tss2_unseal.1 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_unseal" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_unseal\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_unseal\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_unseal\f[](1) \- This command unseals data from a seal in the
  24. FAPI metadata store.
  25. The used decryption scheme is specified in the cryptographic profile
  26. (cf., \f[B]fapi\-profile(5)\f[]).
  27. .SH OPTIONS
  28. .PP
  29. These are the available options:
  30. .IP \[bu] 2
  31. \f[B]\-f\f[], \f[B]\-\-force\f[]:
  32. .RS 2
  33. .PP
  34. Force overwriting the output file.
  35. .RE
  36. .IP \[bu] 2
  37. \f[B]\-p\f[], \f[B]\-\-path\f[]=\f[I]STRING\f[]:
  38. .RS 2
  39. .PP
  40. Path of the object for which the blobs will be returned.
  41. .RE
  42. .IP \[bu] 2
  43. \f[B]\-o\f[], \f[B]\-\-data\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  44. stdout):
  45. .RS 2
  46. .PP
  47. The decrypted data after unsealing.
  48. Optional parameter.
  49. .RE
  50. .SH COMMON OPTIONS
  51. .PP
  52. This collection of options are common to all tss2 programs and provide
  53. information that many users may expect.
  54. .IP \[bu] 2
  55. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  56. manpage.
  57. By default, it attempts to invoke the manpager for the tool, however, on
  58. failure will output a short tool summary.
  59. This is the same behavior if the "man" option argument is specified,
  60. however if explicit "man" is requested, the tool will provide errors
  61. from man on stderr.
  62. If the "no\-man" option if specified, or the manpager fails, the short
  63. options will be output to stdout.
  64. .RS 2
  65. .PP
  66. To successfully use the manpages feature requires the manpages to be
  67. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  68. .RE
  69. .IP \[bu] 2
  70. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  71. tool, supported tctis and exit.
  72. .SH EXAMPLE
  73. .IP
  74. .nf
  75. \f[C]
  76. tss2_unseal\ \-\-path=HS/SRK/myRSACrypt\ \-\-data=data.file
  77. \f[]
  78. .fi
  79. .SH RETURNS
  80. .PP
  81. 0 on success or 1 on failure.
  82. .SH BUGS
  83. .PP
  84. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  85. .SH HELP
  86. .PP
  87. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)