regular

Documentation

Overview

Package regular implements SSH server that supports multiplexing tunneling, SSH connections proxying and only supports Key based auth

Index

• type Server
  • func New(addr utils.NetAddr, hostname string, signers []ssh.Signer, ...) (*Server, error)
  • func (s *Server) Addr() string
  • func (s *Server) AdvertiseAddr() string
  • func (s *Server) Close() error
  • func (s *Server) Component() string
  • func (s *Server) EmitAuditEvent(eventType string, fields events.EventFields)
  • func (s *Server) GetAccessPoint() auth.AccessPoint
  • func (s *Server) GetAuditLog() events.IAuditLog
  • func (s *Server) GetNamespace() string
  • func (s *Server) GetSessionServer() rsession.Service
  • func (s *Server) HandleNewChan(nc net.Conn, sconn *ssh.ServerConn, nch ssh.NewChannel)
  • func (s *Server) HandleRequest(r *ssh.Request)
  • func (s *Server) ID() string
  • func (s *Server) PermitUserEnvironment() bool
  • func (s *Server) Serve(l net.Listener) error
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() error
  • func (s *Server) Wait()
• type ServerOption
  • func SetAuditLog(alog events.IAuditLog) ServerOption
  • func SetCiphers(ciphers []string) ServerOption
  • func SetKEXAlgorithms(kexAlgorithms []string) ServerOption
  • func SetLabels(labels map[string]string, cmdLabels services.CommandLabels) ServerOption
  • func SetLimiter(limiter *limiter.Limiter) ServerOption
  • func SetMACAlgorithms(macAlgorithms []string) ServerOption
  • func SetNamespace(namespace string) ServerOption
  • func SetPermitUserEnvironment(permitUserEnvironment bool) ServerOption
  • func SetProxyMode(tsrv reversetunnel.Server) ServerOption
  • func SetSessionServer(sessionServer rsession.Service) ServerOption
  • func SetShell(shell string) ServerOption

Types

type Server

type Server struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Server implements SSH server that uses configuration backend and certificate-based authentication

func New

func New(addr utils.NetAddr,
	hostname string,
	signers []ssh.Signer,
	authService auth.AccessPoint,
	dataDir string,
	advertiseIP net.IP,
	proxyPublicAddr utils.NetAddr,
	options ...ServerOption) (*Server, error)

New returns an unstarted server

func (*Server) Addr

func (s *Server) Addr() string

Addr returns server address

func (*Server) AdvertiseAddr

func (s *Server) AdvertiseAddr() string

AdvertiseAddr returns an address this server should be publicly accessible as, in "ip:host" form

func (*Server) Close

func (s *Server) Close() error

Close closes listening socket and stops accepting connections

func (*Server) Component

func (s *Server) Component() string

func (*Server) EmitAuditEvent

func (s *Server) EmitAuditEvent(eventType string, fields events.EventFields)

EmitAuditEvent logs a given event to the audit log attached to the server who owns these sessions

func (*Server) GetAccessPoint

func (s *Server) GetAccessPoint() auth.AccessPoint

func (*Server) GetAuditLog

func (s *Server) GetAuditLog() events.IAuditLog

func (*Server) GetNamespace

func (s *Server) GetNamespace() string

func (*Server) GetSessionServer

func (s *Server) GetSessionServer() rsession.Service

func (*Server) HandleNewChan

func (s *Server) HandleNewChan(nc net.Conn, sconn *ssh.ServerConn, nch ssh.NewChannel)

HandleNewChan is called when new channel is opened

func (*Server) HandleRequest

func (s *Server) HandleRequest(r *ssh.Request)

HandleRequest processes global out-of-band requests. Global out-of-band requests are processed in order (this way the originator knows which request we are responding to). If Teleport does not support the request type or an error occurs while processing that request Teleport will reply req.Reply(false, nil).

For more details: https://tools.ietf.org/html/rfc4254.html#page-4

func (*Server) ID

func (s *Server) ID() string

ID returns server ID

func (*Server) PermitUserEnvironment

func (s *Server) PermitUserEnvironment() bool

PermitUserEnvironment returns if ~/.tsh/environment will be read before a session is created by this server.

func (*Server) Serve

func (s *Server) Serve(l net.Listener) error

Serve servers service on started listener

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown performs graceful shutdown

func (*Server) Start

func (s *Server) Start() error

Start starts server

func (*Server) Wait

func (s *Server) Wait()

Wait waits until server stops

type ServerOption

type ServerOption func(s *Server) error

ServerOption is a functional option passed to the server

func SetAuditLog

func SetAuditLog(alog events.IAuditLog) ServerOption

SetAuditLog assigns an audit log interfaces to this server

func SetCiphers

func SetCiphers(ciphers []string) ServerOption

func SetKEXAlgorithms

func SetKEXAlgorithms(kexAlgorithms []string) ServerOption

func SetLabels

func SetLabels(labels map[string]string,
	cmdLabels services.CommandLabels) ServerOption

SetLabels sets dynamic and static labels that server will report to the auth servers

func SetLimiter

func SetLimiter(limiter *limiter.Limiter) ServerOption

SetLimiter sets rate and connection limiter for this server

func SetMACAlgorithms

func SetMACAlgorithms(macAlgorithms []string) ServerOption

func SetNamespace

func SetNamespace(namespace string) ServerOption

func SetPermitUserEnvironment

func SetPermitUserEnvironment(permitUserEnvironment bool) ServerOption

SetPermitUserEnvironment allows you to set the value of permitUserEnvironment.

func SetProxyMode

func SetProxyMode(tsrv reversetunnel.Server) ServerOption

SetProxyMode starts this server in SSH proxying mode

func SetSessionServer

func SetSessionServer(sessionServer rsession.Service) ServerOption

SetSessionServer represents realtime session registry server

func SetShell

func SetShell(shell string) ServerOption

SetShell sets default shell that will be executed for interactive sessions