betterapp / laravel-db-encrypter
Provides database model attribute encryption/decryption
Installs: 454 077
Dependents: 8
Suggesters: 0
Security: 0
Stars: 362
Watchers: 10
Forks: 46
Open Issues: 11
Requires
- php: >=8.0
- laravel/framework: ^9.0
This package is auto-updated.
Last update: 2024-10-28 18:27:07 UTC
README
This package was created to encrypt and decrypt values of Eloquent model attributes.
Donnations
If You think this package helped You, please donate. Thank You.
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SPYLWZ8Y5E4JE&source=url
Key features
- Encrypt, decrypt values stored in database fields
- Using standard Laravel's Crypt service
- Easy configuration
Requirements
- Laravel: 6.0 and up
- PHP: 7.1 and newer
Database schema
Encrypted values are stored as plain text so in most cases takes up more spaces then unencrypted one.
Recommendation is to alter table column to TEXT
type.
If you want use VARCHAR
or CHAR
column type still you need to check if encrypted value fit.
Note:
Do not worry if you have current data in your database not encrypted and added column to $encryptable
- they will return as is.
On save values will be encrypted and everything will work fine.
Installation
Via Composer command line:
$ composer require betterapp/laravel-db-encrypter
Usage
- Use the
betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute
trait in any Eloquent model that you wish to use encryption - Define a
protected $encryptable
array containing a list of the encrypted attributes.
For example:
use betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute; class Client extends Eloquent { use EncryptableDbAttribute; /** @var array The attributes that should be encrypted/decrypted */ protected $encryptable = [ 'id_number', 'email', ]; }
- You can use Laravel's original $casts to cast decrypted values
License
The MIT License (MIT). Please see License File for more information.