mbed TLS v2.16.3: asn1.h Source File

mbed TLS v2.16.3

asn1.h
Go to the documentation of this file.
1
6 /*
7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 *
22 * This file is part of mbed TLS (https://tls.mbed.org)
23 */
24 #ifndef MBEDTLS_ASN1_H
25 #define MBEDTLS_ASN1_H
26
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32
33 #include <stddef.h>
34
35 #if defined(MBEDTLS_BIGNUM_C)
36 #include "bignum.h"
37 #endif
38
51 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
52 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
53 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
54 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
55 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
56 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
57 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
59 /* \} name */
60
72 #define MBEDTLS_ASN1_BOOLEAN 0x01
73 #define MBEDTLS_ASN1_INTEGER 0x02
74 #define MBEDTLS_ASN1_BIT_STRING 0x03
75 #define MBEDTLS_ASN1_OCTET_STRING 0x04
76 #define MBEDTLS_ASN1_NULL 0x05
77 #define MBEDTLS_ASN1_OID 0x06
78 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
79 #define MBEDTLS_ASN1_SEQUENCE 0x10
80 #define MBEDTLS_ASN1_SET 0x11
81 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
82 #define MBEDTLS_ASN1_T61_STRING 0x14
83 #define MBEDTLS_ASN1_IA5_STRING 0x16
84 #define MBEDTLS_ASN1_UTC_TIME 0x17
85 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
86 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
87 #define MBEDTLS_ASN1_BMP_STRING 0x1E
88 #define MBEDTLS_ASN1_PRIMITIVE 0x00
89 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
90 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
91
92 /*
93 * Bit masks for each of the components of an ASN.1 tag as specified in
94 * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
95 * paragraph 8.1.2.2:
96 *
97 * Bit 8 7 6 5 1
98 * +-------+-----+------------+
99 * | Class | P/C | Tag number |
100 * +-------+-----+------------+
101 */
102 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
103 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
104 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
105
106 /* \} name */
107 /* \} addtogroup asn1_module */
108
110 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
111
118 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
119 ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
120 memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
121
122 #ifdef __cplusplus
123 extern "C" {
124 #endif
125
134 typedef struct mbedtls_asn1_buf
135 {
136 int tag;
137 size_t len;
138 unsigned char *p;
139 }
140 mbedtls_asn1_buf;
141
145 typedef struct mbedtls_asn1_bitstring
146 {
147 size_t len;
148 unsigned char unused_bits;
149 unsigned char *p;
150 }
151 mbedtls_asn1_bitstring;
152
156 typedef struct mbedtls_asn1_sequence
157 {
158 mbedtls_asn1_buf buf;
159 struct mbedtls_asn1_sequence *next;
160 }
161 mbedtls_asn1_sequence;
162
166 typedef struct mbedtls_asn1_named_data
167 {
168 mbedtls_asn1_buf oid;
169 mbedtls_asn1_buf val;
170 struct mbedtls_asn1_named_data *next;
171 unsigned char next_merged;
172 }
173 mbedtls_asn1_named_data;
174
187 int mbedtls_asn1_get_len( unsigned char **p,
188 const unsigned char *end,
189 size_t *len );
190
203 int mbedtls_asn1_get_tag( unsigned char **p,
204 const unsigned char *end,
205 size_t *len, int tag );
206
217 int mbedtls_asn1_get_bool( unsigned char **p,
218 const unsigned char *end,
219 int *val );
220
231 int mbedtls_asn1_get_int( unsigned char **p,
232 const unsigned char *end,
233 int *val );
234
245 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
246 mbedtls_asn1_bitstring *bs);
247
259 int mbedtls_asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
260 size_t *len );
261
273 int mbedtls_asn1_get_sequence_of( unsigned char **p,
274 const unsigned char *end,
275 mbedtls_asn1_sequence *cur,
276 int tag);
277
278 #if defined(MBEDTLS_BIGNUM_C)
279
289 int mbedtls_asn1_get_mpi( unsigned char **p,
290 const unsigned char *end,
291 mbedtls_mpi *X );
292 #endif /* MBEDTLS_BIGNUM_C */
293
306 int mbedtls_asn1_get_alg( unsigned char **p,
307 const unsigned char *end,
308 mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
309
322 int mbedtls_asn1_get_alg_null( unsigned char **p,
323 const unsigned char *end,
324 mbedtls_asn1_buf *alg );
325
336 mbedtls_asn1_named_data *mbedtls_asn1_find_named_data( mbedtls_asn1_named_data *list,
337 const char *oid, size_t len );
338
344 void mbedtls_asn1_free_named_data( mbedtls_asn1_named_data *entry );
345
352 void mbedtls_asn1_free_named_data_list( mbedtls_asn1_named_data **head );
353
354 #ifdef __cplusplus
355 }
356 #endif
357
358 #endif /* asn1.h */
mbedtls_asn1_get_bitstring_null
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. Updates the pointer to the beginnin...
mbedtls_asn1_named_data
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
mbedtls_asn1_bitstring::p
unsigned char * p
Definition: asn1.h:149
mbedtls_asn1_bitstring::unused_bits
unsigned char unused_bits
Definition: asn1.h:148
mbedtls_asn1_get_int
int mbedtls_asn1_get_int(unsigned char **p, const unsigned char *end, int *val)
Retrieve an integer ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
mbedtls_mpi
MPI structure.
Definition: bignum.h:185
mbedtls_asn1_find_named_data
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.
mbedtls_asn1_named_data::val
mbedtls_asn1_buf val
Definition: asn1.h:169
mbedtls_asn1_sequence
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
mbedtls_asn1_named_data
Definition: asn1.h:166
mbedtls_asn1_buf
struct mbedtls_asn1_buf mbedtls_asn1_buf
mbedtls_asn1_named_data::next
struct mbedtls_asn1_named_data * next
Definition: asn1.h:170
mbedtls_asn1_get_bitstring
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. Updates the pointer to immediately behind the full tag.
mbedtls_asn1_free_named_data
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
mbedtls_asn1_free_named_data_list
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.
mbedtls_asn1_buf::len
size_t len
Definition: asn1.h:137
mbedtls_asn1_get_len
int mbedtls_asn1_get_len(unsigned char **p, const unsigned char *end, size_t *len)
Get the length of an ASN.1 element. Updates the pointer to immediately behind the length.
bignum.h
Multi-precision integer library.
mbedtls_asn1_bitstring::len
size_t len
Definition: asn1.h:147
mbedtls_asn1_sequence::buf
mbedtls_asn1_buf buf
Definition: asn1.h:158
mbedtls_asn1_sequence
Definition: asn1.h:156
mbedtls_asn1_get_tag
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. Check for the requested tag. Updates the pointer to immediately be...
mbedtls_asn1_bitstring
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
mbedtls_asn1_sequence::next
struct mbedtls_asn1_sequence * next
Definition: asn1.h:159
mbedtls_asn1_buf::p
unsigned char * p
Definition: asn1.h:138
mbedtls_asn1_get_alg_null
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. Updates the pointer to immedia...
mbedtls_asn1_get_alg
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. Updates the pointer to immediately behind the full Al...
mbedtls_asn1_bitstring
Definition: asn1.h:145
mbedtls_asn1_named_data::next_merged
unsigned char next_merged
Definition: asn1.h:171
mbedtls_asn1_get_bool
int mbedtls_asn1_get_bool(unsigned char **p, const unsigned char *end, int *val)
Retrieve a boolean ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
mbedtls_asn1_named_data::oid
mbedtls_asn1_buf oid
Definition: asn1.h:168
mbedtls_asn1_get_mpi
int mbedtls_asn1_get_mpi(unsigned char **p, const unsigned char *end, mbedtls_mpi *X)
Retrieve a MPI value from an integer ASN.1 tag. Updates the pointer to immediately behind the full ta...
config.h
Configuration options (set of defines)
mbedtls_asn1_buf::tag
int tag
Definition: asn1.h:136
mbedtls_asn1_buf
Definition: asn1.h:134
mbedtls_asn1_get_sequence_of
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 <tag>" Updated the pointer to immediately behind the full seq...