subdomain_gateway_ipfs_test.go

package tests

import (
	"net/url"
	"testing"

	"github.com/ipfs/gateway-conformance/tooling"
	"github.com/ipfs/gateway-conformance/tooling/car"
	. "github.com/ipfs/gateway-conformance/tooling/check"
	"github.com/ipfs/gateway-conformance/tooling/helpers"
	"github.com/ipfs/gateway-conformance/tooling/specs"
	. "github.com/ipfs/gateway-conformance/tooling/test"
)

func TestUnixFSDirectoryListingOnSubdomainGateway(t *testing.T) {
	tooling.LogTestGroup(t, GroupUnixFS)

	fixture := car.MustOpenUnixfsCar("dir_listing/fixtures.car")
	root := fixture.MustGetNode()
	file := fixture.MustGetNode("ą", "ę", "file-źł.txt")

	// We're going to run the same test against multiple gateways (localhost, and a subdomain gateway)
	gatewayURLs := []string{
		SubdomainGatewayURL,
		SubdomainLocalhostGatewayURL,
	}

	tests := SugarTests{}

	for _, gatewayURL := range gatewayURLs {
		u, err := url.Parse(gatewayURL)
		if err != nil {
			t.Fatal(err)
		}

		tests = append(tests, SugarTests{
			{
				Name: "backlink on root CID should be hidden (TODO: cleanup Kubo-specifics)",
				Request: Request().
					URL(
						"{{scheme}}://{{cid}}.ipfs.{{host}}/",
						u.Scheme,
						root.Cid(),
						u.Host,
					),
				Response: Expect().
					BodyWithHint("backlink on root CID should be hidden",
						And(
							Contains("Index of"),
							Not(Contains(`<a href="/">..</a>`)),
						)),
			},
			{
				Name: "redirect dir listing to URL with trailing slash",
				Request: Request().
					URL(
						"{{scheme}}://{{cid}}.ipfs.{{host}}/ą/ę",
						u.Scheme,
						root.Cid(),
						u.Host,
					),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals(`/%c4%85/%c4%99/`),
					),
			},
			{
				Name: "Regular dir listing HTML (TODO: cleanup Kubo-specifics)",
				Request: Request().URL(
					"{{scheme}}://{{cid}}.ipfs.{{host}}/ą/ę/",
					u.Scheme,
					root.Cid(),
					u.Host,
				),
				Response: Expect().
					Headers(
						Header("Etag").Contains(`"DirIndex-`),
					).BodyWithHint(`
					- backlink on subdirectory should point at parent directory (TODO:  kubo-specific)
					- breadcrumbs should leverage path-based router mounted on the parent domain (TODO:  kubo-specific)
					- name column should be a link to content root mounted at subdomain origin
					`,
					And(
						Contains("Index of"),
						Contains(
							`<a href="/%C4%85/%C4%99/..">..</a>`,
						),
						Contains(
							`/ipfs/<a href="//{{host}}/ipfs/{{cid}}">{{cid}}</a>/<a href="//{{host}}/ipfs/{{cid}}/%C4%85">ą</a>/<a href="//{{host}}/ipfs/{{cid}}/%C4%85/%C4%99">ę</a>`,
							u.Host, // We don't have a subdomain here which prevents issues with normalization and cidv0
							root.Cid(),
						),
						Contains(
							`<a href="/%C4%85/%C4%99/file-%C5%BA%C5%82.txt">file-źł.txt</a>`,
						),
						Contains(
							`<a class="ipfs-hash" translate="no" href="//{{host}}/ipfs/{{cid}}?filename=file-%25C5%25BA%25C5%2582.txt">`,
							u.Host, // We don't have a subdomain here which prevents issues with normalization and cidv0
							file.Cid(),
						),
					)),
			},
		}...)
	}

	RunWithSpecs(t, helpers.UnwrapSubdomainTests(t, tests), specs.SubdomainGatewayIPFS)
}

