blob: f5a8412591863830a708aa85dfda535716dec9f0 [file] [log] [blame]
Yanray Wang47907a42022-10-24 14:42:01 +08001/** \file ssl_helpers.c
2 *
3 * \brief Helper functions to set up a TLS connection.
4 */
5
6/*
7 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Yanray Wang47907a42022-10-24 14:42:01 +08009 */
10
11#include <test/ssl_helpers.h>
Valerio Setti384fbde2024-01-02 13:26:40 +010012#include "mbedtls/psa_util.h"
Yanray Wange6afd912022-10-27 12:11:18 +080013
Yanray Wang4d07d1c2022-10-27 15:28:16 +080014#if defined(MBEDTLS_SSL_TLS_C)
Ronald Cron10b040f2024-02-05 09:38:09 +010015int mbedtls_test_random(void *p_rng, unsigned char *output, size_t output_len)
Yanray Wange6afd912022-10-27 12:11:18 +080016{
17 (void) p_rng;
18 for (size_t i = 0; i < output_len; i++) {
19 output[i] = rand();
20 }
21
22 return 0;
23}
Yanray Wange6afd912022-10-27 12:11:18 +080024
Yanray Wange6afd912022-10-27 12:11:18 +080025void mbedtls_test_ssl_log_analyzer(void *ctx, int level,
26 const char *file, int line,
27 const char *str)
28{
29 mbedtls_test_ssl_log_pattern *p = (mbedtls_test_ssl_log_pattern *) ctx;
30
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010031/* Change 0 to 1 for debugging of test cases that use this function. */
32#if 0
33 const char *q, *basename;
34 /* Extract basename from file */
35 for (q = basename = file; *q != '\0'; q++) {
36 if (*q == '/' || *q == '\\') {
37 basename = q + 1;
38 }
39 }
40 printf("%s:%04d: |%d| %s",
41 basename, line, level, str);
42#else
Yanray Wange6afd912022-10-27 12:11:18 +080043 (void) level;
44 (void) line;
45 (void) file;
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010046#endif
Yanray Wange6afd912022-10-27 12:11:18 +080047
48 if (NULL != p &&
49 NULL != p->pattern &&
50 NULL != strstr(str, p->pattern)) {
51 p->counter++;
52 }
53}
54
55void mbedtls_test_init_handshake_options(
56 mbedtls_test_handshake_test_options *opts)
57{
58#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron987cf892024-03-04 10:24:27 +010059 static int rng_seed = 0xBEEF;
Yanray Wanga72bc9a2023-12-01 23:34:27 +080060
Yanray Wange6afd912022-10-27 12:11:18 +080061 srand(rng_seed);
62 rng_seed += 0xD0;
63#endif
Ronald Cronb4ad3e72024-01-26 14:57:53 +010064
65 memset(opts, 0, sizeof(*opts));
66
Yanray Wange6afd912022-10-27 12:11:18 +080067 opts->cipher = "";
68 opts->client_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
69 opts->client_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
70 opts->server_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
71 opts->server_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
Ronald Cron097ba142023-03-08 16:18:00 +010072 opts->expected_negotiated_version = MBEDTLS_SSL_VERSION_TLS1_3;
Yanray Wange6afd912022-10-27 12:11:18 +080073 opts->pk_alg = MBEDTLS_PK_RSA;
Yanray Wange6afd912022-10-27 12:11:18 +080074 opts->srv_auth_mode = MBEDTLS_SSL_VERIFY_NONE;
Yanray Wange6afd912022-10-27 12:11:18 +080075 opts->mfl = MBEDTLS_SSL_MAX_FRAG_LEN_NONE;
76 opts->cli_msg_len = 100;
77 opts->srv_msg_len = 100;
78 opts->expected_cli_fragments = 1;
79 opts->expected_srv_fragments = 1;
Yanray Wange6afd912022-10-27 12:11:18 +080080 opts->legacy_renegotiation = MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION;
Yanray Wange6afd912022-10-27 12:11:18 +080081 opts->resize_buffers = 1;
Ronald Cronced99be2024-01-26 15:49:12 +010082 opts->early_data = MBEDTLS_SSL_EARLY_DATA_DISABLED;
Ronald Cron5d3036e2024-02-23 07:43:45 +010083 opts->max_early_data_size = -1;
Yanray Wange6afd912022-10-27 12:11:18 +080084#if defined(MBEDTLS_SSL_CACHE_C)
Tom Cosgrove05b2a872023-07-21 11:31:13 +010085 TEST_CALLOC(opts->cache, 1);
Yanray Wange6afd912022-10-27 12:11:18 +080086 mbedtls_ssl_cache_init(opts->cache);
Pengyu Lv5cbb93e2023-07-10 11:09:40 +080087#if defined(MBEDTLS_HAVE_TIME)
88 TEST_EQUAL(mbedtls_ssl_cache_get_timeout(opts->cache),
89 MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT);
90#endif
Yanray Wange6afd912022-10-27 12:11:18 +080091exit:
92 return;
93#endif
94}
95
96void mbedtls_test_free_handshake_options(
97 mbedtls_test_handshake_test_options *opts)
98{
99#if defined(MBEDTLS_SSL_CACHE_C)
100 mbedtls_ssl_cache_free(opts->cache);
101 mbedtls_free(opts->cache);
102#else
103 (void) opts;
104#endif
105}
106
107#if defined(MBEDTLS_TEST_HOOKS)
108static void set_chk_buf_ptr_args(
109 mbedtls_ssl_chk_buf_ptr_args *args,
110 unsigned char *cur, unsigned char *end, size_t need)
111{
112 args->cur = cur;
113 args->end = end;
114 args->need = need;
115}
116
117static void reset_chk_buf_ptr_args(mbedtls_ssl_chk_buf_ptr_args *args)
118{
119 memset(args, 0, sizeof(*args));
120}
121#endif /* MBEDTLS_TEST_HOOKS */
122
Yanray Wange6afd912022-10-27 12:11:18 +0800123void mbedtls_test_ssl_buffer_init(mbedtls_test_ssl_buffer *buf)
124{
125 memset(buf, 0, sizeof(*buf));
126}
127
Yanray Wange6afd912022-10-27 12:11:18 +0800128int mbedtls_test_ssl_buffer_setup(mbedtls_test_ssl_buffer *buf,
129 size_t capacity)
130{
131 buf->buffer = (unsigned char *) mbedtls_calloc(capacity,
132 sizeof(unsigned char));
133 if (NULL == buf->buffer) {
134 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
135 }
136 buf->capacity = capacity;
137
138 return 0;
139}
140
141void mbedtls_test_ssl_buffer_free(mbedtls_test_ssl_buffer *buf)
142{
143 if (buf->buffer != NULL) {
144 mbedtls_free(buf->buffer);
145 }
146
147 memset(buf, 0, sizeof(*buf));
148}
149
Yanray Wange6afd912022-10-27 12:11:18 +0800150int mbedtls_test_ssl_buffer_put(mbedtls_test_ssl_buffer *buf,
151 const unsigned char *input, size_t input_len)
152{
153 size_t overflow = 0;
154
155 if ((buf == NULL) || (buf->buffer == NULL)) {
156 return -1;
157 }
158
159 /* Reduce input_len to a number that fits in the buffer. */
160 if ((buf->content_length + input_len) > buf->capacity) {
161 input_len = buf->capacity - buf->content_length;
162 }
163
164 if (input == NULL) {
165 return (input_len == 0) ? 0 : -1;
166 }
167
168 /* Check if the buffer has not come full circle and free space is not in
169 * the middle */
170 if (buf->start + buf->content_length < buf->capacity) {
171
172 /* Calculate the number of bytes that need to be placed at lower memory
173 * address */
174 if (buf->start + buf->content_length + input_len
175 > buf->capacity) {
176 overflow = (buf->start + buf->content_length + input_len)
177 % buf->capacity;
178 }
179
180 memcpy(buf->buffer + buf->start + buf->content_length, input,
181 input_len - overflow);
182 memcpy(buf->buffer, input + input_len - overflow, overflow);
183
184 } else {
185 /* The buffer has come full circle and free space is in the middle */
186 memcpy(buf->buffer + buf->start + buf->content_length - buf->capacity,
187 input, input_len);
188 }
189
190 buf->content_length += input_len;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800191 return (input_len > INT_MAX) ? INT_MAX : (int) input_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800192}
193
Yanray Wange6afd912022-10-27 12:11:18 +0800194int mbedtls_test_ssl_buffer_get(mbedtls_test_ssl_buffer *buf,
195 unsigned char *output, size_t output_len)
196{
197 size_t overflow = 0;
198
199 if ((buf == NULL) || (buf->buffer == NULL)) {
200 return -1;
201 }
202
203 if (output == NULL && output_len == 0) {
204 return 0;
205 }
206
207 if (buf->content_length < output_len) {
208 output_len = buf->content_length;
209 }
210
211 /* Calculate the number of bytes that need to be drawn from lower memory
212 * address */
213 if (buf->start + output_len > buf->capacity) {
214 overflow = (buf->start + output_len) % buf->capacity;
215 }
216
217 if (output != NULL) {
218 memcpy(output, buf->buffer + buf->start, output_len - overflow);
219 memcpy(output + output_len - overflow, buf->buffer, overflow);
220 }
221
222 buf->content_length -= output_len;
223 buf->start = (buf->start + output_len) % buf->capacity;
224
Yanray Wanga8f445e2022-11-03 11:51:59 +0800225 return (output_len > INT_MAX) ? INT_MAX : (int) output_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800226}
227
Yanray Wangd19894f2023-03-16 11:47:39 +0800228int mbedtls_test_ssl_message_queue_setup(
229 mbedtls_test_ssl_message_queue *queue, size_t capacity)
Yanray Wange6afd912022-10-27 12:11:18 +0800230{
231 queue->messages = (size_t *) mbedtls_calloc(capacity, sizeof(size_t));
232 if (NULL == queue->messages) {
233 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
234 }
235
Yanray Wanga8f445e2022-11-03 11:51:59 +0800236 queue->capacity = (capacity > INT_MAX) ? INT_MAX : (int) capacity;
Yanray Wange6afd912022-10-27 12:11:18 +0800237 queue->pos = 0;
238 queue->num = 0;
239
240 return 0;
241}
242
Yanray Wangd19894f2023-03-16 11:47:39 +0800243void mbedtls_test_ssl_message_queue_free(
244 mbedtls_test_ssl_message_queue *queue)
Yanray Wange6afd912022-10-27 12:11:18 +0800245{
246 if (queue == NULL) {
247 return;
248 }
249
250 if (queue->messages != NULL) {
251 mbedtls_free(queue->messages);
252 }
253
254 memset(queue, 0, sizeof(*queue));
255}
256
Yanray Wange6afd912022-10-27 12:11:18 +0800257int mbedtls_test_ssl_message_queue_push_info(
258 mbedtls_test_ssl_message_queue *queue, size_t len)
259{
260 int place;
261 if (queue == NULL) {
262 return MBEDTLS_TEST_ERROR_ARG_NULL;
263 }
264
265 if (queue->num >= queue->capacity) {
266 return MBEDTLS_ERR_SSL_WANT_WRITE;
267 }
268
269 place = (queue->pos + queue->num) % queue->capacity;
270 queue->messages[place] = len;
271 queue->num++;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800272 return (len > INT_MAX) ? INT_MAX : (int) len;
Yanray Wange6afd912022-10-27 12:11:18 +0800273}
274
Yanray Wange6afd912022-10-27 12:11:18 +0800275int mbedtls_test_ssl_message_queue_pop_info(
276 mbedtls_test_ssl_message_queue *queue, size_t buf_len)
277{
278 size_t message_length;
279 if (queue == NULL) {
280 return MBEDTLS_TEST_ERROR_ARG_NULL;
281 }
282 if (queue->num == 0) {
283 return MBEDTLS_ERR_SSL_WANT_READ;
284 }
285
286 message_length = queue->messages[queue->pos];
287 queue->messages[queue->pos] = 0;
288 queue->num--;
289 queue->pos++;
290 queue->pos %= queue->capacity;
291 if (queue->pos < 0) {
292 queue->pos += queue->capacity;
293 }
294
Yanray Wanga8f445e2022-11-03 11:51:59 +0800295 return (message_length > INT_MAX && buf_len > INT_MAX) ? INT_MAX :
296 (message_length > buf_len) ? (int) buf_len : (int) message_length;
Yanray Wange6afd912022-10-27 12:11:18 +0800297}
298
299/*
300 * Take a peek on the info about the next message length from the queue.
301 * This will be the oldest inserted message length(fifo).
302 *
303 * \retval MBEDTLS_TEST_ERROR_ARG_NULL, if the queue is null.
304 * \retval MBEDTLS_ERR_SSL_WANT_READ, if the queue is empty.
305 * \retval 0, if the peek was successful.
306 * \retval MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED, if the given buffer length is
307 * too small to fit the message. In this case the \p msg_len will be
308 * set to the full message length so that the
309 * caller knows what portion of the message can be dropped.
310 */
Yanray Wang5e22a922023-03-16 14:57:54 +0800311static int test_ssl_message_queue_peek_info(
312 mbedtls_test_ssl_message_queue *queue,
313 size_t buf_len, size_t *msg_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800314{
315 if (queue == NULL || msg_len == NULL) {
316 return MBEDTLS_TEST_ERROR_ARG_NULL;
317 }
318 if (queue->num == 0) {
319 return MBEDTLS_ERR_SSL_WANT_READ;
320 }
321
322 *msg_len = queue->messages[queue->pos];
323 return (*msg_len > buf_len) ? MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED : 0;
324}
325
Yanray Wang5f86a422023-03-15 16:02:29 +0800326void mbedtls_test_mock_socket_init(mbedtls_test_mock_socket *socket)
Yanray Wange6afd912022-10-27 12:11:18 +0800327{
328 memset(socket, 0, sizeof(*socket));
329}
330
Yanray Wange6afd912022-10-27 12:11:18 +0800331void mbedtls_test_mock_socket_close(mbedtls_test_mock_socket *socket)
332{
333 if (socket == NULL) {
334 return;
335 }
336
337 if (socket->input != NULL) {
338 mbedtls_test_ssl_buffer_free(socket->input);
339 mbedtls_free(socket->input);
340 }
341
342 if (socket->output != NULL) {
343 mbedtls_test_ssl_buffer_free(socket->output);
344 mbedtls_free(socket->output);
345 }
346
347 if (socket->peer != NULL) {
348 memset(socket->peer, 0, sizeof(*socket->peer));
349 }
350
351 memset(socket, 0, sizeof(*socket));
352}
353
Yanray Wange6afd912022-10-27 12:11:18 +0800354int mbedtls_test_mock_socket_connect(mbedtls_test_mock_socket *peer1,
355 mbedtls_test_mock_socket *peer2,
356 size_t bufsize)
357{
358 int ret = -1;
359
360 peer1->output =
361 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
362 1, sizeof(mbedtls_test_ssl_buffer));
363 if (peer1->output == NULL) {
364 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
365 goto exit;
366 }
367 mbedtls_test_ssl_buffer_init(peer1->output);
368 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer1->output, bufsize))) {
369 goto exit;
370 }
371
372 peer2->output =
373 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
374 1, sizeof(mbedtls_test_ssl_buffer));
375 if (peer2->output == NULL) {
376 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
377 goto exit;
378 }
379 mbedtls_test_ssl_buffer_init(peer2->output);
380 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer2->output, bufsize))) {
381 goto exit;
382 }
383
384 peer1->peer = peer2;
385 peer2->peer = peer1;
386 peer1->input = peer2->output;
387 peer2->input = peer1->output;
388
389 peer1->status = peer2->status = MBEDTLS_MOCK_SOCKET_CONNECTED;
390 ret = 0;
391
392exit:
393
394 if (ret != 0) {
395 mbedtls_test_mock_socket_close(peer1);
396 mbedtls_test_mock_socket_close(peer2);
397 }
398
399 return ret;
400}
401
Yanray Wangaf727a22023-03-13 19:22:36 +0800402int mbedtls_test_mock_tcp_send_b(void *ctx,
403 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800404{
405 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
406
407 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
408 return -1;
409 }
410
411 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
412}
413
414int mbedtls_test_mock_tcp_recv_b(void *ctx, unsigned char *buf, size_t len)
415{
416 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
417
418 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
419 return -1;
420 }
421
422 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
423}
424
Yanray Wang34634352023-02-14 17:56:51 +0800425int mbedtls_test_mock_tcp_send_nb(void *ctx,
426 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800427{
428 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
429
430 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
431 return -1;
432 }
433
434 if (socket->output->capacity == socket->output->content_length) {
435 return MBEDTLS_ERR_SSL_WANT_WRITE;
436 }
437
438 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
439}
440
441int mbedtls_test_mock_tcp_recv_nb(void *ctx, unsigned char *buf, size_t len)
442{
443 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
444
445 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
446 return -1;
447 }
448
449 if (socket->input->content_length == 0) {
450 return MBEDTLS_ERR_SSL_WANT_READ;
451 }
452
453 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
454}
455
Yanray Wangd19894f2023-03-16 11:47:39 +0800456void mbedtls_test_message_socket_init(
457 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800458{
459 ctx->queue_input = NULL;
460 ctx->queue_output = NULL;
461 ctx->socket = NULL;
462}
463
Yanray Wange6afd912022-10-27 12:11:18 +0800464int mbedtls_test_message_socket_setup(
465 mbedtls_test_ssl_message_queue *queue_input,
466 mbedtls_test_ssl_message_queue *queue_output,
467 size_t queue_capacity,
468 mbedtls_test_mock_socket *socket,
469 mbedtls_test_message_socket_context *ctx)
470{
471 int ret = mbedtls_test_ssl_message_queue_setup(queue_input, queue_capacity);
472 if (ret != 0) {
473 return ret;
474 }
475 ctx->queue_input = queue_input;
476 ctx->queue_output = queue_output;
477 ctx->socket = socket;
Yanray Wang5f86a422023-03-15 16:02:29 +0800478 mbedtls_test_mock_socket_init(socket);
Yanray Wange6afd912022-10-27 12:11:18 +0800479
480 return 0;
481}
482
Yanray Wangd19894f2023-03-16 11:47:39 +0800483void mbedtls_test_message_socket_close(
484 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800485{
486 if (ctx == NULL) {
487 return;
488 }
489
490 mbedtls_test_ssl_message_queue_free(ctx->queue_input);
491 mbedtls_test_mock_socket_close(ctx->socket);
492 memset(ctx, 0, sizeof(*ctx));
493}
494
Yanray Wang34634352023-02-14 17:56:51 +0800495int mbedtls_test_mock_tcp_send_msg(void *ctx,
496 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800497{
498 mbedtls_test_ssl_message_queue *queue;
499 mbedtls_test_mock_socket *socket;
500 mbedtls_test_message_socket_context *context =
501 (mbedtls_test_message_socket_context *) ctx;
502
503 if (context == NULL || context->socket == NULL
504 || context->queue_output == NULL) {
505 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
506 }
507
508 queue = context->queue_output;
509 socket = context->socket;
510
511 if (queue->num >= queue->capacity) {
512 return MBEDTLS_ERR_SSL_WANT_WRITE;
513 }
514
515 if (mbedtls_test_mock_tcp_send_b(socket, buf, len) != (int) len) {
516 return MBEDTLS_TEST_ERROR_SEND_FAILED;
517 }
518
519 return mbedtls_test_ssl_message_queue_push_info(queue, len);
520}
521
Yanray Wang34634352023-02-14 17:56:51 +0800522int mbedtls_test_mock_tcp_recv_msg(void *ctx,
523 unsigned char *buf, size_t buf_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800524{
525 mbedtls_test_ssl_message_queue *queue;
526 mbedtls_test_mock_socket *socket;
527 mbedtls_test_message_socket_context *context =
528 (mbedtls_test_message_socket_context *) ctx;
529 size_t drop_len = 0;
530 size_t msg_len;
531 int ret;
532
533 if (context == NULL || context->socket == NULL
534 || context->queue_input == NULL) {
535 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
536 }
537
538 queue = context->queue_input;
539 socket = context->socket;
540
541 /* Peek first, so that in case of a socket error the data remains in
542 * the queue. */
Yanray Wang5e22a922023-03-16 14:57:54 +0800543 ret = test_ssl_message_queue_peek_info(queue, buf_len, &msg_len);
Yanray Wange6afd912022-10-27 12:11:18 +0800544 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
545 /* Calculate how much to drop */
546 drop_len = msg_len - buf_len;
547
548 /* Set the requested message len to be buffer length */
549 msg_len = buf_len;
550 } else if (ret != 0) {
551 return ret;
552 }
553
554 if (mbedtls_test_mock_tcp_recv_b(socket, buf, msg_len) != (int) msg_len) {
555 return MBEDTLS_TEST_ERROR_RECV_FAILED;
556 }
557
558 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
559 /* Drop the remaining part of the message */
Yanray Wangaf727a22023-03-13 19:22:36 +0800560 if (mbedtls_test_mock_tcp_recv_b(socket, NULL, drop_len) !=
561 (int) drop_len) {
Yanray Wange6afd912022-10-27 12:11:18 +0800562 /* Inconsistent state - part of the message was read,
563 * and a part couldn't. Not much we can do here, but it should not
564 * happen in test environment, unless forced manually. */
565 }
566 }
Tomás Gonzáleza9b90de2024-02-01 11:12:20 +0000567 ret = mbedtls_test_ssl_message_queue_pop_info(queue, buf_len);
568 if (ret < 0) {
569 return ret;
570 }
Yanray Wange6afd912022-10-27 12:11:18 +0800571
Yanray Wanga8f445e2022-11-03 11:51:59 +0800572 return (msg_len > INT_MAX) ? INT_MAX : (int) msg_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800573}
574
575#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
576
577/*
578 * Deinitializes certificates from endpoint represented by \p ep.
579 */
Yanray Wangf6f71902023-03-15 16:05:14 +0800580static void test_ssl_endpoint_certificate_free(mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +0800581{
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200582 if (ep->ca_chain != NULL) {
583 mbedtls_x509_crt_free(ep->ca_chain);
584 mbedtls_free(ep->ca_chain);
585 ep->ca_chain = NULL;
586 }
587 if (ep->cert != NULL) {
588 mbedtls_x509_crt_free(ep->cert);
589 mbedtls_free(ep->cert);
590 ep->cert = NULL;
591 }
592 if (ep->pkey != NULL) {
Yanray Wange6afd912022-10-27 12:11:18 +0800593#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200594 if (mbedtls_pk_get_type(ep->pkey) == MBEDTLS_PK_OPAQUE) {
595 psa_destroy_key(ep->pkey->priv_id);
Yanray Wange6afd912022-10-27 12:11:18 +0800596 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200597#endif
598 mbedtls_pk_free(ep->pkey);
599 mbedtls_free(ep->pkey);
600 ep->pkey = NULL;
Yanray Wange6afd912022-10-27 12:11:18 +0800601 }
602}
603
Yanray Wange6afd912022-10-27 12:11:18 +0800604int mbedtls_test_ssl_endpoint_certificate_init(mbedtls_test_ssl_endpoint *ep,
605 int pk_alg,
606 int opaque_alg, int opaque_alg2,
607 int opaque_usage)
608{
609 int i = 0;
610 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +0200611 int ok = 0;
Yanray Wange6afd912022-10-27 12:11:18 +0800612#if defined(MBEDTLS_USE_PSA_CRYPTO)
613 mbedtls_svc_key_id_t key_slot = MBEDTLS_SVC_KEY_ID_INIT;
614#endif
615
616 if (ep == NULL) {
617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
618 }
619
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200620 TEST_CALLOC(ep->ca_chain, 1);
621 TEST_CALLOC(ep->cert, 1);
622 TEST_CALLOC(ep->pkey, 1);
Yanray Wange6afd912022-10-27 12:11:18 +0800623
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200624 mbedtls_x509_crt_init(ep->ca_chain);
625 mbedtls_x509_crt_init(ep->cert);
626 mbedtls_pk_init(ep->pkey);
Yanray Wange6afd912022-10-27 12:11:18 +0800627
628 /* Load the trusted CA */
629
630 for (i = 0; mbedtls_test_cas_der[i] != NULL; i++) {
631 ret = mbedtls_x509_crt_parse_der(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200632 ep->ca_chain,
Yanray Wange6afd912022-10-27 12:11:18 +0800633 (const unsigned char *) mbedtls_test_cas_der[i],
634 mbedtls_test_cas_der_len[i]);
Gilles Peskine353eb332025-05-14 17:42:53 +0200635 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800636 }
637
638 /* Load own certificate and private key */
639
640 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
641 if (pk_alg == MBEDTLS_PK_RSA) {
642 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200643 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800644 (const unsigned char *) mbedtls_test_srv_crt_rsa_sha256_der,
645 mbedtls_test_srv_crt_rsa_sha256_der_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200646 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800647
648 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200649 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800650 (const unsigned char *) mbedtls_test_srv_key_rsa_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000651 mbedtls_test_srv_key_rsa_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200652 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800653 } else {
654 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200655 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800656 (const unsigned char *) mbedtls_test_srv_crt_ec_der,
657 mbedtls_test_srv_crt_ec_der_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200658 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800659
660 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200661 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800662 (const unsigned char *) mbedtls_test_srv_key_ec_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000663 mbedtls_test_srv_key_ec_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200664 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800665 }
666 } else {
667 if (pk_alg == MBEDTLS_PK_RSA) {
668 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200669 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800670 (const unsigned char *) mbedtls_test_cli_crt_rsa_der,
671 mbedtls_test_cli_crt_rsa_der_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200672 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800673
674 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200675 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800676 (const unsigned char *) mbedtls_test_cli_key_rsa_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000677 mbedtls_test_cli_key_rsa_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200678 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800679 } else {
680 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200681 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800682 (const unsigned char *) mbedtls_test_cli_crt_ec_der,
683 mbedtls_test_cli_crt_ec_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200684 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800685
686 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200687 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800688 (const unsigned char *) mbedtls_test_cli_key_ec_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000689 mbedtls_test_cli_key_ec_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200690 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800691 }
692 }
693
694#if defined(MBEDTLS_USE_PSA_CRYPTO)
695 if (opaque_alg != 0) {
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100696 psa_key_attributes_t key_attr = PSA_KEY_ATTRIBUTES_INIT;
697 /* Use a fake key usage to get a successful initial guess for the PSA attributes. */
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200698 TEST_EQUAL(mbedtls_pk_get_psa_attributes(ep->pkey, PSA_KEY_USAGE_SIGN_HASH,
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100699 &key_attr), 0);
Valerio Settia9de9442024-02-27 13:56:09 +0100700 /* Then manually usage, alg and alg2 as requested by the test. */
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100701 psa_set_key_usage_flags(&key_attr, opaque_usage);
702 psa_set_key_algorithm(&key_attr, opaque_alg);
703 if (opaque_alg2 != PSA_ALG_NONE) {
704 psa_set_key_enrollment_algorithm(&key_attr, opaque_alg2);
705 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200706 TEST_EQUAL(mbedtls_pk_import_into_psa(ep->pkey, &key_attr, &key_slot), 0);
707 mbedtls_pk_free(ep->pkey);
708 mbedtls_pk_init(ep->pkey);
709 TEST_EQUAL(mbedtls_pk_setup_opaque(ep->pkey, key_slot), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800710 }
711#else
712 (void) opaque_alg;
713 (void) opaque_alg2;
714 (void) opaque_usage;
715#endif
716
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200717 mbedtls_ssl_conf_ca_chain(&(ep->conf), ep->ca_chain, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +0800718
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200719 ret = mbedtls_ssl_conf_own_cert(&(ep->conf), ep->cert,
720 ep->pkey);
Gilles Peskine353eb332025-05-14 17:42:53 +0200721 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800722
Gilles Peskine946bf142025-04-08 09:48:40 +0200723 ok = 1;
724
Yanray Wange6afd912022-10-27 12:11:18 +0800725exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200726 if (ret == 0 && !ok) {
727 /* Exiting due to a test assertion that isn't ret == 0 */
728 ret = -1;
729 }
Yanray Wange6afd912022-10-27 12:11:18 +0800730 if (ret != 0) {
Yanray Wangf6f71902023-03-15 16:05:14 +0800731 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800732 }
733
734 return ret;
735}
736
Yanray Wange6afd912022-10-27 12:11:18 +0800737int mbedtls_test_ssl_endpoint_init(
738 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
739 mbedtls_test_handshake_test_options *options,
740 mbedtls_test_message_socket_context *dtls_context,
741 mbedtls_test_ssl_message_queue *input_queue,
Ronald Cronfb536472024-01-26 14:55:25 +0100742 mbedtls_test_ssl_message_queue *output_queue)
Yanray Wange6afd912022-10-27 12:11:18 +0800743{
744 int ret = -1;
745 uintptr_t user_data_n;
746
747 if (dtls_context != NULL &&
748 (input_queue == NULL || output_queue == NULL)) {
749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
750
751 }
752
753 if (ep == NULL) {
754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
755 }
756
757 memset(ep, 0, sizeof(*ep));
758
759 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
760
761 mbedtls_ssl_init(&(ep->ssl));
762 mbedtls_ssl_config_init(&(ep->conf));
Yanray Wange6afd912022-10-27 12:11:18 +0800763
764 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
765 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
766 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
767 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
768
769 (void) mbedtls_test_rnd_std_rand(NULL,
770 (void *) &user_data_n,
771 sizeof(user_data_n));
772 mbedtls_ssl_conf_set_user_data_n(&ep->conf, user_data_n);
773 mbedtls_ssl_set_user_data_n(&ep->ssl, user_data_n);
774
775 if (dtls_context != NULL) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200776 TEST_EQUAL(mbedtls_test_message_socket_setup(input_queue, output_queue,
777 100, &(ep->socket),
778 dtls_context), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800779 } else {
Yanray Wang5f86a422023-03-15 16:02:29 +0800780 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800781 }
782
783 /* Non-blocking callbacks without timeout */
784 if (dtls_context != NULL) {
785 mbedtls_ssl_set_bio(&(ep->ssl), dtls_context,
786 mbedtls_test_mock_tcp_send_msg,
787 mbedtls_test_mock_tcp_recv_msg,
788 NULL);
789 } else {
790 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
791 mbedtls_test_mock_tcp_send_nb,
792 mbedtls_test_mock_tcp_recv_nb,
793 NULL);
794 }
795
796 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
797 (dtls_context != NULL) ?
798 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
799 MBEDTLS_SSL_TRANSPORT_STREAM,
800 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200801 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800802
Ronald Crona697a712023-03-09 17:47:42 +0100803 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
804 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
805 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
806 options->client_min_version);
807 }
808
809 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
810 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
811 options->client_max_version);
812 }
813 } else {
814 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
815 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
816 options->server_min_version);
817 }
818
819 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
820 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
821 options->server_max_version);
822 }
823 }
824
Ronald Cronfb536472024-01-26 14:55:25 +0100825 if (options->group_list != NULL) {
826 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800827 }
828
829 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
830
Ronald Cronced99be2024-01-26 15:49:12 +0100831#if defined(MBEDTLS_SSL_EARLY_DATA)
832 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100833#if defined(MBEDTLS_SSL_SRV_C)
834 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
835 (options->max_early_data_size >= 0)) {
836 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
837 options->max_early_data_size);
838 }
839#endif
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000840#if defined(MBEDTLS_SSL_ALPN)
841 /* check that alpn_list contains at least one valid entry */
842 if (options->alpn_list[0] != NULL) {
843 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
844 }
845#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100846#endif
847
Yanray Wange6afd912022-10-27 12:11:18 +0800848#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
849 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
850 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
851 mbedtls_ssl_cache_get,
852 mbedtls_ssl_cache_set);
853 }
854#endif
855
856 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
Gilles Peskine353eb332025-05-14 17:42:53 +0200857 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800858
Gilles Peskine856a3702025-02-13 17:28:49 +0100859 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
860 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
Gilles Peskine55b8bb42025-04-08 09:44:34 +0200861 TEST_EQUAL(ret, 0);
Gilles Peskine856a3702025-02-13 17:28:49 +0100862 }
863
Yanray Wange6afd912022-10-27 12:11:18 +0800864#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
865 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && dtls_context != NULL) {
866 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
867 }
868#endif
869
Ronald Cronec3408d2024-01-16 17:50:40 +0100870#if defined(MBEDTLS_DEBUG_C)
871#if defined(MBEDTLS_SSL_SRV_C)
872 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
873 options->srv_log_fun != NULL) {
874 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
875 options->srv_log_obj);
876 }
877#endif
878#if defined(MBEDTLS_SSL_CLI_C)
879 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
880 options->cli_log_fun != NULL) {
881 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
882 options->cli_log_obj);
883 }
884#endif
885#endif /* MBEDTLS_DEBUG_C */
886
Yanray Wange6afd912022-10-27 12:11:18 +0800887 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
888 options->opaque_alg,
889 options->opaque_alg2,
890 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200891 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800892
893 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), user_data_n);
894 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
895 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), user_data_n);
896 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
897
Gilles Peskine946bf142025-04-08 09:48:40 +0200898 return 0;
899
Yanray Wange6afd912022-10-27 12:11:18 +0800900exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200901 if (ret == 0) {
902 /* Exiting due to a test assertion that isn't ret == 0 */
903 ret = -1;
904 }
Yanray Wange6afd912022-10-27 12:11:18 +0800905 return ret;
906}
907
Yanray Wange6afd912022-10-27 12:11:18 +0800908void mbedtls_test_ssl_endpoint_free(
909 mbedtls_test_ssl_endpoint *ep,
910 mbedtls_test_message_socket_context *context)
911{
Yanray Wangf6f71902023-03-15 16:05:14 +0800912 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800913
914 mbedtls_ssl_free(&(ep->ssl));
915 mbedtls_ssl_config_free(&(ep->conf));
916
917 if (context != NULL) {
918 mbedtls_test_message_socket_close(context);
919 } else {
920 mbedtls_test_mock_socket_close(&(ep->socket));
921 }
922}
923
Yanray Wange6afd912022-10-27 12:11:18 +0800924int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
925 mbedtls_ssl_context *second_ssl,
926 int state)
927{
928 enum { BUFFSIZE = 1024 };
929 int max_steps = 1000;
930 int ret = 0;
931
932 if (ssl == NULL || second_ssl == NULL) {
933 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
934 }
935
936 /* Perform communication via connected sockets */
937 while ((ssl->state != state) && (--max_steps >= 0)) {
938 /* If /p second_ssl ends the handshake procedure before /p ssl then
939 * there is no need to call the next step */
940 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
941 ret = mbedtls_ssl_handshake_step(second_ssl);
942 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
943 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
944 return ret;
945 }
946 }
947
948 /* We only care about the \p ssl state and returns, so we call it last,
949 * to leave the iteration as soon as the state is as expected. */
950 ret = mbedtls_ssl_handshake_step(ssl);
951 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
952 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
953 return ret;
954 }
955 }
956
957 return (max_steps >= 0) ? ret : -1;
958}
959
960#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
961
962/*
963 * Write application data. Increase write counter if necessary.
964 */
Michael Schuster54300d42024-06-04 02:30:22 +0200965static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +0200966 unsigned char *buf, int buf_len,
967 int *written,
968 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +0800969{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100970 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +0800971 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
972 * a valid no-op for TLS connections. */
973 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200974 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800975 }
976
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100977 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +0800978 if (ret > 0) {
979 *written += ret;
980 }
981
982 if (expected_fragments == 0) {
983 /* Used for DTLS and the message size larger than MFL. In that case
984 * the message can not be fragmented and the library should return
985 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +0800986 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +0800987 return ret;
988 } else if (expected_fragments == 1) {
989 /* Used for TLS/DTLS and the message size lower than MFL */
990 TEST_ASSERT(ret == buf_len ||
991 ret == MBEDTLS_ERR_SSL_WANT_READ ||
992 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
993 } else {
994 /* Used for TLS and the message size larger than MFL */
995 TEST_ASSERT(expected_fragments > 1);
996 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
997 ret == MBEDTLS_ERR_SSL_WANT_READ ||
998 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
999 }
1000
1001 return 0;
1002
1003exit:
1004 /* Some of the tests failed */
1005 return -1;
1006}
1007
1008/*
1009 * Read application data and increase read counter and fragments counter
1010 * if necessary.
1011 */
Michael Schuster54300d42024-06-04 02:30:22 +02001012static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001013 unsigned char *buf, int buf_len,
1014 int *read, int *fragments,
1015 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001016{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001017 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001018 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1019 * a valid no-op for TLS connections. */
1020 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001021 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001022 }
1023
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001024 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001025 if (ret > 0) {
1026 (*fragments)++;
1027 *read += ret;
1028 }
1029
1030 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001031 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001032 } else if (expected_fragments == 1) {
1033 TEST_ASSERT(ret == buf_len ||
1034 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1035 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1036 } else {
1037 TEST_ASSERT(expected_fragments > 1);
1038 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1039 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1040 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1041 }
1042
1043 return 0;
1044
1045exit:
1046 /* Some of the tests failed */
1047 return -1;
1048}
1049
Yanray Wangead70c82023-03-16 12:04:49 +08001050#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
1051static void set_ciphersuite(mbedtls_ssl_config *conf, const char *cipher,
1052 int *forced_ciphersuite)
Yanray Wange6afd912022-10-27 12:11:18 +08001053{
1054 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
1055 forced_ciphersuite[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
1056 forced_ciphersuite[1] = 0;
1057
1058 ciphersuite_info =
1059 mbedtls_ssl_ciphersuite_from_id(forced_ciphersuite[0]);
1060
1061 TEST_ASSERT(ciphersuite_info != NULL);
1062 TEST_ASSERT(ciphersuite_info->min_tls_version <= conf->max_tls_version);
1063 TEST_ASSERT(ciphersuite_info->max_tls_version >= conf->min_tls_version);
1064
1065 if (conf->max_tls_version > ciphersuite_info->max_tls_version) {
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001066 conf->max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001067 }
1068 if (conf->min_tls_version < ciphersuite_info->min_tls_version) {
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001069 conf->min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001070 }
1071
1072 mbedtls_ssl_conf_ciphersuites(conf, forced_ciphersuite);
1073
1074exit:
1075 return;
1076}
Yanray Wangead70c82023-03-16 12:04:49 +08001077#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Yanray Wange6afd912022-10-27 12:11:18 +08001078
Yanray Wangead70c82023-03-16 12:04:49 +08001079#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
1080 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
1081 defined(MBEDTLS_SSL_SRV_C)
1082static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
1083 const unsigned char *name, size_t name_len)
Yanray Wange6afd912022-10-27 12:11:18 +08001084{
1085 (void) p_info;
1086 (void) ssl;
1087 (void) name;
1088 (void) name_len;
1089
1090 return 0;
1091}
Yanray Wangead70c82023-03-16 12:04:49 +08001092#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
1093 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
1094 MBEDTLS_SSL_SRV_C */
Yanray Wange6afd912022-10-27 12:11:18 +08001095
1096#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001097 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001098int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1099 const unsigned char *iv,
1100 size_t iv_len,
1101 const unsigned char *input,
1102 size_t ilen,
1103 unsigned char *output,
1104 size_t *olen)
1105{
1106#if defined(MBEDTLS_USE_PSA_CRYPTO)
1107 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1108 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1109 size_t part_len;
1110
1111 status = psa_cipher_encrypt_setup(&cipher_op,
1112 transform->psa_key_enc,
1113 transform->psa_alg);
1114
1115 if (status != PSA_SUCCESS) {
1116 return PSA_TO_MBEDTLS_ERR(status);
1117 }
1118
1119 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1120
1121 if (status != PSA_SUCCESS) {
1122 return PSA_TO_MBEDTLS_ERR(status);
1123 }
1124
1125 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1126
1127 if (status != PSA_SUCCESS) {
1128 return PSA_TO_MBEDTLS_ERR(status);
1129 }
1130
1131 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1132 &part_len);
1133
1134 if (status != PSA_SUCCESS) {
1135 return PSA_TO_MBEDTLS_ERR(status);
1136 }
1137
1138 *olen += part_len;
1139 return 0;
1140#else
1141 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1142 iv, iv_len, input, ilen, output, olen);
1143#endif /* MBEDTLS_USE_PSA_CRYPTO */
1144}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001145#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001146 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001147
Valerio Setti31ad3a12023-10-27 11:55:02 +02001148static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1149 mbedtls_cipher_mode_t *cipher_mode,
1150 size_t *key_bits, size_t *iv_len)
1151{
1152 switch (cipher_type) {
1153 case MBEDTLS_CIPHER_AES_128_CBC:
1154 *cipher_mode = MBEDTLS_MODE_CBC;
1155 *key_bits = 128;
1156 *iv_len = 16;
1157 break;
1158 case MBEDTLS_CIPHER_AES_256_CBC:
1159 *cipher_mode = MBEDTLS_MODE_CBC;
1160 *key_bits = 256;
1161 *iv_len = 16;
1162 break;
1163 case MBEDTLS_CIPHER_ARIA_128_CBC:
1164 *cipher_mode = MBEDTLS_MODE_CBC;
1165 *key_bits = 128;
1166 *iv_len = 16;
1167 break;
1168 case MBEDTLS_CIPHER_ARIA_256_CBC:
1169 *cipher_mode = MBEDTLS_MODE_CBC;
1170 *key_bits = 256;
1171 *iv_len = 16;
1172 break;
1173 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1174 *cipher_mode = MBEDTLS_MODE_CBC;
1175 *key_bits = 128;
1176 *iv_len = 16;
1177 break;
1178 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1179 *cipher_mode = MBEDTLS_MODE_CBC;
1180 *key_bits = 256;
1181 *iv_len = 16;
1182 break;
1183
1184 case MBEDTLS_CIPHER_AES_128_CCM:
1185 *cipher_mode = MBEDTLS_MODE_CCM;
1186 *key_bits = 128;
1187 *iv_len = 12;
1188 break;
1189 case MBEDTLS_CIPHER_AES_192_CCM:
1190 *cipher_mode = MBEDTLS_MODE_CCM;
1191 *key_bits = 192;
1192 *iv_len = 12;
1193 break;
1194 case MBEDTLS_CIPHER_AES_256_CCM:
1195 *cipher_mode = MBEDTLS_MODE_CCM;
1196 *key_bits = 256;
1197 *iv_len = 12;
1198 break;
1199 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1200 *cipher_mode = MBEDTLS_MODE_CCM;
1201 *key_bits = 128;
1202 *iv_len = 12;
1203 break;
1204 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1205 *cipher_mode = MBEDTLS_MODE_CCM;
1206 *key_bits = 192;
1207 *iv_len = 12;
1208 break;
1209 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1210 *cipher_mode = MBEDTLS_MODE_CCM;
1211 *key_bits = 256;
1212 *iv_len = 12;
1213 break;
1214
1215 case MBEDTLS_CIPHER_AES_128_GCM:
1216 *cipher_mode = MBEDTLS_MODE_GCM;
1217 *key_bits = 128;
1218 *iv_len = 12;
1219 break;
1220 case MBEDTLS_CIPHER_AES_192_GCM:
1221 *cipher_mode = MBEDTLS_MODE_GCM;
1222 *key_bits = 192;
1223 *iv_len = 12;
1224 break;
1225 case MBEDTLS_CIPHER_AES_256_GCM:
1226 *cipher_mode = MBEDTLS_MODE_GCM;
1227 *key_bits = 256;
1228 *iv_len = 12;
1229 break;
1230 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1231 *cipher_mode = MBEDTLS_MODE_GCM;
1232 *key_bits = 128;
1233 *iv_len = 12;
1234 break;
1235 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1236 *cipher_mode = MBEDTLS_MODE_GCM;
1237 *key_bits = 192;
1238 *iv_len = 12;
1239 break;
1240 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1241 *cipher_mode = MBEDTLS_MODE_GCM;
1242 *key_bits = 256;
1243 *iv_len = 12;
1244 break;
1245
1246 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1247 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1248 *key_bits = 256;
1249 *iv_len = 12;
1250 break;
1251
1252 case MBEDTLS_CIPHER_NULL:
1253 *cipher_mode = MBEDTLS_MODE_STREAM;
1254 *key_bits = 0;
1255 *iv_len = 0;
1256 break;
1257
1258 default:
1259 *cipher_mode = MBEDTLS_MODE_NONE;
1260 *key_bits = 0;
1261 *iv_len = 0;
1262 }
1263}
1264
Yanray Wange6afd912022-10-27 12:11:18 +08001265int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1266 mbedtls_ssl_transform *t_out,
1267 int cipher_type, int hash_id,
1268 int etm, int tag_mode,
1269 mbedtls_ssl_protocol_version tls_version,
1270 size_t cid0_len,
1271 size_t cid1_len)
1272{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001273 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1274 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001275 int ret = 0;
1276
1277#if defined(MBEDTLS_USE_PSA_CRYPTO)
1278 psa_key_type_t key_type;
1279 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1280 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001282#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001283 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001284#endif
1285
Valerio Setti31ad3a12023-10-27 11:55:02 +02001286 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001287 unsigned char *key0 = NULL, *key1 = NULL;
1288 unsigned char *md0 = NULL, *md1 = NULL;
1289 unsigned char iv_enc[16], iv_dec[16];
1290
1291#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1292 unsigned char cid0[SSL_CID_LEN_MIN];
1293 unsigned char cid1[SSL_CID_LEN_MIN];
1294
1295 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1296 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1297#else
1298 ((void) cid0_len);
1299 ((void) cid1_len);
1300#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1301
1302 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001303 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1304 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001305
1306 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001307 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001308 /* Allocate `keylen + 1` bytes to ensure that we get
1309 * a non-NULL pointers from `mbedtls_calloc` even if
1310 * `keylen == 0` in the case of the NULL cipher. */
1311 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1312 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1313 memset(key0, 0x1, keylen);
1314 memset(key1, 0x2, keylen);
1315
1316#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001317 /* Pick cipher */
1318 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1319 CHK(cipher_info != NULL);
1320 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1321 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001322
Yanray Wange6afd912022-10-27 12:11:18 +08001323 /* Setup cipher contexts */
1324 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1325 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1326 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1327 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1328
1329#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001330 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001331 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1332 MBEDTLS_PADDING_NONE) == 0);
1333 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1334 MBEDTLS_PADDING_NONE) == 0);
1335 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1336 MBEDTLS_PADDING_NONE) == 0);
1337 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1338 MBEDTLS_PADDING_NONE) == 0);
1339 }
1340#endif /* MBEDTLS_CIPHER_MODE_CBC */
1341
1342 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001343 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1344 MBEDTLS_ENCRYPT)
1345 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001346 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001347 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1348 MBEDTLS_DECRYPT)
1349 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001350 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001351 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1352 MBEDTLS_ENCRYPT)
1353 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001354 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001355 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1356 MBEDTLS_DECRYPT)
1357 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001358#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001359
1360 /* Setup MAC contexts */
1361#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001362 if (cipher_mode == MBEDTLS_MODE_CBC ||
1363 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001364#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001365 mbedtls_md_info_t const *md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001366 CHK(md_info != NULL);
1367#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001368 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001369 CHK(maclen != 0);
1370 /* Pick hash keys */
1371 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1372 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1373 memset(md0, 0x5, maclen);
1374 memset(md1, 0x6, maclen);
1375
1376#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001377 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001378
1379 CHK(alg != 0);
1380
1381 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1382 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1383 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1384 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1385 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1386 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1387
1388 psa_reset_key_attributes(&attributes);
1389 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1390 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1391 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1392
1393 CHK(psa_import_key(&attributes,
1394 md0, maclen,
1395 &t_in->psa_mac_enc) == PSA_SUCCESS);
1396
1397 CHK(psa_import_key(&attributes,
1398 md1, maclen,
1399 &t_out->psa_mac_enc) == PSA_SUCCESS);
1400
Valerio Setti31ad3a12023-10-27 11:55:02 +02001401 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001402 etm == MBEDTLS_SSL_ETM_DISABLED) {
1403 /* mbedtls_ct_hmac() requires the key to be exportable */
1404 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1405 PSA_KEY_USAGE_VERIFY_HASH);
1406 } else {
1407 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1408 }
1409
1410 CHK(psa_import_key(&attributes,
1411 md1, maclen,
1412 &t_in->psa_mac_dec) == PSA_SUCCESS);
1413
1414 CHK(psa_import_key(&attributes,
1415 md0, maclen,
1416 &t_out->psa_mac_dec) == PSA_SUCCESS);
1417#else
1418 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1419 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1420 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1421 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1422
1423 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1424 md0, maclen) == 0);
1425 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1426 md1, maclen) == 0);
1427 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1428 md1, maclen) == 0);
1429 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1430 md0, maclen) == 0);
1431#endif
1432 }
1433#else
1434 ((void) hash_id);
1435#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1436
1437
1438 /* Pick IV's (regardless of whether they
1439 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001440 memset(iv_enc, 0x3, sizeof(iv_enc));
1441 memset(iv_dec, 0x4, sizeof(iv_dec));
1442
1443 /*
1444 * Setup transforms
1445 */
1446
1447#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1448 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1449 t_out->encrypt_then_mac = etm;
1450 t_in->encrypt_then_mac = etm;
1451#else
1452 ((void) etm);
1453#endif
1454
1455 t_out->tls_version = tls_version;
1456 t_in->tls_version = tls_version;
1457 t_out->ivlen = ivlen;
1458 t_in->ivlen = ivlen;
1459
Valerio Setti31ad3a12023-10-27 11:55:02 +02001460 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001461 case MBEDTLS_MODE_GCM:
1462 case MBEDTLS_MODE_CCM:
1463#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1464 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1465 t_out->fixed_ivlen = 12;
1466 t_in->fixed_ivlen = 12;
1467 } else
1468#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1469 {
1470 t_out->fixed_ivlen = 4;
1471 t_in->fixed_ivlen = 4;
1472 }
1473 t_out->maclen = 0;
1474 t_in->maclen = 0;
1475 switch (tag_mode) {
1476 case 0: /* Full tag */
1477 t_out->taglen = 16;
1478 t_in->taglen = 16;
1479 break;
1480 case 1: /* Partial tag */
1481 t_out->taglen = 8;
1482 t_in->taglen = 8;
1483 break;
1484 default:
1485 ret = 1;
1486 goto cleanup;
1487 }
1488 break;
1489
1490 case MBEDTLS_MODE_CHACHAPOLY:
1491 t_out->fixed_ivlen = 12;
1492 t_in->fixed_ivlen = 12;
1493 t_out->maclen = 0;
1494 t_in->maclen = 0;
1495 switch (tag_mode) {
1496 case 0: /* Full tag */
1497 t_out->taglen = 16;
1498 t_in->taglen = 16;
1499 break;
1500 case 1: /* Partial tag */
1501 t_out->taglen = 8;
1502 t_in->taglen = 8;
1503 break;
1504 default:
1505 ret = 1;
1506 goto cleanup;
1507 }
1508 break;
1509
1510 case MBEDTLS_MODE_STREAM:
1511 case MBEDTLS_MODE_CBC:
1512 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1513 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1514 t_out->taglen = 0;
1515 t_in->taglen = 0;
1516 switch (tag_mode) {
1517 case 0: /* Full tag */
1518 t_out->maclen = maclen;
1519 t_in->maclen = maclen;
1520 break;
1521 default:
1522 ret = 1;
1523 goto cleanup;
1524 }
1525 break;
1526 default:
1527 ret = 1;
1528 goto cleanup;
1529 break;
1530 }
1531
1532 /* Setup IV's */
1533
1534 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1535 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1536 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1537 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1538
1539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1540 /* Add CID */
1541 memcpy(&t_in->in_cid, cid0, cid0_len);
1542 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001543 t_in->in_cid_len = (uint8_t) cid0_len;
1544 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001545 memcpy(&t_out->in_cid, cid1, cid1_len);
1546 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001547 t_out->in_cid_len = (uint8_t) cid1_len;
1548 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001549#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1550
1551#if defined(MBEDTLS_USE_PSA_CRYPTO)
1552 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1553 t_in->taglen,
1554 &alg,
1555 &key_type,
1556 &key_bits);
1557
1558 if (status != PSA_SUCCESS) {
1559 ret = PSA_TO_MBEDTLS_ERR(status);
1560 goto cleanup;
1561 }
1562
1563 t_in->psa_alg = alg;
1564 t_out->psa_alg = alg;
1565
1566 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1567 psa_reset_key_attributes(&attributes);
1568 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1569 psa_set_key_algorithm(&attributes, alg);
1570 psa_set_key_type(&attributes, key_type);
1571
1572 status = psa_import_key(&attributes,
1573 key0,
1574 PSA_BITS_TO_BYTES(key_bits),
1575 &t_in->psa_key_enc);
1576
1577 if (status != PSA_SUCCESS) {
1578 ret = PSA_TO_MBEDTLS_ERR(status);
1579 goto cleanup;
1580 }
1581
1582 status = psa_import_key(&attributes,
1583 key1,
1584 PSA_BITS_TO_BYTES(key_bits),
1585 &t_out->psa_key_enc);
1586
1587 if (status != PSA_SUCCESS) {
1588 ret = PSA_TO_MBEDTLS_ERR(status);
1589 goto cleanup;
1590 }
1591
1592 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1593
1594 status = psa_import_key(&attributes,
1595 key1,
1596 PSA_BITS_TO_BYTES(key_bits),
1597 &t_in->psa_key_dec);
1598
1599 if (status != PSA_SUCCESS) {
1600 ret = PSA_TO_MBEDTLS_ERR(status);
1601 goto cleanup;
1602 }
1603
1604 status = psa_import_key(&attributes,
1605 key0,
1606 PSA_BITS_TO_BYTES(key_bits),
1607 &t_out->psa_key_dec);
1608
1609 if (status != PSA_SUCCESS) {
1610 ret = PSA_TO_MBEDTLS_ERR(status);
1611 goto cleanup;
1612 }
1613 }
1614#endif /* MBEDTLS_USE_PSA_CRYPTO */
1615
1616cleanup:
1617
1618 mbedtls_free(key0);
1619 mbedtls_free(key1);
1620
1621 mbedtls_free(md0);
1622 mbedtls_free(md1);
1623
1624 return ret;
1625}
1626
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001627#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1628int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1629 mbedtls_ssl_transform *transform_out)
1630{
1631#if defined(MBEDTLS_USE_PSA_CRYPTO)
1632 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1633#endif
1634
1635 /* Serialized version of record header for MAC purposes */
1636 unsigned char add_data[13];
1637 memcpy(add_data, record->ctr, 8);
1638 add_data[8] = record->type;
1639 add_data[9] = record->ver[0];
1640 add_data[10] = record->ver[1];
1641 add_data[11] = (record->data_len >> 8) & 0xff;
1642 add_data[12] = (record->data_len >> 0) & 0xff;
1643
1644 /* MAC with additional data */
1645#if defined(MBEDTLS_USE_PSA_CRYPTO)
1646 size_t sign_mac_length = 0;
1647 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1648 transform_out->psa_mac_enc,
1649 transform_out->psa_mac_alg));
1650 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1651 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1652 record->buf + record->data_offset,
1653 record->data_len));
1654 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1655 * extension, there might not be enough room in the record for the
1656 * full-length MAC. */
1657 unsigned char mac[PSA_HASH_MAX_SIZE];
1658 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1659 mac, sizeof(mac),
1660 &sign_mac_length));
1661#else
1662 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1663 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1664 record->buf + record->data_offset,
1665 record->data_len));
1666 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1667 * extension, there might not be enough room in the record for the
1668 * full-length MAC. */
1669 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1670 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1671#endif
1672 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1673 record->data_len += transform_out->maclen;
1674
1675 return 0;
1676
1677exit:
1678#if defined(MBEDTLS_USE_PSA_CRYPTO)
1679 psa_mac_abort(&operation);
1680#endif
1681 return -1;
1682}
1683#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1684
Jerry Yu28547c42023-10-31 14:42:50 +08001685#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001686int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1687 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001688 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001689 const char *crt_file)
1690{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001691 (void) ticket_len;
1692
Yanray Wange6afd912022-10-27 12:11:18 +08001693#if defined(MBEDTLS_HAVE_TIME)
1694 session->start = mbedtls_time(NULL) - 42;
1695#endif
1696 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001697
1698 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1699 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1700
1701 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001702 session->ciphersuite = 0xabcd;
1703 session->id_len = sizeof(session->id);
1704 memset(session->id, 66, session->id_len);
1705 memset(session->master, 17, sizeof(session->master));
1706
1707#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1708 if (crt_file != NULL && strlen(crt_file) != 0) {
1709 mbedtls_x509_crt tmp_crt;
1710 int ret;
1711
1712 mbedtls_x509_crt_init(&tmp_crt);
1713 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1714 if (ret != 0) {
1715 return ret;
1716 }
1717
1718#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1719 /* Move temporary CRT. */
1720 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1721 if (session->peer_cert == NULL) {
1722 return -1;
1723 }
1724 *session->peer_cert = tmp_crt;
1725 memset(&tmp_crt, 0, sizeof(tmp_crt));
1726#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1727 /* Calculate digest of temporary CRT. */
1728 session->peer_cert_digest =
1729 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1730 if (session->peer_cert_digest == NULL) {
1731 return -1;
1732 }
1733
1734#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001735 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001736 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1737 size_t hash_size = 0;
1738 psa_status_t status = psa_hash_compute(
1739 psa_alg, tmp_crt.raw.p,
1740 tmp_crt.raw.len,
1741 session->peer_cert_digest,
1742 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1743 &hash_size);
1744 ret = PSA_TO_MBEDTLS_ERR(status);
1745#else
1746 ret = mbedtls_md(mbedtls_md_info_from_type(
1747 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1748 tmp_crt.raw.p, tmp_crt.raw.len,
1749 session->peer_cert_digest);
1750#endif /* MBEDTLS_USE_PSA_CRYPTO */
1751 if (ret != 0) {
1752 return ret;
1753 }
1754 session->peer_cert_digest_type =
1755 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1756 session->peer_cert_digest_len =
1757 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1758#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1759
1760 mbedtls_x509_crt_free(&tmp_crt);
1761 }
1762#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1763 (void) crt_file;
1764#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1765 session->verify_result = 0xdeadbeef;
1766
Ronald Cronc57f86e2023-11-22 09:50:01 +01001767#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1768#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001769 if (ticket_len != 0) {
1770 session->ticket = mbedtls_calloc(1, ticket_len);
1771 if (session->ticket == NULL) {
1772 return -1;
1773 }
1774 memset(session->ticket, 33, ticket_len);
1775 }
1776 session->ticket_len = ticket_len;
1777 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001778#endif /* MBEDTLS_SSL_CLI_C */
1779
1780#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1781 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1782 session->ticket_creation_time = mbedtls_ms_time() - 42;
1783 }
Yanray Wange6afd912022-10-27 12:11:18 +08001784#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001785#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001786
1787#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1788 session->mfl_code = 1;
1789#endif
1790#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1791 session->encrypt_then_mac = 1;
1792#endif
1793
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001794exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001795 return 0;
1796}
Jerry Yu28547c42023-10-31 14:42:50 +08001797#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001798
1799#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1800int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1801 int ticket_len,
1802 int endpoint_type)
1803{
1804 ((void) ticket_len);
1805 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1806 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1807 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1808 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001809
1810#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001811 session->ticket_age_add = 0x87654321;
1812 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001813 session->resumption_key_len = 32;
1814 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001815#endif
1816
Ronald Cron18b92a12024-03-26 10:15:08 +01001817#if defined(MBEDTLS_SSL_SRV_C)
1818 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1819#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1820#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1821 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1822 if (ret != 0) {
1823 return -1;
1824 }
1825#endif
1826#if defined(MBEDTLS_HAVE_TIME)
1827 session->ticket_creation_time = mbedtls_ms_time() - 42;
1828#endif
1829#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1830 }
1831#endif /* MBEDTLS_SSL_SRV_C */
1832
Yanray Wange6afd912022-10-27 12:11:18 +08001833#if defined(MBEDTLS_SSL_CLI_C)
1834 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001835#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001836#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001837 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001838#endif
1839 session->ticket_lifetime = 0xfedcba98;
1840
1841 session->ticket_len = ticket_len;
1842 if (ticket_len != 0) {
1843 session->ticket = mbedtls_calloc(1, ticket_len);
1844 if (session->ticket == NULL) {
1845 return -1;
1846 }
1847 memset(session->ticket, 33, ticket_len);
1848 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001849#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1850 char hostname[] = "hostname example";
1851 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1852 if (session->hostname == NULL) {
1853 return -1;
1854 }
1855 memcpy(session->hostname, hostname, sizeof(hostname));
1856#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001857#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001858 }
1859#endif /* MBEDTLS_SSL_CLI_C */
1860
Ronald Cron18b92a12024-03-26 10:15:08 +01001861#if defined(MBEDTLS_SSL_EARLY_DATA)
1862 session->max_early_data_size = 0x87654321;
1863#endif /* MBEDTLS_SSL_EARLY_DATA */
1864
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001865#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1866 session->record_size_limit = 2048;
1867#endif
1868
Yanray Wange6afd912022-10-27 12:11:18 +08001869 return 0;
1870}
1871#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1872
Yanray Wangb088bfc2023-03-16 12:15:49 +08001873int mbedtls_test_ssl_exchange_data(
1874 mbedtls_ssl_context *ssl_1,
1875 int msg_len_1, const int expected_fragments_1,
1876 mbedtls_ssl_context *ssl_2,
1877 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001878{
1879 unsigned char *msg_buf_1 = malloc(msg_len_1);
1880 unsigned char *msg_buf_2 = malloc(msg_len_2);
1881 unsigned char *in_buf_1 = malloc(msg_len_2);
1882 unsigned char *in_buf_2 = malloc(msg_len_1);
1883 int msg_type, ret = -1;
1884
1885 /* Perform this test with two message types. At first use a message
1886 * consisting of only 0x00 for the client and only 0xFF for the server.
1887 * At the second time use message with generated data */
1888 for (msg_type = 0; msg_type < 2; msg_type++) {
1889 int written_1 = 0;
1890 int written_2 = 0;
1891 int read_1 = 0;
1892 int read_2 = 0;
1893 int fragments_1 = 0;
1894 int fragments_2 = 0;
1895
1896 if (msg_type == 0) {
1897 memset(msg_buf_1, 0x00, msg_len_1);
1898 memset(msg_buf_2, 0xff, msg_len_2);
1899 } else {
1900 int i, j = 0;
1901 for (i = 0; i < msg_len_1; i++) {
1902 msg_buf_1[i] = j++ & 0xFF;
1903 }
1904 for (i = 0; i < msg_len_2; i++) {
1905 msg_buf_2[i] = (j -= 5) & 0xFF;
1906 }
1907 }
1908
1909 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
1910 /* ssl_1 sending */
1911 if (msg_len_1 > written_1) {
1912 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
1913 msg_len_1, &written_1,
1914 expected_fragments_1);
1915 if (expected_fragments_1 == 0) {
1916 /* This error is expected when the message is too large and
1917 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001918 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001919 msg_len_1 = 0;
1920 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001921 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001922 }
1923 }
1924
1925 /* ssl_2 sending */
1926 if (msg_len_2 > written_2) {
1927 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
1928 msg_len_2, &written_2,
1929 expected_fragments_2);
1930 if (expected_fragments_2 == 0) {
1931 /* This error is expected when the message is too large and
1932 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001933 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001934 msg_len_2 = 0;
1935 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001936 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001937 }
1938 }
1939
1940 /* ssl_1 reading */
1941 if (read_1 < msg_len_2) {
1942 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
1943 msg_len_2, &read_1,
1944 &fragments_2,
1945 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02001946 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001947 }
1948
1949 /* ssl_2 reading */
1950 if (read_2 < msg_len_1) {
1951 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
1952 msg_len_1, &read_2,
1953 &fragments_1,
1954 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02001955 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001956 }
1957 }
1958
1959 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02001960 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
1961 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
1962 TEST_EQUAL(fragments_1, expected_fragments_1);
1963 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08001964 }
1965
1966 ret = 0;
1967
1968exit:
1969 free(msg_buf_1);
1970 free(in_buf_1);
1971 free(msg_buf_2);
1972 free(in_buf_2);
1973
1974 return ret;
1975}
1976
1977/*
1978 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
1979 * must be initialized and connected beforehand.
1980 *
1981 * \retval 0 on success, otherwise error code.
1982 */
Yanray Wangead70c82023-03-16 12:04:49 +08001983#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
1984 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
1985 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
1986static int exchange_data(mbedtls_ssl_context *ssl_1,
1987 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001988{
Yanray Wangb088bfc2023-03-16 12:15:49 +08001989 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
1990 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08001991}
Yanray Wangead70c82023-03-16 12:04:49 +08001992#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
1993 (MBEDTLS_SSL_RENEGOTIATION ||
1994 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08001995
1996#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
1997static int check_ssl_version(
1998 mbedtls_ssl_protocol_version expected_negotiated_version,
1999 const mbedtls_ssl_context *ssl)
2000{
2001 const char *version_string = mbedtls_ssl_get_version(ssl);
2002 mbedtls_ssl_protocol_version version_number =
2003 mbedtls_ssl_get_version_number(ssl);
2004
2005 TEST_EQUAL(ssl->tls_version, expected_negotiated_version);
2006
2007 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2008 TEST_EQUAL(version_string[0], 'D');
2009 ++version_string;
2010 }
2011
2012 switch (expected_negotiated_version) {
2013 case MBEDTLS_SSL_VERSION_TLS1_2:
2014 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002015 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002016 break;
2017
2018 case MBEDTLS_SSL_VERSION_TLS1_3:
2019 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002020 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002021 break;
2022
2023 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002024 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002025 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002026 }
2027
2028 return 1;
2029
2030exit:
2031 return 0;
2032}
2033#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2034
Yanray Wange6afd912022-10-27 12:11:18 +08002035#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002036int mbedtls_test_ssl_do_handshake_with_endpoints(
2037 mbedtls_test_ssl_endpoint *server_ep,
2038 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002039 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002040 mbedtls_ssl_protocol_version proto)
2041{
2042 enum { BUFFSIZE = 1024 };
2043
2044 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002045
Max Fillingeree467aa2024-11-08 22:17:33 +01002046 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2047 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2048
Max Fillinger8f12e312024-10-30 00:29:37 +01002049 mbedtls_test_init_handshake_options(options);
2050 options->server_min_version = proto;
2051 options->client_min_version = proto;
2052 options->server_max_version = proto;
2053 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002054
Max Fillinger8f12e312024-10-30 00:29:37 +01002055 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002056 NULL, NULL, NULL);
2057 if (ret != 0) {
2058 return ret;
2059 }
Max Fillinger8f12e312024-10-30 00:29:37 +01002060 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002061 NULL, NULL, NULL);
2062 if (ret != 0) {
2063 return ret;
2064 }
2065
2066 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2067 if (ret != 0) {
2068 return ret;
2069 }
2070
Max Fillingerea1e7772024-10-30 00:49:10 +01002071 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2072 &client_ep->ssl,
2073 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002074 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2075 return ret;
2076 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002077 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2078 &server_ep->ssl,
2079 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002080 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2081 return ret;
2082 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002083 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2084 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002085 return -1;
2086 }
2087
2088 return 0;
2089}
2090#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2091
2092#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Yanray Wange6afd912022-10-27 12:11:18 +08002093void mbedtls_test_ssl_perform_handshake(
2094 mbedtls_test_handshake_test_options *options)
2095{
2096 /* forced_ciphersuite needs to last until the end of the handshake */
2097 int forced_ciphersuite[2];
2098 enum { BUFFSIZE = 17000 };
2099 mbedtls_test_ssl_endpoint client, server;
2100#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2101 const char *psk_identity = "foo";
2102#endif
2103#if defined(MBEDTLS_TIMING_C)
2104 mbedtls_timing_delay_context timer_client, timer_server;
2105#endif
2106#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2107 unsigned char *context_buf = NULL;
2108 size_t context_buf_len;
2109#endif
2110#if defined(MBEDTLS_SSL_RENEGOTIATION)
2111 int ret = -1;
2112#endif
2113 int expected_handshake_result = options->expected_handshake_result;
2114
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002115 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002116 mbedtls_platform_zeroize(&client, sizeof(client));
2117 mbedtls_platform_zeroize(&server, sizeof(server));
2118 mbedtls_test_ssl_message_queue server_queue, client_queue;
2119 mbedtls_test_message_socket_context server_context, client_context;
2120 mbedtls_test_message_socket_init(&server_context);
2121 mbedtls_test_message_socket_init(&client_context);
2122
Ronald Cronec3408d2024-01-16 17:50:40 +01002123#if defined(MBEDTLS_DEBUG_C)
2124 if (options->cli_log_fun || options->srv_log_fun) {
2125 mbedtls_debug_set_threshold(4);
2126 }
2127#endif
2128
Yanray Wange6afd912022-10-27 12:11:18 +08002129 /* Client side */
2130 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002131 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2132 MBEDTLS_SSL_IS_CLIENT,
2133 options, &client_context,
2134 &client_queue,
2135 &server_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002136#if defined(MBEDTLS_TIMING_C)
2137 mbedtls_ssl_set_timer_cb(&client.ssl, &timer_client,
2138 mbedtls_timing_set_delay,
2139 mbedtls_timing_get_delay);
2140#endif
2141 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002142 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2143 MBEDTLS_SSL_IS_CLIENT,
2144 options, NULL, NULL,
2145 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002146 }
2147
Yanray Wange6afd912022-10-27 12:11:18 +08002148 if (strlen(options->cipher) > 0) {
2149 set_ciphersuite(&client.conf, options->cipher, forced_ciphersuite);
2150 }
2151
Yanray Wange6afd912022-10-27 12:11:18 +08002152 /* Server side */
2153 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002154 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2155 MBEDTLS_SSL_IS_SERVER,
2156 options, &server_context,
2157 &server_queue,
2158 &client_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002159#if defined(MBEDTLS_TIMING_C)
2160 mbedtls_ssl_set_timer_cb(&server.ssl, &timer_server,
2161 mbedtls_timing_set_delay,
2162 mbedtls_timing_get_delay);
2163#endif
2164 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002165 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2166 MBEDTLS_SSL_IS_SERVER,
2167 options, NULL, NULL,
2168 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002169 }
2170
2171 mbedtls_ssl_conf_authmode(&server.conf, options->srv_auth_mode);
2172
Yanray Wange6afd912022-10-27 12:11:18 +08002173#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine353eb332025-05-14 17:42:53 +02002174 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(server.conf),
2175 (unsigned char) options->mfl),
2176 0);
2177 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(client.conf),
2178 (unsigned char) options->mfl),
2179 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002180#else
Gilles Peskine353eb332025-05-14 17:42:53 +02002181 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
Yanray Wange6afd912022-10-27 12:11:18 +08002182#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2183
2184#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2185 if (options->psk_str != NULL && options->psk_str->len > 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002186 TEST_EQUAL(mbedtls_ssl_conf_psk(
2187 &client.conf, options->psk_str->x,
2188 options->psk_str->len,
2189 (const unsigned char *) psk_identity,
2190 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002191
Gilles Peskine353eb332025-05-14 17:42:53 +02002192 TEST_EQUAL(mbedtls_ssl_conf_psk(
2193 &server.conf, options->psk_str->x,
2194 options->psk_str->len,
2195 (const unsigned char *) psk_identity,
2196 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002197#if defined(MBEDTLS_SSL_SRV_C)
2198 mbedtls_ssl_conf_psk_cb(&server.conf, psk_dummy_callback, NULL);
2199#endif
2200 }
2201#endif
2202#if defined(MBEDTLS_SSL_RENEGOTIATION)
2203 if (options->renegotiate) {
2204 mbedtls_ssl_conf_renegotiation(&(server.conf),
2205 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2206 mbedtls_ssl_conf_renegotiation(&(client.conf),
2207 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2208
2209 mbedtls_ssl_conf_legacy_renegotiation(&(server.conf),
2210 options->legacy_renegotiation);
2211 mbedtls_ssl_conf_legacy_renegotiation(&(client.conf),
2212 options->legacy_renegotiation);
2213 }
2214#endif /* MBEDTLS_SSL_RENEGOTIATION */
2215
Gilles Peskine353eb332025-05-14 17:42:53 +02002216 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client.socket),
2217 &(server.socket),
2218 BUFFSIZE), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002219
2220#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2221 if (options->resize_buffers != 0) {
2222 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002223 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2224 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2225 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2226 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002227 }
2228#endif
2229
2230 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2231 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2232 }
2233
Gilles Peskine353eb332025-05-14 17:42:53 +02002234 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client.ssl),
2235 &(server.ssl),
2236 MBEDTLS_SSL_HANDSHAKE_OVER),
2237 expected_handshake_result);
Yanray Wange6afd912022-10-27 12:11:18 +08002238
2239 if (expected_handshake_result != 0) {
2240 /* Connection will have failed by this point, skip to cleanup */
2241 goto exit;
2242 }
2243
Gilles Peskine353eb332025-05-14 17:42:53 +02002244 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002245
2246 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2247 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server.ssl),
2248 &(client.ssl),
2249 MBEDTLS_SSL_HANDSHAKE_OVER),
2250 0);
2251
Gilles Peskine353eb332025-05-14 17:42:53 +02002252 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002253 /* Check that both sides have negotiated the expected version. */
2254 mbedtls_test_set_step(0);
2255 if (!check_ssl_version(options->expected_negotiated_version,
2256 &client.ssl)) {
2257 goto exit;
2258 }
2259
2260 mbedtls_test_set_step(1);
2261 if (!check_ssl_version(options->expected_negotiated_version,
2262 &server.ssl)) {
2263 goto exit;
2264 }
2265
2266 if (options->expected_ciphersuite != 0) {
2267 TEST_EQUAL(server.ssl.session->ciphersuite,
2268 options->expected_ciphersuite);
2269 }
2270
2271#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2272 if (options->resize_buffers != 0) {
2273 /* A server, when using DTLS, might delay a buffer resize to happen
2274 * after it receives a message, so we force it. */
Gilles Peskine353eb332025-05-14 17:42:53 +02002275 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002276
Gilles Peskine353eb332025-05-14 17:42:53 +02002277 TEST_EQUAL(client.ssl.out_buf_len,
2278 mbedtls_ssl_get_output_buflen(&client.ssl));
2279 TEST_EQUAL(client.ssl.in_buf_len,
2280 mbedtls_ssl_get_input_buflen(&client.ssl));
2281 TEST_EQUAL(server.ssl.out_buf_len,
2282 mbedtls_ssl_get_output_buflen(&server.ssl));
2283 TEST_EQUAL(server.ssl.in_buf_len,
2284 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002285 }
2286#endif
2287
2288 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2289 /* Start data exchanging test */
Gilles Peskine353eb332025-05-14 17:42:53 +02002290 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2291 &(client.ssl), options->cli_msg_len,
2292 options->expected_cli_fragments,
2293 &(server.ssl), options->srv_msg_len,
2294 options->expected_srv_fragments),
2295 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002296 }
2297#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2298 if (options->serialize == 1) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002299 TEST_EQUAL(options->dtls, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002300
Gilles Peskine353eb332025-05-14 17:42:53 +02002301 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), NULL,
2302 0, &context_buf_len),
2303 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
Yanray Wange6afd912022-10-27 12:11:18 +08002304
2305 context_buf = mbedtls_calloc(1, context_buf_len);
2306 TEST_ASSERT(context_buf != NULL);
2307
Gilles Peskine353eb332025-05-14 17:42:53 +02002308 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), context_buf,
2309 context_buf_len,
2310 &context_buf_len),
2311 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002312
2313 mbedtls_ssl_free(&(server.ssl));
2314 mbedtls_ssl_init(&(server.ssl));
2315
Gilles Peskine353eb332025-05-14 17:42:53 +02002316 TEST_EQUAL(mbedtls_ssl_setup(&(server.ssl), &(server.conf)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002317
2318 mbedtls_ssl_set_bio(&(server.ssl), &server_context,
2319 mbedtls_test_mock_tcp_send_msg,
2320 mbedtls_test_mock_tcp_recv_msg,
2321 NULL);
2322
2323 mbedtls_ssl_set_user_data_p(&server.ssl, &server);
2324
2325#if defined(MBEDTLS_TIMING_C)
2326 mbedtls_ssl_set_timer_cb(&server.ssl, &timer_server,
2327 mbedtls_timing_set_delay,
2328 mbedtls_timing_get_delay);
2329#endif
2330#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2331 if (options->resize_buffers != 0) {
2332 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002333 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2334 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002335 }
2336#endif
Gilles Peskine353eb332025-05-14 17:42:53 +02002337 TEST_EQUAL(mbedtls_ssl_context_load(&(server.ssl), context_buf,
2338 context_buf_len), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002339
2340#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2341 /* Validate buffer sizes after context deserialization */
2342 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002343 TEST_EQUAL(server.ssl.out_buf_len,
2344 mbedtls_ssl_get_output_buflen(&server.ssl));
2345 TEST_EQUAL(server.ssl.in_buf_len,
2346 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002347 }
2348#endif
2349 /* Retest writing/reading */
2350 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002351 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2352 &(client.ssl), options->cli_msg_len,
2353 options->expected_cli_fragments,
2354 &(server.ssl), options->srv_msg_len,
2355 options->expected_srv_fragments),
2356 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002357 }
2358 }
2359#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2360
2361#if defined(MBEDTLS_SSL_RENEGOTIATION)
2362 if (options->renegotiate) {
2363 /* Start test with renegotiation */
Gilles Peskine353eb332025-05-14 17:42:53 +02002364 TEST_EQUAL(server.ssl.renego_status,
2365 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2366 TEST_EQUAL(client.ssl.renego_status,
2367 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002368
2369 /* After calling this function for the server, it only sends a handshake
2370 * request. All renegotiation should happen during data exchanging */
Gilles Peskine353eb332025-05-14 17:42:53 +02002371 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server.ssl)), 0);
2372 TEST_EQUAL(server.ssl.renego_status,
2373 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2374 TEST_EQUAL(client.ssl.renego_status,
2375 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002376
Gilles Peskine353eb332025-05-14 17:42:53 +02002377 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2378 TEST_EQUAL(server.ssl.renego_status,
2379 MBEDTLS_SSL_RENEGOTIATION_DONE);
2380 TEST_EQUAL(client.ssl.renego_status,
2381 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002382
2383 /* After calling mbedtls_ssl_renegotiate for the client,
2384 * all renegotiation should happen inside this function.
2385 * However in this test, we cannot perform simultaneous communication
2386 * between client and server so this function will return waiting error
2387 * on the socket. All rest of renegotiation should happen
2388 * during data exchanging */
2389 ret = mbedtls_ssl_renegotiate(&(client.ssl));
2390#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2391 if (options->resize_buffers != 0) {
2392 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002393 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2394 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002395 }
2396#endif
2397 TEST_ASSERT(ret == 0 ||
2398 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2399 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
Gilles Peskine353eb332025-05-14 17:42:53 +02002400 TEST_EQUAL(server.ssl.renego_status,
2401 MBEDTLS_SSL_RENEGOTIATION_DONE);
2402 TEST_EQUAL(client.ssl.renego_status,
2403 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
Yanray Wange6afd912022-10-27 12:11:18 +08002404
Gilles Peskine353eb332025-05-14 17:42:53 +02002405 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2406 TEST_EQUAL(server.ssl.renego_status,
2407 MBEDTLS_SSL_RENEGOTIATION_DONE);
2408 TEST_EQUAL(client.ssl.renego_status,
2409 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2411 /* Validate buffer sizes after renegotiation */
2412 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002413 TEST_EQUAL(client.ssl.out_buf_len,
2414 mbedtls_ssl_get_output_buflen(&client.ssl));
2415 TEST_EQUAL(client.ssl.in_buf_len,
2416 mbedtls_ssl_get_input_buflen(&client.ssl));
2417 TEST_EQUAL(server.ssl.out_buf_len,
2418 mbedtls_ssl_get_output_buflen(&server.ssl));
2419 TEST_EQUAL(server.ssl.in_buf_len,
2420 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002421 }
2422#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2423 }
2424#endif /* MBEDTLS_SSL_RENEGOTIATION */
2425
2426 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client.conf) == &client);
2427 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client.ssl) == &client);
2428 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server.conf) == &server);
2429 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server.ssl) == &server);
2430
2431exit:
2432 mbedtls_test_ssl_endpoint_free(&client,
Yanray Wangaf727a22023-03-13 19:22:36 +08002433 options->dtls != 0 ? &client_context : NULL);
Yanray Wange6afd912022-10-27 12:11:18 +08002434 mbedtls_test_ssl_endpoint_free(&server,
Yanray Wangaf727a22023-03-13 19:22:36 +08002435 options->dtls != 0 ? &server_context : NULL);
Yanray Wange6afd912022-10-27 12:11:18 +08002436#if defined(MBEDTLS_DEBUG_C)
2437 if (options->cli_log_fun || options->srv_log_fun) {
2438 mbedtls_debug_set_threshold(0);
2439 }
2440#endif
2441#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2442 if (context_buf != NULL) {
2443 mbedtls_free(context_buf);
2444 }
2445#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002446 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002447}
2448#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2449
2450#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002451int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002452 unsigned char *buf, unsigned char **end, int tweak,
2453 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2454{
2455/*
2456 * The definition of the tweaks assume that the certificate list contains only
2457 * one certificate.
2458 */
2459
2460/*
2461 * struct {
2462 * opaque cert_data<1..2^24-1>;
2463 * Extension extensions<0..2^16-1>;
2464 * } CertificateEntry;
2465 *
2466 * struct {
2467 * opaque certificate_request_context<0..2^8-1>;
2468 * CertificateEntry certificate_list<0..2^24-1>;
2469 * } Certificate;
2470 */
2471 unsigned char *p_certificate_request_context_len = buf;
2472 size_t certificate_request_context_len = buf[0];
2473
2474 unsigned char *p_certificate_list_len =
2475 buf + 1 + certificate_request_context_len;
2476 unsigned char *certificate_list = p_certificate_list_len + 3;
2477 size_t certificate_list_len =
2478 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2479
2480 unsigned char *p_cert_data_len = certificate_list;
2481 unsigned char *cert_data = p_cert_data_len + 3;
2482 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2483
2484 unsigned char *p_extensions_len = cert_data + cert_data_len;
2485 unsigned char *extensions = p_extensions_len + 2;
2486 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2487
2488 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2489
2490 switch (tweak) {
2491 case 1:
2492 /* Failure when checking if the certificate request context length
2493 * and certificate list length can be read
2494 */
2495 *end = buf + 3;
2496 set_chk_buf_ptr_args(args, buf, *end, 4);
2497 break;
2498
2499 case 2:
2500 /* Invalid certificate request context length.
2501 */
2502 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002503 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002504 reset_chk_buf_ptr_args(args);
2505 break;
2506
2507 case 3:
2508 /* Failure when checking if certificate_list data can be read. */
2509 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2510 p_certificate_list_len, 0);
2511 set_chk_buf_ptr_args(args, certificate_list, *end,
2512 certificate_list_len + 1);
2513 break;
2514
2515 case 4:
2516 /* Failure when checking if the cert_data length can be read. */
2517 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2518 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2519 break;
2520
2521 case 5:
2522 /* Failure when checking if cert_data data can be read. */
2523 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2524 p_cert_data_len, 0);
2525 set_chk_buf_ptr_args(args, cert_data,
2526 certificate_list + certificate_list_len,
2527 certificate_list_len - 3 + 1);
2528 break;
2529
2530 case 6:
2531 /* Failure when checking if the extensions length can be read. */
2532 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2533 p_certificate_list_len, 0);
2534 set_chk_buf_ptr_args(
2535 args, p_extensions_len,
2536 certificate_list + certificate_list_len - extensions_len - 1, 2);
2537 break;
2538
2539 case 7:
2540 /* Failure when checking if extensions data can be read. */
2541 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2542
2543 set_chk_buf_ptr_args(
2544 args, extensions,
2545 certificate_list + certificate_list_len, extensions_len + 1);
2546 break;
2547
2548 default:
2549 return -1;
2550 }
2551
2552 return 0;
2553}
2554#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002555
Ronald Cronfaf026c2024-01-31 14:32:06 +01002556/*
2557 * Functions for tests based on tickets. Implementations of the
2558 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2559 * Basically same implementations as in ticket.c without the encryption. That
2560 * way we can tweak easily tickets characteristics to simulate misbehaving
2561 * peers.
2562 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002563#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2564int mbedtls_test_ticket_write(
2565 void *p_ticket, const mbedtls_ssl_session *session,
2566 unsigned char *start, const unsigned char *end,
2567 size_t *tlen, uint32_t *lifetime)
2568{
2569 int ret;
2570 ((void) p_ticket);
2571
2572 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2573 tlen)) != 0) {
2574 return ret;
2575 }
2576
2577 /* Maximum ticket lifetime as defined in RFC 8446 */
2578 *lifetime = 7 * 24 * 3600;
2579
2580 return 0;
2581}
2582
2583int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2584 unsigned char *buf, size_t len)
2585{
2586 ((void) p_ticket);
2587
2588 return mbedtls_ssl_session_load(session, buf, len);
2589}
2590#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002591
2592#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2593 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2594 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2595int mbedtls_test_get_tls13_ticket(
2596 mbedtls_test_handshake_test_options *client_options,
2597 mbedtls_test_handshake_test_options *server_options,
2598 mbedtls_ssl_session *session)
2599{
2600 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002601 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002602 unsigned char buf[64];
2603 mbedtls_test_ssl_endpoint client_ep, server_ep;
2604
2605 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2606 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2607
2608 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
2609 client_options, NULL, NULL, NULL);
2610 TEST_EQUAL(ret, 0);
2611
2612 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
2613 server_options, NULL, NULL, NULL);
2614 TEST_EQUAL(ret, 0);
2615
2616 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2617 mbedtls_test_ticket_write,
2618 mbedtls_test_ticket_parse,
2619 NULL);
2620
2621 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2622 &(server_ep.socket), 1024);
2623 TEST_EQUAL(ret, 0);
2624
2625 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2626 &(server_ep.ssl), &(client_ep.ssl),
2627 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2628
2629 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2630
2631 do {
2632 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2633 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2634
2635 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2636 TEST_EQUAL(ret, 0);
2637
Gilles Peskine946bf142025-04-08 09:48:40 +02002638 ok = 1;
2639
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002640exit:
2641 mbedtls_test_ssl_endpoint_free(&client_ep, NULL);
2642 mbedtls_test_ssl_endpoint_free(&server_ep, NULL);
2643
Gilles Peskine946bf142025-04-08 09:48:40 +02002644 if (ret == 0 && !ok) {
2645 /* Exiting due to a test assertion that isn't ret == 0 */
2646 ret = -1;
2647 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002648 return ret;
2649}
2650#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2651 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2652 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2653
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002654#endif /* MBEDTLS_SSL_TLS_C */