DefaultSecContext.h File Reference

Header for the implementation of an example default security context (RFC 9173). More...

#include <BPSecLib_Private.h>
#include <BPSecLib_Public.h>
#include <default_sc/rfc9173.h>

Include dependency graph for DefaultSecContext.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	BSLX_BIB_Options_e {   BSLX_BIB_OPT_KEY_ID = 1000 , BSLX_BIB_OPT_USE_KEY_WRAP , BSLX_BIB_OPT_WRAPPED_KEY , BSLX_BIB_OPT_SHA_VARIANT ,   BSLX_BIB_OPT_SCOPE }
	Internal BIB option enumerations. More...
enum	BSLX_BCB_Options_e {   BSLX_BCB_OPT_KEY_ID = 2000 , BSLX_BCB_OPT_USE_KEY_WRAP , BSLX_BCB_OPT_WRAPPED_KEY , BSLX_BCB_OPT_IV ,   BSLX_BCB_OPT_AES_VARIANT , BSLX_BCB_OPT_SCOPE }
	Internal BCB option enumerations. More...

Functions
int	BSLX_BIB_Execute (BSL_LibCtx_t *lib, BSL_BundleRef_t *bundle, const BSL_SecOper_t *sec_oper, BSL_SecOutcome_t *sec_outcome)
	Match signature BSL_SecCtx_Execute_f.
bool	BSLX_BIB_Validate (BSL_LibCtx_t *lib, const BSL_BundleRef_t *bundle, const BSL_SecOper_t *sec_oper)
	Match signature BSL_SecCtx_Validate_f.
int	BSLX_BCB_Execute (BSL_LibCtx_t *lib, BSL_BundleRef_t *bundle, const BSL_SecOper_t *sec_oper, BSL_SecOutcome_t *sec_outcome)
	Match signature BSL_SecCtx_Execute_f.
bool	BSLX_BCB_Validate (BSL_LibCtx_t *lib, const BSL_BundleRef_t *bundle, const BSL_SecOper_t *sec_oper)
	Match signature BSL_SecCtx_Validate_f.

Detailed Description

Header for the implementation of an example default security context (RFC 9173).

Enumeration Type Documentation

BSLX_BCB_Options_e

enum BSLX_BCB_Options_e

Internal BCB option enumerations.

Enumerator
BSLX_BCB_OPT_KEY_ID	Used to pass in a key id found in the key registry.
BSLX_BCB_OPT_USE_KEY_WRAP	A uint value 0 to skip key wrap, else use key wrap.
BSLX_BCB_OPT_WRAPPED_KEY	Manually control the wrapped key. Warning This should only be used for testing.
BSLX_BCB_OPT_IV	Manually control the IV. Warning This should only be used for testing.
BSLX_BCB_OPT_AES_VARIANT	A uint value from the choices rfc9173_bcb_aes_variant_e.
BSLX_BCB_OPT_SCOPE	A uint value from the choices rfc9173_bcb_aad_scope_flag_ids_e.

BSLX_BIB_Options_e

enum BSLX_BIB_Options_e

Internal BIB option enumerations.

Enumerator
BSLX_BIB_OPT_KEY_ID	Used to pass in a key id found in the key registry.
BSLX_BIB_OPT_USE_KEY_WRAP	A uint value 0 to skip key wrap, else use key wrap.
BSLX_BIB_OPT_WRAPPED_KEY	Manually control the wrapped key. Warning This should only be used for testing.
BSLX_BIB_OPT_SHA_VARIANT	A uint value from the choices rfc9173_bib_sha_variantid_e.
BSLX_BIB_OPT_SCOPE	A uint value from the choices rfc9173_bib_integ_scope_flag_ids_e.

Function Documentation

BSLX_BCB_Execute()

int BSLX_BCB_Execute	(	BSL_LibCtx_t *	lib,
		BSL_BundleRef_t *	bundle,
		const BSL_SecOper_t *	sec_oper,
		BSL_SecOutcome_t *	sec_outcome
	)

Match signature BSL_SecCtx_Execute_f.

