Skip to content
The Nuxed Crypto component provides a high-level cryptography interface that relies on libsodium for all of its underlying cryptography operations.
Hack Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/Nuxed/Crypto
tests
.gitattributes
.gitignore
.hhconfig
.travis.sh
.travis.yml
LICENSE
README.md
SECURITY.md
composer.json
hh_autoload.json
hhast-lint.json

README.md

Build Status Total Downloads Latest Stable Version License

Nuxed Crypto

The Nuxed Crypto component provides a high-level cryptography interface that relies on libsodium for all of its underlying cryptography operations.

inspired by Halite.

Important

Although this library has developed with care, it has not been examined by security experts, there will always be a chance that we overlooked something. Please ask your favourite trusted hackers to hammer it for implementation errors and bugs before even thinking about deploying it in production.

Installation

This package can be installed with Composer.

$ composer require nuxed/crypto

Example

use namespace Nuxed\{Crypto, Filesystem};
use namespace Nuxed\Crypto\Symmetric;

<<__EntryPoint>>
async function main(): Awaitable<void> {
  // generate a key :
  $key = Symmetric\Encryption\Key::generate();
  
  // or load a stored encryption key :
  $file = new Filesystem\File('/path/to/encryption.key');
  $key = $key = Symmetric\Encryption\Key::import(
    new Crypto\HiddenString(await $file->read())
  );

  $message = new Crypto\HiddenString('Hello, World!');
  $ciphertext = Symmetric\Encryption\encrypt($message, $key);
  $plaintext = Symmetric\Encryption\decrypt($ciphertext, $key);

  print $plaintext->toString(); // Hello, World!
}

Security

For information on reporting security vulnerabilities in Nuxed, see SECURITY.md.


License

Nuxed is open-sourced software licensed under the MIT-licensed.

You can’t perform that action at this time.