ssh

Documentation

Overview

Package ssh implements an ssh-agent.

Index

• Variables
• type Agent
  • func NewAgent(p *piv.KeyService, pe *pinentry.PINEntry, log *zap.Logger, loadKeyfile bool, ...) *Agent
  • func (a *Agent) Add(key agent.AddedKey) error
  • func (a *Agent) List() ([]*agent.Key, error)
  • func (a *Agent) Lock(passphrase []byte) error
  • func (a *Agent) Remove(key gossh.PublicKey) error
  • func (a *Agent) RemoveAll() error
  • func (a *Agent) Sign(key gossh.PublicKey, data []byte) (*gossh.Signature, error)
  • func (a *Agent) Signers() ([]gossh.Signer, error)
  • func (a *Agent) Unlock(passphrase []byte) error

Variables

var ErrNotImplemented = errors.New("not implemented in piv-agent")

ErrNotImplemented is returned from any unimplemented method.

var ErrUnknownKey = errors.New("requested signature of unknown key")

ErrUnknownKey is returned when a signature is requested for an unknown key.

Types

type Agent

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

Agent implements the crypto/ssh Agent interface https://pkg.go.dev/golang.org/x/crypto/ssh/agent#Agent

func NewAgent

func NewAgent(p *piv.KeyService, pe *pinentry.PINEntry, log *zap.Logger,
	loadKeyfile bool, n *notify.Notify, cancel context.CancelFunc) *Agent

NewAgent returns a new Agent.

func (*Agent) Add

func (a *Agent) Add(key agent.AddedKey) error

Add adds a private key to the agent.

func (*Agent) List

func (a *Agent) List() ([]*agent.Key, error)

List returns the identities known to the agent.

func (*Agent) Lock

func (a *Agent) Lock(passphrase []byte) error

Lock locks the agent. Sign and Remove will fail, and List will empty an empty list.

func (*Agent) Remove

func (a *Agent) Remove(key gossh.PublicKey) error

Remove removes all identities with the given public key.

func (*Agent) RemoveAll

func (a *Agent) RemoveAll() error

RemoveAll removes all identities. This is implemented by causing piv-agent to exit.

func (*Agent) Sign

func (a *Agent) Sign(key gossh.PublicKey, data []byte) (*gossh.Signature, error)

Sign has the agent sign the data using a protocol 2 key as defined in [PROTOCOL.agent] section 2.6.2.

func (*Agent) Signers

func (a *Agent) Signers() ([]gossh.Signer, error)

Signers returns signers for all the known keys.

func (*Agent) Unlock

func (a *Agent) Unlock(passphrase []byte) error

Unlock undoes the effect of Lock