httputil

Documentation

Index

• func NewClient(ctx context.Context, localOnly bool) (*http.Client, error)
• func NewRequestWithContext(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)
• func RateLimiter(next http.RoundTripper) http.RoundTripper
• type Signer
  • func NewSigner(ctx context.Context, cfg *config.Config, cl jwt.Claims) (*Signer, error)
  • func (s *Signer) Add(ctx context.Context, uri string) error
  • func (s *Signer) Sign(ctx context.Context, req *http.Request) error

Functions

func NewClient

func NewClient(ctx context.Context, localOnly bool) (*http.Client, error)

NewClient constructs an http.Client that disallows access to public networks, controlled by the localOnly flag.

If disallowed, the reported error will be a *net.AddrError with the "Err" value of "disallowed by policy".

func NewRequestWithContext

func NewRequestWithContext(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)

NewRequestWithContext is a wrapper around http.NewRequestWithContext that sets some defaults in the returned request.

func RateLimiter

func RateLimiter(next http.RoundTripper) http.RoundTripper

RateLimiter wraps the provided RoundTripper with a limiter allowing 10 requests/second/host.

It responds to HTTP 429 responses by automatically decreasing the rate.

Types

type Signer

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

Signer signs requests.

func NewSigner

func NewSigner(ctx context.Context, cfg *config.Config, cl jwt.Claims) (*Signer, error)

NewSigner constructs a signer according to the provided Config and claim.

The returned Signer only adds headers for the hosts specified in the following spots:

• $.notifier.webhook.target
• $.notifier.indexer_addr
• $.notifier.matcher_addr
• $.matcher.indexer_addr

func (*Signer) Add

func (s *Signer) Add(ctx context.Context, uri string) error

Add marks the authority in "uri" as one that expects signed requests.

func (*Signer) Sign

func (s *Signer) Sign(ctx context.Context, req *http.Request) error

Sign modifies the passed http.Request as needed.