A DataType which stores the trust list of a Server. More...

#include <trustlistdatatype.h>

Data Fields
uint32_t	specified_lists
	A bit mask which indicates which lists contain information. More...

struct ua_bytestring *	trusted_certificates
	The list of Application and CA Certificates which are trusted.

int32_t	num_trusted_certificates
	Number of elements in ua_trustlistdatatype::trusted_certificates.

struct ua_bytestring *	trusted_crls
	The CRLs for the CA Certificates in the trustedCertificates list.

int32_t	num_trusted_crls
	Number of elements in ua_trustlistdatatype::trusted_crls.

struct ua_bytestring *	issuer_certificates
	The list of CA Certificates which are necessary to validate Certificates.

int32_t	num_issuer_certificates
	Number of elements in ua_trustlistdatatype::issuer_certificates.

struct ua_bytestring *	issuer_crls
	The CRLs for the CA Certificates in the issuerCertificates list.

int32_t	num_issuer_crls
	Number of elements in ua_trustlistdatatype::issuer_crls.

Related Functions
void	ua_trustlistdatatype_init (struct ua_trustlistdatatype *t)
	Initialize an ua_trustlistdatatype struct with a valid value. More...

void	ua_trustlistdatatype_clear (struct ua_trustlistdatatype *t)
	Clear all resources alloctated in an ua_trustlistdatatype struct. More...

int	ua_trustlistdatatype_compare (const struct ua_trustlistdatatype a, const struct ua_trustlistdatatype b)
	Compare two ua_trustlistdatatype structs. More...

int	ua_trustlistdatatype_copy (struct ua_trustlistdatatype dst, const struct ua_trustlistdatatype src)
	Create a copy of a ua_trustlistdatatype struct. More...

static int	ua_trustlistdatatype_resize_trusted_certificates_array (struct ua_trustlistdatatype *val, int32_t new_len)
	Resize the trusted_certificates array of a ua_trustlistdatatype struct. More...

static int	ua_trustlistdatatype_resize_trusted_crls_array (struct ua_trustlistdatatype *val, int32_t new_len)
	Resize the trusted_crls array of a ua_trustlistdatatype struct. More...

static int	ua_trustlistdatatype_resize_issuer_certificates_array (struct ua_trustlistdatatype *val, int32_t new_len)
	Resize the issuer_certificates array of a ua_trustlistdatatype struct. More...

static int	ua_trustlistdatatype_resize_issuer_crls_array (struct ua_trustlistdatatype *val, int32_t new_len)
	Resize the issuer_crls array of a ua_trustlistdatatype struct. More...

Detailed Description

A DataType which stores the trust list of a Server.

Friends And Related Function Documentation

void ua_trustlistdatatype_clear ( struct ua_trustlistdatatype * t )

Frees allocated memory like arrays and resets numeric values. The ua_trustlistdatatype struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_trustlistdatatype struct, that was validly decoded, initilized by ua_trustlistdatatype_init or created with ua_trustlistdatatype_copy.

int ua_trustlistdatatype_compare	(	const struct ua_trustlistdatatype *	a,
		const struct ua_trustlistdatatype *	b
	)

Compares the content of the ua_trustlistdatatype struct a to the content of the ua_trustlistdatatype struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_trustlistdatatype structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_trustlistdatatype_copy	(	struct ua_trustlistdatatype *	dst,
		const struct ua_trustlistdatatype *	src
	)

Copy all fields from struct ua_trustlistdatatype src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns: Zero on success or ua_statuscode on failure.

void ua_trustlistdatatype_init ( struct ua_trustlistdatatype * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_trustlistdatatype struct can also be passed to ua_trustlistdatatype_compare, ua_trustlistdatatype_copy and ua_trustlistdatatype_clear. This function will always succeed as long as an ua_trustlistdatatype struct is passed to it.

static int ua_trustlistdatatype_resize_issuer_certificates_array	(	struct ua_trustlistdatatype *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the issuer_certificates array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_trustlistdatatype_resize_issuer_crls_array	(	struct ua_trustlistdatatype *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the issuer_crls array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_trustlistdatatype_resize_trusted_certificates_array	(	struct ua_trustlistdatatype *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the trusted_certificates array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_trustlistdatatype_resize_trusted_crls_array	(	struct ua_trustlistdatatype *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the trusted_crls array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

specified_lists

A bit mask which indicates which lists contain information.

See ua_trustlistmasks for allowed values.

The documentation for this struct was generated from the following files:

C:/work/embeddedstack/src/uabase/structure/trustlistdatatype.h
C:/work/embeddedstack/src/uabase/structure/trustlistdatatype.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation