Merge did:indy support

.dockerignore

@@ -1,2 +1,3 @@
 .git
 target
+github

.github/workflows/build.yml

@@ -24,6 +24,10 @@ on:
         default: false
         type: boolean
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   checks:
     name: Run checks
@@ -54,7 +58,7 @@ jobs:
       - name: Cargo fmt
         run: cargo fmt --all -- --check
 
-      - if: "runner.os == 'Linux'"
+      - if: ${{ runner.os == 'Linux' }}
         name: Pre-install cross
         run: |
           cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
@@ -83,13 +87,15 @@ jobs:
 
       - name: Run local node pool
         run: |
-          docker build -f ci/indy-pool.dockerfile -t test_pool --build-arg pool_ip=10.0.0.2 ci
-          docker network create --subnet=10.0.0.0/8 indy-sdk-network
-          docker run -d --name indy_pool -p 9701-9708:9701-9708 --net=indy-sdk-network test_pool
+          ./ci/test.sh up
 
       - name: Run tests
         run: cargo test --manifest-path libindy_vdr/Cargo.toml --features local_nodes_pool
 
+      - name: Stop local node pool
+        run: |
+          ./ci/test.sh down
+
   build-release:
     name: Build library
     needs: [checks]
@@ -136,17 +142,22 @@ jobs:
           shared-key: deps
           save-if: false
 
-      - name: Build
-        shell: sh
+      - if: ${{ matrix.use_cross }}
+        name: Build (cross)
+        run: |
+          cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
+          cross build --lib --release --target ${{ matrix.target }}
+
+      - if: ${{ !matrix.use_cross && matrix.architecture == 'darwin-universal' }}
+        name: Build (mac)
+        run: ./build-universal.sh
+
+      # Requires using the default shell on Windows, otherwise it will complain:
+      # "This perl implementation doesn't produce Windows like paths"
+      - if: ${{ !matrix.use_cross && matrix.architecture != 'darwin-universal' }}
+        name: Build (standard)
         run: |
-          if [ -n "${{ matrix.use_cross }}" ]; then
-            cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
-            cross build --lib --release --target ${{ matrix.target }}
-          elif [ "${{ matrix.architecture }}" == "darwin-universal" ]; then
-            ./build-universal.sh
-          else
-            cargo build --lib --release --target ${{ matrix.target }}
-          fi
+          cargo build --lib --release --target ${{ matrix.target }}
 
       - name: Upload library artifacts
         uses: actions/upload-artifact@v3
@@ -417,7 +428,7 @@ jobs:
     if: |
       (github.event_name == 'release' ||
       (github.event_name == 'workflow_dispatch' &&
-       github.event.inputs.publish == 'true'))
+       github.event.inputs.publish-binaries == 'true'))
 
     steps:
       - name: Fetch Android libraries
@@ -498,14 +509,14 @@ jobs:
       - name: Test python package
         # FIXME cross platform test the python package
         # maybe use the cross docker image?
-        if: "matrix.architecture != 'linux-aarch64'"
+        if: ${{ matrix.architecture != 'linux-aarch64' }}
         shell: sh
         run: |
           pip install dist/*
           python -m demo.test
         working-directory: wrappers/python
 
-      - if: "runner.os == 'Linux'"
+      - if: ${{ runner.os == 'Linux' }}
         name: Audit wheel
         run: |
           auditwheel show wrappers/python/dist/* | tee auditwheel.log

.gitignore

@@ -12,3 +12,5 @@ coverage
 *.tgz
 *.so
 .npmrc
+github
+**/networks

README.md

@@ -39,27 +39,49 @@ At a later stage it should be possible to install a precompiled 'wheel' package
 
 ## Proxy Server
 
-The `indy-vdr-proxy` executable can be used to provide a simple REST API for interacting with the ledger. Command line options can be inspected by running `indy-vdr-proxy --help`.
+The `indy-vdr-proxy` executable can be used to provide a simple REST API for interacting with one or more Indy ledgers. Command line options can be inspected by running `indy-vdr-proxy --help`.
 
