27 #ifndef MBEDTLS_CIPHER_H
28 #define MBEDTLS_CIPHER_H
36 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
37 #define MBEDTLS_CIPHER_MODE_AEAD
40 #if defined(MBEDTLS_CIPHER_MODE_CBC)
41 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
44 #if defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
45 defined(MBEDTLS_CHACHA20_C)
46 #define MBEDTLS_CIPHER_MODE_STREAM
49 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
50 !defined(inline) && !defined(__cplusplus)
51 #define inline __inline
55 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
57 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
59 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
61 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
63 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
65 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
67 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
69 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
70 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
237 #define MBEDTLS_MAX_IV_LENGTH 16
243 #define MBEDTLS_MAX_BLOCK_LENGTH 16
252 #if defined(MBEDTLS_CIPHER_MODE_XTS)
253 #define MBEDTLS_MAX_KEY_LENGTH 64
255 #define MBEDTLS_MAX_KEY_LENGTH 32
334 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
338 void (*
MBEDTLS_PRIVATE(add_padding))(
unsigned char *output,
size_t olen,
size_t data_len );
339 int (*
MBEDTLS_PRIVATE(get_padding))(
unsigned char *input,
size_t ilen,
size_t *data_len );
358 #if defined(MBEDTLS_CMAC_C)
363 #if defined(MBEDTLS_USE_PSA_CRYPTO)
449 return( info->MBEDTLS_PRIVATE(type) );
467 return( info->MBEDTLS_PRIVATE(mode) );
487 return( info->MBEDTLS_PRIVATE(key_bitlen) );
507 return( info->MBEDTLS_PRIVATE(name) );
526 return( (
size_t) info->MBEDTLS_PRIVATE(iv_size) );
545 return( (
size_t) info->MBEDTLS_PRIVATE(block_size) );
632 #if defined(MBEDTLS_USE_PSA_CRYPTO)
673 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
676 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(block_size);
692 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
695 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(mode);
712 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
715 if( ctx->MBEDTLS_PRIVATE(iv_size) != 0 )
716 return (
int) ctx->MBEDTLS_PRIVATE(iv_size);
718 return (
int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(iv_size);
734 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
737 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(type);
753 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
756 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(name);
773 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
776 return (
int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(key_bitlen);
792 if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
795 return ctx->MBEDTLS_PRIVATE(operation);
815 const unsigned char *key,
819 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
859 const unsigned char *iv,
896 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
910 const unsigned char *ad,
size_t ad_len );
943 const unsigned char *input,
944 size_t ilen,
unsigned char *output,
970 unsigned char *output,
size_t *olen );
972 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
990 unsigned char *tag,
size_t tag_len );
1006 const unsigned char *tag,
size_t tag_len );
1043 const unsigned char *iv,
size_t iv_len,
1044 const unsigned char *input,
size_t ilen,
1045 unsigned char *output,
size_t *olen );
1047 #if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1093 const unsigned char *iv,
size_t iv_len,
1094 const unsigned char *ad,
size_t ad_len,
1095 const unsigned char *input,
size_t ilen,
1096 unsigned char *output,
size_t output_len,
1097 size_t *olen,
size_t tag_len );
1149 const unsigned char *iv,
size_t iv_len,
1150 const unsigned char *ad,
size_t ad_len,
1151 const unsigned char *input,
size_t ilen,
1152 unsigned char *output,
size_t output_len,
1153 size_t *olen,
size_t tag_len );
#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN
#define MBEDTLS_CIPHER_VARIABLE_IV_LEN
static const char * mbedtls_cipher_info_get_name(const mbedtls_cipher_info_t *info)
Retrieve the human-readable name 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.
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.
int mbedtls_cipher_setup_psa(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info, size_t taglen)
This function initializes a cipher context for PSA-based use with the given cipher primitive...
static size_t mbedtls_cipher_info_get_key_bitlen(const mbedtls_cipher_info_t *info)
Retrieve the key size for a cipher info structure.
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...
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_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...
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.
int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
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_PRIVATE(member)
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.
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_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_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...
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...
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 mbedtls_operation_t mbedtls_cipher_get_operation(const mbedtls_cipher_context_t *ctx)
This function returns the operation of the given cipher.
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
static int mbedtls_cipher_get_key_bitlen(const mbedtls_cipher_context_t *ctx)
This function returns the key length of the cipher.
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
struct mbedtls_cipher_base_t mbedtls_cipher_base_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...
static mbedtls_cipher_type_t mbedtls_cipher_get_type(const mbedtls_cipher_context_t *ctx)
This function returns the type of the given cipher.
mbedtls_cipher_id_t
Supported cipher types.
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.
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.
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.
#define MBEDTLS_MAX_IV_LENGTH
Macro wrapper for struct's memebrs.
Build-time configuration info.
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...
struct mbedtls_cmac_context_t mbedtls_cmac_context_t
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a cipher_context 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...
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.
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. This must be called after mbedtls_cipher_finish().
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.
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
static mbedtls_cipher_type_t mbedtls_cipher_info_get_type(const mbedtls_cipher_info_t *info)
Retrieve the identifier for a cipher info structure.
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. This must be called after mbedtls_cipher_finish().
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. ...
#define MBEDTLS_MAX_BLOCK_LENGTH
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...