Mbed TLS v2.28.7
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 
13 #if !defined(MBEDTLS_CONFIG_FILE)
14 #include "mbedtls/config.h"
15 #else
16 #include MBEDTLS_CONFIG_FILE
17 #endif
18 
19 #include <stddef.h>
20 
21 #if defined(MBEDTLS_BIGNUM_C)
22 #include "mbedtls/bignum.h"
23 #endif
24 
38 #define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
40 #define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
42 #define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
44 #define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
46 #define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
48 #define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
50 #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
51 
65 #define MBEDTLS_ASN1_BOOLEAN 0x01
66 #define MBEDTLS_ASN1_INTEGER 0x02
67 #define MBEDTLS_ASN1_BIT_STRING 0x03
68 #define MBEDTLS_ASN1_OCTET_STRING 0x04
69 #define MBEDTLS_ASN1_NULL 0x05
70 #define MBEDTLS_ASN1_OID 0x06
71 #define MBEDTLS_ASN1_ENUMERATED 0x0A
72 #define MBEDTLS_ASN1_UTF8_STRING 0x0C
73 #define MBEDTLS_ASN1_SEQUENCE 0x10
74 #define MBEDTLS_ASN1_SET 0x11
75 #define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
76 #define MBEDTLS_ASN1_T61_STRING 0x14
77 #define MBEDTLS_ASN1_IA5_STRING 0x16
78 #define MBEDTLS_ASN1_UTC_TIME 0x17
79 #define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
80 #define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
81 #define MBEDTLS_ASN1_BMP_STRING 0x1E
82 #define MBEDTLS_ASN1_PRIMITIVE 0x00
83 #define MBEDTLS_ASN1_CONSTRUCTED 0x20
84 #define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
85 
86 /* Slightly smaller way to check if tag is a string tag
87  * compared to canonical implementation. */
88 #define MBEDTLS_ASN1_IS_STRING_TAG(tag) \
89  ((tag) < 32u && ( \
90  ((1u << (tag)) & ((1u << MBEDTLS_ASN1_BMP_STRING) | \
91  (1u << MBEDTLS_ASN1_UTF8_STRING) | \
92  (1u << MBEDTLS_ASN1_T61_STRING) | \
93  (1u << MBEDTLS_ASN1_IA5_STRING) | \
94  (1u << MBEDTLS_ASN1_UNIVERSAL_STRING) | \
95  (1u << MBEDTLS_ASN1_PRINTABLE_STRING) | \
96  (1u << MBEDTLS_ASN1_BIT_STRING))) != 0))
97 
98 /*
99  * Bit masks for each of the components of an ASN.1 tag as specified in
100  * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
101  * paragraph 8.1.2.2:
102  *
103  * Bit 8 7 6 5 1
104  * +-------+-----+------------+
105  * | Class | P/C | Tag number |
106  * +-------+-----+------------+
107  */
108 #define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
109 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
110 #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
111 
115 #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
116 
123 #define MBEDTLS_OID_CMP(oid_str, oid_buf) \
124  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
125  memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
126 
127 #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
128  ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
129  memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
130 
131 #ifdef __cplusplus
132 extern "C" {
133 #endif
134 
143 typedef struct mbedtls_asn1_buf {
144  int tag;
145  size_t len;
146  unsigned char *p;
147 }
149 
153 typedef struct mbedtls_asn1_bitstring {
154  size_t len;
155  unsigned char unused_bits;
156  unsigned char *p;
157 }
159 
163 typedef struct mbedtls_asn1_sequence {
166 }
168 
172 typedef struct mbedtls_asn1_named_data {
176  unsigned char next_merged;
177 }
179 
198 int mbedtls_asn1_get_len(unsigned char **p,
199  const unsigned char *end,
200  size_t *len);
201 
223 int mbedtls_asn1_get_tag(unsigned char **p,
224  const unsigned char *end,
225  size_t *len, int tag);
226 
242 int mbedtls_asn1_get_bool(unsigned char **p,
243  const unsigned char *end,
244  int *val);
245 
263 int mbedtls_asn1_get_int(unsigned char **p,
264  const unsigned char *end,
265  int *val);
266 
284 int mbedtls_asn1_get_enum(unsigned char **p,
285  const unsigned char *end,
286  int *val);
287 
305 int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
307 
326 int mbedtls_asn1_get_bitstring_null(unsigned char **p,
327  const unsigned char *end,
328  size_t *len);
329 
377 int mbedtls_asn1_get_sequence_of(unsigned char **p,
378  const unsigned char *end,
380  int tag);
403 
490  unsigned char **p,
491  const unsigned char *end,
492  unsigned char tag_must_mask, unsigned char tag_must_val,
493  unsigned char tag_may_mask, unsigned char tag_may_val,
494  int (*cb)(void *ctx, int tag,
495  unsigned char *start, size_t len),
496  void *ctx);
497 
498 #if defined(MBEDTLS_BIGNUM_C)
517 int mbedtls_asn1_get_mpi(unsigned char **p,
518  const unsigned char *end,
519  mbedtls_mpi *X);
520 #endif /* MBEDTLS_BIGNUM_C */
521 
538 int mbedtls_asn1_get_alg(unsigned char **p,
539  const unsigned char *end,
540  mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
541 
557 int mbedtls_asn1_get_alg_null(unsigned char **p,
558  const unsigned char *end,
559  mbedtls_asn1_buf *alg);
560 
572  const char *oid, size_t len);
573 
582 
592 
596 #ifdef __cplusplus
597 }
598 #endif
599 
600 #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.
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
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.
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:155
unsigned char * p
Definition: asn1.h:156
size_t len
Definition: asn1.h:145
unsigned char * p
Definition: asn1.h:146
mbedtls_asn1_buf oid
Definition: asn1.h:173
struct mbedtls_asn1_named_data * next
Definition: asn1.h:175
mbedtls_asn1_buf val
Definition: asn1.h:174
unsigned char next_merged
Definition: asn1.h:176
mbedtls_asn1_buf buf
Definition: asn1.h:164
struct mbedtls_asn1_sequence * next
Definition: asn1.h:165
MPI structure.
Definition: bignum.h:196