silverd/laravel-model-encryption

A trait to encrypt data models in Laravel, automatically encrypt and decrypt model data overriding getAttribute an setAttribute methods of Eloquent Model.

dev-master 2024-12-13 16:08 UTC

Requires

• php: >=8.0
• ext-openssl: *
• illuminate/database: *

MIT

• model
• laravel
• encrypt
• eloquent

README

A trait to encrypt data models in Laravel, this automatically encrypt and decrypt model data overriding getAttribute an setAttribute methods of Eloquent Model.

How to install

composer require silverd/laravel-model-encryption:dev-master

Publish configuration file, this will create config/encrypt.php

php artisan vendor:publish --provider="Silverd\Encryptable\ServiceProvider"

How to use

1. You must add XES_ENCRYPT_CIPHER / XES_ENCRYPT_KEY / XES_ENCRYPT_IV in your .env file or set it in your config/encrypt.php file

2. Use the Silverd\Encryptable\Encryptable trait:

use Silverd\Encryptable\Encryptable;

1. Set the $encryptable array on your Model.

protected $encryptable = ['encrypted_property'];

1. Here's a complete example:

namespace App;

use Illuminate\Database\Eloquent\Model;
use Silverd\Encryptable\Encryptable;

class User extends Model
{
    use Encryptable;

    protected $encryptable = [
        'email',
        'address' ,
        'name',
    ];
}

1. Optional. Encrypt your current data

If you have current data in your database you can encrypt it with the: php artisan encryptable:encryptModel --model="App\\Models\\RxHolder" command.

Additionally you can decrypt it using the:php artisan encryptable:decryptModel --model="App\\Models\\RxHolder" command.

Note: You must implement first the Encryptable trait and set $encryptable attributes

1. If you are using exists and unique rules with encrypted values replace it with exists_encrypted and unique_encrypted

$validator = validator(['email'=>'[e-mail]'], ['email'=>'exists_encrypted:users,email']);

1. You can still use where functions

$validator = User::where('email','[e-mail]')->first();

Automatically [e-mail] will be encrypted and pass it to the query builder.