ssh

Documentation

Overview

Package ssh provide a wrapper for golang.org/x/crypto/ssh and a parser for SSH client configuration specification ssh_config(5).

Index

• func LoadPrivateKeyInteractive(file string, maxAttempt int) (pkey any, err error)
• type Client
  • func NewClientInteractive(cfg *config.Section) (cl *Client, err error)
  • func (cl *Client) Execute(cmd string) (err error)
  • func (cl *Client) ScpGet(remote, local string) (err error)
  • func (cl *Client) ScpPut(local, remote string) (err error)
  • func (cl *Client) SetSessionOutputError(stdout, stderr io.Writer)
  • func (cl *Client) String() string

Functions

func LoadPrivateKeyInteractive

func LoadPrivateKeyInteractive(file string, maxAttempt int) (pkey any, err error)

LoadPrivateKeyInteractive load private key from file. If key is encrypted, it will prompt the passphrase in terminal with maximum maxAttempt times. If the passphrase still invalid after maxAttempt it will return an error.

Types

type Client

type Client struct {
	*ssh.Client
	// contains filtered or unexported fields
}

Client for SSH connection.

func NewClientInteractive

func NewClientInteractive(cfg *config.Section) (cl *Client, err error)

NewClientInteractive create a new SSH connection using predefined configuration, possibly interactively.

This function may dial twice to find appropriate authentication method when SSH_AUTH_SOCK environment variable is set but no valid key exist and IdentityFile directive is specified in the Host section.

If the IdentityFile is encrypted, it will prompt for passphrase in terminal.

func (*Client) Execute

func (cl *Client) Execute(cmd string) (err error)

Execute a command on remote server.

func (*Client) ScpGet

func (cl *Client) ScpGet(remote, local string) (err error)

ScpGet copy file from remote into local storage using scp.

The local file should be use the absolute path, or relative to the file in config.Section.WorkingDir.

func (*Client) ScpPut

func (cl *Client) ScpPut(local, remote string) (err error)

ScpPut copy a file from local storage to remote using scp command.

The local file should be use the absolute path, or relative to the file in config.Section's WorkingDir.

func (*Client) SetSessionOutputError

func (cl *Client) SetSessionOutputError(stdout, stderr io.Writer)

SetSessionOutputError set the standard output and error for future remote execution.

func (*Client) String

func (cl *Client) String() string