blob: e6c082eacbfcbe7c56276fcdc2ad45c4b8ddaaf7 [file] [log] [blame]
Yanray Wang47907a42022-10-24 14:42:01 +08001/** \file ssl_helpers.c
2 *
3 * \brief Helper functions to set up a TLS connection.
4 */
5
6/*
7 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Yanray Wang47907a42022-10-24 14:42:01 +08009 */
10
11#include <test/ssl_helpers.h>
Valerio Setti384fbde2024-01-02 13:26:40 +010012#include "mbedtls/psa_util.h"
Yanray Wange6afd912022-10-27 12:11:18 +080013
Yanray Wang4d07d1c2022-10-27 15:28:16 +080014#if defined(MBEDTLS_SSL_TLS_C)
Ronald Cron10b040f2024-02-05 09:38:09 +010015int mbedtls_test_random(void *p_rng, unsigned char *output, size_t output_len)
Yanray Wange6afd912022-10-27 12:11:18 +080016{
17 (void) p_rng;
18 for (size_t i = 0; i < output_len; i++) {
19 output[i] = rand();
20 }
21
22 return 0;
23}
Yanray Wange6afd912022-10-27 12:11:18 +080024
Yanray Wange6afd912022-10-27 12:11:18 +080025void mbedtls_test_ssl_log_analyzer(void *ctx, int level,
26 const char *file, int line,
27 const char *str)
28{
29 mbedtls_test_ssl_log_pattern *p = (mbedtls_test_ssl_log_pattern *) ctx;
30
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010031/* Change 0 to 1 for debugging of test cases that use this function. */
32#if 0
33 const char *q, *basename;
34 /* Extract basename from file */
35 for (q = basename = file; *q != '\0'; q++) {
36 if (*q == '/' || *q == '\\') {
37 basename = q + 1;
38 }
39 }
40 printf("%s:%04d: |%d| %s",
41 basename, line, level, str);
42#else
Yanray Wange6afd912022-10-27 12:11:18 +080043 (void) level;
44 (void) line;
45 (void) file;
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010046#endif
Yanray Wange6afd912022-10-27 12:11:18 +080047
48 if (NULL != p &&
49 NULL != p->pattern &&
50 NULL != strstr(str, p->pattern)) {
51 p->counter++;
52 }
53}
54
55void mbedtls_test_init_handshake_options(
56 mbedtls_test_handshake_test_options *opts)
57{
58#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron987cf892024-03-04 10:24:27 +010059 static int rng_seed = 0xBEEF;
Yanray Wanga72bc9a2023-12-01 23:34:27 +080060
Yanray Wange6afd912022-10-27 12:11:18 +080061 srand(rng_seed);
62 rng_seed += 0xD0;
63#endif
Ronald Cronb4ad3e72024-01-26 14:57:53 +010064
65 memset(opts, 0, sizeof(*opts));
66
Yanray Wange6afd912022-10-27 12:11:18 +080067 opts->cipher = "";
68 opts->client_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
69 opts->client_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
70 opts->server_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
71 opts->server_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
Ronald Cron097ba142023-03-08 16:18:00 +010072 opts->expected_negotiated_version = MBEDTLS_SSL_VERSION_TLS1_3;
Yanray Wange6afd912022-10-27 12:11:18 +080073 opts->pk_alg = MBEDTLS_PK_RSA;
Gilles Peskinefb2ce052025-05-28 17:36:12 +020074 opts->srv_auth_mode = MBEDTLS_SSL_VERIFY_REQUIRED;
Yanray Wange6afd912022-10-27 12:11:18 +080075 opts->mfl = MBEDTLS_SSL_MAX_FRAG_LEN_NONE;
76 opts->cli_msg_len = 100;
77 opts->srv_msg_len = 100;
78 opts->expected_cli_fragments = 1;
79 opts->expected_srv_fragments = 1;
Yanray Wange6afd912022-10-27 12:11:18 +080080 opts->legacy_renegotiation = MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION;
Yanray Wange6afd912022-10-27 12:11:18 +080081 opts->resize_buffers = 1;
Ronald Cronced99be2024-01-26 15:49:12 +010082 opts->early_data = MBEDTLS_SSL_EARLY_DATA_DISABLED;
Ronald Cron5d3036e2024-02-23 07:43:45 +010083 opts->max_early_data_size = -1;
Yanray Wange6afd912022-10-27 12:11:18 +080084#if defined(MBEDTLS_SSL_CACHE_C)
Tom Cosgrove05b2a872023-07-21 11:31:13 +010085 TEST_CALLOC(opts->cache, 1);
Yanray Wange6afd912022-10-27 12:11:18 +080086 mbedtls_ssl_cache_init(opts->cache);
Pengyu Lv5cbb93e2023-07-10 11:09:40 +080087#if defined(MBEDTLS_HAVE_TIME)
88 TEST_EQUAL(mbedtls_ssl_cache_get_timeout(opts->cache),
89 MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT);
90#endif
Yanray Wange6afd912022-10-27 12:11:18 +080091exit:
92 return;
93#endif
94}
95
96void mbedtls_test_free_handshake_options(
97 mbedtls_test_handshake_test_options *opts)
98{
99#if defined(MBEDTLS_SSL_CACHE_C)
100 mbedtls_ssl_cache_free(opts->cache);
101 mbedtls_free(opts->cache);
102#else
103 (void) opts;
104#endif
105}
106
107#if defined(MBEDTLS_TEST_HOOKS)
108static void set_chk_buf_ptr_args(
109 mbedtls_ssl_chk_buf_ptr_args *args,
110 unsigned char *cur, unsigned char *end, size_t need)
111{
112 args->cur = cur;
113 args->end = end;
114 args->need = need;
115}
116
117static void reset_chk_buf_ptr_args(mbedtls_ssl_chk_buf_ptr_args *args)
118{
119 memset(args, 0, sizeof(*args));
120}
121#endif /* MBEDTLS_TEST_HOOKS */
122
Yanray Wange6afd912022-10-27 12:11:18 +0800123void mbedtls_test_ssl_buffer_init(mbedtls_test_ssl_buffer *buf)
124{
125 memset(buf, 0, sizeof(*buf));
126}
127
Yanray Wange6afd912022-10-27 12:11:18 +0800128int mbedtls_test_ssl_buffer_setup(mbedtls_test_ssl_buffer *buf,
129 size_t capacity)
130{
131 buf->buffer = (unsigned char *) mbedtls_calloc(capacity,
132 sizeof(unsigned char));
133 if (NULL == buf->buffer) {
134 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
135 }
136 buf->capacity = capacity;
137
138 return 0;
139}
140
141void mbedtls_test_ssl_buffer_free(mbedtls_test_ssl_buffer *buf)
142{
143 if (buf->buffer != NULL) {
144 mbedtls_free(buf->buffer);
145 }
146
147 memset(buf, 0, sizeof(*buf));
148}
149
Yanray Wange6afd912022-10-27 12:11:18 +0800150int mbedtls_test_ssl_buffer_put(mbedtls_test_ssl_buffer *buf,
151 const unsigned char *input, size_t input_len)
152{
153 size_t overflow = 0;
154
155 if ((buf == NULL) || (buf->buffer == NULL)) {
156 return -1;
157 }
158
159 /* Reduce input_len to a number that fits in the buffer. */
160 if ((buf->content_length + input_len) > buf->capacity) {
161 input_len = buf->capacity - buf->content_length;
162 }
163
164 if (input == NULL) {
165 return (input_len == 0) ? 0 : -1;
166 }
167
168 /* Check if the buffer has not come full circle and free space is not in
169 * the middle */
170 if (buf->start + buf->content_length < buf->capacity) {
171
172 /* Calculate the number of bytes that need to be placed at lower memory
173 * address */
174 if (buf->start + buf->content_length + input_len
175 > buf->capacity) {
176 overflow = (buf->start + buf->content_length + input_len)
177 % buf->capacity;
178 }
179
180 memcpy(buf->buffer + buf->start + buf->content_length, input,
181 input_len - overflow);
182 memcpy(buf->buffer, input + input_len - overflow, overflow);
183
184 } else {
185 /* The buffer has come full circle and free space is in the middle */
186 memcpy(buf->buffer + buf->start + buf->content_length - buf->capacity,
187 input, input_len);
188 }
189
190 buf->content_length += input_len;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800191 return (input_len > INT_MAX) ? INT_MAX : (int) input_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800192}
193
Yanray Wange6afd912022-10-27 12:11:18 +0800194int mbedtls_test_ssl_buffer_get(mbedtls_test_ssl_buffer *buf,
195 unsigned char *output, size_t output_len)
196{
197 size_t overflow = 0;
198
199 if ((buf == NULL) || (buf->buffer == NULL)) {
200 return -1;
201 }
202
203 if (output == NULL && output_len == 0) {
204 return 0;
205 }
206
207 if (buf->content_length < output_len) {
208 output_len = buf->content_length;
209 }
210
211 /* Calculate the number of bytes that need to be drawn from lower memory
212 * address */
213 if (buf->start + output_len > buf->capacity) {
214 overflow = (buf->start + output_len) % buf->capacity;
215 }
216
217 if (output != NULL) {
218 memcpy(output, buf->buffer + buf->start, output_len - overflow);
219 memcpy(output + output_len - overflow, buf->buffer, overflow);
220 }
221
222 buf->content_length -= output_len;
223 buf->start = (buf->start + output_len) % buf->capacity;
224
Yanray Wanga8f445e2022-11-03 11:51:59 +0800225 return (output_len > INT_MAX) ? INT_MAX : (int) output_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800226}
227
Yanray Wangd19894f2023-03-16 11:47:39 +0800228int mbedtls_test_ssl_message_queue_setup(
229 mbedtls_test_ssl_message_queue *queue, size_t capacity)
Yanray Wange6afd912022-10-27 12:11:18 +0800230{
231 queue->messages = (size_t *) mbedtls_calloc(capacity, sizeof(size_t));
232 if (NULL == queue->messages) {
233 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
234 }
235
Yanray Wanga8f445e2022-11-03 11:51:59 +0800236 queue->capacity = (capacity > INT_MAX) ? INT_MAX : (int) capacity;
Yanray Wange6afd912022-10-27 12:11:18 +0800237 queue->pos = 0;
238 queue->num = 0;
239
240 return 0;
241}
242
Yanray Wangd19894f2023-03-16 11:47:39 +0800243void mbedtls_test_ssl_message_queue_free(
244 mbedtls_test_ssl_message_queue *queue)
Yanray Wange6afd912022-10-27 12:11:18 +0800245{
246 if (queue == NULL) {
247 return;
248 }
249
250 if (queue->messages != NULL) {
251 mbedtls_free(queue->messages);
252 }
253
254 memset(queue, 0, sizeof(*queue));
255}
256
Yanray Wange6afd912022-10-27 12:11:18 +0800257int mbedtls_test_ssl_message_queue_push_info(
258 mbedtls_test_ssl_message_queue *queue, size_t len)
259{
260 int place;
261 if (queue == NULL) {
262 return MBEDTLS_TEST_ERROR_ARG_NULL;
263 }
264
265 if (queue->num >= queue->capacity) {
266 return MBEDTLS_ERR_SSL_WANT_WRITE;
267 }
268
269 place = (queue->pos + queue->num) % queue->capacity;
270 queue->messages[place] = len;
271 queue->num++;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800272 return (len > INT_MAX) ? INT_MAX : (int) len;
Yanray Wange6afd912022-10-27 12:11:18 +0800273}
274
Yanray Wange6afd912022-10-27 12:11:18 +0800275int mbedtls_test_ssl_message_queue_pop_info(
276 mbedtls_test_ssl_message_queue *queue, size_t buf_len)
277{
278 size_t message_length;
279 if (queue == NULL) {
280 return MBEDTLS_TEST_ERROR_ARG_NULL;
281 }
282 if (queue->num == 0) {
283 return MBEDTLS_ERR_SSL_WANT_READ;
284 }
285
286 message_length = queue->messages[queue->pos];
287 queue->messages[queue->pos] = 0;
288 queue->num--;
289 queue->pos++;
290 queue->pos %= queue->capacity;
291 if (queue->pos < 0) {
292 queue->pos += queue->capacity;
293 }
294
Yanray Wanga8f445e2022-11-03 11:51:59 +0800295 return (message_length > INT_MAX && buf_len > INT_MAX) ? INT_MAX :
296 (message_length > buf_len) ? (int) buf_len : (int) message_length;
Yanray Wange6afd912022-10-27 12:11:18 +0800297}
298
299/*
300 * Take a peek on the info about the next message length from the queue.
301 * This will be the oldest inserted message length(fifo).
302 *
303 * \retval MBEDTLS_TEST_ERROR_ARG_NULL, if the queue is null.
304 * \retval MBEDTLS_ERR_SSL_WANT_READ, if the queue is empty.
305 * \retval 0, if the peek was successful.
306 * \retval MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED, if the given buffer length is
307 * too small to fit the message. In this case the \p msg_len will be
308 * set to the full message length so that the
309 * caller knows what portion of the message can be dropped.
310 */
Yanray Wang5e22a922023-03-16 14:57:54 +0800311static int test_ssl_message_queue_peek_info(
312 mbedtls_test_ssl_message_queue *queue,
313 size_t buf_len, size_t *msg_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800314{
315 if (queue == NULL || msg_len == NULL) {
316 return MBEDTLS_TEST_ERROR_ARG_NULL;
317 }
318 if (queue->num == 0) {
319 return MBEDTLS_ERR_SSL_WANT_READ;
320 }
321
322 *msg_len = queue->messages[queue->pos];
323 return (*msg_len > buf_len) ? MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED : 0;
324}
325
Yanray Wang5f86a422023-03-15 16:02:29 +0800326void mbedtls_test_mock_socket_init(mbedtls_test_mock_socket *socket)
Yanray Wange6afd912022-10-27 12:11:18 +0800327{
328 memset(socket, 0, sizeof(*socket));
329}
330
Yanray Wange6afd912022-10-27 12:11:18 +0800331void mbedtls_test_mock_socket_close(mbedtls_test_mock_socket *socket)
332{
333 if (socket == NULL) {
334 return;
335 }
336
337 if (socket->input != NULL) {
338 mbedtls_test_ssl_buffer_free(socket->input);
339 mbedtls_free(socket->input);
340 }
341
342 if (socket->output != NULL) {
343 mbedtls_test_ssl_buffer_free(socket->output);
344 mbedtls_free(socket->output);
345 }
346
347 if (socket->peer != NULL) {
348 memset(socket->peer, 0, sizeof(*socket->peer));
349 }
350
351 memset(socket, 0, sizeof(*socket));
352}
353
Yanray Wange6afd912022-10-27 12:11:18 +0800354int mbedtls_test_mock_socket_connect(mbedtls_test_mock_socket *peer1,
355 mbedtls_test_mock_socket *peer2,
356 size_t bufsize)
357{
358 int ret = -1;
359
360 peer1->output =
361 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
362 1, sizeof(mbedtls_test_ssl_buffer));
363 if (peer1->output == NULL) {
364 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
365 goto exit;
366 }
367 mbedtls_test_ssl_buffer_init(peer1->output);
368 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer1->output, bufsize))) {
369 goto exit;
370 }
371
372 peer2->output =
373 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
374 1, sizeof(mbedtls_test_ssl_buffer));
375 if (peer2->output == NULL) {
376 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
377 goto exit;
378 }
379 mbedtls_test_ssl_buffer_init(peer2->output);
380 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer2->output, bufsize))) {
381 goto exit;
382 }
383
384 peer1->peer = peer2;
385 peer2->peer = peer1;
386 peer1->input = peer2->output;
387 peer2->input = peer1->output;
388
389 peer1->status = peer2->status = MBEDTLS_MOCK_SOCKET_CONNECTED;
390 ret = 0;
391
392exit:
393
394 if (ret != 0) {
395 mbedtls_test_mock_socket_close(peer1);
396 mbedtls_test_mock_socket_close(peer2);
397 }
398
399 return ret;
400}
401
Yanray Wangaf727a22023-03-13 19:22:36 +0800402int mbedtls_test_mock_tcp_send_b(void *ctx,
403 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800404{
405 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
406
407 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
408 return -1;
409 }
410
411 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
412}
413
414int mbedtls_test_mock_tcp_recv_b(void *ctx, unsigned char *buf, size_t len)
415{
416 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
417
418 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
419 return -1;
420 }
421
422 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
423}
424
Yanray Wang34634352023-02-14 17:56:51 +0800425int mbedtls_test_mock_tcp_send_nb(void *ctx,
426 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800427{
428 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
429
430 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
431 return -1;
432 }
433
434 if (socket->output->capacity == socket->output->content_length) {
435 return MBEDTLS_ERR_SSL_WANT_WRITE;
436 }
437
438 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
439}
440
441int mbedtls_test_mock_tcp_recv_nb(void *ctx, unsigned char *buf, size_t len)
442{
443 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
444
445 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
446 return -1;
447 }
448
449 if (socket->input->content_length == 0) {
450 return MBEDTLS_ERR_SSL_WANT_READ;
451 }
452
453 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
454}
455
Yanray Wangd19894f2023-03-16 11:47:39 +0800456void mbedtls_test_message_socket_init(
457 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800458{
459 ctx->queue_input = NULL;
460 ctx->queue_output = NULL;
461 ctx->socket = NULL;
462}
463
Yanray Wange6afd912022-10-27 12:11:18 +0800464int mbedtls_test_message_socket_setup(
465 mbedtls_test_ssl_message_queue *queue_input,
466 mbedtls_test_ssl_message_queue *queue_output,
467 size_t queue_capacity,
468 mbedtls_test_mock_socket *socket,
469 mbedtls_test_message_socket_context *ctx)
470{
471 int ret = mbedtls_test_ssl_message_queue_setup(queue_input, queue_capacity);
472 if (ret != 0) {
473 return ret;
474 }
475 ctx->queue_input = queue_input;
476 ctx->queue_output = queue_output;
477 ctx->socket = socket;
Yanray Wang5f86a422023-03-15 16:02:29 +0800478 mbedtls_test_mock_socket_init(socket);
Yanray Wange6afd912022-10-27 12:11:18 +0800479
480 return 0;
481}
482
Yanray Wangd19894f2023-03-16 11:47:39 +0800483void mbedtls_test_message_socket_close(
484 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800485{
486 if (ctx == NULL) {
487 return;
488 }
489
490 mbedtls_test_ssl_message_queue_free(ctx->queue_input);
491 mbedtls_test_mock_socket_close(ctx->socket);
492 memset(ctx, 0, sizeof(*ctx));
493}
494
Yanray Wang34634352023-02-14 17:56:51 +0800495int mbedtls_test_mock_tcp_send_msg(void *ctx,
496 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800497{
498 mbedtls_test_ssl_message_queue *queue;
499 mbedtls_test_mock_socket *socket;
500 mbedtls_test_message_socket_context *context =
501 (mbedtls_test_message_socket_context *) ctx;
502
503 if (context == NULL || context->socket == NULL
504 || context->queue_output == NULL) {
505 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
506 }
507
508 queue = context->queue_output;
509 socket = context->socket;
510
511 if (queue->num >= queue->capacity) {
512 return MBEDTLS_ERR_SSL_WANT_WRITE;
513 }
514
515 if (mbedtls_test_mock_tcp_send_b(socket, buf, len) != (int) len) {
516 return MBEDTLS_TEST_ERROR_SEND_FAILED;
517 }
518
519 return mbedtls_test_ssl_message_queue_push_info(queue, len);
520}
521
Yanray Wang34634352023-02-14 17:56:51 +0800522int mbedtls_test_mock_tcp_recv_msg(void *ctx,
523 unsigned char *buf, size_t buf_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800524{
525 mbedtls_test_ssl_message_queue *queue;
526 mbedtls_test_mock_socket *socket;
527 mbedtls_test_message_socket_context *context =
528 (mbedtls_test_message_socket_context *) ctx;
529 size_t drop_len = 0;
530 size_t msg_len;
531 int ret;
532
533 if (context == NULL || context->socket == NULL
534 || context->queue_input == NULL) {
535 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
536 }
537
538 queue = context->queue_input;
539 socket = context->socket;
540
541 /* Peek first, so that in case of a socket error the data remains in
542 * the queue. */
Yanray Wang5e22a922023-03-16 14:57:54 +0800543 ret = test_ssl_message_queue_peek_info(queue, buf_len, &msg_len);
Yanray Wange6afd912022-10-27 12:11:18 +0800544 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
545 /* Calculate how much to drop */
546 drop_len = msg_len - buf_len;
547
548 /* Set the requested message len to be buffer length */
549 msg_len = buf_len;
550 } else if (ret != 0) {
551 return ret;
552 }
553
554 if (mbedtls_test_mock_tcp_recv_b(socket, buf, msg_len) != (int) msg_len) {
555 return MBEDTLS_TEST_ERROR_RECV_FAILED;
556 }
557
558 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
559 /* Drop the remaining part of the message */
Yanray Wangaf727a22023-03-13 19:22:36 +0800560 if (mbedtls_test_mock_tcp_recv_b(socket, NULL, drop_len) !=
561 (int) drop_len) {
Yanray Wange6afd912022-10-27 12:11:18 +0800562 /* Inconsistent state - part of the message was read,
563 * and a part couldn't. Not much we can do here, but it should not
564 * happen in test environment, unless forced manually. */
565 }
566 }
Tomás Gonzáleza9b90de2024-02-01 11:12:20 +0000567 ret = mbedtls_test_ssl_message_queue_pop_info(queue, buf_len);
568 if (ret < 0) {
569 return ret;
570 }
Yanray Wange6afd912022-10-27 12:11:18 +0800571
Yanray Wanga8f445e2022-11-03 11:51:59 +0800572 return (msg_len > INT_MAX) ? INT_MAX : (int) msg_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800573}
574
Gilles Peskine27586d82025-05-28 17:01:42 +0200575
576#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
577 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
578 defined(MBEDTLS_SSL_SRV_C)
579static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
580 const unsigned char *name, size_t name_len)
581{
582 (void) p_info;
583 (void) ssl;
584 (void) name;
585 (void) name_len;
586
587 return 0;
588}
589#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
590 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
591 MBEDTLS_SSL_SRV_C */
592
Yanray Wange6afd912022-10-27 12:11:18 +0800593#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
594
Gilles Peskine27586d82025-05-28 17:01:42 +0200595static int set_ciphersuite(mbedtls_test_ssl_endpoint *ep,
596 const char *cipher)
597{
598 if (cipher == NULL || cipher[0] == 0) {
599 return 1;
600 }
601
602 int ok = 0;
603
604 TEST_CALLOC(ep->ciphersuites, 2);
605 ep->ciphersuites[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
606 ep->ciphersuites[1] = 0;
607
608 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
609 mbedtls_ssl_ciphersuite_from_id(ep->ciphersuites[0]);
610
611 TEST_ASSERT(ciphersuite_info != NULL);
612 TEST_ASSERT(ciphersuite_info->min_tls_version <= ep->conf.max_tls_version);
613 TEST_ASSERT(ciphersuite_info->max_tls_version >= ep->conf.min_tls_version);
614
615 if (ep->conf.max_tls_version > ciphersuite_info->max_tls_version) {
616 ep->conf.max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
617 }
618 if (ep->conf.min_tls_version < ciphersuite_info->min_tls_version) {
619 ep->conf.min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
620 }
621
622 mbedtls_ssl_conf_ciphersuites(&ep->conf, ep->ciphersuites);
623 ok = 1;
624
625exit:
626 return ok;
627}
628
Yanray Wange6afd912022-10-27 12:11:18 +0800629/*
630 * Deinitializes certificates from endpoint represented by \p ep.
631 */
Yanray Wangf6f71902023-03-15 16:05:14 +0800632static void test_ssl_endpoint_certificate_free(mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +0800633{
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200634 if (ep->ca_chain != NULL) {
635 mbedtls_x509_crt_free(ep->ca_chain);
636 mbedtls_free(ep->ca_chain);
637 ep->ca_chain = NULL;
638 }
639 if (ep->cert != NULL) {
640 mbedtls_x509_crt_free(ep->cert);
641 mbedtls_free(ep->cert);
642 ep->cert = NULL;
643 }
644 if (ep->pkey != NULL) {
Yanray Wange6afd912022-10-27 12:11:18 +0800645#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200646 if (mbedtls_pk_get_type(ep->pkey) == MBEDTLS_PK_OPAQUE) {
647 psa_destroy_key(ep->pkey->priv_id);
Yanray Wange6afd912022-10-27 12:11:18 +0800648 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200649#endif
650 mbedtls_pk_free(ep->pkey);
651 mbedtls_free(ep->pkey);
652 ep->pkey = NULL;
Yanray Wange6afd912022-10-27 12:11:18 +0800653 }
654}
655
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200656static int load_endpoint_rsa(mbedtls_test_ssl_endpoint *ep)
657{
658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
659 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
660 ret = mbedtls_x509_crt_parse(
661 ep->cert,
662 (const unsigned char *) mbedtls_test_srv_crt_rsa_sha256_der,
663 mbedtls_test_srv_crt_rsa_sha256_der_len);
664 TEST_EQUAL(ret, 0);
665 ret = mbedtls_pk_parse_key(
666 ep->pkey,
667 (const unsigned char *) mbedtls_test_srv_key_rsa_der,
668 mbedtls_test_srv_key_rsa_der_len, NULL, 0);
669 TEST_EQUAL(ret, 0);
670 } else {
671 ret = mbedtls_x509_crt_parse(
672 ep->cert,
673 (const unsigned char *) mbedtls_test_cli_crt_rsa_der,
674 mbedtls_test_cli_crt_rsa_der_len);
675 TEST_EQUAL(ret, 0);
676 ret = mbedtls_pk_parse_key(
677 ep->pkey,
678 (const unsigned char *) mbedtls_test_cli_key_rsa_der,
679 mbedtls_test_cli_key_rsa_der_len, NULL, 0);
680 TEST_EQUAL(ret, 0);
681 }
682
683exit:
684 return ret;
685}
686
687static int load_endpoint_ecc(mbedtls_test_ssl_endpoint *ep)
688{
689 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
690 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
691 ret = mbedtls_x509_crt_parse(
692 ep->cert,
693 (const unsigned char *) mbedtls_test_srv_crt_ec_der,
694 mbedtls_test_srv_crt_ec_der_len);
695 TEST_EQUAL(ret, 0);
696 ret = mbedtls_pk_parse_key(
697 ep->pkey,
698 (const unsigned char *) mbedtls_test_srv_key_ec_der,
699 mbedtls_test_srv_key_ec_der_len, NULL, 0);
700 TEST_EQUAL(ret, 0);
701 } else {
702 ret = mbedtls_x509_crt_parse(
703 ep->cert,
704 (const unsigned char *) mbedtls_test_cli_crt_ec_der,
705 mbedtls_test_cli_crt_ec_len);
706 TEST_EQUAL(ret, 0);
707 ret = mbedtls_pk_parse_key(
708 ep->pkey,
709 (const unsigned char *) mbedtls_test_cli_key_ec_der,
710 mbedtls_test_cli_key_ec_der_len, NULL, 0);
711 TEST_EQUAL(ret, 0);
712 }
713
714exit:
715 return ret;
716}
717
Yanray Wange6afd912022-10-27 12:11:18 +0800718int mbedtls_test_ssl_endpoint_certificate_init(mbedtls_test_ssl_endpoint *ep,
719 int pk_alg,
720 int opaque_alg, int opaque_alg2,
721 int opaque_usage)
722{
723 int i = 0;
724 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +0200725 int ok = 0;
Yanray Wange6afd912022-10-27 12:11:18 +0800726#if defined(MBEDTLS_USE_PSA_CRYPTO)
727 mbedtls_svc_key_id_t key_slot = MBEDTLS_SVC_KEY_ID_INIT;
728#endif
729
730 if (ep == NULL) {
731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
732 }
733
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200734 TEST_CALLOC(ep->ca_chain, 1);
735 TEST_CALLOC(ep->cert, 1);
736 TEST_CALLOC(ep->pkey, 1);
Yanray Wange6afd912022-10-27 12:11:18 +0800737
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200738 mbedtls_x509_crt_init(ep->ca_chain);
739 mbedtls_x509_crt_init(ep->cert);
740 mbedtls_pk_init(ep->pkey);
Yanray Wange6afd912022-10-27 12:11:18 +0800741
742 /* Load the trusted CA */
743
744 for (i = 0; mbedtls_test_cas_der[i] != NULL; i++) {
745 ret = mbedtls_x509_crt_parse_der(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200746 ep->ca_chain,
Yanray Wange6afd912022-10-27 12:11:18 +0800747 (const unsigned char *) mbedtls_test_cas_der[i],
748 mbedtls_test_cas_der_len[i]);
Gilles Peskine353eb332025-05-14 17:42:53 +0200749 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800750 }
751
752 /* Load own certificate and private key */
753
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200754 if (pk_alg == MBEDTLS_PK_RSA) {
755 TEST_EQUAL(load_endpoint_rsa(ep), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800756 } else {
Gilles Peskine6e4d2452025-05-27 17:13:52 +0200757 TEST_EQUAL(load_endpoint_ecc(ep), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800758 }
759
760#if defined(MBEDTLS_USE_PSA_CRYPTO)
761 if (opaque_alg != 0) {
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100762 psa_key_attributes_t key_attr = PSA_KEY_ATTRIBUTES_INIT;
763 /* Use a fake key usage to get a successful initial guess for the PSA attributes. */
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200764 TEST_EQUAL(mbedtls_pk_get_psa_attributes(ep->pkey, PSA_KEY_USAGE_SIGN_HASH,
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100765 &key_attr), 0);
Valerio Settia9de9442024-02-27 13:56:09 +0100766 /* Then manually usage, alg and alg2 as requested by the test. */
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100767 psa_set_key_usage_flags(&key_attr, opaque_usage);
768 psa_set_key_algorithm(&key_attr, opaque_alg);
769 if (opaque_alg2 != PSA_ALG_NONE) {
770 psa_set_key_enrollment_algorithm(&key_attr, opaque_alg2);
771 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200772 TEST_EQUAL(mbedtls_pk_import_into_psa(ep->pkey, &key_attr, &key_slot), 0);
773 mbedtls_pk_free(ep->pkey);
774 mbedtls_pk_init(ep->pkey);
775 TEST_EQUAL(mbedtls_pk_setup_opaque(ep->pkey, key_slot), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800776 }
777#else
778 (void) opaque_alg;
779 (void) opaque_alg2;
780 (void) opaque_usage;
781#endif
782
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200783 mbedtls_ssl_conf_ca_chain(&(ep->conf), ep->ca_chain, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +0800784
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200785 ret = mbedtls_ssl_conf_own_cert(&(ep->conf), ep->cert,
786 ep->pkey);
Gilles Peskine353eb332025-05-14 17:42:53 +0200787 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800788
Gilles Peskine946bf142025-04-08 09:48:40 +0200789 ok = 1;
790
Yanray Wange6afd912022-10-27 12:11:18 +0800791exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200792 if (ret == 0 && !ok) {
793 /* Exiting due to a test assertion that isn't ret == 0 */
794 ret = -1;
795 }
Yanray Wange6afd912022-10-27 12:11:18 +0800796 if (ret != 0) {
Yanray Wangf6f71902023-03-15 16:05:14 +0800797 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800798 }
799
800 return ret;
801}
802
Gilles Peskine6edb76c2025-06-01 21:53:52 +0200803int mbedtls_test_ssl_endpoint_init_conf(
Yanray Wange6afd912022-10-27 12:11:18 +0800804 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +0200805 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +0800806{
807 int ret = -1;
Gilles Peskine27586d82025-05-28 17:01:42 +0200808#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
809 const char *psk_identity = "foo";
810#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800811
Yanray Wange6afd912022-10-27 12:11:18 +0800812 if (ep == NULL) {
813 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
814 }
815
816 memset(ep, 0, sizeof(*ep));
817
818 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
819
820 mbedtls_ssl_init(&(ep->ssl));
821 mbedtls_ssl_config_init(&(ep->conf));
Gilles Peskine29969592025-05-27 19:24:28 +0200822 mbedtls_test_message_socket_init(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800823
824 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
825 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
826 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
827 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
828
829 (void) mbedtls_test_rnd_std_rand(NULL,
Gilles Peskine00eb0722025-06-01 21:50:05 +0200830 (void *) &ep->user_data_cookie,
831 sizeof(ep->user_data_cookie));
832 mbedtls_ssl_conf_set_user_data_n(&ep->conf, ep->user_data_cookie);
833 mbedtls_ssl_set_user_data_n(&ep->ssl, ep->user_data_cookie);
Yanray Wange6afd912022-10-27 12:11:18 +0800834
Gilles Peskine6c154e72025-05-27 20:23:52 +0200835 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800836
Yanray Wange6afd912022-10-27 12:11:18 +0800837 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
Gilles Peskine29969592025-05-27 19:24:28 +0200838 options->dtls ?
Yanray Wange6afd912022-10-27 12:11:18 +0800839 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
840 MBEDTLS_SSL_TRANSPORT_STREAM,
841 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200842 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800843
Ronald Crona697a712023-03-09 17:47:42 +0100844 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
845 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
846 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
847 options->client_min_version);
848 }
849
850 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
851 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
852 options->client_max_version);
853 }
854 } else {
855 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
856 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
857 options->server_min_version);
858 }
859
860 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
861 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
862 options->server_max_version);
863 }
864 }
865
Gilles Peskine27586d82025-05-28 17:01:42 +0200866 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
867 TEST_ASSERT(set_ciphersuite(ep, options->cipher));
868 }
869
Ronald Cronfb536472024-01-26 14:55:25 +0100870 if (options->group_list != NULL) {
871 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800872 }
873
Gilles Peskinefb2ce052025-05-28 17:36:12 +0200874 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
875 mbedtls_ssl_conf_authmode(&(ep->conf), options->srv_auth_mode);
876 } else {
877 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
878 }
Yanray Wange6afd912022-10-27 12:11:18 +0800879
Ronald Cronced99be2024-01-26 15:49:12 +0100880#if defined(MBEDTLS_SSL_EARLY_DATA)
881 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100882#if defined(MBEDTLS_SSL_SRV_C)
883 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
884 (options->max_early_data_size >= 0)) {
885 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
886 options->max_early_data_size);
887 }
888#endif
Gilles Peskine27586d82025-05-28 17:01:42 +0200889
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000890#if defined(MBEDTLS_SSL_ALPN)
891 /* check that alpn_list contains at least one valid entry */
892 if (options->alpn_list[0] != NULL) {
893 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
894 }
895#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100896#endif
897
Gilles Peskine27586d82025-05-28 17:01:42 +0200898#if defined(MBEDTLS_SSL_RENEGOTIATION)
899 if (options->renegotiate) {
900 mbedtls_ssl_conf_renegotiation(&ep->conf,
901 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
902 mbedtls_ssl_conf_legacy_renegotiation(&ep->conf,
903 options->legacy_renegotiation);
904 }
905#endif /* MBEDTLS_SSL_RENEGOTIATION */
906
Yanray Wange6afd912022-10-27 12:11:18 +0800907#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
908 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
909 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
910 mbedtls_ssl_cache_get,
911 mbedtls_ssl_cache_set);
912 }
913#endif
914
Gilles Peskine27586d82025-05-28 17:01:42 +0200915#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
916 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&ep->conf,
917 (unsigned char) options->mfl),
918 0);
919#else
920 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
921#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
922
Yanray Wange6afd912022-10-27 12:11:18 +0800923#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine29969592025-05-27 19:24:28 +0200924 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->dtls) {
Yanray Wange6afd912022-10-27 12:11:18 +0800925 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
926 }
927#endif
928
Ronald Cronec3408d2024-01-16 17:50:40 +0100929#if defined(MBEDTLS_DEBUG_C)
930#if defined(MBEDTLS_SSL_SRV_C)
931 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
932 options->srv_log_fun != NULL) {
933 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
934 options->srv_log_obj);
935 }
936#endif
937#if defined(MBEDTLS_SSL_CLI_C)
938 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
939 options->cli_log_fun != NULL) {
940 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
941 options->cli_log_obj);
942 }
943#endif
944#endif /* MBEDTLS_DEBUG_C */
945
Yanray Wange6afd912022-10-27 12:11:18 +0800946 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
947 options->opaque_alg,
948 options->opaque_alg2,
949 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200950 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800951
Gilles Peskine27586d82025-05-28 17:01:42 +0200952#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
953 if (options->psk_str != NULL && options->psk_str->len > 0) {
954 TEST_EQUAL(mbedtls_ssl_conf_psk(
955 &ep->conf, options->psk_str->x,
956 options->psk_str->len,
957 (const unsigned char *) psk_identity,
958 strlen(psk_identity)), 0);
959#if defined(MBEDTLS_SSL_SRV_C)
960 if (MBEDTLS_SSL_IS_SERVER == endpoint_type) {
961 mbedtls_ssl_conf_psk_cb(&ep->conf, psk_dummy_callback, NULL);
962 }
963#endif
964 }
965#endif
966
Gilles Peskine00eb0722025-06-01 21:50:05 +0200967 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf),
968 ep->user_data_cookie);
Yanray Wange6afd912022-10-27 12:11:18 +0800969 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
Gilles Peskinea6e71f92025-06-01 21:32:05 +0200970
Gilles Peskine6edb76c2025-06-01 21:53:52 +0200971 return 0;
972
973exit:
974 if (ret == 0) {
975 /* Exiting due to a test assertion that isn't ret == 0 */
976 ret = -1;
977 }
978 return ret;
979}
980
981int mbedtls_test_ssl_endpoint_init_ssl(
982 mbedtls_test_ssl_endpoint *ep,
983 const mbedtls_test_handshake_test_options *options)
984{
985 int endpoint_type = mbedtls_ssl_conf_get_endpoint(&ep->conf);
986 int ret = -1;
Gilles Peskinea6e71f92025-06-01 21:32:05 +0200987
988 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
989 TEST_EQUAL(ret, 0);
990
991 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
992 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
993 TEST_EQUAL(ret, 0);
994 }
995
996 /* Non-blocking callbacks without timeout */
997 if (options->dtls) {
998 mbedtls_ssl_set_bio(&(ep->ssl), &ep->dtls_context,
999 mbedtls_test_mock_tcp_send_msg,
1000 mbedtls_test_mock_tcp_recv_msg,
1001 NULL);
1002#if defined(MBEDTLS_TIMING_C)
1003 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
1004 mbedtls_timing_set_delay,
1005 mbedtls_timing_get_delay);
1006#endif
1007 } else {
1008 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
1009 mbedtls_test_mock_tcp_send_nb,
1010 mbedtls_test_mock_tcp_recv_nb,
1011 NULL);
1012 }
1013
Gilles Peskine00eb0722025-06-01 21:50:05 +02001014 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), ep->user_data_cookie);
Yanray Wange6afd912022-10-27 12:11:18 +08001015 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
1016
Gilles Peskine946bf142025-04-08 09:48:40 +02001017 return 0;
1018
Yanray Wange6afd912022-10-27 12:11:18 +08001019exit:
Gilles Peskine946bf142025-04-08 09:48:40 +02001020 if (ret == 0) {
1021 /* Exiting due to a test assertion that isn't ret == 0 */
1022 ret = -1;
1023 }
Yanray Wange6afd912022-10-27 12:11:18 +08001024 return ret;
1025}
1026
Gilles Peskine6edb76c2025-06-01 21:53:52 +02001027int mbedtls_test_ssl_endpoint_init(
1028 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
1029 const mbedtls_test_handshake_test_options *options)
1030{
1031 int ret = mbedtls_test_ssl_endpoint_init_conf(ep, endpoint_type, options);
1032 if (ret != 0) {
1033 return ret;
1034 }
1035 ret = mbedtls_test_ssl_endpoint_init_ssl(ep, options);
1036 return ret;
1037}
1038
Yanray Wange6afd912022-10-27 12:11:18 +08001039void mbedtls_test_ssl_endpoint_free(
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02001040 mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +08001041{
Yanray Wange6afd912022-10-27 12:11:18 +08001042 mbedtls_ssl_free(&(ep->ssl));
1043 mbedtls_ssl_config_free(&(ep->conf));
1044
Gilles Peskine2744a432025-05-27 13:27:22 +02001045 mbedtls_free(ep->ciphersuites);
1046 ep->ciphersuites = NULL;
1047 test_ssl_endpoint_certificate_free(ep);
1048
Gilles Peskine29969592025-05-27 19:24:28 +02001049 if (ep->dtls_context.socket != NULL) {
1050 mbedtls_test_message_socket_close(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +08001051 } else {
1052 mbedtls_test_mock_socket_close(&(ep->socket));
1053 }
1054}
1055
Gilles Peskineb092e782025-05-27 20:15:03 +02001056int mbedtls_test_ssl_dtls_join_endpoints(mbedtls_test_ssl_endpoint *client,
1057 mbedtls_test_ssl_endpoint *server)
1058{
1059 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1060
Gilles Peskine6c154e72025-05-27 20:23:52 +02001061 ret = mbedtls_test_message_socket_setup(&client->queue_input,
1062 &server->queue_input,
1063 100, &(client->socket),
1064 &client->dtls_context);
1065 TEST_EQUAL(ret, 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02001066
Gilles Peskine6c154e72025-05-27 20:23:52 +02001067 ret = mbedtls_test_message_socket_setup(&server->queue_input,
1068 &client->queue_input,
1069 100, &(server->socket),
1070 &server->dtls_context);
1071 TEST_EQUAL(ret, 0);
1072
1073exit:
Gilles Peskineb092e782025-05-27 20:15:03 +02001074 return ret;
1075}
1076
Yanray Wange6afd912022-10-27 12:11:18 +08001077int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
1078 mbedtls_ssl_context *second_ssl,
1079 int state)
1080{
1081 enum { BUFFSIZE = 1024 };
1082 int max_steps = 1000;
1083 int ret = 0;
1084
1085 if (ssl == NULL || second_ssl == NULL) {
1086 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1087 }
1088
1089 /* Perform communication via connected sockets */
1090 while ((ssl->state != state) && (--max_steps >= 0)) {
1091 /* If /p second_ssl ends the handshake procedure before /p ssl then
1092 * there is no need to call the next step */
1093 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
1094 ret = mbedtls_ssl_handshake_step(second_ssl);
1095 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1096 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1097 return ret;
1098 }
1099 }
1100
1101 /* We only care about the \p ssl state and returns, so we call it last,
1102 * to leave the iteration as soon as the state is as expected. */
1103 ret = mbedtls_ssl_handshake_step(ssl);
1104 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
1105 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
1106 return ret;
1107 }
1108 }
1109
1110 return (max_steps >= 0) ? ret : -1;
1111}
1112
1113#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
1114
1115/*
1116 * Write application data. Increase write counter if necessary.
1117 */
Michael Schuster54300d42024-06-04 02:30:22 +02001118static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001119 unsigned char *buf, int buf_len,
1120 int *written,
1121 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001122{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001123 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001124 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1125 * a valid no-op for TLS connections. */
1126 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001127 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001128 }
1129
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001130 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +08001131 if (ret > 0) {
1132 *written += ret;
1133 }
1134
1135 if (expected_fragments == 0) {
1136 /* Used for DTLS and the message size larger than MFL. In that case
1137 * the message can not be fragmented and the library should return
1138 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +08001139 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +08001140 return ret;
1141 } else if (expected_fragments == 1) {
1142 /* Used for TLS/DTLS and the message size lower than MFL */
1143 TEST_ASSERT(ret == buf_len ||
1144 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1145 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1146 } else {
1147 /* Used for TLS and the message size larger than MFL */
1148 TEST_ASSERT(expected_fragments > 1);
1149 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1150 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1151 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1152 }
1153
1154 return 0;
1155
1156exit:
1157 /* Some of the tests failed */
1158 return -1;
1159}
1160
1161/*
1162 * Read application data and increase read counter and fragments counter
1163 * if necessary.
1164 */
Michael Schuster54300d42024-06-04 02:30:22 +02001165static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001166 unsigned char *buf, int buf_len,
1167 int *read, int *fragments,
1168 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001169{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001170 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001171 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1172 * a valid no-op for TLS connections. */
1173 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001174 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001175 }
1176
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001177 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001178 if (ret > 0) {
1179 (*fragments)++;
1180 *read += ret;
1181 }
1182
1183 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001184 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001185 } else if (expected_fragments == 1) {
1186 TEST_ASSERT(ret == buf_len ||
1187 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1188 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1189 } else {
1190 TEST_ASSERT(expected_fragments > 1);
1191 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1192 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1193 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1194 }
1195
1196 return 0;
1197
1198exit:
1199 /* Some of the tests failed */
1200 return -1;
1201}
1202
Yanray Wange6afd912022-10-27 12:11:18 +08001203#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001204 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001205int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1206 const unsigned char *iv,
1207 size_t iv_len,
1208 const unsigned char *input,
1209 size_t ilen,
1210 unsigned char *output,
1211 size_t *olen)
1212{
1213#if defined(MBEDTLS_USE_PSA_CRYPTO)
1214 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1215 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1216 size_t part_len;
1217
1218 status = psa_cipher_encrypt_setup(&cipher_op,
1219 transform->psa_key_enc,
1220 transform->psa_alg);
1221
1222 if (status != PSA_SUCCESS) {
1223 return PSA_TO_MBEDTLS_ERR(status);
1224 }
1225
1226 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1227
1228 if (status != PSA_SUCCESS) {
1229 return PSA_TO_MBEDTLS_ERR(status);
1230 }
1231
1232 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1233
1234 if (status != PSA_SUCCESS) {
1235 return PSA_TO_MBEDTLS_ERR(status);
1236 }
1237
1238 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1239 &part_len);
1240
1241 if (status != PSA_SUCCESS) {
1242 return PSA_TO_MBEDTLS_ERR(status);
1243 }
1244
1245 *olen += part_len;
1246 return 0;
1247#else
1248 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1249 iv, iv_len, input, ilen, output, olen);
1250#endif /* MBEDTLS_USE_PSA_CRYPTO */
1251}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001252#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001253 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001254
Valerio Setti31ad3a12023-10-27 11:55:02 +02001255static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1256 mbedtls_cipher_mode_t *cipher_mode,
1257 size_t *key_bits, size_t *iv_len)
1258{
1259 switch (cipher_type) {
1260 case MBEDTLS_CIPHER_AES_128_CBC:
1261 *cipher_mode = MBEDTLS_MODE_CBC;
1262 *key_bits = 128;
1263 *iv_len = 16;
1264 break;
1265 case MBEDTLS_CIPHER_AES_256_CBC:
1266 *cipher_mode = MBEDTLS_MODE_CBC;
1267 *key_bits = 256;
1268 *iv_len = 16;
1269 break;
1270 case MBEDTLS_CIPHER_ARIA_128_CBC:
1271 *cipher_mode = MBEDTLS_MODE_CBC;
1272 *key_bits = 128;
1273 *iv_len = 16;
1274 break;
1275 case MBEDTLS_CIPHER_ARIA_256_CBC:
1276 *cipher_mode = MBEDTLS_MODE_CBC;
1277 *key_bits = 256;
1278 *iv_len = 16;
1279 break;
1280 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1281 *cipher_mode = MBEDTLS_MODE_CBC;
1282 *key_bits = 128;
1283 *iv_len = 16;
1284 break;
1285 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1286 *cipher_mode = MBEDTLS_MODE_CBC;
1287 *key_bits = 256;
1288 *iv_len = 16;
1289 break;
1290
1291 case MBEDTLS_CIPHER_AES_128_CCM:
1292 *cipher_mode = MBEDTLS_MODE_CCM;
1293 *key_bits = 128;
1294 *iv_len = 12;
1295 break;
1296 case MBEDTLS_CIPHER_AES_192_CCM:
1297 *cipher_mode = MBEDTLS_MODE_CCM;
1298 *key_bits = 192;
1299 *iv_len = 12;
1300 break;
1301 case MBEDTLS_CIPHER_AES_256_CCM:
1302 *cipher_mode = MBEDTLS_MODE_CCM;
1303 *key_bits = 256;
1304 *iv_len = 12;
1305 break;
1306 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1307 *cipher_mode = MBEDTLS_MODE_CCM;
1308 *key_bits = 128;
1309 *iv_len = 12;
1310 break;
1311 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1312 *cipher_mode = MBEDTLS_MODE_CCM;
1313 *key_bits = 192;
1314 *iv_len = 12;
1315 break;
1316 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1317 *cipher_mode = MBEDTLS_MODE_CCM;
1318 *key_bits = 256;
1319 *iv_len = 12;
1320 break;
1321
1322 case MBEDTLS_CIPHER_AES_128_GCM:
1323 *cipher_mode = MBEDTLS_MODE_GCM;
1324 *key_bits = 128;
1325 *iv_len = 12;
1326 break;
1327 case MBEDTLS_CIPHER_AES_192_GCM:
1328 *cipher_mode = MBEDTLS_MODE_GCM;
1329 *key_bits = 192;
1330 *iv_len = 12;
1331 break;
1332 case MBEDTLS_CIPHER_AES_256_GCM:
1333 *cipher_mode = MBEDTLS_MODE_GCM;
1334 *key_bits = 256;
1335 *iv_len = 12;
1336 break;
1337 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1338 *cipher_mode = MBEDTLS_MODE_GCM;
1339 *key_bits = 128;
1340 *iv_len = 12;
1341 break;
1342 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1343 *cipher_mode = MBEDTLS_MODE_GCM;
1344 *key_bits = 192;
1345 *iv_len = 12;
1346 break;
1347 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1348 *cipher_mode = MBEDTLS_MODE_GCM;
1349 *key_bits = 256;
1350 *iv_len = 12;
1351 break;
1352
1353 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1354 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1355 *key_bits = 256;
1356 *iv_len = 12;
1357 break;
1358
1359 case MBEDTLS_CIPHER_NULL:
1360 *cipher_mode = MBEDTLS_MODE_STREAM;
1361 *key_bits = 0;
1362 *iv_len = 0;
1363 break;
1364
1365 default:
1366 *cipher_mode = MBEDTLS_MODE_NONE;
1367 *key_bits = 0;
1368 *iv_len = 0;
1369 }
1370}
1371
Yanray Wange6afd912022-10-27 12:11:18 +08001372int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1373 mbedtls_ssl_transform *t_out,
1374 int cipher_type, int hash_id,
1375 int etm, int tag_mode,
1376 mbedtls_ssl_protocol_version tls_version,
1377 size_t cid0_len,
1378 size_t cid1_len)
1379{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001380 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1381 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001382 int ret = 0;
1383
1384#if defined(MBEDTLS_USE_PSA_CRYPTO)
1385 psa_key_type_t key_type;
1386 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1387 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001388 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001389#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001390 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001391#endif
1392
Valerio Setti31ad3a12023-10-27 11:55:02 +02001393 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001394 unsigned char *key0 = NULL, *key1 = NULL;
1395 unsigned char *md0 = NULL, *md1 = NULL;
1396 unsigned char iv_enc[16], iv_dec[16];
1397
1398#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1399 unsigned char cid0[SSL_CID_LEN_MIN];
1400 unsigned char cid1[SSL_CID_LEN_MIN];
1401
1402 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1403 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1404#else
1405 ((void) cid0_len);
1406 ((void) cid1_len);
1407#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1408
1409 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001410 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1411 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001412
1413 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001414 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001415 /* Allocate `keylen + 1` bytes to ensure that we get
1416 * a non-NULL pointers from `mbedtls_calloc` even if
1417 * `keylen == 0` in the case of the NULL cipher. */
1418 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1419 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1420 memset(key0, 0x1, keylen);
1421 memset(key1, 0x2, keylen);
1422
1423#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001424 /* Pick cipher */
1425 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1426 CHK(cipher_info != NULL);
1427 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1428 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001429
Yanray Wange6afd912022-10-27 12:11:18 +08001430 /* Setup cipher contexts */
1431 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1432 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1433 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1434 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1435
1436#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001437 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001438 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1439 MBEDTLS_PADDING_NONE) == 0);
1440 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1441 MBEDTLS_PADDING_NONE) == 0);
1442 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1443 MBEDTLS_PADDING_NONE) == 0);
1444 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1445 MBEDTLS_PADDING_NONE) == 0);
1446 }
1447#endif /* MBEDTLS_CIPHER_MODE_CBC */
1448
1449 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001450 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1451 MBEDTLS_ENCRYPT)
1452 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001453 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001454 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1455 MBEDTLS_DECRYPT)
1456 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001457 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001458 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1459 MBEDTLS_ENCRYPT)
1460 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001461 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001462 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1463 MBEDTLS_DECRYPT)
1464 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001465#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001466
1467 /* Setup MAC contexts */
1468#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001469 if (cipher_mode == MBEDTLS_MODE_CBC ||
1470 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001471#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001472 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 +08001473 CHK(md_info != NULL);
1474#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001475 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001476 CHK(maclen != 0);
1477 /* Pick hash keys */
1478 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1479 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1480 memset(md0, 0x5, maclen);
1481 memset(md1, 0x6, maclen);
1482
1483#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001484 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001485
1486 CHK(alg != 0);
1487
1488 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1489 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1490 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1491 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1492 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1493 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1494
1495 psa_reset_key_attributes(&attributes);
1496 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1497 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1498 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1499
1500 CHK(psa_import_key(&attributes,
1501 md0, maclen,
1502 &t_in->psa_mac_enc) == PSA_SUCCESS);
1503
1504 CHK(psa_import_key(&attributes,
1505 md1, maclen,
1506 &t_out->psa_mac_enc) == PSA_SUCCESS);
1507
Valerio Setti31ad3a12023-10-27 11:55:02 +02001508 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001509 etm == MBEDTLS_SSL_ETM_DISABLED) {
1510 /* mbedtls_ct_hmac() requires the key to be exportable */
1511 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1512 PSA_KEY_USAGE_VERIFY_HASH);
1513 } else {
1514 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1515 }
1516
1517 CHK(psa_import_key(&attributes,
1518 md1, maclen,
1519 &t_in->psa_mac_dec) == PSA_SUCCESS);
1520
1521 CHK(psa_import_key(&attributes,
1522 md0, maclen,
1523 &t_out->psa_mac_dec) == PSA_SUCCESS);
1524#else
1525 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1526 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1527 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1528 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1529
1530 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1531 md0, maclen) == 0);
1532 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1533 md1, maclen) == 0);
1534 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1535 md1, maclen) == 0);
1536 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1537 md0, maclen) == 0);
1538#endif
1539 }
1540#else
1541 ((void) hash_id);
1542#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1543
1544
1545 /* Pick IV's (regardless of whether they
1546 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001547 memset(iv_enc, 0x3, sizeof(iv_enc));
1548 memset(iv_dec, 0x4, sizeof(iv_dec));
1549
1550 /*
1551 * Setup transforms
1552 */
1553
1554#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1555 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1556 t_out->encrypt_then_mac = etm;
1557 t_in->encrypt_then_mac = etm;
1558#else
1559 ((void) etm);
1560#endif
1561
1562 t_out->tls_version = tls_version;
1563 t_in->tls_version = tls_version;
1564 t_out->ivlen = ivlen;
1565 t_in->ivlen = ivlen;
1566
Valerio Setti31ad3a12023-10-27 11:55:02 +02001567 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001568 case MBEDTLS_MODE_GCM:
1569 case MBEDTLS_MODE_CCM:
1570#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1571 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1572 t_out->fixed_ivlen = 12;
1573 t_in->fixed_ivlen = 12;
1574 } else
1575#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1576 {
1577 t_out->fixed_ivlen = 4;
1578 t_in->fixed_ivlen = 4;
1579 }
1580 t_out->maclen = 0;
1581 t_in->maclen = 0;
1582 switch (tag_mode) {
1583 case 0: /* Full tag */
1584 t_out->taglen = 16;
1585 t_in->taglen = 16;
1586 break;
1587 case 1: /* Partial tag */
1588 t_out->taglen = 8;
1589 t_in->taglen = 8;
1590 break;
1591 default:
1592 ret = 1;
1593 goto cleanup;
1594 }
1595 break;
1596
1597 case MBEDTLS_MODE_CHACHAPOLY:
1598 t_out->fixed_ivlen = 12;
1599 t_in->fixed_ivlen = 12;
1600 t_out->maclen = 0;
1601 t_in->maclen = 0;
1602 switch (tag_mode) {
1603 case 0: /* Full tag */
1604 t_out->taglen = 16;
1605 t_in->taglen = 16;
1606 break;
1607 case 1: /* Partial tag */
1608 t_out->taglen = 8;
1609 t_in->taglen = 8;
1610 break;
1611 default:
1612 ret = 1;
1613 goto cleanup;
1614 }
1615 break;
1616
1617 case MBEDTLS_MODE_STREAM:
1618 case MBEDTLS_MODE_CBC:
1619 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1620 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1621 t_out->taglen = 0;
1622 t_in->taglen = 0;
1623 switch (tag_mode) {
1624 case 0: /* Full tag */
1625 t_out->maclen = maclen;
1626 t_in->maclen = maclen;
1627 break;
1628 default:
1629 ret = 1;
1630 goto cleanup;
1631 }
1632 break;
1633 default:
1634 ret = 1;
1635 goto cleanup;
1636 break;
1637 }
1638
1639 /* Setup IV's */
1640
1641 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1642 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1643 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1644 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1645
1646#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1647 /* Add CID */
1648 memcpy(&t_in->in_cid, cid0, cid0_len);
1649 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001650 t_in->in_cid_len = (uint8_t) cid0_len;
1651 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001652 memcpy(&t_out->in_cid, cid1, cid1_len);
1653 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001654 t_out->in_cid_len = (uint8_t) cid1_len;
1655 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001656#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1657
1658#if defined(MBEDTLS_USE_PSA_CRYPTO)
1659 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1660 t_in->taglen,
1661 &alg,
1662 &key_type,
1663 &key_bits);
1664
1665 if (status != PSA_SUCCESS) {
1666 ret = PSA_TO_MBEDTLS_ERR(status);
1667 goto cleanup;
1668 }
1669
1670 t_in->psa_alg = alg;
1671 t_out->psa_alg = alg;
1672
1673 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1674 psa_reset_key_attributes(&attributes);
1675 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1676 psa_set_key_algorithm(&attributes, alg);
1677 psa_set_key_type(&attributes, key_type);
1678
1679 status = psa_import_key(&attributes,
1680 key0,
1681 PSA_BITS_TO_BYTES(key_bits),
1682 &t_in->psa_key_enc);
1683
1684 if (status != PSA_SUCCESS) {
1685 ret = PSA_TO_MBEDTLS_ERR(status);
1686 goto cleanup;
1687 }
1688
1689 status = psa_import_key(&attributes,
1690 key1,
1691 PSA_BITS_TO_BYTES(key_bits),
1692 &t_out->psa_key_enc);
1693
1694 if (status != PSA_SUCCESS) {
1695 ret = PSA_TO_MBEDTLS_ERR(status);
1696 goto cleanup;
1697 }
1698
1699 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1700
1701 status = psa_import_key(&attributes,
1702 key1,
1703 PSA_BITS_TO_BYTES(key_bits),
1704 &t_in->psa_key_dec);
1705
1706 if (status != PSA_SUCCESS) {
1707 ret = PSA_TO_MBEDTLS_ERR(status);
1708 goto cleanup;
1709 }
1710
1711 status = psa_import_key(&attributes,
1712 key0,
1713 PSA_BITS_TO_BYTES(key_bits),
1714 &t_out->psa_key_dec);
1715
1716 if (status != PSA_SUCCESS) {
1717 ret = PSA_TO_MBEDTLS_ERR(status);
1718 goto cleanup;
1719 }
1720 }
1721#endif /* MBEDTLS_USE_PSA_CRYPTO */
1722
1723cleanup:
1724
1725 mbedtls_free(key0);
1726 mbedtls_free(key1);
1727
1728 mbedtls_free(md0);
1729 mbedtls_free(md1);
1730
1731 return ret;
1732}
1733
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001734#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1735int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1736 mbedtls_ssl_transform *transform_out)
1737{
1738#if defined(MBEDTLS_USE_PSA_CRYPTO)
1739 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1740#endif
1741
1742 /* Serialized version of record header for MAC purposes */
1743 unsigned char add_data[13];
1744 memcpy(add_data, record->ctr, 8);
1745 add_data[8] = record->type;
1746 add_data[9] = record->ver[0];
1747 add_data[10] = record->ver[1];
1748 add_data[11] = (record->data_len >> 8) & 0xff;
1749 add_data[12] = (record->data_len >> 0) & 0xff;
1750
1751 /* MAC with additional data */
1752#if defined(MBEDTLS_USE_PSA_CRYPTO)
1753 size_t sign_mac_length = 0;
1754 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1755 transform_out->psa_mac_enc,
1756 transform_out->psa_mac_alg));
1757 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1758 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1759 record->buf + record->data_offset,
1760 record->data_len));
1761 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1762 * extension, there might not be enough room in the record for the
1763 * full-length MAC. */
1764 unsigned char mac[PSA_HASH_MAX_SIZE];
1765 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1766 mac, sizeof(mac),
1767 &sign_mac_length));
1768#else
1769 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1770 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1771 record->buf + record->data_offset,
1772 record->data_len));
1773 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1774 * extension, there might not be enough room in the record for the
1775 * full-length MAC. */
1776 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1777 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1778#endif
1779 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1780 record->data_len += transform_out->maclen;
1781
1782 return 0;
1783
1784exit:
1785#if defined(MBEDTLS_USE_PSA_CRYPTO)
1786 psa_mac_abort(&operation);
1787#endif
1788 return -1;
1789}
1790#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1791
Jerry Yu28547c42023-10-31 14:42:50 +08001792#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001793int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1794 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001795 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001796 const char *crt_file)
1797{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001798 (void) ticket_len;
1799
Yanray Wange6afd912022-10-27 12:11:18 +08001800#if defined(MBEDTLS_HAVE_TIME)
1801 session->start = mbedtls_time(NULL) - 42;
1802#endif
1803 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001804
1805 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1806 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1807
1808 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001809 session->ciphersuite = 0xabcd;
1810 session->id_len = sizeof(session->id);
1811 memset(session->id, 66, session->id_len);
1812 memset(session->master, 17, sizeof(session->master));
1813
1814#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1815 if (crt_file != NULL && strlen(crt_file) != 0) {
1816 mbedtls_x509_crt tmp_crt;
1817 int ret;
1818
1819 mbedtls_x509_crt_init(&tmp_crt);
1820 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1821 if (ret != 0) {
1822 return ret;
1823 }
1824
1825#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1826 /* Move temporary CRT. */
1827 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1828 if (session->peer_cert == NULL) {
1829 return -1;
1830 }
1831 *session->peer_cert = tmp_crt;
1832 memset(&tmp_crt, 0, sizeof(tmp_crt));
1833#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1834 /* Calculate digest of temporary CRT. */
1835 session->peer_cert_digest =
1836 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1837 if (session->peer_cert_digest == NULL) {
1838 return -1;
1839 }
1840
1841#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001842 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001843 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1844 size_t hash_size = 0;
1845 psa_status_t status = psa_hash_compute(
1846 psa_alg, tmp_crt.raw.p,
1847 tmp_crt.raw.len,
1848 session->peer_cert_digest,
1849 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1850 &hash_size);
1851 ret = PSA_TO_MBEDTLS_ERR(status);
1852#else
1853 ret = mbedtls_md(mbedtls_md_info_from_type(
1854 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1855 tmp_crt.raw.p, tmp_crt.raw.len,
1856 session->peer_cert_digest);
1857#endif /* MBEDTLS_USE_PSA_CRYPTO */
1858 if (ret != 0) {
1859 return ret;
1860 }
1861 session->peer_cert_digest_type =
1862 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1863 session->peer_cert_digest_len =
1864 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1865#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1866
1867 mbedtls_x509_crt_free(&tmp_crt);
1868 }
1869#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1870 (void) crt_file;
1871#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1872 session->verify_result = 0xdeadbeef;
1873
Ronald Cronc57f86e2023-11-22 09:50:01 +01001874#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1875#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001876 if (ticket_len != 0) {
1877 session->ticket = mbedtls_calloc(1, ticket_len);
1878 if (session->ticket == NULL) {
1879 return -1;
1880 }
1881 memset(session->ticket, 33, ticket_len);
1882 }
1883 session->ticket_len = ticket_len;
1884 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001885#endif /* MBEDTLS_SSL_CLI_C */
1886
1887#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1888 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1889 session->ticket_creation_time = mbedtls_ms_time() - 42;
1890 }
Yanray Wange6afd912022-10-27 12:11:18 +08001891#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001892#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001893
1894#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1895 session->mfl_code = 1;
1896#endif
1897#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1898 session->encrypt_then_mac = 1;
1899#endif
1900
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001901exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001902 return 0;
1903}
Jerry Yu28547c42023-10-31 14:42:50 +08001904#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001905
1906#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1907int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1908 int ticket_len,
1909 int endpoint_type)
1910{
1911 ((void) ticket_len);
1912 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1913 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1914 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1915 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001916
1917#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001918 session->ticket_age_add = 0x87654321;
1919 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001920 session->resumption_key_len = 32;
1921 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001922#endif
1923
Ronald Cron18b92a12024-03-26 10:15:08 +01001924#if defined(MBEDTLS_SSL_SRV_C)
1925 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1926#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1927#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1928 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1929 if (ret != 0) {
1930 return -1;
1931 }
1932#endif
1933#if defined(MBEDTLS_HAVE_TIME)
1934 session->ticket_creation_time = mbedtls_ms_time() - 42;
1935#endif
1936#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1937 }
1938#endif /* MBEDTLS_SSL_SRV_C */
1939
Yanray Wange6afd912022-10-27 12:11:18 +08001940#if defined(MBEDTLS_SSL_CLI_C)
1941 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001942#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001943#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001944 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001945#endif
1946 session->ticket_lifetime = 0xfedcba98;
1947
1948 session->ticket_len = ticket_len;
1949 if (ticket_len != 0) {
1950 session->ticket = mbedtls_calloc(1, ticket_len);
1951 if (session->ticket == NULL) {
1952 return -1;
1953 }
1954 memset(session->ticket, 33, ticket_len);
1955 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001956#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1957 char hostname[] = "hostname example";
1958 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1959 if (session->hostname == NULL) {
1960 return -1;
1961 }
1962 memcpy(session->hostname, hostname, sizeof(hostname));
1963#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001964#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001965 }
1966#endif /* MBEDTLS_SSL_CLI_C */
1967
Ronald Cron18b92a12024-03-26 10:15:08 +01001968#if defined(MBEDTLS_SSL_EARLY_DATA)
1969 session->max_early_data_size = 0x87654321;
1970#endif /* MBEDTLS_SSL_EARLY_DATA */
1971
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001972#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1973 session->record_size_limit = 2048;
1974#endif
1975
Yanray Wange6afd912022-10-27 12:11:18 +08001976 return 0;
1977}
1978#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1979
Yanray Wangb088bfc2023-03-16 12:15:49 +08001980int mbedtls_test_ssl_exchange_data(
1981 mbedtls_ssl_context *ssl_1,
1982 int msg_len_1, const int expected_fragments_1,
1983 mbedtls_ssl_context *ssl_2,
1984 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001985{
1986 unsigned char *msg_buf_1 = malloc(msg_len_1);
1987 unsigned char *msg_buf_2 = malloc(msg_len_2);
1988 unsigned char *in_buf_1 = malloc(msg_len_2);
1989 unsigned char *in_buf_2 = malloc(msg_len_1);
1990 int msg_type, ret = -1;
1991
1992 /* Perform this test with two message types. At first use a message
1993 * consisting of only 0x00 for the client and only 0xFF for the server.
1994 * At the second time use message with generated data */
1995 for (msg_type = 0; msg_type < 2; msg_type++) {
1996 int written_1 = 0;
1997 int written_2 = 0;
1998 int read_1 = 0;
1999 int read_2 = 0;
2000 int fragments_1 = 0;
2001 int fragments_2 = 0;
2002
2003 if (msg_type == 0) {
2004 memset(msg_buf_1, 0x00, msg_len_1);
2005 memset(msg_buf_2, 0xff, msg_len_2);
2006 } else {
2007 int i, j = 0;
2008 for (i = 0; i < msg_len_1; i++) {
2009 msg_buf_1[i] = j++ & 0xFF;
2010 }
2011 for (i = 0; i < msg_len_2; i++) {
2012 msg_buf_2[i] = (j -= 5) & 0xFF;
2013 }
2014 }
2015
2016 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
2017 /* ssl_1 sending */
2018 if (msg_len_1 > written_1) {
2019 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
2020 msg_len_1, &written_1,
2021 expected_fragments_1);
2022 if (expected_fragments_1 == 0) {
2023 /* This error is expected when the message is too large and
2024 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02002025 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08002026 msg_len_1 = 0;
2027 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002028 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002029 }
2030 }
2031
2032 /* ssl_2 sending */
2033 if (msg_len_2 > written_2) {
2034 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
2035 msg_len_2, &written_2,
2036 expected_fragments_2);
2037 if (expected_fragments_2 == 0) {
2038 /* This error is expected when the message is too large and
2039 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02002040 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08002041 msg_len_2 = 0;
2042 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002043 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002044 }
2045 }
2046
2047 /* ssl_1 reading */
2048 if (read_1 < msg_len_2) {
2049 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
2050 msg_len_2, &read_1,
2051 &fragments_2,
2052 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002053 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002054 }
2055
2056 /* ssl_2 reading */
2057 if (read_2 < msg_len_1) {
2058 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
2059 msg_len_1, &read_2,
2060 &fragments_1,
2061 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02002062 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002063 }
2064 }
2065
2066 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02002067 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
2068 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
2069 TEST_EQUAL(fragments_1, expected_fragments_1);
2070 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08002071 }
2072
2073 ret = 0;
2074
2075exit:
2076 free(msg_buf_1);
2077 free(in_buf_1);
2078 free(msg_buf_2);
2079 free(in_buf_2);
2080
2081 return ret;
2082}
2083
2084/*
2085 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
2086 * must be initialized and connected beforehand.
2087 *
2088 * \retval 0 on success, otherwise error code.
2089 */
Yanray Wangead70c82023-03-16 12:04:49 +08002090#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
2091 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
2092 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
2093static int exchange_data(mbedtls_ssl_context *ssl_1,
2094 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08002095{
Yanray Wangb088bfc2023-03-16 12:15:49 +08002096 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
2097 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002098}
Yanray Wangead70c82023-03-16 12:04:49 +08002099#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
2100 (MBEDTLS_SSL_RENEGOTIATION ||
2101 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002102
2103#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2104static int check_ssl_version(
2105 mbedtls_ssl_protocol_version expected_negotiated_version,
Gilles Peskinebd953402025-05-28 15:20:28 +02002106 const mbedtls_ssl_context *client,
2107 const mbedtls_ssl_context *server)
Yanray Wange6afd912022-10-27 12:11:18 +08002108{
Gilles Peskinebd953402025-05-28 15:20:28 +02002109 /* First check that both sides have chosen the same version.
2110 * If so, we can make more sanity checks just on one side.
2111 * If not, something is deeply wrong. */
2112 TEST_EQUAL(client->tls_version, server->tls_version);
2113
2114 /* Make further checks on the client to validate that the
2115 * reported data about the version is correct. */
2116 const char *version_string = mbedtls_ssl_get_version(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002117 mbedtls_ssl_protocol_version version_number =
Gilles Peskinebd953402025-05-28 15:20:28 +02002118 mbedtls_ssl_get_version_number(client);
Yanray Wange6afd912022-10-27 12:11:18 +08002119
Gilles Peskinebd953402025-05-28 15:20:28 +02002120 TEST_EQUAL(client->tls_version, expected_negotiated_version);
Yanray Wange6afd912022-10-27 12:11:18 +08002121
Gilles Peskinebd953402025-05-28 15:20:28 +02002122 if (client->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08002123 TEST_EQUAL(version_string[0], 'D');
2124 ++version_string;
2125 }
2126
2127 switch (expected_negotiated_version) {
2128 case MBEDTLS_SSL_VERSION_TLS1_2:
2129 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002130 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002131 break;
2132
2133 case MBEDTLS_SSL_VERSION_TLS1_3:
2134 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002135 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002136 break;
2137
2138 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002139 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002140 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002141 }
2142
2143 return 1;
2144
2145exit:
2146 return 0;
2147}
2148#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2149
Yanray Wange6afd912022-10-27 12:11:18 +08002150#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002151int mbedtls_test_ssl_do_handshake_with_endpoints(
2152 mbedtls_test_ssl_endpoint *server_ep,
2153 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002154 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002155 mbedtls_ssl_protocol_version proto)
2156{
2157 enum { BUFFSIZE = 1024 };
2158
2159 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002160
Max Fillingeree467aa2024-11-08 22:17:33 +01002161 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2162 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2163
Max Fillinger8f12e312024-10-30 00:29:37 +01002164 mbedtls_test_init_handshake_options(options);
2165 options->server_min_version = proto;
2166 options->client_min_version = proto;
2167 options->server_max_version = proto;
2168 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002169
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002170 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002171 if (ret != 0) {
2172 return ret;
2173 }
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002174 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options);
Max Fillingercf007ca2024-10-29 16:57:09 +01002175 if (ret != 0) {
2176 return ret;
2177 }
2178
2179 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2180 if (ret != 0) {
2181 return ret;
2182 }
2183
Max Fillingerea1e7772024-10-30 00:49:10 +01002184 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2185 &client_ep->ssl,
2186 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002187 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2188 return ret;
2189 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002190 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2191 &server_ep->ssl,
2192 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002193 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2194 return ret;
2195 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002196 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2197 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002198 return -1;
2199 }
2200
2201 return 0;
2202}
2203#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2204
2205#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine78df6ae2025-05-27 21:14:25 +02002206
2207#if defined(MBEDTLS_SSL_RENEGOTIATION)
2208static int test_renegotiation(const mbedtls_test_handshake_test_options *options,
2209 mbedtls_test_ssl_endpoint *client,
2210 mbedtls_test_ssl_endpoint *server)
2211{
2212 int ok = 0;
2213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2214
2215 (void) options; // only used in some configurations
2216
2217 /* Start test with renegotiation */
2218 TEST_EQUAL(server->ssl.renego_status,
2219 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2220 TEST_EQUAL(client->ssl.renego_status,
2221 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2222
2223 /* After calling this function for the server, it only sends a handshake
2224 * request. All renegotiation should happen during data exchanging */
2225 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server->ssl)), 0);
2226 TEST_EQUAL(server->ssl.renego_status,
2227 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2228 TEST_EQUAL(client->ssl.renego_status,
2229 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2230
2231 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2232 TEST_EQUAL(server->ssl.renego_status,
2233 MBEDTLS_SSL_RENEGOTIATION_DONE);
2234 TEST_EQUAL(client->ssl.renego_status,
2235 MBEDTLS_SSL_RENEGOTIATION_DONE);
2236
2237 /* After calling mbedtls_ssl_renegotiate for the client,
2238 * all renegotiation should happen inside this function.
2239 * However in this test, we cannot perform simultaneous communication
2240 * between client and server so this function will return waiting error
2241 * on the socket. All rest of renegotiation should happen
2242 * during data exchanging */
2243 ret = mbedtls_ssl_renegotiate(&(client->ssl));
2244#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2245 if (options->resize_buffers != 0) {
2246 /* Ensure that the buffer sizes are appropriate before resizes */
2247 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2248 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2249 }
2250#endif
2251 TEST_ASSERT(ret == 0 ||
2252 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2253 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
2254 TEST_EQUAL(server->ssl.renego_status,
2255 MBEDTLS_SSL_RENEGOTIATION_DONE);
2256 TEST_EQUAL(client->ssl.renego_status,
2257 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
2258
2259 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2260 TEST_EQUAL(server->ssl.renego_status,
2261 MBEDTLS_SSL_RENEGOTIATION_DONE);
2262 TEST_EQUAL(client->ssl.renego_status,
2263 MBEDTLS_SSL_RENEGOTIATION_DONE);
2264#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2265 /* Validate buffer sizes after renegotiation */
2266 if (options->resize_buffers != 0) {
2267 TEST_EQUAL(client->ssl.out_buf_len,
2268 mbedtls_ssl_get_output_buflen(&client->ssl));
2269 TEST_EQUAL(client->ssl.in_buf_len,
2270 mbedtls_ssl_get_input_buflen(&client->ssl));
2271 TEST_EQUAL(server->ssl.out_buf_len,
2272 mbedtls_ssl_get_output_buflen(&server->ssl));
2273 TEST_EQUAL(server->ssl.in_buf_len,
2274 mbedtls_ssl_get_input_buflen(&server->ssl));
2275 }
2276#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2277
2278 ok = 1;
2279
2280exit:
2281 return ok;
2282}
2283#endif /* MBEDTLS_SSL_RENEGOTIATION */
2284
Gilles Peskinee23a6d12025-05-27 21:17:09 +02002285#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2286static int test_serialization(const mbedtls_test_handshake_test_options *options,
2287 mbedtls_test_ssl_endpoint *client,
2288 mbedtls_test_ssl_endpoint *server)
2289{
2290 int ok = 0;
2291 unsigned char *context_buf = NULL;
2292 size_t context_buf_len;
2293
2294 TEST_EQUAL(options->dtls, 1);
2295
2296 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), NULL,
2297 0, &context_buf_len),
2298 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
2299
2300 context_buf = mbedtls_calloc(1, context_buf_len);
2301 TEST_ASSERT(context_buf != NULL);
2302
2303 TEST_EQUAL(mbedtls_ssl_context_save(&(server->ssl), context_buf,
2304 context_buf_len,
2305 &context_buf_len),
2306 0);
2307
2308 mbedtls_ssl_free(&(server->ssl));
2309 mbedtls_ssl_init(&(server->ssl));
2310
2311 TEST_EQUAL(mbedtls_ssl_setup(&(server->ssl), &(server->conf)), 0);
2312
2313 mbedtls_ssl_set_bio(&(server->ssl), &server->dtls_context,
2314 mbedtls_test_mock_tcp_send_msg,
2315 mbedtls_test_mock_tcp_recv_msg,
2316 NULL);
2317
2318 mbedtls_ssl_set_user_data_p(&server->ssl, server);
2319
2320#if defined(MBEDTLS_TIMING_C)
2321 mbedtls_ssl_set_timer_cb(&server->ssl, &server->timer,
2322 mbedtls_timing_set_delay,
2323 mbedtls_timing_get_delay);
2324#endif
2325#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2326 if (options->resize_buffers != 0) {
2327 /* Ensure that the buffer sizes are appropriate before resizes */
2328 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2329 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2330 }
2331#endif
2332 TEST_EQUAL(mbedtls_ssl_context_load(&(server->ssl), context_buf,
2333 context_buf_len), 0);
2334
2335#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2336 /* Validate buffer sizes after context deserialization */
2337 if (options->resize_buffers != 0) {
2338 TEST_EQUAL(server->ssl.out_buf_len,
2339 mbedtls_ssl_get_output_buflen(&server->ssl));
2340 TEST_EQUAL(server->ssl.in_buf_len,
2341 mbedtls_ssl_get_input_buflen(&server->ssl));
2342 }
2343#endif
2344 /* Retest writing/reading */
2345 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2346 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2347 &(client->ssl), options->cli_msg_len,
2348 options->expected_cli_fragments,
2349 &(server->ssl), options->srv_msg_len,
2350 options->expected_srv_fragments),
2351 0);
2352 }
2353
2354 ok = 1;
2355
2356exit:
2357 mbedtls_free(context_buf);
2358 return ok;
2359}
2360#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2361
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002362int mbedtls_test_ssl_perform_connection(
2363 const mbedtls_test_handshake_test_options *options,
2364 mbedtls_test_ssl_endpoint *client,
2365 mbedtls_test_ssl_endpoint *server)
2366{
2367 enum { BUFFSIZE = 17000 };
2368 int expected_handshake_result = options->expected_handshake_result;
2369 int ok = 0;
2370
2371 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client->socket),
2372 &(server->socket),
2373 BUFFSIZE), 0);
2374
2375#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2376 if (options->resize_buffers != 0) {
2377 /* Ensure that the buffer sizes are appropriate before resizes */
2378 TEST_EQUAL(client->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2379 TEST_EQUAL(client->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2380 TEST_EQUAL(server->ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2381 TEST_EQUAL(server->ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2382 }
2383#endif
2384
2385 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2386 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2387 }
2388
2389 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client->ssl),
2390 &(server->ssl),
2391 MBEDTLS_SSL_HANDSHAKE_OVER),
2392 expected_handshake_result);
2393
2394 if (expected_handshake_result != 0) {
2395 /* Connection will have failed by this point, skip to cleanup */
2396 ok = 1;
2397 goto exit;
2398 }
2399
2400 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client->ssl), 1);
2401
2402 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2403 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server->ssl),
2404 &(client->ssl),
2405 MBEDTLS_SSL_HANDSHAKE_OVER),
2406 0);
2407
2408 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server->ssl), 1);
2409
2410 /* Check that both sides have negotiated the expected version. */
2411 TEST_ASSERT(check_ssl_version(options->expected_negotiated_version,
2412 &client->ssl,
2413 &server->ssl));
2414
2415 if (options->expected_ciphersuite != 0) {
2416 TEST_EQUAL(server->ssl.session->ciphersuite,
2417 options->expected_ciphersuite);
2418 }
2419
2420#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2421 if (options->resize_buffers != 0) {
2422 /* A server, when using DTLS, might delay a buffer resize to happen
2423 * after it receives a message, so we force it. */
2424 TEST_EQUAL(exchange_data(&(client->ssl), &(server->ssl)), 0);
2425
2426 TEST_EQUAL(client->ssl.out_buf_len,
2427 mbedtls_ssl_get_output_buflen(&client->ssl));
2428 TEST_EQUAL(client->ssl.in_buf_len,
2429 mbedtls_ssl_get_input_buflen(&client->ssl));
2430 TEST_EQUAL(server->ssl.out_buf_len,
2431 mbedtls_ssl_get_output_buflen(&server->ssl));
2432 TEST_EQUAL(server->ssl.in_buf_len,
2433 mbedtls_ssl_get_input_buflen(&server->ssl));
2434 }
2435#endif
2436
2437 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2438 /* Start data exchanging test */
2439 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2440 &(client->ssl), options->cli_msg_len,
2441 options->expected_cli_fragments,
2442 &(server->ssl), options->srv_msg_len,
2443 options->expected_srv_fragments),
2444 0);
2445 }
2446#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2447 if (options->serialize == 1) {
2448 TEST_ASSERT(test_serialization(options, client, server));
2449 }
2450#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2451
2452#if defined(MBEDTLS_SSL_RENEGOTIATION)
2453 if (options->renegotiate) {
2454 TEST_ASSERT(test_renegotiation(options, client, server));
2455 }
2456#endif /* MBEDTLS_SSL_RENEGOTIATION */
2457
2458 ok = 1;
2459
2460exit:
2461 return ok;
2462}
2463
Yanray Wange6afd912022-10-27 12:11:18 +08002464void mbedtls_test_ssl_perform_handshake(
Gilles Peskine9b993682025-05-27 18:44:12 +02002465 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +08002466{
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002467 mbedtls_test_ssl_endpoint client_struct;
2468 memset(&client_struct, 0, sizeof(client_struct));
2469 mbedtls_test_ssl_endpoint *const client = &client_struct;
2470 mbedtls_test_ssl_endpoint server_struct;
2471 memset(&server_struct, 0, sizeof(server_struct));
2472 mbedtls_test_ssl_endpoint *const server = &server_struct;
Yanray Wange6afd912022-10-27 12:11:18 +08002473
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002474 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002475
Ronald Cronec3408d2024-01-16 17:50:40 +01002476#if defined(MBEDTLS_DEBUG_C)
2477 if (options->cli_log_fun || options->srv_log_fun) {
2478 mbedtls_debug_set_threshold(4);
2479 }
2480#endif
2481
Yanray Wange6afd912022-10-27 12:11:18 +08002482 /* Client side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002483 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(client,
Gilles Peskine07432b92025-05-27 21:07:44 +02002484 MBEDTLS_SSL_IS_CLIENT,
2485 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002486
Yanray Wange6afd912022-10-27 12:11:18 +08002487 /* Server side */
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002488 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(server,
Gilles Peskine07432b92025-05-27 21:07:44 +02002489 MBEDTLS_SSL_IS_SERVER,
2490 options), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002491
Gilles Peskineb092e782025-05-27 20:15:03 +02002492 if (options->dtls) {
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002493 TEST_EQUAL(mbedtls_test_ssl_dtls_join_endpoints(client, server), 0);
Gilles Peskineb092e782025-05-27 20:15:03 +02002494 }
2495
Gilles Peskine7a8fd462025-05-28 15:41:54 +02002496 TEST_ASSERT(mbedtls_test_ssl_perform_connection(options, client, server));
Yanray Wange6afd912022-10-27 12:11:18 +08002497
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002498 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client->conf) == client);
2499 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client->ssl) == client);
2500 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server->conf) == server);
2501 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server->ssl) == server);
Yanray Wange6afd912022-10-27 12:11:18 +08002502
2503exit:
Gilles Peskinee30b5c72025-05-27 21:05:48 +02002504 mbedtls_test_ssl_endpoint_free(client);
2505 mbedtls_test_ssl_endpoint_free(server);
Yanray Wange6afd912022-10-27 12:11:18 +08002506#if defined(MBEDTLS_DEBUG_C)
2507 if (options->cli_log_fun || options->srv_log_fun) {
2508 mbedtls_debug_set_threshold(0);
2509 }
2510#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002511 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002512}
2513#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2514
2515#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002516int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002517 unsigned char *buf, unsigned char **end, int tweak,
2518 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2519{
2520/*
2521 * The definition of the tweaks assume that the certificate list contains only
2522 * one certificate.
2523 */
2524
2525/*
2526 * struct {
2527 * opaque cert_data<1..2^24-1>;
2528 * Extension extensions<0..2^16-1>;
2529 * } CertificateEntry;
2530 *
2531 * struct {
2532 * opaque certificate_request_context<0..2^8-1>;
2533 * CertificateEntry certificate_list<0..2^24-1>;
2534 * } Certificate;
2535 */
2536 unsigned char *p_certificate_request_context_len = buf;
2537 size_t certificate_request_context_len = buf[0];
2538
2539 unsigned char *p_certificate_list_len =
2540 buf + 1 + certificate_request_context_len;
2541 unsigned char *certificate_list = p_certificate_list_len + 3;
2542 size_t certificate_list_len =
2543 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2544
2545 unsigned char *p_cert_data_len = certificate_list;
2546 unsigned char *cert_data = p_cert_data_len + 3;
2547 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2548
2549 unsigned char *p_extensions_len = cert_data + cert_data_len;
2550 unsigned char *extensions = p_extensions_len + 2;
2551 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2552
2553 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2554
2555 switch (tweak) {
2556 case 1:
2557 /* Failure when checking if the certificate request context length
2558 * and certificate list length can be read
2559 */
2560 *end = buf + 3;
2561 set_chk_buf_ptr_args(args, buf, *end, 4);
2562 break;
2563
2564 case 2:
2565 /* Invalid certificate request context length.
2566 */
2567 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002568 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002569 reset_chk_buf_ptr_args(args);
2570 break;
2571
2572 case 3:
2573 /* Failure when checking if certificate_list data can be read. */
2574 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2575 p_certificate_list_len, 0);
2576 set_chk_buf_ptr_args(args, certificate_list, *end,
2577 certificate_list_len + 1);
2578 break;
2579
2580 case 4:
2581 /* Failure when checking if the cert_data length can be read. */
2582 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2583 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2584 break;
2585
2586 case 5:
2587 /* Failure when checking if cert_data data can be read. */
2588 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2589 p_cert_data_len, 0);
2590 set_chk_buf_ptr_args(args, cert_data,
2591 certificate_list + certificate_list_len,
2592 certificate_list_len - 3 + 1);
2593 break;
2594
2595 case 6:
2596 /* Failure when checking if the extensions length can be read. */
2597 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2598 p_certificate_list_len, 0);
2599 set_chk_buf_ptr_args(
2600 args, p_extensions_len,
2601 certificate_list + certificate_list_len - extensions_len - 1, 2);
2602 break;
2603
2604 case 7:
2605 /* Failure when checking if extensions data can be read. */
2606 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2607
2608 set_chk_buf_ptr_args(
2609 args, extensions,
2610 certificate_list + certificate_list_len, extensions_len + 1);
2611 break;
2612
2613 default:
2614 return -1;
2615 }
2616
2617 return 0;
2618}
2619#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002620
Ronald Cronfaf026c2024-01-31 14:32:06 +01002621/*
2622 * Functions for tests based on tickets. Implementations of the
2623 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2624 * Basically same implementations as in ticket.c without the encryption. That
2625 * way we can tweak easily tickets characteristics to simulate misbehaving
2626 * peers.
2627 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002628#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2629int mbedtls_test_ticket_write(
2630 void *p_ticket, const mbedtls_ssl_session *session,
2631 unsigned char *start, const unsigned char *end,
2632 size_t *tlen, uint32_t *lifetime)
2633{
2634 int ret;
2635 ((void) p_ticket);
2636
2637 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2638 tlen)) != 0) {
2639 return ret;
2640 }
2641
2642 /* Maximum ticket lifetime as defined in RFC 8446 */
2643 *lifetime = 7 * 24 * 3600;
2644
2645 return 0;
2646}
2647
2648int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2649 unsigned char *buf, size_t len)
2650{
2651 ((void) p_ticket);
2652
2653 return mbedtls_ssl_session_load(session, buf, len);
2654}
2655#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002656
2657#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2658 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2659 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2660int mbedtls_test_get_tls13_ticket(
2661 mbedtls_test_handshake_test_options *client_options,
2662 mbedtls_test_handshake_test_options *server_options,
2663 mbedtls_ssl_session *session)
2664{
2665 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002666 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002667 unsigned char buf[64];
2668 mbedtls_test_ssl_endpoint client_ep, server_ep;
2669
2670 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2671 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2672
2673 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002674 client_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002675 TEST_EQUAL(ret, 0);
2676
2677 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002678 server_options);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002679 TEST_EQUAL(ret, 0);
2680
2681 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2682 mbedtls_test_ticket_write,
2683 mbedtls_test_ticket_parse,
2684 NULL);
2685
2686 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2687 &(server_ep.socket), 1024);
2688 TEST_EQUAL(ret, 0);
2689
2690 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2691 &(server_ep.ssl), &(client_ep.ssl),
2692 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2693
2694 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2695
2696 do {
2697 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2698 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2699
2700 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2701 TEST_EQUAL(ret, 0);
2702
Gilles Peskine946bf142025-04-08 09:48:40 +02002703 ok = 1;
2704
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002705exit:
Gilles Peskineca8a9ac2025-05-27 20:52:24 +02002706 mbedtls_test_ssl_endpoint_free(&client_ep);
2707 mbedtls_test_ssl_endpoint_free(&server_ep);
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002708
Gilles Peskine946bf142025-04-08 09:48:40 +02002709 if (ret == 0 && !ok) {
2710 /* Exiting due to a test assertion that isn't ret == 0 */
2711 ret = -1;
2712 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002713 return ret;
2714}
2715#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2716 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2717 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2718
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002719#endif /* MBEDTLS_SSL_TLS_C */