ssh

package

v0.3.1 Latest Latest Go to latest Published: Sep 18, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vmware-tanzu/crash-diagnostics

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CopyFrom(args SSHArgs, agent Agent, rootDir string, sourcePath string) error
func MakeTestSSHFile(t *testing.T, args SSHArgs, filePath, content string)
func RemoveTestSSHFile(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 ¶

View Source

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

ssh-agent constant identifiers

Variables ¶

This section is empty.

Functions ¶

func CopyFrom ¶ added in v0.3.0

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 MakeTestSSHFile ¶ added in v0.3.0

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

func RemoveTestSSHFile ¶ added in v0.3.0

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

func Run ¶ added in v0.3.0

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 ¶ added in v0.3.0

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 ¶ added in v0.3.0

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

func StartAgent ¶ added in v0.3.0

func StartAgent() (Agent, error)

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

type ProxyJumpArgs ¶ added in v0.3.0

type ProxyJumpArgs struct {
	User string
	Host string
}

type SSHArgs ¶ added in v0.3.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL