BSL v1.1.1 - 39.g9f43410
AMMOS Bundle Protocol Security Library (BSL)
Loading...
Searching...
No Matches
BSLX_CoseSc_t Struct Reference
+ Collaboration diagram for BSLX_CoseSc_t:

Data Fields

BSL_BundleRef_tbundle
 Bundle context associated with this operation.
 
BSL_SecOper_t * sec_oper
 Operation source and output.
 
bool is_bib
 True if this operation is integrity, false for confidentiality.
 
bool is_source
 True if this operation is the source role.
 
int status
 Rolling return value for procedure interruption.
 
bool opt_kid
 True if kid came from an option.
 
BSL_Data_t kid
 Required option for KID.
 
BSL_Data_t addl_phdr_bstr
 Optional additional header parameter bytes.
 
BSLX_CoseMsg_HdrMapTree_t addl_phdr
 Optional additional header map, represented by addl_phdr_bstr.
 
BSLX_CoseMsg_HdrMapTree_t addl_uhdr
 Optional additional header map.
 
bool opt_aad_scope
 True if aad_scope came from an option.
 
BSLX_CoseSc_AadScope_t aad_scope
 Required AAD scope, naturally sorted.
 
bool opt_key_alg
 True if key_alg came from an option.
 
bool hdr_key_alg
 True if key_alg came from a header.
 
int64_t key_alg
 Optional key use algorithm from BSLX_CoseMsg_Alg_e.
 
bool opt_tgt_alg
 True if tgt_alg came from an option.
 
bool hdr_tgt_alg
 True if tgt_alg came from a header.
 
int64_t tgt_alg
 Required content layer algorithm from BSLX_CoseMsg_Alg_e.
 
size_t tgt_keylen
 Key length for tgt_alg.
 
bool opt_salt_length
 True if salt_length came from an option.
 
int64_t salt_length
 Optional offset to use when generating IV or Partial IV bytes.
 
bool opt_salt_base
 True if salt_base came from an option.
 
BSL_Data_t salt_base
 Optional base bytes for generating salt bytes.
 
bool opt_salt_offset
 True if salt_offset came from an option.
 
int64_t salt_offset
 Optional offset to use when generating salt bytes.
 
bool opt_iv_base
 True if iv_base came from an option.
 
BSL_Data_t iv_base
 Optional base bytes for generating IV bytes, falling-back to key parameter.
 
bool opt_iv_offset
 True if iv_offset came from an option.
 
int64_t iv_offset
 Optional offset to use when generating IV or Partial IV bytes.
 
BSL_Data_t full_iv
 Direct or derived full IV.
 
BSL_Data_t partial_iv
 Optional partial IV when key supports it.
 
BSL_PrimaryBlock_t primary_block
 Metadata for primary block.
 
uint64_t sec_blk_num
 Parent security block number.
 
BSL_CanonicalBlock_t target_block
 Metadata for target block.
 
bool overwrite_btsd
 True if this is a source or acceptor role and target BTSD is replaced for encryption.
 
BSL_Crypto_KeyHandle_t keyhandle
 Top-layer key to use.
 
BSL_Crypto_KeyHandle_t cekhandle
 Optional content key.
 
BSL_Data_t wrapped_cek
 Optional wrapped content key.
 
BSL_AuthCtx_tmac_ctx
 MAC processing state, may be NULL.
 
BSL_Cipher_tenc_ctx
 Encrypt processing state, may be NULL.
 

Field Documentation

◆ aad_scope

BSLX_CoseSc_AadScope_t BSLX_CoseSc_t::aad_scope

◆ addl_phdr

BSLX_CoseMsg_HdrMapTree_t BSLX_CoseSc_t::addl_phdr

Optional additional header map, represented by addl_phdr_bstr.

Referenced by BSLX_CoseSc_Deinit(), BSLX_CoseSc_GetAndValidateAddlHeaders(), and BSLX_CoseSc_Init().

◆ addl_phdr_bstr

BSL_Data_t BSLX_CoseSc_t::addl_phdr_bstr

Optional additional header parameter bytes.

Referenced by BSLX_CoseSc_Deinit(), BSLX_CoseSc_GetAndValidateAddlHeaders(), and BSLX_CoseSc_Init().

◆ addl_uhdr

BSLX_CoseMsg_HdrMapTree_t BSLX_CoseSc_t::addl_uhdr

Optional additional header map.

Referenced by BSLX_CoseSc_Deinit(), BSLX_CoseSc_GetAndValidateAddlHeaders(), and BSLX_CoseSc_Init().

◆ bundle

BSL_BundleRef_t* BSLX_CoseSc_t::bundle

Bundle context associated with this operation.

Referenced by BSLX_CoseSc_Prepare().

◆ cekhandle

BSL_Crypto_KeyHandle_t BSLX_CoseSc_t::cekhandle

Optional content key.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_Init().

◆ enc_ctx

BSL_Cipher_t* BSLX_CoseSc_t::enc_ctx

Encrypt processing state, may be NULL.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_Init().

◆ full_iv

BSL_Data_t BSLX_CoseSc_t::full_iv

Direct or derived full IV.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_Init().

◆ hdr_key_alg

bool BSLX_CoseSc_t::hdr_key_alg

True if key_alg came from a header.

Referenced by BSLX_CoseSc_GetAndValidateKey().

◆ hdr_tgt_alg

bool BSLX_CoseSc_t::hdr_tgt_alg

True if tgt_alg came from a header.

Referenced by BSLX_CoseSc_GetAndValidateTarget().

◆ is_bib

bool BSLX_CoseSc_t::is_bib

True if this operation is integrity, false for confidentiality.

