1 /* $OpenBSD: evp_enc.c,v 1.31 2016/05/30 13:42:54 beck Exp $ */
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.]
63 #include <openssl/opensslconf.h>
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
68 #ifndef OPENSSL_NO_ENGINE
69 #include <openssl/engine.h>
74 #define M_do_cipher(ctx, out, in, inl) ctx->cipher->do_cipher(ctx, out, in, inl)
77 EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx)
79 memset(ctx, 0, sizeof(EVP_CIPHER_CTX));
83 EVP_CIPHER_CTX_new(void)
85 return calloc(1, sizeof(EVP_CIPHER_CTX));
89 EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
90 const unsigned char *key, const unsigned char *iv, int enc)
93 EVP_CIPHER_CTX_init(ctx);
94 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
98 EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
99 const unsigned char *key, const unsigned char *iv, int enc)
108 #ifndef OPENSSL_NO_ENGINE
109 /* Whether it's nice or not, "Inits" can be used on "Final"'d contexts
110 * so this context may already have an ENGINE! Try to avoid releasing
111 * the previous handle, re-querying for an ENGINE, and having a
112 * reinitialisation, when it may all be unecessary. */
113 if (ctx->engine && ctx->cipher &&
114 (!cipher || (cipher && (cipher->nid == ctx->cipher->nid))))
118 /* Ensure a context left lying around from last time is cleared
119 * (the previous check attempted to avoid this if the same
120 * ENGINE and EVP_CIPHER could be used). */
122 unsigned long flags = ctx->flags;
123 EVP_CIPHER_CTX_cleanup(ctx);
124 /* Restore encrypt and flags */
128 #ifndef OPENSSL_NO_ENGINE
130 if (!ENGINE_init(impl)) {
131 EVPerr(EVP_F_EVP_CIPHERINIT_EX,
132 EVP_R_INITIALIZATION_ERROR);
136 /* Ask if an ENGINE is reserved for this job */
137 impl = ENGINE_get_cipher_engine(cipher->nid);
139 /* There's an ENGINE for this job ... (apparently) */
140 const EVP_CIPHER *c =
141 ENGINE_get_cipher(impl, cipher->nid);
143 EVPerr(EVP_F_EVP_CIPHERINIT_EX,
144 EVP_R_INITIALIZATION_ERROR);
147 /* We'll use the ENGINE's private cipher definition */
149 /* Store the ENGINE functional reference so we know
150 * 'cipher' came from an ENGINE and we need to release
157 ctx->cipher = cipher;
158 if (ctx->cipher->ctx_size) {
159 ctx->cipher_data = malloc(ctx->cipher->ctx_size);
160 if (!ctx->cipher_data) {
161 EVPerr(EVP_F_EVP_CIPHERINIT_EX,
162 ERR_R_MALLOC_FAILURE);
166 ctx->cipher_data = NULL;
168 ctx->key_len = cipher->key_len;
170 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
171 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
172 EVPerr(EVP_F_EVP_CIPHERINIT_EX,
173 EVP_R_INITIALIZATION_ERROR);
177 } else if (!ctx->cipher) {
178 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
181 #ifndef OPENSSL_NO_ENGINE
184 /* we assume block size is a power of 2 in *cryptUpdate */
185 if (ctx->cipher->block_size != 1 &&
186 ctx->cipher->block_size != 8 &&
187 ctx->cipher->block_size != 16) {
188 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_BAD_BLOCK_LENGTH);
192 if (!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
193 switch (EVP_CIPHER_CTX_mode(ctx)) {
195 case EVP_CIPH_STREAM_CIPHER:
196 case EVP_CIPH_ECB_MODE:
199 case EVP_CIPH_CFB_MODE:
200 case EVP_CIPH_OFB_MODE:
205 case EVP_CIPH_CBC_MODE:
207 if ((size_t)EVP_CIPHER_CTX_iv_length(ctx) >
209 EVPerr(EVP_F_EVP_CIPHERINIT_EX,
215 EVP_CIPHER_CTX_iv_length(ctx));
216 memcpy(ctx->iv, ctx->oiv,
217 EVP_CIPHER_CTX_iv_length(ctx));
220 case EVP_CIPH_CTR_MODE:
222 /* Don't reuse IV for CTR mode */
225 EVP_CIPHER_CTX_iv_length(ctx));
234 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
235 if (!ctx->cipher->init(ctx, key, iv, enc))
240 ctx->block_mask = ctx->cipher->block_size - 1;
245 EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
246 const unsigned char *in, int inl)
249 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
251 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
255 EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
258 return EVP_EncryptFinal_ex(ctx, out, outl);
260 return EVP_DecryptFinal_ex(ctx, out, outl);
264 EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
267 return EVP_EncryptFinal_ex(ctx, out, outl);
269 return EVP_DecryptFinal_ex(ctx, out, outl);
273 EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
274 const unsigned char *key, const unsigned char *iv)
276 return EVP_CipherInit(ctx, cipher, key, iv, 1);
280 EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
281 const unsigned char *key, const unsigned char *iv)
283 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
287 EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
288 const unsigned char *key, const unsigned char *iv)
290 return EVP_CipherInit(ctx, cipher, key, iv, 0);
294 EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
295 const unsigned char *key, const unsigned char *iv)
297 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
301 EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
302 const unsigned char *in, int inl)
306 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
307 i = M_do_cipher(ctx, out, in, inl);
320 if (ctx->buf_len == 0 && (inl&(ctx->block_mask)) == 0) {
321 if (M_do_cipher(ctx, out, in, inl)) {
330 bl = ctx->cipher->block_size;
331 if ((size_t)bl > sizeof(ctx->buf)) {
332 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_BAD_BLOCK_LENGTH);
338 memcpy(&(ctx->buf[i]), in, inl);
344 memcpy(&(ctx->buf[i]), in, j);
345 if (!M_do_cipher(ctx, out, ctx->buf, bl))
357 if (!M_do_cipher(ctx, out, in, inl))
363 memcpy(ctx->buf, &(in[inl]), i);
369 EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
373 ret = EVP_EncryptFinal_ex(ctx, out, outl);
378 EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
381 unsigned int i, b, bl;
383 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
384 ret = M_do_cipher(ctx, out, NULL, 0);
392 b = ctx->cipher->block_size;
393 if (b > sizeof ctx->buf) {
394 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_BAD_BLOCK_LENGTH);
402 if (ctx->flags & EVP_CIPH_NO_PADDING) {
404 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
405 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
413 for (i = bl; i < b; i++)
415 ret = M_do_cipher(ctx, out, ctx->buf, b);
425 EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
426 const unsigned char *in, int inl)
431 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
432 fix_len = M_do_cipher(ctx, out, in, inl);
446 if (ctx->flags & EVP_CIPH_NO_PADDING)
447 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
449 b = ctx->cipher->block_size;
450 if (b > sizeof ctx->final) {
451 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_BAD_BLOCK_LENGTH);
455 if (ctx->final_used) {
456 memcpy(out, ctx->final, b);
463 if (!EVP_EncryptUpdate(ctx, out, outl, in, inl))
466 /* if we have 'decrypted' a multiple of block size, make sure
467 * we have a copy of this last block */
468 if (b > 1 && !ctx->buf_len) {
471 memcpy(ctx->final, &out[*outl], b);
482 EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
486 ret = EVP_DecryptFinal_ex(ctx, out, outl);
491 EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
497 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
498 i = M_do_cipher(ctx, out, NULL, 0);
506 b = ctx->cipher->block_size;
507 if (ctx->flags & EVP_CIPH_NO_PADDING) {
509 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
510 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
517 if (ctx->buf_len || !ctx->final_used) {
518 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
519 EVP_R_WRONG_FINAL_BLOCK_LENGTH);
522 if (b > sizeof ctx->final) {
523 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
524 EVP_R_BAD_BLOCK_LENGTH);
527 n = ctx->final[b - 1];
528 if (n == 0 || n > (int)b) {
529 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
532 for (i = 0; i < n; i++) {
533 if (ctx->final[--b] != n) {
534 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
539 n = ctx->cipher->block_size - n;
540 for (i = 0; i < n; i++)
541 out[i] = ctx->final[i];
549 EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
552 EVP_CIPHER_CTX_cleanup(ctx);
558 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 explicit_bzero(c->cipher_data, c->cipher->ctx_size);
567 free(c->cipher_data);
568 #ifndef OPENSSL_NO_ENGINE
570 /* The EVP_CIPHER we used belongs to an ENGINE, release the
571 * functional reference we held for this reason. */
572 ENGINE_finish(c->engine);
574 explicit_bzero(c, sizeof(EVP_CIPHER_CTX));
579 EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
581 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
582 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH,
584 if (c->key_len == keylen)
586 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
590 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
595 EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
598 ctx->flags &= ~EVP_CIPH_NO_PADDING;
600 ctx->flags |= EVP_CIPH_NO_PADDING;
605 EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
610 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
614 if (!ctx->cipher->ctrl) {
615 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
619 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
621 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
622 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
629 EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
631 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
632 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
633 arc4random_buf(key, ctx->key_len);
638 EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
640 if ((in == NULL) || (in->cipher == NULL)) {
641 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
644 #ifndef OPENSSL_NO_ENGINE
645 /* Make sure it's safe to copy a cipher context using an ENGINE */
646 if (in->engine && !ENGINE_init(in->engine)) {
647 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
652 EVP_CIPHER_CTX_cleanup(out);
653 memcpy(out, in, sizeof *out);
655 if (in->cipher_data && in->cipher->ctx_size) {
656 out->cipher_data = malloc(in->cipher->ctx_size);
657 if (!out->cipher_data) {
658 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
661 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
664 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
665 return in->cipher->ctrl((EVP_CIPHER_CTX *)in,
666 EVP_CTRL_COPY, 0, out);