tss2_changeauth.1 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_changeauth" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_changeauth\f[](1) \- This command changes the authorization
  8. data of an entity referred to by the path.
  9. .SH SYNOPSIS
  10. .PP
  11. \f[B]tss2_changeauth\f[] [\f[I]OPTIONS\f[]]
  12. .SH SEE ALSO
  13. .PP
  14. \f[B]fapi\-config(5)\f[] to adjust Fapi parameters like the used
  15. cryptographic profile and TCTI or directories for the Fapi metadata
  16. storages.
  17. .PP
  18. \f[B]fapi\-profile(5)\f[] to determine the cryptographic algorithms and
  19. parameters for all keys and operations of a specific TPM interaction
  20. like the name hash algorithm, the asymmetric signature algorithm, scheme
  21. and parameters and PCR bank selection.
  22. .SH DESCRIPTION
  23. .PP
  24. \f[B]tss2_changeauth\f[](1) \-
  25. .SH OPTIONS
  26. .PP
  27. These are the available options:
  28. .IP \[bu] 2
  29. \f[B]\-a\f[], \f[B]\-\-authValue\f[]=\f[I]STRING\f[]:
  30. .RS 2
  31. .PP
  32. The new UTF\-8 password.
  33. Optional parameter.
  34. If it is neglected then the user is queried interactively for a
  35. password.
  36. To set no password, this option should be used with the empty string
  37. ("").
  38. The maximum password size is determined by the digest size of the chosen
  39. name hash algorithm in the cryptographic profile (cf.,
  40. \f[B]fapi\-profile(5)\f[]).
  41. For example, choosing SHA256 as hash algorithm, allows passwords of a
  42. maximum size of 32 characters.
  43. .RE
  44. .IP \[bu] 2
  45. \f[B]\-p\f[], \f[B]\-\-entityPath\f[]=\f[I]STRING\f[]:
  46. .RS 2
  47. .PP
  48. The path identifying the entity to modify.
  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 EXAMPLES
  73. .SS Change a password for an entity HS/SRK/myRSACryptKey to M1
  74. .IP
  75. .nf
  76. \f[C]
  77. tss2_changeauth\ \-\-entityPath=HS/SRK/myRSACryptKey\ \-\-authValue=M1
  78. \f[]
  79. .fi
  80. .SS Change a password for an entity HS/SRK/myRSACryptKey and ask the
  81. user to enter the password.
  82. .IP
  83. .nf
  84. \f[C]
  85. tss2_changeauth\ \-\-entityPath=HS/SRK/myRSACryptKey
  86. \f[]
  87. .fi
  88. .SH RETURNS
  89. .PP
  90. 0 on success or 1 on failure.
  91. .SH BUGS
  92. .PP
  93. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  94. .SH HELP
  95. .PP
  96. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)