mirror of
https://github.com/stefanberger/libtpms
synced 2026-01-08 12:24:40 +00:00
a0098eda2d
This is the initial import of the libtpms library. The libtpms library provides software emulation of a Trusted Platform Module (TPM). It is intended to be used by applications when a hardware TPM is not adequate. For example, a hypervisor can use libtpms to emulate an independent TPM for each of it's virtual machine guests. The library provides a high- level API for developers to integrate the emulated TPM support into their application. The code was originally written by Kenneth Goldman <kgoldman@us.ibm.com> and Stefan Berger <stefanb@us.ibm.com>. The code is licensed under the Modified BSD License. Signed-off-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
248 lines
7.8 KiB
Groff
248 lines
7.8 KiB
Groff
.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "TPMLIB_GETTPMPROPERTY 1"
|
|
.TH TPMLIB_GETTPMPROPERTY 1 "2011-03-24" "libtpms-0.5.1" "libtpms documentation"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
TPMLIB_GetTPMProperty \- Get a runtime property of the TPM
|
|
.SH "LIBRARY"
|
|
.IX Header "LIBRARY"
|
|
\&\s-1TPM\s0 library (libtpms, \-ltpms)
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fB#include <libtpms/tpm_library.h\fR>
|
|
.PP
|
|
\&\fB\s-1TPM_RESULT\s0 TPMLIB_GetTPMProperty(enum TPMLIB_TPMProperty, int *result);\fR
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fB\f(BITPMLIB_GetTPMProperty()\fB\fR call is used to retrieve run-time parameters
|
|
of the \s-1TPM\s0 such as the number of authorization sessions it can hold or
|
|
the maximum sizes of the permanent state, savestate or volatile state blobs.
|
|
.PP
|
|
This function can be called before or after the \s-1TPM\s0 has been created.
|
|
The current implementation of libtpms will return the same value before
|
|
and after the \s-1TPM\s0 was started.
|
|
.PP
|
|
The following properties have been defined:
|
|
.IP "\fB\s-1TPMPROP_TPM_RSA_KEY_LENGTH_MAX\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_RSA_KEY_LENGTH_MAX"
|
|
The maximum size of an \s-1RSA\s0 key.
|
|
.IP "\fB\s-1TPMPROP_TPM_BUFFER_MAX\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_BUFFER_MAX"
|
|
The maximum sizes of the \s-1TPM\s0 command and result buffers.
|
|
.IP "\fB\s-1TPMPROP_TPM_KEY_HANDLES\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_KEY_HANDLES"
|
|
The number of key slots.
|
|
.IP "\fB\s-1TPMPROP_TPM_OWNER_EVICT_KEY_HANDLES\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_OWNER_EVICT_KEY_HANDLES"
|
|
The number of owner-evict keys.
|
|
.IP "\fB\s-1TPMPROP_TPM_MIN_AUTH_SESSIONS\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MIN_AUTH_SESSIONS"
|
|
The number of authorization sessions.
|
|
.IP "\fB\s-1TPMPROP_TPM_MIN_TRANS_SESSIONS\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MIN_TRANS_SESSIONS"
|
|
The number of transport sessions.
|
|
.IP "\fB\s-1TPMPROP_TPM_MIN_DAA_SESSIONS\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MIN_DAA_SESSIONS"
|
|
The number of \s-1DAA\s0 sessions.
|
|
.IP "\fB\s-1TPMPROP_TPM_MIN_SESSION_LIST\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MIN_SESSION_LIST"
|
|
The size of the session list.
|
|
.IP "\fB\s-1TPMPROP_TPM_MIN_COUNTERS\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MIN_COUNTERS"
|
|
The number of monotonic counters.
|
|
.IP "\fB\s-1TPMPROP_TPM_NUM_FAMILY_TABLE_ENTRY_MIN\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_NUM_FAMILY_TABLE_ENTRY_MIN"
|
|
The number of family entries.
|
|
.IP "\fB\s-1TPMPROP_TPM_NUM_DELEGATE_TABLE_ENTRY_MIN\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_NUM_DELEGATE_TABLE_ENTRY_MIN"
|
|
The number of delegate entries.
|
|
.IP "\fB\s-1TPMPROP_TPM_SPACE_SAFETY_MARGIN\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_SPACE_SAFETY_MARGIN"
|
|
The space saftey margin used for the worst-case sizes of the savestate and
|
|
volatile state blobs. This safety marging is not used for the size of the
|
|
permanent data blob.
|
|
.IP "\fB\s-1TPMPROP_TPM_MAX_NV_SPACE\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MAX_NV_SPACE"
|
|
The maximum size of the permanent data blob.
|
|
.IP "\fB\s-1TPMPROP_TPM_MAX_SAVESTATE_SPACE\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MAX_SAVESTATE_SPACE"
|
|
The maximum size of the savestate blob (includes the space safety margin).
|
|
.IP "\fB\s-1TPMPROP_TPM_MAX_VOLATILESTATE_SPACE\s0\fR" 4
|
|
.IX Item "TPMPROP_TPM_MAX_VOLATILESTATE_SPACE"
|
|
The maximum size of the volatile state blob (includes the space saferty
|
|
margin).
|
|
.SH "ERRORS"
|
|
.IX Header "ERRORS"
|
|
.IP "\fB\s-1TPM_SUCCESS\s0\fR" 4
|
|
.IX Item "TPM_SUCCESS"
|
|
The function completed sucessfully.
|
|
.IP "\fB\s-1TPM_FAIL\s0\fR" 4
|
|
.IX Item "TPM_FAIL"
|
|
An undefined property was queried.
|
|
.PP
|
|
For a complete list of \s-1TPM\s0 error codes please consult the include file
|
|
\&\fBlibtpms/tpm_error.h\fR
|
|
.SH "EXAMPLE"
|
|
.IX Header "EXAMPLE"
|
|
.Vb 1
|
|
\& #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.\en");
|
|
\& 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.\en");
|
|
\& goto err_exit;
|
|
\& }
|
|
\&
|
|
\& fprintf(stdout, "Max. size of RSA keys: %d\en", result);
|
|
\&
|
|
\& err_exit:
|
|
\& TPMLIB_Terminate();
|
|
\&
|
|
\& return 0;
|
|
\& }
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fBTPMLIB_MainInit\fR(3), \fBTPMLIB_Terminate\fR(3),
|
|
\&\fBTPMLIB_Process\fR(3), \fBTPMLIB_RegisterCallbacks\fR(3), \fBTPMLIB_GetVersion\fR(3)
|