From fee4db80a0b03b6abf4f37a9849dd4221dfd28d8 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 14 Jul 2023 18:56:47 +0200 Subject: [PATCH 1/4] client: TestSetHostHeader: don't use un-keyed literals Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 2a59188760b3062436c482bb40fd153df2c0dc44) Signed-off-by: Sebastiaan van Stijn --- client/request_test.go | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/client/request_test.go b/client/request_test.go index 6e5a6e81f2..a9506d312d 100644 --- a/client/request_test.go +++ b/client/request_test.go @@ -28,24 +28,24 @@ func TestSetHostHeader(t *testing.T) { expectedURLHost string }{ { - "unix:///var/run/docker.sock", - "docker", - "/var/run/docker.sock", + host: "unix:///var/run/docker.sock", + expectedHost: "docker", + expectedURLHost: "/var/run/docker.sock", }, { - "npipe:////./pipe/docker_engine", - "docker", - "//./pipe/docker_engine", + host: "npipe:////./pipe/docker_engine", + expectedHost: "docker", + expectedURLHost: "//./pipe/docker_engine", }, { - "tcp://0.0.0.0:4243", - "", - "0.0.0.0:4243", + host: "tcp://0.0.0.0:4243", + expectedHost: "", + expectedURLHost: "0.0.0.0:4243", }, { - "tcp://localhost:4243", - "", - "localhost:4243", + host: "tcp://localhost:4243", + expectedHost: "", + expectedURLHost: "localhost:4243", }, } From 597a5f9794a5c46f405397154727b5193973dd13 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 12 Jul 2023 14:15:38 +0200 Subject: [PATCH 2/4] client: define a "dummy" hostname to use for local connections For local communications (npipe://, unix://), the hostname is not used, but we need valid and meaningful hostname. The current code used the client's `addr` as hostname in some cases, which could contain the path for the unix-socket (`/var/run/docker.sock`), which gets rejected by go1.20.6 and go1.19.11 because of a security fix for [CVE-2023-29406 ][1], which was implemented in https://go.dev/issue/60374. Prior versions go Go would clean the host header, and strip slashes in the process, but go1.20.6 and go1.19.11 no longer do, and reject the host header. This patch introduces a `DummyHost` const, and uses this dummy host for cases where we don't need an actual hostname. Before this patch (using go1.20.6): make GO_VERSION=1.20.6 TEST_FILTER=TestAttach test-integration === RUN TestAttachWithTTY attach_test.go:46: assertion failed: error is not nil: http: invalid Host header --- FAIL: TestAttachWithTTY (0.11s) === RUN TestAttachWithoutTTy attach_test.go:46: assertion failed: error is not nil: http: invalid Host header --- FAIL: TestAttachWithoutTTy (0.02s) FAIL With this patch applied: make GO_VERSION=1.20.6 TEST_FILTER=TestAttach test-integration INFO: Testing against a local daemon === RUN TestAttachWithTTY --- PASS: TestAttachWithTTY (0.12s) === RUN TestAttachWithoutTTy --- PASS: TestAttachWithoutTTy (0.02s) PASS [1]: https://github.com/advisories/GHSA-f8f7-69v5-w4vx Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 92975f0c11f0566cc3c36659f5e3bb9faf5cb176) Signed-off-by: Sebastiaan van Stijn --- client/client.go | 30 ++++++++++++++++++++++++++++++ client/hijack.go | 6 +++++- client/request.go | 10 ++++------ client/request_test.go | 4 ++-- 4 files changed, 41 insertions(+), 9 deletions(-) diff --git a/client/client.go b/client/client.go index 1c081a51ae..54fa36cca8 100644 --- a/client/client.go +++ b/client/client.go @@ -56,6 +56,36 @@ import ( "github.com/pkg/errors" ) +// DummyHost is a hostname used for local communication. +// +// It acts as a valid formatted hostname for local connections (such as "unix://" +// or "npipe://") which do not require a hostname. It should never be resolved, +// but uses the special-purpose ".localhost" TLD (as defined in [RFC 2606, Section 2] +// and [RFC 6761, Section 6.3]). +// +// [RFC 7230, Section 5.4] defines that an empty header must be used for such +// cases: +// +// If the authority component is missing or undefined for the target URI, +// then a client MUST send a Host header field with an empty field-value. +// +// However, [Go stdlib] enforces the semantics of HTTP(S) over TCP, does not +// allow an empty header to be used, and requires req.URL.Scheme to be either +// "http" or "https". +// +// For further details, refer to: +// +// - https://github.com/docker/engine-api/issues/189 +// - https://github.com/golang/go/issues/13624 +// - https://github.com/golang/go/issues/61076 +// - https://github.com/moby/moby/issues/45935 +// +// [RFC 2606, Section 2]: https://www.rfc-editor.org/rfc/rfc2606.html#section-2 +// [RFC 6761, Section 6.3]: https://www.rfc-editor.org/rfc/rfc6761#section-6.3 +// [RFC 7230, Section 5.4]: https://datatracker.ietf.org/doc/html/rfc7230#section-5.4 +// [Go stdlib]: https://github.com/golang/go/blob/6244b1946bc2101b01955468f1be502dbadd6807/src/net/http/transport.go#L558-L569 +const DummyHost = "api.moby.localhost" + // ErrRedirect is the error returned by checkRedirect when the request is non-GET. var ErrRedirect = errors.New("unexpected redirect in response") diff --git a/client/hijack.go b/client/hijack.go index 6bdacab10a..4dcaaca4c5 100644 --- a/client/hijack.go +++ b/client/hijack.go @@ -64,7 +64,11 @@ func fallbackDial(proto, addr string, tlsConfig *tls.Config) (net.Conn, error) { } func (cli *Client) setupHijackConn(ctx context.Context, req *http.Request, proto string) (net.Conn, string, error) { - req.Host = cli.addr + req.URL.Host = cli.addr + if cli.proto == "unix" || cli.proto == "npipe" { + // Override host header for non-tcp connections. + req.Host = DummyHost + } req.Header.Set("Connection", "Upgrade") req.Header.Set("Upgrade", proto) diff --git a/client/request.go b/client/request.go index c799095c12..bcedcf3bd9 100644 --- a/client/request.go +++ b/client/request.go @@ -96,16 +96,14 @@ func (cli *Client) buildRequest(method, path string, body io.Reader, headers hea return nil, err } req = cli.addHeaders(req, headers) + req.URL.Scheme = cli.scheme + req.URL.Host = cli.addr if cli.proto == "unix" || cli.proto == "npipe" { - // For local communications, it doesn't matter what the host is. We just - // need a valid and meaningful host name. (See #189) - req.Host = "docker" + // Override host header for non-tcp connections. + req.Host = DummyHost } - req.URL.Host = cli.addr - req.URL.Scheme = cli.scheme - if expectedPayload && req.Header.Get("Content-Type") == "" { req.Header.Set("Content-Type", "text/plain") } diff --git a/client/request_test.go b/client/request_test.go index a9506d312d..feaf9bf033 100644 --- a/client/request_test.go +++ b/client/request_test.go @@ -29,12 +29,12 @@ func TestSetHostHeader(t *testing.T) { }{ { host: "unix:///var/run/docker.sock", - expectedHost: "docker", + expectedHost: DummyHost, expectedURLHost: "/var/run/docker.sock", }, { host: "npipe:////./pipe/docker_engine", - expectedHost: "docker", + expectedHost: DummyHost, expectedURLHost: "//./pipe/docker_engine", }, { From 547ea18fbbea3d14514120ed67c6e8aff18eb347 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 12 Jul 2023 15:07:59 +0200 Subject: [PATCH 3/4] pkg/plugins: use a dummy hostname for local connections For local communications (npipe://, unix://), the hostname is not used, but we need valid and meaningful hostname. The current code used the socket path as hostname, which gets rejected by go1.20.6 and go1.19.11 because of a security fix for [CVE-2023-29406 ][1], which was implemented in https://go.dev/issue/60374. Prior versions go Go would clean the host header, and strip slashes in the process, but go1.20.6 and go1.19.11 no longer do, and reject the host header. Before this patch, tests would fail on go1.20.6: === FAIL: pkg/authorization TestAuthZRequestPlugin (15.01s) time="2023-07-12T12:53:45Z" level=warning msg="Unable to connect to plugin: //tmp/authz2422457390/authz-test-plugin.sock/AuthZPlugin.AuthZReq: Post \"http://%2F%2Ftmp%2Fauthz2422457390%2Fauthz-test-plugin.sock/AuthZPlugin.AuthZReq\": http: invalid Host header, retrying in 1s" time="2023-07-12T12:53:46Z" level=warning msg="Unable to connect to plugin: //tmp/authz2422457390/authz-test-plugin.sock/AuthZPlugin.AuthZReq: Post \"http://%2F%2Ftmp%2Fauthz2422457390%2Fauthz-test-plugin.sock/AuthZPlugin.AuthZReq\": http: invalid Host header, retrying in 2s" time="2023-07-12T12:53:48Z" level=warning msg="Unable to connect to plugin: //tmp/authz2422457390/authz-test-plugin.sock/AuthZPlugin.AuthZReq: Post \"http://%2F%2Ftmp%2Fauthz2422457390%2Fauthz-test-plugin.sock/AuthZPlugin.AuthZReq\": http: invalid Host header, retrying in 4s" time="2023-07-12T12:53:52Z" level=warning msg="Unable to connect to plugin: //tmp/authz2422457390/authz-test-plugin.sock/AuthZPlugin.AuthZReq: Post \"http://%2F%2Ftmp%2Fauthz2422457390%2Fauthz-test-plugin.sock/AuthZPlugin.AuthZReq\": http: invalid Host header, retrying in 8s" authz_unix_test.go:82: Failed to authorize request Post "http://%2F%2Ftmp%2Fauthz2422457390%2Fauthz-test-plugin.sock/AuthZPlugin.AuthZReq": http: invalid Host header [1]: https://github.com/advisories/GHSA-f8f7-69v5-w4vx Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 6b7705d5b29e226a24902a8dcc488836faaee33c) Signed-off-by: Sebastiaan van Stijn --- pkg/plugins/client.go | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/pkg/plugins/client.go b/pkg/plugins/client.go index 752fecd0ae..e683eb777d 100644 --- a/pkg/plugins/client.go +++ b/pkg/plugins/client.go @@ -18,6 +18,12 @@ import ( const ( defaultTimeOut = 30 + + // dummyHost is a hostname used for local communication. + // + // For local communications (npipe://, unix://), the hostname is not used, + // but we need valid and meaningful hostname. + dummyHost = "plugin.moby.localhost" ) func newTransport(addr string, tlsConfig *tlsconfig.Options) (transport.Transport, error) { @@ -44,8 +50,12 @@ func newTransport(addr string, tlsConfig *tlsconfig.Options) (transport.Transpor return nil, err } scheme := httpScheme(u) - - return transport.NewHTTPTransport(tr, scheme, socket), nil + hostName := u.Host + if hostName == "" || u.Scheme == "unix" || u.Scheme == "npipe" { + // Override host header for non-tcp connections. + hostName = dummyHost + } + return transport.NewHTTPTransport(tr, scheme, hostName), nil } // NewClient creates a new plugin client (http). From bdaadec7881c56835a31473cbe6cd165b816e4b0 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 12 Jul 2023 17:37:01 +0200 Subject: [PATCH 4/4] testutil: use dummyhost for non-tcp connections Signed-off-by: Sebastiaan van Stijn (cherry picked from commit e1db9e9848435042922512b3b5f6dc97f627af00) Signed-off-by: Sebastiaan van Stijn --- integration-cli/docker_api_attach_test.go | 5 +++++ testutil/request/request.go | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/integration-cli/docker_api_attach_test.go b/integration-cli/docker_api_attach_test.go index 6d31c51ec3..401087ab2e 100644 --- a/integration-cli/docker_api_attach_test.go +++ b/integration-cli/docker_api_attach_test.go @@ -236,6 +236,11 @@ func requestHijack(method, endpoint string, data io.Reader, ct, daemon string, m req.URL.Scheme = "http" req.URL.Host = hostURL.Host + if hostURL.Scheme == "unix" || hostURL.Scheme == "npipe" { + // Override host header for non-tcp connections. + req.Host = client.DummyHost + } + for _, opt := range modifiers { opt(req) } diff --git a/testutil/request/request.go b/testutil/request/request.go index d5f559c666..6a91dc9b37 100644 --- a/testutil/request/request.go +++ b/testutil/request/request.go @@ -125,6 +125,11 @@ func newRequest(endpoint string, opts *Options) (*http.Request, error) { } req.URL.Host = hostURL.Host + if hostURL.Scheme == "unix" || hostURL.Scheme == "npipe" { + // Override host header for non-tcp connections. + req.Host = client.DummyHost + } + for _, config := range opts.requestModifiers { if err := config(req); err != nil { return nil, err