2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include <openssl/crypto.h>
11 #include <openssl/evp.h>
12 #include <openssl/err.h>
13 #include "internal/refcount.h"
14 #include "crypto/evp.h"
15 #include "internal/provider.h"
16 #include "internal/numbers.h" /* includes SIZE_MAX */
17 #include "evp_local.h"
19 static EVP_KEYEXCH
*evp_keyexch_new(OSSL_PROVIDER
*prov
)
21 EVP_KEYEXCH
*exchange
= OPENSSL_zalloc(sizeof(EVP_KEYEXCH
));
23 if (exchange
== NULL
) {
24 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
28 exchange
->lock
= CRYPTO_THREAD_lock_new();
29 if (exchange
->lock
== NULL
) {
30 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
31 OPENSSL_free(exchange
);
34 exchange
->prov
= prov
;
35 ossl_provider_up_ref(prov
);
41 static void *evp_keyexch_from_dispatch(int name_id
,
42 const OSSL_DISPATCH
*fns
,
45 EVP_KEYEXCH
*exchange
= NULL
;
46 int fncnt
= 0, paramfncnt
= 0;
48 if ((exchange
= evp_keyexch_new(prov
)) == NULL
) {
49 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
53 exchange
->name_id
= name_id
;
55 for (; fns
->function_id
!= 0; fns
++) {
56 switch (fns
->function_id
) {
57 case OSSL_FUNC_KEYEXCH_NEWCTX
:
58 if (exchange
->newctx
!= NULL
)
60 exchange
->newctx
= OSSL_get_OP_keyexch_newctx(fns
);
63 case OSSL_FUNC_KEYEXCH_INIT
:
64 if (exchange
->init
!= NULL
)
66 exchange
->init
= OSSL_get_OP_keyexch_init(fns
);
69 case OSSL_FUNC_KEYEXCH_SET_PEER
:
70 if (exchange
->set_peer
!= NULL
)
72 exchange
->set_peer
= OSSL_get_OP_keyexch_set_peer(fns
);
74 case OSSL_FUNC_KEYEXCH_DERIVE
:
75 if (exchange
->derive
!= NULL
)
77 exchange
->derive
= OSSL_get_OP_keyexch_derive(fns
);
80 case OSSL_FUNC_KEYEXCH_FREECTX
:
81 if (exchange
->freectx
!= NULL
)
83 exchange
->freectx
= OSSL_get_OP_keyexch_freectx(fns
);
86 case OSSL_FUNC_KEYEXCH_DUPCTX
:
87 if (exchange
->dupctx
!= NULL
)
89 exchange
->dupctx
= OSSL_get_OP_keyexch_dupctx(fns
);
91 case OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS
:
92 if (exchange
->set_ctx_params
!= NULL
)
94 exchange
->set_ctx_params
= OSSL_get_OP_keyexch_set_ctx_params(fns
);
97 case OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS
:
98 if (exchange
->settable_ctx_params
!= NULL
)
100 exchange
->settable_ctx_params
101 = OSSL_get_OP_keyexch_settable_ctx_params(fns
);
106 if (fncnt
!= 4 || (paramfncnt
!= 0 && paramfncnt
!= 2)) {
108 * In order to be a consistent set of functions we must have at least
109 * a complete set of "exchange" functions: init, derive, newctx,
110 * and freectx. The set_ctx_params and settable_ctx_params functions are
111 * optional, but if one of them is present then the other one must also
112 * be present. The dupctx and set_peer functions are optional.
114 EVPerr(EVP_F_EVP_KEYEXCH_FROM_DISPATCH
,
115 EVP_R_INVALID_PROVIDER_FUNCTIONS
);
122 EVP_KEYEXCH_free(exchange
);
126 void EVP_KEYEXCH_free(EVP_KEYEXCH
*exchange
)
128 if (exchange
!= NULL
) {
131 CRYPTO_DOWN_REF(&exchange
->refcnt
, &i
, exchange
->lock
);
134 ossl_provider_free(exchange
->prov
);
135 CRYPTO_THREAD_lock_free(exchange
->lock
);
136 OPENSSL_free(exchange
);
140 int EVP_KEYEXCH_up_ref(EVP_KEYEXCH
*exchange
)
144 CRYPTO_UP_REF(&exchange
->refcnt
, &ref
, exchange
->lock
);
148 OSSL_PROVIDER
*EVP_KEYEXCH_provider(const EVP_KEYEXCH
*exchange
)
150 return exchange
->prov
;
153 EVP_KEYEXCH
*EVP_KEYEXCH_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
154 const char *properties
)
156 return evp_generic_fetch(ctx
, OSSL_OP_KEYEXCH
, algorithm
, properties
,
157 evp_keyexch_from_dispatch
,
158 (int (*)(void *))EVP_KEYEXCH_up_ref
,
159 (void (*)(void *))EVP_KEYEXCH_free
);
162 int EVP_PKEY_derive_init(EVP_PKEY_CTX
*ctx
)
165 void *provkey
= NULL
;
166 EVP_KEYEXCH
*exchange
= NULL
;
167 EVP_KEYMGMT
*tmp_keymgmt
= NULL
;
168 const char *supported_exch
= NULL
;
171 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
175 evp_pkey_ctx_free_old_ops(ctx
);
176 ctx
->operation
= EVP_PKEY_OP_DERIVE
;
179 * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
180 * calls can be removed.
184 if (ctx
->engine
!= NULL
|| ctx
->keytype
== NULL
)
187 /* Ensure that the key is provided. If not, go legacy */
188 tmp_keymgmt
= ctx
->keymgmt
;
189 provkey
= evp_pkey_make_provided(ctx
->pkey
, ctx
->libctx
,
190 &tmp_keymgmt
, ctx
->propquery
, 0);
193 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt
)) {
194 ERR_clear_last_mark();
195 ERR_raise(ERR_LIB_EVP
, EVP_R_INITIALIZATION_ERROR
);
198 EVP_KEYMGMT_free(ctx
->keymgmt
);
199 ctx
->keymgmt
= tmp_keymgmt
;
201 if (ctx
->keymgmt
->query_operation_name
!= NULL
)
202 supported_exch
= ctx
->keymgmt
->query_operation_name(OSSL_OP_KEYEXCH
);
205 * If we didn't get a supported exch, assume there is one with the
206 * same name as the key type.
208 if (supported_exch
== NULL
)
209 supported_exch
= ctx
->keytype
;
212 * Because we cleared out old ops, we shouldn't need to worry about
213 * checking if exchange is already there.
215 exchange
= EVP_KEYEXCH_fetch(ctx
->libctx
, supported_exch
, ctx
->propquery
);
218 || (EVP_KEYMGMT_provider(ctx
->keymgmt
)
219 != EVP_KEYEXCH_provider(exchange
))) {
221 * We don't need to free ctx->keymgmt here, as it's not necessarily
222 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
224 EVP_KEYEXCH_free(exchange
);
229 * TODO remove this when legacy is gone
230 * If we don't have the full support we need with provided methods,
231 * let's go see if legacy does.
235 /* No more legacy from here down to legacy: */
237 ctx
->op
.kex
.exchange
= exchange
;
238 ctx
->op
.kex
.exchprovctx
= exchange
->newctx(ossl_provider_ctx(exchange
->prov
));
239 if (ctx
->op
.kex
.exchprovctx
== NULL
) {
240 /* The provider key can stay in the cache */
241 EVPerr(0, EVP_R_INITIALIZATION_ERROR
);
244 ret
= exchange
->init(ctx
->op
.kex
.exchprovctx
, provkey
);
248 ctx
->operation
= EVP_PKEY_OP_UNDEFINED
;
253 * TODO remove this when legacy is gone
254 * If we don't have the full support we need with provided methods,
255 * let's go see if legacy does.
262 if (ctx
->pmeth
== NULL
|| ctx
->pmeth
->derive
== NULL
) {
263 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
267 if (ctx
->pmeth
->derive_init
== NULL
)
269 ret
= ctx
->pmeth
->derive_init(ctx
);
271 ctx
->operation
= EVP_PKEY_OP_UNDEFINED
;
276 int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX
*ctx
, EVP_PKEY
*peer
)
279 void *provkey
= NULL
;
282 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
,
283 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
287 if (!EVP_PKEY_CTX_IS_DERIVE_OP(ctx
) || ctx
->op
.kex
.exchprovctx
== NULL
)
290 if (ctx
->op
.kex
.exchange
->set_peer
== NULL
) {
291 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
,
292 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
296 provkey
= evp_keymgmt_export_to_provider(peer
, ctx
->keymgmt
, 0);
297 /* If export failed, legacy may be able to pick it up */
300 return ctx
->op
.kex
.exchange
->set_peer(ctx
->op
.kex
.exchprovctx
, provkey
);
306 if (ctx
->pmeth
== NULL
307 || !(ctx
->pmeth
->derive
!= NULL
308 || ctx
->pmeth
->encrypt
!= NULL
309 || ctx
->pmeth
->decrypt
!= NULL
)
310 || ctx
->pmeth
->ctrl
== NULL
) {
311 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
,
312 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
315 if (ctx
->operation
!= EVP_PKEY_OP_DERIVE
316 && ctx
->operation
!= EVP_PKEY_OP_ENCRYPT
317 && ctx
->operation
!= EVP_PKEY_OP_DECRYPT
) {
318 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
,
319 EVP_R_OPERATON_NOT_INITIALIZED
);
323 ret
= ctx
->pmeth
->ctrl(ctx
, EVP_PKEY_CTRL_PEER_KEY
, 0, peer
);
331 if (ctx
->pkey
== NULL
) {
332 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
, EVP_R_NO_KEY_SET
);
336 if (ctx
->pkey
->type
!= peer
->type
) {
337 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
, EVP_R_DIFFERENT_KEY_TYPES
);
342 * For clarity. The error is if parameters in peer are
343 * present (!missing) but don't match. EVP_PKEY_cmp_parameters may return
344 * 1 (match), 0 (don't match) and -2 (comparison is not defined). -1
345 * (different key types) is impossible here because it is checked earlier.
346 * -2 is OK for us here, as well as 1, so we can check for 0 only.
348 if (!EVP_PKEY_missing_parameters(peer
) &&
349 !EVP_PKEY_cmp_parameters(ctx
->pkey
, peer
)) {
350 EVPerr(EVP_F_EVP_PKEY_DERIVE_SET_PEER
, EVP_R_DIFFERENT_PARAMETERS
);
354 EVP_PKEY_free(ctx
->peerkey
);
357 ret
= ctx
->pmeth
->ctrl(ctx
, EVP_PKEY_CTRL_PEER_KEY
, 1, peer
);
364 EVP_PKEY_up_ref(peer
);
369 int EVP_PKEY_derive(EVP_PKEY_CTX
*ctx
, unsigned char *key
, size_t *pkeylen
)
374 EVPerr(EVP_F_EVP_PKEY_DERIVE
,
375 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
379 if (!EVP_PKEY_CTX_IS_DERIVE_OP(ctx
)) {
380 EVPerr(EVP_F_EVP_PKEY_DERIVE
, EVP_R_OPERATON_NOT_INITIALIZED
);
384 if (ctx
->op
.kex
.exchprovctx
== NULL
)
387 ret
= ctx
->op
.kex
.exchange
->derive(ctx
->op
.kex
.exchprovctx
, key
, pkeylen
,
392 if (ctx
== NULL
|| ctx
->pmeth
== NULL
|| ctx
->pmeth
->derive
== NULL
) {
393 EVPerr(EVP_F_EVP_PKEY_DERIVE
,
394 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
398 M_check_autoarg(ctx
, key
, pkeylen
, EVP_F_EVP_PKEY_DERIVE
)
399 return ctx
->pmeth
->derive(ctx
, key
, pkeylen
);
402 int EVP_KEYEXCH_number(const EVP_KEYEXCH
*keyexch
)
404 return keyexch
->name_id
;
407 int EVP_KEYEXCH_is_a(const EVP_KEYEXCH
*keyexch
, const char *name
)
409 return evp_is_a(keyexch
->prov
, keyexch
->name_id
, NULL
, name
);
412 void EVP_KEYEXCH_do_all_provided(OPENSSL_CTX
*libctx
,
413 void (*fn
)(EVP_KEYEXCH
*keyexch
, void *arg
),
416 evp_generic_do_all(libctx
, OSSL_OP_KEYEXCH
,
417 (void (*)(void *, void *))fn
, arg
,
418 evp_keyexch_from_dispatch
,
419 (void (*)(void *))EVP_KEYEXCH_free
);
422 void EVP_KEYEXCH_names_do_all(const EVP_KEYEXCH
*keyexch
,
423 void (*fn
)(const char *name
, void *data
),
426 if (keyexch
->prov
!= NULL
)
427 evp_names_do_all(keyexch
->prov
, keyexch
->name_id
, fn
, data
);