secret

Documentation

Overview

Package secret provides a layer for storing secretes.

Index

• Variables
• type FallbackStash
  • func (f *FallbackStash) DeleteSecret(service, key string) error
  • func (f *FallbackStash) LoadSecret(service, key string) (string, error)
  • func (f *FallbackStash) SaveSecret(service, key, secret string) error
• type InsecureStash
  • func (f *InsecureStash) DeleteSecret(service, key string) error
  • func (f *InsecureStash) LoadSecret(service, key string) (string, error)
  • func (f *InsecureStash) SaveSecret(service, key, secret string) error
• type Keyring
  • func (*Keyring) DeleteSecret(service, key string) error
  • func (*Keyring) LoadSecret(service, key string) (string, error)
  • func (*Keyring) SaveSecret(service, key, secret string) error
• type MemoryStash
  • func (m *MemoryStash) DeleteSecret(service string, key string) error
  • func (m *MemoryStash) LoadSecret(service string, key string) (string, error)
  • func (m *MemoryStash) SaveSecret(service string, key string, secret string) error
• type Stash

Variables

var (
	// ErrNotFound is returned when a secret is not found.
	ErrNotFound = errors.New("secret not found")

	// ErrKeyringUnsupported indicates that secure storage
	// via the system keychain is not supported on the current platform.
	ErrKeyringUnsupported = keyring.ErrUnsupportedPlatform
)

Types

type FallbackStash

type FallbackStash struct {
	Primary, Secondary Stash // required
}

FallbackStash is a secret stash that falls back to a secondary stash if the primary stash fails.

func (*FallbackStash) DeleteSecret

func (f *FallbackStash) DeleteSecret(service, key string) error

DeleteSecret deletes a secret from the primary stash, and if that fails, from the secondary stash.

func (*FallbackStash) LoadSecret

func (f *FallbackStash) LoadSecret(service, key string) (string, error)

LoadSecret loads a secret from the primary stash. If the operation fails NOT because the secret is not found, it falls back to the secondary stash.

func (*FallbackStash) SaveSecret

func (f *FallbackStash) SaveSecret(service, key, secret string) error

SaveSecret saves a secret to the primary stash. If the operation fails, it falls back to the secondary stash.

type InsecureStash

type InsecureStash struct {
	// Destination path to the secrets file.
	Path string // required

	// Log is the logger used by the stash.
	Log *log.Logger // required
}

InsecureStash is a secrets stash that stores secrets in plain text. It prints a warning to stderr the first time it creates the file.

func (*InsecureStash) DeleteSecret

func (f *InsecureStash) DeleteSecret(service, key string) error

DeleteSecret deletes a secret from the stash. It is a no-op if the secret does not exist.

func (*InsecureStash) LoadSecret

func (f *InsecureStash) LoadSecret(service, key string) (string, error)

LoadSecret retrieves a secret from the stash. It returns ErrNotFound if the secret does not exist.

func (*InsecureStash) SaveSecret

func (f *InsecureStash) SaveSecret(service, key, secret string) error

SaveSecret stores a secret in the stash. The first time it creates the file, it prints a warning to stderr.

type Keyring

type Keyring struct{}

Keyring is a secure secret store that uses the system's keychain if available.

Its zero value is ready for use.

func (*Keyring) DeleteSecret

func (*Keyring) DeleteSecret(service, key string) error

DeleteSecret deletes a secret from the keyring.

func (*Keyring) LoadSecret

func (*Keyring) LoadSecret(service, key string) (string, error)

LoadSecret loads a secret from the keyring.

func (*Keyring) SaveSecret

func (*Keyring) SaveSecret(service, key, secret string) error

SaveSecret saves a secret in the keyring.

type MemoryStash

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

MemoryStash is an in-memory secret store for testing. Its zero value is ready for use.

func (*MemoryStash) DeleteSecret

func (m *MemoryStash) DeleteSecret(service string, key string) error

DeleteSecret deletes a secret from the memory stash.

func (*MemoryStash) LoadSecret

func (m *MemoryStash) LoadSecret(service string, key string) (string, error)

LoadSecret loads a secret from the memory stash.

func (*MemoryStash) SaveSecret

func (m *MemoryStash) SaveSecret(service string, key string, secret string) error

SaveSecret saves a secret in the memory stash.

type Stash

type Stash interface {
	SaveSecret(service, key, secret string) error
	LoadSecret(service, key string) (string, error)

	// DeleteSecret deletes a secret from the stash.
	// It is a no-op if the secret does not exist.
	DeleteSecret(service, key string) error
}

Stash stores and retrieves secrets.