mbed TLS v2.23.0
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 "mbedtls/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 "mbedtls/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_ENUMERATED 0x0A
79 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
80 #define MBEDTLS_ASN1_SEQUENCE 0x10
81 #define MBEDTLS_ASN1_SET 0x11
82 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
83 #define MBEDTLS_ASN1_T61_STRING 0x14
84 #define MBEDTLS_ASN1_IA5_STRING 0x16
85 #define MBEDTLS_ASN1_UTC_TIME 0x17
86 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
87 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
88 #define MBEDTLS_ASN1_BMP_STRING 0x1E
89 #define MBEDTLS_ASN1_PRIMITIVE 0x00
90 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
91 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
92 
93 /* Slightly smaller way to check if tag is a string tag
94  * compared to canonical implementation. */
95 #define MBEDTLS_ASN1_IS_STRING_TAG( tag ) \
96  ( ( tag ) < 32u && ( \
97  ( ( 1u << ( tag ) ) & ( ( 1u << MBEDTLS_ASN1_BMP_STRING ) | \
98  ( 1u << MBEDTLS_ASN1_UTF8_STRING ) | \
99  ( 1u << MBEDTLS_ASN1_T61_STRING ) | \
100  ( 1u << MBEDTLS_ASN1_IA5_STRING ) | \
101  ( 1u << MBEDTLS_ASN1_UNIVERSAL_STRING ) | \
102  ( 1u << MBEDTLS_ASN1_PRINTABLE_STRING ) | \
103  ( 1u << MBEDTLS_ASN1_BIT_STRING ) ) ) != 0 ) )
104 
105 /*
106  * Bit masks for each of the components of an ASN.1 tag as specified in
107  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
108  * paragraph 8.1.2.2:
109  *
110  * Bit 8 7 6 5 1
111  * +-------+-----+------------+
112  * | Class | P/C | Tag number |
113  * +-------+-----+------------+
114  */
115 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
116 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
117 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
118 
119 /* \} name */
120 /* \} addtogroup asn1_module */
121 
123 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
124 
131 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
132  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
133  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
134 
135 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
136  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len) ) || \
137  memcmp( (oid_str), (oid_buf), (oid_buf_len) ) != 0 )
138 
139 #ifdef __cplusplus
140 extern "C" {
141 #endif
142 
151 typedef struct mbedtls_asn1_buf
152 {
153  int tag;
154  size_t len;
155  unsigned char *p;
156 }
158 
163 {
164  size_t len;
165  unsigned char unused_bits;
166  unsigned char *p;
167 }
169 
173 typedef struct mbedtls_asn1_sequence
174 {
177 }
179 
184 {
188  unsigned char next_merged;
189 }
191 
210 int mbedtls_asn1_get_len( unsigned char **p,
211  const unsigned char *end,
212  size_t *len );
213 
235 int mbedtls_asn1_get_tag( unsigned char **p,
236  const unsigned char *end,
237  size_t *len, int tag );
238 
254 int mbedtls_asn1_get_bool( unsigned char **p,
255  const unsigned char *end,
256  int *val );
257 
275 int mbedtls_asn1_get_int( unsigned char **p,
276  const unsigned char *end,
277  int *val );
278 
296 int mbedtls_asn1_get_enum( unsigned char **p,
297  const unsigned char *end,
298  int *val );
299 
317 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
319 
338 int mbedtls_asn1_get_bitstring_null( unsigned char **p,
339  const unsigned char *end,
340  size_t *len );
341 
389 int mbedtls_asn1_get_sequence_of( unsigned char **p,
390  const unsigned char *end,
392  int tag );
415 
502  unsigned char **p,
503  const unsigned char *end,
504  unsigned char tag_must_mask, unsigned char tag_must_val,
505  unsigned char tag_may_mask, unsigned char tag_may_val,
506  int (*cb)( void *ctx, int tag,
507  unsigned char* start, size_t len ),
508  void *ctx );
509 
510 #if defined(MBEDTLS_BIGNUM_C)
511 
529 int mbedtls_asn1_get_mpi( unsigned char **p,
530  const unsigned char *end,
531  mbedtls_mpi *X );
532 #endif /* MBEDTLS_BIGNUM_C */
533 
550 int mbedtls_asn1_get_alg( unsigned char **p,
551  const unsigned char *end,
552  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
553 
569 int mbedtls_asn1_get_alg_null( unsigned char **p,
570  const unsigned char *end,
571  mbedtls_asn1_buf *alg );
572 
584  const char *oid, size_t len );
585 
594 
604 
605 #ifdef __cplusplus
606 }
607 #endif
608 
609 #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_buf
struct mbedtls_asn1_buf mbedtls_asn1_buf
mbedtls_asn1_bitstring::p
unsigned char * p
Definition: asn1.h:166
mbedtls_asn1_bitstring::unused_bits
unsigned char unused_bits
Definition: asn1.h:165
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:187
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:186
mbedtls_asn1_named_data
Definition: asn1.h:184
mbedtls_asn1_bitstring
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
mbedtls_asn1_named_data::next
struct mbedtls_asn1_named_data * next
Definition: asn1.h:187
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.
mbedtls_asn1_named_data
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
mbedtls_asn1_buf::len
size_t len
Definition: asn1.h:154
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.
mbedtls_asn1_traverse_sequence_of
int mbedtls_asn1_traverse_sequence_of(unsigned char **p, const unsigned char *end, unsigned char tag_must_mask, unsigned char tag_must_val, unsigned char tag_may_mask, unsigned char tag_may_val, int(*cb)(void *ctx, int tag, unsigned char *start, size_t len), void *ctx)
Traverse an ASN.1 SEQUENCE container and call a callback for each entry.
bignum.h
Multi-precision integer library.
mbedtls_asn1_bitstring::len
size_t len
Definition: asn1.h:164
mbedtls_asn1_sequence::buf
mbedtls_asn1_buf buf
Definition: asn1.h:175
mbedtls_asn1_sequence
Definition: asn1.h:174
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 element. Check for the requested tag. Updates the pointer to immediatel...
mbedtls_asn1_sequence::next
struct mbedtls_asn1_sequence * next
Definition: asn1.h:176
mbedtls_asn1_buf::p
unsigned char * p
Definition: asn1.h:155
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:163
mbedtls_asn1_named_data::next_merged
unsigned char next_merged
Definition: asn1.h:188
mbedtls_asn1_sequence
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
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:185
mbedtls_asn1_get_mpi
int mbedtls_asn1_get_mpi(unsigned char **p, const unsigned char *end, mbedtls_mpi *X)
Retrieve an integer ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
config.h
Configuration options (set of defines)
mbedtls_asn1_buf::tag
int tag
Definition: asn1.h:153
mbedtls_asn1_get_enum
int mbedtls_asn1_get_enum(unsigned char **p, const unsigned char *end, int *val)
Retrieve an enumerated ASN.1 tag and its value. Updates the pointer to immediately behind the full ta...
mbedtls_asn1_sequence_free
void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq)
Free a heap-allocated linked list presentation of an ASN.1 sequence, including the first element.
mbedtls_asn1_buf
Definition: asn1.h:152
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>". Updates the pointer to immediately behind the full se...