utils

Documentation

Index

• Constants
• Variables
• func CheckUntil(interval time.Duration, timeout time.Duration, predicate func() (bool, error)) error
• func Command(name string, args ...string) *exec.Cmd
• func CommandWithStdout(name string, args ...string) *exec.Cmd
• func Decrypt(ciphertext []byte, key *[32]byte) (plaintext []byte, err error)
• func DirectoryExists(path string) (exists bool, err error)
• func Encrypt(plaintext []byte, key *[32]byte) (ciphertext []byte, err error)
• func ExportRsaPrivateKeyAsPemStr(privkey *rsa.PrivateKey) string
• func ExportRsaPublicKeyAsPemStr(pubkey *rsa.PublicKey) (string, error)
• func FileExists(path string) (exists bool, err error)
• func GenerateRsaKeyPair(bits int) (*rsa.PrivateKey, *rsa.PublicKey)
• func GetExpectedErrTxt(err string) string
• func HashSHA256FromPath(path string) (output string, err error)
• func HashSHA256FromString(input string) (output string)
• func IsRedirectionSafe(url url.URL, protectedDomain string) bool
• func IsRedirectionURISafe(uri, protectedDomain string) (bool, error)
• func IsStringAbsURL(input string) (err error)
• func IsStringAlphaNumeric(input string) bool
• func IsStringInSlice(needle string, haystack []string) (inSlice bool)
• func IsStringInSliceContains(needle string, haystack []string) (inSlice bool)
• func IsStringInSliceFold(needle string, haystack []string) (inSlice bool)
• func IsStringInSliceSuffix(needle string, haystack []string) (hasSuffix bool)
• func IsStringSlicesDifferent(a, b []string) (different bool)
• func IsStringSlicesDifferentFold(a, b []string) (different bool)
• func NewTLSConfig(config *schema.TLSConfig, defaultMinVersion uint16, certPool *x509.CertPool) (tlsConfig *tls.Config)
• func NewX509CertPool(directory string) (certPool *x509.CertPool, warnings []error, errors []error)
• func ParseDurationString(input string) (time.Duration, error)
• func ParseRsaPrivateKeyFromPemStr(privPEM string) (*rsa.PrivateKey, error)
• func ParseRsaPublicKeyFromPemStr(pubPEM string) (*rsa.PublicKey, error)
• func PathExists(path string) (exists bool, err error)
• func RandomString(n int, characters []rune) (randomString string)
• func RunCommandAndReturnOutput(command string) (output string, exitCode int, err error)
• func RunCommandUntilCtrlC(cmd *exec.Cmd)
• func RunCommandWithTimeout(cmd *exec.Cmd, timeout time.Duration) error
• func RunFuncUntilCtrlC(fn func() error) error
• func RunFuncWithRetry(attempts int, sleep time.Duration, f func() error) (err error)
• func Shell(command string) *exec.Cmd
• func SliceString(s string, d int) (array []string)
• func StringHTMLEscape(input string) (output string)
• func StringSlicesDelta(before, after []string) (added, removed []string)
• func TLSStringToTLSConfigVersion(input string) (version uint16, err error)
• func Version() (versionString string)
• type Clock
• type ErrSliceSortAlphabetical
  • func (s ErrSliceSortAlphabetical) Len() int
  • func (s ErrSliceSortAlphabetical) Less(i, j int) bool
  • func (s ErrSliceSortAlphabetical) Swap(i, j int)
• type RealClock
  • func (RealClock) After(d time.Duration) <-chan time.Time
  • func (RealClock) Now() time.Time

Constants

const (

	// RFC3339Zero is the default value for time.Time.Unix().
	RFC3339Zero = int64(-62135596800)

	// TLS13 is the textual representation of TLS 1.3.
	TLS13 = "1.3"

	// TLS12 is the textual representation of TLS 1.2.
	TLS12 = "1.2"

	// TLS11 is the textual representation of TLS 1.1.
	TLS11 = "1.1"

	// TLS10 is the textual representation of TLS 1.0.
	TLS10 = "1.0"
)

const (
	// Hour is an int based representation of the time unit.
	Hour = time.Minute * 60

	// Day is an int based representation of the time unit.
	Day = Hour * 24

	// Week is an int based representation of the time unit.
	Week = Day * 7

	// Year is an int based representation of the time unit.
	Year = Day * 365

	// Month is an int based representation of the time unit.
	Month = Year / 12
)

Variables

var AlphaNumericCharacters = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")

AlphaNumericCharacters are literally just valid alphanumeric chars.

var BuildBranch = "master"

BuildBranch is replaced by LDFLAGS at build time with the current branch.

var BuildCommit = "unknown"

BuildCommit is replaced by LDFLAGS at build time with the current commit.

var BuildDate = ""

BuildDate is replaced by LDFLAGS at build time with the date the build started.

var BuildExtra = ""

BuildExtra is replaced by LDFLAGS at build time with a blank string by default. People porting Authelia can use this to add a suffix to their versions.

