tss2_delete.1 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_delete" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_delete\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_delete\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_delete\f[](1) \- This command deletes the given key, policy or
  24. NV from the FAPI metadata store and the TPM.
  25. Depending on the entity type, one of the following actions are taken:
  26. .IP
  27. .nf
  28. \f[C]
  29. \-\ Non\-persistent\ key:\ Flush\ from\ TPM\ (if\ loaded)\ and\ delete\ public\ and\ private\ blobs\ from\ keystore.
  30. \-\ Persistent\ keys:\ Evict\ from\ TPM\ and\ delete\ public\ and\ private\ blobs\ from\ keystore
  31. \-\ Primary\ keys:\ Flush\ from\ TPM\ and\ delete\ public\ blob\ from\ keystore
  32. \-\ NV\ index:\ Undefine\ NV\ index\ from\ TPM\ and\ delete\ public\ blob\ from\ FAPI\ metadata\ store
  33. \-\ Policies:\ Delete\ entry\ from\ policy\ store
  34. \-\ Hierarchy,\ PCR:\ These\ are\ not\ deletable
  35. \-\ Special\ keys\ ek,\ srk:\ These\ are\ not\ deletable
  36. \f[]
  37. .fi
  38. .SH OPTIONS
  39. .PP
  40. These are the available options:
  41. .IP \[bu] 2
  42. \f[B]\-p\f[], \f[B]\-\-path\f[]=\f[I]STRING\f[]:
  43. .RS 2
  44. .PP
  45. The path to the entity to delete.
  46. .RE
  47. .SH COMMON OPTIONS
  48. .PP
  49. This collection of options are common to all tss2 programs and provide
  50. information that many users may expect.
  51. .IP \[bu] 2
  52. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  53. manpage.
  54. By default, it attempts to invoke the manpager for the tool, however, on
  55. failure will output a short tool summary.
  56. This is the same behavior if the "man" option argument is specified,
  57. however if explicit "man" is requested, the tool will provide errors
  58. from man on stderr.
  59. If the "no\-man" option if specified, or the manpager fails, the short
  60. options will be output to stdout.
  61. .RS 2
  62. .PP
  63. To successfully use the manpages feature requires the manpages to be
  64. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  65. .RE
  66. .IP \[bu] 2
  67. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  68. tool, supported tctis and exit.
  69. .SH EXAMPLE
  70. .SH Deletes storage hierarchy (HS) and everything below it:
  71. .IP
  72. .nf
  73. \f[C]
  74. tss2_delete\ \-\-path=/HS
  75. \f[]
  76. .fi
  77. .SH RETURNS
  78. .PP
  79. 0 on success or 1 on failure.
  80. .SH BUGS
  81. .PP
  82. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  83. .SH HELP
  84. .PP
  85. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)