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) {
148 * Ensure a context left lying around from last time is cleared
151 if (cipher != NULL && ctx->cipher != NULL) {
152 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
153 ctx->cipher_data = NULL;
157 /* TODO(3.0): Start of non-legacy code below */
159 /* Ensure a context left lying around from last time is cleared */
160 if (cipher != NULL && ctx->cipher != NULL) {
161 unsigned long flags = ctx->flags;
163 EVP_CIPHER_CTX_reset(ctx);
164 /* Restore encrypt and flags */
170 ctx->cipher = cipher;
172 cipher = ctx->cipher;
174 if (cipher->prov == NULL) {
175 provciph = EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
176 if (provciph == NULL) {
177 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
181 EVP_CIPHER_meth_free(ctx->fetched_cipher);
182 ctx->fetched_cipher = provciph;
185 ctx->cipher = cipher;
186 if (ctx->provctx == NULL) {
187 ctx->provctx = ctx->cipher->newctx();
188 if (ctx->provctx == NULL) {
189 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
194 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
196 * If this ctx was already set up for no padding then we need to tell
197 * the new cipher about it.
199 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
204 if (ctx->cipher->einit == NULL) {
205 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
209 return ctx->cipher->einit(ctx->provctx, key, iv);
212 if (ctx->cipher->dinit == NULL) {
213 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
217 return ctx->cipher->dinit(ctx->provctx, key, iv);
219 /* TODO(3.0): Remove legacy code below */
222 if (cipher != NULL) {
224 * Ensure a context left lying around from last time is cleared (we
225 * previously attempted to avoid this if the same ENGINE and
226 * EVP_CIPHER could be used).
229 unsigned long flags = ctx->flags;
230 EVP_CIPHER_CTX_reset(ctx);
231 /* Restore encrypt and flags */
235 #ifndef OPENSSL_NO_ENGINE
237 if (!ENGINE_init(impl)) {
238 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
245 /* There's an ENGINE for this job ... (apparently) */
246 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
250 * One positive side-effect of US's export control history,
251 * is that we should at least be able to avoid using US
252 * misspellings of "initialisation"?
254 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
257 /* We'll use the ENGINE's private cipher definition */
260 * Store the ENGINE functional reference so we know 'cipher' came
261 * from an ENGINE and we need to release it when done.
269 ctx->cipher = cipher;
270 if (ctx->cipher->ctx_size) {
271 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
272 if (ctx->cipher_data == NULL) {
274 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
278 ctx->cipher_data = NULL;
280 ctx->key_len = cipher->key_len;
281 /* Preserve wrap enable flag, zero everything else */
282 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
283 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
284 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
286 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
291 #ifndef OPENSSL_NO_ENGINE
294 /* we assume block size is a power of 2 in *cryptUpdate */
295 OPENSSL_assert(ctx->cipher->block_size == 1
296 || ctx->cipher->block_size == 8
297 || ctx->cipher->block_size == 16);
299 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
300 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
301 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
305 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
306 switch (EVP_CIPHER_CTX_mode(ctx)) {
308 case EVP_CIPH_STREAM_CIPHER:
309 case EVP_CIPH_ECB_MODE:
312 case EVP_CIPH_CFB_MODE:
313 case EVP_CIPH_OFB_MODE:
318 case EVP_CIPH_CBC_MODE:
320 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
321 (int)sizeof(ctx->iv));
323 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
324 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
327 case EVP_CIPH_CTR_MODE:
329 /* Don't reuse IV for CTR mode */
331 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
339 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
340 if (!ctx->cipher->init(ctx, key, iv, enc))
345 ctx->block_mask = ctx->cipher->block_size - 1;
349 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
350 const unsigned char *in, int inl)
353 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
355 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
358 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
361 return EVP_EncryptFinal_ex(ctx, out, outl);
363 return EVP_DecryptFinal_ex(ctx, out, outl);
366 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
369 return EVP_EncryptFinal(ctx, out, outl);
371 return EVP_DecryptFinal(ctx, out, outl);
374 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
375 const unsigned char *key, const unsigned char *iv)
377 return EVP_CipherInit(ctx, cipher, key, iv, 1);
380 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
381 ENGINE *impl, const unsigned char *key,
382 const unsigned char *iv)
384 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
387 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
388 const unsigned char *key, const unsigned char *iv)
390 return EVP_CipherInit(ctx, cipher, key, iv, 0);
393 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
394 ENGINE *impl, const unsigned char *key,
395 const unsigned char *iv)
397 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
401 * According to the letter of standard difference between pointers
402 * is specified to be valid only within same object. This makes
403 * it formally challenging to determine if input and output buffers
404 * are not partially overlapping with standard pointer arithmetic.
409 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
411 * Then we have VMS that distinguishes itself by adhering to
412 * sizeof(size_t)==4 even in 64-bit builds, which means that
413 * difference between two pointers might be truncated to 32 bits.
414 * In the context one can even wonder how comparison for
415 * equality is implemented. To be on the safe side we adhere to
416 * PTRDIFF_T even for comparison for equality.
418 # define PTRDIFF_T uint64_t
420 # define PTRDIFF_T size_t
423 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
425 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
427 * Check for partially overlapping buffers. [Binary logical
428 * operations are used instead of boolean to minimize number
429 * of conditional branches.]
431 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
432 (diff > (0 - (PTRDIFF_T)len)));
437 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
438 unsigned char *out, int *outl,
439 const unsigned char *in, int inl)
441 int i, j, bl, cmpl = inl;
443 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
444 cmpl = (cmpl + 7) / 8;
446 bl = ctx->cipher->block_size;
453 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
454 /* If block size > 1 then the cipher will have to do this check */
455 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
456 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
460 i = ctx->cipher->do_cipher(ctx, out, in, inl);
468 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
469 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
473 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
474 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
483 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
486 memcpy(&(ctx->buf[i]), in, inl);
492 memcpy(&(ctx->buf[i]), in, j);
495 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
505 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
511 memcpy(ctx->buf, &(in[inl]), i);
517 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
518 const unsigned char *in, int inl)
523 /* Prevent accidental use of decryption context when encrypting */
525 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
529 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
532 if (ctx->cipher->cupdate == NULL) {
533 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
536 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
538 if (soutl > INT_MAX) {
539 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
545 /* TODO(3.0): Remove legacy code below */
548 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
551 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
554 ret = EVP_EncryptFinal_ex(ctx, out, outl);
558 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
561 unsigned int i, b, bl;
564 /* Prevent accidental use of decryption context when encrypting */
566 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
570 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
573 if (ctx->cipher->cfinal == NULL) {
574 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
578 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
580 if (soutl > INT_MAX) {
581 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
588 /* TODO(3.0): Remove legacy code below */
591 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
592 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
600 b = ctx->cipher->block_size;
601 OPENSSL_assert(b <= sizeof(ctx->buf));
607 if (ctx->flags & EVP_CIPH_NO_PADDING) {
609 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
610 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
618 for (i = bl; i < b; i++)
620 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
628 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
629 const unsigned char *in, int inl)
631 int fix_len, cmpl = inl, ret;
635 /* Prevent accidental use of encryption context when decrypting */
637 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
641 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
644 if (ctx->cipher->cupdate == NULL) {
645 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
648 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
651 if (soutl > INT_MAX) {
652 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
660 /* TODO(3.0): Remove legacy code below */
663 b = ctx->cipher->block_size;
665 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
666 cmpl = (cmpl + 7) / 8;
673 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
674 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
675 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
679 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
688 if (ctx->flags & EVP_CIPH_NO_PADDING)
689 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
691 OPENSSL_assert(b <= sizeof(ctx->final));
693 if (ctx->final_used) {
694 /* see comment about PTRDIFF_T comparison above */
695 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
696 || is_partially_overlapping(out, in, b)) {
697 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
700 memcpy(out, ctx->final, b);
706 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
710 * if we have 'decrypted' a multiple of block size, make sure we have a
711 * copy of this last block
713 if (b > 1 && !ctx->buf_len) {
716 memcpy(ctx->final, &out[*outl], b);
726 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
729 ret = EVP_DecryptFinal_ex(ctx, out, outl);
733 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
740 /* Prevent accidental use of encryption context when decrypting */
742 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
746 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
749 if (ctx->cipher->cfinal == NULL) {
750 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
754 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
757 if (soutl > INT_MAX) {
758 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
766 /* TODO(3.0): Remove legacy code below */
771 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
772 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
780 b = ctx->cipher->block_size;
781 if (ctx->flags & EVP_CIPH_NO_PADDING) {
783 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
784 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
791 if (ctx->buf_len || !ctx->final_used) {
792 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
795 OPENSSL_assert(b <= sizeof(ctx->final));
798 * The following assumes that the ciphertext has been authenticated.
799 * Otherwise it provides a padding oracle.
801 n = ctx->final[b - 1];
802 if (n == 0 || n > (int)b) {
803 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
806 for (i = 0; i < n; i++) {
807 if (ctx->final[--b] != n) {
808 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
812 n = ctx->cipher->block_size - n;
813 for (i = 0; i < n; i++)
814 out[i] = ctx->final[i];
821 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
823 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
824 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
825 if (EVP_CIPHER_CTX_key_length(c) == keylen)
827 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
831 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
835 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
838 ctx->flags &= ~EVP_CIPH_NO_PADDING;
840 ctx->flags |= EVP_CIPH_NO_PADDING;
842 if (ctx->cipher != NULL && ctx->cipher->prov != NULL) {
843 OSSL_PARAM params[] = {
844 OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING, NULL),
848 params[0].data = &pad;
850 if (ctx->cipher->set_params == NULL) {
851 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING, EVP_R_CTRL_NOT_IMPLEMENTED);
855 if (!ctx->cipher->set_params(ctx->provctx, params))
862 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
867 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
871 if (!ctx->cipher->ctrl) {
872 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
876 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
878 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
879 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
885 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
887 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
888 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
889 if (RAND_priv_bytes(key, ctx->key_len) <= 0)
894 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
896 if ((in == NULL) || (in->cipher == NULL)) {
897 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
901 if (in->cipher->prov == NULL)
904 if (in->cipher->dupctx == NULL) {
905 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
909 EVP_CIPHER_CTX_reset(out);
914 if (in->fetched_cipher != NULL || !EVP_CIPHER_upref(in->fetched_cipher)) {
915 out->fetched_cipher = NULL;
919 out->provctx = in->cipher->dupctx(in->provctx);
920 if (out->provctx == NULL) {
921 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
927 /* TODO(3.0): Remove legacy code below */
930 #ifndef OPENSSL_NO_ENGINE
931 /* Make sure it's safe to copy a cipher context using an ENGINE */
932 if (in->engine && !ENGINE_init(in->engine)) {
933 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
938 EVP_CIPHER_CTX_reset(out);
939 memcpy(out, in, sizeof(*out));
941 if (in->cipher_data && in->cipher->ctx_size) {
942 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
943 if (out->cipher_data == NULL) {
945 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
948 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
951 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
952 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
954 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
960 static void *evp_cipher_from_dispatch(int nid, const OSSL_DISPATCH *fns,
963 EVP_CIPHER *cipher = NULL;
964 int fnciphcnt = 0, fnctxcnt = 0;
966 if ((cipher = EVP_CIPHER_meth_new(nid, 0, 0)) == NULL)
969 for (; fns->function_id != 0; fns++) {
970 switch (fns->function_id) {
971 case OSSL_FUNC_CIPHER_NEWCTX:
972 if (cipher->newctx != NULL)
974 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
977 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
978 if (cipher->einit != NULL)
980 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
983 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
984 if (cipher->dinit != NULL)
986 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
989 case OSSL_FUNC_CIPHER_UPDATE:
990 if (cipher->cupdate != NULL)
992 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
995 case OSSL_FUNC_CIPHER_FINAL:
996 if (cipher->cfinal != NULL)
998 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1001 case OSSL_FUNC_CIPHER_FREECTX:
1002 if (cipher->freectx != NULL)
1004 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1007 case OSSL_FUNC_CIPHER_DUPCTX:
1008 if (cipher->dupctx != NULL)
1010 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1012 case OSSL_FUNC_CIPHER_KEY_LENGTH:
1013 if (cipher->key_length != NULL)
1015 cipher->key_length = OSSL_get_OP_cipher_key_length(fns);
1017 case OSSL_FUNC_CIPHER_GET_PARAMS:
1018 if (cipher->get_params != NULL)
1020 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1022 case OSSL_FUNC_CIPHER_SET_PARAMS:
1023 if (cipher->set_params != NULL)
1025 cipher->set_params = OSSL_get_OP_cipher_set_params(fns);
1029 if ((fnciphcnt != 3 && fnciphcnt != 4)
1032 * In order to be a consistent set of functions we must have at least
1033 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1034 * functions. In both cases we need a complete set of context management
1037 EVP_CIPHER_meth_free(cipher);
1038 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1041 cipher->prov = prov;
1043 ossl_provider_upref(prov);
1048 static int evp_cipher_upref(void *cipher)
1050 return EVP_CIPHER_upref(cipher);
1053 static void evp_cipher_free(void *cipher)
1055 EVP_CIPHER_meth_free(cipher);
1058 static int evp_cipher_nid(void *vcipher)
1060 EVP_CIPHER *cipher = vcipher;
1065 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1066 const char *properties)
1068 return evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1069 evp_cipher_from_dispatch, evp_cipher_upref,
1070 evp_cipher_free, evp_cipher_nid);