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

NAME

6       tpm2_evictcontrol(1)  -  Make  a transient object persistent or evict a
7       persistent object.
8

SYNOPSIS

10       tpm2_evictcontrol [OPTIONS]
11

DESCRIPTION

13       tpm2_evictcontrol(1) - allows a transient object to be made  persistent
14       or a persistent object to be evicted.
15

OPTIONS

17       · -A,  –auth=AUTH:  The  authorization  used to authorize the commands.
18         Valid choices are:
19
20         · o for TPM_RH_OWNER
21
22         · p for TPM_RH_PLATFORM
23
24       · -H, –handle=HANDLE: The handle of a loaded transient or a  persistent
25         object.
26
27         If  the  handle is for a transient object, then a handle that will be
28         assigned to the persisted object must also be specified with  the  -S
29         option.
30
31         If  the  handle is for a persistent object, then the -S does not need
32         to be provided since the handle must be the same for both options.
33
34       · -c, –context=OBJECT_CONTEXT_FILE: Filename for object context.
35
36       · -S, –persistent=PERSISTENT_HANDLE: The persistent handle for the  ob‐
37         ject handle specified via HANDLE.
38
39       · -P, –pwda=AUTH_PASSWORD: authorization password, optional.  Passwords
40         should follow the “password formatting standards,  see  section”Pass‐
41         word Formatting“.
42

COMMON OPTIONS

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

TCTI OPTIONS

101       This  collection  of options are used to configure the varous TCTI mod‐
102       ules available.  They override any environment variables.
103
104       · -T, –tcti=TCTI_NAME[:TCTI_OPTIONS]: Select the TCTI used for communi‐
105         cation  with the next component down the TSS stack.  In most configu‐
106         rations   this    will    be    the    resource    manager:    tabrmd
107         (https://github.com/01org/tpm2-abrmd)  Optionally,  tcti specific op‐
108         tions can appended to TCTI_NAME by appending a : to TCTI_NAME.
109
110         · For the device TCTI, the TPM device file for use by the device TCTI
111           can  be  specified.   The  default  is  /dev/tpm0.  Example: -T de‐
112           vice:/dev/tpm0
113
114         · For the socket TCTI, the domain name or IP address and port  number
115           used by the socket can be specified.  The default are 127.0.0.1 and
116           2321.  Example: -T socket:127.0.0.1:2321
117
118         · For the abrmd TCTI, it takes no options.  Example: -T abrmd
119

Password Formatting

121       Passwords are interpreted in  two  forms,  string  and  hex-string.   A
122       string password is not interpreted, and is directly used for authoriza‐
123       tion.  A hex-string, is converted from a hexidecimal form into  a  byte
124       array  form, thus allowing passwords with non-printable and/or terminal
125       un-friendly characters.
126
127       By default passwords are assumed to be in the  string  form.   Password
128       form is specified with special prefix values, they are:
129
130       · str:  -  Used  to indicate it is a raw string.  Useful for escaping a
131         password that starts with the “hex:” prefix.
132
133       · hex: - Used when specifying a password in hex string format.
134

EXAMPLES

136              tpm2_evictcontrol -A o -c object.context -S 0x81010002 -P abc123
137              tpm2_evictcontrol -A o -H 0x81010002 -S 0x81010002 -P abc123
138              tpm2_evictcontrol -A o -H 0x81010002 -S 0x81010002 -P 123abc
139

RETURNS

141       0 on success or 1 on failure.
142

BUGS

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

HELP

147       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
148
149
150
151tpm2-tools                      SEPTEMBER 2017            tpm2_evictcontrol(1)
Impressum