teleagent

Documentation

Index

• type Agent
  • func NopCloser(std agent.ExtendedAgent) Agent
• type AgentServer
  • func NewServer(getter Getter) *AgentServer
  • func (a *AgentServer) Close() error
  • func (a *AgentServer) ListenAndServe(addr utils.NetAddr) error
  • func (a *AgentServer) ListenUnixSocket(sockDir, sockName string, user *user.User) error
  • func (a *AgentServer) Serve() error
  • func (a *AgentServer) SetTestPermissions(testPermissions func())
• type Getter

Types

type Agent

type Agent interface {
	agent.ExtendedAgent
	io.Closer
}

Agent extends the agent.ExtendedAgent interface. APIs which accept this interface promise to call `Close()` when they are done using the supplied agent.

func NopCloser

func NopCloser(std agent.ExtendedAgent) Agent

NopCloser wraps an agent.Agent with a NOP closer, allowing it to be passed to APIs which expect the extended agent interface.

type AgentServer

type AgentServer struct {
	Path string
	Dir  string
	// contains filtered or unexported fields
}

AgentServer is implementation of SSH agent server

func NewServer

func NewServer(getter Getter) *AgentServer

NewServer returns new instance of agent server

func (*AgentServer) Close

func (a *AgentServer) Close() error

Close closes listener and stops serving agent

func (*AgentServer) ListenAndServe

func (a *AgentServer) ListenAndServe(addr utils.NetAddr) error

ListenAndServe is similar http.ListenAndServe

func (*AgentServer) ListenUnixSocket

func (a *AgentServer) ListenUnixSocket(sockDir, sockName string, user *user.User) error

ListenUnixSocket starts listening on a new unix socket.

func (*AgentServer) Serve

func (a *AgentServer) Serve() error

Serve starts serving on the listener, assumes that Listen was called before

func (*AgentServer) SetTestPermissions

func (a *AgentServer) SetTestPermissions(testPermissions func())

SetTestPermissions can be used by tests to test agent socket permissions.

type Getter

type Getter func() (Agent, error)

Getter is a function used to get an agent instance.