mbed TLS v2.28.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
50#define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
52#define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
54#define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
56#define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
58#define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
60#define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
62#define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
63
64/* \} name */
65
77#define MBEDTLS_ASN1_BOOLEAN 0x01
78#define MBEDTLS_ASN1_INTEGER 0x02
79#define MBEDTLS_ASN1_BIT_STRING 0x03
80#define MBEDTLS_ASN1_OCTET_STRING 0x04
81#define MBEDTLS_ASN1_NULL 0x05
82#define MBEDTLS_ASN1_OID 0x06
83#define MBEDTLS_ASN1_ENUMERATED 0x0A
84#define MBEDTLS_ASN1_UTF8_STRING 0x0C
85#define MBEDTLS_ASN1_SEQUENCE 0x10
86#define MBEDTLS_ASN1_SET 0x11
87#define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
88#define MBEDTLS_ASN1_T61_STRING 0x14
89#define MBEDTLS_ASN1_IA5_STRING 0x16
90#define MBEDTLS_ASN1_UTC_TIME 0x17
91#define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
92#define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
93#define MBEDTLS_ASN1_BMP_STRING 0x1E
94#define MBEDTLS_ASN1_PRIMITIVE 0x00
95#define MBEDTLS_ASN1_CONSTRUCTED 0x20
96#define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
97
98/* Slightly smaller way to check if tag is a string tag
99 * compared to canonical implementation. */
100#define MBEDTLS_ASN1_IS_STRING_TAG( tag ) \
101 ( ( tag ) < 32u && ( \
102 ( ( 1u << ( tag ) ) & ( ( 1u << MBEDTLS_ASN1_BMP_STRING ) | \
103 ( 1u << MBEDTLS_ASN1_UTF8_STRING ) | \
104 ( 1u << MBEDTLS_ASN1_T61_STRING ) | \
105 ( 1u << MBEDTLS_ASN1_IA5_STRING ) | \
106 ( 1u << MBEDTLS_ASN1_UNIVERSAL_STRING ) | \
107 ( 1u << MBEDTLS_ASN1_PRINTABLE_STRING ) | \
108 ( 1u << MBEDTLS_ASN1_BIT_STRING ) ) ) != 0 ) )
109
110/*
111 * Bit masks for each of the components of an ASN.1 tag as specified in
112 * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
113 * paragraph 8.1.2.2:
114 *
115 * Bit 8 7 6 5 1
116 * +-------+-----+------------+
117 * | Class | P/C | Tag number |
118 * +-------+-----+------------+
119 */
120#define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
121#define MBEDTLS_ASN1_TAG_PC_MASK 0x20
122#define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
123
124/* \} name */
125/* \} addtogroup asn1_module */
126
128#define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
129
136#define MBEDTLS_OID_CMP(oid_str, oid_buf) \
137 ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len ) || \
138 memcmp( (oid_str), (oid_buf)->p, (oid_buf)->len) != 0 )
139
140#define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
141 ( ( MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len) ) || \
142 memcmp( (oid_str), (oid_buf), (oid_buf_len) ) != 0 )
143
144#ifdef __cplusplus
145extern "C" {
146#endif
147
156typedef struct mbedtls_asn1_buf
157{
158 int tag;
159 size_t len;
160 unsigned char *p;
161}
163
168{
169 size_t len;
170 unsigned char unused_bits;
171 unsigned char *p;
172}
174
179{
182}
184
189{
193 unsigned char next_merged;
194}
196
215int mbedtls_asn1_get_len( unsigned char **p,
216 const unsigned char *end,
217 size_t *len );
218
240int mbedtls_asn1_get_tag( unsigned char **p,
241 const unsigned char *end,
242 size_t *len, int tag );
243
259int mbedtls_asn1_get_bool( unsigned char **p,
260 const unsigned char *end,
261 int *val );
262
280int mbedtls_asn1_get_int( unsigned char **p,
281 const unsigned char *end,
282 int *val );
283
301int mbedtls_asn1_get_enum( unsigned char **p,
302 const unsigned char *end,
303 int *val );
304
322int mbedtls_asn1_get_bitstring( unsigned char **p, const unsigned char *end,
324
343int mbedtls_asn1_get_bitstring_null( unsigned char **p,
344 const unsigned char *end,
345 size_t *len );
346
394int mbedtls_asn1_get_sequence_of( unsigned char **p,
395 const unsigned char *end,
397 int tag );
420
507 unsigned char **p,
508 const unsigned char *end,
509 unsigned char tag_must_mask, unsigned char tag_must_val,
510 unsigned char tag_may_mask, unsigned char tag_may_val,
511 int (*cb)( void *ctx, int tag,
512 unsigned char* start, size_t len ),
513 void *ctx );
514
515#if defined(MBEDTLS_BIGNUM_C)
534int mbedtls_asn1_get_mpi( unsigned char **p,
535 const unsigned char *end,
536 mbedtls_mpi *X );
537#endif /* MBEDTLS_BIGNUM_C */
538
555int mbedtls_asn1_get_alg( unsigned char **p,
556 const unsigned char *end,
557 mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params );
558
574int mbedtls_asn1_get_alg_null( unsigned char **p,
575 const unsigned char *end,
576 mbedtls_asn1_buf *alg );
577
589 const char *oid, size_t len );
590
599
609
610#ifdef __cplusplus
611}
612#endif
613
614#endif /* asn1.h */
Multi-precision integer library.
Configuration options (set of defines)
size_t len
Definition: asn1.h:159
mbedtls_asn1_buf oid
Definition: asn1.h:190
unsigned char * p
Definition: asn1.h:160
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:192
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 an integer ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
struct mbedtls_asn1_bitstring mbedtls_asn1_bitstring
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...
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
mbedtls_asn1_buf buf
Definition: asn1.h:180
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.
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.
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...
struct mbedtls_asn1_buf mbedtls_asn1_buf
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.
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:181
unsigned char unused_bits
Definition: asn1.h:170
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:191
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 element. Check for the requested tag. Updates the pointer to immediatel...
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:193
unsigned char * p
Definition: asn1.h:171
void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head)
Free all entries in a mbedtls_asn1_named_data list.
MPI structure.
Definition: bignum.h:193