README

使用 openssl 加密和解密 Laravel 模型属性的包

主要功能

• 轻松加密和解密数据库字段
• 最小化配置
• 使用以下方式包含搜索加密数据：whereEncrypted 和 orWhereEncrypted
• 使用 openssl 加密和解密字段

需求

• Laravel: >= 5
• PHP: >= 7.3

Schema 需求

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

我们强烈建议将列类型更改为 TEXT 或 LONGTEXT

安装

步骤 1：Composer

通过 Composer 命令行

$ composer require elgibor-solution/laravel-database-encryption

步骤 2：将 ServiceProvider 添加到您的 app/config.php 文件（Laravel 5.4 或以下）

将服务提供程序添加到 config/app.php 配置文件中的 providers 数组中，如下所示

    'providers' => [
        ...
        \ESolution\DBEncryption\Providers\DBEncryptionServiceProvider::class,
    ],

用法

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

例如

    
    use ESolution\DBEncryption\Traits\EncryptedAttribute;

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

通过包含 EncryptedAttribute 特性，Eloquent 提供的 setAttribute()、getAttribute() 和 getAttributeFromArray() 方法被覆盖以包括额外的步骤。

搜索加密字段示例

可以通过调用与 Laravel Eloquent 中的 where 和 orWhere 类似的 whereEncrypted 和 orWhereEncrypted 函数来搜索加密字段。

    namespace App\Http\Controllers;

    use App\User;
    class UsersController extends Controller {
        public function index(Request $request)
        {
            $user = User::whereEncrypted('first_name','john')
                        ->orWhereEncrypted('last_name','!=','Doe')->firstOrFail();
            
            return $user;
        }
    }

加密当前数据

如果您数据库中有当前数据，可以使用以下命令进行加密。

php artisan encryptable:encryptModel 'App\User'

另外，您还可以使用以下命令进行解密。

php artisan encryptable:decryptModel 'App\User'

注意：您必须首先实现 Encryptable 特性并设置 $encryptable 属性

存在和唯一验证规则

如果您使用存在和唯一规则与加密值，请将其替换为 exists_encrypted 和 unique_encrypted

常见问题解答

我能否搜索加密数据？

YES！您将能够搜索由此包加密的属性，因为如果您需要搜索数据，请使用 whereEncrypted 和 orWhereEncrypted 函数

    User::whereEncrypted('email','test@gmail.com')->orWhereEncrypted('email','test2@gmail.com')->firstOrFail();

一旦模型使用 EncryptedAttribute，它将自动添加到 Eloquent 中

我能否加密我的所有 User 模型数据？

除了 ID 之外，您可以加密您想要的任何内容

例如：加密登录电子邮件

$user = User::whereEncrypted('email','test@gmail.com')->filter(function ($item) use ($request) {
        return Hash::check($password, $item->password);
    })->where('active',1)->first();

鸣谢

此包受到了以下项目的启发：austinheap/laravel-database-encryption magros/laravel-model-encryption DustApplication/laravel-database-model-encryption

许可证

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