Mbed OS Reference
Loading...
Searching...
No Matches
mbedtls_cipher_info_t Struct Reference

Cipher information. More...

#include <cipher.h>

Data Fields

mbedtls_cipher_type_t type
 Full cipher identifier. More...
 
mbedtls_cipher_mode_t mode
 The cipher mode. More...
 
unsigned int key_bitlen
 The cipher key length, in bits. More...
 
const char * name
 Name of the cipher. More...
 
unsigned int iv_size
 IV or nonce size, in Bytes. More...
 
int flags
 Bitflag comprised of MBEDTLS_CIPHER_VARIABLE_IV_LEN and MBEDTLS_CIPHER_VARIABLE_KEY_LEN indicating whether the cipher supports variable IV or variable key sizes, respectively. More...
 
unsigned int block_size
 The block size, in Bytes. More...
 
const mbedtls_cipher_base_tbase
 Struct for base cipher information and functions. More...
 

Detailed Description

Cipher information.

Allows calling cipher functions in a generic way.

Definition at line 275 of file cipher.h.

Field Documentation

◆ type

Full cipher identifier.

For example, MBEDTLS_CIPHER_AES_256_CBC.

Definition at line 280 of file cipher.h.

◆ mode

The cipher mode.

For example, MBEDTLS_MODE_CBC.

Definition at line 283 of file cipher.h.

◆ key_bitlen

unsigned int key_bitlen

The cipher key length, in bits.

This is the default length for variable sized ciphers. Includes parity bits for ciphers like DES.

Definition at line 289 of file cipher.h.

◆ name

const char* name

Name of the cipher.

Definition at line 292 of file cipher.h.

◆ iv_size

unsigned int iv_size

IV or nonce size, in Bytes.

For ciphers that accept variable IV sizes, this is the recommended size.

Definition at line 298 of file cipher.h.

◆ flags

int flags

Bitflag comprised of MBEDTLS_CIPHER_VARIABLE_IV_LEN and MBEDTLS_CIPHER_VARIABLE_KEY_LEN indicating whether the cipher supports variable IV or variable key sizes, respectively.

Definition at line 304 of file cipher.h.

◆ block_size

unsigned int block_size

The block size, in Bytes.

Definition at line 307 of file cipher.h.

◆ base

const mbedtls_cipher_base_t* base

Struct for base cipher information and functions.

Definition at line 310 of file cipher.h.