tss2_encrypt.1 2.6 KB

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