var BuildNumber = "0"

BuildNumber is replaced by LDFLAGS at build time with the CI build number.

var BuildState = "untagged dirty"

BuildState is replaced by LDFLAGS at build time with `tagged` or `untagged` depending on if the commit is tagged, and `clean` or `dirty` depending on the working tree state. For example if the commit was tagged and the working tree was dirty it would be "tagged dirty". This is used to determine the version string output mode.

var BuildTag = "unknown"

BuildTag is replaced by LDFLAGS at build time with the latest tag at or before the current commit.

var ErrTLSVersionNotSupported = errors.New("supplied TLS version isn't supported")

ErrTLSVersionNotSupported returned when an unknown TLS version supplied.

var ErrTimeoutReached = errors.New("timeout reached")

ErrTimeoutReached error thrown when a timeout is reached.

Functions

func CheckUntil

func CheckUntil(interval time.Duration, timeout time.Duration, predicate func() (bool, error)) error

CheckUntil regularly check a predicate until it's true or time out is reached.

func Command

func Command(name string, args ...string) *exec.Cmd

Command create a command at the project root.

func CommandWithStdout

func CommandWithStdout(name string, args ...string) *exec.Cmd

CommandWithStdout create a command forwarding stdout and stderr to the OS streams.

func Decrypt

func Decrypt(ciphertext []byte, key *[32]byte) (plaintext []byte, err error)

Decrypt decrypts data using 256-bit AES-GCM. This both hides the content of the data and provides a check that it hasn't been altered. Expects input form nonce|ciphertext|tag where '|' indicates concatenation.

func DirectoryExists

func DirectoryExists(path string) (exists bool, err error)

DirectoryExists returns true if the given path exists and is a directory.

func Encrypt

func Encrypt(plaintext []byte, key *[32]byte) (ciphertext []byte, err error)

Encrypt encrypts data using 256-bit AES-GCM. This both hides the content of the data and provides a check that it hasn't been altered. Output takes the form nonce|ciphertext|tag where '|' indicates concatenation.

func ExportRsaPrivateKeyAsPemStr

func ExportRsaPrivateKeyAsPemStr(privkey *rsa.PrivateKey) string

ExportRsaPrivateKeyAsPemStr marshal a rsa private key into PEM string.

func ExportRsaPublicKeyAsPemStr

func ExportRsaPublicKeyAsPemStr(pubkey *rsa.PublicKey) (string, error)

ExportRsaPublicKeyAsPemStr marshal a RSA public into a PEM string.

func FileExists

func FileExists(path string) (exists bool, err error)

FileExists returns true if the given path exists and is a file.

func GenerateRsaKeyPair

func GenerateRsaKeyPair(bits int) (*rsa.PrivateKey, *rsa.PublicKey)

GenerateRsaKeyPair generate an RSA key pair. bits can be 2048 or 4096.

func GetExpectedErrTxt

func GetExpectedErrTxt(err string) string

GetExpectedErrTxt returns error text for expected errs.

func HashSHA256FromPath

func HashSHA256FromPath(path string) (output string, err error)

HashSHA256FromPath takes a path string and calculates the SHA256 checksum of the file at the path returning it as a base16 hash string.

func HashSHA256FromString

func HashSHA256FromString(input string) (output string)

HashSHA256FromString takes an input string and calculates the SHA256 checksum returning it as a base16 hash string.

func IsRedirectionSafe

func IsRedirectionSafe(url url.URL, protectedDomain string) bool

IsRedirectionSafe determines whether the URL is safe to be redirected to.

func IsRedirectionURISafe

func IsRedirectionURISafe(uri, protectedDomain string) (bool, error)

IsRedirectionURISafe determines whether the URI is safe to be redirected to.

func IsStringAbsURL

func IsStringAbsURL(input string) (err error)

IsStringAbsURL checks a string can be parsed as a URL and that is IsAbs and if it can't it returns an error describing why.

func IsStringAlphaNumeric

func IsStringAlphaNumeric(input string) bool

IsStringAlphaNumeric returns false if any rune in the string is not alpha-numeric.

func IsStringInSlice

func IsStringInSlice(needle string, haystack []string) (inSlice bool)

IsStringInSlice checks if a single string is in a slice of strings.

func IsStringInSliceContains

func IsStringInSliceContains(needle string, haystack []string) (inSlice bool)

IsStringInSliceContains checks if a single string is in an array of strings.

func IsStringInSliceFold

func IsStringInSliceFold(needle string, haystack []string) (inSlice bool)

IsStringInSliceFold checks if a single string is in a slice of strings but uses strings.EqualFold to compare them.

func IsStringInSliceSuffix

func IsStringInSliceSuffix(needle string, haystack []string) (hasSuffix bool)

IsStringInSliceSuffix checks if the needle string has one of the suffixes in the haystack.

func IsStringSlicesDifferent

func IsStringSlicesDifferent(a, b []string) (different bool)

