DefaultScUtils.h File Reference

#include "TestUtils.h"
#include <bsl/crypto/CryptoInterface.h>
#include <bsl/dynamic/IdValPair.h>
#include <bsl/dynamic/PublicInterfaceImpl.h>
#include <bsl/dynamic/SecOperation.h>
#include <bsl/dynamic/SecurityActionSet.h>
#include <bsl/mock_bpa/ctr.h>
#include <m-string.h>

Include dependency graph for DefaultScUtils.h:

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

Data Structures
struct	BIBTestContext
struct	BCBTestContext
struct	RFC9173_TestVectors_AppendixA1
	Hard-coded single struct with fields populated from test vector in Appendix A1 for BIB. More...
struct	RFC9173_TestVectorsA2
struct	RFC9173_TestVectors_A4_Modified
struct	RFC9173_A1_Params
struct	RFC9173_AppendixA2_BCB

Macros
#define	RFC9173_EXAMPLE_A1_KEY   "9100"
	Key ID for the Appendix A1 key in OpenSSL.
#define	RFC9173_EXAMPLE_A2_KEY   "9102"
	Key ID for the Appendix A2 key in OpenSSL.
#define	RFC9173_EXAMPLE_A3_KEY   "9103"
	Key ID for the Appendix A3 key in OpenSSL.
#define	RFC9173_EXAMPLE_A4_BCB_KEY   "9104"
	Key ID for the Appendix A4 key in OpenSSL.
#define	BSL_SAMPLE_PP_ID   1
	Sample policy provider ID.
#define	BSL_SAMPLE_PP_ID_2   2

Functions
static int	BSL_Crypto_AddRegistryKeyName (const char *name, const uint8_t *ptr, size_t len)
	Test helper function.
static int	BSL_Crypto_GetRegistryKeyName (const char *name, BSL_Crypto_KeyHandle_t *handle)
	Test helper function.
static int	BSL_Crypto_RemoveRegistryKeyName (const char *name)
	Test helper function.
void	BIBTestContext_Init (BIBTestContext *obj)
void	BIBTestContext_Deinit (BIBTestContext *obj)
void	BSL_TestUtils_InitBIB_AppendixA1 (BIBTestContext *context, BSL_SecRole_e role, const char *key_id)
void	BCBTestContext_Init (BCBTestContext *obj)
void	BCBTestContext_Deinit (BCBTestContext *obj)
void	BSL_TestUtils_InitBCB_Appendix2 (BCBTestContext *context, BSL_SecRole_e role)
RFC9173_A1_Params	BSL_TestUtils_GetRFC9173_A1Params (const char *key_id)
RFC9173_A1_Params	BSL_TestUtils_GetRFC9173_A2Params (const char *key_id)
BSL_SecurityActionSet_t *	BSL_TestUtils_InitMallocBIBActionSet (BIBTestContext *bib_context)
void	BSL_TestUtils_SetupDefaultSecurityContext (BSL_LibCtx_t *bsl_lib)
int	rfc9173_byte_gen_fn_a1 (unsigned char *buf, int len)
int	rfc9173_byte_gen_fn_a2_kek (unsigned char *buf, int len)
int	rfc9173_byte_gen_fn_a2_cek (unsigned char *buf, int len)
int	rfc9173_byte_gen_fn_a4 (unsigned char *buf, int len)

Variables
const struct RFC9173_TestVectors_AppendixA1	RFC9173_TestVectors_AppendixA1
const struct RFC9173_TestVectorsA2	RFC9173_TestVectors_AppendixA2
const struct RFC9173_TestVectors_A4_Modified	RFC9173_TestVectors_AppendixA4

Macro Definition Documentation

BSL_SAMPLE_PP_ID

#define BSL_SAMPLE_PP_ID   1

Sample policy provider ID.

BSL_SAMPLE_PP_ID_2

#define BSL_SAMPLE_PP_ID_2   2

RFC9173_EXAMPLE_A1_KEY

#define RFC9173_EXAMPLE_A1_KEY   "9100"

Key ID for the Appendix A1 key in OpenSSL.

RFC9173_EXAMPLE_A2_KEY

#define RFC9173_EXAMPLE_A2_KEY   "9102"

