sshc

Documentation

Index

• Constants
• type JumpHostConf
• type RemoteShell
  • func NewRemoteShell(sshConn *SshConnection) *RemoteShell
  • func (rs *RemoteShell) Start(cmd string, requestPty bool) error
  • func (rs *RemoteShell) Stop()
• type SocksProxy
  • func NewSocksProxy(sshConn *SshConnection) *SocksProxy
  • func (p *SocksProxy) Start(socksAddress string) error
• type SocksProxyConf
• type SshClientConf
  • func (c *SshClientConf) GetServerEndpoint() *utils.Endpoint
• type SshConnection
  • func NewSshConnection(conf *SshClientConf) *SshConnection
  • func (s *SshConnection) GetConnectionStatus() string
  • func (s *SshConnection) GrabPubKey()
  • func (s *SshConnection) ReadyWait()
  • func (s *SshConnection) Start()
  • func (s *SshConnection) Stop()

Constants

const (
	STATUS_CONNECTING = "Connecting..."
	STATUS_CONNECTED  = "Connected"
	STATUS_CLOSED     = "Closed"
)

The ssh connection available statuses

Types

type JumpHostConf

type JumpHostConf struct {
	// user@server:port
	URI      string `yaml:"uri"`
	Identity string `yaml:"identity"`
	Password string `yaml:"password"`
}

JumpHostConf holds a jump host configuration

type RemoteShell

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

RemoteShell handles remote shell connections. It uses an ssh connection object and requests a shell inside a pty to the remote server

func NewRemoteShell

func NewRemoteShell(sshConn *SshConnection) *RemoteShell

NewRemoteShell creates a new RemoteShell object

func (*RemoteShell) Start

func (rs *RemoteShell) Start(cmd string, requestPty bool) error

Start starts the remote shell

func (*RemoteShell) Stop

func (rs *RemoteShell) Stop()

Stop stops the remote shell

type SocksProxy

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

func NewSocksProxy

func NewSocksProxy(sshConn *SshConnection) *SocksProxy

func (*SocksProxy) Start

func (p *SocksProxy) Start(socksAddress string) error

Start starts the local socks proxy

type SocksProxyConf

type SocksProxyConf struct {
	ListenAddress string `yaml:"listen_address"`
	// use a dedicated ssh client. if nil use the global one
	SshClientConf *SshClientConf `yaml:"sshclient"`
}

type SshClientConf

type SshClientConf struct {
	Identity   string `yaml:"identity"`
	Password   string `yaml:"password"`
	KnownHosts string `yaml:"known_hosts"`
	ServerURI  string `yaml:"server"`
	// it this value is true host keys are not checked
	// against known_hosts file
	Insecure  bool            `yaml:"insecure"`
	Quiet     bool            `yaml:"quiet"`
	JumpHosts []*JumpHostConf `yaml:"jump_hosts"`
}

SshClientConf holds the ssh client configuration

func (*SshClientConf) GetServerEndpoint

func (c *SshClientConf) GetServerEndpoint() *utils.Endpoint

GetServerEndpoint Builds a server endpoint object from the Server string

type SshConnection

type SshConnection struct {
	Client *ssh.Client
	// contains filtered or unexported fields
}

SshConnection implements an ssh client

func NewSshConnection

func NewSshConnection(conf *SshClientConf) *SshConnection

NewSshConnection creates a new SshConnection instance

func (*SshConnection) GetConnectionStatus

func (s *SshConnection) GetConnectionStatus() string

GetConnectionStatus returns the current connection status as a string

func (*SshConnection) GrabPubKey

func (s *SshConnection) GrabPubKey()

GrabPubKey is an helper function that gets server pubkey

func (*SshConnection) ReadyWait

func (s *SshConnection) ReadyWait()

Waits until the connection is estabilished with the server

func (*SshConnection) Start

func (s *SshConnection) Start()

Start connects the ssh client to the remote server and keeps it connected sending keep alive packet and reconnecting in the event of network failures

func (*SshConnection) Stop

func (s *SshConnection) Stop()

Stop closes the ssh conn instance client connection