config

func (*Backend) Get ¶

func (b *Backend) Get() definitions.Backend

Get gets the name of a password Database.

func (*Backend) GetName ¶ added in v1.5.0

func (b *Backend) GetName() string

GetName returns the name of the Backend instance or an empty string if the instance is nil.

func (*Backend) Set ¶

func (b *Backend) Set(value string) error

Set updates the backend of the Backend based on the provided value. It returns an error if the value is not valid. Valid values for the backend are "cache", "ldap" and "lua". If the value is valid, the backend field of Backend is updated accordingly. An error of type ErrWrongPassDB is returned if the value is not valid.

func (*Backend) String ¶

func (b *Backend) String() string

func (*Backend) Type ¶

func (b *Backend) Type() string

Type returns the name of the type.

func (*BackendServer) GetHost ¶ added in v1.7.7

func (n *BackendServer) GetHost() string

GetHost retrieves the host value from the BackendServer. Returns an empty string if the BackendServer is nil.

func (*BackendServer) GetPort ¶ added in v1.7.7

func (n *BackendServer) GetPort() int

GetPort retrieves the port number from the BackendServer. Returns 0 if the BackendServer is nil.

func (*BackendServer) GetProtocol ¶ added in v1.7.7

func (n *BackendServer) GetProtocol() string

GetProtocol retrieves the protocol value from the BackendServer. Returns an empty string if the BackendServer is nil.

func (*BackendServer) GetRequestURI ¶ added in v1.7.7

func (n *BackendServer) GetRequestURI() string

GetRequestURI retrieves the request URI from the BackendServer. Returns an empty string if the BackendServer is nil.

func (*BackendServer) GetTestPassword ¶ added in v1.7.7

func (n *BackendServer) GetTestPassword() string

GetTestPassword retrieves the test password from the BackendServer. Returns an empty string if the BackendServer is nil.

func (*BackendServer) GetTestUsername ¶ added in v1.7.7

func (n *BackendServer) GetTestUsername() string

GetTestUsername retrieves the test username from the BackendServer. Returns an empty string if the BackendServer is nil.

func (*BackendServer) IsDeepCheck ¶ added in v1.7.7

func (n *BackendServer) IsDeepCheck() bool

IsDeepCheck checks if deep checking is enabled for the BackendServer. Returns false if the BackendServer is nil.

func (*BackendServer) IsHAProxyV2 ¶ added in v1.7.7

func (n *BackendServer) IsHAProxyV2() bool

IsHAProxyV2 checks if HAProxy protocol version 2 is enabled for the BackendServer. Returns false if the BackendServer is nil.

func (*BackendServer) IsTLS ¶ added in v1.7.7

func (n *BackendServer) IsTLS() bool

IsTLS checks if TLS is enabled for the BackendServer. Returns false if the BackendServer is nil.

func (*BackendServer) IsTLSSkipVerify ¶ added in v1.7.7

func (n *BackendServer) IsTLSSkipVerify() bool

IsTLSSkipVerify checks if TLS verification should be skipped for the BackendServer. Returns false if the BackendServer is nil.

func (*BackendServer) String ¶

func (n *BackendServer) String() string

func (*BackendServerMonitoring) GetBackendServers ¶ added in v1.7.7

func (n *BackendServerMonitoring) GetBackendServers() []*BackendServer

GetBackendServers retrieves the list of backend servers from the BackendServerMonitoring. Returns an empty slice if the BackendServerMonitoring is nil.

func (*BackendServerMonitoring) String ¶ added in v1.3.5

func (n *BackendServerMonitoring) String() string

func (*BasicAuth) GetPassword ¶ added in v1.4.11

func (b *BasicAuth) GetPassword() string

GetPassword retrieves the password for the BasicAuth configuration. Returns an empty string if the BasicAuth is nil.

func (*BasicAuth) GetUsername ¶ added in v1.4.11

func (b *BasicAuth) GetUsername() string

GetUsername returns the username configured for basic HTTP authentication. Returns an empty string if the BasicAuth is nil.

func (*BasicAuth) IsEnabled ¶ added in v1.4.11

func (b *BasicAuth) IsEnabled() bool

IsEnabled returns true if basic HTTP authentication is enabled, otherwise false. Returns false if the BasicAuth is nil.

func (*BruteForceRule) GetCIDR ¶ added in v1.7.7

func (b *BruteForceRule) GetCIDR() uint

GetCIDR retrieves the CIDR value for the brute force rule. Returns 0 if the BruteForceRule is nil.

func (*BruteForceRule) GetFailedRequests ¶ added in v1.7.7

func (b *BruteForceRule) GetFailedRequests() uint

GetFailedRequests retrieves the number of failed requests threshold for the brute force rule. Returns 0 if the BruteForceRule is nil.

func (*BruteForceRule) GetFilterByOIDCCID ¶ added in v1.7.7

func (b *BruteForceRule) GetFilterByOIDCCID() []string

GetFilterByOIDCCID retrieves the list of OIDC client IDs to filter by for the brute force rule. Returns an empty slice if the BruteForceRule is nil.

func (*BruteForceRule) GetFilterByProtocol ¶ added in v1.7.7

func (b *BruteForceRule) GetFilterByProtocol() []string

GetFilterByProtocol retrieves the list of protocols to filter by for the brute force rule. Returns an empty slice if the BruteForceRule is nil.

func (*BruteForceRule) GetName ¶ added in v1.7.7

func (b *BruteForceRule) GetName() string

GetName retrieves the name of the brute force rule. Returns an empty string if the BruteForceRule is nil.

func (*BruteForceRule) GetPeriod ¶ added in v1.7.7

func (b *BruteForceRule) GetPeriod() time.Duration

GetPeriod retrieves the period duration for the brute force rule. Returns 0 if the BruteForceRule is nil.

func (*BruteForceRule) IsIPv4 ¶ added in v1.7.7

func (b *BruteForceRule) IsIPv4() bool

IsIPv4 checks if the brute force rule is configured for IPv4. Returns false if the BruteForceRule is nil.

func (*BruteForceRule) IsIPv6 ¶ added in v1.7.7

func (b *BruteForceRule) IsIPv6() bool

IsIPv6 checks if the brute force rule is configured for IPv6. Returns false if the BruteForceRule is nil.

func (*BruteForceRule) String ¶ added in v1.4.9

func (b *BruteForceRule) String() string

func (*BruteForceSection) GetAdaptiveToleration ¶ added in v1.7.7

func (b *BruteForceSection) GetAdaptiveToleration() bool

GetAdaptiveToleration retrieves the AdaptiveToleration value from the BruteForceSection instance. Returns false if the receiver is nil.

func (*BruteForceSection) GetBuckets ¶ added in v1.7.7

func (b *BruteForceSection) GetBuckets() []BruteForceRule

GetBuckets retrieves the list of brute force rules from the BruteForceSection. Returns an empty slice if the BruteForceSection is nil.

func (*BruteForceSection) GetColdStartGraceEnabled ¶ added in v1.9.10

func (b *BruteForceSection) GetColdStartGraceEnabled() bool

GetColdStartGraceEnabled tells whether the one-time cold-start grace is enabled.

func (*BruteForceSection) GetColdStartGraceTTL ¶ added in v1.9.10

func (b *BruteForceSection) GetColdStartGraceTTL() time.Duration

GetColdStartGraceTTL returns the TTL for the cold-start grace. Defaults to 120s if not set or invalid.

func (*BruteForceSection) GetCustomTolerations ¶ added in v1.5.1

func (b *BruteForceSection) GetCustomTolerations() []Tolerate

GetCustomTolerations returns the CustomTolerations slice from the BruteForceSection. Returns an empty slice if the receiver is nil.

func (*BruteForceSection) GetIPScoping ¶ added in v1.9.4

func (b *BruteForceSection) GetIPScoping() IPScoping

GetIPScoping returns the IPScoping settings or a zero-value if not present.

func (*BruteForceSection) GetIPWhitelist ¶ added in v1.7.7

func (b *BruteForceSection) GetIPWhitelist() []string

GetIPWhitelist retrieves the IP whitelist from the BruteForceSection. Returns an empty slice if the BruteForceSection is nil.

func (*BruteForceSection) GetMaxToleratePercent ¶ added in v1.7.7

func (b *BruteForceSection) GetMaxToleratePercent() uint8

GetMaxToleratePercent retrieves the MaxToleratePercent value from the BruteForceSection instance. Returns 50 as default if not set or if the receiver is nil.

func (*BruteForceSection) GetMinToleratePercent ¶ added in v1.7.7

func (b *BruteForceSection) GetMinToleratePercent() uint8

GetMinToleratePercent retrieves the MinToleratePercent value from the BruteForceSection instance. Returns 10 as default if not set or if the receiver is nil.

func (*BruteForceSection) GetPWHistKnownAccountsOnlyOnAlreadyTriggered ¶ added in v1.9.4

func (b *BruteForceSection) GetPWHistKnownAccountsOnlyOnAlreadyTriggered() bool

GetPWHistKnownAccountsOnlyOnAlreadyTriggered returns whether per-account PW_HIST should be limited to known accounts (no username fallback) when a request is already cached-blocked. Supports both the new short key (pw_hist_known_cached) and the legacy long key (pw_hist_known_accounts_only_on_already_triggered) for backward compatibility.

func (*BruteForceSection) GetRWPAllowedUniqueHashes ¶ added in v1.10.0

func (b *BruteForceSection) GetRWPAllowedUniqueHashes() uint

GetRWPAllowedUniqueHashes returns how many distinct wrong password hashes are tolerated within the window. Defaults to 3 if not set or if the receiver is nil.

func (*BruteForceSection) GetRWPIPv6CIDR ¶ added in v1.9.4

func (b *BruteForceSection) GetRWPIPv6CIDR() uint

GetRWPIPv6CIDR returns the CIDR to use for IPv6 in the repeating-wrong-password context (0 disables).

func (*BruteForceSection) GetRWPWindow ¶ added in v1.10.0

func (b *BruteForceSection) GetRWPWindow() time.Duration

GetRWPWindow returns the time window for tracking tolerated unique wrong password hashes. Defaults to 15 minutes if not set or invalid.

func (*BruteForceSection) GetScaleFactor ¶ added in v1.7.7

func (b *BruteForceSection) GetScaleFactor() float64

GetScaleFactor retrieves the ScaleFactor value from the BruteForceSection instance. Returns 1.0 as default if not set or if the receiver is nil.

func (*BruteForceSection) GetSoftWhitelist ¶ added in v1.7.7

func (b *BruteForceSection) GetSoftWhitelist() SoftWhitelist

GetSoftWhitelist retrieves the SoftWhitelist from the BruteForceSection. Returns an empty map if the BruteForceSection is nil.

func (*BruteForceSection) GetToleratePercent ¶ added in v1.5.1

func (b *BruteForceSection) GetToleratePercent() uint8

GetToleratePercent retrieves the ToleratePercent value from the BruteForceSection instance. Returns 0 if the receiver is nil.

