2 * Copyright 1995-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
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 "internal/evp_int.h"
21 #include "internal/provider.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_meth_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_MODE)
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_MODE)
85 ENGINE *tmpimpl = NULL;
87 const EVP_CIPHER *tmpcipher;
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_MODE)
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_MODE)
134 if (ctx->cipher == ctx->fetched_cipher)
136 EVP_CIPHER_meth_free(ctx->fetched_cipher);
137 ctx->fetched_cipher = NULL;
141 tmpcipher = (cipher == NULL) ? ctx->cipher : cipher;
143 if (tmpcipher->prov == NULL) {
144 switch(tmpcipher->nid) {
145 case NID_aes_256_ecb:
146 case NID_aes_192_ecb:
147 case NID_aes_128_ecb:
148 case NID_aes_256_cbc:
149 case NID_aes_192_cbc:
150 case NID_aes_128_cbc:
151 case NID_aes_256_ofb128:
152 case NID_aes_192_ofb128:
153 case NID_aes_128_ofb128:
154 case NID_aes_256_cfb128:
155 case NID_aes_192_cfb128:
156 case NID_aes_128_cfb128:
157 case NID_aes_256_cfb1:
158 case NID_aes_192_cfb1:
159 case NID_aes_128_cfb1:
160 case NID_aes_256_cfb8:
161 case NID_aes_192_cfb8:
162 case NID_aes_128_cfb8:
163 case NID_aes_256_ctr:
164 case NID_aes_192_ctr:
165 case NID_aes_128_ctr:
166 case NID_aes_256_gcm:
167 case NID_aes_192_gcm:
168 case NID_aes_128_gcm:
169 case NID_aria_256_gcm:
170 case NID_aria_192_gcm:
171 case NID_aria_128_gcm:
172 case NID_aes_256_ccm:
173 case NID_aes_192_ccm:
174 case NID_aes_128_ccm:
175 case NID_aria_256_ccm:
176 case NID_aria_192_ccm:
177 case NID_aria_128_ccm:
178 case NID_aria_256_ecb:
179 case NID_aria_192_ecb:
180 case NID_aria_128_ecb:
181 case NID_aria_256_cbc:
182 case NID_aria_192_cbc:
183 case NID_aria_128_cbc:
184 case NID_aria_256_ofb128:
185 case NID_aria_192_ofb128:
186 case NID_aria_128_ofb128:
187 case NID_aria_256_cfb128:
188 case NID_aria_192_cfb128:
189 case NID_aria_128_cfb128:
190 case NID_aria_256_cfb1:
191 case NID_aria_192_cfb1:
192 case NID_aria_128_cfb1:
193 case NID_aria_256_cfb8:
194 case NID_aria_192_cfb8:
195 case NID_aria_128_cfb8:
196 case NID_aria_256_ctr:
197 case NID_aria_192_ctr:
198 case NID_aria_128_ctr:
199 case NID_camellia_256_ecb:
200 case NID_camellia_192_ecb:
201 case NID_camellia_128_ecb:
202 case NID_camellia_256_cbc:
203 case NID_camellia_192_cbc:
204 case NID_camellia_128_cbc:
205 case NID_camellia_256_ofb128:
206 case NID_camellia_192_ofb128:
207 case NID_camellia_128_ofb128:
208 case NID_camellia_256_cfb128:
209 case NID_camellia_192_cfb128:
210 case NID_camellia_128_cfb128:
211 case NID_camellia_256_cfb1:
212 case NID_camellia_192_cfb1:
213 case NID_camellia_128_cfb1:
214 case NID_camellia_256_cfb8:
215 case NID_camellia_192_cfb8:
216 case NID_camellia_128_cfb8:
217 case NID_camellia_256_ctr:
218 case NID_camellia_192_ctr:
219 case NID_camellia_128_ctr:
220 case NID_des_ede3_cbc:
221 case NID_des_ede3_ecb:
222 case NID_des_ede3_ofb64:
223 case NID_des_ede3_cfb64:
224 case NID_des_ede3_cfb8:
225 case NID_des_ede3_cfb1:
226 case NID_des_ede_cbc:
227 case NID_des_ede_ecb:
228 case NID_des_ede_ofb64:
229 case NID_des_ede_cfb64:
231 case NID_id_smime_alg_CMS3DESwrap:
239 * Ensure a context left lying around from last time is cleared
242 if (cipher != NULL && ctx->cipher != NULL) {
243 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
244 ctx->cipher_data = NULL;
248 /* TODO(3.0): Start of non-legacy code below */
250 /* Ensure a context left lying around from last time is cleared */
251 if (cipher != NULL && ctx->cipher != NULL) {
252 unsigned long flags = ctx->flags;
254 EVP_CIPHER_CTX_reset(ctx);
255 /* Restore encrypt and flags */
261 cipher = ctx->cipher;
263 if (cipher->prov == NULL) {
265 /* We only do explict fetches inside the FIPS module */
266 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
269 EVP_CIPHER *provciph =
270 EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
272 if (provciph == NULL) {
273 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
277 EVP_CIPHER_meth_free(ctx->fetched_cipher);
278 ctx->fetched_cipher = provciph;
282 ctx->cipher = cipher;
283 if (ctx->provctx == NULL) {
284 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
285 if (ctx->provctx == NULL) {
286 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
291 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
293 * If this ctx was already set up for no padding then we need to tell
294 * the new cipher about it.
296 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
300 switch (EVP_CIPHER_mode(ctx->cipher)) {
301 case EVP_CIPH_CFB_MODE:
302 case EVP_CIPH_OFB_MODE:
303 case EVP_CIPH_CBC_MODE:
304 /* For these modes we remember the original IV for later use */
305 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
306 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
310 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
314 if (ctx->cipher->einit == NULL) {
315 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
319 return ctx->cipher->einit(ctx->provctx,
322 : EVP_CIPHER_CTX_key_length(ctx),
325 : EVP_CIPHER_CTX_iv_length(ctx));
328 if (ctx->cipher->dinit == NULL) {
329 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
333 return ctx->cipher->dinit(ctx->provctx,
336 : EVP_CIPHER_CTX_key_length(ctx),
339 : EVP_CIPHER_CTX_iv_length(ctx));
341 /* TODO(3.0): Remove legacy code below */
344 if (cipher != NULL) {
346 * Ensure a context left lying around from last time is cleared (we
347 * previously attempted to avoid this if the same ENGINE and
348 * EVP_CIPHER could be used).
351 unsigned long flags = ctx->flags;
352 EVP_CIPHER_CTX_reset(ctx);
353 /* Restore encrypt and flags */
357 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
359 if (!ENGINE_init(impl)) {
360 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
367 /* There's an ENGINE for this job ... (apparently) */
368 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
372 * One positive side-effect of US's export control history,
373 * is that we should at least be able to avoid using US
374 * misspellings of "initialisation"?
376 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
379 /* We'll use the ENGINE's private cipher definition */
382 * Store the ENGINE functional reference so we know 'cipher' came
383 * from an ENGINE and we need to release it when done.
391 ctx->cipher = cipher;
392 if (ctx->cipher->ctx_size) {
393 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
394 if (ctx->cipher_data == NULL) {
396 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
400 ctx->cipher_data = NULL;
402 ctx->key_len = cipher->key_len;
403 /* Preserve wrap enable flag, zero everything else */
404 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
405 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
406 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
408 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
413 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
416 if (ctx->cipher == NULL)
419 /* we assume block size is a power of 2 in *cryptUpdate */
420 OPENSSL_assert(ctx->cipher->block_size == 1
421 || ctx->cipher->block_size == 8
422 || ctx->cipher->block_size == 16);
424 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
425 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
426 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
430 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
431 switch (EVP_CIPHER_CTX_mode(ctx)) {
433 case EVP_CIPH_STREAM_CIPHER:
434 case EVP_CIPH_ECB_MODE:
437 case EVP_CIPH_CFB_MODE:
438 case EVP_CIPH_OFB_MODE:
443 case EVP_CIPH_CBC_MODE:
445 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
446 (int)sizeof(ctx->iv));
448 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
449 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
452 case EVP_CIPH_CTR_MODE:
454 /* Don't reuse IV for CTR mode */
456 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
464 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
465 if (!ctx->cipher->init(ctx, key, iv, enc))
470 ctx->block_mask = ctx->cipher->block_size - 1;
474 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
475 const unsigned char *in, int inl)
478 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
480 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
483 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
486 return EVP_EncryptFinal_ex(ctx, out, outl);
488 return EVP_DecryptFinal_ex(ctx, out, outl);
491 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
494 return EVP_EncryptFinal(ctx, out, outl);
496 return EVP_DecryptFinal(ctx, out, outl);
499 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
500 const unsigned char *key, const unsigned char *iv)
502 return EVP_CipherInit(ctx, cipher, key, iv, 1);
505 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
506 ENGINE *impl, const unsigned char *key,
507 const unsigned char *iv)
509 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
512 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
513 const unsigned char *key, const unsigned char *iv)
515 return EVP_CipherInit(ctx, cipher, key, iv, 0);
518 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
519 ENGINE *impl, const unsigned char *key,
520 const unsigned char *iv)
522 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
526 * According to the letter of standard difference between pointers
527 * is specified to be valid only within same object. This makes
528 * it formally challenging to determine if input and output buffers
529 * are not partially overlapping with standard pointer arithmetic.
534 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
536 * Then we have VMS that distinguishes itself by adhering to
537 * sizeof(size_t)==4 even in 64-bit builds, which means that
538 * difference between two pointers might be truncated to 32 bits.
539 * In the context one can even wonder how comparison for
540 * equality is implemented. To be on the safe side we adhere to
541 * PTRDIFF_T even for comparison for equality.
543 # define PTRDIFF_T uint64_t
545 # define PTRDIFF_T size_t
548 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
550 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
552 * Check for partially overlapping buffers. [Binary logical
553 * operations are used instead of boolean to minimize number
554 * of conditional branches.]
556 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
557 (diff > (0 - (PTRDIFF_T)len)));
562 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
563 unsigned char *out, int *outl,
564 const unsigned char *in, int inl)
566 int i, j, bl, cmpl = inl;
568 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
569 cmpl = (cmpl + 7) / 8;
571 bl = ctx->cipher->block_size;
573 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
574 /* If block size > 1 then the cipher will have to do this check */
575 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
576 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
580 i = ctx->cipher->do_cipher(ctx, out, in, inl);
592 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
593 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
597 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
598 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
607 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
610 memcpy(&(ctx->buf[i]), in, inl);
616 memcpy(&(ctx->buf[i]), in, j);
619 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
629 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
635 memcpy(ctx->buf, &(in[inl]), i);
641 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
642 const unsigned char *in, int inl)
648 /* Prevent accidental use of decryption context when encrypting */
650 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
654 if (ctx->cipher == NULL) {
655 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
659 if (ctx->cipher->prov == NULL)
662 blocksize = EVP_CIPHER_CTX_block_size(ctx);
664 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
665 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
668 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
669 inl + (blocksize == 1 ? 0 : blocksize), in,
673 if (soutl > INT_MAX) {
674 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
682 /* TODO(3.0): Remove legacy code below */
685 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
688 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
691 ret = EVP_EncryptFinal_ex(ctx, out, outl);
695 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
698 unsigned int i, b, bl;
702 /* Prevent accidental use of decryption context when encrypting */
704 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
708 if (ctx->cipher == NULL) {
709 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
712 if (ctx->cipher->prov == NULL)
715 blocksize = EVP_CIPHER_CTX_block_size(ctx);
717 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
718 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
722 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
723 blocksize == 1 ? 0 : blocksize);
726 if (soutl > INT_MAX) {
727 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
735 /* TODO(3.0): Remove legacy code below */
738 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
739 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
747 b = ctx->cipher->block_size;
748 OPENSSL_assert(b <= sizeof(ctx->buf));
754 if (ctx->flags & EVP_CIPH_NO_PADDING) {
756 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
757 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
765 for (i = bl; i < b; i++)
767 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
775 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
776 const unsigned char *in, int inl)
778 int fix_len, cmpl = inl, ret;
783 /* Prevent accidental use of encryption context when decrypting */
785 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
789 if (ctx->cipher == NULL) {
790 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
793 if (ctx->cipher->prov == NULL)
796 blocksize = EVP_CIPHER_CTX_block_size(ctx);
798 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
799 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
802 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
803 inl + (blocksize == 1 ? 0 : blocksize), in,
807 if (soutl > INT_MAX) {
808 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
816 /* TODO(3.0): Remove legacy code below */
819 b = ctx->cipher->block_size;
821 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
822 cmpl = (cmpl + 7) / 8;
824 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
825 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
826 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
830 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
844 if (ctx->flags & EVP_CIPH_NO_PADDING)
845 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
847 OPENSSL_assert(b <= sizeof(ctx->final));
849 if (ctx->final_used) {
850 /* see comment about PTRDIFF_T comparison above */
851 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
852 || is_partially_overlapping(out, in, b)) {
853 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
856 memcpy(out, ctx->final, b);
862 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
866 * if we have 'decrypted' a multiple of block size, make sure we have a
867 * copy of this last block
869 if (b > 1 && !ctx->buf_len) {
872 memcpy(ctx->final, &out[*outl], b);
882 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
885 ret = EVP_DecryptFinal_ex(ctx, out, outl);
889 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
897 /* Prevent accidental use of encryption context when decrypting */
899 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
903 if (ctx->cipher == NULL) {
904 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
908 if (ctx->cipher->prov == NULL)
911 blocksize = EVP_CIPHER_CTX_block_size(ctx);
913 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
914 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
918 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
919 blocksize == 1 ? 0 : blocksize);
922 if (soutl > INT_MAX) {
923 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
931 /* TODO(3.0): Remove legacy code below */
935 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
936 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
944 b = ctx->cipher->block_size;
945 if (ctx->flags & EVP_CIPH_NO_PADDING) {
947 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
948 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
955 if (ctx->buf_len || !ctx->final_used) {
956 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
959 OPENSSL_assert(b <= sizeof(ctx->final));
962 * The following assumes that the ciphertext has been authenticated.
963 * Otherwise it provides a padding oracle.
965 n = ctx->final[b - 1];
966 if (n == 0 || n > (int)b) {
967 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
970 for (i = 0; i < n; i++) {
971 if (ctx->final[--b] != n) {
972 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
976 n = ctx->cipher->block_size - n;
977 for (i = 0; i < n; i++)
978 out[i] = ctx->final[i];
985 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
988 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
990 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN, &keylen);
991 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
993 if (ok != EVP_CTRL_RET_UNSUPPORTED)
996 /* TODO(3.0) legacy code follows */
997 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
998 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
999 if (EVP_CIPHER_CTX_key_length(c) == keylen)
1001 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
1002 c->key_len = keylen;
1005 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
1009 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
1012 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1015 ctx->flags &= ~EVP_CIPH_NO_PADDING;
1017 ctx->flags |= EVP_CIPH_NO_PADDING;
1019 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_PADDING, &pad);
1020 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1025 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
1027 int ret = EVP_CTRL_RET_UNSUPPORTED;
1030 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1032 if (ctx == NULL || ctx->cipher == NULL) {
1033 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
1037 if (ctx->cipher->prov == NULL)
1041 case EVP_CTRL_SET_KEY_LENGTH:
1042 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN, &arg);
1044 case EVP_CTRL_RAND_KEY: /* Used by DES */
1047 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
1051 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
1052 case EVP_CTRL_INIT: /* TODO(3.0) Purely legacy, no provider counterpart */
1054 return EVP_CTRL_RET_UNSUPPORTED;
1055 case EVP_CTRL_GET_IV:
1057 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV,
1060 case EVP_CTRL_AEAD_SET_IVLEN:
1065 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, &sz);
1067 case EVP_CTRL_GCM_SET_IV_FIXED:
1069 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED,
1072 case EVP_CTRL_AEAD_SET_TAG:
1074 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1077 case EVP_CTRL_AEAD_GET_TAG:
1079 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1082 case EVP_CTRL_AEAD_TLS1_AAD:
1083 /* This one does a set and a get - since it returns a padding size */
1085 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1087 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1091 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1092 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1099 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1101 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1104 /* TODO(3.0): Remove legacy code below */
1106 if (ctx->cipher->ctrl == NULL) {
1107 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1111 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1112 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1113 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1114 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1120 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1122 if (cipher != NULL && cipher->get_params != NULL)
1123 return cipher->get_params(params);
1127 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1129 if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1130 return ctx->cipher->set_ctx_params(ctx->provctx, params);
1134 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1136 if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1137 return ctx->cipher->get_ctx_params(ctx->provctx, params);
1141 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1143 if (cipher != NULL && cipher->gettable_params != NULL)
1144 return cipher->gettable_params();
1148 const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(const EVP_CIPHER *cipher)
1150 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1151 return cipher->settable_ctx_params();
1155 const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER *cipher)
1157 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1158 return cipher->gettable_ctx_params();
1162 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1164 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1165 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1173 kl = EVP_CIPHER_CTX_key_length(ctx);
1174 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
1178 #endif /* FIPS_MODE */
1181 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1183 if ((in == NULL) || (in->cipher == NULL)) {
1184 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1188 if (in->cipher->prov == NULL)
1191 if (in->cipher->dupctx == NULL) {
1192 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1196 EVP_CIPHER_CTX_reset(out);
1199 out->provctx = NULL;
1201 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1202 out->fetched_cipher = NULL;
1206 out->provctx = in->cipher->dupctx(in->provctx);
1207 if (out->provctx == NULL) {
1208 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1214 /* TODO(3.0): Remove legacy code below */
1217 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1218 /* Make sure it's safe to copy a cipher context using an ENGINE */
1219 if (in->engine && !ENGINE_init(in->engine)) {
1220 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1225 EVP_CIPHER_CTX_reset(out);
1226 memcpy(out, in, sizeof(*out));
1228 if (in->cipher_data && in->cipher->ctx_size) {
1229 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1230 if (out->cipher_data == NULL) {
1232 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1235 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1238 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1239 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1241 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1247 static void *evp_cipher_from_dispatch(const char *name,
1248 const OSSL_DISPATCH *fns,
1249 OSSL_PROVIDER *prov)
1251 EVP_CIPHER *cipher = NULL;
1252 int fnciphcnt = 0, fnctxcnt = 0;
1255 * The legacy NID is set by EVP_CIPHER_fetch() if the name exists in
1256 * the object database.
1258 if ((cipher = EVP_CIPHER_meth_new(0, 0, 0)) == NULL
1259 || (cipher->name = OPENSSL_strdup(name)) == NULL) {
1260 EVP_CIPHER_meth_free(cipher);
1261 EVPerr(0, ERR_R_MALLOC_FAILURE);
1265 for (; fns->function_id != 0; fns++) {
1266 switch (fns->function_id) {
1267 case OSSL_FUNC_CIPHER_NEWCTX:
1268 if (cipher->newctx != NULL)
1270 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1273 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1274 if (cipher->einit != NULL)
1276 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1279 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1280 if (cipher->dinit != NULL)
1282 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1285 case OSSL_FUNC_CIPHER_UPDATE:
1286 if (cipher->cupdate != NULL)
1288 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1291 case OSSL_FUNC_CIPHER_FINAL:
1292 if (cipher->cfinal != NULL)
1294 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1297 case OSSL_FUNC_CIPHER_CIPHER:
1298 if (cipher->ccipher != NULL)
1300 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1302 case OSSL_FUNC_CIPHER_FREECTX:
1303 if (cipher->freectx != NULL)
1305 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1308 case OSSL_FUNC_CIPHER_DUPCTX:
1309 if (cipher->dupctx != NULL)
1311 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1313 case OSSL_FUNC_CIPHER_GET_PARAMS:
1314 if (cipher->get_params != NULL)
1316 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1318 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1319 if (cipher->get_ctx_params != NULL)
1321 cipher->get_ctx_params = OSSL_get_OP_cipher_get_ctx_params(fns);
1323 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1324 if (cipher->set_ctx_params != NULL)
1326 cipher->set_ctx_params = OSSL_get_OP_cipher_set_ctx_params(fns);
1328 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1329 if (cipher->gettable_params != NULL)
1331 cipher->gettable_params = OSSL_get_OP_cipher_gettable_params(fns);
1333 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1334 if (cipher->gettable_ctx_params != NULL)
1336 cipher->gettable_ctx_params =
1337 OSSL_get_OP_cipher_gettable_ctx_params(fns);
1339 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1340 if (cipher->settable_ctx_params != NULL)
1342 cipher->settable_ctx_params =
1343 OSSL_get_OP_cipher_settable_ctx_params(fns);
1347 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1348 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1351 * In order to be a consistent set of functions we must have at least
1352 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1353 * functions, or a single "cipher" function. In all cases we need both
1354 * the "newctx" and "freectx" functions.
1356 EVP_CIPHER_meth_free(cipher);
1357 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1360 cipher->prov = prov;
1362 ossl_provider_up_ref(prov);
1367 static int evp_cipher_up_ref(void *cipher)
1369 return EVP_CIPHER_up_ref(cipher);
1372 static void evp_cipher_free(void *cipher)
1374 EVP_CIPHER_meth_free(cipher);
1377 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1378 const char *properties)
1380 EVP_CIPHER *cipher =
1381 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1382 evp_cipher_from_dispatch, evp_cipher_up_ref,
1386 /* TODO(3.x) get rid of the need for legacy NIDs */
1387 if (cipher != NULL) {
1389 * FIPS module note: since internal fetches will be entirely
1390 * provider based, we know that none of its code depends on legacy
1391 * NIDs or any functionality that use them.
1393 cipher->nid = OBJ_sn2nid(algorithm);
1400 void EVP_CIPHER_do_all_ex(OPENSSL_CTX *libctx,
1401 void (*fn)(EVP_CIPHER *mac, void *arg),
1404 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1405 (void (*)(void *, void *))fn, arg,
1406 evp_cipher_from_dispatch, evp_cipher_free);