config

Documentation

Index

• Variables
• func BoD(t time.Time) time.Time
• func Decrypt(encodedData string, secret []byte) (string, error)
• func DirFromSearchPath(searchpath string) (dir *os.File, err error)
• func Encrypt(plainData, secret []byte) (string, error)
• func FileFromSearchPath(searchpath string) (file *os.File, err error)
• func GetDatetime(tstr string) (t time.Time, err error)
• func GetDatetimeInLocation(tstr string, location *time.Location) (t time.Time, err error)
• func GetDecryptedSecret(name string, key []byte) (secret string, err error)
• func GetLast(day time.Weekday) time.Time
• func GetRawSecret(name string) (secret []byte, err error)
• func GetSecret(name string) (secret string, err error)
• func GetWeekday(day string) (time.Weekday, error)
• func IfGetBool(name string, deflt bool) (value bool)
• func IfGetDuration(name string, deflt time.Duration) (value time.Duration)
• func IfGetInt(name string, deflt int) (value int)
• func IfGetRune(name string, deflt rune) (rvalue rune)
• func IfGetenv(name, deflt string) (value string)
• func LoadFromSearchPath(file, searchpath string) (data []byte, err error)
• func MustGetBool(name string) (value bool)
• func MustGetConfig(name string) string
• func MustGetDuration(name string) (value time.Duration)
• func MustGetInt(name string) (value int)
• func MustGetRune(name string, deflt rune) (rvalue rune)
• func MustGetSecret(name string) string
• func MustGetenv(name string) (v string)
• func SetLogger(logger *slog.Logger)

Variables

var DecryptionKey string

applications that use encrypted secrets must set this as a package global

Functions

func BoD

func BoD(t time.Time) time.Time

BoD returns returns the time at midnight of the given time

func Decrypt

func Decrypt(encodedData string, secret []byte) (string, error)

Decrypt decrypts encodedData string with a secret key and returns plain string.

func DirFromSearchPath

func DirFromSearchPath(searchpath string) (dir *os.File, err error)

DirFromSearchPath returns the first valid directory in searchpath

func Encrypt

func Encrypt(plainData, secret []byte) (string, error)

Encrypt encrypts plainData string with a secret key and returns encrypt string.

func FileFromSearchPath

func FileFromSearchPath(searchpath string) (file *os.File, err error)

FileFromSearchPath returns first valid file in searchpath

func GetDatetime

func GetDatetime(tstr string) (t time.Time, err error)

GetDatetime attempts to parse a partial time string against formats into time.Time

func GetDatetimeInLocation

func GetDatetimeInLocation(tstr string, location *time.Location) (t time.Time, err error)

GetDatetimeInLocation attempts to parse a partial time string against formats into time.Time in a given time.Location

func GetDecryptedSecret

func GetDecryptedSecret(name string, key []byte) (secret string, err error)

GetDecryptedSecret returns the decrypted value of an encrypted Docker secret

func GetLast

func GetLast(day time.Weekday) time.Time

GetLast returns time at midnight of the most recent given weekday

func GetRawSecret

func GetRawSecret(name string) (secret []byte, err error)

GetRawSecret returns the raw value of Docker secret

func GetSecret

func GetSecret(name string) (secret string, err error)

GetSecret returns the value of Docker secret

func GetWeekday

func GetWeekday(day string) (time.Weekday, error)

GetWeekday returns a time.Weekday parsed from a given day string

func IfGetBool

func IfGetBool(name string, deflt bool) (value bool)

IfGetBool returns the int value of environment variable name; if name is not found or value cannot be parsed as an int return deflt

func IfGetDuration

func IfGetDuration(name string, deflt time.Duration) (value time.Duration)

IfGetDuration returns the time.Duration value of environment variable name; if name is not found or value cannot be parsed as a time.Duration return deflt

func IfGetInt

func IfGetInt(name string, deflt int) (value int)

IfGetInt returns the int value of environment variable name; if name is not found or value cannot be parsed as an int return deflt

func IfGetRune

func IfGetRune(name string, deflt rune) (rvalue rune)

IfGetRune returns the rune value of environment variable name; if name is not found or value cannot be parsed as an rune return deflt

func IfGetenv

func IfGetenv(name, deflt string) (value string)

IfGetenv returns the value of environment variable name if found, else deflt

func LoadFromSearchPath

func LoadFromSearchPath(file, searchpath string) (data []byte, err error)

LoadFromSearchPath returns the data read from the first valid file in searchpath

func MustGetBool

func MustGetBool(name string) (value bool)

MustGetBool returns the int value of environment variable name; if name is not found or value cannot be parsed as an int exit with fatal error

func MustGetConfig

func MustGetConfig(name string) string

MustGetConfig returns the value of the Docker secret with name, if it exists; if the secret cannot be read, returns the value of environment variable name; if name is not found in either Docker secrets or as an environment variable, exit with fatal error

func MustGetDuration

func MustGetDuration(name string) (value time.Duration)

MustGetDuration returns the time.Duration value of environment variable name; if name is not found or value cannot be parsed as a time.Duration exit with fatal error

func MustGetInt

func MustGetInt(name string) (value int)

MustGetInt returns the int value of environment variable name; if name is not found or value cannot be parsed as an int exit with fatal error

func MustGetRune

func MustGetRune(name string, deflt rune) (rvalue rune)

MustGetRune returns the rune value of environment variable name; if name is not found or value cannot be parsed as an rune return deflt

func MustGetSecret

func MustGetSecret(name string) string

MustGetSecret returns the value of the Docker secret with name; if the secret cannot be read exit with fatal error

func MustGetenv

func MustGetenv(name string) (v string)

MustGetenv returns the value of environment variable name; if name is not found exit with fatal error

func SetLogger

func SetLogger(logger *slog.Logger)