SdkOverview.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <!-- HTML header for doxygen 1.8.10-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.11"/>
  8. <title>Intel&reg; Enhanced Privacy ID SDK: What&#39;s Included in the SDK</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. $(window).load(resizeHeight);
  19. </script>
  20. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  21. <link href="epidstyle.css" rel="stylesheet" type="text/css"/>
  22. </head>
  23. <body>
  24. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  25. <div id="titlearea">
  26. <table cellspacing="0" cellpadding="0">
  27. <tbody>
  28. <tr style="height: 56px;">
  29. <td id="projectalign" style="padding-left: 0.5em;">
  30. <div id="projectname"><a
  31. onclick="storeLink('index.html')"
  32. id="projectlink"
  33. class="index.html"
  34. href="index.html">Intel&reg; Enhanced Privacy ID SDK</a>
  35. &#160;<span id="projectnumber">3.0.0</span>
  36. </div>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.8.11 -->
  44. </div><!-- top -->
  45. <div id="side-nav" class="ui-resizable side-nav-resizable">
  46. <div id="nav-tree">
  47. <div id="nav-tree-contents">
  48. <div id="nav-sync" class="sync"></div>
  49. </div>
  50. </div>
  51. <div id="splitbar" style="-moz-user-select:none;"
  52. class="ui-resizable-handle">
  53. </div>
  54. </div>
  55. <script type="text/javascript">
  56. $(document).ready(function(){initNavTree('SdkOverview.html','');});
  57. </script>
  58. <div id="doc-content">
  59. <div class="header">
  60. <div class="headertitle">
  61. <div class="title">What's Included in the SDK </div> </div>
  62. </div><!--header-->
  63. <div class="contents">
  64. <div class="toc"><h3>Table of Contents</h3>
  65. <ul><li class="level1"><a href="#SdkOverview_Components">SDK Components</a></li>
  66. <li class="level1"><a href="#SdkOverview_Files">Filesystem Layout</a><ul><li class="level2"><a href="#SdkOverview_Files_SourceLayout">Source Layout</a></li>
  67. <li class="level2"><a href="#SdkOverview_Files_InstallLayout">Install Layout</a></li>
  68. </ul>
  69. </li>
  70. </ul>
  71. </div>
  72. <div class="textblock"><h1><a class="anchor" id="SdkOverview_Components"></a>
  73. SDK Components</h1>
  74. <p>The SDK is divided into logical components to separate responsibilities and create interfaces that you can re-implement using custom tools such as hardware accelerators.</p>
  75. <div class="image">
  76. <img src="sdk_block_diagram.png" alt="sdk_block_diagram.png"/>
  77. </div>
  78. <p><br />
  79. The Intel&reg; EPID SDK is divided into the following components:</p>
  80. <p>Components in the SDK Core implement the features of Intel&reg; EPID.</p>
  81. <table class="doxtable">
  82. <tr>
  83. <th>Component </th><th>Description </th></tr>
  84. <tr>
  85. <td>member </td><td>Library containing APIs needed to implement a member </td></tr>
  86. <tr>
  87. <td>verifier </td><td>Library containing APIs needed to implement a verifier </td></tr>
  88. <tr>
  89. <td>common </td><td>Library containing common types and functions </td></tr>
  90. <tr>
  91. <td>math </td><td>Math primitives used by member and verifier </td></tr>
  92. <tr>
  93. <td>IPP </td><td>A C-only non-optimized subset of Intel&reg; IPP </td></tr>
  94. </table>
  95. <p><a class="el" href="Examples.html">Examples</a> show how to use the SDK APIs in working code.</p>
  96. <table class="doxtable">
  97. <tr>
  98. <th>Component </th><th>Description </th></tr>
  99. <tr>
  100. <td>signmsg </td><td>A sample program showing how to sign messages </td></tr>
  101. <tr>
  102. <td>verfifysig </td><td>A sample program showing how to verify signatures </td></tr>
  103. <tr>
  104. <td>util </td><td>Common utilities used by samples </td></tr>
  105. <tr>
  106. <td>Sample Issuer Material </td><td>Sample keys and revocation lists </td></tr>
  107. </table>
  108. <p>Tools implement utility code to interact with Intel&reg; EPID related services such as <a class="el" href="ChoosingiKGF.html">the Intel&reg; Key Generation</a>Facility (iKGF)".</p>
  109. <table class="doxtable">
  110. <tr>
  111. <th>Component </th><th>Description </th></tr>
  112. <tr>
  113. <td>extractgrps </td><td>A tool to extract groups from a bulk group file </td></tr>
  114. <tr>
  115. <td>extractkeys </td><td>A tool to extract member keys from a bulk key file </td></tr>
  116. <tr>
  117. <td>revokegrp </td><td>A tool to create a revocation request for a group </td></tr>
  118. <tr>
  119. <td>revokekey </td><td>A tool to create a revocation request for a member key </td></tr>
  120. <tr>
  121. <td>revokesig </td><td>A tool to create a revocation request from a signature </td></tr>
  122. </table>
  123. <p>The SDK comes with a number of other components that support building and validating the code.</p>
  124. <table class="doxtable">
  125. <tr>
  126. <th>Component </th><th>Description </th></tr>
  127. <tr>
  128. <td>gtest </td><td>gtest unit test framework </td></tr>
  129. <tr>
  130. <td>Build Scripts </td><td>Scripts to configure and build the SDK </td></tr>
  131. </table>
  132. <p>Math primitives are implemented in the <em>math</em> sub-component of <em>common</em>. The reference math primitive implementation is based on a non-optimized Vanilla C subset of the Intel&reg; Performance Primitives. <em>Math</em> is designed so that you can replace its implementation to call custom hardware IP blocks or optimized libraries.</p>
  133. <h2>Intel&reg; EPID 1.1 Compatibility</h2>
  134. <p>In addition to the default Intel&reg; EPID 2.0 APIs, the <em>verifier</em> component also includes APIs that allow verification of Intel&reg; EPID 1.1 signatures.</p>
  135. <p>Billions of existing devices, including most Intel platforms manufactured since 2008, create signatures that need Intel&reg; EPID 1.1 verification.</p>
  136. <p>For details on verifying Intel&reg; EPID 1.1 signatures see <a href="group___epid11_verifier_module.html#details"><b>EPID 1.1 support</b></a> in the API Reference.</p>
  137. <h1><a class="anchor" id="SdkOverview_Files"></a>
  138. Filesystem Layout</h1>
  139. <p>The Intel&reg; EPID SDK has two filesystem layouts: the Source Layout and the Install Layout.</p>
  140. <p>The Source Layout is what you find when you download the SDK and extract it to disk. This layout contains all of the files that you need to build the libraries, samples, tests, and data generated by the SDK.</p>
  141. <p>The Install Layout is the layout of files under the <code>_install</code> folder after you build the SDK.</p>
  142. <h2><a class="anchor" id="SdkOverview_Files_SourceLayout"></a>
  143. Source Layout</h2>
  144. <p>The Source Layout is used by the build scripts in the Intel&reg; EPID SDK to find components and files needed to create libraries and executables. </p><pre class="fragment">epid-sdk/
  145. |__ LICENSE.txt Distribution license
  146. |__ NOTICE.txt Legal notices
  147. |__ README.md Readme
  148. |__ CHANGELOG.md Change log
  149. |__ SConstruct Main build configuration
  150. |
  151. |__ doc/
  152. | |__ html/ HTML format documentation
  153. | |__ index.html Entry point for HTML format documentation
  154. |
  155. |__ epid/
  156. | |__ common/ Source for Common
  157. | |__ common-testhelper/ Source for unit test helper common helpers
  158. | |__ member/ Source for Member
  159. | |__ verifier/ Source for Verifier
  160. |
  161. |__ example/
  162. | |__ data/ Binary data used for testing and tutorials
  163. | |__ compressed_data/ Compressed Member Key Binary data used for testing and tutorials
  164. | |__ signmsg/ Source for message signing example
  165. | |__ util/ Common utilities for examples
  166. | |__ verifysig/ Source for signature validation signing example
  167. |
  168. |__ ext/
  169. | |__ gtest/ Third party gtest library
  170. | |__ ipp/ IPP library
  171. |
  172. |__ parts-site/ Parts platform config scripts
  173. |
  174. |__ tools/
  175. |__ extractgrps/ Tool to extract groups
  176. |__ extractkeys/ Tool to extract keys
  177. |__ revokegrp/ Tool to create group revocation request
  178. |__ revokekey/ Tool to create a member key revocation request
  179. |__ revokesig/ Tool to create a signature based revocation
  180. request
  181. </pre><h2><a class="anchor" id="SdkOverview_Files_InstallLayout"></a>
  182. Install Layout</h2>
  183. <p>The Install Layout contains the data developers need to develop and build their applications using the Intel&reg; EPID SDK. Once built, the Install Layout has no dependency on the Source Layout, allowing developers to build the SDK once and reuse the built files in other locations or on other computers. </p><pre class="fragment">_install/
  184. |__ epid-sdk/
  185. |__ include/ C include header files for the SDK
  186. |__ lib/
  187. | |__ &lt;platform&gt; Target specific static libraries for the SDK
  188. |
  189. |__example/ Sample applications and data
  190. |__test/ Unit test executables (if unit tests built)
  191. |__tools/ Tools</pre> </div></div><!-- contents -->
  192. </div><!-- doc-content -->
  193. <!-- HTML footer for doxygen 1.8.10-->
  194. <!-- start footer part -->
  195. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  196. <ul>
  197. <li class="footer">
  198. &copy; 2016 Intel Corporation
  199. </li>
  200. </ul>
  201. </div>
  202. </body>
  203. </html>