2 * Copyright 2017-2024 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
10 #include <openssl/ssl.h>
12 #include "helpers/ssltestlib.h"
14 #include "internal/packet.h"
16 static char *cert
= NULL
;
17 static char *privkey
= NULL
;
19 static BIO
*s_to_c_fbio
= NULL
, *c_to_s_fbio
= NULL
;
20 static int chseen
= 0, shseen
= 0, sccsseen
= 0, ccsaftersh
= 0;
21 static int ccsbeforesh
= 0, sappdataseen
= 0, cappdataseen
= 0, badccs
= 0;
22 static int badvers
= 0, badsessid
= 0;
24 static unsigned char chsessid
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
25 static size_t chsessidlen
= 0;
27 static int watchccs_new(BIO
*bi
);
28 static int watchccs_free(BIO
*a
);
29 static int watchccs_read(BIO
*b
, char *out
, int outl
);
30 static int watchccs_write(BIO
*b
, const char *in
, int inl
);
31 static long watchccs_ctrl(BIO
*b
, int cmd
, long num
, void *ptr
);
32 static int watchccs_gets(BIO
*bp
, char *buf
, int size
);
33 static int watchccs_puts(BIO
*bp
, const char *str
);
35 /* Choose a sufficiently large type likely to be unused for this custom BIO */
36 # define BIO_TYPE_WATCHCCS_FILTER (0x80 | BIO_TYPE_FILTER)
38 static BIO_METHOD
*method_watchccs
= NULL
;
40 static const BIO_METHOD
*bio_f_watchccs_filter(void)
42 if (method_watchccs
== NULL
) {
43 method_watchccs
= BIO_meth_new(BIO_TYPE_WATCHCCS_FILTER
,
45 if (method_watchccs
== NULL
46 || !BIO_meth_set_write(method_watchccs
, watchccs_write
)
47 || !BIO_meth_set_read(method_watchccs
, watchccs_read
)
48 || !BIO_meth_set_puts(method_watchccs
, watchccs_puts
)
49 || !BIO_meth_set_gets(method_watchccs
, watchccs_gets
)
50 || !BIO_meth_set_ctrl(method_watchccs
, watchccs_ctrl
)
51 || !BIO_meth_set_create(method_watchccs
, watchccs_new
)
52 || !BIO_meth_set_destroy(method_watchccs
, watchccs_free
))
55 return method_watchccs
;
58 static int watchccs_new(BIO
*bio
)
64 static int watchccs_free(BIO
*bio
)
70 static int watchccs_read(BIO
*bio
, char *out
, int outl
)
73 BIO
*next
= BIO_next(bio
);
80 BIO_clear_retry_flags(bio
);
82 ret
= BIO_read(next
, out
, outl
);
83 if (ret
<= 0 && BIO_should_read(next
))
84 BIO_set_retry_read(bio
);
89 static int watchccs_write(BIO
*bio
, const char *in
, int inl
)
92 BIO
*next
= BIO_next(bio
);
93 PACKET pkt
, msg
, msgbody
, sessionid
;
94 unsigned int rectype
, recvers
, msgtype
, expectedrecvers
;
101 BIO_clear_retry_flags(bio
);
103 if (!PACKET_buf_init(&pkt
, (const unsigned char *)in
, inl
))
106 /* We assume that we always write complete records each time */
107 while (PACKET_remaining(&pkt
)) {
108 if (!PACKET_get_1(&pkt
, &rectype
)
109 || !PACKET_get_net_2(&pkt
, &recvers
)
110 || !PACKET_get_length_prefixed_2(&pkt
, &msg
))
113 expectedrecvers
= TLS1_2_VERSION
;
115 if (rectype
== SSL3_RT_HANDSHAKE
) {
116 if (!PACKET_get_1(&msg
, &msgtype
)
117 || !PACKET_get_length_prefixed_3(&msg
, &msgbody
))
119 if (msgtype
== SSL3_MT_CLIENT_HELLO
) {
123 * Skip legacy_version (2 bytes) and Random (32 bytes) to read
126 if (!PACKET_forward(&msgbody
, 34)
127 || !PACKET_get_length_prefixed_1(&msgbody
, &sessionid
))
131 expectedrecvers
= TLS1_VERSION
;
133 /* Save the session id for later */
134 chsessidlen
= PACKET_remaining(&sessionid
);
135 if (!PACKET_copy_bytes(&sessionid
, chsessid
, chsessidlen
))
139 * Check the session id for the second ClientHello is the
140 * same as the first one.
142 if (PACKET_remaining(&sessionid
) != chsessidlen
144 && memcmp(chsessid
, PACKET_data(&sessionid
),
148 } else if (msgtype
== SSL3_MT_SERVER_HELLO
) {
151 * Skip legacy_version (2 bytes) and Random (32 bytes) to read
154 if (!PACKET_forward(&msgbody
, 34)
155 || !PACKET_get_length_prefixed_1(&msgbody
, &sessionid
))
159 * Check the session id is the same as the one in the
162 if (PACKET_remaining(&sessionid
) != chsessidlen
164 && memcmp(chsessid
, PACKET_data(&sessionid
),
168 } else if (rectype
== SSL3_RT_CHANGE_CIPHER_SPEC
) {
169 if (bio
== s_to_c_fbio
) {
171 * Server writing. We shouldn't have written any app data
172 * yet, and we should have seen both the ClientHello and the
182 } else if (!cappdataseen
) {
184 * Client writing. We shouldn't have written any app data
185 * yet, and we should have seen the ClientHello
187 if (shseen
== 1 && !ccsaftersh
)
189 else if (shseen
== 0 && !ccsbeforesh
)
196 } else if (rectype
== SSL3_RT_APPLICATION_DATA
) {
197 if (bio
== s_to_c_fbio
)
202 if (recvers
!= expectedrecvers
)
206 ret
= BIO_write(next
, in
, inl
);
207 if (ret
<= 0 && BIO_should_write(next
))
208 BIO_set_retry_write(bio
);
213 static long watchccs_ctrl(BIO
*bio
, int cmd
, long num
, void *ptr
)
216 BIO
*next
= BIO_next(bio
);
226 ret
= BIO_ctrl(next
, cmd
, num
, ptr
);
232 static int watchccs_gets(BIO
*bio
, char *buf
, int size
)
234 /* We don't support this - not needed anyway */
238 static int watchccs_puts(BIO
*bio
, const char *str
)
240 return watchccs_write(bio
, str
, strlen(str
));
243 static int test_tls13ccs(int tst
)
245 SSL_CTX
*sctx
= NULL
, *cctx
= NULL
;
246 SSL
*sssl
= NULL
, *cssl
= NULL
;
248 const char msg
[] = "Dummy data";
250 size_t written
, readbytes
;
251 SSL_SESSION
*sess
= NULL
;
253 chseen
= shseen
= sccsseen
= ccsaftersh
= ccsbeforesh
= 0;
254 sappdataseen
= cappdataseen
= badccs
= badvers
= badsessid
= 0;
257 if (!TEST_true(create_ssl_ctx_pair(NULL
, TLS_server_method(),
258 TLS_client_method(), TLS1_VERSION
, 0,
259 &sctx
, &cctx
, cert
, privkey
))
260 || !TEST_true(SSL_CTX_set_max_early_data(sctx
,
261 SSL3_RT_MAX_PLAIN_LENGTH
)))
265 * Test 0: Simple Handshake
266 * Test 1: Simple Handshake, client middlebox compat mode disabled
267 * Test 2: Simple Handshake, server middlebox compat mode disabled
268 * Test 3: HRR Handshake
269 * Test 4: HRR Handshake, client middlebox compat mode disabled
270 * Test 5: HRR Handshake, server middlebox compat mode disabled
271 * Test 6: Early data handshake
272 * Test 7: Early data handshake, client middlebox compat mode disabled
273 * Test 8: Early data handshake, server middlebox compat mode disabled
274 * Test 9: Early data then HRR
275 * Test 10: Early data then HRR, client middlebox compat mode disabled
276 * Test 11: Early data then HRR, server middlebox compat mode disabled
288 SSL_CTX_clear_options(cctx
, SSL_OP_ENABLE_MIDDLEBOX_COMPAT
);
294 SSL_CTX_clear_options(sctx
, SSL_OP_ENABLE_MIDDLEBOX_COMPAT
);
297 TEST_error("Invalid test value");
302 /* Get a session suitable for early_data */
303 if (!TEST_true(create_ssl_objects(sctx
, cctx
, &sssl
, &cssl
, NULL
, NULL
))
304 || !TEST_true(create_ssl_connection(sssl
, cssl
, SSL_ERROR_NONE
)))
306 sess
= SSL_get1_session(cssl
);
316 if ((tst
>= 3 && tst
<= 5) || tst
>= 9) {
318 #if defined(OPENSSL_NO_EC)
319 # if !defined(OPENSSL_NO_DH)
320 if (!TEST_true(SSL_CTX_set1_groups_list(sctx
, "ffdhe3072")))
324 if (!TEST_true(SSL_CTX_set1_groups_list(sctx
, "P-384")))
329 s_to_c_fbio
= BIO_new(bio_f_watchccs_filter());
330 c_to_s_fbio
= BIO_new(bio_f_watchccs_filter());
331 if (!TEST_ptr(s_to_c_fbio
)
332 || !TEST_ptr(c_to_s_fbio
)) {
333 BIO_free(s_to_c_fbio
);
334 BIO_free(c_to_s_fbio
);
338 /* BIOs get freed on error */
339 if (!TEST_true(create_ssl_objects(sctx
, cctx
, &sssl
, &cssl
, s_to_c_fbio
,
345 if (!TEST_true(SSL_set_session(cssl
, sess
))
346 || !TEST_true(SSL_write_early_data(cssl
, msg
, strlen(msg
),
349 && !TEST_int_eq(SSL_read_early_data(sssl
, buf
, sizeof(buf
),
351 SSL_READ_EARLY_DATA_SUCCESS
)))
354 if (!TEST_int_gt(SSL_connect(cssl
), 0))
357 if (!TEST_int_le(SSL_connect(cssl
), 0))
360 if (!TEST_int_eq(SSL_read_early_data(sssl
, buf
, sizeof(buf
),
362 SSL_READ_EARLY_DATA_FINISH
))
366 /* Perform handshake (or complete it if doing early data ) */
367 if (!TEST_true(create_ssl_connection(sssl
, cssl
, SSL_ERROR_NONE
)))
371 * Check there were no unexpected CCS messages, all record versions
372 * were as expected, and that the session ids were reflected by the server
375 if (!TEST_false(badccs
) || !TEST_false(badvers
) || !TEST_false(badsessid
))
380 if (!TEST_true(sccsseen
)
381 || !TEST_true(ccsaftersh
)
382 || !TEST_false(ccsbeforesh
)
383 || !TEST_size_t_gt(chsessidlen
, 0))
388 if (!TEST_true(sccsseen
)
389 || !TEST_false(ccsaftersh
)
390 || !TEST_false(ccsbeforesh
)
391 || !TEST_size_t_eq(chsessidlen
, 0))
396 if (!TEST_false(sccsseen
)
397 || !TEST_true(ccsaftersh
)
398 || !TEST_false(ccsbeforesh
)
399 || !TEST_size_t_gt(chsessidlen
, 0))
404 if (!TEST_true(sccsseen
)
405 || !TEST_true(ccsaftersh
)
406 || !TEST_false(ccsbeforesh
)
407 || !TEST_size_t_gt(chsessidlen
, 0))
412 if (!TEST_true(sccsseen
)
413 || !TEST_false(ccsaftersh
)
414 || !TEST_false(ccsbeforesh
)
415 || !TEST_size_t_eq(chsessidlen
, 0))
420 if (!TEST_false(sccsseen
)
421 || !TEST_true(ccsaftersh
)
422 || !TEST_false(ccsbeforesh
)
423 || !TEST_size_t_gt(chsessidlen
, 0))
428 if (!TEST_true(sccsseen
)
429 || !TEST_false(ccsaftersh
)
430 || !TEST_true(ccsbeforesh
)
431 || !TEST_size_t_gt(chsessidlen
, 0))
436 if (!TEST_true(sccsseen
)
437 || !TEST_false(ccsaftersh
)
438 || !TEST_false(ccsbeforesh
)
439 || !TEST_size_t_eq(chsessidlen
, 0))
444 if (!TEST_false(sccsseen
)
445 || !TEST_false(ccsaftersh
)
446 || !TEST_true(ccsbeforesh
)
447 || !TEST_size_t_gt(chsessidlen
, 0))
452 if (!TEST_true(sccsseen
)
453 || !TEST_false(ccsaftersh
)
454 || !TEST_true(ccsbeforesh
)
455 || !TEST_size_t_gt(chsessidlen
, 0))
460 if (!TEST_true(sccsseen
)
461 || !TEST_false(ccsaftersh
)
462 || !TEST_false(ccsbeforesh
)
463 || !TEST_size_t_eq(chsessidlen
, 0))
468 if (!TEST_false(sccsseen
)
469 || !TEST_false(ccsaftersh
)
470 || !TEST_true(ccsbeforesh
)
471 || !TEST_size_t_gt(chsessidlen
, 0))
478 SSL_SESSION_free(sess
);
487 OPT_TEST_DECLARE_USAGE("certfile privkeyfile\n")
489 int setup_tests(void)
491 if (!test_skip_common_options()) {
492 TEST_error("Error parsing test options\n");
496 if (!TEST_ptr(cert
= test_get_argument(0))
497 || !TEST_ptr(privkey
= test_get_argument(1)))
500 ADD_ALL_TESTS(test_tls13ccs
, 12);
505 void cleanup_tests(void)
507 BIO_meth_free(method_watchccs
);