libtpms/man/man3/TPMLIB_GetInfo.pod
Stefan Berger fe481765b9 Add TPMAttributes JSON object to GetInfo interface
Requesting TPMLIB_INFO_TPMATTRIBUTES returns:

{
  "TPMAttributes": {
    "manufacturer": "id:00001014",
    "version": "id:00740001",
    "model": "swtpm"
  }
}

Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
2018-05-04 19:36:05 -04:00

47 lines
1.1 KiB
Plaintext

=head1 NAME
TPMLIB_GetInfo - Get Information about the TPM implementation
=head1 LIBRARY
TPM library (libtpms, -ltpms)
=head1 SYNOPSIS
B<#include <libtpms/tpm_library.h>>
B<char *TPMLIB_GetInfo(TPMLIB_InfoFlags flags);>
=head1 DESCRIPTION
The B<TPMLIB_GetInfo()> function allows to query for TPM implementation
specifics and get a JSON string in return. Which data is to be returned
can be specified in the flags parameter that may be a logical 'or' concatenation
of flags. If passed flags are not supported, nothing is returned . If a 0 is
passed in, an empty JSON Object '{}' is returned.
The following flags are defined and return JSON objects as shown:
=over 4
=item B<TPMLIB_INFO_TPMSPECIFICATION>
{"TPMSpecification":{"family":"1.2","level":2,"revision":116}}
=item B<TPMLIB_INFO_TPMATTRIBUTES>
{"TPMAttributes":{"manufacturer":"id:00001014","version":"id:00740001","model":"swtpm"}}
=back
=head1 RETURN VALUE
This function returns a JSON string on success and a NULL pointer if a memory
allocation failure occurred.
The caller must free() the returned string.
=head1 SEE ALSO
=cut