Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 // e.g. cn, ou, uid, or a comma separated list of them
NameFormatAsArray []string // we will explode NameFormat on commas
GroupFormat string // e.g. cn, ou, gid, or a comma separated list of them
GroupFormatAsArray []string // we will explode GroupFormat on commas
SSHKeyAttr string
UseGraphAPI bool // For ownCloud backend only
Database string // For Database backends only
DatabaseType string // Type of database: sqlite, mysql, postgres (for database datastore)
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 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
Capabilities []Capability
IncludeGroups []int
}
config file
type Helper ¶
type Helper struct {
Enabled bool
BaseDN string
Datastore string
Database string // For database backends only
}
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 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 ¶
UserAuthenticator authenticates a user via custom auth from a backend
Click to show internal directories.
Click to hide internal directories.