betterapp / laravel-db-encrypter by betterapp

Provides database model attribute encryption/decryption
378,783
362
11
Package Data
Maintainer Username: betterapp
Maintainer Contact: biuro@betterapp.net (Daniel Czestki)
Package Create Date: 2020-01-12
Package Last Update: 2023-03-02
Language: PHP
License: MIT
Last Refreshed: 2024-03-27 03:00:47
Package Statistics
Total Downloads: 378,783
Monthly Downloads: 11,030
Daily Downloads: 688
Total Stars: 362
Total Watchers: 11
Total Forks: 44
Total Open Issues: 11

Laravel Db Encrypter Package

This package was created to encrypt and decrypt values of Eloquent model attributes.

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

  1. Use the betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute trait in any Eloquent model that you wish to use encryption
  2. 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',
        ];
    }

License

The MIT License (MIT). Please see License File for more information.