OPTIGA™ Trust M
Host Library Documentation
optiga_symmetric_enc_dec_params Struct Reference

Specifies the data structure for symmetric encrypt and decrypt. More...

#include <optiga_lib_common.h>

Data Fields

uint16_t symmetric_key_oid
 Symmetric key OID. More...
 
const uint8_t * in_data
 Pointer to plain text. More...
 
uint32_t in_data_length
 Length of plain text. More...
 
const uint8_t * iv
 Pointer to initialization vector. More...
 
uint16_t iv_length
 Length of initialization vector. More...
 
const uint8_t * associated_data
 Pointer to associated data. More...
 
uint16_t associated_data_length
 Length of associated data. More...
 
uint8_t * out_data
 Pointer to output data. More...
 
uint32_t * out_data_length
 Length of output data. More...
 
const uint8_t * generated_hmac
 Pointer to generated hmac. More...
 
uint8_t original_sequence
 Requested sequence. More...
 
uint8_t current_sequence
 Variable to store current encrypt decrypt sequence. More...
 
uint32_t sent_data_length
 Length of sent data. More...
 
uint32_t received_data_length
 Length of received data. More...
 
uint16_t total_input_data_length
 Variable to indicate complete input data length required for CCM. More...
 
uint32_t generated_hmac_length
 Length of generated hmac. More...
 
uint8_t mode
 Encryption or hmac mode. More...
 
uint8_t operation_mode
 Symmetric mode of operation. More...
 

Detailed Description

Specifies the data structure for symmetric encrypt and decrypt.

Definition at line 583 of file optiga_lib_common.h.

Field Documentation

◆ associated_data

const uint8_t* optiga_symmetric_enc_dec_params::associated_data

Pointer to associated data.

Definition at line 596 of file optiga_lib_common.h.

◆ associated_data_length

uint16_t optiga_symmetric_enc_dec_params::associated_data_length

Length of associated data.

Definition at line 598 of file optiga_lib_common.h.

◆ current_sequence

uint8_t optiga_symmetric_enc_dec_params::current_sequence

Variable to store current encrypt decrypt sequence.

Definition at line 608 of file optiga_lib_common.h.

◆ generated_hmac

const uint8_t* optiga_symmetric_enc_dec_params::generated_hmac

Pointer to generated hmac.

Definition at line 604 of file optiga_lib_common.h.

◆ generated_hmac_length

uint32_t optiga_symmetric_enc_dec_params::generated_hmac_length

Length of generated hmac.

Definition at line 616 of file optiga_lib_common.h.

◆ in_data

const uint8_t* optiga_symmetric_enc_dec_params::in_data

Pointer to plain text.

Definition at line 588 of file optiga_lib_common.h.

◆ in_data_length

uint32_t optiga_symmetric_enc_dec_params::in_data_length

Length of plain text.

Definition at line 590 of file optiga_lib_common.h.

◆ iv

const uint8_t* optiga_symmetric_enc_dec_params::iv

Pointer to initialization vector.

Definition at line 592 of file optiga_lib_common.h.

◆ iv_length

uint16_t optiga_symmetric_enc_dec_params::iv_length

Length of initialization vector.

Definition at line 594 of file optiga_lib_common.h.

◆ mode

uint8_t optiga_symmetric_enc_dec_params::mode

Encryption or hmac mode.

Definition at line 618 of file optiga_lib_common.h.

◆ operation_mode

uint8_t optiga_symmetric_enc_dec_params::operation_mode

Symmetric mode of operation.

Definition at line 620 of file optiga_lib_common.h.

◆ original_sequence

uint8_t optiga_symmetric_enc_dec_params::original_sequence

Requested sequence.

Definition at line 606 of file optiga_lib_common.h.

◆ out_data

uint8_t* optiga_symmetric_enc_dec_params::out_data

Pointer to output data.

Definition at line 600 of file optiga_lib_common.h.

◆ out_data_length

uint32_t* optiga_symmetric_enc_dec_params::out_data_length

Length of output data.

Definition at line 602 of file optiga_lib_common.h.

◆ received_data_length

uint32_t optiga_symmetric_enc_dec_params::received_data_length

Length of received data.

Definition at line 612 of file optiga_lib_common.h.

◆ sent_data_length

uint32_t optiga_symmetric_enc_dec_params::sent_data_length

Length of sent data.

Definition at line 610 of file optiga_lib_common.h.

◆ symmetric_key_oid

uint16_t optiga_symmetric_enc_dec_params::symmetric_key_oid

Symmetric key OID.

Definition at line 586 of file optiga_lib_common.h.

◆ total_input_data_length

uint16_t optiga_symmetric_enc_dec_params::total_input_data_length

Variable to indicate complete input data length required for CCM.

Definition at line 614 of file optiga_lib_common.h.