PHPackages                             webnet-fr/database-anonymizer-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. webnet-fr/database-anonymizer-bundle

ActiveSymfony-bundle[Database & ORM](/categories/database)

webnet-fr/database-anonymizer-bundle
====================================

Database anonymizer bundle.

v0.0.1(6y ago)56.1k11[3 issues](https://github.com/webnet-fr/database-anonymizer-bundle/issues)MITPHPPHP ^7.1.3

Since Aug 6Pushed 1y ago3 watchersCompare

[ Source](https://github.com/webnet-fr/database-anonymizer-bundle)[ Packagist](https://packagist.org/packages/webnet-fr/database-anonymizer-bundle)[ Docs](https://webnet.fr)[ RSS](/packages/webnet-fr-database-anonymizer-bundle/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (12)Versions (2)Used By (0)

Database anonymizer bundle
==========================

[](#database-anonymizer-bundle)

[![Build Status](https://camo.githubusercontent.com/aa966660acb13882528610cd29ff5549de7053091e07c860c06551c99fd119be/68747470733a2f2f7472617669732d63692e6f72672f7765626e65742d66722f64617461626173652d616e6f6e796d697a65722d62756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/webnet-fr/database-anonymizer-bundle)[![codecov](https://camo.githubusercontent.com/dcdc08097e4715c76d65ae5a726f8aa663cae1bc2feecf4aefc955bccbf331c2/68747470733a2f2f636f6465636f762e696f2f67682f7765626e65742d66722f64617461626173652d616e6f6e796d697a65722d62756e646c652f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/webnet-fr/database-anonymizer-bundle)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/9ca09e4c38f5dbe48d6c33c735eea63fa0d4447c89b9307578ecebb4fca29acb/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7765626e65742d66722f64617461626173652d616e6f6e796d697a65722d62756e646c652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/webnet-fr/database-anonymizer-bundle)

### Why ?

[](#why-)

[General Data Protection Regulation](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) (GDPR) imposes strict rules in the domain of information storage and treatment. You must not treat the users' personal data unless there is a strong necessity. In case you want to dump a production database in order to use it during development you cannot store or use peronal data in a dumped database anymore. You must delete or anonymize personal information before importing a production database in your developpment setting.

### How ?

[](#how-)

This bundle is based on our [database anonymizer](https://github.com/webnet-fr/database-anonymizer) library which in turn relies on [Faker](https://github.com/fzaninotto/Faker). After installation the command `webnet-fr:anonymizer:anonymize` will be available in your application.

Anonymize the database using a specified connection and a specified config file:

```
php bin/console webnet-fr:anonymizer:anonymize --connection= --config=
```

Anonymize the database using a specified connection and a default bundle config:

```
php bin/console webnet-fr:anonymizer:anonymize --connection=
```

Anonymize the database using a default connection and a specified config file:

```
php bin/console webnet-fr:anonymizer:anonymize --config=
```

Anonymize the database using a default connection and a default bundle config:

```
php bin/console webnet-fr:anonymizer:anonymize
```

### How to install ?

[](#how-to-install-)

Require the bundle:

```
composer require webnet-fr/database-anonymizer-bundle
```

Activate it. Here is an example for Symfony 4:

```
// config/bundles.php

return [
    // ...
    WebnetFr\DatabaseAnonymizerBundle\WebnetFrDatabaseAnonymizerBundle::class => ['dev' => true],
];
```

```
# config/dev/webnet_fr_database_anonymizer.yaml
webnet_fr_database_anonymizer:
    # configuration
```

### How to configure the fields to anonymize ?

[](#how-to-configure-the-fields-to-anonymize-)

Check out [how to configure the fields to anonymize](https://github.com/webnet-fr/database-anonymizer#how-to-configure-the-fields-to-anonymize-) of the database anonymizer library. The bundle provides you with the same configuration with one addition: you can configure anonymization par each connection.

- Configuration of one default connection:

```
# packages/dev/webnet_fr_anonymizer.yaml
webnet_fr_database_anonymizer:
    # using default connection
    tables:
        :
            primary_key:
            fields:
                :
                    generator:
```

```
# packages/doctrine.yaml
doctrine:
    # default
    dbal:
        # driver, host, user, password, etc.
```

- Configuration of multiple connections:

```
# packages/dev/webnet_fr_anonymizer.yaml
webnet_fr_database_anonymizer:
    connections:
        first_connection:
            tables:
                :
                    primary_key:
                    fields:
                        :
                            generator:

        second_connection:
            tables:
                :
                    primary_key:
                    fields:
                        :
                            generator:
```

```
# packages/doctrine.yaml
doctrine:
    dbal:
        default_connection: user_database
        connections:
            first_connection:
                # driver, host, user, password, etc.

            second_connection:
                # driver, host, user, password, etc.
```

- Using annotations:

If you create [entities](https://symfony.com/doc/current/doctrine.html) you can configure anonymization with annotations :

```
use Doctrine\ORM\Mapping as ORM;
use WebnetFr\DatabaseAnonymizerBundle\Annotation as Anonymize;

/**
 * @ORM\Table(name="orders")
 * @ORM\Entity
 *
 * This annotation marks the entities to anonymize.
 * @Anonymize\Table()
 */
class Orders
{
    /**
     * @ORM\Column(name="id", type="integer", nullable=false, options={"unsigned"=true})
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    public $id;

    /**
     * @ORM\Column(name="address", type="string", length=256, nullable=true)
     * @Anonymize\Field(generator="faker", formatter="address")
     */
    public $address;

    /**
     * @ORM\Column(name="zip_code", type="string", length=10, nullable=true)
     * @Anonymize\Field(generator="faker", formatter="postcode")
     */
    public $zipCode;

    /**
     * @ORM\Column(name="comment", type="text", length=0, nullable=true)
     * @Anonymize\Field(generator="faker", formatter="text", arguments={300})
     */
    public $comment;

    /**
     * @ORM\Column(name="created_at", type="datetime", nullable=true)
     * @Anonymize\Field(generator="faker", formatter="dateTime", date_format="Y-m-d H:i:s")
     */
    public $createdAt;

    /**
     * @ORM\Column(name="comment_history", type="array", nullable=true)
     *
     * A custom generator with its custom arguments.
     * @Anonymize\Field(generator="comment_history", max_messages_nb=5)
     */
    public $commentHistory;
}
```

### How add your own custom generator ?

[](#how-add-your-own-custom-generator-)

If you are not satisfied by the generators Faker gives you you can always add your own.

Imagine you have an entity that stores the users' orders:

```
use Doctrine\ORM\Mapping as ORM;

/**
 * Users' orders.
 *
 * @ORM\Table(name="orders")
 * @ORM\Entity
 */
class Orders
{
    /**
     * History of all user's comments.
     * @var string[]
     *
     * @ORM\Column(name="comments", type="array", nullable=true)
     */
    public $comments;
}
```

And you would like to anonymize each comment in this array:

```
webnet_fr_database_anonymizer:
    tables:
        # ...

        orders:
            fields:
                # ...
                comments:
                    generator: comment_history # your generator
```

In most cases you'll have to add two classes:

1. A factory:

```
namespace App\DatabaseAnonymizer;

use Faker\Factory;
use WebnetFr\DatabaseAnonymizer\Exception\UnsupportedGeneratorException;
use WebnetFr\DatabaseAnonymizer\Generator\GeneratorInterface;
use WebnetFr\DatabaseAnonymizer\GeneratorFactory\GeneratorFactoryInterface;

/**
 * The factory that creates a generator out of provided configuration.
 * It is a Symfony service.
 */
class CommentHistoryGeneratorFactory implements GeneratorFactoryInterface
{
    /**
     * @param array $config
     *        An array of the configuration for field to anonymize. It contains
     *        all specified entries, like "generator", "unique", "date_format",
     *        "my_custom_entry", etc.
     *
     * @throws \WebnetFr\DatabaseAnonymizer\Exception\UnsupportedGeneratorException
     *          The factory MUST throw "UnsupportedGeneratorException" if it is
     *          impossible to create the generator for provided configuration.
     *
     * @return GeneratorInterface
     */
    public function getGenerator($config): GeneratorInterface
    {
        // Check if the field should be anonymized with "comment_history" encoder.
        $generatorKey = $config['generator'];
        if ('comment_history' !== $generatorKey) {
            throw new UnsupportedGeneratorException($generatorKey.' generator is not known');
        }

        // Retrieve any configuration values you need.
        $locale = $config['locale'] ?? 'en_US';
        $minMessagesNb = $config['min_messages_nb'] ?? 1;
        $maxMessagesNb = $config['max_messages_nb'] ?? 10;

        // Create and configure generator.
        // Usually there is ONE generator instance for ONE field to anonymize
        // because there could be different config values for differet fields
        // even though these fields are anoymized with the same
        // "comment_history" generator.
        $faker = Factory::create($locale);
        $generator = new CommentHistoryGenerator($faker);
        $generator->setMinMessagesNb($minMessagesNb);
        $generator->setMaxMessagesNb($maxMessagesNb);

        return $generator;
    }
}
```

Since `CommentHistoryGeneratorFactory` is a Symfony service it can depend on any other service (for example on `UserPasswordEncoderInterface` to be able to encode passwords).

If you use `autodiscover` and `autoconfiguraiton` of Symfony services that is all you need. Otherwise you need to register the factory as a service:

```
services:
    App\DatabaseAnonymizer\CommentHistoryGeneratorFactory:
        tags: ["database_anonymizer.generator_factory"]
```

2. A generator:

```