config

Documentation

Index

• type AuthnSettings
  • func GatherSettings(conf Configuration, getters ...func(key string) string) AuthnSettings
• type Configuration
  • func ConfigFromEnv(readFileFunc common.ReadFileFunc) (Configuration, error)
  • func NewConfigFromCustomEnv(readFileFunc common.ReadFileFunc, customEnv func(key string) string) (Configuration, error)
  • func NewConfigFromEnv() (Configuration, error)

Types

type AuthnSettings

type AuthnSettings map[string]string

AuthnSettings represents a group of authenticator client configuration settings.

func GatherSettings

func GatherSettings(conf Configuration, getters ...func(key string) string) AuthnSettings

GatherSettings retrieves authenticator client configuration settings from a slice of arbitrary `func(key string) string` functions. Values received from 'Getter' functions are prioritized in the order that the functions are provided.

type Configuration

type Configuration interface {
	LoadConfig(settings map[string]string)
	GetEnvVariables() []string
	GetRequiredVariables() []string
	GetDefaultValues() map[string]string
	GetContainerMode() string
	GetTokenFilePath() string
	GetTokenTimeout() time.Duration
}

Configuration defines interface for Configuration of an authentication flow

func ConfigFromEnv

func ConfigFromEnv(readFileFunc common.ReadFileFunc) (Configuration, error)

ConfigFromEnv returns a new authenticator configuration object

func NewConfigFromCustomEnv

func NewConfigFromCustomEnv(readFileFunc common.ReadFileFunc, customEnv func(key string) string) (Configuration, error)

func NewConfigFromEnv

func NewConfigFromEnv() (Configuration, error)

NewConfigFromEnv returns a config ConfigFromEnv using the standard file reader for reading certs