54 #ifndef MBEDTLS_CIPHER_H
55 #define MBEDTLS_CIPHER_H
57 #if !defined(MBEDTLS_CONFIG_FILE)
60 #include MBEDTLS_CONFIG_FILE
65 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C)
66 #define MBEDTLS_CIPHER_MODE_AEAD
69 #if defined(MBEDTLS_CIPHER_MODE_CBC)
70 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
73 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
74 #define MBEDTLS_CIPHER_MODE_STREAM
77 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
78 !defined(inline) && !defined(__cplusplus)
79 #define inline __inline
82 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
83 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
84 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
85 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
86 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
87 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
88 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
89 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
91 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
92 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
216 #define MBEDTLS_MAX_IV_LENGTH 16
218 #define MBEDTLS_MAX_BLOCK_LENGTH 16
284 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
288 void (*add_padding)(
unsigned char *output,
size_t olen,
size_t data_len );
289 int (*get_padding)(
unsigned char *input,
size_t ilen,
size_t *data_len );
307 #if defined(MBEDTLS_CMAC_C)
532 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
565 const unsigned char *iv,
size_t iv_len );
577 #if defined(MBEDTLS_GCM_C)
590 const unsigned char *ad,
size_t ad_len );
624 size_t ilen,
unsigned char *output,
size_t *olen );
645 unsigned char *output,
size_t *olen );
647 #if defined(MBEDTLS_GCM_C)
660 unsigned char *tag,
size_t tag_len );
674 const unsigned char *tag,
size_t tag_len );
706 const unsigned char *iv,
size_t iv_len,
707 const unsigned char *input,
size_t ilen,
708 unsigned char *output,
size_t *olen );
710 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
734 const unsigned char *iv,
size_t iv_len,
735 const unsigned char *ad,
size_t ad_len,
736 const unsigned char *input,
size_t ilen,
737 unsigned char *output,
size_t *olen,
738 unsigned char *tag,
size_t tag_len );
768 const unsigned char *iv,
size_t iv_len,
769 const unsigned char *ad,
size_t ad_len,
770 const unsigned char *input,
size_t ilen,
771 unsigned char *output,
size_t *olen,
772 const unsigned char *tag,
size_t tag_len );
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.
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...
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_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.
Configuration options (set of defines)
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.
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.
mbedtls_cipher_mode_t mode
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
An enumeration of supported (cipher, mode) pairs.
const mbedtls_cipher_info_t * cipher_info
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_operation_t operation
mbedtls_cipher_id_t
An enumeration of supported ciphers.
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_MAX_IV_LENGTH
int 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 autenticated decryption (AEAD) function.
int 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 autenticated encryption (AEAD) function.
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...
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. Only supported with GCM. Must be called exactly ...
int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info)
This function initializes and fills the cipher-context structure with the appropriate values...
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. Only supported with GCM. Must be called after mbedtls_...
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_write_tag(mbedtls_cipher_context_t *ctx, unsigned char *tag, size_t tag_len)
This function writes a tag for AEAD ciphers. Only supported with GCM. Must be called after mbedtls_ci...
#define MBEDTLS_MAX_BLOCK_LENGTH
mbedtls_cipher_type_t type
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...
const mbedtls_cipher_base_t * base