2 * Copyright 2022 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/ssl.h>
12 #include "helpers/quictestlib.h"
13 #include "internal/quic_error.h"
16 static char *cert
= NULL
;
17 static char *privkey
= NULL
;
20 * Basic test that just creates a connection and sends some data without any
23 static int test_basic(void)
26 SSL_CTX
*cctx
= SSL_CTX_new(OSSL_QUIC_client_method());
27 QUIC_TSERVER
*qtserv
= NULL
;
29 char *msg
= "Hello World!";
30 size_t msglen
= strlen(msg
);
31 unsigned char buf
[80];
37 if (!TEST_true(qtest_create_quic_objects(NULL
, cctx
, cert
, privkey
, 0,
38 &qtserv
, &cssl
, NULL
)))
41 if (!TEST_true(qtest_create_quic_connection(qtserv
, cssl
)))
44 if (!TEST_int_eq(SSL_write(cssl
, msg
, msglen
), msglen
))
47 ossl_quic_tserver_tick(qtserv
);
48 if (!TEST_true(ossl_quic_tserver_read(qtserv
, buf
, sizeof(buf
), &bytesread
)))
52 * We assume the entire message is read from the server in one go. In
53 * theory this could get fragmented but its a small message so we assume
56 if (!TEST_mem_eq(msg
, msglen
, buf
, bytesread
))
62 ossl_quic_tserver_free(qtserv
);
68 * Test that adding an unknown frame type is handled correctly
70 static int add_unknown_frame_cb(QTEST_FAULT
*fault
, QUIC_PKT_HDR
*hdr
,
71 unsigned char *buf
, size_t len
, void *cbarg
)
73 static size_t done
= 0;
75 * There are no "reserved" frame types which are definitately safe for us
76 * to use for testing purposes - but we just use the highest possible
77 * value (8 byte length integer) and with no payload bytes
79 unsigned char unknown_frame
[] = {
80 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
83 /* We only ever add the unknown frame to one packet */
87 return qtest_fault_prepend_frame(fault
, unknown_frame
,
88 sizeof(unknown_frame
));
91 static int test_unknown_frame(void)
93 int testresult
= 0, ret
;
94 SSL_CTX
*cctx
= SSL_CTX_new(OSSL_QUIC_client_method());
95 QUIC_TSERVER
*qtserv
= NULL
;
97 char *msg
= "Hello World!";
98 size_t msglen
= strlen(msg
);
99 unsigned char buf
[80];
101 QTEST_FAULT
*fault
= NULL
;
106 if (!TEST_true(qtest_create_quic_objects(NULL
, cctx
, cert
, privkey
, 0,
107 &qtserv
, &cssl
, &fault
)))
110 if (!TEST_true(qtest_create_quic_connection(qtserv
, cssl
)))
114 * Write a message from the server to the client and add an unknown frame
117 if (!TEST_true(qtest_fault_set_packet_plain_listener(fault
,
118 add_unknown_frame_cb
,
122 if (!TEST_true(ossl_quic_tserver_write(qtserv
, (unsigned char *)msg
, msglen
,
126 if (!TEST_size_t_eq(msglen
, byteswritten
))
129 ossl_quic_tserver_tick(qtserv
);
130 if (!TEST_true(SSL_tick(cssl
)))
133 if (!TEST_int_le(ret
= SSL_read(cssl
, buf
, sizeof(buf
)), 0))
136 if (!TEST_int_eq(SSL_get_error(cssl
, ret
), SSL_ERROR_SSL
))
141 * TODO(QUIC): We should expect an error on the queue after this - but we
143 * Note, just raising the error in the obvious place causes SSL_tick() to
144 * succeed, but leave a suprious error on the stack. We need to either
145 * allow SSL_tick() to fail, or somehow delay the raising of the error
146 * until the SSL_read() call.
148 if (!TEST_int_eq(ERR_GET_REASON(ERR_peek_error()),
149 SSL_R_UNKNOWN_FRAME_TYPE_RECEIVED
))
153 if (!TEST_true(qtest_check_server_protocol_err(qtserv
)))
158 qtest_fault_free(fault
);
160 ossl_quic_tserver_free(qtserv
);
166 * Test that a server that fails to provide transport params cannot be
169 static int drop_transport_params_cb(QTEST_FAULT
*fault
,
170 QTEST_ENCRYPTED_EXTENSIONS
*ee
,
171 size_t eelen
, void *encextcbarg
)
173 if (!qtest_fault_delete_extension(fault
,
174 TLSEXT_TYPE_quic_transport_parameters
,
175 ee
->extensions
, &ee
->extensionslen
))
181 static int test_no_transport_params(void)
184 SSL_CTX
*cctx
= SSL_CTX_new(OSSL_QUIC_client_method());
185 QUIC_TSERVER
*qtserv
= NULL
;
187 QTEST_FAULT
*fault
= NULL
;
192 if (!TEST_true(qtest_create_quic_objects(NULL
, cctx
, cert
, privkey
, 0,
193 &qtserv
, &cssl
, &fault
)))
196 if (!TEST_true(qtest_fault_set_hand_enc_ext_listener(fault
,
197 drop_transport_params_cb
,
202 * We expect the connection to fail because the server failed to provide
203 * transport parameters
205 if (!TEST_false(qtest_create_quic_connection(qtserv
, cssl
)))
208 if (!TEST_true(qtest_check_server_protocol_err(qtserv
)))
213 qtest_fault_free(fault
);
215 ossl_quic_tserver_free(qtserv
);
221 * Test that corrupted packets/datagrams are dropped and retransmitted
223 static int docorrupt
= 0;
225 static int on_packet_cipher_cb(QTEST_FAULT
*fault
, QUIC_PKT_HDR
*hdr
,
226 unsigned char *buf
, size_t len
, void *cbarg
)
228 if (!docorrupt
|| len
== 0)
231 buf
[(size_t)test_random() % len
] ^= 0xff;
237 static int on_datagram_cb(QTEST_FAULT
*fault
, BIO_MSG
*m
, size_t stride
,
240 if (!docorrupt
|| m
->data_len
== 0)
243 if (!qtest_fault_resize_datagram(fault
, m
->data_len
- 1))
252 * Test 1: Corrupt by flipping bits in an encrypted packet
253 * Test 2: Corrupt by truncating an entire datagram
255 static int test_corrupted_data(int idx
)
257 QTEST_FAULT
*fault
= NULL
;
259 SSL_CTX
*cctx
= SSL_CTX_new(OSSL_QUIC_client_method());
260 QUIC_TSERVER
*qtserv
= NULL
;
262 char *msg
= "Hello World!";
263 size_t msglen
= strlen(msg
);
264 unsigned char buf
[80];
265 size_t bytesread
, byteswritten
;
270 if (!TEST_true(qtest_create_quic_objects(NULL
, cctx
, cert
, privkey
, 0,
271 &qtserv
, &cssl
, &fault
)))
275 /* Listen for encrypted packets being sent */
276 if (!TEST_true(qtest_fault_set_packet_cipher_listener(fault
,
281 /* Listen for datagrams being sent */
282 if (!TEST_true(qtest_fault_set_datagram_listener(fault
,
287 if (!TEST_true(qtest_create_quic_connection(qtserv
, cssl
)))
290 /* Corrupt the next server packet*/
294 * Send first 5 bytes of message. This will get corrupted and is treated as
297 if (!TEST_true(ossl_quic_tserver_write(qtserv
, (unsigned char *)msg
, 5,
301 if (!TEST_size_t_eq(byteswritten
, 5))
305 * Introduce a small delay so that the above packet has time to be detected
306 * as lost. Loss detection times are based on RTT which should be very
307 * fast for us since there isn't really a network. The loss delay timer is
308 * always at least 1ms though. We sleep for 100ms.
309 * TODO(QUIC): This assumes the calculated RTT will always be way less than
310 * 100ms - which it should be...but can we always guarantee this? An
311 * alternative might be to put in our own ossl_time_now() implementation for
312 * these tests and control the timer as part of the test. This approach has
313 * the added advantage that the test will behave reliably when run in a
314 * debugger. Without it may get unreliable debugging results. This would
315 * require some significant refactoring of the ssl/quic code though.
319 /* Send rest of message */
320 if (!TEST_true(ossl_quic_tserver_write(qtserv
, (unsigned char *)msg
+ 5,
321 msglen
- 5, &byteswritten
)))
324 if (!TEST_size_t_eq(byteswritten
, msglen
- 5))
328 * Receive the corrupted packet. This should get dropped and is effectively
329 * "lost". We also process the second packet which should be decrypted
330 * successfully. Therefore we ack the frames in it
332 if (!TEST_true(SSL_tick(cssl
)))
336 * Process the ack. Detect that the first part of the message must have
337 * been lost due to the time elapsed since it was sent and resend it
339 ossl_quic_tserver_tick(qtserv
);
341 /* Receive and process the newly arrived message data resend */
342 if (!TEST_true(SSL_tick(cssl
)))
345 /* The whole message should now have arrived */
346 if (!TEST_true(SSL_read_ex(cssl
, buf
, sizeof(buf
), &bytesread
)))
349 if (!TEST_mem_eq(msg
, msglen
, buf
, bytesread
))
353 * If the test was successful then we corrupted exactly one packet and
354 * docorrupt was reset
356 if (!TEST_false(docorrupt
))
361 qtest_fault_free(fault
);
363 ossl_quic_tserver_free(qtserv
);
368 OPT_TEST_DECLARE_USAGE("certsdir\n")
370 int setup_tests(void)
372 char *certsdir
= NULL
;
374 if (!test_skip_common_options()) {
375 TEST_error("Error parsing test options\n");
379 if (!TEST_ptr(certsdir
= test_get_argument(0)))
382 cert
= test_mk_file_path(certsdir
, "servercert.pem");
386 privkey
= test_mk_file_path(certsdir
, "serverkey.pem");
390 ADD_TEST(test_basic
);
391 ADD_TEST(test_unknown_frame
);
392 ADD_TEST(test_no_transport_params
);
393 ADD_ALL_TESTS(test_corrupted_data
, 2);
399 OPENSSL_free(privkey
);
403 void cleanup_tests(void)
406 OPENSSL_free(privkey
);