252 lines
11 KiB
Python
252 lines
11 KiB
Python
#
|
|
# Wireshark tests
|
|
# By Gerald Combs <gerald@wireshark.org>
|
|
#
|
|
# Ported from a set of Bash scripts which were copyright 2005 Ulf Lamping
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
#
|
|
'''File format conversion tests'''
|
|
|
|
import os.path
|
|
import subprocesstest
|
|
import unittest
|
|
import fixtures
|
|
|
|
# XXX Currently unused. It would be nice to be able to use this below.
|
|
time_output_args = ('-Tfields', '-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta')
|
|
|
|
# Microsecond pcap, direct read was used to generate the baseline:
|
|
# tshark -Tfields -e frame.number -e frame.time_epoch -e frame.time_delta \
|
|
# -r captures/dhcp.pcap > baseline/ff-ts-usec-pcap-direct.txt
|
|
baseline_file = 'ff-ts-usec-pcap-direct.txt'
|
|
|
|
|
|
@fixtures.fixture(scope='session')
|
|
def fileformats_baseline_str(dirs):
|
|
with open(os.path.join(dirs.baseline_dir, baseline_file), 'r') as f:
|
|
return f.read()
|
|
|
|
|
|
@fixtures.mark_usefixtures('test_env')
|
|
@fixtures.uses_fixtures
|
|
class case_fileformat_pcap(subprocesstest.SubprocessTestCase):
|
|
def test_pcap_usec_stdin(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs microsecond pcap stdin'''
|
|
capture_proc = self.assertRun(' '.join((cmd_tshark,
|
|
'-r', '-',
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta',
|
|
'<', capture_file('dhcp.pcap')
|
|
)),
|
|
shell=True)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
def test_pcap_nsec_stdin(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs nanosecond pcap stdin'''
|
|
capture_proc = self.assertRun(' '.join((cmd_tshark,
|
|
'-r', '-',
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta',
|
|
'<', capture_file('dhcp-nanosecond.pcap')
|
|
)),
|
|
shell=True)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
def test_pcap_nsec_direct(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs nanosecond pcap direct'''
|
|
capture_proc = self.assertRun((cmd_tshark,
|
|
'-r', capture_file('dhcp-nanosecond.pcap'),
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta',
|
|
),
|
|
)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
|
|
@fixtures.mark_usefixtures('test_env')
|
|
@fixtures.uses_fixtures
|
|
class case_fileformat_pcapng(subprocesstest.SubprocessTestCase):
|
|
def test_pcapng_usec_stdin(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs microsecond pcapng stdin'''
|
|
capture_proc = self.assertRun(' '.join((cmd_tshark,
|
|
'-r', '-',
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta'
|
|
'<', capture_file('dhcp.pcapng')
|
|
)),
|
|
shell=True)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
def test_pcapng_usec_direct(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs microsecond pcapng direct'''
|
|
capture_proc = self.assertRun((cmd_tshark,
|
|
'-r', capture_file('dhcp.pcapng'),
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta',
|
|
),
|
|
)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
def test_pcapng_nsec_stdin(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs nanosecond pcapng stdin'''
|
|
capture_proc = self.assertRun(' '.join((cmd_tshark,
|
|
'-r', '-',
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta'
|
|
'<', capture_file('dhcp-nanosecond.pcapng')
|
|
)),
|
|
shell=True)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
def test_pcapng_nsec_direct(self, cmd_tshark, capture_file, fileformats_baseline_str):
|
|
'''Microsecond pcap direct vs nanosecond pcapng direct'''
|
|
capture_proc = self.assertRun((cmd_tshark,
|
|
'-r', capture_file('dhcp-nanosecond.pcapng'),
|
|
'-Tfields',
|
|
'-e', 'frame.number', '-e', 'frame.time_epoch', '-e', 'frame.time_delta',
|
|
),
|
|
)
|
|
self.assertTrue(self.diffOutput(capture_proc.stdout_str, fileformats_baseline_str, 'tshark', baseline_file))
|
|
|
|
@fixtures.fixture
|
|
def check_pcapng_dsb_fields(request, cmd_tshark):
|
|
'''Factory that checks whether the DSB within the capture file matches.'''
|
|
self = request.instance
|
|
def check_dsb_fields_real(outfile, fields):
|
|
proc = self.assertRun((cmd_tshark,
|
|
'-r', outfile,
|
|
'-Xread_format:MIME Files Format',
|
|
'-Tfields',
|
|
'-e', 'pcapng.dsb.secrets_type',
|
|
'-e', 'pcapng.dsb.secrets_length',
|
|
'-e', 'pcapng.dsb.secrets_data',
|
|
'-Y', 'pcapng.dsb.secrets_data'
|
|
))
|
|
# Convert "t1,t2 l1,l2 v1,2" -> [(t1, l1, v1), (t2, l2, v2)]
|
|
output = proc.stdout_str.strip()
|
|
actual = list(zip(*[x.split(",") for x in output.split('\t')]))
|
|
def format_field(field):
|
|
t, l, v = field
|
|
v_hex = ''.join('%02x' % c for c in v)
|
|
return ('0x%08x' % t, str(l), v_hex)
|
|
fields = [format_field(field) for field in fields]
|
|
self.assertEqual(fields, actual)
|
|
return check_dsb_fields_real
|
|
|
|
|
|
@fixtures.mark_usefixtures('base_env')
|
|
@fixtures.uses_fixtures
|
|
class case_fileformat_pcapng_dsb(subprocesstest.SubprocessTestCase):
|
|
def test_pcapng_dsb_1(self, cmd_tshark, dirs, capture_file, check_pcapng_dsb_fields):
|
|
'''Check that DSBs are preserved while rewriting files.'''
|
|
dsb_keys1 = os.path.join(dirs.key_dir, 'tls12-dsb-1.keys')
|
|
dsb_keys2 = os.path.join(dirs.key_dir, 'tls12-dsb-2.keys')
|
|
outfile = self.filename_from_id('tls12-dsb-same.pcapng')
|
|
self.assertRun((cmd_tshark,
|
|
'-r', capture_file('tls12-dsb.pcapng'),
|
|
'-w', outfile,
|
|
))
|
|
with open(dsb_keys1, 'r') as f:
|
|
dsb1_contents = f.read().encode('utf8')
|
|
with open(dsb_keys2, 'r') as f:
|
|
dsb2_contents = f.read().encode('utf8')
|
|
check_pcapng_dsb_fields(outfile, (
|
|
(0x544c534b, len(dsb1_contents), dsb1_contents),
|
|
(0x544c534b, len(dsb2_contents), dsb2_contents),
|
|
))
|
|
|
|
def test_pcapng_dsb_2(self, cmd_editcap, dirs, capture_file, check_pcapng_dsb_fields):
|
|
'''Insert a single DSB into a pcapng file.'''
|
|
key_file = os.path.join(dirs.key_dir, 'dhe1_keylog.dat')
|
|
outfile = self.filename_from_id('dhe1-dsb.pcapng')
|
|
self.assertRun((cmd_editcap,
|
|
'--inject-secrets', 'tls,%s' % key_file,
|
|
capture_file('dhe1.pcapng.gz'), outfile
|
|
))
|
|
with open(key_file, 'rb') as f:
|
|
keylog_contents = f.read()
|
|
check_pcapng_dsb_fields(outfile, (
|
|
(0x544c534b, len(keylog_contents), keylog_contents),
|
|
))
|
|
|
|
def test_pcapng_dsb_3(self, cmd_editcap, dirs, capture_file, check_pcapng_dsb_fields):
|
|
'''Insert two DSBs into a pcapng file.'''
|
|
key_file1 = os.path.join(dirs.key_dir, 'dhe1_keylog.dat')
|
|
key_file2 = os.path.join(dirs.key_dir, 'http2-data-reassembly.keys')
|
|
outfile = self.filename_from_id('dhe1-dsb.pcapng')
|
|
self.assertRun((cmd_editcap,
|
|
'--inject-secrets', 'tls,%s' % key_file1,
|
|
'--inject-secrets', 'tls,%s' % key_file2,
|
|
capture_file('dhe1.pcapng.gz'), outfile
|
|
))
|
|
with open(key_file1, 'rb') as f:
|
|
keylog1_contents = f.read()
|
|
with open(key_file2, 'rb') as f:
|
|
keylog2_contents = f.read()
|
|
check_pcapng_dsb_fields(outfile, (
|
|
(0x544c534b, len(keylog1_contents), keylog1_contents),
|
|
(0x544c534b, len(keylog2_contents), keylog2_contents),
|
|
))
|
|
|
|
def test_pcapng_dsb_4(self, cmd_editcap, dirs, capture_file, check_pcapng_dsb_fields):
|
|
'''Insert a single DSB into a pcapng file with existing DSBs.'''
|
|
dsb_keys1 = os.path.join(dirs.key_dir, 'tls12-dsb-1.keys')
|
|
dsb_keys2 = os.path.join(dirs.key_dir, 'tls12-dsb-2.keys')
|
|
key_file = os.path.join(dirs.key_dir, 'dhe1_keylog.dat')
|
|
outfile = self.filename_from_id('tls12-dsb-extra.pcapng')
|
|
self.assertRun((cmd_editcap,
|
|
'--inject-secrets', 'tls,%s' % key_file,
|
|
capture_file('tls12-dsb.pcapng'), outfile
|
|
))
|
|
with open(dsb_keys1, 'r') as f:
|
|
dsb1_contents = f.read().encode('utf8')
|
|
with open(dsb_keys2, 'r') as f:
|
|
dsb2_contents = f.read().encode('utf8')
|
|
with open(key_file, 'rb') as f:
|
|
keylog_contents = f.read()
|
|
# New DSBs are inserted before the first record. Due to the current
|
|
# implementation, this is inserted before other (existing) DSBs. This
|
|
# might change in the future if it is deemed more logical.
|
|
check_pcapng_dsb_fields(outfile, (
|
|
(0x544c534b, len(keylog_contents), keylog_contents),
|
|
(0x544c534b, len(dsb1_contents), dsb1_contents),
|
|
(0x544c534b, len(dsb2_contents), dsb2_contents),
|
|
))
|
|
|
|
def test_pcapng_dsb_bad_key(self, cmd_editcap, dirs, capture_file, check_pcapng_dsb_fields):
|
|
'''Insertion of a RSA key file is not very effective.'''
|
|
rsa_keyfile = os.path.join(dirs.key_dir, 'rsasnakeoil2.key')
|
|
p12_keyfile = os.path.join(dirs.key_dir, 'key.p12')
|
|
outfile = self.filename_from_id('rsasnakeoil2-dsb.pcapng')
|
|
proc = self.assertRun((cmd_editcap,
|
|
'--inject-secrets', 'tls,%s' % rsa_keyfile,
|
|
'--inject-secrets', 'tls,%s' % p12_keyfile,
|
|
capture_file('rsasnakeoil2.pcap'), outfile
|
|
))
|
|
self.assertEqual(proc.stderr_str.count('unsupported private key file'), 2)
|
|
with open(rsa_keyfile, 'rb') as f:
|
|
dsb1_contents = f.read()
|
|
with open(p12_keyfile, 'rb') as f:
|
|
dsb2_contents = f.read()
|
|
check_pcapng_dsb_fields(outfile, (
|
|
(0x544c534b, len(dsb1_contents), dsb1_contents),
|
|
(0x544c534b, len(dsb2_contents), dsb2_contents),
|
|
))
|
|
|
|
|
|
@fixtures.mark_usefixtures('test_env')
|
|
@fixtures.uses_fixtures
|
|
class case_fileformat_mime(subprocesstest.SubprocessTestCase):
|
|
def test_mime_pcapng_gz(self, cmd_tshark, capture_file):
|
|
'''Test that the full uncompressed contents is shown.'''
|
|
proc = self.assertRun((cmd_tshark,
|
|
'-r', capture_file('icmp.pcapng.gz'),
|
|
'-Xread_format:MIME Files Format',
|
|
'-Tfields',
|
|
'-e', 'frame.len',
|
|
'-e', 'pcapng.block.length',
|
|
'-e', 'pcapng.block.length_trailer',
|
|
))
|
|
self.assertEqual(proc.stdout_str.strip(), '480\t128,88,132,132\t128,88,132,132')
|