CBOR.c File Reference

Definition of CBOR CODEC wrapper functions. More...

#include "CBOR.h"
#include "bsl/BPSecLib_Private.h"
#include "bsl/front/TextUtil.h"
#include <m-core.h>

Include dependency graph for CBOR.c:

Functions
int	BSL_CBOR_Encode_GetSize (size_t *needlen, BSL_CBOR_Encode_f func, const void *obj)
	Perform one-pass encoded size inspection.
int	BSL_CBOR_Encode_Twopass (BSL_Data_t *buf, BSL_CBOR_Encode_f func, const void *obj)
	Perform two-pass size-fitted encoding.
int	BSL_CBOR_Decode (const BSL_Data_t *buf, BSL_CBOR_Decode_f func, const void *obj)
	Perform size- and error-checked encoding.
int	BSL_CBOR_Compare_Int64 (const int64_t *ltv, const int64_t *rtv)
	Sort integer values in CBOR canonical order per Section 4.2.1 of RFC 8949 [3].
int	BSL_CBOR_EncodeEID (QCBOREncodeContext *enc, const BSL_HostEID_t *eid)
	Helper to encode EID values in a way that is optimized for two-pass encoder.

Detailed Description

Definition of CBOR CODEC wrapper functions.

Function Documentation

BSL_CBOR_Compare_Int64()

int BSL_CBOR_Compare_Int64	(	const int64_t *	ltv,
		const int64_t *	rtv
	)

Sort integer values in CBOR canonical order per Section 4.2.1 of RFC 8949 [3].

Matches the libc sort and M*LIB CMP signature.

References ASSERT_ARG_NONNULL.

BSL_CBOR_Decode()

int BSL_CBOR_Decode	(	const BSL_Data_t *	buf,
		BSL_CBOR_Decode_f	func,
		const void *	obj
	)

Perform size- and error-checked encoding.

Parameters

[in]	buf	The populated buffer to read from.
	func	The decoding function which takes the user data.
	obj	Pointer to the user data to encode.

Returns

BSL_SUCCESS if successful

References ASSERT_ARG_NONNULL, BSL_ERR_DECODING, BSL_LOG_ERR, BSL_LOG_PLAINTEXT_PTR, BSL_SUCCESS, BSL_Data_t::len, BSL_Data_t::ptr, and UsefulBufC_FROM_BSL_Data.

Referenced by BSL_API_QuerySecurity(), BSL_ExecAnyVerifierAcceptor_Pre(), BSLX_CoseMsg_Headers_CheckCrit(), BSLX_CoseSc_Encrypt0_VerifyAccept(), BSLX_CoseSc_Encrypt_VerifyAccept(), BSLX_CoseSc_GetAndValidateAadScope(), BSLX_CoseSc_GetAndValidateAddlHeaders(), BSLX_CoseSc_GetOptions(), BSLX_CoseSc_Mac0_VerifyAccept(), BSLX_CoseSc_Mac_VerifyAccept(), LLVMFuzzerTestOneInput(), mock_bpa_ctr_decode(), mock_bpa_key_registry_init_cosekey(), test_AppendixA_Example1_BIB_Source(), test_AppendixA_Example4_BCB_Source(), test_AppendixA_Example5_BCB_Source(), test_AppendixA_Example6_BCB_Source(), TEST_CASE(), test_CCSDS_Example_Mac_Source(), and TestASBDecodeEncodeClosure().

BSL_CBOR_Encode_GetSize()

int BSL_CBOR_Encode_GetSize	(	size_t *	needlen,
		BSL_CBOR_Encode_f	func,
		const void *	obj
	)

Perform one-pass encoded size inspection.

Parameters

[out]	needlen	Pointer to the size output.
	func	The encoding function which takes the user data.
	obj	Pointer to the user data to encode.

Returns

BSL_SUCCESS if successful.

References ASSERT_ARG_NONNULL, BSL_ERR_ENCODING, BSL_LOG_DEBUG, BSL_LOG_ERR, and BSL_SUCCESS.

Referenced by bsl_mock_encode_eid().

BSL_CBOR_Encode_Twopass()

int BSL_CBOR_Encode_Twopass	(	BSL_Data_t *	buf,
		BSL_CBOR_Encode_f	func,
		const void *	obj
	)

Perform two-pass size-fitted encoding.

Parameters

[out]	buf	The already-initialized buffer to resize and write into.
	func	The encoding function which takes the user data.
	obj	Pointer to the user data to encode.

Returns

BSL_SUCCESS if successful.

References ASSERT_ARG_NONNULL, BSL_Data_Resize(), BSL_ERR_ENCODING, BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_PLAINTEXT_PTR, BSL_SUCCESS, BSL_Data_t::len, BSL_Data_t::ptr, and UsefulBuf_FROM_BSL_Data.

Referenced by bsl_mock_encode_eid(), BSLP_PolicyOptions_SC3(), BSLX_CoseMsg_Headers_DerivePhdr(), BSLX_CoseSc_AddAadScope(), BSLX_CoseSc_Encrypt0_Source(), BSLX_CoseSc_Encrypt_Source(), BSLX_CoseSc_ExternalAad_Chunked(), BSLX_CoseSc_HkdfContentKey(), BSLX_CoseSc_Mac0_Source(), BSLX_CoseSc_Mac_Source(), Encode_ASB(), LLVMFuzzerTestOneInput(), mock_bpa_ctr_encode(), test_AppendixA_Example1_BIB_Source(), test_AppendixA_Example1_BIB_VerifyAccept(), test_AppendixA_Example4_BCB_Source(), test_AppendixA_Example4_BCB_VerifyAccept(), test_AppendixA_Example5_BCB_Source(), test_AppendixA_Example5_BCB_VerifyAccept(), test_AppendixA_Example6_BCB_Source(), test_bsl_mock_encode_bundle(), test_bsl_mock_encode_canonical(), test_bsl_mock_encode_primary(), test_CCSDS_Example_Mac_Source(), test_CCSDS_Example_Mac_VerifyAccept(), and TestASBDecodeEncodeClosure().

BSL_CBOR_EncodeEID()

int BSL_CBOR_EncodeEID	(	QCBOREncodeContext *	enc,
		const BSL_HostEID_t *	eid
	)

Helper to encode EID values in a way that is optimized for two-pass encoder.

Matches BSL_CBOR_Encode_f signature.

References BSL_Data_Deinit(), BSL_Data_Init(), BSL_ERR_ENCODING, BSL_HostEID_EncodeToCBOR(), BSL_LOG_ERR, BSL_SUCCESS, and UsefulBufC_FROM_BSL_Data.

Referenced by BSL_AbsSecBlock_Encode(), bsl_mock_encode_primary(), BSLX_CoseSc_KdfContext_Encode(), and test_bsl_loopback_eid().