config

Sep 8, 2024

Changes in this version

type ExpandOptions

+ func ExpandNonStringToCSV() ExpandOptions

+ func ExpandNonStringToJSON() ExpandOptions

Jun 26, 2024

Changes in this version

type ExpandOptions

+ func UseKeyfile(file string) ExpandOptions

Jun 5, 2024

Changes in this version

+ var ErrNoUserConfigDir = errors.New("cannot resolve user config directory, check $USER and $HOME exist")

May 23, 2024

Changes in this version

+ func ExpandHomeBytes(p []byte) []byte

May 21, 2024

Changes in this version

+ func AbbreviateHome(p string) string

+ func ExpandHome(p string) string

+ func ExtractCertificatePEM(h host.Host, path string) (data []byte, err error)

+ func ExtractPrivateKeyPEM(h host.Host, pt string) (key *memguard.Enclave, err error)

+ func MatchKey(cert *x509.Certificate, derkeys []*memguard.Enclave) int

+ func ReadCertificates(h host.Host, path string) (certs []*x509.Certificate)

+ func ReadInputPEMString(from, prompt string) (data string, err error)

+ func ReadPrivateKeyBytes(pembytes []byte) (key *memguard.Enclave, err error)

+ func ReadUserInputLine(format string, args ...any) (input string, err error)

type Config

+ func (c *Config) ExpandToPassword(input string, options ...ExpandOptions) *Plaintext

type KeyFile

+ func (k *KeyFile) CreateWithBackup(h host.Host, backup string) (crc uint32, err error)

+ func (k *KeyFile) ReadOrCreate(h host.Host, create bool) (crc32 uint32, created bool, err error)

type KeyValues

+ func (kv *KeyValues) ChecksumString() (c string, err error)

type Plaintext

+ func ExpandToPassword(input string, options ...ExpandOptions) *Plaintext

Apr 18, 2024

Changes in this version

type FileOptions

+ func StopOnInternalDefaultsErrors() FileOptions

type Plaintext

+ func (secret *Plaintext) Bytes() []byte

Nov 23, 2023

Changes in this version

+ func GetFloat64(key string) float64

+ func UserHomeDir(username ...string) (home string, err error)

type Config

+ func Sub(key string) *Config

+ func (c *Config) GetFloat64(key string) (value float64)

type KeyValues

+ func ReadKeyValues(r io.Reader) (kv *KeyValues)

Oct 25, 2023

Changes in this version

+ func AllKeys() []string

+ func AllSettings() map[string]any

+ func AutomaticEnv()

+ func BindEnv(input ...string) error

+ func ConfigFileUsed() string

+ func Get(key string) any

+ func GetBool(key string) bool

+ func GetDuration(key string) time.Duration

+ func GetStringMap(key string) any

+ func GetStringMapStringSlice(key string) map[string][]string

+ func GetUint(key string) uint

+ func GetUint16(key string) uint16

+ func IsSet(key string) bool

+ func MergeConfigMap(vals map[string]any) error

+ func RegisterAlias(alias, key string)

+ func SetDefault(key string, value any)

+ func SetEnvPrefix(prefix string)

+ func SetString(key, value string, options ...ExpandOptions)

+ func SetStringSlice(key string, values []string, options ...ExpandOptions)

type Config

+ Viper *viper.Viper

+ func (c *Config) AllKeys() (keys []string)

+ func (c *Config) AllSettings() (value map[string]any)

+ func (c *Config) AutomaticEnv()

+ func (c *Config) BindEnv(input ...string) (err error)

+ func (c *Config) ConfigFileUsed() (f string)

+ func (c *Config) Get(key string) (value any)

+ func (c *Config) GetBool(key string) (value bool)

+ func (c *Config) GetDuration(key string) (value time.Duration)

+ func (c *Config) GetStringMap(key string) (value map[string]any)

+ func (c *Config) GetStringMapStringSlice(key string) (values map[string][]string)

+ func (c *Config) GetUint(key string) (value uint)

+ func (c *Config) GetUint16(key string) (value uint16)

+ func (c *Config) IsSet(key string) (value bool)

+ func (c *Config) MergeConfigMap(vals map[string]any) (err error)

+ func (c *Config) RegisterAlias(alias, key string)

+ func (c *Config) Set(key string, value interface{})

+ func (c *Config) SetDefault(key string, value any)

+ func (c *Config) SetEnvPrefix(prefix string)

+ func (c *Config) SetString(key, value string, options ...ExpandOptions)

+ func (c *Config) SetStringSlice(key string, values []string, options ...ExpandOptions)

type ExpandOptions

+ func Replace(name string) ExpandOptions

type FileOptions

+ func WatchConfig() FileOptions

Oct 10, 2023

