tss2_provision.1 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_provision" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_provision\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_provision\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_provision\f[](1) \- This command provisions a FAPI instance
  24. and its associated TPM.
  25. The steps taken are:
  26. .IP \[bu] 2
  27. Retrieve the EK template, nonce and certificate, verify that they match
  28. the TPM\[aq]s EK and store them in the key store.
  29. .IP \[bu] 2
  30. Set the authValues and policies for the Owner (Storage Hierarchy), the
  31. Privacy Administrator (Endorsement Hierarchy) and the lockout authority.
  32. .IP \[bu] 2
  33. Scan the TPM\[aq]s nv indices and create entries in the FAPI metadata
  34. store.
  35. This operation MAY use a heuristic to guess the originating programs for
  36. nv indices found and name the entries accordingly.
  37. .IP \[bu] 2
  38. Create the SRK (storage primary key) inside the TPM and make it
  39. persistent if required by the cryptographic profile (cf.,
  40. \f[B]fapi\-profile(5)\f[]) and store its metadata in the system\-wide
  41. FAPI metadata store.
  42. Note that the SRK will not have an authorization value associated.
  43. .PP
  44. If an authorization value is associated with the storage hierarchy, it
  45. is highly recommended that the SRK without authorization value is made
  46. persistent.
  47. .PP
  48. The paths of the different metadata storages for keys and nv indices are
  49. configured in the FAPI configuration file (cf.,
  50. \f[B]fapi\-config(5)\f[]).
  51. .SH OPTIONS
  52. .PP
  53. These are the available options:
  54. .IP \[bu] 2
  55. \f[B]\-E\f[], \f[B]\-\-authValueEh\f[]=\f[I]STRING\f[]: The
  56. authorization value for the privacy admin, i.e.
  57. the endorsement hierarchy.
  58. Optional parameter.
  59. .IP \[bu] 2
  60. \f[B]\-S\f[], \f[B]\-\-authValueSh\f[]=\f[I]STRING\f[]: The
  61. authorization value for the owner, i.e.
  62. the storage hierarchy.
  63. Optional parameter.
  64. .IP \[bu] 2
  65. \f[B]\-L\f[], \f[B]\-\-authValueLockout\f[]=\f[I]STRING\f[]: The
  66. authorization value for the lockout authorization.
  67. Optional parameter.
  68. .SH COMMON OPTIONS
  69. .PP
  70. This collection of options are common to all tss2 programs and provide
  71. information that many users may expect.
  72. .IP \[bu] 2
  73. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  74. manpage.
  75. By default, it attempts to invoke the manpager for the tool, however, on
  76. failure will output a short tool summary.
  77. This is the same behavior if the "man" option argument is specified,
  78. however if explicit "man" is requested, the tool will provide errors
  79. from man on stderr.
  80. If the "no\-man" option if specified, or the manpager fails, the short
  81. options will be output to stdout.
  82. .RS 2
  83. .PP
  84. To successfully use the manpages feature requires the manpages to be
  85. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  86. .RE
  87. .IP \[bu] 2
  88. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  89. tool, supported tctis and exit.
  90. .SH EXAMPLE
  91. .IP
  92. .nf
  93. \f[C]
  94. tss2_provision
  95. \f[]
  96. .fi
  97. .SH RETURNS
  98. .PP
  99. 0 on success or 1 on failure.
  100. .SH BUGS
  101. .PP
  102. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  103. .SH HELP
  104. .PP
  105. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)