ssh

Documentation

Index

• Variables
• func GenerateSSHKey(path string) error
• func NewNativeConfig(user string, auth *Auth) (ssh.ClientConfig, error)
• func SetDefaultClient(clientType SSHClientType)
• func WaitForTCP(addr string) error
• 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 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() 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() error
• type SSHClientType

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

Generate 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 SSHClientType)

func WaitForTCP

func WaitForTCP(addr string) error

Types

type Auth

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

type Client

type Client interface {
	Output(command string) (string, error)
	Shell() 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 ExternalClient

type ExternalClient struct {
	BaseArgs   []string
	BinaryPath string
}

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() error

type KeyPair

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

func NewKeyPair

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

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

func (*KeyPair) Fingerprint

func (kp *KeyPair) Fingerprint() string

Calculate the fingerprint of the public key

func (*KeyPair) WriteToFile

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

Write keypair to files

type NativeClient

type NativeClient struct {
	Config   ssh.ClientConfig
	Hostname string
	Port     int
}

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() error

type SSHClientType

type SSHClientType string

const (
	External SSHClientType = "external"
	Native   SSHClientType = "native"
)