sshtun

Documentation

Index

• type ConnState
• type ConnStateMessage
• type SSHConfig
• type SSHTunnel
  • func NewSSHTunnel(conf SSHConfig, localPort int, destination string, options ...TunnelOption) (*SSHTunnel, error)
  • func (t *SSHTunnel) Close()
  • func (t *SSHTunnel) ConnState() <-chan ConnStateMessage
  • func (t *SSHTunnel) Start() error
• type TunnelConfig
• type TunnelOption
  • func WithLogger(logf func(string, ...any)) TunnelOption

Types

type ConnState

type ConnState int

const (
	// ConnStateNew represents a new connection.
	ConnStateNew ConnState = iota

	// ConnStateConnected represents a connected connection.
	ConnStateConnected

	// ConnStateDisconnected represents a disconnected connection.
	ConnStateDisconnected

	// ConnStateError represents an errored connection.
	ConnStateError

	ConnStateKeepAlive
)

type ConnStateMessage

type ConnStateMessage struct {
	State ConnState
	Err   error
	Msg   string
}

type SSHConfig

type SSHConfig struct {
	Host            string
	Port            int
	User            string
	Auth            ssh.AuthMethod
	HostKeyCallback ssh.HostKeyCallback
}

type SSHTunnel

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

func NewSSHTunnel

func NewSSHTunnel(conf SSHConfig, localPort int, destination string, options ...TunnelOption) (*SSHTunnel, error)

func (*SSHTunnel) Close

func (t *SSHTunnel) Close()

func (*SSHTunnel) ConnState

func (t *SSHTunnel) ConnState() <-chan ConnStateMessage

func (*SSHTunnel) Start

func (t *SSHTunnel) Start() error

type TunnelConfig

type TunnelConfig struct {
	LocalPort   int
	Destination string
	Logf        func(string, ...any)
}

TunnelConfig is the configuration for the tunnel.

type TunnelOption

type TunnelOption func(*TunnelConfig)

func WithLogger

func WithLogger(logf func(string, ...any)) TunnelOption