blob: 580cc9b821319e3a4465200f4548f24bfd18f1ee [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,
Gilles Peskine9b993682025-05-27 18:44:12 +0200739 const mbedtls_test_handshake_test_options *options,
Yanray Wange6afd912022-10-27 12:11:18 +0800740 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{
Gilles Peskine29969592025-05-27 19:24:28 +0200744 (void) dtls_context; // no longer used
745
Yanray Wange6afd912022-10-27 12:11:18 +0800746 int ret = -1;
747 uintptr_t user_data_n;
748
Gilles Peskine29969592025-05-27 19:24:28 +0200749 if (options->dtls &&
Yanray Wange6afd912022-10-27 12:11:18 +0800750 (input_queue == NULL || output_queue == NULL)) {
751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
752
753 }
754
755 if (ep == NULL) {
756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
757 }
758
759 memset(ep, 0, sizeof(*ep));
760
761 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
762
763 mbedtls_ssl_init(&(ep->ssl));
764 mbedtls_ssl_config_init(&(ep->conf));
Gilles Peskine29969592025-05-27 19:24:28 +0200765 mbedtls_test_message_socket_init(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800766
767 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
768 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
769 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
770 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
771
772 (void) mbedtls_test_rnd_std_rand(NULL,
773 (void *) &user_data_n,
774 sizeof(user_data_n));
775 mbedtls_ssl_conf_set_user_data_n(&ep->conf, user_data_n);
776 mbedtls_ssl_set_user_data_n(&ep->ssl, user_data_n);
777
Gilles Peskine29969592025-05-27 19:24:28 +0200778 if (options->dtls) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200779 TEST_EQUAL(mbedtls_test_message_socket_setup(input_queue, output_queue,
780 100, &(ep->socket),
Gilles Peskine29969592025-05-27 19:24:28 +0200781 &ep->dtls_context), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800782 } else {
Yanray Wang5f86a422023-03-15 16:02:29 +0800783 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800784 }
785
786 /* Non-blocking callbacks without timeout */
Gilles Peskine29969592025-05-27 19:24:28 +0200787 if (options->dtls) {
788 mbedtls_ssl_set_bio(&(ep->ssl), &ep->dtls_context,
Yanray Wange6afd912022-10-27 12:11:18 +0800789 mbedtls_test_mock_tcp_send_msg,
790 mbedtls_test_mock_tcp_recv_msg,
791 NULL);
Gilles Peskine0677e022025-05-27 18:05:20 +0200792#if defined(MBEDTLS_TIMING_C)
793 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
794 mbedtls_timing_set_delay,
795 mbedtls_timing_get_delay);
796#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800797 } else {
798 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
799 mbedtls_test_mock_tcp_send_nb,
800 mbedtls_test_mock_tcp_recv_nb,
801 NULL);
802 }
803
804 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
Gilles Peskine29969592025-05-27 19:24:28 +0200805 options->dtls ?
Yanray Wange6afd912022-10-27 12:11:18 +0800806 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
807 MBEDTLS_SSL_TRANSPORT_STREAM,
808 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200809 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800810
Ronald Crona697a712023-03-09 17:47:42 +0100811 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
812 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
813 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
814 options->client_min_version);
815 }
816
817 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
818 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
819 options->client_max_version);
820 }
821 } else {
822 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
823 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
824 options->server_min_version);
825 }
826
827 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
828 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
829 options->server_max_version);
830 }
831 }
832
Ronald Cronfb536472024-01-26 14:55:25 +0100833 if (options->group_list != NULL) {
834 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800835 }
836
837 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
838
Ronald Cronced99be2024-01-26 15:49:12 +0100839#if defined(MBEDTLS_SSL_EARLY_DATA)
840 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100841#if defined(MBEDTLS_SSL_SRV_C)
842 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
843 (options->max_early_data_size >= 0)) {
844 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
845 options->max_early_data_size);
846 }
847#endif
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000848#if defined(MBEDTLS_SSL_ALPN)
849 /* check that alpn_list contains at least one valid entry */
850 if (options->alpn_list[0] != NULL) {
851 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
852 }
853#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100854#endif
855
Yanray Wange6afd912022-10-27 12:11:18 +0800856#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
857 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
858 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
859 mbedtls_ssl_cache_get,
860 mbedtls_ssl_cache_set);
861 }
862#endif
863
864 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
Gilles Peskine353eb332025-05-14 17:42:53 +0200865 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800866
Gilles Peskine856a3702025-02-13 17:28:49 +0100867 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
868 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
Gilles Peskine55b8bb42025-04-08 09:44:34 +0200869 TEST_EQUAL(ret, 0);
Gilles Peskine856a3702025-02-13 17:28:49 +0100870 }
871
Yanray Wange6afd912022-10-27 12:11:18 +0800872#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine29969592025-05-27 19:24:28 +0200873 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->dtls) {
Yanray Wange6afd912022-10-27 12:11:18 +0800874 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
875 }
876#endif
877
Ronald Cronec3408d2024-01-16 17:50:40 +0100878#if defined(MBEDTLS_DEBUG_C)
879#if defined(MBEDTLS_SSL_SRV_C)
880 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
881 options->srv_log_fun != NULL) {
882 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
883 options->srv_log_obj);
884 }
885#endif
886#if defined(MBEDTLS_SSL_CLI_C)
887 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
888 options->cli_log_fun != NULL) {
889 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
890 options->cli_log_obj);
891 }
892#endif
893#endif /* MBEDTLS_DEBUG_C */
894
Yanray Wange6afd912022-10-27 12:11:18 +0800895 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
896 options->opaque_alg,
897 options->opaque_alg2,
898 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200899 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800900
901 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), user_data_n);
902 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
903 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), user_data_n);
904 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
905
Gilles Peskine946bf142025-04-08 09:48:40 +0200906 return 0;
907
Yanray Wange6afd912022-10-27 12:11:18 +0800908exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200909 if (ret == 0) {
910 /* Exiting due to a test assertion that isn't ret == 0 */
911 ret = -1;
912 }
Yanray Wange6afd912022-10-27 12:11:18 +0800913 return ret;
914}
915
Yanray Wange6afd912022-10-27 12:11:18 +0800916void mbedtls_test_ssl_endpoint_free(
917 mbedtls_test_ssl_endpoint *ep,
918 mbedtls_test_message_socket_context *context)
919{
Gilles Peskine29969592025-05-27 19:24:28 +0200920 (void) context; // no longer used
921
Yanray Wange6afd912022-10-27 12:11:18 +0800922 mbedtls_ssl_free(&(ep->ssl));
923 mbedtls_ssl_config_free(&(ep->conf));
924
Gilles Peskine2744a432025-05-27 13:27:22 +0200925 mbedtls_free(ep->ciphersuites);
926 ep->ciphersuites = NULL;
927 test_ssl_endpoint_certificate_free(ep);
928
Gilles Peskine29969592025-05-27 19:24:28 +0200929 if (ep->dtls_context.socket != NULL) {
930 mbedtls_test_message_socket_close(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800931 } else {
932 mbedtls_test_mock_socket_close(&(ep->socket));
933 }
934}
935
Yanray Wange6afd912022-10-27 12:11:18 +0800936int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
937 mbedtls_ssl_context *second_ssl,
938 int state)
939{
940 enum { BUFFSIZE = 1024 };
941 int max_steps = 1000;
942 int ret = 0;
943
944 if (ssl == NULL || second_ssl == NULL) {
945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
946 }
947
948 /* Perform communication via connected sockets */
949 while ((ssl->state != state) && (--max_steps >= 0)) {
950 /* If /p second_ssl ends the handshake procedure before /p ssl then
951 * there is no need to call the next step */
952 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
953 ret = mbedtls_ssl_handshake_step(second_ssl);
954 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
955 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
956 return ret;
957 }
958 }
959
960 /* We only care about the \p ssl state and returns, so we call it last,
961 * to leave the iteration as soon as the state is as expected. */
962 ret = mbedtls_ssl_handshake_step(ssl);
963 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
964 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
965 return ret;
966 }
967 }
968
969 return (max_steps >= 0) ? ret : -1;
970}
971
972#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
973
974/*
975 * Write application data. Increase write counter if necessary.
976 */
Michael Schuster54300d42024-06-04 02:30:22 +0200977static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +0200978 unsigned char *buf, int buf_len,
979 int *written,
980 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +0800981{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100982 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +0800983 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
984 * a valid no-op for TLS connections. */
985 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200986 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800987 }
988
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100989 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +0800990 if (ret > 0) {
991 *written += ret;
992 }
993
994 if (expected_fragments == 0) {
995 /* Used for DTLS and the message size larger than MFL. In that case
996 * the message can not be fragmented and the library should return
997 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +0800998 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +0800999 return ret;
1000 } else if (expected_fragments == 1) {
1001 /* Used for TLS/DTLS and the message size lower than MFL */
1002 TEST_ASSERT(ret == buf_len ||
1003 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1004 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1005 } else {
1006 /* Used for TLS and the message size larger than MFL */
1007 TEST_ASSERT(expected_fragments > 1);
1008 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1009 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1010 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1011 }
1012
1013 return 0;
1014
1015exit:
1016 /* Some of the tests failed */
1017 return -1;
1018}
1019
1020/*
1021 * Read application data and increase read counter and fragments counter
1022 * if necessary.
1023 */
Michael Schuster54300d42024-06-04 02:30:22 +02001024static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001025 unsigned char *buf, int buf_len,
1026 int *read, int *fragments,
1027 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001028{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001029 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001030 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1031 * a valid no-op for TLS connections. */
1032 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001033 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001034 }
1035
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001036 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001037 if (ret > 0) {
1038 (*fragments)++;
1039 *read += ret;
1040 }
1041
1042 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001043 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001044 } else if (expected_fragments == 1) {
1045 TEST_ASSERT(ret == buf_len ||
1046 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1047 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1048 } else {
1049 TEST_ASSERT(expected_fragments > 1);
1050 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1051 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1052 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1053 }
1054
1055 return 0;
1056
1057exit:
1058 /* Some of the tests failed */
1059 return -1;
1060}
1061
Yanray Wangead70c82023-03-16 12:04:49 +08001062#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine2744a432025-05-27 13:27:22 +02001063static int set_ciphersuite(mbedtls_test_ssl_endpoint *ep,
1064 const char *cipher)
Yanray Wange6afd912022-10-27 12:11:18 +08001065{
Gilles Peskine2744a432025-05-27 13:27:22 +02001066 if (cipher == NULL || cipher[0] == 0) {
1067 return 1;
1068 }
Yanray Wange6afd912022-10-27 12:11:18 +08001069
Gilles Peskine2744a432025-05-27 13:27:22 +02001070 int ok = 0;
1071
1072 TEST_CALLOC(ep->ciphersuites, 2);
1073 ep->ciphersuites[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
1074 ep->ciphersuites[1] = 0;
1075
1076 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1077 mbedtls_ssl_ciphersuite_from_id(ep->ciphersuites[0]);
Yanray Wange6afd912022-10-27 12:11:18 +08001078
1079 TEST_ASSERT(ciphersuite_info != NULL);
Gilles Peskine2744a432025-05-27 13:27:22 +02001080 TEST_ASSERT(ciphersuite_info->min_tls_version <= ep->conf.max_tls_version);
1081 TEST_ASSERT(ciphersuite_info->max_tls_version >= ep->conf.min_tls_version);
Yanray Wange6afd912022-10-27 12:11:18 +08001082
Gilles Peskine2744a432025-05-27 13:27:22 +02001083 if (ep->conf.max_tls_version > ciphersuite_info->max_tls_version) {
1084 ep->conf.max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001085 }
Gilles Peskine2744a432025-05-27 13:27:22 +02001086 if (ep->conf.min_tls_version < ciphersuite_info->min_tls_version) {
1087 ep->conf.min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001088 }
1089
Gilles Peskine2744a432025-05-27 13:27:22 +02001090 mbedtls_ssl_conf_ciphersuites(&ep->conf, ep->ciphersuites);
1091 ok = 1;
Yanray Wange6afd912022-10-27 12:11:18 +08001092
1093exit:
Gilles Peskine2744a432025-05-27 13:27:22 +02001094 return ok;
Yanray Wange6afd912022-10-27 12:11:18 +08001095}
Yanray Wangead70c82023-03-16 12:04:49 +08001096#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Yanray Wange6afd912022-10-27 12:11:18 +08001097
Yanray Wangead70c82023-03-16 12:04:49 +08001098#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
1099 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
1100 defined(MBEDTLS_SSL_SRV_C)
1101static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
1102 const unsigned char *name, size_t name_len)
Yanray Wange6afd912022-10-27 12:11:18 +08001103{
1104 (void) p_info;
1105 (void) ssl;
1106 (void) name;
1107 (void) name_len;
1108
1109 return 0;
1110}
Yanray Wangead70c82023-03-16 12:04:49 +08001111#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
1112 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
1113 MBEDTLS_SSL_SRV_C */
Yanray Wange6afd912022-10-27 12:11:18 +08001114
1115#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001116 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001117int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1118 const unsigned char *iv,
1119 size_t iv_len,
1120 const unsigned char *input,
1121 size_t ilen,
1122 unsigned char *output,
1123 size_t *olen)
1124{
1125#if defined(MBEDTLS_USE_PSA_CRYPTO)
1126 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1127 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1128 size_t part_len;
1129
1130 status = psa_cipher_encrypt_setup(&cipher_op,
1131 transform->psa_key_enc,
1132 transform->psa_alg);
1133
1134 if (status != PSA_SUCCESS) {
1135 return PSA_TO_MBEDTLS_ERR(status);
1136 }
1137
1138 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1139
1140 if (status != PSA_SUCCESS) {
1141 return PSA_TO_MBEDTLS_ERR(status);
1142 }
1143
1144 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1145
1146 if (status != PSA_SUCCESS) {
1147 return PSA_TO_MBEDTLS_ERR(status);
1148 }
1149
1150 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1151 &part_len);
1152
1153 if (status != PSA_SUCCESS) {
1154 return PSA_TO_MBEDTLS_ERR(status);
1155 }
1156
1157 *olen += part_len;
1158 return 0;
1159#else
1160 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1161 iv, iv_len, input, ilen, output, olen);
1162#endif /* MBEDTLS_USE_PSA_CRYPTO */
1163}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001164#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001165 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001166
Valerio Setti31ad3a12023-10-27 11:55:02 +02001167static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1168 mbedtls_cipher_mode_t *cipher_mode,
1169 size_t *key_bits, size_t *iv_len)
1170{
1171 switch (cipher_type) {
1172 case MBEDTLS_CIPHER_AES_128_CBC:
1173 *cipher_mode = MBEDTLS_MODE_CBC;
1174 *key_bits = 128;
1175 *iv_len = 16;
1176 break;
1177 case MBEDTLS_CIPHER_AES_256_CBC:
1178 *cipher_mode = MBEDTLS_MODE_CBC;
1179 *key_bits = 256;
1180 *iv_len = 16;
1181 break;
1182 case MBEDTLS_CIPHER_ARIA_128_CBC:
1183 *cipher_mode = MBEDTLS_MODE_CBC;
1184 *key_bits = 128;
1185 *iv_len = 16;
1186 break;
1187 case MBEDTLS_CIPHER_ARIA_256_CBC:
1188 *cipher_mode = MBEDTLS_MODE_CBC;
1189 *key_bits = 256;
1190 *iv_len = 16;
1191 break;
1192 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1193 *cipher_mode = MBEDTLS_MODE_CBC;
1194 *key_bits = 128;
1195 *iv_len = 16;
1196 break;
1197 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1198 *cipher_mode = MBEDTLS_MODE_CBC;
1199 *key_bits = 256;
1200 *iv_len = 16;
1201 break;
1202
1203 case MBEDTLS_CIPHER_AES_128_CCM:
1204 *cipher_mode = MBEDTLS_MODE_CCM;
1205 *key_bits = 128;
1206 *iv_len = 12;
1207 break;
1208 case MBEDTLS_CIPHER_AES_192_CCM:
1209 *cipher_mode = MBEDTLS_MODE_CCM;
1210 *key_bits = 192;
1211 *iv_len = 12;
1212 break;
1213 case MBEDTLS_CIPHER_AES_256_CCM:
1214 *cipher_mode = MBEDTLS_MODE_CCM;
1215 *key_bits = 256;
1216 *iv_len = 12;
1217 break;
1218 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1219 *cipher_mode = MBEDTLS_MODE_CCM;
1220 *key_bits = 128;
1221 *iv_len = 12;
1222 break;
1223 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1224 *cipher_mode = MBEDTLS_MODE_CCM;
1225 *key_bits = 192;
1226 *iv_len = 12;
1227 break;
1228 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1229 *cipher_mode = MBEDTLS_MODE_CCM;
1230 *key_bits = 256;
1231 *iv_len = 12;
1232 break;
1233
1234 case MBEDTLS_CIPHER_AES_128_GCM:
1235 *cipher_mode = MBEDTLS_MODE_GCM;
1236 *key_bits = 128;
1237 *iv_len = 12;
1238 break;
1239 case MBEDTLS_CIPHER_AES_192_GCM:
1240 *cipher_mode = MBEDTLS_MODE_GCM;
1241 *key_bits = 192;
1242 *iv_len = 12;
1243 break;
1244 case MBEDTLS_CIPHER_AES_256_GCM:
1245 *cipher_mode = MBEDTLS_MODE_GCM;
1246 *key_bits = 256;
1247 *iv_len = 12;
1248 break;
1249 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1250 *cipher_mode = MBEDTLS_MODE_GCM;
1251 *key_bits = 128;
1252 *iv_len = 12;
1253 break;
1254 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1255 *cipher_mode = MBEDTLS_MODE_GCM;
1256 *key_bits = 192;
1257 *iv_len = 12;
1258 break;
1259 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1260 *cipher_mode = MBEDTLS_MODE_GCM;
1261 *key_bits = 256;
1262 *iv_len = 12;
1263 break;
1264
1265 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1266 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1267 *key_bits = 256;
1268 *iv_len = 12;
1269 break;
1270
1271 case MBEDTLS_CIPHER_NULL:
1272 *cipher_mode = MBEDTLS_MODE_STREAM;
1273 *key_bits = 0;
1274 *iv_len = 0;
1275 break;
1276
1277 default:
1278 *cipher_mode = MBEDTLS_MODE_NONE;
1279 *key_bits = 0;
1280 *iv_len = 0;
1281 }
1282}
1283
Yanray Wange6afd912022-10-27 12:11:18 +08001284int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1285 mbedtls_ssl_transform *t_out,
1286 int cipher_type, int hash_id,
1287 int etm, int tag_mode,
1288 mbedtls_ssl_protocol_version tls_version,
1289 size_t cid0_len,
1290 size_t cid1_len)
1291{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001292 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1293 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001294 int ret = 0;
1295
1296#if defined(MBEDTLS_USE_PSA_CRYPTO)
1297 psa_key_type_t key_type;
1298 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1299 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001300 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001301#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001302 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001303#endif
1304
Valerio Setti31ad3a12023-10-27 11:55:02 +02001305 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001306 unsigned char *key0 = NULL, *key1 = NULL;
1307 unsigned char *md0 = NULL, *md1 = NULL;
1308 unsigned char iv_enc[16], iv_dec[16];
1309
1310#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1311 unsigned char cid0[SSL_CID_LEN_MIN];
1312 unsigned char cid1[SSL_CID_LEN_MIN];
1313
1314 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1315 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1316#else
1317 ((void) cid0_len);
1318 ((void) cid1_len);
1319#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1320
1321 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001322 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1323 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001324
1325 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001326 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001327 /* Allocate `keylen + 1` bytes to ensure that we get
1328 * a non-NULL pointers from `mbedtls_calloc` even if
1329 * `keylen == 0` in the case of the NULL cipher. */
1330 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1331 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1332 memset(key0, 0x1, keylen);
1333 memset(key1, 0x2, keylen);
1334
1335#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001336 /* Pick cipher */
1337 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1338 CHK(cipher_info != NULL);
1339 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1340 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001341
Yanray Wange6afd912022-10-27 12:11:18 +08001342 /* Setup cipher contexts */
1343 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1344 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1345 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1346 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1347
1348#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001349 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001350 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1351 MBEDTLS_PADDING_NONE) == 0);
1352 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1353 MBEDTLS_PADDING_NONE) == 0);
1354 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1355 MBEDTLS_PADDING_NONE) == 0);
1356 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1357 MBEDTLS_PADDING_NONE) == 0);
1358 }
1359#endif /* MBEDTLS_CIPHER_MODE_CBC */
1360
1361 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001362 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1363 MBEDTLS_ENCRYPT)
1364 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001365 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001366 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1367 MBEDTLS_DECRYPT)
1368 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001369 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001370 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1371 MBEDTLS_ENCRYPT)
1372 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001373 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001374 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1375 MBEDTLS_DECRYPT)
1376 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001377#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001378
1379 /* Setup MAC contexts */
1380#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001381 if (cipher_mode == MBEDTLS_MODE_CBC ||
1382 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001383#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001384 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 +08001385 CHK(md_info != NULL);
1386#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001387 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001388 CHK(maclen != 0);
1389 /* Pick hash keys */
1390 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1391 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1392 memset(md0, 0x5, maclen);
1393 memset(md1, 0x6, maclen);
1394
1395#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001396 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001397
1398 CHK(alg != 0);
1399
1400 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1401 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1402 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1403 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1404 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1405 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1406
1407 psa_reset_key_attributes(&attributes);
1408 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1409 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1410 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1411
1412 CHK(psa_import_key(&attributes,
1413 md0, maclen,
1414 &t_in->psa_mac_enc) == PSA_SUCCESS);
1415
1416 CHK(psa_import_key(&attributes,
1417 md1, maclen,
1418 &t_out->psa_mac_enc) == PSA_SUCCESS);
1419
Valerio Setti31ad3a12023-10-27 11:55:02 +02001420 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001421 etm == MBEDTLS_SSL_ETM_DISABLED) {
1422 /* mbedtls_ct_hmac() requires the key to be exportable */
1423 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1424 PSA_KEY_USAGE_VERIFY_HASH);
1425 } else {
1426 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1427 }
1428
1429 CHK(psa_import_key(&attributes,
1430 md1, maclen,
1431 &t_in->psa_mac_dec) == PSA_SUCCESS);
1432
1433 CHK(psa_import_key(&attributes,
1434 md0, maclen,
1435 &t_out->psa_mac_dec) == PSA_SUCCESS);
1436#else
1437 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1438 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1439 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1440 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1441
1442 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1443 md0, maclen) == 0);
1444 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1445 md1, maclen) == 0);
1446 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1447 md1, maclen) == 0);
1448 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1449 md0, maclen) == 0);
1450#endif
1451 }
1452#else
1453 ((void) hash_id);
1454#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1455
1456
1457 /* Pick IV's (regardless of whether they
1458 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001459 memset(iv_enc, 0x3, sizeof(iv_enc));
1460 memset(iv_dec, 0x4, sizeof(iv_dec));
1461
1462 /*
1463 * Setup transforms
1464 */
1465
1466#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1467 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1468 t_out->encrypt_then_mac = etm;
1469 t_in->encrypt_then_mac = etm;
1470#else
1471 ((void) etm);
1472#endif
1473
1474 t_out->tls_version = tls_version;
1475 t_in->tls_version = tls_version;
1476 t_out->ivlen = ivlen;
1477 t_in->ivlen = ivlen;
1478
Valerio Setti31ad3a12023-10-27 11:55:02 +02001479 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001480 case MBEDTLS_MODE_GCM:
1481 case MBEDTLS_MODE_CCM:
1482#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1483 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1484 t_out->fixed_ivlen = 12;
1485 t_in->fixed_ivlen = 12;
1486 } else
1487#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1488 {
1489 t_out->fixed_ivlen = 4;
1490 t_in->fixed_ivlen = 4;
1491 }
1492 t_out->maclen = 0;
1493 t_in->maclen = 0;
1494 switch (tag_mode) {
1495 case 0: /* Full tag */
1496 t_out->taglen = 16;
1497 t_in->taglen = 16;
1498 break;
1499 case 1: /* Partial tag */
1500 t_out->taglen = 8;
1501 t_in->taglen = 8;
1502 break;
1503 default:
1504 ret = 1;
1505 goto cleanup;
1506 }
1507 break;
1508
1509 case MBEDTLS_MODE_CHACHAPOLY:
1510 t_out->fixed_ivlen = 12;
1511 t_in->fixed_ivlen = 12;
1512 t_out->maclen = 0;
1513 t_in->maclen = 0;
1514 switch (tag_mode) {
1515 case 0: /* Full tag */
1516 t_out->taglen = 16;
1517 t_in->taglen = 16;
1518 break;
1519 case 1: /* Partial tag */
1520 t_out->taglen = 8;
1521 t_in->taglen = 8;
1522 break;
1523 default:
1524 ret = 1;
1525 goto cleanup;
1526 }
1527 break;
1528
1529 case MBEDTLS_MODE_STREAM:
1530 case MBEDTLS_MODE_CBC:
1531 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1532 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1533 t_out->taglen = 0;
1534 t_in->taglen = 0;
1535 switch (tag_mode) {
1536 case 0: /* Full tag */
1537 t_out->maclen = maclen;
1538 t_in->maclen = maclen;
1539 break;
1540 default:
1541 ret = 1;
1542 goto cleanup;
1543 }
1544 break;
1545 default:
1546 ret = 1;
1547 goto cleanup;
1548 break;
1549 }
1550
1551 /* Setup IV's */
1552
1553 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1554 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1555 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1556 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1557
1558#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1559 /* Add CID */
1560 memcpy(&t_in->in_cid, cid0, cid0_len);
1561 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001562 t_in->in_cid_len = (uint8_t) cid0_len;
1563 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001564 memcpy(&t_out->in_cid, cid1, cid1_len);
1565 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001566 t_out->in_cid_len = (uint8_t) cid1_len;
1567 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001568#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1569
1570#if defined(MBEDTLS_USE_PSA_CRYPTO)
1571 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1572 t_in->taglen,
1573 &alg,
1574 &key_type,
1575 &key_bits);
1576
1577 if (status != PSA_SUCCESS) {
1578 ret = PSA_TO_MBEDTLS_ERR(status);
1579 goto cleanup;
1580 }
1581
1582 t_in->psa_alg = alg;
1583 t_out->psa_alg = alg;
1584
1585 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1586 psa_reset_key_attributes(&attributes);
1587 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1588 psa_set_key_algorithm(&attributes, alg);
1589 psa_set_key_type(&attributes, key_type);
1590
1591 status = psa_import_key(&attributes,
1592 key0,
1593 PSA_BITS_TO_BYTES(key_bits),
1594 &t_in->psa_key_enc);
1595
1596 if (status != PSA_SUCCESS) {
1597 ret = PSA_TO_MBEDTLS_ERR(status);
1598 goto cleanup;
1599 }
1600
1601 status = psa_import_key(&attributes,
1602 key1,
1603 PSA_BITS_TO_BYTES(key_bits),
1604 &t_out->psa_key_enc);
1605
1606 if (status != PSA_SUCCESS) {
1607 ret = PSA_TO_MBEDTLS_ERR(status);
1608 goto cleanup;
1609 }
1610
1611 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1612
1613 status = psa_import_key(&attributes,
1614 key1,
1615 PSA_BITS_TO_BYTES(key_bits),
1616 &t_in->psa_key_dec);
1617
1618 if (status != PSA_SUCCESS) {
1619 ret = PSA_TO_MBEDTLS_ERR(status);
1620 goto cleanup;
1621 }
1622
1623 status = psa_import_key(&attributes,
1624 key0,
1625 PSA_BITS_TO_BYTES(key_bits),
1626 &t_out->psa_key_dec);
1627
1628 if (status != PSA_SUCCESS) {
1629 ret = PSA_TO_MBEDTLS_ERR(status);
1630 goto cleanup;
1631 }
1632 }
1633#endif /* MBEDTLS_USE_PSA_CRYPTO */
1634
1635cleanup:
1636
1637 mbedtls_free(key0);
1638 mbedtls_free(key1);
1639
1640 mbedtls_free(md0);
1641 mbedtls_free(md1);
1642
1643 return ret;
1644}
1645
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001646#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1647int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1648 mbedtls_ssl_transform *transform_out)
1649{
1650#if defined(MBEDTLS_USE_PSA_CRYPTO)
1651 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1652#endif
1653
1654 /* Serialized version of record header for MAC purposes */
1655 unsigned char add_data[13];
1656 memcpy(add_data, record->ctr, 8);
1657 add_data[8] = record->type;
1658 add_data[9] = record->ver[0];
1659 add_data[10] = record->ver[1];
1660 add_data[11] = (record->data_len >> 8) & 0xff;
1661 add_data[12] = (record->data_len >> 0) & 0xff;
1662
1663 /* MAC with additional data */
1664#if defined(MBEDTLS_USE_PSA_CRYPTO)
1665 size_t sign_mac_length = 0;
1666 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1667 transform_out->psa_mac_enc,
1668 transform_out->psa_mac_alg));
1669 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1670 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1671 record->buf + record->data_offset,
1672 record->data_len));
1673 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1674 * extension, there might not be enough room in the record for the
1675 * full-length MAC. */
1676 unsigned char mac[PSA_HASH_MAX_SIZE];
1677 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1678 mac, sizeof(mac),
1679 &sign_mac_length));
1680#else
1681 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1682 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1683 record->buf + record->data_offset,
1684 record->data_len));
1685 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1686 * extension, there might not be enough room in the record for the
1687 * full-length MAC. */
1688 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1689 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1690#endif
1691 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1692 record->data_len += transform_out->maclen;
1693
1694 return 0;
1695
1696exit:
1697#if defined(MBEDTLS_USE_PSA_CRYPTO)
1698 psa_mac_abort(&operation);
1699#endif
1700 return -1;
1701}
1702#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1703
Jerry Yu28547c42023-10-31 14:42:50 +08001704#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001705int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1706 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001707 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001708 const char *crt_file)
1709{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001710 (void) ticket_len;
1711
Yanray Wange6afd912022-10-27 12:11:18 +08001712#if defined(MBEDTLS_HAVE_TIME)
1713 session->start = mbedtls_time(NULL) - 42;
1714#endif
1715 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001716
1717 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1718 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1719
1720 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001721 session->ciphersuite = 0xabcd;
1722 session->id_len = sizeof(session->id);
1723 memset(session->id, 66, session->id_len);
1724 memset(session->master, 17, sizeof(session->master));
1725
1726#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1727 if (crt_file != NULL && strlen(crt_file) != 0) {
1728 mbedtls_x509_crt tmp_crt;
1729 int ret;
1730
1731 mbedtls_x509_crt_init(&tmp_crt);
1732 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1733 if (ret != 0) {
1734 return ret;
1735 }
1736
1737#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1738 /* Move temporary CRT. */
1739 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1740 if (session->peer_cert == NULL) {
1741 return -1;
1742 }
1743 *session->peer_cert = tmp_crt;
1744 memset(&tmp_crt, 0, sizeof(tmp_crt));
1745#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1746 /* Calculate digest of temporary CRT. */
1747 session->peer_cert_digest =
1748 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1749 if (session->peer_cert_digest == NULL) {
1750 return -1;
1751 }
1752
1753#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001754 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001755 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1756 size_t hash_size = 0;
1757 psa_status_t status = psa_hash_compute(
1758 psa_alg, tmp_crt.raw.p,
1759 tmp_crt.raw.len,
1760 session->peer_cert_digest,
1761 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1762 &hash_size);
1763 ret = PSA_TO_MBEDTLS_ERR(status);
1764#else
1765 ret = mbedtls_md(mbedtls_md_info_from_type(
1766 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1767 tmp_crt.raw.p, tmp_crt.raw.len,
1768 session->peer_cert_digest);
1769#endif /* MBEDTLS_USE_PSA_CRYPTO */
1770 if (ret != 0) {
1771 return ret;
1772 }
1773 session->peer_cert_digest_type =
1774 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1775 session->peer_cert_digest_len =
1776 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1777#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1778
1779 mbedtls_x509_crt_free(&tmp_crt);
1780 }
1781#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1782 (void) crt_file;
1783#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1784 session->verify_result = 0xdeadbeef;
1785
Ronald Cronc57f86e2023-11-22 09:50:01 +01001786#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1787#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001788 if (ticket_len != 0) {
1789 session->ticket = mbedtls_calloc(1, ticket_len);
1790 if (session->ticket == NULL) {
1791 return -1;
1792 }
1793 memset(session->ticket, 33, ticket_len);
1794 }
1795 session->ticket_len = ticket_len;
1796 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001797#endif /* MBEDTLS_SSL_CLI_C */
1798
1799#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1800 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1801 session->ticket_creation_time = mbedtls_ms_time() - 42;
1802 }
Yanray Wange6afd912022-10-27 12:11:18 +08001803#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001804#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001805
1806#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1807 session->mfl_code = 1;
1808#endif
1809#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1810 session->encrypt_then_mac = 1;
1811#endif
1812
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001813exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001814 return 0;
1815}
Jerry Yu28547c42023-10-31 14:42:50 +08001816#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001817
1818#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1819int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1820 int ticket_len,
1821 int endpoint_type)
1822{
1823 ((void) ticket_len);
1824 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1825 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1826 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1827 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001828
1829#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001830 session->ticket_age_add = 0x87654321;
1831 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001832 session->resumption_key_len = 32;
1833 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001834#endif
1835
Ronald Cron18b92a12024-03-26 10:15:08 +01001836#if defined(MBEDTLS_SSL_SRV_C)
1837 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1838#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1839#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1840 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1841 if (ret != 0) {
1842 return -1;
1843 }
1844#endif
1845#if defined(MBEDTLS_HAVE_TIME)
1846 session->ticket_creation_time = mbedtls_ms_time() - 42;
1847#endif
1848#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1849 }
1850#endif /* MBEDTLS_SSL_SRV_C */
1851
Yanray Wange6afd912022-10-27 12:11:18 +08001852#if defined(MBEDTLS_SSL_CLI_C)
1853 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001854#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001855#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001856 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001857#endif
1858 session->ticket_lifetime = 0xfedcba98;
1859
1860 session->ticket_len = ticket_len;
1861 if (ticket_len != 0) {
1862 session->ticket = mbedtls_calloc(1, ticket_len);
1863 if (session->ticket == NULL) {
1864 return -1;
1865 }
1866 memset(session->ticket, 33, ticket_len);
1867 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001868#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1869 char hostname[] = "hostname example";
1870 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1871 if (session->hostname == NULL) {
1872 return -1;
1873 }
1874 memcpy(session->hostname, hostname, sizeof(hostname));
1875#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001876#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001877 }
1878#endif /* MBEDTLS_SSL_CLI_C */
1879
Ronald Cron18b92a12024-03-26 10:15:08 +01001880#if defined(MBEDTLS_SSL_EARLY_DATA)
1881 session->max_early_data_size = 0x87654321;
1882#endif /* MBEDTLS_SSL_EARLY_DATA */
1883
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001884#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1885 session->record_size_limit = 2048;
1886#endif
1887
Yanray Wange6afd912022-10-27 12:11:18 +08001888 return 0;
1889}
1890#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1891
Yanray Wangb088bfc2023-03-16 12:15:49 +08001892int mbedtls_test_ssl_exchange_data(
1893 mbedtls_ssl_context *ssl_1,
1894 int msg_len_1, const int expected_fragments_1,
1895 mbedtls_ssl_context *ssl_2,
1896 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001897{
1898 unsigned char *msg_buf_1 = malloc(msg_len_1);
1899 unsigned char *msg_buf_2 = malloc(msg_len_2);
1900 unsigned char *in_buf_1 = malloc(msg_len_2);
1901 unsigned char *in_buf_2 = malloc(msg_len_1);
1902 int msg_type, ret = -1;
1903
1904 /* Perform this test with two message types. At first use a message
1905 * consisting of only 0x00 for the client and only 0xFF for the server.
1906 * At the second time use message with generated data */
1907 for (msg_type = 0; msg_type < 2; msg_type++) {
1908 int written_1 = 0;
1909 int written_2 = 0;
1910 int read_1 = 0;
1911 int read_2 = 0;
1912 int fragments_1 = 0;
1913 int fragments_2 = 0;
1914
1915 if (msg_type == 0) {
1916 memset(msg_buf_1, 0x00, msg_len_1);
1917 memset(msg_buf_2, 0xff, msg_len_2);
1918 } else {
1919 int i, j = 0;
1920 for (i = 0; i < msg_len_1; i++) {
1921 msg_buf_1[i] = j++ & 0xFF;
1922 }
1923 for (i = 0; i < msg_len_2; i++) {
1924 msg_buf_2[i] = (j -= 5) & 0xFF;
1925 }
1926 }
1927
1928 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
1929 /* ssl_1 sending */
1930 if (msg_len_1 > written_1) {
1931 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
1932 msg_len_1, &written_1,
1933 expected_fragments_1);
1934 if (expected_fragments_1 == 0) {
1935 /* This error is expected when the message is too large and
1936 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001937 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001938 msg_len_1 = 0;
1939 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001940 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001941 }
1942 }
1943
1944 /* ssl_2 sending */
1945 if (msg_len_2 > written_2) {
1946 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
1947 msg_len_2, &written_2,
1948 expected_fragments_2);
1949 if (expected_fragments_2 == 0) {
1950 /* This error is expected when the message is too large and
1951 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001952 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001953 msg_len_2 = 0;
1954 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001955 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001956 }
1957 }
1958
1959 /* ssl_1 reading */
1960 if (read_1 < msg_len_2) {
1961 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
1962 msg_len_2, &read_1,
1963 &fragments_2,
1964 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02001965 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001966 }
1967
1968 /* ssl_2 reading */
1969 if (read_2 < msg_len_1) {
1970 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
1971 msg_len_1, &read_2,
1972 &fragments_1,
1973 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02001974 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001975 }
1976 }
1977
1978 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02001979 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
1980 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
1981 TEST_EQUAL(fragments_1, expected_fragments_1);
1982 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08001983 }
1984
1985 ret = 0;
1986
1987exit:
1988 free(msg_buf_1);
1989 free(in_buf_1);
1990 free(msg_buf_2);
1991 free(in_buf_2);
1992
1993 return ret;
1994}
1995
1996/*
1997 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
1998 * must be initialized and connected beforehand.
1999 *
2000 * \retval 0 on success, otherwise error code.
2001 */
Yanray Wangead70c82023-03-16 12:04:49 +08002002#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
2003 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
2004 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
2005static int exchange_data(mbedtls_ssl_context *ssl_1,
2006 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08002007{
Yanray Wangb088bfc2023-03-16 12:15:49 +08002008 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
2009 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002010}
Yanray Wangead70c82023-03-16 12:04:49 +08002011#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
2012 (MBEDTLS_SSL_RENEGOTIATION ||
2013 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002014
2015#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2016static int check_ssl_version(
2017 mbedtls_ssl_protocol_version expected_negotiated_version,
2018 const mbedtls_ssl_context *ssl)
2019{
2020 const char *version_string = mbedtls_ssl_get_version(ssl);
2021 mbedtls_ssl_protocol_version version_number =
2022 mbedtls_ssl_get_version_number(ssl);
2023
2024 TEST_EQUAL(ssl->tls_version, expected_negotiated_version);
2025
2026 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2027 TEST_EQUAL(version_string[0], 'D');
2028 ++version_string;
2029 }
2030
2031 switch (expected_negotiated_version) {
2032 case MBEDTLS_SSL_VERSION_TLS1_2:
2033 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002034 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002035 break;
2036
2037 case MBEDTLS_SSL_VERSION_TLS1_3:
2038 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002039 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002040 break;
2041
2042 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002043 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002044 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002045 }
2046
2047 return 1;
2048
2049exit:
2050 return 0;
2051}
2052#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2053
Yanray Wange6afd912022-10-27 12:11:18 +08002054#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002055int mbedtls_test_ssl_do_handshake_with_endpoints(
2056 mbedtls_test_ssl_endpoint *server_ep,
2057 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002058 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002059 mbedtls_ssl_protocol_version proto)
2060{
2061 enum { BUFFSIZE = 1024 };
2062
2063 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002064
Max Fillingeree467aa2024-11-08 22:17:33 +01002065 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2066 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2067
Max Fillinger8f12e312024-10-30 00:29:37 +01002068 mbedtls_test_init_handshake_options(options);
2069 options->server_min_version = proto;
2070 options->client_min_version = proto;
2071 options->server_max_version = proto;
2072 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002073
Max Fillinger8f12e312024-10-30 00:29:37 +01002074 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002075 NULL, NULL, NULL);
2076 if (ret != 0) {
2077 return ret;
2078 }
Max Fillinger8f12e312024-10-30 00:29:37 +01002079 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002080 NULL, NULL, NULL);
2081 if (ret != 0) {
2082 return ret;
2083 }
2084
2085 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2086 if (ret != 0) {
2087 return ret;
2088 }
2089
Max Fillingerea1e7772024-10-30 00:49:10 +01002090 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2091 &client_ep->ssl,
2092 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002093 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2094 return ret;
2095 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002096 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2097 &server_ep->ssl,
2098 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002099 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2100 return ret;
2101 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002102 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2103 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002104 return -1;
2105 }
2106
2107 return 0;
2108}
2109#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2110
2111#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Yanray Wange6afd912022-10-27 12:11:18 +08002112void mbedtls_test_ssl_perform_handshake(
Gilles Peskine9b993682025-05-27 18:44:12 +02002113 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +08002114{
Yanray Wange6afd912022-10-27 12:11:18 +08002115 enum { BUFFSIZE = 17000 };
2116 mbedtls_test_ssl_endpoint client, server;
2117#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2118 const char *psk_identity = "foo";
2119#endif
Yanray Wange6afd912022-10-27 12:11:18 +08002120#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2121 unsigned char *context_buf = NULL;
2122 size_t context_buf_len;
2123#endif
2124#if defined(MBEDTLS_SSL_RENEGOTIATION)
2125 int ret = -1;
2126#endif
2127 int expected_handshake_result = options->expected_handshake_result;
2128
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002129 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002130 mbedtls_platform_zeroize(&client, sizeof(client));
2131 mbedtls_platform_zeroize(&server, sizeof(server));
2132 mbedtls_test_ssl_message_queue server_queue, client_queue;
Yanray Wange6afd912022-10-27 12:11:18 +08002133
Ronald Cronec3408d2024-01-16 17:50:40 +01002134#if defined(MBEDTLS_DEBUG_C)
2135 if (options->cli_log_fun || options->srv_log_fun) {
2136 mbedtls_debug_set_threshold(4);
2137 }
2138#endif
2139
Yanray Wange6afd912022-10-27 12:11:18 +08002140 /* Client side */
2141 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002142 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2143 MBEDTLS_SSL_IS_CLIENT,
Gilles Peskine29969592025-05-27 19:24:28 +02002144 options, NULL,
Gilles Peskine353eb332025-05-14 17:42:53 +02002145 &client_queue,
2146 &server_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002147 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002148 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2149 MBEDTLS_SSL_IS_CLIENT,
2150 options, NULL, NULL,
2151 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002152 }
2153
Gilles Peskine2744a432025-05-27 13:27:22 +02002154 TEST_ASSERT(set_ciphersuite(&client, options->cipher));
Yanray Wange6afd912022-10-27 12:11:18 +08002155
Yanray Wange6afd912022-10-27 12:11:18 +08002156 /* Server side */
2157 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002158 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2159 MBEDTLS_SSL_IS_SERVER,
Gilles Peskine29969592025-05-27 19:24:28 +02002160 options, NULL,
Gilles Peskine353eb332025-05-14 17:42:53 +02002161 &server_queue,
2162 &client_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002163 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002164 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2165 MBEDTLS_SSL_IS_SERVER,
2166 options, NULL, NULL,
2167 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002168 }
2169
2170 mbedtls_ssl_conf_authmode(&server.conf, options->srv_auth_mode);
2171
Yanray Wange6afd912022-10-27 12:11:18 +08002172#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine353eb332025-05-14 17:42:53 +02002173 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(server.conf),
2174 (unsigned char) options->mfl),
2175 0);
2176 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(client.conf),
2177 (unsigned char) options->mfl),
2178 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002179#else
Gilles Peskine353eb332025-05-14 17:42:53 +02002180 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
Yanray Wange6afd912022-10-27 12:11:18 +08002181#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2182
2183#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2184 if (options->psk_str != NULL && options->psk_str->len > 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002185 TEST_EQUAL(mbedtls_ssl_conf_psk(
2186 &client.conf, options->psk_str->x,
2187 options->psk_str->len,
2188 (const unsigned char *) psk_identity,
2189 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002190
Gilles Peskine353eb332025-05-14 17:42:53 +02002191 TEST_EQUAL(mbedtls_ssl_conf_psk(
2192 &server.conf, options->psk_str->x,
2193 options->psk_str->len,
2194 (const unsigned char *) psk_identity,
2195 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002196#if defined(MBEDTLS_SSL_SRV_C)
2197 mbedtls_ssl_conf_psk_cb(&server.conf, psk_dummy_callback, NULL);
2198#endif
2199 }
2200#endif
2201#if defined(MBEDTLS_SSL_RENEGOTIATION)
2202 if (options->renegotiate) {
2203 mbedtls_ssl_conf_renegotiation(&(server.conf),
2204 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2205 mbedtls_ssl_conf_renegotiation(&(client.conf),
2206 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2207
2208 mbedtls_ssl_conf_legacy_renegotiation(&(server.conf),
2209 options->legacy_renegotiation);
2210 mbedtls_ssl_conf_legacy_renegotiation(&(client.conf),
2211 options->legacy_renegotiation);
2212 }
2213#endif /* MBEDTLS_SSL_RENEGOTIATION */
2214
Gilles Peskine353eb332025-05-14 17:42:53 +02002215 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client.socket),
2216 &(server.socket),
2217 BUFFSIZE), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002218
2219#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2220 if (options->resize_buffers != 0) {
2221 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002222 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2223 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2224 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2225 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002226 }
2227#endif
2228
2229 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2230 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2231 }
2232
Gilles Peskine353eb332025-05-14 17:42:53 +02002233 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client.ssl),
2234 &(server.ssl),
2235 MBEDTLS_SSL_HANDSHAKE_OVER),
2236 expected_handshake_result);
Yanray Wange6afd912022-10-27 12:11:18 +08002237
2238 if (expected_handshake_result != 0) {
2239 /* Connection will have failed by this point, skip to cleanup */
2240 goto exit;
2241 }
2242
Gilles Peskine353eb332025-05-14 17:42:53 +02002243 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002244
2245 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2246 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server.ssl),
2247 &(client.ssl),
2248 MBEDTLS_SSL_HANDSHAKE_OVER),
2249 0);
2250
Gilles Peskine353eb332025-05-14 17:42:53 +02002251 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002252 /* Check that both sides have negotiated the expected version. */
2253 mbedtls_test_set_step(0);
2254 if (!check_ssl_version(options->expected_negotiated_version,
2255 &client.ssl)) {
2256 goto exit;
2257 }
2258
2259 mbedtls_test_set_step(1);
2260 if (!check_ssl_version(options->expected_negotiated_version,
2261 &server.ssl)) {
2262 goto exit;
2263 }
2264
2265 if (options->expected_ciphersuite != 0) {
2266 TEST_EQUAL(server.ssl.session->ciphersuite,
2267 options->expected_ciphersuite);
2268 }
2269
2270#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2271 if (options->resize_buffers != 0) {
2272 /* A server, when using DTLS, might delay a buffer resize to happen
2273 * after it receives a message, so we force it. */
Gilles Peskine353eb332025-05-14 17:42:53 +02002274 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002275
Gilles Peskine353eb332025-05-14 17:42:53 +02002276 TEST_EQUAL(client.ssl.out_buf_len,
2277 mbedtls_ssl_get_output_buflen(&client.ssl));
2278 TEST_EQUAL(client.ssl.in_buf_len,
2279 mbedtls_ssl_get_input_buflen(&client.ssl));
2280 TEST_EQUAL(server.ssl.out_buf_len,
2281 mbedtls_ssl_get_output_buflen(&server.ssl));
2282 TEST_EQUAL(server.ssl.in_buf_len,
2283 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002284 }
2285#endif
2286
2287 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2288 /* Start data exchanging test */
Gilles Peskine353eb332025-05-14 17:42:53 +02002289 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2290 &(client.ssl), options->cli_msg_len,
2291 options->expected_cli_fragments,
2292 &(server.ssl), options->srv_msg_len,
2293 options->expected_srv_fragments),
2294 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002295 }
2296#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2297 if (options->serialize == 1) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002298 TEST_EQUAL(options->dtls, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002299
Gilles Peskine353eb332025-05-14 17:42:53 +02002300 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), NULL,
2301 0, &context_buf_len),
2302 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
Yanray Wange6afd912022-10-27 12:11:18 +08002303
2304 context_buf = mbedtls_calloc(1, context_buf_len);
2305 TEST_ASSERT(context_buf != NULL);
2306
Gilles Peskine353eb332025-05-14 17:42:53 +02002307 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), context_buf,
2308 context_buf_len,
2309 &context_buf_len),
2310 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002311
2312 mbedtls_ssl_free(&(server.ssl));
2313 mbedtls_ssl_init(&(server.ssl));
2314
Gilles Peskine353eb332025-05-14 17:42:53 +02002315 TEST_EQUAL(mbedtls_ssl_setup(&(server.ssl), &(server.conf)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002316
Gilles Peskine29969592025-05-27 19:24:28 +02002317 mbedtls_ssl_set_bio(&(server.ssl), &server.dtls_context,
Yanray Wange6afd912022-10-27 12:11:18 +08002318 mbedtls_test_mock_tcp_send_msg,
2319 mbedtls_test_mock_tcp_recv_msg,
2320 NULL);
2321
2322 mbedtls_ssl_set_user_data_p(&server.ssl, &server);
2323
2324#if defined(MBEDTLS_TIMING_C)
Gilles Peskine0677e022025-05-27 18:05:20 +02002325 mbedtls_ssl_set_timer_cb(&server.ssl, &server.timer,
Yanray Wange6afd912022-10-27 12:11:18 +08002326 mbedtls_timing_set_delay,
2327 mbedtls_timing_get_delay);
2328#endif
2329#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2330 if (options->resize_buffers != 0) {
2331 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002332 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2333 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002334 }
2335#endif
Gilles Peskine353eb332025-05-14 17:42:53 +02002336 TEST_EQUAL(mbedtls_ssl_context_load(&(server.ssl), context_buf,
2337 context_buf_len), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002338
2339#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2340 /* Validate buffer sizes after context deserialization */
2341 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002342 TEST_EQUAL(server.ssl.out_buf_len,
2343 mbedtls_ssl_get_output_buflen(&server.ssl));
2344 TEST_EQUAL(server.ssl.in_buf_len,
2345 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002346 }
2347#endif
2348 /* Retest writing/reading */
2349 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002350 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2351 &(client.ssl), options->cli_msg_len,
2352 options->expected_cli_fragments,
2353 &(server.ssl), options->srv_msg_len,
2354 options->expected_srv_fragments),
2355 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002356 }
2357 }
2358#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2359
2360#if defined(MBEDTLS_SSL_RENEGOTIATION)
2361 if (options->renegotiate) {
2362 /* Start test with renegotiation */
Gilles Peskine353eb332025-05-14 17:42:53 +02002363 TEST_EQUAL(server.ssl.renego_status,
2364 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2365 TEST_EQUAL(client.ssl.renego_status,
2366 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002367
2368 /* After calling this function for the server, it only sends a handshake
2369 * request. All renegotiation should happen during data exchanging */
Gilles Peskine353eb332025-05-14 17:42:53 +02002370 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server.ssl)), 0);
2371 TEST_EQUAL(server.ssl.renego_status,
2372 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2373 TEST_EQUAL(client.ssl.renego_status,
2374 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002375
Gilles Peskine353eb332025-05-14 17:42:53 +02002376 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2377 TEST_EQUAL(server.ssl.renego_status,
2378 MBEDTLS_SSL_RENEGOTIATION_DONE);
2379 TEST_EQUAL(client.ssl.renego_status,
2380 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002381
2382 /* After calling mbedtls_ssl_renegotiate for the client,
2383 * all renegotiation should happen inside this function.
2384 * However in this test, we cannot perform simultaneous communication
2385 * between client and server so this function will return waiting error
2386 * on the socket. All rest of renegotiation should happen
2387 * during data exchanging */
2388 ret = mbedtls_ssl_renegotiate(&(client.ssl));
2389#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2390 if (options->resize_buffers != 0) {
2391 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002392 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2393 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002394 }
2395#endif
2396 TEST_ASSERT(ret == 0 ||
2397 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2398 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
Gilles Peskine353eb332025-05-14 17:42:53 +02002399 TEST_EQUAL(server.ssl.renego_status,
2400 MBEDTLS_SSL_RENEGOTIATION_DONE);
2401 TEST_EQUAL(client.ssl.renego_status,
2402 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
Yanray Wange6afd912022-10-27 12:11:18 +08002403
Gilles Peskine353eb332025-05-14 17:42:53 +02002404 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2405 TEST_EQUAL(server.ssl.renego_status,
2406 MBEDTLS_SSL_RENEGOTIATION_DONE);
2407 TEST_EQUAL(client.ssl.renego_status,
2408 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002409#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2410 /* Validate buffer sizes after renegotiation */
2411 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002412 TEST_EQUAL(client.ssl.out_buf_len,
2413 mbedtls_ssl_get_output_buflen(&client.ssl));
2414 TEST_EQUAL(client.ssl.in_buf_len,
2415 mbedtls_ssl_get_input_buflen(&client.ssl));
2416 TEST_EQUAL(server.ssl.out_buf_len,
2417 mbedtls_ssl_get_output_buflen(&server.ssl));
2418 TEST_EQUAL(server.ssl.in_buf_len,
2419 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002420 }
2421#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2422 }
2423#endif /* MBEDTLS_SSL_RENEGOTIATION */
2424
2425 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client.conf) == &client);
2426 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client.ssl) == &client);
2427 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server.conf) == &server);
2428 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server.ssl) == &server);
2429
2430exit:
Gilles Peskine29969592025-05-27 19:24:28 +02002431 mbedtls_test_ssl_endpoint_free(&client, NULL);
2432 mbedtls_test_ssl_endpoint_free(&server, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +08002433#if defined(MBEDTLS_DEBUG_C)
2434 if (options->cli_log_fun || options->srv_log_fun) {
2435 mbedtls_debug_set_threshold(0);
2436 }
2437#endif
2438#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2439 if (context_buf != NULL) {
2440 mbedtls_free(context_buf);
2441 }
2442#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002443 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002444}
2445#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2446
2447#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002448int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002449 unsigned char *buf, unsigned char **end, int tweak,
2450 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2451{
2452/*
2453 * The definition of the tweaks assume that the certificate list contains only
2454 * one certificate.
2455 */
2456
2457/*
2458 * struct {
2459 * opaque cert_data<1..2^24-1>;
2460 * Extension extensions<0..2^16-1>;
2461 * } CertificateEntry;
2462 *
2463 * struct {
2464 * opaque certificate_request_context<0..2^8-1>;
2465 * CertificateEntry certificate_list<0..2^24-1>;
2466 * } Certificate;
2467 */
2468 unsigned char *p_certificate_request_context_len = buf;
2469 size_t certificate_request_context_len = buf[0];
2470
2471 unsigned char *p_certificate_list_len =
2472 buf + 1 + certificate_request_context_len;
2473 unsigned char *certificate_list = p_certificate_list_len + 3;
2474 size_t certificate_list_len =
2475 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2476
2477 unsigned char *p_cert_data_len = certificate_list;
2478 unsigned char *cert_data = p_cert_data_len + 3;
2479 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2480
2481 unsigned char *p_extensions_len = cert_data + cert_data_len;
2482 unsigned char *extensions = p_extensions_len + 2;
2483 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2484
2485 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2486
2487 switch (tweak) {
2488 case 1:
2489 /* Failure when checking if the certificate request context length
2490 * and certificate list length can be read
2491 */
2492 *end = buf + 3;
2493 set_chk_buf_ptr_args(args, buf, *end, 4);
2494 break;
2495
2496 case 2:
2497 /* Invalid certificate request context length.
2498 */
2499 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002500 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002501 reset_chk_buf_ptr_args(args);
2502 break;
2503
2504 case 3:
2505 /* Failure when checking if certificate_list data can be read. */
2506 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2507 p_certificate_list_len, 0);
2508 set_chk_buf_ptr_args(args, certificate_list, *end,
2509 certificate_list_len + 1);
2510 break;
2511
2512 case 4:
2513 /* Failure when checking if the cert_data length can be read. */
2514 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2515 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2516 break;
2517
2518 case 5:
2519 /* Failure when checking if cert_data data can be read. */
2520 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2521 p_cert_data_len, 0);
2522 set_chk_buf_ptr_args(args, cert_data,
2523 certificate_list + certificate_list_len,
2524 certificate_list_len - 3 + 1);
2525 break;
2526
2527 case 6:
2528 /* Failure when checking if the extensions length can be read. */
2529 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2530 p_certificate_list_len, 0);
2531 set_chk_buf_ptr_args(
2532 args, p_extensions_len,
2533 certificate_list + certificate_list_len - extensions_len - 1, 2);
2534 break;
2535
2536 case 7:
2537 /* Failure when checking if extensions data can be read. */
2538 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2539
2540 set_chk_buf_ptr_args(
2541 args, extensions,
2542 certificate_list + certificate_list_len, extensions_len + 1);
2543 break;
2544
2545 default:
2546 return -1;
2547 }
2548
2549 return 0;
2550}
2551#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002552
Ronald Cronfaf026c2024-01-31 14:32:06 +01002553/*
2554 * Functions for tests based on tickets. Implementations of the
2555 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2556 * Basically same implementations as in ticket.c without the encryption. That
2557 * way we can tweak easily tickets characteristics to simulate misbehaving
2558 * peers.
2559 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002560#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2561int mbedtls_test_ticket_write(
2562 void *p_ticket, const mbedtls_ssl_session *session,
2563 unsigned char *start, const unsigned char *end,
2564 size_t *tlen, uint32_t *lifetime)
2565{
2566 int ret;
2567 ((void) p_ticket);
2568
2569 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2570 tlen)) != 0) {
2571 return ret;
2572 }
2573
2574 /* Maximum ticket lifetime as defined in RFC 8446 */
2575 *lifetime = 7 * 24 * 3600;
2576
2577 return 0;
2578}
2579
2580int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2581 unsigned char *buf, size_t len)
2582{
2583 ((void) p_ticket);
2584
2585 return mbedtls_ssl_session_load(session, buf, len);
2586}
2587#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002588
2589#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2590 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2591 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2592int mbedtls_test_get_tls13_ticket(
2593 mbedtls_test_handshake_test_options *client_options,
2594 mbedtls_test_handshake_test_options *server_options,
2595 mbedtls_ssl_session *session)
2596{
2597 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002598 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002599 unsigned char buf[64];
2600 mbedtls_test_ssl_endpoint client_ep, server_ep;
2601
2602 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2603 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2604
2605 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
2606 client_options, NULL, NULL, NULL);
2607 TEST_EQUAL(ret, 0);
2608
2609 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
2610 server_options, NULL, NULL, NULL);
2611 TEST_EQUAL(ret, 0);
2612
2613 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2614 mbedtls_test_ticket_write,
2615 mbedtls_test_ticket_parse,
2616 NULL);
2617
2618 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2619 &(server_ep.socket), 1024);
2620 TEST_EQUAL(ret, 0);
2621
2622 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2623 &(server_ep.ssl), &(client_ep.ssl),
2624 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2625
2626 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2627
2628 do {
2629 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2630 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2631
2632 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2633 TEST_EQUAL(ret, 0);
2634
Gilles Peskine946bf142025-04-08 09:48:40 +02002635 ok = 1;
2636
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002637exit:
2638 mbedtls_test_ssl_endpoint_free(&client_ep, NULL);
2639 mbedtls_test_ssl_endpoint_free(&server_ep, NULL);
2640
Gilles Peskine946bf142025-04-08 09:48:40 +02002641 if (ret == 0 && !ok) {
2642 /* Exiting due to a test assertion that isn't ret == 0 */
2643 ret = -1;
2644 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002645 return ret;
2646}
2647#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2648 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2649 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2650
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002651#endif /* MBEDTLS_SSL_TLS_C */