third_party/mbedtls/repo/include/mbedtls/cipher.h

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