-Responses can be formatted in either HTML or JSON formats. HTML formatting is selected when the `text/html` content type is requested according to the Accept header (as sent by web browsers) or the request query string is set to `?html`. JSON formatting is selected otherwise, and may be explitly selected by using the query string `?raw`. For most ledger requests, JSON responses include information regarding which nodes were contacted is returned in the `X-Requests` header.
+To start the proxy server for a single ledger use the following command:
+```
+indy-vdr-proxy -p <PORT> (-g <OPTIONAL_PATH_TO_GENESIS_FILE>)
+```
+
+To start the proxy server with the standard configuration of indy ledgers use the following command:
+`indy-vdr-proxy -p <PORT> -- --multiple-ledgers`
+This will get the ledger configuration from `https://github.com/IDunion/indy-did-networks`
 
-Sending prepared requests to the ledger is performed by delivering a POST request to the `/submit` endpoint, where the body of the request is the JSON-formatted payload. Additional endpoints are provided as shortcuts for ledger read transactions:
-
-- `/` The root path shows basic status information about the server and the ledger pool
-- `/genesis` Return the current set of genesis transactions
-- `/taa` Fetch the current ledger Transaction Author Agreement
-- `/aml` Fetch the current ledger Acceptance Methods List (for the TAA)
-- `/nym/{DID}` Fetch the NYM transaction associated with a DID
-- `/attrib/{DID}/endpoint` Fetch the registered endpoint for a DID
-- `/schema/{SCHEMA_ID}` Fetch a schema by its identifier
-- `/cred_def/{CRED_DEF_ID}` Fetch a credential definition by its identifier
-- `/rev_reg/{REV_REG_ID}` Fetch a revocation registry by its identifier
-- `/rev_reg_def/{REV_REG_ID}` Fetch a revocation registry definition by its registry identifier
-- `/rev_reg_delta/{REV_REG_ID}` Fetch a revocation registry delta by its registry identifier
-- `/auth` Fetch all AUTH rules for the ledger
-- `/auth/{TXN_TYPE}/{ADD|EDIT}` Fetch the AUTH rule for a specific transaction type and action
-- `/txn/{SUBLEDGER}/{SEQ_NO}` Fetch a specific transaction by subledger identifier (0-2, or one of `pool`, `domain`, or `config`) and sequence number.
+A custom ledger configuration can be provided either by specificing a Github repo or a local folder:
+```
+indy-vdr-proxy -p <PORT> -g <GITHUB_URL or PATH_TO_FOLDER> -- --multiple-ledgers
+```
+The structure needs to be as follows `<NAMESPACE>/OPTIONAL<SUB_NAMESPACE>/pool_transactions_genesis.json`, e.g. `/sovrin/staging/pool_transactions_genesis.json`
+
+Responses can be formatted in either HTML or JSON formats. HTML formatting is selected when the `text/html` content type is requested according to the Accept header (as sent by web browsers) or the request query string is set to `?html`. JSON formatting is selected otherwise, and may be explitly selected by using the query string `?raw`. For most ledger requests, JSON responses include information regarding which nodes were contacted is returned in the `X-Requests` header.
 
