mbed TLS v1.3.11
asn1.h
Go to the documentation of this file.
1 
24 #ifndef POLARSSL_ASN1_H
25 #define POLARSSL_ASN1_H
26 
27 #if !defined(POLARSSL_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include POLARSSL_CONFIG_FILE
31 #endif
32 
33 #include <stddef.h>
34 
35 #if defined(POLARSSL_BIGNUM_C)
36 #include "bignum.h"
37 #endif
38 
51 #define POLARSSL_ERR_ASN1_OUT_OF_DATA -0x0060
52 #define POLARSSL_ERR_ASN1_UNEXPECTED_TAG -0x0062
53 #define POLARSSL_ERR_ASN1_INVALID_LENGTH -0x0064
54 #define POLARSSL_ERR_ASN1_LENGTH_MISMATCH -0x0066
55 #define POLARSSL_ERR_ASN1_INVALID_DATA -0x0068
56 #define POLARSSL_ERR_ASN1_MALLOC_FAILED -0x006A
57 #define POLARSSL_ERR_ASN1_BUF_TOO_SMALL -0x006C
59 /* \} name */
60 
72 #define ASN1_BOOLEAN 0x01
73 #define ASN1_INTEGER 0x02
74 #define ASN1_BIT_STRING 0x03
75 #define ASN1_OCTET_STRING 0x04
76 #define ASN1_NULL 0x05
77 #define ASN1_OID 0x06
78 #define ASN1_UTF8_STRING 0x0C
79 #define ASN1_SEQUENCE 0x10
80 #define ASN1_SET 0x11
81 #define ASN1_PRINTABLE_STRING 0x13
82 #define ASN1_T61_STRING 0x14
83 #define ASN1_IA5_STRING 0x16
84 #define ASN1_UTC_TIME 0x17
85 #define ASN1_GENERALIZED_TIME 0x18
86 #define ASN1_UNIVERSAL_STRING 0x1C
87 #define ASN1_BMP_STRING 0x1E
88 #define ASN1_PRIMITIVE 0x00
89 #define ASN1_CONSTRUCTED 0x20
90 #define ASN1_CONTEXT_SPECIFIC 0x80
91 /* \} name */
92 /* \} addtogroup asn1_module */
93 
95 #define OID_SIZE(x) (sizeof(x) - 1)
96 
105 #define OID_CMP(oid_str, oid_buf) \
106  ( ( OID_SIZE(oid_str) == (oid_buf)->len ) && \
107  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) == 0 )
108 
109 #ifdef __cplusplus
110 extern "C" {
111 #endif
112 
121 typedef struct _asn1_buf
122 {
123  int tag;
124  size_t len;
125  unsigned char *p;
126 }
127 asn1_buf;
128 
132 typedef struct _asn1_bitstring
133 {
134  size_t len;
135  unsigned char unused_bits;
136  unsigned char *p;
137 }
139 
143 typedef struct _asn1_sequence
144 {
147 }
149 
153 typedef struct _asn1_named_data
154 {
158  unsigned char next_merged;
159 }
161 
174 int asn1_get_len( unsigned char **p,
175  const unsigned char *end,
176  size_t *len );
177 
190 int asn1_get_tag( unsigned char **p,
191  const unsigned char *end,
192  size_t *len, int tag );
193 
204 int asn1_get_bool( unsigned char **p,
205  const unsigned char *end,
206  int *val );
207 
218 int asn1_get_int( unsigned char **p,
219  const unsigned char *end,
220  int *val );
221 
232 int asn1_get_bitstring( unsigned char **p, const unsigned char *end,
233  asn1_bitstring *bs);
234 
246 int asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
247  size_t *len );
248 
260 int asn1_get_sequence_of( unsigned char **p,
261  const unsigned char *end,
262  asn1_sequence *cur,
263  int tag);
264 
265 #if defined(POLARSSL_BIGNUM_C)
266 
276 int asn1_get_mpi( unsigned char **p,
277  const unsigned char *end,
278  mpi *X );
279 #endif /* POLARSSL_BIGNUM_C */
280 
293 int asn1_get_alg( unsigned char **p,
294  const unsigned char *end,
295  asn1_buf *alg, asn1_buf *params );
296 
309 int asn1_get_alg_null( unsigned char **p,
310  const unsigned char *end,
311  asn1_buf *alg );
312 
324  const char *oid, size_t len );
325 
332 
340 
341 #ifdef __cplusplus
342 }
343 #endif
344 
345 #endif /* asn1.h */
int asn1_get_sequence_of(unsigned char **p, const unsigned char *end, asn1_sequence *cur, int tag)
Parses and splits an ASN.1 "SEQUENCE OF <tag>" Updated the pointer to immediately behind the full seq...
asn1_buf buf
Buffer containing the given ASN.1 item.
Definition: asn1.h:145
struct _asn1_sequence asn1_sequence
Container for a sequence of ASN.1 items.
int asn1_get_int(unsigned char **p, const unsigned char *end, int *val)
Retrieve an integer ASN.1 tag and its value.
size_t len
ASN1 length, e.g.
Definition: asn1.h:134
Configuration options (set of defines)
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:135
MPI structure.
Definition: bignum.h:182
Container for ASN1 bit strings.
Definition: asn1.h:132
Multi-precision integer library.
asn1_buf val
The named value.
Definition: asn1.h:156
Container for a sequence of ASN.1 items.
Definition: asn1.h:143
struct _asn1_bitstring asn1_bitstring
Container for ASN1 bit strings.
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:136
asn1_buf oid
The object identifier.
Definition: asn1.h:155
int asn1_get_alg_null(unsigned char **p, const unsigned char *end, asn1_buf *alg)
Retrieve an AlgorithmIdentifier ASN.1 sequence with NULL or no params.
int asn1_get_alg(unsigned char **p, const unsigned char *end, asn1_buf *alg, asn1_buf *params)
Retrieve an AlgorithmIdentifier ASN.1 sequence.
struct _asn1_named_data asn1_named_data
Container for a sequence or list of 'named' ASN.1 data items.
unsigned char * p
ASN1 data, e.g.
Definition: asn1.h:125
int asn1_get_bool(unsigned char **p, const unsigned char *end, int *val)
Retrieve a boolean ASN.1 tag and its value.
int tag
ASN1 type, e.g.
Definition: asn1.h:123
void asn1_free_named_data(asn1_named_data *entry)
Free a asn1_named_data entry.
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:153
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:121
int 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.
size_t len
ASN1 length, e.g.
Definition: asn1.h:124
void asn1_free_named_data_list(asn1_named_data **head)
Free all entries in a asn1_named_data list Head will be set to NULL.
struct _asn1_buf asn1_buf
Type-length-value structure that allows for ASN1 using DER.
int asn1_get_len(unsigned char **p, const unsigned char *end, size_t *len)
Get the length of an ASN.1 element.
int asn1_get_tag(unsigned char **p, const unsigned char *end, size_t *len, int tag)
Get the tag and length of the tag.
asn1_named_data * asn1_find_named_data(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 asn1_get_bitstring(unsigned char **p, const unsigned char *end, asn1_bitstring *bs)
Retrieve a bitstring ASN.1 tag and its value.
struct _asn1_named_data * next
The next entry in the sequence.
Definition: asn1.h:157
int asn1_get_mpi(unsigned char **p, const unsigned char *end, mpi *X)
Retrieve a MPI value from an integer ASN.1 tag.
unsigned char next_merged
Merge next item into the current one?
Definition: asn1.h:158
struct _asn1_sequence * next
The next entry in the sequence.
Definition: asn1.h:146