https://github.com/elusivecodes/fyreencryption
FyreEncryption is a free, open-source encryption library for PHP.
https://github.com/elusivecodes/fyreencryption
encryption library openssl php sodium
Last synced: 6 months ago
JSON representation
FyreEncryption is a free, open-source encryption library for PHP.
- Host: GitHub
- URL: https://github.com/elusivecodes/fyreencryption
- Owner: elusivecodes
- License: mit
- Created: 2021-06-15T11:13:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-10T01:15:33.000Z (7 months ago)
- Last Synced: 2024-11-10T02:20:00.721Z (7 months ago)
- Topics: encryption, library, openssl, php, sodium
- Language: PHP
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FyreEncryption
**FyreEncryption** is a free, open-source encryption library for *PHP*.
## Table Of Contents
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Methods](#methods)
- [Encrypters](#encrypters)
- [OpenSSL](#openssl)
- [Sodium](#sodium)
## Installation
**Using Composer**
```
composer require fyre/encryption
```
In PHP:
```php
use Fyre\Encryption\EncryptionManager;
```
## Basic Usage
- `$container` is a [*Container*](https://github.com/elusivecodes/FyreContainer).
- `$config` is a [*Config*](https://github.com/elusivecodes/FyreConfig).
```php
$encryptionManager = new EncryptionManager($container, $config);
```
Default configuration options will be resolved from the "*Encryption*" key in the [*Config*](https://github.com/elusivecodes/FyreConfig).
**Autoloading**
It is recommended to bind the *EncryptionManager* to the [*Container*](https://github.com/elusivecodes/FyreContainer) as a singleton.
```php
$container->singleton(EncryptionManager::class);
```
Any dependencies will be injected automatically when loading from the [*Container*](https://github.com/elusivecodes/FyreContainer).
```php
$encryptionManager = $container->use(EncryptionManager::class);
```
## Methods
**Build**
Build an [*Encrypter*](#encrypters).
- `$options` is an array containing configuration options.
```php
$encrypter = $encryptionManager->build($options);
```
[*Encrypter*](#encrypters) dependencies will be resolved automatically from the [*Container*](https://github.com/elusivecodes/FyreContainer).
**Clear**
Clear all instances and configs.
```php
$encryptionManager->clear();
```
**Get Config**
Get an [*Encrypter*](#encrypters) config.
- `$key` is a string representing the [*Encrypter*](#encrypters) key.
```php
$config = $encryptionManager->getConfig($key);
```
Alternatively, if the `$key` argument is omitted an array containing all configurations will be returned.
```php
$config = $encryptionManager->getConfig();
```
**Has Config**
Determine whether an [*Encrypter*](#encrypters) config exists.
- `$key` is a string representing the [*Encrypter*](#encrypters) key, and will default to `EncryptionManager::DEFAULT`.
```php
$hasConfig = $encryptionManager->hasConfig($key);
```
**Is Loaded**
Determine whether an [*Encrypter*](#encrypters) instance is loaded.
- `$key` is a string representing the [*Encrypter*](#encrypters) key, and will default to `EncryptionManager::DEFAULT`.
```php
$isLoaded = $encryptionManager->isLoaded($key);
```
**Set Config**
Set the [*Encrypter*](#encrypters) config.
- `$key` is a string representing the [*Encrypter*](#encrypters) key.
- `$options` is an array containing configuration options.
```php
$encryptionManager->setConfig($key, $options);
```
**Unload**
Unload an [*Encrypter*](#encrypters).
- `$key` is a string representing the [*Encrypter*](#encrypters) key, and will default to `EncryptionManager::DEFAULT`.
```php
$encryptionManager->unload($key);
```
**Use**
Load a shared [*Encrypter*](#encrypters) instance.
- `$key` is a string representing the [*Encrypter*](#encrypters) key, and will default to `EncryptionManager::DEFAULT`.
```php
$encrypter = $encryptionManager->use($key);
```
[*Encrypter*](#encrypters) dependencies will be resolved automatically from the [*Container*](https://github.com/elusivecodes/FyreContainer).
## Encrypters
You can load a specific encrypter by specifying the `className` option of the `$options` variable above.
Custom encrypters can be created by extending `\Fyre\Encryption\Encrypter`, ensuring all below methods are implemented.
**Decrypt**
Decrypt data.
- `$data` is the encrypted data.
- `$key` is a string representing the encryption key.
```php
$decrypted = $encrypter->decrypt($data, $key);
```
**Encrypt**
Encrypt data.
- `$data` is the data to encrypt.
- `$key` is a string representing the encryption key.
```php
$encrypted = $encrypter->encrypt($data, $key);
```
**Generate Key**
Generate an encryption key.
```php
$key = $encrypter->generateKey();
```
### OpenSSL
The OpenSSL encrypter can be loaded using default configuration using the "*openssl*" key.
```php
$encrypter = $encryptionManager->use('openssl');
```
You can also load the OpenSSL encrypter using custom configuration.
- `$options` is an array containing configuration options.
- `className` must be set to `\Fyre\Encryption\Handlers\OpenSSLEncrypter::class`.
- `cipher` is a string representing the cipher, and will default to "*AES-256-CTR*".
- `digest` is a string representing the digest, and will default to "*SHA512*".
```php
$container->use(Config::class)->set('Encryption.openssl', $options);
```
### Sodium
The Sodium encrypter is the default handler.
```php
$encrypter = $encryptionManager->use();
```
You can also load the Sodium encrypter using custom configuration.
- `$options` is an array containing configuration options.
- `className` must be set to `\Fyre\Encryption\Handlers\SodiumEncrypter::class`.
- `blockSize` is a number representing the block size, and will default to *16*.
- `digest` is a string representing the digest, and will default to "*SHA512*".
```php
$container->use(Config::class)->set('Encryption.default', $options);
```