| tpm2_clearcontrol(1) | General Commands Manual | tpm2_clearcontrol(1) |
tpm2_clearcontrol(1) - Set/ Clear TPMA_PERMANENT.disableClear attribute to effectively block/ unblock lockout authorization handle for issuing TPM clear.
tpm2_clearcontrol [OPTIONS] [ARGUMENT]
tpm2_clearcontrol(1) - Allows user with knowledge of either lockout auth and or platform hierarchy auth to set disableClear which prevents the lockout authorization’s capability to execute tpm2_clear. Only user with authorization knowledge of the platform hierarchy can clear the disableClear. By default it attempts to clear the disableClear bit.
Note: Platform hierarchy auth handle can always be used to clear the TPM with tpm2_clear command.
Specifies what auth handle, either platform hierarchy or lockout the tool should operate on. By default it operates on the platform hierarchy handle. Specify the handle as p|l|platform|lockout.
NOTE : Operating on platform hierarchy require platform authentication.
The authorization value of the hierarchy specified with -C. This tool only respects the Password and HMAC options.
File path to record the hash of the command parameters. This is commonly termed as cpHash. NOTE: When this option is selected, The tool will not actually execute the command, it simply returns a cpHash.
The type of a context object, whether it is a handle or file name, is determined according to the following logic in-order:
Authorization for use of an object in TPM2.0 can come in 3 different forms: 1. Password 2. HMAC 3. Sessions
NOTE: “Authorizations default to the EMPTY PASSWORD when not specified”.
Passwords are interpreted in the following forms below using prefix identifiers.
Note: By default passwords are assumed to be in the string form when they do not have a prefix.
A string password, specified by prefix “str:” or it’s absence (raw string without prefix) is not interpreted, and is directly used for authorization.
foobar
str:foobar
A hex-string password, specified by prefix “hex:” is converted from a hexidecimal form into a byte array form, thus allowing passwords with non-printable and/or terminal un-friendly characters.
hex:0x1122334455667788
A file based password, specified be prefix “file:” should be the path of a file containing the password to be read by the tool or a “-” to use stdin. Storing passwords in files prevents information leakage, passwords passed as options can be read from the process list or common shell history features.
# to use stdin and be prompted
file:-
# to use a file from a path
file:path/to/password/file
# to echo a password via stdin:
echo foobar | tpm2_tool -p file:-
# to use a bash here-string via stdin:
tpm2_tool -p file:- <<< foobar
When using a policy session to authorize the use of an object, prefix the option argument with the session keyword. Then indicate a path to a session file that was created with tpm2_startauthsession(1). Optionally, if the session requires an auth value to be sent with the session handle (eg policy password), then append a + and a string as described in the Passwords section.
To use a session context file called session.ctx.
session:session.ctx
To use a session context file called session.ctx AND send the authvalue mypassword.
session:session.ctx+mypassword
To use a session context file called session.ctx AND send the HEX authvalue 0x11223344.
session:session.ctx+hex:11223344
You can satisfy a PCR policy using the “pcr:” prefix and the PCR minilanguage. The PCR minilanguage is as follows: <pcr-spec>=<raw-pcr-file>
The PCR spec is documented in in the section “PCR bank specifiers”.
The raw-pcr-file is an optional the output of the raw PCR contents as returned by tpm2_pcrread(1).
PCR bank specifiers
To satisfy a PCR policy of sha256 on banks 0, 1, 2 and 3 use a specifier of:
pcr:sha256:0,1,2,3
specifying AUTH.
This collection of options are common to many programs and provide information that many users may expect.
To successfully use the manpages feature requires the manpages to be installed or on MANPATH, See man(1) for more details.
The TCTI or “Transmission Interface” is the communication mechanism with the TPM. TCTIs can be changed for communication with TPMs across different mediums.
To control the TCTI, the tools respect:
Note: The command line option always overrides the environment variable.
The current known TCTIs are:
The arguments to either the command line option or the environment variable are in the form:
<tcti-name>:<tcti-option-config>
Specifying an empty string for either the <tcti-name> or <tcti-option-config> results in the default being used for that portion respectively.
When a TCTI is not specified, the default TCTI is searched for using dlopen(3) semantics. The tools will search for tabrmd, device and mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query what TCTI will be chosen as the default by using the -v option to print the version information. The “default-tcti” key-value pair will indicate which of the aforementioned TCTIs is the default.
Any TCTI that implements the dynamic TCTI interface can be loaded. The tools internally use dlopen(3), and the raw tcti-name value is used for the lookup. Thus, this could be a path to the shared library, or a library name as understood by dlopen(3) semantics.
This collection of options are used to configure the various known TCTI modules available:
Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI=“device:/dev/tpm0”
Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TCTI=“mssim:host=localhost,port=2321”
Specify the tabrmd tcti name and a config string of bus_name=com.example.FooBar:
\--tcti=tabrmd:bus_name=com.example.FooBar
Specify the default (abrmd) tcti and a config string of bus_type=session:
\--tcti:bus_type=session
NOTE: abrmd and tabrmd are synonymous. the various known TCTI modules.
tpm2_clearcontrol -C l s
tpm2_clearcontrol -C p c
Tools can return any of the following codes:
Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
| tpm2-tools |