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

NAME

6       tpm2_policycommandcode(1)  -  Restrict TPM object authorization to spe‐
7       cific TPM commands.
8

SYNOPSIS

10       tpm2_policycommandcode [OPTIONS] [ARGUMENT]
11

DESCRIPTION

13       tpm2_policycommandcode(1) - Restricts TPM object authorization to  spe‐
14       cific  TPM  commands.  Useful when you want to allow only specific com‐
15       mands to interact with the TPM object.
16
17       As an argument it takes the command as an integer  or  friendly  string
18       value.  Friendly string to COMMAND CODE mapping can be found in section
19       COMMAND CODE MAPPINGS.
20

OPTIONS

22       · -S, --session=FILE:
23
24         A session file from tpm2_startauthsession(1)'s -S option.
25
26       · -L, --policy=FILE:
27
28         File to save the policy digest.
29
30       · ARGUMENT the command line argument specifies TPM2 command code.
31
32   References

COMMON OPTIONS

34       This collection of options are common to many programs and provide  in‐
35       formation that many users may expect.
36
37       · -h,  --help=[man|no-man]:  Display the tools manpage.  By default, it
38         attempts to invoke the manpager for the  tool,  however,  on  failure
39         will  output  a short tool summary.  This is the same behavior if the
40         "man" option argument is specified, however if explicit "man" is  re‐
41         quested,  the  tool  will  provide errors from man on stderr.  If the
42         "no-man" option if specified, or the manpager fails,  the  short  op‐
43         tions will be output to stdout.
44
45         To  successfully use the manpages feature requires the manpages to be
46         installed or on MANPATH, See man(1) for more details.
47
48       · -v, --version: Display version information for this  tool,  supported
49         tctis and exit.
50
51       · -V,  --verbose:  Increase the information that the tool prints to the
52         console during its execution.  When using this option  the  file  and
53         line number are printed.
54
55       · -Q, --quiet: Silence normal tool output to stdout.
56
57       · -Z, --enable-errata: Enable the application of errata fixups.  Useful
58         if an errata fixup needs to be applied to commands sent to  the  TPM.
59         Defining  the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.  in‐
60         formation many users may expect.
61

TCTI Configuration

