This file contains an abstraction interface for use with the cipher primitives provided by the library. It provides a common interface to all of the available cipher operations. More...

#include "config.h"
#include <stddef.h>
#include "platform_util.h"

Include dependency graph for cipher.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	mbedtls_cipher_info_t

struct	mbedtls_cipher_context_t

Macros
#define	MBEDTLS_CIPHER_MODE_AEAD

#define	MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080

#define	MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100

#define	MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180

#define	MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200

#define	MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280

#define	MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300

#define	MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380

#define	MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400

#define	MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01

#define	MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02

#define	MBEDTLS_MAX_IV_LENGTH 16

#define	MBEDTLS_MAX_BLOCK_LENGTH 16

Typedefs
typedef struct mbedtls_cipher_base_t	mbedtls_cipher_base_t

typedef struct mbedtls_cmac_context_t	mbedtls_cmac_context_t

typedef struct mbedtls_cipher_info_t	mbedtls_cipher_info_t

typedef struct mbedtls_cipher_context_t	mbedtls_cipher_context_t

Enumerations
enum	mbedtls_cipher_id_t { MBEDTLS_CIPHER_ID_NONE = 0, MBEDTLS_CIPHER_ID_NULL, MBEDTLS_CIPHER_ID_AES, MBEDTLS_CIPHER_ID_DES, MBEDTLS_CIPHER_ID_3DES, MBEDTLS_CIPHER_ID_CAMELLIA, MBEDTLS_CIPHER_ID_BLOWFISH, MBEDTLS_CIPHER_ID_ARC4, MBEDTLS_CIPHER_ID_ARIA, MBEDTLS_CIPHER_ID_CHACHA20 }
	Supported cipher types. More...