IsStringSlicesDifferent checks two slices of strings and on the first occurrence of a string item not existing in the other slice returns true, otherwise returns false.

func IsStringSlicesDifferentFold

func IsStringSlicesDifferentFold(a, b []string) (different bool)

IsStringSlicesDifferentFold checks two slices of strings and on the first occurrence of a string item not existing in the other slice (case insensitive) returns true, otherwise returns false.

func NewTLSConfig

func NewTLSConfig(config *schema.TLSConfig, defaultMinVersion uint16, certPool *x509.CertPool) (tlsConfig *tls.Config)

NewTLSConfig generates a tls.Config from a schema.TLSConfig and a x509.CertPool.

func NewX509CertPool

func NewX509CertPool(directory string) (certPool *x509.CertPool, warnings []error, errors []error)

NewX509CertPool generates a x509.CertPool from the system PKI and the directory specified.

func ParseDurationString

func ParseDurationString(input string) (time.Duration, error)

ParseDurationString parses a string to a duration Duration notations are an integer followed by a unit Units are s = second, m = minute, d = day, w = week, M = month, y = year Example 1y is the same as 1 year.

func ParseRsaPrivateKeyFromPemStr

func ParseRsaPrivateKeyFromPemStr(privPEM string) (*rsa.PrivateKey, error)

ParseRsaPrivateKeyFromPemStr parse a RSA private key from PEM string.

func ParseRsaPublicKeyFromPemStr

func ParseRsaPublicKeyFromPemStr(pubPEM string) (*rsa.PublicKey, error)

ParseRsaPublicKeyFromPemStr parse RSA public key from a PEM string.

func PathExists

func PathExists(path string) (exists bool, err error)

PathExists returns true if the given path exists.

func RandomString

func RandomString(n int, characters []rune) (randomString string)

RandomString generate a random string of n characters.

func RunCommandAndReturnOutput

func RunCommandAndReturnOutput(command string) (output string, exitCode int, err error)

RunCommandAndReturnOutput runs a shell command then returns the stdout and the exit code.

func RunCommandUntilCtrlC

func RunCommandUntilCtrlC(cmd *exec.Cmd)

RunCommandUntilCtrlC run a command until ctrl-c is hit.

func RunCommandWithTimeout

func RunCommandWithTimeout(cmd *exec.Cmd, timeout time.Duration) error

RunCommandWithTimeout run a command with timeout.

func RunFuncUntilCtrlC

func RunFuncUntilCtrlC(fn func() error) error

RunFuncUntilCtrlC run a function until ctrl-c is hit.

func RunFuncWithRetry

func RunFuncWithRetry(attempts int, sleep time.Duration, f func() error) (err error)

RunFuncWithRetry run a function for n attempts with a sleep of n duration between each attempt.

func Shell

func Shell(command string) *exec.Cmd

Shell create a shell command.

func SliceString

func SliceString(s string, d int) (array []string)

SliceString splits a string s into an array with each item being a max of int d d = denominator, n = numerator, q = quotient, r = remainder.

func StringHTMLEscape

func StringHTMLEscape(input string) (output string)

StringHTMLEscape escapes chars for a HTML body.

func StringSlicesDelta

func StringSlicesDelta(before, after []string) (added, removed []string)

StringSlicesDelta takes a before and after []string and compares them returning a added and removed []string.

func TLSStringToTLSConfigVersion

func TLSStringToTLSConfigVersion(input string) (version uint16, err error)

TLSStringToTLSConfigVersion returns a go crypto/tls version for a tls.Config based on string input.

func Version

func Version() (versionString string)

Version returns the Authelia version.

The format of the string is dependent on the values in BuildState. If tagged and clean are present it returns the BuildTag i.e. v1.0.0. If dirty and tagged are present it returns <BuildTag>-dirty. Otherwise the following is the format: untagged-<BuildTag>-dirty-<BuildExtra> (<BuildBranch>, <BuildCommit>).

Types

type Clock

type Clock interface {
	Now() time.Time
	After(d time.Duration) <-chan time.Time
}

Clock is an interface for a clock.

type ErrSliceSortAlphabetical

type ErrSliceSortAlphabetical []error

ErrSliceSortAlphabetical is a helper type that can be used with sort.Sort to sort a slice of errors in alphabetical order. Usage is simple just do sort.Sort(ErrSliceSortAlphabetical([]error{})).

func (ErrSliceSortAlphabetical) Len

func (s ErrSliceSortAlphabetical) Len() int

func (ErrSliceSortAlphabetical) Less

func (s ErrSliceSortAlphabetical) Less(i, j int) bool

func (ErrSliceSortAlphabetical) Swap

func (s ErrSliceSortAlphabetical) Swap(i, j int)

type RealClock

type RealClock struct{}

RealClock is the implementation of a clock for production code.

func (RealClock) After

func (RealClock) After(d time.Duration) <-chan time.Time

After return a channel receiving the time after the defined duration.

func (RealClock) Now

func (RealClock) Now() time.Time

Now return the current time.