httpx

Documentation

Index

• Variables
• func ClientIP(r *http.Request) string
• func DisallowIPPrivateAddresses(ipOrHostnameOrURL string) error
• func DisallowPrivateIPAddressesWhenSet(ipOrHostnameOrURL string) error
• func GetClientIPAddressesWithoutInternalIPs(ipAddresses []string) (string, error)
• func GetResponseMeta(w http.ResponseWriter) (status, size int)
• func HasContentType(r *http.Request, mimetypes ...string) bool
• func IncomingRequestURL(r *http.Request) *url.URL
• func MustNewRequest(method, url string, body io.Reader, contentType string) *http.Request
• func NewChanHandler(buf int) (http.Handler, chan<- http.HandlerFunc)
• func NewRequestForm(method, url string, data url.Values) (*http.Request, error)
• func NewRequestJSON(method, url string, data interface{}) (*http.Request, error)
• func NewResilientClient(opts ...ResilientOptions) *retryablehttp.Client
• func WaitForEndpoint(ctx context.Context, endpoint string, opts ...retry.Option) error
• func WaitForEndpointWithClient(ctx context.Context, client *http.Client, endpoint string, ...) error
• type CompressionRequestReader
  • func NewCompressionRequestReader(eh func(w http.ResponseWriter, r *http.Request, err error)) *CompressionRequestReader
  • func (c *CompressionRequestReader) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type ErrPrivateIPAddressDisallowed
• type NoInternalIPRoundTripper
  • func (n NoInternalIPRoundTripper) RoundTrip(request *http.Request) (*http.Response, error)
• type ResilientOptions
  • func ResilientClientAllowInternalIPRequestsTo(urls ...string) ResilientOptions
  • func ResilientClientDisallowInternalIPs() ResilientOptions
  • func ResilientClientWithClient(c *http.Client) ResilientOptions
  • func ResilientClientWithConnectionTimeout(connTimeout time.Duration) ResilientOptions
  • func ResilientClientWithLogger(l *logrusx.Logger) ResilientOptions
  • func ResilientClientWithMaxRetry(retryMax int) ResilientOptions
  • func ResilientClientWithMaxRetryWait(retryWaitMax time.Duration) ResilientOptions
  • func ResilientClientWithMinxRetryWait(retryWaitMin time.Duration) ResilientOptions
  • func ResilientClientWithTracer(tracer trace.Tracer) ResilientOptions
• type TransportWithHeader
  • func NewTransportWithHeader(h http.Header) *TransportWithHeader
  • func WrapTransportWithHeader(parent http.RoundTripper, h http.Header) *TransportWithHeader
  • func (ct *TransportWithHeader) RoundTrip(req *http.Request) (*http.Response, error)
• type TransportWithHost
  • func NewTransportWithHost(host string) *TransportWithHost
  • func WrapRoundTripperWithHost(parent http.RoundTripper, host string) *TransportWithHost
  • func (ct *TransportWithHost) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var NoInternalDialer = &net.Dialer{
	Timeout:   30 * time.Second,
	KeepAlive: 30 * time.Second,
	Control: func(network, address string, _ syscall.RawConn) error {
		if !(network == "tcp4" || network == "tcp6") {
			return ErrPrivateIPAddressDisallowed(fmt.Errorf("%s is not a safe network type", network))
		}

		host, _, err := net.SplitHostPort(address)
		if err != nil {
			return ErrPrivateIPAddressDisallowed(fmt.Errorf("%s is not a valid host/port pair: %s", address, err))
		}

		ip := net.ParseIP(host)
		if ip == nil {
			return ErrPrivateIPAddressDisallowed(fmt.Errorf("%s is not a valid IP address", host))
		}

		if ip.IsPrivate() || ip.IsLoopback() || ip.IsUnspecified() {
			return ErrPrivateIPAddressDisallowed(fmt.Errorf("%s is not a public IP address", ip))
		}

		return nil
	},
}

var NoInternalTransport http.RoundTripper = &http.Transport{
	Proxy:                 http.ProxyFromEnvironment,
	DialContext:           NoInternalDialer.DialContext,
	ForceAttemptHTTP2:     true,
	MaxIdleConns:          100,
	IdleConnTimeout:       90 * time.Second,
	TLSHandshakeTimeout:   10 * time.Second,
	ExpectContinueTimeout: 1 * time.Second,
}

Functions

func ClientIP

func ClientIP(r *http.Request) string

func DisallowIPPrivateAddresses

func DisallowIPPrivateAddresses(ipOrHostnameOrURL string) error

DisallowIPPrivateAddresses returns nil for a domain (with NS lookup), IP, or IPv6 address if it does not resolve to a private IP subnet. This is a first level of defense against SSRF attacks by disallowing any domain or IP to resolve to a private network range.

Please keep in mind that validations for domains is valid only when looking up. A malicious actor could easily update the DSN record post validation to point to an internal IP

func DisallowPrivateIPAddressesWhenSet

func DisallowPrivateIPAddressesWhenSet(ipOrHostnameOrURL string) error

DisallowPrivateIPAddressesWhenSet is a wrapper for DisallowIPPrivateAddresses which returns valid when ipOrHostnameOrURL is empty.

func GetClientIPAddressesWithoutInternalIPs

func GetClientIPAddressesWithoutInternalIPs(ipAddresses []string) (string, error)

func GetResponseMeta

func GetResponseMeta(w http.ResponseWriter) (status, size int)

func HasContentType

func HasContentType(r *http.Request, mimetypes ...string) bool

HasContentType determines whether the request `content-type` includes a server-acceptable mime-type

Failure should yield an HTTP 415 (`http.StatusUnsupportedMediaType`)

