This package was cloned from here due to the original owner's inactivity.
- Encrypt, Decrypt database fields easily
- Minimal configuration
- Include searching encrypted data using the following:
whereEncrypted
,orWhereEncrypted
,orderByEncrypted
,selectEncrypted
,concatEncrypted
- uses openssl for encrypting and decrypting fields
whereEncrypted
, orWhereEncrypted
, orderByEncrypted
, selectEncrypted
, concatEncrypted
whereEncrypted('first_name','john')
orWhereEncrypted('last_name','!=','Doe')
orderByEncrypted('last_name','asc')
orderByEncrypted('last_name','desc')
selectEncrypted([
"first_name as userFirstName",
"last_name",
]) // array only
concatEncrypted('first_name , " " ,last_name AS fullUserName')
- Laravel: >= 5
- PHP: >= 7.3
Encrypted values are usually longer than plain text values, sometimes much longer. You may find that the column widths in your database tables need to be altered to store the encrypted values generated by this package.
We highly recommend to alter your column types to TEXT
or LONGTEXT
Via Composer command line:
composer require phpcodersnp/laravel-database-encryption
Add the service provider to the providers array in the config/app.php config file as follows:
'providers' => [
...
\PHPCodersNp\DBEncryption\Providers\DBEncryptionServiceProvider::class,
],
php artisan vendor:publish --provider="PHPCodersNp\DBEncryption\Providers\DBEncryptionServiceProvider"
cp vendor/phpcodersnp/laravel-database-encryption/src/Config/config.php config/laravelDatabaseEncryption.php
Copy below code and paste it in bootstrap/app.php
$app->configure('laravelDatabaseEncryption');
$app->register(PHPCodersNp\DBEncryption\Providers\DBEncryptionServiceProvider::class);
Use the EncryptedAttribute
trait in any Eloquent model that you wish to apply encryption
to and define a protected $encrypted
array containing a list of the attributes to encrypt.
For example:
use PHPCodersNp\DBEncryption\Traits\EncryptedAttribute;
class User extends Eloquent {
use EncryptedAttribute;
/**
* The attributes that should be encrypted on save.
*
* @var array
*/
protected $encryptable = [
'first_name', 'last_name', 'email'
];
}
By including the EncryptedAttribute
trait, the setAttribute()
, getAttribute()
and getAttributeFromArray()
methods provided by Eloquent are overridden to include an additional step.
If you have current data in your database you can encrypt it with this command:
php artisan encryptable:encryptModel 'App\Models\User'
Additionally you can decrypt it using this command:
php artisan encryptable:decryptModel 'App\Models\User'
Note: You must implement first the Encryptable
trait and set $encryptable
attributes
If you are using exists and unique rules with encrypted values replace it with exists_encrypted and unique_encrypted
$validator = validator(['email'=>'foo@bar.com'], ['email'=>'exists_encrypted:users,email']);
$validator = validator(['email'=>'foo@bar.com'], ['email'=>'unique_encrypted:users,email']);
YES! You will able to search on attributes which are encrypted by this package because.
If you need to search on data then use the whereEncrypted
and orWhereEncrypted
function:
User::whereEncrypted('email','test@gmail.com')
->orWhereEncrypted('email','test2@gmail.com')
->first();
It will automatically added on the eloquent once the model uses EncryptedAttribute
This package was inspired from the following: austinheap/laravel-database-encryption magros/laravel-model-encryption DustApplication/laravel-database-model-encryption elgiborsolution/laravel-database-encryption
The MIT License (MIT). Please see License File for more information.