PolarSSL is now part of ARM Official announcement and rebranded as mbed TLS.

API Documentation (Doxygen generated)

These pages are generated with doxygen directly from the source code!

cipher.h File Reference

This file contains an abstraction interface for use with the cipher primitives provided by the library. More...

#include "config.h"
#include <stddef.h>
#include "mbedtls/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.

Data Structures

struct  mbedtls_cipher_info_t
 Cipher information. More...
 
struct  mbedtls_cipher_context_t
 Generic cipher context. More...
 

Macros

#define MBEDTLS_CIPHER_MODE_AEAD
 
#define MBEDTLS_CIPHER_MODE_WITH_PADDING
 
#define MBEDTLS_CIPHER_MODE_STREAM
 
#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE   -0x6080
 The selected feature is not available. More...
 
#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA   -0x6100
 Bad input parameters. More...
 
#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED   -0x6180
 Failed to allocate memory. More...
 
#define MBEDTLS_ERR_CIPHER_INVALID_PADDING   -0x6200
 Input data contains invalid padding and is rejected. More...
 
#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED   -0x6280
 Decryption of block requires a full block. More...
 
#define MBEDTLS_ERR_CIPHER_AUTH_FAILED   -0x6300
 Authentication failed (for AEAD modes). More...
 
#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT   -0x6380
 The context is invalid. More...
 
#define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED   -0x6400
 Cipher hardware accelerator failed. More...
 
#define MBEDTLS_CIPHER_VARIABLE_IV_LEN   0x01
 Cipher accepts IVs of variable length. More...
 
#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN   0x02
 Cipher accepts keys of variable length. More...
 
#define MBEDTLS_MAX_IV_LENGTH   16
 Maximum length of any IV, in Bytes. More...
 
#define MBEDTLS_MAX_BLOCK_LENGTH   16
 Maximum block size of any cipher, in Bytes. More...
 

Typedefs

typedef struct
mbedtls_cipher_base_t 
mbedtls_cipher_base_t
 Base cipher information (opaque struct). More...
 
typedef struct
mbedtls_cmac_context_t 
mbedtls_cmac_context_t
 CMAC context (opaque struct). More...
 
typedef struct
mbedtls_cipher_info_t 
mbedtls_cipher_info_t
 Cipher information. More...
 
typedef struct
mbedtls_cipher_context_t 
mbedtls_cipher_context_t
 Generic cipher context. More...
 

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
}
 Supported cipher modes. More...
 
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
}
 Supported cipher padding types. More...
 
enum  mbedtls_operation_t { MBEDTLS_OPERATION_NONE = -1, MBEDTLS_DECRYPT = 0, MBEDTLS_ENCRYPT }
 Type of operation. More...
 
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_tmbedtls_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_tmbedtls_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_tmbedtls_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. 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. More...
 
static unsigned int mbedtls_cipher_get_block_size (const mbedtls_cipher_context_t *ctx)
 This function returns the block size of the given cipher. More...
 
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. More...
 
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. More...
 
static mbedtls_cipher_type_t mbedtls_cipher_get_type (const mbedtls_cipher_context_t *ctx)
 This function returns the type of the given cipher. More...
 
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. More...
 
static int mbedtls_cipher_get_key_bitlen (const mbedtls_cipher_context_t *ctx)
 This function returns the key length of the cipher. More...
 
static mbedtls_operation_t mbedtls_cipher_get_operation (const mbedtls_cipher_context_t *ctx)
 This function returns the operation of the given cipher. 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_padding_mode (mbedtls_cipher_context_t *ctx, mbedtls_cipher_padding_t mode)
 This function sets the padding mode, for cipher modes that use padding. 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_ad (mbedtls_cipher_context_t *ctx, const unsigned char *ad, size_t ad_len)
 This function adds additional data for AEAD ciphers. 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. More...
 
int mbedtls_cipher_finish (mbedtls_cipher_context_t *ctx, unsigned char *output, size_t *olen)
 The generic cipher finalization function. More...
 
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. More...
 
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. 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

Definition in file cipher.h.

Macro Definition Documentation

#define MBEDTLS_CIPHER_MODE_AEAD

Definition at line 42 of file cipher.h.

#define MBEDTLS_CIPHER_MODE_STREAM

Definition at line 51 of file cipher.h.

#define MBEDTLS_CIPHER_MODE_WITH_PADDING

Definition at line 46 of file cipher.h.

#define MBEDTLS_CIPHER_VARIABLE_IV_LEN   0x01

Cipher accepts IVs of variable length.

Definition at line 70 of file cipher.h.

#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN   0x02

Cipher accepts keys of variable length.

Definition at line 71 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED   -0x6180

Failed to allocate memory.

Definition at line 61 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_AUTH_FAILED   -0x6300

