relay

README

WebTeleport Relay

Documentation

Index

• Constants
• Variables
• func DefaultIndex() http.Handler
• func IsInternal(r *http.Request) bool
• func RoundTripper(tssn tunnel.Session) http.RoundTripper
• type ExpVarStruct
  • func NewExpVarStruct() *ExpVarStruct
• type Ingress
  • func NewIngress() Ingress
• type IngressHandler
  • func NewIngressHandler(storage Storage) *IngressHandler
  • func (i *IngressHandler) AliasHandler(w http.ResponseWriter, r *http.Request)
  • func (i *IngressHandler) Dispatch(r *http.Request) http.Handler
  • func (i *IngressHandler) GetRoundTripper(h string) (http.RoundTripper, bool)
  • func (i *IngressHandler) RecordsHandler(w http.ResponseWriter, r *http.Request)
  • func (i *IngressHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (i *IngressHandler) Subscribe(upgrader edge.Upgrader)
  • func (i *IngressHandler) Use(middlewares ...muxr.Middleware)
• type Record
  • func (r *Record) Matches(kvs url.Values) (ok bool)
• type Relayer
• type Storage
• type Store
  • func NewStore() *Store
  • func (s *Store) Alias(k string, v string)
  • func (s *Store) Aliases() (all map[string]string)
  • func (s *Store) Allocate(r *edge.Edge) (string, error)
  • func (s *Store) GetSession(h string) (tunnel.Session, bool)
  • func (s *Store) LookupRecord(k string) (rec *Record, ok bool)
  • func (s *Store) Ping(r *edge.Edge)
  • func (s *Store) Records() (all []*Record)
  • func (s *Store) RemoveSession(tssn tunnel.Session)
  • func (s *Store) Scan(r *edge.Edge)
  • func (s *Store) Subscribe(upgrader edge.Upgrader)
  • func (s *Store) Unalias(k string)
  • func (s *Store) Upsert(k string, r *edge.Edge)
  • func (s *Store) Visited(k string)
  • func (s *Store) WebLog(msg string)
• 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 DefaultWSServer(host string) *WSServer
  • func NewWSServer(host string, ingress Ingress) *WSServer
  • func (s *WSServer) Dispatch(r *http.Request) http.Handler
  • func (s *WSServer) IsRootExternal(r *http.Request) bool
  • func (s *WSServer) IsRootInternal(r *http.Request) bool
  • func (s *WSServer) IsUpgrade(r *http.Request) (result bool)
  • func (s *WSServer) RootHandler(w http.ResponseWriter, r *http.Request)
  • func (s *WSServer) RootInternalHandler(w http.ResponseWriter, r *http.Request)
  • func (s *WSServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type WTServer
  • func DefaultWTServer(host string) *WTServer
  • func NewWTServer(host string, ingress Ingress) *WTServer
  • func (s *WTServer) Dispatch(r *http.Request) http.Handler
  • func (s *WTServer) IsRootExternal(r *http.Request) bool
  • func (s *WTServer) IsRootInternal(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

Constants

const ROOT_INTERNAL = "root.internal"

Variables

var DefaultIngress = NewIngressHandler(DefaultStorage)

var DefaultStorage = NewStore()

Functions

func DefaultIndex

func DefaultIndex() http.Handler

func IsInternal

func IsInternal(r *http.Request) bool

func RoundTripper

func RoundTripper(tssn tunnel.Session) http.RoundTripper

Types

type ExpVarStruct

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

func NewExpVarStruct

func NewExpVarStruct() *ExpVarStruct

type Ingress

type Ingress interface {
	// shortcut to dispatcher
	http.Handler

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

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

	// alias Info
	AliasHandler(w http.ResponseWriter, r *http.Request)

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

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

storage exposed as HTTP server

func NewIngress

func NewIngress() Ingress

type IngressHandler

type IngressHandler struct {
	*muxr.Router
	// contains filtered or unexported fields
}

func NewIngressHandler

func NewIngressHandler(storage Storage) *IngressHandler

func (*IngressHandler) AliasHandler

func (i *IngressHandler) AliasHandler(w http.ResponseWriter, r *http.Request)

func (*IngressHandler) Dispatch

func (i *IngressHandler) Dispatch(r *http.Request) http.Handler

func (*IngressHandler) GetRoundTripper

func (i *IngressHandler) GetRoundTripper(h string) (http.RoundTripper, bool)

func (*IngressHandler) RecordsHandler

func (i *IngressHandler) RecordsHandler(w http.ResponseWriter, r *http.Request)

func (*IngressHandler) ServeHTTP

func (i *IngressHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*IngressHandler) Subscribe

func (i *IngressHandler) Subscribe(upgrader edge.Upgrader)

func (*IngressHandler) Use

func (i *IngressHandler) Use(middlewares ...muxr.Middleware)

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"`
	Path    string         `json:"path"`
}

func (*Record) Matches

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

type Relayer

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

	// builtin HTTPUpgrader
	edge.HTTPUpgrader

	// edge.Edge consumer
	Ingress
}

edge.Edge multiplexer with builtin HTTPUpgrader

type Storage

type Storage interface {
	// allocate new session
	Allocate(r *edge.Edge) (string, error)

	// remove session
	RemoveSession(tssn tunnel.Session)

	// upsert session
	Upsert(k string, r *edge.Edge)

	// get session
	GetSession(h string) (tunnel.Session, bool)

	// get all records
	Records() (all []*Record)

	// scan edge.Edge
	Scan(r *edge.Edge)

	// ping edge.Edge
	Ping(r *edge.Edge)

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

	// log message
	WebLog(msg string)

	// mark visited
	Visited(k string)

	// alias
	Alias(k string, v string)

	// unalias
	Unalias(k string)

	// get all aliases
	Aliases() (all map[string]string)

	// lookup record
	LookupRecord(k string) (rec *Record, ok bool)
}

edge.Edge multiplexer

type Store

type Store struct {
	Lock         *sync.RWMutex
	PingInterval time.Duration
	Verbose      bool
	Webhook      string
	Client       *http.Client
	RecordMap    map[string]*Record
	AliasMap     map[string]string
}

func NewStore

func NewStore() *Store

func (*Store) Alias

func (s *Store) Alias(k string, v string)

func (*Store) Aliases

func (s *Store) Aliases() (all map[string]string)

func (*Store) Allocate

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

func (*Store) GetSession

func (s *Store) GetSession(h string) (tunnel.Session, bool)

func (*Store) LookupRecord

func (s *Store) LookupRecord(k string) (rec *Record, ok bool)

lookup record by key, or alias

func (*Store) Ping

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

func (*Store) Records

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

func (*Store) RemoveSession

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

func (*Store) Scan

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

func (*Store) Subscribe

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

func (*Store) Unalias

func (s *Store) Unalias(k string)

func (*Store) Upsert

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

func (*Store) Visited

func (s *Store) Visited(k string)

func (*Store) WebLog

func (s *Store) WebLog(msg string)

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 {
	Ingress
	edge.HTTPUpgrader
}

func DefaultWSServer

func DefaultWSServer(host string) *WSServer

func NewWSServer

func NewWSServer(host string, ingress Ingress) *WSServer

func (*WSServer) Dispatch

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

func (*WSServer) IsRootExternal

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

func (*WSServer) IsRootInternal

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

func (*WSServer) IsUpgrade

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

func (*WSServer) RootHandler

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

rewrite requests targeting example.com/sub/* to sub.example.com/*

func (*WSServer) RootInternalHandler

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

func (*WSServer) ServeHTTP

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

type WTServer

type WTServer struct {
	Ingress
	*webtransport.Upgrader
}

func DefaultWTServer

func DefaultWTServer(host string) *WTServer

func NewWTServer

func NewWTServer(host string, ingress Ingress) *WTServer

func (*WTServer) Dispatch

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

func (*WTServer) IsRootExternal

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

func (*WTServer) IsRootInternal

func (s *WTServer) IsRootInternal(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