swtpm icon indicating copy to clipboard operation
swtpm copied to clipboard

missing user documentation

Open celesteking opened this issue 1 month ago • 1 comments

It's unclear how to start using this software, where to begin. Wiki outlines how to compile and install, but not how to use. It would be wonderful to have a user guide or a user manual. I see a collection of man pages, but that's inappropriate for someone just starting up, with no knowledge of how the components interconnect.

celesteking avatar Nov 08 '25 13:11 celesteking

We do have some documentation for swtpm, but it depends on what the expectations are. First, users would have to have a background on TPM 2 and what it is and what it does. With this knowledge, these wiki pages would help them how to use swtpm with a TSS 2 stack:

  • https://github.com/stefanberger/swtpm/wiki/Using-the-IBM-TSS-with-swtpm
  • https://github.com/stefanberger/swtpm/wiki/Using-the-Intel-TSS-with-swtpm

SuSE also provides documentation:

  • https://en.opensuse.org/Software_TPM_Emulator_For_QEMU

Most users will likely use a TPM 2 attached to a QEMU VM. There's QEMU-related documentation in QEMU:

  • https://gitlab.com/qemu-project/qemu/-/blob/master/docs/specs/tpm.rst

They can use swtpm with libvirt:

  • https://libvirt.org/formatdomain.html#tpm-device

stefanberger avatar Nov 09 '25 15:11 stefanberger