hihaho/laravel-encryptable-trait

Laravel encryptable trait, easily make certain fields for eloquent models encryptable

Laravel Encryptable Trait

, _(*1)

[!WARNING], _(*2)

No longer maintained

We no longer use this package and will not maintain it. Please feel free to fork it and maintain it yourself., _(*3)

Consider migrating to Laravel encryption features which we added since this package was created., _(*4)

This package uses serialized encryption, while the Laravel encryption casts unserialized encryption. You can upgrade uses of this package to custom casts, e.g. by implementing Illuminate\Contracts\Database\Eloquent\Castable on a data object used as cast., _(*5)

Introduction

This trait encrypts all your fields (defined in $this->encryptable) before saving it to the database. It makes it extremely easy to treat certain fields as encryptable by automatically encrypting and decrypting the values., _(*6)

Install

Simply add the following line to your composer.json and run composer update, _(*7)

"hihaho/laravel-encryptable-trait": "^v4.0"

Or use composer to add it with the following command, _(*8)

composer require hihaho/laravel-encryptable-trait

Requirements

• illuminate/encryption ^10.0 or ^11.0
• PHP 8.1, 8.2 or 8.3

Usage

Simply add the trait to your models and set the $encryptable to an array of values that need to be encrypted., _(*9)

<?php

namespace app\Models;

use Illuminate\Database\Eloquent\Model as Eloquent;
use HiHaHo\EncryptableTrait\Encryptable;

class Phone extends Eloquent
{
    use Encryptable;

    protected $encryptable = [
        'imei',
    ];
}

DecryptException

This package will throw a DecryptException (the default Laravel one: Illuminate\Contracts\Encryption\DecryptException). You can however set $dontThrowDecryptException to true to ignore the exception. If the value can't be decrypted it will just return null., _(*10)

<?php

namespace app\Models;

use Illuminate\Database\Eloquent\Model as Eloquent;
use HiHaHo\EncryptableTrait\Encryptable;

class Phone extends Eloquent
{
    use Encryptable;

    protected $encryptable = [
        'imei',
    ];

    protected $dontThrowDecryptException = true;
}

If the database contains an invalid value, this will return null., _(*11)

$phone = Phone::find(1);
$phone->imei; //Will return null

Contributors

• Robert Boes
• Mart de Graaf
• Sander Muller
• ivinteractive / iv-craig