mbed TLS v2.24.0
asn1.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
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 #ifndef MBEDTLS_ASN1_H
23 #define MBEDTLS_ASN1_H
24 
25 #if !defined(MBEDTLS_CONFIG_FILE)
26 #include "mbedtls/config.h"
27 #else
28 #include MBEDTLS_CONFIG_FILE
29 #endif
30 
31 #include <stddef.h>
32 
33 #if defined(MBEDTLS_BIGNUM_C)
34 #include "mbedtls/bignum.h"
35 #endif
36 
49 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
50 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
51 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
52 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
53 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
54 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
55 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
57 /* \} name */
58 
70 #define MBEDTLS_ASN1_BOOLEAN 0x01
71 #define MBEDTLS_ASN1_INTEGER 0x02
72 #define MBEDTLS_ASN1_BIT_STRING 0x03
73 #define MBEDTLS_ASN1_OCTET_STRING 0x04
74 #define MBEDTLS_ASN1_NULL 0x05
75 #define MBEDTLS_ASN1_OID 0x06
76 #define MBEDTLS_ASN1_ENUMERATED 0x0A
77 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
78 #define MBEDTLS_ASN1_SEQUENCE 0x10
79 #define MBEDTLS_ASN1_SET 0x11
80 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
81 #define MBEDTLS_ASN1_T61_STRING 0x14
82 #define MBEDTLS_ASN1_IA5_STRING 0x16
83 #define MBEDTLS_ASN1_UTC_TIME 0x17
84 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
85 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
86 #define MBEDTLS_ASN1_BMP_STRING 0x1E
87 #define MBEDTLS_ASN1_PRIMITIVE 0x00
88 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
89 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
90 
91 /* Slightly smaller way to check if tag is a string tag
92  * compared to canonical implementation. */
93 #define MBEDTLS_ASN1_IS_STRING_TAG( tag ) \
94  ( ( tag ) < 32u && ( \
95  ( ( 1u << ( tag ) ) & ( ( 1u << MBEDTLS_ASN1_BMP_STRING ) | \
96  ( 1u << MBEDTLS_ASN1_UTF8_STRING ) | \
97  ( 1u << MBEDTLS_ASN1_T61_STRING ) | \
98  ( 1u << MBEDTLS_ASN1_IA5_STRING ) | \
99  ( 1u << MBEDTLS_ASN1_UNIVERSAL_STRING ) | \
100  ( 1u << MBEDTLS_ASN1_PRINTABLE_STRING ) | \
101  ( 1u << MBEDTLS_ASN1_BIT_STRING ) ) ) != 0 ) )
102 
103 /*
104  * Bit masks for each of the components of an ASN.1 tag as specified in
105  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
106  * paragraph 8.1.2.2:
107  *
108  * Bit 8 7 6 5 1
109  * +-------+-----+------------+
110  * | Class | P/C | Tag number |
111  * +-------+-----+------------+
112  */
113 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
114 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
115 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
116 
117 /* \} name */
118 /* \} addtogroup asn1_module */
119 
121 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
122 
129 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
130  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
131  memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
132 
133 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
134  ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len) ) || \
135  memcmp( (oid_str), (oid_buf), (oid_buf_len) ) != 0 )
136 
137 #ifdef __cplusplus
138 extern "C" {
139 #endif
140 
149 typedef struct mbedtls_asn1_buf
150 {
151  int tag;
152  size_t len;
153  unsigned char *p;
154 }
156 
161 {
162  size_t len;
163  unsigned char unused_bits;
164  unsigned char *p;
165 }
167 
171 typedef struct mbedtls_asn1_sequence
172 {
175 }
177 
182 {
186  unsigned char next_merged;
187 }
189 
208 int mbedtls_asn1_get_len( unsigned char **p,
209  const unsigned char *end,
210  size_t *len );
211 
233 int mbedtls_asn1_get_tag( unsigned char **p,
234  const unsigned char *end,
235  size_t *len, int tag );
236 
252 int mbedtls_asn1_get_bool( unsigned char **p,
253  const unsigned char *end,
254  int *val );
255 
273 int mbedtls_asn1_get_int( unsigned char **p,
274  const unsigned char *end,
275  int *val );
276 
294 int mbedtls_asn1_get_enum( unsigned char **p,
295  const unsigned char *end,
296  int *val );
297 
315 int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
317 
336 int mbedtls_asn1_get_bitstring_null( unsigned char **p,
337  const unsigned char *end,
338  size_t *len );
339 
387 int mbedtls_asn1_get_sequence_of( unsigned char **p,
388  const unsigned char *end,
390  int tag );
413 
500  unsigned char **p,
501  const unsigned char *end,
502  unsigned char tag_must_mask, unsigned char tag_must_val,
503  unsigned char tag_may_mask, unsigned char tag_may_val,
504  int (*cb)( void *ctx, int tag,
505  unsigned char* start, size_t len ),
506  void *ctx );
507 
508 #if defined(MBEDTLS_BIGNUM_C)
509 
527 int mbedtls_asn1_get_mpi( unsigned char **p,
528  const unsigned char *end,
529  mbedtls_mpi *X );
530 #endif /* MBEDTLS_BIGNUM_C */
531 
548 int mbedtls_asn1_get_alg( unsigned char **p,
549  const unsigned char *end,
550  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
551 
567 int mbedtls_asn1_get_alg_null( unsigned char **p,
568  const unsigned char *end,
569  mbedtls_asn1_buf *alg );
570 
582  const char *oid, size_t len );
583 
592 
602 
603 #ifdef __cplusplus
604 }
605 #endif
606 
607 #endif /* asn1.h */
unsigned char unused_bits
Definition: asn1.h:163
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 oid
Definition: asn1.h:183
unsigned char next_merged
Definition: asn1.h:186
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...
unsigned char * p
Definition: asn1.h:153
unsigned char * p
Definition: asn1.h:164
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_buf buf
Definition: asn1.h:173
Configuration options (set of defines)
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
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.
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...
Multi-precision integer library.
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head)
Free all entries in a mbedtls_asn1_named_data list.
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...
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...
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...
struct mbedtls_asn1_buf mbedtls_asn1_buf
mbedtls_asn1_buf val
Definition: asn1.h:184
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...
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
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_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.
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...
size_t len
Definition: asn1.h:152
MPI structure.
Definition: bignum.h:184
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...
struct mbedtls_asn1_named_data * next
Definition: asn1.h:185
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...
struct mbedtls_asn1_sequence * next
Definition: asn1.h:174