paragonie/halite is tracked by TopGit as a security tool, with 1.2k stars on GitHub, written primarily in PHP. High-level cryptography interface powered by libsodium
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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.
Installing Halite
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)
:heavy_check_mark: Active
Halite 5.0.x
8.0.0
1.0.18
N/A (standard)
:heavy_check_mark: Active
Halite 4.1+
7.2.0
1.0.15
N/A (standard)
:x: Not Supported
Halite 4.0
7.2.0
1.0.13
N/A (standard)
:x: Not Supported
Halite 3
7.0.0
1.0.9
1.0.6 / 2.0.4
:x: Not Supported
Halite 2
7.0.0
1.0.9
1.0.6
:x: Not Supported
Halite 1
5.6.0
1.0.6
1.0.2
:x: 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
Commercial Support for Older Halite Versions
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.
Using Halite in Your Project
Check out the documentation. The basic Halite API is designed for simplicity:
<?php
use ParagonIE\Halite\KeyFactory;
$encKey = KeyFactory::generateEncryptionKey();
KeyFactory::save($encKey, '/path/outside/webroot/encryption.key');
And then you can encrypt/decrypt messages like so:
<?php
use ParagonIE\Halite\KeyFactory;
use ParagonIE\Halite\Symmetric\Crypto as Symmetric;
use ParagonIE\HiddenString\HiddenString;
$encryptionKey = KeyFactory::loadEncryptionKey('/path/outside/webroot/encryption.key');
$message = new HiddenString('This is a confidential message for your eyes only.');
$ciphertext = Symmetric::encrypt($message, $encryptionKey);
$decrypted = Symmetric::decrypt($ciphertext, $encryptionKey);
var_dump($decrypted->getString() === $message->getString()); // bool(true)
Important: Halite works with Key objects, not strings.
If you attempt to echo a key object, you will get an empty string
rather than its contents. If you attempt to var_dump() a key object,
you will just get some facts about the type of key it is.
You must invoke $obj->getRawKeyMaterial() explicitly if you want
to inspect a key's raw binary contents. This is not recommended for
most use cases.
Example: Generating a key from a password
<?php
use ParagonIE\Halite\KeyFactory;
use ParagonIE\HiddenString\HiddenString;
$passwd = new HiddenString('correct horse battery staple');
// Use random_bytes(16); to generate the salt:
$salt = "\xdd\x7b\x1e\x38\x75\x9f\x72\x86\x0a\xe9\xc8\x58\xf6\x16\x0d\x3b";
$encryptionKey = KeyFactory::deriveEncryptionKey($passwd, $salt);
A key derived from a password can be used in place of one randomly generated.
Example: Encrypting a large file on a system with low memory
Halite includes a file cryptography class that utilizes a streaming API to
allow large files (e.g. gigabytes) be encrypted on a system with very little
available memory (i.e. less than 8 MB).
<?php
use ParagonIE\Halite\File;
use ParagonIE\Halite\KeyFactory;
$encryptionKey = KeyFactory::loadEncryptionKey('/path/outside/webroot/encryption.key');
File::encrypt('input.txt', 'output.txt', $encryptionKey);
Common Support Issues
Uncaught SodiumException: Cannot Wipe Memory
PHP Fatal error: Uncaught SodiumException: This is not implemented, as it is not possible to securely wipe memory from PHP
The solution to this is to make sure libsodium is installed/enabled. See above in this
README for more information.
Support Contracts
If your company uses this library in their products or services, you may be
interested in purchasing a support contract from Paragon Initiative Enterprises.
How does paragonie/halite compare to other Security projects?
paragonie/halite is tracked by TopGit in the Security category, with 1.2k GitHub stars and written in PHP. Browse the Security topic page on TopGit to compare it against similar projects by stars and activity.
Is paragonie/halite open source?
Yes — paragonie/halite ships under the MPL-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/paragonie/halite.
What else is in the Security space?
paragonie/halite is tracked by TopGit under the Security category, alongside 19 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is paragonie/halite?
paragonie/halite (paragonie/halite) is a PHP project on GitHub. From the project's own README: High-level cryptography interface powered by libsodium
Where do I read more about paragonie/halite?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/paragonie/halite is the definitive source.
Why is paragonie/halite categorized under Security?
TopGit places paragonie/halite in the Security category based on its GitHub topics and description (tagged: "argon2", "authentication", "blake2b"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Still deciding about halite?
One click hands the question to an AI along with this page — see what it says about halite.