mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
232 lines
9.5 KiB
Python
Executable file
232 lines
9.5 KiB
Python
Executable file
#!/usr/bin/env python
|
|
|
|
"""
|
|
<Program Name>
|
|
test_extraneous_dependencies_attack.py
|
|
|
|
<Author>
|
|
Zane Fisher.
|
|
|
|
<Started>
|
|
August 19, 2013.
|
|
|
|
April 6, 2014.
|
|
Refactored to use the 'unittest' module (test conditions in code, rather
|
|
than verifying text output), use pre-generated repository files, and
|
|
discontinue use of the old repository tools. Modify the previous scenario
|
|
simulated for the mix-and-match attack. The metadata that specified the
|
|
dependencies of a project modified (previously a text file.) -vladimir.v.diaz
|
|
|
|
<Copyright>
|
|
See LICENSE for licensing information.
|
|
|
|
<Purpose>
|
|
Simulate an extraneous dependencies attack. The client attempts to download
|
|
a file, which lists all the target dependencies, with one legitimate
|
|
dependency, and one extraneous dependency. A client should not download a
|
|
target dependency even if it is found on the repository. Valid targets are
|
|
listed and verified by TUF metadata, such as 'targets.txt'.
|
|
|
|
There is no difference between 'updates' and 'target' files.
|
|
"""
|
|
|
|
# Help with Python 3 compatibility, where the print statement is a function, an
|
|
# implicit relative import is invalid, and the '/' operator performs true
|
|
# division. Example: print 'hello world' raises a 'SyntaxError' exception.
|
|
from __future__ import print_function
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
import os
|
|
import tempfile
|
|
import random
|
|
import time
|
|
import shutil
|
|
import json
|
|
import subprocess
|
|
import logging
|
|
import sys
|
|
|
|
# 'unittest2' required for testing under Python < 2.7.
|
|
if sys.version_info >= (2, 7):
|
|
import unittest
|
|
|
|
else:
|
|
import unittest2 as unittest
|
|
|
|
import tuf.formats
|
|
import tuf.util
|
|
import tuf.log
|
|
import tuf.client.updater as updater
|
|
import tuf.unittest_toolbox as unittest_toolbox
|
|
import tuf._vendor.six as six
|
|
|
|
logger = logging.getLogger('tuf.test_extraneous_dependencies_attack')
|
|
|
|
|
|
|
|
class TestExtraneousDependenciesAttack(unittest_toolbox.Modified_TestCase):
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
# setUpClass() is called before any of the test cases are executed.
|
|
|
|
# Create a temporary directory to store the repository, metadata, and target
|
|
# files. 'temporary_directory' must be deleted in TearDownModule() so that
|
|
# temporary files are always removed, even when exceptions occur.
|
|
cls.temporary_directory = tempfile.mkdtemp(dir=os.getcwd())
|
|
|
|
# Launch a SimpleHTTPServer (serves files in the current directory).
|
|
# Test cases will request metadata and target files that have been
|
|
# pre-generated in 'tuf/tests/repository_data', which will be served by the
|
|
# SimpleHTTPServer launched here. The test cases of this unit test assume
|
|
# the pre-generated metadata files have a specific structure, such
|
|
# as a delegated role 'targets/role1', three target files, five key files,
|
|
# etc.
|
|
cls.SERVER_PORT = random.randint(30000, 45000)
|
|
command = ['python', 'simple_server.py', str(cls.SERVER_PORT)]
|
|
cls.server_process = subprocess.Popen(command, stderr=subprocess.PIPE)
|
|
logger.info('Server process started.')
|
|
logger.info('Server process id: '+str(cls.server_process.pid))
|
|
logger.info('Serving on port: '+str(cls.SERVER_PORT))
|
|
cls.url = 'http://localhost:'+str(cls.SERVER_PORT) + os.path.sep
|
|
|
|
# NOTE: Following error is raised if a delay is not applied:
|
|
# <urlopen error [Errno 111] Connection refused>
|
|
time.sleep(.7)
|
|
|
|
|
|
|
|
@classmethod
|
|
def tearDownClass(cls):
|
|
# tearDownModule() is called after all the test cases have run.
|
|
# http://docs.python.org/2/library/unittest.html#class-and-module-fixtures
|
|
|
|
# Remove the temporary repository directory, which should contain all the
|
|
# metadata, targets, and key files generated of all the test cases.
|
|
shutil.rmtree(cls.temporary_directory)
|
|
|
|
# Kill the SimpleHTTPServer process.
|
|
if cls.server_process.returncode is None:
|
|
logger.info('Server process '+str(cls.server_process.pid)+' terminated.')
|
|
cls.server_process.kill()
|
|
|
|
|
|
|
|
def setUp(self):
|
|
# We are inheriting from custom class.
|
|
unittest_toolbox.Modified_TestCase.setUp(self)
|
|
|
|
# Copy the original repository files provided in the test folder so that
|
|
# any modifications made to repository files are restricted to the copies.
|
|
# The 'repository_data' directory is expected to exist in 'tuf/tests/'.
|
|
original_repository_files = os.path.join(os.getcwd(), 'repository_data')
|
|
temporary_repository_root = \
|
|
self.make_temp_directory(directory=self.temporary_directory)
|
|
|
|
# The original repository, keystore, and client directories will be copied
|
|
# for each test case.
|
|
original_repository = os.path.join(original_repository_files, 'repository')
|
|
original_client = os.path.join(original_repository_files, 'client')
|
|
original_keystore = os.path.join(original_repository_files, 'keystore')
|
|
|
|
# Save references to the often-needed client repository directories.
|
|
# Test cases need these references to access metadata and target files.
|
|
self.repository_directory = \
|
|
os.path.join(temporary_repository_root, 'repository')
|
|
self.client_directory = os.path.join(temporary_repository_root, 'client')
|
|
self.keystore_directory = os.path.join(temporary_repository_root, 'keystore')
|
|
|
|
# Copy the original 'repository', 'client', and 'keystore' directories
|
|
# to the temporary repository the test cases can use.
|
|
shutil.copytree(original_repository, self.repository_directory)
|
|
shutil.copytree(original_client, self.client_directory)
|
|
shutil.copytree(original_keystore, self.keystore_directory)
|
|
|
|
# Set the url prefix required by the 'tuf/client/updater.py' updater.
|
|
# 'path/to/tmp/repository' -> 'localhost:8001/tmp/repository'.
|
|
repository_basepath = self.repository_directory[len(os.getcwd()):]
|
|
url_prefix = \
|
|
'http://localhost:' + str(self.SERVER_PORT) + repository_basepath
|
|
|
|
# Setting 'tuf.conf.repository_directory' with the temporary client
|
|
# directory copied from the original repository files.
|
|
tuf.conf.repository_directory = self.client_directory
|
|
self.repository_mirrors = {'mirror1': {'url_prefix': url_prefix,
|
|
'metadata_path': 'metadata',
|
|
'targets_path': 'targets',
|
|
'confined_target_dirs': ['']}}
|
|
|
|
# Create the repository instance. The test cases will use this client
|
|
# updater to refresh metadata, fetch target files, etc.
|
|
self.repository_updater = updater.Updater('test_repository',
|
|
self.repository_mirrors)
|
|
|
|
|
|
def tearDown(self):
|
|
# Modified_TestCase.tearDown() automatically deletes temporary files and
|
|
# directories that may have been created during each test case.
|
|
unittest_toolbox.Modified_TestCase.tearDown(self)
|
|
|
|
|
|
|
|
def test_with_tuf(self):
|
|
# An attacker tries to trick a client into installing an extraneous target
|
|
# file (a valid file on the repository, in this case) by listing it in the
|
|
# project's metadata file. For the purposes of test_with_tuf(),
|
|
# 'targets/role1.json' is treated as the metadata file that indicates all
|
|
# the files needed to install/update the 'role1' project. The attacker
|
|
# simply adds the extraneous target file to 'role1.json', which the TUF
|
|
# client should reject as untrusted.
|
|
role1_filepath = os.path.join(self.repository_directory, 'metadata',
|
|
'targets', 'role1.json')
|
|
file1_filepath = os.path.join(self.repository_directory, 'targets',
|
|
'file1.txt')
|
|
length, hashes = tuf.util.get_file_details(file1_filepath)
|
|
|
|
role1_metadata = tuf.util.load_json_file(role1_filepath)
|
|
role1_metadata['signed']['targets']['/file2.txt'] = {}
|
|
role1_metadata['signed']['targets']['/file2.txt']['hashes'] = hashes
|
|
role1_metadata['signed']['targets']['/file2.txt']['length'] = length
|
|
|
|
tuf.formats.check_signable_object_format(role1_metadata)
|
|
|
|
with open(role1_filepath, 'wt') as file_object:
|
|
json.dump(role1_metadata, file_object, indent=1, sort_keys=True)
|
|
|
|
# Un-install the metadata of the top-level roles so that the client can
|
|
# download and detect the invalid 'role1.json'.
|
|
os.remove(os.path.join(self.client_directory, 'metadata', 'current',
|
|
'snapshot.json'))
|
|
os.remove(os.path.join(self.client_directory, 'metadata', 'current',
|
|
'targets.json'))
|
|
os.remove(os.path.join(self.client_directory, 'metadata', 'current',
|
|
'timestamp.json'))
|
|
os.remove(os.path.join(self.client_directory, 'metadata', 'current',
|
|
'targets', 'role1.json'))
|
|
|
|
# Verify that the TUF client rejects the invalid metadata and refuses to
|
|
# continue the update process.
|
|
self.repository_updater.refresh()
|
|
|
|
try:
|
|
self.repository_updater.targets_of_role('targets/role1')
|
|
|
|
# Verify that the specific 'tuf.BadHashError' exception is raised by each
|
|
# mirror.
|
|
except tuf.NoWorkingMirrorError as exception:
|
|
for mirror_url, mirror_error in six.iteritems(exception.mirror_errors):
|
|
url_prefix = self.repository_mirrors['mirror1']['url_prefix']
|
|
url_file = os.path.join(url_prefix, 'metadata', 'targets', 'role1.json')
|
|
|
|
# Verify that 'role1.json' is the culprit.
|
|
self.assertEqual(url_file, mirror_url)
|
|
self.assertTrue(isinstance(mirror_error, tuf.BadHashError))
|
|
|
|
else:
|
|
self.fail('TUF did not prevent an extraneous dependencies attack.')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|