ssh

Documentation

Index

• type Client
  • func BuildSSHClient(config Config) *Client
  • func Dial(network, addr string, config *ssh.ClientConfig) (*Client, error)
  • func DialWithKey(addr, user, keyfile string) (*Client, error)
  • func DialWithKeyWithPassphrase(addr, user, keyfile string, passphrase string) (*Client, error)
  • func DialWithPasswd(addr, user, passwd string) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Cmd(cmd string) *remoteScript
  • func (c *Client) Script(script string) *remoteScript
  • func (c *Client) ScriptFile(fname string) *remoteScript
  • func (c *Client) Shell() *remoteShell
  • func (c *Client) Terminal(config *TerminalConfig) *remoteShell
• type Config
• type Dialer
  • func NewDialer(client *Client) *Dialer
  • func (r *Dialer) Dial(context context.Context, addr string) (net.Conn, error)
• type TerminalConfig

Types

type Client

type Client struct {
	Client *ssh.Client
}

func BuildSSHClient

func BuildSSHClient(config Config) *Client

func Dial

func Dial(network, addr string, config *ssh.ClientConfig) (*Client, error)

Dial starts a client connection to the given SSH server. This is wrap the ssh.Dial

func DialWithKey

func DialWithKey(addr, user, keyfile string) (*Client, error)

DialWithKey starts a client connection to the given SSH server with key authmethod.

func DialWithKeyWithPassphrase

func DialWithKeyWithPassphrase(addr, user, keyfile string, passphrase string) (*Client, error)

DialWithKeyWithPassphrase same as DialWithKey but with a passphrase to decrypt the private key

func DialWithPasswd

func DialWithPasswd(addr, user, passwd string) (*Client, error)

DialWithPasswd starts a client connection to the given SSH server with passwd authmethod.

func (*Client) Close

func (c *Client) Close() error

func (*Client) Cmd

func (c *Client) Cmd(cmd string) *remoteScript

Cmd create a command on client

func (*Client) Script

func (c *Client) Script(script string) *remoteScript

Script

func (*Client) ScriptFile

func (c *Client) ScriptFile(fname string) *remoteScript

ScriptFile

func (*Client) Shell

func (c *Client) Shell() *remoteShell

Shell create a noninteractive shell on client.

func (*Client) Terminal

func (c *Client) Terminal(config *TerminalConfig) *remoteShell

Terminal create a interactive shell on client.

type Config

type Config struct {
	IP       string `json:"ip" yaml:"ip"`
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`
}

type Dialer

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

func NewDialer

func NewDialer(client *Client) *Dialer

func (*Dialer) Dial

func (r *Dialer) Dial(context context.Context, addr string) (net.Conn, error)

type TerminalConfig

type TerminalConfig struct {
	Term   string
	Hight  int
	Weight int
	Modes  ssh.TerminalModes
}