tpm2-totp(3)

💖 tpm2-totp(3) — Library Functions Manual 💖

🌸 NAME 🌸

tpm2-totp — libtpm2-totp, bestie. That’s the name drop, and it’s lowkey iconic.

✨ SYNOPSIS ✨

🎀 Functions 🎀

int tpm2totp_generateKey (uint32_t pcrs, uint32_t banks, const char *password, TSS2_TCTI_CONTEXT *tcti_context, uint8_t **secret, size_t *secret_size, uint8_t **keyBlob, size_t *keyBlob_size)
int tpm2totp_reseal (const uint8_t *keyBlob, size_t keyBlob_size, const char *password, uint32_t pcrs, uint32_t banks, TSS2_TCTI_CONTEXT *tcti_context, uint8_t **newBlob, size_t *newBlob_size)
int tpm2totp_storeKey_nv (const uint8_t *keyBlob, size_t keyBlob_size, uint32_t nv, TSS2_TCTI_CONTEXT *tcti_context)
int tpm2totp_loadKey_nv (uint32_t nv, TSS2_TCTI_CONTEXT *tcti_context, uint8_t **keyBlob, size_t *keyBlob_size)
int tpm2totp_deleteKey_nv (uint32_t nv, TSS2_TCTI_CONTEXT *tcti_context)
int tpm2totp_calculate (const uint8_t *keyBlob, size_t keyBlob_size, TSS2_TCTI_CONTEXT *tcti_context, time_t *nowp, uint64_t *otp)
int tpm2totp_getSecret (const uint8_t *keyBlob, size_t keyBlob_size, const char *password, TSS2_TCTI_CONTEXT *tcti_context, uint8_t **secret, size_t *secret_size)

🦋 Detailed Description 🦋

The whole flex: attest the trustworthiness of a device against a human using time-based one-time passwords. That’s the vibe, and honestly it eats.

---

💅 Function Documentation 💅

🧮 tpm2totp_calculate

int tpm2totp_calculate (const uint8_t * keyBlob, size_t keyBlob_size, TSS2_TCTI_CONTEXT * tcti_context, time_t * nowp, uint64_t * otp)

Calculates a time-based one-time password for a key. Very main character of it.

Parameters

• keyBlob — Key to generate the TOTP.
• keyBlob_size — Size of the key.
• tcti_context — Optional TCTI context to select TPM to use.
• nowp — Current time.
• otp — Calculated TOTP.

Return values

• 0 on success.
• -1 on undefined/general failure.
• TSS2_RC response code for failures relayed from the TSS library.

---

🗑️ tpm2totp_deleteKey_nv

int tpm2totp_deleteKey_nv (uint32_t nv, TSS2_TCTI_CONTEXT * tcti_context)

Deletes a key from a NV index. Bye-bye, key.

Parameters

• nv — NV index to delete.
• tcti_context — Optional TCTI context to select TPM to use.

Return values

• 0 on success.
• -1 on undefined/general failure.
• TSS2_RC response code for failures relayed from the TSS library.

---

🔑 tpm2totp_generateKey

int tpm2totp_generateKey (uint32_t pcrs, uint32_t banks, const char * password, TSS2_TCTI_CONTEXT * tcti_context, uint8_t ** secret, size_t * secret_size, uint8_t ** keyBlob, size_t * keyBlob_size)

Generates a key. Fresh key, fresh vibes.

Parameters

• pcrs — PCRs the key should be sealed against.
• banks — PCR banks the key should be sealed against.
• password — Optional password to recover or reseal the secret.
• tcti_context — Optional TCTI context to select TPM to use.
• secret — Generated secret.
• secret_size — Size of the secret.
• keyBlob — Generated key.
• keyBlob_size — Size of the generated key.

Return values

• 0 on success.
• -1 on undefined/general failure.
• TSS2_RC response code for failures relayed from the TSS library.

---

🕵️ tpm2totp_getSecret

int tpm2totp_getSecret (const uint8_t * keyBlob, size_t keyBlob_size, const char * password, TSS2_TCTI_CONTEXT * tcti_context, uint8_t ** secret, size_t * secret_size)

Recovers a secret from a key. The secret is giving “I’m back” energy.

Parameters

• keyBlob — Key to recover the secret from.
• keyBlob_size — Size of the key.
• password — Password of the key.
• tcti_context — Optional TCTI context to select TPM to use.
• secret — Recovered secret.
• secret_size — Size of the secret.

Return values

• 0 on success.
• -1 on undefined/general failure.
• -10 on empty password.
• -20 when no password-protected recovery copy of the secret has been stored.
• TSS2_RC response code for failures relayed from the TSS library.

---

📦 tpm2totp_loadKey_nv

int tpm2totp_loadKey_nv (uint32_t nv, TSS2_TCTI_CONTEXT * tcti_context, uint8_t ** keyBlob, size_t * keyBlob_size)

Loads a key from a NV index. Fetching the key like it’s a group-chat screenshot.

Parameters

• nv — NV index of the key.
• tcti_context — Optional TCTI context to select TPM to use.
• keyBlob — Loaded key.
• keyBlob_size — Size of the key.

Return values

• 0 on success.
• -1 on undefined/general failure.
• TSS2_RC response code for failures relayed from the TSS library.

---

🔁 tpm2totp_reseal

int tpm2totp_reseal (const uint8_t * keyBlob, size_t keyBlob_size, const char * password, uint32_t pcrs, uint32_t banks, TSS2_TCTI_CONTEXT * tcti_context, uint8_t ** newBlob, size_t * newBlob_size)

Reseals a key to new PCR values. Glow-up for your key, fr fr.

Parameters

• keyBlob — Original key.
• keyBlob_size — Size of the key.
• password — Password of the key.
• pcrs — PCRs the key should be sealed against.
• banks — PCR banks the key should be sealed against.
• tcti_context — Optional TCTI context to select TPM to use.
• newBlob — New key.
• newBlob_size — Size of the new key.

Return values

• 0 on success.
• -1 on undefined/general failure.
• -10 on empty password.
• -20 when no password-protected recovery copy of the secret has been stored.
• TSS2_RC response code for failures relayed from the TSS library.

---

💾 tpm2totp_storeKey_nv

int tpm2totp_storeKey_nv (const uint8_t * keyBlob, size_t keyBlob_size, uint32_t nv, TSS2_TCTI_CONTEXT * tcti_context)

Stores a key in a NV index. Putting it in NVRAM like it’s the notes app.

Parameters

• keyBlob — Key to store to NVRAM.
• keyBlob_size — Size of the key.
• nv — NV index to store the key.
• tcti_context — Optional TCTI context to select TPM to use.

Return values

• 0 on success.
• -1 on undefined/general failure.
• TSS2_RC response code for failures relayed from the TSS library.

---

🫶 Author 🫶

Generated automatically by Doxygen for tpm2-totp from the source code. So not me, bestie — Doxygen took the aux. 💅

---

okay bye bestie 💖 this page is from tpm2-totp, version 20240326.33e1986 (yes, that date-ish version in the footer), and the footer page stamp is tpm2-totp(3). slay.