tss2_sign.1 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_sign" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_sign\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_sign\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_sign\f[](1) \- This command uses a key inside the TPM to sign
  24. a digest value using the TPM signing schemes as specified in the
  25. cryptographic profile (cf., \f[B]fapi\-profile(5)\f[]).
  26. .SH OPTIONS
  27. .PP
  28. These are the available options:
  29. .IP \[bu] 2
  30. \f[B]\-p\f[], \f[B]\-\-keyPath\f[]=\f[I]STRING\f[]:
  31. .RS 2
  32. .PP
  33. The path to the signing key.
  34. .RE
  35. .IP \[bu] 2
  36. \f[B]\-s\f[], \f[B]\-\-padding\f[]=\f[I]STRING\f[]:
  37. .RS 2
  38. .PP
  39. The padding scheme used.
  40. Possible values are "RSA_SSA", "RSA_PSS" (case insensitive).
  41. Optional parameter.
  42. If omitted, the default padding specified in the cryptographic profile
  43. (cf., \f[B]fapi\-profile(5)\f[]) is used.
  44. .RE
  45. .IP \[bu] 2
  46. \f[B]\-c\f[], \f[B]\-\-certificate\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  47. (for stdout):
  48. .RS 2
  49. .PP
  50. The certificate associated with keyPath in PEM format.
  51. Optional parameter.
  52. .RE
  53. .IP \[bu] 2
  54. \f[B]\-d\f[], \f[B]\-\-digest\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  55. stdin):
  56. .RS 2
  57. .PP
  58. The data to be signed, already hashed.
  59. .RE
  60. .IP \[bu] 2
  61. \f[B]\-f\f[], \f[B]\-\-force\f[]:
  62. .RS 2
  63. .PP
  64. Force overwriting the output file.
  65. .RE
  66. .IP \[bu] 2
  67. \f[B]\-k\f[], \f[B]\-\-publicKey\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  68. (for stdout):
  69. .RS 2
  70. .PP
  71. The public key associated with keyPath in PEM format.
  72. Optional parameter.
  73. .RE
  74. .IP \[bu] 2
  75. \f[B]\-o\f[], \f[B]\-\-signature\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[]
  76. (for stdout):
  77. .RS 2
  78. .PP
  79. Returns the signature in binary form.
  80. .RE
  81. .SH COMMON OPTIONS
  82. .PP
  83. This collection of options are common to all tss2 programs and provide
  84. information that many users may expect.
  85. .IP \[bu] 2
  86. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  87. manpage.
  88. By default, it attempts to invoke the manpager for the tool, however, on
  89. failure will output a short tool summary.
  90. This is the same behavior if the "man" option argument is specified,
  91. however if explicit "man" is requested, the tool will provide errors
  92. from man on stderr.
  93. If the "no\-man" option if specified, or the manpager fails, the short
  94. options will be output to stdout.
  95. .RS 2
  96. .PP
  97. To successfully use the manpages feature requires the manpages to be
  98. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  99. .RE
  100. .IP \[bu] 2
  101. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  102. tool, supported tctis and exit.
  103. .SH EXAMPLE
  104. .IP
  105. .nf
  106. \f[C]
  107. tss2_sign\ \-\-keyPath=HS/SRK/myRSASign\ \-\-padding="RSA_PSS"\ \-\-digest=digest.file\ \-\-signature=signature.file\ \-\-publicKey=publicKey.file
  108. \f[]
  109. .fi
  110. .SH RETURNS
  111. .PP
  112. 0 on success or 1 on failure.
  113. .SH BUGS
  114. .PP
  115. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  116. .SH HELP
  117. .PP
  118. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)