caddy/modules/caddyhttp/reverseproxy/streaming.go

// Copyright 2015 Matthew Holt and The Caddy Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Most of the code in this file was initially borrowed from the Go
// standard library and modified; It had this copyright notice:
// Copyright 2011 The Go Authors

package reverseproxy

import (
	"bufio"
	"context"
	"errors"
	"fmt"
	"io"
	weakrand "math/rand/v2"
	"mime"
	"net"
	"net/http"
	"sync"
	"time"
	"unsafe"

	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"golang.org/x/net/http/httpguts"

	"github.com/caddyserver/caddy/v2"
	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
)

type h2ReadWriteCloser struct {
	io.ReadCloser
	http.ResponseWriter
}

func (rwc h2ReadWriteCloser) Write(p []byte) (n int, err error) {
	n, err = rwc.ResponseWriter.Write(p)
	if err != nil {
		return 0, err
	}

	//nolint:bodyclose
	err = http.NewResponseController(rwc.ResponseWriter).Flush()
	if err != nil {
		return 0, err
	}
	return n, nil
}

func (h *Handler) handleUpgradeResponse(logger *zap.Logger, wg *sync.WaitGroup, rw http.ResponseWriter, req *http.Request, res *http.Response, upstreamAddr string) {
	reqUpType := upgradeType(req.Header)
	resUpType := upgradeType(res.Header)

	// Taken from https://github.com/golang/go/commit/5c489514bc5e61ad9b5b07bd7d8ec65d66a0512a
	// We know reqUpType is ASCII, it's checked by the caller.
	if !asciiIsPrint(resUpType) {
		if c := logger.Check(zapcore.DebugLevel, "backend tried to switch to invalid protocol"); c != nil {
			c.Write(zap.String("backend_upgrade", resUpType))
		}
		return
	}
	if !asciiEqualFold(reqUpType, resUpType) {
		if c := logger.Check(zapcore.DebugLevel, "backend tried to switch to unexpected protocol via Upgrade header"); c != nil {
			c.Write(
				zap.String("backend_upgrade", resUpType),
				zap.String("requested_upgrade", reqUpType),
			)
		}
		return
	}

	backConn, ok := res.Body.(io.ReadWriteCloser)
	if !ok {
		logger.Error("internal error: 101 switching protocols response with non-writable body")
		return
	}

	// write header first, response headers should not be counted in size
	// like the rest of handler chain.
	copyHeader(rw.Header(), res.Header)
	normalizeWebsocketHeaders(rw.Header())

	// Capture all h fields needed by the tunnel now, so that the Handler (h)
	// is not referenced after this function returns (for HTTP/1.1 hijacked
	// connections the tunnel runs in a detached goroutine).
	tunnel := h.tunnel
	bufferSize := h.StreamBufferSize
	streamTimeout := time.Duration(h.StreamTimeout)

	var (
		conn io.ReadWriteCloser
		brw  *bufio.ReadWriter
		isH2 bool
	)
	// websocket over http2 or http3 if extended connect is enabled, assuming backend doesn't support this, the request will be modified to http1.1 upgrade
	// TODO: once we can reliably detect backend support this, it can be removed for those backends
	if body, ok := caddyhttp.GetVar(req.Context(), "extended_connect_websocket_body").(io.ReadCloser); ok {
		isH2 = true
		req.Body = body
		rw.Header().Del("Upgrade")
		rw.Header().Del("Connection")
		delete(rw.Header(), "Sec-WebSocket-Accept")
		rw.WriteHeader(http.StatusOK)

		if c := logger.Check(zap.DebugLevel, "upgrading connection"); c != nil {
			c.Write(zap.Int("http_version", 2))
		}

		//nolint:bodyclose
		flushErr := http.NewResponseController(rw).Flush()
		if flushErr != nil {
			if c := h.logger.Check(zap.ErrorLevel, "failed to flush http2 websocket response"); c != nil {
				c.Write(zap.Error(flushErr))
			}
			return
		}
		conn = h2ReadWriteCloser{req.Body, rw}
		// bufio is not needed, use minimal buffer
		brw = bufio.NewReadWriter(bufio.NewReaderSize(conn, 1), bufio.NewWriterSize(conn, 1))
	} else {
		rw.WriteHeader(res.StatusCode)

		if c := logger.Check(zap.DebugLevel, "upgrading connection"); c != nil {
			c.Write(zap.Int("http_version", req.ProtoMajor))
		}

		var hijackErr error
		//nolint:bodyclose
		conn, brw, hijackErr = http.NewResponseController(rw).Hijack()
		if errors.Is(hijackErr, http.ErrNotSupported) {
			if c := h.logger.Check(zap.ErrorLevel, "can't switch protocols using non-Hijacker ResponseWriter"); c != nil {
				c.Write(zap.String("type", fmt.Sprintf("%T", rw)))
			}
			return
		}

		if hijackErr != nil {
			if c := h.logger.Check(zap.ErrorLevel, "hijack failed on protocol switch"); c != nil {
				c.Write(zap.Error(hijackErr))
			}
			return
		}
	}

	// For H2 extended connect: close backConn when the request context is
	// cancelled (e.g. client disconnects). For HTTP/1.1 hijacked connections
	// we skip this because req.Context() may be cancelled when ServeHTTP
	// returns early, which would prematurely close the backend connection.
	if isH2 {
		// adopted from https://github.com/golang/go/commit/8bcf2834afdf6a1f7937390903a41518715ef6f5
		backConnCloseCh := make(chan struct{})
		go func() {
			// Ensure that the cancellation of a request closes the backend.
			// See issue https://golang.org/issue/35559.
			select {
			case <-req.Context().Done():
			case <-backConnCloseCh:
			}
			backConn.Close()
		}()
		defer close(backConnCloseCh)
	}

	if err := brw.Flush(); err != nil {
		if c := logger.Check(zapcore.DebugLevel, "response flush"); c != nil {
			c.Write(zap.Error(err))
		}
		return
	}

	// There may be buffered data in the *bufio.Reader
	// see: https://github.com/caddyserver/caddy/issues/6273
	if buffered := brw.Reader.Buffered(); buffered > 0 {
		data, _ := brw.Peek(buffered)
		_, err := backConn.Write(data)
		if err != nil {
			if c := logger.Check(zapcore.DebugLevel, "backConn write failed"); c != nil {
				c.Write(zap.Error(err))
			}
			return
		}
	}

	// Register both connections with the tunnel tracker. We also try to
	// gracefully close connections we recognize as websockets. We need to make
	// sure the client connection messages (i.e. to upstream) are masked, so we
	// need to know whether the connection is considered the server or the
	// client side of the proxy.
	gracefulClose := func(conn io.ReadWriteCloser, isClient bool) func() error {
		if isWebsocket(req) {
			return func() error {
				return writeCloseControl(conn, isClient)
			}
		}
		return nil
	}
	deleteFrontConn := tunnel.registerConnection(conn, gracefulClose(conn, false), upstreamAddr)
	deleteBackConn := tunnel.registerConnection(backConn, gracefulClose(backConn, true), upstreamAddr)
	if h.streamLogsSkipHandshake() {
		caddyhttp.SetVar(req.Context(), caddyhttp.LogSkipVar, true)
	}
	repl := req.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
	repl.Set("http.reverse_proxy.upgraded", true)
	streamUUID, _ := repl.GetString("http.request.uuid")
	streamFields := makeStreamLogFields(streamUUID)
	streamLogger := h.streamLoggerForRequest(req)
	streamLevel := h.streamLogLevel
	finishMetrics := trackActiveStream(upstreamAddr)

	start := time.Now()

	if isH2 {
		h.handleH2UpgradeTunnel(streamLogger, streamLevel, wg, conn, backConn, deleteFrontConn, deleteBackConn, bufferSize, streamTimeout, start, finishMetrics, streamFields)
	} else {
		h.handleDetachedUpgradeTunnel(streamLogger, streamLevel, conn, backConn, deleteFrontConn, deleteBackConn, bufferSize, streamTimeout, start, finishMetrics, streamFields)
		// Return immediately without touching wg. finalizeResponse's
		// wg.Wait() returns at once since wg was never incremented.
	}
}

