aes.h revision 296465 
1/* crypto/aes/aes.h -*- mode:C; c-file-style: "eay" -*- */
2/* ====================================================================
3 * Copyright (c) 1998-2002 The OpenSSL Project.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in
14 *    the documentation and/or other materials provided with the
15 *    distribution.
16 *
17 * 3. All advertising materials mentioning features or use of this
18 *    software must display the following acknowledgment:
19 *    "This product includes software developed by the OpenSSL Project
20 *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 *
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 *    endorse or promote products derived from this software without
24 *    prior written permission. For written permission, please contact
25 *    openssl-core@openssl.org.
26 *
27 * 5. Products derived from this software may not be called "OpenSSL"
28 *    nor may "OpenSSL" appear in their names without prior written
29 *    permission of the OpenSSL Project.
30 *
31 * 6. Redistributions of any form whatsoever must retain the following
32 *    acknowledgment:
33 *    "This product includes software developed by the OpenSSL Project
34 *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 *
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
49 *
50 */
51
52#ifndef HEADER_AES_H
53# define HEADER_AES_H
54
55# include <openssl/opensslconf.h>
56
57# ifdef OPENSSL_NO_AES
58#  error AES is disabled.
59# endif
60
61# define AES_ENCRYPT     1
62# define AES_DECRYPT     0
63
64/*
65 * Because array size can't be a const in C, the following two are macros.
66 * Both sizes are in bytes.
67 */
68# define AES_MAXNR 14
69# define AES_BLOCK_SIZE 16
70
71# ifdef OPENSSL_FIPS
72#  define FIPS_AES_SIZE_T int
73# endif
74
75#ifdef  __cplusplus
76extern "C" {
77#endif
78
79/* This should be a hidden type, but EVP requires that the size be known */
80struct aes_key_st {
81# ifdef AES_LONG
82    unsigned long rd_key[4 * (AES_MAXNR + 1)];
83# else
84    unsigned int rd_key[4 * (AES_MAXNR + 1)];
85# endif
86    int rounds;
87};
88typedef struct aes_key_st AES_KEY;
89
90const char *AES_options(void);
91
92int AES_set_encrypt_key(const unsigned char *userKey, const int bits,
93                        AES_KEY *key);
94int AES_set_decrypt_key(const unsigned char *userKey, const int bits,
95                        AES_KEY *key);
96
97void AES_encrypt(const unsigned char *in, unsigned char *out,
98                 const AES_KEY *key);
99void AES_decrypt(const unsigned char *in, unsigned char *out,
100                 const AES_KEY *key);
101
102void AES_ecb_encrypt(const unsigned char *in, unsigned char *out,
103                     const AES_KEY *key, const int enc);
104void AES_cbc_encrypt(const unsigned char *in, unsigned char *out,
105                     const unsigned long length, const AES_KEY *key,
106                     unsigned char *ivec, const int enc);
107void AES_cfb128_encrypt(const unsigned char *in, unsigned char *out,
108                        const unsigned long length, const AES_KEY *key,
109                        unsigned char *ivec, int *num, const int enc);
110void AES_cfb1_encrypt(const unsigned char *in, unsigned char *out,
111                      const unsigned long length, const AES_KEY *key,
112                      unsigned char *ivec, int *num, const int enc);
113void AES_cfb8_encrypt(const unsigned char *in, unsigned char *out,
114                      const unsigned long length, const AES_KEY *key,
115                      unsigned char *ivec, int *num, const int enc);
116void AES_cfbr_encrypt_block(const unsigned char *in, unsigned char *out,
117                            const int nbits, const AES_KEY *key,
118                            unsigned char *ivec, const int enc);
119void AES_ofb128_encrypt(const unsigned char *in, unsigned char *out,
120                        const unsigned long length, const AES_KEY *key,
121                        unsigned char *ivec, int *num);
122void AES_ctr128_encrypt(const unsigned char *in, unsigned char *out,
123                        const unsigned long length, const AES_KEY *key,
124                        unsigned char ivec[AES_BLOCK_SIZE],
125                        unsigned char ecount_buf[AES_BLOCK_SIZE],
126                        unsigned int *num);
127
128/* For IGE, see also http://www.links.org/files/openssl-ige.pdf */
129/* NB: the IV is _two_ blocks long */
130void AES_ige_encrypt(const unsigned char *in, unsigned char *out,
131                     const unsigned long length, const AES_KEY *key,
132                     unsigned char *ivec, const int enc);
133/* NB: the IV is _four_ blocks long */
134void AES_bi_ige_encrypt(const unsigned char *in, unsigned char *out,
135                        const unsigned long length, const AES_KEY *key,
136                        const AES_KEY *key2, const unsigned char *ivec,
137                        const int enc);
138
139int AES_wrap_key(AES_KEY *key, const unsigned char *iv,
140                 unsigned char *out,
141                 const unsigned char *in, unsigned int inlen);
142int AES_unwrap_key(AES_KEY *key, const unsigned char *iv,
143                   unsigned char *out,
144                   const unsigned char *in, unsigned int inlen);
145
146#ifdef  __cplusplus
147}
148#endif
149
150#endif                          /* !HEADER_AES_H */
151