remote

Documentation

Index

• type HTTP2Handler
  • func NewHTTP2Handler(cfg *config.ServerConfig, registry *session.Registry, pool *redis.Pool, ...) (*HTTP2Handler, error)
  • func (h *HTTP2Handler) Close()
  • func (h *HTTP2Handler) Serve(conn net.Conn)
• type Handler
• type SSHHandler
  • func NewSSHHandler(cfg *config.ServerConfig, registry *session.Registry, pool *redis.Pool, ...) (*SSHHandler, error)
  • func (s *SSHHandler) Close()
  • func (s *SSHHandler) Serve(conn net.Conn)
• type Server
  • func (s *Server) Serve(listener net.Listener, handler Handler) error
• type TCPHandler
  • func NewTCPHandler(cfg *config.ServerConfig, registry *session.Registry, pool *redis.Pool, ...) (*TCPHandler, error)
  • func (h *TCPHandler) Close()
  • func (h *TCPHandler) Serve(conn net.Conn)

Types

type HTTP2Handler

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

HTTP2Handler type represents the handler that accepts incoming wormhole connections

func NewHTTP2Handler

func NewHTTP2Handler(cfg *config.ServerConfig, registry *session.Registry, pool *redis.Pool, factory wnet.ListenerFactory) (*HTTP2Handler, error)

NewHTTP2Handler ...

func (*HTTP2Handler) Close

func (h *HTTP2Handler) Close()

Close closes all sessions handled by HTTP2Handler

func (*HTTP2Handler) Serve

func (h *HTTP2Handler) Serve(conn net.Conn)

Serve accepts incoming wormhole connections and passes them to the handler We are explicit with the *net.TCPConn since we need to be this way - and let the handler and sessions handle wrapping in TLS. Having a TCPConn all the way down will highlight the dangers of sending data over the socket without first wrapping in TLS

type Handler

type Handler interface {
	Serve(net.Conn)
	Close()
}

Handler serves a connection. It's the entry point for starting a session, managing a handshake, auth and encryption (e.g. SSH)

type SSHHandler

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

SSHHandler type represents the handler that accepts incoming wormhole connections

func NewSSHHandler

func NewSSHHandler(cfg *config.ServerConfig, registry *session.Registry, pool *redis.Pool, factory wnet.ListenerFactory) (*SSHHandler, error)

NewSSHHandler returns a new SSHHandler

func (*SSHHandler) Close

func (s *SSHHandler) Close()

Close closes all sessions handled by SSHandler

func (*SSHHandler) Serve

func (s *SSHHandler) Serve(conn net.Conn)

Serve accepts incoming wormhole connections and passes them to the handler

type Server

type Server struct {
	Logger *logrus.Logger
}

Server contains configuration options for a TCP Server

func (*Server) Serve

func (s *Server) Serve(listener net.Listener, handler Handler) error

Serve accepts incoming wormhole connections and passes them to the handler

type TCPHandler

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

TCPHandler type represents the handler that accepts incoming wormhole connections WARNING: TCPHandler is insecure and shouldn't be used in production

func NewTCPHandler

func NewTCPHandler(cfg *config.ServerConfig, registry *session.Registry, pool *redis.Pool, factory wnet.ListenerFactory) (*TCPHandler, error)

NewTCPHandler ...

func (*TCPHandler) Close

func (h *TCPHandler) Close()

Close closes all sessions handled by TCPHandler

func (*TCPHandler) Serve

func (h *TCPHandler) Serve(conn net.Conn)

Serve accepts incoming wormhole connections and passes them to the handler