enum	mbedtls_cipher_type_t { MBEDTLS_CIPHER_NONE = 0, MBEDTLS_CIPHER_NULL, MBEDTLS_CIPHER_AES_128_ECB, MBEDTLS_CIPHER_AES_192_ECB, MBEDTLS_CIPHER_AES_256_ECB, MBEDTLS_CIPHER_AES_128_CBC, MBEDTLS_CIPHER_AES_192_CBC, MBEDTLS_CIPHER_AES_256_CBC, MBEDTLS_CIPHER_AES_128_CFB128, MBEDTLS_CIPHER_AES_192_CFB128, MBEDTLS_CIPHER_AES_256_CFB128, MBEDTLS_CIPHER_AES_128_CTR, MBEDTLS_CIPHER_AES_192_CTR, MBEDTLS_CIPHER_AES_256_CTR, MBEDTLS_CIPHER_AES_128_GCM, MBEDTLS_CIPHER_AES_192_GCM, MBEDTLS_CIPHER_AES_256_GCM, MBEDTLS_CIPHER_CAMELLIA_128_ECB, MBEDTLS_CIPHER_CAMELLIA_192_ECB, MBEDTLS_CIPHER_CAMELLIA_256_ECB, MBEDTLS_CIPHER_CAMELLIA_128_CBC, MBEDTLS_CIPHER_CAMELLIA_192_CBC, MBEDTLS_CIPHER_CAMELLIA_256_CBC, MBEDTLS_CIPHER_CAMELLIA_128_CFB128, MBEDTLS_CIPHER_CAMELLIA_192_CFB128, MBEDTLS_CIPHER_CAMELLIA_256_CFB128, MBEDTLS_CIPHER_CAMELLIA_128_CTR, MBEDTLS_CIPHER_CAMELLIA_192_CTR, MBEDTLS_CIPHER_CAMELLIA_256_CTR, MBEDTLS_CIPHER_CAMELLIA_128_GCM, MBEDTLS_CIPHER_CAMELLIA_192_GCM, MBEDTLS_CIPHER_CAMELLIA_256_GCM, MBEDTLS_CIPHER_DES_ECB, MBEDTLS_CIPHER_DES_CBC, MBEDTLS_CIPHER_DES_EDE_ECB, MBEDTLS_CIPHER_DES_EDE_CBC, MBEDTLS_CIPHER_DES_EDE3_ECB, MBEDTLS_CIPHER_DES_EDE3_CBC, MBEDTLS_CIPHER_BLOWFISH_ECB, MBEDTLS_CIPHER_BLOWFISH_CBC, MBEDTLS_CIPHER_BLOWFISH_CFB64, MBEDTLS_CIPHER_BLOWFISH_CTR, MBEDTLS_CIPHER_ARC4_128, MBEDTLS_CIPHER_AES_128_CCM, MBEDTLS_CIPHER_AES_192_CCM, MBEDTLS_CIPHER_AES_256_CCM, MBEDTLS_CIPHER_CAMELLIA_128_CCM, MBEDTLS_CIPHER_CAMELLIA_192_CCM, MBEDTLS_CIPHER_CAMELLIA_256_CCM, MBEDTLS_CIPHER_ARIA_128_ECB, MBEDTLS_CIPHER_ARIA_192_ECB, MBEDTLS_CIPHER_ARIA_256_ECB, MBEDTLS_CIPHER_ARIA_128_CBC, MBEDTLS_CIPHER_ARIA_192_CBC, MBEDTLS_CIPHER_ARIA_256_CBC, MBEDTLS_CIPHER_ARIA_128_CFB128, MBEDTLS_CIPHER_ARIA_192_CFB128, MBEDTLS_CIPHER_ARIA_256_CFB128, MBEDTLS_CIPHER_ARIA_128_CTR, MBEDTLS_CIPHER_ARIA_192_CTR, MBEDTLS_CIPHER_ARIA_256_CTR, MBEDTLS_CIPHER_ARIA_128_GCM, MBEDTLS_CIPHER_ARIA_192_GCM, MBEDTLS_CIPHER_ARIA_256_GCM, MBEDTLS_CIPHER_ARIA_128_CCM, MBEDTLS_CIPHER_ARIA_192_CCM, MBEDTLS_CIPHER_ARIA_256_CCM, MBEDTLS_CIPHER_AES_128_OFB, MBEDTLS_CIPHER_AES_192_OFB, MBEDTLS_CIPHER_AES_256_OFB, MBEDTLS_CIPHER_AES_128_XTS, MBEDTLS_CIPHER_AES_256_XTS, MBEDTLS_CIPHER_CHACHA20, MBEDTLS_CIPHER_CHACHA20_POLY1305 }
	Supported {cipher type, cipher mode} pairs. More...

enum	mbedtls_cipher_mode_t { MBEDTLS_MODE_NONE = 0, MBEDTLS_MODE_ECB, MBEDTLS_MODE_CBC, MBEDTLS_MODE_CFB, MBEDTLS_MODE_OFB, MBEDTLS_MODE_CTR, MBEDTLS_MODE_GCM, MBEDTLS_MODE_STREAM, MBEDTLS_MODE_CCM, MBEDTLS_MODE_XTS, MBEDTLS_MODE_CHACHAPOLY }

enum	mbedtls_cipher_padding_t { MBEDTLS_PADDING_PKCS7 = 0, MBEDTLS_PADDING_ONE_AND_ZEROS, MBEDTLS_PADDING_ZEROS_AND_LEN, MBEDTLS_PADDING_ZEROS, MBEDTLS_PADDING_NONE }

enum	mbedtls_operation_t { MBEDTLS_OPERATION_NONE = -1, MBEDTLS_DECRYPT = 0, MBEDTLS_ENCRYPT }

enum	{ MBEDTLS_KEY_LENGTH_NONE = 0, MBEDTLS_KEY_LENGTH_DES = 64, MBEDTLS_KEY_LENGTH_DES_EDE = 128, MBEDTLS_KEY_LENGTH_DES_EDE3 = 192 }

