Skip to content

Commit

Permalink
Merge pull request tlsfuzzer#830 from tlsfuzzer/ccs-test.py
Browse files Browse the repository at this point in the history
more test coverage for CCS
  • Loading branch information
tomato42 authored Aug 1, 2023
2 parents 67e5e23 + 337bfe9 commit bdf7c20
Show file tree
Hide file tree
Showing 7 changed files with 412 additions and 28 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -287,9 +287,9 @@ jobs:
- name: Install dependencies (2.6)
if: ${{ matrix.python-version == '2.6' }}
run: |
wget https://files.pythonhosted.org/packages/9a/16/70b836e6523ca296ada4b597c985b96b10cb4435f768ec650aea833c517a/tlslite-ng-0.8.0-alpha43.tar.gz
wget https://files.pythonhosted.org/packages/7c/c9/f4a2146789a4f5161d59a597963a0a2b015a95ed25911da36acf3555c8fa/tlslite-ng-0.8.0a45.tar.gz
wget https://files.pythonhosted.org/packages/b4/4c/f8b4ed6c61dff52294f98aaf99053dd979c1b4233d953f371afb0a2977a1/ecdsa-0.18.0b2-py2.py3-none-any.whl
pip install tlslite-ng-0.8.0-alpha43.tar.gz ecdsa-0.18.0b2-py2.py3-none-any.whl
pip install tlslite-ng-0.8.0a45.tar.gz ecdsa-0.18.0b2-py2.py3-none-any.whl
- name: Install dependencies
if: ${{ matrix.python-version != '2.6' }}
run: pip install -r requirements.txt
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You'll need:

