README

一个用于自动加密和解密Laravel 5.5+中Eloquent属性包，基于配置设置。

本项目旨在创建一个设置即可忘记的包，无需太多努力即可自动加密和解密存储在数据库表中的Eloquent模型属性，实现透明化。因此，它具有高度的意见性，但专为配置而构建。

启用后，它会自动开始加密存储在模型属性中的数据，并在从模型属性中检索数据时解密数据。

所有加密的数据都带有头部，以便可以轻松识别加密数据、轮换加密密钥以及（可选）加密数据格式的版本控制。

这支持存储加密或未加密数据的列，以便迁移更容易。数据可以正确地从列中读取，无论是否加密，但将其保存回这些列时将自动加密。即使数据库中存储的底层值被此包加密，标准的Laravel Eloquent功能（如属性转换）也将正常工作。

有关 laravel-database-encryption 的在线文档，请访问 https://austinheap.github.io/laravel-database-encryption/，其源文件位于 docs/ 目录。最佳起点是 HasEncryptedAttributes 特性文档。

目录

• 摘要
• 要求
• 模式
• 安装
  • 步骤 1: Composer
  • 步骤 2: 启用包（可选）
  • 步骤 3: 配置包
• 使用方法
• 密钥和IV
• 单元测试
• 覆盖
• 常见问题解答
  • 我可以手动加密或解密任意数据吗？
  • 我可以搜索加密数据吗？
  • 我可以加密所有 User 模型数据吗？
  • 此包是否与 elocryptfive 兼容？
• 实现
• 致谢
• 贡献
• 许可证

要求

• Laravel 5.5.*
• PHP >= 7.1.0
• PHP OpenSSL 扩展

模式

加密值通常比纯文本值长，有时要长得多。您可能会发现，您数据库表中的列宽度需要更改，以存储此包生成的加密值。

如果您正在加密长字符串，例如JSON blob，则加密值可能比 VARCHAR 字段支持的长度长，您需要将列类型更改为 TEXT 或 LONGTEXT。

常见问题解答包含从 elocryptfive 迁移的 迁移说明。

安装

步骤 1: Composer

通过Composer命令行

$ composer require austinheap/laravel-database-encryption

或将包添加到您的 composer.json

{
    "require": {
        "austinheap/laravel-database-encryption": "0.1.0"
    }
}

步骤 2: 启用包（可选）

此包实现了Laravel 5.5的自动发现功能。安装后，会自动添加包提供者和外观。

如果您想显式声明提供者和/或别名，请首先将服务提供者添加到您的 config/app.php 文件中

'providers' => [
    //
    AustinHeap\Database\Encryption\EncryptionServiceProvider::class,
];

然后添加别名到您的 config/app.php 文件中

'aliases' => [
    //
    'DatabaseEncryption' => AustinHeap\Database\EncryptionFacade::class,
];

步骤 3: 配置包

发布包配置文件

$ php artisan vendor:publish --provider="AustinHeap\Database\Encryption\EncryptionServiceProvider"

现在，您可以通过编辑 config/database-encryption.php 文件来启用Eloquent模型的自动加密和解密。

return [
    'enabled' => env('DB_ENCRYPTION_ENABLED', true),
];

或者简单地将环境变量 DB_ENCRYPTION_ENABLED 设置为 true，通过 Laravel 的 .env 文件或托管环境实现。

DB_ENCRYPTION_ENABLED=true

使用方法

在希望应用加密的任何 Eloquent 模型中，使用 HasEncryptedAttributes 特性，并定义一个包含要加密的属性列表的 protected $encrypted 数组。

例如

    use AustinHeap\Database\Encryption\Traits\HasEncryptedAttributes;

    class User extends Eloquent {
        use HasEncryptedAttributes;
       
        /**
         * The attributes that should be encrypted on save.
         *
         * @var array
         */
        protected $encrypted = [
            'address_line_1', 'first_name', 'last_name', 'postcode'
        ];
    }

您可以将 $casts 和 $encrypted 结合起来存储加密数组。数组首先被转换为 JSON，然后加密。

例如

    use AustinHeap\Database\Encryption\Traits\HasEncryptedAttributes;

    class User extends Eloquent {
        use HasEncryptedAttributes;

        protected $casts     = ['extended_data' => 'array'];
        protected $encrypted = ['extended_data'];
    }

