2 * Copyright 1995-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 "internal/cryptlib.h"
13 #include <openssl/evp.h>
14 #include <openssl/err.h>
15 #include <openssl/rand.h>
16 #include <openssl/rand_drbg.h>
17 #include <openssl/engine.h>
18 #include <openssl/params.h>
19 #include <openssl/core_names.h>
20 #include "crypto/evp.h"
21 #include "internal/provider.h"
22 #include "evp_local.h"
24 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx)
29 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
32 if (ctx->provctx != NULL) {
33 if (ctx->cipher->freectx != NULL)
34 ctx->cipher->freectx(ctx->provctx);
37 if (ctx->fetched_cipher != NULL)
38 EVP_CIPHER_free(ctx->fetched_cipher);
39 memset(ctx, 0, sizeof(*ctx));
43 /* TODO(3.0): Remove legacy code below */
46 if (ctx->cipher != NULL) {
47 if (ctx->cipher->cleanup && !ctx->cipher->cleanup(ctx))
49 /* Cleanse cipher context data */
50 if (ctx->cipher_data && ctx->cipher->ctx_size)
51 OPENSSL_cleanse(ctx->cipher_data, ctx->cipher->ctx_size);
53 OPENSSL_free(ctx->cipher_data);
54 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
55 ENGINE_finish(ctx->engine);
57 memset(ctx, 0, sizeof(*ctx));
61 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
63 return OPENSSL_zalloc(sizeof(EVP_CIPHER_CTX));
66 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
68 EVP_CIPHER_CTX_reset(ctx);
72 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
73 const unsigned char *key, const unsigned char *iv, int enc)
76 EVP_CIPHER_CTX_reset(ctx);
77 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
80 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
81 ENGINE *impl, const unsigned char *key,
82 const unsigned char *iv, int enc)
84 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
85 ENGINE *tmpimpl = NULL;
88 * enc == 1 means we are encrypting.
89 * enc == 0 means we are decrypting.
90 * enc == -1 means, use the previously initialised value for encrypt/decrypt
100 if (cipher == NULL && ctx->cipher == NULL) {
101 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
105 /* TODO(3.0): Legacy work around code below. Remove this */
107 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
109 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
110 * this context may already have an ENGINE! Try to avoid releasing the
111 * previous handle, re-querying for an ENGINE, and having a
112 * reinitialisation, when it may all be unnecessary.
114 if (ctx->engine && ctx->cipher
115 && (cipher == NULL || cipher->nid == ctx->cipher->nid))
118 if (cipher != NULL && impl == NULL) {
119 /* Ask if an ENGINE is reserved for this job */
120 tmpimpl = ENGINE_get_cipher_engine(cipher->nid);
125 * If there are engines involved then we should use legacy handling for now.
127 if (ctx->engine != NULL
128 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
132 if (ctx->cipher == ctx->fetched_cipher)
134 EVP_CIPHER_free(ctx->fetched_cipher);
135 ctx->fetched_cipher = NULL;
139 * Ensure a context left lying around from last time is cleared
142 if (cipher != NULL && ctx->cipher != NULL) {
143 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
144 ctx->cipher_data = NULL;
148 /* TODO(3.0): Start of non-legacy code below */
150 /* Ensure a context left lying around from last time is cleared */
151 if (cipher != NULL && ctx->cipher != NULL) {
152 unsigned long flags = ctx->flags;
154 EVP_CIPHER_CTX_reset(ctx);
155 /* Restore encrypt and flags */
161 cipher = ctx->cipher;
163 if (cipher->prov == NULL) {
165 /* We only do explicit fetches inside the FIPS module */
166 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
169 EVP_CIPHER *provciph =
170 EVP_CIPHER_fetch(NULL,
171 cipher->nid == NID_undef ? "NULL"
172 : OBJ_nid2sn(cipher->nid),
175 if (provciph == NULL) {
176 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
180 EVP_CIPHER_free(ctx->fetched_cipher);
181 ctx->fetched_cipher = provciph;
185 ctx->cipher = cipher;
186 if (ctx->provctx == NULL) {
187 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
188 if (ctx->provctx == NULL) {
189 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
194 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
196 * If this ctx was already set up for no padding then we need to tell
197 * the new cipher about it.
199 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
204 if (ctx->cipher->einit == NULL) {
205 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
209 return ctx->cipher->einit(ctx->provctx,
212 : EVP_CIPHER_CTX_key_length(ctx),
215 : EVP_CIPHER_CTX_iv_length(ctx));
218 if (ctx->cipher->dinit == NULL) {
219 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
223 return ctx->cipher->dinit(ctx->provctx,
226 : EVP_CIPHER_CTX_key_length(ctx),
229 : EVP_CIPHER_CTX_iv_length(ctx));
231 /* TODO(3.0): Remove legacy code below */
234 if (cipher != NULL) {
236 * Ensure a context left lying around from last time is cleared (we
237 * previously attempted to avoid this if the same ENGINE and
238 * EVP_CIPHER could be used).
241 unsigned long flags = ctx->flags;
242 EVP_CIPHER_CTX_reset(ctx);
243 /* Restore encrypt and flags */
247 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
249 if (!ENGINE_init(impl)) {
250 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
257 /* There's an ENGINE for this job ... (apparently) */
258 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
262 * One positive side-effect of US's export control history,
263 * is that we should at least be able to avoid using US
264 * misspellings of "initialisation"?
266 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
269 /* We'll use the ENGINE's private cipher definition */
272 * Store the ENGINE functional reference so we know 'cipher' came
273 * from an ENGINE and we need to release it when done.
281 ctx->cipher = cipher;
282 if (ctx->cipher->ctx_size) {
283 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
284 if (ctx->cipher_data == NULL) {
286 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
290 ctx->cipher_data = NULL;
292 ctx->key_len = cipher->key_len;
293 /* Preserve wrap enable flag, zero everything else */
294 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
295 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
296 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
298 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
303 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
306 if (ctx->cipher == NULL)
309 /* we assume block size is a power of 2 in *cryptUpdate */
310 OPENSSL_assert(ctx->cipher->block_size == 1
311 || ctx->cipher->block_size == 8
312 || ctx->cipher->block_size == 16);
314 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
315 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
316 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
320 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
321 switch (EVP_CIPHER_CTX_mode(ctx)) {
323 case EVP_CIPH_STREAM_CIPHER:
324 case EVP_CIPH_ECB_MODE:
327 case EVP_CIPH_CFB_MODE:
328 case EVP_CIPH_OFB_MODE:
333 case EVP_CIPH_CBC_MODE:
335 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
336 (int)sizeof(ctx->iv));
338 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
339 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
342 case EVP_CIPH_CTR_MODE:
344 /* Don't reuse IV for CTR mode */
346 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
354 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
355 if (!ctx->cipher->init(ctx, key, iv, enc))
360 ctx->block_mask = ctx->cipher->block_size - 1;
364 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
365 const unsigned char *in, int inl)
368 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
370 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
373 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
376 return EVP_EncryptFinal_ex(ctx, out, outl);
378 return EVP_DecryptFinal_ex(ctx, out, outl);
381 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
384 return EVP_EncryptFinal(ctx, out, outl);
386 return EVP_DecryptFinal(ctx, out, outl);
389 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
390 const unsigned char *key, const unsigned char *iv)
392 return EVP_CipherInit(ctx, cipher, key, iv, 1);
395 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
396 ENGINE *impl, const unsigned char *key,
397 const unsigned char *iv)
399 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
402 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
403 const unsigned char *key, const unsigned char *iv)
405 return EVP_CipherInit(ctx, cipher, key, iv, 0);
408 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
409 ENGINE *impl, const unsigned char *key,
410 const unsigned char *iv)
412 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
416 * According to the letter of standard difference between pointers
417 * is specified to be valid only within same object. This makes
418 * it formally challenging to determine if input and output buffers
419 * are not partially overlapping with standard pointer arithmetic.
424 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
426 * Then we have VMS that distinguishes itself by adhering to
427 * sizeof(size_t)==4 even in 64-bit builds, which means that
428 * difference between two pointers might be truncated to 32 bits.
429 * In the context one can even wonder how comparison for
430 * equality is implemented. To be on the safe side we adhere to
431 * PTRDIFF_T even for comparison for equality.
433 # define PTRDIFF_T uint64_t
435 # define PTRDIFF_T size_t
438 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
440 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
442 * Check for partially overlapping buffers. [Binary logical
443 * operations are used instead of boolean to minimize number
444 * of conditional branches.]
446 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
447 (diff > (0 - (PTRDIFF_T)len)));
452 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
453 unsigned char *out, int *outl,
454 const unsigned char *in, int inl)
456 int i, j, bl, cmpl = inl;
458 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
459 cmpl = (cmpl + 7) / 8;
461 bl = ctx->cipher->block_size;
463 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
464 /* If block size > 1 then the cipher will have to do this check */
465 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
466 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
470 i = ctx->cipher->do_cipher(ctx, out, in, inl);
482 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
483 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
487 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
488 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
497 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
500 memcpy(&(ctx->buf[i]), in, inl);
506 memcpy(&(ctx->buf[i]), in, j);
509 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
519 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
525 memcpy(ctx->buf, &(in[inl]), i);
531 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
532 const unsigned char *in, int inl)
538 /* Prevent accidental use of decryption context when encrypting */
540 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
544 if (ctx->cipher == NULL) {
545 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
549 if (ctx->cipher->prov == NULL)
552 blocksize = EVP_CIPHER_CTX_block_size(ctx);
554 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
555 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
558 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
559 inl + (blocksize == 1 ? 0 : blocksize), in,
563 if (soutl > INT_MAX) {
564 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
572 /* TODO(3.0): Remove legacy code below */
575 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
578 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
581 ret = EVP_EncryptFinal_ex(ctx, out, outl);
585 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
588 unsigned int i, b, bl;
592 /* Prevent accidental use of decryption context when encrypting */
594 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
598 if (ctx->cipher == NULL) {
599 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
602 if (ctx->cipher->prov == NULL)
605 blocksize = EVP_CIPHER_CTX_block_size(ctx);
607 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
608 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
612 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
613 blocksize == 1 ? 0 : blocksize);
616 if (soutl > INT_MAX) {
617 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
625 /* TODO(3.0): Remove legacy code below */
628 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
629 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
637 b = ctx->cipher->block_size;
638 OPENSSL_assert(b <= sizeof(ctx->buf));
644 if (ctx->flags & EVP_CIPH_NO_PADDING) {
646 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
647 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
655 for (i = bl; i < b; i++)
657 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
665 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
666 const unsigned char *in, int inl)
668 int fix_len, cmpl = inl, ret;
673 /* Prevent accidental use of encryption context when decrypting */
675 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
679 if (ctx->cipher == NULL) {
680 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
683 if (ctx->cipher->prov == NULL)
686 blocksize = EVP_CIPHER_CTX_block_size(ctx);
688 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
689 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
692 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
693 inl + (blocksize == 1 ? 0 : blocksize), in,
697 if (soutl > INT_MAX) {
698 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
706 /* TODO(3.0): Remove legacy code below */
709 b = ctx->cipher->block_size;
711 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
712 cmpl = (cmpl + 7) / 8;
714 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
715 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
716 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
720 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
734 if (ctx->flags & EVP_CIPH_NO_PADDING)
735 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
737 OPENSSL_assert(b <= sizeof(ctx->final));
739 if (ctx->final_used) {
740 /* see comment about PTRDIFF_T comparison above */
741 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
742 || is_partially_overlapping(out, in, b)) {
743 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
746 memcpy(out, ctx->final, b);
752 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
756 * if we have 'decrypted' a multiple of block size, make sure we have a
757 * copy of this last block
759 if (b > 1 && !ctx->buf_len) {
762 memcpy(ctx->final, &out[*outl], b);
772 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
775 ret = EVP_DecryptFinal_ex(ctx, out, outl);
779 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
787 /* Prevent accidental use of encryption context when decrypting */
789 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
793 if (ctx->cipher == NULL) {
794 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
798 if (ctx->cipher->prov == NULL)
801 blocksize = EVP_CIPHER_CTX_block_size(ctx);
803 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
804 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
808 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
809 blocksize == 1 ? 0 : blocksize);
812 if (soutl > INT_MAX) {
813 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
821 /* TODO(3.0): Remove legacy code below */
825 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
826 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
834 b = ctx->cipher->block_size;
835 if (ctx->flags & EVP_CIPH_NO_PADDING) {
837 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
838 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
845 if (ctx->buf_len || !ctx->final_used) {
846 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
849 OPENSSL_assert(b <= sizeof(ctx->final));
852 * The following assumes that the ciphertext has been authenticated.
853 * Otherwise it provides a padding oracle.
855 n = ctx->final[b - 1];
856 if (n == 0 || n > (int)b) {
857 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
860 for (i = 0; i < n; i++) {
861 if (ctx->final[--b] != n) {
862 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
866 n = ctx->cipher->block_size - n;
867 for (i = 0; i < n; i++)
868 out[i] = ctx->final[i];
875 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
877 if (c->cipher->prov != NULL) {
879 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
882 if (EVP_CIPHER_CTX_key_length(c) == keylen)
885 /* Check the cipher actually understands this parameter */
886 if (OSSL_PARAM_locate_const(EVP_CIPHER_settable_ctx_params(c->cipher),
887 OSSL_CIPHER_PARAM_KEYLEN) == NULL)
890 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &len);
891 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
893 return ok > 0 ? 1 : 0;
896 /* TODO(3.0) legacy code follows */
899 * Note there have never been any built-in ciphers that define this flag
900 * since it was first introduced.
902 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
903 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
904 if (EVP_CIPHER_CTX_key_length(c) == keylen)
906 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
910 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
914 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
917 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
918 unsigned int pd = pad;
921 ctx->flags &= ~EVP_CIPH_NO_PADDING;
923 ctx->flags |= EVP_CIPH_NO_PADDING;
925 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING, &pd);
926 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
931 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
933 int ret = EVP_CTRL_RET_UNSUPPORTED;
937 OSSL_PARAM params[4] = {
938 OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END
941 if (ctx == NULL || ctx->cipher == NULL) {
942 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
946 if (ctx->cipher->prov == NULL)
950 case EVP_CTRL_SET_KEY_LENGTH:
951 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &sz);
953 case EVP_CTRL_RAND_KEY: /* Used by DES */
956 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
962 * TODO(3.0) EVP_CTRL_INIT is purely legacy, no provider counterpart
963 * As a matter of fact, this should be dead code, but some caller
964 * might still do a direct control call with this command, so...
965 * Legacy methods return 1 except for exceptional circumstances, so
966 * we do the same here to not be disruptive.
969 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
972 case EVP_CTRL_GET_IV:
974 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV,
977 case EVP_CTRL_AEAD_SET_IVLEN:
980 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
982 case EVP_CTRL_AEAD_SET_IV_FIXED:
983 params[0] = OSSL_PARAM_construct_octet_string(
984 OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, ptr, sz);
986 case EVP_CTRL_GCM_IV_GEN:
989 sz = 0; /* special case that uses the iv length */
990 params[0] = OSSL_PARAM_construct_octet_string(
991 OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN, ptr, sz);
993 case EVP_CTRL_GCM_SET_IV_INV:
996 params[0] = OSSL_PARAM_construct_octet_string(
997 OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV, ptr, sz);
999 case EVP_CTRL_GET_RC5_ROUNDS:
1000 set_params = 0; /* Fall thru */
1001 case EVP_CTRL_SET_RC5_ROUNDS:
1004 i = (unsigned int)arg;
1005 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_ROUNDS, &i);
1007 case EVP_CTRL_SET_SPEED:
1010 i = (unsigned int)arg;
1011 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_SPEED, &i);
1013 case EVP_CTRL_AEAD_GET_TAG:
1014 set_params = 0; /* Fall thru */
1015 case EVP_CTRL_AEAD_SET_TAG:
1016 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1019 case EVP_CTRL_AEAD_TLS1_AAD:
1020 /* This one does a set and a get - since it returns a size */
1022 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1024 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1028 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1029 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1033 #ifndef OPENSSL_NO_RC2
1034 case EVP_CTRL_GET_RC2_KEY_BITS:
1035 set_params = 0; /* Fall thru */
1036 case EVP_CTRL_SET_RC2_KEY_BITS:
1037 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, &sz);
1039 #endif /* OPENSSL_NO_RC2 */
1040 #if !defined(OPENSSL_NO_MULTIBLOCK)
1041 case EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE:
1042 params[0] = OSSL_PARAM_construct_size_t(
1043 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT, &sz);
1044 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1048 params[0] = OSSL_PARAM_construct_size_t(
1049 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE, &sz);
1050 params[1] = OSSL_PARAM_construct_end();
1051 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1055 case EVP_CTRL_TLS1_1_MULTIBLOCK_AAD: {
1056 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *p =
1057 (EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *)ptr;
1059 if (arg < (int)sizeof(EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM))
1062 params[0] = OSSL_PARAM_construct_octet_string(
1063 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD, (void*)p->inp, p->len);
1064 params[1] = OSSL_PARAM_construct_uint(
1065 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1066 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1069 /* Retrieve the return values changed by the set */
1070 params[0] = OSSL_PARAM_construct_size_t(
1071 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN, &sz);
1072 params[1] = OSSL_PARAM_construct_uint(
1073 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1074 params[2] = OSSL_PARAM_construct_end();
1075 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1080 case EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT: {
1081 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *p =
1082 (EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *)ptr;
1084 params[0] = OSSL_PARAM_construct_octet_string(
1085 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC, p->out, p->len);
1087 params[1] = OSSL_PARAM_construct_octet_string(
1088 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN, (void*)p->inp,
1090 params[2] = OSSL_PARAM_construct_uint(
1091 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1092 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1095 params[0] = OSSL_PARAM_construct_size_t(
1096 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN, &sz);
1097 params[1] = OSSL_PARAM_construct_end();
1098 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1103 #endif /* OPENSSL_NO_MULTIBLOCK */
1104 case EVP_CTRL_AEAD_SET_MAC_KEY:
1107 params[0] = OSSL_PARAM_construct_octet_string(
1108 OSSL_CIPHER_PARAM_AEAD_MAC_KEY, ptr, sz);
1113 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1115 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1118 /* TODO(3.0): Remove legacy code below */
1120 if (ctx->cipher->ctrl == NULL) {
1121 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1125 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1128 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1129 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1130 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1136 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1138 if (cipher != NULL && cipher->get_params != NULL)
1139 return cipher->get_params(params);
1143 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1145 if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1146 return ctx->cipher->set_ctx_params(ctx->provctx, params);
1150 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1152 if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1153 return ctx->cipher->get_ctx_params(ctx->provctx, params);
1157 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1159 if (cipher != NULL && cipher->gettable_params != NULL)
1160 return cipher->gettable_params();
1164 const OSSL_PARAM *EVP_CIPHER_settable_ctx_params(const EVP_CIPHER *cipher)
1166 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1167 return cipher->settable_ctx_params();
1171 const OSSL_PARAM *EVP_CIPHER_gettable_ctx_params(const EVP_CIPHER *cipher)
1173 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1174 return cipher->gettable_ctx_params();
1178 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1180 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1181 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1189 kl = EVP_CIPHER_CTX_key_length(ctx);
1190 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
1194 #endif /* FIPS_MODULE */
1197 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1199 if ((in == NULL) || (in->cipher == NULL)) {
1200 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1204 if (in->cipher->prov == NULL)
1207 if (in->cipher->dupctx == NULL) {
1208 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1212 EVP_CIPHER_CTX_reset(out);
1215 out->provctx = NULL;
1217 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1218 out->fetched_cipher = NULL;
1222 out->provctx = in->cipher->dupctx(in->provctx);
1223 if (out->provctx == NULL) {
1224 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1230 /* TODO(3.0): Remove legacy code below */
1233 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
1234 /* Make sure it's safe to copy a cipher context using an ENGINE */
1235 if (in->engine && !ENGINE_init(in->engine)) {
1236 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1241 EVP_CIPHER_CTX_reset(out);
1242 memcpy(out, in, sizeof(*out));
1244 if (in->cipher_data && in->cipher->ctx_size) {
1245 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1246 if (out->cipher_data == NULL) {
1248 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1251 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1254 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1255 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1257 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1263 EVP_CIPHER *evp_cipher_new(void)
1265 EVP_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_CIPHER));
1267 if (cipher != NULL) {
1268 cipher->lock = CRYPTO_THREAD_lock_new();
1269 if (cipher->lock == NULL) {
1270 OPENSSL_free(cipher);
1279 * FIPS module note: since internal fetches will be entirely
1280 * provider based, we know that none of its code depends on legacy
1281 * NIDs or any functionality that use them.
1284 /* TODO(3.x) get rid of the need for legacy NIDs */
1285 static void set_legacy_nid(const char *name, void *vlegacy_nid)
1288 int *legacy_nid = vlegacy_nid;
1290 * We use lowest level function to get the associated method, because
1291 * higher level functions such as EVP_get_cipherbyname() have changed
1292 * to look at providers too.
1294 const void *legacy_method = OBJ_NAME_get(name, OBJ_NAME_TYPE_CIPHER_METH);
1296 if (*legacy_nid == -1) /* We found a clash already */
1298 if (legacy_method == NULL)
1300 nid = EVP_CIPHER_nid(legacy_method);
1301 if (*legacy_nid != NID_undef && *legacy_nid != nid) {
1309 static void *evp_cipher_from_dispatch(const int name_id,
1310 const OSSL_DISPATCH *fns,
1311 OSSL_PROVIDER *prov)
1313 EVP_CIPHER *cipher = NULL;
1314 int fnciphcnt = 0, fnctxcnt = 0;
1316 if ((cipher = evp_cipher_new()) == NULL) {
1317 EVPerr(0, ERR_R_MALLOC_FAILURE);
1322 /* TODO(3.x) get rid of the need for legacy NIDs */
1323 cipher->nid = NID_undef;
1324 evp_names_do_all(prov, name_id, set_legacy_nid, &cipher->nid);
1325 if (cipher->nid == -1) {
1326 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1327 EVP_CIPHER_free(cipher);
1332 cipher->name_id = name_id;
1334 for (; fns->function_id != 0; fns++) {
1335 switch (fns->function_id) {
1336 case OSSL_FUNC_CIPHER_NEWCTX:
1337 if (cipher->newctx != NULL)
1339 cipher->newctx = OSSL_FUNC_cipher_newctx(fns);
1342 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1343 if (cipher->einit != NULL)
1345 cipher->einit = OSSL_FUNC_cipher_encrypt_init(fns);
1348 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1349 if (cipher->dinit != NULL)
1351 cipher->dinit = OSSL_FUNC_cipher_decrypt_init(fns);
1354 case OSSL_FUNC_CIPHER_UPDATE:
1355 if (cipher->cupdate != NULL)
1357 cipher->cupdate = OSSL_FUNC_cipher_update(fns);
1360 case OSSL_FUNC_CIPHER_FINAL:
1361 if (cipher->cfinal != NULL)
1363 cipher->cfinal = OSSL_FUNC_cipher_final(fns);
1366 case OSSL_FUNC_CIPHER_CIPHER:
1367 if (cipher->ccipher != NULL)
1369 cipher->ccipher = OSSL_FUNC_cipher_cipher(fns);
1371 case OSSL_FUNC_CIPHER_FREECTX:
1372 if (cipher->freectx != NULL)
1374 cipher->freectx = OSSL_FUNC_cipher_freectx(fns);
1377 case OSSL_FUNC_CIPHER_DUPCTX:
1378 if (cipher->dupctx != NULL)
1380 cipher->dupctx = OSSL_FUNC_cipher_dupctx(fns);
1382 case OSSL_FUNC_CIPHER_GET_PARAMS:
1383 if (cipher->get_params != NULL)
1385 cipher->get_params = OSSL_FUNC_cipher_get_params(fns);
1387 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1388 if (cipher->get_ctx_params != NULL)
1390 cipher->get_ctx_params = OSSL_FUNC_cipher_get_ctx_params(fns);
1392 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1393 if (cipher->set_ctx_params != NULL)
1395 cipher->set_ctx_params = OSSL_FUNC_cipher_set_ctx_params(fns);
1397 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1398 if (cipher->gettable_params != NULL)
1400 cipher->gettable_params = OSSL_FUNC_cipher_gettable_params(fns);
1402 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1403 if (cipher->gettable_ctx_params != NULL)
1405 cipher->gettable_ctx_params =
1406 OSSL_FUNC_cipher_gettable_ctx_params(fns);
1408 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1409 if (cipher->settable_ctx_params != NULL)
1411 cipher->settable_ctx_params =
1412 OSSL_FUNC_cipher_settable_ctx_params(fns);
1416 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1417 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1420 * In order to be a consistent set of functions we must have at least
1421 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1422 * functions, or a single "cipher" function. In all cases we need both
1423 * the "newctx" and "freectx" functions.
1425 EVP_CIPHER_free(cipher);
1426 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1429 cipher->prov = prov;
1431 ossl_provider_up_ref(prov);
1436 static int evp_cipher_up_ref(void *cipher)
1438 return EVP_CIPHER_up_ref(cipher);
1441 static void evp_cipher_free(void *cipher)
1443 EVP_CIPHER_free(cipher);
1446 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1447 const char *properties)
1449 EVP_CIPHER *cipher =
1450 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1451 evp_cipher_from_dispatch, evp_cipher_up_ref,
1454 if (cipher != NULL && !evp_cipher_cache_constants(cipher)) {
1455 EVP_CIPHER_free(cipher);
1461 int EVP_CIPHER_up_ref(EVP_CIPHER *cipher)
1465 CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
1469 void EVP_CIPHER_free(EVP_CIPHER *cipher)
1476 CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
1479 ossl_provider_free(cipher->prov);
1480 CRYPTO_THREAD_lock_free(cipher->lock);
1481 OPENSSL_free(cipher);
1484 void EVP_CIPHER_do_all_provided(OPENSSL_CTX *libctx,
1485 void (*fn)(EVP_CIPHER *mac, void *arg),
1488 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1489 (void (*)(void *, void *))fn, arg,
1490 evp_cipher_from_dispatch, evp_cipher_free);