Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for hardware keys in Connect #48453

Merged
merged 3 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -438,6 +438,27 @@ installation directory to the `Path` user environment variable.
</TabItem>
</Tabs>

## 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.

## Configuration

Teleport Connect can be configured by editing the `app_config.json` file, which it creates on first launch.
Expand Down
Loading