relay

Documentation

Index

• func ListenAndServe(ctx context.Context, addr string, handler http.Handler) (string, error)
• func ListenAndServeQUIC(ctx context.Context, addr string, handler http.Handler, tlsCfg *tls.Config) error
• func ListenAndServeTLS(ctx context.Context, addr string, handler http.Handler, srv *http.Server) (string, error)
• func Port(addr string) string
• type Config
• type Relay
  • func New(cfg Config) *Relay
  • func (r *Relay) Done() <-chan struct{}
  • func (r *Relay) Handler() http.Handler
  • func (r *Relay) Idle() <-chan struct{}

Functions

func ListenAndServe

func ListenAndServe(ctx context.Context, addr string, handler http.Handler) (string, error)

ListenAndServe starts the relay on the given address. Returns the actual address (useful when addr is ":0").

func ListenAndServeQUIC

func ListenAndServeQUIC(ctx context.Context, addr string, handler http.Handler, tlsCfg *tls.Config) error

ListenAndServeQUIC starts an HTTP/3 (QUIC) server on the given UDP address, serving the same handler as the TCP listener. The addr should match the TCP port so clients can reach both protocols on the same host:port.

func ListenAndServeTLS

func ListenAndServeTLS(ctx context.Context, addr string, handler http.Handler, srv *http.Server) (string, error)

ListenAndServeTLS starts the relay with TLS on the given address. Returns the actual address (useful when addr is ":0").

func Port

func Port(addr string) string

Port extracts just the port number from an addr like "127.0.0.1:PORT".

Types

type Config

type Config struct {
	Token       string
	SSHDAddr    string
	BufSize     int
	NoTLS       bool
	IdleTimeout time.Duration // shut down if no client connected for this long (default 60s)
}

Config holds relay configuration.

type Relay

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

Relay manages a single SSH session bridged over HTTP streaming.

func New

func New(cfg Config) *Relay

New creates a new Relay with the given config.

func (*Relay) Done

func (r *Relay) Done() <-chan struct{}

Done returns a channel that is closed when the sshd connection drops (i.e. the SSH session ended). Callers should shut down the listener.

func (*Relay) Handler

func (r *Relay) Handler() http.Handler

Handler returns the HTTP handler for the relay endpoints.

func (*Relay) Idle

func (r *Relay) Idle() <-chan struct{}

Idle returns a channel that is closed when the relay has been idle (no connected client) for longer than IdleTimeout.