SpecShaper GDPR Bundle

A bundle to aid with the General Data Protection Regulation requirements.

Features include:

Written for Symfony verison 3.x.x
Provides annotation for adding to entity parameter doc blocks - this method is being deprecated.
Uses a PersonalData object and data transformers.
Records values for Data Protection Impact Assesments of entity parameters.
Uses SpecShaper\EncryptBundle to encrypt senstive data

Version History

Version 1

Version 1 of this project used annotations to classify entity parameter personal data.
This unfortunately could not be extended to managing live data, it runs into problems where data become expired. What should get displayed instead? How can live data status be reported with annotations?

Version 1 Features:

Generate a entity parameter coverage report.
Generate a summary report of all entity parameters and GDPR annotations.

Version 2

Version 2 uses a PersonalData entity to store the GDPR parameters associated with the personal data parameter.

A custom twig function can be used to:

Decrypt any encrypted data
Display current data in its correct format.
Display deleted/aggregated/annonymised data once it has been sanitised

Version 2 Features:

Warning

This bundle has not been unit tested.
It has only been running on a Symfony2 v3.0.1 project, and not backward compatibility tested.

Documentation

The source of the documentation is stored in the Resources/doc/ folder in this bundle.

License

This bundle is under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE

About

GdprBundle has been written for the SpecShaper and Parolla websites to encode users private data.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.

When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps.

Installation

Step 1: Download the bundle

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

$ composer require specshaper/gdpr-bundle dev-master

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new SpecShaper\GdprBundle\SpecShaperGdprBundle(),
            new SpecShaper\EncryptBundle\SpecShaperEncryptBundle(),
        );
        // ...
    }
    // ...
}

Step 2: Configure the bundle

Add an empty value for encrypt_key to your parameters file.

# app/config/parameters.yml

    # ...
    encrypt_key: ~

Geneate a 256 bit 32 character key using the command tool in the Encrypt bundle

$ bin/console encrypt:genkey

Now, replace your encryption key.

# app/config/parameters.yml

    # ...
    encrypt_key: <your_key_here>

Configure the EncryptBundle.

# app/config/config.yml

    # ...
    spec_shaper_encrypt:
        is_disabled: false

You can disable encryption of the database by setting deleting is_disabled or setting it true.

Configure the routing to access the reports:

# app/config/routing.yml

   # ...
    spec_shaper_gdpr:
        resource: "@SpecShaperGdprBundle/Controller/"
        type:     annotation
        prefix:   /gdpr

You should make sure that the /gdpr path is behind a firewall in your security settings.

# app/config/security.yml
    security:
        acces_control:
            # ...
            - { path: ^/gdpr/, role: [ROLE_SUPER_ADMIN] }

Add the personal_data doctrine type to doctrine

# app/config/config.yml
    doctrine:
        dbal:
            types:
                personal_data:  SpecShaper\GdprBundle\Types\PersonalDataType

Step 3: Create the entities if using the new personal_data type.

User the personal_data column type, and pass the options.

<?php
    // ...
    use Symfony\Component\Validator\Constraints as Assert;
    use SpecShaper\GdprBundle\Validator\Constraints as GdprAssert;
    // ...
    
    /**
     * Iban bank account number.
     *
     * @var string
     *
     * @GdprAssert\PersonalData({
     *     @Assert\NotBlank,
     *     @Assert\Iban
     * })
     *
     * @ORM\Column(type="personal_data", nullable=true, options={
     *     "format" = "STRING",
     *     "isSensitive"=false,
     *     "isEncrypted"=true,
     *     "idMethod"="INDIRECT",
     *     "identifiableBy"="Can be used to identify an individual if compared with third party database",
     *     "providedBy"="The employee, the employer",
     *     "purposeFor"="Used to pay employees by SEPA",
     *     "retainFor"="P6Y",
     *     "disposeBy"="SET_NULL",
     *     "methodOfReceipt"={"HTTPS"},
     *     "receiptProtection"={"TSS"},
     *     "methodOfReturn"={"HTTPS", "PDF"},
     *     "returnProtection"={"TSS","ENCRYPTED_PDF"}
     * })
     */
    protected $iban;

Look at the PersonalData object constants for the full range of options available.

The PersonalData field can be validated in the entity doc comments using the PersonalData constraint and defining the default symfony validation constaints as shown above".

Step 4: Converting your database.

Use the command below to update your database.

$bin/console gdpr:update

The command will find all Column annotations of type personal_data and convert the stored value to a PersonalData object.

Step 5: Use in forms

Use the PersonalDataType in forms. Note that this is different from the doctrine PersonalDataType.

<?php
// ...
use SpecShaper\GdprBundle\Form\Type\PersonalDataType;
    
    // ...
    $builder    
        ->add('iban', PersonalDataType::class, array(
            'required' => true,
            'label' => 'label.iban',
            'attr' => array(
                'placeholder' => 'placeholder.aValidInternationalBankAccountNumber'
            ),
            'constraints' => array(
                new Iban()
            )
        ))
        ;

You can also validate the entered value in the form before it gets passed to the entity.

If have custom validators then you will need to use the getData method on the PersonalData object and validate this value.

Step 5: Decode in templates

To view your data in a twig template:

{{ employee.bankAccount.iban }}

This will call the toString method of the PersonalData object, which will convert the data to its format as set in the entity field annotation.

If you want to access the data without any default conversion then use:

{{ employee.bankAccount.iban.data }}

If you query a repository using a select method, or get an array result then the doctrine onLoad event subscriber will not decyrpt any encrypted values.

In this case, use the twig_filter to decrypt your value when rendering.

{{ employee.bankAccount.iban.data | personal_data }}

Todo: Use the twig_filter for personal_data to pass rendering options:

{{ employee.bankAccount.iban.data | personal_data("date", "d M Y") }}
{{ employee.salary.data | personal_data("currency", "EUR") }}
{{ employee.height.data | personal_data("decimal", 2) }}

Step 6: Reporting

Coverage Report

Access the coverage report by navigating your browser to '\gdpr\reporting\coverage'.
This will serve an excel file that contains all the entities and parameters managed by the entity manager. If any of the parameters contain the "personal_data" column type it will also list each of the attributes values.

Note that at the moment we are only pulling information from the default entity manager. I need to improve the coverage report to get all entityManagers.

History Report

@todo Not yet written.

A report of log entries for:

PersonalData object creation and updates.
PersonalData object disposal.
PersonalData objects exported.

simokarpin/GdprBundle