2 * Copyright 2006-2020 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
12 #include <openssl/objects.h>
13 #include <openssl/evp.h>
14 #include "internal/cryptlib.h"
15 #include "crypto/evp.h"
16 #include "internal/provider.h"
17 #include "evp_local.h"
19 static int evp_pkey_asym_cipher_init(EVP_PKEY_CTX *ctx, int operation)
23 EVP_ASYM_CIPHER *cipher = NULL;
24 EVP_KEYMGMT *tmp_keymgmt = NULL;
25 const char *supported_ciph = NULL;
28 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
32 evp_pkey_ctx_free_old_ops(ctx);
33 ctx->operation = operation;
36 * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
37 * calls can be removed.
41 if (ctx->engine != NULL || ctx->keytype == NULL)
45 * Ensure that the key is provided, either natively, or as a cached export.
48 tmp_keymgmt = ctx->keymgmt;
49 provkey = evp_pkey_export_to_provider(ctx->pkey, ctx->libctx,
50 &tmp_keymgmt, ctx->propquery);
53 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
54 ERR_clear_last_mark();
55 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
58 EVP_KEYMGMT_free(ctx->keymgmt);
59 ctx->keymgmt = tmp_keymgmt;
61 if (ctx->keymgmt->query_operation_name != NULL)
63 ctx->keymgmt->query_operation_name(OSSL_OP_ASYM_CIPHER);
66 * If we didn't get a supported ciph, assume there is one with the
67 * same name as the key type.
69 if (supported_ciph == NULL)
70 supported_ciph = ctx->keytype;
73 * Because we cleared out old ops, we shouldn't need to worry about
74 * checking if cipher is already there.
77 EVP_ASYM_CIPHER_fetch(ctx->libctx, supported_ciph, ctx->propquery);
80 || (EVP_KEYMGMT_provider(ctx->keymgmt)
81 != EVP_ASYM_CIPHER_provider(cipher))) {
83 * We don't need to free ctx->keymgmt here, as it's not necessarily
84 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
86 EVP_ASYM_CIPHER_free(cipher);
91 * TODO remove this when legacy is gone
92 * If we don't have the full support we need with provided methods,
93 * let's go see if legacy does.
97 /* No more legacy from here down to legacy: */
99 ctx->op.ciph.cipher = cipher;
100 ctx->op.ciph.ciphprovctx = cipher->newctx(ossl_provider_ctx(cipher->prov));
101 if (ctx->op.ciph.ciphprovctx == NULL) {
102 /* The provider key can stay in the cache */
103 EVPerr(0, EVP_R_INITIALIZATION_ERROR);
108 case EVP_PKEY_OP_ENCRYPT:
109 if (cipher->encrypt_init == NULL) {
110 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
114 ret = cipher->encrypt_init(ctx->op.ciph.ciphprovctx, provkey);
116 case EVP_PKEY_OP_DECRYPT:
117 if (cipher->decrypt_init == NULL) {
118 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
122 ret = cipher->decrypt_init(ctx->op.ciph.ciphprovctx, provkey);
125 EVPerr(0, EVP_R_INITIALIZATION_ERROR);
135 * TODO remove this when legacy is gone
136 * If we don't have the full support we need with provided methods,
137 * let's go see if legacy does.
141 if (ctx->pmeth == NULL || ctx->pmeth->encrypt == NULL) {
142 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
145 switch(ctx->operation) {
146 case EVP_PKEY_OP_ENCRYPT:
147 if (ctx->pmeth->encrypt_init == NULL)
149 ret = ctx->pmeth->encrypt_init(ctx);
151 case EVP_PKEY_OP_DECRYPT:
152 if (ctx->pmeth->decrypt_init == NULL)
154 ret = ctx->pmeth->decrypt_init(ctx);
157 EVPerr(0, EVP_R_INITIALIZATION_ERROR);
163 evp_pkey_ctx_free_old_ops(ctx);
164 ctx->operation = EVP_PKEY_OP_UNDEFINED;
169 int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx)
171 return evp_pkey_asym_cipher_init(ctx, EVP_PKEY_OP_ENCRYPT);
174 int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
175 unsigned char *out, size_t *outlen,
176 const unsigned char *in, size_t inlen)
181 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
185 if (ctx->operation != EVP_PKEY_OP_ENCRYPT) {
186 EVPerr(0, EVP_R_OPERATON_NOT_INITIALIZED);
190 if (ctx->op.ciph.ciphprovctx == NULL)
193 ret = ctx->op.ciph.cipher->encrypt(ctx->op.ciph.ciphprovctx, out, outlen,
194 (out == NULL ? 0 : *outlen), in, inlen);
198 if (ctx->pmeth == NULL || ctx->pmeth->encrypt == NULL) {
199 EVPerr(EVP_F_EVP_PKEY_ENCRYPT,
200 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
203 M_check_autoarg(ctx, out, outlen, EVP_F_EVP_PKEY_ENCRYPT)
204 return ctx->pmeth->encrypt(ctx, out, outlen, in, inlen);
207 int EVP_PKEY_decrypt_init(EVP_PKEY_CTX *ctx)
209 return evp_pkey_asym_cipher_init(ctx, EVP_PKEY_OP_DECRYPT);
212 int EVP_PKEY_decrypt(EVP_PKEY_CTX *ctx,
213 unsigned char *out, size_t *outlen,
214 const unsigned char *in, size_t inlen)
219 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
223 if (ctx->operation != EVP_PKEY_OP_DECRYPT) {
224 EVPerr(0, EVP_R_OPERATON_NOT_INITIALIZED);
228 if (ctx->op.ciph.ciphprovctx == NULL)
231 ret = ctx->op.ciph.cipher->decrypt(ctx->op.ciph.ciphprovctx, out, outlen,
232 (out == NULL ? 0 : *outlen), in, inlen);
236 if (ctx->pmeth == NULL || ctx->pmeth->decrypt == NULL) {
237 EVPerr(EVP_F_EVP_PKEY_DECRYPT,
238 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
241 M_check_autoarg(ctx, out, outlen, EVP_F_EVP_PKEY_DECRYPT)
242 return ctx->pmeth->decrypt(ctx, out, outlen, in, inlen);
246 static EVP_ASYM_CIPHER *evp_asym_cipher_new(OSSL_PROVIDER *prov)
248 EVP_ASYM_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_ASYM_CIPHER));
250 if (cipher == NULL) {
251 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
255 cipher->lock = CRYPTO_THREAD_lock_new();
256 if (cipher->lock == NULL) {
257 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
258 OPENSSL_free(cipher);
262 ossl_provider_up_ref(prov);
268 static void *evp_asym_cipher_from_dispatch(int name_id,
269 const OSSL_DISPATCH *fns,
272 EVP_ASYM_CIPHER *cipher = NULL;
273 int ctxfncnt = 0, encfncnt = 0, decfncnt = 0;
274 int gparamfncnt = 0, sparamfncnt = 0;
276 if ((cipher = evp_asym_cipher_new(prov)) == NULL) {
277 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
281 cipher->name_id = name_id;
283 for (; fns->function_id != 0; fns++) {
284 switch (fns->function_id) {
285 case OSSL_FUNC_ASYM_CIPHER_NEWCTX:
286 if (cipher->newctx != NULL)
288 cipher->newctx = OSSL_FUNC_asym_cipher_newctx(fns);
291 case OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT:
292 if (cipher->encrypt_init != NULL)
294 cipher->encrypt_init = OSSL_FUNC_asym_cipher_encrypt_init(fns);
297 case OSSL_FUNC_ASYM_CIPHER_ENCRYPT:
298 if (cipher->encrypt != NULL)
300 cipher->encrypt = OSSL_FUNC_asym_cipher_encrypt(fns);
303 case OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT:
304 if (cipher->decrypt_init != NULL)
306 cipher->decrypt_init = OSSL_FUNC_asym_cipher_decrypt_init(fns);
309 case OSSL_FUNC_ASYM_CIPHER_DECRYPT:
310 if (cipher->decrypt != NULL)
312 cipher->decrypt = OSSL_FUNC_asym_cipher_decrypt(fns);
315 case OSSL_FUNC_ASYM_CIPHER_FREECTX:
316 if (cipher->freectx != NULL)
318 cipher->freectx = OSSL_FUNC_asym_cipher_freectx(fns);
321 case OSSL_FUNC_ASYM_CIPHER_DUPCTX:
322 if (cipher->dupctx != NULL)
324 cipher->dupctx = OSSL_FUNC_asym_cipher_dupctx(fns);
326 case OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS:
327 if (cipher->get_ctx_params != NULL)
329 cipher->get_ctx_params
330 = OSSL_FUNC_asym_cipher_get_ctx_params(fns);
333 case OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS:
334 if (cipher->gettable_ctx_params != NULL)
336 cipher->gettable_ctx_params
337 = OSSL_FUNC_asym_cipher_gettable_ctx_params(fns);
340 case OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS:
341 if (cipher->set_ctx_params != NULL)
343 cipher->set_ctx_params
344 = OSSL_FUNC_asym_cipher_set_ctx_params(fns);
347 case OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS:
348 if (cipher->settable_ctx_params != NULL)
350 cipher->settable_ctx_params
351 = OSSL_FUNC_asym_cipher_settable_ctx_params(fns);
357 || (encfncnt != 0 && encfncnt != 2)
358 || (decfncnt != 0 && decfncnt != 2)
359 || (encfncnt != 2 && decfncnt != 2)
360 || (gparamfncnt != 0 && gparamfncnt != 2)
361 || (sparamfncnt != 0 && sparamfncnt != 2)) {
363 * In order to be a consistent set of functions we must have at least
364 * a set of context functions (newctx and freectx) as well as a pair of
365 * "cipher" functions: (encrypt_init, encrypt) or
366 * (decrypt_init decrypt). set_ctx_params and settable_ctx_params are
367 * optional, but if one of them is present then the other one must also
368 * be present. The same applies to get_ctx_params and
369 * gettable_ctx_params. The dupctx function is optional.
371 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
377 EVP_ASYM_CIPHER_free(cipher);
381 void EVP_ASYM_CIPHER_free(EVP_ASYM_CIPHER *cipher)
383 if (cipher != NULL) {
386 CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
389 ossl_provider_free(cipher->prov);
390 CRYPTO_THREAD_lock_free(cipher->lock);
391 OPENSSL_free(cipher);
395 int EVP_ASYM_CIPHER_up_ref(EVP_ASYM_CIPHER *cipher)
399 CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
403 OSSL_PROVIDER *EVP_ASYM_CIPHER_provider(const EVP_ASYM_CIPHER *cipher)
408 EVP_ASYM_CIPHER *EVP_ASYM_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
409 const char *properties)
411 return evp_generic_fetch(ctx, OSSL_OP_ASYM_CIPHER, algorithm, properties,
412 evp_asym_cipher_from_dispatch,
413 (int (*)(void *))EVP_ASYM_CIPHER_up_ref,
414 (void (*)(void *))EVP_ASYM_CIPHER_free);
417 int EVP_ASYM_CIPHER_is_a(const EVP_ASYM_CIPHER *cipher, const char *name)
419 return evp_is_a(cipher->prov, cipher->name_id, NULL, name);
422 int EVP_ASYM_CIPHER_number(const EVP_ASYM_CIPHER *cipher)
424 return cipher->name_id;
427 void EVP_ASYM_CIPHER_do_all_provided(OPENSSL_CTX *libctx,
428 void (*fn)(EVP_ASYM_CIPHER *cipher,
432 evp_generic_do_all(libctx, OSSL_OP_ASYM_CIPHER,
433 (void (*)(void *, void *))fn, arg,
434 evp_asym_cipher_from_dispatch,
435 (void (*)(void *))EVP_ASYM_CIPHER_free);
439 void EVP_ASYM_CIPHER_names_do_all(const EVP_ASYM_CIPHER *cipher,
440 void (*fn)(const char *name, void *data),
443 if (cipher->prov != NULL)
444 evp_names_do_all(cipher->prov, cipher->name_id, fn, data);