/didcomm-mediator

DIDComm mediator compatible with Hyperledger-Aries

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Server-side implementation of DID communication (DIDComm).

Summary

The dominant paradigm in mobile and web development today is duplex request-response. You call an API with certain inputs, and you get back a response with certain outputs over the same channel (Http over TCP connection)

Unfortunately, many agents are not good analogs to web servers. They may be mobile devices that turn off at unpredictable intervals and that lack a stable connection to the network. They may need to work peer-to-peer, when the internet is not available. They may need to interact in time frames of hours or days, not with 30-second timeouts. They may not listen over the same channel that they use to talk.

Because of this, the fundamental paradigm for DIDComm is

  • message-based
  • asynchronous
  • simplex.

Agent X sends a message over channel A. Sometime later, it may receive a response from Agent Y over channel B. This is much closer to an email paradigm than a web paradigm

Installation

Helm chart https://github.com/Sirius-social/didcomm-helm

Motivation

According to The DIDComm design attempts to be:

  • Secure
  • Private
  • Decentralized
  • Transport-agnostic
  • Routable (allows mixed and dynamic transports; passes through mix networks and other generic infrastructure that sees only payload BLOBs)
  • Interoperable
  • Extensible
  • Efficient

Features

This repo contains server-side part of DIDComm infrastructure to solve DIDComm challenges in Mobile Apps development:

  • routing issues of mobile devices:
    • Incoming DID-Communication messages will arrive, even if the mobile agent is behind a firewall and network-address-translation (NAT).
    • Incoming DID-Communication messages continue to arrive, even when the IP address of the mobile agent changes (switching between, 3G, 4G, Wifi, roaming, ...).
  • transport issues of mobile devices:
  • secure challenges:
    • Simple encapsulation of DIDcom messages, getting trust from the DIDcom Encryption Envelope, so, on top of transport layer, using DIDComm, individuals on semi-connected mobile devices become full peers
    • In additional server side endpoints use HTTPS with TLS 1.2 (and Websockets wss://) or greater with a forward secret
  • private goals:
    • DIDComm uses public key cryptography, not certificates from some parties and passwords from others. Its security guarantees are independent of the transport over which it flows. It is sessionless (though sessions can easily be built atop it). When authentication is required, all parties do it the same way.
    • Registration is self-service, intermediaries require little trust, and no terms and conditions apply.
  • interoperability:
    • protocol Aries-RFC 0160 to establish P2P connection between independent Mobile App and Server-side Mediator to authenticate in mediator services (see below)
    • protocol Aries-RFC 0211 to allocate Http endpoint, accessible from internet.
    • protocol Aries-RFC 0212 to pull queued messages
    • DIDComm extension queue transport extension to indicate duplex channel (via websocket) between edge-agent and mediator. See usage details here
  • efficient
    • This server app is packed to docker image to rapidly deploy, maintain, scale with microservices approach
    • Fast to start: appliccation, presented in the repo, has user-friendly admin page and dashboards.

Mediation Flow

See details here Mediation.md

Quick Start

You may quickly start with cloud-mediator, check samples for it

or set-up self-maintained one

  1. Navigate to docs directory and pull all docker images: docker-compose pull
  2. You should generate Mediator public and private keys: docker-compose run --rm app manage generate_seed, you will see something like this: 
    =================================================================================
SEED value is:
                6tyKXax9gbmyLjRjMXrGouPBQ9SZ8L2h
place it to SEED environment variable
=================================================================================
    seed value make it possible to restore Mediator cryptography keys and DIDs independently of hardware and software environment
  3. Replace in docker-compose.yml file SEED environment with generated seed on prev step
  4. Run application docker-compose up -d and open in browser Admin Page http://localhost:8000/admin to finish configurations via Admin Web Page

Deploy

Develop and contribute

To contribute code, send message to support@socialsirius.com or create issue