15#ifndef MBEDTLS_CIPHER_H
16#define MBEDTLS_CIPHER_H
24#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
25#define MBEDTLS_CIPHER_MODE_AEAD
28#if defined(MBEDTLS_CIPHER_MODE_CBC)
29#define MBEDTLS_CIPHER_MODE_WITH_PADDING
32#if defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
33 defined(MBEDTLS_CHACHA20_C)
34#define MBEDTLS_CIPHER_MODE_STREAM
38#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
40#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
42#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
44#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
46#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
48#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
50#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
52#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
53#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
220#define MBEDTLS_MAX_IV_LENGTH 16
226#define MBEDTLS_MAX_BLOCK_LENGTH 16
235#if defined(MBEDTLS_CIPHER_MODE_XTS)
236#define MBEDTLS_MAX_KEY_LENGTH 64
238#define MBEDTLS_MAX_KEY_LENGTH 32
311#define MBEDTLS_KEY_BITLEN_SHIFT 6
312#define MBEDTLS_IV_SIZE_SHIFT 2
328#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
332 void(*
MBEDTLS_PRIVATE(add_padding))(
unsigned char *output,
size_t olen,
size_t data_len);
333 int(*
MBEDTLS_PRIVATE(get_padding))(
unsigned char *input,
size_t ilen,
size_t *data_len);
352#if defined(MBEDTLS_CMAC_C)
357#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
504 return info->MBEDTLS_PRIVATE(name);
545 return (
size_t) (info->MBEDTLS_PRIVATE(block_size));
634#if defined(MBEDTLS_USE_PSA_CRYPTO)
635#if !defined(MBEDTLS_DEPRECATED_REMOVED)
681 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
685 return (
unsigned int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(block_size);
700 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
720 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
724 if (ctx->MBEDTLS_PRIVATE(iv_size) != 0) {
725 return (
int) ctx->MBEDTLS_PRIVATE(iv_size);
728 return (
int) (((int) ctx->MBEDTLS_PRIVATE(cipher_info)->
MBEDTLS_PRIVATE(iv_size)) <<
743 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
762 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
766 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(name);
781 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
785 return (
int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(key_bitlen) <<
800 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
804 return ctx->MBEDTLS_PRIVATE(operation);
824 const unsigned char *key,
828#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
873 const unsigned char *iv,
910#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
924 const unsigned char *ad,
size_t ad_len);
957 const unsigned char *input,
958 size_t ilen,
unsigned char *output,
984 unsigned char *output,
size_t *olen);
986#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
1004 unsigned char *tag,
size_t tag_len);
1020 const unsigned char *tag,
size_t tag_len);
1057 const unsigned char *iv,
size_t iv_len,
1058 const unsigned char *input,
size_t ilen,
1059 unsigned char *output,
size_t *olen);
1061#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1107 const unsigned char *iv,
size_t iv_len,
1108 const unsigned char *ad,
size_t ad_len,
1109 const unsigned char *input,
size_t ilen,
1110 unsigned char *output,
size_t output_len,
1111 size_t *olen,
size_t tag_len);
1163 const unsigned char *iv,
size_t iv_len,
1164 const unsigned char *ad,
size_t ad_len,
1165 const unsigned char *input,
size_t ilen,
1166 unsigned char *output,
size_t output_len,
1167 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_CAMELLIA_128_CCM_STAR_NO_TAG
@ MBEDTLS_CIPHER_CHACHA20
@ MBEDTLS_CIPHER_DES_EDE3_CBC
@ MBEDTLS_CIPHER_ARIA_128_GCM
@ MBEDTLS_CIPHER_AES_128_CCM_STAR_NO_TAG
@ MBEDTLS_CIPHER_AES_128_CBC
@ MBEDTLS_CIPHER_AES_192_GCM
@ MBEDTLS_CIPHER_AES_128_OFB
@ MBEDTLS_CIPHER_ARIA_192_ECB
@ MBEDTLS_CIPHER_CAMELLIA_256_GCM
@ MBEDTLS_CIPHER_DES_EDE_ECB
@ MBEDTLS_CIPHER_AES_192_CCM_STAR_NO_TAG
@ 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_CCM_STAR_NO_TAG
@ 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_CAMELLIA_256_CCM_STAR_NO_TAG
@ MBEDTLS_CIPHER_CAMELLIA_192_CCM_STAR_NO_TAG
@ MBEDTLS_CIPHER_ARIA_192_CTR
@ MBEDTLS_CIPHER_ARIA_192_CCM_STAR_NO_TAG
@ MBEDTLS_CIPHER_CAMELLIA_256_ECB
@ MBEDTLS_CIPHER_AES_256_KW
@ MBEDTLS_CIPHER_AES_128_GCM
@ MBEDTLS_CIPHER_CAMELLIA_192_ECB
@ MBEDTLS_CIPHER_ARIA_256_CCM_STAR_NO_TAG
@ 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_AES_256_KWP
@ MBEDTLS_CIPHER_AES_256_CBC
@ 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_CCM_STAR_NO_TAG
@ 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.
#define MBEDTLS_IV_SIZE_SHIFT
static size_t mbedtls_cipher_info_get_iv_size(const mbedtls_cipher_info_t *info)
This function returns the size of the IV or nonce for the cipher info structure, in bytes.
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
#define MBEDTLS_KEY_BITLEN_SHIFT
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.
static mbedtls_cipher_mode_t mbedtls_cipher_info_get_mode(const mbedtls_cipher_info_t *info)
Retrieve the operation mode for a cipher info structure.
static size_t mbedtls_cipher_info_get_block_size(const mbedtls_cipher_info_t *info)
This function returns the block size of the given cipher info structure in bytes.
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.
#define MBEDTLS_CIPHER_VARIABLE_IV_LEN
static int mbedtls_cipher_info_has_variable_iv_size(const mbedtls_cipher_info_t *info)
This function returns a non-zero value if the IV size for the given cipher is variable.
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_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...
#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN
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 in bytes.
static const char * mbedtls_cipher_info_get_name(const mbedtls_cipher_info_t *info)
Retrieve the human-readable name for a cipher info structure.
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
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
static int mbedtls_cipher_info_has_variable_key_bitlen(const mbedtls_cipher_info_t *info)
This function returns a non-zero value if the key length for the given cipher is variable.
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_type_t mbedtls_cipher_info_get_type(const mbedtls_cipher_info_t *info)
Retrieve the identifier for a cipher info structure.
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_CCM_STAR_NO_TAG
@ MBEDTLS_MODE_CHACHAPOLY
@ MBEDTLS_KEY_LENGTH_NONE
@ MBEDTLS_KEY_LENGTH_DES_EDE
@ MBEDTLS_KEY_LENGTH_DES_EDE3
#define MBEDTLS_MAX_IV_LENGTH
mbedtls_cipher_id_t
Supported cipher types.
@ MBEDTLS_CIPHER_ID_CAMELLIA
@ MBEDTLS_CIPHER_ID_CHACHA20
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.
static size_t mbedtls_cipher_info_get_key_bitlen(const mbedtls_cipher_info_t *info)
Retrieve the key size for a cipher info structure.
Build-time configuration info.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)