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
• type SecretServiceDBusHelper
  • func (s *SecretServiceDBusHelper) Add(creds *credentials.Credentials) error
  • func (s *SecretServiceDBusHelper) Delete(serverURL string) error
  • func (s *SecretServiceDBusHelper) Get(serverURL string) (string, string, error)
  • func (s *SecretServiceDBusHelper) List() (map[string]string, error)
• type TestHelper
  • func NewTestHelper() TestHelper
  • func (h TestHelper) Add(creds *credentials.Credentials) error
  • func (h TestHelper) Delete(url string) error
  • func (h TestHelper) Get(url string) (string, string, error)
  • func (h TestHelper) List() (map[string]string, error)

Constants

const (
	Pass              = "pass-app"
	SecretService     = "secret-service"
	SecretServiceDBus = "secret-service-dbus"
)

const Version = "k11"

Version is the keychain data version.

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

	// DefaultHelper is the default helper to use if the user hasn't yet set a preference.
	DefaultHelper string //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

type SecretServiceDBusHelper

type SecretServiceDBusHelper struct{}

SecretServiceDBusHelper is wrapper around keybase/go-keychain/secretservice library.

func (*SecretServiceDBusHelper) Add

func (s *SecretServiceDBusHelper) Add(creds *credentials.Credentials) error

Add appends credentials to the store.

func (*SecretServiceDBusHelper) Delete

func (s *SecretServiceDBusHelper) Delete(serverURL string) error

Delete removes credentials from the store.

func (*SecretServiceDBusHelper) Get

func (s *SecretServiceDBusHelper) Get(serverURL string) (string, string, error)

Get retrieves credentials from the store. It returns username and secret as strings.

func (*SecretServiceDBusHelper) List

func (s *SecretServiceDBusHelper) List() (map[string]string, error)

List returns the stored serverURLs and their associated usernames.

type TestHelper

type TestHelper map[string]*credentials.Credentials

func NewTestHelper

func NewTestHelper() TestHelper

func (TestHelper) Add

func (h TestHelper) Add(creds *credentials.Credentials) error

func (TestHelper) Delete

func (h TestHelper) Delete(url string) error

func (TestHelper) Get

func (h TestHelper) Get(url string) (string, string, error)

func (TestHelper) List

func (h TestHelper) List() (map[string]string, error)