the-hardforq / kyc-issuer

kyc-issuer

KYC Issuer (this document is WORK IN PROGRESS)

This Issuers implements the following protocols:

• DIF DIDComm Messaging V2
• Out-of-Band Messages 2.0
• Routing Protocol 2.0
• Peer DID Method Specification
• HTTPS Transport
• Trust Ping Protocol 2.0
• Discover Features Protocol 2.0
• WACI PEx Issue Credential Protocol 3.0: only a subset was implemented, request-credential --> issue-credential
• Shorten URL Protocol 1.0

Significant libraries

DIDComm and Peer DID were implemented with the help of the following amazing libraries from SICPA:

• sicpa-dlab/didcomm-python
• sicpa-dlab/peer-did-python

Installation

python -m venv ./venv 
source ./venv/bin/activate
pip install requirements.txt

Mongo DB

This mediator use MongoDB as Data Base. You need to have it installed before running. One installaton option is with docker as:

docker pull mongo
docker run --name mongo_example -d mongo

Envirnomental varables

The following environmental variables are needed. Change the values as your need:

export DB_URL=mongodb://localhost:27017
export PUBLIC_URL=http://127.0.0.1:8000
export ROTATE_OOB=0  // rotate OOB at startup if set
export MONGODB_USER={MongoDB username}
export MONGODB_PASSWORD={MongoDB password}
export WOLFRAM_ALPHA_API_ID=ZZZZZZ // only for basicmessage demo (https://www.wolframalpha.com)
export DATASEERS_API_KEY={DataSeers API KEY}
export PRISM_SDK_PASSWORD="ghp_..." // only if issuer is did:prism
export ATALA_PRISM_JARS="<working_dir>/prism-cli-v1.4.1/lib" // only if issuer is did:prism

Runing the agent

uvicorn main:app --reload --host 0.0.0.0

Build docker

docker build -f ./Dockerfile .  -t kyc-issuer
docker run -p 8000:8000 kyc-issuer

ATALA Prism Credential Issuer

In order to issue Prism Credentials you need Java 11 and download Prism SDK (need a Prism SDK password from IOG). This agent use JPype as a wrapper to access Java classes from Python.

1- Export your Prism SDK Password: export PRISM_SDK_PASSWORD="ghp_..."

2- Download anx extract the JVM SDK

curl "https://maven.pkg.github.com/input-output-hk/atala-prism-sdk/io/iohk/atala/prism-cli/v1.4.1/prism-cli-v1.4.1.zip" -H "Authorization: Bearer ${PRISM_SDK_PASSWORD}" -L -O
unzip prism-cli-v1.4.1.zip

3- Export JAVA_HOME and ATALA_PRISM_JARS as follows:

export JAVA_HOME=<java_home_directory>
export ATALA_PRISM_JARS="<working_dir>/prism-cli-v1.4.1/lib"

4- Export Prism Issuer switch

export PRISM_ISSUER=1