asn1.h File Reference

Generic ASN.1 parsing. More...

Data Structures
struct	mbedtls_asn1_bitstring
struct	mbedtls_asn1_buf
struct	mbedtls_asn1_named_data
struct	mbedtls_asn1_sequence

Macros
ASN1 Error codes
These error codes are OR'ed to X509 error codes for higher error granularity. ASN1 is a standard to specify data structures.
#define	MBEDTLS_ERR_ASN1_ALLOC_FAILED   -0x006A
#define	MBEDTLS_ERR_ASN1_BUF_TOO_SMALL   -0x006C
#define	MBEDTLS_ERR_ASN1_INVALID_DATA   -0x0068
#define	MBEDTLS_ERR_ASN1_INVALID_LENGTH   -0x0064
#define	MBEDTLS_ERR_ASN1_LENGTH_MISMATCH   -0x0066
#define	MBEDTLS_ERR_ASN1_OUT_OF_DATA   -0x0060
#define	MBEDTLS_ERR_ASN1_UNEXPECTED_TAG   -0x0062
DER constants
These constants comply with the DER encoded ASN.1 type tags. DER encoding uses hexadecimal representation. An example DER sequence is: 0x02 – tag indicating INTEGER 0x01 – length in octets 0x05 – value Such sequences are typically read into mbedtls_x509_buf.
#define	MBEDTLS_OID_CMP(oid_str, oid_buf)
#define	MBEDTLS_OID_SIZE(x)

Functions to parse ASN.1 data structures
typedef struct mbedtls_asn1_bitstring	mbedtls_asn1_bitstring
typedef struct mbedtls_asn1_buf	mbedtls_asn1_buf
mbedtls_asn1_named_data *	mbedtls_asn1_find_named_data (mbedtls_asn1_named_data *list, const char *oid, size_t len)
	Find a specific named_data entry in a sequence or list based on the OID.
void	mbedtls_asn1_free_named_data (mbedtls_asn1_named_data *entry)
	Free a mbedtls_asn1_named_data entry.
void	mbedtls_asn1_free_named_data_list (mbedtls_asn1_named_data **head)
	Free all entries in a mbedtls_asn1_named_data list Head will be set to NULL.
int	mbedtls_asn1_get_alg (unsigned char **p, const unsigned char *end, mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params)
	Retrieve an AlgorithmIdentifier ASN.1 sequence. Updates the pointer to immediately behind the full AlgorithmIdentifier.
int	mbedtls_asn1_get_alg_null (unsigned char **p, const unsigned char *end, mbedtls_asn1_buf *alg)
	Retrieve an AlgorithmIdentifier ASN.1 sequence with NULL or no params. Updates the pointer to immediately behind the full AlgorithmIdentifier.
int	mbedtls_asn1_get_bitstring (unsigned char **p, const unsigned char *end, mbedtls_asn1_bitstring *bs)
	Retrieve a bitstring ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
int	mbedtls_asn1_get_bitstring_null (unsigned char **p, const unsigned char *end, size_t *len)
	Retrieve a bitstring ASN.1 tag without unused bits and its value. Updates the pointer to the beginning of the bit/octet string.
int	mbedtls_asn1_get_bool (unsigned char **p, const unsigned char *end, int *val)
	Retrieve a boolean ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
int	mbedtls_asn1_get_int (unsigned char **p, const unsigned char *end, int *val)
	Retrieve an integer ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
int	mbedtls_asn1_get_len (unsigned char **p, const unsigned char *end, size_t *len)
	Get the length of an ASN.1 element. Updates the pointer to immediately behind the length.
int	mbedtls_asn1_get_mpi (unsigned char **p, const unsigned char *end, mbedtls_mpi *X)
	Retrieve a MPI value from an integer ASN.1 tag. Updates the pointer to immediately behind the full tag.
int	mbedtls_asn1_get_sequence_of (unsigned char **p, const unsigned char *end, mbedtls_asn1_sequence *cur, int tag)
	Parses and splits an ASN.1 "SEQUENCE OF <tag>" Updated the pointer to immediately behind the full sequence tag.
int	mbedtls_asn1_get_tag (unsigned char **p, const unsigned char *end, size_t *len, int tag)
	Get the tag and length of the tag. Check for the requested tag. Updates the pointer to immediately behind the tag and length.
typedef struct mbedtls_asn1_named_data	mbedtls_asn1_named_data
typedef struct mbedtls_asn1_sequence	mbedtls_asn1_sequence

Detailed Description

Generic ASN.1 parsing.