blob: e1a26b732ecb887f25d68ffd95854f34e325e2f7 [file] [log] [blame]
Gilles Peskine27d806f2019-03-01 18:02:53 +01001/* BEGIN_HEADER */
2#include <errno.h>
3#include <stdlib.h>
4#include <limits.h>
5
6#include "mbedtls/bignum.h"
7#include "mbedtls/asn1.h"
8#if defined(MBEDTLS_ASN1_WRITE_C)
9#include "mbedtls/asn1write.h"
10#endif
11
Gilles Peskine95c893d2020-01-21 21:26:36 +010012/* Used internally to report an error that indicates a bug in a parsing function. */
Gilles Peskine27d806f2019-03-01 18:02:53 +010013#define ERR_PARSE_INCONSISTENCY INT_MAX
14
Gilles Peskine95c893d2020-01-21 21:26:36 +010015/* Use this magic value in some tests to indicate that the expected result
16 * should not be checked. */
17#define UNPREDICTABLE_RESULT 0x5552
18
Gilles Peskine449bd832023-01-11 14:50:10 +010019static int nested_parse(unsigned char **const p,
20 const unsigned char *const end)
Gilles Peskine27d806f2019-03-01 18:02:53 +010021{
22 int ret;
23 size_t len = 0;
24 size_t len2 = 0;
25 unsigned char *const start = *p;
26 unsigned char *content_start;
27 unsigned char tag;
28
29 /* First get the length, skipping over the tag. */
30 content_start = start + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +010031 ret = mbedtls_asn1_get_len(&content_start, end, &len);
32 TEST_ASSERT(content_start <= end);
33 if (ret != 0) {
34 return ret;
35 }
Gilles Peskine27d806f2019-03-01 18:02:53 +010036
37 /* Since we have a valid element start (tag and length), retrieve and
38 * check the tag. */
39 tag = start[0];
Gilles Peskine449bd832023-01-11 14:50:10 +010040 TEST_EQUAL(mbedtls_asn1_get_tag(p, end, &len2, tag ^ 1),
41 MBEDTLS_ERR_ASN1_UNEXPECTED_TAG);
Gilles Peskine27d806f2019-03-01 18:02:53 +010042 *p = start;
Gilles Peskine449bd832023-01-11 14:50:10 +010043 TEST_EQUAL(mbedtls_asn1_get_tag(p, end, &len2, tag), 0);
44 TEST_EQUAL(len, len2);
45 TEST_ASSERT(*p == content_start);
Gilles Peskine27d806f2019-03-01 18:02:53 +010046 *p = content_start;
47
Gilles Peskine449bd832023-01-11 14:50:10 +010048 switch (tag & 0x1f) {
Gilles Peskine27d806f2019-03-01 18:02:53 +010049 case MBEDTLS_ASN1_BOOLEAN:
50 {
51 int val = -257;
52 *p = start;
Gilles Peskine449bd832023-01-11 14:50:10 +010053 ret = mbedtls_asn1_get_bool(p, end, &val);
54 if (ret == 0) {
55 TEST_ASSERT(val == 0 || val == 1);
56 }
Gilles Peskine27d806f2019-03-01 18:02:53 +010057 break;
58 }
59
60 case MBEDTLS_ASN1_INTEGER:
61 {
62#if defined(MBEDTLS_BIGNUM_C)
63 mbedtls_mpi mpi;
Gilles Peskine449bd832023-01-11 14:50:10 +010064 mbedtls_mpi_init(&mpi);
Gilles Peskine27d806f2019-03-01 18:02:53 +010065 *p = start;
Gilles Peskine449bd832023-01-11 14:50:10 +010066 ret = mbedtls_asn1_get_mpi(p, end, &mpi);
67 mbedtls_mpi_free(&mpi);
Gilles Peskine03c165e2019-10-10 19:15:18 +020068#else
69 *p = start + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +010070 ret = mbedtls_asn1_get_len(p, end, &len);
Gilles Peskine03c165e2019-10-10 19:15:18 +020071 *p += len;
Gilles Peskine27d806f2019-03-01 18:02:53 +010072#endif
73 /* If we're sure that the number fits in an int, also
74 * call mbedtls_asn1_get_int(). */
Gilles Peskine449bd832023-01-11 14:50:10 +010075 if (ret == 0 && len < sizeof(int)) {
Gilles Peskine27d806f2019-03-01 18:02:53 +010076 int val = -257;
77 unsigned char *q = start;
Gilles Peskine449bd832023-01-11 14:50:10 +010078 ret = mbedtls_asn1_get_int(&q, end, &val);
79 TEST_ASSERT(*p == q);
Gilles Peskine27d806f2019-03-01 18:02:53 +010080 }
81 break;
82 }
83
84 case MBEDTLS_ASN1_BIT_STRING:
85 {
86 mbedtls_asn1_bitstring bs;
87 *p = start;
Gilles Peskine449bd832023-01-11 14:50:10 +010088 ret = mbedtls_asn1_get_bitstring(p, end, &bs);
Gilles Peskine27d806f2019-03-01 18:02:53 +010089 break;
90 }
91
92 case MBEDTLS_ASN1_SEQUENCE:
93 {
Gilles Peskine449bd832023-01-11 14:50:10 +010094 while (*p <= end && *p < content_start + len && ret == 0) {
95 ret = nested_parse(p, content_start + len);
96 }
Gilles Peskine27d806f2019-03-01 18:02:53 +010097 break;
98 }
99
100 case MBEDTLS_ASN1_OCTET_STRING:
101 case MBEDTLS_ASN1_NULL:
102 case MBEDTLS_ASN1_OID:
103 case MBEDTLS_ASN1_UTF8_STRING:
104 case MBEDTLS_ASN1_SET:
105 case MBEDTLS_ASN1_PRINTABLE_STRING:
106 case MBEDTLS_ASN1_T61_STRING:
107 case MBEDTLS_ASN1_IA5_STRING:
108 case MBEDTLS_ASN1_UTC_TIME:
109 case MBEDTLS_ASN1_GENERALIZED_TIME:
110 case MBEDTLS_ASN1_UNIVERSAL_STRING:
111 case MBEDTLS_ASN1_BMP_STRING:
112 default:
113 /* No further testing implemented for this tag. */
114 *p += len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 return 0;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100116 }
117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 TEST_ASSERT(*p <= end);
119 return ret;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100120
121exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100122 return ERR_PARSE_INCONSISTENCY;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100123}
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125int get_len_step(const data_t *input, size_t buffer_size,
126 size_t actual_length)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100127{
128 unsigned char *buf = NULL;
129 unsigned char *p = NULL;
Gilles Peskine42a1acf2020-01-21 16:12:07 +0100130 unsigned char *end;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100131 size_t parsed_length;
132 int ret;
133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134 mbedtls_test_set_step(buffer_size);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100135 /* Allocate a new buffer of exactly the length to parse each time.
136 * This gives memory sanitizers a chance to catch buffer overreads. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 if (buffer_size == 0) {
138 ASSERT_ALLOC(buf, 1);
Gilles Peskine42a1acf2020-01-21 16:12:07 +0100139 end = buf + 1;
140 p = end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 } else {
142 ASSERT_ALLOC_WEAK(buf, buffer_size);
143 if (buffer_size > input->len) {
144 memcpy(buf, input->x, input->len);
145 memset(buf + input->len, 'A', buffer_size - input->len);
146 } else {
147 memcpy(buf, input->x, buffer_size);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100148 }
149 p = buf;
Gilles Peskine42a1acf2020-01-21 16:12:07 +0100150 end = buf + buffer_size;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100151 }
152
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 ret = mbedtls_asn1_get_len(&p, end, &parsed_length);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 if (buffer_size >= input->len + actual_length) {
156 TEST_EQUAL(ret, 0);
157 TEST_ASSERT(p == buf + input->len);
158 TEST_EQUAL(parsed_length, actual_length);
159 } else {
160 TEST_EQUAL(ret, MBEDTLS_ERR_ASN1_OUT_OF_DATA);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100161 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 mbedtls_free(buf);
163 return 1;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100164
165exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 mbedtls_free(buf);
167 return 0;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100168}
169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170typedef struct {
Hanno Becker199b7092019-09-11 14:21:26 +0100171 const unsigned char *input_start;
172 const char *description;
173} traverse_state_t;
174
175/* Value returned by traverse_callback if description runs out. */
176#define RET_TRAVERSE_STOP 1
177/* Value returned by traverse_callback if description has an invalid format
178 * (see traverse_sequence_of). */
179#define RET_TRAVERSE_ERROR 2
180
181
Gilles Peskine449bd832023-01-11 14:50:10 +0100182static int traverse_callback(void *ctx, int tag,
183 unsigned char *content, size_t len)
Hanno Becker199b7092019-09-11 14:21:26 +0100184{
185 traverse_state_t *state = ctx;
186 size_t offset;
187 const char *rest = state->description;
188 unsigned long n;
189
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 TEST_ASSERT(content > state->input_start);
Hanno Becker199b7092019-09-11 14:21:26 +0100191 offset = content - state->input_start;
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 mbedtls_test_set_step(offset);
Hanno Becker199b7092019-09-11 14:21:26 +0100193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 if (*rest == 0) {
195 return RET_TRAVERSE_STOP;
196 }
197 n = strtoul(rest, (char **) &rest, 0);
198 TEST_EQUAL(n, offset);
199 TEST_EQUAL(*rest, ',');
Hanno Becker199b7092019-09-11 14:21:26 +0100200 ++rest;
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 n = strtoul(rest, (char **) &rest, 0);
202 TEST_EQUAL(n, (unsigned) tag);
203 TEST_EQUAL(*rest, ',');
Hanno Becker199b7092019-09-11 14:21:26 +0100204 ++rest;
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 n = strtoul(rest, (char **) &rest, 0);
206 TEST_EQUAL(n, len);
207 if (*rest == ',') {
Hanno Becker199b7092019-09-11 14:21:26 +0100208 ++rest;
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 }
Hanno Becker199b7092019-09-11 14:21:26 +0100210
211 state->description = rest;
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 return 0;
Hanno Becker199b7092019-09-11 14:21:26 +0100213
214exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 return RET_TRAVERSE_ERROR;
Hanno Becker199b7092019-09-11 14:21:26 +0100216}
217
Gilles Peskine27d806f2019-03-01 18:02:53 +0100218/* END_HEADER */
219
220/* BEGIN_DEPENDENCIES
221 * depends_on:MBEDTLS_ASN1_PARSE_C
222 * END_DEPENDENCIES
223 */
224
225/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100226void parse_prefixes(const data_t *input,
227 int full_result,
228 int overfull_result)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100229{
Gilles Peskine95c893d2020-01-21 21:26:36 +0100230 /* full_result: expected result from parsing the given string. */
231 /* overfull_result: expected_result from parsing the given string plus
232 * some trailing garbage. This may be UNPREDICTABLE_RESULT to accept
233 * any result: use this for invalid inputs that may or may not become
234 * valid depending on what the trailing garbage is. */
235
Gilles Peskine27d806f2019-03-01 18:02:53 +0100236 unsigned char *buf = NULL;
237 unsigned char *p = NULL;
238 size_t buffer_size;
239 int ret;
240
Gilles Peskineef418382020-01-21 18:56:27 +0100241 /* Test every prefix of the input, except the empty string.
242 * The first byte of the string is the tag. Without a tag byte,
243 * we wouldn't know what to parse the input as.
Gilles Peskine95c893d2020-01-21 21:26:36 +0100244 * Also test the input followed by an extra byte.
Gilles Peskineef418382020-01-21 18:56:27 +0100245 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 for (buffer_size = 1; buffer_size <= input->len + 1; buffer_size++) {
247 mbedtls_test_set_step(buffer_size);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100248 /* Allocate a new buffer of exactly the length to parse each time.
249 * This gives memory sanitizers a chance to catch buffer overreads. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 ASSERT_ALLOC(buf, buffer_size);
251 memcpy(buf, input->x, buffer_size);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100252 p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 ret = nested_parse(&p, buf + buffer_size);
Gilles Peskine95c893d2020-01-21 21:26:36 +0100254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if (ret == ERR_PARSE_INCONSISTENCY) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100256 goto exit;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100257 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 if (buffer_size < input->len) {
259 TEST_EQUAL(ret, MBEDTLS_ERR_ASN1_OUT_OF_DATA);
260 } else if (buffer_size == input->len) {
261 TEST_EQUAL(ret, full_result);
262 } else { /* ( buffer_size > input->len ) */
263 if (overfull_result != UNPREDICTABLE_RESULT) {
264 TEST_EQUAL(ret, overfull_result);
265 }
Gilles Peskine95c893d2020-01-21 21:26:36 +0100266 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (ret == 0) {
268 TEST_ASSERT(p == buf + input->len);
Gilles Peskine95c893d2020-01-21 21:26:36 +0100269 }
Gilles Peskine95c893d2020-01-21 21:26:36 +0100270
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 mbedtls_free(buf);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100272 buf = NULL;
273 }
274
275exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 mbedtls_free(buf);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100277}
278/* END_CASE */
279
280/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100281void get_len(const data_t *input, int actual_length_arg)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100282{
283 size_t actual_length = actual_length_arg;
284 size_t buffer_size;
285
Gilles Peskineef418382020-01-21 18:56:27 +0100286 /* Test prefixes of a buffer containing the given length string
287 * followed by `actual_length` bytes of payload. To save a bit of
288 * time, we skip some "boring" prefixes: we don't test prefixes where
289 * the payload is truncated more than one byte away from either end,
290 * and we only test the empty string on a 1-byte input.
291 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 for (buffer_size = 1; buffer_size <= input->len + 1; buffer_size++) {
293 if (!get_len_step(input, buffer_size, actual_length)) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100296 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 if (!get_len_step(input, input->len + actual_length - 1, actual_length)) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 }
300 if (!get_len_step(input, input->len + actual_length, actual_length)) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100301 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100303}
304/* END_CASE */
305
306/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100307void get_boolean(const data_t *input,
308 int expected_value, int expected_result)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100309{
310 unsigned char *p = input->x;
311 int val;
312 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 ret = mbedtls_asn1_get_bool(&p, input->x + input->len, &val);
314 TEST_EQUAL(ret, expected_result);
315 if (expected_result == 0) {
316 TEST_EQUAL(val, expected_value);
317 TEST_ASSERT(p == input->x + input->len);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100318 }
319}
320/* END_CASE */
321
322/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100323void empty_integer(const data_t *input)
Gilles Peskine321adb22019-10-10 19:18:21 +0200324{
325 unsigned char *p;
326#if defined(MBEDTLS_BIGNUM_C)
327 mbedtls_mpi actual_mpi;
328#endif
329 int val;
330
331#if defined(MBEDTLS_BIGNUM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 mbedtls_mpi_init(&actual_mpi);
Gilles Peskine321adb22019-10-10 19:18:21 +0200333#endif
334
335 /* An INTEGER with no content is not valid. */
336 p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 TEST_EQUAL(mbedtls_asn1_get_int(&p, input->x + input->len, &val),
338 MBEDTLS_ERR_ASN1_INVALID_LENGTH);
Gilles Peskine321adb22019-10-10 19:18:21 +0200339
340#if defined(MBEDTLS_BIGNUM_C)
341 /* INTEGERs are sometimes abused as bitstrings, so the library accepts
342 * an INTEGER with empty content and gives it the value 0. */
343 p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 TEST_EQUAL(mbedtls_asn1_get_mpi(&p, input->x + input->len, &actual_mpi),
345 0);
346 TEST_EQUAL(mbedtls_mpi_cmp_int(&actual_mpi, 0), 0);
Gilles Peskine321adb22019-10-10 19:18:21 +0200347#endif
348
349exit:
350#if defined(MBEDTLS_BIGNUM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 mbedtls_mpi_free(&actual_mpi);
Gilles Peskine321adb22019-10-10 19:18:21 +0200352#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 /*empty cleanup in some configurations*/;
Gilles Peskine321adb22019-10-10 19:18:21 +0200354}
355/* END_CASE */
356
357/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100358void get_integer(const data_t *input,
359 const char *expected_hex, int expected_result)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100360{
361 unsigned char *p;
362#if defined(MBEDTLS_BIGNUM_C)
363 mbedtls_mpi expected_mpi;
364 mbedtls_mpi actual_mpi;
Gilles Peskine970dcbf2019-10-10 19:21:12 +0200365 mbedtls_mpi complement;
Gilles Peskine03c165e2019-10-10 19:15:18 +0200366 int expected_result_for_mpi = expected_result;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100367#endif
368 long expected_value;
369 int expected_result_for_int = expected_result;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100370 int val;
371 int ret;
372
373#if defined(MBEDTLS_BIGNUM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 mbedtls_mpi_init(&expected_mpi);
375 mbedtls_mpi_init(&actual_mpi);
376 mbedtls_mpi_init(&complement);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100377#endif
378
379 errno = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 expected_value = strtol(expected_hex, NULL, 16);
381 if (expected_result == 0 &&
382 (errno == ERANGE
Gilles Peskine27d806f2019-03-01 18:02:53 +0100383#if LONG_MAX > INT_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 || expected_value > INT_MAX || expected_value < INT_MIN
Gilles Peskine27d806f2019-03-01 18:02:53 +0100385#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 )) {
Gilles Peskine970dcbf2019-10-10 19:21:12 +0200387 /* The library returns the dubious error code INVALID_LENGTH
388 * for integers that are out of range. */
389 expected_result_for_int = MBEDTLS_ERR_ASN1_INVALID_LENGTH;
390 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100391 if (expected_result == 0 && expected_value < 0) {
Gilles Peskine970dcbf2019-10-10 19:21:12 +0200392 /* The library does not support negative INTEGERs and
393 * returns the dubious error code INVALID_LENGTH.
394 * Test that we preserve the historical behavior. If we
395 * decide to change the behavior, we'll also change this test. */
Gilles Peskine27d806f2019-03-01 18:02:53 +0100396 expected_result_for_int = MBEDTLS_ERR_ASN1_INVALID_LENGTH;
397 }
398
399 p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 ret = mbedtls_asn1_get_int(&p, input->x + input->len, &val);
401 TEST_EQUAL(ret, expected_result_for_int);
402 if (ret == 0) {
403 TEST_EQUAL(val, expected_value);
404 TEST_ASSERT(p == input->x + input->len);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100405 }
406
407#if defined(MBEDTLS_BIGNUM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 ret = mbedtls_test_read_mpi(&expected_mpi, expected_hex);
409 TEST_ASSERT(ret == 0 || ret == MBEDTLS_ERR_MPI_BAD_INPUT_DATA);
410 if (ret == MBEDTLS_ERR_MPI_BAD_INPUT_DATA) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100411 /* The data overflows the maximum MPI size. */
412 expected_result_for_mpi = MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
413 }
414 p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 ret = mbedtls_asn1_get_mpi(&p, input->x + input->len, &actual_mpi);
416 TEST_EQUAL(ret, expected_result_for_mpi);
417 if (ret == 0) {
418 if (expected_value >= 0) {
419 TEST_ASSERT(mbedtls_mpi_cmp_mpi(&actual_mpi,
420 &expected_mpi) == 0);
421 } else {
Gilles Peskine970dcbf2019-10-10 19:21:12 +0200422 /* The library ignores the sign bit in ASN.1 INTEGERs
423 * (which makes sense insofar as INTEGERs are sometimes
424 * abused as bit strings), so the result of parsing them
425 * is a positive integer such that expected_mpi +
426 * actual_mpi = 2^n where n is the length of the content
427 * of the INTEGER. (Leading ff octets don't matter for the
428 * expected value, but they matter for the actual value.)
429 * Test that we don't change from this behavior. If we
430 * decide to fix the library to change the behavior on
431 * negative INTEGERs, we'll fix this test code. */
432 unsigned char *q = input->x + 1;
433 size_t len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 TEST_ASSERT(mbedtls_asn1_get_len(&q, input->x + input->len,
435 &len) == 0);
436 TEST_ASSERT(mbedtls_mpi_lset(&complement, 1) == 0);
437 TEST_ASSERT(mbedtls_mpi_shift_l(&complement, len * 8) == 0);
438 TEST_ASSERT(mbedtls_mpi_add_mpi(&complement, &complement,
439 &expected_mpi) == 0);
440 TEST_ASSERT(mbedtls_mpi_cmp_mpi(&complement,
441 &actual_mpi) == 0);
Gilles Peskine970dcbf2019-10-10 19:21:12 +0200442 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 TEST_ASSERT(p == input->x + input->len);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100444 }
445#endif
446
447exit:
448#if defined(MBEDTLS_BIGNUM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 mbedtls_mpi_free(&expected_mpi);
450 mbedtls_mpi_free(&actual_mpi);
451 mbedtls_mpi_free(&complement);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100452#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 /*empty cleanup in some configurations*/;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100454}
455/* END_CASE */
456
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200457/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100458void get_enum(const data_t *input,
459 const char *expected_hex, int expected_result)
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200460{
461 unsigned char *p;
462 long expected_value;
463 int expected_result_for_enum = expected_result;
464 int val;
465 int ret;
466
467 errno = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 expected_value = strtol(expected_hex, NULL, 16);
469 if (expected_result == 0 &&
470 (errno == ERANGE
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200471#if LONG_MAX > INT_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 || expected_value > INT_MAX || expected_value < INT_MIN
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200473#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 )) {
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200475 /* The library returns the dubious error code INVALID_LENGTH
476 * for integers that are out of range. */
477 expected_result_for_enum = MBEDTLS_ERR_ASN1_INVALID_LENGTH;
478 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 if (expected_result == 0 && expected_value < 0) {
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200480 /* The library does not support negative INTEGERs and
481 * returns the dubious error code INVALID_LENGTH.
482 * Test that we preserve the historical behavior. If we
483 * decide to change the behavior, we'll also change this test. */
484 expected_result_for_enum = MBEDTLS_ERR_ASN1_INVALID_LENGTH;
485 }
486
487 p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 ret = mbedtls_asn1_get_enum(&p, input->x + input->len, &val);
489 TEST_EQUAL(ret, expected_result_for_enum);
490 if (ret == 0) {
491 TEST_EQUAL(val, expected_value);
492 TEST_ASSERT(p == input->x + input->len);
Mykhailo Sopiha6af7bf92019-10-31 15:55:16 +0200493 }
494}
495/* END_CASE */
496
Gilles Peskine27d806f2019-03-01 18:02:53 +0100497/* BEGIN_CASE depends_on:MBEDTLS_BIGNUM_C */
Gilles Peskine449bd832023-01-11 14:50:10 +0100498void get_mpi_too_large()
Gilles Peskine27d806f2019-03-01 18:02:53 +0100499{
500 unsigned char *buf = NULL;
501 unsigned char *p;
502 mbedtls_mpi actual_mpi;
503 size_t too_many_octets =
504 MBEDTLS_MPI_MAX_LIMBS * sizeof(mbedtls_mpi_uint) + 1;
505 size_t size = too_many_octets + 6;
506
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 mbedtls_mpi_init(&actual_mpi);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100508
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 ASSERT_ALLOC(buf, size);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100510 buf[0] = 0x02; /* tag: INTEGER */
511 buf[1] = 0x84; /* 4-octet length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 buf[2] = (too_many_octets >> 24) & 0xff;
513 buf[3] = (too_many_octets >> 16) & 0xff;
514 buf[4] = (too_many_octets >> 8) & 0xff;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100515 buf[5] = too_many_octets & 0xff;
516 buf[6] = 0x01; /* most significant octet */
517
518 p = buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 TEST_EQUAL(mbedtls_asn1_get_mpi(&p, buf + size, &actual_mpi),
520 MBEDTLS_ERR_MPI_ALLOC_FAILED);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100521
522exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 mbedtls_mpi_free(&actual_mpi);
524 mbedtls_free(buf);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100525}
526/* END_CASE */
527
528/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100529void get_bitstring(const data_t *input,
530 int expected_length, int expected_unused_bits,
531 int expected_result, int expected_result_null)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100532{
533 mbedtls_asn1_bitstring bs = { 0xdead, 0x21, NULL };
534 unsigned char *p = input->x;
535
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 TEST_EQUAL(mbedtls_asn1_get_bitstring(&p, input->x + input->len, &bs),
537 expected_result);
538 if (expected_result == 0) {
539 TEST_EQUAL(bs.len, (size_t) expected_length);
540 TEST_EQUAL(bs.unused_bits, expected_unused_bits);
541 TEST_ASSERT(bs.p != NULL);
542 TEST_EQUAL(bs.p - input->x + bs.len, input->len);
543 TEST_ASSERT(p == input->x + input->len);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100544 }
545
546 p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 TEST_EQUAL(mbedtls_asn1_get_bitstring_null(&p, input->x + input->len,
548 &bs.len),
549 expected_result_null);
550 if (expected_result_null == 0) {
551 TEST_EQUAL(bs.len, (size_t) expected_length);
552 if (expected_result == 0) {
553 TEST_ASSERT(p == input->x + input->len - bs.len);
554 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100555 }
556}
557/* END_CASE */
558
559/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100560void get_sequence_of(const data_t *input, int tag,
561 const char *description,
562 int expected_result)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100563{
Hanno Becker199b7092019-09-11 14:21:26 +0100564 /* The description string is a comma-separated list of integers.
565 * For each element in the SEQUENCE in input, description contains
566 * two integers: the offset of the element (offset from the start
567 * of input to the tag of the element) and the length of the
568 * element's contents.
569 * "offset1,length1,..." */
570
Gilles Peskine27d806f2019-03-01 18:02:53 +0100571 mbedtls_asn1_sequence head = { { 0, 0, NULL }, NULL };
Hanno Becker12ae27d2019-09-11 14:20:09 +0100572 mbedtls_asn1_sequence *cur;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100573 unsigned char *p = input->x;
574 const char *rest = description;
575 unsigned long n;
Chris Jones567e0ad2021-02-03 12:07:01 +0000576 unsigned int step = 0;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100577
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 TEST_EQUAL(mbedtls_asn1_get_sequence_of(&p, input->x + input->len,
579 &head, tag),
580 expected_result);
581 if (expected_result == 0) {
582 TEST_ASSERT(p == input->x + input->len);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100583
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 if (!*rest) {
585 TEST_EQUAL(head.buf.tag, 0);
586 TEST_ASSERT(head.buf.p == NULL);
587 TEST_EQUAL(head.buf.len, 0);
588 TEST_ASSERT(head.next == NULL);
589 } else {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100590 cur = &head;
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 while (*rest) {
592 mbedtls_test_set_step(step);
593 TEST_ASSERT(cur != NULL);
594 TEST_EQUAL(cur->buf.tag, tag);
595 n = strtoul(rest, (char **) &rest, 0);
596 TEST_EQUAL(n, (size_t) (cur->buf.p - input->x));
Gilles Peskine27d806f2019-03-01 18:02:53 +0100597 ++rest;
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 n = strtoul(rest, (char **) &rest, 0);
599 TEST_EQUAL(n, cur->buf.len);
600 if (*rest) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100601 ++rest;
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100603 cur = cur->next;
Chris Jones567e0ad2021-02-03 12:07:01 +0000604 ++step;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100605 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 TEST_ASSERT(cur == NULL);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100607 }
608 }
609
610exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 mbedtls_asn1_sequence_free(head.next);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100612}
613/* END_CASE */
614
615/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100616void traverse_sequence_of(const data_t *input,
617 int tag_must_mask, int tag_must_val,
618 int tag_may_mask, int tag_may_val,
619 const char *description,
620 int expected_result)
Hanno Becker199b7092019-09-11 14:21:26 +0100621{
622 /* The description string is a comma-separated list of integers.
623 * For each element in the SEQUENCE in input, description contains
624 * three integers: the offset of the element's content (offset from
625 * the start of input to the content of the element), the element's tag,
626 * and the length of the element's contents.
627 * "offset1,tag1,length1,..." */
628
629 unsigned char *p = input->x;
Gilles Peskine449bd832023-01-11 14:50:10 +0100630 traverse_state_t traverse_state = { input->x, description };
Hanno Becker199b7092019-09-11 14:21:26 +0100631 int ret;
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 ret = mbedtls_asn1_traverse_sequence_of(&p, input->x + input->len,
634 (uint8_t) tag_must_mask, (uint8_t) tag_must_val,
635 (uint8_t) tag_may_mask, (uint8_t) tag_may_val,
636 traverse_callback, &traverse_state);
637 if (ret == RET_TRAVERSE_ERROR) {
Hanno Becker199b7092019-09-11 14:21:26 +0100638 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +0100639 }
640 TEST_EQUAL(ret, expected_result);
641 TEST_EQUAL(*traverse_state.description, 0);
Hanno Becker199b7092019-09-11 14:21:26 +0100642}
643/* END_CASE */
644
645/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646void get_alg(const data_t *input,
647 int oid_offset, int oid_length,
648 int params_tag, int params_offset, int params_length,
649 int total_length,
650 int expected_result)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100651{
652 mbedtls_asn1_buf oid = { -1, 0, NULL };
653 mbedtls_asn1_buf params = { -1, 0, NULL };
654 unsigned char *p = input->x;
655 int ret;
656
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 TEST_EQUAL(mbedtls_asn1_get_alg(&p, input->x + input->len,
658 &oid, &params),
659 expected_result);
660 if (expected_result == 0) {
661 TEST_EQUAL(oid.tag, MBEDTLS_ASN1_OID);
662 TEST_EQUAL(oid.p - input->x, oid_offset);
663 TEST_EQUAL(oid.len, (size_t) oid_length);
664 TEST_EQUAL(params.tag, params_tag);
665 if (params_offset != 0) {
666 TEST_EQUAL(params.p - input->x, params_offset);
667 } else {
668 TEST_ASSERT(params.p == NULL);
669 }
670 TEST_EQUAL(params.len, (size_t) params_length);
671 TEST_EQUAL(p - input->x, total_length);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100672 }
673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 ret = mbedtls_asn1_get_alg_null(&p, input->x + input->len, &oid);
675 if (expected_result == 0 && params_offset == 0) {
676 TEST_EQUAL(oid.tag, MBEDTLS_ASN1_OID);
677 TEST_EQUAL(oid.p - input->x, oid_offset);
678 TEST_EQUAL(oid.len, (size_t) oid_length);
679 TEST_EQUAL(p - input->x, total_length);
680 } else {
681 TEST_ASSERT(ret != 0);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100682 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100683}
684/* END_CASE */
685
686/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100687void find_named_data(data_t *oid0, data_t *oid1, data_t *oid2, data_t *oid3,
688 data_t *needle, int from, int position)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100689{
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 mbedtls_asn1_named_data nd[] = {
691 { { 0x06, oid0->len, oid0->x }, { 0, 0, NULL }, NULL, 0 },
692 { { 0x06, oid1->len, oid1->x }, { 0, 0, NULL }, NULL, 0 },
693 { { 0x06, oid2->len, oid2->x }, { 0, 0, NULL }, NULL, 0 },
694 { { 0x06, oid3->len, oid3->x }, { 0, 0, NULL }, NULL, 0 },
Gilles Peskine27d806f2019-03-01 18:02:53 +0100695 };
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 mbedtls_asn1_named_data *pointers[ARRAY_LENGTH(nd) + 1];
Gilles Peskine27d806f2019-03-01 18:02:53 +0100697 size_t i;
Mateusz Starzyk59961cf2021-01-26 13:57:43 +0100698 const mbedtls_asn1_named_data *found;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100699
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 for (i = 0; i < ARRAY_LENGTH(nd); i++) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100701 pointers[i] = &nd[i];
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 }
703 pointers[ARRAY_LENGTH(nd)] = NULL;
704 for (i = 0; i < ARRAY_LENGTH(nd); i++) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100705 nd[i].next = pointers[i+1];
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100707
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 found = mbedtls_asn1_find_named_data((const mbedtls_asn1_named_data *) pointers[from],
709 (const char *) needle->x,
710 needle->len);
711 TEST_ASSERT(found == pointers[position]);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100712}
713/* END_CASE */
714
Glenn Strauss2a642992022-11-07 20:09:38 -0500715/* BEGIN_CASE depends_on:!MBEDTLS_DEPRECATED_REMOVED:!MBEDTLS_DEPRECATED_WARNING */
Gilles Peskine449bd832023-01-11 14:50:10 +0100716void free_named_data_null()
Gilles Peskine27d806f2019-03-01 18:02:53 +0100717{
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 mbedtls_asn1_free_named_data(NULL);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100719 goto exit; /* Silence unused label warning */
720}
721/* END_CASE */
722
Glenn Straussaa36c2a2022-11-07 20:08:54 -0500723/* BEGIN_CASE depends_on:!MBEDTLS_DEPRECATED_REMOVED:!MBEDTLS_DEPRECATED_WARNING */
Gilles Peskine449bd832023-01-11 14:50:10 +0100724void free_named_data(int with_oid, int with_val, int with_next)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100725{
726 mbedtls_asn1_named_data next =
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 { { 0x06, 0, NULL }, { 0, 0xcafe, NULL }, NULL, 0 };
Gilles Peskine27d806f2019-03-01 18:02:53 +0100728 mbedtls_asn1_named_data head =
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 { { 0x06, 0, NULL }, { 0, 0, NULL }, NULL, 0 };
Gilles Peskine27d806f2019-03-01 18:02:53 +0100730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 if (with_oid) {
732 ASSERT_ALLOC(head.oid.p, 1);
733 }
734 if (with_val) {
735 ASSERT_ALLOC(head.val.p, 1);
736 }
737 if (with_next) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100738 head.next = &next;
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 }
Gilles Peskine27d806f2019-03-01 18:02:53 +0100740
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 mbedtls_asn1_free_named_data(&head);
742 TEST_ASSERT(head.oid.p == NULL);
743 TEST_ASSERT(head.val.p == NULL);
744 TEST_ASSERT(head.next == NULL);
745 TEST_ASSERT(next.val.len == 0xcafe);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100746
747exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 mbedtls_free(head.oid.p);
749 mbedtls_free(head.val.p);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100750}
751/* END_CASE */
752
753/* BEGIN_CASE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100754void free_named_data_list(int length)
Gilles Peskine27d806f2019-03-01 18:02:53 +0100755{
756 mbedtls_asn1_named_data *head = NULL;
757 int i;
758
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 for (i = 0; i < length; i++) {
Gilles Peskine27d806f2019-03-01 18:02:53 +0100760 mbedtls_asn1_named_data *new = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 ASSERT_ALLOC(new, 1);
Gilles Peskine88f136f2019-09-20 21:06:27 +0200762 new->next = head;
Gilles Peskine27d806f2019-03-01 18:02:53 +0100763 head = new;
764 }
765
Gilles Peskine449bd832023-01-11 14:50:10 +0100766 mbedtls_asn1_free_named_data_list(&head);
767 TEST_ASSERT(head == NULL);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100768 /* Most of the point of the test is that it doesn't leak memory.
769 * So this test is only really useful under a memory leak detection
770 * framework. */
771exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 mbedtls_asn1_free_named_data_list(&head);
Gilles Peskine27d806f2019-03-01 18:02:53 +0100773}
774/* END_CASE */