sshagent

README

go-sshagent

Package go-sshagent provides a simple SSH Agent implementation, written in Go, mainly to be used within tests.

Documentation

Overview

Package sshagent provides an SSH agent implementation that's bootstraped with the given signers, which cannot be changed.

It is intended to be used on testing only.

Index

• type Agent
  • func New(signers ...ssh.Signer) *Agent
  • func (a *Agent) Add(key agent.AddedKey) error
  • func (a *Agent) Close() error
  • func (a *Agent) List() ([]*agent.Key, error)
  • func (a *Agent) Lock(passphrase []byte) error
  • func (a *Agent) Ready() bool
  • func (a *Agent) Remove(key ssh.PublicKey) error
  • func (a *Agent) RemoveAll() error
  • func (a *Agent) Sign(key ssh.PublicKey, data []byte) (*ssh.Signature, error)
  • func (a *Agent) Signers() ([]ssh.Signer, error)
  • func (a *Agent) Socket() string
  • func (a *Agent) Start() error
  • func (a *Agent) Unlock(passphrase []byte) error
• type ErrUnsupportedOperation
  • func (e ErrUnsupportedOperation) Error() string

Types

type Agent

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

Agent is the ssh agent implementation.

func New

func New(signers ...ssh.Signer) *Agent

New create a new agent with the given signers.

func (*Agent) Add

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

func (*Agent) Close

func (a *Agent) Close() error

Close the agent and cleanup.

func (*Agent) List

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

func (*Agent) Lock

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

func (*Agent) Ready

func (a *Agent) Ready() bool

Ready tells whether the agent is ready or not.

func (*Agent) Remove

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

func (*Agent) RemoveAll

func (a *Agent) RemoveAll() error

func (*Agent) Sign

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

func (*Agent) Signers

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

func (*Agent) Socket

func (a *Agent) Socket() string

Socket returns the unix socket address in which the agent is listening.

func (*Agent) Start

func (a *Agent) Start() error

Start the agent in a random socket.

func (*Agent) Unlock

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

type ErrUnsupportedOperation

type ErrUnsupportedOperation struct {
	Op string
}

ErrUnsupportedOperation is returned on operations that are not implemented.

func (ErrUnsupportedOperation) Error

func (e ErrUnsupportedOperation) Error() string