PHP-TUF is in a pre-release state and is not considered a complete or secure version of the TUF framework. It should currently only be used for testing, development and feedback.
Do not use in production for secure target downloads!!
PHP-TUF is a PHP implementation of The Update Framework (TUF) to provide signing and verification for secure PHP application updates. Read the TUF specification for more information on how TUF is intended to work and the security it provides.
PHP-TUF project development is primarily focused on supporting secure automated updates for PHP CMSes, although it should also work for any PHP application or Composer project. Contributing projects:
PHP-TUF client requirements
The PHP-TUF client is designed to provide TUF verification to PHP applications for target signatures.
- Minimum required PHP version: 7.2
paragonie/sodium_compatdependency provides a polyfill for the Sodium cryptography library; however, installing
ext-sodiumis recommended for better performance and security.
PHP-TUF development requirements
We recommend using the default CLI implementation (a Python application) to generate keys and signatures as a part of your project's release creation process. This will require:
- Python 3.9+
- PIP 19+
@todo More detailed instructions. #170
Server environment setup for the Python TUF CLI
Install OS-level dependencies:
On Fedora 33:
sudo dnf install pipenv python3-devel libffi-devel
On Ubuntu 20.10:
sudo apt-get install pipenv python3-dev libffi-dev
Configure the virtual environment:
pipenv --three install
Launch a shell within the virtual environment:
The code generally follows PSR-2 with some additional formatting rules for code documentation and array formatting. Run PHPCS to check for code style compliance:
Test fixtures generation
Install the Python TUF implementation and enable the pipenv:
pipenv install pipenv shell
Initialize the repository and add/sign a target:
Fixtures should appear in
Running the PHP-TUF tests
- Ensure you have all required dependencies by running
composer testat the project's root.
Leveraging test fixtures directly
python3 -m http.server 8001
mkdir -p tuftargets curl http://localhost:8001/targets/testtarget.txt > tuftargets/testtarget.txt client.py --repo http://localhost:8001 testtarget.txt # A 404 is expected for N.root.json unless a key has been rotated.
Dependency policies and information
To provide a lightweight, reliable, and secure client, external dependencies are carefully limited. Any proposed dependency additions (and those dependencies' dependencies) should undergo the Drupal core dependency evaluation process.
For evaluations and policies of current dependencies, see the PHP-TUF dependency information.