• Stars
    star
    17,127
  • Rank 1,607 (Top 0.04 %)
  • Language
    Go
  • License
    GNU Affero Genera...
  • Created over 9 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The easiest, and most secure way to access and protect all of your infrastructure.

Teleport provides connectivity, authentication, access controls and audit for infrastructure.

Here is why you might use Teleport:

  • Set up SSO for all of your cloud infrastructure [1].
  • Protect access to cloud and on-prem services using mTLS endpoints and short-lived certificates.
  • Establish tunnels to access services behind NATs and firewalls.
  • Provide an audit log with session recording and replay for various protocols.
  • Unify Role-Based Access Control (RBAC) and enforce the principle of least privilege with access requests.

[1] The open source version supports only GitHub SSO.

Teleport works with SSH, Kubernetes, databases, RDP, and web services.


Table of Contents

  1. Introduction
  2. Installing and Running
  3. Docker
  4. Building Teleport
  5. Why Did We Build Teleport?
  6. More Information
  7. Support and Contributing
  8. Is Teleport Secure and Production Ready?
  9. Who Built Teleport?

Introduction

Teleport includes an identity-aware access proxy, a CA that issues short-lived certificates, a unified access control system and a tunneling system to access resources behind the firewall.

We have implemented Teleport as a single Go binary that integrates with multiple protocols and cloud services:

You can set up Teleport as a Linux daemon or a Kubernetes deployment.

Teleport focuses on best practices for infrastructure security:

  • No need to manage shared secrets such as SSH keys or Kubernetes tokens: it uses certificate-based auth with certificate expiration for all protocols.
  • Two-factor authentication (2FA) for everything.
  • Collaboratively troubleshoot issues through session sharing.
  • Single sign-on (SSO) for everything via GitHub Auth, OpenID Connect, or SAML with endpoints like Okta or Active Directory.
  • Infrastructure introspection: Use Teleport via the CLI or Web UI to view the status of every SSH node, database instance, Kubernetes cluster, or internal web app.

Teleport uses Go crypto. It is fully compatible with OpenSSH, sshd servers, and ssh clients, Kubernetes clusters and more.

Project Links Description
Teleport Website The official website of the project.
Documentation Admin guide, user manual and more.
Blog Our blog where we publish Teleport news.
Forum Ask us a setup question, post your tutorial, feedback, or idea on our forum.
Slack Need help with your setup? Ping us in our Slack channel.
Cloud-hosted We offer Enterprise with a Cloud-hosted option. For teams that require easy and secure access to their computing environments.

Installing and Running

To set up a single-instance Teleport cluster, follow our getting started guide. You can then register your servers, Kubernetes clusters, and other infrastructure with your Teleport cluster.

You can also get started with Teleport Enterprise Cloud, a managed Teleport deployment that makes it easier to enable secure access to your infrastructure.

Sign up for a free trial of Teleport Enterprise Cloud.

Follow our guide to registering your first server with Teleport Enterprise Cloud.

Docker

Deploy Teleport

If you wish to deploy Teleport inside a Docker container see the installation guide.

For Local Testing and Development

Follow the instructions in the docker/README file.

To run a full test suite locally, see the test dependencies list

Building Teleport

The teleport repository contains the Teleport daemon binary (written in Go) and a web UI written in Javascript (a git submodule located in the webassets/ directory).

If your intention is to build and deploy for use in a production infrastructure a released tag should be used. The default branch, master, is the current development branch for an upcoming major version. Get the latest release tags listed at https://goteleport.com/download/ and then use that tag in the git clone. For example git clone https://github.com/gravitational/teleport.git -b v16.0.0 gets release v16.0.0.

Dockerized Build

It is often easiest to build with Docker, which ensures that all required tooling is available for the build. To execute a dockerized build, ensure that docker is installed and running, and execute:

make -C build.assets build-binaries

Local Build

Dependencies

Ensure you have installed correct versions of necessary dependencies:

  • Go version from go.mod
  • If you wish to build the Rust-powered features like Desktop Access, see the Rust and Cargo versions in build.assets/Makefile (search for RUST_VERSION)
  • For tsh version > 10.x with FIDO support, you will need libfido and openssl 1.1 installed locally
  • To build the web UI:
    • yarn(< 2.0.0) is required.
    • If you prefer not to install/use yarn, but have docker available, you can run make docker-ui instead.
    • The Rust and Cargo version in build.assets/Makefile (search for RUST_VERSION) are required.
    • The wasm-pack version in build.assets/Makefile (search for WASM_PACK_VERSION) is required.
    • binaryen (which contains wasm-opt) is required to be installed manually on linux aarch64 (64-bit ARM). You can check if it's already installed on your system by running which wasm-opt. If not you can install it like apt-get install binaryen (for Debian-based Linux). wasm-pack will install this automatically on other platforms.