Authentication failed (for AEAD modes).

Definition at line 64 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA   -0x6100

Bad input parameters.

Definition at line 60 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE   -0x6080

The selected feature is not available.

Definition at line 59 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED   -0x6280

Decryption of block requires a full block.

Definition at line 63 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED   -0x6400

Cipher hardware accelerator failed.

Definition at line 68 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT   -0x6380

The context is invalid.

For example, because it was freed.

Definition at line 65 of file cipher.h.

#define MBEDTLS_ERR_CIPHER_INVALID_PADDING   -0x6200

Input data contains invalid padding and is rejected.

Definition at line 62 of file cipher.h.

#define MBEDTLS_MAX_BLOCK_LENGTH   16

Maximum block size of any cipher, in Bytes.

Definition at line 226 of file cipher.h.

#define MBEDTLS_MAX_IV_LENGTH   16

Maximum length of any IV, in Bytes.

Definition at line 224 of file cipher.h.

Typedef Documentation

Base cipher information (opaque struct).

Definition at line 231 of file cipher.h.

Generic cipher context.

Cipher information.

Allows calling cipher functions in a generic way.

CMAC context (opaque struct).

Definition at line 236 of file cipher.h.

Enumeration Type Documentation

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.

Definition at line 212 of file cipher.h.

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.

Definition at line 84 of file cipher.h.

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.

Definition at line 182 of file cipher.h.

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

Definition at line 197 of file cipher.h.

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.

Definition at line 104 of file cipher.h.

Type of operation.

Enumerator
MBEDTLS_OPERATION_NONE 
MBEDTLS_DECRYPT 
MBEDTLS_ENCRYPT 

Definition at line 206 of file cipher.h.

Function Documentation

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
ctxThe generic cipher context. This must be initialized and and bound to a key.
ivThe IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least iv_len Bytes.
iv_lenThe IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.
adThe additional data to be authenticated. This must be a readable buffer of at least ad_len Bytes.
ad_lenThe length of ad.
inputThe buffer holding the input data. This must be a readable buffer of at least ilen Bytes.
ilenThe length of the input data.
outputThe buffer for the output data. This must be able to hold at least ilen Bytes.
olenThe length of the output data, to be updated with the actual number of Bytes written. This must not be NULL.
tagThe buffer holding the authentication tag. This must be a readable buffer of at least tag_len Bytes.
tag_lenThe 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.
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
ctxThe generic cipher context. This must be initialized and bound to a key.
ivThe IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least iv_len Bytes.
iv_lenThe IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.
adThe additional data to authenticate. This must be a readable buffer of at least ad_len Bytes.
ad_lenThe length of ad.
inputThe buffer holding the input data. This must be a readable buffer of at least ilen Bytes.
ilenThe length of the input data.
outputThe buffer for the output data. This must be able to hold at least ilen Bytes.
olenThe length of the output data, to be updated with the actual number of Bytes written. This must not be NULL.
tagThe buffer for the authentication tag. This must be a writable buffer of at least tag_len Bytes.
tag_lenThe 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.
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().

Parameters
ctxThe generic cipher context. This must be initialized.
tagThe buffer holding the tag. This must be a readable buffer of at least tag_len Bytes.
tag_lenThe length of the tag to check.
Returns
0 on success.
A specific error code on failure.
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
ctxThe generic cipher context. This must be initialized.
ivThe IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least iv_len Bytes.
iv_lenThe IV length for ciphers with variable-size IV. This parameter is discarded by ciphers with fixed-size IV.
inputThe buffer holding the input data. This must be a readable buffer of at least ilen Bytes.
ilenThe length of the input data in Bytes.
outputThe 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.
olenThe 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.
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
ctxThe generic cipher context. This must be initialized and bound to a key.
outputThe buffer to write data to. This needs to be a writable buffer of at least block_size Bytes.
olenThe 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.
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
ctxThe context to be freed. If this is NULL, the function has no effect, otherwise this must point to an initialized context.
static unsigned int mbedtls_cipher_get_block_size ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the block size of the given cipher.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The block size of the underlying cipher.
0 if ctx has not been initialized.

Definition at line 427 of file cipher.h.

References mbedtls_cipher_info_t::block_size, mbedtls_cipher_context_t::cipher_info, and MBEDTLS_INTERNAL_VALIDATE_RET.

static mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the mode of operation for the cipher.

For example, MBEDTLS_MODE_CBC.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The mode of operation.
MBEDTLS_MODE_NONE if ctx has not been initialized.

Definition at line 446 of file cipher.h.

References mbedtls_cipher_context_t::cipher_info, MBEDTLS_INTERNAL_VALIDATE_RET, MBEDTLS_MODE_NONE, and mbedtls_cipher_info_t::mode.

