xandanet/laravel-mysql-encrypt

Laravel 5.x | 6.x | 7.x | 8.x Database encryption mysql side

2.0.0 2021-02-19 08:08 UTC

Requires

• php: ^7.2.5
• illuminate/database: ^5.0|^6.0|^7.0|^8.0
• illuminate/support: ^5.0|^6.0|^7.0|^8.0

MIT

• Christopher Keller

• php
• mysql
• encryption
• laravel
• pii
• xandanet

README

Laravel/Lumen database encryption at database side using native AES_DECRYPT and AES_ENCRYPT functions. Automatically encrypt and decrypt fields in your Models.

Install

1. Composer

composer require xandanet/laravel-mysql-encrypt

2. Publish config (optional)

Laravel

php artisan vendor:publish --provider="XandaNet\MysqlEncrypt\Providers\LaravelServiceProvider"

Lumen

mkdir -p config
cp vendor/xandanet/laravel-mysql-encrypt/config/config.php config/mysql-encrypt.php

3. Configure Provider

Laravel

• For Laravel 5.5 or later, the service provider is automatically loaded, skip this step.

• For Laravel 5.4 or earlier, add the following to config/app.php:

'providers' => array(
    XandaNet\\MysqlEncrypt\\Providers\\LaravelServiceProvider::class
);

Lumen

• For Lumen, add the following to bootstrap/app.php:

$app->register(XandaNet\MysqlEncrypt\Providers\LumenServiceProvider::class);

4. Set encryption key in .env file

APP_AESENCRYPT_KEY=yourencryptionkey

Update Models

<?php

namespace App;

use XandaNet\MysqlEncrypt\Traits\Encryptable;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use Encryptable; // <-- 1. Include trait

    protected $encryptable = [ // <-- 2. Include columns to be encrypted
        'email',
        'first_name',
        'last_name',
        'telephone',
    ];
}

Validators

unique_encrypted

unique_encrypted:<table>,<field(optional)>

exists_encrypted

exists_encrypted:<table>,<field(optional)>

Scopes

Custom Local scopes available:

whereEncrypted whereNotEncrypted orWhereEncrypted orWhereNotEncrypted orderByEncrypted

Global scope DecryptSelectScope automatically booted in models using Encryptable trait.

Schema columns to support encrypted data

Schema::create('users', function (Blueprint $table) {
    $table->bigIncrements('id');
    $table->string('password');
    $table->rememberToken();
    $table->timestamps();
});

// Once the table has been created, use ALTER TABLE to create VARBINARY
// or BLOB types to store encrypted data.
DB::statement('ALTER TABLE `users` ADD `first_name` VARBINARY(300)');
DB::statement('ALTER TABLE `users` ADD `last_name` VARBINARY(300)');
DB::statement('ALTER TABLE `users` ADD `email` VARBINARY(300)');
DB::statement('ALTER TABLE `users` ADD `telephone` VARBINARY(50)');

License

The MIT License (MIT). Please see License File for more information.