Download the PHP package michaelmawhinney/cryptex without Composer
On this page you can find all versions of the php package michaelmawhinney/cryptex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download michaelmawhinney/cryptex
More information about michaelmawhinney/cryptex
Files in michaelmawhinney/cryptex
Package cryptex
Short Description A simple PHP class for 2-way authenticated encryption using XChaCha20 + Poly1305 (libsodium)
License MIT
Homepage https://github.com/michaelmawhinney/cryptex
Informations about the package cryptex
Cryptex: 2-way Authenticated Encryption Class
Cryptex is a simple PHP class that performs 2-way authenticated encryption using XChaCha20 + Poly1305.
Requirements
- PHP 8.1 or newer
Installation
The preferred method of installation is with Packagist and Composer. The following command installs the package and adds it as a requirement to your project's composer.json:
composer require michaelmawhinney/cryptex
You can also download or clone the repo and include the src/Cryptex.php
manually if you prefer.
Usage
Always store or transmit your $key
and $salt
values securely.
Testing
The PHPUnit test class is in tests/CryptexTest.php
.
If you installed Cryptex with Composer, you can run the following command in the top-level folder of this project to perform the unit tests:
./vendor/bin/phpunit --bootstrap vendor/autoload.php tests
If phpunit
is already installed on your local system, you can run this command instead:
phpunit tests
Generating Documentation
Cryptex uses phpDocumentor to automatically generate documentation whenever changes are made. The generated documentation is available online here. However if you want to generate the documentation locally, you can run the following command in the top-level folder of this project (requires docker):
docker run --rm -v "$(pwd):/data" "phpdoc/phpdoc:3" -d src,tests -t docs
If you want to use another method of running/installing phpdoc, refer to the phpDocumentor documentation.