config

Documentation

Index

• func Bool(ctx context.Context, key string) bool
• func Directory() string
• func Int(ctx context.Context, key string) int
• func PwStoreDir(mount string) string
• func String(ctx context.Context, key string) string
• type Config
  • func FromContext(ctx context.Context) *Config
  • func New() *Config
  • func NewNoWrites() *Config
  • func (c *Config) Get(key string) string
  • func (c *Config) GetBool(key string) bool
  • func (c *Config) GetInt(key string) int
  • func (c *Config) GetM(mount, key string) string
  • func (c *Config) IsSet(key string) bool
  • func (c *Config) Keys(mount string) []string
  • func (c *Config) MountPath(mountPoint string) string
  • func (c *Config) Mounts() []string
  • func (c *Config) Path() string
  • func (c *Config) Set(mount, key, value string) error
  • func (c *Config) SetEnv(key, value string) error
  • func (c *Config) SetMountPath(mount, path string) error
  • func (c *Config) SetPath(path string) error
  • func (c *Config) Unset(mount, key string) error
  • func (c *Config) WithConfig(ctx context.Context) context.Context

Functions

func Bool

func Bool(ctx context.Context, key string) bool

Bool returns a bool value from the config in the context.

func Directory

func Directory() string

Directory returns the configuration directory for the gopass config file.

func Int

func Int(ctx context.Context, key string) int

Int returns an integer value from the config in the context.

func PwStoreDir

func PwStoreDir(mount string) string

PwStoreDir reads the password store dir from the environment or returns the default location if the env is not set.

func String

func String(ctx context.Context, key string) string

String returns a string value from the config in the context.

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is a gopass config handler.

func FromContext

func FromContext(ctx context.Context) *Config

func New

func New() *Config

New initializes a new gopass config. It will handle legacy configs as well.

func NewNoWrites

func NewNoWrites() *Config

NewNoWrites initializes a new config that does not allow writes. For use in tests.

func (*Config) Get

func (c *Config) Get(key string) string

Get returns the given key from the root config.

func (*Config) GetBool

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

GetBool returns true if the value of the key evaluates to "true". Otherwise it returns false.

func (*Config) GetInt

func (c *Config) GetInt(key string) int

GetInt returns the integer value of the key if it can be parsed. Otherwise it returns 0.

func (*Config) GetM

func (c *Config) GetM(mount, key string) string

GetM returns the given key from the mount or the root config if mount is empty.

func (*Config) IsSet

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

IsSet returns true if the key is set in the root config.

func (*Config) Keys

func (c *Config) Keys(mount string) []string

Keys returns all keys in the given config.

func (*Config) MountPath

func (c *Config) MountPath(mountPoint string) string

MountPath returns the mount store path.

func (*Config) Mounts

func (c *Config) Mounts() []string

Mounts returns all mount points from the root config. Note: Any mounts in local configs are ignored.

func (*Config) Path

func (c *Config) Path() string

Path returns the root store path.

func (*Config) Set

func (c *Config) Set(mount, key, value string) error

Set tries to set the key to the given value. The mount option is necessary to discern between the per-user (global) and possible per-directory (local) config files.

• If mount is empty the setting will be written to the per-user config (global)
• If mount has the special value "<root>" the setting will be written to the per-directory config of the root store (local)
• If mount has any other value we will attempt to write the setting to the per-directory config of this mount.
• If the mount point does not exist we will return nil.

func (*Config) SetEnv

func (c *Config) SetEnv(key, value string) error

SetEnv overrides a key in the non-persistent layer.

func (*Config) SetMountPath

func (c *Config) SetMountPath(mount, path string) error

SetMountPath is a short cut to set a mount to a path.

func (*Config) SetPath

func (c *Config) SetPath(path string) error

SetPath is a short cut to set the root store path.

func (*Config) Unset

func (c *Config) Unset(mount, key string) error

Unset deletes the key from the given config.

func (*Config) WithConfig

func (c *Config) WithConfig(ctx context.Context) context.Context