somecoding/laminas-doctrine-encrypt

当在Laminas中使用时,为Doctrine实体提供属性加密和哈希功能


README

提供Laminas & Doctrine 2加密模块。支持Mezzio。

安装

composer require somecoding/laminas-doctrine-encrypt

需求

  • PHP 8.1或更高版本(必须启用Sodium扩展)

如果你在Windows上使用Xampp,PHP 8.1的安装可能不会自动启用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 / Laminas

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

附加

使用的配置使用了别名,如hashing_serviceencryption_adapter。您可以使用自己的配置覆盖这些,以实现自己的Service和/或Adapter类。如果实现了正确的接口类,这些将自动被此模块使用。但在进行任何操作之前,请确保阅读代码。

模块

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

但是,必须说明,在编写此ReadMe时,Halite模块包含重复的const声明,因此您必须在PHP配置中禁用您的E_NOTICE警告 :(

Mezzio

当使用Mezzio时,您需要将ConfigProvider添加到您的config/config.php文件中。

    \Keet\Encrypt\ConfigProvider::class,

当声明实体路径(可能是包含App\ConfigProvider的文件)时,请确保将路径作为数组传递。

    'my_entity' => [
        'class' => AnnotationDriver::class,
        'cache' => 'array',
        'paths' => [ __DIR__ . '/Entity' ],
    ],

注解示例

加密

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

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

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

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

/**
 * @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);