README

Installation
Configure Provider
Updating your Eloquent Models
Creating tables to support encrypt columns
Set encryption key in .env and config file
Important Notes

Laravel MySql AES Encrypt/Decrypt

Laravel 7.x Database Encryption in mysql side, use native mysql function AES_DECRYPT and AES_ENCRYPT
Auto encrypt and decrypt signed fields/columns in your Model
Can use all functions of Eloquent/Model
You can perform the operations "=>, <',' between ',' LIKE ' in encrypted columns

1.Install the package via Composer:

$ composer require codiantnew/dbaesencrypt

2.Configure provider

If you're on Laravel 5.4 or earlier, you'll need to add and comment line on config/app.php:

'providers' => array(
    // Illuminate\Database\DatabaseServiceProvider::class,
    Codiant\\DBAESEncrypt\\Database\\DatabaseServiceProviderEncrypt::class
)

3.Updating Your Eloquent Models

Your models that have encrypted columns, should extend from ModelEncrypt:

namespace App\Models;

use Codiant\DBAESEncrypt\Database\Eloquent;

class Product extends ModelEncrypt
{    
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'tb_product';

    /**
     * The attributes that are encrypted.
     *
     * @var array
     */
    protected $fillableEncrypt = [
        'name'
    ];

     /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
                'name',
                'description',
                ];
}

4.Creating tables to support encrypt columns

It adds new features to Schema which you can use in your migrations:

    Schema::create('tb_persons', function (Blueprint $table) {
        // here you do all columns supported by the schema builder
        $table->increments('id')->unsigned;
        $table->string('description', 250);
        $table ->unsignedInteger('created_by')->nullable();
        $table ->unsignedInteger('updated_by')->nullable();
    });
    
    // once the table is created use a raw query to ALTER it and add the BLOB, MEDIUMBLOB or LONGBLOB
    DB::statement("ALTER TABLE tb_persons ADD name MEDIUMBLOB after id");

});

5.Set encryption key in .env and config file

Set in .env file
APP_AESENCRYPT_KEY=yourencryptedkey

Set in config/services.php
'aesEncrypt' => [
    'key' => env('APP_AESENCRYPT_KEY'),
]

6.Add BaseUser class for fixed problem of authenticable model problem

Create BaseUser class in app/BaseUser.php for fixed problem of authenticable model problem Extends BaseUser class in your Authenticatable model.

namespace App;

use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Codiant\DBAESEncrypt\Database\Eloquent;

class BaseUser extends Eloquent\ModelEncrypt implements
    AuthenticatableContract,
    AuthorizableContract,
    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;
}

Important Notes

1. DB query will not work with encrypted column.
2. Union will not work with paginate method. with union you can use simplePaginate method.
3. On encrypted column searching will work case sensitive. To resolve this problem use the MySQL lowercase method.
4. Don't use encrypted columns for making model relations.
5. Use all columns of the encrypted table in fillable array. You can select only columns that are available in fillable array in your select query.
6. Don't use asterisk in select method with encrypted table (ex. ->select('users.*')).
    Sometimes you want to use an asterisk with join and some other condition. For that condition, you have to overwrite encrypted columns.
    Example : I have encrypt name column in users table.
            ->select(DB::raw('users.*'),'name as name')

codiantnew / dbaesencrypt

Maintainers

Details