func (*BruteForceSection) GetTolerateTTL ¶ added in v1.5.1

func (b *BruteForceSection) GetTolerateTTL() time.Duration

GetTolerateTTL retrieves the TolerateTTL value from the BruteForceSection instance. Returns 0 if the receiver is nil.

func (*BruteForceSection) GetTolerationsIPv6CIDR ¶ added in v1.9.4

func (b *BruteForceSection) GetTolerationsIPv6CIDR() uint

GetTolerationsIPv6CIDR returns the CIDR to use for IPv6 in the tolerations context (0 disables).

func (*BruteForceSection) LearnFromFeature ¶ added in v1.3.5

func (b *BruteForceSection) LearnFromFeature(input string) bool

LearnFromFeature checks if the given feature is present in the Learning slice of the BruteForceSection. It returns true if the feature is found, otherwise false.

func (*BruteForceSection) String ¶

func (b *BruteForceSection) String() string

func (*Cluster) GetAddresses ¶ added in v1.4.11

func (c *Cluster) GetAddresses() []string

GetAddresses retrieves the list of Redis cluster addresses configured in the Cluster instance. Returns an empty slice if the Cluster is nil.

func (*Cluster) GetMaxRedirects ¶ added in v1.7.1

func (c *Cluster) GetMaxRedirects() int

GetMaxRedirects returns the maximum number of redirects to follow. Returns 0 if the Cluster is nil.

func (*Cluster) GetPassword ¶ added in v1.4.11

func (c *Cluster) GetPassword() string

GetPassword retrieves the password configured for the Redis cluster. Returns an empty string if the Cluster is nil.

func (*Cluster) GetReadOnly ¶ added in v1.7.1

func (c *Cluster) GetReadOnly() bool

GetReadOnly returns whether read-only commands should be allowed from replicas. Returns false if the Cluster is nil. Deprecated: Use GetRouteReadsToReplicas instead.

func (*Cluster) GetReadTimeout ¶ added in v1.7.1

func (c *Cluster) GetReadTimeout() time.Duration

GetReadTimeout returns the timeout for read operations. Returns 0 if the Cluster is nil.

func (*Cluster) GetRouteByLatency ¶ added in v1.7.1

func (c *Cluster) GetRouteByLatency() bool

GetRouteByLatency returns whether commands should be routed to the closest node. Returns false if the Cluster is nil.

func (*Cluster) GetRouteRandomly ¶ added in v1.7.1

func (c *Cluster) GetRouteRandomly() bool

GetRouteRandomly returns whether commands should be routed randomly across nodes. Returns false if the Cluster is nil.

func (*Cluster) GetRouteReadsToReplicas ¶ added in v1.7.11

func (c *Cluster) GetRouteReadsToReplicas() bool

GetRouteReadsToReplicas returns whether read commands should be routed to replica nodes. Returns false if the Cluster is nil.

func (*Cluster) GetUsername ¶ added in v1.4.11

func (c *Cluster) GetUsername() string

GetUsername retrieves the username configured for the Redis cluster. Returns an empty string if the Cluster is nil.

func (*Cluster) GetWriteTimeout ¶ added in v1.7.1

func (c *Cluster) GetWriteTimeout() time.Duration

GetWriteTimeout returns the timeout for write operations. Returns 0 if the Cluster is nil.

func (*Compression) GetAlgorithms ¶ added in v1.9.8

func (c *Compression) GetAlgorithms() []string

GetAlgorithms returns the enabled compression algorithms in order of preference. Returns an empty slice if the Compression is nil.

func (*Compression) GetContentTypes ¶ added in v1.7.3

func (c *Compression) GetContentTypes() []string

GetContentTypes returns the list of content types that should be compressed. Returns an empty slice if the Compression is nil.

func (*Compression) GetLevel ¶ added in v1.7.3

func (c *Compression) GetLevel() int

GetLevel returns the (deprecated) gzip compression level (1-9). Deprecated: Use GetLevelGzip() instead. This remains for backward compatibility. Returns 0 if the Compression is nil.

func (*Compression) GetLevelBrotli ¶ added in v1.9.9

func (c *Compression) GetLevelBrotli() int

GetLevelBrotli returns the configured Brotli compression level (1-11). Returns 0 if the Compression is nil.

func (*Compression) GetLevelGzip ¶ added in v1.9.8

func (c *Compression) GetLevelGzip() int

GetLevelGzip returns the configured gzip compression level (1-9). If LevelGzip is not set (>0), it falls back to the deprecated Level field for backward compatibility. Returns 0 if the Compression is nil.

func (*Compression) GetLevelZstd ¶ added in v1.9.8

func (c *Compression) GetLevelZstd() int

GetLevelZstd returns the configured zstd compression level mapping. Returns 0 if the Compression is nil.

func (*Compression) GetMinLength ¶ added in v1.7.3

func (c *Compression) GetMinLength() int

GetMinLength returns the minimum content length required for compression. Returns 0 if the Compression is nil.

func (*Compression) IsEnabled ¶ added in v1.7.3

func (c *Compression) IsEnabled() bool

IsEnabled returns true if compression is enabled, otherwise false. Returns false if the Compression is nil.

func (*DNS) GetResolveClientIP ¶ added in v1.4.11

func (d *DNS) GetResolveClientIP() bool

GetResolveClientIP returns the value of the ResolveClientIP field indicating whether client IP resolution is enabled. Returns false if the DNS is nil.

func (*DNS) GetResolver ¶ added in v1.4.11

func (d *DNS) GetResolver() string

GetResolver returns the configured DNS resolver address as a string. Returns an empty string if the DNS is nil.

func (*DNS) GetTimeout ¶ added in v1.4.11

func (d *DNS) GetTimeout() time.Duration

GetTimeout returns the timeout duration configured for the DNS resolver. Returns 0 if the DNS is nil.

func (*DbgModule) Get ¶

func (d *DbgModule) Get() string

Get returns the name of the `DbgModule` instance. The name represents the current debug module. It can be used to identify the debug module when needed.

func (*DbgModule) GetModule ¶

func (d *DbgModule) GetModule() definitions.DbgModule

GetModule returns the `module` field of the `DbgModule` struct. It is used to retrieve the current debug module.

Usage:

module := d.GetModule()

Example:

func main() {
  dbg := &DbgModule{}
  module := dbg.GetModule()
  fmt.Println(module) // Output: 0
}

func (*DbgModule) Set ¶

func (d *DbgModule) Set(value string) error

Set updates the debug module based on the provided value. It returns an error if the value is not valid. Valid values for the debug module are "none", "all", "auth", "hydra", "webauthn", "statistics", "whitelist", "ldap", "ldappool", "sql", "cache", "bf", "rbl", "action", "feature", and "lua". If the value is valid, the module and name fields are updated accordingly. An error of type ErrWrongDebugModule is returned if the value is not valid.

func (*DbgModule) String ¶

func (d *DbgModule) String() string

func (*DbgModule) Type ¶

func (d *DbgModule) Type() string

Type returns the type of the DbgModule, which is always "DebugModule".

func (*Dedup) IsDistributedEnabled ¶ added in v1.10.0

func (d *Dedup) IsDistributedEnabled() bool

IsDistributedEnabled reports whether distributed (Redis) deduplication is enabled. Deprecated: Distributed deduplication has been removed; this always returns false.

func (*Dedup) IsInProcessEnabled ¶ added in v1.10.0

func (d *Dedup) IsInProcessEnabled() bool

IsInProcessEnabled reports whether in-process singleflight deduplication is enabled. Default is true unless explicitly configured.

func (*DefaultHTTPRequestHeader) GetAuthMethod ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetAuthMethod() string

GetAuthMethod retrieves the authentication method value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetClientHost ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetClientHost() string

GetClientHost retrieves the client host value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetClientID ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetClientID() string

GetClientID retrieves the client identifier from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetClientIP ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetClientIP() string

GetClientIP retrieves the client's IP address from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetClientPort ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetClientPort() string

GetClientPort retrieves the client port value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetLocalIP ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetLocalIP() string

GetLocalIP retrieves the local IP address from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetLocalPort ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetLocalPort() string

GetLocalPort retrieves the local port value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetLoginAttempt ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetLoginAttempt() string

GetLoginAttempt retrieves the login attempt value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetOIDCCID ¶ added in v1.7.5

func (d *DefaultHTTPRequestHeader) GetOIDCCID() string

GetOIDCCID retrieves the OIDC Client ID value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetPassword ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetPassword() string

GetPassword retrieves the password value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetPasswordEncoded ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetPasswordEncoded() string

GetPasswordEncoded retrieves the encoded password value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetProtocol ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetProtocol() string

GetProtocol retrieves the protocol value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSL ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSL() string

GetSSL retrieves the SSL value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLCipher ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLCipher() string

GetSSLCipher retrieves the SSL cipher value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLClientCN ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLClientCN() string

GetSSLClientCN retrieves the Common Name (CN) from the SSL client certificate in the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLClientIssuerDN ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLClientIssuerDN() string

GetSSLClientIssuerDN retrieves the SSL client issuer distinguished name (DN) from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLClientNotAfter ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLClientNotAfter() string

GetSSLClientNotAfter retrieves the SSL client certificate expiration date from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLClientNotBefore ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLClientNotBefore() string

GetSSLClientNotBefore retrieves the SSL client certificate start date from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLClientSubjectDN ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLClientSubjectDN() string

GetSSLClientSubjectDN retrieves the SSL client subject distinguished name (DN) from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLFingerprint ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLFingerprint() string

GetSSLFingerprint retrieves the SSL fingerprint value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLIssuer ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLIssuer() string

GetSSLIssuer retrieves the SSL issuer value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLIssuerDN ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLIssuerDN() string

GetSSLIssuerDN retrieves the SSL issuer distinguished name (DN) from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLProtocol ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLProtocol() string

GetSSLProtocol retrieves the SSL protocol value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLSerial ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLSerial() string

GetSSLSerial retrieves the SSL serial number from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLSessionID ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLSessionID() string

GetSSLSessionID retrieves the SSL session ID from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLSubject ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLSubject() string

GetSSLSubject retrieves the SSL subject value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLSubjectDN ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLSubjectDN() string

GetSSLSubjectDN retrieves the SSL subject distinguished name (DN) from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetSSLVerify ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetSSLVerify() string

GetSSLVerify retrieves the SSL verification setting from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*DefaultHTTPRequestHeader) GetUsername ¶ added in v1.4.11

func (d *DefaultHTTPRequestHeader) GetUsername() string

GetUsername retrieves the username value from the DefaultHTTPRequestHeader struct. Returns an empty string if the DefaultHTTPRequestHeader is nil.

func (*Endpoint) IsAuthBasicDisabled ¶ added in v1.7.0

func (e *Endpoint) IsAuthBasicDisabled() bool

IsAuthBasicDisabled checks if Basic authentication is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsAuthHeaderDisabled ¶ added in v1.7.0

func (e *Endpoint) IsAuthHeaderDisabled() bool

