proxy

Documentation

Index

• Constants
• type CacheControl
  • func MakeCacheControl(cacheOpts []string) (*CacheControl, error)
  • func NewCacheControl(defaultAge time.Duration) *CacheControl
  • func (c *CacheControl) AddMime(m string, d time.Duration)
  • func (c *CacheControl) Middleware(next http.Handler) http.Handler
• type ErrorReporter
  • func (em *ErrorReporter) Report(w http.ResponseWriter, code int)
• type FailoverSelector
  • func (r *FailoverSelector) Select(_ int) int
• type Http
  • func (h *Http) Run(ctx context.Context) error
• type LBSelector
• type LBSelectorFunc
  • func (f LBSelectorFunc) Select(n int) int
• type Matcher
• type MatcherMock
  • func (mock *MatcherMock) CheckHealth() map[string]error
  • func (mock *MatcherMock) CheckHealthCalls() []struct{}
  • func (mock *MatcherMock) Mappers() []discovery.URLMapper
  • func (mock *MatcherMock) MappersCalls() []struct{}
  • func (mock *MatcherMock) Match(srv string, src string) discovery.Matches
  • func (mock *MatcherMock) MatchCalls() []struct{ ... }
  • func (mock *MatcherMock) Servers() []string
  • func (mock *MatcherMock) ServersCalls() []struct{}
• type MiddlewareProvider
• type OFLookup
• type OnlyFrom
  • func NewOnlyFrom(lookups ...OFLookup) *OnlyFrom
  • func (o *OnlyFrom) Handler(next http.Handler) http.Handler
• type RandomSelector
  • func (r *RandomSelector) Select(n int) int
• type Reporter
• type RoundRobinSelector
  • func (r *RoundRobinSelector) Select(n int) int
• type SSLConfig
• type Timeouts

Constants

const (
	// SSLNone defines to run http server only
	SSLNone sslMode = iota

	// SSLStatic defines to run both https and http server. Redirect http to https
	SSLStatic

	// SSLAuto defines to run both https and http server. Redirect http to https. Https server with autocert support
	SSLAuto
)

Types

type CacheControl

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

CacheControl sets Cache-Control response header with different ages for different mimes

func MakeCacheControl

func MakeCacheControl(cacheOpts []string) (*CacheControl, error)

MakeCacheControl creates CacheControl from the list of params. the first param represents default age and can be just a duration string (i.e. 60h) or "default:60h" all other params are mime:duration pairs, i.e. "text/html:30s"

func NewCacheControl

func NewCacheControl(defaultAge time.Duration) *CacheControl

NewCacheControl creates NewCacheControl with the default max age

func (*CacheControl) AddMime

func (c *CacheControl) AddMime(m string, d time.Duration)

AddMime sets max age for a given mime

func (*CacheControl) Middleware

func (c *CacheControl) Middleware(next http.Handler) http.Handler

Middleware checks if mime custom age set and returns it if matched to content type from resource (file) extension. fallback to default if nothing matched

type ErrorReporter

type ErrorReporter struct {
	Template string
	Nice     bool
	// contains filtered or unexported fields
}

ErrorReporter formats error with a given template Supports go-style template with {{.ErrMessage}} and {{.ErrCode}}

func (*ErrorReporter) Report

func (em *ErrorReporter) Report(w http.ResponseWriter, code int)

Report formats and sends error to ResponseWriter

type FailoverSelector

type FailoverSelector struct{}

FailoverSelector is a selector with failover, thread-safe

func (*FailoverSelector) Select

func (r *FailoverSelector) Select(_ int) int

Select returns next backend index

type Http

type Http struct {
	Matcher
	Address          string
	AssetsLocation   string
	AssetsWebRoot    string
	Assets404        string
	AssetsSPA        bool
	MaxBodySize      int64
	GzEnabled        bool
	ProxyHeaders     []string
	DropHeader       []string
	SSLConfig        SSLConfig
	Insecure         bool
	Version          string
	AccessLog        io.Writer
	StdOutEnabled    bool
	Signature        bool
	Timeouts         Timeouts
	CacheControl     MiddlewareProvider
	Metrics          MiddlewareProvider
	PluginConductor  MiddlewareProvider
	Reporter         Reporter
	LBSelector       LBSelector
	OnlyFrom         *OnlyFrom
	BasicAuthEnabled bool
	BasicAuthAllowed []string

	ThrottleSystem int
	ThrottleUser   int

	KeepHost bool
}

Http is a proxy server for both http and https

func (*Http) Run

func (h *Http) Run(ctx context.Context) error

Run the lister and request's router, activate rest server

type LBSelector

type LBSelector interface {
	Select(len int) int // return index of picked server
}

LBSelector defines load balancer strategy

type LBSelectorFunc

type LBSelectorFunc func(n int) int

LBSelectorFunc is a functional adapted for LBSelector to select backend from the list

func (LBSelectorFunc) Select

func (f LBSelectorFunc) Select(n int) int

Select returns backend index

type Matcher

