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:
150 * Ensure a context left lying around from last time is cleared
153 if (cipher != NULL && ctx->cipher != NULL) {
154 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
155 ctx->cipher_data = NULL;
159 /* TODO(3.0): Start of non-legacy code below */
161 /* Ensure a context left lying around from last time is cleared */
162 if (cipher != NULL && ctx->cipher != NULL) {
163 unsigned long flags = ctx->flags;
165 EVP_CIPHER_CTX_reset(ctx);
166 /* Restore encrypt and flags */
172 ctx->cipher = cipher;
174 cipher = ctx->cipher;
176 if (cipher->prov == NULL) {
177 provciph = EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
178 if (provciph == NULL) {
179 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
183 EVP_CIPHER_meth_free(ctx->fetched_cipher);
184 ctx->fetched_cipher = provciph;
187 ctx->cipher = cipher;
188 if (ctx->provctx == NULL) {
189 ctx->provctx = ctx->cipher->newctx();
190 if (ctx->provctx == NULL) {
191 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
196 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
198 * If this ctx was already set up for no padding then we need to tell
199 * the new cipher about it.
201 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
206 if (ctx->cipher->einit == NULL) {
207 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
211 return ctx->cipher->einit(ctx->provctx, key, iv);
214 if (ctx->cipher->dinit == NULL) {
215 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
219 return ctx->cipher->dinit(ctx->provctx, key, iv);
221 /* TODO(3.0): Remove legacy code below */
224 if (cipher != NULL) {
226 * Ensure a context left lying around from last time is cleared (we
227 * previously attempted to avoid this if the same ENGINE and
228 * EVP_CIPHER could be used).
231 unsigned long flags = ctx->flags;
232 EVP_CIPHER_CTX_reset(ctx);
233 /* Restore encrypt and flags */
237 #ifndef OPENSSL_NO_ENGINE
239 if (!ENGINE_init(impl)) {
240 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
247 /* There's an ENGINE for this job ... (apparently) */
248 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
252 * One positive side-effect of US's export control history,
253 * is that we should at least be able to avoid using US
254 * misspellings of "initialisation"?
256 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
259 /* We'll use the ENGINE's private cipher definition */
262 * Store the ENGINE functional reference so we know 'cipher' came
263 * from an ENGINE and we need to release it when done.
271 ctx->cipher = cipher;
272 if (ctx->cipher->ctx_size) {
273 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
274 if (ctx->cipher_data == NULL) {
276 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
280 ctx->cipher_data = NULL;
282 ctx->key_len = cipher->key_len;
283 /* Preserve wrap enable flag, zero everything else */
284 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
285 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
286 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
288 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
293 #ifndef OPENSSL_NO_ENGINE
296 /* we assume block size is a power of 2 in *cryptUpdate */
297 OPENSSL_assert(ctx->cipher->block_size == 1
298 || ctx->cipher->block_size == 8
299 || ctx->cipher->block_size == 16);
301 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
302 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
303 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
307 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
308 switch (EVP_CIPHER_CTX_mode(ctx)) {
310 case EVP_CIPH_STREAM_CIPHER:
311 case EVP_CIPH_ECB_MODE:
314 case EVP_CIPH_CFB_MODE:
315 case EVP_CIPH_OFB_MODE:
320 case EVP_CIPH_CBC_MODE:
322 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
323 (int)sizeof(ctx->iv));
325 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
326 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
329 case EVP_CIPH_CTR_MODE:
331 /* Don't reuse IV for CTR mode */
333 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
341 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
342 if (!ctx->cipher->init(ctx, key, iv, enc))
347 ctx->block_mask = ctx->cipher->block_size - 1;
351 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
352 const unsigned char *in, int inl)
355 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
357 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
360 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
363 return EVP_EncryptFinal_ex(ctx, out, outl);
365 return EVP_DecryptFinal_ex(ctx, out, outl);
368 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
371 return EVP_EncryptFinal(ctx, out, outl);
373 return EVP_DecryptFinal(ctx, out, outl);
376 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
377 const unsigned char *key, const unsigned char *iv)
379 return EVP_CipherInit(ctx, cipher, key, iv, 1);
382 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
383 ENGINE *impl, const unsigned char *key,
384 const unsigned char *iv)
386 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
389 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
390 const unsigned char *key, const unsigned char *iv)
392 return EVP_CipherInit(ctx, cipher, key, iv, 0);
395 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
396 ENGINE *impl, const unsigned char *key,
397 const unsigned char *iv)
399 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
403 * According to the letter of standard difference between pointers
404 * is specified to be valid only within same object. This makes
405 * it formally challenging to determine if input and output buffers
406 * are not partially overlapping with standard pointer arithmetic.
411 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
413 * Then we have VMS that distinguishes itself by adhering to
414 * sizeof(size_t)==4 even in 64-bit builds, which means that
415 * difference between two pointers might be truncated to 32 bits.
416 * In the context one can even wonder how comparison for
417 * equality is implemented. To be on the safe side we adhere to
418 * PTRDIFF_T even for comparison for equality.
420 # define PTRDIFF_T uint64_t
422 # define PTRDIFF_T size_t
425 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
427 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
429 * Check for partially overlapping buffers. [Binary logical
430 * operations are used instead of boolean to minimize number
431 * of conditional branches.]
433 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
434 (diff > (0 - (PTRDIFF_T)len)));
439 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
440 unsigned char *out, int *outl,
441 const unsigned char *in, int inl)
443 int i, j, bl, cmpl = inl;
445 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
446 cmpl = (cmpl + 7) / 8;
448 bl = ctx->cipher->block_size;
455 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
456 /* If block size > 1 then the cipher will have to do this check */
457 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
458 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
462 i = ctx->cipher->do_cipher(ctx, out, in, inl);
470 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
471 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
475 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
476 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
485 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
488 memcpy(&(ctx->buf[i]), in, inl);
494 memcpy(&(ctx->buf[i]), in, j);
497 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
507 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
513 memcpy(ctx->buf, &(in[inl]), i);
519 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
520 const unsigned char *in, int inl)
525 /* Prevent accidental use of decryption context when encrypting */
527 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
531 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
534 if (ctx->cipher->cupdate == NULL) {
535 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
538 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
540 if (soutl > INT_MAX) {
541 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
547 /* TODO(3.0): Remove legacy code below */
550 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
553 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
556 ret = EVP_EncryptFinal_ex(ctx, out, outl);
560 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
563 unsigned int i, b, bl;
566 /* Prevent accidental use of decryption context when encrypting */
568 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
572 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
575 if (ctx->cipher->cfinal == NULL) {
576 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
580 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
582 if (soutl > INT_MAX) {
583 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
590 /* TODO(3.0): Remove legacy code below */
593 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
594 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
602 b = ctx->cipher->block_size;
603 OPENSSL_assert(b <= sizeof(ctx->buf));
609 if (ctx->flags & EVP_CIPH_NO_PADDING) {
611 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
612 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
620 for (i = bl; i < b; i++)
622 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
630 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
631 const unsigned char *in, int inl)
633 int fix_len, cmpl = inl, ret;
637 /* Prevent accidental use of encryption context when decrypting */
639 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
643 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
646 if (ctx->cipher->cupdate == NULL) {
647 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
650 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
653 if (soutl > INT_MAX) {
654 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
662 /* TODO(3.0): Remove legacy code below */
665 b = ctx->cipher->block_size;
667 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
668 cmpl = (cmpl + 7) / 8;
675 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
676 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
677 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
681 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
690 if (ctx->flags & EVP_CIPH_NO_PADDING)
691 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
693 OPENSSL_assert(b <= sizeof(ctx->final));
695 if (ctx->final_used) {
696 /* see comment about PTRDIFF_T comparison above */
697 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
698 || is_partially_overlapping(out, in, b)) {
699 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
702 memcpy(out, ctx->final, b);
708 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
712 * if we have 'decrypted' a multiple of block size, make sure we have a
713 * copy of this last block
715 if (b > 1 && !ctx->buf_len) {
718 memcpy(ctx->final, &out[*outl], b);
728 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
731 ret = EVP_DecryptFinal_ex(ctx, out, outl);
735 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
742 /* Prevent accidental use of encryption context when decrypting */
744 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
748 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
751 if (ctx->cipher->cfinal == NULL) {
752 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
756 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
759 if (soutl > INT_MAX) {
760 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
768 /* TODO(3.0): Remove legacy code below */
773 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
774 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
782 b = ctx->cipher->block_size;
783 if (ctx->flags & EVP_CIPH_NO_PADDING) {
785 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
786 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
793 if (ctx->buf_len || !ctx->final_used) {
794 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
797 OPENSSL_assert(b <= sizeof(ctx->final));
800 * The following assumes that the ciphertext has been authenticated.
801 * Otherwise it provides a padding oracle.
803 n = ctx->final[b - 1];
804 if (n == 0 || n > (int)b) {
805 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
808 for (i = 0; i < n; i++) {
809 if (ctx->final[--b] != n) {
810 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
814 n = ctx->cipher->block_size - n;
815 for (i = 0; i < n; i++)
816 out[i] = ctx->final[i];
823 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
825 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
826 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
827 if (EVP_CIPHER_CTX_key_length(c) == keylen)
829 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
833 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
837 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
840 ctx->flags &= ~EVP_CIPH_NO_PADDING;
842 ctx->flags |= EVP_CIPH_NO_PADDING;
844 if (ctx->cipher != NULL && ctx->cipher->prov != NULL) {
845 OSSL_PARAM params[] = {
846 OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING, NULL),
850 params[0].data = &pad;
852 if (ctx->cipher->set_params == NULL) {
853 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING, EVP_R_CTRL_NOT_IMPLEMENTED);
857 if (!ctx->cipher->set_params(ctx->provctx, params))
864 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
869 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
873 if (!ctx->cipher->ctrl) {
874 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
878 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
880 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
881 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
887 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
889 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
890 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
891 if (RAND_priv_bytes(key, ctx->key_len) <= 0)
896 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
898 if ((in == NULL) || (in->cipher == NULL)) {
899 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
903 if (in->cipher->prov == NULL)
906 if (in->cipher->dupctx == NULL) {
907 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
911 EVP_CIPHER_CTX_reset(out);
916 if (in->fetched_cipher != NULL || !EVP_CIPHER_upref(in->fetched_cipher)) {
917 out->fetched_cipher = NULL;
921 out->provctx = in->cipher->dupctx(in->provctx);
922 if (out->provctx == NULL) {
923 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
929 /* TODO(3.0): Remove legacy code below */
932 #ifndef OPENSSL_NO_ENGINE
933 /* Make sure it's safe to copy a cipher context using an ENGINE */
934 if (in->engine && !ENGINE_init(in->engine)) {
935 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
940 EVP_CIPHER_CTX_reset(out);
941 memcpy(out, in, sizeof(*out));
943 if (in->cipher_data && in->cipher->ctx_size) {
944 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
945 if (out->cipher_data == NULL) {
947 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
950 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
953 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
954 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
956 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
962 static void *evp_cipher_from_dispatch(int nid, const OSSL_DISPATCH *fns,
965 EVP_CIPHER *cipher = NULL;
966 int fnciphcnt = 0, fnctxcnt = 0;
968 if ((cipher = EVP_CIPHER_meth_new(nid, 0, 0)) == NULL)
971 for (; fns->function_id != 0; fns++) {
972 switch (fns->function_id) {
973 case OSSL_FUNC_CIPHER_NEWCTX:
974 if (cipher->newctx != NULL)
976 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
979 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
980 if (cipher->einit != NULL)
982 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
985 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
986 if (cipher->dinit != NULL)
988 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
991 case OSSL_FUNC_CIPHER_UPDATE:
992 if (cipher->cupdate != NULL)
994 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
997 case OSSL_FUNC_CIPHER_FINAL:
998 if (cipher->cfinal != NULL)
1000 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1003 case OSSL_FUNC_CIPHER_FREECTX:
1004 if (cipher->freectx != NULL)
1006 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1009 case OSSL_FUNC_CIPHER_DUPCTX:
1010 if (cipher->dupctx != NULL)
1012 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1014 case OSSL_FUNC_CIPHER_KEY_LENGTH:
1015 if (cipher->key_length != NULL)
1017 cipher->key_length = OSSL_get_OP_cipher_key_length(fns);
1019 case OSSL_FUNC_CIPHER_GET_PARAMS:
1020 if (cipher->get_params != NULL)
1022 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1024 case OSSL_FUNC_CIPHER_SET_PARAMS:
1025 if (cipher->set_params != NULL)
1027 cipher->set_params = OSSL_get_OP_cipher_set_params(fns);
1031 if ((fnciphcnt != 3 && fnciphcnt != 4)
1034 * In order to be a consistent set of functions we must have at least
1035 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1036 * functions. In both cases we need a complete set of context management
1039 EVP_CIPHER_meth_free(cipher);
1040 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1043 cipher->prov = prov;
1045 ossl_provider_upref(prov);
1050 static int evp_cipher_upref(void *cipher)
1052 return EVP_CIPHER_upref(cipher);
1055 static void evp_cipher_free(void *cipher)
1057 EVP_CIPHER_meth_free(cipher);
1060 static int evp_cipher_nid(void *vcipher)
1062 EVP_CIPHER *cipher = vcipher;
1067 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1068 const char *properties)
1070 return evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1071 evp_cipher_from_dispatch, evp_cipher_upref,
1072 evp_cipher_free, evp_cipher_nid);