Address did:peer:2 spec changes
Opened this issue · 8 comments
The goal of this ticket is just to track the adoption of the community for the specs change.
There are some spec changes for did:peer:2...
that are breaking changes for DID Comm.
In order to achieve interoperability. It's important to fix libraries that implement did:peer:2
and update all applications that depend on those libraries.
- ✅ did:peer method spec website - #65
- ✅ lib - app.fmgp/did-method-peer - FabioPinheiro/scala-did#162
- ✅ app - Scala-did Live Demo
- ✅ tool - GitHub action to send DID Comm message
- ✅ app - Atala Mediator - hyperledger/identus-mediator#158
- ✅ lib - sicpa-dlab/peer-did-jvm - sicpa-dlab/peer-did-jvm#37 and sicpa-dlab/peer-did-jvm#44 @mineme0110
- app - DIDComm Browser Demo - decentralized-identity/didcomm-demo#63 and decentralized-identity/didcomm-demo#2
- lib - Blocktrust PeerDID - (TODO open issue)
- app - Blocktrust Identity Wallet - (TODO open issue)
- lib - sicpa-dlab/didcomm-python - sicpa-dlab/didcomm-python#104
- lib - sicpa-dlab/peer-did-python - (TODO open issue)
- lib - evernym/pypeerdid - ?deprecated?
- lib - transmute-industries/did-peer.js - (TODO open issue)
- ✅ lib - decentralized-identity/did-peer-2 - ✅ It's already fixed by @dbluhm
- lib - beatt83/peerdid-swift - beatt83/peerdid-swift#1
- lib - decentralized-identity/did-resolver - (TODO open issue)
- docker - uni-resolver-driver-did-uport - (TODO open issue) - click here to see used lib
- sdk - input-output-hk/atala-prism-wallet-sdk-ts - hyperledger/identus-edge-agent-sdk-ts#126
- sdk - input-output-hk/atala-prism-wallet-sdk-kmm - hyperledger/identus-edge-agent-sdk-kmp#108
- sdk - input-output-hk/atala-prism-wallet-sdk-swift - hyperledger/identus-edge-agent-sdk-swift#105
- app - Indicio Mediator - [WIP] No link to issue
- lib - sicpa-dlab/didcomm-rust - sicpa-dlab/didcomm-rust#130
I'm pretty sure this list is far from being complete.
Feel free to add to this list. Also, help us contact the maintainers by creating tickets on the respective libraries.
Context
The changes were merged in this commit a5eca6b
Both issues have possible mitigation solutions that allow a smoother migration.
Although previous implementations are considered faulty! Since DID methods have no version.
Issue 1
The first is to fix the encoding to follow the DID Document.
The DID Document's service example in did:peer
looks like
"service":{
...
"serviceEndpoint": "https://example.com/endpoint",
"routingKeys": [...],
"accept": [...]
}
But it should instead look like
"service":{
...
"serviceEndpoint": {
"uri":"https://example.com/endpoint",
"routingKeys": [...],
"accept": [...]
}
}
We should make sure that our did:peer
used on the applications are encoded correctly.
when decrypting you look for that key
Issue 2
The second problem is about the id
of the keys (kid
).
It was unspecified before. So each library generates the kid
in its own way.
The major problem is that the kid
is used on the DID Comm message itself. More specifically the field skid
in the message's Protected Header is the kid
of the sender and the recipients.header.kid
is also the kid
recipient. When decrypting you look for that key.
So the agent encrypting and the agent decrypting MUST have the same or an equivalent resolver (the key id needs to be deterministic).
https://identity.foundation/peer-did-method-spec/
I was expecting the specs web pages to be updated by the GitHub job.
@dbluhm @swcurran do you know if the job failed or do we still need to do something?
https://identity.foundation/peer-did-method-spec/ I was expecting the specs web pages to be updated by the GitHub job. @dbluhm @swcurran do you know if the job failed or do we still need to do something?
It should have been updated... good catch, I'll investigate what went wrong!
Thanks for putting this issue together, by the way! This is excellent. We'll work on getting the didcomm-demo updated as well as the Indicio Mediator (no public repo to link to at the moment but feel free to add to your list). We will likely update those two projects in tandem.
For sicpa peer-did-jvm library
I have raised a PR which is an initiative to start the work required for the changes in PeerDID Spec
sicpa-dlab/peer-did-jvm#37
This PR doesn't handle all the PeerDID Spec changes required.
- lib - decentralized-identity/did-resolver - (TODO open issue)
- docker - uni-resolver-driver-did-uport - (TODO open issue) - click here to see used lib
- app - universal-resolver - (TODO open issue)
- lib - veramolabs/peer-did-resolver - (TODO open issue)
Looking at the list, there's a library under the uniresolver that is missing. The veramo labs depends on a library that handles the actual parsing of DIDs and here's a PR for the fixes aviarytech/did-peer#3
Thanks @frostyfrog. So now we can update the version of @aviarytech/did-peer@0.0.24
in veramolabs/peer-did-resolver
@FabioPinheiro @frostyfrog I bumped the versions of the libraries in the uniresolver chain of dependencies.
The last step is merging the changes in teh universal resolver repo:
decentralized-identity/universal-resolver#395
@FabioPinheiro @frostyfrog I bumped the versions of the libraries in the uniresolver chain of dependencies. The last step is merging the changes in teh universal resolver repo: decentralized-identity/universal-resolver#395
That is great. I'm seeing a lot of fix/PRs for this lately.
Let me try to update the list