1 /*
2 * Copyright 2022-2025 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/evp.h>
11 #include <openssl/err.h>
12 #include <openssl/core.h>
13 #include <openssl/core_dispatch.h>
14 #include "internal/provider.h"
15 #include "internal/core.h"
16 #include "crypto/evp.h"
17 #include "evp_local.h"
18
evp_mac_up_ref(void * vmac)19 static int evp_mac_up_ref(void *vmac)
20 {
21 EVP_MAC *mac = vmac;
22 int ref = 0;
23
24 CRYPTO_UP_REF(&mac->refcnt, &ref);
25 return 1;
26 }
27
evp_mac_free(void * vmac)28 static void evp_mac_free(void *vmac)
29 {
30 EVP_MAC *mac = vmac;
31 int ref = 0;
32
33 if (mac == NULL)
34 return;
35
36 CRYPTO_DOWN_REF(&mac->refcnt, &ref);
37 if (ref > 0)
38 return;
39 OPENSSL_free(mac->type_name);
40 ossl_provider_free(mac->prov);
41 CRYPTO_FREE_REF(&mac->refcnt);
42 OPENSSL_free(mac);
43 }
44
evp_mac_new(void)45 static void *evp_mac_new(void)
46 {
47 EVP_MAC *mac = NULL;
48
49 if ((mac = OPENSSL_zalloc(sizeof(*mac))) == NULL
50 || !CRYPTO_NEW_REF(&mac->refcnt, 1)) {
51 evp_mac_free(mac);
52 return NULL;
53 }
54 return mac;
55 }
56
evp_mac_from_algorithm(int name_id,const OSSL_ALGORITHM * algodef,OSSL_PROVIDER * prov)57 static void *evp_mac_from_algorithm(int name_id,
58 const OSSL_ALGORITHM *algodef,
59 OSSL_PROVIDER *prov)
60 {
61 const OSSL_DISPATCH *fns = algodef->implementation;
62 EVP_MAC *mac = NULL;
63 int fnmaccnt = 0, fnctxcnt = 0, mac_init_found = 0;
64
65 if ((mac = evp_mac_new()) == NULL) {
66 ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
67 goto err;
68 }
69 mac->name_id = name_id;
70
71 if ((mac->type_name = ossl_algorithm_get1_first_name(algodef)) == NULL)
72 goto err;
73
74 mac->description = algodef->algorithm_description;
75
76 for (; fns->function_id != 0; fns++) {
77 switch (fns->function_id) {
78 case OSSL_FUNC_MAC_NEWCTX:
79 if (mac->newctx != NULL)
80 break;
81 mac->newctx = OSSL_FUNC_mac_newctx(fns);
82 fnctxcnt++;
83 break;
84 case OSSL_FUNC_MAC_DUPCTX:
85 if (mac->dupctx != NULL)
86 break;
87 mac->dupctx = OSSL_FUNC_mac_dupctx(fns);
88 break;
89 case OSSL_FUNC_MAC_FREECTX:
90 if (mac->freectx != NULL)
91 break;
92 mac->freectx = OSSL_FUNC_mac_freectx(fns);
93 fnctxcnt++;
94 break;
95 case OSSL_FUNC_MAC_INIT:
96 if (mac->init != NULL)
97 break;
98 mac->init = OSSL_FUNC_mac_init(fns);
99 mac_init_found = 1;
100 break;
101 case OSSL_FUNC_MAC_UPDATE:
102 if (mac->update != NULL)
103 break;
104 mac->update = OSSL_FUNC_mac_update(fns);
105 fnmaccnt++;
106 break;
107 case OSSL_FUNC_MAC_FINAL:
108 if (mac->final != NULL)
109 break;
110 mac->final = OSSL_FUNC_mac_final(fns);
111 fnmaccnt++;
112 break;
113 case OSSL_FUNC_MAC_GETTABLE_PARAMS:
114 if (mac->gettable_params != NULL)
115 break;
116 mac->gettable_params = OSSL_FUNC_mac_gettable_params(fns);
117 break;
118 case OSSL_FUNC_MAC_GETTABLE_CTX_PARAMS:
119 if (mac->gettable_ctx_params != NULL)
120 break;
121 mac->gettable_ctx_params = OSSL_FUNC_mac_gettable_ctx_params(fns);
122 break;
123 case OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS:
124 if (mac->settable_ctx_params != NULL)
125 break;
126 mac->settable_ctx_params = OSSL_FUNC_mac_settable_ctx_params(fns);
127 break;
128 case OSSL_FUNC_MAC_GET_PARAMS:
129 if (mac->get_params != NULL)
130 break;
131 mac->get_params = OSSL_FUNC_mac_get_params(fns);
132 break;
133 case OSSL_FUNC_MAC_GET_CTX_PARAMS:
134 if (mac->get_ctx_params != NULL)
135 break;
136 mac->get_ctx_params = OSSL_FUNC_mac_get_ctx_params(fns);
137 break;
138 case OSSL_FUNC_MAC_SET_CTX_PARAMS:
139 if (mac->set_ctx_params != NULL)
140 break;
141 mac->set_ctx_params = OSSL_FUNC_mac_set_ctx_params(fns);
142 break;
143 case OSSL_FUNC_MAC_INIT_SKEY:
144 if (mac->init_skey != NULL)
145 break;
146 mac->init_skey = OSSL_FUNC_mac_init_skey(fns);
147 mac_init_found = 1;
148 break;
149 }
150 }
151 fnmaccnt += mac_init_found;
152 if (fnmaccnt != 3
153 || fnctxcnt != 2) {
154 /*
155 * In order to be a consistent set of functions we must have at least
156 * a complete set of "mac" functions, and a complete set of context
157 * management functions, as well as the size function.
158 */
159 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
160 goto err;
161 }
162
163 if (prov != NULL && !ossl_provider_up_ref(prov))
164 goto err;
165
166 mac->prov = prov;
167
168 return mac;
169
170 err:
171 evp_mac_free(mac);
172 return NULL;
173 }
174
EVP_MAC_fetch(OSSL_LIB_CTX * libctx,const char * algorithm,const char * properties)175 EVP_MAC *EVP_MAC_fetch(OSSL_LIB_CTX *libctx, const char *algorithm,
176 const char *properties)
177 {
178 return evp_generic_fetch(libctx, OSSL_OP_MAC, algorithm, properties,
179 evp_mac_from_algorithm, evp_mac_up_ref,
180 evp_mac_free);
181 }
182
EVP_MAC_up_ref(EVP_MAC * mac)183 int EVP_MAC_up_ref(EVP_MAC *mac)
184 {
185 return evp_mac_up_ref(mac);
186 }
187
EVP_MAC_free(EVP_MAC * mac)188 void EVP_MAC_free(EVP_MAC *mac)
189 {
190 evp_mac_free(mac);
191 }
192
EVP_MAC_get0_provider(const EVP_MAC * mac)193 const OSSL_PROVIDER *EVP_MAC_get0_provider(const EVP_MAC *mac)
194 {
195 return mac->prov;
196 }
197
EVP_MAC_gettable_params(const EVP_MAC * mac)198 const OSSL_PARAM *EVP_MAC_gettable_params(const EVP_MAC *mac)
199 {
200 if (mac->gettable_params == NULL)
201 return NULL;
202 return mac->gettable_params(ossl_provider_ctx(EVP_MAC_get0_provider(mac)));
203 }
204
EVP_MAC_gettable_ctx_params(const EVP_MAC * mac)205 const OSSL_PARAM *EVP_MAC_gettable_ctx_params(const EVP_MAC *mac)
206 {
207 void *alg;
208
209 if (mac->gettable_ctx_params == NULL)
210 return NULL;
211 alg = ossl_provider_ctx(EVP_MAC_get0_provider(mac));
212 return mac->gettable_ctx_params(NULL, alg);
213 }
214
EVP_MAC_settable_ctx_params(const EVP_MAC * mac)215 const OSSL_PARAM *EVP_MAC_settable_ctx_params(const EVP_MAC *mac)
216 {
217 void *alg;
218
219 if (mac->settable_ctx_params == NULL)
220 return NULL;
221 alg = ossl_provider_ctx(EVP_MAC_get0_provider(mac));
222 return mac->settable_ctx_params(NULL, alg);
223 }
224
EVP_MAC_CTX_gettable_params(EVP_MAC_CTX * ctx)225 const OSSL_PARAM *EVP_MAC_CTX_gettable_params(EVP_MAC_CTX *ctx)
226 {
227 void *alg;
228
229 if (ctx->meth->gettable_ctx_params == NULL)
230 return NULL;
231 alg = ossl_provider_ctx(EVP_MAC_get0_provider(ctx->meth));
232 return ctx->meth->gettable_ctx_params(ctx->algctx, alg);
233 }
234
EVP_MAC_CTX_settable_params(EVP_MAC_CTX * ctx)235 const OSSL_PARAM *EVP_MAC_CTX_settable_params(EVP_MAC_CTX *ctx)
236 {
237 void *alg;
238
239 if (ctx->meth->settable_ctx_params == NULL)
240 return NULL;
241 alg = ossl_provider_ctx(EVP_MAC_get0_provider(ctx->meth));
242 return ctx->meth->settable_ctx_params(ctx->algctx, alg);
243 }
244
EVP_MAC_do_all_provided(OSSL_LIB_CTX * libctx,void (* fn)(EVP_MAC * mac,void * arg),void * arg)245 void EVP_MAC_do_all_provided(OSSL_LIB_CTX *libctx,
246 void (*fn)(EVP_MAC *mac, void *arg),
247 void *arg)
248 {
249 evp_generic_do_all(libctx, OSSL_OP_MAC,
250 (void (*)(void *, void *))fn, arg,
251 evp_mac_from_algorithm, evp_mac_up_ref, evp_mac_free);
252 }
253
evp_mac_fetch_from_prov(OSSL_PROVIDER * prov,const char * algorithm,const char * properties)254 EVP_MAC *evp_mac_fetch_from_prov(OSSL_PROVIDER *prov,
255 const char *algorithm,
256 const char *properties)
257 {
258 return evp_generic_fetch_from_prov(prov, OSSL_OP_MAC,
259 algorithm, properties,
260 evp_mac_from_algorithm,
261 evp_mac_up_ref,
262 evp_mac_free);
263 }
264