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

NAME

6       tpm2_startup(1) - Send a startup command to the TPM.
7

SYNOPSIS

9       tpm2_startup [OPTIONS]
10

DESCRIPTION

12       tpm2_startup(1) Send a TPM2_Startup command with either TPM_SU_CLEAR or
13       TPM_SU_STATE.
14
15       NOTE: Typically a Resource Manager or low-level/boot software will have
16       already sent this command.
17

OPTIONS

19       · -c, –clear:
20
21         Startup type sent will be TPM_SU_CLEAR instead of TPM2_SU_STATE.
22

COMMON OPTIONS

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

TCTI OPTIONS

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

EXAMPLES

101              tpm2_startup
102              tpm2_startup -c
103

RETURNS

105       0 on success or 1 on failure.
106

BUGS

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

HELP

111       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
112
113
114
115tpm2-tools                      SEPTEMBER 2017                 tpm2_startup(1)