IsAuthHeaderDisabled checks if header-based authentication is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsAuthJSONDisabled ¶ added in v1.7.0

func (e *Endpoint) IsAuthJSONDisabled() bool

IsAuthJSONDisabled checks if JSON-based authentication is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsAuthJWTDisabled ¶ added in v1.7.0

func (e *Endpoint) IsAuthJWTDisabled() bool

IsAuthJWTDisabled checks if JWT authentication is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsAuthNginxDisabled ¶ added in v1.7.0

func (e *Endpoint) IsAuthNginxDisabled() bool

IsAuthNginxDisabled checks if Nginx-based authentication is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsAuthSASLAuthdDisabled ¶ added in v1.7.0

func (e *Endpoint) IsAuthSASLAuthdDisabled() bool

IsAuthSASLAuthdDisabled checks if SASL authentication is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsConfigurationDisabled ¶ added in v1.7.11

func (e *Endpoint) IsConfigurationDisabled() bool

IsConfigurationDisabled checks if the configuration setting is enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*Endpoint) IsCustomHooksDisabled ¶ added in v1.7.0

func (e *Endpoint) IsCustomHooksDisabled() bool

IsCustomHooksDisabled checks if custom hooks are enabled for the endpoint and returns the corresponding boolean value. Returns false if the Endpoint is nil.

func (*EnvironmentSettings) GetDevMode ¶ added in v1.4.10

func (env *EnvironmentSettings) GetDevMode() bool

GetDevMode returns the DevMode value, indicating whether the application is running in developer mode.

func (*EnvironmentSettings) GetIMAPBackendAddress ¶ added in v1.4.10

func (env *EnvironmentSettings) GetIMAPBackendAddress() string

GetIMAPBackendAddress retrieves the address of the IMAP backend server from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetIMAPBackendPort ¶ added in v1.4.10

func (env *EnvironmentSettings) GetIMAPBackendPort() int

GetIMAPBackendPort retrieves the port of the IMAP backend server from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetLocalCacheAuthTTL ¶ added in v1.4.10

func (env *EnvironmentSettings) GetLocalCacheAuthTTL() time.Duration

GetLocalCacheAuthTTL retrieves the time-to-live duration for local cache authentication from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetMaxLoginAttempts ¶ added in v1.4.10

func (env *EnvironmentSettings) GetMaxLoginAttempts() uint8

GetMaxLoginAttempts retrieves the maximum allowed number of login attempts from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetPOP3BackendAddress ¶ added in v1.4.10

func (env *EnvironmentSettings) GetPOP3BackendAddress() string

GetPOP3BackendAddress retrieves the address of the POP3 backend server from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetPOP3BackendPort ¶ added in v1.4.10

func (env *EnvironmentSettings) GetPOP3BackendPort() int

GetPOP3BackendPort retrieves the port of the POP3 backend server from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetSMTPBackendAddress ¶ added in v1.4.10

func (env *EnvironmentSettings) GetSMTPBackendAddress() string

GetSMTPBackendAddress retrieves the address of the SMTP backend server from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetSMTPBackendPort ¶ added in v1.4.10

func (env *EnvironmentSettings) GetSMTPBackendPort() int

GetSMTPBackendPort retrieves the port of the SMTP backend server from the EnvironmentSettings instance.

func (*EnvironmentSettings) GetWaitDelay ¶ added in v1.4.10

func (env *EnvironmentSettings) GetWaitDelay() uint8

GetWaitDelay retrieves the wait delay in seconds between connection attempts from the EnvironmentSettings instance.

func (*EnvironmentSettings) String ¶ added in v1.4.10

func (env *EnvironmentSettings) String() string

String returns the name of the Config object excluding the HTTPOptions.

func (*Feature) Get ¶

func (f *Feature) Get() string

Get gets the name of a feature returned as string.

func (*Feature) Set ¶

func (f *Feature) Set(value string) error

Set updates the feature name based on the provided value. It returns an error if the value is not a valid feature name. Valid feature names are "tls_encryption", "rbl", "relay_domains", and "lua". If the value is valid, the name field of the Feature struct is updated accordingly. An error of type ErrWrongFeature is returned if the value is not valid.

func (*Feature) String ¶

func (f *Feature) String() string

func (*Feature) Type ¶

func (f *Feature) Type() string

Type returns the name of the type.

func (*FileSettings) GetAllProtocols ¶ added in v1.4.10

func (f *FileSettings) GetAllProtocols() []string

GetAllProtocols returns a unique slice of strings (a Set) for all defined protocols in the database search sections. Returns an empty slice if the FileSettings is nil.

func (*FileSettings) GetAuthMethod ¶ added in v1.4.10

func (f *FileSettings) GetAuthMethod() string

GetAuthMethod returns the HTTP request header for the auth mechanism LOGIN or PLAIN

func (*FileSettings) GetBackendServer ¶ added in v1.4.10

func (f *FileSettings) GetBackendServer(protocol string) *BackendServer

GetBackendServer retrieves the first BackendServer that matches the specified protocol from the FileSettings's backend servers. Returns an empty BackendServer if no matching server is found or if the FileSettings object is nil.

func (*FileSettings) GetBackendServerMonitoring ¶ added in v1.4.10

func (f *FileSettings) GetBackendServerMonitoring() *BackendServerMonitoring

GetBackendServerMonitoring is a method on the FileSettings struct. It returns the BackendServerMonitoring field from the FileSettings struct. Returns an empty BackendServerMonitoring if the FileSettings is nil or if the BackendServerMonitoring field is nil.

func (*FileSettings) GetBackendServers ¶ added in v1.4.10

func (f *FileSettings) GetBackendServers() []*BackendServer

GetBackendServers retrieves the list of backend servers for the FileSettings instance or returns an empty list if none are configured.

func (*FileSettings) GetBruteForce ¶ added in v1.4.10

func (f *FileSettings) GetBruteForce() *BruteForceSection

GetBruteForce returns the BruteForceSection associated with the FileSettings instance. Returns nil if the instance is nil.

func (*FileSettings) GetBruteForceRules ¶ added in v1.4.10

func (f *FileSettings) GetBruteForceRules() []BruteForceRule

GetBruteForceRules retrieves the list of brute force rules defined in the configuration file. If no rules are defined or the FileSettings instance is nil, it returns an empty slice.

func (*FileSettings) GetClearTextList ¶ added in v1.4.10

func (f *FileSettings) GetClearTextList() []string

GetClearTextList retrieves a list of clear text strings from the FileSettings instance. Returns nil if the FileSettings instance is nil.

func (*FileSettings) GetClientHost ¶ added in v1.4.10

func (f *FileSettings) GetClientHost() string

GetClientHost returns the HTTP request header used to retrieve an optional client hostname

func (*FileSettings) GetClientID ¶ added in v1.4.10

func (f *FileSettings) GetClientID() string

GetClientID returns the HTTP request header used to retrieve an optional client ID

func (*FileSettings) GetClientIP ¶ added in v1.4.10

func (f *FileSettings) GetClientIP() string

GetClientIP returns the HTTP request header that holds the client IP of the request

func (*FileSettings) GetClientPort ¶ added in v1.4.10

func (f *FileSettings) GetClientPort() string

GetClientPort returns the HTTP request header that holds the client TCP port of the request

func (*FileSettings) GetConfig ¶ added in v1.4.10

func (f *FileSettings) GetConfig(backend definitions.Backend) any

GetConfig retrieves the configuration for a given backend from the FileSettings receiver or returns nil if unavailable.

func (*FileSettings) GetConfigFileAsJSON ¶ added in v1.7.11

func (f *FileSettings) GetConfigFileAsJSON() ([]byte, error)

GetConfigFileAsJSON returns the current configuration settings as a JSON string, ensuring thread safety with a mutex lock.

func (*FileSettings) GetLDAP ¶ added in v1.4.10

func (f *FileSettings) GetLDAP() *LDAPSection

GetLDAP retrieves the LDAPSection from the FileSettings instance. Returns nil if the FileSettings is nil.

func (*FileSettings) GetLDAPConfigAuthIdlePoolSize ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigAuthIdlePoolSize() int

GetLDAPConfigAuthIdlePoolSize retrieves the authentication idle pool size for the LDAP configuration. It returns the default value if the configuration is nil or not properly set.

func (*FileSettings) GetLDAPConfigAuthPoolSize ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigAuthPoolSize() int

GetLDAPConfigAuthPoolSize returns the authentication pool size configured for an LDAP backend or a default value if not set.

func (*FileSettings) GetLDAPConfigBindDN ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigBindDN() string

GetLDAPConfigBindDN returns the BindDN value from the LDAP configuration if available, otherwise it returns an empty string.

func (*FileSettings) GetLDAPConfigBindPW ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigBindPW() string

GetLDAPConfigBindPW retrieves the BindPW (bind password) from the LDAP configuration if available, or returns an empty string.

func (*FileSettings) GetLDAPConfigConnectAbortTimeout ¶ added in v1.5.0

func (f *FileSettings) GetLDAPConfigConnectAbortTimeout() time.Duration

GetLDAPConfigConnectAbortTimeout retrieves the abort timeout duration from the LDAP configuration, or returns 0 if not applicable.

func (*FileSettings) GetLDAPConfigLookupIdlePoolSize ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigLookupIdlePoolSize() int

GetLDAPConfigLookupIdlePoolSize returns the configured idle connection pool size for LDAP lookups or a default value if unset.

func (*FileSettings) GetLDAPConfigLookupPoolSize ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigLookupPoolSize() int

GetLDAPConfigLookupPoolSize returns the size of the LDAP lookup connection pool, or a default if no configuration exists.

func (*FileSettings) GetLDAPConfigNumberOfWorkers ¶ added in v1.6.5

func (f *FileSettings) GetLDAPConfigNumberOfWorkers() int

GetLDAPConfigNumberOfWorkers retrieves the number of workers for the LDAP configuration. Defaults to a predefined value.

func (*FileSettings) GetLDAPConfigSASLExternal ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigSASLExternal() bool

GetLDAPConfigSASLExternal checks if the LDAP configuration uses SASL External authentication and returns its status. It returns false if the FileSettings receiver or the LDAP configuration is nil, or if the type assertion fails.

func (*FileSettings) GetLDAPConfigServerURIs ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigServerURIs() []string

GetLDAPConfigServerURIs retrieves the LDAP server URIs from the configuration or returns "ldap://localhost" as a default value.

func (*FileSettings) GetLDAPConfigStartTLS ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigStartTLS() bool

GetLDAPConfigStartTLS determines if StartTLS is enabled for the LDAP configuration in the provided file. Returns false if the file or configuration is nil or not of type *LDAPConf.

func (*FileSettings) GetLDAPConfigTLSCAFile ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigTLSCAFile() string

GetLDAPConfigTLSCAFile retrieves the TLS CA file for the LDAP configuration if available, returning an empty string if not.

func (*FileSettings) GetLDAPConfigTLSClientCert ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigTLSClientCert() string

GetLDAPConfigTLSClientCert retrieves the TLS client certificate for the LDAP configuration. Returns an empty string if the file or configuration is nil, or if the assertion of the config type fails.

