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

NAME

6       tpm2_rc_decode(1) - Decode TPM2 error codes to human readable format.
7

SYNOPSIS

9       tpm2_rc_decode [OPTIONS] RC_CODE
10

DESCRIPTION

12       tpm2_rc_decode(1)  converts  RC_CODE originating from the SAPI and TCTI
13       into human readable errors.  Analogous to strerror(3), but for the tpm2
14       stack.
15

OPTIONS

17       This tool takes no tool specific options.
18

COMMON OPTIONS

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

TCTI OPTIONS

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

EXAMPLES

97              tpm2_rc_decode 0x100
98

RETURNS

100       0 on success or 1 on failure.
101

BUGS

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

HELP

106       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
107
108
109
110tpm2-tools                      SEPTEMBER 2017               tpm2_rc_decode(1)
Impressum