package
3.2.0-alpha.2+incompatible
Repository: https://github.com/jessynt/teleport.git
Documentation: pkg.go.dev
# Functions
NewExecRequest creates a new local or remote Exec.
NewHeartbeat returns a new instance of heartbeat.
NewServerContext creates a new *ServerContext which is used to pass and manage resources.
No description provided by the author
NewTerminal returns a new terminal.
NewTrackingReader returns a new instance of activity tracking reader.
StartKeepAliveLoop starts the keep-alive loop.
# Constants
HeartbeatModeAuth sets heartbeat to auth that does not support keep alives.
HeartbeatModeNode sets heartbeat to node updates that support keep alives.
HeartbeatModeProxy sets heartbeat to proxy that does not support keep alives.
HeartbeatStateAnnounce is set when full state has to be announced back to the auth server.
HeartbeatStateAnnounceWait is set after successfull announce, heartbeat will wait until server updates information, or time for next announce comes.
HeartbeatStateInit is set when the state has not been collected yet, or the state is not fetched.
HeartbeatStateKeepAlive is set when only sending keep alives is necessary.
HeartbeatStateKeepAliveWait is set when heartbeat will waiting until it's time to send keep alive.
# Structs
AuthHandlers are common authorization and authentication related handlers used by the regular and forwarding server.
ExecResult is used internally to send the result of a command execution from a goroutine to SSH request handler and back to the calling client.
Heartbeat keeps heartbeat state, it is implemented according to actor model - all interactions with it are to be done with signals.
HeartbeatConfig is a heartbeat configuration.
IdentityContext holds all identity information associated with the user logged on the connection.
KeepAliveParams configures the keep-alive loop.
SessionContext holds session specific context, such as SSH auth agents, PTYs, and other resources.
SessionRegistry holds a map of all active sessions on a given SSH server.
SubsystemResult is a result of execution of the subsystem.
TermHandlers are common terminal handling functions used by both the regular and forwarding server.
TrackingReader wraps the writer and every time write occurs, updates the activity in the server context.
# Interfaces
Exec executes an "exec" request.
RequestSender is an interface that impliments SendRequest.
Server is regular or forwarding SSH server.
Subsystem represents SSH subsytem - special command executed in the context of the session.
Terminal defines an interface of handy functions for managing a (local or remote) PTY, such as resizing windows, executing commands with a PTY, and cleaning up.
# Type aliases
GetServerInfoFn is function that returns server info.
HeartbeatMode represents the mode of the heartbeat node, proxy or auth server.
KeepAliveState represents state of the heartbeat.