Mbed TLS v4.1.1
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 OR GPL-2.0-or-later
9 */
10#ifndef MBEDTLS_ASN1_H
11#define MBEDTLS_ASN1_H
12#include "mbedtls/private_access.h"
13
17
18#include <stddef.h>
19
20#if defined(MBEDTLS_BIGNUM_C)
21#include "mbedtls/private/bignum.h"
22#endif
23
28
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
47
49
60#define MBEDTLS_ASN1_BOOLEAN 0x01
61#define MBEDTLS_ASN1_INTEGER 0x02
62#define MBEDTLS_ASN1_BIT_STRING 0x03
63#define MBEDTLS_ASN1_OCTET_STRING 0x04
64#define MBEDTLS_ASN1_NULL 0x05
65#define MBEDTLS_ASN1_OID 0x06
66#define MBEDTLS_ASN1_ENUMERATED 0x0A
67#define MBEDTLS_ASN1_UTF8_STRING 0x0C
68#define MBEDTLS_ASN1_SEQUENCE 0x10
69#define MBEDTLS_ASN1_SET 0x11
70#define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
71#define MBEDTLS_ASN1_T61_STRING 0x14
72#define MBEDTLS_ASN1_IA5_STRING 0x16
73#define MBEDTLS_ASN1_UTC_TIME 0x17
74#define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
75#define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
76#define MBEDTLS_ASN1_BMP_STRING 0x1E
77#define MBEDTLS_ASN1_PRIMITIVE 0x00
78#define MBEDTLS_ASN1_CONSTRUCTED 0x20
79#define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
80
81/* Slightly smaller way to check if tag is a string tag
82 * compared to canonical implementation. */
83#define MBEDTLS_ASN1_IS_STRING_TAG(tag) \
84 ((unsigned int) (tag) < 32u && ( \
85 ((1u << (tag)) & ((1u << MBEDTLS_ASN1_BMP_STRING) | \
86 (1u << MBEDTLS_ASN1_UTF8_STRING) | \
87 (1u << MBEDTLS_ASN1_T61_STRING) | \
88 (1u << MBEDTLS_ASN1_IA5_STRING) | \
89 (1u << MBEDTLS_ASN1_UNIVERSAL_STRING) | \
90 (1u << MBEDTLS_ASN1_PRINTABLE_STRING))) != 0))
91
92/*
93 * Bit masks for each of the components of an ASN.1 tag as specified in
94 * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
95 * paragraph 8.1.2.2:
96 *
97 * Bit 8 7 6 5 1
98 * +-------+-----+------------+
99 * | Class | P/C | Tag number |
100 * +-------+-----+------------+
101 */
102#define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
103#define MBEDTLS_ASN1_TAG_PC_MASK 0x20
104#define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
105
107
109#define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
110
117#define MBEDTLS_OID_CMP(oid_str, oid_buf) \
118 ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
119 memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
120
121#define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
122 ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
123 memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
124
125#ifdef __cplusplus
126extern "C" {
127#endif
128
133
137typedef struct mbedtls_asn1_buf {
138 int tag;
139 size_t len;
140 unsigned char *p;
141}
143
148 size_t len;
149 unsigned char unused_bits;
150 unsigned char *p;
151}
153
170
177
186
192 unsigned char MBEDTLS_PRIVATE(next_merged);
193}
195
196#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C) || \
197 defined(PSA_HAVE_ALG_SOME_ECDSA)
216int mbedtls_asn1_get_len(unsigned char **p,
217 const unsigned char *end,
218 size_t *len);
219
241int mbedtls_asn1_get_tag(unsigned char **p,
242 const unsigned char *end,
243 size_t *len, int tag);
244#endif /* MBEDTLS_ASN1_PARSE_C || MBEDTLS_ASN1_WRITE_C || PSA_HAVE_ALG_SOME_ECDSA */
245
246#if defined(MBEDTLS_ASN1_PARSE_C)
262int mbedtls_asn1_get_bool(unsigned char **p,
263 const unsigned char *end,
264 int *val);
265
283int mbedtls_asn1_get_int(unsigned char **p,
284 const unsigned char *end,
285 int *val);
286
308
309int mbedtls_asn1_get_integer(unsigned char **p, const unsigned char *end,
310 unsigned char **head, size_t *length);
328int mbedtls_asn1_get_enum(unsigned char **p,
329 const unsigned char *end,
330 int *val);
331
349int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
351
371 const unsigned char *end,
372 size_t *len);
373
421int mbedtls_asn1_get_sequence_of(unsigned char **p,
422 const unsigned char *end,
424 int tag);
447
534 unsigned char **p,
535 const unsigned char *end,
536 unsigned char tag_must_mask, unsigned char tag_must_val,
537 unsigned char tag_may_mask, unsigned char tag_may_val,
538 int (*cb)(void *ctx, int tag,
539 unsigned char *start, size_t len),
540 void *ctx);
541
542
559int mbedtls_asn1_get_alg(unsigned char **p,
560 const unsigned char *end,
561 mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
562
578int mbedtls_asn1_get_alg_null(unsigned char **p,
579 const unsigned char *end,
580 mbedtls_asn1_buf *alg);
581
593 const char *oid, size_t len);
594
604
613
616
617#endif /* MBEDTLS_ASN1_PARSE_C */
618
619#ifdef __cplusplus
620}
621#endif
622
623#endif /* MBEDTLS_ASN1_H */
Compatibility definitions for MbedTLS 3.x code built with MbedTLS 4.x or TF-PSA-Crypto 1....
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_integer(unsigned char **p, const unsigned char *end, unsigned char **head, size_t *length)
Parse an INTEGER in DER representation and return a pointer to its big-endian representation and leng...
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...
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...
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.
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.
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.
Common and shared functions used by multiple modules in the Mbed TLS library.
unsigned char unused_bits
Definition asn1.h:149
unsigned char * p
Definition asn1.h:150
size_t len
Definition asn1.h:139
unsigned char * p
Definition asn1.h:140
mbedtls_asn1_buf oid
Definition asn1.h:175
struct mbedtls_asn1_named_data * next
Definition asn1.h:185
mbedtls_asn1_buf val
Definition asn1.h:176
mbedtls_asn1_buf buf
Definition asn1.h:158
struct mbedtls_asn1_sequence * next
Definition asn1.h:167
Build-time configuration info.