Functions
const int *	mbedtls_cipher_list (void)
	This function retrieves the list of ciphers supported by the generic cipher module. More...

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. More...

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. More...

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, key size and mode. More...

void	mbedtls_cipher_init (mbedtls_cipher_context_t *ctx)
	This function initializes a `cipher_context` as NONE. More...

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 responsibility of the caller. More...

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. It also clears the structure. More...

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. More...

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. More...

int	mbedtls_cipher_reset (mbedtls_cipher_context_t *ctx)
	This function resets the cipher state. More...

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. Writes as many block-sized blocks of data as possible to output. Any data that cannot be written immediately is either added to the next block, or flushed when mbedtls_cipher_finish() is called. Exception: For MBEDTLS_MODE_ECB, expects a single block in size. For example, 16 Bytes for AES. More...

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, the data contained in it is padded to the size of the last block, and written to the `output` buffer. More...

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. More...

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. More...

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. More...

Detailed Description

This file contains an abstraction interface for use with the cipher primitives provided by the library. It provides a common interface to all of the available cipher operations.

Author: Adriaan de Jong dejon.nosp@m.g@fo.nosp@m.x-it..nosp@m.com

Macro Definition Documentation

◆ MBEDTLS_CIPHER_MODE_AEAD

#define MBEDTLS_CIPHER_MODE_AEAD

◆ MBEDTLS_CIPHER_VARIABLE_IV_LEN

#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01

Cipher accepts IVs of variable length.

◆ MBEDTLS_CIPHER_VARIABLE_KEY_LEN

#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02

Cipher accepts keys of variable length.

◆ MBEDTLS_ERR_CIPHER_ALLOC_FAILED

#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180

Failed to allocate memory.

◆ MBEDTLS_ERR_CIPHER_AUTH_FAILED

#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300

Authentication failed (for AEAD modes).

◆ MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA

#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100

Bad input parameters.

◆ MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE

#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080

The selected feature is not available.

◆ MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED

#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280

Decryption of block requires a full block.

◆ MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED

#define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400

Cipher hardware accelerator failed.

◆ MBEDTLS_ERR_CIPHER_INVALID_CONTEXT

#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380

The context is invalid. For example, because it was freed.

◆ MBEDTLS_ERR_CIPHER_INVALID_PADDING

#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200

Input data contains invalid padding and is rejected.

◆ MBEDTLS_MAX_BLOCK_LENGTH

#define MBEDTLS_MAX_BLOCK_LENGTH 16

Maximum block size of any cipher, in Bytes.

◆ MBEDTLS_MAX_IV_LENGTH

#define MBEDTLS_MAX_IV_LENGTH 16

Maximum length of any IV, in Bytes.

Typedef Documentation

◆ mbedtls_cipher_base_t

typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t

Base cipher information (opaque struct).

◆ mbedtls_cipher_context_t

typedef struct mbedtls_cipher_context_t mbedtls_cipher_context_t

Generic cipher context.

◆ mbedtls_cipher_info_t

typedef struct mbedtls_cipher_info_t mbedtls_cipher_info_t

Cipher information. Allows calling cipher functions in a generic way.

◆ mbedtls_cmac_context_t

typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t

CMAC context (opaque struct).

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
MBEDTLS_KEY_LENGTH_NONE	Undefined key length.
MBEDTLS_KEY_LENGTH_DES	Key length, in bits (including parity), for DES keys.
MBEDTLS_KEY_LENGTH_DES_EDE	Key length in bits, including parity, for DES in two-key EDE.
MBEDTLS_KEY_LENGTH_DES_EDE3	Key length in bits, including parity, for DES in three-key EDE.

◆ mbedtls_cipher_id_t

enum mbedtls_cipher_id_t

Supported cipher types.

Warning: RC4 and DES are considered weak ciphers and their use constitutes a security risk. Arm recommends considering stronger ciphers instead.

