ssh

Documentation

Index

• Constants
• func AssertRemoteTestSSHFile(t *testing.T, args SSHArgs, filePath string)
• func CopyFrom(args SSHArgs, agent Agent, rootDir string, sourcePath string) error
• func CopyTo(args SSHArgs, agent Agent, sourcePath, targetPath string) error
• func MakeLocalTestFile(t *testing.T, filePath, content string)
• func MakeRemoteTestSSHDir(t *testing.T, args SSHArgs, filePath string)
• func MakeRemoteTestSSHFile(t *testing.T, args SSHArgs, filePath, content string)
• func RemoveLocalTestFile(t *testing.T, fileName string)
• func RemoveRemoteTestSSHFile(t *testing.T, args SSHArgs, fileName string)
• func Run(args SSHArgs, agent Agent, cmd string) (string, error)
• func RunRead(args SSHArgs, agent Agent, cmd string) (io.Reader, error)
• type Agent
  • func StartAgent() (Agent, error)
• type ProxyJumpArgs
• type SSHArgs

Constants

const (
	AgentPidIdentifier = "SSH_AGENT_PID"
	AuthSockIdentifier = "SSH_AUTH_SOCK"
)

ssh-agent constant identifiers

Functions

func AssertRemoteTestSSHFile

func AssertRemoteTestSSHFile(t *testing.T, args SSHArgs, filePath string)

func CopyFrom

func CopyFrom(args SSHArgs, agent Agent, rootDir string, sourcePath string) error

CopyFrom copies one or more files using SCP from remote host and returns the paths of files that were successfully copied.

func CopyTo

func CopyTo(args SSHArgs, agent Agent, sourcePath, targetPath string) error

CopyTo copies one or more files using SCP from local machine to remote host.

func MakeLocalTestFile

func MakeLocalTestFile(t *testing.T, filePath, content string)

func MakeRemoteTestSSHDir

func MakeRemoteTestSSHDir(t *testing.T, args SSHArgs, filePath string)

func MakeRemoteTestSSHFile

func MakeRemoteTestSSHFile(t *testing.T, args SSHArgs, filePath, content string)

func RemoveLocalTestFile

func RemoveLocalTestFile(t *testing.T, fileName string)

func RemoveRemoteTestSSHFile

func RemoveRemoteTestSSHFile(t *testing.T, args SSHArgs, fileName string)

func Run

func Run(args SSHArgs, agent Agent, cmd string) (string, error)

Run runs a command over SSH and returns the result as a string

func RunRead

func RunRead(args SSHArgs, agent Agent, cmd string) (io.Reader, error)

RunRead runs a command over SSH and returns an io.Reader for stdout/stderr

Types

type Agent

type Agent interface {
	AddKey(keyPath string) error
	RemoveKey(keyPath string) error
	Stop() error
	GetEnvVariables() string
}

func StartAgent

func StartAgent() (Agent, error)

StartAgent starts the ssh-agent process and returns the SSH authentication parameters.

type ProxyJumpArgs

type ProxyJumpArgs struct {
	User string
	Host string
}

type SSHArgs

type SSHArgs struct {
	User           string
	Host           string
	PrivateKeyPath string
	Port           string
	MaxRetries     int
	ProxyJump      *ProxyJumpArgs
}