mbed TLS v2.0.0
asn1.h
Go to the documentation of this file.
1 
24 #ifndef MBEDTLS_ASN1_H
25 #define MBEDTLS_ASN1_H
26 
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32 
33 #include <stddef.h>
34 
35 #if defined(MBEDTLS_BIGNUM_C)
36 #include "bignum.h"
37 #endif
38 
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
59 /* \} name */
60 
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_UTF8_STRING 0x0C
79 #define MBEDTLS_ASN1_SEQUENCE 0x10
80 #define MBEDTLS_ASN1_SET 0x11
81 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
82 #define MBEDTLS_ASN1_T61_STRING 0x14
83 #define MBEDTLS_ASN1_IA5_STRING 0x16
84 #define MBEDTLS_ASN1_UTC_TIME 0x17
85 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
86 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
87 #define MBEDTLS_ASN1_BMP_STRING 0x1E
88 #define MBEDTLS_ASN1_PRIMITIVE 0x00
89 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
90 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
91 /* \} name */
92 /* \} addtogroup asn1_module */
93 
95 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
96 
103 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
104  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
105  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
106 
107 #ifdef __cplusplus
108 extern "C" {
109 #endif
110 
119 typedef struct mbedtls_asn1_buf
120 {
121  int tag;
122  size_t len;
123  unsigned char *p;
124 }
126 
131 {
132  size_t len;
133  unsigned char unused_bits;
134  unsigned char *p;
135 }
137 
141 typedef struct mbedtls_asn1_sequence
142 {
145 }
147 
152 {
156  unsigned char next_merged;
157 }
159 
172 int mbedtls_asn1_get_len( unsigned char **p,
173  const unsigned char *end,
174  size_t *len );
175 
188 int mbedtls_asn1_get_tag( unsigned char **p,
189  const unsigned char *end,
190  size_t *len, int tag );
191 
202 int mbedtls_asn1_get_bool( unsigned char **p,
203  const unsigned char *end,
204  int *val );
205 
216 int mbedtls_asn1_get_int( unsigned char **p,
217  const unsigned char *end,
218  int *val );
219 
230 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
232 
244 int mbedtls_asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
245  size_t *len );
246 
258 int mbedtls_asn1_get_sequence_of( unsigned char **p,
259  const unsigned char *end,
261  int tag);
262 
263 #if defined(MBEDTLS_BIGNUM_C)
264 
274 int mbedtls_asn1_get_mpi( unsigned char **p,
275  const unsigned char *end,
276  mbedtls_mpi *X );
277 #endif /* MBEDTLS_BIGNUM_C */
278 
291 int mbedtls_asn1_get_alg( unsigned char **p,
292  const unsigned char *end,
293  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
294 
307 int mbedtls_asn1_get_alg_null( unsigned char **p,
308  const unsigned char *end,
309  mbedtls_asn1_buf *alg );
310 
322  const char *oid, size_t len );
323 
330 
338 
339 #ifdef __cplusplus
340 }
341 #endif
342 
343 #endif /* asn1.h */
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:133
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:153
unsigned char next_merged
Merge next item into the current one?
Definition: asn1.h:156
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:123
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:134
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:143
int tag
ASN1 type, e.g.
Definition: asn1.h:121
Compatibility names (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:141
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:151
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:119
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:154
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:130
size_t len
ASN1 length, in octets.
Definition: asn1.h:122
MPI structure.
Definition: bignum.h:144
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:155
size_t len
ASN1 length, in octets.
Definition: asn1.h:132
struct mbedtls_asn1_sequence * next
The next entry in the sequence.
Definition: asn1.h:144