ReactOS 0.4.15-dev-8227-g32d615f
Asn1_module

Classes

struct  mbedtls_asn1_buf
 
struct  mbedtls_asn1_bitstring
 
struct  mbedtls_asn1_sequence
 
struct  mbedtls_asn1_named_data
 

Variables

int mbedtls_asn1_buf::tag
 
size_t mbedtls_asn1_buf::len
 
unsigned charmbedtls_asn1_buf::p
 
size_t mbedtls_asn1_bitstring::len
 
unsigned char mbedtls_asn1_bitstring::unused_bits
 
unsigned charmbedtls_asn1_bitstring::p
 
mbedtls_asn1_buf mbedtls_asn1_sequence::buf
 
struct mbedtls_asn1_sequencembedtls_asn1_sequence::next
 
mbedtls_asn1_buf mbedtls_asn1_named_data::oid
 
mbedtls_asn1_buf mbedtls_asn1_named_data::val
 
struct mbedtls_asn1_named_datambedtls_asn1_named_data::next
 
unsigned char mbedtls_asn1_named_data::next_merged
 

Functions to parse ASN.1 data structures

typedef struct mbedtls_asn1_buf mbedtls_asn1_buf
 
typedef struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
 
typedef struct mbedtls_asn1_sequence mbedtls_asn1_sequence
 
typedef struct mbedtls_asn1_named_data mbedtls_asn1_named_data
 
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_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.
 
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_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_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_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_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.
 
mbedtls_asn1_named_datambedtls_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.
 

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_OUT_OF_DATA   -0x0060
 
#define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG   -0x0062
 
#define MBEDTLS_ERR_ASN1_INVALID_LENGTH   -0x0064
 
#define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH   -0x0066
 
#define MBEDTLS_ERR_ASN1_INVALID_DATA   -0x0068
 
#define MBEDTLS_ERR_ASN1_ALLOC_FAILED   -0x006A
 
#define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL   -0x006C
 

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_ASN1_BOOLEAN   0x01
 
#define MBEDTLS_ASN1_INTEGER   0x02
 
#define MBEDTLS_ASN1_BIT_STRING   0x03
 
#define MBEDTLS_ASN1_OCTET_STRING   0x04
 
#define MBEDTLS_ASN1_NULL   0x05
 
#define MBEDTLS_ASN1_OID   0x06
 
#define MBEDTLS_ASN1_UTF8_STRING   0x0C
 
#define MBEDTLS_ASN1_SEQUENCE   0x10
 
#define MBEDTLS_ASN1_SET   0x11
 
#define MBEDTLS_ASN1_PRINTABLE_STRING   0x13
 
#define MBEDTLS_ASN1_T61_STRING   0x14
 
#define MBEDTLS_ASN1_IA5_STRING   0x16
 
#define MBEDTLS_ASN1_UTC_TIME   0x17
 
#define MBEDTLS_ASN1_GENERALIZED_TIME   0x18
 
#define MBEDTLS_ASN1_UNIVERSAL_STRING   0x1C
 
#define MBEDTLS_ASN1_BMP_STRING   0x1E
 
#define MBEDTLS_ASN1_PRIMITIVE   0x00
 
#define MBEDTLS_ASN1_CONSTRUCTED   0x20
 
#define MBEDTLS_ASN1_CONTEXT_SPECIFIC   0x80
 
#define MBEDTLS_ASN1_TAG_CLASS_MASK   0xC0
 
#define MBEDTLS_ASN1_TAG_PC_MASK   0x20
 
#define MBEDTLS_ASN1_TAG_VALUE_MASK   0x1F
 
#define MBEDTLS_OID_SIZE(x)   (sizeof(x) - 1)
 
#define MBEDTLS_OID_CMP(oid_str, oid_buf)
 

Detailed Description

Macro Definition Documentation

◆ MBEDTLS_ASN1_BIT_STRING

#define MBEDTLS_ASN1_BIT_STRING   0x03

Definition at line 99 of file asn1.h.

◆ MBEDTLS_ASN1_BMP_STRING

#define MBEDTLS_ASN1_BMP_STRING   0x1E

Definition at line 112 of file asn1.h.

◆ MBEDTLS_ASN1_BOOLEAN

#define MBEDTLS_ASN1_BOOLEAN   0x01

Definition at line 97 of file asn1.h.

◆ MBEDTLS_ASN1_CONSTRUCTED

#define MBEDTLS_ASN1_CONSTRUCTED   0x20

Definition at line 114 of file asn1.h.

◆ MBEDTLS_ASN1_CONTEXT_SPECIFIC

#define MBEDTLS_ASN1_CONTEXT_SPECIFIC   0x80

Definition at line 115 of file asn1.h.

◆ MBEDTLS_ASN1_GENERALIZED_TIME

#define MBEDTLS_ASN1_GENERALIZED_TIME   0x18

Definition at line 110 of file asn1.h.

◆ MBEDTLS_ASN1_IA5_STRING

#define MBEDTLS_ASN1_IA5_STRING   0x16

Definition at line 108 of file asn1.h.

◆ MBEDTLS_ASN1_INTEGER

#define MBEDTLS_ASN1_INTEGER   0x02

Definition at line 98 of file asn1.h.

◆ MBEDTLS_ASN1_NULL

#define MBEDTLS_ASN1_NULL   0x05

Definition at line 101 of file asn1.h.

◆ MBEDTLS_ASN1_OCTET_STRING

#define MBEDTLS_ASN1_OCTET_STRING   0x04

Definition at line 100 of file asn1.h.

◆ MBEDTLS_ASN1_OID

#define MBEDTLS_ASN1_OID   0x06

Definition at line 102 of file asn1.h.

◆ MBEDTLS_ASN1_PRIMITIVE

#define MBEDTLS_ASN1_PRIMITIVE   0x00

Definition at line 113 of file asn1.h.

◆ MBEDTLS_ASN1_PRINTABLE_STRING

#define MBEDTLS_ASN1_PRINTABLE_STRING   0x13

Definition at line 106 of file asn1.h.

◆ MBEDTLS_ASN1_SEQUENCE

#define MBEDTLS_ASN1_SEQUENCE   0x10

Definition at line 104 of file asn1.h.

◆ MBEDTLS_ASN1_SET

#define MBEDTLS_ASN1_SET   0x11

Definition at line 105 of file asn1.h.

◆ MBEDTLS_ASN1_T61_STRING

#define MBEDTLS_ASN1_T61_STRING   0x14

Definition at line 107 of file asn1.h.

◆ MBEDTLS_ASN1_TAG_CLASS_MASK

#define MBEDTLS_ASN1_TAG_CLASS_MASK   0xC0

Definition at line 127 of file asn1.h.

◆ MBEDTLS_ASN1_TAG_PC_MASK

#define MBEDTLS_ASN1_TAG_PC_MASK   0x20

Definition at line 128 of file asn1.h.

◆ MBEDTLS_ASN1_TAG_VALUE_MASK

#define MBEDTLS_ASN1_TAG_VALUE_MASK   0x1F

Definition at line 129 of file asn1.h.

◆ MBEDTLS_ASN1_UNIVERSAL_STRING

#define MBEDTLS_ASN1_UNIVERSAL_STRING   0x1C

Definition at line 111 of file asn1.h.

◆ MBEDTLS_ASN1_UTC_TIME

#define MBEDTLS_ASN1_UTC_TIME   0x17

Definition at line 109 of file asn1.h.

◆ MBEDTLS_ASN1_UTF8_STRING

#define MBEDTLS_ASN1_UTF8_STRING   0x0C

Definition at line 103 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_ALLOC_FAILED

#define MBEDTLS_ERR_ASN1_ALLOC_FAILED   -0x006A

Memory allocation failed

Definition at line 81 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_BUF_TOO_SMALL

#define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL   -0x006C

Buffer too small when writing ASN.1 data structure.

Definition at line 82 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_INVALID_DATA

#define MBEDTLS_ERR_ASN1_INVALID_DATA   -0x0068

Data is invalid. (not used)

Definition at line 80 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_INVALID_LENGTH

#define MBEDTLS_ERR_ASN1_INVALID_LENGTH   -0x0064

Error when trying to determine the length or invalid length.

Definition at line 78 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_LENGTH_MISMATCH

#define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH   -0x0066

Actual length differs from expected length.

Definition at line 79 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_OUT_OF_DATA

#define MBEDTLS_ERR_ASN1_OUT_OF_DATA   -0x0060

Out of data when parsing an ASN1 data structure.

Definition at line 76 of file asn1.h.

◆ MBEDTLS_ERR_ASN1_UNEXPECTED_TAG

#define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG   -0x0062

ASN1 tag was of an unexpected value.

Definition at line 77 of file asn1.h.

◆ MBEDTLS_OID_CMP

