tss2_setappdata.1 2.5 KB

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