Teleport 13 Test Plan

[r0mant]

Manual Testing Plan

Below are the items that should be manually tested with each release of Teleport. These tests should be run on both a fresh installation of the version to be released as well as an upgrade of the previous version of Teleport.

• [x] Adding nodes to a cluster @atburke

  • [x] Adding Nodes via Valid Static Token
  • [x] Adding Nodes via Valid Short-lived Tokens
  • [x] Adding Nodes via Invalid Token Fails
  • [x] Revoking Node Invitation

• [x] Labels @lxea

  • [x] Static Labels
  • [x] Dynamic Labels

• [x] Trusted Clusters @EdwardDowling

  • [x] Adding Trusted Cluster Valid Static Token
  • [x] Adding Trusted Cluster Valid Short-lived Token
  • [x] Adding Trusted Cluster Invalid Token
  • [x] Removing Trusted Cluster
  • [x] Changing role map of existing Trusted Cluster

• [x] RBAC @nklaassen

  Make sure that invalid and valid attempts are reflected in audit log. Do this with both Teleport and Agentless nodes.

  • [x] Successfully connect to node with correct role
  • [x] Unsuccessfully connect to a node in a role restricting access by label
  • [x] Unsuccessfully connect to a node in a role restricting access by invalid SSH login
  • [x] Allow/deny role option: SSH agent forwarding
  • [x] Allow/deny role option: Port forwarding
  • [x] Allow/deny role option: SSH file copying (found bug #24949)

• [x] Verify that custom PAM environment variables are available as expected. @nklaassen

• [x] Users @codingllama

  With every user combination, try to login and signup with invalid second factor, invalid password to see how the system reacts.

  WebAuthn in the release tsh binary is implemented using libfido2 for linux/macOS. Ask for a statically built pre-release binary for realistic tests. (tsh fido2 diag should work in our binary.) Webauthn in Windows build is implemented using webauthn.dll. (tsh webauthn diag with security key selected in dialog should work.)

  Touch ID requires a signed tsh, ask for a signed pre-release binary so you may run the tests.

  Windows Webauthn requires Windows 10 19H1 and device capable of Windows Hello.

  • [x] Adding Users Password Only
  • [x] Adding Users OTP
  • [x] Adding Users WebAuthn
  • [x] macOS/Linux
  • [x] Windows
  • [x] Adding Users via platform authenticator
  • [x] Touch ID
  • [x] Windows Hello
  • [x] Managing MFA devices
  • [x] Add an OTP device with tsh mfa add
  • [x] Add a WebAuthn device with tsh mfa add
    • [x] macOS/Linux
    • [x] Windows
  • [x] Add platform authenticator device with tsh mfa add
    • [x] Touch ID
    • [x] Windows Hello
  • [x] List MFA devices with tsh mfa ls
  • [x] Remove an OTP device with tsh mfa rm
  • [x] Remove a WebAuthn device with tsh mfa rm
  • [x] Attempt removing the last MFA device on the user
    • [x] with second_factor: on in auth_service, should fail
    • [x] with second_factor: optional in auth_service, should succeed
  • [x] Login Password Only
  • [x] Login with MFA
  • [x] Add an OTP, a WebAuthn and a Touch ID/Windows Hello device with tsh mfa add
  • [x] Login via OTP
  • [x] Login via WebAuthn
    • [x] macOS/Linux
    • [x] Windows
  • [x] Login via platform authenticator
    • [x] Touch ID
    • [x] Windows Hello
  • [x] Login via WebAuthn using an U2F device

  U2F devices must be registered in a previous version of Teleport.

  Using Teleport v9, set auth_service.authentication.second_factor = u2f, restart the server and then register an U2F device (tsh mfa add). Upgrade the installation to the current Teleport version (one major at a time) and try to log in using the U2F device as your second factor - it should work.

  • [x] Login OIDC
  • [x] Login SAML
  • [x] Login GitHub
  • [x] Deleting Users

• [x] Backends @timothyb89

  • [x] Teleport runs with etcd
  • [x] Teleport runs with dynamodb
  • [x] Teleport runs with SQLite
  • [x] Teleport runs with Firestore

• [x] Session Recording @Joerger

  • [x] Session recording can be disabled
  • [x] Sessions can be recorded at the node
  • [x] Sessions in remote clusters are recorded in remote clusters
  • [x] Sessions can be recorded at the proxy
  • [x] Sessions on remote clusters are recorded in the local cluster
  • [x] With an OpenSSH server without a Teleport CA signed host certificate
    • [x] Host key checking enabled rejects connection
    • [x] Host key checking disabled allows connection

• [x] Enhanced Session Recording @Joerger

  • [x] disk, command and network events are being logged.
  • [x] Recorded events can be enforced by the enhanced_recording role option.
  • [x] Enhanced session recording can be enabled on CentOS 7 with kernel 5.8+.

• [x] Restricted Session @Joerger

  • [x] Network request are allowed when a policy allow them.
  • [x] Network request are blocked when a policy deny them.

• [x] Audit Log @atburke

  • [x] Failed login attempts are recorded
  • [x] Interactive sessions have the correct Server ID
  • [x] server_id is the ID of the node in "session_recording: node" mode
  • [x] server_id is the ID of the node in "session_recording: proxy" mode
  • [x] forwarded_by is the ID of the proxy in "session_recording: proxy" mode

  Node/Proxy ID may be found at /var/lib/teleport/host_uuid in the corresponding machine.

  Node IDs may also be queried via tctl nodes ls.

  • [x] Exec commands are recorded
  • [x] scp commands are recorded
  • [x] Subsystem results are recorded

  Subsystem testing may be achieved using both Recording Proxy mode and OpenSSH integration.

  Assuming the proxy is proxy.example.com:3023 and node1 is a node running OpenSSH/sshd, you may use the following command to trigger a subsystem audit log:

  sftp -o "ProxyCommand ssh -o 'ForwardAgent yes' -p 3023 %r@proxy.example.com -s proxy:%h:%p" root@node1

• [x] Interact with a cluster using tsh @capnspacehook

  These commands should ideally be tested for recording and non-recording modes as they are implemented in a different ways.

  • [x] tsh ssh \<regular-node>
  • [x] tsh ssh \<node-remote-cluster>
  • [x] tsh ssh \<agentless-node>
  • [x] tsh ssh \<agentless-node-remote-cluster>
  • [x] tsh ssh -A \<regular-node>
  • [x] tsh ssh -A \<node-remote-cluster>
  • [x] tsh ssh -A \<agentless-node>
  • [x] tsh ssh -A \<agentless-node-remote-cluster>
  • [x] tsh ssh \<regular-node> ls
  • [x] tsh ssh \<node-remote-cluster> ls
  • [x] tsh ssh \<agentless-node> ls
  • [x] tsh ssh \<agentless-node-remote-cluster> ls
  • [x] tsh join \<regular-node>
  • [x] tsh join \<node-remote-cluster>
  • [x] tsh join \<agentless-node>
  • [x] tsh join \<agentless-node-remote-cluster>
  • [x] tsh play \<regular-node>
  • [x] tsh play \<node-remote-cluster>
  • [x] tsh play \<agentless-node>
  • [x] tsh play \<agentless-node-remote-cluster>
  • [x] tsh scp \<regular-node>
  • [x] tsh scp \<node-remote-cluster>
  • [x] tsh scp \<agentless-node>
  • [x] tsh scp \<agentless-node-remote-cluster>
  • [x] tsh ssh -L \<regular-node>
  • [x] tsh ssh -L \<node-remote-cluster>
  • [x] tsh ssh -L \<agentless-node>
  • [x] tsh ssh -L \<agentless-node-remote-cluster>
  • [x] tsh ls
  • [x] tsh clusters

• [x] Interact with a cluster using ssh @capnspacehook Make sure to test both recording and regular proxy modes.

  • [x] ssh \<regular-node>
  • [x] ssh \<node-remote-cluster>
  • [x] ssh \<agentless-node>
  • [x] ssh \<agentless-node-remote-cluster>
  • [x] ssh -A \<regular-node>
  • [x] ssh -A \<node-remote-cluster>
  • [x] ssh -A \<agentless-node>
  • [x] ssh -A \<agentless-node-remote-cluster>
  • [x] ssh \<regular-node> ls
  • [x] ssh \<node-remote-cluster> ls
  • [x] ssh \<agentless-node> ls
  • [x] ssh \<agentless-node-remote-cluster> ls
  • [x] scp \<regular-node>
  • [x] scp \<node-remote-cluster>
  • [x] scp \<agentless-node>
  • [x] scp \<agentless-node-remote-cluster>
  • [x] ssh -L \<regular-node>
  • [x] ssh -L \<node-remote-cluster>
  • [x] ssh -L \<agentless-node>
  • [x] ssh -L \<agentless-node-remote-cluster>

• [x] Verify proxy jump functionality @Joerger Log into leaf cluster via root, shut down the root proxy and verify proxy jump works.

  • [x] tls routing disabled
  • [x] tsh ssh -J \<leaf.proxy.example.com:3023>
  • [x] ssh -J \<leaf.proxy.example.com:3023>
  • [x] tls routing enabled
  • [x] tsh ssh -J \<leaf.proxy.example.com:3080>
  • [x] tsh proxy ssh -J \<leaf.proxy.example.com:3080>

• [x] Interact with a cluster using the Web UI @EdwardDowling

  • [x] Connect to a Teleport node
  • [x] Connect to a OpenSSH node
  • [x] Connect to a Agentless node
  • [x] Check agent forwarding is correct based on role and proxy mode.

• [x] tsh CA loading @atburke

  Create a trusted cluster pair with a node in the leaf cluster. Log into the root cluster.

  • [x] load_all_cas on the root auth server is false (default) - tsh ssh leaf.node.example.com results in access denied.
  • [x] load_all_cas on the root auth server is true - tsh ssh leaf.node.example.com succeeds.

• [x] X11 Forwarding @Joerger

  • Install xeyes and xclip:
  • Linux: apt install x11-apps xclip
  • Mac: Install and launch XQuartz which comes with xeyes. Then brew install xclip.
  • Enable X11 forwarding for a Node running as root: ssh_service.x11.enabled = yes
  • [x] Successfully X11 forward as both root and non-root user
  • [x] tsh ssh -X user@node xeyes
  • [x] tsh ssh -X root@node xeyes
  • [x] Test untrusted vs trusted forwarding
  • [x] tsh ssh -Y server01 "echo Hello World | xclip -sel c && xclip -sel c -o" should print "Hello World"
  • [x] tsh ssh -X server01 "echo Hello World | xclip -sel c && xclip -sel c -o" should fail with "BadAccess" X error

User accounting @atburke

• [x] Verify that active interactive sessions are tracked in /var/run/utmp on Linux.
• [x] Verify that interactive sessions are logged in /var/log/wtmp on Linux.

Combinations @strideynet

For some manual testing, many combinations need to be tested. For example, for interactive sessions the 12 combinations are below.

• [x] Connect to a OpenSSH node in a local cluster using OpenSSH.
• [x] Connect to a OpenSSH node in a local cluster using Teleport.
• [x] Connect to a OpenSSH node in a local cluster using the Web UI.
• [x] Connect to an Agentless node in a local cluster using OpenSSH.
• [x] Connect to an Agentless node in a local cluster using Teleport.
• [x] Connect to an Agentless node in a local cluster using the Web UI.
• [x] Connect to a Teleport node in a local cluster using OpenSSH.
• [x] Connect to a Teleport node in a local cluster using Teleport.
• [x] Connect to a Teleport node in a local cluster using the Web UI.
• [x] Connect to a OpenSSH node in a remote cluster using OpenSSH.
• [x] Connect to a OpenSSH node in a remote cluster using Teleport.
• [x] Connect to a OpenSSH node in a remote cluster using the Web UI.
• [x] Connect to an Agentless node in a remote cluster using OpenSSH.
• [x] Connect to an Agentless node in a remote cluster using Teleport.
• [x] Connect to an Agentless node in a remote cluster using the Web UI.
• [x] Connect to a Teleport node in a remote cluster using OpenSSH.
• [x] Connect to a Teleport node in a remote cluster using Teleport.
• [x] Connect to a Teleport node in a remote cluster using the Web UI.

Teleport with EKS/GKE @tigrato

• [x] Deploy Teleport on a single EKS cluster
• [x] Deploy Teleport on two EKS clusters and connect them via trusted cluster feature
• [x] Deploy Teleport Proxy outside GKE cluster fronting connections to it (use this script to generate a kubeconfig)
• [x] Deploy Teleport Proxy outside EKS cluster fronting connections to it (use this script to generate a kubeconfig)

Teleport with multiple Kubernetes clusters @AntonAM

Note: you can use GKE or EKS or minikube to run Kubernetes clusters. Minikube is the only caveat - it's not reachable publicly so don't run a proxy there.

• [x] Deploy combo auth/proxy/kubernetes_service outside a Kubernetes cluster, using a kubeconfig
  • [x] Login with tsh login, check that tsh kube ls has your cluster
  • [x] Run kubectl get nodes, kubectl exec -it $SOME_POD -- sh
  • [x] Verify that the audit log recorded the above request and session
• [x] Deploy combo auth/proxy/kubernetes_service inside a Kubernetes cluster
  • [x] Login with tsh login, check that tsh kube ls has your cluster
  • [x] Run kubectl get nodes, kubectl exec -it $SOME_POD -- sh
  • [x] Verify that the audit log recorded the above request and session
• [x] Deploy combo auth/proxy_service outside the Kubernetes cluster and kubernetes_service inside of a Kubernetes cluster, connected over a reverse tunnel
  • [x] Login with tsh login, check that tsh kube ls has your cluster
  • [x] Run kubectl get nodes, kubectl exec -it $SOME_POD -- sh
  • [x] Verify that the audit log recorded the above request and session
• [x] Deploy a second kubernetes_service inside another Kubernetes cluster, connected over a reverse tunnel
  • [x] Login with tsh login, check that tsh kube ls has both clusters
  • [x] Switch to a second cluster using tsh kube login
  • [x] Run kubectl get nodes, kubectl exec -it $SOME_POD -- sh on the new cluster
  • [x] Verify that the audit log recorded the above request and session
• [x] Deploy combo auth/proxy/kubernetes_service outside a Kubernetes cluster, using a kubeconfig with multiple clusters in it
  • [x] Login with tsh login, check that tsh kube ls has all clusters
• [x] Test Kubernetes screen in the web UI (tab is located on left side nav on dashboard):
  • [x] Verify that all kubes registered are shown with correct name and labels
  • [x] Verify that clicking on a rows connect button renders a dialogue on manual instructions with Step 2 login value matching the rows name column
  • [x] Verify searching for name or labels in the search bar works
  • [x] Verify you can sort by name colum
• [x] Test Kubernetes exec via WebSockets - client

Kubernetes auto-discovery @tigrato

• [x] Test Kubernetes auto-discovery:
  • [x] Verify that Azure AKS clusters are discovered and enrolled for different Azure Auth configs:
  • [x] Local Accounts only
  • [x] Azure AD
  • [x] Azure RBAC
  • [x] Verify that AWS EKS clusters are discovered and enrolled
  • [x] Verify that GCP GKE clusters are discovered and enrolled
• [x] Verify dynamic registration.
  • [x] Can register a new Kubernetes cluster using tctl create.
  • [x] Can update registered Kubernetes cluster using tctl create -f.
  • [x] Can delete registered Kubernetes cluster using tctl rm.

Kubernetes Secret Storage @AntonAM

• [x] Kubernetes Secret storage for Agent's Identity
  • [x] Install Teleport agent with a short-lived token
    • [x] Validate if the Teleport is installed as a Kubernetes Statefulset
    • [x] Restart the agent after token TTL expires to see if it reuses the same identity.
  • [x] Force cluster CA rotation

Kubernetes Pod RBAC @AntonAM

• [x] Verify the following scenarios for kubernetes_resources:
  • [x] {"kind":"pod","name":"*","namespace":"*"} - must allow access to every pod.
  • [x] {"kind":"pod","name":"<somename>","namespace":"*"} - must allow access to pod <somename> in every namespace.
  • [x] {"kind":"pod","name":"*","namespace":"<somenamespace>"} - must allow access to any pod in <somenamespace> namespace.
  • [x] Verify support for * wildcards - <some-name>-* and regex for name and namespace fields.
  • [x] Verify support for delete pods collection - must use go-client.
• [x] Verify scenarios with multiple roles defining kubernetes_resources:
  • [x] Validate that the returned list of pods is the union of every role.
  • [x] Validate that access to other pods is denied by RBAC.
  • [x] Validate that the Kubernetes Groups/Users are correctly selected depending on the role that applies to the pod.
    • [x] Test with a kubernetes_groups that denies exec into a pod
• [x] Verify the following scenarios for Resource Access Requests to Pods:
  • [x] Create a valid resource access request and validate if access to other pods is denied.
  • [x] Validate if creating a resource access request with Kubernetes resources denied by search_as_roles is not allowed.

Kubernetes credentials forwarding @tigrato

• [x] Components running v13
  • [x] Validate the user details are shared using user impersonation
    • [x] Proxy -> kube service
    • [x] Proxy -> leaf proxy -> kube service
• [x] Different versions
  • [x] Proxy v13, kube service v12
  • [x] Proxy v13, leaf proxy v13, leaf kube service v12
  • [x] Proxy v13, leaf proxy v12, leaf kube service v12

Teleport with FIPS mode @atburke

• [x] Perform trusted clusters, Web and SSH sanity check with all teleport components deployed in FIPS mode.

ACME @marcoandredinis

• [x] Teleport can fetch TLS certificate automatically using ACME protocol.

Migrations @r0mant @zmb3

• [x] Migrate trusted clusters from 12.x to 13.0.0-alpha.1
  • [x] Migrate auth server on main cluster, then rest of the servers on main cluster SSH should work for both main and old clusters
  • [x] Migrate auth server on remote cluster, then rest of the remote cluster SSH should work

Command Templates

When interacting with a cluster, the following command templates are useful:

OpenSSH

# when connecting to the recording proxy, `-o 'ForwardAgent yes'` is required.
ssh -o "ProxyCommand ssh -o 'ForwardAgent yes' -p 3023 %r@proxy.example.com -s proxy:%h:%p" \
  node.example.com

# the above command only forwards the agent to the proxy, to forward the agent
# to the target node, `-o 'ForwardAgent yes'` needs to be passed twice.
ssh -o "ForwardAgent yes" \
  -o "ProxyCommand ssh -o 'ForwardAgent yes' -p 3023 %r@proxy.example.com -s proxy:%h:%p" \
  node.example.com

# when connecting to a remote cluster using OpenSSH, the subsystem request is
# updated with the name of the remote cluster.
ssh -o "ProxyCommand ssh -o 'ForwardAgent yes' -p 3023 %r@proxy.example.com -s proxy:%h:%p@foo.com" \
  node.foo.com

Teleport

# when connecting to a OpenSSH node, remember `-p 22` needs to be passed.
tsh --proxy=proxy.example.com --user=<username> --insecure ssh -p 22 node.example.com

# an agent can be forwarded to the target node with `-A`
tsh --proxy=proxy.example.com --user=<username> --insecure ssh -A -p 22 node.example.com

# the --cluster flag is used to connect to a node in a remote cluster.
tsh --proxy=proxy.example.com --user=<username> --insecure ssh --cluster=foo.com -p 22 node.foo.com

Teleport with SSO Providers

• [x] Google Workspace install instructions work @AntonAM
  • [x] Google Workspace Screenshots are up-to-date
• [x] Azure Active Directory (AD) install instructions work @gabrielcorado
  • [x] Azure Active Directory (AD) Screenshots are up-to-date
• [x] ActiveDirectory (ADFS) install instructions work @gabrielcorado
  • [x] Active Directory (ADFS) Screenshots are up-to-date
• [x] Okta install instructions work @mdwn
  • [x] Okta Screenshots are up-to-date
• [x] OneLogin install instructions work @hugoShaka
  • [ ] OneLogin Screenshots are up-to-date (https://github.com/gravitational/teleport/pull/25290)
• [x] GitLab install instructions work @capnspacehook
  • [x] GitLab Screenshots are up-to-date
• [x] OIDC install instructions work @camscale
  • [x] OIDC Screenshots are up-to-date
• [x] All providers with guides in docs are covered in this test plan @camscale
• [x] Login Rules work to transform traits from SSO provider @nklaassen
• [x] SAML IdP guide instructions work @mdwn
  • [x] SAML IdP screenshots are up to date

GitHub External SSO @Tener

• [x] Teleport OSS
  • [x] GitHub organization without external SSO succeeds
  • [x] GitHub organization with external SSO fails
• [x] Teleport Enterprise
  • [x] GitHub organization without external SSO succeeds
  • [x] GitHub organization with external SSO succeeds

tctl sso family of commands @Tener

For help with setting up sso connectors, check out the Quick GitHub/SAML/OIDC Setup Tips

tctl sso configure helps to construct a valid connector definition:

• [x] tctl sso configure github ... creates valid connector definitions
• [x] tctl sso configure oidc ... creates valid connector definitions
• [x] tctl sso configure saml ... creates valid connector definitions

tctl sso test test a provided connector definition, which can be loaded from file or piped in with tctl sso configure or tctl get --with-secrets. Valid connectors are accepted, invalid are rejected with sensible error messages.

• [x] Connectors can be tested with tctl sso test. @Tener
  • [x] GitHub
  • [x] SAML
  • [x] OIDC
    • [x] Google Workspace
    • [x] Non-Google IdP

Teleport Plugins @EdwardDowling

• [x] Test receiving a message via Teleport Slackbot
• [x] Test receiving a new Jira Ticket via Teleport Jira

AWS Node Joining @nklaassen

Docs

• [x] On EC2 instance with ec2:DescribeInstances permissions for local account: TELEPORT_TEST_EC2=1 go test ./integration -run TestEC2NodeJoin
• [x] On EC2 instance with any attached role: TELEPORT_TEST_EC2=1 go test ./integration -run TestIAMNodeJoin
• [x] EC2 Join method in IoT mode with node and auth in different AWS accounts
• [x] IAM Join method in IoT mode with node and auth in different AWS accounts

Kubernetes Node Joining @hugoShaka

• [x] Join a Teleport node running in the same Kubernetes cluster via a Kubernetes ProvisionToken

Azure Node Joining @atburke

Docs

• [x] Join a Teleport node running in an Azure VM

Cloud Labels @atburke

• [x] Create an EC2 instance with tags in instance metadata enabled and with tag foo: bar. Verify that a node running on the instance has label aws/foo=bar.
• [x] Create an Azure VM with tag foo: bar. Verify that a node running on the instance has label azure/foo=bar.

Passwordless @codingllama

This feature has additional build requirements, so it should be tested with a pre-release build from Drone (eg: https://get.gravitational.com/teleport-v10.0.0-alpha.2-linux-amd64-bin.tar.gz).

This sections complements "Users -> Managing MFA devices". tsh binaries for each operating system (Linux, macOS and Windows) must be tested separately for FIDO2 items.

• [x] Diagnostics

  Commands should pass all tests.

  • [x] tsh fido2 diag (macOS/Linux)
  • [x] tsh touchid diag (macOS only)
  • [x] tsh webauthnwin diag (Windows only)

• [x] Registration

  • [x] Register a passworldess FIDO2 key (tsh mfa add, choose WEBAUTHN and passwordless)
  • [x] macOS/Linux
  • [x] Windows
  • [x] Register a platform authenticator
  • [x] Touch ID credential (tsh mfa add, choose TOUCHID)
  • [x] Windows hello credential (tsh mfa add, choose WEBAUTHN and passwordless)

• [x] Login

  • [x] Passwordless login using FIDO2 (tsh login --auth=passwordless)
  • [x] macOS/Linux
  • [x] Windows
  • [x] Passwordless login using platform authenticator (tsh login --auth=passwordless)
  • [x] Touch ID
  • [x] Windows Hello
  • [x] tsh login --auth=passwordless --mfa-mode=cross-platform uses FIDO2
  • [x] macOS/Linux
  • [x] Windows
  • [x] tsh login --auth=passwordless --mfa-mode=platform uses platform authenticator
  • [x] Touch ID
  • [x] Windows Hello
  • [x] tsh login --auth=passwordless --mfa-mode=auto prefers platform authenticator
  • [x] Touch ID
  • [x] Windows Hello
  • [x] Exercise credential picker (register credentials for multiple users in the same device)
  • [x] FIDO2 macOS/Linux
  • [x] Touch ID
  • [x] Windows
  • [x] Passwordless disable switch works (auth_service.authentication.passwordless = false)
  • [x] Cluster in passwordless mode defaults to passwordless (auth_service.authentication.connector_name = passwordless)
  • [x] Cluster in passwordless mode allows MFA login (tsh login --auth=local)

• [x] Touch ID support commands

  • [x] tsh touchid ls works
  • [x] tsh touchid rm works (careful, may lock you out!)

Device Trust @sshahcodes

Device Trust requires Teleport Enterprise.

This feature has additional build requirements, so it should be tested with a pre-release build from Drone (eg: https://get.gravitational.com/teleport-v10.0.0-alpha.2-linux-amd64-bin.tar.gz).

Client-side enrollment requires a signed tsh for macOS, make sure to use the tsh binary from tsh.app.

A simple formula for testing device authorization is:

# Before enrollment.
# Replace with other kinds of access, as appropriate (db, kube, etc)
tsh ssh node-that-requires-device-trust
> ERROR: ssh: rejected: administratively prohibited (unauthorized device)

# Register the device.
# Get the serial number from "Apple -> About This Mac".
tctl devices add --os=macos --asset-tag=<SERIAL_NUMBER> --enroll

# Enroll the device.
tsh device enroll --token=<TOKEN_FROM_COMMAND_ABOVE>
tsh logout; tsh login

# After enrollment
tsh ssh node-that-requires-device-trust
> $

• [x] Inventory management

  • [x] Add device (tctl devices add)
  • [x] Add device and create enrollment token (tctl devices add --enroll)
  • [x] List devices (tctl devices ls)
  • [x] Remove device using device ID (tctl devices rm)
  • [x] Remove device using asset tag (tctl devices rm)
  • [x] Create enrollment token using device ID (tctl devices enroll)
  • [x] Create enrollment token using asset tag (tctl devices enroll)

• [x] Device enrollment

  • [x] Enroll device on macOS (tsh device enroll)
  • [x] Verify device extensions on TLS certificate

  Note that different accesses have different certificates (Database, Kube, etc).

  $ openssl x509 -noout -in ~/.tsh/keys/zarquon/llama-x509.pem -nameopt sep_multiline -subject | grep 1.3.9999.3
  > 1.3.9999.3.1=6e60b9fd-1e3e-473d-b148-27b4f158c2a7
  > 1.3.9999.3.2=AAAAAAAAAAAA
  > 1.3.9999.3.3=661c9340-81b0-4a1a-a671-7b1304d28600

  • [x] Verify device extensions on SSH certificate

  ssh-keygen -L -f ~/.tsh/keys/zarquon/llama-ssh/zarquon-cert.pub | grep teleport-device-
  teleport-device-asset-tag ...
  teleport-device-credential-id ...
  teleport-device-id ...

• [x] Device authorization

  • [x] device_trust.mode other than "off" or "" not allowed (OSS)
  • [x] device_trust.mode="off" doesn't impede access (Enterprise and OSS)
  • [x] device_trust.mode="optional" doesn't impede access, but issues device extensions on login
  • [x] device_trust.mode="required" enforces enrolled devices
  • [x] device_trust.mode="required" is enforced by processes, and not only by Auth APIs

  Testing this requires issuing a certificate without device extensions (mode="off"), then changing the cluster configuration to mode="required" and attempting to access a process directly, without a login attempt.

  • [x] Role-based authz enforces enrolled devices (device_trust.mode="off" or "optional", role.spec.options.device_trust_mode="required")

  • [x] Device authorization works correctly for both require_session_mfa=false and require_session_mfa=true

  • [x] Device authorization applies to SSH access (all items above)

  • [x] Device authorization applies to Trusted Clusters (root with mode="optional" and leaf with mode="required")

  • [x] Device authorization applies to Database access (all items above)

  • [x] Device authorization applies to Kubernetes access (all items above)

  • [x] Device authorization does not apply to App access (both cluster-wide and role)

  • [x] Device authorization does not apply to Windows Desktop access (both cluster-wide and role)

• [x] Device audit (see lib/events/codes.go)

  • [x] Inventory management actions issue events (success only)
  • [x] Device enrollment issues device event (any outcomes)
  • [x] Device authorization issues device event (any outcomes)
  • [x] Events with UserMetadata contain TrustedDevice data (for certificates with device extensions)

• [x] Binary support

  • [x] Non-signed and/or non-notarized tsh for macOS gives a sane error message for tsh device enroll attempts.

Hardware Key Support @Joerger

Hardware Key Support is an Enterprise feature and is not available for OSS.

You will need a YubiKey 4.3+ to test this feature.

This feature has additional build requirements, so it should be tested with a pre-release build from Drone (eg: https://get.gravitational.com/teleport-ent-v11.0.0-alpha.2-linux-amd64-bin.tar.gz).

Server Access

These tests should be carried out sequentially. tsh tests should be carried out on Linux, MacOS, and Windows.

1. [x] tsh login as user with Webauthn login and no hardware key requirement.
2. [x] Request a role with role.role_options.require_session_mfa: hardware_key - tsh login --request-roles=hardware_key_required
   • [x] Assuming the role should force automatic re-login with yubikey
   • [x] tsh ssh
   • [x] Requires yubikey to be connected for re-login
   • [x] Prompts for per-session MFA
3. [x] Request a role with role.role_options.require_session_mfa: hardware_key_touch - tsh login --request-roles=hardware_key_touch_required
   • [x] Assuming the role should force automatic re-login with yubikey
   • [x] Prompts for touch if not cached (last touch within 15 seconds)
   • [x] tsh ssh
   • [x] Requires yubikey to be connected for re-login
   • [x] Prompts for touch if not cached
4. [x] tsh logout and tsh login as the user with no hardware key requirement.
5. [x] Upgrade auth settings to auth_service.authentication.require_session_mfa: hardware_key
   • [x] Using the existing login session (tsh ls) should force automatic re-login with yubikey
   • [x] tsh ssh
   • [x] Requires yubikey to be connected for re-login
   • [x] Prompts for per-session MFA
6. [x] Upgrade auth settings to auth_service.authentication.require_session_mfa: hardware_key_touch
   • [x] Using the existing login session (tsh ls) should force automatic re-login with yubikey
   • [x] Prompts for touch if not cached
   • [x] tsh ssh
   • [x] Requires yubikey to be connected for re-login
   • [x] Prompts for touch if not cached

Other

Set auth_service.authentication.require_session_mfa: hardware_key_touch in your cluster auth settings.

• [x] Database Access: tsh proxy db --tunnel

HSM Support @nklaassen

Docs

• [x] YubiHSM2 Support (@nklaassen has hardware)
  • [x] Make sure docs/links are up to date (PR https://github.com/gravitational/teleport/pull/25019)
  • [x] New cluster with YubiHSM2 CA works
  • [x] Migrating a software cluster to YubiHSM2 works
  • [x] CA rotation works
• [x] AWS CloudHSM Support
  • [x] Make sure docs/links are up to date (PR https://github.com/gravitational/teleport/pull/25306)
  • [x] New cluster with CloudHSM CA works
  • [x] Migrating a software cluster to CloudHSM works
  • [x] CA rotation works
• [x] GCP KMS Support
  • [x] Make sure docs/links are up to date
  • [x] New cluster with GCP KMS CA works
  • [x] Migrating a software cluster to GCP KMS works
  • [x] CA rotation works

Moderated session @marcoandredinis

Using tsh join an SSH session as two moderators (two separate terminals, role requires one moderator).

• [x] Ctrl+C in the #1 terminal should disconnect the moderator.
• [x] Ctrl+C in the #2 terminal should disconnect the moderator and terminate the session as session has no moderator.

Using tsh join an SSH session as two moderators (two separate terminals, role requires one moderator).

• [x] t in any terminal should terminate the session for all participants.

Performance @rosstimothy @fspmarshall @espadolini

Scaling Test

Scale up the number of nodes/clusters a few times for each configuration below.

1) Verify that there are no memory/goroutine/file descriptor leaks 2) Compare the baseline metrics with the previous release to determine if resource usage has increased 3) Restart all Auth instances and verify that all nodes/clusters reconnect

Perform reverse tunnel node scaling tests for all backend configurations:

• [x] etcd - 10k
• [x] DynamoDB - 10k

• [x] Firestore - 10k

  Perform the following additional scaling tests on DynamoDB:

  • [x] 10k direct dial nodes.
  • [x] 500 trusted clusters.

Soak Test

Run 30 minute soak test directly against direct and tunnel nodes and via label based matching. Tests should be run against a Cloud tenant.

tsh bench ssh --duration=30m user@direct-dial-node ls
tsh bench ssh --duration=30m user@reverse-tunnel-node ls
tsh bench ssh --duration=30m user@foo=bar ls
tsh bench ssh --duration=30m --random user@foo ls

Concurrent Session Test

• Cluster with 1k reverse tunnel nodes

Run a concurrent session test that will spawn 5 interactive sessions per node in the cluster:

tsh bench web sessions --max=5000 user ls
tsh bench web sessions --max=5000 --web user ls

• [x] Verify that all 5000 sessions are able to be established.
• [x] Verify that tsh and the web UI are still functional.

Robustness

• Connectivity Issues:

• [x] Verify that a lack of connectivity to Auth does not prevent access to resources which do not require a moderated session and in async recording mode from an already issued certificate.

• [x] Verify that a lack of connectivity to Auth prevents access to resources which require a moderated session and in async recording mode from an already issued certificate.

• [x] Verify that an open session is not terminated when all Auth instances are restarted.

Teleport with Cloud Providers

AWS @tcsc

• [x] Deploy Teleport to AWS. Using DynamoDB & S3
• [x] Deploy Teleport Enterprise to AWS. Using HA Setup https://gravitational.com/teleport/docs/aws-terraform-guide/

GCP @tcsc

• [x] Deploy Teleport to GCP. Using Cloud Firestore & Cloud Storage
• [x] Deploy Teleport to GKE. Google Kubernetes engine.
• [x] Deploy Teleport Enterprise to GCP.

IBM @hugoShaka

• [x] Deploy Teleport to IBM Cloud. Using IBM Database for etcd & IBM Object Store
• [x] Deploy Teleport to IBM Cloud Kubernetes.
• [x] Deploy Teleport Enterprise to IBM Cloud.

Application Access @mdwn

• [x] Run an application within local cluster.
  • [x] Verify the debug application debug_app: true works.
  • [x] Verify an application can be configured with command line flags.
  • [x] Verify an application can be configured from file configuration.
  • [x] Verify that applications are available at auto-generated addresses name.rootProxyPublicAddr and well as publicAddr.
• [x] Run an application within a trusted cluster.
  • [x] Verify that applications are available at auto-generated addresses name.rootProxyPublicAddr.
• [x] Verify Audit Records.
  • [x] app.session.start and app.session.chunk events are created in the Audit Log.
  • [x] app.session.chunk points to a 5 minute session archive with multiple app.session.request events inside.
  • [x] tsh play <chunk-id> can fetch and print a session chunk archive.
• [x] Verify JWT using verify-jwt.go.
• [x] Verify RBAC.
• [x] Verify CLI access with tsh apps login.
• [x] Verify AWS console access.
  • [x] Can log into AWS web console through the web UI.
  • [x] Can interact with AWS using tsh commands.
  • [x] tsh aws
  • [x] tsh aws --endpoint-url (this is a hidden flag)
• [x] Verify Azure CLI access with tsh apps login.
  • [x] Can interact with Azure using tsh az commands.
  • [x] Can interact with Azure using a combination of tsh proxy az and az commands.
• [x] Verify GCP CLI access with tsh apps login.
  • [x] Can interact with GCP using tsh gcloud commands.
  • [x] Can interact with Google Cloud Storage using tsh gsutil commands.
  • [x] Can interact with GCP/GCS using a combination of tsh proxy gcloud and gcloud/gsutil commands.
• [x] Verify dynamic registration.
  • [x] Can register a new app using tctl create.
  • [x] Can update registered app using tctl create -f.
  • [x] Can delete registered app using tctl rm.
• [x] Test Applications screen in the web UI (tab is located on left side nav on dashboard):
  • [x] Verify that all apps registered are shown
  • [x] Verify that clicking on the app icon takes you to another tab
  • [x] Verify using the bash command produced from Add Application dialogue works (refresh app screen to see it registered)

Database Access @smallinsky

• [x] Connect to a database within a local cluster.
  • [x] Self-hosted Postgres. @smallinsky
  • [x] verify that cancelling a Postgres request works. (select pg_sleep(10) followed by ctrl-c is a good query to test.)
  • [x] Self-hosted MySQL. @GavinFrazar
  • [x] Self-hosted MariaDB. @GavinFrazar
  • [x] Self-hosted MongoDB. @Tener
  • [x] Self-hosted CockroachDB. @Tener
  • [x] Self-hosted Redis. @gabrielcorado
  • [x] Self-hosted Redis Cluster. @gabrielcorado
  • [x] Self-hosted MSSQL. @gabrielcorado
  • [x] Self-hosted MSSQL with PKINIT authentication. @smallinsky
  • [x] AWS Aurora Postgres. @GavinFrazar
  • [x] AWS Aurora MySQL. @GavinFrazar
  • [x] AWS RDS Proxy (MySQL, Postgres, or MariaDB, SQLServer) @GavinFrazar
  • [x] AWS Redshift. @gabrielcorado
  • [x] AWS Redshift Serverless. @gabrielcorado
  • [x] Verify connection to external AWS account works with assume_role_arn: "" and external_id: "<id>"
  • [x] AWS ElastiCache. @greedy52
  • [x] AWS MemoryDB. @greedy52
  • [x] GCP Cloud SQL Postgres. @GavinFrazar
  • [x] GCP Cloud SQL MySQL. @GavinFrazar
  • [x] Snowflake. @smallinsky
  • [x] Azure Cache for Redis. @GavinFrazar
  • [x] Azure single-server MySQL and Postgres @smallinsky
  • [x] Azure flexible-server MySQL and Postgres @smallinsky
  • [x] Elasticsearch. @Tener
  • [x] Cassandra/ScyllaDB. @gabrielcorado
  • [x] Verify connection to external AWS account works with assume_role_arn: "" and external_id: "<id>"
  • [x] Dynamodb. @Tener
  • [x] Verify connection to external AWS account works with assume_role_arn: "" and external_id: "<id>"
  • [x] Azure SQL Server. @gabrielcorado
  • [x] Oracle @smallinsky
• [x] Connect to a database within a remote cluster via a trusted cluster.
  • [x] Self-hosted Postgres. @smallinsky
  • [x] Self-hosted MySQL. @GavinFrazar
  • [x] Self-hosted MariaDB. @GavinFrazar
  • [x] Self-hosted MongoDB. @Tener
  • [x] Self-hosted CockroachDB. @Tener
  • [x] Self-hosted Redis. @gabrielcorado
  • [x] Self-hosted Redis Cluster. @gabrielcorado
  • [x] Self-hosted MSSQL. @gabrielcorado
  • [x] Self-hosted MSSQL with PKINIT authentication @smallinsky
  • [x] AWS Aurora Postgres. @GavinFrazar
  • [x] AWS Aurora MySQL. @GavinFrazar
  • [x] AWS RDS Proxy (MySQL, Postgres, or MariaDB, SQLServer) @GavinFrazar
  • [x] AWS Redshift. @gabrielcorado
  • [x] AWS Redshift Serverless. @gabrielcorado
  • [x] AWS ElastiCache. @greedy52
  • [x] AWS MemoryDB. @greedy52
  • [x] GCP Cloud SQL Postgres. @GavinFrazar
  • [x] GCP Cloud SQL MySQL. @GavinFrazar
  • [x] Snowflake. @smallinsky
  • [x] Azure Cache for Redis. @GavinFrazar
  • [x] Azure single-server MySQL and Postgres @smallinsky
  • [x] Azure flexible-server MySQL and Postgres @smallinsky
  • [x] Elasticsearch. @Tener
  • [x] Cassandra/ScyllaDB. @gabrielcorado
  • [x] Dynamodb. @Tener
  • [x] Azure SQL Server. @gabrielcorado
  • [x] Oracle @smallinsky
• [x] Verify audit events. @GavinFrazar
  • [x] db.session.start is emitted when you connect.
  • [x] db.session.end is emitted when you disconnect.
  • [x] db.session.query is emitted when you execute a SQL query.
• [x] Verify RBAC. @GavinFrazar
  • [x] tsh db ls shows only databases matching role's db_labels.
  • [x] Can only connect as users from db_users.
  • [x] (Postgres only) Can only connect to databases from db_names. @smallinsky
  • [x] db.session.start is emitted when connection attempt is denied.
  • [x] (MongoDB only) Can only execute commands in databases from db_names. @Tener
  • [x] db.session.query is emitted when command fails due to permissions.
  • [x] Can configure per-session MFA.
  • [x] MFA tap is required on each tsh db connect.
• [x] Verify dynamic registration. @gabrielcorado
  • [x] Can register a new database using tctl create.
  • [x] Can update registered database using tctl create -f.
  • [x] Can delete registered database using tctl rm.
• [x] Verify discovery.
  • [x] AWS @greedy52
    • [x] Can detect and register RDS instances.
    • [x] Can detect and register RDS instances in an external AWS account when assume_role_arn and external_id is set.
    • [x] Can detect and register Aurora clusters, and their reader and custom endpoints.
    • [x] Can detect and register RDS proxies, and their custom endpoints.
    • [x] Can detect and register Redshift clusters.
    • [x] Can detect and register Redshift serverless workgroups, and their VPC endpoints.
    • [x] Can detect and register ElastiCache Redis clusters.
    • [x] Can detect and register MemoryDB clusters.
  • [x] Azure @GavinFrazar
    • [x] Can detect and register MySQL and Postgres single-server instances.
    • [x] Can detect and register MySQL and Postgres flexible-server instances.
    • [x] Can detect and register Azure Cache for Redis servers.
    • [x] Can detect and register Azure SQL Servers and Azure SQL Managed Instances.
• [x] Verify Teleport managed users (password rotation, auto 'auth' on connection, etc.). @greedy52
  • [x] Can detect and manage ElastiCache users
  • [x] Can detect and manage MemoryDB users
• [x] Test Databases screen in the web UI (tab is located on left side nav on dashboard): @smallinsky
  • [x] Verify that all dbs registered are shown with correct name, description, type, and labels
  • [x] Verify that clicking on a rows connect button renders a dialogue on manual instructions with Step 2 login value matching the rows name column
  • [x] Verify searching for all columns in the search bar works
  • [x] Verify you can sort by all columns except labels
• [x] Other @smallinsky
  • [x] MySQL server version reported by Teleport is correct.

TLS Routing @smallinsky

• [x] Verify that teleport proxy v2 configuration starts only a single listener for proxy service, in contrast with v1 configuration. @GavinFrazar Given configuration:

  version: v2
  proxy_service:
  enabled: "yes"
  public_addr: ['root.example.com']
  web_listen_addr: 0.0.0.0:3080

  There should be total of three listeners, with only *:3080 for proxy service. Given the configuration above, 3022 and 3025 will be opened for other services.

  lsof -i -P | grep teleport | grep LISTEN
  teleport  ...  TCP *:3022 (LISTEN)
  teleport  ...  TCP *:3025 (LISTEN)
  teleport  ...  TCP *:3080 (LISTEN) # <-- proxy service

  In contrast for the same configuration with version v1, there should be additional ports 3023 and 3024.

  lsof -i -P | grep teleport | grep LISTEN
  teleport  ...  TCP *:3022 (LISTEN)
  teleport  ...  TCP *:3025 (LISTEN)
  teleport  ...  TCP *:3023 (LISTEN) # <-- extra proxy service port
  teleport  ...  TCP *:3024 (LISTEN) # <-- extra proxy service port
  teleport  ...  TCP *:3080 (LISTEN) # <-- proxy service

• [x] Run Teleport Proxy in multiplex mode auth_service.proxy_listener_mode: "multiplex" @GavinFrazar

  • [x] Trusted cluster
  • [x] Setup trusted clusters using single port setup web_proxy_addr == tunnel_addr

    kind: trusted_cluster
    spec:
    ...
    web_proxy_addr: root.example.com:443
    tunnel_addr: root.example.com:443
    ...

• [x] Database Access

  • [x] Verify that tsh db connect works through proxy running in multiplex mode
  • [x] Postgres @smallinsky
  • [x] MySQL @GavinFrazar
  • [x] MariaDB @GavinFrazar
  • [x] MongoDB @Tener
  • [x] CockroachDB @Tener
  • [x] Redis @greedy52
  • [x] MSSQL @gabrielcorado
  • [x] Snowflake @smallinsky
  • [x] Elasticsearch. @Tener
  • [x] Cassandra/ScyllaDB. @gabrielcorado
  • [x] Oracle @smallinsky
  • [x] Verify connecting to a database through TLS ALPN SNI local proxy tsh db proxy with a GUI client. @smallinsky @GavinFrazar @Tener @greedy52
  • [x] Verify tsh proxy db with teleport proxy behind ALB. @smallinsky

• [x] Application Access @smallinsky

  • [x] Verify app access through proxy running in multiplex mode

• [x] SSH Access @GavinFrazar

  • [x] Connect to a OpenSSH server through a local ssh proxy ssh -o "ForwardAgent yes" -o "ProxyCommand tsh proxy ssh" user@host.example.com
  • [x] Connect to a OpenSSH server on leaf-cluster through a local ssh proxyssh -o "ForwardAgent yes" -o "ProxyCommand tsh proxy ssh --user=%r --cluster=leaf-cluster %h:%p" user@node.foo.com
  • [x] Verify tsh ssh access through proxy running in multiplex mode

• [x] Kubernetes access: @gabrielcorado

  • [x] Verify kubernetes access through proxy running in multiplex mode

• [x] Teleport Proxy single port multiplex mode behind L7 load balancer

  • [x] Agent can join through Proxy and maintain reverse tunnel @smallinsky
  • [x] tsh login and tctl @smallinsky
  • [x] SSH Access: tsh ssh and tsh config @gabrielcorado
  • [x] Database Access: tsh proxy db and tsh db connect @gabrielcorado
  • [x] Application Access: tsh proxy app and tsh aws @gabrielcorado
  • [x] Kubernetes Access: tsh proxy kube @smallinsky

    Desktop Access @ibeckermayer

• Direct mode (set listen_addr):

  • [x] Can connect to desktop defined in static hosts section.
  • [x] Can connect to desktop discovered via LDAP

• IoT mode (reverse tunnel through proxy):

  • [x] Can connect to desktop defined in static hosts section.
  • [x] Can connect to desktop discovered via LDAP

• [x] Connect multiple windows_desktop_services to the same Teleport cluster, verify that connections to desktops on different AD domains works. (Attempt to connect several times to verify that you are routed to the correct windows_desktop_service)

• Verify user input

  • [x] Download Keyboard Key Info and verify all keys are processed correctly in each supported browser. Known issues: F11 cannot be captured by the browser without special configuration on MacOS.
  • [x] Left click and right click register as Windows clicks. (Right click on the desktop should show a Windows menu, not a browser context menu)
  • [x] Vertical and horizontal scroll work. Horizontal Scroll Test

• Locking

  • [x] Verify that placing a user lock terminates an active desktop session.
  • [x] Verify that placing a desktop lock terminates an active desktop session.
  • [x] Verify that placing a role lock terminates an active desktop session.

• Labeling

  • [x] Set client_idle_timeout to a small value and verify that idle sessions are terminated (the session should end and an audit event will confirm it was due to idle connection)
  • [x] All desktops have teleport.dev/origin label.
  • [x] Dynamic desktops have additional teleport.dev labels for OS, OS Version, DNS hostname.
  • [x] Regexp-based host labeling applies across all desktops, regardless of origin.

• RBAC

  • [x] RBAC denies access to a Windows desktop due to labels
  • [x] RBAC denies access to a Windows desktop with the wrong OS-login.

• Clipboard Support

  • When a user has a role with clipboard sharing enabled and is using a chromium based browser
  • [x] Going to a desktop when clipboard permissions are in "Ask" mode (aka "prompt") causes the browser to show a prompt when you first click or press a key
  • [x] The clipboard icon is highlighted in the top bar
  • [x] After allowing clipboard permission, copy text from local workstation, paste into remote desktop
  • [x] After allowing clipboard permission, copy text from remote desktop, paste into local workstation
  • [x] After disallowing clipboard permission, confirm copying text from local workstation and pasting into remote desktop doesn't work
  • [x] After disallowing clipboard permission, confirm copying text from remote desktop and pasting into local workstation doesn't work
  • When a user has a role with clipboard sharing enabled and is not using a chromium based browser
  • [x] The clipboard icon is not highlighted in the top bar and copy/paste does not work
  • When a user has a role with clipboard sharing disabled and is using a chromium and non-chromium based browser (confirm both)
  • [x] The clipboard icon is not highlighted in the top bar and copy/paste does not work

• Directory Sharing

  • On supported, non-chromium based browsers (Firefox/Safari)
  • [x] Attempting to share directory logs a sensible warning in the warning dropdown
  • On supported, chromium based browsers (Chrome/Edge)
  • Begin sharing works
    • [x] The shared directory icon in the top right of the screen is highlighted when directory sharing is initiated
    • [x] The shared directory appears as a network drive named " on teleport"
    • [x] The share directory menu option disappears from the menu
  • Navigation
    • [x] The folders of the shared directory are navigable (move up and down the directory tree)
  • CRUD
    • [x] A new text file can be created
    • [x] The text file can be written to (saved)
    • [x] The text file can be read (close it, check that it's saved on the local machine, then open it again on the remote)
    • [x] The text file can be deleted
  • File/Folder movement
    • In to out (make at least one of these from a non-top-level-directory)
    • [x] A file from inside the shared directory can be drag-and-dropped outside the shared directory
    • [x] A folder from inside the shared directory can be drag-and-dropped outside the shared directory (and its contents retained)
    • [x] A file from inside the shared directory can be cut-pasted outside the shared directory
    • [x] A folder from inside the shared directory can be cut-pasted outside the shared directory
    • [x] A file from inside the shared directory can be copy-pasted outside the shared directory
    • [x] A folder from inside the shared directory can be copy-pasted outside the shared directory
    • Out to in (make at least one of these overwrite an existing file, and one go into a non-top-level directory)
    • [x] A file from outside the shared directory can be drag-and-dropped into the shared directory
    • [x] A folder from outside the shared directory can be drag-and-dropped into the shared directory (and its contents retained)
    • [x] A file from outside the shared directory can be cut-pasted into the shared directory
    • [x] A folder from outside the shared directory can be cut-pasted into the shared directory
    • [x] A file from outside the shared directory can be copy-pasted into the shared directory
    • [x] A folder from outside the shared directory can be copy-pasted into the shared directory
    • Within
    • [x] A file from inside the shared directory cannot be drag-and-dropped to another folder inside the shared directory: a dismissible "Unsupported Action" dialog is shown
    • [x] A folder from inside the shared directory cannot be drag-and-dropped to another folder inside the shared directory: a dismissible "Unsupported Action" dialog is shown
    • [x] A file from inside the shared directory cannot be cut-pasted to another folder inside the shared directory: a dismissible "Unsupported Action" dialog is shown
    • [x] A folder from inside the shared directory cannot be cut-pasted to another folder inside the shared directory: a dismissible "Unsupported Action" dialog is shown
    • [x] A file from inside the shared directory can be copy-pasted to another folder inside the shared directory
    • [x] A folder from inside the shared directory can be copy-pasted to another folder inside shared directory (and its contents retained)
  • RBAC
  • [x] Give the user one role that explicitly disables directory sharing (desktop_directory_sharing: false) and confirm that the option to share a directory doesn't appear in the menu

• Per-Session MFA (try webauthn on each of Chrome, Safari, and Firefox; u2f only works with Firefox)

  • [x] Attempting to start a session no keys registered shows an error message
  • [x] Attempting to start a session with a webauthn registered pops up the "Verify Your Identity" dialog
  • [x] Hitting "Cancel" shows an error message
  • [x] Hitting "Verify" causes your browser to prompt you for MFA
  • [x] Cancelling that browser MFA prompt shows an error
  • [x] Successful MFA verification allows you to connect

• Session Recording

  • [x] Verify sessions are not recorded if all of a user's roles disable recording
  • [x] Verify sync recording (mode: node-sync or mode: proxy-sync)
  • [x] Verify async recording (mode: node or mode: proxy)
  • [x] Sessions show up in session recordings UI with desktop icon
  • [x] Sessions can be played back, including play/pause functionality
  • [x] Sessions playback speed can be toggled while its playing
  • [x] Sessions playback speed can be toggled while its paused
  • [x] A session that ends with a TDP error message can be played back, ends by displaying the error message, and the progress bar progresses to the end.
  • [x] Attempting to play back a session that doesn't exist (i.e. by entering a non-existing session id in the url) shows a relevant error message.
  • [x] RBAC for sessions: ensure users can only see their own recordings when using the RBAC rule from our docs

• Audit Events (check these after performing the above tests)

  • [x] windows.desktop.session.start (TDP00I) emitted on start
  • [x] windows.desktop.session.start (TDP00W) emitted when session fails to start (due to RBAC, for example)
  • [x] client.disconnect (T3006I) emitted when session is terminated by or fails to start due to lock
  • [x] windows.desktop.session.end (TDP01I) emitted on end
  • [x] desktop.clipboard.send (TDP02I) emitted for local copy -> remote paste
  • [x] desktop.clipboard.receive (TDP03I) emitted for remote copy -> local paste
  • [x] desktop.directory.share (TDP04I) emitted when Teleport starts sharing a directory
  • [x] desktop.directory.read (TDP05I) emitted when a file is read over the shared directory
  • [x] desktop.directory.write (TDP06I) emitted when a file is written to over the shared directory

• Warnings/Errors

  • [x] Induce the backend to send a TDP Notification of severity warning (1), confirm that a warning is logged in the warning dropdown
  • [x] Induce the backend to send a TDP Notification of severity error (2), confirm that session is terminated and error popup is shown
  • [x] Induce the backend to send a TDP Error, confirm that session is terminated and error popup is shown (confirms backwards compatibility w/ older w_d_s starting in Teleport 12)

• Trusted Cluster / Tunneling

  • Set up Teleport in a trusted cluster configuration where the root and leaf cluster has a w_d_s connected via tunnel (w_d_s running as a separate process)
  • [x] Confirm that windows desktop sessions can be made on root cluster
  • [x] Confirm that windows desktop sessions can be made on leaf cluster

Binaries compatibility @fheinecke

• Verify tsh runs on:
  • [ ] Windows 10
  • [ ] MacOS

Machine ID

SSH @strideynet

With a default Teleport instance configured with a SSH node:

• [x] Verify you are able to create a new bot user with tctl bots add robot --roles=access. Follow the instructions provided in the output to start tbot
• [x] Verify you are able to connect to the SSH node using openssh with the generated ssh_config in the destination directory
• [x] Verify that after the renewal period (default 20m, but this can be reduced via configuration), that newly generated certificates are placed in the destination directory
• [x] Verify that sending both SIGUSR1 and SIGHUP to a running tbot process causes a renewal and new certificates to be generated
• [x] Verify that you are able to make a connection to the SSH node using the ssh_config provided by tbot after each phase of a manual CA rotation.

Ensure the above tests are completed for both:

• [x] Directly connecting to the auth server
• [x] Connecting to the auth server via the proxy reverse tunnel

DB Access @timothyb89

With a default Postgres DB instance, a Teleport instance configured with DB access and a bot user configured:

• [x] Verify you are able to connect to and interact with a database using tbot db while tbot start is running

Host users creation @lxea

Host users creation docs Host users creation RFD

• Verify host users creation functionality
  • [x] non-existing users are created automatically
  • [x] users are added to groups
  • [x] non-existing configured groups are created
  • [x] created users are added to the teleport-system group
  • [x] users are cleaned up after their session ends
  • [x] cleanup occurs if a program was left running after session ends
  • [x] sudoers file creation is successful
  • [x] Invalid sudoers files are not created
  • [x] existing host users are not modified
  • [x] setting disable_create_host_user: true stops user creation from occurring

CA rotations @espadolini

• Verify the CA rotation functionality itself (by checking in the backend or with tctl get cert_authority)
  • [x] standby phase: only active_keys, no additional_trusted_keys
  • [x] init phase: active_keys and additional_trusted_keys
  • [x] update_clients and update_servers phases: the certs from the init phase are swapped
  • [x] standby phase: only the new certs remain in active_keys, nothing in additional_trusted_keys
  • [x] rollback phase (second pass, after completing a regular rotation): same content as in the init phase
  • [x] standby phase after rollback: same content as in the previous standby phase
• Verify functionality in all phases (clients might have to log in again in lieu of waiting for credentials to expire between phases)
  • [x] SSH session in tsh from a previous phase
  • [x] SSH session in web UI from a previous phase
  • [x] New SSH session with tsh
  • [x] New SSH session with web UI
  • [x] New SSH session in a child cluster on the same major version
  • [x] New SSH session in a child cluster on the previous major version
  • [x] New SSH session from a parent cluster
  • [x] Application access through a browser
  • [x] Application access through curl with tsh apps login
  • [x] kubectl get po after tsh kube login
  • [ ] Database access (no configuration change should be necessary if the database CA isn't rotated, other Teleport functionality should not be affected if only the database CA is rotated)

EC2 Discovery @lxea

EC2 Discovery docs

• Verify EC2 instance discovery
  • [x] Only EC2 instances matching given AWS tags have the installer executed on them
  • [x] Only the IAM permissions mentioned in the discovery docs are required for operation
  • [x] Custom scripts specified in different matchers are executed
  • [x] Custom SSM documents specified in different matchers are executed
  • [x] New EC2 instances with matching AWS tags are discovered and added to the teleport cluster
  • [x] Large numbers of EC2 instances (51+) are all successfully added to the cluster
  • [x] Nodes that have been discovered do not have the install script run on the node multiple times

IP Pinning

Add a role with pin_source_ip: true (requires Enterprise) to test IP pinning. Testing will require changing your IP (that Teleport Proxy sees). Docs: IP Pinning

• Verify that it works for SSH Access @AntonAM
  • [x] You can access tunnel node with tsh ssh on root cluster
  • [x] You can access direct access node with tsh ssh on root cluster
  • [x] You can access tunnel node from Web UI on root cluster
  • [x] You can access direct access node from Web UI on root cluster
  • [x] You can access tunnel node with tsh ssh on leaf cluster
  • [x] You can access direct access node with tsh ssh on leaf cluster
  • [x] You can access tunnel node from Web UI on leaf cluster
  • [x] You can access direct access node from Web UI on leaf cluster
  • [x] You can download files from nodes in Web UI (small arrows at top left corner)
  • [x] If you change your IP you no longer can access nodes.
• Verify that it works for Kube Access @AntonAM
  • [x] You can access Kubernetes cluster through standalone Kube service on root cluster
  • [x] You can access Kubernetes cluster through agent inside Kubernetes on root cluster
  • [x] You can access Kubernetes cluster through standalone Kube service on leaf cluster
  • [x] You can access Kubernetes cluster through agent inside Kubernetes on leaf cluster
  • [x] If you change your IP you no longer can access Kube clusters.
• Verify that it works for DB Access @smallinsky
  • [x] You can access DB servers on root cluster
  • [x] You can access DB servers on leaf cluster
  • [x] If you change your IP you no longer can access DB servers.
• Verify that it works for App Access @mdwn
  • [x] You can access App service on root cluster
  • [x] You can access App service on leaf cluster
  • [x] If you change your IP you no longer can access App services.
• Verify that it works for Desktop Access @ibeckermayer
  • [x] You can access Desktop service on root cluster
  • [x] You can access Desktop service on leaf cluster
  • [x] If you change your IP you no longer can access Desktop services.

Documentation @ptgott @alexfornuto

Checks should be performed on the version of documentation corresponding to the major release we're testing for. For example, for Teleport 12 release use branch/v12 branch and make sure to select "Version 12.0" in the documentation version switcher.

• [x] Verify installation instructions are accurate:

  • [x] Self-hosted: https://goteleport.com/docs/installation (@alexfornuto)
  • [x] Cloud: https://goteleport.com/docs/deploy-a-cluster/teleport-cloud/downloads/?scope=cloud ptgott

• [x] #25211

  • [x] OSS: https://goteleport.com/docs/deploy-a-cluster/open-source/
  • [x] Enterprise: https://goteleport.com/docs/deploy-a-cluster/teleport-enterprise/getting-started/?scope=enterprise
  • [x] Cloud: https://goteleport.com/docs/deploy-a-cluster/teleport-cloud/getting-started/?scope=cloud ptgott
  • [x] Helm: https://goteleport.com/docs/deploy-a-cluster/helm-deployments/kubernetes-cluster/?scope=enterprise ptgott

• [ ] Verify upcoming releases page is accurate:

  • [ ] https://goteleport.com/docs/preview/upcoming-releases/?scope=enterprise
  • [ ] Only exists for the default docs version. ptgott

• [x] Verify Teleport versions throughout documentation are correct and reflect upcoming release: ptgott

  In progress in this PR: https://github.com/gravitational/teleport/pull/25230

• [x] Verify that all necessary documentation for the release was backported to release branch ptgott:

  • [x] Diff between master and release branch and make sure there are no missed PRs

• [x] Verify deprecated Teleport versions are added to the older versions page ptgott

  • [x] https://goteleport.com/docs/older-versions/ In progress in this PR: https://github.com/gravitational/docs/pull/277

• [x] Verify gravitational/docs version configuration: ptgott:

  • [x] Verify latest version in gravitational/docs/config.json: in progress in this PR: https://github.com/gravitational/docs/pull/270
  • [x] Verify gravitational/docs/.gitmodules contains latest release In progress in this PR: https://github.com/gravitational/docs/pull/277

• [x] Verify changelog is up-to-date and complete for the default docs version:

  • [ ] https://goteleport.com/docs/changelog/

• [x] Verify supported versions table in FAQ ptgott:

  • [x] https://goteleport.com/docs/faq/#supported-versions PR in progress here: https://github.com/gravitational/teleport/pull/25215/files

Resources

Quick GitHub/SAML/OIDC Setup Tips

[hugoShaka]

Creating a Kubernetes join token returns no message: https://github.com/gravitational/teleport/issues/24733

[nklaassen]

~Web UI has no favicon: https://github.com/gravitational/teleport/issues/24773~

Fixed

[nklaassen]

Agentless/OpenSSH guide doesn't work: https://github.com/gravitational/teleport/issues/24778

[Tener]

~public_addr no longer accepts https://: https://github.com/gravitational/teleport/issues/24796~

Fixed

[Joerger]

~Hardware Key support bug: https://github.com/gravitational/teleport/issues/24866~

And the fix: https://github.com/gravitational/teleport/pull/24867

[smallinsky]

Minor UX log entry issue for tsh db connect https://github.com/gravitational/teleport/issues/24879 cc: @GavinFrazar

[nklaassen]

~Can't SSH to agentless nodes from Web UI: https://github.com/gravitational/teleport/issues/24922~

Fixed

[Joerger]

Enhanced session recording does not capture disk events - looks like a known issue so I'm checking it as complete.

[nklaassen]

tsh proxy ssh tries to prompt for password on invalid login when stdin is not a terminal: https://github.com/gravitational/teleport/issues/24925

[capnspacehook]

~Forwarding SSH agent with OpenSSH to agentless node hangs on exit: https://github.com/gravitational/teleport/issues/24936~

Fixed

[rosstimothy]

~Proxy is unable to join the cluster when using the default Kube join mechanism in the Helm chart: https://github.com/gravitational/teleport/issues/24941~

Fixed

[nklaassen]

~tsh attempts relogin for "ambiguous host" errors: https://github.com/gravitational/teleport/issues/24943~

Fixed

[nklaassen]

scp to agentless nodes allowed in spite of RBAC denial: #24949

Fixed

[nklaassen]

YubiHSM2 SDK version 2023.01 not supported: #25017

[GavinFrazar]

~Trusted cluster OpenSSH tsh config incorrect config generation: #25018~

This is working as expected.

[Tener]

DynamoDB db access requires additional configuration which isn't mentioned in docs or handled by tsh: https://github.com/gravitational/teleport/issues/25063

[strideynet]

Can't openssh or Web SSH from root cluster to Agentless in leaf cluster (this request can be only executed by a proxy): https://github.com/gravitational/teleport/issues/25068

Fixed

[strideynet]

~Web SSH connections to an Agentless node do not show the node name in the session recordings list: https://github.com/gravitational/teleport/issues/25072~

Fixed

[strideynet]

Role impersonated certificates do not work with Agentless SSH proxy re-issuing https://github.com/gravitational/teleport/issues/25083

Fixed

[GavinFrazar]

agentless OpenSSH guide does not explain required permissions to create node resources: https://github.com/gravitational/teleport/issues/25129

[AntonAM]

~Proxy can't connect to the Auth when installing Teleport with helm chart #25149~

Fixed

[ibeckermayer]

Several UI bugs in Discover for Desktop Access

• https://github.com/gravitational/teleport/issues/25161
• https://github.com/gravitational/teleport/issues/25162
• https://github.com/gravitational/teleport/issues/25163

[Joerger]

~tsh ssh -J leaf.proxy.example.com leaf-node only works when root auth/proxy is shut down - https://github.com/gravitational/teleport/issues/25178~

Fixed

[ptgott]

Differences in docs pages between master and v13, including the git commits on master that aren't present in v13 for each page (I can't just use git log here because backport refs aren't identical to their source refs):

$ git diff --name-only origin/master origin/branch/v13 -- docs/pages | xargs -I{} bash -c '
git log --oneline origin/branch/v13..origin/master -- {}
'
59ebccb538 docs: Login Rule k8s operator docs (#23888)
59ebccb538 docs: Login Rule k8s operator docs (#23888)
bb1f9899c1 Alphabetize the GUI Client page (#25013)
3d17be5a1d docs: add information on viewing status and logs for systemd service (#25139)
59ebccb538 docs: Login Rule k8s operator docs (#23888)

Looks like these all have outstanding backports, so I think all is good.

[ptgott]

@alexfornuto @avatus What do you think is the best way right now to ensure that the "Upcoming Releases" page only exists for the default docs version?

We could add a redirect from /preview/upcoming-releases/ to https://goteleport.com/docs/preview/upcoming-releases in the non-default branches, but that will quickly become difficult to maintain (unless we change the test plan to be really specific about what we need to change with each release).

Another option is deleting this page for non-default versions and not adding a redirect, but that might lead to 404s.

[rosstimothy]

etcd 10k Test

etcd Metrics

Teleport Metrics

Network Metrics

Soak Test

> tsh bench --duration=30m ssh root@node-agents-6dcccfd8df-22rfr-01 ls

* Requests originated: 17998
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         195 ms
50         227 ms
75         284 ms
90         354 ms
95         403 ms
99         548 ms
100        1353 ms

> tsh bench --duration=30m ssh --random root@all ls

* Requests originated: 17998
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         229 ms
50         258 ms
75         301 ms
90         354 ms
95         397 ms
99         533 ms
100        2475 ms

> tsh bench --duration=30m ssh root@foo=bar ls

* Requests originated: 17982
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         719 ms
50         1294 ms
75         4591 ms
90         18735 ms
95         24047 ms
99         28415 ms
100        35935 ms

Firestore 10k Test

Teleport Metrics

Network Metrics

Issues

• Joining several thousand instances at once takes longer for all instances to successfully join. https://github.com/gravitational/teleport/issues/25154
• Cycling auth servers while all 10k nodes were joined revealed that there may be connections leaked from joining. After all instances reconnected to Auth the Proxy had far fewer connections, goroutines, and consumed less memory. Auth was stopped ~16:20 and started ~16:50 in the etcd graphs. Auth was stopped ~22:08 and started ~22:18 in the Firestore graphs. https://github.com/gravitational/teleport/issues/25235
• Benchmarks were performed on Cloud but due to https://github.com/gravitational/teleport/issues/25165 the results were very inconsistent.

[ptgott]

I've suggested some edits to the teleport-cluster Helm guide in the course of testing it: https://github.com/gravitational/teleport/pull/25287

[ptgott]

In the Teleport Enterprise Cloud Getting Started guide, v13 has some UI differences from v12 for adding servers (including light mode), but I'm not going to update the screenshots this week since I have some higher-priority items to take care of. The overall server registration flow shown in the guide still works as intended.

[hugoShaka]

Outdated OneLogin screenshot: https://github.com/gravitational/teleport/pull/25290

[hugoShaka]

Bucket ACL issues with terraform: https://github.com/gravitational/teleport/pull/25113

[flyinghermit]

~tsh ssh returns ambiguous EOF error when devices are locked : https://github.com/gravitational/teleport.e/issues/1240~

Fixed

[rosstimothy]

~tsh ssh and tsh ls not working when cluster is upgraded to alpha.2: https://github.com/gravitational/teleport/issues/25365~

Fixed

[capnspacehook]

Using OpenSSH ssh to connect to leaf agentless nodes results in hostkey warning: https://github.com/gravitational/teleport/issues/25511

[capnspacehook]

joining agentless moderated sessions doesn't work: https://github.com/gravitational/teleport/issues/25522

Working as expected

[capnspacehook]

creating moderated sessions for a leaf node is not enforced: https://github.com/gravitational/teleport/issues/25557

[fspmarshall]

Dynamo Loadtesting

10k Tunnel Node Scaling

10k Direct Dial Node Scaling

500 Trusted Cluster Scaling

note: Elevated CPU is presumed to be due to a cache bug that was causing frequent recents of the "remote proxy" cache, and will be fixed in the final v13 release.

Benchmarks (1k Nodes)

Tunnel bench:

tsh bench ssh --duration=30m root@node-agents-77ff5cb7c7-zspkf-19 ls

* Requests originated: 17999
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         118 ms                                                                                                                 
50         127 ms
75         136 ms           
90         140 ms   
95         143 ms
99         155 ms
100        6839 ms

Tunnel Random:

tsh bench ssh --duration=30m --random root@all ls

* Requests originated: 17999
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         123 ms
50         130 ms
75         140 ms
90         150 ms
95         159 ms
99         187 ms
100        6823 ms

Label-Based:

tsh bench ssh --duration=30m root@fullname=node-agents-77ff5cb7c7-zxxg4-19 ls

* Requests originated: 17999
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         164 ms
50         172 ms
75         179 ms           
90         187 ms           
95         192 ms
99         209 ms
100        6859 ms

Direct Dial:

tsh bench ssh --duration=30m root@node-agents-77ff5cb7c7-zsw4p-19 ls

* Requests originated: 17999
* Requests failed: 0

Histogram

Percentile Response Duration
---------- -----------------
25         108 ms
50         113 ms
75         116 ms
90         126 ms           
95         133 ms           
99         145 ms
100        6803 ms