NAME¶

tpm2_encryptdecrypt - performs symmetric encryption or decryption. keyHandle shall reference a symmetric cipher object.

SYNOPSIS¶

tpm2_encryptdecrypt[ COMMON OPTIONS ] [ TCTI OPTIONS ] [ --keyHandle|--keyContext|--pwdk|--decrypt|--inFile|--outFile|--passwdInHex| ]

performs symmetric encryption or decryption. keyHandle shall reference a symmetric cipher object.

DESCRIPTION¶

tpm2_encryptdecrypt performs symmetric encryption or decryption. keyHandle shall reference a symmetric cipher object.

OPTIONS¶

-k ,--keyHandle

the symmetric key used for the operation (encryption/decryption)

-c ,--keyContext

filename of the key context used for the operation

-P ,--pwdk

the password of key, optional

-D ,--decrypt

the operation type, default NO, optional YES the operation is decryption NO the operation is encryption

-I ,--inFile

Input file path, containing the data to be operated

-o ,--outFile

Output file path, record the operated data

-X ,--passwdInHex

passwords given by any options are hex format.

[COMMON OPTIONS ]

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

-h, --help

Display a manual describing the tool and its usage.

-v, --version

Display version information for this tool.

-V, --verbose

Increase the information that the tool prints to the console during its execution.

[TCTI OPTIONS ]

This collection of options are used to configure the varous TCTI modules available.

-T, --tcti

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. Supported TCTIs are or “device” or “socket” .

-d, --device-file

Specify the TPM device file for use by the device TCTI. The default is /dev/tpm0.

-R, --socket-address

Specify the domain name or IP address used by the socket TCTI. The default is 127.0.0.1.

-p, --socket-port

Specify the port number used by the socket TCTI. The default is 2321.

ENVIRONMENT: TCTI

This collection of environment variables that may be used to configure the varous TCTI modules available. The values passed through these variables can be overridden on a per-command basis using the available command line options.

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. See 'OPTIONS' section for the names of supported TCTIs.

TPM2TOOLS_DEVICE_FILE

Specify the TPM device file for use by the device TCTI.

TPM2TOOLS_SOCKET_ADDRESS

Specify the domain name or IP address used by the socket TCTI.

TPM2TOOLS_SOCKET_PORT

Specify the port number used by the socket TCTI.

EXAMPLES¶

tpm2_encryptdecrypt

tpm2_encryptdecrypt -k 0x81010001 -P abc123 -D NO -I <filePath> -o <filePath>
tpm2_encryptdecrypt -c key.context -P abc123 -D NO -I <filePath> -o <filePath>
tpm2_encryptdecrypt -k 0x81010001 -P 123abca -X -D NO -I <filePath> -o <filePath>