Find a file
alexlyulkov 0164e3866c Merge pull request #51 from gravitational/alex/heartbeat
Added hostname to presence service(Now auth knows hostname of each node)
2015-11-05 12:25:45 -08:00
assets add license to JSX and JS files too 2015-10-31 13:10:42 -07:00
docs update the docs 2015-10-31 14:42:07 -07:00
examples update the docs 2015-10-31 14:42:07 -07:00
fixtures/keys Initial working prototype 2015-03-14 14:35:43 -07:00
Godeps re-vendor deps that had licensing applied too 2015-10-31 12:56:31 -07:00
lib Fixed proxy known servers filtering, fixed srv Shell test 2015-11-05 12:20:44 -08:00
tool Added hostname to presence service(Now auth knows hostname of each node) 2015-11-04 21:02:58 -08:00
.gitignore Added 2 factor hotp authentication, everyting works 2015-10-23 13:34:09 -07:00
errors.go Apply apache license to teleport 2015-10-31 11:56:49 -07:00
LICENSE Apply apache license to teleport 2015-10-31 11:56:49 -07:00
Makefile some changes to readme 2015-10-28 18:10:09 -07:00
mkdocs.yml User manual and API reference 2015-05-13 21:37:25 -07:00
README.md Update README.md 2015-10-31 14:43:52 -07:00
shippable.yaml Implement web proxying, and web SSH console proof of concept 2015-04-01 21:21:07 -07:00

Teleport

Teleport is a SSH infrastructure for clusters of Linux servers. Teleport extends traditional SSH with the following capabilities:

  • Provides coordinated and secure access to multiple Linux clusters by multiple teams with different permissions.
  • Enforces cluster-specific security policies.
  • Includes session record/replay and keeps audit logs.

It also contains a few nice conveniences like built-in command multiplexing, web-based administration and more. Teleport is a standalone executable.

Teleport uses Etcd in HA mode or Boltdb in standalone mode.

Status

Teleport is not ready to be used in production yet

We are currently fixing outstanding security issues, and working on hardening.

Design document

Take a look at Teleport design document

Developer Docs

Take a look at Developer API

Overview

Overview

Teleport system consists of several independent parts that can be set up in various combinations:

Teleport Auth

Auth server acts as Authentication and Authorization server, SSH host and user certificate authority, stores audit logs and access records and is the only stateful component in the system.

Note Read more about SSH authorities in this intro article Note Auth server does not itself provide any support for interactive sessions and remote command execution

Teleport SSH

Teleport SSH server is a simple stateless server written in Go that only supports SSH user certificates as authentication method, generates structured events and supports interactive collaborative sessions.

Teleport Proxy

Teleport Proxy is a stateless SSH proxy that implements 2-factor web authentication and proxies traffic to the remote SSH nodes.

Installation

Teleport is open source, however it and should be cloned from the repository.

Prerequisites

  • go >= 1.4.2
  • etcd >= v2.0.10 (in case of HA mode)

Clone the latest master

mkdir -p $(GOPATH)/src/github/gravitational
cd $(GOPATH)/src/github/gravitational
git clone git@github.com:gravitational/teleport.git

Compile

make install

This should install teleport and tctl binaries, check that the binaries are installed.

ls ${GOPATH}/bin/tctl ${GOPATH}/bin/teleport

Quickstart

# create the directory where auth server will keep it's local state
mkdir -p /var/lib/teleport
# make sure it is not owned by root
chown <<USER>>:<<GROUP>> /var/lib/teleport

# start teleport in embedded mode
make run-embedded

Note: run-embedded executes teleport with configuration file in examples/embedded.yaml check it out for more details

Web access via proxy

Teleport allows to access the cluster via web portal. The web portal is guarded by 2-factor authentication. Here's how to log in:

  • Create a user entry for yourself:
tctl user set-pass --user=<user> --pass=<pass>

Important: Username and password are not enough to log in into teleport, for second factor it uses HOTP tokens. Tool generated QR code for you too, and placed it in the current working directory. Follow next steps to set up your phone to use QR key:

  • Set up Google Authenticator app on your phone (available for free for Android and iPhone)

Check out QR.png file that was written to the local directory and scan QR code. Follow next step to login:

Note: If you failed to log in for the first time, try to refresh the token. Teleport will try to sync up your phone and token on the next attempt.

SSH access via proxy

This is still in progress, should be merged soon. Follow the progress here:

https://github.com/gravitational/teleport/compare/alex/ssh-agent