func (*FileSettings) GetLDAPConfigTLSClientKey ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigTLSClientKey() string

GetLDAPConfigTLSClientKey retrieves the TLS client key for the LDAP configuration. Returns an empty string if not set.

func (*FileSettings) GetLDAPConfigTLSSkipVerify ¶ added in v1.4.10

func (f *FileSettings) GetLDAPConfigTLSSkipVerify() bool

GetLDAPConfigTLSSkipVerify retrieves the TLSSkipVerify value from the LDAP configuration in the file. Returns false if the file or configuration is nil or not of type *LDAPConf.

func (*FileSettings) GetLDAPOptionalPools ¶ added in v1.5.0

func (f *FileSettings) GetLDAPOptionalPools() map[string]*LDAPConf

GetLDAPOptionalPools retrieves a map of optional LDAP pool configurations from the file settings. Returns an empty map if the file settings or LDAP section is not properly configured.

func (*FileSettings) GetLDAPSearchProtocol ¶ added in v1.4.10

func (f *FileSettings) GetLDAPSearchProtocol(protocol string, poolName string) (*LDAPSearchProtocol, error)

GetLDAPSearchProtocol retrieves the LDAPSearchProtocol configuration based on the specified protocol. If the protocol is not found, it falls back to the default protocol. Returns an error if the configuration or default protocol is missing. Returns nil if no matching protocol is found and there's no error.

func (*FileSettings) GetLocalIP ¶ added in v1.4.10

func (f *FileSettings) GetLocalIP() string

GetLocalIP returns the HTTP request header that represents the local IP address for the server that accepts client requests

func (*FileSettings) GetLocalPort ¶ added in v1.4.10

func (f *FileSettings) GetLocalPort() string

GetLocalPort returns the HTTP request header that represents the local TCP port for the server that accepts client requests

func (*FileSettings) GetLoginAttempt ¶ added in v1.4.10

func (f *FileSettings) GetLoginAttempt() string

GetLoginAttempt returns the HTTP request header for login-attempts

func (*FileSettings) GetLua ¶ added in v1.4.10

func (f *FileSettings) GetLua() *LuaSection

GetLua retrieves the LuaSection from the FileSettings instance. Returns nil if the FileSettings instance is nil.

func (*FileSettings) GetLuaActionNumberOfWorkers ¶ added in v1.10.0

func (f *FileSettings) GetLuaActionNumberOfWorkers() int

GetLuaActionNumberOfWorkers retrieves the number of workers configured for Lua actions or returns default (10) if unset.

func (*FileSettings) GetLuaFeatureVMPoolSize ¶ added in v1.10.0

func (f *FileSettings) GetLuaFeatureVMPoolSize() int

GetLuaFeatureVMPoolSize returns the VM pool size for Lua features.

func (*FileSettings) GetLuaFilterVMPoolSize ¶ added in v1.10.0

func (f *FileSettings) GetLuaFilterVMPoolSize() int

GetLuaFilterVMPoolSize returns the VM pool size for Lua filters.

func (*FileSettings) GetLuaHookVMPoolSize ¶ added in v1.10.0

func (f *FileSettings) GetLuaHookVMPoolSize() int

GetLuaHookVMPoolSize returns the VM pool size for Lua hooks.

func (*FileSettings) GetLuaInitScriptPath ¶ added in v1.4.10

func (f *FileSettings) GetLuaInitScriptPath() string

GetLuaInitScriptPath returns the path to the Lua init script specified in the configuration. If the configuration or LuaConf is nil, it returns an empty string. If InitScriptPaths is set, it returns the first path from that list. Otherwise, it returns the value of InitScriptPath.

func (*FileSettings) GetLuaInitScriptPaths ¶ added in v1.7.7

func (f *FileSettings) GetLuaInitScriptPaths() []string

GetLuaInitScriptPaths returns all paths to Lua init scripts specified in the configuration. It combines both the single InitScriptPath and the list in InitScriptPaths. If the configuration or LuaConf is nil, it returns an empty slice.

func (*FileSettings) GetLuaNumberOfWorkers ¶ added in v1.6.5

func (f *FileSettings) GetLuaNumberOfWorkers() int

GetLuaNumberOfWorkers retrieves the number of workers configured for the Lua backend or returns the default if unset.

func (*FileSettings) GetLuaOptionalBackends ¶ added in v1.5.0

func (f *FileSettings) GetLuaOptionalBackends() map[string]*LuaConf

GetLuaOptionalBackends retrieves the optional Lua backends configuration from FileSettings. Returns an empty map if unavailable.

func (*FileSettings) GetLuaPackagePath ¶ added in v1.4.10

func (f *FileSettings) GetLuaPackagePath() string

GetLuaPackagePath returns the Lua package path based on the file configuration or a default path if not specified.

func (*FileSettings) GetLuaScriptPath ¶ added in v1.4.10

func (f *FileSettings) GetLuaScriptPath() string

GetLuaScriptPath retrieves the backend Lua script file path from the configuration. Returns an empty string if unavailable.

func (*FileSettings) GetLuaSearchProtocol ¶ added in v1.4.10

func (f *FileSettings) GetLuaSearchProtocol(protocol string, backendName string) (*LuaSearchProtocol, error)

GetLuaSearchProtocol retrieves a LuaSearchProtocol configuration matching the specified protocol. Returns a default LuaSearchProtocol if the protocol cannot be found and protocol is set to ProtoDefault. Returns a DetailedError if the protocol cannot be found and no default is configured. Returns nil if no matching protocol is found and there's no error. Accepts a string representing the protocol to search for.

func (*FileSettings) GetOIDCCID ¶ added in v1.7.5

func (f *FileSettings) GetOIDCCID() string

GetOIDCCID retrieves the OIDC Client ID from the FileSettings' DefaultHTTPRequestHeader. Returns an empty string if nil.

func (*FileSettings) GetOauth2 ¶ added in v1.4.10

func (f *FileSettings) GetOauth2() *Oauth2Section

GetOauth2 returns the Oauth2Section of the FileSettings instance. Returns nil if the FileSettings instance is nil.

func (*FileSettings) GetPassword ¶ added in v1.4.10

func (f *FileSettings) GetPassword() string

GetPassword returns the HTTP request header for the password

func (*FileSettings) GetPasswordEncoded ¶ added in v1.4.10

func (f *FileSettings) GetPasswordEncoded() string

GetPasswordEncoded returns the HTTP request header to indicate if the password was encoded

func (*FileSettings) GetProtocol ¶ added in v1.4.10

func (f *FileSettings) GetProtocol() string

GetProtocol returns the HTTP request header for the used protocol

func (*FileSettings) GetProtocols ¶ added in v1.4.10

func (f *FileSettings) GetProtocols(backend definitions.Backend) any

GetProtocols retrieves protocol configurations for the specified backend type. Returns nil if the backend is not found or has no associated protocols.

func (*FileSettings) GetRBLs ¶ added in v1.4.10

func (f *FileSettings) GetRBLs() *RBLSection

GetRBLs retrieves the RBLSection configuration from the FileSettings instance. Returns nil if the FileSettings instance is nil.

func (*FileSettings) GetRelayDomains ¶ added in v1.4.10

func (f *FileSettings) GetRelayDomains() *RelayDomainsSection

GetRelayDomains retrieves the RelayDomainsSection from the FileSettings. Returns nil if the FileSettings is nil.

func (*FileSettings) GetSSL ¶ added in v1.4.10

func (f *FileSettings) GetSSL() string

GetSSL returns the HTTP request header used to indicate SSL security for the current client connection

func (*FileSettings) GetSSLCipher ¶ added in v1.4.10

func (f *FileSettings) GetSSLCipher() string

GetSSLCipher retrieves the SSL cipher from the default HTTP request header of the server configuration. Returns an empty string if the FileSettings instance is nil.

func (*FileSettings) GetSSLClientCN ¶ added in v1.4.10

func (f *FileSettings) GetSSLClientCN() string

GetSSLClientCN retrieves the SSL client common name (CN) from the default HTTP request header.

func (*FileSettings) GetSSLClientIssuerDN ¶ added in v1.4.10

func (f *FileSettings) GetSSLClientIssuerDN() string

GetSSLClientIssuerDN returns the distinguished name (DN) of the SSL client issuer from the default HTTP request header.

func (*FileSettings) GetSSLClientNotAfter ¶ added in v1.4.10

func (f *FileSettings) GetSSLClientNotAfter() string

GetSSLClientNotAfter retrieves the SSL client certificate's "not after" expiration date as a string. Returns an empty string if the FileSettings is nil.

func (*FileSettings) GetSSLClientNotBefore ¶ added in v1.4.10

func (f *FileSettings) GetSSLClientNotBefore() string

GetSSLClientNotBefore retrieves the "SSLClientNotBefore" value from the default HTTP request header of the server. Returns an empty string if the FileSettings instance is nil.

func (*FileSettings) GetSSLClientSubjectDN ¶ added in v1.4.10

func (f *FileSettings) GetSSLClientSubjectDN() string

GetSSLClientSubjectDN returns the SSL client subject distinguished name from the default HTTP request header. If the FileSettings receiver is nil, it returns an empty string.

func (*FileSettings) GetSSLFingerprint ¶ added in v1.4.10

func (f *FileSettings) GetSSLFingerprint() string

GetSSLFingerprint retrieves the SSL fingerprint from the server's default HTTP request header. If the FileSettings is nil, it returns an empty string.

func (*FileSettings) GetSSLIssuer ¶ added in v1.4.10

func (f *FileSettings) GetSSLIssuer() string

GetSSLIssuer retrieves the SSL certificate issuer from the default HTTP request header of the server configuration.

func (*FileSettings) GetSSLIssuerDN ¶ added in v1.4.10

func (f *FileSettings) GetSSLIssuerDN() string

GetSSLIssuerDN retrieves the Distinguished Name (DN) of the SSL issuer from the default HTTP request header.

func (*FileSettings) GetSSLProtocol ¶ added in v1.4.10

func (f *FileSettings) GetSSLProtocol() string

GetSSLProtocol retrieves the SSL protocol from the DefaultHTTPRequestHeader of the Server configuration.

func (*FileSettings) GetSSLSerial ¶ added in v1.4.10

func (f *FileSettings) GetSSLSerial() string

GetSSLSerial retrieves the SSL serial number from the default HTTP request header of the server configuration. Returns an empty string if the FileSettings receiver is nil.

func (*FileSettings) GetSSLSessionID ¶ added in v1.4.10

func (f *FileSettings) GetSSLSessionID() string

GetSSLSessionID retrieves the SSL session ID from the file's default HTTP request header. Returns an empty string if the file is nil.

func (*FileSettings) GetSSLSubject ¶ added in v1.4.10

func (f *FileSettings) GetSSLSubject() string

GetSSLSubject retrieves the SSL subject from the default HTTP request header. Returns an empty string if the file is nil.

func (*FileSettings) GetSSLSubjectDN ¶ added in v1.4.10

