middleware

Documentation

Index

• Variables
• func AddAuthenticationHeader(authenticator auth.Authenticator, config configuration.Configuration, ...) error
• func ApplyTlsConfig(transport *http.Transport, insecure bool, caPool *x509.CertPool) *http.Transport
• func ConfigureProxy(transport *http.Transport, logger *zerolog.Logger, ...) *http.Transport
• func HandleResponse(res *http.Response, config configuration.Configuration) error
• func ShouldRequireAuthentication(apiUrl string, url *url.URL, additionalSubdomains []string, ...) (matchesPattern bool, err error)
• type AuthHeaderMiddleware
  • func NewAuthHeaderMiddleware(config configuration.Configuration, authenticator auth.Authenticator, ...) *AuthHeaderMiddleware
  • func (n *AuthHeaderMiddleware) RoundTrip(request *http.Request) (*http.Response, error)
• type ResponseMiddleware
  • func NewReponseMiddleware(roundTriper http.RoundTripper, config configuration.Configuration, ...) *ResponseMiddleware
  • func (rm ResponseMiddleware) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var ErrAuthenticationFailed = fmt.Errorf("authentication failed")

ErrAuthenticationFailed indicates that authentication failed in the networking middleware.

Functions

func AddAuthenticationHeader

func AddAuthenticationHeader(
	authenticator auth.Authenticator,
	config configuration.Configuration,
	request *http.Request,
) error

AddAuthenticationHeader determines whether a request needs authentication, negotiates authorization and sets request headers if necessary.

If this fails due to an authentication error, the resulting error will match ErrAuthenticationFailed.

func ApplyTlsConfig

func ApplyTlsConfig(transport *http.Transport, insecure bool, caPool *x509.CertPool) *http.Transport

func ConfigureProxy

func ConfigureProxy(
	transport *http.Transport,
	logger *zerolog.Logger,
	proxy func(req *http.Request) (*url.URL, error),
	authenticationMechanism httpauth.AuthenticationMechanism,
) *http.Transport

func HandleResponse

func HandleResponse(res *http.Response, config configuration.Configuration) error

HandleResponse maps the response param to the eror catalog error.

func ShouldRequireAuthentication

func ShouldRequireAuthentication(
	apiUrl string,
	url *url.URL,
	additionalSubdomains []string,
	additionalUrls []string,
) (matchesPattern bool, err error)

Types

type AuthHeaderMiddleware

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

func NewAuthHeaderMiddleware

func NewAuthHeaderMiddleware(
	config configuration.Configuration,
	authenticator auth.Authenticator,
	roundTripper http.RoundTripper,
) *AuthHeaderMiddleware

func (*AuthHeaderMiddleware) RoundTrip

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

type ResponseMiddleware

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

func NewReponseMiddleware

func NewReponseMiddleware(roundTriper http.RoundTripper, config configuration.Configuration, errHandler networktypes.ErrorHandlerFunc) *ResponseMiddleware

func (ResponseMiddleware) RoundTrip

func (rm ResponseMiddleware) RoundTrip(req *http.Request) (*http.Response, error)