Головна сторінка Огляд Довідка
Увійти
SoftwareDesign
/
csu3_am335x
8
0
Відгалуження 0
Файли Проблеми 0 Запити на злиття 0 Wiki
Гілка: master
Гілки Теги
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group___esys___policy_signed.html

group___esys___policy_signed.html 24 KB
Постійне посилання Історія Запис

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.13"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>tpm2-tss: The ESAPI function for the TPM2_PolicySigned command.</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="resize.js"></script>
    14. 

  14. <script type="text/javascript" src="navtreedata.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18. </script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    23. 

  23. <div id="titlearea">
    24. 

  24. <table cellspacing="0" cellpadding="0">
    25. 

  25.  <tbody>
    26. 

  26.  <tr style="height: 56px;">
    27. 

  27.   <td id="projectalign" style="padding-left: 0.5em;">
    28. 

  28.    <div id="projectname">tpm2-tss
    29. 

  29.    &#160;<span id="projectnumber">3.2.0</span>
    30. 

  30.    </div>
    31. 

  31.    <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.13 -->
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. $(function() {
    43. 

  43.   initMenu('',false,false,'search.php','Search');
    44. 

  44. });
    45. 

  45. </script>
    46. 

  46. <div id="main-nav"></div>
    47. 

  47. </div><!-- top -->
    48. 

  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
    49. 

  49.   <div id="nav-tree">
    50. 

  50.     <div id="nav-tree-contents">
    51. 

  51.       <div id="nav-sync" class="sync"></div>
    52. 

  52.     </div>
    53. 

  53.   </div>
    54. 

  54.   <div id="splitbar" style="-moz-user-select:none;" 
    55. 

  55.        class="ui-resizable-handle">
    56. 

  56.   </div>
    57. 

  57. </div>
    58. 

  58. <script type="text/javascript">
    59. 

  59. $(document).ready(function(){initNavTree('group___esys___policy_signed.html','');});
    60. 

  60. </script>
    61. 

  61. <div id="doc-content">
    62. 

  62. <div class="header">
    63. 

  63.   <div class="summary">
    64. 

  64. <a href="#func-members">Functions</a>  </div>
    65. 

  65.   <div class="headertitle">
    66. 

  66. <div class="title">The ESAPI function for the TPM2_PolicySigned command.<div class="ingroups"><a class="el" href="group__esys.html">Enhanced System API</a> &raquo; <a class="el" href="group__esys__tpm.html">Esys TPM Commands</a></div></div>  </div>
    67. 

  67. </div><!--header-->
    68. 

  68. <div class="contents">
    69. 

  69. <table class="memberdecls">
    70. 

  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    71. 

  71. Functions</h2></td></tr>
    72. 

  72. <tr class="memitem:ga1a25d27ca50a66e4c3acdb9654796f07"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___policy_signed.html#ga1a25d27ca50a66e4c3acdb9654796f07">Esys_PolicySigned_Async</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esysContext, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> authObject, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> policySession, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle1, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle2, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, INT32 expiration, const TPMT_SIGNATURE *auth)</td></tr>
    73. 

  73. <tr class="separator:ga1a25d27ca50a66e4c3acdb9654796f07"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:gadb0229e6796b106ea08dd1032b3368be"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___policy_signed.html#gadb0229e6796b106ea08dd1032b3368be">Esys_PolicySigned</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esysContext, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> authObject, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> policySession, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle1, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle2, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, INT32 expiration, const TPMT_SIGNATURE *auth, TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket)</td></tr>
    75. 

  75. <tr class="separator:gadb0229e6796b106ea08dd1032b3368be"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:gac18b4589969a3517f7c3927ef3879cc2"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___policy_signed.html#gac18b4589969a3517f7c3927ef3879cc2">Esys_PolicySigned_Finish</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esysContext, TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket)</td></tr>
    77. 

  77. <tr class="separator:gac18b4589969a3517f7c3927ef3879cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. </table>
    79. 

  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    80. 

  80. <p>ESAPI function to invoke the TPM2_PolicySigned command either as a one-call or in an asynchronous manner. </p>
    81. 

  81. <h2 class="groupheader">Function Documentation</h2>
    82. 

  82. <a id="gadb0229e6796b106ea08dd1032b3368be"></a>
    83. 

  83. <h2 class="memtitle"><span class="permalink"><a href="#gadb0229e6796b106ea08dd1032b3368be">&#9670;&nbsp;</a></span>Esys_PolicySigned()</h2>
    84. 

  84. 

  85. <div class="memitem">
    86. 

  86. <div class="memproto">
    87. 

  87.       <table class="memname">
    88. 

  88.         <tr>
    89. 

  89.           <td class="memname">TSS2_RC Esys_PolicySigned </td>
    90. 

  90.           <td>(</td>
    91. 

  91.           <td class="paramtype"><a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *&#160;</td>
    92. 

  92.           <td class="paramname"><em>esysContext</em>, </td>
    93. 

  93.         </tr>
    94. 

  94.         <tr>
    95. 

  95.           <td class="paramkey"></td>
    96. 

  96.           <td></td>
    97. 

  97.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    98. 

  98.           <td class="paramname"><em>authObject</em>, </td>
    99. 

  99.         </tr>
    100. 

  100.         <tr>
    101. 

  101.           <td class="paramkey"></td>
    102. 

  102.           <td></td>
    103. 

  103.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    104. 

  104.           <td class="paramname"><em>policySession</em>, </td>
    105. 

  105.         </tr>
    106. 

  106.         <tr>
    107. 

  107.           <td class="paramkey"></td>
    108. 

  108.           <td></td>
    109. 

  109.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    110. 

  110.           <td class="paramname"><em>shandle1</em>, </td>
    111. 

  111.         </tr>
    112. 

  112.         <tr>
    113. 

  113.           <td class="paramkey"></td>
    114. 

  114.           <td></td>
    115. 

  115.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    116. 

  116.           <td class="paramname"><em>shandle2</em>, </td>
    117. 

  117.         </tr>
    118. 

  118.         <tr>
    119. 

  119.           <td class="paramkey"></td>
    120. 

  120.           <td></td>
    121. 

  121.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    122. 

  122.           <td class="paramname"><em>shandle3</em>, </td>
    123. 

  123.         </tr>
    124. 

  124.         <tr>
    125. 

  125.           <td class="paramkey"></td>
    126. 

  126.           <td></td>
    127. 

  127.           <td class="paramtype">const TPM2B_NONCE *&#160;</td>
    128. 

  128.           <td class="paramname"><em>nonceTPM</em>, </td>
    129. 

  129.         </tr>
    130. 

  130.         <tr>
    131. 

  131.           <td class="paramkey"></td>
    132. 

  132.           <td></td>
    133. 

  133.           <td class="paramtype">const TPM2B_DIGEST *&#160;</td>
    134. 

  134.           <td class="paramname"><em>cpHashA</em>, </td>
    135. 

  135.         </tr>
    136. 

  136.         <tr>
    137. 

  137.           <td class="paramkey"></td>
    138. 

  138.           <td></td>
    139. 

  139.           <td class="paramtype">const TPM2B_NONCE *&#160;</td>
    140. 

  140.           <td class="paramname"><em>policyRef</em>, </td>
    141. 

  141.         </tr>
    142. 

  142.         <tr>
    143. 

  143.           <td class="paramkey"></td>
    144. 

  144.           <td></td>
    145. 

  145.           <td class="paramtype">INT32&#160;</td>
    146. 

  146.           <td class="paramname"><em>expiration</em>, </td>
    147. 

  147.         </tr>
    148. 

  148.         <tr>
    149. 

  149.           <td class="paramkey"></td>
    150. 

  150.           <td></td>
    151. 

  151.           <td class="paramtype">const TPMT_SIGNATURE *&#160;</td>
    152. 

  152.           <td class="paramname"><em>auth</em>, </td>
    153. 

  153.         </tr>
    154. 

  154.         <tr>
    155. 

  155.           <td class="paramkey"></td>
    156. 

  156.           <td></td>
    157. 

  157.           <td class="paramtype">TPM2B_TIMEOUT **&#160;</td>
    158. 

  158.           <td class="paramname"><em>timeout</em>, </td>
    159. 

  159.         </tr>
    160. 

  160.         <tr>
    161. 

  161.           <td class="paramkey"></td>
    162. 

  162.           <td></td>
    163. 

  163.           <td class="paramtype">TPMT_TK_AUTH **&#160;</td>
    164. 

  164.           <td class="paramname"><em>policyTicket</em>&#160;</td>
    165. 

  165.         </tr>
    166. 

  166.         <tr>
    167. 

  167.           <td></td>
    168. 

  168.           <td>)</td>
    169. 

  169.           <td></td><td></td>
    170. 

  170.         </tr>
    171. 

  171.       </table>
    172. 

  172. </div><div class="memdoc">
    173. 

  173. <p>One-Call function for TPM2_PolicySigned</p>
    174. 

  174. <p>This function invokes the TPM2_PolicySigned command in a one-call variant. This means the function will block until the TPM response is available. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.</p>
    175. 

  175. <dl class="params"><dt>Parameters</dt><dd>
    176. 

  176.   <table class="params">
    177. 

  177.     <tr><td class="paramdir">[in,out]</td><td class="paramname">esysContext</td><td>The <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a>. </td></tr>
    178. 

  178.     <tr><td class="paramdir">[in]</td><td class="paramname">authObject</td><td>Handle for a key that will validate the signature. </td></tr>
    179. 

  179.     <tr><td class="paramdir">[in]</td><td class="paramname">policySession</td><td>Handle for the policy session being extended. </td></tr>
    180. 

  180.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle1</td><td>First session handle. </td></tr>
    181. 

  181.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle2</td><td>Second session handle. </td></tr>
    182. 

  182.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle3</td><td>Third session handle. </td></tr>
    183. 

  183.     <tr><td class="paramdir">[in]</td><td class="paramname">nonceTPM</td><td>The policy nonce for the session. </td></tr>
    184. 

  184.     <tr><td class="paramdir">[in]</td><td class="paramname">cpHashA</td><td>Digest of the command parameters to which this authorization is limited. </td></tr>
    185. 

  185.     <tr><td class="paramdir">[in]</td><td class="paramname">policyRef</td><td>A reference to a policy relating to the authorization<ul>
    186. 

  186. <li>may be the Empty Buffer. </li>
    187. 

  187. </ul>
    188. 

  188. </td></tr>
    189. 

  189.     <tr><td class="paramdir">[in]</td><td class="paramname">expiration</td><td>Time when authorization will expire, measured in seconds from the time that nonceTPM was generated. </td></tr>
    190. 

  190.     <tr><td class="paramdir">[in]</td><td class="paramname">auth</td><td>Signed authorization (not optional). </td></tr>
    191. 

  191.     <tr><td class="paramdir">[out]</td><td class="paramname">timeout</td><td>Implementation-specific time value, used to indicate to the TPM when the ticket expires. (callee-allocated) </td></tr>
    192. 

  192.     <tr><td class="paramdir">[out]</td><td class="paramname">policyTicket</td><td>Produced if the command succeeds and expiration in the command was non-zero; this ticket will use the TPMT_ST_AUTH_SIGNED structure tag. See 23.2.5. (callee-allocated) </td></tr>
    193. 

  193.   </table>
    194. 

  194.   </dd>
    195. 

  195. </dl>
    196. 

  196. <dl class="retval"><dt>Return values</dt><dd>
    197. 

  197.   <table class="retval">
    198. 

  198.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    199. 

  199.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_REFERENCE</td><td>if the esysContext or required input pointers or required output handle references are NULL. </td></tr>
    200. 

  200.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_CONTEXT</td><td>if esysContext corruption is detected. </td></tr>
    201. 

  201.     <tr><td class="paramname">TSS2_ESYS_RC_MEMORY</td><td>if the ESAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    202. 

  202.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    203. 

  203.     <tr><td class="paramname">TSS2_ESYS_RC_INSUFFICIENT_RESPONSE</td><td>if the TPM's response does not at least contain the tag, response length, and response code. </td></tr>
    204. 

  204.     <tr><td class="paramname">TSS2_ESYS_RC_MALFORMED_RESPONSE</td><td>if the TPM's response is corrupted. </td></tr>
    205. 

  205.     <tr><td class="paramname">TSS2_ESYS_RC_RSP_AUTH_FAILED</td><td>if the response HMAC from the TPM did not verify. </td></tr>
    206. 

  206.     <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS</td><td>if more than one session has the 'decrypt' attribute bit set. </td></tr>
    207. 

  207.     <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS</td><td>if more than one session has the 'encrypt' attribute bit set. </td></tr>
    208. 

  208.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_TR</td><td>if any of the ESYS_TR objects are unknown to the <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE. </td></tr>
    209. 

  209.     <tr><td class="paramname">TSS2_RCs</td><td>produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. </td></tr>
    210. 

  210.   </table>
    211. 

  211.   </dd>
    212. 

  212. </dl>
    213. 

  213. 

  214. </div>
    215. 

  215. </div>
    216. 

  216. <a id="ga1a25d27ca50a66e4c3acdb9654796f07"></a>
    217. 

  217. <h2 class="memtitle"><span class="permalink"><a href="#ga1a25d27ca50a66e4c3acdb9654796f07">&#9670;&nbsp;</a></span>Esys_PolicySigned_Async()</h2>
    218. 

  218. 

  219. <div class="memitem">
    220. 

  220. <div class="memproto">
    221. 

  221.       <table class="memname">
    222. 

  222.         <tr>
    223. 

  223.           <td class="memname">TSS2_RC Esys_PolicySigned_Async </td>
    224. 

  224.           <td>(</td>
    225. 

  225.           <td class="paramtype"><a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *&#160;</td>
    226. 

  226.           <td class="paramname"><em>esysContext</em>, </td>
    227. 

  227.         </tr>
    228. 

  228.         <tr>
    229. 

  229.           <td class="paramkey"></td>
    230. 

  230.           <td></td>
    231. 

  231.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    232. 

  232.           <td class="paramname"><em>authObject</em>, </td>
    233. 

  233.         </tr>
    234. 

  234.         <tr>
    235. 

  235.           <td class="paramkey"></td>
    236. 

  236.           <td></td>
    237. 

  237.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    238. 

  238.           <td class="paramname"><em>policySession</em>, </td>
    239. 

  239.         </tr>
    240. 

  240.         <tr>
    241. 

  241.           <td class="paramkey"></td>
    242. 

  242.           <td></td>
    243. 

  243.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    244. 

  244.           <td class="paramname"><em>shandle1</em>, </td>
    245. 

  245.         </tr>
    246. 

  246.         <tr>
    247. 

  247.           <td class="paramkey"></td>
    248. 

  248.           <td></td>
    249. 

  249.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    250. 

  250.           <td class="paramname"><em>shandle2</em>, </td>
    251. 

  251.         </tr>
    252. 

  252.         <tr>
    253. 

  253.           <td class="paramkey"></td>
    254. 

  254.           <td></td>
    255. 

  255.           <td class="paramtype"><a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a>&#160;</td>
    256. 

  256.           <td class="paramname"><em>shandle3</em>, </td>
    257. 

  257.         </tr>
    258. 

  258.         <tr>
    259. 

  259.           <td class="paramkey"></td>
    260. 

  260.           <td></td>
    261. 

  261.           <td class="paramtype">const TPM2B_NONCE *&#160;</td>
    262. 

  262.           <td class="paramname"><em>nonceTPM</em>, </td>
    263. 

  263.         </tr>
    264. 

  264.         <tr>
    265. 

  265.           <td class="paramkey"></td>
    266. 

  266.           <td></td>
    267. 

  267.           <td class="paramtype">const TPM2B_DIGEST *&#160;</td>
    268. 

  268.           <td class="paramname"><em>cpHashA</em>, </td>
    269. 

  269.         </tr>
    270. 

  270.         <tr>
    271. 

  271.           <td class="paramkey"></td>
    272. 

  272.           <td></td>
    273. 

  273.           <td class="paramtype">const TPM2B_NONCE *&#160;</td>
    274. 

  274.           <td class="paramname"><em>policyRef</em>, </td>
    275. 

  275.         </tr>
    276. 

  276.         <tr>
    277. 

  277.           <td class="paramkey"></td>
    278. 

  278.           <td></td>
    279. 

  279.           <td class="paramtype">INT32&#160;</td>
    280. 

  280.           <td class="paramname"><em>expiration</em>, </td>
    281. 

  281.         </tr>
    282. 

  282.         <tr>
    283. 

  283.           <td class="paramkey"></td>
    284. 

  284.           <td></td>
    285. 

  285.           <td class="paramtype">const TPMT_SIGNATURE *&#160;</td>
    286. 

  286.           <td class="paramname"><em>auth</em>&#160;</td>
    287. 

  287.         </tr>
    288. 

  288.         <tr>
    289. 

  289.           <td></td>
    290. 

  290.           <td>)</td>
    291. 

  291.           <td></td><td></td>
    292. 

  292.         </tr>
    293. 

  293.       </table>
    294. 

  294. </div><div class="memdoc">
    295. 

  295. <p>Asynchronous function for TPM2_PolicySigned</p>
    296. 

  296. <p>This function invokes the TPM2_PolicySigned command in a asynchronous variant. This means the function will return as soon as the command has been sent downwards the stack to the TPM. All input parameters are const. In order to retrieve the TPM's response call Esys_PolicySigned_Finish.</p>
    297. 

  297. <dl class="params"><dt>Parameters</dt><dd>
    298. 

  298.   <table class="params">
    299. 

  299.     <tr><td class="paramdir">[in,out]</td><td class="paramname">esysContext</td><td>The <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a>. </td></tr>
    300. 

  300.     <tr><td class="paramdir">[in]</td><td class="paramname">authObject</td><td>Handle for a key that will validate the signature. </td></tr>
    301. 

  301.     <tr><td class="paramdir">[in]</td><td class="paramname">policySession</td><td>Handle for the policy session being extended. </td></tr>
    302. 

  302.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle1</td><td>First session handle. </td></tr>
    303. 

  303.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle2</td><td>Second session handle. </td></tr>
    304. 

  304.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle3</td><td>Third session handle. </td></tr>
    305. 

  305.     <tr><td class="paramdir">[in]</td><td class="paramname">nonceTPM</td><td>The policy nonce for the session. </td></tr>
    306. 

  306.     <tr><td class="paramdir">[in]</td><td class="paramname">cpHashA</td><td>Digest of the command parameters to which this authorization is limited. </td></tr>
    307. 

  307.     <tr><td class="paramdir">[in]</td><td class="paramname">policyRef</td><td>A reference to a policy relating to the authorization<ul>
    308. 

  308. <li>may be the Empty Buffer. </li>
    309. 

  309. </ul>
    310. 

  310. </td></tr>
    311. 

  311.     <tr><td class="paramdir">[in]</td><td class="paramname">expiration</td><td>Time when authorization will expire, measured in seconds from the time that nonceTPM was generated. </td></tr>
    312. 

  312.     <tr><td class="paramdir">[in]</td><td class="paramname">auth</td><td>Signed authorization (not optional). </td></tr>
    313. 

  313.   </table>
    314. 

  314.   </dd>
    315. 

  315. </dl>
    316. 

  316. <dl class="retval"><dt>Return values</dt><dd>
    317. 

  317.   <table class="retval">
    318. 

  318.     <tr><td class="paramname">ESYS_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    319. 

  319.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_REFERENCE</td><td>if the esysContext or required input pointers or required output handle references are NULL. </td></tr>
    320. 

  320.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_CONTEXT</td><td>if esysContext corruption is detected. </td></tr>
    321. 

  321.     <tr><td class="paramname">TSS2_ESYS_RC_MEMORY</td><td>if the ESAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    322. 

  322.     <tr><td class="paramname">TSS2_RCs</td><td>produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. </td></tr>
    323. 

  323.     <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS</td><td>if more than one session has the 'decrypt' attribute bit set. </td></tr>
    324. 

  324.     <tr><td class="paramname">TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS</td><td>if more than one session has the 'encrypt' attribute bit set. </td></tr>
    325. 

  325.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_TR</td><td>if any of the ESYS_TR objects are unknown to the <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE. </td></tr>
    326. 

  326.   </table>
    327. 

  327.   </dd>
    328. 

  328. </dl>
    329. 

  329. 

  330. </div>
    331. 

  331. </div>
    332. 

  332. <a id="gac18b4589969a3517f7c3927ef3879cc2"></a>
    333. 

  333. <h2 class="memtitle"><span class="permalink"><a href="#gac18b4589969a3517f7c3927ef3879cc2">&#9670;&nbsp;</a></span>Esys_PolicySigned_Finish()</h2>
    334. 

  334. 

  335. <div class="memitem">
    336. 

  336. <div class="memproto">
    337. 

  337.       <table class="memname">
    338. 

  338.         <tr>
    339. 

  339.           <td class="memname">TSS2_RC Esys_PolicySigned_Finish </td>
    340. 

  340.           <td>(</td>
    341. 

  341.           <td class="paramtype"><a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *&#160;</td>
    342. 

  342.           <td class="paramname"><em>esysContext</em>, </td>
    343. 

  343.         </tr>
    344. 

  344.         <tr>
    345. 

  345.           <td class="paramkey"></td>
    346. 

  346.           <td></td>
    347. 

  347.           <td class="paramtype">TPM2B_TIMEOUT **&#160;</td>
    348. 

  348.           <td class="paramname"><em>timeout</em>, </td>
    349. 

  349.         </tr>
    350. 

  350.         <tr>
    351. 

  351.           <td class="paramkey"></td>
    352. 

  352.           <td></td>
    353. 

  353.           <td class="paramtype">TPMT_TK_AUTH **&#160;</td>
    354. 

  354.           <td class="paramname"><em>policyTicket</em>&#160;</td>
    355. 

  355.         </tr>
    356. 

  356.         <tr>
    357. 

  357.           <td></td>
    358. 

  358.           <td>)</td>
    359. 

  359.           <td></td><td></td>
    360. 

  360.         </tr>
    361. 

  361.       </table>
    362. 

  362. </div><div class="memdoc">
    363. 

  363. <p>Asynchronous finish function for TPM2_PolicySigned</p>
    364. 

  364. <p>This function returns the results of a TPM2_PolicySigned command invoked via Esys_PolicySigned_Finish. All non-simple output parameters are allocated by the function's implementation. NULL can be passed for every output parameter if the value is not required.</p>
    365. 

  365. <dl class="params"><dt>Parameters</dt><dd>
    366. 

  366.   <table class="params">
    367. 

  367.     <tr><td class="paramdir">[in,out]</td><td class="paramname">esysContext</td><td>The <a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a>. </td></tr>
    368. 

  368.     <tr><td class="paramdir">[out]</td><td class="paramname">timeout</td><td>Implementation-specific time value, used to indicate to the TPM when the ticket expires. (callee-allocated) </td></tr>
    369. 

  369.     <tr><td class="paramdir">[out]</td><td class="paramname">policyTicket</td><td>Produced if the command succeeds and expiration in the command was non-zero; this ticket will use the TPMT_ST_AUTH_SIGNED structure tag. See 23.2.5. (callee-allocated) </td></tr>
    370. 

  370.   </table>
    371. 

  371.   </dd>
    372. 

  372. </dl>
    373. 

  373. <dl class="retval"><dt>Return values</dt><dd>
    374. 

  374.   <table class="retval">
    375. 

  375.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success </td></tr>
    376. 

  376.     <tr><td class="paramname">ESYS_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
    377. 

  377.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_REFERENCE</td><td>if the esysContext or required input pointers or required output handle references are NULL. </td></tr>
    378. 

  378.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_CONTEXT</td><td>if esysContext corruption is detected. </td></tr>
    379. 

  379.     <tr><td class="paramname">TSS2_ESYS_RC_MEMORY</td><td>if the ESAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
    380. 

  380.     <tr><td class="paramname">TSS2_ESYS_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    381. 

  381.     <tr><td class="paramname">TSS2_ESYS_RC_TRY_AGAIN</td><td>if the timeout counter expires before the TPM response is received. </td></tr>
    382. 

  382.     <tr><td class="paramname">TSS2_ESYS_RC_INSUFFICIENT_RESPONSE</td><td>if the TPM's response does not at least contain the tag, response length, and response code. </td></tr>
    383. 

  383.     <tr><td class="paramname">TSS2_ESYS_RC_RSP_AUTH_FAILED</td><td>if the response HMAC from the TPM did not verify. </td></tr>
    384. 

  384.     <tr><td class="paramname">TSS2_ESYS_RC_MALFORMED_RESPONSE</td><td>if the TPM's response is corrupted. </td></tr>
    385. 

  385.     <tr><td class="paramname">TSS2_RCs</td><td>produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. </td></tr>
    386. 

  386.   </table>
    387. 

  387.   </dd>
    388. 

  388. </dl>
    389. 

  389. 

  390. </div>
    391. 

  391. </div>
    392. 

  392. </div><!-- contents -->
    393. 

  393. </div><!-- doc-content -->
    394. 

  394. <!-- start footer part -->
    395. 

  395. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    396. 

  396.   <ul>
    397. 

  397.     <li class="footer">Generated by
    398. 

  398.     <a href="http://www.doxygen.org/index.html">
    399. 

  399.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
    400. 

  400.   </ul>
    401. 

  401. </div>
    402. 

  402. </body>
    403. 

  403. </html>
    404.