/src/openssl30/crypto/evp/mac_lib.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 2018-2022 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 <string.h> |
11 | | #include <stdarg.h> |
12 | | #include <openssl/evp.h> |
13 | | #include <openssl/err.h> |
14 | | #include <openssl/core.h> |
15 | | #include <openssl/core_names.h> |
16 | | #include <openssl/types.h> |
17 | | #include "internal/nelem.h" |
18 | | #include "crypto/evp.h" |
19 | | #include "internal/provider.h" |
20 | | #include "evp_local.h" |
21 | | |
22 | | EVP_MAC_CTX *EVP_MAC_CTX_new(EVP_MAC *mac) |
23 | 17.3k | { |
24 | 17.3k | EVP_MAC_CTX *ctx = OPENSSL_zalloc(sizeof(EVP_MAC_CTX)); |
25 | | |
26 | 17.3k | if (ctx == NULL |
27 | 17.3k | || (ctx->algctx = mac->newctx(ossl_provider_ctx(mac->prov))) == NULL |
28 | 17.3k | || !EVP_MAC_up_ref(mac)) { |
29 | 0 | ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE); |
30 | 0 | if (ctx != NULL) |
31 | 0 | mac->freectx(ctx->algctx); |
32 | 0 | OPENSSL_free(ctx); |
33 | 0 | ctx = NULL; |
34 | 17.3k | } else { |
35 | 17.3k | ctx->meth = mac; |
36 | 17.3k | } |
37 | 17.3k | return ctx; |
38 | 17.3k | } |
39 | | |
40 | | void EVP_MAC_CTX_free(EVP_MAC_CTX *ctx) |
41 | 905k | { |
42 | 905k | if (ctx == NULL) |
43 | 265k | return; |
44 | 640k | ctx->meth->freectx(ctx->algctx); |
45 | 640k | ctx->algctx = NULL; |
46 | | /* refcnt-- */ |
47 | 640k | EVP_MAC_free(ctx->meth); |
48 | 640k | OPENSSL_free(ctx); |
49 | 640k | } |
50 | | |
51 | | EVP_MAC_CTX *EVP_MAC_CTX_dup(const EVP_MAC_CTX *src) |
52 | 523k | { |
53 | 523k | EVP_MAC_CTX *dst; |
54 | | |
55 | 523k | if (src->algctx == NULL) |
56 | 0 | return NULL; |
57 | | |
58 | 523k | dst = OPENSSL_malloc(sizeof(*dst)); |
59 | 523k | if (dst == NULL) { |
60 | 0 | ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE); |
61 | 0 | return NULL; |
62 | 0 | } |
63 | | |
64 | 523k | *dst = *src; |
65 | 523k | if (!EVP_MAC_up_ref(dst->meth)) { |
66 | 0 | ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE); |
67 | 0 | OPENSSL_free(dst); |
68 | 0 | return NULL; |
69 | 0 | } |
70 | | |
71 | 523k | dst->algctx = src->meth->dupctx(src->algctx); |
72 | 523k | if (dst->algctx == NULL) { |
73 | 0 | EVP_MAC_CTX_free(dst); |
74 | 0 | return NULL; |
75 | 0 | } |
76 | | |
77 | 523k | return dst; |
78 | 523k | } |
79 | | |
80 | | EVP_MAC *EVP_MAC_CTX_get0_mac(EVP_MAC_CTX *ctx) |
81 | 303 | { |
82 | 303 | return ctx->meth; |
83 | 303 | } |
84 | | |
85 | | static size_t get_size_t_ctx_param(EVP_MAC_CTX *ctx, const char *name) |
86 | 464k | { |
87 | 464k | size_t sz = 0; |
88 | | |
89 | 464k | if (ctx->algctx != NULL) { |
90 | 464k | OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END }; |
91 | | |
92 | 464k | params[0] = OSSL_PARAM_construct_size_t(name, &sz); |
93 | 464k | if (ctx->meth->get_ctx_params != NULL) { |
94 | 464k | if (ctx->meth->get_ctx_params(ctx->algctx, params)) |
95 | 464k | return sz; |
96 | 464k | } else if (ctx->meth->get_params != NULL) { |
97 | 0 | if (ctx->meth->get_params(params)) |
98 | 0 | return sz; |
99 | 0 | } |
100 | 464k | } |
101 | | /* |
102 | | * If the MAC hasn't been initialized yet, or there is no size to get, |
103 | | * we return zero |
104 | | */ |
105 | 0 | return 0; |
106 | 464k | } |
107 | | |
108 | | size_t EVP_MAC_CTX_get_mac_size(EVP_MAC_CTX *ctx) |
109 | 464k | { |
110 | 464k | return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_SIZE); |
111 | 464k | } |
112 | | |
113 | | size_t EVP_MAC_CTX_get_block_size(EVP_MAC_CTX *ctx) |
114 | 0 | { |
115 | 0 | return get_size_t_ctx_param(ctx, OSSL_MAC_PARAM_BLOCK_SIZE); |
116 | 0 | } |
117 | | |
118 | | int EVP_MAC_init(EVP_MAC_CTX *ctx, const unsigned char *key, size_t keylen, |
119 | | const OSSL_PARAM params[]) |
120 | 62.9k | { |
121 | 62.9k | return ctx->meth->init(ctx->algctx, key, keylen, params); |
122 | 62.9k | } |
123 | | |
124 | | int EVP_MAC_update(EVP_MAC_CTX *ctx, const unsigned char *data, size_t datalen) |
125 | 641k | { |
126 | 641k | return ctx->meth->update(ctx->algctx, data, datalen); |
127 | 641k | } |
128 | | |
129 | | static int evp_mac_final(EVP_MAC_CTX *ctx, int xof, |
130 | | unsigned char *out, size_t *outl, size_t outsize) |
131 | 428k | { |
132 | 428k | size_t l; |
133 | 428k | int res; |
134 | 428k | OSSL_PARAM params[2]; |
135 | 428k | size_t macsize; |
136 | | |
137 | 428k | if (ctx == NULL || ctx->meth == NULL) { |
138 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_NULL_ALGORITHM); |
139 | 0 | return 0; |
140 | 0 | } |
141 | 428k | if (ctx->meth->final == NULL) { |
142 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR); |
143 | 0 | return 0; |
144 | 0 | } |
145 | | |
146 | 428k | macsize = EVP_MAC_CTX_get_mac_size(ctx); |
147 | 428k | if (out == NULL) { |
148 | 0 | if (outl == NULL) { |
149 | 0 | ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER); |
150 | 0 | return 0; |
151 | 0 | } |
152 | 0 | *outl = macsize; |
153 | 0 | return 1; |
154 | 0 | } |
155 | 428k | if (outsize < macsize) { |
156 | 7 | ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); |
157 | 7 | return 0; |
158 | 7 | } |
159 | 428k | if (xof) { |
160 | 0 | params[0] = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_XOF, &xof); |
161 | 0 | params[1] = OSSL_PARAM_construct_end(); |
162 | |
|
163 | 0 | if (EVP_MAC_CTX_set_params(ctx, params) <= 0) { |
164 | 0 | ERR_raise(ERR_LIB_EVP, EVP_R_SETTING_XOF_FAILED); |
165 | 0 | return 0; |
166 | 0 | } |
167 | 0 | } |
168 | 428k | res = ctx->meth->final(ctx->algctx, out, &l, outsize); |
169 | 428k | if (outl != NULL) |
170 | 367k | *outl = l; |
171 | 428k | return res; |
172 | 428k | } |
173 | | |
174 | | int EVP_MAC_final(EVP_MAC_CTX *ctx, |
175 | | unsigned char *out, size_t *outl, size_t outsize) |
176 | 428k | { |
177 | 428k | return evp_mac_final(ctx, 0, out, outl, outsize); |
178 | 428k | } |
179 | | |
180 | | int EVP_MAC_finalXOF(EVP_MAC_CTX *ctx, unsigned char *out, size_t outsize) |
181 | 0 | { |
182 | 0 | return evp_mac_final(ctx, 1, out, NULL, outsize); |
183 | 0 | } |
184 | | |
185 | | /* |
186 | | * The {get,set}_params functions return 1 if there is no corresponding |
187 | | * function in the implementation. This is the same as if there was one, |
188 | | * but it didn't recognise any of the given params, i.e. nothing in the |
189 | | * bag of parameters was useful. |
190 | | */ |
191 | | int EVP_MAC_get_params(EVP_MAC *mac, OSSL_PARAM params[]) |
192 | 0 | { |
193 | 0 | if (mac->get_params != NULL) |
194 | 0 | return mac->get_params(params); |
195 | 0 | return 1; |
196 | 0 | } |
197 | | |
198 | | int EVP_MAC_CTX_get_params(EVP_MAC_CTX *ctx, OSSL_PARAM params[]) |
199 | 0 | { |
200 | 0 | if (ctx->meth->get_ctx_params != NULL) |
201 | 0 | return ctx->meth->get_ctx_params(ctx->algctx, params); |
202 | 0 | return 1; |
203 | 0 | } |
204 | | |
205 | | int EVP_MAC_CTX_set_params(EVP_MAC_CTX *ctx, const OSSL_PARAM params[]) |
206 | 222k | { |
207 | 222k | if (ctx->meth->set_ctx_params != NULL) |
208 | 222k | return ctx->meth->set_ctx_params(ctx->algctx, params); |
209 | 0 | return 1; |
210 | 222k | } |
211 | | |
212 | | int evp_mac_get_number(const EVP_MAC *mac) |
213 | 0 | { |
214 | 0 | return mac->name_id; |
215 | 0 | } |
216 | | |
217 | | const char *EVP_MAC_get0_name(const EVP_MAC *mac) |
218 | 0 | { |
219 | 0 | return mac->type_name; |
220 | 0 | } |
221 | | |
222 | | const char *EVP_MAC_get0_description(const EVP_MAC *mac) |
223 | 0 | { |
224 | 0 | return mac->description; |
225 | 0 | } |
226 | | |
227 | | int EVP_MAC_is_a(const EVP_MAC *mac, const char *name) |
228 | 318 | { |
229 | 318 | return mac != NULL && evp_is_a(mac->prov, mac->name_id, NULL, name); |
230 | 318 | } |
231 | | |
232 | | int EVP_MAC_names_do_all(const EVP_MAC *mac, |
233 | | void (*fn)(const char *name, void *data), |
234 | | void *data) |
235 | 0 | { |
236 | 0 | if (mac->prov != NULL) |
237 | 0 | return evp_names_do_all(mac->prov, mac->name_id, fn, data); |
238 | | |
239 | 0 | return 1; |
240 | 0 | } |
241 | | |
242 | | unsigned char *EVP_Q_mac(OSSL_LIB_CTX *libctx, |
243 | | const char *name, const char *propq, |
244 | | const char *subalg, const OSSL_PARAM *params, |
245 | | const void *key, size_t keylen, |
246 | | const unsigned char *data, size_t datalen, |
247 | | unsigned char *out, size_t outsize, size_t *outlen) |
248 | 70.7k | { |
249 | 70.7k | EVP_MAC *mac = EVP_MAC_fetch(libctx, name, propq); |
250 | 70.7k | OSSL_PARAM subalg_param[] = { OSSL_PARAM_END, OSSL_PARAM_END }; |
251 | 70.7k | EVP_MAC_CTX *ctx = NULL; |
252 | 70.7k | size_t len = 0; |
253 | 70.7k | unsigned char *res = NULL; |
254 | | |
255 | 70.7k | if (outlen != NULL) |
256 | 13.7k | *outlen = 0; |
257 | 70.7k | if (mac == NULL) |
258 | 0 | return NULL; |
259 | 70.7k | if (subalg != NULL) { |
260 | 70.7k | const OSSL_PARAM *defined_params = EVP_MAC_settable_ctx_params(mac); |
261 | 70.7k | const char *param_name = OSSL_MAC_PARAM_DIGEST; |
262 | | |
263 | | /* |
264 | | * The underlying algorithm may be a cipher or a digest. |
265 | | * We don't know which it is, but we can ask the MAC what it |
266 | | * should be and bet on that. |
267 | | */ |
268 | 70.7k | if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) { |
269 | 0 | param_name = OSSL_MAC_PARAM_CIPHER; |
270 | 0 | if (OSSL_PARAM_locate_const(defined_params, param_name) == NULL) { |
271 | 0 | ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_INVALID_ARGUMENT); |
272 | 0 | goto err; |
273 | 0 | } |
274 | 0 | } |
275 | 70.7k | subalg_param[0] = |
276 | 70.7k | OSSL_PARAM_construct_utf8_string(param_name, (char *)subalg, 0); |
277 | 70.7k | } |
278 | | /* Single-shot - on NULL key input, set dummy key value for EVP_MAC_Init. */ |
279 | 70.7k | if (key == NULL && keylen == 0) |
280 | 0 | key = data; |
281 | 70.7k | if ((ctx = EVP_MAC_CTX_new(mac)) != NULL |
282 | 70.7k | && EVP_MAC_CTX_set_params(ctx, subalg_param) |
283 | 70.7k | && EVP_MAC_CTX_set_params(ctx, params) |
284 | 70.7k | && EVP_MAC_init(ctx, key, keylen, params) |
285 | 70.7k | && EVP_MAC_update(ctx, data, datalen) |
286 | 70.7k | && EVP_MAC_final(ctx, out, &len, outsize)) { |
287 | 70.7k | if (out == NULL) { |
288 | 0 | out = OPENSSL_malloc(len); |
289 | 0 | if (out != NULL && !EVP_MAC_final(ctx, out, NULL, len)) { |
290 | 0 | OPENSSL_free(out); |
291 | 0 | out = NULL; |
292 | 0 | } |
293 | 0 | } |
294 | 70.7k | res = out; |
295 | 70.7k | if (res != NULL && outlen != NULL) |
296 | 13.7k | *outlen = len; |
297 | 70.7k | } |
298 | | |
299 | 70.7k | err: |
300 | 70.7k | EVP_MAC_CTX_free(ctx); |
301 | 70.7k | EVP_MAC_free(mac); |
302 | 70.7k | return res; |
303 | 70.7k | } |