Changes in this version

type FileOptions

+ func SetConfigReader(in io.Reader) FileOptions

Oct 6, 2023

Changes in this version

+ func ReadCertificatePEM(h host.Host, pt string) (data []byte, err error)

+ func ReadPrivateKeyPEM(h host.Host, pt string) (key *memguard.Enclave, err error)

Sep 1, 2023

Changes in this version

+ func UserConfigDir(username ...string) (p string, err error) — darwin/amd64, js/wasm

Aug 16, 2023

Changes in this version

+ func Delimiter() string

+ func PrivateKeyType(der *memguard.Enclave) (keytype string)

+ func PublicKey(der *memguard.Enclave) (publickey crypto.PublicKey, err error)

+ func ReadCertChain(h host.Host, p string) (pool *x509.CertPool)

+ func WriteCertChain(h host.Host, p string, certs ...*x509.Certificate) (err error)

type Config

+ func (c *Config) Delimiter() string

Jul 28, 2023

Changes in this version

+ func UnmarshalKey(key string, rawVal interface{}, opts ...viper.DecoderConfigOption) error

type Config

+ func (c *Config) UnmarshalKey(key string, rawVal interface{}, opts ...viper.DecoderConfigOption) error

Jul 11, 2023

Changes in this version

+ const DefaultKeyType

+ func CreateCertificateAndKey(template, parent *x509.Certificate, ...) (cert *x509.Certificate, certKeyPEM *memguard.Enclave, err error)

+ func KeyType(key *memguard.Enclave) (keytype string)

+ func ParseCertificate(h host.Host, pt string) (cert *x509.Certificate, err error)

+ func ParseCertificates(h host.Host, p string) (certs []*x509.Certificate, err error)

+ func ParseKey(keyPEM *memguard.Enclave) (privateKey any, publickey crypto.PublicKey, err error)

+ func ReadPrivateKey(h host.Host, pt string) (key *memguard.Enclave, err error)

+ func WritePrivateKey(h host.Host, pt string, key *memguard.Enclave) (err error)

type FileOptions

+ func WithDefaults(defaults []byte, format string) FileOptions

+ func WithEnvs(prefix string, delimiter string) FileOptions

Jun 28, 2023

Changes in this version

type ExpandOptions

+ func Initial(value any) ExpandOptions

Jun 22, 2023

Changes in this version

type FileOptions

+ func UseEnvs(prefix string, delimiter string) FileOptions

Jun 7, 2023

Changes in this version

+ var ErrNotInteractive = errors.New("not an interactive session")

+ func DefaultFileExtension(extension string)

+ func ExpandStringSlice(input []string, options ...ExpandOptions) []string

+ func GetSliceStringMapString(s string, options ...ExpandOptions) (result []map[string]string)

type Config

+ func (c *Config) ExpandStringSlice(input []string, options ...ExpandOptions) (vals []string)

+ func (c *Config) GetSliceStringMapString(s string, options ...ExpandOptions) (result []map[string]string)

type ExpandOptions

+ func LookupTables(values []map[string]string) ExpandOptions

type FileOptions

+ func AddDirs(paths ...string) FileOptions

+ func FromDir(dir string) FileOptions

+ func SetFileExtension(extension string) FileOptions

May 31, 2023

Changes in this version

+ func AppConfigDir() string

type Config

+ func (c *Config) AppConfigDir() string

May 25, 2023

Changes in this version

+ func CreateCertKey(template, parent *x509.Certificate, ...) (cert *x509.Certificate, keyPEM *memguard.Enclave, err error)

+ func CreateRootCert(h host.Host, basefilepath string, overwrite bool) (err error)

+ func CreateSigningCert(h host.Host, basefilepath string, rootbasefilepath string, overwrite bool) (err error)

+ func NewPrivateKey() *memguard.Enclave

+ func ReadCert(h host.Host, path string) (cert *x509.Certificate, err error)

+ func ReadKey(h host.Host, path string) (key *memguard.Enclave, err error)

+ func WriteCert(h host.Host, path string, cert *x509.Certificate) (err error)

+ func WriteCerts(h host.Host, path string, certs ...*x509.Certificate) (err error)

+ func WriteKey(h host.Host, path string, key *memguard.Enclave) (err error)

May 22, 2023

Changes in this version

+ func AddCreds(creds Credentials, options ...FileOptions) (err error)

+ func DefaultKeyDelimiter(delimiter string)

+ func DeleteAllCreds(options ...FileOptions) (err error)

+ func DeleteCreds(domain string, options ...FileOptions) (err error)

+ func ExpandToEnclave(input string, options ...ExpandOptions) (value *memguard.Enclave)

+ func ExpandToLockedBuffer(input string, options ...ExpandOptions) (value *memguard.LockedBuffer)