Key ID for the Appendix A2 key in OpenSSL.

RFC9173_EXAMPLE_A3_KEY

#define RFC9173_EXAMPLE_A3_KEY   "9103"

Key ID for the Appendix A3 key in OpenSSL.

RFC9173_EXAMPLE_A4_BCB_KEY

#define RFC9173_EXAMPLE_A4_BCB_KEY   "9104"

Key ID for the Appendix A4 key in OpenSSL.

Function Documentation

BCBTestContext_Deinit()

void BCBTestContext_Deinit

(

BCBTestContext *

obj

)

References BSL_IdValPair_Deinit(), BSL_SecOper_Deinit(), BCBTestContext::opt_aes_variant, BCBTestContext::opt_scope_flags, BCBTestContext::opt_test_key_id, BCBTestContext::opt_use_key_wrap, and BCBTestContext::sec_oper.

Referenced by test_RFC9173_AppendixA_Example2_BCB_Acceptor(), test_RFC9173_AppendixA_Example2_BCB_Source(), test_RFC9173_AppendixA_Example3_Acceptor(), test_RFC9173_AppendixA_Example3_Source(), test_RFC9173_AppendixA_Example4_Acceptor(), test_RFC9173_AppendixA_Example4_Source(), test_sec_accept_keyunwrap(), and test_sec_source_keywrap().

BCBTestContext_Init()

void BCBTestContext_Init

(

BCBTestContext *

obj

)

References BSL_IdValPair_Init(), BSL_SecOper_Init(), BCBTestContext::opt_aes_variant, BCBTestContext::opt_scope_flags, BCBTestContext::opt_test_key_id, BCBTestContext::opt_use_key_wrap, and BCBTestContext::sec_oper.

Referenced by test_RFC9173_AppendixA_Example2_BCB_Acceptor(), test_RFC9173_AppendixA_Example2_BCB_Source(), test_RFC9173_AppendixA_Example3_Acceptor(), test_RFC9173_AppendixA_Example3_Source(), test_RFC9173_AppendixA_Example4_Acceptor(), test_RFC9173_AppendixA_Example4_Source(), test_sec_accept_keyunwrap(), and test_sec_source_keywrap().

BIBTestContext_Deinit()

void BIBTestContext_Deinit

(

BIBTestContext *

obj

)

References BSL_IdValPair_Deinit(), BSL_SecOper_Deinit(), BIBTestContext::opt_scope_flags, BIBTestContext::opt_sha_variant, BIBTestContext::opt_test_key, BIBTestContext::opt_use_key_wrap, and BIBTestContext::sec_oper.

Referenced by test_RFC9173_AppendixA_Example1_BIB_Source(), test_RFC9173_AppendixA_Example3_Acceptor(), test_RFC9173_AppendixA_Example3_Source(), test_RFC9173_AppendixA_Example4_Acceptor(), test_RFC9173_AppendixA_Example4_Source(), test_sec_accept_keyunwrap(), test_sec_source_keywrap(), test_SecurityContext_BIB_Acceptor(), test_SecurityContext_BIB_Source(), test_SecurityContext_BIB_Verifier(), and test_SecurityContext_BIB_Verifier_Failure().

BIBTestContext_Init()

void BIBTestContext_Init

(

BIBTestContext *

obj

)

References BSL_IdValPair_Init(), BSL_SecOper_Init(), BIBTestContext::opt_scope_flags, BIBTestContext::opt_sha_variant, BIBTestContext::opt_test_key, BIBTestContext::opt_use_key_wrap, and BIBTestContext::sec_oper.

Referenced by test_RFC9173_AppendixA_Example1_BIB_Source(), test_RFC9173_AppendixA_Example3_Acceptor(), test_RFC9173_AppendixA_Example3_Source(), test_RFC9173_AppendixA_Example4_Acceptor(), test_RFC9173_AppendixA_Example4_Source(), test_sec_accept_keyunwrap(), test_sec_source_keywrap(), test_SecurityContext_BIB_Acceptor(), test_SecurityContext_BIB_Source(), test_SecurityContext_BIB_Verifier(), and test_SecurityContext_BIB_Verifier_Failure().

