README

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

本项目的目的是创建一个即装即用的包，可以轻松安装，无需额外努力即可加密和解密存储在数据库表中的Eloquent模型属性，透明地进行。因此，它具有高度的意见性，但专为配置构建。

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

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

这支持存储加密或非加密数据的列，以便简化迁移。无论数据是否加密，都可以正确地从列中读取数据，但将其保存回列时将自动加密。即使数据库中存储的底层值由该包加密，标准的Laravel Eloquent功能（如属性铸造）也将继续按正常方式工作。

有关laravel-database-encryption的在线文档可在此处找到，其源代码位于docs/目录中。最合理的开始之处是HasEncryptedAttributes特质的文档。

目录

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

要求

• Laravel：5.5，5.6，5.7或5.8
• PHP：7.1，7.2或7.3
• 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.2"
    }
}

步骤2：启用包（可选）

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

如果您想显式声明提供者和/或别名，请首先将服务提供者添加到您的 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),
];

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

DB_ENCRYPTION_ENABLED=true

用法

使用 HasEncryptedAttributes 特性在您希望应用加密的任何Eloquent模型中，并定义一个包含要加密的属性列表的 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() 方法被重写以包含一个额外的步骤。这个额外的步骤只是检查通过setter/getter访问的属性是否包含在模型的 $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. 赚钱吧！

欢迎自动迁移的拉取请求，但目前它超出了此项目目标范围。

此包是否与insert-random-Eloquent-package-here兼容？

可能不是！保证随机包之间的互操作性是不可行的，尤其是那些也大量修改Eloquent默认行为的包。

关于互操作性的问题和拉取请求将不会被接受。

实现

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

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

致谢

这是delatbabel/elocryptfive的分支，它是dtisgodsson/elocrypt的分支，该分支基于早期的工作。

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

贡献

欢迎拉取请求！有关更多信息，请参阅贡献指南。

许可

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