mbed TLS v3.4.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
50 
51 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
52 
53 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
54 
55 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
56 
57 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
58 
59 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
60 
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  ((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) | \
107  (1u << MBEDTLS_ASN1_BIT_STRING))) != 0))
108 
109 /*
110  * Bit masks for each of the components of an ASN.1 tag as specified in
111  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
112  * paragraph 8.1.2.2:
113  *
114  * Bit 8 7 6 5 1
115  * +-------+-----+------------+
116  * | Class | P/C | Tag number |
117  * +-------+-----+------------+
118  */
119 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
120 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
121 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
122 
126 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
127 
134 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
135  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
136  memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
137 
138 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
139  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
140  memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
141 
142 #ifdef __cplusplus
143 extern "C" {
144 #endif
145 
154 typedef struct mbedtls_asn1_buf {
155  int tag;
156  size_t len;
157  unsigned char *p;
158 }
160 
164 typedef struct mbedtls_asn1_bitstring {
165  size_t len;
166  unsigned char unused_bits;
167  unsigned char *p;
168 }
170 
174 typedef struct mbedtls_asn1_sequence {
185 }
187 
191 typedef struct mbedtls_asn1_named_data {
203 
209  unsigned char MBEDTLS_PRIVATE(next_merged);
210 }
212 
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 
275 int mbedtls_asn1_get_bool(unsigned char **p,
276  const unsigned char *end,
277  int *val);
278 
296 int mbedtls_asn1_get_int(unsigned char **p,
297  const unsigned char *end,
298  int *val);
299 
317 int mbedtls_asn1_get_enum(unsigned char **p,
318  const unsigned char *end,
319  int *val);
320 
338 int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
340 
359 int mbedtls_asn1_get_bitstring_null(unsigned char **p,
360  const unsigned char *end,
361  size_t *len);
362 
410 int mbedtls_asn1_get_sequence_of(unsigned char **p,
411  const unsigned char *end,
413  int tag);
436 
523  unsigned char **p,
524  const unsigned char *end,
525  unsigned char tag_must_mask, unsigned char tag_must_val,
526  unsigned char tag_may_mask, unsigned char tag_may_val,
527  int (*cb)(void *ctx, int tag,
528  unsigned char *start, size_t len),
529  void *ctx);
530 
531 #if defined(MBEDTLS_BIGNUM_C)
532 
550 int mbedtls_asn1_get_mpi(unsigned char **p,
551  const unsigned char *end,
552  mbedtls_mpi *X);
553 #endif /* MBEDTLS_BIGNUM_C */
554 
571 int mbedtls_asn1_get_alg(unsigned char **p,
572  const unsigned char *end,
573  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
574 
590 int mbedtls_asn1_get_alg_null(unsigned char **p,
591  const unsigned char *end,
592  mbedtls_asn1_buf *alg);
593 
605  const char *oid, size_t len);
606 
607 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
608 
621 #endif /* MBEDTLS_DEPRECATED_REMOVED */
622 
632 
641 
645 #ifdef __cplusplus
646 }
647 #endif
648 
649 #endif /* asn1.h */
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:166
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_buf oid
Definition: asn1.h:192
unsigned char * p
Definition: asn1.h:157
unsigned char * p
Definition: asn1.h:167
mbedtls_asn1_buf buf
Definition: asn1.h:175
struct mbedtls_asn1_sequence mbedtls_asn1_sequence
#define MBEDTLS_PRIVATE(member)
struct mbedtls_asn1_buf mbedtls_asn1_buf
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.
Common and shared functions used by multiple modules in the Mbed TLS library.
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.
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_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_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...
Macro wrapper for struct's members.
mbedtls_asn1_buf val
Definition: asn1.h:193
void MBEDTLS_DEPRECATED mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
#define MBEDTLS_DEPRECATED
Definition: platform_util.h:53
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.
Build-time configuration info.
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_sequence_of(unsigned char **p, const unsigned char *end, mbedtls_asn1_sequence *cur, int tag)
Parses and splits an ASN.1 "SEQUENCE OF ". Updates the pointer to immediately behind the full se...
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...
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...
struct mbedtls_asn1_named_data mbedtls_asn1_named_data
size_t len
Definition: asn1.h:156
MPI structure.
Definition: bignum.h:205
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_named_data * next
Definition: asn1.h:202
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_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...
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_sequence * next
Definition: asn1.h:184