Skip to content

Commit

Permalink
docs: mention teleport tpm identify command (#47734)
Browse files Browse the repository at this point in the history
This command is helpful for obtaining the info necessary to create
a join token for the TPM joining method.

Closes #45731
  • Loading branch information
zmb3 authored Oct 21, 2024
1 parent cac5a20 commit 1815f56
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/pages/includes/tpm-joining-background.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,21 @@ A Trusted Platform Module (TPM) is a secure, physical cryptoprocessor that is
installed on a host. TPMs can store cryptographic material and perform a number
of cryptographic operations, without exposing the cryptographic material to the
operating system. Each TPM has a unique key pair burned-in known as the
Endorsement Key (EK).
Endorsement Key (EK). This key does not change, even if the host operating
system is reinstalled.

Some TPMs also contain an X.509 certificate for this key pair that is signed by
the manufacturer's CA. This is known as the EK Certificate (EKCert). This
certificate can be used by the TPM to prove to a third-party (who trusts the
manufacturer's CA) that the TPM is genuine and abides by the TPM specification.

When using the `tpm` join method, you must first query the TPM's public key and
then create a join token that explicitly allows this public key. Even if the
host operating system is reinstalled, the EK public key will not change, meaning
that the TPM will still be usable to join your Teleport cluster. If you have a
large number of hosts, it may make sense to use automation tooling such as
ansible to query the TPMs across your fleet and then generate join tokens.
then create a join token that explicitly allows this public key. To list
information about the detected TPM, run the `teleport tpm identify` command.

If you have a large number of hosts, it may make sense to use automation tooling
such as Ansible to query the TPMs across your fleet and then generate join
tokens.

<Admonition type="warning">
The `tpm` join method is currently not compatible with FIPS 140-2.
Expand Down

0 comments on commit 1815f56

Please sign in to comment.