kunalkanani/maskable

A package for concealing sensitive data in Laravel models and API responses with customizable masking rules. Mask specific fields, like emails and phone numbers, without altering the original data stored in the database.

dev-master 2024-11-17 08:22 UTC

Requires

• php: ^8.3
• illuminate/contracts: ^10.0||^11.0

MIT

• Kunal Kanani

• laravel
• maskable
• data hide

README

Install the package via Composer:

composer require kunalkanani/maskable
php artisan vendor:publish --tag="config"

Usage

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use KunalKanani\Maskable\Maskable;
use KunalKanani\Maskable\Rules\EmailMaskRule;
use App\MaskRules\CustomMaskRule;

class ExampleModel extends Model
{
    use Maskable;

    protected $maskable = [
        'email' => EmailMaskRule::class,
        'first_name' => CustomMaskRule:class
    ];
}

php artisan tinker

$exampleModel = ExampleModel::findOrFail(1);
$exampleModel->email;
'K****@test.com'
$exampleModel->first_name;
'Ku***'

$exampleModel->unmasked();
$exampleModel->email;
'[e-mail]'
$exampleModel->first_name;
'Kunal'

Create custom masking rules

<?php

namespace App\MaskRules;

use Illuminate\Support\Str;
use KunalKanani\Maskable\Rules\MaskRuleInterface;

class CustomMaskRule implements MaskRuleInterface
{
    public function apply(string $value): string
    {
        return Str::mask($value, '*', 2);
    }
}