keychain

Documentation

Index

• Variables
• type Keychain
  • func (Keychain) Delete(ref string) error
  • func (Keychain) Get(ref string) (string, error)
  • func (Keychain) Set(ref, value string) error
• type Store

Variables

var ErrBackend = errors.New("keychain backend error")

ErrBackend marks any keychain backend failure other than ErrNotFound. Store methods wrap ErrBackend so callers can classify pre-handoff keychain failures via errors.Is (ADR-0001 §6 exit codes).

var ErrNotFound = errors.New("keychain: item not found")

ErrNotFound is returned by Get when the keychain item does not exist.

Types

type Keychain

type Keychain struct{}

Keychain is the production Store backed by the OS keychain via go-keyring.

func (Keychain) Delete

func (Keychain) Delete(ref string) error

func (Keychain) Get

func (Keychain) Get(ref string) (string, error)

func (Keychain) Set

func (Keychain) Set(ref, value string) error

type Store

type Store interface {
	// Get returns the value stored under ref, or ErrNotFound.
	Get(ref string) (string, error)
	// Set stores value under ref.
	Set(ref, value string) error
	// Delete removes ref.
	Delete(ref string) error
}

Store provides access to keychain-stored secrets.