validatedid / ssi-eidas-bridge

eIDAS Bridge API

SSI eIDAS Bridge API service linking the European Trust and Legal Framework, named eIDAS (electronic IDentification, Authentication and trust Services), with the Self-Sovereign Identification (SSI) global trust framework, based on Decentralized Identifiers, or DIDs.

Table of Contents

1. Getting started
2. Building
3. Testing
4. Swagger Documentation
5. Licensing

Getting started

Prerequisites

You need:

• Node.js >= 12
• Yarn >= 1.22.0

Installing

Clone the repository and move to the project directory

git clone https://github.com/validatedid/ssi-eidas-bridge
cd ssi-eidas-bridge

Docker Build and Up

Copy .env.example to .env and set the following environment variables:

• BRIDGE_ENV : set to test, local, integration, development or production
• API_PRIVATE_KEY <-- TYPE HERE API PRIVATE KEY IN HEX FORMAT

Build and Run ssi-eidas-bridge Docker Image

docker-compose up --build

To stop the container, just press Ctrl^C and to remove the container:

docker-compose down

Building

Clone the repository and move to the project directory

git clone https://github.com/validatedid/ssi-eidas-bridge
cd ssi-eidas-bridge

Install the required libraries and packages dependencies

yarn install

Build project

yarn build

Start the swagger service API

yarn start

This command starts a node server exposing the SSI eIDAS Bridge Swagger API at http://localhost:9002/ssi-eidas-bridge/v1/api-docs/ where you can play with the API.

Testing

Copy .env.example to .env and set the following environment variables:

# Set to test, local, integration, development or production
BRIDGE_ENV=local

# DSS service used to validate the URL. DSS webapp demo can be deployed locally using Docker too,
# checkout this example: https://github.com/validatedid/dss-service
DSS_URL="https://ec.europa.eu/cefdigital/DSS/webapp-demo"

# REDIS key-value storage to store the p12 certificates.
REDIS_URL=127.0.0.1
REDIS_PORT=6379

Unit tests

Run:

yarn test:unit

Functional tests

Run:

yarn test:e2e

Unit & Integration tests

Run:

yarn test

Swagger Documentation

This project contains the SSI eIDAS Bridge Service,linking the European Trust and Legal Framework, named eIDAS (electronic IDentification, Authentication and trust Services), with the Self-Sovereign Identification (SSI) global trust framework, based on Decentralized Identifiers, or DIDs.

You can read the documentation at https://api.vidchain.net/ssi-eidas-bridge/v1/api-docs.