fix: dynamic subdomain gateway detection #53

lidel · 2024-02-26T01:20:07Z

Description

This PR removes the concept of hardcoding BASE_URL at build time, which makes the same static payload work on any domain that follows subdomain convention, including inlined DNSlink names required for TLS wildcard setups:

It allows us to have release artifacts which work everywhere.

Notes & open questions

Long term, we should make @helia/verified-fetch support http(s):// URLs for path, subdomain, and dnslink gateways, removing the need for creating ipfs:// and ipns:// URLs.

Change checklist

I have performed a self-review of my own code
I have made corresponding changes to the documentation if necessary (this includes comments as well)
I have added tests that prove my fix is effective or that my feature works

Subdomain gateway won't have any path prefix, namespace and root identifier are in `Host` header. Closes #28

- removed hardcoded BASE_URL - improved detection based on matching from right to left to reduce false-positives related to dnslinks

lidel

Some highlights below.

lidel · 2024-02-26T01:22:35Z

src/lib/dns-link-labels.ts

-export function isDnsLabel (label: string): boolean {
-  return ['-', '.'].some((char) => label.includes(char))
+export function isInlinedDnsLink (label: string): boolean {
+  return isValidDnsLabel(label) && label.includes('-') && !label.includes('.')


ℹ️ to avoid false-positives added code to ensure an inlined DNSLink

does not parse as a valid CID

does not include .

includes at least one -

lidel · 2024-02-26T01:26:13Z

src/lib/heliaFetch.ts

 import type { Helia } from '@helia/interface'

 export interface HeliaFetchOptions {
  path: string
  helia: Helia
  signal?: AbortSignal
  headers?: Headers
-  origin?: string | null
+  id?: string | null


ℹ️ had to rename, would be confusing for web devs ("origin" in web security context, including window.location, means at minimum both protocol and the authority identifier).

lidel · 2024-02-26T01:32:58Z

src/lib/path-or-subdomain.ts

💭 I did not clean this up to make the PR smaller and easier to review.

My plan is to move majority of subdomain handling to @helia/verified-fetch in future PRs and then get back here and decide what minimal handling makes sense to remain in this project.

lidel · 2024-02-26T01:34:49Z

src/sw.ts

  const urlString = request.url
-  const url = new URL(urlString)
-  const subdomain = url.hostname.replace(`.${BASE_URL}`, '')
-  const subdomainRegex = /^(?<origin>[^/]+)\.(?<protocol>ip[fn]s)?$/


ℹ️ this produced invalid results for docs.ipfs.tech.ipns.example.com, the new code walks labels from right to left, which is better order for avoiding false-positive matches.

should we redirect from subdomains like "docs.ipfs.tech" to "docs-ipfs-tech" ?

lidel · 2024-02-26T01:56:46Z

public/_redirects

💭 I was not able to find where ?helia-sw is handled – assumed it is not wired up yet, but I've updated _redirects so it will work on web (subdomain or dnslink) gateway once we add it.

@SgtPooki what was the plan around ?helia-sw-subdomain and ?helia-sw? I want to add origin isolation enforcement in follow-up PR and most likely will have to touch this.

?helia-sw & ?helia-sw-subdomain are no longer required and should be able to be removed

they were used to help with registering the service worker originally, but now, if the service worker is hit, we never render the jsx, and if the service worker isn't hit, we determine (in app.tsx) if we need to load the or not

SgtPooki

some comments and questions

SgtPooki · 2024-02-26T16:42:58Z

public/_redirects

they were used to help with registering the service worker originally, but now, if the service worker is hit, we never render the jsx, and if the service worker isn't hit, we determine (in app.tsx) if we need to load the or not

SgtPooki · 2024-02-26T16:50:43Z

src/lib/heliaFetch.ts

+ * * /ipfs/CID      (https://docs.ipfs.tech/concepts/content-addressing/)
+ * * /ipns/DNSLink  (https://dnslink.dev/)
+ * * /ipns/IPNSName (https://specs.ipfs.tech/ipns/ipns-record/#ipns-name)


SgtPooki · 2024-02-26T16:54:09Z

src/sw.ts

  const urlString = request.url
-  const url = new URL(urlString)
-  const subdomain = url.hostname.replace(`.${BASE_URL}`, '')
-  const subdomainRegex = /^(?<origin>[^/]+)\.(?<protocol>ip[fn]s)?$/


should we redirect from subdomains like "docs.ipfs.tech" to "docs-ipfs-tech" ?

SgtPooki · 2024-02-26T16:56:29Z

src/index.tsx

  // but the requested path is something it should, so show redirect and redirect to the same URL
  root.render(
    <RedirectPage />
  )
  window.location.replace(window.location.href)
 } else {
+  // TODO: add detection of DNSLink gateways (alowing use with Host: en.wikipedia-on-ipfs.org)


if en.wikipedia-on-ipfs.org.ipns.sw-host.tld is requested, this will never be hit.

SgtPooki · 2024-02-26T16:56:55Z

public/_redirects

@@ -1,2 +1 @@
-/ipns/* /?helia-sw=/ipns/:splat 302
-/ipfs/* /?helia-sw=/ipfs/:splat 302
+/* /?helia-sw=/:splat 302


we should be able to remove this and just resolve #28

lidel added 2 commits February 23, 2024 19:07

fix: route to ?helia-sw for all 404 paths

de4f2c2

Subdomain gateway won't have any path prefix, namespace and root identifier are in `Host` header. Closes #28

refactor: improved subdomain detection

1cfe4ca

- removed hardcoded BASE_URL - improved detection based on matching from right to left to reduce false-positives related to dnslinks

lidel requested review from SgtPooki and 2color February 26, 2024 01:20

lidel commented Feb 26, 2024

View reviewed changes

Merge branch 'main' into subdomain-setup-detection

e68b250

lidel mentioned this pull request Feb 26, 2024

Origin isolation warnings, tests and enforcement #30

Open

9 tasks

lidel commented Feb 26, 2024

View reviewed changes

This was referenced Feb 26, 2024

Epic: service-worker-gateway Productionisation #31

Open

Add _redirects file for SPA behavior #28

Closed

SgtPooki reviewed Feb 26, 2024

View reviewed changes

SgtPooki added 2 commits February 26, 2024 10:00

chore: fix test script

1fa7e2b

chore: gitattributes

df38c11

SgtPooki approved these changes Feb 26, 2024

View reviewed changes

SgtPooki merged commit 333ee9f into main Feb 26, 2024
14 checks passed

SgtPooki deleted the subdomain-setup-detection branch February 26, 2024 21:20

lidel mentioned this pull request Mar 15, 2024

chore(main): release 1.0.0 #120

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: dynamic subdomain gateway detection #53

fix: dynamic subdomain gateway detection #53

lidel commented Feb 26, 2024 •

edited

Loading

lidel left a comment

lidel Feb 26, 2024

lidel Feb 26, 2024

lidel Feb 26, 2024

lidel Feb 26, 2024

SgtPooki Feb 26, 2024

lidel Feb 26, 2024

SgtPooki Feb 26, 2024

SgtPooki Feb 26, 2024

SgtPooki left a comment

SgtPooki Feb 26, 2024

SgtPooki Feb 26, 2024

SgtPooki Feb 26, 2024

SgtPooki Feb 26, 2024

SgtPooki Feb 26, 2024

fix: dynamic subdomain gateway detection #53

fix: dynamic subdomain gateway detection #53

Conversation

lidel commented Feb 26, 2024 • edited Loading

Description

Notes & open questions

Change checklist

lidel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SgtPooki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lidel commented Feb 26, 2024 •

edited

Loading