Most of client wanted to encrypt their database. So encase a person got access to database, they won't see the actual data of it. BUT the problem is, developers will have difficulty searching encrypted data when they need it.
The purpose of this project is to create a set-it-and-forget-it package that can be
installed without much effort to encrypt and decrypt Eloquent model attributes stored
in your database tables, and most of all able to search encrypted database fields
using whereEncrypted and orWhereEncrypted functions similar to laravel eloquent's where and orWhere.
- Encrypt, Decrypt database fields easily
- Minimal configuration
- Include searching encrypted data using the following:
whereEncryptedandorWhereEncrypted - uses Laravel's Facades
Cryptfor encrypting and decrypting fields
- Laravel: 5.5, 5.6, 5.7, or 5.8
- PHP: 5.6 Above
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 dustapplication/laravel-database-model-encryptionAdd the service provider to the providers array in the config/app.php config file as follows:
'providers' => [
...
\DustApplication\Encryption\Providers\EncryptServiceProvider::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 DustApplication\Encryption\Traits\EncryptedAttribute;
class User extends Eloquent {
use EncryptedAttribute;
/**
* The attributes that should be encrypted on save.
*
* @var array
*/
protected $encryptable = [
'first_name', 'last_name'
];
}By including the EncryptedAttribute trait, the setAttribute(), getAttribute() and getAttributeFromArray()
methods provided by Eloquent are overridden to include an additional step.
Searching encrypted field can be done by calling the whereEncrypted and orWhereEncrypted functions
similar to laravel eloquent where and orWhere.
namespace App\Http\Controllers;
use App\User;
class UsersController extends Controller {
public function index(Request $request)
{
$user = User::whereEncrypted('first_name','john')
->orWhereEncrypted('last_name','!=','Doe')->firstOrFail();
return $user;
}
}The use of encryption searching is recommended for small group of data. Using it on large amount of data rows will affects the performance.
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
If you are using exists and unique rules with encrypted values replace it with exists_encrypted and unique_encrypted
php $validator = validator(['email'=>'foo@bar.com'], ['email'=>'exists_encrypted:users,email']); $validator = validator(['email'=>'foo@bar.com'], ['email'=>'unique_encrypted:users,email']);
No for now, but we may include it on next update
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')->firstOrFail();
It will automatically added on the eloquent once the model uses EncryptedAttribute
Aside from IDs you can encrypt everything you wan't
For example: Logging-in on encrypted email
$user = User::whereEncrypted('email','test@gmail.com')->filter(function ($item) use ($request) {
return Hash::check($password, $item->password);
})->where('active',1)->first();
This package was inspired from the following: austinheap/laravel-database-encryption magros/laravel-model-encryption
The MIT License (MIT). Please see License File for more information.