1 /* ==================================================================== 2 * Copyright (c) 2002-2006 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 #ifndef OPENSSL_HEADER_AES_H 50 #define OPENSSL_HEADER_AES_H 51 52 #include <openssl/base.h> 53 54 #if defined(__cplusplus) 55 extern "C" { 56 #endif 57 58 59 // Raw AES functions. 60 61 62 #define AES_ENCRYPT 1 63 #define AES_DECRYPT 0 64 65 // AES_MAXNR is the maximum number of AES rounds. 66 #define AES_MAXNR 14 67 68 #define AES_BLOCK_SIZE 16 69 70 // aes_key_st should be an opaque type, but EVP requires that the size be 71 // known. 72 struct aes_key_st { 73 uint32_t rd_key[4 * (AES_MAXNR + 1)]; 74 unsigned rounds; 75 }; 76 typedef struct aes_key_st AES_KEY; 77 78 // AES_set_encrypt_key configures |aeskey| to encrypt with the |bits|-bit key, 79 // |key|. |key| must point to |bits|/8 bytes. It returns zero on success and a 80 // negative number if |bits| is an invalid AES key size. 81 // 82 // WARNING: this function breaks the usual return value convention. 83 OPENSSL_EXPORT int AES_set_encrypt_key(const uint8_t *key, unsigned bits, 84 AES_KEY *aeskey); 85 86 // AES_set_decrypt_key configures |aeskey| to decrypt with the |bits|-bit key, 87 // |key|. |key| must point to |bits|/8 bytes. It returns zero on success and a 88 // negative number if |bits| is an invalid AES key size. 89 // 90 // WARNING: this function breaks the usual return value convention. 91 OPENSSL_EXPORT int AES_set_decrypt_key(const uint8_t *key, unsigned bits, 92 AES_KEY *aeskey); 93 94 // AES_encrypt encrypts a single block from |in| to |out| with |key|. The |in| 95 // and |out| pointers may overlap. 96 OPENSSL_EXPORT void AES_encrypt(const uint8_t *in, uint8_t *out, 97 const AES_KEY *key); 98 99 // AES_decrypt decrypts a single block from |in| to |out| with |key|. The |in| 100 // and |out| pointers may overlap. 101 OPENSSL_EXPORT void AES_decrypt(const uint8_t *in, uint8_t *out, 102 const AES_KEY *key); 103 104 105 // Block cipher modes. 106 107 // AES_ctr128_encrypt encrypts (or decrypts, it's the same in CTR mode) |len| 108 // bytes from |in| to |out|. The |num| parameter must be set to zero on the 109 // first call and |ivec| will be incremented. This function may be called 110 // in-place with |in| equal to |out|, but otherwise the buffers may not 111 // partially overlap. A partial overlap may overwrite input data before it is 112 // read. 113 OPENSSL_EXPORT void AES_ctr128_encrypt(const uint8_t *in, uint8_t *out, 114 size_t len, const AES_KEY *key, 115 uint8_t ivec[AES_BLOCK_SIZE], 116 uint8_t ecount_buf[AES_BLOCK_SIZE], 117 unsigned int *num); 118 119 // AES_ecb_encrypt encrypts (or decrypts, if |enc| == |AES_DECRYPT|) a single, 120 // 16 byte block from |in| to |out|. This function may be called in-place with 121 // |in| equal to |out|, but otherwise the buffers may not partially overlap. A 122 // partial overlap may overwrite input data before it is read. 123 OPENSSL_EXPORT void AES_ecb_encrypt(const uint8_t *in, uint8_t *out, 124 const AES_KEY *key, const int enc); 125 126 // AES_cbc_encrypt encrypts (or decrypts, if |enc| == |AES_DECRYPT|) |len| 127 // bytes from |in| to |out|. The length must be a multiple of the block size. 128 // This function may be called in-place with |in| equal to |out|, but otherwise 129 // the buffers may not partially overlap. A partial overlap may overwrite input 130 // data before it is read. 131 OPENSSL_EXPORT void AES_cbc_encrypt(const uint8_t *in, uint8_t *out, size_t len, 132 const AES_KEY *key, uint8_t *ivec, 133 const int enc); 134 135 // AES_ofb128_encrypt encrypts (or decrypts, it's the same in OFB mode) |len| 136 // bytes from |in| to |out|. The |num| parameter must be set to zero on the 137 // first call. This function may be called in-place with |in| equal to |out|, 138 // but otherwise the buffers may not partially overlap. A partial overlap may 139 // overwrite input data before it is read. 140 OPENSSL_EXPORT void AES_ofb128_encrypt(const uint8_t *in, uint8_t *out, 141 size_t len, const AES_KEY *key, 142 uint8_t *ivec, int *num); 143 144 // AES_cfb128_encrypt encrypts (or decrypts, if |enc| == |AES_DECRYPT|) |len| 145 // bytes from |in| to |out|. The |num| parameter must be set to zero on the 146 // first call. This function may be called in-place with |in| equal to |out|, 147 // but otherwise the buffers may not partially overlap. A partial overlap may 148 // overwrite input data before it is read. 149 OPENSSL_EXPORT void AES_cfb128_encrypt(const uint8_t *in, uint8_t *out, 150 size_t len, const AES_KEY *key, 151 uint8_t *ivec, int *num, int enc); 152 153 154 // AES key wrap. 155 // 156 // These functions implement AES Key Wrap mode, as defined in RFC 3394. They 157 // should never be used except to interoperate with existing systems that use 158 // this mode. 159 160 // AES_wrap_key performs AES key wrap on |in| which must be a multiple of 8 161 // bytes. |iv| must point to an 8 byte value or be NULL to use the default IV. 162 // |key| must have been configured for encryption. On success, it writes 163 // |in_len| + 8 bytes to |out| and returns |in_len| + 8. Otherwise, it returns 164 // -1. 165 OPENSSL_EXPORT int AES_wrap_key(const AES_KEY *key, const uint8_t *iv, 166 uint8_t *out, const uint8_t *in, size_t in_len); 167 168 // AES_unwrap_key performs AES key unwrap on |in| which must be a multiple of 8 169 // bytes. |iv| must point to an 8 byte value or be NULL to use the default IV. 170 // |key| must have been configured for decryption. On success, it writes 171 // |in_len| - 8 bytes to |out| and returns |in_len| - 8. Otherwise, it returns 172 // -1. 173 OPENSSL_EXPORT int AES_unwrap_key(const AES_KEY *key, const uint8_t *iv, 174 uint8_t *out, const uint8_t *in, 175 size_t in_len); 176 177 178 // AES key wrap with padding. 179 // 180 // These functions implement AES Key Wrap with Padding mode, as defined in RFC 181 // 5649. They should never be used except to interoperate with existing systems 182 // that use this mode. 183 184 // AES_wrap_key_padded performs a padded AES key wrap on |in| which must be 185 // between 1 and 2^32-1 bytes. |key| must have been configured for encryption. 186 // On success it writes at most |max_out| bytes of ciphertext to |out|, sets 187 // |*out_len| to the number of bytes written, and returns one. On failure it 188 // returns zero. To ensure success, set |max_out| to at least |in_len| + 15. 189 OPENSSL_EXPORT int AES_wrap_key_padded(const AES_KEY *key, uint8_t *out, 190 size_t *out_len, size_t max_out, 191 const uint8_t *in, size_t in_len); 192 193 // AES_unwrap_key_padded performs a padded AES key unwrap on |in| which must be 194 // a multiple of 8 bytes. |key| must have been configured for decryption. On 195 // success it writes at most |max_out| bytes to |out|, sets |*out_len| to the 196 // number of bytes written, and returns one. On failure it returns zero. Setting 197 // |max_out| to |in_len| is a sensible estimate. 198 OPENSSL_EXPORT int AES_unwrap_key_padded(const AES_KEY *key, uint8_t *out, 199 size_t *out_len, size_t max_out, 200 const uint8_t *in, size_t in_len); 201 202 203 #if defined(__cplusplus) 204 } // extern C 205 #endif 206 207 #endif // OPENSSL_HEADER_AES_H 208