providers/implementations/serializers/serializer_common.c

   1 /*
   2  * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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
   8  */
   9
  10 #include <openssl/opensslconf.h> /* SIXTY_FOUR_BIT_LONG, ... */
  11 #include <openssl/err.h>
  12 #include <openssl/pem.h>         /* PEM_BUFSIZE */
  13 #include <openssl/pkcs12.h>      /* PKCS8_encrypt() */
  14 #include <openssl/types.h>
  15 #include <openssl/x509.h>        /* i2d_X509_PUBKEY_bio() */
  16 #include "crypto/bn.h"           /* bn_get_words() */
  17 #include "prov/bio.h"            /* ossl_prov_bio_printf() */
  18 #include "prov/implementations.h"
  19 #include "prov/providercommonerr.h" /* PROV_R_READ_KEY */
  20 #include "serializer_local.h"
  21
  22 static PKCS8_PRIV_KEY_INFO *
  23 ossl_prov_p8info_from_obj(const void *obj, int obj_nid,
  24                           ASN1_STRING *params,
  25                           int params_type,
  26                           int (*k2d)(const void *obj,
  27                                      unsigned char **pder))
  28 {
  29     /* der, derlen store the key DER output and its length */
  30     unsigned char *der = NULL;
  31     int derlen;
  32     /* The final PKCS#8 info */
  33     PKCS8_PRIV_KEY_INFO *p8info = NULL;
  34
  35
  36     if ((p8info = PKCS8_PRIV_KEY_INFO_new()) == NULL
  37         || (derlen = k2d(obj, &der)) <= 0
  38         || !PKCS8_pkey_set0(p8info, OBJ_nid2obj(obj_nid), 0,
  39                             params_type, params, der, derlen)) {
  40         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  41         PKCS8_PRIV_KEY_INFO_free(p8info);
  42         OPENSSL_free(der);
  43         p8info = NULL;
  44     }
  45
  46     return p8info;
  47 }
  48
  49 static X509_SIG *ossl_prov_encp8_from_p8info(PKCS8_PRIV_KEY_INFO *p8info,
  50                                              struct pkcs8_encrypt_ctx_st *ctx)
  51 {
  52     X509_SIG *p8 = NULL;
  53     char buf[PEM_BUFSIZE];
  54     const void *kstr = ctx->cipher_pass;
  55     size_t klen = ctx->cipher_pass_length;
  56
  57     if (ctx->cipher == NULL)
  58         return NULL;
  59
  60     if (kstr == NULL) {
  61         if (!ctx->cb(buf, sizeof(buf), &klen, NULL, ctx->cbarg)) {
  62             ERR_raise(ERR_LIB_PROV, PROV_R_READ_KEY);
  63             return NULL;
  64         }
  65         kstr = buf;
  66     }
  67     /* NID == -1 means "standard" */
  68     p8 = PKCS8_encrypt(-1, ctx->cipher, kstr, klen, NULL, 0, 0, p8info);
  69     if (kstr == buf)
  70         OPENSSL_cleanse(buf, klen);
  71     return p8;
  72 }
  73
  74 static X509_SIG *ossl_prov_encp8_from_obj(const void *obj, int obj_nid,
  75                                           ASN1_STRING *params,
  76                                           int params_type,
  77                                           int (*k2d)(const void *obj,
  78                                                      unsigned char **pder),
  79                                           struct pkcs8_encrypt_ctx_st *ctx)
  80 {
  81     PKCS8_PRIV_KEY_INFO *p8info =
  82         ossl_prov_p8info_from_obj(obj, obj_nid, params, params_type, k2d);
  83     X509_SIG *p8 = ossl_prov_encp8_from_p8info(p8info, ctx);
  84
  85     PKCS8_PRIV_KEY_INFO_free(p8info);
  86     return p8;
  87 }
  88
  89 static X509_PUBKEY *ossl_prov_pubkey_from_obj(const void *obj, int obj_nid,
  90                                               ASN1_STRING *params,
  91                                               int params_type,
  92                                               int (*k2d)(const void *obj,
  93                                                          unsigned char **pder))
  94 {
  95     /* der, derlen store the key DER output and its length */
  96     unsigned char *der = NULL;
  97     int derlen;
  98     /* The final X509_PUBKEY */
  99     X509_PUBKEY *xpk = NULL;
 100
 101
 102     if ((xpk = X509_PUBKEY_new()) == NULL
 103         || (derlen = k2d(obj, &der)) <= 0
 104         || !X509_PUBKEY_set0_param(xpk, OBJ_nid2obj(obj_nid),
 105                                    params_type, params, der, derlen)) {
 106         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 107         X509_PUBKEY_free(xpk);
 108         OPENSSL_free(der);
 109         xpk = NULL;
 110     }
 111
 112     return xpk;
 113 }
 114
 115 OSSL_OP_keymgmt_new_fn *ossl_prov_get_keymgmt_new(const OSSL_DISPATCH *fns)
 116 {
 117     /* Pilfer the keymgmt dispatch table */
 118     for (; fns->function_id != 0; fns++)
 119         if (fns->function_id == OSSL_FUNC_KEYMGMT_NEW)
 120             return OSSL_get_OP_keymgmt_new(fns);
 121
 122     return NULL;
 123 }
 124
 125 OSSL_OP_keymgmt_free_fn *ossl_prov_get_keymgmt_free(const OSSL_DISPATCH *fns)
 126 {
 127     /* Pilfer the keymgmt dispatch table */
 128     for (; fns->function_id != 0; fns++)
 129         if (fns->function_id == OSSL_FUNC_KEYMGMT_FREE)
 130             return OSSL_get_OP_keymgmt_free(fns);
 131
 132     return NULL;
 133 }
 134
 135 OSSL_OP_keymgmt_import_fn *ossl_prov_get_keymgmt_import(const OSSL_DISPATCH *fns)
 136 {
 137     /* Pilfer the keymgmt dispatch table */
 138     for (; fns->function_id != 0; fns++)
 139         if (fns->function_id == OSSL_FUNC_KEYMGMT_IMPORT)
 140             return OSSL_get_OP_keymgmt_import(fns);
 141
 142     return NULL;
 143 }
 144
 145 # ifdef SIXTY_FOUR_BIT_LONG
 146 #  define BN_FMTu "%lu"
 147 #  define BN_FMTx "%lx"
 148 # endif
 149
 150 # ifdef SIXTY_FOUR_BIT
 151 #  define BN_FMTu "%llu"
 152 #  define BN_FMTx "%llx"
 153 # endif
 154
 155 # ifdef THIRTY_TWO_BIT
 156 #  define BN_FMTu "%u"
 157 #  define BN_FMTx "%x"
 158 # endif
 159
 160 int ossl_prov_print_labeled_bignum(BIO *out, const char *label,
 161                                    const BIGNUM *bn)
 162 {
 163     const char *neg;
 164     const char *post_label_spc = " ";
 165     int bytes;
 166     BN_ULONG *words;
 167     int n, i;
 168
 169     if (bn == NULL)
 170         return 0;
 171     if (label == NULL) {
 172         label = "";
 173         post_label_spc = "";
 174     }
 175
 176     bytes = BN_num_bytes(bn);
 177     words = bn_get_words(bn);
 178     neg = BN_is_negative(bn) ? "-" : "";
 179
 180     if (BN_is_zero(bn))
 181         return ossl_prov_bio_printf(out, "%s%s0\n", label, post_label_spc);
 182
 183     if (BN_num_bytes(bn) <= BN_BYTES)
 184         return ossl_prov_bio_printf(out,
 185                                     "%s%s%s" BN_FMTu " (%s0x" BN_FMTx ")\n",
 186                                     label, post_label_spc, neg, words[0],
 187                                     neg, words[0]);
 188
 189     if (neg[0] == '-')
 190         neg = " (Negative)";
 191
 192     if (ossl_prov_bio_printf(out, "%s%s\n", label, neg) <= 0)
 193         return 0;
 194
 195     /* Keep track of how many bytes we have printed out so far */
 196     n = 0;
 197
 198     /*
 199      * OpenSSL BIGNUMs are little endian limbs, so we print them last to
 200      * first limb.
 201      * i is used as limb index, j is used as the "byte index" in the limb
 202      */
 203     for (i = bytes / BN_BYTES - 1; i >= 0; i--) {
 204         BN_ULONG l = words[i];
 205         int  j;
 206
 207         for (j = BN_BYTES - 1; j >= 0; j--) {
 208             int o = 8 * j;
 209             int b = ((l & (0xffLU << o)) >> o) & 0xff;
 210
 211             /* Indent every new line with 4 spaces */
 212             if ((n % 15) == 0) {
 213                 if (n > 0)
 214                     if (ossl_prov_bio_printf(out, "\n") <= 0)
 215                         return 0;
 216                 if (ossl_prov_bio_printf(out, "    ") <= 0)
 217                     return 0;
 218             }
 219
 220             /*
 221              * Upper bit set, then we print an extra zero and pretend the
 222              * BIGNUM was one byte longer
 223              */
 224             if (n == 0 && b > 127) {
 225                 if (ossl_prov_bio_printf(out, "%02x:", 0) <= 0)
 226                     return 0;
 227                 n++;
 228                 bytes++;
 229             }
 230
 231             if (++n < bytes) {
 232                 if (ossl_prov_bio_printf(out, "%02x:", b) <= 0)
 233                     return 0;
 234             } else {
 235                 if (ossl_prov_bio_printf(out, "%02x", b) <= 0)
 236                     return 0;
 237             }
 238         }
 239     }
 240     if (ossl_prov_bio_printf(out, "\n") <= 0)
 241         return 0;
 242
 243     return 1;
 244 }
 245
 246 /* Number of octets per line */
 247 #define LABELED_BUF_PRINT_WIDTH    15
 248
 249 int ossl_prov_print_labeled_buf(BIO *out, const char *label,
 250                                 const unsigned char *buf, size_t buflen)
 251 {
 252     size_t i;
 253
 254     if (ossl_prov_bio_printf(out, "%s\n", label) <= 0)
 255         return 0;
 256
 257     for (i = 0; i < buflen; i++) {
 258         if ((i % LABELED_BUF_PRINT_WIDTH) == 0) {
 259             if (i > 0 && ossl_prov_bio_printf(out, "\n") <= 0)
 260                 return 0;
 261             if (ossl_prov_bio_printf(out, "    ") <= 0)
 262                 return 0;
 263         }
 264
 265         if (ossl_prov_bio_printf(out, "%02x%s", buf[i],
 266                                  (i == buflen - 1) ? "" : ":") <= 0)
 267             return 0;
 268     }
 269     if (ossl_prov_bio_printf(out, "\n") <= 0)
 270         return 0;
 271
 272     return 1;
 273 }
 274
 275
 276 /* p2s = param to asn1_string, k2d = key to der */
 277 int ossl_prov_write_priv_der_from_obj(BIO *out, const void *obj, int obj_nid,
 278                                       int (*p2s)(const void *obj, int nid,
 279                                                  ASN1_STRING **str,
 280                                                  int *strtype),
 281                                       int (*k2d)(const void *obj,
 282                                                  unsigned char **pder),
 283                                       struct pkcs8_encrypt_ctx_st *ctx)
 284 {
 285     int ret = 0;
 286     ASN1_STRING *str = NULL;
 287     int strtype = V_ASN1_UNDEF;
 288
 289     if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
 290         return 0;
 291
 292     if (ctx->cipher_intent) {
 293         X509_SIG *p8 =
 294             ossl_prov_encp8_from_obj(obj, obj_nid, str, strtype, k2d, ctx);
 295
 296         if (p8 != NULL)
 297             ret = i2d_PKCS8_bio(out, p8);
 298
 299         X509_SIG_free(p8);
 300     } else {
 301         PKCS8_PRIV_KEY_INFO *p8info =
 302             ossl_prov_p8info_from_obj(obj, obj_nid, str, strtype, k2d);
 303
 304         if (p8info != NULL)
 305             ret = i2d_PKCS8_PRIV_KEY_INFO_bio(out, p8info);
 306
 307         PKCS8_PRIV_KEY_INFO_free(p8info);
 308     }
 309
 310     return ret;
 311 }
 312
 313 int ossl_prov_write_priv_pem_from_obj(BIO *out, const void *obj, int obj_nid,
 314                                       int (*p2s)(const void *obj, int nid,
 315                                                  ASN1_STRING **str,
 316                                                  int *strtype),
 317                                       int (*k2d)(const void *obj,
 318                                                  unsigned char **pder),
 319                                       struct pkcs8_encrypt_ctx_st *ctx)
 320 {
 321     int ret = 0;
 322     ASN1_STRING *str = NULL;
 323     int strtype = V_ASN1_UNDEF;
 324
 325     if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
 326         return 0;
 327
 328     if (ctx->cipher_intent) {
 329         X509_SIG *p8 = ossl_prov_encp8_from_obj(obj, obj_nid, str, strtype,
 330                                                 k2d, ctx);
 331
 332         if (p8 != NULL)
 333             ret = PEM_write_bio_PKCS8(out, p8);
 334
 335         X509_SIG_free(p8);
 336     } else {
 337         PKCS8_PRIV_KEY_INFO *p8info =
 338             ossl_prov_p8info_from_obj(obj, obj_nid, str, strtype, k2d);
 339
 340         if (p8info != NULL)
 341             ret = PEM_write_bio_PKCS8_PRIV_KEY_INFO(out, p8info);
 342
 343         PKCS8_PRIV_KEY_INFO_free(p8info);
 344     }
 345
 346     return ret;
 347 }
 348
 349 int ossl_prov_write_pub_der_from_obj(BIO *out, const void *obj, int obj_nid,
 350                                      int (*p2s)(const void *obj, int nid,
 351                                                 ASN1_STRING **str,
 352                                                 int *strtype),
 353                                      int (*k2d)(const void *obj,
 354                                                 unsigned char **pder))
 355 {
 356     int ret = 0;
 357     ASN1_STRING *str = NULL;
 358     int strtype = V_ASN1_UNDEF;
 359     X509_PUBKEY *xpk = NULL;
 360
 361     if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
 362         return 0;
 363
 364     xpk = ossl_prov_pubkey_from_obj(obj, obj_nid, str, strtype, k2d);
 365
 366     if (xpk != NULL)
 367         ret = i2d_X509_PUBKEY_bio(out, xpk);
 368
 369     /* Also frees |str| */
 370     X509_PUBKEY_free(xpk);
 371     return ret;
 372 }
 373
 374 int ossl_prov_write_pub_pem_from_obj(BIO *out, const void *obj, int obj_nid,
 375                                      int (*p2s)(const void *obj, int nid,
 376                                                 ASN1_STRING **str,
 377                                                 int *strtype),
 378                                      int (*k2d)(const void *obj,
 379                                                 unsigned char **pder))
 380 {
 381     int ret = 0;
 382     ASN1_STRING *str = NULL;
 383     int strtype = V_ASN1_UNDEF;
 384     X509_PUBKEY *xpk = NULL;
 385
 386     if (p2s != NULL && !p2s(obj, obj_nid, &str, &strtype))
 387         return 0;
 388
 389     xpk = ossl_prov_pubkey_from_obj(obj, obj_nid, str, strtype, k2d);
 390
 391     if (xpk != NULL)
 392         ret = PEM_write_bio_X509_PUBKEY(out, xpk);
 393
 394     /* Also frees |str| */
 395     X509_PUBKEY_free(xpk);
 396     return ret;
 397 }
 398