Move handle resolution to .well-known #1048

dholms · 2023-05-16T02:04:43Z

This moves handle resolution to .well-known

Specifically, a handle is resolved by calling GET http(s)://${handle}/.well-known/atproto-did

The expected response is text/plain and simply contains the associated DID

Closes #969

bnewbold · 2023-05-16T02:23:21Z

It feels to me like this is generic to DIDs in general, not just atproto, and we could represent that in the path name. Eg, /.well-known/did/${handle} or /.well-known/handle-did/${handle}.

Is it a requirement that the handle in the hostname match the handle in the path?

bnewbold · 2023-05-16T02:25:37Z

I actually really like the sub-directory thing, makes it quite easy to do virtual hosting with a bunch of domains and DIDs using something like nginx

dholms · 2023-05-16T02:26:41Z

While it is generic to dids, I think it's useful for different ecosystems to be able to differentiate the dids/handles associated with each.

For instance, with the DNS records we do
TXT. _atproto.${handle} "did=did:...."

Is it a requirement that the handle in the hostname match the handle in the path?

I don't have a super strong opinion on this. But I do think it's reasonable to be able to ask an authority what a subdomain resolves to. ie: asking bsky.social what dholms.bsky.social resolves to.

Though canonically, you're encouraged to ask the hostname that matches the handle

dholms · 2023-05-16T02:27:39Z

I was trying to match our DNS semantics with the pathing here. maybe .well-known/atproto-did/${handle}?

Evalprime · 2023-05-16T15:34:57Z

packages/identifier/tests/resolve.test.ts

