/src/openssl/providers/implementations/macs/blake2_mac_impl.c

Source
/*
 * 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 <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/proverr.h>

#include "prov/blake2.h"
#include "internal/cryptlib.h"
#include "prov/implementations.h"
#include "prov/providercommon.h"

#include "prov/blake2_params.inc"

/*
 * Forward declaration of everything implemented here.  This is not strictly
 * necessary for the compiler, but provides an assurance that the signatures
 * of the functions in the dispatch table are correct.
 */
static OSSL_FUNC_mac_newctx_fn blake2_mac_new;
static OSSL_FUNC_mac_dupctx_fn blake2_mac_dup;
static OSSL_FUNC_mac_freectx_fn blake2_mac_free;
static OSSL_FUNC_mac_gettable_ctx_params_fn blake2_gettable_ctx_params;
static OSSL_FUNC_mac_get_ctx_params_fn blake2_get_ctx_params;
static OSSL_FUNC_mac_settable_ctx_params_fn blake2_mac_settable_ctx_params;
static OSSL_FUNC_mac_set_ctx_params_fn blake2_mac_set_ctx_params;
static OSSL_FUNC_mac_init_fn blake2_mac_init;
static OSSL_FUNC_mac_update_fn blake2_mac_update;
static OSSL_FUNC_mac_final_fn blake2_mac_final;

struct blake2_mac_data_st {
    BLAKE2_CTX ctx;
    BLAKE2_PARAM params;
    unsigned char key[BLAKE2_KEYBYTES];
};

static void *blake2_mac_new(void *unused_provctx)
{
    struct blake2_mac_data_st *macctx;

    if (!ossl_prov_is_running())
        return NULL;

    macctx = OPENSSL_zalloc(sizeof(*macctx));
    if (macctx != NULL) {
        BLAKE2_PARAM_INIT(&macctx->params);
        /* ctx initialization is deferred to BLAKE2b_Init() */
    }
    return macctx;
}

static void *blake2_mac_dup(void *vsrc)
{
    struct blake2_mac_data_st *dst;
    struct blake2_mac_data_st *src = vsrc;

    if (!ossl_prov_is_running())
        return NULL;

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

    *dst = *src;
    return dst;
}

static void blake2_mac_free(void *vmacctx)
{
    struct blake2_mac_data_st *macctx = vmacctx;

    if (macctx != NULL) {
        OPENSSL_cleanse(macctx->key, sizeof(macctx->key));
        OPENSSL_free(macctx);
    }
}

static size_t blake2_mac_size(void *vmacctx)
{
    struct blake2_mac_data_st *macctx = vmacctx;

    return macctx->params.digest_length;
}

static int blake2_setkey(struct blake2_mac_data_st *macctx,
                         const unsigned char *key, size_t keylen)
{
    if (keylen > BLAKE2_KEYBYTES || keylen == 0) {
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
        return 0;
    }
    memcpy(macctx->key, key, keylen);
    /* Pad with zeroes at the end if required */
    if (keylen < BLAKE2_KEYBYTES)
        memset(macctx->key + keylen, 0, BLAKE2_KEYBYTES - keylen);
    BLAKE2_PARAM_SET_KEY_LENGTH(&macctx->params, (uint8_t)keylen);
    return 1;
}

static int blake2_mac_init(void *vmacctx, const unsigned char *key,
                           size_t keylen, const OSSL_PARAM params[])
{
    struct blake2_mac_data_st *macctx = vmacctx;

    if (!ossl_prov_is_running() || !blake2_mac_set_ctx_params(macctx, params))
        return 0;
    if (key != NULL) {
        if (!blake2_setkey(macctx, key, keylen))
            return 0;
    } else if (macctx->params.key_length == 0) {
        /* Check key has been set */
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
        return 0;
    }
    return BLAKE2_INIT_KEY(&macctx->ctx, &macctx->params, macctx->key);
}

