mbed TLS v2.2.0
asn1.h
Go to the documentation of this file.
1 
23 #ifndef MBEDTLS_ASN1_H
24 #define MBEDTLS_ASN1_H
25 
26 #if !defined(MBEDTLS_CONFIG_FILE)
27 #include "config.h"
28 #else
29 #include MBEDTLS_CONFIG_FILE
30 #endif
31 
32 #include <stddef.h>
33 
34 #if defined(MBEDTLS_BIGNUM_C)
35 #include "bignum.h"
36 #endif
37 
50 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
51 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
52 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
53 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
54 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
55 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
56 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
58 /* \} name */
59 
71 #define MBEDTLS_ASN1_BOOLEAN 0x01
72 #define MBEDTLS_ASN1_INTEGER 0x02
73 #define MBEDTLS_ASN1_BIT_STRING 0x03
74 #define MBEDTLS_ASN1_OCTET_STRING 0x04
75 #define MBEDTLS_ASN1_NULL 0x05
76 #define MBEDTLS_ASN1_OID 0x06
77 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
78 #define MBEDTLS_ASN1_SEQUENCE 0x10
79 #define MBEDTLS_ASN1_SET 0x11
80 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
81 #define MBEDTLS_ASN1_T61_STRING 0x14
82 #define MBEDTLS_ASN1_IA5_STRING 0x16
83 #define MBEDTLS_ASN1_UTC_TIME 0x17
84 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
85 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
86 #define MBEDTLS_ASN1_BMP_STRING 0x1E
87 #define MBEDTLS_ASN1_PRIMITIVE 0x00
88 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
89 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
90 /* \} name */
91 /* \} addtogroup asn1_module */
92 
94 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
95 
102 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
103  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
104  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
105 
106 #ifdef __cplusplus
107 extern "C" {
108 #endif
109 
118 typedef struct mbedtls_asn1_buf
119 {
120  int tag;
121  size_t len;
122  unsigned char *p;
123 }
125 
130 {
131  size_t len;
132  unsigned char unused_bits;
133  unsigned char *p;
134 }
136 
140 typedef struct mbedtls_asn1_sequence
141 {
144 }
146 
151 {
155  unsigned char next_merged;
156 }
158 
171 int mbedtls_asn1_get_len( unsigned char **p,
172  const unsigned char *end,
173  size_t *len );
174 
187 int mbedtls_asn1_get_tag( unsigned char **p,
188  const unsigned char *end,
189  size_t *len, int tag );
190 
201 int mbedtls_asn1_get_bool( unsigned char **p,
202  const unsigned char *end,
203  int *val );
204 
215 int mbedtls_asn1_get_int( unsigned char **p,
216  const unsigned char *end,
217  int *val );
218 
229 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
231 
243 int mbedtls_asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
244  size_t *len );
245 
257 int mbedtls_asn1_get_sequence_of( unsigned char **p,
258  const unsigned char *end,
260  int tag);
261 
262 #if defined(MBEDTLS_BIGNUM_C)
263 
273 int mbedtls_asn1_get_mpi( unsigned char **p,
274  const unsigned char *end,
275  mbedtls_mpi *X );
276 #endif /* MBEDTLS_BIGNUM_C */
277 
290 int mbedtls_asn1_get_alg( unsigned char **p,
291  const unsigned char *end,
292  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
293 
306 int mbedtls_asn1_get_alg_null( unsigned char **p,
307  const unsigned char *end,
308  mbedtls_asn1_buf *alg );
309 
321  const char *oid, size_t len );
322 
329 
337 
338 #ifdef __cplusplus
339 }
340 #endif
341 
342 #endif /* asn1.h */
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:132
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:152
unsigned char next_merged
Merge next item into the current one?
Definition: asn1.h:155
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:122
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:133
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:142
int tag
ASN1 type, e.g.
Definition: asn1.h:120
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:140
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:150
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:118
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:153
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:129
size_t len
ASN1 length, in octets.
Definition: asn1.h:121
MPI structure.
Definition: bignum.h:143
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:154
size_t len
ASN1 length, in octets.
Definition: asn1.h:131
struct mbedtls_asn1_sequence * next
The next entry in the sequence.
Definition: asn1.h:143