ssh

Documentation

Index

• type Client
  • func NewClient(cfg *Config) (*Client, error)
  • func (c *Client) ExecCmd(connectPath string, cmd string) error
  • func (c *Client) SendFile(sourceFilePath string, destDirPath string) error
• type Config
  • func (c Config) GetSshClientConfig() (*ssh.ClientConfig, error)
• type RemoteAccess

Types

type Client

type Client struct {
	SshClientConfig *ssh.ClientConfig
	SshUrl          string
}

Client is an ssh wrapper to dialog with a sftp server.

func NewClient

func NewClient(cfg *Config) (*Client, error)

Client constructor.

func (*Client) ExecCmd

func (c *Client) ExecCmd(connectPath string, cmd string) error

ExecCmd will remotely execute a command.

func (*Client) SendFile

func (c *Client) SendFile(sourceFilePath string, destDirPath string) error

SendFile sends a file from a source path to the destination directory with the same name.

type Config

type Config struct {
	User       string `yaml:"user"`
	Host       string `yaml:"host"`
	Port       string `yaml:"port"`
	SshKeyPath string `yaml:"sshKeyPath"`
}

Config is the configuration structure used by an ssh client.

func (Config) GetSshClientConfig

func (c Config) GetSshClientConfig() (*ssh.ClientConfig, error)

GetSshClientConfig loads and parses a private key to return an ssh client config.

type RemoteAccess

type RemoteAccess interface {
	SendFile(sourcePath string, destPath string) error
	ExecCmd(connectPath string, cmd string) error
}

RemoteAccess interface defines the methods a concrete remote accessor must implement.