PolarSSL v1.3.9
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
108#define OID_CMP(oid_str, oid_buf) \
109 ( ( OID_SIZE(oid_str) == (oid_buf)->len ) && \
110 memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) == 0 )
111
112#ifdef __cplusplus
113extern "C" {
114#endif
115
124typedef struct _asn1_buf
125{
126 int tag;
127 size_t len;
128 unsigned char *p;
129}
131
135typedef struct _asn1_bitstring
136{
137 size_t len;
138 unsigned char unused_bits;
139 unsigned char *p;
140}
142
146typedef struct _asn1_sequence
147{
150}
152
156typedef struct _asn1_named_data
157{
161}
163
176int asn1_get_len( unsigned char **p,
177 const unsigned char *end,
178 size_t *len );
179
192int asn1_get_tag( unsigned char **p,
193 const unsigned char *end,
194 size_t *len, int tag );
195
206int asn1_get_bool( unsigned char **p,
207 const unsigned char *end,
208 int *val );
209
220int asn1_get_int( unsigned char **p,
221 const unsigned char *end,
222 int *val );
223
234int asn1_get_bitstring( unsigned char **p, const unsigned char *end,
235 asn1_bitstring *bs);
236
248int asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
249 size_t *len );
250
262int asn1_get_sequence_of( unsigned char **p,
263 const unsigned char *end,
264 asn1_sequence *cur,
265 int tag);
266
267#if defined(POLARSSL_BIGNUM_C)
278int asn1_get_mpi( unsigned char **p,
279 const unsigned char *end,
280 mpi *X );
281#endif /* POLARSSL_BIGNUM_C */
282
295int asn1_get_alg( unsigned char **p,
296 const unsigned char *end,
297 asn1_buf *alg, asn1_buf *params );
298
311int asn1_get_alg_null( unsigned char **p,
312 const unsigned char *end,
313 asn1_buf *alg );
314
326 const char *oid, size_t len );
327
334
342
343#ifdef __cplusplus
344}
345#endif
346
347#endif /* asn1.h */
Multi-precision integer library.
Configuration options (set of defines)
size_t len
ASN1 length, e.g.
Definition: asn1.h:137
int asn1_get_bool(unsigned char **p, const unsigned char *end, int *val)
Retrieve a boolean ASN.1 tag and its value.
asn1_buf buf
Buffer containing the given ASN.1 item.
Definition: asn1.h:148
int tag
ASN1 type, e.g.
Definition: asn1.h:126
struct _asn1_buf asn1_buf
Type-length-value structure that allows for ASN1 using DER.
struct _asn1_named_data asn1_named_data
Container for a sequence or list of 'named' ASN.1 data items.
size_t len
ASN1 length, e.g.
Definition: asn1.h:127
int asn1_get_alg(unsigned char **p, const unsigned char *end, asn1_buf *alg, asn1_buf *params)
Retrieve an AlgorithmIdentifier ASN.1 sequence.
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.
struct _asn1_sequence asn1_sequence
Container for a sequence of ASN.1 items.
void asn1_free_named_data(asn1_named_data *entry)
Free a asn1_named_data entry.
struct _asn1_named_data * next
The next entry in the sequence.
Definition: asn1.h:160
unsigned char unused_bits
Number of unused bits at the end of the string.
Definition: asn1.h:138
unsigned char * p
ASN1 data, e.g.
Definition: asn1.h:128
int asn1_get_bitstring(unsigned char **p, const unsigned char *end, asn1_bitstring *bs)
Retrieve a bitstring ASN.1 tag and its value.
int asn1_get_mpi(unsigned char **p, const unsigned char *end, mpi *X)
Retrieve a MPI value from an integer ASN.1 tag.
asn1_buf oid
The object identifier.
Definition: asn1.h:158
struct _asn1_bitstring asn1_bitstring
Container for ASN1 bit strings.
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.
unsigned char * p
Raw ASN1 data for the bit string.
Definition: asn1.h:139
int asn1_get_int(unsigned char **p, const unsigned char *end, int *val)
Retrieve an integer ASN.1 tag and its value.
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_len(unsigned char **p, const unsigned char *end, size_t *len)
Get the length of an ASN.1 element.
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.
asn1_buf val
The named value.
Definition: asn1.h:159
struct _asn1_sequence * next
The next entry in the sequence.
Definition: asn1.h:149
int asn1_get_tag(unsigned char **p, const unsigned char *end, size_t *len, int tag)
Get the tag and length of the tag.
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...
Container for ASN1 bit strings.
Definition: asn1.h:136
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:125
Container for a sequence or list of 'named' ASN.1 data items.
Definition: asn1.h:157
Container for a sequence of ASN.1 items.
Definition: asn1.h:147
MPI structure.
Definition: bignum.h:183