relay

README

WebTeleport Relay

Documentation

Index

• func DefaultIndex() http.Handler
• func NewProxyHandler() http.Handler
• func ProxyBasicAuth(r *http.Request) (username, password string, ok bool)
• func ReverseProxy(tssn transport.Session) *httputil.ReverseProxy
• func Transport(tssn transport.Session) *http.Transport
• type ExpVarStruct
  • func NewExpVarStruct() *ExpVarStruct
• type Record
• type Relayer
• type SessionStore
  • func NewSessionStore() *SessionStore
  • func (s *SessionStore) Allocate(r *http.Request, root string) (string, string, error)
  • func (s *SessionStore) GetSession(k string) (transport.Session, bool)
  • func (s *SessionStore) Negotiate(r *http.Request, root string, tssn transport.Session, tstm transport.Stream) (string, error)
  • func (s *SessionStore) Ping(tssn transport.Session, tstm transport.Stream)
  • func (s *SessionStore) Records() (all []*Record)
  • func (s *SessionStore) RecordsHandler(w http.ResponseWriter, r *http.Request)
  • func (s *SessionStore) RemoveSession(tssn transport.Session)
  • func (s *SessionStore) Scan(tssn transport.Session, tstm transport.Stream)
  • func (s *SessionStore) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *SessionStore) Upsert(k string, tssn transport.Session, tstm transport.Stream, r *http.Request)
  • func (s *SessionStore) Visited(k string)
• type Storage
• type Upgrader
• type WSServer
  • func NewWSServer(host string, store Storage) *WSServer
  • func (s *WSServer) ConnectHandler(w http.ResponseWriter, r *http.Request)
  • func (s *WSServer) IndexHandler(w http.ResponseWriter, r *http.Request)
  • func (s *WSServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *WSServer) WithPostUpgrade(h http.Handler) *WSServer
• type WTServer
  • func NewWTServer(host string, store Storage) *WTServer
  • func (s *WTServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *WTServer) WithAddr(a string) *WTServer
  • func (s *WTServer) WithPostUpgrade(h http.Handler) *WTServer
  • func (s *WTServer) WithTLSConfig(tlsConfig *tls.Config) *WTServer
• type WebsocketUpgrader
  • func (s *WebsocketUpgrader) IsRoot(r *http.Request) (result bool)
  • func (s *WebsocketUpgrader) IsUpgrade(r *http.Request) (result bool)
  • func (s *WebsocketUpgrader) Root() string
  • func (*WebsocketUpgrader) Upgrade(w http.ResponseWriter, r *http.Request) (tssn transport.Session, tstm transport.Stream, err error)
• type WebtransportUpgrader
  • func (s *WebtransportUpgrader) IsRoot(r *http.Request) (result bool)
  • func (s *WebtransportUpgrader) IsUpgrade(r *http.Request) (result bool)
  • func (s *WebtransportUpgrader) Root() string
  • func (s *WebtransportUpgrader) Upgrade(w http.ResponseWriter, r *http.Request) (transport.Session, transport.Stream, error)

Functions

func DefaultIndex

func DefaultIndex() http.Handler

func NewProxyHandler

func NewProxyHandler() http.Handler

func ProxyBasicAuth

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

func ReverseProxy

func ReverseProxy(tssn transport.Session) *httputil.ReverseProxy

func Transport

func Transport(tssn transport.Session) *http.Transport

Types

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 transport.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"`
}

type Relayer

type Relayer interface {
	Upgrader
	Storage
	http.Handler
}

type SessionStore

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

func NewSessionStore

func NewSessionStore() *SessionStore

func (*SessionStore) Allocate

func (s *SessionStore) Allocate(r *http.Request, root string) (string, string, error)

func (*SessionStore) GetSession

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

func (*SessionStore) Negotiate

func (s *SessionStore) Negotiate(r *http.Request, root string, tssn transport.Session, tstm transport.Stream) (string, error)

func (*SessionStore) Ping

func (s *SessionStore) Ping(tssn transport.Session, tstm transport.Stream)

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 transport.Session)

func (*SessionStore) Scan

func (s *SessionStore) Scan(tssn transport.Session, tstm transport.Stream)

func (*SessionStore) ServeHTTP

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

func (*SessionStore) Upsert

func (s *SessionStore) Upsert(k string, tssn transport.Session, tstm transport.Stream, r *http.Request)

func (*SessionStore) Visited

func (s *SessionStore) Visited(k string)

type Storage

type Storage interface {
	// Upsert
	Upsert(k string, tssn transport.Session, tstm transport.Stream, r *http.Request)
	// Read
	GetSession(k string) (transport.Session, bool)
	Records() []*Record
	RecordsHandler(w http.ResponseWriter, r *http.Request)
	// Update
	Visited(k string)
	// Remove Session
	// if session is already removed, subsequent calls will be no-op
	// NOTE: the signature is not Remove(k string) because the key doesn't
	// uniquely identify the session. If a new session is created with the same key,
	// it should not be removed by the previous call
	RemoveSession(tssn transport.Session)
	// Rand
	Allocate(r *http.Request, root string) (key string, hostnamePath string, err error)
	Negotiate(r *http.Request, root string, tssn transport.Session, tstm transport.Stream) (key string, err error)
	// Serve
	http.Handler
}

/ transport agnostic CRUD

type Upgrader

type Upgrader interface {
	Root() string
	IsRoot(r *http.Request) bool
	IsUpgrade(r *http.Request) bool
	Upgrade(w http.ResponseWriter, r *http.Request) (transport.Session, transport.Stream, error)
}

type WSServer

type WSServer struct {
	HOST string
	Storage
	Upgrader
	Proxy       http.Handler
	PostUpgrade http.Handler
}

func NewWSServer

func NewWSServer(host string, store Storage) *WSServer

func (*WSServer) ConnectHandler

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

func (*WSServer) IndexHandler

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

func (*WSServer) ServeHTTP

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

func (*WSServer) WithPostUpgrade

func (s *WSServer) WithPostUpgrade(h http.Handler) *WSServer

type WTServer

type WTServer struct {
	HOST string
	Storage
	*WebtransportUpgrader
	PostUpgrade http.Handler
}

func NewWTServer

func NewWTServer(host string, store Storage) *WTServer

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) WithPostUpgrade

func (s *WTServer) WithPostUpgrade(h http.Handler) *WTServer

func (*WTServer) WithTLSConfig

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

type WebsocketUpgrader

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

func (*WebsocketUpgrader) IsRoot

func (s *WebsocketUpgrader) IsRoot(r *http.Request) (result bool)

func (*WebsocketUpgrader) IsUpgrade

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

func (*WebsocketUpgrader) Root

func (s *WebsocketUpgrader) Root() string

func (*WebsocketUpgrader) Upgrade

func (*WebsocketUpgrader) Upgrade(w http.ResponseWriter, r *http.Request) (tssn transport.Session, tstm transport.Stream, err error)

type WebtransportUpgrader

type WebtransportUpgrader struct {
	*wt.Server
	// contains filtered or unexported fields
}

func (*WebtransportUpgrader) IsRoot

func (s *WebtransportUpgrader) IsRoot(r *http.Request) (result bool)

func (*WebtransportUpgrader) IsUpgrade

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

func (*WebtransportUpgrader) Root

func (s *WebtransportUpgrader) Root() string

func (*WebtransportUpgrader) Upgrade

func (s *WebtransportUpgrader) Upgrade(w http.ResponseWriter, r *http.Request) (transport.Session, transport.Stream, error)