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_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_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_128_xts:
167 case NID_aes_256_xts:
168 case NID_aes_256_gcm:
169 case NID_aes_192_gcm:
170 case NID_aes_128_gcm:
171 case NID_aria_256_gcm:
172 case NID_aria_192_gcm:
173 case NID_aria_128_gcm:
174 case NID_aes_256_ccm:
175 case NID_aes_192_ccm:
176 case NID_aes_128_ccm:
177 case NID_aria_256_ccm:
178 case NID_aria_192_ccm:
179 case NID_aria_128_ccm:
180 case NID_aria_256_ecb:
181 case NID_aria_192_ecb:
182 case NID_aria_128_ecb:
183 case NID_aria_256_cbc:
184 case NID_aria_192_cbc:
185 case NID_aria_128_cbc:
186 case NID_aria_256_ofb128:
187 case NID_aria_192_ofb128:
188 case NID_aria_128_ofb128:
189 case NID_aria_256_cfb128:
190 case NID_aria_192_cfb128:
191 case NID_aria_128_cfb128:
192 case NID_aria_256_cfb1:
193 case NID_aria_192_cfb1:
194 case NID_aria_128_cfb1:
195 case NID_aria_256_cfb8:
196 case NID_aria_192_cfb8:
197 case NID_aria_128_cfb8:
198 case NID_aria_256_ctr:
199 case NID_aria_192_ctr:
200 case NID_aria_128_ctr:
201 case NID_camellia_256_ecb:
202 case NID_camellia_192_ecb:
203 case NID_camellia_128_ecb:
204 case NID_camellia_256_cbc:
205 case NID_camellia_192_cbc:
206 case NID_camellia_128_cbc:
207 case NID_camellia_256_ofb128:
208 case NID_camellia_192_ofb128:
209 case NID_camellia_128_ofb128:
210 case NID_camellia_256_cfb128:
211 case NID_camellia_192_cfb128:
212 case NID_camellia_128_cfb128:
213 case NID_camellia_256_cfb1:
214 case NID_camellia_192_cfb1:
215 case NID_camellia_128_cfb1:
216 case NID_camellia_256_cfb8:
217 case NID_camellia_192_cfb8:
218 case NID_camellia_128_cfb8:
219 case NID_camellia_256_ctr:
220 case NID_camellia_192_ctr:
221 case NID_camellia_128_ctr:
222 case NID_des_ede3_cbc:
223 case NID_des_ede3_ecb:
224 case NID_des_ede3_ofb64:
225 case NID_des_ede3_cfb64:
226 case NID_des_ede3_cfb8:
227 case NID_des_ede3_cfb1:
228 case NID_des_ede_cbc:
229 case NID_des_ede_ecb:
230 case NID_des_ede_ofb64:
231 case NID_des_ede_cfb64:
233 case NID_id_smime_alg_CMS3DESwrap:
249 * Ensure a context left lying around from last time is cleared
252 if (cipher != NULL && ctx->cipher != NULL) {
253 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
254 ctx->cipher_data = NULL;
258 /* TODO(3.0): Start of non-legacy code below */
260 /* Ensure a context left lying around from last time is cleared */
261 if (cipher != NULL && ctx->cipher != NULL) {
262 unsigned long flags = ctx->flags;
264 EVP_CIPHER_CTX_reset(ctx);
265 /* Restore encrypt and flags */
271 cipher = ctx->cipher;
273 if (cipher->prov == NULL) {
275 /* We only do explict fetches inside the FIPS module */
276 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
279 EVP_CIPHER *provciph =
280 EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
282 if (provciph == NULL) {
283 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
287 EVP_CIPHER_free(ctx->fetched_cipher);
288 ctx->fetched_cipher = provciph;
292 ctx->cipher = cipher;
293 if (ctx->provctx == NULL) {
294 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
295 if (ctx->provctx == NULL) {
296 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
301 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
303 * If this ctx was already set up for no padding then we need to tell
304 * the new cipher about it.
306 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
310 switch (EVP_CIPHER_mode(ctx->cipher)) {
311 case EVP_CIPH_CFB_MODE:
312 case EVP_CIPH_OFB_MODE:
313 case EVP_CIPH_CBC_MODE:
314 /* For these modes we remember the original IV for later use */
315 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
316 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
320 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
324 if (ctx->cipher->einit == NULL) {
325 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
329 return ctx->cipher->einit(ctx->provctx,
332 : EVP_CIPHER_CTX_key_length(ctx),
335 : EVP_CIPHER_CTX_iv_length(ctx));
338 if (ctx->cipher->dinit == NULL) {
339 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
343 return ctx->cipher->dinit(ctx->provctx,
346 : EVP_CIPHER_CTX_key_length(ctx),
349 : EVP_CIPHER_CTX_iv_length(ctx));
351 /* TODO(3.0): Remove legacy code below */
354 if (cipher != NULL) {
356 * Ensure a context left lying around from last time is cleared (we
357 * previously attempted to avoid this if the same ENGINE and
358 * EVP_CIPHER could be used).
361 unsigned long flags = ctx->flags;
362 EVP_CIPHER_CTX_reset(ctx);
363 /* Restore encrypt and flags */
367 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
369 if (!ENGINE_init(impl)) {
370 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
377 /* There's an ENGINE for this job ... (apparently) */
378 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
382 * One positive side-effect of US's export control history,
383 * is that we should at least be able to avoid using US
384 * misspellings of "initialisation"?
386 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
389 /* We'll use the ENGINE's private cipher definition */
392 * Store the ENGINE functional reference so we know 'cipher' came
393 * from an ENGINE and we need to release it when done.
401 ctx->cipher = cipher;
402 if (ctx->cipher->ctx_size) {
403 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
404 if (ctx->cipher_data == NULL) {
406 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
410 ctx->cipher_data = NULL;
412 ctx->key_len = cipher->key_len;
413 /* Preserve wrap enable flag, zero everything else */
414 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
415 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
416 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
418 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
423 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
426 if (ctx->cipher == NULL)
429 /* we assume block size is a power of 2 in *cryptUpdate */
430 OPENSSL_assert(ctx->cipher->block_size == 1
431 || ctx->cipher->block_size == 8
432 || ctx->cipher->block_size == 16);
434 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
435 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
436 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
440 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
441 switch (EVP_CIPHER_CTX_mode(ctx)) {
443 case EVP_CIPH_STREAM_CIPHER:
444 case EVP_CIPH_ECB_MODE:
447 case EVP_CIPH_CFB_MODE:
448 case EVP_CIPH_OFB_MODE:
453 case EVP_CIPH_CBC_MODE:
455 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
456 (int)sizeof(ctx->iv));
458 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
459 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
462 case EVP_CIPH_CTR_MODE:
464 /* Don't reuse IV for CTR mode */
466 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
474 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
475 if (!ctx->cipher->init(ctx, key, iv, enc))
480 ctx->block_mask = ctx->cipher->block_size - 1;
484 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
485 const unsigned char *in, int inl)
488 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
490 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
493 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
496 return EVP_EncryptFinal_ex(ctx, out, outl);
498 return EVP_DecryptFinal_ex(ctx, out, outl);
501 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
504 return EVP_EncryptFinal(ctx, out, outl);
506 return EVP_DecryptFinal(ctx, out, outl);
509 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
510 const unsigned char *key, const unsigned char *iv)
512 return EVP_CipherInit(ctx, cipher, key, iv, 1);
515 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
516 ENGINE *impl, const unsigned char *key,
517 const unsigned char *iv)
519 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
522 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
523 const unsigned char *key, const unsigned char *iv)
525 return EVP_CipherInit(ctx, cipher, key, iv, 0);
528 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
529 ENGINE *impl, const unsigned char *key,
530 const unsigned char *iv)
532 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
536 * According to the letter of standard difference between pointers
537 * is specified to be valid only within same object. This makes
538 * it formally challenging to determine if input and output buffers
539 * are not partially overlapping with standard pointer arithmetic.
544 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
546 * Then we have VMS that distinguishes itself by adhering to
547 * sizeof(size_t)==4 even in 64-bit builds, which means that
548 * difference between two pointers might be truncated to 32 bits.
549 * In the context one can even wonder how comparison for
550 * equality is implemented. To be on the safe side we adhere to
551 * PTRDIFF_T even for comparison for equality.
553 # define PTRDIFF_T uint64_t
555 # define PTRDIFF_T size_t
558 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
560 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
562 * Check for partially overlapping buffers. [Binary logical
563 * operations are used instead of boolean to minimize number
564 * of conditional branches.]
566 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
567 (diff > (0 - (PTRDIFF_T)len)));
572 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
573 unsigned char *out, int *outl,
574 const unsigned char *in, int inl)
576 int i, j, bl, cmpl = inl;
578 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
579 cmpl = (cmpl + 7) / 8;
581 bl = ctx->cipher->block_size;
583 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
584 /* If block size > 1 then the cipher will have to do this check */
585 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
586 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
590 i = ctx->cipher->do_cipher(ctx, out, in, inl);
602 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
603 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
607 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
608 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
617 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
620 memcpy(&(ctx->buf[i]), in, inl);
626 memcpy(&(ctx->buf[i]), in, j);
629 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
639 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
645 memcpy(ctx->buf, &(in[inl]), i);
651 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
652 const unsigned char *in, int inl)
658 /* Prevent accidental use of decryption context when encrypting */
660 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
664 if (ctx->cipher == NULL) {
665 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
669 if (ctx->cipher->prov == NULL)
672 blocksize = EVP_CIPHER_CTX_block_size(ctx);
674 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
675 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
678 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
679 inl + (blocksize == 1 ? 0 : blocksize), in,
683 if (soutl > INT_MAX) {
684 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
692 /* TODO(3.0): Remove legacy code below */
695 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
698 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
701 ret = EVP_EncryptFinal_ex(ctx, out, outl);
705 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
708 unsigned int i, b, bl;
712 /* Prevent accidental use of decryption context when encrypting */
714 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
718 if (ctx->cipher == NULL) {
719 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
722 if (ctx->cipher->prov == NULL)
725 blocksize = EVP_CIPHER_CTX_block_size(ctx);
727 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
728 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
732 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
733 blocksize == 1 ? 0 : blocksize);
736 if (soutl > INT_MAX) {
737 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
745 /* TODO(3.0): Remove legacy code below */
748 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
749 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
757 b = ctx->cipher->block_size;
758 OPENSSL_assert(b <= sizeof(ctx->buf));
764 if (ctx->flags & EVP_CIPH_NO_PADDING) {
766 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
767 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
775 for (i = bl; i < b; i++)
777 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
785 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
786 const unsigned char *in, int inl)
788 int fix_len, cmpl = inl, ret;
793 /* Prevent accidental use of encryption context when decrypting */
795 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
799 if (ctx->cipher == NULL) {
800 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
803 if (ctx->cipher->prov == NULL)
806 blocksize = EVP_CIPHER_CTX_block_size(ctx);
808 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
809 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
812 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
813 inl + (blocksize == 1 ? 0 : blocksize), in,
817 if (soutl > INT_MAX) {
818 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
826 /* TODO(3.0): Remove legacy code below */
829 b = ctx->cipher->block_size;
831 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
832 cmpl = (cmpl + 7) / 8;
834 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
835 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
836 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
840 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
854 if (ctx->flags & EVP_CIPH_NO_PADDING)
855 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
857 OPENSSL_assert(b <= sizeof(ctx->final));
859 if (ctx->final_used) {
860 /* see comment about PTRDIFF_T comparison above */
861 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
862 || is_partially_overlapping(out, in, b)) {
863 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
866 memcpy(out, ctx->final, b);
872 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
876 * if we have 'decrypted' a multiple of block size, make sure we have a
877 * copy of this last block
879 if (b > 1 && !ctx->buf_len) {
882 memcpy(ctx->final, &out[*outl], b);
892 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
895 ret = EVP_DecryptFinal_ex(ctx, out, outl);
899 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
907 /* Prevent accidental use of encryption context when decrypting */
909 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
913 if (ctx->cipher == NULL) {
914 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
918 if (ctx->cipher->prov == NULL)
921 blocksize = EVP_CIPHER_CTX_block_size(ctx);
923 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
924 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
928 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
929 blocksize == 1 ? 0 : blocksize);
932 if (soutl > INT_MAX) {
933 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
941 /* TODO(3.0): Remove legacy code below */
945 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
946 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
954 b = ctx->cipher->block_size;
955 if (ctx->flags & EVP_CIPH_NO_PADDING) {
957 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
958 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
965 if (ctx->buf_len || !ctx->final_used) {
966 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
969 OPENSSL_assert(b <= sizeof(ctx->final));
972 * The following assumes that the ciphertext has been authenticated.
973 * Otherwise it provides a padding oracle.
975 n = ctx->final[b - 1];
976 if (n == 0 || n > (int)b) {
977 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
980 for (i = 0; i < n; i++) {
981 if (ctx->final[--b] != n) {
982 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
986 n = ctx->cipher->block_size - n;
987 for (i = 0; i < n; i++)
988 out[i] = ctx->final[i];
995 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
998 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1001 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &len);
1002 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
1004 if (ok != EVP_CTRL_RET_UNSUPPORTED)
1007 /* TODO(3.0) legacy code follows */
1008 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
1009 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
1010 if (EVP_CIPHER_CTX_key_length(c) == keylen)
1012 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
1013 c->key_len = keylen;
1016 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
1020 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
1023 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1024 unsigned int pd = pad;
1027 ctx->flags &= ~EVP_CIPH_NO_PADDING;
1029 ctx->flags |= EVP_CIPH_NO_PADDING;
1031 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING, &pd);
1032 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1037 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
1039 int ret = EVP_CTRL_RET_UNSUPPORTED;
1042 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1044 if (ctx == NULL || ctx->cipher == NULL) {
1045 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
1049 if (ctx->cipher->prov == NULL)
1053 case EVP_CTRL_SET_KEY_LENGTH:
1054 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &sz);
1056 case EVP_CTRL_RAND_KEY: /* Used by DES */
1059 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
1063 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
1064 case EVP_CTRL_INIT: /* TODO(3.0) Purely legacy, no provider counterpart */
1066 return EVP_CTRL_RET_UNSUPPORTED;
1067 case EVP_CTRL_GET_IV:
1069 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV,
1072 case EVP_CTRL_AEAD_SET_IVLEN:
1075 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
1077 case EVP_CTRL_GCM_SET_IV_FIXED:
1079 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED,
1082 case EVP_CTRL_AEAD_GET_TAG:
1083 set_params = 0; /* Fall thru */
1084 case EVP_CTRL_AEAD_SET_TAG:
1085 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1088 case EVP_CTRL_AEAD_TLS1_AAD:
1089 /* This one does a set and a get - since it returns a padding size */
1091 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1093 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1097 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1098 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1105 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1107 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1110 /* TODO(3.0): Remove legacy code below */
1112 if (ctx->cipher->ctrl == NULL) {
1113 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1117 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1118 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1119 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1120 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1126 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1128 if (cipher != NULL && cipher->get_params != NULL)
1129 return cipher->get_params(params);
1133 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1135 if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1136 return ctx->cipher->set_ctx_params(ctx->provctx, params);
1140 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1142 if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1143 return ctx->cipher->get_ctx_params(ctx->provctx, params);
1147 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1149 if (cipher != NULL && cipher->gettable_params != NULL)
1150 return cipher->gettable_params();
1154 const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(const EVP_CIPHER *cipher)
1156 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1157 return cipher->settable_ctx_params();
1161 const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER *cipher)
1163 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1164 return cipher->gettable_ctx_params();
1168 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1170 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1171 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1179 kl = EVP_CIPHER_CTX_key_length(ctx);
1180 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
1184 #endif /* FIPS_MODE */
1187 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1189 if ((in == NULL) || (in->cipher == NULL)) {
1190 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1194 if (in->cipher->prov == NULL)
1197 if (in->cipher->dupctx == NULL) {
1198 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1202 EVP_CIPHER_CTX_reset(out);
1205 out->provctx = NULL;
1207 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1208 out->fetched_cipher = NULL;
1212 out->provctx = in->cipher->dupctx(in->provctx);
1213 if (out->provctx == NULL) {
1214 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1220 /* TODO(3.0): Remove legacy code below */
1223 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1224 /* Make sure it's safe to copy a cipher context using an ENGINE */
1225 if (in->engine && !ENGINE_init(in->engine)) {
1226 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1231 EVP_CIPHER_CTX_reset(out);
1232 memcpy(out, in, sizeof(*out));
1234 if (in->cipher_data && in->cipher->ctx_size) {
1235 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1236 if (out->cipher_data == NULL) {
1238 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1241 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1244 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1245 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1247 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1253 EVP_CIPHER *evp_cipher_new(void)
1255 EVP_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_CIPHER));
1257 if (cipher != NULL) {
1258 cipher->lock = CRYPTO_THREAD_lock_new();
1259 if (cipher->lock == NULL) {
1260 OPENSSL_free(cipher);
1268 static void *evp_cipher_from_dispatch(const char *name,
1269 const OSSL_DISPATCH *fns,
1270 OSSL_PROVIDER *prov,
1273 EVP_CIPHER *cipher = NULL;
1274 int fnciphcnt = 0, fnctxcnt = 0;
1276 if ((cipher = evp_cipher_new()) == NULL
1277 || (cipher->name = OPENSSL_strdup(name)) == NULL) {
1278 EVP_CIPHER_free(cipher);
1279 EVPerr(0, ERR_R_MALLOC_FAILURE);
1285 * FIPS module note: since internal fetches will be entirely
1286 * provider based, we know that none of its code depends on legacy
1287 * NIDs or any functionality that use them.
1289 * TODO(3.x) get rid of the need for legacy NIDs
1291 cipher->nid = OBJ_sn2nid(name);
1294 for (; fns->function_id != 0; fns++) {
1295 switch (fns->function_id) {
1296 case OSSL_FUNC_CIPHER_NEWCTX:
1297 if (cipher->newctx != NULL)
1299 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1302 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1303 if (cipher->einit != NULL)
1305 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1308 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1309 if (cipher->dinit != NULL)
1311 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1314 case OSSL_FUNC_CIPHER_UPDATE:
1315 if (cipher->cupdate != NULL)
1317 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1320 case OSSL_FUNC_CIPHER_FINAL:
1321 if (cipher->cfinal != NULL)
1323 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1326 case OSSL_FUNC_CIPHER_CIPHER:
1327 if (cipher->ccipher != NULL)
1329 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1331 case OSSL_FUNC_CIPHER_FREECTX:
1332 if (cipher->freectx != NULL)
1334 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1337 case OSSL_FUNC_CIPHER_DUPCTX:
1338 if (cipher->dupctx != NULL)
1340 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1342 case OSSL_FUNC_CIPHER_GET_PARAMS:
1343 if (cipher->get_params != NULL)
1345 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1347 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1348 if (cipher->get_ctx_params != NULL)
1350 cipher->get_ctx_params = OSSL_get_OP_cipher_get_ctx_params(fns);
1352 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1353 if (cipher->set_ctx_params != NULL)
1355 cipher->set_ctx_params = OSSL_get_OP_cipher_set_ctx_params(fns);
1357 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1358 if (cipher->gettable_params != NULL)
1360 cipher->gettable_params = OSSL_get_OP_cipher_gettable_params(fns);
1362 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1363 if (cipher->gettable_ctx_params != NULL)
1365 cipher->gettable_ctx_params =
1366 OSSL_get_OP_cipher_gettable_ctx_params(fns);
1368 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1369 if (cipher->settable_ctx_params != NULL)
1371 cipher->settable_ctx_params =
1372 OSSL_get_OP_cipher_settable_ctx_params(fns);
1376 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1377 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1380 * In order to be a consistent set of functions we must have at least
1381 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1382 * functions, or a single "cipher" function. In all cases we need both
1383 * the "newctx" and "freectx" functions.
1385 EVP_CIPHER_free(cipher);
1386 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1389 cipher->prov = prov;
1391 ossl_provider_up_ref(prov);
1396 static int evp_cipher_up_ref(void *cipher)
1398 return EVP_CIPHER_up_ref(cipher);
1401 static void evp_cipher_free(void *cipher)
1403 EVP_CIPHER_free(cipher);
1406 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1407 const char *properties)
1409 EVP_CIPHER *cipher =
1410 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1411 evp_cipher_from_dispatch, NULL, evp_cipher_up_ref,
1417 int EVP_CIPHER_up_ref(EVP_CIPHER *cipher)
1421 CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
1425 void EVP_CIPHER_free(EVP_CIPHER *cipher)
1432 CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
1435 ossl_provider_free(cipher->prov);
1436 OPENSSL_free(cipher->name);
1437 CRYPTO_THREAD_lock_free(cipher->lock);
1438 OPENSSL_free(cipher);
1441 void EVP_CIPHER_do_all_ex(OPENSSL_CTX *libctx,
1442 void (*fn)(EVP_CIPHER *mac, void *arg),
1445 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1446 (void (*)(void *, void *))fn, arg,
1447 evp_cipher_from_dispatch, NULL, evp_cipher_free);