web

Documentation

Overview

Package web implements web proxy handler that provides web interface to view and connect to teleport nodes

Index

• func ClearSession(w http.ResponseWriter) error
• func ConstructSSHResponse(response *auth.OIDCAuthResponse) (*url.URL, error)
• func CreateSignupLink(hostPort string, token string) string
• func EncodeCookie(user, sid string) (string, error)
• func NewStaticFileSystem(debugMode bool) (http.FileSystem, error)
• func SetPlugin(p Plugin)
• func SetSession(w http.ResponseWriter, user, sid string) error
• type ClusterHandler
• type Config
• type ContextHandler
• type CreateSessionResponse
  • func NewSessionResponse(ctx *SessionContext) (*CreateSessionResponse, error)
• type Handler
  • func (h *Handler) AuthenticateRequest(w http.ResponseWriter, r *http.Request, checkBearerToken bool) (*SessionContext, error)
  • func (m *Handler) Close() error
  • func (h *Handler) ProxyHostPort() string
  • func (h *Handler) String() string
  • func (h *Handler) WithAuth(fn ContextHandler) httprouter.Handle
  • func (h *Handler) WithClusterAuth(fn ClusterHandler) httprouter.Handle
• type HandlerOption
  • func SetSessionStreamPollPeriod(period time.Duration) HandlerOption
• type Plugin
  • func GetPlugin() Plugin
• type ResourceMap
  • func (rm ResourceMap) Open(name string) (http.File, error)
• type RewritingHandler
  • func NewHandler(cfg Config, opts ...HandlerOption) (*RewritingHandler, error)
  • func (r *RewritingHandler) Close() error
  • func (r *RewritingHandler) GetHandler() *Handler
• type Server
• type SessionContext
  • func (c *SessionContext) AddClosers(closers ...io.Closer)
  • func (c *SessionContext) Close() error
  • func (c *SessionContext) ExtendWebSession() (services.WebSession, error)
  • func (c *SessionContext) GetAgent() (auth.AgentCloser, error)
  • func (c *SessionContext) GetClient() (auth.ClientI, error)
  • func (c *SessionContext) GetUser() string
  • func (c *SessionContext) GetWebSession() services.WebSession
  • func (c *SessionContext) Invalidate() error
  • func (c *SessionContext) RemoveCloser(closer io.Closer)
  • func (c *SessionContext) TransferClosers() []io.Closer
  • func (c *SessionContext) UpdateSessionTerminal(siteAPI auth.ClientI, namespace string, sessionID session.ID, ...) error
• type SessionCookie
  • func DecodeCookie(b string) (*SessionCookie, error)

Functions

func ClearSession

func ClearSession(w http.ResponseWriter) error

func ConstructSSHResponse

func ConstructSSHResponse(response *auth.OIDCAuthResponse) (*url.URL, error)

ConstructSSHResponse creates a special SSH response for SSH login method that encodes everything using the client's secret key

func CreateSignupLink

func CreateSignupLink(hostPort string, token string) string

CreateSignupLink generates and returns a URL which is given to a new user to complete registration with Teleport via Web UI

func EncodeCookie

func EncodeCookie(user, sid string) (string, error)

func NewStaticFileSystem

func NewStaticFileSystem(debugMode bool) (http.FileSystem, error)

NewStaticFileSystem returns the initialized implementation of http.FileSystem interface which can be used to serve Teleport Proxy Web UI

If 'debugMode' is true, it will load the web assets from the same git repo directory where the executable is, otherwise it will load them from the embedded zip archive.

func SetPlugin

func SetPlugin(p Plugin)

SetPlugin sets plugin for the web handler

func SetSession

func SetSession(w http.ResponseWriter, user, sid string) error

Types

type ClusterHandler

type ClusterHandler func(w http.ResponseWriter, r *http.Request, p httprouter.Params, ctx *SessionContext, site reversetunnel.RemoteSite) (interface{}, error)

ClusterHandler is a authenticated handler that is called for some existing remote cluster

type Config

type Config struct {
	// Proxy is a reverse tunnel proxy that handles connections
	// to various sites
	Proxy reversetunnel.Server
	// AuthServers is a list of auth servers this proxy talks to
	AuthServers utils.NetAddr
	// DomainName is a domain name served by web handler
	DomainName string
	// ProxyClient is a client that authenticated as proxy
	ProxyClient auth.ClientI
	// DisableUI allows to turn off serving web based UI
	DisableUI bool
	// ProxySSHAddr points to the SSH address of the proxy
	ProxySSHAddr utils.NetAddr
	// ProxyWebAddr points to the web (HTTPS) address of the proxy
	ProxyWebAddr utils.NetAddr
}

Config represents web handler configuration parameters

type ContextHandler

type ContextHandler func(w http.ResponseWriter, r *http.Request, p httprouter.Params, ctx *SessionContext) (interface{}, error)

ContextHandler is a handler called with the auth context, what means it is authenticated and ready to work

