tpm2_createprimary - Man Page

tpm2_createprimary [Options]

tpm2_createprimary(1) - This command is used to create a primary object under one of the hierarchies: Owner, Platform, Endorsement, NULL. The command will create and load a Primary Object. The sensitive and public portions are not returned. A context file for the created object’s handle is saved as a file for future interactions with the created primary.

• -C, --hierarchy=OBJECT:

  The hierarchy under which the object is created. This will also dictate which authorization secret (if any) must be supplied. Defaults to TPM_RH_OWNER, when no value specified. Supported options are:

  • o for TPM_RH_OWNER
  • p for TPM_RH_PLATFORM
  • e for TPM_RH_ENDORSEMENT
  • n for TPM_RH_NULL
  • <num> where a raw number can be used.

• -P, --hierarchy-auth=AUTH:

  The authorization value for the hierarchy specified with -C.

• -p, --key-auth=AUTH:

  The authorization value for the primary object created.

• -g, --hash-algorithm=ALGORITHM:

  The hash algorithm to use for generating the objects name. Defaults to sha256 if not specified.

• -G, --key-algorithm=ALGORITHM:

  The algorithm type for the generated primary key. Defaults to rsa2048:null:aes128cfb.

• -c, --key-context=File:

  The file path to save the object context of the generated primary object.

• -L, --policy=File or HEX_STRING:

  An optional file input or hex string that contains the policy digest for policy based authorization of the object.

• -a, --attributes=ATTRIBUTES:

  The object attributes, optional. Defaults to: TPMA_OBJECT_RESTRICTED|TPMA_OBJECT_DECRYPT|TPMA_OBJECT_FIXEDTPM|  TPMA_OBJECT_FIXEDPARENT|TPMA_OBJECT_SENSITIVEDATAORIGIN|  TPMA_OBJECT_USERWITHAUTH

• -u, --unique-data=File OR STDIN:

  An optional file input that contains the unique field of TPMT_PUBLIC in little-endian format. Primary key creator may place information that causes the primary key generation scheme internal to the TPM to generate statistically unique values. The TPM v2.0 specification calls this field unique and overloads it so that it contains one value when the application provides this structure as input and another value when the applications receives this structure as output (like public portion of the rsa key).

  If the data is specified as a file, the user is responsible for ensuring that this buffer is formatted per TPMU_PUBLIC_ID union.

  The unique data can also be retrieved from stdin buffer by specifying “-” as the –unique-data option value and the tool will parse the key type and associate the input data with the unique data buffer associated with the key type.

  NOTE:

  1. The maximum allowed bytes is dependent on key type and the TPM implementation. Eg. While TSS allows a value upto 512 for MAX_RSA_KEY_BYTES, however the ibmSwTPM implementation supports a value upto 256 bytes.
  2. The unique input data specified on stdin for ECC is split for specifying the X coordinate and Y coordinate buffers.

• --creation-data=File:

  An optional file output that saves the creation data for certification.

• --template-data=File:

  An optional file output that saves the key template data (TPM2B_PUBLIC) to be used in tpm2_policytemplate.

• -t, --creation-ticket=File:

  An optional file output that saves the creation ticket for certification.

• -d, --creation-hash=File:

  An optional file output that saves the creation hash for certification.

• -q, --outside-info=FILE_OR_HEX:

  An optional file or hex string to add unique data to the creation data. Note that it does not contribute in creating statistically unique object.

• -l, --pcr-list=PCR:

  The list of PCR banks and selected PCRs’ ids for each bank to be included in the creation data for certification.

• --cphash=File

  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.

