README

Introduction

This version of the DoctrineEncryptBundle was initially forked from: integr8rs/DoctrineEncryptBundle

This version was created due to be maintained and managed by a GitHub organization (DoctrineEncryptBundle) due to all previous versions that were installable not being actively maintained any longer. This includes the most popular on as well: michaeldegroot/doctrine-encrypt-bundle

The original bundle created by ambta can be found here: -ambta/DoctrineEncryptBundle

This bundle has updated security by not rolling its own encryption and using verified standardized library's from the field.

Using Halite

All deps are already installed with this package

// Config.yml
ambta_doctrine_encrypt:
    encryptor_class: Halite

Using Defuse

You will need to require Defuse yourself

composer require "defuse/php-encryption ^2.0"

// Config.yml
ambta_doctrine_encrypt:
    encryptor_class: Defuse

Secret key

The secret key should be a max 32 byte hexadecimal string ([0-9a-fA-F]).

Secret key is generated if there is no key found. This is automatically generated and stored in the folder defined in the configuration

// Config.yml
ambta_doctrine_encrypt:
    secret_directory_path: '%kernel.project_dir%'   # Default value

Filename example: .DefuseEncryptor.key or .HaliteEncryptor.key

Do not forget to add these files to your .gitignore file, you do not want this on your repository!

Documentation

• Installation
• Requirements
• Configuration
• Usage
• Console commands
• Upgrading
• Custom encryption class

Demo

Demo-installations can be found in this repository within the demo directory. These demonstrates how to use the various supported encryption and decryption implementations.