|
| 1 | +package http_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "encoding/pem" |
| 6 | + "io" |
| 7 | + "net" |
| 8 | + "net/http" |
| 9 | + "net/http/httptest" |
| 10 | + "net/url" |
| 11 | + "os" |
| 12 | + "path/filepath" |
| 13 | + "reflect" |
| 14 | + "testing" |
| 15 | + "time" |
| 16 | + |
| 17 | + "github.com/stretchr/testify/require" |
| 18 | + "sigs.k8s.io/controller-runtime/pkg/log" |
| 19 | + |
| 20 | + httputil "github.com/operator-framework/operator-controller/internal/shared/util/http" |
| 21 | +) |
| 22 | + |
| 23 | +// startRecordingProxy starts a plain-HTTP CONNECT proxy that tunnels HTTPS |
| 24 | +// connections and records the target host of each CONNECT request. |
| 25 | +func startRecordingProxy(proxied chan<- string) *httptest.Server { |
| 26 | + return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { |
| 27 | + if r.Method != http.MethodConnect { |
| 28 | + http.Error(w, "only CONNECT supported", http.StatusMethodNotAllowed) |
| 29 | + return |
| 30 | + } |
| 31 | + // Non-blocking: if there are unexpected extra CONNECT requests (retries, |
| 32 | + // parallel connections) we record the first one and drop the rest rather |
| 33 | + // than blocking the proxy handler goroutine. |
| 34 | + select { |
| 35 | + case proxied <- r.Host: |
| 36 | + default: |
| 37 | + } |
| 38 | + |
| 39 | + dst, err := net.Dial("tcp", r.Host) |
| 40 | + if err != nil { |
| 41 | + http.Error(w, err.Error(), http.StatusBadGateway) |
| 42 | + return |
| 43 | + } |
| 44 | + defer dst.Close() |
| 45 | + |
| 46 | + hj, ok := w.(http.Hijacker) |
| 47 | + if !ok { |
| 48 | + http.Error(w, "hijacking not supported", http.StatusInternalServerError) |
| 49 | + return |
| 50 | + } |
| 51 | + conn, bufrw, err := hj.Hijack() |
| 52 | + if err != nil { |
| 53 | + http.Error(w, err.Error(), http.StatusInternalServerError) |
| 54 | + return |
| 55 | + } |
| 56 | + defer conn.Close() |
| 57 | + |
| 58 | + if _, err = conn.Write([]byte("HTTP/1.1 200 Connection established\r\n\r\n")); err != nil { |
| 59 | + return |
| 60 | + } |
| 61 | + |
| 62 | + done := make(chan struct{}, 2) |
| 63 | + tunnel := func(dst io.Writer, src io.Reader) { |
| 64 | + defer func() { done <- struct{}{} }() |
| 65 | + _, _ = io.Copy(dst, src) |
| 66 | + // Half-close the write side so the other direction sees EOF and |
| 67 | + // its io.Copy returns, preventing the goroutine from hanging. |
| 68 | + if cw, ok := dst.(interface{ CloseWrite() error }); ok { |
| 69 | + _ = cw.CloseWrite() |
| 70 | + } |
| 71 | + } |
| 72 | + // Use bufrw (not conn) as the client→dst source: Hijack may have |
| 73 | + // buffered bytes (e.g. the TLS ClientHello) that arrived together with |
| 74 | + // the CONNECT headers; reading from conn directly would lose them. |
| 75 | + go tunnel(dst, bufrw) |
| 76 | + go tunnel(conn, dst) |
| 77 | + <-done |
| 78 | + <-done // wait for both directions before closing connections |
| 79 | + })) |
| 80 | +} |
| 81 | + |
| 82 | +// certPoolWatcherForTLSServer creates a CertPoolWatcher that trusts the given |
| 83 | +// TLS test server's certificate. |
| 84 | +func certPoolWatcherForTLSServer(t *testing.T, server *httptest.Server) *httputil.CertPoolWatcher { |
| 85 | + t.Helper() |
| 86 | + |
| 87 | + dir := t.TempDir() |
| 88 | + certPath := filepath.Join(dir, "server.pem") |
| 89 | + |
| 90 | + certDER := server.TLS.Certificates[0].Certificate[0] |
| 91 | + f, err := os.Create(certPath) |
| 92 | + require.NoError(t, err) |
| 93 | + require.NoError(t, pem.Encode(f, &pem.Block{Type: "CERTIFICATE", Bytes: certDER})) |
| 94 | + require.NoError(t, f.Close()) |
| 95 | + |
| 96 | + cpw, err := httputil.NewCertPoolWatcher(dir, log.FromContext(context.Background())) |
| 97 | + require.NoError(t, err) |
| 98 | + require.NotNil(t, cpw) |
| 99 | + t.Cleanup(cpw.Done) |
| 100 | + require.NoError(t, cpw.Start(context.Background())) |
| 101 | + return cpw |
| 102 | +} |
| 103 | + |
| 104 | +// TestBuildHTTPClientTransportUsesProxyFromEnvironment verifies that the |
| 105 | +// transport returned by BuildHTTPClient has Proxy set to http.ProxyFromEnvironment |
| 106 | +// so that HTTPS_PROXY and NO_PROXY env vars are honoured at runtime. |
| 107 | +func TestBuildHTTPClientTransportUsesProxyFromEnvironment(t *testing.T) { |
| 108 | + // Use system certs (empty dir) — we only need a valid CertPoolWatcher. |
| 109 | + cpw, err := httputil.NewCertPoolWatcher("", log.FromContext(context.Background())) |
| 110 | + require.NoError(t, err) |
| 111 | + t.Cleanup(cpw.Done) |
| 112 | + require.NoError(t, cpw.Start(context.Background())) |
| 113 | + |
| 114 | + client, err := httputil.BuildHTTPClient(cpw) |
| 115 | + require.NoError(t, err) |
| 116 | + |
| 117 | + transport, ok := client.Transport.(*http.Transport) |
| 118 | + require.True(t, ok) |
| 119 | + require.Equal(t, |
| 120 | + reflect.ValueOf(http.ProxyFromEnvironment).Pointer(), |
| 121 | + reflect.ValueOf(transport.Proxy).Pointer(), |
| 122 | + "BuildHTTPClient must wire transport.Proxy to http.ProxyFromEnvironment so that "+ |
| 123 | + "HTTPS_PROXY/NO_PROXY env vars are honoured; a nil or different Proxy function "+ |
| 124 | + "means env-var proxying is silently disabled") |
| 125 | +} |
| 126 | + |
| 127 | +// TestBuildHTTPClientProxyTunnelsConnections verifies end-to-end that the |
| 128 | +// HTTP client produced by BuildHTTPClient correctly tunnels HTTPS connections |
| 129 | +// through an HTTP CONNECT proxy. |
| 130 | +// |
| 131 | +// The test overrides transport.Proxy with http.ProxyURL rather than relying on |
| 132 | +// HTTPS_PROXY: httptest servers bind to 127.0.0.1, which http.ProxyFromEnvironment |
| 133 | +// silently excludes from proxying, and env-var changes within the same process |
| 134 | +// are unreliable due to sync.Once caching. Using http.ProxyURL directly exercises |
| 135 | +// the same tunnelling code path that HTTPS_PROXY triggers in production. |
| 136 | +func TestBuildHTTPClientProxyTunnelsConnections(t *testing.T) { |
| 137 | + targetServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { |
| 138 | + w.WriteHeader(http.StatusOK) |
| 139 | + })) |
| 140 | + defer targetServer.Close() |
| 141 | + |
| 142 | + proxied := make(chan string, 1) |
| 143 | + proxyServer := startRecordingProxy(proxied) |
| 144 | + defer proxyServer.Close() |
| 145 | + |
| 146 | + proxyURL, err := url.Parse(proxyServer.URL) |
| 147 | + require.NoError(t, err) |
| 148 | + |
| 149 | + cpw := certPoolWatcherForTLSServer(t, targetServer) |
| 150 | + client, err := httputil.BuildHTTPClient(cpw) |
| 151 | + require.NoError(t, err) |
| 152 | + |
| 153 | + // Point the transport directly at our test proxy, bypassing the loopback |
| 154 | + // exclusion and env-var caching of http.ProxyFromEnvironment. |
| 155 | + transport, ok := client.Transport.(*http.Transport) |
| 156 | + require.True(t, ok) |
| 157 | + transport.Proxy = http.ProxyURL(proxyURL) |
| 158 | + |
| 159 | + resp, err := client.Get(targetServer.URL) |
| 160 | + require.NoError(t, err) |
| 161 | + resp.Body.Close() |
| 162 | + |
| 163 | + select { |
| 164 | + case host := <-proxied: |
| 165 | + require.Equal(t, targetServer.Listener.Addr().String(), host, |
| 166 | + "proxy must have received a CONNECT request for the target server address") |
| 167 | + case <-time.After(5 * time.Second): |
| 168 | + t.Fatal("HTTPS connection to target server did not go through the proxy") |
| 169 | + } |
| 170 | +} |
| 171 | + |
| 172 | +// TestBuildHTTPClientProxyBlocksWhenRejected verifies that when the proxy |
| 173 | +// rejects the CONNECT tunnel, the client request fails rather than silently |
| 174 | +// falling back to a direct connection. |
| 175 | +func TestBuildHTTPClientProxyBlocksWhenRejected(t *testing.T) { |
| 176 | + targetServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { |
| 177 | + w.WriteHeader(http.StatusOK) |
| 178 | + })) |
| 179 | + defer targetServer.Close() |
| 180 | + |
| 181 | + // A proxy that returns 403 Forbidden for every CONNECT request. |
| 182 | + rejectingProxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { |
| 183 | + if r.Method == http.MethodConnect { |
| 184 | + http.Error(w, "proxy access denied", http.StatusForbidden) |
| 185 | + return |
| 186 | + } |
| 187 | + http.Error(w, "only CONNECT supported", http.StatusMethodNotAllowed) |
| 188 | + })) |
| 189 | + defer rejectingProxy.Close() |
| 190 | + |
| 191 | + proxyURL, err := url.Parse(rejectingProxy.URL) |
| 192 | + require.NoError(t, err) |
| 193 | + |
| 194 | + cpw := certPoolWatcherForTLSServer(t, targetServer) |
| 195 | + client, err := httputil.BuildHTTPClient(cpw) |
| 196 | + require.NoError(t, err) |
| 197 | + |
| 198 | + transport, ok := client.Transport.(*http.Transport) |
| 199 | + require.True(t, ok) |
| 200 | + transport.Proxy = http.ProxyURL(proxyURL) |
| 201 | + |
| 202 | + resp, err := client.Get(targetServer.URL) |
| 203 | + if resp != nil { |
| 204 | + resp.Body.Close() |
| 205 | + } |
| 206 | + require.Error(t, err, "request should fail when the proxy rejects the CONNECT tunnel") |
| 207 | +} |
0 commit comments