func (h *Handler) handleH2UpgradeTunnel(
	streamLogger *zap.Logger,
	streamLevel zapcore.Level,
	wg *sync.WaitGroup,
	conn io.ReadWriteCloser,
	backConn io.ReadWriteCloser,
	deleteFrontConn func(),
	deleteBackConn func(),
	bufferSize int,
	streamTimeout time.Duration,
	start time.Time,
	finishMetrics func(result string, duration time.Duration, toBackend, fromBackend int64),
	streamFields []zap.Field,
) {
	// H2 extended connect: ServeHTTP must block because rw and req.Body are
	// only valid while the handler goroutine is running. Defers clean up
	// when the select below fires and this function returns.
	defer deleteBackConn()
	defer deleteFrontConn()
	var (
		toBackend   int64
		fromBackend int64
		result      string
	)

	// when a stream timeout is encountered, no error will be read from errc
	// a buffer size of 2 will allow both the read and write goroutines to send the error and exit
	// see: https://github.com/caddyserver/caddy/issues/7418
	errc := make(chan error, 2)
	spc := switchProtocolCopier{
		user:       conn,
		backend:    backConn,
		wg:         wg,
		bufferSize: bufferSize,
		sent:       &toBackend,
		received:   &fromBackend,
	}
	wg.Add(2)

	var timeoutc <-chan time.Time
	if streamTimeout > 0 {
		timer := time.NewTimer(streamTimeout)
		defer timer.Stop()
		timeoutc = timer.C
	}

	go spc.copyToBackend(errc)
	go spc.copyFromBackend(errc)
	select {
	case err := <-errc:
		result = classifyStreamResult(err)
		if c := streamLogger.Check(streamLevel, "streaming error"); c != nil {
			c.Write(zap.Error(err))
		}
	case t := <-timeoutc:
		result = "timeout"
		if c := streamLogger.Check(streamLevel, "stream timed out"); c != nil {
			c.Write(zap.Time("timeout", t))
		}
	}

	// Close both ends to unblock the still-running copy goroutine,
	// then wait for it so byte counts are final before metrics/logging.
	conn.Close()
	backConn.Close()
	wg.Wait()

	finishMetrics(result, time.Since(start), toBackend, fromBackend)
	if c := streamLogger.Check(streamLevel, "connection closed"); c != nil {
		fields := append([]zap.Field{}, streamFields...)
		fields = append(fields,
			zap.Duration("duration", time.Since(start)),
			zap.Int64("bytes_to_backend", toBackend),
			zap.Int64("bytes_from_backend", fromBackend),
		)
		c.Write(fields...)
	}
}

