Gilles Peskine | 89f0a53 | 2019-01-31 11:47:57 +0100 | [diff] [blame] | 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.11"/> |
| 7 | <title>Platform Security Architecture — cryptography and keystore interface: Key management</title> |
| 8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 9 | <script type="text/javascript" src="jquery.js"></script> |
| 10 | <script type="text/javascript" src="dynsections.js"></script> |
| 11 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 12 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 13 | <script type="text/javascript" src="search/search.js"></script> |
| 14 | <script type="text/javascript"> |
| 15 | $(document).ready(function() { init_search(); }); |
| 16 | </script> |
| 17 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 18 | </head> |
| 19 | <body> |
| 20 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 21 | <div id="titlearea"> |
| 22 | <table cellspacing="0" cellpadding="0"> |
| 23 | <tbody> |
| 24 | <tr style="height: 56px;"> |
| 25 | <td id="projectalign" style="padding-left: 0.5em;"> |
| 26 | <div id="projectname">Platform Security Architecture — cryptography and keystore interface |
| 27 |  <span id="projectnumber">beta 1 — 2019-01-21</span> |
| 28 | </div> |
| 29 | </td> |
| 30 | </tr> |
| 31 | </tbody> |
| 32 | </table> |
| 33 | </div> |
| 34 | <!-- end header part --> |
| 35 | <!-- Generated by Doxygen 1.8.11 --> |
| 36 | <script type="text/javascript"> |
| 37 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 38 | </script> |
| 39 | <div id="navrow1" class="tabs"> |
| 40 | <ul class="tablist"> |
| 41 | <li><a href="index.html"><span>Main Page</span></a></li> |
| 42 | <li class="current"><a href="modules.html"><span>Modules</span></a></li> |
| 43 | <li><a href="annotated.html"><span>Classes</span></a></li> |
| 44 | <li><a href="files.html"><span>Files</span></a></li> |
| 45 | <li> |
| 46 | <div id="MSearchBox" class="MSearchBoxInactive"> |
| 47 | <span class="left"> |
| 48 | <img id="MSearchSelect" src="search/mag_sel.png" |
| 49 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 50 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 51 | alt=""/> |
| 52 | <input type="text" id="MSearchField" value="Search" accesskey="S" |
| 53 | onfocus="searchBox.OnSearchFieldFocus(true)" |
| 54 | onblur="searchBox.OnSearchFieldFocus(false)" |
| 55 | onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| 56 | </span><span class="right"> |
| 57 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| 58 | </span> |
| 59 | </div> |
| 60 | </li> |
| 61 | </ul> |
| 62 | </div> |
| 63 | </div><!-- top --> |
| 64 | <!-- window showing the filter options --> |
| 65 | <div id="MSearchSelectWindow" |
| 66 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 67 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 68 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 69 | </div> |
| 70 | |
| 71 | <!-- iframe showing the search results (closed by default) --> |
| 72 | <div id="MSearchResultsWindow"> |
| 73 | <iframe src="javascript:void(0)" frameborder="0" |
| 74 | name="MSearchResults" id="MSearchResults"> |
| 75 | </iframe> |
| 76 | </div> |
| 77 | |
| 78 | <div class="header"> |
| 79 | <div class="summary"> |
| 80 | <a href="#func-members">Functions</a> </div> |
| 81 | <div class="headertitle"> |
| 82 | <div class="title">Key management</div> </div> |
| 83 | </div><!--header--> |
| 84 | <div class="contents"> |
| 85 | <table class="memberdecls"> |
| 86 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| 87 | Functions</h2></td></tr> |
| 88 | <tr class="memitem:ga1e4825ab59260aeb3bdbb3ff07210022"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__key__management.html#ga1e4825ab59260aeb3bdbb3ff07210022">psa_get_key_lifetime</a> (<a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> handle, <a class="el" href="group__key__lifetimes.html#ga6821ff6dd39dc2bc370ded760ad8b0cf">psa_key_lifetime_t</a> *lifetime)</td></tr> |
| 89 | <tr class="memdesc:ga1e4825ab59260aeb3bdbb3ff07210022"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the lifetime of an open key. <a href="#ga1e4825ab59260aeb3bdbb3ff07210022">More...</a><br /></td></tr> |
| 90 | <tr class="separator:ga1e4825ab59260aeb3bdbb3ff07210022"><td class="memSeparator" colspan="2"> </td></tr> |
| 91 | <tr class="memitem:ga40094b77b7a42b9c8e158395113f1a35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__key__management.html#ga40094b77b7a42b9c8e158395113f1a35">psa_allocate_key</a> (<a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> *handle)</td></tr> |
| 92 | <tr class="separator:ga40094b77b7a42b9c8e158395113f1a35"><td class="memSeparator" colspan="2"> </td></tr> |
| 93 | <tr class="memitem:gaa9f1c848cf78b80fe2a7b18bb7ccec50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__key__management.html#gaa9f1c848cf78b80fe2a7b18bb7ccec50">psa_open_key</a> (<a class="el" href="group__key__lifetimes.html#ga6821ff6dd39dc2bc370ded760ad8b0cf">psa_key_lifetime_t</a> lifetime, <a class="el" href="group__key__lifetimes.html#ga11e986351c65bd3dc3c0fe2cd9926e4b">psa_key_id_t</a> id, <a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> *handle)</td></tr> |
| 94 | <tr class="separator:gaa9f1c848cf78b80fe2a7b18bb7ccec50"><td class="memSeparator" colspan="2"> </td></tr> |
| 95 | <tr class="memitem:ga4108f255d3eaa6d23a7a14b684af8d7c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__key__management.html#ga4108f255d3eaa6d23a7a14b684af8d7c">psa_create_key</a> (<a class="el" href="group__key__lifetimes.html#ga6821ff6dd39dc2bc370ded760ad8b0cf">psa_key_lifetime_t</a> lifetime, <a class="el" href="group__key__lifetimes.html#ga11e986351c65bd3dc3c0fe2cd9926e4b">psa_key_id_t</a> id, <a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> *handle)</td></tr> |
| 96 | <tr class="separator:ga4108f255d3eaa6d23a7a14b684af8d7c"><td class="memSeparator" colspan="2"> </td></tr> |
| 97 | <tr class="memitem:gaa09b720d299dfe6b9f41c36e448078eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__key__management.html#gaa09b720d299dfe6b9f41c36e448078eb">psa_close_key</a> (<a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> handle)</td></tr> |
| 98 | <tr class="separator:gaa09b720d299dfe6b9f41c36e448078eb"><td class="memSeparator" colspan="2"> </td></tr> |
| 99 | </table> |
| 100 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 101 | <h2 class="groupheader">Function Documentation</h2> |
| 102 | <a class="anchor" id="ga40094b77b7a42b9c8e158395113f1a35"></a> |
| 103 | <div class="memitem"> |
| 104 | <div class="memproto"> |
| 105 | <table class="memname"> |
| 106 | <tr> |
| 107 | <td class="memname"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> psa_allocate_key </td> |
| 108 | <td>(</td> |
| 109 | <td class="paramtype"><a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> * </td> |
| 110 | <td class="paramname"><em>handle</em></td><td>)</td> |
| 111 | <td></td> |
| 112 | </tr> |
| 113 | </table> |
| 114 | </div><div class="memdoc"> |
| 115 | <p>Allocate a key slot for a transient key, i.e. a key which is only stored in volatile memory.</p> |
| 116 | <p>The allocated key slot and its handle remain valid until the application calls <a class="el" href="group__key__management.html#gaa09b720d299dfe6b9f41c36e448078eb">psa_close_key()</a> or <a class="el" href="group__import__export.html#ga165085fc1bc7a78b91792fdd94ae102c" title="Destroy a key. ">psa_destroy_key()</a> or until the application terminates.</p> |
| 117 | <dl class="params"><dt>Parameters</dt><dd> |
| 118 | <table class="params"> |
| 119 | <tr><td class="paramdir">[out]</td><td class="paramname">handle</td><td>On success, a handle to a volatile key slot.</td></tr> |
| 120 | </table> |
| 121 | </dd> |
| 122 | </dl> |
| 123 | <dl class="retval"><dt>Return values</dt><dd> |
| 124 | <table class="retval"> |
| 125 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4cc859e2c66ca381c7418db3527a65e1">PSA_SUCCESS</a></td><td>Success. The application can now use the value of <code>*handle</code> to access the newly allocated key slot. </td></tr> |
| 126 | <tr><td class="paramname"><a class="el" href="group__error.html#ga91b2ad8a867517a2651f1b076c5216e5">PSA_ERROR_INSUFFICIENT_MEMORY</a></td><td>There was not enough memory, or the maximum number of key slots has been reached. </td></tr> |
| 127 | </table> |
| 128 | </dd> |
| 129 | </dl> |
| 130 | |
| 131 | </div> |
| 132 | </div> |
| 133 | <a class="anchor" id="gaa09b720d299dfe6b9f41c36e448078eb"></a> |
| 134 | <div class="memitem"> |
| 135 | <div class="memproto"> |
| 136 | <table class="memname"> |
| 137 | <tr> |
| 138 | <td class="memname"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> psa_close_key </td> |
| 139 | <td>(</td> |
| 140 | <td class="paramtype"><a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> </td> |
| 141 | <td class="paramname"><em>handle</em></td><td>)</td> |
| 142 | <td></td> |
| 143 | </tr> |
| 144 | </table> |
| 145 | </div><div class="memdoc"> |
| 146 | <p>Close a key handle.</p> |
| 147 | <p>If the handle designates a volatile key, destroy the key material and free all associated resources, just like <a class="el" href="group__import__export.html#ga165085fc1bc7a78b91792fdd94ae102c" title="Destroy a key. ">psa_destroy_key()</a>.</p> |
| 148 | <p>If the handle designates a persistent key, free all resources associated with the key in volatile memory. The key slot in persistent storage is not affected and can be opened again later with <a class="el" href="group__key__management.html#gaa9f1c848cf78b80fe2a7b18bb7ccec50">psa_open_key()</a>.</p> |
| 149 | <p>If the key is currently in use in a multipart operation, the multipart operation is aborted.</p> |
| 150 | <dl class="params"><dt>Parameters</dt><dd> |
| 151 | <table class="params"> |
| 152 | <tr><td class="paramname">handle</td><td>The key handle to close.</td></tr> |
| 153 | </table> |
| 154 | </dd> |
| 155 | </dl> |
| 156 | <dl class="retval"><dt>Return values</dt><dd> |
| 157 | <table class="retval"> |
| 158 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4cc859e2c66ca381c7418db3527a65e1">PSA_SUCCESS</a></td><td></td></tr> |
| 159 | <tr><td class="paramname"><a class="el" href="group__error.html#gadf22718935657c2c3168c228204085f9">PSA_ERROR_INVALID_HANDLE</a></td><td></td></tr> |
| 160 | <tr><td class="paramname"><a class="el" href="group__error.html#ga5cdb6948371d49e916106249020ea3f7">PSA_ERROR_COMMUNICATION_FAILURE</a></td><td></td></tr> |
| 161 | </table> |
| 162 | </dd> |
| 163 | </dl> |
| 164 | |
| 165 | </div> |
| 166 | </div> |
| 167 | <a class="anchor" id="ga4108f255d3eaa6d23a7a14b684af8d7c"></a> |
| 168 | <div class="memitem"> |
| 169 | <div class="memproto"> |
| 170 | <table class="memname"> |
| 171 | <tr> |
| 172 | <td class="memname"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> psa_create_key </td> |
| 173 | <td>(</td> |
| 174 | <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga6821ff6dd39dc2bc370ded760ad8b0cf">psa_key_lifetime_t</a> </td> |
| 175 | <td class="paramname"><em>lifetime</em>, </td> |
| 176 | </tr> |
| 177 | <tr> |
| 178 | <td class="paramkey"></td> |
| 179 | <td></td> |
| 180 | <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga11e986351c65bd3dc3c0fe2cd9926e4b">psa_key_id_t</a> </td> |
| 181 | <td class="paramname"><em>id</em>, </td> |
| 182 | </tr> |
| 183 | <tr> |
| 184 | <td class="paramkey"></td> |
| 185 | <td></td> |
| 186 | <td class="paramtype"><a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> * </td> |
| 187 | <td class="paramname"><em>handle</em> </td> |
| 188 | </tr> |
| 189 | <tr> |
| 190 | <td></td> |
| 191 | <td>)</td> |
| 192 | <td></td><td></td> |
| 193 | </tr> |
| 194 | </table> |
| 195 | </div><div class="memdoc"> |
| 196 | <p>Create a new persistent key slot.</p> |
| 197 | <p>Create a new persistent key slot and return a handle to it. The handle remains valid until the application calls <a class="el" href="group__key__management.html#gaa09b720d299dfe6b9f41c36e448078eb">psa_close_key()</a> or terminates. The application can open the key again with <a class="el" href="group__key__management.html#gaa9f1c848cf78b80fe2a7b18bb7ccec50">psa_open_key()</a> until it removes the key by calling <a class="el" href="group__import__export.html#ga165085fc1bc7a78b91792fdd94ae102c" title="Destroy a key. ">psa_destroy_key()</a>.</p> |
| 198 | <dl class="params"><dt>Parameters</dt><dd> |
| 199 | <table class="params"> |
| 200 | <tr><td class="paramdir"></td><td class="paramname">lifetime</td><td>The lifetime of the key. This designates a storage area where the key material is stored. This must not be <a class="el" href="group__key__lifetimes.html#ga8b438870ba69489b685730d346455108">PSA_KEY_LIFETIME_VOLATILE</a>. </td></tr> |
| 201 | <tr><td class="paramdir"></td><td class="paramname">id</td><td>The persistent identifier of the key. </td></tr> |
| 202 | <tr><td class="paramdir">[out]</td><td class="paramname">handle</td><td>On success, a handle to the newly created key slot. When key material is later created in this key slot, it will be saved to the specified persistent location.</td></tr> |
| 203 | </table> |
| 204 | </dd> |
| 205 | </dl> |
| 206 | <dl class="retval"><dt>Return values</dt><dd> |
| 207 | <table class="retval"> |
| 208 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4cc859e2c66ca381c7418db3527a65e1">PSA_SUCCESS</a></td><td>Success. The application can now use the value of <code>*handle</code> to access the newly allocated key slot. </td></tr> |
| 209 | <tr><td class="paramname"><a class="el" href="group__error.html#ga91b2ad8a867517a2651f1b076c5216e5">PSA_ERROR_INSUFFICIENT_MEMORY</a></td><td></td></tr> |
| 210 | <tr><td class="paramname"><a class="el" href="group__error.html#ga897a45eb206a6f6b7be7ffbe36f0d766">PSA_ERROR_INSUFFICIENT_STORAGE</a></td><td></td></tr> |
| 211 | <tr><td class="paramname"><a class="el" href="group__error.html#gac2fee3a51249fbea45360aaa911f3e58">PSA_ERROR_OCCUPIED_SLOT</a></td><td>There is already a key with the identifier <code>id</code> in the storage area designated by <code>lifetime</code>. </td></tr> |
| 212 | <tr><td class="paramname"><a class="el" href="group__error.html#ga798df25a505ebf931f7bec1f80f1f85f">PSA_ERROR_INVALID_ARGUMENT</a></td><td><code>lifetime</code> is invalid, for example <a class="el" href="group__key__lifetimes.html#ga8b438870ba69489b685730d346455108">PSA_KEY_LIFETIME_VOLATILE</a>. </td></tr> |
| 213 | <tr><td class="paramname"><a class="el" href="group__error.html#ga798df25a505ebf931f7bec1f80f1f85f">PSA_ERROR_INVALID_ARGUMENT</a></td><td><code>id</code> is invalid for the specified lifetime. </td></tr> |
| 214 | <tr><td class="paramname"><a class="el" href="group__error.html#ga1dcc6d130633ed5db8942257581b55dd">PSA_ERROR_NOT_SUPPORTED</a></td><td><code>lifetime</code> is not supported. </td></tr> |
| 215 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4d1b8dd8526177a15a210b7afc1accb1">PSA_ERROR_NOT_PERMITTED</a></td><td><code>lifetime</code> is valid, but the application does not have the permission to create a key there. </td></tr> |
| 216 | </table> |
| 217 | </dd> |
| 218 | </dl> |
| 219 | |
| 220 | </div> |
| 221 | </div> |
| 222 | <a class="anchor" id="ga1e4825ab59260aeb3bdbb3ff07210022"></a> |
| 223 | <div class="memitem"> |
| 224 | <div class="memproto"> |
| 225 | <table class="memname"> |
| 226 | <tr> |
| 227 | <td class="memname"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> psa_get_key_lifetime </td> |
| 228 | <td>(</td> |
| 229 | <td class="paramtype"><a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> </td> |
| 230 | <td class="paramname"><em>handle</em>, </td> |
| 231 | </tr> |
| 232 | <tr> |
| 233 | <td class="paramkey"></td> |
| 234 | <td></td> |
| 235 | <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga6821ff6dd39dc2bc370ded760ad8b0cf">psa_key_lifetime_t</a> * </td> |
| 236 | <td class="paramname"><em>lifetime</em> </td> |
| 237 | </tr> |
| 238 | <tr> |
| 239 | <td></td> |
| 240 | <td>)</td> |
| 241 | <td></td><td></td> |
| 242 | </tr> |
| 243 | </table> |
| 244 | </div><div class="memdoc"> |
| 245 | |
| 246 | <p>Retrieve the lifetime of an open key. </p> |
| 247 | <dl class="params"><dt>Parameters</dt><dd> |
| 248 | <table class="params"> |
| 249 | <tr><td class="paramdir"></td><td class="paramname">handle</td><td>Handle to query. </td></tr> |
| 250 | <tr><td class="paramdir">[out]</td><td class="paramname">lifetime</td><td>On success, the lifetime value.</td></tr> |
| 251 | </table> |
| 252 | </dd> |
| 253 | </dl> |
| 254 | <dl class="retval"><dt>Return values</dt><dd> |
| 255 | <table class="retval"> |
| 256 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4cc859e2c66ca381c7418db3527a65e1">PSA_SUCCESS</a></td><td>Success. </td></tr> |
| 257 | <tr><td class="paramname"><a class="el" href="group__error.html#gadf22718935657c2c3168c228204085f9">PSA_ERROR_INVALID_HANDLE</a></td><td></td></tr> |
| 258 | <tr><td class="paramname"><a class="el" href="group__error.html#ga5cdb6948371d49e916106249020ea3f7">PSA_ERROR_COMMUNICATION_FAILURE</a></td><td></td></tr> |
| 259 | <tr><td class="paramname"><a class="el" href="group__error.html#ga08b10e70fa5ff0b05c631d9f8f6b2c6b">PSA_ERROR_HARDWARE_FAILURE</a></td><td></td></tr> |
| 260 | <tr><td class="paramname"><a class="el" href="group__error.html#ga2c5dda1485cb54f2385cb9c1279a7004">PSA_ERROR_TAMPERING_DETECTED</a></td><td></td></tr> |
| 261 | <tr><td class="paramname"><a class="el" href="group__error.html#ga933d40fa2a591004f2e93aa91e11db84">PSA_ERROR_BAD_STATE</a></td><td>The library has not been previously initialized by <a class="el" href="group__initialization.html#ga2de150803fc2f7dc6101d5af7e921dd9" title="Library initialization. ">psa_crypto_init()</a>. It is implementation-dependent whether a failure to initialize results in this error code. </td></tr> |
| 262 | </table> |
| 263 | </dd> |
| 264 | </dl> |
| 265 | |
| 266 | </div> |
| 267 | </div> |
| 268 | <a class="anchor" id="gaa9f1c848cf78b80fe2a7b18bb7ccec50"></a> |
| 269 | <div class="memitem"> |
| 270 | <div class="memproto"> |
| 271 | <table class="memname"> |
| 272 | <tr> |
| 273 | <td class="memname"><a class="el" href="group__error.html#ga05676e70ba5c6a7565aff3c36677c1f9">psa_status_t</a> psa_open_key </td> |
| 274 | <td>(</td> |
| 275 | <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga6821ff6dd39dc2bc370ded760ad8b0cf">psa_key_lifetime_t</a> </td> |
| 276 | <td class="paramname"><em>lifetime</em>, </td> |
| 277 | </tr> |
| 278 | <tr> |
| 279 | <td class="paramkey"></td> |
| 280 | <td></td> |
| 281 | <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga11e986351c65bd3dc3c0fe2cd9926e4b">psa_key_id_t</a> </td> |
| 282 | <td class="paramname"><em>id</em>, </td> |
| 283 | </tr> |
| 284 | <tr> |
| 285 | <td class="paramkey"></td> |
| 286 | <td></td> |
| 287 | <td class="paramtype"><a class="el" href="group__platform.html#gabf6d5fd4e2ea89ecd425c88f057e7f75">psa_key_handle_t</a> * </td> |
| 288 | <td class="paramname"><em>handle</em> </td> |
| 289 | </tr> |
| 290 | <tr> |
| 291 | <td></td> |
| 292 | <td>)</td> |
| 293 | <td></td><td></td> |
| 294 | </tr> |
| 295 | </table> |
| 296 | </div><div class="memdoc"> |
| 297 | <p>Open a handle to an existing persistent key.</p> |
| 298 | <p>Open a handle to a key which was previously created with <a class="el" href="group__key__management.html#ga4108f255d3eaa6d23a7a14b684af8d7c">psa_create_key()</a>.</p> |
| 299 | <dl class="params"><dt>Parameters</dt><dd> |
| 300 | <table class="params"> |
| 301 | <tr><td class="paramdir"></td><td class="paramname">lifetime</td><td>The lifetime of the key. This designates a storage area where the key material is stored. This must not be <a class="el" href="group__key__lifetimes.html#ga8b438870ba69489b685730d346455108">PSA_KEY_LIFETIME_VOLATILE</a>. </td></tr> |
| 302 | <tr><td class="paramdir"></td><td class="paramname">id</td><td>The persistent identifier of the key. </td></tr> |
| 303 | <tr><td class="paramdir">[out]</td><td class="paramname">handle</td><td>On success, a handle to a key slot which contains the data and metadata loaded from the specified persistent location.</td></tr> |
| 304 | </table> |
| 305 | </dd> |
| 306 | </dl> |
| 307 | <dl class="retval"><dt>Return values</dt><dd> |
| 308 | <table class="retval"> |
| 309 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4cc859e2c66ca381c7418db3527a65e1">PSA_SUCCESS</a></td><td>Success. The application can now use the value of <code>*handle</code> to access the newly allocated key slot. </td></tr> |
| 310 | <tr><td class="paramname"><a class="el" href="group__error.html#ga91b2ad8a867517a2651f1b076c5216e5">PSA_ERROR_INSUFFICIENT_MEMORY</a></td><td></td></tr> |
| 311 | <tr><td class="paramname"><a class="el" href="group__error.html#gaba00e3e6ceb2b12965a81e5ac02ae040">PSA_ERROR_EMPTY_SLOT</a></td><td></td></tr> |
| 312 | <tr><td class="paramname"><a class="el" href="group__error.html#ga798df25a505ebf931f7bec1f80f1f85f">PSA_ERROR_INVALID_ARGUMENT</a></td><td><code>lifetime</code> is invalid, for example <a class="el" href="group__key__lifetimes.html#ga8b438870ba69489b685730d346455108">PSA_KEY_LIFETIME_VOLATILE</a>. </td></tr> |
| 313 | <tr><td class="paramname"><a class="el" href="group__error.html#ga798df25a505ebf931f7bec1f80f1f85f">PSA_ERROR_INVALID_ARGUMENT</a></td><td><code>id</code> is invalid for the specified lifetime. </td></tr> |
| 314 | <tr><td class="paramname"><a class="el" href="group__error.html#ga1dcc6d130633ed5db8942257581b55dd">PSA_ERROR_NOT_SUPPORTED</a></td><td><code>lifetime</code> is not supported. </td></tr> |
| 315 | <tr><td class="paramname"><a class="el" href="group__error.html#ga4d1b8dd8526177a15a210b7afc1accb1">PSA_ERROR_NOT_PERMITTED</a></td><td>The specified key exists, but the application does not have the permission to access it. Note that this specification does not define any way to create such a key, but it may be possible through implementation-specific means. </td></tr> |
| 316 | </table> |
| 317 | </dd> |
| 318 | </dl> |
| 319 | |
| 320 | </div> |
| 321 | </div> |
| 322 | </div><!-- contents --> |
| 323 | <!-- start footer part --> |
| 324 | <hr class="footer"/><address class="footer"><small> |
| 325 | Generated by  <a href="http://www.doxygen.org/index.html"> |
| 326 | <img class="footer" src="doxygen.png" alt="doxygen"/> |
| 327 | </a> 1.8.11 |
| 328 | </small></address> |
| 329 | </body> |
| 330 | </html> |