PolarSSL v1.3.7
asn1.h
Go to the documentation of this file.
1 
27 #ifndef POLARSSL_ASN1_H
28 #define POLARSSL_ASN1_H
29 
30 #if !defined(POLARSSL_CONFIG_FILE)
31 #include "config.h"
32 #else
33 #include POLARSSL_CONFIG_FILE
34 #endif
35 
36 #if defined(POLARSSL_BIGNUM_C)
37 #include "bignum.h"
38 #endif
39 
40 #include <string.h>
41 
54 #define POLARSSL_ERR_ASN1_OUT_OF_DATA -0x0060
55 #define POLARSSL_ERR_ASN1_UNEXPECTED_TAG -0x0062
56 #define POLARSSL_ERR_ASN1_INVALID_LENGTH -0x0064
57 #define POLARSSL_ERR_ASN1_LENGTH_MISMATCH -0x0066
58 #define POLARSSL_ERR_ASN1_INVALID_DATA -0x0068
59 #define POLARSSL_ERR_ASN1_MALLOC_FAILED -0x006A
60 #define POLARSSL_ERR_ASN1_BUF_TOO_SMALL -0x006C
62 /* \} name */
63 
75 #define ASN1_BOOLEAN 0x01
76 #define ASN1_INTEGER 0x02
77 #define ASN1_BIT_STRING 0x03
78 #define ASN1_OCTET_STRING 0x04
79 #define ASN1_NULL 0x05
80 #define ASN1_OID 0x06
81 #define ASN1_UTF8_STRING 0x0C
82 #define ASN1_SEQUENCE 0x10
83 #define ASN1_SET 0x11
84 #define ASN1_PRINTABLE_STRING 0x13
85 #define ASN1_T61_STRING 0x14
86 #define ASN1_IA5_STRING 0x16
87 #define ASN1_UTC_TIME 0x17
88 #define ASN1_GENERALIZED_TIME 0x18
89 #define ASN1_UNIVERSAL_STRING 0x1C
90 #define ASN1_BMP_STRING 0x1E
91 #define ASN1_PRIMITIVE 0x00
92 #define ASN1_CONSTRUCTED 0x20
93 #define ASN1_CONTEXT_SPECIFIC 0x80
94 /* \} name */
95 /* \} addtogroup asn1_module */
96 
98 #define OID_SIZE(x) (sizeof(x) - 1)
99 
104 #define OID_CMP(oid_str, oid_buf) \
105  ( ( 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 _asn1_buf
121 {
122  int tag;
123  size_t len;
124  unsigned char *p;
125 }
126 asn1_buf;
127 
131 typedef struct _asn1_bitstring
132 {
133  size_t len;
134  unsigned char unused_bits;
135  unsigned char *p;
136 }
138 
142 typedef struct _asn1_sequence
143 {
146 }
148 
152 typedef struct _asn1_named_data
153 {
157 }
159 
172 int asn1_get_len( unsigned char **p,
173  const unsigned char *end,
174  size_t *len );
175 
188 int asn1_get_tag( unsigned char **p,
189  const unsigned char *end,
190  size_t *len, int tag );
191 
202 int asn1_get_bool( unsigned char **p,
203  const unsigned char *end,
204  int *val );
205 
216 int asn1_get_int( unsigned char **p,
217  const unsigned char *end,
218  int *val );
219 
230 int asn1_get_bitstring( unsigned char **p, const unsigned char *end,
231  asn1_bitstring *bs);
232 
244 int asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
245  size_t *len );
246 
258 int asn1_get_sequence_of( unsigned char **p,
259  const unsigned char *end,
260  asn1_sequence *cur,
261  int tag);
262 
263 #if defined(POLARSSL_BIGNUM_C)
264 
274 int asn1_get_mpi( unsigned char **p,
275  const unsigned char *end,
276  mpi *X );
277 #endif /* POLARSSL_BIGNUM_C */
278 
291 int asn1_get_alg( unsigned char **p,
292  const unsigned char *end,
293  asn1_buf *alg, asn1_buf *params );
294 
307 int asn1_get_alg_null( unsigned char **p,
308  const unsigned char *end,
309  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 */
int asn1_get_sequence_of(unsigned char **p, const unsigned char *end, asn1_sequence *cur, int tag)
Parses and splits an ASN.1 &quot;SEQUENCE OF &lt;tag&gt;&quot; Updated the pointer to immediately behind the full seq...
asn1_buf buf
Buffer containing the given ASN.1 item.
Definition: asn1.h:144
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:133
Configuration options (set of defines)
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:134
MPI structure.
Definition: bignum.h:181
Container for ASN1 bit strings.
Definition: asn1.h:131
Multi-precision integer library.
asn1_buf val
The named value.
Definition: asn1.h:155
Container for a sequence of ASN.1 items.
Definition: asn1.h:142
struct _asn1_bitstring asn1_bitstring
Container for ASN1 bit strings.
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:135
asn1_buf oid
The object identifier.
Definition: asn1.h:154
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 &#39;named&#39; ASN.1 data items.
unsigned char * p
ASN1 data, e.g.
Definition: asn1.h:124
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:122
void asn1_free_named_data(asn1_named_data *entry)
Free a asn1_named_data entry.
Container for a sequence or list of &#39;named&#39; ASN.1 data items.
Definition: asn1.h:152
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:120
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:123
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:156
int asn1_get_mpi(unsigned char **p, const unsigned char *end, mpi *X)
Retrieve a MPI value from an integer ASN.1 tag.
struct _asn1_sequence * next
The next entry in the sequence.
Definition: asn1.h:145