group__fapi.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>tpm2-tss: Feature API</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr style="height: 56px;">
  27. <td id="projectalign" style="padding-left: 0.5em;">
  28. <div id="projectname">tpm2-tss
  29. &#160;<span id="projectnumber">3.2.0</span>
  30. </div>
  31. <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- end header part -->
  38. <!-- Generated by Doxygen 1.8.13 -->
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. $(function() {
  43. initMenu('',false,false,'search.php','Search');
  44. });
  45. </script>
  46. <div id="main-nav"></div>
  47. </div><!-- top -->
  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
  49. <div id="nav-tree">
  50. <div id="nav-tree-contents">
  51. <div id="nav-sync" class="sync"></div>
  52. </div>
  53. </div>
  54. <div id="splitbar" style="-moz-user-select:none;"
  55. class="ui-resizable-handle">
  56. </div>
  57. </div>
  58. <script type="text/javascript">
  59. $(document).ready(function(){initNavTree('group__fapi.html','');});
  60. </script>
  61. <div id="doc-content">
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#groups">Modules</a> &#124;
  65. <a href="#typedef-members">Typedefs</a> </div>
  66. <div class="headertitle">
  67. <div class="title">Feature API</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <table class="memberdecls">
  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  72. Modules</h2></td></tr>
  73. <tr class="memitem:group___fapi___initialize"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___initialize.html">Fapi_Initialize</a></td></tr>
  74. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:group___fapi___finalize"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___finalize.html">Fapi_Finalize</a></td></tr>
  76. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:group___fapi___get_tcti"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_tcti.html">Fapi_GetTcti</a></td></tr>
  78. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:group___fapi___get_poll_handles"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_poll_handles.html">Fapi_GetPollHandles</a></td></tr>
  80. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:group___fapi___free"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___free.html">Fapi_Free</a></td></tr>
  82. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:group___fapi___get_info"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_info.html">Fapi_GetInfo</a></td></tr>
  84. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:group___fapi___provision"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___provision.html">Fapi_Provision</a></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:group___fapi___get_platform_certificates"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_platform_certificates.html">Fapi_GetPlatformCertificates</a></td></tr>
  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:group___fapi___get_esys_blobs"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_esys_blobs.html">Fapi_GetEsysBlobs</a></td></tr>
  90. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:group___fapi___get_random"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_random.html">Fapi_GetRandom</a></td></tr>
  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:group___fapi___import"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___import.html">Fapi_Import</a></td></tr>
  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:group___fapi___list"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___list.html">Fapi_List</a></td></tr>
  96. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:group___fapi___delete"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___delete.html">Fapi_Delete</a></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:group___fapi___change_auth"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___change_auth.html">Fapi_ChangeAuth</a></td></tr>
  100. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:group___fapi___set_description"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___set_description.html">Fapi_SetDescription</a></td></tr>
  102. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:group___fapi___get_description"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_description.html">Fapi_GetDescription</a></td></tr>
  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:group___fapi___set_app_data"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___set_app_data.html">Fapi_SetAppData</a></td></tr>
  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:group___fapi___get_app_data"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_app_data.html">Fapi_GetAppData</a></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:group___fapi___get_tpm_blobs"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_tpm_blobs.html">Fapi_GetTpmBlobs</a></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:group___fapi___create_key"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_key.html">Fapi_CreateKey</a></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:group___fapi___sign"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___sign.html">Fapi_Sign</a></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:group___fapi___verify_signature"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___verify_signature.html">Fapi_VerifySignature</a></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:group___fapi___encrypt"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___encrypt.html">Fapi_Encrypt</a></td></tr>
  118. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:group___fapi___decrypt"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___decrypt.html">Fapi_Decrypt</a></td></tr>
  120. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:group___fapi___set_certificate"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___set_certificate.html">Fapi_SetCertificate</a></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:group___fapi___get_certificate"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___get_certificate.html">Fapi_GetCertificate</a></td></tr>
  124. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:group___fapi___export_key"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___export_key.html">Fapi_ExportKey</a></td></tr>
  126. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:group___fapi___create_seal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_seal.html">Fapi_CreateSeal</a></td></tr>
  128. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:group___fapi___unseal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___unseal.html">Fapi_Unseal</a></td></tr>
  130. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:group___fapi___export_policy"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___export_policy.html">Fapi_ExportPolicy</a></td></tr>
  132. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:group___fapi___authorize_policy"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___authorize_policy.html">Fapi_AuthorizePolicy</a></td></tr>
  134. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:group___fapi___write_authorize_nv"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___write_authorize_nv.html">Fapi_WriteAuthorizeNv</a></td></tr>
  136. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:group___fapi___pcr_read"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___pcr_read.html">Fapi_PcrRead</a></td></tr>
  138. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:group___fapi___pcr_extend"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___pcr_extend.html">Fapi_PcrExtend</a></td></tr>
  140. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:group___fapi___quote"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___quote.html">Fapi_Quote</a></td></tr>
  142. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:group___fapi___verify_quote"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___verify_quote.html">Fapi_VerifyQuote</a></td></tr>
  144. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:group___fapi___create_nv"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_nv.html">Fapi_CreateNv</a></td></tr>
  146. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:group___fapi___nv_read"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___nv_read.html">Fapi_NvRead</a></td></tr>
  148. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:group___fapi___nv_write"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___nv_write.html">Fapi_NvWrite</a></td></tr>
  150. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:group___fapi___nv_extend"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___nv_extend.html">Fapi_NvExtend</a></td></tr>
  152. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:group___fapi___nv_increment"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___nv_increment.html">Fapi_NvIncrement</a></td></tr>
  154. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:group___fapi___nv_set_bits"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___nv_set_bits.html">Fapi_NvSetBits</a></td></tr>
  156. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:group___fapi___set_auth_c_b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___set_auth_c_b.html">Fapi_SetAuthCB</a></td></tr>
  158. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:group___fapi___set_branch_c_b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___set_branch_c_b.html">Fapi_SetBranchCB</a></td></tr>
  160. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:group___fapi___set_sign_c_b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___set_sign_c_b.html">Fapi_SetSignCB</a></td></tr>
  162. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:group__ifapi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi.html">Internals of Feature API</a></td></tr>
  164. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. </table><table class="memberdecls">
  166. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  167. Typedefs</h2></td></tr>
  168. <tr class="memitem:gaf6a28a10fa6867bc123309c76820cba1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fapi.html#gaf6a28a10fa6867bc123309c76820cba1">FAPI_CONTEXT</a></td></tr>
  169. <tr class="separator:gaf6a28a10fa6867bc123309c76820cba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. </table>
  171. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  172. <p>Feature API (FAPI) as described in the <a href="https://trustedcomputinggroup.org/wp-content/uploads/todo.pdf">TSS 2.0 Feature API (FAPI) Specification</a>. This API provides a very abstract view on TPM functionalities most suitable for 80 percent of applications. In mostly uses standard types in its parameter list. Policies are encoded in JSON, whereas most key material is encoded as PEM. Both the synchronous and asynchronous API are exposed through a single library: libtss2-fapi. In order to perform an asynchronous invocation of FAPI functions, the following code serves as a template: do { r = Fapi_GetPollHandles(fc, &amp;ph, &amp;nph); if (r == TSS2_RC_SUCCESS) { poll(ph, nph, -1); Fapi_Free(ph); } r = Fapi_*_Finish(fc, ...); } while (r == TSS2_FAPI_RC_TRY_AGAIN); </p>
  173. <h2 class="groupheader">Typedef Documentation</h2>
  174. <a id="gaf6a28a10fa6867bc123309c76820cba1"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#gaf6a28a10fa6867bc123309c76820cba1">&#9670;&nbsp;</a></span>FAPI_CONTEXT</h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Reference to the <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> that holds data for the connection to the TPM as well as the metadata for TPM Resource as well as links to the key- and policy store or key material for encrypted sessions. </p>
  185. </div>
  186. </div>
  187. </div><!-- contents -->
  188. </div><!-- doc-content -->
  189. <!-- start footer part -->
  190. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  191. <ul>
  192. <li class="footer">Generated by
  193. <a href="http://www.doxygen.org/index.html">
  194. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  195. </ul>
  196. </div>
  197. </body>
  198. </html>