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