+Sending prepared requests to the ledger is performed by delivering a POST request to the `{LEDGER}/submit` endpoint, where the body of the request is the JSON-formatted payload. Additional endpoints are provided as shortcuts for ledger read transactions:
+- `/` Return configured ledgers 
+- `{LEDGER}/` Basic status information about the server and the ledger pool
+- `{LEDGER}/genesis` Return the current set of genesis transactions
+- `{LEDGER}/taa` Fetch the current ledger Transaction Author Agreement
+- `{LEDGER}/aml` Fetch the current ledger Acceptance Methods List (for the TAA)
+- `{LEDGER}/nym/{DID}` Fetch the NYM transaction associated with an unqualified DID. Can be used with `timestamp` or `seq_no` query parameters to fetch specific versions
+- `{LEDGER}/attrib/{DID}/endpoint` Fetch the registered endpoint for an unqualified DID
+- `{LEDGER}/schema/{SCHEMA_ID}` Fetch a schema by its identifier
+- `{LEDGER}/cred_def/{CRED_DEF_ID}` Fetch a credential definition by its identifier
+- `{LEDGER}/rev_reg/{REV_REG_ID}` Fetch a revocation registry by its identifier
+- `{LEDGER}/rev_reg_def/{REV_REG_ID}` Fetch a revocation registry definition by its registry identifier
+- `{LEDGER}/rev_reg_delta/{REV_REG_ID}` Fetch a revocation registry delta by its registry identifier
+- `{LEDGER}/auth` Fetch all AUTH rules for the ledger
+- `{LEDGER}/auth/{TXN_TYPE}/{ADD|EDIT}` Fetch the AUTH rule for a specific transaction type and action
+- `{LEDGER}/txn/{SUBLEDGER}/{SEQ_NO}` Fetch a specific transaction by subledger identifier (0-2, or one of `pool`, `domain`, or `config`) and sequence number.
+
+If the proxy server is used with a single ledger, the `{LEDGER}` part of the path must be omitted.
+
+### DID:Indy Resolver
+
+Indy VDR contains a DID Resolver to resolve DIDs and dereference DID Urls to ledger objects from configured ledgers according to the [did:indy specification](https://hyperledger.github.io/indy-did-method/).
+
+`GET /1.0/identifiers/{DID or DID_URL}`
 ## Connecting to a Ledger
 
 Whether using the library or the proxy server, you will need a `genesis.txn` file containing the set of pool genesis transactions. You can run a local pool in Docker using [VON-Network](https://github.com/bcgov/von-network) or follow the [Indy-SDK instructions](https://github.com/hyperledger/indy-sdk#how-to-start-local-nodes-pool-with-docker).

ci/indy-pool.dockerfile

@@ -1,49 +1,5 @@
-FROM ubuntu:16.04
-
-ARG uid=1000
-
-# Install environment
-RUN apt-get update -y && apt-get install -y \
-	git \
-	wget \
-	python3.5 \
-	python3-nacl \
-	python3-pip \
-	python3-setuptools \
-	apt-transport-https \
-	ca-certificates \
-	software-properties-common
-
-RUN pip3 install -U \
-	"pip~=9.0" \
-	"setuptools~=50.0" \
-	"supervisor~=4.2"
-
-RUN add-apt-repository "deb http://us.archive.ubuntu.com/ubuntu xenial main universe" && \
-	apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys CE7709D068DB5E88
-ARG indy_stream=master
-RUN add-apt-repository "deb https://repo.sovrin.org/deb xenial ${indy_stream}" && \
-	add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial stable"
-
-RUN useradd -ms /bin/bash -u $uid indy
-
-ARG indy_plenum_ver=1.13.0.dev1032
-ARG indy_node_ver=1.13.0.dev1221
-
-RUN apt-get update -y && apt-get install -y \
-	libsodium18 \
-	libbz2-dev \
-	zlib1g-dev \
-	liblz4-dev \
-	libsnappy-dev \
-	rocksdb=5.8.8 \
-	libindy \
-	ursa \
-	vim
-
-RUN pip3 install \
-	indy-plenum==${indy_plenum_ver} \
-	indy-node==${indy_node_ver}
+FROM ghcr.io/hyperledger/indy-node-container/indy_node:1.13.2-rc5-ubuntu20-main
+RUN pip3 install "supervisor~=4.2"
 
 RUN echo "[supervisord]\n\
 logfile = /tmp/supervisord.log\n\

ci/test.sh

@@ -0,0 +1,50 @@
+#/bin/bash
+
+readonly command=$(basename ${0})
+
+help(){
+    echo "Usage: $command <subcommand> [options]\n"
+    echo "Subcommands:"
+    echo "    up"
+    echo "    test"
+    echo "    down"
+    echo "Default behavior without a subcommand is up, test, down"
+}
+
+up(){
+  docker build -f ci/indy-pool.dockerfile -t test_pool --build-arg pool_ip=10.0.0.2 ci
+  docker network create --subnet=10.0.0.0/8 indy-sdk-network
+  docker run -d --name indy_pool -p 9701-9708:9701-9708 --net=indy-sdk-network test_pool
+}
+
+run_tests(){
+  cargo test  --manifest-path libindy_vdr/Cargo.toml --features local_nodes_pool
+}
+
+down(){
+  docker stop indy_pool
+  docker rm indy_pool
+  docker network rm  indy-sdk-network
+}
+
+subcommand="$1"
+case $subcommand in
+  "-h" | "--help")
+    help
+    ;;
+  "up")
+    up
+    ;;
+  "test" | "tests")
+    run_tests
+    ;;
+  "down")
+    down
+    ;;
+  *)
+    up
+    run_tests
+    down
+    ;;
+esac
+

