1 /* $OpenBSD: test_sshkey.c,v 1.20 2019/11/25 10:32:35 djm Exp $ */ 2 /* 3 * Regress test for sshkey.h key management API 4 * 5 * Placed in the public domain 6 */ 7 8 #include <sys/types.h> 9 #include <sys/param.h> 10 #include <stdio.h> 11 #include <stdint.h> 12 #include <stdlib.h> 13 #include <string.h> 14 15 #include <openssl/bn.h> 16 #include <openssl/ec.h> 17 #include <openssl/rsa.h> 18 #include <openssl/dsa.h> 19 20 #include "test_helper.h" 21 22 #include "ssherr.h" 23 #include "sshbuf.h" 24 #define SSHBUF_INTERNAL 1 /* access internals for testing */ 25 #include "sshkey.h" 26 27 #include "authfile.h" 28 #include "common.h" 29 #include "ssh2.h" 30 31 void sshkey_tests(void); 32 33 static void 34 put_opt(struct sshbuf *b, const char *name, const char *value) 35 { 36 struct sshbuf *sect; 37 38 sect = sshbuf_new(); 39 ASSERT_PTR_NE(sect, NULL); 40 ASSERT_INT_EQ(sshbuf_put_cstring(b, name), 0); 41 if (value != NULL) 42 ASSERT_INT_EQ(sshbuf_put_cstring(sect, value), 0); 43 ASSERT_INT_EQ(sshbuf_put_stringb(b, sect), 0); 44 sshbuf_free(sect); 45 } 46 47 static void 48 build_cert(struct sshbuf *b, struct sshkey *k, const char *type, 49 struct sshkey *sign_key, struct sshkey *ca_key, 50 const char *sig_alg) 51 { 52 struct sshbuf *ca_buf, *pk, *principals, *critopts, *exts; 53 u_char *sigblob; 54 size_t siglen; 55 56 ca_buf = sshbuf_new(); 57 ASSERT_PTR_NE(ca_buf, NULL); 58 ASSERT_INT_EQ(sshkey_putb(ca_key, ca_buf), 0); 59 60 /* 61 * Get the public key serialisation by rendering the key and skipping 62 * the type string. This is a bit of a hack :/ 63 */ 64 pk = sshbuf_new(); 65 ASSERT_PTR_NE(pk, NULL); 66 ASSERT_INT_EQ(sshkey_putb_plain(k, pk), 0); 67 ASSERT_INT_EQ(sshbuf_skip_string(pk), 0); 68 69 principals = sshbuf_new(); 70 ASSERT_PTR_NE(principals, NULL); 71 ASSERT_INT_EQ(sshbuf_put_cstring(principals, "gsamsa"), 0); 72 ASSERT_INT_EQ(sshbuf_put_cstring(principals, "gregor"), 0); 73 74 critopts = sshbuf_new(); 75 ASSERT_PTR_NE(critopts, NULL); 76 put_opt(critopts, "force-command", "/usr/local/bin/nethack"); 77 put_opt(critopts, "source-address", "192.168.0.0/24,127.0.0.1,::1"); 78 79 exts = sshbuf_new(); 80 ASSERT_PTR_NE(exts, NULL); 81 put_opt(critopts, "permit-X11-forwarding", NULL); 82 83 ASSERT_INT_EQ(sshbuf_put_cstring(b, type), 0); 84 ASSERT_INT_EQ(sshbuf_put_cstring(b, "noncenoncenonce!"), 0); /* nonce */ 85 ASSERT_INT_EQ(sshbuf_putb(b, pk), 0); /* public key serialisation */ 86 ASSERT_INT_EQ(sshbuf_put_u64(b, 1234), 0); /* serial */ 87 ASSERT_INT_EQ(sshbuf_put_u32(b, SSH2_CERT_TYPE_USER), 0); /* type */ 88 ASSERT_INT_EQ(sshbuf_put_cstring(b, "gregor"), 0); /* key ID */ 89 ASSERT_INT_EQ(sshbuf_put_stringb(b, principals), 0); /* principals */ 90 ASSERT_INT_EQ(sshbuf_put_u64(b, 0), 0); /* start */ 91 ASSERT_INT_EQ(sshbuf_put_u64(b, 0xffffffffffffffffULL), 0); /* end */ 92 ASSERT_INT_EQ(sshbuf_put_stringb(b, critopts), 0); /* options */ 93 ASSERT_INT_EQ(sshbuf_put_stringb(b, exts), 0); /* extensions */ 94 ASSERT_INT_EQ(sshbuf_put_string(b, NULL, 0), 0); /* reserved */ 95 ASSERT_INT_EQ(sshbuf_put_stringb(b, ca_buf), 0); /* signature key */ 96 ASSERT_INT_EQ(sshkey_sign(sign_key, &sigblob, &siglen, 97 sshbuf_ptr(b), sshbuf_len(b), sig_alg, NULL, 0), 0); 98 ASSERT_INT_EQ(sshbuf_put_string(b, sigblob, siglen), 0); /* signature */ 99 100 free(sigblob); 101 sshbuf_free(ca_buf); 102 sshbuf_free(exts); 103 sshbuf_free(critopts); 104 sshbuf_free(principals); 105 sshbuf_free(pk); 106 } 107 108 static void 109 signature_test(struct sshkey *k, struct sshkey *bad, const char *sig_alg, 110 const u_char *d, size_t l) 111 { 112 size_t len; 113 u_char *sig; 114 115 ASSERT_INT_EQ(sshkey_sign(k, &sig, &len, d, l, sig_alg, NULL, 0), 0); 116 ASSERT_SIZE_T_GT(len, 8); 117 ASSERT_PTR_NE(sig, NULL); 118 ASSERT_INT_EQ(sshkey_verify(k, sig, len, d, l, NULL, 0, NULL), 0); 119 ASSERT_INT_NE(sshkey_verify(bad, sig, len, d, l, NULL, 0, NULL), 0); 120 /* Fuzz test is more comprehensive, this is just a smoke test */ 121 sig[len - 5] ^= 0x10; 122 ASSERT_INT_NE(sshkey_verify(k, sig, len, d, l, NULL, 0, NULL), 0); 123 free(sig); 124 } 125 126 static void 127 banana(u_char *s, size_t l) 128 { 129 size_t o; 130 const u_char the_banana[] = { 'b', 'a', 'n', 'a', 'n', 'a' }; 131 132 for (o = 0; o < l; o += sizeof(the_banana)) { 133 if (l - o < sizeof(the_banana)) { 134 memcpy(s + o, "nanananana", l - o); 135 break; 136 } 137 memcpy(s + o, banana, sizeof(the_banana)); 138 } 139 } 140 141 static void 142 signature_tests(struct sshkey *k, struct sshkey *bad, const char *sig_alg) 143 { 144 u_char i, buf[2049]; 145 size_t lens[] = { 146 1, 2, 7, 8, 9, 15, 16, 17, 31, 32, 33, 127, 128, 129, 147 255, 256, 257, 1023, 1024, 1025, 2047, 2048, 2049 148 }; 149 150 for (i = 0; i < (sizeof(lens)/sizeof(lens[0])); i++) { 151 test_subtest_info("%s key, banana length %zu", 152 sshkey_type(k), lens[i]); 153 banana(buf, lens[i]); 154 signature_test(k, bad, sig_alg, buf, lens[i]); 155 } 156 } 157 158 static struct sshkey * 159 get_private(const char *n) 160 { 161 struct sshbuf *b; 162 struct sshkey *ret; 163 164 b = load_file(n); 165 ASSERT_INT_EQ(sshkey_parse_private_fileblob(b, "", &ret, NULL), 0); 166 sshbuf_free(b); 167 return ret; 168 } 169 170 void 171 sshkey_tests(void) 172 { 173 struct sshkey *k1, *k2, *k3, *k4, *kr, *kd, *ke, *kf; 174 struct sshbuf *b; 175 176 TEST_START("new invalid"); 177 k1 = sshkey_new(-42); 178 ASSERT_PTR_EQ(k1, NULL); 179 TEST_DONE(); 180 181 TEST_START("new/free KEY_UNSPEC"); 182 k1 = sshkey_new(KEY_UNSPEC); 183 ASSERT_PTR_NE(k1, NULL); 184 sshkey_free(k1); 185 TEST_DONE(); 186 187 TEST_START("new/free KEY_RSA"); 188 k1 = sshkey_new(KEY_RSA); 189 ASSERT_PTR_NE(k1, NULL); 190 ASSERT_PTR_NE(k1->rsa, NULL); 191 sshkey_free(k1); 192 TEST_DONE(); 193 194 TEST_START("new/free KEY_DSA"); 195 k1 = sshkey_new(KEY_DSA); 196 ASSERT_PTR_NE(k1, NULL); 197 ASSERT_PTR_NE(k1->dsa, NULL); 198 sshkey_free(k1); 199 TEST_DONE(); 200 201 TEST_START("new/free KEY_ECDSA"); 202 k1 = sshkey_new(KEY_ECDSA); 203 ASSERT_PTR_NE(k1, NULL); 204 ASSERT_PTR_EQ(k1->ecdsa, NULL); /* Can't allocate without NID */ 205 sshkey_free(k1); 206 TEST_DONE(); 207 208 TEST_START("new/free KEY_ED25519"); 209 k1 = sshkey_new(KEY_ED25519); 210 ASSERT_PTR_NE(k1, NULL); 211 /* These should be blank until key loaded or generated */ 212 ASSERT_PTR_EQ(k1->ed25519_sk, NULL); 213 ASSERT_PTR_EQ(k1->ed25519_pk, NULL); 214 sshkey_free(k1); 215 TEST_DONE(); 216 217 TEST_START("generate KEY_RSA too small modulus"); 218 ASSERT_INT_EQ(sshkey_generate(KEY_RSA, 128, &k1), 219 SSH_ERR_KEY_LENGTH); 220 ASSERT_PTR_EQ(k1, NULL); 221 TEST_DONE(); 222 223 TEST_START("generate KEY_RSA too large modulus"); 224 ASSERT_INT_EQ(sshkey_generate(KEY_RSA, 1 << 20, &k1), 225 SSH_ERR_KEY_LENGTH); 226 ASSERT_PTR_EQ(k1, NULL); 227 TEST_DONE(); 228 229 TEST_START("generate KEY_DSA wrong bits"); 230 ASSERT_INT_EQ(sshkey_generate(KEY_DSA, 2048, &k1), 231 SSH_ERR_KEY_LENGTH); 232 ASSERT_PTR_EQ(k1, NULL); 233 sshkey_free(k1); 234 TEST_DONE(); 235 236 TEST_START("generate KEY_ECDSA wrong bits"); 237 ASSERT_INT_EQ(sshkey_generate(KEY_ECDSA, 42, &k1), 238 SSH_ERR_KEY_LENGTH); 239 ASSERT_PTR_EQ(k1, NULL); 240 sshkey_free(k1); 241 TEST_DONE(); 242 243 TEST_START("generate KEY_RSA"); 244 ASSERT_INT_EQ(sshkey_generate(KEY_RSA, 767, &kr), 245 SSH_ERR_KEY_LENGTH); 246 ASSERT_INT_EQ(sshkey_generate(KEY_RSA, 1024, &kr), 0); 247 ASSERT_PTR_NE(kr, NULL); 248 ASSERT_PTR_NE(kr->rsa, NULL); 249 ASSERT_PTR_NE(rsa_n(kr), NULL); 250 ASSERT_PTR_NE(rsa_e(kr), NULL); 251 ASSERT_PTR_NE(rsa_p(kr), NULL); 252 ASSERT_INT_EQ(BN_num_bits(rsa_n(kr)), 1024); 253 TEST_DONE(); 254 255 TEST_START("generate KEY_DSA"); 256 ASSERT_INT_EQ(sshkey_generate(KEY_DSA, 1024, &kd), 0); 257 ASSERT_PTR_NE(kd, NULL); 258 ASSERT_PTR_NE(kd->dsa, NULL); 259 ASSERT_PTR_NE(dsa_g(kd), NULL); 260 ASSERT_PTR_NE(dsa_priv_key(kd), NULL); 261 TEST_DONE(); 262 263 TEST_START("generate KEY_ECDSA"); 264 ASSERT_INT_EQ(sshkey_generate(KEY_ECDSA, 256, &ke), 0); 265 ASSERT_PTR_NE(ke, NULL); 266 ASSERT_PTR_NE(ke->ecdsa, NULL); 267 ASSERT_PTR_NE(EC_KEY_get0_public_key(ke->ecdsa), NULL); 268 ASSERT_PTR_NE(EC_KEY_get0_private_key(ke->ecdsa), NULL); 269 TEST_DONE(); 270 271 TEST_START("generate KEY_ED25519"); 272 ASSERT_INT_EQ(sshkey_generate(KEY_ED25519, 256, &kf), 0); 273 ASSERT_PTR_NE(kf, NULL); 274 ASSERT_INT_EQ(kf->type, KEY_ED25519); 275 ASSERT_PTR_NE(kf->ed25519_pk, NULL); 276 ASSERT_PTR_NE(kf->ed25519_sk, NULL); 277 TEST_DONE(); 278 279 TEST_START("demote KEY_RSA"); 280 ASSERT_INT_EQ(sshkey_from_private(kr, &k1), 0); 281 ASSERT_PTR_NE(k1, NULL); 282 ASSERT_PTR_NE(kr, k1); 283 ASSERT_INT_EQ(k1->type, KEY_RSA); 284 ASSERT_PTR_NE(k1->rsa, NULL); 285 ASSERT_PTR_NE(rsa_n(k1), NULL); 286 ASSERT_PTR_NE(rsa_e(k1), NULL); 287 ASSERT_PTR_EQ(rsa_p(k1), NULL); 288 TEST_DONE(); 289 290 TEST_START("equal KEY_RSA/demoted KEY_RSA"); 291 ASSERT_INT_EQ(sshkey_equal(kr, k1), 1); 292 sshkey_free(k1); 293 TEST_DONE(); 294 295 TEST_START("demote KEY_DSA"); 296 ASSERT_INT_EQ(sshkey_from_private(kd, &k1), 0); 297 ASSERT_PTR_NE(k1, NULL); 298 ASSERT_PTR_NE(kd, k1); 299 ASSERT_INT_EQ(k1->type, KEY_DSA); 300 ASSERT_PTR_NE(k1->dsa, NULL); 301 ASSERT_PTR_NE(dsa_g(k1), NULL); 302 ASSERT_PTR_EQ(dsa_priv_key(k1), NULL); 303 TEST_DONE(); 304 305 TEST_START("equal KEY_DSA/demoted KEY_DSA"); 306 ASSERT_INT_EQ(sshkey_equal(kd, k1), 1); 307 sshkey_free(k1); 308 TEST_DONE(); 309 310 TEST_START("demote KEY_ECDSA"); 311 ASSERT_INT_EQ(sshkey_from_private(ke, &k1), 0); 312 ASSERT_PTR_NE(k1, NULL); 313 ASSERT_PTR_NE(ke, k1); 314 ASSERT_INT_EQ(k1->type, KEY_ECDSA); 315 ASSERT_PTR_NE(k1->ecdsa, NULL); 316 ASSERT_INT_EQ(k1->ecdsa_nid, ke->ecdsa_nid); 317 ASSERT_PTR_NE(EC_KEY_get0_public_key(ke->ecdsa), NULL); 318 ASSERT_PTR_EQ(EC_KEY_get0_private_key(k1->ecdsa), NULL); 319 TEST_DONE(); 320 321 TEST_START("equal KEY_ECDSA/demoted KEY_ECDSA"); 322 ASSERT_INT_EQ(sshkey_equal(ke, k1), 1); 323 sshkey_free(k1); 324 TEST_DONE(); 325 326 TEST_START("demote KEY_ED25519"); 327 ASSERT_INT_EQ(sshkey_from_private(kf, &k1), 0); 328 ASSERT_PTR_NE(k1, NULL); 329 ASSERT_PTR_NE(kf, k1); 330 ASSERT_INT_EQ(k1->type, KEY_ED25519); 331 ASSERT_PTR_NE(k1->ed25519_pk, NULL); 332 ASSERT_PTR_EQ(k1->ed25519_sk, NULL); 333 TEST_DONE(); 334 335 TEST_START("equal KEY_ED25519/demoted KEY_ED25519"); 336 ASSERT_INT_EQ(sshkey_equal(kf, k1), 1); 337 sshkey_free(k1); 338 TEST_DONE(); 339 340 TEST_START("equal mismatched key types"); 341 ASSERT_INT_EQ(sshkey_equal(kd, kr), 0); 342 ASSERT_INT_EQ(sshkey_equal(kd, ke), 0); 343 ASSERT_INT_EQ(sshkey_equal(kr, ke), 0); 344 ASSERT_INT_EQ(sshkey_equal(ke, kf), 0); 345 ASSERT_INT_EQ(sshkey_equal(kd, kf), 0); 346 TEST_DONE(); 347 348 TEST_START("equal different keys"); 349 ASSERT_INT_EQ(sshkey_generate(KEY_RSA, 1024, &k1), 0); 350 ASSERT_INT_EQ(sshkey_equal(kr, k1), 0); 351 sshkey_free(k1); 352 ASSERT_INT_EQ(sshkey_generate(KEY_DSA, 1024, &k1), 0); 353 ASSERT_INT_EQ(sshkey_equal(kd, k1), 0); 354 sshkey_free(k1); 355 ASSERT_INT_EQ(sshkey_generate(KEY_ECDSA, 256, &k1), 0); 356 ASSERT_INT_EQ(sshkey_equal(ke, k1), 0); 357 sshkey_free(k1); 358 ASSERT_INT_EQ(sshkey_generate(KEY_ED25519, 256, &k1), 0); 359 ASSERT_INT_EQ(sshkey_equal(kf, k1), 0); 360 sshkey_free(k1); 361 TEST_DONE(); 362 363 sshkey_free(kr); 364 sshkey_free(kd); 365 sshkey_free(ke); 366 sshkey_free(kf); 367 368 TEST_START("certify key"); 369 ASSERT_INT_EQ(sshkey_load_public(test_data_file("ed25519_1.pub"), 370 &k1, NULL), 0); 371 k2 = get_private("ed25519_2"); 372 ASSERT_INT_EQ(sshkey_to_certified(k1), 0); 373 ASSERT_PTR_NE(k1->cert, NULL); 374 k1->cert->type = SSH2_CERT_TYPE_USER; 375 k1->cert->serial = 1234; 376 k1->cert->key_id = strdup("estragon"); 377 ASSERT_PTR_NE(k1->cert->key_id, NULL); 378 k1->cert->principals = calloc(4, sizeof(*k1->cert->principals)); 379 ASSERT_PTR_NE(k1->cert->principals, NULL); 380 k1->cert->principals[0] = strdup("estragon"); 381 k1->cert->principals[1] = strdup("vladimir"); 382 k1->cert->principals[2] = strdup("pozzo"); 383 k1->cert->principals[3] = strdup("lucky"); 384 ASSERT_PTR_NE(k1->cert->principals[0], NULL); 385 ASSERT_PTR_NE(k1->cert->principals[1], NULL); 386 ASSERT_PTR_NE(k1->cert->principals[2], NULL); 387 ASSERT_PTR_NE(k1->cert->principals[3], NULL); 388 k1->cert->nprincipals = 4; 389 k1->cert->valid_after = 0; 390 k1->cert->valid_before = (u_int64_t)-1; 391 sshbuf_free(k1->cert->critical); 392 k1->cert->critical = sshbuf_new(); 393 ASSERT_PTR_NE(k1->cert->critical, NULL); 394 sshbuf_free(k1->cert->extensions); 395 k1->cert->extensions = sshbuf_new(); 396 ASSERT_PTR_NE(k1->cert->extensions, NULL); 397 put_opt(k1->cert->critical, "force-command", "/usr/bin/true"); 398 put_opt(k1->cert->critical, "source-address", "127.0.0.1"); 399 put_opt(k1->cert->extensions, "permit-X11-forwarding", NULL); 400 put_opt(k1->cert->extensions, "permit-agent-forwarding", NULL); 401 ASSERT_INT_EQ(sshkey_from_private(k2, &k1->cert->signature_key), 0); 402 ASSERT_INT_EQ(sshkey_certify(k1, k2, NULL, NULL), 0); 403 b = sshbuf_new(); 404 ASSERT_PTR_NE(b, NULL); 405 ASSERT_INT_EQ(sshkey_putb(k1, b), 0); 406 ASSERT_INT_EQ(sshkey_from_blob(sshbuf_ptr(b), sshbuf_len(b), &k3), 0); 407 408 sshkey_free(k1); 409 sshkey_free(k2); 410 sshkey_free(k3); 411 sshbuf_reset(b); 412 TEST_DONE(); 413 414 TEST_START("sign and verify RSA"); 415 k1 = get_private("rsa_1"); 416 ASSERT_INT_EQ(sshkey_load_public(test_data_file("rsa_2.pub"), &k2, 417 NULL), 0); 418 signature_tests(k1, k2, "ssh-rsa"); 419 sshkey_free(k1); 420 sshkey_free(k2); 421 TEST_DONE(); 422 423 TEST_START("sign and verify RSA-SHA256"); 424 k1 = get_private("rsa_1"); 425 ASSERT_INT_EQ(sshkey_load_public(test_data_file("rsa_2.pub"), &k2, 426 NULL), 0); 427 signature_tests(k1, k2, "rsa-sha2-256"); 428 sshkey_free(k1); 429 sshkey_free(k2); 430 TEST_DONE(); 431 432 TEST_START("sign and verify RSA-SHA512"); 433 k1 = get_private("rsa_1"); 434 ASSERT_INT_EQ(sshkey_load_public(test_data_file("rsa_2.pub"), &k2, 435 NULL), 0); 436 signature_tests(k1, k2, "rsa-sha2-512"); 437 sshkey_free(k1); 438 sshkey_free(k2); 439 TEST_DONE(); 440 441 TEST_START("sign and verify DSA"); 442 k1 = get_private("dsa_1"); 443 ASSERT_INT_EQ(sshkey_load_public(test_data_file("dsa_2.pub"), &k2, 444 NULL), 0); 445 signature_tests(k1, k2, NULL); 446 sshkey_free(k1); 447 sshkey_free(k2); 448 TEST_DONE(); 449 450 TEST_START("sign and verify ECDSA"); 451 k1 = get_private("ecdsa_1"); 452 ASSERT_INT_EQ(sshkey_load_public(test_data_file("ecdsa_2.pub"), &k2, 453 NULL), 0); 454 signature_tests(k1, k2, NULL); 455 sshkey_free(k1); 456 sshkey_free(k2); 457 TEST_DONE(); 458 459 TEST_START("sign and verify ED25519"); 460 k1 = get_private("ed25519_1"); 461 ASSERT_INT_EQ(sshkey_load_public(test_data_file("ed25519_2.pub"), &k2, 462 NULL), 0); 463 signature_tests(k1, k2, NULL); 464 sshkey_free(k1); 465 sshkey_free(k2); 466 TEST_DONE(); 467 468 TEST_START("nested certificate"); 469 ASSERT_INT_EQ(sshkey_load_cert(test_data_file("rsa_1"), &k1), 0); 470 ASSERT_INT_EQ(sshkey_load_public(test_data_file("rsa_1.pub"), &k2, 471 NULL), 0); 472 k3 = get_private("rsa_1"); 473 build_cert(b, k2, "ssh-rsa-cert-v01@openssh.com", k3, k1, NULL); 474 ASSERT_INT_EQ(sshkey_from_blob(sshbuf_ptr(b), sshbuf_len(b), &k4), 475 SSH_ERR_KEY_CERT_INVALID_SIGN_KEY); 476 ASSERT_PTR_EQ(k4, NULL); 477 sshkey_free(k1); 478 sshkey_free(k2); 479 sshkey_free(k3); 480 sshbuf_free(b); 481 TEST_DONE(); 482 483 } 484