NCBI C++ ToolKit
Public Attributes | List of all members
mbedtls_cipher_info_t Struct Reference

Search Toolkit Book for mbedtls_cipher_info_t

Cipher information. More...

#include "cipher.h"
(Private to src/connect/mbedtls/mbedtls.)

+ Collaboration diagram for mbedtls_cipher_info_t:

Public Attributes

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 276 of file cipher.h.

Member Data Documentation

◆ base

const mbedtls_cipher_base_t* mbedtls_cipher_info_t::base

Struct for base cipher information and functions.

Definition at line 310 of file cipher.h.

Referenced by mbedtls_cipher_info_from_values_ncbicxx_2_28_3(), and mbedtls_cipher_setup_ncbicxx_2_28_3().

◆ block_size

unsigned int mbedtls_cipher_info_t::block_size

The block size, in Bytes.

Definition at line 307 of file cipher.h.

Referenced by mbedtls_ccm_setkey_ncbicxx_2_28_3(), mbedtls_gcm_setkey_ncbicxx_2_28_3(), and ssl_populate_transform().

◆ flags

int mbedtls_cipher_info_t::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.

◆ iv_size

unsigned int mbedtls_cipher_info_t::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.

Referenced by mbedtls_pkcs12_pbe_ncbicxx_2_28_3(), mbedtls_pkcs5_pbes2_ncbicxx_2_28_3(), and ssl_populate_transform().

◆ key_bitlen

unsigned int mbedtls_cipher_info_t::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.

Referenced by mbedtls_cipher_info_from_values_ncbicxx_2_28_3(), mbedtls_pkcs12_pbe_ncbicxx_2_28_3(), mbedtls_pkcs5_pbes2_ncbicxx_2_28_3(), mbedtls_ssl_ticket_setup_ncbicxx_2_28_3(), and ssl_populate_transform().

◆ mode

mbedtls_cipher_mode_t mbedtls_cipher_info_t::mode

The cipher mode.

For example, MBEDTLS_MODE_CBC.

Definition at line 283 of file cipher.h.

Referenced by mbedtls_cipher_info_from_values_ncbicxx_2_28_3(), mbedtls_ssl_ticket_setup_ncbicxx_2_28_3(), ssl_populate_transform(), and ssl_write_encrypt_then_mac_ext().

◆ name

const char* mbedtls_cipher_info_t::name

Name of the cipher.

Definition at line 292 of file cipher.h.

Referenced by mbedtls_cipher_info_from_string_ncbicxx_2_28_3().

◆ type

mbedtls_cipher_type_t mbedtls_cipher_info_t::type

Full cipher identifier.

For example, MBEDTLS_CIPHER_AES_256_CBC.

Definition at line 280 of file cipher.h.


The documentation for this struct was generated from the following file:
Modified on Wed Feb 21 09:58:07 2024 by modify_doxy.py rev. 669887