func (f *FileSettings) GetSSLSubjectDN() string

GetSSLSubjectDN returns the SSL subject distinguished name from the Server's default HTTP request header.

func (*FileSettings) GetSSLVerify ¶ added in v1.4.10

func (f *FileSettings) GetSSLVerify() string

GetSSLVerify retrieves the SSL verification status from the default HTTP request header configuration. If the FileSettings receiver is nil, it returns an empty string.

func (*FileSettings) GetSection ¶ added in v1.4.10

func (f *FileSettings) GetSection(backend definitions.Backend) any

GetSection retrieves the section corresponding to the provided backend type from the FileSettings. Returns nil if not found.

func (*FileSettings) GetServer ¶ added in v1.4.10

func (f *FileSettings) GetServer() *ServerSection

GetServer retrieves the ServerSection from the FileSettings. Returns an empty ServerSection if the FileSettings is nil or if no Server is present.

func (*FileSettings) GetSkipConsent ¶ added in v1.4.10

func (f *FileSettings) GetSkipConsent(clientId string) (skip bool)

GetSkipConsent returns a boolean true, if the consent dialog shall be skipped for an OAuth-2 client.

func (*FileSettings) GetSkipTOTP ¶ added in v1.4.10

func (f *FileSettings) GetSkipTOTP(clientId string) (skip bool)

GetSkipTOTP returns a boolean true, if TOTP two-factor authentication shall be skipped for an OAuth-2 client.

func (*FileSettings) GetUsername ¶ added in v1.4.10

func (f *FileSettings) GetUsername() string

GetUsername returns the HTTP request header for the username

func (*FileSettings) HandleFile ¶ added in v1.4.10

func (f *FileSettings) HandleFile() (err error)

HandleFile applies the configuration settings loaded from the configuration file. It does sanity checks to make sure Nauthilus has a working configuration.

func (*FileSettings) HasFeature ¶ added in v1.4.10

func (f *FileSettings) HasFeature(feature string) bool

HasFeature checks if the given feature exists in the LoadableConfig's Features list

func (*FileSettings) HaveLDAPBackend ¶ added in v1.4.10

func (f *FileSettings) HaveLDAPBackend() bool

HaveLDAPBackend checks if the configuration includes an LDAP backend and returns true if it exists, otherwise false.

func (*FileSettings) HaveLua ¶ added in v1.4.10

func (f *FileSettings) HaveLua() bool

HaveLua is a method on the FileSettings struct. It checks if the Lua field in the FileSettings struct is not nil. It returns a boolean value indicating whether Lua is present or not.

func (*FileSettings) HaveLuaActions ¶ added in v1.4.10

func (f *FileSettings) HaveLuaActions() bool

HaveLuaActions is a method on the FileSettings struct. It checks if the FileSettings struct has Lua actions. It returns true if the FileSettings struct has Lua actions, otherwise returns false.

func (*FileSettings) HaveLuaBackend ¶ added in v1.6.9

func (f *FileSettings) HaveLuaBackend() bool

HaveLuaBackend checks if the FileSettings instance has a Lua backend configured and returns true if found, otherwise false.

func (*FileSettings) HaveLuaFeatures ¶ added in v1.4.10

func (f *FileSettings) HaveLuaFeatures() bool

HaveLuaFeatures is a method on the FileSettings struct. It checks if the FileSettings struct has Lua features. It returns true if there are Lua features, and false otherwise.

func (*FileSettings) HaveLuaFilters ¶ added in v1.4.10

func (f *FileSettings) HaveLuaFilters() bool

HaveLuaFilters is a method on the FileSettings struct. It checks if the FileSettings struct has Lua filters. It returns true if there are Lua filters, and false otherwise.

func (*FileSettings) HaveLuaHooks ¶ added in v1.4.10

func (f *FileSettings) HaveLuaHooks() bool

HaveLuaHooks returns true if the FileSettings instance has Lua hooks associated with it, otherwise returns false.

func (*FileSettings) HaveLuaInit ¶ added in v1.4.10

func (f *FileSettings) HaveLuaInit() bool

HaveLuaInit checks if any Lua initialization script paths are set in the configuration. It first confirms that the FileSettings instance supports Lua by invoking HaveLua method. Then, it retrieves the Lua configuration using GetConfig with the definitions.BackendLua constant. If the retrieved configuration is of type *LuaConf and either InitScriptPath is not empty or InitScriptPaths contains at least one entry, it returns true. Otherwise, it returns false.

func (*FileSettings) HaveServer ¶ added in v1.4.10

func (f *FileSettings) HaveServer() bool

HaveServer is a method on the FileSettings struct. It returns true if the Server field in the FileSettings struct is not nil, indicating that a server exists.

func (*FileSettings) LDAPHavePoolOnly ¶ added in v1.4.10

func (f *FileSettings) LDAPHavePoolOnly(backendName string) bool

LDAPHavePoolOnly checks if the LDAP configuration is set to use the `PoolOnly` mode. Returns false if any element is nil.

func (*FileSettings) RetrieveGetterMap ¶ added in v1.4.10

func (f *FileSettings) RetrieveGetterMap() map[definitions.Backend]GetterHandler

RetrieveGetterMap returns a map associating each supported backend with its corresponding GetterHandler implementation. This method initializes a new map for the backends, and populates it by checking if certain backend sections exist. If the provided FileSettings object is nil, it returns an empty map.

func (*Frontend) GetCSRFSecret ¶ added in v1.7.7

func (f *Frontend) GetCSRFSecret() string

GetCSRFSecret retrieves the CSRF secret from the Frontend configuration. Returns an empty string if the Frontend is nil.

func (*Frontend) GetCookieStoreAuthKey ¶ added in v1.7.7

func (f *Frontend) GetCookieStoreAuthKey() string

GetCookieStoreAuthKey retrieves the cookie store authentication key from the Frontend configuration. Returns an empty string if the Frontend is nil.

func (*Frontend) GetCookieStoreEncKey ¶ added in v1.7.7

func (f *Frontend) GetCookieStoreEncKey() string

GetCookieStoreEncKey retrieves the cookie store encryption key from the Frontend configuration. Returns an empty string if the Frontend is nil.

func (*Frontend) IsEnabled ¶ added in v1.7.7

func (f *Frontend) IsEnabled() bool

IsEnabled checks if the Frontend is enabled. Returns false if the Frontend is nil.

func (*HTTPClient) GetIdleConnTimeout ¶ added in v1.4.11

func (c *HTTPClient) GetIdleConnTimeout() time.Duration

GetIdleConnTimeout returns the idle connection timeout duration configured for the HTTP client. Returns 0 if the HTTPClient is nil.

func (*HTTPClient) GetMaxConnsPerHost ¶ added in v1.4.11

func (c *HTTPClient) GetMaxConnsPerHost() int

GetMaxConnsPerHost returns the maximum number of connections allowed per host for the HTTP client. Returns 0 if the HTTPClient is nil.

func (*HTTPClient) GetMaxIdleConns ¶ added in v1.4.11

func (c *HTTPClient) GetMaxIdleConns() int

GetMaxIdleConns returns the maximum number of idle connections allowed for the HTTP client. Returns 0 if the HTTPClient is nil.

func (*HTTPClient) GetMaxIdleConnsPerHost ¶ added in v1.4.11

func (c *HTTPClient) GetMaxIdleConnsPerHost() int

GetMaxIdleConnsPerHost returns the maximum number of idle connections allowed per host for the HTTP client. Returns 0 if the HTTPClient is nil.

func (*HTTPClient) GetProxy ¶ added in v1.4.11

func (c *HTTPClient) GetProxy() string

GetProxy returns the proxy URL configured for the HTTP client. Returns an empty string if the HTTPClient is nil.

func (*HTTPClient) GetTLS ¶ added in v1.7.11

func (c *HTTPClient) GetTLS() *TLS

GetTLS returns the TLS configuration associated with the HTTP client. Returns an empty TLS struct if the receiver is nil.

func (*IdTokenClaims) GetAddress ¶ added in v1.7.7

func (i *IdTokenClaims) GetAddress() string

GetAddress retrieves the address claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetBirthdate ¶ added in v1.7.7

func (i *IdTokenClaims) GetBirthdate() string

GetBirthdate retrieves the birthdate claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetCustomClaims ¶ added in v1.7.7

func (i *IdTokenClaims) GetCustomClaims() map[string]any

GetCustomClaims retrieves the custom claims from the IdTokenClaims. Returns nil if the IdTokenClaims is nil.

func (*IdTokenClaims) GetEmail ¶ added in v1.7.7

func (i *IdTokenClaims) GetEmail() string

GetEmail retrieves the email claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetEmailVerified ¶ added in v1.7.7

func (i *IdTokenClaims) GetEmailVerified() string

GetEmailVerified retrieves the email_verified claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetFamilyName ¶ added in v1.7.7

func (i *IdTokenClaims) GetFamilyName() string

GetFamilyName retrieves the family name claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetGender ¶ added in v1.7.7

func (i *IdTokenClaims) GetGender() string

GetGender retrieves the gender claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetGivenName ¶ added in v1.7.7

func (i *IdTokenClaims) GetGivenName() string

GetGivenName retrieves the given name claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetGroups ¶ added in v1.7.7

func (i *IdTokenClaims) GetGroups() string

GetGroups retrieves the groups claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetLocale ¶ added in v1.7.7

func (i *IdTokenClaims) GetLocale() string

GetLocale retrieves the locale claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetMiddleName ¶ added in v1.7.7

func (i *IdTokenClaims) GetMiddleName() string

GetMiddleName retrieves the middle name claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetName ¶ added in v1.7.7

func (i *IdTokenClaims) GetName() string

GetName retrieves the name claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetNickName ¶ added in v1.7.7

func (i *IdTokenClaims) GetNickName() string

GetNickName retrieves the nickname claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetPhoneNumber ¶ added in v1.7.7

func (i *IdTokenClaims) GetPhoneNumber() string

GetPhoneNumber retrieves the phone_number claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetPhoneNumberVerified ¶ added in v1.7.7

func (i *IdTokenClaims) GetPhoneNumberVerified() string

GetPhoneNumberVerified retrieves the phone_number_verified claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetPicture ¶ added in v1.7.7

func (i *IdTokenClaims) GetPicture() string

GetPicture retrieves the picture claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetPreferredUserName ¶ added in v1.7.7

func (i *IdTokenClaims) GetPreferredUserName() string

GetPreferredUserName retrieves the preferred username claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetProfile ¶ added in v1.7.7

func (i *IdTokenClaims) GetProfile() string

GetProfile retrieves the profile claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetUpdatedAt ¶ added in v1.7.7

func (i *IdTokenClaims) GetUpdatedAt() string

GetUpdatedAt retrieves the updated_at claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetWebsite ¶ added in v1.7.7

func (i *IdTokenClaims) GetWebsite() string

GetWebsite retrieves the website claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) GetZoneInfo ¶ added in v1.7.7

