blob: 9c498e8cf2174603f9b0570b31751add93a4f0d6 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.] */
56
57#ifndef OPENSSL_HEADER_CIPHER_H
58#define OPENSSL_HEADER_CIPHER_H
59
60#include <openssl/base.h>
61
62#if defined(__cplusplus)
63extern "C" {
64#endif
65
66
67/* Ciphers. */
68
69
70/* Cipher primitives.
71 *
72 * The following functions return |EVP_CIPHER| objects that implement the named
73 * cipher algorithm. */
74
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070075OPENSSL_EXPORT const EVP_CIPHER *EVP_rc4(void);
Adam Langley95c29f32014-06-20 12:00:00 -070076
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070077OPENSSL_EXPORT const EVP_CIPHER *EVP_des_cbc(void);
78OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ede3_cbc(void);
Adam Langley95c29f32014-06-20 12:00:00 -070079
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070080OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_ecb(void);
81OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_cbc(void);
82OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_ctr(void);
Adam Langley95c29f32014-06-20 12:00:00 -070083
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070084OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ecb(void);
85OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_cbc(void);
86OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ctr(void);
David Benjamin4841ce42014-12-15 03:59:02 -050087
88/* Deprecated AES-GCM implementations that set |EVP_CIPH_FLAG_CUSTOM_CIPHER|.
89 * Use |EVP_aead_aes_128_gcm| and |EVP_aead_aes_256_gcm| instead. */
90OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_gcm(void);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070091OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_gcm(void);
Adam Langley95c29f32014-06-20 12:00:00 -070092
93/* EVP_enc_null returns a 'cipher' that passes plaintext through as
94 * ciphertext. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070095OPENSSL_EXPORT const EVP_CIPHER *EVP_enc_null(void);
Adam Langley95c29f32014-06-20 12:00:00 -070096
Adam Langleycc8fcf42014-08-21 10:48:32 -070097/* EVP_rc2_40_cbc returns a cipher that implements 40-bit RC2 in CBC mode. This
98 * is obviously very, very weak and is included only in order to read PKCS#12
99 * files, which often encrypt the certificate chain using this cipher. It is
100 * deliberately not exported. */
101const EVP_CIPHER *EVP_rc2_40_cbc(void);
102
Adam Langley95c29f32014-06-20 12:00:00 -0700103/* EVP_get_cipherbynid returns the cipher corresponding to the given NID, or
104 * NULL if no such cipher is known. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700105OPENSSL_EXPORT const EVP_CIPHER *EVP_get_cipherbynid(int nid);
Adam Langley95c29f32014-06-20 12:00:00 -0700106
107
108/* Cipher context allocation.
109 *
110 * An |EVP_CIPHER_CTX| represents the state of an encryption or decryption in
111 * progress. */
112
113/* EVP_CIPHER_CTX_init initialises an, already allocated, |EVP_CIPHER_CTX|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700114OPENSSL_EXPORT void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700115
116/* EVP_CIPHER_CTX_new allocates a fresh |EVP_CIPHER_CTX|, calls
117 * |EVP_CIPHER_CTX_init| and returns it, or NULL on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700118OPENSSL_EXPORT EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700119
120/* EVP_CIPHER_CTX_cleanup frees any memory referenced by |ctx|. It returns one
121 * on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700122OPENSSL_EXPORT int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700123
124/* EVP_CIPHER_CTX_free calls |EVP_CIPHER_CTX_cleanup| on |ctx| and then frees
125 * |ctx| itself. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700126OPENSSL_EXPORT void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700127
128/* EVP_CIPHER_CTX_copy sets |out| to be a duplicate of the current state of
129 * |in|. The |out| argument must have been previously initialised. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700130OPENSSL_EXPORT int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out,
131 const EVP_CIPHER_CTX *in);
Adam Langley95c29f32014-06-20 12:00:00 -0700132
133
134/* Cipher context configuration. */
135
136/* EVP_CipherInit_ex configures |ctx| for a fresh encryption (or decryption, if
137 * |enc| is zero) operation using |cipher|. If |ctx| has been previously
138 * configured with a cipher then |cipher|, |key| and |iv| may be |NULL| and
139 * |enc| may be -1 to reuse the previous values. The operation will use |key|
140 * as the key and |iv| as the IV (if any). These should have the correct
141 * lengths given by |EVP_CIPHER_key_length| and |EVP_CIPHER_iv_length|. It
142 * returns one on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700143OPENSSL_EXPORT int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx,
144 const EVP_CIPHER *cipher, ENGINE *engine,
145 const uint8_t *key, const uint8_t *iv,
146 int enc);
Adam Langley95c29f32014-06-20 12:00:00 -0700147
148/* EVP_EncryptInit_ex calls |EVP_CipherInit_ex| with |enc| equal to one. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700149OPENSSL_EXPORT int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx,
150 const EVP_CIPHER *cipher, ENGINE *impl,
151 const uint8_t *key, const uint8_t *iv);
Adam Langley95c29f32014-06-20 12:00:00 -0700152
153/* EVP_DecryptInit_ex calls |EVP_CipherInit_ex| with |enc| equal to zero. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700154OPENSSL_EXPORT int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx,
155 const EVP_CIPHER *cipher, ENGINE *impl,
156 const uint8_t *key, const uint8_t *iv);
Adam Langley95c29f32014-06-20 12:00:00 -0700157
158
159/* Cipher operations. */
160
161/* EVP_EncryptUpdate encrypts |in_len| bytes from |in| to |out|. The number
162 * of output bytes may be up to |in_len| plus the block length minus one and
163 * |out| must have sufficient space. The number of bytes actually output is
164 * written to |*out_len|. It returns one on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700165OPENSSL_EXPORT int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out,
166 int *out_len, const uint8_t *in,
167 int in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700168
169/* EVP_EncryptFinal_ex writes at most a block of ciphertext to |out| and sets
170 * |*out_len| to the number of bytes written. If padding is enabled (the
171 * default) then standard padding is applied to create the final block. If
172 * padding is disabled (with |EVP_CIPHER_CTX_set_padding|) then any partial
173 * block remaining will cause an error. The function returns one on success and
174 * zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700175OPENSSL_EXPORT int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out,
176 int *out_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700177
178/* EVP_DecryptUpdate decrypts |in_len| bytes from |in| to |out|. The number of
179 * output bytes may be up to |in_len| plus the block length minus one and |out|
180 * must have sufficient space. The number of bytes actually output is written
181 * to |*out_len|. It returns one on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700182OPENSSL_EXPORT int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out,
183 int *out_len, const uint8_t *in,
184 int in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700185
186/* EVP_DecryptFinal_ex writes at most a block of ciphertext to |out| and sets
187 * |*out_len| to the number of bytes written. If padding is enabled (the
188 * default) then padding is removed from the final block.
189 *
190 * WARNING: it is unsafe to call this function with unauthenticted
191 * ciphertext if padding is enabled. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700192OPENSSL_EXPORT int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out,
193 int *out_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700194
195/* EVP_Cipher performs a one-shot encryption/decryption operation. No partial
David Benjamin4841ce42014-12-15 03:59:02 -0500196 * blocks etc are maintained between calls. It returns one on success and zero
197 * otherwise, unless |EVP_CIPHER_flags| has |EVP_CIPH_FLAG_CUSTOM_CIPHER|
198 * set. Then it returns the number of bytes written or -1 on error.
Adam Langley95c29f32014-06-20 12:00:00 -0700199 *
David Benjamin4841ce42014-12-15 03:59:02 -0500200 * WARNING: this differs from the usual return value convention when using
201 * |EVP_CIPH_FLAG_CUSTOM_CIPHER|.
202 *
203 * TODO(davidben): The normal ciphers currently never fail, even if, e.g.,
204 * |in_len| is not a multiple of the block size for CBC-mode decryption. The
205 * input just gets rounded up while the output gets truncated. This should
206 * either be officially documented or fail. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700207OPENSSL_EXPORT int EVP_Cipher(EVP_CIPHER_CTX *ctx, uint8_t *out,
208 const uint8_t *in, size_t in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700209
210/* EVP_CipherUpdate calls either |EVP_EncryptUpdate| or |EVP_DecryptUpdate|
211 * depending on how |ctx| has been setup. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700212OPENSSL_EXPORT int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out,
213 int *out_len, const uint8_t *in,
214 int in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700215
216/* EVP_CipherFinal_ex calls either |EVP_EncryptFinal_ex| or
217 * |EVP_DecryptFinal_ex| depending on how |ctx| has been setup. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700218OPENSSL_EXPORT int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out,
219 int *out_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700220
221
222/* Cipher context accessors. */
223
224/* EVP_CIPHER_CTX_cipher returns the |EVP_CIPHER| underlying |ctx|, or NULL if
225 * none has been set. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700226OPENSSL_EXPORT const EVP_CIPHER *EVP_CIPHER_CTX_cipher(
227 const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700228
229/* EVP_CIPHER_CTX_nid returns a NID identifying the |EVP_CIPHER| underlying
230 * |ctx| (e.g. |NID_rc4|). It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700231OPENSSL_EXPORT int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700232
233/* EVP_CIPHER_CTX_block_size returns the block size, in bytes, of the cipher
234 * underlying |ctx|, or one if the cipher is a stream cipher. It will crash if
235 * no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700236OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700237
238/* EVP_CIPHER_CTX_key_length returns the key size, in bytes, of the cipher
239 * underlying |ctx| or zero if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700240OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700241
242/* EVP_CIPHER_CTX_iv_length returns the IV size, in bytes, of the cipher
243 * underlying |ctx|. It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700244OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700245
246/* EVP_CIPHER_CTX_get_app_data returns the opaque, application data pointer for
247 * |ctx|, or NULL if none has been set. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700248OPENSSL_EXPORT void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700249
250/* EVP_CIPHER_CTX_set_app_data sets the opaque, application data pointer for
251 * |ctx| to |data|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700252OPENSSL_EXPORT void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx,
253 void *data);
Adam Langley95c29f32014-06-20 12:00:00 -0700254
255/* EVP_CIPHER_CTX_flags returns a value which is the OR of zero or more
256 * |EVP_CIPH_*| flags. It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700257OPENSSL_EXPORT uint32_t EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700258
259/* EVP_CIPHER_CTX_mode returns one of the |EVP_CIPH_*| cipher mode values
260 * enumerated below. It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700261OPENSSL_EXPORT uint32_t EVP_CIPHER_CTX_mode(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700262
263/* EVP_CIPHER_CTX_ctrl is an |ioctl| like function. The |command| argument
264 * should be one of the |EVP_CTRL_*| values. The |arg| and |ptr| arguments are
265 * specific to the command in question. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700266OPENSSL_EXPORT int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int command,
267 int arg, void *ptr);
Adam Langley95c29f32014-06-20 12:00:00 -0700268
269/* EVP_CIPHER_CTX_set_padding sets whether padding is enabled for |ctx| and
270 * returns one. Pass a non-zero |pad| to enable padding (the default) or zero
271 * to disable. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700272OPENSSL_EXPORT int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad);
Adam Langley95c29f32014-06-20 12:00:00 -0700273
Adam Langley539112f2014-08-22 11:06:41 -0700274/* EVP_CIPHER_CTX_set_key_length sets the key length for |ctx|. This is only
275 * valid for ciphers that can take a variable length key. It returns one on
276 * success and zero on error. */
277OPENSSL_EXPORT int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *ctx, unsigned key_len);
278
Adam Langley95c29f32014-06-20 12:00:00 -0700279
280/* Cipher accessors. */
281
282/* EVP_CIPHER_nid returns a NID identifing |cipher|. (For example,
283 * |NID_rc4|.) */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700284OPENSSL_EXPORT int EVP_CIPHER_nid(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700285
286/* EVP_CIPHER_name returns the short name for |cipher| or NULL if no name is
287 * known. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700288OPENSSL_EXPORT const char *EVP_CIPHER_name(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700289
290/* EVP_CIPHER_block_size returns the block size, in bytes, for |cipher|, or one
291 * if |cipher| is a stream cipher. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700292OPENSSL_EXPORT unsigned EVP_CIPHER_block_size(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700293
294/* EVP_CIPHER_key_length returns the key size, in bytes, for |cipher|. If
295 * |cipher| can take a variable key length then this function returns the
296 * default key length and |EVP_CIPHER_flags| will return a value with
297 * |EVP_CIPH_VARIABLE_LENGTH| set. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700298OPENSSL_EXPORT unsigned EVP_CIPHER_key_length(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700299
300/* EVP_CIPHER_iv_length returns the IV size, in bytes, of |cipher|, or zero if
301 * |cipher| doesn't take an IV. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700302OPENSSL_EXPORT unsigned EVP_CIPHER_iv_length(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700303
304/* EVP_CIPHER_flags returns a value which is the OR of zero or more
305 * |EVP_CIPH_*| flags. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700306OPENSSL_EXPORT uint32_t EVP_CIPHER_flags(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700307
308/* EVP_CIPHER_mode returns one of the cipher mode values enumerated below. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700309OPENSSL_EXPORT uint32_t EVP_CIPHER_mode(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700310
311
312/* Key derivation. */
313
314/* EVP_BytesToKey generates a key and IV for the cipher |type| by iterating
315 * |md| |count| times using |data| and |salt|. On entry, the |key| and |iv|
316 * buffers must have enough space to hold a key and IV for |type|. It returns
317 * the length of the key on success or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700318OPENSSL_EXPORT int EVP_BytesToKey(const EVP_CIPHER *type, const EVP_MD *md,
319 const uint8_t *salt, const uint8_t *data,
320 size_t data_len, unsigned count, uint8_t *key,
321 uint8_t *iv);
Adam Langley95c29f32014-06-20 12:00:00 -0700322
323
324/* Cipher modes (for |EVP_CIPHER_mode|). */
325
326#define EVP_CIPH_STREAM_CIPHER 0x0
327#define EVP_CIPH_ECB_MODE 0x1
328#define EVP_CIPH_CBC_MODE 0x2
329#define EVP_CIPH_CFB_MODE 0x3
330#define EVP_CIPH_OFB_MODE 0x4
331#define EVP_CIPH_CTR_MODE 0x5
332#define EVP_CIPH_GCM_MODE 0x6
333
334
335/* Cipher flags (for |EVP_CIPHER_flags|). */
336
337/* EVP_CIPH_VARIABLE_LENGTH indicates that the cipher takes a variable length
338 * key. */
339#define EVP_CIPH_VARIABLE_LENGTH 0x40
340
341/* EVP_CIPH_ALWAYS_CALL_INIT indicates that the |init| function for the cipher
342 * should always be called when initialising a new operation, even if the key
343 * is NULL to indicate that the same key is being used. */
344#define EVP_CIPH_ALWAYS_CALL_INIT 0x80
345
346/* EVP_CIPH_CUSTOM_IV indicates that the cipher manages the IV itself rather
347 * than keeping it in the |iv| member of |EVP_CIPHER_CTX|. */
348#define EVP_CIPH_CUSTOM_IV 0x100
349
350/* EVP_CIPH_CTRL_INIT indicates that EVP_CTRL_INIT should be used when
351 * initialising an |EVP_CIPHER_CTX|. */
352#define EVP_CIPH_CTRL_INIT 0x200
353
354/* EVP_CIPH_FLAG_CUSTOM_CIPHER indicates that the cipher manages blocking
355 * itself. This causes EVP_(En|De)crypt_ex to be simple wrapper functions. */
356#define EVP_CIPH_FLAG_CUSTOM_CIPHER 0x400
357
358/* EVP_CIPH_FLAG_AEAD_CIPHER specifies that the cipher is an AEAD. This is an
359 * older version of the proper AEAD interface. See aead.h for the current
360 * one. */
361#define EVP_CIPH_FLAG_AEAD_CIPHER 0x800
362
Adam Langley7578f3f2014-07-24 17:42:11 -0700363/* EVP_CIPH_CUSTOM_COPY indicates that the |ctrl| callback should be called
364 * with |EVP_CTRL_COPY| at the end of normal |EVP_CIPHER_CTX_copy|
365 * processing. */
366#define EVP_CIPH_CUSTOM_COPY 0x1000
367
Adam Langley95c29f32014-06-20 12:00:00 -0700368
Adam Langley704453f2014-09-23 16:19:16 -0700369/* Deprecated functions */
370
371/* EVP_CipherInit acts like EVP_CipherInit_ex except that |EVP_CIPHER_CTX_init|
372 * is called on |cipher| first, if |cipher| is not NULL. */
373OPENSSL_EXPORT int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
374 const uint8_t *key, const uint8_t *iv,
375 int enc);
376
377/* EVP_EncryptInit calls |EVP_CipherInit| with |enc| equal to one. */
378OPENSSL_EXPORT int EVP_EncryptInit(EVP_CIPHER_CTX *ctx,
379 const EVP_CIPHER *cipher, const uint8_t *key,
380 const uint8_t *iv);
381
382/* EVP_DecryptInit calls |EVP_CipherInit| with |enc| equal to zero. */
383OPENSSL_EXPORT int EVP_DecryptInit(EVP_CIPHER_CTX *ctx,
384 const EVP_CIPHER *cipher, const uint8_t *key,
385 const uint8_t *iv);
386
387/* EVP_add_cipher_alias does nothing and returns one. */
388OPENSSL_EXPORT int EVP_add_cipher_alias(const char *a, const char *b);
389
390/* EVP_get_cipherbyname returns an |EVP_CIPHER| given a human readable name in
391 * |name|, or NULL if the name is unknown. */
392OPENSSL_EXPORT const EVP_CIPHER *EVP_get_cipherbyname(const char *name);
393
394
Adam Langley95c29f32014-06-20 12:00:00 -0700395/* Private functions. */
396
397/* EVP_CIPH_NO_PADDING disables padding in block ciphers. */
398#define EVP_CIPH_NO_PADDING 0x800
399
400/* EVP_CIPHER_CTX_ctrl commands. */
401#define EVP_CTRL_INIT 0x0
402#define EVP_CTRL_SET_KEY_LENGTH 0x1
403#define EVP_CTRL_GET_RC2_KEY_BITS 0x2
404#define EVP_CTRL_SET_RC2_KEY_BITS 0x3
405#define EVP_CTRL_GET_RC5_ROUNDS 0x4
406#define EVP_CTRL_SET_RC5_ROUNDS 0x5
407#define EVP_CTRL_RAND_KEY 0x6
408#define EVP_CTRL_PBE_PRF_NID 0x7
409#define EVP_CTRL_COPY 0x8
410#define EVP_CTRL_GCM_SET_IVLEN 0x9
411#define EVP_CTRL_GCM_GET_TAG 0x10
412#define EVP_CTRL_GCM_SET_TAG 0x11
413#define EVP_CTRL_GCM_SET_IV_FIXED 0x12
414#define EVP_CTRL_GCM_IV_GEN 0x13
Adam Langley95c29f32014-06-20 12:00:00 -0700415#define EVP_CTRL_AEAD_SET_MAC_KEY 0x17
416/* Set the GCM invocation field, decrypt only */
417#define EVP_CTRL_GCM_SET_IV_INV 0x18
418
419/* GCM TLS constants */
420/* Length of fixed part of IV derived from PRF */
421#define EVP_GCM_TLS_FIXED_IV_LEN 4
422/* Length of explicit part of IV part of TLS records */
423#define EVP_GCM_TLS_EXPLICIT_IV_LEN 8
424/* Length of tag for TLS */
425#define EVP_GCM_TLS_TAG_LEN 16
426
427#define EVP_MAX_KEY_LENGTH 64
428#define EVP_MAX_IV_LENGTH 16
429#define EVP_MAX_BLOCK_LENGTH 32
430
431struct evp_cipher_ctx_st {
432 /* cipher contains the underlying cipher for this context. */
433 const EVP_CIPHER *cipher;
434
435 /* app_data is a pointer to opaque, user data. */
436 void *app_data; /* application stuff */
437
438 /* cipher_data points to the |cipher| specific state. */
439 void *cipher_data;
440
441 /* key_len contains the length of the key, which may differ from
442 * |cipher->key_len| if the cipher can take a variable key length. */
443 unsigned key_len;
444
445 /* encrypt is one if encrypting and zero if decrypting. */
446 int encrypt;
447
448 /* flags contains the OR of zero or more |EVP_CIPH_*| flags, above. */
449 uint32_t flags;
450
451 /* oiv contains the original IV value. */
452 uint8_t oiv[EVP_MAX_IV_LENGTH];
453
454 /* iv contains the current IV value, which may have been updated. */
455 uint8_t iv[EVP_MAX_IV_LENGTH];
456
457 /* buf contains a partial block which is used by, for example, CTR mode to
458 * store unused keystream bytes. */
459 uint8_t buf[EVP_MAX_BLOCK_LENGTH];
460
461 /* buf_len contains the number of bytes of a partial block contained in
462 * |buf|. */
463 int buf_len;
464
465 /* num contains the number of bytes of |iv| which are valid for modes that
466 * manage partial blocks themselves. */
467 int num;
468
469 /* final_used is non-zero if the |final| buffer contains plaintext. */
470 int final_used;
471
472 /* block_mask contains |cipher->block_size| minus one. (The block size
473 * assumed to be a power of two.) */
474 int block_mask;
475
476 uint8_t final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
477} /* EVP_CIPHER_CTX */;
478
479typedef struct evp_cipher_info_st {
480 const EVP_CIPHER *cipher;
481 unsigned char iv[EVP_MAX_IV_LENGTH];
482} EVP_CIPHER_INFO;
483
484
485#if defined(__cplusplus)
486} /* extern C */
487#endif
488
489#define CIPHER_F_EVP_CipherInit_ex 100
490#define CIPHER_F_EVP_EncryptFinal_ex 101
491#define CIPHER_F_EVP_DecryptFinal_ex 102
492#define CIPHER_F_EVP_CIPHER_CTX_ctrl 103
493#define CIPHER_F_aes_init_key 104
494#define CIPHER_F_aesni_init_key 105
495#define CIPHER_F_EVP_CIPHER_CTX_copy 106
Adam Langleyfd772a52014-06-20 12:00:00 -0700496#define CIPHER_F_EVP_AEAD_CTX_open 107
497#define CIPHER_F_EVP_AEAD_CTX_init 108
498#define CIPHER_F_EVP_AEAD_CTX_seal 109
499#define CIPHER_F_aead_aes_gcm_seal 110
500#define CIPHER_F_aead_aes_gcm_open 111
501#define CIPHER_F_aead_aes_gcm_init 112
Adam Langleyde0b2022014-06-20 12:00:00 -0700502#define CIPHER_F_aead_chacha20_poly1305_init 113
503#define CIPHER_F_aead_chacha20_poly1305_open 114
504#define CIPHER_F_aead_chacha20_poly1305_seal 115
Adam Langley45ec21b2014-06-24 17:26:59 -0700505#define CIPHER_F_aead_rc4_md5_tls_init 116
506#define CIPHER_F_aead_rc4_md5_tls_seal 117
507#define CIPHER_F_aead_rc4_md5_tls_open 118
Adam Langley93a3dcd2014-07-25 15:40:44 -0700508#define CIPHER_F_aead_aes_key_wrap_seal 119
509#define CIPHER_F_aead_aes_key_wrap_init 120
510#define CIPHER_F_aead_aes_key_wrap_open 121
Adam Langley539112f2014-08-22 11:06:41 -0700511#define CIPHER_F_EVP_CIPHER_CTX_set_key_length 122
Adam Langley95c29f32014-06-20 12:00:00 -0700512#define CIPHER_R_WRAP_MODE_NOT_ALLOWED 100
513#define CIPHER_R_AES_KEY_SETUP_FAILED 101
514#define CIPHER_R_INPUT_NOT_INITIALIZED 102
515#define CIPHER_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH 103
516#define CIPHER_R_INITIALIZATION_ERROR 104
517#define CIPHER_R_CTRL_NOT_IMPLEMENTED 105
518#define CIPHER_R_NO_CIPHER_SET 106
519#define CIPHER_R_BAD_DECRYPT 107
520#define CIPHER_R_WRONG_FINAL_BLOCK_LENGTH 108
521#define CIPHER_R_CTRL_OPERATION_NOT_IMPLEMENTED 109
Adam Langleyfd772a52014-06-20 12:00:00 -0700522#define CIPHER_R_TAG_TOO_LARGE 110
523#define CIPHER_R_BAD_KEY_LENGTH 111
524#define CIPHER_R_BUFFER_TOO_SMALL 112
525#define CIPHER_R_OUTPUT_ALIASES_INPUT 113
526#define CIPHER_R_UNSUPPORTED_KEY_SIZE 114
527#define CIPHER_R_TOO_LARGE 115
Adam Langleyde0b2022014-06-20 12:00:00 -0700528#define CIPHER_R_IV_TOO_LARGE 116
Adam Langley45ec21b2014-06-24 17:26:59 -0700529#define CIPHER_R_INVALID_AD_SIZE 117
530#define CIPHER_R_INVALID_AD 118
Adam Langley93a3dcd2014-07-25 15:40:44 -0700531#define CIPHER_R_UNSUPPORTED_TAG_SIZE 119
532#define CIPHER_R_UNSUPPORTED_INPUT_SIZE 120
533#define CIPHER_R_UNSUPPORTED_AD_SIZE 121
534#define CIPHER_R_UNSUPPORTED_NONCE_SIZE 122
Adam Langley539112f2014-08-22 11:06:41 -0700535#define CIPHER_R_INVALID_KEY_LENGTH 123
Adam Langley95c29f32014-06-20 12:00:00 -0700536
537#endif /* OPENSSL_HEADER_CIPHER_H */