Giter Site home page Giter Site logo

laravel-model-encryption's Introduction

Scrutinizer Code Quality Downloads License Codeship Build Status Code Intelligence Status

laravel-model-encryption

A trait to encrypt data models in Laravel, this automatically encrypt and decrypt model data overriding getAttribute an setAttribute methods of Eloquent Model.

How to install

Run composer installation

    composer install magros/laravel-model-encryption

Add ServiceProvider to your app/config.php file

    'providers' => [
        ...
        \Magros\Encryptable\EncryptServiceProvider::class,
    ],

Publish configuration file, this will create config/encrypt.php

     php artisan vendor:publish --provider=Magros\Encryptable\EncryptServiceProvider

How to use

  1. You must add ENCRYPT_KEY and ENCRYPT_PREFIX in your .env file or set it in your config/encrypt.php file

  2. Use the Magros\Encryptable\Encryptable trait:

    use Magros\Encryptable\Encryptable;
  3. Set the $encryptable array on your Model.

    protected $encryptable = ['encrypted_property'];
  4. Here's a complete example:

    <?php
    
    namespace App;
    
    use Illuminate\Database\Eloquent\Model;
    use Magros\Encryptable\Encryptable;
    
    class User extends Model
    {
    
        use Encryptable;
    
        /**
         * The attributes that should be encrypted when stored.
         *
         * @var array
         */
        protected $encryptable = [ 'email', 'address' , 'name'];
     
        /**
        * Optionally you can define the attributes that should be converted to camelcase when retrieve.
        *
        * @var array
        */
         protected $camelcase = ['name'];
    }
  5. Optional. Encrypt your current data

    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

  6. If you are using exists and unique rules with encrypted values replace it with exists_encrypted and unique_encrypted

    $validator = validator(['email'=>'[email protected]'], ['email'=>'exists_encrypted:users,email']);
  7. You can still use where functions

    $validator = User::where('email','[email protected]')->first();

    Automatically [email protected] will be encrypted and pass it to the query builder.

laravel-model-encryption's People

Contributors

magros avatar mgodinez98 avatar rpsimao avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.