Merge pull request #685 from bcgov/acapy-flags-md

Philipp Etschel · web-flow · commit ddce112f46ec · 2021-12-10T10:58:14.000+01:00
Readme for aca-py flags
diff --git a/README.md b/README.md
@@ -113,6 +113,8 @@ Learn how to contribute in [Contributing](CONTRIBUTING.md). You can also start b
 
 Regarding release process, we do not follow a strict process yet, nevertheless we follow the guidelines described in [Publishing](PUBLISHING.md).
 
+Learn what aries protocols can be controlled by the BPA in [aca-py-args](scripts/aca-py-args.md)
+
 ## Business Partner Agent in Action
 - [COP26 Presented by BC Goverment and OpenEarth Foundation](https://www.youtube.com/watch?v=q0Jml3isSh8)
 - [Use Case and Technical Demonstration Playlist](https://www.youtube.com/watch?v=TGiiNOoVoJs&list=PL9CV_8JBQHiooHv05idOTrR2eBAJM89LX)
diff --git a/docs/Quickstart.md b/docs/Quickstart.md
@@ -0,0 +1,66 @@
+## What is the Business Partner Agent
+
+The Business Partner Agent leverages the [aries-cloudagent-python](https://github.com/hyperledger/aries-cloudagent-python) which a python implementation of the [Hyperledger ARIES](https://www.hyperledger.org/use/aries) protocols, which define the issuance, holding, and verification of the [Hyperledger Indy Verifiable Credentials](https://www.hyperledger.org/use/hyperledger-indy) (and [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/)). 
+
+## Why do I need to know those things
+There are operations and concepts critical to the usage, security, and privacy that should not be overlooked. The Business Partner Agent's goal is to simplify the usage of these technologies, but is still constrained by the requirements of the infrastructure. 
+
+## Before you start the application
+
+Configure the ledger
+
+This system is build on a distributed ledger (based on indy) that holds public cryptographic keys for Digital IDentities (DID's) as well as other artifacts required to exchange Indy Credentials. 
+
+.env file sets the following important environment variable. 
+
+`ACAPY_GENESIS_URL`
+This is the web address the ACA-py agent will use to discover all the nodes on the Indy Ledger you wish to use.
+
+Example Values: 
+- **`http://host.docker.internal:9000/genesis`** will configure the agent that the Business Partner Agent uses to write to a VON network hosted directly on your local machine, this is great for local development/testing. That ledger can started by running `./start_infra.sh`  In [local-network](../scripts/local-network)
+- **`http://test.bcovrin.vonx.io/genesis`** will configure the agent that the Business Partner Agent uses to write to a Sovrin ledger hosted by the BC Provincial Government that is for development purposes and is free to use.
+- For a production use case, you will need to pick your ledger carefully for one that meets your needs. [Sovrin MainNET](https://sovrin.org/transaction-endorsers/) is one ledger that would be appropriate in production. 
+
+
+`ACAPY_SEED`
+
+This is a [seed](https://en.wikipedia.org/wiki/Random_seed) value that aca-py uses to randomly generate your cryptographic keys (private and public) and DID. This SEED is the master key to your DID, if someone gained a copy of your SEED, they would be able to impersonate your DID, [identity theft is not a joke](https://youtu.be/WaaANll8h18?t=61). If you lost or overwrote your own SEED, all data stored in any previous wallet would be inaccessible as aca-py no longer has key to decrypt the wallet (however credentials that were already issues can still be verified as your public key is still on the ledger)
+
+If you intend to create a new DID, then the `ACAPY_SEED` value is not important. However if you intend to start the Business Partner Agent to manage an existing DID, you would need to set the `ACAPY_SEED` appropriately. 
+
+## Automatically on startup
+
+1) The ACA-py agent will write your DID and Public Key (VerKey) to the Hyperledger defined by `ACAPY_GENESIS_URL`.
+2) The ACA-py agent will provision it's wallet (encrypted database) to the Postgres instance defined in the .env file, that instance is defined and managed by the scripts in this project. 
+
+
+## The Alice Faber Demo
+
+The Verifiable Credential Community uses the [Alice/Faber Demo](https://kctheservant.medium.com/demonstration-of-hyperledger-aries-cloud-agent-6e476a5426b0) as the standard example. It involves an Individual 'Alice' getting a transcript/degree from the 'Faber' College and presenting that transcript to the 'Acme' Business. 
+
+Verifiable Credentials allow Alice to complete this trusted sharing of data without Acme and Faber needing to communicate directly. 
+
+To execute this demo, you will need...
+
+1) Configure and start Faber College (a BPA) to use the BCovrin Test Ledger [deploy this](../scripts/docker-compose.yaml), ensure `ACAPY_GENESIS_URL=http://test.bcovrin.vonx.io/genesis`
+
+2) Download a SSI Wallet to your Smartphone to act as `Alice's` personal wallet. We have used the `Trinsic Wallet` and `estatus Wallet` for our development testing, but are not affiliated or guarantee that will they operate correctly (The BPA is alpha software)
+
+Steps of the Issuance Demo using Alice Faber.
+
+1) Create a Schema, with whatever values seem appropriate (degree_name, graduation_date) [Demo](https://www.youtube.com/watch?v=wi6Q6WVYHbM&t=1859s)
+2) Create a CredDef [Demo](https://www.youtube.com/watch?v=wi6Q6WVYHbM&t=1950s)
+3) Create a Connection to your Personal Wallet [Demo](https://youtu.be/wi6Q6WVYHbM?t=1200)
+4) Issue Credential to your Personal Wallet [Demo](https://youtu.be/wi6Q6WVYHbM?t=1249)
+
+
+Steps of the Issuance Demo using Alice Faber.
+
+1) Configure and deploy second BPA to act as ACME
+2) Import Schema by Schema ID
+3) Create Proof Request template
+4) Create Connection to Personal Wallet (same steps as Issuance)
+5) Make Proof Request from ACME to Alice for proof of Degree. 
+
+
+
diff --git a/docs/aries-protocol-support.md b/docs/aries-protocol-support.md
@@ -0,0 +1,92 @@
+## ACA-PY args file
+
+`docker run bcgovimages/aries-cloudagent:py36-1.16-1_0.7.1 start --help`
+
+
+An option that is supported by the BPA means that it should be set as false in the 'acapy-static-args.yml' file. The BPA will receive the webhook from aca-py and handle it appropriatly, saving relevant data in the database, and displaying any 'in-progress' or 'completed' items in the UI for Users to inspect and interact with. 
+
+_For simplicity or demo purposes, it may be appropriate to set a supported flag to true. The BPA will still update any records appropriately, but aca-py will proceed with those protocols immediately, without interaction from the BPA, or the User._
+
+Options that are 'NOT-SUPPORTED' must be left true, so aca-py can automatically proceed with the aries protocols and the BPA does not have the behaviour to proceded with those protocols, either automatically, or for the user to decide.
+
+Feature should be built to allow the BPA to control protocols labelled 'NOT-SUPPORTED'
+
+```
+docker run bcgovimages/aries-cloudagent:py36-1.16-1_0.7.1 start --help
+...
+Debug:
+...
+  --auto-accept-invites
+                        Automatically accept invites without firing a webhook
+                        event or waiting for an admin request. Default: false.
+                        [env var: ACAPY_AUTO_ACCEPT_INVITES]
+        **SUPPORTED BY BPA**
+
+  --auto-accept-requests
+                        Automatically accept connection requests without
+                        firing a webhook event or waiting for an admin
+                        request. Default: false. [env var:
+                        ACAPY_AUTO_ACCEPT_REQUESTS]
+        **SUPPORTED BY BPA**
+
+  --auto-respond-messages
+                        Automatically respond to basic messages indicating the
+                        message was received. Default: false. [env var:
+                        ACAPY_AUTO_RESPOND_MESSAGES]
+        **SUPPORTED BY BPA**
+
+  --auto-respond-credential-proposal
+                        Auto-respond to credential proposals with
+                        corresponding credential offers [env var:
+                        ACAPY_AUTO_RESPOND_CREDENTIAL_PROPOSAL]
+        **SUPPORTED BY BPA**
+
+  --auto-respond-credential-offer
+                        Automatically respond to Indy credential offers with a
+                        credential request. Default: false [env var:
+                        ACAPY_AUTO_RESPOND_CREDENTIAL_OFFER]
+        **SUPPORTED BY BPA**
+        
+  --auto-respond-credential-request
+                        Auto-respond to credential requests with corresponding
+                        credentials [env var:
+                        ACAPY_AUTO_RESPOND_CREDENTIAL_REQUEST]
+        **SUPPORTED BY BPA**
+        
+  --auto-respond-presentation-proposal
+                        Auto-respond to presentation proposals with
+                        corresponding presentation requests [env var:
+                        ACAPY_AUTO_RESPOND_PRESENTATION_PROPOSAL]
+        **NOT-SUPPORTED**
+        
+  --auto-respond-presentation-request
+                        Automatically respond to Indy presentation requests
+                        with a constructed presentation if a corresponding
+                        credential can be retrieved for every referent in the
+                        presentation request. Default: false. [env var:
+                        ACAPY_AUTO_RESPOND_PRESENTATION_REQUEST]
+        **SUPPORTED BY BPA**
+        
+  --auto-store-credential
+                        Automatically store an issued credential upon receipt.
+                        Default: false. [env var: ACAPY_AUTO_STORE_CREDENTIAL]
+        **NOT-SUPPORTED**
+        
+  --auto-verify-presentation
+                        Automatically verify a presentation when it is
+                        received. Default: false. [env var:
+                        ACAPY_AUTO_VERIFY_PRESENTATION]
+        **NOT-SUPPORTED**
+        
+...
+Protocol:
+  --auto-ping-connection
+                        Automatically send a trust ping immediately after a
+                        connection response is accepted. Some agents require
+                        this before marking a connection as 'active'. Default:
+                        false. [env var: ACAPY_AUTO_PING_CONNECTION]
+        **SUPPORTED BY BPA**             
+...
+```
+
+The default 'acapy-static-args.yml` can be found [here](../scripts/acapy-static-args.yml). 
diff --git a/scripts/acapy-static-args.yml b/scripts/acapy-static-args.yml
@@ -6,10 +6,14 @@ auto-respond-credential-offer: false
 auto-respond-credential-request: false
 auto-respond-presentation-proposal: true
 auto-respond-presentation-request: false
+
 auto-store-credential: true
 auto-verify-presentation: true
+
 auto-ping-connection: true
+
 auto-provision: true
+
 monitor-ping: true
 preserve-exchange-records: false
 public-invites: true
diff --git a/scripts/scenarios/local-network/acapy-static-args.yml b/scripts/scenarios/local-network/acapy-static-args.yml
@@ -6,10 +6,14 @@ auto-respond-credential-offer: false
 auto-respond-credential-request: false
 auto-respond-presentation-proposal: true
 auto-respond-presentation-request: false
+
 auto-store-credential: true
 auto-verify-presentation: true
+
 auto-ping-connection: true
+
 auto-provision: true
+
 monitor-ping: true
 preserve-exchange-records: false
 public-invites: true
diff --git a/scripts/scenarios/local-network/docker-compose.yml b/scripts/scenarios/local-network/docker-compose.yml
@@ -176,7 +176,7 @@ services:
   #######
   tails-server:
     build:
-      context: https://github.com/bcgov/indy-tails-server.git#master
+      context: https://github.com/bcgov/indy-tails-server.git#main
       dockerfile: docker/Dockerfile.tails-server
     ports:
       - "6543:6543"