* Python 2.6 or later or Python 3.5 or later
* [tlslite-ng](https://github.com/tlsfuzzer/tlslite-ng)
0.8.0-alpha40 or later (note that `tlslite` will *not* work and
0.8.0-alpha45 or later (note that `tlslite` will *not* work and
they conflict with each other)
* [ecdsa](https://github.com/warner/python-ecdsa)
python module (dependency of tlslite-ng, should get installed
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
tlslite-ng==0.8.0-alpha44
tlslite-ng==0.8.0-alpha45
286 changes: 286 additions & 0 deletions scripts/test-ccs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,286 @@
# Author: Hubert Kario, (c) 2015-2023
# 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, \
RawMessageGenerator
from tlsfuzzer.expect import ExpectServerHello, ExpectCertificate, \
ExpectServerHelloDone, ExpectChangeCipherSpec, ExpectFinished, \
ExpectAlert, ExpectApplicationData, ExpectClose, \
ExpectServerKeyExchange


from tlslite.constants import CipherSuite, AlertLevel, AlertDescription, \
GroupName, ExtensionType, ContentType
from tlslite.extensions import SupportedGroupsExtension, \
SignatureAlgorithmsExtension, SignatureAlgorithmsCertExtension
from tlsfuzzer.utils.lists import natural_sort_keys
from tlsfuzzer.helpers import SIG_ALL, AutoEmptyExtension


version = 1


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(" (\"sanity\" tests are always executed)")
print(" -d negotiate (EC)DHE instead of RSA key exchange, send")
print(" additional extensions, usually used for (EC)DHE ciphers")
print(" -C ciph Use specified ciphersuite. Either numerical value or")
print(" IETF name.")
print(" -M | --ems Advertise support for Extended Master Secret")
print(" --help this message")


def main():
host = "localhost"
port = 4433
num_limit = None
run_exclude = set()
expected_failures = {}
last_exp_tmp = None
dhe = False
ciphers = None
ems = False

argv = sys.argv[1:]
opts, args = getopt.getopt(argv, "h:p:e:x:X:n:dC:M", ["help", "ems"])
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 == '-d':
dhe = True
elif opt == '-C':
if arg[:2] == '0x':
ciphers = [int(arg, 16)]
else:
try:
ciphers = [getattr(CipherSuite, arg)]
except AttributeError:
ciphers = [int(arg)]
elif opt == '-M' or opt == '--ems':
ems = True
elif opt == '--help':
help_msg()
sys.exit(0)
else:
raise ValueError("Unknown option: {0}".format(opt))

if args:
run_only = set(args)
else:
run_only = None

if ciphers:
if not dhe:
# by default send minimal set of extensions, but allow user
# to override it
dhe = ciphers[0] in CipherSuite.ecdhAllSuites or \
ciphers[0] in CipherSuite.dhAllSuites
else:
if dhe:
ciphers = [CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
CipherSuite.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
CipherSuite.TLS_DHE_RSA_WITH_AES_128_CBC_SHA]
else:
ciphers = [CipherSuite.TLS_RSA_WITH_AES_128_CBC_SHA]


conversations = {}

conversation = Connect(host, port)
node = conversation
ext = {}
if ems:
ext[ExtensionType.extended_master_secret] = AutoEmptyExtension()
if dhe:
groups = [GroupName.secp256r1,
GroupName.ffdhe2048]
ext[ExtensionType.supported_groups] = SupportedGroupsExtension()\
.create(groups)
ext[ExtensionType.signature_algorithms] = \
SignatureAlgorithmsExtension().create(SIG_ALL)
ext[ExtensionType.signature_algorithms_cert] = \
SignatureAlgorithmsCertExtension().create(SIG_ALL)
if not ext:
ext = None
node = node.add_child(ClientHelloGenerator(
ciphers + [CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV],
extensions=ext))
node = node.add_child(ExpectServerHello())
node = node.add_child(ExpectCertificate())
if dhe:
node = node.add_child(ExpectServerKeyExchange())
node = node.add_child(ExpectServerHelloDone())
node = node.add_child(ClientKeyExchangeGenerator())
node = node.add_child(ChangeCipherSpecGenerator())
node = node.add_child(FinishedGenerator())
node = node.add_child(ExpectChangeCipherSpec())
node = node.add_child(ExpectFinished())
node = node.add_child(ApplicationDataGenerator(
bytearray(b"GET / HTTP/1.0\r\n\r\n")))
node = node.add_child(ExpectApplicationData())
node = node.add_child(AlertGenerator(AlertLevel.warning,
AlertDescription.close_notify))
node = node.add_child(ExpectAlert())
node.next_sibling = ExpectClose()
conversations["sanity"] = conversation

# multi-byte CCS
conversation = Connect(host, port)
node = conversation
ext = {}
if ems:
ext[ExtensionType.extended_master_secret] = AutoEmptyExtension()
if dhe:
groups = [GroupName.secp256r1,
GroupName.ffdhe2048]
ext[ExtensionType.supported_groups] = SupportedGroupsExtension()\
.create(groups)
ext[ExtensionType.signature_algorithms] = \
SignatureAlgorithmsExtension().create(SIG_ALL)
ext[ExtensionType.signature_algorithms_cert] = \
SignatureAlgorithmsCertExtension().create(SIG_ALL)
if not ext:
ext = None
node = node.add_child(ClientHelloGenerator(
ciphers + [CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV],
extensions=ext))
node = node.add_child(ExpectServerHello())
node = node.add_child(ExpectCertificate())
if dhe:
node = node.add_child(ExpectServerKeyExchange())
node = node.add_child(ExpectServerHelloDone())
node = node.add_child(ClientKeyExchangeGenerator())
node = node.add_child(RawMessageGenerator(
ContentType.change_cipher_spec, b'\x01\x01'))
node = node.add_child(ExpectAlert(
AlertLevel.fatal,
AlertDescription.unexpected_message))
node.add_child(ExpectClose())
conversations["two bytes long CCS"] = 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:
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 conversation script; check basic communication with typical")
print("cipher, TLS 1.2 or earlier and RSA key exchange (or (EC)DHE if")
print("-d option is used)\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()
Loading

0 comments on commit bdf7c20

Please sign in to comment.