DoctrineEncryptBundle 使用教程

1. 项目介绍

DoctrineEncryptBundle 是一个Symfony框架的扩展，用于加密和解密 Doctrine 实体。这个项目的目标是通过对实体属性进行加密，提高应用程序的数据安全性。本项目是基于ambta的DoctrineEncryptBundle进行改进和扩展的，使用了经过验证和标准化的加密库，如Halite和Defuse。

2. 项目快速启动

环境要求

• PHP 7.2 或更高版本
• Symfony 3.4 或更高版本
• Composer

安装步骤

1. 使用Composer将项目添加到您的Symfony项目中：

   composer require absolute-quantum/doctrine-encrypt-bundle
   

2. 在 config/bundles.php 文件中注册Bundle：

   return [
       // ...
       AbsoluteQuantum\getDoctrineEncryptBundle\ DoctrineEncryptBundle::class => ['all' => true],
       // ...
   ];
   

3. 配置加密服务提供者，例如使用Halite：

   # config/packages/ambta_doctrine_encrypt.yaml
   ambta_doctrine_encrypt:
       encryptor_class: 'Halite'
   

   或者使用Defuse：

   # config/packages/ambta_doctrine_encrypt.yaml
   ambta_doctrine_encrypt:
       encryptor_class: 'Defuse'
   

   如果使用Defuse，需要单独安装：

   composer require "defuse/php-encryption ^2.0"
   

4. 生成密钥（如果尚未生成）：

   php bin/console doctrine:encrypt:generate-key
   

   请确保将密钥文件（例如 .DefuseEncryptor.key 或 .HaliteEncryptor.key）添加到 .gitignore 文件中，不要将其提交到版本控制系统。

5. 重启应用程序。

3. 应用案例和最佳实践

加密实体属性

在实体中使用注解来指定哪些属性需要加密：

use Doctrine\ORM\Mapping as ORM;
use Ambta\DoctrineEncryptBundle\Configuration�Annotation as DE;

/**
 * @ORM\Entity
 * @DE\Encrypted
 */
class User
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string")
     * @DE\Encrypt
     */
    private $email;

    // ...
}

在服务中使用加密

可以在服务中注入加密器，并使用它来加密和解密数据：

namespace App\Service;

use Ambta\DoctrineEncryptBundle\Encryptors\EncryptorInterface;
use Symfony\Component\DependencyInjection\InjectionInterface;

class EncryptionService implements InjectionInterface
{
    private $encryptor;

    public function __construct(EncryptorInterface $encryptor)
    {
        $this->encryptor = $encryptor;
    }

    public function encryptData($data)
    {
        return $this->encryptor->encrypt($data);
    }

    public function decryptData($data)
    {
        return $this->encryptor->decrypt($data);
    }
}

4. 典型生态项目

• Symfony框架：DoctrineEncryptBundle 旨在与Symfony框架无缝集成，为Symfony项目提供数据加密功能。
• Doctrine ORM：该扩展与Doctrine ORM紧密集成，允许开发者轻松地对实体属性进行加密。
• Halite/Defuse：项目支持使用Halite和Defuse这两个知名的加密库，提供了更高的安全性保障。