For an example of Dev Environment setup on a Mac, see these instructions.

Perform a build

Important

  • The Go compiler is somewhat sensitive to the amount of memory: you will need at least 1GB of virtual memory to compile Teleport. A 512MB instance without swap will not work.
  • This will build the latest version of Teleport, regardless of whether it is stable. If you want to build the latest stable release, run git checkout and git submodule update --recursive to the corresponding tag (for example,
  • run git checkout v8.0.0) before performing a build.

Get the source

git clone https://github.com/gravitational/teleport.git
cd teleport

To perform a build

make full

To build tsh with Apple TouchID support enabled:

Important

tsh binaries with Touch ID support are only functional using binaries signed with Teleport's Apple Developer ID and notarized by Apple. If you are a Teleport maintainer, ask the team for access.

make build/tsh TOUCHID=yes

To build tsh with libfido:

make build/tsh FIDO2=dynamic
  • On a Mac, with libfido and openssl 3 installed via homebrew

    export PKG_CONFIG_PATH="$(brew --prefix openssl@3)/lib/pkgconfig"
    make build/tsh FIDO2=dynamic

Build output and run locally

If the build succeeds, the installer will place the binaries in the build directory.

Before starting, create default data directories:

sudo mkdir -p -m0700 /var/lib/teleport
sudo chown $USER /var/lib/teleport

Running Teleport in a hot reload mode

To speed up your development process, you can run Teleport using CompileDaemon. This will build and run the Teleport binary, and then rebuild and restart it whenever any Go source files change.

  1. Install CompileDaemon:

    go install github.com/githubnemo/CompileDaemon@latest

    Note that we use go install instead of the suggested go get, because we don't want CompileDaemon to become a dependency of the project.

  2. Build and run the Teleport binary:

    make teleport-hot-reload

    By default, this runs a teleport start command. If you want to customize the command, for example by providing a custom config file location, you can use the TELEPORT_ARGS parameter:

    make teleport-hot-reload TELEPORT_ARGS='start --config=/path/to/config.yaml'

Note that you still need to run make grpc if you modify any Protocol Buffers files to regenerate the generated Go sources; regenerating these sources should in turn cause the CompileDaemon to rebuild and restart Teleport.

Web UI

The Teleport Web UI resides in the web directory.

Rebuilding Web UI for development

To rebuild the Teleport UI package, run the following command:

make docker-ui

Then you can replace Teleport Web UI files with the files from the newly-generated /dist folder.

To enable speedy iterations on the Web UI, you can run a local web-dev server.

You can also tell Teleport to load the Web UI assets from the source directory. To enable this behavior, set the environment variable DEBUG=1 and rebuild with the default target:

# Run Teleport as a single-node cluster in development mode:
DEBUG=1 ./build/teleport start -d

Keep the server running in this mode, and make your UI changes in /dist directory. For instructions about how to update the Web UI, read the web README.

Managing dependencies

All dependencies are managed using Go modules. Here are the instructions for some common tasks:

Add a new dependency

Latest version:

go get github.com/new/dependency

and update the source to use this dependency.

To get a specific version, use go get github.com/new/dependency@version instead.

Set dependency to a specific version

go get github.com/new/dependency@version

Update dependency to the latest version

go get -u github.com/new/dependency

Update all dependencies

go get -u all

Debugging dependencies

Why is a specific package imported?

go mod why $pkgname

Why is a specific module imported?

go mod why -m $modname

Why is a specific version of a module imported?

go mod graph | grep $modname

Devbox Build (experimental)

Note: Devbox support is still experimental. It's very possible things may not work as intended.

Teleport can be built using devbox. To use devbox, follow the instructions to install devbox here and then run:

devbox shell

This will install Teleport's various build dependencies and drop you into a shell with these dependencies. From here, you can build Teleport normally.

flake.nix

A nix flake is located in build.assets/flake that allows for installation of Teleport's less common build tooling. If this flake is updated, run:

devbox install

