PROV SERIALIZER: add common functionality to serialize keys
[openssl.git] / providers / implementations / serializers / serializer_common.c
diff --git a/providers/implementations/serializers/serializer_common.c b/providers/implementations/serializers/serializer_common.c
new file mode 100644 (file)
index 0000000..6aa4e64
--- /dev/null
@@ -0,0 +1,339 @@
+/*
+ * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
+ */
+
+#include <openssl/opensslconf.h> /* SIXTY_FOUR_BIT_LONG, ... */
+#include <openssl/err.h>
+#include <openssl/pem.h>         /* PEM_BUFSIZE */
+#include <openssl/pkcs12.h>      /* PKCS8_encrypt() */
+#include <openssl/types.h>
+#include <openssl/x509.h>        /* i2d_X509_PUBKEY_bio() */
+#include "crypto/bn.h"           /* bn_get_words() */
+#include "prov/bio.h"            /* ossl_prov_bio_printf() */
+#include "prov/implementations.h"
+#include "prov/providercommonerr.h" /* PROV_R_READ_KEY */
+#include "serializer_local.h"
+
+static PKCS8_PRIV_KEY_INFO *
+ossl_prov_p8info_from_obj(const void *obj, int obj_nid,
+                          ASN1_STRING *params,
+                          int params_type,
+                          int (*k2d)(const void *obj,
+                                     unsigned char **pder))
+{
+    /* der, derlen store the key DER output and its length */
+    unsigned char *der = NULL;
+    int derlen;
+    /* The final PKCS#8 info */
+    PKCS8_PRIV_KEY_INFO *p8info = NULL;
+
+
+    if ((p8info = PKCS8_PRIV_KEY_INFO_new()) == NULL
+        || (derlen = k2d(obj, &der)) <= 0
+        || !PKCS8_pkey_set0(p8info, OBJ_nid2obj(obj_nid), 0,
+                            params_type, params, der, derlen)) {
+        ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
+        PKCS8_PRIV_KEY_INFO_free(p8info);
+        OPENSSL_free(der);
+        p8info = NULL;
+    }
+
+    return p8info;
+}
+
+static X509_SIG *ossl_prov_encp8_from_p8info(PKCS8_PRIV_KEY_INFO *p8info,
+                                             struct pkcs8_encrypt_ctx_st *ctx)
+{
+    X509_SIG *p8 = NULL;
+    char buf[PEM_BUFSIZE];
+    const void *kstr = ctx->cipher_pass;
+    size_t klen = ctx->cipher_pass_length;
+
+    if (ctx->cipher == NULL)
+        return NULL;
+
+    if (kstr == NULL) {
+        if (!ctx->cb(buf, sizeof(buf), &klen, NULL, ctx->cbarg)) {
+            ERR_raise(ERR_LIB_PROV, PROV_R_READ_KEY);
+            return NULL;
+        }
+        kstr = buf;
+    }
+    /* NID == -1 means "standard" */
+    p8 = PKCS8_encrypt(-1, ctx->cipher, kstr, klen, NULL, 0, 0, p8info);
+    if (kstr == buf)
+        OPENSSL_cleanse(buf, klen);
+    return p8;
+}
+
+static X509_SIG *ossl_prov_encp8_from_obj(const void *obj, int obj_nid,
+                                          ASN1_STRING *params,
+                                          int params_type,
+                                          int (*k2d)(const void *obj,
+                                                     unsigned char **pder),
+                                          struct pkcs8_encrypt_ctx_st *ctx)
+{
+    PKCS8_PRIV_KEY_INFO *p8info =
+        ossl_prov_p8info_from_obj(obj, obj_nid, params, params_type, k2d);
+    X509_SIG *p8 = ossl_prov_encp8_from_p8info(p8info, ctx);
+
+    PKCS8_PRIV_KEY_INFO_free(p8info);
+    return p8;
+}
+
+static X509_PUBKEY *ossl_prov_pubkey_from_obj(const void *obj, int obj_nid,
+                                              ASN1_STRING *params,
+                                              int params_type,
+                                              int (*k2d)(const void *obj,
+                                                         unsigned char **pder))
+{
+    /* der, derlen store the key DER output and its length */
+    unsigned char *der = NULL;
+    int derlen;
+    /* The final X509_PUBKEY */
+    X509_PUBKEY *xpk = NULL;
+
+
+    if ((xpk = X509_PUBKEY_new()) == NULL
+        || (derlen = k2d(obj, &der)) <= 0
+        || !X509_PUBKEY_set0_param(xpk, OBJ_nid2obj(obj_nid),
+                                   params_type, params, der, derlen)) {
+        ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
+        X509_PUBKEY_free(xpk);
+        OPENSSL_free(der);
+        xpk = NULL;
+    }
+
+    return xpk;
+}
+
+OSSL_OP_keymgmt_importkey_fn *ossl_prov_get_importkey(const OSSL_DISPATCH *fns)
+{
+    /* Pilfer the keymgmt dispatch table */
+    for (; fns->function_id != 0; fns++)
+        if (fns->function_id == OSSL_FUNC_KEYMGMT_IMPORTKEY)
+            return OSSL_get_OP_keymgmt_importkey(fns);
+
+    return NULL;
+}
+
+# ifdef SIXTY_FOUR_BIT_LONG
+#  define BN_FMTu "%lu"
+#  define BN_FMTx "%lx"
+# endif
+
+# ifdef SIXTY_FOUR_BIT
+#  define BN_FMTu "%llu"
+#  define BN_FMTx "%llx"
+# endif
+
+# ifdef THIRTY_TWO_BIT
+#  define BN_FMTu "%u"
+#  define BN_FMTx "%x"
+# endif
+
+int ossl_prov_print_labeled_bignum(BIO *out, const char *label,
+                                   const BIGNUM *n)
+{
+    const char *neg;
+    const char *post_label_spc = " ";
+    int bytes;
+    BN_ULONG *words;
+    int i, off;
+
+    if (n == NULL)
+        return 0;
+    if (label == NULL) {
+        label = "";
+        post_label_spc = "";
+    }
+
+    bytes = BN_num_bytes(n);
+    words = bn_get_words(n);
+    neg = BN_is_negative(n) ? "-" : "";
+
+    if (BN_is_zero(n))
+        return ossl_prov_bio_printf(out, "%s%s0\n", label, post_label_spc);
+
+    if (BN_num_bytes(n) <= BN_BYTES)
+        return ossl_prov_bio_printf(out,
+                                    "%s%s%s" BN_FMTu " (%s0x" BN_FMTx ")\n",
+                                    label, post_label_spc, neg, words[0],
+                                    neg, words[0]);
+
+    if (neg[0] == '-')
+        neg = " (Negative)";
+
+    if (ossl_prov_bio_printf(out, "%s%s\n", label, neg) <= 0)
+        return 0;
+
+    /* Skip past the zero bytes in the first word */
+    for (off = 0; off < BN_BYTES; off++) {
+        BN_ULONG l = words[0];
+        int o = 8 * (BN_BYTES - off - 1);
+        int b = ((l & (0xffLU << o)) >> o) & 0xff;
+
+        if (b != 0)
+            break;
+    }
+    /* print 16 hex digits per line, indented with 4 spaces */
+    for (i = 0; i < bytes; i += 16) {
+        int j, step;
+
+        if (ossl_prov_bio_printf(out, "    ") <= 0)
+            return 0;
+
+        for (j = 0; i + j < bytes && j < 16; j += BN_BYTES - step) {
+            int k;
+            BN_ULONG l = words[(i + j + off) / BN_BYTES];
+
+            step = (i + j + off) % BN_BYTES;
+
+            for (k = step; k < BN_BYTES; k++) {
+                int o = 8 * (BN_BYTES - k - 1);
+                int b = ((l & (0xffLU << o)) >> o) & 0xff;
+
+                /* We may have reached the number of bytes prematurely */
+                if (i + j + k - off >= bytes)
+                    break;
+
+                if (ossl_prov_bio_printf(out, "%02x:", b) <= 0)
+                    return 0;
+            }
+        }
+
+        if (ossl_prov_bio_printf(out, "\n") <= 0)
+            return 0;
+    }
+
+    return 1;
+}
+
+/* p2s = param to asn1_string, k2d = key to der */
+int ossl_prov_write_priv_der_from_obj(BIO *out, const void *obj, int obj_nid,
+                                      int (*p2s)(const void *obj, int nid,
+                                                 ASN1_STRING **str,
+                                                 int *strtype),
+                                      int (*k2d)(const void *obj,
+                                                 unsigned char **pder),
+                                      struct pkcs8_encrypt_ctx_st *ctx)
+{
+    int ret = 0;
+    ASN1_STRING *str = NULL;
+    int strtype = 0;
+
+    if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
+        return 0;
+
+    if (ctx->cipher_intent) {
+        X509_SIG *p8 =
+            ossl_prov_encp8_from_obj(obj, obj_nid, str, strtype, k2d, ctx);
+
+        if (p8 != NULL)
+            ret = i2d_PKCS8_bio(out, p8);
+
+        X509_SIG_free(p8);
+    } else {
+        PKCS8_PRIV_KEY_INFO *p8info =
+            ossl_prov_p8info_from_obj(obj, obj_nid, str, strtype, k2d);
+
+        if (p8info != NULL)
+            ret = i2d_PKCS8_PRIV_KEY_INFO_bio(out, p8info);
+
+        PKCS8_PRIV_KEY_INFO_free(p8info);
+    }
+
+    return ret;
+}
+
+int ossl_prov_write_priv_pem_from_obj(BIO *out, const void *obj, int obj_nid,
+                                      int (*p2s)(const void *obj, int nid,
+                                                 ASN1_STRING **str,
+                                                 int *strtype),
+                                      int (*k2d)(const void *obj,
+                                                 unsigned char **pder),
+                                      struct pkcs8_encrypt_ctx_st *ctx)
+{
+    int ret = 0;
+    ASN1_STRING *str = NULL;
+    int strtype = 0;
+
+    if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
+        return 0;
+
+    if (ctx->cipher_intent) {
+        X509_SIG *p8 = ossl_prov_encp8_from_obj(obj, obj_nid, str, strtype,
+                                                k2d, ctx);
+
+        if (p8 != NULL)
+            ret = PEM_write_bio_PKCS8(out, p8);
+
+        X509_SIG_free(p8);
+    } else {
+        PKCS8_PRIV_KEY_INFO *p8info =
+            ossl_prov_p8info_from_obj(obj, obj_nid, str, strtype, k2d);
+
+        if (p8info != NULL)
+            ret = PEM_write_bio_PKCS8_PRIV_KEY_INFO(out, p8info);
+
+        PKCS8_PRIV_KEY_INFO_free(p8info);
+    }
+
+    return ret;
+}
+
+int ossl_prov_write_pub_der_from_obj(BIO *out, const void *obj, int obj_nid,
+                                     int (*p2s)(const void *obj, int nid,
+                                                ASN1_STRING **str,
+                                                int *strtype),
+                                     int (*k2d)(const void *obj,
+                                                unsigned char **pder))
+{
+    int ret = 0;
+    ASN1_STRING *str = NULL;
+    int strtype = 0;
+    X509_PUBKEY *xpk = NULL;
+
+    if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
+        return 0;
+
+    xpk = ossl_prov_pubkey_from_obj(obj, obj_nid, str, strtype, k2d);
+
+    if (xpk != NULL)
+        ret = i2d_X509_PUBKEY_bio(out, xpk);
+
+    /* Also frees |str| */
+    X509_PUBKEY_free(xpk);
+    return ret;
+}
+
+int ossl_prov_write_pub_pem_from_obj(BIO *out, const void *obj, int obj_nid,
+                                     int (*p2s)(const void *obj, int nid,
+                                                ASN1_STRING **str,
+                                                int *strtype),
+                                     int (*k2d)(const void *obj,
+                                                unsigned char **pder))
+{
+    int ret = 0;
+    ASN1_STRING *str = NULL;
+    int strtype = 0;
+    X509_PUBKEY *xpk = NULL;
+
+    if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
+        return 0;
+
+    xpk = ossl_prov_pubkey_from_obj(obj, obj_nid, str, strtype, k2d);
+
+    if (xpk != NULL)
+        ret = PEM_write_bio_X509_PUBKEY(out, xpk);
+
+    /* Also frees |str| */
+    X509_PUBKEY_free(xpk);
+    return ret;
+}
+