func (h *Handler) handleDetachedUpgradeTunnel(
	streamLogger *zap.Logger,
	streamLevel zapcore.Level,
	conn io.ReadWriteCloser,
	backConn io.ReadWriteCloser,
	deleteFrontConn func(),
	deleteBackConn func(),
	bufferSize int,
	streamTimeout time.Duration,
	start time.Time,
	finishMetrics func(result string, duration time.Duration, toBackend, fromBackend int64),
	streamFields []zap.Field,
) {
	// HTTP/1.1 hijacked connection: launch a detached goroutine so that
	// ServeHTTP can return immediately, allowing the Handler to be GC'd
	// after a config reload. The goroutine captures only tunnel (a small
	// *tunnelState), logger, conn/backConn, and scalar config values.
	go func() {
		var (
			toBackend   int64
			fromBackend int64
			result      = "closed"
		)
		defer deleteBackConn()
		defer deleteFrontConn()
		defer func() {
			finishMetrics(result, time.Since(start), toBackend, fromBackend)
			if c := streamLogger.Check(streamLevel, "connection closed"); c != nil {
				fields := append([]zap.Field{}, streamFields...)
				fields = append(fields,
					zap.Duration("duration", time.Since(start)),
					zap.Int64("bytes_to_backend", toBackend),
					zap.Int64("bytes_from_backend", fromBackend),
				)
				c.Write(fields...)
			}
		}()

		var innerWg sync.WaitGroup
		// when a stream timeout is encountered, no error will be read from errc
		// a buffer size of 2 will allow both the read and write goroutines to send the error and exit
		// see: https://github.com/caddyserver/caddy/issues/7418
		errc := make(chan error, 2)
		spc := switchProtocolCopier{
			user:       conn,
			backend:    backConn,
			wg:         &innerWg,
			bufferSize: bufferSize,
			sent:       &toBackend,
			received:   &fromBackend,
		}
		innerWg.Add(2)

		var timeoutc <-chan time.Time
		if streamTimeout > 0 {
			timer := time.NewTimer(streamTimeout)
			defer timer.Stop()
			timeoutc = timer.C
		}

		go spc.copyToBackend(errc)
		go spc.copyFromBackend(errc)
		select {
		case err := <-errc:
			result = classifyStreamResult(err)
			if c := streamLogger.Check(streamLevel, "streaming error"); c != nil {
				c.Write(zap.Error(err))
			}
		case t := <-timeoutc:
			result = "timeout"
			if c := streamLogger.Check(streamLevel, "stream timed out"); c != nil {
				c.Write(zap.Time("timeout", t))
			}
		}

		// Close both ends to unblock the still-running copy goroutine,
		// then wait for it to finish so byte counts are accurate before
		// the deferred log fires.
		conn.Close()
		backConn.Close()
		innerWg.Wait()
	}()
}

