keyring

Documentation

Index

• type Keyring
  • func Load() (*Keyring, error)
  • func (k *Keyring) LoadPassword(fp fingerprint.Fingerprint) (password string, gotPassword bool)
  • func (k *Keyring) Name() string
  • func (k *Keyring) PurgePassword(fp fingerprint.Fingerprint) error
  • func (k *Keyring) SavePassword(fp fingerprint.Fingerprint, newPassword string) error

Types

type Keyring

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

func Load

func Load() (*Keyring, error)

Load initialises the underlying keyring and returns a Keyring which provides accessor methods.

func (*Keyring) LoadPassword

func (k *Keyring) LoadPassword(fp fingerprint.Fingerprint) (password string, gotPassword bool)

LoadPassword attempts to load a password from the keyring for the given key and returns (password, gotPassword).

func (*Keyring) Name

func (k *Keyring) Name() string

func (*Keyring) PurgePassword

func (k *Keyring) PurgePassword(fp fingerprint.Fingerprint) error

PurgePassword deletes the key from the keyring or returns an error if it encounters one with the underlying keyring. If the keyring announces the key wasn't found, PurgePassword swallows that particular error.

func (*Keyring) SavePassword

func (k *Keyring) SavePassword(fp fingerprint.Fingerprint, newPassword string) error

SavePassword stores the given password in the keyring against the key and returns any error encountered in the underlying keyring.