TPMLIB_GetTPMProperty(3)

πŸ’– TPMLIB_GetTPMProperty(3) β€” NAME πŸ’–

okay bestie, this is the TPMLIB_GetTPMProperty(3) manual, and it's literally about getting a runtime property of the TPM. iconic little fetch quest, no cap. ✨


πŸ“š LIBRARY πŸ“š

TPM library (libtpms, -ltpms) 🫢


✨ SYNOPSIS ✨

#include <libtpms/tpm_library.h>

TPM_RESULT TPMLIB_GetTPMProperty(enum TPMLIB_TPMProperty, int *result);

πŸ’… DESCRIPTION πŸ’…

The TPMLIB_GetTPMProperty() call is your bestie for retrieving run-time parameters of the TPM β€” things like the number of authorization sessions it can hold, or the maximum sizes of the permanent state, savestate or volatile state blobs. it's giving "ask the TPM for its stats" energy. πŸ’–

This function can be called before or after the TPM has been created. The current implementation of libtpms will return the same value before and after the TPM was started. lowkey consistent, we love that.

With the introduction of the function TPMLIB_ChooseTPMVersion(), the call to this function should be executed after the TPM version has been chosen. The reason is that different TPM versions may return different values.

⚠️ version vibe check: different TPM versions may return different values, so the docs say to call this after TPMLIB_ChooseTPMVersion() has chosen the version. periodt.

The following properties have been defined:

  • TPMPROP_TPM_RSA_KEY_LENGTH_MAX β€” the maximum size of an RSA key. πŸ”
  • TPMPROP_TPM_BUFFER_MAX β€” the maximum sizes of the TPM command and result buffers.
  • TPMPROP_TPM_KEY_HANDLES β€” the number of key slots.
  • TPMPROP_TPM_OWNER_EVICT_KEY_HANDLES β€” the number of owner-evict keys.
  • TPMPROP_TPM_MIN_AUTH_SESSIONS β€” the number of authorization sessions.
  • TPMPROP_TPM_MIN_TRANS_SESSIONS β€” the number of transport sessions.
  • TPMPROP_TPM_MIN_DAA_SESSIONS β€” the number of DAA sessions.
  • TPMPROP_TPM_MIN_SESSION_LIST β€” the size of the session list.
  • TPMPROP_TPM_MIN_COUNTERS β€” the number of monotonic counters.
  • TPMPROP_TPM_NUM_FAMILY_TABLE_ENTRY_MIN β€” the number of family entries.
  • TPMPROP_TPM_NUM_DELEGATE_TABLE_ENTRY_MIN β€” the number of delegate entries.
  • TPMPROP_TPM_SPACE_SAFETY_MARGIN β€” the space safety margin used for the worst-case sizes of the savestate and volatile state blobs. This safety margin is not used for the size of the permanent data blob.
  • TPMPROP_TPM_MAX_NV_SPACE β€” the maximum size of the permanent data blob.
  • TPMPROP_TPM_MAX_SAVESTATE_SPACE β€” the maximum size of the savestate blob (includes the space safety margin).
  • TPMPROP_TPM_MAX_VOLATILESTATE_SPACE β€” the maximum size of the volatile state blob (includes the space safety margin).

😭 ERRORS 😭

  • TPM_SUCCESS β€” the function completed successfully. slay. πŸ’–
  • TPM_FAIL β€” an undefined property was queried. πŸ’€

For a complete list of TPM error codes please consult the include file libtpms/tpm_error.h.


🧚 EXAMPLE 🧚

#include <stdio.h>

#include <libtpms/tpm_library.h>
#include <libtpms/tpm_error.h>

int main(void) {
    TPM_RESULT res;
    int result;
    int rc = 0;

    if (TPMLIB_MainInit() != TPM_SUCCESS) {
        fprintf(stderr, "Could not start the TPM.\n");
        return 1;
    }

    if (TPMLIB_GetTPMProperty(TPMPROP_TPM_RSA_KEY_LENGTH_MAX, &result)
        != TPM_SUCCESS) {
        fprintf(stderr, "Could not read the max. size of RSA keys.\n");
        goto err_exit;
    }

    fprintf(stdout, "Max. size of RSA keys: %d\n", result);

err_exit:
    TPMLIB_Terminate();

    return 0;
}

🌈 SEE ALSO 🌈


that's the whole page, bestie 🫢 source/version: libtpms, date: 2026-01-02, page: TPMLIB_GetTPMProperty(3). literally iconic. πŸ’…βœ¨

πŸ“¦ where this page comes from