encode.c File Reference

Definitions for bundle and block encoding. More...

#include <BPSecLib_Private.h>
#include "encode.h"
#include "agent.h"
#include "crc.h"

Include dependency graph for encode.c:

Functions
int	bsl_mock_encode_eid (const BSL_HostEID_t *eid, BSL_Data_t *encoded_bytes)
	Encode a single EID.
int	bsl_mock_encode_eid_from_ctx (QCBOREncodeContext *enc, const BSL_HostEID_t *eid)
	Encode a single EID from a QCBOR Encode Context.
int	bsl_mock_encode_primary (QCBOREncodeContext *enc, const MockBPA_PrimaryBlock_t *blk)
	Encode primary block to a CBOR data.
int	bsl_mock_encode_canonical (QCBOREncodeContext *enc, const MockBPA_CanonicalBlock_t *blk)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int	bsl_mock_encode_bundle (QCBOREncodeContext *enc, const MockBPA_Bundle_t *bundle)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Variables
static const uint8_t	zero_crc [] = { 0, 0, 0, 0 }

Detailed Description

Definitions for bundle and block encoding.

Function Documentation

bsl_mock_encode_bundle()

int bsl_mock_encode_bundle	(	QCBOREncodeContext *	enc,
		const MockBPA_Bundle_t *	bundle
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References MockBPA_Bundle_t::blocks, bsl_mock_encode_canonical(), bsl_mock_encode_primary(), and MockBPA_Bundle_t::primary_block.

Referenced by LLVMFuzzerTestOneInput(), M_ALGO_DEF(), test_bsl_loopback_bundle(), and test_bsl_mock_encode_bundle().

bsl_mock_encode_canonical()

int bsl_mock_encode_canonical	(	QCBOREncodeContext *	enc,
		const MockBPA_CanonicalBlock_t *	blk
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References MockBPA_CanonicalBlock_t::blk_num, MockBPA_CanonicalBlock_t::blk_type, BSL_BUNDLECRCTYPE_16, BSL_BUNDLECRCTYPE_32, MockBPA_CanonicalBlock_t::btsd, MockBPA_CanonicalBlock_t::btsd_len, MockBPA_CanonicalBlock_t::crc_type, MockBPA_CanonicalBlock_t::flags, mock_bpa_crc_apply(), and zero_crc.

Referenced by bsl_mock_encode_bundle(), and test_bsl_mock_encode_canonical().

bsl_mock_encode_eid()

int bsl_mock_encode_eid	(	const BSL_HostEID_t *	eid,
		BSL_Data_t *	encoded_bytes
	)

Encode a single EID.

Matches the signature for the BSL_HostDescriptors_t::eid_to_cbor function.

Parameters

[in]	eid	The EID value.
[in,out]	encoded_bytes	Resulting encoded bytes. NULL if checking for required CBOR length.

References bsl_mock_eid_t::as_ipn, bsl_mock_eid_t::as_raw, bsl_eid_ipn_ssp_t::auth_num, BSL_CHKERR1, BSL_ERR_ENCODING, BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_MOCK_EID_IPN, BSL_HostEID_t::handle, BSL_Data_t::len, bsl_eid_ipn_ssp_t::ncomp, bsl_eid_ipn_ssp_t::node_num, BSL_Data_t::ptr, bsl_mock_eid_t::scheme, bsl_mock_eid_t::ssp, and bsl_eid_ipn_ssp_t::svc_num.

Referenced by MockBPA_Agent_Descriptors().

bsl_mock_encode_eid_from_ctx()

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

Encode a single EID from a QCBOR Encode Context.

Parameters

[in,out]	enc	QCBOR Encode Context.
[in]	eid	The EID Value.

References BSL_Data_Deinit(), BSL_Data_InitBuffer(), BSL_ERR_ENCODING, BSL_HostEID_EncodeToCBOR(), BSL_LOG_ERR, BSL_SUCCESS, BSL_Data_t::len, and BSL_Data_t::ptr.

Referenced by bsl_mock_encode_primary(), and test_bsl_loopback_eid().

bsl_mock_encode_primary()

int bsl_mock_encode_primary	(	QCBOREncodeContext *	enc,
		const MockBPA_PrimaryBlock_t *	blk
	)

Encode primary block to a CBOR data.

Parameters

[in]	enc	The encoder.
[in]	blk	primary block information to be encoded

Returns

0 if successful

References MockBPA_PrimaryBlock_t::adu_length, BSL_BUNDLE_IS_FRAGMENT, BSL_BUNDLECRCTYPE_16, BSL_BUNDLECRCTYPE_32, bsl_mock_encode_eid_from_ctx(), MockBPA_CreationTimestamp_t::bundle_creation_time, MockBPA_PrimaryBlock_t::crc_type, MockBPA_PrimaryBlock_t::dest_eid, MockBPA_PrimaryBlock_t::flags, MockBPA_PrimaryBlock_t::frag_offset, MockBPA_PrimaryBlock_t::lifetime, mock_bpa_crc_apply(), MockBPA_PrimaryBlock_t::report_to_eid, MockBPA_CreationTimestamp_t::seq_num, MockBPA_PrimaryBlock_t::src_node_id, MockBPA_PrimaryBlock_t::timestamp, MockBPA_PrimaryBlock_t::version, and zero_crc.

Referenced by bsl_mock_encode_bundle(), and TEST_CASE().

Variable Documentation

zero_crc

const uint8_t zero_crc[] = { 0, 0, 0, 0 }

static

Referenced by bsl_mock_encode_canonical(), and bsl_mock_encode_primary().