通过包含 HasEncryptedAttributes 特性，Eloquent 提供的 setAttribute() 和 getAttributeFromArray() 方法被重写，增加了一个额外的步骤。这个额外的步骤只是简单地检查通过设置器/获取器访问的属性是否包含在模型上的 $encrypted 数组中，然后相应地加密或解密它。

密钥和IV

使用的密钥和加密算法是默认的 Laravel Encrypter 服务，并在 config/app.php 中配置。

    'key' => env('APP_KEY', 'SomeRandomString'),
    'cipher' => 'AES-256-CBC',

如果您使用 AES-256-CBC 作为加密数据的密文，如果没有生成过应用密钥，可以使用内置命令通过 php artisan key:generate 生成。如果您加密较长的数据，可能需要考虑使用 AES-256-CBC-HMAC-SHA1 密文。

加密的 IV 是随机生成的，不能设置。

单元测试

此包具有使用出色的 orchestral/testbench 包构建的激进的单元测试，该包建立在 PHPUnit 之上。执行单元测试需要 MySQL 服务器。

您可以在网上找到 laravel-database-encryption 的代码覆盖率报告。

覆盖

以下 Laravel 5.5 的 Eloquent 方法会受到此特性的影响。

• constructor() -- 调用 fill()。
• fill() -- 调用 setAttribute()，它已扩展为加密数据。
• hydrate() -- 待定。
• create() -- 调用 constructor()，因此调用 fill()。
• firstOrCreate() -- 调用 constructor()。
• firstOrNew() -- 调用 constructor()。
• updateOrCreate() -- 调用 fill()。
• update() -- 调用 fill()。
• toArray() -- 调用 attributesToArray()。
• jsonSerialize() -- 调用 toArray()。
• toJson() -- 调用 toArray()。
• attributesToArray() -- 调用 getArrayableAttributes()。
• getAttribute() -- 调用 getAttributeValue()。
• getAttributeValue() -- 调用 getAttributeFromArray()。
• getAttributeFromArray() -- 调用 getArrayableAttributes()。
• getArrayableAttributes() -- 扩展以解密数据。
• setAttribute() -- 扩展以加密数据。
• getAttributes() -- 扩展以解密数据。
• castAttribute() -- 扩展以转换加密数据。
• isDirty() -- 扩展以识别加密数据。

常见问题解答

我可以手动加密或解密任意数据吗？

是的！您可以使用 encryptedAttribute() 和 decryptedAttribute() 函数手动加密或解密数据。例如

    $user = new User();
    $encryptedEmail = $user->encryptedAttribute(Input::get('email'));

我可以搜索加密数据吗？

不！您将无法搜索此包加密的属性，因为……它是加密的。比较加密值需要固定的 IV，这会引入安全问题。

如果您需要搜索数据，则

• 保持未加密，或
• 对数据进行哈希处理，然后使用如 SHA256 这样的知名哈希算法在哈希值上搜索，而不是加密值。

您可以同时存储哈希值和加密值，使用哈希值进行搜索，并在需要时检索加密值。

我可以加密所有 User 模型数据吗？

不！与搜索相同的问题也适用于身份验证，因为身份验证需要搜索。

此包是否与 elocryptfive 完全兼容？

不！虽然它是一个（更现代的）替代品，但它们不是直接兼容的。要从 elocryptfive 迁移到此包，您必须

1. 解密数据库中所有由elocryptfive加密的数据。
2. 从您的模型/代码中移除所有对elocryptfive的调用。
3. 从您的composer.json中移除elocryptfive，并运行composer update。
4. 此时，您的数据库中应没有加密数据，且所有调用/引用都已移除，但请确保elocryptfive已被彻底清除。
5. 按照上面的安装说明进行操作。
6. ???
7. 盈利！

欢迎提交用于自动迁移的pull request，但当前这超出了本项目目标范围。

实现

以下流量较大的网站在生产中使用此包

• securitytext.org - security.txt文档注册和whois服务器

致谢

这是delatbabel/elocryptfive的一个分支，它本身是dtisgodsson/elocrypt的一个分支，而后者基于早期工作。

• delatbabel/elocryptfive 贡献者
• dtisgodsson/elocrypt 贡献者

贡献

欢迎提交pull request！请参阅贡献指南以获取更多信息。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可文件。