group___fapi___quote.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>tpm2-tss: Fapi_Quote</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. </script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr style="height: 56px;">
  27. <td id="projectalign" style="padding-left: 0.5em;">
  28. <div id="projectname">tpm2-tss
  29. &#160;<span id="projectnumber">3.2.0</span>
  30. </div>
  31. <div id="projectbrief">TPM Software stack 2.0 TCG spec compliant implementation</div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- end header part -->
  38. <!-- Generated by Doxygen 1.8.13 -->
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. $(function() {
  43. initMenu('',false,false,'search.php','Search');
  44. });
  45. </script>
  46. <div id="main-nav"></div>
  47. </div><!-- top -->
  48. <div id="side-nav" class="ui-resizable side-nav-resizable">
  49. <div id="nav-tree">
  50. <div id="nav-tree-contents">
  51. <div id="nav-sync" class="sync"></div>
  52. </div>
  53. </div>
  54. <div id="splitbar" style="-moz-user-select:none;"
  55. class="ui-resizable-handle">
  56. </div>
  57. </div>
  58. <script type="text/javascript">
  59. $(document).ready(function(){initNavTree('group___fapi___quote.html','');});
  60. </script>
  61. <div id="doc-content">
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Fapi_Quote<div class="ingroups"><a class="el" href="group__fapi.html">Feature API</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:gaae9ed4c6ef7e097ae9b00ddc0a184f74"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___quote.html#gaae9ed4c6ef7e097ae9b00ddc0a184f74">Fapi_Quote</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, uint32_t *pcrList, size_t pcrListSize, char const *keyPath, char const *quoteType, uint8_t const *qualifyingData, size_t qualifyingDataSize, char **quoteInfo, uint8_t **signature, size_t *signatureSize, char **pcrLog, char **certificate)</td></tr>
  73. <tr class="separator:gaae9ed4c6ef7e097ae9b00ddc0a184f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga2a57d5a993a86e279de43fc21b452721"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___quote.html#ga2a57d5a993a86e279de43fc21b452721">Fapi_Quote_Async</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, uint32_t *pcrList, size_t pcrListSize, char const *keyPath, char const *quoteType, uint8_t const *qualifyingData, size_t qualifyingDataSize)</td></tr>
  75. <tr class="separator:ga2a57d5a993a86e279de43fc21b452721"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga6a9429c2b13d8ce7d6a4616326b5da54"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___quote.html#ga6a9429c2b13d8ce7d6a4616326b5da54">Fapi_Quote_Finish</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, char **quoteInfo, uint8_t **signature, size_t *signatureSize, char **pcrLog, char **certificate)</td></tr>
  77. <tr class="separator:ga6a9429c2b13d8ce7d6a4616326b5da54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table>
  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80. <p>FAPI functions to invoke Quote either as one-call or in an asynchronous manner. </p>
  81. <h2 class="groupheader">Function Documentation</h2>
  82. <a id="gaae9ed4c6ef7e097ae9b00ddc0a184f74"></a>
  83. <h2 class="memtitle"><span class="permalink"><a href="#gaae9ed4c6ef7e097ae9b00ddc0a184f74">&#9670;&nbsp;</a></span>Fapi_Quote()</h2>
  84. <div class="memitem">
  85. <div class="memproto">
  86. <table class="memname">
  87. <tr>
  88. <td class="memname">Fapi_Quote </td>
  89. <td>(</td>
  90. <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
  91. <td class="paramname"><em>context</em>, </td>
  92. </tr>
  93. <tr>
  94. <td class="paramkey"></td>
  95. <td></td>
  96. <td class="paramtype">uint32_t *&#160;</td>
  97. <td class="paramname"><em>pcrList</em>, </td>
  98. </tr>
  99. <tr>
  100. <td class="paramkey"></td>
  101. <td></td>
  102. <td class="paramtype">size_t&#160;</td>
  103. <td class="paramname"><em>pcrListSize</em>, </td>
  104. </tr>
  105. <tr>
  106. <td class="paramkey"></td>
  107. <td></td>
  108. <td class="paramtype">char const *&#160;</td>
  109. <td class="paramname"><em>keyPath</em>, </td>
  110. </tr>
  111. <tr>
  112. <td class="paramkey"></td>
  113. <td></td>
  114. <td class="paramtype">char const *&#160;</td>
  115. <td class="paramname"><em>quoteType</em>, </td>
  116. </tr>
  117. <tr>
  118. <td class="paramkey"></td>
  119. <td></td>
  120. <td class="paramtype">uint8_t const *&#160;</td>
  121. <td class="paramname"><em>qualifyingData</em>, </td>
  122. </tr>
  123. <tr>
  124. <td class="paramkey"></td>
  125. <td></td>
  126. <td class="paramtype">size_t&#160;</td>
  127. <td class="paramname"><em>qualifyingDataSize</em>, </td>
  128. </tr>
  129. <tr>
  130. <td class="paramkey"></td>
  131. <td></td>
  132. <td class="paramtype">char **&#160;</td>
  133. <td class="paramname"><em>quoteInfo</em>, </td>
  134. </tr>
  135. <tr>
  136. <td class="paramkey"></td>
  137. <td></td>
  138. <td class="paramtype">uint8_t **&#160;</td>
  139. <td class="paramname"><em>signature</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">size_t *&#160;</td>
  145. <td class="paramname"><em>signatureSize</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">char **&#160;</td>
  151. <td class="paramname"><em>pcrLog</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">char **&#160;</td>
  157. <td class="paramname"><em>certificate</em>&#160;</td>
  158. </tr>
  159. <tr>
  160. <td></td>
  161. <td>)</td>
  162. <td></td><td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>One-Call function for Fapi_Quote</p>
  167. <p>Given a set of PCRs and a restricted signing key, it will sign those PCRs and return the quote.</p>
  168. <dl class="params"><dt>Parameters</dt><dd>
  169. <table class="params">
  170. <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> </td></tr>
  171. <tr><td class="paramdir">[in]</td><td class="paramname">pcrList</td><td>The list of PCRs that are to be quoted </td></tr>
  172. <tr><td class="paramdir">[in]</td><td class="paramname">pcrListSize</td><td>The size of pcrList in bytes </td></tr>
  173. <tr><td class="paramdir">[in]</td><td class="paramname">keyPath</td><td>The path to the signing key </td></tr>
  174. <tr><td class="paramdir">[in]</td><td class="paramname">quoteType</td><td>The type of quote. May be NULL </td></tr>
  175. <tr><td class="paramdir">[in]</td><td class="paramname">qualifyingData</td><td>A nonce provided by the caller. May be NULL </td></tr>
  176. <tr><td class="paramdir">[in]</td><td class="paramname">qualifyingDataSize</td><td>The size of qualifyingData in bytes. Must be 0 if qualifyingData is NULL </td></tr>
  177. <tr><td class="paramdir">[out]</td><td class="paramname">quoteInfo</td><td>A JSON-encoded structure holding the inputs to the quote operation </td></tr>
  178. <tr><td class="paramdir">[out]</td><td class="paramname">signature</td><td>The signature of the PCRs </td></tr>
  179. <tr><td class="paramdir">[out]</td><td class="paramname">signatureSize</td><td>The size of the signature in bytes. May be NULL </td></tr>
  180. <tr><td class="paramdir">[out]</td><td class="paramname">pcrLog</td><td>The log of the PCR. May be NULL </td></tr>
  181. <tr><td class="paramdir">[out]</td><td class="paramname">certificate</td><td>The certificate associated with the signing key. May be NULL</td></tr>
  182. </table>
  183. </dd>
  184. </dl>
  185. <dl class="retval"><dt>Return values</dt><dd>
  186. <table class="retval">
  187. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  188. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context, pcrList, keyPath, quoteInfo or signature is NULL. </td></tr>
  189. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  190. <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if path does not map to a FAPI entity. </td></tr>
  191. <tr><td class="paramname">TSS2_FAPI_RC_BAD_KEY</td><td>if the entity at path is not a key, or is a key that is unsuitable for the requested operation. </td></tr>
  192. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if qualifyingData is invalid or if qualifyingDataSize is zero. </td></tr>
  193. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
  194. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  195. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
  196. <tr><td class="paramname">TSS2_FAPI_RC_NO_TPM</td><td>if FAPI was initialized in no-TPM-mode via its config file. </td></tr>
  197. <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>
  198. <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
  199. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
  200. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
  201. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
  202. <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
  203. <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
  204. <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
  205. <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>
  206. </table>
  207. </dd>
  208. </dl>
  209. </div>
  210. </div>
  211. <a id="ga2a57d5a993a86e279de43fc21b452721"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#ga2a57d5a993a86e279de43fc21b452721">&#9670;&nbsp;</a></span>Fapi_Quote_Async()</h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">Fapi_Quote_Async </td>
  218. <td>(</td>
  219. <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
  220. <td class="paramname"><em>context</em>, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype">uint32_t *&#160;</td>
  226. <td class="paramname"><em>pcrList</em>, </td>
  227. </tr>
  228. <tr>
  229. <td class="paramkey"></td>
  230. <td></td>
  231. <td class="paramtype">size_t&#160;</td>
  232. <td class="paramname"><em>pcrListSize</em>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype">char const *&#160;</td>
  238. <td class="paramname"><em>keyPath</em>, </td>
  239. </tr>
  240. <tr>
  241. <td class="paramkey"></td>
  242. <td></td>
  243. <td class="paramtype">char const *&#160;</td>
  244. <td class="paramname"><em>quoteType</em>, </td>
  245. </tr>
  246. <tr>
  247. <td class="paramkey"></td>
  248. <td></td>
  249. <td class="paramtype">uint8_t const *&#160;</td>
  250. <td class="paramname"><em>qualifyingData</em>, </td>
  251. </tr>
  252. <tr>
  253. <td class="paramkey"></td>
  254. <td></td>
  255. <td class="paramtype">size_t&#160;</td>
  256. <td class="paramname"><em>qualifyingDataSize</em>&#160;</td>
  257. </tr>
  258. <tr>
  259. <td></td>
  260. <td>)</td>
  261. <td></td><td></td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Asynchronous function for Fapi_Quote</p>
  266. <p>Given a set of PCRs and a restricted signing key, it will sign those PCRs and return the quote.</p>
  267. <p>Call Fapi_Quote_Finish to finish the execution of this command.</p>
  268. <dl class="params"><dt>Parameters</dt><dd>
  269. <table class="params">
  270. <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> </td></tr>
  271. <tr><td class="paramdir">[in]</td><td class="paramname">pcrList</td><td>The list of PCRs that are to be quoted </td></tr>
  272. <tr><td class="paramdir">[in]</td><td class="paramname">pcrListSize</td><td>The size of pcrList in bytes </td></tr>
  273. <tr><td class="paramdir">[in]</td><td class="paramname">keyPath</td><td>The path to the signing key </td></tr>
  274. <tr><td class="paramdir">[in]</td><td class="paramname">quoteType</td><td>The type of quote. May be NULL </td></tr>
  275. <tr><td class="paramdir">[in]</td><td class="paramname">qualifyingData</td><td>A nonce provided by the caller. May be NULL </td></tr>
  276. <tr><td class="paramdir">[in]</td><td class="paramname">qualifyingDataSize</td><td>The size of qualifyingData in bytes. Must be 0 if qualifyingData is NULL</td></tr>
  277. </table>
  278. </dd>
  279. </dl>
  280. <dl class="retval"><dt>Return values</dt><dd>
  281. <table class="retval">
  282. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  283. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context, pcrList or keyPath is NULL. </td></tr>
  284. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  285. <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if path does not map to a FAPI entity. </td></tr>
  286. <tr><td class="paramname">TSS2_FAPI_RC_BAD_KEY</td><td>if the entity at path is not a key, or is a key that is unsuitable for the requested operation. </td></tr>
  287. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if pcrListSize is 0, qualifyingData is invalid or if qualifyingDataSize is zero. </td></tr>
  288. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
  289. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  290. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
  291. <tr><td class="paramname">TSS2_FAPI_RC_NO_TPM</td><td>if FAPI was initialized in no-TPM-mode via its config file. </td></tr>
  292. </table>
  293. </dd>
  294. </dl>
  295. </div>
  296. </div>
  297. <a id="ga6a9429c2b13d8ce7d6a4616326b5da54"></a>
  298. <h2 class="memtitle"><span class="permalink"><a href="#ga6a9429c2b13d8ce7d6a4616326b5da54">&#9670;&nbsp;</a></span>Fapi_Quote_Finish()</h2>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname">Fapi_Quote_Finish </td>
  304. <td>(</td>
  305. <td class="paramtype"><a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *&#160;</td>
  306. <td class="paramname"><em>context</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">char **&#160;</td>
  312. <td class="paramname"><em>quoteInfo</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">uint8_t **&#160;</td>
  318. <td class="paramname"><em>signature</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">size_t *&#160;</td>
  324. <td class="paramname"><em>signatureSize</em>, </td>
  325. </tr>
  326. <tr>
  327. <td class="paramkey"></td>
  328. <td></td>
  329. <td class="paramtype">char **&#160;</td>
  330. <td class="paramname"><em>pcrLog</em>, </td>
  331. </tr>
  332. <tr>
  333. <td class="paramkey"></td>
  334. <td></td>
  335. <td class="paramtype">char **&#160;</td>
  336. <td class="paramname"><em>certificate</em>&#160;</td>
  337. </tr>
  338. <tr>
  339. <td></td>
  340. <td>)</td>
  341. <td></td><td></td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Asynchronous finish function for Fapi_Quote</p>
  346. <p>This function should be called after a previous Fapi_Quote_Async.</p>
  347. <dl class="params"><dt>Parameters</dt><dd>
  348. <table class="params">
  349. <tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>The <a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> </td></tr>
  350. <tr><td class="paramdir">[out]</td><td class="paramname">quoteInfo</td><td>A JSON-encoded structure holding the inputs to the quote operation </td></tr>
  351. <tr><td class="paramdir">[out]</td><td class="paramname">signature</td><td>The signature of the PCRs </td></tr>
  352. <tr><td class="paramdir">[out]</td><td class="paramname">signatureSize</td><td>The size of the signature in bytes. May be NULL </td></tr>
  353. <tr><td class="paramdir">[out]</td><td class="paramname">pcrLog</td><td>The log of the PCR. May be NULL </td></tr>
  354. <tr><td class="paramdir">[out]</td><td class="paramname">certificate</td><td>The certificate associated with the signing key. May be NULL</td></tr>
  355. </table>
  356. </dd>
  357. </dl>
  358. <dl class="retval"><dt>Return values</dt><dd>
  359. <table class="retval">
  360. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  361. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context, quoteInfor or signature is NULL. </td></tr>
  362. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  363. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  364. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
  365. <tr><td class="paramname">TSS2_FAPI_RC_MEMORY</td><td>if the FAPI cannot allocate enough memory for internal operations or return parameters. </td></tr>
  366. <tr><td class="paramname">TSS2_FAPI_RC_TRY_AGAIN</td><td>if the asynchronous operation is not yet complete. Call this function again later. </td></tr>
  367. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  368. <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
  369. <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
  370. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
  371. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
  372. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
  373. <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
  374. <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
  375. <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
  376. <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>
  377. </table>
  378. </dd>
  379. </dl>
  380. </div>
  381. </div>
  382. </div><!-- contents -->
  383. </div><!-- doc-content -->
  384. <!-- start footer part -->
  385. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  386. <ul>
  387. <li class="footer">Generated by
  388. <a href="http://www.doxygen.org/index.html">
  389. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  390. </ul>
  391. </div>
  392. </body>
  393. </html>