Home | History | Annotate | Download | only in openssl
      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 (at) 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|.
     80  *
     81  * WARNING: unlike other OpenSSL functions, this returns zero on success and a
     82  * negative number on error. */
     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|.
     88  *
     89  * WARNING: unlike other OpenSSL functions, this returns zero on success and a
     90  * negative number on error. */
     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. */
    110 OPENSSL_EXPORT void AES_ctr128_encrypt(const uint8_t *in, uint8_t *out,
    111                                        size_t len, const AES_KEY *key,
    112                                        uint8_t ivec[AES_BLOCK_SIZE],
    113                                        uint8_t ecount_buf[AES_BLOCK_SIZE],
    114                                        unsigned int *num);
    115 
    116 /* AES_ecb_encrypt encrypts (or decrypts, if |enc| == |AES_DECRYPT|) a single,
    117  * 16 byte block from |in| to |out|. */
    118 OPENSSL_EXPORT void AES_ecb_encrypt(const uint8_t *in, uint8_t *out,
    119                                     const AES_KEY *key, const int enc);
    120 
    121 /* AES_cbc_encrypt encrypts (or decrypts, if |enc| == |AES_DECRYPT|) |len|
    122  * bytes from |in| to |out|. The length must be a multiple of the block size. */
    123 OPENSSL_EXPORT void AES_cbc_encrypt(const uint8_t *in, uint8_t *out, size_t len,
    124                                     const AES_KEY *key, uint8_t *ivec,
    125                                     const int enc);
    126 
    127 /* AES_ofb128_encrypt encrypts (or decrypts, it's the same in OFB mode) |len|
    128  * bytes from |in| to |out|. The |num| parameter must be set to zero on the
    129  * first call. */
    130 OPENSSL_EXPORT void AES_ofb128_encrypt(const uint8_t *in, uint8_t *out,
    131                                        size_t len, const AES_KEY *key,
    132                                        uint8_t *ivec, int *num);
    133 
    134 /* AES_cfb128_encrypt encrypts (or decrypts, if |enc| == |AES_DECRYPT|) |len|
    135  * bytes from |in| to |out|. The |num| parameter must be set to zero on the
    136  * first call. */
    137 OPENSSL_EXPORT void AES_cfb128_encrypt(const uint8_t *in, uint8_t *out,
    138                                        size_t len, const AES_KEY *key,
    139                                        uint8_t *ivec, int *num, int enc);
    140 
    141 
    142 /* Android compatibility section.
    143  *
    144  * These functions are declared, temporarily, for Android because
    145  * wpa_supplicant will take a little time to sync with upstream. Outside of
    146  * Android they'll have no definition. */
    147 
    148 OPENSSL_EXPORT int AES_wrap_key(AES_KEY *key, const uint8_t *iv, uint8_t *out,
    149                                 const uint8_t *in, unsigned in_len);
    150 OPENSSL_EXPORT int AES_unwrap_key(AES_KEY *key, const uint8_t *iv, uint8_t *out,
    151                                   const uint8_t *in, unsigned in_len);
    152 
    153 
    154 #if defined(__cplusplus)
    155 }  /* extern C */
    156 #endif
    157 
    158 #endif  /* OPENSSL_HEADER_AES_H */
    159