Referenced by BSLX_CoseSc_GetOptions(), and BSLX_CoseSc_Prepare().

◆ is_source

bool BSLX_CoseSc_t::is_source

True if this operation is the source role.

Referenced by BSLX_CoseSc_GetOptions(), and BSLX_CoseSc_Prepare().

◆ iv_base

BSL_Data_t BSLX_CoseSc_t::iv_base

Optional base bytes for generating IV bytes, falling-back to key parameter.

Referenced by BSLX_CoseSc_Deinit(), BSLX_CoseSc_GetOptions(), and BSLX_CoseSc_Init().

◆ iv_offset

int64_t BSLX_CoseSc_t::iv_offset

Optional offset to use when generating IV or Partial IV bytes.

Referenced by BSLX_CoseSc_GetOptions().

◆ key_alg

int64_t BSLX_CoseSc_t::key_alg

Optional key use algorithm from BSLX_CoseMsg_Alg_e.

Referenced by BSLX_CoseSc_GetAndValidateKey(), and BSLX_CoseSc_GetOptions().

◆ keyhandle

BSL_Crypto_KeyHandle_t BSLX_CoseSc_t::keyhandle

Top-layer key to use.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_GetAndValidateKey().

◆ kid

BSL_Data_t BSLX_CoseSc_t::kid

◆ mac_ctx

BSL_AuthCtx_t* BSLX_CoseSc_t::mac_ctx

MAC processing state, may be NULL.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_Init().

◆ opt_aad_scope

bool BSLX_CoseSc_t::opt_aad_scope

True if aad_scope came from an option.

Referenced by BSLX_CoseSc_GetAndValidateAadScope(), and BSLX_CoseSc_GetOptions().

◆ opt_iv_base

bool BSLX_CoseSc_t::opt_iv_base

True if iv_base came from an option.

Referenced by BSLX_CoseSc_GetOptions().

◆ opt_iv_offset

bool BSLX_CoseSc_t::opt_iv_offset

True if iv_offset came from an option.

Referenced by BSLX_CoseSc_GetOptions().

◆ opt_key_alg

bool BSLX_CoseSc_t::opt_key_alg

True if key_alg came from an option.

Referenced by BSLX_CoseSc_GetAndValidateKey(), and BSLX_CoseSc_GetOptions().

◆ opt_kid

bool BSLX_CoseSc_t::opt_kid

True if kid came from an option.

Referenced by BSLX_CoseSc_GetAndValidateKey(), and BSLX_CoseSc_GetOptions().

◆ opt_salt_base

bool BSLX_CoseSc_t::opt_salt_base

True if salt_base came from an option.

Referenced by BSLX_CoseSc_GetOptions().

◆ opt_salt_length

bool BSLX_CoseSc_t::opt_salt_length

True if salt_length came from an option.

Referenced by BSLX_CoseSc_GetOptions().

◆ opt_salt_offset

bool BSLX_CoseSc_t::opt_salt_offset

True if salt_offset came from an option.

Referenced by BSLX_CoseSc_GetOptions().

◆ opt_tgt_alg

bool BSLX_CoseSc_t::opt_tgt_alg

True if tgt_alg came from an option.

Referenced by BSLX_CoseSc_GetAndValidateTarget(), and BSLX_CoseSc_GetOptions().

◆ overwrite_btsd

bool BSLX_CoseSc_t::overwrite_btsd

True if this is a source or acceptor role and target BTSD is replaced for encryption.

Referenced by BSLX_CoseSc_Prepare().

◆ partial_iv

BSL_Data_t BSLX_CoseSc_t::partial_iv

Optional partial IV when key supports it.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_Init().

◆ primary_block

BSL_PrimaryBlock_t BSLX_CoseSc_t::primary_block

Metadata for primary block.

Referenced by BSLX_CoseSc_Deinit(), BSLX_CoseSc_Init(), and BSLX_CoseSc_Prepare().

◆ salt_base

BSL_Data_t BSLX_CoseSc_t::salt_base

Optional base bytes for generating salt bytes.

Referenced by BSLX_CoseSc_Deinit(), BSLX_CoseSc_GetOptions(), and BSLX_CoseSc_Init().

◆ salt_length

int64_t BSLX_CoseSc_t::salt_length

Optional offset to use when generating IV or Partial IV bytes.

Referenced by BSLX_CoseSc_GetOptions().

◆ salt_offset

int64_t BSLX_CoseSc_t::salt_offset

Optional offset to use when generating salt bytes.

Referenced by BSLX_CoseSc_GetOptions().

◆ sec_blk_num

uint64_t BSLX_CoseSc_t::sec_blk_num

Parent security block number.

Referenced by BSLX_CoseSc_Prepare().

◆ sec_oper

BSL_SecOper_t* BSLX_CoseSc_t::sec_oper

◆ status

◆ target_block

BSL_CanonicalBlock_t BSLX_CoseSc_t::target_block

Metadata for target block.

Referenced by BSLX_CoseSc_Prepare().

◆ tgt_alg

int64_t BSLX_CoseSc_t::tgt_alg

Required content layer algorithm from BSLX_CoseMsg_Alg_e.

Referenced by BSLX_CoseSc_GetAndValidateTarget(), and BSLX_CoseSc_GetOptions().

◆ tgt_keylen

size_t BSLX_CoseSc_t::tgt_keylen

Key length for tgt_alg.

Referenced by BSLX_CoseSc_GetAndValidateTarget().

◆ wrapped_cek

BSL_Data_t BSLX_CoseSc_t::wrapped_cek

Optional wrapped content key.

Referenced by BSLX_CoseSc_Deinit(), and BSLX_CoseSc_Init().


The documentation for this struct was generated from the following file: