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

• type Client
  • func NewClient(cfg *ConfigSection) (cl *Client, err error)
  • func (cl *Client) Execute(cmd string) (err error)
  • func (cl *Client) Get(remote, local string) (err error)
  • func (cl *Client) Put(local, remote string) (err error)
  • func (cl *Client) String() string
• type Config
  • func NewConfig(file string) (cfg *Config, err error)
  • func (cfg *Config) Get(s string) (section *ConfigSection)
  • func (cfg *Config) Prepend(other *Config)
• type ConfigSection
• type PermittedCNAMEs

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for SSH connection.

func NewClient

func NewClient(cfg *ConfigSection) (cl *Client, err error)

NewClient create a new SSH connection using predefined configuration.

func (*Client) Execute

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

Execute a command on remote server.

func (*Client) Get

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

Get copy file from remote into local storage.

The local file should be use the absolute path, or relative to the file in ConfigSection's workingDir.

func (*Client) Put

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

Put 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 ConfigSection's workingDir.

func (*Client) String

func (cl *Client) String() string

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config contains mapping of host's patterns and its options from SSH configuration file.

func NewConfig

func NewConfig(file string) (cfg *Config, err error)

NewConfig load SSH configuration from file.

func (*Config) Get

func (cfg *Config) Get(s string) (section *ConfigSection)

Get the Host or Match configuration that match with the pattern "s".

func (*Config) Prepend

func (cfg *Config) Prepend(other *Config)

Prepend other Config's sections to this Config. The other's sections will be at the top of the list.

This function can be useful if we want to load another SSH config file without using Include directive.

type ConfigSection

type ConfigSection struct {
	AddKeysToAgent              string
	AddressFamily               string
	BindAddress                 string
	BindInterface               string
	CanonicalDomains            []string
	CanonicalizeHostname        string
	CanonicalizeMaxDots         int
	CanonicalizePermittedCNAMEs *PermittedCNAMEs
	CASignatureAlgorithms       []string
	CertificateFile             []string
	ConnectionAttempts          int
	ConnectTimeout              int

	// Environments contains system environment variables that will be
	// passed to Execute().
	// The key and value is derived from "SendEnv" and "SetEnv".
	Environments map[string]string

	Hostname                          string
	IdentityFile                      []string
	Port                              int
	User                              string
	XAuthLocation                     string
	IsBatchMode                       bool
	IsCanonicalizeFallbackLocal       bool
	IsChallengeResponseAuthentication bool
	IsCheckHostIP                     bool
	IsClearAllForwardings             bool
	UseCompression                    bool
	UseVisualHostKey                  bool
	// contains filtered or unexported fields
}

ConfigSection is the type that represent SSH client Host and Match section in configuration.

type PermittedCNAMEs

type PermittedCNAMEs struct {
	// contains filtered or unexported fields
}