rpsimao/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.

0.3 2023-04-05 11:04 UTC

Requires

• php: >=7.1
• ext-openssl: *
• illuminate/database: ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0

Requires (Dev)

• mockery/mockery: dev-master@dev
• orchestra/testbench: ~3.7

MIT

• Marco Antonio Godinez

• model
• laravel
• encrypt
• eloquent
• laravel 5

README

laravel-model-encryption

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

Run composer installation

    composer install magros/laravel-model-encryption

Add ServiceProvider to your app/config.php file

    'providers' => [
        ...
        \Magros\Encryptable\EncryptServiceProvider::class,
    ],

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

     php artisan vendor:publish --provider=Magros\Encryptable\EncryptServiceProvider

How to use

1. You must add ENCRYPT_KEY and ENCRYPT_PREFIX in your .env file or set it in your config/encrypt.php file

2. Use the Magros\Encryptable\Encryptable trait:

   use Magros\Encryptable\Encryptable;

3. Set the $encryptable array on your Model.

   protected $encryptable = ['encrypted_property'];

4. Here's a complete example:

   <?php
   
   namespace App;
   
   use Illuminate\Database\Eloquent\Model;
   use Magros\Encryptable\Encryptable;
   
   class User extends Model
   {
   
       use Encryptable;
   
       /**
        * The attributes that should be encrypted when stored.
        *
        * @var array
        */
       protected $encryptable = [ 'email', 'address' , 'name'];
    
       /**
       * Optionally you can define the attributes that should be converted to camelcase when retrieve.
       *
       * @var array
       */
        protected $camelcase = ['name'];
   }

5. Optional. Encrypt your current data

   If you have current data in your database you can encrypt it with the: php artisan encryptable:encryptModel 'App\User' command.

   Additionally you can decrypt it using the:php artisan encryptable:decryptModel 'App\User' command.

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

6. 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']);

7. 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.