mbed TLS v2.28.3
Loading...
Searching...
No Matches
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
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
127#define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
128
135#define MBEDTLS_OID_CMP(oid_str, oid_buf) \
136 ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
137 memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
138
139#define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
140 ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
141 memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
142
143#ifdef __cplusplus
144extern "C" {
145#endif
146
155typedef struct mbedtls_asn1_buf {
156 int tag;
157 size_t len;
158 unsigned char *p;
159}
161
166 size_t len;
167 unsigned char unused_bits;
168 unsigned char *p;
169}
171
175typedef struct mbedtls_asn1_sequence {
178}
180
188 unsigned char next_merged;
189}
191
210int mbedtls_asn1_get_len(unsigned char **p,
211 const unsigned char *end,
212 size_t *len);
213
235int mbedtls_asn1_get_tag(unsigned char **p,
236 const unsigned char *end,
237 size_t *len, int tag);
238
254int mbedtls_asn1_get_bool(unsigned char **p,
255 const unsigned char *end,
256 int *val);
257
275int mbedtls_asn1_get_int(unsigned char **p,
276 const unsigned char *end,
277 int *val);
278
296int mbedtls_asn1_get_enum(unsigned char **p,
297 const unsigned char *end,
298 int *val);
299
317int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
319
339 const unsigned char *end,
340 size_t *len);
341
389int 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)
529int mbedtls_asn1_get_mpi(unsigned char **p,
530 const unsigned char *end,
531 mbedtls_mpi *X);
532#endif /* MBEDTLS_BIGNUM_C */
533
550int mbedtls_asn1_get_alg(unsigned char **p,
551 const unsigned char *end,
552 mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
553
569int 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
608#ifdef __cplusplus
609}
610#endif
611
612#endif /* asn1.h */
Multi-precision integer library.
Configuration options (set of defines)
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...
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.
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...
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...
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.
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.
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.
void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head)
Free all entries in a mbedtls_asn1_named_data list.
unsigned char unused_bits
Definition asn1.h:167
unsigned char * p
Definition asn1.h:168
size_t len
Definition asn1.h:157
unsigned char * p
Definition asn1.h:158
mbedtls_asn1_buf oid
Definition asn1.h:185
struct mbedtls_asn1_named_data * next
Definition asn1.h:187
mbedtls_asn1_buf val
Definition asn1.h:186
unsigned char next_merged
Definition asn1.h:188
mbedtls_asn1_buf buf
Definition asn1.h:176
struct mbedtls_asn1_sequence * next
Definition asn1.h:177
MPI structure.
Definition bignum.h:208