User consents management using Blockchain technology to guarantee integrity and traceability of private data.

Confluence Page: MODL - EvalBlockchain

Évaluer l’utilisation de la technologie blockchain pour garantir l’intégrité et la traçabilité des données privées.

1. Make sure Python 3.6+ is installed.
2. Install the dependencies in your preferred virtual environment manager (pipenv, conda, etc.)

pip install -e <blockchain-repo-root> 

3. Generate one or more blockchains:

python blockchain/app.py --port 5002 --db file://<custom-directory> --new

4. Run one or more server nodes:

python blockchain/app.py -s secret -p 5001 --db file://<custom-directory>  # loads all "<blockchain-id>/chain.json" in directory
python blockchain/app.py -s secret -p 5002 --db file://<custom-directory>/<id>/chain.json  # loads only that blockchain
python blockchain/app.py -s secret -p 5003 --db file://<custom-directory>/chains.txt  # loads only listed blockchains IDs
python blockchain/app.py -s secret --port 5004 --db <db-impl>://<db-connector>  # use an alternate database implementation

When running server nodes, any predefined set of nodes within a shared network should be provided directly with the --nodes='<node1-url>,<node2-url>,...' option to allow consensus resolution between nodes. Otherwise, nodes can be registered after startup using the relevant API endpoints.

When running the above commands to start a server node, uvicorn ASGI runner is automatically called to serve the Web Application. Any additional parameters supported by uvicorn can be specified on the command line. For example, timeout controls and workers can be configured as follows.

python blockchain/app.py \
  --db "file://<custom-directory>" \
  --secret 'blockchain-1' \
  -N "0.0.0.0:5002" -N "0.0.0.0:5003" -N "0.0.0.0:5004" \
  --host "0.0.0.0" \
  --port 5001 \ 
  --workers 20 \ 
  --timeout-keep-alive 10

The CLI will automatically handle and redirect relevant parameters for the blockchain and the ASGI runner respectively.

5. Once started, refer to the following endpoints for OpenAPI requests and details:

Details about the current blockchain node:

GET localhost:<port>/

OpenAPI description:

GET localhost:<port>/api

6. Refer to usage help for further customization options:

python blockchain/app.py --help

Another option for running this blockchain program is to use Docker.
Follow the instructions below to create a local Docker container:

1. Clone this repository
2. Build the docker container

docker build -t blockchain:1.1.0 .

3. Run the container

docker run --rm -p 80:5000 blockchain:1.1.0 <blockchain-parameters>

4. To add more instances, vary the public port number before the colon:

docker run --rm -p "81:5000" blockchain:1.1.0 <blockchain-parameters>
docker run --rm -p "82:5000" blockchain:1.1.0 <blockchain-parameters>
docker run --rm -p "83:5000" blockchain:1.1.0 <blockchain-parameters>

Contributions are welcome! Please feel free to submit a Pull Request.

Following are the reference resources and source code employed to start development of this project.

• Original code: dvf/blockchain
• Building a Blockchain blogpost

The blockchains are intended to contain tracking of Consent changes and resolution. Each blockchain UUID (multiple chains per nodes) represent a potential user for management their Consents.

Following is a visual representation of such Consents using UI endpoints.

Similar details can be retrieved from the API endpoints, as well as further operations on the blockchains and nodes their should process consensus resolution against.

The Consents are generated with a set of demonstration Actions, which can be extended as needed by modifying the ConsentsAction enumeration.