• -f, --format:

  Format selection for the public key output file. `tss' (the default) will output a binary blob according to the TPM 2.0 Specification. `pem' will output an OpenSSL compatible PEM encoded public key. `der' will output an OpenSSL compatible DER encoded public key. `tpmt' will output a binary blob of the TPMT_PUBLIC struct referenced by TPM 2.0 specs.

  Public key format.

• -o, --output=File:

  The output file path, recording the public portion of the object.

The type of a context object, whether it is a handle or file name, is determined according to the following logic in-order:

• If the argument is a file path, then the file is loaded as a restored TPM transient object.

• If the argument is a prefix match on one of:

  • owner: the owner hierarchy
  • platform: the platform hierarchy
  • endorsement: the endorsement hierarchy
  • lockout: the lockout control persistent object
• If the argument argument can be loaded as a number it will be treat as a handle, e.g. 0x81010013 and used directly._OBJECT_.

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”.

foobar
str:foobar

hex:1122334455667788

# 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

session:session.ctx

session:session.ctx+mypassword

session:session.ctx+hex:11223344

pcr:sha256:0,1,2,3

Options that take algorithms support “nice-names”.

There are two major algorithm specification string classes, simple and complex. Only certain algorithms will be accepted by the TPM, based on usage and conditions.

Object Attributes are used to control various properties of created objects. When specified as an option, either the raw bitfield mask or “nice-names” may be used. The values can be found in Table 31 Part 2 of the TPM2.0 specification, which can be found here:

<https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-2-Structures-01.38.pdf>

Nice names are calculated by taking the name field of table 31 and removing the prefix TPMA_OBJECT_ and lowercasing the result. Thus, TPMA_OBJECT_FIXEDTPM becomes fixedtpm. Nice names can be joined using the bitwise or “|” symbol.

For instance, to set The fields TPMA_OBJECT_FIXEDTPM, TPMA_OBJECT_NODA, and TPMA_OBJECT_SIGN_ENCRYPT, the argument would be:

fixedtpm|noda|sign specifying the object attributes ATTRIBUTES.

This collection of options are common to many programs and provide information that many users may expect.

• -h, --help=[man|no-man]: Display the tools manpage. By default, it attempts to invoke the manpager for the tool, however, on failure will output a short tool summary. This is the same behavior if the “man” option argument is specified, however if explicit “man” is requested, the tool will provide errors from man on stderr. If the “no-man” option if specified, or the manpager fails, the short options will be output to stdout.

  To successfully use the manpages feature 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. Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.
• -R, --autoflush: Enable autoflush for transient objects created by the command. If a parent object is loaded from a context file also the transient parent object will be flushed. Autoflush can also be activated if the environment variable TPM2TOOLS_AUTOFLUSH is is set to yes or true. information many users may expect.

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:

1. The command line option -T or --tcti
2. The environment variable: TPM2TOOLS_TCTI.

Note: The command line option always overrides the environment variable.

The current known TCTIs are:

• tabrmd - The resource manager, called tabrmd (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and abrmd as a tcti name are synonymous.
• mssim - Typically used for communicating to the TPM software simulator.
• device - Used when talking directly to a TPM device file.
• none - Do not initalize a connection with the TPM. Some tools allow for off-tpm options and thus support not using a TCTI. Tools that do not support it will error when attempted to be used without a TCTI connection. Does not support ANY options and MUST BE presented as the exact text of “none”.

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.

This collection of options are used to configure the various known TCTI modules available:

• device: For the device TCTI, the TPM character device file for use by the device TCTI can be specified. The default is /dev/tpm0.

  Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI=“device:/dev/tpm0”

• mssim: For the mssim TCTI, the domain name or IP address and port number used by the simulator can be specified. The default are 127.0.0.1 and 2321.

  Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TCTI=“mssim:host=localhost,port=2321”

• abrmd: For the abrmd TCTI, the configuration string format is a series of simple key value pairs separated by a `,' character. Each key and value string are separated by a `=' character.

  • TCTI abrmd supports two keys:

    1. `bus_name' : The name of the tabrmd service on the bus (a string).
    2. `bus_type' : The type of the dbus instance (a string) limited to `session' and `system'.

  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.

Tools can return any of the following codes:

• 0 - Success.
• 1 - General non-specific error.
• 2 - Options handling error.
• 3 - Authentication error.
• 4 - TCTI related error.
• 5 - Non supported scheme. Applicable to tpm2_testparams.

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

See the Mailing List (https://lists.linuxfoundation.org/mailman/listinfo/tpm2)