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:
179 * Ensure a context left lying around from last time is cleared
182 if (cipher != NULL && ctx->cipher != NULL) {
183 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
184 ctx->cipher_data = NULL;
188 /* TODO(3.0): Start of non-legacy code below */
190 /* Ensure a context left lying around from last time is cleared */
191 if (cipher != NULL && ctx->cipher != NULL) {
192 unsigned long flags = ctx->flags;
194 EVP_CIPHER_CTX_reset(ctx);
195 /* Restore encrypt and flags */
201 cipher = ctx->cipher;
203 if (cipher->prov == NULL) {
205 /* We only do explict fetches inside the FIPS module */
206 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
209 EVP_CIPHER *provciph =
210 EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
212 if (provciph == NULL) {
213 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
217 EVP_CIPHER_meth_free(ctx->fetched_cipher);
218 ctx->fetched_cipher = provciph;
222 ctx->cipher = cipher;
223 if (ctx->provctx == NULL) {
224 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
225 if (ctx->provctx == NULL) {
226 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
231 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
233 * If this ctx was already set up for no padding then we need to tell
234 * the new cipher about it.
236 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
240 switch (EVP_CIPHER_mode(ctx->cipher)) {
241 case EVP_CIPH_CFB_MODE:
242 case EVP_CIPH_OFB_MODE:
243 case EVP_CIPH_CBC_MODE:
244 /* For these modes we remember the original IV for later use */
245 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
246 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
250 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
254 if (ctx->cipher->einit == NULL) {
255 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
259 return ctx->cipher->einit(ctx->provctx,
262 : EVP_CIPHER_CTX_key_length(ctx),
265 : EVP_CIPHER_CTX_iv_length(ctx));
268 if (ctx->cipher->dinit == NULL) {
269 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
273 return ctx->cipher->dinit(ctx->provctx,
276 : EVP_CIPHER_CTX_key_length(ctx),
279 : EVP_CIPHER_CTX_iv_length(ctx));
281 /* TODO(3.0): Remove legacy code below */
284 if (cipher != NULL) {
286 * Ensure a context left lying around from last time is cleared (we
287 * previously attempted to avoid this if the same ENGINE and
288 * EVP_CIPHER could be used).
291 unsigned long flags = ctx->flags;
292 EVP_CIPHER_CTX_reset(ctx);
293 /* Restore encrypt and flags */
297 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
299 if (!ENGINE_init(impl)) {
300 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
307 /* There's an ENGINE for this job ... (apparently) */
308 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
312 * One positive side-effect of US's export control history,
313 * is that we should at least be able to avoid using US
314 * misspellings of "initialisation"?
316 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
319 /* We'll use the ENGINE's private cipher definition */
322 * Store the ENGINE functional reference so we know 'cipher' came
323 * from an ENGINE and we need to release it when done.
331 ctx->cipher = cipher;
332 if (ctx->cipher->ctx_size) {
333 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
334 if (ctx->cipher_data == NULL) {
336 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
340 ctx->cipher_data = NULL;
342 ctx->key_len = cipher->key_len;
343 /* Preserve wrap enable flag, zero everything else */
344 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
345 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
346 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
348 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
353 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
356 if (ctx->cipher == NULL)
359 /* we assume block size is a power of 2 in *cryptUpdate */
360 OPENSSL_assert(ctx->cipher->block_size == 1
361 || ctx->cipher->block_size == 8
362 || ctx->cipher->block_size == 16);
364 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
365 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
366 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
370 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
371 switch (EVP_CIPHER_CTX_mode(ctx)) {
373 case EVP_CIPH_STREAM_CIPHER:
374 case EVP_CIPH_ECB_MODE:
377 case EVP_CIPH_CFB_MODE:
378 case EVP_CIPH_OFB_MODE:
383 case EVP_CIPH_CBC_MODE:
385 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
386 (int)sizeof(ctx->iv));
388 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
389 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
392 case EVP_CIPH_CTR_MODE:
394 /* Don't reuse IV for CTR mode */
396 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
404 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
405 if (!ctx->cipher->init(ctx, key, iv, enc))
410 ctx->block_mask = ctx->cipher->block_size - 1;
414 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
415 const unsigned char *in, int inl)
418 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
420 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
423 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
426 return EVP_EncryptFinal_ex(ctx, out, outl);
428 return EVP_DecryptFinal_ex(ctx, out, outl);
431 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
434 return EVP_EncryptFinal(ctx, out, outl);
436 return EVP_DecryptFinal(ctx, out, outl);
439 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
440 const unsigned char *key, const unsigned char *iv)
442 return EVP_CipherInit(ctx, cipher, key, iv, 1);
445 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
446 ENGINE *impl, const unsigned char *key,
447 const unsigned char *iv)
449 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
452 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
453 const unsigned char *key, const unsigned char *iv)
455 return EVP_CipherInit(ctx, cipher, key, iv, 0);
458 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
459 ENGINE *impl, const unsigned char *key,
460 const unsigned char *iv)
462 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
466 * According to the letter of standard difference between pointers
467 * is specified to be valid only within same object. This makes
468 * it formally challenging to determine if input and output buffers
469 * are not partially overlapping with standard pointer arithmetic.
474 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
476 * Then we have VMS that distinguishes itself by adhering to
477 * sizeof(size_t)==4 even in 64-bit builds, which means that
478 * difference between two pointers might be truncated to 32 bits.
479 * In the context one can even wonder how comparison for
480 * equality is implemented. To be on the safe side we adhere to
481 * PTRDIFF_T even for comparison for equality.
483 # define PTRDIFF_T uint64_t
485 # define PTRDIFF_T size_t
488 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
490 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
492 * Check for partially overlapping buffers. [Binary logical
493 * operations are used instead of boolean to minimize number
494 * of conditional branches.]
496 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
497 (diff > (0 - (PTRDIFF_T)len)));
502 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
503 unsigned char *out, int *outl,
504 const unsigned char *in, int inl)
506 int i, j, bl, cmpl = inl;
508 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
509 cmpl = (cmpl + 7) / 8;
511 bl = ctx->cipher->block_size;
513 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
514 /* If block size > 1 then the cipher will have to do this check */
515 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
516 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
520 i = ctx->cipher->do_cipher(ctx, out, in, inl);
532 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
533 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
537 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
538 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
547 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
550 memcpy(&(ctx->buf[i]), in, inl);
556 memcpy(&(ctx->buf[i]), in, j);
559 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
569 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
575 memcpy(ctx->buf, &(in[inl]), i);
581 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
582 const unsigned char *in, int inl)
588 /* Prevent accidental use of decryption context when encrypting */
590 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
594 if (ctx->cipher == NULL) {
595 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
599 if (ctx->cipher->prov == NULL)
602 blocksize = EVP_CIPHER_CTX_block_size(ctx);
604 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
605 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
608 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
609 inl + (blocksize == 1 ? 0 : blocksize), in,
613 if (soutl > INT_MAX) {
614 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
622 /* TODO(3.0): Remove legacy code below */
625 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
628 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
631 ret = EVP_EncryptFinal_ex(ctx, out, outl);
635 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
638 unsigned int i, b, bl;
642 /* Prevent accidental use of decryption context when encrypting */
644 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
648 if (ctx->cipher == NULL) {
649 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
652 if (ctx->cipher->prov == NULL)
655 blocksize = EVP_CIPHER_CTX_block_size(ctx);
657 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
658 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
662 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
663 blocksize == 1 ? 0 : blocksize);
666 if (soutl > INT_MAX) {
667 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
675 /* TODO(3.0): Remove legacy code below */
678 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
679 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
687 b = ctx->cipher->block_size;
688 OPENSSL_assert(b <= sizeof(ctx->buf));
694 if (ctx->flags & EVP_CIPH_NO_PADDING) {
696 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
697 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
705 for (i = bl; i < b; i++)
707 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
715 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
716 const unsigned char *in, int inl)
718 int fix_len, cmpl = inl, ret;
723 /* Prevent accidental use of encryption context when decrypting */
725 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
729 if (ctx->cipher == NULL) {
730 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
733 if (ctx->cipher->prov == NULL)
736 blocksize = EVP_CIPHER_CTX_block_size(ctx);
738 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
739 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
742 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
743 inl + (blocksize == 1 ? 0 : blocksize), in,
747 if (soutl > INT_MAX) {
748 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
756 /* TODO(3.0): Remove legacy code below */
759 b = ctx->cipher->block_size;
761 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
762 cmpl = (cmpl + 7) / 8;
764 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
765 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
766 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
770 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
784 if (ctx->flags & EVP_CIPH_NO_PADDING)
785 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
787 OPENSSL_assert(b <= sizeof(ctx->final));
789 if (ctx->final_used) {
790 /* see comment about PTRDIFF_T comparison above */
791 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
792 || is_partially_overlapping(out, in, b)) {
793 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
796 memcpy(out, ctx->final, b);
802 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
806 * if we have 'decrypted' a multiple of block size, make sure we have a
807 * copy of this last block
809 if (b > 1 && !ctx->buf_len) {
812 memcpy(ctx->final, &out[*outl], b);
822 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
825 ret = EVP_DecryptFinal_ex(ctx, out, outl);
829 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
837 /* Prevent accidental use of encryption context when decrypting */
839 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
843 if (ctx->cipher == NULL) {
844 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
848 if (ctx->cipher->prov == NULL)
851 blocksize = EVP_CIPHER_CTX_block_size(ctx);
853 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
854 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
858 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
859 blocksize == 1 ? 0 : blocksize);
862 if (soutl > INT_MAX) {
863 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
871 /* TODO(3.0): Remove legacy code below */
875 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
876 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
884 b = ctx->cipher->block_size;
885 if (ctx->flags & EVP_CIPH_NO_PADDING) {
887 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
888 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
895 if (ctx->buf_len || !ctx->final_used) {
896 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
899 OPENSSL_assert(b <= sizeof(ctx->final));
902 * The following assumes that the ciphertext has been authenticated.
903 * Otherwise it provides a padding oracle.
905 n = ctx->final[b - 1];
906 if (n == 0 || n > (int)b) {
907 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
910 for (i = 0; i < n; i++) {
911 if (ctx->final[--b] != n) {
912 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
916 n = ctx->cipher->block_size - n;
917 for (i = 0; i < n; i++)
918 out[i] = ctx->final[i];
925 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
928 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
930 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN, &keylen);
931 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
933 if (ok != EVP_CTRL_RET_UNSUPPORTED)
936 /* TODO(3.0) legacy code follows */
937 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
938 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
939 if (EVP_CIPHER_CTX_key_length(c) == keylen)
941 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
945 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
949 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
952 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
955 ctx->flags &= ~EVP_CIPH_NO_PADDING;
957 ctx->flags |= EVP_CIPH_NO_PADDING;
959 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_PADDING, &pad);
960 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
965 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
967 int ret = EVP_CTRL_RET_UNSUPPORTED;
970 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
972 if (ctx == NULL || ctx->cipher == NULL) {
973 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
977 if (ctx->cipher->prov == NULL)
981 case EVP_CTRL_SET_KEY_LENGTH:
982 params[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN, &arg);
984 case EVP_CTRL_RAND_KEY: /* Used by DES */
985 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
986 case EVP_CTRL_INIT: /* TODO(3.0) Purely legacy, no provider counterpart */
988 return EVP_CTRL_RET_UNSUPPORTED;
989 case EVP_CTRL_GET_IV:
991 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV,
994 case EVP_CTRL_AEAD_SET_IVLEN:
999 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, &sz);
1001 case EVP_CTRL_GCM_SET_IV_FIXED:
1003 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED,
1006 case EVP_CTRL_AEAD_SET_TAG:
1008 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1011 case EVP_CTRL_AEAD_GET_TAG:
1013 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1016 case EVP_CTRL_AEAD_TLS1_AAD:
1017 /* This one does a set and a get - since it returns a padding size */
1019 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1021 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1025 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1026 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1033 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1035 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1038 /* TODO(3.0): Remove legacy code below */
1040 if (ctx->cipher->ctrl == NULL) {
1041 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1045 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1046 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1047 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1048 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1054 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1056 if (cipher != NULL && cipher->get_params != NULL)
1057 return cipher->get_params(params);
1061 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1063 if (ctx->cipher != NULL && ctx->cipher->ctx_set_params != NULL)
1064 return ctx->cipher->ctx_set_params(ctx->provctx, params);
1068 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1070 if (ctx->cipher != NULL && ctx->cipher->ctx_get_params != NULL)
1071 return ctx->cipher->ctx_get_params(ctx->provctx, params);
1075 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1077 if (cipher != NULL && cipher->gettable_params != NULL)
1078 return cipher->gettable_params();
1082 const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(const EVP_CIPHER *cipher)
1084 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1085 return cipher->settable_ctx_params();
1089 const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER *cipher)
1091 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1092 return cipher->gettable_ctx_params();
1096 #if !defined(FIPS_MODE)
1097 /* TODO(3.0): No support for RAND yet in the FIPS module */
1098 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1101 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1102 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1103 kl = EVP_CIPHER_CTX_key_length(ctx);
1104 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
1110 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1112 if ((in == NULL) || (in->cipher == NULL)) {
1113 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1117 if (in->cipher->prov == NULL)
1120 if (in->cipher->dupctx == NULL) {
1121 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1125 EVP_CIPHER_CTX_reset(out);
1128 out->provctx = NULL;
1130 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1131 out->fetched_cipher = NULL;
1135 out->provctx = in->cipher->dupctx(in->provctx);
1136 if (out->provctx == NULL) {
1137 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1143 /* TODO(3.0): Remove legacy code below */
1146 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1147 /* Make sure it's safe to copy a cipher context using an ENGINE */
1148 if (in->engine && !ENGINE_init(in->engine)) {
1149 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1154 EVP_CIPHER_CTX_reset(out);
1155 memcpy(out, in, sizeof(*out));
1157 if (in->cipher_data && in->cipher->ctx_size) {
1158 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1159 if (out->cipher_data == NULL) {
1161 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1164 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1167 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1168 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1170 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1176 static void *evp_cipher_from_dispatch(const char *name,
1177 const OSSL_DISPATCH *fns,
1178 OSSL_PROVIDER *prov)
1180 EVP_CIPHER *cipher = NULL;
1181 int fnciphcnt = 0, fnctxcnt = 0;
1184 * The legacy NID is set by EVP_CIPHER_fetch() if the name exists in
1185 * the object database.
1187 if ((cipher = EVP_CIPHER_meth_new(0, 0, 0)) == NULL
1188 || (cipher->name = OPENSSL_strdup(name)) == NULL) {
1189 EVP_CIPHER_meth_free(cipher);
1190 EVPerr(0, ERR_R_MALLOC_FAILURE);
1194 for (; fns->function_id != 0; fns++) {
1195 switch (fns->function_id) {
1196 case OSSL_FUNC_CIPHER_NEWCTX:
1197 if (cipher->newctx != NULL)
1199 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1202 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1203 if (cipher->einit != NULL)
1205 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1208 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1209 if (cipher->dinit != NULL)
1211 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1214 case OSSL_FUNC_CIPHER_UPDATE:
1215 if (cipher->cupdate != NULL)
1217 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1220 case OSSL_FUNC_CIPHER_FINAL:
1221 if (cipher->cfinal != NULL)
1223 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1226 case OSSL_FUNC_CIPHER_CIPHER:
1227 if (cipher->ccipher != NULL)
1229 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1231 case OSSL_FUNC_CIPHER_FREECTX:
1232 if (cipher->freectx != NULL)
1234 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1237 case OSSL_FUNC_CIPHER_DUPCTX:
1238 if (cipher->dupctx != NULL)
1240 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1242 case OSSL_FUNC_CIPHER_GET_PARAMS:
1243 if (cipher->get_params != NULL)
1245 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1247 case OSSL_FUNC_CIPHER_CTX_GET_PARAMS:
1248 if (cipher->ctx_get_params != NULL)
1250 cipher->ctx_get_params = OSSL_get_OP_cipher_ctx_get_params(fns);
1252 case OSSL_FUNC_CIPHER_CTX_SET_PARAMS:
1253 if (cipher->ctx_set_params != NULL)
1255 cipher->ctx_set_params = OSSL_get_OP_cipher_ctx_set_params(fns);
1257 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1258 if (cipher->gettable_params != NULL)
1260 cipher->gettable_params = OSSL_get_OP_cipher_gettable_params(fns);
1262 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1263 if (cipher->gettable_ctx_params != NULL)
1265 cipher->gettable_ctx_params =
1266 OSSL_get_OP_cipher_gettable_ctx_params(fns);
1268 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1269 if (cipher->settable_ctx_params != NULL)
1271 cipher->settable_ctx_params =
1272 OSSL_get_OP_cipher_settable_ctx_params(fns);
1276 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1277 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1280 * In order to be a consistent set of functions we must have at least
1281 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1282 * functions, or a single "cipher" function. In all cases we need both
1283 * the "newctx" and "freectx" functions.
1285 EVP_CIPHER_meth_free(cipher);
1286 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1289 cipher->prov = prov;
1291 ossl_provider_up_ref(prov);
1296 static int evp_cipher_up_ref(void *cipher)
1298 return EVP_CIPHER_up_ref(cipher);
1301 static void evp_cipher_free(void *cipher)
1303 EVP_CIPHER_meth_free(cipher);
1306 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1307 const char *properties)
1309 EVP_CIPHER *cipher =
1310 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1311 evp_cipher_from_dispatch, evp_cipher_up_ref,
1315 /* TODO(3.x) get rid of the need for legacy NIDs */
1316 if (cipher != NULL) {
1318 * FIPS module note: since internal fetches will be entirely
1319 * provider based, we know that none of its code depends on legacy
1320 * NIDs or any functionality that use them.
1322 cipher->nid = OBJ_sn2nid(algorithm);
1329 void EVP_CIPHER_do_all_ex(OPENSSL_CTX *libctx,
1330 void (*fn)(EVP_CIPHER *mac, void *arg),
1333 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1334 (void (*)(void *, void *))fn, arg,
1335 evp_cipher_from_dispatch, evp_cipher_free);