https://github.com/petrknap/php-crypto-sodium

The library that packages functional `sodium_crypt_*` into objects.
https://github.com/petrknap/php-crypto-sodium

aead aes asymmetric-cryptography block-cipher chacha20 cryptography curve25519 decryption encryption php php-library poly1305 public-key-cryptography secret-key-cryptography security sodium stream-cipher symmetric-cryptography x25519 xchacha20

Last synced: about 1 month ago
JSON representation

The library that packages functional `sodium_crypt_*` into objects.

• Host: GitHub
• URL: https://github.com/petrknap/php-crypto-sodium
• Owner: petrknap
• License: lgpl-3.0
• Created: 2024-04-18T13:42:38.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T11:25:30.000Z (about 2 months ago)
• Last Synced: 2024-10-28T12:09:22.760Z (about 2 months ago)
• Topics: aead, aes, asymmetric-cryptography, block-cipher, chacha20, cryptography, curve25519, decryption, encryption, php, php-library, poly1305, public-key-cryptography, secret-key-cryptography, security, sodium, stream-cipher, symmetric-cryptography, x25519, xchacha20
• Language: PHP
• Homepage:
• Size: 84 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: COPYING
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# Crypto Sodium

A simple library that packages [functional `sodium_crypt_*`](https://www.php.net/manual/en/book.sodium.php) into objects.

Inputs and outputs are binary data, don't be afraid to use the [`petrknap/binary`](https://github.com/petrknap/php-binary).

## Examples

### Symmetric block encryption

```php

use PetrKnap\CryptoSodium\SecretBox;

$secretBox = new SecretBox();

$message = 'Hello World!';

$key = $secretBox->generateKey();

$ciphertext = $secretBox->encrypt($message, $key);

echo $secretBox->decrypt($ciphertext, $key);

$secretBox->eraseData($key);

```

### Asymmetric block encryption

```php

use PetrKnap\CryptoSodium\Box;

$box = new Box();

$message = 'Hello World!';

$keyPair = $box->generateKeyPair();

$ciphertext = $box->encrypt($message, $keyPair);

echo $box->decrypt($ciphertext, $keyPair);

$box->eraseData($keyPair);

```

### Symmetric stream encryption

```php

use PetrKnap\CryptoSodium\SecretStream\XChaCha20Poly1305;

$xChaCha20Poly1305 = new XChaCha20Poly1305();

$messageChunk1 = 'Hello ';

$messageChunk2 = 'World!';

$key = $xChaCha20Poly1305->generateKey();

$pushStream = $xChaCha20Poly1305->initPush($key);

$ciphertextHeader = $pushStream->header;

$ciphertextChunk1 = $pushStream->push($messageChunk1);

$ciphertextChunk2 = $pushStream->push($messageChunk2, tag: XChaCha20Poly1305::TAG_FINAL);

$pullStream = $xChaCha20Poly1305->initPull($ciphertextHeader, $key);

echo $pullStream->pull($ciphertextChunk1);

echo $pullStream->pull($ciphertextChunk2);

$xChaCha20Poly1305->eraseData($key);

```

### Symmetric block encryption with additional data

```php

use PetrKnap\CryptoSodium\Aead\Aes256Gcm;

$aes256Gcm = new Aes256Gcm();

$message = 'Hello World!';

$purpose = 'example';

$key = $aes256Gcm->generateKey();

$ciphertext = $aes256Gcm->encrypt($message, $key, additionalData: $purpose);

echo $aes256Gcm->decrypt($ciphertext, $key, additionalData: $purpose);

$aes256Gcm->eraseData($key);

```

---

Run `composer require petrknap/crypto-sodium` to install it.

You can [support this project via donation](https://petrknap.github.io/donate.html).

The project is licensed under [the terms of the `LGPL-3.0-or-later`](./COPYING.LESSER).