blob: 6751136582ae33c33b7d11329ec38a0fd420f137 [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 Cosgrovee4e9e7d2023-07-21 11:40:20 +010063 TEST_MEMORY_COMPARE(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);
Paul Elliott078edc22023-10-20 19:14:46 +010068
69exit:
Gilles Peskine449bd832023-01-11 14:50:10 +010070 mbedtls_mps_reader_free(&rd);
Hanno Becker09d880a2021-01-12 07:43:30 +000071}
72/* END_CASE */
Hanno Becker0e4edfc2021-01-12 07:52:29 +000073
74/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +010075void mbedtls_mps_reader_no_pausing_single_step_multiple_rounds(int with_acc)
Hanno Becker0e4edfc2021-01-12 07:52:29 +000076{
Hanno Becker5047b562021-02-22 16:52:02 +000077 /* This test exercises multiple rounds of the basic use of the MPS reader:
Hanno Becker0e4edfc2021-01-12 07:52:29 +000078 * - The 'producing' layer provides a buffer
79 * - The 'consuming' layer fetches it in a single go.
Hanno Becker5047b562021-02-22 16:52:02 +000080 * - After processing, the consuming layer commits the data
81 * and the reader is moved back to producing mode.
Hanno Becker0e4edfc2021-01-12 07:52:29 +000082 *
83 * Parameters:
84 * - with_acc: 0 if the reader should be initialized without accumulator.
85 * 1 if the reader should be initialized with accumulator.
86 *
87 * Whether the accumulator is present or not should not matter,
88 * since the consumer's request can be fulfilled from the data
89 * that the producer has provided.
90 */
91
92 unsigned char bufA[100], bufB[100];
93 unsigned char acc[10];
94 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +000095 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +010096 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker0e4edfc2021-01-12 07:52:29 +000097 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 }
99 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
100 bufB[i] = ~((unsigned char) i);
101 }
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000102
103 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 if (with_acc == 0) {
105 mbedtls_mps_reader_init(&rd, NULL, 0);
106 } else {
107 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
108 }
109 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000110 /* Consumption (upper layer) */
111 /* Consume exactly what's available */
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100113 TEST_MEMORY_COMPARE(tmp, 100, bufA, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000115 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100116 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
117 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000118 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100119 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100120 TEST_MEMORY_COMPARE(tmp, 100, bufB, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000122 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Paul Elliott078edc22023-10-20 19:14:46 +0100124
125exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 mbedtls_mps_reader_free(&rd);
Hanno Becker0e4edfc2021-01-12 07:52:29 +0000127}
128/* END_CASE */
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000129
130/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100131void mbedtls_mps_reader_no_pausing_multiple_steps_single_round(int with_acc)
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000132{
133 /* This test exercises one round of the following:
134 * - The 'producing' layer provides a buffer
135 * - The 'consuming' layer fetches it in multiple calls
Hanno Becker5047b562021-02-22 16:52:02 +0000136 * to `mbedtls_mps_reader_get()`, without committing in between.
137 * - After processing, the consuming layer commits the data
138 * and the reader is moved back to producing mode.
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000139 *
140 * Parameters:
141 * - with_acc: 0 if the reader should be initialized without accumulator.
142 * 1 if the reader should be initialized with accumulator.
143 *
144 * Whether the accumulator is present or not should not matter,
Hanno Becker5047b562021-02-22 16:52:02 +0000145 * since the consumer's requests can be fulfilled from the data
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000146 * that the producer has provided.
147 */
148
149 /* Lower layer provides data that the upper layer fully consumes
150 * through multiple `get` calls. */
151 unsigned char buf[100];
152 unsigned char acc[10];
153 unsigned char *tmp;
154 mbedtls_mps_size_t tmp_len;
Hanno Becker88993962021-01-28 09:45:47 +0000155 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000157 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 }
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000159
160 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 if (with_acc == 0) {
162 mbedtls_mps_reader_init(&rd, NULL, 0);
163 } else {
164 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
165 }
166 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000167 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100169 TEST_MEMORY_COMPARE(tmp, 10, buf, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100171 TEST_MEMORY_COMPARE(tmp, 70, buf + 10, 70);
Gilles Peskine449bd832023-01-11 14:50:10 +0100172 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, &tmp_len) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100173 TEST_MEMORY_COMPARE(tmp, tmp_len, buf + 80, 20);
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000175 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100176 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Paul Elliott078edc22023-10-20 19:14:46 +0100177
178exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 mbedtls_mps_reader_free(&rd);
Hanno Beckerdbd8a962021-01-12 08:01:16 +0000180}
181/* END_CASE */
Hanno Becker7973b2d2021-01-12 08:11:40 +0000182
183/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100184void mbedtls_mps_reader_no_pausing_multiple_steps_multiple_rounds(int with_acc)
Hanno Becker7973b2d2021-01-12 08:11:40 +0000185{
186 /* This test exercises one round of fetching a buffer in multiple chunks
187 * and passing it back to the producer afterwards, followed by another
188 * single-step sequence of feed-fetch-commit-reclaim.
189 */
190 unsigned char bufA[100], bufB[100];
191 unsigned char acc[10];
192 unsigned char *tmp;
193 mbedtls_mps_size_t tmp_len;
Hanno Becker88993962021-01-28 09:45:47 +0000194 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker7973b2d2021-01-12 08:11:40 +0000196 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100197 }
198 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
199 bufB[i] = ~((unsigned char) i);
200 }
Hanno Becker7973b2d2021-01-12 08:11:40 +0000201
202 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 if (with_acc == 0) {
204 mbedtls_mps_reader_init(&rd, NULL, 0);
205 } else {
206 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
207 }
208 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000209 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100211 TEST_MEMORY_COMPARE(tmp, 10, bufA, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100213 TEST_MEMORY_COMPARE(tmp, 70, bufA + 10, 70);
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, &tmp_len) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100215 TEST_MEMORY_COMPARE(tmp, tmp_len, bufA + 80, 20);
Gilles Peskine449bd832023-01-11 14:50:10 +0100216 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000217 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
219 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000220 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100222 TEST_MEMORY_COMPARE(tmp, 100, bufB, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000224 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Paul Elliott078edc22023-10-20 19:14:46 +0100226
227exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 mbedtls_mps_reader_free(&rd);
Hanno Becker7973b2d2021-01-12 08:11:40 +0000229}
230/* END_CASE */
Hanno Becker7d86b742021-01-12 08:14:38 +0000231
232/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
233void mbedtls_mps_reader_pausing_needed_disabled()
234{
Hanno Becker5047b562021-02-22 16:52:02 +0000235 /* This test exercises the behaviour of the MPS reader when a read request
Hanno Becker7d86b742021-01-12 08:14:38 +0000236 * of the consumer exceeds what has been provided by the producer, and when
237 * no accumulator is available in the reader.
238 *
239 * In this case, we expect the reader to fail.
240 */
241
242 unsigned char buf[100];
243 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000244 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Becker7d86b742021-01-12 08:14:38 +0000246 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 }
Hanno Becker7d86b742021-01-12 08:14:38 +0000248
249 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 mbedtls_mps_reader_init(&rd, NULL, 0);
251 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Becker7d86b742021-01-12 08:14:38 +0000252 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100254 TEST_MEMORY_COMPARE(tmp, 50, buf, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
256 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) ==
257 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Becker7d86b742021-01-12 08:14:38 +0000258 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
260 MBEDTLS_ERR_MPS_READER_NEED_ACCUMULATOR);
Paul Elliott078edc22023-10-20 19:14:46 +0100261
262exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_mps_reader_free(&rd);
Hanno Becker7d86b742021-01-12 08:14:38 +0000264}
265/* END_CASE */
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000266
267/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
268void mbedtls_mps_reader_pausing_needed_buffer_too_small()
269{
270 /* This test exercises the behaviour of the MPS reader with accumulator
Hanno Becker5047b562021-02-22 16:52:02 +0000271 * in the situation where a read request goes beyond the bounds of the
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000272 * current read buffer, _and_ the reader's accumulator is too small to
273 * hold the requested amount of data.
274 *
Hanno Becker014f6832021-02-08 06:52:21 +0000275 * In this case, we expect mbedtls_mps_reader_reclaim() to fail,
276 * but it should be possible to continue fetching data as if
277 * there had been no excess request via mbedtls_mps_reader_get()
278 * and the call to mbedtls_mps_reader_reclaim() had been rejected
279 * because of data remaining.
280 */
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000281
282 unsigned char buf[100];
283 unsigned char acc[10];
284 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000285 mbedtls_mps_reader rd;
Hanno Becker014f6832021-02-08 06:52:21 +0000286 mbedtls_mps_size_t tmp_len;
287
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000289 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 }
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000291
292 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
294 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000295 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100297 TEST_MEMORY_COMPARE(tmp, 50, buf, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
299 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100300 TEST_MEMORY_COMPARE(tmp, 10, buf + 50, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) ==
302 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000303 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
305 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Becker014f6832021-02-08 06:52:21 +0000306
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, &tmp_len) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100308 TEST_MEMORY_COMPARE(tmp, tmp_len, buf + 50, 50);
Hanno Becker014f6832021-02-08 06:52:21 +0000309
Paul Elliott078edc22023-10-20 19:14:46 +0100310exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 mbedtls_mps_reader_free(&rd);
Hanno Beckercaf1a3f2021-01-12 08:18:12 +0000312}
313/* END_CASE */
Hanno Beckere82952a2021-01-12 08:27:29 +0000314
315/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000316void mbedtls_mps_reader_reclaim_overflow()
317{
318 /* This test exercises the behaviour of the MPS reader with accumulator
319 * in the situation where upon calling mbedtls_mps_reader_reclaim(), the
320 * uncommitted data together with the excess data missing in the last
Tom Cosgrove1797b052022-12-04 17:19:59 +0000321 * call to mbedtls_mps_reader_get() exceeds the bounds of the type
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000322 * holding the buffer length.
323 */
324
325 unsigned char buf[100];
326 unsigned char acc[50];
327 unsigned char *tmp;
328 mbedtls_mps_reader rd;
329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Becker5b3841d2021-03-19 05:23:30 +0000331 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 }
Hanno Becker5b3841d2021-03-19 05:23:30 +0000333
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000334 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
336 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000337 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100339 TEST_MEMORY_COMPARE(tmp, 50, buf, 50);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000340 /* Excess request */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 TEST_ASSERT(mbedtls_mps_reader_get(&rd, (mbedtls_mps_size_t) -1, &tmp, NULL) ==
342 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000343 /* Wrapup (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
345 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000346
Paul Elliott078edc22023-10-20 19:14:46 +0100347exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 mbedtls_mps_reader_free(&rd);
Hanno Becker1b1e7eb2021-03-08 16:57:08 +0000349}
350/* END_CASE */
351
352/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100353void mbedtls_mps_reader_pausing(int option)
Hanno Beckere82952a2021-01-12 08:27:29 +0000354{
355 /* This test exercises the behaviour of the reader when the
Hanno Becker756abeb2021-03-08 16:28:09 +0000356 * accumulator is used to fulfill a consumer's request.
Hanno Beckere82952a2021-01-12 08:27:29 +0000357 *
358 * More detailed:
359 * - The producer feeds some data.
360 * - The consumer asks for more data than what's available.
361 * - The reader remembers the request and goes back to
362 * producing mode, waiting for more data from the producer.
363 * - The producer provides another chunk of data which is
364 * sufficient to fulfill the original read request.
365 * - The consumer retries the original read request, which
366 * should now succeed.
367 *
368 * This test comes in multiple variants controlled by the
369 * `option` parameter and documented below.
370 */
371
372 unsigned char bufA[100], bufB[100];
373 unsigned char *tmp;
374 unsigned char acc[40];
Hanno Beckerd7fcbfa2021-03-08 16:25:38 +0000375 int paused;
Hanno Becker88993962021-01-28 09:45:47 +0000376 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Beckere82952a2021-01-12 08:27:29 +0000378 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 }
380 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
381 bufB[i] = ~((unsigned char) i);
382 }
Hanno Beckere82952a2021-01-12 08:27:29 +0000383
384 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
386 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000387
388 /* Consumption (upper layer) */
389 /* Ask for more than what's available. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100391 TEST_MEMORY_COMPARE(tmp, 80, bufA, 80);
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
393 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100394 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 switch (option) {
Hanno Beckere82952a2021-01-12 08:27:29 +0000396 case 0: /* Single uncommitted fetch at pausing */
397 case 1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000399 break;
400 default: /* Multiple uncommitted fetches at pausing */
401 break;
402 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
404 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckere82952a2021-01-12 08:27:29 +0000405
406 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, &paused) == 0);
408 TEST_ASSERT(paused == 1);
409 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000410
411 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 switch (option) {
Hanno Beckere82952a2021-01-12 08:27:29 +0000413 case 0: /* Single fetch at pausing, re-fetch with commit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100415 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
416 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000418 break;
419
420 case 1: /* Single fetch at pausing, re-fetch without commit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100422 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
423 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Hanno Beckere82952a2021-01-12 08:27:29 +0000424 break;
425
426 case 2: /* Multiple fetches at pausing, repeat without commit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100428 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100430 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
431 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Hanno Beckere82952a2021-01-12 08:27:29 +0000432 break;
433
434 case 3: /* Multiple fetches at pausing, repeat with commit 1. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100436 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
438 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100439 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
440 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Hanno Beckere82952a2021-01-12 08:27:29 +0000441 break;
442
443 case 4: /* Multiple fetches at pausing, repeat with commit 2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100445 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100447 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
448 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000450 break;
451
452 case 5: /* Multiple fetches at pausing, repeat with commit 3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100454 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
456 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100457 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
458 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000460 break;
461
462 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 TEST_ASSERT(0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000464 }
465
466 /* In all cases, fetch the rest of the second buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 90, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100468 TEST_MEMORY_COMPARE(tmp, 90, bufB + 10, 90);
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere82952a2021-01-12 08:27:29 +0000470
471 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Paul Elliott078edc22023-10-20 19:14:46 +0100473
474exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 mbedtls_mps_reader_free(&rd);
Hanno Beckere82952a2021-01-12 08:27:29 +0000476}
477/* END_CASE */
Hanno Beckeraac41222021-01-12 08:36:36 +0000478
479/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100480void mbedtls_mps_reader_pausing_multiple_feeds(int option)
Hanno Beckeraac41222021-01-12 08:36:36 +0000481{
482 /* This test exercises the behaviour of the MPS reader
483 * in the following situation:
Hanno Becker5047b562021-02-22 16:52:02 +0000484 * - The consumer has asked for more than what's available, so the
Hanno Beckeraac41222021-01-12 08:36:36 +0000485 * reader pauses and waits for further input data via
Hanno Becker88993962021-01-28 09:45:47 +0000486 * `mbedtls_mps_reader_feed()`
487 * - Multiple such calls to `mbedtls_mps_reader_feed()` are necessary
Hanno Beckeraac41222021-01-12 08:36:36 +0000488 * to fulfill the original request, and the reader needs to do
489 * the necessary bookkeeping under the hood.
490 *
491 * This test comes in a few variants differing in the number and
492 * size of feed calls that the producer issues while the reader is
493 * accumulating the necessary data - see the comments below.
494 */
495
496 unsigned char bufA[100], bufB[100];
497 unsigned char *tmp;
498 unsigned char acc[70];
Hanno Becker88993962021-01-28 09:45:47 +0000499 mbedtls_mps_reader rd;
Hanno Beckeraac41222021-01-12 08:36:36 +0000500 mbedtls_mps_size_t fetch_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Beckeraac41222021-01-12 08:36:36 +0000502 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 }
504 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
505 bufB[i] = ~((unsigned char) i);
506 }
Hanno Beckeraac41222021-01-12 08:36:36 +0000507
508 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
510 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000511
512 /* Consumption (upper layer) */
513 /* Ask for more than what's available. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100515 TEST_MEMORY_COMPARE(tmp, 80, bufA, 80);
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000517 /* 20 left, ask for 70 -> 50 overhead */
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) ==
519 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckeraac41222021-01-12 08:36:36 +0000520
521 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
523 switch (option) {
Hanno Beckeraac41222021-01-12 08:36:36 +0000524 case 0: /* 10 + 10 + 80 byte feed */
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, 10) ==
526 MBEDTLS_ERR_MPS_READER_NEED_MORE);
527 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 10, 10) ==
528 MBEDTLS_ERR_MPS_READER_NEED_MORE);
529 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 20, 80) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000530 break;
531
532 case 1: /* 50 x 1byte */
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 for (size_t num_feed = 0; num_feed < 49; num_feed++) {
534 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + num_feed, 1) ==
535 MBEDTLS_ERR_MPS_READER_NEED_MORE);
Hanno Beckeraac41222021-01-12 08:36:36 +0000536 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 49, 1) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000538 break;
539
540 case 2: /* 49 x 1byte + 51bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 for (size_t num_feed = 0; num_feed < 49; num_feed++) {
542 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + num_feed, 1) ==
543 MBEDTLS_ERR_MPS_READER_NEED_MORE);
Hanno Beckeraac41222021-01-12 08:36:36 +0000544 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB + 49, 51) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000546 break;
547
548 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 TEST_ASSERT(0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000550 break;
551 }
552
553 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 70, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100555 TEST_MEMORY_COMPARE(tmp, 20, bufA + 80, 20);
556 TEST_MEMORY_COMPARE(tmp + 20, 50, bufB, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 1000, &tmp, &fetch_len) == 0);
558 switch (option) {
Hanno Beckeraac41222021-01-12 08:36:36 +0000559 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 TEST_ASSERT(fetch_len == 50);
Hanno Beckeraac41222021-01-12 08:36:36 +0000561 break;
562
563 case 1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 TEST_ASSERT(fetch_len == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000565 break;
566
567 case 2:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 TEST_ASSERT(fetch_len == 50);
Hanno Beckeraac41222021-01-12 08:36:36 +0000569 break;
570
571 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 TEST_ASSERT(0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000573 break;
574 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckeraac41222021-01-12 08:36:36 +0000576
577 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Paul Elliott078edc22023-10-20 19:14:46 +0100579
580exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 mbedtls_mps_reader_free(&rd);
Hanno Beckeraac41222021-01-12 08:36:36 +0000582}
583/* END_CASE */
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000584
585
586/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100587void mbedtls_mps_reader_reclaim_data_left(int option)
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000588{
589 /* This test exercises the behaviour of the MPS reader when a
Hanno Becker88993962021-01-28 09:45:47 +0000590 * call to mbedtls_mps_reader_reclaim() is made before all data
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000591 * provided by the producer has been fetched and committed. */
592
593 unsigned char buf[100];
594 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000595 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000597 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 }
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000599
600 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 mbedtls_mps_reader_init(&rd, NULL, 0);
602 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000603
604 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 switch (option) {
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000606 case 0:
607 /* Fetch (but not commit) the entire buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf), &tmp, NULL)
609 == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100610 TEST_MEMORY_COMPARE(tmp, 100, buf, 100);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000611 break;
612
613 case 1:
614 /* Fetch (but not commit) parts of the buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf) / 2,
616 &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100617 TEST_MEMORY_COMPARE(tmp, sizeof(buf) / 2, buf, sizeof(buf) / 2);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000618 break;
619
620 case 2:
621 /* Fetch and commit parts of the buffer, then
622 * fetch but not commit the rest of the buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf) / 2,
624 &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100625 TEST_MEMORY_COMPARE(tmp, sizeof(buf) / 2, buf, sizeof(buf) / 2);
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
627 TEST_ASSERT(mbedtls_mps_reader_get(&rd, sizeof(buf) / 2,
628 &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100629 TEST_MEMORY_COMPARE(tmp, sizeof(buf) / 2,
Tom Cosgrove0540fe72023-07-27 14:17:27 +0100630 buf + sizeof(buf) / 2,
631 sizeof(buf) / 2);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000632 break;
633
634 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 TEST_ASSERT(0);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000636 break;
637 }
638
639 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
641 MBEDTLS_ERR_MPS_READER_DATA_LEFT);
Paul Elliott078edc22023-10-20 19:14:46 +0100642
643exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 mbedtls_mps_reader_free(&rd);
Hanno Beckercb2a88e2021-01-12 08:39:37 +0000645}
646/* END_CASE */
Hanno Beckere1f173c2021-01-12 08:43:58 +0000647
648/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
649void mbedtls_mps_reader_reclaim_data_left_retry()
650{
651 /* This test exercises the behaviour of the MPS reader when an attempt
652 * by the producer to reclaim the reader fails because of more data pending
653 * to be processed, and the consumer subsequently fetches more data. */
654 unsigned char buf[100];
655 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +0000656 mbedtls_mps_reader rd;
Hanno Beckere1f173c2021-01-12 08:43:58 +0000657
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Beckere1f173c2021-01-12 08:43:58 +0000659 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100660 }
Hanno Beckere1f173c2021-01-12 08:43:58 +0000661
662 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100663 mbedtls_mps_reader_init(&rd, NULL, 0);
664 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000665 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100667 TEST_MEMORY_COMPARE(tmp, 50, buf, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
669 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100670 TEST_MEMORY_COMPARE(tmp, 50, buf + 50, 50);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000671 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
673 MBEDTLS_ERR_MPS_READER_DATA_LEFT);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000674 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100676 TEST_MEMORY_COMPARE(tmp, 50, buf + 50, 50);
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000678 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
680 mbedtls_mps_reader_free(&rd);
Hanno Beckere1f173c2021-01-12 08:43:58 +0000681}
682/* END_CASE */
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000683
684/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100685void mbedtls_mps_reader_multiple_pausing(int option)
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000686{
687 /* This test exercises the behaviour of the MPS reader
688 * in the following situation:
Hanno Becker88993962021-01-28 09:45:47 +0000689 * - A read request via `mbedtls_mps_reader_get()` can't
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000690 * be served and the reader is paused to accumulate
691 * the desired amount of data from the producer.
Hanno Becker5047b562021-02-22 16:52:02 +0000692 * - Once enough data is available, the consumer successfully
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000693 * reads the data from the reader, but afterwards exceeds
694 * the available data again - pausing is necessary for a
695 * second time.
696 */
697
698 unsigned char bufA[100], bufB[20], bufC[10];
699 unsigned char *tmp;
700 unsigned char acc[50];
701 mbedtls_mps_size_t tmp_len;
Hanno Becker88993962021-01-28 09:45:47 +0000702 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000704 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 }
706 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
707 bufB[i] = ~((unsigned char) i);
708 }
709 for (size_t i = 0; (unsigned) i < sizeof(bufC); i++) {
710 bufC[i] = ~((unsigned char) i);
711 }
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000712
713 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
715 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000716
717 /* Consumption (upper layer) */
718 /* Ask for more than what's available. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100720 TEST_MEMORY_COMPARE(tmp, 80, bufA, 80);
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
722 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100723 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
725 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000726
727 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
729 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 switch (option) {
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000732 case 0: /* Fetch same chunks, commit afterwards, and
733 * then exceed bounds of new buffer; accumulator
734 * large enough. */
735
736 /* Consume */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, &tmp_len) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100738 TEST_MEMORY_COMPARE(tmp, tmp_len, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100740 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
741 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
743 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
744 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000745
746 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
748 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufC, sizeof(bufC)) == 0);;
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000749
750 /* Consume */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100752 TEST_MEMORY_COMPARE(tmp, 10, bufB + 10, 10);
753 TEST_MEMORY_COMPARE(tmp + 10, 10, bufC, 10);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000754 break;
755
756 case 1: /* Fetch same chunks, commit afterwards, and
757 * then exceed bounds of new buffer; accumulator
758 * not large enough. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100760 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100762 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
763 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
765 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 51, &tmp, NULL) ==
766 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000767
768 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
770 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000771 break;
772
773 case 2: /* Fetch same chunks, don't commit afterwards, and
774 * then exceed bounds of new buffer; accumulator
775 * large enough. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100777 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100779 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
780 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
782 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000783
784 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
786 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufC, sizeof(bufC)) == 0);;
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000787
788 /* Consume */
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 50, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100790 TEST_MEMORY_COMPARE(tmp, 20, bufA + 80, 20);
791 TEST_MEMORY_COMPARE(tmp + 20, 20, bufB, 20);
792 TEST_MEMORY_COMPARE(tmp + 40, 10, bufC, 10);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000793 break;
794
795 case 3: /* Fetch same chunks, don't commit afterwards, and
796 * then exceed bounds of new buffer; accumulator
797 * not large enough. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100799 TEST_MEMORY_COMPARE(tmp, 10, bufA + 80, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +0100801 TEST_MEMORY_COMPARE(tmp, 10, bufA + 90, 10);
802 TEST_MEMORY_COMPARE(tmp + 10, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +0100803 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 21, &tmp, NULL) ==
804 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000805
806 /* Prepare */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) ==
808 MBEDTLS_ERR_MPS_READER_ACCUMULATOR_TOO_SMALL);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000809 break;
810
811 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 TEST_ASSERT(0);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000813 break;
814 }
815
Paul Elliott078edc22023-10-20 19:14:46 +0100816exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 mbedtls_mps_reader_free(&rd);
Hanno Beckerb6fdd352021-01-12 09:17:56 +0000818}
819/* END_CASE */
Hanno Becker714cbeb2021-01-12 09:23:15 +0000820
821/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER:MBEDTLS_MPS_STATE_VALIDATION */
Gilles Peskine449bd832023-01-11 14:50:10 +0100822void mbedtls_mps_reader_random_usage(int num_out_chunks,
823 int max_chunk_size,
824 int max_request,
825 int acc_size)
Hanno Becker714cbeb2021-01-12 09:23:15 +0000826
827{
828 /* Randomly pass a reader object back and forth between lower and
829 * upper layer and let each of them call the respective reader API
830 * functions in a random fashion.
831 *
832 * On the lower layer, we're tracking and concatenating
833 * the data passed to successful feed calls.
834 *
835 * For the upper layer, we track and concatenate buffers
836 * obtained from successful get calls.
837 *
838 * As long as the lower layer calls reclaim at least once, (resetting the
839 * fetched but not-yet-committed data), this should always lead to the same
840 * stream of outgoing/incoming data for the lower/upper layers, even if
841 * most of the random calls fail.
842 *
843 * NOTE: This test uses rand() for random data, which is not optimal.
844 * Instead, it would be better to get the random data from a
845 * static buffer. This both eases reproducibility and allows
846 * simple conversion to a fuzz target.
847 */
848 int ret;
849 unsigned char *acc = NULL;
850 unsigned char *outgoing = NULL, *incoming = NULL;
851 unsigned char *cur_chunk = NULL;
852 size_t cur_out_chunk, out_pos, in_commit, in_fetch;
853 int rand_op; /* Lower layer:
854 * - Reclaim (0)
855 * - Feed (1)
856 * Upper layer:
857 * - Get, do tolerate smaller output (0)
858 * - Get, don't tolerate smaller output (1)
859 * - Commit (2) */
860 int mode = 0; /* Lower layer (0) or Upper layer (1) */
861 int reclaimed = 1; /* Have to call reclaim at least once before
862 * returning the reader to the upper layer. */
Hanno Becker88993962021-01-28 09:45:47 +0000863 mbedtls_mps_reader rd;
Hanno Becker714cbeb2021-01-12 09:23:15 +0000864
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 if (acc_size > 0) {
Tom Cosgrove05b2a872023-07-21 11:31:13 +0100866 TEST_CALLOC(acc, acc_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000867 }
868
869 /* This probably needs to be changed because we want
870 * our tests to be deterministic. */
871 // srand( time( NULL ) );
872
Tom Cosgrove05b2a872023-07-21 11:31:13 +0100873 TEST_CALLOC(outgoing, num_out_chunks * max_chunk_size);
874 TEST_CALLOC(incoming, num_out_chunks * max_chunk_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000875
Gilles Peskine449bd832023-01-11 14:50:10 +0100876 mbedtls_mps_reader_init(&rd, acc, acc_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000877
878 cur_out_chunk = 0;
879 in_commit = 0;
880 in_fetch = 0;
881 out_pos = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 while (cur_out_chunk < (unsigned) num_out_chunks) {
883 if (mode == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000884 /* Choose randomly between reclaim and feed */
885 rand_op = rand() % 2;
886
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 if (rand_op == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000888 /* Reclaim */
Gilles Peskine449bd832023-01-11 14:50:10 +0100889 ret = mbedtls_mps_reader_reclaim(&rd, NULL);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000890
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 if (ret == 0) {
892 TEST_ASSERT(cur_chunk != NULL);
893 mbedtls_free(cur_chunk);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000894 cur_chunk = NULL;
895 }
896 reclaimed = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 } else {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000898 /* Feed reader with a random chunk */
899 unsigned char *tmp = NULL;
900 size_t tmp_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 if (cur_out_chunk == (unsigned) num_out_chunks) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000902 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 }
Hanno Becker714cbeb2021-01-12 09:23:15 +0000904
Gilles Peskine449bd832023-01-11 14:50:10 +0100905 tmp_size = (rand() % max_chunk_size) + 1;
Tom Cosgrove05b2a872023-07-21 11:31:13 +0100906 TEST_CALLOC(tmp, tmp_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000907
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 TEST_ASSERT(mbedtls_test_rnd_std_rand(NULL, tmp, tmp_size) == 0);
909 ret = mbedtls_mps_reader_feed(&rd, tmp, tmp_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 if (ret == 0 || ret == MBEDTLS_ERR_MPS_READER_NEED_MORE) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000912 cur_out_chunk++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 memcpy(outgoing + out_pos, tmp, tmp_size);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000914 out_pos += tmp_size;
915 }
916
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if (ret == 0) {
918 TEST_ASSERT(cur_chunk == NULL);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000919 cur_chunk = tmp;
Gilles Peskine449bd832023-01-11 14:50:10 +0100920 } else {
921 mbedtls_free(tmp);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000922 }
923
924 }
925
926 /* Randomly switch to consumption mode if reclaim
927 * was called at least once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 if (reclaimed == 1 && rand() % 3 == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000929 in_fetch = 0;
930 mode = 1;
931 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 } else {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000933 /* Choose randomly between get tolerating fewer data,
934 * get not tolerating fewer data, and commit. */
935 rand_op = rand() % 3;
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 if (rand_op == 0 || rand_op == 1) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000937 mbedtls_mps_size_t get_size, real_size;
938 unsigned char *chunk_get;
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 get_size = (rand() % max_request) + 1;
940 if (rand_op == 0) {
941 ret = mbedtls_mps_reader_get(&rd, get_size, &chunk_get,
942 &real_size);
943 } else {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000944 real_size = get_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 ret = mbedtls_mps_reader_get(&rd, get_size, &chunk_get, NULL);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000946 }
947
948 /* Check if output is in accordance with what was written */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (ret == 0) {
950 memcpy(incoming + in_commit + in_fetch,
951 chunk_get, real_size);
952 TEST_ASSERT(memcmp(incoming + in_commit + in_fetch,
953 outgoing + in_commit + in_fetch,
954 real_size) == 0);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000955 in_fetch += real_size;
956 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 } else if (rand_op == 2) { /* Commit */
958 ret = mbedtls_mps_reader_commit(&rd);
959 if (ret == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000960 in_commit += in_fetch;
961 in_fetch = 0;
962 }
963 }
964
965 /* Randomly switch back to preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 if (rand() % 3 == 0) {
Hanno Becker714cbeb2021-01-12 09:23:15 +0000967 reclaimed = 0;
968 mode = 0;
969 }
970 }
971 }
972
Paul Elliott078edc22023-10-20 19:14:46 +0100973exit:
Hanno Becker714cbeb2021-01-12 09:23:15 +0000974 /* Cleanup */
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_mps_reader_free(&rd);
976 mbedtls_free(incoming);
977 mbedtls_free(outgoing);
978 mbedtls_free(acc);
979 mbedtls_free(cur_chunk);
Hanno Becker714cbeb2021-01-12 09:23:15 +0000980}
981/* END_CASE */
Hanno Becker223b72e2021-01-12 09:31:31 +0000982
983/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Gilles Peskine449bd832023-01-11 14:50:10 +0100984void mbedtls_reader_inconsistent_usage(int option)
Hanno Becker223b72e2021-01-12 09:31:31 +0000985{
986 /* This test exercises the behaviour of the MPS reader
987 * in the following situation:
988 * - The consumer asks for more data than what's available
989 * - The reader is paused and receives more data from the
990 * producer until the original read request can be fulfilled.
991 * - The consumer does not repeat the original request but
992 * requests data in a different way.
993 *
994 * The reader does not guarantee that inconsistent read requests
995 * after pausing will succeed, and this test triggers some cases
996 * where the request fails.
997 */
998
999 unsigned char bufA[100], bufB[100];
1000 unsigned char *tmp;
1001 unsigned char acc[40];
Hanno Becker88993962021-01-28 09:45:47 +00001002 mbedtls_mps_reader rd;
Hanno Becker223b72e2021-01-12 09:31:31 +00001003 int success = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 for (size_t i = 0; (unsigned) i < sizeof(bufA); i++) {
Hanno Becker223b72e2021-01-12 09:31:31 +00001005 bufA[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 }
1007 for (size_t i = 0; (unsigned) i < sizeof(bufB); i++) {
1008 bufB[i] = ~((unsigned char) i);
1009 }
Hanno Becker223b72e2021-01-12 09:31:31 +00001010
1011 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_mps_reader_init(&rd, acc, sizeof(acc));
1013 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufA, sizeof(bufA)) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001014 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 80, &tmp, NULL) == 0);
1016 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
1017 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) == 0);
1018 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 20, &tmp, NULL) ==
1019 MBEDTLS_ERR_MPS_READER_OUT_OF_DATA);
Hanno Becker223b72e2021-01-12 09:31:31 +00001020 /* Preparation */
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
1022 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, bufB, sizeof(bufB)) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001023 /* Consumption */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 switch (option) {
Hanno Becker223b72e2021-01-12 09:31:31 +00001025 case 0:
1026 /* Ask for buffered data in a single chunk, no commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001028 TEST_MEMORY_COMPARE(tmp, 20, bufA + 80, 20);
1029 TEST_MEMORY_COMPARE(tmp + 20, 10, bufB, 10);
Hanno Becker223b72e2021-01-12 09:31:31 +00001030 success = 1;
1031 break;
1032
1033 case 1:
1034 /* Ask for buffered data in a single chunk, with commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 30, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001036 TEST_MEMORY_COMPARE(tmp, 20, bufA + 80, 20);
1037 TEST_MEMORY_COMPARE(tmp + 20, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001039 success = 1;
1040 break;
1041
1042 case 2:
1043 /* Ask for more than was requested when pausing, #1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 31, &tmp, NULL) ==
1045 MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS);
Hanno Becker223b72e2021-01-12 09:31:31 +00001046 break;
1047
1048 case 3:
1049 /* Ask for more than was requested when pausing #2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 TEST_ASSERT(mbedtls_mps_reader_get(&rd, (mbedtls_mps_size_t) -1, &tmp, NULL) ==
1051 MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS);
Hanno Becker223b72e2021-01-12 09:31:31 +00001052 break;
1053
1054 case 4:
1055 /* Asking for buffered data in different
1056 * chunks than before CAN fail. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001058 TEST_MEMORY_COMPARE(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 10, &tmp, NULL) ==
1060 MBEDTLS_ERR_MPS_READER_INCONSISTENT_REQUESTS);
Hanno Becker223b72e2021-01-12 09:31:31 +00001061 break;
1062
1063 case 5:
1064 /* Asking for buffered data different chunks
1065 * than before NEED NOT fail - no commits */
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001067 TEST_MEMORY_COMPARE(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001069 TEST_MEMORY_COMPARE(tmp, 5, bufA + 95, 5);
1070 TEST_MEMORY_COMPARE(tmp + 5, 10, bufB, 10);
Hanno Becker223b72e2021-01-12 09:31:31 +00001071 success = 1;
1072 break;
1073
1074 case 6:
1075 /* Asking for buffered data different chunks
1076 * than before NEED NOT fail - intermediate commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001078 TEST_MEMORY_COMPARE(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
1080 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001081 TEST_MEMORY_COMPARE(tmp, 5, bufA + 95, 5);
1082 TEST_MEMORY_COMPARE(tmp + 5, 10, bufB, 10);
Hanno Becker223b72e2021-01-12 09:31:31 +00001083 success = 1;
1084 break;
1085
1086 case 7:
1087 /* Asking for buffered data different chunks
1088 * than before NEED NOT fail - end commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001090 TEST_MEMORY_COMPARE(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001092 TEST_MEMORY_COMPARE(tmp, 5, bufA + 95, 5);
1093 TEST_MEMORY_COMPARE(tmp + 5, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001095 success = 1;
1096 break;
1097
1098 case 8:
1099 /* Asking for buffered data different chunks
1100 * than before NEED NOT fail - intermediate & end commit */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001102 TEST_MEMORY_COMPARE(tmp, 15, bufA + 80, 15);
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 15, &tmp, NULL) == 0);
1104 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001105 TEST_MEMORY_COMPARE(tmp, 5, bufA + 95, 5);
1106 TEST_MEMORY_COMPARE(tmp + 5, 10, bufB, 10);
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001108 success = 1;
1109 break;
1110
1111 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 TEST_ASSERT(0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001113 break;
1114 }
1115
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 if (success == 1) {
Hanno Becker223b72e2021-01-12 09:31:31 +00001117 /* In all succeeding cases, fetch the rest of the second buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 90, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001119 TEST_MEMORY_COMPARE(tmp, 90, bufB + 10, 90);
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001121
1122 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Hanno Becker223b72e2021-01-12 09:31:31 +00001124 }
1125
Paul Elliott078edc22023-10-20 19:14:46 +01001126exit:
Hanno Becker223b72e2021-01-12 09:31:31 +00001127 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 mbedtls_mps_reader_free(&rd);
Hanno Becker223b72e2021-01-12 09:31:31 +00001129}
1130/* END_CASE */
Hanno Becker2b8bad32021-01-12 09:40:05 +00001131
1132/* BEGIN_CASE depends_on:TEST_SUITE_MPS_READER */
Hanno Becker15da2fc2021-02-22 16:57:14 +00001133void mbedtls_mps_reader_feed_empty()
Hanno Becker2b8bad32021-01-12 09:40:05 +00001134{
1135 /* This test exercises the behaviour of the reader when it is
Hanno Becker5047b562021-02-22 16:52:02 +00001136 * fed with a NULL buffer. */
Hanno Becker2b8bad32021-01-12 09:40:05 +00001137 unsigned char buf[100];
1138 unsigned char *tmp;
Hanno Becker88993962021-01-28 09:45:47 +00001139 mbedtls_mps_reader rd;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 for (size_t i = 0; (unsigned) i < sizeof(buf); i++) {
Hanno Becker2b8bad32021-01-12 09:40:05 +00001141 buf[i] = (unsigned char) i;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Hanno Becker2b8bad32021-01-12 09:40:05 +00001143
1144 /* Preparation (lower layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 mbedtls_mps_reader_init(&rd, NULL, 0);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, NULL, sizeof(buf)) ==
1148 MBEDTLS_ERR_MPS_READER_INVALID_ARG);
Hanno Becker15da2fc2021-02-22 16:57:14 +00001149
Hanno Becker2b8bad32021-01-12 09:40:05 +00001150 /* Subsequent feed-calls should still succeed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 TEST_ASSERT(mbedtls_mps_reader_feed(&rd, buf, sizeof(buf)) == 0);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001152
1153 /* Consumption (upper layer) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 TEST_ASSERT(mbedtls_mps_reader_get(&rd, 100, &tmp, NULL) == 0);
Tom Cosgrovee4e9e7d2023-07-21 11:40:20 +01001155 TEST_MEMORY_COMPARE(tmp, 100, buf, 100);
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 TEST_ASSERT(mbedtls_mps_reader_commit(&rd) == 0);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001157
1158 /* Wrapup */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 TEST_ASSERT(mbedtls_mps_reader_reclaim(&rd, NULL) == 0);
Paul Elliott078edc22023-10-20 19:14:46 +01001160
1161exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 mbedtls_mps_reader_free(&rd);
Hanno Becker2b8bad32021-01-12 09:40:05 +00001163}
1164/* END_CASE */