in order to make sure the changes in the flake are reflected in the local devbox shell.

Why did We Build Teleport?

The Teleport creators used to work together at Rackspace. We noticed that most cloud computing users struggle with setting up and configuring infrastructure security because popular tools, while flexible, are complex to understand and expensive to maintain. Additionally, most organizations use multiple infrastructure form factors such as several cloud providers, multiple cloud accounts, servers in colocation, and even smart devices. Some of those devices run on untrusted networks, behind third-party firewalls. This only magnifies complexity and increases operational overhead.

We had a choice, either start a security consulting business or build a solution that's dead-easy to use and understand. A real-time representation of all of your servers in the same room as you, as if they were magically teleported. Thus, Teleport was born!

More Information

Support and Contributing

We offer a few different options for support. First of all, we try to provide clear and comprehensive documentation. The docs are also in GitHub, so feel free to create a PR or file an issue if you have ideas for improvements. If you still have questions after reviewing our docs, you can also:

  • Join Teleport Discussions to ask questions. Our engineers are available there to help you.
  • If you want to contribute to Teleport or file a bug report/issue, you can create an issue here in GitHub.
  • If you are interested in Teleport Enterprise or more responsive support during a POC, we can also create a dedicated Slack channel for you during your POC. You can reach out to us through our website to arrange for a POC.

Is Teleport Secure and Production-Ready?

Yes -- Teleport is production-ready and designed to protect and facilitate access to the most precious and mission-critical applications.

Teleport has completed several security audits from nationally and internationally recognized technology security companies.

We publicize some of our audit results, security philosophy and related information on our trust page.

You can see the list of companies that use Teleport in production on the Teleport product page.

Who Built Teleport?

Teleport was created by Gravitational, Inc.. We have built Teleport by borrowing from our previous experiences at Rackspace. Learn more about Teleport and our history.

More Repositories

1

teleconsole

Command line tool to share your UNIX terminal and forward local TCP ports to people you trust.
Go
2,780
star
2

workshop

Docker, Kubernetes and Gravity Trainings by Gravitational
Go
2,025
star
3

gravity

Kubernetes application deployments for restricted, regulated, or remote environments
Go
1,082
star
4

wormhole

Wireguard based overlay network CNI plugin for kubernetes
Go
517
star
5

satellite

Simple and extensible monitoring agent / library for Kubernetes: https://gravitational.com/blog/monitoring_kubernetes_satellite/
Go
198
star
6

cve-2018-1002105

Test utility for cve-2018-1002105
Go
195
star
7

teleport-plugins

Set of plugins for Teleport
HTML
83
star
8

careers

Apply at https://jobs.lever.co/teleport
TeX
83
star
9

trace

Package for error handling and error reporting
Go
66
star
10

planet

Installable Kubernetes delivered in containers
Go
51
star
11

webapps

Mono-repository of Gravitational Web Applications
TypeScript
46
star
12

configure

Configure is a golang library that populates a struct from environment variables, command line arugments and YAML files.
Go
45
star
13

rigging

Kubernetes resources change management
Go
40
star
14

monitoring-app

Gravity application that provides a Kapacitor/Alertmanager/Grafana based monitoring system.
Go
34
star
15

force

A new programming language for cloud native workflows
Go
31
star
16

rbac-linter

Python
28
star
17

teleport-cluster-terraform

Archived - see the Terraform in gravitational/teleport instead
HCL
23
star
18

console-demo

Simplest possible implementation of web-based terminal for Golang backend
JavaScript
23
star
19

protoc-gen-terraform

Generates Terraform provider schemas and unmarshallers from protobuf definitions
Go
16
star
20

version

version is a library that automates the task of adding build version information to any Go package
Go
16
star
21

udpbeat

ELK beat that collects the structured inputs via UDP and emits them to ELK
Go
15
star
22

stolon-app

Opinionated stolon gravity/kubernetes app.
Go
13
star
23

kube2sky

A bridge between Kubernetes and SkyDNS.
Go
13
star
24

sync-controller

Controller that synchronizes Kubernetes custom resources between clusters
Go
12
star
25

roundtrip

Library for HTTP request/response workflow
Go
12
star
26

logging-app

This gravity app provides an rsyslog-based log collection system to gravity sites.
Go
12
star
27

robotest

Automated provisioning and install testing
Go
11
star
28

docs

Source code backing goteleport.com/docs
TypeScript
11
star
29

