keystore

Documentation

Overview

Package keystore provides encrypted on-disk storage for identity key material. The keystore file is encrypted with AES-256-GCM using a key derived from a user-supplied passphrase via HKDF-SHA256.

Index

• Variables
• type Keystore
  • func New(path, passphrase string) *Keystore
  • func (ks *Keystore) List() ([]string, error)
  • func (ks *Keystore) Load(address string) (*identity.IdentityKeyPair, error)
  • func (ks *Keystore) Store(address string, kp *identity.IdentityKeyPair) error

Variables

var (
	// ErrNotFound is returned when an address is not in the keystore.
	ErrNotFound = errors.New("keystore: identity not found")
	// ErrDecryptionFailed is returned when the passphrase is wrong.
	ErrDecryptionFailed = errors.New("keystore: decryption failed (wrong passphrase?)")
)

Types

type Keystore

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

Keystore manages encrypted identity key material on disk.

func New

func New(path, passphrase string) *Keystore

New creates a Keystore backed by the file at path. The passphrase is used to derive the encryption key. The file is created on first write.

func (*Keystore) List

func (ks *Keystore) List() ([]string, error)

List returns all addresses stored in the keystore.

func (*Keystore) Load

func (ks *Keystore) Load(address string) (*identity.IdentityKeyPair, error)

Load retrieves an identity key pair by address. Returns ErrNotFound if the address is not in the keystore.

func (*Keystore) Store

func (ks *Keystore) Store(address string, kp *identity.IdentityKeyPair) error

Store saves an identity key pair under the given address. If the keystore file already exists, it is decrypted, updated, and re-encrypted.