Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 1 | /** |
| 2 | * \file asn1.h |
| 3 | * |
| 4 | * \brief Generic ASN.1 parsing |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 5 | */ |
| 6 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 7 | * Copyright The Mbed TLS Contributors |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 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. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 21 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 22 | #ifndef MBEDTLS_ASN1_H |
| 23 | #define MBEDTLS_ASN1_H |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 24 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 25 | #if !defined(MBEDTLS_CONFIG_FILE) |
Jaeden Amero | c49fbbf | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 26 | #include "mbedtls/config.h" |
Manuel Pégourié-Gonnard | cef4ad2 | 2014-04-29 12:39:06 +0200 | [diff] [blame] | 27 | #else |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 28 | #include MBEDTLS_CONFIG_FILE |
Manuel Pégourié-Gonnard | cef4ad2 | 2014-04-29 12:39:06 +0200 | [diff] [blame] | 29 | #endif |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 30 | |
Rich Evans | 00ab470 | 2015-02-06 13:43:58 +0000 | [diff] [blame] | 31 | #include <stddef.h> |
| 32 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 33 | #if defined(MBEDTLS_BIGNUM_C) |
Jaeden Amero | c49fbbf | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 34 | #include "mbedtls/bignum.h" |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 35 | #endif |
| 36 | |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 37 | /** |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 38 | * \addtogroup asn1_module |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 39 | * \{ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 40 | */ |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 41 | |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 42 | /** |
| 43 | * \name ASN1 Error codes |
| 44 | * These error codes are OR'ed to X509 error codes for |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 45 | * higher error granularity. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 46 | * ASN1 is a standard to specify data structures. |
| 47 | * \{ |
| 48 | */ |
Gilles Peskine | a397443 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 49 | /** 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 Bakker | 0588815 | 2012-02-16 10:26:57 +0000 | [diff] [blame] | 63 | |
Andrzej Kurek | 73afe27 | 2022-01-24 10:31:06 -0500 | [diff] [blame] | 64 | /** \} name ASN1 Error codes */ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 65 | |
| 66 | /** |
| 67 | * \name DER constants |
Andres Amaya Garcia | 9fb0205 | 2017-08-25 17:24:44 +0100 | [diff] [blame] | 68 | * These constants comply with the DER encoded ASN.1 type tags. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 69 | * 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 Peskine | 96ddb0a | 2020-02-26 19:50:01 +0100 | [diff] [blame] | 74 | * Such sequences are typically read into \c ::mbedtls_x509_buf. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 75 | * \{ |
| 76 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 77 | #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 Sopiha | 20180ca | 2019-10-29 15:58:10 +0200 | [diff] [blame] | 83 | #define MBEDTLS_ASN1_ENUMERATED 0x0A |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 84 | #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 Garcia | 7512bf7 | 2017-08-25 17:12:11 +0100 | [diff] [blame] | 97 | |
Hanno Becker | cba7122 | 2019-09-11 14:15:10 +0100 | [diff] [blame] | 98 | /* Slightly smaller way to check if tag is a string tag |
| 99 | * compared to canonical implementation. */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 100 | #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 Becker | cba7122 | 2019-09-11 14:15:10 +0100 | [diff] [blame] | 109 | |
Andres Amaya Garcia | 7512bf7 | 2017-08-25 17:12:11 +0100 | [diff] [blame] | 110 | /* |
| 111 | * Bit masks for each of the components of an ASN.1 tag as specified in |
Gilles Peskine | 1ed45ea | 2018-03-08 18:16:45 +0100 | [diff] [blame] | 112 | * ITU X.690 (08/2015), section 8.1 "General rules for encoding", |
| 113 | * paragraph 8.1.2.2: |
Andres Amaya Garcia | 7512bf7 | 2017-08-25 17:12:11 +0100 | [diff] [blame] | 114 | * |
| 115 | * Bit 8 7 6 5 1 |
| 116 | * +-------+-----+------------+ |
| 117 | * | Class | P/C | Tag number | |
| 118 | * +-------+-----+------------+ |
| 119 | */ |
Andres Amaya Garcia | 7786abc | 2017-11-07 20:21:56 +0000 | [diff] [blame] | 120 | #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 Garcia | 7512bf7 | 2017-08-25 17:12:11 +0100 | [diff] [blame] | 123 | |
Andrzej Kurek | 73afe27 | 2022-01-24 10:31:06 -0500 | [diff] [blame] | 124 | /** \} name DER constants */ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 125 | |
| 126 | /** Returns the size of the binary string, without the trailing \\0 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 127 | #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1) |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 128 | |
Manuel Pégourié-Gonnard | e76b750 | 2014-01-23 19:15:29 +0100 | [diff] [blame] | 129 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 130 | * Compares an mbedtls_asn1_buf structure to a reference OID. |
Manuel Pégourié-Gonnard | e76b750 | 2014-01-23 19:15:29 +0100 | [diff] [blame] | 131 | * |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 132 | * Only works for 'defined' oid_str values (MBEDTLS_OID_HMAC_SHA1), you cannot use a |
Manuel Pégourié-Gonnard | e76b750 | 2014-01-23 19:15:29 +0100 | [diff] [blame] | 133 | * 'unsigned char *oid' here! |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 134 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 135 | #define MBEDTLS_OID_CMP(oid_str, oid_buf) \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 136 | ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \ |
| 137 | memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0) |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 138 | |
Hanno Becker | 63e38fe | 2019-09-11 14:16:40 +0100 | [diff] [blame] | 139 | #define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 140 | ((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \ |
| 141 | memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0) |
Hanno Becker | 63e38fe | 2019-09-11 14:16:40 +0100 | [diff] [blame] | 142 | |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 143 | #ifdef __cplusplus |
| 144 | extern "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 Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 155 | typedef struct mbedtls_asn1_buf { |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 156 | int tag; /**< ASN1 type, e.g. MBEDTLS_ASN1_UTF8_STRING. */ |
Manuel Pégourié-Gonnard | b8186a5 | 2015-06-18 14:58:58 +0200 | [diff] [blame] | 157 | size_t len; /**< ASN1 length, in octets. */ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 158 | unsigned char *p; /**< ASN1 data, e.g. in ASCII. */ |
| 159 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 160 | mbedtls_asn1_buf; |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 161 | |
| 162 | /** |
| 163 | * Container for ASN1 bit strings. |
| 164 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 165 | typedef struct mbedtls_asn1_bitstring { |
Manuel Pégourié-Gonnard | b8186a5 | 2015-06-18 14:58:58 +0200 | [diff] [blame] | 166 | size_t len; /**< ASN1 length, in octets. */ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 167 | 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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 170 | mbedtls_asn1_bitstring; |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 171 | |
| 172 | /** |
| 173 | * Container for a sequence of ASN.1 items |
| 174 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 175 | typedef struct mbedtls_asn1_sequence { |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 176 | mbedtls_asn1_buf buf; /**< Buffer containing the given ASN.1 item. */ |
| 177 | struct mbedtls_asn1_sequence *next; /**< The next entry in the sequence. */ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 178 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 179 | mbedtls_asn1_sequence; |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 180 | |
| 181 | /** |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 182 | * Container for a sequence or list of 'named' ASN.1 data items |
| 183 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 184 | typedef struct mbedtls_asn1_named_data { |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 185 | 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é-Gonnard | 555fbf8 | 2015-02-04 17:11:55 +0000 | [diff] [blame] | 188 | unsigned char next_merged; /**< Merge next item into the current one? */ |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 189 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 190 | mbedtls_asn1_named_data; |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 191 | |
| 192 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 193 | * \brief Get the length of an ASN.1 element. |
| 194 | * Updates the pointer to immediately behind the length. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 195 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 196 | * \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 Peskine | dc2db48 | 2019-09-20 21:06:01 +0200 | [diff] [blame] | 202 | * \param len On successful completion, \c *len contains the length |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 203 | * read from the ASN.1 input. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 204 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 205 | * \return 0 if successful. |
| 206 | * \return #MBEDTLS_ERR_ASN1_OUT_OF_DATA if the ASN.1 element |
| 207 | * would end beyond \p end. |
Andrzej Kurek | 293e452 | 2022-04-13 14:28:52 -0400 | [diff] [blame] | 208 | * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the length is unparsable. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 209 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 210 | int mbedtls_asn1_get_len(unsigned char **p, |
| 211 | const unsigned char *end, |
| 212 | size_t *len); |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 213 | |
| 214 | /** |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 215 | * \brief Get the tag and length of the element. |
| 216 | * Check for the requested tag. |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 217 | * Updates the pointer to immediately behind the tag and length. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 218 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 219 | * \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 Peskine | dc2db48 | 2019-09-20 21:06:01 +0200 | [diff] [blame] | 224 | * \param len On successful completion, \c *len contains the length |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 225 | * read from the ASN.1 input. |
| 226 | * \param tag The expected tag. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 227 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 228 | * \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 Case | 0e7791f | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 233 | * \return #MBEDTLS_ERR_ASN1_INVALID_LENGTH if the length is unparsable. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 234 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 235 | int mbedtls_asn1_get_tag(unsigned char **p, |
| 236 | const unsigned char *end, |
| 237 | size_t *len, int tag); |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 238 | |
| 239 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 240 | * \brief Retrieve a boolean ASN.1 tag and its value. |
| 241 | * Updates the pointer to immediately behind the full tag. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 242 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 243 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 249 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 250 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 253 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 254 | int mbedtls_asn1_get_bool(unsigned char **p, |
| 255 | const unsigned char *end, |
| 256 | int *val); |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 257 | |
| 258 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 259 | * \brief Retrieve an integer ASN.1 tag and its value. |
| 260 | * Updates the pointer to immediately behind the full tag. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 261 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 262 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 268 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 269 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 274 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 275 | int mbedtls_asn1_get_int(unsigned char **p, |
| 276 | const unsigned char *end, |
| 277 | int *val); |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 278 | |
| 279 | /** |
Mykhailo Sopiha | 20180ca | 2019-10-29 15:58:10 +0200 | [diff] [blame] | 280 | * \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 Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 296 | int mbedtls_asn1_get_enum(unsigned char **p, |
| 297 | const unsigned char *end, |
| 298 | int *val); |
Mykhailo Sopiha | 20180ca | 2019-10-29 15:58:10 +0200 | [diff] [blame] | 299 | |
| 300 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 301 | * \brief Retrieve a bitstring ASN.1 tag and its value. |
| 302 | * Updates the pointer to immediately behind the full tag. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 303 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 304 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 310 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 311 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 316 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 317 | int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end, |
| 318 | mbedtls_asn1_bitstring *bs); |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 319 | |
| 320 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 321 | * \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é-Gonnard | a2d4e64 | 2013-07-11 13:59:02 +0200 | [diff] [blame] | 324 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 325 | * \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é-Gonnard | a2d4e64 | 2013-07-11 13:59:02 +0200 | [diff] [blame] | 331 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 332 | * \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é-Gonnard | a2d4e64 | 2013-07-11 13:59:02 +0200 | [diff] [blame] | 337 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 338 | int mbedtls_asn1_get_bitstring_null(unsigned char **p, |
| 339 | const unsigned char *end, |
| 340 | size_t *len); |
Manuel Pégourié-Gonnard | a2d4e64 | 2013-07-11 13:59:02 +0200 | [diff] [blame] | 341 | |
| 342 | /** |
Gilles Peskine | dc2db48 | 2019-09-20 21:06:01 +0200 | [diff] [blame] | 343 | * \brief Parses and splits an ASN.1 "SEQUENCE OF <tag>". |
| 344 | * Updates the pointer to immediately behind the full sequence tag. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 345 | * |
Hanno Becker | 12ae27d | 2019-09-11 14:20:09 +0100 | [diff] [blame] | 346 | * This function allocates memory for the sequence elements. You can free |
| 347 | * the allocated memory with mbedtls_asn1_sequence_free(). |
| 348 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 349 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 353 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 354 | * \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 Peskine | b5c74a5 | 2019-10-30 17:07:02 +0100 | [diff] [blame] | 382 | * \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 Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 385 | * \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 Peskine | b5c74a5 | 2019-10-30 17:07:02 +0100 | [diff] [blame] | 387 | * a valid ASN.1 SEQUENCE. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 388 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 389 | int mbedtls_asn1_get_sequence_of(unsigned char **p, |
| 390 | const unsigned char *end, |
| 391 | mbedtls_asn1_sequence *cur, |
| 392 | int tag); |
Hanno Becker | 12ae27d | 2019-09-11 14:20:09 +0100 | [diff] [blame] | 393 | /** |
| 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 Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 414 | void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq); |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 415 | |
Hanno Becker | 199b709 | 2019-09-11 14:21:26 +0100 | [diff] [blame] | 416 | /** |
| 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 | */ |
| 501 | int mbedtls_asn1_traverse_sequence_of( |
| 502 | unsigned char **p, |
| 503 | const unsigned char *end, |
Hanno Becker | 34aada2 | 2020-02-03 10:39:55 +0000 | [diff] [blame] | 504 | unsigned char tag_must_mask, unsigned char tag_must_val, |
| 505 | unsigned char tag_may_mask, unsigned char tag_may_val, |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 506 | int (*cb)(void *ctx, int tag, |
| 507 | unsigned char *start, size_t len), |
| 508 | void *ctx); |
Hanno Becker | 199b709 | 2019-09-11 14:21:26 +0100 | [diff] [blame] | 509 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 510 | #if defined(MBEDTLS_BIGNUM_C) |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 511 | /** |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 512 | * \brief Retrieve an integer ASN.1 tag and its value. |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 513 | * Updates the pointer to immediately behind the full tag. |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 514 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 515 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 521 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 522 | * \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 Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 528 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 529 | int mbedtls_asn1_get_mpi(unsigned char **p, |
| 530 | const unsigned char *end, |
| 531 | mbedtls_mpi *X); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 532 | #endif /* MBEDTLS_BIGNUM_C */ |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 533 | |
Paul Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 534 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 535 | * \brief Retrieve an AlgorithmIdentifier ASN.1 sequence. |
| 536 | * Updates the pointer to immediately behind the full |
| 537 | * AlgorithmIdentifier. |
Paul Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 538 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 539 | * \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 Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 547 | * |
| 548 | * \return 0 if successful or a specific ASN.1 or MPI error code. |
| 549 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 550 | int mbedtls_asn1_get_alg(unsigned char **p, |
| 551 | const unsigned char *end, |
| 552 | mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params); |
Paul Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 553 | |
| 554 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 555 | * \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 Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 559 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 560 | * \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 Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 566 | * |
| 567 | * \return 0 if successful or a specific ASN.1 or MPI error code. |
| 568 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 569 | int mbedtls_asn1_get_alg_null(unsigned char **p, |
| 570 | const unsigned char *end, |
| 571 | mbedtls_asn1_buf *alg); |
Paul Bakker | f8d018a | 2013-06-29 12:16:17 +0200 | [diff] [blame] | 572 | |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 573 | /** |
Paul Bakker | cdda097 | 2013-09-09 12:51:29 +0200 | [diff] [blame] | 574 | * \brief Find a specific named_data entry in a sequence or list based on |
| 575 | * the OID. |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 576 | * |
| 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 Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 583 | mbedtls_asn1_named_data *mbedtls_asn1_find_named_data(mbedtls_asn1_named_data *list, |
| 584 | const char *oid, size_t len); |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 585 | |
| 586 | /** |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 587 | * \brief Free a mbedtls_asn1_named_data entry |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 588 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 589 | * \param entry The named data entry to free. |
| 590 | * This function calls mbedtls_free() on |
| 591 | * `entry->oid.p` and `entry->val.p`. |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 592 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 593 | void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry); |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 594 | |
Paul Bakker | c547cc9 | 2013-09-09 12:01:23 +0200 | [diff] [blame] | 595 | /** |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 596 | * \brief Free all entries in a mbedtls_asn1_named_data list. |
Paul Bakker | c547cc9 | 2013-09-09 12:01:23 +0200 | [diff] [blame] | 597 | * |
Gilles Peskine | bcbe1df | 2019-03-01 17:57:43 +0100 | [diff] [blame] | 598 | * \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 Bakker | c547cc9 | 2013-09-09 12:01:23 +0200 | [diff] [blame] | 602 | */ |
Gilles Peskine | 1b6c09a | 2023-01-11 14:52:35 +0100 | [diff] [blame] | 603 | void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head); |
Paul Bakker | c547cc9 | 2013-09-09 12:01:23 +0200 | [diff] [blame] | 604 | |
Andrzej Kurek | 73afe27 | 2022-01-24 10:31:06 -0500 | [diff] [blame] | 605 | /** \} name Functions to parse ASN.1 data structures */ |
Andrzej Kurek | ff632d5 | 2022-01-24 10:32:00 -0500 | [diff] [blame] | 606 | /** \} addtogroup asn1_module */ |
Andrzej Kurek | 73afe27 | 2022-01-24 10:31:06 -0500 | [diff] [blame] | 607 | |
Paul Bakker | efc3029 | 2011-11-10 14:43:23 +0000 | [diff] [blame] | 608 | #ifdef __cplusplus |
| 609 | } |
| 610 | #endif |
| 611 | |
| 612 | #endif /* asn1.h */ |