SHARCS Readme

Prerequisies / Tested with

• Bun, ~v1.0.1

Server - Docker

• first time: run ./docker-build-image.sh
• as server: run docker run --rm --name sharcs-poc-container -p 8080:8080 sharcs-poc:latest
• API documentation available at http://localhost:8080/api-docs/

Run

• Install bun i
• Run the scripts using bun [script name] [optional index of diploma you want to try]
• Run the server using bun ./server.js

Configuration

• ./data
  • ./data/context: all locally downloaded contexts, so the demo doesn't rely on public resources/an internet connection
  • ./data/credentials: demo VCs
    • issues with these VCs
      • Concept.prefLabel is not defined in the context --> Concept.preferredLabel
      • some old contexts are removed and bbs is added

steps

• update the 'old' diplomas / store their status, see 01_refresh_diploma.ts
  • optionally validate using 02_verify.ts
• minimization
  • when a minimization request arrives, validate the diploma based on the ./data/shape, using 03_validate.js
  • minize the diploma based on the ./data/frame, using 04_minimize.ts
    • optionally validate using 05_verify.ts
• status
  • check status
  • update status
  • check status again
  • TODO init status should also create the status doc

Resources

• https://github.com/mattrglobal/jsonld-signatures-bbs
  • used for creating the VCs -> JSON-LD
• https://www.itb.ec.europa.eu/shacl/any/upload : if you don't feel like running validators locally

Ideas

• range queries: expand VC API options + add code
  • selective disclose + range
    • birthdate/date: diploma older than 3 year
    • substring?
• Proof of Signature / BBS?
  • Evidence record cfr DocByte (Merkle Tree)
  • VC ín VC + selective disclosure?
• selective points to frame: both normal frame as expanded frame?
  • test
• VP
• ❗ delivery
  • options / validate / verify / minimize