blob: 68ac122f8d4d89e3254e4eec0b5aa12222f26fca [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
838 /* Non-blocking callbacks without timeout */
Gilles Peskine29969592025-05-27 19:24:28 +0200839 if (options->dtls) {
840 mbedtls_ssl_set_bio(&(ep->ssl), &ep->dtls_context,
Yanray Wange6afd912022-10-27 12:11:18 +0800841 mbedtls_test_mock_tcp_send_msg,
842 mbedtls_test_mock_tcp_recv_msg,
843 NULL);
Gilles Peskine0677e022025-05-27 18:05:20 +0200844#if defined(MBEDTLS_TIMING_C)
845 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
846 mbedtls_timing_set_delay,
847 mbedtls_timing_get_delay);
848#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800849 } else {
850 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
851 mbedtls_test_mock_tcp_send_nb,
852 mbedtls_test_mock_tcp_recv_nb,
853 NULL);
854 }
855
856 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
Gilles Peskine29969592025-05-27 19:24:28 +0200857 options->dtls ?
Yanray Wange6afd912022-10-27 12:11:18 +0800858 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
859 MBEDTLS_SSL_TRANSPORT_STREAM,
860 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200861 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800862
Ronald Crona697a712023-03-09 17:47:42 +0100863 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
864 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
865 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
866 options->client_min_version);
867 }
868
869 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
870 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
871 options->client_max_version);
872 }
873 } else {
874 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
875 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
876 options->server_min_version);
877 }
878
879 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
880 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
881 options->server_max_version);
882 }
883 }
884
Gilles Peskine27586d82025-05-28 17:01:42 +0200885 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
886 TEST_ASSERT(set_ciphersuite(ep, options->cipher));
887 }
888
Ronald Cronfb536472024-01-26 14:55:25 +0100889 if (options->group_list != NULL) {
890 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800891 }
892
Gilles Peskinefb2ce052025-05-28 17:36:12 +0200893 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
894 mbedtls_ssl_conf_authmode(&(ep->conf), options->srv_auth_mode);
895 } else {
896 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
897 }
Yanray Wange6afd912022-10-27 12:11:18 +0800898
Ronald Cronced99be2024-01-26 15:49:12 +0100899#if defined(MBEDTLS_SSL_EARLY_DATA)
900 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100901#if defined(MBEDTLS_SSL_SRV_C)
902 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
903 (options->max_early_data_size >= 0)) {
904 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
905 options->max_early_data_size);
906 }
907#endif
Gilles Peskine27586d82025-05-28 17:01:42 +0200908
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000909#if defined(MBEDTLS_SSL_ALPN)
910 /* check that alpn_list contains at least one valid entry */
911 if (options->alpn_list[0] != NULL) {
912 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
913 }
914#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100915#endif
916
Gilles Peskine27586d82025-05-28 17:01:42 +0200917#if defined(MBEDTLS_SSL_RENEGOTIATION)
918 if (options->renegotiate) {
919 mbedtls_ssl_conf_renegotiation(&ep->conf,
920 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
921 mbedtls_ssl_conf_legacy_renegotiation(&ep->conf,
922 options->legacy_renegotiation);
923 }
924#endif /* MBEDTLS_SSL_RENEGOTIATION */
925
Yanray Wange6afd912022-10-27 12:11:18 +0800926#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
927 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
928 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
929 mbedtls_ssl_cache_get,
930 mbedtls_ssl_cache_set);
931 }
932#endif
933
Gilles Peskine27586d82025-05-28 17:01:42 +0200934#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
935 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&ep->conf,
936 (unsigned char) options->mfl),
937 0);
938#else
939 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
940#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
941
Yanray Wange6afd912022-10-27 12:11:18 +0800942 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
Gilles Peskine353eb332025-05-14 17:42:53 +0200943 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800944
Gilles Peskine856a3702025-02-13 17:28:49 +0100945 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
946 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
Gilles Peskine55b8bb42025-04-08 09:44:34 +0200947 TEST_EQUAL(ret, 0);
Gilles Peskine856a3702025-02-13 17:28:49 +0100948 }
949
Yanray Wange6afd912022-10-27 12:11:18 +0800950#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine29969592025-05-27 19:24:28 +0200951 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->dtls) {
Yanray Wange6afd912022-10-27 12:11:18 +0800952 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
953 }
954#endif
955
Ronald Cronec3408d2024-01-16 17:50:40 +0100956#if defined(MBEDTLS_DEBUG_C)
957#if defined(MBEDTLS_SSL_SRV_C)
958 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
959 options->srv_log_fun != NULL) {
960 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
961 options->srv_log_obj);
962 }
963#endif
964#if defined(MBEDTLS_SSL_CLI_C)
965 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
966 options->cli_log_fun != NULL) {
967 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
968 options->cli_log_obj);
969 }
970#endif
971#endif /* MBEDTLS_DEBUG_C */
972
Yanray Wange6afd912022-10-27 12:11:18 +0800973 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
974 options->opaque_alg,
975 options->opaque_alg2,
976 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200977 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800978
Gilles Peskine27586d82025-05-28 17:01:42 +0200979#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
980 if (options->psk_str != NULL && options->psk_str->len > 0) {
981 TEST_EQUAL(mbedtls_ssl_conf_psk(
982 &ep->conf, options->psk_str->x,
983 options->psk_str->len,
984 (const unsigned char *) psk_identity,
985 strlen(psk_identity)), 0);
986#if defined(MBEDTLS_SSL_SRV_C)
987 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
988 mbedtls_ssl_conf_psk_cb(&ep->conf, psk_dummy_callback, NULL);
989 }
990#endif
991 }
992#endif
993
Yanray Wange6afd912022-10-27 12:11:18 +0800994 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), user_data_n);
995 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
996 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), user_data_n);
997 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
998
Gilles Peskine946bf142025-04-08 09:48:40 +0200999 return 0;
1000
Yanray Wange6afd912022-10-27 12:11:18 +08001001exit:
Gilles Peskine946bf142025-04-08 09:48:40 +02001002 if (ret == 0) {
1003 /* Exiting due to a test assertion that isn't ret == 0 */
1004 ret = -1;
1005 }
Yanray Wange6afd912022-10-27 12:11:18 +08001006 return ret;
1007}
1008
Yanray Wange6afd912022-10-27 12:11:18 +08001009void mbedtls_test_ssl_endpoint_free(
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02001010 mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +08001011{
Yanray Wange6afd912022-10-27 12:11:18 +08001012 mbedtls_ssl_free(&(ep->ssl));
1013 mbedtls_ssl_config_free(&(ep->conf));
1014
Gilles Peskine2744a432025-05-27 13:27:22 +02001015 mbedtls_free(ep->ciphersuites);
1016 ep->ciphersuites = NULL;
1017 test_ssl_endpoint_certificate_free(ep);
1018
Gilles Peskine29969592025-05-27 19:24:28 +02001019 if (ep->dtls_context.socket != NULL) {
1020 mbedtls_test_message_socket_close(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +08001021 } else {
1022 mbedtls_test_mock_socket_close(&(ep->socket));
1023 }
1024}
1025
Gilles Peskineb092e782025-05-27 20:15:03 +02001026int mbedtls_test_ssl_dtls_join_endpoints(mbedtls_test_ssl_endpoint *client,
1027 mbedtls_test_ssl_endpoint *server)
1028{
1029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1030
Gilles Peskine6c154e72025-05-27 20:23:52 +02001031 ret = mbedtls_test_message_socket_setup(&client->queue_input,
1032 &server->queue_input,
1033 100, &(client->socket),
1034 &client->dtls_context);
1035 TEST_EQUAL(ret, 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02001036
Gilles Peskine6c154e72025-05-27 20:23:52 +02001037 ret = mbedtls_test_message_socket_setup(&server->queue_input,
1038 &client->queue_input,
1039 100, &(server->socket),
1040 &server->dtls_context);
1041 TEST_EQUAL(ret, 0);
1042
1043exit:
Gilles Peskineb092e782025-05-27 20:15:03 +02001044 return ret;
1045}
1046
Yanray Wange6afd912022-10-27 12:11:18 +08001047int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
1048 mbedtls_ssl_context *second_ssl,
1049 int state)
1050{
1051 enum { BUFFSIZE = 1024 };
1052 int max_steps = 1000;
1053 int ret = 0;
1054
1055 if (ssl == NULL || second_ssl == NULL) {
1056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1057 }
1058
1059 /* Perform communication via connected sockets */
1060 while ((ssl->state != state) && (--max_steps >= 0)) {
1061 /* If /p second_ssl ends the handshake procedure before /p ssl then
1062 * there is no need to call the next step */
1063 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
1064 ret = mbedtls_ssl_handshake_step(second_ssl);
1065 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1066 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1067 return ret;
1068 }
1069 }
1070
1071 /* We only care about the \p ssl state and returns, so we call it last,
1072 * to leave the iteration as soon as the state is as expected. */
1073 ret = mbedtls_ssl_handshake_step(ssl);
1074 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1075 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1076 return ret;
1077 }
1078 }
1079
1080 return (max_steps >= 0) ? ret : -1;
1081}
1082
1083#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
1084
1085/*
1086 * Write application data. Increase write counter if necessary.
1087 */
Michael Schuster54300d42024-06-04 02:30:22 +02001088static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001089 unsigned char *buf, int buf_len,
1090 int *written,
1091 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001092{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001093 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001094 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1095 * a valid no-op for TLS connections. */
1096 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001097 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001098 }
1099
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001100 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +08001101 if (ret > 0) {
1102 *written += ret;
1103 }
1104
1105 if (expected_fragments == 0) {
1106 /* Used for DTLS and the message size larger than MFL. In that case
1107 * the message can not be fragmented and the library should return
1108 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +08001109 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +08001110 return ret;
1111 } else if (expected_fragments == 1) {
1112 /* Used for TLS/DTLS and the message size lower than MFL */
1113 TEST_ASSERT(ret == buf_len ||
1114 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1115 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1116 } else {
1117 /* Used for TLS and the message size larger than MFL */
1118 TEST_ASSERT(expected_fragments > 1);
1119 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1120 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1121 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1122 }
1123
1124 return 0;
1125
1126exit:
1127 /* Some of the tests failed */
1128 return -1;
1129}
1130
1131/*
1132 * Read application data and increase read counter and fragments counter
1133 * if necessary.
1134 */
Michael Schuster54300d42024-06-04 02:30:22 +02001135static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001136 unsigned char *buf, int buf_len,
1137 int *read, int *fragments,
1138 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001139{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001140 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001141 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1142 * a valid no-op for TLS connections. */
1143 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001144 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001145 }
1146
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001147 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001148 if (ret > 0) {
1149 (*fragments)++;
1150 *read += ret;
1151 }
1152
1153 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001154 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001155 } else if (expected_fragments == 1) {
1156 TEST_ASSERT(ret == buf_len ||
1157 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1158 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1159 } else {
1160 TEST_ASSERT(expected_fragments > 1);
1161 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1162 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1163 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1164 }
1165
1166 return 0;
1167
1168exit:
1169 /* Some of the tests failed */
1170 return -1;
1171}
1172
Yanray Wange6afd912022-10-27 12:11:18 +08001173#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001174 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001175int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1176 const unsigned char *iv,
1177 size_t iv_len,
1178 const unsigned char *input,
1179 size_t ilen,
1180 unsigned char *output,
1181 size_t *olen)
1182{
1183#if defined(MBEDTLS_USE_PSA_CRYPTO)
1184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1185 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1186 size_t part_len;
1187
1188 status = psa_cipher_encrypt_setup(&cipher_op,
1189 transform->psa_key_enc,
1190 transform->psa_alg);
1191
1192 if (status != PSA_SUCCESS) {
1193 return PSA_TO_MBEDTLS_ERR(status);
1194 }
1195
1196 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1197
1198 if (status != PSA_SUCCESS) {
1199 return PSA_TO_MBEDTLS_ERR(status);
1200 }
1201
1202 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1203
1204 if (status != PSA_SUCCESS) {
1205 return PSA_TO_MBEDTLS_ERR(status);
1206 }
1207
1208 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1209 &part_len);
1210
1211 if (status != PSA_SUCCESS) {
1212 return PSA_TO_MBEDTLS_ERR(status);
1213 }
1214
1215 *olen += part_len;
1216 return 0;
1217#else
1218 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1219 iv, iv_len, input, ilen, output, olen);
1220#endif /* MBEDTLS_USE_PSA_CRYPTO */
1221}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001222#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001223 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001224
Valerio Setti31ad3a12023-10-27 11:55:02 +02001225static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1226 mbedtls_cipher_mode_t *cipher_mode,
1227 size_t *key_bits, size_t *iv_len)
1228{
1229 switch (cipher_type) {
1230 case MBEDTLS_CIPHER_AES_128_CBC:
1231 *cipher_mode = MBEDTLS_MODE_CBC;
1232 *key_bits = 128;
1233 *iv_len = 16;
1234 break;
1235 case MBEDTLS_CIPHER_AES_256_CBC:
1236 *cipher_mode = MBEDTLS_MODE_CBC;
1237 *key_bits = 256;
1238 *iv_len = 16;
1239 break;
1240 case MBEDTLS_CIPHER_ARIA_128_CBC:
1241 *cipher_mode = MBEDTLS_MODE_CBC;
1242 *key_bits = 128;
1243 *iv_len = 16;
1244 break;
1245 case MBEDTLS_CIPHER_ARIA_256_CBC:
1246 *cipher_mode = MBEDTLS_MODE_CBC;
1247 *key_bits = 256;
1248 *iv_len = 16;
1249 break;
1250 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1251 *cipher_mode = MBEDTLS_MODE_CBC;
1252 *key_bits = 128;
1253 *iv_len = 16;
1254 break;
1255 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1256 *cipher_mode = MBEDTLS_MODE_CBC;
1257 *key_bits = 256;
1258 *iv_len = 16;
1259 break;
1260
1261 case MBEDTLS_CIPHER_AES_128_CCM:
1262 *cipher_mode = MBEDTLS_MODE_CCM;
1263 *key_bits = 128;
1264 *iv_len = 12;
1265 break;
1266 case MBEDTLS_CIPHER_AES_192_CCM:
1267 *cipher_mode = MBEDTLS_MODE_CCM;
1268 *key_bits = 192;
1269 *iv_len = 12;
1270 break;
1271 case MBEDTLS_CIPHER_AES_256_CCM:
1272 *cipher_mode = MBEDTLS_MODE_CCM;
1273 *key_bits = 256;
1274 *iv_len = 12;
1275 break;
1276 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1277 *cipher_mode = MBEDTLS_MODE_CCM;
1278 *key_bits = 128;
1279 *iv_len = 12;
1280 break;
1281 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1282 *cipher_mode = MBEDTLS_MODE_CCM;
1283 *key_bits = 192;
1284 *iv_len = 12;
1285 break;
1286 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1287 *cipher_mode = MBEDTLS_MODE_CCM;
1288 *key_bits = 256;
1289 *iv_len = 12;
1290 break;
1291
1292 case MBEDTLS_CIPHER_AES_128_GCM:
1293 *cipher_mode = MBEDTLS_MODE_GCM;
1294 *key_bits = 128;
1295 *iv_len = 12;
1296 break;
1297 case MBEDTLS_CIPHER_AES_192_GCM:
1298 *cipher_mode = MBEDTLS_MODE_GCM;
1299 *key_bits = 192;
1300 *iv_len = 12;
1301 break;
1302 case MBEDTLS_CIPHER_AES_256_GCM:
1303 *cipher_mode = MBEDTLS_MODE_GCM;
1304 *key_bits = 256;
1305 *iv_len = 12;
1306 break;
1307 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1308 *cipher_mode = MBEDTLS_MODE_GCM;
1309 *key_bits = 128;
1310 *iv_len = 12;
1311 break;
1312 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1313 *cipher_mode = MBEDTLS_MODE_GCM;
1314 *key_bits = 192;
1315 *iv_len = 12;
1316 break;
1317 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1318 *cipher_mode = MBEDTLS_MODE_GCM;
1319 *key_bits = 256;
1320 *iv_len = 12;
1321 break;
1322
1323 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1324 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1325 *key_bits = 256;
1326 *iv_len = 12;
1327 break;
1328
1329 case MBEDTLS_CIPHER_NULL:
1330 *cipher_mode = MBEDTLS_MODE_STREAM;
1331 *key_bits = 0;
1332 *iv_len = 0;
1333 break;
1334
1335 default:
1336 *cipher_mode = MBEDTLS_MODE_NONE;
1337 *key_bits = 0;
1338 *iv_len = 0;
1339 }
1340}
1341
Yanray Wange6afd912022-10-27 12:11:18 +08001342int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1343 mbedtls_ssl_transform *t_out,
1344 int cipher_type, int hash_id,
1345 int etm, int tag_mode,
1346 mbedtls_ssl_protocol_version tls_version,
1347 size_t cid0_len,
1348 size_t cid1_len)
1349{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001350 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1351 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001352 int ret = 0;
1353
1354#if defined(MBEDTLS_USE_PSA_CRYPTO)
1355 psa_key_type_t key_type;
1356 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1357 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001358 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001359#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001360 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001361#endif
1362
Valerio Setti31ad3a12023-10-27 11:55:02 +02001363 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001364 unsigned char *key0 = NULL, *key1 = NULL;
1365 unsigned char *md0 = NULL, *md1 = NULL;
1366 unsigned char iv_enc[16], iv_dec[16];
1367
1368#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1369 unsigned char cid0[SSL_CID_LEN_MIN];
1370 unsigned char cid1[SSL_CID_LEN_MIN];
1371
1372 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1373 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1374#else
1375 ((void) cid0_len);
1376 ((void) cid1_len);
1377#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1378
1379 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001380 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1381 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001382
1383 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001384 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001385 /* Allocate `keylen + 1` bytes to ensure that we get
1386 * a non-NULL pointers from `mbedtls_calloc` even if
1387 * `keylen == 0` in the case of the NULL cipher. */
1388 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1389 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1390 memset(key0, 0x1, keylen);
1391 memset(key1, 0x2, keylen);
1392
1393#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001394 /* Pick cipher */
1395 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1396 CHK(cipher_info != NULL);
1397 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1398 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001399
Yanray Wange6afd912022-10-27 12:11:18 +08001400 /* Setup cipher contexts */
1401 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1402 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1403 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1404 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1405
1406#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001407 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001408 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1409 MBEDTLS_PADDING_NONE) == 0);
1410 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1411 MBEDTLS_PADDING_NONE) == 0);
1412 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1413 MBEDTLS_PADDING_NONE) == 0);
1414 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1415 MBEDTLS_PADDING_NONE) == 0);
1416 }
1417#endif /* MBEDTLS_CIPHER_MODE_CBC */
1418
1419 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001420 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1421 MBEDTLS_ENCRYPT)
1422 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001423 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001424 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1425 MBEDTLS_DECRYPT)
1426 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001427 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001428 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1429 MBEDTLS_ENCRYPT)
1430 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001431 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001432 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1433 MBEDTLS_DECRYPT)
1434 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001435#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001436
1437 /* Setup MAC contexts */
1438#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001439 if (cipher_mode == MBEDTLS_MODE_CBC ||
1440 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001441#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001442 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 +08001443 CHK(md_info != NULL);
1444#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001445 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001446 CHK(maclen != 0);
1447 /* Pick hash keys */
1448 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1449 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1450 memset(md0, 0x5, maclen);
1451 memset(md1, 0x6, maclen);
1452
1453#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001454 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001455
1456 CHK(alg != 0);
1457
1458 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1459 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1460 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1461 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1462 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1463 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1464
1465 psa_reset_key_attributes(&attributes);
1466 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1467 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1468 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1469
1470 CHK(psa_import_key(&attributes,
1471 md0, maclen,
1472 &t_in->psa_mac_enc) == PSA_SUCCESS);
1473
1474 CHK(psa_import_key(&attributes,
1475 md1, maclen,
1476 &t_out->psa_mac_enc) == PSA_SUCCESS);
1477
Valerio Setti31ad3a12023-10-27 11:55:02 +02001478 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001479 etm == MBEDTLS_SSL_ETM_DISABLED) {
1480 /* mbedtls_ct_hmac() requires the key to be exportable */
1481 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1482 PSA_KEY_USAGE_VERIFY_HASH);
1483 } else {
1484 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1485 }
1486
1487 CHK(psa_import_key(&attributes,
1488 md1, maclen,
1489 &t_in->psa_mac_dec) == PSA_SUCCESS);
1490
1491 CHK(psa_import_key(&attributes,
1492 md0, maclen,
1493 &t_out->psa_mac_dec) == PSA_SUCCESS);
1494#else
1495 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1496 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1497 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1498 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1499
1500 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1501 md0, maclen) == 0);
1502 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1503 md1, maclen) == 0);
1504 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1505 md1, maclen) == 0);
1506 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1507 md0, maclen) == 0);
1508#endif
1509 }
1510#else
1511 ((void) hash_id);
1512#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1513
1514
1515 /* Pick IV's (regardless of whether they
1516 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001517 memset(iv_enc, 0x3, sizeof(iv_enc));
1518 memset(iv_dec, 0x4, sizeof(iv_dec));
1519
1520 /*
1521 * Setup transforms
1522 */
1523
1524#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1525 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1526 t_out->encrypt_then_mac = etm;
1527 t_in->encrypt_then_mac = etm;
1528#else
1529 ((void) etm);
1530#endif
1531
1532 t_out->tls_version = tls_version;
1533 t_in->tls_version = tls_version;
1534 t_out->ivlen = ivlen;
1535 t_in->ivlen = ivlen;
1536
Valerio Setti31ad3a12023-10-27 11:55:02 +02001537 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001538 case MBEDTLS_MODE_GCM:
1539 case MBEDTLS_MODE_CCM:
1540#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1541 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1542 t_out->fixed_ivlen = 12;
1543 t_in->fixed_ivlen = 12;
1544 } else
1545#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1546 {
1547 t_out->fixed_ivlen = 4;
1548 t_in->fixed_ivlen = 4;
1549 }
1550 t_out->maclen = 0;
1551 t_in->maclen = 0;
1552 switch (tag_mode) {
1553 case 0: /* Full tag */
1554 t_out->taglen = 16;
1555 t_in->taglen = 16;
1556 break;
1557 case 1: /* Partial tag */
1558 t_out->taglen = 8;
1559 t_in->taglen = 8;
1560 break;
1561 default:
1562 ret = 1;
1563 goto cleanup;
1564 }
1565 break;
1566
1567 case MBEDTLS_MODE_CHACHAPOLY:
1568 t_out->fixed_ivlen = 12;
1569 t_in->fixed_ivlen = 12;
1570 t_out->maclen = 0;
1571 t_in->maclen = 0;
1572 switch (tag_mode) {
1573 case 0: /* Full tag */
1574 t_out->taglen = 16;
1575 t_in->taglen = 16;
1576 break;
1577 case 1: /* Partial tag */
1578 t_out->taglen = 8;
1579 t_in->taglen = 8;
1580 break;
1581 default:
1582 ret = 1;
1583 goto cleanup;
1584 }
1585 break;
1586
1587 case MBEDTLS_MODE_STREAM:
1588 case MBEDTLS_MODE_CBC:
1589 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1590 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1591 t_out->taglen = 0;
1592 t_in->taglen = 0;
1593 switch (tag_mode) {
1594 case 0: /* Full tag */
1595 t_out->maclen = maclen;
1596 t_in->maclen = maclen;
1597 break;
1598 default:
1599 ret = 1;
1600 goto cleanup;
1601 }
1602 break;
1603 default:
1604 ret = 1;
1605 goto cleanup;
1606 break;
1607 }
1608
1609 /* Setup IV's */
1610
1611 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1612 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1613 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1614 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1615
1616#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1617 /* Add CID */
1618 memcpy(&t_in->in_cid, cid0, cid0_len);
1619 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001620 t_in->in_cid_len = (uint8_t) cid0_len;
1621 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001622 memcpy(&t_out->in_cid, cid1, cid1_len);
1623 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001624 t_out->in_cid_len = (uint8_t) cid1_len;
1625 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001626#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1627
1628#if defined(MBEDTLS_USE_PSA_CRYPTO)
1629 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1630 t_in->taglen,
1631 &alg,
1632 &key_type,
1633 &key_bits);
1634
1635 if (status != PSA_SUCCESS) {
1636 ret = PSA_TO_MBEDTLS_ERR(status);
1637 goto cleanup;
1638 }
1639
1640 t_in->psa_alg = alg;
1641 t_out->psa_alg = alg;
1642
1643 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1644 psa_reset_key_attributes(&attributes);
1645 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1646 psa_set_key_algorithm(&attributes, alg);
1647 psa_set_key_type(&attributes, key_type);
1648
1649 status = psa_import_key(&attributes,
1650 key0,
1651 PSA_BITS_TO_BYTES(key_bits),
1652 &t_in->psa_key_enc);
1653
1654 if (status != PSA_SUCCESS) {
1655 ret = PSA_TO_MBEDTLS_ERR(status);
1656 goto cleanup;
1657 }
1658
1659 status = psa_import_key(&attributes,
1660 key1,
1661 PSA_BITS_TO_BYTES(key_bits),
1662 &t_out->psa_key_enc);
1663
1664 if (status != PSA_SUCCESS) {
1665 ret = PSA_TO_MBEDTLS_ERR(status);
1666 goto cleanup;
1667 }
1668
1669 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1670
1671 status = psa_import_key(&attributes,
1672 key1,
1673 PSA_BITS_TO_BYTES(key_bits),
1674 &t_in->psa_key_dec);
1675
1676 if (status != PSA_SUCCESS) {
1677 ret = PSA_TO_MBEDTLS_ERR(status);
1678 goto cleanup;
1679 }
1680
1681 status = psa_import_key(&attributes,
1682 key0,
1683 PSA_BITS_TO_BYTES(key_bits),
1684 &t_out->psa_key_dec);
1685
1686 if (status != PSA_SUCCESS) {
1687 ret = PSA_TO_MBEDTLS_ERR(status);
1688 goto cleanup;
1689 }
1690 }
1691#endif /* MBEDTLS_USE_PSA_CRYPTO */
1692
1693cleanup:
1694
1695 mbedtls_free(key0);
1696 mbedtls_free(key1);
1697
1698 mbedtls_free(md0);
1699 mbedtls_free(md1);
1700
1701 return ret;
1702}
1703
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001704#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1705int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1706 mbedtls_ssl_transform *transform_out)
1707{
1708#if defined(MBEDTLS_USE_PSA_CRYPTO)
1709 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1710#endif
1711
1712 /* Serialized version of record header for MAC purposes */
1713 unsigned char add_data[13];
1714 memcpy(add_data, record->ctr, 8);
1715 add_data[8] = record->type;
1716 add_data[9] = record->ver[0];
1717 add_data[10] = record->ver[1];
1718 add_data[11] = (record->data_len >> 8) & 0xff;
1719 add_data[12] = (record->data_len >> 0) & 0xff;
1720
1721 /* MAC with additional data */
1722#if defined(MBEDTLS_USE_PSA_CRYPTO)
1723 size_t sign_mac_length = 0;
1724 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1725 transform_out->psa_mac_enc,
1726 transform_out->psa_mac_alg));
1727 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1728 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1729 record->buf + record->data_offset,
1730 record->data_len));
1731 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1732 * extension, there might not be enough room in the record for the
1733 * full-length MAC. */
1734 unsigned char mac[PSA_HASH_MAX_SIZE];
1735 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1736 mac, sizeof(mac),
1737 &sign_mac_length));
1738#else
1739 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1740 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1741 record->buf + record->data_offset,
1742 record->data_len));
1743 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1744 * extension, there might not be enough room in the record for the
1745 * full-length MAC. */
1746 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1747 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1748#endif
1749 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1750 record->data_len += transform_out->maclen;
1751
1752 return 0;
1753
1754exit:
1755#if defined(MBEDTLS_USE_PSA_CRYPTO)
1756 psa_mac_abort(&operation);
1757#endif
1758 return -1;
1759}
1760#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1761
Jerry Yu28547c42023-10-31 14:42:50 +08001762#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001763int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1764 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001765 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001766 const char *crt_file)
1767{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001768 (void) ticket_len;
1769
Yanray Wange6afd912022-10-27 12:11:18 +08001770#if defined(MBEDTLS_HAVE_TIME)
1771 session->start = mbedtls_time(NULL) - 42;
1772#endif
1773 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001774
1775 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1776 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1777
1778 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001779 session->ciphersuite = 0xabcd;
1780 session->id_len = sizeof(session->id);
1781 memset(session->id, 66, session->id_len);
1782 memset(session->master, 17, sizeof(session->master));
1783
1784#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1785 if (crt_file != NULL && strlen(crt_file) != 0) {
1786 mbedtls_x509_crt tmp_crt;
1787 int ret;
1788
1789 mbedtls_x509_crt_init(&tmp_crt);
1790 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1791 if (ret != 0) {
1792 return ret;
1793 }
1794
1795#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1796 /* Move temporary CRT. */
1797 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1798 if (session->peer_cert == NULL) {
1799 return -1;
1800 }
1801 *session->peer_cert = tmp_crt;
1802 memset(&tmp_crt, 0, sizeof(tmp_crt));
1803#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1804 /* Calculate digest of temporary CRT. */
1805 session->peer_cert_digest =
1806 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1807 if (session->peer_cert_digest == NULL) {
1808 return -1;
1809 }
1810
1811#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001812 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001813 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1814 size_t hash_size = 0;
1815 psa_status_t status = psa_hash_compute(
1816 psa_alg, tmp_crt.raw.p,
1817 tmp_crt.raw.len,
1818 session->peer_cert_digest,
1819 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1820 &hash_size);
1821 ret = PSA_TO_MBEDTLS_ERR(status);
1822#else
1823 ret = mbedtls_md(mbedtls_md_info_from_type(
1824 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1825 tmp_crt.raw.p, tmp_crt.raw.len,
1826 session->peer_cert_digest);
1827#endif /* MBEDTLS_USE_PSA_CRYPTO */
1828 if (ret != 0) {
1829 return ret;
1830 }
1831 session->peer_cert_digest_type =
1832 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1833 session->peer_cert_digest_len =
1834 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1835#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1836
1837 mbedtls_x509_crt_free(&tmp_crt);
1838 }
1839#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1840 (void) crt_file;
1841#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1842 session->verify_result = 0xdeadbeef;
1843
Ronald Cronc57f86e2023-11-22 09:50:01 +01001844#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1845#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001846 if (ticket_len != 0) {
1847 session->ticket = mbedtls_calloc(1, ticket_len);
1848 if (session->ticket == NULL) {
1849 return -1;
1850 }
1851 memset(session->ticket, 33, ticket_len);
1852 }
1853 session->ticket_len = ticket_len;
1854 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001855#endif /* MBEDTLS_SSL_CLI_C */
1856
1857#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1858 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1859 session->ticket_creation_time = mbedtls_ms_time() - 42;
1860 }
Yanray Wange6afd912022-10-27 12:11:18 +08001861#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001862#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001863
1864#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1865 session->mfl_code = 1;
1866#endif
1867#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1868 session->encrypt_then_mac = 1;
1869#endif
1870
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001871exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001872 return 0;
1873}
Jerry Yu28547c42023-10-31 14:42:50 +08001874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001875
1876#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1877int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1878 int ticket_len,
1879 int endpoint_type)
1880{
1881 ((void) ticket_len);
1882 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1883 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1884 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1885 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001886
1887#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001888 session->ticket_age_add = 0x87654321;
1889 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001890 session->resumption_key_len = 32;
1891 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001892#endif
1893
Ronald Cron18b92a12024-03-26 10:15:08 +01001894#if defined(MBEDTLS_SSL_SRV_C)
1895 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1896#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1897#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1898 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1899 if (ret != 0) {
1900 return -1;
1901 }
1902#endif
1903#if defined(MBEDTLS_HAVE_TIME)
1904 session->ticket_creation_time = mbedtls_ms_time() - 42;
1905#endif
1906#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1907 }
1908#endif /* MBEDTLS_SSL_SRV_C */
1909
Yanray Wange6afd912022-10-27 12:11:18 +08001910#if defined(MBEDTLS_SSL_CLI_C)
1911 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001912#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001913#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001914 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001915#endif
1916 session->ticket_lifetime = 0xfedcba98;
1917
1918 session->ticket_len = ticket_len;
1919 if (ticket_len != 0) {
1920 session->ticket = mbedtls_calloc(1, ticket_len);
1921 if (session->ticket == NULL) {
1922 return -1;
1923 }
1924 memset(session->ticket, 33, ticket_len);
1925 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001926#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1927 char hostname[] = "hostname example";
1928 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1929 if (session->hostname == NULL) {
1930 return -1;
1931 }
1932 memcpy(session->hostname, hostname, sizeof(hostname));
1933#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001934#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001935 }
1936#endif /* MBEDTLS_SSL_CLI_C */
1937
Ronald Cron18b92a12024-03-26 10:15:08 +01001938#if defined(MBEDTLS_SSL_EARLY_DATA)
1939 session->max_early_data_size = 0x87654321;
1940#endif /* MBEDTLS_SSL_EARLY_DATA */
1941
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001942#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1943 session->record_size_limit = 2048;
1944#endif
1945
Yanray Wange6afd912022-10-27 12:11:18 +08001946 return 0;
1947}
1948#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1949
Yanray Wangb088bfc2023-03-16 12:15:49 +08001950int mbedtls_test_ssl_exchange_data(
1951 mbedtls_ssl_context *ssl_1,
1952 int msg_len_1, const int expected_fragments_1,
1953 mbedtls_ssl_context *ssl_2,
1954 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001955{
1956 unsigned char *msg_buf_1 = malloc(msg_len_1);
1957 unsigned char *msg_buf_2 = malloc(msg_len_2);
1958 unsigned char *in_buf_1 = malloc(msg_len_2);
1959 unsigned char *in_buf_2 = malloc(msg_len_1);
1960 int msg_type, ret = -1;
1961
1962 /* Perform this test with two message types. At first use a message
1963 * consisting of only 0x00 for the client and only 0xFF for the server.
1964 * At the second time use message with generated data */
1965 for (msg_type = 0; msg_type < 2; msg_type++) {
1966 int written_1 = 0;
1967 int written_2 = 0;
1968 int read_1 = 0;
1969 int read_2 = 0;
1970 int fragments_1 = 0;
1971 int fragments_2 = 0;
1972
1973 if (msg_type == 0) {
1974 memset(msg_buf_1, 0x00, msg_len_1);
1975 memset(msg_buf_2, 0xff, msg_len_2);
1976 } else {
1977 int i, j = 0;
1978 for (i = 0; i < msg_len_1; i++) {
1979 msg_buf_1[i] = j++ & 0xFF;
1980 }
1981 for (i = 0; i < msg_len_2; i++) {
1982 msg_buf_2[i] = (j -= 5) & 0xFF;
1983 }
1984 }
1985
1986 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
1987 /* ssl_1 sending */
1988 if (msg_len_1 > written_1) {
1989 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
1990 msg_len_1, &written_1,
1991 expected_fragments_1);
1992 if (expected_fragments_1 == 0) {
1993 /* This error is expected when the message is too large and
1994 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001995 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001996 msg_len_1 = 0;
1997 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001998 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001999 }
2000 }
2001
2002 /* ssl_2 sending */
2003 if (msg_len_2 > written_2) {
2004 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
2005 msg_len_2, &written_2,
2006 expected_fragments_2);
2007 if (expected_fragments_2 == 0) {
2008 /* This error is expected when the message is too large and
2009 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02002010 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08002011 msg_len_2 = 0;
2012 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002013 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002014 }
2015 }
2016
2017 /* ssl_1 reading */
2018 if (read_1 < msg_len_2) {
2019 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
2020 msg_len_2, &read_1,
2021 &fragments_2,
2022 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002023 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002024 }
2025
2026 /* ssl_2 reading */
2027 if (read_2 < msg_len_1) {
2028 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
2029 msg_len_1, &read_2,
2030 &fragments_1,
2031 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02002032 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002033 }
2034 }
2035
2036 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02002037 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
2038 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
2039 TEST_EQUAL(fragments_1, expected_fragments_1);
2040 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08002041 }
2042
2043 ret = 0;
2044
2045exit:
2046 free(msg_buf_1);
2047 free(in_buf_1);
2048 free(msg_buf_2);
2049 free(in_buf_2);
2050
2051 return ret;
2052}
2053
2054/*
2055 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
2056 * must be initialized and connected beforehand.
2057 *
2058 * \retval 0 on success, otherwise error code.
2059 */
Yanray Wangead70c82023-03-16 12:04:49 +08002060#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
2061 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
2062 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
2063static int exchange_data(mbedtls_ssl_context *ssl_1,
2064 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08002065{
Yanray Wangb088bfc2023-03-16 12:15:49 +08002066 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
2067 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002068}
Yanray Wangead70c82023-03-16 12:04:49 +08002069#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
2070 (MBEDTLS_SSL_RENEGOTIATION ||
2071 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002072
2073#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2074static int check_ssl_version(
2075 mbedtls_ssl_protocol_version expected_negotiated_version,
Gilles Peskinebd953402025-05-28 15:20:28 +02002076 const mbedtls_ssl_context *client,
2077 const mbedtls_ssl_context *server)
Yanray Wange6afd912022-10-27 12:11:18 +08002078{
Gilles Peskinebd953402025-05-28 15:20:28 +02002079 /* First check that both sides have chosen the same version.
2080 * If so, we can make more sanity checks just on one side.
2081 * If not, something is deeply wrong. */
2082 TEST_EQUAL(client->tls_version, server->tls_version);
2083
2084 /* Make further checks on the client to validate that the
2085 * reported data about the version is correct. */
2086 const char *version_string = mbedtls_ssl_get_version(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002087 mbedtls_ssl_protocol_version version_number =
Gilles Peskinebd953402025-05-28 15:20:28 +02002088 mbedtls_ssl_get_version_number(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002089
Gilles Peskinebd953402025-05-28 15:20:28 +02002090 TEST_EQUAL(client->tls_version, expected_negotiated_version);
Yanray Wange6afd912022-10-27 12:11:18 +08002091
Gilles Peskinebd953402025-05-28 15:20:28 +02002092 if (client->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08002093 TEST_EQUAL(version_string[0], 'D');
2094 ++version_string;
2095 }
2096
2097 switch (expected_negotiated_version) {
2098 case MBEDTLS_SSL_VERSION_TLS1_2:
2099 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002100 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002101 break;
2102
2103 case MBEDTLS_SSL_VERSION_TLS1_3:
2104 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002105 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002106 break;
2107
2108 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002109 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002110 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002111 }
2112
2113 return 1;
2114
2115exit:
2116 return 0;
2117}
2118#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2119
Yanray Wange6afd912022-10-27 12:11:18 +08002120#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002121int mbedtls_test_ssl_do_handshake_with_endpoints(
2122 mbedtls_test_ssl_endpoint *server_ep,
2123 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002124 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002125 mbedtls_ssl_protocol_version proto)
2126{
2127 enum { BUFFSIZE = 1024 };
2128
2129 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002130
Max Fillingeree467aa2024-11-08 22:17:33 +01002131 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2132 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2133
Max Fillinger8f12e312024-10-30 00:29:37 +01002134 mbedtls_test_init_handshake_options(options);
2135 options->server_min_version = proto;
2136 options->client_min_version = proto;
2137 options->server_max_version = proto;
2138 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002139
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002140 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002141 if (ret != 0) {
2142 return ret;
2143 }
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002144 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002145 if (ret != 0) {
2146 return ret;
2147 }
2148
2149 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2150 if (ret != 0) {
2151 return ret;
2152 }
2153
Max Fillingerea1e7772024-10-30 00:49:10 +01002154 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2155 &client_ep->ssl,
2156 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002157 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2158 return ret;
2159 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002160 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2161 &server_ep->ssl,
2162 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002163 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2164 return ret;
2165 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002166 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2167 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002168 return -1;
2169 }
2170
2171 return 0;
2172}
2173#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2174
2175#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine78df6ae2025-05-27 21:14:25 +02002176
2177#if defined(MBEDTLS_SSL_RENEGOTIATION)
2178static int test_renegotiation(const mbedtls_test_handshake_test_options *options,
2179 mbedtls_test_ssl_endpoint *client,
2180 mbedtls_test_ssl_endpoint *server)
2181{
2182 int ok = 0;
2183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2184
2185 (void) options; // only used in some configurations
2186
2187 /* Start test with renegotiation */
2188 TEST_EQUAL(server->ssl.renego_status,
2189 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2190 TEST_EQUAL(client->ssl.renego_status,
2191 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2192
2193 /* After calling this function for the server, it only sends a handshake
2194 * request. All renegotiation should happen during data exchanging */
2195 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server->ssl)), 0);
2196 TEST_EQUAL(server->ssl.renego_status,
2197 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2198 TEST_EQUAL(client->ssl.renego_status,
2199 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2200
2201 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2202 TEST_EQUAL(server->ssl.renego_status,
2203 MBEDTLS_SSL_RENEGOTIATION_DONE);
2204 TEST_EQUAL(client->ssl.renego_status,
2205 MBEDTLS_SSL_RENEGOTIATION_DONE);
2206
2207 /* After calling mbedtls_ssl_renegotiate for the client,
2208 * all renegotiation should happen inside this function.
2209 * However in this test, we cannot perform simultaneous communication
2210 * between client and server so this function will return waiting error
2211 * on the socket. All rest of renegotiation should happen
2212 * during data exchanging */
2213 ret = mbedtls_ssl_renegotiate(&(client->ssl));
2214#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2215 if (options->resize_buffers != 0) {
2216 /* Ensure that the buffer sizes are appropriate before resizes */
2217 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2218 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2219 }
2220#endif
2221 TEST_ASSERT(ret == 0 ||
2222 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2223 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
2224 TEST_EQUAL(server->ssl.renego_status,
2225 MBEDTLS_SSL_RENEGOTIATION_DONE);
2226 TEST_EQUAL(client->ssl.renego_status,
2227 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
2228
2229 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2230 TEST_EQUAL(server->ssl.renego_status,
2231 MBEDTLS_SSL_RENEGOTIATION_DONE);
2232 TEST_EQUAL(client->ssl.renego_status,
2233 MBEDTLS_SSL_RENEGOTIATION_DONE);
2234#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2235 /* Validate buffer sizes after renegotiation */
2236 if (options->resize_buffers != 0) {
2237 TEST_EQUAL(client->ssl.out_buf_len,
2238 mbedtls_ssl_get_output_buflen(&client->ssl));
2239 TEST_EQUAL(client->ssl.in_buf_len,
2240 mbedtls_ssl_get_input_buflen(&client->ssl));
2241 TEST_EQUAL(server->ssl.out_buf_len,
2242 mbedtls_ssl_get_output_buflen(&server->ssl));
2243 TEST_EQUAL(server->ssl.in_buf_len,
2244 mbedtls_ssl_get_input_buflen(&server->ssl));
2245 }
2246#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2247
2248 ok = 1;
2249
2250exit:
2251 return ok;
2252}
2253#endif /* MBEDTLS_SSL_RENEGOTIATION */
2254
Gilles Peskinee23a6d12025-05-27 21:17:09 +02002255#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2256static int test_serialization(const mbedtls_test_handshake_test_options *options,
2257 mbedtls_test_ssl_endpoint *client,
2258 mbedtls_test_ssl_endpoint *server)
2259{
2260 int ok = 0;
2261 unsigned char *context_buf = NULL;
2262 size_t context_buf_len;
2263
2264 TEST_EQUAL(options->dtls, 1);
2265
2266 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), NULL,
2267 0, &context_buf_len),
2268 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
2269
2270 context_buf = mbedtls_calloc(1, context_buf_len);
2271 TEST_ASSERT(context_buf != NULL);
2272
2273 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), context_buf,
2274 context_buf_len,
2275 &context_buf_len),
2276 0);
2277
2278 mbedtls_ssl_free(&(server->ssl));
2279 mbedtls_ssl_init(&(server->ssl));
2280
2281 TEST_EQUAL(mbedtls_ssl_setup(&(server->ssl), &(server->conf)), 0);
2282
2283 mbedtls_ssl_set_bio(&(server->ssl), &server->dtls_context,
2284 mbedtls_test_mock_tcp_send_msg,
2285 mbedtls_test_mock_tcp_recv_msg,
2286 NULL);
2287
2288 mbedtls_ssl_set_user_data_p(&server->ssl, server);
2289
2290#if defined(MBEDTLS_TIMING_C)
2291 mbedtls_ssl_set_timer_cb(&server->ssl, &server->timer,
2292 mbedtls_timing_set_delay,
2293 mbedtls_timing_get_delay);
2294#endif
2295#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2296 if (options->resize_buffers != 0) {
2297 /* Ensure that the buffer sizes are appropriate before resizes */
2298 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2299 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2300 }
2301#endif
2302 TEST_EQUAL(mbedtls_ssl_context_load(&(server->ssl), context_buf,
2303 context_buf_len), 0);
2304
2305#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2306 /* Validate buffer sizes after context deserialization */
2307 if (options->resize_buffers != 0) {
2308 TEST_EQUAL(server->ssl.out_buf_len,
2309 mbedtls_ssl_get_output_buflen(&server->ssl));
2310 TEST_EQUAL(server->ssl.in_buf_len,
2311 mbedtls_ssl_get_input_buflen(&server->ssl));
2312 }
2313#endif
2314 /* Retest writing/reading */
2315 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2316 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2317 &(client->ssl), options->cli_msg_len,
2318 options->expected_cli_fragments,
2319 &(server->ssl), options->srv_msg_len,
2320 options->expected_srv_fragments),
2321 0);
2322 }
2323
2324 ok = 1;
2325
2326exit:
2327 mbedtls_free(context_buf);
2328 return ok;
2329}
2330#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2331
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002332int mbedtls_test_ssl_perform_connection(
2333 const mbedtls_test_handshake_test_options *options,
2334 mbedtls_test_ssl_endpoint *client,
2335 mbedtls_test_ssl_endpoint *server)
2336{
2337 enum { BUFFSIZE = 17000 };
2338 int expected_handshake_result = options->expected_handshake_result;
2339 int ok = 0;
2340
2341 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client->socket),
2342 &(server->socket),
2343 BUFFSIZE), 0);
2344
2345#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2346 if (options->resize_buffers != 0) {
2347 /* Ensure that the buffer sizes are appropriate before resizes */
2348 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2349 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2350 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2351 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2352 }
2353#endif
2354
2355 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2356 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2357 }
2358
2359 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client->ssl),
2360 &(server->ssl),
2361 MBEDTLS_SSL_HANDSHAKE_OVER),
2362 expected_handshake_result);
2363
2364 if (expected_handshake_result != 0) {
2365 /* Connection will have failed by this point, skip to cleanup */
2366 ok = 1;
2367 goto exit;
2368 }
2369
2370 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client->ssl), 1);
2371
2372 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2373 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server->ssl),
2374 &(client->ssl),
2375 MBEDTLS_SSL_HANDSHAKE_OVER),
2376 0);
2377
2378 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server->ssl), 1);
2379
2380 /* Check that both sides have negotiated the expected version. */
2381 TEST_ASSERT(check_ssl_version(options->expected_negotiated_version,
2382 &client->ssl,
2383 &server->ssl));
2384
2385 if (options->expected_ciphersuite != 0) {
2386 TEST_EQUAL(server->ssl.session->ciphersuite,
2387 options->expected_ciphersuite);
2388 }
2389
2390#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2391 if (options->resize_buffers != 0) {
2392 /* A server, when using DTLS, might delay a buffer resize to happen
2393 * after it receives a message, so we force it. */
2394 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2395
2396 TEST_EQUAL(client->ssl.out_buf_len,
2397 mbedtls_ssl_get_output_buflen(&client->ssl));
2398 TEST_EQUAL(client->ssl.in_buf_len,
2399 mbedtls_ssl_get_input_buflen(&client->ssl));
2400 TEST_EQUAL(server->ssl.out_buf_len,
2401 mbedtls_ssl_get_output_buflen(&server->ssl));
2402 TEST_EQUAL(server->ssl.in_buf_len,
2403 mbedtls_ssl_get_input_buflen(&server->ssl));
2404 }
2405#endif
2406
2407 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2408 /* Start data exchanging test */
2409 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2410 &(client->ssl), options->cli_msg_len,
2411 options->expected_cli_fragments,
2412 &(server->ssl), options->srv_msg_len,
2413 options->expected_srv_fragments),
2414 0);
2415 }
2416#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2417 if (options->serialize == 1) {
2418 TEST_ASSERT(test_serialization(options, client, server));
2419 }
2420#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2421
2422#if defined(MBEDTLS_SSL_RENEGOTIATION)
2423 if (options->renegotiate) {
2424 TEST_ASSERT(test_renegotiation(options, client, server));
2425 }
2426#endif /* MBEDTLS_SSL_RENEGOTIATION */
2427
2428 ok = 1;
2429
2430exit:
2431 return ok;
2432}
2433
Yanray Wange6afd912022-10-27 12:11:18 +08002434void mbedtls_test_ssl_perform_handshake(
Gilles Peskine9b993682025-05-27 18:44:12 +02002435 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +08002436{
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002437 mbedtls_test_ssl_endpoint client_struct;
2438 memset(&client_struct, 0, sizeof(client_struct));
2439 mbedtls_test_ssl_endpoint *const client = &client_struct;
2440 mbedtls_test_ssl_endpoint server_struct;
2441 memset(&server_struct, 0, sizeof(server_struct));
2442 mbedtls_test_ssl_endpoint *const server = &server_struct;
Yanray Wange6afd912022-10-27 12:11:18 +08002443
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002444 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002445
Ronald Cronec3408d2024-01-16 17:50:40 +01002446#if defined(MBEDTLS_DEBUG_C)
2447 if (options->cli_log_fun || options->srv_log_fun) {
2448 mbedtls_debug_set_threshold(4);
2449 }
2450#endif
2451
Yanray Wange6afd912022-10-27 12:11:18 +08002452 /* Client side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002453 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(client,
Gilles Peskine07432b92025-05-27 21:07:44 +02002454 MBEDTLS_SSL_IS_CLIENT,
2455 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002456
Yanray Wange6afd912022-10-27 12:11:18 +08002457 /* Server side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002458 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(server,
Gilles Peskine07432b92025-05-27 21:07:44 +02002459 MBEDTLS_SSL_IS_SERVER,
2460 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002461
Gilles Peskineb092e782025-05-27 20:15:03 +02002462 if (options->dtls) {
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002463 TEST_EQUAL(mbedtls_test_ssl_dtls_join_endpoints(client, server), 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02002464 }
2465
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002466 TEST_ASSERT(mbedtls_test_ssl_perform_connection(options, client, server));
Yanray Wange6afd912022-10-27 12:11:18 +08002467
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002468 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client->conf) == client);
2469 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client->ssl) == client);
2470 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server->conf) == server);
2471 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server->ssl) == server);
Yanray Wange6afd912022-10-27 12:11:18 +08002472
2473exit:
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002474 mbedtls_test_ssl_endpoint_free(client);
2475 mbedtls_test_ssl_endpoint_free(server);
Yanray Wange6afd912022-10-27 12:11:18 +08002476#if defined(MBEDTLS_DEBUG_C)
2477 if (options->cli_log_fun || options->srv_log_fun) {
2478 mbedtls_debug_set_threshold(0);
2479 }
2480#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002481 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002482}
2483#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2484
2485#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002486int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002487 unsigned char *buf, unsigned char **end, int tweak,
2488 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2489{
2490/*
2491 * The definition of the tweaks assume that the certificate list contains only
2492 * one certificate.
2493 */
2494
2495/*
2496 * struct {
2497 * opaque cert_data<1..2^24-1>;
2498 * Extension extensions<0..2^16-1>;
2499 * } CertificateEntry;
2500 *
2501 * struct {
2502 * opaque certificate_request_context<0..2^8-1>;
2503 * CertificateEntry certificate_list<0..2^24-1>;
2504 * } Certificate;
2505 */
2506 unsigned char *p_certificate_request_context_len = buf;
2507 size_t certificate_request_context_len = buf[0];
2508
2509 unsigned char *p_certificate_list_len =
2510 buf + 1 + certificate_request_context_len;
2511 unsigned char *certificate_list = p_certificate_list_len + 3;
2512 size_t certificate_list_len =
2513 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2514
2515 unsigned char *p_cert_data_len = certificate_list;
2516 unsigned char *cert_data = p_cert_data_len + 3;
2517 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2518
2519 unsigned char *p_extensions_len = cert_data + cert_data_len;
2520 unsigned char *extensions = p_extensions_len + 2;
2521 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2522
2523 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2524
2525 switch (tweak) {
2526 case 1:
2527 /* Failure when checking if the certificate request context length
2528 * and certificate list length can be read
2529 */
2530 *end = buf + 3;
2531 set_chk_buf_ptr_args(args, buf, *end, 4);
2532 break;
2533
2534 case 2:
2535 /* Invalid certificate request context length.
2536 */
2537 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002538 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002539 reset_chk_buf_ptr_args(args);
2540 break;
2541
2542 case 3:
2543 /* Failure when checking if certificate_list data can be read. */
2544 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2545 p_certificate_list_len, 0);
2546 set_chk_buf_ptr_args(args, certificate_list, *end,
2547 certificate_list_len + 1);
2548 break;
2549
2550 case 4:
2551 /* Failure when checking if the cert_data length can be read. */
2552 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2553 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2554 break;
2555
2556 case 5:
2557 /* Failure when checking if cert_data data can be read. */
2558 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2559 p_cert_data_len, 0);
2560 set_chk_buf_ptr_args(args, cert_data,
2561 certificate_list + certificate_list_len,
2562 certificate_list_len - 3 + 1);
2563 break;
2564
2565 case 6:
2566 /* Failure when checking if the extensions length can be read. */
2567 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2568 p_certificate_list_len, 0);
2569 set_chk_buf_ptr_args(
2570 args, p_extensions_len,
2571 certificate_list + certificate_list_len - extensions_len - 1, 2);
2572 break;
2573
2574 case 7:
2575 /* Failure when checking if extensions data can be read. */
2576 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2577
2578 set_chk_buf_ptr_args(
2579 args, extensions,
2580 certificate_list + certificate_list_len, extensions_len + 1);
2581 break;
2582
2583 default:
2584 return -1;
2585 }
2586
2587 return 0;
2588}
2589#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002590
Ronald Cronfaf026c2024-01-31 14:32:06 +01002591/*
2592 * Functions for tests based on tickets. Implementations of the
2593 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2594 * Basically same implementations as in ticket.c without the encryption. That
2595 * way we can tweak easily tickets characteristics to simulate misbehaving
2596 * peers.
2597 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002598#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2599int mbedtls_test_ticket_write(
2600 void *p_ticket, const mbedtls_ssl_session *session,
2601 unsigned char *start, const unsigned char *end,
2602 size_t *tlen, uint32_t *lifetime)
2603{
2604 int ret;
2605 ((void) p_ticket);
2606
2607 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2608 tlen)) != 0) {
2609 return ret;
2610 }
2611
2612 /* Maximum ticket lifetime as defined in RFC 8446 */
2613 *lifetime = 7 * 24 * 3600;
2614
2615 return 0;
2616}
2617
2618int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2619 unsigned char *buf, size_t len)
2620{
2621 ((void) p_ticket);
2622
2623 return mbedtls_ssl_session_load(session, buf, len);
2624}
2625#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002626
2627#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2628 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2629 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2630int mbedtls_test_get_tls13_ticket(
2631 mbedtls_test_handshake_test_options *client_options,
2632 mbedtls_test_handshake_test_options *server_options,
2633 mbedtls_ssl_session *session)
2634{
2635 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002636 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002637 unsigned char buf[64];
2638 mbedtls_test_ssl_endpoint client_ep, server_ep;
2639
2640 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2641 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2642
2643 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002644 client_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002645 TEST_EQUAL(ret, 0);
2646
2647 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002648 server_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002649 TEST_EQUAL(ret, 0);
2650
2651 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2652 mbedtls_test_ticket_write,
2653 mbedtls_test_ticket_parse,
2654 NULL);
2655
2656 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2657 &(server_ep.socket), 1024);
2658 TEST_EQUAL(ret, 0);
2659
2660 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2661 &(server_ep.ssl), &(client_ep.ssl),
2662 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2663
2664 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2665
2666 do {
2667 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2668 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2669
2670 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2671 TEST_EQUAL(ret, 0);
2672
Gilles Peskine946bf142025-04-08 09:48:40 +02002673 ok = 1;
2674
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002675exit:
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002676 mbedtls_test_ssl_endpoint_free(&client_ep);
2677 mbedtls_test_ssl_endpoint_free(&server_ep);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002678
Gilles Peskine946bf142025-04-08 09:48:40 +02002679 if (ret == 0 && !ok) {
2680 /* Exiting due to a test assertion that isn't ret == 0 */
2681 ret = -1;
2682 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002683 return ret;
2684}
2685#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2686 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2687 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2688
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002689#endif /* MBEDTLS_SSL_TLS_C */