ssh

Documentation

Index

• Constants
• Variables
• func Execute(client *SSHForwardingClient, cmd string) (error, int)
• func SSHAgentClient() (gosshagent.Agent, error)
• func Shell(client *SSHForwardingClient) error
• type HostKeyChecker
  • func NewHostKeyChecker(m HostKeyManager, trustHost func(addr, algo, fingerprint string) bool, ...) *HostKeyChecker
  • func (kc *HostKeyChecker) Check(addr string, remote net.Addr, key gossh.PublicKey) error
  • func (kc *HostKeyChecker) SetTrustHost(trustHost func(addr, algo, fingerprint string) bool)
• type HostKeyFile
  • func NewHostKeyFile(path string) *HostKeyFile
  • func (f *HostKeyFile) GetHostKeys() (map[string]gossh.PublicKey, error)
  • func (f *HostKeyFile) PutHostKey(addr string, hostKey gossh.PublicKey) error
  • func (f *HostKeyFile) String() string
• type HostKeyManager
• type SSHForwardingClient
  • func NewSSHClient(user, addr string, checker *HostKeyChecker, agentForwarding bool) (*SSHForwardingClient, error)
  • func NewTunnelledSSHClient(user, tunaddr, tgtaddr string, checker *HostKeyChecker, agentForwarding bool) (*SSHForwardingClient, error)
  • func (s *SSHForwardingClient) ForwardAgentAuthentication(session *gossh.Session) error

Constants

const (
	DefaultKnownHostsFile = "~/.fleetctl/known_hosts"
)

Variables

var (
	ErrUnparsableKey   = errors.New("unparsable key bytes")
	ErrUnsetTrustFunc  = errors.New("unset trustHost function")
	ErrUntrustHost     = errors.New("unauthorized host")
	ErrUnmatchKey      = errors.New("host key mismatch")
	ErrUnfoundHostAddr = errors.New("cannot find out host address")
)

Functions

func Execute

func Execute(client *SSHForwardingClient, cmd string) (error, int)

Execute runs the given command on the given client with stdin/stdout/stderr connected to the controlling terminal. It returns any error encountered in the SSH session, and the exit status of the remote command.

func SSHAgentClient

func SSHAgentClient() (gosshagent.Agent, error)

SSHAgentClient returns an Agent that talks to the local ssh-agent

func Shell

func Shell(client *SSHForwardingClient) error

Shell launches an interactive shell on the given client. It returns any error encountered in setting up the SSH session.

Types

type HostKeyChecker

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

HostKeyChecker implements gossh.HostKeyChecker interface It is used for validation during the cryptographic handshake

func NewHostKeyChecker

func NewHostKeyChecker(m HostKeyManager, trustHost func(addr, algo, fingerprint string) bool, errWriter io.Writer) *HostKeyChecker

NewHostKeyChecker returns new HostKeyChecker m manages existing host keys, trustHost tells whether or not to trust new host, errWriter indicates the place to write error msg

func (*HostKeyChecker) Check

func (kc *HostKeyChecker) Check(addr string, remote net.Addr, key gossh.PublicKey) error

Check is called during the handshake to check server's public key for unexpected changes. The hostKey argument is in SSH wire format. It can be parsed using ssh.ParsePublicKey. The address before DNS resolution is passed in the addr argument, so the key can also be checked against the hostname.

func (*HostKeyChecker) SetTrustHost

func (kc *HostKeyChecker) SetTrustHost(trustHost func(addr, algo, fingerprint string) bool)

SetTrustHost sets trustHost field

type HostKeyFile

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

HostKeyFile is an implementation of HostKeyManager interface Host keys are saved and loaded from file

func NewHostKeyFile

func NewHostKeyFile(path string) *HostKeyFile

NewHostKeyFile returns new HostKeyFile using file path

func (*HostKeyFile) GetHostKeys

func (f *HostKeyFile) GetHostKeys() (map[string]gossh.PublicKey, error)

func (*HostKeyFile) PutHostKey

func (f *HostKeyFile) PutHostKey(addr string, hostKey gossh.PublicKey) error

func (*HostKeyFile) String

func (f *HostKeyFile) String() string

type HostKeyManager

type HostKeyManager interface {
	String() string
	// get all host keys
	GetHostKeys() (map[string]gossh.PublicKey, error)
	// put new host key under management
	PutHostKey(addr string, hostKey gossh.PublicKey) error
}

HostKeyManager gives the interface to manage host keys

type SSHForwardingClient

type SSHForwardingClient struct {
	*gossh.Client
	// contains filtered or unexported fields
}

func NewSSHClient

func NewSSHClient(user, addr string, checker *HostKeyChecker, agentForwarding bool) (*SSHForwardingClient, error)

func NewTunnelledSSHClient

func NewTunnelledSSHClient(user, tunaddr, tgtaddr string, checker *HostKeyChecker, agentForwarding bool) (*SSHForwardingClient, error)

func (*SSHForwardingClient) ForwardAgentAuthentication

func (s *SSHForwardingClient) ForwardAgentAuthentication(session *gossh.Session) error