config

Documentation

Index

• type API
• type Backend
• type Behaviors
• type Capability
• type Config
• type Frontend
• type Group
• type Helper
• type LDAP
• type LDAPS
• type Tracing
• type User
• type UserAuthenticator

Types

type API

type API struct {
	Cert        string
	Enabled     bool
	Internals   bool
	Key         string
	Listen      string
	SecretToken string
	TLS         bool
}

config file

type Backend

type Backend struct {
	BaseDN                    string
	Datastore                 string
	Insecure                  bool     // For LDAP and owncloud backend only
	Servers                   []string // For LDAP and owncloud backend only
	NameFormat                string
	GroupFormat               string
	SSHKeyAttr                string
	UseGraphAPI               bool   // For ownCloud backend only
	Plugin                    string // Path to plugin library, for plugin backend only
	PluginHandler             string // Name of plugin's main handler function
	Database                  string // For Database backends only
	GroupWithSearchCapability string // For PamLinux backend only
	AnonymousDSE              bool   // For Config and Database backends only
}

config file

type Behaviors

type Behaviors struct {
	IgnoreCapabilities    bool
	LimitFailedBinds      bool
	NumberOfFailedBinds   int
	PeriodOfFailedBinds   time.Duration
	BlockFailedBindsFor   time.Duration
	PruneSourceTableEvery time.Duration
	PruneSourcesOlderThan time.Duration
	LegacyVersion         int
}

config file

type Capability

type Capability struct {
	Action string
	Object string
}

config file

type Config

type Config struct {
	API                API
	Backend            Backend // Deprecated
	Backends           []Backend
	Helper             Helper
	Behaviors          Behaviors
	Debug              bool
	Syslog             bool
	StructuredLog      bool
	WatchConfig        bool
	YubikeyClientID    string
	YubikeySecret      string
	Frontend           Frontend
	LDAP               LDAP
	LDAPS              LDAPS
	Groups             []Group
	Users              []User
	Tracing            Tracing
	ConfigFile         string
	AwsAccessKeyId     string
	AwsSecretAccessKey string
	AwsRegion          string
}

config file

type Frontend

type Frontend struct {
	AllowedBaseDNs []string // For LDAP backend only
	Listen         string
	Cert           string
	Key            string
	TLS            bool
}

config file

type Group

type Group struct {
	Name          string
	UnixID        int // TODO: remove after deprecating UnixID on User and Group
	GIDNumber     int
	IncludeGroups []int
}

config file

type Helper

type Helper struct {
	Enabled       bool
	BaseDN        string
	Datastore     string
	Plugin        string // Path to plugin library, for plugin backend only
	PluginHandler string // Name of plugin's main handler function
	Database      string // For MySQL backend only TODO REname to match plugin
}

config file

type LDAP

type LDAP struct {
	Enabled bool
	Listen  string
	// StartTLS parameters
	TLS         bool
	TLSCert     string
	TLSKey      string
	TLSCertPath string
	TLSKeyPath  string
}

config file

type LDAPS

type LDAPS struct {
	Enabled bool
	Listen  string
	Cert    string
	Key     string
}

config file

type Tracing

type Tracing struct {
	Enabled      bool
	GRPCEndpoint string
	HTTPEndpoint string
}

config file

type User

type User struct {
	Name          string
	OtherGroups   []int
	PassSHA256    string
	PassBcrypt    string
	PassAppSHA256 []string
	PassAppBcrypt []string
	PassAppCustom UserAuthenticator `toml:"-"`
	PrimaryGroup  int
	Capabilities  []Capability
	SSHKeys       []string
	OTPSecret     string
	Yubikey       string
	Disabled      bool
	UnixID        int // TODO: remove after deprecating UnixID on User and Group
	UIDNumber     int
	Mail          string
	LoginShell    string
	GivenName     string
	SN            string
	Homedir       string
	CustomAttrs   map[string]interface{}
}

config file

type UserAuthenticator

type UserAuthenticator func(user *User, pw string) error

UserAuthenticator authenticates a user via custom auth from a backend