crypto/x509/x_pubkey.c

   1 /*
   2  * Copyright 1995-2020 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 /*
  11  * DSA low level APIs are deprecated for public use, but still ok for
  12  * internal use.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <stdio.h>
  17 #include "internal/cryptlib.h"
  18 #include <openssl/asn1t.h>
  19 #include <openssl/x509.h>
  20 #include "crypto/asn1.h"
  21 #include "crypto/evp.h"
  22 #include "crypto/x509.h"
  23 #include <openssl/rsa.h>
  24 #include <openssl/dsa.h>
  25 #include <openssl/serializer.h>
  26
  27 struct X509_pubkey_st {
  28     X509_ALGOR *algor;
  29     ASN1_BIT_STRING *public_key;
  30     EVP_PKEY *pkey;
  31 };
  32
  33 static int x509_pubkey_decode(EVP_PKEY **pk, X509_PUBKEY *key);
  34
  35 /* Minor tweak to operation: free up EVP_PKEY */
  36 static int pubkey_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
  37                      void *exarg)
  38 {
  39     if (operation == ASN1_OP_FREE_POST) {
  40         X509_PUBKEY *pubkey = (X509_PUBKEY *)*pval;
  41         EVP_PKEY_free(pubkey->pkey);
  42     } else if (operation == ASN1_OP_D2I_POST) {
  43         /* Attempt to decode public key and cache in pubkey structure. */
  44         X509_PUBKEY *pubkey = (X509_PUBKEY *)*pval;
  45         EVP_PKEY_free(pubkey->pkey);
  46         pubkey->pkey = NULL;
  47         /*
  48          * Opportunistically decode the key but remove any non fatal errors
  49          * from the queue. Subsequent explicit attempts to decode/use the key
  50          * will return an appropriate error.
  51          */
  52         ERR_set_mark();
  53         if (x509_pubkey_decode(&pubkey->pkey, pubkey) == -1)
  54             return 0;
  55         ERR_pop_to_mark();
  56     }
  57     return 1;
  58 }
  59
  60 ASN1_SEQUENCE_cb(X509_PUBKEY, pubkey_cb) = {
  61         ASN1_SIMPLE(X509_PUBKEY, algor, X509_ALGOR),
  62         ASN1_SIMPLE(X509_PUBKEY, public_key, ASN1_BIT_STRING)
  63 } ASN1_SEQUENCE_END_cb(X509_PUBKEY, X509_PUBKEY)
  64
  65 IMPLEMENT_ASN1_FUNCTIONS(X509_PUBKEY)
  66 IMPLEMENT_ASN1_DUP_FUNCTION(X509_PUBKEY)
  67
  68 /* TODO should better be called X509_PUBKEY_set1 */
  69 int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey)
  70 {
  71     X509_PUBKEY *pk = NULL;
  72
  73     if (x == NULL)
  74         return 0;
  75
  76     if (pkey == NULL)
  77         goto unsupported;
  78
  79     if (pkey->ameth != NULL) {
  80         if ((pk = X509_PUBKEY_new()) == NULL) {
  81             X509err(X509_F_X509_PUBKEY_SET, ERR_R_MALLOC_FAILURE);
  82             goto error;
  83         }
  84         if (pkey->ameth->pub_encode != NULL) {
  85             if (!pkey->ameth->pub_encode(pk, pkey)) {
  86                 X509err(X509_F_X509_PUBKEY_SET,
  87                         X509_R_PUBLIC_KEY_ENCODE_ERROR);
  88                 goto error;
  89             }
  90         } else {
  91             X509err(X509_F_X509_PUBKEY_SET, X509_R_METHOD_NOT_SUPPORTED);
  92             goto error;
  93         }
  94     } else if (pkey->keymgmt != NULL) {
  95         BIO *bmem = BIO_new(BIO_s_mem());
  96         const char *serprop = OSSL_SERIALIZER_PUBKEY_TO_DER_PQ;
  97         OSSL_SERIALIZER_CTX *sctx =
  98             OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, serprop);
  99
 100         if (OSSL_SERIALIZER_to_bio(sctx, bmem)) {
 101             const unsigned char *der = NULL;
 102             long derlen = BIO_get_mem_data(bmem, (char **)&der);
 103
 104             pk = d2i_X509_PUBKEY(NULL, &der, derlen);
 105         }
 106
 107         OSSL_SERIALIZER_CTX_free(sctx);
 108         BIO_free(bmem);
 109     }
 110
 111     if (pk == NULL)
 112         goto unsupported;
 113
 114     X509_PUBKEY_free(*x);
 115     if (!EVP_PKEY_up_ref(pkey)) {
 116         X509err(X509_F_X509_PUBKEY_SET, ERR_R_INTERNAL_ERROR);
 117         goto error;
 118     }
 119     *x = pk;
 120
 121     /*
 122      * pk->pkey is NULL when using the legacy routine, but is non-NULL when
 123      * going through the serializer, and for all intents and purposes, it's
 124      * a perfect copy of |pkey|, just not the same instance.  In that case,
 125      * we could simply return early, right here.
 126      * However, in the interest of being cautious leaning on paranoia, some
 127      * application might very well depend on the passed |pkey| being used
 128      * and none other, so we spend a few more cycles throwing away the newly
 129      * created |pk->pkey| and replace it with |pkey|.
 130      * TODO(3.0) Investigate if it's safe to change to simply return here
 131      * if |pk->pkey != NULL|.
 132      */
 133     if (pk->pkey != NULL)
 134         EVP_PKEY_free(pk->pkey);
 135
 136     pk->pkey = pkey;
 137     return 1;
 138
 139  unsupported:
 140     X509err(X509_F_X509_PUBKEY_SET, X509_R_UNSUPPORTED_ALGORITHM);
 141
 142  error:
 143     X509_PUBKEY_free(pk);
 144     return 0;
 145 }
 146
 147 /*
 148  * Attempt to decode a public key.
 149  * Returns 1 on success, 0 for a decode failure and -1 for a fatal
 150  * error e.g. malloc failure.
 151  */
 152
 153
 154 static int x509_pubkey_decode(EVP_PKEY **ppkey, X509_PUBKEY *key)
 155 {
 156     EVP_PKEY *pkey = EVP_PKEY_new();
 157
 158     if (pkey == NULL) {
 159         X509err(X509_F_X509_PUBKEY_DECODE, ERR_R_MALLOC_FAILURE);
 160         return -1;
 161     }
 162
 163     if (!EVP_PKEY_set_type(pkey, OBJ_obj2nid(key->algor->algorithm))) {
 164         X509err(X509_F_X509_PUBKEY_DECODE, X509_R_UNSUPPORTED_ALGORITHM);
 165         goto error;
 166     }
 167
 168     if (pkey->ameth->pub_decode) {
 169         /*
 170          * Treat any failure of pub_decode as a decode error. In
 171          * future we could have different return codes for decode
 172          * errors and fatal errors such as malloc failure.
 173          */
 174         if (!pkey->ameth->pub_decode(pkey, key)) {
 175             X509err(X509_F_X509_PUBKEY_DECODE, X509_R_PUBLIC_KEY_DECODE_ERROR);
 176             goto error;
 177         }
 178     } else {
 179         X509err(X509_F_X509_PUBKEY_DECODE, X509_R_METHOD_NOT_SUPPORTED);
 180         goto error;
 181     }
 182
 183     *ppkey = pkey;
 184     return 1;
 185
 186  error:
 187     EVP_PKEY_free(pkey);
 188     return 0;
 189 }
 190
 191 EVP_PKEY *X509_PUBKEY_get0(X509_PUBKEY *key)
 192 {
 193     EVP_PKEY *ret = NULL;
 194
 195     if (key == NULL || key->public_key == NULL)
 196         return NULL;
 197
 198     if (key->pkey != NULL)
 199         return key->pkey;
 200
 201     /*
 202      * When the key ASN.1 is initially parsed an attempt is made to
 203      * decode the public key and cache the EVP_PKEY structure. If this
 204      * operation fails the cached value will be NULL. Parsing continues
 205      * to allow parsing of unknown key types or unsupported forms.
 206      * We repeat the decode operation so the appropriate errors are left
 207      * in the queue.
 208      */
 209     x509_pubkey_decode(&ret, key);
 210     /* If decode doesn't fail something bad happened */
 211     if (ret != NULL) {
 212         X509err(X509_F_X509_PUBKEY_GET0, ERR_R_INTERNAL_ERROR);
 213         EVP_PKEY_free(ret);
 214     }
 215
 216     return NULL;
 217 }
 218
 219 EVP_PKEY *X509_PUBKEY_get(X509_PUBKEY *key)
 220 {
 221     EVP_PKEY *ret = X509_PUBKEY_get0(key);
 222     if (ret != NULL)
 223         EVP_PKEY_up_ref(ret);
 224     return ret;
 225 }
 226
 227 /*
 228  * Now two pseudo ASN1 routines that take an EVP_PKEY structure and encode or
 229  * decode as X509_PUBKEY
 230  */
 231
 232 EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length)
 233 {
 234     X509_PUBKEY *xpk;
 235     EVP_PKEY *pktmp;
 236     const unsigned char *q;
 237
 238     q = *pp;
 239     xpk = d2i_X509_PUBKEY(NULL, &q, length);
 240     if (xpk == NULL)
 241         return NULL;
 242     pktmp = X509_PUBKEY_get(xpk);
 243     X509_PUBKEY_free(xpk);
 244     if (pktmp == NULL)
 245         return NULL;
 246     *pp = q;
 247     if (a != NULL) {
 248         EVP_PKEY_free(*a);
 249         *a = pktmp;
 250     }
 251     return pktmp;
 252 }
 253
 254 int i2d_PUBKEY(const EVP_PKEY *a, unsigned char **pp)
 255 {
 256     int ret = -1;
 257
 258     if (a == NULL)
 259         return 0;
 260     if (a->ameth != NULL) {
 261         X509_PUBKEY *xpk = NULL;
 262
 263         if ((xpk = X509_PUBKEY_new()) == NULL)
 264             return -1;
 265
 266         /* pub_encode() only encode parameters, not the key itself */
 267         if (a->ameth->pub_encode != NULL && a->ameth->pub_encode(xpk, a)) {
 268             xpk->pkey = (EVP_PKEY *)a;
 269             ret = i2d_X509_PUBKEY(xpk, pp);
 270             xpk->pkey = NULL;
 271         }
 272         X509_PUBKEY_free(xpk);
 273     } else if (a->keymgmt != NULL) {
 274         const char *serprop = OSSL_SERIALIZER_PUBKEY_TO_DER_PQ;
 275         OSSL_SERIALIZER_CTX *ctx =
 276             OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(a, serprop);
 277         BIO *out = BIO_new(BIO_s_mem());
 278         BUF_MEM *buf = NULL;
 279
 280         if (ctx != NULL
 281             && out != NULL
 282             && OSSL_SERIALIZER_CTX_get_serializer(ctx) != NULL
 283             && OSSL_SERIALIZER_to_bio(ctx, out)
 284             && BIO_get_mem_ptr(out, &buf) > 0) {
 285             ret = buf->length;
 286
 287             if (pp != NULL) {
 288                 if (*pp == NULL) {
 289                     *pp = (unsigned char *)buf->data;
 290                     buf->length = 0;
 291                     buf->data = NULL;
 292                 } else {
 293                     memcpy(*pp, buf->data, ret);
 294                     *pp += ret;
 295                 }
 296             }
 297         }
 298         BIO_free(out);
 299         OSSL_SERIALIZER_CTX_free(ctx);
 300     }
 301
 302     return ret;
 303 }
 304
 305 /*
 306  * The following are equivalents but which return RSA and DSA keys
 307  */
 308 #ifndef OPENSSL_NO_RSA
 309 RSA *d2i_RSA_PUBKEY(RSA **a, const unsigned char **pp, long length)
 310 {
 311     EVP_PKEY *pkey;
 312     RSA *key;
 313     const unsigned char *q;
 314
 315     q = *pp;
 316     pkey = d2i_PUBKEY(NULL, &q, length);
 317     if (pkey == NULL)
 318         return NULL;
 319     key = EVP_PKEY_get1_RSA(pkey);
 320     EVP_PKEY_free(pkey);
 321     if (key == NULL)
 322         return NULL;
 323     *pp = q;
 324     if (a != NULL) {
 325         RSA_free(*a);
 326         *a = key;
 327     }
 328     return key;
 329 }
 330
 331 int i2d_RSA_PUBKEY(const RSA *a, unsigned char **pp)
 332 {
 333     EVP_PKEY *pktmp;
 334     int ret;
 335     if (!a)
 336         return 0;
 337     pktmp = EVP_PKEY_new();
 338     if (pktmp == NULL) {
 339         ASN1err(ASN1_F_I2D_RSA_PUBKEY, ERR_R_MALLOC_FAILURE);
 340         return -1;
 341     }
 342     (void)EVP_PKEY_assign_RSA(pktmp, (RSA *)a);
 343     ret = i2d_PUBKEY(pktmp, pp);
 344     pktmp->pkey.ptr = NULL;
 345     EVP_PKEY_free(pktmp);
 346     return ret;
 347 }
 348 #endif
 349
 350 #ifndef OPENSSL_NO_DSA
 351 DSA *d2i_DSA_PUBKEY(DSA **a, const unsigned char **pp, long length)
 352 {
 353     EVP_PKEY *pkey;
 354     DSA *key;
 355     const unsigned char *q;
 356
 357     q = *pp;
 358     pkey = d2i_PUBKEY(NULL, &q, length);
 359     if (pkey == NULL)
 360         return NULL;
 361     key = EVP_PKEY_get1_DSA(pkey);
 362     EVP_PKEY_free(pkey);
 363     if (key == NULL)
 364         return NULL;
 365     *pp = q;
 366     if (a != NULL) {
 367         DSA_free(*a);
 368         *a = key;
 369     }
 370     return key;
 371 }
 372
 373 int i2d_DSA_PUBKEY(const DSA *a, unsigned char **pp)
 374 {
 375     EVP_PKEY *pktmp;
 376     int ret;
 377     if (!a)
 378         return 0;
 379     pktmp = EVP_PKEY_new();
 380     if (pktmp == NULL) {
 381         ASN1err(ASN1_F_I2D_DSA_PUBKEY, ERR_R_MALLOC_FAILURE);
 382         return -1;
 383     }
 384     (void)EVP_PKEY_assign_DSA(pktmp, (DSA *)a);
 385     ret = i2d_PUBKEY(pktmp, pp);
 386     pktmp->pkey.ptr = NULL;
 387     EVP_PKEY_free(pktmp);
 388     return ret;
 389 }
 390 #endif
 391
 392 #ifndef OPENSSL_NO_EC
 393 EC_KEY *d2i_EC_PUBKEY(EC_KEY **a, const unsigned char **pp, long length)
 394 {
 395     EVP_PKEY *pkey;
 396     EC_KEY *key;
 397     const unsigned char *q;
 398
 399     q = *pp;
 400     pkey = d2i_PUBKEY(NULL, &q, length);
 401     if (pkey == NULL)
 402         return NULL;
 403     key = EVP_PKEY_get1_EC_KEY(pkey);
 404     EVP_PKEY_free(pkey);
 405     if (key == NULL)
 406         return NULL;
 407     *pp = q;
 408     if (a != NULL) {
 409         EC_KEY_free(*a);
 410         *a = key;
 411     }
 412     return key;
 413 }
 414
 415 int i2d_EC_PUBKEY(const EC_KEY *a, unsigned char **pp)
 416 {
 417     EVP_PKEY *pktmp;
 418     int ret;
 419
 420     if (a == NULL)
 421         return 0;
 422     if ((pktmp = EVP_PKEY_new()) == NULL) {
 423         ASN1err(ASN1_F_I2D_EC_PUBKEY, ERR_R_MALLOC_FAILURE);
 424         return -1;
 425     }
 426     (void)EVP_PKEY_assign_EC_KEY(pktmp, (EC_KEY *)a);
 427     ret = i2d_PUBKEY(pktmp, pp);
 428     pktmp->pkey.ptr = NULL;
 429     EVP_PKEY_free(pktmp);
 430     return ret;
 431 }
 432 #endif
 433
 434 int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
 435                            int ptype, void *pval,
 436                            unsigned char *penc, int penclen)
 437 {
 438     if (!X509_ALGOR_set0(pub->algor, aobj, ptype, pval))
 439         return 0;
 440     if (penc) {
 441         OPENSSL_free(pub->public_key->data);
 442         pub->public_key->data = penc;
 443         pub->public_key->length = penclen;
 444         /* Set number of unused bits to zero */
 445         pub->public_key->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
 446         pub->public_key->flags |= ASN1_STRING_FLAG_BITS_LEFT;
 447     }
 448     return 1;
 449 }
 450
 451 int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
 452                            const unsigned char **pk, int *ppklen,
 453                            X509_ALGOR **pa, X509_PUBKEY *pub)
 454 {
 455     if (ppkalg)
 456         *ppkalg = pub->algor->algorithm;
 457     if (pk) {
 458         *pk = pub->public_key->data;
 459         *ppklen = pub->public_key->length;
 460     }
 461     if (pa)
 462         *pa = pub->algor;
 463     return 1;
 464 }
 465
 466 ASN1_BIT_STRING *X509_get0_pubkey_bitstr(const X509 *x)
 467 {
 468     if (x == NULL)
 469         return NULL;
 470     return x->cert_info.key->public_key;
 471 }