group__ifapi__vendor.html 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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: Vendor specific module</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__ifapi__vendor.html','');});
  60. </script>
  61. <div id="doc-content">
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Vendor specific module<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a> &raquo; <a class="el" href="group__ifapi.html">Internals of Feature API</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:ga8ba591d0534628e22c038cffc64810fb"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__vendor.html#ga8ba591d0534628e22c038cffc64810fb">ifapi_get_intl_ek_certificate</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, TPM2B_PUBLIC *ek_public, unsigned char **cert_buffer, size_t *cert_size)</td></tr>
  73. <tr class="separator:ga8ba591d0534628e22c038cffc64810fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table>
  75. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  76. <p>Provides functions implementing vendor specific extensions. </p>
  77. <h2 class="groupheader">Function Documentation</h2>
  78. <a id="ga8ba591d0534628e22c038cffc64810fb"></a>
  79. <h2 class="memtitle"><span class="permalink"><a href="#ga8ba591d0534628e22c038cffc64810fb">&#9670;&nbsp;</a></span>ifapi_get_intl_ek_certificate()</h2>
  80. <div class="memitem">
  81. <div class="memproto">
  82. <table class="memname">
  83. <tr>
  84. <td class="memname">TSS2_RC ifapi_get_intl_ek_certificate </td>
  85. <td>(</td>
  86. <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
  87. <td class="paramname"><em>context</em>, </td>
  88. </tr>
  89. <tr>
  90. <td class="paramkey"></td>
  91. <td></td>
  92. <td class="paramtype">TPM2B_PUBLIC *&#160;</td>
  93. <td class="paramname"><em>ek_public</em>, </td>
  94. </tr>
  95. <tr>
  96. <td class="paramkey"></td>
  97. <td></td>
  98. <td class="paramtype">unsigned char **&#160;</td>
  99. <td class="paramname"><em>cert_buffer</em>, </td>
  100. </tr>
  101. <tr>
  102. <td class="paramkey"></td>
  103. <td></td>
  104. <td class="paramtype">size_t *&#160;</td>
  105. <td class="paramname"><em>cert_size</em>&#160;</td>
  106. </tr>
  107. <tr>
  108. <td></td>
  109. <td>)</td>
  110. <td></td><td></td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. <p>Get INTEL certificate for EK</p>
  115. <p>Using the base64 encoded public endorsement key the JSON encoded certificate will be downloaded. The JSON certificate will be parsed and the base64 encoded certificate will be converted into binary format.</p>
  116. <dl class="params"><dt>Parameters</dt><dd>
  117. <table class="params">
  118. <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>The FAPI context with the configuration data. </td></tr>
  119. <tr><td class="paramdir">[in]</td><td class="paramname">ek_public</td><td>The out public data of the EK. </td></tr>
  120. <tr><td class="paramdir">[out]</td><td class="paramname">cert_buffer</td><td>the der encoded certificate. </td></tr>
  121. <tr><td class="paramdir">[out]</td><td class="paramname">cert_size</td><td>The size of the certificate buffer.</td></tr>
  122. </table>
  123. </dd>
  124. </dl>
  125. <dl class="retval"><dt>Return values</dt><dd>
  126. <table class="retval">
  127. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
  128. <tr><td class="paramname">TSS2_FAPI_RC_NO_CERT</td><td>If an error did occur during certificate downloading. </td></tr>
  129. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occured. </td></tr>
  130. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
  131. </table>
  132. </dd>
  133. </dl>
  134. </div>
  135. </div>
  136. </div><!-- contents -->
  137. </div><!-- doc-content -->
  138. <!-- start footer part -->
  139. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  140. <ul>
  141. <li class="footer">Generated by
  142. <a href="http://www.doxygen.org/index.html">
  143. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  144. </ul>
  145. </div>
  146. </body>
  147. </html>