+ func GetBytes(s string, options ...ExpandOptions) []byte

+ func Join(parts ...string) string

+ func Path(name string, options ...FileOptions) string

+ func PromoteFile(r host.Host, paths ...string) (final string)

+ func ReadUserInput(prompt string) (input string, err error)

+ func ResetConfig(options ...FileOptions)

+ func Save(name string, options ...FileOptions) (err error)

+ func Set(key string, value interface{})

+ func SetKeyValues(items ...string)

type Config

+ func FindCreds(path string, options ...FileOptions) (cred *Config)

+ func Load(name string, options ...FileOptions) (c *Config, err error)

+ func (c *Config) ExpandRawString(s string, options ...ExpandOptions) (value string, err error)

+ func (c *Config) ExpandToEnclave(input string, options ...ExpandOptions) (value *memguard.Enclave)

+ func (c *Config) ExpandToLockedBuffer(input string, options ...ExpandOptions) (value *memguard.LockedBuffer)

+ func (c *Config) GetBytes(s string, options ...ExpandOptions) []byte

+ func (c *Config) GetPassword(key string, options ...ExpandOptions) Plaintext

+ func (c *Config) Join(parts ...string) string

+ func (c *Config) SetKeyValues(items ...string)

+ func (cf *Config) FindCreds(path string) (creds *Config)

+ func (cf *Config) ReadRCConfig(r host.Host, path string, prefix string, aliases map[string]string) (err error)

+ func (cf *Config) Save(name string, options ...FileOptions) (err error)

+ type Credentials struct

+ ClientID string

+ ClientSecret string

+ Domain string

+ Password string

+ Renewal string

+ Token string

+ Username string

type ExpandOptions

+ func NoDecode() ExpandOptions

+ func NoExpand() ExpandOptions

+ type FileOptions func(*fileOptions)

+ func Host(r host.Host) FileOptions

+ func KeyDelimiter(delimiter string) FileOptions

+ func LoadDir(dir string) FileOptions

+ func MustExist() FileOptions

+ func SaveDir(dir string) FileOptions

+ func SetFileFormat(extension string) FileOptions

+ func SetGlobal() FileOptions

+ type KeyFile string

+ func (k *KeyFile) Base() string

+ func (k *KeyFile) Check(create bool) (crc32 uint32, created bool, err error)

+ func (k *KeyFile) Concat(extras ...string) string

+ func (k *KeyFile) Decode(input []byte) (plaintext []byte, err error)

+ func (k *KeyFile) DecodeEnclave(input []byte) (plaintext *memguard.Enclave, err error)

+ func (k *KeyFile) DecodeString(input string) (plaintext string, err error)

+ func (k *KeyFile) Dir() string

+ func (k *KeyFile) Encode(plaintext Plaintext, expandable bool) (out string, err error)

+ func (k *KeyFile) EncodePasswordInput(expandable bool) (out string, err error)

+ func (k *KeyFile) EncodeString(plaintext string, expandable bool) (out string, err error)

+ func (k *KeyFile) Read() (kv *KeyValues, err error)

+ func (k *KeyFile) RollKeyfile(backup string) (crc uint32, err error)

+ func (k *KeyFile) Set(value string) error

+ func (k *KeyFile) String() string

+ func (k *KeyFile) Type() string

+ func (k *KeyFile) Write(kv KeyValues) (err error)

+ type KeyValues struct

+ func NewKeyValues() (kv *KeyValues)

+ func NewRandomKeyValues() (kv *KeyValues)

+ func Read(r io.Reader) (kv *KeyValues)

+ func (kv *KeyValues) Checksum() (c uint32, err error)

+ func (kv *KeyValues) Decode(in []byte) (out []byte, err error)

+ func (kv *KeyValues) DecodeEnclave(in []byte) (out *memguard.Enclave, err error)

+ func (kv *KeyValues) DecodeString(in string) (out string, err error)

+ func (kv *KeyValues) Encode(in Plaintext) (out []byte, err error)

+ func (kv *KeyValues) EncodeString(in string) (out string, err error)

+ func (kv *KeyValues) String() string

+ func (kv *KeyValues) Write(w io.Writer) error

+ type Plaintext struct

+ func GetPassword(s string, options ...ExpandOptions) Plaintext

+ func NewPlaintext(buf []byte) Plaintext

+ func ReadPasswordInput(match bool, maxtries int, prompt ...string) (plaintext Plaintext, err error)

+ func (secret *Plaintext) IsNil() bool

+ func (secret *Plaintext) Set(value string) error

+ func (secret *Plaintext) String() string

+ func (secret *Plaintext) Type() string

Apr 12, 2023

Changes in this version

