1tpm2_policyor(1) General Commands Manual tpm2_policyor(1)
2
6 tpm2_policyor(1) - logically OR’s two policies together.
7
9 tpm2_policyor [OPTIONS]
10
12 tpm2_policyor(1) - Generates a policy_or event with the TPM. It ex‐
13 pects a session to be already established via tpm2_startauthsession(1).
14 If the input session is a trial session this tool generates a policy
15 digest that compounds two or more input policy digests such that the
16 resulting policy digest requires at least one of the policy events be‐
17 ing true. If the input session is real policy session tpm2_policyor(1)
18 authenticates the object successfully if at least one of the policy
19 events are true.
20
22 • -L, --policy=FILE:
23 File to save the compounded policy digest.
25 • -S, --session=FILE:
27 The policy session file generated via the -S option to tpm2_star‐
29 tauthsession(1).
30 • ARGUMENT the command line argument specifies the list of files for
32 the policy digests that has to be compounded resulting in individual
33 policies being added to final policy digest that can authenticate the
34 object. The list begins with the policy digest hash alg. Example
35 sha256:policy1,policy2
36 • -l, --policy-list=POLICY_FILE_LIST:
38 This option is retained for backwards compatibility. Use the argu‐
40 ment method instead.
41 References
44 This collection of options are common to many programs and provide in‐
45 formation that many users may expect.
46 • -h, --help=[man|no-man]: Display the tools manpage. By default, it
48 attempts to invoke the manpager for the tool, however, on failure
49 will output a short tool summary. This is the same behavior if the
50 “man” option argument is specified, however if explicit “man” is re‐
51 quested, the tool will provide errors from man on stderr. If the
52 “no-man” option if specified, or the manpager fails, the short op‐
53 tions will be output to stdout.
54 To successfully use the manpages feature requires the manpages to be
56 installed or on MANPATH, See man(1) for more details.
57 • -v, --version: Display version information for this tool, supported
59 tctis and exit.
60 • -V, --verbose: Increase the information that the tool prints to the
62 console during its execution. When using this option the file and
63 line number are printed.
64 • -Q, --quiet: Silence normal tool output to stdout.
66 • -Z, --enable-errata: Enable the application of errata fixups. Useful
68 if an errata fixup needs to be applied to commands sent to the TPM.
69 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
70 formation many users may expect.
71
73 The TCTI or “Transmission Interface” is the communication mechanism
74 with the TPM. TCTIs can be changed for communication with TPMs across
75 different mediums.
76 To control the TCTI, the tools respect:
78 1. The command line option -T or --tcti
80 2. The environment variable: TPM2TOOLS_TCTI.
82 Note: The command line option always overrides the environment vari‐
84 able.
85 The current known TCTIs are:
87 • tabrmd - The resource manager, called tabrmd
89 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
90 abrmd as a tcti name are synonymous.
91 • mssim - Typically used for communicating to the TPM software simula‐
93 tor.
94 • device - Used when talking directly to a TPM device file.
96 • none - Do not initalize a connection with the TPM. Some tools allow
98 for off-tpm options and thus support not using a TCTI. Tools that do
99 not support it will error when attempted to be used without a TCTI
100 connection. Does not support ANY options and MUST BE presented as
101 the exact text of “none”.
102 The arguments to either the command line option or the environment
104 variable are in the form:
105 <tcti-name>:<tcti-option-config>
107 Specifying an empty string for either the <tcti-name> or <tcti-op‐
109 tion-config> results in the default being used for that portion respec‐
110 tively.
111 TCTI Defaults
113 When a TCTI is not specified, the default TCTI is searched for using
114 dlopen(3) semantics. The tools will search for tabrmd, device and
115 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
116 what TCTI will be chosen as the default by using the -v option to print
117 the version information. The “default-tcti” key-value pair will indi‐
118 cate which of the aforementioned TCTIs is the default.
119 Custom TCTIs
121 Any TCTI that implements the dynamic TCTI interface can be loaded. The
122 tools internally use dlopen(3), and the raw tcti-name value is used for
123 the lookup. Thus, this could be a path to the shared library, or a li‐
124 brary name as understood by dlopen(3) semantics.
125
127 This collection of options are used to configure the various known TCTI
128 modules available:
129 • device: For the device TCTI, the TPM character device file for use by
131 the device TCTI can be specified. The default is /dev/tpm0.
132 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI=“de‐
134 vice:/dev/tpm0”
135 • mssim: For the mssim TCTI, the domain name or IP address and port
137 number used by the simulator can be specified. The default are
138 127.0.0.1 and 2321.
139 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
141 TI=“mssim:host=localhost,port=2321”
142 • abrmd: For the abrmd TCTI, the configuration string format is a se‐
144 ries of simple key value pairs separated by a `,' character. Each
145 key and value string are separated by a `=' character.
146 • TCTI abrmd supports two keys:
148 1. `bus_name' : The name of the tabrmd service on the bus (a
150 string).
151 2. `bus_type' : The type of the dbus instance (a string) limited to
153 `session' and `system'.
154 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
156 ample.FooBar:
157 \--tcti=tabrmd:bus_name=com.example.FooBar
159 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
161 sion:
162 \--tcti:bus_type=session
164 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
166 ules.
167
169 Create an authorization policy for a sealing object that compounds a
170 pcr policy and a policypassword in an OR fashion and show satisfying
171 either policies could unseal the secret.
172 Create policypcr as first truth value for compounding the policies
174 tpm2_startauthsession -S session.ctx
175 tpm2_policypcr -S session.ctx -L policy.pcr -l sha256:0,1,2,3
176 tpm2_flushcontext session.ctx
177 Create policypassword as second truth value for compounding the policies
179 tpm2_startauthsession -S session.ctx
180 tpm2_policypassword -S session.ctx -L policy.pass
181 tpm2_flushcontext session.ctx
182 Compound the two policies in an OR fashion with tpm2_policyor command
184 tpm2_startauthsession -S session.ctx
185 tpm2_policyor -S session.ctx -L policy.or sha256:policy.pass,policy.pcr
186 tpm2_flushcontext session.ctx
187 Create a sealing object and attach the auth policy from tpm2_policyor com‐
189 mand
190 tpm2_createprimary -c prim.ctx -Q
191 echo "secret" | tpm2_create -C prim.ctx -c key.ctx -u key.pub -r key.priv \
192 -L policy.or -i-
193 Satisfy auth policy using password and unseal the secret
195 tpm2_startauthsession -S session.ctx --policy-session
196 tpm2_policypassword -S session.ctx
197 tpm2_policyor -S session.ctx sha256:policy.pass,policy.pcr
198 tpm2_unseal -c key.ctx -p session:session.ctx
199 tpm2_flushcontext session.ctx
200 Satisfy auth policy using pcr and unseal the secret
202 tpm2_startauthsession -S session.ctx --policy-session
203 tpm2_policypcr -S session.ctx -l sha256:0,1,2,3
204 tpm2_policyor -S session.ctx sha256:policy.pass,policy.pcr
205 tpm2_unseal -c key.ctx -p session:session.ctx
206 tpm2_flushcontext session.ctx
207
209 Tools can return any of the following codes:
210 • 0 - Success.
212 • 1 - General non-specific error.
214 • 2 - Options handling error.
216 • 3 - Authentication error.
218 • 4 - TCTI related error.
220 • 5 - Non supported scheme. Applicable to tpm2_testparams.
222
224 It expects a session to be already established via tpm2_startauthses‐
225 sion(1) and requires one of the following:
226 • direct device access
228 • extended session support with tpm2-abrmd.
230 Without it, most resource managers will not save session state between
232 command invocations.
233
235 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
236
238 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
239tpm2-tools tpm2_policyor(1)