README

提供Zend Framework 3 & Doctrine 2加密模块。

安装

composer require rkeet/zf-doctrine-encrypt

要求

PHP 7.2或更高版本（必须启用Sodium扩展）

如果您在Windows上使用Xampp，PHP 7.2的安装可能不会自动启用Sodium扩展。如果是这种情况，您将收到错误（'This is not implemented, as it is not possible to securely wipe memory from PHP'）。通过将以下内容添加到您的php.ini文件来为PHP启用Sodium

extension = C:\xampp\php\ext\php_sodium.dll

这也可能适用于其他本地安装。

配置

Zend Framework

确保将模块添加到您的应用程序配置中。在您的modules.config.php中，确保包含Keet\\Encrypt。

附加信息

使用的配置使用别名，例如hashing_service和encryption_adapter。您可以使用自己的配置来覆盖这些，以实现自己的Service和/或Adapter类。如果实现了正确的接口类，这些将自动由该模块使用。但在进行这些操作之前，请务必阅读代码。

模块

提供*.dist文件。将这些文件（删除扩展名）复制到您的应用程序中，并填写所需的密钥/盐值。如果已填写，则使用Halite进行加密即可。

然而，必须说明的是，在撰写本README时，Halite模块包含重复的const声明，因此您必须在PHP配置中禁用您的E_NOTICE警告:(

注解示例

加密

简单来说，假设您有一个Address实体，根据EU GDPR法规，地址的部分，如街道，需要进行加密。这使用默认配置所需的密钥和盐

要加密街道名称，添加@Encrypted，如下所示

/**
 * @var string
 * @ORM\Column(name="street", type="text", nullable=true)
 * @Encrypted
 */
protected $street;

默认情况下，加密服务假设要加密的数据类型为 字符串。但是，您可能需要加密其他类型的数据，例如门牌号。非字符串类型是支持的，但如果数据类型不是字符串，则必须提供数据类型。您可以这样操作：

/**
 * @var int
 * @ORM\Column(name="house_number", type="text", nullable=false)
 * @Encrypted(type="int")
 */
protected $houseNumber;

支持的数据类型可以在这里找到。

密文表示

密文总是结果为一个长度可变的字符串，长度总是大于255个字符。因此，您应该使用能够表示其完整长度的数据类型。请注意，任何非字符串属性在数据库中都将被处理为字符串表示。

哈希

假设您想要存储密码，它应该与上面的操作类似。然而，这是一种不应被解密的数据（并且不需要解密），因此您应该对它进行哈希处理。

要哈希某些内容，如密码，请添加@Hashed注解。请参阅下面的示例。

/**
 * @var string
 * @ORM\Column(name="password", type="text", nullable=false)
 * @Hashed
 */
protected $password;

注意，与@Encrypted不同，没有选项来指定类型。由于我们不能解密数据（它是一向的），因此不需要知道原始类型是什么。响应始终是字符串值。

控制器示例

哈希

提供了一个HashingService。此服务也使用HashingAdapter，但提供了可以在控制器和其他类（如插件）中使用的功能。服务在别名为'hashing_service'下注册。您可以在自己的项目中重写'hashing_service'以提供自己的实现。

HashingService提供了哈希和验证字符串的能力。这两个操作是分开的，一个是一向哈希字符串。另一个（需要哈希字符串）执行相同的操作，然后验证两个字符串是否完全相同（从而验证）。

在控制器中，要哈希字符串，只需这样做：

$secret = $this->getHashingService()->hash('correct horse battery staple');

要验证您下次处理的是相同的字符串，例如在登录时比较密码，可以这样操作：

$verified = $this->getHashingService()->verify('correct horse battery staple', $secret);

$verified将设置为布尔值。

为了不存储超过必须存储的任何输入数据，您可以直接从表单数据中比较，如下所示：

if($form->isValid() && $this->getHashingService()->verify($form->getData()['password_field'], $user->getPassword()) {
    // do other things
}

加密

还提供了一个EncryptionService，它的工作方式与HashingService类似。它提供了加密和解密数据的功能。

要加密数据，请这样做：

$encrypted = $this->getEncryptionService()->encrypt('correct horse battery staple');

要解密数据，请这样做：

$decrypted = $this->getEncryptionService()->decrypt($string);

rkeet / zf-doctrine-encrypt

维护者

详细信息