SdkOverview.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  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">2.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. <table class="doxtable">
  81. <tr>
  82. <th>Component </th><th>Description </th></tr>
  83. <tr>
  84. <td>member </td><td>Library containing APIs needed to implement a member </td></tr>
  85. <tr>
  86. <td>verifier </td><td>Library containing APIs needed to implement a verifier </td></tr>
  87. <tr>
  88. <td>common </td><td>Library containing common types and functions </td></tr>
  89. <tr>
  90. <td>math </td><td>Math primitives used by member and verifier </td></tr>
  91. <tr>
  92. <td>IPP </td><td>A C-only non-optimized subset of Intel&reg; IPP </td></tr>
  93. <tr>
  94. <td>signmsg </td><td>A sample program showing how to sign messages </td></tr>
  95. <tr>
  96. <td>verfifysig </td><td>A sample program showing how to verify signatures </td></tr>
  97. <tr>
  98. <td>util </td><td>Common utilities used by samples </td></tr>
  99. <tr>
  100. <td>gtest </td><td>gtest unit test framework </td></tr>
  101. <tr>
  102. <td>Build Scripts </td><td>Scripts to configure and build the SDK </td></tr>
  103. <tr>
  104. <td>Sample Issuer Material </td><td>Sample keys and revocation lists </td></tr>
  105. </table>
  106. <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>
  107. <h1><a class="anchor" id="SdkOverview_Files"></a>
  108. Filesystem Layout</h1>
  109. <p>The Intel&reg; EPID SDK has two filesystem layouts: the Source Layout and the Install Layout.</p>
  110. <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>
  111. <p>The Install Layout is the layout of files under the <code>_install</code> folder after you build the SDK.</p>
  112. <h2><a class="anchor" id="SdkOverview_Files_SourceLayout"></a>
  113. Source Layout</h2>
  114. <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/
  115. |__ LICENSE.txt Distribution license
  116. |__ NOTICE.txt Legal notices
  117. |__ README.md Readme
  118. |__ RELEASE_NOTES.md Release notes
  119. |__ SConstruct Main build configuration
  120. |
  121. |__ doc/
  122. | |__ html/ HTML format documentation
  123. | |__ index.html Entry point for HTML format documentation
  124. |
  125. |__ epid/
  126. | |__ common/ Source for Common
  127. | |__ common-testhelper/ Source for unit test helper common helpers
  128. | |__ member/ Source for Member
  129. | |__ verifier/ Source for Verifier
  130. |
  131. |__ example/
  132. | |__ data/ Binary data used for testing and tutorials
  133. | |__ signmsg/ Source for message signing example
  134. | |__ util/ Common utilities for examples
  135. | |__ verifysig/ Source for signature validation signing example
  136. |
  137. |__ ext/
  138. | |__ gtest/ Third party gtest library
  139. | |__ ipp/ IPP library
  140. |
  141. |__ parts-site/ Parts platform config scripts
  142. </pre><h2><a class="anchor" id="SdkOverview_Files_InstallLayout"></a>
  143. Install Layout</h2>
  144. <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/
  145. |__ epid-sdk/
  146. |__ include/ C include header files for the SDK
  147. |__ lib/
  148. | |__ &lt;platform&gt; Target specific static libraries for the SDK
  149. |
  150. |__example/ Sample applications and data
  151. |__test/ Unit test executables (if unit tests built)</pre> </div></div><!-- contents -->
  152. </div><!-- doc-content -->
  153. <!-- HTML footer for doxygen 1.8.10-->
  154. <!-- start footer part -->
  155. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  156. <ul>
  157. <li class="footer">
  158. &copy; 2016 Intel Corporation
  159. </li>
  160. </ul>
  161. </div>
  162. </body>
  163. </html>