IFAPI_KEY.3 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. .TH "IFAPI_KEY" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. IFAPI_KEY
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <ifapi_keystore\&.h>\fP
  11. .SS "Data Fields"
  12. .in +1c
  13. .ti -1c
  14. .RI "UINT32 \fBpersistent_handle\fP"
  15. .br
  16. .ti -1c
  17. .RI "TPM2B_PUBLIC \fBpublic\fP"
  18. .br
  19. .ti -1c
  20. .RI "\fBUINT8_ARY\fP \fBserialization\fP"
  21. .br
  22. .ti -1c
  23. .RI "\fBUINT8_ARY\fP \fBprivate\fP"
  24. .br
  25. .ti -1c
  26. .RI "char * \fBpolicyInstance\fP"
  27. .br
  28. .ti -1c
  29. .RI "TPM2B_CREATION_DATA \fBcreationData\fP"
  30. .br
  31. .ti -1c
  32. .RI "TPMT_TK_CREATION \fBcreationTicket\fP"
  33. .br
  34. .ti -1c
  35. .RI "char * \fBdescription\fP"
  36. .br
  37. .ti -1c
  38. .RI "\fBUINT8_ARY\fP \fBappData\fP"
  39. .br
  40. .ti -1c
  41. .RI "char * \fBcertificate\fP"
  42. .br
  43. .ti -1c
  44. .RI "TPMT_SIG_SCHEME \fBsigning_scheme\fP"
  45. .br
  46. .ti -1c
  47. .RI "TPM2B_NAME \fBname\fP"
  48. .br
  49. .ti -1c
  50. .RI "TPMI_YES_NO \fBwith_auth\fP"
  51. .br
  52. .ti -1c
  53. .RI "UINT32 \fBreset_count\fP"
  54. .br
  55. .ti -1c
  56. .RI "TPMI_YES_NO \fBdelete_prohibited\fP"
  57. .br
  58. .in -1c
  59. .SH "Detailed Description"
  60. .PP
  61. Type for representing a FAPI key
  62. .SH "Field Documentation"
  63. .PP
  64. .SS "\fBUINT8_ARY\fP appData"
  65. Application data
  66. .SS "char* certificate"
  67. Keys certificate (if any)
  68. .SS "TPM2B_CREATION_DATA creationData"
  69. None
  70. .SS "TPMT_TK_CREATION creationTicket"
  71. None
  72. .SS "TPMI_YES_NO delete_prohibited"
  73. Persistent object should not be deleted\&.
  74. .SS "char* description"
  75. Human readable description of key
  76. .SS "TPM2B_NAME name"
  77. Name of the key
  78. .SS "UINT32 persistent_handle"
  79. Persistent TPM Handle
  80. .SS "char* policyInstance"
  81. Keys policy
  82. .SS "\fBUINT8_ARY\fP private"
  83. None
  84. .SS "TPM2B_PUBLIC public"
  85. The wrapped public portion of the object
  86. .SS "UINT32 reset_count"
  87. The TPM reset count during key creation
  88. .SS "\fBUINT8_ARY\fP serialization"
  89. None
  90. .SS "TPMT_SIG_SCHEME signing_scheme"
  91. Signing scheme for the key
  92. .SS "TPMI_YES_NO with_auth"
  93. Authorization provided during creation
  94. .SH "Author"
  95. .PP
  96. Generated automatically by Doxygen for tpm2-tss from the source code\&.