Enumerator
MBEDTLS_CIPHER_ID_NONE	Placeholder to mark the end of cipher ID lists.
MBEDTLS_CIPHER_ID_NULL	The identity cipher, treated as a stream cipher.
MBEDTLS_CIPHER_ID_AES	The AES cipher.
MBEDTLS_CIPHER_ID_DES	The DES cipher.
MBEDTLS_CIPHER_ID_3DES	The Triple DES cipher.
MBEDTLS_CIPHER_ID_CAMELLIA	The Camellia cipher.
MBEDTLS_CIPHER_ID_BLOWFISH	The Blowfish cipher.
MBEDTLS_CIPHER_ID_ARC4	The RC4 cipher.
MBEDTLS_CIPHER_ID_ARIA	The Aria cipher.
MBEDTLS_CIPHER_ID_CHACHA20	The ChaCha20 cipher.

◆ mbedtls_cipher_mode_t

enum mbedtls_cipher_mode_t

Supported cipher modes.

Enumerator
MBEDTLS_MODE_NONE	None.
MBEDTLS_MODE_ECB	The ECB cipher mode.
MBEDTLS_MODE_CBC	The CBC cipher mode.
MBEDTLS_MODE_CFB	The CFB cipher mode.
MBEDTLS_MODE_OFB	The OFB cipher mode.
MBEDTLS_MODE_CTR	The CTR cipher mode.
MBEDTLS_MODE_GCM	The GCM cipher mode.
MBEDTLS_MODE_STREAM	The stream cipher mode.
MBEDTLS_MODE_CCM	The CCM cipher mode.
MBEDTLS_MODE_XTS	The XTS cipher mode.
MBEDTLS_MODE_CHACHAPOLY	The ChaCha-Poly cipher mode.

◆ mbedtls_cipher_padding_t

enum mbedtls_cipher_padding_t

Supported cipher padding types.

Enumerator
MBEDTLS_PADDING_PKCS7	PKCS7 padding (default).
MBEDTLS_PADDING_ONE_AND_ZEROS	ISO/IEC 7816-4 padding.
MBEDTLS_PADDING_ZEROS_AND_LEN	ANSI X.923 padding.
MBEDTLS_PADDING_ZEROS	Zero padding (not reversible).
MBEDTLS_PADDING_NONE	Never pad (full blocks only).

◆ mbedtls_cipher_type_t

enum mbedtls_cipher_type_t

Supported {cipher type, cipher mode} pairs.

Warning: RC4 and DES are considered weak ciphers and their use constitutes a security risk. Arm recommends considering stronger ciphers instead.

