Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 6.3 KB

README.md

File metadata and controls

105 lines (76 loc) · 6.3 KB
Raw

Aries RFC 0793: Unqualified DID Transition

Summary

Historically, Aries use of the Indy SDK's wallet included the use of 'unqualified DIDs' or DIDs without a did: prefix and method. This transition documents the process of migrating any such DIDs still in use to fully qualified DIDs.

This process involves the adoption of the Rotate DID protocol and algorithm 4 of the Peer DID Method, then the rotation from the unqualified DIDs to any fully qualified DID, with preference for did:peer:4.

The adoption of these specs will further prepare the Aries community for adoption of DIDComm v2 by providing an avenue for adding DIDComm v2 compatible endpoints.

Codebases that do not use unqualified DIDs MUST still adopt DID Rotation and did:peer:4 as part of this process, even if no unqualified DIDs must be rotated.

This RFC follows the guidance in RFC 0345 about community-coordinated updates to (try to) ensure that independently deployed, interoperable agents remain interoperable throughout this transition.

The transition from the unqualified to qualified DIDs will occur in four steps:

  • Pre-work: where we agree on the transition plan outlined in this RFC.
    • Finalize did:peer:4 details, including feature discovery support of did:peer:4.
    • Verify transisiton plan and code.
  • Step 1: Agent builders MUST update all agent code bases and deployments to support DID Rotation and did:peer:4.
    • Each agent builder SHOULD notify the community they have completed Step 1 by submitting a PR to update their entry in the implementations accordingly.
    • Target Date for code update: 2024-05-01
    • Target Date for deployment update: 2024-07-02
  • Step 2: Agent builders using unqualified DIDs MUST no longer use new unqualified DIDs, and MUST use DID Rotation to rotate to a fully qualified DID.
    • Each agent builder SHOULD notify the community they have completed Step 2 by submitting a PR to update their entry in the implementations accordingly.
    • Target Date for finishing step 2: 2024-11-01
  • Step 3: Agent builders SHOULD update their deployments to remove all support for receiving unqualified DIDs from other agents.

The community coordination triggers between the steps above will be as follows:

  • Pre-work to Step 1 - a PR to this RFC is merged that sets the RFC status to ACCEPTED.
  • Step 1 to Step 2 - the community agrees that the majority of the deployed agents have completed Step 1. A PR to this RFC is merged that sets the RFC status to ADOPTED.
    • Agent builders indicate completion of Step 1 by updating the Implementations section of this RFC.
    • All other RFCs in this repo are updated to use the new message type format.
    • The ADOPTED version of this RFC is included in the current Aries Interop Profile version.
  • Step 2 to Step 3 - the community agrees that the majority of the deployed agents have completed Step 2. A PR to this RFC is merged that sets the RFC status to RETIRED.
    • Agent builders indicate completion of Step 2 by updating the Implementations section of this RFC.

Motivation

To enable agent builders to independently update their code bases and deployed agents while maintaining interoperability.

Tutorial

The general mechanism for this type of transition is documented in RFC 0345 about community-coordinated updates.

The specific sequence of events to make this particular transition is outlined in the summary section of this RFC.

Reference

See the summary section of this RFC for the details of this transition.

Drawbacks

None identified.

Rationale and alternatives

This approach balances the speed of adoption with the need for independent deployment and interoperability.

Prior art

The approach outlined in RFC 0345 about community-coordinated updates is a well-known pattern for using deprecation to make breaking changes in an ecosystem. That said, this is the first attempt to use this approach in Aries. Adjustments to the transition plan will be made as needed, and RFC 0345 will be updated based on lessons learned in executing this plan.

Unresolved questions

  • Are any changes to existing RFCs needed before starting Step 1?

Implementations

The following table lists the status of various agent code bases and deployments with respect to the steps of this transition. Agent builders MUST update this table as they complete steps of the transition.

Name / Link Implementation Notes
Aries Protocol Test Suite No steps completed
Aries Framework - .NET No steps completed
Trinsic.id No steps completed
Aries Cloud Agent - Python No steps completed
Aries Static Agent - Python No steps completed
Aries Framework - Go No steps completed
Connect.Me No steps completed
Verity No steps completed
Pico Labs No steps completed
IBM No steps completed
IBM Agent No steps completed
Aries Cloud Agent - Pico No steps completed
Aries Framework JavaScript No steps completed