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

Explain profiles #177

Merged
merged 3 commits into from Apr 12, 2021
Merged

Explain profiles #177

merged 3 commits into from Apr 12, 2021

Conversation

dhh1128
Copy link
Contributor

@dhh1128 dhh1128 commented Apr 5, 2021

Signed-off-by: Daniel Hardman daniel.hardman@sicpa.com

Signed-off-by: Daniel Hardman <daniel.hardman@sicpa.com>
@dhh1128
Copy link
Contributor Author

dhh1128 commented Apr 5, 2021

@TelegramSam and @troyronda: I don't know if this is the right place to put this content, and I also don't know how much what I added here overlaps with what Troy will write. But here's a quick attempt to capture what we discussed on the call today. To be refined and/or replaced with something better...

### Defined Profiles

* `didcomm/aip1`: The encryption envelope, signing mechanism, plaintext conventions, and routing algorithms embodied in Aries AIP 1.0, circa 2020.
* `didcomm/aip2`: The encryption envelope, signing mechanism, plaintext conventions, and routing algorithms embodied in Aries AIP 2.0, circa 2020.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are actually two flavors of AIP2 - one with Envelope v1 (RFC 19) and one with Envelope v2 (RFC 587).

Currently the media types in the Aries accept properties are:

  • application/json;flavor=didcomm-msg (roughly the equivalent of AIP1).
  • application/didcomm-encrypted+json;cty=application/json (roughly the equivalent of AIP2 with Envelope v2).

With AIP2 + Envelope v2, we are allowing an AIP to enable community transition with an AIP2 target. If we could include that target concept here, then we could propose the same profile media type concept in Aries RFCs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Good point.

What if we did the following:

  • didcomm/aip1: (no change in descrip)
  • didcomm/aip2retro: The signing mechanism, plaintext conventions, and routing algorithms embodied in Aries AIP 2.0, circa 2020 -- with the old-style encryption envelope from Aries RFC 0019. This legal variant of AIP 2.0 minimizes differences with codebases that shipped AIP 1.0 support.
  • didcomm/aip2pro: The signing mechanism, plaintext conventions, and routing algorithms embodied in Aries AIP 2.0, circa 2020 -- with the new-style encryption envelope from Aries RFC 0587. This legal variant of AIP 2.0 lays the foundation for DIDComm v2 support by anticipating the eventual envelope change.
  • didcomm/v2 (keep current description)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dhh1128 - nice writeup.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the text to address this point. What do you think, @troyronda ?

Signed-off-by: Daniel Hardman <daniel.hardman@sicpa.com>
2. The key types used for encryption and/or signing
3. The format of the encryption and/or signing envelopes
4. The encoding of plaintext messages
5. The protocol used to forward forward and route
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo - two forwards

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Updated.

Signed-off-by: Daniel Hardman <daniel.hardman@sicpa.com>
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

Successfully merging this pull request may close these issues.

None yet

4 participants