mintopia/laravel-encryptable

An encryptable trait that can be used in models

v2.0.0 2021-05-16 19:31 UTC

Requires

• php: >=8.0
• illuminate/support: ^8.0

Requires (Dev)

• illuminate/database: ^8.0
• mockery/mockery: ^1.1
• phpunit/phpunit: ^9.0

MIT

• Chris Stretton
• Jessica Smith

README

Provides a trait to decrypt or encrypt values in a Laravel model.

Usage

Add the trait to your model, define the $encrypted array and fields in it will be encrypted and decrypted on the fly by default.

namespace App;

use Cheezykins\LaravelEncryptable\Traits\Encryptable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model {
    use Encryptable;

    protected $encrypted = [
        'email'
    ];
}

Then in usage:

$model = new MyModel();
$model->name = 'Chris';
$model->email = '[e-mail]';
$model->save();

The email field in the database will now be the encrypted value.

eyJpdiI6IkRZS0lOUlwvR29MbU4zN1diYzl2ZCtnPT0iLCJ2YWx1ZSI6IldEYzVUajlUcDdvVHE0M0kxdForNlE9PSIsIm1hYyI6ImY1MzQ2ZWYwNTNkZDI2YTY2MDgyMmVjZmU3MmI0MGU0NTNmMmU4NWE4OGFmYzZhYTJlYzczMWU1YTdmNzNjYjQifQ==

When retrieved, the data will be automatically decrypted for you.

$model = MyModel::find(1);
echo $model->email;

> "[e-mail]"

Same for other ways of accessing model data.

$model = MyModel::find(1);
return response()->json($model->toArray());

{
  "id": 1,
  "name": "Chris",
  "email": "[e-mail]"
}

WARNING

The encrypted value is stored based on your Laravel APP_KEY using the algorithm defined in your config/app.php cipher setting. If your application key is changed or lost there is no way to retrieve the data.

Installation

require the project and use it. There is no service provider as it is not needed.

composer require cheezykins/laravel-encryptable