distributed-compliance-ledger

README

Distributed Compliance Ledger

If you are interested in how to build and run the project locally, please look at README-DEV

Please note, that the only officially supported platform now is Linux. It's recommended to develop and deploy the App on Ubuntu 18.04 or Ubuntu 20.04.

Please note, that there were breaking changes in DCL 0.6 (migration to the latest Cosmos SDK), so the current master and DCL releases 0.6+ are not compatible with pools and Test Nets running DCL 0.5.

Overview

DC Ledger is a public permissioned Ledger which can be used for two main use cases:

• ZB/Matter compliance certification of device models
• Public key infrastructure (PKI)

More information about use cases can be found in DC Ledger Overview and Use Case Diagrams.

DC Ledger is based on Tendermint and Cosmos SDK.

DC Ledger is a public permissioned ledger in the following sense:

• Anyone can read from the ledger (that's why it's public). See How to read from the Ledger.
• Writes to the ledger are permissioned. See How to write to the Ledger for details.
• PoA (proof of authority) approach is used for adding new validator nodes to the network (see Add New Node Use Case) and Running Node Instructions.

In order to send write transactions to the ledger you need:

• Have a private/public key pair
• Have an Account created on the ledger via ACCOUNT transaction (see Use Case Txn Auth).
  • The Account stores the public part of the key
  • The Account has an associated role. The role is used for authorization policies.
• Sign every transaction by the private key.

Main Components

Pool of Nodes

• A network of Tendermint-based validator nodes (Validators and Observers) maintaining the ledger.
• Every validator node (dcld binary) runs DC Ledger application code (based on Cosmos SDK) implementing the use cases.
• See the proposed deployment in deployment.

Clients

For interactions with the pool of nodes (sending write and read requests).

Every client must be connected to a Node (either Observer or Validator).

If there is no trusted node for connection, a Light Client Proxy can be used. A Light Client Proxy can be connected to multiple nodes and will verify the state proofs for every single value query request.

• CLI
• REST
• gRPC
• Tendermint RPC and Light Client

Please note, that multi-value queries don't have state proofs support and should be sent to trusted nodes only.

Please make sure that TLS is enabled in gRPC, REST or Light Client Proxy for secure communication with a Node.

Public UI (Outdated, doesn't work with DCL 0.6+)

• based on the REST API
• can be used to browse the ledger
  • please note that it doesn't show all the accounts on the ledger
  • it shows only the default (demo) accounts created on the UI server
• for demo purposes only: can be used for sending write requests from the default (demo) accounts
• source code and documentation are located in dcl-ui directory

How To

CLI

• The same dcld binary as a Node
• A full list of all CLI commands can be found there: transactions.md.
• CLI can be used for write and read requests.
• Please configure the CLI before using (see how-to.md).
• If there are no trusted Observer or Validator nodes to connect a CLI, then a Light Client Proxy can be used.

Light Client Proxy

Should be used if there are no trusted Observer or Validator nodes to connect.

It can be a proxy for CLI or direct requests from code done via Tendermint RPC.

Please note, that CLI can use a Light Client proxy only for single-value query requests. A Full Node (Validator or Observer) should be used for multi-value query requests and write requests.

Please note, that multi-value queries don't have state proofs support and should be sent to trusted node only.

See Run Light Client Proxy for details how to run it.

REST

• There are no state proofs in REST, so REST queries should be sent to trusted Validator or Observer nodes only.
• OpenAPI specification: https://zigbee-alliance.github.io/distributed-compliance-ledger/.
• Any running node exposes a REST API at port 1317. See https://docs.cosmos.network/master/core/grpc_rest.html.
• See transactions for a full list of endpoints.
• REST HTTP(S) queries can be directly used for read requests. See How to read from the Ledger.
• REST HTTP(S) queries can be directly used to broadcast generated and signed transaction.
• Generation and signing of transactions need to be done in code or via CLI. See How to write to the Ledger.

gRPC

• There are no state proofs in gRPC, so gRPC queries should be sent to trusted Validator or Observer nodes only.
• Any running node exposes a REST API at port 9090. See https://docs.cosmos.network/master/core/grpc_rest.html.
• A client code can be generated for all popular languages from the proto files proto, see https://grpc.io/docs/languages/.
• The generated client code can be used for read and write requests, i.e. generation and signing of transactions See How to read from the Ledger and How to write to the Ledger for details.

Tendermint RPC and Light Client

• Tendermint RPC is exposed by every running node at port 26657. See https://docs.cosmos.network/master/core/grpc_rest.html#tendermint-rpc.
• Tendermint RPC supports state proofs. Tendermint's Light Client library can be used to verify the state proofs. So, if Light Client API is used, then it's possible to communicate with non-trusted nodes.
• Please note, that multi-value queries don't have state proofs support and should be sent to trusted nodes only.
• There are currently no DC Ledger specific API libraries for various platforms and languages, but they may be provided in the future.
• The following libraries can be used as light clients:
  • Golang Light Client implementation
  • Rust Light Client implementation

Instructions

After the CLI or REST API is configured and Account with an appropriate role is created, the following instructions from how-to.md can be used for every role (see Use Case Diagrams):

• Trustee
  • propose new accounts
  • approve new accounts
  • propose revocation of accounts
  • approve revocation of accounts
  • propose X509 root certificates
  • approve X509 root certificates
  • propose revocation of X509 root certificates
  • approve revocation of X509 root certificates
  • publish X509 certificates
  • revoke X509 certificates
• CA
  • propose X509 root certificates
  • publish X509 certificates
  • revoke X509 certificates
• Vendor
  • publish vendor info
  • publish device model info
  • publish device model version
  • publish X509 certificates
  • revoke X509 certificates
• Test House
  • publish compliance test results
  • publish X509 certificates
  • revoke X509 root certificates
• Certification Center
  • certify or revoke certification of device models
  • publish X509 certificates
  • revoke X509 certificates
• Node Admin
  • add a new Validator node
  • publish X509 certificates
  • revoke X509 certificates

Run a local pool of nodes in Docker

See Run local pool section in README-DEV.md.

Deploy a persistent pool of nodes

A recommended way for deployment and client connection: diagram

One can either deploy its own network of validator nodes or join one of the persistent DC Ledger Networks.

• If you want to deploy your own network for debug purposes, you can use the provided Ansible Playbook: ansible/readme.md.
• If you want to join an existing network (either a custom or persistent) as a validator node, please follow the Running Node or a more detailed Running a Validator Node instructions.
• If you want to join an existing network as an observer node, please follow the Running Node or a more detailed Running an Observer Node instructions.
• If you want to deploy your own persistent network, you will need to create a genesis node and a genesis file first as described in Running Node or a more detailed Running a Genesis Validator Node. Please note, that these instructions describe the case when the genesis block consists of a single node only. This is done just for simplicity, and nothing prevents you from adding more nodes to the genesis file by adapting the instructions accordingly.

Useful Links

• OpenAPI specification
• Quick Start
• List of Transactions, Queries, CLI command, REST API
• How To Guide
• Use Case Diagrams
  • PKI
  • Device on-ledger certification
  • Device off-ledger certification
  • Auth
  • Validators
• DC Ledger Overview
• DC Ledger Architecture Details
• Deployment Pattern
• Running a Node
  • Running a Genesis Validator Node
  • Running a Validator Node
  • Running an Observer Node
• Tendermint
• Cosmos SDK