455 lines
20 KiB
Python
455 lines
20 KiB
Python
# Author: Simo Sorce, (c) 2018
|
|
# Released under Gnu GPL v2.0, see LICENSE file for details
|
|
"""Test with CertificateRequest"""
|
|
|
|
from __future__ import print_function
|
|
import traceback
|
|
import sys
|
|
import getopt
|
|
import re
|
|
from random import sample
|
|
from itertools import chain
|
|
|
|
from tlsfuzzer.runner import Runner
|
|
from tlsfuzzer.messages import Connect, ClientHelloGenerator, \
|
|
ClientKeyExchangeGenerator, ChangeCipherSpecGenerator, \
|
|
FinishedGenerator, ApplicationDataGenerator, \
|
|
CertificateGenerator, CertificateVerifyGenerator, \
|
|
AlertGenerator
|
|
from tlsfuzzer.expect import ExpectServerHello, ExpectCertificate, \
|
|
ExpectServerHelloDone, ExpectChangeCipherSpec, ExpectFinished, \
|
|
ExpectAlert, ExpectClose, ExpectCertificateRequest, \
|
|
ExpectApplicationData, ExpectEncryptedExtensions, \
|
|
ExpectCertificateVerify, ExpectNewSessionTicket
|
|
from tlsfuzzer.utils.lists import natural_sort_keys
|
|
from tlsfuzzer.helpers import key_share_gen, sig_algs_to_ids, RSA_SIG_ALL, \
|
|
expected_ext_parser, dict_update_non_present
|
|
from tlslite.extensions import SignatureAlgorithmsExtension, \
|
|
SignatureAlgorithmsCertExtension, ClientKeyShareExtension, \
|
|
SupportedVersionsExtension, SupportedGroupsExtension, \
|
|
StatusRequestExtension
|
|
from tlslite.constants import CipherSuite, AlertLevel, AlertDescription, \
|
|
HashAlgorithm, SignatureAlgorithm, ExtensionType, SignatureScheme, \
|
|
GroupName
|
|
from tlslite.utils.keyfactory import parsePEMKey
|
|
from tlslite.x509 import X509
|
|
from tlslite.x509certchain import X509CertChain
|
|
|
|
|
|
version = 9
|
|
|
|
|
|
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(" -n num run 'num' or all(if 0) tests instead of default(all)")
|
|
print(" (excluding \"sanity\" tests)")
|
|
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(" -s sigalgs hash and signature algorithm pairs that the server")
|
|
print(" is expected to support.")
|
|
print(" -k keyfile file with private key of client")
|
|
print(" -c certfile file with the certificate of client")
|
|
print(" -E ext_spec List of extensions that should be advertised by")
|
|
print(" the client (in addition to the basic ones required")
|
|
print(" to establish the connection). The ids can be")
|
|
print(" specified by name (\"status_request\") or by number")
|
|
print(" (\"5\"). After the ID specification there must be")
|
|
print(" included short names of the messages in which the")
|
|
print(" reply to extension needs to be included (\"CH\",")
|
|
print(" \"SH\", \"EE\", \"CT\", \"CR\", \"NST\", \"HRR\").")
|
|
print(" Extensions are separated by spaces, messages are")
|
|
print(" specified by colons, e.g.:")
|
|
print(" \"status_request:CH:CT:CR\".")
|
|
print(" Note: tlsfuzzer will try to create a sensible ")
|
|
print(" extension for extensions it know about, but will")
|
|
print(" create extension with empty payload for others.")
|
|
print(" Note: in this script, extensions marked CR will be")
|
|
print(" verified only in the \"verify extensions in ")
|
|
print(" CertificateRequest\" script. ")
|
|
print(" --help this message")
|
|
|
|
|
|
def main():
|
|
"""Check what signature algorithms server advertises"""
|
|
hostname = "localhost"
|
|
port = 4433
|
|
num_limit = None
|
|
run_exclude = set()
|
|
expected_failures = {}
|
|
last_exp_tmp = None
|
|
cert = None
|
|
private_key = None
|
|
ext_spec = {'CH': None, 'SH': None, 'EE': None, 'CT': None, 'CR': None,
|
|
'NST': None, 'HRR': None}
|
|
|
|
sigalgs = [SignatureScheme.ed25519,
|
|
SignatureScheme.ed448,
|
|
SignatureScheme.ecdsa_secp521r1_sha512,
|
|
SignatureScheme.ecdsa_secp384r1_sha384,
|
|
SignatureScheme.ecdsa_secp256r1_sha256,
|
|
(HashAlgorithm.sha224, SignatureAlgorithm.ecdsa),
|
|
(HashAlgorithm.sha1, SignatureAlgorithm.ecdsa),
|
|
SignatureScheme.rsa_pss_rsae_sha512,
|
|
SignatureScheme.rsa_pss_pss_sha512,
|
|
SignatureScheme.rsa_pss_rsae_sha384,
|
|
SignatureScheme.rsa_pss_pss_sha384,
|
|
SignatureScheme.rsa_pss_rsae_sha256,
|
|
SignatureScheme.rsa_pss_pss_sha256,
|
|
SignatureScheme.rsa_pkcs1_sha512,
|
|
SignatureScheme.rsa_pkcs1_sha384,
|
|
SignatureScheme.rsa_pkcs1_sha256,
|
|
SignatureScheme.rsa_pkcs1_sha224,
|
|
SignatureScheme.rsa_pkcs1_sha1]
|
|
|
|
argv = sys.argv[1:]
|
|
opts, args = getopt.getopt(argv, "h:p:e:x:X:s:k:c:E:", ["help"])
|
|
for opt, arg in opts:
|
|
if opt == '-h':
|
|
hostname = arg
|
|
elif opt == '-p':
|
|
port = int(arg)
|
|
elif opt == '-e':
|
|
run_exclude.add(arg)
|
|
elif opt == '-n':
|
|
num_limit = int(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 == '--help':
|
|
help_msg()
|
|
sys.exit(0)
|
|
elif opt == '-s':
|
|
sigalgs = sig_algs_to_ids(arg)
|
|
elif opt == '-E':
|
|
ext_spec = expected_ext_parser(arg)
|
|
elif opt == '-k':
|
|
text_key = open(arg, 'rb').read()
|
|
if sys.version_info[0] >= 3:
|
|
text_key = str(text_key, 'utf-8')
|
|
private_key = parsePEMKey(text_key, private=True)
|
|
elif opt == '-c':
|
|
text_cert = open(arg, 'rb').read()
|
|
if sys.version_info[0] >= 3:
|
|
text_cert = str(text_cert, 'utf-8')
|
|
cert = X509()
|
|
cert.parse(text_cert)
|
|
else:
|
|
raise ValueError("Unknown option: {0}".format(opt))
|
|
|
|
if args:
|
|
run_only = set(args)
|
|
else:
|
|
run_only = None
|
|
|
|
conversations = {}
|
|
|
|
# sanity check for Client Certificates
|
|
conversation = Connect(hostname, port)
|
|
node = conversation
|
|
ciphers = [CipherSuite.TLS_AES_128_GCM_SHA256,
|
|
CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV]
|
|
ext = {}
|
|
groups = [GroupName.secp256r1]
|
|
key_shares = []
|
|
for group in groups:
|
|
key_shares.append(key_share_gen(group))
|
|
ext[ExtensionType.key_share] = \
|
|
ClientKeyShareExtension().create(key_shares)
|
|
ext[ExtensionType.supported_versions] = \
|
|
SupportedVersionsExtension().create([(3, 4), (3, 3)])
|
|
ext[ExtensionType.supported_groups] = \
|
|
SupportedGroupsExtension().create(groups)
|
|
sig_algs = [SignatureScheme.rsa_pss_rsae_sha256,
|
|
SignatureScheme.rsa_pss_pss_sha256]
|
|
ext[ExtensionType.signature_algorithms] = \
|
|
SignatureAlgorithmsExtension().create(sig_algs)
|
|
ext[ExtensionType.signature_algorithms_cert] = \
|
|
SignatureAlgorithmsCertExtension().create(RSA_SIG_ALL)
|
|
ext = dict_update_non_present(ext, ext_spec['CH'])
|
|
node = node.add_child(ClientHelloGenerator(ciphers, extensions=ext))
|
|
ext = dict_update_non_present(None, ext_spec['SH'])
|
|
node = node.add_child(ExpectServerHello(extensions=ext))
|
|
node = node.add_child(ExpectChangeCipherSpec())
|
|
ext = dict_update_non_present(None, ext_spec['EE'])
|
|
node = node.add_child(ExpectEncryptedExtensions(extensions=ext))
|
|
node = node.add_child(ExpectCertificateRequest())
|
|
node = node.add_child(ExpectCertificate())
|
|
node = node.add_child(ExpectCertificateVerify())
|
|
node = node.add_child(ExpectFinished())
|
|
node = node.add_child(CertificateGenerator())
|
|
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
|
|
|
|
if cert and private_key:
|
|
# sanity check for Client Certificates
|
|
conversation = Connect(hostname, port)
|
|
node = conversation
|
|
ciphers = [CipherSuite.TLS_AES_128_GCM_SHA256,
|
|
CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV]
|
|
ext = {}
|
|
groups = [GroupName.secp256r1]
|
|
key_shares = []
|
|
for group in groups:
|
|
key_shares.append(key_share_gen(group))
|
|
ext[ExtensionType.key_share] = \
|
|
ClientKeyShareExtension().create(key_shares)
|
|
ext[ExtensionType.supported_versions] = \
|
|
SupportedVersionsExtension().create([(3, 4), (3, 3)])
|
|
ext[ExtensionType.supported_groups] = \
|
|
SupportedGroupsExtension().create(groups)
|
|
sig_algs = [SignatureScheme.rsa_pss_rsae_sha256,
|
|
SignatureScheme.rsa_pss_pss_sha256]
|
|
ext[ExtensionType.signature_algorithms] = \
|
|
SignatureAlgorithmsExtension().create(sig_algs)
|
|
ext[ExtensionType.signature_algorithms_cert] = \
|
|
SignatureAlgorithmsCertExtension().create(RSA_SIG_ALL)
|
|
ext = dict_update_non_present(ext, ext_spec['CH'])
|
|
node = node.add_child(ClientHelloGenerator(ciphers, extensions=ext))
|
|
ext = dict_update_non_present(None, ext_spec['SH'])
|
|
node = node.add_child(ExpectServerHello(extensions=ext))
|
|
node = node.add_child(ExpectChangeCipherSpec())
|
|
ext = dict_update_non_present(None, ext_spec['EE'])
|
|
node = node.add_child(ExpectEncryptedExtensions(extensions=ext))
|
|
node = node.add_child(ExpectCertificateRequest())
|
|
node = node.add_child(ExpectCertificate())
|
|
node = node.add_child(ExpectCertificateVerify())
|
|
node = node.add_child(ExpectFinished())
|
|
node = node.add_child(CertificateGenerator(X509CertChain([cert])))
|
|
node = node.add_child(CertificateVerifyGenerator(private_key))
|
|
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["with certificate"] = conversation
|
|
|
|
# verify the advertised hashes
|
|
conversation = Connect(hostname, port)
|
|
node = conversation
|
|
ciphers = [CipherSuite.TLS_AES_128_GCM_SHA256,
|
|
CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV]
|
|
ext = {}
|
|
groups = [GroupName.secp256r1]
|
|
key_shares = []
|
|
for group in groups:
|
|
key_shares.append(key_share_gen(group))
|
|
ext[ExtensionType.key_share] = \
|
|
ClientKeyShareExtension().create(key_shares)
|
|
ext[ExtensionType.supported_versions] = \
|
|
SupportedVersionsExtension().create([(3, 4), (3, 3)])
|
|
ext[ExtensionType.supported_groups] = \
|
|
SupportedGroupsExtension().create(groups)
|
|
sig_algs = [SignatureScheme.rsa_pss_rsae_sha256,
|
|
SignatureScheme.rsa_pss_pss_sha256]
|
|
ext[ExtensionType.signature_algorithms] = \
|
|
SignatureAlgorithmsExtension().create(sig_algs)
|
|
ext[ExtensionType.signature_algorithms_cert] = \
|
|
SignatureAlgorithmsCertExtension().create(RSA_SIG_ALL)
|
|
ext = dict_update_non_present(ext, ext_spec['CH'])
|
|
node = node.add_child(ClientHelloGenerator(ciphers, extensions=ext))
|
|
ext = dict_update_non_present(None, ext_spec['SH'])
|
|
node = node.add_child(ExpectServerHello(extensions=ext))
|
|
node = node.add_child(ExpectChangeCipherSpec())
|
|
ext = dict_update_non_present(None, ext_spec['EE'])
|
|
node = node.add_child(ExpectEncryptedExtensions(extensions=ext))
|
|
node = node.add_child(ExpectCertificateRequest(sigalgs))
|
|
# extensions are not yet supported in Certificate messages
|
|
node = node.add_child(ExpectCertificate())
|
|
node = node.add_child(ExpectCertificateVerify())
|
|
node = node.add_child(ExpectFinished())
|
|
node = node.add_child(CertificateGenerator())
|
|
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["check sigalgs in cert request"] = conversation
|
|
|
|
# verify the sent extensions
|
|
conversation = Connect(hostname, port)
|
|
node = conversation
|
|
ciphers = [CipherSuite.TLS_AES_128_GCM_SHA256,
|
|
CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV]
|
|
ext = {}
|
|
groups = [GroupName.secp256r1]
|
|
key_shares = []
|
|
for group in groups:
|
|
key_shares.append(key_share_gen(group))
|
|
ext[ExtensionType.key_share] = \
|
|
ClientKeyShareExtension().create(key_shares)
|
|
ext[ExtensionType.supported_versions] = \
|
|
SupportedVersionsExtension().create([(3, 4), (3, 3)])
|
|
ext[ExtensionType.supported_groups] = \
|
|
SupportedGroupsExtension().create(groups)
|
|
sig_algs = [SignatureScheme.rsa_pss_rsae_sha256,
|
|
SignatureScheme.rsa_pss_pss_sha256]
|
|
ext[ExtensionType.signature_algorithms] = \
|
|
SignatureAlgorithmsExtension().create(sig_algs)
|
|
ext[ExtensionType.signature_algorithms_cert] = \
|
|
SignatureAlgorithmsCertExtension().create(RSA_SIG_ALL)
|
|
ext = dict_update_non_present(ext, ext_spec['CH'])
|
|
node = node.add_child(ClientHelloGenerator(ciphers, extensions=ext))
|
|
ext = dict_update_non_present(None, ext_spec['SH'])
|
|
node = node.add_child(ExpectServerHello(extensions=ext))
|
|
node = node.add_child(ExpectChangeCipherSpec())
|
|
node = node.add_child(ExpectEncryptedExtensions())
|
|
ext = {ExtensionType.signature_algorithms:
|
|
SignatureAlgorithmsExtension().create(sigalgs)}
|
|
ext = dict_update_non_present(ext, ext_spec['CR'])
|
|
node = node.add_child(ExpectCertificateRequest(extensions=ext))
|
|
node = node.add_child(ExpectCertificate())
|
|
node = node.add_child(ExpectCertificateVerify())
|
|
node = node.add_child(ExpectFinished())
|
|
node = node.add_child(CertificateGenerator())
|
|
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["verify extensions in CertificateRequest"] = 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("Test to verify if server accepts empty certificate messages and")
|
|
print("advertises only expected signature algotithms and extensions in ")
|
|
print("Certificate Request message\n")
|
|
|
|
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()
|