Get rid of the diversity of names for MAC parameters
[openssl.git] / providers / default / macs / blake2_mac_impl.c
1 /*
2  * Copyright 2018 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/opensslconf.h>
11 #ifndef OPENSSL_NO_BLAKE2
12
13 # include <openssl/core_numbers.h>
14 # include <openssl/core_names.h>
15 # include <openssl/params.h>
16
17 # include "internal/blake2.h"
18 # include "internal/cryptlib.h"
19 # include "internal/providercommonerr.h"
20 # include "internal/provider_algs.h"
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_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_get_ctx_params_fn blake2_get_ctx_params;
32 static OSSL_OP_mac_settable_ctx_params_fn blake2_mac_settable_ctx_params;
33 static OSSL_OP_mac_set_ctx_params_fn blake2_mac_set_ctx_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;
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 size_t blake2_mac_size(void *vmacctx);
45
46 static void *blake2_mac_new(void *unused_provctx)
47 {
48     struct blake2_mac_data_st *macctx = OPENSSL_zalloc(sizeof(*macctx));
49
50     if (macctx != NULL) {
51         BLAKE2_PARAM_INIT(&macctx->params);
52         /* ctx initialization is deferred to BLAKE2b_Init() */
53     }
54     return macctx;
55 }
56
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     dst = OPENSSL_zalloc(sizeof(*dst));
63     if (dst == NULL)
64         return NULL;
65
66     *dst = *src;
67     return dst;
68 }
69
70 static void blake2_mac_free(void *vmacctx)
71 {
72     struct blake2_mac_data_st *macctx = vmacctx;
73
74     if (macctx != NULL) {
75         OPENSSL_cleanse(macctx->key, sizeof(macctx->key));
76         OPENSSL_free(macctx);
77     }
78 }
79
80 static int blake2_mac_init(void *vmacctx)
81 {
82     struct blake2_mac_data_st *macctx = vmacctx;
83
84     /* Check key has been set */
85     if (macctx->params.key_length == 0) {
86         ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
87         return 0;
88     }
89
90     return BLAKE2_INIT_KEY(&macctx->ctx, &macctx->params, macctx->key);
91 }
92
93 static int blake2_mac_update(void *vmacctx,
94                              const unsigned char *data, size_t datalen)
95 {
96     struct blake2_mac_data_st *macctx = vmacctx;
97
98     return BLAKE2_UPDATE(&macctx->ctx, data, datalen);
99 }
100
101 static int blake2_mac_final(void *vmacctx,
102                             unsigned char *out, size_t *outl,
103                             size_t outsize)
104 {
105     struct blake2_mac_data_st *macctx = vmacctx;
106
107     return BLAKE2_FINAL(out, &macctx->ctx);
108 }
109
110 static const OSSL_PARAM known_gettable_ctx_params[] = {
111     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
112     OSSL_PARAM_END
113 };
114 static const OSSL_PARAM *blake2_gettable_ctx_params(void)
115 {
116     return known_gettable_ctx_params;
117 }
118
119 static int blake2_get_ctx_params(void *vmacctx, OSSL_PARAM params[])
120 {
121     OSSL_PARAM *p;
122
123     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
124         return OSSL_PARAM_set_size_t(p, blake2_mac_size(vmacctx));
125
126     return 1;
127 }
128
129 static const OSSL_PARAM known_settable_ctx_params[] = {
130     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
131     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
132     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_CUSTOM, NULL, 0),
133     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_SALT, NULL, 0),
134     OSSL_PARAM_END
135 };
136 static const OSSL_PARAM *blake2_mac_settable_ctx_params()
137 {
138     return known_settable_ctx_params;
139 }
140
141 /*
142  * ALL parameters should be set before init().
143  */
144 static int blake2_mac_set_ctx_params(void *vmacctx, const OSSL_PARAM params[])
145 {
146     struct blake2_mac_data_st *macctx = vmacctx;
147     const OSSL_PARAM *p;
148
149     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SIZE)) != NULL) {
150         size_t size;
151
152         if (!OSSL_PARAM_get_size_t(p, &size)
153             || size < 1
154             || size > BLAKE2_OUTBYTES) {
155             ERR_raise(ERR_LIB_PROV, PROV_R_NOT_XOF_OR_INVALID_LENGTH);
156             return 0;
157         }
158         BLAKE2_PARAM_SET_DIGEST_LENGTH(&macctx->params, (uint8_t)size);
159     }
160
161     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
162         size_t len;
163         void *key_p = macctx->key;
164
165         if (!OSSL_PARAM_get_octet_string(p, &key_p, BLAKE2_KEYBYTES, &len)) {
166             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
167             return 0;
168         }
169         /* Pad with zeroes at the end */
170         memset(macctx->key + len, 0, BLAKE2_KEYBYTES - len);
171
172         BLAKE2_PARAM_SET_KEY_LENGTH(&macctx->params, (uint8_t)len);
173     }
174
175     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_CUSTOM))
176         != NULL) {
177         /*
178          * The OSSL_PARAM API doesn't provide direct pointer use, so we
179          * must handle the OSSL_PARAM structure ourselves here
180          */
181         if (p->data_size > BLAKE2_PERSONALBYTES) {
182             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CUSTOM_LENGTH);
183             return 0;
184         }
185         BLAKE2_PARAM_SET_PERSONAL(&macctx->params, p->data, p->data_size);
186     }
187
188     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_SALT)) != NULL) {
189         /*
190          * The OSSL_PARAM API doesn't provide direct pointer use, so we
191          * must handle the OSSL_PARAM structure ourselves here as well
192          */
193         if (p->data_size > BLAKE2_SALTBYTES) {
194             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
195             return 0;
196         }
197         BLAKE2_PARAM_SET_SALT(&macctx->params, p->data, p->data_size);
198     }
199     return 1;
200 }
201
202 static size_t blake2_mac_size(void *vmacctx)
203 {
204     struct blake2_mac_data_st *macctx = vmacctx;
205
206     return macctx->params.digest_length;
207 }
208
209 const OSSL_DISPATCH BLAKE2_FUNCTIONS[] = {
210     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))blake2_mac_new },
211     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))blake2_mac_dup },
212     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))blake2_mac_free },
213     { OSSL_FUNC_MAC_INIT, (void (*)(void))blake2_mac_init },
214     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))blake2_mac_update },
215     { OSSL_FUNC_MAC_FINAL, (void (*)(void))blake2_mac_final },
216     { OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS,
217       (void (*)(void))blake2_gettable_ctx_params },
218     { OSSL_FUNC_MAC_GET_CTX_PARAMS, (void (*)(void))blake2_get_ctx_params },
219     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
220       (void (*)(void))blake2_mac_settable_ctx_params },
221     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))blake2_mac_set_ctx_params },
222     { 0, NULL }
223 };
224
225 #endif