Documentation ¶
Overview ¶
Gravitational Teleport is a modern SSH server for remotely accessing clusters of Linux servers via SSH or HTTPS. It is intended to be used instead of sshd.
Teleport enables teams to easily adopt the best SSH practices like:
- No need to distribute keys: Teleport uses certificate-based access with automatic expiration time.
- Enforcement of 2nd factor authentication.
- Cluster introspection: every Teleport node becomes a part of a cluster and is visible on the Web UI.
- Record and replay SSH sessions for knowledge sharing and auditing purposes.
- Collaboratively troubleshoot issues through session sharing.
- Connect to clusters located behind firewalls without direct Internet access via SSH bastions.
- Ability to integrate SSH credentials with your organization identities via OAuth (Google Apps, Github).
- Keep the full audit log of all SSH sessions within a cluster.
Teleport web site:
https://gravitational.com/teleport/
Teleport on Github:
https://github.com/gravitational/teleport
Index ¶
Constants ¶
const ( // SSHAuthSock is the environment variable pointing to the // Unix socket the SSH agent is running on. SSHAuthSock = "SSH_AUTH_SOCK" // SSHAgentPID is the environment variable pointing to the agent // process ID SSHAgentPID = "SSH_AGENT_PID" // SSHTeleportUser is the current Teleport user that is logged in. SSHTeleportUser = "SSH_TELEPORT_USER" // SSHSessionWebproxyAddr is the address the web proxy. SSHSessionWebproxyAddr = "SSH_SESSION_WEBPROXY_ADDR" // SSHTeleportClusterName is the name of the cluster this node belongs to. SSHTeleportClusterName = "SSH_TELEPORT_CLUSTER_NAME" // SSHTeleportHostUUID is the UUID of the host. SSHTeleportHostUUID = "SSH_TELEPORT_HOST_UUID" // SSHSessionID is the UUID of the current session. SSHSessionID = "SSH_SESSION_ID" )
const ( // TOTPValidityPeriod is the number of seconds a TOTP token is valid. TOTPValidityPeriod uint = 30 // TOTPSkew adds that many periods before and after to the validity window. TOTPSkew uint = 1 )
const ( // ComponentMemory is a memory backend ComponentMemory = "memory" // ComponentAuthority is a TLS and an SSH certificate authority ComponentAuthority = "ca" // ComponentProcess is a main control process ComponentProcess = "proc" // ComponentServer is a server subcomponent of some services ComponentServer = "server" // ComponentACME is ACME protocol controller ComponentACME = "acme" // ComponentReverseTunnelServer is reverse tunnel server // that together with agent establish a bi-directional SSH revers tunnel // to bypass firewall restrictions ComponentReverseTunnelServer = "proxy:server" // ComponentReverseTunnelAgent is reverse tunnel agent // that together with server establish a bi-directional SSH revers tunnel // to bypass firewall restrictions ComponentReverseTunnelAgent = "proxy:agent" // ComponentLabel is a component label name used in reporting ComponentLabel = "component" // ComponentProxyKube is a kubernetes proxy ComponentProxyKube = "proxy:kube" // ComponentAuth is the cluster CA node (auth server API) ComponentAuth = "auth" // ComponentGRPC is grpc server ComponentGRPC = "grpc" // ComponentMigrate is responsible for data migrations ComponentMigrate = "migrate" // ComponentNode is SSH node (SSH server serving requests) ComponentNode = "node" // ComponentForwardingNode is SSH node (SSH server serving requests) ComponentForwardingNode = "node:forward" // ComponentProxy is SSH proxy (SSH server forwarding connections) ComponentProxy = "proxy" // ComponentProxyPeer is the proxy peering component of the proxy service ComponentProxyPeer = "proxy:peer" // ComponentApp is the application proxy service. ComponentApp = "app:service" // ComponentDatabase is the database proxy service. ComponentDatabase = "db:service" // ComponentDiscovery is the Discovery service. ComponentDiscovery = "discovery:service" // ComponentAppProxy is the application handler within the web proxy service. ComponentAppProxy = "app:web" // ComponentWebProxy is the web handler within the web proxy service. ComponentWebProxy = "web" // ComponentDiagnostic is a diagnostic service ComponentDiagnostic = "diag" // ComponentClient is a client ComponentClient = "client" // ComponentTunClient is a tunnel client ComponentTunClient = "client:tunnel" // ComponentCache is a cache component ComponentCache = "cache" // ComponentBackend is a backend component ComponentBackend = "backend" // ComponentSubsystemProxy is the proxy subsystem. ComponentSubsystemProxy = "subsystem:proxy" // ComponentSubsystemSFTP is the SFTP subsystem. ComponentSubsystemSFTP = "subsystem:sftp" // ComponentLocalTerm is a terminal on a regular SSH node. ComponentLocalTerm = "term:local" // ComponentRemoteTerm is a terminal on a forwarding SSH node. ComponentRemoteTerm = "term:remote" // ComponentRemoteSubsystem is subsystem on a forwarding SSH node. ComponentRemoteSubsystem = "subsystem:remote" // ComponentAuditLog is audit log component ComponentAuditLog = "audit" // ComponentKeyAgent is an agent that has loaded the sessions keys and // certificates for a user connected to a proxy. ComponentKeyAgent = "keyagent" // ComponentKeyStore is all sessions keys and certificates a user has on disk // for all proxies. ComponentKeyStore = "keystore" // ComponentConnectProxy is the HTTP CONNECT proxy used to tunnel connection. ComponentConnectProxy = "http:proxy" // ComponentSOCKS is a SOCKS5 proxy. ComponentSOCKS = "socks" // ComponentKeyGen is the public/private keypair generator. ComponentKeyGen = "keygen" // ComponentFirestore represents firestore clients ComponentFirestore = "firestore" // ComponentSession is an active session. ComponentSession = "session" // ComponentDynamoDB represents dynamodb clients ComponentDynamoDB = "dynamodb" // Component pluggable authentication module (PAM) ComponentPAM = "pam" // ComponentUpload is a session recording upload server ComponentUpload = "upload" // ComponentWeb is a web server ComponentWeb = "web" // ComponentWebsocket is websocket server that the web client connects to. ComponentWebsocket = "websocket" // ComponentRBAC is role-based access control. ComponentRBAC = "rbac" // ComponentKeepAlive is keep-alive messages sent from clients to servers // and vice versa. ComponentKeepAlive = "keepalive" // ComponentTeleport is the "teleport" binary. ComponentTeleport = "teleport" // ComponentTSH is the "tsh" binary. ComponentTSH = "tsh" // ComponentTBot is the "tbot" binary ComponentTBot = "tbot" // ComponentKubeClient is the Kubernetes client. ComponentKubeClient = "client:kube" // ComponentBuffer is in-memory event circular buffer // used to broadcast events to subscribers. ComponentBuffer = "buffer" // ComponentBPF is the eBPF packagae. ComponentBPF = "bpf" // ComponentRestrictedSession is restriction of user access to kernel objects ComponentRestrictedSession = "restrictedsess" // ComponentCgroup is the cgroup package. ComponentCgroup = "cgroups" // ComponentKube is an Kubernetes API gateway. ComponentKube = "kubernetes" // ComponentSAML is a SAML service provider. ComponentSAML = "saml" // ComponentMetrics is a metrics server ComponentMetrics = "metrics" // ComponentWindowsDesktop is a Windows desktop access server. ComponentWindowsDesktop = "windows_desktop" // ComponentTracing is a tracing exporter ComponentTracing = "tracing" // ComponentInstance is an abstract component common to all services. ComponentInstance = "instance" // ComponentVersionControl is the component common to all version control operations. ComponentVersionControl = "version-control" // DebugEnvVar tells tests to use verbose debug output DebugEnvVar = "DEBUG" // DebugAssetsPath allows users to set the path of the webassets if debug // mode is enabled. // For example, // `DEBUG=1 DEBUG_ASSETS_PATH=/path/to/webassets/ teleport start`. DebugAssetsPath = "DEBUG_ASSETS_PATH" // VerboseLogEnvVar forces all logs to be verbose (down to DEBUG level) VerboseLogsEnvVar = "TELEPORT_DEBUG" // IterationsEnvVar sets tests iterations to run IterationsEnvVar = "ITERATIONS" // DefaultTerminalWidth defines the default width of a server-side allocated // pseudo TTY DefaultTerminalWidth = 80 // DefaultTerminalHeight defines the default height of a server-side allocated // pseudo TTY DefaultTerminalHeight = 25 // SafeTerminalType is the fall-back TTY type to fall back to (when $TERM // is not defined) SafeTerminalType = "xterm" // DataDirParameterName is the name of the data dir configuration parameter passed // to all backends during initialization DataDirParameterName = "data_dir" // KeepAliveReqType is a SSH request type to keep the connection alive. A client and // a server keep pining each other with it. KeepAliveReqType = "keepalive@openssh.com" // RecordingProxyReqType is the name of a global request which returns if // the proxy is recording sessions or not. // // DEPRECATED: ClusterDetailsReqType should be used instead to avoid multiple round trips for // cluster information. // TODO(tross):DELETE IN 12.0 RecordingProxyReqType = "recording-proxy@teleport.com" // ClusterDetailsReqType is the name of a global request which returns cluster details like // if the proxy is recording sessions or not and if FIPS is enabled. ClusterDetailsReqType = "cluster-details@goteleport.com" // JSON means JSON serialization format JSON = "json" // YAML means YAML serialization format YAML = "yaml" // Text means text serialization format Text = "text" // PTY is a raw pty session capture format PTY = "pty" // Names is for formatting node names in plain text Names = "names" // LinuxAdminGID is the ID of the standard adm group on linux LinuxAdminGID = 4 // by the owner and group DirMaskSharedGroup = 0770 // FileMaskOwnerOnly is the file mask that allows read write access // to owers only FileMaskOwnerOnly = 0600 // On means mode is on On = "on" // Off means mode is off Off = "off" // SchemeS3 is S3 file scheme, means upload or download to S3 like object // storage SchemeS3 = "s3" // SchemeGCS is GCS file scheme, means upload or download to GCS like object // storage SchemeGCS = "gs" // GCSTestURI turns on GCS tests GCSTestURI = "TEST_GCS_URI" // AWSRunTests turns on tests executed against AWS directly AWSRunTests = "TEST_AWS" // Region is AWS region parameter Region = "region" // Endpoint is an optional Host for non-AWS S3 Endpoint = "endpoint" // Insecure is an optional switch to use HTTP instead of HTTPS Insecure = "insecure" // DisableServerSideEncryption is an optional switch to opt out of SSE in case the provider does not support it DisableServerSideEncryption = "disablesse" // ACL is the canned ACL to send to S3 ACL = "acl" // SSEKMSKey is an optional switch to use an KMS CMK key for S3 SSE. SSEKMSKey = "sse_kms_key" // SchemeFile is a local disk file storage SchemeFile = "file" // SchemeStdout outputs audit log entries to stdout SchemeStdout = "stdout" // LogsDir is a log subdirectory for events and logs LogsDir = "log" // Syslog is a mode for syslog logging Syslog = "syslog" // HumanDateFormat is a human readable date formatting HumanDateFormat = "Jan _2 15:04 UTC" // HumanDateFormatMilli is a human readable date formatting with milliseconds HumanDateFormatMilli = "Jan _2 15:04:05.000 UTC" // DebugLevel is a debug logging level name DebugLevel = "debug" // MinimumEtcdVersion is the minimum version of etcd supported by Teleport MinimumEtcdVersion = "3.3.0" )
const ( // OIDCPromptSelectAccount instructs the Authorization Server to // prompt the End-User to select a user account. OIDCPromptSelectAccount = "select_account" // OIDCAccessTypeOnline indicates that OIDC flow should be performed // with Authorization server and user connected online OIDCAccessTypeOnline = "online" )
const ( // AuthorizedKeys are public keys that check against User CAs. AuthorizedKeys = "authorized_keys" // KnownHosts are public keys that check against Host CAs. KnownHosts = "known_hosts" )
const ( // CertExtensionPermitX11Forwarding allows X11 forwarding for certificate CertExtensionPermitX11Forwarding = "permit-X11-forwarding" // CertExtensionPermitAgentForwarding allows agent forwarding for certificate CertExtensionPermitAgentForwarding = "permit-agent-forwarding" // CertExtensionPermitPTY allows user to request PTY CertExtensionPermitPTY = "permit-pty" // CertExtensionPermitPortForwarding allows user to request port forwarding CertExtensionPermitPortForwarding = "permit-port-forwarding" // CertExtensionTeleportRoles is used to propagate teleport roles CertExtensionTeleportRoles = "teleport-roles" // CertExtensionTeleportRouteToCluster is used to encode // the target cluster to route to in the certificate CertExtensionTeleportRouteToCluster = "teleport-route-to-cluster" // CertExtensionTeleportTraits is used to propagate traits about the user. CertExtensionTeleportTraits = "teleport-traits" // CertExtensionTeleportActiveRequests is used to track which privilege // escalation requests were used to construct the certificate. CertExtensionTeleportActiveRequests = "teleport-active-requests" // CertExtensionMFAVerified is used to mark certificates issued after an MFA // check. CertExtensionMFAVerified = "mfa-verified" // CertExtensionClientIP is used to embed the IP of the client that created // the certificate. CertExtensionClientIP = "client-ip" // CertExtensionImpersonator is set when one user has requested certificates // for another user CertExtensionImpersonator = "impersonator" // CertExtensionDisallowReissue is set when a certificate should not be allowed // to request future certificates. CertExtensionDisallowReissue = "disallow-reissue" // CertExtensionRenewable is a flag to indicate the certificate may be // renewed. CertExtensionRenewable = "renewable" // CertExtensionGeneration counts the number of times a certificate has // been renewed. CertExtensionGeneration = "generation" // CertExtensionAllowedResources lists the resources which this certificate // should be allowed to access CertExtensionAllowedResources = "teleport-allowed-resources" // CertExtensionConnectionDiagnosticID contains the ID of the ConnectionDiagnostic. // The Node/Agent will append connection traces to this diagnostic instance. CertExtensionConnectionDiagnosticID = "teleport-connection-diagnostic-id" // CertExtensionPrivateKeyPolicy is used to mark certificates with their supported // private key policy. CertExtensionPrivateKeyPolicy = "private-key-policy" )
const ( // NetIQ is an identity provider. NetIQ = "netiq" // ADFS is Microsoft Active Directory Federation Services ADFS = "adfs" // Ping is the common backend for all Ping Identity-branded identity // providers (including PingOne, PingFederate, etc). Ping = "ping" // Okta should be used for Okta OIDC providers. Okta = "okta" // JumpCloud is an identity provider. JumpCloud = "jumpcloud" )
Note: when adding new providers to this list, consider updating the help message for --provider flag for `tctl sso configure oidc` and `tctl sso configure saml` commands as well as docs at https://goteleport.com/docs/enterprise/sso/#provider-specific-workarounds
const ( // RemoteCommandSuccess is returned when a command has successfully executed. RemoteCommandSuccess = 0 // RemoteCommandFailure is returned when a command has failed to execute and // we don't have another status code for it. RemoteCommandFailure = 255 // HomeDirNotFound is returned when a the "teleport checkhomedir" command cannot // find the user's home directory. HomeDirNotFound = 254 )
const ( // CertificateFormatOldSSH is used to make Teleport interoperate with older // versions of OpenSSH. CertificateFormatOldSSH = "oldssh" // CertificateFormatUnspecified is used to check if the format was specified // or not. CertificateFormatUnspecified = "" )
const ( // TraitInternalPrefix is the role variable prefix that indicates it's for // local accounts. TraitInternalPrefix = "internal" // TraitExternalPrefix is the role variable prefix that indicates the data comes from an external identity provider. TraitExternalPrefix = "external" // TraitTeams is the name of the role variable use to store team // membership information TraitTeams = "github_teams" // TraitJWT is the name of the trait containing JWT header for app access. TraitJWT = "jwt" // TraitInternalLoginsVariable is the variable used to store allowed // logins for local accounts. TraitInternalLoginsVariable = "{{internal.logins}}" // TraitInternalWindowsLoginsVariable is the variable used to store // allowed Windows Desktop logins for local accounts. TraitInternalWindowsLoginsVariable = "{{internal.windows_logins}}" // TraitInternalKubeGroupsVariable is the variable used to store allowed // kubernetes groups for local accounts. TraitInternalKubeGroupsVariable = "{{internal.kubernetes_groups}}" // TraitInternalKubeUsersVariable is the variable used to store allowed // kubernetes users for local accounts. TraitInternalKubeUsersVariable = "{{internal.kubernetes_users}}" // TraitInternalDBNamesVariable is the variable used to store allowed // database names for local accounts. TraitInternalDBNamesVariable = "{{internal.db_names}}" // TraitInternalDBUsersVariable is the variable used to store allowed // database users for local accounts. TraitInternalDBUsersVariable = "{{internal.db_users}}" // TraitInternalAWSRoleARNs is the variable used to store allowed AWS // role ARNs for local accounts. TraitInternalAWSRoleARNs = "{{internal.aws_role_arns}}" // TraitInternalJWTVariable is the variable used to store JWT token for // app sessions. TraitInternalJWTVariable = "{{internal.jwt}}" )
const ( // PresetEditorRoleName is a name of a preset role that allows // editing cluster configuration. PresetEditorRoleName = "editor" // PresetAccessRoleName is a name of a preset role that allows // accessing cluster resources. PresetAccessRoleName = "access" // PresetAuditorRoleName is a name of a preset role that allows // reading cluster events and playing back session records. PresetAuditorRoleName = "auditor" )
const ( // RemoteClusterStatusOffline indicates that cluster is considered as // offline, since it has missed a series of heartbeats RemoteClusterStatusOffline = "offline" // RemoteClusterStatusOnline indicates that cluster is sending heartbeats // at expected interval RemoteClusterStatusOnline = "online" )
const ( // PrivateDirMode is a mode for private directories PrivateDirMode = 0700 )SharedDirMode = 0750
const ( // SessionEvent is sent by servers to clients when an audit event occurs on // the session. SessionEvent = "x-teleport-event" // VersionRequest is sent by clients to server requesting the Teleport // version they are running. VersionRequest = "x-teleport-version" // ForceTerminateRequest is an SSH request to forcefully terminate a session. ForceTerminateRequest = "x-teleport-force-terminate" // TerminalSizeRequest is a request for the terminal size of the session. TerminalSizeRequest = "x-teleport-terminal-size" // MFAPresenceRequest is an SSH request to notify clients that MFA presence is required for a session. MFAPresenceRequest = "x-teleport-mfa-presence" // EnvSSHJoinMode is the SSH environment variable that contains the requested participant mode. EnvSSHJoinMode = "TELEPORT_SSH_JOIN_MODE" // EnvSSHSessionReason is a reason attached to started sessions meant to describe their intent. EnvSSHSessionReason = "TELEPORT_SESSION_REASON" // EnvSSHSessionInvited is an environment variable listning people invited to a session. EnvSSHSessionInvited = "TELEPORT_SESSION_JOIN_MODE" // EnvSSHSessionDisplayParticipantRequirements is set to true or false to indicate if participant // requirement information should be printed. EnvSSHSessionDisplayParticipantRequirements = "TELEPORT_SESSION_PARTICIPANT_REQUIREMENTS" // SSHSessionJoinPrincipal is the SSH principal used when joining sessions. // This starts with a hyphen so it isn't a valid unix login. SSHSessionJoinPrincipal = "-teleport-internal-join" )
const ( // EnvKubeConfig is environment variable for kubeconfig EnvKubeConfig = "KUBECONFIG" // KubeConfigDir is a default directory where k8s stores its user local config KubeConfigDir = ".kube" // KubeConfigFile is a default filename where k8s stores its user local config KubeConfigFile = "config" // KubeRunTests turns on kubernetes tests KubeRunTests = "TEST_KUBE" // KubeSystemAuthenticated is a builtin group that allows // any user to access common API methods, e.g. discovery methods // required for initial client usage KubeSystemAuthenticated = "system:authenticated" // UsageKubeOnly specifies certificate usage metadata // that limits certificate to be only used for kubernetes proxying UsageKubeOnly = "usage:kube" // UsageAppOnly specifies a certificate metadata that only allows it to be // used for proxying applications. UsageAppsOnly = "usage:apps" // UsageDatabaseOnly specifies certificate usage metadata that only allows // it to be used for proxying database connections. UsageDatabaseOnly = "usage:db" // UsageWindowsDesktopOnly specifies certificate usage metadata that limits // certificate to be only used for Windows desktop access UsageWindowsDesktopOnly = "usage:windows_desktop" )
const ( // NodeIsAmbiguous serves as an identifying error string indicating that // the proxy subsystem found multiple nodes matching the specified hostname. NodeIsAmbiguous = "err-node-is-ambiguous" // MaxLeases serves as an identifying error string indicating that the // semaphore system is rejecting an acquisition attempt due to max // leases having already been reached. MaxLeases = "err-max-leases" )
const ( // OpenBrowserLinux is the command used to open a web browser on Linux. OpenBrowserLinux = "xdg-open" // OpenBrowserDarwin is the command used to open a web browser on macOS/Darwin. OpenBrowserDarwin = "open" // OpenBrowserWindows is the command used to open a web browser on Windows. OpenBrowserWindows = "rundll32.exe" // BrowserNone is the string used to suppress the opening of a browser in // response to 'tsh login' commands. BrowserNone = "none" )
const ( // ExecSubCommand is the sub-command Teleport uses to re-exec itself for // command execution (exec and shells). ExecSubCommand = "exec" // ForwardSubCommand is the sub-command Teleport uses to re-exec itself // for port forwarding. ForwardSubCommand = "forward" // CheckHomeDirSubCommand is the sub-command Teleport uses to re-exec itself // to check if the user's home directory exists. CheckHomeDirSubCommand = "checkhomedir" // ParkSubCommand is the sub-command Teleport uses to re-exec itself as a // specific UID to prevent the matching user from being deleted before // spawning the intended child process. ParkSubCommand = "park" // SFTPSubCommand is the sub-command Teleport uses to re-exec itself to // handle SFTP connections. SFTPSubCommand = "sftp" )
const ( // ChanDirectTCPIP is a SSH channel of type "direct-tcpip". ChanDirectTCPIP = "direct-tcpip" // ChanSession is a SSH channel of type "session". ChanSession = "session" )
const ( // internal application being proxied. AppJWTHeader = "teleport-jwt-assertion" // AppCFHeader is a compatibility header. AppCFHeader = "cf-access-token" // HostHeader is the name of the Host header. HostHeader = "Host" )
const ( // WebAPIConnUpgrade is the HTTP web API to make the connection upgrade // call. WebAPIConnUpgrade = "/webapi/connectionupgrade" // WebAPIConnUpgradeHeader is the header used to indicate the requested // connection upgrade types in the connection upgrade API. WebAPIConnUpgradeHeader = "Upgrade" // WebAPIConnUpgradeTypeALPN is a connection upgrade type that specifies // the upgraded connection should be handled by the ALPN handler. WebAPIConnUpgradeTypeALPN = "alpn" )
const ( // MetricGenerateRequests counts how many generate server keys requests // are issued over time MetricGenerateRequests = "auth_generate_requests_total" // MetricGenerateRequestsThrottled measures how many generate requests // are throttled MetricGenerateRequestsThrottled = "auth_generate_requests_throttled_total" // MetricGenerateRequestsCurrent measures current in-flight requests MetricGenerateRequestsCurrent = "auth_generate_requests" // MetricGenerateRequestsHistogram measures generate requests latency MetricGenerateRequestsHistogram = "auth_generate_seconds" // MetricServerInteractiveSessions measures interactive sessions in flight MetricServerInteractiveSessions = "server_interactive_sessions_total" // MetricProxySSHSessions measures sessions in flight on the proxy MetricProxySSHSessions = "proxy_ssh_sessions_total" // MetricRemoteClusters measures connected remote clusters MetricRemoteClusters = "remote_clusters" // MetricTrustedClusters counts trusted clusters MetricTrustedClusters = "trusted_clusters" // MetricClusterNameNotFound counts times a cluster name was not found MetricClusterNameNotFound = "cluster_name_not_found_total" // MetricFailedLoginAttempts counts failed login attempts MetricFailedLoginAttempts = "failed_login_attempts_total" // MetricConnectToNodeAttempts counts ssh attempts MetricConnectToNodeAttempts = "connect_to_node_attempts_total" // MetricFailedConnectToNodeAttempts counts failed ssh attempts MetricFailedConnectToNodeAttempts = "failed_connect_to_node_attempts_total" // MetricUserMaxConcurrentSessionsHit counts number of times a user exceeded their max concurrent ssh connections MetricUserMaxConcurrentSessionsHit = "user_max_concurrent_sessions_hit_total" // MetricProxyConnectionLimitHit counts the number of times the proxy connection limit was exceeded MetricProxyConnectionLimitHit = "proxy_connection_limit_exceeded_total" // MetricUserLoginCount counts user logins MetricUserLoginCount = "user_login_total" // MetricHeartbeatConnectionsReceived counts heartbeat connections received by auth MetricHeartbeatConnectionsReceived = "heartbeat_connections_received_total" // MetricCertificateMismatch counts login failures due to certificate mismatch MetricCertificateMismatch = "certificate_mismatch_total" // MetricHeartbeatsMissed counts the nodes that failed to heartbeat MetricHeartbeatsMissed = "heartbeats_missed_total" // MetricWatcherEventsEmitted counts watcher events that are emitted MetricWatcherEventsEmitted = "watcher_events" // MetricWatcherEventSizes measures the size of watcher events that are emitted MetricWatcherEventSizes = "watcher_event_sizes" // MetricMissingSSHTunnels returns the number of missing SSH tunnels for this proxy. MetricMissingSSHTunnels = "proxy_missing_ssh_tunnels" // TagCluster is a metric tag for a cluster TagCluster = "cluster" )
const ( // MetricProcessCPUSecondsTotal measures CPU seconds consumed by process MetricProcessCPUSecondsTotal = "process_cpu_seconds_total" // MetricProcessMaxFDs shows maximum amount of file descriptors allowed for the process MetricProcessMaxFDs = "process_max_fds" // MetricProcessOpenFDs shows process open file descriptors MetricProcessOpenFDs = "process_open_fds" // MetricProcessResidentMemoryBytes measures bytes consumed by process resident memory MetricProcessResidentMemoryBytes = "process_resident_memory_bytes" // MetricProcessStartTimeSeconds measures process start time MetricProcessStartTimeSeconds = "process_start_time_seconds" )
const ( // MetricGoThreads is amount of system threads used by Go runtime MetricGoThreads = "go_threads" // MetricGoGoroutines measures current number of goroutines MetricGoGoroutines = "go_goroutines" // MetricGoInfo provides information about Go runtime version MetricGoInfo = "go_info" // MetricGoAllocBytes measures allocated memory bytes MetricGoAllocBytes = "go_memstats_alloc_bytes" // MetricGoHeapAllocBytes measures heap bytes allocated by Go runtime MetricGoHeapAllocBytes = "go_memstats_heap_alloc_bytes" // MetricGoHeapObjects measures count of heap objects created by Go runtime MetricGoHeapObjects = "go_memstats_heap_objects" )
const ( // MetricBackendWatchers is a metric with backend watchers MetricBackendWatchers = "backend_watchers_total" // MetricBackendWatcherQueues is a metric with backend watcher queues sizes MetricBackendWatcherQueues = "backend_watcher_queues_total" // MetricBackendRequests measures count of backend requests MetricBackendRequests = "backend_requests" // MetricBackendReadHistogram measures histogram of backend read latencies MetricBackendReadHistogram = "backend_read_seconds" // MetricBackendWriteHistogram measures histogram of backend write latencies MetricBackendWriteHistogram = "backend_write_seconds" // MetricBackendBatchWriteHistogram measures histogram of backend batch write latencies MetricBackendBatchWriteHistogram = "backend_batch_write_seconds" // MetricBackendBatchReadHistogram measures histogram of backend batch read latencies MetricBackendBatchReadHistogram = "backend_batch_read_seconds" // MetricBackendWriteRequests measures backend write requests count MetricBackendWriteRequests = "backend_write_requests_total" // MetricBackendWriteFailedRequests measures failed backend write requests count MetricBackendWriteFailedRequests = "backend_write_requests_failed_total" // MetricBackendBatchWriteRequests measures batch backend writes count MetricBackendBatchWriteRequests = "backend_batch_write_requests_total" // MetricBackendBatchFailedWriteRequests measures failed batch backend requests count MetricBackendBatchFailedWriteRequests = "backend_batch_write_requests_failed_total" // MetricBackendReadRequests measures backend read requests count MetricBackendReadRequests = "backend_read_requests_total" // MetricBackendFailedReadRequests measures failed backend read requests count MetricBackendFailedReadRequests = "backend_read_requests_failed_total" // MetricBackendBatchReadRequests measures batch backend read requests count MetricBackendBatchReadRequests = "backend_batch_read_requests_total" // MetricBackendBatchFailedReadRequests measures failed backend batch read requests count MetricBackendBatchFailedReadRequests = "backend_batch_read_requests_failed_total" // MetricLostCommandEvents measures the number of command events that were lost MetricLostCommandEvents = "bpf_lost_command_events" // MetricLostDiskEvents measures the number of disk events that were lost. MetricLostDiskEvents = "bpf_lost_disk_events" // MetricLostNetworkEvents measures the number of network events that were lost. MetricLostNetworkEvents = "bpf_lost_network_events" // MetricLostRestrictedEvents measures the number of restricted events that were lost MetricLostRestrictedEvents = "bpf_lost_restricted_events" // MetricState tracks the state of the teleport process. MetricState = "process_state" // MetricNamespace defines the teleport prometheus namespace MetricNamespace = "teleport" // MetricConnectedResources tracks the number and type of resources connected via keepalives MetricConnectedResources = "connected_resources" // MetricBuildInfo tracks build information MetricBuildInfo = "build_info" // MetricCacheEventsReceived tracks the total number of events received by a cache MetricCacheEventsReceived = "cache_events" // MetricStaleCacheEventsReceived tracks the number of stale events received by a cache MetricStaleCacheEventsReceived = "cache_stale_events" // MetricRegisteredServers tracks the number of Teleport servers that have successfully registered with the Teleport cluster and have not reached the end of their ttl MetricRegisteredServers = "registered_servers" // MetricReverseSSHTunnels defines the number of connected SSH reverse tunnels to the proxy MetricReverseSSHTunnels = "reverse_tunnels_connected" // TagRange is a tag specifying backend requests TagRange = "range" // TagReq is a tag specifying backend request type TagReq = "req" // TagTrue is a tag value to mark true values TagTrue = "true" // TagFalse is a tag value to mark false values TagFalse = "false" // TagResource is a tag specifying the resource for an event TagResource = "resource" // TagVersion is a prometheus label for version of Teleport built TagVersion = "version" // TagGitref is a prometheus label for the gitref of Teleport built TagGitref = "gitref" // TagGoVersion is a prometheus label for version of Go used to build Teleport TagGoVersion = "goversion" // TagCacheComponent is a prometheus label for the cache component TagCacheComponent = "cache_component" // TagType is a prometheus label for type of resource or tunnel connected TagType = "type" // TagServer is a prometheus label to indicate what server the metric is tied to TagServer = "server" // TagClient is a prometheus label to indicate what client the metric is tied to TagClient = "client" )
const AdminRoleName = "admin"
AdminRoleName is the name of the default admin role for all local users if another role is not explicitly assigned
const ( // GetHomeDirSubsystem is an SSH subsystem request that Teleport // uses to get the home directory of a remote user. GetHomeDirSubsystem = "gethomedir" )
const ( // HTTPNextProtoTLS is the NPN/ALPN protocol negotiated during // HTTP/1.1.'s TLS setup. // https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids HTTPNextProtoTLS = "http/1.1" )
const MaxEnvironmentFileLines = 1000
MaxEnvironmentFileLines is the maximum number of lines in a environment file.
const MaxHTTPRequestSize = 10 * 1024 * 1024
MaxHTTPRequestSize is the maximum accepted size (in bytes) of the body of a received HTTP request. This limit is meant to be used with utils.ReadAtMost to prevent resource exhaustion attacks.
const MaxHTTPResponseSize = 10 * 1024 * 1024
MaxHTTPResponseSize is the maximum accepted size (in bytes) of the body of a received HTTP response. This limit is meant to be used with utils.ReadAtMost to prevent resource exhaustion attacks.
const MaxResourceSize = 1000000
MaxResourceSize is the maximum size (in bytes) of a serialized resource. This limit is typically only enforced against resources that are likely to arbitrarily grow (e.g. PluginData).
const SCP = "scp"
SCP is Secure Copy.
const StandardHTTPSPort = 443
StandardHTTPSPort is the default port used for the https URI scheme, cf. RFC 7230 § 2.7.2.
const UserSingleUseCertTTL = time.Minute
UserSingleUseCertTTL is a TTL for per-connection user certificates.
const UserSystem = "system"
UserSystem defines a user as system.
const (
Version = "12.0.0-dev"
)
const WebAPIVersion = "v1"
WebAPIVersion is a current webapi version
Variables ¶
var Gitref string
Gitref variable is automatically set to the output of git-describe during the build process
var MinClientVersion string
MinClientVersion is the minimum client version required by the server.
Functions ¶
func Component ¶ added in v1.0.0
Component generates "component:subcomponent1:subcomponent2" strings used in debugging
func NewWebAssetsFilesystem ¶
func NewWebAssetsFilesystem() (http.FileSystem, error)
NewWebAssetsFilesystem is a no-op in this build mode.
Types ¶
type Principal ¶
type Principal string
A principal name for use in SSH certificates.
const ( // The localhost domain, for talking to a proxy or node on the same // machine. PrincipalLocalhost Principal = "localhost" // The IPv4 loopback address, for talking to a proxy or node on the same // machine. PrincipalLoopbackV4 Principal = "127.0.0.1" // The IPv6 loopback address, for talking to a proxy or node on the same // machine. PrincipalLoopbackV6 Principal = "::1" )
Directories ¶
Path | Synopsis |
---|---|
api
module
|
|
build.assets
|
|
gomod/update-api-import-path
Command update-api-import-path updates the api import path to incorporate the version set in /api/version.go.
|
Command update-api-import-path updates the api import path to incorporate the version set in /api/version.go. |
tooling
Module
|
|
docs
|
|
examples
|
|
integration package tests Teleport on a high level creating clusters of servers in memory, connecting them together and connecting to them
|
integration package tests Teleport on a high level creating clusters of servers in memory, connecting them together and connecting to them |
integrations
|
|
kube-agent-updater
Module
|
|
terraform
Module
|
|
asciitable
Package asciitable implements a simple ASCII table formatter for printing tabular values into a text terminal.
|
Package asciitable implements a simple ASCII table formatter for printing tabular values into a text terminal. |
auth
*
|
* |
auth/authclient
Package authclient contains common code for creating an auth server client which may use SSH tunneling through a proxy.
|
Package authclient contains common code for creating an auth server client which may use SSH tunneling through a proxy. |
auth/keystore
Package keystore provides a generic client and associated helpers for handling private keys that may be backed by an HSM.
|
Package keystore provides a generic client and associated helpers for handling private keys that may be backed by an HSM. |
auth/test
package test contains CA authority acceptance test suite.
|
package test contains CA authority acceptance test suite. |
auth/testauthority
Package testauthority implements a wrapper around native.Keygen that uses pre-computed keys.
|
Package testauthority implements a wrapper around native.Keygen that uses pre-computed keys. |
auth/webauthn
Package webauthn implements server-side support for the Web Authentication specification.
|
Package webauthn implements server-side support for the Web Authentication specification. |
auth/webauthncli
Package webauthncli provides the client-side implementation for WebAuthn.
|
Package webauthncli provides the client-side implementation for WebAuthn. |
auth/webauthnwin
Package webauthnwin is wrapper around Windows webauthn API.
|
Package webauthnwin is wrapper around Windows webauthn API. |
backend
Package backend provides storage backend abstraction layer
|
Package backend provides storage backend abstraction layer |
backend/dynamo
Package dynamo implements DynamoDB storage backend for Teleport auth service, similar to etcd backend.
|
Package dynamo implements DynamoDB storage backend for Teleport auth service, similar to etcd backend. |
backend/etcdbk
Package etcdbk implements Etcd powered backend
|
Package etcdbk implements Etcd powered backend |
backend/firestore
Package firestoreFirestoreBackend implements Firestore storage backend for Teleport auth service, similar to DynamoDB backend.
|
Package firestoreFirestoreBackend implements Firestore storage backend for Teleport auth service, similar to DynamoDB backend. |
backend/kubernetes
Package kubernetes implements Kubernetes Secret backend used for persisting identity and state for agent's running in Kubernetes clusters.
|
Package kubernetes implements Kubernetes Secret backend used for persisting identity and state for agent's running in Kubernetes clusters. |
backend/lite
Package lite implements SQLite backend used for local persistent caches in proxies and nodes and for standalone auth service deployments.
|
Package lite implements SQLite backend used for local persistent caches in proxies and nodes and for standalone auth service deployments. |
backend/memory
Package memory implements backend interface using a combination of Minheap (to store expiring items) and B-Tree for storing sorted dictionary of items.
|
Package memory implements backend interface using a combination of Minheap (to store expiring items) and B-Tree for storing sorted dictionary of items. |
backend/test
Package test contains a backend acceptance test suite that is backend implementation independent each backend will use the suite to test itself
|
Package test contains a backend acceptance test suite that is backend implementation independent each backend will use the suite to test itself |
benchmark
Package benchmark package provides tools to run progressive or independent benchmarks against teleport services.
|
Package benchmark package provides tools to run progressive or independent benchmarks against teleport services. |
cache
Package cache implements event-driven cache layer that is used by auth servers, proxies and nodes.
|
Package cache implements event-driven cache layer that is used by auth servers, proxies and nodes. |
client/db
Package db contains methods for working with database connection profiles that combine connection parameters for a particular database.
|
Package db contains methods for working with database connection profiles that combine connection parameters for a particular database. |
client/escape
Package escape implements client-side escape character logic.
|
Package escape implements client-side escape character logic. |
client/identityfile
Package identityfile handles formatting and parsing of identity files.
|
Package identityfile handles formatting and parsing of identity files. |
cloud
Package cloud contains common methods and utilities for integrations with various cloud providers such as AWS, GCP or Azure.
|
Package cloud contains common methods and utilities for integrations with various cloud providers such as AWS, GCP or Azure. |
config
Package config provides facilities for configuring Teleport daemons including
|
Package config provides facilities for configuring Teleport daemons including |
defaults
Package defaults contains default constants set in various parts of teleport codebase
|
Package defaults contains default constants set in various parts of teleport codebase |
events
Package events implements the audit log interface events.IAuditLog using filesystem backend.
|
Package events implements the audit log interface events.IAuditLog using filesystem backend. |
events/firestoreevents
Package firestoreeventsLog implements Firestore storage backend for Teleport event storage.
|
Package firestoreeventsLog implements Firestore storage backend for Teleport event storage. |
events/gcssessions
Package gcssessionsHandler implements GCS storage for Teleport session recording persistence.
|
Package gcssessionsHandler implements GCS storage for Teleport session recording persistence. |
httplib
Package httplib implements common utility functions for writing classic HTTP handlers
|
Package httplib implements common utility functions for writing classic HTTP handlers |
joinserver
Package joinserver contains the implementation of the JoinService gRPC server which runs on both Auth and Proxy.
|
Package joinserver contains the implementation of the JoinService gRPC server which runs on both Auth and Proxy. |
jwt
Package jwt is used to sign and verify JWT tokens used by application access.
|
Package jwt is used to sign and verify JWT tokens used by application access. |
kube
Package kube contains subpackages with utility functions and proxies to intercept and authenticate Kubernetes API traffic
|
Package kube contains subpackages with utility functions and proxies to intercept and authenticate Kubernetes API traffic |
kube/kubeconfig
Package kubeconfig manages teleport entries in a local kubeconfig file.
|
Package kubeconfig manages teleport entries in a local kubeconfig file. |
limiter
Package limiter implements connection and rate limiters for teleport
|
Package limiter implements connection and rate limiters for teleport |
modules
package modules allows external packages override certain behavioral aspects of teleport
|
package modules allows external packages override certain behavioral aspects of teleport |
multiplexer
Package multiplexer implements SSH and TLS multiplexing on the same listener
|
Package multiplexer implements SSH and TLS multiplexing on the same listener |
pam
Package pam implements a subset of Pluggable Authentication Modules (PAM).
|
Package pam implements a subset of Pluggable Authentication Modules (PAM). |
reversetunnel
Package reversetunnel sets up persistent reverse tunnel between remote site and teleport proxy, when site agents dial to teleport proxy's socket and teleport proxy can connect to any server through this tunnel.
|
Package reversetunnel sets up persistent reverse tunnel between remote site and teleport proxy, when site agents dial to teleport proxy's socket and teleport proxy can connect to any server through this tunnel. |
reversetunnel/track
Package track provides a simple interface for tracking known proxies by endpoint/name and correctly handling expiration and exclusivity.
|
Package track provides a simple interface for tracking known proxies by endpoint/name and correctly handling expiration and exclusivity. |
secret
Package secret implements a authenticated encryption with associated data (AEAD) cipher to be used when symmetric is required in Teleport.
|
Package secret implements a authenticated encryption with associated data (AEAD) cipher to be used when symmetric is required in Teleport. |
service
Package service implements teleport running service, takes care of initialization, cleanup and shutdown procedures
|
Package service implements teleport running service, takes care of initialization, cleanup and shutdown procedures |
services
Package services implements statefule services provided by teleport, like certificate authority management, user and web sessions, events and logs.
|
Package services implements statefule services provided by teleport, like certificate authority management, user and web sessions, events and logs. |
services/local
Package local implements services interfaces using abstract key value backend provided by lib/backend, what makes it possible for teleport to run using boltdb or etcd
|
Package local implements services interfaces using abstract key value backend provided by lib/backend, what makes it possible for teleport to run using boltdb or etcd |
session
Package session is used for bookkeeping of SSH interactive sessions that happen in realtime across the teleport cluster
|
Package session is used for bookkeeping of SSH interactive sessions that happen in realtime across the teleport cluster |
srv/app
app package runs the application proxy process.
|
app package runs the application proxy process. |
srv/db/common
Package common provides common utilities used by all supported database implementations.
|
Package common provides common utilities used by all supported database implementations. |
srv/db/mongodb
Package mongodb implements database access proxy that handles authentication, authorization and protocol parsing of connections from MongoDB clients to MongoDB clusters.
|
Package mongodb implements database access proxy that handles authentication, authorization and protocol parsing of connections from MongoDB clients to MongoDB clusters. |
srv/db/mongodb/protocol
Package protocol implements reading/writing MongoDB wire protocol messages from/to client/server and converting them into parsed data structures.
|
Package protocol implements reading/writing MongoDB wire protocol messages from/to client/server and converting them into parsed data structures. |
srv/db/mysql
Package mysql implements MySQL protocol support for the database access.
|
Package mysql implements MySQL protocol support for the database access. |
srv/db/mysql/protocol
Package protocol implements parts of MySQL wire protocol which are needed for the service to be able to interpret the protocol messages but are not readily available in the convenient form in the vendored MySQL library.
|
Package protocol implements parts of MySQL wire protocol which are needed for the service to be able to interpret the protocol messages but are not readily available in the convenient form in the vendored MySQL library. |
srv/db/postgres
Package postgres implements components of the database access subsystem that proxy connections between Postgres clients (like, psql or pgAdmin) and Postgres database servers with full protocol awareness.
|
Package postgres implements components of the database access subsystem that proxy connections between Postgres clients (like, psql or pgAdmin) and Postgres database servers with full protocol awareness. |
srv/db/redis
Package redis implements database access proxy that handles authentication, authorization and protocol parsing of connections from Redis clients to Redis standalone or Redis clusters.
|
Package redis implements database access proxy that handles authentication, authorization and protocol parsing of connections from Redis clients to Redis standalone or Redis clusters. |
srv/db/secrets
Package secrets implements clients for managing secret values using secret management tools like AWS Secrets Manager.
|
Package secrets implements clients for managing secret values using secret management tools like AWS Secrets Manager. |
srv/desktop
Package desktop implements Desktop Access services, like windows_desktop_access.
|
Package desktop implements Desktop Access services, like windows_desktop_access. |
srv/desktop/rdp/rdpclient
Package rdpclient implements an RDP client.
|
Package rdpclient implements an RDP client. |
srv/desktop/tdp
Package tdp implements the Teleport desktop protocol (TDP) encoder/decoder.
|
Package tdp implements the Teleport desktop protocol (TDP) encoder/decoder. |
srv/regular
Package regular implements SSH server that supports multiplexing tunneling, SSH connections proxying and only supports Key based auth
|
Package regular implements SSH server that supports multiplexing tunneling, SSH connections proxying and only supports Key based auth |
srv/uacc
Package uacc concerns itself with updating the user account database and log on nodes that a client connects to with an interactive session.
|
Package uacc concerns itself with updating the user account database and log on nodes that a client connects to with an interactive session. |
sshca
Package sshca specifies interfaces for SSH certificate authorities
|
Package sshca specifies interfaces for SSH certificate authorities |
sshutils
Package sshutils contains the implementations of the base SSH server used throughout Teleport.
|
Package sshutils contains the implementations of the base SSH server used throughout Teleport. |
sshutils/scp
Package scp handles file uploads and downloads via SCP command.
|
Package scp handles file uploads and downloads via SCP command. |
sshutils/sftp
Package sftp handles file transfers client-side via SFTP
|
Package sftp handles file transfers client-side via SFTP |
tlsca
Package tlsca provides internal TLS certificate authority used for mutual TLS authentication with the auth server and internal teleport components and external clients
|
Package tlsca provides internal TLS certificate authority used for mutual TLS authentication with the auth server and internal teleport components and external clients |
utils/parse
TODO(awly): combine Expression and Matcher.
|
TODO(awly): combine Expression and Matcher. |
utils/prompt
Package prompt implements CLI prompts to the user.
|
Package prompt implements CLI prompts to the user. |
utils/socks
package socks implements a SOCKS5 handshake.
|
package socks implements a SOCKS5 handshake. |
utils/workpool
Package workpool provies the `Pool` type which functions as a means of managing the number of concurrent workers, grouped by key.
|
Package workpool provies the `Pool` type which functions as a means of managing the number of concurrent workers, grouped by key. |
web
Package web implements web proxy handler that provides web interface to view and connect to teleport nodes
|
Package web implements web proxy handler that provides web interface to view and connect to teleport nodes |
web/app
Package app connections to applications over a reverse tunnel and forwards HTTP requests to them.
|
Package app connections to applications over a reverse tunnel and forwards HTTP requests to them. |
apis/resources/v2
Package v2 contains API Schema definitions for the resources v2 API group +kubebuilder:object:generate=true +groupName=resources.teleport.dev
|
Package v2 contains API Schema definitions for the resources v2 API group +kubebuilder:object:generate=true +groupName=resources.teleport.dev |
apis/resources/v5
Package v5 contains API Schema definitions for the resources v5 API group +kubebuilder:object:generate=true +groupName=resources.teleport.dev
|
Package v5 contains API Schema definitions for the resources v5 API group +kubebuilder:object:generate=true +groupName=resources.teleport.dev |
tool
|
|