/src/openssl/crypto/pkcs12/p12_mutl.c

Source (jump to first uncovered line)
/*
 * Copyright 1999-2023 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
 */

/*
 * HMAC low level APIs are deprecated for public use, but still ok for internal
 * use.
 */
#include "internal/deprecated.h"

#include <stdio.h>
#include "internal/cryptlib.h"
#include <openssl/crypto.h>
#include <openssl/hmac.h>
#include <openssl/rand.h>
#include <openssl/pkcs12.h>
#include "p12_local.h"

int PKCS12_mac_present(const PKCS12 *p12)
{
    return p12->mac ? 1 : 0;
}

void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac,
                     const X509_ALGOR **pmacalg,
                     const ASN1_OCTET_STRING **psalt,
                     const ASN1_INTEGER **piter,
                     const PKCS12 *p12)
{
    if (p12->mac) {
        X509_SIG_get0(p12->mac->dinfo, pmacalg, pmac);
        if (psalt)
            *psalt = p12->mac->salt;
        if (piter)
            *piter = p12->mac->iter;
    } else {
        if (pmac)
            *pmac = NULL;
        if (pmacalg)
            *pmacalg = NULL;
        if (psalt)
            *psalt = NULL;
        if (piter)
            *piter = NULL;
    }
}

#define TK26_MAC_KEY_LEN 32

static int pkcs12_gen_gost_mac_key(const char *pass, int passlen,
                                   const unsigned char *salt, int saltlen,
                                   int iter, int keylen, unsigned char *key,
                                   const EVP_MD *digest)
{
    unsigned char out[96];

    if (keylen != TK26_MAC_KEY_LEN) {
        return 0;
    }

    if (!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter,
                           digest, sizeof(out), out)) {
        return 0;
    }
    memcpy(key, out + sizeof(out) - TK26_MAC_KEY_LEN, TK26_MAC_KEY_LEN);
    OPENSSL_cleanse(out, sizeof(out));
    return 1;
}

/* Generate a MAC */
static int pkcs12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
                          unsigned char *mac, unsigned int *maclen,
                          int (*pkcs12_key_gen)(const char *pass, int passlen,
                                                unsigned char *salt, int slen,
                                                int id, int iter, int n,
                                                unsigned char *out,
                                                const EVP_MD *md_type))
{
    int ret = 0;
    const EVP_MD *md;
    EVP_MD *md_fetch;
    HMAC_CTX *hmac = NULL;
    unsigned char key[EVP_MAX_MD_SIZE], *salt;
    int saltlen, iter;
    char md_name[80];
    int md_size = 0;
    int md_nid;
    const X509_ALGOR *macalg;
    const ASN1_OBJECT *macoid;

    if (!PKCS7_type_is_data(p12->authsafes)) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_CONTENT_TYPE_NOT_DATA);
        return 0;
    }

    if (p12->authsafes->d.data == NULL) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_DECODE_ERROR);
        return 0;
    }

    salt = p12->mac->salt->data;
    saltlen = p12->mac->salt->length;
    if (p12->mac->iter == NULL)
        iter = 1;
    else
        iter = ASN1_INTEGER_get(p12->mac->iter);
    X509_SIG_get0(p12->mac->dinfo, &macalg, NULL);
    X509_ALGOR_get0(&macoid, NULL, NULL, macalg);
    if (OBJ_obj2txt(md_name, sizeof(md_name), macoid, 0) < 0)
        return 0;

    (void)ERR_set_mark();
    md = md_fetch = EVP_MD_fetch(p12->authsafes->ctx.libctx, md_name,
                                 p12->authsafes->ctx.propq);
    if (md == NULL)
        md = EVP_get_digestbynid(OBJ_obj2nid(macoid));

    if (md == NULL) {
        (void)ERR_clear_last_mark();
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_UNKNOWN_DIGEST_ALGORITHM);
        return 0;
    }
    (void)ERR_pop_to_mark();

    md_size = EVP_MD_get_size(md);
    md_nid = EVP_MD_get_type(md);
    if (md_size < 0)
        goto err;
    if ((md_nid == NID_id_GostR3411_94
         || md_nid == NID_id_GostR3411_2012_256
         || md_nid == NID_id_GostR3411_2012_512)
        && ossl_safe_getenv("LEGACY_GOST_PKCS12") == NULL) {
        md_size = TK26_MAC_KEY_LEN;
        if (!pkcs12_gen_gost_mac_key(pass, passlen, salt, saltlen, iter,
                                     md_size, key, md)) {
            ERR_raise(ERR_LIB_PKCS12, PKCS12_R_KEY_GEN_ERROR);
            goto err;
        }
    } else {
        if (pkcs12_key_gen != NULL) {
            if (!(*pkcs12_key_gen)(pass, passlen, salt, saltlen, PKCS12_MAC_ID,
                                   iter, md_size, key, md)) {
                ERR_raise(ERR_LIB_PKCS12, PKCS12_R_KEY_GEN_ERROR);
                goto err;
            }
        } else {
            /* Default to UTF-8 password */
            if (!PKCS12_key_gen_utf8_ex(pass, passlen, salt, saltlen, PKCS12_MAC_ID,
                                       iter, md_size, key, md,
                                       p12->authsafes->ctx.libctx,
                                       p12->authsafes->ctx.propq)) {
                ERR_raise(ERR_LIB_PKCS12, PKCS12_R_KEY_GEN_ERROR);
                goto err;
            }
        }
    }
    if ((hmac = HMAC_CTX_new()) == NULL
        || !HMAC_Init_ex(hmac, key, md_size, md, NULL)
        || !HMAC_Update(hmac, p12->authsafes->d.data->data,
                        p12->authsafes->d.data->length)
        || !HMAC_Final(hmac, mac, maclen)) {
        goto err;
    }
    ret = 1;

err:
    OPENSSL_cleanse(key, sizeof(key));
    HMAC_CTX_free(hmac);
    EVP_MD_free(md_fetch);
    return ret;
}

int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
                   unsigned char *mac, unsigned int *maclen)
{
    return pkcs12_gen_mac(p12, pass, passlen, mac, maclen, NULL);
}

/* Verify the mac */
int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen)
{
    unsigned char mac[EVP_MAX_MD_SIZE];
    unsigned int maclen;
    const ASN1_OCTET_STRING *macoct;

    if (p12->mac == NULL) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_ABSENT);
        return 0;
    }
    if (!pkcs12_gen_mac(p12, pass, passlen, mac, &maclen, NULL)) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_GENERATION_ERROR);
        return 0;
    }
    X509_SIG_get0(p12->mac->dinfo, NULL, &macoct);
    if ((maclen != (unsigned int)ASN1_STRING_length(macoct))
        || CRYPTO_memcmp(mac, ASN1_STRING_get0_data(macoct), maclen) != 0)
        return 0;

    return 1;
}

/* Set a mac */

int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
                   unsigned char *salt, int saltlen, int iter,
                   const EVP_MD *md_type)
{
    unsigned char mac[EVP_MAX_MD_SIZE];
    unsigned int maclen;
    ASN1_OCTET_STRING *macoct;

    if (md_type == NULL)
        /* No need to do a fetch as the md_type is used only to get a NID */
        md_type = EVP_sha256();
    if (!iter)
        iter = PKCS12_DEFAULT_ITER;
    if (PKCS12_setup_mac(p12, iter, salt, saltlen, md_type) == PKCS12_ERROR) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_SETUP_ERROR);
        return 0;
    }
    /*
     * Note that output mac is forced to UTF-8...
     */
    if (!pkcs12_gen_mac(p12, pass, passlen, mac, &maclen, NULL)) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_GENERATION_ERROR);
        return 0;
    }
    X509_SIG_getm(p12->mac->dinfo, NULL, &macoct);
    if (!ASN1_OCTET_STRING_set(macoct, mac, maclen)) {
        ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_STRING_SET_ERROR);
        return 0;
    }
    return 1;
}