func IncomingRequestURL

func IncomingRequestURL(r *http.Request) *url.URL

IncomingRequestURL returns the URL of the incoming HTTP request by looking at the host, TLS, and X-Forwarded-* headers.

func MustNewRequest

func MustNewRequest(method, url string, body io.Reader, contentType string) *http.Request

MustNewRequest returns a new *http.Request or fatals.

func NewChanHandler

func NewChanHandler(buf int) (http.Handler, chan<- http.HandlerFunc)

NewChanHandler returns a new handler and corresponding channel for sending handler funcs. Useful for testing. The argument buf specifies the channel capacity, so pass 0 for a sync handler.

func NewRequestForm

func NewRequestForm(method, url string, data url.Values) (*http.Request, error)

NewRequestForm returns a new POST Form *http.Request.

func NewRequestJSON

func NewRequestJSON(method, url string, data interface{}) (*http.Request, error)

NewRequestJSON returns a new JSON *http.Request.

func NewResilientClient

func NewResilientClient(opts ...ResilientOptions) *retryablehttp.Client

NewResilientClient creates a new ResilientClient.

func WaitForEndpoint

func WaitForEndpoint(ctx context.Context, endpoint string, opts ...retry.Option) error

WaitForEndpoint waits for the endpoint to be available.

func WaitForEndpointWithClient

func WaitForEndpointWithClient(ctx context.Context, client *http.Client, endpoint string, opts ...retry.Option) error

WaitForEndpointWithClient waits for the endpoint to be available while using the given http.Client.

Types

type CompressionRequestReader

type CompressionRequestReader struct {
	ErrHandler func(w http.ResponseWriter, r *http.Request, err error)
}

func NewCompressionRequestReader

func NewCompressionRequestReader(eh func(w http.ResponseWriter, r *http.Request, err error)) *CompressionRequestReader

func (*CompressionRequestReader) ServeHTTP

func (c *CompressionRequestReader) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type ErrPrivateIPAddressDisallowed

type ErrPrivateIPAddressDisallowed error

ErrPrivateIPAddressDisallowed is returned when a private IP address is disallowed.

type NoInternalIPRoundTripper

type NoInternalIPRoundTripper struct {
	// contains filtered or unexported fields
}

NoInternalIPRoundTripper is a RoundTripper that disallows internal IP addresses.

func (NoInternalIPRoundTripper) RoundTrip

func (n NoInternalIPRoundTripper) RoundTrip(request *http.Request) (*http.Response, error)

type ResilientOptions

type ResilientOptions func(o *resilientOptions)

ResilientOptions is a set of options for the ResilientClient.

func ResilientClientAllowInternalIPRequestsTo

func ResilientClientAllowInternalIPRequestsTo(urls ...string) ResilientOptions

ResilientClientAllowInternalIPRequestsTo allows requests to the exact matching URLs even if they are internal IPs.

func ResilientClientDisallowInternalIPs

func ResilientClientDisallowInternalIPs() ResilientOptions

ResilientClientDisallowInternalIPs disallows internal IPs from being used.

func ResilientClientWithClient

func ResilientClientWithClient(c *http.Client) ResilientOptions

ResilientClientWithClient sets the underlying http client to use.

func ResilientClientWithConnectionTimeout

func ResilientClientWithConnectionTimeout(connTimeout time.Duration) ResilientOptions

ResilientClientWithConnectionTimeout sets the connection timeout for the client.

func ResilientClientWithLogger

func ResilientClientWithLogger(l *logrusx.Logger) ResilientOptions

ResilientClientWithLogger sets the logger to be used by the client.

func ResilientClientWithMaxRetry

func ResilientClientWithMaxRetry(retryMax int) ResilientOptions

ResilientClientWithMaxRetry sets the maximum number of retries.

func ResilientClientWithMaxRetryWait

func ResilientClientWithMaxRetryWait(retryWaitMax time.Duration) ResilientOptions

ResilientClientWithMaxRetryWait sets the maximum wait time for a retry.

func ResilientClientWithMinxRetryWait

func ResilientClientWithMinxRetryWait(retryWaitMin time.Duration) ResilientOptions

ResilientClientWithMinxRetryWait sets the minimum wait time between retries.

func ResilientClientWithTracer

func ResilientClientWithTracer(tracer trace.Tracer) ResilientOptions

ResilientClientWithTracer wraps the http clients transport with a tracing instrumentation

type TransportWithHeader

type TransportWithHeader struct {
	http.RoundTripper
	// contains filtered or unexported fields
}

TransportWithHeader is an http.RoundTripper that always uses the values from the given header.

func NewTransportWithHeader

func NewTransportWithHeader(h http.Header) *TransportWithHeader

NewTransportWithHeader returns a new http.Transport that always uses the values from the given header.

func WrapTransportWithHeader

func WrapTransportWithHeader(parent http.RoundTripper, h http.Header) *TransportWithHeader

WrapTransportWithHeader wraps a http.Transport to always use the values from the given header.

func (*TransportWithHeader) RoundTrip

func (ct *TransportWithHeader) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper.

type TransportWithHost

type TransportWithHost struct {
	http.RoundTripper
	// contains filtered or unexported fields
}

TransportWithHost is an http.RoundTripper that always uses the given host.

func NewTransportWithHost

func NewTransportWithHost(host string) *TransportWithHost

NewTransportWithHost returns a new http.Transport that always uses the given host.

func WrapRoundTripperWithHost

func WrapRoundTripperWithHost(parent http.RoundTripper, host string) *TransportWithHost

WrapRoundTripperWithHost wraps a http.RoundTripper that always uses the given host.

func (*TransportWithHost) RoundTrip

func (ct *TransportWithHost) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper.