Add VC-JWT diagrams to core specification about vc-data-model

[OR13]

I have tooling that generates similar graphs for JWT headers, which serve the same purpose...

I can take the action to produce svg diagrams for JWT headers.

[selfissued]

Boy, that sounds straightforward...

[OR13]

%%{
  init: {
    'theme': 'base',
    'themeVariables': {
      'primaryColor': '#DDDDDD',
      'primaryTextColor': '#000000',
      'nodeBorder': '#000000',
      'edgeLabelBackground': '#DDDDDD',
      'clusterBkg': '#DDDDDD',
      'clusterBorder': '#000000',
      'lineColor': '#000000',
      'fontFamily': 'monospace',
      'darkmode': true
    }
  }
}%%
graph 
    subgraph 0 [&nbsp Verifiable Credential  &nbsp ]
        n4("Metadata")
        n5("Claim(s)")
        n6("Proof(s)")
	end
    
    subgraph 1 [&nbsp JSON Web Token &nbsp ]
        n1("Header")
        n2("Claimset")
        n3("Signature")
	end
    
    subgraph 2 [&nbsp Claimset &nbsp ]
        subgraph 3 [&nbsp Metadata &nbsp ]
            n7("AlumniCredential")
            n8("Credential 123")
            n9("ExampleUniversity")
            n10("2023-05-21T19:16:35.495Z")
        end
        subgraph 4 [&nbsp Claims &nbsp ]
            n11("Pat")
            n12("ExampleUniversity")
        end
    end
    subgraph 5 [&nbsp Protected Header &nbsp ]
        n13("iss: did:example:123")
        n14("kid: #key-42")
        n15("alg: ES384")
        n16("typ: vc+ld+jwt")
        n17("cty: vc+ld+json")
	end
	0 -- &nbsp representation &nbsp  --> 1
    n8 -- type --> n7
    n8 -- validFrom --> n10
    n8 -- issuer --> n9
    n8 -- subject --> n11
    n11 -- AlumniOf --> n12
    n2 --> 2
    n1 --> 5

class n1,n4,n7,n8,n9,n10,n13,n14,n15,n16,n17 RedNode;
class n2,n5,n11,n12 YellowNode;
class n3,n6 GreenNode;

classDef RedNode text-align: center, color:#000, fill:#DDAABB, stroke:#000, stroke-width:1px;
classDef YellowNode color:#000, fill:#FFEE99, stroke:#000, stroke-width:1px;
classDef GreenNode color:#000, fill:#BBDDAA, stroke:#000, stroke-width:1px;

🌶️ view source

[OR13]

With "proof tunneling"

%%{
  init: {
    'theme': 'base',
    'themeVariables': {
      'primaryColor': '#DDDDDD',
      'primaryTextColor': '#000000',
      'nodeBorder': '#000000',
      'edgeLabelBackground': '#DDDDDD',
      'clusterBkg': '#DDDDDD',
      'clusterBorder': '#000000',
      'lineColor': '#000000',
      'fontFamily': 'monospace',
      'darkmode': true
    }
  }
}%%
graph 

        
    subgraph 1 [&nbsp JSON Web Token &nbsp ]
        n1("Header")
        n2("Claimset")
        n3("Signature")
    end
    
    subgraph 7 [&nbsp Verifiable Credential &nbsp ]
        subgraph 2 [&nbsp Credential Graph &nbsp ]
            subgraph 3 [&nbsp Metadata &nbsp ]
                n7("AlumniCredential")
                n8("Credential 123")
                n9("ExampleUniversity")
                n10("2023-05-21T19:16:35.495Z")
            end
            subgraph 4 [&nbsp Claims &nbsp ]
                n11("Pat")
                n12("ExampleUniversity")
            end
        end
        subgraph 6 [&nbsp Proof Graph &nbsp ]
            n18("Signature 456")
            n19("DataIntegrityProof")
            n20("2023-05-21T20:09:37.988Z")
            n21("zu4oey5q...eV6")
            n22("Example University Public Key 7")
        end
    end
        
        
    subgraph 5 [&nbsp Protected Header &nbsp ]
        n13("iss: did:example:123")
        n14("kid: #key-42")
        n15("alg: ES384")
        n16("typ: vc+ld+jwt")
        n17("cty: vc+ld+json")
    end
        

    2 -- &nbsp proof &nbsp  --> 6

    n8 -- type --> n7
    n8 -- validFrom --> n10
    n8 -- issuer --> n9
    n8 -- subject --> n11
    n11 -- AlumniOf --> n12
    n2 --> 7
    n1 --> 5

    n18 -- type --> n19
    n18 -- created --> n20
    n18 -- proofValue --> n21
    n18 -- verificationMethod --> n22

class n1,n4,n7,n8,n9,n10,n13,n14,n15,n16,n17 RedNode;
class n2,n5,n11,n12 YellowNode;
class n3,n6,n18,n19,n20,n21,n22 GreenNode;

classDef RedNode text-align: center, color:#000, fill:#DDAABB, stroke:#000, stroke-width:1px;
classDef YellowNode color:#000, fill:#FFEE99, stroke:#000, stroke-width:1px;
classDef GreenNode color:#000, fill:#BBDDAA, stroke:#000, stroke-width:1px;

[OR13]

Related PR is the digital bazaar tooling which is powering the current examples rendered in the spec... digitalbazaar/respec-vc#8

[iherman]

The issue was discussed in a meeting on 2023-06-28

• no resolutions were taken

View the transcript

2.10. Add VC-JWT diagrams to core specification (issue vc-data-model#1135)

See github issue vc-data-model#1135.

Brent Zundel: #1135 - Add VC JWT diagrams to core specification.

Manu Sporny: yes, this can be a post-CR thing.

Michael Prorock: +1 post cr.

Brent Zundel: as diagrams are non-normative this is a post-CR.

Orie Steele: related to date integrity proofs in the core context and need to be understood by implementers. The pictures are one of the most important information we offer.

Shigeya Suzuki: Is it possible to add "diagram" tag for any issues requests diagrams?

Manu Sporny: +1 for diagrams visualizing both securing mechanisms.

Orie Steele: prefer to see the diagrams upgraded include proof specs that define securing mechanisms.

Manu Sporny: (PRs welcome) :).

Brent Zundel: w3c/vc-data-integrity#107.

Orie Steele: anyone working on JWT want diagrams to show up in the core data model? open a PR.

Brent Zundel: PRs are welcomed! (Manu encouraged that).

Orie Steele: You can always put your text in an issue, and ask an editor to do the PR for it.

Brent Zundel: if anyone has a problem raising a PR ask for help of Brent or anyone to learn how.

Michael Jones: reinforced Orie's comment about stuff that should be in the securing spec.

Orie Steele: +1 selfissued.

Manu Sporny: -1 to not talking about securing in the core spec.

Dave Longley: of course, philosophies around external vs. internal securing mechanisms are at odds there -- we should remember they are different things and that may influence approaches.