#define MBEDTLS_OID_CMP (   oid_str,
  oid_buf 
)
Value:
( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
GLfloat GLfloat p
Definition: glext.h:8902
GLenum GLsizei len
Definition: glext.h:6722
#define MBEDTLS_OID_SIZE(x)
Definition: asn1.h:135

Compares an mbedtls_asn1_buf structure to a reference OID.

Only works for 'defined' oid_str values (MBEDTLS_OID_HMAC_SHA1), you cannot use a 'unsigned char *oid' here!

Definition at line 143 of file asn1.h.

◆ MBEDTLS_OID_SIZE

#define MBEDTLS_OID_SIZE (   x)    (sizeof(x) - 1)

Returns the size of the binary string, without the trailing \0

Definition at line 135 of file asn1.h.

Typedef Documentation

◆ mbedtls_asn1_bitstring

Container for ASN1 bit strings.

◆ mbedtls_asn1_buf

Type-length-value structure that allows for ASN1 using DER.

◆ mbedtls_asn1_named_data

Container for a sequence or list of 'named' ASN.1 data items

◆ mbedtls_asn1_sequence

Container for a sequence of ASN.1 items

Function Documentation

◆ mbedtls_asn1_find_named_data()

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.

Parameters
listThe list to seek through
oidThe OID to look for
lenSize of the OID
Returns
NULL if not found, or a pointer to the existing entry.

◆ mbedtls_asn1_free_named_data()

void mbedtls_asn1_free_named_data ( mbedtls_asn1_named_data entry)

Free a mbedtls_asn1_named_data entry.

Parameters
entryThe named data entry to free

◆ mbedtls_asn1_free_named_data_list()

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.

Parameters
headPointer to the head of the list of named data entries to free

◆ mbedtls_asn1_get_alg()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
algThe buffer to receive the OID
paramsThe buffer to receive the params (if any)
Returns
0 if successful or a specific ASN.1 or MPI error code.

◆ mbedtls_asn1_get_alg_null()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
algThe buffer to receive the OID
Returns
0 if successful or a specific ASN.1 or MPI error code.

◆ mbedtls_asn1_get_bitstring()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
bsThe variable that will receive the value
Returns
0 if successful or a specific ASN.1 error code.

◆ mbedtls_asn1_get_bitstring_null()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
lenLength of the actual bit/octect string in bytes
Returns
0 if successful or a specific ASN.1 error code.

◆ mbedtls_asn1_get_bool()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
valThe variable that will receive the value
Returns
0 if successful or a specific ASN.1 error code.

◆ mbedtls_asn1_get_int()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
valThe variable that will receive the value
Returns
0 if successful or a specific ASN.1 error code.

◆ mbedtls_asn1_get_len()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
lenThe variable that will receive the value
Returns
0 if successful, MBEDTLS_ERR_ASN1_OUT_OF_DATA on reaching end of data, MBEDTLS_ERR_ASN1_INVALID_LENGTH if length is unparseable.

◆ mbedtls_asn1_get_mpi()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
XThe MPI that will receive the value
Returns
0 if successful or a specific ASN.1 or MPI error code.

◆ mbedtls_asn1_get_sequence_of()

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.

Parameters
pThe position in the ASN.1 data
endEnd of data
curFirst variable in the chain to fill
tagType of sequence
Returns
0 if successful or a specific ASN.1 error code.

◆ mbedtls_asn1_get_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.

Parameters
pThe position in the ASN.1 data
endEnd of data
lenThe variable that will receive the length
tagThe expected tag
Returns
0 if successful, MBEDTLS_ERR_ASN1_UNEXPECTED_TAG if tag did not match requested tag, or another specific ASN.1 error code.

Variable Documentation

◆ buf

mbedtls_asn1_buf mbedtls_asn1_sequence::buf

Buffer containing the given ASN.1 item.

Definition at line 183 of file asn1.h.

◆ len [1/2]

size_t mbedtls_asn1_buf::len

ASN1 length, in octets.

Definition at line 162 of file asn1.h.

◆ len [2/2]

size_t mbedtls_asn1_bitstring::len

ASN1 length, in octets.

Definition at line 172 of file asn1.h.

◆ next [1/2]

struct mbedtls_asn1_sequence* mbedtls_asn1_sequence::next

The next entry in the sequence.

Definition at line 184 of file asn1.h.

◆ next [2/2]

struct mbedtls_asn1_named_data* mbedtls_asn1_named_data::next

The next entry in the sequence.

Definition at line 195 of file asn1.h.

◆ next_merged

unsigned char mbedtls_asn1_named_data::next_merged

Merge next item into the current one?

Definition at line 196 of file asn1.h.

◆ oid

mbedtls_asn1_buf mbedtls_asn1_named_data::oid

The object identifier.

Definition at line 193 of file asn1.h.

◆ p [1/2]

unsigned char* mbedtls_asn1_buf::p

ASN1 data, e.g. in ASCII.

Definition at line 163 of file asn1.h.

◆ p [2/2]

unsigned char* mbedtls_asn1_bitstring::p

Raw ASN1 data for the bit string

Definition at line 174 of file asn1.h.

◆ tag

int mbedtls_asn1_buf::tag

ASN1 type, e.g. MBEDTLS_ASN1_UTF8_STRING.

Definition at line 161 of file asn1.h.

◆ unused_bits

unsigned char mbedtls_asn1_bitstring::unused_bits

Number of unused bits at the end of the string

Definition at line 173 of file asn1.h.

◆ val

mbedtls_asn1_buf mbedtls_asn1_named_data::val

The named value.

Definition at line 194 of file asn1.h.