README.md

ClearGDPR Platform

Overview

Regardless of your data stores, ClearGDPR allows you to install on-premise or in the cloud, a complete web based GDPR compliance tool, with Blockchain anchored chain-of-custody records.

This repository contains implementation of the ClearGDPR platform as well as an example UI for the data subjects to demonstrate how developers can integrate with the ClearGDPR APIs and have a drop-in style compliance enabled for their project.

Table of contents

• Architecture
  • Project structure
• Quick Start guide
• Further reading
• Troubleshooting
• Roadmap
• License
• Contributing

Architecture

Project structure

The project is split into multiple services, each contained within it's own directory:

project root
├─ quorum                           # Blockchain related docker images and helper tools
├─ og                               # Code for the ClearGDPR API implementation
├─ frontend                         # Example React UI to interact with ClearGDPR API
├─ api                              # Example back-end React UI to interact with ClearGDPR API
├─ docs                             # Documentation artifacts (images, documents, etc.)
└─ travis                           # Scripts used on the CI server

Quick Start guide

The docker-compose.yml contains configuration for a reference development environment of one Data Controller and one Data Processor and all required dependencies.

To get started with the project the only pre-reqs are node (v7.6+), docker and docker-compose.

Our interactive quick start will get you up and running, simply run node setup.js from the root of the project and follow the prompts.

If you have issues getting up and running, be sure to check out our troubleshooting guide.

Further reading

Each part of the project has additional README documentation in its subfolder:

• Quorum image and tools README
• ClearGDPR (CG) API README
• Docker definitions README
• Demo backend README
• Demo frontend README
• Updating Travis Configuration

Troubleshooting

See the Troubleshooting guide

Roadmap

• CG API supports giving consent and revoking consent(erasure)
• All events are written to the blockchain
• Quorum smart contract that stores client state of processors and controllers
• Processor mode and controller mode is working, with events propagated between nodes through the blockchain smart contract
• A example UI with registration/consent and erasure abilities
• Encryption of all data on CG nodes
• Robust integration test suite of CG nodes for both processor and controller mode
• Admin dashboard design + front-end code (configuration, subject & processor status)
• Automate Quick Start script
• Interactive Quick Start wizard
• Admin dashboard hooked up to controller state via the CG api
• Adding the remaining GDPR article actions/rights
• More granular controls of consent/revoking of data (ie. which data can be shared specifically)
• Evolving functionalities, upgradability and security in the smart contract
• E2E test suite of controller/processor interaction via blockchain
• Usage of Quorum’s custom privateFor method for whitelisting of nodes that are privy to specific events
• Fleshing out an SDK for implementing CG interaction from your frontend
• Drop in wordpress plugin
• Commercial middleware plugin(s)

License

This project is licensed under GNU LGPL LICENSE

Contributing

See Contributing