2 * Copyright 1995-2018 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 #ifndef OPENSSL_NO_ENGINE
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 EVP_CIPHER *provciph = NULL;
85 ENGINE *tmpimpl = NULL;
86 const EVP_CIPHER *tmpcipher;
89 * enc == 1 means we are encrypting.
90 * enc == 0 means we are decrypting.
91 * enc == -1 means, use the previously initialised value for encrypt/decrypt
101 if (cipher == NULL && ctx->cipher == NULL) {
102 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
106 /* TODO(3.0): Legacy work around code below. Remove this */
108 #ifndef OPENSSL_NO_ENGINE
110 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
111 * this context may already have an ENGINE! Try to avoid releasing the
112 * previous handle, re-querying for an ENGINE, and having a
113 * reinitialisation, when it may all be unnecessary.
115 if (ctx->engine && ctx->cipher
116 && (cipher == NULL || cipher->nid == ctx->cipher->nid))
119 if (cipher != NULL && impl == NULL) {
120 /* Ask if an ENGINE is reserved for this job */
121 tmpimpl = ENGINE_get_cipher_engine(cipher->nid);
126 * If there are engines involved then we should use legacy handling for now.
128 if (ctx->engine != NULL
130 || tmpimpl != NULL) {
131 if (ctx->cipher == ctx->fetched_cipher)
133 EVP_CIPHER_meth_free(ctx->fetched_cipher);
134 ctx->fetched_cipher = NULL;
138 tmpcipher = (cipher == NULL) ? ctx->cipher : cipher;
140 if (tmpcipher->prov == NULL) {
141 switch(tmpcipher->nid) {
142 case NID_aes_256_ecb:
143 case NID_aes_192_ecb:
144 case NID_aes_128_ecb:
145 case NID_aes_256_cbc:
146 case NID_aes_192_cbc:
147 case NID_aes_128_cbc:
148 case NID_aes_256_ofb128:
149 case NID_aes_192_ofb128:
150 case NID_aes_128_ofb128:
151 case NID_aes_256_cfb128:
152 case NID_aes_192_cfb128:
153 case NID_aes_128_cfb128:
154 case NID_aes_256_cfb1:
155 case NID_aes_192_cfb1:
156 case NID_aes_128_cfb1:
157 case NID_aes_256_cfb8:
158 case NID_aes_192_cfb8:
159 case NID_aes_128_cfb8:
160 case NID_aes_256_ctr:
161 case NID_aes_192_ctr:
162 case NID_aes_128_ctr:
170 * Ensure a context left lying around from last time is cleared
173 if (cipher != NULL && ctx->cipher != NULL) {
174 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
175 ctx->cipher_data = NULL;
179 /* TODO(3.0): Start of non-legacy code below */
181 /* Ensure a context left lying around from last time is cleared */
182 if (cipher != NULL && ctx->cipher != NULL) {
183 unsigned long flags = ctx->flags;
185 EVP_CIPHER_CTX_reset(ctx);
186 /* Restore encrypt and flags */
192 ctx->cipher = cipher;
194 cipher = ctx->cipher;
196 if (cipher->prov == NULL) {
197 provciph = EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
198 if (provciph == NULL) {
199 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
203 EVP_CIPHER_meth_free(ctx->fetched_cipher);
204 ctx->fetched_cipher = provciph;
207 ctx->cipher = cipher;
208 if (ctx->provctx == NULL) {
209 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
210 if (ctx->provctx == NULL) {
211 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
216 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
218 * If this ctx was already set up for no padding then we need to tell
219 * the new cipher about it.
221 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
225 switch (EVP_CIPHER_mode(ctx->cipher)) {
226 case EVP_CIPH_CFB_MODE:
227 case EVP_CIPH_OFB_MODE:
228 case EVP_CIPH_CBC_MODE:
229 /* For these modes we remember the original IV for later use */
230 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
231 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
235 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
239 if (ctx->cipher->einit == NULL) {
240 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
244 return ctx->cipher->einit(ctx->provctx,
247 : EVP_CIPHER_CTX_key_length(ctx),
250 : EVP_CIPHER_CTX_iv_length(ctx));
253 if (ctx->cipher->dinit == NULL) {
254 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
258 return ctx->cipher->dinit(ctx->provctx,
261 : EVP_CIPHER_CTX_key_length(ctx),
264 : EVP_CIPHER_CTX_iv_length(ctx));
266 /* TODO(3.0): Remove legacy code below */
269 if (cipher != NULL) {
271 * Ensure a context left lying around from last time is cleared (we
272 * previously attempted to avoid this if the same ENGINE and
273 * EVP_CIPHER could be used).
276 unsigned long flags = ctx->flags;
277 EVP_CIPHER_CTX_reset(ctx);
278 /* Restore encrypt and flags */
282 #ifndef OPENSSL_NO_ENGINE
284 if (!ENGINE_init(impl)) {
285 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
292 /* There's an ENGINE for this job ... (apparently) */
293 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
297 * One positive side-effect of US's export control history,
298 * is that we should at least be able to avoid using US
299 * misspellings of "initialisation"?
301 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
304 /* We'll use the ENGINE's private cipher definition */
307 * Store the ENGINE functional reference so we know 'cipher' came
308 * from an ENGINE and we need to release it when done.
316 ctx->cipher = cipher;
317 if (ctx->cipher->ctx_size) {
318 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
319 if (ctx->cipher_data == NULL) {
321 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
325 ctx->cipher_data = NULL;
327 ctx->key_len = cipher->key_len;
328 /* Preserve wrap enable flag, zero everything else */
329 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
330 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
331 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
333 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
338 #ifndef OPENSSL_NO_ENGINE
341 if (ctx->cipher == NULL)
344 /* we assume block size is a power of 2 in *cryptUpdate */
345 OPENSSL_assert(ctx->cipher->block_size == 1
346 || ctx->cipher->block_size == 8
347 || ctx->cipher->block_size == 16);
349 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
350 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
351 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
355 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
356 switch (EVP_CIPHER_CTX_mode(ctx)) {
358 case EVP_CIPH_STREAM_CIPHER:
359 case EVP_CIPH_ECB_MODE:
362 case EVP_CIPH_CFB_MODE:
363 case EVP_CIPH_OFB_MODE:
368 case EVP_CIPH_CBC_MODE:
370 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
371 (int)sizeof(ctx->iv));
373 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
374 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
377 case EVP_CIPH_CTR_MODE:
379 /* Don't reuse IV for CTR mode */
381 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
389 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
390 if (!ctx->cipher->init(ctx, key, iv, enc))
395 ctx->block_mask = ctx->cipher->block_size - 1;
399 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
400 const unsigned char *in, int inl)
403 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
405 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
408 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
411 return EVP_EncryptFinal_ex(ctx, out, outl);
413 return EVP_DecryptFinal_ex(ctx, out, outl);
416 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
419 return EVP_EncryptFinal(ctx, out, outl);
421 return EVP_DecryptFinal(ctx, out, outl);
424 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
425 const unsigned char *key, const unsigned char *iv)
427 return EVP_CipherInit(ctx, cipher, key, iv, 1);
430 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
431 ENGINE *impl, const unsigned char *key,
432 const unsigned char *iv)
434 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
437 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
438 const unsigned char *key, const unsigned char *iv)
440 return EVP_CipherInit(ctx, cipher, key, iv, 0);
443 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
444 ENGINE *impl, const unsigned char *key,
445 const unsigned char *iv)
447 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
451 * According to the letter of standard difference between pointers
452 * is specified to be valid only within same object. This makes
453 * it formally challenging to determine if input and output buffers
454 * are not partially overlapping with standard pointer arithmetic.
459 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
461 * Then we have VMS that distinguishes itself by adhering to
462 * sizeof(size_t)==4 even in 64-bit builds, which means that
463 * difference between two pointers might be truncated to 32 bits.
464 * In the context one can even wonder how comparison for
465 * equality is implemented. To be on the safe side we adhere to
466 * PTRDIFF_T even for comparison for equality.
468 # define PTRDIFF_T uint64_t
470 # define PTRDIFF_T size_t
473 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
475 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
477 * Check for partially overlapping buffers. [Binary logical
478 * operations are used instead of boolean to minimize number
479 * of conditional branches.]
481 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
482 (diff > (0 - (PTRDIFF_T)len)));
487 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
488 unsigned char *out, int *outl,
489 const unsigned char *in, int inl)
491 int i, j, bl, cmpl = inl;
493 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
494 cmpl = (cmpl + 7) / 8;
496 bl = ctx->cipher->block_size;
503 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
504 /* If block size > 1 then the cipher will have to do this check */
505 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
506 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
510 i = ctx->cipher->do_cipher(ctx, out, in, inl);
518 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
519 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
523 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
524 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
533 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
536 memcpy(&(ctx->buf[i]), in, inl);
542 memcpy(&(ctx->buf[i]), in, j);
545 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
555 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
561 memcpy(ctx->buf, &(in[inl]), i);
567 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
568 const unsigned char *in, int inl)
574 /* Prevent accidental use of decryption context when encrypting */
576 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
580 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
583 blocksize = EVP_CIPHER_CTX_block_size(ctx);
585 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
586 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
589 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
590 inl + (blocksize == 1 ? 0 : blocksize), in,
593 if (soutl > INT_MAX) {
594 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
600 /* TODO(3.0): Remove legacy code below */
603 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
606 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
609 ret = EVP_EncryptFinal_ex(ctx, out, outl);
613 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
616 unsigned int i, b, bl;
620 /* Prevent accidental use of decryption context when encrypting */
622 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
626 if (ctx->cipher == NULL) {
627 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
630 if (ctx->cipher->prov == NULL)
633 blocksize = EVP_CIPHER_CTX_block_size(ctx);
635 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
636 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
640 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
641 blocksize == 1 ? 0 : blocksize);
643 if (soutl > INT_MAX) {
644 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
651 /* TODO(3.0): Remove legacy code below */
654 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
655 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
663 b = ctx->cipher->block_size;
664 OPENSSL_assert(b <= sizeof(ctx->buf));
670 if (ctx->flags & EVP_CIPH_NO_PADDING) {
672 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
673 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
681 for (i = bl; i < b; i++)
683 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
691 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
692 const unsigned char *in, int inl)
694 int fix_len, cmpl = inl, ret;
699 /* Prevent accidental use of encryption context when decrypting */
701 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
705 if (ctx->cipher == NULL) {
706 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
709 if (ctx->cipher->prov == NULL)
712 blocksize = EVP_CIPHER_CTX_block_size(ctx);
714 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
715 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
718 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
719 inl + (blocksize == 1 ? 0 : blocksize), in,
723 if (soutl > INT_MAX) {
724 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
732 /* TODO(3.0): Remove legacy code below */
735 b = ctx->cipher->block_size;
737 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
738 cmpl = (cmpl + 7) / 8;
745 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
746 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
747 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
751 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
760 if (ctx->flags & EVP_CIPH_NO_PADDING)
761 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
763 OPENSSL_assert(b <= sizeof(ctx->final));
765 if (ctx->final_used) {
766 /* see comment about PTRDIFF_T comparison above */
767 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
768 || is_partially_overlapping(out, in, b)) {
769 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
772 memcpy(out, ctx->final, b);
778 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
782 * if we have 'decrypted' a multiple of block size, make sure we have a
783 * copy of this last block
785 if (b > 1 && !ctx->buf_len) {
788 memcpy(ctx->final, &out[*outl], b);
798 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
801 ret = EVP_DecryptFinal_ex(ctx, out, outl);
805 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
813 /* Prevent accidental use of encryption context when decrypting */
815 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
819 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
822 blocksize = EVP_CIPHER_CTX_block_size(ctx);
824 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
825 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
829 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
830 blocksize == 1 ? 0 : blocksize);
833 if (soutl > INT_MAX) {
834 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
842 /* TODO(3.0): Remove legacy code below */
846 if (ctx->cipher == NULL) {
847 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
851 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
852 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
860 b = ctx->cipher->block_size;
861 if (ctx->flags & EVP_CIPH_NO_PADDING) {
863 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
864 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
871 if (ctx->buf_len || !ctx->final_used) {
872 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
875 OPENSSL_assert(b <= sizeof(ctx->final));
878 * The following assumes that the ciphertext has been authenticated.
879 * Otherwise it provides a padding oracle.
881 n = ctx->final[b - 1];
882 if (n == 0 || n > (int)b) {
883 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
886 for (i = 0; i < n; i++) {
887 if (ctx->final[--b] != n) {
888 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
892 n = ctx->cipher->block_size - n;
893 for (i = 0; i < n; i++)
894 out[i] = ctx->final[i];
901 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
903 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
904 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
905 if (EVP_CIPHER_CTX_key_length(c) == keylen)
907 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
911 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
915 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
918 ctx->flags &= ~EVP_CIPH_NO_PADDING;
920 ctx->flags |= EVP_CIPH_NO_PADDING;
922 if (ctx->cipher != NULL && ctx->cipher->prov != NULL) {
923 OSSL_PARAM params[] = {
924 OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING, NULL),
928 params[0].data = &pad;
930 if (ctx->cipher->ctx_set_params == NULL) {
931 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING, EVP_R_CTRL_NOT_IMPLEMENTED);
935 if (!ctx->cipher->ctx_set_params(ctx->provctx, params))
942 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
947 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
951 if (!ctx->cipher->ctrl) {
952 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
956 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
958 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
959 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
965 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
968 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
969 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
970 kl = EVP_CIPHER_CTX_key_length(ctx);
971 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
976 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
978 if ((in == NULL) || (in->cipher == NULL)) {
979 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
983 if (in->cipher->prov == NULL)
986 if (in->cipher->dupctx == NULL) {
987 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
991 EVP_CIPHER_CTX_reset(out);
996 if (in->fetched_cipher != NULL && !EVP_CIPHER_upref(in->fetched_cipher)) {
997 out->fetched_cipher = NULL;
1001 out->provctx = in->cipher->dupctx(in->provctx);
1002 if (out->provctx == NULL) {
1003 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1009 /* TODO(3.0): Remove legacy code below */
1012 #ifndef OPENSSL_NO_ENGINE
1013 /* Make sure it's safe to copy a cipher context using an ENGINE */
1014 if (in->engine && !ENGINE_init(in->engine)) {
1015 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1020 EVP_CIPHER_CTX_reset(out);
1021 memcpy(out, in, sizeof(*out));
1023 if (in->cipher_data && in->cipher->ctx_size) {
1024 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1025 if (out->cipher_data == NULL) {
1027 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1030 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1033 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1034 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1036 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1042 static void *evp_cipher_from_dispatch(int nid, const OSSL_DISPATCH *fns,
1043 OSSL_PROVIDER *prov)
1045 EVP_CIPHER *cipher = NULL;
1046 int fnciphcnt = 0, fnctxcnt = 0;
1048 if ((cipher = EVP_CIPHER_meth_new(nid, 0, 0)) == NULL)
1051 for (; fns->function_id != 0; fns++) {
1052 switch (fns->function_id) {
1053 case OSSL_FUNC_CIPHER_NEWCTX:
1054 if (cipher->newctx != NULL)
1056 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1059 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1060 if (cipher->einit != NULL)
1062 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1065 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1066 if (cipher->dinit != NULL)
1068 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1071 case OSSL_FUNC_CIPHER_UPDATE:
1072 if (cipher->cupdate != NULL)
1074 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1077 case OSSL_FUNC_CIPHER_FINAL:
1078 if (cipher->cfinal != NULL)
1080 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1083 case OSSL_FUNC_CIPHER_CIPHER:
1084 if (cipher->ccipher != NULL)
1086 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1088 case OSSL_FUNC_CIPHER_FREECTX:
1089 if (cipher->freectx != NULL)
1091 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1094 case OSSL_FUNC_CIPHER_DUPCTX:
1095 if (cipher->dupctx != NULL)
1097 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1099 case OSSL_FUNC_CIPHER_KEY_LENGTH:
1100 if (cipher->key_length != NULL)
1102 cipher->key_length = OSSL_get_OP_cipher_key_length(fns);
1104 case OSSL_FUNC_CIPHER_IV_LENGTH:
1105 if (cipher->iv_length != NULL)
1107 cipher->iv_length = OSSL_get_OP_cipher_iv_length(fns);
1109 case OSSL_FUNC_CIPHER_BLOCK_SIZE:
1110 if (cipher->blocksize != NULL)
1112 cipher->blocksize = OSSL_get_OP_cipher_block_size(fns);
1114 case OSSL_FUNC_CIPHER_GET_PARAMS:
1115 if (cipher->get_params != NULL)
1117 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1119 case OSSL_FUNC_CIPHER_CTX_GET_PARAMS:
1120 if (cipher->ctx_get_params != NULL)
1122 cipher->ctx_get_params = OSSL_get_OP_cipher_ctx_get_params(fns);
1124 case OSSL_FUNC_CIPHER_CTX_SET_PARAMS:
1125 if (cipher->ctx_set_params != NULL)
1127 cipher->ctx_set_params = OSSL_get_OP_cipher_ctx_set_params(fns);
1131 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1132 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1134 || cipher->blocksize == NULL
1135 || cipher->iv_length == NULL
1136 || cipher->key_length == NULL) {
1138 * In order to be a consistent set of functions we must have at least
1139 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1140 * functions, or a single "cipher" function. In all cases we need a
1141 * complete set of context management functions, as well as the
1142 * blocksize, iv_length and key_length functions.
1144 EVP_CIPHER_meth_free(cipher);
1145 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1148 cipher->prov = prov;
1150 ossl_provider_upref(prov);
1155 static int evp_cipher_upref(void *cipher)
1157 return EVP_CIPHER_upref(cipher);
1160 static void evp_cipher_free(void *cipher)
1162 EVP_CIPHER_meth_free(cipher);
1165 static int evp_cipher_nid(void *vcipher)
1167 EVP_CIPHER *cipher = vcipher;
1172 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1173 const char *properties)
1175 return evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1176 evp_cipher_from_dispatch, evp_cipher_upref,
1177 evp_cipher_free, evp_cipher_nid);