Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/globaltradingtechnologies/crypt-bundle
Provides symfony encryptor/decryptor services based on various cryptographic components
https://github.com/globaltradingtechnologies/crypt-bundle
aes bundle decryptor encryption encryptor rsa security symfony-bundle
Last synced: 3 months ago
JSON representation
Provides symfony encryptor/decryptor services based on various cryptographic components
- Host: GitHub
- URL: https://github.com/globaltradingtechnologies/crypt-bundle
- Owner: GlobalTradingTechnologies
- License: mit
- Created: 2015-12-22T15:40:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-03-09T04:23:16.000Z (almost 5 years ago)
- Last Synced: 2024-10-13T06:22:22.791Z (3 months ago)
- Topics: aes, bundle, decryptor, encryption, encryptor, rsa, security, symfony-bundle
- Language: PHP
- Homepage:
- Size: 78.1 KB
- Stars: 6
- Watchers: 7
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CryptBundle
===========
[](https://travis-ci.org/GlobalTradingTechnologies/crypt-bundle)
[](https://packagist.org/packages/gtt/crypt-bundle)
[](//packagist.org/packages/gtt/crypt-bundle)
[](https://packagist.org/packages/gtt/crypt-bundle)
Provides a simple way to configure Symfony services for data encryption and decryption based on well-known encryption algorithms.
With the help of this CryptBundle you can encrypt or decrypt your data as simple as operate with elementary [EncryptorInterface](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/EncryptorInterface.php) or [DecryptorInterface](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/DecryptorInterface.php):
```php
use Gtt\Bundle\CryptBundle\Encryption\EncryptorInterface;
use Gtt\Bundle\CryptBundle\Encryption\DecryptorInterface;
class MyMagicService
{
/**
* Encryptor
*
* @var EncryptorInterface
*/
protected $encryptor;
/**
* Decryptor
*
* @var DecryptorInterface
*/
protected $decryptor;
public function __construct(EncryptorInterface $encryptor, DecryptorInterface $decryptor)
{
$this->encryptor = $encryptor;
$this->decryptor = $decryptor;
}
public function doSomeMagic()
{
$someStringData = "Crypt me!";
$encrypted = $this->encryptor->encrypt($someStringData);
$decrypted = $this->decryptor->decrypt($encrypted);
return $someStringData == $decrypted;
}
}
```
Implementations of [EncryptorInterface](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/EncryptorInterface.php) or [DecryptorInterface](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/DecryptorInterface.php) would be provided by CryptBundle. The choice of encryption algorithm is up to you - you can specify it in bundle config.
Requirements
============
Requires only PHP 5.6+ and symfony/framework-bundle.
Installation
============
Bundle should be installed via composer
```
composer require gtt/crypt-bundle
```
After that you need to register the bundle inside your application kernel.
Also you probably need to install specific crypto libraries such as
```
composer install zendframework/zend-crypt
composer install defuse/php-encryption
```
(You can add the libraries that you need. All of them are optional)
Encryption
==========
Under the hood bundle provides bridges to well-known php components for encrypting data as implementations of
[encryptor](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/EncryptorInterface.php) and [decryptor](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/DecryptorInterface.php) interfaces.
This implementations are registered as a Symfony services that can be used by your code. See [Usage section](#Usage) for details.
Configuration
=============
Bundle configuration defines one or several cryptor-sections grouped by encryption-type (for now supported types are aes and rsa) and the name of the pair of encryptor and decryptor (_aes_binary_cryptor_, _aes_log_cryptor_ and _rsa_default_cryptor_ in example below).
Each cryptor-section contains options for defining the pair of encryptor and decryptor of certain encryption type.
Tou can turn on automatic encryption for database strings when using [doctrine/dbal](https://github.com/doctrine/dbal).
You can see example that holds configs for 2 pairs of aes encryptor and decryptor and one pair of rsa encryptor and decryptor
and uses *rsa_default_cryptor* for encrypting database values:
```yml
gtt_crypt:
cryptors:
aes:
aes_binary_cryptor:
key_size: 128
key_path: "/tmp/keys/aes/first.key"
binary_output: true
aes_log_cryptor:
key_size: 128
key_path: "/tmp/keys/aes/second.key"
binary_output: false
rsa:
rsa_default_cryptor:
private_key: "/tmp/keys/rsa/priv.key"
public_key: "/tmp/keys/rsa/pub.key"
binary_output: false
padding: 4
doctrine:
dbal:
encrypted_string: rsa_default_cryptor
```
You can see reference of configuration options for supported encryption types:
### RSA
- private_key - path to RSA private key
- pass_phrase - RSA private key passphrase
- public_key - path to RSA public key
- binary_output - should be result of encryption encoded with base64 algorithm or should be input string base64-decoded before decryption
- padding - number of distinct practices which all include adding data to the message prior to encryption.
Should be one of constants from list below:
-- OPENSSL_PKCS1_PADDING
-- OPENSSL_SSLV23_PADDING
-- OPENSSL_NO_PADDING
-- OPENSSL_PKCS1_OAEP_PADDING
### AES
- key_size - AES key size. Should be 128 for 1.x or 256 for 2.x version of [defuse/php-encryption](https://github.com/defuse/php-encryption/)
- key_path - path to AES private key. Can be generated by built in [crypt:aes:generate-key](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Command/GenerateKeyCommand.php) command
- binary_output - should be result of encryption encoded with base64 algorithm or should be input string base64-decoded before decryption
Usage
=====
In order to use encryptos and decryptors in your code you have 3 availabilities:
### Tag your service (recommended)
The prefered way to receive encryptor or decryptor in you service is to implement in the service's class very simple [EncryptorAwareInterface](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/EncryptorAwareInterface.php) or [DecryptorAwareInterface](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/DecryptorAwareInterface.php).
You can also use traits in most cases if you are too lazy: [SingleDecryptorAwareTrait](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/SingleDecryptorAwareTrait.php) and [SingleEncryptorAwareTrait](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/Encryption/SingleEncryptorAwareTrait.php).
After that you should tag the service with `gtt.crypt.encryptor.aware` or `gtt.crypt.decryptor.aware` tag (depends on whether you want to get encryptor or decryptor) and specify cryptor name in tag attribute `cryptor_name`.
For example if you use configuration such as in [Configuration section](#Configuration) the _cryptor_name_ attribute value can be one of _aes_binary_cryptor_, _aes_log_cryptor_ or _rsa_default_cryptor_.
The setter injection (setters are defined in EncryptorAwareInterface/DecryptorAwareInterface interfaces) would be done by [CryptorInjectorPass](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/DependencyInjection/Compiler/CryptorInjectorPass.php).
```yml
services:
gtt_encryptor_holder:
class: Your\Class\That\Wants\To\Receive\Encryptor
tags:
- { name: gtt.crypt.encryptor.aware, cryptor_name: "aes_binary_cryptor" }
gtt_decryptor_holder:
class: Your\Class\That\Wants\To\Receive\Decryptor
tags:
- { name: gtt.crypt.decryptor.aware, cryptor_name: "aes_binary_cryptor" }
```
### Inject cryptors directly by service id
Each encryptor or decryptor configured by CryptBundle is a service with id constructed in accordance with the following pattern:
`gtt.crypt.encryptor.` for encryptors and `gtt.crypt.decryptor.`, where holds corresponding cryptor name defined in bundle config.
For example if you use configuration such as in [Configuration section](#Configuration) the value can be one of _aes_binary_cryptor_, _aes_log_cryptor_ or _rsa_default_cryptor_.
You can simply inject these services in DI-configs of your bundles.
### Use cryptor registry
Crypt-bundle also registers [CryptorRegistry](https://github.com/GlobalTradingTechnologies/crypt-bundle/blob/master/CryptorRegistry.php) service with id _gtt.crypt.registry_ that collects all the encryptors and decryptors configured.
You can use it to get cryptors by calling getEncryptor or getDecryptor methods with name of the encryptor or decryptor specified.
For example if you use configuration such as in [Configuration section](#Configuration) the name can be one of _aes_binary_cryptor_, _aes_log_cryptor_ or _rsa_default_cryptor_.
### Encrypting database values
When database value encryption is enabled the `encrypted_string` dbal type is automatically registered. You can use this
type inside doctrine entities or direct dbal queries.
```php
use Gtt\Bundle\CryptBundle\Bridge\Doctrine\DBAL\Enum\TypeEnum;
$this->connection->executeQuery(
'INSERT INTO something VALUES(:my_secret)',
['my_secret' => 'A very secret value'],
['my_secret' => TypeEnum::ENCRYPTED_STRING]
)
```
Supported encryption components
===============================
* RSA (Based on [zendframework/zend-crypt](https://github.com/zendframework/zend-crypt))
* AES (Based on [defuse/php-encryption](https://github.com/defuse/php-encryption/))