asn1.c File Reference

#include <sys/types.h>
#include <stdlib.h>
#include <string.h>
#include <memdebug.h>
#include <pro/asn1.h>

Include dependency graph for asn1.c:

Functions
const uint8_t *	AsnHeaderParse (const uint8_t *data, size_t *datalength, uint8_t *type)
	Interpret the ID and length of the next object.
uint8_t *	AsnHeaderBuild (uint8_t *data, size_t *datalength, uint8_t type, size_t length)
	Build an ASN header for an object with a given ID and length.
const uint8_t *	AsnSequenceParse (const uint8_t *data, size_t *datalength, uint8_t type)
	Check the type and get the length of the next object.
uint8_t *	AsnSequenceBuild (uint8_t *data, size_t *datalength, uint8_t type, size_t length)
	Build an ASN header for a sequence with a given type and length.
const uint8_t *	AsnIntegerParse (const uint8_t *data, size_t *datalength, uint8_t *type, long *intp)
	Pull a long out of an ASN integer type.
uint8_t *	AsnIntegerBuild (uint8_t *data, size_t *datalength, uint8_t type, long *intp)
	Build an ASN object containing an integer.
const uint8_t *	AsnUnsignedParse (const uint8_t *data, size_t *datalength, uint8_t *type, uint32_t *intp)
	Pull an unsigned long out of an ASN integer type.
uint8_t *	AsnUnsignedBuild (uint8_t *data, size_t *datalength, uint8_t type, uint32_t *intp)
	Build an ASN object containing an unsigned integer.
const uint8_t *	AsnOctetStringParse (const uint8_t *data, size_t *datalength, uint8_t *type, uint8_t *string, size_t *strlength)
	Pulls a string out of an ASN octet string type.
uint8_t *	AsnOctetStringBuild (uint8_t *data, size_t *datalength, uint8_t type, const uint8_t *string, size_t strlength)
	Build an ASN object containing an octet string.
const uint8_t *	AsnOidParse (const uint8_t *data, size_t *datalength, uint8_t *type, OID *objid, size_t *objidlength)
	Pulls an object identifier out of an ASN object ID type.
uint8_t *	AsnOidBuild (uint8_t *data, size_t *datalength, uint8_t type, const OID *objid, size_t objidlength)
	Build an ASN object identifier.
const uint8_t *	AsnNullParse (const uint8_t *data, size_t *datalength, uint8_t *type)
	Parse an ASN null type.
uint8_t *	AsnNullBuild (uint8_t *data, size_t *datalength, uint8_t type)
	Build an ASN null object.
const uint8_t *	AsnBitStringParse (const uint8_t *data, size_t *datalength, uint8_t *type, uint8_t *string, size_t *strlength)
	Pull a bitstring out of an ASN bitstring type.
uint8_t *	AsnBitStringBuild (uint8_t *data, size_t *datalength, uint8_t type, const uint8_t *string, size_t strlength)
	Build an ASN bit string.
const uint8_t *	AsnUnsigned64Parse (const uint8_t *data, size_t *datalength, uint8_t *type, UNSIGNED64 *cp)
	Pull a 64 bit unsigned long out of an ASN integer type.
uint8_t *	AsnUnsigned64Build (uint8_t *data, size_t *datalength, uint8_t type, const UNSIGNED64 *cp)
	Build an ASN object containing a 64 bit unsigned integer.

---

Function Documentation

const uint8_t* AsnHeaderParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type
	)

Interpret the ID and length of the next object.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the ID and length.
type	Pointer to the variable that receives the ASN type of the object.

Returns:

A pointer to the first byte following ID and length (aka the start of the data field). Returns NULL on any error.

References ASN_EXTENSION_ID, and NULL.

Referenced by AsnSequenceParse(), SnmpAgentProcessRequest(), and SnmpVarParse().

uint8_t* AsnHeaderBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		size_t	length
	)

Build an ASN header for an object with a given ID and length.

This only works on data types < 30, i.e. no extension octets. The maximum length is 0xFFFF;

Parameters:

data	Pointer to start of object.
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the encoded ID and length of this object.
type	ASN type of the object.
length	Length of object.

Returns:

Returns a pointer to the first byte of the contents of this object. Returns NULL on any error.

References NULL.

Referenced by AsnBitStringBuild(), AsnIntegerBuild(), AsnNullBuild(), AsnOctetStringBuild(), AsnOidBuild(), AsnUnsigned64Build(), and AsnUnsignedBuild().

const uint8_t* AsnSequenceParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t	type
	)

Check the type and get the length of the next object.

Similare to AsnHeaderParse, but tests for expected type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the ID and length.
type	The expected ASN type of the object.

Returns:

A pointer to the first byte following ID and length (aka the start of the data field). Returns NULL on any error.

References AsnHeaderParse(), and NULL.

Referenced by SnmpAuthParse(), and SnmpVarParse().

Here is the call graph for this function:

uint8_t* AsnSequenceBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		size_t	length
	)

Build an ASN header for a sequence with a given type and length.

This only works on data types < 30, i.e. no extension octets. The maximum length is 0xFFFF;

Parameters:

data	Pointer to start of object.
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the encoded ID and length of this object.
type	ASN type of the object.
length	Length of object.

Returns:

Returns a pointer to the first byte of the contents of this object. Returns NULL on any error.

