Declaration of CBOR CODEC wrappers and interfaces. More...

#include "bsl/BPSecLib_Public.h"
#include <qcbor/qcbor_encode.h>
#include <qcbor/qcbor_spiffy_decode.h>

Include dependency graph for CBOR.h:

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

Macros
#define	UsefulBuf_FROM_BSL_Data(obj) ((UsefulBuf) { (obj).ptr, (obj).len })

#define	UsefulBufC_FROM_BSL_Data(obj) ((UsefulBufC) { (obj).ptr, (obj).len })

Typedefs
typedef int(*	BSL_CBOR_Encode_f) (QCBOREncodeContext enc, const void obj)
	Callback to actually perform the encoding.

typedef int(*	BSL_CBOR_Decode_f) (QCBORDecodeContext dec, const void obj)
	Callback to actually perform the decoding.

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

Declaration of CBOR CODEC wrappers and interfaces.

Macro Definition Documentation

◆ UsefulBuf_FROM_BSL_Data

#define UsefulBuf_FROM_BSL_Data ( obj ) ((UsefulBuf) { (obj).ptr, (obj).len })

◆ UsefulBufC_FROM_BSL_Data

#define UsefulBufC_FROM_BSL_Data ( obj ) ((UsefulBufC) { (obj).ptr, (obj).len })

Typedef Documentation

◆ BSL_CBOR_Decode_f

typedef int(* BSL_CBOR_Decode_f) (QCBORDecodeContext *dec, const void *obj)

Callback to actually perform the decoding.

Parameters

enc	Non-null pointer to the decoder to use.
obj	Pointer to the user data to decode into.

◆ BSL_CBOR_Encode_f

typedef int(* BSL_CBOR_Encode_f) (QCBOREncodeContext *enc, const void *obj)

Callback to actually perform the encoding.

Parameters

enc	Non-null pointer to the encoder to use.
obj	Pointer to the user data to encode.

Returns: BSL_SUCCESS if successful.

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.