git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/mbedtls/include/mbedtls/cipher.h

   1 /**\r
   2  * \file cipher.h\r
   3  *\r
   4  * \brief This file contains an abstraction interface for use with the cipher\r
   5  * primitives provided by the library. It provides a common interface to all of\r
   6  * the available cipher operations.\r
   7  *\r
   8  * \author Adriaan de Jong <dejong@fox-it.com>\r
   9  */\r
  10 /*\r
  11  *  Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved\r
  12  *  SPDX-License-Identifier: Apache-2.0\r
  13  *\r
  14  *  Licensed under the Apache License, Version 2.0 (the "License"); you may\r
  15  *  not use this file except in compliance with the License.\r
  16  *  You may obtain a copy of the License at\r
  17  *\r
  18  *  http://www.apache.org/licenses/LICENSE-2.0\r
  19  *\r
  20  *  Unless required by applicable law or agreed to in writing, software\r
  21  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
  22  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  23  *  See the License for the specific language governing permissions and\r
  24  *  limitations under the License.\r
  25  *\r
  26  *  This file is part of Mbed TLS (https://tls.mbed.org)\r
  27  */\r
  28 \r
  29 #ifndef MBEDTLS_CIPHER_H\r
  30 #define MBEDTLS_CIPHER_H\r
  31 \r
  32 #if !defined(MBEDTLS_CONFIG_FILE)\r
  33 #include "config.h"\r
  34 #else\r
  35 #include MBEDTLS_CONFIG_FILE\r
  36 #endif\r
  37 \r
  38 #include <stddef.h>\r
  39 #include "platform_util.h"\r
  40 \r
  41 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)\r
  42 #define MBEDTLS_CIPHER_MODE_AEAD\r
  43 #endif\r
  44 \r
  45 #if defined(MBEDTLS_CIPHER_MODE_CBC)\r
  46 #define MBEDTLS_CIPHER_MODE_WITH_PADDING\r
  47 #endif\r
  48 \r
  49 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \\r
  50     defined(MBEDTLS_CHACHA20_C)\r
  51 #define MBEDTLS_CIPHER_MODE_STREAM\r
  52 #endif\r
  53 \r
  54 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \\r
  55     !defined(inline) && !defined(__cplusplus)\r
  56 #define inline __inline\r
  57 #endif\r
  58 \r
  59 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE  -0x6080  /**< The selected feature is not available. */\r
  60 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA       -0x6100  /**< Bad input parameters. */\r
  61 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED         -0x6180  /**< Failed to allocate memory. */\r
  62 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING      -0x6200  /**< Input data contains invalid padding and is rejected. */\r
  63 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED  -0x6280  /**< Decryption of block requires a full block. */\r
  64 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED          -0x6300  /**< Authentication failed (for AEAD modes). */\r
  65 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT      -0x6380  /**< The context is invalid. For example, because it was freed. */\r
  66 \r
  67 /* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */\r
  68 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED      -0x6400  /**< Cipher hardware accelerator failed. */\r
  69 \r
  70 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN     0x01    /**< Cipher accepts IVs of variable length. */\r
  71 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN    0x02    /**< Cipher accepts keys of variable length. */\r
  72 \r
  73 #ifdef __cplusplus\r
  74 extern "C" {\r
  75 #endif\r
  76 \r
  77 /**\r
  78  * \brief     Supported cipher types.\r
  79  *\r
  80  * \warning   RC4 and DES are considered weak ciphers and their use\r
  81  *            constitutes a security risk. Arm recommends considering stronger\r
  82  *            ciphers instead.\r
  83  */\r
  84 typedef enum {\r
  85     MBEDTLS_CIPHER_ID_NONE = 0,  /**< Placeholder to mark the end of cipher ID lists. */\r
  86     MBEDTLS_CIPHER_ID_NULL,      /**< The identity cipher, treated as a stream cipher. */\r
  87     MBEDTLS_CIPHER_ID_AES,       /**< The AES cipher. */\r
  88     MBEDTLS_CIPHER_ID_DES,       /**< The DES cipher. */\r
  89     MBEDTLS_CIPHER_ID_3DES,      /**< The Triple DES cipher. */\r
  90     MBEDTLS_CIPHER_ID_CAMELLIA,  /**< The Camellia cipher. */\r
  91     MBEDTLS_CIPHER_ID_BLOWFISH,  /**< The Blowfish cipher. */\r
  92     MBEDTLS_CIPHER_ID_ARC4,      /**< The RC4 cipher. */\r
  93     MBEDTLS_CIPHER_ID_ARIA,      /**< The Aria cipher. */\r
  94     MBEDTLS_CIPHER_ID_CHACHA20,  /**< The ChaCha20 cipher. */\r
  95 } mbedtls_cipher_id_t;\r
  96 \r
  97 /**\r
  98  * \brief     Supported {cipher type, cipher mode} pairs.\r
  99  *\r
 100  * \warning   RC4 and DES are considered weak ciphers and their use\r
 101  *            constitutes a security risk. Arm recommends considering stronger\r
 102  *            ciphers instead.\r
 103  */\r
 104 typedef enum {\r
 105     MBEDTLS_CIPHER_NONE = 0,             /**< Placeholder to mark the end of cipher-pair lists. */\r
 106     MBEDTLS_CIPHER_NULL,                 /**< The identity stream cipher. */\r
 107     MBEDTLS_CIPHER_AES_128_ECB,          /**< AES cipher with 128-bit ECB mode. */\r
 108     MBEDTLS_CIPHER_AES_192_ECB,          /**< AES cipher with 192-bit ECB mode. */\r
 109     MBEDTLS_CIPHER_AES_256_ECB,          /**< AES cipher with 256-bit ECB mode. */\r
 110     MBEDTLS_CIPHER_AES_128_CBC,          /**< AES cipher with 128-bit CBC mode. */\r
 111     MBEDTLS_CIPHER_AES_192_CBC,          /**< AES cipher with 192-bit CBC mode. */\r
 112     MBEDTLS_CIPHER_AES_256_CBC,          /**< AES cipher with 256-bit CBC mode. */\r
 113     MBEDTLS_CIPHER_AES_128_CFB128,       /**< AES cipher with 128-bit CFB128 mode. */\r
 114     MBEDTLS_CIPHER_AES_192_CFB128,       /**< AES cipher with 192-bit CFB128 mode. */\r
 115     MBEDTLS_CIPHER_AES_256_CFB128,       /**< AES cipher with 256-bit CFB128 mode. */\r
 116     MBEDTLS_CIPHER_AES_128_CTR,          /**< AES cipher with 128-bit CTR mode. */\r
 117     MBEDTLS_CIPHER_AES_192_CTR,          /**< AES cipher with 192-bit CTR mode. */\r
 118     MBEDTLS_CIPHER_AES_256_CTR,          /**< AES cipher with 256-bit CTR mode. */\r
 119     MBEDTLS_CIPHER_AES_128_GCM,          /**< AES cipher with 128-bit GCM mode. */\r
 120     MBEDTLS_CIPHER_AES_192_GCM,          /**< AES cipher with 192-bit GCM mode. */\r
 121     MBEDTLS_CIPHER_AES_256_GCM,          /**< AES cipher with 256-bit GCM mode. */\r
 122     MBEDTLS_CIPHER_CAMELLIA_128_ECB,     /**< Camellia cipher with 128-bit ECB mode. */\r
 123     MBEDTLS_CIPHER_CAMELLIA_192_ECB,     /**< Camellia cipher with 192-bit ECB mode. */\r
 124     MBEDTLS_CIPHER_CAMELLIA_256_ECB,     /**< Camellia cipher with 256-bit ECB mode. */\r
 125     MBEDTLS_CIPHER_CAMELLIA_128_CBC,     /**< Camellia cipher with 128-bit CBC mode. */\r
 126     MBEDTLS_CIPHER_CAMELLIA_192_CBC,     /**< Camellia cipher with 192-bit CBC mode. */\r
 127     MBEDTLS_CIPHER_CAMELLIA_256_CBC,     /**< Camellia cipher with 256-bit CBC mode. */\r
 128     MBEDTLS_CIPHER_CAMELLIA_128_CFB128,  /**< Camellia cipher with 128-bit CFB128 mode. */\r
 129     MBEDTLS_CIPHER_CAMELLIA_192_CFB128,  /**< Camellia cipher with 192-bit CFB128 mode. */\r
 130     MBEDTLS_CIPHER_CAMELLIA_256_CFB128,  /**< Camellia cipher with 256-bit CFB128 mode. */\r
 131     MBEDTLS_CIPHER_CAMELLIA_128_CTR,     /**< Camellia cipher with 128-bit CTR mode. */\r
 132     MBEDTLS_CIPHER_CAMELLIA_192_CTR,     /**< Camellia cipher with 192-bit CTR mode. */\r
 133     MBEDTLS_CIPHER_CAMELLIA_256_CTR,     /**< Camellia cipher with 256-bit CTR mode. */\r
 134     MBEDTLS_CIPHER_CAMELLIA_128_GCM,     /**< Camellia cipher with 128-bit GCM mode. */\r
 135     MBEDTLS_CIPHER_CAMELLIA_192_GCM,     /**< Camellia cipher with 192-bit GCM mode. */\r
 136     MBEDTLS_CIPHER_CAMELLIA_256_GCM,     /**< Camellia cipher with 256-bit GCM mode. */\r
 137     MBEDTLS_CIPHER_DES_ECB,              /**< DES cipher with ECB mode. */\r
 138     MBEDTLS_CIPHER_DES_CBC,              /**< DES cipher with CBC mode. */\r
 139     MBEDTLS_CIPHER_DES_EDE_ECB,          /**< DES cipher with EDE ECB mode. */\r
 140     MBEDTLS_CIPHER_DES_EDE_CBC,          /**< DES cipher with EDE CBC mode. */\r
 141     MBEDTLS_CIPHER_DES_EDE3_ECB,         /**< DES cipher with EDE3 ECB mode. */\r
 142     MBEDTLS_CIPHER_DES_EDE3_CBC,         /**< DES cipher with EDE3 CBC mode. */\r
 143     MBEDTLS_CIPHER_BLOWFISH_ECB,         /**< Blowfish cipher with ECB mode. */\r
 144     MBEDTLS_CIPHER_BLOWFISH_CBC,         /**< Blowfish cipher with CBC mode. */\r
 145     MBEDTLS_CIPHER_BLOWFISH_CFB64,       /**< Blowfish cipher with CFB64 mode. */\r
 146     MBEDTLS_CIPHER_BLOWFISH_CTR,         /**< Blowfish cipher with CTR mode. */\r
 147     MBEDTLS_CIPHER_ARC4_128,             /**< RC4 cipher with 128-bit mode. */\r
 148     MBEDTLS_CIPHER_AES_128_CCM,          /**< AES cipher with 128-bit CCM mode. */\r
 149     MBEDTLS_CIPHER_AES_192_CCM,          /**< AES cipher with 192-bit CCM mode. */\r
 150     MBEDTLS_CIPHER_AES_256_CCM,          /**< AES cipher with 256-bit CCM mode. */\r
 151     MBEDTLS_CIPHER_CAMELLIA_128_CCM,     /**< Camellia cipher with 128-bit CCM mode. */\r
 152     MBEDTLS_CIPHER_CAMELLIA_192_CCM,     /**< Camellia cipher with 192-bit CCM mode. */\r
 153     MBEDTLS_CIPHER_CAMELLIA_256_CCM,     /**< Camellia cipher with 256-bit CCM mode. */\r
 154     MBEDTLS_CIPHER_ARIA_128_ECB,         /**< Aria cipher with 128-bit key and ECB mode. */\r
 155     MBEDTLS_CIPHER_ARIA_192_ECB,         /**< Aria cipher with 192-bit key and ECB mode. */\r
 156     MBEDTLS_CIPHER_ARIA_256_ECB,         /**< Aria cipher with 256-bit key and ECB mode. */\r
 157     MBEDTLS_CIPHER_ARIA_128_CBC,         /**< Aria cipher with 128-bit key and CBC mode. */\r
 158     MBEDTLS_CIPHER_ARIA_192_CBC,         /**< Aria cipher with 192-bit key and CBC mode. */\r
 159     MBEDTLS_CIPHER_ARIA_256_CBC,         /**< Aria cipher with 256-bit key and CBC mode. */\r
 160     MBEDTLS_CIPHER_ARIA_128_CFB128,      /**< Aria cipher with 128-bit key and CFB-128 mode. */\r
 161     MBEDTLS_CIPHER_ARIA_192_CFB128,      /**< Aria cipher with 192-bit key and CFB-128 mode. */\r
 162     MBEDTLS_CIPHER_ARIA_256_CFB128,      /**< Aria cipher with 256-bit key and CFB-128 mode. */\r
 163     MBEDTLS_CIPHER_ARIA_128_CTR,         /**< Aria cipher with 128-bit key and CTR mode. */\r
 164     MBEDTLS_CIPHER_ARIA_192_CTR,         /**< Aria cipher with 192-bit key and CTR mode. */\r
 165     MBEDTLS_CIPHER_ARIA_256_CTR,         /**< Aria cipher with 256-bit key and CTR mode. */\r
 166     MBEDTLS_CIPHER_ARIA_128_GCM,         /**< Aria cipher with 128-bit key and GCM mode. */\r
 167     MBEDTLS_CIPHER_ARIA_192_GCM,         /**< Aria cipher with 192-bit key and GCM mode. */\r
 168     MBEDTLS_CIPHER_ARIA_256_GCM,         /**< Aria cipher with 256-bit key and GCM mode. */\r
 169     MBEDTLS_CIPHER_ARIA_128_CCM,         /**< Aria cipher with 128-bit key and CCM mode. */\r
 170     MBEDTLS_CIPHER_ARIA_192_CCM,         /**< Aria cipher with 192-bit key and CCM mode. */\r
 171     MBEDTLS_CIPHER_ARIA_256_CCM,         /**< Aria cipher with 256-bit key and CCM mode. */\r
 172     MBEDTLS_CIPHER_AES_128_OFB,          /**< AES 128-bit cipher in OFB mode. */\r
 173     MBEDTLS_CIPHER_AES_192_OFB,          /**< AES 192-bit cipher in OFB mode. */\r
 174     MBEDTLS_CIPHER_AES_256_OFB,          /**< AES 256-bit cipher in OFB mode. */\r
 175     MBEDTLS_CIPHER_AES_128_XTS,          /**< AES 128-bit cipher in XTS block mode. */\r
 176     MBEDTLS_CIPHER_AES_256_XTS,          /**< AES 256-bit cipher in XTS block mode. */\r
 177     MBEDTLS_CIPHER_CHACHA20,             /**< ChaCha20 stream cipher. */\r
 178     MBEDTLS_CIPHER_CHACHA20_POLY1305,    /**< ChaCha20-Poly1305 AEAD cipher. */\r
 179     MBEDTLS_CIPHER_AES_128_KW,           /**< AES cipher with 128-bit NIST KW mode. */\r
 180     MBEDTLS_CIPHER_AES_192_KW,           /**< AES cipher with 192-bit NIST KW mode. */\r
 181     MBEDTLS_CIPHER_AES_256_KW,           /**< AES cipher with 256-bit NIST KW mode. */\r
 182     MBEDTLS_CIPHER_AES_128_KWP,          /**< AES cipher with 128-bit NIST KWP mode. */\r
 183     MBEDTLS_CIPHER_AES_192_KWP,          /**< AES cipher with 192-bit NIST KWP mode. */\r
 184     MBEDTLS_CIPHER_AES_256_KWP,          /**< AES cipher with 256-bit NIST KWP mode. */\r
 185 } mbedtls_cipher_type_t;\r
 186 \r
 187 /** Supported cipher modes. */\r
 188 typedef enum {\r
 189     MBEDTLS_MODE_NONE = 0,               /**< None.                        */\r
 190     MBEDTLS_MODE_ECB,                    /**< The ECB cipher mode.         */\r
 191     MBEDTLS_MODE_CBC,                    /**< The CBC cipher mode.         */\r
 192     MBEDTLS_MODE_CFB,                    /**< The CFB cipher mode.         */\r
 193     MBEDTLS_MODE_OFB,                    /**< The OFB cipher mode.         */\r
 194     MBEDTLS_MODE_CTR,                    /**< The CTR cipher mode.         */\r
 195     MBEDTLS_MODE_GCM,                    /**< The GCM cipher mode.         */\r
 196     MBEDTLS_MODE_STREAM,                 /**< The stream cipher mode.      */\r
 197     MBEDTLS_MODE_CCM,                    /**< The CCM cipher mode.         */\r
 198     MBEDTLS_MODE_XTS,                    /**< The XTS cipher mode.         */\r
 199     MBEDTLS_MODE_CHACHAPOLY,             /**< The ChaCha-Poly cipher mode. */\r
 200     MBEDTLS_MODE_KW,                     /**< The SP800-38F KW mode */\r
 201     MBEDTLS_MODE_KWP,                    /**< The SP800-38F KWP mode */\r
 202 } mbedtls_cipher_mode_t;\r
 203 \r
 204 /** Supported cipher padding types. */\r
 205 typedef enum {\r
 206     MBEDTLS_PADDING_PKCS7 = 0,     /**< PKCS7 padding (default).        */\r
 207     MBEDTLS_PADDING_ONE_AND_ZEROS, /**< ISO/IEC 7816-4 padding.         */\r
 208     MBEDTLS_PADDING_ZEROS_AND_LEN, /**< ANSI X.923 padding.             */\r
 209     MBEDTLS_PADDING_ZEROS,         /**< Zero padding (not reversible). */\r
 210     MBEDTLS_PADDING_NONE,          /**< Never pad (full blocks only).   */\r
 211 } mbedtls_cipher_padding_t;\r
 212 \r
 213 /** Type of operation. */\r
 214 typedef enum {\r
 215     MBEDTLS_OPERATION_NONE = -1,\r
 216     MBEDTLS_DECRYPT = 0,\r
 217     MBEDTLS_ENCRYPT,\r
 218 } mbedtls_operation_t;\r
 219 \r
 220 enum {\r
 221     /** Undefined key length. */\r
 222     MBEDTLS_KEY_LENGTH_NONE = 0,\r
 223     /** Key length, in bits (including parity), for DES keys. */\r
 224     MBEDTLS_KEY_LENGTH_DES  = 64,\r
 225     /** Key length in bits, including parity, for DES in two-key EDE. */\r
 226     MBEDTLS_KEY_LENGTH_DES_EDE = 128,\r
 227     /** Key length in bits, including parity, for DES in three-key EDE. */\r
 228     MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,\r
 229 };\r
 230 \r
 231 /** Maximum length of any IV, in Bytes. */\r
 232 #define MBEDTLS_MAX_IV_LENGTH      16\r
 233 /** Maximum block size of any cipher, in Bytes. */\r
 234 #define MBEDTLS_MAX_BLOCK_LENGTH   16\r
 235 \r
 236 /**\r
 237  * Base cipher information (opaque struct).\r
 238  */\r
 239 typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t;\r
 240 \r
 241 /**\r
 242  * CMAC context (opaque struct).\r
 243  */\r
 244 typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t;\r
 245 \r
 246 /**\r
 247  * Cipher information. Allows calling cipher functions\r
 248  * in a generic way.\r
 249  */\r
 250 typedef struct mbedtls_cipher_info_t\r
 251 {\r
 252     /** Full cipher identifier. For example,\r
 253      * MBEDTLS_CIPHER_AES_256_CBC.\r
 254      */\r
 255     mbedtls_cipher_type_t type;\r
 256 \r
 257     /** The cipher mode. For example, MBEDTLS_MODE_CBC. */\r
 258     mbedtls_cipher_mode_t mode;\r
 259 \r
 260     /** The cipher key length, in bits. This is the\r
 261      * default length for variable sized ciphers.\r
 262      * Includes parity bits for ciphers like DES.\r
 263      */\r
 264     unsigned int key_bitlen;\r
 265 \r
 266     /** Name of the cipher. */\r
 267     const char * name;\r
 268 \r
 269     /** IV or nonce size, in Bytes.\r
 270      * For ciphers that accept variable IV sizes,\r
 271      * this is the recommended size.\r
 272      */\r
 273     unsigned int iv_size;\r
 274 \r
 275     /** Bitflag comprised of MBEDTLS_CIPHER_VARIABLE_IV_LEN and\r
 276      *  MBEDTLS_CIPHER_VARIABLE_KEY_LEN indicating whether the\r
 277      *  cipher supports variable IV or variable key sizes, respectively.\r
 278      */\r
 279     int flags;\r
 280 \r
 281     /** The block size, in Bytes. */\r
 282     unsigned int block_size;\r
 283 \r
 284     /** Struct for base cipher information and functions. */\r
 285     const mbedtls_cipher_base_t *base;\r
 286 \r
 287 } mbedtls_cipher_info_t;\r
 288 \r
 289 /**\r
 290  * Generic cipher context.\r
 291  */\r
 292 typedef struct mbedtls_cipher_context_t\r
 293 {\r
 294     /** Information about the associated cipher. */\r
 295     const mbedtls_cipher_info_t *cipher_info;\r
 296 \r
 297     /** Key length to use. */\r
 298     int key_bitlen;\r
 299 \r
 300     /** Operation that the key of the context has been\r
 301      * initialized for.\r
 302      */\r
 303     mbedtls_operation_t operation;\r
 304 \r
 305 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)\r
 306     /** Padding functions to use, if relevant for\r
 307      * the specific cipher mode.\r
 308      */\r
 309     void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );\r
 310     int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );\r
 311 #endif\r
 312 \r
 313     /** Buffer for input that has not been processed yet. */\r
 314     unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];\r
 315 \r
 316     /** Number of Bytes that have not been processed yet. */\r
 317     size_t unprocessed_len;\r
 318 \r
 319     /** Current IV or NONCE_COUNTER for CTR-mode, data unit (or sector) number\r
 320      * for XTS-mode. */\r
 321     unsigned char iv[MBEDTLS_MAX_IV_LENGTH];\r
 322 \r
 323     /** IV size in Bytes, for ciphers with variable-length IVs. */\r
 324     size_t iv_size;\r
 325 \r
 326     /** The cipher-specific context. */\r
 327     void *cipher_ctx;\r
 328 \r
 329 #if defined(MBEDTLS_CMAC_C)\r
 330     /** CMAC-specific context. */\r
 331     mbedtls_cmac_context_t *cmac_ctx;\r
 332 #endif\r
 333 \r
 334 #if defined(MBEDTLS_USE_PSA_CRYPTO)\r
 335     /** Indicates whether the cipher operations should be performed\r
 336      *  by Mbed TLS' own crypto library or an external implementation\r
 337      *  of the PSA Crypto API.\r
 338      *  This is unset if the cipher context was established through\r
 339      *  mbedtls_cipher_setup(), and set if it was established through\r
 340      *  mbedtls_cipher_setup_psa().\r
 341      */\r
 342     unsigned char psa_enabled;\r
 343 #endif /* MBEDTLS_USE_PSA_CRYPTO */\r
 344 \r
 345 } mbedtls_cipher_context_t;\r
 346 \r
 347 /**\r
 348  * \brief This function retrieves the list of ciphers supported\r
 349  *        by the generic cipher module.\r
 350  *\r
 351  *        For any cipher identifier in the returned list, you can\r
 352  *        obtain the corresponding generic cipher information structure\r
 353  *        via mbedtls_cipher_info_from_type(), which can then be used\r
 354  *        to prepare a cipher context via mbedtls_cipher_setup().\r
 355  *\r
 356  *\r
 357  * \return      A statically-allocated array of cipher identifiers\r
 358  *              of type cipher_type_t. The last entry is zero.\r
 359  */\r
 360 const int *mbedtls_cipher_list( void );\r
 361 \r
 362 /**\r
 363  * \brief               This function retrieves the cipher-information\r
 364  *                      structure associated with the given cipher name.\r
 365  *\r
 366  * \param cipher_name   Name of the cipher to search for. This must not be\r
 367  *                      \c NULL.\r
 368  *\r
 369  * \return              The cipher information structure associated with the\r
 370  *                      given \p cipher_name.\r
 371  * \return              \c NULL if the associated cipher information is not found.\r
 372  */\r
 373 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );\r
 374 \r
 375 /**\r
 376  * \brief               This function retrieves the cipher-information\r
 377  *                      structure associated with the given cipher type.\r
 378  *\r
 379  * \param cipher_type   Type of the cipher to search for.\r
 380  *\r
 381  * \return              The cipher information structure associated with the\r
 382  *                      given \p cipher_type.\r
 383  * \return              \c NULL if the associated cipher information is not found.\r
 384  */\r
 385 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type( const mbedtls_cipher_type_t cipher_type );\r
 386 \r
 387 /**\r
 388  * \brief               This function retrieves the cipher-information\r
 389  *                      structure associated with the given cipher ID,\r
 390  *                      key size and mode.\r
 391  *\r
 392  * \param cipher_id     The ID of the cipher to search for. For example,\r
 393  *                      #MBEDTLS_CIPHER_ID_AES.\r
 394  * \param key_bitlen    The length of the key in bits.\r
 395  * \param mode          The cipher mode. For example, #MBEDTLS_MODE_CBC.\r
 396  *\r
 397  * \return              The cipher information structure associated with the\r
 398  *                      given \p cipher_id.\r
 399  * \return              \c NULL if the associated cipher information is not found.\r
 400  */\r
 401 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_values( const mbedtls_cipher_id_t cipher_id,\r
 402                                               int key_bitlen,\r
 403                                               const mbedtls_cipher_mode_t mode );\r
 404 \r
 405 /**\r
 406  * \brief               This function initializes a \p cipher_context as NONE.\r
 407  *\r
 408  * \param ctx           The context to be initialized. This must not be \c NULL.\r
 409  */\r
 410 void mbedtls_cipher_init( mbedtls_cipher_context_t *ctx );\r
 411 \r
 412 /**\r
 413  * \brief               This function frees and clears the cipher-specific\r
 414  *                      context of \p ctx. Freeing \p ctx itself remains the\r
 415  *                      responsibility of the caller.\r
 416  *\r
 417  * \param ctx           The context to be freed. If this is \c NULL, the\r
 418  *                      function has no effect, otherwise this must point to an\r
 419  *                      initialized context.\r
 420  */\r
 421 void mbedtls_cipher_free( mbedtls_cipher_context_t *ctx );\r
 422 \r
 423 \r
 424 /**\r
 425  * \brief               This function initializes a cipher context for\r
 426  *                      use with the given cipher primitive.\r
 427  *\r
 428  * \param ctx           The context to initialize. This must be initialized.\r
 429  * \param cipher_info   The cipher to use.\r
 430  *\r
 431  * \return              \c 0 on success.\r
 432  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 433  *                      parameter-verification failure.\r
 434  * \return              #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the\r
 435  *                      cipher-specific context fails.\r
 436  *\r
 437  * \internal Currently, the function also clears the structure.\r
 438  * In future versions, the caller will be required to call\r
 439  * mbedtls_cipher_init() on the structure first.\r
 440  */\r
 441 int mbedtls_cipher_setup( mbedtls_cipher_context_t *ctx,\r
 442                           const mbedtls_cipher_info_t *cipher_info );\r
 443 \r
 444 #if defined(MBEDTLS_USE_PSA_CRYPTO)\r
 445 /**\r
 446  * \brief               This function initializes a cipher context for\r
 447  *                      PSA-based use with the given cipher primitive.\r
 448  *\r
 449  * \note                See #MBEDTLS_USE_PSA_CRYPTO for information on PSA.\r
 450  *\r
 451  * \param ctx           The context to initialize. May not be \c NULL.\r
 452  * \param cipher_info   The cipher to use.\r
 453  * \param taglen        For AEAD ciphers, the length in bytes of the\r
 454  *                      authentication tag to use. Subsequent uses of\r
 455  *                      mbedtls_cipher_auth_encrypt() or\r
 456  *                      mbedtls_cipher_auth_decrypt() must provide\r
 457  *                      the same tag length.\r
 458  *                      For non-AEAD ciphers, the value must be \c 0.\r
 459  *\r
 460  * \return              \c 0 on success.\r
 461  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 462  *                      parameter-verification failure.\r
 463  * \return              #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the\r
 464  *                      cipher-specific context fails.\r
 465  */\r
 466 int mbedtls_cipher_setup_psa( mbedtls_cipher_context_t *ctx,\r
 467                               const mbedtls_cipher_info_t *cipher_info,\r
 468                               size_t taglen );\r
 469 #endif /* MBEDTLS_USE_PSA_CRYPTO */\r
 470 \r
 471 /**\r
 472  * \brief        This function returns the block size of the given cipher.\r
 473  *\r
 474  * \param ctx    The context of the cipher. This must be initialized.\r
 475  *\r
 476  * \return       The block size of the underlying cipher.\r
 477  * \return       \c 0 if \p ctx has not been initialized.\r
 478  */\r
 479 static inline unsigned int mbedtls_cipher_get_block_size(\r
 480     const mbedtls_cipher_context_t *ctx )\r
 481 {\r
 482     MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );\r
 483     if( ctx->cipher_info == NULL )\r
 484         return 0;\r
 485 \r
 486     return ctx->cipher_info->block_size;\r
 487 }\r
 488 \r
 489 /**\r
 490  * \brief        This function returns the mode of operation for\r
 491  *               the cipher. For example, MBEDTLS_MODE_CBC.\r
 492  *\r
 493  * \param ctx    The context of the cipher. This must be initialized.\r
 494  *\r
 495  * \return       The mode of operation.\r
 496  * \return       #MBEDTLS_MODE_NONE if \p ctx has not been initialized.\r
 497  */\r
 498 static inline mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode(\r
 499     const mbedtls_cipher_context_t *ctx )\r
 500 {\r
 501     MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, MBEDTLS_MODE_NONE );\r
 502     if( ctx->cipher_info == NULL )\r
 503         return MBEDTLS_MODE_NONE;\r
 504 \r
 505     return ctx->cipher_info->mode;\r
 506 }\r
 507 \r
 508 /**\r
 509  * \brief       This function returns the size of the IV or nonce\r
 510  *              of the cipher, in Bytes.\r
 511  *\r
 512  * \param ctx   The context of the cipher. This must be initialized.\r
 513  *\r
 514  * \return      The recommended IV size if no IV has been set.\r
 515  * \return      \c 0 for ciphers not using an IV or a nonce.\r
 516  * \return      The actual size if an IV has been set.\r
 517  */\r
 518 static inline int mbedtls_cipher_get_iv_size(\r
 519     const mbedtls_cipher_context_t *ctx )\r
 520 {\r
 521     MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );\r
 522     if( ctx->cipher_info == NULL )\r
 523         return 0;\r
 524 \r
 525     if( ctx->iv_size != 0 )\r
 526         return (int) ctx->iv_size;\r
 527 \r
 528     return (int) ctx->cipher_info->iv_size;\r
 529 }\r
 530 \r
 531 /**\r
 532  * \brief               This function returns the type of the given cipher.\r
 533  *\r
 534  * \param ctx           The context of the cipher. This must be initialized.\r
 535  *\r
 536  * \return              The type of the cipher.\r
 537  * \return              #MBEDTLS_CIPHER_NONE if \p ctx has not been initialized.\r
 538  */\r
 539 static inline mbedtls_cipher_type_t mbedtls_cipher_get_type(\r
 540     const mbedtls_cipher_context_t *ctx )\r
 541 {\r
 542     MBEDTLS_INTERNAL_VALIDATE_RET(\r
 543         ctx != NULL, MBEDTLS_CIPHER_NONE );\r
 544     if( ctx->cipher_info == NULL )\r
 545         return MBEDTLS_CIPHER_NONE;\r
 546 \r
 547     return ctx->cipher_info->type;\r
 548 }\r
 549 \r
 550 /**\r
 551  * \brief               This function returns the name of the given cipher\r
 552  *                      as a string.\r
 553  *\r
 554  * \param ctx           The context of the cipher. This must be initialized.\r
 555  *\r
 556  * \return              The name of the cipher.\r
 557  * \return              NULL if \p ctx has not been not initialized.\r
 558  */\r
 559 static inline const char *mbedtls_cipher_get_name(\r
 560     const mbedtls_cipher_context_t *ctx )\r
 561 {\r
 562     MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );\r
 563     if( ctx->cipher_info == NULL )\r
 564         return 0;\r
 565 \r
 566     return ctx->cipher_info->name;\r
 567 }\r
 568 \r
 569 /**\r
 570  * \brief               This function returns the key length of the cipher.\r
 571  *\r
 572  * \param ctx           The context of the cipher. This must be initialized.\r
 573  *\r
 574  * \return              The key length of the cipher in bits.\r
 575  * \return              #MBEDTLS_KEY_LENGTH_NONE if ctx \p has not been\r
 576  *                      initialized.\r
 577  */\r
 578 static inline int mbedtls_cipher_get_key_bitlen(\r
 579     const mbedtls_cipher_context_t *ctx )\r
 580 {\r
 581     MBEDTLS_INTERNAL_VALIDATE_RET(\r
 582         ctx != NULL, MBEDTLS_KEY_LENGTH_NONE );\r
 583     if( ctx->cipher_info == NULL )\r
 584         return MBEDTLS_KEY_LENGTH_NONE;\r
 585 \r
 586     return (int) ctx->cipher_info->key_bitlen;\r
 587 }\r
 588 \r
 589 /**\r
 590  * \brief          This function returns the operation of the given cipher.\r
 591  *\r
 592  * \param ctx      The context of the cipher. This must be initialized.\r
 593  *\r
 594  * \return         The type of operation: #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.\r
 595  * \return         #MBEDTLS_OPERATION_NONE if \p ctx has not been initialized.\r
 596  */\r
 597 static inline mbedtls_operation_t mbedtls_cipher_get_operation(\r
 598     const mbedtls_cipher_context_t *ctx )\r
 599 {\r
 600     MBEDTLS_INTERNAL_VALIDATE_RET(\r
 601         ctx != NULL, MBEDTLS_OPERATION_NONE );\r
 602     if( ctx->cipher_info == NULL )\r
 603         return MBEDTLS_OPERATION_NONE;\r
 604 \r
 605     return ctx->operation;\r
 606 }\r
 607 \r
 608 /**\r
 609  * \brief               This function sets the key to use with the given context.\r
 610  *\r
 611  * \param ctx           The generic cipher context. This must be initialized and\r
 612  *                      bound to a cipher information structure.\r
 613  * \param key           The key to use. This must be a readable buffer of at\r
 614  *                      least \p key_bitlen Bits.\r
 615  * \param key_bitlen    The key length to use, in Bits.\r
 616  * \param operation     The operation that the key will be used for:\r
 617  *                      #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.\r
 618  *\r
 619  * \return              \c 0 on success.\r
 620  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 621  *                      parameter-verification failure.\r
 622  * \return              A cipher-specific error code on failure.\r
 623  */\r
 624 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx,\r
 625                            const unsigned char *key,\r
 626                            int key_bitlen,\r
 627                            const mbedtls_operation_t operation );\r
 628 \r
 629 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)\r
 630 /**\r
 631  * \brief               This function sets the padding mode, for cipher modes\r
 632  *                      that use padding.\r
 633  *\r
 634  *                      The default passing mode is PKCS7 padding.\r
 635  *\r
 636  * \param ctx           The generic cipher context. This must be initialized and\r
 637  *                      bound to a cipher information structure.\r
 638  * \param mode          The padding mode.\r
 639  *\r
 640  * \return              \c 0 on success.\r
 641  * \return              #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE\r
 642  *                      if the selected padding mode is not supported.\r
 643  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if the cipher mode\r
 644  *                      does not support padding.\r
 645  */\r
 646 int mbedtls_cipher_set_padding_mode( mbedtls_cipher_context_t *ctx,\r
 647                                      mbedtls_cipher_padding_t mode );\r
 648 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */\r
 649 \r
 650 /**\r
 651  * \brief           This function sets the initialization vector (IV)\r
 652  *                  or nonce.\r
 653  *\r
 654  * \note            Some ciphers do not use IVs nor nonce. For these\r
 655  *                  ciphers, this function has no effect.\r
 656  *\r
 657  * \param ctx       The generic cipher context. This must be initialized and\r
 658  *                  bound to a cipher information structure.\r
 659  * \param iv        The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This\r
 660  *                  must be a readable buffer of at least \p iv_len Bytes.\r
 661  * \param iv_len    The IV length for ciphers with variable-size IV.\r
 662  *                  This parameter is discarded by ciphers with fixed-size IV.\r
 663  *\r
 664  * \return          \c 0 on success.\r
 665  * \return          #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 666  *                  parameter-verification failure.\r
 667  */\r
 668 int mbedtls_cipher_set_iv( mbedtls_cipher_context_t *ctx,\r
 669                            const unsigned char *iv,\r
 670                            size_t iv_len );\r
 671 \r
 672 /**\r
 673  * \brief         This function resets the cipher state.\r
 674  *\r
 675  * \param ctx     The generic cipher context. This must be initialized.\r
 676  *\r
 677  * \return        \c 0 on success.\r
 678  * \return        #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 679  *                parameter-verification failure.\r
 680  */\r
 681 int mbedtls_cipher_reset( mbedtls_cipher_context_t *ctx );\r
 682 \r
 683 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)\r
 684 /**\r
 685  * \brief               This function adds additional data for AEAD ciphers.\r
 686  *                      Currently supported with GCM and ChaCha20+Poly1305.\r
 687  *                      This must be called exactly once, after\r
 688  *                      mbedtls_cipher_reset().\r
 689  *\r
 690  * \param ctx           The generic cipher context. This must be initialized.\r
 691  * \param ad            The additional data to use. This must be a readable\r
 692  *                      buffer of at least \p ad_len Bytes.\r
 693  * \param ad_len        The length of \p ad in Bytes.\r
 694  *\r
 695  * \return              \c 0 on success.\r
 696  * \return              A specific error code on failure.\r
 697  */\r
 698 int mbedtls_cipher_update_ad( mbedtls_cipher_context_t *ctx,\r
 699                       const unsigned char *ad, size_t ad_len );\r
 700 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */\r
 701 \r
 702 /**\r
 703  * \brief               The generic cipher update function. It encrypts or\r
 704  *                      decrypts using the given cipher context. Writes as\r
 705  *                      many block-sized blocks of data as possible to output.\r
 706  *                      Any data that cannot be written immediately is either\r
 707  *                      added to the next block, or flushed when\r
 708  *                      mbedtls_cipher_finish() is called.\r
 709  *                      Exception: For MBEDTLS_MODE_ECB, expects a single block\r
 710  *                      in size. For example, 16 Bytes for AES.\r
 711  *\r
 712  * \note                If the underlying cipher is used in GCM mode, all calls\r
 713  *                      to this function, except for the last one before\r
 714  *                      mbedtls_cipher_finish(), must have \p ilen as a\r
 715  *                      multiple of the block size of the cipher.\r
 716  *\r
 717  * \param ctx           The generic cipher context. This must be initialized and\r
 718  *                      bound to a key.\r
 719  * \param input         The buffer holding the input data. This must be a\r
 720  *                      readable buffer of at least \p ilen Bytes.\r
 721  * \param ilen          The length of the input data.\r
 722  * \param output        The buffer for the output data. This must be able to\r
 723  *                      hold at least `ilen + block_size`. This must not be the\r
 724  *                      same buffer as \p input.\r
 725  * \param olen          The length of the output data, to be updated with the\r
 726  *                      actual number of Bytes written. This must not be\r
 727  *                      \c NULL.\r
 728  *\r
 729  * \return              \c 0 on success.\r
 730  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 731  *                      parameter-verification failure.\r
 732  * \return              #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE on an\r
 733  *                      unsupported mode for a cipher.\r
 734  * \return              A cipher-specific error code on failure.\r
 735  */\r
 736 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx,\r
 737                            const unsigned char *input,\r
 738                            size_t ilen, unsigned char *output,\r
 739                            size_t *olen );\r
 740 \r
 741 /**\r
 742  * \brief               The generic cipher finalization function. If data still\r
 743  *                      needs to be flushed from an incomplete block, the data\r
 744  *                      contained in it is padded to the size of\r
 745  *                      the last block, and written to the \p output buffer.\r
 746  *\r
 747  * \param ctx           The generic cipher context. This must be initialized and\r
 748  *                      bound to a key.\r
 749  * \param output        The buffer to write data to. This needs to be a writable\r
 750  *                      buffer of at least \p block_size Bytes.\r
 751  * \param olen          The length of the data written to the \p output buffer.\r
 752  *                      This may not be \c NULL.\r
 753  *\r
 754  * \return              \c 0 on success.\r
 755  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 756  *                      parameter-verification failure.\r
 757  * \return              #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption\r
 758  *                      expecting a full block but not receiving one.\r
 759  * \return              #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding\r
 760  *                      while decrypting.\r
 761  * \return              A cipher-specific error code on failure.\r
 762  */\r
 763 int mbedtls_cipher_finish( mbedtls_cipher_context_t *ctx,\r
 764                    unsigned char *output, size_t *olen );\r
 765 \r
 766 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)\r
 767 /**\r
 768  * \brief               This function writes a tag for AEAD ciphers.\r
 769  *                      Currently supported with GCM and ChaCha20+Poly1305.\r
 770  *                      This must be called after mbedtls_cipher_finish().\r
 771  *\r
 772  * \param ctx           The generic cipher context. This must be initialized,\r
 773  *                      bound to a key, and have just completed a cipher\r
 774  *                      operation through mbedtls_cipher_finish() the tag for\r
 775  *                      which should be written.\r
 776  * \param tag           The buffer to write the tag to. This must be a writable\r
 777  *                      buffer of at least \p tag_len Bytes.\r
 778  * \param tag_len       The length of the tag to write.\r
 779  *\r
 780  * \return              \c 0 on success.\r
 781  * \return              A specific error code on failure.\r
 782  */\r
 783 int mbedtls_cipher_write_tag( mbedtls_cipher_context_t *ctx,\r
 784                       unsigned char *tag, size_t tag_len );\r
 785 \r
 786 /**\r
 787  * \brief               This function checks the tag for AEAD ciphers.\r
 788  *                      Currently supported with GCM and ChaCha20+Poly1305.\r
 789  *                      This must be called after mbedtls_cipher_finish().\r
 790  *\r
 791  * \param ctx           The generic cipher context. This must be initialized.\r
 792  * \param tag           The buffer holding the tag. This must be a readable\r
 793  *                      buffer of at least \p tag_len Bytes.\r
 794  * \param tag_len       The length of the tag to check.\r
 795  *\r
 796  * \return              \c 0 on success.\r
 797  * \return              A specific error code on failure.\r
 798  */\r
 799 int mbedtls_cipher_check_tag( mbedtls_cipher_context_t *ctx,\r
 800                       const unsigned char *tag, size_t tag_len );\r
 801 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */\r
 802 \r
 803 /**\r
 804  * \brief               The generic all-in-one encryption/decryption function,\r
 805  *                      for all ciphers except AEAD constructs.\r
 806  *\r
 807  * \param ctx           The generic cipher context. This must be initialized.\r
 808  * \param iv            The IV to use, or NONCE_COUNTER for CTR-mode ciphers.\r
 809  *                      This must be a readable buffer of at least \p iv_len\r
 810  *                      Bytes.\r
 811  * \param iv_len        The IV length for ciphers with variable-size IV.\r
 812  *                      This parameter is discarded by ciphers with fixed-size\r
 813  *                      IV.\r
 814  * \param input         The buffer holding the input data. This must be a\r
 815  *                      readable buffer of at least \p ilen Bytes.\r
 816  * \param ilen          The length of the input data in Bytes.\r
 817  * \param output        The buffer for the output data. This must be able to\r
 818  *                      hold at least `ilen + block_size`. This must not be the\r
 819  *                      same buffer as \p input.\r
 820  * \param olen          The length of the output data, to be updated with the\r
 821  *                      actual number of Bytes written. This must not be\r
 822  *                      \c NULL.\r
 823  *\r
 824  * \note                Some ciphers do not use IVs nor nonce. For these\r
 825  *                      ciphers, use \p iv = NULL and \p iv_len = 0.\r
 826  *\r
 827  * \return              \c 0 on success.\r
 828  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 829  *                      parameter-verification failure.\r
 830  * \return              #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption\r
 831  *                      expecting a full block but not receiving one.\r
 832  * \return              #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding\r
 833  *                      while decrypting.\r
 834  * \return              A cipher-specific error code on failure.\r
 835  */\r
 836 int mbedtls_cipher_crypt( mbedtls_cipher_context_t *ctx,\r
 837                   const unsigned char *iv, size_t iv_len,\r
 838                   const unsigned char *input, size_t ilen,\r
 839                   unsigned char *output, size_t *olen );\r
 840 \r
 841 #if defined(MBEDTLS_CIPHER_MODE_AEAD)\r
 842 /**\r
 843  * \brief               The generic autenticated encryption (AEAD) function.\r
 844  *\r
 845  * \param ctx           The generic cipher context. This must be initialized and\r
 846  *                      bound to a key.\r
 847  * \param iv            The IV to use, or NONCE_COUNTER for CTR-mode ciphers.\r
 848  *                      This must be a readable buffer of at least \p iv_len\r
 849  *                      Bytes.\r
 850  * \param iv_len        The IV length for ciphers with variable-size IV.\r
 851  *                      This parameter is discarded by ciphers with fixed-size IV.\r
 852  * \param ad            The additional data to authenticate. This must be a\r
 853  *                      readable buffer of at least \p ad_len Bytes.\r
 854  * \param ad_len        The length of \p ad.\r
 855  * \param input         The buffer holding the input data. This must be a\r
 856  *                      readable buffer of at least \p ilen Bytes.\r
 857  * \param ilen          The length of the input data.\r
 858  * \param output        The buffer for the output data. This must be able to\r
 859  *                      hold at least \p ilen Bytes.\r
 860  * \param olen          The length of the output data, to be updated with the\r
 861  *                      actual number of Bytes written. This must not be\r
 862  *                      \c NULL.\r
 863  * \param tag           The buffer for the authentication tag. This must be a\r
 864  *                      writable buffer of at least \p tag_len Bytes.\r
 865  * \param tag_len       The desired length of the authentication tag.\r
 866  *\r
 867  * \return              \c 0 on success.\r
 868  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 869  *                      parameter-verification failure.\r
 870  * \return              A cipher-specific error code on failure.\r
 871  */\r
 872 int mbedtls_cipher_auth_encrypt( mbedtls_cipher_context_t *ctx,\r
 873                          const unsigned char *iv, size_t iv_len,\r
 874                          const unsigned char *ad, size_t ad_len,\r
 875                          const unsigned char *input, size_t ilen,\r
 876                          unsigned char *output, size_t *olen,\r
 877                          unsigned char *tag, size_t tag_len );\r
 878 \r
 879 /**\r
 880  * \brief               The generic autenticated decryption (AEAD) function.\r
 881  *\r
 882  * \note                If the data is not authentic, then the output buffer\r
 883  *                      is zeroed out to prevent the unauthentic plaintext being\r
 884  *                      used, making this interface safer.\r
 885  *\r
 886  * \param ctx           The generic cipher context. This must be initialized and\r
 887  *                      and bound to a key.\r
 888  * \param iv            The IV to use, or NONCE_COUNTER for CTR-mode ciphers.\r
 889  *                      This must be a readable buffer of at least \p iv_len\r
 890  *                      Bytes.\r
 891  * \param iv_len        The IV length for ciphers with variable-size IV.\r
 892  *                      This parameter is discarded by ciphers with fixed-size IV.\r
 893  * \param ad            The additional data to be authenticated. This must be a\r
 894  *                      readable buffer of at least \p ad_len Bytes.\r
 895  * \param ad_len        The length of \p ad.\r
 896  * \param input         The buffer holding the input data. This must be a\r
 897  *                      readable buffer of at least \p ilen Bytes.\r
 898  * \param ilen          The length of the input data.\r
 899  * \param output        The buffer for the output data.\r
 900  *                      This must be able to hold at least \p ilen Bytes.\r
 901  * \param olen          The length of the output data, to be updated with the\r
 902  *                      actual number of Bytes written. This must not be\r
 903  *                      \c NULL.\r
 904  * \param tag           The buffer holding the authentication tag. This must be\r
 905  *                      a readable buffer of at least \p tag_len Bytes.\r
 906  * \param tag_len       The length of the authentication tag.\r
 907  *\r
 908  * \return              \c 0 on success.\r
 909  * \return              #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on\r
 910  *                      parameter-verification failure.\r
 911  * \return              #MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.\r
 912  * \return              A cipher-specific error code on failure.\r
 913  */\r
 914 int mbedtls_cipher_auth_decrypt( mbedtls_cipher_context_t *ctx,\r
 915                          const unsigned char *iv, size_t iv_len,\r
 916                          const unsigned char *ad, size_t ad_len,\r
 917                          const unsigned char *input, size_t ilen,\r
 918                          unsigned char *output, size_t *olen,\r
 919                          const unsigned char *tag, size_t tag_len );\r
 920 #endif /* MBEDTLS_CIPHER_MODE_AEAD */\r
 921 \r
 922 #ifdef __cplusplus\r
 923 }\r
 924 #endif\r
 925 \r
 926 #endif /* MBEDTLS_CIPHER_H */\r