maize-tech / laravel-encryptable
Laravel Encryptable
Fund package maintenance!
maize-tech
Installs: 15 285
Dependents: 0
Suggesters: 0
Security: 0
Stars: 106
Watchers: 7
Forks: 10
Open Issues: 1
Requires
- php: ^8.0
- ext-openssl: *
- illuminate/contracts: ^9.0|^10.0|^11.0
- illuminate/database: ^9.0|^10.0|^11.0
- illuminate/support: ^9.0|^10.0|^11.0
- illuminate/validation: ^9.0|^10.0|^11.0
- spatie/laravel-package-tools: ^1.14.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.4
- orchestra/testbench: ^7.0|^8.0|^9.0
- phpunit/phpunit: ^9.5|^10.5
- vimeo/psalm: ^4.20|^5.22
README
Laravel Encryptable
This package allows you to anonymize sensitive data (like the name, surname and email address of a user) similarly to Laravel's Encryption feature, but still have the ability to make direct queries to the database. An example use case could be the need to make search queries through anonymized attributes.
This package currently supports MySQL
and PostgreSQL
databases.
Installation
You can install the package via composer:
composer require maize-tech/laravel-encryptable
You can publish the config file with:
php artisan vendor:publish --provider="Maize\Encryptable\EncryptableServiceProvider" --tag="encryptable-config"
This is the content of the published config file:
return [ /* |-------------------------------------------------------------------------- | Encryption key |-------------------------------------------------------------------------- | | The key used to encrypt data. | Once defined, never change it or encrypted data cannot be correctly decrypted. | */ 'key' => env('ENCRYPTION_KEY'), /* |-------------------------------------------------------------------------- | Encryption cipher |-------------------------------------------------------------------------- | | The cipher used to encrypt data. | Once defined, never change it or encrypted data cannot be correctly decrypted. | Default value is the cipher algorithm used by default in MySQL. | */ 'cipher' => env('ENCRYPTION_CIPHER', 'aes-128-ecb'), ];
Usage
Basic
To use the package, just add the Encryptable
cast to all model attributes you want to anonymize.
<?php namespace App\Models; use Maize\Encryptable\Encryptable; use Illuminate\Database\Eloquent\Model; class User extends Model { protected $fillable = [ 'name', 'email', ]; protected $casts = [ 'name' => Encryptable::class, 'email' => Encryptable::class, ]; }
Once done, all values will be encrypted before being stored in the database, and decrypted when querying them via Eloquent.
Manually encrypt via PHP
use Maize\Encryptable\Encryption; $value = "your-decrypted-value"; $encrypted = Encryption::php()->encrypt($value); // returns the encrypted value
Manually decrypt via PHP
use Maize\Encryptable\Encryption; $encrypted = "your-encrypted-value"; $value = Encryption::php()->decrypt($value); // returns the decrypted value
Manually decrypt via DB
use Maize\Encryptable\Encryption; $encrypted = "your-encrypted-value"; $encryptedQuery = Encryption::db()->encrypt($value); // returns the query used to find the decrypted value
Custom validation rules
You can use one of the two custom rules to check the uniqueness or existence of a given encryptable value.
ExistsEncrypted
is an extension of Laravel's Exists
rule, whereas UniqueEncrypted
is an extension of Laravel's Unique
rule.
You can use them in the same way as Laravel's base rules:
use Maize\Encryptable\Rules\ExistsEncrypted; use Illuminate\Support\Facades\Validator; use Illuminate\Validation\Rule; $data = [ 'email' => 'email@example.com', ]; Validator::make($data, [ 'email' => [ 'required', 'string', 'email', new ExistsEncrypted('users'), // checks whether the given email exists in the database Rule::existsEncrypted('users') // alternative way to invoke the rule ], ]);
use Maize\Encryptable\Rules\UniqueEncrypted; use Illuminate\Support\Facades\Validator; $data = [ 'email' => 'email@example.com', ]; Validator::make($data, [ 'email' => [ 'required', 'string', 'email', new UniqueEncrypted('users'), // checks whether the given email does not already exist in the database Rule::uniqueEncrypted('users') // alternative way to invoke the rule ], ]);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.