reprovinci/doctrine-encrypt

Package encrypts and decrypts Doctrine fields through life cycle events.

v3.0.5 2017-06-13 07:33 UTC

This package is not auto-updated.

Last update: 2024-10-07 13:52:48 UTC


README

Package encrypts and decrypts Doctrine fields through life cycle events.

Installation

Add reprovinci/doctrine-encrypt to your Composer manifest.

{
    "require": {
        "reprovinci/doctrine-encrypt": "~3.0"
    }
}

Configuration

Add the event subscriber to your entity manager's event manager. Assuming $em is your configured entity manager:

<?php

# You should pick your own hexadecimal secret
$secret = pack("H*", "dda8e5b978e05346f08b312a8c2eac03670bb5661097f8bc13212c31be66384c");

$subscriber = new DoctrineEncryptSubscriber(
    new \Doctrine\Common\Annotations\AnnotationReader,
    new \Reprovinci\DoctrineEncrypt\Encryptors\AES256Encryptor($secret)
);

$eventManager = $em->getEventManager();
$eventManager->addEventSubscriber($encrypt_subscriber);

Usage

<?php

namespace Your\Namespace;

use Doctrine\ORM\Mapping as ORM;

use Reprovinci\DoctrineEncrypt\Configuration\Encrypted;

/**
 * @ORM\Entity
 */
class Entity
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     * @ORM\Column(type="integer")
     * @var int
     */
    protected $id;

    /**
     * @ORM\Column(type="text")
     * @Encrypted
     * @var string
     */
    protected $secret_data;
}

License

This bundle is under the MIT license. See the complete license in the bundle

Versions

I'm using Semantic Versioning like described here.