IFAPI_Key_Sign.3 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. .TH "IFAPI_Key_Sign" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. IFAPI_Key_Sign
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <fapi_int\&.h>\fP
  11. .SS "Data Fields"
  12. .in +1c
  13. .ti -1c
  14. .RI "enum FAPI_SIGN_STATE \fBstate\fP"
  15. .br
  16. .ti -1c
  17. .RI "const char * \fBkeyPath\fP"
  18. .br
  19. .ti -1c
  20. .RI "\fBESYS_TR\fP \fBhandle\fP"
  21. .br
  22. .ti -1c
  23. .RI "TPM2B_DIGEST \fBdigest\fP"
  24. .br
  25. .ti -1c
  26. .RI "TPMT_SIG_SCHEME \fBscheme\fP"
  27. .br
  28. .ti -1c
  29. .RI "\fBIFAPI_OBJECT\fP * \fBkey_object\fP"
  30. .br
  31. .ti -1c
  32. .RI "TPMT_SIGNATURE * \fBtpm_signature\fP"
  33. .br
  34. .ti -1c
  35. .RI "TPMI_YES_NO \fBdecrypt\fP"
  36. .br
  37. .ti -1c
  38. .RI "TPMT_SIGNATURE * \fBsignature\fP"
  39. .br
  40. .ti -1c
  41. .RI "char const * \fBpadding\fP"
  42. .br
  43. .ti -1c
  44. .RI "char * \fBcertificate\fP"
  45. .br
  46. .ti -1c
  47. .RI "uint8_t * \fBret_signature\fP"
  48. .br
  49. .ti -1c
  50. .RI "size_t \fBsignatureSize\fP"
  51. .br
  52. .ti -1c
  53. .RI "char * \fBpublicKey\fP"
  54. .br
  55. .in -1c
  56. .SH "Detailed Description"
  57. .PP
  58. The data structure holding internal state of Fapi_Sign\&.
  59. .SH "Field Documentation"
  60. .PP
  61. .SS "char* certificate"
  62. Certificate of the signing key\&.
  63. .SS "TPMI_YES_NO decrypt"
  64. Switch for symmetric algs
  65. .SS "TPM2B_DIGEST digest"
  66. The digest to be signed
  67. .SS "\fBESYS_TR\fP handle"
  68. The ESYS handle of the signing key
  69. .SS "\fBIFAPI_OBJECT\fP* key_object"
  70. The IPAPI object of the signing key
  71. .SS "const char* keyPath"
  72. The implicit key path
  73. .SS "char const* padding"
  74. Optional padding parameter for key sign\&.
  75. .SS "char* publicKey"
  76. Public key of the signing key\&.
  77. .SS "uint8_t* ret_signature"
  78. Result signature
  79. .SS "TPMT_SIG_SCHEME scheme"
  80. The signature scheme from profile
  81. .SS "TPMT_SIGNATURE* signature"
  82. Produced TPM singature
  83. .SS "enum FAPI_SIGN_STATE state"
  84. The state of the signing operation
  85. .SS "TPMT_SIGNATURE* tpm_signature"
  86. The signature in TPM format
  87. .SH "Author"
  88. .PP
  89. Generated automatically by Doxygen for tpm2-tss from the source code\&.