type CreateSessionResponse

type CreateSessionResponse struct {
	// Type is token type (bearer)
	Type string `json:"type"`
	// Token value
	Token string `json:"token"`
	// User represents the user
	User interface{} `json:"user"`
	// ExpiresIn sets seconds before this token is not valid
	ExpiresIn int `json:"expires_in"`
}

CreateSessionResponse returns OAuth compabible data about access token: https://tools.ietf.org/html/rfc6749

func NewSessionResponse

func NewSessionResponse(ctx *SessionContext) (*CreateSessionResponse, error)

type Handler

type Handler struct {
	sync.Mutex
	httprouter.Router
	// contains filtered or unexported fields
}

Handler is HTTP web proxy handler

func (*Handler) AuthenticateRequest

func (h *Handler) AuthenticateRequest(w http.ResponseWriter, r *http.Request, checkBearerToken bool) (*SessionContext, error)

authenticateRequest authenticates request using combination of a session cookie and bearer token

func (*Handler) Close

func (m *Handler) Close() error

Close closes associated session cache operations

func (*Handler) ProxyHostPort

func (h *Handler) ProxyHostPort() string

ProxyHostPort returns the address of the proxy server using --proxy notation, i.e. "localhost:8030,8023"

func (*Handler) String

func (h *Handler) String() string

func (*Handler) WithAuth

func (h *Handler) WithAuth(fn ContextHandler) httprouter.Handle

WithAuth ensures that request is authenticated

func (*Handler) WithClusterAuth

func (h *Handler) WithClusterAuth(fn ClusterHandler) httprouter.Handle

WithClusterAuth ensures that request is authenticated and is issued for existing cluster

type HandlerOption

type HandlerOption func(h *Handler) error

HandlerOption is a functional argument - an option that can be passed to NewHandler function

func SetSessionStreamPollPeriod

func SetSessionStreamPollPeriod(period time.Duration) HandlerOption

SetSessionStreamPollPeriod sets polling period for session streams

type Plugin

type Plugin interface {
	// AddHandlers adds handlers to the web API handler
	AddHandlers(h *Handler)
}

Plugin is API Server extension setter if set, it will add handler methods during web handler initialization

func GetPlugin

func GetPlugin() Plugin

GetPlugin returns web API plugin that

type ResourceMap

type ResourceMap map[string]*zip.File

func (ResourceMap) Open

func (rm ResourceMap) Open(name string) (http.File, error)

type RewritingHandler

type RewritingHandler struct {
	http.Handler
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(cfg Config, opts ...HandlerOption) (*RewritingHandler, error)

NewHandler returns a new instance of web proxy handler

func (*RewritingHandler) Close

func (r *RewritingHandler) Close() error

func (*RewritingHandler) GetHandler

func (r *RewritingHandler) GetHandler() *Handler

type Server

type Server struct {
	http.Server
}

type SessionContext

type SessionContext struct {
	sync.Mutex
	*log.Entry
	// contains filtered or unexported fields
}

SessionContext is a context associated with users' web session, it stores connected client that persists between requests for example to avoid connecting to the auth server on every page hit

func (*SessionContext) AddClosers

func (c *SessionContext) AddClosers(closers ...io.Closer)

func (*SessionContext) Close

func (c *SessionContext) Close() error

Close cleans up connections associated with requests

func (*SessionContext) ExtendWebSession

func (c *SessionContext) ExtendWebSession() (services.WebSession, error)

ExtendWebSession creates a new web session for this user based on the previous session

func (*SessionContext) GetAgent

func (c *SessionContext) GetAgent() (auth.AgentCloser, error)

GetAgent returns agent that can we used to answer challenges for the web to ssh connection

func (*SessionContext) GetClient

func (c *SessionContext) GetClient() (auth.ClientI, error)

GetClient returns the client connected to the auth server

func (*SessionContext) GetUser

func (c *SessionContext) GetUser() string

GetUser returns the authenticated teleport user

func (*SessionContext) GetWebSession

func (c *SessionContext) GetWebSession() services.WebSession

GetWebSession returns a web session

func (*SessionContext) Invalidate

func (c *SessionContext) Invalidate() error

func (*SessionContext) RemoveCloser

func (c *SessionContext) RemoveCloser(closer io.Closer)

func (*SessionContext) TransferClosers

func (c *SessionContext) TransferClosers() []io.Closer

func (*SessionContext) UpdateSessionTerminal

func (c *SessionContext) UpdateSessionTerminal(
	siteAPI auth.ClientI, namespace string, sessionID session.ID, params session.TerminalParams) error

UpdateSessionTerminal is called when a browser window is resized and we need to update PTY on the server side

type SessionCookie

type SessionCookie struct {
	User string `json:"user"`
	SID  string `json:"sid"`
}

SessionCookie stores information about active user and session

func DecodeCookie

func DecodeCookie(b string) (*SessionCookie, error)