Go to the documentation of this file.
24 #ifndef MBEDTLS_ASN1_H
25 #define MBEDTLS_ASN1_H
27 #if !defined(MBEDTLS_CONFIG_FILE)
30 #include MBEDTLS_CONFIG_FILE
35 #if defined(MBEDTLS_BIGNUM_C)
51 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
52 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
53 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
54 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
55 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
56 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
57 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
72 #define MBEDTLS_ASN1_BOOLEAN 0x01
73 #define MBEDTLS_ASN1_INTEGER 0x02
74 #define MBEDTLS_ASN1_BIT_STRING 0x03
75 #define MBEDTLS_ASN1_OCTET_STRING 0x04
76 #define MBEDTLS_ASN1_NULL 0x05
77 #define MBEDTLS_ASN1_OID 0x06
78 #define MBEDTLS_ASN1_ENUMERATED 0x0A
79 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
80 #define MBEDTLS_ASN1_SEQUENCE 0x10
81 #define MBEDTLS_ASN1_SET 0x11
82 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
83 #define MBEDTLS_ASN1_T61_STRING 0x14
84 #define MBEDTLS_ASN1_IA5_STRING 0x16
85 #define MBEDTLS_ASN1_UTC_TIME 0x17
86 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
87 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
88 #define MBEDTLS_ASN1_BMP_STRING 0x1E
89 #define MBEDTLS_ASN1_PRIMITIVE 0x00
90 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
91 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
95 #define MBEDTLS_ASN1_IS_STRING_TAG( tag ) \
96 ( ( tag ) < 32u && ( \
97 ( ( 1u << ( tag ) ) & ( ( 1u << MBEDTLS_ASN1_BMP_STRING ) | \
98 ( 1u << MBEDTLS_ASN1_UTF8_STRING ) | \
99 ( 1u << MBEDTLS_ASN1_T61_STRING ) | \
100 ( 1u << MBEDTLS_ASN1_IA5_STRING ) | \
101 ( 1u << MBEDTLS_ASN1_UNIVERSAL_STRING ) | \
102 ( 1u << MBEDTLS_ASN1_PRINTABLE_STRING ) | \
103 ( 1u << MBEDTLS_ASN1_BIT_STRING ) ) ) != 0 ) )
115 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
116 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
117 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
123 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
131 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
132 ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
133 memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
135 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
136 ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len) ) || \
137 memcmp( (oid_str), (oid_buf), (oid_buf_len) ) != 0 )
211 const unsigned char *end,
236 const unsigned char *end,
237 size_t *len,
int tag );
255 const unsigned char *end,
276 const unsigned char *end,
297 const unsigned char *end,
339 const unsigned char *end,
390 const unsigned char *end,
503 const unsigned char *end,
504 unsigned char tag_must_mask,
unsigned char tag_must_val,
505 unsigned char tag_may_mask,
unsigned char tag_may_val,
506 int (*cb)(
void *ctx,
int tag,
507 unsigned char* start,
size_t len ),
510 #if defined(MBEDTLS_BIGNUM_C)
530 const unsigned char *end,
551 const unsigned char *end,
570 const unsigned char *end,
584 const char *
oid,
size_t len );
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 beginnin...
struct mbedtls_asn1_buf mbedtls_asn1_buf
unsigned char unused_bits
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.
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.
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
struct mbedtls_asn1_named_data * next
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.
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.
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_traverse_sequence_of(unsigned char **p, const unsigned char *end, unsigned char tag_must_mask, unsigned char tag_must_val, unsigned char tag_may_mask, unsigned char tag_may_val, int(*cb)(void *ctx, int tag, unsigned char *start, size_t len), void *ctx)
Traverse an ASN.1 SEQUENCE container and call a callback for each entry.
Multi-precision integer library.
int mbedtls_asn1_get_tag(unsigned char **p, const unsigned char *end, size_t *len, int tag)
Get the tag and length of the element. Check for the requested tag. Updates the pointer to immediatel...
struct mbedtls_asn1_sequence * next
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 immedia...
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 Al...
unsigned char next_merged
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
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_mpi(unsigned char **p, const unsigned char *end, mbedtls_mpi *X)
Retrieve an integer ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
Configuration options (set of defines)
int mbedtls_asn1_get_enum(unsigned char **p, const unsigned char *end, int *val)
Retrieve an enumerated ASN.1 tag and its value. Updates the pointer to immediately behind the full ta...
void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq)
Free a heap-allocated linked list presentation of an ASN.1 sequence, including the first element.
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>". Updates the pointer to immediately behind the full se...