tpm2_nvundefine(1)

📦
version 5.8 · 10 versions
, in arch rolling

💅 tpm2_nvundefine(1) — delete a Non-Volatile (NV) index, bestie 💅

okay so this is the General Commands Manual page for tpm2_nvundefine(1), and it is literally all about deleting a Non-Volatile (NV) index. no cap. ✨

✨ NAME ✨

tpm2_nvundefine(1) — Delete a Non-Volatile (NV) index.

🎀 SYNOPSIS 🎀

tpm2_nvundefine [OPTIONS] [ARGUMENT]

🦋 DESCRIPTION 🦋

So tpm2_nvundefine(1) deletes a Non-Volatile (NV) index that was previously defined with tpm2_nvdefine(1). The index is specified as an argument, bestie. It can be a raw handle or an offset value to the nv handle range “TPM2_HR_NV_INDEX”.

The tool is also capable of deleting NV indices with attribute TPMA_NV_POLICY_DELETE, and the tool uses this attribute for the default hierarchy to select when -C is missing. The default value for -C is the “owner” hierarchy when TPMA_NV_POLICY_DELETE is clear and “platform” when TPMA_NV_POLICY_DELETE is set. 💅

✨ OPTIONS ✨

  • -C, --hierarchy=OBJECT — specifies the hierarchy used to authorize. Supported options are:
    • o for TPM_RH_OWNER
    • p for TPM_RH_PLATFORM
    • <num> where a hierarchy handle may be specified.
  • -P, --auth=AUTH — specifies the authorization value for the hierarchy.
  • -S, --session=POLICY_SESSION — specify a policy session to use when the NV index has attribute TPMA_NV_POLICY_DELETE set. This can also be used to specify an auxiliary session for auditing and or encryption/decryption of the parameters. Note:
    1. If TPM2_CC_NV_UndefineSpaceSpecial is invoked then only one additional aux session can be specified. The order of how sessions are specified also matters. First specification of -S is interpreted as the session for satisfying the ADMIN role required for TPM2_CC_NV_UndefineSpaceSpecial. If a password is used for the NV object the password has to be added to the the session path: path+passwdord.
    2. If TPM2_CC_NV_Undefine is invoked then only two additional aux sessions can be specified.
  • --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, it simply returns a cpHash unless rphash is also required.
  • --rphash=FILE — file path to record the hash of the response parameters. This is commonly termed as rpHash.
  • --with-policydelete=NONE — this must be specified when calculating cpHash with --tcti=none. This is a requirement because there is no way to know if the attribute TPMA_NV_POLICYDELETE has been set from the NV index name alone.
  • -n, --name=FILE — the name of the NV index that must be provided when only calculating the cpHash without actually dispatching the command to the TPM.
  • ARGUMENT — the command line argument specifies the NV index or offset number.

📚 References

✨ section-label moment ✨

🧸 Context Object Format

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 can be loaded as a number it will be treated as a handle, e.g. 0x81010013 and used directly._OBJECT_.

🔐 Authorization Formatting

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

For authentication with auth values, the tool commands implicitly generate an HMAC session. Thus passwords are not transmitted unencrypted. This does not apply to passwords defined for objects. In this case, an HMAC session should be used (see tpm2_startauthsession(1)).

🔑 Passwords

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.

🔤 String

A string password, specified by prefix str: or its absence (raw string without prefix) is not interpreted, and is directly used for authorization.

💬 Examples

foobar
str:foobar

🧬 Hex-string

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.

🧪 Example

hex:1122334455667788

📁 File

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.

📂 Examples

# 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

🪄 Sessions

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.

🪄 Examples

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

🧬 PCR Authorizations

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 argument that contains the output of the raw PCR contents as returned by tpm2_pcrread(1).

🏦 PCR bank specifiers

✨ label only ✨

🧪 Examples

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.

🌟 COMMON OPTIONS

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

  • -h, --help=[man|no-man] — Display the tool's 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 is 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.
  • -z, --pwd-session — Use password session instead of a HMAC session for authentication. A clear text password is passed to the TPM to authorize the action. This option can be used to avoid problems when unsalted sessions are used in OpenSSL FIPS mode. If auth values are used a salted session should be used for authentication.
  • -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 set to yes or true. information many users may expect.

📡 TCTI Configuration

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

🧚 TCTI Defaults

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.

🌈 Custom TCTIs

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.

✨ TCTI OPTIONS ✨

okay so this little collection of options is literally how you 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.

🌸 EXAMPLES 🌸

Define an ordinary NV index and delete it

tpm2_nvdefine 1

tpm2_nvundefine 1

Define an ordinary NV index with attribute TPMA_NV_POLICY_DELETE and delete it

tpm2_startauthsession -S s.ctx

tpm2_policyauthvalue -S s.ctx

tpm2_policycommandcode -S s.ctx -L policy.dat TPM2_CC_NV_UndefineSpaceSpecial

tpm2_nvdefine -C p -s 32 \
  -a "ppread|ppwrite|authread|authwrite|platformcreate|policydelete|write_stclear|read_stclear" \
  -L policy.dat 1

tpm2_flushcontext s.ctx

tpm2_startauthsession --policy-session -S s.ctx

tpm2_policyauthvalue -S s.ctx

tpm2_policycommandcode -S s.ctx TPM2_CC_NV_UndefineSpaceSpecial

tpm2_nvundefine -S s.ctx 1

If a password is used for the nv object. The nv undefine command has to be executed as follows:

tpm2_nvundefine -S s.ctx+mypassword  1

💖 Returns 💖

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.

🐛 BUGS 🐛

Github Issues

🆘 HELP 🆘

See the Mailing List

📜 License 📜

This work is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

💖 sign-off from the tpm2-tools source, page tpm2_nvundefine(1) — no date in this footer bestie, so we're not inventing one, periodt 🎀

📦 where this page comes from