client

Documentation

Index

• func AddKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (err error)
• func CheckKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (found bool, err error)
• func DefaultKnownHosts() (ssh.HostKeyCallback, error)
• func DefaultKnownHostsPath() (string, error)
• func GetSigner(prvFile string, passphrase string) (ssh.Signer, error)
• func HasAgent() bool
• func KnownHosts(file string) (ssh.HostKeyCallback, error)
• type Auth
  • func Key(prvFile string, passphrase string) (Auth, error)
  • func Password(pass string) Auth
  • func UseAgent() (Auth, error)
• type Client
  • func NewClient(config *Config) (c *Client, err error)
  • func (c Client) CleanRemote(remotePath string) (err error)
  • func (c Client) Close() error
  • func (c Client) Download(ctx context.Context, remotePath, localPath string) (err error)
  • func (c Client) NewSftp(opts ...sftp.ClientOption) (*sftp.Client, error)
  • func (c Client) Run(cmd string) ([]byte, error)
  • func (c Client) Upload(localPath string, remotePath string) (err error)
• type Config

Functions

func AddKnownHost

func AddKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (err error)

AddKnownHost add a a host to known hosts file.

func CheckKnownHost

func CheckKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (found bool, err error)

CheckKnownHost checks is host in known hosts file.

func DefaultKnownHosts

func DefaultKnownHosts() (ssh.HostKeyCallback, error)

DefaultKnownHosts returns host key callback from default known hosts path, and error if any.

func DefaultKnownHostsPath

func DefaultKnownHostsPath() (string, error)

DefaultKnownHostsPath returns default user knows hosts file.

func GetSigner

func GetSigner(prvFile string, passphrase string) (ssh.Signer, error)

GetSigner returns ssh signer from private key file.

func HasAgent

func HasAgent() bool

HasAgent checks if ssh agent exists.

func KnownHosts

func KnownHosts(file string) (ssh.HostKeyCallback, error)

KnownHosts returns host key callback from a custom known hosts path.

Types

type Auth

type Auth []ssh.AuthMethod

Auth represents ssh auth methods.

func Key

func Key(prvFile string, passphrase string) (Auth, error)

Key returns auth method from private key with or without passphrase.

func Password

func Password(pass string) Auth

Password returns password auth method.

func UseAgent

func UseAgent() (Auth, error)

UseAgent auth via ssh agent

type Client

type Client struct {
	*ssh.Client
	Config *Config
}

Client represents ssh client

func NewClient

func NewClient(config *Config) (c *Client, err error)

NewClient returns new client and error if any

func (Client) CleanRemote

func (c Client) CleanRemote(remotePath string) (err error)

CleanRemote Deleting file on the server

func (Client) Close

func (c Client) Close() error

Close client net connection.

func (Client) Download

func (c Client) Download(ctx context.Context, remotePath, localPath string) (err error)

Download file from remote server

func (Client) NewSftp

func (c Client) NewSftp(opts ...sftp.ClientOption) (*sftp.Client, error)

NewSftp returns new sftp client and error if any.

func (Client) Run

func (c Client) Run(cmd string) ([]byte, error)

Run starts a new SSH session and runs the cmd, it returns CombinedOutput and err if any.

func (Client) Upload

func (c Client) Upload(localPath string, remotePath string) (err error)

Upload a local file to remote server!

type Config

type Config struct {
	Auth             Auth
	User             string
	Addr             string
	Key              string
	Port             uint
	Catalog          string
	FwType           string
	UsePassword      bool
	UseKeyPassphrase bool
	Timeout          time.Duration
	Callback         ssh.HostKeyCallback
}

Config for Client