config

Documentation

Index

• Constants
• Variables
• func FlagSet() *flag.FlagSet
• func IsURLEmpty(url *url.URL) bool
• func StringToTemplateHookFunc() mapstructure.DecodeHookFuncType
• func StringToURLHookFunc() mapstructure.DecodeHookFuncType
• func Validate(mode int, conf Config) error
• type Config
  • func Load(mode int, configFile string, flagSet *flag.FlagSet) (Config, error)
• type HTTP
• type HTTPCheck
• type Log
• type OAuth2
• type OAuth2Client
• type OAuth2Endpoints
• type OAuth2Validate
• type OpenVPNCommonName
• type OpenVPNCommonNameMode
  • func (s OpenVPNCommonNameMode) MarshalText() ([]byte, error)
  • func (s OpenVPNCommonNameMode) String() string
  • func (s *OpenVPNCommonNameMode) UnmarshalText(text []byte) error
• type OpenVpn
• type OpenVpnBypass

Constants

const (
	Plugin = iota
	ManagementClient
)

Variables

var Defaults = Config{
	Log: Log{
		Format: "console",
		Level:  "info",
	},
	HTTP: HTTP{
		BaseURL: &url.URL{
			Scheme: "http",
			Host:   "localhost:9000",
		},
		Listen: ":9000",
		TLS:    false,
		Check: HTTPCheck{
			IPAddr: false,
		},
	},
	OpenVpn: OpenVpn{
		Addr: &url.URL{
			Scheme:   "unix",
			Path:     "/run/openvpn/server.sock",
			OmitHost: true,
		},
		AuthTokenUser:      true,
		AuthPendingTimeout: 3 * time.Minute,
		CommonName: OpenVPNCommonName{
			Mode: CommonNameModePlain,
		},
		Bypass: OpenVpnBypass{
			CommonNames: make([]string, 0),
		},
	},
	OAuth2: OAuth2{
		Provider: "generic",
		Issuer:   &url.URL{Scheme: "", Host: ""},
		Endpoints: OAuth2Endpoints{
			Auth:      &url.URL{Scheme: "", Host: ""},
			Discovery: &url.URL{Scheme: "", Host: ""},
			Token:     &url.URL{Scheme: "", Host: ""},
		},
		Client: OAuth2Client{},
		Validate: OAuth2Validate{
			Groups: make([]string, 0),
			Roles:  make([]string, 0),
			IPAddr: false,
			Issuer: true,
		},
		Scopes: []string{},
	},
}

var ErrRequired = errors.New("required")

Functions

func FlagSet

func FlagSet() *flag.FlagSet

FlagSet configure the command line parser using the flag library.

func IsURLEmpty

func IsURLEmpty(url *url.URL) bool

func StringToTemplateHookFunc

func StringToTemplateHookFunc() mapstructure.DecodeHookFuncType

StringToTemplateHookFunc parse a string to template.Template.

func StringToURLHookFunc

func StringToURLHookFunc() mapstructure.DecodeHookFuncType

StringToURLHookFunc parse a string to url.URL.

func Validate

func Validate(mode int, conf Config) error

Validate validates the config.

Types

type Config

type Config struct {
	ConfigFile string  `koanf:"config"`
	Log        Log     `koanf:"log"`
	HTTP       HTTP    `koanf:"http"`
	OpenVpn    OpenVpn `koanf:"openvpn"`
	OAuth2     OAuth2  `koanf:"oauth2"`
}

func Load

func Load(mode int, configFile string, flagSet *flag.FlagSet) (Config, error)

type HTTP

type HTTP struct {
	Listen             string             `koanf:"listen"`
	CertFile           string             `koanf:"cert"`
	KeyFile            string             `koanf:"key"`
	TLS                bool               `koanf:"tls"`
	BaseURL            *url.URL           `koanf:"baseurl"`
	Secret             string             `koanf:"secret"`
	CallbackTemplate   *template.Template `koanf:"template"`
	Check              HTTPCheck          `koanf:"check"`
	EnableProxyHeaders bool               `koanf:"enable-proxy-headers"`
}

type HTTPCheck

type HTTPCheck struct {
	IPAddr bool `koanf:"ipaddr"`
}

type Log

type Log struct {
	Format string `koanf:"format"`
	Level  string `koanf:"level"`
}

type OAuth2

type OAuth2 struct {
	Issuer          *url.URL        `koanf:"issuer"`
	Provider        string          `koanf:"provider"`
	AuthorizeParams string          `koanf:"authorize-params"`
	Endpoints       OAuth2Endpoints `koanf:"endpoint"`
	Client          OAuth2Client    `koanf:"client"`
	Scopes          []string        `koanf:"scopes"`
	Pkce            bool            `koanf:"pkce"`
	Validate        OAuth2Validate  `koanf:"validate"`
}

type OAuth2Client

type OAuth2Client struct {
	ID     string `koanf:"id"`
	Secret string `koanf:"secret"`
}

type OAuth2Endpoints

type OAuth2Endpoints struct {
	Discovery *url.URL `koanf:"discovery"`
	Auth      *url.URL `koanf:"auth"`
	Token     *url.URL `koanf:"token"`
}

type OAuth2Validate

type OAuth2Validate struct {
	Groups     []string `koanf:"groups"`
	Roles      []string `koanf:"roles"`
	IPAddr     bool     `koanf:"ipaddr"`
	Issuer     bool     `koanf:"issuer"`
	CommonName string   `koanf:"common_name"`
}

type OpenVPNCommonName

type OpenVPNCommonName struct {
	Mode OpenVPNCommonNameMode `koanf:"mode"`
}

type OpenVPNCommonNameMode

type OpenVPNCommonNameMode int

const (
	CommonNameModePlain OpenVPNCommonNameMode = iota
	CommonNameModeOmit
	CommonNameModeOmitValue = "<omit>"
)

func (OpenVPNCommonNameMode) MarshalText

func (s OpenVPNCommonNameMode) MarshalText() ([]byte, error)

func (OpenVPNCommonNameMode) String

func (s OpenVPNCommonNameMode) String() string

func (*OpenVPNCommonNameMode) UnmarshalText

func (s *OpenVPNCommonNameMode) UnmarshalText(text []byte) error

type OpenVpn

type OpenVpn struct {
	Addr               *url.URL          `koanf:"addr"`
	Password           string            `koanf:"password"`
	Bypass             OpenVpnBypass     `koanf:"bypass"`
	AuthTokenUser      bool              `koanf:"auth-token-user"`
	AuthPendingTimeout time.Duration     `koanf:"auth-pending-timeout"`
	CommonName         OpenVPNCommonName `koanf:"common-name"`
}

type OpenVpnBypass

type OpenVpnBypass struct {
	CommonNames []string `koanf:"cn"`
}