next

Doc and website engine using next
TypeScript
11
star
30

etcd-backup

For handling backup/restore of etcd database from userspace
Go
9
star
31

jenkins-pipelines

Go
9
star
32

provisioner

[DEPRECATED] Terraform based provisioners for ops center
Go
7
star
33

bandwagon

Sample custom post-installation application for Gravity
JavaScript
7
star
34

teleport-agent-terraform

Terraform module which sets up a Teleport agent in AWS
HCL
7
star
35

terraform-gravity

Public terraform scripts for deploying Gravity
HCL
6
star
36

keygen

OSS tool for easy SSH key generation
Go
6
star
37

license

CA and licensing tools
Go
6
star
38

docker-debian

Customized Debian Docker images
Shell
6
star
39

gha-exporter

GitHub Actions metrics exporter for Prometheus
Go
6
star
40

protobuf-as

Protobuf AssemblyScript compiler
WebAssembly
5
star
41

slackbot

Gravitational support bot
Go
5
star
42

mm

Auto discovery and export Prometheus metrics into InfluxDB
Go
5
star
43

licensinator

Python
4
star
44

gamma

An open source tool to compile a monorepo of GitHub actions into individual repos
Go
4
star
45

webassets

HTML
4
star
46

healthz

Version of SkyDNS healthz that is simply Go
Go
4
star
47

cloud-native-hackathon

Teleport Challenge
4
star
48

quickstart

Getting started with Gravity. Sample application
HCL
4
star
49

shared-workflows

GitHub Actions shared within the organization
Go
3
star
50

docker-ubuntu

Customized Ubuntu Docker images
Shell
3
star
51

fakeiot

Fake IOT test cluster used for Full Stack Coding challenge
Go
3
star
52

predicate-lang

Predicate - Access Control System
3
star
53

pithos-app

Pithos object store for Kubernetes + Gravity
Go
3
star
54

storage-app

Gravity system application that provides OpenEBS-based persistent storage for clusters
Makefile
3
star
55

coordinate

Set of utilities for ETCD and BoltDB
Go
3
star
56

reporting

gRPC based client/server usage reporting module
Go
2
star
57

httplib

HTTP Library utils
Go
2
star
58

oom

Reproduce problems with missing backpressure when using grpc ServeHTTP and a solution
Go
2
star
59

selinux

SELinux support for Gravity
Shell
2
star
60

cluster-ssl-app

cluster ssl system application
Shell
2
star
61

form

Package for handling HTTP web forms input
Go
2
star
62

session

Secure session IDs encrypted by lemma
Go
2
star
63

log

backport of logging facility we are using for compatibility purposes
Go
2
star
64

hackernews-challenge

Frontend Developer Challenge
2
star
65

it-onboarding

IT Onboarding
1
star
66

teleport-actions

Mono-repository of GitHub Actions for Teleport
1
star
67

.github

Teleport GitHub Organization Repository
1
star
68

aws-teleport-workshop

Teleport AWS Workshop
1
star
69

lf

LF is a on disk log format key value data store. Never use it anywhere
1
star
70

downtime

TypeScript
1
star
71

hello

Tiny web app skeleton to show the basic Gravitational project structure and development workflow
Go
1
star
72

aws-ecr-helper

Amazon ECR Credential Helper for kubernetes cronjobs
Go
1
star
73

challenge-user-management

User Management Coding Challenge
CSS
1
star
74

django-app

Gravity django-app
Go
1
star
75

gh-actions-poc

Go
1
star
76

ingress-app

Ingress App
Mustache
1
star
77

robotest-triage

Tools for triaging bulk Robotest runs
Python
1
star
78

magnet

Experimental library for working with mage as a build system
Go
1
star
79

patroni-app

Gravity application that provides installation of Patroni(a template for PostgreSQL HA)
HTML
1
star
80

godl

Go
1
star
81

packer-manifests

This repository contains manifests for Hashicorp Packer
Shell
1
star
82

teleport-github-actions-provisioning

An example of using Teleport Machine ID with Github Actions
HCL
1
star
83

sw

Star Wars Frontend Challenge
CSS
1
star
84

it-prod-public-test

a testing repo
1
star
85

influxdata-webinar

Files for Influxdata Webinar
JavaScript
1
star
86

test-it-public-repo

Testing repo
1
star
87

tpl

Render static text template from a configuration file
Go
1
star