Skip to content

Latest commit

 

History

History
131 lines (102 loc) · 6.96 KB

README.md

File metadata and controls

131 lines (102 loc) · 6.96 KB
Raw

Vaccination certificates using Indy

This repository contains an example of issuing vaccination certificates using Indy.

This example consists of three agents. A web agent is for an issuer who issues vaccination certificates. It shows step by step guides what to be done in Indy to issue credentials. Two mobile agents are android app and iOS app that receive vaccination certificates and present proofs of vaccination.

SDKs and protocols

The agents do not use Aries frameworks. They use Indy SDK to handle certificates and proofs. They use QR codes to initiate communication and use HTTP as a communication channel. (A production service should use HTTPS instead of HTTP.)

Ledger usage

The agents use BCovrin test network for Indy ledger. It can be changed easily by replacing pool_transactions_genesis file in the web folder.

The mobile agent does not use the pool. It gets schema, credential definition, and revocation states from the web agents when it constructs proofs.

Running the agents

run_web.sh runs the web agent with Docker if you have Docker Desktop. You can also run the web agent without Docker by cd web; npm install; npm start. You need Nodejs and Indy SDK installed on your desktop. Be aware that installing Indy SDK on macOS is tricky.

You can use the web agent by visiting http://localhost:3000.

You need Android Studio and an android device to run the android agent. You cannot use android simulator to run the mobile agent bacause it needs qrcode scanner and it does not contain libraries for the simulator. The android device should use WIFI on the same network as the web agent. Or the mobile agent will not be able to connect to the web agent.

You need XCode and an iOS15 device to run the iOS agent. You also need cocoapods and cmake installed. Run pod install and open xcworkspace file.

More about the agents

Web agent

Web agent is a web app:

Web agent works as follows:

  • creates a wallet named demoWallet and a pool named demoPool on startup. demoWallet is created at ~/.indy_client/wallet/demoWallet and demoPool is created at ~/.indy_client/pool/demoPool using genesis file at web/pool_transactions_genesis.
  • gets it's IP address from the env variable SERVER or from the en0 interface
  • tells it's IP to the mobile agent via qrcode
  • creates a DID with seed given by you. You have to register this DID to the ledger. This DID is used to create a schema and a credential definition. Schema is defined in web/routes/schema.js.
  • stores it's status, did, schema, and credential definition in a file db.json. You can reset the web agent by removing db.json file and demoWallet folder. You need to delete demoPool folder if you want to change the pool.

Web agent provides the following REST APIs for mobile agent:

  • GET /credential/credOffer/{credId}: get the credential offer
  • POST /credential/credRequest/{credId}: request the credential
  • POST /credential/revoke/{credRevId}: revoke the credential
  • POST /credential/proof/{proofId}: present a proof
  • GET /schema: get the schema
  • GET /definition: get the credential definition
  • GET /revStates/{credRevId}: get the revocation state

Android agent

Android agent is an android app:

Android agent works as follows:

  • sets env variable EXTERNAL_STORAGE to applicationContext.filesDir telling where to create wallet files.
  • creates a wallet named demoWallet and open it.
  • creates a master secret in the wallet and save the secret's ID in the SharedPreference.
  • most of the logics are implemented in WalletMainActivity.kt. It scans the qrcode, parse it, and decide whether to get a credential or to present a proof.
  • does not connect to the pool. The prover usually fetchs schema, credential definition, and revocation state from the ledger to create a proof. Which schema to fetch depends on the proof request. In this example, we use only one schema and one credential definition, so the Android agent simply gets them from the web agent.

Notes on the libraries and dependencies:

  • Libindy wrapper for Java contains JNA which does not support android. Exclude the JNA and import the proper version that support android.
    implementation ('org.hyperledger:indy:1.14.2') {
        exclude group: 'net.java.dev.jna', module: 'jna'
    }
    implementation 'net.java.dev.jna:jna:5.8.0@aar'
  • Libindy wrapper for Java does not contain native libraries. libindy.so and libc++_shared.so should be located in the wallet-app/app/src/main/jniLibs/{abi} folder. You can find libc++_shared.so file in the NDK files if you install NDK.

iOS agent

iOS agent is an iOS app:

iOS agent works as follows:

  • doesn't need to set env variable EXTERNAL_STORAGE. Wallet files are created in the app's default document directory.
  • creates a wallet named demoWallet and open it.
  • creates a master secret in the wallet and save the secret's ID in the UserDefaults.
  • most of the logics are implemented in RequestHandler.swift. It processes getting a credential and presenting a proof.
  • like Android agent, does not connect to the pool.

Notes on the Libindy wrapper for iOS:

QR code data format

The QR codes generated by the web agent are json data with two types:

Credential Offer

{
  "type": "cred_offer",
  "title": "Vaccination certificate",
  "to": "Alice",
  "offer_id": "abcdefg1234",
  "server": "10.1.1.20:3000"
}

Proof Request

{
  "type": "cred_verify",
  "title": "Request proof of vaccination",
  "server": "10.1.1.20:3000",
  "proof_request": <json object>,
  "proof_id": "abcdefg5678"
}