blob: a122f356cbb8ec77e6169ceddd54d30be001d3a4 [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;
Gilles Peskinefb2ce052025-05-28 17:36:12 +020074 opts->srv_auth_mode = MBEDTLS_SSL_VERIFY_REQUIRED;
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
Gilles Peskine27586d82025-05-28 17:01:42 +0200575
576#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
577 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
578 defined(MBEDTLS_SSL_SRV_C)
579static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
580 const unsigned char *name, size_t name_len)
581{
582 (void) p_info;
583 (void) ssl;
584 (void) name;
585 (void) name_len;
586
587 return 0;
588}
589#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
590 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
591 MBEDTLS_SSL_SRV_C */
592
Yanray Wange6afd912022-10-27 12:11:18 +0800593#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
594
Gilles Peskine27586d82025-05-28 17:01:42 +0200595static int set_ciphersuite(mbedtls_test_ssl_endpoint *ep,
596 const char *cipher)
597{
598 if (cipher == NULL || cipher[0] == 0) {
599 return 1;
600 }
601
602 int ok = 0;
603
604 TEST_CALLOC(ep->ciphersuites, 2);
605 ep->ciphersuites[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
606 ep->ciphersuites[1] = 0;
607
608 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
609 mbedtls_ssl_ciphersuite_from_id(ep->ciphersuites[0]);
610
611 TEST_ASSERT(ciphersuite_info != NULL);
612 TEST_ASSERT(ciphersuite_info->min_tls_version <= ep->conf.max_tls_version);
613 TEST_ASSERT(ciphersuite_info->max_tls_version >= ep->conf.min_tls_version);
614
615 if (ep->conf.max_tls_version > ciphersuite_info->max_tls_version) {
616 ep->conf.max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
617 }
618 if (ep->conf.min_tls_version < ciphersuite_info->min_tls_version) {
619 ep->conf.min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
620 }
621
622 mbedtls_ssl_conf_ciphersuites(&ep->conf, ep->ciphersuites);
623 ok = 1;
624
625exit:
626 return ok;
627}
628
Yanray Wange6afd912022-10-27 12:11:18 +0800629/*
630 * Deinitializes certificates from endpoint represented by \p ep.
631 */
Yanray Wangf6f71902023-03-15 16:05:14 +0800632static void test_ssl_endpoint_certificate_free(mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +0800633{
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200634 if (ep->ca_chain != NULL) {
635 mbedtls_x509_crt_free(ep->ca_chain);
636 mbedtls_free(ep->ca_chain);
637 ep->ca_chain = NULL;
638 }
639 if (ep->cert != NULL) {
640 mbedtls_x509_crt_free(ep->cert);
641 mbedtls_free(ep->cert);
642 ep->cert = NULL;
643 }
644 if (ep->pkey != NULL) {
Yanray Wange6afd912022-10-27 12:11:18 +0800645#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200646 if (mbedtls_pk_get_type(ep->pkey) == MBEDTLS_PK_OPAQUE) {
647 psa_destroy_key(ep->pkey->priv_id);
Yanray Wange6afd912022-10-27 12:11:18 +0800648 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200649#endif
650 mbedtls_pk_free(ep->pkey);
651 mbedtls_free(ep->pkey);
652 ep->pkey = NULL;
Yanray Wange6afd912022-10-27 12:11:18 +0800653 }
654}
655
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200656static int load_endpoint_rsa(mbedtls_test_ssl_endpoint *ep)
657{
658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
659 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
660 ret = mbedtls_x509_crt_parse(
661 ep->cert,
662 (const unsigned char *) mbedtls_test_srv_crt_rsa_sha256_der,
663 mbedtls_test_srv_crt_rsa_sha256_der_len);
664 TEST_EQUAL(ret, 0);
665 ret = mbedtls_pk_parse_key(
666 ep->pkey,
667 (const unsigned char *) mbedtls_test_srv_key_rsa_der,
668 mbedtls_test_srv_key_rsa_der_len, NULL, 0);
669 TEST_EQUAL(ret, 0);
670 } else {
671 ret = mbedtls_x509_crt_parse(
672 ep->cert,
673 (const unsigned char *) mbedtls_test_cli_crt_rsa_der,
674 mbedtls_test_cli_crt_rsa_der_len);
675 TEST_EQUAL(ret, 0);
676 ret = mbedtls_pk_parse_key(
677 ep->pkey,
678 (const unsigned char *) mbedtls_test_cli_key_rsa_der,
679 mbedtls_test_cli_key_rsa_der_len, NULL, 0);
680 TEST_EQUAL(ret, 0);
681 }
682
683exit:
684 return ret;
685}
686
687static int load_endpoint_ecc(mbedtls_test_ssl_endpoint *ep)
688{
689 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
690 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
691 ret = mbedtls_x509_crt_parse(
692 ep->cert,
693 (const unsigned char *) mbedtls_test_srv_crt_ec_der,
694 mbedtls_test_srv_crt_ec_der_len);
695 TEST_EQUAL(ret, 0);
696 ret = mbedtls_pk_parse_key(
697 ep->pkey,
698 (const unsigned char *) mbedtls_test_srv_key_ec_der,
699 mbedtls_test_srv_key_ec_der_len, NULL, 0);
700 TEST_EQUAL(ret, 0);
701 } else {
702 ret = mbedtls_x509_crt_parse(
703 ep->cert,
704 (const unsigned char *) mbedtls_test_cli_crt_ec_der,
705 mbedtls_test_cli_crt_ec_len);
706 TEST_EQUAL(ret, 0);
707 ret = mbedtls_pk_parse_key(
708 ep->pkey,
709 (const unsigned char *) mbedtls_test_cli_key_ec_der,
710 mbedtls_test_cli_key_ec_der_len, NULL, 0);
711 TEST_EQUAL(ret, 0);
712 }
713
714exit:
715 return ret;
716}
717
Yanray Wange6afd912022-10-27 12:11:18 +0800718int mbedtls_test_ssl_endpoint_certificate_init(mbedtls_test_ssl_endpoint *ep,
719 int pk_alg,
720 int opaque_alg, int opaque_alg2,
721 int opaque_usage)
722{
723 int i = 0;
724 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +0200725 int ok = 0;
Yanray Wange6afd912022-10-27 12:11:18 +0800726#if defined(MBEDTLS_USE_PSA_CRYPTO)
727 mbedtls_svc_key_id_t key_slot = MBEDTLS_SVC_KEY_ID_INIT;
728#endif
729
730 if (ep == NULL) {
731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
732 }
733
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200734 TEST_CALLOC(ep->ca_chain, 1);
735 TEST_CALLOC(ep->cert, 1);
736 TEST_CALLOC(ep->pkey, 1);
Yanray Wange6afd912022-10-27 12:11:18 +0800737
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200738 mbedtls_x509_crt_init(ep->ca_chain);
739 mbedtls_x509_crt_init(ep->cert);
740 mbedtls_pk_init(ep->pkey);
Yanray Wange6afd912022-10-27 12:11:18 +0800741
742 /* Load the trusted CA */
743
744 for (i = 0; mbedtls_test_cas_der[i] != NULL; i++) {
745 ret = mbedtls_x509_crt_parse_der(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200746 ep->ca_chain,
Yanray Wange6afd912022-10-27 12:11:18 +0800747 (const unsigned char *) mbedtls_test_cas_der[i],
748 mbedtls_test_cas_der_len[i]);
Gilles Peskine353eb332025-05-14 17:42:53 +0200749 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800750 }
751
752 /* Load own certificate and private key */
753
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200754 if (pk_alg == MBEDTLS_PK_RSA) {
755 TEST_EQUAL(load_endpoint_rsa(ep), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800756 } else {
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200757 TEST_EQUAL(load_endpoint_ecc(ep), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800758 }
759
760#if defined(MBEDTLS_USE_PSA_CRYPTO)
761 if (opaque_alg != 0) {
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100762 psa_key_attributes_t key_attr = PSA_KEY_ATTRIBUTES_INIT;
763 /* Use a fake key usage to get a successful initial guess for the PSA attributes. */
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200764 TEST_EQUAL(mbedtls_pk_get_psa_attributes(ep->pkey, PSA_KEY_USAGE_SIGN_HASH,
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100765 &key_attr), 0);
Valerio Settia9de9442024-02-27 13:56:09 +0100766 /* Then manually usage, alg and alg2 as requested by the test. */
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100767 psa_set_key_usage_flags(&key_attr, opaque_usage);
768 psa_set_key_algorithm(&key_attr, opaque_alg);
769 if (opaque_alg2 != PSA_ALG_NONE) {
770 psa_set_key_enrollment_algorithm(&key_attr, opaque_alg2);
771 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200772 TEST_EQUAL(mbedtls_pk_import_into_psa(ep->pkey, &key_attr, &key_slot), 0);
773 mbedtls_pk_free(ep->pkey);
774 mbedtls_pk_init(ep->pkey);
775 TEST_EQUAL(mbedtls_pk_setup_opaque(ep->pkey, key_slot), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800776 }
777#else
778 (void) opaque_alg;
779 (void) opaque_alg2;
780 (void) opaque_usage;
781#endif
782
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200783 mbedtls_ssl_conf_ca_chain(&(ep->conf), ep->ca_chain, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +0800784
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200785 ret = mbedtls_ssl_conf_own_cert(&(ep->conf), ep->cert,
786 ep->pkey);
Gilles Peskine353eb332025-05-14 17:42:53 +0200787 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800788
Gilles Peskine946bf142025-04-08 09:48:40 +0200789 ok = 1;
790
Yanray Wange6afd912022-10-27 12:11:18 +0800791exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200792 if (ret == 0 && !ok) {
793 /* Exiting due to a test assertion that isn't ret == 0 */
794 ret = -1;
795 }
Yanray Wange6afd912022-10-27 12:11:18 +0800796 if (ret != 0) {
Yanray Wangf6f71902023-03-15 16:05:14 +0800797 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800798 }
799
800 return ret;
801}
802
Yanray Wange6afd912022-10-27 12:11:18 +0800803int mbedtls_test_ssl_endpoint_init(
804 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +0200805 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +0800806{
807 int ret = -1;
808 uintptr_t user_data_n;
Gilles Peskine27586d82025-05-28 17:01:42 +0200809#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
810 const char *psk_identity = "foo";
811#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800812
Yanray Wange6afd912022-10-27 12:11:18 +0800813 if (ep == NULL) {
814 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
815 }
816
817 memset(ep, 0, sizeof(*ep));
818
819 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
820
821 mbedtls_ssl_init(&(ep->ssl));
822 mbedtls_ssl_config_init(&(ep->conf));
Gilles Peskine29969592025-05-27 19:24:28 +0200823 mbedtls_test_message_socket_init(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800824
825 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
826 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
827 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
828 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
829
830 (void) mbedtls_test_rnd_std_rand(NULL,
831 (void *) &user_data_n,
832 sizeof(user_data_n));
833 mbedtls_ssl_conf_set_user_data_n(&ep->conf, user_data_n);
834 mbedtls_ssl_set_user_data_n(&ep->ssl, user_data_n);
835
Gilles Peskine6c154e72025-05-27 20:23:52 +0200836 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800837
Yanray Wange6afd912022-10-27 12:11:18 +0800838 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
Gilles Peskine29969592025-05-27 19:24:28 +0200839 options->dtls ?
Yanray Wange6afd912022-10-27 12:11:18 +0800840 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
841 MBEDTLS_SSL_TRANSPORT_STREAM,
842 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200843 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800844
Ronald Crona697a712023-03-09 17:47:42 +0100845 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
846 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
847 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
848 options->client_min_version);
849 }
850
851 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
852 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
853 options->client_max_version);
854 }
855 } else {
856 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
857 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
858 options->server_min_version);
859 }
860
861 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
862 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
863 options->server_max_version);
864 }
865 }
866
Gilles Peskine27586d82025-05-28 17:01:42 +0200867 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
868 TEST_ASSERT(set_ciphersuite(ep, options->cipher));
869 }
870
Ronald Cronfb536472024-01-26 14:55:25 +0100871 if (options->group_list != NULL) {
872 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800873 }
874
Gilles Peskinefb2ce052025-05-28 17:36:12 +0200875 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
876 mbedtls_ssl_conf_authmode(&(ep->conf), options->srv_auth_mode);
877 } else {
878 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
879 }
Yanray Wange6afd912022-10-27 12:11:18 +0800880
Ronald Cronced99be2024-01-26 15:49:12 +0100881#if defined(MBEDTLS_SSL_EARLY_DATA)
882 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100883#if defined(MBEDTLS_SSL_SRV_C)
884 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
885 (options->max_early_data_size >= 0)) {
886 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
887 options->max_early_data_size);
888 }
889#endif
Gilles Peskine27586d82025-05-28 17:01:42 +0200890
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000891#if defined(MBEDTLS_SSL_ALPN)
892 /* check that alpn_list contains at least one valid entry */
893 if (options->alpn_list[0] != NULL) {
894 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
895 }
896#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100897#endif
898
Gilles Peskine27586d82025-05-28 17:01:42 +0200899#if defined(MBEDTLS_SSL_RENEGOTIATION)
900 if (options->renegotiate) {
901 mbedtls_ssl_conf_renegotiation(&ep->conf,
902 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
903 mbedtls_ssl_conf_legacy_renegotiation(&ep->conf,
904 options->legacy_renegotiation);
905 }
906#endif /* MBEDTLS_SSL_RENEGOTIATION */
907
Yanray Wange6afd912022-10-27 12:11:18 +0800908#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
909 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
910 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
911 mbedtls_ssl_cache_get,
912 mbedtls_ssl_cache_set);
913 }
914#endif
915
Gilles Peskine27586d82025-05-28 17:01:42 +0200916#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
917 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&ep->conf,
918 (unsigned char) options->mfl),
919 0);
920#else
921 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
922#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
923
Yanray Wange6afd912022-10-27 12:11:18 +0800924#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine29969592025-05-27 19:24:28 +0200925 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->dtls) {
Yanray Wange6afd912022-10-27 12:11:18 +0800926 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
927 }
928#endif
929
Ronald Cronec3408d2024-01-16 17:50:40 +0100930#if defined(MBEDTLS_DEBUG_C)
931#if defined(MBEDTLS_SSL_SRV_C)
932 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
933 options->srv_log_fun != NULL) {
934 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
935 options->srv_log_obj);
936 }
937#endif
938#if defined(MBEDTLS_SSL_CLI_C)
939 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
940 options->cli_log_fun != NULL) {
941 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
942 options->cli_log_obj);
943 }
944#endif
945#endif /* MBEDTLS_DEBUG_C */
946
Yanray Wange6afd912022-10-27 12:11:18 +0800947 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
948 options->opaque_alg,
949 options->opaque_alg2,
950 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200951 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800952
Gilles Peskine27586d82025-05-28 17:01:42 +0200953#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
954 if (options->psk_str != NULL && options->psk_str->len > 0) {
955 TEST_EQUAL(mbedtls_ssl_conf_psk(
956 &ep->conf, options->psk_str->x,
957 options->psk_str->len,
958 (const unsigned char *) psk_identity,
959 strlen(psk_identity)), 0);
960#if defined(MBEDTLS_SSL_SRV_C)
961 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
962 mbedtls_ssl_conf_psk_cb(&ep->conf, psk_dummy_callback, NULL);
963 }
964#endif
965 }
966#endif
967
Yanray Wange6afd912022-10-27 12:11:18 +0800968 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), user_data_n);
969 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
Gilles Peskinea6e71f92025-06-01 21:32:05 +0200970
971 /* We've finished the configuration. Now set up a context. */
972
973 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
974 TEST_EQUAL(ret, 0);
975
976 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
977 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
978 TEST_EQUAL(ret, 0);
979 }
980
981 /* Non-blocking callbacks without timeout */
982 if (options->dtls) {
983 mbedtls_ssl_set_bio(&(ep->ssl), &ep->dtls_context,
984 mbedtls_test_mock_tcp_send_msg,
985 mbedtls_test_mock_tcp_recv_msg,
986 NULL);
987#if defined(MBEDTLS_TIMING_C)
988 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
989 mbedtls_timing_set_delay,
990 mbedtls_timing_get_delay);
991#endif
992 } else {
993 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
994 mbedtls_test_mock_tcp_send_nb,
995 mbedtls_test_mock_tcp_recv_nb,
996 NULL);
997 }
998
Yanray Wange6afd912022-10-27 12:11:18 +0800999 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), user_data_n);
1000 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
1001
Gilles Peskine946bf142025-04-08 09:48:40 +02001002 return 0;
1003
Yanray Wange6afd912022-10-27 12:11:18 +08001004exit:
Gilles Peskine946bf142025-04-08 09:48:40 +02001005 if (ret == 0) {
1006 /* Exiting due to a test assertion that isn't ret == 0 */
1007 ret = -1;
1008 }
Yanray Wange6afd912022-10-27 12:11:18 +08001009 return ret;
1010}
1011
Yanray Wange6afd912022-10-27 12:11:18 +08001012void mbedtls_test_ssl_endpoint_free(
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02001013 mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +08001014{
Yanray Wange6afd912022-10-27 12:11:18 +08001015 mbedtls_ssl_free(&(ep->ssl));
1016 mbedtls_ssl_config_free(&(ep->conf));
1017
Gilles Peskine2744a432025-05-27 13:27:22 +02001018 mbedtls_free(ep->ciphersuites);
1019 ep->ciphersuites = NULL;
1020 test_ssl_endpoint_certificate_free(ep);
1021
Gilles Peskine29969592025-05-27 19:24:28 +02001022 if (ep->dtls_context.socket != NULL) {
1023 mbedtls_test_message_socket_close(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +08001024 } else {
1025 mbedtls_test_mock_socket_close(&(ep->socket));
1026 }
1027}
1028
Gilles Peskineb092e782025-05-27 20:15:03 +02001029int mbedtls_test_ssl_dtls_join_endpoints(mbedtls_test_ssl_endpoint *client,
1030 mbedtls_test_ssl_endpoint *server)
1031{
1032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1033
Gilles Peskine6c154e72025-05-27 20:23:52 +02001034 ret = mbedtls_test_message_socket_setup(&client->queue_input,
1035 &server->queue_input,
1036 100, &(client->socket),
1037 &client->dtls_context);
1038 TEST_EQUAL(ret, 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02001039
Gilles Peskine6c154e72025-05-27 20:23:52 +02001040 ret = mbedtls_test_message_socket_setup(&server->queue_input,
1041 &client->queue_input,
1042 100, &(server->socket),
1043 &server->dtls_context);
1044 TEST_EQUAL(ret, 0);
1045
1046exit:
Gilles Peskineb092e782025-05-27 20:15:03 +02001047 return ret;
1048}
1049
Yanray Wange6afd912022-10-27 12:11:18 +08001050int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
1051 mbedtls_ssl_context *second_ssl,
1052 int state)
1053{
1054 enum { BUFFSIZE = 1024 };
1055 int max_steps = 1000;
1056 int ret = 0;
1057
1058 if (ssl == NULL || second_ssl == NULL) {
1059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1060 }
1061
1062 /* Perform communication via connected sockets */
1063 while ((ssl->state != state) && (--max_steps >= 0)) {
1064 /* If /p second_ssl ends the handshake procedure before /p ssl then
1065 * there is no need to call the next step */
1066 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
1067 ret = mbedtls_ssl_handshake_step(second_ssl);
1068 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1069 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1070 return ret;
1071 }
1072 }
1073
1074 /* We only care about the \p ssl state and returns, so we call it last,
1075 * to leave the iteration as soon as the state is as expected. */
1076 ret = mbedtls_ssl_handshake_step(ssl);
1077 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1078 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1079 return ret;
1080 }
1081 }
1082
1083 return (max_steps >= 0) ? ret : -1;
1084}
1085
1086#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
1087
1088/*
1089 * Write application data. Increase write counter if necessary.
1090 */
Michael Schuster54300d42024-06-04 02:30:22 +02001091static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001092 unsigned char *buf, int buf_len,
1093 int *written,
1094 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001095{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001096 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001097 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1098 * a valid no-op for TLS connections. */
1099 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001100 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001101 }
1102
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001103 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +08001104 if (ret > 0) {
1105 *written += ret;
1106 }
1107
1108 if (expected_fragments == 0) {
1109 /* Used for DTLS and the message size larger than MFL. In that case
1110 * the message can not be fragmented and the library should return
1111 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +08001112 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +08001113 return ret;
1114 } else if (expected_fragments == 1) {
1115 /* Used for TLS/DTLS and the message size lower than MFL */
1116 TEST_ASSERT(ret == buf_len ||
1117 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1118 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1119 } else {
1120 /* Used for TLS and the message size larger than MFL */
1121 TEST_ASSERT(expected_fragments > 1);
1122 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1123 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1124 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1125 }
1126
1127 return 0;
1128
1129exit:
1130 /* Some of the tests failed */
1131 return -1;
1132}
1133
1134/*
1135 * Read application data and increase read counter and fragments counter
1136 * if necessary.
1137 */
Michael Schuster54300d42024-06-04 02:30:22 +02001138static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001139 unsigned char *buf, int buf_len,
1140 int *read, int *fragments,
1141 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001142{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001143 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001144 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1145 * a valid no-op for TLS connections. */
1146 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001147 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001148 }
1149
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001150 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001151 if (ret > 0) {
1152 (*fragments)++;
1153 *read += ret;
1154 }
1155
1156 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001157 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001158 } else if (expected_fragments == 1) {
1159 TEST_ASSERT(ret == buf_len ||
1160 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1161 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1162 } else {
1163 TEST_ASSERT(expected_fragments > 1);
1164 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1165 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1166 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1167 }
1168
1169 return 0;
1170
1171exit:
1172 /* Some of the tests failed */
1173 return -1;
1174}
1175
Yanray Wange6afd912022-10-27 12:11:18 +08001176#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001177 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001178int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1179 const unsigned char *iv,
1180 size_t iv_len,
1181 const unsigned char *input,
1182 size_t ilen,
1183 unsigned char *output,
1184 size_t *olen)
1185{
1186#if defined(MBEDTLS_USE_PSA_CRYPTO)
1187 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1188 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1189 size_t part_len;
1190
1191 status = psa_cipher_encrypt_setup(&cipher_op,
1192 transform->psa_key_enc,
1193 transform->psa_alg);
1194
1195 if (status != PSA_SUCCESS) {
1196 return PSA_TO_MBEDTLS_ERR(status);
1197 }
1198
1199 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1200
1201 if (status != PSA_SUCCESS) {
1202 return PSA_TO_MBEDTLS_ERR(status);
1203 }
1204
1205 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1206
1207 if (status != PSA_SUCCESS) {
1208 return PSA_TO_MBEDTLS_ERR(status);
1209 }
1210
1211 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1212 &part_len);
1213
1214 if (status != PSA_SUCCESS) {
1215 return PSA_TO_MBEDTLS_ERR(status);
1216 }
1217
1218 *olen += part_len;
1219 return 0;
1220#else
1221 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1222 iv, iv_len, input, ilen, output, olen);
1223#endif /* MBEDTLS_USE_PSA_CRYPTO */
1224}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001225#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001226 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001227
Valerio Setti31ad3a12023-10-27 11:55:02 +02001228static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1229 mbedtls_cipher_mode_t *cipher_mode,
1230 size_t *key_bits, size_t *iv_len)
1231{
1232 switch (cipher_type) {
1233 case MBEDTLS_CIPHER_AES_128_CBC:
1234 *cipher_mode = MBEDTLS_MODE_CBC;
1235 *key_bits = 128;
1236 *iv_len = 16;
1237 break;
1238 case MBEDTLS_CIPHER_AES_256_CBC:
1239 *cipher_mode = MBEDTLS_MODE_CBC;
1240 *key_bits = 256;
1241 *iv_len = 16;
1242 break;
1243 case MBEDTLS_CIPHER_ARIA_128_CBC:
1244 *cipher_mode = MBEDTLS_MODE_CBC;
1245 *key_bits = 128;
1246 *iv_len = 16;
1247 break;
1248 case MBEDTLS_CIPHER_ARIA_256_CBC:
1249 *cipher_mode = MBEDTLS_MODE_CBC;
1250 *key_bits = 256;
1251 *iv_len = 16;
1252 break;
1253 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1254 *cipher_mode = MBEDTLS_MODE_CBC;
1255 *key_bits = 128;
1256 *iv_len = 16;
1257 break;
1258 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1259 *cipher_mode = MBEDTLS_MODE_CBC;
1260 *key_bits = 256;
1261 *iv_len = 16;
1262 break;
1263
1264 case MBEDTLS_CIPHER_AES_128_CCM:
1265 *cipher_mode = MBEDTLS_MODE_CCM;
1266 *key_bits = 128;
1267 *iv_len = 12;
1268 break;
1269 case MBEDTLS_CIPHER_AES_192_CCM:
1270 *cipher_mode = MBEDTLS_MODE_CCM;
1271 *key_bits = 192;
1272 *iv_len = 12;
1273 break;
1274 case MBEDTLS_CIPHER_AES_256_CCM:
1275 *cipher_mode = MBEDTLS_MODE_CCM;
1276 *key_bits = 256;
1277 *iv_len = 12;
1278 break;
1279 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1280 *cipher_mode = MBEDTLS_MODE_CCM;
1281 *key_bits = 128;
1282 *iv_len = 12;
1283 break;
1284 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1285 *cipher_mode = MBEDTLS_MODE_CCM;
1286 *key_bits = 192;
1287 *iv_len = 12;
1288 break;
1289 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1290 *cipher_mode = MBEDTLS_MODE_CCM;
1291 *key_bits = 256;
1292 *iv_len = 12;
1293 break;
1294
1295 case MBEDTLS_CIPHER_AES_128_GCM:
1296 *cipher_mode = MBEDTLS_MODE_GCM;
1297 *key_bits = 128;
1298 *iv_len = 12;
1299 break;
1300 case MBEDTLS_CIPHER_AES_192_GCM:
1301 *cipher_mode = MBEDTLS_MODE_GCM;
1302 *key_bits = 192;
1303 *iv_len = 12;
1304 break;
1305 case MBEDTLS_CIPHER_AES_256_GCM:
1306 *cipher_mode = MBEDTLS_MODE_GCM;
1307 *key_bits = 256;
1308 *iv_len = 12;
1309 break;
1310 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1311 *cipher_mode = MBEDTLS_MODE_GCM;
1312 *key_bits = 128;
1313 *iv_len = 12;
1314 break;
1315 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1316 *cipher_mode = MBEDTLS_MODE_GCM;
1317 *key_bits = 192;
1318 *iv_len = 12;
1319 break;
1320 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1321 *cipher_mode = MBEDTLS_MODE_GCM;
1322 *key_bits = 256;
1323 *iv_len = 12;
1324 break;
1325
1326 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1327 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1328 *key_bits = 256;
1329 *iv_len = 12;
1330 break;
1331
1332 case MBEDTLS_CIPHER_NULL:
1333 *cipher_mode = MBEDTLS_MODE_STREAM;
1334 *key_bits = 0;
1335 *iv_len = 0;
1336 break;
1337
1338 default:
1339 *cipher_mode = MBEDTLS_MODE_NONE;
1340 *key_bits = 0;
1341 *iv_len = 0;
1342 }
1343}
1344
Yanray Wange6afd912022-10-27 12:11:18 +08001345int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1346 mbedtls_ssl_transform *t_out,
1347 int cipher_type, int hash_id,
1348 int etm, int tag_mode,
1349 mbedtls_ssl_protocol_version tls_version,
1350 size_t cid0_len,
1351 size_t cid1_len)
1352{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001353 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1354 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001355 int ret = 0;
1356
1357#if defined(MBEDTLS_USE_PSA_CRYPTO)
1358 psa_key_type_t key_type;
1359 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1360 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001362#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001363 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001364#endif
1365
Valerio Setti31ad3a12023-10-27 11:55:02 +02001366 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001367 unsigned char *key0 = NULL, *key1 = NULL;
1368 unsigned char *md0 = NULL, *md1 = NULL;
1369 unsigned char iv_enc[16], iv_dec[16];
1370
1371#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1372 unsigned char cid0[SSL_CID_LEN_MIN];
1373 unsigned char cid1[SSL_CID_LEN_MIN];
1374
1375 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1376 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1377#else
1378 ((void) cid0_len);
1379 ((void) cid1_len);
1380#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1381
1382 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001383 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1384 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001385
1386 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001387 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001388 /* Allocate `keylen + 1` bytes to ensure that we get
1389 * a non-NULL pointers from `mbedtls_calloc` even if
1390 * `keylen == 0` in the case of the NULL cipher. */
1391 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1392 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1393 memset(key0, 0x1, keylen);
1394 memset(key1, 0x2, keylen);
1395
1396#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001397 /* Pick cipher */
1398 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1399 CHK(cipher_info != NULL);
1400 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1401 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001402
Yanray Wange6afd912022-10-27 12:11:18 +08001403 /* Setup cipher contexts */
1404 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1405 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1406 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1407 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1408
1409#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001410 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001411 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1412 MBEDTLS_PADDING_NONE) == 0);
1413 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1414 MBEDTLS_PADDING_NONE) == 0);
1415 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1416 MBEDTLS_PADDING_NONE) == 0);
1417 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1418 MBEDTLS_PADDING_NONE) == 0);
1419 }
1420#endif /* MBEDTLS_CIPHER_MODE_CBC */
1421
1422 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001423 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1424 MBEDTLS_ENCRYPT)
1425 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001426 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001427 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1428 MBEDTLS_DECRYPT)
1429 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001430 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001431 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1432 MBEDTLS_ENCRYPT)
1433 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001434 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001435 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1436 MBEDTLS_DECRYPT)
1437 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001438#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001439
1440 /* Setup MAC contexts */
1441#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001442 if (cipher_mode == MBEDTLS_MODE_CBC ||
1443 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001444#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001445 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 +08001446 CHK(md_info != NULL);
1447#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001448 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001449 CHK(maclen != 0);
1450 /* Pick hash keys */
1451 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1452 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1453 memset(md0, 0x5, maclen);
1454 memset(md1, 0x6, maclen);
1455
1456#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001457 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001458
1459 CHK(alg != 0);
1460
1461 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1462 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1463 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1464 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1465 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1466 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1467
1468 psa_reset_key_attributes(&attributes);
1469 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1470 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1471 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1472
1473 CHK(psa_import_key(&attributes,
1474 md0, maclen,
1475 &t_in->psa_mac_enc) == PSA_SUCCESS);
1476
1477 CHK(psa_import_key(&attributes,
1478 md1, maclen,
1479 &t_out->psa_mac_enc) == PSA_SUCCESS);
1480
Valerio Setti31ad3a12023-10-27 11:55:02 +02001481 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001482 etm == MBEDTLS_SSL_ETM_DISABLED) {
1483 /* mbedtls_ct_hmac() requires the key to be exportable */
1484 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1485 PSA_KEY_USAGE_VERIFY_HASH);
1486 } else {
1487 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1488 }
1489
1490 CHK(psa_import_key(&attributes,
1491 md1, maclen,
1492 &t_in->psa_mac_dec) == PSA_SUCCESS);
1493
1494 CHK(psa_import_key(&attributes,
1495 md0, maclen,
1496 &t_out->psa_mac_dec) == PSA_SUCCESS);
1497#else
1498 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1499 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1500 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1501 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1502
1503 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1504 md0, maclen) == 0);
1505 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1506 md1, maclen) == 0);
1507 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1508 md1, maclen) == 0);
1509 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1510 md0, maclen) == 0);
1511#endif
1512 }
1513#else
1514 ((void) hash_id);
1515#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1516
1517
1518 /* Pick IV's (regardless of whether they
1519 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001520 memset(iv_enc, 0x3, sizeof(iv_enc));
1521 memset(iv_dec, 0x4, sizeof(iv_dec));
1522
1523 /*
1524 * Setup transforms
1525 */
1526
1527#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1528 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1529 t_out->encrypt_then_mac = etm;
1530 t_in->encrypt_then_mac = etm;
1531#else
1532 ((void) etm);
1533#endif
1534
1535 t_out->tls_version = tls_version;
1536 t_in->tls_version = tls_version;
1537 t_out->ivlen = ivlen;
1538 t_in->ivlen = ivlen;
1539
Valerio Setti31ad3a12023-10-27 11:55:02 +02001540 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001541 case MBEDTLS_MODE_GCM:
1542 case MBEDTLS_MODE_CCM:
1543#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1544 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1545 t_out->fixed_ivlen = 12;
1546 t_in->fixed_ivlen = 12;
1547 } else
1548#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1549 {
1550 t_out->fixed_ivlen = 4;
1551 t_in->fixed_ivlen = 4;
1552 }
1553 t_out->maclen = 0;
1554 t_in->maclen = 0;
1555 switch (tag_mode) {
1556 case 0: /* Full tag */
1557 t_out->taglen = 16;
1558 t_in->taglen = 16;
1559 break;
1560 case 1: /* Partial tag */
1561 t_out->taglen = 8;
1562 t_in->taglen = 8;
1563 break;
1564 default:
1565 ret = 1;
1566 goto cleanup;
1567 }
1568 break;
1569
1570 case MBEDTLS_MODE_CHACHAPOLY:
1571 t_out->fixed_ivlen = 12;
1572 t_in->fixed_ivlen = 12;
1573 t_out->maclen = 0;
1574 t_in->maclen = 0;
1575 switch (tag_mode) {
1576 case 0: /* Full tag */
1577 t_out->taglen = 16;
1578 t_in->taglen = 16;
1579 break;
1580 case 1: /* Partial tag */
1581 t_out->taglen = 8;
1582 t_in->taglen = 8;
1583 break;
1584 default:
1585 ret = 1;
1586 goto cleanup;
1587 }
1588 break;
1589
1590 case MBEDTLS_MODE_STREAM:
1591 case MBEDTLS_MODE_CBC:
1592 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1593 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1594 t_out->taglen = 0;
1595 t_in->taglen = 0;
1596 switch (tag_mode) {
1597 case 0: /* Full tag */
1598 t_out->maclen = maclen;
1599 t_in->maclen = maclen;
1600 break;
1601 default:
1602 ret = 1;
1603 goto cleanup;
1604 }
1605 break;
1606 default:
1607 ret = 1;
1608 goto cleanup;
1609 break;
1610 }
1611
1612 /* Setup IV's */
1613
1614 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1615 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1616 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1617 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1618
1619#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1620 /* Add CID */
1621 memcpy(&t_in->in_cid, cid0, cid0_len);
1622 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001623 t_in->in_cid_len = (uint8_t) cid0_len;
1624 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001625 memcpy(&t_out->in_cid, cid1, cid1_len);
1626 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001627 t_out->in_cid_len = (uint8_t) cid1_len;
1628 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001629#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1630
1631#if defined(MBEDTLS_USE_PSA_CRYPTO)
1632 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1633 t_in->taglen,
1634 &alg,
1635 &key_type,
1636 &key_bits);
1637
1638 if (status != PSA_SUCCESS) {
1639 ret = PSA_TO_MBEDTLS_ERR(status);
1640 goto cleanup;
1641 }
1642
1643 t_in->psa_alg = alg;
1644 t_out->psa_alg = alg;
1645
1646 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1647 psa_reset_key_attributes(&attributes);
1648 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1649 psa_set_key_algorithm(&attributes, alg);
1650 psa_set_key_type(&attributes, key_type);
1651
1652 status = psa_import_key(&attributes,
1653 key0,
1654 PSA_BITS_TO_BYTES(key_bits),
1655 &t_in->psa_key_enc);
1656
1657 if (status != PSA_SUCCESS) {
1658 ret = PSA_TO_MBEDTLS_ERR(status);
1659 goto cleanup;
1660 }
1661
1662 status = psa_import_key(&attributes,
1663 key1,
1664 PSA_BITS_TO_BYTES(key_bits),
1665 &t_out->psa_key_enc);
1666
1667 if (status != PSA_SUCCESS) {
1668 ret = PSA_TO_MBEDTLS_ERR(status);
1669 goto cleanup;
1670 }
1671
1672 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1673
1674 status = psa_import_key(&attributes,
1675 key1,
1676 PSA_BITS_TO_BYTES(key_bits),
1677 &t_in->psa_key_dec);
1678
1679 if (status != PSA_SUCCESS) {
1680 ret = PSA_TO_MBEDTLS_ERR(status);
1681 goto cleanup;
1682 }
1683
1684 status = psa_import_key(&attributes,
1685 key0,
1686 PSA_BITS_TO_BYTES(key_bits),
1687 &t_out->psa_key_dec);
1688
1689 if (status != PSA_SUCCESS) {
1690 ret = PSA_TO_MBEDTLS_ERR(status);
1691 goto cleanup;
1692 }
1693 }
1694#endif /* MBEDTLS_USE_PSA_CRYPTO */
1695
1696cleanup:
1697
1698 mbedtls_free(key0);
1699 mbedtls_free(key1);
1700
1701 mbedtls_free(md0);
1702 mbedtls_free(md1);
1703
1704 return ret;
1705}
1706
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001707#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1708int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1709 mbedtls_ssl_transform *transform_out)
1710{
1711#if defined(MBEDTLS_USE_PSA_CRYPTO)
1712 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1713#endif
1714
1715 /* Serialized version of record header for MAC purposes */
1716 unsigned char add_data[13];
1717 memcpy(add_data, record->ctr, 8);
1718 add_data[8] = record->type;
1719 add_data[9] = record->ver[0];
1720 add_data[10] = record->ver[1];
1721 add_data[11] = (record->data_len >> 8) & 0xff;
1722 add_data[12] = (record->data_len >> 0) & 0xff;
1723
1724 /* MAC with additional data */
1725#if defined(MBEDTLS_USE_PSA_CRYPTO)
1726 size_t sign_mac_length = 0;
1727 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1728 transform_out->psa_mac_enc,
1729 transform_out->psa_mac_alg));
1730 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1731 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1732 record->buf + record->data_offset,
1733 record->data_len));
1734 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1735 * extension, there might not be enough room in the record for the
1736 * full-length MAC. */
1737 unsigned char mac[PSA_HASH_MAX_SIZE];
1738 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1739 mac, sizeof(mac),
1740 &sign_mac_length));
1741#else
1742 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1743 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1744 record->buf + record->data_offset,
1745 record->data_len));
1746 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1747 * extension, there might not be enough room in the record for the
1748 * full-length MAC. */
1749 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1750 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1751#endif
1752 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1753 record->data_len += transform_out->maclen;
1754
1755 return 0;
1756
1757exit:
1758#if defined(MBEDTLS_USE_PSA_CRYPTO)
1759 psa_mac_abort(&operation);
1760#endif
1761 return -1;
1762}
1763#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1764
Jerry Yu28547c42023-10-31 14:42:50 +08001765#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001766int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1767 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001768 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001769 const char *crt_file)
1770{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001771 (void) ticket_len;
1772
Yanray Wange6afd912022-10-27 12:11:18 +08001773#if defined(MBEDTLS_HAVE_TIME)
1774 session->start = mbedtls_time(NULL) - 42;
1775#endif
1776 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001777
1778 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1779 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1780
1781 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001782 session->ciphersuite = 0xabcd;
1783 session->id_len = sizeof(session->id);
1784 memset(session->id, 66, session->id_len);
1785 memset(session->master, 17, sizeof(session->master));
1786
1787#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1788 if (crt_file != NULL && strlen(crt_file) != 0) {
1789 mbedtls_x509_crt tmp_crt;
1790 int ret;
1791
1792 mbedtls_x509_crt_init(&tmp_crt);
1793 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1794 if (ret != 0) {
1795 return ret;
1796 }
1797
1798#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1799 /* Move temporary CRT. */
1800 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1801 if (session->peer_cert == NULL) {
1802 return -1;
1803 }
1804 *session->peer_cert = tmp_crt;
1805 memset(&tmp_crt, 0, sizeof(tmp_crt));
1806#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1807 /* Calculate digest of temporary CRT. */
1808 session->peer_cert_digest =
1809 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1810 if (session->peer_cert_digest == NULL) {
1811 return -1;
1812 }
1813
1814#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001815 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001816 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1817 size_t hash_size = 0;
1818 psa_status_t status = psa_hash_compute(
1819 psa_alg, tmp_crt.raw.p,
1820 tmp_crt.raw.len,
1821 session->peer_cert_digest,
1822 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1823 &hash_size);
1824 ret = PSA_TO_MBEDTLS_ERR(status);
1825#else
1826 ret = mbedtls_md(mbedtls_md_info_from_type(
1827 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1828 tmp_crt.raw.p, tmp_crt.raw.len,
1829 session->peer_cert_digest);
1830#endif /* MBEDTLS_USE_PSA_CRYPTO */
1831 if (ret != 0) {
1832 return ret;
1833 }
1834 session->peer_cert_digest_type =
1835 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1836 session->peer_cert_digest_len =
1837 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1838#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1839
1840 mbedtls_x509_crt_free(&tmp_crt);
1841 }
1842#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1843 (void) crt_file;
1844#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1845 session->verify_result = 0xdeadbeef;
1846
Ronald Cronc57f86e2023-11-22 09:50:01 +01001847#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1848#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001849 if (ticket_len != 0) {
1850 session->ticket = mbedtls_calloc(1, ticket_len);
1851 if (session->ticket == NULL) {
1852 return -1;
1853 }
1854 memset(session->ticket, 33, ticket_len);
1855 }
1856 session->ticket_len = ticket_len;
1857 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001858#endif /* MBEDTLS_SSL_CLI_C */
1859
1860#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1861 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1862 session->ticket_creation_time = mbedtls_ms_time() - 42;
1863 }
Yanray Wange6afd912022-10-27 12:11:18 +08001864#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001865#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001866
1867#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1868 session->mfl_code = 1;
1869#endif
1870#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1871 session->encrypt_then_mac = 1;
1872#endif
1873
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001874exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001875 return 0;
1876}
Jerry Yu28547c42023-10-31 14:42:50 +08001877#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001878
1879#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1880int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1881 int ticket_len,
1882 int endpoint_type)
1883{
1884 ((void) ticket_len);
1885 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1886 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1887 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1888 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001889
1890#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001891 session->ticket_age_add = 0x87654321;
1892 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001893 session->resumption_key_len = 32;
1894 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001895#endif
1896
Ronald Cron18b92a12024-03-26 10:15:08 +01001897#if defined(MBEDTLS_SSL_SRV_C)
1898 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1899#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1900#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1901 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1902 if (ret != 0) {
1903 return -1;
1904 }
1905#endif
1906#if defined(MBEDTLS_HAVE_TIME)
1907 session->ticket_creation_time = mbedtls_ms_time() - 42;
1908#endif
1909#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1910 }
1911#endif /* MBEDTLS_SSL_SRV_C */
1912
Yanray Wange6afd912022-10-27 12:11:18 +08001913#if defined(MBEDTLS_SSL_CLI_C)
1914 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001915#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001916#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001917 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001918#endif
1919 session->ticket_lifetime = 0xfedcba98;
1920
1921 session->ticket_len = ticket_len;
1922 if (ticket_len != 0) {
1923 session->ticket = mbedtls_calloc(1, ticket_len);
1924 if (session->ticket == NULL) {
1925 return -1;
1926 }
1927 memset(session->ticket, 33, ticket_len);
1928 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001929#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1930 char hostname[] = "hostname example";
1931 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1932 if (session->hostname == NULL) {
1933 return -1;
1934 }
1935 memcpy(session->hostname, hostname, sizeof(hostname));
1936#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001937#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001938 }
1939#endif /* MBEDTLS_SSL_CLI_C */
1940
Ronald Cron18b92a12024-03-26 10:15:08 +01001941#if defined(MBEDTLS_SSL_EARLY_DATA)
1942 session->max_early_data_size = 0x87654321;
1943#endif /* MBEDTLS_SSL_EARLY_DATA */
1944
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001945#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1946 session->record_size_limit = 2048;
1947#endif
1948
Yanray Wange6afd912022-10-27 12:11:18 +08001949 return 0;
1950}
1951#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1952
Yanray Wangb088bfc2023-03-16 12:15:49 +08001953int mbedtls_test_ssl_exchange_data(
1954 mbedtls_ssl_context *ssl_1,
1955 int msg_len_1, const int expected_fragments_1,
1956 mbedtls_ssl_context *ssl_2,
1957 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001958{
1959 unsigned char *msg_buf_1 = malloc(msg_len_1);
1960 unsigned char *msg_buf_2 = malloc(msg_len_2);
1961 unsigned char *in_buf_1 = malloc(msg_len_2);
1962 unsigned char *in_buf_2 = malloc(msg_len_1);
1963 int msg_type, ret = -1;
1964
1965 /* Perform this test with two message types. At first use a message
1966 * consisting of only 0x00 for the client and only 0xFF for the server.
1967 * At the second time use message with generated data */
1968 for (msg_type = 0; msg_type < 2; msg_type++) {
1969 int written_1 = 0;
1970 int written_2 = 0;
1971 int read_1 = 0;
1972 int read_2 = 0;
1973 int fragments_1 = 0;
1974 int fragments_2 = 0;
1975
1976 if (msg_type == 0) {
1977 memset(msg_buf_1, 0x00, msg_len_1);
1978 memset(msg_buf_2, 0xff, msg_len_2);
1979 } else {
1980 int i, j = 0;
1981 for (i = 0; i < msg_len_1; i++) {
1982 msg_buf_1[i] = j++ & 0xFF;
1983 }
1984 for (i = 0; i < msg_len_2; i++) {
1985 msg_buf_2[i] = (j -= 5) & 0xFF;
1986 }
1987 }
1988
1989 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
1990 /* ssl_1 sending */
1991 if (msg_len_1 > written_1) {
1992 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
1993 msg_len_1, &written_1,
1994 expected_fragments_1);
1995 if (expected_fragments_1 == 0) {
1996 /* This error is expected when the message is too large and
1997 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001998 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001999 msg_len_1 = 0;
2000 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002001 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002002 }
2003 }
2004
2005 /* ssl_2 sending */
2006 if (msg_len_2 > written_2) {
2007 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
2008 msg_len_2, &written_2,
2009 expected_fragments_2);
2010 if (expected_fragments_2 == 0) {
2011 /* This error is expected when the message is too large and
2012 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02002013 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08002014 msg_len_2 = 0;
2015 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002016 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002017 }
2018 }
2019
2020 /* ssl_1 reading */
2021 if (read_1 < msg_len_2) {
2022 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
2023 msg_len_2, &read_1,
2024 &fragments_2,
2025 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002026 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002027 }
2028
2029 /* ssl_2 reading */
2030 if (read_2 < msg_len_1) {
2031 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
2032 msg_len_1, &read_2,
2033 &fragments_1,
2034 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02002035 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002036 }
2037 }
2038
2039 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02002040 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
2041 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
2042 TEST_EQUAL(fragments_1, expected_fragments_1);
2043 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08002044 }
2045
2046 ret = 0;
2047
2048exit:
2049 free(msg_buf_1);
2050 free(in_buf_1);
2051 free(msg_buf_2);
2052 free(in_buf_2);
2053
2054 return ret;
2055}
2056
2057/*
2058 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
2059 * must be initialized and connected beforehand.
2060 *
2061 * \retval 0 on success, otherwise error code.
2062 */
Yanray Wangead70c82023-03-16 12:04:49 +08002063#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
2064 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
2065 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
2066static int exchange_data(mbedtls_ssl_context *ssl_1,
2067 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08002068{
Yanray Wangb088bfc2023-03-16 12:15:49 +08002069 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
2070 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002071}
Yanray Wangead70c82023-03-16 12:04:49 +08002072#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
2073 (MBEDTLS_SSL_RENEGOTIATION ||
2074 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002075
2076#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2077static int check_ssl_version(
2078 mbedtls_ssl_protocol_version expected_negotiated_version,
Gilles Peskinebd953402025-05-28 15:20:28 +02002079 const mbedtls_ssl_context *client,
2080 const mbedtls_ssl_context *server)
Yanray Wange6afd912022-10-27 12:11:18 +08002081{
Gilles Peskinebd953402025-05-28 15:20:28 +02002082 /* First check that both sides have chosen the same version.
2083 * If so, we can make more sanity checks just on one side.
2084 * If not, something is deeply wrong. */
2085 TEST_EQUAL(client->tls_version, server->tls_version);
2086
2087 /* Make further checks on the client to validate that the
2088 * reported data about the version is correct. */
2089 const char *version_string = mbedtls_ssl_get_version(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002090 mbedtls_ssl_protocol_version version_number =
Gilles Peskinebd953402025-05-28 15:20:28 +02002091 mbedtls_ssl_get_version_number(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002092
Gilles Peskinebd953402025-05-28 15:20:28 +02002093 TEST_EQUAL(client->tls_version, expected_negotiated_version);
Yanray Wange6afd912022-10-27 12:11:18 +08002094
Gilles Peskinebd953402025-05-28 15:20:28 +02002095 if (client->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08002096 TEST_EQUAL(version_string[0], 'D');
2097 ++version_string;
2098 }
2099
2100 switch (expected_negotiated_version) {
2101 case MBEDTLS_SSL_VERSION_TLS1_2:
2102 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002103 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002104 break;
2105
2106 case MBEDTLS_SSL_VERSION_TLS1_3:
2107 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002108 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002109 break;
2110
2111 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002112 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002113 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002114 }
2115
2116 return 1;
2117
2118exit:
2119 return 0;
2120}
2121#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2122
Yanray Wange6afd912022-10-27 12:11:18 +08002123#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002124int mbedtls_test_ssl_do_handshake_with_endpoints(
2125 mbedtls_test_ssl_endpoint *server_ep,
2126 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002127 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002128 mbedtls_ssl_protocol_version proto)
2129{
2130 enum { BUFFSIZE = 1024 };
2131
2132 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002133
Max Fillingeree467aa2024-11-08 22:17:33 +01002134 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2135 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2136
Max Fillinger8f12e312024-10-30 00:29:37 +01002137 mbedtls_test_init_handshake_options(options);
2138 options->server_min_version = proto;
2139 options->client_min_version = proto;
2140 options->server_max_version = proto;
2141 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002142
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002143 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002144 if (ret != 0) {
2145 return ret;
2146 }
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002147 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002148 if (ret != 0) {
2149 return ret;
2150 }
2151
2152 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2153 if (ret != 0) {
2154 return ret;
2155 }
2156
Max Fillingerea1e7772024-10-30 00:49:10 +01002157 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2158 &client_ep->ssl,
2159 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002160 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2161 return ret;
2162 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002163 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2164 &server_ep->ssl,
2165 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002166 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2167 return ret;
2168 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002169 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2170 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002171 return -1;
2172 }
2173
2174 return 0;
2175}
2176#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2177
2178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine78df6ae2025-05-27 21:14:25 +02002179
2180#if defined(MBEDTLS_SSL_RENEGOTIATION)
2181static int test_renegotiation(const mbedtls_test_handshake_test_options *options,
2182 mbedtls_test_ssl_endpoint *client,
2183 mbedtls_test_ssl_endpoint *server)
2184{
2185 int ok = 0;
2186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2187
2188 (void) options; // only used in some configurations
2189
2190 /* Start test with renegotiation */
2191 TEST_EQUAL(server->ssl.renego_status,
2192 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2193 TEST_EQUAL(client->ssl.renego_status,
2194 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2195
2196 /* After calling this function for the server, it only sends a handshake
2197 * request. All renegotiation should happen during data exchanging */
2198 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server->ssl)), 0);
2199 TEST_EQUAL(server->ssl.renego_status,
2200 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2201 TEST_EQUAL(client->ssl.renego_status,
2202 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2203
2204 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2205 TEST_EQUAL(server->ssl.renego_status,
2206 MBEDTLS_SSL_RENEGOTIATION_DONE);
2207 TEST_EQUAL(client->ssl.renego_status,
2208 MBEDTLS_SSL_RENEGOTIATION_DONE);
2209
2210 /* After calling mbedtls_ssl_renegotiate for the client,
2211 * all renegotiation should happen inside this function.
2212 * However in this test, we cannot perform simultaneous communication
2213 * between client and server so this function will return waiting error
2214 * on the socket. All rest of renegotiation should happen
2215 * during data exchanging */
2216 ret = mbedtls_ssl_renegotiate(&(client->ssl));
2217#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2218 if (options->resize_buffers != 0) {
2219 /* Ensure that the buffer sizes are appropriate before resizes */
2220 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2221 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2222 }
2223#endif
2224 TEST_ASSERT(ret == 0 ||
2225 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2226 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
2227 TEST_EQUAL(server->ssl.renego_status,
2228 MBEDTLS_SSL_RENEGOTIATION_DONE);
2229 TEST_EQUAL(client->ssl.renego_status,
2230 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
2231
2232 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2233 TEST_EQUAL(server->ssl.renego_status,
2234 MBEDTLS_SSL_RENEGOTIATION_DONE);
2235 TEST_EQUAL(client->ssl.renego_status,
2236 MBEDTLS_SSL_RENEGOTIATION_DONE);
2237#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2238 /* Validate buffer sizes after renegotiation */
2239 if (options->resize_buffers != 0) {
2240 TEST_EQUAL(client->ssl.out_buf_len,
2241 mbedtls_ssl_get_output_buflen(&client->ssl));
2242 TEST_EQUAL(client->ssl.in_buf_len,
2243 mbedtls_ssl_get_input_buflen(&client->ssl));
2244 TEST_EQUAL(server->ssl.out_buf_len,
2245 mbedtls_ssl_get_output_buflen(&server->ssl));
2246 TEST_EQUAL(server->ssl.in_buf_len,
2247 mbedtls_ssl_get_input_buflen(&server->ssl));
2248 }
2249#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2250
2251 ok = 1;
2252
2253exit:
2254 return ok;
2255}
2256#endif /* MBEDTLS_SSL_RENEGOTIATION */
2257
Gilles Peskinee23a6d12025-05-27 21:17:09 +02002258#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2259static int test_serialization(const mbedtls_test_handshake_test_options *options,
2260 mbedtls_test_ssl_endpoint *client,
2261 mbedtls_test_ssl_endpoint *server)
2262{
2263 int ok = 0;
2264 unsigned char *context_buf = NULL;
2265 size_t context_buf_len;
2266
2267 TEST_EQUAL(options->dtls, 1);
2268
2269 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), NULL,
2270 0, &context_buf_len),
2271 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
2272
2273 context_buf = mbedtls_calloc(1, context_buf_len);
2274 TEST_ASSERT(context_buf != NULL);
2275
2276 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), context_buf,
2277 context_buf_len,
2278 &context_buf_len),
2279 0);
2280
2281 mbedtls_ssl_free(&(server->ssl));
2282 mbedtls_ssl_init(&(server->ssl));
2283
2284 TEST_EQUAL(mbedtls_ssl_setup(&(server->ssl), &(server->conf)), 0);
2285
2286 mbedtls_ssl_set_bio(&(server->ssl), &server->dtls_context,
2287 mbedtls_test_mock_tcp_send_msg,
2288 mbedtls_test_mock_tcp_recv_msg,
2289 NULL);
2290
2291 mbedtls_ssl_set_user_data_p(&server->ssl, server);
2292
2293#if defined(MBEDTLS_TIMING_C)
2294 mbedtls_ssl_set_timer_cb(&server->ssl, &server->timer,
2295 mbedtls_timing_set_delay,
2296 mbedtls_timing_get_delay);
2297#endif
2298#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2299 if (options->resize_buffers != 0) {
2300 /* Ensure that the buffer sizes are appropriate before resizes */
2301 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2302 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2303 }
2304#endif
2305 TEST_EQUAL(mbedtls_ssl_context_load(&(server->ssl), context_buf,
2306 context_buf_len), 0);
2307
2308#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2309 /* Validate buffer sizes after context deserialization */
2310 if (options->resize_buffers != 0) {
2311 TEST_EQUAL(server->ssl.out_buf_len,
2312 mbedtls_ssl_get_output_buflen(&server->ssl));
2313 TEST_EQUAL(server->ssl.in_buf_len,
2314 mbedtls_ssl_get_input_buflen(&server->ssl));
2315 }
2316#endif
2317 /* Retest writing/reading */
2318 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2319 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2320 &(client->ssl), options->cli_msg_len,
2321 options->expected_cli_fragments,
2322 &(server->ssl), options->srv_msg_len,
2323 options->expected_srv_fragments),
2324 0);
2325 }
2326
2327 ok = 1;
2328
2329exit:
2330 mbedtls_free(context_buf);
2331 return ok;
2332}
2333#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2334
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002335int mbedtls_test_ssl_perform_connection(
2336 const mbedtls_test_handshake_test_options *options,
2337 mbedtls_test_ssl_endpoint *client,
2338 mbedtls_test_ssl_endpoint *server)
2339{
2340 enum { BUFFSIZE = 17000 };
2341 int expected_handshake_result = options->expected_handshake_result;
2342 int ok = 0;
2343
2344 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client->socket),
2345 &(server->socket),
2346 BUFFSIZE), 0);
2347
2348#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2349 if (options->resize_buffers != 0) {
2350 /* Ensure that the buffer sizes are appropriate before resizes */
2351 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2352 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2353 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2354 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2355 }
2356#endif
2357
2358 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2359 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2360 }
2361
2362 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client->ssl),
2363 &(server->ssl),
2364 MBEDTLS_SSL_HANDSHAKE_OVER),
2365 expected_handshake_result);
2366
2367 if (expected_handshake_result != 0) {
2368 /* Connection will have failed by this point, skip to cleanup */
2369 ok = 1;
2370 goto exit;
2371 }
2372
2373 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client->ssl), 1);
2374
2375 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2376 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server->ssl),
2377 &(client->ssl),
2378 MBEDTLS_SSL_HANDSHAKE_OVER),
2379 0);
2380
2381 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server->ssl), 1);
2382
2383 /* Check that both sides have negotiated the expected version. */
2384 TEST_ASSERT(check_ssl_version(options->expected_negotiated_version,
2385 &client->ssl,
2386 &server->ssl));
2387
2388 if (options->expected_ciphersuite != 0) {
2389 TEST_EQUAL(server->ssl.session->ciphersuite,
2390 options->expected_ciphersuite);
2391 }
2392
2393#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2394 if (options->resize_buffers != 0) {
2395 /* A server, when using DTLS, might delay a buffer resize to happen
2396 * after it receives a message, so we force it. */
2397 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2398
2399 TEST_EQUAL(client->ssl.out_buf_len,
2400 mbedtls_ssl_get_output_buflen(&client->ssl));
2401 TEST_EQUAL(client->ssl.in_buf_len,
2402 mbedtls_ssl_get_input_buflen(&client->ssl));
2403 TEST_EQUAL(server->ssl.out_buf_len,
2404 mbedtls_ssl_get_output_buflen(&server->ssl));
2405 TEST_EQUAL(server->ssl.in_buf_len,
2406 mbedtls_ssl_get_input_buflen(&server->ssl));
2407 }
2408#endif
2409
2410 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2411 /* Start data exchanging test */
2412 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2413 &(client->ssl), options->cli_msg_len,
2414 options->expected_cli_fragments,
2415 &(server->ssl), options->srv_msg_len,
2416 options->expected_srv_fragments),
2417 0);
2418 }
2419#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2420 if (options->serialize == 1) {
2421 TEST_ASSERT(test_serialization(options, client, server));
2422 }
2423#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2424
2425#if defined(MBEDTLS_SSL_RENEGOTIATION)
2426 if (options->renegotiate) {
2427 TEST_ASSERT(test_renegotiation(options, client, server));
2428 }
2429#endif /* MBEDTLS_SSL_RENEGOTIATION */
2430
2431 ok = 1;
2432
2433exit:
2434 return ok;
2435}
2436
Yanray Wange6afd912022-10-27 12:11:18 +08002437void mbedtls_test_ssl_perform_handshake(
Gilles Peskine9b993682025-05-27 18:44:12 +02002438 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +08002439{
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002440 mbedtls_test_ssl_endpoint client_struct;
2441 memset(&client_struct, 0, sizeof(client_struct));
2442 mbedtls_test_ssl_endpoint *const client = &client_struct;
2443 mbedtls_test_ssl_endpoint server_struct;
2444 memset(&server_struct, 0, sizeof(server_struct));
2445 mbedtls_test_ssl_endpoint *const server = &server_struct;
Yanray Wange6afd912022-10-27 12:11:18 +08002446
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002447 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002448
Ronald Cronec3408d2024-01-16 17:50:40 +01002449#if defined(MBEDTLS_DEBUG_C)
2450 if (options->cli_log_fun || options->srv_log_fun) {
2451 mbedtls_debug_set_threshold(4);
2452 }
2453#endif
2454
Yanray Wange6afd912022-10-27 12:11:18 +08002455 /* Client side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002456 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(client,
Gilles Peskine07432b92025-05-27 21:07:44 +02002457 MBEDTLS_SSL_IS_CLIENT,
2458 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002459
Yanray Wange6afd912022-10-27 12:11:18 +08002460 /* Server side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002461 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(server,
Gilles Peskine07432b92025-05-27 21:07:44 +02002462 MBEDTLS_SSL_IS_SERVER,
2463 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002464
Gilles Peskineb092e782025-05-27 20:15:03 +02002465 if (options->dtls) {
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002466 TEST_EQUAL(mbedtls_test_ssl_dtls_join_endpoints(client, server), 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02002467 }
2468
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002469 TEST_ASSERT(mbedtls_test_ssl_perform_connection(options, client, server));
Yanray Wange6afd912022-10-27 12:11:18 +08002470
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002471 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client->conf) == client);
2472 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client->ssl) == client);
2473 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server->conf) == server);
2474 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server->ssl) == server);
Yanray Wange6afd912022-10-27 12:11:18 +08002475
2476exit:
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002477 mbedtls_test_ssl_endpoint_free(client);
2478 mbedtls_test_ssl_endpoint_free(server);
Yanray Wange6afd912022-10-27 12:11:18 +08002479#if defined(MBEDTLS_DEBUG_C)
2480 if (options->cli_log_fun || options->srv_log_fun) {
2481 mbedtls_debug_set_threshold(0);
2482 }
2483#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002484 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002485}
2486#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2487
2488#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002489int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002490 unsigned char *buf, unsigned char **end, int tweak,
2491 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2492{
2493/*
2494 * The definition of the tweaks assume that the certificate list contains only
2495 * one certificate.
2496 */
2497
2498/*
2499 * struct {
2500 * opaque cert_data<1..2^24-1>;
2501 * Extension extensions<0..2^16-1>;
2502 * } CertificateEntry;
2503 *
2504 * struct {
2505 * opaque certificate_request_context<0..2^8-1>;
2506 * CertificateEntry certificate_list<0..2^24-1>;
2507 * } Certificate;
2508 */
2509 unsigned char *p_certificate_request_context_len = buf;
2510 size_t certificate_request_context_len = buf[0];
2511
2512 unsigned char *p_certificate_list_len =
2513 buf + 1 + certificate_request_context_len;
2514 unsigned char *certificate_list = p_certificate_list_len + 3;
2515 size_t certificate_list_len =
2516 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2517
2518 unsigned char *p_cert_data_len = certificate_list;
2519 unsigned char *cert_data = p_cert_data_len + 3;
2520 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2521
2522 unsigned char *p_extensions_len = cert_data + cert_data_len;
2523 unsigned char *extensions = p_extensions_len + 2;
2524 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2525
2526 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2527
2528 switch (tweak) {
2529 case 1:
2530 /* Failure when checking if the certificate request context length
2531 * and certificate list length can be read
2532 */
2533 *end = buf + 3;
2534 set_chk_buf_ptr_args(args, buf, *end, 4);
2535 break;
2536
2537 case 2:
2538 /* Invalid certificate request context length.
2539 */
2540 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002541 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002542 reset_chk_buf_ptr_args(args);
2543 break;
2544
2545 case 3:
2546 /* Failure when checking if certificate_list data can be read. */
2547 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2548 p_certificate_list_len, 0);
2549 set_chk_buf_ptr_args(args, certificate_list, *end,
2550 certificate_list_len + 1);
2551 break;
2552
2553 case 4:
2554 /* Failure when checking if the cert_data length can be read. */
2555 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2556 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2557 break;
2558
2559 case 5:
2560 /* Failure when checking if cert_data data can be read. */
2561 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2562 p_cert_data_len, 0);
2563 set_chk_buf_ptr_args(args, cert_data,
2564 certificate_list + certificate_list_len,
2565 certificate_list_len - 3 + 1);
2566 break;
2567
2568 case 6:
2569 /* Failure when checking if the extensions length can be read. */
2570 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2571 p_certificate_list_len, 0);
2572 set_chk_buf_ptr_args(
2573 args, p_extensions_len,
2574 certificate_list + certificate_list_len - extensions_len - 1, 2);
2575 break;
2576
2577 case 7:
2578 /* Failure when checking if extensions data can be read. */
2579 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2580
2581 set_chk_buf_ptr_args(
2582 args, extensions,
2583 certificate_list + certificate_list_len, extensions_len + 1);
2584 break;
2585
2586 default:
2587 return -1;
2588 }
2589
2590 return 0;
2591}
2592#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002593
Ronald Cronfaf026c2024-01-31 14:32:06 +01002594/*
2595 * Functions for tests based on tickets. Implementations of the
2596 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2597 * Basically same implementations as in ticket.c without the encryption. That
2598 * way we can tweak easily tickets characteristics to simulate misbehaving
2599 * peers.
2600 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002601#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2602int mbedtls_test_ticket_write(
2603 void *p_ticket, const mbedtls_ssl_session *session,
2604 unsigned char *start, const unsigned char *end,
2605 size_t *tlen, uint32_t *lifetime)
2606{
2607 int ret;
2608 ((void) p_ticket);
2609
2610 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2611 tlen)) != 0) {
2612 return ret;
2613 }
2614
2615 /* Maximum ticket lifetime as defined in RFC 8446 */
2616 *lifetime = 7 * 24 * 3600;
2617
2618 return 0;
2619}
2620
2621int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2622 unsigned char *buf, size_t len)
2623{
2624 ((void) p_ticket);
2625
2626 return mbedtls_ssl_session_load(session, buf, len);
2627}
2628#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002629
2630#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2631 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2632 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2633int mbedtls_test_get_tls13_ticket(
2634 mbedtls_test_handshake_test_options *client_options,
2635 mbedtls_test_handshake_test_options *server_options,
2636 mbedtls_ssl_session *session)
2637{
2638 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002639 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002640 unsigned char buf[64];
2641 mbedtls_test_ssl_endpoint client_ep, server_ep;
2642
2643 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2644 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2645
2646 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002647 client_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002648 TEST_EQUAL(ret, 0);
2649
2650 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002651 server_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002652 TEST_EQUAL(ret, 0);
2653
2654 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2655 mbedtls_test_ticket_write,
2656 mbedtls_test_ticket_parse,
2657 NULL);
2658
2659 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2660 &(server_ep.socket), 1024);
2661 TEST_EQUAL(ret, 0);
2662
2663 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2664 &(server_ep.ssl), &(client_ep.ssl),
2665 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2666
2667 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2668
2669 do {
2670 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2671 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2672
2673 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2674 TEST_EQUAL(ret, 0);
2675
Gilles Peskine946bf142025-04-08 09:48:40 +02002676 ok = 1;
2677
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002678exit:
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002679 mbedtls_test_ssl_endpoint_free(&client_ep);
2680 mbedtls_test_ssl_endpoint_free(&server_ep);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002681
Gilles Peskine946bf142025-04-08 09:48:40 +02002682 if (ret == 0 && !ok) {
2683 /* Exiting due to a test assertion that isn't ret == 0 */
2684 ret = -1;
2685 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002686 return ret;
2687}
2688#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2689 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2690 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2691
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002692#endif /* MBEDTLS_SSL_TLS_C */