func classifyStreamResult(err error) string {
	if err == nil || errors.Is(err, io.EOF) || errors.Is(err, net.ErrClosed) || errors.Is(err, context.Canceled) {
		return "closed"
	}
	return "error"
}

func makeStreamLogFields(streamUUID string) []zap.Field {
	fields := make([]zap.Field, 0, 1)
	if streamUUID != "" {
		fields = append(fields, zap.String("uuid", streamUUID))
	}
	return fields
}

// flushInterval returns the p.FlushInterval value, conditionally
// overriding its value for a specific request/response.
func (h Handler) flushInterval(req *http.Request, res *http.Response) time.Duration {
	resCTHeader := res.Header.Get("Content-Type")
	resCT, _, err := mime.ParseMediaType(resCTHeader)

	// For Server-Sent Events responses, flush immediately.
	// The MIME type is defined in https://www.w3.org/TR/eventsource/#text-event-stream
	if err == nil && resCT == "text/event-stream" {
		return -1 // negative means immediately
	}

	// We might have the case of streaming for which Content-Length might be unset.
	if res.ContentLength == -1 {
		return -1
	}

	// for h2 and h2c upstream streaming data to client (issues #3556 and #3606)
	if h.isBidirectionalStream(req, res) {
		return -1
	}

	return time.Duration(h.FlushInterval)
}

// isBidirectionalStream returns whether we should work in bi-directional stream mode.
//
// See https://github.com/caddyserver/caddy/pull/3620 for discussion of nuances.
func (h Handler) isBidirectionalStream(req *http.Request, res *http.Response) bool {
	// We have to check the encoding here; only flush headers with identity encoding.
	// Non-identity encoding might combine with "encode" directive, and in that case,
	// if body size larger than enc.MinLength, upper level encode handle might have
	// Content-Encoding header to write.
	// (see https://github.com/caddyserver/caddy/issues/3606 for use case)
	ae := req.Header.Get("Accept-Encoding")

	return req.ProtoMajor == 2 &&
		res.ProtoMajor == 2 &&
		res.ContentLength == -1 &&
		(ae == "identity" || ae == "")
}

func (h Handler) copyResponse(dst http.ResponseWriter, src io.Reader, flushInterval time.Duration, logger *zap.Logger) error {
	var w io.Writer = dst

	if flushInterval != 0 {
		var mlwLogger *zap.Logger
		if h.VerboseLogs {
			mlwLogger = logger.Named("max_latency_writer")
		} else {
			mlwLogger = zap.NewNop()
		}
		mlw := &maxLatencyWriter{
			dst: dst,
			//nolint:bodyclose
			flush:   http.NewResponseController(dst).Flush,
			latency: flushInterval,
			logger:  mlwLogger,
		}
		defer mlw.stop()

		// set up initial timer so headers get flushed even if body writes are delayed
		mlw.flushPending = true
		mlw.t = time.AfterFunc(flushInterval, mlw.delayedFlush)

		w = mlw
	}

	buf := streamingBufPool.Get().(*[]byte)
	defer streamingBufPool.Put(buf)

	var copyLogger *zap.Logger
	if h.VerboseLogs {
		copyLogger = logger
	} else {
		copyLogger = zap.NewNop()
	}

	_, err := h.copyBuffer(w, src, *buf, copyLogger)
	return err
}

