1# $OpenBSD: tlsfuzzer.py,v 1.43 2021/09/03 14:50:36 tb Exp $ 2# 3# Copyright (c) 2020 Theo Buehler <tb@openbsd.org> 4# 5# Permission to use, copy, modify, and distribute this software for any 6# purpose with or without fee is hereby granted, provided that the above 7# copyright notice and this permission notice appear in all copies. 8# 9# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 17import getopt 18import os 19import subprocess 20import sys 21from timeit import default_timer as timer 22 23tlsfuzzer_scriptdir = "/usr/local/share/tlsfuzzer/scripts/" 24 25class Test: 26 """ 27 Represents a tlsfuzzer test script. 28 name: the script's name 29 args: arguments to feed to the script 30 tls12_args: override args for a TLSv1.2 server 31 tls13_args: override args for a TLSv1.3 server 32 33 XXX Add client cert support. 34 """ 35 def __init__(self, name="", args=[], tls12_args=[], tls13_args=[]): 36 self.name = name 37 self.tls12_args = args 38 self.tls13_args = args 39 if tls12_args: 40 self.tls12_args = tls12_args 41 if tls13_args: 42 self.tls13_args = tls13_args 43 44 def args(self, has_tls1_3: True): 45 if has_tls1_3: 46 return self.tls13_args 47 else: 48 return self.tls12_args 49 50 def __repr__(self): 51 return "<Test: %s tls12_args: %s tls13_args: %s>" % ( 52 self.name, self.tls12_args, tls13_args 53 ) 54 55class TestGroup: 56 """ A group of Test objects to be run by TestRunner.""" 57 def __init__(self, title="Tests", tests=[]): 58 self.title = title 59 self.tests = tests 60 61 def __iter__(self): 62 return iter(self.tests) 63 64# argument to pass to several tests 65tls13_unsupported_ciphers = [ 66 "-e", "TLS 1.3 with ffdhe2048", 67 "-e", "TLS 1.3 with ffdhe3072", 68 "-e", "TLS 1.3 with x448", 69] 70 71def substitute_alert(want, got): 72 return f"Expected alert description \"{want}\" " \ 73 + f"does not match received \"{got}\"" 74 75# test-tls13-finished.py has 70 failing tests that expect a "decode_error" 76# instead of the "decrypt_error" sent by tls13_server_finished_recv(). 77# Both alerts appear to be reasonable in this context, so work around this 78# in the test instead of the library. 79def generate_test_tls13_finished_args(): 80 assertion = substitute_alert("decode_error", "decrypt_error"); 81 paddings = [ 82 ("TLS_AES_128_GCM_SHA256", 0, 1), 83 ("TLS_AES_128_GCM_SHA256", 0, 2), 84 ("TLS_AES_128_GCM_SHA256", 0, 4), 85 ("TLS_AES_128_GCM_SHA256", 0, 8), 86 ("TLS_AES_128_GCM_SHA256", 0, 16), 87 ("TLS_AES_128_GCM_SHA256", 0, 32), 88 ("TLS_AES_128_GCM_SHA256", 0, 48), 89 ("TLS_AES_128_GCM_SHA256", 0, 2**14-4-32), 90 ("TLS_AES_128_GCM_SHA256", 0, 0x20000), 91 ("TLS_AES_128_GCM_SHA256", 0, 0x30000), 92 ("TLS_AES_128_GCM_SHA256", 1, 0), 93 ("TLS_AES_128_GCM_SHA256", 2, 0), 94 ("TLS_AES_128_GCM_SHA256", 4, 0), 95 ("TLS_AES_128_GCM_SHA256", 8, 0), 96 ("TLS_AES_128_GCM_SHA256", 16, 0), 97 ("TLS_AES_128_GCM_SHA256", 32, 0), 98 ("TLS_AES_128_GCM_SHA256", 48, 0), 99 ("TLS_AES_128_GCM_SHA256", 2**14-4-32, 0), 100 ("TLS_AES_128_GCM_SHA256", 12, 0), 101 ("TLS_AES_128_GCM_SHA256", 1, 1), 102 ("TLS_AES_128_GCM_SHA256", 8, 8), 103 ("TLS_AES_256_GCM_SHA384", 0, 1), 104 ("TLS_AES_256_GCM_SHA384", 0, 2), 105 ("TLS_AES_256_GCM_SHA384", 0, 4), 106 ("TLS_AES_256_GCM_SHA384", 0, 8), 107 ("TLS_AES_256_GCM_SHA384", 0, 16), 108 ("TLS_AES_256_GCM_SHA384", 0, 32), 109 ("TLS_AES_256_GCM_SHA384", 0, 48), 110 ("TLS_AES_256_GCM_SHA384", 0, 2**14-4-48), 111 ("TLS_AES_256_GCM_SHA384", 0, 0x20000), 112 ("TLS_AES_256_GCM_SHA384", 0, 0x30000), 113 ("TLS_AES_256_GCM_SHA384", 0, 12), 114 ("TLS_AES_256_GCM_SHA384", 1, 0), 115 ("TLS_AES_256_GCM_SHA384", 2, 0), 116 ("TLS_AES_256_GCM_SHA384", 4, 0), 117 ("TLS_AES_256_GCM_SHA384", 8, 0), 118 ("TLS_AES_256_GCM_SHA384", 16, 0), 119 ("TLS_AES_256_GCM_SHA384", 32, 0), 120 ("TLS_AES_256_GCM_SHA384", 48, 0), 121 ("TLS_AES_256_GCM_SHA384", 2**14-4-48, 0), 122 ("TLS_AES_256_GCM_SHA384", 1, 1), 123 ("TLS_AES_256_GCM_SHA384", 8, 8), 124 ] 125 truncations = [ 126 ("TLS_AES_128_GCM_SHA256", 0, -1), 127 ("TLS_AES_128_GCM_SHA256", 0, -2), 128 ("TLS_AES_128_GCM_SHA256", 0, -4), 129 ("TLS_AES_128_GCM_SHA256", 0, -8), 130 ("TLS_AES_128_GCM_SHA256", 0, -16), 131 ("TLS_AES_128_GCM_SHA256", 0, -32), 132 ("TLS_AES_128_GCM_SHA256", 0, 12), 133 ("TLS_AES_128_GCM_SHA256", 1, None), 134 ("TLS_AES_128_GCM_SHA256", 2, None), 135 ("TLS_AES_128_GCM_SHA256", 4, None), 136 ("TLS_AES_128_GCM_SHA256", 8, None), 137 ("TLS_AES_128_GCM_SHA256", 16, None), 138 ("TLS_AES_128_GCM_SHA256", 32, None), 139 ("TLS_AES_256_GCM_SHA384", 0, -1), 140 ("TLS_AES_256_GCM_SHA384", 0, -2), 141 ("TLS_AES_256_GCM_SHA384", 0, -4), 142 ("TLS_AES_256_GCM_SHA384", 0, -8), 143 ("TLS_AES_256_GCM_SHA384", 0, -16), 144 ("TLS_AES_256_GCM_SHA384", 0, -32), 145 ("TLS_AES_256_GCM_SHA384", 0, 12), 146 ("TLS_AES_256_GCM_SHA384", 1, None), 147 ("TLS_AES_256_GCM_SHA384", 2, None), 148 ("TLS_AES_256_GCM_SHA384", 4, None), 149 ("TLS_AES_256_GCM_SHA384", 8, None), 150 ("TLS_AES_256_GCM_SHA384", 16, None), 151 ("TLS_AES_256_GCM_SHA384", 32, None), 152 ] 153 154 args = [ 155 "-x", "empty - cipher TLS_AES_128_GCM_SHA256", "-X", assertion, 156 "-x", "empty - cipher TLS_AES_256_GCM_SHA384", "-X", assertion, 157 ] 158 padding_fmt = "padding - cipher %s, pad_byte 0, pad_left %d, pad_right %d" 159 for padding in paddings: 160 args += ["-x", padding_fmt % padding, "-X", assertion] 161 truncation_fmt = "truncation - cipher %s, start %d, end %s" 162 for truncation in truncations: 163 args += ["-x", truncation_fmt % truncation, "-X", assertion] 164 return args 165 166tls13_tests = TestGroup("TLSv1.3 tests", [ 167 Test("test-tls13-ccs.py"), 168 Test("test-tls13-conversation.py"), 169 Test("test-tls13-count-tickets.py"), 170 Test("test-tls13-empty-alert.py"), 171 Test("test-tls13-finished.py", generate_test_tls13_finished_args()), 172 Test("test-tls13-finished-plaintext.py"), 173 Test("test-tls13-hrr.py"), 174 Test("test-tls13-keyshare-omitted.py"), 175 Test("test-tls13-legacy-version.py"), 176 Test("test-tls13-nociphers.py"), 177 Test("test-tls13-record-padding.py"), 178 Test("test-tls13-shuffled-extentions.py"), 179 Test("test-tls13-zero-content-type.py"), 180 181 # The skipped tests fail due to a bug in BIO_gets() which masks the retry 182 # signalled from an SSL_read() failure. Testing with httpd(8) shows we're 183 # handling these corner cases correctly since tls13_record_layer.c -r1.47. 184 Test("test-tls13-zero-length-data.py", [ 185 "-e", "zero-length app data", 186 "-e", "zero-length app data with large padding", 187 "-e", "zero-length app data with padding", 188 ]), 189]) 190 191# Tests that take a lot of time (> ~30s on an x280) 192tls13_slow_tests = TestGroup("slow TLSv1.3 tests", [ 193 # XXX: Investigate the occasional message 194 # "Got shared secret with 1 most significant bytes equal to zero." 195 Test("test-tls13-dhe-shared-secret-padding.py", tls13_unsupported_ciphers), 196 197 Test("test-tls13-invalid-ciphers.py"), 198 Test("test-tls13-serverhello-random.py", tls13_unsupported_ciphers), 199 200 # Mark two tests cases as xfail for now. The tests expect an arguably 201 # correct decode_error while we send a decrypt_error (like fizz/boring). 202 Test("test-tls13-record-layer-limits.py", [ 203 "-x", "max size payload (2**14) of Finished msg, with 16348 bytes of left padding, cipher TLS_AES_128_GCM_SHA256", 204 "-X", substitute_alert("decode_error", "decrypt_error"), 205 "-x", "max size payload (2**14) of Finished msg, with 16348 bytes of left padding, cipher TLS_CHACHA20_POLY1305_SHA256", 206 "-X", substitute_alert("decode_error", "decrypt_error"), 207 ]), 208 # We don't accept an empty ECPF extension since it must advertise the 209 # uncompressed point format. Exclude this extension type from the test. 210 Test( 211 "test-tls13-large-number-of-extensions.py", 212 tls13_args = ["--exc", "11"], 213 ), 214]) 215 216tls13_extra_cert_tests = TestGroup("TLSv1.3 certificate tests", [ 217 # need to set up client certs to run these 218 Test("test-tls13-certificate-request.py"), 219 Test("test-tls13-certificate-verify.py"), 220 Test("test-tls13-ecdsa-in-certificate-verify.py"), 221 Test("test-tls13-eddsa-in-certificate-verify.py"), 222 223 # Test expects the server to have installed three certificates: 224 # with P-256, P-384 and P-521 curve. Also SHA1+ECDSA is verified 225 # to not work. 226 Test("test-tls13-ecdsa-support.py"), 227]) 228 229tls13_failing_tests = TestGroup("failing TLSv1.3 tests", [ 230 # Some tests fail because we fail later than the scripts expect us to. 231 # With X25519, we accept weak peer public keys and fail when we actually 232 # compute the keyshare. Other tests seem to indicate that we could be 233 # stricter about what keyshares we accept. 234 Test("test-tls13-crfg-curves.py", [ 235 '-e', 'all zero x448 key share', 236 '-e', 'empty x448 key share', 237 '-e', 'sanity x448 with compression ansiX962_compressed_char2', 238 '-e', 'sanity x448 with compression ansiX962_compressed_prime', 239 '-e', 'sanity x448 with compression uncompressed', 240 '-e', 'too big x448 key share', 241 '-e', 'too small x448 key share', 242 '-e', 'x448 key share of "1"', 243 ]), 244 Test("test-tls13-ecdhe-curves.py", [ 245 '-e', 'sanity - x448', 246 '-e', 'x448 - key share from other curve', 247 '-e', 'x448 - point at infinity', 248 '-e', 'x448 - right 0-padded key_share', 249 '-e', 'x448 - right-truncated key_share', 250 ]), 251 252 # The test sends records with protocol version 0x0300 instead of 0x0303 253 # and currently fails with OpenSSL and LibreSSL for this reason. 254 # We have the logic corresponding to NSS's fix for CVE-2020-25648 255 # https://hg.mozilla.org/projects/nss/rev/57bbefa793232586d27cee83e74411171e128361 256 # so should not be affected by this issue. 257 Test("test-tls13-multiple-ccs-messages.py"), 258 259 # https://github.com/openssl/openssl/issues/8369 260 Test("test-tls13-obsolete-curves.py"), 261 262 # 3 failing rsa_pss_pss tests 263 Test("test-tls13-rsa-signatures.py"), 264 265 # The failing tests all expect an ri extension. What's up with that? 266 Test("test-tls13-version-negotiation.py"), 267]) 268 269tls13_slow_failing_tests = TestGroup("slow, failing TLSv1.3 tests", [ 270 # Other test failures bugs in keyshare/tlsext negotiation? 271 Test("test-tls13-unrecognised-groups.py"), # unexpected closure 272 273 # 5 occasional failures: 274 # 'app data split, conversation with KeyUpdate msg' 275 # 'fragmented keyupdate msg' 276 # 'multiple KeyUpdate messages' 277 # 'post-handshake KeyUpdate msg with update_not_request' 278 # 'post-handshake KeyUpdate msg with update_request' 279 Test("test-tls13-keyupdate.py"), 280 281 Test("test-tls13-symetric-ciphers.py"), # unexpected message from peer 282 283 # 6 tests fail: 'rsa_pkcs1_{md5,sha{1,224,256,384,512}} signature' 284 # We send server hello, but the test expects handshake_failure 285 Test("test-tls13-pkcs-signature.py"), 286 # 8 tests fail: 'tls13 signature rsa_pss_{pss,rsae}_sha{256,384,512} 287 Test("test-tls13-rsapss-signatures.py"), 288]) 289 290tls13_unsupported_tests = TestGroup("TLSv1.3 tests for unsupported features", [ 291 # Tests for features we don't support 292 Test("test-tls13-0rtt-garbage.py"), 293 Test("test-tls13-ffdhe-groups.py"), 294 Test("test-tls13-ffdhe-sanity.py"), 295 Test("test-tls13-psk_dhe_ke.py"), 296 Test("test-tls13-psk_ke.py"), 297 298 # need server to react to HTTP GET for /keyupdate 299 Test("test-tls13-keyupdate-from-server.py"), 300 301 # Weird test: tests servers that don't support 1.3 302 Test("test-tls13-non-support.py"), 303 304 # broken test script 305 # UnboundLocalError: local variable 'cert' referenced before assignment 306 Test("test-tls13-post-handshake-auth.py"), 307 308 # ExpectNewSessionTicket 309 Test("test-tls13-session-resumption.py"), 310 311 # Server must be configured to support only rsa_pss_rsae_sha512 312 Test("test-tls13-signature-algorithms.py"), 313]) 314 315tls12_exclude_legacy_protocols = [ 316 # all these have BIO_read timeouts against TLSv1.3 317 "-e", "Protocol (3, 0)", 318 "-e", "Protocol (3, 0) in SSLv2 compatible ClientHello", 319 # the following only fail with TLSv1.3 320 "-e", "Protocol (3, 1) in SSLv2 compatible ClientHello", 321 "-e", "Protocol (3, 2) in SSLv2 compatible ClientHello", 322 "-e", "Protocol (3, 3) in SSLv2 compatible ClientHello", 323 "-e", "Protocol (3, 1) with x448 group", 324 "-e", "Protocol (3, 2) with x448 group", 325 "-e", "Protocol (3, 3) with x448 group", 326] 327 328tls12_tests = TestGroup("TLSv1.2 tests", [ 329 # Tests that pass as they are. 330 Test("test-TLSv1_2-rejected-without-TLSv1_2.py"), 331 Test("test-aes-gcm-nonces.py"), 332 Test("test-chacha20.py"), 333 Test("test-conversation.py"), 334 Test("test-cve-2016-2107.py"), 335 Test("test-cve-2016-6309.py"), 336 Test("test-dhe-rsa-key-exchange.py"), 337 Test("test-dhe-rsa-key-exchange-with-bad-messages.py"), 338 Test("test-early-application-data.py"), 339 Test("test-empty-extensions.py"), 340 Test("test-extensions.py"), 341 Test("test-fuzzed-MAC.py"), 342 Test("test-fuzzed-ciphertext.py"), 343 Test("test-fuzzed-finished.py"), 344 Test("test-fuzzed-padding.py"), 345 Test("test-fuzzed-plaintext.py"), # fails once in a while 346 Test("test-hello-request-by-client.py"), 347 Test("test-invalid-cipher-suites.py"), 348 Test("test-invalid-content-type.py"), 349 Test("test-invalid-session-id.py"), 350 Test("test-invalid-version.py"), 351 Test("test-lucky13.py"), 352 Test("test-message-skipping.py"), 353 Test("test-no-heartbeat.py"), 354 Test("test-record-layer-fragmentation.py"), 355 Test("test-sessionID-resumption.py"), 356 Test("test-sslv2-connection.py"), 357 Test("test-truncating-of-finished.py"), 358 Test("test-truncating-of-kRSA-client-key-exchange.py"), 359 Test("test-unsupported-curve-fallback.py"), 360 Test("test-version-numbers.py"), 361 Test("test-zero-length-data.py"), 362 363 # Tests that need tweaking for unsupported features and ciphers. 364 Test( 365 "test-atypical-padding.py", [ 366 "-e", "sanity - encrypt then MAC", 367 "-e", "2^14 bytes of AppData with 256 bytes of padding (SHA1 + Encrypt then MAC)", 368 ] 369 ), 370 Test( 371 "test-dhe-rsa-key-exchange-signatures.py", [ 372 "-e", "TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA sha224 signature", 373 "-e", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 sha224 signature", 374 "-e", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA sha224 signature", 375 "-e", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 sha224 signature", 376 "-e", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA sha224 signature", 377 ] 378 ), 379 Test("test-dhe-key-share-random.py", tls12_exclude_legacy_protocols), 380 Test("test-export-ciphers-rejected.py", ["--min-ver", "TLSv1.0"]), 381 Test( 382 "test-downgrade-protection.py", 383 tls12_args = ["--server-max-protocol", "TLSv1.2"], 384 tls13_args = ["--server-max-protocol", "TLSv1.3"], 385 ), 386 Test("test-fallback-scsv.py", tls13_args = ["--tls-1.3"] ), 387 388 Test("test-invalid-compression-methods.py", [ 389 "-x", "invalid compression methods", 390 "-X", substitute_alert("illegal_parameter", "decode_error"), 391 "-x", "only deflate compression method", 392 "-X", substitute_alert("illegal_parameter", "decode_error"), 393 ]), 394 395 # Skip extended_master_secret test. Since we don't support this 396 # extension, we don't notice that it was dropped. 397 Test("test-renegotiation-changed-clienthello.py", [ 398 "-e", "drop extended_master_secret in renegotiation", 399 ]), 400 401 # Without --sig-algs-drop-ok, two tests fail since we do not currently 402 # implement the signature_algorithms_cert extension (although we MUST). 403 Test("test-sig-algs-renegotiation-resumption.py", ["--sig-algs-drop-ok"]), 404 405 Test("test-serverhello-random.py", args = tls12_exclude_legacy_protocols), 406]) 407 408tls12_slow_tests = TestGroup("slow TLSv1.2 tests", [ 409 Test("test-cve-2016-7054.py"), 410 Test("test-dhe-no-shared-secret-padding.py", tls12_exclude_legacy_protocols), 411 Test("test-ecdhe-padded-shared-secret.py", tls12_exclude_legacy_protocols), 412 Test("test-ecdhe-rsa-key-share-random.py", tls12_exclude_legacy_protocols), 413 Test("test-large-hello.py"), 414]) 415 416tls12_failing_tests = TestGroup("failing TLSv1.2 tests", [ 417 # no shared cipher 418 Test("test-aesccm.py"), 419 # need server to set up alpn 420 Test("test-alpn-negotiation.py"), 421 # many tests fail due to unexpected server_name extension 422 Test("test-bleichenbacher-workaround.py"), 423 424 # need client key and cert plus extra server setup 425 Test("test-certificate-malformed.py"), 426 Test("test-certificate-request.py"), 427 Test("test-certificate-verify-malformed-sig.py"), 428 Test("test-certificate-verify-malformed.py"), 429 Test("test-certificate-verify.py"), 430 Test("test-ecdsa-in-certificate-verify.py"), 431 Test("test-eddsa-in-certificate-verify.py"), 432 Test("test-renegotiation-disabled-client-cert.py"), 433 Test("test-rsa-pss-sigs-on-certificate-verify.py"), 434 Test("test-rsa-sigs-on-certificate-verify.py"), 435 436 # test doesn't expect session ticket 437 Test("test-client-compatibility.py"), 438 # abrupt closure 439 Test("test-client-hello-max-size.py"), 440 # unknown signature algorithms 441 Test("test-clienthello-md5.py"), 442 443 # Tests expect an illegal_parameter or a decode_error alert. Should be 444 # added to ssl3_get_client_key_exchange on kex function failure. 445 Test("test-ecdhe-rsa-key-exchange-with-bad-messages.py"), 446 447 # We send a handshake_failure due to no shared ciphers while the 448 # test expects to succeed. 449 Test("test-ecdhe-rsa-key-exchange.py"), 450 451 # no shared cipher 452 Test("test-ecdsa-sig-flexibility.py"), 453 454 # Tests expect SH but we send unexpected_message or handshake_failure 455 # 'Application data inside Client Hello' 456 # 'Application data inside Client Key Exchange' 457 # 'Application data inside Finished' 458 Test("test-interleaved-application-data-and-fragmented-handshakes-in-renegotiation.py"), 459 # Tests expect SH but we send handshake_failure 460 # 'Application data before Change Cipher Spec' 461 # 'Application data before Client Key Exchange' 462 # 'Application data before Finished' 463 Test("test-interleaved-application-data-in-renegotiation.py"), 464 465 # broken test script 466 # TypeError: '<' not supported between instances of 'int' and 'NoneType' 467 Test("test-invalid-client-hello-w-record-overflow.py"), 468 469 # Lots of failures. abrupt closure 470 Test("test-invalid-client-hello.py"), 471 472 # abrupt closure 473 # 'encrypted premaster set to all zero (n)' n in 256 384 512 474 Test("test-invalid-rsa-key-exchange-messages.py"), 475 476 # test expects illegal_parameter, we send unrecognized_name (which seems 477 # correct according to rfc 6066?) 478 Test("test-invalid-server-name-extension-resumption.py"), 479 # let through some server names without sending an alert 480 # again illegal_parameter vs unrecognized_name 481 Test("test-invalid-server-name-extension.py"), 482 483 # 14 pass 484 # 7 fail 485 # 'n extensions', n in 4095, 4096, 4097, 8191, 8192, 8193, 16383, 486 Test("test-large-number-of-extensions.py"), 487 488 # 4 failures: 489 # 'insecure (legacy) renegotiation with GET after 2nd handshake' 490 # 'insecure (legacy) renegotiation with incomplete GET' 491 # 'secure renegotiation with GET after 2nd handshake' 492 # 'secure renegotiation with incomplete GET' 493 Test("test-legacy-renegotiation.py"), 494 495 # 1 failure (timeout): we don't send the unexpected_message alert 496 # 'duplicate change cipher spec after Finished' 497 Test("test-message-duplication.py"), 498 499 # server should send status_request 500 Test("test-ocsp-stapling.py"), 501 502 # unexpected closure 503 Test("test-openssl-3712.py"), 504 505 # failed: 3 (expect an alert, we send AD) 506 # 'try insecure (legacy) renegotiation with incomplete GET' 507 # 'try secure renegotiation with GET after 2nd CH' 508 # 'try secure renegotiation with incomplete GET' 509 Test("test-renegotiation-disabled.py"), 510 511 # 'resumption of safe session with NULL cipher' 512 # 'resumption with cipher from old CH but not selected by server' 513 Test("test-resumption-with-wrong-ciphers.py"), 514 515 # 5 failures: 516 # 'empty sigalgs' 517 # 'only undefined sigalgs' 518 # 'rsa_pss_pss_sha256 only' 519 # 'rsa_pss_pss_sha384 only' 520 # 'rsa_pss_pss_sha512 only' 521 Test("test-sig-algs.py"), 522 523 # 13 failures: 524 # 'duplicated n non-rsa schemes' for n in 202 2342 8119 23741 32744 525 # 'empty list of signature methods' 526 # 'tolerance n RSA or ECDSA methods' for n in 215 2355 8132 23754 527 # 'tolerance 32758 methods with sig_alg_cert' 528 # 'tolerance max 32744 number of methods with sig_alg_cert' 529 # 'tolerance max (32760) number of methods' 530 Test("test-signature-algorithms.py"), 531 532 # times out 533 Test("test-ssl-death-alert.py"), 534 535 # 17 pass, 13 fail. padding and truncation 536 Test("test-truncating-of-client-hello.py"), 537 538 # x448 tests need disabling plus x25519 corner cases need sorting out 539 Test("test-x25519.py"), 540]) 541 542tls12_unsupported_tests = TestGroup("TLSv1.2 for unsupported features", [ 543 # protocol_version 544 Test("test-SSLv3-padding.py"), 545 # we don't do RSA key exchanges 546 Test("test-bleichenbacher-timing.py"), 547 # no encrypt-then-mac 548 Test("test-encrypt-then-mac-renegotiation.py"), 549 Test("test-encrypt-then-mac.py"), 550 # no EME support 551 Test("test-extended-master-secret-extension-with-client-cert.py"), 552 Test("test-extended-master-secret-extension.py"), 553 # no ffdhe 554 Test("test-ffdhe-expected-params.py"), 555 Test("test-ffdhe-negotiation.py"), 556 # record_size_limit/max_fragment_length extension (RFC 8449) 557 Test("test-record-size-limit.py"), 558 # expects the server to send the heartbeat extension 559 Test("test-heartbeat.py"), 560]) 561 562# These tests take a ton of time to fail against an 1.3 server, 563# so don't run them against 1.3 pending further investigation. 564legacy_tests = TestGroup("Legacy protocol tests", [ 565 Test("test-sslv2-force-cipher-3des.py"), 566 Test("test-sslv2-force-cipher-non3des.py"), 567 Test("test-sslv2-force-cipher.py"), 568 Test("test-sslv2-force-export-cipher.py"), 569 Test("test-sslv2hello-protocol.py"), 570]) 571 572all_groups = [ 573 tls13_tests, 574 tls13_slow_tests, 575 tls13_extra_cert_tests, 576 tls13_failing_tests, 577 tls13_slow_failing_tests, 578 tls13_unsupported_tests, 579 tls12_tests, 580 tls12_slow_tests, 581 tls12_failing_tests, 582 tls12_unsupported_tests, 583 legacy_tests, 584] 585 586failing_groups = [ 587 tls13_failing_tests, 588 tls13_slow_failing_tests, 589 tls12_failing_tests, 590] 591 592class TestRunner: 593 """ Runs the given tests troups against a server and displays stats. """ 594 595 def __init__( 596 self, timing=False, verbose=False, host="localhost", port=4433, 597 use_tls1_3=True, dry_run=False, tests=[], scriptdir=tlsfuzzer_scriptdir, 598 ): 599 self.tests = [] 600 601 self.dryrun = dry_run 602 self.use_tls1_3 = use_tls1_3 603 self.host = host 604 self.port = str(port) 605 self.scriptdir = scriptdir 606 607 self.stats = [] 608 self.failed = [] 609 self.missing = [] 610 611 self.timing = timing 612 self.verbose = verbose 613 614 def add(self, title="tests", tests=[]): 615 # tests.sort(key=lambda test: test.name) 616 self.tests.append(TestGroup(title, tests)) 617 618 def add_group(self, group): 619 self.tests.append(group) 620 621 def run_script(self, test): 622 script = test.name 623 args = ["-h"] + [self.host] + ["-p"] + [self.port] + test.args(self.use_tls1_3) 624 625 if self.dryrun: 626 if not self.verbose: 627 args = [] 628 print(script , end=' ' if args else '') 629 print(' '.join([f"\"{arg}\"" for arg in args])) 630 return 631 632 if self.verbose: 633 print(script) 634 else: 635 print(f"{script[:68]:<72}", end=" ", flush=True) 636 start = timer() 637 scriptpath = os.path.join(self.scriptdir, script) 638 if not os.path.exists(scriptpath): 639 self.missing.append(script) 640 print("MISSING") 641 return 642 test = subprocess.run( 643 ["python3", scriptpath] + args, 644 capture_output=not self.verbose, 645 text=True, 646 ) 647 end = timer() 648 self.stats.append((script, end - start)) 649 if test.returncode == 0: 650 print("OK") 651 return 652 print("FAILED") 653 self.failed.append(script) 654 655 if self.verbose: 656 return 657 658 print('\n'.join(test.stdout.split("Test end\n", 1)[1:]), end="") 659 660 def run(self): 661 for group in self: 662 print(f"Running {group.title} ...") 663 for test in group: 664 self.run_script(test) 665 return not self.failed 666 667 def __iter__(self): 668 return iter(self.tests) 669 670 def __del__(self): 671 if self.timing and self.stats: 672 total = 0.0 673 for (script, time) in self.stats: 674 print(f"{round(time, 2):6.2f} {script}") 675 total += time 676 print(f"{round(total, 2):6.2f} total") 677 678 if self.failed: 679 print("Failed tests:") 680 print('\n'.join(self.failed)) 681 682 if self.missing: 683 print("Missing tests (outdated package?):") 684 print('\n'.join(self.missing)) 685 686class TlsServer: 687 """ Spawns an s_server listening on localhost:port if necessary. """ 688 689 def __init__(self, host="localhost", port=4433): 690 self.spawn = True 691 # Check whether a server is already listening on localhost:port 692 self.spawn = subprocess.run( 693 ["nc", "-c", "-z", "-T", "noverify", host, str(port)], 694 stderr=subprocess.DEVNULL, 695 ).returncode != 0 696 697 if self.spawn: 698 self.server = subprocess.Popen( 699 [ 700 "openssl", 701 "s_server", 702 "-accept", 703 str(port), 704 "-groups", 705 "X25519:P-256:P-521:P-384", 706 "-key", 707 "localhost.key", 708 "-cert", 709 "localhost.crt", 710 "-www", 711 ], 712 stdout=subprocess.DEVNULL, 713 stderr=subprocess.PIPE, 714 text=True, 715 ) 716 717 # Check whether the server talks TLSv1.3 718 self.has_tls1_3 = True or subprocess.run( 719 [ 720 "nc", 721 "-c", 722 "-z", 723 "-T", 724 "noverify", 725 "-T", 726 "protocols=TLSv1.3", 727 "localhost", 728 str(port), 729 ], 730 stderr=subprocess.DEVNULL, 731 ).returncode == 0 732 733 self.check() 734 735 def check(self): 736 if self.spawn and self.server.poll() is not None: 737 print(self.server.stderr.read()) 738 raise RuntimeError( 739 f"openssl s_server died. Return code: {self.server.returncode}." 740 ) 741 if self.spawn: 742 self.server.stderr.detach() 743 744 def __del__(self): 745 if self.spawn: 746 self.server.terminate() 747 748# Extract the arguments we pass to script 749def defaultargs(script, has_tls1_3): 750 return next( 751 (test for group in all_groups for test in group if test.name == script), 752 Test() 753 ).args(has_tls1_3) 754 755def list_or_missing(missing=True): 756 tests = [test.name for group in all_groups for test in group] 757 758 if missing: 759 scripts = { 760 f for f in os.listdir(tlsfuzzer_scriptdir) if f != "__pycache__" 761 } 762 missing = scripts - set(tests) 763 if missing: 764 print('\n'.join(sorted(missing))) 765 exit(0) 766 767 tests.sort() 768 print('\n'.join(tests)) 769 exit(0) 770 771def usage(): 772 print("Usage: python3 tlsfuzzer.py [-flmnstv] [-p port] [script [test...]]") 773 print(" --help help") 774 print(" -f run failing tests") 775 print(" -l list tests") 776 print(" -m list new tests after package update") 777 print(" -n do not run tests, but list the ones that would be run") 778 print(" -p port connect to this port - defaults to 4433") 779 print(" -s run slow tests") 780 print(" -t show timing stats at end") 781 print(" -v verbose output") 782 exit(0) 783 784def main(): 785 failing = False 786 list = False 787 missing = False 788 dryrun = False 789 host = "localhost" 790 port = 4433 791 slow = False 792 timing = False 793 verbose = False 794 795 argv = sys.argv[1:] 796 opts, args = getopt.getopt(argv, "fh:lmnp:stv", ["help"]) 797 for opt, arg in opts: 798 if opt == '--help': 799 usage() 800 elif opt == '-f': 801 failing = True 802 elif opt == '-h': 803 host = arg 804 elif opt == '-l': 805 list = True 806 elif opt == '-m': 807 missing = True 808 elif opt == '-n': 809 dryrun = True 810 elif opt == '-p': 811 port = int(arg) 812 elif opt == '-s': 813 slow = True 814 elif opt == '-t': 815 timing = True 816 elif opt == '-v': 817 verbose = True 818 else: 819 raise ValueError(f"Unknown option: {opt}") 820 821 if not os.path.exists(tlsfuzzer_scriptdir): 822 print("package py3-tlsfuzzer is required for this regress") 823 exit(1) 824 825 if list and failing: 826 failing = [test.name for group in failing_groups for test in group] 827 failing.sort() 828 print('\n'.join(failing)) 829 exit(0) 830 831 if list or missing: 832 list_or_missing(missing) 833 834 tls_server = TlsServer(host, port) 835 836 tests = TestRunner(timing, verbose, host, port, tls_server.has_tls1_3, dryrun) 837 838 if args: 839 (dir, script) = os.path.split(args[0]) 840 if dir and not dir == '.': 841 tests.scriptdir = dir 842 843 testargs = defaultargs(script, tls_server.has_tls1_3) 844 845 tests.verbose = True 846 tests.add("test from command line", [Test(script, testargs + args[1:])]) 847 848 exit(not tests.run()) 849 850 if failing: 851 if tls_server.has_tls1_3: 852 tests.add_group(tls13_failing_tests) 853 if slow: 854 tests.add_group(tls13_slow_failing_tests) 855 tests.add_group(tls12_failing_tests) 856 857 if tls_server.has_tls1_3: 858 tests.add_group(tls13_tests) 859 if slow: 860 tests.add_group(tls13_slow_tests) 861 else: 862 tests.add_group(legacy_tests) 863 864 tests.add_group(tls12_tests) 865 if slow: 866 tests.add_group(tls12_slow_tests) 867 868 success = tests.run() 869 del tests 870 871 if not success: 872 print("FAILED") 873 exit(1) 874 875if __name__ == "__main__": 876 main() 877