func TestGatewaySubdomains(t *testing.T) {
	tooling.LogTestGroup(t, GroupSubdomains)

	fixture := car.MustOpenUnixfsCar("subdomain_gateway/fixtures.car")

	CIDVal := string(fixture.MustGetRawData("hello-CIDv1")) // hello
	DirCID := fixture.MustGetCid("testdirlisting")
	CIDv1 := fixture.MustGetCid("hello-CIDv1")
	CIDv0 := fixture.MustGetCid("hello-CIDv0")
	CIDv0to1 := fixture.MustGetCid("hello-CIDv0to1")
	CIDv1_TOO_LONG := fixture.MustGetCid("hello-CIDv1_TOO_LONG")
	CIDWikipedia := "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco"

	dirWithPercentEncodedFilename := car.MustOpenUnixfsCar("path_gateway_unixfs/dir-with-percent-encoded-filename.car")
	dirWithPercentEncodedFilenameCID := dirWithPercentEncodedFilename.MustGetCid()

	tests := SugarTests{}

	// We're going to run the same test against multiple gateways (localhost, and a subdomain gateway)
	gatewayURLs := []string{
		SubdomainGatewayURL,
		SubdomainLocalhostGatewayURL,
	}

	for _, gatewayURL := range gatewayURLs {
		u, err := url.Parse(gatewayURL)
		if err != nil {
			t.Fatal(err)
		}

		tests = append(tests, SugarTests{
			{
				Name: "request for example.com/ipfs/{CIDv1} redirects to subdomain",
				Hint: `
					subdomains should not return payload directly,
					but redirect to URL with proper origin isolation
				`,
				Request: Request().URL("{{url}}/ipfs/{{cid}}/", gatewayURL, CIDv1),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").
							Hint("request for example.com/ipfs/{CIDv1} returns Location HTTP header for subdomain redirect in browsers").
							Contains("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv1, u.Host),
					),
			},
			{
				Name:    "request for example.com/ipfs/{CIDv1}/{filename with percent encoding} redirects to subdomain",
				Request: Request().URL("{{url}}/ipfs/{{cid}}/Portugal%252C+España=Peninsula%20Ibérica.txt", gatewayURL, dirWithPercentEncodedFilenameCID),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals("{{scheme}}://{{cid}}.ipfs.{{host}}/Portugal%252C+Espa%C3%B1a=Peninsula%20Ib%C3%A9rica.txt", u.Scheme, dirWithPercentEncodedFilenameCID, u.Host),
					),
			},
			{
				Name: "request for example.com/ipfs/{DirCID} redirects to subdomain",
				Hint: `
					subdomains should not return payload directly,
					but redirect to URL with proper origin isolation
				`,
				Request: Request().URL("{{url}}/ipfs/{{cid}}/", gatewayURL, DirCID),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").
							Hint("request for example.com/ipfs/{DirCID} returns Location HTTP header for subdomain redirect in browsers").
							Contains("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, DirCID, u.Host),
					),
			},
			{
				Name:    "request for example.com/ipfs/{CIDv0} redirects to CIDv1 representation in subdomain",
				Request: Request().URL("{{url}}/ipfs/{{cid}}/", gatewayURL, CIDv0),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").
							Hint("request for example.com/ipfs/{CIDv0to1} returns Location HTTP header for subdomain redirect in browsers").
							Contains("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv0to1, u.Host),
					),
			},
			{
				Name:    "request for {CID}.ipfs.example.com should return expected payload",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}", u.Scheme, CIDv1, u.Host),
				Response: Expect().
					Status(200).
					Body(Contains(CIDVal)),
			},
			{
				Name:    "request for {CID}.ipfs.example.com/ipfs/{CID} should return HTTP 404",
				Hint:    "ensure /ipfs/ namespace is not mounted on subdomain",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/ipfs/{{cid}}", u.Scheme, CIDv1, u.Host),
				Response: Expect().
					Status(404),
			},
			{
				Name:    "request for {CID}.ipfs.example.com/ipfs/file.txt should return data from a file in CID content root",
				Hint:    "ensure requests to /ipfs/* are not blocked, if content root has such subdirectory",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/ipfs/file.txt", u.Scheme, DirCID, u.Host),
				Response: Expect().
					Status(200).
					Body(Contains("I am a txt file")),
			},
			{
				Name:    "valid file and subdirectory paths in directory listing at {cid}.ipfs.example.com",
				Hint:    "{CID}.ipfs.example.com/sub/dir (Directory Listing)",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, DirCID, u.Host),
				Response: Expect().
					Status(200).
					Body(And(
						// TODO: implement html expectations
						Contains(`<a href="/hello">hello</a>`),
						Contains(`<a href="/ipfs">ipfs</a>`),
					)),
			},
			{
				Name:    "valid parent directory path in directory listing at {cid}.ipfs.example.com/sub/dir",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/ipfs/ipns/", u.Scheme, DirCID, u.Host),
				Response: Expect().
					Status(200).
					Body(And(
						// TODO: implement html expectations
						Contains(`<a href="/ipfs/ipns/..">..</a>`),
						Contains(`<a href="/ipfs/ipns/bar">bar</a>`),
					)),
			},
			{
				Name:    "request for deep path resource at {cid}.ipfs.example.com/sub/dir/file",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/ipfs/ipns/bar", u.Scheme, DirCID, u.Host),
				Response: Expect().
					Status(200).
					Body(Contains("text-file-content")),
			},
			{
				Name: "valid breadcrumb links in the header of directory listing at {cid}.ipfs.example.com/sub/dir (TODO: cleanup Kubo-specifics)",
				Hint: `
			Note 1: we test for sneaky subdir names  {cid}.ipfs.example.com/ipfs/ipns/ :^)
			Note 2: example.com/ipfs/.. present in HTML will be redirected to subdomain, so this is expected behavior
			`,
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/ipfs/ipns/", u.Scheme, DirCID, u.Host),
				Response: Expect().
					Status(200).
					Body(
						And(
							Contains("Index of"),
							Contains(`/ipfs/<a href="//{{host}}/ipfs/{{cid}}">{{cid}}</a>/<a href="//{{host}}/ipfs/{{cid}}/ipfs">ipfs</a>/<a href="//{{host}}/ipfs/{{cid}}/ipfs/ipns">ipns</a>`,
								u.Host, DirCID),
						),
					),
			},
			{
				Name:    "request for example.com/ipfs/{CIDv1} produces redirect to {CIDv1}.ipfs.example.com",
				Hint:    "path requests to the root hostname should redirect to a subdomain URL with proper origin isolation",
				Request: Request().URL("{{scheme}}://{{host}}/ipfs/{{cid}}/", u.Scheme, u.Host, CIDv1),
				Response: Expect().
					Headers(
						Header("Location").Equals("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv1, u.Host),
					),
			},
			{
				Name:    "request for example.com/ipfs/{InvalidCID} produces useful error before redirect",
				Hint:    "error message should include original CID (and it should be case-sensitive, as we can't assume everyone uses base32)",
				Request: Request().URL("{{scheme}}://{{host}}/ipfs/QmInvalidCID", u.Scheme, u.Host),
				Response: Expect().
					Body(Contains(`invalid path "/ipfs/QmInvalidCID"`)),
			},

			{
				Name:    "request for example.com/ipfs/{CIDv0} produces redirect to {CIDv1}.ipfs.example.com",
				Request: Request().URL("{{scheme}}://{{host}}/ipfs/{{cid}}/", u.Scheme, u.Host, CIDv0),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv0to1, u.Host),
					),
			},

			{
				Name: "request for http://example.com/ipfs/{CID} with X-Forwarded-Proto: https produces redirect to HTTPS URL",
				Hint: "Support X-Forwarded-Proto",
				Request: Request().URL("{{scheme}}://{{host}}/ipfs/{{cid}}/", u.Scheme, u.Host, CIDv1).
					Header("X-Forwarded-Proto", "https"),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals("https://{{cid}}.ipfs.{{host}}/", CIDv1, u.Host),
					),
			},
			{
				Name: "request for example.com/ipfs/?uri=ipfs%3A%2F%2F.. produces redirect to /ipfs/.. content path",
				Hint: "Support ipfs:// in https://developer.mozilla.org/en-US/docs/Web/API/Navigator/registerProtocolHandler",
				Request: Request().URL("{{scheme}}://{{host}}/ipfs/", u.Scheme, u.Host).
					Query(
						"uri", "ipfs://{{host}}/wiki/Diego_Maradona.html", CIDWikipedia,
					),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals("/ipfs/{{cid}}/wiki/Diego_Maradona.html", CIDWikipedia),
					),
			},
			{
				Name:    "request for a too long CID at example.com/ipfs/{CIDv1} returns human readable error",
				Hint:    "router should not redirect to hostnames that could fail due to DNS limits",
				Request: Request().URL("{{url}}/ipfs/{{cid}}", gatewayURL, CIDv1_TOO_LONG),
				Response: Expect().
					Status(400).
					Body(Contains("CID incompatible with DNS label length limit of 63")),
			},
			{
				Name:    "request for a too long CID at {CIDv1}.ipfs.example.com returns expected payload",
				Hint:    "direct request should also fail (provides the same UX as router and avoids confusion)",
				Request: Request().URL("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv1_TOO_LONG, u.Host),
				Response: Expect().
					Status(400).
					Body(Contains("CID incompatible with DNS label length limit of 63")),
			},
			// ## ============================================================================
			// ## Test support for X-Forwarded-Host
			// ## ============================================================================
			{
				Name: "request for http://fake.domain.com/ipfs/{CID} doesn't match the example.com gateway",
				Request: Request().
					URL("{{scheme}}://{{domain}}/ipfs/{{cid}}", u.Scheme, "fake.domain.com", CIDv1),
				Response: Expect().
					Status(200),
			},
			{
				Name: "request for http://fake.domain.com/ipfs/{CID} with X-Forwarded-Host: example.com match the example.com gateway",
				Request: Request().
					URL("{{scheme}}://{{domain}}/ipfs/{{cid}}", u.Scheme, "fake.domain.com", CIDv1).
					Header("X-Forwarded-Host", u.Host),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals("{{scheme}}://{{cid}}.ipfs.{{host}}/", u.Scheme, CIDv1, u.Host),
					),
			},
			{
				Name: "request for http://fake.domain.com/ipfs/{CID} with X-Forwarded-Host: example.com and X-Forwarded-Proto: https match the example.com gateway, redirect with https",
				Request: Request().
					URL("{{scheme}}://{{domain}}/ipfs/{{cid}}", u.Scheme, "fake.domain.com", CIDv1).
					Header("X-Forwarded-Host", u.Host).
					Header("X-Forwarded-Proto", "https"),
				Response: Expect().
					Status(301).
					Headers(
						Header("Location").Equals("https://{{cid}}.ipfs.{{host}}/", CIDv1, u.Host),
					),
			},
		}...)
	}

	RunWithSpecs(t, helpers.UnwrapSubdomainTests(t, tests), specs.SubdomainGatewayIPFS)
}