DoctrineEncryptBundle 安装与配置指南

1. 项目基础介绍

DoctrineEncryptBundle 是一个为 Symfony 框架设计的加密bundle，用于加密 Doctrine 实体。该项目是基于 ambta/DoctrineEncryptBundle 的一个分支，主要改进了安全性，不再使用自定义加密，而是使用经过验证的标准库。该项目使用 PHP 作为主要编程语言。

2. 关键技术和框架

• Symfony: 一个用于开发PHP应用程序的免费、开源的web框架。
• Doctrine: 一个PHP对象关系映射（ORM）工具，用于将PHP对象映射到数据库中的表。
• Halite: 一个基于libsodium的加密库，提供了简单易用的加密功能。
• Defuse/php-encryption: 另一个加密库，需要单独安装。

3. 安装和配置准备工作

在开始安装之前，请确保您的环境中已经安装了以下依赖：

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

确保您的系统满足以上要求后，可以按照以下步骤进行安装。

安装步骤

1. 克隆项目

   使用 Git 克隆项目到您的本地环境：

   git clone https://github.com/absolute-quantum/DoctrineEncryptBundle.git
   

2. 安装依赖

   进入项目目录，使用 Composer 安装项目依赖：

   cd DoctrineEncryptBundle
   composer install
   

3. 配置Bundle

   在 config/bundles.php 文件中，注册 DoctrineEncryptBundle：

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

4. 配置加密库

   根据您选择的加密库（Halite 或 Defuse）进行配置。

   • 使用 Halite：在 config/packages/ambta_doctrine_encrypt.yaml 中配置如下：

     ambta_doctrine_encrypt:
         encryptor_class: Halite
     

   • 使用 Defuse：首先需要安装 Defuse 库：

     composer require "defuse/php-encryption:^2.0"
     

     然后在配置文件中设置：

     ambta_doctrine_encrypt:
         encryptor_class: Defuse
     

5. 生成密钥

   根据所选加密库生成密钥，并将其放在 .gitignore 文件中指定的目录下。

   • 对于 Halite，密钥文件可能名为 .HaliteEncryptor.key。
   • 对于 Defuse，密钥文件可能名为 .DefuseEncryptor.key。

6. 完成配置

   确保所有配置正确无误，并且已经将必要的更改应用到您的 Symfony 项目中。

完成以上步骤后，您的 Symfony 项目就应该已经成功集成了 DoctrineEncryptBundle，并可以开始使用加密功能了。请记得根据项目文档和需求进一步配置和测试。