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:
158 * Ensure a context left lying around from last time is cleared
161 if (cipher != NULL && ctx->cipher != NULL) {
162 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
163 ctx->cipher_data = NULL;
167 /* TODO(3.0): Start of non-legacy code below */
169 /* Ensure a context left lying around from last time is cleared */
170 if (cipher != NULL && ctx->cipher != NULL) {
171 unsigned long flags = ctx->flags;
173 EVP_CIPHER_CTX_reset(ctx);
174 /* Restore encrypt and flags */
180 ctx->cipher = cipher;
182 cipher = ctx->cipher;
184 if (cipher->prov == NULL) {
185 provciph = EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
186 if (provciph == NULL) {
187 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
191 EVP_CIPHER_meth_free(ctx->fetched_cipher);
192 ctx->fetched_cipher = provciph;
195 ctx->cipher = cipher;
196 if (ctx->provctx == NULL) {
197 ctx->provctx = ctx->cipher->newctx();
198 if (ctx->provctx == NULL) {
199 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
204 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
206 * If this ctx was already set up for no padding then we need to tell
207 * the new cipher about it.
209 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
213 switch (EVP_CIPHER_mode(ctx->cipher)) {
214 case EVP_CIPH_CFB_MODE:
215 case EVP_CIPH_OFB_MODE:
216 case EVP_CIPH_CBC_MODE:
217 /* For these modes we remember the original IV for later use */
218 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
219 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
223 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
227 if (ctx->cipher->einit == NULL) {
228 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
232 return ctx->cipher->einit(ctx->provctx, key, iv);
235 if (ctx->cipher->dinit == NULL) {
236 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
240 return ctx->cipher->dinit(ctx->provctx, key, iv);
242 /* TODO(3.0): Remove legacy code below */
245 if (cipher != NULL) {
247 * Ensure a context left lying around from last time is cleared (we
248 * previously attempted to avoid this if the same ENGINE and
249 * EVP_CIPHER could be used).
252 unsigned long flags = ctx->flags;
253 EVP_CIPHER_CTX_reset(ctx);
254 /* Restore encrypt and flags */
258 #ifndef OPENSSL_NO_ENGINE
260 if (!ENGINE_init(impl)) {
261 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
268 /* There's an ENGINE for this job ... (apparently) */
269 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
273 * One positive side-effect of US's export control history,
274 * is that we should at least be able to avoid using US
275 * misspellings of "initialisation"?
277 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
280 /* We'll use the ENGINE's private cipher definition */
283 * Store the ENGINE functional reference so we know 'cipher' came
284 * from an ENGINE and we need to release it when done.
292 ctx->cipher = cipher;
293 if (ctx->cipher->ctx_size) {
294 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
295 if (ctx->cipher_data == NULL) {
297 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
301 ctx->cipher_data = NULL;
303 ctx->key_len = cipher->key_len;
304 /* Preserve wrap enable flag, zero everything else */
305 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
306 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
307 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
309 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
314 #ifndef OPENSSL_NO_ENGINE
317 /* we assume block size is a power of 2 in *cryptUpdate */
318 OPENSSL_assert(ctx->cipher->block_size == 1
319 || ctx->cipher->block_size == 8
320 || ctx->cipher->block_size == 16);
322 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
323 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
324 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
328 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
329 switch (EVP_CIPHER_CTX_mode(ctx)) {
331 case EVP_CIPH_STREAM_CIPHER:
332 case EVP_CIPH_ECB_MODE:
335 case EVP_CIPH_CFB_MODE:
336 case EVP_CIPH_OFB_MODE:
341 case EVP_CIPH_CBC_MODE:
343 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
344 (int)sizeof(ctx->iv));
346 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
347 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
350 case EVP_CIPH_CTR_MODE:
352 /* Don't reuse IV for CTR mode */
354 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
362 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
363 if (!ctx->cipher->init(ctx, key, iv, enc))
368 ctx->block_mask = ctx->cipher->block_size - 1;
372 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
373 const unsigned char *in, int inl)
376 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
378 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
381 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
384 return EVP_EncryptFinal_ex(ctx, out, outl);
386 return EVP_DecryptFinal_ex(ctx, out, outl);
389 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
392 return EVP_EncryptFinal(ctx, out, outl);
394 return EVP_DecryptFinal(ctx, out, outl);
397 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
398 const unsigned char *key, const unsigned char *iv)
400 return EVP_CipherInit(ctx, cipher, key, iv, 1);
403 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
404 ENGINE *impl, const unsigned char *key,
405 const unsigned char *iv)
407 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
410 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
411 const unsigned char *key, const unsigned char *iv)
413 return EVP_CipherInit(ctx, cipher, key, iv, 0);
416 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
417 ENGINE *impl, const unsigned char *key,
418 const unsigned char *iv)
420 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
424 * According to the letter of standard difference between pointers
425 * is specified to be valid only within same object. This makes
426 * it formally challenging to determine if input and output buffers
427 * are not partially overlapping with standard pointer arithmetic.
432 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
434 * Then we have VMS that distinguishes itself by adhering to
435 * sizeof(size_t)==4 even in 64-bit builds, which means that
436 * difference between two pointers might be truncated to 32 bits.
437 * In the context one can even wonder how comparison for
438 * equality is implemented. To be on the safe side we adhere to
439 * PTRDIFF_T even for comparison for equality.
441 # define PTRDIFF_T uint64_t
443 # define PTRDIFF_T size_t
446 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
448 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
450 * Check for partially overlapping buffers. [Binary logical
451 * operations are used instead of boolean to minimize number
452 * of conditional branches.]
454 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
455 (diff > (0 - (PTRDIFF_T)len)));
460 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
461 unsigned char *out, int *outl,
462 const unsigned char *in, int inl)
464 int i, j, bl, cmpl = inl;
466 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
467 cmpl = (cmpl + 7) / 8;
469 bl = ctx->cipher->block_size;
476 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
477 /* If block size > 1 then the cipher will have to do this check */
478 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
479 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
483 i = ctx->cipher->do_cipher(ctx, out, in, inl);
491 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
492 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
496 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
497 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
506 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
509 memcpy(&(ctx->buf[i]), in, inl);
515 memcpy(&(ctx->buf[i]), in, j);
518 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
528 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
534 memcpy(ctx->buf, &(in[inl]), i);
540 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
541 const unsigned char *in, int inl)
546 /* Prevent accidental use of decryption context when encrypting */
548 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
552 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
555 if (ctx->cipher->cupdate == NULL) {
556 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
559 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
561 if (soutl > INT_MAX) {
562 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
568 /* TODO(3.0): Remove legacy code below */
571 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
574 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
577 ret = EVP_EncryptFinal_ex(ctx, out, outl);
581 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
584 unsigned int i, b, bl;
587 /* Prevent accidental use of decryption context when encrypting */
589 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
593 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
596 if (ctx->cipher->cfinal == NULL) {
597 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
601 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
603 if (soutl > INT_MAX) {
604 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
611 /* TODO(3.0): Remove legacy code below */
614 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
615 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
623 b = ctx->cipher->block_size;
624 OPENSSL_assert(b <= sizeof(ctx->buf));
630 if (ctx->flags & EVP_CIPH_NO_PADDING) {
632 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
633 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
641 for (i = bl; i < b; i++)
643 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
651 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
652 const unsigned char *in, int inl)
654 int fix_len, cmpl = inl, ret;
658 /* Prevent accidental use of encryption context when decrypting */
660 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
664 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
667 if (ctx->cipher->cupdate == NULL) {
668 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
671 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
674 if (soutl > INT_MAX) {
675 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
683 /* TODO(3.0): Remove legacy code below */
686 b = ctx->cipher->block_size;
688 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
689 cmpl = (cmpl + 7) / 8;
696 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
697 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
698 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
702 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
711 if (ctx->flags & EVP_CIPH_NO_PADDING)
712 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
714 OPENSSL_assert(b <= sizeof(ctx->final));
716 if (ctx->final_used) {
717 /* see comment about PTRDIFF_T comparison above */
718 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
719 || is_partially_overlapping(out, in, b)) {
720 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
723 memcpy(out, ctx->final, b);
729 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
733 * if we have 'decrypted' a multiple of block size, make sure we have a
734 * copy of this last block
736 if (b > 1 && !ctx->buf_len) {
739 memcpy(ctx->final, &out[*outl], b);
749 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
752 ret = EVP_DecryptFinal_ex(ctx, out, outl);
756 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
763 /* Prevent accidental use of encryption context when decrypting */
765 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
769 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
772 if (ctx->cipher->cfinal == NULL) {
773 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
777 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
780 if (soutl > INT_MAX) {
781 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
789 /* TODO(3.0): Remove legacy code below */
794 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
795 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
803 b = ctx->cipher->block_size;
804 if (ctx->flags & EVP_CIPH_NO_PADDING) {
806 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
807 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
814 if (ctx->buf_len || !ctx->final_used) {
815 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
818 OPENSSL_assert(b <= sizeof(ctx->final));
821 * The following assumes that the ciphertext has been authenticated.
822 * Otherwise it provides a padding oracle.
824 n = ctx->final[b - 1];
825 if (n == 0 || n > (int)b) {
826 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
829 for (i = 0; i < n; i++) {
830 if (ctx->final[--b] != n) {
831 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
835 n = ctx->cipher->block_size - n;
836 for (i = 0; i < n; i++)
837 out[i] = ctx->final[i];
844 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
846 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
847 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
848 if (EVP_CIPHER_CTX_key_length(c) == keylen)
850 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
854 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
858 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
861 ctx->flags &= ~EVP_CIPH_NO_PADDING;
863 ctx->flags |= EVP_CIPH_NO_PADDING;
865 if (ctx->cipher != NULL && ctx->cipher->prov != NULL) {
866 OSSL_PARAM params[] = {
867 OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING, NULL),
871 params[0].data = &pad;
873 if (ctx->cipher->ctx_set_params == NULL) {
874 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING, EVP_R_CTRL_NOT_IMPLEMENTED);
878 if (!ctx->cipher->ctx_set_params(ctx->provctx, params))
885 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
890 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
894 if (!ctx->cipher->ctrl) {
895 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
899 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
901 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
902 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
908 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
910 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
911 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
912 if (RAND_priv_bytes(key, ctx->key_len) <= 0)
917 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
919 if ((in == NULL) || (in->cipher == NULL)) {
920 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
924 if (in->cipher->prov == NULL)
927 if (in->cipher->dupctx == NULL) {
928 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
932 EVP_CIPHER_CTX_reset(out);
937 if (in->fetched_cipher != NULL && !EVP_CIPHER_upref(in->fetched_cipher)) {
938 out->fetched_cipher = NULL;
942 out->provctx = in->cipher->dupctx(in->provctx);
943 if (out->provctx == NULL) {
944 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
950 /* TODO(3.0): Remove legacy code below */
953 #ifndef OPENSSL_NO_ENGINE
954 /* Make sure it's safe to copy a cipher context using an ENGINE */
955 if (in->engine && !ENGINE_init(in->engine)) {
956 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
961 EVP_CIPHER_CTX_reset(out);
962 memcpy(out, in, sizeof(*out));
964 if (in->cipher_data && in->cipher->ctx_size) {
965 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
966 if (out->cipher_data == NULL) {
968 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
971 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
974 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
975 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
977 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
983 static void *evp_cipher_from_dispatch(int nid, const OSSL_DISPATCH *fns,
986 EVP_CIPHER *cipher = NULL;
987 int fnciphcnt = 0, fnctxcnt = 0;
989 if ((cipher = EVP_CIPHER_meth_new(nid, 0, 0)) == NULL)
992 for (; fns->function_id != 0; fns++) {
993 switch (fns->function_id) {
994 case OSSL_FUNC_CIPHER_NEWCTX:
995 if (cipher->newctx != NULL)
997 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1000 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1001 if (cipher->einit != NULL)
1003 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1006 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1007 if (cipher->dinit != NULL)
1009 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1012 case OSSL_FUNC_CIPHER_UPDATE:
1013 if (cipher->cupdate != NULL)
1015 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1018 case OSSL_FUNC_CIPHER_FINAL:
1019 if (cipher->cfinal != NULL)
1021 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1024 case OSSL_FUNC_CIPHER_CIPHER:
1025 if (cipher->ccipher != NULL)
1027 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1029 case OSSL_FUNC_CIPHER_FREECTX:
1030 if (cipher->freectx != NULL)
1032 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1035 case OSSL_FUNC_CIPHER_DUPCTX:
1036 if (cipher->dupctx != NULL)
1038 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1040 case OSSL_FUNC_CIPHER_KEY_LENGTH:
1041 if (cipher->key_length != NULL)
1043 cipher->key_length = OSSL_get_OP_cipher_key_length(fns);
1045 case OSSL_FUNC_CIPHER_IV_LENGTH:
1046 if (cipher->iv_length != NULL)
1048 cipher->iv_length = OSSL_get_OP_cipher_iv_length(fns);
1050 case OSSL_FUNC_CIPHER_BLOCK_SIZE:
1051 if (cipher->blocksize != NULL)
1053 cipher->blocksize = OSSL_get_OP_cipher_block_size(fns);
1055 case OSSL_FUNC_CIPHER_GET_PARAMS:
1056 if (cipher->get_params != NULL)
1058 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1060 case OSSL_FUNC_CIPHER_CTX_GET_PARAMS:
1061 if (cipher->ctx_get_params != NULL)
1063 cipher->ctx_get_params = OSSL_get_OP_cipher_ctx_get_params(fns);
1065 case OSSL_FUNC_CIPHER_CTX_SET_PARAMS:
1066 if (cipher->ctx_set_params != NULL)
1068 cipher->ctx_set_params = OSSL_get_OP_cipher_ctx_set_params(fns);
1072 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1073 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1076 * In order to be a consistent set of functions we must have at least
1077 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1078 * functions, or a single "cipher" function. In all cases we need a
1079 * complete set of context management functions
1081 EVP_CIPHER_meth_free(cipher);
1082 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1085 cipher->prov = prov;
1087 ossl_provider_upref(prov);
1092 static int evp_cipher_upref(void *cipher)
1094 return EVP_CIPHER_upref(cipher);
1097 static void evp_cipher_free(void *cipher)
1099 EVP_CIPHER_meth_free(cipher);
1102 static int evp_cipher_nid(void *vcipher)
1104 EVP_CIPHER *cipher = vcipher;
1109 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1110 const char *properties)
1112 return evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1113 evp_cipher_from_dispatch, evp_cipher_upref,
1114 evp_cipher_free, evp_cipher_nid);