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 
blake2_mac_new(void * unused_provctx)42 static void *blake2_mac_new(void *unused_provctx)
43 {
44     struct blake2_mac_data_st *macctx;
45 
46     if (!ossl_prov_is_running())
47         return NULL;
48 
49     macctx = OPENSSL_zalloc(sizeof(*macctx));
50     if (macctx != NULL) {
51         BLAKE2_PARAM_INIT(&macctx->params);
52         /* ctx initialization is deferred to BLAKE2b_Init() */
53     }
54     return macctx;
55 }
56 
blake2_mac_dup(void * vsrc)57 static void *blake2_mac_dup(void *vsrc)
58 {
59     struct blake2_mac_data_st *dst;
60     struct blake2_mac_data_st *src = vsrc;
61 
62     if (!ossl_prov_is_running())
63         return NULL;
64 
65     dst = OPENSSL_zalloc(sizeof(*dst));
66     if (dst == NULL)
67         return NULL;
68 
69     *dst = *src;
70     return dst;
71 }
72 
blake2_mac_free(void * vmacctx)73 static void blake2_mac_free(void *vmacctx)
74 {
75     struct blake2_mac_data_st *macctx = vmacctx;
76 
77     if (macctx != NULL) {
78         OPENSSL_cleanse(macctx->key, sizeof(macctx->key));
79         OPENSSL_free(macctx);
80     }
81 }
82 
blake2_mac_size(void * vmacctx)83 static size_t blake2_mac_size(void *vmacctx)
84 {
85     struct blake2_mac_data_st *macctx = vmacctx;
86 
87     return macctx->params.digest_length;
88 }
89 
blake2_setkey(struct blake2_mac_data_st * macctx,const unsigned char * key,size_t keylen)90 static int blake2_setkey(struct blake2_mac_data_st *macctx,
91                          const unsigned char *key, size_t keylen)
92 {
93     if (keylen > BLAKE2_KEYBYTES || keylen == 0) {
94         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
95         return 0;
96     }
97     memcpy(macctx->key, key, keylen);
98     /* Pad with zeroes at the end if required */
99     if (keylen < BLAKE2_KEYBYTES)
100         memset(macctx->key + keylen, 0, BLAKE2_KEYBYTES - keylen);
101     BLAKE2_PARAM_SET_KEY_LENGTH(&macctx->params, (uint8_t)keylen);
102     return 1;
103 }
104 
blake2_mac_init(void * vmacctx,const unsigned char * key,size_t keylen,const OSSL_PARAM params[])105 static int blake2_mac_init(void *vmacctx, const unsigned char *key,
106                            size_t keylen, const OSSL_PARAM params[])
107 {
108     struct blake2_mac_data_st *macctx = vmacctx;
109 
110     if (!ossl_prov_is_running() || !blake2_mac_set_ctx_params(macctx, params))
111         return 0;
112     if (key != NULL) {
113         if (!blake2_setkey(macctx, key, keylen))
114             return 0;
115     } else if (macctx->params.key_length == 0) {
116         /* Check key has been set */
117         ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
118         return 0;
119     }
120     return BLAKE2_INIT_KEY(&macctx->ctx, &macctx->params, macctx->key);
121 }
122 
blake2_mac_update(void * vmacctx,const unsigned char * data,size_t datalen)123 static int blake2_mac_update(void *vmacctx,
124                              const unsigned char *data, size_t datalen)
125 {
126     struct blake2_mac_data_st *macctx = vmacctx;
127 
128     if (datalen == 0)
129         return 1;
130 
131     return BLAKE2_UPDATE(&macctx->ctx, data, datalen);
132 }
133 
blake2_mac_final(void * vmacctx,unsigned char * out,size_t * outl,size_t outsize)134 static int blake2_mac_final(void *vmacctx,
135                             unsigned char *out, size_t *outl,
136                             size_t outsize)
137 {
138     struct blake2_mac_data_st *macctx = vmacctx;
139 
140     if (!ossl_prov_is_running())
141         return 0;
142 
143     *outl = blake2_mac_size(macctx);
144     return BLAKE2_FINAL(out, &macctx->ctx);
145 }
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 };
blake2_gettable_ctx_params(ossl_unused void * ctx,ossl_unused void * provctx)152 static const OSSL_PARAM *blake2_gettable_ctx_params(ossl_unused void *ctx,
153                                                     ossl_unused void *provctx)
154 {
155     return known_gettable_ctx_params;
156 }
157 
blake2_get_ctx_params(void * vmacctx,OSSL_PARAM params[])158 static int blake2_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
159 {
160     OSSL_PARAM *p;
161 
162     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL
163             && !OSSL_PARAM_set_size_t(p, blake2_mac_size(vmacctx)))
164         return 0;
165 
166     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_BLOCK_SIZE)) != NULL
167             && !OSSL_PARAM_set_size_t(p, BLAKE2_BLOCKBYTES))
168         return 0;
169 
170     return 1;
171 }
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 };
blake2_mac_settable_ctx_params(ossl_unused void * ctx,ossl_unused void * p_ctx)180 static const OSSL_PARAM *blake2_mac_settable_ctx_params(
181             ossl_unused void *ctx, ossl_unused void *p_ctx)
182 {
183     return known_settable_ctx_params;
184 }
185 
186 /*
187  * ALL parameters should be set before init().
188  */
blake2_mac_set_ctx_params(void * vmacctx,const OSSL_PARAM params[])189 static int blake2_mac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
190 {
191     struct blake2_mac_data_st *macctx = vmacctx;
192     const OSSL_PARAM *p;
193 
194     if (ossl_param_is_empty(params))
195         return 1;
196 
197     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
198         size_t size;
199 
200         if (!OSSL_PARAM_get_size_t(p, &size)
201             || size < 1
202             || size > BLAKE2_OUTBYTES) {
203             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_XOF_OR_INVALID_LENGTH);
204             return 0;
205         }
206         BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx->params, (uint8_t)size);
207     }
208 
209     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL
210             && !blake2_setkey(macctx, p->data, p->data_size))
211         return 0;
212 
213     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CUSTOM))
214         != 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         if (p->data_size > BLAKE2_PERSONALBYTES) {
220             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
221             return 0;
222         }
223         BLAKE2_PARAM_SET_PERSONAL(&macctx->params, p->data, p->data_size);
224     }
225 
226     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         if (p->data_size > BLAKE2_SALTBYTES) {
232             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
233             return 0;
234         }
235         BLAKE2_PARAM_SET_SALT(&macctx->params, p->data, p->data_size);
236     }
237     return 1;
238 }
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 };
255