authentication

Documentation

Index

• Constants
• func CreateHTTPRoundTripper(roundTripperType TransportType, auth *AuthMeta, conf ...*HTTPTransport) (rt http.RoundTripper, err error)
• func GetBearerToken(auth *AuthMeta) string
• func NewTLSConfig(auth *AuthMeta, unsafeSsl bool) (*tls.Config, error)
• func ParseEndpointParams(inputStr string) (url.Values, error)
• func ParseScope(inputStr string) []string
• type AuthMeta
  • func GetAuthConfigs(triggerMetadata, authParams map[string]string) (out *AuthMeta, err error)
• type HTTPTransport
• type TransportType
• type Type

Constants

const (
	AuthModesKey = "authModes"
)

Functions

func CreateHTTPRoundTripper

func CreateHTTPRoundTripper(roundTripperType TransportType, auth *AuthMeta, conf ...*HTTPTransport) (rt http.RoundTripper, err error)

func GetBearerToken

func GetBearerToken(auth *AuthMeta) string

func NewTLSConfig

func NewTLSConfig(auth *AuthMeta, unsafeSsl bool) (*tls.Config, error)

func ParseEndpointParams

func ParseEndpointParams(inputStr string) (url.Values, error)

ParseEndpointParams parse OAuth endpoint params from URL-encoded query string.

func ParseScope

func ParseScope(inputStr string) []string

ParseScope parse OAuth scopes from a comma separated string whitespace is trimmed

Types

type AuthMeta

type AuthMeta struct {
	// bearer auth
	EnableBearerAuth bool
	BearerToken      string

	// basic auth
	EnableBasicAuth bool
	Username        string
	Password        string // +optional

	// client certification
	EnableTLS bool
	Cert      string
	Key       string
	CA        string

	// oAuth2
	EnableOAuth    bool
	OauthTokenURI  string
	Scopes         []string
	ClientID       string
	ClientSecret   string
	EndpointParams url.Values

	// custom auth header
	EnableCustomAuth bool
	CustomAuthHeader string
	CustomAuthValue  string
}

func GetAuthConfigs

func GetAuthConfigs(triggerMetadata, authParams map[string]string) (out *AuthMeta, err error)

type HTTPTransport

type HTTPTransport struct {
	MaxIdleConnDuration time.Duration
	ReadTimeout         time.Duration
	WriteTimeout        time.Duration
}

type TransportType

type TransportType int

TransportType is type of http transport

const (
	NetHTTP  TransportType = iota // NetHTTP standard Go net/http client.
	FastHTTP                      // FastHTTP Fast http client.
)

type Type

type Type string

Type describes the authentication type used in a scaler

const (
	// APIKeyAuthType is an auth type using an API key
	APIKeyAuthType Type = "apiKey"
	// BasicAuthType is an auth type using basic auth
	BasicAuthType Type = "basic"
	// TLSAuthType is an auth type using TLS
	TLSAuthType Type = "tls"
	// BearerAuthType is an auth type using a bearer token
	BearerAuthType Type = "bearer"
	// CustomAuthType is an auth type using a custom header
	CustomAuthType Type = "custom"
	// OAuthType is an auth type using a oAuth2
	OAuthType Type = "oauth"
)