blob: f917acc5742af3841424574d81c3d75252f31726 [file] [log] [blame]
Yanray Wang47907a42022-10-24 14:42:01 +08001/** \file ssl_helpers.c
2 *
3 * \brief Helper functions to set up a TLS connection.
4 */
5
6/*
7 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Yanray Wang47907a42022-10-24 14:42:01 +08009 */
10
11#include <test/ssl_helpers.h>
Valerio Setti384fbde2024-01-02 13:26:40 +010012#include "mbedtls/psa_util.h"
Yanray Wange6afd912022-10-27 12:11:18 +080013
Yanray Wang4d07d1c2022-10-27 15:28:16 +080014#if defined(MBEDTLS_SSL_TLS_C)
Ronald Cron10b040f2024-02-05 09:38:09 +010015int mbedtls_test_random(void *p_rng, unsigned char *output, size_t output_len)
Yanray Wange6afd912022-10-27 12:11:18 +080016{
17 (void) p_rng;
18 for (size_t i = 0; i < output_len; i++) {
19 output[i] = rand();
20 }
21
22 return 0;
23}
Yanray Wange6afd912022-10-27 12:11:18 +080024
Yanray Wange6afd912022-10-27 12:11:18 +080025void mbedtls_test_ssl_log_analyzer(void *ctx, int level,
26 const char *file, int line,
27 const char *str)
28{
29 mbedtls_test_ssl_log_pattern *p = (mbedtls_test_ssl_log_pattern *) ctx;
30
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010031/* Change 0 to 1 for debugging of test cases that use this function. */
32#if 0
33 const char *q, *basename;
34 /* Extract basename from file */
35 for (q = basename = file; *q != '\0'; q++) {
36 if (*q == '/' || *q == '\\') {
37 basename = q + 1;
38 }
39 }
40 printf("%s:%04d: |%d| %s",
41 basename, line, level, str);
42#else
Yanray Wange6afd912022-10-27 12:11:18 +080043 (void) level;
44 (void) line;
45 (void) file;
Manuel Pégourié-Gonnard6637ef72025-02-11 13:19:45 +010046#endif
Yanray Wange6afd912022-10-27 12:11:18 +080047
48 if (NULL != p &&
49 NULL != p->pattern &&
50 NULL != strstr(str, p->pattern)) {
51 p->counter++;
52 }
53}
54
55void mbedtls_test_init_handshake_options(
56 mbedtls_test_handshake_test_options *opts)
57{
58#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron987cf892024-03-04 10:24:27 +010059 static int rng_seed = 0xBEEF;
Yanray Wanga72bc9a2023-12-01 23:34:27 +080060
Yanray Wange6afd912022-10-27 12:11:18 +080061 srand(rng_seed);
62 rng_seed += 0xD0;
63#endif
Ronald Cronb4ad3e72024-01-26 14:57:53 +010064
65 memset(opts, 0, sizeof(*opts));
66
Yanray Wange6afd912022-10-27 12:11:18 +080067 opts->cipher = "";
68 opts->client_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
69 opts->client_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
70 opts->server_min_version = MBEDTLS_SSL_VERSION_UNKNOWN;
71 opts->server_max_version = MBEDTLS_SSL_VERSION_UNKNOWN;
Ronald Cron097ba142023-03-08 16:18:00 +010072 opts->expected_negotiated_version = MBEDTLS_SSL_VERSION_TLS1_3;
Yanray Wange6afd912022-10-27 12:11:18 +080073 opts->pk_alg = MBEDTLS_PK_RSA;
Yanray Wange6afd912022-10-27 12:11:18 +080074 opts->srv_auth_mode = MBEDTLS_SSL_VERIFY_NONE;
Yanray Wange6afd912022-10-27 12:11:18 +080075 opts->mfl = MBEDTLS_SSL_MAX_FRAG_LEN_NONE;
76 opts->cli_msg_len = 100;
77 opts->srv_msg_len = 100;
78 opts->expected_cli_fragments = 1;
79 opts->expected_srv_fragments = 1;
Yanray Wange6afd912022-10-27 12:11:18 +080080 opts->legacy_renegotiation = MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION;
Yanray Wange6afd912022-10-27 12:11:18 +080081 opts->resize_buffers = 1;
Ronald Cronced99be2024-01-26 15:49:12 +010082 opts->early_data = MBEDTLS_SSL_EARLY_DATA_DISABLED;
Ronald Cron5d3036e2024-02-23 07:43:45 +010083 opts->max_early_data_size = -1;
Yanray Wange6afd912022-10-27 12:11:18 +080084#if defined(MBEDTLS_SSL_CACHE_C)
Tom Cosgrove05b2a872023-07-21 11:31:13 +010085 TEST_CALLOC(opts->cache, 1);
Yanray Wange6afd912022-10-27 12:11:18 +080086 mbedtls_ssl_cache_init(opts->cache);
Pengyu Lv5cbb93e2023-07-10 11:09:40 +080087#if defined(MBEDTLS_HAVE_TIME)
88 TEST_EQUAL(mbedtls_ssl_cache_get_timeout(opts->cache),
89 MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT);
90#endif
Yanray Wange6afd912022-10-27 12:11:18 +080091exit:
92 return;
93#endif
94}
95
96void mbedtls_test_free_handshake_options(
97 mbedtls_test_handshake_test_options *opts)
98{
99#if defined(MBEDTLS_SSL_CACHE_C)
100 mbedtls_ssl_cache_free(opts->cache);
101 mbedtls_free(opts->cache);
102#else
103 (void) opts;
104#endif
105}
106
107#if defined(MBEDTLS_TEST_HOOKS)
108static void set_chk_buf_ptr_args(
109 mbedtls_ssl_chk_buf_ptr_args *args,
110 unsigned char *cur, unsigned char *end, size_t need)
111{
112 args->cur = cur;
113 args->end = end;
114 args->need = need;
115}
116
117static void reset_chk_buf_ptr_args(mbedtls_ssl_chk_buf_ptr_args *args)
118{
119 memset(args, 0, sizeof(*args));
120}
121#endif /* MBEDTLS_TEST_HOOKS */
122
Yanray Wange6afd912022-10-27 12:11:18 +0800123void mbedtls_test_ssl_buffer_init(mbedtls_test_ssl_buffer *buf)
124{
125 memset(buf, 0, sizeof(*buf));
126}
127
Yanray Wange6afd912022-10-27 12:11:18 +0800128int mbedtls_test_ssl_buffer_setup(mbedtls_test_ssl_buffer *buf,
129 size_t capacity)
130{
131 buf->buffer = (unsigned char *) mbedtls_calloc(capacity,
132 sizeof(unsigned char));
133 if (NULL == buf->buffer) {
134 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
135 }
136 buf->capacity = capacity;
137
138 return 0;
139}
140
141void mbedtls_test_ssl_buffer_free(mbedtls_test_ssl_buffer *buf)
142{
143 if (buf->buffer != NULL) {
144 mbedtls_free(buf->buffer);
145 }
146
147 memset(buf, 0, sizeof(*buf));
148}
149
Yanray Wange6afd912022-10-27 12:11:18 +0800150int mbedtls_test_ssl_buffer_put(mbedtls_test_ssl_buffer *buf,
151 const unsigned char *input, size_t input_len)
152{
153 size_t overflow = 0;
154
155 if ((buf == NULL) || (buf->buffer == NULL)) {
156 return -1;
157 }
158
159 /* Reduce input_len to a number that fits in the buffer. */
160 if ((buf->content_length + input_len) > buf->capacity) {
161 input_len = buf->capacity - buf->content_length;
162 }
163
164 if (input == NULL) {
165 return (input_len == 0) ? 0 : -1;
166 }
167
168 /* Check if the buffer has not come full circle and free space is not in
169 * the middle */
170 if (buf->start + buf->content_length < buf->capacity) {
171
172 /* Calculate the number of bytes that need to be placed at lower memory
173 * address */
174 if (buf->start + buf->content_length + input_len
175 > buf->capacity) {
176 overflow = (buf->start + buf->content_length + input_len)
177 % buf->capacity;
178 }
179
180 memcpy(buf->buffer + buf->start + buf->content_length, input,
181 input_len - overflow);
182 memcpy(buf->buffer, input + input_len - overflow, overflow);
183
184 } else {
185 /* The buffer has come full circle and free space is in the middle */
186 memcpy(buf->buffer + buf->start + buf->content_length - buf->capacity,
187 input, input_len);
188 }
189
190 buf->content_length += input_len;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800191 return (input_len > INT_MAX) ? INT_MAX : (int) input_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800192}
193
Yanray Wange6afd912022-10-27 12:11:18 +0800194int mbedtls_test_ssl_buffer_get(mbedtls_test_ssl_buffer *buf,
195 unsigned char *output, size_t output_len)
196{
197 size_t overflow = 0;
198
199 if ((buf == NULL) || (buf->buffer == NULL)) {
200 return -1;
201 }
202
203 if (output == NULL && output_len == 0) {
204 return 0;
205 }
206
207 if (buf->content_length < output_len) {
208 output_len = buf->content_length;
209 }
210
211 /* Calculate the number of bytes that need to be drawn from lower memory
212 * address */
213 if (buf->start + output_len > buf->capacity) {
214 overflow = (buf->start + output_len) % buf->capacity;
215 }
216
217 if (output != NULL) {
218 memcpy(output, buf->buffer + buf->start, output_len - overflow);
219 memcpy(output + output_len - overflow, buf->buffer, overflow);
220 }
221
222 buf->content_length -= output_len;
223 buf->start = (buf->start + output_len) % buf->capacity;
224
Yanray Wanga8f445e2022-11-03 11:51:59 +0800225 return (output_len > INT_MAX) ? INT_MAX : (int) output_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800226}
227
Yanray Wangd19894f2023-03-16 11:47:39 +0800228int mbedtls_test_ssl_message_queue_setup(
229 mbedtls_test_ssl_message_queue *queue, size_t capacity)
Yanray Wange6afd912022-10-27 12:11:18 +0800230{
231 queue->messages = (size_t *) mbedtls_calloc(capacity, sizeof(size_t));
232 if (NULL == queue->messages) {
233 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
234 }
235
Yanray Wanga8f445e2022-11-03 11:51:59 +0800236 queue->capacity = (capacity > INT_MAX) ? INT_MAX : (int) capacity;
Yanray Wange6afd912022-10-27 12:11:18 +0800237 queue->pos = 0;
238 queue->num = 0;
239
240 return 0;
241}
242
Yanray Wangd19894f2023-03-16 11:47:39 +0800243void mbedtls_test_ssl_message_queue_free(
244 mbedtls_test_ssl_message_queue *queue)
Yanray Wange6afd912022-10-27 12:11:18 +0800245{
246 if (queue == NULL) {
247 return;
248 }
249
250 if (queue->messages != NULL) {
251 mbedtls_free(queue->messages);
252 }
253
254 memset(queue, 0, sizeof(*queue));
255}
256
Yanray Wange6afd912022-10-27 12:11:18 +0800257int mbedtls_test_ssl_message_queue_push_info(
258 mbedtls_test_ssl_message_queue *queue, size_t len)
259{
260 int place;
261 if (queue == NULL) {
262 return MBEDTLS_TEST_ERROR_ARG_NULL;
263 }
264
265 if (queue->num >= queue->capacity) {
266 return MBEDTLS_ERR_SSL_WANT_WRITE;
267 }
268
269 place = (queue->pos + queue->num) % queue->capacity;
270 queue->messages[place] = len;
271 queue->num++;
Yanray Wanga8f445e2022-11-03 11:51:59 +0800272 return (len > INT_MAX) ? INT_MAX : (int) len;
Yanray Wange6afd912022-10-27 12:11:18 +0800273}
274
Yanray Wange6afd912022-10-27 12:11:18 +0800275int mbedtls_test_ssl_message_queue_pop_info(
276 mbedtls_test_ssl_message_queue *queue, size_t buf_len)
277{
278 size_t message_length;
279 if (queue == NULL) {
280 return MBEDTLS_TEST_ERROR_ARG_NULL;
281 }
282 if (queue->num == 0) {
283 return MBEDTLS_ERR_SSL_WANT_READ;
284 }
285
286 message_length = queue->messages[queue->pos];
287 queue->messages[queue->pos] = 0;
288 queue->num--;
289 queue->pos++;
290 queue->pos %= queue->capacity;
291 if (queue->pos < 0) {
292 queue->pos += queue->capacity;
293 }
294
Yanray Wanga8f445e2022-11-03 11:51:59 +0800295 return (message_length > INT_MAX && buf_len > INT_MAX) ? INT_MAX :
296 (message_length > buf_len) ? (int) buf_len : (int) message_length;
Yanray Wange6afd912022-10-27 12:11:18 +0800297}
298
299/*
300 * Take a peek on the info about the next message length from the queue.
301 * This will be the oldest inserted message length(fifo).
302 *
303 * \retval MBEDTLS_TEST_ERROR_ARG_NULL, if the queue is null.
304 * \retval MBEDTLS_ERR_SSL_WANT_READ, if the queue is empty.
305 * \retval 0, if the peek was successful.
306 * \retval MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED, if the given buffer length is
307 * too small to fit the message. In this case the \p msg_len will be
308 * set to the full message length so that the
309 * caller knows what portion of the message can be dropped.
310 */
Yanray Wang5e22a922023-03-16 14:57:54 +0800311static int test_ssl_message_queue_peek_info(
312 mbedtls_test_ssl_message_queue *queue,
313 size_t buf_len, size_t *msg_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800314{
315 if (queue == NULL || msg_len == NULL) {
316 return MBEDTLS_TEST_ERROR_ARG_NULL;
317 }
318 if (queue->num == 0) {
319 return MBEDTLS_ERR_SSL_WANT_READ;
320 }
321
322 *msg_len = queue->messages[queue->pos];
323 return (*msg_len > buf_len) ? MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED : 0;
324}
325
Yanray Wang5f86a422023-03-15 16:02:29 +0800326void mbedtls_test_mock_socket_init(mbedtls_test_mock_socket *socket)
Yanray Wange6afd912022-10-27 12:11:18 +0800327{
328 memset(socket, 0, sizeof(*socket));
329}
330
Yanray Wange6afd912022-10-27 12:11:18 +0800331void mbedtls_test_mock_socket_close(mbedtls_test_mock_socket *socket)
332{
333 if (socket == NULL) {
334 return;
335 }
336
337 if (socket->input != NULL) {
338 mbedtls_test_ssl_buffer_free(socket->input);
339 mbedtls_free(socket->input);
340 }
341
342 if (socket->output != NULL) {
343 mbedtls_test_ssl_buffer_free(socket->output);
344 mbedtls_free(socket->output);
345 }
346
347 if (socket->peer != NULL) {
348 memset(socket->peer, 0, sizeof(*socket->peer));
349 }
350
351 memset(socket, 0, sizeof(*socket));
352}
353
Yanray Wange6afd912022-10-27 12:11:18 +0800354int mbedtls_test_mock_socket_connect(mbedtls_test_mock_socket *peer1,
355 mbedtls_test_mock_socket *peer2,
356 size_t bufsize)
357{
358 int ret = -1;
359
360 peer1->output =
361 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
362 1, sizeof(mbedtls_test_ssl_buffer));
363 if (peer1->output == NULL) {
364 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
365 goto exit;
366 }
367 mbedtls_test_ssl_buffer_init(peer1->output);
368 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer1->output, bufsize))) {
369 goto exit;
370 }
371
372 peer2->output =
373 (mbedtls_test_ssl_buffer *) mbedtls_calloc(
374 1, sizeof(mbedtls_test_ssl_buffer));
375 if (peer2->output == NULL) {
376 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
377 goto exit;
378 }
379 mbedtls_test_ssl_buffer_init(peer2->output);
380 if (0 != (ret = mbedtls_test_ssl_buffer_setup(peer2->output, bufsize))) {
381 goto exit;
382 }
383
384 peer1->peer = peer2;
385 peer2->peer = peer1;
386 peer1->input = peer2->output;
387 peer2->input = peer1->output;
388
389 peer1->status = peer2->status = MBEDTLS_MOCK_SOCKET_CONNECTED;
390 ret = 0;
391
392exit:
393
394 if (ret != 0) {
395 mbedtls_test_mock_socket_close(peer1);
396 mbedtls_test_mock_socket_close(peer2);
397 }
398
399 return ret;
400}
401
Yanray Wangaf727a22023-03-13 19:22:36 +0800402int mbedtls_test_mock_tcp_send_b(void *ctx,
403 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800404{
405 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
406
407 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
408 return -1;
409 }
410
411 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
412}
413
414int mbedtls_test_mock_tcp_recv_b(void *ctx, unsigned char *buf, size_t len)
415{
416 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
417
418 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
419 return -1;
420 }
421
422 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
423}
424
Yanray Wang34634352023-02-14 17:56:51 +0800425int mbedtls_test_mock_tcp_send_nb(void *ctx,
426 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800427{
428 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
429
430 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
431 return -1;
432 }
433
434 if (socket->output->capacity == socket->output->content_length) {
435 return MBEDTLS_ERR_SSL_WANT_WRITE;
436 }
437
438 return mbedtls_test_ssl_buffer_put(socket->output, buf, len);
439}
440
441int mbedtls_test_mock_tcp_recv_nb(void *ctx, unsigned char *buf, size_t len)
442{
443 mbedtls_test_mock_socket *socket = (mbedtls_test_mock_socket *) ctx;
444
445 if (socket == NULL || socket->status != MBEDTLS_MOCK_SOCKET_CONNECTED) {
446 return -1;
447 }
448
449 if (socket->input->content_length == 0) {
450 return MBEDTLS_ERR_SSL_WANT_READ;
451 }
452
453 return mbedtls_test_ssl_buffer_get(socket->input, buf, len);
454}
455
Yanray Wangd19894f2023-03-16 11:47:39 +0800456void mbedtls_test_message_socket_init(
457 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800458{
459 ctx->queue_input = NULL;
460 ctx->queue_output = NULL;
461 ctx->socket = NULL;
462}
463
Yanray Wange6afd912022-10-27 12:11:18 +0800464int mbedtls_test_message_socket_setup(
465 mbedtls_test_ssl_message_queue *queue_input,
466 mbedtls_test_ssl_message_queue *queue_output,
467 size_t queue_capacity,
468 mbedtls_test_mock_socket *socket,
469 mbedtls_test_message_socket_context *ctx)
470{
471 int ret = mbedtls_test_ssl_message_queue_setup(queue_input, queue_capacity);
472 if (ret != 0) {
473 return ret;
474 }
475 ctx->queue_input = queue_input;
476 ctx->queue_output = queue_output;
477 ctx->socket = socket;
Yanray Wang5f86a422023-03-15 16:02:29 +0800478 mbedtls_test_mock_socket_init(socket);
Yanray Wange6afd912022-10-27 12:11:18 +0800479
480 return 0;
481}
482
Yanray Wangd19894f2023-03-16 11:47:39 +0800483void mbedtls_test_message_socket_close(
484 mbedtls_test_message_socket_context *ctx)
Yanray Wange6afd912022-10-27 12:11:18 +0800485{
486 if (ctx == NULL) {
487 return;
488 }
489
490 mbedtls_test_ssl_message_queue_free(ctx->queue_input);
491 mbedtls_test_mock_socket_close(ctx->socket);
492 memset(ctx, 0, sizeof(*ctx));
493}
494
Yanray Wang34634352023-02-14 17:56:51 +0800495int mbedtls_test_mock_tcp_send_msg(void *ctx,
496 const unsigned char *buf, size_t len)
Yanray Wange6afd912022-10-27 12:11:18 +0800497{
498 mbedtls_test_ssl_message_queue *queue;
499 mbedtls_test_mock_socket *socket;
500 mbedtls_test_message_socket_context *context =
501 (mbedtls_test_message_socket_context *) ctx;
502
503 if (context == NULL || context->socket == NULL
504 || context->queue_output == NULL) {
505 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
506 }
507
508 queue = context->queue_output;
509 socket = context->socket;
510
511 if (queue->num >= queue->capacity) {
512 return MBEDTLS_ERR_SSL_WANT_WRITE;
513 }
514
515 if (mbedtls_test_mock_tcp_send_b(socket, buf, len) != (int) len) {
516 return MBEDTLS_TEST_ERROR_SEND_FAILED;
517 }
518
519 return mbedtls_test_ssl_message_queue_push_info(queue, len);
520}
521
Yanray Wang34634352023-02-14 17:56:51 +0800522int mbedtls_test_mock_tcp_recv_msg(void *ctx,
523 unsigned char *buf, size_t buf_len)
Yanray Wange6afd912022-10-27 12:11:18 +0800524{
525 mbedtls_test_ssl_message_queue *queue;
526 mbedtls_test_mock_socket *socket;
527 mbedtls_test_message_socket_context *context =
528 (mbedtls_test_message_socket_context *) ctx;
529 size_t drop_len = 0;
530 size_t msg_len;
531 int ret;
532
533 if (context == NULL || context->socket == NULL
534 || context->queue_input == NULL) {
535 return MBEDTLS_TEST_ERROR_CONTEXT_ERROR;
536 }
537
538 queue = context->queue_input;
539 socket = context->socket;
540
541 /* Peek first, so that in case of a socket error the data remains in
542 * the queue. */
Yanray Wang5e22a922023-03-16 14:57:54 +0800543 ret = test_ssl_message_queue_peek_info(queue, buf_len, &msg_len);
Yanray Wange6afd912022-10-27 12:11:18 +0800544 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
545 /* Calculate how much to drop */
546 drop_len = msg_len - buf_len;
547
548 /* Set the requested message len to be buffer length */
549 msg_len = buf_len;
550 } else if (ret != 0) {
551 return ret;
552 }
553
554 if (mbedtls_test_mock_tcp_recv_b(socket, buf, msg_len) != (int) msg_len) {
555 return MBEDTLS_TEST_ERROR_RECV_FAILED;
556 }
557
558 if (ret == MBEDTLS_TEST_ERROR_MESSAGE_TRUNCATED) {
559 /* Drop the remaining part of the message */
Yanray Wangaf727a22023-03-13 19:22:36 +0800560 if (mbedtls_test_mock_tcp_recv_b(socket, NULL, drop_len) !=
561 (int) drop_len) {
Yanray Wange6afd912022-10-27 12:11:18 +0800562 /* Inconsistent state - part of the message was read,
563 * and a part couldn't. Not much we can do here, but it should not
564 * happen in test environment, unless forced manually. */
565 }
566 }
Tomás Gonzáleza9b90de2024-02-01 11:12:20 +0000567 ret = mbedtls_test_ssl_message_queue_pop_info(queue, buf_len);
568 if (ret < 0) {
569 return ret;
570 }
Yanray Wange6afd912022-10-27 12:11:18 +0800571
Yanray Wanga8f445e2022-11-03 11:51:59 +0800572 return (msg_len > INT_MAX) ? INT_MAX : (int) msg_len;
Yanray Wange6afd912022-10-27 12:11:18 +0800573}
574
575#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
576
577/*
578 * Deinitializes certificates from endpoint represented by \p ep.
579 */
Yanray Wangf6f71902023-03-15 16:05:14 +0800580static void test_ssl_endpoint_certificate_free(mbedtls_test_ssl_endpoint *ep)
Yanray Wange6afd912022-10-27 12:11:18 +0800581{
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200582 if (ep->ca_chain != NULL) {
583 mbedtls_x509_crt_free(ep->ca_chain);
584 mbedtls_free(ep->ca_chain);
585 ep->ca_chain = NULL;
586 }
587 if (ep->cert != NULL) {
588 mbedtls_x509_crt_free(ep->cert);
589 mbedtls_free(ep->cert);
590 ep->cert = NULL;
591 }
592 if (ep->pkey != NULL) {
Yanray Wange6afd912022-10-27 12:11:18 +0800593#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200594 if (mbedtls_pk_get_type(ep->pkey) == MBEDTLS_PK_OPAQUE) {
595 psa_destroy_key(ep->pkey->priv_id);
Yanray Wange6afd912022-10-27 12:11:18 +0800596 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200597#endif
598 mbedtls_pk_free(ep->pkey);
599 mbedtls_free(ep->pkey);
600 ep->pkey = NULL;
Yanray Wange6afd912022-10-27 12:11:18 +0800601 }
602}
603
Yanray Wange6afd912022-10-27 12:11:18 +0800604int mbedtls_test_ssl_endpoint_certificate_init(mbedtls_test_ssl_endpoint *ep,
605 int pk_alg,
606 int opaque_alg, int opaque_alg2,
607 int opaque_usage)
608{
609 int i = 0;
610 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +0200611 int ok = 0;
Yanray Wange6afd912022-10-27 12:11:18 +0800612#if defined(MBEDTLS_USE_PSA_CRYPTO)
613 mbedtls_svc_key_id_t key_slot = MBEDTLS_SVC_KEY_ID_INIT;
614#endif
615
616 if (ep == NULL) {
617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
618 }
619
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200620 TEST_CALLOC(ep->ca_chain, 1);
621 TEST_CALLOC(ep->cert, 1);
622 TEST_CALLOC(ep->pkey, 1);
Yanray Wange6afd912022-10-27 12:11:18 +0800623
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200624 mbedtls_x509_crt_init(ep->ca_chain);
625 mbedtls_x509_crt_init(ep->cert);
626 mbedtls_pk_init(ep->pkey);
Yanray Wange6afd912022-10-27 12:11:18 +0800627
628 /* Load the trusted CA */
629
630 for (i = 0; mbedtls_test_cas_der[i] != NULL; i++) {
631 ret = mbedtls_x509_crt_parse_der(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200632 ep->ca_chain,
Yanray Wange6afd912022-10-27 12:11:18 +0800633 (const unsigned char *) mbedtls_test_cas_der[i],
634 mbedtls_test_cas_der_len[i]);
Gilles Peskine353eb332025-05-14 17:42:53 +0200635 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800636 }
637
638 /* Load own certificate and private key */
639
640 if (ep->conf.endpoint == MBEDTLS_SSL_IS_SERVER) {
641 if (pk_alg == MBEDTLS_PK_RSA) {
642 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200643 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800644 (const unsigned char *) mbedtls_test_srv_crt_rsa_sha256_der,
645 mbedtls_test_srv_crt_rsa_sha256_der_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200646 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800647
648 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200649 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800650 (const unsigned char *) mbedtls_test_srv_key_rsa_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000651 mbedtls_test_srv_key_rsa_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200652 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800653 } else {
654 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200655 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800656 (const unsigned char *) mbedtls_test_srv_crt_ec_der,
657 mbedtls_test_srv_crt_ec_der_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200658 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800659
660 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200661 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800662 (const unsigned char *) mbedtls_test_srv_key_ec_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000663 mbedtls_test_srv_key_ec_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200664 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800665 }
666 } else {
667 if (pk_alg == MBEDTLS_PK_RSA) {
668 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200669 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800670 (const unsigned char *) mbedtls_test_cli_crt_rsa_der,
671 mbedtls_test_cli_crt_rsa_der_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200672 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800673
674 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200675 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800676 (const unsigned char *) mbedtls_test_cli_key_rsa_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000677 mbedtls_test_cli_key_rsa_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200678 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800679 } else {
680 ret = mbedtls_x509_crt_parse(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200681 ep->cert,
Yanray Wange6afd912022-10-27 12:11:18 +0800682 (const unsigned char *) mbedtls_test_cli_crt_ec_der,
683 mbedtls_test_cli_crt_ec_len);
Gilles Peskine353eb332025-05-14 17:42:53 +0200684 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800685
686 ret = mbedtls_pk_parse_key(
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200687 ep->pkey,
Yanray Wange6afd912022-10-27 12:11:18 +0800688 (const unsigned char *) mbedtls_test_cli_key_ec_der,
Ben Taylor440cb2a2025-03-05 09:40:08 +0000689 mbedtls_test_cli_key_ec_der_len, NULL, 0);
Gilles Peskine353eb332025-05-14 17:42:53 +0200690 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800691 }
692 }
693
694#if defined(MBEDTLS_USE_PSA_CRYPTO)
695 if (opaque_alg != 0) {
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100696 psa_key_attributes_t key_attr = PSA_KEY_ATTRIBUTES_INIT;
697 /* Use a fake key usage to get a successful initial guess for the PSA attributes. */
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200698 TEST_EQUAL(mbedtls_pk_get_psa_attributes(ep->pkey, PSA_KEY_USAGE_SIGN_HASH,
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100699 &key_attr), 0);
Valerio Settia9de9442024-02-27 13:56:09 +0100700 /* Then manually usage, alg and alg2 as requested by the test. */
Valerio Setti1fa2f6e2024-02-27 08:11:25 +0100701 psa_set_key_usage_flags(&key_attr, opaque_usage);
702 psa_set_key_algorithm(&key_attr, opaque_alg);
703 if (opaque_alg2 != PSA_ALG_NONE) {
704 psa_set_key_enrollment_algorithm(&key_attr, opaque_alg2);
705 }
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200706 TEST_EQUAL(mbedtls_pk_import_into_psa(ep->pkey, &key_attr, &key_slot), 0);
707 mbedtls_pk_free(ep->pkey);
708 mbedtls_pk_init(ep->pkey);
709 TEST_EQUAL(mbedtls_pk_setup_opaque(ep->pkey, key_slot), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800710 }
711#else
712 (void) opaque_alg;
713 (void) opaque_alg2;
714 (void) opaque_usage;
715#endif
716
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200717 mbedtls_ssl_conf_ca_chain(&(ep->conf), ep->ca_chain, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +0800718
Gilles Peskineb6bb3fb2025-05-26 21:57:52 +0200719 ret = mbedtls_ssl_conf_own_cert(&(ep->conf), ep->cert,
720 ep->pkey);
Gilles Peskine353eb332025-05-14 17:42:53 +0200721 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800722
Gilles Peskine946bf142025-04-08 09:48:40 +0200723 ok = 1;
724
Yanray Wange6afd912022-10-27 12:11:18 +0800725exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200726 if (ret == 0 && !ok) {
727 /* Exiting due to a test assertion that isn't ret == 0 */
728 ret = -1;
729 }
Yanray Wange6afd912022-10-27 12:11:18 +0800730 if (ret != 0) {
Yanray Wangf6f71902023-03-15 16:05:14 +0800731 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800732 }
733
734 return ret;
735}
736
Yanray Wange6afd912022-10-27 12:11:18 +0800737int mbedtls_test_ssl_endpoint_init(
738 mbedtls_test_ssl_endpoint *ep, int endpoint_type,
Gilles Peskine9b993682025-05-27 18:44:12 +0200739 const mbedtls_test_handshake_test_options *options,
Yanray Wange6afd912022-10-27 12:11:18 +0800740 mbedtls_test_message_socket_context *dtls_context,
741 mbedtls_test_ssl_message_queue *input_queue,
Ronald Cronfb536472024-01-26 14:55:25 +0100742 mbedtls_test_ssl_message_queue *output_queue)
Yanray Wange6afd912022-10-27 12:11:18 +0800743{
Gilles Peskine29969592025-05-27 19:24:28 +0200744 (void) dtls_context; // no longer used
745
Yanray Wange6afd912022-10-27 12:11:18 +0800746 int ret = -1;
747 uintptr_t user_data_n;
748
Gilles Peskine29969592025-05-27 19:24:28 +0200749 if (options->dtls &&
Yanray Wange6afd912022-10-27 12:11:18 +0800750 (input_queue == NULL || output_queue == NULL)) {
751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
752
753 }
754
755 if (ep == NULL) {
756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
757 }
758
759 memset(ep, 0, sizeof(*ep));
760
761 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
762
763 mbedtls_ssl_init(&(ep->ssl));
764 mbedtls_ssl_config_init(&(ep->conf));
Gilles Peskine29969592025-05-27 19:24:28 +0200765 mbedtls_test_message_socket_init(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800766
767 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
768 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
769 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
770 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
771
772 (void) mbedtls_test_rnd_std_rand(NULL,
773 (void *) &user_data_n,
774 sizeof(user_data_n));
775 mbedtls_ssl_conf_set_user_data_n(&ep->conf, user_data_n);
776 mbedtls_ssl_set_user_data_n(&ep->ssl, user_data_n);
777
Gilles Peskine29969592025-05-27 19:24:28 +0200778 if (options->dtls) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200779 TEST_EQUAL(mbedtls_test_message_socket_setup(input_queue, output_queue,
780 100, &(ep->socket),
Gilles Peskine29969592025-05-27 19:24:28 +0200781 &ep->dtls_context), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800782 } else {
Yanray Wang5f86a422023-03-15 16:02:29 +0800783 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800784 }
785
786 /* Non-blocking callbacks without timeout */
Gilles Peskine29969592025-05-27 19:24:28 +0200787 if (options->dtls) {
788 mbedtls_ssl_set_bio(&(ep->ssl), &ep->dtls_context,
Yanray Wange6afd912022-10-27 12:11:18 +0800789 mbedtls_test_mock_tcp_send_msg,
790 mbedtls_test_mock_tcp_recv_msg,
791 NULL);
Gilles Peskine0677e022025-05-27 18:05:20 +0200792#if defined(MBEDTLS_TIMING_C)
793 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
794 mbedtls_timing_set_delay,
795 mbedtls_timing_get_delay);
796#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800797 } else {
798 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
799 mbedtls_test_mock_tcp_send_nb,
800 mbedtls_test_mock_tcp_recv_nb,
801 NULL);
802 }
803
804 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
Gilles Peskine29969592025-05-27 19:24:28 +0200805 options->dtls ?
Yanray Wange6afd912022-10-27 12:11:18 +0800806 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
807 MBEDTLS_SSL_TRANSPORT_STREAM,
808 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200809 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800810
Ronald Crona697a712023-03-09 17:47:42 +0100811 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
812 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
813 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
814 options->client_min_version);
815 }
816
817 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
818 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
819 options->client_max_version);
820 }
821 } else {
822 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
823 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
824 options->server_min_version);
825 }
826
827 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
828 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
829 options->server_max_version);
830 }
831 }
832
Ronald Cronfb536472024-01-26 14:55:25 +0100833 if (options->group_list != NULL) {
834 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800835 }
836
837 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
838
Ronald Cronced99be2024-01-26 15:49:12 +0100839#if defined(MBEDTLS_SSL_EARLY_DATA)
840 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100841#if defined(MBEDTLS_SSL_SRV_C)
842 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
843 (options->max_early_data_size >= 0)) {
844 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
845 options->max_early_data_size);
846 }
847#endif
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000848#if defined(MBEDTLS_SSL_ALPN)
849 /* check that alpn_list contains at least one valid entry */
850 if (options->alpn_list[0] != NULL) {
851 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
852 }
853#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100854#endif
855
Yanray Wange6afd912022-10-27 12:11:18 +0800856#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
857 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
858 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
859 mbedtls_ssl_cache_get,
860 mbedtls_ssl_cache_set);
861 }
862#endif
863
864 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
Gilles Peskine353eb332025-05-14 17:42:53 +0200865 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800866
Gilles Peskine856a3702025-02-13 17:28:49 +0100867 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
868 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
Gilles Peskine55b8bb42025-04-08 09:44:34 +0200869 TEST_EQUAL(ret, 0);
Gilles Peskine856a3702025-02-13 17:28:49 +0100870 }
871
Yanray Wange6afd912022-10-27 12:11:18 +0800872#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine29969592025-05-27 19:24:28 +0200873 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->dtls) {
Yanray Wange6afd912022-10-27 12:11:18 +0800874 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
875 }
876#endif
877
Ronald Cronec3408d2024-01-16 17:50:40 +0100878#if defined(MBEDTLS_DEBUG_C)
879#if defined(MBEDTLS_SSL_SRV_C)
880 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
881 options->srv_log_fun != NULL) {
882 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
883 options->srv_log_obj);
884 }
885#endif
886#if defined(MBEDTLS_SSL_CLI_C)
887 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
888 options->cli_log_fun != NULL) {
889 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
890 options->cli_log_obj);
891 }
892#endif
893#endif /* MBEDTLS_DEBUG_C */
894
Yanray Wange6afd912022-10-27 12:11:18 +0800895 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
896 options->opaque_alg,
897 options->opaque_alg2,
898 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200899 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800900
901 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), user_data_n);
902 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
903 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), user_data_n);
904 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
905
Gilles Peskine946bf142025-04-08 09:48:40 +0200906 return 0;
907
Yanray Wange6afd912022-10-27 12:11:18 +0800908exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200909 if (ret == 0) {
910 /* Exiting due to a test assertion that isn't ret == 0 */
911 ret = -1;
912 }
Yanray Wange6afd912022-10-27 12:11:18 +0800913 return ret;
914}
915
Yanray Wange6afd912022-10-27 12:11:18 +0800916void mbedtls_test_ssl_endpoint_free(
917 mbedtls_test_ssl_endpoint *ep,
918 mbedtls_test_message_socket_context *context)
919{
Gilles Peskine29969592025-05-27 19:24:28 +0200920 (void) context; // no longer used
921
Yanray Wange6afd912022-10-27 12:11:18 +0800922 mbedtls_ssl_free(&(ep->ssl));
923 mbedtls_ssl_config_free(&(ep->conf));
924
Gilles Peskine2744a432025-05-27 13:27:22 +0200925 mbedtls_free(ep->ciphersuites);
926 ep->ciphersuites = NULL;
927 test_ssl_endpoint_certificate_free(ep);
928
Gilles Peskine29969592025-05-27 19:24:28 +0200929 if (ep->dtls_context.socket != NULL) {
930 mbedtls_test_message_socket_close(&ep->dtls_context);
Yanray Wange6afd912022-10-27 12:11:18 +0800931 } else {
932 mbedtls_test_mock_socket_close(&(ep->socket));
933 }
934}
935
Gilles Peskineb092e782025-05-27 20:15:03 +0200936int mbedtls_test_ssl_dtls_join_endpoints(mbedtls_test_ssl_endpoint *client,
937 mbedtls_test_ssl_endpoint *server)
938{
939 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
940
941 /* Nothing to do yet. */
942 (void) client;
943 (void) server;
944 ret = 0;
945
946 return ret;
947}
948
Yanray Wange6afd912022-10-27 12:11:18 +0800949int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
950 mbedtls_ssl_context *second_ssl,
951 int state)
952{
953 enum { BUFFSIZE = 1024 };
954 int max_steps = 1000;
955 int ret = 0;
956
957 if (ssl == NULL || second_ssl == NULL) {
958 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
959 }
960
961 /* Perform communication via connected sockets */
962 while ((ssl->state != state) && (--max_steps >= 0)) {
963 /* If /p second_ssl ends the handshake procedure before /p ssl then
964 * there is no need to call the next step */
965 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
966 ret = mbedtls_ssl_handshake_step(second_ssl);
967 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
968 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
969 return ret;
970 }
971 }
972
973 /* We only care about the \p ssl state and returns, so we call it last,
974 * to leave the iteration as soon as the state is as expected. */
975 ret = mbedtls_ssl_handshake_step(ssl);
976 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
977 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
978 return ret;
979 }
980 }
981
982 return (max_steps >= 0) ? ret : -1;
983}
984
985#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
986
987/*
988 * Write application data. Increase write counter if necessary.
989 */
Michael Schuster54300d42024-06-04 02:30:22 +0200990static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +0200991 unsigned char *buf, int buf_len,
992 int *written,
993 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +0800994{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100995 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +0800996 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
997 * a valid no-op for TLS connections. */
998 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200999 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001000 }
1001
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001002 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +08001003 if (ret > 0) {
1004 *written += ret;
1005 }
1006
1007 if (expected_fragments == 0) {
1008 /* Used for DTLS and the message size larger than MFL. In that case
1009 * the message can not be fragmented and the library should return
1010 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +08001011 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +08001012 return ret;
1013 } else if (expected_fragments == 1) {
1014 /* Used for TLS/DTLS and the message size lower than MFL */
1015 TEST_ASSERT(ret == buf_len ||
1016 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1017 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1018 } else {
1019 /* Used for TLS and the message size larger than MFL */
1020 TEST_ASSERT(expected_fragments > 1);
1021 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1022 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1023 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1024 }
1025
1026 return 0;
1027
1028exit:
1029 /* Some of the tests failed */
1030 return -1;
1031}
1032
1033/*
1034 * Read application data and increase read counter and fragments counter
1035 * if necessary.
1036 */
Michael Schuster54300d42024-06-04 02:30:22 +02001037static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001038 unsigned char *buf, int buf_len,
1039 int *read, int *fragments,
1040 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001041{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001042 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001043 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1044 * a valid no-op for TLS connections. */
1045 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001046 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001047 }
1048
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001049 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001050 if (ret > 0) {
1051 (*fragments)++;
1052 *read += ret;
1053 }
1054
1055 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001056 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001057 } else if (expected_fragments == 1) {
1058 TEST_ASSERT(ret == buf_len ||
1059 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1060 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1061 } else {
1062 TEST_ASSERT(expected_fragments > 1);
1063 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1064 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1065 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1066 }
1067
1068 return 0;
1069
1070exit:
1071 /* Some of the tests failed */
1072 return -1;
1073}
1074
Yanray Wangead70c82023-03-16 12:04:49 +08001075#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine2744a432025-05-27 13:27:22 +02001076static int set_ciphersuite(mbedtls_test_ssl_endpoint *ep,
1077 const char *cipher)
Yanray Wange6afd912022-10-27 12:11:18 +08001078{
Gilles Peskine2744a432025-05-27 13:27:22 +02001079 if (cipher == NULL || cipher[0] == 0) {
1080 return 1;
1081 }
Yanray Wange6afd912022-10-27 12:11:18 +08001082
Gilles Peskine2744a432025-05-27 13:27:22 +02001083 int ok = 0;
1084
1085 TEST_CALLOC(ep->ciphersuites, 2);
1086 ep->ciphersuites[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
1087 ep->ciphersuites[1] = 0;
1088
1089 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1090 mbedtls_ssl_ciphersuite_from_id(ep->ciphersuites[0]);
Yanray Wange6afd912022-10-27 12:11:18 +08001091
1092 TEST_ASSERT(ciphersuite_info != NULL);
Gilles Peskine2744a432025-05-27 13:27:22 +02001093 TEST_ASSERT(ciphersuite_info->min_tls_version <= ep->conf.max_tls_version);
1094 TEST_ASSERT(ciphersuite_info->max_tls_version >= ep->conf.min_tls_version);
Yanray Wange6afd912022-10-27 12:11:18 +08001095
Gilles Peskine2744a432025-05-27 13:27:22 +02001096 if (ep->conf.max_tls_version > ciphersuite_info->max_tls_version) {
1097 ep->conf.max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001098 }
Gilles Peskine2744a432025-05-27 13:27:22 +02001099 if (ep->conf.min_tls_version < ciphersuite_info->min_tls_version) {
1100 ep->conf.min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001101 }
1102
Gilles Peskine2744a432025-05-27 13:27:22 +02001103 mbedtls_ssl_conf_ciphersuites(&ep->conf, ep->ciphersuites);
1104 ok = 1;
Yanray Wange6afd912022-10-27 12:11:18 +08001105
1106exit:
Gilles Peskine2744a432025-05-27 13:27:22 +02001107 return ok;
Yanray Wange6afd912022-10-27 12:11:18 +08001108}
Yanray Wangead70c82023-03-16 12:04:49 +08001109#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Yanray Wange6afd912022-10-27 12:11:18 +08001110
Yanray Wangead70c82023-03-16 12:04:49 +08001111#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
1112 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
1113 defined(MBEDTLS_SSL_SRV_C)
1114static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
1115 const unsigned char *name, size_t name_len)
Yanray Wange6afd912022-10-27 12:11:18 +08001116{
1117 (void) p_info;
1118 (void) ssl;
1119 (void) name;
1120 (void) name_len;
1121
1122 return 0;
1123}
Yanray Wangead70c82023-03-16 12:04:49 +08001124#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
1125 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
1126 MBEDTLS_SSL_SRV_C */
Yanray Wange6afd912022-10-27 12:11:18 +08001127
1128#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001129 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001130int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1131 const unsigned char *iv,
1132 size_t iv_len,
1133 const unsigned char *input,
1134 size_t ilen,
1135 unsigned char *output,
1136 size_t *olen)
1137{
1138#if defined(MBEDTLS_USE_PSA_CRYPTO)
1139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1140 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1141 size_t part_len;
1142
1143 status = psa_cipher_encrypt_setup(&cipher_op,
1144 transform->psa_key_enc,
1145 transform->psa_alg);
1146
1147 if (status != PSA_SUCCESS) {
1148 return PSA_TO_MBEDTLS_ERR(status);
1149 }
1150
1151 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1152
1153 if (status != PSA_SUCCESS) {
1154 return PSA_TO_MBEDTLS_ERR(status);
1155 }
1156
1157 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1158
1159 if (status != PSA_SUCCESS) {
1160 return PSA_TO_MBEDTLS_ERR(status);
1161 }
1162
1163 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1164 &part_len);
1165
1166 if (status != PSA_SUCCESS) {
1167 return PSA_TO_MBEDTLS_ERR(status);
1168 }
1169
1170 *olen += part_len;
1171 return 0;
1172#else
1173 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1174 iv, iv_len, input, ilen, output, olen);
1175#endif /* MBEDTLS_USE_PSA_CRYPTO */
1176}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001177#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001178 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001179
Valerio Setti31ad3a12023-10-27 11:55:02 +02001180static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1181 mbedtls_cipher_mode_t *cipher_mode,
1182 size_t *key_bits, size_t *iv_len)
1183{
1184 switch (cipher_type) {
1185 case MBEDTLS_CIPHER_AES_128_CBC:
1186 *cipher_mode = MBEDTLS_MODE_CBC;
1187 *key_bits = 128;
1188 *iv_len = 16;
1189 break;
1190 case MBEDTLS_CIPHER_AES_256_CBC:
1191 *cipher_mode = MBEDTLS_MODE_CBC;
1192 *key_bits = 256;
1193 *iv_len = 16;
1194 break;
1195 case MBEDTLS_CIPHER_ARIA_128_CBC:
1196 *cipher_mode = MBEDTLS_MODE_CBC;
1197 *key_bits = 128;
1198 *iv_len = 16;
1199 break;
1200 case MBEDTLS_CIPHER_ARIA_256_CBC:
1201 *cipher_mode = MBEDTLS_MODE_CBC;
1202 *key_bits = 256;
1203 *iv_len = 16;
1204 break;
1205 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1206 *cipher_mode = MBEDTLS_MODE_CBC;
1207 *key_bits = 128;
1208 *iv_len = 16;
1209 break;
1210 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1211 *cipher_mode = MBEDTLS_MODE_CBC;
1212 *key_bits = 256;
1213 *iv_len = 16;
1214 break;
1215
1216 case MBEDTLS_CIPHER_AES_128_CCM:
1217 *cipher_mode = MBEDTLS_MODE_CCM;
1218 *key_bits = 128;
1219 *iv_len = 12;
1220 break;
1221 case MBEDTLS_CIPHER_AES_192_CCM:
1222 *cipher_mode = MBEDTLS_MODE_CCM;
1223 *key_bits = 192;
1224 *iv_len = 12;
1225 break;
1226 case MBEDTLS_CIPHER_AES_256_CCM:
1227 *cipher_mode = MBEDTLS_MODE_CCM;
1228 *key_bits = 256;
1229 *iv_len = 12;
1230 break;
1231 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1232 *cipher_mode = MBEDTLS_MODE_CCM;
1233 *key_bits = 128;
1234 *iv_len = 12;
1235 break;
1236 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1237 *cipher_mode = MBEDTLS_MODE_CCM;
1238 *key_bits = 192;
1239 *iv_len = 12;
1240 break;
1241 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1242 *cipher_mode = MBEDTLS_MODE_CCM;
1243 *key_bits = 256;
1244 *iv_len = 12;
1245 break;
1246
1247 case MBEDTLS_CIPHER_AES_128_GCM:
1248 *cipher_mode = MBEDTLS_MODE_GCM;
1249 *key_bits = 128;
1250 *iv_len = 12;
1251 break;
1252 case MBEDTLS_CIPHER_AES_192_GCM:
1253 *cipher_mode = MBEDTLS_MODE_GCM;
1254 *key_bits = 192;
1255 *iv_len = 12;
1256 break;
1257 case MBEDTLS_CIPHER_AES_256_GCM:
1258 *cipher_mode = MBEDTLS_MODE_GCM;
1259 *key_bits = 256;
1260 *iv_len = 12;
1261 break;
1262 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1263 *cipher_mode = MBEDTLS_MODE_GCM;
1264 *key_bits = 128;
1265 *iv_len = 12;
1266 break;
1267 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1268 *cipher_mode = MBEDTLS_MODE_GCM;
1269 *key_bits = 192;
1270 *iv_len = 12;
1271 break;
1272 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1273 *cipher_mode = MBEDTLS_MODE_GCM;
1274 *key_bits = 256;
1275 *iv_len = 12;
1276 break;
1277
1278 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1279 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1280 *key_bits = 256;
1281 *iv_len = 12;
1282 break;
1283
1284 case MBEDTLS_CIPHER_NULL:
1285 *cipher_mode = MBEDTLS_MODE_STREAM;
1286 *key_bits = 0;
1287 *iv_len = 0;
1288 break;
1289
1290 default:
1291 *cipher_mode = MBEDTLS_MODE_NONE;
1292 *key_bits = 0;
1293 *iv_len = 0;
1294 }
1295}
1296
Yanray Wange6afd912022-10-27 12:11:18 +08001297int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1298 mbedtls_ssl_transform *t_out,
1299 int cipher_type, int hash_id,
1300 int etm, int tag_mode,
1301 mbedtls_ssl_protocol_version tls_version,
1302 size_t cid0_len,
1303 size_t cid1_len)
1304{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001305 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1306 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001307 int ret = 0;
1308
1309#if defined(MBEDTLS_USE_PSA_CRYPTO)
1310 psa_key_type_t key_type;
1311 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1312 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001313 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001314#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001315 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001316#endif
1317
Valerio Setti31ad3a12023-10-27 11:55:02 +02001318 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001319 unsigned char *key0 = NULL, *key1 = NULL;
1320 unsigned char *md0 = NULL, *md1 = NULL;
1321 unsigned char iv_enc[16], iv_dec[16];
1322
1323#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1324 unsigned char cid0[SSL_CID_LEN_MIN];
1325 unsigned char cid1[SSL_CID_LEN_MIN];
1326
1327 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1328 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1329#else
1330 ((void) cid0_len);
1331 ((void) cid1_len);
1332#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1333
1334 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001335 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1336 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001337
1338 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001339 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001340 /* Allocate `keylen + 1` bytes to ensure that we get
1341 * a non-NULL pointers from `mbedtls_calloc` even if
1342 * `keylen == 0` in the case of the NULL cipher. */
1343 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1344 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1345 memset(key0, 0x1, keylen);
1346 memset(key1, 0x2, keylen);
1347
1348#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001349 /* Pick cipher */
1350 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1351 CHK(cipher_info != NULL);
1352 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1353 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001354
Yanray Wange6afd912022-10-27 12:11:18 +08001355 /* Setup cipher contexts */
1356 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1357 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1358 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1359 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1360
1361#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001362 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001363 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1364 MBEDTLS_PADDING_NONE) == 0);
1365 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1366 MBEDTLS_PADDING_NONE) == 0);
1367 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1368 MBEDTLS_PADDING_NONE) == 0);
1369 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1370 MBEDTLS_PADDING_NONE) == 0);
1371 }
1372#endif /* MBEDTLS_CIPHER_MODE_CBC */
1373
1374 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001375 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1376 MBEDTLS_ENCRYPT)
1377 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001378 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001379 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1380 MBEDTLS_DECRYPT)
1381 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001382 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001383 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1384 MBEDTLS_ENCRYPT)
1385 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001386 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001387 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1388 MBEDTLS_DECRYPT)
1389 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001390#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001391
1392 /* Setup MAC contexts */
1393#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001394 if (cipher_mode == MBEDTLS_MODE_CBC ||
1395 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001396#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001397 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 +08001398 CHK(md_info != NULL);
1399#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001400 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001401 CHK(maclen != 0);
1402 /* Pick hash keys */
1403 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1404 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1405 memset(md0, 0x5, maclen);
1406 memset(md1, 0x6, maclen);
1407
1408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001409 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001410
1411 CHK(alg != 0);
1412
1413 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1414 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1415 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1416 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1417 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1418 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1419
1420 psa_reset_key_attributes(&attributes);
1421 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1422 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1423 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1424
1425 CHK(psa_import_key(&attributes,
1426 md0, maclen,
1427 &t_in->psa_mac_enc) == PSA_SUCCESS);
1428
1429 CHK(psa_import_key(&attributes,
1430 md1, maclen,
1431 &t_out->psa_mac_enc) == PSA_SUCCESS);
1432
Valerio Setti31ad3a12023-10-27 11:55:02 +02001433 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001434 etm == MBEDTLS_SSL_ETM_DISABLED) {
1435 /* mbedtls_ct_hmac() requires the key to be exportable */
1436 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1437 PSA_KEY_USAGE_VERIFY_HASH);
1438 } else {
1439 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1440 }
1441
1442 CHK(psa_import_key(&attributes,
1443 md1, maclen,
1444 &t_in->psa_mac_dec) == PSA_SUCCESS);
1445
1446 CHK(psa_import_key(&attributes,
1447 md0, maclen,
1448 &t_out->psa_mac_dec) == PSA_SUCCESS);
1449#else
1450 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1451 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1452 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1453 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1454
1455 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1456 md0, maclen) == 0);
1457 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1458 md1, maclen) == 0);
1459 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1460 md1, maclen) == 0);
1461 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1462 md0, maclen) == 0);
1463#endif
1464 }
1465#else
1466 ((void) hash_id);
1467#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1468
1469
1470 /* Pick IV's (regardless of whether they
1471 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001472 memset(iv_enc, 0x3, sizeof(iv_enc));
1473 memset(iv_dec, 0x4, sizeof(iv_dec));
1474
1475 /*
1476 * Setup transforms
1477 */
1478
1479#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1480 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1481 t_out->encrypt_then_mac = etm;
1482 t_in->encrypt_then_mac = etm;
1483#else
1484 ((void) etm);
1485#endif
1486
1487 t_out->tls_version = tls_version;
1488 t_in->tls_version = tls_version;
1489 t_out->ivlen = ivlen;
1490 t_in->ivlen = ivlen;
1491
Valerio Setti31ad3a12023-10-27 11:55:02 +02001492 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001493 case MBEDTLS_MODE_GCM:
1494 case MBEDTLS_MODE_CCM:
1495#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1496 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1497 t_out->fixed_ivlen = 12;
1498 t_in->fixed_ivlen = 12;
1499 } else
1500#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1501 {
1502 t_out->fixed_ivlen = 4;
1503 t_in->fixed_ivlen = 4;
1504 }
1505 t_out->maclen = 0;
1506 t_in->maclen = 0;
1507 switch (tag_mode) {
1508 case 0: /* Full tag */
1509 t_out->taglen = 16;
1510 t_in->taglen = 16;
1511 break;
1512 case 1: /* Partial tag */
1513 t_out->taglen = 8;
1514 t_in->taglen = 8;
1515 break;
1516 default:
1517 ret = 1;
1518 goto cleanup;
1519 }
1520 break;
1521
1522 case MBEDTLS_MODE_CHACHAPOLY:
1523 t_out->fixed_ivlen = 12;
1524 t_in->fixed_ivlen = 12;
1525 t_out->maclen = 0;
1526 t_in->maclen = 0;
1527 switch (tag_mode) {
1528 case 0: /* Full tag */
1529 t_out->taglen = 16;
1530 t_in->taglen = 16;
1531 break;
1532 case 1: /* Partial tag */
1533 t_out->taglen = 8;
1534 t_in->taglen = 8;
1535 break;
1536 default:
1537 ret = 1;
1538 goto cleanup;
1539 }
1540 break;
1541
1542 case MBEDTLS_MODE_STREAM:
1543 case MBEDTLS_MODE_CBC:
1544 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1545 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1546 t_out->taglen = 0;
1547 t_in->taglen = 0;
1548 switch (tag_mode) {
1549 case 0: /* Full tag */
1550 t_out->maclen = maclen;
1551 t_in->maclen = maclen;
1552 break;
1553 default:
1554 ret = 1;
1555 goto cleanup;
1556 }
1557 break;
1558 default:
1559 ret = 1;
1560 goto cleanup;
1561 break;
1562 }
1563
1564 /* Setup IV's */
1565
1566 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1567 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1568 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1569 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1570
1571#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1572 /* Add CID */
1573 memcpy(&t_in->in_cid, cid0, cid0_len);
1574 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001575 t_in->in_cid_len = (uint8_t) cid0_len;
1576 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001577 memcpy(&t_out->in_cid, cid1, cid1_len);
1578 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001579 t_out->in_cid_len = (uint8_t) cid1_len;
1580 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001581#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1582
1583#if defined(MBEDTLS_USE_PSA_CRYPTO)
1584 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1585 t_in->taglen,
1586 &alg,
1587 &key_type,
1588 &key_bits);
1589
1590 if (status != PSA_SUCCESS) {
1591 ret = PSA_TO_MBEDTLS_ERR(status);
1592 goto cleanup;
1593 }
1594
1595 t_in->psa_alg = alg;
1596 t_out->psa_alg = alg;
1597
1598 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1599 psa_reset_key_attributes(&attributes);
1600 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1601 psa_set_key_algorithm(&attributes, alg);
1602 psa_set_key_type(&attributes, key_type);
1603
1604 status = psa_import_key(&attributes,
1605 key0,
1606 PSA_BITS_TO_BYTES(key_bits),
1607 &t_in->psa_key_enc);
1608
1609 if (status != PSA_SUCCESS) {
1610 ret = PSA_TO_MBEDTLS_ERR(status);
1611 goto cleanup;
1612 }
1613
1614 status = psa_import_key(&attributes,
1615 key1,
1616 PSA_BITS_TO_BYTES(key_bits),
1617 &t_out->psa_key_enc);
1618
1619 if (status != PSA_SUCCESS) {
1620 ret = PSA_TO_MBEDTLS_ERR(status);
1621 goto cleanup;
1622 }
1623
1624 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1625
1626 status = psa_import_key(&attributes,
1627 key1,
1628 PSA_BITS_TO_BYTES(key_bits),
1629 &t_in->psa_key_dec);
1630
1631 if (status != PSA_SUCCESS) {
1632 ret = PSA_TO_MBEDTLS_ERR(status);
1633 goto cleanup;
1634 }
1635
1636 status = psa_import_key(&attributes,
1637 key0,
1638 PSA_BITS_TO_BYTES(key_bits),
1639 &t_out->psa_key_dec);
1640
1641 if (status != PSA_SUCCESS) {
1642 ret = PSA_TO_MBEDTLS_ERR(status);
1643 goto cleanup;
1644 }
1645 }
1646#endif /* MBEDTLS_USE_PSA_CRYPTO */
1647
1648cleanup:
1649
1650 mbedtls_free(key0);
1651 mbedtls_free(key1);
1652
1653 mbedtls_free(md0);
1654 mbedtls_free(md1);
1655
1656 return ret;
1657}
1658
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001659#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1660int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1661 mbedtls_ssl_transform *transform_out)
1662{
1663#if defined(MBEDTLS_USE_PSA_CRYPTO)
1664 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1665#endif
1666
1667 /* Serialized version of record header for MAC purposes */
1668 unsigned char add_data[13];
1669 memcpy(add_data, record->ctr, 8);
1670 add_data[8] = record->type;
1671 add_data[9] = record->ver[0];
1672 add_data[10] = record->ver[1];
1673 add_data[11] = (record->data_len >> 8) & 0xff;
1674 add_data[12] = (record->data_len >> 0) & 0xff;
1675
1676 /* MAC with additional data */
1677#if defined(MBEDTLS_USE_PSA_CRYPTO)
1678 size_t sign_mac_length = 0;
1679 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1680 transform_out->psa_mac_enc,
1681 transform_out->psa_mac_alg));
1682 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1683 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1684 record->buf + record->data_offset,
1685 record->data_len));
1686 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1687 * extension, there might not be enough room in the record for the
1688 * full-length MAC. */
1689 unsigned char mac[PSA_HASH_MAX_SIZE];
1690 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1691 mac, sizeof(mac),
1692 &sign_mac_length));
1693#else
1694 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1695 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1696 record->buf + record->data_offset,
1697 record->data_len));
1698 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1699 * extension, there might not be enough room in the record for the
1700 * full-length MAC. */
1701 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1702 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1703#endif
1704 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1705 record->data_len += transform_out->maclen;
1706
1707 return 0;
1708
1709exit:
1710#if defined(MBEDTLS_USE_PSA_CRYPTO)
1711 psa_mac_abort(&operation);
1712#endif
1713 return -1;
1714}
1715#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1716
Jerry Yu28547c42023-10-31 14:42:50 +08001717#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001718int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1719 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001720 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001721 const char *crt_file)
1722{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001723 (void) ticket_len;
1724
Yanray Wange6afd912022-10-27 12:11:18 +08001725#if defined(MBEDTLS_HAVE_TIME)
1726 session->start = mbedtls_time(NULL) - 42;
1727#endif
1728 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001729
1730 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1731 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1732
1733 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001734 session->ciphersuite = 0xabcd;
1735 session->id_len = sizeof(session->id);
1736 memset(session->id, 66, session->id_len);
1737 memset(session->master, 17, sizeof(session->master));
1738
1739#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1740 if (crt_file != NULL && strlen(crt_file) != 0) {
1741 mbedtls_x509_crt tmp_crt;
1742 int ret;
1743
1744 mbedtls_x509_crt_init(&tmp_crt);
1745 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1746 if (ret != 0) {
1747 return ret;
1748 }
1749
1750#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1751 /* Move temporary CRT. */
1752 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1753 if (session->peer_cert == NULL) {
1754 return -1;
1755 }
1756 *session->peer_cert = tmp_crt;
1757 memset(&tmp_crt, 0, sizeof(tmp_crt));
1758#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1759 /* Calculate digest of temporary CRT. */
1760 session->peer_cert_digest =
1761 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1762 if (session->peer_cert_digest == NULL) {
1763 return -1;
1764 }
1765
1766#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001767 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001768 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1769 size_t hash_size = 0;
1770 psa_status_t status = psa_hash_compute(
1771 psa_alg, tmp_crt.raw.p,
1772 tmp_crt.raw.len,
1773 session->peer_cert_digest,
1774 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1775 &hash_size);
1776 ret = PSA_TO_MBEDTLS_ERR(status);
1777#else
1778 ret = mbedtls_md(mbedtls_md_info_from_type(
1779 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1780 tmp_crt.raw.p, tmp_crt.raw.len,
1781 session->peer_cert_digest);
1782#endif /* MBEDTLS_USE_PSA_CRYPTO */
1783 if (ret != 0) {
1784 return ret;
1785 }
1786 session->peer_cert_digest_type =
1787 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1788 session->peer_cert_digest_len =
1789 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1790#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1791
1792 mbedtls_x509_crt_free(&tmp_crt);
1793 }
1794#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1795 (void) crt_file;
1796#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1797 session->verify_result = 0xdeadbeef;
1798
Ronald Cronc57f86e2023-11-22 09:50:01 +01001799#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1800#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001801 if (ticket_len != 0) {
1802 session->ticket = mbedtls_calloc(1, ticket_len);
1803 if (session->ticket == NULL) {
1804 return -1;
1805 }
1806 memset(session->ticket, 33, ticket_len);
1807 }
1808 session->ticket_len = ticket_len;
1809 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001810#endif /* MBEDTLS_SSL_CLI_C */
1811
1812#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1813 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1814 session->ticket_creation_time = mbedtls_ms_time() - 42;
1815 }
Yanray Wange6afd912022-10-27 12:11:18 +08001816#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001817#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001818
1819#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1820 session->mfl_code = 1;
1821#endif
1822#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1823 session->encrypt_then_mac = 1;
1824#endif
1825
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001826exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001827 return 0;
1828}
Jerry Yu28547c42023-10-31 14:42:50 +08001829#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001830
1831#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1832int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1833 int ticket_len,
1834 int endpoint_type)
1835{
1836 ((void) ticket_len);
1837 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1838 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1839 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1840 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001841
1842#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001843 session->ticket_age_add = 0x87654321;
1844 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001845 session->resumption_key_len = 32;
1846 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001847#endif
1848
Ronald Cron18b92a12024-03-26 10:15:08 +01001849#if defined(MBEDTLS_SSL_SRV_C)
1850 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1851#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1852#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1853 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1854 if (ret != 0) {
1855 return -1;
1856 }
1857#endif
1858#if defined(MBEDTLS_HAVE_TIME)
1859 session->ticket_creation_time = mbedtls_ms_time() - 42;
1860#endif
1861#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1862 }
1863#endif /* MBEDTLS_SSL_SRV_C */
1864
Yanray Wange6afd912022-10-27 12:11:18 +08001865#if defined(MBEDTLS_SSL_CLI_C)
1866 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001867#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001868#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001869 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001870#endif
1871 session->ticket_lifetime = 0xfedcba98;
1872
1873 session->ticket_len = ticket_len;
1874 if (ticket_len != 0) {
1875 session->ticket = mbedtls_calloc(1, ticket_len);
1876 if (session->ticket == NULL) {
1877 return -1;
1878 }
1879 memset(session->ticket, 33, ticket_len);
1880 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001881#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1882 char hostname[] = "hostname example";
1883 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1884 if (session->hostname == NULL) {
1885 return -1;
1886 }
1887 memcpy(session->hostname, hostname, sizeof(hostname));
1888#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001889#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001890 }
1891#endif /* MBEDTLS_SSL_CLI_C */
1892
Ronald Cron18b92a12024-03-26 10:15:08 +01001893#if defined(MBEDTLS_SSL_EARLY_DATA)
1894 session->max_early_data_size = 0x87654321;
1895#endif /* MBEDTLS_SSL_EARLY_DATA */
1896
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001897#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1898 session->record_size_limit = 2048;
1899#endif
1900
Yanray Wange6afd912022-10-27 12:11:18 +08001901 return 0;
1902}
1903#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1904
Yanray Wangb088bfc2023-03-16 12:15:49 +08001905int mbedtls_test_ssl_exchange_data(
1906 mbedtls_ssl_context *ssl_1,
1907 int msg_len_1, const int expected_fragments_1,
1908 mbedtls_ssl_context *ssl_2,
1909 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001910{
1911 unsigned char *msg_buf_1 = malloc(msg_len_1);
1912 unsigned char *msg_buf_2 = malloc(msg_len_2);
1913 unsigned char *in_buf_1 = malloc(msg_len_2);
1914 unsigned char *in_buf_2 = malloc(msg_len_1);
1915 int msg_type, ret = -1;
1916
1917 /* Perform this test with two message types. At first use a message
1918 * consisting of only 0x00 for the client and only 0xFF for the server.
1919 * At the second time use message with generated data */
1920 for (msg_type = 0; msg_type < 2; msg_type++) {
1921 int written_1 = 0;
1922 int written_2 = 0;
1923 int read_1 = 0;
1924 int read_2 = 0;
1925 int fragments_1 = 0;
1926 int fragments_2 = 0;
1927
1928 if (msg_type == 0) {
1929 memset(msg_buf_1, 0x00, msg_len_1);
1930 memset(msg_buf_2, 0xff, msg_len_2);
1931 } else {
1932 int i, j = 0;
1933 for (i = 0; i < msg_len_1; i++) {
1934 msg_buf_1[i] = j++ & 0xFF;
1935 }
1936 for (i = 0; i < msg_len_2; i++) {
1937 msg_buf_2[i] = (j -= 5) & 0xFF;
1938 }
1939 }
1940
1941 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
1942 /* ssl_1 sending */
1943 if (msg_len_1 > written_1) {
1944 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
1945 msg_len_1, &written_1,
1946 expected_fragments_1);
1947 if (expected_fragments_1 == 0) {
1948 /* This error is expected when the message is too large and
1949 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001950 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001951 msg_len_1 = 0;
1952 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001953 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001954 }
1955 }
1956
1957 /* ssl_2 sending */
1958 if (msg_len_2 > written_2) {
1959 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
1960 msg_len_2, &written_2,
1961 expected_fragments_2);
1962 if (expected_fragments_2 == 0) {
1963 /* This error is expected when the message is too large and
1964 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001965 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001966 msg_len_2 = 0;
1967 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001968 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001969 }
1970 }
1971
1972 /* ssl_1 reading */
1973 if (read_1 < msg_len_2) {
1974 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
1975 msg_len_2, &read_1,
1976 &fragments_2,
1977 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02001978 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001979 }
1980
1981 /* ssl_2 reading */
1982 if (read_2 < msg_len_1) {
1983 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
1984 msg_len_1, &read_2,
1985 &fragments_1,
1986 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02001987 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001988 }
1989 }
1990
1991 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02001992 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
1993 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
1994 TEST_EQUAL(fragments_1, expected_fragments_1);
1995 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08001996 }
1997
1998 ret = 0;
1999
2000exit:
2001 free(msg_buf_1);
2002 free(in_buf_1);
2003 free(msg_buf_2);
2004 free(in_buf_2);
2005
2006 return ret;
2007}
2008
2009/*
2010 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
2011 * must be initialized and connected beforehand.
2012 *
2013 * \retval 0 on success, otherwise error code.
2014 */
Yanray Wangead70c82023-03-16 12:04:49 +08002015#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
2016 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
2017 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
2018static int exchange_data(mbedtls_ssl_context *ssl_1,
2019 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08002020{
Yanray Wangb088bfc2023-03-16 12:15:49 +08002021 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
2022 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002023}
Yanray Wangead70c82023-03-16 12:04:49 +08002024#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
2025 (MBEDTLS_SSL_RENEGOTIATION ||
2026 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002027
2028#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2029static int check_ssl_version(
2030 mbedtls_ssl_protocol_version expected_negotiated_version,
2031 const mbedtls_ssl_context *ssl)
2032{
2033 const char *version_string = mbedtls_ssl_get_version(ssl);
2034 mbedtls_ssl_protocol_version version_number =
2035 mbedtls_ssl_get_version_number(ssl);
2036
2037 TEST_EQUAL(ssl->tls_version, expected_negotiated_version);
2038
2039 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2040 TEST_EQUAL(version_string[0], 'D');
2041 ++version_string;
2042 }
2043
2044 switch (expected_negotiated_version) {
2045 case MBEDTLS_SSL_VERSION_TLS1_2:
2046 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002047 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002048 break;
2049
2050 case MBEDTLS_SSL_VERSION_TLS1_3:
2051 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002052 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002053 break;
2054
2055 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002056 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002057 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002058 }
2059
2060 return 1;
2061
2062exit:
2063 return 0;
2064}
2065#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2066
Yanray Wange6afd912022-10-27 12:11:18 +08002067#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002068int mbedtls_test_ssl_do_handshake_with_endpoints(
2069 mbedtls_test_ssl_endpoint *server_ep,
2070 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002071 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002072 mbedtls_ssl_protocol_version proto)
2073{
2074 enum { BUFFSIZE = 1024 };
2075
2076 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002077
Max Fillingeree467aa2024-11-08 22:17:33 +01002078 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2079 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2080
Max Fillinger8f12e312024-10-30 00:29:37 +01002081 mbedtls_test_init_handshake_options(options);
2082 options->server_min_version = proto;
2083 options->client_min_version = proto;
2084 options->server_max_version = proto;
2085 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002086
Max Fillinger8f12e312024-10-30 00:29:37 +01002087 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002088 NULL, NULL, NULL);
2089 if (ret != 0) {
2090 return ret;
2091 }
Max Fillinger8f12e312024-10-30 00:29:37 +01002092 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002093 NULL, NULL, NULL);
2094 if (ret != 0) {
2095 return ret;
2096 }
2097
2098 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2099 if (ret != 0) {
2100 return ret;
2101 }
2102
Max Fillingerea1e7772024-10-30 00:49:10 +01002103 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2104 &client_ep->ssl,
2105 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002106 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2107 return ret;
2108 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002109 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2110 &server_ep->ssl,
2111 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002112 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2113 return ret;
2114 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002115 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2116 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002117 return -1;
2118 }
2119
2120 return 0;
2121}
2122#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2123
2124#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Yanray Wange6afd912022-10-27 12:11:18 +08002125void mbedtls_test_ssl_perform_handshake(
Gilles Peskine9b993682025-05-27 18:44:12 +02002126 const mbedtls_test_handshake_test_options *options)
Yanray Wange6afd912022-10-27 12:11:18 +08002127{
Yanray Wange6afd912022-10-27 12:11:18 +08002128 enum { BUFFSIZE = 17000 };
2129 mbedtls_test_ssl_endpoint client, server;
2130#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2131 const char *psk_identity = "foo";
2132#endif
Yanray Wange6afd912022-10-27 12:11:18 +08002133#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2134 unsigned char *context_buf = NULL;
2135 size_t context_buf_len;
2136#endif
2137#if defined(MBEDTLS_SSL_RENEGOTIATION)
2138 int ret = -1;
2139#endif
2140 int expected_handshake_result = options->expected_handshake_result;
2141
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002142 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002143 mbedtls_platform_zeroize(&client, sizeof(client));
2144 mbedtls_platform_zeroize(&server, sizeof(server));
2145 mbedtls_test_ssl_message_queue server_queue, client_queue;
Yanray Wange6afd912022-10-27 12:11:18 +08002146
Ronald Cronec3408d2024-01-16 17:50:40 +01002147#if defined(MBEDTLS_DEBUG_C)
2148 if (options->cli_log_fun || options->srv_log_fun) {
2149 mbedtls_debug_set_threshold(4);
2150 }
2151#endif
2152
Yanray Wange6afd912022-10-27 12:11:18 +08002153 /* Client side */
2154 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002155 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2156 MBEDTLS_SSL_IS_CLIENT,
Gilles Peskine29969592025-05-27 19:24:28 +02002157 options, NULL,
Gilles Peskine353eb332025-05-14 17:42:53 +02002158 &client_queue,
2159 &server_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002160 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002161 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2162 MBEDTLS_SSL_IS_CLIENT,
2163 options, NULL, NULL,
2164 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002165 }
2166
Gilles Peskine2744a432025-05-27 13:27:22 +02002167 TEST_ASSERT(set_ciphersuite(&client, options->cipher));
Yanray Wange6afd912022-10-27 12:11:18 +08002168
Yanray Wange6afd912022-10-27 12:11:18 +08002169 /* Server side */
2170 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002171 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2172 MBEDTLS_SSL_IS_SERVER,
Gilles Peskine29969592025-05-27 19:24:28 +02002173 options, NULL,
Gilles Peskine353eb332025-05-14 17:42:53 +02002174 &server_queue,
2175 &client_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002176 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002177 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2178 MBEDTLS_SSL_IS_SERVER,
2179 options, NULL, NULL,
2180 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002181 }
2182
2183 mbedtls_ssl_conf_authmode(&server.conf, options->srv_auth_mode);
2184
Gilles Peskineb092e782025-05-27 20:15:03 +02002185 if (options->dtls) {
2186 TEST_EQUAL(mbedtls_test_ssl_dtls_join_endpoints(&client, &server), 0);
2187 }
2188
Yanray Wange6afd912022-10-27 12:11:18 +08002189#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine353eb332025-05-14 17:42:53 +02002190 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(server.conf),
2191 (unsigned char) options->mfl),
2192 0);
2193 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(client.conf),
2194 (unsigned char) options->mfl),
2195 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002196#else
Gilles Peskine353eb332025-05-14 17:42:53 +02002197 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
Yanray Wange6afd912022-10-27 12:11:18 +08002198#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2199
2200#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2201 if (options->psk_str != NULL && options->psk_str->len > 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002202 TEST_EQUAL(mbedtls_ssl_conf_psk(
2203 &client.conf, options->psk_str->x,
2204 options->psk_str->len,
2205 (const unsigned char *) psk_identity,
2206 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002207
Gilles Peskine353eb332025-05-14 17:42:53 +02002208 TEST_EQUAL(mbedtls_ssl_conf_psk(
2209 &server.conf, options->psk_str->x,
2210 options->psk_str->len,
2211 (const unsigned char *) psk_identity,
2212 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002213#if defined(MBEDTLS_SSL_SRV_C)
2214 mbedtls_ssl_conf_psk_cb(&server.conf, psk_dummy_callback, NULL);
2215#endif
2216 }
2217#endif
2218#if defined(MBEDTLS_SSL_RENEGOTIATION)
2219 if (options->renegotiate) {
2220 mbedtls_ssl_conf_renegotiation(&(server.conf),
2221 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2222 mbedtls_ssl_conf_renegotiation(&(client.conf),
2223 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2224
2225 mbedtls_ssl_conf_legacy_renegotiation(&(server.conf),
2226 options->legacy_renegotiation);
2227 mbedtls_ssl_conf_legacy_renegotiation(&(client.conf),
2228 options->legacy_renegotiation);
2229 }
2230#endif /* MBEDTLS_SSL_RENEGOTIATION */
2231
Gilles Peskine353eb332025-05-14 17:42:53 +02002232 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client.socket),
2233 &(server.socket),
2234 BUFFSIZE), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002235
2236#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2237 if (options->resize_buffers != 0) {
2238 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002239 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2240 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2241 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2242 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002243 }
2244#endif
2245
2246 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2247 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2248 }
2249
Gilles Peskine353eb332025-05-14 17:42:53 +02002250 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client.ssl),
2251 &(server.ssl),
2252 MBEDTLS_SSL_HANDSHAKE_OVER),
2253 expected_handshake_result);
Yanray Wange6afd912022-10-27 12:11:18 +08002254
2255 if (expected_handshake_result != 0) {
2256 /* Connection will have failed by this point, skip to cleanup */
2257 goto exit;
2258 }
2259
Gilles Peskine353eb332025-05-14 17:42:53 +02002260 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002261
2262 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2263 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server.ssl),
2264 &(client.ssl),
2265 MBEDTLS_SSL_HANDSHAKE_OVER),
2266 0);
2267
Gilles Peskine353eb332025-05-14 17:42:53 +02002268 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002269 /* Check that both sides have negotiated the expected version. */
2270 mbedtls_test_set_step(0);
2271 if (!check_ssl_version(options->expected_negotiated_version,
2272 &client.ssl)) {
2273 goto exit;
2274 }
2275
2276 mbedtls_test_set_step(1);
2277 if (!check_ssl_version(options->expected_negotiated_version,
2278 &server.ssl)) {
2279 goto exit;
2280 }
2281
2282 if (options->expected_ciphersuite != 0) {
2283 TEST_EQUAL(server.ssl.session->ciphersuite,
2284 options->expected_ciphersuite);
2285 }
2286
2287#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2288 if (options->resize_buffers != 0) {
2289 /* A server, when using DTLS, might delay a buffer resize to happen
2290 * after it receives a message, so we force it. */
Gilles Peskine353eb332025-05-14 17:42:53 +02002291 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002292
Gilles Peskine353eb332025-05-14 17:42:53 +02002293 TEST_EQUAL(client.ssl.out_buf_len,
2294 mbedtls_ssl_get_output_buflen(&client.ssl));
2295 TEST_EQUAL(client.ssl.in_buf_len,
2296 mbedtls_ssl_get_input_buflen(&client.ssl));
2297 TEST_EQUAL(server.ssl.out_buf_len,
2298 mbedtls_ssl_get_output_buflen(&server.ssl));
2299 TEST_EQUAL(server.ssl.in_buf_len,
2300 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002301 }
2302#endif
2303
2304 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2305 /* Start data exchanging test */
Gilles Peskine353eb332025-05-14 17:42:53 +02002306 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2307 &(client.ssl), options->cli_msg_len,
2308 options->expected_cli_fragments,
2309 &(server.ssl), options->srv_msg_len,
2310 options->expected_srv_fragments),
2311 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002312 }
2313#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2314 if (options->serialize == 1) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002315 TEST_EQUAL(options->dtls, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002316
Gilles Peskine353eb332025-05-14 17:42:53 +02002317 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), NULL,
2318 0, &context_buf_len),
2319 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
Yanray Wange6afd912022-10-27 12:11:18 +08002320
2321 context_buf = mbedtls_calloc(1, context_buf_len);
2322 TEST_ASSERT(context_buf != NULL);
2323
Gilles Peskine353eb332025-05-14 17:42:53 +02002324 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), context_buf,
2325 context_buf_len,
2326 &context_buf_len),
2327 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002328
2329 mbedtls_ssl_free(&(server.ssl));
2330 mbedtls_ssl_init(&(server.ssl));
2331
Gilles Peskine353eb332025-05-14 17:42:53 +02002332 TEST_EQUAL(mbedtls_ssl_setup(&(server.ssl), &(server.conf)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002333
Gilles Peskine29969592025-05-27 19:24:28 +02002334 mbedtls_ssl_set_bio(&(server.ssl), &server.dtls_context,
Yanray Wange6afd912022-10-27 12:11:18 +08002335 mbedtls_test_mock_tcp_send_msg,
2336 mbedtls_test_mock_tcp_recv_msg,
2337 NULL);
2338
2339 mbedtls_ssl_set_user_data_p(&server.ssl, &server);
2340
2341#if defined(MBEDTLS_TIMING_C)
Gilles Peskine0677e022025-05-27 18:05:20 +02002342 mbedtls_ssl_set_timer_cb(&server.ssl, &server.timer,
Yanray Wange6afd912022-10-27 12:11:18 +08002343 mbedtls_timing_set_delay,
2344 mbedtls_timing_get_delay);
2345#endif
2346#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2347 if (options->resize_buffers != 0) {
2348 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002349 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2350 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002351 }
2352#endif
Gilles Peskine353eb332025-05-14 17:42:53 +02002353 TEST_EQUAL(mbedtls_ssl_context_load(&(server.ssl), context_buf,
2354 context_buf_len), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002355
2356#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2357 /* Validate buffer sizes after context deserialization */
2358 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002359 TEST_EQUAL(server.ssl.out_buf_len,
2360 mbedtls_ssl_get_output_buflen(&server.ssl));
2361 TEST_EQUAL(server.ssl.in_buf_len,
2362 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002363 }
2364#endif
2365 /* Retest writing/reading */
2366 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002367 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2368 &(client.ssl), options->cli_msg_len,
2369 options->expected_cli_fragments,
2370 &(server.ssl), options->srv_msg_len,
2371 options->expected_srv_fragments),
2372 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002373 }
2374 }
2375#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2376
2377#if defined(MBEDTLS_SSL_RENEGOTIATION)
2378 if (options->renegotiate) {
2379 /* Start test with renegotiation */
Gilles Peskine353eb332025-05-14 17:42:53 +02002380 TEST_EQUAL(server.ssl.renego_status,
2381 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2382 TEST_EQUAL(client.ssl.renego_status,
2383 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002384
2385 /* After calling this function for the server, it only sends a handshake
2386 * request. All renegotiation should happen during data exchanging */
Gilles Peskine353eb332025-05-14 17:42:53 +02002387 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server.ssl)), 0);
2388 TEST_EQUAL(server.ssl.renego_status,
2389 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2390 TEST_EQUAL(client.ssl.renego_status,
2391 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002392
Gilles Peskine353eb332025-05-14 17:42:53 +02002393 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2394 TEST_EQUAL(server.ssl.renego_status,
2395 MBEDTLS_SSL_RENEGOTIATION_DONE);
2396 TEST_EQUAL(client.ssl.renego_status,
2397 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002398
2399 /* After calling mbedtls_ssl_renegotiate for the client,
2400 * all renegotiation should happen inside this function.
2401 * However in this test, we cannot perform simultaneous communication
2402 * between client and server so this function will return waiting error
2403 * on the socket. All rest of renegotiation should happen
2404 * during data exchanging */
2405 ret = mbedtls_ssl_renegotiate(&(client.ssl));
2406#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2407 if (options->resize_buffers != 0) {
2408 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002409 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2410 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002411 }
2412#endif
2413 TEST_ASSERT(ret == 0 ||
2414 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2415 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
Gilles Peskine353eb332025-05-14 17:42:53 +02002416 TEST_EQUAL(server.ssl.renego_status,
2417 MBEDTLS_SSL_RENEGOTIATION_DONE);
2418 TEST_EQUAL(client.ssl.renego_status,
2419 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
Yanray Wange6afd912022-10-27 12:11:18 +08002420
Gilles Peskine353eb332025-05-14 17:42:53 +02002421 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2422 TEST_EQUAL(server.ssl.renego_status,
2423 MBEDTLS_SSL_RENEGOTIATION_DONE);
2424 TEST_EQUAL(client.ssl.renego_status,
2425 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002426#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2427 /* Validate buffer sizes after renegotiation */
2428 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002429 TEST_EQUAL(client.ssl.out_buf_len,
2430 mbedtls_ssl_get_output_buflen(&client.ssl));
2431 TEST_EQUAL(client.ssl.in_buf_len,
2432 mbedtls_ssl_get_input_buflen(&client.ssl));
2433 TEST_EQUAL(server.ssl.out_buf_len,
2434 mbedtls_ssl_get_output_buflen(&server.ssl));
2435 TEST_EQUAL(server.ssl.in_buf_len,
2436 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002437 }
2438#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2439 }
2440#endif /* MBEDTLS_SSL_RENEGOTIATION */
2441
2442 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client.conf) == &client);
2443 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client.ssl) == &client);
2444 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server.conf) == &server);
2445 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server.ssl) == &server);
2446
2447exit:
Gilles Peskine29969592025-05-27 19:24:28 +02002448 mbedtls_test_ssl_endpoint_free(&client, NULL);
2449 mbedtls_test_ssl_endpoint_free(&server, NULL);
Yanray Wange6afd912022-10-27 12:11:18 +08002450#if defined(MBEDTLS_DEBUG_C)
2451 if (options->cli_log_fun || options->srv_log_fun) {
2452 mbedtls_debug_set_threshold(0);
2453 }
2454#endif
2455#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2456 if (context_buf != NULL) {
2457 mbedtls_free(context_buf);
2458 }
2459#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002460 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002461}
2462#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2463
2464#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002465int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002466 unsigned char *buf, unsigned char **end, int tweak,
2467 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2468{
2469/*
2470 * The definition of the tweaks assume that the certificate list contains only
2471 * one certificate.
2472 */
2473
2474/*
2475 * struct {
2476 * opaque cert_data<1..2^24-1>;
2477 * Extension extensions<0..2^16-1>;
2478 * } CertificateEntry;
2479 *
2480 * struct {
2481 * opaque certificate_request_context<0..2^8-1>;
2482 * CertificateEntry certificate_list<0..2^24-1>;
2483 * } Certificate;
2484 */
2485 unsigned char *p_certificate_request_context_len = buf;
2486 size_t certificate_request_context_len = buf[0];
2487
2488 unsigned char *p_certificate_list_len =
2489 buf + 1 + certificate_request_context_len;
2490 unsigned char *certificate_list = p_certificate_list_len + 3;
2491 size_t certificate_list_len =
2492 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2493
2494 unsigned char *p_cert_data_len = certificate_list;
2495 unsigned char *cert_data = p_cert_data_len + 3;
2496 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2497
2498 unsigned char *p_extensions_len = cert_data + cert_data_len;
2499 unsigned char *extensions = p_extensions_len + 2;
2500 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2501
2502 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2503
2504 switch (tweak) {
2505 case 1:
2506 /* Failure when checking if the certificate request context length
2507 * and certificate list length can be read
2508 */
2509 *end = buf + 3;
2510 set_chk_buf_ptr_args(args, buf, *end, 4);
2511 break;
2512
2513 case 2:
2514 /* Invalid certificate request context length.
2515 */
2516 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002517 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002518 reset_chk_buf_ptr_args(args);
2519 break;
2520
2521 case 3:
2522 /* Failure when checking if certificate_list data can be read. */
2523 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2524 p_certificate_list_len, 0);
2525 set_chk_buf_ptr_args(args, certificate_list, *end,
2526 certificate_list_len + 1);
2527 break;
2528
2529 case 4:
2530 /* Failure when checking if the cert_data length can be read. */
2531 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2532 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2533 break;
2534
2535 case 5:
2536 /* Failure when checking if cert_data data can be read. */
2537 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2538 p_cert_data_len, 0);
2539 set_chk_buf_ptr_args(args, cert_data,
2540 certificate_list + certificate_list_len,
2541 certificate_list_len - 3 + 1);
2542 break;
2543
2544 case 6:
2545 /* Failure when checking if the extensions length can be read. */
2546 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2547 p_certificate_list_len, 0);
2548 set_chk_buf_ptr_args(
2549 args, p_extensions_len,
2550 certificate_list + certificate_list_len - extensions_len - 1, 2);
2551 break;
2552
2553 case 7:
2554 /* Failure when checking if extensions data can be read. */
2555 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2556
2557 set_chk_buf_ptr_args(
2558 args, extensions,
2559 certificate_list + certificate_list_len, extensions_len + 1);
2560 break;
2561
2562 default:
2563 return -1;
2564 }
2565
2566 return 0;
2567}
2568#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002569
Ronald Cronfaf026c2024-01-31 14:32:06 +01002570/*
2571 * Functions for tests based on tickets. Implementations of the
2572 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2573 * Basically same implementations as in ticket.c without the encryption. That
2574 * way we can tweak easily tickets characteristics to simulate misbehaving
2575 * peers.
2576 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002577#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2578int mbedtls_test_ticket_write(
2579 void *p_ticket, const mbedtls_ssl_session *session,
2580 unsigned char *start, const unsigned char *end,
2581 size_t *tlen, uint32_t *lifetime)
2582{
2583 int ret;
2584 ((void) p_ticket);
2585
2586 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2587 tlen)) != 0) {
2588 return ret;
2589 }
2590
2591 /* Maximum ticket lifetime as defined in RFC 8446 */
2592 *lifetime = 7 * 24 * 3600;
2593
2594 return 0;
2595}
2596
2597int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2598 unsigned char *buf, size_t len)
2599{
2600 ((void) p_ticket);
2601
2602 return mbedtls_ssl_session_load(session, buf, len);
2603}
2604#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002605
2606#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2607 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2608 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2609int mbedtls_test_get_tls13_ticket(
2610 mbedtls_test_handshake_test_options *client_options,
2611 mbedtls_test_handshake_test_options *server_options,
2612 mbedtls_ssl_session *session)
2613{
2614 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002615 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002616 unsigned char buf[64];
2617 mbedtls_test_ssl_endpoint client_ep, server_ep;
2618
2619 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2620 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2621
2622 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
2623 client_options, NULL, NULL, NULL);
2624 TEST_EQUAL(ret, 0);
2625
2626 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
2627 server_options, NULL, NULL, NULL);
2628 TEST_EQUAL(ret, 0);
2629
2630 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2631 mbedtls_test_ticket_write,
2632 mbedtls_test_ticket_parse,
2633 NULL);
2634
2635 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2636 &(server_ep.socket), 1024);
2637 TEST_EQUAL(ret, 0);
2638
2639 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2640 &(server_ep.ssl), &(client_ep.ssl),
2641 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2642
2643 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2644
2645 do {
2646 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2647 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2648
2649 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2650 TEST_EQUAL(ret, 0);
2651
Gilles Peskine946bf142025-04-08 09:48:40 +02002652 ok = 1;
2653
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002654exit:
2655 mbedtls_test_ssl_endpoint_free(&client_ep, NULL);
2656 mbedtls_test_ssl_endpoint_free(&server_ep, NULL);
2657
Gilles Peskine946bf142025-04-08 09:48:40 +02002658 if (ret == 0 && !ok) {
2659 /* Exiting due to a test assertion that isn't ret == 0 */
2660 ret = -1;
2661 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002662 return ret;
2663}
2664#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2665 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2666 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2667
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002668#endif /* MBEDTLS_SSL_TLS_C */