static int blake2_mac_update(void *vmacctx,
                             const unsigned char *data, size_t datalen)
{
    struct blake2_mac_data_st *macctx = vmacctx;

    if (datalen == 0)
        return 1;

    return BLAKE2_UPDATE(&macctx->ctx, data, datalen);
}

static int blake2_mac_final(void *vmacctx,
                            unsigned char *out, size_t *outl,
                            size_t outsize)
{
    struct blake2_mac_data_st *macctx = vmacctx;

    if (!ossl_prov_is_running())
        return 0;

    *outl = blake2_mac_size(macctx);
    return BLAKE2_FINAL(out, &macctx->ctx);
}

/* See blake2.h for parameter definition */
static const OSSL_PARAM *blake2_gettable_ctx_params(ossl_unused void *ctx,
                                                    ossl_unused void *provctx)
{
    return blake2_get_ctx_list;
}

static int blake2_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
{
    struct blake2_mac_data_st *macctx = vmacctx;
    struct blake2_get_ctx_st p;

    if (macctx == NULL || !blake2_get_ctx_decoder(params, &p))
        return 0;

    if (p.size != NULL
            && !OSSL_PARAM_set_size_t(p.size, blake2_mac_size(macctx)))
        return 0;

    if (p.bsize != NULL && !OSSL_PARAM_set_size_t(p.bsize, BLAKE2_BLOCKBYTES))
        return 0;

    return 1;
}

static const OSSL_PARAM *blake2_mac_settable_ctx_params(
            ossl_unused void *ctx, ossl_unused void *p_ctx)
{
    return blake2_mac_set_ctx_list;
}

/*
 * ALL parameters should be set before init().
 */
static int blake2_mac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
{
    struct blake2_mac_data_st *macctx = vmacctx;
    struct blake2_mac_set_ctx_st p;

    if (macctx == NULL || !blake2_mac_set_ctx_decoder(params, &p))
        return 0;

    if (p.size != NULL) {
        size_t size;

        if (!OSSL_PARAM_get_size_t(p.size, &size)
            || size < 1
            || size > BLAKE2_OUTBYTES) {
            ERR_raise(ERR_LIB_PROV, PROV_R_NOT_XOF_OR_INVALID_LENGTH);
            return 0;
        }
        BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx->params, (uint8_t)size);
    }

    if (p.key != NULL)
        if (p.key->data_type != OSSL_PARAM_OCTET_STRING
                || !blake2_setkey(macctx, p.key->data, p.key->data_size))
            return 0;

    if (p.cust != NULL) {
        if (p.cust->data_type != OSSL_PARAM_OCTET_STRING)
            return 0;
        /*
         * The OSSL_PARAM API doesn't provide direct pointer use, so we
         * must handle the OSSL_PARAM structure ourselves here
         */
        if (p.cust->data_size > BLAKE2_PERSONALBYTES) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
            return 0;
        }
        BLAKE2_PARAM_SET_PERSONAL(&macctx->params, p.cust->data,
                                  p.cust->data_size);
    }

    if (p.salt != NULL) {
        if (p.salt->data_type != OSSL_PARAM_OCTET_STRING)
            return 0;
        /*
         * The OSSL_PARAM API doesn't provide direct pointer use, so we
         * must handle the OSSL_PARAM structure ourselves here as well
         */
        if (p.salt->data_size > BLAKE2_SALTBYTES) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
            return 0;
        }
        BLAKE2_PARAM_SET_SALT(&macctx->params, p.salt->data, p.salt->data_size);
    }
    return 1;
}

