/src/openssl/crypto/pkcs12/p12_kiss.c

Source
/*
 * Copyright 1999-2026 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 <stdio.h>
#include "internal/cryptlib.h"
#include <openssl/pkcs12.h>
#include "crypto/x509.h" /* for ossl_x509_add_cert_new() */

/* Simplified PKCS#12 routines */

static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
    EVP_PKEY **pkey, STACK_OF(X509) *ocerts);

static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
    int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts,
    OSSL_LIB_CTX *libctx, const char *propq);

static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
    EVP_PKEY **pkey, STACK_OF(X509) *ocerts,
    OSSL_LIB_CTX *libctx, const char *propq);

/*
 * Parse and decrypt a PKCS#12 structure returning user key, user cert and
 * other (CA) certs. Note either ca should be NULL, *ca should be NULL, or it
 * should point to a valid STACK structure. pkey and/or cert may be NULL;
 * if non-NULL the variables they point to can be passed uninitialised.
 */

int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
    STACK_OF(X509) **ca)
{
    STACK_OF(X509) *ocerts = NULL;
    X509 *x = NULL;
    STACK_OF(X509) *initial_ca = ca != NULL ? *ca : NULL;
    int initial_ca_count = initial_ca == NULL ? 0 : sk_X509_num(initial_ca);
    int ca_added_count = 0;

    if (pkey != NULL)
        *pkey = NULL;
    if (cert != NULL)
        *cert = NULL;

    /* Check for NULL PKCS12 structure */

    if (p12 == NULL) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_INVALID_NULL_PKCS12_POINTER);
        return 0;
    }

    /* Check the mac */
    if (PKCS12_mac_present(p12)) {
        /*
         * If password is zero length or NULL then try verifying both cases to
         * determine which password is correct. The reason for this is that under
         * PKCS#12 password based encryption no password and a zero length
         * password are two different things...
         */
        if (pass == NULL || *pass == '\0') {
            if (PKCS12_verify_mac(p12, NULL, 0))
                pass = NULL;
            else if (PKCS12_verify_mac(p12, "", 0))
                pass = "";
            else {
                ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_VERIFY_FAILURE);
                goto err;
            }
        } else if (!PKCS12_verify_mac(p12, pass, -1)) {
            ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_VERIFY_FAILURE);
            goto err;
        }
    } else if (pass == NULL || *pass == '\0') {
        pass = NULL;
    }

    /* If needed, allocate stack for other certificates */
    if ((cert != NULL || ca != NULL)
        && (ocerts = sk_X509_new_null()) == NULL) {
        ERR_raise(ERR_LIB_PKCS12, ERR_R_CRYPTO_LIB);
        goto err;
    }

    if (!parse_pk12(p12, pass, -1, pkey, ocerts)) {
        int err = ERR_peek_last_error();

        if (ERR_GET_LIB(err) != ERR_LIB_EVP
            && ERR_GET_REASON(err) != EVP_R_UNSUPPORTED_ALGORITHM)
            ERR_raise(ERR_LIB_PKCS12, PKCS12_R_PARSE_ERROR);
        goto err;
    }

    /* Split the certs in ocerts over *cert and *ca as far as requested */
    while ((x = sk_X509_shift(ocerts)) != NULL) {
        if (pkey != NULL && *pkey != NULL
            && cert != NULL && *cert == NULL) {
            int match;

            ERR_set_mark();
            match = X509_check_private_key(x, *pkey);
            ERR_pop_to_mark();
            if (match) {
                *cert = x;
                continue;
            }
        }

        if (ca != NULL) {
            if (!ossl_x509_add_cert_new(ca, x, X509_ADD_FLAG_DEFAULT))
                goto err;
            continue;
        }
        X509_free(x);
    }
    sk_X509_free(ocerts);

    return 1;

err:

    if (pkey != NULL) {
        EVP_PKEY_free(*pkey);
        *pkey = NULL;
    }
    if (cert != NULL) {
        X509_free(*cert);
        *cert = NULL;
    }

    ca_added_count = ca == NULL || *ca == NULL ? 0 : sk_X509_num(*ca) - initial_ca_count;
    while (ca_added_count > 0) {
        X509 *t_cert = sk_X509_pop(*ca);
        X509_free(t_cert);
        ca_added_count--;
    }

    if (initial_ca == NULL && ca != NULL) {
        sk_X509_free(*ca);
        *ca = NULL;
    }

    X509_free(x);
    OSSL_STACK_OF_X509_free(ocerts);
    return 0;
}

/* Parse the outer PKCS#12 structure */

