Encrypted

A custom cast class for Laravel Eloquent that encrypts or hashes your values. Package is small and provides just a few, simple, well tested features.

protected $casts = [
    // hashes the value when assigning to $model->password
    'password' => Password::class,

    // encrypts on write, decrypts on read
    'classified' => Encrypted::class,

    // encrypts on write, decrypts & typecasts on read
    'secret' => Encrypted::class.':integer',
];

Installation

Use composer.

$ composer require crudly/encrypted

Usage

Mark any column in your model as encrypted.

<?php

namespace App;

use Crudly\Encrypted\Encrypted;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
	protected $casts = [
		'something_secret' => Encrypted::class,
	];
}

You can work with the attribute as you normally would, but it will be encrypted on the database.

$mm = new MyModel;

$mm->someting_secret = 'classified_info';
$mm->save();

Type casting

Encryption serializes the variable and decryption unserializes it, so you get out exactly what you put in. This usually means that no type casting is needed.

But sometimes you want everything casted to some type even if you put something else in. In those cases you can specify types (all of Eloquent's default casts are supported):

<?php

namespace App;

use Crudly\Encrypted\Encrypted;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
	protected $casts = [
		'encrypted_column' => Encrypted::class,
		'an_integer' => Encrypted::class.':integer',
		'a_string' => Encrypted::class.':string',
		'decimal_with_two_places' => Encrypted::class.':decimal:2',
	];
}

Password hashing

This can also be used to hash a password upon write.

<?php

namespace App;

use Crudly\Encrypted\Password;
use Illuminate\Database\Eloquent\Model;

class MyUser extends Model
{
	protected $casts = [
		'password' => Password::class,
	];
}

This hashes the password using bcrypt. You can check a string against the hashed password using Hash facade.

$mu = new MyUser;
$mu->password = 'secret';

$mu->password; // returns a hash

Hash::check('secret', $mu->password); //returns true
Hash::check('hunter2', $mu->password); //returns false

TODO

Maybe add key and cipher customization via options, i.e. Encrypted::class.':string,AckfSECXIvnK5r28GVIWUAxmbBSjTsmF' and Encrypted::class.':string,AckfSECXIvnK5r28GVIWUAxmbBSjTsmF,AES-128-CBC'. And password hashing options.

You might also like...

Laravel Ban simplify blocking and banning Eloquent models.

Laravel Ban Introduction Laravel Ban simplify management of Eloquent model's ban. Make any model bannable in a minutes! Use case is not limited to Use

879 Dec 30, 2022

Add Social Reactions to Laravel Eloquent Models. It lets people express how they feel about the content. Fully customizable Weighted Reaction System & Reaction Type System with Like, Dislike and any other custom emotion types. Do you react?

Laravel Love Introduction Laravel Love is emotional part of the application. It let people express how they feel about the content. Make any model rea

996 Dec 28, 2022

Comments

Using datetime cast on Encrypted fails
I'm using Laravel 7.9, and using the Encrypted cast using a datetime cast, it fails:

class Student extends Model { protected $casts = [ 'birth_date' => Encrypted::class . ':datetime', ]; } $student->birth_date; // fails

Call to undefined method "getConnection".

It looks like HasAttributes is calling the getConnection() method, which is in Model to get the date format if a date format is not set.

I think the simplest solution would be setting the $dateFormat field in Caster, although it's really only needed for date fields.
opened by rawilk 1

Releases(1.4.0)

1.4.0(Feb 22, 2022)

Source code(tar.gz)
Source code(zip)
1.3.0(Oct 9, 2020)

Source code(tar.gz)
Source code(zip)
1.2.1(May 4, 2020)

Fixes casting to datetime.
Source code(tar.gz)
Source code(zip)
1.2.0(May 2, 2020)

Now respecting hashing config (by using Hash::make instead of bcrypt) and correctly decrypts null to null.
Source code(tar.gz)
Source code(zip)
1.1.0(Apr 26, 2020)

This adds a password hashing feature.
Source code(tar.gz)
Source code(zip)
1.0.0(Apr 26, 2020)

Initial release
Source code(tar.gz)
Source code(zip)