blob: 1eca6e496d88479136536e4de2df4181cf74ccfb [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
Gilles Peskine1819a912025-07-22 21:54:50 +020014#include <limits.h>
15
Yanray Wang4d07d1c2022-10-27 15:28:16 +080016#if defined(MBEDTLS_SSL_TLS_C)
Ronald Cron10b040f2024-02-05 09:38:09 +010017int mbedtls_test_random(void *p_rng, unsigned char *output, size_t output_len)
Yanray Wange6afd912022-10-27 12:11:18 +080018{
19 (void) p_rng;
20 for (size_t i = 0; i < output_len; i++) {
21 output[i] = rand();
22 }
23
24 return 0;
25}
Yanray Wange6afd912022-10-27 12:11:18 +080026
Yanray Wange6afd912022-10-27 12:11:18 +080027void mbedtls_test_ssl_log_analyzer(void *ctx, int level,
28 const char *file, int line,
29 const char *str)
30{
31 mbedtls_test_ssl_log_pattern *p = (mbedtls_test_ssl_log_pattern *) ctx;
32
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010033/* Change 0 to 1 for debugging of test cases that use this function. */
34#if 0
35 const char *q, *basename;
36 /* Extract basename from file */
37 for (q = basename = file; *q != '\0'; q++) {
38 if (*q == '/' || *q == '\\') {
39 basename = q + 1;
40 }
41 }
42 printf("%s:%04d: |%d| %s",
43 basename, line, level, str);
44#else
Yanray Wange6afd912022-10-27 12:11:18 +080045 (void) level;
46 (void) line;
47 (void) file;
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010048#endif
Yanray Wange6afd912022-10-27 12:11:18 +080049
50 if (NULL != p &&
51 NULL != p->pattern &&
52 NULL != strstr(str, p->pattern)) {
53 p->counter++;
54 }
55}
56
57void mbedtls_test_init_handshake_options(
58 mbedtls_test_handshake_test_options *opts)
59{
60#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron987cf892024-03-04 10:24:27 +010061 static int rng_seed = 0xBEEF;
Yanray Wanga72bc9a2023-12-01 23:34:27 +080062
Yanray Wange6afd912022-10-27 12:11:18 +080063 srand(rng_seed);
64 rng_seed += 0xD0;
65#endif
Ronald Cronb4ad3e72024-01-26 14:57:53 +010066
67 memset(opts, 0, sizeof(*opts));
68
Yanray Wange6afd912022-10-27 12:11:18 +080069 opts->cipher = "";
70 opts->client_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
71 opts->client_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
72 opts->server_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
73 opts->server_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
Ronald Cron097ba142023-03-08 16:18:00 +010074 opts->expected_negotiated_version = MBEDTLS_SSL_VERSION_TLS1_3;
Yanray Wange6afd912022-10-27 12:11:18 +080075 opts->pk_alg = MBEDTLS_PK_RSA;
Gilles Peskinefb2ce052025-05-28 17:36:12 +020076 opts->srv_auth_mode = MBEDTLS_SSL_VERIFY_REQUIRED;
Yanray Wange6afd912022-10-27 12:11:18 +080077 opts->mfl = MBEDTLS_SSL_MAX_FRAG_LEN_NONE;
78 opts->cli_msg_len = 100;
79 opts->srv_msg_len = 100;
80 opts->expected_cli_fragments = 1;
81 opts->expected_srv_fragments = 1;
Yanray Wange6afd912022-10-27 12:11:18 +080082 opts->legacy_renegotiation = MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION;
Yanray Wange6afd912022-10-27 12:11:18 +080083 opts->resize_buffers = 1;
Ronald Cronced99be2024-01-26 15:49:12 +010084 opts->early_data = MBEDTLS_SSL_EARLY_DATA_DISABLED;
Ronald Cron5d3036e2024-02-23 07:43:45 +010085 opts->max_early_data_size = -1;
Yanray Wange6afd912022-10-27 12:11:18 +080086#if defined(MBEDTLS_SSL_CACHE_C)
Tom Cosgrove05b2a872023-07-21 11:31:13 +010087 TEST_CALLOC(opts->cache, 1);
Yanray Wange6afd912022-10-27 12:11:18 +080088 mbedtls_ssl_cache_init(opts->cache);
Pengyu Lv5cbb93e2023-07-10 11:09:40 +080089#if defined(MBEDTLS_HAVE_TIME)
90 TEST_EQUAL(mbedtls_ssl_cache_get_timeout(opts->cache),
91 MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT);
92#endif
Yanray Wange6afd912022-10-27 12:11:18 +080093exit:
94 return;
95#endif
96}
97
98void mbedtls_test_free_handshake_options(
99 mbedtls_test_handshake_test_options *opts)
100{
101#if defined(MBEDTLS_SSL_CACHE_C)
102 mbedtls_ssl_cache_free(opts->cache);
103 mbedtls_free(opts->cache);
104#else
105 (void) opts;
106#endif
107}
108
109#if defined(MBEDTLS_TEST_HOOKS)
110static void set_chk_buf_ptr_args(
111 mbedtls_ssl_chk_buf_ptr_args *args,
112 unsigned char *cur, unsigned char *end, size_t need)
113{
114 args->cur = cur;
115 args->end = end;
116 args->need = need;
117}
118
119static void reset_chk_buf_ptr_args(mbedtls_ssl_chk_buf_ptr_args *args)
120{
121 memset(args, 0, sizeof(*args));
122}
123#endif /* MBEDTLS_TEST_HOOKS */
124
Yanray Wange6afd912022-10-27 12:11:18 +0800125void mbedtls_test_ssl_buffer_init(mbedtls_test_ssl_buffer *buf)
126{
127 memset(buf, 0, sizeof(*buf));
128}
129
Yanray Wange6afd912022-10-27 12:11:18 +0800130int mbedtls_test_ssl_buffer_setup(mbedtls_test_ssl_buffer *buf,
131 size_t capacity)
132{
133 buf->buffer = (unsigned char *) mbedtls_calloc(capacity,
134 sizeof(unsigned char));
135 if (NULL == buf->buffer) {
136 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
137 }
138 buf->capacity = capacity;
139
140 return 0;
141}
142
143void mbedtls_test_ssl_buffer_free(mbedtls_test_ssl_buffer *buf)
144{
145 if (buf->buffer != NULL) {
146 mbedtls_free(buf->buffer);
147 }
148
149 memset(buf, 0, sizeof(*buf));
150}
151
Yanray Wange6afd912022-10-27 12:11:18 +0800152int mbedtls_test_ssl_buffer_put(mbedtls_test_ssl_buffer *buf,
153 const unsigned char *input, size_t input_len)
154{
155 size_t overflow = 0;
156
157 if ((buf == NULL) || (buf->buffer == NULL)) {
158 return -1;
159 }
160
161 /* Reduce input_len to a number that fits in the buffer. */
162 if ((buf->content_length + input_len) > buf->capacity) {
163 input_len = buf->capacity - buf->content_length;
164 }
165
166 if (input == NULL) {
167 return (input_len == 0) ? 0 : -1;
168 }
169
170 /* Check if the buffer has not come full circle and free space is not in
171 * the middle */
172 if (buf->start + buf->content_length < buf->capacity) {
173
174 /* Calculate the number of bytes that need to be placed at lower memory
175 * address */
176 if (buf->start + buf->content_length + input_len
177 > buf->capacity) {
178 overflow = (buf->start + buf->content_length + input_len)
179 % buf->capacity;
180 }
181
182 memcpy(buf->buffer + buf->start + buf->content_length, input,
183 input_len - overflow);
184 memcpy(buf->buffer, input + input_len - overflow, overflow);
185
186 } else {
187 /* The buffer has come full circle and free space is in the middle */
188 memcpy(buf->buffer + buf->start + buf->content_length - buf->capacity,
189 input, input_len);
190 }
191
192 buf->content_length += input_len;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800193 return (input_len > INT_MAX) ? INT_MAX : (int) input_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800194}
195
Yanray Wange6afd912022-10-27 12:11:18 +0800196int mbedtls_test_ssl_buffer_get(mbedtls_test_ssl_buffer *buf,
197 unsigned char *output, size_t output_len)
198{
199 size_t overflow = 0;
200
201 if ((buf == NULL) || (buf->buffer == NULL)) {
202 return -1;
203 }
204
205 if (output == NULL && output_len == 0) {
206 return 0;
207 }
208
209 if (buf->content_length < output_len) {
210 output_len = buf->content_length;
211 }
212
213 /* Calculate the number of bytes that need to be drawn from lower memory
214 * address */
215 if (buf->start + output_len > buf->capacity) {
216 overflow = (buf->start + output_len) % buf->capacity;
217 }
218
219 if (output != NULL) {
220 memcpy(output, buf->buffer + buf->start, output_len - overflow);
221 memcpy(output + output_len - overflow, buf->buffer, overflow);
222 }
223
224 buf->content_length -= output_len;
225 buf->start = (buf->start + output_len) % buf->capacity;
226
Yanray Wanga8f445e2022-11-03 11:51:59 +0800227 return (output_len > INT_MAX) ? INT_MAX : (int) output_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800228}
229
Yanray Wangd19894f2023-03-16 11:47:39 +0800230int mbedtls_test_ssl_message_queue_setup(
231 mbedtls_test_ssl_message_queue *queue, size_t capacity)
Yanray Wange6afd912022-10-27 12:11:18 +0800232{
233 queue->messages = (size_t *) mbedtls_calloc(capacity, sizeof(size_t));
234 if (NULL == queue->messages) {
235 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
236 }
237
Yanray Wanga8f445e2022-11-03 11:51:59 +0800238 queue->capacity = (capacity > INT_MAX) ? INT_MAX : (int) capacity;
Yanray Wange6afd912022-10-27 12:11:18 +0800239 queue->pos = 0;
240 queue->num = 0;
241
242 return 0;
243}
244
Yanray Wangd19894f2023-03-16 11:47:39 +0800245void mbedtls_test_ssl_message_queue_free(
246 mbedtls_test_ssl_message_queue *queue)
Yanray Wange6afd912022-10-27 12:11:18 +0800247{
248 if (queue == NULL) {
249 return;
250 }
251
252 if (queue->messages != NULL) {
253 mbedtls_free(queue->messages);
254 }
255
256 memset(queue, 0, sizeof(*queue));
257}
258
Yanray Wange6afd912022-10-27 12:11:18 +0800259int mbedtls_test_ssl_message_queue_push_info(
260 mbedtls_test_ssl_message_queue *queue, size_t len)
261{
262 int place;
263 if (queue == NULL) {
264 return MBEDTLS_TEST_ERROR_ARG_NULL;
265 }
266
267 if (queue->num >= queue->capacity) {
268 return MBEDTLS_ERR_SSL_WANT_WRITE;
269 }
270
271 place = (queue->pos + queue->num) % queue->capacity;
272 queue->messages[place] = len;
273 queue->num++;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800274 return (len > INT_MAX) ? INT_MAX : (int) len;
Yanray Wange6afd912022-10-27 12:11:18 +0800275}
276
Yanray Wange6afd912022-10-27 12:11:18 +0800277int mbedtls_test_ssl_message_queue_pop_info(
278 mbedtls_test_ssl_message_queue *queue, size_t buf_len)
279{
280 size_t message_length;
281 if (queue == NULL) {
282 return MBEDTLS_TEST_ERROR_ARG_NULL;
283 }
284 if (queue->num == 0) {
285 return MBEDTLS_ERR_SSL_WANT_READ;
286 }
287
288 message_length = queue->messages[queue->pos];
289 queue->messages[queue->pos] = 0;
290 queue->num--;
291 queue->pos++;
292 queue->pos %= queue->capacity;
293 if (queue->pos < 0) {
294 queue->pos += queue->capacity;
295 }
296
Yanray Wanga8f445e2022-11-03 11:51:59 +0800297 return (message_length > INT_MAX && buf_len > INT_MAX) ? INT_MAX :
298 (message_length > buf_len) ? (int) buf_len : (int) message_length;
Yanray Wange6afd912022-10-27 12:11:18 +0800299}
300
301/*
302 * Take a peek on the info about the next message length from the queue.
303 * This will be the oldest inserted message length(fifo).
304 *
305 * \retval MBEDTLS_TEST_ERROR_ARG_NULL, if the queue is null.
306 * \retval MBEDTLS_ERR_SSL_WANT_READ, if the queue is empty.
307 * \retval 0, if the peek was successful.
308 * \retval MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED, if the given buffer length is
309 * too small to fit the message. In this case the \p msg_len will be
310 * set to the full message length so that the
311 * caller knows what portion of the message can be dropped.
312 */
Yanray Wang5e22a922023-03-16 14:57:54 +0800313static int test_ssl_message_queue_peek_info(
314 mbedtls_test_ssl_message_queue *queue,
315 size_t buf_len, size_t *msg_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800316{
317 if (queue == NULL || msg_len == NULL) {
318 return MBEDTLS_TEST_ERROR_ARG_NULL;
319 }
320 if (queue->num == 0) {
321 return MBEDTLS_ERR_SSL_WANT_READ;
322 }
323
324 *msg_len = queue->messages[queue->pos];
325 return (*msg_len > buf_len) ? MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED : 0;
326}
327
Yanray Wang5f86a422023-03-15 16:02:29 +0800328void mbedtls_test_mock_socket_init(mbedtls_test_mock_socket *socket)
Yanray Wange6afd912022-10-27 12:11:18 +0800329{
330 memset(socket, 0, sizeof(*socket));
331}
332
Yanray Wange6afd912022-10-27 12:11:18 +0800333void mbedtls_test_mock_socket_close(mbedtls_test_mock_socket *socket)
334{
335 if (socket == NULL) {
336 return;
337 }
338
339 if (socket->input != NULL) {
340 mbedtls_test_ssl_buffer_free(socket->input);
341 mbedtls_free(socket->input);
342 }
343
344 if (socket->output != NULL) {
345 mbedtls_test_ssl_buffer_free(socket->output);
346 mbedtls_free(socket->output);
347 }
348
349 if (socket->peer != NULL) {
350 memset(socket->peer, 0, sizeof(*socket->peer));
351 }
352
353 memset(socket, 0, sizeof(*socket));
354}
355
Yanray Wange6afd912022-10-27 12:11:18 +0800356int mbedtls_test_mock_socket_connect(mbedtls_test_mock_socket *peer1,
357 mbedtls_test_mock_socket *peer2,
358 size_t bufsize)
359{
360 int ret = -1;
361
362 peer1->output =
363 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
364 1, sizeof(mbedtls_test_ssl_buffer));
365 if (peer1->output == NULL) {
366 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
367 goto exit;
368 }
369 mbedtls_test_ssl_buffer_init(peer1->output);
370 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer1->output, bufsize))) {
371 goto exit;
372 }
373
374 peer2->output =
375 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
376 1, sizeof(mbedtls_test_ssl_buffer));
377 if (peer2->output == NULL) {
378 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
379 goto exit;
380 }
381 mbedtls_test_ssl_buffer_init(peer2->output);
382 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer2->output, bufsize))) {
383 goto exit;
384 }
385
386 peer1->peer = peer2;
387 peer2->peer = peer1;
388 peer1->input = peer2->output;
389 peer2->input = peer1->output;
390
391 peer1->status = peer2->status = MBEDTLS_MOCK_SOCKET_CONNECTED;
392 ret = 0;
393
394exit:
395
396 if (ret != 0) {
397 mbedtls_test_mock_socket_close(peer1);
398 mbedtls_test_mock_socket_close(peer2);
399 }
400
401 return ret;
402}
403
Yanray Wangaf727a22023-03-13 19:22:36 +0800404int mbedtls_test_mock_tcp_send_b(void *ctx,
405 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800406{
407 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
408
409 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
410 return -1;
411 }
412
413 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
414}
415
416int mbedtls_test_mock_tcp_recv_b(void *ctx, unsigned char *buf, size_t len)
417{
418 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
419
420 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
421 return -1;
422 }
423
424 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
425}
426
Yanray Wang34634352023-02-14 17:56:51 +0800427int mbedtls_test_mock_tcp_send_nb(void *ctx,
428 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800429{
430 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
431
432 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
433 return -1;
434 }
435
436 if (socket->output->capacity == socket->output->content_length) {
437 return MBEDTLS_ERR_SSL_WANT_WRITE;
438 }
439
440 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
441}
442
443int mbedtls_test_mock_tcp_recv_nb(void *ctx, unsigned char *buf, size_t len)
444{
445 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
446
447 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
448 return -1;
449 }
450
451 if (socket->input->content_length == 0) {
452 return MBEDTLS_ERR_SSL_WANT_READ;
453 }
454
455 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
456}
457
Yanray Wangd19894f2023-03-16 11:47:39 +0800458void mbedtls_test_message_socket_init(
459 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800460{
461 ctx->queue_input = NULL;
462 ctx->queue_output = NULL;
463 ctx->socket = NULL;
464}
465
Yanray Wange6afd912022-10-27 12:11:18 +0800466int mbedtls_test_message_socket_setup(
467 mbedtls_test_ssl_message_queue *queue_input,
468 mbedtls_test_ssl_message_queue *queue_output,
469 size_t queue_capacity,
470 mbedtls_test_mock_socket *socket,
471 mbedtls_test_message_socket_context *ctx)
472{
473 int ret = mbedtls_test_ssl_message_queue_setup(queue_input, queue_capacity);
474 if (ret != 0) {
475 return ret;
476 }
477 ctx->queue_input = queue_input;
478 ctx->queue_output = queue_output;
479 ctx->socket = socket;
Yanray Wang5f86a422023-03-15 16:02:29 +0800480 mbedtls_test_mock_socket_init(socket);
Yanray Wange6afd912022-10-27 12:11:18 +0800481
482 return 0;
483}
484
Yanray Wangd19894f2023-03-16 11:47:39 +0800485void mbedtls_test_message_socket_close(
486 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800487{
488 if (ctx == NULL) {
489 return;
490 }
491
492 mbedtls_test_ssl_message_queue_free(ctx->queue_input);
493 mbedtls_test_mock_socket_close(ctx->socket);
494 memset(ctx, 0, sizeof(*ctx));
495}
496
Yanray Wang34634352023-02-14 17:56:51 +0800497int mbedtls_test_mock_tcp_send_msg(void *ctx,
498 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800499{
500 mbedtls_test_ssl_message_queue *queue;
501 mbedtls_test_mock_socket *socket;
502 mbedtls_test_message_socket_context *context =
503 (mbedtls_test_message_socket_context *) ctx;
504
505 if (context == NULL || context->socket == NULL
506 || context->queue_output == NULL) {
507 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
508 }
509
510 queue = context->queue_output;
511 socket = context->socket;
512
513 if (queue->num >= queue->capacity) {
514 return MBEDTLS_ERR_SSL_WANT_WRITE;
515 }
516
517 if (mbedtls_test_mock_tcp_send_b(socket, buf, len) != (int) len) {
518 return MBEDTLS_TEST_ERROR_SEND_FAILED;
519 }
520
521 return mbedtls_test_ssl_message_queue_push_info(queue, len);
522}
523
Yanray Wang34634352023-02-14 17:56:51 +0800524int mbedtls_test_mock_tcp_recv_msg(void *ctx,
525 unsigned char *buf, size_t buf_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800526{
527 mbedtls_test_ssl_message_queue *queue;
528 mbedtls_test_mock_socket *socket;
529 mbedtls_test_message_socket_context *context =
530 (mbedtls_test_message_socket_context *) ctx;
531 size_t drop_len = 0;
532 size_t msg_len;
533 int ret;
534
535 if (context == NULL || context->socket == NULL
536 || context->queue_input == NULL) {
537 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
538 }
539
540 queue = context->queue_input;
541 socket = context->socket;
542
543 /* Peek first, so that in case of a socket error the data remains in
544 * the queue. */
Yanray Wang5e22a922023-03-16 14:57:54 +0800545 ret = test_ssl_message_queue_peek_info(queue, buf_len, &msg_len);
Yanray Wange6afd912022-10-27 12:11:18 +0800546 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
547 /* Calculate how much to drop */
548 drop_len = msg_len - buf_len;
549
550 /* Set the requested message len to be buffer length */
551 msg_len = buf_len;
552 } else if (ret != 0) {
553 return ret;
554 }
555
556 if (mbedtls_test_mock_tcp_recv_b(socket, buf, msg_len) != (int) msg_len) {
557 return MBEDTLS_TEST_ERROR_RECV_FAILED;
558 }
559
560 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
561 /* Drop the remaining part of the message */
Yanray Wangaf727a22023-03-13 19:22:36 +0800562 if (mbedtls_test_mock_tcp_recv_b(socket, NULL, drop_len) !=
563 (int) drop_len) {
Yanray Wange6afd912022-10-27 12:11:18 +0800564 /* Inconsistent state - part of the message was read,
565 * and a part couldn't. Not much we can do here, but it should not
566 * happen in test environment, unless forced manually. */
567 }
568 }
Tomás Gonzáleza9b90de2024-02-01 11:12:20 +0000569 ret = mbedtls_test_ssl_message_queue_pop_info(queue, buf_len);
570 if (ret < 0) {
571 return ret;
572 }
Yanray Wange6afd912022-10-27 12:11:18 +0800573
Yanray Wanga8f445e2022-11-03 11:51:59 +0800574 return (msg_len > INT_MAX) ? INT_MAX : (int) msg_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800575}
576
Gilles Peskine27586d82025-05-28 17:01:42 +0200577
578#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
579 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
580 defined(MBEDTLS_SSL_SRV_C)
581static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
582 const unsigned char *name, size_t name_len)
583{
584 (void) p_info;
585 (void) ssl;
586 (void) name;
587 (void) name_len;
588
589 return 0;
590}
591#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
592 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
593 MBEDTLS_SSL_SRV_C */
594
Yanray Wange6afd912022-10-27 12:11:18 +0800595#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
596
Gilles Peskine27586d82025-05-28 17:01:42 +0200597static int set_ciphersuite(mbedtls_test_ssl_endpoint *ep,
598 const char *cipher)
599{
600 if (cipher == NULL || cipher[0] == 0) {
601 return 1;
602 }
603
604 int ok = 0;
605
606 TEST_CALLOC(ep->ciphersuites, 2);
607 ep->ciphersuites[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
608 ep->ciphersuites[1] = 0;
609
610 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
611 mbedtls_ssl_ciphersuite_from_id(ep->ciphersuites[0]);
612
613 TEST_ASSERT(ciphersuite_info != NULL);
614 TEST_ASSERT(ciphersuite_info->min_tls_version <= ep->conf.max_tls_version);
615 TEST_ASSERT(ciphersuite_info->max_tls_version >= ep->conf.min_tls_version);
616
617 if (ep->conf.max_tls_version > ciphersuite_info->max_tls_version) {
618 ep->conf.max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
619 }
620 if (ep->conf.min_tls_version < ciphersuite_info->min_tls_version) {
621 ep->conf.min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
622 }
623
624 mbedtls_ssl_conf_ciphersuites(&ep->conf, ep->ciphersuites);
625 ok = 1;
626
627exit:
628 return ok;
629}
630
Yanray Wange6afd912022-10-27 12:11:18 +0800631/*
632 * Deinitializes certificates from endpoint represented by \p ep.
633 */
Yanray Wangf6f71902023-03-15 16:05:14 +0800634static void test_ssl_endpoint_certificate_free(mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +0800635{
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200636 if (ep->ca_chain != NULL) {
637 mbedtls_x509_crt_free(ep->ca_chain);
638 mbedtls_free(ep->ca_chain);
639 ep->ca_chain = NULL;
640 }
641 if (ep->cert != NULL) {
642 mbedtls_x509_crt_free(ep->cert);
643 mbedtls_free(ep->cert);
644 ep->cert = NULL;
645 }
646 if (ep->pkey != NULL) {
Yanray Wange6afd912022-10-27 12:11:18 +0800647#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200648 if (mbedtls_pk_get_type(ep->pkey) == MBEDTLS_PK_OPAQUE) {
649 psa_destroy_key(ep->pkey->priv_id);
Yanray Wange6afd912022-10-27 12:11:18 +0800650 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200651#endif
652 mbedtls_pk_free(ep->pkey);
653 mbedtls_free(ep->pkey);
654 ep->pkey = NULL;
Yanray Wange6afd912022-10-27 12:11:18 +0800655 }
656}
657
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200658static int load_endpoint_rsa(mbedtls_test_ssl_endpoint *ep)
659{
660 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
661 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
662 ret = mbedtls_x509_crt_parse(
663 ep->cert,
664 (const unsigned char *) mbedtls_test_srv_crt_rsa_sha256_der,
665 mbedtls_test_srv_crt_rsa_sha256_der_len);
666 TEST_EQUAL(ret, 0);
667 ret = mbedtls_pk_parse_key(
668 ep->pkey,
669 (const unsigned char *) mbedtls_test_srv_key_rsa_der,
670 mbedtls_test_srv_key_rsa_der_len, NULL, 0);
671 TEST_EQUAL(ret, 0);
672 } else {
673 ret = mbedtls_x509_crt_parse(
674 ep->cert,
675 (const unsigned char *) mbedtls_test_cli_crt_rsa_der,
676 mbedtls_test_cli_crt_rsa_der_len);
677 TEST_EQUAL(ret, 0);
678 ret = mbedtls_pk_parse_key(
679 ep->pkey,
680 (const unsigned char *) mbedtls_test_cli_key_rsa_der,
681 mbedtls_test_cli_key_rsa_der_len, NULL, 0);
682 TEST_EQUAL(ret, 0);
683 }
684
685exit:
686 return ret;
687}
688
689static int load_endpoint_ecc(mbedtls_test_ssl_endpoint *ep)
690{
691 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
692 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
693 ret = mbedtls_x509_crt_parse(
694 ep->cert,
695 (const unsigned char *) mbedtls_test_srv_crt_ec_der,
696 mbedtls_test_srv_crt_ec_der_len);
697 TEST_EQUAL(ret, 0);
698 ret = mbedtls_pk_parse_key(
699 ep->pkey,
700 (const unsigned char *) mbedtls_test_srv_key_ec_der,
701 mbedtls_test_srv_key_ec_der_len, NULL, 0);
702 TEST_EQUAL(ret, 0);
703 } else {
704 ret = mbedtls_x509_crt_parse(
705 ep->cert,
706 (const unsigned char *) mbedtls_test_cli_crt_ec_der,
707 mbedtls_test_cli_crt_ec_len);
708 TEST_EQUAL(ret, 0);
709 ret = mbedtls_pk_parse_key(
710 ep->pkey,
711 (const unsigned char *) mbedtls_test_cli_key_ec_der,
712 mbedtls_test_cli_key_ec_der_len, NULL, 0);
713 TEST_EQUAL(ret, 0);
714 }
715
716exit:
717 return ret;
718}
719
Yanray Wange6afd912022-10-27 12:11:18 +0800720int mbedtls_test_ssl_endpoint_certificate_init(mbedtls_test_ssl_endpoint *ep,
721 int pk_alg,
722 int opaque_alg, int opaque_alg2,
723 int opaque_usage)
724{
725 int i = 0;
726 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +0200727 int ok = 0;
Yanray Wange6afd912022-10-27 12:11:18 +0800728#if defined(MBEDTLS_USE_PSA_CRYPTO)
729 mbedtls_svc_key_id_t key_slot = MBEDTLS_SVC_KEY_ID_INIT;
730#endif
731
732 if (ep == NULL) {
733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
734 }
735
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200736 TEST_CALLOC(ep->ca_chain, 1);
737 TEST_CALLOC(ep->cert, 1);
738 TEST_CALLOC(ep->pkey, 1);
Yanray Wange6afd912022-10-27 12:11:18 +0800739
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200740 mbedtls_x509_crt_init(ep->ca_chain);
741 mbedtls_x509_crt_init(ep->cert);
742 mbedtls_pk_init(ep->pkey);
Yanray Wange6afd912022-10-27 12:11:18 +0800743
744 /* Load the trusted CA */
745
746 for (i = 0; mbedtls_test_cas_der[i] != NULL; i++) {
747 ret = mbedtls_x509_crt_parse_der(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200748 ep->ca_chain,
Yanray Wange6afd912022-10-27 12:11:18 +0800749 (const unsigned char *) mbedtls_test_cas_der[i],
750 mbedtls_test_cas_der_len[i]);
Gilles Peskine353eb332025-05-14 17:42:53 +0200751 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800752 }
753
754 /* Load own certificate and private key */
755
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200756 if (pk_alg == MBEDTLS_PK_RSA) {
757 TEST_EQUAL(load_endpoint_rsa(ep), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800758 } else {
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200759 TEST_EQUAL(load_endpoint_ecc(ep), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800760 }
761
762#if defined(MBEDTLS_USE_PSA_CRYPTO)
763 if (opaque_alg != 0) {
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100764 psa_key_attributes_t key_attr = PSA_KEY_ATTRIBUTES_INIT;
765 /* Use a fake key usage to get a successful initial guess for the PSA attributes. */
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200766 TEST_EQUAL(mbedtls_pk_get_psa_attributes(ep->pkey, PSA_KEY_USAGE_SIGN_HASH,
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100767 &key_attr), 0);
Valerio Settia9de9442024-02-27 13:56:09 +0100768 /* Then manually usage, alg and alg2 as requested by the test. */
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100769 psa_set_key_usage_flags(&key_attr, opaque_usage);
770 psa_set_key_algorithm(&key_attr, opaque_alg);
771 if (opaque_alg2 != PSA_ALG_NONE) {
772 psa_set_key_enrollment_algorithm(&key_attr, opaque_alg2);
773 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200774 TEST_EQUAL(mbedtls_pk_import_into_psa(ep->pkey, &key_attr, &key_slot), 0);
775 mbedtls_pk_free(ep->pkey);
776 mbedtls_pk_init(ep->pkey);
Ben Taylor361ce2b2025-07-04 10:36:53 +0100777 TEST_EQUAL(mbedtls_pk_wrap_psa(ep->pkey, key_slot), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800778 }
779#else
780 (void) opaque_alg;
781 (void) opaque_alg2;
782 (void) opaque_usage;
783#endif
784
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200785 mbedtls_ssl_conf_ca_chain(&(ep->conf), ep->ca_chain, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +0800786
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200787 ret = mbedtls_ssl_conf_own_cert(&(ep->conf), ep->cert,
788 ep->pkey);
Gilles Peskine353eb332025-05-14 17:42:53 +0200789 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800790
Gilles Peskine946bf142025-04-08 09:48:40 +0200791 ok = 1;
792
Yanray Wange6afd912022-10-27 12:11:18 +0800793exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200794 if (ret == 0 && !ok) {
795 /* Exiting due to a test assertion that isn't ret == 0 */
796 ret = -1;
797 }
Yanray Wange6afd912022-10-27 12:11:18 +0800798 if (ret != 0) {
Yanray Wangf6f71902023-03-15 16:05:14 +0800799 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800800 }
801
802 return ret;
803}
804
Gilles Peskine6edb76c2025-06-01 21:53:52 +0200805int mbedtls_test_ssl_endpoint_init_conf(
Yanray Wange6afd912022-10-27 12:11:18 +0800806 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +0200807 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +0800808{
809 int ret = -1;
Gilles Peskine27586d82025-05-28 17:01:42 +0200810#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
811 const char *psk_identity = "foo";
812#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800813
Yanray Wange6afd912022-10-27 12:11:18 +0800814 if (ep == NULL) {
815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
816 }
817
818 memset(ep, 0, sizeof(*ep));
819
820 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
821
822 mbedtls_ssl_init(&(ep->ssl));
823 mbedtls_ssl_config_init(&(ep->conf));
Gilles Peskine29969592025-05-27 19:24:28 +0200824 mbedtls_test_message_socket_init(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800825
826 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
827 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
828 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
829 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
830
831 (void) mbedtls_test_rnd_std_rand(NULL,
Gilles Peskine00eb0722025-06-01 21:50:05 +0200832 (void *) &ep->user_data_cookie,
833 sizeof(ep->user_data_cookie));
834 mbedtls_ssl_conf_set_user_data_n(&ep->conf, ep->user_data_cookie);
835 mbedtls_ssl_set_user_data_n(&ep->ssl, ep->user_data_cookie);
Yanray Wange6afd912022-10-27 12:11:18 +0800836
Gilles Peskine6c154e72025-05-27 20:23:52 +0200837 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800838
Yanray Wange6afd912022-10-27 12:11:18 +0800839 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
Gilles Peskine29969592025-05-27 19:24:28 +0200840 options->dtls ?
Yanray Wange6afd912022-10-27 12:11:18 +0800841 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
842 MBEDTLS_SSL_TRANSPORT_STREAM,
843 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200844 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800845
Ronald Crona697a712023-03-09 17:47:42 +0100846 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
847 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
848 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
849 options->client_min_version);
850 }
851
852 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
853 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
854 options->client_max_version);
855 }
856 } else {
857 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
858 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
859 options->server_min_version);
860 }
861
862 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
863 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
864 options->server_max_version);
865 }
866 }
867
Gilles Peskine27586d82025-05-28 17:01:42 +0200868 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
869 TEST_ASSERT(set_ciphersuite(ep, options->cipher));
870 }
871
Ronald Cronfb536472024-01-26 14:55:25 +0100872 if (options->group_list != NULL) {
873 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800874 }
875
Gilles Peskinefb2ce052025-05-28 17:36:12 +0200876 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
877 mbedtls_ssl_conf_authmode(&(ep->conf), options->srv_auth_mode);
878 } else {
879 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
880 }
Yanray Wange6afd912022-10-27 12:11:18 +0800881
Ronald Cronced99be2024-01-26 15:49:12 +0100882#if defined(MBEDTLS_SSL_EARLY_DATA)
883 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100884#if defined(MBEDTLS_SSL_SRV_C)
885 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
886 (options->max_early_data_size >= 0)) {
887 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
888 options->max_early_data_size);
889 }
890#endif
Gilles Peskine27586d82025-05-28 17:01:42 +0200891
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000892#if defined(MBEDTLS_SSL_ALPN)
893 /* check that alpn_list contains at least one valid entry */
894 if (options->alpn_list[0] != NULL) {
895 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
896 }
897#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100898#endif
899
Gilles Peskine27586d82025-05-28 17:01:42 +0200900#if defined(MBEDTLS_SSL_RENEGOTIATION)
901 if (options->renegotiate) {
902 mbedtls_ssl_conf_renegotiation(&ep->conf,
903 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
904 mbedtls_ssl_conf_legacy_renegotiation(&ep->conf,
905 options->legacy_renegotiation);
906 }
907#endif /* MBEDTLS_SSL_RENEGOTIATION */
908
Yanray Wange6afd912022-10-27 12:11:18 +0800909#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
910 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
911 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
912 mbedtls_ssl_cache_get,
913 mbedtls_ssl_cache_set);
914 }
915#endif
916
Gilles Peskine27586d82025-05-28 17:01:42 +0200917#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
918 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&ep->conf,
919 (unsigned char) options->mfl),
920 0);
921#else
922 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
923#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
924
Yanray Wange6afd912022-10-27 12:11:18 +0800925#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine29969592025-05-27 19:24:28 +0200926 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->dtls) {
Yanray Wange6afd912022-10-27 12:11:18 +0800927 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
928 }
929#endif
930
Ronald Cronec3408d2024-01-16 17:50:40 +0100931#if defined(MBEDTLS_DEBUG_C)
932#if defined(MBEDTLS_SSL_SRV_C)
933 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
934 options->srv_log_fun != NULL) {
935 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
936 options->srv_log_obj);
937 }
938#endif
939#if defined(MBEDTLS_SSL_CLI_C)
940 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
941 options->cli_log_fun != NULL) {
942 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
943 options->cli_log_obj);
944 }
945#endif
946#endif /* MBEDTLS_DEBUG_C */
947
Yanray Wange6afd912022-10-27 12:11:18 +0800948 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
949 options->opaque_alg,
950 options->opaque_alg2,
951 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200952 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800953
Gilles Peskine27586d82025-05-28 17:01:42 +0200954#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
955 if (options->psk_str != NULL && options->psk_str->len > 0) {
956 TEST_EQUAL(mbedtls_ssl_conf_psk(
957 &ep->conf, options->psk_str->x,
958 options->psk_str->len,
959 (const unsigned char *) psk_identity,
960 strlen(psk_identity)), 0);
961#if defined(MBEDTLS_SSL_SRV_C)
962 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
963 mbedtls_ssl_conf_psk_cb(&ep->conf, psk_dummy_callback, NULL);
964 }
965#endif
966 }
967#endif
968
Gilles Peskine00eb0722025-06-01 21:50:05 +0200969 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf),
970 ep->user_data_cookie);
Yanray Wange6afd912022-10-27 12:11:18 +0800971 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
Gilles Peskinea6e71f92025-06-01 21:32:05 +0200972
Gilles Peskine6edb76c2025-06-01 21:53:52 +0200973 return 0;
974
975exit:
976 if (ret == 0) {
977 /* Exiting due to a test assertion that isn't ret == 0 */
978 ret = -1;
979 }
980 return ret;
981}
982
983int mbedtls_test_ssl_endpoint_init_ssl(
984 mbedtls_test_ssl_endpoint *ep,
985 const mbedtls_test_handshake_test_options *options)
986{
987 int endpoint_type = mbedtls_ssl_conf_get_endpoint(&ep->conf);
988 int ret = -1;
Gilles Peskinea6e71f92025-06-01 21:32:05 +0200989
990 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
991 TEST_EQUAL(ret, 0);
992
993 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
994 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
995 TEST_EQUAL(ret, 0);
996 }
997
998 /* Non-blocking callbacks without timeout */
999 if (options->dtls) {
1000 mbedtls_ssl_set_bio(&(ep->ssl), &ep->dtls_context,
1001 mbedtls_test_mock_tcp_send_msg,
1002 mbedtls_test_mock_tcp_recv_msg,
1003 NULL);
1004#if defined(MBEDTLS_TIMING_C)
1005 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
1006 mbedtls_timing_set_delay,
1007 mbedtls_timing_get_delay);
1008#endif
1009 } else {
1010 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
1011 mbedtls_test_mock_tcp_send_nb,
1012 mbedtls_test_mock_tcp_recv_nb,
1013 NULL);
1014 }
1015
Gilles Peskine00eb0722025-06-01 21:50:05 +02001016 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), ep->user_data_cookie);
Yanray Wange6afd912022-10-27 12:11:18 +08001017 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
1018
Gilles Peskine946bf142025-04-08 09:48:40 +02001019 return 0;
1020
Yanray Wange6afd912022-10-27 12:11:18 +08001021exit:
Gilles Peskine946bf142025-04-08 09:48:40 +02001022 if (ret == 0) {
1023 /* Exiting due to a test assertion that isn't ret == 0 */
1024 ret = -1;
1025 }
Yanray Wange6afd912022-10-27 12:11:18 +08001026 return ret;
1027}
1028
Gilles Peskine6edb76c2025-06-01 21:53:52 +02001029int mbedtls_test_ssl_endpoint_init(
1030 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
1031 const mbedtls_test_handshake_test_options *options)
1032{
1033 int ret = mbedtls_test_ssl_endpoint_init_conf(ep, endpoint_type, options);
1034 if (ret != 0) {
1035 return ret;
1036 }
1037 ret = mbedtls_test_ssl_endpoint_init_ssl(ep, options);
1038 return ret;
1039}
1040
Yanray Wange6afd912022-10-27 12:11:18 +08001041void mbedtls_test_ssl_endpoint_free(
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02001042 mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +08001043{
Yanray Wange6afd912022-10-27 12:11:18 +08001044 mbedtls_ssl_free(&(ep->ssl));
1045 mbedtls_ssl_config_free(&(ep->conf));
1046
Gilles Peskine2744a432025-05-27 13:27:22 +02001047 mbedtls_free(ep->ciphersuites);
1048 ep->ciphersuites = NULL;
1049 test_ssl_endpoint_certificate_free(ep);
1050
Gilles Peskine29969592025-05-27 19:24:28 +02001051 if (ep->dtls_context.socket != NULL) {
1052 mbedtls_test_message_socket_close(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +08001053 } else {
1054 mbedtls_test_mock_socket_close(&(ep->socket));
1055 }
1056}
1057
Gilles Peskineb092e782025-05-27 20:15:03 +02001058int mbedtls_test_ssl_dtls_join_endpoints(mbedtls_test_ssl_endpoint *client,
1059 mbedtls_test_ssl_endpoint *server)
1060{
1061 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1062
Gilles Peskine6c154e72025-05-27 20:23:52 +02001063 ret = mbedtls_test_message_socket_setup(&client->queue_input,
1064 &server->queue_input,
1065 100, &(client->socket),
1066 &client->dtls_context);
1067 TEST_EQUAL(ret, 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02001068
Gilles Peskine6c154e72025-05-27 20:23:52 +02001069 ret = mbedtls_test_message_socket_setup(&server->queue_input,
1070 &client->queue_input,
1071 100, &(server->socket),
1072 &server->dtls_context);
1073 TEST_EQUAL(ret, 0);
1074
1075exit:
Gilles Peskineb092e782025-05-27 20:15:03 +02001076 return ret;
1077}
1078
Yanray Wange6afd912022-10-27 12:11:18 +08001079int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
1080 mbedtls_ssl_context *second_ssl,
1081 int state)
1082{
1083 enum { BUFFSIZE = 1024 };
1084 int max_steps = 1000;
1085 int ret = 0;
1086
1087 if (ssl == NULL || second_ssl == NULL) {
1088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1089 }
1090
1091 /* Perform communication via connected sockets */
1092 while ((ssl->state != state) && (--max_steps >= 0)) {
1093 /* If /p second_ssl ends the handshake procedure before /p ssl then
1094 * there is no need to call the next step */
1095 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
1096 ret = mbedtls_ssl_handshake_step(second_ssl);
1097 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1098 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1099 return ret;
1100 }
1101 }
1102
1103 /* We only care about the \p ssl state and returns, so we call it last,
1104 * to leave the iteration as soon as the state is as expected. */
1105 ret = mbedtls_ssl_handshake_step(ssl);
1106 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1107 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1108 return ret;
1109 }
1110 }
1111
1112 return (max_steps >= 0) ? ret : -1;
1113}
1114
1115#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
1116
1117/*
1118 * Write application data. Increase write counter if necessary.
1119 */
Michael Schuster54300d42024-06-04 02:30:22 +02001120static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001121 unsigned char *buf, int buf_len,
1122 int *written,
1123 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001124{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001125 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001126 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1127 * a valid no-op for TLS connections. */
1128 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001129 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001130 }
1131
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001132 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +08001133 if (ret > 0) {
1134 *written += ret;
1135 }
1136
1137 if (expected_fragments == 0) {
1138 /* Used for DTLS and the message size larger than MFL. In that case
1139 * the message can not be fragmented and the library should return
1140 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +08001141 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +08001142 return ret;
1143 } else if (expected_fragments == 1) {
1144 /* Used for TLS/DTLS and the message size lower than MFL */
1145 TEST_ASSERT(ret == buf_len ||
1146 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1147 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1148 } else {
1149 /* Used for TLS and the message size larger than MFL */
1150 TEST_ASSERT(expected_fragments > 1);
1151 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1152 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1153 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1154 }
1155
1156 return 0;
1157
1158exit:
1159 /* Some of the tests failed */
1160 return -1;
1161}
1162
1163/*
1164 * Read application data and increase read counter and fragments counter
1165 * if necessary.
1166 */
Michael Schuster54300d42024-06-04 02:30:22 +02001167static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001168 unsigned char *buf, int buf_len,
1169 int *read, int *fragments,
1170 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001171{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001172 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001173 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1174 * a valid no-op for TLS connections. */
1175 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001176 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001177 }
1178
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001179 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001180 if (ret > 0) {
1181 (*fragments)++;
1182 *read += ret;
1183 }
1184
1185 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001186 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001187 } else if (expected_fragments == 1) {
1188 TEST_ASSERT(ret == buf_len ||
1189 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1190 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1191 } else {
1192 TEST_ASSERT(expected_fragments > 1);
1193 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1194 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1195 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1196 }
1197
1198 return 0;
1199
1200exit:
1201 /* Some of the tests failed */
1202 return -1;
1203}
1204
Yanray Wange6afd912022-10-27 12:11:18 +08001205#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001206 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001207int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1208 const unsigned char *iv,
1209 size_t iv_len,
1210 const unsigned char *input,
1211 size_t ilen,
1212 unsigned char *output,
1213 size_t *olen)
1214{
1215#if defined(MBEDTLS_USE_PSA_CRYPTO)
1216 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1217 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1218 size_t part_len;
1219
1220 status = psa_cipher_encrypt_setup(&cipher_op,
1221 transform->psa_key_enc,
1222 transform->psa_alg);
1223
1224 if (status != PSA_SUCCESS) {
1225 return PSA_TO_MBEDTLS_ERR(status);
1226 }
1227
1228 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1229
1230 if (status != PSA_SUCCESS) {
1231 return PSA_TO_MBEDTLS_ERR(status);
1232 }
1233
1234 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1235
1236 if (status != PSA_SUCCESS) {
1237 return PSA_TO_MBEDTLS_ERR(status);
1238 }
1239
1240 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1241 &part_len);
1242
1243 if (status != PSA_SUCCESS) {
1244 return PSA_TO_MBEDTLS_ERR(status);
1245 }
1246
1247 *olen += part_len;
1248 return 0;
1249#else
1250 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1251 iv, iv_len, input, ilen, output, olen);
1252#endif /* MBEDTLS_USE_PSA_CRYPTO */
1253}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001254#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001255 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001256
Valerio Setti31ad3a12023-10-27 11:55:02 +02001257static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1258 mbedtls_cipher_mode_t *cipher_mode,
1259 size_t *key_bits, size_t *iv_len)
1260{
1261 switch (cipher_type) {
1262 case MBEDTLS_CIPHER_AES_128_CBC:
1263 *cipher_mode = MBEDTLS_MODE_CBC;
1264 *key_bits = 128;
1265 *iv_len = 16;
1266 break;
1267 case MBEDTLS_CIPHER_AES_256_CBC:
1268 *cipher_mode = MBEDTLS_MODE_CBC;
1269 *key_bits = 256;
1270 *iv_len = 16;
1271 break;
1272 case MBEDTLS_CIPHER_ARIA_128_CBC:
1273 *cipher_mode = MBEDTLS_MODE_CBC;
1274 *key_bits = 128;
1275 *iv_len = 16;
1276 break;
1277 case MBEDTLS_CIPHER_ARIA_256_CBC:
1278 *cipher_mode = MBEDTLS_MODE_CBC;
1279 *key_bits = 256;
1280 *iv_len = 16;
1281 break;
1282 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1283 *cipher_mode = MBEDTLS_MODE_CBC;
1284 *key_bits = 128;
1285 *iv_len = 16;
1286 break;
1287 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1288 *cipher_mode = MBEDTLS_MODE_CBC;
1289 *key_bits = 256;
1290 *iv_len = 16;
1291 break;
1292
1293 case MBEDTLS_CIPHER_AES_128_CCM:
1294 *cipher_mode = MBEDTLS_MODE_CCM;
1295 *key_bits = 128;
1296 *iv_len = 12;
1297 break;
1298 case MBEDTLS_CIPHER_AES_192_CCM:
1299 *cipher_mode = MBEDTLS_MODE_CCM;
1300 *key_bits = 192;
1301 *iv_len = 12;
1302 break;
1303 case MBEDTLS_CIPHER_AES_256_CCM:
1304 *cipher_mode = MBEDTLS_MODE_CCM;
1305 *key_bits = 256;
1306 *iv_len = 12;
1307 break;
1308 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1309 *cipher_mode = MBEDTLS_MODE_CCM;
1310 *key_bits = 128;
1311 *iv_len = 12;
1312 break;
1313 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1314 *cipher_mode = MBEDTLS_MODE_CCM;
1315 *key_bits = 192;
1316 *iv_len = 12;
1317 break;
1318 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1319 *cipher_mode = MBEDTLS_MODE_CCM;
1320 *key_bits = 256;
1321 *iv_len = 12;
1322 break;
1323
1324 case MBEDTLS_CIPHER_AES_128_GCM:
1325 *cipher_mode = MBEDTLS_MODE_GCM;
1326 *key_bits = 128;
1327 *iv_len = 12;
1328 break;
1329 case MBEDTLS_CIPHER_AES_192_GCM:
1330 *cipher_mode = MBEDTLS_MODE_GCM;
1331 *key_bits = 192;
1332 *iv_len = 12;
1333 break;
1334 case MBEDTLS_CIPHER_AES_256_GCM:
1335 *cipher_mode = MBEDTLS_MODE_GCM;
1336 *key_bits = 256;
1337 *iv_len = 12;
1338 break;
1339 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1340 *cipher_mode = MBEDTLS_MODE_GCM;
1341 *key_bits = 128;
1342 *iv_len = 12;
1343 break;
1344 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1345 *cipher_mode = MBEDTLS_MODE_GCM;
1346 *key_bits = 192;
1347 *iv_len = 12;
1348 break;
1349 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1350 *cipher_mode = MBEDTLS_MODE_GCM;
1351 *key_bits = 256;
1352 *iv_len = 12;
1353 break;
1354
1355 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1356 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1357 *key_bits = 256;
1358 *iv_len = 12;
1359 break;
1360
1361 case MBEDTLS_CIPHER_NULL:
1362 *cipher_mode = MBEDTLS_MODE_STREAM;
1363 *key_bits = 0;
1364 *iv_len = 0;
1365 break;
1366
1367 default:
1368 *cipher_mode = MBEDTLS_MODE_NONE;
1369 *key_bits = 0;
1370 *iv_len = 0;
1371 }
1372}
1373
Yanray Wange6afd912022-10-27 12:11:18 +08001374int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1375 mbedtls_ssl_transform *t_out,
1376 int cipher_type, int hash_id,
1377 int etm, int tag_mode,
1378 mbedtls_ssl_protocol_version tls_version,
1379 size_t cid0_len,
1380 size_t cid1_len)
1381{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001382 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1383 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001384 int ret = 0;
1385
1386#if defined(MBEDTLS_USE_PSA_CRYPTO)
1387 psa_key_type_t key_type;
1388 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1389 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001391#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001392 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001393#endif
1394
Valerio Setti31ad3a12023-10-27 11:55:02 +02001395 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001396 unsigned char *key0 = NULL, *key1 = NULL;
1397 unsigned char *md0 = NULL, *md1 = NULL;
1398 unsigned char iv_enc[16], iv_dec[16];
1399
1400#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1401 unsigned char cid0[SSL_CID_LEN_MIN];
1402 unsigned char cid1[SSL_CID_LEN_MIN];
1403
1404 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1405 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1406#else
1407 ((void) cid0_len);
1408 ((void) cid1_len);
1409#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1410
1411 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001412 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1413 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001414
1415 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001416 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001417 /* Allocate `keylen + 1` bytes to ensure that we get
1418 * a non-NULL pointers from `mbedtls_calloc` even if
1419 * `keylen == 0` in the case of the NULL cipher. */
1420 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1421 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1422 memset(key0, 0x1, keylen);
1423 memset(key1, 0x2, keylen);
1424
1425#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001426 /* Pick cipher */
1427 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1428 CHK(cipher_info != NULL);
1429 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1430 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001431
Yanray Wange6afd912022-10-27 12:11:18 +08001432 /* Setup cipher contexts */
1433 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1434 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1435 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1436 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1437
1438#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001439 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001440 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1441 MBEDTLS_PADDING_NONE) == 0);
1442 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1443 MBEDTLS_PADDING_NONE) == 0);
1444 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1445 MBEDTLS_PADDING_NONE) == 0);
1446 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1447 MBEDTLS_PADDING_NONE) == 0);
1448 }
1449#endif /* MBEDTLS_CIPHER_MODE_CBC */
1450
1451 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001452 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1453 MBEDTLS_ENCRYPT)
1454 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001455 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001456 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1457 MBEDTLS_DECRYPT)
1458 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001459 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001460 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1461 MBEDTLS_ENCRYPT)
1462 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001463 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001464 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1465 MBEDTLS_DECRYPT)
1466 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001467#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001468
1469 /* Setup MAC contexts */
1470#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001471 if (cipher_mode == MBEDTLS_MODE_CBC ||
1472 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001473#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001474 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 +08001475 CHK(md_info != NULL);
1476#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001477 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001478 CHK(maclen != 0);
1479 /* Pick hash keys */
1480 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1481 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1482 memset(md0, 0x5, maclen);
1483 memset(md1, 0x6, maclen);
1484
1485#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001486 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001487
1488 CHK(alg != 0);
1489
1490 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1491 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1492 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1493 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1494 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1495 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1496
1497 psa_reset_key_attributes(&attributes);
1498 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1499 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1500 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1501
1502 CHK(psa_import_key(&attributes,
1503 md0, maclen,
1504 &t_in->psa_mac_enc) == PSA_SUCCESS);
1505
1506 CHK(psa_import_key(&attributes,
1507 md1, maclen,
1508 &t_out->psa_mac_enc) == PSA_SUCCESS);
1509
Valerio Setti31ad3a12023-10-27 11:55:02 +02001510 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001511 etm == MBEDTLS_SSL_ETM_DISABLED) {
1512 /* mbedtls_ct_hmac() requires the key to be exportable */
1513 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1514 PSA_KEY_USAGE_VERIFY_HASH);
1515 } else {
1516 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1517 }
1518
1519 CHK(psa_import_key(&attributes,
1520 md1, maclen,
1521 &t_in->psa_mac_dec) == PSA_SUCCESS);
1522
1523 CHK(psa_import_key(&attributes,
1524 md0, maclen,
1525 &t_out->psa_mac_dec) == PSA_SUCCESS);
1526#else
1527 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1528 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1529 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1530 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1531
1532 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1533 md0, maclen) == 0);
1534 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1535 md1, maclen) == 0);
1536 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1537 md1, maclen) == 0);
1538 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1539 md0, maclen) == 0);
1540#endif
1541 }
1542#else
1543 ((void) hash_id);
1544#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1545
1546
1547 /* Pick IV's (regardless of whether they
1548 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001549 memset(iv_enc, 0x3, sizeof(iv_enc));
1550 memset(iv_dec, 0x4, sizeof(iv_dec));
1551
1552 /*
1553 * Setup transforms
1554 */
1555
1556#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1557 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1558 t_out->encrypt_then_mac = etm;
1559 t_in->encrypt_then_mac = etm;
1560#else
1561 ((void) etm);
1562#endif
1563
1564 t_out->tls_version = tls_version;
1565 t_in->tls_version = tls_version;
1566 t_out->ivlen = ivlen;
1567 t_in->ivlen = ivlen;
1568
Valerio Setti31ad3a12023-10-27 11:55:02 +02001569 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001570 case MBEDTLS_MODE_GCM:
1571 case MBEDTLS_MODE_CCM:
1572#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1573 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1574 t_out->fixed_ivlen = 12;
1575 t_in->fixed_ivlen = 12;
1576 } else
1577#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1578 {
1579 t_out->fixed_ivlen = 4;
1580 t_in->fixed_ivlen = 4;
1581 }
1582 t_out->maclen = 0;
1583 t_in->maclen = 0;
1584 switch (tag_mode) {
1585 case 0: /* Full tag */
1586 t_out->taglen = 16;
1587 t_in->taglen = 16;
1588 break;
1589 case 1: /* Partial tag */
1590 t_out->taglen = 8;
1591 t_in->taglen = 8;
1592 break;
1593 default:
1594 ret = 1;
1595 goto cleanup;
1596 }
1597 break;
1598
1599 case MBEDTLS_MODE_CHACHAPOLY:
1600 t_out->fixed_ivlen = 12;
1601 t_in->fixed_ivlen = 12;
1602 t_out->maclen = 0;
1603 t_in->maclen = 0;
1604 switch (tag_mode) {
1605 case 0: /* Full tag */
1606 t_out->taglen = 16;
1607 t_in->taglen = 16;
1608 break;
1609 case 1: /* Partial tag */
1610 t_out->taglen = 8;
1611 t_in->taglen = 8;
1612 break;
1613 default:
1614 ret = 1;
1615 goto cleanup;
1616 }
1617 break;
1618
1619 case MBEDTLS_MODE_STREAM:
1620 case MBEDTLS_MODE_CBC:
1621 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1622 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1623 t_out->taglen = 0;
1624 t_in->taglen = 0;
1625 switch (tag_mode) {
1626 case 0: /* Full tag */
1627 t_out->maclen = maclen;
1628 t_in->maclen = maclen;
1629 break;
1630 default:
1631 ret = 1;
1632 goto cleanup;
1633 }
1634 break;
1635 default:
1636 ret = 1;
1637 goto cleanup;
1638 break;
1639 }
1640
1641 /* Setup IV's */
1642
1643 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1644 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1645 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1646 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1647
1648#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1649 /* Add CID */
1650 memcpy(&t_in->in_cid, cid0, cid0_len);
1651 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001652 t_in->in_cid_len = (uint8_t) cid0_len;
1653 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001654 memcpy(&t_out->in_cid, cid1, cid1_len);
1655 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001656 t_out->in_cid_len = (uint8_t) cid1_len;
1657 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001658#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1659
1660#if defined(MBEDTLS_USE_PSA_CRYPTO)
1661 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1662 t_in->taglen,
1663 &alg,
1664 &key_type,
1665 &key_bits);
1666
1667 if (status != PSA_SUCCESS) {
1668 ret = PSA_TO_MBEDTLS_ERR(status);
1669 goto cleanup;
1670 }
1671
1672 t_in->psa_alg = alg;
1673 t_out->psa_alg = alg;
1674
1675 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1676 psa_reset_key_attributes(&attributes);
1677 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1678 psa_set_key_algorithm(&attributes, alg);
1679 psa_set_key_type(&attributes, key_type);
1680
1681 status = psa_import_key(&attributes,
1682 key0,
1683 PSA_BITS_TO_BYTES(key_bits),
1684 &t_in->psa_key_enc);
1685
1686 if (status != PSA_SUCCESS) {
1687 ret = PSA_TO_MBEDTLS_ERR(status);
1688 goto cleanup;
1689 }
1690
1691 status = psa_import_key(&attributes,
1692 key1,
1693 PSA_BITS_TO_BYTES(key_bits),
1694 &t_out->psa_key_enc);
1695
1696 if (status != PSA_SUCCESS) {
1697 ret = PSA_TO_MBEDTLS_ERR(status);
1698 goto cleanup;
1699 }
1700
1701 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1702
1703 status = psa_import_key(&attributes,
1704 key1,
1705 PSA_BITS_TO_BYTES(key_bits),
1706 &t_in->psa_key_dec);
1707
1708 if (status != PSA_SUCCESS) {
1709 ret = PSA_TO_MBEDTLS_ERR(status);
1710 goto cleanup;
1711 }
1712
1713 status = psa_import_key(&attributes,
1714 key0,
1715 PSA_BITS_TO_BYTES(key_bits),
1716 &t_out->psa_key_dec);
1717
1718 if (status != PSA_SUCCESS) {
1719 ret = PSA_TO_MBEDTLS_ERR(status);
1720 goto cleanup;
1721 }
1722 }
1723#endif /* MBEDTLS_USE_PSA_CRYPTO */
1724
1725cleanup:
1726
1727 mbedtls_free(key0);
1728 mbedtls_free(key1);
1729
1730 mbedtls_free(md0);
1731 mbedtls_free(md1);
1732
1733 return ret;
1734}
1735
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001736#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1737int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1738 mbedtls_ssl_transform *transform_out)
1739{
1740#if defined(MBEDTLS_USE_PSA_CRYPTO)
1741 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1742#endif
1743
1744 /* Serialized version of record header for MAC purposes */
1745 unsigned char add_data[13];
1746 memcpy(add_data, record->ctr, 8);
1747 add_data[8] = record->type;
1748 add_data[9] = record->ver[0];
1749 add_data[10] = record->ver[1];
1750 add_data[11] = (record->data_len >> 8) & 0xff;
1751 add_data[12] = (record->data_len >> 0) & 0xff;
1752
1753 /* MAC with additional data */
1754#if defined(MBEDTLS_USE_PSA_CRYPTO)
1755 size_t sign_mac_length = 0;
1756 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1757 transform_out->psa_mac_enc,
1758 transform_out->psa_mac_alg));
1759 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1760 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1761 record->buf + record->data_offset,
1762 record->data_len));
1763 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1764 * extension, there might not be enough room in the record for the
1765 * full-length MAC. */
1766 unsigned char mac[PSA_HASH_MAX_SIZE];
1767 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1768 mac, sizeof(mac),
1769 &sign_mac_length));
1770#else
1771 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1772 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1773 record->buf + record->data_offset,
1774 record->data_len));
1775 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1776 * extension, there might not be enough room in the record for the
1777 * full-length MAC. */
1778 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1779 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1780#endif
1781 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1782 record->data_len += transform_out->maclen;
1783
1784 return 0;
1785
1786exit:
1787#if defined(MBEDTLS_USE_PSA_CRYPTO)
1788 psa_mac_abort(&operation);
1789#endif
1790 return -1;
1791}
1792#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1793
Jerry Yu28547c42023-10-31 14:42:50 +08001794#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001795int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1796 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001797 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001798 const char *crt_file)
1799{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001800 (void) ticket_len;
1801
Yanray Wange6afd912022-10-27 12:11:18 +08001802#if defined(MBEDTLS_HAVE_TIME)
1803 session->start = mbedtls_time(NULL) - 42;
1804#endif
1805 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001806
1807 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1808 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1809
1810 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001811 session->ciphersuite = 0xabcd;
1812 session->id_len = sizeof(session->id);
1813 memset(session->id, 66, session->id_len);
1814 memset(session->master, 17, sizeof(session->master));
1815
1816#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1817 if (crt_file != NULL && strlen(crt_file) != 0) {
1818 mbedtls_x509_crt tmp_crt;
1819 int ret;
1820
1821 mbedtls_x509_crt_init(&tmp_crt);
1822 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1823 if (ret != 0) {
1824 return ret;
1825 }
1826
1827#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1828 /* Move temporary CRT. */
1829 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1830 if (session->peer_cert == NULL) {
1831 return -1;
1832 }
1833 *session->peer_cert = tmp_crt;
1834 memset(&tmp_crt, 0, sizeof(tmp_crt));
1835#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1836 /* Calculate digest of temporary CRT. */
1837 session->peer_cert_digest =
1838 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1839 if (session->peer_cert_digest == NULL) {
1840 return -1;
1841 }
1842
1843#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001844 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001845 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1846 size_t hash_size = 0;
1847 psa_status_t status = psa_hash_compute(
1848 psa_alg, tmp_crt.raw.p,
1849 tmp_crt.raw.len,
1850 session->peer_cert_digest,
1851 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1852 &hash_size);
1853 ret = PSA_TO_MBEDTLS_ERR(status);
1854#else
1855 ret = mbedtls_md(mbedtls_md_info_from_type(
1856 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1857 tmp_crt.raw.p, tmp_crt.raw.len,
1858 session->peer_cert_digest);
1859#endif /* MBEDTLS_USE_PSA_CRYPTO */
1860 if (ret != 0) {
1861 return ret;
1862 }
1863 session->peer_cert_digest_type =
1864 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1865 session->peer_cert_digest_len =
1866 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1867#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1868
1869 mbedtls_x509_crt_free(&tmp_crt);
1870 }
1871#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1872 (void) crt_file;
1873#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1874 session->verify_result = 0xdeadbeef;
1875
Ronald Cronc57f86e2023-11-22 09:50:01 +01001876#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1877#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001878 if (ticket_len != 0) {
1879 session->ticket = mbedtls_calloc(1, ticket_len);
1880 if (session->ticket == NULL) {
1881 return -1;
1882 }
1883 memset(session->ticket, 33, ticket_len);
1884 }
1885 session->ticket_len = ticket_len;
1886 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001887#endif /* MBEDTLS_SSL_CLI_C */
1888
1889#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1890 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1891 session->ticket_creation_time = mbedtls_ms_time() - 42;
1892 }
Yanray Wange6afd912022-10-27 12:11:18 +08001893#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001894#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001895
1896#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1897 session->mfl_code = 1;
1898#endif
1899#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1900 session->encrypt_then_mac = 1;
1901#endif
1902
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001903exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001904 return 0;
1905}
Jerry Yu28547c42023-10-31 14:42:50 +08001906#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001907
1908#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1909int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1910 int ticket_len,
1911 int endpoint_type)
1912{
1913 ((void) ticket_len);
1914 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1915 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1916 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1917 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001918
1919#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001920 session->ticket_age_add = 0x87654321;
1921 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001922 session->resumption_key_len = 32;
1923 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001924#endif
1925
Ronald Cron18b92a12024-03-26 10:15:08 +01001926#if defined(MBEDTLS_SSL_SRV_C)
1927 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1928#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1929#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1930 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1931 if (ret != 0) {
1932 return -1;
1933 }
1934#endif
1935#if defined(MBEDTLS_HAVE_TIME)
1936 session->ticket_creation_time = mbedtls_ms_time() - 42;
1937#endif
1938#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1939 }
1940#endif /* MBEDTLS_SSL_SRV_C */
1941
Yanray Wange6afd912022-10-27 12:11:18 +08001942#if defined(MBEDTLS_SSL_CLI_C)
1943 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001944#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001945#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001946 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001947#endif
1948 session->ticket_lifetime = 0xfedcba98;
1949
1950 session->ticket_len = ticket_len;
1951 if (ticket_len != 0) {
1952 session->ticket = mbedtls_calloc(1, ticket_len);
1953 if (session->ticket == NULL) {
1954 return -1;
1955 }
1956 memset(session->ticket, 33, ticket_len);
1957 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001958#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1959 char hostname[] = "hostname example";
1960 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1961 if (session->hostname == NULL) {
1962 return -1;
1963 }
1964 memcpy(session->hostname, hostname, sizeof(hostname));
1965#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001966#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001967 }
1968#endif /* MBEDTLS_SSL_CLI_C */
1969
Ronald Cron18b92a12024-03-26 10:15:08 +01001970#if defined(MBEDTLS_SSL_EARLY_DATA)
1971 session->max_early_data_size = 0x87654321;
1972#endif /* MBEDTLS_SSL_EARLY_DATA */
1973
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001974#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1975 session->record_size_limit = 2048;
1976#endif
1977
Yanray Wange6afd912022-10-27 12:11:18 +08001978 return 0;
1979}
1980#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1981
Yanray Wangb088bfc2023-03-16 12:15:49 +08001982int mbedtls_test_ssl_exchange_data(
1983 mbedtls_ssl_context *ssl_1,
1984 int msg_len_1, const int expected_fragments_1,
1985 mbedtls_ssl_context *ssl_2,
1986 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001987{
1988 unsigned char *msg_buf_1 = malloc(msg_len_1);
1989 unsigned char *msg_buf_2 = malloc(msg_len_2);
1990 unsigned char *in_buf_1 = malloc(msg_len_2);
1991 unsigned char *in_buf_2 = malloc(msg_len_1);
1992 int msg_type, ret = -1;
1993
1994 /* Perform this test with two message types. At first use a message
1995 * consisting of only 0x00 for the client and only 0xFF for the server.
1996 * At the second time use message with generated data */
1997 for (msg_type = 0; msg_type < 2; msg_type++) {
1998 int written_1 = 0;
1999 int written_2 = 0;
2000 int read_1 = 0;
2001 int read_2 = 0;
2002 int fragments_1 = 0;
2003 int fragments_2 = 0;
2004
2005 if (msg_type == 0) {
2006 memset(msg_buf_1, 0x00, msg_len_1);
2007 memset(msg_buf_2, 0xff, msg_len_2);
2008 } else {
2009 int i, j = 0;
2010 for (i = 0; i < msg_len_1; i++) {
2011 msg_buf_1[i] = j++ & 0xFF;
2012 }
2013 for (i = 0; i < msg_len_2; i++) {
2014 msg_buf_2[i] = (j -= 5) & 0xFF;
2015 }
2016 }
2017
2018 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
2019 /* ssl_1 sending */
2020 if (msg_len_1 > written_1) {
2021 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
2022 msg_len_1, &written_1,
2023 expected_fragments_1);
2024 if (expected_fragments_1 == 0) {
2025 /* This error is expected when the message is too large and
2026 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02002027 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08002028 msg_len_1 = 0;
2029 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002030 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002031 }
2032 }
2033
2034 /* ssl_2 sending */
2035 if (msg_len_2 > written_2) {
2036 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
2037 msg_len_2, &written_2,
2038 expected_fragments_2);
2039 if (expected_fragments_2 == 0) {
2040 /* This error is expected when the message is too large and
2041 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02002042 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08002043 msg_len_2 = 0;
2044 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002045 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002046 }
2047 }
2048
2049 /* ssl_1 reading */
2050 if (read_1 < msg_len_2) {
2051 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
2052 msg_len_2, &read_1,
2053 &fragments_2,
2054 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002055 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002056 }
2057
2058 /* ssl_2 reading */
2059 if (read_2 < msg_len_1) {
2060 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
2061 msg_len_1, &read_2,
2062 &fragments_1,
2063 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02002064 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002065 }
2066 }
2067
2068 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02002069 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
2070 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
2071 TEST_EQUAL(fragments_1, expected_fragments_1);
2072 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08002073 }
2074
2075 ret = 0;
2076
2077exit:
2078 free(msg_buf_1);
2079 free(in_buf_1);
2080 free(msg_buf_2);
2081 free(in_buf_2);
2082
2083 return ret;
2084}
2085
2086/*
2087 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
2088 * must be initialized and connected beforehand.
2089 *
2090 * \retval 0 on success, otherwise error code.
2091 */
Yanray Wangead70c82023-03-16 12:04:49 +08002092#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
2093 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
2094 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
2095static int exchange_data(mbedtls_ssl_context *ssl_1,
2096 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08002097{
Yanray Wangb088bfc2023-03-16 12:15:49 +08002098 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
2099 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002100}
Yanray Wangead70c82023-03-16 12:04:49 +08002101#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
2102 (MBEDTLS_SSL_RENEGOTIATION ||
2103 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002104
2105#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2106static int check_ssl_version(
2107 mbedtls_ssl_protocol_version expected_negotiated_version,
Gilles Peskinebd953402025-05-28 15:20:28 +02002108 const mbedtls_ssl_context *client,
2109 const mbedtls_ssl_context *server)
Yanray Wange6afd912022-10-27 12:11:18 +08002110{
Gilles Peskinebd953402025-05-28 15:20:28 +02002111 /* First check that both sides have chosen the same version.
2112 * If so, we can make more sanity checks just on one side.
2113 * If not, something is deeply wrong. */
2114 TEST_EQUAL(client->tls_version, server->tls_version);
2115
2116 /* Make further checks on the client to validate that the
2117 * reported data about the version is correct. */
2118 const char *version_string = mbedtls_ssl_get_version(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002119 mbedtls_ssl_protocol_version version_number =
Gilles Peskinebd953402025-05-28 15:20:28 +02002120 mbedtls_ssl_get_version_number(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002121
Gilles Peskinebd953402025-05-28 15:20:28 +02002122 TEST_EQUAL(client->tls_version, expected_negotiated_version);
Yanray Wange6afd912022-10-27 12:11:18 +08002123
Gilles Peskinebd953402025-05-28 15:20:28 +02002124 if (client->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08002125 TEST_EQUAL(version_string[0], 'D');
2126 ++version_string;
2127 }
2128
2129 switch (expected_negotiated_version) {
2130 case MBEDTLS_SSL_VERSION_TLS1_2:
2131 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002132 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002133 break;
2134
2135 case MBEDTLS_SSL_VERSION_TLS1_3:
2136 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002137 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002138 break;
2139
2140 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002141 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002142 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002143 }
2144
2145 return 1;
2146
2147exit:
2148 return 0;
2149}
2150#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2151
Yanray Wange6afd912022-10-27 12:11:18 +08002152#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002153int mbedtls_test_ssl_do_handshake_with_endpoints(
2154 mbedtls_test_ssl_endpoint *server_ep,
2155 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002156 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002157 mbedtls_ssl_protocol_version proto)
2158{
2159 enum { BUFFSIZE = 1024 };
2160
2161 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002162
Max Fillingeree467aa2024-11-08 22:17:33 +01002163 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2164 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2165
Max Fillinger8f12e312024-10-30 00:29:37 +01002166 mbedtls_test_init_handshake_options(options);
2167 options->server_min_version = proto;
2168 options->client_min_version = proto;
2169 options->server_max_version = proto;
2170 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002171
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002172 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002173 if (ret != 0) {
2174 return ret;
2175 }
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002176 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002177 if (ret != 0) {
2178 return ret;
2179 }
2180
2181 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2182 if (ret != 0) {
2183 return ret;
2184 }
2185
Max Fillingerea1e7772024-10-30 00:49:10 +01002186 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2187 &client_ep->ssl,
2188 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002189 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2190 return ret;
2191 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002192 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2193 &server_ep->ssl,
2194 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002195 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2196 return ret;
2197 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002198 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2199 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002200 return -1;
2201 }
2202
2203 return 0;
2204}
2205#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2206
2207#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine78df6ae2025-05-27 21:14:25 +02002208
2209#if defined(MBEDTLS_SSL_RENEGOTIATION)
2210static int test_renegotiation(const mbedtls_test_handshake_test_options *options,
2211 mbedtls_test_ssl_endpoint *client,
2212 mbedtls_test_ssl_endpoint *server)
2213{
2214 int ok = 0;
2215 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2216
2217 (void) options; // only used in some configurations
2218
2219 /* Start test with renegotiation */
2220 TEST_EQUAL(server->ssl.renego_status,
2221 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2222 TEST_EQUAL(client->ssl.renego_status,
2223 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2224
2225 /* After calling this function for the server, it only sends a handshake
2226 * request. All renegotiation should happen during data exchanging */
2227 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server->ssl)), 0);
2228 TEST_EQUAL(server->ssl.renego_status,
2229 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2230 TEST_EQUAL(client->ssl.renego_status,
2231 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2232
2233 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2234 TEST_EQUAL(server->ssl.renego_status,
2235 MBEDTLS_SSL_RENEGOTIATION_DONE);
2236 TEST_EQUAL(client->ssl.renego_status,
2237 MBEDTLS_SSL_RENEGOTIATION_DONE);
2238
2239 /* After calling mbedtls_ssl_renegotiate for the client,
2240 * all renegotiation should happen inside this function.
2241 * However in this test, we cannot perform simultaneous communication
2242 * between client and server so this function will return waiting error
2243 * on the socket. All rest of renegotiation should happen
2244 * during data exchanging */
2245 ret = mbedtls_ssl_renegotiate(&(client->ssl));
2246#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2247 if (options->resize_buffers != 0) {
2248 /* Ensure that the buffer sizes are appropriate before resizes */
2249 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2250 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2251 }
2252#endif
2253 TEST_ASSERT(ret == 0 ||
2254 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2255 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
2256 TEST_EQUAL(server->ssl.renego_status,
2257 MBEDTLS_SSL_RENEGOTIATION_DONE);
2258 TEST_EQUAL(client->ssl.renego_status,
2259 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
2260
2261 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2262 TEST_EQUAL(server->ssl.renego_status,
2263 MBEDTLS_SSL_RENEGOTIATION_DONE);
2264 TEST_EQUAL(client->ssl.renego_status,
2265 MBEDTLS_SSL_RENEGOTIATION_DONE);
2266#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2267 /* Validate buffer sizes after renegotiation */
2268 if (options->resize_buffers != 0) {
2269 TEST_EQUAL(client->ssl.out_buf_len,
2270 mbedtls_ssl_get_output_buflen(&client->ssl));
2271 TEST_EQUAL(client->ssl.in_buf_len,
2272 mbedtls_ssl_get_input_buflen(&client->ssl));
2273 TEST_EQUAL(server->ssl.out_buf_len,
2274 mbedtls_ssl_get_output_buflen(&server->ssl));
2275 TEST_EQUAL(server->ssl.in_buf_len,
2276 mbedtls_ssl_get_input_buflen(&server->ssl));
2277 }
2278#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2279
2280 ok = 1;
2281
2282exit:
2283 return ok;
2284}
2285#endif /* MBEDTLS_SSL_RENEGOTIATION */
2286
Gilles Peskinee23a6d12025-05-27 21:17:09 +02002287#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2288static int test_serialization(const mbedtls_test_handshake_test_options *options,
2289 mbedtls_test_ssl_endpoint *client,
2290 mbedtls_test_ssl_endpoint *server)
2291{
2292 int ok = 0;
2293 unsigned char *context_buf = NULL;
2294 size_t context_buf_len;
2295
2296 TEST_EQUAL(options->dtls, 1);
2297
2298 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), NULL,
2299 0, &context_buf_len),
2300 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
2301
2302 context_buf = mbedtls_calloc(1, context_buf_len);
2303 TEST_ASSERT(context_buf != NULL);
2304
2305 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), context_buf,
2306 context_buf_len,
2307 &context_buf_len),
2308 0);
2309
2310 mbedtls_ssl_free(&(server->ssl));
2311 mbedtls_ssl_init(&(server->ssl));
2312
2313 TEST_EQUAL(mbedtls_ssl_setup(&(server->ssl), &(server->conf)), 0);
2314
2315 mbedtls_ssl_set_bio(&(server->ssl), &server->dtls_context,
2316 mbedtls_test_mock_tcp_send_msg,
2317 mbedtls_test_mock_tcp_recv_msg,
2318 NULL);
2319
2320 mbedtls_ssl_set_user_data_p(&server->ssl, server);
2321
2322#if defined(MBEDTLS_TIMING_C)
2323 mbedtls_ssl_set_timer_cb(&server->ssl, &server->timer,
2324 mbedtls_timing_set_delay,
2325 mbedtls_timing_get_delay);
2326#endif
2327#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2328 if (options->resize_buffers != 0) {
2329 /* Ensure that the buffer sizes are appropriate before resizes */
2330 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2331 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2332 }
2333#endif
2334 TEST_EQUAL(mbedtls_ssl_context_load(&(server->ssl), context_buf,
2335 context_buf_len), 0);
2336
2337#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2338 /* Validate buffer sizes after context deserialization */
2339 if (options->resize_buffers != 0) {
2340 TEST_EQUAL(server->ssl.out_buf_len,
2341 mbedtls_ssl_get_output_buflen(&server->ssl));
2342 TEST_EQUAL(server->ssl.in_buf_len,
2343 mbedtls_ssl_get_input_buflen(&server->ssl));
2344 }
2345#endif
2346 /* Retest writing/reading */
2347 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2348 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2349 &(client->ssl), options->cli_msg_len,
2350 options->expected_cli_fragments,
2351 &(server->ssl), options->srv_msg_len,
2352 options->expected_srv_fragments),
2353 0);
2354 }
2355
2356 ok = 1;
2357
2358exit:
2359 mbedtls_free(context_buf);
2360 return ok;
2361}
2362#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2363
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002364int mbedtls_test_ssl_perform_connection(
2365 const mbedtls_test_handshake_test_options *options,
2366 mbedtls_test_ssl_endpoint *client,
2367 mbedtls_test_ssl_endpoint *server)
2368{
2369 enum { BUFFSIZE = 17000 };
2370 int expected_handshake_result = options->expected_handshake_result;
2371 int ok = 0;
2372
2373 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client->socket),
2374 &(server->socket),
2375 BUFFSIZE), 0);
2376
2377#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2378 if (options->resize_buffers != 0) {
2379 /* Ensure that the buffer sizes are appropriate before resizes */
2380 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2381 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2382 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2383 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2384 }
2385#endif
2386
2387 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2388 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2389 }
2390
2391 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client->ssl),
2392 &(server->ssl),
2393 MBEDTLS_SSL_HANDSHAKE_OVER),
2394 expected_handshake_result);
2395
2396 if (expected_handshake_result != 0) {
2397 /* Connection will have failed by this point, skip to cleanup */
2398 ok = 1;
2399 goto exit;
2400 }
2401
2402 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client->ssl), 1);
2403
2404 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2405 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server->ssl),
2406 &(client->ssl),
2407 MBEDTLS_SSL_HANDSHAKE_OVER),
2408 0);
2409
2410 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server->ssl), 1);
2411
2412 /* Check that both sides have negotiated the expected version. */
2413 TEST_ASSERT(check_ssl_version(options->expected_negotiated_version,
2414 &client->ssl,
2415 &server->ssl));
2416
2417 if (options->expected_ciphersuite != 0) {
2418 TEST_EQUAL(server->ssl.session->ciphersuite,
2419 options->expected_ciphersuite);
2420 }
2421
2422#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2423 if (options->resize_buffers != 0) {
2424 /* A server, when using DTLS, might delay a buffer resize to happen
2425 * after it receives a message, so we force it. */
2426 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2427
2428 TEST_EQUAL(client->ssl.out_buf_len,
2429 mbedtls_ssl_get_output_buflen(&client->ssl));
2430 TEST_EQUAL(client->ssl.in_buf_len,
2431 mbedtls_ssl_get_input_buflen(&client->ssl));
2432 TEST_EQUAL(server->ssl.out_buf_len,
2433 mbedtls_ssl_get_output_buflen(&server->ssl));
2434 TEST_EQUAL(server->ssl.in_buf_len,
2435 mbedtls_ssl_get_input_buflen(&server->ssl));
2436 }
2437#endif
2438
2439 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2440 /* Start data exchanging test */
2441 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2442 &(client->ssl), options->cli_msg_len,
2443 options->expected_cli_fragments,
2444 &(server->ssl), options->srv_msg_len,
2445 options->expected_srv_fragments),
2446 0);
2447 }
2448#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2449 if (options->serialize == 1) {
2450 TEST_ASSERT(test_serialization(options, client, server));
2451 }
2452#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2453
2454#if defined(MBEDTLS_SSL_RENEGOTIATION)
2455 if (options->renegotiate) {
2456 TEST_ASSERT(test_renegotiation(options, client, server));
2457 }
2458#endif /* MBEDTLS_SSL_RENEGOTIATION */
2459
2460 ok = 1;
2461
2462exit:
2463 return ok;
2464}
2465
Yanray Wange6afd912022-10-27 12:11:18 +08002466void mbedtls_test_ssl_perform_handshake(
Gilles Peskine9b993682025-05-27 18:44:12 +02002467 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +08002468{
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002469 mbedtls_test_ssl_endpoint client_struct;
2470 memset(&client_struct, 0, sizeof(client_struct));
2471 mbedtls_test_ssl_endpoint *const client = &client_struct;
2472 mbedtls_test_ssl_endpoint server_struct;
2473 memset(&server_struct, 0, sizeof(server_struct));
2474 mbedtls_test_ssl_endpoint *const server = &server_struct;
Yanray Wange6afd912022-10-27 12:11:18 +08002475
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002476 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002477
Ronald Cronec3408d2024-01-16 17:50:40 +01002478#if defined(MBEDTLS_DEBUG_C)
2479 if (options->cli_log_fun || options->srv_log_fun) {
2480 mbedtls_debug_set_threshold(4);
2481 }
2482#endif
2483
Yanray Wange6afd912022-10-27 12:11:18 +08002484 /* Client side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002485 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(client,
Gilles Peskine07432b92025-05-27 21:07:44 +02002486 MBEDTLS_SSL_IS_CLIENT,
2487 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002488
Yanray Wange6afd912022-10-27 12:11:18 +08002489 /* Server side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002490 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(server,
Gilles Peskine07432b92025-05-27 21:07:44 +02002491 MBEDTLS_SSL_IS_SERVER,
2492 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002493
Gilles Peskineb092e782025-05-27 20:15:03 +02002494 if (options->dtls) {
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002495 TEST_EQUAL(mbedtls_test_ssl_dtls_join_endpoints(client, server), 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02002496 }
2497
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002498 TEST_ASSERT(mbedtls_test_ssl_perform_connection(options, client, server));
Yanray Wange6afd912022-10-27 12:11:18 +08002499
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002500 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client->conf) == client);
2501 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client->ssl) == client);
2502 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server->conf) == server);
2503 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server->ssl) == server);
Yanray Wange6afd912022-10-27 12:11:18 +08002504
2505exit:
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002506 mbedtls_test_ssl_endpoint_free(client);
2507 mbedtls_test_ssl_endpoint_free(server);
Yanray Wange6afd912022-10-27 12:11:18 +08002508#if defined(MBEDTLS_DEBUG_C)
2509 if (options->cli_log_fun || options->srv_log_fun) {
2510 mbedtls_debug_set_threshold(0);
2511 }
2512#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002513 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002514}
2515#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2516
2517#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002518int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002519 unsigned char *buf, unsigned char **end, int tweak,
2520 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2521{
2522/*
2523 * The definition of the tweaks assume that the certificate list contains only
2524 * one certificate.
2525 */
2526
2527/*
2528 * struct {
2529 * opaque cert_data<1..2^24-1>;
2530 * Extension extensions<0..2^16-1>;
2531 * } CertificateEntry;
2532 *
2533 * struct {
2534 * opaque certificate_request_context<0..2^8-1>;
2535 * CertificateEntry certificate_list<0..2^24-1>;
2536 * } Certificate;
2537 */
2538 unsigned char *p_certificate_request_context_len = buf;
2539 size_t certificate_request_context_len = buf[0];
2540
2541 unsigned char *p_certificate_list_len =
2542 buf + 1 + certificate_request_context_len;
2543 unsigned char *certificate_list = p_certificate_list_len + 3;
2544 size_t certificate_list_len =
2545 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2546
2547 unsigned char *p_cert_data_len = certificate_list;
2548 unsigned char *cert_data = p_cert_data_len + 3;
2549 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2550
2551 unsigned char *p_extensions_len = cert_data + cert_data_len;
2552 unsigned char *extensions = p_extensions_len + 2;
2553 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2554
2555 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2556
2557 switch (tweak) {
2558 case 1:
2559 /* Failure when checking if the certificate request context length
2560 * and certificate list length can be read
2561 */
2562 *end = buf + 3;
2563 set_chk_buf_ptr_args(args, buf, *end, 4);
2564 break;
2565
2566 case 2:
2567 /* Invalid certificate request context length.
2568 */
2569 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002570 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002571 reset_chk_buf_ptr_args(args);
2572 break;
2573
2574 case 3:
2575 /* Failure when checking if certificate_list data can be read. */
2576 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2577 p_certificate_list_len, 0);
2578 set_chk_buf_ptr_args(args, certificate_list, *end,
2579 certificate_list_len + 1);
2580 break;
2581
2582 case 4:
2583 /* Failure when checking if the cert_data length can be read. */
2584 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2585 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2586 break;
2587
2588 case 5:
2589 /* Failure when checking if cert_data data can be read. */
2590 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2591 p_cert_data_len, 0);
2592 set_chk_buf_ptr_args(args, cert_data,
2593 certificate_list + certificate_list_len,
2594 certificate_list_len - 3 + 1);
2595 break;
2596
2597 case 6:
2598 /* Failure when checking if the extensions length can be read. */
2599 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2600 p_certificate_list_len, 0);
2601 set_chk_buf_ptr_args(
2602 args, p_extensions_len,
2603 certificate_list + certificate_list_len - extensions_len - 1, 2);
2604 break;
2605
2606 case 7:
2607 /* Failure when checking if extensions data can be read. */
2608 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2609
2610 set_chk_buf_ptr_args(
2611 args, extensions,
2612 certificate_list + certificate_list_len, extensions_len + 1);
2613 break;
2614
2615 default:
2616 return -1;
2617 }
2618
2619 return 0;
2620}
2621#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002622
Ronald Cronfaf026c2024-01-31 14:32:06 +01002623/*
2624 * Functions for tests based on tickets. Implementations of the
2625 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2626 * Basically same implementations as in ticket.c without the encryption. That
2627 * way we can tweak easily tickets characteristics to simulate misbehaving
2628 * peers.
2629 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002630#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2631int mbedtls_test_ticket_write(
2632 void *p_ticket, const mbedtls_ssl_session *session,
2633 unsigned char *start, const unsigned char *end,
2634 size_t *tlen, uint32_t *lifetime)
2635{
2636 int ret;
2637 ((void) p_ticket);
2638
2639 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2640 tlen)) != 0) {
2641 return ret;
2642 }
2643
2644 /* Maximum ticket lifetime as defined in RFC 8446 */
2645 *lifetime = 7 * 24 * 3600;
2646
2647 return 0;
2648}
2649
2650int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2651 unsigned char *buf, size_t len)
2652{
2653 ((void) p_ticket);
2654
2655 return mbedtls_ssl_session_load(session, buf, len);
2656}
2657#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002658
2659#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2660 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2661 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2662int mbedtls_test_get_tls13_ticket(
2663 mbedtls_test_handshake_test_options *client_options,
2664 mbedtls_test_handshake_test_options *server_options,
2665 mbedtls_ssl_session *session)
2666{
2667 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002668 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002669 unsigned char buf[64];
2670 mbedtls_test_ssl_endpoint client_ep, server_ep;
2671
2672 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2673 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2674
2675 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002676 client_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002677 TEST_EQUAL(ret, 0);
2678
2679 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002680 server_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002681 TEST_EQUAL(ret, 0);
2682
2683 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2684 mbedtls_test_ticket_write,
2685 mbedtls_test_ticket_parse,
2686 NULL);
2687
2688 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2689 &(server_ep.socket), 1024);
2690 TEST_EQUAL(ret, 0);
2691
2692 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2693 &(server_ep.ssl), &(client_ep.ssl),
2694 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2695
2696 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2697
2698 do {
2699 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2700 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2701
2702 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2703 TEST_EQUAL(ret, 0);
2704
Gilles Peskine946bf142025-04-08 09:48:40 +02002705 ok = 1;
2706
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002707exit:
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002708 mbedtls_test_ssl_endpoint_free(&client_ep);
2709 mbedtls_test_ssl_endpoint_free(&server_ep);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002710
Gilles Peskine946bf142025-04-08 09:48:40 +02002711 if (ret == 0 && !ok) {
2712 /* Exiting due to a test assertion that isn't ret == 0 */
2713 ret = -1;
2714 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002715 return ret;
2716}
2717#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2718 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2719 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2720
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002721#endif /* MBEDTLS_SSL_TLS_C */