2 * Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include <openssl/evp.h>
12 #include <openssl/pem.h>
13 #include <openssl/rsa.h>
14 #include <openssl/x509.h>
15 #include <openssl/serializer.h>
16 #include <openssl/deserializer.h>
18 #include "internal/cryptlib.h" /* ossl_assert */
23 * TODO(3.0) Modify PEM_write_bio_PrivateKey_traditional() to handle
24 * provider side EVP_PKEYs (which don't necessarily have an ameth)
26 * In the mean time, we use separate "downgraded" EVP_PKEYs to test
27 * serializing/deserializing with "traditional" keys.
30 static EVP_PKEY *key_RSA = NULL;
31 static EVP_PKEY *legacy_key_RSA = NULL;
32 static EVP_PKEY *key_RSA_PSS = NULL;
33 static EVP_PKEY *legacy_key_RSA_PSS = NULL;
35 static EVP_PKEY *make_RSA(const char *rsa_type, int make_legacy)
37 EVP_PKEY *pkey = NULL;
38 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_name(NULL, rsa_type, NULL);
41 * No real need to check the errors other than for the cascade
42 * effect. |pkey| will imply remain NULL if something goes wrong.
45 && EVP_PKEY_keygen_init(ctx) > 0
46 && EVP_PKEY_keygen(ctx, &pkey) > 0);
47 EVP_PKEY_CTX_free(ctx);
48 if (make_legacy && EVP_PKEY_get0(pkey) == NULL) {
56 /* Main test driver */
59 * TODO(3.0) For better error output, changed the callbacks to take __FILE__
60 * and __LINE__ as first two arguments, and have them use the lower case
61 * functions, such as test_strn_eq(), rather than the uppercase macros
62 * (TEST_strn2_eq(), for example).
65 typedef int (serializer)(void **serialized, long *serialized_len,
66 void *object, const char *pass, const char *pcipher,
67 const char *ser_propq);
68 typedef int (deserializer)(void **object,
69 void *serialized, long serialized_len,
71 typedef int (checker)(const char *type, const void *data, size_t data_len);
72 typedef void (dumper)(const char *label, const void *data, size_t data_len);
74 static int test_serialize_deserialize(const char *type, EVP_PKEY *pkey,
75 const char *pass, const char *pcipher,
76 serializer *serialize_cb,
77 deserializer *deserialize_cb,
78 checker *check_cb, dumper *dump_cb,
79 const char *ser_propq, int make_legacy)
81 void *serialized = NULL;
82 long serialized_len = 0;
83 EVP_PKEY *pkey2 = NULL;
84 void *serialized2 = NULL;
85 long serialized2_len = 0;
88 if (!serialize_cb(&serialized, &serialized_len, pkey,
89 pass, pcipher, ser_propq)
90 || !check_cb(type, serialized, serialized_len)
91 || !deserialize_cb((void **)&pkey2, serialized, serialized_len,
93 || !TEST_int_eq(EVP_PKEY_eq(pkey, pkey2), 1))
97 * TODO(3.0) Remove this when PEM_write_bio_PrivateKey_traditional()
98 * handles provider side keys.
101 && !TEST_ptr(EVP_PKEY_get0(pkey2)))
105 * Double check the serialization, but only for unprotected keys,
106 * as protected keys have a random component, which makes the output
109 if ((pass == NULL && pcipher == NULL)
110 && (!serialize_cb(&serialized2, &serialized2_len, pkey2,
111 pass, pcipher, ser_propq)
112 || !TEST_mem_eq(serialized, serialized_len,
113 serialized2, serialized2_len)))
119 dump_cb("serialized result", serialized, serialized_len);
121 OPENSSL_free(serialized);
122 OPENSSL_free(serialized2);
123 EVP_PKEY_free(pkey2);
127 /* Serializing and desserializing methods */
129 static int serialize_EVP_PKEY_prov(void **serialized, long *serialized_len,
131 const char *pass, const char *pcipher,
132 const char *ser_propq)
134 EVP_PKEY *pkey = object;
135 OSSL_SERIALIZER_CTX *sctx = NULL;
137 BUF_MEM *mem_buf = NULL;
138 const unsigned char *upass = (const unsigned char *)pass;
141 if (!TEST_ptr(sctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, ser_propq))
143 && !TEST_true(OSSL_SERIALIZER_CTX_set_passphrase(sctx, upass,
146 && !TEST_true(OSSL_SERIALIZER_CTX_set_cipher(sctx, pcipher, NULL)))
147 || !TEST_ptr(mem_ser = BIO_new(BIO_s_mem()))
148 || !TEST_true(OSSL_SERIALIZER_to_bio(sctx, mem_ser))
149 || !TEST_true(BIO_get_mem_ptr(mem_ser, &mem_buf) > 0)
150 || !TEST_ptr(*serialized = mem_buf->data)
151 || !TEST_long_gt(*serialized_len = mem_buf->length, 0))
154 /* Detach the serialized output */
155 mem_buf->data = NULL;
160 OSSL_SERIALIZER_CTX_free(sctx);
164 static int deserialize_EVP_PKEY_prov(void **object,
165 void *serialized, long serialized_len,
168 EVP_PKEY *pkey = NULL;
169 OSSL_DESERIALIZER_CTX *dctx = NULL;
170 BIO *mem_deser = NULL;
171 const unsigned char *upass = (const unsigned char *)pass;
174 if (!TEST_ptr(dctx = OSSL_DESERIALIZER_CTX_new_by_EVP_PKEY(&pkey, NULL,
177 && !OSSL_DESERIALIZER_CTX_set_passphrase(dctx, upass,
179 || !TEST_ptr(mem_deser = BIO_new_mem_buf(serialized, serialized_len))
180 || !TEST_true(OSSL_DESERIALIZER_from_bio(dctx, mem_deser)))
186 OSSL_DESERIALIZER_CTX_free(dctx);
190 static int serialize_EVP_PKEY_legacy_PEM(void **serialized,
191 long *serialized_len,
193 const char *pass, const char *pcipher,
194 ossl_unused const char *ser_propq)
196 EVP_PKEY *pkey = object;
197 EVP_CIPHER *cipher = NULL;
199 BUF_MEM *mem_buf = NULL;
200 const unsigned char *upass = (const unsigned char *)pass;
204 if (pcipher != NULL && pass != NULL) {
205 passlen = strlen(pass);
206 if (!TEST_ptr(cipher = EVP_CIPHER_fetch(NULL, pcipher, NULL)))
209 if (!TEST_ptr(mem_ser = BIO_new(BIO_s_mem()))
210 || !TEST_true(PEM_write_bio_PrivateKey_traditional(mem_ser, pkey,
214 || !TEST_true(BIO_get_mem_ptr(mem_ser, &mem_buf) > 0)
215 || !TEST_ptr(*serialized = mem_buf->data)
216 || !TEST_long_gt(*serialized_len = mem_buf->length, 0))
219 /* Detach the serialized output */
220 mem_buf->data = NULL;
225 EVP_CIPHER_free(cipher);
229 /* Test cases and their dumpers / checkers */
231 static void dump_der(const char *label, const void *data, size_t data_len)
233 test_output_memory(label, data, data_len);
236 static void dump_pem(const char *label, const void *data, size_t data_len)
238 test_output_string(label, data, data_len - 1);
241 static int check_unprotected_PKCS8_DER(const char *type,
242 const void *data, size_t data_len)
244 const unsigned char *datap = data;
245 PKCS8_PRIV_KEY_INFO *p8inf =
246 d2i_PKCS8_PRIV_KEY_INFO(NULL, &datap, data_len);
249 if (TEST_ptr(p8inf)) {
250 EVP_PKEY *pkey = EVP_PKCS82PKEY(p8inf);
252 ok = (TEST_ptr(pkey) && TEST_true(EVP_PKEY_is_a(pkey, type)));
255 PKCS8_PRIV_KEY_INFO_free(p8inf);
259 static int test_unprotected_RSA_via_DER(void)
261 return test_serialize_deserialize("RSA", key_RSA, NULL, NULL,
262 serialize_EVP_PKEY_prov,
263 deserialize_EVP_PKEY_prov,
264 check_unprotected_PKCS8_DER, dump_der,
265 OSSL_SERIALIZER_PrivateKey_TO_DER_PQ,
269 static int test_unprotected_RSA_PSS_via_DER(void)
271 return test_serialize_deserialize("RSA-PSS", key_RSA_PSS, NULL, NULL,
272 serialize_EVP_PKEY_prov,
273 deserialize_EVP_PKEY_prov,
274 check_unprotected_PKCS8_DER, dump_der,
275 OSSL_SERIALIZER_PrivateKey_TO_DER_PQ,
279 static int check_unprotected_PKCS8_PEM(const char *type,
280 const void *data, size_t data_len)
282 static const char pem_header[] = "-----BEGIN " PEM_STRING_PKCS8INF "-----";
284 return TEST_strn_eq(data, pem_header, sizeof(pem_header) - 1);
287 static int test_unprotected_RSA_via_PEM(void)
289 return test_serialize_deserialize("RSA", key_RSA, NULL, NULL,
290 serialize_EVP_PKEY_prov,
291 deserialize_EVP_PKEY_prov,
292 check_unprotected_PKCS8_PEM, dump_pem,
293 OSSL_SERIALIZER_PrivateKey_TO_PEM_PQ,
297 static int test_unprotected_RSA_PSS_via_PEM(void)
299 return test_serialize_deserialize("RSA-PSS", key_RSA_PSS, NULL, NULL,
300 serialize_EVP_PKEY_prov,
301 deserialize_EVP_PKEY_prov,
302 check_unprotected_PKCS8_PEM, dump_pem,
303 OSSL_SERIALIZER_PrivateKey_TO_PEM_PQ,
307 static int check_unprotected_legacy_PEM(const char *type,
308 const void *data, size_t data_len)
310 static char pem_header[80];
313 TEST_int_gt(BIO_snprintf(pem_header, sizeof(pem_header),
314 "-----BEGIN %s PRIVATE KEY-----", type), 0)
315 && TEST_strn_eq(data, pem_header, strlen(pem_header));
318 static int test_unprotected_RSA_via_legacy_PEM(void)
320 return test_serialize_deserialize("RSA", legacy_key_RSA, NULL, NULL,
321 serialize_EVP_PKEY_legacy_PEM,
322 deserialize_EVP_PKEY_prov,
323 check_unprotected_legacy_PEM, dump_pem,
327 static int test_unprotected_RSA_PSS_via_legacy_PEM(void)
329 return test_serialize_deserialize("RSA-PSS", legacy_key_RSA_PSS, NULL, NULL,
330 serialize_EVP_PKEY_legacy_PEM,
331 deserialize_EVP_PKEY_prov,
332 check_unprotected_legacy_PEM, dump_pem,
336 static const char *pass_cipher = "AES-256-CBC";
337 static const char *pass = "the holy handgrenade of antioch";
339 static int check_protected_PKCS8_DER(const char *type,
340 const void *data, size_t data_len)
342 const unsigned char *datap = data;
343 X509_SIG *p8 = d2i_X509_SIG(NULL, &datap, data_len);
344 int ok = TEST_ptr(p8);
350 static int test_protected_RSA_via_DER(void)
352 return test_serialize_deserialize("RSA", key_RSA, pass, pass_cipher,
353 serialize_EVP_PKEY_prov,
354 deserialize_EVP_PKEY_prov,
355 check_protected_PKCS8_DER, dump_der,
356 OSSL_SERIALIZER_PrivateKey_TO_DER_PQ,
360 static int test_protected_RSA_PSS_via_DER(void)
362 return test_serialize_deserialize("RSA", key_RSA, pass, pass_cipher,
363 serialize_EVP_PKEY_prov,
364 deserialize_EVP_PKEY_prov,
365 check_protected_PKCS8_DER, dump_der,
366 OSSL_SERIALIZER_PrivateKey_TO_DER_PQ,
370 static int check_protected_PKCS8_PEM(const char *type,
371 const void *data, size_t data_len)
373 static const char pem_header[] = "-----BEGIN " PEM_STRING_PKCS8 "-----";
375 return TEST_strn_eq(data, pem_header, sizeof(pem_header) - 1);
378 static int test_protected_RSA_via_PEM(void)
380 return test_serialize_deserialize("RSA", key_RSA, pass, pass_cipher,
381 serialize_EVP_PKEY_prov,
382 deserialize_EVP_PKEY_prov,
383 check_protected_PKCS8_PEM, dump_pem,
384 OSSL_SERIALIZER_PrivateKey_TO_PEM_PQ,
388 static int test_protected_RSA_PSS_via_PEM(void)
390 return test_serialize_deserialize("RSA-PSS", key_RSA_PSS, pass, pass_cipher,
391 serialize_EVP_PKEY_prov,
392 deserialize_EVP_PKEY_prov,
393 check_protected_PKCS8_PEM, dump_pem,
394 OSSL_SERIALIZER_PrivateKey_TO_PEM_PQ,
398 static int check_protected_legacy_PEM(const char *type,
399 const void *data, size_t data_len)
401 static char pem_header[80];
404 TEST_int_gt(BIO_snprintf(pem_header, sizeof(pem_header),
405 "-----BEGIN %s PRIVATE KEY-----", type), 0)
406 && TEST_strn_eq(data, pem_header, strlen(pem_header))
407 && TEST_ptr(strstr(data, "\nDEK-Info: "));
410 static int test_protected_RSA_via_legacy_PEM(void)
412 return test_serialize_deserialize("RSA", legacy_key_RSA, pass, pass_cipher,
413 serialize_EVP_PKEY_legacy_PEM,
414 deserialize_EVP_PKEY_prov,
415 check_protected_legacy_PEM, dump_pem,
419 static int test_protected_RSA_PSS_via_legacy_PEM(void)
421 return test_serialize_deserialize("RSA-PSS", legacy_key_RSA_PSS,
423 serialize_EVP_PKEY_legacy_PEM,
424 deserialize_EVP_PKEY_prov,
425 check_protected_legacy_PEM, dump_pem,
429 static int check_public_DER(int type, const void *data, size_t data_len)
431 const unsigned char *datap = data;
432 EVP_PKEY *pkey = d2i_PUBKEY(NULL, &datap, data_len);
433 int ok = (TEST_ptr(pkey) && TEST_true(EVP_PKEY_is_a(pkey, "RSA")));
439 static int test_public_RSA_via_DER(void)
441 return test_serialize_deserialize("RSA", NULL, NULL,
442 serialize_EVP_PKEY_prov,
443 deserialize_EVP_PKEY_prov,
444 check_public_DER, dump_der,
445 OSSL_SERIALIZER_PUBKEY_TO_DER_PQ,
449 static int test_public_RSA_PSS_via_DER(void)
451 return test_serialize_deserialize("RSA-PSS", NULL, NULL,
452 serialize_EVP_PKEY_prov,
453 deserialize_EVP_PKEY_prov,
454 check_public_DER, dump_der,
455 OSSL_SERIALIZER_PUBKEY_TO_DER_PQ,
459 static int check_public_PEM(int type, const void *data, size_t data_len)
461 static const char pem_header[] = "-----BEGIN " PEM_STRING_PUBLIC "-----";
464 TEST_strn_eq(data, pem_header, sizeof(pem_header) - 1);
467 static int test_public_RSA_via_PEM(void)
469 return test_serialize_deserialize("RSA", NULL, NULL,
470 serialize_EVP_PKEY_prov,
471 deserialize_EVP_PKEY_prov,
472 check_public_PEM, dump_pem,
473 OSSL_SERIALIZER_PUBKEY_TO_PEM_PQ,
477 static int test_public_RSA_PSS_via_PEM(void)
479 return test_serialize_deserialize("RSA-PSS", NULL, NULL,
480 serialize_EVP_PKEY_prov,
481 deserialize_EVP_PKEY_prov,
482 check_public_PEM, dump_pem,
483 OSSL_SERIALIZER_PUBKEY_TO_PEM_PQ,
487 int setup_tests(void)
489 TEST_info("Generating keys...");
490 if (!TEST_ptr(key_RSA = make_RSA("RSA", 0))
491 || !TEST_ptr(legacy_key_RSA = make_RSA("RSA", 1))
492 || !TEST_ptr(key_RSA_PSS = make_RSA("RSA-PSS", 0))
493 || !TEST_ptr(legacy_key_RSA_PSS = make_RSA("RSA-PSS", 1))) {
494 EVP_PKEY_free(key_RSA);
495 EVP_PKEY_free(legacy_key_RSA);
496 EVP_PKEY_free(key_RSA_PSS);
497 EVP_PKEY_free(legacy_key_RSA_PSS);
500 TEST_info("Generating key... done");
502 ADD_TEST(test_unprotected_RSA_via_DER);
503 ADD_TEST(test_unprotected_RSA_via_PEM);
504 ADD_TEST(test_unprotected_RSA_via_legacy_PEM);
505 ADD_TEST(test_protected_RSA_via_DER);
506 ADD_TEST(test_protected_RSA_via_PEM);
507 ADD_TEST(test_protected_RSA_via_legacy_PEM);
508 ADD_TEST(test_public_RSA_via_DER);
509 ADD_TEST(test_public_RSA_via_PEM);
510 ADD_TEST(test_unprotected_RSA_PSS_via_DER);
511 ADD_TEST(test_unprotected_RSA_PSS_via_PEM);
512 ADD_TEST(test_unprotected_RSA_PSS_via_legacy_PEM);
513 ADD_TEST(test_protected_RSA_PSS_via_DER);
514 ADD_TEST(test_protected_RSA_PSS_via_PEM);
515 ADD_TEST(test_protected_RSA_PSS_via_legacy_PEM);
516 ADD_TEST(test_public_RSA_PSS_via_DER);
517 ADD_TEST(test_public_RSA_PSS_via_PEM);