15#ifndef MBEDTLS_CIPHER_H
16#define MBEDTLS_CIPHER_H
18#if !defined(MBEDTLS_CONFIG_FILE)
21#include MBEDTLS_CONFIG_FILE
27#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
28#define MBEDTLS_CIPHER_MODE_AEAD
31#if defined(MBEDTLS_CIPHER_MODE_CBC)
32#define MBEDTLS_CIPHER_MODE_WITH_PADDING
35#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
36 defined(MBEDTLS_CHACHA20_C)
37#define MBEDTLS_CIPHER_MODE_STREAM
40#if (defined(__ARMCC_VERSION) || defined(_MSC_VER)) && \
41 !defined(inline) && !defined(__cplusplus)
42#define inline __inline
46#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
48#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
50#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
52#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
54#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
56#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
58#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
62#define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
64#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
65#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
229#define MBEDTLS_MAX_IV_LENGTH 16
235#define MBEDTLS_MAX_BLOCK_LENGTH 16
244#if defined(MBEDTLS_CIPHER_MODE_XTS)
245#define MBEDTLS_MAX_KEY_LENGTH 64
247#define MBEDTLS_MAX_KEY_LENGTH 32
317#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
321 void (*
add_padding)(
unsigned char *output,
size_t olen,
size_t data_len);
322 int (*
get_padding)(
unsigned char *input,
size_t ilen,
size_t *data_len);
341#if defined(MBEDTLS_CMAC_C)
346#if defined(MBEDTLS_USE_PSA_CRYPTO)
354 unsigned char psa_enabled;
475#if defined(MBEDTLS_USE_PSA_CRYPTO)
664 const unsigned char *key,
668#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
706 const unsigned char *iv,
742#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
758 const unsigned char *ad,
size_t ad_len);
796 const unsigned char *input,
797 size_t ilen,
unsigned char *output,
823 unsigned char *output,
size_t *olen);
825#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
843 unsigned char *tag,
size_t tag_len);
859 const unsigned char *tag,
size_t tag_len);
896 const unsigned char *iv,
size_t iv_len,
897 const unsigned char *input,
size_t ilen,
898 unsigned char *output,
size_t *olen);
900#if defined(MBEDTLS_CIPHER_MODE_AEAD)
901#if !defined(MBEDTLS_DEPRECATED_REMOVED)
902#if defined(MBEDTLS_DEPRECATED_WARNING)
903#define MBEDTLS_DEPRECATED __attribute__((deprecated))
905#define MBEDTLS_DEPRECATED
955 const unsigned char *iv,
size_t iv_len,
956 const unsigned char *ad,
size_t ad_len,
957 const unsigned char *input,
size_t ilen,
958 unsigned char *output,
size_t *olen,
959 unsigned char *tag,
size_t tag_len);
1014 const unsigned char *iv,
size_t iv_len,
1015 const unsigned char *ad,
size_t ad_len,
1016 const unsigned char *input,
size_t ilen,
1017 unsigned char *output,
size_t *olen,
1018 const unsigned char *tag,
size_t tag_len);
1019#undef MBEDTLS_DEPRECATED
1023#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1069 const unsigned char *iv,
size_t iv_len,
1070 const unsigned char *ad,
size_t ad_len,
1071 const unsigned char *input,
size_t ilen,
1072 unsigned char *output,
size_t output_len,
1073 size_t *olen,
size_t tag_len);
1125 const unsigned char *iv,
size_t iv_len,
1126 const unsigned char *ad,
size_t ad_len,
1127 const unsigned char *input,
size_t ilen,
1128 unsigned char *output,
size_t output_len,
1129 size_t *olen,
size_t tag_len);
int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info)
This function prepares a cipher context for use with the given cipher primitive.
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
@ MBEDTLS_CIPHER_AES_128_ECB
@ MBEDTLS_CIPHER_ARIA_256_CTR
@ MBEDTLS_CIPHER_CAMELLIA_128_GCM
@ MBEDTLS_CIPHER_AES_128_XTS
@ MBEDTLS_CIPHER_CHACHA20
@ MBEDTLS_CIPHER_DES_EDE3_CBC
@ MBEDTLS_CIPHER_ARIA_128_GCM
@ MBEDTLS_CIPHER_AES_128_CBC
@ MBEDTLS_CIPHER_AES_192_GCM
@ MBEDTLS_CIPHER_BLOWFISH_CTR
@ MBEDTLS_CIPHER_AES_128_OFB
@ MBEDTLS_CIPHER_ARIA_192_ECB
@ MBEDTLS_CIPHER_CAMELLIA_256_GCM
@ MBEDTLS_CIPHER_DES_EDE_ECB
@ MBEDTLS_CIPHER_BLOWFISH_CFB64
@ MBEDTLS_CIPHER_ARIA_256_CFB128
@ MBEDTLS_CIPHER_ARIA_192_CBC
@ MBEDTLS_CIPHER_CAMELLIA_192_CBC
@ MBEDTLS_CIPHER_ARIA_128_CTR
@ MBEDTLS_CIPHER_ARIA_192_CCM
@ MBEDTLS_CIPHER_CAMELLIA_192_GCM
@ MBEDTLS_CIPHER_AES_192_OFB
@ MBEDTLS_CIPHER_AES_256_ECB
@ MBEDTLS_CIPHER_AES_256_CTR
@ MBEDTLS_CIPHER_AES_192_CCM
@ MBEDTLS_CIPHER_AES_128_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_192_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_128_CCM
@ MBEDTLS_CIPHER_AES_128_CTR
@ MBEDTLS_CIPHER_ARIA_192_GCM
@ MBEDTLS_CIPHER_AES_256_XTS
@ MBEDTLS_CIPHER_AES_192_CFB128
@ MBEDTLS_CIPHER_ARIA_256_ECB
@ MBEDTLS_CIPHER_CAMELLIA_256_CCM
@ MBEDTLS_CIPHER_AES_256_GCM
@ MBEDTLS_CIPHER_CAMELLIA_128_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_128_CBC
@ MBEDTLS_CIPHER_AES_256_CCM
@ MBEDTLS_CIPHER_CAMELLIA_256_CFB128
@ MBEDTLS_CIPHER_ARIA_192_CTR
@ MBEDTLS_CIPHER_BLOWFISH_CBC
@ MBEDTLS_CIPHER_CAMELLIA_256_ECB
@ MBEDTLS_CIPHER_AES_256_KW
@ MBEDTLS_CIPHER_AES_128_GCM
@ MBEDTLS_CIPHER_CAMELLIA_192_ECB
@ MBEDTLS_CIPHER_AES_256_CFB128
@ MBEDTLS_CIPHER_CHACHA20_POLY1305
@ MBEDTLS_CIPHER_CAMELLIA_128_ECB
@ MBEDTLS_CIPHER_AES_192_CBC
@ MBEDTLS_CIPHER_CAMELLIA_192_CCM
@ MBEDTLS_CIPHER_ARIA_128_CCM
@ MBEDTLS_CIPHER_AES_192_CTR
@ MBEDTLS_CIPHER_AES_128_CCM
@ MBEDTLS_CIPHER_DES_EDE_CBC
@ MBEDTLS_CIPHER_ARIA_256_CBC
@ MBEDTLS_CIPHER_AES_256_OFB
@ MBEDTLS_CIPHER_ARIA_192_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_128_CTR
@ MBEDTLS_CIPHER_BLOWFISH_ECB
@ MBEDTLS_CIPHER_AES_256_KWP
@ MBEDTLS_CIPHER_AES_256_CBC
@ MBEDTLS_CIPHER_ARC4_128
@ MBEDTLS_CIPHER_CAMELLIA_192_CTR
@ MBEDTLS_CIPHER_AES_128_KW
@ MBEDTLS_CIPHER_AES_192_KW
@ MBEDTLS_CIPHER_AES_192_KWP
@ MBEDTLS_CIPHER_AES_192_ECB
@ MBEDTLS_CIPHER_ARIA_256_GCM
@ MBEDTLS_CIPHER_AES_128_KWP
@ MBEDTLS_CIPHER_DES_EDE3_ECB
@ MBEDTLS_CIPHER_ARIA_128_CBC
@ MBEDTLS_CIPHER_CAMELLIA_256_CTR
@ MBEDTLS_CIPHER_ARIA_128_ECB
@ MBEDTLS_CIPHER_CAMELLIA_256_CBC
@ MBEDTLS_CIPHER_ARIA_256_CCM
@ MBEDTLS_CIPHER_ARIA_128_CFB128
int mbedtls_cipher_setkey(mbedtls_cipher_context_t *ctx, const unsigned char *key, int key_bitlen, const mbedtls_operation_t operation)
This function sets the key to use with the given context.
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
int mbedtls_cipher_crypt(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen)
The generic all-in-one encryption/decryption function, for all ciphers except AEAD constructs.
const mbedtls_cipher_info_t * mbedtls_cipher_info_from_type(const mbedtls_cipher_type_t cipher_type)
This function retrieves the cipher-information structure associated with the given cipher type.
int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
int mbedtls_cipher_auth_decrypt_ext(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t output_len, size_t *olen, size_t tag_len)
The authenticated encryption (AEAD/NIST_KW) function.
@ MBEDTLS_KEY_LENGTH_NONE
@ MBEDTLS_KEY_LENGTH_DES_EDE
@ MBEDTLS_KEY_LENGTH_DES_EDE3
int mbedtls_cipher_set_iv(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len)
This function sets the initialization vector (IV) or nonce.
@ MBEDTLS_PADDING_ONE_AND_ZEROS
@ MBEDTLS_PADDING_ZEROS_AND_LEN
int mbedtls_cipher_auth_encrypt_ext(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t output_len, size_t *olen, size_t tag_len)
The authenticated encryption (AEAD/NIST_KW) function.
int mbedtls_cipher_finish(mbedtls_cipher_context_t *ctx, unsigned char *output, size_t *olen)
The generic cipher finalization function. If data still needs to be flushed from an incomplete block,...
static int mbedtls_cipher_get_key_bitlen(const mbedtls_cipher_context_t *ctx)
This function returns the key length of the cipher.
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
const mbedtls_cipher_info_t * mbedtls_cipher_info_from_values(const mbedtls_cipher_id_t cipher_id, int key_bitlen, const mbedtls_cipher_mode_t mode)
This function retrieves the cipher-information structure associated with the given cipher ID,...
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a ctx as NONE.
int MBEDTLS_DEPRECATED mbedtls_cipher_auth_decrypt(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, const unsigned char *tag, size_t tag_len)
The generic authenticated decryption (AEAD) function.
int mbedtls_cipher_update_ad(mbedtls_cipher_context_t *ctx, const unsigned char *ad, size_t ad_len)
This function adds additional data for AEAD ciphers. Currently supported with GCM and ChaCha20+Poly13...
int mbedtls_cipher_write_tag(mbedtls_cipher_context_t *ctx, unsigned char *tag, size_t tag_len)
This function writes a tag for AEAD ciphers. Currently supported with GCM and ChaCha20+Poly1305....
static mbedtls_operation_t mbedtls_cipher_get_operation(const mbedtls_cipher_context_t *ctx)
This function returns the operation of the given cipher.
void mbedtls_cipher_free(mbedtls_cipher_context_t *ctx)
This function frees and clears the cipher-specific context of ctx. Freeing ctx itself remains the res...
static int mbedtls_cipher_get_iv_size(const mbedtls_cipher_context_t *ctx)
This function returns the size of the IV or nonce of the cipher, in Bytes.
int mbedtls_cipher_update(mbedtls_cipher_context_t *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen)
The generic cipher update function. It encrypts or decrypts using the given cipher context....
static mbedtls_cipher_type_t mbedtls_cipher_get_type(const mbedtls_cipher_context_t *ctx)
This function returns the type of the given cipher.
static unsigned int mbedtls_cipher_get_block_size(const mbedtls_cipher_context_t *ctx)
This function returns the block size of the given cipher.
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
#define MBEDTLS_DEPRECATED
const mbedtls_cipher_info_t * mbedtls_cipher_info_from_string(const char *cipher_name)
This function retrieves the cipher-information structure associated with the given cipher name.
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
static const char * mbedtls_cipher_get_name(const mbedtls_cipher_context_t *ctx)
This function returns the name of the given cipher as a string.
#define MBEDTLS_MAX_BLOCK_LENGTH
int MBEDTLS_DEPRECATED mbedtls_cipher_auth_encrypt(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, unsigned char *tag, size_t tag_len)
The generic authenticated encryption (AEAD) function.
int mbedtls_cipher_check_tag(mbedtls_cipher_context_t *ctx, const unsigned char *tag, size_t tag_len)
This function checks the tag for AEAD ciphers. Currently supported with GCM and ChaCha20+Poly1305....
static mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode(const mbedtls_cipher_context_t *ctx)
This function returns the mode of operation for the cipher. For example, MBEDTLS_MODE_CBC.
@ MBEDTLS_MODE_CHACHAPOLY
#define MBEDTLS_MAX_IV_LENGTH
mbedtls_cipher_id_t
Supported cipher types.
@ MBEDTLS_CIPHER_ID_CAMELLIA
@ MBEDTLS_CIPHER_ID_CHACHA20
@ MBEDTLS_CIPHER_ID_BLOWFISH
int mbedtls_cipher_set_padding_mode(mbedtls_cipher_context_t *ctx, mbedtls_cipher_padding_t mode)
This function sets the padding mode, for cipher modes that use padding.
Configuration options (set of defines)
mbedtls_operation_t operation
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
void(* add_padding)(unsigned char *output, size_t olen, size_t data_len)
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
const mbedtls_cipher_info_t * cipher_info
mbedtls_cipher_type_t type
mbedtls_cipher_mode_t mode
const mbedtls_cipher_base_t * base