Enumerator
MBEDTLS_CIPHER_NONE	Placeholder to mark the end of cipher-pair lists.
MBEDTLS_CIPHER_NULL	The identity stream cipher.
MBEDTLS_CIPHER_AES_128_ECB	AES cipher with 128-bit ECB mode.
MBEDTLS_CIPHER_AES_192_ECB	AES cipher with 192-bit ECB mode.
MBEDTLS_CIPHER_AES_256_ECB	AES cipher with 256-bit ECB mode.
MBEDTLS_CIPHER_AES_128_CBC	AES cipher with 128-bit CBC mode.
MBEDTLS_CIPHER_AES_192_CBC	AES cipher with 192-bit CBC mode.
MBEDTLS_CIPHER_AES_256_CBC	AES cipher with 256-bit CBC mode.
MBEDTLS_CIPHER_AES_128_CFB128	AES cipher with 128-bit CFB128 mode.
MBEDTLS_CIPHER_AES_192_CFB128	AES cipher with 192-bit CFB128 mode.
MBEDTLS_CIPHER_AES_256_CFB128	AES cipher with 256-bit CFB128 mode.
MBEDTLS_CIPHER_AES_128_CTR	AES cipher with 128-bit CTR mode.
MBEDTLS_CIPHER_AES_192_CTR	AES cipher with 192-bit CTR mode.
MBEDTLS_CIPHER_AES_256_CTR	AES cipher with 256-bit CTR mode.
MBEDTLS_CIPHER_AES_128_GCM	AES cipher with 128-bit GCM mode.
MBEDTLS_CIPHER_AES_192_GCM	AES cipher with 192-bit GCM mode.
MBEDTLS_CIPHER_AES_256_GCM	AES cipher with 256-bit GCM mode.
MBEDTLS_CIPHER_CAMELLIA_128_ECB	Camellia cipher with 128-bit ECB mode.
MBEDTLS_CIPHER_CAMELLIA_192_ECB	Camellia cipher with 192-bit ECB mode.
MBEDTLS_CIPHER_CAMELLIA_256_ECB	Camellia cipher with 256-bit ECB mode.
MBEDTLS_CIPHER_CAMELLIA_128_CBC	Camellia cipher with 128-bit CBC mode.
MBEDTLS_CIPHER_CAMELLIA_192_CBC	Camellia cipher with 192-bit CBC mode.
MBEDTLS_CIPHER_CAMELLIA_256_CBC	Camellia cipher with 256-bit CBC mode.
MBEDTLS_CIPHER_CAMELLIA_128_CFB128	Camellia cipher with 128-bit CFB128 mode.
MBEDTLS_CIPHER_CAMELLIA_192_CFB128	Camellia cipher with 192-bit CFB128 mode.
MBEDTLS_CIPHER_CAMELLIA_256_CFB128	Camellia cipher with 256-bit CFB128 mode.
MBEDTLS_CIPHER_CAMELLIA_128_CTR	Camellia cipher with 128-bit CTR mode.
MBEDTLS_CIPHER_CAMELLIA_192_CTR	Camellia cipher with 192-bit CTR mode.
MBEDTLS_CIPHER_CAMELLIA_256_CTR	Camellia cipher with 256-bit CTR mode.
MBEDTLS_CIPHER_CAMELLIA_128_GCM	Camellia cipher with 128-bit GCM mode.
MBEDTLS_CIPHER_CAMELLIA_192_GCM	Camellia cipher with 192-bit GCM mode.
MBEDTLS_CIPHER_CAMELLIA_256_GCM	Camellia cipher with 256-bit GCM mode.
MBEDTLS_CIPHER_DES_ECB	DES cipher with ECB mode.
MBEDTLS_CIPHER_DES_CBC	DES cipher with CBC mode.
MBEDTLS_CIPHER_DES_EDE_ECB	DES cipher with EDE ECB mode.
MBEDTLS_CIPHER_DES_EDE_CBC	DES cipher with EDE CBC mode.
MBEDTLS_CIPHER_DES_EDE3_ECB	DES cipher with EDE3 ECB mode.
MBEDTLS_CIPHER_DES_EDE3_CBC	DES cipher with EDE3 CBC mode.
MBEDTLS_CIPHER_BLOWFISH_ECB	Blowfish cipher with ECB mode.
MBEDTLS_CIPHER_BLOWFISH_CBC	Blowfish cipher with CBC mode.
MBEDTLS_CIPHER_BLOWFISH_CFB64	Blowfish cipher with CFB64 mode.
MBEDTLS_CIPHER_BLOWFISH_CTR	Blowfish cipher with CTR mode.
MBEDTLS_CIPHER_ARC4_128	RC4 cipher with 128-bit mode.
MBEDTLS_CIPHER_AES_128_CCM	AES cipher with 128-bit CCM mode.
MBEDTLS_CIPHER_AES_192_CCM	AES cipher with 192-bit CCM mode.
MBEDTLS_CIPHER_AES_256_CCM	AES cipher with 256-bit CCM mode.
MBEDTLS_CIPHER_CAMELLIA_128_CCM	Camellia cipher with 128-bit CCM mode.
MBEDTLS_CIPHER_CAMELLIA_192_CCM	Camellia cipher with 192-bit CCM mode.
MBEDTLS_CIPHER_CAMELLIA_256_CCM	Camellia cipher with 256-bit CCM mode.
MBEDTLS_CIPHER_ARIA_128_ECB	Aria cipher with 128-bit key and ECB mode.
MBEDTLS_CIPHER_ARIA_192_ECB	Aria cipher with 192-bit key and ECB mode.
MBEDTLS_CIPHER_ARIA_256_ECB	Aria cipher with 256-bit key and ECB mode.
MBEDTLS_CIPHER_ARIA_128_CBC	Aria cipher with 128-bit key and CBC mode.
MBEDTLS_CIPHER_ARIA_192_CBC	Aria cipher with 192-bit key and CBC mode.
MBEDTLS_CIPHER_ARIA_256_CBC	Aria cipher with 256-bit key and CBC mode.
MBEDTLS_CIPHER_ARIA_128_CFB128	Aria cipher with 128-bit key and CFB-128 mode.
MBEDTLS_CIPHER_ARIA_192_CFB128	Aria cipher with 192-bit key and CFB-128 mode.
MBEDTLS_CIPHER_ARIA_256_CFB128	Aria cipher with 256-bit key and CFB-128 mode.
MBEDTLS_CIPHER_ARIA_128_CTR	Aria cipher with 128-bit key and CTR mode.
MBEDTLS_CIPHER_ARIA_192_CTR	Aria cipher with 192-bit key and CTR mode.
MBEDTLS_CIPHER_ARIA_256_CTR	Aria cipher with 256-bit key and CTR mode.
MBEDTLS_CIPHER_ARIA_128_GCM	Aria cipher with 128-bit key and GCM mode.
MBEDTLS_CIPHER_ARIA_192_GCM	Aria cipher with 192-bit key and GCM mode.
MBEDTLS_CIPHER_ARIA_256_GCM	Aria cipher with 256-bit key and GCM mode.
MBEDTLS_CIPHER_ARIA_128_CCM	Aria cipher with 128-bit key and CCM mode.
MBEDTLS_CIPHER_ARIA_192_CCM	Aria cipher with 192-bit key and CCM mode.
MBEDTLS_CIPHER_ARIA_256_CCM	Aria cipher with 256-bit key and CCM mode.
MBEDTLS_CIPHER_AES_128_OFB	AES 128-bit cipher in OFB mode.
MBEDTLS_CIPHER_AES_192_OFB	AES 192-bit cipher in OFB mode.
MBEDTLS_CIPHER_AES_256_OFB	AES 256-bit cipher in OFB mode.
MBEDTLS_CIPHER_AES_128_XTS	AES 128-bit cipher in XTS block mode.
MBEDTLS_CIPHER_AES_256_XTS	AES 256-bit cipher in XTS block mode.
MBEDTLS_CIPHER_CHACHA20	ChaCha20 stream cipher.
MBEDTLS_CIPHER_CHACHA20_POLY1305	ChaCha20-Poly1305 AEAD cipher.

