openwallet-foundation / acapy

Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments.
https://wiki.hyperledger.org/display/aries
Apache License 2.0
412 stars 512 forks source link

Missing goal codes in DID exchange protocol implementation #1652

Closed jleach closed 1 year ago

jleach commented 2 years ago

The DID Exchange RFC notes the implication of a goal/code to better reason about why a connection is being established:

  "goal_code": "aries.rel.build",
  "goal": "To create a relationship",

Its also mentioned in the Out-Of-Band protocol in Invitation: https://didcomm.org/out-of-band/%VER/invitation:

  "goal_code": "issue-vc",
  "goal": "To issue a Faber College Graduate credential",

But, in the ACA-py agent Swagger docs its absent /out-of-band/create-invitation/

{
  "alias": "Barry",
  "attachments": [
    {
      "id": "attachment-0",
      "type": "present-proof"
    }
  ],
  "handshake_protocols": [
    "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0"
  ],
  "mediation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "metadata": {},
  "my_label": "Invitation to Barry",
  "use_public_did": false
}
andrej-zirko commented 1 year ago

We are considering the utilization of goal codes with implicit invitation.

The inviter will receive a request from invitee using create request and Public DID. However, the webhook received by the inviter does not provide specific details about the invitee.

At present, we haven't come across any particular information that can be displayed to the inviter, except for the goal and goal code.

Are there any alternative methods available currently to convey information about the invitee to the inviter?

Thank you

swcurran commented 1 year ago

@usingtechnology — please take this one. Hopefully it should be a quick and dirty addition to the API for OOB.

For @andrej-zirko ’s use case, the request Admin API call also needs goal and goal code to be added, so please include that if the Admin API does not currently support it.

Of course, if the underlying protocols do not also support goal codes, that will also need to be supported…

usingtechnology commented 1 year ago

Ok, on it.