Home | History | Annotate | Download | only in html
      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.14"/>
      8 <title>Intel&reg; Enhanced Privacy ID SDK: epid/member/tpm2/ibm_tss/context.c File Reference</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 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
     18   $(document).ready(initResizable);
     19 /* @license-end */</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">6.0.1</span>
     36 </div>
     37   </td>
     38  </tr>
     39  </tbody>
     40 </table>
     41 </div>
     42 <!-- end header part -->
     43 <!-- Generated by Doxygen 1.8.14 -->
     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 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
     57 $(document).ready(function(){initNavTree('context_8c.html','');});
     58 /* @license-end */
     59 </script>
     60 <div id="doc-content">
     61 <div class="header">
     62   <div class="summary">
     63 <a href="#define-members">Macros</a> &#124;
     64 <a href="#func-members">Functions</a> &#124;
     65 <a href="#var-members">Variables</a>  </div>
     66   <div class="headertitle">
     67 <div class="title">context.c File Reference</div>  </div>
     68 </div><!--header-->
     69 <div class="contents">
     70 
     71 <p>TPM context implementation.  
     72 <a href="#details">More...</a></p>
     73 <div class="textblock"><code>#include &quot;<a class="el" href="context_8h.html">epid/member/tpm2/context.h</a>&quot;</code><br />
     74 <code>#include &lt;tss2/TPM_Types.h&gt;</code><br />
     75 <code>#include &lt;tss2/tss.h&gt;</code><br />
     76 <code>#include &quot;<a class="el" href="finitefield_8h.html">epid/common/math/finitefield.h</a>&quot;</code><br />
     77 <code>#include &quot;epid/common/src/epid2params.h&quot;</code><br />
     78 <code>#include &quot;epid/common/src/memory.h&quot;</code><br />
     79 <code>#include &quot;<a class="el" href="getrandom_8h.html">epid/member/tpm2/getrandom.h</a>&quot;</code><br />
     80 <code>#include &quot;<a class="el" href="printtss_8h.html">epid/member/tpm2/ibm_tss/printtss.h</a>&quot;</code><br />
     81 <code>#include &quot;<a class="el" href="state_8h.html">epid/member/tpm2/ibm_tss/state.h</a>&quot;</code><br />
     82 <code>#include &quot;<a class="el" href="tpm__member_8h.html">epid/member/tpm_member.h</a>&quot;</code><br />
     83 </div><table class="memberdecls">
     84 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
     85 Macros</h2></td></tr>
     86 <tr class="memitem:a5638f861b82f1746ea1af0b384ef8ff1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="context_8c.html#a5638f861b82f1746ea1af0b384ef8ff1">BREAK_ON_EPID_ERROR</a>(ret)</td></tr>
     87 <tr class="memdesc:a5638f861b82f1746ea1af0b384ef8ff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle Intel(R) EPID Error with Break.  <a href="#a5638f861b82f1746ea1af0b384ef8ff1">More...</a><br /></td></tr>
     88 <tr class="separator:a5638f861b82f1746ea1af0b384ef8ff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
     89 </table><table class="memberdecls">
     90 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
     91 Functions</h2></td></tr>
     92 <tr class="memitem:a7f547c0068dc63f0a6b76ad15b1b9675"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="context_8c.html#a7f547c0068dc63f0a6b76ad15b1b9675">Tpm2FlushKey</a> (<a class="el" href="struct_tpm2_ctx.html">Tpm2Ctx</a> *ctx)</td></tr>
     93 <tr class="memdesc:a7f547c0068dc63f0a6b76ad15b1b9675"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes key from TPM.  <a href="#a7f547c0068dc63f0a6b76ad15b1b9675">More...</a><br /></td></tr>
     94 <tr class="separator:a7f547c0068dc63f0a6b76ad15b1b9675"><td class="memSeparator" colspan="2">&#160;</td></tr>
     95 <tr class="memitem:ga11a523e65eee3c7ad1ab21239329ce3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___tpm2_module.html#ga11a523e65eee3c7ad1ab21239329ce3e">Tpm2CreateContext</a> (<a class="el" href="struct_member_params.html">MemberParams</a> const *params, Epid2Params_ const *epid2_params, <a class="el" href="group___epid_common.html#ga6119a2c0323a3fca9e502b24bc378c2c">BitSupplier</a> *rnd_func, void **rnd_param, const <a class="el" href="struct_fp_elem_str.html">FpElemStr</a> **f, <a class="el" href="struct_tpm2_ctx.html">Tpm2Ctx</a> **ctx)</td></tr>
     96 <tr class="memdesc:ga11a523e65eee3c7ad1ab21239329ce3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new Tpm context.  <a href="group___tpm2_module.html#ga11a523e65eee3c7ad1ab21239329ce3e">More...</a><br /></td></tr>
     97 <tr class="separator:ga11a523e65eee3c7ad1ab21239329ce3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
     98 <tr class="memitem:ga38f47cba4c26320db06aa50a77590ef4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___tpm2_module.html#ga38f47cba4c26320db06aa50a77590ef4">Tpm2DeleteContext</a> (<a class="el" href="struct_tpm2_ctx.html">Tpm2Ctx</a> **ctx)</td></tr>
     99 <tr class="memdesc:ga38f47cba4c26320db06aa50a77590ef4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes an existing Tpm context.  <a href="group___tpm2_module.html#ga38f47cba4c26320db06aa50a77590ef4">More...</a><br /></td></tr>
    100 <tr class="separator:ga38f47cba4c26320db06aa50a77590ef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    101 <tr class="memitem:ga11cc131debbca60c0de7e53d48330b69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___tpm2_module.html#ga11cc131debbca60c0de7e53d48330b69">Tpm2SetHashAlg</a> (<a class="el" href="struct_tpm2_ctx.html">Tpm2Ctx</a> *ctx, <a class="el" href="group___epid_types.html#ga5e450438f6f9a5eacd0cf5ce354ec890">HashAlg</a> hash_alg)</td></tr>
    102 <tr class="memdesc:ga11cc131debbca60c0de7e53d48330b69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the hash algorithm to be used by a TPM2.  <a href="group___tpm2_module.html#ga11cc131debbca60c0de7e53d48330b69">More...</a><br /></td></tr>
    103 <tr class="separator:ga11cc131debbca60c0de7e53d48330b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
    104 <tr class="memitem:ga8ee4fed3e1a4dd0c910102430fca8c81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___tpm2_module.html#ga8ee4fed3e1a4dd0c910102430fca8c81">Tpm2ResetContext</a> (<a class="el" href="struct_tpm2_ctx.html">Tpm2Ctx</a> **ctx)</td></tr>
    105 <tr class="memdesc:ga8ee4fed3e1a4dd0c910102430fca8c81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset an existing Tpm context.  <a href="group___tpm2_module.html#ga8ee4fed3e1a4dd0c910102430fca8c81">More...</a><br /></td></tr>
    106 <tr class="separator:ga8ee4fed3e1a4dd0c910102430fca8c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
    107 </table><table class="memberdecls">
    108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
    109 Variables</h2></td></tr>
    110 <tr class="memitem:a8e9ae8d68d53b7549da3823bc65a336e"><td class="memItemLeft" align="right" valign="top"><a id="a8e9ae8d68d53b7549da3823bc65a336e"></a>
    111 <a class="el" href="stdtypes_8h.html#ad5c9d4ba3dc37783a528b0925dc981a0">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="context_8c.html#a8e9ae8d68d53b7549da3823bc65a336e">is_context_already_created</a> = <a class="el" href="stdtypes_8h.html#a65e9886d74aaee76545e83dd09011727">false</a></td></tr>
    112 <tr class="memdesc:a8e9ae8d68d53b7549da3823bc65a336e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag that indicates that context was already created. <br /></td></tr>
    113 <tr class="separator:a8e9ae8d68d53b7549da3823bc65a336e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    114 </table>
    115 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    116 <div class="textblock"><p>TPM context implementation. </p>
    117 </div><h2 class="groupheader">Macro Definition Documentation</h2>
    118 <a id="a5638f861b82f1746ea1af0b384ef8ff1"></a>
    119 <h2 class="memtitle"><span class="permalink"><a href="#a5638f861b82f1746ea1af0b384ef8ff1">&#9670;&nbsp;</a></span>BREAK_ON_EPID_ERROR</h2>
    120 
    121 <div class="memitem">
    122 <div class="memproto">
    123       <table class="memname">
    124         <tr>
    125           <td class="memname">#define BREAK_ON_EPID_ERROR</td>
    126           <td>(</td>
    127           <td class="paramtype">&#160;</td>
    128           <td class="paramname">ret</td><td>)</td>
    129           <td></td>
    130         </tr>
    131       </table>
    132 </div><div class="memdoc">
    133 <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">if</span> (<a class="code" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9">kEpidNoErr</a> != (ret)) {     \</div><div class="line">    break;                       \</div><div class="line">  }</div><div class="ttc" id="group___error_codes_html_ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9"><div class="ttname"><a href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9">kEpidNoErr</a></div><div class="ttdoc">no error </div><div class="ttdef"><b>Definition:</b> errors.h:41</div></div>
    134 </div><!-- fragment -->
    135 <p>Handle Intel(R) EPID Error with Break. </p>
    136 
    137 </div>
    138 </div>
    139 <h2 class="groupheader">Function Documentation</h2>
    140 <a id="a7f547c0068dc63f0a6b76ad15b1b9675"></a>
    141 <h2 class="memtitle"><span class="permalink"><a href="#a7f547c0068dc63f0a6b76ad15b1b9675">&#9670;&nbsp;</a></span>Tpm2FlushKey()</h2>
    142 
    143 <div class="memitem">
    144 <div class="memproto">
    145       <table class="memname">
    146         <tr>
    147           <td class="memname">void Tpm2FlushKey </td>
    148           <td>(</td>
    149           <td class="paramtype"><a class="el" href="struct_tpm2_ctx.html">Tpm2Ctx</a> *&#160;</td>
    150           <td class="paramname"><em>ctx</em></td><td>)</td>
    151           <td></td>
    152         </tr>
    153       </table>
    154 </div><div class="memdoc">
    155 
    156 <p>Deletes key from TPM. </p>
    157 <dl class="params"><dt>Parameters</dt><dd>
    158   <table class="params">
    159     <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>TPM context.</td></tr>
    160   </table>
    161   </dd>
    162 </dl>
    163 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
    164 
    165 </div>
    166 </div>
    167 </div><!-- contents -->
    168 </div><!-- doc-content -->
    169 <!-- HTML footer for doxygen 1.8.10-->
    170 <!-- start footer part -->
    171 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    172   <ul>
    173     <li class="navelem"><a class="el" href="dir_12b90d9c027aaf878a834df729679a56.html">epid</a></li><li class="navelem"><a class="el" href="dir_512d3e62841a8535b716ec4cf8b9e950.html">member</a></li><li class="navelem"><a class="el" href="dir_0d59f1b8006345e373e07b4691e0da76.html">tpm2</a></li><li class="navelem"><a class="el" href="dir_b7525369f2fbc378c6814b573b9a2bc3.html">ibm_tss</a></li><li class="navelem"><a class="el" href="context_8c.html">context.c</a></li>
    174     <li class="footer">
    175       &copy; 2016-2017 Intel Corporation
    176     </li>
    177   </ul>
    178 </div>
    179 </body>
    180 </html>
    181