blob: 7024e0b8c417f343601b5d6befe76af7d6f186da [file] [log] [blame]
Hanno Becker09d880a2021-01-12 07:43:30 +00001/* BEGIN_HEADER */
2
3#include <stdlib.h>
4
Hanno Becker8a04b102021-02-22 16:49:24 +00005#include "mps_reader.h"
Hanno Becker09d880a2021-01-12 07:43:30 +00006
7/*
8 * Compile-time configuration for test suite.
9 */
10
11/* Comment/Uncomment this to disable/enable the
12 * testing of the various MPS layers.
13 * This can be useful for time-consuming instrumentation
14 * tasks such as the conversion of E-ACSL annotations
15 * into runtime assertions. */
16#define TEST_SUITE_MPS_READER
17
18/* End of compile-time configuration. */
19
20/* END_HEADER */
21
Hanno Becker43c8f8c2021-03-05 05:16:45 +000022/* BEGIN_DEPENDENCIES
Ronald Cron6f135e12021-12-08 16:57:54 +010023 * depends_on:MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker43c8f8c2021-03-05 05:16:45 +000024 * END_DEPENDENCIES
25 */
26
Hanno Becker09d880a2021-01-12 07:43:30 +000027/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +010028void mbedtls_mps_reader_no_pausing_single_step_single_round(int with_acc)
Hanno Becker09d880a2021-01-12 07:43:30 +000029{
30 /* This test exercises the most basic use of the MPS reader:
31 * - The 'producing' layer provides a buffer
32 * - The 'consuming' layer fetches it in a single go.
Hanno Becker5047b562021-02-22 16:52:02 +000033 * - After processing, the consuming layer commits the data
34 * and the reader is moved back to producing mode.
Hanno Becker09d880a2021-01-12 07:43:30 +000035 *
36 * Parameters:
37 * - with_acc: 0 if the reader should be initialized without accumulator.
38 * 1 if the reader should be initialized with accumulator.
39 *
40 * Whether the accumulator is present or not should not matter,
41 * since the consumer's request can be fulfilled from the data
42 * that the producer has provided.
43 */
44 unsigned char bufA[100];
45 unsigned char acc[10];
46 unsigned char *tmp;
Hanno Beckerd7fcbfa2021-03-08 16:25:38 +000047 int paused;
Hanno Becker88993962021-01-28 09:45:47 +000048 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +010049 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker09d880a2021-01-12 07:43:30 +000050 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +010051 }
Hanno Becker09d880a2021-01-12 07:43:30 +000052
53 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +010054 if (with_acc == 0) {
55 mbedtls_mps_reader_init(&rd, NULL, 0);
56 } else {
57 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
58 }
59 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker09d880a2021-01-12 07:43:30 +000060 /* Consumption (upper layer) */
61 /* Consume exactly what's available */
Gilles Peskine449bd832023-01-11 14:50:10 +010062 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +010063 TEST_BUFFERS_EQUAL(tmp, 100, bufA, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +010064 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker09d880a2021-01-12 07:43:30 +000065 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +010066 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, &paused) == 0);
67 TEST_ASSERT(paused == 0);
68 mbedtls_mps_reader_free(&rd);
Hanno Becker09d880a2021-01-12 07:43:30 +000069}
70/* END_CASE */
Hanno Becker0e4edfc2021-01-12 07:52:29 +000071
72/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +010073void mbedtls_mps_reader_no_pausing_single_step_multiple_rounds(int with_acc)
Hanno Becker0e4edfc2021-01-12 07:52:29 +000074{
Hanno Becker5047b562021-02-22 16:52:02 +000075 /* This test exercises multiple rounds of the basic use of the MPS reader:
Hanno Becker0e4edfc2021-01-12 07:52:29 +000076 * - The 'producing' layer provides a buffer
77 * - The 'consuming' layer fetches it in a single go.
Hanno Becker5047b562021-02-22 16:52:02 +000078 * - After processing, the consuming layer commits the data
79 * and the reader is moved back to producing mode.
Hanno Becker0e4edfc2021-01-12 07:52:29 +000080 *
81 * Parameters:
82 * - with_acc: 0 if the reader should be initialized without accumulator.
83 * 1 if the reader should be initialized with accumulator.
84 *
85 * Whether the accumulator is present or not should not matter,
86 * since the consumer's request can be fulfilled from the data
87 * that the producer has provided.
88 */
89
90 unsigned char bufA[100], bufB[100];
91 unsigned char acc[10];
92 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +000093 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +010094 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker0e4edfc2021-01-12 07:52:29 +000095 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +010096 }
97 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
98 bufB[i] = ~((unsigned char) i);
99 }
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000100
101 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (with_acc == 0) {
103 mbedtls_mps_reader_init(&rd, NULL, 0);
104 } else {
105 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
106 }
107 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000108 /* Consumption (upper layer) */
109 /* Consume exactly what's available */
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100111 TEST_BUFFERS_EQUAL(tmp, 100, bufA, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000113 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
115 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000116 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100118 TEST_BUFFERS_EQUAL(tmp, 100, bufB, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +0100119 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000120 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
122 mbedtls_mps_reader_free(&rd);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000123}
124/* END_CASE */
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000125
126/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100127void mbedtls_mps_reader_no_pausing_multiple_steps_single_round(int with_acc)
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000128{
129 /* This test exercises one round of the following:
130 * - The 'producing' layer provides a buffer
131 * - The 'consuming' layer fetches it in multiple calls
Hanno Becker5047b562021-02-22 16:52:02 +0000132 * to `mbedtls_mps_reader_get()`, without committing in between.
133 * - After processing, the consuming layer commits the data
134 * and the reader is moved back to producing mode.
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000135 *
136 * Parameters:
137 * - with_acc: 0 if the reader should be initialized without accumulator.
138 * 1 if the reader should be initialized with accumulator.
139 *
140 * Whether the accumulator is present or not should not matter,
Hanno Becker5047b562021-02-22 16:52:02 +0000141 * since the consumer's requests can be fulfilled from the data
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000142 * that the producer has provided.
143 */
144
145 /* Lower layer provides data that the upper layer fully consumes
146 * through multiple `get` calls. */
147 unsigned char buf[100];
148 unsigned char acc[10];
149 unsigned char *tmp;
150 mbedtls_mps_size_t tmp_len;
Hanno Becker88993962021-01-28 09:45:47 +0000151 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000153 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100154 }
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000155
156 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100157 if (with_acc == 0) {
158 mbedtls_mps_reader_init(&rd, NULL, 0);
159 } else {
160 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
161 }
162 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000163 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100165 TEST_BUFFERS_EQUAL(tmp, 10, buf, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100167 TEST_BUFFERS_EQUAL(tmp, 70, buf + 10, 70);
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, &tmp_len) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100169 TEST_BUFFERS_EQUAL(tmp, tmp_len, buf + 80, 20);
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000171 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
173 mbedtls_mps_reader_free(&rd);
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000174}
175/* END_CASE */
Hanno Becker7973b2d2021-01-12 08:11:40 +0000176
177/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178void mbedtls_mps_reader_no_pausing_multiple_steps_multiple_rounds(int with_acc)
Hanno Becker7973b2d2021-01-12 08:11:40 +0000179{
180 /* This test exercises one round of fetching a buffer in multiple chunks
181 * and passing it back to the producer afterwards, followed by another
182 * single-step sequence of feed-fetch-commit-reclaim.
183 */
184 unsigned char bufA[100], bufB[100];
185 unsigned char acc[10];
186 unsigned char *tmp;
187 mbedtls_mps_size_t tmp_len;
Hanno Becker88993962021-01-28 09:45:47 +0000188 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker7973b2d2021-01-12 08:11:40 +0000190 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 }
192 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
193 bufB[i] = ~((unsigned char) i);
194 }
Hanno Becker7973b2d2021-01-12 08:11:40 +0000195
196 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 if (with_acc == 0) {
198 mbedtls_mps_reader_init(&rd, NULL, 0);
199 } else {
200 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
201 }
202 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000203 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100205 TEST_BUFFERS_EQUAL(tmp, 10, bufA, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100207 TEST_BUFFERS_EQUAL(tmp, 70, bufA + 10, 70);
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, &tmp_len) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100209 TEST_BUFFERS_EQUAL(tmp, tmp_len, bufA + 80, 20);
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000211 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
213 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000214 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100216 TEST_BUFFERS_EQUAL(tmp, 100, bufB, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000218 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
220 mbedtls_mps_reader_free(&rd);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000221}
222/* END_CASE */
Hanno Becker7d86b742021-01-12 08:14:38 +0000223
224/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
225void mbedtls_mps_reader_pausing_needed_disabled()
226{
Hanno Becker5047b562021-02-22 16:52:02 +0000227 /* This test exercises the behaviour of the MPS reader when a read request
Hanno Becker7d86b742021-01-12 08:14:38 +0000228 * of the consumer exceeds what has been provided by the producer, and when
229 * no accumulator is available in the reader.
230 *
231 * In this case, we expect the reader to fail.
232 */
233
234 unsigned char buf[100];
235 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000236 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Becker7d86b742021-01-12 08:14:38 +0000238 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 }
Hanno Becker7d86b742021-01-12 08:14:38 +0000240
241 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 mbedtls_mps_reader_init(&rd, NULL, 0);
243 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Becker7d86b742021-01-12 08:14:38 +0000244 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100246 TEST_BUFFERS_EQUAL(tmp, 50, buf, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
248 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) ==
249 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Becker7d86b742021-01-12 08:14:38 +0000250 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
252 MBEDTLS_ERR_MPS_READER_NEED_ACCUMULATOR);
253 mbedtls_mps_reader_free(&rd);
Hanno Becker7d86b742021-01-12 08:14:38 +0000254}
255/* END_CASE */
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000256
257/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
258void mbedtls_mps_reader_pausing_needed_buffer_too_small()
259{
260 /* This test exercises the behaviour of the MPS reader with accumulator
Hanno Becker5047b562021-02-22 16:52:02 +0000261 * in the situation where a read request goes beyond the bounds of the
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000262 * current read buffer, _and_ the reader's accumulator is too small to
263 * hold the requested amount of data.
264 *
Hanno Becker014f6832021-02-08 06:52:21 +0000265 * In this case, we expect mbedtls_mps_reader_reclaim() to fail,
266 * but it should be possible to continue fetching data as if
267 * there had been no excess request via mbedtls_mps_reader_get()
268 * and the call to mbedtls_mps_reader_reclaim() had been rejected
269 * because of data remaining.
270 */
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000271
272 unsigned char buf[100];
273 unsigned char acc[10];
274 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000275 mbedtls_mps_reader rd;
Hanno Becker014f6832021-02-08 06:52:21 +0000276 mbedtls_mps_size_t tmp_len;
277
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000279 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 }
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000281
282 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
284 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000285 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100287 TEST_BUFFERS_EQUAL(tmp, 50, buf, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
289 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100290 TEST_BUFFERS_EQUAL(tmp, 10, buf + 50, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) ==
292 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000293 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
295 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Becker014f6832021-02-08 06:52:21 +0000296
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, &tmp_len) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100298 TEST_BUFFERS_EQUAL(tmp, tmp_len, buf + 50, 50);
Hanno Becker014f6832021-02-08 06:52:21 +0000299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 mbedtls_mps_reader_free(&rd);
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000301}
302/* END_CASE */
Hanno Beckere82952a2021-01-12 08:27:29 +0000303
304/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000305void mbedtls_mps_reader_reclaim_overflow()
306{
307 /* This test exercises the behaviour of the MPS reader with accumulator
308 * in the situation where upon calling mbedtls_mps_reader_reclaim(), the
309 * uncommitted data together with the excess data missing in the last
Tom Cosgrove1797b052022-12-04 17:19:59 +0000310 * call to mbedtls_mps_reader_get() exceeds the bounds of the type
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000311 * holding the buffer length.
312 */
313
314 unsigned char buf[100];
315 unsigned char acc[50];
316 unsigned char *tmp;
317 mbedtls_mps_reader rd;
318
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Becker5b3841d2021-03-19 05:23:30 +0000320 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Hanno Becker5b3841d2021-03-19 05:23:30 +0000322
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000323 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
325 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000326 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100328 TEST_BUFFERS_EQUAL(tmp, 50, buf, 50);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000329 /* Excess request */
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 TEST_ASSERT(mbedtls_mps_reader_get(&rd, (mbedtls_mps_size_t) -1, &tmp, NULL) ==
331 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000332 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
334 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000335
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 mbedtls_mps_reader_free(&rd);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000337}
338/* END_CASE */
339
340/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341void mbedtls_mps_reader_pausing(int option)
Hanno Beckere82952a2021-01-12 08:27:29 +0000342{
343 /* This test exercises the behaviour of the reader when the
Hanno Becker756abeb2021-03-08 16:28:09 +0000344 * accumulator is used to fulfill a consumer's request.
Hanno Beckere82952a2021-01-12 08:27:29 +0000345 *
346 * More detailed:
347 * - The producer feeds some data.
348 * - The consumer asks for more data than what's available.
349 * - The reader remembers the request and goes back to
350 * producing mode, waiting for more data from the producer.
351 * - The producer provides another chunk of data which is
352 * sufficient to fulfill the original read request.
353 * - The consumer retries the original read request, which
354 * should now succeed.
355 *
356 * This test comes in multiple variants controlled by the
357 * `option` parameter and documented below.
358 */
359
360 unsigned char bufA[100], bufB[100];
361 unsigned char *tmp;
362 unsigned char acc[40];
Hanno Beckerd7fcbfa2021-03-08 16:25:38 +0000363 int paused;
Hanno Becker88993962021-01-28 09:45:47 +0000364 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Beckere82952a2021-01-12 08:27:29 +0000366 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 }
368 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
369 bufB[i] = ~((unsigned char) i);
370 }
Hanno Beckere82952a2021-01-12 08:27:29 +0000371
372 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
374 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000375
376 /* Consumption (upper layer) */
377 /* Ask for more than what's available. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100379 TEST_BUFFERS_EQUAL(tmp, 80, bufA, 80);
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
381 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100382 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 switch (option) {
Hanno Beckere82952a2021-01-12 08:27:29 +0000384 case 0: /* Single uncommitted fetch at pausing */
385 case 1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000387 break;
388 default: /* Multiple uncommitted fetches at pausing */
389 break;
390 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100391 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
392 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckere82952a2021-01-12 08:27:29 +0000393
394 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, &paused) == 0);
396 TEST_ASSERT(paused == 1);
397 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000398
399 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 switch (option) {
Hanno Beckere82952a2021-01-12 08:27:29 +0000401 case 0: /* Single fetch at pausing, re-fetch with commit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100403 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
404 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000406 break;
407
408 case 1: /* Single fetch at pausing, re-fetch without commit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100410 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
411 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Hanno Beckere82952a2021-01-12 08:27:29 +0000412 break;
413
414 case 2: /* Multiple fetches at pausing, repeat without commit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100416 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100418 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
419 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Hanno Beckere82952a2021-01-12 08:27:29 +0000420 break;
421
422 case 3: /* Multiple fetches at pausing, repeat with commit 1. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100424 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
426 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100427 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
428 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Hanno Beckere82952a2021-01-12 08:27:29 +0000429 break;
430
431 case 4: /* Multiple fetches at pausing, repeat with commit 2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100433 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100435 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
436 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000438 break;
439
440 case 5: /* Multiple fetches at pausing, repeat with commit 3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100442 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
444 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100445 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
446 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000448 break;
449
450 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 TEST_ASSERT(0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000452 }
453
454 /* In all cases, fetch the rest of the second buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 90, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100456 TEST_BUFFERS_EQUAL(tmp, 90, bufB + 10, 90);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000458
459 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
461 mbedtls_mps_reader_free(&rd);
Hanno Beckere82952a2021-01-12 08:27:29 +0000462}
463/* END_CASE */
Hanno Beckeraac41222021-01-12 08:36:36 +0000464
465/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100466void mbedtls_mps_reader_pausing_multiple_feeds(int option)
Hanno Beckeraac41222021-01-12 08:36:36 +0000467{
468 /* This test exercises the behaviour of the MPS reader
469 * in the following situation:
Hanno Becker5047b562021-02-22 16:52:02 +0000470 * - The consumer has asked for more than what's available, so the
Hanno Beckeraac41222021-01-12 08:36:36 +0000471 * reader pauses and waits for further input data via
Hanno Becker88993962021-01-28 09:45:47 +0000472 * `mbedtls_mps_reader_feed()`
473 * - Multiple such calls to `mbedtls_mps_reader_feed()` are necessary
Hanno Beckeraac41222021-01-12 08:36:36 +0000474 * to fulfill the original request, and the reader needs to do
475 * the necessary bookkeeping under the hood.
476 *
477 * This test comes in a few variants differing in the number and
478 * size of feed calls that the producer issues while the reader is
479 * accumulating the necessary data - see the comments below.
480 */
481
482 unsigned char bufA[100], bufB[100];
483 unsigned char *tmp;
484 unsigned char acc[70];
Hanno Becker88993962021-01-28 09:45:47 +0000485 mbedtls_mps_reader rd;
Hanno Beckeraac41222021-01-12 08:36:36 +0000486 mbedtls_mps_size_t fetch_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Beckeraac41222021-01-12 08:36:36 +0000488 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 }
490 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
491 bufB[i] = ~((unsigned char) i);
492 }
Hanno Beckeraac41222021-01-12 08:36:36 +0000493
494 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
496 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000497
498 /* Consumption (upper layer) */
499 /* Ask for more than what's available. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100501 TEST_BUFFERS_EQUAL(tmp, 80, bufA, 80);
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000503 /* 20 left, ask for 70 -> 50 overhead */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) ==
505 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckeraac41222021-01-12 08:36:36 +0000506
507 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
509 switch (option) {
Hanno Beckeraac41222021-01-12 08:36:36 +0000510 case 0: /* 10 + 10 + 80 byte feed */
Gilles Peskine449bd832023-01-11 14:50:10 +0100511 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, 10) ==
512 MBEDTLS_ERR_MPS_READER_NEED_MORE);
513 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 10, 10) ==
514 MBEDTLS_ERR_MPS_READER_NEED_MORE);
515 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 20, 80) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000516 break;
517
518 case 1: /* 50 x 1byte */
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 for (size_t num_feed = 0; num_feed < 49; num_feed++) {
520 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + num_feed, 1) ==
521 MBEDTLS_ERR_MPS_READER_NEED_MORE);
Hanno Beckeraac41222021-01-12 08:36:36 +0000522 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 49, 1) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000524 break;
525
526 case 2: /* 49 x 1byte + 51bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 for (size_t num_feed = 0; num_feed < 49; num_feed++) {
528 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + num_feed, 1) ==
529 MBEDTLS_ERR_MPS_READER_NEED_MORE);
Hanno Beckeraac41222021-01-12 08:36:36 +0000530 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 49, 51) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000532 break;
533
534 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 TEST_ASSERT(0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000536 break;
537 }
538
539 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100541 TEST_BUFFERS_EQUAL(tmp, 20, bufA + 80, 20);
542 TEST_BUFFERS_EQUAL(tmp + 20, 50, bufB, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 1000, &tmp, &fetch_len) == 0);
544 switch (option) {
Hanno Beckeraac41222021-01-12 08:36:36 +0000545 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 TEST_ASSERT(fetch_len == 50);
Hanno Beckeraac41222021-01-12 08:36:36 +0000547 break;
548
549 case 1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 TEST_ASSERT(fetch_len == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000551 break;
552
553 case 2:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 TEST_ASSERT(fetch_len == 50);
Hanno Beckeraac41222021-01-12 08:36:36 +0000555 break;
556
557 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 TEST_ASSERT(0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000559 break;
560 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000562
563 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
565 mbedtls_mps_reader_free(&rd);
Hanno Beckeraac41222021-01-12 08:36:36 +0000566}
567/* END_CASE */
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000568
569
570/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100571void mbedtls_mps_reader_reclaim_data_left(int option)
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000572{
573 /* This test exercises the behaviour of the MPS reader when a
Hanno Becker88993962021-01-28 09:45:47 +0000574 * call to mbedtls_mps_reader_reclaim() is made before all data
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000575 * provided by the producer has been fetched and committed. */
576
577 unsigned char buf[100];
578 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000579 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000581 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 }
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000583
584 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 mbedtls_mps_reader_init(&rd, NULL, 0);
586 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000587
588 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 switch (option) {
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000590 case 0:
591 /* Fetch (but not commit) the entire buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf), &tmp, NULL)
593 == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100594 TEST_BUFFERS_EQUAL(tmp, 100, buf, 100);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000595 break;
596
597 case 1:
598 /* Fetch (but not commit) parts of the buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf) / 2,
600 &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100601 TEST_BUFFERS_EQUAL(tmp, sizeof(buf) / 2, buf, sizeof(buf) / 2);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000602 break;
603
604 case 2:
605 /* Fetch and commit parts of the buffer, then
606 * fetch but not commit the rest of the buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf) / 2,
608 &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100609 TEST_BUFFERS_EQUAL(tmp, sizeof(buf) / 2, buf, sizeof(buf) / 2);
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
611 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf) / 2,
612 &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100613 TEST_BUFFERS_EQUAL(tmp, sizeof(buf) / 2,
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 buf + sizeof(buf) / 2,
615 sizeof(buf) / 2);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000616 break;
617
618 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100619 TEST_ASSERT(0);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000620 break;
621 }
622
623 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
625 MBEDTLS_ERR_MPS_READER_DATA_LEFT);
626 mbedtls_mps_reader_free(&rd);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000627}
628/* END_CASE */
Hanno Beckere1f173c2021-01-12 08:43:58 +0000629
630/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
631void mbedtls_mps_reader_reclaim_data_left_retry()
632{
633 /* This test exercises the behaviour of the MPS reader when an attempt
634 * by the producer to reclaim the reader fails because of more data pending
635 * to be processed, and the consumer subsequently fetches more data. */
636 unsigned char buf[100];
637 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000638 mbedtls_mps_reader rd;
Hanno Beckere1f173c2021-01-12 08:43:58 +0000639
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckere1f173c2021-01-12 08:43:58 +0000641 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100642 }
Hanno Beckere1f173c2021-01-12 08:43:58 +0000643
644 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 mbedtls_mps_reader_init(&rd, NULL, 0);
646 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000647 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100649 TEST_BUFFERS_EQUAL(tmp, 50, buf, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
651 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100652 TEST_BUFFERS_EQUAL(tmp, 50, buf + 50, 50);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000653 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
655 MBEDTLS_ERR_MPS_READER_DATA_LEFT);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000656 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100658 TEST_BUFFERS_EQUAL(tmp, 50, buf + 50, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000660 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
662 mbedtls_mps_reader_free(&rd);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000663}
664/* END_CASE */
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000665
666/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100667void mbedtls_mps_reader_multiple_pausing(int option)
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000668{
669 /* This test exercises the behaviour of the MPS reader
670 * in the following situation:
Hanno Becker88993962021-01-28 09:45:47 +0000671 * - A read request via `mbedtls_mps_reader_get()` can't
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000672 * be served and the reader is paused to accumulate
673 * the desired amount of data from the producer.
Hanno Becker5047b562021-02-22 16:52:02 +0000674 * - Once enough data is available, the consumer successfully
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000675 * reads the data from the reader, but afterwards exceeds
676 * the available data again - pausing is necessary for a
677 * second time.
678 */
679
680 unsigned char bufA[100], bufB[20], bufC[10];
681 unsigned char *tmp;
682 unsigned char acc[50];
683 mbedtls_mps_size_t tmp_len;
Hanno Becker88993962021-01-28 09:45:47 +0000684 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000686 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 }
688 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
689 bufB[i] = ~((unsigned char) i);
690 }
691 for (size_t i = 0; (unsigned) i < sizeof(bufC); i++) {
692 bufC[i] = ~((unsigned char) i);
693 }
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000694
695 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
697 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000698
699 /* Consumption (upper layer) */
700 /* Ask for more than what's available. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100702 TEST_BUFFERS_EQUAL(tmp, 80, bufA, 80);
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
704 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100705 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
707 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000708
709 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
711 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 switch (option) {
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000714 case 0: /* Fetch same chunks, commit afterwards, and
715 * then exceed bounds of new buffer; accumulator
716 * large enough. */
717
718 /* Consume */
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, &tmp_len) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100720 TEST_BUFFERS_EQUAL(tmp, tmp_len, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100722 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
723 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
725 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
726 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000727
728 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
730 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufC, sizeof(bufC)) == 0);;
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000731
732 /* Consume */
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100734 TEST_BUFFERS_EQUAL(tmp, 10, bufB + 10, 10);
735 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufC, 10);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000736 break;
737
738 case 1: /* Fetch same chunks, commit afterwards, and
739 * then exceed bounds of new buffer; accumulator
740 * not large enough. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100742 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100744 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
745 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
747 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 51, &tmp, NULL) ==
748 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000749
750 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
752 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000753 break;
754
755 case 2: /* Fetch same chunks, don't commit afterwards, and
756 * then exceed bounds of new buffer; accumulator
757 * large enough. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100759 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100761 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
762 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
764 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000765
766 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
768 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufC, sizeof(bufC)) == 0);;
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000769
770 /* Consume */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100772 TEST_BUFFERS_EQUAL(tmp, 20, bufA + 80, 20);
773 TEST_BUFFERS_EQUAL(tmp + 20, 20, bufB, 20);
774 TEST_BUFFERS_EQUAL(tmp + 40, 10, bufC, 10);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000775 break;
776
777 case 3: /* Fetch same chunks, don't commit afterwards, and
778 * then exceed bounds of new buffer; accumulator
779 * not large enough. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100781 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +0100783 TEST_BUFFERS_EQUAL(tmp, 10, bufA + 90, 10);
784 TEST_BUFFERS_EQUAL(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 21, &tmp, NULL) ==
786 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000787
788 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
790 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000791 break;
792
793 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 TEST_ASSERT(0);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000795 break;
796 }
797
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 mbedtls_mps_reader_free(&rd);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000799}
800/* END_CASE */
Hanno Becker714cbeb2021-01-12 09:23:15 +0000801
802/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER:MBEDTLS_MPS_STATE_VALIDATION */
Gilles Peskine449bd832023-01-11 14:50:10 +0100803void mbedtls_mps_reader_random_usage(int num_out_chunks,
804 int max_chunk_size,
805 int max_request,
806 int acc_size)
Hanno Becker714cbeb2021-01-12 09:23:15 +0000807
808{
809 /* Randomly pass a reader object back and forth between lower and
810 * upper layer and let each of them call the respective reader API
811 * functions in a random fashion.
812 *
813 * On the lower layer, we're tracking and concatenating
814 * the data passed to successful feed calls.
815 *
816 * For the upper layer, we track and concatenate buffers
817 * obtained from successful get calls.
818 *
819 * As long as the lower layer calls reclaim at least once, (resetting the
820 * fetched but not-yet-committed data), this should always lead to the same
821 * stream of outgoing/incoming data for the lower/upper layers, even if
822 * most of the random calls fail.
823 *
824 * NOTE: This test uses rand() for random data, which is not optimal.
825 * Instead, it would be better to get the random data from a
826 * static buffer. This both eases reproducibility and allows
827 * simple conversion to a fuzz target.
828 */
829 int ret;
830 unsigned char *acc = NULL;
831 unsigned char *outgoing = NULL, *incoming = NULL;
832 unsigned char *cur_chunk = NULL;
833 size_t cur_out_chunk, out_pos, in_commit, in_fetch;
834 int rand_op; /* Lower layer:
835 * - Reclaim (0)
836 * - Feed (1)
837 * Upper layer:
838 * - Get, do tolerate smaller output (0)
839 * - Get, don't tolerate smaller output (1)
840 * - Commit (2) */
841 int mode = 0; /* Lower layer (0) or Upper layer (1) */
842 int reclaimed = 1; /* Have to call reclaim at least once before
843 * returning the reader to the upper layer. */
Hanno Becker88993962021-01-28 09:45:47 +0000844 mbedtls_mps_reader rd;
Hanno Becker714cbeb2021-01-12 09:23:15 +0000845
Gilles Peskine449bd832023-01-11 14:50:10 +0100846 if (acc_size > 0) {
Tom Cosgrove05b2a872023-07-21 11:31:13 +0100847 TEST_CALLOC(acc, acc_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000848 }
849
850 /* This probably needs to be changed because we want
851 * our tests to be deterministic. */
852 // srand( time( NULL ) );
853
Tom Cosgrove05b2a872023-07-21 11:31:13 +0100854 TEST_CALLOC(outgoing, num_out_chunks * max_chunk_size);
855 TEST_CALLOC(incoming, num_out_chunks * max_chunk_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000856
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 mbedtls_mps_reader_init(&rd, acc, acc_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000858
859 cur_out_chunk = 0;
860 in_commit = 0;
861 in_fetch = 0;
862 out_pos = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 while (cur_out_chunk < (unsigned) num_out_chunks) {
864 if (mode == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000865 /* Choose randomly between reclaim and feed */
866 rand_op = rand() % 2;
867
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 if (rand_op == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000869 /* Reclaim */
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 ret = mbedtls_mps_reader_reclaim(&rd, NULL);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000871
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 if (ret == 0) {
873 TEST_ASSERT(cur_chunk != NULL);
874 mbedtls_free(cur_chunk);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000875 cur_chunk = NULL;
876 }
877 reclaimed = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100878 } else {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000879 /* Feed reader with a random chunk */
880 unsigned char *tmp = NULL;
881 size_t tmp_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 if (cur_out_chunk == (unsigned) num_out_chunks) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000883 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 }
Hanno Becker714cbeb2021-01-12 09:23:15 +0000885
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 tmp_size = (rand() % max_chunk_size) + 1;
Tom Cosgrove05b2a872023-07-21 11:31:13 +0100887 TEST_CALLOC(tmp, tmp_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000888
Gilles Peskine449bd832023-01-11 14:50:10 +0100889 TEST_ASSERT(mbedtls_test_rnd_std_rand(NULL, tmp, tmp_size) == 0);
890 ret = mbedtls_mps_reader_feed(&rd, tmp, tmp_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000891
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (ret == 0 || ret == MBEDTLS_ERR_MPS_READER_NEED_MORE) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000893 cur_out_chunk++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 memcpy(outgoing + out_pos, tmp, tmp_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000895 out_pos += tmp_size;
896 }
897
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 if (ret == 0) {
899 TEST_ASSERT(cur_chunk == NULL);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000900 cur_chunk = tmp;
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 } else {
902 mbedtls_free(tmp);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000903 }
904
905 }
906
907 /* Randomly switch to consumption mode if reclaim
908 * was called at least once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (reclaimed == 1 && rand() % 3 == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000910 in_fetch = 0;
911 mode = 1;
912 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 } else {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000914 /* Choose randomly between get tolerating fewer data,
915 * get not tolerating fewer data, and commit. */
916 rand_op = rand() % 3;
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if (rand_op == 0 || rand_op == 1) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000918 mbedtls_mps_size_t get_size, real_size;
919 unsigned char *chunk_get;
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 get_size = (rand() % max_request) + 1;
921 if (rand_op == 0) {
922 ret = mbedtls_mps_reader_get(&rd, get_size, &chunk_get,
923 &real_size);
924 } else {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000925 real_size = get_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 ret = mbedtls_mps_reader_get(&rd, get_size, &chunk_get, NULL);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000927 }
928
929 /* Check if output is in accordance with what was written */
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 if (ret == 0) {
931 memcpy(incoming + in_commit + in_fetch,
932 chunk_get, real_size);
933 TEST_ASSERT(memcmp(incoming + in_commit + in_fetch,
934 outgoing + in_commit + in_fetch,
935 real_size) == 0);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000936 in_fetch += real_size;
937 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 } else if (rand_op == 2) { /* Commit */
939 ret = mbedtls_mps_reader_commit(&rd);
940 if (ret == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000941 in_commit += in_fetch;
942 in_fetch = 0;
943 }
944 }
945
946 /* Randomly switch back to preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 if (rand() % 3 == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000948 reclaimed = 0;
949 mode = 0;
950 }
951 }
952 }
953
954 /* Cleanup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 mbedtls_mps_reader_free(&rd);
956 mbedtls_free(incoming);
957 mbedtls_free(outgoing);
958 mbedtls_free(acc);
959 mbedtls_free(cur_chunk);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000960}
961/* END_CASE */
Hanno Becker223b72e2021-01-12 09:31:31 +0000962
963/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100964void mbedtls_reader_inconsistent_usage(int option)
Hanno Becker223b72e2021-01-12 09:31:31 +0000965{
966 /* This test exercises the behaviour of the MPS reader
967 * in the following situation:
968 * - The consumer asks for more data than what's available
969 * - The reader is paused and receives more data from the
970 * producer until the original read request can be fulfilled.
971 * - The consumer does not repeat the original request but
972 * requests data in a different way.
973 *
974 * The reader does not guarantee that inconsistent read requests
975 * after pausing will succeed, and this test triggers some cases
976 * where the request fails.
977 */
978
979 unsigned char bufA[100], bufB[100];
980 unsigned char *tmp;
981 unsigned char acc[40];
Hanno Becker88993962021-01-28 09:45:47 +0000982 mbedtls_mps_reader rd;
Hanno Becker223b72e2021-01-12 09:31:31 +0000983 int success = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker223b72e2021-01-12 09:31:31 +0000985 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 }
987 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
988 bufB[i] = ~((unsigned char) i);
989 }
Hanno Becker223b72e2021-01-12 09:31:31 +0000990
991 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
993 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +0000994 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
996 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
997 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
998 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
999 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Becker223b72e2021-01-12 09:31:31 +00001000 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
1002 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001003 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 switch (option) {
Hanno Becker223b72e2021-01-12 09:31:31 +00001005 case 0:
1006 /* Ask for buffered data in a single chunk, no commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001008 TEST_BUFFERS_EQUAL(tmp, 20, bufA + 80, 20);
1009 TEST_BUFFERS_EQUAL(tmp + 20, 10, bufB, 10);
Hanno Becker223b72e2021-01-12 09:31:31 +00001010 success = 1;
1011 break;
1012
1013 case 1:
1014 /* Ask for buffered data in a single chunk, with commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001016 TEST_BUFFERS_EQUAL(tmp, 20, bufA + 80, 20);
1017 TEST_BUFFERS_EQUAL(tmp + 20, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001019 success = 1;
1020 break;
1021
1022 case 2:
1023 /* Ask for more than was requested when pausing, #1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 31, &tmp, NULL) ==
1025 MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS);
Hanno Becker223b72e2021-01-12 09:31:31 +00001026 break;
1027
1028 case 3:
1029 /* Ask for more than was requested when pausing #2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 TEST_ASSERT(mbedtls_mps_reader_get(&rd, (mbedtls_mps_size_t) -1, &tmp, NULL) ==
1031 MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS);
Hanno Becker223b72e2021-01-12 09:31:31 +00001032 break;
1033
1034 case 4:
1035 /* Asking for buffered data in different
1036 * chunks than before CAN fail. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001038 TEST_BUFFERS_EQUAL(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) ==
1040 MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS);
Hanno Becker223b72e2021-01-12 09:31:31 +00001041 break;
1042
1043 case 5:
1044 /* Asking for buffered data different chunks
1045 * than before NEED NOT fail - no commits */
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001047 TEST_BUFFERS_EQUAL(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001049 TEST_BUFFERS_EQUAL(tmp, 5, bufA + 95, 5);
1050 TEST_BUFFERS_EQUAL(tmp + 5, 10, bufB, 10);
Hanno Becker223b72e2021-01-12 09:31:31 +00001051 success = 1;
1052 break;
1053
1054 case 6:
1055 /* Asking for buffered data different chunks
1056 * than before NEED NOT fail - intermediate commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001058 TEST_BUFFERS_EQUAL(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
1060 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001061 TEST_BUFFERS_EQUAL(tmp, 5, bufA + 95, 5);
1062 TEST_BUFFERS_EQUAL(tmp + 5, 10, bufB, 10);
Hanno Becker223b72e2021-01-12 09:31:31 +00001063 success = 1;
1064 break;
1065
1066 case 7:
1067 /* Asking for buffered data different chunks
1068 * than before NEED NOT fail - end commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001070 TEST_BUFFERS_EQUAL(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001072 TEST_BUFFERS_EQUAL(tmp, 5, bufA + 95, 5);
1073 TEST_BUFFERS_EQUAL(tmp + 5, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001075 success = 1;
1076 break;
1077
1078 case 8:
1079 /* Asking for buffered data different chunks
1080 * than before NEED NOT fail - intermediate & end commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001082 TEST_BUFFERS_EQUAL(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
1084 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001085 TEST_BUFFERS_EQUAL(tmp, 5, bufA + 95, 5);
1086 TEST_BUFFERS_EQUAL(tmp + 5, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001088 success = 1;
1089 break;
1090
1091 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 TEST_ASSERT(0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001093 break;
1094 }
1095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 if (success == 1) {
Hanno Becker223b72e2021-01-12 09:31:31 +00001097 /* In all succeeding cases, fetch the rest of the second buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 90, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001099 TEST_BUFFERS_EQUAL(tmp, 90, bufB + 10, 90);
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001101
1102 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001104 }
1105
1106 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 mbedtls_mps_reader_free(&rd);
Hanno Becker223b72e2021-01-12 09:31:31 +00001108}
1109/* END_CASE */
Hanno Becker2b8bad32021-01-12 09:40:05 +00001110
1111/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Hanno Becker15da2fc2021-02-22 16:57:14 +00001112void mbedtls_mps_reader_feed_empty()
Hanno Becker2b8bad32021-01-12 09:40:05 +00001113{
1114 /* This test exercises the behaviour of the reader when it is
Hanno Becker5047b562021-02-22 16:52:02 +00001115 * fed with a NULL buffer. */
Hanno Becker2b8bad32021-01-12 09:40:05 +00001116 unsigned char buf[100];
1117 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +00001118 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Becker2b8bad32021-01-12 09:40:05 +00001120 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 }
Hanno Becker2b8bad32021-01-12 09:40:05 +00001122
1123 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 mbedtls_mps_reader_init(&rd, NULL, 0);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, NULL, sizeof(buf)) ==
1127 MBEDTLS_ERR_MPS_READER_INVALID_ARG);
Hanno Becker15da2fc2021-02-22 16:57:14 +00001128
Hanno Becker2b8bad32021-01-12 09:40:05 +00001129 /* Subsequent feed-calls should still succeed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001131
1132 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrove65cd8512023-07-20 16:46:01 +01001134 TEST_BUFFERS_EQUAL(tmp, 100, buf, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001136
1137 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
1139 mbedtls_mps_reader_free(&rd);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001140}
1141/* END_CASE */