sshagent

Documentation

Index

• type Agent
  • func (a *Agent) Add(key []byte) error
  • func (a *Agent) Pid() int
  • func (a *Agent) Run() (bool, error)
  • func (a *Agent) Stdout() io.Reader

Types

type Agent

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

Agent represents an ssh-agent

func (*Agent) Add

func (a *Agent) Add(key []byte) error

Add wraps `ssh-agent add`

func (*Agent) Pid

func (a *Agent) Pid() int

Pid is the process ID of the ssh-agent, either found in existing environment, or started by us.

func (*Agent) Run

func (a *Agent) Run() (bool, error)

Run ensures an ssh-agent is running. If ssh-agent has already been started, do nothing. If SSH_AUTH_SOCK & SSH_AGENT_PID are set, adopt those. Otherwise, start an ssh-agent, which produces output like:

SSH_AUTH_SOCK=/path/to/socket; export SSH_AUTH_SOCK;
SSH_AGENT_PID=42; export SSH_AGENT_PID;
echo Agent pid 42

The output is captured verbatim, and also parsed for those values. The SSH_AUTH_SOCK in either case is used for subsequent Add() The bool return value indicates whether the call started the agent.

func (*Agent) Stdout

func (a *Agent) Stdout() io.Reader

Stdout of the `ssh-agent -s` command.