IFAPI_Provision.3 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. .TH "IFAPI_Provision" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. IFAPI_Provision
  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 "\fBIFAPI_OBJECT\fP \fBhierarchy_lockout\fP"
  15. .br
  16. .ti -1c
  17. .RI "\fBIFAPI_OBJECT\fP \fBhierarchy_hs\fP"
  18. .br
  19. .ti -1c
  20. .RI "\fBIFAPI_OBJECT\fP \fBhierarchy_he\fP"
  21. .br
  22. .ti -1c
  23. .RI "\fBIFAPI_OBJECT\fP \fBhierarchy_hn\fP"
  24. .br
  25. .ti -1c
  26. .RI "\fBIFAPI_OBJECT\fP * \fBhierarchy\fP"
  27. .br
  28. .ti -1c
  29. .RI "\fBTPMS_POLICY\fP * \fBhierarchy_policy\fP"
  30. .br
  31. .ti -1c
  32. .RI "\fBIFAPI_KEY_TEMPLATE\fP \fBpublic_templ\fP"
  33. .br
  34. .ti -1c
  35. .RI "TPM2B_PUBLIC \fBpublic\fP"
  36. .br
  37. .ti -1c
  38. .RI "char ** \fBpathlist\fP"
  39. .br
  40. .ti -1c
  41. .RI "size_t \fBnumPaths\fP"
  42. .br
  43. .ti -1c
  44. .RI "size_t \fBnumHierarchyObjects\fP"
  45. .br
  46. .ti -1c
  47. .RI "size_t \fBhiearchy_idx\fP"
  48. .br
  49. .ti -1c
  50. .RI "size_t \fBpath_idx\fP"
  51. .br
  52. .ti -1c
  53. .RI "\fBIFAPI_OBJECT\fP * \fBhierarchies\fP"
  54. .br
  55. .ti -1c
  56. .RI "TPM2B_SENSITIVE_CREATE \fBinSensitive\fP"
  57. .br
  58. .ti -1c
  59. .RI "TPM2B_DATA \fBoutsideInfo\fP"
  60. .br
  61. .ti -1c
  62. .RI "TPML_PCR_SELECTION \fBcreationPCR\fP"
  63. .br
  64. .ti -1c
  65. .RI "\fBESYS_TR\fP \fBhandle\fP"
  66. .br
  67. .ti -1c
  68. .RI "const char * \fBauthValueLockout\fP"
  69. .br
  70. .ti -1c
  71. .RI "const char * \fBauthValueEh\fP"
  72. .br
  73. .ti -1c
  74. .RI "const char * \fBpolicyPathEh\fP"
  75. .br
  76. .ti -1c
  77. .RI "const char * \fBauthValueSh\fP"
  78. .br
  79. .ti -1c
  80. .RI "const char * \fBpolicyPathSh\fP"
  81. .br
  82. .ti -1c
  83. .RI "size_t \fBdigest_idx\fP"
  84. .br
  85. .ti -1c
  86. .RI "size_t \fBhash_size\fP"
  87. .br
  88. .ti -1c
  89. .RI "TPM2_HANDLE \fBcert_nv_idx\fP"
  90. .br
  91. .ti -1c
  92. .RI "TPM2B_NV_PUBLIC * \fBnvPublic\fP"
  93. .br
  94. .ti -1c
  95. .RI "\fBESYS_TR\fP \fBesys_nv_cert_handle\fP"
  96. .br
  97. .ti -1c
  98. .RI "char * \fBpem_cert\fP"
  99. .br
  100. .ti -1c
  101. .RI "TPM2_ALG_ID \fBcert_key_type\fP"
  102. .br
  103. .ti -1c
  104. .RI "size_t \fBcert_count\fP"
  105. .br
  106. .ti -1c
  107. .RI "size_t \fBcert_idx\fP"
  108. .br
  109. .ti -1c
  110. .RI "TPMS_CAPABILITY_DATA * \fBcapabilityData\fP"
  111. .br
  112. .ti -1c
  113. .RI "\fBIFAPI_OBJECT\fP \fBhierarchy_object\fP"
  114. .br
  115. .ti -1c
  116. .RI "TPM2B_AUTH \fBhierarchy_auth\fP"
  117. .br
  118. .ti -1c
  119. .RI "TPM2B_DIGEST \fBpolicy_digest\fP"
  120. .br
  121. .ti -1c
  122. .RI "char * \fBintermed_crt\fP"
  123. .br
  124. .ti -1c
  125. .RI "char * \fBroot_crt\fP"
  126. .br
  127. .ti -1c
  128. .RI "TPMA_PERMANENT \fBauth_state\fP"
  129. .br
  130. .ti -1c
  131. .RI "\fBESYS_TR\fP \fBsrk_esys_handle\fP"
  132. .br
  133. .ti -1c
  134. .RI "\fBESYS_TR\fP \fBek_esys_handle\fP"
  135. .br
  136. .ti -1c
  137. .RI "\fBESYS_TR\fP \fBsrk_tpm_handle\fP"
  138. .br
  139. .ti -1c
  140. .RI "\fBESYS_TR\fP \fBek_tpm_handle\fP"
  141. .br
  142. .ti -1c
  143. .RI "bool \fBsrk_exists\fP"
  144. .br
  145. .in -1c
  146. .SH "Detailed Description"
  147. .PP
  148. The data structure holding internal state of Provisioning\&.
  149. .SH "Field Documentation"
  150. .PP
  151. .SS "size_t hiearchy_idx"
  152. Index to the current hierarchy
  153. .SS "\fBIFAPI_OBJECT\fP* hierarchies"
  154. Array of the hierarchies stored in keystore\&.
  155. .SS "\fBIFAPI_OBJECT\fP* hierarchy"
  156. The current hierarchy
  157. .SS "\fBIFAPI_OBJECT\fP hierarchy_he"
  158. The endorsement hierarchy
  159. .SS "\fBIFAPI_OBJECT\fP hierarchy_hn"
  160. The null hierarchy
  161. .SS "\fBIFAPI_OBJECT\fP hierarchy_hs"
  162. The storage hierarchy
  163. .SS "\fBIFAPI_OBJECT\fP hierarchy_lockout"
  164. The lockout hierarchy
  165. .SS "\fBTPMS_POLICY\fP* hierarchy_policy"
  166. Policy of the current used hierarchy\&.
  167. .SS "size_t numHierarchyObjects"
  168. Number of hierarchies stored in keystore
  169. .SS "size_t numPaths"
  170. Size of array with all keystore objects
  171. .SS "size_t path_idx"
  172. Index of array with the object paths
  173. .SS "char** pathlist"
  174. The array with all keystore objects
  175. .SS "TPM2B_PUBLIC public"
  176. The public info of the created primary
  177. .SS "\fBIFAPI_KEY_TEMPLATE\fP public_templ"
  178. The basic template for the keys public data
  179. .SH "Author"
  180. .PP
  181. Generated automatically by Doxygen for tpm2-tss from the source code\&.