blob: 540cdcc469472dfcba38ea1abfe51d09b05561c2 [file] [log] [blame]
Paul Bakkerefc30292011-11-10 14:43:23 +00001/**
2 * \file asn1.h
3 *
4 * \brief Generic ASN.1 parsing
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * 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.
Paul Bakkerefc30292011-11-10 14:43:23 +000021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_ASN1_H
23#define MBEDTLS_ASN1_H
Paul Bakkerefc30292011-11-10 14:43:23 +000024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010026#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020027#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020028#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#endif
Paul Bakkerefc30292011-11-10 14:43:23 +000030
Rich Evans00ab4702015-02-06 13:43:58 +000031#include <stddef.h>
32
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#if defined(MBEDTLS_BIGNUM_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010034#include "mbedtls/bignum.h"
Paul Bakkerefc30292011-11-10 14:43:23 +000035#endif
36
Paul Bakker9af723c2014-05-01 13:03:14 +020037/**
Paul Bakkerefc30292011-11-10 14:43:23 +000038 * \addtogroup asn1_module
Paul Bakker9af723c2014-05-01 13:03:14 +020039 * \{
Paul Bakkerefc30292011-11-10 14:43:23 +000040 */
Paul Bakker9af723c2014-05-01 13:03:14 +020041
Paul Bakkerefc30292011-11-10 14:43:23 +000042/**
43 * \name ASN1 Error codes
44 * These error codes are OR'ed to X509 error codes for
Paul Bakker9af723c2014-05-01 13:03:14 +020045 * higher error granularity.
Paul Bakkerefc30292011-11-10 14:43:23 +000046 * ASN1 is a standard to specify data structures.
47 * \{
48 */
Gilles Peskinea3974432021-07-26 18:48:10 +020049/** Out of data when parsing an ASN1 data structure. */
50#define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
51/** ASN1 tag was of an unexpected value. */
52#define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
53/** Error when trying to determine the length or invalid length. */
54#define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
55/** Actual length differs from expected length. */
56#define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
57/** Data is invalid. */
58#define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
59/** Memory allocation failed */
60#define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
61/** Buffer too small when writing ASN.1 data structure. */
62#define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
Paul Bakker05888152012-02-16 10:26:57 +000063
Andrzej Kurek73afe272022-01-24 10:31:06 -050064/** \} name ASN1 Error codes */
Paul Bakkerefc30292011-11-10 14:43:23 +000065
66/**
67 * \name DER constants
Andres Amaya Garcia9fb02052017-08-25 17:24:44 +010068 * These constants comply with the DER encoded ASN.1 type tags.
Paul Bakkerefc30292011-11-10 14:43:23 +000069 * DER encoding uses hexadecimal representation.
70 * An example DER sequence is:\n
71 * - 0x02 -- tag indicating INTEGER
72 * - 0x01 -- length in octets
73 * - 0x05 -- value
Gilles Peskine96ddb0a2020-02-26 19:50:01 +010074 * Such sequences are typically read into \c ::mbedtls_x509_buf.
Paul Bakkerefc30292011-11-10 14:43:23 +000075 * \{
76 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077#define MBEDTLS_ASN1_BOOLEAN 0x01
78#define MBEDTLS_ASN1_INTEGER 0x02
79#define MBEDTLS_ASN1_BIT_STRING 0x03
80#define MBEDTLS_ASN1_OCTET_STRING 0x04
81#define MBEDTLS_ASN1_NULL 0x05
82#define MBEDTLS_ASN1_OID 0x06
Mykhailo Sopiha20180ca2019-10-29 15:58:10 +020083#define MBEDTLS_ASN1_ENUMERATED 0x0A
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084#define MBEDTLS_ASN1_UTF8_STRING 0x0C
85#define MBEDTLS_ASN1_SEQUENCE 0x10
86#define MBEDTLS_ASN1_SET 0x11
87#define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
88#define MBEDTLS_ASN1_T61_STRING 0x14
89#define MBEDTLS_ASN1_IA5_STRING 0x16
90#define MBEDTLS_ASN1_UTC_TIME 0x17
91#define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
92#define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
93#define MBEDTLS_ASN1_BMP_STRING 0x1E
94#define MBEDTLS_ASN1_PRIMITIVE 0x00
95#define MBEDTLS_ASN1_CONSTRUCTED 0x20
96#define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
Andres Amaya Garcia7512bf72017-08-25 17:12:11 +010097
Hanno Beckercba71222019-09-11 14:15:10 +010098/* Slightly smaller way to check if tag is a string tag
99 * compared to canonical implementation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100100#define MBEDTLS_ASN1_IS_STRING_TAG(tag) \
101 ((tag) < 32u && ( \
102 ((1u << (tag)) & ((1u << MBEDTLS_ASN1_BMP_STRING) | \
103 (1u << MBEDTLS_ASN1_UTF8_STRING) | \
104 (1u << MBEDTLS_ASN1_T61_STRING) | \
105 (1u << MBEDTLS_ASN1_IA5_STRING) | \
106 (1u << MBEDTLS_ASN1_UNIVERSAL_STRING) | \
107 (1u << MBEDTLS_ASN1_PRINTABLE_STRING) | \
108 (1u << MBEDTLS_ASN1_BIT_STRING))) != 0))
Hanno Beckercba71222019-09-11 14:15:10 +0100109
Andres Amaya Garcia7512bf72017-08-25 17:12:11 +0100110/*
111 * Bit masks for each of the components of an ASN.1 tag as specified in
Gilles Peskine1ed45ea2018-03-08 18:16:45 +0100112 * ITU X.690 (08/2015), section 8.1 "General rules for encoding",
113 * paragraph 8.1.2.2:
Andres Amaya Garcia7512bf72017-08-25 17:12:11 +0100114 *
115 * Bit 8 7 6 5 1
116 * +-------+-----+------------+
117 * | Class | P/C | Tag number |
118 * +-------+-----+------------+
119 */
Andres Amaya Garcia7786abc2017-11-07 20:21:56 +0000120#define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
121#define MBEDTLS_ASN1_TAG_PC_MASK 0x20
122#define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
Andres Amaya Garcia7512bf72017-08-25 17:12:11 +0100123
Andrzej Kurek73afe272022-01-24 10:31:06 -0500124/** \} name DER constants */
Paul Bakkerefc30292011-11-10 14:43:23 +0000125
126/** Returns the size of the binary string, without the trailing \\0 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200127#define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
Paul Bakkerefc30292011-11-10 14:43:23 +0000128
Manuel Pégourié-Gonnarde76b7502014-01-23 19:15:29 +0100129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130 * Compares an mbedtls_asn1_buf structure to a reference OID.
Manuel Pégourié-Gonnarde76b7502014-01-23 19:15:29 +0100131 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132 * Only works for 'defined' oid_str values (MBEDTLS_OID_HMAC_SHA1), you cannot use a
Manuel Pégourié-Gonnarde76b7502014-01-23 19:15:29 +0100133 * 'unsigned char *oid' here!
Paul Bakkere5eae762013-08-26 12:05:14 +0200134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135#define MBEDTLS_OID_CMP(oid_str, oid_buf) \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100136 ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
137 memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200138
Hanno Becker63e38fe2019-09-11 14:16:40 +0100139#define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100140 ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
141 memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
Hanno Becker63e38fe2019-09-11 14:16:40 +0100142
Paul Bakkerefc30292011-11-10 14:43:23 +0000143#ifdef __cplusplus
144extern "C" {
145#endif
146
147/**
148 * \name Functions to parse ASN.1 data structures
149 * \{
150 */
151
152/**
153 * Type-length-value structure that allows for ASN1 using DER.
154 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100155typedef struct mbedtls_asn1_buf {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156 int tag; /**< ASN1 type, e.g. MBEDTLS_ASN1_UTF8_STRING. */
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200157 size_t len; /**< ASN1 length, in octets. */
Paul Bakkerefc30292011-11-10 14:43:23 +0000158 unsigned char *p; /**< ASN1 data, e.g. in ASCII. */
159}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160mbedtls_asn1_buf;
Paul Bakkerefc30292011-11-10 14:43:23 +0000161
162/**
163 * Container for ASN1 bit strings.
164 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100165typedef struct mbedtls_asn1_bitstring {
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200166 size_t len; /**< ASN1 length, in octets. */
Paul Bakkerefc30292011-11-10 14:43:23 +0000167 unsigned char unused_bits; /**< Number of unused bits at the end of the string */
168 unsigned char *p; /**< Raw ASN1 data for the bit string */
169}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170mbedtls_asn1_bitstring;
Paul Bakkerefc30292011-11-10 14:43:23 +0000171
172/**
173 * Container for a sequence of ASN.1 items
174 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100175typedef struct mbedtls_asn1_sequence {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 mbedtls_asn1_buf buf; /**< Buffer containing the given ASN.1 item. */
177 struct mbedtls_asn1_sequence *next; /**< The next entry in the sequence. */
Paul Bakkerefc30292011-11-10 14:43:23 +0000178}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179mbedtls_asn1_sequence;
Paul Bakkerefc30292011-11-10 14:43:23 +0000180
181/**
Paul Bakkere5eae762013-08-26 12:05:14 +0200182 * Container for a sequence or list of 'named' ASN.1 data items
183 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100184typedef struct mbedtls_asn1_named_data {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200185 mbedtls_asn1_buf oid; /**< The object identifier. */
186 mbedtls_asn1_buf val; /**< The named value. */
187 struct mbedtls_asn1_named_data *next; /**< The next entry in the sequence. */
Manuel Pégourié-Gonnard555fbf82015-02-04 17:11:55 +0000188 unsigned char next_merged; /**< Merge next item into the current one? */
Paul Bakkere5eae762013-08-26 12:05:14 +0200189}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190mbedtls_asn1_named_data;
Paul Bakkere5eae762013-08-26 12:05:14 +0200191
192/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200193 * \brief Get the length of an ASN.1 element.
194 * Updates the pointer to immediately behind the length.
Paul Bakkerefc30292011-11-10 14:43:23 +0000195 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100196 * \param p On entry, \c *p points to the first byte of the length,
197 * i.e. immediately after the tag.
198 * On successful completion, \c *p points to the first byte
199 * after the length, i.e. the first byte of the content.
200 * On error, the value of \c *p is undefined.
201 * \param end End of data.
Gilles Peskinedc2db482019-09-20 21:06:01 +0200202 * \param len On successful completion, \c *len contains the length
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100203 * read from the ASN.1 input.
Paul Bakkerefc30292011-11-10 14:43:23 +0000204 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100205 * \return 0 if successful.
206 * \return #MBEDTLS_ERR_ASN1_OUT_OF_DATA if the ASN.1 element
207 * would end beyond \p end.
Andrzej Kurek293e4522022-04-13 14:28:52 -0400208 * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the length is unparsable.
Paul Bakkerefc30292011-11-10 14:43:23 +0000209 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100210int mbedtls_asn1_get_len(unsigned char **p,
211 const unsigned char *end,
212 size_t *len);
Paul Bakkerefc30292011-11-10 14:43:23 +0000213
214/**
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100215 * \brief Get the tag and length of the element.
216 * Check for the requested tag.
Paul Bakkercdda0972013-09-09 12:51:29 +0200217 * Updates the pointer to immediately behind the tag and length.
Paul Bakkerefc30292011-11-10 14:43:23 +0000218 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100219 * \param p On entry, \c *p points to the start of the ASN.1 element.
220 * On successful completion, \c *p points to the first byte
221 * after the length, i.e. the first byte of the content.
222 * On error, the value of \c *p is undefined.
223 * \param end End of data.
Gilles Peskinedc2db482019-09-20 21:06:01 +0200224 * \param len On successful completion, \c *len contains the length
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100225 * read from the ASN.1 input.
226 * \param tag The expected tag.
Paul Bakkerefc30292011-11-10 14:43:23 +0000227 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100228 * \return 0 if successful.
229 * \return #MBEDTLS_ERR_ASN1_UNEXPECTED_TAG if the data does not start
230 * with the requested tag.
231 * \return #MBEDTLS_ERR_ASN1_OUT_OF_DATA if the ASN.1 element
232 * would end beyond \p end.
Shaun Case0e7791f2021-12-20 21:14:10 -0800233 * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the length is unparsable.
Paul Bakkerefc30292011-11-10 14:43:23 +0000234 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100235int mbedtls_asn1_get_tag(unsigned char **p,
236 const unsigned char *end,
237 size_t *len, int tag);
Paul Bakkerefc30292011-11-10 14:43:23 +0000238
239/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200240 * \brief Retrieve a boolean ASN.1 tag and its value.
241 * Updates the pointer to immediately behind the full tag.
Paul Bakkerefc30292011-11-10 14:43:23 +0000242 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100243 * \param p On entry, \c *p points to the start of the ASN.1 element.
244 * On successful completion, \c *p points to the first byte
245 * beyond the ASN.1 element.
246 * On error, the value of \c *p is undefined.
247 * \param end End of data.
248 * \param val On success, the parsed value (\c 0 or \c 1).
Paul Bakkerefc30292011-11-10 14:43:23 +0000249 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100250 * \return 0 if successful.
251 * \return An ASN.1 error code if the input does not start with
252 * a valid ASN.1 BOOLEAN.
Paul Bakkerefc30292011-11-10 14:43:23 +0000253 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100254int mbedtls_asn1_get_bool(unsigned char **p,
255 const unsigned char *end,
256 int *val);
Paul Bakkerefc30292011-11-10 14:43:23 +0000257
258/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200259 * \brief Retrieve an integer ASN.1 tag and its value.
260 * Updates the pointer to immediately behind the full tag.
Paul Bakkerefc30292011-11-10 14:43:23 +0000261 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100262 * \param p On entry, \c *p points to the start of the ASN.1 element.
263 * On successful completion, \c *p points to the first byte
264 * beyond the ASN.1 element.
265 * On error, the value of \c *p is undefined.
266 * \param end End of data.
267 * \param val On success, the parsed value.
Paul Bakkerefc30292011-11-10 14:43:23 +0000268 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100269 * \return 0 if successful.
270 * \return An ASN.1 error code if the input does not start with
271 * a valid ASN.1 INTEGER.
272 * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the parsed value does
273 * not fit in an \c int.
Paul Bakkerefc30292011-11-10 14:43:23 +0000274 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100275int mbedtls_asn1_get_int(unsigned char **p,
276 const unsigned char *end,
277 int *val);
Paul Bakkerefc30292011-11-10 14:43:23 +0000278
279/**
Mykhailo Sopiha20180ca2019-10-29 15:58:10 +0200280 * \brief Retrieve an enumerated ASN.1 tag and its value.
281 * Updates the pointer to immediately behind the full tag.
282 *
283 * \param p On entry, \c *p points to the start of the ASN.1 element.
284 * On successful completion, \c *p points to the first byte
285 * beyond the ASN.1 element.
286 * On error, the value of \c *p is undefined.
287 * \param end End of data.
288 * \param val On success, the parsed value.
289 *
290 * \return 0 if successful.
291 * \return An ASN.1 error code if the input does not start with
292 * a valid ASN.1 ENUMERATED.
293 * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the parsed value does
294 * not fit in an \c int.
295 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100296int mbedtls_asn1_get_enum(unsigned char **p,
297 const unsigned char *end,
298 int *val);
Mykhailo Sopiha20180ca2019-10-29 15:58:10 +0200299
300/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200301 * \brief Retrieve a bitstring ASN.1 tag and its value.
302 * Updates the pointer to immediately behind the full tag.
Paul Bakkerefc30292011-11-10 14:43:23 +0000303 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100304 * \param p On entry, \c *p points to the start of the ASN.1 element.
305 * On successful completion, \c *p is equal to \p end.
306 * On error, the value of \c *p is undefined.
307 * \param end End of data.
308 * \param bs On success, ::mbedtls_asn1_bitstring information about
309 * the parsed value.
Paul Bakkerefc30292011-11-10 14:43:23 +0000310 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100311 * \return 0 if successful.
312 * \return #MBEDTLS_ERR_ASN1_LENGTH_MISMATCH if the input contains
313 * extra data after a valid BIT STRING.
314 * \return An ASN.1 error code if the input does not start with
315 * a valid ASN.1 BIT STRING.
Paul Bakkerefc30292011-11-10 14:43:23 +0000316 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100317int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
318 mbedtls_asn1_bitstring *bs);
Paul Bakkerefc30292011-11-10 14:43:23 +0000319
320/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200321 * \brief Retrieve a bitstring ASN.1 tag without unused bits and its
322 * value.
323 * Updates the pointer to the beginning of the bit/octet string.
Manuel Pégourié-Gonnarda2d4e642013-07-11 13:59:02 +0200324 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100325 * \param p On entry, \c *p points to the start of the ASN.1 element.
326 * On successful completion, \c *p points to the first byte
327 * of the content of the BIT STRING.
328 * On error, the value of \c *p is undefined.
329 * \param end End of data.
330 * \param len On success, \c *len is the length of the content in bytes.
Manuel Pégourié-Gonnarda2d4e642013-07-11 13:59:02 +0200331 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100332 * \return 0 if successful.
333 * \return #MBEDTLS_ERR_ASN1_INVALID_DATA if the input starts with
334 * a valid BIT STRING with a nonzero number of unused bits.
335 * \return An ASN.1 error code if the input does not start with
336 * a valid ASN.1 BIT STRING.
Manuel Pégourié-Gonnarda2d4e642013-07-11 13:59:02 +0200337 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100338int mbedtls_asn1_get_bitstring_null(unsigned char **p,
339 const unsigned char *end,
340 size_t *len);
Manuel Pégourié-Gonnarda2d4e642013-07-11 13:59:02 +0200341
342/**
Gilles Peskinedc2db482019-09-20 21:06:01 +0200343 * \brief Parses and splits an ASN.1 "SEQUENCE OF <tag>".
344 * Updates the pointer to immediately behind the full sequence tag.
Paul Bakkerefc30292011-11-10 14:43:23 +0000345 *
Hanno Becker12ae27d2019-09-11 14:20:09 +0100346 * This function allocates memory for the sequence elements. You can free
347 * the allocated memory with mbedtls_asn1_sequence_free().
348 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100349 * \note On error, this function may return a partial list in \p cur.
350 * You must set `cur->next = NULL` before calling this function!
351 * Otherwise it is impossible to distinguish a previously non-null
352 * pointer from a pointer to an object allocated by this function.
Paul Bakkerefc30292011-11-10 14:43:23 +0000353 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100354 * \note If the sequence is empty, this function does not modify
355 * \c *cur. If the sequence is valid and non-empty, this
356 * function sets `cur->buf.tag` to \p tag. This allows
357 * callers to distinguish between an empty sequence and
358 * a one-element sequence.
359 *
360 * \param p On entry, \c *p points to the start of the ASN.1 element.
361 * On successful completion, \c *p is equal to \p end.
362 * On error, the value of \c *p is undefined.
363 * \param end End of data.
364 * \param cur A ::mbedtls_asn1_sequence which this function fills.
365 * When this function returns, \c *cur is the head of a linked
366 * list. Each node in this list is allocated with
367 * mbedtls_calloc() apart from \p cur itself, and should
368 * therefore be freed with mbedtls_free().
369 * The list describes the content of the sequence.
370 * The head of the list (i.e. \c *cur itself) describes the
371 * first element, `*cur->next` describes the second element, etc.
372 * For each element, `buf.tag == tag`, `buf.len` is the length
373 * of the content of the content of the element, and `buf.p`
374 * points to the first byte of the content (i.e. immediately
375 * past the length of the element).
376 * Note that list elements may be allocated even on error.
377 * \param tag Each element of the sequence must have this tag.
378 *
379 * \return 0 if successful.
380 * \return #MBEDTLS_ERR_ASN1_LENGTH_MISMATCH if the input contains
381 * extra data after a valid SEQUENCE OF \p tag.
Gilles Peskineb5c74a52019-10-30 17:07:02 +0100382 * \return #MBEDTLS_ERR_ASN1_UNEXPECTED_TAG if the input starts with
383 * an ASN.1 SEQUENCE in which an element has a tag that
384 * is different from \p tag.
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100385 * \return #MBEDTLS_ERR_ASN1_ALLOC_FAILED if a memory allocation failed.
386 * \return An ASN.1 error code if the input does not start with
Gilles Peskineb5c74a52019-10-30 17:07:02 +0100387 * a valid ASN.1 SEQUENCE.
Paul Bakkerefc30292011-11-10 14:43:23 +0000388 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100389int mbedtls_asn1_get_sequence_of(unsigned char **p,
390 const unsigned char *end,
391 mbedtls_asn1_sequence *cur,
392 int tag);
Hanno Becker12ae27d2019-09-11 14:20:09 +0100393/**
394 * \brief Free a heap-allocated linked list presentation of
395 * an ASN.1 sequence, including the first element.
396 *
397 * There are two common ways to manage the memory used for the representation
398 * of a parsed ASN.1 sequence:
399 * - Allocate a head node `mbedtls_asn1_sequence *head` with mbedtls_calloc().
400 * Pass this node as the `cur` argument to mbedtls_asn1_get_sequence_of().
401 * When you have finished processing the sequence,
402 * call mbedtls_asn1_sequence_free() on `head`.
403 * - Allocate a head node `mbedtls_asn1_sequence *head` in any manner,
404 * for example on the stack. Make sure that `head->next == NULL`.
405 * Pass `head` as the `cur` argument to mbedtls_asn1_get_sequence_of().
406 * When you have finished processing the sequence,
407 * call mbedtls_asn1_sequence_free() on `head->cur`,
408 * then free `head` itself in the appropriate manner.
409 *
410 * \param seq The address of the first sequence component. This may
411 * be \c NULL, in which case this functions returns
412 * immediately.
413 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100414void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq);
Paul Bakkerefc30292011-11-10 14:43:23 +0000415
Hanno Becker199b7092019-09-11 14:21:26 +0100416/**
417 * \brief Traverse an ASN.1 SEQUENCE container and
418 * call a callback for each entry.
419 *
420 * This function checks that the input is a SEQUENCE of elements that
421 * each have a "must" tag, and calls a callback function on the elements
422 * that have a "may" tag.
423 *
424 * For example, to validate that the input is a SEQUENCE of `tag1` and call
425 * `cb` on each element, use
426 * ```
427 * mbedtls_asn1_traverse_sequence_of(&p, end, 0xff, tag1, 0, 0, cb, ctx);
428 * ```
429 *
430 * To validate that the input is a SEQUENCE of ANY and call `cb` on
431 * each element, use
432 * ```
433 * mbedtls_asn1_traverse_sequence_of(&p, end, 0, 0, 0, 0, cb, ctx);
434 * ```
435 *
436 * To validate that the input is a SEQUENCE of CHOICE {NULL, OCTET STRING}
437 * and call `cb` on each element that is an OCTET STRING, use
438 * ```
439 * mbedtls_asn1_traverse_sequence_of(&p, end, 0xfe, 0x04, 0xff, 0x04, cb, ctx);
440 * ```
441 *
442 * The callback is called on the elements with a "may" tag from left to
443 * right. If the input is not a valid SEQUENCE of elements with a "must" tag,
444 * the callback is called on the elements up to the leftmost point where
445 * the input is invalid.
446 *
447 * \warning This function is still experimental and may change
448 * at any time.
449 *
450 * \param p The address of the pointer to the beginning of
451 * the ASN.1 SEQUENCE header. This is updated to
452 * point to the end of the ASN.1 SEQUENCE container
453 * on a successful invocation.
454 * \param end The end of the ASN.1 SEQUENCE container.
455 * \param tag_must_mask A mask to be applied to the ASN.1 tags found within
456 * the SEQUENCE before comparing to \p tag_must_value.
457 * \param tag_must_val The required value of each ASN.1 tag found in the
458 * SEQUENCE, after masking with \p tag_must_mask.
459 * Mismatching tags lead to an error.
460 * For example, a value of \c 0 for both \p tag_must_mask
461 * and \p tag_must_val means that every tag is allowed,
462 * while a value of \c 0xFF for \p tag_must_mask means
463 * that \p tag_must_val is the only allowed tag.
464 * \param tag_may_mask A mask to be applied to the ASN.1 tags found within
465 * the SEQUENCE before comparing to \p tag_may_value.
466 * \param tag_may_val The desired value of each ASN.1 tag found in the
467 * SEQUENCE, after masking with \p tag_may_mask.
468 * Mismatching tags will be silently ignored.
469 * For example, a value of \c 0 for \p tag_may_mask and
470 * \p tag_may_val means that any tag will be considered,
471 * while a value of \c 0xFF for \p tag_may_mask means
472 * that all tags with value different from \p tag_may_val
473 * will be ignored.
474 * \param cb The callback to trigger for each component
475 * in the ASN.1 SEQUENCE that matches \p tag_may_val.
476 * The callback function is called with the following
477 * parameters:
478 * - \p ctx.
479 * - The tag of the current element.
480 * - A pointer to the start of the current element's
481 * content inside the input.
482 * - The length of the content of the current element.
483 * If the callback returns a non-zero value,
484 * the function stops immediately,
485 * forwarding the callback's return value.
486 * \param ctx The context to be passed to the callback \p cb.
487 *
488 * \return \c 0 if successful the entire ASN.1 SEQUENCE
489 * was traversed without parsing or callback errors.
490 * \return #MBEDTLS_ERR_ASN1_LENGTH_MISMATCH if the input
491 * contains extra data after a valid SEQUENCE
492 * of elements with an accepted tag.
493 * \return #MBEDTLS_ERR_ASN1_UNEXPECTED_TAG if the input starts
494 * with an ASN.1 SEQUENCE in which an element has a tag
495 * that is not accepted.
496 * \return An ASN.1 error code if the input does not start with
497 * a valid ASN.1 SEQUENCE.
498 * \return A non-zero error code forwarded from the callback
499 * \p cb in case the latter returns a non-zero value.
500 */
501int mbedtls_asn1_traverse_sequence_of(
502 unsigned char **p,
503 const unsigned char *end,
Hanno Becker34aada22020-02-03 10:39:55 +0000504 unsigned char tag_must_mask, unsigned char tag_must_val,
505 unsigned char tag_may_mask, unsigned char tag_may_val,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100506 int (*cb)(void *ctx, int tag,
507 unsigned char *start, size_t len),
508 void *ctx);
Hanno Becker199b7092019-09-11 14:21:26 +0100509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510#if defined(MBEDTLS_BIGNUM_C)
Paul Bakkerefc30292011-11-10 14:43:23 +0000511/**
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100512 * \brief Retrieve an integer ASN.1 tag and its value.
Paul Bakkercdda0972013-09-09 12:51:29 +0200513 * Updates the pointer to immediately behind the full tag.
Paul Bakkerefc30292011-11-10 14:43:23 +0000514 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100515 * \param p On entry, \c *p points to the start of the ASN.1 element.
516 * On successful completion, \c *p points to the first byte
517 * beyond the ASN.1 element.
518 * On error, the value of \c *p is undefined.
519 * \param end End of data.
520 * \param X On success, the parsed value.
Paul Bakkerefc30292011-11-10 14:43:23 +0000521 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100522 * \return 0 if successful.
523 * \return An ASN.1 error code if the input does not start with
524 * a valid ASN.1 INTEGER.
525 * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the parsed value does
526 * not fit in an \c int.
527 * \return An MPI error code if the parsed value is too large.
Paul Bakkerefc30292011-11-10 14:43:23 +0000528 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100529int mbedtls_asn1_get_mpi(unsigned char **p,
530 const unsigned char *end,
531 mbedtls_mpi *X);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532#endif /* MBEDTLS_BIGNUM_C */
Paul Bakkerefc30292011-11-10 14:43:23 +0000533
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200534/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200535 * \brief Retrieve an AlgorithmIdentifier ASN.1 sequence.
536 * Updates the pointer to immediately behind the full
537 * AlgorithmIdentifier.
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200538 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100539 * \param p On entry, \c *p points to the start of the ASN.1 element.
540 * On successful completion, \c *p points to the first byte
541 * beyond the AlgorithmIdentifier element.
542 * On error, the value of \c *p is undefined.
543 * \param end End of data.
544 * \param alg The buffer to receive the OID.
545 * \param params The buffer to receive the parameters.
546 * This is zeroized if there are no parameters.
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200547 *
548 * \return 0 if successful or a specific ASN.1 or MPI error code.
549 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100550int mbedtls_asn1_get_alg(unsigned char **p,
551 const unsigned char *end,
552 mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200553
554/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200555 * \brief Retrieve an AlgorithmIdentifier ASN.1 sequence with NULL or no
556 * params.
557 * Updates the pointer to immediately behind the full
558 * AlgorithmIdentifier.
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200559 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100560 * \param p On entry, \c *p points to the start of the ASN.1 element.
561 * On successful completion, \c *p points to the first byte
562 * beyond the AlgorithmIdentifier element.
563 * On error, the value of \c *p is undefined.
564 * \param end End of data.
565 * \param alg The buffer to receive the OID.
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200566 *
567 * \return 0 if successful or a specific ASN.1 or MPI error code.
568 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100569int mbedtls_asn1_get_alg_null(unsigned char **p,
570 const unsigned char *end,
571 mbedtls_asn1_buf *alg);
Paul Bakkerf8d018a2013-06-29 12:16:17 +0200572
Paul Bakkere5eae762013-08-26 12:05:14 +0200573/**
Paul Bakkercdda0972013-09-09 12:51:29 +0200574 * \brief Find a specific named_data entry in a sequence or list based on
575 * the OID.
Paul Bakkere5eae762013-08-26 12:05:14 +0200576 *
577 * \param list The list to seek through
578 * \param oid The OID to look for
579 * \param len Size of the OID
580 *
581 * \return NULL if not found, or a pointer to the existing entry.
582 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100583mbedtls_asn1_named_data *mbedtls_asn1_find_named_data(mbedtls_asn1_named_data *list,
584 const char *oid, size_t len);
Paul Bakkere5eae762013-08-26 12:05:14 +0200585
586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587 * \brief Free a mbedtls_asn1_named_data entry
Paul Bakkere5eae762013-08-26 12:05:14 +0200588 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100589 * \param entry The named data entry to free.
590 * This function calls mbedtls_free() on
591 * `entry->oid.p` and `entry->val.p`.
Paul Bakkere5eae762013-08-26 12:05:14 +0200592 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100593void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry);
Paul Bakkere5eae762013-08-26 12:05:14 +0200594
Paul Bakkerc547cc92013-09-09 12:01:23 +0200595/**
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100596 * \brief Free all entries in a mbedtls_asn1_named_data list.
Paul Bakkerc547cc92013-09-09 12:01:23 +0200597 *
Gilles Peskinebcbe1df2019-03-01 17:57:43 +0100598 * \param head Pointer to the head of the list of named data entries to free.
599 * This function calls mbedtls_asn1_free_named_data() and
600 * mbedtls_free() on each list element and
601 * sets \c *head to \c NULL.
Paul Bakkerc547cc92013-09-09 12:01:23 +0200602 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100603void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head);
Paul Bakkerc547cc92013-09-09 12:01:23 +0200604
Andrzej Kurek73afe272022-01-24 10:31:06 -0500605/** \} name Functions to parse ASN.1 data structures */
Andrzej Kurekff632d52022-01-24 10:32:00 -0500606/** \} addtogroup asn1_module */
Andrzej Kurek73afe272022-01-24 10:31:06 -0500607
Paul Bakkerefc30292011-11-10 14:43:23 +0000608#ifdef __cplusplus
609}
610#endif
611
612#endif /* asn1.h */