-
Notifications
You must be signed in to change notification settings - Fork 219
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
Unqualified DID Community Coordinated Update #793
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6f1d97f
unassigned number edit
TelegramSam 44edc1f
updated number
TelegramSam fcb2caf
Merge branch 'main' into unqualified_did_ccu
swcurran 9b44bd8
Updated for DID Rotation and did:peer:4
TelegramSam 5f45647
Updated Dates
TelegramSam 1f3f774
Merge branch 'main' into unqualified_did_ccu
swcurran File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Aries RFC 0793: Unqualified DID Transition | ||
|
|
||
| - Authors: [Sam Curren](mailto:[email protected]) | ||
| - Status: [PROPOSED](/README.md#proposed) | ||
| - Since: 2023-07-11 | ||
| - Status Note: In Pre-work **Target Completion Date: 2023.12.17** | ||
| - Supersedes: | ||
| - Start Date: 2023-07-11 | ||
| - Tags: [feature](/tags.md#feature), [community-update](/tags.md#community-update) | ||
|
|
||
| ## 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](../../concepts/0345-community-coordinated-update/README.md) 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](#implementations) accordingly. | ||
| - Target Date for code update: 2023-12-17 | ||
| - Target Date fpr deployment update: 2024-02- 28 | ||
| - **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](#implementations) accordingly. | ||
| - Target Date for finishing step 2: 2024-03-20 | ||
| - **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](/README.md#accepted). | ||
| - The [ACCEPTED](/README.md#accepted) version of this RFC is included in the current [Aries Interop Profile](/concepts/0302-aries-interop-profile/README.md) version. | ||
| - **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](/README.md#adopted). | ||
| - Agent builders indicate completion of Step 1 by updating the [Implementations](#implementations) section of this RFC. | ||
| - All other RFCs in this repo are updated to use the new message type format. | ||
| - The [ADOPTED](/README.md#adopted) version of this RFC is included in the current [Aries Interop Profile](/concepts/0302-aries-interop-profile/README.md) 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](/README.md#retired). | ||
| - Agent builders indicate completion of Step 2 by updating the [Implementations](#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](../../concepts/0345-community-coordinated-update/README.md) about | ||
| community-coordinated updates. | ||
|
|
||
| The specific sequence of events to make this particular transition is outlined in the [summary](#summary) section of this RFC. | ||
|
|
||
| ## Reference | ||
|
|
||
| See the [summary](#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](../../concepts/0345-community-coordinated-update/README.md) 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](https://github.com/hyperledger/aries-protocol-test-suite) | No steps completed | ||
| [Aries Framework - .NET](https://github.com/hyperledger/aries-framework-dotnet) | No steps completed | ||
| [Trinsic.id](https://trinsic.id/) | No steps completed | ||
| [Aries Cloud Agent - Python](https://github.com/hyperledger/aries-cloudagent-python) | No steps completed | ||
| [Aries Static Agent - Python](https://github.com/hyperledger/aries-staticagent-python) | No steps completed | ||
| [Aries Framework - Go](https://github.com/hyperledger/aries-framework-go) | No steps completed | ||
| [Connect.Me](https://www.evernym.com/blog/connect-me-sovrin-digital-wallet/) | No steps completed | ||
| [Verity](https://www.evernym.com/products/) | No steps completed | ||
| [Pico Labs](http://picolabs.io/) | No steps completed | ||
| [IBM](https://github.com/IBM-Blockchain-Identity/unknown) | No steps completed | ||
| IBM Agent | No steps completed | ||
| [Aries Cloud Agent - Pico](https://github.com/Picolab/aries-cloudagent-pico) | No steps completed | ||
| [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript) | No steps completed | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should reference both public and peer DIDs, since there are examples of both in Aries. Unqualified public DIDs are (presumably) transitioned to be “did:sov” DIDs.