◆ mbedtls_operation_t

enum mbedtls_operation_t

Type of operation.

Enumerator
MBEDTLS_OPERATION_NONE
MBEDTLS_DECRYPT
MBEDTLS_ENCRYPT

Function Documentation

◆ mbedtls_cipher_auth_decrypt()

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.

Note: If the data is not authentic, then the output buffer is zeroed out to prevent the unauthentic plaintext being used, making this interface safer.

Parameters

ctx	The generic cipher context. This must be initialized and and bound to a key.
iv	The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least `iv_len` Bytes.
iv_len	The IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.
ad	The additional data to be authenticated. This must be a readable buffer of at least `ad_len` Bytes.
ad_len	The length of `ad`.
input	The buffer holding the input data. This must be a readable buffer of at least `ilen` Bytes.
ilen	The length of the input data.
output	The buffer for the output data. This must be able to hold at least `ilen` Bytes.
olen	The length of the output data, to be updated with the actual number of Bytes written. This must not be `NULL`.
tag	The buffer holding the authentication tag. This must be a readable buffer of at least `tag_len` Bytes.
tag_len	The length of the authentication tag.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.; A cipher-specific error code on failure.

◆ mbedtls_cipher_auth_encrypt()

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.

Parameters

ctx	The generic cipher context. This must be initialized and bound to a key.
iv	The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least `iv_len` Bytes.
iv_len	The IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.
ad	The additional data to authenticate. This must be a readable buffer of at least `ad_len` Bytes.
ad_len	The length of `ad`.
input	The buffer holding the input data. This must be a readable buffer of at least `ilen` Bytes.
ilen	The length of the input data.
output	The buffer for the output data. This must be able to hold at least `ilen` Bytes.
olen	The length of the output data, to be updated with the actual number of Bytes written. This must not be `NULL`.
tag	The buffer for the authentication tag. This must be a writable buffer of at least `tag_len` Bytes.
tag_len	The desired length of the authentication tag.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; A cipher-specific error code on failure.

