244 lines
9.2 KiB
Python
244 lines
9.2 KiB
Python
# Author: Hubert Kario, (c) 2018
|
|
# Released under Gnu GPL v2.0, see LICENSE file for details
|
|
|
|
from __future__ import print_function
|
|
import traceback
|
|
import sys
|
|
import getopt
|
|
from itertools import chain
|
|
from random import sample
|
|
|
|
from tlsfuzzer.runner import Runner
|
|
from tlsfuzzer.messages import Connect, ClientHelloGenerator, \
|
|
ClientKeyExchangeGenerator, ChangeCipherSpecGenerator, \
|
|
FinishedGenerator, ApplicationDataGenerator, AlertGenerator
|
|
from tlsfuzzer.expect import ExpectServerHello, ExpectCertificate, \
|
|
ExpectServerHelloDone, ExpectChangeCipherSpec, ExpectFinished, \
|
|
ExpectAlert, ExpectApplicationData, ExpectClose, \
|
|
ExpectEncryptedExtensions, ExpectCertificateVerify, \
|
|
ExpectNewSessionTicket, srv_ext_handler_supp_vers, \
|
|
gen_srv_ext_handler_psk
|
|
|
|
from tlslite.constants import CipherSuite, AlertLevel, AlertDescription, \
|
|
TLS_1_3_DRAFT, GroupName, ExtensionType, SignatureScheme, \
|
|
PskKeyExchangeMode
|
|
from tlslite.keyexchange import ECDHKeyExchange
|
|
from tlsfuzzer.utils.lists import natural_sort_keys
|
|
from tlslite.utils.compat import a2b_hex, compatAscii2Bytes
|
|
from tlsfuzzer.utils.ordered_dict import OrderedDict
|
|
from tlslite.extensions import KeyShareEntry, ClientKeyShareExtension, \
|
|
SupportedVersionsExtension, SupportedGroupsExtension, \
|
|
SignatureAlgorithmsExtension, PskKeyExchangeModesExtension
|
|
from tlsfuzzer.helpers import key_share_gen, psk_ext_gen, psk_ext_updater
|
|
|
|
|
|
version = 4
|
|
|
|
|
|
def help_msg():
|
|
print("Usage: <script-name> [-h hostname] [-p port] [[probe-name] ...]")
|
|
print(" -h hostname name of the host to run the test against")
|
|
print(" localhost by default")
|
|
print(" -p port port number to use for connection, 4433 by default")
|
|
print(" probe-name if present, will run only the probes with given")
|
|
print(" names and not all of them, e.g \"sanity\"")
|
|
print(" -e probe-name exclude the probe from the list of the ones run")
|
|
print(" may be specified multiple times")
|
|
print(" -x probe-name expect the probe to fail. When such probe passes despite being marked like this")
|
|
print(" it will be reported in the test summary and the whole script will fail.")
|
|
print(" May be specified multiple times.")
|
|
print(" -X message expect the `message` substring in exception raised during")
|
|
print(" execution of preceding expected failure probe")
|
|
print(" usage: [-x probe-name] [-X exception], order is compulsory!")
|
|
print(" -n num run 'num' or all(if 0) tests instead of default(all)")
|
|
print(" (excluding \"sanity\" tests)")
|
|
print(" --psk psk hex encoded (without the 0x) value for the psk")
|
|
print(" secret supported by server")
|
|
print(" --psk-iden identity name associated with the secret configured in")
|
|
print(" server")
|
|
print(" --psk-sha384 use SHA-384 PRF for the PSK (SHA-256 is default)")
|
|
print(" --help this message")
|
|
|
|
|
|
def main():
|
|
host = "localhost"
|
|
port = 4433
|
|
num_limit = None
|
|
run_exclude = set()
|
|
expected_failures = {}
|
|
last_exp_tmp = None
|
|
psk_prf = "sha256"
|
|
psk_secret = b'\xaa'
|
|
psk_ident = b'test'
|
|
|
|
argv = sys.argv[1:]
|
|
opts, args = getopt.getopt(argv, "h:p:e:x:X:n:",
|
|
["help", "psk=", "psk-iden=", "psk-sha384"])
|
|
for opt, arg in opts:
|
|
if opt == '-h':
|
|
host = arg
|
|
elif opt == '-p':
|
|
port = int(arg)
|
|
elif opt == '-e':
|
|
run_exclude.add(arg)
|
|
elif opt == '-x':
|
|
expected_failures[arg] = None
|
|
last_exp_tmp = str(arg)
|
|
elif opt == '-X':
|
|
if not last_exp_tmp:
|
|
raise ValueError("-x has to be specified before -X")
|
|
expected_failures[last_exp_tmp] = str(arg)
|
|
elif opt == '-n':
|
|
num_limit = int(arg)
|
|
elif opt == '--help':
|
|
help_msg()
|
|
sys.exit(0)
|
|
elif opt == '--psk':
|
|
psk_secret = a2b_hex(arg)
|
|
elif opt == '--psk-iden':
|
|
psk_ident = compatAscii2Bytes(arg)
|
|
elif opt == '--psk-sha384':
|
|
psk_prf = "sha384"
|
|
else:
|
|
raise ValueError("Unknown option: {0}".format(opt))
|
|
|
|
if args:
|
|
run_only = set(args)
|
|
else:
|
|
run_only = None
|
|
|
|
conversations = {}
|
|
|
|
conversation = Connect(host, port)
|
|
node = conversation
|
|
ciphers = []
|
|
if psk_prf == "sha256":
|
|
ciphers.append(CipherSuite.TLS_AES_128_GCM_SHA256)
|
|
else:
|
|
ciphers.append(CipherSuite.TLS_AES_256_GCM_SHA384)
|
|
ext = OrderedDict()
|
|
ext[ExtensionType.supported_versions] = SupportedVersionsExtension()\
|
|
.create([TLS_1_3_DRAFT, (3, 3)])
|
|
ext[ExtensionType.psk_key_exchange_modes] = PskKeyExchangeModesExtension()\
|
|
.create([PskKeyExchangeMode.psk_ke])
|
|
psk_settings = [(psk_ident, psk_secret, psk_prf)]
|
|
ext[ExtensionType.pre_shared_key] = psk_ext_gen(psk_settings)
|
|
mods = []
|
|
mods.append(psk_ext_updater(psk_settings))
|
|
node = node.add_child(ClientHelloGenerator(ciphers, extensions=ext,
|
|
modifiers=mods))
|
|
ext = {}
|
|
ext[ExtensionType.supported_versions] = srv_ext_handler_supp_vers
|
|
ext[ExtensionType.pre_shared_key] = gen_srv_ext_handler_psk(psk_settings)
|
|
node = node.add_child(ExpectServerHello(extensions=ext))
|
|
node = node.add_child(ExpectChangeCipherSpec())
|
|
node = node.add_child(ExpectEncryptedExtensions())
|
|
node = node.add_child(ExpectFinished())
|
|
node = node.add_child(FinishedGenerator())
|
|
node = node.add_child(ApplicationDataGenerator(
|
|
bytearray(b"GET / HTTP/1.0\r\n\r\n")))
|
|
|
|
# This message is optional and may show up 0 to many times
|
|
cycle = ExpectNewSessionTicket()
|
|
node = node.add_child(cycle)
|
|
node.add_child(cycle)
|
|
|
|
node.next_sibling = ExpectApplicationData()
|
|
node = node.next_sibling.add_child(AlertGenerator(AlertLevel.warning,
|
|
AlertDescription.close_notify))
|
|
|
|
node = node.add_child(ExpectAlert())
|
|
node.next_sibling = ExpectClose()
|
|
conversations["sanity"] = conversation
|
|
|
|
# run the conversation
|
|
good = 0
|
|
bad = 0
|
|
xfail = 0
|
|
xpass = 0
|
|
failed = []
|
|
xpassed = []
|
|
if not num_limit:
|
|
num_limit = len(conversations)
|
|
|
|
# make sure that sanity test is run first and last
|
|
# to verify that server was running and kept running throughout
|
|
sanity_tests = [('sanity', conversations['sanity'])]
|
|
if run_only:
|
|
if num_limit > len(run_only):
|
|
num_limit = len(run_only)
|
|
regular_tests = [(k, v) for k, v in conversations.items() if
|
|
k in run_only]
|
|
else:
|
|
regular_tests = [(k, v) for k, v in conversations.items() if
|
|
(k != 'sanity') and k not in run_exclude]
|
|
sampled_tests = sample(regular_tests, min(num_limit, len(regular_tests)))
|
|
ordered_tests = chain(sanity_tests, sampled_tests, sanity_tests)
|
|
|
|
for c_name, c_test in ordered_tests:
|
|
if run_only and c_name not in run_only or c_name in run_exclude:
|
|
continue
|
|
print("{0} ...".format(c_name))
|
|
|
|
runner = Runner(c_test)
|
|
|
|
res = True
|
|
exception = None
|
|
try:
|
|
runner.run()
|
|
except Exception as exp:
|
|
exception = exp
|
|
print("Error while processing")
|
|
print(traceback.format_exc())
|
|
res = False
|
|
|
|
if c_name in expected_failures:
|
|
if res:
|
|
xpass += 1
|
|
xpassed.append(c_name)
|
|
print("XPASS-expected failure but test passed\n")
|
|
else:
|
|
if expected_failures[c_name] is not None and \
|
|
expected_failures[c_name] not in str(exception):
|
|
bad += 1
|
|
failed.append(c_name)
|
|
print("Expected error message: {0}\n"
|
|
.format(expected_failures[c_name]))
|
|
else:
|
|
xfail += 1
|
|
print("OK-expected failure\n")
|
|
else:
|
|
if res:
|
|
good += 1
|
|
print("OK\n")
|
|
else:
|
|
bad += 1
|
|
failed.append(c_name)
|
|
|
|
print("Basic script for psk_ke key exchange in TLS 1.3")
|
|
print("Check if server supports a PSK handshake without use of DHE key")
|
|
print("exchange.")
|
|
|
|
print("Test end")
|
|
print(20 * '=')
|
|
print("version: {0}".format(version))
|
|
print(20 * '=')
|
|
print("TOTAL: {0}".format(len(sampled_tests) + 2*len(sanity_tests)))
|
|
print("SKIP: {0}".format(len(run_exclude.intersection(conversations.keys()))))
|
|
print("PASS: {0}".format(good))
|
|
print("XFAIL: {0}".format(xfail))
|
|
print("FAIL: {0}".format(bad))
|
|
print("XPASS: {0}".format(xpass))
|
|
print(20 * '=')
|
|
sort = sorted(xpassed ,key=natural_sort_keys)
|
|
if len(sort):
|
|
print("XPASSED:\n\t{0}".format('\n\t'.join(repr(i) for i in sort)))
|
|
sort = sorted(failed, key=natural_sort_keys)
|
|
if len(sort):
|
|
print("FAILED:\n\t{0}".format('\n\t'.join(repr(i) for i in sort)))
|
|
|
|
if bad or xpass:
|
|
sys.exit(1)
|
|
|
|
if __name__ == "__main__":
|
|
main()
|