Mbed TLS v3.5.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 #include "mbedtls/private_access.h"
25 
26 #include "mbedtls/build_info.h"
27 #include "mbedtls/platform_util.h"
28 
29 #include <stddef.h>
30 
31 #if defined(MBEDTLS_BIGNUM_C)
32 #include "mbedtls/bignum.h"
33 #endif
34 
49 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
51 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
53 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
55 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
57 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
59 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
61 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
62 
76 #define MBEDTLS_ASN1_BOOLEAN 0x01
77 #define MBEDTLS_ASN1_INTEGER 0x02
78 #define MBEDTLS_ASN1_BIT_STRING 0x03
79 #define MBEDTLS_ASN1_OCTET_STRING 0x04
80 #define MBEDTLS_ASN1_NULL 0x05
81 #define MBEDTLS_ASN1_OID 0x06
82 #define MBEDTLS_ASN1_ENUMERATED 0x0A
83 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
84 #define MBEDTLS_ASN1_SEQUENCE 0x10
85 #define MBEDTLS_ASN1_SET 0x11
86 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
87 #define MBEDTLS_ASN1_T61_STRING 0x14
88 #define MBEDTLS_ASN1_IA5_STRING 0x16
89 #define MBEDTLS_ASN1_UTC_TIME 0x17
90 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
91 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
92 #define MBEDTLS_ASN1_BMP_STRING 0x1E
93 #define MBEDTLS_ASN1_PRIMITIVE 0x00
94 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
95 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
96 
97 /* Slightly smaller way to check if tag is a string tag
98  * compared to canonical implementation. */
99 #define MBEDTLS_ASN1_IS_STRING_TAG(tag) \
100  ((unsigned int) (tag) < 32u && ( \
101  ((1u << (tag)) & ((1u << MBEDTLS_ASN1_BMP_STRING) | \
102  (1u << MBEDTLS_ASN1_UTF8_STRING) | \
103  (1u << MBEDTLS_ASN1_T61_STRING) | \
104  (1u << MBEDTLS_ASN1_IA5_STRING) | \
105  (1u << MBEDTLS_ASN1_UNIVERSAL_STRING) | \
106  (1u << MBEDTLS_ASN1_PRINTABLE_STRING))) != 0))
107 
108 /*
109  * Bit masks for each of the components of an ASN.1 tag as specified in
110  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
111  * paragraph 8.1.2.2:
112  *
113  * Bit 8 7 6 5 1
114  * +-------+-----+------------+
115  * | Class | P/C | Tag number |
116  * +-------+-----+------------+
117  */
118 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
119 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
120 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
121 
125 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
126 
133 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
134  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
135  memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
136 
137 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
138  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
139  memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
140 
141 #ifdef __cplusplus
142 extern "C" {
143 #endif
144 
153 typedef struct mbedtls_asn1_buf {
154  int tag;
155  size_t len;
156  unsigned char *p;
157 }
159 
163 typedef struct mbedtls_asn1_bitstring {
164  size_t len;
165  unsigned char unused_bits;
166  unsigned char *p;
167 }
169 
173 typedef struct mbedtls_asn1_sequence {
184 }
186 
190 typedef struct mbedtls_asn1_named_data {
202 
208  unsigned char MBEDTLS_PRIVATE(next_merged);
209 }
211 
212 #if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_X509_CREATE_C)
231 int mbedtls_asn1_get_len(unsigned char **p,
232  const unsigned char *end,
233  size_t *len);
234 
256 int mbedtls_asn1_get_tag(unsigned char **p,
257  const unsigned char *end,
258  size_t *len, int tag);
259 #endif /* MBEDTLS_ASN1_PARSE_C || MBEDTLS_X509_CREATE_C */
260 
261 #if defined(MBEDTLS_ASN1_PARSE_C)
277 int mbedtls_asn1_get_bool(unsigned char **p,
278  const unsigned char *end,
279  int *val);
280 
298 int mbedtls_asn1_get_int(unsigned char **p,
299  const unsigned char *end,
300  int *val);
301 
319 int mbedtls_asn1_get_enum(unsigned char **p,
320  const unsigned char *end,
321  int *val);
322 
340 int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
342 
361 int mbedtls_asn1_get_bitstring_null(unsigned char **p,
362  const unsigned char *end,
363  size_t *len);
364 
412 int mbedtls_asn1_get_sequence_of(unsigned char **p,
413  const unsigned char *end,
415  int tag);
438 
525  unsigned char **p,
526  const unsigned char *end,
527  unsigned char tag_must_mask, unsigned char tag_must_val,
528  unsigned char tag_may_mask, unsigned char tag_may_val,
529  int (*cb)(void *ctx, int tag,
530  unsigned char *start, size_t len),
531  void *ctx);
532 
533 #if defined(MBEDTLS_BIGNUM_C)
552 int mbedtls_asn1_get_mpi(unsigned char **p,
553  const unsigned char *end,
554  mbedtls_mpi *X);
555 #endif /* MBEDTLS_BIGNUM_C */
556 
573 int mbedtls_asn1_get_alg(unsigned char **p,
574  const unsigned char *end,
575  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
576 
592 int mbedtls_asn1_get_alg_null(unsigned char **p,
593  const unsigned char *end,
594  mbedtls_asn1_buf *alg);
595 
607  const char *oid, size_t len);
608 
609 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
623 #endif /* MBEDTLS_DEPRECATED_REMOVED */
624 
634 
643 
647 #ifdef __cplusplus
648 }
649 #endif
650 
651 #endif /* MBEDTLS_ASN1_PARSE_C */
652 
653 #endif /* asn1.h */
Multi-precision integer library.
void MBEDTLS_DEPRECATED mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
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...
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.
const mbedtls_asn1_named_data * mbedtls_asn1_find_named_data(const 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 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
void mbedtls_asn1_free_named_data_list_shallow(mbedtls_asn1_named_data *name)
Free all shallow entries in a mbedtls_asn1_named_data list, but do not free internal pointer targets.
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.
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.
Build-time configuration info.
Common and shared functions used by multiple modules in the Mbed TLS library.
#define MBEDTLS_DEPRECATED
Definition: platform_util.h:45
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
unsigned char unused_bits
Definition: asn1.h:165
unsigned char * p
Definition: asn1.h:166
size_t len
Definition: asn1.h:155
unsigned char * p
Definition: asn1.h:156
mbedtls_asn1_buf oid
Definition: asn1.h:191
struct mbedtls_asn1_named_data * next
Definition: asn1.h:201
mbedtls_asn1_buf val
Definition: asn1.h:192
mbedtls_asn1_buf buf
Definition: asn1.h:174
struct mbedtls_asn1_sequence * next
Definition: asn1.h:183
MPI structure.
Definition: bignum.h:219