paragonie/haliteHigh-level cryptography interface powered by libsodium
Halite is a high-level cryptography interface that relies on libsodium for all of its underlying cryptography operations.
Halite was created by Paragon Initiative Enterprises as a result of our continued efforts to improve the ecosystem and make cryptography in PHP safer and easier to implement.
You can read the Halite Documentation online.
Halite is released under Mozilla Public License 2.0. Commercial licenses are available from Paragon Initiative Enterprises if you wish to extend Halite without making your derivative works available under the terms of the MPL.
If you are satisfied with the terms of MPL software for backend web applications but would like to purchase a support contract for your application that uses Halite, those are also offered by Paragon Initiative Enterprises.
Important: Earlier versions of Halite were available under the GNU Public License version 3 (GPLv3). Only Halite 4.0.1 and newer are available under the Mozilla Public License terms.
Before you can use Halite, you must choose a version that fits the requirements of your project. The differences between the requirements for the available versions of Halite are briefly highlighted below.
| PHP | libsodium | PECL libsodium | Support | |
|---|---|---|---|---|
| Halite 5.1 and newer | 8.1.0 | 1.0.18 | N/A (standard) | ✔️ Active |
| Halite 5.0.x | 8.0.0 | 1.0.18 | N/A (standard) | ✔️ Active |
| Halite 4.1+ | 7.2.0 | 1.0.15 | N/A (standard) | ❌ Not Supported |
| Halite 4.0 | 7.2.0 | 1.0.13 | N/A (standard) | ❌ Not Supported |
| Halite 3 | 7.0.0 | 1.0.9 | 1.0.6 / 2.0.4 | ❌ Not Supported |
| Halite 2 | 7.0.0 | 1.0.9 | 1.0.6 | ❌ Not Supported |
| Halite 1 | 5.6.0 | 1.0.6 | 1.0.2 | ❌ Not Supported |
Note: Halite 5.0.x works on PHP 8.0, but performance is worse than on PHP 8.1.
If you need a version of Halite before 5.1, see the documentation relevant to that particular branch.
To install Halite, you first need to install libsodium. You may or may not need the PHP extension. For most people, this means running...
sudo apt-get install php7.2-sodium
...or an equivalent command for your operating system and PHP version.
If you're stuck, this step-by-step guide contributed by @aolko may be helpful.
Once you have the prerequisites installed, install Halite through Composer:
composer require paragonie/halite:^5
Free (gratis) support for Halite only extends to the most recent major version (currently 5).
If your company requires support for an older version of Halite, contact Paragon Initiative Enterprises to inquire about commercial support options.
If you need an easy way to migrate from older versions of Halite, check out halite-legacy.
Check out the documentation. The basic Halite API is designed for simplicity: