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 BasicAuth
• type CertAuth
• type Config
  • func (c *Config) Disabled() bool
  • func (c *Config) Enabled(mode Type) bool
  • func (c *Config) EnabledBasicAuth() bool
  • func (c *Config) EnabledBearerAuth() bool
  • func (c *Config) EnabledCustomAuth() bool
  • func (c *Config) EnabledOAuth() bool
  • func (c *Config) EnabledTLS() bool
  • func (c *Config) GetBearerToken() string
  • func (c *Config) ToAuthMeta() *AuthMeta
  • func (c *Config) Validate() error
• type CustomAuth
• type HTTPTransport
• type OAuth
• 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
}

AuthMeta is the metadata for the authentication types Deprecated: use Config instead

func GetAuthConfigs

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

type BasicAuth

type BasicAuth struct {
	Username string `keda:"name=username, order=authParams"`
	Password string `keda:"name=password, order=authParams"`
}

BasicAuth is a basic authentication type

type CertAuth

type CertAuth struct {
	Cert string `keda:"name=cert, order=authParams"`
	Key  string `keda:"name=key, order=authParams"`
	CA   string `keda:"name=ca, order=authParams"`
}

CertAuth is a client certificate authentication type

type Config

type Config struct {
	Modes []Type `` /* 130-byte string literal not displayed */

	BearerToken string `keda:"name=bearerToken, order=authParams, optional"`
	BasicAuth   `keda:"optional"`
	CertAuth    `keda:"optional"`
	OAuth       `keda:"optional"`
	CustomAuth  `keda:"optional"`
}

Config is the configuration for the authentication types

func (*Config) Disabled

func (c *Config) Disabled() bool

Disabled returns true if no auth modes are enabled

func (*Config) Enabled

func (c *Config) Enabled(mode Type) bool

Enabled returns true if given auth mode is enabled

func (*Config) EnabledBasicAuth

func (c *Config) EnabledBasicAuth() bool

func (*Config) EnabledBearerAuth

func (c *Config) EnabledBearerAuth() bool

func (*Config) EnabledCustomAuth

func (c *Config) EnabledCustomAuth() bool

func (*Config) EnabledOAuth

func (c *Config) EnabledOAuth() bool

func (*Config) EnabledTLS

func (c *Config) EnabledTLS() bool

helpers for checking enabled auth modes

func (*Config) GetBearerToken

func (c *Config) GetBearerToken() string

GetBearerToken returns the bearer token with the Bearer prefix

func (*Config) ToAuthMeta

func (c *Config) ToAuthMeta() *AuthMeta

ToAuthMeta converts the Config to deprecated AuthMeta

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the Config and returns an error if it is invalid

type CustomAuth

type CustomAuth struct {
	CustomAuthHeader string `keda:"name=customAuthHeader, order=authParams"`
	CustomAuthValue  string `keda:"name=customAuthValue,  order=authParams"`
}

CustomAuth is a custom header authentication type

type HTTPTransport

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

type OAuth

type OAuth struct {
	OauthTokenURI  string     `keda:"name=oauthTokenURI,  order=authParams"`
	Scopes         []string   `keda:"name=scopes,         order=authParams"`
	ClientID       string     `keda:"name=clientID,       order=authParams"`
	ClientSecret   string     `keda:"name=clientSecret,   order=authParams"`
	EndpointParams url.Values `keda:"name=endpointParams, order=authParams"`
}

OAuth is an oAuth2 authentication type

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"
)