BSL_Crypto_AddRegistryKeyName()

static int BSL_Crypto_AddRegistryKeyName ( const char *  name, const uint8_t *  ptr, size_t  len  )

inlinestatic

Test helper function.

References BSL_Crypto_AddRegistryKey(), BSL_Crypto_LoadKey(), BSL_Crypto_ReleaseKeyHandle(), BSL_DATA_INIT_VIEW_CSTR, and keyhandle.

Referenced by add_key_to_reg_fn(), BSL_TestUtils_SetupDefaultSecurityContext(), setUp(), TEST_CASE(), TEST_CASE(), test_get_key_concurrency(), test_sec_accept_keyunwrap(), and test_sec_source_keywrap().

BSL_Crypto_GetRegistryKeyName()

static int BSL_Crypto_GetRegistryKeyName ( const char *  name, BSL_Crypto_KeyHandle_t *  handle  )

inlinestatic

Test helper function.

References BSL_Crypto_GetRegistryKey(), and BSL_DATA_INIT_VIEW_CSTR.

Referenced by get_key_from_reg_fn(), test_add_key_concurrency(), TEST_CASE(), TEST_CASE(), test_decrypt(), and test_encrypt().

BSL_Crypto_RemoveRegistryKeyName()

static int BSL_Crypto_RemoveRegistryKeyName ( const char *  name )

inlinestatic

Test helper function.

References BSL_Crypto_RemoveRegistryKey(), and BSL_DATA_INIT_VIEW_CSTR.

Referenced by TEST_CASE().

BSL_TestUtils_GetRFC9173_A1Params()

RFC9173_A1_Params BSL_TestUtils_GetRFC9173_A1Params

(

const char *

key_id

)

References RFC9173_TestVectors_AppendixA1::bib_asb_scope_flags_key, RFC9173_TestVectors_AppendixA1::bib_asb_scope_flags_value, RFC9173_TestVectors_AppendixA1::bib_asb_sha_variant_key, RFC9173_TestVectors_AppendixA1::bib_asb_sha_variant_value, BSL_IdValPair_Init(), BSL_IdValPair_SetInt64(), BSL_IdValPair_SetTextstr(), BSLX_BIB_OPT_KEY_ID, BSLX_BIB_OPT_USE_KEY_WRAP, RFC9173_A1_Params::scope_flags, RFC9173_A1_Params::sha_variant, RFC9173_A1_Params::test_key_id, and RFC9173_A1_Params::use_key_wrap.

Referenced by test_MultiplePolicyProviders(), and test_PolicyProvider_Inspect_RFC9173_BIB().

BSL_TestUtils_GetRFC9173_A2Params()

RFC9173_A1_Params BSL_TestUtils_GetRFC9173_A2Params

(

const char *

key_id

)

BSL_TestUtils_InitBCB_Appendix2()

void BSL_TestUtils_InitBCB_Appendix2	(	BCBTestContext *	context,
		BSL_SecRole_e	role
	)

References BSL_IdValPair_SetInt64(), BSL_IdValPair_SetTextstr(), BSL_POLICYACTION_NOTHING, BSL_SECBLOCKTYPE_BCB, BSL_SecOper_AppendOption(), BSL_SecOper_Populate(), BSLX_BCB_OPT_AES_VARIANT, BSLX_BCB_OPT_KEY_ID, BSLX_BCB_OPT_SCOPE, BSLX_BCB_OPT_USE_KEY_WRAP, BCBTestContext::opt_aes_variant, BCBTestContext::opt_scope_flags, BCBTestContext::opt_test_key_id, BCBTestContext::opt_use_key_wrap, RFC9173_BCB_AES_VARIANT_A128GCM, RFC9173_CONTEXTID_BCB_AES_GCM, RFC9173_EXAMPLE_A2_KEY, and BCBTestContext::sec_oper.

Referenced by test_RFC9173_AppendixA_Example2_BCB_Acceptor(), and test_RFC9173_AppendixA_Example2_BCB_Source().

BSL_TestUtils_InitBIB_AppendixA1()

void BSL_TestUtils_InitBIB_AppendixA1	(	BIBTestContext *	context,
		BSL_SecRole_e	role,
		const char *	key_id
	)

