Fix urlFromDid() logic to correctly handle path segments

interop-alliance · Sep 21, 2022 · 8268df2 · 8268df2
1 parent 7974c13
commit 8268df2
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 12 deletions.
diff --git a/src/DidWebResolver.js b/src/DidWebResolver.js
@@ -54,7 +54,11 @@ export function urlFromDid ({ did } = {}) {
   // const [didResource, query] = didUrl.split('?')
 
   // eslint-disable-next-line no-unused-vars
-  const [_did, _web, urlNoProtocol] = didUrl.split(':')
+  const [_did, _web, urlNoProtocol, ...pathFragments] = didUrl.split(':')
+
+  if (urlNoProtocol.includes('/')) {
+    throw new TypeError(`Cannot construct url from did: "${did}". domain-name cannot contain a path.`)
+  }
 
   let parsedUrl
   try {
@@ -65,11 +69,10 @@ export function urlFromDid ({ did } = {}) {
     throw new TypeError(`Cannot construct url from did: "${did}".`)
   }
 
-  if (!parsedUrl.pathname || parsedUrl.pathname === '/') {
+  if (pathFragments.length === 0) {
     parsedUrl.pathname = '/.well-known/did.json'
   } else {
-    const pathFragments = parsedUrl.pathname.split('/')
-    parsedUrl.pathname = pathFragments.map(decodeURIComponent).join('/')
+    parsedUrl.pathname = pathFragments.map(decodeURIComponent).join('/') + '/did.json'
   }
 
   if (hashFragment) {

diff --git a/test/unit/DidWebResolver.spec.js b/test/unit/DidWebResolver.spec.js
@@ -112,6 +112,30 @@ describe('DidWebDriver', () => {
         .to.equal('DID Method not supported: "did:example:1234".')
     })
 
+    it('should error on pattern did:web:domain/path/subpath', () => {
+      const invalidDids = [
+        'did:web:example.com/path',
+        'did:web:example.com/path/subpath',
+        'did:web:example.com/path/subpath?query=string',
+        'did:web:example.com/path/subpath#fragment',
+        'did:web:example.com/:user:alice'
+      ]
+      invalidDids.forEach((did) => {
+        let error
+        try {
+          urlFromDid({ did })
+        } catch (e) {
+          error = e
+        }
+        if (error) {
+          expect(error.message)
+            .to.contain('domain-name cannot contain a path.')
+        } else {
+          expect.fail('should have thrown error for did: ' + did)
+        }
+      })
+    })
+
     it('should convert first id fragment to pathname plus default path', () => {
       expect(urlFromDid({ did: 'did:web:example.com' }))
         .to.equal('https://example.com/.well-known/did.json')
@@ -122,19 +146,31 @@ describe('DidWebDriver', () => {
         .to.equal('https://localhost:8080/.well-known/did.json')
     })
 
-    it('should url-decode path fragments', () => {
-      expect(urlFromDid({ did: 'did:web:example.com/path/some%2Bsubpath' }))
-        .to.equal('https://example.com/path/some+subpath')
-    })
-
     it('should preserve hash fragments for dids without paths', () => {
       const url = urlFromDid({ did: 'did:web:localhost%3A8080#keyId' })
       expect(url).to.equal('https://localhost:8080/.well-known/did.json#keyId')
     })
 
-    it('should preserve hash fragments for dids with paths', () => {
-      const url = urlFromDid({ did: 'did:web:example.com/path/some%2Bsubpath#keyId' })
-      expect(url).to.equal('https://example.com/path/some+subpath#keyId')
+    // See: https://w3c-ccg.github.io/did-method-web/#example-creating-the-did-with-optional-path
+    it('should work with optional path', () => {
+      const url = urlFromDid({ did: 'did:web:w3c-ccg.github.io:user:alice' })
+      expect(url).to.equal('https://w3c-ccg.github.io/user/alice/did.json')
+    })
+
+    // See: https://w3c-ccg.github.io/did-method-web/#example-creating-the-did-with-optional-path-and-port
+    it('should work with optional path and port', () => {
+      const url = urlFromDid({ did: 'did:web:example.com%3A3000:user:alice' })
+      expect(url).to.equal('https://example.com:3000/user/alice/did.json')
+    })
+
+    it('should preserve hash fragments for dids with optional path', () => {
+      const url = urlFromDid({ did: 'did:web:w3c-ccg.github.io:user:alice#keyId' })
+      expect(url).to.equal('https://w3c-ccg.github.io/user/alice/did.json#keyId')
+    })
+
+    it('should preserve hash fragments for dids with optional path and port', () => {
+      const url = urlFromDid({ did: 'did:web:example.com%3A3000:user:alice#keyId' })
+      expect(url).to.equal('https://example.com:3000/user/alice/did.json#keyId')
     })
   })