Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
SoftwareDesign
/
csu3_am335x
8
0
Салаа 0
Файлууд Асуудлууд 0 Хуулах хүсэлтүүд 0 Мэдлэгийн сан
Салаа: master
Салаанууд Тагууд
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group__ifapi__policy__execution.html

group__ifapi__policy__execution.html 15 KB
Байнгын холболт Түүх Анхны өгөгдөл

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295 
  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: Policy execution functions.</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__ifapi__policy__execution.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">Policy execution functions.<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a> &raquo; <a class="el" href="group__ifapi.html">Internals of Feature API</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:ga01ff79224d4877642c99c7ff698d895f"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__execution.html#ga01ff79224d4877642c99c7ff698d895f">get_policy_digest_idx</a> (TPML_DIGEST_VALUES *digest_values, TPMI_ALG_HASH hashAlg, size_t *idx)</td></tr>
    73. 

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

  74. <tr class="memitem:ga22089e183c37d59da09c2c9d38d4d402"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__execution.html#ga22089e183c37d59da09c2c9d38d4d402">ifapi_extend_authorization</a> (<a class="el" href="struct_t_p_m_s___p_o_l_i_c_y.html">TPMS_POLICY</a> *policy, <a class="el" href="struct_t_p_m_s___p_o_l_i_c_y_a_u_t_h_o_r_i_z_a_t_i_o_n.html">TPMS_POLICYAUTHORIZATION</a> *authorization)</td></tr>
    75. 

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

  76. <tr class="memitem:ga7cda976fe18fa117e01436bf90475848"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__execution.html#ga7cda976fe18fa117e01436bf90475848">ifapi_policyeval_execute</a> (<a class="el" href="group__esys__int.html#struct_e_s_y_s___c_o_n_t_e_x_t">ESYS_CONTEXT</a> *esys_ctx, <a class="el" href="struct_i_f_a_p_i___p_o_l_i_c_y___e_x_e_c___c_t_x.html">IFAPI_POLICY_EXEC_CTX</a> *current_policy)</td></tr>
    77. 

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

  78. <tr class="memitem:ga6e68667e49ec0daf18277b770df3f446"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ifapi__policy__execution.html#ga6e68667e49ec0daf18277b770df3f446">ifapi_policyeval_execute_prepare</a> (<a class="el" href="struct_i_f_a_p_i___p_o_l_i_c_y___e_x_e_c___c_t_x.html">IFAPI_POLICY_EXEC_CTX</a> *pol_ctx, TPMI_ALG_HASH hash_alg, <a class="el" href="struct_t_p_m_s___p_o_l_i_c_y.html">TPMS_POLICY</a> *policy)</td></tr>
    79. 

  79. <tr class="separator:ga6e68667e49ec0daf18277b770df3f446"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. </table>
    81. 

  81. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    82. 

  82. <p>Provides internal functions for policy execution. </p>
    83. 

  83. <h2 class="groupheader">Function Documentation</h2>
    84. 

  84. <a id="ga01ff79224d4877642c99c7ff698d895f"></a>
    85. 

  85. <h2 class="memtitle"><span class="permalink"><a href="#ga01ff79224d4877642c99c7ff698d895f">&#9670;&nbsp;</a></span>get_policy_digest_idx()</h2>
    86. 

  86. 

  87. <div class="memitem">
    88. 

  88. <div class="memproto">
    89. 

  89.       <table class="memname">
    90. 

  90.         <tr>
    91. 

  91.           <td class="memname">TSS2_RC get_policy_digest_idx </td>
    92. 

  92.           <td>(</td>
    93. 

  93.           <td class="paramtype">TPML_DIGEST_VALUES *&#160;</td>
    94. 

  94.           <td class="paramname"><em>digest_values</em>, </td>
    95. 

  95.         </tr>
    96. 

  96.         <tr>
    97. 

  97.           <td class="paramkey"></td>
    98. 

  98.           <td></td>
    99. 

  99.           <td class="paramtype">TPMI_ALG_HASH&#160;</td>
    100. 

  100.           <td class="paramname"><em>hashAlg</em>, </td>
    101. 

  101.         </tr>
    102. 

  102.         <tr>
    103. 

  103.           <td class="paramkey"></td>
    104. 

  104.           <td></td>
    105. 

  105.           <td class="paramtype">size_t *&#160;</td>
    106. 

  106.           <td class="paramname"><em>idx</em>&#160;</td>
    107. 

  107.         </tr>
    108. 

  108.         <tr>
    109. 

  109.           <td></td>
    110. 

  110.           <td>)</td>
    111. 

  111.           <td></td><td></td>
    112. 

  112.         </tr>
    113. 

  113.       </table>
    114. 

  114. </div><div class="memdoc">
    115. 

  115. <p>Compute the index for the current digest list and clear the digest.</p>
    116. 

  116. <p>The list entry with the appropriate hash algorithm will be searched. The found digest will be set to zero.</p>
    117. 

  117. <dl class="params"><dt>Parameters</dt><dd>
    118. 

  118.   <table class="params">
    119. 

  119.     <tr><td class="paramdir">[in,out]</td><td class="paramname">digest_values</td><td>The list of policy digests and corresponding hash algorithms. </td></tr>
    120. 

  120.     <tr><td class="paramdir">[in]</td><td class="paramname">hashAlg</td><td>The hash algorithm to be searched. </td></tr>
    121. 

  121.     <tr><td class="paramdir">[out]</td><td class="paramname">idx</td><td>The index of the found digest. </td></tr>
    122. 

  122.   </table>
    123. 

  123.   </dd>
    124. 

  124. </dl>
    125. 

  125. <dl class="retval"><dt>Return values</dt><dd>
    126. 

  126.   <table class="retval">
    127. 

  127.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    128. 

  128.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>If no appropriate digest was found in the digest list. </td></tr>
    129. 

  129.   </table>
    130. 

  130.   </dd>
    131. 

  131. </dl>
    132. 

  132. 

  133. </div>
    134. 

  134. </div>
    135. 

  135. <a id="ga22089e183c37d59da09c2c9d38d4d402"></a>
    136. 

  136. <h2 class="memtitle"><span class="permalink"><a href="#ga22089e183c37d59da09c2c9d38d4d402">&#9670;&nbsp;</a></span>ifapi_extend_authorization()</h2>
    137. 

  137. 

  138. <div class="memitem">
    139. 

  139. <div class="memproto">
    140. 

  140.       <table class="memname">
    141. 

  141.         <tr>
    142. 

  142.           <td class="memname">TSS2_RC ifapi_extend_authorization </td>
    143. 

  143.           <td>(</td>
    144. 

  144.           <td class="paramtype"><a class="el" href="struct_t_p_m_s___p_o_l_i_c_y.html">TPMS_POLICY</a> *&#160;</td>
    145. 

  145.           <td class="paramname"><em>policy</em>, </td>
    146. 

  146.         </tr>
    147. 

  147.         <tr>
    148. 

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

  149.           <td></td>
    150. 

  150.           <td class="paramtype"><a class="el" href="struct_t_p_m_s___p_o_l_i_c_y_a_u_t_h_o_r_i_z_a_t_i_o_n.html">TPMS_POLICYAUTHORIZATION</a> *&#160;</td>
    151. 

  151.           <td class="paramname"><em>authorization</em>&#160;</td>
    152. 

  152.         </tr>
    153. 

  153.         <tr>
    154. 

  154.           <td></td>
    155. 

  155.           <td>)</td>
    156. 

  156.           <td></td><td></td>
    157. 

  157.         </tr>
    158. 

  158.       </table>
    159. 

  159. </div><div class="memdoc">
    160. 

  160. <p>Add a new authorization to a policy.</p>
    161. 

  161. <p>The the signed hash computed from the policy digest and the policyRef together with the public key of the key used for signing will be stored in the policy.</p>
    162. 

  162. <dl class="params"><dt>Parameters</dt><dd>
    163. 

  163.   <table class="params">
    164. 

  164.     <tr><td class="paramdir">[in,out]</td><td class="paramname">policy</td><td>The policy to be authorized. </td></tr>
    165. 

  165.     <tr><td class="paramdir">[in]</td><td class="paramname">authorization</td><td>The structure with the signature, the policyRef and the public key.</td></tr>
    166. 

  166.   </table>
    167. 

  167.   </dd>
    168. 

  168. </dl>
    169. 

  169. <dl class="retval"><dt>Return values</dt><dd>
    170. 

  170.   <table class="retval">
    171. 

  171.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    172. 

  172.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>If the memory for the authorization list cannot be allocated. </td></tr>
    173. 

  173.   </table>
    174. 

  174.   </dd>
    175. 

  175. </dl>
    176. 

  176. 

  177. </div>
    178. 

  178. </div>
    179. 

  179. <a id="ga7cda976fe18fa117e01436bf90475848"></a>
    180. 

  180. <h2 class="memtitle"><span class="permalink"><a href="#ga7cda976fe18fa117e01436bf90475848">&#9670;&nbsp;</a></span>ifapi_policyeval_execute()</h2>
    181. 

  181. 

  182. <div class="memitem">
    183. 

  183. <div class="memproto">
    184. 

  184.       <table class="memname">
    185. 

  185.         <tr>
    186. 

  186.           <td class="memname">TSS2_RC ifapi_policyeval_execute </td>
    187. 

  187.           <td>(</td>
    188. 

  188.           <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>
    189. 

  189.           <td class="paramname"><em>esys_ctx</em>, </td>
    190. 

  190.         </tr>
    191. 

  191.         <tr>
    192. 

  192.           <td class="paramkey"></td>
    193. 

  193.           <td></td>
    194. 

  194.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___p_o_l_i_c_y___e_x_e_c___c_t_x.html">IFAPI_POLICY_EXEC_CTX</a> *&#160;</td>
    195. 

  195.           <td class="paramname"><em>current_policy</em>&#160;</td>
    196. 

  196.         </tr>
    197. 

  197.         <tr>
    198. 

  198.           <td></td>
    199. 

  199.           <td>)</td>
    200. 

  200.           <td></td><td></td>
    201. 

  201.         </tr>
    202. 

  202.       </table>
    203. 

  203. </div><div class="memdoc">
    204. 

  204. <p>Execute all policy commands defined by a list of policy elements.</p>
    205. 

  205. <dl class="retval"><dt>Return values</dt><dd>
    206. 

  206.   <table class="retval">
    207. 

  207.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    208. 

  208.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
    209. 

  209.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>If wrong values are detected during execution. </td></tr>
    210. 

  210.     <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>If an error occurs during access to the policy store. </td></tr>
    211. 

  211.     <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>If policy search for a certain policy digest was not successful. </td></tr>
    212. 

  212.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_TEMPLATE</td><td>In a invalid policy is loaded during execution. </td></tr>
    213. 

  213.     <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if an I/O operation is not finished yet and this function needs to be called again. </td></tr>
    214. 

  214.     <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
    215. 

  215.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
    216. 

  216.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    217. 

  217.     <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
    218. 

  218.     <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
    219. 

  219.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
    220. 

  220.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
    221. 

  221.     <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
    222. 

  222.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if the path is used in inappropriate context or contains illegal characters. </td></tr>
    223. 

  223.     <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
    224. 

  224.   </table>
    225. 

  225.   </dd>
    226. 

  226. </dl>
    227. 

  227. 

  228. </div>
    229. 

  229. </div>
    230. 

  230. <a id="ga6e68667e49ec0daf18277b770df3f446"></a>
    231. 

  231. <h2 class="memtitle"><span class="permalink"><a href="#ga6e68667e49ec0daf18277b770df3f446">&#9670;&nbsp;</a></span>ifapi_policyeval_execute_prepare()</h2>
    232. 

  232. 

  233. <div class="memitem">
    234. 

  234. <div class="memproto">
    235. 

  235.       <table class="memname">
    236. 

  236.         <tr>
    237. 

  237.           <td class="memname">TSS2_RC ifapi_policyeval_execute_prepare </td>
    238. 

  238.           <td>(</td>
    239. 

  239.           <td class="paramtype"><a class="el" href="struct_i_f_a_p_i___p_o_l_i_c_y___e_x_e_c___c_t_x.html">IFAPI_POLICY_EXEC_CTX</a> *&#160;</td>
    240. 

  240.           <td class="paramname"><em>pol_ctx</em>, </td>
    241. 

  241.         </tr>
    242. 

  242.         <tr>
    243. 

  243.           <td class="paramkey"></td>
    244. 

  244.           <td></td>
    245. 

  245.           <td class="paramtype">TPMI_ALG_HASH&#160;</td>
    246. 

  246.           <td class="paramname"><em>hash_alg</em>, </td>
    247. 

  247.         </tr>
    248. 

  248.         <tr>
    249. 

  249.           <td class="paramkey"></td>
    250. 

  250.           <td></td>
    251. 

  251.           <td class="paramtype"><a class="el" href="struct_t_p_m_s___p_o_l_i_c_y.html">TPMS_POLICY</a> *&#160;</td>
    252. 

  252.           <td class="paramname"><em>policy</em>&#160;</td>
    253. 

  253.         </tr>
    254. 

  254.         <tr>
    255. 

  255.           <td></td>
    256. 

  256.           <td>)</td>
    257. 

  257.           <td></td><td></td>
    258. 

  258.         </tr>
    259. 

  259.       </table>
    260. 

  260. </div><div class="memdoc">
    261. 

  261. <p>Initialize policy element list to be executed and store policy in context.</p>
    262. 

  262. <dl class="params"><dt>Parameters</dt><dd>
    263. 

  263.   <table class="params">
    264. 

  264.     <tr><td class="paramdir">[in]</td><td class="paramname">pol_ctx</td><td>Context for execution of a list of policy elements. </td></tr>
    265. 

  265.     <tr><td class="paramdir">[in]</td><td class="paramname">hash_alg</td><td>The hash algorithm used for the policy computation. </td></tr>
    266. 

  266.     <tr><td class="paramdir">[in,out]</td><td class="paramname">policy</td><td>The policy to be executed. Some policy elements will be used to store computed parameters needed for policy execution. </td></tr>
    267. 

  267.   </table>
    268. 

  268.   </dd>
    269. 

  269. </dl>
    270. 

  270. <dl class="retval"><dt>Return values</dt><dd>
    271. 

  271.   <table class="retval">
    272. 

  272.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success. </td></tr>
    273. 

  273.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>If the callback for branch selection is not defined. This callback will be needed of or policies have to be executed. </td></tr>
    274. 

  274.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>If the computed branch index deliverd by the callback does not identify a branch. </td></tr>
    275. 

  275.     <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if not enough memory can be allocated. </td></tr>
    276. 

  276.     <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>a invalid null pointer is passed. </td></tr>
    277. 

  277.     <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
    278. 

  278.   </table>
    279. 

  279.   </dd>
    280. 

  280. </dl>
    281. 

  281. 

  282. </div>
    283. 

  283. </div>
    284. 

  284. </div><!-- contents -->
    285. 

  285. </div><!-- doc-content -->
    286. 

  286. <!-- start footer part -->
    287. 

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

  288.   <ul>
    289. 

  289.     <li class="footer">Generated by
    290. 

  290.     <a href="http://www.doxygen.org/index.html">
    291. 

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

  292.   </ul>
    293. 

  293. </div>
    294. 

  294. </body>
    295. 

  295. </html>
    296.