// copyBuffer returns any write errors or non-EOF read errors, and the amount
// of bytes written.
func (h Handler) copyBuffer(dst io.Writer, src io.Reader, buf []byte, logger *zap.Logger) (int64, error) {
	if len(buf) == 0 {
		buf = make([]byte, defaultBufferSize)
	}
	var written int64
	for {
		logger.Debug("waiting to read from upstream")
		nr, rerr := src.Read(buf)
		logger := logger.With(zap.Int("read", nr))
		if c := logger.Check(zapcore.DebugLevel, "read from upstream"); c != nil {
			c.Write(zap.Error(rerr))
		}
		if rerr != nil && rerr != io.EOF && rerr != context.Canceled {
			// TODO: this could be useful to know (indeed, it revealed an error in our
			// fastcgi PoC earlier; but it's this single error report here that necessitates
			// a function separate from io.CopyBuffer, since io.CopyBuffer does not distinguish
			// between read or write errors; in a reverse proxy situation, write errors are not
			// something we need to report to the client, but read errors are a problem on our
			// end for sure. so we need to decide what we want.)
			// p.logf("copyBuffer: ReverseProxy read error during body copy: %v", rerr)
			if c := logger.Check(zapcore.ErrorLevel, "reading from backend"); c != nil {
				c.Write(zap.Error(rerr))
			}
		}
		if nr > 0 {
			logger.Debug("writing to downstream")
			nw, werr := dst.Write(buf[:nr])
			if nw > 0 {
				written += int64(nw)
			}
			if c := logger.Check(zapcore.DebugLevel, "wrote to downstream"); c != nil {
				c.Write(
					zap.Int("written", nw),
					zap.Int64("written_total", written),
					zap.Error(werr),
				)
			}
			if werr != nil {
				return written, fmt.Errorf("writing: %w", werr)
			}
			if nr != nw {
				return written, io.ErrShortWrite
			}
		}
		if rerr != nil {
			if rerr == io.EOF {
				return written, nil
			}
			return written, fmt.Errorf("reading: %w", rerr)
		}
	}
}

// openConnection maps an open connection to an optional function for graceful
// close and records which upstream address the connection is proxying to.
type openConnection struct {
	conn          io.ReadWriteCloser
	gracefulClose func() error
	upstream      string
}

// tunnelState tracks hijacked/upgraded connections for selective cleanup.
type tunnelState struct {
	connections map[io.ReadWriteCloser]openConnection
	closeTimer  *time.Timer
	closeDelay  time.Duration
	mu          sync.Mutex
	logger      *zap.Logger
}

func newTunnelState(logger *zap.Logger, closeDelay time.Duration) *tunnelState {
	return &tunnelState{
		connections: make(map[io.ReadWriteCloser]openConnection),
		closeDelay:  closeDelay,
		logger:      logger,
	}
}

// registerConnection stores conn in the tracking map. The caller must invoke
// the returned del func when the connection is done.
func (ts *tunnelState) registerConnection(conn io.ReadWriteCloser, gracefulClose func() error, upstream string) (del func()) {
	ts.mu.Lock()
	ts.connections[conn] = openConnection{conn, gracefulClose, upstream}
	ts.mu.Unlock()
	return func() {
		ts.mu.Lock()
		delete(ts.connections, conn)
		if len(ts.connections) == 0 && ts.closeTimer != nil {
			if ts.closeTimer.Stop() {
				ts.logger.Debug("stopped streaming connections close timer - all connections are already closed")
			}
			ts.closeTimer = nil
		}
		ts.mu.Unlock()
	}
}

// closeConnections closes all tracked connections.
func (ts *tunnelState) closeConnections() error {
	var err error
	ts.mu.Lock()
	defer ts.mu.Unlock()
	for _, oc := range ts.connections {
		if oc.gracefulClose != nil {
			if gracefulErr := oc.gracefulClose(); gracefulErr != nil && err == nil {
				err = gracefulErr
			}
		}
		if closeErr := oc.conn.Close(); closeErr != nil && err == nil {
			err = closeErr
		}
	}
	return err
}

// cleanupConnections closes upgraded connections. Depending on closeDelay it
// does that either immediately or after a timer.
func (ts *tunnelState) cleanupConnections() error {
	if ts.closeDelay == 0 {
		return ts.closeConnections()
	}

	ts.mu.Lock()
	defer ts.mu.Unlock()
	if len(ts.connections) > 0 {
		delay := ts.closeDelay
		ts.closeTimer = time.AfterFunc(delay, func() {
			if c := ts.logger.Check(zapcore.DebugLevel, "closing streaming connections after delay"); c != nil {
				c.Write(zap.Duration("delay", delay))
			}
			err := ts.closeConnections()
			if err != nil {
				if c := ts.logger.Check(zapcore.ErrorLevel, "failed to close connections after delay"); c != nil {
					c.Write(
						zap.Error(err),
						zap.Duration("delay", delay),
					)
				}
			}
		})
	}
	return nil
}

