group___fapi___create_nv.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  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_CreateNv</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___create_nv.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_CreateNv<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:gabdea8a4a9aa6c07589bd01f80c373117"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_nv.html#gabdea8a4a9aa6c07589bd01f80c373117">Fapi_CreateNv</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue)</td></tr>
  73. <tr class="separator:gabdea8a4a9aa6c07589bd01f80c373117"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:gadd3eb9d5fd4a941d2d52c798eeef6c79"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_nv.html#gadd3eb9d5fd4a941d2d52c798eeef6c79">Fapi_CreateNv_Async</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue)</td></tr>
  75. <tr class="separator:gadd3eb9d5fd4a941d2d52c798eeef6c79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga9591e43cd9a21fa112c78e56d0b5b45a"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___fapi___create_nv.html#ga9591e43cd9a21fa112c78e56d0b5b45a">Fapi_CreateNv_Finish</a> (<a class="el" href="struct_f_a_p_i___c_o_n_t_e_x_t.html">FAPI_CONTEXT</a> *context)</td></tr>
  77. <tr class="separator:ga9591e43cd9a21fa112c78e56d0b5b45a"><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 CreateNv either as one-call or in an asynchronous manner. </p>
  81. <h2 class="groupheader">Function Documentation</h2>
  82. <a id="gabdea8a4a9aa6c07589bd01f80c373117"></a>
  83. <h2 class="memtitle"><span class="permalink"><a href="#gabdea8a4a9aa6c07589bd01f80c373117">&#9670;&nbsp;</a></span>Fapi_CreateNv()</h2>
  84. <div class="memitem">
  85. <div class="memproto">
  86. <table class="memname">
  87. <tr>
  88. <td class="memname">Fapi_CreateNv </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">char const *&#160;</td>
  97. <td class="paramname"><em>path</em>, </td>
  98. </tr>
  99. <tr>
  100. <td class="paramkey"></td>
  101. <td></td>
  102. <td class="paramtype">char const *&#160;</td>
  103. <td class="paramname"><em>type</em>, </td>
  104. </tr>
  105. <tr>
  106. <td class="paramkey"></td>
  107. <td></td>
  108. <td class="paramtype">size_t&#160;</td>
  109. <td class="paramname"><em>size</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>policyPath</em>, </td>
  116. </tr>
  117. <tr>
  118. <td class="paramkey"></td>
  119. <td></td>
  120. <td class="paramtype">char const *&#160;</td>
  121. <td class="paramname"><em>authValue</em>&#160;</td>
  122. </tr>
  123. <tr>
  124. <td></td>
  125. <td>)</td>
  126. <td></td><td></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>One-Call function for Fapi_CreateNv</p>
  131. <p>This command creates an NV index in the TPM using a given path and type.</p>
  132. <dl class="params"><dt>Parameters</dt><dd>
  133. <table class="params">
  134. <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>
  135. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path to the new NV index </td></tr>
  136. <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The intended type of the new NV index. May be NULL </td></tr>
  137. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the new NV index in bytes. May be 0 if the size is inferred from the type </td></tr>
  138. <tr><td class="paramdir">[in]</td><td class="paramname">policyPath</td><td>The path to the policy that is associated with the new NV index. May be NULL </td></tr>
  139. <tr><td class="paramdir">[in]</td><td class="paramname">authValue</td><td>The authorization value that is associated with the new NV index. May be NULL</td></tr>
  140. </table>
  141. </dd>
  142. </dl>
  143. <dl class="retval"><dt>Return values</dt><dd>
  144. <table class="retval">
  145. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  146. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context or path is NULL. </td></tr>
  147. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  148. <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if an NV index already exists at path. </td></tr>
  149. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if type is non-NULL but invalid or does not match the size. </td></tr>
  150. <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if policyPath is non-NULL and does not map to a FAPI policy or if path dos not refer to a valid NV index path. </td></tr>
  151. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  152. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
  153. <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>
  154. <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>
  155. <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>
  156. <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
  157. <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
  158. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
  159. <tr><td class="paramname">TSS2_FAPI_RC_NV_TOO_SMALL</td><td>if too many NV handles are defined. </td></tr>
  160. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
  161. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
  162. <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
  163. <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
  164. <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
  165. </table>
  166. </dd>
  167. </dl>
  168. </div>
  169. </div>
  170. <a id="gadd3eb9d5fd4a941d2d52c798eeef6c79"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#gadd3eb9d5fd4a941d2d52c798eeef6c79">&#9670;&nbsp;</a></span>Fapi_CreateNv_Async()</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">Fapi_CreateNv_Async </td>
  177. <td>(</td>
  178. <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>
  179. <td class="paramname"><em>context</em>, </td>
  180. </tr>
  181. <tr>
  182. <td class="paramkey"></td>
  183. <td></td>
  184. <td class="paramtype">char const *&#160;</td>
  185. <td class="paramname"><em>path</em>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype">char const *&#160;</td>
  191. <td class="paramname"><em>type</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">size_t&#160;</td>
  197. <td class="paramname"><em>size</em>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype">char const *&#160;</td>
  203. <td class="paramname"><em>policyPath</em>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">char const *&#160;</td>
  209. <td class="paramname"><em>authValue</em>&#160;</td>
  210. </tr>
  211. <tr>
  212. <td></td>
  213. <td>)</td>
  214. <td></td><td></td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>Asynchronous function for Fapi_CreateNv</p>
  219. <p>This command creates an NV index in the TPM using a given path and type.</p>
  220. <p>Call Fapi_CreateNv_Finish to finish the execution of this command.</p>
  221. <dl class="params"><dt>Parameters</dt><dd>
  222. <table class="params">
  223. <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>
  224. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path to the new NV index </td></tr>
  225. <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The intended type of the new NV index. May be NULL </td></tr>
  226. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the new NV index in bytes. May be 0 if the size is inferred from the type </td></tr>
  227. <tr><td class="paramdir">[in]</td><td class="paramname">policyPath</td><td>The path to the policy that is associated with the new NV index. May be NULL </td></tr>
  228. <tr><td class="paramdir">[in]</td><td class="paramname">authValue</td><td>The authorization value that is associated with the new NV index. May be NULL</td></tr>
  229. </table>
  230. </dd>
  231. </dl>
  232. <dl class="retval"><dt>Return values</dt><dd>
  233. <table class="retval">
  234. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  235. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context or path is NULL. </td></tr>
  236. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  237. <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if an NV index already exists at path. </td></tr>
  238. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if type is non-NULL but invalid or does not match the size. </td></tr>
  239. <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if policyPath is non-NULL and does not map to a FAPI policy or if path dos not refer to a valid NV index path. </td></tr>
  240. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  241. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
  242. <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>
  243. <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>
  244. <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
  245. </table>
  246. </dd>
  247. </dl>
  248. </div>
  249. </div>
  250. <a id="ga9591e43cd9a21fa112c78e56d0b5b45a"></a>
  251. <h2 class="memtitle"><span class="permalink"><a href="#ga9591e43cd9a21fa112c78e56d0b5b45a">&#9670;&nbsp;</a></span>Fapi_CreateNv_Finish()</h2>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">Fapi_CreateNv_Finish </td>
  257. <td>(</td>
  258. <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>
  259. <td class="paramname"><em>context</em></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Asynchronous finish function for Fapi_CreateNv</p>
  265. <p>This function should be called after a previous Fapi_CreateNv_Async.</p>
  266. <dl class="params"><dt>Parameters</dt><dd>
  267. <table class="params">
  268. <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>
  269. </table>
  270. </dd>
  271. </dl>
  272. <dl class="retval"><dt>Return values</dt><dd>
  273. <table class="retval">
  274. <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>if the function call was a success. </td></tr>
  275. <tr><td class="paramname">TSS2_FAPI_RC_BAD_REFERENCE</td><td>if context is NULL. </td></tr>
  276. <tr><td class="paramname">TSS2_FAPI_RC_BAD_CONTEXT</td><td>if context corruption is detected. </td></tr>
  277. <tr><td class="paramname">TSS2_FAPI_RC_BAD_SEQUENCE</td><td>if the context has an asynchronous operation already pending. </td></tr>
  278. <tr><td class="paramname">TSS2_FAPI_RC_IO_ERROR</td><td>if the data cannot be saved. </td></tr>
  279. <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>
  280. <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>
  281. <tr><td class="paramname">TSS2_FAPI_RC_BAD_VALUE</td><td>if an invalid value was passed into the function. </td></tr>
  282. <tr><td class="paramname">TSS2_FAPI_RC_PATH_NOT_FOUND</td><td>if a FAPI object path was not found during authorization. </td></tr>
  283. <tr><td class="paramname">TSS2_FAPI_RC_KEY_NOT_FOUND</td><td>if a key was not found. </td></tr>
  284. <tr><td class="paramname">TSS2_FAPI_RC_GENERAL_FAILURE</td><td>if an internal error occurred. </td></tr>
  285. <tr><td class="paramname">TSS2_FAPI_RC_BAD_PATH</td><td>if a path is used in inappropriate context or contains illegal characters. </td></tr>
  286. <tr><td class="paramname">TSS2_FAPI_RC_NV_TOO_SMALL</td><td>if too many NV handles are defined. </td></tr>
  287. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN</td><td>if a required authorization callback is not set. </td></tr>
  288. <tr><td class="paramname">TSS2_FAPI_RC_AUTHORIZATION_FAILED</td><td>if the authorization attempt fails. </td></tr>
  289. <tr><td class="paramname">TSS2_FAPI_RC_POLICY_UNKNOWN</td><td>if policy search for a certain policy digest was not successful. </td></tr>
  290. <tr><td class="paramname">TSS2_ESYS_RC_*</td><td>possible error codes of ESAPI. </td></tr>
  291. <tr><td class="paramname">TSS2_FAPI_RC_NOT_PROVISIONED</td><td>FAPI was not provisioned. </td></tr>
  292. <tr><td class="paramname">TSS2_FAPI_RC_PATH_ALREADY_EXISTS</td><td>if the object already exists in object store. </td></tr>
  293. </table>
  294. </dd>
  295. </dl>
  296. </div>
  297. </div>
  298. </div><!-- contents -->
  299. </div><!-- doc-content -->
  300. <!-- start footer part -->
  301. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  302. <ul>
  303. <li class="footer">Generated by
  304. <a href="http://www.doxygen.org/index.html">
  305. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  306. </ul>
  307. </div>
  308. </body>
  309. </html>