kielabokkie/laravel-conceal

Conceal data in an array or collection

v1.4.0 2022-01-05 20:59 UTC

Requires

• php: ^7.2|^8.0
• illuminate/support: ^5.7|^6.0|^7.0|^8.0

Requires (Dev)

• orchestra/testbench: ^3.7|^4.0

MIT

• kielabokkie

README

This package allows you to conceal sensitive data in arrays and collections. This is particularly useful when writing possibly sensitive data to log files.

Once installed you can do things like this:

$data = [
    'username' => 'wouter',
    'api_key' => 'secret'
];

$hide = ['api_key'];

$output = conceal($data, $hide);
print_r($output);

// Outputs: ['username' => 'wouter', 'api_key' => '********']

Requirements

• PHP >= 7.2
• Laravel 5.7+ | 6 | 7 | 8

Installation

Install the package via composer:

composer require kielabokkie/laravel-conceal

Package configuration

This package has minimal configuration. All you can do at the moment is set the keys that are concealed by default. If you want to add your own defaults you can do that by publishing the config file by running the following command:

php artisan vendor:publish --provider="Kielabokkie\LaravelConceal\ConcealServiceProvider"

These are the contents of the file that will be published at config/conceal.php:

return [
    /*
     * Array of keys that will be concealed automatically.
     */
    'defaults' => [
        'password',
        'password_confirmation',
    ]
];

Usage

Use the default configuration to conceal the password:

$data = [
    'username' => 'wouter',
    'password' => 'secret'
];

$output = conceal($data);
print_r($output);

// Outputs: ['username' => 'wouter', 'password' => '********']

Set keys on the fly:

$data = [
    'api_key' => 'secret'
];

$output = conceal($data, ['api_key']);
print_r($output);

// Outputs: ['api_key' => '********']

Everything works exactly the same for collections:

$data = new Collection([
    'username' => 'wouter',
    'password' => 'secret'
]);

$output = conceal($data);
print_r($output->toArray());

// Outputs: ['username' => 'wouter', 'password' => '********']

And last but not least, it works recursively too:

$data = [
    'password' => 'secret',
    'nextlevel' => [
        'password' => 'secret',
    ]
];

$output = conceal($data);
print_r($output);

// Outputs: ['password' => '********', 'nextlevel' => ['password' => '********']]

Facade

The examples above use the conceal() helper function. If Facades are more your thing you can use that instead:

use Kielabokkie\LaravelConceal\Facades\Concealer;

$data = [
    'password' => 'secret'
];

$output = Concealer::conceal($data);
print_r($output);

// Outputs: ['password' => '********']