// writeCloseControl sends a best-effort Close control message to the given
// WebSocket connection. Thanks to @pascaldekloe who provided inspiration
// from his simple implementation of this I was able to learn from at:
// github.com/pascaldekloe/websocket. Further work for handling masking
// taken from github.com/gorilla/websocket.
func writeCloseControl(conn io.Writer, isClient bool) error {
	// Sources:
	// https://github.com/pascaldekloe/websocket/blob/32050af67a5d/websocket.go#L119
	// https://github.com/gorilla/websocket/blob/v1.5.0/conn.go#L413

	// For now, we're not using a reason. We might later, though.
	// The code handling the reason is left in
	var reason string // max 123 bytes (control frame payload limit is 125; status code takes 2)

	const closeMessage = 8
	const finalBit = 1 << 7 // Frame header byte 0 bits from Section 5.2 of RFC 6455
	const maskBit = 1 << 7  // Frame header byte 1 bits from Section 5.2 of RFC 6455
	const goingAwayUpper uint8 = 1001 >> 8
	const goingAwayLower uint8 = 1001 & 0xff

	b0 := byte(closeMessage) | finalBit
	b1 := byte(len(reason) + 2)
	if isClient {
		b1 |= maskBit
	}

	buf := make([]byte, 0, 127)
	buf = append(buf, b0, b1)
	msgLength := 4 + len(reason)

	// Both branches below append the "going away" code and reason
	appendMessage := func(buf []byte) []byte {
		buf = append(buf, goingAwayUpper, goingAwayLower)
		buf = append(buf, []byte(reason)...)
		return buf
	}

	// When we're the client, we need to mask the message as per
	// https://www.rfc-editor.org/rfc/rfc6455#section-5.3
	if isClient {
		key := newMaskKey()
		buf = append(buf, key[:]...)
		msgLength += len(key)
		buf = appendMessage(buf)
		maskBytes(key, 0, buf[2+len(key):])
	} else {
		buf = appendMessage(buf)
	}

	// simply best-effort, but return error for logging purposes
	// TODO: we might need to ensure we are the exclusive writer by this point (io.Copy is stopped)?
	_, err := conn.Write(buf[:msgLength])
	return err
}

// Copied from https://github.com/gorilla/websocket/blob/v1.5.0/mask.go
func maskBytes(key [4]byte, pos int, b []byte) int {
	// Mask one byte at a time for small buffers.
	if len(b) < 2*wordSize {
		for i := range b {
			b[i] ^= key[pos&3]
			pos++
		}
		return pos & 3
	}

	// Mask one byte at a time to word boundary.
	if n := int(uintptr(unsafe.Pointer(&b[0]))) % wordSize; n != 0 {
		n = wordSize - n
		for i := range b[:n] {
			b[i] ^= key[pos&3]
			pos++
		}
		b = b[n:]
	}

	// Create aligned word size key.
	var k [wordSize]byte
	for i := range k {
		k[i] = key[(pos+i)&3] // nolint:gosec // false positive, impossible to be out of bounds; see: https://github.com/securego/gosec/issues/1525
	}
	kw := *(*uintptr)(unsafe.Pointer(&k))

	// Mask one word at a time.
	n := (len(b) / wordSize) * wordSize
	for i := 0; i < n; i += wordSize {
		*(*uintptr)(unsafe.Add(unsafe.Pointer(&b[0]), i)) ^= kw
	}

	// Mask one byte at a time for remaining bytes.
	b = b[n:]
	for i := range b {
		b[i] ^= key[pos&3]
		pos++
	}

	return pos & 3
}

// Copied from https://github.com/gorilla/websocket/blob/v1.5.0/conn.go#L184
func newMaskKey() [4]byte {
	n := weakrand.Uint32()
	return [4]byte{byte(n), byte(n >> 8), byte(n >> 16), byte(n >> 24)}
}

