Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.88 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.88 KB

Logo

Build status License Latest version Latest Unstable Version Total downloads Downloads this month

Introduction

This is a fork from the original bundle created by ambta which can be found here: ambta/DoctrineEncryptBundle

This bundle has updated security by not rolling it's 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

Demo

Two demo-installations, one using symfony 4.4 and one using symfony 6.x, can be found in this repository in demo. This demonstrates how to use the application using both annotations and, when using php > 8.0, attributes.