config

Documentation

Overview

Package config is a minimalist config package. It uses a flat structure and simple obfuscation to avoid over-the-shoulder or casual viewing of passwords on the file system. Future implementations may improve upon the data structure and allow for user provided passwords that will better protect the locally stored password. Or we can try to find a config library that supports:

• getting / setting values in a structured way (like Viper)
• securely prompting for values (I suppose this could be externalized)
• encrypting / decrypting / obfuscating stored values
• loading and saving configuration (not just reading)

Index

• Constants
• type Config
  • func NewConfig() Config
  • func (c Config) Get(group, name string) string
  • func (c Config) GetSecret(group, name string) (string, error)
  • func (c Config) PromptPlainText(group, name, prompt string) error
  • func (c Config) PromptSecret(group, name, prompt string) error
  • func (c Config) Read() error
  • func (c Config) Set(group, name string, value string)
  • func (c Config) SetSecret(group string, name string, plainText string) error
  • func (c Config) Write() error

Constants

const DefaultConfigFileName = ".graven.yaml"

Types

type Config

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

func NewConfig

func NewConfig() Config

func (Config) Get

func (c Config) Get(group, name string) string

func (Config) GetSecret

func (c Config) GetSecret(group, name string) (string, error)

func (Config) PromptPlainText

func (c Config) PromptPlainText(group, name, prompt string) error

func (Config) PromptSecret

func (c Config) PromptSecret(group, name, prompt string) error

func (Config) Read

func (c Config) Read() error

func (Config) Set

func (c Config) Set(group, name string, value string)

func (Config) SetSecret

func (c Config) SetSecret(group string, name string, plainText string) error

func (Config) Write

func (c Config) Write() error