Mbed TLS v3.6.1
asn1.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  */
10 #ifndef MBEDTLS_ASN1_H
11 #define MBEDTLS_ASN1_H
12 #include "mbedtls/private_access.h"
13 
14 #include "mbedtls/build_info.h"
15 #include "mbedtls/platform_util.h"
16 
17 #include <stddef.h>
18 
19 #if defined(MBEDTLS_BIGNUM_C)
20 #include "mbedtls/bignum.h"
21 #endif
22 
37 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
39 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
41 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
43 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
45 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
47 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
49 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
50 
64 #define MBEDTLS_ASN1_BOOLEAN 0x01
65 #define MBEDTLS_ASN1_INTEGER 0x02
66 #define MBEDTLS_ASN1_BIT_STRING 0x03
67 #define MBEDTLS_ASN1_OCTET_STRING 0x04
68 #define MBEDTLS_ASN1_NULL 0x05
69 #define MBEDTLS_ASN1_OID 0x06
70 #define MBEDTLS_ASN1_ENUMERATED 0x0A
71 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
72 #define MBEDTLS_ASN1_SEQUENCE 0x10
73 #define MBEDTLS_ASN1_SET 0x11
74 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
75 #define MBEDTLS_ASN1_T61_STRING 0x14
76 #define MBEDTLS_ASN1_IA5_STRING 0x16
77 #define MBEDTLS_ASN1_UTC_TIME 0x17
78 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
79 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
80 #define MBEDTLS_ASN1_BMP_STRING 0x1E
81 #define MBEDTLS_ASN1_PRIMITIVE 0x00
82 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
83 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
84 
85 /* Slightly smaller way to check if tag is a string tag
86  * compared to canonical implementation. */
87 #define MBEDTLS_ASN1_IS_STRING_TAG(tag) \
88  ((unsigned int) (tag) < 32u && ( \
89  ((1u << (tag)) & ((1u << MBEDTLS_ASN1_BMP_STRING) | \
90  (1u << MBEDTLS_ASN1_UTF8_STRING) | \
91  (1u << MBEDTLS_ASN1_T61_STRING) | \
92  (1u << MBEDTLS_ASN1_IA5_STRING) | \
93  (1u << MBEDTLS_ASN1_UNIVERSAL_STRING) | \
94  (1u << MBEDTLS_ASN1_PRINTABLE_STRING))) != 0))
95 
96 /*
97  * Bit masks for each of the components of an ASN.1 tag as specified in
98  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
99  * paragraph 8.1.2.2:
100  *
101  * Bit 8 7 6 5 1
102  * +-------+-----+------------+
103  * | Class | P/C | Tag number |
104  * +-------+-----+------------+
105  */
106 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
107 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
108 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
109 
113 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
114 
121 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
122  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
123  memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
124 
125 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
126  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
127  memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
128 
129 #ifdef __cplusplus
130 extern "C" {
131 #endif
132 
141 typedef struct mbedtls_asn1_buf {
142  int tag;
143  size_t len;
144  unsigned char *p;
145 }
147 
151 typedef struct mbedtls_asn1_bitstring {
152  size_t len;
153  unsigned char unused_bits;
154  unsigned char *p;
155 }
157 
161 typedef struct mbedtls_asn1_sequence {
172 }
174 
178 typedef struct mbedtls_asn1_named_data {
190 
196  unsigned char MBEDTLS_PRIVATE(next_merged);
197 }
199 
200 #if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_X509_CREATE_C) || \
201  defined(MBEDTLS_PSA_UTIL_HAVE_ECDSA)
220 int mbedtls_asn1_get_len(unsigned char **p,
221  const unsigned char *end,
222  size_t *len);
223 
245 int mbedtls_asn1_get_tag(unsigned char **p,
246  const unsigned char *end,
247  size_t *len, int tag);
248 #endif /* MBEDTLS_ASN1_PARSE_C || MBEDTLS_X509_CREATE_C || MBEDTLS_PSA_UTIL_HAVE_ECDSA */
249 
250 #if defined(MBEDTLS_ASN1_PARSE_C)
266 int mbedtls_asn1_get_bool(unsigned char **p,
267  const unsigned char *end,
268  int *val);
269 
287 int mbedtls_asn1_get_int(unsigned char **p,
288  const unsigned char *end,
289  int *val);
290 
308 int mbedtls_asn1_get_enum(unsigned char **p,
309  const unsigned char *end,
310  int *val);
311 
329 int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
331 
350 int mbedtls_asn1_get_bitstring_null(unsigned char **p,
351  const unsigned char *end,
352  size_t *len);
353 
401 int mbedtls_asn1_get_sequence_of(unsigned char **p,
402  const unsigned char *end,
404  int tag);
427 
514  unsigned char **p,
515  const unsigned char *end,
516  unsigned char tag_must_mask, unsigned char tag_must_val,
517  unsigned char tag_may_mask, unsigned char tag_may_val,
518  int (*cb)(void *ctx, int tag,
519  unsigned char *start, size_t len),
520  void *ctx);
521 
522 #if defined(MBEDTLS_BIGNUM_C)
541 int mbedtls_asn1_get_mpi(unsigned char **p,
542  const unsigned char *end,
543  mbedtls_mpi *X);
544 #endif /* MBEDTLS_BIGNUM_C */
545 
562 int mbedtls_asn1_get_alg(unsigned char **p,
563  const unsigned char *end,
564  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
565 
581 int mbedtls_asn1_get_alg_null(unsigned char **p,
582  const unsigned char *end,
583  mbedtls_asn1_buf *alg);
584 
596  const char *oid, size_t len);
597 
598 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
612 #endif /* MBEDTLS_DEPRECATED_REMOVED */
613 
623 
632 
636 #endif /* MBEDTLS_ASN1_PARSE_C */
637 
638 #ifdef __cplusplus
639 }
640 #endif
641 
642 #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:37
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
unsigned char unused_bits
Definition: asn1.h:153
unsigned char * p
Definition: asn1.h:154
size_t len
Definition: asn1.h:143
unsigned char * p
Definition: asn1.h:144
mbedtls_asn1_buf oid
Definition: asn1.h:179
struct mbedtls_asn1_named_data * next
Definition: asn1.h:189
mbedtls_asn1_buf val
Definition: asn1.h:180
mbedtls_asn1_buf buf
Definition: asn1.h:162
struct mbedtls_asn1_sequence * next
Definition: asn1.h:171
MPI structure.
Definition: bignum.h:207