2 * Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include <openssl/bio.h>
12 #include <openssl/crypto.h>
13 #include <openssl/ssl.h>
14 #include <openssl/err.h>
16 #include "helpers/ssltestlib.h"
19 static char *cert = NULL;
20 static char *privkey = NULL;
21 static unsigned int timer_cb_count;
26 #define DUMMY_CERT_STATUS_LEN 12
28 static unsigned char certstatus[] = {
29 SSL3_RT_HANDSHAKE, /* Content type */
30 0xfe, 0xfd, /* Record version */
32 0, 0, 0, 0, 0, 0x0f, /* Record sequence number */
33 0, DTLS1_HM_HEADER_LENGTH + DUMMY_CERT_STATUS_LEN - 2,
34 SSL3_MT_CERTIFICATE_STATUS, /* Cert Status handshake message type */
35 0, 0, DUMMY_CERT_STATUS_LEN, /* Message len */
36 0, 5, /* Message sequence */
37 0, 0, 0, /* Fragment offset */
38 0, 0, DUMMY_CERT_STATUS_LEN - 2, /* Fragment len */
39 0x80, 0x80, 0x80, 0x80, 0x80,
40 0x80, 0x80, 0x80, 0x80, 0x80 /* Dummy data */
43 #define RECORD_SEQUENCE 10
45 static const char dummy_cookie[] = "0123456";
47 static int generate_cookie_cb(SSL *ssl, unsigned char *cookie,
48 unsigned int *cookie_len)
50 memcpy(cookie, dummy_cookie, sizeof(dummy_cookie));
51 *cookie_len = sizeof(dummy_cookie);
55 static int verify_cookie_cb(SSL *ssl, const unsigned char *cookie,
56 unsigned int cookie_len)
58 return TEST_mem_eq(cookie, cookie_len, dummy_cookie, sizeof(dummy_cookie));
61 static unsigned int timer_cb(SSL *s, unsigned int timer_us)
71 static int test_dtls_unprocessed(int testidx)
73 SSL_CTX *sctx = NULL, *cctx = NULL;
74 SSL *serverssl1 = NULL, *clientssl1 = NULL;
75 BIO *c_to_s_fbio, *c_to_s_mempacket;
80 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
83 &sctx, &cctx, cert, privkey)))
86 #ifndef OPENSSL_NO_DTLS1_2
87 if (!TEST_true(SSL_CTX_set_cipher_list(cctx, "AES128-SHA")))
90 /* Default sigalgs are SHA1 based in <DTLS1.2 which is in security level 0 */
91 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "AES128-SHA:@SECLEVEL=0"))
92 || !TEST_true(SSL_CTX_set_cipher_list(cctx,
93 "AES128-SHA:@SECLEVEL=0")))
97 c_to_s_fbio = BIO_new(bio_f_tls_dump_filter());
98 if (!TEST_ptr(c_to_s_fbio))
101 /* BIO is freed by create_ssl_connection on error */
102 if (!TEST_true(create_ssl_objects(sctx, cctx, &serverssl1, &clientssl1,
106 DTLS_set_timer_cb(clientssl1, timer_cb);
109 certstatus[RECORD_SEQUENCE] = 0xff;
112 * Inject a dummy record from the next epoch. In test 0, this should never
113 * get used because the message sequence number is too big. In test 1 we set
114 * the record sequence number to be way off in the future.
116 c_to_s_mempacket = SSL_get_wbio(clientssl1);
117 c_to_s_mempacket = BIO_next(c_to_s_mempacket);
118 mempacket_test_inject(c_to_s_mempacket, (char *)certstatus,
119 sizeof(certstatus), 1, INJECT_PACKET_IGNORE_REC_SEQ);
122 * Create the connection. We use "create_bare_ssl_connection" here so that
123 * we can force the connection to not do "SSL_read" once partly connected.
124 * We don't want to accidentally read the dummy records we injected because
125 * they will fail to decrypt.
127 if (!TEST_true(create_bare_ssl_connection(serverssl1, clientssl1,
128 SSL_ERROR_NONE, 0, 0)))
131 if (timer_cb_count == 0) {
132 printf("timer_callback was not called.\n");
138 SSL_free(serverssl1);
139 SSL_free(clientssl1);
146 /* One record for the cookieless initial ClientHello */
147 #define CLI_TO_SRV_COOKIE_EXCH 1
150 * In a resumption handshake we use 2 records for the initial ClientHello in
151 * this test because we are using a very small MTU and the ClientHello is
152 * bigger than in the non resumption case.
154 #define CLI_TO_SRV_RESUME_COOKIE_EXCH 2
155 #define SRV_TO_CLI_COOKIE_EXCH 1
157 #define CLI_TO_SRV_EPOCH_0_RECS 3
158 #define CLI_TO_SRV_EPOCH_1_RECS 1
159 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
160 # define SRV_TO_CLI_EPOCH_0_RECS 10
163 * In this case we have no ServerKeyExchange message, because we don't have
164 * ECDHE or DHE. When it is present it gets fragmented into 3 records in this
167 # define SRV_TO_CLI_EPOCH_0_RECS 9
169 #define SRV_TO_CLI_EPOCH_1_RECS 1
170 #define TOTAL_FULL_HAND_RECORDS \
171 (CLI_TO_SRV_COOKIE_EXCH + SRV_TO_CLI_COOKIE_EXCH + \
172 CLI_TO_SRV_EPOCH_0_RECS + CLI_TO_SRV_EPOCH_1_RECS + \
173 SRV_TO_CLI_EPOCH_0_RECS + SRV_TO_CLI_EPOCH_1_RECS)
175 #define CLI_TO_SRV_RESUME_EPOCH_0_RECS 3
176 #define CLI_TO_SRV_RESUME_EPOCH_1_RECS 1
177 #define SRV_TO_CLI_RESUME_EPOCH_0_RECS 2
178 #define SRV_TO_CLI_RESUME_EPOCH_1_RECS 1
179 #define TOTAL_RESUME_HAND_RECORDS \
180 (CLI_TO_SRV_RESUME_COOKIE_EXCH + SRV_TO_CLI_COOKIE_EXCH + \
181 CLI_TO_SRV_RESUME_EPOCH_0_RECS + CLI_TO_SRV_RESUME_EPOCH_1_RECS + \
182 SRV_TO_CLI_RESUME_EPOCH_0_RECS + SRV_TO_CLI_RESUME_EPOCH_1_RECS)
184 #define TOTAL_RECORDS (TOTAL_FULL_HAND_RECORDS + TOTAL_RESUME_HAND_RECORDS)
187 * We are assuming a ServerKeyExchange message is sent in this test. If we don't
188 * have either DH or EC, then it won't be
190 #if !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_EC)
191 static int test_dtls_drop_records(int idx)
193 SSL_CTX *sctx = NULL, *cctx = NULL;
194 SSL *serverssl = NULL, *clientssl = NULL;
195 BIO *c_to_s_fbio, *mempackbio;
198 SSL_SESSION *sess = NULL;
199 int cli_to_srv_cookie, cli_to_srv_epoch0, cli_to_srv_epoch1;
200 int srv_to_cli_epoch0;
202 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
203 DTLS_client_method(),
205 &sctx, &cctx, cert, privkey)))
208 #ifdef OPENSSL_NO_DTLS1_2
209 /* Default sigalgs are SHA1 based in <DTLS1.2 which is in security level 0 */
210 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "DEFAULT:@SECLEVEL=0"))
211 || !TEST_true(SSL_CTX_set_cipher_list(cctx,
212 "DEFAULT:@SECLEVEL=0")))
216 if (!TEST_true(SSL_CTX_set_dh_auto(sctx, 1)))
219 SSL_CTX_set_options(sctx, SSL_OP_COOKIE_EXCHANGE);
220 SSL_CTX_set_cookie_generate_cb(sctx, generate_cookie_cb);
221 SSL_CTX_set_cookie_verify_cb(sctx, verify_cookie_cb);
223 if (idx >= TOTAL_FULL_HAND_RECORDS) {
224 /* We're going to do a resumption handshake. Get a session first. */
225 if (!TEST_true(create_ssl_objects(sctx, cctx, &serverssl, &clientssl,
227 || !TEST_true(create_ssl_connection(serverssl, clientssl,
229 || !TEST_ptr(sess = SSL_get1_session(clientssl)))
232 SSL_shutdown(clientssl);
233 SSL_shutdown(serverssl);
236 serverssl = clientssl = NULL;
238 cli_to_srv_epoch0 = CLI_TO_SRV_RESUME_EPOCH_0_RECS;
239 cli_to_srv_epoch1 = CLI_TO_SRV_RESUME_EPOCH_1_RECS;
240 srv_to_cli_epoch0 = SRV_TO_CLI_RESUME_EPOCH_0_RECS;
241 cli_to_srv_cookie = CLI_TO_SRV_RESUME_COOKIE_EXCH;
242 idx -= TOTAL_FULL_HAND_RECORDS;
244 cli_to_srv_epoch0 = CLI_TO_SRV_EPOCH_0_RECS;
245 cli_to_srv_epoch1 = CLI_TO_SRV_EPOCH_1_RECS;
246 srv_to_cli_epoch0 = SRV_TO_CLI_EPOCH_0_RECS;
247 cli_to_srv_cookie = CLI_TO_SRV_COOKIE_EXCH;
250 c_to_s_fbio = BIO_new(bio_f_tls_dump_filter());
251 if (!TEST_ptr(c_to_s_fbio))
254 /* BIO is freed by create_ssl_connection on error */
255 if (!TEST_true(create_ssl_objects(sctx, cctx, &serverssl, &clientssl,
260 if (!TEST_true(SSL_set_session(clientssl, sess)))
264 DTLS_set_timer_cb(clientssl, timer_cb);
265 DTLS_set_timer_cb(serverssl, timer_cb);
267 /* Work out which record to drop based on the test number */
268 if (idx >= cli_to_srv_cookie + cli_to_srv_epoch0 + cli_to_srv_epoch1) {
269 mempackbio = SSL_get_wbio(serverssl);
270 idx -= cli_to_srv_cookie + cli_to_srv_epoch0 + cli_to_srv_epoch1;
271 if (idx >= SRV_TO_CLI_COOKIE_EXCH + srv_to_cli_epoch0) {
273 idx -= SRV_TO_CLI_COOKIE_EXCH + srv_to_cli_epoch0;
276 mempackbio = SSL_get_wbio(clientssl);
277 if (idx >= cli_to_srv_cookie + cli_to_srv_epoch0) {
279 idx -= cli_to_srv_cookie + cli_to_srv_epoch0;
281 mempackbio = BIO_next(mempackbio);
283 BIO_ctrl(mempackbio, MEMPACKET_CTRL_SET_DROP_EPOCH, epoch, NULL);
284 BIO_ctrl(mempackbio, MEMPACKET_CTRL_SET_DROP_REC, idx, NULL);
286 if (!TEST_true(create_ssl_connection(serverssl, clientssl, SSL_ERROR_NONE)))
289 if (sess != NULL && !TEST_true(SSL_session_reused(clientssl)))
292 /* If the test did what we planned then it should have dropped a record */
293 if (!TEST_int_eq((int)BIO_ctrl(mempackbio, MEMPACKET_CTRL_GET_DROP_REC, 0,
299 SSL_SESSION_free(sess);
307 #endif /* !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_EC) */
309 static int test_cookie(void)
311 SSL_CTX *sctx = NULL, *cctx = NULL;
312 SSL *serverssl = NULL, *clientssl = NULL;
315 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
316 DTLS_client_method(),
318 &sctx, &cctx, cert, privkey)))
321 SSL_CTX_set_options(sctx, SSL_OP_COOKIE_EXCHANGE);
322 SSL_CTX_set_cookie_generate_cb(sctx, generate_cookie_cb);
323 SSL_CTX_set_cookie_verify_cb(sctx, verify_cookie_cb);
325 #ifdef OPENSSL_NO_DTLS1_2
326 /* Default sigalgs are SHA1 based in <DTLS1.2 which is in security level 0 */
327 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "DEFAULT:@SECLEVEL=0"))
328 || !TEST_true(SSL_CTX_set_cipher_list(cctx,
329 "DEFAULT:@SECLEVEL=0")))
333 if (!TEST_true(create_ssl_objects(sctx, cctx, &serverssl, &clientssl,
335 || !TEST_true(create_ssl_connection(serverssl, clientssl,
349 static int test_dtls_duplicate_records(void)
351 SSL_CTX *sctx = NULL, *cctx = NULL;
352 SSL *serverssl = NULL, *clientssl = NULL;
355 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
356 DTLS_client_method(),
358 &sctx, &cctx, cert, privkey)))
361 #ifdef OPENSSL_NO_DTLS1_2
362 /* Default sigalgs are SHA1 based in <DTLS1.2 which is in security level 0 */
363 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "DEFAULT:@SECLEVEL=0"))
364 || !TEST_true(SSL_CTX_set_cipher_list(cctx,
365 "DEFAULT:@SECLEVEL=0")))
369 if (!TEST_true(create_ssl_objects(sctx, cctx, &serverssl, &clientssl,
373 DTLS_set_timer_cb(clientssl, timer_cb);
374 DTLS_set_timer_cb(serverssl, timer_cb);
376 BIO_ctrl(SSL_get_wbio(clientssl), MEMPACKET_CTRL_SET_DUPLICATE_REC, 1, NULL);
377 BIO_ctrl(SSL_get_wbio(serverssl), MEMPACKET_CTRL_SET_DUPLICATE_REC, 1, NULL);
379 if (!TEST_true(create_ssl_connection(serverssl, clientssl, SSL_ERROR_NONE)))
393 * Test just sending a Finished message as the first message. Should fail due
394 * to an unexpected message.
396 static int test_just_finished(void)
398 int testresult = 0, ret;
399 SSL_CTX *sctx = NULL;
400 SSL *serverssl = NULL;
401 BIO *rbio = NULL, *wbio = NULL, *sbio = NULL;
402 unsigned char buf[] = {
404 SSL3_RT_HANDSHAKE, /* content type */
405 (DTLS1_2_VERSION >> 8) & 0xff, /* protocol version hi byte */
406 DTLS1_2_VERSION & 0xff, /* protocol version lo byte */
408 0, 0, 0, 0, 0, 0, /* record sequence */
409 0, DTLS1_HM_HEADER_LENGTH + SHA_DIGEST_LENGTH, /* record length */
412 SSL3_MT_FINISHED, /* message type */
413 0, 0, SHA_DIGEST_LENGTH, /* message length */
414 0, 0, /* message sequence */
415 0, 0, 0, /* fragment offset */
416 0, 0, SHA_DIGEST_LENGTH, /* fragment length */
419 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
423 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
425 &sctx, NULL, cert, privkey)))
428 #ifdef OPENSSL_NO_DTLS1_2
429 /* DTLSv1 is not allowed at the default security level */
430 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "DEFAULT:@SECLEVEL=0")))
434 serverssl = SSL_new(sctx);
435 rbio = BIO_new(BIO_s_mem());
436 wbio = BIO_new(BIO_s_mem());
438 if (!TEST_ptr(serverssl) || !TEST_ptr(rbio) || !TEST_ptr(wbio))
442 SSL_set0_rbio(serverssl, rbio);
443 SSL_set0_wbio(serverssl, wbio);
445 DTLS_set_timer_cb(serverssl, timer_cb);
447 if (!TEST_int_eq(BIO_write(sbio, buf, sizeof(buf)), sizeof(buf)))
450 /* We expect the attempt to process the message to fail */
451 if (!TEST_int_le(ret = SSL_accept(serverssl), 0))
454 /* Check that we got the error we were expecting */
455 if (!TEST_int_eq(SSL_get_error(serverssl, ret), SSL_ERROR_SSL))
458 if (!TEST_int_eq(ERR_GET_REASON(ERR_get_error()), SSL_R_UNEXPECTED_MESSAGE))
472 * Test that swapping later records before Finished or CCS still works
473 * Test 0: Test receiving a handshake record early from next epoch on server side
474 * Test 1: Test receiving a handshake record early from next epoch on client side
475 * Test 2: Test receiving an app data record early from next epoch on client side
476 * Test 3: Test receiving an app data before Finished on client side
478 static int test_swap_records(int idx)
480 SSL_CTX *sctx = NULL, *cctx = NULL;
481 SSL *sssl = NULL, *cssl = NULL;
484 char msg[] = { 0x00, 0x01, 0x02, 0x03 };
487 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
488 DTLS_client_method(),
490 &sctx, &cctx, cert, privkey)))
493 #ifndef OPENSSL_NO_DTLS1_2
494 if (!TEST_true(SSL_CTX_set_cipher_list(cctx, "AES128-SHA")))
497 /* Default sigalgs are SHA1 based in <DTLS1.2 which is in security level 0 */
498 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "AES128-SHA:@SECLEVEL=0"))
499 || !TEST_true(SSL_CTX_set_cipher_list(cctx,
500 "AES128-SHA:@SECLEVEL=0")))
504 if (!TEST_true(create_ssl_objects(sctx, cctx, &sssl, &cssl,
508 /* Send flight 1: ClientHello */
509 if (!TEST_int_le(SSL_connect(cssl), 0))
512 /* Recv flight 1, send flight 2: ServerHello, Certificate, ServerHelloDone */
513 if (!TEST_int_le(SSL_accept(sssl), 0))
516 /* Recv flight 2, send flight 3: ClientKeyExchange, CCS, Finished */
517 if (!TEST_int_le(SSL_connect(cssl), 0))
521 /* Swap Finished and CCS within the datagram */
522 bio = SSL_get_wbio(cssl);
524 || !TEST_true(mempacket_swap_epoch(bio)))
528 /* Recv flight 3, send flight 4: datagram 0(NST, CCS) datagram 1(Finished) */
529 if (!TEST_int_gt(SSL_accept(sssl), 0))
532 /* Send flight 4 (cont'd): datagram 2(app data) */
533 if (!TEST_int_eq(SSL_write(sssl, msg, sizeof(msg)), (int)sizeof(msg)))
536 bio = SSL_get_wbio(sssl);
540 /* Finished comes before NST/CCS */
541 if (!TEST_true(mempacket_move_packet(bio, 0, 1)))
543 } else if (idx == 2) {
544 /* App data comes before NST/CCS */
545 if (!TEST_true(mempacket_move_packet(bio, 0, 2)))
547 } else if (idx == 3) {
548 /* App data comes before Finished */
549 bio = SSL_get_wbio(sssl);
550 if (!TEST_true(mempacket_move_packet(bio, 1, 2)))
555 * Recv flight 4 (datagram 1): NST, CCS, + flight 5: app data
556 * + flight 4 (datagram 2): Finished
558 if (!TEST_int_gt(SSL_connect(cssl), 0))
561 if (idx == 0 || idx == 1) {
562 /* App data was not received early, so it should not be pending */
563 if (!TEST_int_eq(SSL_pending(cssl), 0)
564 || !TEST_false(SSL_has_pending(cssl)))
568 /* We received the app data early so it should be buffered already */
569 if (!TEST_int_eq(SSL_pending(cssl), (int)sizeof(msg))
570 || !TEST_true(SSL_has_pending(cssl)))
575 * Recv flight 5 (app data)
577 if (!TEST_int_eq(SSL_read(cssl, buf, sizeof(buf)), (int)sizeof(msg)))
590 /* Confirm that we can create a connections using DTLSv1_listen() */
591 static int test_listen(void)
593 SSL_CTX *sctx = NULL, *cctx = NULL;
594 SSL *serverssl = NULL, *clientssl = NULL;
597 if (!TEST_true(create_ssl_ctx_pair(NULL, DTLS_server_method(),
598 DTLS_client_method(),
600 &sctx, &cctx, cert, privkey)))
603 #ifdef OPENSSL_NO_DTLS1_2
604 /* Default sigalgs are SHA1 based in <DTLS1.2 which is in security level 0 */
605 if (!TEST_true(SSL_CTX_set_cipher_list(sctx, "DEFAULT:@SECLEVEL=0"))
606 || !TEST_true(SSL_CTX_set_cipher_list(cctx,
607 "DEFAULT:@SECLEVEL=0")))
611 SSL_CTX_set_cookie_generate_cb(sctx, generate_cookie_cb);
612 SSL_CTX_set_cookie_verify_cb(sctx, verify_cookie_cb);
614 if (!TEST_true(create_ssl_objects(sctx, cctx, &serverssl, &clientssl,
618 DTLS_set_timer_cb(clientssl, timer_cb);
619 DTLS_set_timer_cb(serverssl, timer_cb);
622 * The last parameter to create_bare_ssl_connection() requests that
623 * DTLSv1_listen() is used.
625 if (!TEST_true(create_bare_ssl_connection(serverssl, clientssl,
626 SSL_ERROR_NONE, 1, 1)))
639 OPT_TEST_DECLARE_USAGE("certfile privkeyfile\n")
641 int setup_tests(void)
643 if (!test_skip_common_options()) {
644 TEST_error("Error parsing test options\n");
648 if (!TEST_ptr(cert = test_get_argument(0))
649 || !TEST_ptr(privkey = test_get_argument(1)))
652 ADD_ALL_TESTS(test_dtls_unprocessed, NUM_TESTS);
653 #if !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_EC)
654 ADD_ALL_TESTS(test_dtls_drop_records, TOTAL_RECORDS);
656 ADD_TEST(test_cookie);
657 ADD_TEST(test_dtls_duplicate_records);
658 ADD_TEST(test_just_finished);
659 ADD_ALL_TESTS(test_swap_records, 4);
660 ADD_TEST(test_listen);
665 void cleanup_tests(void)
667 bio_f_tls_dump_filter_free();
668 bio_s_mempacket_test_free();