References BSL_IdValPair_SetInt64(), BSL_IdValPair_SetTextstr(), BSL_POLICYACTION_DROP_BLOCK, BSL_SECBLOCKTYPE_BIB, BSL_SecOper_AppendOption(), BSL_SecOper_Populate(), BSLX_BIB_OPT_KEY_ID, BSLX_BIB_OPT_SCOPE, BSLX_BIB_OPT_SHA_VARIANT, BSLX_BIB_OPT_USE_KEY_WRAP, BIBTestContext::opt_scope_flags, BIBTestContext::opt_sha_variant, BIBTestContext::opt_test_key, BIBTestContext::opt_use_key_wrap, RFC9173_BIB_SHA_HMAC512, RFC9173_CONTEXTID_BIB_HMAC_SHA2, and BIBTestContext::sec_oper.

Referenced by test_RFC9173_AppendixA_Example1_BIB_Source(), test_SecurityContext_BIB_Acceptor(), test_SecurityContext_BIB_Source(), test_SecurityContext_BIB_Verifier(), and test_SecurityContext_BIB_Verifier_Failure().

BSL_TestUtils_InitMallocBIBActionSet()

BSL_SecurityActionSet_t * BSL_TestUtils_InitMallocBIBActionSet

(

BIBTestContext *

bib_context

)

References action_set, BSL_calloc(), BSL_free(), BSL_SecOper_Init(), BSL_SecurityAction_AppendSecOper(), BSL_SecurityAction_Deinit(), BSL_SecurityAction_Init(), BSL_SecurityActionSet_AppendAction(), BSL_SecurityActionSet_Init(), and BIBTestContext::sec_oper.

Referenced by test_SecurityContext_BIB_Acceptor(), test_SecurityContext_BIB_Source(), test_SecurityContext_BIB_Verifier(), and test_SecurityContext_BIB_Verifier_Failure().

BSL_TestUtils_SetupDefaultSecurityContext()

void BSL_TestUtils_SetupDefaultSecurityContext

(

BSL_LibCtx_t *

bsl_lib

)

References BSL_API_RegisterSecurityContext(), BSL_Crypto_AddRegistryKeyName(), BSLX_BCB_Execute(), BSLX_BCB_Validate(), BSLX_BIB_Execute(), BSLX_BIB_Validate(), RFC9173_CONTEXTID_BCB_AES_GCM, RFC9173_CONTEXTID_BIB_HMAC_SHA2, RFC9173_EXAMPLE_A1_KEY, RFC9173_EXAMPLE_A2_KEY, RFC9173_EXAMPLE_A3_KEY, and RFC9173_EXAMPLE_A4_BCB_KEY.

Referenced by _setUp(), and setUp().

rfc9173_byte_gen_fn_a1()

int rfc9173_byte_gen_fn_a1	(	unsigned char *	buf,
		int	len
	)

Referenced by test_RFC9173_AppendixA_Example1_BIB_Source().

rfc9173_byte_gen_fn_a2_cek()

int rfc9173_byte_gen_fn_a2_cek	(	unsigned char *	buf,
		int	len
	)

Referenced by test_RFC9173_AppendixA_Example2_BCB_Source().

rfc9173_byte_gen_fn_a2_kek()

int rfc9173_byte_gen_fn_a2_kek	(	unsigned char *	buf,
		int	len
	)

rfc9173_byte_gen_fn_a4()

int rfc9173_byte_gen_fn_a4	(	unsigned char *	buf,
		int	len
	)

Referenced by test_RFC9173_AppendixA_Example3_Acceptor(), test_RFC9173_AppendixA_Example4_Acceptor(), and test_RFC9173_AppendixA_Example4_Source().

Variable Documentation

RFC9173_TestVectors_AppendixA1

const struct RFC9173_TestVectors_AppendixA1 RFC9173_TestVectors_AppendixA1

RFC9173_TestVectors_AppendixA2

const struct RFC9173_TestVectorsA2 RFC9173_TestVectors_AppendixA2

RFC9173_TestVectors_AppendixA4

const struct RFC9173_TestVectors_A4_Modified RFC9173_TestVectors_AppendixA4