1tpm2_getcap(1)              General Commands Manual             tpm2_getcap(1)
2
3
4

NAME

6       tpm2_getcap(1) - Display TPM capabilities in a human readable form.
7

SYNOPSIS

9       tpm2_getcap [OPTIONS]
10

DESCRIPTION

12       tpm2_getcap(1)  -  Query the TPM for it's capabilities / properties and
13       dump them to the console.  This is a thin wrapper around  the  GetCapa‐
14       bility command.
15

OPTIONS

17       · -c,  –capability=CAPABILITY_NAME: The name of the capability group to
18         query.  Currently supported capability groups are:
19
20         · properties-fixed: Display fixed TPM properties.
21
22         · properties-variable: Display variable TPM properties.
23
24         · algorithms: Display data about supported algorithms.
25
26         · commands: Display data about supported commands.
27
28         · ecc-curves: Display data about elliptic curves.
29
30         · handles-transient: Display handles about transient objects.
31
32         · handles-persistent: Display handles about persistent objects.
33
34         · handles-permanent: Display handles about permanent objects.
35
36         · handles-pcr: Display handles about PCRs.
37
38         · handles-nv-index: Display handles about NV Indices.
39
40         · handles-loaded-session: Display handles about both loaded HMAC  and
41           policy sessions.
42
43         · handles-saved-session: Display handles about saved sessions.
44

COMMON OPTIONS

46       This  collection of options are common to many programs and provide in‐
47       formation that many users may expect.
48
49       · -h, –help: Display the tools manpage.  This requires the manpages  to
50         be installed or on MANPATH, See man(1) for more details.
51
52       · -v,  –version:  Display  version information for this tool, supported
53         tctis and exit.
54
55       · -V, –verbose: Increase the information that the tool  prints  to  the
56         console  during  its  execution.  When using this option the file and
57         line number are printed.
58
59       · -Q, –quiet: Silence normal tool output to stdout.
60
61       · -Z, –enable-errata: Enable the application of errata fixups.   Useful
62         if  an  errata fixup needs to be applied to commands sent to the TPM.
63         # TCTI ENVIRONMENT
64
65       This collection of environment variables that may be used to  configure
66       the various TCTI modules available.
67
68       The  values  passed  through  these  variables  can  be overridden on a
69       per-command basis using the available command line options, see the TC‐
70       TI_OPTIONS section.
71
72       The variables respected depend on how the software was configured.
73
74       · TPM2TOOLS_TCTI_NAME:  Select the TCTI used for communication with the
75         next component down the TSS stack.  In most configurations this  will
76         be  the  TPM but it could be a simulator or proxy.  The current known
77         TCTIs are:
78
79         · tabrmd   -   The    new    resource    manager,    called    tabrmd
80           (https://github.com/01org/tpm2-abrmd).
81
82         · socket  -  Typically used with the old resource manager, or talking
83           directly to a simulator.
84
85         · device - Used when talking directly to a TPM device file.
86
87       · TPM2TOOLS_DEVICE_FILE: When using the device TCTI,  specify  the  TPM
88         device file.  The default is “/dev/tpm0”.
89
90         Note:  Using  the tpm directly requires the users to ensure that con‐
91         current access does not occur and that they manage the tpm resources.
92         These  tasks  are  usually managed by a resource manager.  Linux 4.12
93         and greater supports an in kernel resource manager  at  “/dev/tpmrm”,
94         typically “/dev/tpmrm0”.
95
96       · TPM2TOOLS_SOCKET_ADDRESS: When using the socket TCTI, specify the do‐
97         main name or IP address used.  The default is 127.0.0.1.
98
99       · TPM2TOOLS_SOCKET_PORT: When using the socket TCTI, specify  the  port
100         number used.  The default is 2321.
101

TCTI OPTIONS

103       This  collection  of options are used to configure the varous TCTI mod‐
104       ules available.  They override any environment variables.
105
106       · -T, –tcti=TCTI_NAME[:TCTI_OPTIONS]: Select the TCTI used for communi‐
107         cation  with the next component down the TSS stack.  In most configu‐
108         rations   this    will    be    the    resource    manager:    tabrmd
109         (https://github.com/01org/tpm2-abrmd)  Optionally,  tcti specific op‐
110         tions can appended to TCTI_NAME by appending a : to TCTI_NAME.
111
112         · For the device TCTI, the TPM device file for use by the device TCTI
113           can  be  specified.   The  default  is  /dev/tpm0.  Example: -T de‐
114           vice:/dev/tpm0
115
116         · For the socket TCTI, the domain name or IP address and port  number
117           used by the socket can be specified.  The default are 127.0.0.1 and
118           2321.  Example: -T socket:127.0.0.1:2321
119
120         · For the abrmd TCTI, it takes no options.  Example: -T abrmd
121

EXAMPLES

123              tpm2_getcap --capability="properties-fixed"
124

RETURNS

126       0 on success or 1 on failure.
127

BUGS

129       Github Issues (https://github.com/01org/tpm2-tools/issues)
130

HELP

132       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
133
134
135
136tpm2-tools                      SEPTEMBER 2017                  tpm2_getcap(1)