Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rkeet/zf-doctrine-encrypt

Provides encryption and hashing with Zend Framework 3 & Doctrine 2 - provides default adapters using Halite / Sodium
https://github.com/rkeet/zf-doctrine-encrypt

doctrine-orm doctrine2 encryption event gdpr hashing php php72 sodium zend-framework3

Last synced: 3 months ago
JSON representation

Provides encryption and hashing with Zend Framework 3 & Doctrine 2 - provides default adapters using Halite / Sodium

Awesome Lists containing this project

README 

        
# Zend Framework 3 & Doctrine Encrypt Module



Provides a Zend Framework 3 & Doctrine 2 encryption module.



# Installation



    composer require rkeet/zf-doctrine-encrypt

    

# Requirements



 * PHP 7.2 or greater (must have Sodium extension enabled)

 

If you're on Windows, using Xampp, the PHP 7.2 installation might not automatically enable the Sodium extension. If this

the case, you'll get an error (`'This is not implemented, as it is not possible to securely wipe memory from PHP'`). 

Enable Sodium for PHP by adding this to your `php.ini` file:



    extension = C:\xampp\php\ext\php_sodium.dll



This might also be applicable ot other local installations.  



# Configuration



## Zend Framework



Make sure to add the module to you application configuration. In your `modules.config.php` make sure to include 

`Keet\\Encrypt`.



### Additional



The configuration which is used makes use of aliases, such as `hashing_service` and `encryption_adapter`. You may override these with your own config to implement your own Service and/or Adapter classes. These will automatically be used by this module if the correct Interface classes are implemented. Make sure to read through the code before you do any of this though.



## Module



`*.dist` files are provided. Copy these (remove extension) to your application and fill in the required key/salt values. 

If these are filled in, it works out of the box using [Halite](https://github.com/paragonie/halite) for encryption. 



However, must be said, at the moment of writing this ReadMe, the Halite module contains duplicate `const` declarations,

as such, you must disable your `E_NOTICE` warnings in your PHP config :(



## Annotation Examples



### Encryption



Simple, consider that you have an `Address` Entity, which under the [EU GDPR regulation](https://www.eugdpr.org/)

requires parts of the address, such as the street, to be encrypted. This uses the key & salt required for the config

by default



To encrypt a street name, add `@Encrypted` like so: 



    /**

     * @var string

     * @ORM\Column(name="street", type="text", nullable=true)

     * @Encrypted

     */

    protected $street;

    

By default the Encryption service assumes that the data to be encrypted is of the type `string`. However, you could have

a requirement to encrypt another type of data, such as a house number. Non-string types are supported, but the type of data

must be provided if not a string. You can do this like so:



    /**

     * @var int

     * @ORM\Column(name="house_number", type="text", nullable=false)

     * @Encrypted(type="int")

     */

    protected $houseNumber;

    

Supported types are [found here](http://php.net/settype).



### Cyphertext representation



The cypher text always results in a string with varying length always longer than 255 chars.

Therefore you should use a datatype capable of representing the full length of it. 

Be aware that any non-string property will be handled as a string representation in the database.



### Hashing



Say you'd like to store a password, it should work in much of the same way as the above. However, it is data that should

not be de-cryptable (and there's no need for it to ever be decrypted), thus you should hash it instead.



To hash something, like a password, add the `@Hashed` Annotation. See the example below.



    /**

     * @var string

     * @ORM\Column(name="password", type="text", nullable=false)

     * @Hashed

     */

    protected $password;

    

**Note** that, unlike `@Encrypted`, there aren't options to give a type. As we can't decrypt the data (it's one-way), 

there's no need to know what the original type was. The response will always be string value.



## Controller Examples



### Hashing



A `HashingService` is provided. This service also uses the `HashingAdapter` but provides functionality that 

can be used in Controllers and other classes, such as plugins. The service is registered under the alias 'hashing_service'.

You can override 'hasing_service' in your own project to provide your own implementation. 



The `HashingService` provides the ability to hash and verify strings. These are two separate operations, one one-way 

hashes a string. The other does the same (requires the hashed string) and then verifies that both strings are 

exactly the same (thus verifying).



In a Controller, to hash a string, simply do:



    $secret = $this->getHashingService()->hash('correct horse battery staple');

    

To verify that your dealing the same string a next time, for example to compare passwords on login, do:



    $verified = $this->getHashingService()->verify('correct horse battery staple', $secret);

    

`$verified` will be set to a boolean value. 



To not store any entered data longer than you must, you could compare directly from form data, like so:



    if($form->isValid() && $this->getHashingService()->verify($form->getData()['password_field'], $user->getPassword()) {

        // do other things

    }

 

### Encryption

 

An `EncryptionService` is also provided and works in much the same way as the `HashingService`. It provides functionality to encrypt and to decrypt data. 



To encrypt data, do:



    $encrypted = $this->getEncryptionService()->encrypt('correct horse battery staple');

    

To decrypt data, do: 



    $decrypted = $this->getEncryptionService()->decrypt($string);