References NULL.

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), and SnmpVarBuild().

const uint8_t* AsnIntegerParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type,
		long *	intp
	)

Pull a long out of an ASN integer type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.
intp	Pointer to the variable that receives the value of the object.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References NULL.

Referenced by SnmpAgentProcessRequest(), and SnmpAuthParse().

uint8_t* AsnIntegerBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		long *	intp
	)

Build an ASN object containing an integer.

Parameters:

data	Pointer to start of output buffer
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.
intp	Value of the object.

Returns:

A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild(), and NULL.

Referenced by SnmpAgentProcessRequest(), SnmpAuthBuild(), and SnmpVarBuild().

Here is the call graph for this function:

const uint8_t* AsnUnsignedParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type,
		uint32_t *	intp
	)

Pull an unsigned long out of an ASN integer type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.
intp	Pointer to the variable that receives the value of the object.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References NULL.

uint8_t* AsnUnsignedBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		uint32_t *	intp
	)

Build an ASN object containing an unsigned integer.

Parameters:

data	Pointer to start of output buffer
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.
intp	Value of the object.

Returns:

A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild(), and NULL.

Referenced by SnmpVarBuild().

Here is the call graph for this function:

const uint8_t* AsnOctetStringParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type,
		uint8_t *	string,
		size_t *	strlength
	)

Pulls a string out of an ASN octet string type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.
string	Pointer to the variable that receives the value of the object.
strlength	Contains the size of the string buffer on entry. On exit, it is returned as the number of bytes stored in the string buffer.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References memcpy(), and NULL.

Referenced by SnmpAuthParse().

Here is the call graph for this function:

uint8_t* AsnOctetStringBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		const uint8_t *	string,
		size_t	strlength
	)

Build an ASN object containing an octet string.

Parameters:

data	Pointer to start of output buffer
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.
string	Pointer to the value. If NULL, the octet string will be filled with zeros.
strlength	Number of bytes in the string value.

Returns:

A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild(), memcpy(), memset(), and NULL.

Referenced by SnmpAuthBuild(), and SnmpVarBuild().

Here is the call graph for this function:

const uint8_t* AsnOidParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type,
		OID *	objid,
		size_t *	objidlength
	)

Pulls an object identifier out of an ASN object ID type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.
objid	Pointer to the variable that receives the object identifier.
objidlength	Points to a variable that contains the size of the output buffer on entry. On exit, it is returned as the number of sub IDs stored in the output buffer.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References ASN_BIT8, and NULL.

Referenced by SnmpVarParse().

uint8_t* AsnOidBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		const OID *	objid,
		size_t	objidlength
	)

Build an ASN object identifier.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.
objid	Pointer to the object identifier.
objidlength	Number of sub IDs in the object identifier.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild(), free(), malloc(), MAX_OID_LEN, and NULL.

Referenced by SnmpVarBuild().

Here is the call graph for this function:

const uint8_t* AsnNullParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type
	)

Parse an ASN null type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References NULL.

uint8_t* AsnNullBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type
	)

Build an ASN null object.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild().

Referenced by SnmpVarBuild().

Here is the call graph for this function:

const uint8_t* AsnBitStringParse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type,
		uint8_t *	string,
		size_t *	strlength
	)

Pull a bitstring out of an ASN bitstring type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.
string	Pointer to the variable that receives the value of the object.
strlength	Contains the size of the string buffer on entry. On exit, it is returned as the number of bytes stored in the string buffer.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References memcpy(), and NULL.

Here is the call graph for this function:

uint8_t* AsnBitStringBuild	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		const uint8_t *	string,
		size_t	strlength
	)

Build an ASN bit string.

Parameters:

data	Pointer to start of output buffer
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.
string	Pointer to the value. If NULL, the octet string will be filled with zeros.
strlength	Number of bytes in the string value.

Returns:

A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild(), memcpy(), and NULL.

Referenced by SnmpVarBuild().

Here is the call graph for this function:

const uint8_t* AsnUnsigned64Parse	(	const uint8_t *	data,
		size_t *	datalength,
		uint8_t *	type,
		UNSIGNED64 *	cp
	)

Pull a 64 bit unsigned long out of an ASN integer type.

Parameters:

data	Pointer to start of the object.
datalength	Contains the number of valid bytes following the start of the object. On exit, it is returned as the number of valid bytes following the end of this object.
type	Pointer to the variable that receives the ASN type of the object.
intp	Pointer to the variable that receives the value of the object.

Returns:

Pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References UNSIGNED64::high, UNSIGNED64::low, and NULL.

uint8_t* AsnUnsigned64Build	(	uint8_t *	data,
		size_t *	datalength,
		uint8_t	type,
		const UNSIGNED64 *	cp
	)

Build an ASN object containing a 64 bit unsigned integer.

Parameters:

data	Pointer to start of output buffer
datalength	Contains the number of available bytes following the start of the object. On exit, it is returned as the number of available bytes following the end of this object.
type	ASN type of the object.
intp	Value of the object.

Returns:

A pointer to the first byte past the end of this object (i.e. the start of the next object). Returns NULL on any error.

References AsnHeaderBuild(), UNSIGNED64::high, UNSIGNED64::low, and NULL.

Referenced by SnmpVarBuild().

Here is the call graph for this function: