tss2_verifyquote.1 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_verifyquote" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_verifyquote\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_verifyquote\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_verifyquote\f[](1) \- This command verifies that the data
  24. returned by a quote is valid.
  25. This includes
  26. .IP \[bu] 2
  27. Reconstructing the quoteInfo\[aq]s PCR values from the eventLog (if an
  28. eventLog was provided)
  29. .IP \[bu] 2
  30. Verifying the quoteInfo using the signature and the publicKeyPath
  31. .PP
  32. The used signature verification scheme is specified in the cryptographic
  33. profile (cf., \f[B]fapi\-profile(5)\f[]).
  34. .PP
  35. An application using tss2_verifyquote() will further have to
  36. .IP \[bu] 2
  37. Assess the publicKey\[aq]s trustworthiness
  38. .IP \[bu] 2
  39. Assess the eventLog entries\[aq] trustworthiness
  40. .SH OPTIONS
  41. .PP
  42. These are the available options:
  43. .IP \[bu] 2
  44. \f[B]\-Q\f[], \f[B]\-\-qualifyingData\f[]=\f[I]FILENAME\f[] or
  45. \f[I]\-\f[] (for stdin):
  46. .RS 2
  47. .PP
  48. A nonce provided by the caller to ensure freshness of the signature.
  49. Optional parameter.
  50. .RE
  51. .IP \[bu] 2
  52. \f[B]\-l\f[], \f[B]\-\-pcrLog\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  53. stdin):
  54. .RS 2
  55. .PP
  56. Returns the PCR event log for the chosen PCR.
  57. Optional parameter.
  58. .PP
  59. PCR event logs are a list (arbitrary length JSON array) of log entries
  60. with the following content.
  61. .IP
  62. .nf
  63. \f[C]
  64. \-\ recnum:\ Unique\ record\ number
  65. \-\ pcr:\ PCR\ index
  66. \-\ digest:\ The\ digests
  67. \-\ type:\ The\ type\ of\ event.\ At\ the\ moment\ the\ only\ possible\ value\ is:\ "LINUX_IMA"\ (legacy\ IMA)
  68. \-\ eventDigest:\ Digest\ of\ the\ event;\ e.g.\ the\ digest\ of\ the\ measured\ file
  69. \-\ eventName:\ Name\ of\ the\ event;\ e.g.\ the\ name\ of\ the\ measured\ file.
  70. \f[]
  71. .fi
  72. .RE
  73. .IP \[bu] 2
  74. \f[B]\-q\f[], \f[B]\-\-quoteInfo\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  75. (for stdin):
  76. .RS 2
  77. .PP
  78. The JSON\-encoded structure holding the inputs to the quote operation.
  79. This includes the digest value and PCR values.
  80. .RE
  81. .IP \[bu] 2
  82. \f[B]\-k\f[], \f[B]\-\-publicKeyPath\f[]=\f[I]STRING\f[]:
  83. .RS 2
  84. .PP
  85. Identifies the signing key.
  86. MAY be a path to the public key hierarchy /ext.
  87. .RE
  88. .IP \[bu] 2
  89. \f[B]\-i\f[], \f[B]\-\-signature\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  90. (for stdin):
  91. .RS 2
  92. .PP
  93. The signature over the quoted material.
  94. .RE
  95. .SH COMMON OPTIONS
  96. .PP
  97. This collection of options are common to all tss2 programs and provide
  98. information that many users may expect.
  99. .IP \[bu] 2
  100. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  101. manpage.
  102. By default, it attempts to invoke the manpager for the tool, however, on
  103. failure will output a short tool summary.
  104. This is the same behavior if the "man" option argument is specified,
  105. however if explicit "man" is requested, the tool will provide errors
  106. from man on stderr.
  107. If the "no\-man" option if specified, or the manpager fails, the short
  108. options will be output to stdout.
  109. .RS 2
  110. .PP
  111. To successfully use the manpages feature requires the manpages to be
  112. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  113. .RE
  114. .IP \[bu] 2
  115. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  116. tool, supported tctis and exit.
  117. .SH EXAMPLE
  118. .IP
  119. .nf
  120. \f[C]
  121. \ \ \ \ tss2_verifyquote\ \-\-publicKeyPath="ext/myNewParent"\ \-\-qualifyingData=qualifyingData.file\ \-\-quoteInfo=quoteInfo.file\ \-\-signature=signature.file\ \-\-pcrLog=pcrLog.file
  122. \f[]
  123. .fi
  124. .SH RETURNS
  125. .PP
  126. 0 on success or 1 on failure.
  127. .SH BUGS
  128. .PP
  129. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  130. .SH HELP
  131. .PP
  132. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)