blob: 92cec76a8a44961055f8dab28676d5c295a37d9c [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);
83OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_gcm(void);
Adam Langley95c29f32014-06-20 12:00:00 -070084
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070085OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ecb(void);
86OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_cbc(void);
87OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ctr(void);
88OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_gcm(void);
Adam Langley95c29f32014-06-20 12:00:00 -070089
90/* EVP_enc_null returns a 'cipher' that passes plaintext through as
91 * ciphertext. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070092OPENSSL_EXPORT const EVP_CIPHER *EVP_enc_null(void);
Adam Langley95c29f32014-06-20 12:00:00 -070093
94/* EVP_get_cipherbynid returns the cipher corresponding to the given NID, or
95 * NULL if no such cipher is known. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070096OPENSSL_EXPORT const EVP_CIPHER *EVP_get_cipherbynid(int nid);
Adam Langley95c29f32014-06-20 12:00:00 -070097
98
99/* Cipher context allocation.
100 *
101 * An |EVP_CIPHER_CTX| represents the state of an encryption or decryption in
102 * progress. */
103
104/* EVP_CIPHER_CTX_init initialises an, already allocated, |EVP_CIPHER_CTX|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700105OPENSSL_EXPORT void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700106
107/* EVP_CIPHER_CTX_new allocates a fresh |EVP_CIPHER_CTX|, calls
108 * |EVP_CIPHER_CTX_init| and returns it, or NULL on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700109OPENSSL_EXPORT EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700110
111/* EVP_CIPHER_CTX_cleanup frees any memory referenced by |ctx|. It returns one
112 * on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700113OPENSSL_EXPORT int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700114
115/* EVP_CIPHER_CTX_free calls |EVP_CIPHER_CTX_cleanup| on |ctx| and then frees
116 * |ctx| itself. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700117OPENSSL_EXPORT void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700118
119/* EVP_CIPHER_CTX_copy sets |out| to be a duplicate of the current state of
120 * |in|. The |out| argument must have been previously initialised. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700121OPENSSL_EXPORT int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out,
122 const EVP_CIPHER_CTX *in);
Adam Langley95c29f32014-06-20 12:00:00 -0700123
124
125/* Cipher context configuration. */
126
127/* EVP_CipherInit_ex configures |ctx| for a fresh encryption (or decryption, if
128 * |enc| is zero) operation using |cipher|. If |ctx| has been previously
129 * configured with a cipher then |cipher|, |key| and |iv| may be |NULL| and
130 * |enc| may be -1 to reuse the previous values. The operation will use |key|
131 * as the key and |iv| as the IV (if any). These should have the correct
132 * lengths given by |EVP_CIPHER_key_length| and |EVP_CIPHER_iv_length|. It
133 * returns one on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700134OPENSSL_EXPORT int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx,
135 const EVP_CIPHER *cipher, ENGINE *engine,
136 const uint8_t *key, const uint8_t *iv,
137 int enc);
Adam Langley95c29f32014-06-20 12:00:00 -0700138
139/* EVP_EncryptInit_ex calls |EVP_CipherInit_ex| with |enc| equal to one. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700140OPENSSL_EXPORT int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx,
141 const EVP_CIPHER *cipher, ENGINE *impl,
142 const uint8_t *key, const uint8_t *iv);
Adam Langley95c29f32014-06-20 12:00:00 -0700143
144/* EVP_DecryptInit_ex calls |EVP_CipherInit_ex| with |enc| equal to zero. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700145OPENSSL_EXPORT int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx,
146 const EVP_CIPHER *cipher, ENGINE *impl,
147 const uint8_t *key, const uint8_t *iv);
Adam Langley95c29f32014-06-20 12:00:00 -0700148
149
150/* Cipher operations. */
151
152/* EVP_EncryptUpdate encrypts |in_len| bytes from |in| to |out|. The number
153 * of output bytes may be up to |in_len| plus the block length minus one and
154 * |out| must have sufficient space. The number of bytes actually output is
155 * written to |*out_len|. It returns one on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700156OPENSSL_EXPORT int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out,
157 int *out_len, const uint8_t *in,
158 int in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700159
160/* EVP_EncryptFinal_ex writes at most a block of ciphertext to |out| and sets
161 * |*out_len| to the number of bytes written. If padding is enabled (the
162 * default) then standard padding is applied to create the final block. If
163 * padding is disabled (with |EVP_CIPHER_CTX_set_padding|) then any partial
164 * block remaining will cause an error. The function returns one on success and
165 * zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700166OPENSSL_EXPORT int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out,
167 int *out_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700168
169/* EVP_DecryptUpdate decrypts |in_len| bytes from |in| to |out|. The number of
170 * output bytes may be up to |in_len| plus the block length minus one and |out|
171 * must have sufficient space. The number of bytes actually output is written
172 * to |*out_len|. It returns one on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700173OPENSSL_EXPORT int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out,
174 int *out_len, const uint8_t *in,
175 int in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700176
177/* EVP_DecryptFinal_ex writes at most a block of ciphertext to |out| and sets
178 * |*out_len| to the number of bytes written. If padding is enabled (the
179 * default) then padding is removed from the final block.
180 *
181 * WARNING: it is unsafe to call this function with unauthenticted
182 * ciphertext if padding is enabled. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700183OPENSSL_EXPORT int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out,
184 int *out_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700185
186/* EVP_Cipher performs a one-shot encryption/decryption operation. No partial
187 * blocks etc are maintained between calls. It returns the number of bytes
188 * written or -1 on error.
189 *
190 * WARNING: this differs from the usual return value convention. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700191OPENSSL_EXPORT int EVP_Cipher(EVP_CIPHER_CTX *ctx, uint8_t *out,
192 const uint8_t *in, size_t in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700193
194/* EVP_CipherUpdate calls either |EVP_EncryptUpdate| or |EVP_DecryptUpdate|
195 * depending on how |ctx| has been setup. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700196OPENSSL_EXPORT int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out,
197 int *out_len, const uint8_t *in,
198 int in_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700199
200/* EVP_CipherFinal_ex calls either |EVP_EncryptFinal_ex| or
201 * |EVP_DecryptFinal_ex| depending on how |ctx| has been setup. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700202OPENSSL_EXPORT int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out,
203 int *out_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700204
205
206/* Cipher context accessors. */
207
208/* EVP_CIPHER_CTX_cipher returns the |EVP_CIPHER| underlying |ctx|, or NULL if
209 * none has been set. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700210OPENSSL_EXPORT const EVP_CIPHER *EVP_CIPHER_CTX_cipher(
211 const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700212
213/* EVP_CIPHER_CTX_nid returns a NID identifying the |EVP_CIPHER| underlying
214 * |ctx| (e.g. |NID_rc4|). It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700215OPENSSL_EXPORT int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700216
217/* EVP_CIPHER_CTX_block_size returns the block size, in bytes, of the cipher
218 * underlying |ctx|, or one if the cipher is a stream cipher. It will crash if
219 * no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700220OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700221
222/* EVP_CIPHER_CTX_key_length returns the key size, in bytes, of the cipher
223 * underlying |ctx| or zero if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700224OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700225
226/* EVP_CIPHER_CTX_iv_length returns the IV size, in bytes, of the cipher
227 * underlying |ctx|. It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700228OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700229
230/* EVP_CIPHER_CTX_get_app_data returns the opaque, application data pointer for
231 * |ctx|, or NULL if none has been set. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700232OPENSSL_EXPORT void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700233
234/* EVP_CIPHER_CTX_set_app_data sets the opaque, application data pointer for
235 * |ctx| to |data|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700236OPENSSL_EXPORT void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx,
237 void *data);
Adam Langley95c29f32014-06-20 12:00:00 -0700238
239/* EVP_CIPHER_CTX_flags returns a value which is the OR of zero or more
240 * |EVP_CIPH_*| flags. It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700241OPENSSL_EXPORT uint32_t EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700242
243/* EVP_CIPHER_CTX_mode returns one of the |EVP_CIPH_*| cipher mode values
244 * enumerated below. It will crash if no cipher has been configured. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700245OPENSSL_EXPORT uint32_t EVP_CIPHER_CTX_mode(const EVP_CIPHER_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700246
247/* EVP_CIPHER_CTX_ctrl is an |ioctl| like function. The |command| argument
248 * should be one of the |EVP_CTRL_*| values. The |arg| and |ptr| arguments are
249 * specific to the command in question. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700250OPENSSL_EXPORT int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int command,
251 int arg, void *ptr);
Adam Langley95c29f32014-06-20 12:00:00 -0700252
253/* EVP_CIPHER_CTX_set_padding sets whether padding is enabled for |ctx| and
254 * returns one. Pass a non-zero |pad| to enable padding (the default) or zero
255 * to disable. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700256OPENSSL_EXPORT int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad);
Adam Langley95c29f32014-06-20 12:00:00 -0700257
258
259/* Cipher accessors. */
260
261/* EVP_CIPHER_nid returns a NID identifing |cipher|. (For example,
262 * |NID_rc4|.) */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700263OPENSSL_EXPORT int EVP_CIPHER_nid(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700264
265/* EVP_CIPHER_name returns the short name for |cipher| or NULL if no name is
266 * known. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700267OPENSSL_EXPORT const char *EVP_CIPHER_name(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700268
269/* EVP_CIPHER_block_size returns the block size, in bytes, for |cipher|, or one
270 * if |cipher| is a stream cipher. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700271OPENSSL_EXPORT unsigned EVP_CIPHER_block_size(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700272
273/* EVP_CIPHER_key_length returns the key size, in bytes, for |cipher|. If
274 * |cipher| can take a variable key length then this function returns the
275 * default key length and |EVP_CIPHER_flags| will return a value with
276 * |EVP_CIPH_VARIABLE_LENGTH| set. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700277OPENSSL_EXPORT unsigned EVP_CIPHER_key_length(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700278
279/* EVP_CIPHER_iv_length returns the IV size, in bytes, of |cipher|, or zero if
280 * |cipher| doesn't take an IV. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700281OPENSSL_EXPORT unsigned EVP_CIPHER_iv_length(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700282
283/* EVP_CIPHER_flags returns a value which is the OR of zero or more
284 * |EVP_CIPH_*| flags. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700285OPENSSL_EXPORT uint32_t EVP_CIPHER_flags(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700286
287/* EVP_CIPHER_mode returns one of the cipher mode values enumerated below. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700288OPENSSL_EXPORT uint32_t EVP_CIPHER_mode(const EVP_CIPHER *cipher);
Adam Langley95c29f32014-06-20 12:00:00 -0700289
290
291/* Key derivation. */
292
293/* EVP_BytesToKey generates a key and IV for the cipher |type| by iterating
294 * |md| |count| times using |data| and |salt|. On entry, the |key| and |iv|
295 * buffers must have enough space to hold a key and IV for |type|. It returns
296 * the length of the key on success or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700297OPENSSL_EXPORT int EVP_BytesToKey(const EVP_CIPHER *type, const EVP_MD *md,
298 const uint8_t *salt, const uint8_t *data,
299 size_t data_len, unsigned count, uint8_t *key,
300 uint8_t *iv);
Adam Langley95c29f32014-06-20 12:00:00 -0700301
302
303/* Cipher modes (for |EVP_CIPHER_mode|). */
304
305#define EVP_CIPH_STREAM_CIPHER 0x0
306#define EVP_CIPH_ECB_MODE 0x1
307#define EVP_CIPH_CBC_MODE 0x2
308#define EVP_CIPH_CFB_MODE 0x3
309#define EVP_CIPH_OFB_MODE 0x4
310#define EVP_CIPH_CTR_MODE 0x5
311#define EVP_CIPH_GCM_MODE 0x6
312
313
314/* Cipher flags (for |EVP_CIPHER_flags|). */
315
316/* EVP_CIPH_VARIABLE_LENGTH indicates that the cipher takes a variable length
317 * key. */
318#define EVP_CIPH_VARIABLE_LENGTH 0x40
319
320/* EVP_CIPH_ALWAYS_CALL_INIT indicates that the |init| function for the cipher
321 * should always be called when initialising a new operation, even if the key
322 * is NULL to indicate that the same key is being used. */
323#define EVP_CIPH_ALWAYS_CALL_INIT 0x80
324
325/* EVP_CIPH_CUSTOM_IV indicates that the cipher manages the IV itself rather
326 * than keeping it in the |iv| member of |EVP_CIPHER_CTX|. */
327#define EVP_CIPH_CUSTOM_IV 0x100
328
329/* EVP_CIPH_CTRL_INIT indicates that EVP_CTRL_INIT should be used when
330 * initialising an |EVP_CIPHER_CTX|. */
331#define EVP_CIPH_CTRL_INIT 0x200
332
333/* EVP_CIPH_FLAG_CUSTOM_CIPHER indicates that the cipher manages blocking
334 * itself. This causes EVP_(En|De)crypt_ex to be simple wrapper functions. */
335#define EVP_CIPH_FLAG_CUSTOM_CIPHER 0x400
336
337/* EVP_CIPH_FLAG_AEAD_CIPHER specifies that the cipher is an AEAD. This is an
338 * older version of the proper AEAD interface. See aead.h for the current
339 * one. */
340#define EVP_CIPH_FLAG_AEAD_CIPHER 0x800
341
Adam Langley7578f3f2014-07-24 17:42:11 -0700342/* EVP_CIPH_CUSTOM_COPY indicates that the |ctrl| callback should be called
343 * with |EVP_CTRL_COPY| at the end of normal |EVP_CIPHER_CTX_copy|
344 * processing. */
345#define EVP_CIPH_CUSTOM_COPY 0x1000
346
Adam Langley95c29f32014-06-20 12:00:00 -0700347
348/* Private functions. */
349
350/* EVP_CIPH_NO_PADDING disables padding in block ciphers. */
351#define EVP_CIPH_NO_PADDING 0x800
352
353/* EVP_CIPHER_CTX_ctrl commands. */
354#define EVP_CTRL_INIT 0x0
355#define EVP_CTRL_SET_KEY_LENGTH 0x1
356#define EVP_CTRL_GET_RC2_KEY_BITS 0x2
357#define EVP_CTRL_SET_RC2_KEY_BITS 0x3
358#define EVP_CTRL_GET_RC5_ROUNDS 0x4
359#define EVP_CTRL_SET_RC5_ROUNDS 0x5
360#define EVP_CTRL_RAND_KEY 0x6
361#define EVP_CTRL_PBE_PRF_NID 0x7
362#define EVP_CTRL_COPY 0x8
363#define EVP_CTRL_GCM_SET_IVLEN 0x9
364#define EVP_CTRL_GCM_GET_TAG 0x10
365#define EVP_CTRL_GCM_SET_TAG 0x11
366#define EVP_CTRL_GCM_SET_IV_FIXED 0x12
367#define EVP_CTRL_GCM_IV_GEN 0x13
Adam Langley95c29f32014-06-20 12:00:00 -0700368#define EVP_CTRL_AEAD_SET_MAC_KEY 0x17
369/* Set the GCM invocation field, decrypt only */
370#define EVP_CTRL_GCM_SET_IV_INV 0x18
371
372/* GCM TLS constants */
373/* Length of fixed part of IV derived from PRF */
374#define EVP_GCM_TLS_FIXED_IV_LEN 4
375/* Length of explicit part of IV part of TLS records */
376#define EVP_GCM_TLS_EXPLICIT_IV_LEN 8
377/* Length of tag for TLS */
378#define EVP_GCM_TLS_TAG_LEN 16
379
380#define EVP_MAX_KEY_LENGTH 64
381#define EVP_MAX_IV_LENGTH 16
382#define EVP_MAX_BLOCK_LENGTH 32
383
384struct evp_cipher_ctx_st {
385 /* cipher contains the underlying cipher for this context. */
386 const EVP_CIPHER *cipher;
387
388 /* app_data is a pointer to opaque, user data. */
389 void *app_data; /* application stuff */
390
391 /* cipher_data points to the |cipher| specific state. */
392 void *cipher_data;
393
394 /* key_len contains the length of the key, which may differ from
395 * |cipher->key_len| if the cipher can take a variable key length. */
396 unsigned key_len;
397
398 /* encrypt is one if encrypting and zero if decrypting. */
399 int encrypt;
400
401 /* flags contains the OR of zero or more |EVP_CIPH_*| flags, above. */
402 uint32_t flags;
403
404 /* oiv contains the original IV value. */
405 uint8_t oiv[EVP_MAX_IV_LENGTH];
406
407 /* iv contains the current IV value, which may have been updated. */
408 uint8_t iv[EVP_MAX_IV_LENGTH];
409
410 /* buf contains a partial block which is used by, for example, CTR mode to
411 * store unused keystream bytes. */
412 uint8_t buf[EVP_MAX_BLOCK_LENGTH];
413
414 /* buf_len contains the number of bytes of a partial block contained in
415 * |buf|. */
416 int buf_len;
417
418 /* num contains the number of bytes of |iv| which are valid for modes that
419 * manage partial blocks themselves. */
420 int num;
421
422 /* final_used is non-zero if the |final| buffer contains plaintext. */
423 int final_used;
424
425 /* block_mask contains |cipher->block_size| minus one. (The block size
426 * assumed to be a power of two.) */
427 int block_mask;
428
429 uint8_t final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
430} /* EVP_CIPHER_CTX */;
431
432typedef struct evp_cipher_info_st {
433 const EVP_CIPHER *cipher;
434 unsigned char iv[EVP_MAX_IV_LENGTH];
435} EVP_CIPHER_INFO;
436
437
438#if defined(__cplusplus)
439} /* extern C */
440#endif
441
442#define CIPHER_F_EVP_CipherInit_ex 100
443#define CIPHER_F_EVP_EncryptFinal_ex 101
444#define CIPHER_F_EVP_DecryptFinal_ex 102
445#define CIPHER_F_EVP_CIPHER_CTX_ctrl 103
446#define CIPHER_F_aes_init_key 104
447#define CIPHER_F_aesni_init_key 105
448#define CIPHER_F_EVP_CIPHER_CTX_copy 106
Adam Langleyfd772a52014-06-20 12:00:00 -0700449#define CIPHER_F_EVP_AEAD_CTX_open 107
450#define CIPHER_F_EVP_AEAD_CTX_init 108
451#define CIPHER_F_EVP_AEAD_CTX_seal 109
452#define CIPHER_F_aead_aes_gcm_seal 110
453#define CIPHER_F_aead_aes_gcm_open 111
454#define CIPHER_F_aead_aes_gcm_init 112
Adam Langleyde0b2022014-06-20 12:00:00 -0700455#define CIPHER_F_aead_chacha20_poly1305_init 113
456#define CIPHER_F_aead_chacha20_poly1305_open 114
457#define CIPHER_F_aead_chacha20_poly1305_seal 115
Adam Langley45ec21b2014-06-24 17:26:59 -0700458#define CIPHER_F_aead_rc4_md5_tls_init 116
459#define CIPHER_F_aead_rc4_md5_tls_seal 117
460#define CIPHER_F_aead_rc4_md5_tls_open 118
Adam Langley93a3dcd2014-07-25 15:40:44 -0700461#define CIPHER_F_aead_aes_key_wrap_seal 119
462#define CIPHER_F_aead_aes_key_wrap_init 120
463#define CIPHER_F_aead_aes_key_wrap_open 121
Adam Langley95c29f32014-06-20 12:00:00 -0700464#define CIPHER_R_WRAP_MODE_NOT_ALLOWED 100
465#define CIPHER_R_AES_KEY_SETUP_FAILED 101
466#define CIPHER_R_INPUT_NOT_INITIALIZED 102
467#define CIPHER_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH 103
468#define CIPHER_R_INITIALIZATION_ERROR 104
469#define CIPHER_R_CTRL_NOT_IMPLEMENTED 105
470#define CIPHER_R_NO_CIPHER_SET 106
471#define CIPHER_R_BAD_DECRYPT 107
472#define CIPHER_R_WRONG_FINAL_BLOCK_LENGTH 108
473#define CIPHER_R_CTRL_OPERATION_NOT_IMPLEMENTED 109
Adam Langleyfd772a52014-06-20 12:00:00 -0700474#define CIPHER_R_TAG_TOO_LARGE 110
475#define CIPHER_R_BAD_KEY_LENGTH 111
476#define CIPHER_R_BUFFER_TOO_SMALL 112
477#define CIPHER_R_OUTPUT_ALIASES_INPUT 113
478#define CIPHER_R_UNSUPPORTED_KEY_SIZE 114
479#define CIPHER_R_TOO_LARGE 115
Adam Langleyde0b2022014-06-20 12:00:00 -0700480#define CIPHER_R_IV_TOO_LARGE 116
Adam Langley45ec21b2014-06-24 17:26:59 -0700481#define CIPHER_R_INVALID_AD_SIZE 117
482#define CIPHER_R_INVALID_AD 118
Adam Langley93a3dcd2014-07-25 15:40:44 -0700483#define CIPHER_R_UNSUPPORTED_TAG_SIZE 119
484#define CIPHER_R_UNSUPPORTED_INPUT_SIZE 120
485#define CIPHER_R_UNSUPPORTED_AD_SIZE 121
486#define CIPHER_R_UNSUPPORTED_NONCE_SIZE 122
Adam Langley95c29f32014-06-20 12:00:00 -0700487
488#endif /* OPENSSL_HEADER_CIPHER_H */