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
10 /* We need to use some engine deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
15 #include "internal/cryptlib.h"
16 #include <openssl/evp.h>
17 #include <openssl/err.h>
18 #include <openssl/rand.h>
19 #include <openssl/engine.h>
20 #include <openssl/params.h>
21 #include <openssl/core_names.h>
22 #include "crypto/evp.h"
23 #include "internal/provider.h"
24 #include "evp_local.h"
26 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx)
31 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
34 if (ctx->provctx != NULL) {
35 if (ctx->cipher->freectx != NULL)
36 ctx->cipher->freectx(ctx->provctx);
39 if (ctx->fetched_cipher != NULL)
40 EVP_CIPHER_free(ctx->fetched_cipher);
41 memset(ctx, 0, sizeof(*ctx));
45 /* TODO(3.0): Remove legacy code below */
48 if (ctx->cipher != NULL) {
49 if (ctx->cipher->cleanup && !ctx->cipher->cleanup(ctx))
51 /* Cleanse cipher context data */
52 if (ctx->cipher_data && ctx->cipher->ctx_size)
53 OPENSSL_cleanse(ctx->cipher_data, ctx->cipher->ctx_size);
55 OPENSSL_free(ctx->cipher_data);
56 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
57 ENGINE_finish(ctx->engine);
59 memset(ctx, 0, sizeof(*ctx));
63 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
65 return OPENSSL_zalloc(sizeof(EVP_CIPHER_CTX));
68 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
70 EVP_CIPHER_CTX_reset(ctx);
74 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
75 const unsigned char *key, const unsigned char *iv, int enc)
78 EVP_CIPHER_CTX_reset(ctx);
79 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
82 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
83 ENGINE *impl, const unsigned char *key,
84 const unsigned char *iv, int enc)
86 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
87 ENGINE *tmpimpl = NULL;
90 * enc == 1 means we are encrypting.
91 * enc == 0 means we are decrypting.
92 * enc == -1 means, use the previously initialised value for encrypt/decrypt
102 if (cipher == NULL && ctx->cipher == NULL) {
103 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
107 /* TODO(3.0): Legacy work around code below. Remove this */
109 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
111 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
112 * this context may already have an ENGINE! Try to avoid releasing the
113 * previous handle, re-querying for an ENGINE, and having a
114 * reinitialisation, when it may all be unnecessary.
116 if (ctx->engine && ctx->cipher
117 && (cipher == NULL || cipher->nid == ctx->cipher->nid))
120 if (cipher != NULL && impl == NULL) {
121 /* Ask if an ENGINE is reserved for this job */
122 tmpimpl = ENGINE_get_cipher_engine(cipher->nid);
127 * If there are engines involved then we should use legacy handling for now.
129 if (ctx->engine != NULL
130 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
134 if (ctx->cipher == ctx->fetched_cipher)
136 EVP_CIPHER_free(ctx->fetched_cipher);
137 ctx->fetched_cipher = NULL;
141 * Ensure a context left lying around from last time is cleared
144 if (cipher != NULL && ctx->cipher != NULL) {
145 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
146 ctx->cipher_data = NULL;
150 /* TODO(3.0): Start of non-legacy code below */
152 /* Ensure a context left lying around from last time is cleared */
153 if (cipher != NULL && ctx->cipher != NULL) {
154 unsigned long flags = ctx->flags;
156 EVP_CIPHER_CTX_reset(ctx);
157 /* Restore encrypt and flags */
163 cipher = ctx->cipher;
165 if (cipher->prov == NULL) {
167 /* We only do explicit fetches inside the FIPS module */
168 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
171 EVP_CIPHER *provciph =
172 EVP_CIPHER_fetch(NULL,
173 cipher->nid == NID_undef ? "NULL"
174 : OBJ_nid2sn(cipher->nid),
177 if (provciph == NULL)
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)
541 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, ERR_R_PASSED_NULL_PARAMETER);
545 /* Prevent accidental use of decryption context when encrypting */
547 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
551 if (ctx->cipher == NULL) {
552 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
556 if (ctx->cipher->prov == NULL)
559 blocksize = EVP_CIPHER_CTX_block_size(ctx);
561 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
562 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
565 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
566 inl + (blocksize == 1 ? 0 : blocksize), in,
570 if (soutl > INT_MAX) {
571 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
579 /* TODO(3.0): Remove legacy code below */
582 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
585 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
588 ret = EVP_EncryptFinal_ex(ctx, out, outl);
592 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
595 unsigned int i, b, bl;
602 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, ERR_R_PASSED_NULL_PARAMETER);
606 /* Prevent accidental use of decryption context when encrypting */
608 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
612 if (ctx->cipher == NULL) {
613 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
616 if (ctx->cipher->prov == NULL)
619 blocksize = EVP_CIPHER_CTX_block_size(ctx);
621 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
622 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
626 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
627 blocksize == 1 ? 0 : blocksize);
630 if (soutl > INT_MAX) {
631 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
639 /* TODO(3.0): Remove legacy code below */
642 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
643 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
651 b = ctx->cipher->block_size;
652 OPENSSL_assert(b <= sizeof(ctx->buf));
658 if (ctx->flags & EVP_CIPH_NO_PADDING) {
660 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
661 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
669 for (i = bl; i < b; i++)
671 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
679 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
680 const unsigned char *in, int inl)
682 int fix_len, cmpl = inl, ret;
690 EVPerr(EVP_F_EVP_DECRYPTUPDATE, ERR_R_PASSED_NULL_PARAMETER);
694 /* Prevent accidental use of encryption context when decrypting */
696 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
700 if (ctx->cipher == NULL) {
701 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
704 if (ctx->cipher->prov == NULL)
707 blocksize = EVP_CIPHER_CTX_block_size(ctx);
709 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
710 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
713 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
714 inl + (blocksize == 1 ? 0 : blocksize), in,
718 if (soutl > INT_MAX) {
719 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
727 /* TODO(3.0): Remove legacy code below */
730 b = ctx->cipher->block_size;
732 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
733 cmpl = (cmpl + 7) / 8;
735 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
736 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
737 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
741 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
755 if (ctx->flags & EVP_CIPH_NO_PADDING)
756 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
758 OPENSSL_assert(b <= sizeof(ctx->final));
760 if (ctx->final_used) {
761 /* see comment about PTRDIFF_T comparison above */
762 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
763 || is_partially_overlapping(out, in, b)) {
764 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
767 memcpy(out, ctx->final, b);
773 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
777 * if we have 'decrypted' a multiple of block size, make sure we have a
778 * copy of this last block
780 if (b > 1 && !ctx->buf_len) {
783 memcpy(ctx->final, &out[*outl], b);
793 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
796 ret = EVP_DecryptFinal_ex(ctx, out, outl);
800 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
811 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, ERR_R_PASSED_NULL_PARAMETER);
815 /* Prevent accidental use of encryption context when decrypting */
817 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
821 if (ctx->cipher == NULL) {
822 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
826 if (ctx->cipher->prov == NULL)
829 blocksize = EVP_CIPHER_CTX_block_size(ctx);
831 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
832 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
836 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
837 blocksize == 1 ? 0 : blocksize);
840 if (soutl > INT_MAX) {
841 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
849 /* TODO(3.0): Remove legacy code below */
853 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
854 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
862 b = ctx->cipher->block_size;
863 if (ctx->flags & EVP_CIPH_NO_PADDING) {
865 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
866 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
873 if (ctx->buf_len || !ctx->final_used) {
874 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
877 OPENSSL_assert(b <= sizeof(ctx->final));
880 * The following assumes that the ciphertext has been authenticated.
881 * Otherwise it provides a padding oracle.
883 n = ctx->final[b - 1];
884 if (n == 0 || n > (int)b) {
885 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
888 for (i = 0; i < n; i++) {
889 if (ctx->final[--b] != n) {
890 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
894 n = ctx->cipher->block_size - n;
895 for (i = 0; i < n; i++)
896 out[i] = ctx->final[i];
903 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
905 if (c->cipher->prov != NULL) {
907 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
910 if (EVP_CIPHER_CTX_key_length(c) == keylen)
913 /* Check the cipher actually understands this parameter */
914 if (OSSL_PARAM_locate_const(EVP_CIPHER_settable_ctx_params(c->cipher),
915 OSSL_CIPHER_PARAM_KEYLEN) == NULL)
918 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &len);
919 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
921 return ok > 0 ? 1 : 0;
924 /* TODO(3.0) legacy code follows */
927 * Note there have never been any built-in ciphers that define this flag
928 * since it was first introduced.
930 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
931 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
932 if (EVP_CIPHER_CTX_key_length(c) == keylen)
934 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
938 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
942 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
945 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
946 unsigned int pd = pad;
949 ctx->flags &= ~EVP_CIPH_NO_PADDING;
951 ctx->flags |= EVP_CIPH_NO_PADDING;
953 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING, &pd);
954 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
959 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
961 int ret = EVP_CTRL_RET_UNSUPPORTED;
965 OSSL_PARAM params[4] = {
966 OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END
969 if (ctx == NULL || ctx->cipher == NULL) {
970 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
974 if (ctx->cipher->prov == NULL)
978 case EVP_CTRL_SET_KEY_LENGTH:
979 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &sz);
981 case EVP_CTRL_RAND_KEY: /* Used by DES */
984 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
990 * TODO(3.0) EVP_CTRL_INIT is purely legacy, no provider counterpart
991 * As a matter of fact, this should be dead code, but some caller
992 * might still do a direct control call with this command, so...
993 * Legacy methods return 1 except for exceptional circumstances, so
994 * we do the same here to not be disruptive.
997 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
1000 case EVP_CTRL_AEAD_SET_IVLEN:
1003 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
1005 case EVP_CTRL_AEAD_SET_IV_FIXED:
1006 params[0] = OSSL_PARAM_construct_octet_string(
1007 OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, ptr, sz);
1009 case EVP_CTRL_GCM_IV_GEN:
1012 sz = 0; /* special case that uses the iv length */
1013 params[0] = OSSL_PARAM_construct_octet_string(
1014 OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN, ptr, sz);
1016 case EVP_CTRL_GCM_SET_IV_INV:
1019 params[0] = OSSL_PARAM_construct_octet_string(
1020 OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV, ptr, sz);
1022 case EVP_CTRL_GET_RC5_ROUNDS:
1023 set_params = 0; /* Fall thru */
1024 case EVP_CTRL_SET_RC5_ROUNDS:
1027 i = (unsigned int)arg;
1028 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_ROUNDS, &i);
1030 case EVP_CTRL_SET_SPEED:
1033 i = (unsigned int)arg;
1034 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_SPEED, &i);
1036 case EVP_CTRL_AEAD_GET_TAG:
1037 set_params = 0; /* Fall thru */
1038 case EVP_CTRL_AEAD_SET_TAG:
1039 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1042 case EVP_CTRL_AEAD_TLS1_AAD:
1043 /* This one does a set and a get - since it returns a size */
1045 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1047 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1051 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1052 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1056 #ifndef OPENSSL_NO_RC2
1057 case EVP_CTRL_GET_RC2_KEY_BITS:
1058 set_params = 0; /* Fall thru */
1059 case EVP_CTRL_SET_RC2_KEY_BITS:
1060 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, &sz);
1062 #endif /* OPENSSL_NO_RC2 */
1063 #if !defined(OPENSSL_NO_MULTIBLOCK)
1064 case EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE:
1065 params[0] = OSSL_PARAM_construct_size_t(
1066 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT, &sz);
1067 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1071 params[0] = OSSL_PARAM_construct_size_t(
1072 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE, &sz);
1073 params[1] = OSSL_PARAM_construct_end();
1074 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1078 case EVP_CTRL_TLS1_1_MULTIBLOCK_AAD: {
1079 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *p =
1080 (EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *)ptr;
1082 if (arg < (int)sizeof(EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM))
1085 params[0] = OSSL_PARAM_construct_octet_string(
1086 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD, (void*)p->inp, p->len);
1087 params[1] = OSSL_PARAM_construct_uint(
1088 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1089 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1092 /* Retrieve the return values changed by the set */
1093 params[0] = OSSL_PARAM_construct_size_t(
1094 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN, &sz);
1095 params[1] = OSSL_PARAM_construct_uint(
1096 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1097 params[2] = OSSL_PARAM_construct_end();
1098 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1103 case EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT: {
1104 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *p =
1105 (EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *)ptr;
1107 params[0] = OSSL_PARAM_construct_octet_string(
1108 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC, p->out, p->len);
1110 params[1] = OSSL_PARAM_construct_octet_string(
1111 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN, (void*)p->inp,
1113 params[2] = OSSL_PARAM_construct_uint(
1114 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1115 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1118 params[0] = OSSL_PARAM_construct_size_t(
1119 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN, &sz);
1120 params[1] = OSSL_PARAM_construct_end();
1121 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1126 #endif /* OPENSSL_NO_MULTIBLOCK */
1127 case EVP_CTRL_AEAD_SET_MAC_KEY:
1130 params[0] = OSSL_PARAM_construct_octet_string(
1131 OSSL_CIPHER_PARAM_AEAD_MAC_KEY, ptr, sz);
1136 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1138 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1141 /* TODO(3.0): Remove legacy code below */
1143 if (ctx->cipher->ctrl == NULL) {
1144 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1148 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1151 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1152 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1153 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1159 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1161 if (cipher != NULL && cipher->get_params != NULL)
1162 return cipher->get_params(params);
1166 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1168 if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1169 return ctx->cipher->set_ctx_params(ctx->provctx, params);
1173 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1175 if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1176 return ctx->cipher->get_ctx_params(ctx->provctx, params);
1180 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1182 if (cipher != NULL && cipher->gettable_params != NULL)
1183 return cipher->gettable_params(
1184 ossl_provider_ctx(EVP_CIPHER_provider(cipher)));
1188 const OSSL_PARAM *EVP_CIPHER_settable_ctx_params(const EVP_CIPHER *cipher)
1190 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1191 return cipher->settable_ctx_params(
1192 ossl_provider_ctx(EVP_CIPHER_provider(cipher)));
1196 const OSSL_PARAM *EVP_CIPHER_gettable_ctx_params(const EVP_CIPHER *cipher)
1198 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1199 return cipher->gettable_ctx_params(
1200 ossl_provider_ctx(EVP_CIPHER_provider(cipher)));
1205 static OSSL_LIB_CTX *EVP_CIPHER_CTX_get_libctx(EVP_CIPHER_CTX *ctx)
1207 const EVP_CIPHER *cipher = ctx->cipher;
1208 const OSSL_PROVIDER *prov;
1213 prov = EVP_CIPHER_provider(cipher);
1214 return ossl_provider_libctx(prov);
1218 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1220 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1221 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1228 OSSL_LIB_CTX *libctx = EVP_CIPHER_CTX_get_libctx(ctx);
1230 kl = EVP_CIPHER_CTX_key_length(ctx);
1231 if (kl <= 0 || RAND_priv_bytes_ex(libctx, key, kl) <= 0)
1235 #endif /* FIPS_MODULE */
1238 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1240 if ((in == NULL) || (in->cipher == NULL)) {
1241 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1245 if (in->cipher->prov == NULL)
1248 if (in->cipher->dupctx == NULL) {
1249 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1253 EVP_CIPHER_CTX_reset(out);
1256 out->provctx = NULL;
1258 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1259 out->fetched_cipher = NULL;
1263 out->provctx = in->cipher->dupctx(in->provctx);
1264 if (out->provctx == NULL) {
1265 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1271 /* TODO(3.0): Remove legacy code below */
1274 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
1275 /* Make sure it's safe to copy a cipher context using an ENGINE */
1276 if (in->engine && !ENGINE_init(in->engine)) {
1277 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1282 EVP_CIPHER_CTX_reset(out);
1283 memcpy(out, in, sizeof(*out));
1285 if (in->cipher_data && in->cipher->ctx_size) {
1286 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1287 if (out->cipher_data == NULL) {
1289 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1292 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1295 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1296 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1298 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1304 EVP_CIPHER *evp_cipher_new(void)
1306 EVP_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_CIPHER));
1308 if (cipher != NULL) {
1309 cipher->lock = CRYPTO_THREAD_lock_new();
1310 if (cipher->lock == NULL) {
1311 OPENSSL_free(cipher);
1320 * FIPS module note: since internal fetches will be entirely
1321 * provider based, we know that none of its code depends on legacy
1322 * NIDs or any functionality that use them.
1325 /* TODO(3.x) get rid of the need for legacy NIDs */
1326 static void set_legacy_nid(const char *name, void *vlegacy_nid)
1329 int *legacy_nid = vlegacy_nid;
1331 * We use lowest level function to get the associated method, because
1332 * higher level functions such as EVP_get_cipherbyname() have changed
1333 * to look at providers too.
1335 const void *legacy_method = OBJ_NAME_get(name, OBJ_NAME_TYPE_CIPHER_METH);
1337 if (*legacy_nid == -1) /* We found a clash already */
1339 if (legacy_method == NULL)
1341 nid = EVP_CIPHER_nid(legacy_method);
1342 if (*legacy_nid != NID_undef && *legacy_nid != nid) {
1350 static void *evp_cipher_from_dispatch(const int name_id,
1351 const OSSL_DISPATCH *fns,
1352 OSSL_PROVIDER *prov)
1354 EVP_CIPHER *cipher = NULL;
1355 int fnciphcnt = 0, fnctxcnt = 0;
1357 if ((cipher = evp_cipher_new()) == NULL) {
1358 EVPerr(0, ERR_R_MALLOC_FAILURE);
1363 /* TODO(3.x) get rid of the need for legacy NIDs */
1364 cipher->nid = NID_undef;
1365 evp_names_do_all(prov, name_id, set_legacy_nid, &cipher->nid);
1366 if (cipher->nid == -1) {
1367 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1368 EVP_CIPHER_free(cipher);
1373 cipher->name_id = name_id;
1375 for (; fns->function_id != 0; fns++) {
1376 switch (fns->function_id) {
1377 case OSSL_FUNC_CIPHER_NEWCTX:
1378 if (cipher->newctx != NULL)
1380 cipher->newctx = OSSL_FUNC_cipher_newctx(fns);
1383 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1384 if (cipher->einit != NULL)
1386 cipher->einit = OSSL_FUNC_cipher_encrypt_init(fns);
1389 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1390 if (cipher->dinit != NULL)
1392 cipher->dinit = OSSL_FUNC_cipher_decrypt_init(fns);
1395 case OSSL_FUNC_CIPHER_UPDATE:
1396 if (cipher->cupdate != NULL)
1398 cipher->cupdate = OSSL_FUNC_cipher_update(fns);
1401 case OSSL_FUNC_CIPHER_FINAL:
1402 if (cipher->cfinal != NULL)
1404 cipher->cfinal = OSSL_FUNC_cipher_final(fns);
1407 case OSSL_FUNC_CIPHER_CIPHER:
1408 if (cipher->ccipher != NULL)
1410 cipher->ccipher = OSSL_FUNC_cipher_cipher(fns);
1412 case OSSL_FUNC_CIPHER_FREECTX:
1413 if (cipher->freectx != NULL)
1415 cipher->freectx = OSSL_FUNC_cipher_freectx(fns);
1418 case OSSL_FUNC_CIPHER_DUPCTX:
1419 if (cipher->dupctx != NULL)
1421 cipher->dupctx = OSSL_FUNC_cipher_dupctx(fns);
1423 case OSSL_FUNC_CIPHER_GET_PARAMS:
1424 if (cipher->get_params != NULL)
1426 cipher->get_params = OSSL_FUNC_cipher_get_params(fns);
1428 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1429 if (cipher->get_ctx_params != NULL)
1431 cipher->get_ctx_params = OSSL_FUNC_cipher_get_ctx_params(fns);
1433 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1434 if (cipher->set_ctx_params != NULL)
1436 cipher->set_ctx_params = OSSL_FUNC_cipher_set_ctx_params(fns);
1438 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1439 if (cipher->gettable_params != NULL)
1441 cipher->gettable_params = OSSL_FUNC_cipher_gettable_params(fns);
1443 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1444 if (cipher->gettable_ctx_params != NULL)
1446 cipher->gettable_ctx_params =
1447 OSSL_FUNC_cipher_gettable_ctx_params(fns);
1449 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1450 if (cipher->settable_ctx_params != NULL)
1452 cipher->settable_ctx_params =
1453 OSSL_FUNC_cipher_settable_ctx_params(fns);
1457 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1458 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1461 * In order to be a consistent set of functions we must have at least
1462 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1463 * functions, or a single "cipher" function. In all cases we need both
1464 * the "newctx" and "freectx" functions.
1466 EVP_CIPHER_free(cipher);
1467 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1470 cipher->prov = prov;
1472 ossl_provider_up_ref(prov);
1477 static int evp_cipher_up_ref(void *cipher)
1479 return EVP_CIPHER_up_ref(cipher);
1482 static void evp_cipher_free(void *cipher)
1484 EVP_CIPHER_free(cipher);
1487 EVP_CIPHER *EVP_CIPHER_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
1488 const char *properties)
1490 EVP_CIPHER *cipher =
1491 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1492 evp_cipher_from_dispatch, evp_cipher_up_ref,
1495 if (cipher != NULL && !evp_cipher_cache_constants(cipher)) {
1496 EVP_CIPHER_free(cipher);
1502 int EVP_CIPHER_up_ref(EVP_CIPHER *cipher)
1506 CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
1510 void EVP_CIPHER_free(EVP_CIPHER *cipher)
1517 CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
1520 ossl_provider_free(cipher->prov);
1521 CRYPTO_THREAD_lock_free(cipher->lock);
1522 OPENSSL_free(cipher);
1525 void EVP_CIPHER_do_all_provided(OSSL_LIB_CTX *libctx,
1526 void (*fn)(EVP_CIPHER *mac, void *arg),
1529 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1530 (void (*)(void *, void *))fn, arg,
1531 evp_cipher_from_dispatch, evp_cipher_free);