static int mbedtls_cipher_get_iv_size ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the size of the IV or nonce of the cipher, in Bytes.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The recommended IV size if no IV has been set.
0 for ciphers not using an IV or a nonce.
The actual size if an IV has been set.

Definition at line 466 of file cipher.h.

References mbedtls_cipher_context_t::cipher_info, mbedtls_cipher_info_t::iv_size, mbedtls_cipher_context_t::iv_size, and MBEDTLS_INTERNAL_VALIDATE_RET.

static int mbedtls_cipher_get_key_bitlen ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the key length of the cipher.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The key length of the cipher in bits.
MBEDTLS_KEY_LENGTH_NONE if ctx has not been initialized.

Definition at line 526 of file cipher.h.

References mbedtls_cipher_context_t::cipher_info, mbedtls_cipher_info_t::key_bitlen, MBEDTLS_INTERNAL_VALIDATE_RET, and MBEDTLS_KEY_LENGTH_NONE.

static const char* mbedtls_cipher_get_name ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the name of the given cipher as a string.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The name of the cipher.
NULL if ctx has not been not initialized.

Definition at line 507 of file cipher.h.

References mbedtls_cipher_context_t::cipher_info, MBEDTLS_INTERNAL_VALIDATE_RET, and mbedtls_cipher_info_t::name.

static mbedtls_operation_t mbedtls_cipher_get_operation ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the operation of the given cipher.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The type of operation: MBEDTLS_ENCRYPT or MBEDTLS_DECRYPT.
MBEDTLS_OPERATION_NONE if ctx has not been initialized.

Definition at line 545 of file cipher.h.

References mbedtls_cipher_context_t::cipher_info, MBEDTLS_INTERNAL_VALIDATE_RET, MBEDTLS_OPERATION_NONE, and mbedtls_cipher_context_t::operation.

static mbedtls_cipher_type_t mbedtls_cipher_get_type ( const mbedtls_cipher_context_t ctx)
inlinestatic

This function returns the type of the given cipher.

Parameters
ctxThe context of the cipher. This must be initialized.
Returns
The type of the cipher.
MBEDTLS_CIPHER_NONE if ctx has not been initialized.

Definition at line 487 of file cipher.h.

References mbedtls_cipher_context_t::cipher_info, MBEDTLS_CIPHER_NONE, MBEDTLS_INTERNAL_VALIDATE_RET, and mbedtls_cipher_info_t::type.

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_nameName 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.
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_typeType 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.
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_idThe ID of the cipher to search for. For example, MBEDTLS_CIPHER_ID_AES.
key_bitlenThe length of the key in bits.
modeThe 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.
void mbedtls_cipher_init ( mbedtls_cipher_context_t ctx)

This function initializes a cipher_context as NONE.

Parameters
ctxThe context to be initialized. This must not be NULL.
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.
int mbedtls_cipher_reset ( mbedtls_cipher_context_t ctx)

This function resets the cipher state.

Parameters
ctxThe generic cipher context. This must be initialized.
Returns
0 on success.
MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on parameter-verification failure.
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
ctxThe generic cipher context. This must be initialized and bound to a cipher information structure.
ivThe IV to use, or NONCE_COUNTER for CTR-mode ciphers. This must be a readable buffer of at least iv_len Bytes.
iv_lenThe 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.
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.

The default passing mode is PKCS7 padding.

Parameters
ctxThe generic cipher context. This must be initialized and bound to a cipher information structure.
modeThe padding mode.
Returns
0 on success.
MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE if the selected padding mode is not supported.
MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if the cipher mode does not support padding.
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
ctxThe generic cipher context. This must be initialized and bound to a cipher information structure.
keyThe key to use. This must be a readable buffer of at least key_bitlen Bits.
key_bitlenThe key length to use, in Bits.
operationThe 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.
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
ctxThe context to initialize. This must be initialized.
cipher_infoThe 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.
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
ctxThe generic cipher context. This must be initialized and bound to a key.
inputThe buffer holding the input data. This must be a readable buffer of at least ilen Bytes.
ilenThe length of the input data.
outputThe 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.
olenThe 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.
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+Poly1305. This must be called exactly once, after mbedtls_cipher_reset().

Parameters
ctxThe generic cipher context. This must be initialized.
adThe additional data to use. This must be a readable buffer of at least ad_len Bytes.
ad_lenthe Length of ad Bytes.
Returns
0 on success.
A specific error code on failure.
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().

Parameters
ctxThe generic cipher context. This must be initialized, bound to a key, and have just completed a cipher operation through mbedtls_cipher_finish() the tag for which should be written.
tagThe buffer to write the tag to. This must be a writable buffer of at least tag_len Bytes.
tag_lenThe length of the tag to write.
Returns
0 on success.
A specific error code on failure.