DefaultSecContext_Private.h File Reference

Contains functions only used internally, however, test utilities can include this to unit test them. More...

#include <stdint.h>
#include <qcbor/qcbor_encode.h>
#include <BPSecLib_Private.h>
#include <BPSecLib_Public.h>
#include <CryptoInterface.h>
#include "rfc9173.h"

Include dependency graph for DefaultSecContext_Private.h:

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

Data Structures
struct	BSLX_BlockMetadata_t
struct	BSLX_Bytestr_t
struct	BSLX_BIB_t
struct	BSLX_BCB_t
	BCB encryption context with crypto primitives. More...
struct	BSLX_ScratchSpace_t
	Wrapper for large, variable-sized buffer holding all working data to compete a BCB operation. More...

Functions
size_t	BSLX_Bytestr_GetCapacity (void)
BSL_Data_t	BSLX_Bytestr_AsData (BSLX_Bytestr_t *self)
int	BSLX_BIB_InitFromSecOper (BSLX_BIB_t *self, const BSL_SecOper_t *sec_oper)
	Populate the BIB parameters convenience struct from the security operation struct.
int	BSLX_BIB_GenIPPT (BSLX_BIB_t *self, BSL_Data_t ippt_space)
	Computes the Integrity-Protected Plaintext (IPPT) for a canonical bundle block (non-primary)
int	BSLX_BIB_GenHMAC (BSLX_BIB_t *self, BSL_Data_t ippt_data)
	Performs the actual HMAC over the given IPPT, placing the result in hmac_result.
void *	BSLX_ScratchSpace_take (BSLX_ScratchSpace_t *scratch, size_t len)
	This means "give me len bytes from the scratch space and increment a counter." This is a convenience to assign space within the scratch space for certain structs.
int	BSLX_BCB_GetParams (const BSL_BundleRef_t *bundle, BSLX_BCB_t *bcb_context, const BSL_SecOper_t *sec_oper)
int	BSLX_BCB_Init (BSLX_BCB_t *bcb_context, const BSL_BundleRef_t *bundle, const BSL_SecOper_t *sec_oper)
int	BSLX_BCB_ComputeAAD (BSLX_BCB_t *bcb_context)
int	BSLX_BCB_Encrypt (BSLX_BCB_t *bcb_context)
void	BSLX_EncodeHeader (const BSL_CanonicalBlock_t *block, QCBOREncodeContext *encoder)

Detailed Description

Contains functions only used internally, however, test utilities can include this to unit test them.

Function Documentation

BSLX_BIB_GenHMAC()

int BSLX_BIB_GenHMAC	(	BSLX_BIB_t *	self,
		BSL_Data_t	ippt_data
	)

Performs the actual HMAC over the given IPPT, placing the result in hmac_result.

Returns the number of bytes written into hmac_result. Negative indicates error. NOTE: This does NOT resize the result, the caller must do so.

References BSL_AuthCtx_Deinit(), BSL_AuthCtx_DigestBuffer(), BSL_AuthCtx_Finalize(), BSL_AuthCtx_Init(), BSL_ERR_SECURITY_CONTEXT_AUTH_FAILED, BSL_LOG_ERR, BSLX_BIB_t::key_id, BSL_Data_t::len, and BSL_Data_t::ptr.

BSLX_BIB_InitFromSecOper()

int BSLX_BIB_InitFromSecOper	(	BSLX_BIB_t *	self,
		const BSL_SecOper_t *	sec_oper
	)

Populate the BIB parameters convenience struct from the security operation struct.

TODO: move to common function.

References BSL_ERR_PROPERTY_CHECK_FAILED, BSL_LOG_DEBUG, BSL_LOG_WARNING, BSL_SecOper_CountParams(), BSL_SecOper_GetParamAt(), BSL_SecParam_GetAsBytestr(), BSL_SecParam_GetAsUInt64(), BSL_SecParam_GetId(), BSL_SecParam_IsInt64(), BSL_SECPARAM_TYPE_INT_FIXED_KEY, BSL_SECPARAM_TYPE_KEY_ID, BSL_SUCCESS, BSLX_BIB_t::key_id, BSL_Data_t::len, map_rfc9173_sha_variant_to_crypto(), and BSL_Data_t::ptr.