tss2_exportkey.1 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_exportkey" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_exportkey\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_exportkey\f[] [\f[I]OPTIONS\f[]]
  11. .SH SEE ALSO
  12. .PP
  13. \f[B]fapi\-config(5)\f[] to adjust Fapi parameters like the used
  14. cryptographic profile and TCTI or directories for the Fapi metadata
  15. storages.
  16. .PP
  17. \f[B]fapi\-profile(5)\f[] to determine the cryptographic algorithms and
  18. parameters for all keys and operations of a specific TPM interaction
  19. like the name hash algorithm, the asymmetric signature algorithm, scheme
  20. and parameters and PCR bank selection.
  21. .SH DESCRIPTION
  22. .PP
  23. \f[B]tss2_exportkey\f[](1) \- This command will duplicate a key and
  24. encrypt it using the public key of a new parent.
  25. The exported data will contain the re\-wrapped key pointed to by the
  26. pathOfKeyToDuplicate and then the JSON encoded policy.
  27. Encryption is done according to TPM encryption schemes specified in the
  28. cryptographic profile (cf., \f[B]fapi\-profile(5)\f[]).
  29. .SH OPTIONS
  30. .PP
  31. These are the available options:
  32. .IP \[bu] 2
  33. \f[B]\-e\f[] \f[B]\-\-pathToPublicKeyOfNewParent\f[]=\f[I]STRING\f[]:
  34. .RS 2
  35. .PP
  36. The path to the public key of the new parent.
  37. This key MAY be in the public key hierarchy /ext.
  38. Optional parameter.
  39. If omitted only the public key will exported.
  40. .RE
  41. .IP \[bu] 2
  42. \f[B]\-f\f[], \f[B]\-\-force\f[]:
  43. .RS 2
  44. .PP
  45. Force overwriting the output file.
  46. .RE
  47. .IP \[bu] 2
  48. \f[B]\-o\f[], \f[B]\-\-exportedData\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  49. (for stdout):
  50. .RS 2
  51. .PP
  52. Returns the exported subtree.
  53. .RE
  54. .IP \[bu] 2
  55. \f[B]\-p\f[], \f[B]\-\-pathOfKeyToDuplicate\f[]=\f[I]STRING\f[]:
  56. .RS 2
  57. .PP
  58. The path to the root of the subtree to export.
  59. .RE
  60. .SH COMMON OPTIONS
  61. .PP
  62. This collection of options are common to all tss2 programs and provide
  63. information that many users may expect.
  64. .IP \[bu] 2
  65. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  66. manpage.
  67. By default, it attempts to invoke the manpager for the tool, however, on
  68. failure will output a short tool summary.
  69. This is the same behavior if the "man" option argument is specified,
  70. however if explicit "man" is requested, the tool will provide errors
  71. from man on stderr.
  72. If the "no\-man" option if specified, or the manpager fails, the short
  73. options will be output to stdout.
  74. .RS 2
  75. .PP
  76. To successfully use the manpages feature requires the manpages to be
  77. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  78. .RE
  79. .IP \[bu] 2
  80. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  81. tool, supported tctis and exit.
  82. .SH EXAMPLE
  83. .IP
  84. .nf
  85. \f[C]
  86. tss2_exportkey\ \-\-pathOfKeyToDuplicate=HS/SRK/myRSADecrypt\ \-\-exportedData=exportedData.file
  87. \f[]
  88. .fi
  89. .SH RETURNS
  90. .PP
  91. 0 on success or 1 on failure.
  92. .SH BUGS
  93. .PP
  94. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  95. .SH HELP
  96. .PP
  97. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)