/src/openssl/crypto/evp/mac_lib.c

Source (jump to first uncovered line)
/*
 * Copyright 2018-2025 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 <string.h>
#include <stdarg.h>
#include <openssl/evp.h>
#include <openssl/err.h>
#include <openssl/core.h>
#include <openssl/core_names.h>
#include <openssl/types.h>
#include "internal/nelem.h"
#include "crypto/evp.h"
#include "internal/provider.h"
#include "evp_local.h"

EVP_MAC_CTX *EVP_MAC_CTX_new(EVP_MAC *mac)
{
    EVP_MAC_CTX *ctx = OPENSSL_zalloc(sizeof(EVP_MAC_CTX));

    if (ctx != NULL) {
        ctx->meth = mac;
        if ((ctx->algctx = mac->newctx(ossl_provider_ctx(mac->prov))) == NULL
            || !EVP_MAC_up_ref(mac)) {
            mac->freectx(ctx->algctx);
            ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
            OPENSSL_free(ctx);
            ctx = NULL;
        }
    }
    return ctx;
}

void EVP_MAC_CTX_free(EVP_MAC_CTX *ctx)
{
    if (ctx == NULL)
        return;
    ctx->meth->freectx(ctx->algctx);
    ctx->algctx = NULL;
    /* refcnt-- */
    EVP_MAC_free(ctx->meth);
    OPENSSL_free(ctx);
}

EVP_MAC_CTX *EVP_MAC_CTX_dup(const EVP_MAC_CTX *src)
{
    EVP_MAC_CTX *dst;

    if (src->algctx == NULL)
        return NULL;

    dst = OPENSSL_malloc(sizeof(*dst));
    if (dst == NULL)
        return NULL;

    *dst = *src;
    if (!EVP_MAC_up_ref(dst->meth)) {
        ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
        OPENSSL_free(dst);
        return NULL;
    }

    dst->algctx = src->meth->dupctx(src->algctx);
    if (dst->algctx == NULL) {
        EVP_MAC_CTX_free(dst);
        return NULL;
    }

    return dst;
}

EVP_MAC *EVP_MAC_CTX_get0_mac(EVP_MAC_CTX *ctx)
{
    return ctx->meth;
}

static size_t get_size_t_ctx_param(EVP_MAC_CTX *ctx, const char *name)
{
    size_t sz = 0;

    if (ctx->algctx != NULL) {
        OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };

        params[0] = OSSL_PARAM_construct_size_t(name, &sz);
        if (ctx->meth->get_ctx_params != NULL) {
            if (ctx->meth->get_ctx_params(ctx->algctx, params))
                return sz;
        } else if (ctx->meth->get_params != NULL) {
            if (ctx->meth->get_params(params))
                return sz;
        }
    }
    /*
     * If the MAC hasn't been initialized yet, or there is no size to get,
     * we return zero
     */
    return 0;
}

size_t EVP_MAC_CTX_get_mac_size(EVP_MAC_CTX *ctx)
{
    return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_SIZE);
}

size_t EVP_MAC_CTX_get_block_size(EVP_MAC_CTX *ctx)
{
    return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_BLOCK_SIZE);
}

int EVP_MAC_init(EVP_MAC_CTX *ctx, const unsigned char *key, size_t keylen,
                 const OSSL_PARAM params[])
{
    if (ctx->meth->init == NULL) {
        ERR_raise(ERR_R_EVP_LIB, ERR_R_UNSUPPORTED);
        return 0;
    }
    return ctx->meth->init(ctx->algctx, key, keylen, params);
}

int EVP_MAC_init_SKEY(EVP_MAC_CTX *ctx, EVP_SKEY *skey, const OSSL_PARAM params[])
{
    if (ctx->meth->init_skey == NULL
        || skey->skeymgmt->prov != ctx->meth->prov
        || ctx->meth->init_skey == NULL) {
        ERR_raise(ERR_R_EVP_LIB, ERR_R_UNSUPPORTED);
        return 0;
    }
    return ctx->meth->init_skey(ctx->algctx, skey->keydata, params);
}

int EVP_MAC_update(EVP_MAC_CTX *ctx, const unsigned char *data, size_t datalen)
{
    return ctx->meth->update(ctx->algctx, data, datalen);
}

