web

Documentation

Overview

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

Index

• Constants
• func ClearSession(w http.ResponseWriter) error
• func CreateSignupLink(hostPort string, token string) string
• func EncodeCookie(user, sid string) (string, error)
• func NewHandler(cfg Config, opts ...HandlerOption) (http.Handler, error)
• func SetSession(w http.ResponseWriter, user, sid string) error
• type Config
• type Handler
  • func (h *Handler) String() string
• type HandlerOption
  • func SetSessionStreamPollPeriod(period time.Duration) HandlerOption
• type SSHLoginResponse
  • func SSHAgentLogin(proxyAddr, user, password, hotpToken string, pubKey []byte, ttl time.Duration, ...) (*SSHLoginResponse, error)
• type Server
  • func New(addr utils.NetAddr, cfg Config) (*Server, error)
• type SessionCookie
  • func DecodeCookie(b string) (*SessionCookie, error)

Constants

const (
	// HTTPS is https prefix
	HTTPS = "https"
	// WSS is secure web sockets prefix
	WSS = "wss"
)

const Version = "v1"

Version is a current webapi version

Functions

func ClearSession

func ClearSession(w http.ResponseWriter) error

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 NewHandler

func NewHandler(cfg Config, opts ...HandlerOption) (http.Handler, error)

NewHandler returns a new instance of web proxy handler

func SetSession

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

Types

type Config

type Config struct {
	// InsecureHTTPMode tells whether handler is running
	// in HTTP only that is considered insecure (as opposed to HTTPS)
	InsecureHTTPMode bool
	// Proxy is a reverse tunnel proxy that handles connections
	// to various sites
	Proxy reversetunnel.Server
	// AssetsDir is a directory with web assets (js files, css files)
	AssetsDir string
	// 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
}

Config represents web handler configuration parameters

type Handler

type Handler struct {
	httprouter.Router

	sync.Mutex
	// contains filtered or unexported fields
}

Handler is HTTP web proxy handler

func (*Handler) String

func (h *Handler) String() string

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 SSHLoginResponse

type SSHLoginResponse struct {
	// Cert is a signed certificate
	Cert []byte `json:"cert"`
	// HostSigners is a list of signing host public keys
	// trusted by proxy
	HostSigners []services.CertAuthority `json:"host_signers"`
}

SSHLoginResponse is a response returned by web proxy

func SSHAgentLogin

func SSHAgentLogin(proxyAddr, user, password, hotpToken string, pubKey []byte, ttl time.Duration, insecure bool) (*SSHLoginResponse, error)

SSHAgentLogin issues call to web proxy and receives temp certificate if credentials are valid

proxyAddr must be specified as host:port

type Server

type Server struct {
	http.Server
}

func New

func New(addr utils.NetAddr, cfg Config) (*Server, error)

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)