func (i *IdTokenClaims) GetZoneInfo() string

GetZoneInfo retrieves the zoneinfo claim from the IdTokenClaims. Returns an empty string if the IdTokenClaims is nil.

func (*IdTokenClaims) String ¶

func (i *IdTokenClaims) String() string

func (*Insights) IsBlockProfileEnabled ¶ added in v1.4.11

func (i *Insights) IsBlockProfileEnabled() bool

IsBlockProfileEnabled checks if block profiling is enabled in the Insights configuration. Returns false if the Insights is nil.

func (*Insights) IsMonitorConnectionsEnabled ¶ added in v1.7.4

func (i *Insights) IsMonitorConnectionsEnabled() bool

IsMonitorConnectionsEnabled returns true if connection monitoring is enabled. Returns false if the Insights is nil.

func (*Insights) IsPprofEnabled ¶ added in v1.4.11

func (i *Insights) IsPprofEnabled() bool

IsPprofEnabled checks if pprof profiling is enabled in the Insights configuration. Returns false if the Insights is nil.

func (*JWTAuth) GetRefreshTokenExpiry ¶ added in v1.7.2

func (j *JWTAuth) GetRefreshTokenExpiry() time.Duration

GetRefreshTokenExpiry returns the refresh token expiry duration. Returns 0 if the JWTAuth is nil.

func (*JWTAuth) GetSecretKey ¶ added in v1.7.0

func (j *JWTAuth) GetSecretKey() string

GetSecretKey returns the secret key used for JWT signing. Returns an empty string if the JWTAuth is nil.

func (*JWTAuth) GetTokenExpiry ¶ added in v1.7.0

func (j *JWTAuth) GetTokenExpiry() time.Duration

GetTokenExpiry returns the token expiry duration. Returns 0 if the JWTAuth is nil.

func (*JWTAuth) GetUsers ¶ added in v1.7.0

func (j *JWTAuth) GetUsers() []*JWTUser

GetUsers returns the list of JWT users. Returns an empty slice if the JWTAuth is nil.

func (*JWTAuth) IsEnabled ¶ added in v1.7.0

func (j *JWTAuth) IsEnabled() bool

IsEnabled returns true if JWT authentication is enabled, otherwise false. Returns false if the JWTAuth is nil.

func (*JWTAuth) IsRefreshTokenEnabled ¶ added in v1.7.0

func (j *JWTAuth) IsRefreshTokenEnabled() bool

IsRefreshTokenEnabled returns true if refresh tokens are enabled. Returns false if the JWTAuth is nil.

func (*JWTAuth) IsStoreInRedisEnabled ¶ added in v1.7.0

func (j *JWTAuth) IsStoreInRedisEnabled() bool

IsStoreInRedisEnabled returns true if tokens should be stored in Redis. Returns false if the JWTAuth is nil.

func (*JWTUser) GetPassword ¶ added in v1.7.0

func (u *JWTUser) GetPassword() string

GetPassword returns the password of the JWT user. Returns an empty string if the JWTUser is nil.

func (*JWTUser) GetRoles ¶ added in v1.7.0

func (u *JWTUser) GetRoles() []string

GetRoles returns the roles of the JWT user. Returns an empty slice if the JWTUser is nil.

func (*JWTUser) GetUsername ¶ added in v1.7.0

func (u *JWTUser) GetUsername() string

GetUsername returns the username of the JWT user. Returns an empty string if the JWTUser is nil.

func (*KeepAlive) GetMaxIdleConns ¶ added in v1.7.3

func (k *KeepAlive) GetMaxIdleConns() int

GetMaxIdleConns returns the maximum number of idle connections. Returns 0 if the KeepAlive is nil.

func (*KeepAlive) GetMaxIdleConnsPerHost ¶ added in v1.7.3

func (k *KeepAlive) GetMaxIdleConnsPerHost() int

GetMaxIdleConnsPerHost returns the maximum number of idle connections per host. Returns 0 if the KeepAlive is nil.

func (*KeepAlive) GetTimeout ¶ added in v1.7.3

func (k *KeepAlive) GetTimeout() time.Duration

GetTimeout returns the keep-alive timeout duration. Returns 0 if the KeepAlive is nil.

func (*KeepAlive) IsEnabled ¶ added in v1.7.3

func (k *KeepAlive) IsEnabled() bool

IsEnabled returns true if keep-alive optimization is enabled, otherwise false. Returns false if the KeepAlive is nil.

func (*LDAPAttributeMapping) GetAAGUIDField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetAAGUIDField() string

GetAAGUIDField retrieves the AAGUID field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetCredentialIDField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetCredentialIDField() string

GetCredentialIDField retrieves the credential ID field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetCredentialObject ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetCredentialObject() string

GetCredentialObject retrieves the credential object field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetDisplayNameField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetDisplayNameField() string

GetDisplayNameField retrieves the display name field from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetPublicKeyField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetPublicKeyField() string

GetPublicKeyField retrieves the public key field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetSignCountField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetSignCountField() string

GetSignCountField retrieves the sign count field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetTOTPRecoveryField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetTOTPRecoveryField() string

GetTOTPRecoveryField retrieves the TOTP recovery field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetTOTPSecretField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetTOTPSecretField() string

GetTOTPSecretField retrieves the TOTP secret field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPAttributeMapping) GetUniqueUserIDField ¶ added in v1.7.7

func (m *LDAPAttributeMapping) GetUniqueUserIDField() string

GetUniqueUserIDField retrieves the unique user ID field name from the LDAPAttributeMapping. Returns an empty string if the LDAPAttributeMapping is nil.

func (*LDAPConf) GetAuthIdlePoolSize ¶ added in v1.7.7

func (l *LDAPConf) GetAuthIdlePoolSize() int

GetAuthIdlePoolSize retrieves the authentication idle pool size from the LDAPConf. Returns definitions.LDAPIdlePoolSize if the LDAPConf is nil.

func (*LDAPConf) GetAuthPoolSize ¶ added in v1.7.7

func (l *LDAPConf) GetAuthPoolSize() int

GetAuthPoolSize retrieves the authentication pool size from the LDAPConf. Returns definitions.LDAPIdlePoolSize if the LDAPConf is nil.

func (*LDAPConf) GetAuthQueueLength ¶ added in v1.10.0

func (l *LDAPConf) GetAuthQueueLength() int

GetAuthQueueLength returns the maximum queue length for auth requests. Zero means unlimited.

func (*LDAPConf) GetAuthRateLimitBurst ¶ added in v1.10.0

func (l *LDAPConf) GetAuthRateLimitBurst() int

GetAuthRateLimitBurst returns burst size for auth limiter.

func (*LDAPConf) GetAuthRateLimitPerSecond ¶ added in v1.10.0

func (l *LDAPConf) GetAuthRateLimitPerSecond() float64

GetAuthRateLimitPerSecond returns tokens per second for auth limiter.

func (*LDAPConf) GetBindDN ¶ added in v1.7.7

func (l *LDAPConf) GetBindDN() string

GetBindDN retrieves the bind DN from the LDAPConf. Returns an empty string if the LDAPConf is nil.

func (*LDAPConf) GetBindPW ¶ added in v1.7.7

func (l *LDAPConf) GetBindPW() string

GetBindPW retrieves the bind password from the LDAPConf. Returns an empty string if the LDAPConf is nil.

func (*LDAPConf) GetBindTimeout ¶ added in v1.10.0

func (l *LDAPConf) GetBindTimeout() time.Duration

GetBindTimeout returns the bind timeout duration.

func (*LDAPConf) GetCBCooldown ¶ added in v1.10.0

func (l *LDAPConf) GetCBCooldown() time.Duration

GetCBCooldown returns the cooldown period for the breaker to remain open. Default 30s.

func (*LDAPConf) GetCBFailureThreshold ¶ added in v1.10.0

func (l *LDAPConf) GetCBFailureThreshold() int

GetCBFailureThreshold returns the number of failures before opening the breaker. Default 5.

func (*LDAPConf) GetCBHalfOpenMax ¶ added in v1.10.0

func (l *LDAPConf) GetCBHalfOpenMax() int

GetCBHalfOpenMax returns the number of half-open probes allowed before deciding state. Default 1.

func (*LDAPConf) GetCacheImpl ¶ added in v1.10.0

func (l *LDAPConf) GetCacheImpl() string

GetCacheImpl returns selected cache implementation: "lru" or "ttl". Default "ttl".

func (*LDAPConf) GetCacheMaxEntries ¶ added in v1.10.0

func (l *LDAPConf) GetCacheMaxEntries() int

GetCacheMaxEntries returns max entries for LRU caches. Default 5000.

func (*LDAPConf) GetConnectAbortTimeout ¶ added in v1.7.7

func (l *LDAPConf) GetConnectAbortTimeout() time.Duration

GetConnectAbortTimeout retrieves the connect abort timeout duration from the LDAPConf. Returns 0 if the LDAPConf is nil.

func (*LDAPConf) GetHealthCheckInterval ¶ added in v1.10.0

func (l *LDAPConf) GetHealthCheckInterval() time.Duration

GetHealthCheckInterval returns the interval for active LDAP health probes. Default 10s.

func (*LDAPConf) GetHealthCheckTimeout ¶ added in v1.10.0

func (l *LDAPConf) GetHealthCheckTimeout() time.Duration

GetHealthCheckTimeout returns the per-probe timeout for LDAP health checks. Default 1.5s.

func (*LDAPConf) GetIncludeRawResult ¶ added in v1.10.0

func (l *LDAPConf) GetIncludeRawResult() bool

GetIncludeRawResult returns whether raw LDAP search entries should be included in replies. Default false.

func (*LDAPConf) GetLookupIdlePoolSize ¶ added in v1.7.7

func (l *LDAPConf) GetLookupIdlePoolSize() int

GetLookupIdlePoolSize retrieves the lookup idle pool size from the LDAPConf. Returns definitions.LDAPIdlePoolSize if the LDAPConf is nil.

func (*LDAPConf) GetLookupPoolSize ¶ added in v1.7.7

func (l *LDAPConf) GetLookupPoolSize() int

GetLookupPoolSize retrieves the lookup pool size from the LDAPConf. Returns definitions.LDAPIdlePoolSize if the LDAPConf is nil.

func (*LDAPConf) GetLookupQueueLength ¶ added in v1.10.0

func (l *LDAPConf) GetLookupQueueLength() int

GetLookupQueueLength returns the maximum queue length for lookup requests. Zero means unlimited.

func (*LDAPConf) GetModifyTimeout ¶ added in v1.10.0

func (l *LDAPConf) GetModifyTimeout() time.Duration

GetModifyTimeout returns the modify timeout duration.

func (*LDAPConf) GetNegativeCacheTTL ¶ added in v1.10.0

func (l *LDAPConf) GetNegativeCacheTTL() time.Duration

GetNegativeCacheTTL returns TTL for negative cache entries. Default 20s.

func (*LDAPConf) GetNumberOfWorkers ¶ added in v1.6.5

func (l *LDAPConf) GetNumberOfWorkers() int

