keyring

Documentation

Index

• Constants
• Variables
• func Discard(ctx context.Context, targetName string) error
• func Store(ctx context.Context, targetName string, c *Cred) error
• type Cred
  • func Find(ctx context.Context, targetName string) (*Cred, error)
• type Keyring

Constants

const (
	ZetaUserName = "ZetaUserName"
)

Variables

var (
	// ErrNotFound is the expected error if the secret isn't found in the
	// keyring.
	ErrNotFound = errors.New("secret not found in keyring")
	// ErrSetDataTooBig is returned if `Set` was called with too much data.
	// On MacOS: The combination of service, username & password should not exceed ~3000 bytes
	// On Windows: The service is limited to 32KiB while the password is limited to 2560 bytes
	// On Linux/Unix: There is no theoretical limit but performance suffers with big values (>100KiB)
	ErrSetDataTooBig = errors.New("data passed to Set was too big")
)

var ErrUnsupportedPlatform = errors.New("unsupported platform: " + runtime.GOOS)

All of the following methods error out on unsupported platforms

Functions

func Discard

func Discard(ctx context.Context, targetName string) error

Discard cred

func Store

func Store(ctx context.Context, targetName string, c *Cred) error

Store target cred

Types

type Cred

type Cred struct {
	UserName string
	Password string
}

func Find

func Find(ctx context.Context, targetName string) (*Cred, error)

Find cred in keyring for target.

type Keyring

type Keyring interface {
	// Find cred in keyring for target.
	Find(ctx context.Context, targetName string) (*Cred, error)
	// Store target cred
	Store(ctx context.Context, targetName string, c *Cred) error
	// Discard cred
	Discard(ctx context.Context, targetName string) error
}

Keyring provides a simple set/get interface for a keyring service.