RE: Diagrams for VC HTTP API work [was Re: [AGENDA] VC HTTP API Work Item - August 17th 2021]

Here's the first cut at the VC Verification Process ArchiMate model based on the data pulled from Joe's VC Verification - Sequence Diagram...

The most up-to-date version of all of the different model views can be found here: https://mwherman2000.github.io/VC-ARM/.

GitHub: https://github.com/mwherman2000/VC-ARM

Issues: https://github.com/mwherman2000/VC-ARM/issues

[cid:image003.jpg@01D797A0.911234D0]

From: Michael Herman (Trusted Digital Web) <mwherman@parallelspace.net>
Sent: August 22, 2021 5:33 PM
To: Michael Herman (Trusted Digital Web) <mwherman@parallelspace.net>; Joe Andrieu <joe@legreq.com>; Credentials Community Group <public-credentials@w3.org>
Subject: RE: Diagrams for VC HTTP API work [was Re: [AGENDA] VC HTTP API Work Item - August 17th 2021]

Here's a first cut of the VC Issuing Process ArchiMate model based on the data pulled from Joe's VC Issuance - Sequence Diagram...

GitHub: https://github.com/mwherman2000/VC-ARM

Issues: https://github.com/mwherman2000/VC-ARM/issues

[cid:image001.jpg@01D797A0.50AA0440]

From: Michael Herman (Trusted Digital Web) <mwherman@parallelspace.net<mailto:mwherman@parallelspace.net>>
Sent: August 22, 2021 9:33 AM
To: Joe Andrieu <joe@legreq.com<mailto:joe@legreq.com>>; Credentials Community Group <public-credentials@w3.org<mailto:public-credentials@w3.org>>
Subject: RE: Diagrams for VC HTTP API work [was Re: [AGENDA] VC HTTP API Work Item - August 17th 2021]

Here's some of my initial feedback on the otherwise very valuable diagrams:


  1.  A Role is a formal concept and cannot technically participate in any of these processes.  A Role is simply a label to which an Actor can be assigned.
Reference: https://pubs.opengroup.org/architecture/archimate3-doc/chap08.html#_Toc10045369
For example, Hollace is assigned to the Holder Role.
  2.  Software components (aka Agents) are the only things that can interact with each and with Wallets, other services, etc.
Reference: https://pubs.opengroup.org/architecture/archimate3-doc/chap09.html#_Toc10045389
For example, a Hollace's Holder Agent can interact with Izzy's Issuer Agent.
  3.  Agents have public Service Endpoints and these, in turn, are supported or implemented by internal software Functions.
Functions interact/invoke/call other Functions via APIs or Service Endpoints.
Here's an example. The intended audience is Software Architects and Developers.

[cid:image002.jpg@01D797A0.50AA0440]

From: Joe Andrieu <joe@legreq.com<mailto:joe@legreq.com>>
Sent: August 16, 2021 3:16 PM
To: Credentials Community Group <public-credentials@w3.org<mailto:public-credentials@w3.org>>
Subject: Diagrams for VC HTTP API work [was Re: [AGENDA] VC HTTP API Work Item - August 17th 2021]

Howdy folks,

Based on conversations with the use case team, I've put together the attached diagrams, illustrating a minimum conceptual model based on the USCIS Green Card use case, as implemented using CHAPI.

I'm sure this model is lacking some elements for folks who have a slightly different configuration. I chose this use case because it is the one I'm most familiar with, making it easiest to be complete. I'd like to speak to folks with different scenarios and see if we can't come up with a variation that covers your requirements.

A few notes.

1. There are sequence and communications diagrams for both issuance and verification, plus a class diagram.

2. All of the components are "owned" by one of the core roles (Holder, Issuer, Verifier) are color coded.

3. The class diagram aggregates the method calls on each of the lifelines in the other diagrams.

4. The components are
  a. Holder The entity who holds the VC once issued and later presents it for verification.
  b. Holder Application The software or service that allows holders to manage their credentials. Often called a wallet. For symmetry, it could be called a Holder Service.
  c. Storage Service The software or service that actually stores VCs long term (on behalf of the holder)
  d. Issuer Role The website or software that provides issuing functionality to a holder on behalf of that issuer)
  e. Issuer Service Software or service that actually signs VCs and VPs) This component is used by both the issuer  (to mint VCs) and the holder (to create VPs for presentation)
  f. Verifier Role The website or software that uses a Verification Service as part of its decision making process for providing services to holders.
  g. Verifier Service The software or service that verifies VCs and VPs by checking proofs and checking status.