static int evp_mac_final(EVP_MAC_CTX *ctx, int xof,
                         unsigned char *out, size_t *outl, size_t outsize)
{
    size_t l;
    int res;
    OSSL_PARAM params[2];
    size_t macsize;

    if (ctx == NULL || ctx->meth == NULL) {
        ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_NULL_ALGORITHM);
        return 0;
    }
    if (ctx->meth->final == NULL) {
        ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
        return 0;
    }

    macsize = EVP_MAC_CTX_get_mac_size(ctx);
    if (out == NULL) {
        if (outl == NULL) {
            ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
            return 0;
        }
        *outl = macsize;
        return 1;
    }
    if (outsize < macsize) {
        ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL);
        return 0;
    }
    if (xof) {
        params[0] = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_XOF, &xof);
        params[1] = OSSL_PARAM_construct_end();

        if (EVP_MAC_CTX_set_params(ctx, params) <= 0) {
            ERR_raise(ERR_LIB_EVP, EVP_R_SETTING_XOF_FAILED);
            return 0;
        }
    }
    res = ctx->meth->final(ctx->algctx, out, &l, outsize);
    if (outl != NULL)
        *outl = l;
    return res;
}

int EVP_MAC_final(EVP_MAC_CTX *ctx,
                  unsigned char *out, size_t *outl, size_t outsize)
{
    return evp_mac_final(ctx, 0, out, outl, outsize);
}

int EVP_MAC_finalXOF(EVP_MAC_CTX *ctx, unsigned char *out, size_t outsize)
{
    return evp_mac_final(ctx, 1, out, NULL, outsize);
}

/*
 * The {get,set}_params functions return 1 if there is no corresponding
 * function in the implementation.  This is the same as if there was one,
 * but it didn't recognise any of the given params, i.e. nothing in the
 * bag of parameters was useful.
 */
int EVP_MAC_get_params(EVP_MAC *mac, OSSL_PARAM params[])
{
    if (mac->get_params != NULL)
        return mac->get_params(params);
    return 1;
}

int EVP_MAC_CTX_get_params(EVP_MAC_CTX *ctx, OSSL_PARAM params[])
{
    if (ctx->meth->get_ctx_params != NULL)
        return ctx->meth->get_ctx_params(ctx->algctx, params);
    return 1;
}

int EVP_MAC_CTX_set_params(EVP_MAC_CTX *ctx, const OSSL_PARAM params[])
{
    if (ctx->meth->set_ctx_params != NULL)
        return ctx->meth->set_ctx_params(ctx->algctx, params);
    return 1;
}

int evp_mac_get_number(const EVP_MAC *mac)
{
    return mac->name_id;
}

const char *EVP_MAC_get0_name(const EVP_MAC *mac)
{
    return mac->type_name;
}

const char *EVP_MAC_get0_description(const EVP_MAC *mac)
{
    return mac->description;
}

int EVP_MAC_is_a(const EVP_MAC *mac, const char *name)
{
    return mac != NULL && evp_is_a(mac->prov, mac->name_id, NULL, name);
}

int EVP_MAC_names_do_all(const EVP_MAC *mac,
                         void (*fn)(const char *name, void *data),
                         void *data)
{
    if (mac->prov != NULL)
        return evp_names_do_all(mac->prov, mac->name_id, fn, data);

    return 1;
}

