magros/laravel-model-encryption

This enable store encrypted models in Laravel

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 require 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'=>'[email protected]'], ['email'=>'exists_encrypted:users,email']);

7. You can still use where functions

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

   Automatically [email protected] will be encrypted and pass it to the query builder.

laravel-model-encryption's Issues

Illuminate\Database\Eloquent\Model and Magros\Encryptable\Encryptable define the same property ($encrypter) in the composition of

Hello,

i think the package is conflict with the current laravel. i got this error when executing:

php artisan encryptable:encryptModel 'App\Models\MyModel'

Illuminate\Database\Eloquent\Model and Magros\Encryptable\Encryptable define the same property ($encrypter) in the composition of App\Models\MyModel. However, the definition differs and is considered incompatible. Class was composed

Error command encryptModel on PHP 7.3.11

When running php artisan encryptable:encryptModel 'App\User' it was raised the error: Call to undefined function Magros\Encryptable\str_contains()

Environment:

• Ubuntu 19.09
• PHP 7.3.11
• Laravel 7

Regards

Where conditions passed as an array are not decrypted

https://laravel.com/docs/5.2/queries#where-clauses

Laravel allows for the where clause in the query builder to be passed an array of conditions, e.g.

$users = DB::table('users')->where([
    ['status', '=', '1'],
    ['subscribed', '<>', '1'],
])->get();

or

$users = DB::table('users')->where([
    'status' => '1',
    'name' => 'John Doe',
]])->get();

The extended query builder works well to handle queries on encrypted fields when passed via a simple where clause, but when this more complex structure is passed, the column field never gets recognised, and the value isn't decrypted.

unique_encrypted doesn't support "except" or "idColumn" constraints

https://laravel.com/docs/5.8/validation#rule-unique

Laravel's validation rules allow for except conditions to be passed to a rule. This allows for validation rules on an update of a user account to ensure that the user's email address is unique, excluding their own user record. This can be done via Rule objects, or by adding the exceptional values to the piped-format validation rule string.

The syntax would look something like:

'email' => 'required|email|unique:users,email,'.$user_id,

When using the unique_encrypted validation rule, only the first two parameters get handled. This means that an attempt to update a user record by posting a full user object will throw a validation error due to the email address already existing in the database.

Call to undefined function Magros\Encryptable\config_path()

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

In EncryptServiceProvider.php line 29:

Call to undefined function Magros\Encryptable\config_path()

Encrypted values are store in lowercase instead of their true value

As the title says, encrypted values are stored as lowercase. For instance:

username = ABCdefg

when encrypted it shows as abcdefg , which is a problem with case sensitive fields like usernames and passwords.

ENCRYPT_PREFIX ISSUE need to fix - URGENT

I am facing encryption issue when i use prefix word in encryptable values then value not encrypting.

Value should encrypt even value contain prefix.

Thanks