package
18.0.0-dev.vnet-windows.4+incompatible
Repository: https://github.com/gravitational/teleport.git
Documentation: pkg.go.dev
# Packages
Package networking handles ssh networking requests via the teleport networking subprocess, including port forwarding, agent forwarding, and x11 forwarding.
Package scp handles file uploads and downloads via SCP command.
Package sftp handles file transfers client-side via SFTP.
Package X11 contains contains the ssh client/server helper functions for performing X11 forwarding.
# Functions
AuthorizedKeyFingerprint returns fingerprint from public key in authorized key format.
CryptoPublicKey extracts a crypto.PublicKey from any public key in authorized_keys format.
EqualFingerprints checks if two finger prints are equal.
ExitCodeFromExecError extracts and returns the exit code from the error.
Fingerprint returns SSH RFC4716 fingerprint of the key.
ForwardRequest is a helper for forwarding a request across a session or channel.
ForwardRequests forwards all ssh requests received from the given channel until the channel or context is closed.
GetCheckers returns public keys that can be used to check cert authorities.
GetSigners returns SSH signers for the provided authority.
JoinHostPort is a wrapper for net.JoinHostPort that takes a uint32 port.
MarshalAuthorizedKeysFormat returns the certificate authority public key exported as a single line that can be placed in ~/.ssh/authorized_keys file.
MarshalKnownHost returns the certificate authority public key exported as a single line that can be placed in ~/.ssh/known_hosts.
NewConnectionContext creates a new ConnectionContext and a child context.Context instance which will be canceled when the ConnectionContext is closed.
NewReply creates a new reply helper for SSH servers.
No description provided by the author
NewSigner returns new ssh Signer from private key + certificate pair.
NewSSHConnMetadataWithUser overrides an ssh.ConnMetadata with provided user.
ParseDirectTCPIPReq parses an SSH request's payload into a DirectTCPIPReq.
ParseTCPIPForwardReq parses an SSH request's payload into a TCPIPForwardReq.
PrivateKeyFingerprint returns fingerprint of the public key extracted from the PEM encoded private key.
No description provided by the author
SetClock sets the server's clock.
No description provided by the author
SetConnectionContextClock sets the connection context's internal clock.
No description provided by the author
SetIngressReporter sets the reporter for reporting new and active connections.
SetInsecureSkipHostValidation does not validate the host signers to make sure they are a valid certificate.
No description provided by the author
No description provided by the author
SetLogger sets the logger for the server.
No description provided by the author
No description provided by the author
No description provided by the author
SetShutdownPollPeriod sets a polling period for graceful shutdowns of SSH servers.
No description provided by the author
SetTracerProvider sets the tracer provider for the server.
SplitHostPort is a wrapper for net.SplitHostPort that returns a uint32 port.
StaticHostSigners returns a [GetHostSignersFunc] that always returns the given host signers.
UnmarshalKnownHosts returns a list of authorized hosts from the given known_hosts file.
ValidateSigners returns a list of signers that could be used to sign keys.
# Constants
AgentForwardRequest is SSH agent request.
AuthAgentRequest is a request to a SSH client to open an agent channel.
EnvRequest is a request to set an environment variable.
ExecRequest is a request to run a command.
MaxVersionStringBytes is the maximum number of bytes allowed for a SSH version string https://tools.ietf.org/html/rfc4253.
PTYRequest is a request for PTY.
PuTTYSimpleRequest is a PuTTY-specific channel name which it automatically requests when it proxies connections.
PuTTYWinadjRequest is a PuTTY-specific channel name which it automatically requests to measure window size on active connections, expecting a failure response from the server.
SessionEnvVar is environment variable for SSH session.
ShellRequest is a request for a shell.
SSHVersionPrefix is the prefix of "server version" string which begins every SSH handshake.
SubsystemRequest is a request to run a subsystem.
WindowChangeRequest is a request to change window.
X11ChannelRequest is the type of an X11 forwarding channel.
X11ForwardRequest is a request to initiate X11 forwarding.
# Structs
No description provided by the author
ClusterDetails specifies information about a cluster.
ConnectionContext manages connection-level state.
DirectTCPIPReq represents the payload of an SSH "direct-tcpip" or "forwarded-tcpip" request.
EnvReqParams are parameters for env request.
ExecReq specifies parameters for a "exec" request.
ForwardedTCPIPRequest specifies parameters for opening a port forwarding channel from the server.
KnownHost is a structural representation of a known hosts entry for a Teleport host.
LegacySHA1Signer always forces use of SHA-1 for signing.
PTYReqParams specifies parameters for pty change window.
Reply is a helper to handle replying/rejecting and log messages when needed.
Server is a generic implementation of an SSH server.
SSHConnMetadataWithUser overrides an ssh.ConnMetadata with provided user.
SubsystemReq specifies the parameters for a "subsystem" request.
TCPIPForwardReq represents the payload of an SSH "tcpip-forward" or "cancel-tcpip-forward" request.
WinChangeReqParams specifies parameters for window changes.
# Interfaces
No description provided by the author
NewConnHandler is called once per incoming connection.
RequestForwarder represents a resource capable of sending an ssh request such as an ssh.Channel or ssh.Session.
No description provided by the author
SSHRequest defines an interface for ssh.Request.
SSHServerVersionOverrider returns a SSH server version string that should be used instead of the one from a static configuration (typically because the version was already sent and can't be un-sent).
# Type aliases
No description provided by the author
GetHostSignersFunc is an infallible function that returns host signers for use with a new SSH connection.
No description provided by the author
NewConnHandlerFunc wraps a function to satisfy NewConnHandler interface.
No description provided by the author
No description provided by the author
ServerOption is a functional argument for server.