package
2.3.5+incompatible
Repository: https://github.com/dspasibenko/teleport.git
Documentation: pkg.go.dev
# Functions
AuthConnectAddr returns the default address to search for auth.
AuthListenAddr returns the default listening address for the Auth service.
ConfigureLimiter assigns the default parameters to a connection throttler (AKA limiter).
ProxyListenAddr returns the default listening address for the SSH Proxy service.
ProxyWebListenAddr returns the default listening address for the Web-based SSH Proxy service.
ReverseTunnellListenAddr returns the default listening address for the SSH Proxy service used by the SSH nodes to establish proxy<->ssh_node connection from behind a firewall which blocks inbound connecions to ssh_nodes.
SSHServerListenAddr returns the default listening address for the Web-based SSH Proxy service.
# Constants
AccountLockInterval defines a time interval during which a user account is locked after MaxLoginAttempts.
ActivePartyTTL is a TTL when party is marked as inactive.
ActiveSessionTTL is a TTL when session is marked as inactive.
AttemptTTL is TTL for login attempt.
When running as a "SSH Proxy" this port will be used to serve auth requests.
Default DB to use for persisting state.
By default SSH server (and SSH proxy) will bind to this IP.
CacheTTL is a default cache TTL for persistent node cache.
CertDuration is a default certificate duration 12 is default as it' longer than average working day (I hope so).
DefaultDialTimeout is a default TCP dial timeout we set for our connection attempts.
DefaultIdleConnectionDuration indicates for how long Teleport will hold the SSH connection open if there are no reads/writes happening over it.
DefaultReadHeadersTimeout is a default TCP timeout when we wait for the response headers to arrive.
By default all users use /bin/bash.
DefaultThrottleTimeout is a timemout used to throttle failed auth servers.
Name of events bolt database file stored in DataDir.
HOTPFirstTokensRange is amount of lookahead tokens we remember for sync purposes.
HOTPTokenDigits is the number of digits in each token.
HTTPIdleTimeout is a default timeout for idle HTTP connections.
Web UI over HTTP(s).
InviteTokenTTL sets the lifespan of tokens used for adding nodes and users to a cluster.
IterationLimit is a default limit if it's not set.
Number of max.
Number of max.
LogRotationPeriod defines how frequently to rotate the audit log file.
MaxCertDuration limits maximum duration of validity of issued cert.
MaxIterationLimit is max iteration limit.
MaxLoginAttempts sets the max.
MaxPasswordLength is maximum password length (for sanity).
MaxSignupTokenTTL is a maximum TTL for a web signup one time token clients can reduce this time, not increase it.
MinCertDuration specifies minimum duration of validity of issued cert.
MinPasswordLength is minimum password length.
Namespace is default namespace.
OIDCAuthRequestTTL is TTL of internally stored auth request created by client.
ProvisioningTokenTTL is a the default TTL for server provisioning tokens.
RoleAuthService is authentication and authorization service, the only stateful role in the system.
RoleNode is SSH stateless node.
RoleProxy is a stateless SSH access proxy (bastion).
SAMLAuthRequestTTL is TTL of internally stored auth request created by client.
path to a self-signed TLS cert file for HTTPS connection for the web proxy.
path to a self-signed TLS PRIVATE key file for HTTPS connection for the web proxy.
path to a self-signed TLS PUBLIC key file for HTTPS connection for the web proxy.
Default SSH port.
When running in "SSH Proxy" role this port will be used to accept incoming client connections and proxy them to SSHServerListenPort of one of many SSH nodes.
When running in "SSH Proxy" role this port will be used for incoming connections from SSH nodes who wish to use "reverse tunnell" (when they run behind an environment/firewall which only allows outgoing connections).
When running in "SSH Server" mode behind a proxy, this listening port will be used to connect users to:.
This is hardcoded in the U2F library.
# Variables
AuthServersRefreshPeriod is a period for clients to refresh their their stored list of auth servers.
ConfigEnvar is a name of teleport's configuration environment variable.
ConfigFilePath is default path to teleport config file.
DataDir is where all mutable data is stored (user keys, recorded sessions, registered SSH servers, etc):.
ETCDPrefix is default key in ETCD clustered configurations.
ReverseTunnelAgentHeartbeatPeriod is the period between agent heartbeat messages.
ServerHeartbeatTTL is a period between heartbeats Median sleep time between node pings is this value / 2 + random deviation added to this time to avoid lots of simultaneous heartbeats coming to auth server.
SessionRefreshPeriod is how often tsh polls information about session TODO(klizhentas) all polling periods should go away once backend releases events.
StartRoles is default roles teleport assumes when started via 'start' command.
TerminalSizeRefreshPeriod is how frequently clients who share sessions sync up their terminal sizes.