relay

README

WebTeleport Relay

Documentation

Index

• Variables
• func CheckProxyAuth(user, pass string) bool
• func ConnectVerbose(next http.Handler) http.Handler
• func DefaultIndex() http.Handler
• func IsProxy(r *http.Request) bool
• func NewProxyHandler() http.Handler
• func ProxyAuthenticate(next http.Handler) http.Handler
• func ProxyBasicAuth(r *http.Request) (username, password string, ok bool)
• func ProxyDispatcher(r *http.Request) http.Handler
• func ReverseProxy(rt http.RoundTripper) *httputil.ReverseProxy
• func RoundTripper(tssn tunnel.Session) http.RoundTripper
• type Dispatcher
• type DispatcherFunc
  • func (d DispatcherFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ExpVarStruct
  • func NewExpVarStruct() *ExpVarStruct
• type Record
  • func (r *Record) Matches(kvs url.Values) (ok bool)
• type Relayer
• type SessionStore
  • func NewSessionStore() *SessionStore
  • func (s *SessionStore) Allocate(r *edge.Edge, root string) (string, string, error)
  • func (s *SessionStore) Dispatch(r *http.Request) http.Handler
  • func (s *SessionStore) GetRoundTripper(k string) (http.RoundTripper, bool)
  • func (s *SessionStore) GetSession(k string) (tunnel.Session, bool)
  • func (s *SessionStore) Negotiate(r *edge.Edge, root string) (string, error)
  • func (s *SessionStore) Ping(r *edge.Edge)
  • func (s *SessionStore) Records() (all []*Record)
  • func (s *SessionStore) RecordsHandler(w http.ResponseWriter, r *http.Request)
  • func (s *SessionStore) RemoveSession(tssn tunnel.Session)
  • func (s *SessionStore) Scan(r *edge.Edge)
  • func (s *SessionStore) Subscribe(upgrader edge.Upgrader)
  • func (s *SessionStore) Upsert(k string, r *edge.Edge)
  • func (s *SessionStore) Visited(k string)
  • func (s *SessionStore) WebLog(msg string)
• type Storage
• type VerboseConn
  • func (c *VerboseConn) Read(b []byte) (n int, err error)
  • func (c *VerboseConn) Write(b []byte) (n int, err error)
• type WSServer
  • func NewWSServer(host string, store Storage) *WSServer
  • func (s *WSServer) Dispatch(r *http.Request) http.Handler
  • func (s *WSServer) IndexHandler(w http.ResponseWriter, r *http.Request)
  • func (s *WSServer) IsRoot(r *http.Request) bool
  • func (s *WSServer) IsUpgrade(r *http.Request) (result bool)
  • func (s *WSServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type WTServer
  • func NewWTServer(host string, store Storage) *WTServer
  • func (s *WTServer) Dispatch(r *http.Request) http.Handler
  • func (s *WTServer) IsRoot(r *http.Request) bool
  • func (s *WTServer) IsUpgrade(r *http.Request) bool
  • func (s *WTServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *WTServer) WithAddr(a string) *WTServer
  • func (s *WTServer) WithTLSConfig(tlsConfig *tls.Config) *WTServer

Variables

var AuthenticatedProxyHandler = ConnectVerbose(ProxyAuthenticate(NewProxyHandler()))

Functions

func CheckProxyAuth

func CheckProxyAuth(user, pass string) bool

func ConnectVerbose

func ConnectVerbose(next http.Handler) http.Handler

func DefaultIndex

func DefaultIndex() http.Handler

func IsProxy

func IsProxy(r *http.Request) bool

h1/h2/h3 connect requests or forward requests

func NewProxyHandler

func NewProxyHandler() http.Handler

func ProxyAuthenticate

func ProxyAuthenticate(next http.Handler) http.Handler

func ProxyBasicAuth

func ProxyBasicAuth(r *http.Request) (username, password string, ok bool)

func ProxyDispatcher

func ProxyDispatcher(r *http.Request) http.Handler

func ReverseProxy

func ReverseProxy(rt http.RoundTripper) *httputil.ReverseProxy

func RoundTripper

func RoundTripper(tssn tunnel.Session) http.RoundTripper

Types

type Dispatcher

type Dispatcher interface {
	Dispatch(r *http.Request) http.Handler
}

dispatch to other http.Handler implementations

type DispatcherFunc

type DispatcherFunc func(*http.Request) http.Handler

wrapping Dispatcher into http.Handler

func (DispatcherFunc) ServeHTTP

func (d DispatcherFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ExpVarStruct

type ExpVarStruct struct {
	WebteleportRelayStreamsSpawned   *expvar.Int
	WebteleportRelayStreamsClosed    *expvar.Int
	WebteleportRelaySessionsAccepted *expvar.Int
	WebteleportRelaySessionsClosed   *expvar.Int
}

func NewExpVarStruct

func NewExpVarStruct() *ExpVarStruct

type Record

type Record struct {
	Key     string         `json:"key"`
	Session tunnel.Session `json:"-"`
	Header  tags.Tags      `json:"header"`
	Tags    tags.Tags      `json:"tags"`
	Since   time.Time      `json:"since"`
	Visited int            `json:"visited"`
	IP      string         `json:"ip"`
}

func (*Record) Matches

func (r *Record) Matches(kvs url.Values) (ok bool)

type Relayer

type Relayer interface {
	// dispatch to HTTPUpgrader and Storage
	Dispatcher

	// builtin HTTPUpgrader
	edge.HTTPUpgrader

	// edge.Edge multiplexer
	Storage
}

edge.Edge multiplexer with builtin HTTPUpgrader

type SessionStore

type SessionStore struct {
	*muxr.Router
	Lock         *sync.RWMutex
	PingInterval time.Duration
	Verbose      bool
	Webhook      string
	Client       *http.Client
	Record       map[string]*Record
}

func NewSessionStore

func NewSessionStore() *SessionStore

func (*SessionStore) Allocate

func (s *SessionStore) Allocate(r *edge.Edge, root string) (string, string, error)

func (*SessionStore) Dispatch

func (s *SessionStore) Dispatch(r *http.Request) http.Handler

func (*SessionStore) GetRoundTripper

func (s *SessionStore) GetRoundTripper(k string) (http.RoundTripper, bool)

func (*SessionStore) GetSession

func (s *SessionStore) GetSession(k string) (tunnel.Session, bool)

func (*SessionStore) Negotiate

func (s *SessionStore) Negotiate(r *edge.Edge, root string) (string, error)

func (*SessionStore) Ping

func (s *SessionStore) Ping(r *edge.Edge)

Ping proactively pings the client to keep the connection alive and to detect if the client has disconnected. If the client has disconnected, the session is removed from the session store.

This function has been found mostly unnecessary since the disconnect is automatically detected by the underlying transport layer and handled by the Scan function. However, it is kept here for completeness.

func (*SessionStore) Records

func (s *SessionStore) Records() (all []*Record)

func (*SessionStore) RecordsHandler

func (s *SessionStore) RecordsHandler(w http.ResponseWriter, r *http.Request)

func (*SessionStore) RemoveSession

func (s *SessionStore) RemoveSession(tssn tunnel.Session)

func (*SessionStore) Scan

func (s *SessionStore) Scan(r *edge.Edge)

func (*SessionStore) Subscribe

func (s *SessionStore) Subscribe(upgrader edge.Upgrader)

func (*SessionStore) Upsert

func (s *SessionStore) Upsert(k string, r *edge.Edge)

func (*SessionStore) Visited

func (s *SessionStore) Visited(k string)

func (*SessionStore) WebLog

func (s *SessionStore) WebLog(msg string)

type Storage

type Storage interface {
	// Dispatch to edge.Edge
	Dispatcher

	// get Session wrapped by http.Transport
	GetRoundTripper(k string) (http.RoundTripper, bool)

	// record Info
	RecordsHandler(w http.ResponseWriter, r *http.Request)

	// subscribe to incoming stream of edge.Edge
	edge.Subscriber

	// apply middleware to dispatcher
	Use(middlewares ...muxr.Middleware)

	// shortcut to dispatcher
	http.Handler
}

edge.Edge multiplexer

type VerboseConn

type VerboseConn struct {
	net.Conn
}

func (*VerboseConn) Read

func (c *VerboseConn) Read(b []byte) (n int, err error)

func (*VerboseConn) Write

func (c *VerboseConn) Write(b []byte) (n int, err error)

type WSServer

type WSServer struct {
	Storage
	edge.HTTPUpgrader
}

func NewWSServer

func NewWSServer(host string, store Storage) *WSServer

func (*WSServer) Dispatch

func (s *WSServer) Dispatch(r *http.Request) http.Handler

func (*WSServer) IndexHandler

func (s *WSServer) IndexHandler(w http.ResponseWriter, r *http.Request)

func (*WSServer) IsRoot

func (s *WSServer) IsRoot(r *http.Request) bool

func (*WSServer) IsUpgrade

func (s *WSServer) IsUpgrade(r *http.Request) (result bool)

func (*WSServer) ServeHTTP

func (s *WSServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type WTServer

type WTServer struct {
	HOST string
	Storage
	*webtransport.Upgrader
}

func NewWTServer

func NewWTServer(host string, store Storage) *WTServer

func (*WTServer) Dispatch

func (s *WTServer) Dispatch(r *http.Request) http.Handler

func (*WTServer) IsRoot

func (s *WTServer) IsRoot(r *http.Request) bool

func (*WTServer) IsUpgrade

func (s *WTServer) IsUpgrade(r *http.Request) bool

func (*WTServer) ServeHTTP

func (s *WTServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*WTServer) WithAddr

func (s *WTServer) WithAddr(a string) *WTServer

func (*WTServer) WithTLSConfig

func (s *WTServer) WithTLSConfig(tlsConfig *tls.Config) *WTServer