jfnetwork/doctrine-encrypted-object

Doctrine mapping type to store encrypted objects

2.1.0 2021-07-08 06:34 UTC

Requires

• php: >=7.0
• defuse/php-encryption: ^2.1
• doctrine/orm: ^2.5
• symfony/config: >=4.0
• symfony/dependency-injection: >=4.0
• symfony/http-kernel: >=4.0

MIT

• Anton Eremin

README

This bundle implement a doctrine mapping type for objects, that should be encrypted in storage.

Install

The bundle can be installed with composer:

composer require jfnetwork/doctrine-encrypted-object

Then it should be added to your bundle list:

Symfony 4

bundles.php:

<?php

return [
    ...,
    Jfnetwork\DoctrineEncryptedObject\DoctrineEncryptedObjectBundle::class => ['all' => true],
];

Sample Configuration

doctrine_encrypted_object:
    key: '%env(DOCTRINE_ENCRYPTED_OBJECT_KEY)%'

And the ENV variable should be generated with command:

vendor/bin/generate-defuse-key

More info about key generation at tutorial from defuse/php-encryption package

Usage

/**
 * @ORM\Column(name="your_secure_field", type="encoded_object")
 */
private $yourSecureField;

Upgrade from 1.0 to 1.1

The field type was changed from TEXT to BLOB with 1.1. The Doctrine should make a suitable migration for you. Optionally you can add update query from HEX values to binary. For example for MySQL:

UPDATE `your_table` SET `your_secret_field` = UNHEX(`your_secret_field`)