TAF (The Archive Framework)

TAF is a framework that aims to provide archival authentication and ensure that Git repositories can be securely cloned/updated. TAF's implementation strongly relies on The Update Framework (TUF), which helps developers maintain the security of a software update system. It provides a flexible framework and specification that developers can integrate into any software update system. TAF integrates Git with TUF:

TUF targets were modified to authenticate Git commits instead of individual files. This reduces the metadata size and simplifies authentication.
The TUF metadata repository storage utilizes Git. That means TUF metadata files are stored in a Git repository, which is referred to as an authentication repository.

When a TAF authentication repository is cloned, all target repositories are also cloned, and TUF validation is performed against every commit since the repository's inception. When a TAF repository is updated, data is fetched from upstream and each commit is authenticated. A TAF clone/update differs from a standard Git clone/fetch in that remote commits aren't added to the local Git repositories until they've been fully authenticated locally. TAF can be used to secure any git repository, regardless of its content.

Threats

A git repository can be compromised in several ways:

An attacker might hack a user's account on a code hosting platform, like GitHub or GitLab.
An attacker might compromise the hosting platform itself.
An attacker might gain access to a developer's personal computer.

Such an attacker could then:

Upload a new GPG key to GitHub.
Push new commits to any repository.
Add another authorized user with write access.
Unprotect the master branch of any repository and force-push to it.

TAF's primary objective is not to prevent the attacks listed above but rather to detect when an attack has occurred and halt an update if necessary. Thus, TAF should be used instead of directly calling git pull and git clone.

Installation Steps

From PyPI

pip install taf

From source:

pip install -e .

Install extra dependencies when using Yubikey:

pip install taf[yubikey]

Add bash completion:

copy taf-complete.sh to user's directory
add source ./taf-complete.sh to ~/.bash_profile or ~/.bashrc
source ~/.bash_profile

Development Setup

We are using pre-commit to run black code formatter, flake8 and bandit code quality checks, as well as Mypy static type checker.

pip install -e .[dev]
pip install -e .[test]

pre-commit install # registers git pre-commit hook

pre-commit run --all-files # runs code formatting and quality checks for all files

NOTE: For Windows users: Open settings.json and replace paths.

Running Tests

To run tests with mocked Yubikey:

pytest

To run tests with real Yubikey:

Insert test Yubikey
Run taf setup_test_key WARNING: This command will import targets private key to signature slot of your Yubikey, as well as new self-signed x509 certificate!
Run REAL_YK=True pytest or set REAL_YK=True pytest depending on platform.

Installing Wheels on Windows and MacOS

The newer versions of TAF do not require additional setup, and there are no platform-specific wheels needed. However, older versions required certain platform-specific DLLs, which the CI would copy to taf/libs before building a wheel. Therefore, it's important to install the appropriate platform-specific wheel if you're using an older version.

Installing Wheels on Ubuntu

Install dependencies

sudo add-apt-repository ppa:jonathonf/python-3.10
sudo apt-get update
sudo apt-get install python3.10
sudo apt-get install python3.10-venv
sudo apt-get install python3.10-dev
sudo apt-get install swig
sudo apt-get install libpcsclite-dev
sudo apt-get install libssl-dev
sudo apt-get install libykpers-1-dev

Create virtual environment

python3.10 -m venv env
pip install --upgrade pip
pip install wheel
pip install taf

Test CLI

taf

Acknowledgements

This project was made possible in part by the Institute of Museum and Library Services (LG-246285-OLS-20)

openlawlibrary / taf

readme