Note that there are more components than had previously been itemized in the vc-http-api work, because storage and status services had not be broken out as distinct capabilities. This sometimes caused confusion. Some implementations will bundle all or some of these components into a full-stack credential platform, however, the APIs, IMO, must support interoperability between these components. So, yes, a Holder Application will need to have a way to get VPs created. Instead of assuming that's a subcomponent of the Holder Application, breaking it out illustrates, for example, the API that might be useful at an Issuer when acting on behalf of a holder.

5. The class diagram is a distillation across all component instances in all sequence and communications diagrams, so it starts to suggest an API for each of those components. Since I have only modeled one scenario's issuance and verification, I expect the API is not full coverage. However, it is nice to see that I only have the messages indicated by the USCIS, CHAPI-based flow (where, for example, VCs are always delivered in VPs, so the Verifier Service doesn't need a Verify VC method).

6. The message names are chosen for logical consistency in "normal English"; they should likely be turned into camel case or something and we can have a bikeshed festival.

7. The dance between roles and services matches the architecture for the services operating SaaS style for a front-end that is providing the "role" functionality on behalf of the actual entity in that role. For example, the USCIS plugfest had mock-up USCIS websites that beneficiaries interacted with, and which, in turn, it interacted with Issuer services. It is understood that the enterprising organization could run both the role and service software using its own bespoke custom software.

8. It is worth noting that all of the user tasks from the VC Use Cases document, except two, are accomodated. https://w3c.github.io/vc-use-cases/#user-tasks In particular, "move claim" and "amend claim" don't really have much support: neither the spec nor any implementation I know of addressed these use cases. "Move claim" feels like it gets addressed by "store", "retrieve", and "delete". Notably, the "delete" is not in the VC use case document, but probably should be; It almost certainly needs to be a feature in at least the storage service API. For the "amend" claim, I believe the only real way to do that today (given cryptographic proofs) is to revoke and re-issue. FWIW, I think we should remove "move" and "amend" the VC Use Cases document.

9. The "revoke" capability is not modelled yet, but it makes sense to add it to the status service (we just have the verifier service checking status). I just didn't build out that diagram.

That's it for now.

Plenty of fodder for discussion.

Comments and feedback welcome.

-j


On Sun, Aug 15, 2021, at 4:41 PM, Manu Sporny wrote:
VC HTTP API Work Item - August 17th 2021
Time: Tue 4pm ET, 1pm PT, 10pm CET, 8am NZDT (Wed)

Text Chat:
      http://irc.w3.org/?channels=ccg
      irc://irc.w3.org:6665/#ccg

Jitsi Teleconf:
      https://meet.w3c-ccg.org/vchttpapi

Duration: 60 minutes

MEETING MODERATOR: Manu Sporny

AGENDA:

1. Agenda Review, Introductions (5 minutes)

2. VC HTTP API Renaming Poll Reminder (5 minutes)
   https://lists.w3.org/Archives/Public/public-credentials/2021Aug/0124.html

3. Simple Majority Objection w/ GNAP-KBAT (30 minutes)
   https://github.com/w3c-ccg/vc-http-api/pull/224/files#r682106281
   https://lists.w3.org/Archives/Public/public-credentials/2021Aug/0110.html

4. Feature Scoping (15 minutes)
   https://lists.w3.org/Archives/Public/public-credentials/2021Aug/0122.html

5. Pull Requests (5 minutes)
   https://github.com/w3c-ccg/vc-http-api/pull/224

-- manu

--
Manu Sporny - https://www.linkedin.com/in/manusporny/
Founder/CEO - Digital Bazaar, Inc.
News: Digital Bazaar Announces New Case Studies (2021)
https://www.digitalbazaar.com/



--
Joe Andrieu, PMP                                                                              joe@legreq.com<mailto:joe@legreq.com>
LEGENDARY REQUIREMENTS                                                        +1(805)705-8651
Do what matters.                                                                            http://legreq.com<http://www.legendaryrequirements.com>