type Matcher interface {
	Match(srv, src string) (res discovery.Matches)
	Servers() (servers []string)
	Mappers() (mappers []discovery.URLMapper)
	CheckHealth() (pingResult map[string]error)
}

Matcher source info (server and route) to the destination url If no match found return ok=false

type MatcherMock

type MatcherMock struct {
	// CheckHealthFunc mocks the CheckHealth method.
	CheckHealthFunc func() map[string]error

	// MappersFunc mocks the Mappers method.
	MappersFunc func() []discovery.URLMapper

	// MatchFunc mocks the Match method.
	MatchFunc func(srv string, src string) discovery.Matches

	// ServersFunc mocks the Servers method.
	ServersFunc func() []string
	// contains filtered or unexported fields
}

MatcherMock is a mock implementation of Matcher.

func TestSomethingThatUsesMatcher(t *testing.T) {

	// make and configure a mocked Matcher
	mockedMatcher := &MatcherMock{
		CheckHealthFunc: func() map[string]error {
			panic("mock out the CheckHealth method")
		},
		MappersFunc: func() []discovery.URLMapper {
			panic("mock out the Mappers method")
		},
		MatchFunc: func(srv string, src string) discovery.Matches {
			panic("mock out the Match method")
		},
		ServersFunc: func() []string {
			panic("mock out the Servers method")
		},
	}

	// use mockedMatcher in code that requires Matcher
	// and then make assertions.

}

func (*MatcherMock) CheckHealth

func (mock *MatcherMock) CheckHealth() map[string]error

CheckHealth calls CheckHealthFunc.

func (*MatcherMock) CheckHealthCalls

func (mock *MatcherMock) CheckHealthCalls() []struct {
}

CheckHealthCalls gets all the calls that were made to CheckHealth. Check the length with:

len(mockedMatcher.CheckHealthCalls())

func (*MatcherMock) Mappers

func (mock *MatcherMock) Mappers() []discovery.URLMapper

Mappers calls MappersFunc.

func (*MatcherMock) MappersCalls

func (mock *MatcherMock) MappersCalls() []struct {
}

MappersCalls gets all the calls that were made to Mappers. Check the length with:

len(mockedMatcher.MappersCalls())

func (*MatcherMock) Match

func (mock *MatcherMock) Match(srv string, src string) discovery.Matches

Match calls MatchFunc.

func (*MatcherMock) MatchCalls

func (mock *MatcherMock) MatchCalls() []struct {
	Srv string
	Src string
}

MatchCalls gets all the calls that were made to Match. Check the length with:

len(mockedMatcher.MatchCalls())

func (*MatcherMock) Servers

func (mock *MatcherMock) Servers() []string

Servers calls ServersFunc.

func (*MatcherMock) ServersCalls

func (mock *MatcherMock) ServersCalls() []struct {
}

ServersCalls gets all the calls that were made to Servers. Check the length with:

len(mockedMatcher.ServersCalls())

type MiddlewareProvider

type MiddlewareProvider interface {
	Middleware(next http.Handler) http.Handler
}

MiddlewareProvider interface defines http middleware handler

type OFLookup

type OFLookup string

OFLookup defines lookup method for source IP.

const (
	OFRemoteAddr OFLookup = "remote-addr"
	OFRealIP     OFLookup = "real-ip"
	OFForwarded  OFLookup = "forwarded"
)

enum of possible lookup methods

type OnlyFrom

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

OnlyFrom implements middleware to allow access for a limited list of source IPs.

func NewOnlyFrom

func NewOnlyFrom(lookups ...OFLookup) *OnlyFrom

NewOnlyFrom creates OnlyFrom middleware with given lookup methods.

func (*OnlyFrom) Handler

func (o *OnlyFrom) Handler(next http.Handler) http.Handler

Handler implements middleware interface.

type RandomSelector

type RandomSelector struct{}

RandomSelector is a random selector, thread-safe

func (*RandomSelector) Select

func (r *RandomSelector) Select(n int) int

Select returns random backend index

type Reporter

type Reporter interface {
	Report(w http.ResponseWriter, code int)
}

Reporter defines error reporting service

type RoundRobinSelector

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

RoundRobinSelector is a simple round-robin selector, thread-safe

func (*RoundRobinSelector) Select

func (r *RoundRobinSelector) Select(n int) int

Select returns next backend index

type SSLConfig

type SSLConfig struct {
	SSLMode       sslMode
	Cert          string
	Key           string
	ACMELocation  string
	ACMEEmail     string
	FQDNs         []string
	RedirHTTPPort int
}

SSLConfig holds all ssl params for rest server

type Timeouts

type Timeouts struct {
	// server timeouts
	ReadHeader time.Duration
	Write      time.Duration
	Idle       time.Duration
	// transport timeouts
	Dial           time.Duration
	KeepAlive      time.Duration
	IdleConn       time.Duration
	TLSHandshake   time.Duration
	ExpectContinue time.Duration
	ResponseHeader time.Duration
}

Timeouts consolidate timeouts for both server and transport