├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Authors 2 | 3 | - [Oliver Terbu](https://github.com/awoie) ([ConsenSys MESH](https://mesh.xyz)) 4 | 5 | # Status 6 | 7 | **Version**: 0.1.1 8 | 9 | :warning: This specification is still work in progress and the specification is subject to change. Don't use this for production use case cases. :warning: 10 | 11 | # DID ENS Specification 12 | 13 | The Ethereum Name Service (ENS) is a distributed, open, and extensible naming system based on the Ethereum blockchain. 14 | ENS’s job is to map human-readable names like ’some.eth’ to machine-readable identifiers such as Ethereum addresses, other cryptocurrency addresses, content hashes, and metadata. 15 | 16 | ENS has similar goals to DNS, the Internet’s Domain Name Service, but has significantly different architecture due to the capabilities and constraints provided by the Ethereum blockchain. Like DNS, ENS operates on a system of dot-separated hierarchical names called domains, with the owner of a domain having full control over subdomains. 17 | 18 | Top-level domains, like ‘.eth’ and ‘.test’, are owned by smart contracts called registrars, which specify rules governing the allocation of their subdomains. Anyone may, by following the rules imposed by these registrar contracts, obtain ownership of a domain for their own use. ENS also supports importing in DNS names already owned by the user for use on ENS. 19 | 20 | Because of the hierarchal nature of ENS, anyone who owns a domain at any level may configure subdomains - for themselves or others - as desired. For instance, if Some owns 'some.eth', she can create 'pay.some.eth' and configure it as she wishes. 21 | 22 | ENS is deployed on the Ethereum main network and on several test networks. 23 | 24 | The Ethereum community has established ENS names as their identifiers (see [Etherscan](https://etherscan.io/enslookup)) for web3 projects. This DID method specification has two purposes: 25 | 1. to wrap existing ENS names as DIDs to be interoperable with applications relying on Decentralized Identifiers 26 | 2. to define a canonical way to augment ENS names with DID capabilities such as services and verification methods. 27 | 28 | ## DID Method Name 29 | 30 | The name string that shall identify this DID method is: ens. 31 | 32 | A DID that uses this method MUST begin with the following prefix: did:ens. Per the DID specification, this string MUST be in lowercase. The remainder of the DID, after the prefix, is specified below. 33 | 34 | ## Method Specific Identifier 35 | 36 | ENS DIDs have the following format: 37 | 38 | ``` 39 | DID := did:ens[:]: 40 | network := mainnet | rinkeby | ropsten | goerli | ... 41 | name := 42 | ``` 43 | 44 | If the network is omitted, the network defaults to mainnet, so a `did:ens:some.eth` is equivalent to `did:ens:mainnet:some.eth`. However, the canonical form is `did:ens:mainnet:some.eth`. 45 | 46 | > :warning: Issue [#2](https://github.com/veramolabs/did-ens-spec/issues/2): should we consider did:pkh as the canonical id? 47 | 48 | ENS names are first normalized, using a process called UTS-46 normalization. This ensures that upper- and lower-case names are treated equivalently, and that invalid characters are prohibited. 49 | 50 | ### Examples 51 | 52 | ``` 53 | - did:ens:some.eth 54 | - did:ens:my.some.eth 55 | - ... 56 | ``` 57 | 58 | ## CRUD Operations 59 | 60 | ENS names can have TEXT records. This specification defines TEXT record names that will have an impact on DID resolution of ENS DIDs. 61 | 62 | The following named TEXT records are defined: 63 | 64 | - `org.w3c.did.service` 65 | 66 | OPTIONAL. A set of [services](https://www.w3.org/TR/did-core/#services) as per W3C DID Core specification. The service `id` property MAY be omitted. In that case the DID resolver will generate a canonical value for the specific service entry. 67 | 68 | > NOTE: the ENS Service will be automatically propagated as a service during DID resolution. 69 | 70 | - `org.w3c.did.verificationMethod` 71 | 72 | OPTIONAL. A set of [verification methods](https://www.w3.org/TR/did-core/#verification-methods) as per W3C DID Core specification. Verification method `id` property values MUST be relative DID URIs, e.g., `#my-key-id-1234`. 73 | 74 | >NOTE: the owner of the ENS name will be automatically propagated as a verification method during DID resolution. 75 | 76 | - `org.w3c.did.verificationRelationship` 77 | 78 | OPTIONAL. A map of [verification relationship](https://www.w3.org/TR/did-core/#verification-relationships) as per W3C DID Core specification to a set of verification relationship identifiers (`id` property). 79 | 80 | >NOTE: the verification method that relates to the owner of the ENS name can be used for all verification relationships. 81 | 82 | ### CREATE 83 | 84 | See [ENS](https://docs.ens.domains/dapp-developer-guide) on how to register ENS names. 85 | 86 | > :warning: Issue [#4](https://github.com/veramolabs/did-ens-spec/issues/4): provide more details on ENS registration. 87 | 88 | ### READ 89 | 90 | DID resolution will perform ENS resolution for a given ENS name. Additionally, the DID resolver will then retrieve the DID specific TEXT records for the ENS name and add default values for service endpoints and verification methods. 91 | 92 | > :warning: Issue [#4](https://github.com/veramolabs/did-ens-spec/issues/4): provide more details on ENS resolution. 93 | 94 | The default verification method will always include the owner of the ENS name as follows: 95 | 96 | ```json 97 | { 98 | "id": "#", 99 | "type": "EcdsaSecp256k1RecoveryMethod2020", 100 | "controller": "", 101 | "blockchainAccountId": "" 102 | } 103 | ``` 104 | 105 | The `id` of the default verification method is the concatenation of the ENS DID followed by the `#` and the hex representation of `sha256(blockchainAccountId)`. Additional verification methods that MAY be added MUST not use that verification method `id` and will be ignored in the DID Document. 106 | 107 | The default service will always include the ENS service as follows: 108 | 109 | ```json 110 | { 111 | "id":"#Web3PublicProfile-", 112 | "type": "Web3PublicProfile", 113 | "serviceEndpoint": { 114 | "profileService": "ENS", 115 | "ensName": "", 116 | "network": "mainnet" 117 | } 118 | } 119 | ``` 120 | 121 | The `id` of the default service is the concatenation of the ENS DID followed by the `#Web3PublicProfile-` and the hex representation of `sha256(blockchainAccountId)`. Additional services that MAY be added MUST not use that service `id` and will be ignored in the DID Document. 122 | 123 | If the DID specific TEXT records are malformed, the entire TEXT record will be ignored in the DID resolution process. 124 | 125 | See ENS on how to resolve ENS names and how to resolve TEXT records for ENS names. 126 | 127 | #### Example (no TEXT records) 128 | 129 | For `did:ens:some.eth` (with no TEXT records added), the DID Document would look as follows: 130 | 131 | ```json 132 | { 133 | "@context": [ 134 | "https://www.w3.org/ns/did/v1", 135 | "https://w3id.org/ens/v1", 136 | "https://w3id.org/casa/profile-services/v1" 137 | ], 138 | "id": "did:ens:some.eth", 139 | "canonicalId": "did:ens:mainnet:some.eth", 140 | "verificationMethod": [{ 141 | "id": "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7", 142 | "type": "EcdsaSecp256k1RecoveryMethod2020", 143 | "controller": "did:ens:mainnet:some.eth", 144 | "blockchainAccountId": "eip155:1:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb" 145 | }], 146 | "service": [{ 147 | "id":"did:ens:mainnet:some.eth#Web3PublicProfile-5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7", 148 | "type": "Web3PublicProfile", 149 | "serviceEndpoint": { 150 | "profileService": "ENS", 151 | "ensName": "some.eth", 152 | "network": "mainnet" 153 | } 154 | }], 155 | "authentication": [ 156 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 157 | ], 158 | "assertionMethod": [ 159 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 160 | ], 161 | "capabilityInvocation": [ 162 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 163 | ], 164 | "capabilityDelegation": [ 165 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 166 | ] 167 | } 168 | ``` 169 | 170 | #### Example (with keyAgreement) 171 | 172 | For `did:ens:some.eth` with DID specific TEXT records added, the DID Document would look as follows: 173 | 174 | ```json 175 | { 176 | "@context": [ 177 | "https://www.w3.org/ns/did/v1", 178 | "https://w3id.org/ens/v1", 179 | "https://w3id.org/casa/profile-services/v1" 180 | ], 181 | "id": "did:ens:some.eth", 182 | "canonicalId": "did:ens:mainnet:some.eth", 183 | "verificationMethod": [{ 184 | "id": "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7", 185 | "type": "EcdsaSecp256k1RecoveryMethod2020", 186 | "controller": "did:ens:mainnet:some.eth", 187 | "blockchainAccountId": "eip155:1:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb" 188 | }, 189 | { 190 | "id": "did:ens:mainnet:some.eth#zC9ByQ8aJs8vrNXyDhPHHNNMSHPcaSgNpjjsBYpMMjsTdS", 191 | "type": "X25519KeyAgreementKey2019", 192 | "controller": "did:ens:mainnet:some.eth", 193 | "publicKeyMultibase": "z9hFgmPVfmBZwRvFEyniQDBkz9LmV7gDEqytWyGZLmDXE" 194 | } 195 | ], 196 | "service": [{ 197 | "id":"did:ens:mainnet:some.eth#Web3PublicProfile-5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7", 198 | "type": "Web3PublicProfile", 199 | "serviceEndpoint": { 200 | "profileService": "ENS", 201 | "ensName": "some.eth", 202 | "network": "mainnet" 203 | } 204 | }], 205 | "authentication": [ 206 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 207 | ], 208 | "assertionMethod": [ 209 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 210 | ], 211 | "capabilityInvocation": [ 212 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 213 | ], 214 | "capabilityDelegation": [ 215 | "did:ens:mainnet:some.eth#5d3e82eaba0bf8991c38bd092fa5f5523b5b3bf13e06b4b29c0022a094a528d7" 216 | ], 217 | "keyAgreement": [ 218 | "did:ens:mainnet:some.eth#zC9ByQ8aJs8vrNXyDhPHHNNMSHPcaSgNpjjsBYpMMjsTdS" 219 | ] 220 | } 221 | ``` 222 | 223 | The following TEXT records have to be set: 224 | 225 | - `org.w3c.did.verificationRelationship` 226 | - `org.w3c.did:verificationMethod` 227 | 228 | > :warning: Issue [#3](https://github.com/veramolabs/did-ens-spec/issues/3): More details on TEXT records and more examples for other service endpoints and authentication relationships. 229 | 230 | ### UPDATE 231 | 232 | See [ENS](https://docs.ens.domains/dapp-developer-guide) on how to add TEXT records. 233 | 234 | > :warning: Issue [#4](https://github.com/veramolabs/did-ens-spec/issues/4): provide more details on ENS TEXT records. 235 | 236 | ### DELETE 237 | 238 | See [ENS](https://docs.ens.domains/dapp-developer-guide) on how to delete ENS names or end the lease. 239 | 240 | > :warning: Issue [#4](https://github.com/veramolabs/did-ens-spec/issues/4): provide more details on how the lease ends or ownership is transferred. 241 | 242 | ## Privacy Considerations 243 | 244 | See [ENS](https://docs.ens.domains/dapp-developer-guide). 245 | 246 | When any data (e.g. W3C Verifiable Credentials) is associated with ENS DIDs, sharing that data would also impose sharing the onchain data graph (e.g. transaction history, NFTs etc.) of the ETH account that owns the ENS name. 247 | 248 | Using personal identifiable information as DID Method specific identifiers (e.g. alice.eth) discloses personal information every time the DID is shared with a counter party. This specification DOES NOT endorse the use of ENS names that correlate directly with real world human beings. 249 | 250 | > NOTE: The Ethereum community is already using ENS names for individuals (e.g. vitalik.eth). 251 | 252 | ## Security Considerations 253 | 254 | See [ENS](https://docs.ens.domains/dapp-developer-guide). 255 | 256 | ENS names are non-fungible and transferrable. When the owner of the ENS name changes, the authorative keys will also change. This needs to be considered when used in conjunction with verifiable data where the DID is embedded, e.g., W3C Verifiable Credentials. 257 | 258 | > :warning: Issue [#1](https://github.com/veramolabs/did-ens-spec/issues/1): potentially addresses the above issue. 259 | --------------------------------------------------------------------------------