arrilot/data-anonymization

Anonymize any data in your SQL database

1.1.3 2023-01-10 22:03 UTC

This package is auto-updated.

Last update: 2024-06-11 00:48:45 UTC


README

Latest Stable Version Scrutinizer Quality Score

Data anonymization

  • This simple framework-agnostic package helps you to replace any sensitive production data in your development databases.

Installation

If you use anything from this list, you'd better install a corresponding bridge package

Otherwise just composer require arrilot/data-anonymization

Usage

Workflow:

  1. Create a php executable.

  2. Define how you want to anonymize your data in this file using fluent api (see example below).

  3. Make sure it is not accessible throw the web and etc.

  4. Run it every time you want.

Here is an example file that illustrates api really well:

#!/usr/bin/env php
<?php

use Arrilot\DataAnonymization\Anonymizer;
use Arrilot\DataAnonymization\Blueprint;
use Arrilot\DataAnonymization\Database\SqlDatabase;

require './vendor/autoload.php';

$dsn = 'mysql:dbname=test;host=127.0.0.1';
$user = 'testuser';
$password = 'test';

$database = new SqlDatabase($dsn, $user, $password);
$anonymizer = new Anonymizer($database);

// Describe `users` table.
$anonymizer->table('users', function (Blueprint $table) {
    // Specify a primary key of the table. An array should be passed in for composite key.
    // This step can be skipped if you have `id` as a primary key.
    // You can change default primary key for all tables with `Blueprint::setDefaultPrimary('ID')`
    $table->primary('id');

    // Replace with static data.
    $table->column('email1')->replaceWith('john@example.com');

    // Use #row# template to get "email_0@example.com", "email_1@example.com", "email_2@example.com"
    $table->column('email2')->replaceWith('email_#row#@example.com');

    // To replace with dynamic data a $generator is needed.
    // Any generator object can be set like that - `$anonymizer->setGenerator($generator);`
    // A simpler way is just to do `require fzaninotto/Faker` and it will be set automatically.
    $table->column('email3')->replaceWith(function ($generator) {
        return $generator->email;
    });

    // Use `where` to leave some data untouched.
    // If you don't list a column here, it will be left untouched too.
    $table->column('email4')->where('ID != 1')->replaceWith(function ($generator) {
        return $generator->unique()->email;
    });
});

$anonymizer->run();

echo 'Anonymization has been completed!';