ssh

Documentation

Index

• func ConnectFunc(network, addr string) func() (net.Conn, error)
• func New(config *Config) (result *comm, err error)
• type Config
• type Password
  • func (p Password) Password(user string) (string, error)
• type PasswordKeyboardInteractive
  • func (p PasswordKeyboardInteractive) Challenge(user, instruction string, questions []string, echos []bool) ([]string, error)
• type SimpleKeychain
  • func (k *SimpleKeychain) AddPEMKey(key string) (err error)
  • func (k *SimpleKeychain) AddPEMKeyPassword(key string, password string) (err error)
  • func (k *SimpleKeychain) Key(i int) (ssh.PublicKey, error)
  • func (k *SimpleKeychain) Sign(i int, rand io.Reader, data []byte) (sig []byte, err error)

Functions

func ConnectFunc

func ConnectFunc(network, addr string) func() (net.Conn, error)

ConnectFunc is a convenience method for returning a function that just uses net.Dial to communicate with the remote end that is suitable for use with the SSH communicator configuration.

func New

func New(config *Config) (result *comm, err error)

Creates a new packer.Communicator implementation over SSH. This takes an already existing TCP connection and SSH configuration.

Types

type Config

type Config struct {
	// The configuration of the Go SSH connection
	SSHConfig *ssh.ClientConfig

	// Connection returns a new connection. The current connection
	// in use will be closed as part of the Close method, or in the
	// case an error occurs.
	Connection func() (net.Conn, error)

	// NoPty, if true, will not request a pty from the remote end.
	NoPty bool
}

Config is the structure used to configure the SSH communicator.

type Password

type Password string

An implementation of ssh.ClientPassword so that you can use a static string password for the password to ClientAuthPassword.

func (Password) Password

func (p Password) Password(user string) (string, error)

type PasswordKeyboardInteractive

type PasswordKeyboardInteractive string

An implementation of ssh.ClientKeyboardInteractive that simply sends back the password for all questions. The questions are logged.

func (PasswordKeyboardInteractive) Challenge

func (p PasswordKeyboardInteractive) Challenge(user, instruction string, questions []string, echos []bool) ([]string, error)

type SimpleKeychain

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

SimpleKeychain makes it easy to use private keys in order to connect via SSH, since the interface exposed by Go isn't the easiest to use right away.

func (*SimpleKeychain) AddPEMKey

func (k *SimpleKeychain) AddPEMKey(key string) (err error)

AddPEMKey adds a simple PEM encoded private key to the keychain.

func (*SimpleKeychain) AddPEMKeyPassword

func (k *SimpleKeychain) AddPEMKeyPassword(key string, password string) (err error)

AddPEMKeyPassword adds a PEM encoded private key that is protected by a password to the keychain.

func (*SimpleKeychain) Key

func (k *SimpleKeychain) Key(i int) (ssh.PublicKey, error)

Key method for ssh.ClientKeyring interface

func (*SimpleKeychain) Sign

func (k *SimpleKeychain) Sign(i int, rand io.Reader, data []byte) (sig []byte, err error)

Sign method for ssh.ClientKeyring interface