@atproto-labs/handle-resolver-node 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @atproto-labs/handle-resolver-node
+
+## 0.0.1
+
+### Patch Changes
+
+- [`e134c79a0`](https://github.com/bluesky-social/atproto/commit/e134c79a0ffb000b2cb36437815673fa6bda664b) Thanks [@devinivy](https://github.com/devinivy)! - Initial publish of experimental oauth packages to @atproto-labs
+
+- Updated dependencies [[`e134c79a0`](https://github.com/bluesky-social/atproto/commit/e134c79a0ffb000b2cb36437815673fa6bda664b)]:
+  - @atproto-labs/handle-resolver@0.0.1
+  - @atproto-labs/fetch-node@0.0.1
+  - @atproto-labs/fetch@0.0.1
+  - @atproto-labs/did@0.0.1

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Dual MIT/Apache-2.0 License
+
+Copyright (c) 2022-2024 Bluesky PBC, and Contributors
+
+Except as otherwise noted in individual files, this software is licensed under the MIT license (<http://opensource.org/licenses/MIT>), or the Apache License, Version 2.0 (<http://www.apache.org/licenses/LICENSE-2.0>).
+
+Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.

package/dist/dns-handle-resolver.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { resolveTxt } from 'node:dns/promises';
+import { HandleResolveOptions, HandleResolver, ResolvedHandle } from '@atproto-labs/handle-resolver';
+export type DnsHandleResolverOptions = {
+    /**
+     * Nameservers to use in place of the system's default nameservers.
+     */
+    nameservers?: string[];
+};
+export declare class DnsHandleResolver implements HandleResolver {
+    protected resolveTxt: typeof resolveTxt;
+    constructor(options?: DnsHandleResolverOptions);
+    resolve(handle: string, _options?: HandleResolveOptions): Promise<ResolvedHandle>;
+}
+//# sourceMappingURL=dns-handle-resolver.d.ts.map

package/dist/dns-handle-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dns-handle-resolver.d.ts","sourceRoot":"","sources":["../src/dns-handle-resolver.ts"],"names":[],"mappings":";AAAA,OAAO,EAAoB,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEhE,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,cAAc,EAEf,MAAM,+BAA+B,CAAA;AAKtC,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA;AAED,qBAAa,iBAAkB,YAAW,cAAc;IACtD,SAAS,CAAC,UAAU,EAAE,OAAO,UAAU,CAAA;gBAE3B,OAAO,CAAC,EAAE,wBAAwB;IAMjC,OAAO,CAClB,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,cAAc,CAAC;CAO3B"}

package/dist/dns-handle-resolver.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DnsHandleResolver = void 0;
+const promises_1 = require("node:dns/promises");
+const handle_resolver_1 = require("@atproto-labs/handle-resolver");
+const SUBDOMAIN = '_atproto';
+const PREFIX = 'did=';
+class DnsHandleResolver {
+    constructor(options) {
+        Object.defineProperty(this, "resolveTxt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.resolveTxt = options?.nameservers
+            ? buildResolveTxt(options.nameservers)
+            : promises_1.resolveTxt.bind(null);
+    }
+    async resolve(handle, _options) {
+        try {
+            return parseDnsResult(await this.resolveTxt(`${SUBDOMAIN}.${handle}`));
+        }
+        catch (err) {
+            return null;
+        }
+    }
+}
+exports.DnsHandleResolver = DnsHandleResolver;
+function buildResolveTxt(nameservers) {
+    // Build the resolver asynchronously
+    const resolverPromise = Promise.allSettled(nameservers.map((h) => (0, promises_1.lookup)(h)))
+        .then((responses) => responses.flatMap((r) => r.status === 'fulfilled' ? [r.value.address] : []))
+        .then((backupIps) => {
+        if (!backupIps.length)
+            return null;
+        const resolver = new promises_1.Resolver();
+        resolver.setServers(backupIps);
+        return resolver;
+    });
+    resolverPromise.catch(() => {
+        // Should never happen
+    });
+    return async (hostname) => {
+        const resolver = await resolverPromise;
+        return resolver ? resolver.resolveTxt(hostname) : [];
+    };
+}
+function parseDnsResult(chunkedResults) {
+    const results = chunkedResults.map((chunks) => chunks.join(''));
+    const found = results.filter((i) => i.startsWith(PREFIX));
+    if (found.length !== 1) {
+        return null;
+    }
+    const did = found[0].slice(PREFIX.length);
+    return (0, handle_resolver_1.isResolvedHandle)(did) ? did : null;
+}
+//# sourceMappingURL=dns-handle-resolver.js.map

package/dist/dns-handle-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dns-handle-resolver.js","sourceRoot":"","sources":["../src/dns-handle-resolver.ts"],"names":[],"mappings":";;;AAAA,gDAAgE;AAEhE,mEAKsC;AAEtC,MAAM,SAAS,GAAG,UAAU,CAAA;AAC5B,MAAM,MAAM,GAAG,MAAM,CAAA;AASrB,MAAa,iBAAiB;IAG5B,YAAY,OAAkC;QAFpC;;;;;WAA6B;QAGrC,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,WAAW;YACpC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC;YACtC,CAAC,CAAC,qBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAEM,KAAK,CAAC,OAAO,CAClB,MAAc,EACd,QAA+B;QAE/B,IAAI,CAAC;YACH,OAAO,cAAc,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,CAAC,CAAC,CAAA;QACxE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF;AAnBD,8CAmBC;AAED,SAAS,eAAe,CAAC,WAAqB;IAC5C,oCAAoC;IACpC,MAAM,eAAe,GAA6B,OAAO,CAAC,UAAU,CAClE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAM,EAAC,CAAC,CAAC,CAAC,CAClC;SACE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAClB,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACtB,CAAC,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAClD,CACF;SACA,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,IAAI,CAAC,SAAS,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QAClC,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAA;QAC/B,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;QAC9B,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAC,CAAA;IAEJ,eAAe,CAAC,KAAK,CAAC,GAAG,EAAE;QACzB,sBAAsB;IACxB,CAAC,CAAC,CAAA;IAEF,OAAO,KAAK,EAAE,QAAQ,EAAE,EAAE;QACxB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAA;QACtC,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IACtD,CAAC,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CAAC,cAA0B;IAChD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;IAC/D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IACzD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACzC,OAAO,IAAA,kCAAgB,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;AAC3C,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './node-handle-resolver.js';
+export { NodeHandleResolver as default } from './node-handle-resolver.js';
+export * from './dns-handle-resolver.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,2BAA2B,CAAA;AACzC,OAAO,EAAE,kBAAkB,IAAI,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAGzE,cAAc,0BAA0B,CAAA"}

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+// Main export
+__exportStar(require("./node-handle-resolver.js"), exports);
+var node_handle_resolver_js_1 = require("./node-handle-resolver.js");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return node_handle_resolver_js_1.NodeHandleResolver; } });
+// Utilities
+__exportStar(require("./dns-handle-resolver.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,4DAAyC;AACzC,qEAAyE;AAAhE,kHAAA,kBAAkB,OAAW;AAEtC,YAAY;AACZ,2DAAwC"}

package/dist/node-handle-resolver.d.ts

@@ -0,0 +1,29 @@
+import { Fetch } from '@atproto-labs/fetch';
+import { SafeFetchWrapOptions } from '@atproto-labs/fetch-node';
+import { CachedHandleResolver, CachedHandleResolverOptions, HandleResolver } from '@atproto-labs/handle-resolver';
+import { DnsHandleResolverOptions } from './dns-handle-resolver.js';
+export type NodeHandleResolverOptions = {
+    /**
+     * List of domain names that are forbidden to be resolved using the
+     * well-known/atproto-did method.
+     */
+    wellKnownExclude?: SafeFetchWrapOptions['forbiddenDomainNames'];
+    /**
+     * List of backup nameservers to use for DNS resolution.
+     */
+    fallbackNameservers?: DnsHandleResolverOptions['nameservers'];
+    cache?: CachedHandleResolverOptions['cache'];
+    /**
+     * Fetch function to use for HTTP requests. Allows customizing the request
+     * behavior, e.g. adding headers, setting a timeout, mocking, etc. The
+     * provided fetch function will be wrapped with a safeFetchWrap function that
+     * adds SSRF protection.
+     *
+     * @default `globalThis.fetch`
+     */
+    fetch?: Fetch;
+};
+export declare class NodeHandleResolver extends CachedHandleResolver implements HandleResolver {
+    constructor({ cache, fetch, fallbackNameservers, wellKnownExclude, }?: NodeHandleResolverOptions);
+}
+//# sourceMappingURL=node-handle-resolver.d.ts.map

package/dist/node-handle-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-handle-resolver.d.ts","sourceRoot":"","sources":["../src/node-handle-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,oBAAoB,EAAiB,MAAM,0BAA0B,CAAA;AAC9E,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,cAAc,EAEf,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAEL,wBAAwB,EACzB,MAAM,0BAA0B,CAAA;AAEjC,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,CAAA;IAE/D;;OAEG;IACH,mBAAmB,CAAC,EAAE,wBAAwB,CAAC,aAAa,CAAC,CAAA;IAE7D,KAAK,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC,CAAA;IAE5C;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,qBAAa,kBACX,SAAQ,oBACR,YAAW,cAAc;gBAEb,EACV,KAAK,EACL,KAAwB,EACxB,mBAAmB,EACnB,gBAAgB,GACjB,GAAE,yBAA8B;CA+ClC"}

package/dist/node-handle-resolver.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeHandleResolver = void 0;
+const fetch_node_1 = require("@atproto-labs/fetch-node");
+const handle_resolver_1 = require("@atproto-labs/handle-resolver");
+const dns_handle_resolver_js_1 = require("./dns-handle-resolver.js");
+class NodeHandleResolver extends handle_resolver_1.CachedHandleResolver {
+    constructor({ cache, fetch = globalThis.fetch, fallbackNameservers, wellKnownExclude, } = {}) {
+        const safeFetch = (0, fetch_node_1.safeFetchWrap)({
+            fetch,
+            timeout: 3000, // 3 seconds
+            forbiddenDomainNames: wellKnownExclude,
+            ssrfProtection: true,
+            responseMaxSize: 10 * 1048, // DID are max 2048 characters, 10kb for safety
+        });
+        const httpResolver = new handle_resolver_1.WellKnownHandleResolver({
+            fetch: safeFetch,
+        });
+        const dnsResolver = new dns_handle_resolver_js_1.DnsHandleResolver();
+        const fallbackResolver = new dns_handle_resolver_js_1.DnsHandleResolver({
+            nameservers: fallbackNameservers,
+        });
+        super({
+            cache,
+            resolver: {
+                resolve: async (handle) => {
+                    const abortController = new AbortController();
+                    const dnsPromise = dnsResolver.resolve(handle);
+                    const httpPromise = httpResolver.resolve(handle, {
+                        signal: abortController.signal,
+                    });
+                    // Will be awaited later
+                    httpPromise.catch(() => { });
+                    const dnsRes = await dnsPromise;
+                    if (dnsRes) {
+                        abortController.abort();
+                        return dnsRes;
+                    }
+                    const res = await httpPromise;
+                    if (res)
+                        return res;
+                    return fallbackResolver.resolve(handle);
+                },
+            },
+        });
+    }
+}
+exports.NodeHandleResolver = NodeHandleResolver;
+//# sourceMappingURL=node-handle-resolver.js.map

package/dist/node-handle-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-handle-resolver.js","sourceRoot":"","sources":["../src/node-handle-resolver.ts"],"names":[],"mappings":";;;AACA,yDAA8E;AAC9E,mEAKsC;AAEtC,qEAGiC;AA2BjC,MAAa,kBACX,SAAQ,sCAAoB;IAG5B,YAAY,EACV,KAAK,EACL,KAAK,GAAG,UAAU,CAAC,KAAK,EACxB,mBAAmB,EACnB,gBAAgB,MACa,EAAE;QAC/B,MAAM,SAAS,GAAG,IAAA,0BAAa,EAAC;YAC9B,KAAK;YACL,OAAO,EAAE,IAAI,EAAE,YAAY;YAC3B,oBAAoB,EAAE,gBAAgB;YACtC,cAAc,EAAE,IAAI;YACpB,eAAe,EAAE,EAAE,GAAG,IAAI,EAAE,+CAA+C;SAC5E,CAAC,CAAA;QAEF,MAAM,YAAY,GAAG,IAAI,yCAAuB,CAAC;YAC/C,KAAK,EAAE,SAAS;SACjB,CAAC,CAAA;QAEF,MAAM,WAAW,GAAG,IAAI,0CAAiB,EAAE,CAAA;QAE3C,MAAM,gBAAgB,GAAG,IAAI,0CAAiB,CAAC;YAC7C,WAAW,EAAE,mBAAmB;SACjC,CAAC,CAAA;QAEF,KAAK,CAAC;YACJ,KAAK;YACL,QAAQ,EAAE;gBACR,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;oBACxB,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;oBAE7C,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;oBAC9C,MAAM,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE;wBAC/C,MAAM,EAAE,eAAe,CAAC,MAAM;qBAC/B,CAAC,CAAA;oBAEF,wBAAwB;oBACxB,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;oBAE3B,MAAM,MAAM,GAAG,MAAM,UAAU,CAAA;oBAC/B,IAAI,MAAM,EAAE,CAAC;wBACX,eAAe,CAAC,KAAK,EAAE,CAAA;wBACvB,OAAO,MAAM,CAAA;oBACf,CAAC;oBAED,MAAM,GAAG,GAAG,MAAM,WAAW,CAAA;oBAC7B,IAAI,GAAG;wBAAE,OAAO,GAAG,CAAA;oBAEnB,OAAO,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;gBACzC,CAAC;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF;AAxDD,gDAwDC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@atproto-labs/handle-resolver-node",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Node specific ATProto handle to DID resolver",
+  "keywords": [
+    "atproto",
+    "oauth",
+    "handle",
+    "identity",
+    "node"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/handle-resolver-node"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@atproto-labs/handle-resolver": "0.0.1",
+    "@atproto-labs/fetch": "0.0.1",
+    "@atproto-labs/fetch-node": "0.0.1",
+    "@atproto-labs/did": "0.0.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json"
+  }
+}

package/src/dns-handle-resolver.ts

@@ -0,0 +1,76 @@
+import { Resolver, lookup, resolveTxt } from 'node:dns/promises'
+
+import {
+  HandleResolveOptions,
+  HandleResolver,
+  ResolvedHandle,
+  isResolvedHandle,
+} from '@atproto-labs/handle-resolver'
+
+const SUBDOMAIN = '_atproto'
+const PREFIX = 'did='
+
+export type DnsHandleResolverOptions = {
+  /**
+   * Nameservers to use in place of the system's default nameservers.
+   */
+  nameservers?: string[]
+}
+
+export class DnsHandleResolver implements HandleResolver {
+  protected resolveTxt: typeof resolveTxt
+
+  constructor(options?: DnsHandleResolverOptions) {
+    this.resolveTxt = options?.nameservers
+      ? buildResolveTxt(options.nameservers)
+      : resolveTxt.bind(null)
+  }
+
+  public async resolve(
+    handle: string,
+    _options?: HandleResolveOptions,
+  ): Promise<ResolvedHandle> {
+    try {
+      return parseDnsResult(await this.resolveTxt(`${SUBDOMAIN}.${handle}`))
+    } catch (err) {
+      return null
+    }
+  }
+}
+
+function buildResolveTxt(nameservers: string[]): typeof resolveTxt {
+  // Build the resolver asynchronously
+  const resolverPromise: Promise<Resolver | null> = Promise.allSettled(
+    nameservers.map((h) => lookup(h)),
+  )
+    .then((responses) =>
+      responses.flatMap((r) =>
+        r.status === 'fulfilled' ? [r.value.address] : [],
+      ),
+    )
+    .then((backupIps) => {
+      if (!backupIps.length) return null
+      const resolver = new Resolver()
+      resolver.setServers(backupIps)
+      return resolver
+    })
+
+  resolverPromise.catch(() => {
+    // Should never happen
+  })
+
+  return async (hostname) => {
+    const resolver = await resolverPromise
+    return resolver ? resolver.resolveTxt(hostname) : []
+  }
+}
+
+function parseDnsResult(chunkedResults: string[][]): ResolvedHandle {
+  const results = chunkedResults.map((chunks) => chunks.join(''))
+  const found = results.filter((i) => i.startsWith(PREFIX))
+  if (found.length !== 1) {
+    return null
+  }
+  const did = found[0].slice(PREFIX.length)
+  return isResolvedHandle(did) ? did : null
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+// Main export
+export * from './node-handle-resolver.js'
+export { NodeHandleResolver as default } from './node-handle-resolver.js'
+
+// Utilities
+export * from './dns-handle-resolver.js'

package/src/node-handle-resolver.ts

@@ -0,0 +1,96 @@
+import { Fetch } from '@atproto-labs/fetch'
+import { SafeFetchWrapOptions, safeFetchWrap } from '@atproto-labs/fetch-node'
+import {
+  CachedHandleResolver,
+  CachedHandleResolverOptions,
+  HandleResolver,
+  WellKnownHandleResolver,
+} from '@atproto-labs/handle-resolver'
+
+import {
+  DnsHandleResolver,
+  DnsHandleResolverOptions,
+} from './dns-handle-resolver.js'
+
+export type NodeHandleResolverOptions = {
+  /**
+   * List of domain names that are forbidden to be resolved using the
+   * well-known/atproto-did method.
+   */
+  wellKnownExclude?: SafeFetchWrapOptions['forbiddenDomainNames']
+
+  /**
+   * List of backup nameservers to use for DNS resolution.
+   */
+  fallbackNameservers?: DnsHandleResolverOptions['nameservers']
+
+  cache?: CachedHandleResolverOptions['cache']
+
+  /**
+   * Fetch function to use for HTTP requests. Allows customizing the request
+   * behavior, e.g. adding headers, setting a timeout, mocking, etc. The
+   * provided fetch function will be wrapped with a safeFetchWrap function that
+   * adds SSRF protection.
+   *
+   * @default `globalThis.fetch`
+   */
+  fetch?: Fetch
+}
+
+export class NodeHandleResolver
+  extends CachedHandleResolver
+  implements HandleResolver
+{
+  constructor({
+    cache,
+    fetch = globalThis.fetch,
+    fallbackNameservers,
+    wellKnownExclude,
+  }: NodeHandleResolverOptions = {}) {
+    const safeFetch = safeFetchWrap({
+      fetch,
+      timeout: 3000, // 3 seconds
+      forbiddenDomainNames: wellKnownExclude,
+      ssrfProtection: true,
+      responseMaxSize: 10 * 1048, // DID are max 2048 characters, 10kb for safety
+    })
+
+    const httpResolver = new WellKnownHandleResolver({
+      fetch: safeFetch,
+    })
+
+    const dnsResolver = new DnsHandleResolver()
+
+    const fallbackResolver = new DnsHandleResolver({
+      nameservers: fallbackNameservers,
+    })
+
+    super({
+      cache,
+      resolver: {
+        resolve: async (handle) => {
+          const abortController = new AbortController()
+
+          const dnsPromise = dnsResolver.resolve(handle)
+          const httpPromise = httpResolver.resolve(handle, {
+            signal: abortController.signal,
+          })
+
+          // Will be awaited later
+          httpPromise.catch(() => {})
+
+          const dnsRes = await dnsPromise
+          if (dnsRes) {
+            abortController.abort()
+            return dnsRes
+          }
+
+          const res = await httpPromise
+          if (res) return res
+
+          return fallbackResolver.resolve(handle)
+        },
+      },
+    })
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig/node.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "include": [],
+  "references": [{ "path": "./tsconfig.build.json" }]
+}