63       The TCTI or "Transmission Interface"  is  the  communication  mechanism
64       with  the TPM.  TCTIs can be changed for communication with TPMs across
65       different mediums.
66
67       To control the TCTI, the tools respect:
68
69       1. The command line option -T or --tcti
70
71       2. The environment variable: TPM2TOOLS_TCTI.
72
73       Note: The command line option always overrides  the  environment  vari‐
74       able.
75
76       The current known TCTIs are:
77
78       · tabrmd      -     The     resource     manager,     called     tabrmd
79         (https://github.com/tpm2-software/tpm2-abrmd).  Note that tabrmd  and
80         abrmd as a tcti name are synonymous.
81
82       · mssim  - Typically used for communicating to the TPM software simula‐
83         tor.
84
85       · device - Used when talking directly to a TPM device file.
86
87       · none - Do not initalize a connection with the TPM.  Some tools  allow
88         for off-tpm options and thus support not using a TCTI.  Tools that do
89         not support it will error when attempted to be used  without  a  TCTI
90         connection.   Does  not  support ANY options and MUST BE presented as
91         the exact text of "none".
92
93       The arguments to either the command  line  option  or  the  environment
94       variable are in the form:
95
96       <tcti-name>:<tcti-option-config>
97
98       Specifying  an  empty  string  for  either the <tcti-name> or <tcti-op‐
99       tion-config> results in the default being used for that portion respec‐
100       tively.
101
102   TCTI Defaults
103       When  a  TCTI  is not specified, the default TCTI is searched for using
104       dlopen(3) semantics.  The tools will  search  for  tabrmd,  device  and
105       mssim  TCTIs  IN THAT ORDER and USE THE FIRST ONE FOUND.  You can query
106       what TCTI will be chosen as the default by using the -v option to print
107       the  version information.  The "default-tcti" key-value pair will indi‐
108       cate which of the aforementioned TCTIs is the default.
109
110   Custom TCTIs
111       Any TCTI that implements the dynamic TCTI interface can be loaded.  The
112       tools internally use dlopen(3), and the raw tcti-name value is used for
113       the lookup.  Thus, this could be a path to the shared library, or a li‐
114       brary name as understood by dlopen(3) semantics.
115

TCTI OPTIONS

117       This collection of options are used to configure the various known TCTI
118       modules available:
119
120       · device: For the device TCTI, the TPM character device file for use by
121         the device TCTI can be specified.  The default is /dev/tpm0.
122
123         Example:    -T   device:/dev/tpm0   or   export   TPM2TOOLS_TCTI="de‐
124         vice:/dev/tpm0"
125
126       · mssim: For the mssim TCTI, the domain name or  IP  address  and  port
127         number  used  by  the  simulator  can  be specified.  The default are
128         127.0.0.1 and 2321.
129
130         Example: -T mssim:host=localhost,port=2321  or  export  TPM2TOOLS_TC‐
131         TI="mssim:host=localhost,port=2321"
132
133       · abrmd:  For  the abrmd TCTI, the configuration string format is a se‐
134         ries of simple key value pairs separated by a  ','  character.   Each
135         key and value string are separated by a '=' character.
136
137         · TCTI abrmd supports two keys:
138
139           1. 'bus_name'  :  The  name  of  the  tabrmd  service on the bus (a
140              string).
141
142           2. 'bus_type' : The type of the dbus instance (a string) limited to
143              'session' and 'system'.
144
145         Specify  the tabrmd tcti name and a config string of bus_name=com.ex‐
146         ample.FooBar:
147
148         \--tcti=tabrmd:bus_name=com.example.FooBar
149
150         Specify the default (abrmd) tcti and a config string of bus_type=ses‐
151         sion:
152
153         \--tcti:bus_type=session
154
155         NOTE:  abrmd  and tabrmd are synonymous.  the various known TCTI mod‐
156         ules.
157

COMMAND CODE MAPPINGS

159       The friendly strings below can be used en lieu of the raw integer  val‐
160       ues.
161
162       -TPM2_CC_AC_GetCapability: 0x194 -TPM2_CC_AC_Send: 0x195 -TPM2_CC_Acti‐
163       vateCredential: 0x147 -TPM2_CC_Certify: 0x148 -TPM2_CC_CertifyCreation:
164       0x14a     -TPM2_CC_ChangeEPS:     0x124    -TPM2_CC_ChangePPS:    0x125
165       -TPM2_CC_Clear:  0x126  -TPM2_CC_ClearControl:  0x127   -TPM2_CC_Clock‐
166       RateAdjust:   0x130  -TPM2_CC_ClockSet:  0x128  -TPM2_CC_Commit:  0x18b
167       -TPM2_CC_ContextLoad: 0x161 -TPM2_CC_ContextSave:  0x162  -TPM2_CC_Cre‐
168       ate:  0x153  -TPM2_CC_CreateLoaded: 0x191 -TPM2_CC_CreatePrimary: 0x131
169       -TPM2_CC_DictionaryAttackLockReset: 0x139  -TPM2_CC_DictionaryAttackPa‐
170       rameters:   0x13a  -TPM2_CC_Duplicate:  0x14b  -TPM2_CC_ECC_Parameters:
171       0x178    -TPM2_CC_ECDH_KeyGen:    0x163    -TPM2_CC_ECDH_ZGen:    0x154
172       -TPM2_CC_EC_Ephemeral:     0x18e     -TPM2_CC_EncryptDecrypt:     0x164
173       -TPM2_CC_EncryptDecrypt2: 0x193  -TPM2_CC_EventSequenceComplete:  0x185
174       -TPM2_CC_EvictControl:     0x120    -TPM2_CC_FieldUpgradeData:    0x141
175       -TPM2_CC_FieldUpgradeStart:    0x12f    -TPM2_CC_FirmwareRead:    0x179
176       -TPM2_CC_FlushContext:      0x165     -TPM2_CC_GetCapability:     0x17a
177       -TPM2_CC_GetCommandAuditDigest:   0x133    -TPM2_CC_GetRandom:    0x17b
178       -TPM2_CC_GetSessionAuditDigest:   0x14d  -TPM2_CC_GetTestResult:  0x17c
179       -TPM2_CC_GetTime: 0x14c  -TPM2_CC_Hash:  0x17d  -TPM2_CC_HashSequenceS‐
180       tart:  0x186 -TPM2_CC_HierarchyChangeAuth: 0x129 -TPM2_CC_HierarchyCon‐
181       trol:   0x121   -TPM2_CC_HMAC:   0x155    -TPM2_CC_HMAC_Start:    0x15b
182       -TPM2_CC_Import:      0x156     -TPM2_CC_IncrementalSelfTest:     0x142
183       -TPM2_CC_Load: 0x157 -TPM2_CC_LoadExternal: 0x167  -TPM2_CC_MakeCreden‐
184       tial:  0x168  -TPM2_CC_NV_Certify:  0x184 -TPM2_CC_NV_ChangeAuth: 0x13b
185       -TPM2_CC_NV_DefineSpace:      0x12a      -TPM2_CC_NV_Extend:      0x136
186       -TPM2_CC_NV_GlobalWriteLock:    0x132    -TPM2_CC_NV_Increment:   0x134
187       -TPM2_CC_NV_Read: 0x14e -TPM2_CC_NV_ReadLock:  0x14f  -TPM2_CC_NV_Read‐
188       Public:  0x169  -TPM2_CC_NV_SetBits:  0x135  -TPM2_CC_NV_UndefineSpace:
189       0x122 -TPM2_CC_NV_UndefineSpaceSpecial: 0x11f -TPM2_CC_NV_Write:  0x137
190       -TPM2_CC_NV_WriteLock:     0x138    -TPM2_CC_ObjectChangeAuth:    0x150
191       -TPM2_CC_PCR_Allocate: 0x12b -TPM2_CC_PCR_Event: 0x13c -TPM2_CC_PCR_Ex‐
192       tend:   0x182   -TPM2_CC_PCR_Read:   0x17e   -TPM2_CC_PCR_Reset:  0x13d
193       -TPM2_CC_PCR_SetAuthPolicy:  0x12c   -TPM2_CC_PCR_SetAuthValue:   0x183
194       -TPM2_CC_Policy_AC_SendSelect:  0x196  -TPM2_CC_PolicyAuthorize:  0x16a
195       -TPM2_CC_PolicyAuthorizeNV:   0x192   -TPM2_CC_PolicyAuthValue:   0x16b
196       -TPM2_CC_PolicyCommandCode:  0x16c  -TPM2_CC_PolicyCounterTimer:  0x16d
197       -TPM2_CC_PolicyCpHash:  0x16e  -TPM2_CC_PolicyDuplicationSelect:  0x188
198       -TPM2_CC_PolicyGetDigest:    0x189    -TPM2_CC_PolicyLocality:    0x16f
199       -TPM2_CC_PolicyNameHash: 0x170 -TPM2_CC_PolicyNV: 0x149  -TPM2_CC_Poli‐
200       cyNvWritten:  0x18f  -TPM2_CC_PolicyOR:  0x171 -TPM2_CC_PolicyPassword:
201       0x18c -TPM2_CC_PolicyPCR: 0x17f -TPM2_CC_PolicyPhysicalPresence:  0x187
202       -TPM2_CC_PolicyRestart:      0x180     -TPM2_CC_PolicySecret:     0x151
203       -TPM2_CC_PolicySigned:     0x160     -TPM2_CC_PolicyTemplate:     0x190
204       -TPM2_CC_PolicyTicket:      0x172      -TPM2_CC_PP_Commands:      0x12d
205       -TPM2_CC_Quote: 0x158  -TPM2_CC_ReadClock:  0x181  -TPM2_CC_ReadPublic:
206       0x173     -TPM2_CC_Rewrap:     0x152     -TPM2_CC_RSA_Decrypt:    0x159
207       -TPM2_CC_RSA_Encrypt: 0x174 -TPM2_CC_SelfTest: 0x143 -TPM2_CC_Sequence‐
208       Complete:  0x13e  -TPM2_CC_SequenceUpdate: 0x15c -TPM2_CC_SetAlgorithm‐
209       Set: 0x13f -TPM2_CC_SetCommandCodeAuditStatus: 0x140 -TPM2_CC_SetPrima‐
210       ryPolicy:   0x12e   -TPM2_CC_Shutdown:   0x145   -TPM2_CC_Sign:   0x15d
211       -TPM2_CC_StartAuthSession: 0x176 -TPM2_CC_Startup: 0x144 -TPM2_CC_Stir‐
212       Random:   0x146   -TPM2_CC_TestParms:   0x18a   -TPM2_CC_Unseal:  0x15e
213       -TPM2_CC_Vendor_TCG_Test:  0x20000000  -TPM2_CC_VerifySignature:  0x177
214       -TPM2_CC_ZGen_2Phase: 0x18d
215

EXAMPLES

217       Start  a  policy session and extend it with a specific command like un‐
218       seal.  Attempts to perform other operations would fail.
219
220   Create an unseal-only policy
221              tpm2_startauthsession -S session.dat
222
223              tpm2_policycommandcode -S session.dat -L policy.dat TPM2_CC_Unseal
224
225              tpm2_flushcontext session.dat
226
227   Create the object with unseal-only auth policy
228              tpm2_createprimary -C o -c prim.ctx
229
230              tpm2_create -C prim.ctx -u sealkey.pub -r sealkey.priv -L policy.dat \
231                -i- <<< "SEALED-SECRET"
232
233   Try unseal operation
234              tpm2_load -C prim.ctx -u sealkey.pub -r sealkey.priv -n sealkey.name \
235                -c sealkey.ctx
236
237              tpm2_startauthsession --policy-session -S session.dat
238
239              tpm2_policycommandcode -S session.dat -L policy.dat TPM2_CC_Unseal
240
241              tpm2_unseal -p session:session.dat -c sealkey.ctx
242              SEALED-SECRET
243
244              tpm2_flushcontext session.dat
245
246   Try any other operation
247              echo "Encrypt Me" > plain.txt
248
249              tpm2_encryptdecrypt plain.txt -o enc.txt -c sealkey.ctx plain.txt
250              ERROR: Esys_EncryptDecrypt2(0x12F) - tpm:error(2.0): authValue or authPolicy is
251              not available for selected entity
252

Returns

254       Tools can return any of the following codes:
255
256       · 0 - Success.
257
258       · 1 - General non-specific error.
259
260       · 2 - Options handling error.
261
262       · 3 - Authentication error.
263
264       · 4 - TCTI related error.
265
266       · 5 - Non supported scheme.  Applicable to tpm2_testparams.
267

Limitations

269       It expects a session to be already established  via  tpm2_startauthses‐
270       sion(1) and requires one of the following:
271
272       · direct device access
273
274       · extended session support with tpm2-abrmd.
275
276       Without  it, most resource managers will not save session state between
277       command invocations.
278

BUGS

280       Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
281

HELP

283       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
284
285
286
287tpm2-tools                                           tpm2_policycommandcode(1)
Impressum