mbed TLS v2.16.12
asn1.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_ASN1_H
50 #define MBEDTLS_ASN1_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include <stddef.h>
59 
60 #if defined(MBEDTLS_BIGNUM_C)
61 #include "bignum.h"
62 #endif
63 
77 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
79 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
81 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
83 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
85 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
87 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
89 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
90 
91 /* \} name */
92 
104 #define MBEDTLS_ASN1_BOOLEAN 0x01
105 #define MBEDTLS_ASN1_INTEGER 0x02
106 #define MBEDTLS_ASN1_BIT_STRING 0x03
107 #define MBEDTLS_ASN1_OCTET_STRING 0x04
108 #define MBEDTLS_ASN1_NULL 0x05
109 #define MBEDTLS_ASN1_OID 0x06
110 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
111 #define MBEDTLS_ASN1_SEQUENCE 0x10
112 #define MBEDTLS_ASN1_SET 0x11
113 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
114 #define MBEDTLS_ASN1_T61_STRING 0x14
115 #define MBEDTLS_ASN1_IA5_STRING 0x16
116 #define MBEDTLS_ASN1_UTC_TIME 0x17
117 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
118 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
119 #define MBEDTLS_ASN1_BMP_STRING 0x1E
120 #define MBEDTLS_ASN1_PRIMITIVE 0x00
121 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
122 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
123 
124 /*
125  * Bit masks for each of the components of an ASN.1 tag as specified in
126  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
127  * paragraph 8.1.2.2:
128  *
129  * Bit 8 7 6 5 1
130  * +-------+-----+------------+
131  * | Class | P/C | Tag number |
132  * +-------+-----+------------+
133  */
134 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
135 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
136 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
137 
138 /* \} name */
139 /* \} addtogroup asn1_module */
140 
142 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
143 
150 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
151  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
152  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
153 
154 #ifdef __cplusplus
155 extern "C" {
156 #endif
157 
166 typedef struct mbedtls_asn1_buf
167 {
168  int tag;
169  size_t len;
170  unsigned char *p;
171 }
173 
178 {
179  size_t len;
180  unsigned char unused_bits;
181  unsigned char *p;
182 }
184 
188 typedef struct mbedtls_asn1_sequence
189 {
192 }
194 
199 {
203  unsigned char next_merged;
204 }
206 
219 int mbedtls_asn1_get_len( unsigned char **p,
220  const unsigned char *end,
221  size_t *len );
222 
235 int mbedtls_asn1_get_tag( unsigned char **p,
236  const unsigned char *end,
237  size_t *len, int tag );
238 
249 int mbedtls_asn1_get_bool( unsigned char **p,
250  const unsigned char *end,
251  int *val );
252 
263 int mbedtls_asn1_get_int( unsigned char **p,
264  const unsigned char *end,
265  int *val );
266 
277 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
279 
291 int mbedtls_asn1_get_bitstring_null( unsigned char **p, const unsigned char *end,
292  size_t *len );
293 
305 int mbedtls_asn1_get_sequence_of( unsigned char **p,
306  const unsigned char *end,
308  int tag);
309 
310 #if defined(MBEDTLS_BIGNUM_C)
321 int mbedtls_asn1_get_mpi( unsigned char **p,
322  const unsigned char *end,
323  mbedtls_mpi *X );
324 #endif /* MBEDTLS_BIGNUM_C */
325 
338 int mbedtls_asn1_get_alg( unsigned char **p,
339  const unsigned char *end,
340  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
341 
354 int mbedtls_asn1_get_alg_null( unsigned char **p,
355  const unsigned char *end,
356  mbedtls_asn1_buf *alg );
357 
369  const char *oid, size_t len );
370 
377 
385 
386 #ifdef __cplusplus
387 }
388 #endif
389 
390 #endif /* asn1.h */
Multi-precision integer library.
Configuration options (set of defines)
size_t len
Definition: asn1.h:169
mbedtls_asn1_buf oid
Definition: asn1.h:200
unsigned char * p
Definition: asn1.h:170
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...
struct mbedtls_asn1_named_data * next
Definition: asn1.h:202
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
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...
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
mbedtls_asn1_buf buf
Definition: asn1.h:190
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.
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...
struct mbedtls_asn1_buf mbedtls_asn1_buf
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.
struct mbedtls_asn1_sequence * next
Definition: asn1.h:191
unsigned char unused_bits
Definition: asn1.h:180
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.
mbedtls_asn1_buf val
Definition: asn1.h:201
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...
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...
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.
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...
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.
unsigned char next_merged
Definition: asn1.h:203
unsigned char * p
Definition: asn1.h:181
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.
MPI structure.
Definition: bignum.h:219