TEST: Update the serialization/deserialization test with encryption

This adds variants of already existing tests, but where the object
is encrypted / decrypted along the way as well.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12410)

diff --git a/test/serdes_test.c b/test/serdes_test.c
index 5870ceae8114acc83f389637f9a656b2016868a8..268f4544356782cac72ff7d54e2f464e181ded8d 100644 (file)
--- a/test/serdes_test.c
+++ b/test/serdes_test.c
@@ -7,6 +7,7 @@
  * https://www.openssl.org/source/license.html
  */
 
+#include <string.h>
 #include <openssl/evp.h>
 #include <openssl/pem.h>
 #include <openssl/rsa.h>
@@ -38,13 +39,17 @@ static EVP_PKEY *make_RSA(const char *rsa_type)
 /* Main test driver */
 
 typedef int (serializer)(void **serialized, long *serialized_len,
-                         void *object, const char *ser_propq);
+                         void *object,
+                         const char *pass, const char *pcipher,
+                         const char *ser_propq);
 typedef int (deserializer)(void **object,
-                           void *serialized, long serialized_len);
+                           void *serialized, long serialized_len,
+                           const char *pass, const char *pcipher);
 typedef int (checker)(int type, const void *data, size_t data_len);
 typedef void (dumper)(const char *label, const void *data, size_t data_len);
 
 static int test_serialize_deserialize(EVP_PKEY *pkey,
+                                      const char *pass, const char *pcipher,
                                       serializer *serialize_cb,
                                       deserializer *deserialize_cb,
                                       checker *check_cb, dumper *dump_cb,
@@ -57,18 +62,24 @@ static int test_serialize_deserialize(EVP_PKEY *pkey,
     long serialized2_len = 0;
     int ok = 0;
 
-    if (!serialize_cb(&serialized, &serialized_len, pkey, ser_propq)
+    if (!serialize_cb(&serialized, &serialized_len, pkey,
+                      pass, pcipher, ser_propq)
         || !check_cb(EVP_PKEY_base_id(pkey), serialized, serialized_len)
-        || !deserialize_cb((void **)&pkey2, serialized, serialized_len)
+        || !deserialize_cb((void **)&pkey2, serialized, serialized_len,
+                           pass, pcipher)
         || !TEST_int_eq(EVP_PKEY_eq(pkey, pkey2), 1))
         goto end;
 
     /*
-     * Double check the serialization.
+     * Double check the serialization, but only for unprotected keys,
+     * as protected keys have a random component, which makes the output
+     * differ.
      */
-    if (!serialize_cb(&serialized2, &serialized2_len, pkey2, ser_propq)
-        || !TEST_mem_eq(serialized, serialized_len,
-                        serialized2, serialized2_len))
+    if ((pass == NULL && pcipher == NULL)
+        && (!serialize_cb(&serialized2, &serialized2_len, pkey2,
+                          pass, pcipher, ser_propq)
+            || !TEST_mem_eq(serialized, serialized_len,
+                            serialized2, serialized2_len)))
         goto end;
 
     ok = 1;
@@ -85,15 +96,22 @@ static int test_serialize_deserialize(EVP_PKEY *pkey,
 /* Serializing and desserializing methods */
 
 static int serialize_EVP_PKEY(void **serialized, long *serialized_len,
-                              void *object, const char *ser_propq)
+                              void *object,
+                              const char *pass, const char *pcipher,
+                              const char *ser_propq)
 {
     EVP_PKEY *pkey = object;
     OSSL_SERIALIZER_CTX *sctx = NULL;
     BIO *mem_ser = NULL;
     BUF_MEM *mem_buf = NULL;
+    const unsigned char *upass = (const unsigned char *)pass;
     int ok = 0;
 
     if (!TEST_ptr(sctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, ser_propq))
+        || (pass != NULL
+            && !OSSL_SERIALIZER_CTX_set_passphrase(sctx, upass, strlen(pass)))
+        || (pcipher != NULL
+            && !OSSL_SERIALIZER_CTX_set_cipher(sctx, pcipher, NULL))
         || !TEST_ptr(mem_ser = BIO_new(BIO_s_mem()))
         || !TEST_true(OSSL_SERIALIZER_to_bio(sctx, mem_ser))
         || !TEST_true(BIO_get_mem_ptr(mem_ser, &mem_buf) > 0)
@@ -112,15 +130,22 @@ static int serialize_EVP_PKEY(void **serialized, long *serialized_len,
 }
 
 static int deserialize_EVP_PKEY(void **object,
-                                void *serialized, long serialized_len)
+                                void *serialized, long serialized_len,
+                                const char *pass, const char *pcipher)
 {
     EVP_PKEY *pkey = NULL;
     OSSL_DESERIALIZER_CTX *dctx = NULL;
     BIO *mem_deser = NULL;
+    const unsigned char *upass = (const unsigned char *)pass;
     int ok = 0;
 
     if (!TEST_ptr(dctx = OSSL_DESERIALIZER_CTX_new_by_EVP_PKEY(&pkey, NULL,
                                                                NULL, NULL))
+        || (pass != NULL
+            && !OSSL_DESERIALIZER_CTX_set_passphrase(dctx, upass,
+                                                     strlen(pass)))
+        || (pcipher != NULL
+            && !OSSL_DESERIALIZER_CTX_set_cipher(dctx, pcipher, NULL))
         || !TEST_ptr(mem_deser = BIO_new_mem_buf(serialized, serialized_len))
         || !TEST_true(OSSL_DESERIALIZER_from_bio(dctx, mem_deser)))
         goto end;
@@ -144,7 +169,8 @@ static void dump_pem(const char *label, const void *data, size_t data_len)
     test_output_string(label, data, data_len - 1);
 }
 
-static int check_PKCS8_DER(int type, const void *data, size_t data_len)
+static int check_unprotected_PKCS8_DER(int type,
+                                       const void *data, size_t data_len)
 {
     const unsigned char *datap = data;
     PKCS8_PRIV_KEY_INFO *p8inf =
@@ -161,28 +187,69 @@ static int check_PKCS8_DER(int type, const void *data, size_t data_len)
     return ok;
 }
 
-static int test_RSA_via_DER(void)
+static int test_unprotected_RSA_via_DER(void)
 {
-    return test_serialize_deserialize(key_RSA,
+    return test_serialize_deserialize(key_RSA, NULL, NULL,
                                       serialize_EVP_PKEY,
                                       deserialize_EVP_PKEY,
-                                      check_PKCS8_DER, dump_der,
+                                      check_unprotected_PKCS8_DER, dump_der,
                                       OSSL_SERIALIZER_PrivateKey_TO_DER_PQ);
 }
 
-static int check_PKCS8_PEM(int type, const void *data, size_t data_len)
+static int check_unprotected_PKCS8_PEM(int type,
+                                       const void *data, size_t data_len)
 {
     static const char pem_header[] = "-----BEGIN " PEM_STRING_PKCS8INF "-----";
 
     return TEST_strn_eq(data, pem_header, sizeof(pem_header) - 1);
 }
 
-static int test_RSA_via_PEM(void)
+static int test_unprotected_RSA_via_PEM(void)
 {
-    return test_serialize_deserialize(key_RSA,
+        return test_serialize_deserialize(key_RSA, NULL, NULL,
                                       serialize_EVP_PKEY,
                                       deserialize_EVP_PKEY,
-                                      check_PKCS8_PEM, dump_pem,
+                                      check_unprotected_PKCS8_PEM, dump_pem,
+                                      OSSL_SERIALIZER_PrivateKey_TO_PEM_PQ);
+}
+
+static const char *pass_cipher = "AES-256-CBC";
+static const char *pass = "the holy handgrenade of antioch";
+
+static int check_protected_PKCS8_DER(int type,
+                                     const void *data, size_t data_len)
+{
+    const unsigned char *datap = data;
+    X509_SIG *p8 = d2i_X509_SIG(NULL, &datap, data_len);
+    int ok = TEST_ptr(p8);
+
+    X509_SIG_free(p8);
+    return ok;
+}
+
+static int test_protected_RSA_via_DER(void)
+{
+    return test_serialize_deserialize(key_RSA, pass, pass_cipher,
+                                      serialize_EVP_PKEY,
+                                      deserialize_EVP_PKEY,
+                                      check_protected_PKCS8_DER, dump_der,
+                                      OSSL_SERIALIZER_PrivateKey_TO_DER_PQ);
+}
+
+static int check_protected_PKCS8_PEM(int type,
+                                     const void *data, size_t data_len)
+{
+    static const char pem_header[] = "-----BEGIN " PEM_STRING_PKCS8 "-----";
+
+    return TEST_strn_eq(data, pem_header, sizeof(pem_header) - 1);
+}
+
+static int test_protected_RSA_via_PEM(void)
+{
+    return test_serialize_deserialize(key_RSA, pass, pass_cipher,
+                                      serialize_EVP_PKEY,
+                                      deserialize_EVP_PKEY,
+                                      check_protected_PKCS8_PEM, dump_pem,
                                       OSSL_SERIALIZER_PrivateKey_TO_PEM_PQ);
 }
 
@@ -193,8 +260,10 @@ int setup_tests(void)
         return 0;
     TEST_info("Generating key... done");
 
-    ADD_TEST(test_RSA_via_DER);
-    ADD_TEST(test_RSA_via_PEM);
+    ADD_TEST(test_unprotected_RSA_via_DER);
+    ADD_TEST(test_unprotected_RSA_via_PEM);
+    ADD_TEST(test_protected_RSA_via_DER);
+    ADD_TEST(test_protected_RSA_via_PEM);
 
     return 1;
 }