blob: 90810c55e9c204f15521ffed88e11b1ab97147da [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,
739 mbedtls_test_handshake_test_options *options,
740 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{
744 int ret = -1;
745 uintptr_t user_data_n;
746
747 if (dtls_context != NULL &&
748 (input_queue == NULL || output_queue == NULL)) {
749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
750
751 }
752
753 if (ep == NULL) {
754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
755 }
756
757 memset(ep, 0, sizeof(*ep));
758
759 ep->name = (endpoint_type == MBEDTLS_SSL_IS_SERVER) ? "Server" : "Client";
760
761 mbedtls_ssl_init(&(ep->ssl));
762 mbedtls_ssl_config_init(&(ep->conf));
Yanray Wange6afd912022-10-27 12:11:18 +0800763
764 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&ep->conf) == NULL);
765 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), 0);
766 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&ep->ssl) == NULL);
767 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), 0);
768
769 (void) mbedtls_test_rnd_std_rand(NULL,
770 (void *) &user_data_n,
771 sizeof(user_data_n));
772 mbedtls_ssl_conf_set_user_data_n(&ep->conf, user_data_n);
773 mbedtls_ssl_set_user_data_n(&ep->ssl, user_data_n);
774
775 if (dtls_context != NULL) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200776 TEST_EQUAL(mbedtls_test_message_socket_setup(input_queue, output_queue,
777 100, &(ep->socket),
778 dtls_context), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800779 } else {
Yanray Wang5f86a422023-03-15 16:02:29 +0800780 mbedtls_test_mock_socket_init(&(ep->socket));
Yanray Wange6afd912022-10-27 12:11:18 +0800781 }
782
783 /* Non-blocking callbacks without timeout */
784 if (dtls_context != NULL) {
785 mbedtls_ssl_set_bio(&(ep->ssl), dtls_context,
786 mbedtls_test_mock_tcp_send_msg,
787 mbedtls_test_mock_tcp_recv_msg,
788 NULL);
Gilles Peskine0677e022025-05-27 18:05:20 +0200789#if defined(MBEDTLS_TIMING_C)
790 mbedtls_ssl_set_timer_cb(&ep->ssl, &ep->timer,
791 mbedtls_timing_set_delay,
792 mbedtls_timing_get_delay);
793#endif
Yanray Wange6afd912022-10-27 12:11:18 +0800794 } else {
795 mbedtls_ssl_set_bio(&(ep->ssl), &(ep->socket),
796 mbedtls_test_mock_tcp_send_nb,
797 mbedtls_test_mock_tcp_recv_nb,
798 NULL);
799 }
800
801 ret = mbedtls_ssl_config_defaults(&(ep->conf), endpoint_type,
802 (dtls_context != NULL) ?
803 MBEDTLS_SSL_TRANSPORT_DATAGRAM :
804 MBEDTLS_SSL_TRANSPORT_STREAM,
805 MBEDTLS_SSL_PRESET_DEFAULT);
Gilles Peskine353eb332025-05-14 17:42:53 +0200806 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800807
Ronald Crona697a712023-03-09 17:47:42 +0100808 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
809 if (options->client_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
810 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
811 options->client_min_version);
812 }
813
814 if (options->client_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
815 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
816 options->client_max_version);
817 }
818 } else {
819 if (options->server_min_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
820 mbedtls_ssl_conf_min_tls_version(&(ep->conf),
821 options->server_min_version);
822 }
823
824 if (options->server_max_version != MBEDTLS_SSL_VERSION_UNKNOWN) {
825 mbedtls_ssl_conf_max_tls_version(&(ep->conf),
826 options->server_max_version);
827 }
828 }
829
Ronald Cronfb536472024-01-26 14:55:25 +0100830 if (options->group_list != NULL) {
831 mbedtls_ssl_conf_groups(&(ep->conf), options->group_list);
Yanray Wange6afd912022-10-27 12:11:18 +0800832 }
833
834 mbedtls_ssl_conf_authmode(&(ep->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
835
Ronald Cronced99be2024-01-26 15:49:12 +0100836#if defined(MBEDTLS_SSL_EARLY_DATA)
837 mbedtls_ssl_conf_early_data(&(ep->conf), options->early_data);
Ronald Cron5d3036e2024-02-23 07:43:45 +0100838#if defined(MBEDTLS_SSL_SRV_C)
839 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
840 (options->max_early_data_size >= 0)) {
841 mbedtls_ssl_conf_max_early_data_size(&(ep->conf),
842 options->max_early_data_size);
843 }
844#endif
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000845#if defined(MBEDTLS_SSL_ALPN)
846 /* check that alpn_list contains at least one valid entry */
847 if (options->alpn_list[0] != NULL) {
848 mbedtls_ssl_conf_alpn_protocols(&(ep->conf), options->alpn_list);
849 }
850#endif
Ronald Cronced99be2024-01-26 15:49:12 +0100851#endif
852
Yanray Wange6afd912022-10-27 12:11:18 +0800853#if defined(MBEDTLS_SSL_CACHE_C) && defined(MBEDTLS_SSL_SRV_C)
854 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && options->cache != NULL) {
855 mbedtls_ssl_conf_session_cache(&(ep->conf), options->cache,
856 mbedtls_ssl_cache_get,
857 mbedtls_ssl_cache_set);
858 }
859#endif
860
861 ret = mbedtls_ssl_setup(&(ep->ssl), &(ep->conf));
Gilles Peskine353eb332025-05-14 17:42:53 +0200862 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800863
Gilles Peskine856a3702025-02-13 17:28:49 +0100864 if (MBEDTLS_SSL_IS_CLIENT == endpoint_type) {
865 ret = mbedtls_ssl_set_hostname(&(ep->ssl), "localhost");
Gilles Peskine55b8bb42025-04-08 09:44:34 +0200866 TEST_EQUAL(ret, 0);
Gilles Peskine856a3702025-02-13 17:28:49 +0100867 }
868
Yanray Wange6afd912022-10-27 12:11:18 +0800869#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_SRV_C)
870 if (endpoint_type == MBEDTLS_SSL_IS_SERVER && dtls_context != NULL) {
871 mbedtls_ssl_conf_dtls_cookies(&(ep->conf), NULL, NULL, NULL);
872 }
873#endif
874
Ronald Cronec3408d2024-01-16 17:50:40 +0100875#if defined(MBEDTLS_DEBUG_C)
876#if defined(MBEDTLS_SSL_SRV_C)
877 if (endpoint_type == MBEDTLS_SSL_IS_SERVER &&
878 options->srv_log_fun != NULL) {
879 mbedtls_ssl_conf_dbg(&(ep->conf), options->srv_log_fun,
880 options->srv_log_obj);
881 }
882#endif
883#if defined(MBEDTLS_SSL_CLI_C)
884 if (endpoint_type == MBEDTLS_SSL_IS_CLIENT &&
885 options->cli_log_fun != NULL) {
886 mbedtls_ssl_conf_dbg(&(ep->conf), options->cli_log_fun,
887 options->cli_log_obj);
888 }
889#endif
890#endif /* MBEDTLS_DEBUG_C */
891
Yanray Wange6afd912022-10-27 12:11:18 +0800892 ret = mbedtls_test_ssl_endpoint_certificate_init(ep, options->pk_alg,
893 options->opaque_alg,
894 options->opaque_alg2,
895 options->opaque_usage);
Gilles Peskine353eb332025-05-14 17:42:53 +0200896 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800897
898 TEST_EQUAL(mbedtls_ssl_conf_get_user_data_n(&ep->conf), user_data_n);
899 mbedtls_ssl_conf_set_user_data_p(&ep->conf, ep);
900 TEST_EQUAL(mbedtls_ssl_get_user_data_n(&ep->ssl), user_data_n);
901 mbedtls_ssl_set_user_data_p(&ep->ssl, ep);
902
Gilles Peskine946bf142025-04-08 09:48:40 +0200903 return 0;
904
Yanray Wange6afd912022-10-27 12:11:18 +0800905exit:
Gilles Peskine946bf142025-04-08 09:48:40 +0200906 if (ret == 0) {
907 /* Exiting due to a test assertion that isn't ret == 0 */
908 ret = -1;
909 }
Yanray Wange6afd912022-10-27 12:11:18 +0800910 return ret;
911}
912
Yanray Wange6afd912022-10-27 12:11:18 +0800913void mbedtls_test_ssl_endpoint_free(
914 mbedtls_test_ssl_endpoint *ep,
915 mbedtls_test_message_socket_context *context)
916{
Yanray Wangf6f71902023-03-15 16:05:14 +0800917 test_ssl_endpoint_certificate_free(ep);
Yanray Wange6afd912022-10-27 12:11:18 +0800918
919 mbedtls_ssl_free(&(ep->ssl));
920 mbedtls_ssl_config_free(&(ep->conf));
921
922 if (context != NULL) {
923 mbedtls_test_message_socket_close(context);
924 } else {
925 mbedtls_test_mock_socket_close(&(ep->socket));
926 }
927}
928
Yanray Wange6afd912022-10-27 12:11:18 +0800929int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,
930 mbedtls_ssl_context *second_ssl,
931 int state)
932{
933 enum { BUFFSIZE = 1024 };
934 int max_steps = 1000;
935 int ret = 0;
936
937 if (ssl == NULL || second_ssl == NULL) {
938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
939 }
940
941 /* Perform communication via connected sockets */
942 while ((ssl->state != state) && (--max_steps >= 0)) {
943 /* If /p second_ssl ends the handshake procedure before /p ssl then
944 * there is no need to call the next step */
945 if (!mbedtls_ssl_is_handshake_over(second_ssl)) {
946 ret = mbedtls_ssl_handshake_step(second_ssl);
947 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
948 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
949 return ret;
950 }
951 }
952
953 /* We only care about the \p ssl state and returns, so we call it last,
954 * to leave the iteration as soon as the state is as expected. */
955 ret = mbedtls_ssl_handshake_step(ssl);
956 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ &&
957 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
958 return ret;
959 }
960 }
961
962 return (max_steps >= 0) ? ret : -1;
963}
964
965#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
966
967/*
968 * Write application data. Increase write counter if necessary.
969 */
Michael Schuster54300d42024-06-04 02:30:22 +0200970static int mbedtls_ssl_write_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +0200971 unsigned char *buf, int buf_len,
972 int *written,
973 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +0800974{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100975 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +0800976 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
977 * a valid no-op for TLS connections. */
978 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +0200979 TEST_EQUAL(mbedtls_ssl_write(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +0800980 }
981
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +0100982 ret = mbedtls_ssl_write(ssl, buf + *written, buf_len - *written);
Yanray Wange6afd912022-10-27 12:11:18 +0800983 if (ret > 0) {
984 *written += ret;
985 }
986
987 if (expected_fragments == 0) {
988 /* Used for DTLS and the message size larger than MFL. In that case
989 * the message can not be fragmented and the library should return
990 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA error. This error must be returned
Yanray Wangb088bfc2023-03-16 12:15:49 +0800991 * to prevent a dead loop inside mbedtls_test_ssl_exchange_data(). */
Yanray Wange6afd912022-10-27 12:11:18 +0800992 return ret;
993 } else if (expected_fragments == 1) {
994 /* Used for TLS/DTLS and the message size lower than MFL */
995 TEST_ASSERT(ret == buf_len ||
996 ret == MBEDTLS_ERR_SSL_WANT_READ ||
997 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
998 } else {
999 /* Used for TLS and the message size larger than MFL */
1000 TEST_ASSERT(expected_fragments > 1);
1001 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1002 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1003 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1004 }
1005
1006 return 0;
1007
1008exit:
1009 /* Some of the tests failed */
1010 return -1;
1011}
1012
1013/*
1014 * Read application data and increase read counter and fragments counter
1015 * if necessary.
1016 */
Michael Schuster54300d42024-06-04 02:30:22 +02001017static int mbedtls_ssl_read_fragment(mbedtls_ssl_context *ssl,
Michael Schusterbd89b792024-06-04 02:41:10 +02001018 unsigned char *buf, int buf_len,
1019 int *read, int *fragments,
1020 const int expected_fragments)
Yanray Wange6afd912022-10-27 12:11:18 +08001021{
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001022 int ret;
Yanray Wange6afd912022-10-27 12:11:18 +08001023 /* Verify that calling mbedtls_ssl_write with a NULL buffer and zero length is
1024 * a valid no-op for TLS connections. */
1025 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001026 TEST_EQUAL(mbedtls_ssl_read(ssl, NULL, 0), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001027 }
1028
Agathiyan Bragadeesh93212652023-07-12 11:22:59 +01001029 ret = mbedtls_ssl_read(ssl, buf + *read, buf_len - *read);
Yanray Wange6afd912022-10-27 12:11:18 +08001030 if (ret > 0) {
1031 (*fragments)++;
1032 *read += ret;
1033 }
1034
1035 if (expected_fragments == 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02001036 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001037 } else if (expected_fragments == 1) {
1038 TEST_ASSERT(ret == buf_len ||
1039 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1040 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1041 } else {
1042 TEST_ASSERT(expected_fragments > 1);
1043 TEST_ASSERT((ret >= 0 && ret <= buf_len) ||
1044 ret == MBEDTLS_ERR_SSL_WANT_READ ||
1045 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
1046 }
1047
1048 return 0;
1049
1050exit:
1051 /* Some of the tests failed */
1052 return -1;
1053}
1054
Yanray Wangead70c82023-03-16 12:04:49 +08001055#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
1056static void set_ciphersuite(mbedtls_ssl_config *conf, const char *cipher,
1057 int *forced_ciphersuite)
Yanray Wange6afd912022-10-27 12:11:18 +08001058{
1059 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
1060 forced_ciphersuite[0] = mbedtls_ssl_get_ciphersuite_id(cipher);
1061 forced_ciphersuite[1] = 0;
1062
1063 ciphersuite_info =
1064 mbedtls_ssl_ciphersuite_from_id(forced_ciphersuite[0]);
1065
1066 TEST_ASSERT(ciphersuite_info != NULL);
1067 TEST_ASSERT(ciphersuite_info->min_tls_version <= conf->max_tls_version);
1068 TEST_ASSERT(ciphersuite_info->max_tls_version >= conf->min_tls_version);
1069
1070 if (conf->max_tls_version > ciphersuite_info->max_tls_version) {
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001071 conf->max_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->max_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001072 }
1073 if (conf->min_tls_version < ciphersuite_info->min_tls_version) {
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001074 conf->min_tls_version = (mbedtls_ssl_protocol_version) ciphersuite_info->min_tls_version;
Yanray Wange6afd912022-10-27 12:11:18 +08001075 }
1076
1077 mbedtls_ssl_conf_ciphersuites(conf, forced_ciphersuite);
1078
1079exit:
1080 return;
1081}
Yanray Wangead70c82023-03-16 12:04:49 +08001082#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Yanray Wange6afd912022-10-27 12:11:18 +08001083
Yanray Wangead70c82023-03-16 12:04:49 +08001084#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
1085 defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED) && \
1086 defined(MBEDTLS_SSL_SRV_C)
1087static int psk_dummy_callback(void *p_info, mbedtls_ssl_context *ssl,
1088 const unsigned char *name, size_t name_len)
Yanray Wange6afd912022-10-27 12:11:18 +08001089{
1090 (void) p_info;
1091 (void) ssl;
1092 (void) name;
1093 (void) name_len;
1094
1095 return 0;
1096}
Yanray Wangead70c82023-03-16 12:04:49 +08001097#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
1098 MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED &&
1099 MBEDTLS_SSL_SRV_C */
Yanray Wange6afd912022-10-27 12:11:18 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Elena Uziunaite74342c72024-07-05 11:31:29 +01001102 defined(PSA_WANT_ALG_CBC_NO_PADDING) && defined(PSA_WANT_KEY_TYPE_AES)
Yanray Wange6afd912022-10-27 12:11:18 +08001103int mbedtls_test_psa_cipher_encrypt_helper(mbedtls_ssl_transform *transform,
1104 const unsigned char *iv,
1105 size_t iv_len,
1106 const unsigned char *input,
1107 size_t ilen,
1108 unsigned char *output,
1109 size_t *olen)
1110{
1111#if defined(MBEDTLS_USE_PSA_CRYPTO)
1112 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1113 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1114 size_t part_len;
1115
1116 status = psa_cipher_encrypt_setup(&cipher_op,
1117 transform->psa_key_enc,
1118 transform->psa_alg);
1119
1120 if (status != PSA_SUCCESS) {
1121 return PSA_TO_MBEDTLS_ERR(status);
1122 }
1123
1124 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1125
1126 if (status != PSA_SUCCESS) {
1127 return PSA_TO_MBEDTLS_ERR(status);
1128 }
1129
1130 status = psa_cipher_update(&cipher_op, input, ilen, output, ilen, olen);
1131
1132 if (status != PSA_SUCCESS) {
1133 return PSA_TO_MBEDTLS_ERR(status);
1134 }
1135
1136 status = psa_cipher_finish(&cipher_op, output + *olen, ilen - *olen,
1137 &part_len);
1138
1139 if (status != PSA_SUCCESS) {
1140 return PSA_TO_MBEDTLS_ERR(status);
1141 }
1142
1143 *olen += part_len;
1144 return 0;
1145#else
1146 return mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1147 iv, iv_len, input, ilen, output, olen);
1148#endif /* MBEDTLS_USE_PSA_CRYPTO */
1149}
Elena Uziunaite74342c72024-07-05 11:31:29 +01001150#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_ALG_CBC_NO_PADDING &&
Elena Uziunaite6121a342024-07-05 11:16:53 +01001151 PSA_WANT_KEY_TYPE_AES */
Yanray Wange6afd912022-10-27 12:11:18 +08001152
Valerio Setti31ad3a12023-10-27 11:55:02 +02001153static void mbedtls_test_ssl_cipher_info_from_type(mbedtls_cipher_type_t cipher_type,
1154 mbedtls_cipher_mode_t *cipher_mode,
1155 size_t *key_bits, size_t *iv_len)
1156{
1157 switch (cipher_type) {
1158 case MBEDTLS_CIPHER_AES_128_CBC:
1159 *cipher_mode = MBEDTLS_MODE_CBC;
1160 *key_bits = 128;
1161 *iv_len = 16;
1162 break;
1163 case MBEDTLS_CIPHER_AES_256_CBC:
1164 *cipher_mode = MBEDTLS_MODE_CBC;
1165 *key_bits = 256;
1166 *iv_len = 16;
1167 break;
1168 case MBEDTLS_CIPHER_ARIA_128_CBC:
1169 *cipher_mode = MBEDTLS_MODE_CBC;
1170 *key_bits = 128;
1171 *iv_len = 16;
1172 break;
1173 case MBEDTLS_CIPHER_ARIA_256_CBC:
1174 *cipher_mode = MBEDTLS_MODE_CBC;
1175 *key_bits = 256;
1176 *iv_len = 16;
1177 break;
1178 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1179 *cipher_mode = MBEDTLS_MODE_CBC;
1180 *key_bits = 128;
1181 *iv_len = 16;
1182 break;
1183 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1184 *cipher_mode = MBEDTLS_MODE_CBC;
1185 *key_bits = 256;
1186 *iv_len = 16;
1187 break;
1188
1189 case MBEDTLS_CIPHER_AES_128_CCM:
1190 *cipher_mode = MBEDTLS_MODE_CCM;
1191 *key_bits = 128;
1192 *iv_len = 12;
1193 break;
1194 case MBEDTLS_CIPHER_AES_192_CCM:
1195 *cipher_mode = MBEDTLS_MODE_CCM;
1196 *key_bits = 192;
1197 *iv_len = 12;
1198 break;
1199 case MBEDTLS_CIPHER_AES_256_CCM:
1200 *cipher_mode = MBEDTLS_MODE_CCM;
1201 *key_bits = 256;
1202 *iv_len = 12;
1203 break;
1204 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1205 *cipher_mode = MBEDTLS_MODE_CCM;
1206 *key_bits = 128;
1207 *iv_len = 12;
1208 break;
1209 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1210 *cipher_mode = MBEDTLS_MODE_CCM;
1211 *key_bits = 192;
1212 *iv_len = 12;
1213 break;
1214 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1215 *cipher_mode = MBEDTLS_MODE_CCM;
1216 *key_bits = 256;
1217 *iv_len = 12;
1218 break;
1219
1220 case MBEDTLS_CIPHER_AES_128_GCM:
1221 *cipher_mode = MBEDTLS_MODE_GCM;
1222 *key_bits = 128;
1223 *iv_len = 12;
1224 break;
1225 case MBEDTLS_CIPHER_AES_192_GCM:
1226 *cipher_mode = MBEDTLS_MODE_GCM;
1227 *key_bits = 192;
1228 *iv_len = 12;
1229 break;
1230 case MBEDTLS_CIPHER_AES_256_GCM:
1231 *cipher_mode = MBEDTLS_MODE_GCM;
1232 *key_bits = 256;
1233 *iv_len = 12;
1234 break;
1235 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1236 *cipher_mode = MBEDTLS_MODE_GCM;
1237 *key_bits = 128;
1238 *iv_len = 12;
1239 break;
1240 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1241 *cipher_mode = MBEDTLS_MODE_GCM;
1242 *key_bits = 192;
1243 *iv_len = 12;
1244 break;
1245 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1246 *cipher_mode = MBEDTLS_MODE_GCM;
1247 *key_bits = 256;
1248 *iv_len = 12;
1249 break;
1250
1251 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1252 *cipher_mode = MBEDTLS_MODE_CHACHAPOLY;
1253 *key_bits = 256;
1254 *iv_len = 12;
1255 break;
1256
1257 case MBEDTLS_CIPHER_NULL:
1258 *cipher_mode = MBEDTLS_MODE_STREAM;
1259 *key_bits = 0;
1260 *iv_len = 0;
1261 break;
1262
1263 default:
1264 *cipher_mode = MBEDTLS_MODE_NONE;
1265 *key_bits = 0;
1266 *iv_len = 0;
1267 }
1268}
1269
Yanray Wange6afd912022-10-27 12:11:18 +08001270int mbedtls_test_ssl_build_transforms(mbedtls_ssl_transform *t_in,
1271 mbedtls_ssl_transform *t_out,
1272 int cipher_type, int hash_id,
1273 int etm, int tag_mode,
1274 mbedtls_ssl_protocol_version tls_version,
1275 size_t cid0_len,
1276 size_t cid1_len)
1277{
Valerio Setti31ad3a12023-10-27 11:55:02 +02001278 mbedtls_cipher_mode_t cipher_mode = MBEDTLS_MODE_NONE;
1279 size_t key_bits = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001280 int ret = 0;
1281
1282#if defined(MBEDTLS_USE_PSA_CRYPTO)
1283 psa_key_type_t key_type;
1284 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1285 psa_algorithm_t alg;
Yanray Wange6afd912022-10-27 12:11:18 +08001286 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001287#else
Valerio Setti31ad3a12023-10-27 11:55:02 +02001288 mbedtls_cipher_info_t const *cipher_info;
Yanray Wange6afd912022-10-27 12:11:18 +08001289#endif
1290
Valerio Setti31ad3a12023-10-27 11:55:02 +02001291 size_t keylen, maclen, ivlen = 0;
Yanray Wange6afd912022-10-27 12:11:18 +08001292 unsigned char *key0 = NULL, *key1 = NULL;
1293 unsigned char *md0 = NULL, *md1 = NULL;
1294 unsigned char iv_enc[16], iv_dec[16];
1295
1296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1297 unsigned char cid0[SSL_CID_LEN_MIN];
1298 unsigned char cid1[SSL_CID_LEN_MIN];
1299
1300 mbedtls_test_rnd_std_rand(NULL, cid0, sizeof(cid0));
1301 mbedtls_test_rnd_std_rand(NULL, cid1, sizeof(cid1));
1302#else
1303 ((void) cid0_len);
1304 ((void) cid1_len);
1305#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1306
1307 maclen = 0;
Valerio Setti31ad3a12023-10-27 11:55:02 +02001308 mbedtls_test_ssl_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type,
1309 &cipher_mode, &key_bits, &ivlen);
Yanray Wange6afd912022-10-27 12:11:18 +08001310
1311 /* Pick keys */
Valerio Setti31ad3a12023-10-27 11:55:02 +02001312 keylen = key_bits / 8;
Yanray Wange6afd912022-10-27 12:11:18 +08001313 /* Allocate `keylen + 1` bytes to ensure that we get
1314 * a non-NULL pointers from `mbedtls_calloc` even if
1315 * `keylen == 0` in the case of the NULL cipher. */
1316 CHK((key0 = mbedtls_calloc(1, keylen + 1)) != NULL);
1317 CHK((key1 = mbedtls_calloc(1, keylen + 1)) != NULL);
1318 memset(key0, 0x1, keylen);
1319 memset(key1, 0x2, keylen);
1320
1321#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001322 /* Pick cipher */
1323 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) cipher_type);
1324 CHK(cipher_info != NULL);
1325 CHK(mbedtls_cipher_info_get_iv_size(cipher_info) <= 16);
1326 CHK(mbedtls_cipher_info_get_key_bitlen(cipher_info) % 8 == 0);
Valerio Setti3d59ebe2023-10-30 11:56:56 +01001327
Yanray Wange6afd912022-10-27 12:11:18 +08001328 /* Setup cipher contexts */
1329 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_enc, cipher_info) == 0);
1330 CHK(mbedtls_cipher_setup(&t_in->cipher_ctx_dec, cipher_info) == 0);
1331 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_enc, cipher_info) == 0);
1332 CHK(mbedtls_cipher_setup(&t_out->cipher_ctx_dec, cipher_info) == 0);
1333
1334#if defined(MBEDTLS_CIPHER_MODE_CBC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001335 if (cipher_mode == MBEDTLS_MODE_CBC) {
Yanray Wange6afd912022-10-27 12:11:18 +08001336 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_enc,
1337 MBEDTLS_PADDING_NONE) == 0);
1338 CHK(mbedtls_cipher_set_padding_mode(&t_in->cipher_ctx_dec,
1339 MBEDTLS_PADDING_NONE) == 0);
1340 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_enc,
1341 MBEDTLS_PADDING_NONE) == 0);
1342 CHK(mbedtls_cipher_set_padding_mode(&t_out->cipher_ctx_dec,
1343 MBEDTLS_PADDING_NONE) == 0);
1344 }
1345#endif /* MBEDTLS_CIPHER_MODE_CBC */
1346
1347 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_enc, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001348 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1349 MBEDTLS_ENCRYPT)
1350 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001351 CHK(mbedtls_cipher_setkey(&t_in->cipher_ctx_dec, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001352 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1353 MBEDTLS_DECRYPT)
1354 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001355 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_enc, key1,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001356 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1357 MBEDTLS_ENCRYPT)
1358 == 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001359 CHK(mbedtls_cipher_setkey(&t_out->cipher_ctx_dec, key0,
Yanray Wanga8f445e2022-11-03 11:51:59 +08001360 (keylen << 3 > INT_MAX) ? INT_MAX : (int) keylen << 3,
1361 MBEDTLS_DECRYPT)
1362 == 0);
Valerio Setti31ad3a12023-10-27 11:55:02 +02001363#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Yanray Wange6afd912022-10-27 12:11:18 +08001364
1365 /* Setup MAC contexts */
1366#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Valerio Setti31ad3a12023-10-27 11:55:02 +02001367 if (cipher_mode == MBEDTLS_MODE_CBC ||
1368 cipher_mode == MBEDTLS_MODE_STREAM) {
Yanray Wange6afd912022-10-27 12:11:18 +08001369#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001370 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 +08001371 CHK(md_info != NULL);
1372#endif
Agathiyan Bragadeesh2f017a82023-07-12 11:21:54 +01001373 maclen = mbedtls_md_get_size_from_type((mbedtls_md_type_t) hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001374 CHK(maclen != 0);
1375 /* Pick hash keys */
1376 CHK((md0 = mbedtls_calloc(1, maclen)) != NULL);
1377 CHK((md1 = mbedtls_calloc(1, maclen)) != NULL);
1378 memset(md0, 0x5, maclen);
1379 memset(md1, 0x6, maclen);
1380
1381#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001382 alg = mbedtls_md_psa_alg_from_type(hash_id);
Yanray Wange6afd912022-10-27 12:11:18 +08001383
1384 CHK(alg != 0);
1385
1386 t_out->psa_mac_alg = PSA_ALG_HMAC(alg);
1387 t_in->psa_mac_alg = PSA_ALG_HMAC(alg);
1388 t_in->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1389 t_out->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1390 t_in->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1391 t_out->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
1392
1393 psa_reset_key_attributes(&attributes);
1394 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
1395 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(alg));
1396 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
1397
1398 CHK(psa_import_key(&attributes,
1399 md0, maclen,
1400 &t_in->psa_mac_enc) == PSA_SUCCESS);
1401
1402 CHK(psa_import_key(&attributes,
1403 md1, maclen,
1404 &t_out->psa_mac_enc) == PSA_SUCCESS);
1405
Valerio Setti31ad3a12023-10-27 11:55:02 +02001406 if (cipher_mode == MBEDTLS_MODE_STREAM ||
Yanray Wange6afd912022-10-27 12:11:18 +08001407 etm == MBEDTLS_SSL_ETM_DISABLED) {
1408 /* mbedtls_ct_hmac() requires the key to be exportable */
1409 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
1410 PSA_KEY_USAGE_VERIFY_HASH);
1411 } else {
1412 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
1413 }
1414
1415 CHK(psa_import_key(&attributes,
1416 md1, maclen,
1417 &t_in->psa_mac_dec) == PSA_SUCCESS);
1418
1419 CHK(psa_import_key(&attributes,
1420 md0, maclen,
1421 &t_out->psa_mac_dec) == PSA_SUCCESS);
1422#else
1423 CHK(mbedtls_md_setup(&t_out->md_ctx_enc, md_info, 1) == 0);
1424 CHK(mbedtls_md_setup(&t_out->md_ctx_dec, md_info, 1) == 0);
1425 CHK(mbedtls_md_setup(&t_in->md_ctx_enc, md_info, 1) == 0);
1426 CHK(mbedtls_md_setup(&t_in->md_ctx_dec, md_info, 1) == 0);
1427
1428 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_enc,
1429 md0, maclen) == 0);
1430 CHK(mbedtls_md_hmac_starts(&t_in->md_ctx_dec,
1431 md1, maclen) == 0);
1432 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_enc,
1433 md1, maclen) == 0);
1434 CHK(mbedtls_md_hmac_starts(&t_out->md_ctx_dec,
1435 md0, maclen) == 0);
1436#endif
1437 }
1438#else
1439 ((void) hash_id);
1440#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1441
1442
1443 /* Pick IV's (regardless of whether they
1444 * are being used by the transform). */
Yanray Wange6afd912022-10-27 12:11:18 +08001445 memset(iv_enc, 0x3, sizeof(iv_enc));
1446 memset(iv_dec, 0x4, sizeof(iv_dec));
1447
1448 /*
1449 * Setup transforms
1450 */
1451
1452#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
1453 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1454 t_out->encrypt_then_mac = etm;
1455 t_in->encrypt_then_mac = etm;
1456#else
1457 ((void) etm);
1458#endif
1459
1460 t_out->tls_version = tls_version;
1461 t_in->tls_version = tls_version;
1462 t_out->ivlen = ivlen;
1463 t_in->ivlen = ivlen;
1464
Valerio Setti31ad3a12023-10-27 11:55:02 +02001465 switch (cipher_mode) {
Yanray Wange6afd912022-10-27 12:11:18 +08001466 case MBEDTLS_MODE_GCM:
1467 case MBEDTLS_MODE_CCM:
1468#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1469 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
1470 t_out->fixed_ivlen = 12;
1471 t_in->fixed_ivlen = 12;
1472 } else
1473#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1474 {
1475 t_out->fixed_ivlen = 4;
1476 t_in->fixed_ivlen = 4;
1477 }
1478 t_out->maclen = 0;
1479 t_in->maclen = 0;
1480 switch (tag_mode) {
1481 case 0: /* Full tag */
1482 t_out->taglen = 16;
1483 t_in->taglen = 16;
1484 break;
1485 case 1: /* Partial tag */
1486 t_out->taglen = 8;
1487 t_in->taglen = 8;
1488 break;
1489 default:
1490 ret = 1;
1491 goto cleanup;
1492 }
1493 break;
1494
1495 case MBEDTLS_MODE_CHACHAPOLY:
1496 t_out->fixed_ivlen = 12;
1497 t_in->fixed_ivlen = 12;
1498 t_out->maclen = 0;
1499 t_in->maclen = 0;
1500 switch (tag_mode) {
1501 case 0: /* Full tag */
1502 t_out->taglen = 16;
1503 t_in->taglen = 16;
1504 break;
1505 case 1: /* Partial tag */
1506 t_out->taglen = 8;
1507 t_in->taglen = 8;
1508 break;
1509 default:
1510 ret = 1;
1511 goto cleanup;
1512 }
1513 break;
1514
1515 case MBEDTLS_MODE_STREAM:
1516 case MBEDTLS_MODE_CBC:
1517 t_out->fixed_ivlen = 0; /* redundant, must be 0 */
1518 t_in->fixed_ivlen = 0; /* redundant, must be 0 */
1519 t_out->taglen = 0;
1520 t_in->taglen = 0;
1521 switch (tag_mode) {
1522 case 0: /* Full tag */
1523 t_out->maclen = maclen;
1524 t_in->maclen = maclen;
1525 break;
1526 default:
1527 ret = 1;
1528 goto cleanup;
1529 }
1530 break;
1531 default:
1532 ret = 1;
1533 goto cleanup;
1534 break;
1535 }
1536
1537 /* Setup IV's */
1538
1539 memcpy(&t_in->iv_dec, iv_dec, sizeof(iv_dec));
1540 memcpy(&t_in->iv_enc, iv_enc, sizeof(iv_enc));
1541 memcpy(&t_out->iv_dec, iv_enc, sizeof(iv_enc));
1542 memcpy(&t_out->iv_enc, iv_dec, sizeof(iv_dec));
1543
1544#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1545 /* Add CID */
1546 memcpy(&t_in->in_cid, cid0, cid0_len);
1547 memcpy(&t_in->out_cid, cid1, cid1_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001548 t_in->in_cid_len = (uint8_t) cid0_len;
1549 t_in->out_cid_len = (uint8_t) cid1_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001550 memcpy(&t_out->in_cid, cid1, cid1_len);
1551 memcpy(&t_out->out_cid, cid0, cid0_len);
Yanray Wanga8f445e2022-11-03 11:51:59 +08001552 t_out->in_cid_len = (uint8_t) cid1_len;
1553 t_out->out_cid_len = (uint8_t) cid0_len;
Yanray Wange6afd912022-10-27 12:11:18 +08001554#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1555
1556#if defined(MBEDTLS_USE_PSA_CRYPTO)
1557 status = mbedtls_ssl_cipher_to_psa(cipher_type,
1558 t_in->taglen,
1559 &alg,
1560 &key_type,
1561 &key_bits);
1562
1563 if (status != PSA_SUCCESS) {
1564 ret = PSA_TO_MBEDTLS_ERR(status);
1565 goto cleanup;
1566 }
1567
1568 t_in->psa_alg = alg;
1569 t_out->psa_alg = alg;
1570
1571 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
1572 psa_reset_key_attributes(&attributes);
1573 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
1574 psa_set_key_algorithm(&attributes, alg);
1575 psa_set_key_type(&attributes, key_type);
1576
1577 status = psa_import_key(&attributes,
1578 key0,
1579 PSA_BITS_TO_BYTES(key_bits),
1580 &t_in->psa_key_enc);
1581
1582 if (status != PSA_SUCCESS) {
1583 ret = PSA_TO_MBEDTLS_ERR(status);
1584 goto cleanup;
1585 }
1586
1587 status = psa_import_key(&attributes,
1588 key1,
1589 PSA_BITS_TO_BYTES(key_bits),
1590 &t_out->psa_key_enc);
1591
1592 if (status != PSA_SUCCESS) {
1593 ret = PSA_TO_MBEDTLS_ERR(status);
1594 goto cleanup;
1595 }
1596
1597 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
1598
1599 status = psa_import_key(&attributes,
1600 key1,
1601 PSA_BITS_TO_BYTES(key_bits),
1602 &t_in->psa_key_dec);
1603
1604 if (status != PSA_SUCCESS) {
1605 ret = PSA_TO_MBEDTLS_ERR(status);
1606 goto cleanup;
1607 }
1608
1609 status = psa_import_key(&attributes,
1610 key0,
1611 PSA_BITS_TO_BYTES(key_bits),
1612 &t_out->psa_key_dec);
1613
1614 if (status != PSA_SUCCESS) {
1615 ret = PSA_TO_MBEDTLS_ERR(status);
1616 goto cleanup;
1617 }
1618 }
1619#endif /* MBEDTLS_USE_PSA_CRYPTO */
1620
1621cleanup:
1622
1623 mbedtls_free(key0);
1624 mbedtls_free(key1);
1625
1626 mbedtls_free(md0);
1627 mbedtls_free(md1);
1628
1629 return ret;
1630}
1631
Gilles Peskine9099d3f2023-09-18 13:11:50 +02001632#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1633int mbedtls_test_ssl_prepare_record_mac(mbedtls_record *record,
1634 mbedtls_ssl_transform *transform_out)
1635{
1636#if defined(MBEDTLS_USE_PSA_CRYPTO)
1637 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1638#endif
1639
1640 /* Serialized version of record header for MAC purposes */
1641 unsigned char add_data[13];
1642 memcpy(add_data, record->ctr, 8);
1643 add_data[8] = record->type;
1644 add_data[9] = record->ver[0];
1645 add_data[10] = record->ver[1];
1646 add_data[11] = (record->data_len >> 8) & 0xff;
1647 add_data[12] = (record->data_len >> 0) & 0xff;
1648
1649 /* MAC with additional data */
1650#if defined(MBEDTLS_USE_PSA_CRYPTO)
1651 size_t sign_mac_length = 0;
1652 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_setup(&operation,
1653 transform_out->psa_mac_enc,
1654 transform_out->psa_mac_alg));
1655 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation, add_data, 13));
1656 TEST_EQUAL(PSA_SUCCESS, psa_mac_update(&operation,
1657 record->buf + record->data_offset,
1658 record->data_len));
1659 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1660 * extension, there might not be enough room in the record for the
1661 * full-length MAC. */
1662 unsigned char mac[PSA_HASH_MAX_SIZE];
1663 TEST_EQUAL(PSA_SUCCESS, psa_mac_sign_finish(&operation,
1664 mac, sizeof(mac),
1665 &sign_mac_length));
1666#else
1667 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc, add_data, 13));
1668 TEST_EQUAL(0, mbedtls_md_hmac_update(&transform_out->md_ctx_enc,
1669 record->buf + record->data_offset,
1670 record->data_len));
1671 /* Use a temporary buffer for the MAC, because with the truncated HMAC
1672 * extension, there might not be enough room in the record for the
1673 * full-length MAC. */
1674 unsigned char mac[MBEDTLS_MD_MAX_SIZE];
1675 TEST_EQUAL(0, mbedtls_md_hmac_finish(&transform_out->md_ctx_enc, mac));
1676#endif
1677 memcpy(record->buf + record->data_offset + record->data_len, mac, transform_out->maclen);
1678 record->data_len += transform_out->maclen;
1679
1680 return 0;
1681
1682exit:
1683#if defined(MBEDTLS_USE_PSA_CRYPTO)
1684 psa_mac_abort(&operation);
1685#endif
1686 return -1;
1687}
1688#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1689
Jerry Yu28547c42023-10-31 14:42:50 +08001690#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001691int mbedtls_test_ssl_tls12_populate_session(mbedtls_ssl_session *session,
1692 int ticket_len,
Ronald Cron7b1921a2023-11-23 12:31:56 +01001693 int endpoint_type,
Yanray Wange6afd912022-10-27 12:11:18 +08001694 const char *crt_file)
1695{
Ronald Cronc57f86e2023-11-22 09:50:01 +01001696 (void) ticket_len;
1697
Yanray Wange6afd912022-10-27 12:11:18 +08001698#if defined(MBEDTLS_HAVE_TIME)
1699 session->start = mbedtls_time(NULL) - 42;
1700#endif
1701 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001702
1703 TEST_ASSERT(endpoint_type == MBEDTLS_SSL_IS_CLIENT ||
1704 endpoint_type == MBEDTLS_SSL_IS_SERVER);
1705
1706 session->endpoint = endpoint_type;
Yanray Wange6afd912022-10-27 12:11:18 +08001707 session->ciphersuite = 0xabcd;
1708 session->id_len = sizeof(session->id);
1709 memset(session->id, 66, session->id_len);
1710 memset(session->master, 17, sizeof(session->master));
1711
1712#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && defined(MBEDTLS_FS_IO)
1713 if (crt_file != NULL && strlen(crt_file) != 0) {
1714 mbedtls_x509_crt tmp_crt;
1715 int ret;
1716
1717 mbedtls_x509_crt_init(&tmp_crt);
1718 ret = mbedtls_x509_crt_parse_file(&tmp_crt, crt_file);
1719 if (ret != 0) {
1720 return ret;
1721 }
1722
1723#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1724 /* Move temporary CRT. */
1725 session->peer_cert = mbedtls_calloc(1, sizeof(*session->peer_cert));
1726 if (session->peer_cert == NULL) {
1727 return -1;
1728 }
1729 *session->peer_cert = tmp_crt;
1730 memset(&tmp_crt, 0, sizeof(tmp_crt));
1731#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1732 /* Calculate digest of temporary CRT. */
1733 session->peer_cert_digest =
1734 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
1735 if (session->peer_cert_digest == NULL) {
1736 return -1;
1737 }
1738
1739#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001740 psa_algorithm_t psa_alg = mbedtls_md_psa_alg_from_type(
Yanray Wange6afd912022-10-27 12:11:18 +08001741 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE);
1742 size_t hash_size = 0;
1743 psa_status_t status = psa_hash_compute(
1744 psa_alg, tmp_crt.raw.p,
1745 tmp_crt.raw.len,
1746 session->peer_cert_digest,
1747 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN,
1748 &hash_size);
1749 ret = PSA_TO_MBEDTLS_ERR(status);
1750#else
1751 ret = mbedtls_md(mbedtls_md_info_from_type(
1752 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
1753 tmp_crt.raw.p, tmp_crt.raw.len,
1754 session->peer_cert_digest);
1755#endif /* MBEDTLS_USE_PSA_CRYPTO */
1756 if (ret != 0) {
1757 return ret;
1758 }
1759 session->peer_cert_digest_type =
1760 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
1761 session->peer_cert_digest_len =
1762 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
1763#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1764
1765 mbedtls_x509_crt_free(&tmp_crt);
1766 }
1767#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1768 (void) crt_file;
1769#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED && MBEDTLS_FS_IO */
1770 session->verify_result = 0xdeadbeef;
1771
Ronald Cronc57f86e2023-11-22 09:50:01 +01001772#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1773#if defined(MBEDTLS_SSL_CLI_C)
Yanray Wange6afd912022-10-27 12:11:18 +08001774 if (ticket_len != 0) {
1775 session->ticket = mbedtls_calloc(1, ticket_len);
1776 if (session->ticket == NULL) {
1777 return -1;
1778 }
1779 memset(session->ticket, 33, ticket_len);
1780 }
1781 session->ticket_len = ticket_len;
1782 session->ticket_lifetime = 86401;
Ronald Cronc57f86e2023-11-22 09:50:01 +01001783#endif /* MBEDTLS_SSL_CLI_C */
1784
1785#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_HAVE_TIME)
1786 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1787 session->ticket_creation_time = mbedtls_ms_time() - 42;
1788 }
Yanray Wange6afd912022-10-27 12:11:18 +08001789#endif
Ronald Cronc57f86e2023-11-22 09:50:01 +01001790#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001791
1792#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1793 session->mfl_code = 1;
1794#endif
1795#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1796 session->encrypt_then_mac = 1;
1797#endif
1798
Ronald Cronc7fa82e2024-02-09 09:33:09 +01001799exit:
Yanray Wange6afd912022-10-27 12:11:18 +08001800 return 0;
1801}
Jerry Yu28547c42023-10-31 14:42:50 +08001802#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wange6afd912022-10-27 12:11:18 +08001803
1804#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1805int mbedtls_test_ssl_tls13_populate_session(mbedtls_ssl_session *session,
1806 int ticket_len,
1807 int endpoint_type)
1808{
1809 ((void) ticket_len);
1810 session->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1811 session->endpoint = endpoint_type == MBEDTLS_SSL_IS_CLIENT ?
1812 MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER;
1813 session->ciphersuite = 0xabcd;
Ronald Cron18b92a12024-03-26 10:15:08 +01001814
1815#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001816 session->ticket_age_add = 0x87654321;
1817 session->ticket_flags = 0x7;
Yanray Wange6afd912022-10-27 12:11:18 +08001818 session->resumption_key_len = 32;
1819 memset(session->resumption_key, 0x99, sizeof(session->resumption_key));
Yanray Wange6afd912022-10-27 12:11:18 +08001820#endif
1821
Ronald Cron18b92a12024-03-26 10:15:08 +01001822#if defined(MBEDTLS_SSL_SRV_C)
1823 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
1824#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1825#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
1826 int ret = mbedtls_ssl_session_set_ticket_alpn(session, "ALPNExample");
1827 if (ret != 0) {
1828 return -1;
1829 }
1830#endif
1831#if defined(MBEDTLS_HAVE_TIME)
1832 session->ticket_creation_time = mbedtls_ms_time() - 42;
1833#endif
1834#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1835 }
1836#endif /* MBEDTLS_SSL_SRV_C */
1837
Yanray Wange6afd912022-10-27 12:11:18 +08001838#if defined(MBEDTLS_SSL_CLI_C)
1839 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron18b92a12024-03-26 10:15:08 +01001840#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Yanray Wange6afd912022-10-27 12:11:18 +08001841#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08001842 session->ticket_reception_time = mbedtls_ms_time() - 40;
Yanray Wange6afd912022-10-27 12:11:18 +08001843#endif
1844 session->ticket_lifetime = 0xfedcba98;
1845
1846 session->ticket_len = ticket_len;
1847 if (ticket_len != 0) {
1848 session->ticket = mbedtls_calloc(1, ticket_len);
1849 if (session->ticket == NULL) {
1850 return -1;
1851 }
1852 memset(session->ticket, 33, ticket_len);
1853 }
Ronald Cron8d15e012024-03-27 09:30:13 +01001854#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1855 char hostname[] = "hostname example";
1856 session->hostname = mbedtls_calloc(1, sizeof(hostname));
1857 if (session->hostname == NULL) {
1858 return -1;
1859 }
1860 memcpy(session->hostname, hostname, sizeof(hostname));
1861#endif
Ronald Cron18b92a12024-03-26 10:15:08 +01001862#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Yanray Wange6afd912022-10-27 12:11:18 +08001863 }
1864#endif /* MBEDTLS_SSL_CLI_C */
1865
Ronald Cron18b92a12024-03-26 10:15:08 +01001866#if defined(MBEDTLS_SSL_EARLY_DATA)
1867 session->max_early_data_size = 0x87654321;
1868#endif /* MBEDTLS_SSL_EARLY_DATA */
1869
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001870#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1871 session->record_size_limit = 2048;
1872#endif
1873
Yanray Wange6afd912022-10-27 12:11:18 +08001874 return 0;
1875}
1876#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1877
Yanray Wangb088bfc2023-03-16 12:15:49 +08001878int mbedtls_test_ssl_exchange_data(
1879 mbedtls_ssl_context *ssl_1,
1880 int msg_len_1, const int expected_fragments_1,
1881 mbedtls_ssl_context *ssl_2,
1882 int msg_len_2, const int expected_fragments_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001883{
1884 unsigned char *msg_buf_1 = malloc(msg_len_1);
1885 unsigned char *msg_buf_2 = malloc(msg_len_2);
1886 unsigned char *in_buf_1 = malloc(msg_len_2);
1887 unsigned char *in_buf_2 = malloc(msg_len_1);
1888 int msg_type, ret = -1;
1889
1890 /* Perform this test with two message types. At first use a message
1891 * consisting of only 0x00 for the client and only 0xFF for the server.
1892 * At the second time use message with generated data */
1893 for (msg_type = 0; msg_type < 2; msg_type++) {
1894 int written_1 = 0;
1895 int written_2 = 0;
1896 int read_1 = 0;
1897 int read_2 = 0;
1898 int fragments_1 = 0;
1899 int fragments_2 = 0;
1900
1901 if (msg_type == 0) {
1902 memset(msg_buf_1, 0x00, msg_len_1);
1903 memset(msg_buf_2, 0xff, msg_len_2);
1904 } else {
1905 int i, j = 0;
1906 for (i = 0; i < msg_len_1; i++) {
1907 msg_buf_1[i] = j++ & 0xFF;
1908 }
1909 for (i = 0; i < msg_len_2; i++) {
1910 msg_buf_2[i] = (j -= 5) & 0xFF;
1911 }
1912 }
1913
1914 while (read_1 < msg_len_2 || read_2 < msg_len_1) {
1915 /* ssl_1 sending */
1916 if (msg_len_1 > written_1) {
1917 ret = mbedtls_ssl_write_fragment(ssl_1, msg_buf_1,
1918 msg_len_1, &written_1,
1919 expected_fragments_1);
1920 if (expected_fragments_1 == 0) {
1921 /* This error is expected when the message is too large and
1922 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001923 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001924 msg_len_1 = 0;
1925 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001926 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001927 }
1928 }
1929
1930 /* ssl_2 sending */
1931 if (msg_len_2 > written_2) {
1932 ret = mbedtls_ssl_write_fragment(ssl_2, msg_buf_2,
1933 msg_len_2, &written_2,
1934 expected_fragments_2);
1935 if (expected_fragments_2 == 0) {
1936 /* This error is expected when the message is too large and
1937 * cannot be fragmented */
Gilles Peskine353eb332025-05-14 17:42:53 +02001938 TEST_EQUAL(ret, MBEDTLS_ERR_SSL_BAD_INPUT_DATA);
Yanray Wange6afd912022-10-27 12:11:18 +08001939 msg_len_2 = 0;
1940 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02001941 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001942 }
1943 }
1944
1945 /* ssl_1 reading */
1946 if (read_1 < msg_len_2) {
1947 ret = mbedtls_ssl_read_fragment(ssl_1, in_buf_1,
1948 msg_len_2, &read_1,
1949 &fragments_2,
1950 expected_fragments_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02001951 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001952 }
1953
1954 /* ssl_2 reading */
1955 if (read_2 < msg_len_1) {
1956 ret = mbedtls_ssl_read_fragment(ssl_2, in_buf_2,
1957 msg_len_1, &read_2,
1958 &fragments_1,
1959 expected_fragments_1);
Gilles Peskine353eb332025-05-14 17:42:53 +02001960 TEST_EQUAL(ret, 0);
Yanray Wange6afd912022-10-27 12:11:18 +08001961 }
1962 }
1963
1964 ret = -1;
Gilles Peskine353eb332025-05-14 17:42:53 +02001965 TEST_EQUAL(0, memcmp(msg_buf_1, in_buf_2, msg_len_1));
1966 TEST_EQUAL(0, memcmp(msg_buf_2, in_buf_1, msg_len_2));
1967 TEST_EQUAL(fragments_1, expected_fragments_1);
1968 TEST_EQUAL(fragments_2, expected_fragments_2);
Yanray Wange6afd912022-10-27 12:11:18 +08001969 }
1970
1971 ret = 0;
1972
1973exit:
1974 free(msg_buf_1);
1975 free(in_buf_1);
1976 free(msg_buf_2);
1977 free(in_buf_2);
1978
1979 return ret;
1980}
1981
1982/*
1983 * Perform data exchanging between \p ssl_1 and \p ssl_2. Both of endpoints
1984 * must be initialized and connected beforehand.
1985 *
1986 * \retval 0 on success, otherwise error code.
1987 */
Yanray Wangead70c82023-03-16 12:04:49 +08001988#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) && \
1989 (defined(MBEDTLS_SSL_RENEGOTIATION) || \
1990 defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH))
1991static int exchange_data(mbedtls_ssl_context *ssl_1,
1992 mbedtls_ssl_context *ssl_2)
Yanray Wange6afd912022-10-27 12:11:18 +08001993{
Yanray Wangb088bfc2023-03-16 12:15:49 +08001994 return mbedtls_test_ssl_exchange_data(ssl_1, 256, 1,
1995 ssl_2, 256, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08001996}
Yanray Wangead70c82023-03-16 12:04:49 +08001997#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED &&
1998 (MBEDTLS_SSL_RENEGOTIATION ||
1999 MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH) */
Yanray Wange6afd912022-10-27 12:11:18 +08002000
2001#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2002static int check_ssl_version(
2003 mbedtls_ssl_protocol_version expected_negotiated_version,
2004 const mbedtls_ssl_context *ssl)
2005{
2006 const char *version_string = mbedtls_ssl_get_version(ssl);
2007 mbedtls_ssl_protocol_version version_number =
2008 mbedtls_ssl_get_version_number(ssl);
2009
2010 TEST_EQUAL(ssl->tls_version, expected_negotiated_version);
2011
2012 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2013 TEST_EQUAL(version_string[0], 'D');
2014 ++version_string;
2015 }
2016
2017 switch (expected_negotiated_version) {
2018 case MBEDTLS_SSL_VERSION_TLS1_2:
2019 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_2);
Gilles Peskine353eb332025-05-14 17:42:53 +02002020 TEST_EQUAL(strcmp(version_string, "TLSv1.2"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002021 break;
2022
2023 case MBEDTLS_SSL_VERSION_TLS1_3:
2024 TEST_EQUAL(version_number, MBEDTLS_SSL_VERSION_TLS1_3);
Gilles Peskine353eb332025-05-14 17:42:53 +02002025 TEST_EQUAL(strcmp(version_string, "TLSv1.3"), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002026 break;
2027
2028 default:
Agathiyan Bragadeeshdc28a5a2023-07-18 11:45:28 +01002029 TEST_FAIL(
Agathiyan Bragadeeshebb40bc2023-07-14 17:28:27 +01002030 "Version check not implemented for this protocol version");
Yanray Wange6afd912022-10-27 12:11:18 +08002031 }
2032
2033 return 1;
2034
2035exit:
2036 return 0;
2037}
2038#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2039
Yanray Wange6afd912022-10-27 12:11:18 +08002040#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Max Fillingercf007ca2024-10-29 16:57:09 +01002041int mbedtls_test_ssl_do_handshake_with_endpoints(
2042 mbedtls_test_ssl_endpoint *server_ep,
2043 mbedtls_test_ssl_endpoint *client_ep,
Max Fillinger8f12e312024-10-30 00:29:37 +01002044 mbedtls_test_handshake_test_options *options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002045 mbedtls_ssl_protocol_version proto)
2046{
2047 enum { BUFFSIZE = 1024 };
2048
2049 int ret = -1;
Max Fillingercf007ca2024-10-29 16:57:09 +01002050
Max Fillingeree467aa2024-11-08 22:17:33 +01002051 mbedtls_platform_zeroize(server_ep, sizeof(mbedtls_test_ssl_endpoint));
2052 mbedtls_platform_zeroize(client_ep, sizeof(mbedtls_test_ssl_endpoint));
2053
Max Fillinger8f12e312024-10-30 00:29:37 +01002054 mbedtls_test_init_handshake_options(options);
2055 options->server_min_version = proto;
2056 options->client_min_version = proto;
2057 options->server_max_version = proto;
2058 options->client_max_version = proto;
Max Fillingercf007ca2024-10-29 16:57:09 +01002059
Max Fillinger8f12e312024-10-30 00:29:37 +01002060 ret = mbedtls_test_ssl_endpoint_init(client_ep, MBEDTLS_SSL_IS_CLIENT, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002061 NULL, NULL, NULL);
2062 if (ret != 0) {
2063 return ret;
2064 }
Max Fillinger8f12e312024-10-30 00:29:37 +01002065 ret = mbedtls_test_ssl_endpoint_init(server_ep, MBEDTLS_SSL_IS_SERVER, options,
Max Fillingercf007ca2024-10-29 16:57:09 +01002066 NULL, NULL, NULL);
2067 if (ret != 0) {
2068 return ret;
2069 }
2070
2071 ret = mbedtls_test_mock_socket_connect(&client_ep->socket, &server_ep->socket, BUFFSIZE);
2072 if (ret != 0) {
2073 return ret;
2074 }
2075
Max Fillingerea1e7772024-10-30 00:49:10 +01002076 ret = mbedtls_test_move_handshake_to_state(&server_ep->ssl,
2077 &client_ep->ssl,
2078 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002079 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2080 return ret;
2081 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002082 ret = mbedtls_test_move_handshake_to_state(&client_ep->ssl,
2083 &server_ep->ssl,
2084 MBEDTLS_SSL_HANDSHAKE_OVER);
Max Fillingercf007ca2024-10-29 16:57:09 +01002085 if (ret != 0 && ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
2086 return ret;
2087 }
Max Fillingerea1e7772024-10-30 00:49:10 +01002088 if (!mbedtls_ssl_is_handshake_over(&client_ep->ssl) ||
2089 !mbedtls_ssl_is_handshake_over(&server_ep->ssl)) {
Max Fillingercf007ca2024-10-29 16:57:09 +01002090 return -1;
2091 }
2092
2093 return 0;
2094}
2095#endif /* defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED) */
2096
2097#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Yanray Wange6afd912022-10-27 12:11:18 +08002098void mbedtls_test_ssl_perform_handshake(
2099 mbedtls_test_handshake_test_options *options)
2100{
2101 /* forced_ciphersuite needs to last until the end of the handshake */
2102 int forced_ciphersuite[2];
2103 enum { BUFFSIZE = 17000 };
2104 mbedtls_test_ssl_endpoint client, server;
2105#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2106 const char *psk_identity = "foo";
2107#endif
Yanray Wange6afd912022-10-27 12:11:18 +08002108#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2109 unsigned char *context_buf = NULL;
2110 size_t context_buf_len;
2111#endif
2112#if defined(MBEDTLS_SSL_RENEGOTIATION)
2113 int ret = -1;
2114#endif
2115 int expected_handshake_result = options->expected_handshake_result;
2116
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002117 MD_OR_USE_PSA_INIT();
Yanray Wange6afd912022-10-27 12:11:18 +08002118 mbedtls_platform_zeroize(&client, sizeof(client));
2119 mbedtls_platform_zeroize(&server, sizeof(server));
2120 mbedtls_test_ssl_message_queue server_queue, client_queue;
2121 mbedtls_test_message_socket_context server_context, client_context;
2122 mbedtls_test_message_socket_init(&server_context);
2123 mbedtls_test_message_socket_init(&client_context);
2124
Ronald Cronec3408d2024-01-16 17:50:40 +01002125#if defined(MBEDTLS_DEBUG_C)
2126 if (options->cli_log_fun || options->srv_log_fun) {
2127 mbedtls_debug_set_threshold(4);
2128 }
2129#endif
2130
Yanray Wange6afd912022-10-27 12:11:18 +08002131 /* Client side */
2132 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002133 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2134 MBEDTLS_SSL_IS_CLIENT,
2135 options, &client_context,
2136 &client_queue,
2137 &server_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002138 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002139 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&client,
2140 MBEDTLS_SSL_IS_CLIENT,
2141 options, NULL, NULL,
2142 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002143 }
2144
Yanray Wange6afd912022-10-27 12:11:18 +08002145 if (strlen(options->cipher) > 0) {
2146 set_ciphersuite(&client.conf, options->cipher, forced_ciphersuite);
2147 }
2148
Yanray Wange6afd912022-10-27 12:11:18 +08002149 /* Server side */
2150 if (options->dtls != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002151 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2152 MBEDTLS_SSL_IS_SERVER,
2153 options, &server_context,
2154 &server_queue,
2155 &client_queue), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002156 } else {
Gilles Peskine353eb332025-05-14 17:42:53 +02002157 TEST_EQUAL(mbedtls_test_ssl_endpoint_init(&server,
2158 MBEDTLS_SSL_IS_SERVER,
2159 options, NULL, NULL,
2160 NULL), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002161 }
2162
2163 mbedtls_ssl_conf_authmode(&server.conf, options->srv_auth_mode);
2164
Yanray Wange6afd912022-10-27 12:11:18 +08002165#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine353eb332025-05-14 17:42:53 +02002166 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(server.conf),
2167 (unsigned char) options->mfl),
2168 0);
2169 TEST_EQUAL(mbedtls_ssl_conf_max_frag_len(&(client.conf),
2170 (unsigned char) options->mfl),
2171 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002172#else
Gilles Peskine353eb332025-05-14 17:42:53 +02002173 TEST_EQUAL(MBEDTLS_SSL_MAX_FRAG_LEN_NONE, options->mfl);
Yanray Wange6afd912022-10-27 12:11:18 +08002174#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2175
2176#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
2177 if (options->psk_str != NULL && options->psk_str->len > 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002178 TEST_EQUAL(mbedtls_ssl_conf_psk(
2179 &client.conf, options->psk_str->x,
2180 options->psk_str->len,
2181 (const unsigned char *) psk_identity,
2182 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002183
Gilles Peskine353eb332025-05-14 17:42:53 +02002184 TEST_EQUAL(mbedtls_ssl_conf_psk(
2185 &server.conf, options->psk_str->x,
2186 options->psk_str->len,
2187 (const unsigned char *) psk_identity,
2188 strlen(psk_identity)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002189#if defined(MBEDTLS_SSL_SRV_C)
2190 mbedtls_ssl_conf_psk_cb(&server.conf, psk_dummy_callback, NULL);
2191#endif
2192 }
2193#endif
2194#if defined(MBEDTLS_SSL_RENEGOTIATION)
2195 if (options->renegotiate) {
2196 mbedtls_ssl_conf_renegotiation(&(server.conf),
2197 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2198 mbedtls_ssl_conf_renegotiation(&(client.conf),
2199 MBEDTLS_SSL_RENEGOTIATION_ENABLED);
2200
2201 mbedtls_ssl_conf_legacy_renegotiation(&(server.conf),
2202 options->legacy_renegotiation);
2203 mbedtls_ssl_conf_legacy_renegotiation(&(client.conf),
2204 options->legacy_renegotiation);
2205 }
2206#endif /* MBEDTLS_SSL_RENEGOTIATION */
2207
Gilles Peskine353eb332025-05-14 17:42:53 +02002208 TEST_EQUAL(mbedtls_test_mock_socket_connect(&(client.socket),
2209 &(server.socket),
2210 BUFFSIZE), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002211
2212#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2213 if (options->resize_buffers != 0) {
2214 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002215 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2216 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
2217 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2218 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002219 }
2220#endif
2221
2222 if (options->expected_negotiated_version == MBEDTLS_SSL_VERSION_UNKNOWN) {
2223 expected_handshake_result = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
2224 }
2225
Gilles Peskine353eb332025-05-14 17:42:53 +02002226 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(client.ssl),
2227 &(server.ssl),
2228 MBEDTLS_SSL_HANDSHAKE_OVER),
2229 expected_handshake_result);
Yanray Wange6afd912022-10-27 12:11:18 +08002230
2231 if (expected_handshake_result != 0) {
2232 /* Connection will have failed by this point, skip to cleanup */
2233 goto exit;
2234 }
2235
Gilles Peskine353eb332025-05-14 17:42:53 +02002236 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&client.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002237
2238 /* Make sure server state is moved to HANDSHAKE_OVER also. */
2239 TEST_EQUAL(mbedtls_test_move_handshake_to_state(&(server.ssl),
2240 &(client.ssl),
2241 MBEDTLS_SSL_HANDSHAKE_OVER),
2242 0);
2243
Gilles Peskine353eb332025-05-14 17:42:53 +02002244 TEST_EQUAL(mbedtls_ssl_is_handshake_over(&server.ssl), 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002245 /* Check that both sides have negotiated the expected version. */
2246 mbedtls_test_set_step(0);
2247 if (!check_ssl_version(options->expected_negotiated_version,
2248 &client.ssl)) {
2249 goto exit;
2250 }
2251
2252 mbedtls_test_set_step(1);
2253 if (!check_ssl_version(options->expected_negotiated_version,
2254 &server.ssl)) {
2255 goto exit;
2256 }
2257
2258 if (options->expected_ciphersuite != 0) {
2259 TEST_EQUAL(server.ssl.session->ciphersuite,
2260 options->expected_ciphersuite);
2261 }
2262
2263#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2264 if (options->resize_buffers != 0) {
2265 /* A server, when using DTLS, might delay a buffer resize to happen
2266 * after it receives a message, so we force it. */
Gilles Peskine353eb332025-05-14 17:42:53 +02002267 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002268
Gilles Peskine353eb332025-05-14 17:42:53 +02002269 TEST_EQUAL(client.ssl.out_buf_len,
2270 mbedtls_ssl_get_output_buflen(&client.ssl));
2271 TEST_EQUAL(client.ssl.in_buf_len,
2272 mbedtls_ssl_get_input_buflen(&client.ssl));
2273 TEST_EQUAL(server.ssl.out_buf_len,
2274 mbedtls_ssl_get_output_buflen(&server.ssl));
2275 TEST_EQUAL(server.ssl.in_buf_len,
2276 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002277 }
2278#endif
2279
2280 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
2281 /* Start data exchanging test */
Gilles Peskine353eb332025-05-14 17:42:53 +02002282 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2283 &(client.ssl), options->cli_msg_len,
2284 options->expected_cli_fragments,
2285 &(server.ssl), options->srv_msg_len,
2286 options->expected_srv_fragments),
2287 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002288 }
2289#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2290 if (options->serialize == 1) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002291 TEST_EQUAL(options->dtls, 1);
Yanray Wange6afd912022-10-27 12:11:18 +08002292
Gilles Peskine353eb332025-05-14 17:42:53 +02002293 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), NULL,
2294 0, &context_buf_len),
2295 MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL);
Yanray Wange6afd912022-10-27 12:11:18 +08002296
2297 context_buf = mbedtls_calloc(1, context_buf_len);
2298 TEST_ASSERT(context_buf != NULL);
2299
Gilles Peskine353eb332025-05-14 17:42:53 +02002300 TEST_EQUAL(mbedtls_ssl_context_save(&(server.ssl), context_buf,
2301 context_buf_len,
2302 &context_buf_len),
2303 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002304
2305 mbedtls_ssl_free(&(server.ssl));
2306 mbedtls_ssl_init(&(server.ssl));
2307
Gilles Peskine353eb332025-05-14 17:42:53 +02002308 TEST_EQUAL(mbedtls_ssl_setup(&(server.ssl), &(server.conf)), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002309
2310 mbedtls_ssl_set_bio(&(server.ssl), &server_context,
2311 mbedtls_test_mock_tcp_send_msg,
2312 mbedtls_test_mock_tcp_recv_msg,
2313 NULL);
2314
2315 mbedtls_ssl_set_user_data_p(&server.ssl, &server);
2316
2317#if defined(MBEDTLS_TIMING_C)
Gilles Peskine0677e022025-05-27 18:05:20 +02002318 mbedtls_ssl_set_timer_cb(&server.ssl, &server.timer,
Yanray Wange6afd912022-10-27 12:11:18 +08002319 mbedtls_timing_set_delay,
2320 mbedtls_timing_get_delay);
2321#endif
2322#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2323 if (options->resize_buffers != 0) {
2324 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002325 TEST_EQUAL(server.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2326 TEST_EQUAL(server.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002327 }
2328#endif
Gilles Peskine353eb332025-05-14 17:42:53 +02002329 TEST_EQUAL(mbedtls_ssl_context_load(&(server.ssl), context_buf,
2330 context_buf_len), 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002331
2332#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2333 /* Validate buffer sizes after context deserialization */
2334 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002335 TEST_EQUAL(server.ssl.out_buf_len,
2336 mbedtls_ssl_get_output_buflen(&server.ssl));
2337 TEST_EQUAL(server.ssl.in_buf_len,
2338 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002339 }
2340#endif
2341 /* Retest writing/reading */
2342 if (options->cli_msg_len != 0 || options->srv_msg_len != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002343 TEST_EQUAL(mbedtls_test_ssl_exchange_data(
2344 &(client.ssl), options->cli_msg_len,
2345 options->expected_cli_fragments,
2346 &(server.ssl), options->srv_msg_len,
2347 options->expected_srv_fragments),
2348 0);
Yanray Wange6afd912022-10-27 12:11:18 +08002349 }
2350 }
2351#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
2352
2353#if defined(MBEDTLS_SSL_RENEGOTIATION)
2354 if (options->renegotiate) {
2355 /* Start test with renegotiation */
Gilles Peskine353eb332025-05-14 17:42:53 +02002356 TEST_EQUAL(server.ssl.renego_status,
2357 MBEDTLS_SSL_INITIAL_HANDSHAKE);
2358 TEST_EQUAL(client.ssl.renego_status,
2359 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002360
2361 /* After calling this function for the server, it only sends a handshake
2362 * request. All renegotiation should happen during data exchanging */
Gilles Peskine353eb332025-05-14 17:42:53 +02002363 TEST_EQUAL(mbedtls_ssl_renegotiate(&(server.ssl)), 0);
2364 TEST_EQUAL(server.ssl.renego_status,
2365 MBEDTLS_SSL_RENEGOTIATION_PENDING);
2366 TEST_EQUAL(client.ssl.renego_status,
2367 MBEDTLS_SSL_INITIAL_HANDSHAKE);
Yanray Wange6afd912022-10-27 12:11:18 +08002368
Gilles Peskine353eb332025-05-14 17:42:53 +02002369 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2370 TEST_EQUAL(server.ssl.renego_status,
2371 MBEDTLS_SSL_RENEGOTIATION_DONE);
2372 TEST_EQUAL(client.ssl.renego_status,
2373 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002374
2375 /* After calling mbedtls_ssl_renegotiate for the client,
2376 * all renegotiation should happen inside this function.
2377 * However in this test, we cannot perform simultaneous communication
2378 * between client and server so this function will return waiting error
2379 * on the socket. All rest of renegotiation should happen
2380 * during data exchanging */
2381 ret = mbedtls_ssl_renegotiate(&(client.ssl));
2382#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2383 if (options->resize_buffers != 0) {
2384 /* Ensure that the buffer sizes are appropriate before resizes */
Gilles Peskine353eb332025-05-14 17:42:53 +02002385 TEST_EQUAL(client.ssl.out_buf_len, MBEDTLS_SSL_OUT_BUFFER_LEN);
2386 TEST_EQUAL(client.ssl.in_buf_len, MBEDTLS_SSL_IN_BUFFER_LEN);
Yanray Wange6afd912022-10-27 12:11:18 +08002387 }
2388#endif
2389 TEST_ASSERT(ret == 0 ||
2390 ret == MBEDTLS_ERR_SSL_WANT_READ ||
2391 ret == MBEDTLS_ERR_SSL_WANT_WRITE);
Gilles Peskine353eb332025-05-14 17:42:53 +02002392 TEST_EQUAL(server.ssl.renego_status,
2393 MBEDTLS_SSL_RENEGOTIATION_DONE);
2394 TEST_EQUAL(client.ssl.renego_status,
2395 MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS);
Yanray Wange6afd912022-10-27 12:11:18 +08002396
Gilles Peskine353eb332025-05-14 17:42:53 +02002397 TEST_EQUAL(exchange_data(&(client.ssl), &(server.ssl)), 0);
2398 TEST_EQUAL(server.ssl.renego_status,
2399 MBEDTLS_SSL_RENEGOTIATION_DONE);
2400 TEST_EQUAL(client.ssl.renego_status,
2401 MBEDTLS_SSL_RENEGOTIATION_DONE);
Yanray Wange6afd912022-10-27 12:11:18 +08002402#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2403 /* Validate buffer sizes after renegotiation */
2404 if (options->resize_buffers != 0) {
Gilles Peskine353eb332025-05-14 17:42:53 +02002405 TEST_EQUAL(client.ssl.out_buf_len,
2406 mbedtls_ssl_get_output_buflen(&client.ssl));
2407 TEST_EQUAL(client.ssl.in_buf_len,
2408 mbedtls_ssl_get_input_buflen(&client.ssl));
2409 TEST_EQUAL(server.ssl.out_buf_len,
2410 mbedtls_ssl_get_output_buflen(&server.ssl));
2411 TEST_EQUAL(server.ssl.in_buf_len,
2412 mbedtls_ssl_get_input_buflen(&server.ssl));
Yanray Wange6afd912022-10-27 12:11:18 +08002413 }
2414#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
2415 }
2416#endif /* MBEDTLS_SSL_RENEGOTIATION */
2417
2418 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&client.conf) == &client);
2419 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&client.ssl) == &client);
2420 TEST_ASSERT(mbedtls_ssl_conf_get_user_data_p(&server.conf) == &server);
2421 TEST_ASSERT(mbedtls_ssl_get_user_data_p(&server.ssl) == &server);
2422
2423exit:
2424 mbedtls_test_ssl_endpoint_free(&client,
Yanray Wangaf727a22023-03-13 19:22:36 +08002425 options->dtls != 0 ? &client_context : NULL);
Yanray Wange6afd912022-10-27 12:11:18 +08002426 mbedtls_test_ssl_endpoint_free(&server,
Yanray Wangaf727a22023-03-13 19:22:36 +08002427 options->dtls != 0 ? &server_context : NULL);
Yanray Wange6afd912022-10-27 12:11:18 +08002428#if defined(MBEDTLS_DEBUG_C)
2429 if (options->cli_log_fun || options->srv_log_fun) {
2430 mbedtls_debug_set_threshold(0);
2431 }
2432#endif
2433#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
2434 if (context_buf != NULL) {
2435 mbedtls_free(context_buf);
2436 }
2437#endif
Manuel Pégourié-Gonnard23fc4372023-03-17 13:34:11 +01002438 MD_OR_USE_PSA_DONE();
Yanray Wange6afd912022-10-27 12:11:18 +08002439}
2440#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2441
2442#if defined(MBEDTLS_TEST_HOOKS)
Yanray Wangf56181a2023-03-16 12:21:33 +08002443int mbedtls_test_tweak_tls13_certificate_msg_vector_len(
Yanray Wange6afd912022-10-27 12:11:18 +08002444 unsigned char *buf, unsigned char **end, int tweak,
2445 int *expected_result, mbedtls_ssl_chk_buf_ptr_args *args)
2446{
2447/*
2448 * The definition of the tweaks assume that the certificate list contains only
2449 * one certificate.
2450 */
2451
2452/*
2453 * struct {
2454 * opaque cert_data<1..2^24-1>;
2455 * Extension extensions<0..2^16-1>;
2456 * } CertificateEntry;
2457 *
2458 * struct {
2459 * opaque certificate_request_context<0..2^8-1>;
2460 * CertificateEntry certificate_list<0..2^24-1>;
2461 * } Certificate;
2462 */
2463 unsigned char *p_certificate_request_context_len = buf;
2464 size_t certificate_request_context_len = buf[0];
2465
2466 unsigned char *p_certificate_list_len =
2467 buf + 1 + certificate_request_context_len;
2468 unsigned char *certificate_list = p_certificate_list_len + 3;
2469 size_t certificate_list_len =
2470 MBEDTLS_GET_UINT24_BE(p_certificate_list_len, 0);
2471
2472 unsigned char *p_cert_data_len = certificate_list;
2473 unsigned char *cert_data = p_cert_data_len + 3;
2474 size_t cert_data_len = MBEDTLS_GET_UINT24_BE(p_cert_data_len, 0);
2475
2476 unsigned char *p_extensions_len = cert_data + cert_data_len;
2477 unsigned char *extensions = p_extensions_len + 2;
2478 size_t extensions_len = MBEDTLS_GET_UINT16_BE(p_extensions_len, 0);
2479
2480 *expected_result = MBEDTLS_ERR_SSL_DECODE_ERROR;
2481
2482 switch (tweak) {
2483 case 1:
2484 /* Failure when checking if the certificate request context length
2485 * and certificate list length can be read
2486 */
2487 *end = buf + 3;
2488 set_chk_buf_ptr_args(args, buf, *end, 4);
2489 break;
2490
2491 case 2:
2492 /* Invalid certificate request context length.
2493 */
2494 *p_certificate_request_context_len =
Yanray Wanga8f445e2022-11-03 11:51:59 +08002495 (unsigned char) certificate_request_context_len + 1;
Yanray Wange6afd912022-10-27 12:11:18 +08002496 reset_chk_buf_ptr_args(args);
2497 break;
2498
2499 case 3:
2500 /* Failure when checking if certificate_list data can be read. */
2501 MBEDTLS_PUT_UINT24_BE(certificate_list_len + 1,
2502 p_certificate_list_len, 0);
2503 set_chk_buf_ptr_args(args, certificate_list, *end,
2504 certificate_list_len + 1);
2505 break;
2506
2507 case 4:
2508 /* Failure when checking if the cert_data length can be read. */
2509 MBEDTLS_PUT_UINT24_BE(2, p_certificate_list_len, 0);
2510 set_chk_buf_ptr_args(args, p_cert_data_len, certificate_list + 2, 3);
2511 break;
2512
2513 case 5:
2514 /* Failure when checking if cert_data data can be read. */
2515 MBEDTLS_PUT_UINT24_BE(certificate_list_len - 3 + 1,
2516 p_cert_data_len, 0);
2517 set_chk_buf_ptr_args(args, cert_data,
2518 certificate_list + certificate_list_len,
2519 certificate_list_len - 3 + 1);
2520 break;
2521
2522 case 6:
2523 /* Failure when checking if the extensions length can be read. */
2524 MBEDTLS_PUT_UINT24_BE(certificate_list_len - extensions_len - 1,
2525 p_certificate_list_len, 0);
2526 set_chk_buf_ptr_args(
2527 args, p_extensions_len,
2528 certificate_list + certificate_list_len - extensions_len - 1, 2);
2529 break;
2530
2531 case 7:
2532 /* Failure when checking if extensions data can be read. */
2533 MBEDTLS_PUT_UINT16_BE(extensions_len + 1, p_extensions_len, 0);
2534
2535 set_chk_buf_ptr_args(
2536 args, extensions,
2537 certificate_list + certificate_list_len, extensions_len + 1);
2538 break;
2539
2540 default:
2541 return -1;
2542 }
2543
2544 return 0;
2545}
2546#endif /* MBEDTLS_TEST_HOOKS */
Ronald Cron77abfe62024-01-15 11:17:31 +01002547
Ronald Cronfaf026c2024-01-31 14:32:06 +01002548/*
2549 * Functions for tests based on tickets. Implementations of the
2550 * write/parse ticket interfaces as defined by mbedtls_ssl_ticket_write/parse_t.
2551 * Basically same implementations as in ticket.c without the encryption. That
2552 * way we can tweak easily tickets characteristics to simulate misbehaving
2553 * peers.
2554 */
Ronald Cron77abfe62024-01-15 11:17:31 +01002555#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2556int mbedtls_test_ticket_write(
2557 void *p_ticket, const mbedtls_ssl_session *session,
2558 unsigned char *start, const unsigned char *end,
2559 size_t *tlen, uint32_t *lifetime)
2560{
2561 int ret;
2562 ((void) p_ticket);
2563
2564 if ((ret = mbedtls_ssl_session_save(session, start, end - start,
2565 tlen)) != 0) {
2566 return ret;
2567 }
2568
2569 /* Maximum ticket lifetime as defined in RFC 8446 */
2570 *lifetime = 7 * 24 * 3600;
2571
2572 return 0;
2573}
2574
2575int mbedtls_test_ticket_parse(void *p_ticket, mbedtls_ssl_session *session,
2576 unsigned char *buf, size_t len)
2577{
2578 ((void) p_ticket);
2579
2580 return mbedtls_ssl_session_load(session, buf, len);
2581}
2582#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002583
2584#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SRV_C) && \
2585 defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2586 defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2587int mbedtls_test_get_tls13_ticket(
2588 mbedtls_test_handshake_test_options *client_options,
2589 mbedtls_test_handshake_test_options *server_options,
2590 mbedtls_ssl_session *session)
2591{
2592 int ret = -1;
Gilles Peskine946bf142025-04-08 09:48:40 +02002593 int ok = 0;
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002594 unsigned char buf[64];
2595 mbedtls_test_ssl_endpoint client_ep, server_ep;
2596
2597 mbedtls_platform_zeroize(&client_ep, sizeof(client_ep));
2598 mbedtls_platform_zeroize(&server_ep, sizeof(server_ep));
2599
2600 ret = mbedtls_test_ssl_endpoint_init(&client_ep, MBEDTLS_SSL_IS_CLIENT,
2601 client_options, NULL, NULL, NULL);
2602 TEST_EQUAL(ret, 0);
2603
2604 ret = mbedtls_test_ssl_endpoint_init(&server_ep, MBEDTLS_SSL_IS_SERVER,
2605 server_options, NULL, NULL, NULL);
2606 TEST_EQUAL(ret, 0);
2607
2608 mbedtls_ssl_conf_session_tickets_cb(&server_ep.conf,
2609 mbedtls_test_ticket_write,
2610 mbedtls_test_ticket_parse,
2611 NULL);
2612
2613 ret = mbedtls_test_mock_socket_connect(&(client_ep.socket),
2614 &(server_ep.socket), 1024);
2615 TEST_EQUAL(ret, 0);
2616
2617 TEST_EQUAL(mbedtls_test_move_handshake_to_state(
2618 &(server_ep.ssl), &(client_ep.ssl),
2619 MBEDTLS_SSL_HANDSHAKE_OVER), 0);
2620
2621 TEST_EQUAL(server_ep.ssl.handshake->new_session_tickets_count, 0);
2622
2623 do {
2624 ret = mbedtls_ssl_read(&(client_ep.ssl), buf, sizeof(buf));
2625 } while (ret != MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET);
2626
2627 ret = mbedtls_ssl_get_session(&(client_ep.ssl), session);
2628 TEST_EQUAL(ret, 0);
2629
Gilles Peskine946bf142025-04-08 09:48:40 +02002630 ok = 1;
2631
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002632exit:
2633 mbedtls_test_ssl_endpoint_free(&client_ep, NULL);
2634 mbedtls_test_ssl_endpoint_free(&server_ep, NULL);
2635
Gilles Peskine946bf142025-04-08 09:48:40 +02002636 if (ret == 0 && !ok) {
2637 /* Exiting due to a test assertion that isn't ret == 0 */
2638 ret = -1;
2639 }
Ronald Cron1f6e4e42024-01-26 16:31:33 +01002640 return ret;
2641}
2642#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SRV_C &&
2643 MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS &&
2644 MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
2645
Yanray Wang4d07d1c2022-10-27 15:28:16 +08002646#endif /* MBEDTLS_SSL_TLS_C */