PolarSSL v1.3.3
asn1.h
Go to the documentation of this file.
1 
27 #ifndef POLARSSL_ASN1_H
28 #define POLARSSL_ASN1_H
29 
30 #include "config.h"
31 
32 #if defined(POLARSSL_BIGNUM_C)
33 #include "bignum.h"
34 #endif
35 
36 #include <string.h>
37 
50 #define POLARSSL_ERR_ASN1_OUT_OF_DATA -0x0060
51 #define POLARSSL_ERR_ASN1_UNEXPECTED_TAG -0x0062
52 #define POLARSSL_ERR_ASN1_INVALID_LENGTH -0x0064
53 #define POLARSSL_ERR_ASN1_LENGTH_MISMATCH -0x0066
54 #define POLARSSL_ERR_ASN1_INVALID_DATA -0x0068
55 #define POLARSSL_ERR_ASN1_MALLOC_FAILED -0x006A
56 #define POLARSSL_ERR_ASN1_BUF_TOO_SMALL -0x006C
58 /* \} name */
59 
71 #define ASN1_BOOLEAN 0x01
72 #define ASN1_INTEGER 0x02
73 #define ASN1_BIT_STRING 0x03
74 #define ASN1_OCTET_STRING 0x04
75 #define ASN1_NULL 0x05
76 #define ASN1_OID 0x06
77 #define ASN1_UTF8_STRING 0x0C
78 #define ASN1_SEQUENCE 0x10
79 #define ASN1_SET 0x11
80 #define ASN1_PRINTABLE_STRING 0x13
81 #define ASN1_T61_STRING 0x14
82 #define ASN1_IA5_STRING 0x16
83 #define ASN1_UTC_TIME 0x17
84 #define ASN1_GENERALIZED_TIME 0x18
85 #define ASN1_UNIVERSAL_STRING 0x1C
86 #define ASN1_BMP_STRING 0x1E
87 #define ASN1_PRIMITIVE 0x00
88 #define ASN1_CONSTRUCTED 0x20
89 #define ASN1_CONTEXT_SPECIFIC 0x80
90 /* \} name */
91 /* \} addtogroup asn1_module */
92 
94 #define OID_SIZE(x) (sizeof(x) - 1)
95 
100 #define OID_CMP(oid_str, oid_buf) \
101  ( ( OID_SIZE(oid_str) == (oid_buf)->len ) && \
102  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) == 0 )
103 
104 #ifdef __cplusplus
105 extern "C" {
106 #endif
107 
116 typedef struct _asn1_buf
117 {
118  int tag;
119  size_t len;
120  unsigned char *p;
121 }
122 asn1_buf;
123 
127 typedef struct _asn1_bitstring
128 {
129  size_t len;
130  unsigned char unused_bits;
131  unsigned char *p;
132 }
134 
138 typedef struct _asn1_sequence
139 {
142 }
144 
148 typedef struct _asn1_named_data
149 {
153 }
155 
168 int asn1_get_len( unsigned char **p,
169  const unsigned char *end,
170  size_t *len );
171 
184 int asn1_get_tag( unsigned char **p,
185  const unsigned char *end,
186  size_t *len, int tag );
187 
198 int asn1_get_bool( unsigned char **p,
199  const unsigned char *end,
200  int *val );
201 
212 int asn1_get_int( unsigned char **p,
213  const unsigned char *end,
214  int *val );
215 
226 int asn1_get_bitstring( unsigned char **p, const unsigned char *end,
227  asn1_bitstring *bs);
228 
240 int asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
241  size_t *len );
242 
254 int asn1_get_sequence_of( unsigned char **p,
255  const unsigned char *end,
256  asn1_sequence *cur,
257  int tag);
258 
259 #if defined(POLARSSL_BIGNUM_C)
260 
270 int asn1_get_mpi( unsigned char **p,
271  const unsigned char *end,
272  mpi *X );
273 #endif
274 
287 int asn1_get_alg( unsigned char **p,
288  const unsigned char *end,
289  asn1_buf *alg, asn1_buf *params );
290 
303 int asn1_get_alg_null( unsigned char **p,
304  const unsigned char *end,
305  asn1_buf *alg );
306 
318  const char *oid, size_t len );
319 
326 
334 
335 #ifdef __cplusplus
336 }
337 #endif
338 
339 #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:140
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:129
Configuration options (set of defines)
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:130
MPI structure.
Definition: bignum.h:177
Container for ASN1 bit strings.
Definition: asn1.h:127
Multi-precision integer library.
asn1_buf val
The named value.
Definition: asn1.h:151
Container for a sequence of ASN.1 items.
Definition: asn1.h:138
struct _asn1_bitstring asn1_bitstring
Container for ASN1 bit strings.
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:131
asn1_buf oid
The object identifier.
Definition: asn1.h:150
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:120
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:118
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:148
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:116
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:119
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:152
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:141