config

Documentation

Index

• Variables
• func Directory() string
• func Homedir() string
• func PwStoreDir(mount string) string
• type Config
  • func Load() *Config
  • func New() *Config
  • func (c *Config) CheckOverflow() error
  • func (c *Config) Config() *Config
  • func (c *Config) Directory() string
  • func (c *Config) Save() error
  • func (c *Config) SetConfigValue(mount, key, value string) error
  • func (c *Config) String() string
• type Pre130
  • func (c *Pre130) CheckOverflow() error
  • func (c *Pre130) Config() *Config
• type Pre140
  • func (c *Pre140) CheckOverflow() error
  • func (c *Pre140) Config() *Config
• type StoreConfig
  • func (c *StoreConfig) ConfigMap() map[string]string
  • func (c *StoreConfig) SetConfigValue(key, value string) error
  • func (c *StoreConfig) String() string
  • func (c StoreConfig) WithContext(ctx context.Context) context.Context

Variables

var (
	// ErrConfigNotFound is returned on load if the config was not found
	ErrConfigNotFound = errors.Errorf("config not found")
	// ErrConfigNotParsed is returned on load if the config could not be decoded
	ErrConfigNotParsed = errors.Errorf("config not parseable")
)

Functions

func Directory

func Directory() string

Directory returns the configuration directory for the gopass config file

func Homedir

func Homedir() string

Homedir returns the users home dir or an empty string if the lookup fails

func PwStoreDir

func PwStoreDir(mount string) string

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

Types

type Config

type Config struct {
	Path    string                  `yaml:"-"`
	Root    *StoreConfig            `yaml:"root"`
	Mounts  map[string]*StoreConfig `yaml:"mounts"`
	Version string                  `yaml:"version"`

	// Catches all undefined files and must be empty after parsing
	XXX map[string]interface{} `yaml:",inline"`
}

Config is the current config struct

func Load

func Load() *Config

Load will try to load the config from one of the default locations

func New

func New() *Config

New creates a new config with sane default values

func (*Config) CheckOverflow

func (c *Config) CheckOverflow() error

CheckOverflow implements configer. It will check for any extra config values not handled by the current struct

func (*Config) Config

func (c *Config) Config() *Config

Config will return a current config

func (*Config) Directory

func (c *Config) Directory() string

Directory returns the directory this config is using

func (*Config) Save

func (c *Config) Save() error

Save saves the config

func (*Config) SetConfigValue

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

SetConfigValue will try to set the given key to the value in the config struct

func (*Config) String

func (c *Config) String() string

type Pre130

type Pre130 struct {
	AlwaysTrust bool              `yaml:"alwaystrust"` // always trust public keys when encrypting
	AskForMore  bool              `yaml:"askformore"`  // ask for more data on generate
	AutoImport  bool              `yaml:"autoimport"`  // import missing public keys w/o asking
	AutoPull    bool              `yaml:"autopull"`    // pull from git before push
	AutoPush    bool              `yaml:"autopush"`    // push to git remote after commit
	ClipTimeout int               `yaml:"cliptimeout"` // clear clipboard after seconds
	Debug       bool              `yaml:"debug"`       // enable debug output
	LoadKeys    bool              `yaml:"loadkeys"`    // load missing keys from store
	Mounts      map[string]string `yaml:"mounts,omitempty"`
	NoColor     bool              `yaml:"nocolor"`     // disable colors in output
	NoConfirm   bool              `yaml:"noconfirm"`   // do not confirm recipients when encrypting
	Path        string            `yaml:"path"`        // path to the root store
	PersistKeys bool              `yaml:"persistkeys"` // store recipient keys in store
	SafeContent bool              `yaml:"safecontent"` // avoid showing passwords in terminal
	Version     string            `yaml:"version"`

	// Catches all undefined files and must be empty after parsing
	XXX map[string]interface{} `yaml:",inline"`
}

Pre130 is the gopass config structure before version 1.3.0. Not all fields were available between 1.0.0 and 1.3.0, but this struct should cover all of them.

func (*Pre130) CheckOverflow

func (c *Pre130) CheckOverflow() error

CheckOverflow implements configer

func (*Pre130) Config

func (c *Pre130) Config() *Config

Config converts the Pre130 config to the current config struct

type Pre140

type Pre140 struct {
	AskForMore  bool              `yaml:"askformore"`  // ask for more data on generate
	AutoImport  bool              `yaml:"autoimport"`  // import missing public keys w/o asking
	AutoSync    bool              `yaml:"autosync"`    // push to git remote after commit, pull before push if necessary
	ClipTimeout int               `yaml:"cliptimeout"` // clear clipboard after seconds
	Mounts      map[string]string `yaml:"mounts,omitempty"`
	NoConfirm   bool              `yaml:"noconfirm"`   // do not confirm recipients when encrypting
	Path        string            `yaml:"path"`        // path to the root store
	SafeContent bool              `yaml:"safecontent"` // avoid showing passwords in terminal
	Version     string            `yaml:"version"`

	// Catches all undefined files and must be empty after parsing
	XXX map[string]interface{} `yaml:",inline"`
}

Pre140 is the gopass config structure before version 1.4.0

func (*Pre140) CheckOverflow

func (c *Pre140) CheckOverflow() error

CheckOverflow implements configer

func (*Pre140) Config

func (c *Pre140) Config() *Config

Config converts the Pre140 config to the current config struct

type StoreConfig

type StoreConfig struct {
	AskForMore     bool         `yaml:"askformore"`     // ask for more data on generate
	AutoClip       bool         `yaml:"autoclip"`       // decide whether passwords are automatically copied or not
	AutoImport     bool         `yaml:"autoimport"`     // import missing public keys w/o asking
	AutoSync       bool         `yaml:"autosync"`       // push to git remote after commit, pull before push if necessary
	ClipTimeout    int          `yaml:"cliptimeout"`    // clear clipboard after seconds
	EditRecipients bool         `yaml:"editrecipients"` // edit recipients when confirming
	NoColor        bool         `yaml:"nocolor"`        // do not use color when outputing text
	NoConfirm      bool         `yaml:"noconfirm"`      // do not confirm recipients when encrypting
	NoPager        bool         `yaml:"nopager"`        // do not invoke a pager to display long lists
	Path           *backend.URL `yaml:"path"`           // path to the root store
	SafeContent    bool         `yaml:"safecontent"`    // avoid showing passwords in terminal
	UseSymbols     bool         `yaml:"usesymbols"`     // always use symbols when generating passwords
	Notifications  bool         `yaml:"notifications"`  // enable desktop notifications
}

StoreConfig is a per-store (root or mount) config

func (*StoreConfig) ConfigMap

func (c *StoreConfig) ConfigMap() map[string]string

ConfigMap returns a map of stringified config values for easy printing

func (*StoreConfig) SetConfigValue

func (c *StoreConfig) SetConfigValue(key, value string) error

SetConfigValue will try to set the given key to the value in the config struct

func (*StoreConfig) String

func (c *StoreConfig) String() string

func (StoreConfig) WithContext

func (c StoreConfig) WithContext(ctx context.Context) context.Context

WithContext returns a context with all config options set for this store config, iff they have not been already set in the context