1 /* crypto/evp/evp_enc.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
61 #include <openssl/evp.h>
62 #include <openssl/err.h>
63 #include <openssl/rand.h>
64 #ifndef OPENSSL_NO_ENGINE
65 # include <openssl/engine.h>
68 # include <openssl/fips.h>
73 # define M_do_cipher(ctx, out, in, inl) FIPS_cipher(ctx, out, in, inl)
75 # define M_do_cipher(ctx, out, in, inl) ctx->cipher->do_cipher(ctx, out, in, inl)
78 const char EVP_version[] = "EVP" OPENSSL_VERSION_PTEXT;
80 void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx)
82 memset(ctx, 0, sizeof(EVP_CIPHER_CTX));
83 /* ctx->cipher=NULL; */
86 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
88 EVP_CIPHER_CTX *ctx = OPENSSL_malloc(sizeof(*ctx));
90 EVP_CIPHER_CTX_init(ctx);
94 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
95 const unsigned char *key, const unsigned char *iv, int enc)
98 EVP_CIPHER_CTX_init(ctx);
99 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
102 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
103 ENGINE *impl, const unsigned char *key,
104 const unsigned char *iv, int enc)
113 #ifndef OPENSSL_NO_ENGINE
115 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
116 * this context may already have an ENGINE! Try to avoid releasing the
117 * previous handle, re-querying for an ENGINE, and having a
118 * reinitialisation, when it may all be unecessary.
120 if (ctx->engine && ctx->cipher && (!cipher ||
128 * Ensure a context left lying around from last time is cleared (the
129 * previous check attempted to avoid this if the same ENGINE and
130 * EVP_CIPHER could be used).
133 unsigned long flags = ctx->flags;
134 EVP_CIPHER_CTX_cleanup(ctx);
135 /* Restore encrypt and flags */
139 #ifndef OPENSSL_NO_ENGINE
141 if (!ENGINE_init(impl)) {
142 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
146 /* Ask if an ENGINE is reserved for this job */
147 impl = ENGINE_get_cipher_engine(cipher->nid);
149 /* There's an ENGINE for this job ... (apparently) */
150 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
153 * One positive side-effect of US's export control history,
154 * is that we should at least be able to avoid using US
155 * mispellings of "initialisation"?
157 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
160 /* We'll use the ENGINE's private cipher definition */
163 * Store the ENGINE functional reference so we know 'cipher' came
164 * from an ENGINE and we need to release it when done.
173 const EVP_CIPHER *fcipher = NULL;
175 fcipher = evp_get_fips_cipher(cipher);
178 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
181 ctx->cipher = cipher;
182 if (ctx->cipher->ctx_size) {
183 ctx->cipher_data = OPENSSL_malloc(ctx->cipher->ctx_size);
184 if (!ctx->cipher_data) {
186 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
190 ctx->cipher_data = NULL;
192 ctx->key_len = cipher->key_len;
193 /* Preserve wrap enable flag, zero everything else */
194 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
195 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
196 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
198 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
202 } else if (!ctx->cipher) {
203 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
206 #ifndef OPENSSL_NO_ENGINE
211 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
213 /* we assume block size is a power of 2 in *cryptUpdate */
214 OPENSSL_assert(ctx->cipher->block_size == 1
215 || ctx->cipher->block_size == 8
216 || ctx->cipher->block_size == 16);
218 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
219 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
220 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
224 if (!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
225 switch (EVP_CIPHER_CTX_mode(ctx)) {
227 case EVP_CIPH_STREAM_CIPHER:
228 case EVP_CIPH_ECB_MODE:
231 case EVP_CIPH_CFB_MODE:
232 case EVP_CIPH_OFB_MODE:
237 case EVP_CIPH_CBC_MODE:
239 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
240 (int)sizeof(ctx->iv));
242 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
243 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
246 case EVP_CIPH_CTR_MODE:
248 /* Don't reuse IV for CTR mode */
250 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
259 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
260 if (!ctx->cipher->init(ctx, key, iv, enc))
265 ctx->block_mask = ctx->cipher->block_size - 1;
269 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
270 const unsigned char *in, int inl)
273 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
275 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
278 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
281 return EVP_EncryptFinal_ex(ctx, out, outl);
283 return EVP_DecryptFinal_ex(ctx, out, outl);
286 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
289 return EVP_EncryptFinal(ctx, out, outl);
291 return EVP_DecryptFinal(ctx, out, outl);
294 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
295 const unsigned char *key, const unsigned char *iv)
297 return EVP_CipherInit(ctx, cipher, key, iv, 1);
300 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
301 ENGINE *impl, const unsigned char *key,
302 const unsigned char *iv)
304 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
307 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
308 const unsigned char *key, const unsigned char *iv)
310 return EVP_CipherInit(ctx, cipher, key, iv, 0);
313 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
314 ENGINE *impl, const unsigned char *key,
315 const unsigned char *iv)
317 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
320 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
321 const unsigned char *in, int inl)
325 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
326 i = M_do_cipher(ctx, out, in, inl);
339 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
340 if (M_do_cipher(ctx, out, in, inl)) {
349 bl = ctx->cipher->block_size;
350 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
353 memcpy(&(ctx->buf[i]), in, inl);
359 memcpy(&(ctx->buf[i]), in, j);
360 if (!M_do_cipher(ctx, out, ctx->buf, bl))
372 if (!M_do_cipher(ctx, out, in, inl))
378 memcpy(ctx->buf, &(in[inl]), i);
383 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
386 ret = EVP_EncryptFinal_ex(ctx, out, outl);
390 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
393 unsigned int i, b, bl;
395 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
396 ret = M_do_cipher(ctx, out, NULL, 0);
404 b = ctx->cipher->block_size;
405 OPENSSL_assert(b <= sizeof(ctx->buf));
411 if (ctx->flags & EVP_CIPH_NO_PADDING) {
413 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
414 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
422 for (i = bl; i < b; i++)
424 ret = M_do_cipher(ctx, out, ctx->buf, b);
432 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
433 const unsigned char *in, int inl)
438 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
439 fix_len = M_do_cipher(ctx, out, in, inl);
453 if (ctx->flags & EVP_CIPH_NO_PADDING)
454 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
456 b = ctx->cipher->block_size;
457 OPENSSL_assert(b <= sizeof(ctx->final));
459 if (ctx->final_used) {
460 memcpy(out, ctx->final, b);
466 if (!EVP_EncryptUpdate(ctx, out, outl, in, inl))
470 * if we have 'decrypted' a multiple of block size, make sure we have a
471 * copy of this last block
473 if (b > 1 && !ctx->buf_len) {
476 memcpy(ctx->final, &out[*outl], b);
486 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
489 ret = EVP_DecryptFinal_ex(ctx, out, outl);
493 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
499 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
500 i = M_do_cipher(ctx, out, NULL, 0);
508 b = ctx->cipher->block_size;
509 if (ctx->flags & EVP_CIPH_NO_PADDING) {
511 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
512 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
519 if (ctx->buf_len || !ctx->final_used) {
520 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
523 OPENSSL_assert(b <= sizeof(ctx->final));
526 * The following assumes that the ciphertext has been authenticated.
527 * Otherwise it provides a padding oracle.
529 n = ctx->final[b - 1];
530 if (n == 0 || n > (int)b) {
531 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
534 for (i = 0; i < n; i++) {
535 if (ctx->final[--b] != n) {
536 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
540 n = ctx->cipher->block_size - n;
541 for (i = 0; i < n; i++)
542 out[i] = ctx->final[i];
549 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
552 EVP_CIPHER_CTX_cleanup(ctx);
557 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *c)
560 if (c->cipher != NULL) {
561 if (c->cipher->cleanup && !c->cipher->cleanup(c))
563 /* Cleanse cipher context data */
565 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
568 OPENSSL_free(c->cipher_data);
570 #ifndef OPENSSL_NO_ENGINE
573 * The EVP_CIPHER we used belongs to an ENGINE, release the
574 * functional reference we held for this reason.
576 ENGINE_finish(c->engine);
579 FIPS_cipher_ctx_cleanup(c);
581 memset(c, 0, sizeof(EVP_CIPHER_CTX));
585 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
587 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
588 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
589 if (c->key_len == keylen)
591 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
595 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
599 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
602 ctx->flags &= ~EVP_CIPH_NO_PADDING;
604 ctx->flags |= EVP_CIPH_NO_PADDING;
608 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
612 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
616 if (!ctx->cipher->ctrl) {
617 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
621 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
623 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
624 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
630 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
632 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
633 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
634 if (RAND_bytes(key, ctx->key_len) <= 0)
639 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
641 if ((in == NULL) || (in->cipher == NULL)) {
642 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
645 #ifndef OPENSSL_NO_ENGINE
646 /* Make sure it's safe to copy a cipher context using an ENGINE */
647 if (in->engine && !ENGINE_init(in->engine)) {
648 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
653 EVP_CIPHER_CTX_cleanup(out);
654 memcpy(out, in, sizeof(*out));
656 if (in->cipher_data && in->cipher->ctx_size) {
657 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
658 if (!out->cipher_data) {
660 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
663 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
666 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
667 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
669 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);