123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>tpm2-tss: Event log utilities.</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript">
- $(document).ready(initResizable);
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">tpm2-tss
-  <span id="projectnumber">3.2.0</span>
- </div>
- <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- $(document).ready(function(){initNavTree('group__ifapi__eventlog.html','');});
- </script>
- <div id="doc-content">
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Event log utilities.<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a> » <a class="el" href="group__ifapi.html">Internals of Feature API</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga5e89f103600a23fe7cd4b6dd4dc99ddd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga5e89f103600a23fe7cd4b6dd4dc99ddd">ifapi_cleanup_event</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> *event)</td></tr>
- <tr class="separator:ga5e89f103600a23fe7cd4b6dd4dc99ddd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6ac8c0daf0f029cd3696a86d68c73219"><td class="memItemLeft" align="right" valign="top">TSS2_RC </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga6ac8c0daf0f029cd3696a86d68c73219">ifapi_eventlog_append_check</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io)</td></tr>
- <tr class="separator:ga6ac8c0daf0f029cd3696a86d68c73219"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga417170e7828a2ce3c141b87dbec6ca1d"><td class="memItemLeft" align="right" valign="top">TSS2_RC </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga417170e7828a2ce3c141b87dbec6ca1d">ifapi_eventlog_append_finish</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const <a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> *pcr_event)</td></tr>
- <tr class="separator:ga417170e7828a2ce3c141b87dbec6ca1d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9677fd20dc24c0bc3ddb4492aaac529d"><td class="memItemLeft" align="right" valign="top">TSS2_RC </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga9677fd20dc24c0bc3ddb4492aaac529d">ifapi_eventlog_get_async</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, const TPM2_HANDLE *pcrList, size_t pcrListSize)</td></tr>
- <tr class="separator:ga9677fd20dc24c0bc3ddb4492aaac529d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga14c309bed3daccc393ac644c28e32efa"><td class="memItemLeft" align="right" valign="top">TSS2_RC </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#ga14c309bed3daccc393ac644c28e32efa">ifapi_eventlog_get_finish</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, <a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> *io, char **log)</td></tr>
- <tr class="separator:ga14c309bed3daccc393ac644c28e32efa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab2ade1bd7663318c8ff39f3bed986ff3"><td class="memItemLeft" align="right" valign="top">TSS2_RC </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__eventlog.html#gab2ade1bd7663318c8ff39f3bed986ff3">ifapi_eventlog_initialize</a> (<a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> *eventlog, const char *log_dir)</td></tr>
- <tr class="separator:gab2ade1bd7663318c8ff39f3bed986ff3"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>Provides internal fapi functions for the handling of event logs </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga5e89f103600a23fe7cd4b6dd4dc99ddd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga5e89f103600a23fe7cd4b6dd4dc99ddd">◆ </a></span>ifapi_cleanup_event()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void ifapi_cleanup_event </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Free allocated memory for an ifapi event.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>The structure to be cleaned up. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga6ac8c0daf0f029cd3696a86d68c73219"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga6ac8c0daf0f029cd3696a86d68c73219">◆ </a></span>ifapi_eventlog_append_check()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">TSS2_RC ifapi_eventlog_append_check </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> * </td>
- <td class="paramname"><em>eventlog</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> * </td>
- <td class="paramname"><em>io</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check event log format before appending an event to the existing event log.</p>
- <p>Call after ifapi_eventlog_get_async.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
- <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga417170e7828a2ce3c141b87dbec6ca1d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga417170e7828a2ce3c141b87dbec6ca1d">◆ </a></span>ifapi_eventlog_append_finish()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">TSS2_RC ifapi_eventlog_append_finish </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> * </td>
- <td class="paramname"><em>eventlog</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> * </td>
- <td class="paramname"><em>io</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="struct_i_f_a_p_i___e_v_e_n_t.html">IFAPI_EVENT</a> * </td>
- <td class="paramname"><em>pcr_event</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Append an event to the existing event log.</p>
- <p>Call after ifapi_eventlog_get_async.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
- <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">pcr_event</td><td>The event to be appended to the eventlog. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga9677fd20dc24c0bc3ddb4492aaac529d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga9677fd20dc24c0bc3ddb4492aaac529d">◆ </a></span>ifapi_eventlog_get_async()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">TSS2_RC ifapi_eventlog_get_async </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> * </td>
- <td class="paramname"><em>eventlog</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> * </td>
- <td class="paramname"><em>io</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const TPM2_HANDLE * </td>
- <td class="paramname"><em>pcrList</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>pcrListSize</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Retrieve the eventlog for a given list of pcrs using asynchronous io.</p>
- <p>Call ifapi_eventlog_get_finish to retrieve the results.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
- <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">pcrList</td><td>The list of PCR indices to retrieve the log for. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">pcrListSize</td><td>The size of pcrList. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga14c309bed3daccc393ac644c28e32efa"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga14c309bed3daccc393ac644c28e32efa">◆ </a></span>ifapi_eventlog_get_finish()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">TSS2_RC ifapi_eventlog_get_finish </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> * </td>
- <td class="paramname"><em>eventlog</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___i_o.html">IFAPI_IO</a> * </td>
- <td class="paramname"><em>io</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>log</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Retrieve the eventlog for a given list of pcrs using asynchronous io.</p>
- <p>Call after ifapi_eventlog_get_async.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
- <tr><td class="paramdir">[in,out]</td><td class="paramname">io</td><td>The context area for the asynchronous io module. </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">log</td><td>The event log for the requested PCRs in JSON format </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the I/O operation is not finished yet and this function needs to be called again. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gab2ade1bd7663318c8ff39f3bed986ff3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gab2ade1bd7663318c8ff39f3bed986ff3">◆ </a></span>ifapi_eventlog_initialize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">TSS2_RC ifapi_eventlog_initialize </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___e_v_e_n_t_l_o_g.html">IFAPI_EVENTLOG</a> * </td>
- <td class="paramname"><em>eventlog</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>log_dir</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Initialize the eventlog module of FAPI.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">eventlog</td><td>The context area for the eventlog. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">log_dir</td><td>The directory where to put the eventlog data. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if creation of log_dir failed or log_dir is not writable. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if memory allocation failed. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
- <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="footer">Generated by
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
- </ul>
- </div>
- </body>
- </html>
|