References BSLX_BCB_t::aad_scope, BSLX_BCB_t::aes_variant, BSLX_BCB_t::authtag, BSL_BundleCtx_GetBlockMetadata(), BSL_Data_InitView(), BSL_ERR_HOST_CALLBACK_FAILED, BSL_ERR_SECURITY_CONTEXT_FAILED, BSL_IdValPair_GetAsBytestr(), BSL_IdValPair_GetAsInt64(), BSL_IdValPair_SetBytestr(), BSL_IdValPair_SetInt64(), BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_INFO, BSL_LOG_WARNING, BSL_SecOper_FindParam(), BSL_SecOper_FindResult(), BSL_SecOper_GetSecurityBlockNum(), BSL_SecOper_GetTargetBlockNum(), BSL_SecOper_IsRoleAcceptor(), BSL_SecOutcome_AppendParam(), BSL_SecOutcome_AppendResult(), BSL_SUCCESS, BSLX_BCB_ComputeAAD(), BSLX_BCB_Decrypt(), BSLX_BCB_Deinit(), BSLX_BCB_Encrypt(), BSLX_BCB_GetOptions(), BSLX_BCB_Init(), CHK_ARG_NONNULL, CHK_PRECONDITION, BSLX_BCB_t::err_count, BSLX_BCB_t::is_source, BSLX_BCB_t::iv, BSL_Data_t::len, BSLX_BCB_t::opt_aad_scope, BSLX_BCB_t::overwrite_btsd, BSL_Data_t::ptr, RFC9173_BCB_AADSCOPEFLAGID_INC_SECURITY_HEADER, RFC9173_BCB_RESULTID_AUTHTAG, RFC9173_BCB_SECPARAM_AADSCOPE, RFC9173_BCB_SECPARAM_AESVARIANT, RFC9173_BCB_SECPARAM_IV, RFC9173_BCB_SECPARAM_WRAPPEDKEY, BSLX_BCB_t::sec_block, and BSLX_BCB_t::wrapped_key.

Referenced by BSL_TestUtils_SetupDefaultSecurityContext(), MockBPA_Agent_Init(), test_RFC9173_AppendixA_Example2_BCB_Acceptor(), test_RFC9173_AppendixA_Example2_BCB_Source(), test_sec_accept_keyunwrap(), and test_sec_source_keywrap().

BSLX_BCB_Validate()

bool BSLX_BCB_Validate	(	BSL_LibCtx_t *	lib,
		const BSL_BundleRef_t *	bundle,
		const BSL_SecOper_t *	sec_oper
	)

Match signature BSL_SecCtx_Validate_f.

Referenced by BSL_TestUtils_SetupDefaultSecurityContext(), and MockBPA_Agent_Init().

BSLX_BIB_Execute()

int BSLX_BIB_Execute	(	BSL_LibCtx_t *	lib,
		BSL_BundleRef_t *	bundle,
		const BSL_SecOper_t *	sec_oper,
		BSL_SecOutcome_t *	sec_outcome
	)

Match signature BSL_SecCtx_Execute_f.

References BSL_BundleCtx_GetBlockMetadata(), BSL_BundleCtx_GetBundleMetadata(), BSL_Crypto_Compare(), BSL_Data_Deinit(), BSL_DATA_INIT_NULL, BSL_Data_InitBuffer(), BSL_ERR_SECURITY_CONTEXT_FAILED, BSL_IdValPair_GetAsBytestr(), BSL_IdValPair_GetAsInt64(), BSL_IdValPair_IsBytestr(), BSL_IdValPair_SetBytestr(), BSL_IdValPair_SetInt64(), BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_WARNING, BSL_SecOper_FindParam(), BSL_SecOper_FindResult(), BSL_SecOper_GetSecurityBlockNum(), BSL_SecOper_GetTargetBlockNum(), BSL_SecOper_IsConsistent(), BSL_SecOutcome_AppendParam(), BSL_SecOutcome_AppendResult(), BSL_SUCCESS, BSLX_BIB_Deinit(), BSLX_BIB_GenHMAC(), BSLX_BIB_GenIPPT(), BSLX_BIB_InitFromSecOper(), CHK_ARG_NONNULL, CHK_PRECONDITION, BSLX_BIB_t::err_count, BSLX_BIB_t::hmac_result_val, BSLX_BIB_t::ippt_scope, BSLX_BIB_t::is_source, BSL_Data_t::len, BSLX_BIB_t::opt_ippt_scope, BSLX_BIB_t::opt_sha_variant, BSLX_BIB_t::primary_block, BSL_Data_t::ptr, RFC9173_BIB_PARAMID_INTEG_SCOPE_FLAG, RFC9173_BIB_PARAMID_SHA_VARIANT, RFC9173_BIB_PARAMID_WRAPPED_KEY, RFC9173_BIB_RESULTID_HMAC, BSLX_BIB_t::sec_block, BSLX_BIB_t::sha_variant, BSLX_BIB_t::target_block, and BSLX_BIB_t::wrapped_key.

Referenced by BSL_TestUtils_SetupDefaultSecurityContext(), MockBPA_Agent_Init(), test_RFC9173_AppendixA_Example1_BIB_Source(), test_sec_accept_keyunwrap(), and test_sec_source_keywrap().

BSLX_BIB_Validate()

bool BSLX_BIB_Validate	(	BSL_LibCtx_t *	lib,
		const BSL_BundleRef_t *	bundle,
		const BSL_SecOper_t *	sec_oper
	)

Match signature BSL_SecCtx_Validate_f.

Referenced by BSL_TestUtils_SetupDefaultSecurityContext(), and MockBPA_Agent_Init().