.\" Automatically generated by Pandoc 3.1.9
.\"
.TH "tpm2_loadexternal" "1" "" "tpm2-tools" "General Commands Manual"
.SH NAME
\f[B]tpm2_loadexternal\f[R](1) - Load an external object into the TPM.
.SH SYNOPSIS
\f[B]tpm2_loadexternal\f[R] [\f[I]OPTIONS\f[R]]
.SH DESCRIPTION
\f[B]tpm2_loadexternal\f[R](1) - This command loads an external object
into the TPM, forgoing TPM protections.
Ie, the key material is not protected by the parent object\[cq]s seed.
It can also be used to load TSS2 Private Keys in pem format.
The command allows loading of just the public portion of an object or
both the public and private portions of an object.
For TSS2 Private Keys, only the public portion of the key is loaded.
.PP
The tool outputs the name of the loaded object in a YAML dictionary
format with the key \f[I]name\f[R] where the value for that key is the
name of the object in hex format, for example:
.IP
.EX
name: 000bac25cb8743111c8e1f52f2ee7279d05d3902a18dd1af694db5d1afa7adf1c8b3
.EE
.PP
It also saves a context file for future interactions with the object.
.SH OPTIONS
.IP \[bu] 2
\f[B]-C\f[R], \f[B]--hierarchy\f[R]=\f[I]OBJECT\f[R]:
.RS 2
.PP
Hierarchy to use for the ticket, optional.
Defaults to \f[B]n\f[R], \f[B]null\f[R].
Supported options are:
.IP \[bu] 2
\f[B]o\f[R] for the \f[B]owner\f[R] hierarchy.
.IP \[bu] 2
\f[B]p\f[R] for the \f[B]platform\f[R] hierarchy.
.IP \[bu] 2
\f[B]e\f[R] for the \f[B]endorsement\f[R] hierarchy.
.IP \[bu] 2
\f[B]n\f[R] for the \f[B]null\f[R] hierarchy.
.RE
.IP \[bu] 2
\f[B]-G\f[R], \f[B]--key-algorithm\f[R]=\f[I]ALGORITHM\f[R]:
.RS 2
.PP
The algorithm used by the key to be imported.
Supports:
.IP \[bu] 2
\f[B]aes\f[R] - AES 128,192 or 256 key.
.IP \[bu] 2
\f[B]rsa\f[R] - RSA 1024 or 2048 key.
.IP \[bu] 2
\f[B]ecc\f[R] - ECC NIST P192, P224, P256, P384 or P521 public and
private key.
.RE
.IP \[bu] 2
\f[B]-u\f[R], \f[B]--public\f[R]=\f[I]FILE\f[R]:
.RS 2
.PP
The public portion of the object, this can be one of the following file
formats:
.IP \[bu] 2
TSS - The TSS/TPM format.
For example from option \f[CR]-u\f[R] of command
\f[B]tpm2_create\f[R](1).
.IP \[bu] 2
RSA - OSSL PEM formats.
For example \f[CR]public.pem\f[R] from the command
\f[CR]openssl rsa -in private.pem -out public.pem -pubout\f[R]
.IP \[bu] 2
ECC - OSSL PEM formats.
For example \f[CR]public.pem\f[R] from the command
\f[CR]openssl ec -in private.ecc.pem -out public.ecc.pem -pubout\f[R]
.RE
.IP \[bu] 2
\f[B]-r\f[R], \f[B]--private\f[R]=\f[I]FILE\f[R]:
.RS 2
.PP
The sensitive portion of the object, optional.
If one wishes to use the private portion of a key, this must be
specified.
Like option \f[B]-u\f[R], this command takes files in the following
format:
.IP \[bu] 2
RSA - OSSL PEM formats.
For example \f[CR]private.pem\f[R] from the command
\f[CR]openssl genrsa -out private.pem 2048\f[R] Since an RSA public key
can be derived from the private PEM file, their is no need to specify -u
for the public portion.
.IP \[bu] 2
TSS2 PrivateKey PEM formats.
.PP
\f[I]Note\f[R]: The private portion does not respect TSS formats as
it\[cq]s impossible to get a \f[B]TPM2B_SENSITIVE\f[R] output from a
previous command.
They are always protected by the TPM as \f[B]TPM2B_PRIVATE\f[R] blobs.
.RE
.IP \[bu] 2
\f[B]-p\f[R], \f[B]--auth\f[R]=\f[I]AUTH\f[R]:
.RS 2
.PP
The authorization value for the key, optional.
.RE
.IP \[bu] 2
\f[B]-L\f[R], \f[B]--policy\f[R]=\f[I]FILE\f[R] or \f[I]HEX_STRING\f[R]:
.RS 2
.PP
The input policy file or hex string, optional.
A file or hex string containing the hash of a policy derived from
\f[CR]tpm2_createpolicy\f[R] or another policy digest generating source.
.RE
.IP \[bu] 2
\f[B]-g\f[R], \f[B]--hash-algorithm\f[R]=\f[I]ALGORITHM\f[R]:
.RS 2
.PP
The hash algorithm for generating the objects name.
This is optional and defaults to sha256 when not specified.
However, load external supports having a \f[I]null\f[R] name algorithm.
In this case, no cryptographic binding checks between the public and
private portions are performed.
.RE
.IP \[bu] 2
\f[B]-a\f[R], \f[B]--attributes\f[R]=\f[I]ATTRIBUTES\f[R]:
.RS 2
.PP
The object attributes, optional.
The default for created objects is:
\f[CR]TPMA_OBJECT_SIGN_ENCRYPT|TPMA_OBJECT_DECRYPT\f[R].
Optionally, if -p is specified or no \f[CR]-p\f[R] or \f[CR]-L\f[R] is
specified then \f[CR]TPMA_OBJECT_USERWITHAUTH\f[R] is added to the
default attribute set.
.PP
\f[I]Note\f[R]: If specifying attributes, the TPM will reject certain
attributes like \f[B]TPMA_OBJECT_FIXEDTPM\f[R], as those guarantees
cannot be made.
.RE
.IP \[bu] 2
\f[B]-c\f[R], \f[B]--key-context\f[R]=\f[I]FILE\f[R]
.RS 2
.PP
The file name to save the object context, required.
.RE
.IP \[bu] 2
\f[B]-n\f[R], \f[B]--name\f[R]=\f[I]FILE\f[R]:
.RS 2
.PP
An optional file to save the object name, which is in a binary hash
format.
The size of the hash is based on name algorithm or the \f[B]-g\f[R]
option.
.RE
.IP \[bu] 2
\f[B]--passin\f[R]=\f[I]OSSL_PEM_FILE_PASSWORD\f[R]
.RS 2
.PP
An optional password for an Open SSL (OSSL) provided input file.
It mirrors the -passin option of OSSL and is known to support the pass,
file, env, fd and plain password formats of openssl.
(see \f[I]man(1) openssl\f[R]) for more.
.RE
.SS References
.SH Context Object Format
The type of a context object, whether it is a handle or file name, is
determined according to the following logic \f[I]in-order\f[R]:
.IP \[bu] 2
If the argument is a file path, then the file is loaded as a restored
TPM transient object.
.IP \[bu] 2
If the argument is a \f[I]prefix\f[R] match on one of:
.RS 2
.IP \[bu] 2
owner: the owner hierarchy
.IP \[bu] 2
platform: the platform hierarchy
.IP \[bu] 2
endorsement: the endorsement hierarchy
.IP \[bu] 2
lockout: the lockout control persistent object
.RE
.IP \[bu] 2
If the argument argument can be loaded as a number it will be treat as a
handle, e.g.\ 0x81010013 and used directly._OBJECT_.
.SH Authorization Formatting
Authorization for use of an object in TPM2.0 can come in 3 different
forms: 1.
Password 2.
HMAC 3.
Sessions
.PP
\f[B]NOTE:\f[R] \[lq]Authorizations default to the \f[B]EMPTY
PASSWORD\f[R] when not specified\[rq].
.SS Passwords
Passwords are interpreted in the following forms below using prefix
identifiers.
.PP
\f[B]Note\f[R]: By default passwords are assumed to be in the string
form when they do not have a prefix.
.SS String
A string password, specified by prefix \[lq]str:\[rq] or it\[cq]s
absence (raw string without prefix) is not interpreted, and is directly
used for authorization.
.SS Examples
.IP
.EX
foobar
str:foobar
.EE
.SS Hex-string
A hex-string password, specified by prefix \[lq]hex:\[rq] is converted
from a hexidecimal form into a byte array form, thus allowing passwords
with non-printable and/or terminal un-friendly characters.
.SS Example
.IP
.EX
hex:1122334455667788
.EE
.SS File
A file based password, specified be prefix \[lq]file:\[rq] should be the
path of a file containing the password to be read by the tool or a
\[lq]-\[rq] 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.
.SS Examples
.IP
.EX
# 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
.EE
.SS Sessions
When using a policy session to authorize the use of an object, prefix
the option argument with the \f[I]session\f[R] 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 \f[B]Passwords\f[R] section.
.SS Examples
To use a session context file called \f[I]session.ctx\f[R].
.IP
.EX
session:session.ctx
.EE
.PP
To use a session context file called \f[I]session.ctx\f[R] \f[B]AND\f[R]
send the authvalue mypassword.
.IP
.EX
session:session.ctx+mypassword
.EE
.PP
To use a session context file called \f[I]session.ctx\f[R] \f[B]AND\f[R]
send the \f[I]HEX\f[R] authvalue 0x11223344.
.IP
.EX
session:session.ctx+hex:11223344
.EE
.SS PCR Authorizations
You can satisfy a PCR policy using the \[lq]pcr:\[rq] prefix and the PCR
minilanguage.
The PCR minilanguage is as follows: \f[CR]<pcr-spec>=<raw-pcr-file>\f[R]
.PP
The PCR spec is documented in in the section \[lq]PCR bank
specifiers\[rq].
.PP
The \f[CR]raw-pcr-file\f[R] is an \f[B]optional\f[R] argument that
contains the output of the raw PCR contents as returned by
\f[I]tpm2_pcrread(1)\f[R].
.PP
PCR bank specifiers
.SS Examples
To satisfy a PCR policy of sha256 on banks 0, 1, 2 and 3 use a specifier
of:
.IP
.EX
pcr:sha256:0,1,2,3
.EE
.PP
specifying \f[I]AUTH\f[R].
.SH Algorithm Specifiers
Options that take algorithms support \[lq]nice-names\[rq].
.PP
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.
.SS Simple specifiers
These are strings with no additional specification data.
When creating objects, non-specified portions of an object are assumed
to defaults.
You can find the list of known \[lq]Simple Specifiers\[rq] below.
.SS Asymmetric
.IP \[bu] 2
rsa
.IP \[bu] 2
ecc
.SS Symmetric
.IP \[bu] 2
aes
.IP \[bu] 2
camellia
.IP \[bu] 2
sm4
.SS Hashing Algorithms
.IP \[bu] 2
sha1
.IP \[bu] 2
sha256
.IP \[bu] 2
sha384
.IP \[bu] 2
sha512
.IP \[bu] 2
sm3_256
.IP \[bu] 2
sha3_256
.IP \[bu] 2
sha3_384
.IP \[bu] 2
sha3_512
.SS Keyed Hash
.IP \[bu] 2
hmac
.IP \[bu] 2
xor
.SS Signing Schemes
.IP \[bu] 2
rsassa
.IP \[bu] 2
rsapss
.IP \[bu] 2
ecdsa
.IP \[bu] 2
ecdaa
.IP \[bu] 2
ecschnorr
.IP \[bu] 2
sm2
.SS Asymmetric Encryption Schemes
.IP \[bu] 2
oaep
.IP \[bu] 2
rsaes
.IP \[bu] 2
ecdh
.SS Modes
.IP \[bu] 2
ctr
.IP \[bu] 2
ofb
.IP \[bu] 2
cbc
.IP \[bu] 2
cfb
.IP \[bu] 2
ecb
.SS Misc
.IP \[bu] 2
null
.SS Complex Specifiers
Objects, when specified for creation by the TPM, have numerous
algorithms to populate in the public data.
Things like type, scheme and asymmetric details, key size, etc.
Below is the general format for specifying this data:
\f[CR]<type>:<scheme>:<symmetric-details>\f[R]
.SS Type Specifiers
This portion of the complex algorithm specifier is required.
The remaining scheme and symmetric details will default based on the
type specified and the type of the object being created.
.IP \[bu] 2
aes - Default AES: aes128
.IP \[bu] 2
aes128\f[CR]<mode>\f[R] - 128 bit AES with optional mode
(\f[I]ctr\f[R]|\f[I]ofb\f[R]|\f[I]cbc\f[R]|\f[I]cfb\f[R]|\f[I]ecb\f[R]).
If mode is not specified, defaults to \f[I]null\f[R].
.IP \[bu] 2
aes192\f[CR]<mode>\f[R] - Same as aes128\f[CR]<mode>\f[R], except for a
192 bit key size.
.IP \[bu] 2
aes256\f[CR]<mode>\f[R] - Same as aes128\f[CR]<mode>\f[R], except for a
256 bit key size.
.IP \[bu] 2
sm4 - Default SM4: sm4128
.IP \[bu] 2
sm4128 or sm4_128 \f[CR]<mode>\f[R] - 128 bit SM4 with optional mode
(\f[I]ctr\f[R]|\f[I]ofb\f[R]|\f[I]cbc\f[R]|\f[I]cfb\f[R]|\f[I]ecb\f[R]).
If mode is not specified, defaults to \f[I]null\f[R].
.IP \[bu] 2
ecc - Elliptical Curve, defaults to ecc256.
.IP \[bu] 2
ecc192 or ecc_nist_p192 - 192 bit ECC NIST curve
.IP \[bu] 2
ecc224 or ecc_nist_p224 - 224 bit ECC NIST curve
.IP \[bu] 2
ecc256 or ecc_nist_p256 - 256 bit ECC NIST curve
.IP \[bu] 2
ecc384 or ecc_nist_p384 - 384 bit ECC NIST curve
.IP \[bu] 2
ecc521 or ecc_nist_p521 - 521 bit ECC NIST curve
.IP \[bu] 2
ecc_sm2 or ecc_sm2_p256 - 256 bit SM2 curve
.IP \[bu] 2
rsa - Default RSA: rsa2048
.IP \[bu] 2
rsa1024 - RSA with 1024 bit keysize.
.IP \[bu] 2
rsa2048 - RSA with 2048 bit keysize.
.IP \[bu] 2
rsa3072 - RSA with 3072 bit keysize.
.IP \[bu] 2
rsa4096 - RSA with 4096 bit keysize.
.SS Scheme Specifiers
Next, is an optional field, it can be skipped.
.PP
Schemes are usually \f[B]Signing Schemes\f[R] or \f[B]Asymmetric
Encryption Schemes\f[R].
Most signing schemes take a hash algorithm directly following the
signing scheme.
If the hash algorithm is missing, it defaults to \f[I]sha256\f[R].
Some take no arguments, and some take multiple arguments.
.SS Hash Optional Scheme Specifiers
These scheme specifiers are followed by a dash and a valid hash
algorithm, For example: \f[CR]oaep-sha256\f[R].
.IP \[bu] 2
oaep
.IP \[bu] 2
ecdh
.IP \[bu] 2
rsassa
.IP \[bu] 2
rsapss
.IP \[bu] 2
ecdsa
.IP \[bu] 2
ecschnorr
.IP \[bu] 2
sm2
.SS Multiple Option Scheme Specifiers
This scheme specifier is followed by a count (max size UINT16) then
followed by a dash(-) and a valid hash algorithm.
* ecdaa For example, ecdaa4-sha256.
If no count is specified, it defaults to 4.
.SS No Option Scheme Specifiers
This scheme specifier takes NO arguments.
* rsaes
.SS Symmetric Details Specifiers
This field is optional, and defaults based on the \f[I]type\f[R] of
object being created and it\[cq]s attributes.
Generally, any valid \f[B]Symmetric\f[R] specifier from the \f[B]Type
Specifiers\f[R] list should work.
If not specified, an asymmetric objects symmetric details defaults to
\f[I]aes128cfb\f[R].
.SS Examples
.SS Create an rsa2048 key with an rsaes asymmetric encryption scheme
\f[CR]tpm2_create -C parent.ctx -G rsa2048:rsaes -u key.pub -r key.priv\f[R]
.SS Create an ecc256 key with an ecdaa signing scheme with a count of 4 and sha384 hash
\f[CR]/tpm2_create -C parent.ctx -G ecc256:ecdaa4-sha384 -u key.pub -r key.priv\f[R]
cryptographic algorithms \f[I]ALGORITHM\f[R].
.SH Object Attributes
Object Attributes are used to control various properties of created
objects.
When specified as an option, either the raw bitfield mask or
\[lq]nice-names\[rq] may be used.
The values can be found in Table 31 Part 2 of the TPM2.0 specification,
which can be found here:
.PP
\c
.UR
https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-2-Structures-01.38.pdf
.UE \c
.PP
Nice names are calculated by taking the name field of table 31 and
removing the prefix \f[B]TPMA_OBJECT_\f[R] and lowercasing the result.
Thus, \f[B]TPMA_OBJECT_FIXEDTPM\f[R] becomes fixedtpm.
Nice names can be joined using the bitwise or \[lq]|\[rq] symbol.
.PP
For instance, to set The fields \f[B]TPMA_OBJECT_FIXEDTPM\f[R],
\f[B]TPMA_OBJECT_NODA\f[R], and \f[B]TPMA_OBJECT_SIGN_ENCRYPT\f[R], the
argument would be:
.PP
\f[B]fixedtpm|noda|sign\f[R] specifying the object attributes
\f[I]ATTRIBUTES\f[R].
.SH COMMON OPTIONS
This collection of options are common to many programs and provide
information that many users may expect.
.IP \[bu] 2
\f[B]-h\f[R], \f[B]--help=[man|no-man]\f[R]: 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 \[lq]man\[rq] option argument is
specified, however if explicit \[lq]man\[rq] is requested, the tool will
provide errors from man on stderr.
If the \[lq]no-man\[rq] option if specified, or the manpager fails, the
short options will be output to stdout.
.RS 2
.PP
To successfully use the manpages feature requires the manpages to be
installed or on \f[I]MANPATH\f[R], See man(1) for more details.
.RE
.IP \[bu] 2
\f[B]-v\f[R], \f[B]--version\f[R]: Display version information for this
tool, supported tctis and exit.
.IP \[bu] 2
\f[B]-V\f[R], \f[B]--verbose\f[R]: Increase the information that the
tool prints to the console during its execution.
When using this option the file and line number are printed.
.IP \[bu] 2
\f[B]-Q\f[R], \f[B]--quiet\f[R]: Silence normal tool output to stdout.
.IP \[bu] 2
\f[B]-Z\f[R], \f[B]--enable-errata\f[R]: 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.
.IP \[bu] 2
\f[B]-R\f[R], \f[B]--autoflush\f[R]: 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.
.SH TCTI Configuration
The TCTI or \[lq]Transmission Interface\[rq] is the communication
mechanism with the TPM.
TCTIs can be changed for communication with TPMs across different
mediums.
.PP
To control the TCTI, the tools respect:
.IP "1." 3
The command line option \f[B]-T\f[R] or \f[B]--tcti\f[R]
.IP "2." 3
The environment variable: \f[I]TPM2TOOLS_TCTI\f[R].
.PP
\f[B]Note:\f[R] The command line option always overrides the environment
variable.
.PP
The current known TCTIs are:
.IP \[bu] 2
tabrmd - The resource manager, called \c
.UR https://github.com/tpm2-software/tpm2-abrmd
tabrmd
.UE \c
\&.
Note that tabrmd and abrmd as a tcti name are synonymous.
.IP \[bu] 2
mssim - Typically used for communicating to the TPM software simulator.
.IP \[bu] 2
device - Used when talking directly to a TPM device file.
.IP \[bu] 2
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 \f[I]ANY\f[R] options and \f[I]MUST BE\f[R] presented
as the exact text of \[lq]none\[rq].
.PP
The arguments to either the command line option or the environment
variable are in the form:
.PP
\f[CR]<tcti-name>:<tcti-option-config>\f[R]
.PP
Specifying an empty string for either the \f[CR]<tcti-name>\f[R] or
\f[CR]<tcti-option-config>\f[R] results in the default being used for
that portion respectively.
.SS TCTI Defaults
When a TCTI is not specified, the default TCTI is searched for using
\f[I]dlopen(3)\f[R] semantics.
The tools will search for \f[I]tabrmd\f[R], \f[I]device\f[R] and
\f[I]mssim\f[R] TCTIs \f[B]IN THAT ORDER\f[R] and \f[B]USE THE FIRST ONE
FOUND\f[R].
You can query what TCTI will be chosen as the default by using the
\f[B]-v\f[R] option to print the version information.
The \[lq]default-tcti\[rq] key-value pair will indicate which of the
aforementioned TCTIs is the default.
.SS Custom TCTIs
Any TCTI that implements the dynamic TCTI interface can be loaded.
The tools internally use \f[I]dlopen(3)\f[R], and the raw
\f[I]tcti-name\f[R] value is used for the lookup.
Thus, this could be a path to the shared library, or a library name as
understood by \f[I]dlopen(3)\f[R] semantics.
.SH TCTI OPTIONS
This collection of options are used to configure the various known TCTI
modules available:
.IP \[bu] 2
\f[B]device\f[R]: For the device TCTI, the TPM character device file for
use by the device TCTI can be specified.
The default is \f[I]/dev/tpm0\f[R].
.RS 2
.PP
Example: \f[B]-T device:/dev/tpm0\f[R] or \f[B]export
\f[BI]TPM2TOOLS_TCTI\f[B]=\[lq]device:/dev/tpm0\[rq]\f[R]
.RE
.IP \[bu] 2
\f[B]mssim\f[R]: 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.
.RS 2
.PP
Example: \f[B]-T mssim:host=localhost,port=2321\f[R] or \f[B]export
\f[BI]TPM2TOOLS_TCTI\f[B]=\[lq]mssim:host=localhost,port=2321\[rq]\f[R]
.RE
.IP \[bu] 2
\f[B]abrmd\f[R]: 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.
.RS 2
.IP \[bu] 2
TCTI abrmd supports two keys:
.RS 2
.IP "1." 3
`bus_name' : The name of the tabrmd service on the bus (a string).
.IP "2." 3
`bus_type' : The type of the dbus instance (a string) limited to
`session' and `system'.
.RE
.PP
Specify the tabrmd tcti name and a config string of
\f[CR]bus_name=com.example.FooBar\f[R]:
.IP
.EX
\[rs]--tcti=tabrmd:bus_name=com.example.FooBar
.EE
.PP
Specify the default (abrmd) tcti and a config string of
\f[CR]bus_type=session\f[R]:
.IP
.EX
\[rs]--tcti:bus_type=session
.EE
.PP
\f[B]NOTE\f[R]: abrmd and tabrmd are synonymous.
the various known TCTI modules.
.RE
.SH NOTES
.IP \[bu] 2
If the hierarchy is \f[I]null\f[R] or the name hashing algorithm is
\f[I]null\f[R], tickets produced using the object will be NULL.
.IP \[bu] 2
If the private portion of an object is specified, the hierarchy must be
\f[I]null\f[R] or the TPM will reject loading it.
.SH EXAMPLES
.SS Load a TPM generated public key into the \f[I]owner\f[R] hierarchy
.IP
.EX
tpm2_createprimary -c primary.ctx

