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

NAME

6       tpm2_takeownership(1)  - Insert authorization values for the owner, en‐
7       dorsement and lockout authorizations.
8

SYNOPSIS

10       tpm2_takeownership [OPTIONS]
11

DESCRIPTION

13       tpm2_takeownership(1) - performs a hash operation on FILE  and  returns
14       the  results.   If FILE is not specified, then data is read from stdin.
15       If the results of the hash will be used in a signing operation that us‐
16       es  a  restricted signing key, then the ticket returned by this command
17       can indicate that the hash is safe to sign.
18

OPTIONS

20       · -o, –owner-password=OWNER_PASSWORD: The new owner authorization  val‐
21         ue.
22
23         Passwords  should  follow the password formatting standards, see sec‐
24         tion “Password Formatting”.
25
26       · -e, –endorse-password=ENDORSE_PASSWORD:
27
28         The new endorse authorization value.   Passwords  should  follow  the
29         same formatting requirements as the -o option.
30
31       · -l, –lockout-password=LOCKOUT_PASSWORD:
32
33         The new lockout authorization value.
34
35         The  new  endorse  authorization  value.  Passwords should follow the
36         same formatting requirements as the -o option.
37
38       · -O, –old-ownerPassword=OLD_OWNER_PASSWORD:
39
40         The old owner authorization value.  Passwords should follow the  same
41         formatting requirements as the -o option.
42
43       · -E, –old-endorsePassword=OLD_ENDORSE_PASSWORD:
44
45         The  old  endorse  authorization  value.  Passwords should follow the
46         same formatting requirements as the -o option.
47
48       · -L, –old-lockoutPassword=OLD_LOCKOUT_PASSWORD:
49
50         The old lockout authorization value.   Passwords  should  follow  the
51         same formatting requirements as the -o option.
52
53       · -c, –clear:
54
55         Clears  the  3 authorizations values with lockout auth, thus one must
56         specify -L.
57

COMMON OPTIONS

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

TCTI OPTIONS

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

Password Formatting

136       Passwords  are  interpreted  in  two  forms,  string and hex-string.  A
137       string password is not interpreted, and is directly used for authoriza‐
138       tion.   A  hex-string, is converted from a hexidecimal form into a byte
139       array form, thus allowing passwords with non-printable and/or  terminal
140       un-friendly characters.
141
142       By  default  passwords  are assumed to be in the string form.  Password
143       form is specified with special prefix values, they are:
144
145       · str: - Used to indicate it is a raw string.  Useful  for  escaping  a
146         password that starts with the “hex:” prefix.
147
148       · hex: - Used when specifying a password in hex string format.
149

EXAMPLES

151       Set owner, endorsement and lockout authorizations to an empty auth val‐
152       ue:
153
154              tpm2_takeownership -c -L oldlockoutpasswd
155
156       Set owner, endorsement and lockout authorizations to a new value:
157
158              tpm2_takeownership -o newo -e newe -l newl -O oldo -E olde -L oldl
159

RETURNS

161       0 on success or 1 on failure.
162

BUGS

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

HELP

167       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
168
169
170
171tpm2-tools                      SEPTEMBER 2017           tpm2_takeownership(1)