Skip to content

Latest commit

 

History

History
204 lines (145 loc) · 6.38 KB

README.md

File metadata and controls

204 lines (145 loc) · 6.38 KB
Raw

Teleport Mattermost Plugin

This package provides Teleport <-> Mattermost integrataion that allows teams to get notified about new access requests in Mattermost.

Setup

See setup instructions on Teleport's website

Prerequisites

This guide assumes that you have:

  • Teleport 6.1.0 or newer
  • Admin privileges with access to tctl
  • Mattermost account with admin privileges.

Setting up a sandbox Mattermost instance for testing

If you want to build the plugin and test it with Mattermost, the easiest way to get Mattermost running is with the docker image:

docker run --name mattermost-preview -d --publish 8065:8065 --add-host dockerhost:127.0.0.1 mattermost/mattermost-preview

Check out more documentation on running Mattermost.

Setting up Mattermost to work with the plugin

In Mattermost, go to System Console -> Integrations -> Enable Bot Account Creation -> Set to True. This will allow us to create a new bot account that the Teleport plugin will use.

Go back to your team, then Integrations -> Bot Accounts -> Add Bot Account.

The new bot account will need Post All permission.

The confirmation screen after you've created the bot will give you the access token. We'll use this in the config later.

Create an access-plugin role and user within Teleport

First off, using an existing Teleport Cluster, we are going to create a new Teleport User and Role to access Teleport.

Create User and Role for access.

Log into Teleport Authentication Server, this is where you normally run tctl. Don't change the username and the role name, it should be access-plugin for the plugin to work correctly.

$ cat > rscs.yaml <<EOF
kind: user
metadata:
  name: access-plugin
spec:
  roles: ['access-plugin']
version: v2
---
kind: role
metadata:
  name: access-plugin
spec:
  allow:
    rules:
      - resources: ['access_request']
        verbs: ['list', 'read']
      - resources: ['access_plugin_data']
        verbs: ['update']
    # teleport currently refuses to issue certs for a user with 0 logins,
    # this restriction may be lifted in future versions.
    logins: ['access-plugin']
version: v3
EOF

# ...
$ tctl create -f rscs.yaml

Export access-plugin Certificate

Teleport Plugin uses the access-plugin role and user to peform the approval. We export the identify files, using tctl auth sign.

$ tctl auth sign --format=tls --user=access-plugin --out=auth --ttl=8760h
# ...

The above sequence should result in three PEM encoded files being generated: auth.crt, auth.key, and auth.cas (certificate, private key, and CA certs respectively). We'll reference these later in the bot config, and move them to an appropriate directory.

Note: by default, tctl auth sign produces certificates with a relatively short lifetime. For production deployments, the --ttl flag can be used to ensure a more practical certificate lifetime. --ttl=8760h exports a 1 year token

Export access-plugin Certificate for use with Teleport Cloud

Connection to Teleport Cloud is only possible with reverse tunnel. For this reason, we need the identity signed in a different format called file which exports SSH keys too.

$ tctl auth sign --auth-server=yourproxy.teleport.sh:443 --format=file --user=access-plugin --out=auth --ttl=8760h
# ...

Downloading and installing the plugin

[See our Mattermost plugin docs for download links.

Building from source

# Checkout teleport-plugins
git clone [email protected]:gravitational/teleport-plugins.git
cd teleport-plugins

cd access/mattermost
make

Configuring Mattermost Plugin

Mattermost Plugin uses a config file in TOML format. Generate a boilerplate config by running the following command:

teleport-mattermost configure > /etc/teleport-mattermost.yml

Then, edit the config as needed.

# example mattermost configuration TOML file
[teleport]
addr = "example.com:3025" # Teleport Auth Server GRPC API address
client_key = "/var/lib/teleport/plugins/mattermost/auth.key" # Teleport GRPC client secret key
client_crt = "/var/lib/teleport/plugins/mattermost/auth.crt" # Teleport GRPC client certificate
root_cas = "/var/lib/teleport/plugins/mattermost/auth.cas"   # Teleport cluster CA certs

[mattermost]
url = "https://mattermost.example.com" # Mattermost Server URL
token = "api-token"                    # Mattermost Bot OAuth token

[log]
output = "stderr" # Logger output. Could be "stdout", "stderr" or "/var/lib/teleport/mattermost.log"
severity = "INFO" # Logger severity. Could be "INFO", "ERROR", "DEBUG" or "WARN".

To use with Teleport Cloud, you should set a path to identity file exported with --format=file option.

[teleport]
addr = "yourproxy.teleport.sh:443"                     # Teleport proxy address
identity = "/var/lib/teleport/plugins/mattermost/auth" # Teleport identity file

Running the plugin

With the config above, you should be able to run the bot invoking teleport-mattermost start

The Workflow

Create an access request

You can create an access request using Web UI going to https://your-proxy.example.com/web/requests/new where your-proxy.example.com is your Teleport Proxy public address. There you should specify the reviewers whose usernames must match the emails of Mattermost users which you want to be notified. Check that you see a request message on Mattermost.

It should look like this: %image%

Review the request

Open the Link in message and choose to either approve or deny the request. The messages should automatically get updated to reflect the action you just did.

Teleport OSS edition

Currently, Teleport OSS edition does not have an "Access Requests" page at Web UI. Alternatively, you can create an access request using tsh:

tsh request create --roles=foo [email protected]

98afcb7d-9c6d-4a8f-8a03-9124fbbcb059

Note: There must be a user with an email [email protected] registered in your Mattermost team.

To approve or deny the request:

tsh request review --approve 98afcb7d-9c6d-4a8f-8a03-9124fbbcb059
tsh request review --deny 98afcb7d-9c6d-4a8f-8a03-9124fbbcb059