From 5fe960474c4af2c7935839f5e3130dce45af8b63 Mon Sep 17 00:00:00 2001
From: Andrew Gillis <11790789+gammazero@users.noreply.github.com>
Date: Wed, 28 Aug 2024 10:03:26 -0700
Subject: [PATCH] fix(cli): preserve hostname specified with --api in http
 request headers (#10497)

Preserve hostname specified with --api in http request headers

- Replaces PR #10233
- Add test to check for hostname in HTTP header
- Update docs/changelogs/v0.30.md
---
 cmd/ipfs/kubo/start.go             | 5 ++++-
 docs/changelogs/v0.30.md           | 5 +++++
 test/sharness/t0235-cli-request.sh | 6 +++++-
 3 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/cmd/ipfs/kubo/start.go b/cmd/ipfs/kubo/start.go
index cae1e2c1b..474045e71 100644
--- a/cmd/ipfs/kubo/start.go
+++ b/cmd/ipfs/kubo/start.go
@@ -303,7 +303,10 @@ func makeExecutor(req *cmds.Request, env interface{}) (cmds.Executor, error) {
 	}
 
 	// Resolve the API addr.
-	apiAddr, err = resolveAddr(req.Context, apiAddr)
+	//
+	// Do not replace apiAddr with the resolved addr so that the requested
+	// hostname is kept for use in the request's HTTP header.
+	_, err = resolveAddr(req.Context, apiAddr)
 	if err != nil {
 		return nil, err
 	}
diff --git a/docs/changelogs/v0.30.md b/docs/changelogs/v0.30.md
index e7f5d8b3f..4c22e40ba 100644
--- a/docs/changelogs/v0.30.md
+++ b/docs/changelogs/v0.30.md
@@ -13,6 +13,7 @@
   - [`/unix/` socket support in `Addresses.API`](#unix-socket-support-in-addressesapi)
   - [Cleaned Up `ipfs daemon` Startup Log](#cleaned-up-ipfs-daemon-startup-log)
   - [UnixFS 1.5: Mode and Modification Time Support](#unixfs-15-mode-and-modification-time-support)
+  - [Commands Preserve Specified Hostname](#commands-preserve-specified-hostname)
 - [📝 Changelog](#-changelog)
 - [👨‍👩‍👧‍👦 Contributors](#-contributors)
 
@@ -129,6 +130,10 @@ Modification time support was also added to the Gateway. If present, value from
 > [!NOTE]
 > Storing `mode` and `mtime` requires root block to be `dag-pb` and disabled `raw-leaves` setting to create envelope for storing the metadata.
 
+#### Commands Preserve Specified Hostname
+
+When executing a [CLI command](https://docs.ipfs.tech/reference/kubo/cli/) over [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/), if a hostname is specified by `--api=/dns4/<domain>/` the resulting HTTP request now contains the hostname, instead of the the IP address that the hostname resolved to, as was the previous behavior. This makes it easier for those trying to run Kubo behind a reverse proxy using hostname-based rules.
+  
 ### 📝 Changelog
 
 ### 👨‍👩‍👧‍👦 Contributors
diff --git a/test/sharness/t0235-cli-request.sh b/test/sharness/t0235-cli-request.sh
index 3b2281894..02ef514de 100755
--- a/test/sharness/t0235-cli-request.sh
+++ b/test/sharness/t0235-cli-request.sh
@@ -28,7 +28,7 @@ test_expect_success "start nc" '
 '
 
 test_expect_success "can make http request against nc server" '
-  ipfs cat /ipfs/Qmabcdef --api /ip4/127.0.0.1/tcp/5005 &
+  ipfs cat /ipfs/Qmabcdef --api /dns4/localhost/tcp/5005 &
   IPFSPID=$!
 
   # handle request for /api/v0/version
@@ -80,4 +80,8 @@ test_expect_success "api flag does not appear in request" '
   test_expect_code 1 grep "api=/ip4" nc_out
 '
 
+test_expect_success "host has dns name not ip address" '
+  grep "Host: localhost:5005" nc_out
+'
+
 test_done