+ func GetInt(s string, options ...ExpandOptions) int

+ func GetInt64(s string, options ...ExpandOptions) int64

+ func SetStringMapString(m string, vals map[string]string)

type Config

+ func (c *Config) GetInt(s string, options ...ExpandOptions) (i int)

+ func (c *Config) GetInt64(s string, options ...ExpandOptions) (i int64)

+ func (c *Config) SetStringMapString(m string, vals map[string]string)

type ExpandOptions

+ func Default(value any) ExpandOptions

+ func TrimSpace(yes bool) ExpandOptions

Dec 19, 2022

Changes in this version

+ func EncodePasswordPrompt(keyfile string, expandable bool) (out string, err error)

+ func EncodeWithKey(plaintext []byte, key []byte) (out string, err error)

+ func EncodeWithKeyReader(plaintext []byte, r io.Reader) (out string, err error)

+ func EncodeWithKeyfile(plaintext []byte, keyfile string, expandable bool) (out string, err error)

+ func Expand(input string, options ...ExpandOptions) (value []byte)

+ func GetByteSlice(s string, options ...ExpandOptions) []byte

+ func ReadPasswordFile(path string) []byte

+ func ReadPasswordPrompt(prompt ...string) []byte

type AESValues

+ func (a AESValues) EncodeAESBytes(in []byte) (out []byte, err error)

type Config

+ func ReadHOCONFile(path string) (cf *Config, err error)

+ func (c *Config) DefaultExpandOptions(options ...ExpandOptions)

+ func (c *Config) Expand(input string, options ...ExpandOptions) (value []byte)

+ func (c *Config) GetByteSlice(s string, options ...ExpandOptions) []byte

+ func (cf *Config) MergeHOCONConfig(conf string) (err error)

+ func (cf *Config) MergeHOCONFile(path string) (err error)

+ type ExpandOptions func(*expandOptions)

+ func Expressions(yes bool) ExpandOptions

+ func ExternalLookups(yes bool) ExpandOptions

+ func LookupTable(values map[string]string) ExpandOptions

+ func Prefix(prefix string, fn func(*Config, string) string) ExpandOptions

+ func TrimPrefix() ExpandOptions

type Options

+ func Global() Options

+ func MergeSettings() Options

+ func UseDefaults(b bool) Options

Nov 2, 2022

Changes in this version

+ func UserConfigDir(username ...string) (path string, err error) — linux/amd64, windows/amd64

Oct 25, 2022

Changes in this version

+ func ExpandString(input string, values ...map[string]string) (value string)

Oct 11, 2022

Changes in this version

+ func Checksum(r io.Reader) (c uint32, err error)

+ func ChecksumFile(path string) (c uint32, err error)

+ func ChecksumString(in string) (c uint32, err error)

+ func GetString(s string, values ...map[string]string) string

+ func GetStringMapString(s string, values ...map[string]string) map[string]string

+ func GetStringSlice(s string, values ...map[string]string) []string

+ type AESValues struct

+ IV []byte

+ Key []byte

+ func NewAESValues() (a AESValues, err error)

+ func ReadAESValues(r io.Reader) (a AESValues, err error)

+ func ReadAESValuesFile(path string) (a AESValues, err error)

+ func (a *AESValues) Checksum() (c uint32, err error)

+ func (a AESValues) DecodeAES(in []byte) (out []byte, err error)

+ func (a AESValues) DecodeAESString(in string) (out string, err error)

+ func (a AESValues) EncodeAES(in []byte) (out []byte, err error)

+ func (a AESValues) EncodeAESString(in string) (out string, err error)

+ func (a AESValues) String() string

+ func (a AESValues) WriteAESValues(w io.Writer) error

+ type Config struct

+ Type string

+ func GetConfig() *Config

+ func LoadConfig(configName string, options ...Options) (c *Config, err error)

+ func New() *Config

+ func (c *Config) ExpandAllSettings(values ...map[string]string) (all map[string]interface{})

+ func (c *Config) ExpandString(input string, values ...map[string]string) (value string)

+ func (c *Config) GetString(s string, values ...map[string]string) string

+ func (c *Config) GetStringMapString(s string, values ...map[string]string) (m map[string]string)

+ func (c *Config) GetStringSlice(s string, values ...map[string]string) (slice []string)

+ func (c *Config) Sub(key string) *Config

+ type Options func(*configOptions)

+ func AddConfigDirs(paths ...string) Options

+ func IgnoreSystemDir() Options

+ func IgnoreUserConfDir() Options

+ func IgnoreWorkingDir() Options

+ func SetAppName(name string) Options

+ func SetConfigFile(path string) Options

+ func SetDefaults(defaults []byte, format string) Options

+ func UseGlobal() Options