Documentation
¶
Index ¶
- func ByteSize(bytes uint64) string
- func CheckStrings(elements ...any) string
- func ComparePasswords(hashPassword string, plainPassword string) (bool, error)
- func DebugModule(module global.DbgModule, keyvals ...any)
- func GetHash(value string) string
- func GetProxyAddress(request *http.Request, guid, clientIP, clientPort string) (string, string)
- func IsInNetwork(networkList []string, guid, clientIP string) (matchIP bool)
- func NewDNSResolver() (resolver *net.Resolver)
- func PreparePassword(password string) string
- func ProtoErrToFields(err error) (fields []zap.Field)
- func RemoveCRLFFromQueryOrFilter(value string, sep string) string
- func ResolveIPAddress(ctx context.Context, address string) (hostname string)
- func ValidateUsername(username string) bool
- func WithNotAvailable(elements ...any) string
- type CryptPassword
- type MacroSource
- type RedisLogger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ByteSize ¶
ByteSize formats a given number of bytes into a human-readable string representation. If the number is less than 1024, it will be displayed in bytes (e.g., "256B"). Otherwise, the number will be converted into a larger unit (e.g., 1.5KB, 20MB, etc.).
func CheckStrings ¶
CheckStrings checks a list of strings and returns the first that is non-empty.
func ComparePasswords ¶
ComparePasswords takes a plain password and creates a hash. Then it compares the hashed passwords and returns true, if bothe passwords are equal. If an error occurs, the result is false for the compare operation and the error is returned.
func DebugModule ¶
func GetHash ¶
GetHash creates an SHA-256 hash of a plain text password and returns the first 128 bits.
func GetProxyAddress ¶
GetProxyAddress extracts the client IP address and port from the request headers. If the X-Forwarded-For header is present, the function checks if the client IP is in the list of trusted proxies. If it is not, the function returns the client IP and port unchanged. If the client IP is in the list of trusted proxies, the function logs the forwarding address and updates the client IP with the first IP address from X-Forwarded-For header, and sets the client port to "N/A". The function returns the updated client IP and port.
The function uses the following helper functions: - logForwarderFound: Logs the finding of the X-Forwarded-For header in the debug module. - IsInNetwork: Checks if an IP address is part of a list of networks. - logNoTrustedProxies: Logs a warning indicating that the client IP does not match the trusted proxies. - logTrustedProxy: Logs the client IP matching with the forwarded address. - global.NotAvailable: A constant used when data for a particular field is not available.
The function does not mutate the request or any other external state.
func IsInNetwork ¶ added in v1.2.6
IsInNetwork checks if an IP address is part of a list of networks. It iterates through the networkList and checks each network if it contains the given IP address. The function returns true if there is a match. The function logs any network errors encountered during the process. The function logs the information about checking a network for the given authentication object. The function logs the IP address of the client along with the IP address or network being checked.
func NewDNSResolver ¶ added in v1.1.3
NewDNSResolver creates a new DNS resolver based on the configured settings.
func PreparePassword ¶
func ProtoErrToFields ¶
func ResolveIPAddress ¶
ResolveIPAddress returns the hostname for a given IP address.
func ValidateUsername ¶
ValidateUsername validates the given username against the usernamePattern regular expression. It takes a string username as input and returns a boolean value representing whether the username is valid or not. The usernamePattern regular expression allows any character except "(", ")", "{", SP, CTL, "%", "*", "\", except empty string. The function returns true if the username matches the pattern, and false otherwise.
func WithNotAvailable ¶
WithNotAvailable checks a list of string. If none of the strings does have a content, we return the global.NotAvailable string.
Types ¶
type CryptPassword ¶
CryptPassword is a container for an encrypted password typically used in SQL fields.
func (*CryptPassword) Generate ¶
func (c *CryptPassword) Generate(plainPassword string, salt []byte, alg global.Algorithm, pwOption global.PasswordOption) ( string, error, )
Generate creates the encrypted form of a plain text password.
func (*CryptPassword) GetParameters ¶
func (c *CryptPassword) GetParameters(cryptedPassword string) ( salt []byte, alg global.Algorithm, pwOption global.PasswordOption, err error, )
GetParameters splits an encoded password into its components.
type MacroSource ¶
type MacroSource struct {
Username string
XLocalIP string
XPort string
ClientIP string
XClientPort string
TOTPSecret *string
Protocol config.Protocol
}
MacroSource holds all values that might be used in macros.
func (*MacroSource) ReplaceMacros ¶
func (m *MacroSource) ReplaceMacros(source string) (dest string)
ReplaceMacros replaces several macros with values found in the Authentication object.
%Modifiers{long variables}
Modifiers: (Optional): L - Lower U - Upper
R - Reverse the string T - Trim the string
Long variavles: user - full username, i.e. localpart@domain.tld username - the local part of {user}, if user has a domain part, else user and username are the same domain - the domain part of {user}. Empty string, if {user} did not contain a domain part service - The service name, i.e. imap, pop3, lmtp local_ip - local IP address local_port - local port remote_ip - remote client IP address remote_port - remote client port.
Source Files