/* pkey and/or ocerts may be NULL */
static int parse_pk12(PKCS12 *p12, const char *pass, int passlen,
    EVP_PKEY **pkey, STACK_OF(X509) *ocerts)
{
    STACK_OF(PKCS7) *asafes;
    STACK_OF(PKCS12_SAFEBAG) *bags;
    int i, bagnid;
    PKCS7 *p7;

    if ((asafes = PKCS12_unpack_authsafes(p12)) == NULL)
        return 0;
    for (i = 0; i < sk_PKCS7_num(asafes); i++) {
        p7 = sk_PKCS7_value(asafes, i);
        bagnid = OBJ_obj2nid(p7->type);
        if (bagnid == NID_pkcs7_data) {
            bags = PKCS12_unpack_p7data(p7);
        } else if (bagnid == NID_pkcs7_encrypted) {
            bags = PKCS12_unpack_p7encdata(p7, pass, passlen);
        } else
            continue;
        if (!bags) {
            sk_PKCS7_pop_free(asafes, PKCS7_free);
            return 0;
        }
        if (!parse_bags(bags, pass, passlen, pkey, ocerts,
                p7->ctx.libctx, p7->ctx.propq)) {
            sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
            sk_PKCS7_pop_free(asafes, PKCS7_free);
            return 0;
        }
        sk_PKCS12_SAFEBAG_pop_free(bags, PKCS12_SAFEBAG_free);
    }
    sk_PKCS7_pop_free(asafes, PKCS7_free);
    return 1;
}

/* pkey and/or ocerts may be NULL */
static int parse_bags(const STACK_OF(PKCS12_SAFEBAG) *bags, const char *pass,
    int passlen, EVP_PKEY **pkey, STACK_OF(X509) *ocerts,
    OSSL_LIB_CTX *libctx, const char *propq)
{
    int i;
    for (i = 0; i < sk_PKCS12_SAFEBAG_num(bags); i++) {
        if (!parse_bag(sk_PKCS12_SAFEBAG_value(bags, i),
                pass, passlen, pkey, ocerts,
                libctx, propq))
            return 0;
    }
    return 1;
}

/* pkey and/or ocerts may be NULL */
static int parse_bag(PKCS12_SAFEBAG *bag, const char *pass, int passlen,
    EVP_PKEY **pkey, STACK_OF(X509) *ocerts,
    OSSL_LIB_CTX *libctx, const char *propq)
{
    PKCS8_PRIV_KEY_INFO *p8;
    X509 *x509;
    const ASN1_TYPE *attrib;
    ASN1_BMPSTRING *fname = NULL;
    ASN1_OCTET_STRING *lkid = NULL;

    if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_friendlyName))) {
        if (attrib->type != V_ASN1_BMPSTRING)
            return 0;
        fname = attrib->value.bmpstring;
    }

    if ((attrib = PKCS12_SAFEBAG_get0_attr(bag, NID_localKeyID))) {
        if (attrib->type != V_ASN1_OCTET_STRING)
            return 0;
        lkid = attrib->value.octet_string;
    }

    switch (PKCS12_SAFEBAG_get_nid(bag)) {
    case NID_keyBag:
        if (pkey == NULL || *pkey != NULL)
            return 1;
        *pkey = EVP_PKCS82PKEY_ex(PKCS12_SAFEBAG_get0_p8inf(bag),
            libctx, propq);
        if (*pkey == NULL)
            return 0;
        break;

    case NID_pkcs8ShroudedKeyBag:
        if (pkey == NULL || *pkey != NULL)
            return 1;
        if ((p8 = PKCS12_decrypt_skey_ex(bag, pass, passlen,
                 libctx, propq))
            == NULL)
            return 0;
        *pkey = EVP_PKCS82PKEY_ex(p8, libctx, propq);
        PKCS8_PRIV_KEY_INFO_free(p8);
        if (!(*pkey))
            return 0;
        break;

    case NID_certBag:
        if (ocerts == NULL
            || PKCS12_SAFEBAG_get_bag_nid(bag) != NID_x509Certificate)
            return 1;
        if ((x509 = PKCS12_SAFEBAG_get1_cert_ex(bag, libctx, propq)) == NULL)
            return 0;
        if (lkid && !X509_keyid_set1(x509, lkid->data, lkid->length)) {
            X509_free(x509);
            return 0;
        }
        if (fname) {
            int len, r;
            unsigned char *data;

            len = ASN1_STRING_to_UTF8(&data, fname);
            if (len >= 0) {
                r = X509_alias_set1(x509, data, len);
                OPENSSL_free(data);
                if (!r) {
                    X509_free(x509);
                    return 0;
                }
            }
        }

        if (!sk_X509_push(ocerts, x509)) {
            X509_free(x509);
            return 0;
        }

        break;

    case NID_safeContentsBag:
        return parse_bags(PKCS12_SAFEBAG_get0_safes(bag), pass, passlen, pkey,
            ocerts, libctx, propq);

    default:
        return 1;
    }
    return 1;
}

Coverage Report

Created: 2026-08-31 06:56

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