1tpm2_loadexternal(1)        General Commands Manual       tpm2_loadexternal(1)
2
3
4

NAME

6       tpm2_loadexternal(1)  -  load  an object that is not a Protected Object
7       into the TPM.
8

SYNOPSIS

10       tpm2_loadexternal [OPTIONS]
11

DESCRIPTION

13       tpm2_loadexternal(1) - load an object that is not  a  Protected  Object
14       into  the  TPM.   The command allows loading of a public area or both a
15       public and a sensitive area.
16

OPTIONS

18       · -H, –hierarchy=HIERARCHY: hierarchy to use for the ticket.  Supported
19         options are:
20
21         · o for TPM_RH_OWNER
22
23         · p for TPM_RH_PLATFORM
24
25         · e for TPM_RH_ENDORSEMENT
26
27         · n for TPM_RH_NULL
28
29       · -u, –pubfile=PUBLIC_FILE: The public portion of the object.
30
31       · -r,  –privfile=PRIVATE_FILE: The sensitive portion of the object, op‐
32         tional.
33
34       · -C, –context=CONTEXT_FILE The file to save the  object  context,  op‐
35         tional.
36

COMMON OPTIONS

38       This  collection of options are common to many programs and provide in‐
39       formation that many users may expect.
40
41       · -h, –help: Display the tools manpage.  This requires the manpages  to
42         be installed or on MANPATH, See man(1) for more details.
43
44       · -v,  –version:  Display  version information for this tool, supported
45         tctis and exit.
46
47       · -V, –verbose: Increase the information that the tool  prints  to  the
48         console  during  its  execution.  When using this option the file and
49         line number are printed.
50
51       · -Q, –quiet: Silence normal tool output to stdout.
52
53       · -Z, –enable-errata: Enable the application of errata fixups.   Useful
54         if  an  errata fixup needs to be applied to commands sent to the TPM.
55         # TCTI ENVIRONMENT
56
57       This collection of environment variables that may be used to  configure
58       the various TCTI modules available.
59
60       The  values  passed  through  these  variables  can  be overridden on a
61       per-command basis using the available command line options, see the TC‐
62       TI_OPTIONS section.
63
64       The variables respected depend on how the software was configured.
65
66       · TPM2TOOLS_TCTI_NAME:  Select the TCTI used for communication with the
67         next component down the TSS stack.  In most configurations this  will
68         be  the  TPM but it could be a simulator or proxy.  The current known
69         TCTIs are:
70
71         · tabrmd   -   The    new    resource    manager,    called    tabrmd
72           (https://github.com/01org/tpm2-abrmd).
73
74         · socket  -  Typically used with the old resource manager, or talking
75           directly to a simulator.
76
77         · device - Used when talking directly to a TPM device file.
78
79       · TPM2TOOLS_DEVICE_FILE: When using the device TCTI,  specify  the  TPM
80         device file.  The default is “/dev/tpm0”.
81
82         Note:  Using  the tpm directly requires the users to ensure that con‐
83         current access does not occur and that they manage the tpm resources.
84         These  tasks  are  usually managed by a resource manager.  Linux 4.12
85         and greater supports an in kernel resource manager  at  “/dev/tpmrm”,
86         typically “/dev/tpmrm0”.
87
88       · TPM2TOOLS_SOCKET_ADDRESS: When using the socket TCTI, specify the do‐
89         main name or IP address used.  The default is 127.0.0.1.
90
91       · TPM2TOOLS_SOCKET_PORT: When using the socket TCTI, specify  the  port
92         number used.  The default is 2321.
93

TCTI OPTIONS

95       This  collection  of options are used to configure the varous TCTI mod‐
96       ules available.  They override any environment variables.
97
98       · -T, –tcti=TCTI_NAME[:TCTI_OPTIONS]: Select the TCTI used for communi‐
99         cation  with the next component down the TSS stack.  In most configu‐
100         rations   this    will    be    the    resource    manager:    tabrmd
101         (https://github.com/01org/tpm2-abrmd)  Optionally,  tcti specific op‐
102         tions can appended to TCTI_NAME by appending a : to TCTI_NAME.
103
104         · For the device TCTI, the TPM device file for use by the device TCTI
105           can  be  specified.   The  default  is  /dev/tpm0.  Example: -T de‐
106           vice:/dev/tpm0
107
108         · For the socket TCTI, the domain name or IP address and port  number
109           used by the socket can be specified.  The default are 127.0.0.1 and
110           2321.  Example: -T socket:127.0.0.1:2321
111
112         · For the abrmd TCTI, it takes no options.  Example: -T abrmd
113

EXAMPLES

115       Load a public area generated by tpm2_create, tpm2_readpublic or manual‐
116       ly
117
118              tpm2_loadexternal -H <e|o|p|n> -u <pubKeyFileName> -C object.context
119
120       Load  a  key with sensitive area.  Both the public & the senstive areas
121       shall be generated  externally.   DON'T  use  the  areas  generated  by
122       tpm2_create.
123
124              tpm2_loadexternal -H n -u <pubKeyFileName> -r <privKeyFileName> -C object.context
125

RETURNS

127       0 on success or 1 on failure.
128

BUGS

130       Github Issues (https://github.com/01org/tpm2-tools/issues)
131

HELP

133       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
134
135
136
137tpm2-tools                      SEPTEMBER 2017            tpm2_loadexternal(1)