ssh

Documentation

Index

• Variables
• func GenerateSSHKey(path string) error
• func NewConfig(user string, auth *Auth) (*ssh.ClientConfig, error)
• func WaitForTCP(addr string) error
• type Auth
• type Client
  • func NewClient(user string, host string, port int, auth *Auth) (*Client, error)
  • func (client *Client) Run(command string) (Output, error)
  • func (client *Client) 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 Output

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 NewConfig

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

func WaitForTCP

func WaitForTCP(addr string) error

Types

type Auth

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

type Client

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

func NewClient

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

func (*Client) Run

func (client *Client) Run(command string) (Output, error)

func (*Client) Shell

func (client *Client) 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 Output

type Output struct {
	Stdout io.Reader
	Stderr io.Reader
}