Página inicial Explorar Ajuda
Entrar
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Arquivos Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
csu3_am335x
/
EVSE
/
GPL
/
tpm2-tss-3.2.0
/
doxygen-doc
/
html
/
group___esys___activate_credential.html

group___esys___activate_credential.html 21 KB
Link permanente Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341 
  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_ActivateCredential 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___activate_credential.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_ActivateCredential 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:ga394cfa83fd9c5a976279d2693123d2ad"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___activate_credential.html#ga394cfa83fd9c5a976279d2693123d2ad">Esys_ActivateCredential_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> activateHandle, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> keyHandle, <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_ID_OBJECT *credentialBlob, const TPM2B_ENCRYPTED_SECRET *secret)</td></tr>
    73. 

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

  74. <tr class="memitem:gab5628aad7be38ff70246510ea6c04c3c"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___activate_credential.html#gab5628aad7be38ff70246510ea6c04c3c">Esys_ActivateCredential</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> activateHandle, <a class="el" href="group___e_s_y_s___t_r.html#ga65d10db3b0b31fcd709e692f1545d30f">ESYS_TR</a> keyHandle, <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_ID_OBJECT *credentialBlob, const TPM2B_ENCRYPTED_SECRET *secret, TPM2B_DIGEST **certInfo)</td></tr>
    75. 

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

  76. <tr class="memitem:ga16caad452149431f2bf7a57aebad0108"><td class="memItemLeft" align="right" valign="top">TSS2_RC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___esys___activate_credential.html#ga16caad452149431f2bf7a57aebad0108">Esys_ActivateCredential_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_DIGEST **certInfo)</td></tr>
    77. 

  77. <tr class="separator:ga16caad452149431f2bf7a57aebad0108"><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_ActivateCredential command either as a one-call or in an asynchronous manner. </p>
    81. 

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

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

  83. <h2 class="memtitle"><span class="permalink"><a href="#gab5628aad7be38ff70246510ea6c04c3c">&#9670;&nbsp;</a></span>Esys_ActivateCredential()</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_ActivateCredential </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>activateHandle</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>keyHandle</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_ID_OBJECT *&#160;</td>
    128. 

  128.           <td class="paramname"><em>credentialBlob</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_ENCRYPTED_SECRET *&#160;</td>
    134. 

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

  135.         </tr>
    136. 

  136.         <tr>
    137. 

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

  138.           <td></td>
    139. 

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

  140.           <td class="paramname"><em>certInfo</em>&#160;</td>
    141. 

  141.         </tr>
    142. 

  142.         <tr>
    143. 

  143.           <td></td>
    144. 

  144.           <td>)</td>
    145. 

  145.           <td></td><td></td>
    146. 

  146.         </tr>
    147. 

  147.       </table>
    148. 

  148. </div><div class="memdoc">
    149. 

  149. <p>One-Call function for TPM2_ActivateCredential</p>
    150. 

  150. <p>This function invokes the TPM2_ActivateCredential 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>
    151. 

  151. <dl class="params"><dt>Parameters</dt><dd>
    152. 

  152.   <table class="params">
    153. 

  153.     <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>
    154. 

  154.     <tr><td class="paramdir">[in]</td><td class="paramname">activateHandle</td><td>Handle of the object associated with certificate in credentialBlob. </td></tr>
    155. 

  155.     <tr><td class="paramdir">[in]</td><td class="paramname">keyHandle</td><td>Loaded key used to decrypt the TPMS_SENSITIVE in credentialBlob. </td></tr>
    156. 

  156.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle1</td><td>Session handle for authorization of activateHandle </td></tr>
    157. 

  157.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle2</td><td>Session handle for authorization of keyHandle </td></tr>
    158. 

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

  159.     <tr><td class="paramdir">[in]</td><td class="paramname">credentialBlob</td><td>The credential. </td></tr>
    160. 

  160.     <tr><td class="paramdir">[in]</td><td class="paramname">secret</td><td>KeyHandle algorithm-dependent encrypted seed that protects credentialBlob. </td></tr>
    161. 

  161.     <tr><td class="paramdir">[out]</td><td class="paramname">certInfo</td><td>The decrypted certificate information. (callee-allocated) </td></tr>
    162. 

  162.   </table>
    163. 

  163.   </dd>
    164. 

  164. </dl>
    165. 

  165. <dl class="retval"><dt>Return values</dt><dd>
    166. 

  166.   <table class="retval">
    167. 

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

  168.     <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>
    169. 

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

  170.     <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>
    171. 

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

  172.     <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>
    173. 

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

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

  175.     <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>
    176. 

  176.     <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>
    177. 

  177.     <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>
    178. 

  178.     <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>
    179. 

  179.   </table>
    180. 

  180.   </dd>
    181. 

  181. </dl>
    182. 

  182. 

  183. </div>
    184. 

  184. </div>
    185. 

  185. <a id="ga394cfa83fd9c5a976279d2693123d2ad"></a>
    186. 

  186. <h2 class="memtitle"><span class="permalink"><a href="#ga394cfa83fd9c5a976279d2693123d2ad">&#9670;&nbsp;</a></span>Esys_ActivateCredential_Async()</h2>
    187. 

  187. 

  188. <div class="memitem">
    189. 

  189. <div class="memproto">
    190. 

  190.       <table class="memname">
    191. 

  191.         <tr>
    192. 

  192.           <td class="memname">TSS2_RC Esys_ActivateCredential_Async </td>
    193. 

  193.           <td>(</td>
    194. 

  194.           <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>
    195. 

  195.           <td class="paramname"><em>esysContext</em>, </td>
    196. 

  196.         </tr>
    197. 

  197.         <tr>
    198. 

  198.           <td class="paramkey"></td>
    199. 

  199.           <td></td>
    200. 

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

  201.           <td class="paramname"><em>activateHandle</em>, </td>
    202. 

  202.         </tr>
    203. 

  203.         <tr>
    204. 

  204.           <td class="paramkey"></td>
    205. 

  205.           <td></td>
    206. 

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

  207.           <td class="paramname"><em>keyHandle</em>, </td>
    208. 

  208.         </tr>
    209. 

  209.         <tr>
    210. 

  210.           <td class="paramkey"></td>
    211. 

  211.           <td></td>
    212. 

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

  213.           <td class="paramname"><em>shandle1</em>, </td>
    214. 

  214.         </tr>
    215. 

  215.         <tr>
    216. 

  216.           <td class="paramkey"></td>
    217. 

  217.           <td></td>
    218. 

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

  219.           <td class="paramname"><em>shandle2</em>, </td>
    220. 

  220.         </tr>
    221. 

  221.         <tr>
    222. 

  222.           <td class="paramkey"></td>
    223. 

  223.           <td></td>
    224. 

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

  225.           <td class="paramname"><em>shandle3</em>, </td>
    226. 

  226.         </tr>
    227. 

  227.         <tr>
    228. 

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

  229.           <td></td>
    230. 

  230.           <td class="paramtype">const TPM2B_ID_OBJECT *&#160;</td>
    231. 

  231.           <td class="paramname"><em>credentialBlob</em>, </td>
    232. 

  232.         </tr>
    233. 

  233.         <tr>
    234. 

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

  235.           <td></td>
    236. 

  236.           <td class="paramtype">const TPM2B_ENCRYPTED_SECRET *&#160;</td>
    237. 

  237.           <td class="paramname"><em>secret</em>&#160;</td>
    238. 

  238.         </tr>
    239. 

  239.         <tr>
    240. 

  240.           <td></td>
    241. 

  241.           <td>)</td>
    242. 

  242.           <td></td><td></td>
    243. 

  243.         </tr>
    244. 

  244.       </table>
    245. 

  245. </div><div class="memdoc">
    246. 

  246. <p>Asynchronous function for TPM2_ActivateCredential</p>
    247. 

  247. <p>This function invokes the TPM2_ActivateCredential 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_ActivateCredential_Finish.</p>
    248. 

  248. <dl class="params"><dt>Parameters</dt><dd>
    249. 

  249.   <table class="params">
    250. 

  250.     <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>
    251. 

  251.     <tr><td class="paramdir">[in]</td><td class="paramname">activateHandle</td><td>Handle of the object associated with certificate in credentialBlob. </td></tr>
    252. 

  252.     <tr><td class="paramdir">[in]</td><td class="paramname">keyHandle</td><td>Loaded key used to decrypt the TPMS_SENSITIVE in credentialBlob. </td></tr>
    253. 

  253.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle1</td><td>Session handle for authorization of activateHandle </td></tr>
    254. 

  254.     <tr><td class="paramdir">[in]</td><td class="paramname">shandle2</td><td>Session handle for authorization of keyHandle </td></tr>
    255. 

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

  256.     <tr><td class="paramdir">[in]</td><td class="paramname">credentialBlob</td><td>The credential. </td></tr>
    257. 

  257.     <tr><td class="paramdir">[in]</td><td class="paramname">secret</td><td>KeyHandle algorithm-dependent encrypted seed that protects credentialBlob. </td></tr>
    258. 

  258.   </table>
    259. 

  259.   </dd>
    260. 

  260. </dl>
    261. 

  261. <dl class="retval"><dt>Return values</dt><dd>
    262. 

  262.   <table class="retval">
    263. 

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

  264.     <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>
    265. 

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

  266.     <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>
    267. 

  267.     <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>
    268. 

  268.     <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>
    269. 

  269.     <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>
    270. 

  270.     <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>
    271. 

  271.   </table>
    272. 

  272.   </dd>
    273. 

  273. </dl>
    274. 

  274. 

  275. </div>
    276. 

  276. </div>
    277. 

  277. <a id="ga16caad452149431f2bf7a57aebad0108"></a>
    278. 

  278. <h2 class="memtitle"><span class="permalink"><a href="#ga16caad452149431f2bf7a57aebad0108">&#9670;&nbsp;</a></span>Esys_ActivateCredential_Finish()</h2>
    279. 

  279. 

  280. <div class="memitem">
    281. 

  281. <div class="memproto">
    282. 

  282.       <table class="memname">
    283. 

  283.         <tr>
    284. 

  284.           <td class="memname">TSS2_RC Esys_ActivateCredential_Finish </td>
    285. 

  285.           <td>(</td>
    286. 

  286.           <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>
    287. 

  287.           <td class="paramname"><em>esysContext</em>, </td>
    288. 

  288.         </tr>
    289. 

  289.         <tr>
    290. 

  290.           <td class="paramkey"></td>
    291. 

  291.           <td></td>
    292. 

  292.           <td class="paramtype">TPM2B_DIGEST **&#160;</td>
    293. 

  293.           <td class="paramname"><em>certInfo</em>&#160;</td>
    294. 

  294.         </tr>
    295. 

  295.         <tr>
    296. 

  296.           <td></td>
    297. 

  297.           <td>)</td>
    298. 

  298.           <td></td><td></td>
    299. 

  299.         </tr>
    300. 

  300.       </table>
    301. 

  301. </div><div class="memdoc">
    302. 

  302. <p>Asynchronous finish function for TPM2_ActivateCredential</p>
    303. 

  303. <p>This function returns the results of a TPM2_ActivateCredential command invoked via Esys_ActivateCredential_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>
    304. 

  304. <dl class="params"><dt>Parameters</dt><dd>
    305. 

  305.   <table class="params">
    306. 

  306.     <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>
    307. 

  307.     <tr><td class="paramdir">[out]</td><td class="paramname">certInfo</td><td>The decrypted certificate information. (callee-allocated) </td></tr>
    308. 

  308.   </table>
    309. 

  309.   </dd>
    310. 

  310. </dl>
    311. 

  311. <dl class="retval"><dt>Return values</dt><dd>
    312. 

  312.   <table class="retval">
    313. 

  313.     <tr><td class="paramname">TSS2_RC_SUCCESS</td><td>on success </td></tr>
    314. 

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

  315.     <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>
    316. 

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

  317.     <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>
    318. 

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

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

  320.     <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>
    321. 

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

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

  323.     <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>
    324. 

  324.   </table>
    325. 

  325.   </dd>
    326. 

  326. </dl>
    327. 

  327. 

  328. </div>
    329. 

  329. </div>
    330. 

  330. </div><!-- contents -->
    331. 

  331. </div><!-- doc-content -->
    332. 

  332. <!-- start footer part -->
    333. 

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

  334.   <ul>
    335. 

  335.     <li class="footer">Generated by
    336. 

  336.     <a href="http://www.doxygen.org/index.html">
    337. 

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

  338.   </ul>
    339. 

  339. </div>
    340. 

  340. </body>
    341. 

  341. </html>
    342.