keyring

README

Keyring

This package provides a cross platform keyring using system APIs (macOS/keychain, Windows/wincred, Linux/libsecret).

For more details visit keys.pub.

macOS

The Keychain API via the github.com/keybase/go-keychain package.

Windows

The Windows Credential Manager API via the github.com/danieljoos/wincred package.

Linux

The SecretService dbus interface via the github.com/zalando/go-keyring package. The SecretService dbus interface, which is provided by GNOME Keyring.

We are still exploring whether to use kwallet or libsecret directly for linux environments that support that instead. In the meantime, you can fall back to the FS based keyring.

FS

There is a filesystem based keyring.

Mem

The is an in memory keyring for ephemeral keys or for testing.

Documentation

Overview

Package keyring provides a cross-platform secure keyring.

Index

• func Backup(path string, kr Keyring, now time.Time) error
• func CheckSystem() error
• func IDs(kr Keyring, prefix string) ([]string, error)
• func Restore(path string, kr Keyring) error
• type Item
• type Keyring
  • func NewFS(dir string) (Keyring, error)
  • func NewMem() Keyring
  • func NewSystem(service string) (Keyring, error)

Functions

func Backup

func Backup(path string, kr Keyring, now time.Time) error

Backup into {path}.tgz.

func CheckSystem

func CheckSystem() error

CheckSystem returns error if system keyring (dbus+libsecret) is not available.

func IDs

func IDs(kr Keyring, prefix string) ([]string, error)

IDs from Keyring.

func Restore

func Restore(path string, kr Keyring) error

Restore from path.tgz.

Types

type Item

type Item struct {
	ID   string
	Data []byte
}

Item ..

type Keyring

type Keyring interface {
	// Name of the keyring implementation.
	Name() string

	// Get bytes.
	Get(id string) ([]byte, error)
	// Set bytes.
	Set(id string, data []byte) error
	// Delete bytes.
	Delete(id string) (bool, error)

	// Exists returns true if exists.
	Exists(id string) (bool, error)

	// Reset removes all data.
	Reset() error

	Items(prefix string) ([]*Item, error)
}

Keyring is the interface used to store data.

func NewFS

func NewFS(dir string) (Keyring, error)

NewFS returns Keyring backed by the filesystem.

func NewMem

func NewMem() Keyring

NewMem returns an in memory keyring useful for testing or ephemeral keys.

func NewSystem

func NewSystem(service string) (Keyring, error)

NewSystem creates system keyring.