// isWebsocket returns true if r looks to be an upgrade request for WebSockets.
// It is a fairly naive check.
func isWebsocket(r *http.Request) bool {
	return httpguts.HeaderValuesContainsToken(r.Header["Connection"], "upgrade") &&
		httpguts.HeaderValuesContainsToken(r.Header["Upgrade"], "websocket")
}

// closeConnectionsForUpstream closes all tracked connections that were
// established to the given upstream address.
func (ts *tunnelState) closeConnectionsForUpstream(addr string) error {
	var err error
	ts.mu.Lock()
	defer ts.mu.Unlock()
	for _, oc := range ts.connections {
		if oc.upstream != addr {
			continue
		}
		if oc.gracefulClose != nil {
			if gracefulErr := oc.gracefulClose(); gracefulErr != nil && err == nil {
				err = gracefulErr
			}
		}
		if closeErr := oc.conn.Close(); closeErr != nil && err == nil {
			err = closeErr
		}
	}
	return err
}

type maxLatencyWriter struct {
	dst     io.Writer
	flush   func() error
	latency time.Duration // non-zero; negative means to flush immediately

	mu           sync.Mutex // protects t, flushPending, and dst.Flush
	t            *time.Timer
	flushPending bool
	logger       *zap.Logger
}

func (m *maxLatencyWriter) Write(p []byte) (n int, err error) {
	m.mu.Lock()
	defer m.mu.Unlock()
	n, err = m.dst.Write(p)
	if c := m.logger.Check(zapcore.DebugLevel, "wrote bytes"); c != nil {
		c.Write(zap.Int("n", n), zap.Error(err))
	}
	if m.latency < 0 {
		m.logger.Debug("flushing immediately")
		//nolint:errcheck
		m.flush()
		return n, err
	}
	if m.flushPending {
		m.logger.Debug("delayed flush already pending")
		return n, err
	}
	if m.t == nil {
		m.t = time.AfterFunc(m.latency, m.delayedFlush)
	} else {
		m.t.Reset(m.latency)
	}
	if c := m.logger.Check(zapcore.DebugLevel, "timer set for delayed flush"); c != nil {
		c.Write(zap.Duration("duration", m.latency))
	}
	m.flushPending = true
	return n, err
}

func (m *maxLatencyWriter) delayedFlush() {
	m.mu.Lock()
	defer m.mu.Unlock()
	if !m.flushPending { // if stop was called but AfterFunc already started this goroutine
		m.logger.Debug("delayed flush is not pending")
		return
	}
	m.logger.Debug("delayed flush")
	//nolint:errcheck
	m.flush()
	m.flushPending = false
}

func (m *maxLatencyWriter) stop() {
	m.mu.Lock()
	defer m.mu.Unlock()
	m.flushPending = false
	if m.t != nil {
		m.t.Stop()
	}
}

// switchProtocolCopier exists so goroutines proxying data back and
// forth have nice names in stacks.
type switchProtocolCopier struct {
	user, backend io.ReadWriteCloser
	wg            *sync.WaitGroup
	bufferSize    int
	// sent and received accumulate byte counts for each direction.
	// They are written before wg.Done() and read after wg.Wait(), so no
	// additional synchronization is needed beyond the WaitGroup barrier.
	sent     *int64 // bytes copied to backend; must be non-nil
	received *int64 // bytes copied from backend; must be non-nil
}

func (c switchProtocolCopier) copyFromBackend(errc chan<- error) {
	n, err := io.CopyBuffer(c.user, c.backend, c.buffer())
	*c.received = n
	errc <- err
	c.wg.Done()
}

func (c switchProtocolCopier) copyToBackend(errc chan<- error) {
	n, err := io.CopyBuffer(c.backend, c.user, c.buffer())
	*c.sent = n
	errc <- err
	c.wg.Done()
}

func (c switchProtocolCopier) buffer() []byte {
	size := c.bufferSize
	if size <= 0 {
		size = defaultBufferSize
	}
	return make([]byte, size)
}

var streamingBufPool = sync.Pool{
	New: func() any {
		// The Pool's New function should generally only return pointer
		// types, since a pointer can be put into the return interface
		// value without an allocation
		// - (from the package docs)
		b := make([]byte, defaultBufferSize)
		return &b
	},
}

const (
	defaultBufferSize = 32 * 1024
	wordSize          = int(unsafe.Sizeof(uintptr(0)))
)