/* Set up a mac structure */
int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, int saltlen,
                     const EVP_MD *md_type)
{
    X509_ALGOR *macalg;

    PKCS12_MAC_DATA_free(p12->mac);
    p12->mac = NULL;

    if ((p12->mac = PKCS12_MAC_DATA_new()) == NULL)
        return PKCS12_ERROR;
    if (iter > 1) {
        if ((p12->mac->iter = ASN1_INTEGER_new()) == NULL) {
            ERR_raise(ERR_LIB_PKCS12, ERR_R_ASN1_LIB);
            return 0;
        }
        if (!ASN1_INTEGER_set(p12->mac->iter, iter)) {
            ERR_raise(ERR_LIB_PKCS12, ERR_R_ASN1_LIB);
            return 0;
        }
    }
    if (saltlen == 0)
        saltlen = PKCS12_SALT_LEN;
    else if (saltlen < 0)
        return 0;
    if ((p12->mac->salt->data = OPENSSL_malloc(saltlen)) == NULL)
        return 0;
    p12->mac->salt->length = saltlen;
    if (salt == NULL) {
        if (RAND_bytes_ex(p12->authsafes->ctx.libctx, p12->mac->salt->data,
                          (size_t)saltlen, 0) <= 0)
            return 0;
    } else {
        memcpy(p12->mac->salt->data, salt, saltlen);
    }
    X509_SIG_getm(p12->mac->dinfo, &macalg, NULL);
    if (!X509_ALGOR_set0(macalg, OBJ_nid2obj(EVP_MD_get_type(md_type)),
                         V_ASN1_NULL, NULL)) {
        ERR_raise(ERR_LIB_PKCS12, ERR_R_ASN1_LIB);
        return 0;
    }

    return 1;
}

Coverage Report

