2 * Copyright 2018-2021 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/core_dispatch.h>
11 #include <openssl/core_names.h>
12 #include <openssl/params.h>
13 #include <openssl/proverr.h>
15 #include "prov/blake2.h"
16 #include "internal/cryptlib.h"
17 #include "prov/implementations.h"
18 #include "prov/providercommon.h"
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.
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
;
36 struct blake2_mac_data_st
{
39 unsigned char key
[BLAKE2_KEYBYTES
];
42 static void *blake2_mac_new(void *unused_provctx
)
44 struct blake2_mac_data_st
*macctx
;
46 if (!ossl_prov_is_running())
49 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 if (!ossl_prov_is_running())
65 dst
= OPENSSL_zalloc(sizeof(*dst
));
73 static void blake2_mac_free(void *vmacctx
)
75 struct blake2_mac_data_st
*macctx
= vmacctx
;
78 OPENSSL_cleanse(macctx
->key
, sizeof(macctx
->key
));
83 static size_t blake2_mac_size(void *vmacctx
)
85 struct blake2_mac_data_st
*macctx
= vmacctx
;
87 return macctx
->params
.digest_length
;
90 static int blake2_mac_init(void *vmacctx
)
92 struct blake2_mac_data_st
*macctx
= vmacctx
;
94 if (!ossl_prov_is_running())
97 /* Check key has been set */
98 if (macctx
->params
.key_length
== 0) {
99 ERR_raise(ERR_LIB_PROV
, PROV_R_NO_KEY_SET
);
103 return BLAKE2_INIT_KEY(&macctx
->ctx
, &macctx
->params
, macctx
->key
);
106 static int blake2_mac_update(void *vmacctx
,
107 const unsigned char *data
, size_t datalen
)
109 struct blake2_mac_data_st
*macctx
= vmacctx
;
114 return BLAKE2_UPDATE(&macctx
->ctx
, data
, datalen
);
117 static int blake2_mac_final(void *vmacctx
,
118 unsigned char *out
, size_t *outl
,
121 struct blake2_mac_data_st
*macctx
= vmacctx
;
123 if (!ossl_prov_is_running())
126 *outl
= blake2_mac_size(macctx
);
127 return BLAKE2_FINAL(out
, &macctx
->ctx
);
130 static const OSSL_PARAM known_gettable_ctx_params
[] = {
131 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE
, NULL
),
134 static const OSSL_PARAM
*blake2_gettable_ctx_params(ossl_unused
void *provctx
)
136 return known_gettable_ctx_params
;
139 static int blake2_get_ctx_params(void *vmacctx
, OSSL_PARAM params
[])
143 if ((p
= OSSL_PARAM_locate(params
, OSSL_MAC_PARAM_SIZE
)) != NULL
)
144 return OSSL_PARAM_set_size_t(p
, blake2_mac_size(vmacctx
));
149 static const OSSL_PARAM known_settable_ctx_params
[] = {
150 OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE
, NULL
),
151 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY
, NULL
, 0),
152 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM
, NULL
, 0),
153 OSSL_PARAM_octet_string(OSSL_MAC_PARAM_SALT
, NULL
, 0),
156 static const OSSL_PARAM
*blake2_mac_settable_ctx_params(ossl_unused
void *p_ctx
)
158 return known_settable_ctx_params
;
162 * ALL parameters should be set before init().
164 static int blake2_mac_set_ctx_params(void *vmacctx
, const OSSL_PARAM params
[])
166 struct blake2_mac_data_st
*macctx
= vmacctx
;
169 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_SIZE
)) != NULL
) {
172 if (!OSSL_PARAM_get_size_t(p
, &size
)
174 || size
> BLAKE2_OUTBYTES
) {
175 ERR_raise(ERR_LIB_PROV
, PROV_R_NOT_XOF_OR_INVALID_LENGTH
);
178 BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx
->params
, (uint8_t)size
);
181 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_KEY
)) != NULL
) {
183 void *key_p
= macctx
->key
;
185 if (!OSSL_PARAM_get_octet_string(p
, &key_p
, BLAKE2_KEYBYTES
, &len
)) {
186 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY_LENGTH
);
189 /* Pad with zeroes at the end */
190 memset(macctx
->key
+ len
, 0, BLAKE2_KEYBYTES
- len
);
192 BLAKE2_PARAM_SET_KEY_LENGTH(&macctx
->params
, (uint8_t)len
);
195 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_CUSTOM
))
198 * The OSSL_PARAM API doesn't provide direct pointer use, so we
199 * must handle the OSSL_PARAM structure ourselves here
201 if (p
->data_size
> BLAKE2_PERSONALBYTES
) {
202 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_CUSTOM_LENGTH
);
205 BLAKE2_PARAM_SET_PERSONAL(&macctx
->params
, p
->data
, p
->data_size
);
208 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_MAC_PARAM_SALT
)) != NULL
) {
210 * The OSSL_PARAM API doesn't provide direct pointer use, so we
211 * must handle the OSSL_PARAM structure ourselves here as well
213 if (p
->data_size
> BLAKE2_SALTBYTES
) {
214 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_SALT_LENGTH
);
217 BLAKE2_PARAM_SET_SALT(&macctx
->params
, p
->data
, p
->data_size
);
222 const OSSL_DISPATCH BLAKE2_FUNCTIONS
[] = {
223 { OSSL_FUNC_MAC_NEWCTX
, (void (*)(void))blake2_mac_new
},
224 { OSSL_FUNC_MAC_DUPCTX
, (void (*)(void))blake2_mac_dup
},
225 { OSSL_FUNC_MAC_FREECTX
, (void (*)(void))blake2_mac_free
},
226 { OSSL_FUNC_MAC_INIT
, (void (*)(void))blake2_mac_init
},
227 { OSSL_FUNC_MAC_UPDATE
, (void (*)(void))blake2_mac_update
},
228 { OSSL_FUNC_MAC_FINAL
, (void (*)(void))blake2_mac_final
},
229 { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS
,
230 (void (*)(void))blake2_gettable_ctx_params
},
231 { OSSL_FUNC_MAC_GET_CTX_PARAMS
, (void (*)(void))blake2_get_ctx_params
},
232 { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS
,
233 (void (*)(void))blake2_mac_settable_ctx_params
},
234 { OSSL_FUNC_MAC_SET_CTX_PARAMS
, (void (*)(void))blake2_mac_set_ctx_params
},