crypto/x509/x_pubkey.c

   1 /*
   2  * Copyright 1995-2018 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 <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include <openssl/asn1t.h>
  13 #include <openssl/x509.h>
  14 #include "internal/asn1_int.h"
  15 #include "internal/evp_int.h"
  16 #include "internal/x509_int.h"
  17 #include <openssl/rsa.h>
  18 #include <openssl/dsa.h>
  19
  20 struct X509_pubkey_st {
  21     X509_ALGOR *algor;
  22     ASN1_BIT_STRING *public_key;
  23     EVP_PKEY *pkey;
  24 };
  25
  26 static int x509_pubkey_decode(EVP_PKEY **pk, X509_PUBKEY *key);
  27
  28 /* Minor tweak to operation: free up EVP_PKEY */
  29 static int pubkey_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
  30                      void *exarg)
  31 {
  32     if (operation == ASN1_OP_FREE_POST) {
  33         X509_PUBKEY *pubkey = (X509_PUBKEY *)*pval;
  34         EVP_PKEY_free(pubkey->pkey);
  35     } else if (operation == ASN1_OP_D2I_POST) {
  36         /* Attempt to decode public key and cache in pubkey structure. */
  37         X509_PUBKEY *pubkey = (X509_PUBKEY *)*pval;
  38         EVP_PKEY_free(pubkey->pkey);
  39         pubkey->pkey = NULL;
  40         /*
  41          * Opportunistically decode the key but remove any non fatal errors
  42          * from the queue. Subsequent explicit attempts to decode/use the key
  43          * will return an appropriate error.
  44          */
  45         ERR_set_mark();
  46         if (x509_pubkey_decode(&pubkey->pkey, pubkey) == -1)
  47             return 0;
  48         ERR_pop_to_mark();
  49     }
  50     return 1;
  51 }
  52
  53 ASN1_SEQUENCE_cb(X509_PUBKEY, pubkey_cb) = {
  54         ASN1_SIMPLE(X509_PUBKEY, algor, X509_ALGOR),
  55         ASN1_SIMPLE(X509_PUBKEY, public_key, ASN1_BIT_STRING)
  56 } ASN1_SEQUENCE_END_cb(X509_PUBKEY, X509_PUBKEY)
  57
  58 IMPLEMENT_ASN1_FUNCTIONS(X509_PUBKEY)
  59 IMPLEMENT_ASN1_DUP_FUNCTION(X509_PUBKEY)
  60
  61 /* TODO should better be called X509_PUBKEY_set1 */
  62 int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey)
  63 {
  64     X509_PUBKEY *pk = NULL;
  65
  66     if (x == NULL)
  67         return 0;
  68
  69     if ((pk = X509_PUBKEY_new()) == NULL)
  70         goto error;
  71
  72     if (pkey != NULL && pkey->ameth) {
  73         if (pkey->ameth->pub_encode) {
  74             if (!pkey->ameth->pub_encode(pk, pkey)) {
  75                 X509err(X509_F_X509_PUBKEY_SET,
  76                         X509_R_PUBLIC_KEY_ENCODE_ERROR);
  77                 goto error;
  78             }
  79         } else {
  80             X509err(X509_F_X509_PUBKEY_SET, X509_R_METHOD_NOT_SUPPORTED);
  81             goto error;
  82         }
  83     } else {
  84         X509err(X509_F_X509_PUBKEY_SET, X509_R_UNSUPPORTED_ALGORITHM);
  85         goto error;
  86     }
  87
  88     X509_PUBKEY_free(*x);
  89     *x = pk;
  90     pk->pkey = pkey;
  91     return EVP_PKEY_up_ref(pkey);
  92
  93  error:
  94     X509_PUBKEY_free(pk);
  95     return 0;
  96 }
  97
  98 /*
  99  * Attempt to decode a public key.
 100  * Returns 1 on success, 0 for a decode failure and -1 for a fatal
 101  * error e.g. malloc failure.
 102  */
 103
 104
 105 static int x509_pubkey_decode(EVP_PKEY **ppkey, X509_PUBKEY *key)
 106 {
 107     EVP_PKEY *pkey = EVP_PKEY_new();
 108
 109     if (pkey == NULL) {
 110         X509err(X509_F_X509_PUBKEY_DECODE, ERR_R_MALLOC_FAILURE);
 111         return -1;
 112     }
 113
 114     if (!EVP_PKEY_set_type(pkey, OBJ_obj2nid(key->algor->algorithm))) {
 115         X509err(X509_F_X509_PUBKEY_DECODE, X509_R_UNSUPPORTED_ALGORITHM);
 116         goto error;
 117     }
 118
 119     if (pkey->ameth->pub_decode) {
 120         /*
 121          * Treat any failure of pub_decode as a decode error. In
 122          * future we could have different return codes for decode
 123          * errors and fatal errors such as malloc failure.
 124          */
 125         if (!pkey->ameth->pub_decode(pkey, key)) {
 126             X509err(X509_F_X509_PUBKEY_DECODE, X509_R_PUBLIC_KEY_DECODE_ERROR);
 127             goto error;
 128         }
 129     } else {
 130         X509err(X509_F_X509_PUBKEY_DECODE, X509_R_METHOD_NOT_SUPPORTED);
 131         goto error;
 132     }
 133
 134     *ppkey = pkey;
 135     return 1;
 136
 137  error:
 138     EVP_PKEY_free(pkey);
 139     return 0;
 140 }
 141
 142 EVP_PKEY *X509_PUBKEY_get0(X509_PUBKEY *key)
 143 {
 144     EVP_PKEY *ret = NULL;
 145
 146     if (key == NULL || key->public_key == NULL)
 147         return NULL;
 148
 149     if (key->pkey != NULL)
 150         return key->pkey;
 151
 152     /*
 153      * When the key ASN.1 is initially parsed an attempt is made to
 154      * decode the public key and cache the EVP_PKEY structure. If this
 155      * operation fails the cached value will be NULL. Parsing continues
 156      * to allow parsing of unknown key types or unsupported forms.
 157      * We repeat the decode operation so the appropriate errors are left
 158      * in the queue.
 159      */
 160     x509_pubkey_decode(&ret, key);
 161     /* If decode doesn't fail something bad happened */
 162     if (ret != NULL) {
 163         X509err(X509_F_X509_PUBKEY_GET0, ERR_R_INTERNAL_ERROR);
 164         EVP_PKEY_free(ret);
 165     }
 166
 167     return NULL;
 168 }
 169
 170 EVP_PKEY *X509_PUBKEY_get(X509_PUBKEY *key)
 171 {
 172     EVP_PKEY *ret = X509_PUBKEY_get0(key);
 173     if (ret != NULL)
 174         EVP_PKEY_up_ref(ret);
 175     return ret;
 176 }
 177
 178 /*
 179  * Now two pseudo ASN1 routines that take an EVP_PKEY structure and encode or
 180  * decode as X509_PUBKEY
 181  */
 182
 183 EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length)
 184 {
 185     X509_PUBKEY *xpk;
 186     EVP_PKEY *pktmp;
 187     const unsigned char *q;
 188     q = *pp;
 189     xpk = d2i_X509_PUBKEY(NULL, &q, length);
 190     if (!xpk)
 191         return NULL;
 192     pktmp = X509_PUBKEY_get(xpk);
 193     X509_PUBKEY_free(xpk);
 194     if (!pktmp)
 195         return NULL;
 196     *pp = q;
 197     if (a) {
 198         EVP_PKEY_free(*a);
 199         *a = pktmp;
 200     }
 201     return pktmp;
 202 }
 203
 204 int i2d_PUBKEY(const EVP_PKEY *a, unsigned char **pp)
 205 {
 206     X509_PUBKEY *xpk = NULL;
 207     int ret = -1;
 208
 209     if (a == NULL)
 210         return 0;
 211     if ((xpk = X509_PUBKEY_new()) == NULL)
 212         return -1;
 213     if (a->ameth != NULL && a->ameth->pub_encode != NULL
 214         && !a->ameth->pub_encode(xpk, a))
 215         goto error;
 216     xpk->pkey = (EVP_PKEY *)a;
 217     ret = i2d_X509_PUBKEY(xpk, pp);
 218     xpk->pkey = NULL;
 219  error:
 220     X509_PUBKEY_free(xpk);
 221     return ret;
 222 }
 223
 224 /*
 225  * The following are equivalents but which return RSA and DSA keys
 226  */
 227 #ifndef OPENSSL_NO_RSA
 228 RSA *d2i_RSA_PUBKEY(RSA **a, const unsigned char **pp, long length)
 229 {
 230     EVP_PKEY *pkey;
 231     RSA *key;
 232     const unsigned char *q;
 233     q = *pp;
 234     pkey = d2i_PUBKEY(NULL, &q, length);
 235     if (!pkey)
 236         return NULL;
 237     key = EVP_PKEY_get1_RSA(pkey);
 238     EVP_PKEY_free(pkey);
 239     if (!key)
 240         return NULL;
 241     *pp = q;
 242     if (a) {
 243         RSA_free(*a);
 244         *a = key;
 245     }
 246     return key;
 247 }
 248
 249 int i2d_RSA_PUBKEY(const RSA *a, unsigned char **pp)
 250 {
 251     EVP_PKEY *pktmp;
 252     int ret;
 253     if (!a)
 254         return 0;
 255     pktmp = EVP_PKEY_new();
 256     if (pktmp == NULL) {
 257         ASN1err(ASN1_F_I2D_RSA_PUBKEY, ERR_R_MALLOC_FAILURE);
 258         return -1;
 259     }
 260     (void)EVP_PKEY_assign_RSA(pktmp, (RSA *)a);
 261     ret = i2d_PUBKEY(pktmp, pp);
 262     pktmp->pkey.ptr = NULL;
 263     EVP_PKEY_free(pktmp);
 264     return ret;
 265 }
 266 #endif
 267
 268 #ifndef OPENSSL_NO_DSA
 269 DSA *d2i_DSA_PUBKEY(DSA **a, const unsigned char **pp, long length)
 270 {
 271     EVP_PKEY *pkey;
 272     DSA *key;
 273     const unsigned char *q;
 274     q = *pp;
 275     pkey = d2i_PUBKEY(NULL, &q, length);
 276     if (!pkey)
 277         return NULL;
 278     key = EVP_PKEY_get1_DSA(pkey);
 279     EVP_PKEY_free(pkey);
 280     if (!key)
 281         return NULL;
 282     *pp = q;
 283     if (a) {
 284         DSA_free(*a);
 285         *a = key;
 286     }
 287     return key;
 288 }
 289
 290 int i2d_DSA_PUBKEY(const DSA *a, unsigned char **pp)
 291 {
 292     EVP_PKEY *pktmp;
 293     int ret;
 294     if (!a)
 295         return 0;
 296     pktmp = EVP_PKEY_new();
 297     if (pktmp == NULL) {
 298         ASN1err(ASN1_F_I2D_DSA_PUBKEY, ERR_R_MALLOC_FAILURE);
 299         return -1;
 300     }
 301     (void)EVP_PKEY_assign_DSA(pktmp, (DSA *)a);
 302     ret = i2d_PUBKEY(pktmp, pp);
 303     pktmp->pkey.ptr = NULL;
 304     EVP_PKEY_free(pktmp);
 305     return ret;
 306 }
 307 #endif
 308
 309 #ifndef OPENSSL_NO_EC
 310 EC_KEY *d2i_EC_PUBKEY(EC_KEY **a, const unsigned char **pp, long length)
 311 {
 312     EVP_PKEY *pkey;
 313     EC_KEY *key;
 314     const unsigned char *q;
 315     q = *pp;
 316     pkey = d2i_PUBKEY(NULL, &q, length);
 317     if (!pkey)
 318         return NULL;
 319     key = EVP_PKEY_get1_EC_KEY(pkey);
 320     EVP_PKEY_free(pkey);
 321     if (!key)
 322         return NULL;
 323     *pp = q;
 324     if (a) {
 325         EC_KEY_free(*a);
 326         *a = key;
 327     }
 328     return key;
 329 }
 330
 331 int i2d_EC_PUBKEY(const EC_KEY *a, unsigned char **pp)
 332 {
 333     EVP_PKEY *pktmp;
 334     int ret;
 335     if (!a)
 336         return 0;
 337     if ((pktmp = EVP_PKEY_new()) == NULL) {
 338         ASN1err(ASN1_F_I2D_EC_PUBKEY, ERR_R_MALLOC_FAILURE);
 339         return -1;
 340     }
 341     (void)EVP_PKEY_assign_EC_KEY(pktmp, (EC_KEY *)a);
 342     ret = i2d_PUBKEY(pktmp, pp);
 343     pktmp->pkey.ptr = NULL;
 344     EVP_PKEY_free(pktmp);
 345     return ret;
 346 }
 347 #endif
 348
 349 int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
 350                            int ptype, void *pval,
 351                            unsigned char *penc, int penclen)
 352 {
 353     if (!X509_ALGOR_set0(pub->algor, aobj, ptype, pval))
 354         return 0;
 355     if (penc) {
 356         OPENSSL_free(pub->public_key->data);
 357         pub->public_key->data = penc;
 358         pub->public_key->length = penclen;
 359         /* Set number of unused bits to zero */
 360         pub->public_key->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
 361         pub->public_key->flags |= ASN1_STRING_FLAG_BITS_LEFT;
 362     }
 363     return 1;
 364 }
 365
 366 int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
 367                            const unsigned char **pk, int *ppklen,
 368                            X509_ALGOR **pa, X509_PUBKEY *pub)
 369 {
 370     if (ppkalg)
 371         *ppkalg = pub->algor->algorithm;
 372     if (pk) {
 373         *pk = pub->public_key->data;
 374         *ppklen = pub->public_key->length;
 375     }
 376     if (pa)
 377         *pa = pub->algor;
 378     return 1;
 379 }
 380
 381 ASN1_BIT_STRING *X509_get0_pubkey_bitstr(const X509 *x)
 382 {
 383     if (x == NULL)
 384         return NULL;
 385     return x->cert_info.key->public_key;
 386 }