BCB_AES_GCM.c File Reference

Contains functionality and data structures to implement BCB using security context in RFC9173. More...

#include <stdlib.h>
#include <qcbor/qcbor_encode.h>
#include <qcbor/qcbor_spiffy_decode.h>
#include <BPSecLib_Private.h>
#include <CryptoInterface.h>
#include "DefaultSecContext.h"
#include "DefaultSecContext_Private.h"
#include "rfc9173.h"

Include dependency graph for BCB_AES_GCM.c:

Functions
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.
int	BSLX_BCB_ComputeAAD (BSLX_BCB_t *bcb_context)
static int	BSLX_BCB_Decrypt (BSLX_BCB_t *bcb_context)
int	BSLX_BCB_Encrypt (BSLX_BCB_t *bcb_context)
int	BSLX_BCB_GetOptions (const BSL_BundleRef_t *bundle, BSLX_BCB_t *bcb_context, const BSL_SecOper_t *sec_oper)
	Populate the BCB context with options from the operation.
int	BSLX_BCB_Init (BSLX_BCB_t *bcb_context, BSL_BundleRef_t *bundle, const BSL_SecOper_t *sec_oper)
void	BSLX_BCB_Deinit (BSLX_BCB_t *bcb_context)
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.

Detailed Description

Contains functionality and data structures to implement BCB using security context in RFC9173.

Function Documentation

BSLX_BCB_ComputeAAD()

int BSLX_BCB_ComputeAAD

(

BSLX_BCB_t *

bcb_context

)

References BSLX_BCB_t::aad, BSLX_BCB_t::aad_scope, BSL_Data_Deinit(), BSL_Data_Resize(), BSL_ERR_ENCODING, BSL_ERR_INSUFFICIENT_SPACE, BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_SUCCESS, BSLX_EncodeHeader(), CHK_ARG_NONNULL, CHK_PRECONDITION, BSL_PrimaryBlock_t::encoded, BSL_Data_t::len, BSLX_BCB_t::primary_block, BSL_Data_t::ptr, RFC9173_BCB_AADSCOPEFLAGID_INC_PRIM_BLOCK, RFC9173_BCB_AADSCOPEFLAGID_INC_SECURITY_HEADER, RFC9173_BCB_AADSCOPEFLAGID_INC_TARGET_HEADER, BSLX_BCB_t::sec_block, and BSLX_BCB_t::target_block.

Referenced by BSLX_BCB_Execute().

BSLX_BCB_Decrypt()

static int BSLX_BCB_Decrypt ( BSLX_BCB_t *  bcb_context )

static

References BSLX_BCB_t::aad, BSLX_BCB_t::aes_variant, ASSERT_POSTCONDITION, BSLX_BCB_t::authtag, BSL_CanonicalBlock_t::block_num, BSL_BundleCtx_ReadBTSD(), BSL_BundleCtx_WriteBTSD(), BSL_Cipher_AddAAD(), BSL_Cipher_AddSeq(), BSL_Cipher_Deinit(), BSL_Cipher_FinalizeSeq(), BSL_Cipher_Init(), BSL_Cipher_SetTag(), BSL_CRYPTO_AES_128, BSL_CRYPTO_AES_256, BSL_Crypto_ClearGeneratedKeyHandle(), BSL_CRYPTO_DECRYPT, BSL_Crypto_GetRegistryKey(), BSL_Crypto_UnwrapKey(), BSL_Data_Deinit(), BSL_ERR_HOST_CALLBACK_FAILED, BSL_ERR_SECURITY_CONTEXT_CRYPTO_FAILED, BSL_ERR_SECURITY_CONTEXT_FAILED, BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_INFO, BSL_LOG_WARNING, BSL_SeqReader_Destroy(), BSL_SeqWriter_Destroy(), BSL_SUCCESS, BSL_CanonicalBlock_t::btsd_len, BSLX_BCB_t::bundle, CHK_ARG_NONNULL, CHK_PRECONDITION, BSLX_BCB_t::iv, BSLX_BCB_t::key_id, BSLX_BCB_t::keywrap, BSL_Data_t::len, BSLX_BCB_t::overwrite_btsd, BSL_Data_t::ptr, RFC9173_BCB_AES_VARIANT_A128GCM, BSLX_BCB_t::target_block, and BSLX_BCB_t::wrapped_key.

Referenced by BSLX_BCB_Execute().

BSLX_BCB_Deinit()

void BSLX_BCB_Deinit

(

BSLX_BCB_t *

bcb_context

)

References BSLX_BCB_t::aad, ASSERT_ARG_NONNULL, BSLX_BCB_t::authtag, BSL_Data_Deinit(), BSL_PrimaryBlock_deinit(), BSLX_BCB_t::debugstr, BSLX_BCB_t::iv, BSLX_BCB_t::primary_block, and BSLX_BCB_t::wrapped_key.

Referenced by BSLX_BCB_Execute().

BSLX_BCB_Encrypt()

int BSLX_BCB_Encrypt