unsigned char *EVP_Q_mac(OSSL_LIB_CTX *libctx,
                         const char *name, const char *propq,
                         const char *subalg, const OSSL_PARAM *params,
                         const void *key, size_t keylen,
                         const unsigned char *data, size_t datalen,
                         unsigned char *out, size_t outsize, size_t *outlen)
{
    EVP_MAC *mac = EVP_MAC_fetch(libctx, name, propq);
    OSSL_PARAM subalg_param[] = { OSSL_PARAM_END, OSSL_PARAM_END };
    EVP_MAC_CTX *ctx  = NULL;
    size_t len = 0;
    unsigned char *res = NULL;

    if (outlen != NULL)
        *outlen = 0;
    if (mac == NULL)
        return NULL;
    if (subalg != NULL) {
        const OSSL_PARAM *defined_params = EVP_MAC_settable_ctx_params(mac);
        const char *param_name = OSSL_MAC_PARAM_DIGEST;

        /*
         * The underlying algorithm may be a cipher or a digest.
         * We don't know which it is, but we can ask the MAC what it
         * should be and bet on that.
         */
        if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
            param_name = OSSL_MAC_PARAM_CIPHER;
            if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
                ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
                goto err;
            }
        }
        subalg_param[0] =
            OSSL_PARAM_construct_utf8_string(param_name, (char *)subalg, 0);
    }
    /* Single-shot - on NULL key input, set dummy key value for EVP_MAC_Init. */
    if (key == NULL && keylen == 0)
        key = data;
    if ((ctx = EVP_MAC_CTX_new(mac)) != NULL
            && EVP_MAC_CTX_set_params(ctx, subalg_param)
            && EVP_MAC_CTX_set_params(ctx, params)
            && EVP_MAC_init(ctx, key, keylen, params)
            && EVP_MAC_update(ctx, data, datalen)
            && EVP_MAC_final(ctx, out, &len, outsize)) {
        if (out == NULL) {
            out = OPENSSL_malloc(len);
            if (out != NULL && !EVP_MAC_final(ctx, out, NULL, len)) {
                OPENSSL_free(out);
                out = NULL;
            }
        }
        res = out;
        if (res != NULL && outlen != NULL)
            *outlen = len;
    }

 err:
    EVP_MAC_CTX_free(ctx);
    EVP_MAC_free(mac);
    return res;
}

Coverage Report

