ssh

Documentation

Index

• Constants
• type Config
• type Endpoint
  • func (endpoint *Endpoint) String() string
• type GlobalConnectSsh
  • func (m *GlobalConnectSsh) Close() error
  • func (m *GlobalConnectSsh) GetConfig() interface{}
  • func (m *GlobalConnectSsh) GetGroup() string
  • func (m *GlobalConnectSsh) GetName() string
  • func (m *GlobalConnectSsh) GetType() string
  • func (m *GlobalConnectSsh) InitModule(_cfg interface{}) error
  • func (m *GlobalConnectSsh) InitPipe(w io.Writer, r io.Reader) error
  • func (m *GlobalConnectSsh) Run(ctx context.Context) error
• type SSHtunnel
  • func (tunnel *SSHtunnel) Start() error
  • func (tunnel *SSHtunnel) Stop() error

Constants

const MODULE_GROUP = "global"

const MODULE_NAME = "ssh"

const MODULE_TYPE = "connect"

Types

type Config

type Config struct {
	LocalEndpointHost string
	LocalEndpointPort int

	ServerEndpointHost string
	ServerEndpointPort int

	RemoteEndpointHost string
	RemoteEndpointPort int

	RemoteUser string

	// Full path to id_rsa key
	KeyPath string
}

type Endpoint

type Endpoint struct {
	Host string
	Port int
}

func (*Endpoint) String

func (endpoint *Endpoint) String() string

type GlobalConnectSsh

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

func (*GlobalConnectSsh) Close

func (m *GlobalConnectSsh) Close() error

func (*GlobalConnectSsh) GetConfig

func (m *GlobalConnectSsh) GetConfig() interface{}

func (*GlobalConnectSsh) GetGroup

func (m *GlobalConnectSsh) GetGroup() string

func (*GlobalConnectSsh) GetName

func (m *GlobalConnectSsh) GetName() string

func (*GlobalConnectSsh) GetType

func (m *GlobalConnectSsh) GetType() string

func (*GlobalConnectSsh) InitModule

func (m *GlobalConnectSsh) InitModule(_cfg interface{}) error

func (*GlobalConnectSsh) InitPipe

func (m *GlobalConnectSsh) InitPipe(w io.Writer, r io.Reader) error

func (*GlobalConnectSsh) Run

func (m *GlobalConnectSsh) Run(ctx context.Context) error

type SSHtunnel

type SSHtunnel struct {
	Local    *Endpoint
	Server   *Endpoint
	Remote   *Endpoint
	Listener net.Listener

	Config *ssh.ClientConfig
}

func (*SSHtunnel) Start

func (tunnel *SSHtunnel) Start() error

func (*SSHtunnel) Stop

func (tunnel *SSHtunnel) Stop() error