mbed TLS v2.3.0
asn1.h
Go to the documentation of this file.
1 
25 #ifndef MBEDTLS_ASN1_H
26 #define MBEDTLS_ASN1_H
27 
28 #if !defined(MBEDTLS_CONFIG_FILE)
29 #include "config.h"
30 #else
31 #include MBEDTLS_CONFIG_FILE
32 #endif
33 
34 #include <stddef.h>
35 
36 #if defined(MBEDTLS_BIGNUM_C)
37 #include "bignum.h"
38 #endif
39 
52 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
53 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
54 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
55 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
56 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
57 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
58 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
60 /* \} name */
61 
73 #define MBEDTLS_ASN1_BOOLEAN 0x01
74 #define MBEDTLS_ASN1_INTEGER 0x02
75 #define MBEDTLS_ASN1_BIT_STRING 0x03
76 #define MBEDTLS_ASN1_OCTET_STRING 0x04
77 #define MBEDTLS_ASN1_NULL 0x05
78 #define MBEDTLS_ASN1_OID 0x06
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
92 /* \} name */
93 /* \} addtogroup asn1_module */
94 
96 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
97 
104 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
105  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
106  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
107 
108 #ifdef __cplusplus
109 extern "C" {
110 #endif
111 
120 typedef struct mbedtls_asn1_buf
121 {
122  int tag;
123  size_t len;
124  unsigned char *p;
125 }
127 
132 {
133  size_t len;
134  unsigned char unused_bits;
135  unsigned char *p;
136 }
138 
142 typedef struct mbedtls_asn1_sequence
143 {
146 }
148 
153 {
157  unsigned char next_merged;
158 }
160 
173 int mbedtls_asn1_get_len( unsigned char **p,
174  const unsigned char *end,
175  size_t *len );
176 
189 int mbedtls_asn1_get_tag( unsigned char **p,
190  const unsigned char *end,
191  size_t *len, int tag );
192 
203 int mbedtls_asn1_get_bool( unsigned char **p,
204  const unsigned char *end,
205  int *val );
206 
217 int mbedtls_asn1_get_int( unsigned char **p,
218  const unsigned char *end,
219  int *val );
220 
231 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
233 
245 int mbedtls_asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
246  size_t *len );
247 
259 int mbedtls_asn1_get_sequence_of( unsigned char **p,
260  const unsigned char *end,
262  int tag);
263 
264 #if defined(MBEDTLS_BIGNUM_C)
265 
275 int mbedtls_asn1_get_mpi( unsigned char **p,
276  const unsigned char *end,
277  mbedtls_mpi *X );
278 #endif /* MBEDTLS_BIGNUM_C */
279 
292 int mbedtls_asn1_get_alg( unsigned char **p,
293  const unsigned char *end,
294  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
295 
308 int mbedtls_asn1_get_alg_null( unsigned char **p,
309  const unsigned char *end,
310  mbedtls_asn1_buf *alg );
311 
323  const char *oid, size_t len );
324 
331 
339 
340 #ifdef __cplusplus
341 }
342 #endif
343 
344 #endif /* asn1.h */
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:134
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.
mbedtls_asn1_buf oid
The object identifier.
Definition: asn1.h:154
unsigned char next_merged
Merge next item into the current one?
Definition: asn1.h:157
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.
unsigned char * p
ASN1 data, e.g.
Definition: asn1.h:124
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:135
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.
mbedtls_asn1_buf buf
Buffer containing the given ASN.1 item.
Definition: asn1.h:144
int tag
ASN1 type, e.g.
Definition: asn1.h:122
Configuration options (set of defines)
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
Container for a sequence of ASN.1 items.
Definition: asn1.h:142
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.
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.
Multi-precision integer library.
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:152
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
Container for ASN1 bit strings.
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
Container for a sequence or list of 'named' ASN.1 data items.
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.
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:120
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.
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 " Updated the pointer to immediately behind the full seq...
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.
struct mbedtls_asn1_buf mbedtls_asn1_buf
Type-length-value structure that allows for ASN1 using DER.
mbedtls_asn1_buf val
The named value.
Definition: asn1.h:155
int mbedtls_asn1_get_bool(unsigned char **p, const unsigned char *end, int *val)
Retrieve a boolean ASN.1 tag and its value.
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
Container for a sequence of ASN.1 items.
int mbedtls_asn1_get_int(unsigned char **p, const unsigned char *end, int *val)
Retrieve an integer ASN.1 tag and its value.
Container for ASN1 bit strings.
Definition: asn1.h:131
size_t len
ASN1 length, in octets.
Definition: asn1.h:123
MPI structure.
Definition: bignum.h:146
int mbedtls_asn1_get_len(unsigned char **p, const unsigned char *end, size_t *len)
Get the length of an ASN.1 element.
struct mbedtls_asn1_named_data * next
The next entry in the sequence.
Definition: asn1.h:156
size_t len
ASN1 length, in octets.
Definition: asn1.h:133
struct mbedtls_asn1_sequence * next
The next entry in the sequence.
Definition: asn1.h:145