GetNumberOfWorkers returns the number of workers configured in the LDAPConf. Returns 0 if the LDAPConf is nil.

func (*LDAPConf) GetPoolName ¶ added in v1.10.0

func (l *LDAPConf) GetPoolName() string

GetPoolName returns the pool name label set internally.

func (*LDAPConf) GetRetryBase ¶ added in v1.10.0

func (l *LDAPConf) GetRetryBase() time.Duration

GetRetryBase returns the base backoff duration for retries. Default 200ms if unset.

func (*LDAPConf) GetRetryMax ¶ added in v1.10.0

func (l *LDAPConf) GetRetryMax() int

GetRetryMax returns the maximum number of retries for transient errors. Default 2 if unset.

func (*LDAPConf) GetRetryMaxBackoff ¶ added in v1.10.0

func (l *LDAPConf) GetRetryMaxBackoff() time.Duration

GetRetryMaxBackoff returns the max backoff duration for retries. Default 2s if unset.

func (*LDAPConf) GetSearchSizeLimit ¶ added in v1.10.0

func (l *LDAPConf) GetSearchSizeLimit() int

GetSearchSizeLimit returns LDAP size limit; 0 means server default (unlimited).

func (*LDAPConf) GetSearchTimeLimit ¶ added in v1.10.0

func (l *LDAPConf) GetSearchTimeLimit() time.Duration

GetSearchTimeLimit returns LDAP time limit as a duration; 0 means default.

func (*LDAPConf) GetSearchTimeout ¶ added in v1.10.0

func (l *LDAPConf) GetSearchTimeout() time.Duration

GetSearchTimeout returns the search timeout duration.

func (*LDAPConf) GetServerURIs ¶ added in v1.7.7

func (l *LDAPConf) GetServerURIs() []string

GetServerURIs retrieves the server URIs from the LDAPConf. Returns []string{"ldap://localhost"} slice if the LDAPConf is nil.

func (*LDAPConf) GetTLSCAFile ¶ added in v1.7.7

func (l *LDAPConf) GetTLSCAFile() string

GetTLSCAFile retrieves the TLS CA certificate file path from the LDAPConf. Returns an empty string if the LDAPConf is nil.

func (*LDAPConf) GetTLSClientCert ¶ added in v1.7.7

func (l *LDAPConf) GetTLSClientCert() string

GetTLSClientCert retrieves the TLS client certificate file path from the LDAPConf. Returns an empty string if the LDAPConf is nil.

func (*LDAPConf) GetTLSClientKey ¶ added in v1.7.7

func (l *LDAPConf) GetTLSClientKey() string

GetTLSClientKey retrieves the TLS client key file path from the LDAPConf. Returns an empty string if the LDAPConf is nil.

func (*LDAPConf) IsPoolOnly ¶ added in v1.7.7

func (l *LDAPConf) IsPoolOnly() bool

IsPoolOnly determines the effective pool-only mode. Rule: If deprecated 'pool_only' is set, it wins. Otherwise use 'lookup_pool_only'.

func (*LDAPConf) IsSASLExternal ¶ added in v1.7.7

func (l *LDAPConf) IsSASLExternal() bool

IsSASLExternal checks if SASL External authentication is enabled in the LDAPConf. Returns false if the LDAPConf is nil.

func (*LDAPConf) IsStartTLS ¶ added in v1.7.7

func (l *LDAPConf) IsStartTLS() bool

IsStartTLS checks if StartTLS is enabled in the LDAPConf. Returns false if the LDAPConf is nil.

func (*LDAPConf) IsTLSSkipVerify ¶ added in v1.7.7

func (l *LDAPConf) IsTLSSkipVerify() bool

IsTLSSkipVerify checks if TLS verification should be skipped in the LDAPConf. Returns false if the LDAPConf is nil.

func (*LDAPConf) String ¶

func (l *LDAPConf) String() string

func (*LDAPFilter) GetWebAuthnCredentialsFilter ¶ added in v1.7.7

func (f *LDAPFilter) GetWebAuthnCredentialsFilter() string

GetWebAuthnCredentialsFilter returns an LDAP filter which is used to find WebAuthn credentials. Returns an empty string if the LDAPFilter is nil.

func (*LDAPScope) Get ¶

func (l *LDAPScope) Get() int

Get returns the numeric LDAP search scope.

func (*LDAPScope) Set ¶

func (l *LDAPScope) Set(value string) error

Set sets the numeric LDAP search scope by its string representation.

func (*LDAPScope) String ¶

func (l *LDAPScope) String() string

func (*LDAPScope) Type ¶

func (l *LDAPScope) Type() string

Type returns the name of the type.

func (*LDAPSearchProtocol) GetAccountField ¶

func (p *LDAPSearchProtocol) GetAccountField() (string, error)

GetAccountField returns the LDAP attribute for an account. It returns a DetailedError, if no value has been configured.

func (*LDAPSearchProtocol) GetAttributes ¶

func (p *LDAPSearchProtocol) GetAttributes() ([]string, error)

GetAttributes returns a list of attributes that are requested from the LDAP server. It returns a DetailedError, if no value has been configured.

func (*LDAPSearchProtocol) GetBaseDN ¶

func (p *LDAPSearchProtocol) GetBaseDN() (string, error)

GetBaseDN returns the base DN that is used for each specific protocol. It returns a DetailedError, if no value has been configured.

func (*LDAPSearchProtocol) GetCacheName ¶

func (p *LDAPSearchProtocol) GetCacheName() (string, error)

GetCacheName returns the Redis cache domain. It returns a DetailedError, if no value has been configured.

func (*LDAPSearchProtocol) GetListAccountsFilter ¶

func (p *LDAPSearchProtocol) GetListAccountsFilter() (string, error)

GetListAccountsFilter returns an LDAP filter which is used to find all user accounts. It returns a DetailedError, if no value has been configured.

func (*LDAPSearchProtocol) GetPoolName ¶ added in v1.5.0

func (p *LDAPSearchProtocol) GetPoolName() string

GetPoolName returns the configured pool name. If no pool name is configured, it defaults to DefaultBackendName.

func (*LDAPSearchProtocol) GetProtocols ¶ added in v1.7.7

func (p *LDAPSearchProtocol) GetProtocols() []string

GetProtocols retrieves the list of protocols from the LDAPSearchProtocol. Returns an empty slice if the LDAPSearchProtocol is nil or if the Protocols field is nil.

func (*LDAPSearchProtocol) GetScope ¶

func (p *LDAPSearchProtocol) GetScope() (*LDAPScope, error)

GetScope returns an LDAP search scope. If no scope was defined, it automatically sets the subtree scope. If a scope has been defined and is unknown, it returns a DetailedError.

func (*LDAPSearchProtocol) GetUserFilter ¶

func (p *LDAPSearchProtocol) GetUserFilter() (string, error)

GetUserFilter returns an LDAP search filter to find a user. It returns a DetailedError, if no value has been configured.

func (*LDAPSection) GetConfig ¶

func (l *LDAPSection) GetConfig() any

GetConfig retrieves the LDAP configuration from the receiver. Returns nil if the receiver is nil.

func (*LDAPSection) GetOptionalLDAPPools ¶ added in v1.5.0

func (l *LDAPSection) GetOptionalLDAPPools() map[string]*LDAPConf

GetOptionalLDAPPools returns a map of LDAP pool configurations if available, or an empty map if the receiver is nil.

func (*LDAPSection) GetProtocols ¶

func (l *LDAPSection) GetProtocols() any

GetProtocols returns the search protocols of the LDAP configuration, or an empty slice if the receiver is nil.

func (*LDAPSection) GetSearch ¶ added in v1.7.7

func (l *LDAPSection) GetSearch() []LDAPSearchProtocol

GetSearch returns the LDAP search protocols if available, or an empty slice if the receiver is nil.

func (*LDAPSection) String ¶

func (l *LDAPSection) String() string

func (*Log) GetDebugModules ¶ added in v1.4.11

func (l *Log) GetDebugModules() []*DbgModule

GetDebugModules retrieves the list of debug modules configured in the Log instance. Returns an empty slice if the Log is nil.

func (*Log) GetLogLevel ¶ added in v1.4.11

func (l *Log) GetLogLevel() int

GetLogLevel returns the name of the current logging level configured in the Log instance. Returns 0 if the Log is nil or the Level is nil.

func (*Log) GetLogLevelName ¶ added in v1.4.11

func (l *Log) GetLogLevelName() string

GetLogLevelName returns the name of the current logging level as a string. Returns an empty string if the Log is nil or the Level is nil.

func (*Log) IsAddSourceEnabled ¶ added in v1.10.0

func (l *Log) IsAddSourceEnabled() bool

IsAddSourceEnabled indicates whether slog should add source information (file:line) to log records. Returns false if Log is nil; default behavior is configured via config defaults.

func (*Log) IsLogFormatJSON ¶ added in v1.4.11

func (l *Log) IsLogFormatJSON() bool

IsLogFormatJSON indicates whether the log format is set to JSON based on the `JSON` field in the `Log` struct. Returns false if the Log is nil.

func (*Log) IsLogUsesColor ¶ added in v1.4.11

func (l *Log) IsLogUsesColor() bool

IsLogUsesColor determines if colored output is enabled for logging. Returns false if the Log is nil.

func (*LuaAction) GetAction ¶

func (l *LuaAction) GetAction() (string, string, string)

GetAction returns the ActionType, ScriptName, and ScriptPath of a LuaAction. It is a method of the LuaAction struct. The ActionType field represents the type of the Lua action. The ScriptName field represents the name of the Lua script. The ScriptPath field represents the path to the Lua script file. It returns these values as strings.

func (*LuaAction) GetActionType ¶ added in v1.7.7

func (l *LuaAction) GetActionType() string

GetActionType retrieves the ActionType from the LuaAction. Returns an empty string if the LuaAction is nil.

func (*LuaAction) GetScriptName ¶ added in v1.7.7

func (l *LuaAction) GetScriptName() string

GetScriptName retrieves the ScriptName from the LuaAction. Returns an empty string if the LuaAction is nil.

func (*LuaAction) GetScriptPath ¶ added in v1.7.7

func (l *LuaAction) GetScriptPath() string

GetScriptPath retrieves the ScriptPath from the LuaAction. Returns an empty string if the LuaAction is nil.

func (*LuaAction) String ¶

func (l *LuaAction) String() string

func (*LuaConf) GetActionNumberOfWorkers ¶ added in v1.10.0

func (l *LuaConf) GetActionNumberOfWorkers() int

GetActionNumberOfWorkers returns the configured number of action workers or a sane default (definitions.MaxActionWorkers) if unset.

func (*LuaConf) GetBackendScriptPath ¶ added in v1.7.7

func (l *LuaConf) GetBackendScriptPath() string

GetBackendScriptPath retrieves the BackendScriptPath from the LuaConf. Returns an empty string if the LuaConf is nil.

func (*LuaConf) GetFeatureVMPoolSize ¶ added in v1.10.0

