Repository files navigation

A Laravel 5 package that allows you to store Eloquent model properties encrypted in your database, and automatically decrypts them when you need to access them.

composer require sagalbot/encryptable

This package is really just a simple trait and property that you can add to your Eloquent models. Usage is simple:

1. Before using Laravel's encrypter, you must set a key option in your config/app.php configuration file.

   artisan key:generate

   note:If you already haveAPP_KEY set in your.env, you should skip this step.

2. Use theSagalbot\Encryptable\Encryptable trait:

   use \Sagalbot\Encryptable\Encryptable;

3. Set the$encryptable array on your Model.

   protected$encryptable = ['my_encrypted_property'];

4. That's it! Here's a complete example:

   <?phpnamespaceApp;useIlluminate\Database\Eloquent\Model;useSagalbot\Encryptable\Encryptable;class MyEncryptedModelextends Model{use Encryptable;/**     * The attributes that should be encrypted when stored.     *     * @var array     */protected$encryptable = ['my_encrypted_property','another_secret' ];}

By default, the package uses the globalencrypt() anddecrypt() Laravel functions, which are just aliases to resolve theIlluminate\Encryption\Encrypter::class out of the container. Laravel's encrypter uses OpenSSL to provide AES-256 and AES-128 encryption, which you can read more about at theLaravel Docs.

If you need to adjust how a specific model encrypts and decrypts its properties, you can override thedecryptAttribute andencryptAttribute methods on your model:

/** * @param $value */protectedfunctionencryptAttribute($value){//  encrypt the value}/** * @param $value */protectedfunctiondecryptAttribute($value){//  decrypt the value}

Don't lose your encryption key - you can't decrypt your stored data without it.