tpm2_create -C primary.ctx -u pub.dat -r priv.dat

tpm2_loadexternal -C o -u pub.dat -c pub.ctx
name: 000b9be4d7c6193a57e1bfc86a42a6b03856a91d2f9e77c6cbdb796a783d52d4b3b9
.EE
.SS Load an RSA public key into the \f[I]owner\f[R] hierarchy
.IP
.EX
openssl genrsa -out private.pem 2048

openssl rsa -in private.pem -out public.pem -outform PEM -pubout

tpm2_loadexternal -C o -Grsa -u public.pem -c key.ctx
name: 000b7b91d304d16995d42792b57d0fb25df7abe5fdd8afe9950730e00dc5b934ddbc
.EE
.SS Load an RSA key-pair into the \f[I]null\f[R] hierarchy
.IP
.EX
openssl genrsa -out private.pem 2048

tpm2_loadexternal -C n -Grsa -r private.pem -c key.ctx
name: 000b635ea220b6c62ec1d02343859dd203c8ac5dad82ebc5b124e407d2502f88691f
.EE
.SS Load an AES key into the \f[I]null\f[R] hierarchy
.IP
.EX
dd if=/dev/urandom of=sym.key bs=1 count=16

tpm2_loadexternal -C n -Gaes -r sym.key -c key.ctx
name: 000bfc4d8dd7e4f921bcc9dca4b04f49564243cd9def129a3740002bfd4b9e966d34
.EE
.SS Load TSS2 Private Key into the \f[I]null\f[R] hierarchy
.IP
.EX
tpm2_loadexternal -r tss_privkey.pem -c tss_privkey.ctx
name: 000bc5a216702aca9ba226af1214c50dc4dc33ce6269677aa581ea6d9eec7f27000d
.EE
.SH Returns
Tools can return any of the following codes:
.IP \[bu] 2
0 - Success.
.IP \[bu] 2
1 - General non-specific error.
.IP \[bu] 2
2 - Options handling error.
.IP \[bu] 2
3 - Authentication error.
.IP \[bu] 2
4 - TCTI related error.
.IP \[bu] 2
5 - Non supported scheme.
Applicable to tpm2_testparams.
.SH BUGS
\c
.UR https://github.com/tpm2-software/tpm2-tools/issues
Github Issues
.UE \c
.SH HELP
See the \c
.UR https://lists.linuxfoundation.org/mailman/listinfo/tpm2
Mailing List
.UE \c