config

Documentation

Index

• type Config
  • func DefaultConfig() Config
  • func Load(path string) (config *Config, err error)
• type DefaultVerifierProxyConfig
• type RegistrableComponentConfig
• type SignerConfig
• type SignerParams
• type SignerProxyConfig
• type URL
  • func (u URL) MarshalYAML() (interface{}, error)
  • func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error
• type VerifierConfig
• type VerifierProxyConfig
  • func (cfg *VerifierProxyConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

Types

type Config

type Config struct {
	SignerProxy     SignerProxyConfig     `yaml:"signer_proxy"`
	VerifierProxies []VerifierProxyConfig `yaml:"verifier_proxies"`
}

Config is the global configuration

func DefaultConfig

func DefaultConfig() Config

DefaultConfig is a configuration that can be used as a fallback value.

func Load

func Load(path string) (config *Config, err error)

Load is a shortcut to open a file, read it, and generate a Config. It supports relative and absolute paths. Given "", it returns DefaultConfig.

type DefaultVerifierProxyConfig

type DefaultVerifierProxyConfig VerifierProxyConfig

type RegistrableComponentConfig

type RegistrableComponentConfig struct {
	Type    string                 `yaml:"type"`
	Options map[string]interface{} `yaml:"options"`
}

type SignerConfig

type SignerConfig struct {
	SignerParams `yaml:",inline"`
	PrivateKey   RegistrableComponentConfig `yaml:"private_key"`
}

type SignerParams

type SignerParams struct {
	Issuer         string        `yaml:"issuer"`
	ExpirationTime time.Duration `yaml:"expiration_time"`
	MaxSkew        time.Duration `yaml:"max_skew"`
	NonceLength    int           `yaml:"nonce_length"`
}

type SignerProxyConfig

type SignerProxyConfig struct {
	Enabled             bool          `yaml:"enabled"`
	ListenAddr          string        `yaml:"listen_addr"`
	SocketPermission    os.FileMode   `yaml:"socket_permission"`
	ShutdownTimeout     time.Duration `yaml:"shutdown_timeout"`
	CAKeyFile           string        `yaml:"ca_key_file"`
	CACrtFile           string        `yaml:"ca_crt_file"`
	TrustedCertificates []string      `yaml:"trusted_certificates"`
	InsecureSkipVerify  bool          `yaml:"insecure_skip_verify"`
	Signer              SignerConfig  `yaml:"signer"`
}

type URL

type URL struct {
	*url.URL
}

URL is a custom URL type that allows validation at configuration load time.

func (URL) MarshalYAML

func (u URL) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface for URLs.

func (*URL) UnmarshalYAML

func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface for URLs.

type VerifierConfig

type VerifierConfig struct {
	Upstream        URL                          `yaml:"upstream"`
	Audience        URL                          `yaml:"audience"`
	MaxSkew         time.Duration                `yaml:"max_skew"`
	MaxTTL          time.Duration                `yaml:"max_ttl"`
	KeyServer       RegistrableComponentConfig   `yaml:"key_server"`
	NonceStorage    RegistrableComponentConfig   `yaml:"nonce_storage"`
	ClaimsVerifiers []RegistrableComponentConfig `yaml:"claims_verifiers"`
}

type VerifierProxyConfig

type VerifierProxyConfig struct {
	Enabled          bool           `yaml:"enabled"`
	ListenAddr       string         `yaml:"listen_addr"`
	SocketPermission os.FileMode    `yaml:"socket_permission"`
	ShutdownTimeout  time.Duration  `yaml:"shutdown_timeout"`
	CrtFile          string         `yaml:"crt_file"`
	KeyFile          string         `yaml:"key_file"`
	Verifier         VerifierConfig `yaml:"verifier"`
}

func (*VerifierProxyConfig) UnmarshalYAML

func (cfg *VerifierProxyConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface for URLs.