keychain

Documentation

Overview

Package keychain implements a native secure password store for each platform.

Index

• Constants
• Variables
• type Keychain
  • func NewKeychain(preferred, keychainName string) (*Keychain, error)
  • func NewMissingKeychain() *Keychain
  • func (kc *Keychain) Clear() error
  • func (kc *Keychain) Delete(userID string) error
  • func (kc *Keychain) Get(userID string) (string, string, error)
  • func (kc *Keychain) List() ([]string, error)
  • func (kc *Keychain) Put(userID, secret string) error

Constants

const Version = "k11"

Version is the keychain data version.

const WindowsCredentials = "windows-credentials"

Variables

var (
	// ErrNoKeychain indicates that no suitable keychain implementation could be loaded.
	ErrNoKeychain = errors.New("no keychain") //nolint:gochecknoglobals

	// ErrMacKeychainRebuild is returned on macOS with blocked or corrupted keychain.
	ErrMacKeychainRebuild = errors.New("keychain error -25293")

	// Helpers holds all discovered keychain helpers. It is populated in init().
	Helpers map[string]helperConstructor //nolint:gochecknoglobals

)

Types

type Keychain

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

func NewKeychain

func NewKeychain(preferred, keychainName string) (*Keychain, error)

NewKeychain creates a new native keychain.

func NewMissingKeychain

func NewMissingKeychain() *Keychain

NewMissingKeychain returns a new keychain that always returns an error.

func (*Keychain) Clear

func (kc *Keychain) Clear() error

func (*Keychain) Delete

func (kc *Keychain) Delete(userID string) error

func (*Keychain) Get

func (kc *Keychain) Get(userID string) (string, string, error)

Get returns the username and secret for the given userID.

func (*Keychain) List

func (kc *Keychain) List() ([]string, error)

func (*Keychain) Put

func (kc *Keychain) Put(userID, secret string) error