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

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

#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"

/*
 * 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);
}

static const OSSL_PARAM known_gettable_ctx_params[] = {
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_BLOCK_SIZE, NULL),
    OSSL_PARAM_END
};
static const OSSL_PARAM *blake2_gettable_ctx_params(ossl_unused void *ctx,
                                                    ossl_unused void *provctx)
{
    return known_gettable_ctx_params;
}

static int blake2_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
{
    OSSL_PARAM *p;

    if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL
            && !OSSL_PARAM_set_size_t(p, blake2_mac_size(vmacctx)))
        return 0;

    if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_BLOCK_SIZE)) != NULL
            && !OSSL_PARAM_set_size_t(p, BLAKE2_BLOCKBYTES))
        return 0;

    return 1;
}

static const OSSL_PARAM known_settable_ctx_params[] = {
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
    OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_MAC_PARAM_SALT, NULL, 0),
    OSSL_PARAM_END
};
static const OSSL_PARAM *blake2_mac_settable_ctx_params(
            ossl_unused void *ctx, ossl_unused void *p_ctx)
{
    return known_settable_ctx_params;
}

/*
 * 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;
    const OSSL_PARAM *p;

    if (ossl_param_is_empty(params))
        return 1;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
        size_t size;

        if (!OSSL_PARAM_get_size_t(p, &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 = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL
            && !blake2_setkey(macctx, p->data, p->data_size))
        return 0;

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

    if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SALT)) != NULL) {
        /*
         * The OSSL_PARAM API doesn't provide direct pointer use, so we
         * must handle the OSSL_PARAM structure ourselves here as well
         */
        if (p->data_size > BLAKE2_SALTBYTES) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
            return 0;
        }
        BLAKE2_PARAM_SET_SALT(&macctx->params, p->data, p->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-06-13 06:36

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