◆ mbedtls_cipher_crypt()

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.

Parameters

ctx	The generic cipher context. This must be initialized.
iv	The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least `iv_len` Bytes.
iv_len	The IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.
input	The buffer holding the input data. This must be a readable buffer of at least `ilen` Bytes.
ilen	The length of the input data in Bytes.
output	The buffer for the output data. This must be able to hold at least `ilen + block_size`. This must not be the same buffer as `input`.
olen	The length of the output data, to be updated with the actual number of Bytes written. This must not be `NULL`.

Note: Some ciphers do not use IVs nor nonce. For these ciphers, use iv = NULL and iv_len = 0.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption expecting a full block but not receiving one.; MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding while decrypting.; A cipher-specific error code on failure.

◆ mbedtls_cipher_finish()

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, the data contained in it is padded to the size of the last block, and written to the output buffer.

Parameters

ctx	The generic cipher context. This must be initialized and bound to a key.
output	The buffer to write data to. This needs to be a writable buffer of at least `block_size` Bytes.
olen	The length of the data written to the `output` buffer. This may not be `NULL`.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption expecting a full block but not receiving one.; MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding while decrypting.; A cipher-specific error code on failure.

◆ mbedtls_cipher_free()

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 responsibility of the caller.

Parameters

ctx	The context to be freed. If this is `NULL`, the function has no effect, otherwise this must point to an initialized context.

Here is the call graph for this function:

◆ mbedtls_cipher_info_from_string()

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.

Parameters

cipher_name Name of the cipher to search for. This must not be NULL.

Returns: The cipher information structure associated with the given cipher_name.; NULL if the associated cipher information is not found.

◆ mbedtls_cipher_info_from_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.

Parameters

cipher_type Type of the cipher to search for.

Returns: The cipher information structure associated with the given cipher_type.; NULL if the associated cipher information is not found.

◆ mbedtls_cipher_info_from_values()

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, key size and mode.

Parameters

cipher_id	The ID of the cipher to search for. For example, MBEDTLS_CIPHER_ID_AES.
key_bitlen	The length of the key in bits.
mode	The cipher mode. For example, MBEDTLS_MODE_CBC.

Returns: The cipher information structure associated with the given cipher_id.; NULL if the associated cipher information is not found.

◆ mbedtls_cipher_init()

void mbedtls_cipher_init ( mbedtls_cipher_context_t * ctx )

This function initializes a cipher_context as NONE.

Parameters

ctx	The context to be initialized. This must not be `NULL`.

◆ mbedtls_cipher_list()

const int* mbedtls_cipher_list ( void )

This function retrieves the list of ciphers supported by the generic cipher module.

Returns: A statically-allocated array of ciphers. The last entry is zero.

◆ mbedtls_cipher_reset()

int mbedtls_cipher_reset ( mbedtls_cipher_context_t * ctx )

This function resets the cipher state.

Parameters

