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:
245 * Ensure a context left lying around from last time is cleared
248 if (cipher != NULL && ctx->cipher != NULL) {
249 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
250 ctx->cipher_data = NULL;
254 /* TODO(3.0): Start of non-legacy code below */
256 /* Ensure a context left lying around from last time is cleared */
257 if (cipher != NULL && ctx->cipher != NULL) {
258 unsigned long flags = ctx->flags;
260 EVP_CIPHER_CTX_reset(ctx);
261 /* Restore encrypt and flags */
267 cipher = ctx->cipher;
269 if (cipher->prov == NULL) {
271 /* We only do explict fetches inside the FIPS module */
272 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
275 EVP_CIPHER *provciph =
276 EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
278 if (provciph == NULL) {
279 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
283 EVP_CIPHER_free(ctx->fetched_cipher);
284 ctx->fetched_cipher = provciph;
288 ctx->cipher = cipher;
289 if (ctx->provctx == NULL) {
290 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
291 if (ctx->provctx == NULL) {
292 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
297 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
299 * If this ctx was already set up for no padding then we need to tell
300 * the new cipher about it.
302 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
306 switch (EVP_CIPHER_mode(ctx->cipher)) {
307 case EVP_CIPH_CFB_MODE:
308 case EVP_CIPH_OFB_MODE:
309 case EVP_CIPH_CBC_MODE:
310 /* For these modes we remember the original IV for later use */
311 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
312 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
316 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
320 if (ctx->cipher->einit == NULL) {
321 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
325 return ctx->cipher->einit(ctx->provctx,
328 : EVP_CIPHER_CTX_key_length(ctx),
331 : EVP_CIPHER_CTX_iv_length(ctx));
334 if (ctx->cipher->dinit == NULL) {
335 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
339 return ctx->cipher->dinit(ctx->provctx,
342 : EVP_CIPHER_CTX_key_length(ctx),
345 : EVP_CIPHER_CTX_iv_length(ctx));
347 /* TODO(3.0): Remove legacy code below */
350 if (cipher != NULL) {
352 * Ensure a context left lying around from last time is cleared (we
353 * previously attempted to avoid this if the same ENGINE and
354 * EVP_CIPHER could be used).
357 unsigned long flags = ctx->flags;
358 EVP_CIPHER_CTX_reset(ctx);
359 /* Restore encrypt and flags */
363 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
365 if (!ENGINE_init(impl)) {
366 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
373 /* There's an ENGINE for this job ... (apparently) */
374 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
378 * One positive side-effect of US's export control history,
379 * is that we should at least be able to avoid using US
380 * misspellings of "initialisation"?
382 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
385 /* We'll use the ENGINE's private cipher definition */
388 * Store the ENGINE functional reference so we know 'cipher' came
389 * from an ENGINE and we need to release it when done.
397 ctx->cipher = cipher;
398 if (ctx->cipher->ctx_size) {
399 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
400 if (ctx->cipher_data == NULL) {
402 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
406 ctx->cipher_data = NULL;
408 ctx->key_len = cipher->key_len;
409 /* Preserve wrap enable flag, zero everything else */
410 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
411 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
412 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
414 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
419 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
422 if (ctx->cipher == NULL)
425 /* we assume block size is a power of 2 in *cryptUpdate */
426 OPENSSL_assert(ctx->cipher->block_size == 1
427 || ctx->cipher->block_size == 8
428 || ctx->cipher->block_size == 16);
430 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
431 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
432 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
436 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
437 switch (EVP_CIPHER_CTX_mode(ctx)) {
439 case EVP_CIPH_STREAM_CIPHER:
440 case EVP_CIPH_ECB_MODE:
443 case EVP_CIPH_CFB_MODE:
444 case EVP_CIPH_OFB_MODE:
449 case EVP_CIPH_CBC_MODE:
451 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
452 (int)sizeof(ctx->iv));
454 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
455 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
458 case EVP_CIPH_CTR_MODE:
460 /* Don't reuse IV for CTR mode */
462 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
470 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
471 if (!ctx->cipher->init(ctx, key, iv, enc))
476 ctx->block_mask = ctx->cipher->block_size - 1;
480 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
481 const unsigned char *in, int inl)
484 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
486 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
489 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
492 return EVP_EncryptFinal_ex(ctx, out, outl);
494 return EVP_DecryptFinal_ex(ctx, out, outl);
497 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
500 return EVP_EncryptFinal(ctx, out, outl);
502 return EVP_DecryptFinal(ctx, out, outl);
505 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
506 const unsigned char *key, const unsigned char *iv)
508 return EVP_CipherInit(ctx, cipher, key, iv, 1);
511 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
512 ENGINE *impl, const unsigned char *key,
513 const unsigned char *iv)
515 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
518 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
519 const unsigned char *key, const unsigned char *iv)
521 return EVP_CipherInit(ctx, cipher, key, iv, 0);
524 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
525 ENGINE *impl, const unsigned char *key,
526 const unsigned char *iv)
528 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
532 * According to the letter of standard difference between pointers
533 * is specified to be valid only within same object. This makes
534 * it formally challenging to determine if input and output buffers
535 * are not partially overlapping with standard pointer arithmetic.
540 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
542 * Then we have VMS that distinguishes itself by adhering to
543 * sizeof(size_t)==4 even in 64-bit builds, which means that
544 * difference between two pointers might be truncated to 32 bits.
545 * In the context one can even wonder how comparison for
546 * equality is implemented. To be on the safe side we adhere to
547 * PTRDIFF_T even for comparison for equality.
549 # define PTRDIFF_T uint64_t
551 # define PTRDIFF_T size_t
554 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
556 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
558 * Check for partially overlapping buffers. [Binary logical
559 * operations are used instead of boolean to minimize number
560 * of conditional branches.]
562 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
563 (diff > (0 - (PTRDIFF_T)len)));
568 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
569 unsigned char *out, int *outl,
570 const unsigned char *in, int inl)
572 int i, j, bl, cmpl = inl;
574 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
575 cmpl = (cmpl + 7) / 8;
577 bl = ctx->cipher->block_size;
579 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
580 /* If block size > 1 then the cipher will have to do this check */
581 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
582 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
586 i = ctx->cipher->do_cipher(ctx, out, in, inl);
598 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
599 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
603 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
604 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
613 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
616 memcpy(&(ctx->buf[i]), in, inl);
622 memcpy(&(ctx->buf[i]), in, j);
625 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
635 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
641 memcpy(ctx->buf, &(in[inl]), i);
647 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
648 const unsigned char *in, int inl)
654 /* Prevent accidental use of decryption context when encrypting */
656 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
660 if (ctx->cipher == NULL) {
661 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
665 if (ctx->cipher->prov == NULL)
668 blocksize = EVP_CIPHER_CTX_block_size(ctx);
670 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
671 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
674 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
675 inl + (blocksize == 1 ? 0 : blocksize), in,
679 if (soutl > INT_MAX) {
680 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
688 /* TODO(3.0): Remove legacy code below */
691 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
694 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
697 ret = EVP_EncryptFinal_ex(ctx, out, outl);
701 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
704 unsigned int i, b, bl;
708 /* Prevent accidental use of decryption context when encrypting */
710 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
714 if (ctx->cipher == NULL) {
715 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
718 if (ctx->cipher->prov == NULL)
721 blocksize = EVP_CIPHER_CTX_block_size(ctx);
723 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
724 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
728 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
729 blocksize == 1 ? 0 : blocksize);
732 if (soutl > INT_MAX) {
733 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
741 /* TODO(3.0): Remove legacy code below */
744 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
745 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
753 b = ctx->cipher->block_size;
754 OPENSSL_assert(b <= sizeof(ctx->buf));
760 if (ctx->flags & EVP_CIPH_NO_PADDING) {
762 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
763 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
771 for (i = bl; i < b; i++)
773 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
781 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
782 const unsigned char *in, int inl)
784 int fix_len, cmpl = inl, ret;
789 /* Prevent accidental use of encryption context when decrypting */
791 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
795 if (ctx->cipher == NULL) {
796 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
799 if (ctx->cipher->prov == NULL)
802 blocksize = EVP_CIPHER_CTX_block_size(ctx);
804 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
805 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
808 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
809 inl + (blocksize == 1 ? 0 : blocksize), in,
813 if (soutl > INT_MAX) {
814 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
822 /* TODO(3.0): Remove legacy code below */
825 b = ctx->cipher->block_size;
827 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
828 cmpl = (cmpl + 7) / 8;
830 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
831 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
832 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
836 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
850 if (ctx->flags & EVP_CIPH_NO_PADDING)
851 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
853 OPENSSL_assert(b <= sizeof(ctx->final));
855 if (ctx->final_used) {
856 /* see comment about PTRDIFF_T comparison above */
857 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
858 || is_partially_overlapping(out, in, b)) {
859 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
862 memcpy(out, ctx->final, b);
868 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
872 * if we have 'decrypted' a multiple of block size, make sure we have a
873 * copy of this last block
875 if (b > 1 && !ctx->buf_len) {
878 memcpy(ctx->final, &out[*outl], b);
888 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
891 ret = EVP_DecryptFinal_ex(ctx, out, outl);
895 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
903 /* Prevent accidental use of encryption context when decrypting */
905 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
909 if (ctx->cipher == NULL) {
910 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
914 if (ctx->cipher->prov == NULL)
917 blocksize = EVP_CIPHER_CTX_block_size(ctx);
919 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
920 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
924 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
925 blocksize == 1 ? 0 : blocksize);
928 if (soutl > INT_MAX) {
929 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
937 /* TODO(3.0): Remove legacy code below */
941 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
942 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
950 b = ctx->cipher->block_size;
951 if (ctx->flags & EVP_CIPH_NO_PADDING) {
953 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
954 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
961 if (ctx->buf_len || !ctx->final_used) {
962 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
965 OPENSSL_assert(b <= sizeof(ctx->final));
968 * The following assumes that the ciphertext has been authenticated.
969 * Otherwise it provides a padding oracle.
971 n = ctx->final[b - 1];
972 if (n == 0 || n > (int)b) {
973 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
976 for (i = 0; i < n; i++) {
977 if (ctx->final[--b] != n) {
978 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
982 n = ctx->cipher->block_size - n;
983 for (i = 0; i < n; i++)
984 out[i] = ctx->final[i];
991 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
994 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
997 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &len);
998 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
1000 if (ok != EVP_CTRL_RET_UNSUPPORTED)
1003 /* TODO(3.0) legacy code follows */
1004 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
1005 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
1006 if (EVP_CIPHER_CTX_key_length(c) == keylen)
1008 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
1009 c->key_len = keylen;
1012 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
1016 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
1019 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1020 unsigned int pd = pad;
1023 ctx->flags &= ~EVP_CIPH_NO_PADDING;
1025 ctx->flags |= EVP_CIPH_NO_PADDING;
1027 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING, &pd);
1028 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1033 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
1035 int ret = EVP_CTRL_RET_UNSUPPORTED;
1038 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1040 if (ctx == NULL || ctx->cipher == NULL) {
1041 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
1045 if (ctx->cipher->prov == NULL)
1049 case EVP_CTRL_SET_KEY_LENGTH:
1050 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &sz);
1052 case EVP_CTRL_RAND_KEY: /* Used by DES */
1055 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
1059 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
1060 case EVP_CTRL_INIT: /* TODO(3.0) Purely legacy, no provider counterpart */
1062 return EVP_CTRL_RET_UNSUPPORTED;
1063 case EVP_CTRL_GET_IV:
1065 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV,
1068 case EVP_CTRL_AEAD_SET_IVLEN:
1071 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
1073 case EVP_CTRL_GCM_SET_IV_FIXED:
1075 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED,
1078 case EVP_CTRL_AEAD_GET_TAG:
1079 set_params = 0; /* Fall thru */
1080 case EVP_CTRL_AEAD_SET_TAG:
1081 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1084 case EVP_CTRL_AEAD_TLS1_AAD:
1085 /* This one does a set and a get - since it returns a padding size */
1087 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1089 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1093 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1094 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1101 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1103 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1106 /* TODO(3.0): Remove legacy code below */
1108 if (ctx->cipher->ctrl == NULL) {
1109 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1113 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1114 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1115 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1116 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1122 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1124 if (cipher != NULL && cipher->get_params != NULL)
1125 return cipher->get_params(params);
1129 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1131 if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1132 return ctx->cipher->set_ctx_params(ctx->provctx, params);
1136 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1138 if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1139 return ctx->cipher->get_ctx_params(ctx->provctx, params);
1143 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1145 if (cipher != NULL && cipher->gettable_params != NULL)
1146 return cipher->gettable_params();
1150 const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(const EVP_CIPHER *cipher)
1152 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1153 return cipher->settable_ctx_params();
1157 const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER *cipher)
1159 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1160 return cipher->gettable_ctx_params();
1164 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1166 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1167 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1175 kl = EVP_CIPHER_CTX_key_length(ctx);
1176 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
1180 #endif /* FIPS_MODE */
1183 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1185 if ((in == NULL) || (in->cipher == NULL)) {
1186 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1190 if (in->cipher->prov == NULL)
1193 if (in->cipher->dupctx == NULL) {
1194 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1198 EVP_CIPHER_CTX_reset(out);
1201 out->provctx = NULL;
1203 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1204 out->fetched_cipher = NULL;
1208 out->provctx = in->cipher->dupctx(in->provctx);
1209 if (out->provctx == NULL) {
1210 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1216 /* TODO(3.0): Remove legacy code below */
1219 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1220 /* Make sure it's safe to copy a cipher context using an ENGINE */
1221 if (in->engine && !ENGINE_init(in->engine)) {
1222 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1227 EVP_CIPHER_CTX_reset(out);
1228 memcpy(out, in, sizeof(*out));
1230 if (in->cipher_data && in->cipher->ctx_size) {
1231 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1232 if (out->cipher_data == NULL) {
1234 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1237 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1240 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1241 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1243 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1249 EVP_CIPHER *evp_cipher_new(void)
1251 EVP_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_CIPHER));
1253 if (cipher != NULL) {
1254 cipher->lock = CRYPTO_THREAD_lock_new();
1255 if (cipher->lock == NULL) {
1256 OPENSSL_free(cipher);
1264 static void *evp_cipher_from_dispatch(const char *name,
1265 const OSSL_DISPATCH *fns,
1266 OSSL_PROVIDER *prov,
1269 EVP_CIPHER *cipher = NULL;
1270 int fnciphcnt = 0, fnctxcnt = 0;
1272 if ((cipher = evp_cipher_new()) == NULL
1273 || (cipher->name = OPENSSL_strdup(name)) == NULL) {
1274 EVP_CIPHER_free(cipher);
1275 EVPerr(0, ERR_R_MALLOC_FAILURE);
1281 * FIPS module note: since internal fetches will be entirely
1282 * provider based, we know that none of its code depends on legacy
1283 * NIDs or any functionality that use them.
1285 * TODO(3.x) get rid of the need for legacy NIDs
1287 cipher->nid = OBJ_sn2nid(name);
1290 for (; fns->function_id != 0; fns++) {
1291 switch (fns->function_id) {
1292 case OSSL_FUNC_CIPHER_NEWCTX:
1293 if (cipher->newctx != NULL)
1295 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1298 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1299 if (cipher->einit != NULL)
1301 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1304 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1305 if (cipher->dinit != NULL)
1307 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1310 case OSSL_FUNC_CIPHER_UPDATE:
1311 if (cipher->cupdate != NULL)
1313 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1316 case OSSL_FUNC_CIPHER_FINAL:
1317 if (cipher->cfinal != NULL)
1319 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1322 case OSSL_FUNC_CIPHER_CIPHER:
1323 if (cipher->ccipher != NULL)
1325 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1327 case OSSL_FUNC_CIPHER_FREECTX:
1328 if (cipher->freectx != NULL)
1330 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1333 case OSSL_FUNC_CIPHER_DUPCTX:
1334 if (cipher->dupctx != NULL)
1336 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1338 case OSSL_FUNC_CIPHER_GET_PARAMS:
1339 if (cipher->get_params != NULL)
1341 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1343 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1344 if (cipher->get_ctx_params != NULL)
1346 cipher->get_ctx_params = OSSL_get_OP_cipher_get_ctx_params(fns);
1348 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1349 if (cipher->set_ctx_params != NULL)
1351 cipher->set_ctx_params = OSSL_get_OP_cipher_set_ctx_params(fns);
1353 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1354 if (cipher->gettable_params != NULL)
1356 cipher->gettable_params = OSSL_get_OP_cipher_gettable_params(fns);
1358 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1359 if (cipher->gettable_ctx_params != NULL)
1361 cipher->gettable_ctx_params =
1362 OSSL_get_OP_cipher_gettable_ctx_params(fns);
1364 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1365 if (cipher->settable_ctx_params != NULL)
1367 cipher->settable_ctx_params =
1368 OSSL_get_OP_cipher_settable_ctx_params(fns);
1372 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1373 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1376 * In order to be a consistent set of functions we must have at least
1377 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1378 * functions, or a single "cipher" function. In all cases we need both
1379 * the "newctx" and "freectx" functions.
1381 EVP_CIPHER_free(cipher);
1382 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1385 cipher->prov = prov;
1387 ossl_provider_up_ref(prov);
1392 static int evp_cipher_up_ref(void *cipher)
1394 return EVP_CIPHER_up_ref(cipher);
1397 static void evp_cipher_free(void *cipher)
1399 EVP_CIPHER_free(cipher);
1402 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1403 const char *properties)
1405 EVP_CIPHER *cipher =
1406 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1407 evp_cipher_from_dispatch, NULL, evp_cipher_up_ref,
1413 int EVP_CIPHER_up_ref(EVP_CIPHER *cipher)
1417 CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
1421 void EVP_CIPHER_free(EVP_CIPHER *cipher)
1428 CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
1431 ossl_provider_free(cipher->prov);
1432 OPENSSL_free(cipher->name);
1433 CRYPTO_THREAD_lock_free(cipher->lock);
1434 OPENSSL_free(cipher);
1437 void EVP_CIPHER_do_all_ex(OPENSSL_CTX *libctx,
1438 void (*fn)(EVP_CIPHER *mac, void *arg),
1441 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1442 (void (*)(void *, void *))fn, arg,
1443 evp_cipher_from_dispatch, NULL, evp_cipher_free);