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

NAME

6       tpm2_listpersistent(1) - Display all defined persistent objects.
7

SYNOPSIS

9       tpm2_listpersistent [OPTIONS] FILE
10

DESCRIPTION

12       tpm2_listpersistent(1) - display all defined persistent objects.
13

OPTIONS

15       These options for listing the persistent objects:
16
17       · -g,  –halg=ALGORITHM: Only display persistent objects using this hash
18         algorithm.  Algorithms should follow the " formatting standards,  see
19         section  “Algorithm  Specifiers”.   Also, see section “Supported Hash
20         Algorithms” for a list of supported hash algorithms.
21
22       · -G, –kalg=KEY_ALGORITHM: Only display persistent objects  using  this
23         key  algorithm.   It accepts friendly names just like -g option.  See
24         section “Supported Public Object Algorithms” for a list of  supported
25         object algorithms.
26

COMMON OPTIONS

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

TCTI OPTIONS

85       This  collection  of options are used to configure the varous TCTI mod‐
86       ules available.  They override any environment variables.
87
88       · -T, –tcti=TCTI_NAME[:TCTI_OPTIONS]: Select the TCTI used for communi‐
89         cation  with the next component down the TSS stack.  In most configu‐
90         rations   this    will    be    the    resource    manager:    tabrmd
91         (https://github.com/01org/tpm2-abrmd)  Optionally,  tcti specific op‐
92         tions can appended to TCTI_NAME by appending a : to TCTI_NAME.
93
94         · For the device TCTI, the TPM device file for use by the device TCTI
95           can  be  specified.   The  default  is  /dev/tpm0.  Example: -T de‐
96           vice:/dev/tpm0
97
98         · For the socket TCTI, the domain name or IP address and port  number
99           used by the socket can be specified.  The default are 127.0.0.1 and
100           2321.  Example: -T socket:127.0.0.1:2321
101
102         · For the abrmd TCTI, it takes no options.  Example: -T abrmd
103

Supported Hash Algorithms

105       Supported hash algorithms are:
106
107       · 0x4 or sha1 for TPM_ALG_SHA1 (default)
108
109       · 0xB or sha256 for TPM_ALG_SHA256
110
111       · 0xC or sha384 for TPM_ALG_SHA384
112
113       · 0xD or sha512 for TPM_ALG_SHA512
114
115       · 0x12 or sm3_256 for TPM_ALG_SM3_256
116
117       NOTE: Your TPM may not support all algorithms.
118

Supported Public Object Algorithms

120       Supported public object algorithms are:
121
122       · 0x1 or rsa for TPM_ALG_RSA (default).
123
124       · 0x8 or keyedhash for TPM_ALG_KEYEDHASH.
125
126       · 0x23 or ecc for TPM_ALG_ECC.
127
128       · 0x25 or symcipher for TPM_ALG_SYMCIPHER.
129
130       NOTE: Your TPM may not support all algorithms.
131

Algorithm Specfiers

133       Options that take algorithms support “nice-names”.   Nice  names,  like
134       sha1 can be used in place of the raw hex for sha1: 0x4.  The nice names
135       are converted by stripping the leading TPM_ALG_ from the Algorithm Name
136       field  and  converting it to lower case.  For instance TPM_ALG_SHA3_256
137       becomes sha3_256.
138
139       The algorithms can be found at:  <https://trustedcomputinggroup.org/wp-
140       content/uploads/TCG_Algorithm_Registry_Rev_1.24.pdf>
141

EXAMPLES

143              tpm2_listpersistent
144              tpm2_listpersistent -g sha256 -G ecc
145

RETURNS

147       0 on success or 1 on failure.
148

BUGS

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

HELP

153       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
154
155
156
157tpm2-tools                      SEPTEMBER 2017          tpm2_listpersistent(1)
Impressum