brandoriented/doctrine-encryption-bundle

Doctrine encryption bundle for Symfony to aid with GDPR and general field encryption

1.1.1 2018-05-23 09:02 UTC

Requires

• php: >=7
• doctrine/common: 2.*
• doctrine/dbal: 2.*
• doctrine/orm: 2.*
• symfony/symfony: 3.*
• twig/twig: 1.*

MIT

• Matthew Thomas
• Dominik Labudzinski

• orm
• symfony
• bundle
• doctrine
• encryption
• gdpr

README

With GDPR becoming business critical here's a bundle that handles the data encryption layer.

Installation

composer require brandoriented/doctrine-encryption-bundle dev-master

   app/AppKernel.php
   
   
    public function registerBundles()
    {
        $bundles = [
            ...
            new BrandOriented\Encryption\DoctrineEncryptionBundle(),
            ...
        ];
    }

Configuration

Basic

Basic configuration will take advantage of the encryption library provided

doctrine_encryption:
  key: 'an encryption key'
  iv: 'an encryption iv'
  suffix: 'an encryption suffix'

Full

doctrine_encryption:
  key: 'an encryption key'
  iv: 'an encryption iv'
  suffix: 'an encryption suffix'
  method: 'AES-256-CBC' // This is the default setting
  class: 'Full\Namespace\To\Your\Encryptor' // If not supplied will use the default

Usage

Using the encryption service in controller

use BrandOriented\Encryption\Bridge\Bridge;

$this->get(Bridge::class)->encrypt($string)
$this->get(Bridge::class)->decrypt($string);

Entity Annotation

    use BrandOriented\Encryption\Annotation\Encrypted;

    class User {
       /**
       * @Encrypted()
       */
       private $firstname;
    
    }

The above will auto encrypt on prePersist and preUpdate

Twig

{{ user.firstname | decrypt }}

Design decision

You'll notice there is no postLoad event to convert back to decrypted. Experience with doctrine is that as the entity is changed it adds it to the queue to be flushed. Say if you have an account with 1000 users each user would be decrypted meaning re saved.

How to add a custom Encryptor

Create a class that extends BrandOriented\Encryption\Encryptor\EncryptorInterface. Then register as mentioned in the above config.

Tests

Yes there a loads of lovely unit tests :)

Roadmap

• Form inputs
• Command line util
• Travis integration