ctx	The generic cipher context. This must be initialized.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.

◆ mbedtls_cipher_set_iv()

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.

Note: Some ciphers do not use IVs nor nonce. For these ciphers, this function has no effect.

Parameters

ctx	The generic cipher context. This must be initialized and bound to a cipher information structure.
iv	The IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least `iv_len` Bytes.
iv_len	The IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.

◆ mbedtls_cipher_setkey()

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.

Parameters

ctx	The generic cipher context. This must be initialized and bound to a cipher information structure.
key	The key to use. This must be a readable buffer of at least `key_bitlen` Bits.
key_bitlen	The key length to use, in Bits.
operation	The operation that the key will be used for: MBEDTLS_ENCRYPT or MBEDTLS_DECRYPT.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; A cipher-specific error code on failure.

◆ mbedtls_cipher_setup()

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. It also clears the structure.

Parameters

ctx	The context to initialize. This must be initialized.
cipher_info	The cipher to use.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the cipher-specific context fails.

◆ mbedtls_cipher_update()

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. Writes as many block-sized blocks of data as possible to output. Any data that cannot be written immediately is either added to the next block, or flushed when mbedtls_cipher_finish() is called. Exception: For MBEDTLS_MODE_ECB, expects a single block in size. For example, 16 Bytes for AES.

Note: If the underlying cipher is used in GCM mode, all calls to this function, except for the last one before mbedtls_cipher_finish(), must have ilen as a multiple of the block size of the cipher.

Parameters

ctx	The generic cipher context. This must be initialized and bound to a key.
input	The buffer holding the input data. This must be a readable buffer of at least `ilen` Bytes.
ilen	The length of the input data.
output	The buffer for the output data. This must be able to hold at least `ilen + block_size`. This must not be the same buffer as `input`.
olen	The length of the output data, to be updated with the actual number of Bytes written. This must not be `NULL`.

Returns: 0 on success.; MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.; MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE on an unsupported mode for a cipher.; A cipher-specific error code on failure.

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ MBEDTLS_CIPHER_MODE_AEAD

◆ MBEDTLS_CIPHER_VARIABLE_IV_LEN

◆ MBEDTLS_CIPHER_VARIABLE_KEY_LEN

◆ MBEDTLS_ERR_CIPHER_ALLOC_FAILED

◆ MBEDTLS_ERR_CIPHER_AUTH_FAILED

◆ MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA

◆ MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE

◆ MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED

◆ MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED

◆ MBEDTLS_ERR_CIPHER_INVALID_CONTEXT

◆ MBEDTLS_ERR_CIPHER_INVALID_PADDING

◆ MBEDTLS_MAX_BLOCK_LENGTH

◆ MBEDTLS_MAX_IV_LENGTH

Typedef Documentation

◆ mbedtls_cipher_base_t

◆ mbedtls_cipher_context_t

◆ mbedtls_cipher_info_t

◆ mbedtls_cmac_context_t

Enumeration Type Documentation

◆ anonymous enum

◆ mbedtls_cipher_id_t

◆ mbedtls_cipher_mode_t

◆ mbedtls_cipher_padding_t

◆ mbedtls_cipher_type_t

◆ mbedtls_operation_t

Function Documentation

◆ mbedtls_cipher_auth_decrypt()

◆ mbedtls_cipher_auth_encrypt()

◆ mbedtls_cipher_crypt()

◆ mbedtls_cipher_finish()

◆ mbedtls_cipher_free()

◆ mbedtls_cipher_info_from_string()

◆ mbedtls_cipher_info_from_type()

◆ mbedtls_cipher_info_from_values()

◆ mbedtls_cipher_init()

◆ mbedtls_cipher_list()

◆ mbedtls_cipher_reset()

◆ mbedtls_cipher_set_iv()

◆ mbedtls_cipher_setkey()

◆ mbedtls_cipher_setup()

◆ mbedtls_cipher_update()