1# $OpenBSD: tlsfuzzer.py,v 1.46 2022/07/18 08:36:47 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, self.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", [ "--exc", "57" ]), 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", "--exc", "57"], 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 # needs an echo server 302 Test("test-tls13-lengths.py"), 303 304 # Weird test: tests servers that don't support 1.3 305 Test("test-tls13-non-support.py"), 306 307 # broken test script 308 # UnboundLocalError: local variable 'cert' referenced before assignment 309 Test("test-tls13-post-handshake-auth.py"), 310 311 # ExpectNewSessionTicket 312 Test("test-tls13-session-resumption.py"), 313 314 # Server must be configured to support only rsa_pss_rsae_sha512 315 Test("test-tls13-signature-algorithms.py"), 316]) 317 318tls12_exclude_legacy_protocols = [ 319 # all these have BIO_read timeouts against TLSv1.3 320 "-e", "Protocol (3, 0)", 321 "-e", "Protocol (3, 0) in SSLv2 compatible ClientHello", 322 # the following only fail with TLSv1.3 323 "-e", "Protocol (3, 1) in SSLv2 compatible ClientHello", 324 "-e", "Protocol (3, 2) in SSLv2 compatible ClientHello", 325 "-e", "Protocol (3, 3) in SSLv2 compatible ClientHello", 326 "-e", "Protocol (3, 1) with x448 group", 327 "-e", "Protocol (3, 2) with x448 group", 328 "-e", "Protocol (3, 3) with x448 group", 329] 330 331tls12_tests = TestGroup("TLSv1.2 tests", [ 332 # Tests that pass as they are. 333 Test("test-TLSv1_2-rejected-without-TLSv1_2.py"), 334 Test("test-aes-gcm-nonces.py"), 335 Test("test-chacha20.py"), 336 Test("test-conversation.py"), 337 Test("test-cve-2016-2107.py"), 338 Test("test-cve-2016-6309.py"), 339 Test("test-dhe-rsa-key-exchange.py"), 340 Test("test-dhe-rsa-key-exchange-with-bad-messages.py"), 341 Test("test-early-application-data.py"), 342 Test("test-empty-extensions.py"), 343 Test("test-extensions.py"), 344 Test("test-fuzzed-MAC.py"), 345 Test("test-fuzzed-ciphertext.py"), 346 Test("test-fuzzed-finished.py"), 347 Test("test-fuzzed-padding.py"), 348 Test("test-fuzzed-plaintext.py"), # fails once in a while 349 Test("test-hello-request-by-client.py"), 350 Test("test-invalid-cipher-suites.py"), 351 Test("test-invalid-content-type.py"), 352 Test("test-invalid-session-id.py"), 353 Test("test-invalid-version.py"), 354 Test("test-lucky13.py"), 355 Test("test-message-skipping.py"), 356 Test("test-no-heartbeat.py"), 357 Test("test-record-layer-fragmentation.py"), 358 Test("test-sessionID-resumption.py"), 359 Test("test-sslv2-connection.py"), 360 Test("test-truncating-of-finished.py"), 361 Test("test-truncating-of-kRSA-client-key-exchange.py"), 362 Test("test-unsupported-curve-fallback.py"), 363 Test("test-version-numbers.py"), 364 Test("test-zero-length-data.py"), 365 366 # Tests that need tweaking for unsupported features and ciphers. 367 Test( 368 "test-atypical-padding.py", [ 369 "-e", "sanity - encrypt then MAC", 370 "-e", "2^14 bytes of AppData with 256 bytes of padding (SHA1 + Encrypt then MAC)", 371 ] 372 ), 373 Test( 374 "test-dhe-rsa-key-exchange-signatures.py", [ 375 "-e", "TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA sha224 signature", 376 "-e", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 sha224 signature", 377 "-e", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA sha224 signature", 378 "-e", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 sha224 signature", 379 "-e", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA sha224 signature", 380 ] 381 ), 382 Test("test-dhe-key-share-random.py", tls12_exclude_legacy_protocols), 383 Test("test-export-ciphers-rejected.py", ["--min-ver", "TLSv1.0"]), 384 Test( 385 "test-downgrade-protection.py", 386 tls12_args = ["--server-max-protocol", "TLSv1.2"], 387 tls13_args = ["--server-max-protocol", "TLSv1.3"], 388 ), 389 Test("test-fallback-scsv.py", tls13_args = ["--tls-1.3"] ), 390 391 Test("test-invalid-compression-methods.py", [ 392 "-x", "invalid compression methods", 393 "-X", substitute_alert("illegal_parameter", "decode_error"), 394 "-x", "only deflate compression method", 395 "-X", substitute_alert("illegal_parameter", "decode_error"), 396 ]), 397 398 # Skip extended_master_secret test. Since we don't support this 399 # extension, we don't notice that it was dropped. 400 Test("test-renegotiation-changed-clienthello.py", [ 401 "-e", "drop extended_master_secret in renegotiation", 402 ]), 403 404 # Without --sig-algs-drop-ok, two tests fail since we do not currently 405 # implement the signature_algorithms_cert extension (although we MUST). 406 Test("test-sig-algs-renegotiation-resumption.py", ["--sig-algs-drop-ok"]), 407 408 Test("test-serverhello-random.py", args = tls12_exclude_legacy_protocols), 409]) 410 411tls12_slow_tests = TestGroup("slow TLSv1.2 tests", [ 412 Test("test-cve-2016-7054.py"), 413 Test("test-dhe-no-shared-secret-padding.py", tls12_exclude_legacy_protocols), 414 Test("test-ecdhe-padded-shared-secret.py", tls12_exclude_legacy_protocols), 415 Test("test-ecdhe-rsa-key-share-random.py", tls12_exclude_legacy_protocols), 416 Test("test-large-hello.py", [ "-m", "58" ]), 417]) 418 419tls12_failing_tests = TestGroup("failing TLSv1.2 tests", [ 420 # no shared cipher 421 Test("test-aesccm.py"), 422 # need server to set up alpn 423 Test("test-alpn-negotiation.py"), 424 # many tests fail due to unexpected server_name extension 425 Test("test-bleichenbacher-workaround.py"), 426 427 # need client key and cert plus extra server setup 428 Test("test-certificate-malformed.py"), 429 Test("test-certificate-request.py"), 430 Test("test-certificate-verify-malformed-sig.py"), 431 Test("test-certificate-verify-malformed.py"), 432 Test("test-certificate-verify.py"), 433 Test("test-ecdsa-in-certificate-verify.py"), 434 Test("test-eddsa-in-certificate-verify.py"), 435 Test("test-renegotiation-disabled-client-cert.py"), 436 Test("test-rsa-pss-sigs-on-certificate-verify.py"), 437 Test("test-rsa-sigs-on-certificate-verify.py"), 438 439 # test doesn't expect session ticket 440 Test("test-client-compatibility.py"), 441 # abrupt closure 442 Test("test-client-hello-max-size.py"), 443 # unknown signature algorithms 444 Test("test-clienthello-md5.py"), 445 446 # Tests expect an illegal_parameter or a decode_error alert. Should be 447 # added to ssl3_get_client_key_exchange on kex function failure. 448 Test("test-ecdhe-rsa-key-exchange-with-bad-messages.py"), 449 450 # We send a handshake_failure due to no shared ciphers while the 451 # test expects to succeed. 452 Test("test-ecdhe-rsa-key-exchange.py"), 453 454 # no shared cipher 455 Test("test-ecdsa-sig-flexibility.py"), 456 457 # Tests expect SH but we send unexpected_message or handshake_failure 458 # 'Application data inside Client Hello' 459 # 'Application data inside Client Key Exchange' 460 # 'Application data inside Finished' 461 Test("test-interleaved-application-data-and-fragmented-handshakes-in-renegotiation.py"), 462 # Tests expect SH but we send handshake_failure 463 # 'Application data before Change Cipher Spec' 464 # 'Application data before Client Key Exchange' 465 # 'Application data before Finished' 466 Test("test-interleaved-application-data-in-renegotiation.py"), 467 468 # broken test script 469 # TypeError: '<' not supported between instances of 'int' and 'NoneType' 470 Test("test-invalid-client-hello-w-record-overflow.py"), 471 472 # Lots of failures. abrupt closure 473 Test("test-invalid-client-hello.py"), 474 475 # abrupt closure 476 # 'encrypted premaster set to all zero (n)' n in 256 384 512 477 Test("test-invalid-rsa-key-exchange-messages.py"), 478 479 # test expects illegal_parameter, we send unrecognized_name (which seems 480 # correct according to rfc 6066?) 481 Test("test-invalid-server-name-extension-resumption.py"), 482 # let through some server names without sending an alert 483 # again illegal_parameter vs unrecognized_name 484 Test("test-invalid-server-name-extension.py"), 485 486 # 14 pass 487 # 7 fail 488 # 'n extensions', n in 4095, 4096, 4097, 8191, 8192, 8193, 16383, 489 Test("test-large-number-of-extensions.py"), 490 491 # 4 failures: 492 # 'insecure (legacy) renegotiation with GET after 2nd handshake' 493 # 'insecure (legacy) renegotiation with incomplete GET' 494 # 'secure renegotiation with GET after 2nd handshake' 495 # 'secure renegotiation with incomplete GET' 496 Test("test-legacy-renegotiation.py"), 497 498 # 1 failure (timeout): we don't send the unexpected_message alert 499 # 'duplicate change cipher spec after Finished' 500 Test("test-message-duplication.py"), 501 502 # server should send status_request 503 Test("test-ocsp-stapling.py"), 504 505 # unexpected closure 506 Test("test-openssl-3712.py"), 507 508 # failed: 3 (expect an alert, we send AD) 509 # 'try insecure (legacy) renegotiation with incomplete GET' 510 # 'try secure renegotiation with GET after 2nd CH' 511 # 'try secure renegotiation with incomplete GET' 512 Test("test-renegotiation-disabled.py"), 513 514 # 'resumption of safe session with NULL cipher' 515 # 'resumption with cipher from old CH but not selected by server' 516 Test("test-resumption-with-wrong-ciphers.py"), 517 518 # 5 failures: 519 # 'empty sigalgs' 520 # 'only undefined sigalgs' 521 # 'rsa_pss_pss_sha256 only' 522 # 'rsa_pss_pss_sha384 only' 523 # 'rsa_pss_pss_sha512 only' 524 Test("test-sig-algs.py"), 525 526 # 13 failures: 527 # 'duplicated n non-rsa schemes' for n in 202 2342 8119 23741 32744 528 # 'empty list of signature methods' 529 # 'tolerance n RSA or ECDSA methods' for n in 215 2355 8132 23754 530 # 'tolerance 32758 methods with sig_alg_cert' 531 # 'tolerance max 32744 number of methods with sig_alg_cert' 532 # 'tolerance max (32760) number of methods' 533 Test("test-signature-algorithms.py"), 534 535 # times out 536 Test("test-ssl-death-alert.py"), 537 538 # 17 pass, 13 fail. padding and truncation 539 Test("test-truncating-of-client-hello.py"), 540 541 # x448 tests need disabling plus x25519 corner cases need sorting out 542 Test("test-x25519.py"), 543]) 544 545tls12_unsupported_tests = TestGroup("TLSv1.2 for unsupported features", [ 546 # protocol_version 547 Test("test-SSLv3-padding.py"), 548 # we don't do RSA key exchanges 549 Test("test-bleichenbacher-timing.py"), 550 # no encrypt-then-mac 551 Test("test-encrypt-then-mac-renegotiation.py"), 552 Test("test-encrypt-then-mac.py"), 553 # no EME support 554 Test("test-extended-master-secret-extension-with-client-cert.py"), 555 Test("test-extended-master-secret-extension.py"), 556 # no ffdhe 557 Test("test-ffdhe-expected-params.py"), 558 Test("test-ffdhe-negotiation.py"), 559 # record_size_limit/max_fragment_length extension (RFC 8449) 560 Test("test-record-size-limit.py"), 561 # expects the server to send the heartbeat extension 562 Test("test-heartbeat.py"), 563 # needs an echo server 564 Test("test-lengths.py"), 565]) 566 567# These tests take a ton of time to fail against an 1.3 server, 568# so don't run them against 1.3 pending further investigation. 569legacy_tests = TestGroup("Legacy protocol tests", [ 570 Test("test-sslv2-force-cipher-3des.py"), 571 Test("test-sslv2-force-cipher-non3des.py"), 572 Test("test-sslv2-force-cipher.py"), 573 Test("test-sslv2-force-export-cipher.py"), 574 Test("test-sslv2hello-protocol.py"), 575]) 576 577all_groups = [ 578 tls13_tests, 579 tls13_slow_tests, 580 tls13_extra_cert_tests, 581 tls13_failing_tests, 582 tls13_slow_failing_tests, 583 tls13_unsupported_tests, 584 tls12_tests, 585 tls12_slow_tests, 586 tls12_failing_tests, 587 tls12_unsupported_tests, 588 legacy_tests, 589] 590 591failing_groups = [ 592 tls13_failing_tests, 593 tls13_slow_failing_tests, 594 tls12_failing_tests, 595] 596 597class TestRunner: 598 """ Runs the given tests troups against a server and displays stats. """ 599 600 def __init__( 601 self, timing=False, verbose=False, host="localhost", port=4433, 602 use_tls1_3=True, dry_run=False, tests=[], scriptdir=tlsfuzzer_scriptdir, 603 ): 604 self.tests = [] 605 606 self.dryrun = dry_run 607 self.use_tls1_3 = use_tls1_3 608 self.host = host 609 self.port = str(port) 610 self.scriptdir = scriptdir 611 612 self.stats = [] 613 self.failed = [] 614 self.missing = [] 615 616 self.timing = timing 617 self.verbose = verbose 618 619 def add(self, title="tests", tests=[]): 620 # tests.sort(key=lambda test: test.name) 621 self.tests.append(TestGroup(title, tests)) 622 623 def add_group(self, group): 624 self.tests.append(group) 625 626 def run_script(self, test): 627 script = test.name 628 args = ["-h"] + [self.host] + ["-p"] + [self.port] + test.args(self.use_tls1_3) 629 630 if self.dryrun: 631 if not self.verbose: 632 args = [] 633 print(script , end=' ' if args else '') 634 print(' '.join([f"\"{arg}\"" for arg in args])) 635 return 636 637 if self.verbose: 638 print(script) 639 else: 640 print(f"{script[:68]:<72}", end=" ", flush=True) 641 start = timer() 642 scriptpath = os.path.join(self.scriptdir, script) 643 if not os.path.exists(scriptpath): 644 self.missing.append(script) 645 print("MISSING") 646 return 647 test = subprocess.run( 648 ["python3", scriptpath] + args, 649 capture_output=not self.verbose, 650 text=True, 651 ) 652 end = timer() 653 self.stats.append((script, end - start)) 654 if test.returncode == 0: 655 print("OK") 656 return 657 print("FAILED") 658 self.failed.append(script) 659 660 if self.verbose: 661 return 662 663 print('\n'.join(test.stdout.split("Test end\n", 1)[1:]), end="") 664 665 def run(self): 666 for group in self: 667 print(f"Running {group.title} ...") 668 for test in group: 669 self.run_script(test) 670 return not self.failed 671 672 def __iter__(self): 673 return iter(self.tests) 674 675 def __del__(self): 676 if self.timing and self.stats: 677 total = 0.0 678 for (script, time) in self.stats: 679 print(f"{round(time, 2):6.2f} {script}") 680 total += time 681 print(f"{round(total, 2):6.2f} total") 682 683 if self.failed: 684 print("Failed tests:") 685 print('\n'.join(self.failed)) 686 687 if self.missing: 688 print("Missing tests (outdated package?):") 689 print('\n'.join(self.missing)) 690 691class TlsServer: 692 """ Spawns an s_server listening on localhost:port if necessary. """ 693 694 def __init__(self, host="localhost", port=4433): 695 self.spawn = True 696 # Check whether a server is already listening on localhost:port 697 self.spawn = subprocess.run( 698 ["nc", "-c", "-z", "-T", "noverify", host, str(port)], 699 stderr=subprocess.DEVNULL, 700 ).returncode != 0 701 702 if self.spawn: 703 self.server = subprocess.Popen( 704 [ 705 "openssl", 706 "s_server", 707 "-accept", 708 str(port), 709 "-groups", 710 "X25519:P-256:P-521:P-384", 711 "-key", 712 "localhost.key", 713 "-cert", 714 "localhost.crt", 715 "-www", 716 ], 717 stdout=subprocess.DEVNULL, 718 stderr=subprocess.PIPE, 719 text=True, 720 ) 721 722 # Check whether the server talks TLSv1.3 723 self.has_tls1_3 = True or subprocess.run( 724 [ 725 "nc", 726 "-c", 727 "-z", 728 "-T", 729 "noverify", 730 "-T", 731 "protocols=TLSv1.3", 732 "localhost", 733 str(port), 734 ], 735 stderr=subprocess.DEVNULL, 736 ).returncode == 0 737 738 self.check() 739 740 def check(self): 741 if self.spawn and self.server.poll() is not None: 742 print(self.server.stderr.read()) 743 raise RuntimeError( 744 f"openssl s_server died. Return code: {self.server.returncode}." 745 ) 746 if self.spawn: 747 self.server.stderr.detach() 748 749 def __del__(self): 750 if self.spawn: 751 self.server.terminate() 752 753# Extract the arguments we pass to script 754def defaultargs(script, has_tls1_3): 755 return next( 756 (test for group in all_groups for test in group if test.name == script), 757 Test() 758 ).args(has_tls1_3) 759 760def list_or_missing(missing=True): 761 tests = [test.name for group in all_groups for test in group] 762 763 if missing: 764 scripts = { 765 f for f in os.listdir(tlsfuzzer_scriptdir) if f != "__pycache__" 766 } 767 missing = scripts - set(tests) 768 if missing: 769 print('\n'.join(sorted(missing))) 770 exit(0) 771 772 tests.sort() 773 print('\n'.join(tests)) 774 exit(0) 775 776def usage(): 777 print("Usage: python3 tlsfuzzer.py [-flmnstv] [-p port] [script [test...]]") 778 print(" --help help") 779 print(" -f run failing tests") 780 print(" -l list tests") 781 print(" -m list new tests after package update") 782 print(" -n do not run tests, but list the ones that would be run") 783 print(" -p port connect to this port - defaults to 4433") 784 print(" -s run slow tests") 785 print(" -t show timing stats at end") 786 print(" -v verbose output") 787 exit(0) 788 789def main(): 790 failing = False 791 list = False 792 missing = False 793 dryrun = False 794 host = "localhost" 795 port = 4433 796 slow = False 797 timing = False 798 verbose = False 799 800 argv = sys.argv[1:] 801 opts, args = getopt.getopt(argv, "fh:lmnp:stv", ["help"]) 802 for opt, arg in opts: 803 if opt == '--help': 804 usage() 805 elif opt == '-f': 806 failing = True 807 elif opt == '-h': 808 host = arg 809 elif opt == '-l': 810 list = True 811 elif opt == '-m': 812 missing = True 813 elif opt == '-n': 814 dryrun = True 815 elif opt == '-p': 816 port = int(arg) 817 elif opt == '-s': 818 slow = True 819 elif opt == '-t': 820 timing = True 821 elif opt == '-v': 822 verbose = True 823 else: 824 raise ValueError(f"Unknown option: {opt}") 825 826 if not os.path.exists(tlsfuzzer_scriptdir): 827 print("package py3-tlsfuzzer is required for this regress") 828 exit(1) 829 830 if list and failing: 831 failing = [test.name for group in failing_groups for test in group] 832 failing.sort() 833 print('\n'.join(failing)) 834 exit(0) 835 836 if list or missing: 837 list_or_missing(missing) 838 839 tls_server = TlsServer(host, port) 840 841 tests = TestRunner(timing, verbose, host, port, tls_server.has_tls1_3, dryrun) 842 843 if args: 844 (dir, script) = os.path.split(args[0]) 845 if dir and not dir == '.': 846 tests.scriptdir = dir 847 848 testargs = defaultargs(script, tls_server.has_tls1_3) 849 850 tests.verbose = True 851 tests.add("test from command line", [Test(script, testargs + args[1:])]) 852 853 exit(not tests.run()) 854 855 if failing: 856 if tls_server.has_tls1_3: 857 tests.add_group(tls13_failing_tests) 858 if slow: 859 tests.add_group(tls13_slow_failing_tests) 860 tests.add_group(tls12_failing_tests) 861 862 if tls_server.has_tls1_3: 863 tests.add_group(tls13_tests) 864 if slow: 865 tests.add_group(tls13_slow_tests) 866 else: 867 tests.add_group(legacy_tests) 868 869 tests.add_group(tls12_tests) 870 if slow: 871 tests.add_group(tls12_slow_tests) 872 873 success = tests.run() 874 del tests 875 876 if not success: 877 print("FAILED") 878 exit(1) 879 880if __name__ == "__main__": 881 main() 882