config

Documentation

Index

• func Load()
• func LoadForSetup()
• type Config
  • func Get() *Config
• type DBConf
  • func (conf *DBConf) GetPassword() string
• type LoggerConf
• type ProviderConf
• type ServiceOperatorConf

Functions

func Load

func Load()

Load reads the config file and populates the Config struct; then validates the Config

func LoadForSetup

func LoadForSetup()

LoadForSetup reads the config file and populates the Config struct; it does not validate the Config, since this is not required for setup

Types

type Config

type Config struct {
	IssuerURL            string                   `yaml:"issuer"`
	Host                 string                   // Extracted from the IssuerURL
	Server               serverConf               `yaml:"server"`
	GeoIPDBFile          string                   `yaml:"geo_ip_db_file"`
	API                  apiConf                  `yaml:"api"`
	DB                   DBConf                   `yaml:"database"`
	Signing              signingConf              `yaml:"signing"`
	Logging              loggingConf              `yaml:"logging"`
	ServiceDocumentation string                   `yaml:"service_documentation"`
	Features             featuresConf             `yaml:"features"`
	Providers            []*ProviderConf          `yaml:"providers"`
	ProviderByIssuer     map[string]*ProviderConf `yaml:"-"`
	ServiceOperator      ServiceOperatorConf      `yaml:"service_operator"`
}

Config holds the server configuration

func Get

func Get() *Config

Get returns the Config

type DBConf

type DBConf struct {
	Hosts                  []string `yaml:"hosts"`
	User                   string   `yaml:"user"`
	Password               string   `yaml:"password"`
	PasswordFile           string   `yaml:"password_file"`
	DB                     string   `yaml:"db"`
	ReconnectInterval      int64    `yaml:"try_reconnect_interval"`
	EnableScheduledCleanup bool     `yaml:"schedule_cleanup"`
}

DBConf is type for holding configuration for a db

func (*DBConf) GetPassword

func (conf *DBConf) GetPassword() string

GetPassword returns the password for this database config. If necessary it reads it from the password file.

type LoggerConf

type LoggerConf struct {
	Dir    string `yaml:"dir"`
	StdErr bool   `yaml:"stderr"`
	Level  string `yaml:"level"`
}

LoggerConf holds configuration related to logging

type ProviderConf

type ProviderConf struct {
	Issuer                   string             `yaml:"issuer"`
	ClientID                 string             `yaml:"client_id"`
	ClientSecret             string             `yaml:"client_secret"`
	Scopes                   []string           `yaml:"scopes"`
	MytokensMaxLifetime      int64              `yaml:"mytokens_max_lifetime"`
	Endpoints                *oauth2x.Endpoints `yaml:"-"`
	Provider                 *oidc.Provider     `yaml:"-"`
	Name                     string             `yaml:"name"`
	AudienceRequestParameter string             `yaml:"audience_request_parameter"`
}

ProviderConf holds information about a provider

type ServiceOperatorConf

type ServiceOperatorConf struct {
	Name     string `yaml:"name"`
	Homepage string `yaml:"homepage"`
	Contact  string `yaml:"mail_contact"`
	Privacy  string `yaml:"mail_privacy"`
}

ServiceOperatorConf is type holding the configuration for the service operator of this mytoken instance