crypto/pkcs12/p12_kiss.c

   1 /*
   2  * Copyright 1999-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 #include <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include <openssl/pkcs12.h>
  13 #include "crypto/x509.h" /* for X509_add_cert_new() */
  14
  15 DEFINE_STACK_OF(PKCS7)
  16 DEFINE_STACK_OF(PKCS12_SAFEBAG)
  17
  18 /* Simplified PKCS#12 routines */
  19
  20 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
  21                       EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
  22
  23 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
  24                       int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
  25
  26 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
  27                      EVP_PKEY **pkey, STACK_OF(X509) *ocerts);
  28
  29 /*
  30  * Parse and decrypt a PKCS#12 structure returning user key, user cert and
  31  * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
  32  * should point to a valid STACK structure. pkey and/or cert may be NULL;
  33  * if non-NULL the variables they point to can be passed uninitialised.
  34  */
  35
  36 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
  37                  STACK_OF(X509) **ca)
  38 {
  39     STACK_OF(X509) *ocerts = NULL;
  40     X509 *x = NULL;
  41
  42     if (pkey != NULL)
  43         *pkey = NULL;
  44     if (cert != NULL)
  45         *cert = NULL;
  46
  47     /* Check for NULL PKCS12 structure */
  48
  49     if (p12 == NULL) {
  50         PKCS12err(PKCS12_F_PKCS12_PARSE,
  51                   PKCS12_R_INVALID_NULL_PKCS12_POINTER);
  52         return 0;
  53     }
  54
  55     /* Check the mac */
  56
  57     /*
  58      * If password is zero length or NULL then try verifying both cases to
  59      * determine which password is correct. The reason for this is that under
  60      * PKCS#12 password based encryption no password and a zero length
  61      * password are two different things...
  62      */
  63
  64     if (pass == NULL || *pass == '\0') {
  65         if (PKCS12_verify_mac(p12, NULL, 0))
  66             pass = NULL;
  67         else if (PKCS12_verify_mac(p12, "", 0))
  68             pass = "";
  69         else {
  70             PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
  71             goto err;
  72         }
  73     } else if (!PKCS12_verify_mac(p12, pass, -1)) {
  74         PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_MAC_VERIFY_FAILURE);
  75         goto err;
  76     }
  77
  78     /* If needed, allocate stack for other certificates */
  79     if ((cert != NULL || ca != NULL)
  80             && (ocerts = sk_X509_new_null()) == NULL) {
  81         PKCS12err(PKCS12_F_PKCS12_PARSE, ERR_R_MALLOC_FAILURE);
  82         goto err;
  83     }
  84
  85     if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
  86         PKCS12err(PKCS12_F_PKCS12_PARSE, PKCS12_R_PARSE_ERROR);
  87         goto err;
  88     }
  89
  90     /* Split the certs in ocerts over *cert and *ca as far as requested */
  91     while ((x = sk_X509_shift(ocerts)) != NULL) {
  92         if (pkey != NULL && *pkey != NULL
  93                 && cert != NULL && *cert == NULL) {
  94             int match;
  95
  96             ERR_set_mark();
  97             match = X509_check_private_key(x, *pkey);
  98             ERR_pop_to_mark();
  99             if (match) {
 100                 *cert = x;
 101                 continue;
 102             }
 103         }
 104
 105         if (ca != NULL) {
 106             if (!X509_add_cert_new(ca, x, X509_ADD_FLAG_DEFAULT))
 107                 goto err;
 108             continue;
 109         }
 110         X509_free(x);
 111     }
 112     sk_X509_free(ocerts);
 113
 114     return 1;
 115
 116  err:
 117
 118     if (pkey != NULL) {
 119         EVP_PKEY_free(*pkey);
 120         *pkey = NULL;
 121     }
 122     if (cert != NULL) {
 123         X509_free(*cert);
 124         *cert = NULL;
 125     }
 126     X509_free(x);
 127     sk_X509_pop_free(ocerts, X509_free);
 128     return 0;
 129
 130 }
 131
 132 /* Parse the outer PKCS#12 structure */
 133
 134 /* pkey and/or ocerts may be NULL */
 135 static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
 136                       EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
 137 {
 138     STACK_OF(PKCS7) *asafes;
 139     STACK_OF(PKCS12_SAFEBAG) *bags;
 140     int i, bagnid;
 141     PKCS7 *p7;
 142
 143     if ((asafes = PKCS12_unpack_authsafes(p12)) == NULL)
 144         return 0;
 145     for (i = 0; i < sk_PKCS7_num(asafes); i++) {
 146         p7 = sk_PKCS7_value(asafes, i);
 147         bagnid = OBJ_obj2nid(p7->type);
 148         if (bagnid == NID_pkcs7_data) {
 149             bags = PKCS12_unpack_p7data(p7);
 150         } else if (bagnid == NID_pkcs7_encrypted) {
 151             bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
 152         } else
 153             continue;
 154         if (!bags) {
 155             sk_PKCS7_pop_free(asafes, PKCS7_free);
 156             return 0;
 157         }
 158         if (!parse_bags(bags, pass, passlen, pkey, ocerts)) {
 159             sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
 160             sk_PKCS7_pop_free(asafes, PKCS7_free);
 161             return 0;
 162         }
 163         sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
 164     }
 165     sk_PKCS7_pop_free(asafes, PKCS7_free);
 166     return 1;
 167 }
 168
 169 /* pkey and/or ocerts may be NULL */
 170 static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
 171                       int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
 172 {
 173     int i;
 174     for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
 175         if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
 176                        pass, passlen, pkey, ocerts))
 177             return 0;
 178     }
 179     return 1;
 180 }
 181
 182 /* pkey and/or ocerts may be NULL */
 183 static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
 184                      EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
 185 {
 186     PKCS8_PRIV_KEY_INFO *p8;
 187     X509 *x509;
 188     const ASN1_TYPE *attrib;
 189     ASN1_BMPSTRING *fname = NULL;
 190     ASN1_OCTET_STRING *lkid = NULL;
 191
 192     if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_friendlyName)))
 193         fname = attrib->value.bmpstring;
 194
 195     if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_localKeyID)))
 196         lkid = attrib->value.octet_string;
 197
 198     switch (PKCS12_SAFEBAG_get_nid(bag)) {
 199     case NID_keyBag:
 200         if (pkey == NULL || *pkey != NULL)
 201             return 1;
 202         *pkey = EVP_PKCS82PKEY(PKCS12_SAFEBAG_get0_p8inf(bag));
 203         if (*pkey == NULL)
 204             return 0;
 205         break;
 206
 207     case NID_pkcs8ShroudedKeyBag:
 208         if (pkey == NULL || *pkey != NULL)
 209             return 1;
 210         if ((p8 = PKCS12_decrypt_skey(bag, pass, passlen)) == NULL)
 211             return 0;
 212         *pkey = EVP_PKCS82PKEY(p8);
 213         PKCS8_PRIV_KEY_INFO_free(p8);
 214         if (!(*pkey))
 215             return 0;
 216         break;
 217
 218     case NID_certBag:
 219         if (ocerts == NULL
 220                 || PKCS12_SAFEBAG_get_bag_nid(bag) != NID_x509Certificate)
 221             return 1;
 222         if ((x509 = PKCS12_SAFEBAG_get1_cert(bag)) == NULL)
 223             return 0;
 224         if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
 225             X509_free(x509);
 226             return 0;
 227         }
 228         if (fname) {
 229             int len, r;
 230             unsigned char *data;
 231
 232             len = ASN1_STRING_to_UTF8(&data, fname);
 233             if (len >= 0) {
 234                 r = X509_alias_set1(x509, data, len);
 235                 OPENSSL_free(data);
 236                 if (!r) {
 237                     X509_free(x509);
 238                     return 0;
 239                 }
 240             }
 241         }
 242
 243         if (!sk_X509_push(ocerts, x509)) {
 244             X509_free(x509);
 245             return 0;
 246         }
 247
 248         break;
 249
 250     case NID_safeContentsBag:
 251         return parse_bags(PKCS12_SAFEBAG_get0_safes(bag), pass, passlen, pkey,
 252                           ocerts);
 253
 254     default:
 255         return 1;
 256     }
 257     return 1;
 258 }