indy-vdr-proxy/Cargo.toml

@@ -14,15 +14,19 @@ default = ["fetch", "zmq_vendored"]
 
 [dependencies]
 clap = "3.1"
-env_logger = "0.9"
+env_logger = "0.10"
+futures-executor = "0.3"
 futures-util = "0.3"
+indy-vdr = { path = "../libindy_vdr", default-features = false, features = ["log"] }
+git2 = "0.14.2"
 hyper = { version = "0.14", features = ["http1", "http2", "server"] }
 hyper-tls = { version = "0.5", optional = true }
 log = "0.4.8"
 percent-encoding = "2"
+regex = "1.5.4"
 serde_json = "1.0"
 tokio = { version = "1.0", features = ["macros", "rt-multi-thread", "signal"] }
-indy-vdr = { path = "../libindy_vdr", default-features = false, features = ["log"] }
+url = "2.2.2"
 
 [target.'cfg(unix)'.dependencies]
 hyper-unix-connector = "0.2"

indy-vdr-proxy/src/app.rs

@@ -2,13 +2,15 @@ extern crate clap;
 use clap::{Arg, Command};
 
 pub struct Config {
-    pub genesis: String,
+    pub genesis: Option<String>,
+    pub namespace: String,
     #[cfg(unix)]
     pub socket: Option<String>,
     pub host: Option<String>,
     pub port: Option<u16>,
     pub init_refresh: bool,
     pub interval_refresh: u32,
+    pub is_multiple: bool,
 }
 
 pub fn load_config() -> Result<Config, String> {
@@ -24,6 +26,18 @@ pub fn load_config() -> Result<Config, String> {
                 .value_name("GENESIS")
                 .help("Path to the ledger genesis transactions")
         )
+        .arg(
+            Arg::new("name")
+                .short('n')
+                .long("name")
+                .takes_value(true)
+                .value_name("NAMESPACE")
+                .help("Namespace of ledger for DID resolution. Only needed if not multiple-ledgers")
+        )
+        .arg(
+            Arg::new("multiple-ledgers")
+                .help("Support multiple ledgers")
+        )
         .arg(
             Arg::new("host")
                 .short('h')
@@ -68,19 +82,18 @@ pub fn load_config() -> Result<Config, String> {
 
     let matches = app.get_matches();
 
-    let genesis = matches
-        .value_of("genesis")
-        .unwrap_or("genesis.txn")
-        .to_owned();
+    let genesis = matches.value_of("genesis").map(|v| v.to_owned());
+
+    let namespace = matches.value_of("name").unwrap_or("test").to_owned();
+
+    let is_multiple = matches.is_present("multiple-ledgers");
 
     if matches.occurrences_of("socket") > 0 {
         if matches.occurrences_of("host") > 0 {
             return Err("Cannot specify both host and socket".to_owned());
         }
-    } else {
-        if matches.occurrences_of("port") == 0 {
-            return Err("Port number or socket must be specified".to_owned());
-        }
+    } else if matches.occurrences_of("port") == 0 {
+        return Err("Port number or socket must be specified".to_owned());
     }
 
     #[cfg(unix)]
@@ -101,11 +114,13 @@ pub fn load_config() -> Result<Config, String> {
 
     Ok(Config {
         genesis,
+        namespace,
         #[cfg(unix)]
         socket,
         host,
         port,
         init_refresh,
         interval_refresh,
+        is_multiple,
     })
 }