TPMLIB_SetState(3)

💅 TPMLIB_SetState(3) — bestie, we’re managing TPM state now 💅

okay so this is the libtpms page for TPMLIB_SetState and TPMLIB_GetState. It’s giving “state blobs have rules,” and honestly? We’re gonna respect them. 🫶

🌸 NAME 🌸

• TPMLIB_SetState — set the TPM’s volatile, permanent, or save state
• TPMLIB_GetState — get the TPM’s volatile, permanent, or save state

📚 LIBRARY 📚

TPM library (libtpms, -ltpms) — yes, link it like that, bestie. ✨

✨ SYNOPSIS ✨

Include the header first, obviously:

#include <libtpms/tpm_library.h>

TPM_RESULT TPMLIB_SetState(enum TPMLIB_StateType st,
                           const unsigned char *buffer, uint32_t buflen);

TPM_RESULT TPMLIB_GetState(enum TPMLIB_StateType st,
                           unsigned char **buffer, uint32_t *buflen);

💖 DESCRIPTION 💖

🎀 TPMLIB_SetState() — the setter 🎀

So TPMLIB_SetState() lets you set one of the state blobs of the TPM. The state blob you pass in gets tested to see whether it can be accepted, and if it can’t be accepted, you get a TPM error code back. No cap. 😭

If it is accepted, that state blob will be passed to the TPM upon TPM_MainInit(). Also, setting a state blob hides a file that may contain the same type of blob and would be read otherwise. And here’s the required bit: you have to call this function with a NULL pointer for the buffer parameter to hide a state blob in a file. That’s not a suggestion, bestie — it’s required. 💅

You can only set the state blobs after TPMLIB_ChooseTPMVersion() has been called. Also, all state blobs are cleared when a different version of TPM is chosen using TPMLIB_ChooseTPMVersion, or when a call to TPMLIB_SetState() fails because a state blob could not be accepted. So yeah, failure has consequences. 💀

⚠️ The order in which state blobs are set is important. The first state blob has to be the one representing the TPM’s permanent state. Only after that can either the volatile or save state blobs be set. Do not freestyle this order, okay? 🙈

🦋 TPMLIB_GetState() — the getter 🦋

TPMLIB_GetState() lets you get the current state of the TPM. For as long as the TPM has not been started, this function either returns the state blob previously set with TPMLIB_SetState() or the state is read from a file. Once the TPM has been started, the state of the running TPM is returned. Slay. ✨

About TPMLIB_STATE_SAVE_STATE (the save state type): this type of TPM state can be set with this function. The same state blob will be returned until TPM_Startup(ST_STATE) has been called, after which an empty blob will be returned. This blob can also only be read after TPM_SaveState() has been sent to the TPM. iykyk. 🧚

👑 SEE ALSO 👑

• TPMLIB_ChooseTPMVersion(3)
• TPMLIB_MainInit(3)
• TPMLIB_Terminate(3)

---

signed, sealed, delivered by libtpms on 2026-01-02 — that’s the whole page, bestie 💌🫶