Method apiClient

codersdk/workspacesdk/agentconn.go:1380–1429

apiClient returns an HTTP client that can be used to make requests to the workspace agent's HTTP API server.

()

// apiClient returns an HTTP client that can be used to make
// requests to the workspace agent's HTTP API server.
func (c *agentConn) apiClient() *http.Client {
	agentAddr := netip.AddrPortFrom(c.agentAddress(), AgentHTTPAPIServerPort)
	return &http.Client{
		// Redirects are blocked to prevent misuse.
		CheckRedirect: func(*http.Request, []*http.Request) error {
			return http.ErrUseLastResponse
		},
		Transport: &http.Transport{
			// Disable keep alives as we're usually only making a single
			// request, and this triggers goleak in tests
			DisableKeepAlives: true,
			DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) {
				if network != "tcp" {
					return nil, xerrors.Errorf("network must be tcp")
				}

				host, port, err := net.SplitHostPort(addr)
				if err != nil {
					return nil, xerrors.Errorf("split host port %q: %w", addr, err)
				}

				// Verify that the port is TailnetStatisticsPort.
				if port != strconv.Itoa(AgentHTTPAPIServerPort) {
					return nil, xerrors.Errorf("request %q does not appear to be for http api", addr)
				}

				if reqAddr, err := netip.ParseAddr(host); err != nil || reqAddr != agentAddr.Addr() {
					c.opts.Logger.Warn(ctx, "blocked workspace agent API request to unintended host",
						slog.F("agent_id", c.opts.AgentID),
						slog.F("request_host", host),
						slog.F("intended_agent_addr", agentAddr.Addr()),
					)
					return nil, xerrors.Errorf("request host %q does not match intended agent %q", host, agentAddr.Addr())
				}

				if !c.AwaitReachable(ctx) {
					return nil, xerrors.Errorf("workspace agent not reachable in time: %v", ctx.Err())
				}

				// Always dial the pinned agent address, never the request host.
				conn, err := c.Conn.DialContextTCP(ctx, agentAddr)
				if err != nil {
					return nil, xerrors.Errorf("dial http api: %w", err)
				}

				return conn, nil
			},
		},
	}
}

func (c *agentConn) GetPeerDiagnostics() tailnet.PeerDiagnostics {
	return c.Conn.GetPeerDiagnostics(c.opts.AgentID)