philiprehberger/php-mask

Mask sensitive data in strings, arrays, and objects for safe logging

v1.0.3 2026-03-17 20:06 UTC

Requires

• php: ^8.2

Requires (Dev)

• laravel/pint: ^1.0
• phpstan/phpstan: ^1.12|^2.0
• phpunit/phpunit: ^11.0

MIT

• Philip Rehberger

• logging
• sanitize
• mask
• privacy
• redact
• sensitive

README

Mask sensitive data in strings, arrays, and objects for safe logging.

Requirements

Dependency	Version
PHP	^8.2

Installation

composer require philiprehberger/php-mask

Usage

Email masking

use PhilipRehberger\Mask\Mask;

Mask::email('[e-mail]');
// "j***@e******.com"

Phone masking

Mask::phone('[phone]');
// "+1-555-***-4567"

Credit card masking

Mask::creditCard('4111 1234 5678 1111');
// "4111 **** **** 1111"

IP address masking

Mask::ip('192.168.1.100');
// "192.168.*.*"

Generic string masking

Mask::string('SensitiveData');
// "Se*********ta"

Mask::string('SensitiveData', visibleStart: 3, visibleEnd: 3);
// "Sen*******ata"

Array masking (deep)

$data = [
    'name' => 'John',
    'email' => '[e-mail]',
    'nested' => [
        'ssn' => '123-45-6789',
    ],
];

Mask::array($data, ['email', 'ssn']);
// ['name' => 'John', 'email' => 'jo************om', 'nested' => ['ssn' => '12*******89']]

JSON masking

$json = '{"name":"John","ssn":"123-45-6789"}';

Mask::json($json, ['ssn']);
// '{"name":"John","ssn":"12*******89"}'

Custom configuration

use PhilipRehberger\Mask\MaskConfig;

Mask::configure(new MaskConfig(
    maskChar: '#',
    preserveLength: false,
    visibleStart: 3,
    visibleEnd: 3,
));

Mask::string('SensitiveData');
// "Sen###ata"

API

Method	Description
Mask::email(string $email): string	Mask an email address, preserving first char of local/domain and TLD
Mask::phone(string $phone): string	Mask a phone number, preserving country code and last 4 digits
Mask::creditCard(string $number): string	Mask a credit card, showing first 4 and last 4 digits
Mask::ip(string $ip): string	Mask an IP address, showing first two octets (v4) or groups (v6)
Mask::string(string $value, int $visibleStart = 2, int $visibleEnd = 2): string	Mask a generic string with configurable visible characters
Mask::array(array $data, array $keys): array	Deep-mask specified keys in an associative array
Mask::json(string $json, array $keys): string	Parse JSON, mask specified keys, re-encode
Mask::configure(MaskConfig $config): void	Set global masking configuration
Mask::resetConfig(): void	Reset configuration to defaults

Development

composer install
vendor/bin/phpunit
vendor/bin/pint --test
vendor/bin/phpstan analyse

License

MIT