Conform to did:peer:2 spec #3
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
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
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 |
|---|---|---|
|
|
@@ -44,7 +44,7 @@ export const encodeService = (service: IDIDDocumentServiceDescriptor): string => | |
| return `.${Numalgo2Prefixes.Service}${base64url.encode(encoded)}` | ||
| } | ||
|
|
||
| export const decodeService = (did: string, service: string, metadata: Record<string, any>): IDIDDocumentServiceDescriptor => { | ||
| const val = JSON.parse(utf8.decode(base64url.decode(service))) | ||
| if (val.s) { | ||
| val['serviceEndpoint'] = val.s; | ||
|
|
@@ -73,27 +73,38 @@ export const decodeService = (did: string, service: string, index: number): IDID | |
| if (val.t) { | ||
| if (val.t === 'dm') { | ||
| val.type = 'DIDCommMessaging' | ||
| } else { | ||
| val.type = val.t; | ||
| } | ||
| delete val['t'] | ||
| } | ||
| if (!val.id) { | ||
| if (metadata.index == 0) { | ||
TheTechmage marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| val.id = `#service`; | ||
| } else { | ||
| val.id = `#service-${metadata.index}`; | ||
| } | ||
| metadata.index++; | ||
| } | ||
| return val; | ||
| } | ||
|
|
||
| export const isPeerDID = (did: string) => { | ||
| return new RegExp('^did:peer:(([01](z)([1-9a-km-zA-HJ-NP-Z]*))|(2((\.[AEVID](z)([1-9a-km-zA-HJ-NP-Z]*))+(\.(S)[0-9a-zA-Z=]*)*)))$').test(did) | ||
| } | ||
|
|
||
| export const createDIDDocument = ( | ||
| did: string, | ||
| authKeys: IDIDDocumentVerificationMethod[], | ||
| encKeys: IDIDDocumentVerificationMethod[], | ||
| services: IDIDDocumentServiceDescriptor[], | ||
TheTechmage marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ) => { | ||
| let contexts = ["https://www.w3.org/ns/did/v1", "https://w3id.org/security/multikey/v1"] | ||
| const prefix = "did:peer:"; | ||
| const didPeerNumalgo = parseInt(did.slice(prefix.length, prefix.length+1)) | ||
| if (didPeerNumalgo < 2) { | ||
| contexts = ["https://www.w3.org/ns/did/v1", "https://w3id.org/security/suites/ed25519-2020/v1"] | ||
| } | ||
| const auth = authKeys.map(k => k.id); | ||
| const enc = encKeys.map(k => k.id); | ||
| const ver = [...authKeys, ...encKeys].map(k => ({ | ||
|
|
@@ -106,16 +117,20 @@ export const createDIDDocument = ( | |
| "id": did, | ||
| assertionMethod: auth, | ||
| authentication: auth, | ||
| verificationMethod: ver, | ||
| } | ||
| if (didPeerNumalgo < 2) { | ||
|
There was a problem hiding this comment. did:peer:2 doesn't have There was a problem hiding this comment. did:peer:2 does support expressing It is because of limitations like these that we're moving to did:peer:4 which can express any DID Document without limitations. There was a problem hiding this comment. I'm not sure what needs to be done here as Delegation and Invocation are foreign diddoc concepts to me. All of my recent work has revolved around |
||
| doc["capabilityDelegation"] = auth | ||
| doc["capabilityInvocation"] = auth | ||
| } | ||
| if (enc.length > 0) { | ||
| doc['keyAgreement'] = enc; | ||
| if (didPeerNumalgo < 2) { | ||
| contexts.push("https://w3id.org/security/suites/x25519-2020/v1"); | ||
| } | ||
| } | ||
| if (services.length > 0) { | ||
| doc['service'] = services | ||
| } | ||
| return {"@context": contexts, ...doc}; | ||
| } | ||
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 |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| { | ||
| "did": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ.SeyJpZCI6ImEtdmVyeS11bmlxdWUtc2VydmljZSIsInQiOiJkbSIsInMiOiJodHRwczovL2V4YW1wbGUuY29tL2VuZHBvaW50MiIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkxIl0sImEiOlsiZGlkY29tbS92MiIsImRpZGNvbW0vYWlwMjtlbnY9cmZjNTg3Il19.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDMiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ" | ||
| } |
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 |
|---|---|---|
| @@ -1,46 +1,53 @@ | ||
| { | ||
| "@context": [ | ||
| "https://www.w3.org/ns/did/v1", | ||
| "https://w3id.org/security/multikey/v1" | ||
| ], | ||
| "id": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ.SeyJpZCI6ImEtdmVyeS11bmlxdWUtc2VydmljZSIsInQiOiJkbSIsInMiOiJodHRwczovL2V4YW1wbGUuY29tL2VuZHBvaW50MiIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkxIl0sImEiOlsiZGlkY29tbS92MiIsImRpZGNvbW0vYWlwMjtlbnY9cmZjNTg3Il19.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDMiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ", | ||
| "verificationMethod": [ | ||
| { | ||
| "id": "#key-1", | ||
| "type": "Multikey", | ||
| "controller": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ.SeyJpZCI6ImEtdmVyeS11bmlxdWUtc2VydmljZSIsInQiOiJkbSIsInMiOiJodHRwczovL2V4YW1wbGUuY29tL2VuZHBvaW50MiIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkxIl0sImEiOlsiZGlkY29tbS92MiIsImRpZGNvbW0vYWlwMjtlbnY9cmZjNTg3Il19.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDMiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ", | ||
| "publicKeyMultibase": "z6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud" | ||
| }, | ||
| { | ||
| "id": "#key-2", | ||
| "type": "Multikey", | ||
| "controller": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ.SeyJpZCI6ImEtdmVyeS11bmlxdWUtc2VydmljZSIsInQiOiJkbSIsInMiOiJodHRwczovL2V4YW1wbGUuY29tL2VuZHBvaW50MiIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkxIl0sImEiOlsiZGlkY29tbS92MiIsImRpZGNvbW0vYWlwMjtlbnY9cmZjNTg3Il19.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDMiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ", | ||
| "publicKeyMultibase": "z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V" | ||
| } | ||
| ], | ||
| "authentication": [ | ||
| "#key-2" | ||
| ], | ||
| "assertionMethod": [ | ||
| "#key-2" | ||
| ], | ||
| "keyAgreement": [ | ||
| "#key-1" | ||
| ], | ||
| "service": [ | ||
| { | ||
| "id": "#service", | ||
| "type": "DIDCommMessaging", | ||
| "serviceEndpoint": "https://example.com/endpoint1", | ||
| "routingKeys": ["did:example:somemediator#somekey1"], | ||
| "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"] | ||
| }, | ||
| { | ||
| "id": "a-very-unique-service", | ||
TheTechmage marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "type": "DIDCommMessaging", | ||
| "serviceEndpoint": "https://example.com/endpoint2", | ||
| "routingKeys": ["did:example:somemediator#somekey1"], | ||
| "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"] | ||
| }, | ||
| { | ||
| "id": "#service-1", | ||
| "type": "DIDCommMessaging", | ||
| "serviceEndpoint": "https://example.com/endpoint3", | ||
| "routingKeys": ["did:example:somemediator#somekey1"], | ||
| "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"] | ||
| } | ||
| ] | ||
| } | ||
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
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
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
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.
I prefer absolute URIs over relative. I know the spec uses relative and these get quite ugly but I don't think it will matter at an interoperability level unless I'm missing something
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.
I believe you're correct; whether the URLs are "expanded" or left as relative should not significantly impact interop as either should be considered acceptable. Using absolute URIs here I think is fair. @frostyfrog
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.
Alternatively I'd be ok with using relative and putting an
"@base": "did:peer:2z123najb..."in the@contextwhich will effectively do the same thingThere 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.
I like the idea of using
@baseas it allows the document to be a bit cleaner when a Human is reading it. I have added it to the context property according to the pattern demonstrated in example 150 in the JSON-LD docs.