README ¶
Gravitational Teleport
Project Links | Description |
---|---|
Teleport Website | The official website of the project |
Documentation | Admin guide, user manual and more |
Demo Video | 3-minute video overview of the UI. |
Teleconsole | The free service to "invite" SSH clients behind NAT, built on top of Teleport |
Blog | Our blog where we publish Teleport news |
Introduction
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 is built on top of the high-quality Golang SSH implementation and it is fully compatible with OpenSSH.
Installing and Running
Download the latest binary release,
unpack the .tar.gz and run sudo make install
. This will copy Teleport binaries into
/usr/local/bin
.
Then you can run Teleport as a single-node cluster:
$ sudo teleport start
In production, Teleport must run as root. But to play, just do chown $USER /var/lib/teleport
and run it under $USER
, in this case you will not be able to login as someone else though.
Building Teleport
Teleport source code consists of the actual Teleport daemon binary written in Golang, and also
it has a web UI (located in /web directory) written in Javascript. The WebUI is not changed often
and we keep it checked into Git under /dist
, so you only need to build Golang:
Make sure you have Golang v1.7
or newer, then run:
# getting & building:
$ go get github.com/gravitational/teleport
$ cd $GOPATH/src/github.com/gravitational/teleport
$ make
# create the default data directory before starting:
$ sudo mkdir -p /var/lib/teleport
$ sudo chown $USER /var/lib/teleport
If the build was successful the binaries will be in $GOPATH/src/github.com/gravitational/teleport/build
By default the web UI is not build into the binary, to run self-build teleport you have
to set the environment variable: DEBUG=1
, in debug mode the web UI will be loaded from
web/dist directory.
Then you can run Teleport as a single-node cluster in development mode:
$ DEBUG=1 build/teleport start -d
To build the binary with embedded web assets:
$ make release
$ build/teleport start -d
If you want to release your own Teleport version, edit this Makefile, update
VERSION
and SUFFIX
constants, then run make setver
to update version.go
If you want to cut another binary release tarball, run make release
.
NOTE: The Go compiler is somewhat sensitive to amount of memory: you will need at least 1GB of virtual memory to compile Teleport. 512MB instance without swap will not work.
Rebuilding Web UI
If you want to make changes to the web UI, you have to re-build the content of /dist
directory
See web/README.md for instructions on how to update the Web UI.
Why did We Build Teleport?
Mature tech companies with significant infrastructure footprints tend to implement most of these patterns internally. Teleport allows smaller companies without significant in-house SSH expertise to easily adopt them, as well. Teleport comes with an accessible Web UI and a very permissive Apache 2.0 license to facilitate adoption and use.
Being a complete standalone tool, Teleport can be used as a software library enabling trust management in complex multi-cluster, multi-region scenarios across many teams within multiple organizations.
More Information
Contributing
The best way to contribute is to create issues or pull requests right here on Github. You can also reach the Gravitational team through their website
Status
Teleport has completed a security audit from a nationally recognized technology security company. So we are comfortable with the use of Teleport from a security perspective.
However, Teleport is still a relatively young product so you may experience usability issues. We are actively supporting Teleport and addressing any issues that are submitted to this repo. Ask questions, send pull requests, report issues and don't be shy! :)
The latest stable Teleport build can be found in Releases
Known Issues
- Teleport does not officially support IPv6 yet.
Who Built Teleport?
Teleport was created by Gravitational Inc. We have built Teleport by borrowing from our previous experiences at Rackspace. It has been extracted from Gravity, our system for helping our clients to deploy and remotely manage their SaaS applications on many cloud regions or even on-premise.
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 ( // Component indicates a component of teleport, used for logging Component = "component" // ComponentFields stores component-specific fields ComponentFields = "fields" // ComponentReverseTunnel is reverse tunnel agent and server // that together establish a bi-directional SSH revers tunnel // to bypass firewall restrictions ComponentReverseTunnel = "reversetunnel" // ComponentAuth is the cluster CA node (auth server API) ComponentAuth = "auth" // ComponentNode is SSH node (SSH server serving requests) ComponentNode = "node" // ComponentProxy is SSH proxy (SSH server forwarding connections) ComponentProxy = "proxy" // ComponentTunClient is a tunnel client ComponentTunClient = "tunclient" // DebugEnvVar tells tests to use verbose debug output DebugEnvVar = "DEBUG" // VerboseLogEnvVar forces all logs to be verbose (down to DEBUG level) VerboseLogsEnvVar = "TELEPORT_DEBUG" // 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" // ConnectorOIDC means connector type OIDC ConnectorOIDC = "oidc" // DataDirParameterName is the name of the data dir configuration parameter passed // to all backends during initialization DataDirParameterName = "data_dir" // SSH request type to keep the connection alive. A client and a server keep // pining each other with it: KeepAliveReqType = "keepalive@openssh.com" // OTP means One-time Password Algorithm for Two-Factor Authentication. OTP = "otp" // TOTP means Time-based One-time Password Algorithm. for Two-Factor Authentication. TOTP = "totp" // HOTP means HMAC-based One-time Password Algorithm.for Two-Factor Authentication. HOTP = "hotp" // U2F means Universal 2nd Factor.for Two-Factor Authentication. U2F = "u2f" // OFF means no second factor.for Two-Factor Authentication. OFF = "off" // Local means authentication will happen locally within the Teleport cluster. Local = "local" // OIDC means authentication will happen remotly using an OIDC connector. OIDC = "oidc" )
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 ( // 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" )
const ContextUser = "teleport-user"
ContextUser is a user set in the context of the request
const ForeverTTL time.Duration = 0
ForeverTTL means that object TTL will not expire unless deleted
const (
Version = "2.0.1"
)
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
Functions ¶
This section is empty.
Types ¶
type BuiltinRole ¶
type BuiltinRole struct { // Role is the builtin role this username is associated with Role Role }
BuiltinRole is monitoring
type LocalUser ¶
type LocalUser struct { // Username is local username Username string }
LocalUsername is a local username
type RemoteUser ¶
type RemoteUser struct { // Username is a name of the remote user Username string `json:"username"` // ClusterName is a name of the remote cluster // of the user ClusterName string `json:"cluster_name"` }
RemoteUser defines encoded remote user
type Role ¶ added in v1.0.0
type Role string
Role identifies the role of an SSH connection. Unlike "user roles" introduced as part of RBAC in Teleport 1.4+ these are built-in roles used for different Teleport components when connecting to each other.
const ( // RoleAuth is for teleport auth server (authority, authentication and authorization) RoleAuth Role = "Auth" // RoleWeb is for web access users RoleWeb Role = "Web" // RoleNode is a role for SSH node in the cluster RoleNode Role = "Node" // RoleProxy is a role for SSH proxy in the cluster RoleProxy Role = "Proxy" // RoleAdmin is admin role RoleAdmin Role = "Admin" // RoleProvisionToken is a role for nodes authenticated using provisioning tokens RoleProvisionToken Role = "ProvisionToken" // RoleTrustedCluster is a role needed for tokens used to add trusted clusters. RoleTrustedCluster Role = "Trustedcluster" // RoleSignup is for first time signing up users RoleSignup Role = "Signup" // RoleNop is used for actions that already using external authz mechanisms // e.g. tokens or passwords RoleNop Role = "Nop" )
func (*Role) Check ¶ added in v1.0.0
Check checks if this a a valid role value, returns nil if it's ok, false otherwise
type Roles ¶ added in v1.0.0
type Roles []Role
func ParseRoles ¶ added in v1.0.0
ParseRoles takes a comma-separated list of roles and returns a slice of roles, or an error if parsing failed
func (Roles) Check ¶ added in v1.0.0
Check returns an error if the role set is incorrect (contains unknown roles)
Directories ¶
Path | Synopsis |
---|---|
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 |
lib
|
|
auth
Package auth implements certificate signing authority and access control server Authority server is composed of several parts: * Authority server itself that implements signing and acl logic * HTTP server wrapper for authority server * HTTP client wrapper Package auth implements certificate signing authority and access control server Authority server is composed of several parts: * Authority server itself that implements signing and acl logic * HTTP server wrapper for authority server * HTTP client wrapper
|
Package auth implements certificate signing authority and access control server Authority server is composed of several parts: * Authority server itself that implements signing and acl logic * HTTP server wrapper for authority server * HTTP client wrapper Package auth implements certificate signing authority and access control server Authority server is composed of several parts: * Authority server itself that implements signing and acl logic * HTTP server wrapper for authority server * HTTP client wrapper |
backend/boltbk
Package boltbk implements BoltDB backed backend for standalone instances This is a legacy backend which only exists for backward compatibility purposes Production Teleport clusters should be using either etcd or DynamoDB backends.
|
Package boltbk implements BoltDB backed backend for standalone instances This is a legacy backend which only exists for backward compatibility purposes Production Teleport clusters should be using either etcd or DynamoDB backends. |
backend/dir
Package 'dir' implements the "directory backend".
|
Package 'dir' implements the "directory backend". |
backend/dynamo
Package dynamodbDynamoDBBackend implements DynamoDB storage backend for Teleport auth service, similar to etcd backend.
|
Package dynamodbDynamoDBBackend 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/test
Package test contains a backend acceptance test suite that is backend implementation independant each backend will use the suite to test itself
|
Package test contains a backend acceptance test suite that is backend implementation independant each backend will use the suite to test itself |
config
Package 'config' provides facilities for configuring Teleport daemons including - parsing YAML configuration - parsing CLI flags
|
Package 'config' provides facilities for configuring Teleport daemons including - parsing YAML configuration - parsing CLI flags |
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 currently implements the audit log using a simple filesystem backend.
|
Package events currently implements the audit log using a simple filesystem backend. |
httplib
Package httplib implements common utility functions for writing classic HTTP handlers
|
Package httplib implements common utility functions for writing classic HTTP handlers |
limiter
Package limiter implements connection and rate limiters for teleport
|
Package limiter implements connection and rate limiters for teleport |
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. |
service
Package service implements teleport running service, takes care of initialization, cleanup and shutdown procedures Copyright 2015 Gravitational, Inc.
|
Package service implements teleport running service, takes care of initialization, cleanup and shutdown procedures Copyright 2015 Gravitational, Inc. |
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 bookeeping of SSH interactive sessions that happen in realtime across the teleport cluster
|
Package session is used for bookeeping of SSH interactive sessions that happen in realtime across the teleport cluster |
srv
Package srv implements SSH server that supports multiplexing tunneling, SSH connections proxying and only supports Key based auth
|
Package srv implements SSH server that supports multiplexing tunneling, SSH connections proxying and only supports Key based auth |
sshutils/scp
Package scp handles file uploads and downloads via scp command
|
Package scp handles file uploads and downloads via scp command |
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 |
tool
|
|