func (l *LuaConf) GetFeatureVMPoolSize() int

GetFeatureVMPoolSize retrieves the configured feature VM pool size or falls back to the worker count if unset or invalid.

func (*LuaConf) GetFilterVMPoolSize ¶ added in v1.10.0

func (l *LuaConf) GetFilterVMPoolSize() int

GetFilterVMPoolSize returns the configured filter VM pool size or falls back to the number of workers if unset or invalid.

func (*LuaConf) GetHookVMPoolSize ¶ added in v1.10.0

func (l *LuaConf) GetHookVMPoolSize() int

GetHookVMPoolSize retrieves the hook VM pool size or defaults to the number of workers if unset or invalid.

func (*LuaConf) GetInitScriptPath ¶ added in v1.7.7

func (l *LuaConf) GetInitScriptPath() string

GetInitScriptPath retrieves the InitScriptPath from the LuaConf. Returns an empty string if the LuaConf is nil.

func (*LuaConf) GetInitScriptPaths ¶ added in v1.7.7

func (l *LuaConf) GetInitScriptPaths() []string

GetInitScriptPaths retrieves the InitScriptPaths from the LuaConf. Returns an empty slice if the LuaConf is nil.

func (*LuaConf) GetLuaIPv4CIDR ¶ added in v1.10.0

func (l *LuaConf) GetLuaIPv4CIDR() uint

GetLuaIPv4CIDR returns the configured IPv4 CIDR for generic Lua scoping; 0 means disabled.

func (*LuaConf) GetLuaIPv6CIDR ¶ added in v1.10.0

func (l *LuaConf) GetLuaIPv6CIDR() uint

GetLuaIPv6CIDR returns the configured IPv6 CIDR for generic Lua scoping; 0 means disabled.

func (*LuaConf) GetNumberOfWorkers ¶ added in v1.6.5

func (l *LuaConf) GetNumberOfWorkers() int

GetNumberOfWorkers returns the number of backend workers. Preference order (v1.10.0+): 1) BackendNumberOfWorkers (new) 2) NumberOfWorkers (deprecated) 3) Default

func (*LuaConf) GetPackagePath ¶ added in v1.7.7

func (l *LuaConf) GetPackagePath() string

GetPackagePath retrieves the PackagePath from the LuaConf. Returns an empty string if the LuaConf is nil.

func (*LuaConf) GetQueueLength ¶ added in v1.10.0

func (l *LuaConf) GetQueueLength() int

GetQueueLength returns the max queue length for Lua backend requests; 0 means unlimited.

func (*LuaConf) String ¶

func (l *LuaConf) String() string

func (*LuaFeature) GetName ¶ added in v1.7.7

func (l *LuaFeature) GetName() string

GetName retrieves the Name from the LuaFeature. Returns an empty string if the LuaFeature is nil.

func (*LuaFeature) GetScriptPath ¶ added in v1.7.7

func (l *LuaFeature) GetScriptPath() string

GetScriptPath retrieves the ScriptPath from the LuaFeature. Returns an empty string if the LuaFeature is nil.

func (*LuaFeature) String ¶

func (l *LuaFeature) String() string

func (*LuaFilter) GetName ¶ added in v1.7.7

func (l *LuaFilter) GetName() string

GetName retrieves the Name from the LuaFilter. Returns an empty string if the LuaFilter is nil.

func (*LuaFilter) GetScriptPath ¶ added in v1.7.7

func (l *LuaFilter) GetScriptPath() string

GetScriptPath retrieves the ScriptPath from the LuaFilter. Returns an empty string if the LuaFilter is nil.

func (*LuaFilter) String ¶

func (l *LuaFilter) String() string

func (*LuaHooks) GetContentType ¶ added in v1.7.11

func (l *LuaHooks) GetContentType() string

GetContentType retrieves the Content-Type from the LuaHooks. Returns "application/json" if the LuaHooks is nil or the ContentType is an empty string

func (*LuaHooks) GetLocation ¶ added in v1.7.7

func (l *LuaHooks) GetLocation() string

GetLocation retrieves the Location from the LuaHooks. Returns an empty string if the LuaHooks is nil.

func (*LuaHooks) GetMethod ¶ added in v1.7.7

func (l *LuaHooks) GetMethod() string

GetMethod retrieves the Method from the LuaHooks. Returns an empty string if the LuaHooks is nil.

func (*LuaHooks) GetRoles ¶ added in v1.7.0

func (l *LuaHooks) GetRoles() []string

GetRoles returns the roles configured for the hook. If no roles are configured, it returns an empty slice.

func (*LuaHooks) GetScriptPath ¶ added in v1.7.7

func (l *LuaHooks) GetScriptPath() string

GetScriptPath retrieves the ScriptPath from the LuaHooks. Returns an empty string if the LuaHooks is nil.

func (*LuaHooks) String ¶ added in v1.3.9

func (l *LuaHooks) String() string

func (*LuaSearchProtocol) GetBackendName ¶ added in v1.5.0

func (l *LuaSearchProtocol) GetBackendName() string

GetBackendName returns the backend name configured in LuaSearchProtocol or a default value if not specified.

func (*LuaSearchProtocol) GetCacheName ¶

func (l *LuaSearchProtocol) GetCacheName() (string, error)

GetCacheName returns the Redis cache domain. It returns a DetailedError, if no value has been configured.

func (*LuaSearchProtocol) GetProtocols ¶ added in v1.7.7

func (l *LuaSearchProtocol) GetProtocols() []string

GetProtocols retrieves the list of protocols from the LuaSearchProtocol. Returns an empty slice if the LuaSearchProtocol is nil or if the Protocols field is nil.

func (*LuaSection) GetActions ¶ added in v1.7.7

func (l *LuaSection) GetActions() []LuaAction

GetActions retrieves the list of LuaAction from the LuaSection. Returns an empty slice if the LuaSection is nil.

func (*LuaSection) GetConfig ¶

func (l *LuaSection) GetConfig() any

GetConfig retrieves the `Config` field from the LuaSection. Returns an empty LuaConf if the LuaSection is nil.

func (*LuaSection) GetFeatures ¶ added in v1.7.7

func (l *LuaSection) GetFeatures() []LuaFeature

GetFeatures retrieves the list of LuaFeature from the LuaSection. Returns an empty slice if the LuaSection is nil.

func (*LuaSection) GetFilters ¶ added in v1.7.7

func (l *LuaSection) GetFilters() []LuaFilter

GetFilters retrieves the list of LuaFilter from the LuaSection. Returns an empty slice if the LuaSection is nil.

func (*LuaSection) GetHooks ¶ added in v1.7.7

func (l *LuaSection) GetHooks() []LuaHooks

GetHooks retrieves the list of LuaHooks from the LuaSection. Returns an empty slice if the LuaSection is nil.

func (*LuaSection) GetOptionalLuaBackends ¶ added in v1.5.0

func (l *LuaSection) GetOptionalLuaBackends() map[string]*LuaConf

GetOptionalLuaBackends retrieves the `OptionalLuaBackends` field from the LuaSection. Returns an empty map if the LuaSection is nil.

func (*LuaSection) GetProtocols ¶

func (l *LuaSection) GetProtocols() any

GetProtocols retrieves the search protocols from the LuaSection. Returns an empty slice if the LuaSection is nil.

func (*LuaSection) String ¶

func (l *LuaSection) String() string

func (Master) GetAddress ¶ added in v1.4.11

func (m Master) GetAddress() string

GetAddress returns the address of the master Redis instance stored in the Master struct.

func (Master) GetPassword ¶ added in v1.4.11

func (m Master) GetPassword() string

GetPassword returns the password of the master Redis instance stored in the Master struct.

func (Master) GetUsername ¶ added in v1.4.11

func (m Master) GetUsername() string

GetUsername returns the username of the master Redis instance stored in the Master struct.

func (*MasterUser) GetDelimiter ¶ added in v1.4.11

func (m *MasterUser) GetDelimiter() string

GetDelimiter retrieves the delimiter value associated with the MasterUser configuration. Returns an empty string if the MasterUser is nil.

func (*MasterUser) IsEnabled ¶ added in v1.4.11

func (m *MasterUser) IsEnabled() bool

IsEnabled determines if the MasterUser is enabled by checking the Enabled field. Returns false if the MasterUser is nil.

func (*OIDCCustomClaim) GetName ¶ added in v1.7.7

func (c *OIDCCustomClaim) GetName() string

GetName retrieves the name of the custom claim. Returns an empty string if the OIDCCustomClaim is nil.

func (*OIDCCustomClaim) GetType ¶ added in v1.7.7

func (c *OIDCCustomClaim) GetType() string

GetType retrieves the type of the custom claim. Returns an empty string if the OIDCCustomClaim is nil.

func (*Oauth2Client) GetClaims ¶ added in v1.7.7

func (c *Oauth2Client) GetClaims() IdTokenClaims

GetClaims retrieves the ID token claims from the Oauth2Client. Returns an empty IdTokenClaims struct if the Oauth2Client is nil.

func (*Oauth2Client) GetClientId ¶ added in v1.7.7

func (c *Oauth2Client) GetClientId() string

GetClientId retrieves the client ID from the Oauth2Client. Returns an empty string if the Oauth2Client is nil.

func (*Oauth2Client) GetClientName ¶ added in v1.7.7

func (c *Oauth2Client) GetClientName() string

GetClientName retrieves the client name from the Oauth2Client. Returns an empty string if the Oauth2Client is nil.

func (*Oauth2Client) GetSubject ¶ added in v1.7.7

func (c *Oauth2Client) GetSubject() string

GetSubject retrieves the subject from the Oauth2Client. Returns an empty string if the Oauth2Client is nil.

func (*Oauth2Client) IsSkipConsent ¶ added in v1.7.7

func (c *Oauth2Client) IsSkipConsent() bool

IsSkipConsent checks if consent should be skipped for this client. Returns false if the Oauth2Client is nil.

func (*Oauth2Client) IsSkipTOTP ¶ added in v1.7.7

func (c *Oauth2Client) IsSkipTOTP() bool

IsSkipTOTP checks if TOTP verification should be skipped for this client. Returns false if the Oauth2Client is nil.

func (*Oauth2CustomScope) GetClaims ¶ added in v1.7.7

func (s *Oauth2CustomScope) GetClaims() []OIDCCustomClaim

GetClaims retrieves the list of custom claims for this scope. Returns an empty slice if the Oauth2CustomScope is nil.

func (*Oauth2CustomScope) GetDescription ¶ added in v1.7.7

func (s *Oauth2CustomScope) GetDescription() string

GetDescription retrieves the description of the custom scope. Returns an empty string if the Oauth2CustomScope is nil.

func (*Oauth2CustomScope) GetName ¶ added in v1.7.7

func (s *Oauth2CustomScope) GetName() string

GetName retrieves the name of the custom scope. Returns an empty string if the Oauth2CustomScope is nil.

func (*Oauth2CustomScope) GetOther ¶ added in v1.7.7

func (s *Oauth2CustomScope) GetOther() map[string]any