tpm2_getpubak(1) - Generate attestation key with given
algorithm under the endorsement hierarchy.
tpm2_getpubak(1) - Generate attestation key with given
algorithm under endorsement hierarchy, make it persistent with given ak
handle, and return pub AK and AK name. If any passwd option is missing,
assume NULL.
The tool outputs to stdout a YAML representation of the loaded key
handle as well as it's name, for example:
-
loaded-key:
handle: 800000ff
name: 000bac149518baa05540a0678bd9b624f8a98d042e46c60f4d098ba394d36fc49268
- •
- -e, –endorse-passwd=ENDORSE_PASSWORD:
Specifies current endorsement password, defaults to NULL. Passwords should
follow the “password formatting standards, see
section”Password Formatting“.
- •
- -P, –ak-passwd=AK_PASSWORD Specifies the AK
password when created, defaults to NULL. Same formatting as the endorse
password value or -e option.
- •
- -o, –owner-passwd=OWNER_PASSWORD Specifies the
current owner password, defaults to NULL. Same formatting as the endorse
password value or -e option.
- •
- -E, –ek-handle=EK_HANDLE: Specifies the handle
used to make EK persistent.
- •
- -k, –ak-handle=AK_HANDLE: Specifies the handle
used to make AK persistent.
- •
- -g, –alg=ALGORITHM: Specifies the algorithm
type of AK. Algorithms should follow the " formatting standards, see
section “Algorithm Specifiers”. See section
“Supported Public Object Algorithms” for a list of supported
object algorithms.
- •
- -g, –alg=ALGORITHM: Like -g, but specifies the
algorithm of sign. See section “Supported Signing
Algorithms” for details.
- •
- -f, –file=FILE: Specifies the file used to
save the public portion of AK. This will be a binary data structure
corresponding to the TPM2B_PUBLIC struct in the specification.
- •
- -n, –ak-name=NAME: Specifies the file used to
save the ak name, optional.
This collection of options are common to many programs and provide
information that many users may expect.
- •
- -h, –help: Display the tools manpage. This requires
the manpages to be installed or on MANPATH, See man(1) for more
details.
- •
- -v, –version: Display version information for this
tool, supported tctis and exit.
- •
- -V, –verbose: Increase the information that the tool
prints to the console during its execution. When using this option the
file and line number are printed.
- •
- -Q, –quiet: Silence normal tool output to
stdout.
- •
- -Z, –enable-errata: Enable the application of errata
fixups. Useful if an errata fixup needs to be applied to commands sent to
the TPM. # TCTI ENVIRONMENT
This collection of environment variables that may be used to
configure the various TCTI modules available.
The values passed through these variables can be overridden on a
per-command basis using the available command line options, see the
TCTI_OPTIONS section.
The variables respected depend on how the software was
configured.
- •
- TPM2TOOLS_TCTI_NAME: Select the TCTI used for communication with
the next component down the TSS stack. In most configurations this will be
the TPM but it could be a simulator or proxy. The current known TCTIs
are:
- •
- tabrmd - The new resource manager, called tabrmd
(https://github.com/01org/tpm2-abrmd).
- •
- socket - Typically used with the old resource manager, or talking directly
to a simulator.
- •
- device - Used when talking directly to a TPM device file.
- •
- TPM2TOOLS_DEVICE_FILE: When using the device TCTI, specify the TPM
device file. The default is “/dev/tpm0”.
Note: Using the tpm directly requires the users to ensure that
concurrent access does not occur and that they manage the tpm resources.
These tasks are usually managed by a resource manager. Linux 4.12 and
greater supports an in kernel resource manager at
“/dev/tpmrm”, typically
“/dev/tpmrm0”.
- •
- TPM2TOOLS_SOCKET_ADDRESS: When using the socket TCTI, specify the
domain name or IP address used. The default is 127.0.0.1.
- •
- TPM2TOOLS_SOCKET_PORT: When using the socket TCTI, specify the port
number used. The default is 2321.
This collection of options are used to configure the varous TCTI
modules available. They override any environment variables.
- •
- -T,
–tcti=TCTI_NAME[:TCTI_OPTIONS]:
Select the TCTI used for communication with the next component down the
TSS stack. In most configurations this will be the resource manager:
tabrmd (https://github.com/01org/tpm2-abrmd) Optionally, tcti specific
options can appended to TCTI_NAME by appending a : to
TCTI_NAME.
- •
- For the device TCTI, the TPM device file for use by the device TCTI can be
specified. The default is /dev/tpm0. Example: -T
device:/dev/tpm0
- •
- For the socket TCTI, the domain name or IP address and port number used by
the socket can be specified. The default are 127.0.0.1 and 2321. Example:
-T socket:127.0.0.1:2321
- •
- For the abrmd TCTI, it takes no options. Example: -T abrmd
Passwords are interpreted in two forms, string and hex-string. A
string password is not interpreted, and is directly used for authorization.
A hex-string, is converted from a hexidecimal form into a byte array form,
thus allowing passwords with non-printable and/or terminal un-friendly
characters.
By default passwords are assumed to be in the string form.
Password form is specified with special prefix values, they are:
- •
- str: - Used to indicate it is a raw string. Useful for escaping a password
that starts with the “hex:” prefix.
- •
- hex: - Used when specifying a password in hex string format.
Supported algorithms are:
- •
- 0x5 or hmac for TPM_ALG_HMAC (default)
- •
- 0x14 or rsassa for TPM_ALG_RSASSA
- •
- 0x16 or rsapss for TPM_ALG_RSAPSS
- •
- 0x18 or ecdsa for TPM_ALG_ECDSA
- •
- 0x1A or ecdaa for TPM_ALG_ECDAA
- •
- 0x1B or sm2 for TPM_ALG_SM2
- •
- 0x1C or ecschnorr for TPM_ALG_ECSCHNORR
NOTE: Your TPM may not support all algorithms.
Supported public object algorithms are:
- •
- 0x1 or rsa for TPM_ALG_RSA (default).
- •
- 0x8 or keyedhash for TPM_ALG_KEYEDHASH.
- •
- 0x23 or ecc for TPM_ALG_ECC.
- •
- 0x25 or symcipher for TPM_ALG_SYMCIPHER.
NOTE: Your TPM may not support all algorithms.
Options that take algorithms support “nice-names”.
Nice names, like sha1 can be used in place of the raw hex for sha1: 0x4. The
nice names are converted by stripping the leading TPM_ALG_ from the
Algorithm Name field and converting it to lower case. For instance
TPM_ALG_SHA3_256 becomes sha3_256.
The algorithms can be found at:
<https://trustedcomputinggroup.org/wp-content/uploads/TCG_Algorithm_Registry_Rev_1.24.pdf>
-
tpm2_getpubak -e abc123 -P abc123 -o passwd -E 0x81010001 -k 0x81010002 -f ./ak.pub -n ./ak.name
tpm2_getpubak -e 1a1b1c -P 123abc -o 1a1b1c -X -E 0x81010001 -k 0x81010002 -f ./ak.pub -n ./ak.name
0 on success or 1 on failure.
Github Issues (https://github.com/01org/tpm2-tools/issues)
See the Mailing List
(https://lists.01.org/mailman/listinfo/tpm2)