ssh

Documentation

Index

• Constants
• Variables
• func GenerateSSHKey(path string) error
• func NewNativeConfig(user string, auth *Auth) (ssh.ClientConfig, error)
• func SetDefaultClient(clientType ClientType)
• type Auth
• type Client
  • func NewClient(user string, host string, port int, auth *Auth) (Client, error)
  • func NewNativeClient(user, host string, port int, auth *Auth) (Client, error)
• type ClientType
• type ExternalClient
  • func NewExternalClient(sshBinaryPath, user, host string, port int, auth *Auth) (*ExternalClient, error)
  • func (client *ExternalClient) Output(command string) (string, error)
  • func (client *ExternalClient) Shell(args ...string) error
  • func (client *ExternalClient) Start(command string) (io.ReadCloser, io.ReadCloser, error)
  • func (client *ExternalClient) Wait() error
• type KeyPair
  • func NewKeyPair() (keyPair *KeyPair, err error)
  • func (kp *KeyPair) Fingerprint() string
  • func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error
• type NativeClient
  • func (client *NativeClient) Output(command string) (string, error)
  • func (client *NativeClient) OutputWithPty(command string) (string, error)
  • func (client *NativeClient) Shell(args ...string) error
  • func (client *NativeClient) Start(command string) (io.ReadCloser, io.ReadCloser, error)
  • func (client *NativeClient) Wait() error

Constants

const (
	External    ClientType = "external"
	Native      ClientType = "native"
	SSHProxyArg string     = "ProxyCommand='%s -X connect -x %s %%h %%p'"
)

Variables

var (
	ErrKeyGeneration     = errors.New("Unable to generate key")
	ErrValidation        = errors.New("Unable to validate key")
	ErrPublicKey         = errors.New("Unable to convert public key")
	ErrUnableToWriteFile = errors.New("Unable to write file")
)

Functions

func GenerateSSHKey

func GenerateSSHKey(path string) error

GenerateSSHKey generates SSH keypair based on path of the private key The public key would be generated to the same path with ".pub" added

func NewNativeConfig

func NewNativeConfig(user string, auth *Auth) (ssh.ClientConfig, error)

func SetDefaultClient

func SetDefaultClient(clientType ClientType)

Types

type Auth

type Auth struct {
	Passwords []string
	Keys      []string
}

type Client

type Client interface {
	Output(command string) (string, error)
	Shell(args ...string) error

	// Start starts the specified command without waiting for it to finish. You
	// have to call the Wait function for that.
	//
	// The first two io.ReadCloser are the standard output and the standard
	// error of the executing command respectively. The returned error follows
	// the same logic as in the exec.Cmd.Start function.
	Start(command string) (io.ReadCloser, io.ReadCloser, error)

	// Wait waits for the command started by the Start function to exit. The
	// returned error follows the same logic as in the exec.Cmd.Wait function.
	Wait() error
}

func NewClient

func NewClient(user string, host string, port int, auth *Auth) (Client, error)

func NewNativeClient

func NewNativeClient(user, host string, port int, auth *Auth) (Client, error)

type ClientType

type ClientType string

type ExternalClient

type ExternalClient struct {
	BaseArgs   []string
	BinaryPath string
	// contains filtered or unexported fields
}

func NewExternalClient

func NewExternalClient(sshBinaryPath, user, host string, port int, auth *Auth) (*ExternalClient, error)

func (*ExternalClient) Output

func (client *ExternalClient) Output(command string) (string, error)

func (*ExternalClient) Shell

func (client *ExternalClient) Shell(args ...string) error

func (*ExternalClient) Start

func (client *ExternalClient) Start(command string) (io.ReadCloser, io.ReadCloser, error)

func (*ExternalClient) Wait

func (client *ExternalClient) Wait() error

type KeyPair

type KeyPair struct {
	PrivateKey []byte
	PublicKey  []byte
}

func NewKeyPair

func NewKeyPair() (keyPair *KeyPair, err error)

NewKeyPair generates a new SSH keypair This will return a private & public key encoded as DER.

func (*KeyPair) Fingerprint

func (kp *KeyPair) Fingerprint() string

Fingerprint calculates the fingerprint of the public key

func (*KeyPair) WriteToFile

func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error

WriteToFile writes keypair to files

type NativeClient

type NativeClient struct {
	Config   ssh.ClientConfig
	Hostname string
	Port     int
	// contains filtered or unexported fields
}

func (*NativeClient) Output

func (client *NativeClient) Output(command string) (string, error)

func (*NativeClient) OutputWithPty

func (client *NativeClient) OutputWithPty(command string) (string, error)

func (*NativeClient) Shell

func (client *NativeClient) Shell(args ...string) error

func (*NativeClient) Start

func (client *NativeClient) Start(command string) (io.ReadCloser, io.ReadCloser, error)

func (*NativeClient) Wait

func (client *NativeClient) Wait() error