]>
Commit | Line | Data |
---|---|---|
ff64702b | 1 | /* |
33388b44 | 2 | * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved. |
ff64702b MC |
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/crypto.h> | |
11 | #include <openssl/evp.h> | |
12 | #include <openssl/err.h> | |
13 | #include "internal/refcount.h" | |
25f2138b | 14 | #include "crypto/evp.h" |
ff64702b | 15 | #include "internal/provider.h" |
ac5a61ca | 16 | #include "internal/numbers.h" /* includes SIZE_MAX */ |
706457b7 | 17 | #include "evp_local.h" |
ff64702b MC |
18 | |
19 | static EVP_KEYEXCH *evp_keyexch_new(OSSL_PROVIDER *prov) | |
20 | { | |
21 | EVP_KEYEXCH *exchange = OPENSSL_zalloc(sizeof(EVP_KEYEXCH)); | |
22 | ||
c1ff5994 MC |
23 | if (exchange == NULL) { |
24 | ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE); | |
25 | return NULL; | |
26 | } | |
27 | ||
ff64702b MC |
28 | exchange->lock = CRYPTO_THREAD_lock_new(); |
29 | if (exchange->lock == NULL) { | |
c1ff5994 | 30 | ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE); |
ff64702b MC |
31 | OPENSSL_free(exchange); |
32 | return NULL; | |
33 | } | |
34 | exchange->prov = prov; | |
35 | ossl_provider_up_ref(prov); | |
36 | exchange->refcnt = 1; | |
37 | ||
38 | return exchange; | |
39 | } | |
40 | ||
f7c16d48 | 41 | static void *evp_keyexch_from_dispatch(int name_id, |
6b9e3724 | 42 | const OSSL_DISPATCH *fns, |
0ddf74bf | 43 | OSSL_PROVIDER *prov) |
ff64702b MC |
44 | { |
45 | EVP_KEYEXCH *exchange = NULL; | |
4fe54d67 | 46 | int fncnt = 0, sparamfncnt = 0, gparamfncnt = 0; |
ff64702b | 47 | |
f7c16d48 | 48 | if ((exchange = evp_keyexch_new(prov)) == NULL) { |
3ca9d210 RL |
49 | ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE); |
50 | goto err; | |
6b9e3724 | 51 | } |
ff64702b | 52 | |
f7c16d48 | 53 | exchange->name_id = name_id; |
3ca9d210 | 54 | |
ff64702b MC |
55 | for (; fns->function_id != 0; fns++) { |
56 | switch (fns->function_id) { | |
57 | case OSSL_FUNC_KEYEXCH_NEWCTX: | |
58 | if (exchange->newctx != NULL) | |
59 | break; | |
60 | exchange->newctx = OSSL_get_OP_keyexch_newctx(fns); | |
61 | fncnt++; | |
62 | break; | |
63 | case OSSL_FUNC_KEYEXCH_INIT: | |
64 | if (exchange->init != NULL) | |
65 | break; | |
66 | exchange->init = OSSL_get_OP_keyexch_init(fns); | |
67 | fncnt++; | |
68 | break; | |
69 | case OSSL_FUNC_KEYEXCH_SET_PEER: | |
70 | if (exchange->set_peer != NULL) | |
71 | break; | |
72 | exchange->set_peer = OSSL_get_OP_keyexch_set_peer(fns); | |
73 | break; | |
74 | case OSSL_FUNC_KEYEXCH_DERIVE: | |
75 | if (exchange->derive != NULL) | |
76 | break; | |
77 | exchange->derive = OSSL_get_OP_keyexch_derive(fns); | |
78 | fncnt++; | |
79 | break; | |
80 | case OSSL_FUNC_KEYEXCH_FREECTX: | |
81 | if (exchange->freectx != NULL) | |
82 | break; | |
83 | exchange->freectx = OSSL_get_OP_keyexch_freectx(fns); | |
84 | fncnt++; | |
85 | break; | |
86 | case OSSL_FUNC_KEYEXCH_DUPCTX: | |
87 | if (exchange->dupctx != NULL) | |
88 | break; | |
89 | exchange->dupctx = OSSL_get_OP_keyexch_dupctx(fns); | |
90 | break; | |
4fe54d67 NT |
91 | case OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS: |
92 | if (exchange->get_ctx_params != NULL) | |
93 | break; | |
94 | exchange->get_ctx_params = OSSL_get_OP_keyexch_get_ctx_params(fns); | |
95 | gparamfncnt++; | |
96 | break; | |
97 | case OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS: | |
98 | if (exchange->gettable_ctx_params != NULL) | |
99 | break; | |
100 | exchange->gettable_ctx_params | |
101 | = OSSL_get_OP_keyexch_gettable_ctx_params(fns); | |
102 | gparamfncnt++; | |
103 | break; | |
9c45222d MC |
104 | case OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS: |
105 | if (exchange->set_ctx_params != NULL) | |
35aca9ec | 106 | break; |
9c45222d | 107 | exchange->set_ctx_params = OSSL_get_OP_keyexch_set_ctx_params(fns); |
4fe54d67 | 108 | sparamfncnt++; |
9c45222d MC |
109 | break; |
110 | case OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS: | |
111 | if (exchange->settable_ctx_params != NULL) | |
112 | break; | |
113 | exchange->settable_ctx_params | |
114 | = OSSL_get_OP_keyexch_settable_ctx_params(fns); | |
4fe54d67 | 115 | sparamfncnt++; |
35aca9ec | 116 | break; |
ff64702b MC |
117 | } |
118 | } | |
4fe54d67 NT |
119 | if (fncnt != 4 |
120 | || (gparamfncnt != 0 && gparamfncnt != 2) | |
121 | || (sparamfncnt != 0 && sparamfncnt != 2)) { | |
ff64702b MC |
122 | /* |
123 | * In order to be a consistent set of functions we must have at least | |
124 | * a complete set of "exchange" functions: init, derive, newctx, | |
9c45222d MC |
125 | * and freectx. The set_ctx_params and settable_ctx_params functions are |
126 | * optional, but if one of them is present then the other one must also | |
4fe54d67 NT |
127 | * be present. Same goes for get_ctx_params and gettable_ctx_params. |
128 | * The dupctx and set_peer functions are optional. | |
ff64702b | 129 | */ |
ff64702b MC |
130 | EVPerr(EVP_F_EVP_KEYEXCH_FROM_DISPATCH, |
131 | EVP_R_INVALID_PROVIDER_FUNCTIONS); | |
3ca9d210 | 132 | goto err; |
ff64702b MC |
133 | } |
134 | ||
135 | return exchange; | |
3ca9d210 RL |
136 | |
137 | err: | |
138 | EVP_KEYEXCH_free(exchange); | |
3ca9d210 | 139 | return NULL; |
ff64702b MC |
140 | } |
141 | ||
142 | void EVP_KEYEXCH_free(EVP_KEYEXCH *exchange) | |
143 | { | |
144 | if (exchange != NULL) { | |
145 | int i; | |
146 | ||
147 | CRYPTO_DOWN_REF(&exchange->refcnt, &i, exchange->lock); | |
148 | if (i > 0) | |
149 | return; | |
150 | ossl_provider_free(exchange->prov); | |
151 | CRYPTO_THREAD_lock_free(exchange->lock); | |
152 | OPENSSL_free(exchange); | |
153 | } | |
154 | } | |
155 | ||
156 | int EVP_KEYEXCH_up_ref(EVP_KEYEXCH *exchange) | |
157 | { | |
158 | int ref = 0; | |
159 | ||
160 | CRYPTO_UP_REF(&exchange->refcnt, &ref, exchange->lock); | |
161 | return 1; | |
162 | } | |
163 | ||
8b84b075 RL |
164 | OSSL_PROVIDER *EVP_KEYEXCH_provider(const EVP_KEYEXCH *exchange) |
165 | { | |
166 | return exchange->prov; | |
167 | } | |
168 | ||
ff64702b MC |
169 | EVP_KEYEXCH *EVP_KEYEXCH_fetch(OPENSSL_CTX *ctx, const char *algorithm, |
170 | const char *properties) | |
171 | { | |
0ddf74bf RL |
172 | return evp_generic_fetch(ctx, OSSL_OP_KEYEXCH, algorithm, properties, |
173 | evp_keyexch_from_dispatch, | |
174 | (int (*)(void *))EVP_KEYEXCH_up_ref, | |
175 | (void (*)(void *))EVP_KEYEXCH_free); | |
ff64702b MC |
176 | } |
177 | ||
c0e0984f | 178 | int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx) |
ff64702b MC |
179 | { |
180 | int ret; | |
8b84b075 | 181 | void *provkey = NULL; |
c0e0984f | 182 | EVP_KEYEXCH *exchange = NULL; |
f6aa5774 RL |
183 | EVP_KEYMGMT *tmp_keymgmt = NULL; |
184 | const char *supported_exch = NULL; | |
c0e0984f RL |
185 | |
186 | if (ctx == NULL) { | |
187 | EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); | |
188 | return -2; | |
189 | } | |
ff64702b | 190 | |
864b89ce | 191 | evp_pkey_ctx_free_old_ops(ctx); |
ff64702b MC |
192 | ctx->operation = EVP_PKEY_OP_DERIVE; |
193 | ||
0b9dd384 RL |
194 | /* |
195 | * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark() | |
196 | * calls can be removed. | |
197 | */ | |
198 | ERR_set_mark(); | |
199 | ||
4b9e90f4 | 200 | if (ctx->keymgmt == NULL) |
ff64702b MC |
201 | goto legacy; |
202 | ||
3c6ed955 RL |
203 | /* |
204 | * Ensure that the key is provided, either natively, or as a cached export. | |
205 | * If not, go legacy | |
206 | */ | |
f6aa5774 | 207 | tmp_keymgmt = ctx->keymgmt; |
3c6ed955 RL |
208 | provkey = evp_pkey_export_to_provider(ctx->pkey, ctx->libctx, |
209 | &tmp_keymgmt, ctx->propquery); | |
f6aa5774 RL |
210 | if (provkey == NULL) |
211 | goto legacy; | |
212 | if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { | |
0b9dd384 | 213 | ERR_clear_last_mark(); |
f6aa5774 RL |
214 | ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR); |
215 | goto err; | |
c0e0984f | 216 | } |
f6aa5774 RL |
217 | EVP_KEYMGMT_free(ctx->keymgmt); |
218 | ctx->keymgmt = tmp_keymgmt; | |
219 | ||
220 | if (ctx->keymgmt->query_operation_name != NULL) | |
221 | supported_exch = ctx->keymgmt->query_operation_name(OSSL_OP_KEYEXCH); | |
222 | ||
223 | /* | |
224 | * If we didn't get a supported exch, assume there is one with the | |
225 | * same name as the key type. | |
226 | */ | |
227 | if (supported_exch == NULL) | |
228 | supported_exch = ctx->keytype; | |
229 | ||
230 | /* | |
231 | * Because we cleared out old ops, we shouldn't need to worry about | |
232 | * checking if exchange is already there. | |
233 | */ | |
234 | exchange = EVP_KEYEXCH_fetch(ctx->libctx, supported_exch, ctx->propquery); | |
235 | ||
236 | if (exchange == NULL | |
c0e0984f RL |
237 | || (EVP_KEYMGMT_provider(ctx->keymgmt) |
238 | != EVP_KEYEXCH_provider(exchange))) { | |
ff64702b | 239 | /* |
0b9dd384 RL |
240 | * We don't need to free ctx->keymgmt here, as it's not necessarily |
241 | * tied to this operation. It will be freed by EVP_PKEY_CTX_free(). | |
ff64702b | 242 | */ |
c0e0984f RL |
243 | EVP_KEYEXCH_free(exchange); |
244 | goto legacy; | |
ff64702b MC |
245 | } |
246 | ||
0b9dd384 RL |
247 | /* |
248 | * TODO remove this when legacy is gone | |
249 | * If we don't have the full support we need with provided methods, | |
250 | * let's go see if legacy does. | |
251 | */ | |
252 | ERR_pop_to_mark(); | |
253 | ||
254 | /* No more legacy from here down to legacy: */ | |
c0e0984f | 255 | |
864b89ce | 256 | ctx->op.kex.exchange = exchange; |
864b89ce MC |
257 | ctx->op.kex.exchprovctx = exchange->newctx(ossl_provider_ctx(exchange->prov)); |
258 | if (ctx->op.kex.exchprovctx == NULL) { | |
8b84b075 | 259 | /* The provider key can stay in the cache */ |
c0e0984f | 260 | EVPerr(0, EVP_R_INITIALIZATION_ERROR); |
ff64702b MC |
261 | goto err; |
262 | } | |
864b89ce | 263 | ret = exchange->init(ctx->op.kex.exchprovctx, provkey); |
ff64702b MC |
264 | |
265 | return ret ? 1 : 0; | |
266 | err: | |
267 | ctx->operation = EVP_PKEY_OP_UNDEFINED; | |
268 | return 0; | |
269 | ||
270 | legacy: | |
0b9dd384 RL |
271 | /* |
272 | * TODO remove this when legacy is gone | |
273 | * If we don't have the full support we need with provided methods, | |
274 | * let's go see if legacy does. | |
275 | */ | |
276 | ERR_pop_to_mark(); | |
277 | ||
f844f9eb | 278 | #ifdef FIPS_MODULE |
62f49b90 SL |
279 | return 0; |
280 | #else | |
e0d8523e | 281 | if (ctx->pmeth == NULL || ctx->pmeth->derive == NULL) { |
c0e0984f | 282 | EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); |
ff64702b MC |
283 | return -2; |
284 | } | |
285 | ||
286 | if (ctx->pmeth->derive_init == NULL) | |
287 | return 1; | |
288 | ret = ctx->pmeth->derive_init(ctx); | |
289 | if (ret <= 0) | |
290 | ctx->operation = EVP_PKEY_OP_UNDEFINED; | |
291 | return ret; | |
62f49b90 | 292 | #endif |
ff64702b MC |
293 | } |
294 | ||
ff64702b MC |
295 | int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer) |
296 | { | |
62f49b90 | 297 | int ret = 0; |
8b84b075 | 298 | void *provkey = NULL; |
ff64702b MC |
299 | |
300 | if (ctx == NULL) { | |
301 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, | |
302 | EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); | |
303 | return -2; | |
304 | } | |
305 | ||
864b89ce | 306 | if (!EVP_PKEY_CTX_IS_DERIVE_OP(ctx) || ctx->op.kex.exchprovctx == NULL) |
ff64702b MC |
307 | goto legacy; |
308 | ||
864b89ce | 309 | if (ctx->op.kex.exchange->set_peer == NULL) { |
ff64702b MC |
310 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, |
311 | EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); | |
312 | return -2; | |
313 | } | |
314 | ||
3c6ed955 RL |
315 | provkey = evp_pkey_export_to_provider(peer, ctx->libctx, &ctx->keymgmt, |
316 | ctx->propquery); | |
3f7ce7f1 RL |
317 | /* |
318 | * If making the key provided wasn't possible, legacy may be able to pick | |
319 | * it up | |
320 | */ | |
e0d8523e RL |
321 | if (provkey == NULL) |
322 | goto legacy; | |
864b89ce | 323 | return ctx->op.kex.exchange->set_peer(ctx->op.kex.exchprovctx, provkey); |
ff64702b MC |
324 | |
325 | legacy: | |
f844f9eb | 326 | #ifdef FIPS_MODULE |
62f49b90 SL |
327 | return ret; |
328 | #else | |
3f7ce7f1 RL |
329 | /* |
330 | * TODO(3.0) investigate the case where the operation is deemed legacy, | |
331 | * but the given peer key is provider only. | |
332 | */ | |
ff64702b MC |
333 | if (ctx->pmeth == NULL |
334 | || !(ctx->pmeth->derive != NULL | |
335 | || ctx->pmeth->encrypt != NULL | |
336 | || ctx->pmeth->decrypt != NULL) | |
337 | || ctx->pmeth->ctrl == NULL) { | |
338 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, | |
339 | EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); | |
340 | return -2; | |
341 | } | |
342 | if (ctx->operation != EVP_PKEY_OP_DERIVE | |
343 | && ctx->operation != EVP_PKEY_OP_ENCRYPT | |
344 | && ctx->operation != EVP_PKEY_OP_DECRYPT) { | |
345 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, | |
346 | EVP_R_OPERATON_NOT_INITIALIZED); | |
347 | return -1; | |
348 | } | |
349 | ||
350 | ret = ctx->pmeth->ctrl(ctx, EVP_PKEY_CTRL_PEER_KEY, 0, peer); | |
351 | ||
352 | if (ret <= 0) | |
353 | return ret; | |
354 | ||
355 | if (ret == 2) | |
356 | return 1; | |
357 | ||
358 | if (ctx->pkey == NULL) { | |
359 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, EVP_R_NO_KEY_SET); | |
360 | return -1; | |
361 | } | |
362 | ||
363 | if (ctx->pkey->type != peer->type) { | |
364 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, EVP_R_DIFFERENT_KEY_TYPES); | |
365 | return -1; | |
366 | } | |
367 | ||
368 | /* | |
369 | * For clarity. The error is if parameters in peer are | |
370 | * present (!missing) but don't match. EVP_PKEY_cmp_parameters may return | |
371 | * 1 (match), 0 (don't match) and -2 (comparison is not defined). -1 | |
372 | * (different key types) is impossible here because it is checked earlier. | |
373 | * -2 is OK for us here, as well as 1, so we can check for 0 only. | |
374 | */ | |
375 | if (!EVP_PKEY_missing_parameters(peer) && | |
376 | !EVP_PKEY_cmp_parameters(ctx->pkey, peer)) { | |
377 | EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER, EVP_R_DIFFERENT_PARAMETERS); | |
378 | return -1; | |
379 | } | |
380 | ||
381 | EVP_PKEY_free(ctx->peerkey); | |
382 | ctx->peerkey = peer; | |
383 | ||
384 | ret = ctx->pmeth->ctrl(ctx, EVP_PKEY_CTRL_PEER_KEY, 1, peer); | |
385 | ||
386 | if (ret <= 0) { | |
387 | ctx->peerkey = NULL; | |
388 | return ret; | |
389 | } | |
390 | ||
391 | EVP_PKEY_up_ref(peer); | |
392 | return 1; | |
62f49b90 | 393 | #endif |
ff64702b MC |
394 | } |
395 | ||
396 | int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *pkeylen) | |
397 | { | |
398 | int ret; | |
399 | ||
400 | if (ctx == NULL) { | |
401 | EVPerr(EVP_F_EVP_PKEY_DERIVE, | |
402 | EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); | |
403 | return -2; | |
404 | } | |
405 | ||
864b89ce | 406 | if (!EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) { |
ff64702b MC |
407 | EVPerr(EVP_F_EVP_PKEY_DERIVE, EVP_R_OPERATON_NOT_INITIALIZED); |
408 | return -1; | |
409 | } | |
410 | ||
864b89ce | 411 | if (ctx->op.kex.exchprovctx == NULL) |
ff64702b MC |
412 | goto legacy; |
413 | ||
864b89ce MC |
414 | ret = ctx->op.kex.exchange->derive(ctx->op.kex.exchprovctx, key, pkeylen, |
415 | SIZE_MAX); | |
ff64702b MC |
416 | |
417 | return ret; | |
418 | legacy: | |
419 | if (ctx == NULL || ctx->pmeth == NULL || ctx->pmeth->derive == NULL) { | |
420 | EVPerr(EVP_F_EVP_PKEY_DERIVE, | |
421 | EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE); | |
422 | return -2; | |
423 | } | |
424 | ||
425 | M_check_autoarg(ctx, key, pkeylen, EVP_F_EVP_PKEY_DERIVE) | |
426 | return ctx->pmeth->derive(ctx, key, pkeylen); | |
427 | } | |
251e610c | 428 | |
506cb0f6 RL |
429 | int EVP_KEYEXCH_number(const EVP_KEYEXCH *keyexch) |
430 | { | |
431 | return keyexch->name_id; | |
432 | } | |
433 | ||
251e610c RL |
434 | int EVP_KEYEXCH_is_a(const EVP_KEYEXCH *keyexch, const char *name) |
435 | { | |
e4a1d023 | 436 | return evp_is_a(keyexch->prov, keyexch->name_id, NULL, name); |
251e610c RL |
437 | } |
438 | ||
439 | void EVP_KEYEXCH_do_all_provided(OPENSSL_CTX *libctx, | |
440 | void (*fn)(EVP_KEYEXCH *keyexch, void *arg), | |
441 | void *arg) | |
442 | { | |
251e610c RL |
443 | evp_generic_do_all(libctx, OSSL_OP_KEYEXCH, |
444 | (void (*)(void *, void *))fn, arg, | |
0ddf74bf | 445 | evp_keyexch_from_dispatch, |
251e610c RL |
446 | (void (*)(void *))EVP_KEYEXCH_free); |
447 | } | |
f651c727 RL |
448 | |
449 | void EVP_KEYEXCH_names_do_all(const EVP_KEYEXCH *keyexch, | |
450 | void (*fn)(const char *name, void *data), | |
451 | void *data) | |
452 | { | |
453 | if (keyexch->prov != NULL) | |
454 | evp_names_do_all(keyexch->prov, keyexch->name_id, fn, data); | |
455 | } |