(

BSLX_BCB_t *

bcb_context

)

wrapped key always 8 bytes greater than CEK [7] (2.2.1)

References BSLX_BCB_t::aad, BSLX_BCB_t::aes_variant, BSLX_BCB_t::authtag, BSL_CanonicalBlock_t::block_num, BSL_BundleCtx_ReadBTSD(), BSL_BundleCtx_WriteBTSD(), BSL_Cipher_AddAAD(), BSL_Cipher_AddSeq(), BSL_Cipher_Deinit(), BSL_Cipher_FinalizeSeq(), BSL_Cipher_GetTag(), BSL_Cipher_Init(), BSL_CRYPTO_AES_128, BSL_CRYPTO_AES_256, BSL_CRYPTO_AESGCM_AUTH_TAG_LEN, BSL_Crypto_ClearGeneratedKeyHandle(), BSL_CRYPTO_ENCRYPT, BSL_Crypto_GenIV(), BSL_Crypto_GenKey(), BSL_Crypto_GetRegistryKey(), BSL_Crypto_WrapKey(), BSL_Data_InitBuffer(), BSL_Data_Resize(), BSL_ERR_HOST_CALLBACK_FAILED, BSL_ERR_SECURITY_CONTEXT_CRYPTO_FAILED, BSL_ERR_SECURITY_CONTEXT_FAILED, BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_WARNING, BSL_SeqReader_Destroy(), BSL_SeqWriter_Destroy(), BSL_SUCCESS, BSL_CanonicalBlock_t::btsd_len, BSLX_BCB_t::bundle, CHK_ARG_NONNULL, CHK_PRECONDITION, BSLX_BCB_t::iv, BSLX_BCB_t::key_id, BSLX_BCB_t::keywrap, BSL_Data_t::len, BSL_Data_t::ptr, RFC9173_BCB_AES_VARIANT_A128GCM, RFC9173_BCB_DEFAULT_IV_LEN, BSLX_BCB_t::target_block, and BSLX_BCB_t::wrapped_key.

Referenced by BSLX_BCB_Execute().

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_GetOptions()

int BSLX_BCB_GetOptions	(	const BSL_BundleRef_t *	bundle,
		BSLX_BCB_t *	bcb_context,
		const BSL_SecOper_t *	sec_oper
	)

Populate the BCB context with options from the operation.

References BSLX_BCB_t::aad_scope, BSLX_BCB_t::aes_variant, BSL_CanonicalBlock_t::block_num, BSL_Data_InitView(), BSL_ERR_PROPERTY_CHECK_FAILED, BSL_IdValPair_GetAsBytestr(), BSL_IdValPair_GetAsInt64(), BSL_IdValPair_GetAsTextstr(), BSL_IdValPair_GetId(), BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_WARNING, BSL_SecOper_FindOption(), BSL_SUCCESS, BSLX_BCB_OPT_AES_VARIANT, BSLX_BCB_OPT_KEY_ID, BSLX_BCB_OPT_SCOPE, BSLX_BCB_OPT_USE_KEY_WRAP, BSLX_BCB_OPT_WRAPPED_KEY, BSL_CanonicalBlock_t::btsd_len, CHK_ARG_NONNULL, CHK_PRECONDITION, BSLX_BCB_t::err_count, BSLX_BCB_t::key_id, BSLX_BCB_t::keywrap, BSL_Data_t::len, BSLX_BCB_t::opt_aad_scope, BSL_Data_t::ptr, RFC9173_BCB_AES_VARIANT_A128GCM, RFC9173_BCB_AES_VARIANT_A256GCM, BSLX_BCB_t::target_block, and BSLX_BCB_t::wrapped_key.

Referenced by BSLX_BCB_Execute().

BSLX_BCB_Init()

int BSLX_BCB_Init	(	BSLX_BCB_t *	bcb_context,
		BSL_BundleRef_t *	bundle,
		const BSL_SecOper_t *	sec_oper
	)

References BSL_PrimaryBlock_t::block_count, BSL_CanonicalBlock_t::block_num, BSL_BundleCtx_GetBlockMetadata(), BSL_BundleCtx_GetBundleMetadata(), BSL_CRYPTO_DECRYPT, BSL_CRYPTO_ENCRYPT, BSL_Data_Resize(), BSL_ERR_HOST_CALLBACK_FAILED, BSL_ERR_INSUFFICIENT_SPACE, BSL_LOG_ERR, BSL_SecOper_GetTargetBlockNum(), BSL_SecOper_IsRoleSource(), BSL_SUCCESS, BSL_CanonicalBlock_t::btsd_len, BSLX_BCB_t::bundle, CHK_ARG_NONNULL, CHK_POSTCONDITION, CHK_PROPERTY, BSLX_BCB_t::crypto_mode, BSLX_BCB_t::debugstr, BSLX_BCB_t::is_source, BSLX_BCB_t::primary_block, and BSLX_BCB_t::target_block.

Referenced by BSLX_BCB_Execute().

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().