Document removal of digest+signature algorithm link.
[openssl.git] / crypto / aes / aes.h
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 #include <stddef.h>
62
63 #define AES_ENCRYPT     1
64 #define AES_DECRYPT     0
65
66 /* Because array size can't be a const in C, the following two are macros.
67    Both sizes are in bytes. */
68 #define AES_MAXNR 14
69 #define AES_BLOCK_SIZE 16
70
71 #ifdef  __cplusplus
72 extern "C" {
73 #endif
74
75 /* This should be a hidden type, but EVP requires that the size be known */
76 struct aes_key_st {
77 #ifdef AES_LONG
78     unsigned long rd_key[4 *(AES_MAXNR + 1)];
79 #else
80     unsigned int rd_key[4 *(AES_MAXNR + 1)];
81 #endif
82     int rounds;
83 };
84 typedef struct aes_key_st AES_KEY;
85
86 const char *AES_options(void);
87
88 int AES_set_encrypt_key(const unsigned char *userKey, const int bits,
89         AES_KEY *key);
90 int AES_set_decrypt_key(const unsigned char *userKey, const int bits,
91         AES_KEY *key);
92
93 void AES_encrypt(const unsigned char *in, unsigned char *out,
94         const AES_KEY *key);
95 void AES_decrypt(const unsigned char *in, unsigned char *out,
96         const AES_KEY *key);
97
98 void AES_ecb_encrypt(const unsigned char *in, unsigned char *out,
99         const AES_KEY *key, const int enc);
100 void AES_cbc_encrypt(const unsigned char *in, unsigned char *out,
101         size_t length, const AES_KEY *key,
102         unsigned char *ivec, const int enc);
103 void AES_cfb128_encrypt(const unsigned char *in, unsigned char *out,
104         size_t length, const AES_KEY *key,
105         unsigned char *ivec, int *num, const int enc);
106 void AES_cfb1_encrypt(const unsigned char *in, unsigned char *out,
107         size_t length, const AES_KEY *key,
108         unsigned char *ivec, int *num, const int enc);
109 void AES_cfb8_encrypt(const unsigned char *in, unsigned char *out,
110         size_t length, const AES_KEY *key,
111         unsigned char *ivec, int *num, const int enc);
112 void AES_ofb128_encrypt(const unsigned char *in, unsigned char *out,
113         size_t length, const AES_KEY *key,
114         unsigned char *ivec, int *num);
115 void AES_ctr128_encrypt(const unsigned char *in, unsigned char *out,
116         size_t length, const AES_KEY *key,
117         unsigned char ivec[AES_BLOCK_SIZE],
118         unsigned char ecount_buf[AES_BLOCK_SIZE],
119         unsigned int *num);
120 /* NB: the IV is _two_ blocks long */
121 void AES_ige_encrypt(const unsigned char *in, unsigned char *out,
122                      size_t length, const AES_KEY *key,
123                      unsigned char *ivec, const int enc);
124 /* NB: the IV is _four_ blocks long */
125 void AES_bi_ige_encrypt(const unsigned char *in, unsigned char *out,
126                         size_t length, const AES_KEY *key,
127                         const AES_KEY *key2, const unsigned char *ivec,
128                         const int enc);
129
130 int AES_wrap_key(AES_KEY *key, const unsigned char *iv,
131                 unsigned char *out,
132                 const unsigned char *in, unsigned int inlen);
133 int AES_unwrap_key(AES_KEY *key, const unsigned char *iv,
134                 unsigned char *out,
135                 const unsigned char *in, unsigned int inlen);
136
137
138 #ifdef  __cplusplus
139 }
140 #endif
141
142 #endif /* !HEADER_AES_H */