const OSSL_DISPATCH BLAKE2_FUNCTIONS[] = {
    { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))blake2_mac_new },
    { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))blake2_mac_dup },
    { OSSL_FUNC_MAC_FREECTX, (void (*)(void))blake2_mac_free },
    { OSSL_FUNC_MAC_INIT, (void (*)(void))blake2_mac_init },
    { OSSL_FUNC_MAC_UPDATE, (void (*)(void))blake2_mac_update },
    { OSSL_FUNC_MAC_FINAL, (void (*)(void))blake2_mac_final },
    { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
      (void (*)(void))blake2_gettable_ctx_params },
    { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))blake2_get_ctx_params },
    { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
      (void (*)(void))blake2_mac_settable_ctx_params },
    { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))blake2_mac_set_ctx_params },
    OSSL_DISPATCH_END
};

Coverage Report

Created: 2025-10-12 06:56

Line	Count	Source
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 <openssl/core_dispatch.h>
11		#include <openssl/core_names.h>
12		#include <openssl/params.h>
13		#include <openssl/proverr.h>
14
15		#include "prov/blake2.h"
16		#include "internal/cryptlib.h"
17		#include "prov/implementations.h"
18		#include "prov/providercommon.h"
19
20		#include "prov/blake2_params.inc"
21
22		/*
23		* Forward declaration of everything implemented here. This is not strictly
24		* necessary for the compiler, but provides an assurance that the signatures
25		* of the functions in the dispatch table are correct.
26		*/
27		static OSSL_FUNC_mac_newctx_fn blake2_mac_new;
28		static OSSL_FUNC_mac_dupctx_fn blake2_mac_dup;
29		static OSSL_FUNC_mac_freectx_fn blake2_mac_free;
30		static OSSL_FUNC_mac_gettable_ctx_params_fn blake2_gettable_ctx_params;
31		static OSSL_FUNC_mac_get_ctx_params_fn blake2_get_ctx_params;
32		static OSSL_FUNC_mac_settable_ctx_params_fn blake2_mac_settable_ctx_params;
33		static OSSL_FUNC_mac_set_ctx_params_fn blake2_mac_set_ctx_params;
34		static OSSL_FUNC_mac_init_fn blake2_mac_init;
35		static OSSL_FUNC_mac_update_fn blake2_mac_update;
36		static OSSL_FUNC_mac_final_fn blake2_mac_final;
37
38		struct blake2_mac_data_st {
39		BLAKE2_CTX ctx;
40		BLAKE2_PARAM params;
41		unsigned char key[BLAKE2_KEYBYTES];
42		};
43
44		static void blake2_mac_new(void unused_provctx)
45	0	{
46	0	struct blake2_mac_data_st *macctx;
47
48	0	if (!ossl_prov_is_running())
49	0	return NULL;
50
51	0	macctx = OPENSSL_zalloc(sizeof(*macctx));
52	0	if (macctx != NULL) {
53	0	BLAKE2_PARAM_INIT(&macctx->params);
54		/* ctx initialization is deferred to BLAKE2b_Init() */
55	0	}
56	0	return macctx;
57	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_new Unexecuted instantiation: blake2s_mac.c:blake2_mac_new
58
59		static void blake2_mac_dup(void vsrc)
60	0	{
61	0	struct blake2_mac_data_st *dst;
62	0	struct blake2_mac_data_st *src = vsrc;
63
64	0	if (!ossl_prov_is_running())
65	0	return NULL;
66
67	0	dst = OPENSSL_zalloc(sizeof(*dst));
68	0	if (dst == NULL)
69	0	return NULL;
70
71	0	dst = src;
72	0	return dst;
73	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_dup Unexecuted instantiation: blake2s_mac.c:blake2_mac_dup
74
75		static void blake2_mac_free(void *vmacctx)
76	0	{
77	0	struct blake2_mac_data_st *macctx = vmacctx;
78
79	0	if (macctx != NULL) {
80	0	OPENSSL_cleanse(macctx->key, sizeof(macctx->key));
81	0	OPENSSL_free(macctx);
82	0	}
83	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_free Unexecuted instantiation: blake2s_mac.c:blake2_mac_free
84
85		static size_t blake2_mac_size(void *vmacctx)
86	0	{
87	0	struct blake2_mac_data_st *macctx = vmacctx;
88
89	0	return macctx->params.digest_length;
90	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_size Unexecuted instantiation: blake2s_mac.c:blake2_mac_size
91
92		static int blake2_setkey(struct blake2_mac_data_st *macctx,
93		const unsigned char *key, size_t keylen)
94	0	{
95	0	if (keylen > BLAKE2_KEYBYTES \|\| keylen == 0) {
96	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
97	0	return 0;
98	0	}
99	0	memcpy(macctx->key, key, keylen);
100		/* Pad with zeroes at the end if required */
101	0	if (keylen < BLAKE2_KEYBYTES)
102	0	memset(macctx->key + keylen, 0, BLAKE2_KEYBYTES - keylen);
103	0	BLAKE2_PARAM_SET_KEY_LENGTH(&macctx->params, (uint8_t)keylen);
104	0	return 1;
105	0	} Unexecuted instantiation: blake2b_mac.c:blake2_setkey Unexecuted instantiation: blake2s_mac.c:blake2_setkey
106
107		static int blake2_mac_init(void vmacctx, const unsigned char key,
108		size_t keylen, const OSSL_PARAM params[])
109	0	{
110	0	struct blake2_mac_data_st *macctx = vmacctx;
111
112	0	if (!ossl_prov_is_running() \|\| !blake2_mac_set_ctx_params(macctx, params))
113	0	return 0;
114	0	if (key != NULL) {
115	0	if (!blake2_setkey(macctx, key, keylen))
116	0	return 0;
117	0	} else if (macctx->params.key_length == 0) {
118		/* Check key has been set */
119	0	ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
120	0	return 0;
121	0	}
122	0	return BLAKE2_INIT_KEY(&macctx->ctx, &macctx->params, macctx->key);
123	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_init Unexecuted instantiation: blake2s_mac.c:blake2_mac_init
124
125		static int blake2_mac_update(void *vmacctx,
126		const unsigned char *data, size_t datalen)
127	0	{
128	0	struct blake2_mac_data_st *macctx = vmacctx;
129
130	0	if (datalen == 0)
131	0	return 1;
132
133	0	return BLAKE2_UPDATE(&macctx->ctx, data, datalen);
134	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_update Unexecuted instantiation: blake2s_mac.c:blake2_mac_update
135
136		static int blake2_mac_final(void *vmacctx,
137		unsigned char out, size_t outl,
138		size_t outsize)
139	0	{
140	0	struct blake2_mac_data_st *macctx = vmacctx;
141
142	0	if (!ossl_prov_is_running())
143	0	return 0;
144
145	0	*outl = blake2_mac_size(macctx);
146	0	return BLAKE2_FINAL(out, &macctx->ctx);
147	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_final Unexecuted instantiation: blake2s_mac.c:blake2_mac_final
148
149		/* See blake2.h for parameter definition */
150		static const OSSL_PARAM blake2_gettable_ctx_params(ossl_unused void ctx,
151		ossl_unused void *provctx)
152	0	{
153	0	return blake2_get_ctx_list;
154	0	} Unexecuted instantiation: blake2b_mac.c:blake2_gettable_ctx_params Unexecuted instantiation: blake2s_mac.c:blake2_gettable_ctx_params
155
156		static int blake2_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
157	0	{
158	0	struct blake2_mac_data_st *macctx = vmacctx;
159	0	struct blake2_get_ctx_st p;
160
161	0	if (macctx == NULL \|\| !blake2_get_ctx_decoder(params, &p))
162	0	return 0;
163
164	0	if (p.size != NULL
165	0	&& !OSSL_PARAM_set_size_t(p.size, blake2_mac_size(macctx)))
166	0	return 0;
167
168	0	if (p.bsize != NULL && !OSSL_PARAM_set_size_t(p.bsize, BLAKE2_BLOCKBYTES))
169	0	return 0;
170
171	0	return 1;
172	0	} Unexecuted instantiation: blake2b_mac.c:blake2_get_ctx_params Unexecuted instantiation: blake2s_mac.c:blake2_get_ctx_params
173
174		static const OSSL_PARAM *blake2_mac_settable_ctx_params(
175		ossl_unused void ctx, ossl_unused void p_ctx)
176	0	{
177	0	return blake2_mac_set_ctx_list;
178	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_settable_ctx_params Unexecuted instantiation: blake2s_mac.c:blake2_mac_settable_ctx_params
179
180		/*
181		* ALL parameters should be set before init().
182		*/
183		static int blake2_mac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
184	0	{
185	0	struct blake2_mac_data_st *macctx = vmacctx;
186	0	struct blake2_mac_set_ctx_st p;
187
188	0	if (macctx == NULL \|\| !blake2_mac_set_ctx_decoder(params, &p))
189	0	return 0;
190
191	0	if (p.size != NULL) {
192	0	size_t size;
193
194	0	if (!OSSL_PARAM_get_size_t(p.size, &size)
195	0	\|\| size < 1
196	0	\|\| size > BLAKE2_OUTBYTES) {
197	0	ERR_raise(ERR_LIB_PROV, PROV_R_NOT_XOF_OR_INVALID_LENGTH);
198	0	return 0;
199	0	}
200	0	BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx->params, (uint8_t)size);
201	0	}
202
203	0	if (p.key != NULL)
204	0	if (p.key->data_type != OSSL_PARAM_OCTET_STRING
205	0	\|\| !blake2_setkey(macctx, p.key->data, p.key->data_size))
206	0	return 0;
207
208	0	if (p.cust != NULL) {
209	0	if (p.cust->data_type != OSSL_PARAM_OCTET_STRING)
210	0	return 0;
211		/*
212		* The OSSL_PARAM API doesn't provide direct pointer use, so we
213		* must handle the OSSL_PARAM structure ourselves here
214		*/
215	0	if (p.cust->data_size > BLAKE2_PERSONALBYTES) {
216	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
217	0	return 0;
218	0	}
219	0	BLAKE2_PARAM_SET_PERSONAL(&macctx->params, p.cust->data,
220	0	p.cust->data_size);
221	0	}
222
223	0	if (p.salt != NULL) {
224	0	if (p.salt->data_type != OSSL_PARAM_OCTET_STRING)
225	0	return 0;
226		/*
227		* The OSSL_PARAM API doesn't provide direct pointer use, so we
228		* must handle the OSSL_PARAM structure ourselves here as well
229		*/
230	0	if (p.salt->data_size > BLAKE2_SALTBYTES) {
231	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
232	0	return 0;
233	0	}
234	0	BLAKE2_PARAM_SET_SALT(&macctx->params, p.salt->data, p.salt->data_size);
235	0	}
236	0	return 1;
237	0	} Unexecuted instantiation: blake2b_mac.c:blake2_mac_set_ctx_params Unexecuted instantiation: blake2s_mac.c:blake2_mac_set_ctx_params
238
239		const OSSL_DISPATCH BLAKE2_FUNCTIONS[] = {
240		{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))blake2_mac_new },
241		{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))blake2_mac_dup },
242		{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))blake2_mac_free },
243		{ OSSL_FUNC_MAC_INIT, (void (*)(void))blake2_mac_init },
244		{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))blake2_mac_update },
245		{ OSSL_FUNC_MAC_FINAL, (void (*)(void))blake2_mac_final },
246		{ OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
247		(void (*)(void))blake2_gettable_ctx_params },
248		{ OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))blake2_get_ctx_params },
249		{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
250		(void (*)(void))blake2_mac_settable_ctx_params },
251		{ OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))blake2_mac_set_ctx_params },
252		OSSL_DISPATCH_END
253		};