tss2_gettpmblobs.1 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_gettpmblobs" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_gettpmblobs\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_gettpmblobs\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_gettpmblobs\f[](1) \- This command returns the public and
  24. private blobs of an object, such that they could be loaded by a
  25. low\-level API (e.g.
  26. ESAPI).
  27. It also returns the policy associated with these blobs in JSON format.
  28. .SH OPTIONS
  29. .PP
  30. These are the available options:
  31. .IP \[bu] 2
  32. \f[B]\-f\f[], \f[B]\-\-force\f[]:
  33. .RS 2
  34. .PP
  35. Force overwriting the output file.
  36. .RE
  37. .IP \[bu] 2
  38. \f[B]\-p\f[], \f[B]\-\-path\f[]=\f[I]STRING\f[]:
  39. .RS 2
  40. .PP
  41. The path of the object for which the blobs will be returned.
  42. .RE
  43. .IP \[bu] 2
  44. \f[B]\-u\f[], \f[B]\-\-tpm2bPublic\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  45. (for stdout):
  46. .RS 2
  47. .PP
  48. The returned public area of the object as a marshalled TPM2B_PUBLIC.
  49. Optional parameter.
  50. .RE
  51. .IP \[bu] 2
  52. \f[B]\-r\f[], \f[B]\-\-tpm2bPrivate\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  53. (for stdout):
  54. .RS 2
  55. .PP
  56. The returned private area of the object as a marshalled TPM2B_PRIVATE.
  57. Optional parameter.
  58. .RE
  59. .IP \[bu] 2
  60. \f[B]\-l\f[], \f[B]\-\-policy\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  61. stdout):
  62. .RS 2
  63. .PP
  64. The returned policy associated with the object, encoded in JSON.
  65. Optional parameter.
  66. .RE
  67. .SH COMMON OPTIONS
  68. .PP
  69. This collection of options are common to all tss2 programs and provide
  70. information that many users may expect.
  71. .IP \[bu] 2
  72. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  73. manpage.
  74. By default, it attempts to invoke the manpager for the tool, however, on
  75. failure will output a short tool summary.
  76. This is the same behavior if the "man" option argument is specified,
  77. however if explicit "man" is requested, the tool will provide errors
  78. from man on stderr.
  79. If the "no\-man" option if specified, or the manpager fails, the short
  80. options will be output to stdout.
  81. .RS 2
  82. .PP
  83. To successfully use the manpages feature requires the manpages to be
  84. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  85. .RE
  86. .IP \[bu] 2
  87. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  88. tool, supported tctis and exit.
  89. .SH EXAMPLE
  90. .IP
  91. .nf
  92. \f[C]
  93. tss2_gettpmblobs\ \-\-path=HS/SRK/myRSACrypt\ \-\-tpm2bPublic=tpm2bPublic.file\ \-\-tpm2bPrivate=tpm2bPrivate.file\ \-\-policy=policy.file
  94. \f[]
  95. .fi
  96. .SH RETURNS
  97. .PP
  98. 0 on success or 1 on failure.
  99. .SH BUGS
  100. .PP
  101. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  102. .SH HELP
  103. .PP
  104. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)