@@ -48,12 +48,12 @@ describe('handle resolution', () => {
  })

  it('handles a bad DNS resolution', async () => {
-    await expect(resolveDns('bad.test')).rejects.toThrow(NoHandleRecordError)
+    const did = resolveDns('bad.test')


should this be an await statement? it's failing tests

Evalprime

line 51 in the resolve test needs an await statement

Evalprime · 2023-05-16T15:48:59Z

take a look at https://github.com/protocol-registries/well-known-uris, it's not required obviously but does add some security to the path

dholms · 2023-05-16T17:04:32Z

Yeah I think we'll need to wait until we have an actual spec before we can register there

Evalprime · 2023-05-16T17:18:33Z

is the spec documented and will the lexicon work with the site?

devinivy · 2023-05-16T19:42:13Z

packages/identifier/src/resolve.ts

+  const dnsRes = await dnsPromise
+  if (dnsRes) {
+    httpAbort.abort()
+    return dnsRes
+  }
+  return httpPromise


pfrazee

Yep I'm good with this

pfrazee · 2023-05-17T00:36:26Z

lexicons/com/atproto/identity/resolveHandle.json

@@ -7,6 +7,7 @@
      "description": "Provides the DID of a repo.",
      "parameters": {
        "type": "params",
+        "required": ["handle"],
        "properties": {
          "handle": {


should probs drop the "if not specified" bit of the description (at least it was still in the comment)

pfrazee

Yep I'm good with this

packages/identity/src/handle/index.ts

devinivy · 2023-05-18T20:39:15Z

packages/pds/Dockerfile

-COPY ./packages/did-resolver ./packages/did-resolver
 COPY ./packages/identifier ./packages/identifier
+COPY ./packages/identity ./packages/identity


Thanks for remembering this 👍

devinivy · 2023-05-18T20:41:56Z

packages/dev-env/src/util.ts

+
+    const url = `${pds.url}/.well-known/atproto-did`
+    try {
+      const res = await fetch(url, { headers: { host: handle } })


devinivy

Good stuff!

Co-authored-by: devin ivy <devinivy@gmail.com>

AaronGoldman · 2023-05-20T05:29:42Z

For some reason I was expecting

https://${handle}/.well-known/_atproto -> did=${did}

To match the DNS form as closely as possible 🤷‍♂️

devinivy · 2023-05-25T04:22:56Z

packages/identity/src/handle/index.ts

+      const data = await res.json()
+      return data.did


This is going away soon so I don't think it's a biggie, but we might want to ensure that the result here is a string (if not a valid did).

yeah that's a good point 👍

* move handle resolution to .well-known * required handle on resolveHandle * rm test * tidy * tidy * fix up appview * missing await * atproto-handle -> atproto-did * shift did & handle resolution to new identity package * fix up network mocks * fix up another test * one more * drop lex comment * rm handle param * Update packages/identity/src/handle/index.ts Co-authored-by: devin ivy <devinivy@gmail.com> * still temporarily support xrpc handle resolution * typo * ensure return value is a string --------- Co-authored-by: devin ivy <devinivy@gmail.com>

zfaizal2 · 2023-10-03T21:13:39Z

Curious, how are you configuring your domains to support wildcard subdomains (ex. foobar.bsky.social/.well-known/atproto-did)

* move handle resolution to .well-known * required handle on resolveHandle * rm test * tidy * tidy * fix up appview * missing await * atproto-handle -> atproto-did * shift did & handle resolution to new identity package * fix up network mocks * fix up another test * one more * drop lex comment * rm handle param * Update packages/identity/src/handle/index.ts Co-authored-by: devin ivy <devinivy@gmail.com> * still temporarily support xrpc handle resolution * typo * ensure return value is a string --------- Co-authored-by: devin ivy <devinivy@gmail.com>

dholms added 3 commits May 15, 2023 20:54

move handle resolution to .well-known

fa391ff

required handle on resolveHandle

db18e1a

rm test

c0786af

dholms added 3 commits May 15, 2023 21:28

tidy

2e55de3

tidy

4fcba80

fix up appview

d33b4fc

Evalprime reviewed May 16, 2023

View reviewed changes

dholms added 2 commits May 16, 2023 11:57

missing await

f5cb29f

atproto-handle -> atproto-did

459156c

devinivy reviewed May 16, 2023

View reviewed changes

shift did & handle resolution to new identity package

4c210a3

dholms mentioned this pull request May 16, 2023

Combine did & handle resolution in new @atproto/identity package #1054

Merged

dholms added 3 commits May 16, 2023 18:37

fix up network mocks

96c5bda

fix up another test

b681b2d

one more

54d32ed

dholms marked this pull request as ready for review May 17, 2023 00:01

pfrazee approved these changes May 17, 2023

View reviewed changes

dholms added 2 commits May 16, 2023 19:40

drop lex comment

d1cd8ee

rm handle param

eef1ca3

devinivy reviewed May 18, 2023

View reviewed changes

packages/identity/src/handle/index.ts Outdated Show resolved Hide resolved

devinivy reviewed May 18, 2023

View reviewed changes

devinivy approved these changes May 18, 2023

View reviewed changes

Update packages/identity/src/handle/index.ts

25fbc2f

Co-authored-by: devin ivy <devinivy@gmail.com>

dholms added 2 commits May 24, 2023 17:05

still temporarily support xrpc handle resolution

e502559

typo

332a5a1

devinivy reviewed May 25, 2023

View reviewed changes

devinivy approved these changes May 25, 2023

View reviewed changes

dholms added 2 commits May 25, 2023 10:24

ensure return value is a string

c8eec7a

merge main

5438222

dholms merged commit 743eaf1 into main May 26, 2023

dholms deleted the well-known-handles branch May 26, 2023 00:04

emilyliu7321 mentioned this pull request May 26, 2023

Update com.atproto.identity.resolveHandle lexicon bluesky-social/atproto-website#96

Merged

yamarten mentioned this pull request May 31, 2024

Incorrect explanation based on old handle specifications bluesky-social/atproto-website#315

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move handle resolution to .well-known #1048

Move handle resolution to .well-known #1048

dholms commented May 16, 2023 •

edited

Loading

bnewbold commented May 16, 2023

bnewbold commented May 16, 2023

dholms commented May 16, 2023

dholms commented May 16, 2023

Evalprime May 16, 2023

dholms May 16, 2023

Evalprime left a comment

Evalprime commented May 16, 2023

dholms commented May 16, 2023

Evalprime commented May 16, 2023

devinivy May 16, 2023

pfrazee left a comment

pfrazee May 17, 2023

pfrazee left a comment

devinivy May 18, 2023

devinivy May 18, 2023

devinivy left a comment

AaronGoldman commented May 20, 2023

devinivy May 25, 2023

dholms May 25, 2023

zfaizal2 commented Oct 3, 2023

Move handle resolution to .well-known #1048

Move handle resolution to .well-known #1048

Conversation

dholms commented May 16, 2023 • edited Loading

bnewbold commented May 16, 2023

bnewbold commented May 16, 2023

dholms commented May 16, 2023

dholms commented May 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Evalprime left a comment

Choose a reason for hiding this comment

Evalprime commented May 16, 2023

dholms commented May 16, 2023

Evalprime commented May 16, 2023

Choose a reason for hiding this comment

pfrazee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pfrazee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devinivy left a comment

Choose a reason for hiding this comment

AaronGoldman commented May 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zfaizal2 commented Oct 3, 2023

dholms commented May 16, 2023 •

edited

Loading