2 * Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include <openssl/opensslconf.h>
11 #ifndef OPENSSL_NO_BLAKE2
13 # include <openssl/core_numbers.h>
14 # include <openssl/core_names.h>
15 # include <openssl/params.h>
17 # include "internal/blake2.h"
18 # include "internal/cryptlib.h"
19 # include "internal/providercommonerr.h"
20 # include "internal/provider_algs.h"
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.
27 static OSSL_OP_mac_newctx_fn blake2_mac_new;
28 static OSSL_OP_mac_dupctx_fn blake2_mac_dup;
29 static OSSL_OP_mac_freectx_fn blake2_mac_free;
30 static OSSL_OP_mac_gettable_ctx_params_fn blake2_gettable_ctx_params;
31 static OSSL_OP_mac_ctx_get_params_fn blake2_ctx_get_params;
32 static OSSL_OP_mac_settable_ctx_params_fn blake2_mac_settable_ctx_params;
33 static OSSL_OP_mac_ctx_set_params_fn blake2_mac_ctx_set_params;
34 static OSSL_OP_mac_init_fn blake2_mac_init;
35 static OSSL_OP_mac_update_fn blake2_mac_update;
36 static OSSL_OP_mac_final_fn blake2_mac_final;
38 struct blake2_mac_data_st {
41 unsigned char key[BLAKE2_KEYBYTES];
44 static size_t blake2_mac_size(void *vmacctx);
46 static void *blake2_mac_new(void *unused_provctx)
48 struct blake2_mac_data_st *macctx = OPENSSL_zalloc(sizeof(*macctx));
51 BLAKE2_PARAM_INIT(&macctx->params);
52 /* ctx initialization is deferred to BLAKE2b_Init() */
57 static void *blake2_mac_dup(void *vsrc)
59 struct blake2_mac_data_st *dst;
60 struct blake2_mac_data_st *src = vsrc;
62 dst = OPENSSL_zalloc(sizeof(*dst));
70 static void blake2_mac_free(void *vmacctx)
72 struct blake2_mac_data_st *macctx = vmacctx;
75 OPENSSL_cleanse(macctx->key, sizeof(macctx->key));
80 static int blake2_mac_init(void *vmacctx)
82 struct blake2_mac_data_st *macctx = vmacctx;
84 /* Check key has been set */
85 if (macctx->params.key_length == 0) {
86 ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
90 return BLAKE2_INIT_KEY(&macctx->ctx, &macctx->params, macctx->key);
93 static int blake2_mac_update(void *vmacctx,
94 const unsigned char *data, size_t datalen)
96 struct blake2_mac_data_st *macctx = vmacctx;
98 return BLAKE2_UPDATE(&macctx->ctx, data, datalen);
101 static int blake2_mac_final(void *vmacctx,
102 unsigned char *out, size_t *outl,
105 struct blake2_mac_data_st *macctx = vmacctx;
107 return BLAKE2_FINAL(out, &macctx->ctx);
110 static const OSSL_PARAM known_gettable_ctx_params[] = {
111 OSSL_PARAM_size_t(OSSL_MAC_PARAM_OUTLEN, NULL),
112 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL), /* Same as "outlen" */
115 static const OSSL_PARAM *blake2_gettable_ctx_params(void)
117 return known_gettable_ctx_params;
120 static int blake2_ctx_get_params(void *vmacctx, OSSL_PARAM params[])
124 if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_OUTLEN)) != NULL
125 || (p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
126 return OSSL_PARAM_set_size_t(p, blake2_mac_size(vmacctx));
131 static const OSSL_PARAM known_settable_ctx_params[] = {
132 OSSL_PARAM_size_t(OSSL_MAC_PARAM_OUTLEN, NULL),
133 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
134 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
135 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM, NULL, 0),
136 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_SALT, NULL, 0),
139 static const OSSL_PARAM *blake2_mac_settable_ctx_params()
141 return known_settable_ctx_params;
145 * ALL parameters should be set before init().
147 static int blake2_mac_ctx_set_params(void *vmacctx, const OSSL_PARAM params[])
149 struct blake2_mac_data_st *macctx = vmacctx;
152 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_OUTLEN)) != NULL
154 (p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
157 if (!OSSL_PARAM_get_size_t(p, &size)
159 || size > BLAKE2_OUTBYTES) {
160 ERR_raise(ERR_LIB_PROV, PROV_R_NOT_XOF_OR_INVALID_LENGTH);
163 BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx->params, (uint8_t)size);
166 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
168 void *key_p = macctx->key;
170 if (!OSSL_PARAM_get_octet_string(p, &key_p, BLAKE2_KEYBYTES, &len)) {
171 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
174 /* Pad with zeroes at the end */
175 memset(macctx->key + len, 0, BLAKE2_KEYBYTES - len);
177 BLAKE2_PARAM_SET_KEY_LENGTH(&macctx->params, (uint8_t)len);
180 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CUSTOM))
183 * The OSSL_PARAM API doesn't provide direct pointer use, so we
184 * must handle the OSSL_PARAM structure ourselves here
186 if (p->data_size > BLAKE2_PERSONALBYTES) {
187 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
190 BLAKE2_PARAM_SET_PERSONAL(&macctx->params, p->data, p->data_size);
193 if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SALT)) != NULL) {
195 * The OSSL_PARAM API doesn't provide direct pointer use, so we
196 * must handle the OSSL_PARAM structure ourselves here as well
198 if (p->data_size > BLAKE2_SALTBYTES) {
199 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
202 BLAKE2_PARAM_SET_SALT(&macctx->params, p->data, p->data_size);
207 static size_t blake2_mac_size(void *vmacctx)
209 struct blake2_mac_data_st *macctx = vmacctx;
211 return macctx->params.digest_length;
214 const OSSL_DISPATCH BLAKE2_FUNCTIONS[] = {
215 { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))blake2_mac_new },
216 { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))blake2_mac_dup },
217 { OSSL_FUNC_MAC_FREECTX, (void (*)(void))blake2_mac_free },
218 { OSSL_FUNC_MAC_INIT, (void (*)(void))blake2_mac_init },
219 { OSSL_FUNC_MAC_UPDATE, (void (*)(void))blake2_mac_update },
220 { OSSL_FUNC_MAC_FINAL, (void (*)(void))blake2_mac_final },
221 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
222 (void (*)(void))blake2_gettable_ctx_params },
223 { OSSL_FUNC_MAC_CTX_GET_PARAMS, (void (*)(void))blake2_ctx_get_params },
224 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
225 (void (*)(void))blake2_mac_settable_ctx_params },
226 { OSSL_FUNC_MAC_CTX_SET_PARAMS, (void (*)(void))blake2_mac_ctx_set_params },