Scroll to navigation

TPMLIB_GetTPMProperty(3) TPMLIB_GetTPMProperty(3)

NAME

TPMLIB_GetTPMProperty - Get a runtime property of the TPM

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 used to retrieve run-time parameters of the TPM such as the number of authorization sessions it can hold or the maximum sizes of the permanent state, savestate or volatile state blobs.

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.

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.

The following properties have been defined:

The maximum size of an RSA key.
The maximum sizes of the TPM command and result buffers.
The number of key slots.
The number of owner-evict keys.
The number of authorization sessions.
The number of transport sessions.
The number of DAA sessions.
The size of the session list.
The number of monotonic counters.
The number of family entries.
The number of delegate entries.
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.
The maximum size of the permanent data blob.
The maximum size of the savestate blob (includes the space safety margin).
The maximum size of the volatile state blob (includes the space saferty margin).

ERRORS

The function completed successfully.
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

TPMLIB_MainInit(3), TPMLIB_Terminate(3), TPMLIB_Process(3), TPMLIB_RegisterCallbacks(3), TPMLIB_GetVersion(3), TPMLIB_ChooseTPMVersion(3)

2022-08-14 libtpms