Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a summary / overview of the data used in the cryptography across all of the AnonCreds interactions #20

Open
swcurran opened this issue Feb 28, 2022 · 2 comments

Comments

@swcurran
Copy link
Member

swcurran commented Feb 28, 2022

Add a section to the specification that provides an overview of the cryptography data elements used (see example below), with, with reference links (usually [[ref: ]]s) to where those elements are defined.

The original description of this task was to define a "Data Models" section in the specification. Instead, we are putting in the Data Models inline tagged with [[def: ]]-style definitions, and referencing them elsewhere in the specification, including in this overview section.

Original Description: For each data model referenced in the "data flow" documents, define the data structure in JSON and the purpose/meaning and optionality of each item. This includes:

  • All data objects that are persisted on the Verifiable Data Registry (VDR) and/or stored locally
  • All data objects that are transferred from one participant to another in a data flow operation (e.g. a Credential Offer that flows from the Issuer to the Holder)
@victormartinez-work victormartinez-work self-assigned this Mar 22, 2022
@victormartinez-work victormartinez-work removed their assignment Apr 11, 2022
@MichScha
Copy link

This is a pretty helpful part for understanding all object and their relations.

I think we should create a list of the individual data objects here with details of exactly where they are created, stored and between which participants they are exchanged (context example credential issuance). I would also add the description of the objects here and instead of linking to the appendix, link the json objects from the chapters. Might be easier to read and understand?

I am just wondering if we should also include something like nonce which the issuer needs to store locally for a later credential issuance. Thats seems to be too detailled.

Just a quick summary out of my mind
Local Data
Roles (whereas each entity could be in every role)

  • Issuer
    • private keys for did
    • peer-did keys?
    • cred_def private keys
  • Verifier
    • peer-did keys?
  • Holder
    • private keys for did
    • peer-did keys?
    • MasterSecret

Data on Verifiable Data Registry (Indy specific Domain Ledger)

  • nym
  • schema
  • cred_def
  • revoc_reg_def
  • revoc_reg_entry

Data in motion

  • Credential/Issuance
    • Credential-Offer
    • Credential-Request
    • Credential
  • Present Proof
    • Presentation-Request
    • Presentation

I am happy to take over this part if not someone is already working on it.

@swcurran
Copy link
Member Author

I think this is an excellent idea! Having it all in one section would be really good.

@swcurran swcurran changed the title Create the Data Model Descriptions document Add a summary / overview of the data used in the cryptography across all of the AnonCreds interactions Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants