Skip to content

Commit

Permalink
Add docs for hardware keys in Connect
Browse files Browse the repository at this point in the history
  • Loading branch information
gzdunek committed Nov 5, 2024
1 parent 83b1d23 commit 3def1fb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
Binary file added docs/img/use-teleport/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/pages/connect-your-client/teleport-connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,27 @@ The application connection tab shows an example command that can be used to quer
Requests sent under the displayed address will be proxied through an authenticated tunnel to the
application.

## Hardware key support

Teleport Connect supports authenticating with hardware-based keys.
Keys are generated and stored directly on a hardware device, providing greater security than storing
them on a file system. For more details, see [Hardware Key Support guide](../admin-guides/access-controls/guides/hardware-key-support.mdx).

<Admonition type="note" title="PIV support">
Hardware key support requires users to use a PIV-compatible hardware key.
Currently, this feature is only guaranteed to support YubiKey series 5+.
</Admonition>

To log in with a hardware key, your role or cluster configuration must enable it.
Once enforced, Teleport Connect will require you to keep the hardware key plugged in and may also prompt for a tap and/or PIV PIN:

![Logging in with a hardware key](../../img/use-teleport/[email protected])

When logging in for the first time, you’ll be prompted to log in again immediately.

If your key is set to the default PIV PIN, you may be prompted to change it at this step.
Entering a default or empty PIN will open a dialog to update it.

## Connecting to multiple clusters

Teleport Connect allows you to log in to multiple clusters at the same time. After logging in to
Expand Down

0 comments on commit 3def1fb

Please sign in to comment.