Created: 2024-02-25 06:25

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 1999-2023 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		* HMAC low level APIs are deprecated for public use, but still ok for internal
12		* use.
13		*/
14		#include "internal/deprecated.h"
15
16		#include <stdio.h>
17		#include "internal/cryptlib.h"
18		#include <openssl/crypto.h>
19		#include <openssl/hmac.h>
20		#include <openssl/rand.h>
21		#include <openssl/pkcs12.h>
22		#include "p12_local.h"
23
24		int PKCS12_mac_present(const PKCS12 *p12)
25	0	{
26	0	return p12->mac ? 1 : 0;
27	0	}
28
29		void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac,
30		const X509_ALGOR **pmacalg,
31		const ASN1_OCTET_STRING **psalt,
32		const ASN1_INTEGER **piter,
33		const PKCS12 *p12)
34	0	{
35	0	if (p12->mac) {
36	0	X509_SIG_get0(p12->mac->dinfo, pmacalg, pmac);
37	0	if (psalt)
38	0	*psalt = p12->mac->salt;
39	0	if (piter)
40	0	*piter = p12->mac->iter;
41	0	} else {
42	0	if (pmac)
43	0	*pmac = NULL;
44	0	if (pmacalg)
45	0	*pmacalg = NULL;
46	0	if (psalt)
47	0	*psalt = NULL;
48	0	if (piter)
49	0	*piter = NULL;
50	0	}
51	0	}
52
53	0	#define TK26_MAC_KEY_LEN 32
54
55		static int pkcs12_gen_gost_mac_key(const char *pass, int passlen,
56		const unsigned char *salt, int saltlen,
57		int iter, int keylen, unsigned char *key,
58		const EVP_MD *digest)
59	0	{
60	0	unsigned char out[96];
61
62	0	if (keylen != TK26_MAC_KEY_LEN) {
63	0	return 0;
64	0	}
65
66	0	if (!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter,
67	0	digest, sizeof(out), out)) {
68	0	return 0;
69	0	}
70	0	memcpy(key, out + sizeof(out) - TK26_MAC_KEY_LEN, TK26_MAC_KEY_LEN);
71	0	OPENSSL_cleanse(out, sizeof(out));
72	0	return 1;
73	0	}
74
75		/* Generate a MAC */
76		static int pkcs12_gen_mac(PKCS12 p12, const char pass, int passlen,
77		unsigned char mac, unsigned int maclen,
78		int (pkcs12_key_gen)(const char pass, int passlen,
79		unsigned char *salt, int slen,
80		int id, int iter, int n,
81		unsigned char *out,
82		const EVP_MD *md_type))
83	0	{
84	0	int ret = 0;
85	0	const EVP_MD *md;
86	0	EVP_MD *md_fetch;
87	0	HMAC_CTX *hmac = NULL;
88	0	unsigned char key[EVP_MAX_MD_SIZE], *salt;
89	0	int saltlen, iter;
90	0	char md_name[80];
91	0	int md_size = 0;
92	0	int md_nid;
93	0	const X509_ALGOR *macalg;
94	0	const ASN1_OBJECT *macoid;
95
96	0	if (!PKCS7_type_is_data(p12->authsafes)) {
97	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_CONTENT_TYPE_NOT_DATA);
98	0	return 0;
99	0	}
100
101	0	if (p12->authsafes->d.data == NULL) {
102	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_DECODE_ERROR);
103	0	return 0;
104	0	}
105
106	0	salt = p12->mac->salt->data;
107	0	saltlen = p12->mac->salt->length;
108	0	if (p12->mac->iter == NULL)
109	0	iter = 1;
110	0	else
111	0	iter = ASN1_INTEGER_get(p12->mac->iter);
112	0	X509_SIG_get0(p12->mac->dinfo, &macalg, NULL);
113	0	X509_ALGOR_get0(&macoid, NULL, NULL, macalg);
114	0	if (OBJ_obj2txt(md_name, sizeof(md_name), macoid, 0) < 0)
115	0	return 0;
116
117	0	(void)ERR_set_mark();
118	0	md = md_fetch = EVP_MD_fetch(p12->authsafes->ctx.libctx, md_name,
119	0	p12->authsafes->ctx.propq);
120	0	if (md == NULL)
121	0	md = EVP_get_digestbynid(OBJ_obj2nid(macoid));
122
123	0	if (md == NULL) {
124	0	(void)ERR_clear_last_mark();
125	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_UNKNOWN_DIGEST_ALGORITHM);
126	0	return 0;
127	0	}
128	0	(void)ERR_pop_to_mark();
129
130	0	md_size = EVP_MD_get_size(md);
131	0	md_nid = EVP_MD_get_type(md);
132	0	if (md_size < 0)
133	0	goto err;
134	0	if ((md_nid == NID_id_GostR3411_94
135	0	\|\| md_nid == NID_id_GostR3411_2012_256
136	0	\|\| md_nid == NID_id_GostR3411_2012_512)
137	0	&& ossl_safe_getenv("LEGACY_GOST_PKCS12") == NULL) {
138	0	md_size = TK26_MAC_KEY_LEN;
139	0	if (!pkcs12_gen_gost_mac_key(pass, passlen, salt, saltlen, iter,
140	0	md_size, key, md)) {
141	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_KEY_GEN_ERROR);
142	0	goto err;
143	0	}
144	0	} else {
145	0	if (pkcs12_key_gen != NULL) {
146	0	if (!(*pkcs12_key_gen)(pass, passlen, salt, saltlen, PKCS12_MAC_ID,
147	0	iter, md_size, key, md)) {
148	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_KEY_GEN_ERROR);
149	0	goto err;
150	0	}
151	0	} else {
152		/* Default to UTF-8 password */
153	0	if (!PKCS12_key_gen_utf8_ex(pass, passlen, salt, saltlen, PKCS12_MAC_ID,
154	0	iter, md_size, key, md,
155	0	p12->authsafes->ctx.libctx,
156	0	p12->authsafes->ctx.propq)) {
157	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_KEY_GEN_ERROR);
158	0	goto err;
159	0	}
160	0	}
161	0	}
162	0	if ((hmac = HMAC_CTX_new()) == NULL
163	0	\|\| !HMAC_Init_ex(hmac, key, md_size, md, NULL)
164	0	\|\| !HMAC_Update(hmac, p12->authsafes->d.data->data,
165	0	p12->authsafes->d.data->length)
166	0	\|\| !HMAC_Final(hmac, mac, maclen)) {
167	0	goto err;
168	0	}
169	0	ret = 1;
170
171	0	err:
172	0	OPENSSL_cleanse(key, sizeof(key));
173	0	HMAC_CTX_free(hmac);
174	0	EVP_MD_free(md_fetch);
175	0	return ret;
176	0	}
177
178		int PKCS12_gen_mac(PKCS12 p12, const char pass, int passlen,
179		unsigned char mac, unsigned int maclen)
180	0	{
181	0	return pkcs12_gen_mac(p12, pass, passlen, mac, maclen, NULL);
182	0	}
183
184		/* Verify the mac */
185		int PKCS12_verify_mac(PKCS12 p12, const char pass, int passlen)
186	0	{
187	0	unsigned char mac[EVP_MAX_MD_SIZE];
188	0	unsigned int maclen;
189	0	const ASN1_OCTET_STRING *macoct;
190
191	0	if (p12->mac == NULL) {
192	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_ABSENT);
193	0	return 0;
194	0	}
195	0	if (!pkcs12_gen_mac(p12, pass, passlen, mac, &maclen, NULL)) {
196	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_GENERATION_ERROR);
197	0	return 0;
198	0	}
199	0	X509_SIG_get0(p12->mac->dinfo, NULL, &macoct);
200	0	if ((maclen != (unsigned int)ASN1_STRING_length(macoct))
201	0	\|\| CRYPTO_memcmp(mac, ASN1_STRING_get0_data(macoct), maclen) != 0)
202	0	return 0;
203
204	0	return 1;
205	0	}
206
207		/* Set a mac */
208
209		int PKCS12_set_mac(PKCS12 p12, const char pass, int passlen,
210		unsigned char *salt, int saltlen, int iter,
211		const EVP_MD *md_type)
212	0	{
213	0	unsigned char mac[EVP_MAX_MD_SIZE];
214	0	unsigned int maclen;
215	0	ASN1_OCTET_STRING *macoct;
216
217	0	if (md_type == NULL)
218		/* No need to do a fetch as the md_type is used only to get a NID */
219	0	md_type = EVP_sha256();
220	0	if (!iter)
221	0	iter = PKCS12_DEFAULT_ITER;
222	0	if (PKCS12_setup_mac(p12, iter, salt, saltlen, md_type) == PKCS12_ERROR) {
223	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_SETUP_ERROR);
224	0	return 0;
225	0	}
226		/*
227		* Note that output mac is forced to UTF-8...
228		*/
229	0	if (!pkcs12_gen_mac(p12, pass, passlen, mac, &maclen, NULL)) {
230	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_GENERATION_ERROR);
231	0	return 0;
232	0	}
233	0	X509_SIG_getm(p12->mac->dinfo, NULL, &macoct);
234	0	if (!ASN1_OCTET_STRING_set(macoct, mac, maclen)) {
235	0	ERR_raise(ERR_LIB_PKCS12, PKCS12_R_MAC_STRING_SET_ERROR);
236	0	return 0;
237	0	}
238	0	return 1;
239	0	}
240
241		/* Set up a mac structure */
242		int PKCS12_setup_mac(PKCS12 p12, int iter, unsigned char salt, int saltlen,
243		const EVP_MD *md_type)
244	0	{
245	0	X509_ALGOR *macalg;
246
247	0	PKCS12_MAC_DATA_free(p12->mac);
248	0	p12->mac = NULL;
249
250	0	if ((p12->mac = PKCS12_MAC_DATA_new()) == NULL)
251	0	return PKCS12_ERROR;
252	0	if (iter > 1) {
253	0	if ((p12->mac->iter = ASN1_INTEGER_new()) == NULL) {
254	0	ERR_raise(ERR_LIB_PKCS12, ERR_R_ASN1_LIB);
255	0	return 0;
256	0	}
257	0	if (!ASN1_INTEGER_set(p12->mac->iter, iter)) {
258	0	ERR_raise(ERR_LIB_PKCS12, ERR_R_ASN1_LIB);
259	0	return 0;
260	0	}
261	0	}
262	0	if (saltlen == 0)
263	0	saltlen = PKCS12_SALT_LEN;
264	0	else if (saltlen < 0)
265	0	return 0;
266	0	if ((p12->mac->salt->data = OPENSSL_malloc(saltlen)) == NULL)
267	0	return 0;
268	0	p12->mac->salt->length = saltlen;
269	0	if (salt == NULL) {
270	0	if (RAND_bytes_ex(p12->authsafes->ctx.libctx, p12->mac->salt->data,
271	0	(size_t)saltlen, 0) <= 0)
272	0	return 0;
273	0	} else {
274	0	memcpy(p12->mac->salt->data, salt, saltlen);
275	0	}
276	0	X509_SIG_getm(p12->mac->dinfo, &macalg, NULL);
277	0	if (!X509_ALGOR_set0(macalg, OBJ_nid2obj(EVP_MD_get_type(md_type)),
278	0	V_ASN1_NULL, NULL)) {
279	0	ERR_raise(ERR_LIB_PKCS12, ERR_R_ASN1_LIB);
280	0	return 0;
281	0	}
282
283	0	return 1;
284	0	}