Created: 2025-06-13 06:36

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2018-2025 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 <string.h>
11		#include <stdarg.h>
12		#include <openssl/evp.h>
13		#include <openssl/err.h>
14		#include <openssl/core.h>
15		#include <openssl/core_names.h>
16		#include <openssl/types.h>
17		#include "internal/nelem.h"
18		#include "crypto/evp.h"
19		#include "internal/provider.h"
20		#include "evp_local.h"
21
22		EVP_MAC_CTX EVP_MAC_CTX_new(EVP_MAC mac)
23	0	{
24	0	EVP_MAC_CTX *ctx = OPENSSL_zalloc(sizeof(EVP_MAC_CTX));
25
26	0	if (ctx != NULL) {
27	0	ctx->meth = mac;
28	0	if ((ctx->algctx = mac->newctx(ossl_provider_ctx(mac->prov))) == NULL
29	0	\|\| !EVP_MAC_up_ref(mac)) {
30	0	mac->freectx(ctx->algctx);
31	0	ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
32	0	OPENSSL_free(ctx);
33	0	ctx = NULL;
34	0	}
35	0	}
36	0	return ctx;
37	0	}
38
39		void EVP_MAC_CTX_free(EVP_MAC_CTX *ctx)
40	0	{
41	0	if (ctx == NULL)
42	0	return;
43	0	ctx->meth->freectx(ctx->algctx);
44	0	ctx->algctx = NULL;
45		/* refcnt-- */
46	0	EVP_MAC_free(ctx->meth);
47	0	OPENSSL_free(ctx);
48	0	}
49
50		EVP_MAC_CTX EVP_MAC_CTX_dup(const EVP_MAC_CTX src)
51	0	{
52	0	EVP_MAC_CTX *dst;
53
54	0	if (src->algctx == NULL)
55	0	return NULL;
56
57	0	dst = OPENSSL_malloc(sizeof(*dst));
58	0	if (dst == NULL)
59	0	return NULL;
60
61	0	dst = src;
62	0	if (!EVP_MAC_up_ref(dst->meth)) {
63	0	ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
64	0	OPENSSL_free(dst);
65	0	return NULL;
66	0	}
67
68	0	dst->algctx = src->meth->dupctx(src->algctx);
69	0	if (dst->algctx == NULL) {
70	0	EVP_MAC_CTX_free(dst);
71	0	return NULL;
72	0	}
73
74	0	return dst;
75	0	}
76
77		EVP_MAC EVP_MAC_CTX_get0_mac(EVP_MAC_CTX ctx)
78	0	{
79	0	return ctx->meth;
80	0	}
81
82		static size_t get_size_t_ctx_param(EVP_MAC_CTX ctx, const char name)
83	0	{
84	0	size_t sz = 0;
85
86	0	if (ctx->algctx != NULL) {
87	0	OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
88
89	0	params[0] = OSSL_PARAM_construct_size_t(name, &sz);
90	0	if (ctx->meth->get_ctx_params != NULL) {
91	0	if (ctx->meth->get_ctx_params(ctx->algctx, params))
92	0	return sz;
93	0	} else if (ctx->meth->get_params != NULL) {
94	0	if (ctx->meth->get_params(params))
95	0	return sz;
96	0	}
97	0	}
98		/*
99		* If the MAC hasn't been initialized yet, or there is no size to get,
100		* we return zero
101		*/
102	0	return 0;
103	0	}
104
105		size_t EVP_MAC_CTX_get_mac_size(EVP_MAC_CTX *ctx)
106	0	{
107	0	return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_SIZE);
108	0	}
109
110		size_t EVP_MAC_CTX_get_block_size(EVP_MAC_CTX *ctx)
111	0	{
112	0	return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_BLOCK_SIZE);
113	0	}
114
115		int EVP_MAC_init(EVP_MAC_CTX ctx, const unsigned char key, size_t keylen,
116		const OSSL_PARAM params[])
117	0	{
118	0	if (ctx->meth->init == NULL) {
119	0	ERR_raise(ERR_R_EVP_LIB, ERR_R_UNSUPPORTED);
120	0	return 0;
121	0	}
122	0	return ctx->meth->init(ctx->algctx, key, keylen, params);
123	0	}
124
125		int EVP_MAC_init_SKEY(EVP_MAC_CTX ctx, EVP_SKEY skey, const OSSL_PARAM params[])
126	0	{
127	0	if (ctx->meth->init_skey == NULL
128	0	\|\| skey->skeymgmt->prov != ctx->meth->prov
129	0	\|\| ctx->meth->init_skey == NULL) {
130	0	ERR_raise(ERR_R_EVP_LIB, ERR_R_UNSUPPORTED);
131	0	return 0;
132	0	}
133	0	return ctx->meth->init_skey(ctx->algctx, skey->keydata, params);
134	0	}
135
136		int EVP_MAC_update(EVP_MAC_CTX ctx, const unsigned char data, size_t datalen)
137	0	{
138	0	return ctx->meth->update(ctx->algctx, data, datalen);
139	0	}
140
141		static int evp_mac_final(EVP_MAC_CTX *ctx, int xof,
142		unsigned char out, size_t outl, size_t outsize)
143	0	{
144	0	size_t l;
145	0	int res;
146	0	OSSL_PARAM params[2];
147	0	size_t macsize;
148
149	0	if (ctx == NULL \|\| ctx->meth == NULL) {
150	0	ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_NULL_ALGORITHM);
151	0	return 0;
152	0	}
153	0	if (ctx->meth->final == NULL) {
154	0	ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
155	0	return 0;
156	0	}
157
158	0	macsize = EVP_MAC_CTX_get_mac_size(ctx);
159	0	if (out == NULL) {
160	0	if (outl == NULL) {
161	0	ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
162	0	return 0;
163	0	}
164	0	*outl = macsize;
165	0	return 1;
166	0	}
167	0	if (outsize < macsize) {
168	0	ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL);
169	0	return 0;
170	0	}
171	0	if (xof) {
172	0	params[0] = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_XOF, &xof);
173	0	params[1] = OSSL_PARAM_construct_end();
174
175	0	if (EVP_MAC_CTX_set_params(ctx, params) <= 0) {
176	0	ERR_raise(ERR_LIB_EVP, EVP_R_SETTING_XOF_FAILED);
177	0	return 0;
178	0	}
179	0	}
180	0	res = ctx->meth->final(ctx->algctx, out, &l, outsize);
181	0	if (outl != NULL)
182	0	*outl = l;
183	0	return res;
184	0	}
185
186		int EVP_MAC_final(EVP_MAC_CTX *ctx,
187		unsigned char out, size_t outl, size_t outsize)
188	0	{
189	0	return evp_mac_final(ctx, 0, out, outl, outsize);
190	0	}
191
192		int EVP_MAC_finalXOF(EVP_MAC_CTX ctx, unsigned char out, size_t outsize)
193	0	{
194	0	return evp_mac_final(ctx, 1, out, NULL, outsize);
195	0	}
196
197		/*
198		* The {get,set}_params functions return 1 if there is no corresponding
199		* function in the implementation. This is the same as if there was one,
200		* but it didn't recognise any of the given params, i.e. nothing in the
201		* bag of parameters was useful.
202		*/
203		int EVP_MAC_get_params(EVP_MAC *mac, OSSL_PARAM params[])
204	0	{
205	0	if (mac->get_params != NULL)
206	0	return mac->get_params(params);
207	0	return 1;
208	0	}
209
210		int EVP_MAC_CTX_get_params(EVP_MAC_CTX *ctx, OSSL_PARAM params[])
211	0	{
212	0	if (ctx->meth->get_ctx_params != NULL)
213	0	return ctx->meth->get_ctx_params(ctx->algctx, params);
214	0	return 1;
215	0	}
216
217		int EVP_MAC_CTX_set_params(EVP_MAC_CTX *ctx, const OSSL_PARAM params[])
218	0	{
219	0	if (ctx->meth->set_ctx_params != NULL)
220	0	return ctx->meth->set_ctx_params(ctx->algctx, params);
221	0	return 1;
222	0	}
223
224		int evp_mac_get_number(const EVP_MAC *mac)
225	0	{
226	0	return mac->name_id;
227	0	}
228
229		const char EVP_MAC_get0_name(const EVP_MAC mac)
230	0	{
231	0	return mac->type_name;
232	0	}
233
234		const char EVP_MAC_get0_description(const EVP_MAC mac)
235	0	{
236	0	return mac->description;
237	0	}
238
239		int EVP_MAC_is_a(const EVP_MAC mac, const char name)
240	0	{
241	0	return mac != NULL && evp_is_a(mac->prov, mac->name_id, NULL, name);
242	0	}
243
244		int EVP_MAC_names_do_all(const EVP_MAC *mac,
245		void (fn)(const char name, void *data),
246		void *data)
247	0	{
248	0	if (mac->prov != NULL)
249	0	return evp_names_do_all(mac->prov, mac->name_id, fn, data);
250
251	0	return 1;
252	0	}
253
254		unsigned char EVP_Q_mac(OSSL_LIB_CTX libctx,
255		const char name, const char propq,
256		const char subalg, const OSSL_PARAM params,
257		const void *key, size_t keylen,
258		const unsigned char *data, size_t datalen,
259		unsigned char out, size_t outsize, size_t outlen)
260	0	{
261	0	EVP_MAC *mac = EVP_MAC_fetch(libctx, name, propq);
262	0	OSSL_PARAM subalg_param[] = { OSSL_PARAM_END, OSSL_PARAM_END };
263	0	EVP_MAC_CTX *ctx = NULL;
264	0	size_t len = 0;
265	0	unsigned char *res = NULL;
266
267	0	if (outlen != NULL)
268	0	*outlen = 0;
269	0	if (mac == NULL)
270	0	return NULL;
271	0	if (subalg != NULL) {
272	0	const OSSL_PARAM *defined_params = EVP_MAC_settable_ctx_params(mac);
273	0	const char *param_name = OSSL_MAC_PARAM_DIGEST;
274
275		/*
276		* The underlying algorithm may be a cipher or a digest.
277		* We don't know which it is, but we can ask the MAC what it
278		* should be and bet on that.
279		*/
280	0	if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
281	0	param_name = OSSL_MAC_PARAM_CIPHER;
282	0	if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) {
283	0	ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT);
284	0	goto err;
285	0	}
286	0	}
287	0	subalg_param[0] =
288	0	OSSL_PARAM_construct_utf8_string(param_name, (char *)subalg, 0);
289	0	}
290		/* Single-shot - on NULL key input, set dummy key value for EVP_MAC_Init. */
291	0	if (key == NULL && keylen == 0)
292	0	key = data;
293	0	if ((ctx = EVP_MAC_CTX_new(mac)) != NULL
294	0	&& EVP_MAC_CTX_set_params(ctx, subalg_param)
295	0	&& EVP_MAC_CTX_set_params(ctx, params)
296	0	&& EVP_MAC_init(ctx, key, keylen, params)
297	0	&& EVP_MAC_update(ctx, data, datalen)
298	0	&& EVP_MAC_final(ctx, out, &len, outsize)) {
299	0	if (out == NULL) {
300	0	out = OPENSSL_malloc(len);
301	0	if (out != NULL && !EVP_MAC_final(ctx, out, NULL, len)) {
302	0	OPENSSL_free(out);
303	0	out = NULL;
304	0	}
305	0	}
306	0	res = out;
307	0	if (res != NULL && outlen != NULL)
308	0	*outlen = len;
309	0	}
310
311	0	err:
312	0	EVP_MAC_CTX_free(ctx);
313	0	EVP_MAC_free(mac);
314	0	return res;
315	0	}