Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
p64_utils/docs/p64_utils_api_reference_manual/html/group__attributes.html
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
890 lines (829 sloc)
53.2 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!-- HTML header for doxygen 1.8.13--> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> | |
| <meta name="generator" content="Doxygen 1.8.13"/> | |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | |
| <title>PSoC64 Secure Boot Utilities Middleware Library 1.0: Key attributes</title> | |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | |
| <script type="text/javascript" src="jquery.js"></script> | |
| <script type="text/javascript" src="dynsections.js"></script> | |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> | |
| <script type="text/javascript" src="resize.js"></script> | |
| <script type="text/javascript" src="navtreedata.js"></script> | |
| <script type="text/javascript" src="navtree.js"></script> | |
| <script type="text/javascript"> | |
| $(document).ready(initResizable); | |
| </script> | |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | |
| <script type="text/javascript" src="search/searchdata.js"></script> | |
| <script type="text/javascript" src="search/search.js"></script> | |
| <link href="doxygen_style.css" rel="stylesheet" type="text/css" /> | |
| </head> | |
| <body> | |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | |
| <div id="titlearea"> | |
| <table cellspacing="0" cellpadding="0"> | |
| <tbody> | |
| <tr style="height: 56px;"> | |
| <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td> | |
| <td id="projectalign" style="padding-left: 0.5em;"> | |
| <div id="projectname">PSoC64 Secure Boot Utilities Middleware Library 1.0</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <!-- end header part --> | |
| <!-- Generated by Doxygen 1.8.13 --> | |
| <script type="text/javascript"> | |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); | |
| </script> | |
| <script type="text/javascript" src="menudata.js"></script> | |
| <script type="text/javascript" src="menu.js"></script> | |
| <script type="text/javascript"> | |
| $(function() { | |
| initMenu('',true,false,'search.php','Search'); | |
| $(document).ready(function() { init_search(); }); | |
| }); | |
| </script> | |
| <div id="main-nav"></div> | |
| </div><!-- top --> | |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> | |
| <div id="nav-tree"> | |
| <div id="nav-tree-contents"> | |
| <div id="nav-sync" class="sync"></div> | |
| </div> | |
| </div> | |
| <div id="splitbar" style="-moz-user-select:none;" | |
| class="ui-resizable-handle"> | |
| </div> | |
| </div> | |
| <script type="text/javascript"> | |
| $(document).ready(function(){initNavTree('group__attributes.html','');}); | |
| </script> | |
| <div id="doc-content"> | |
| <!-- window showing the filter options --> | |
| <div id="MSearchSelectWindow" | |
| onmouseover="return searchBox.OnSearchSelectShow()" | |
| onmouseout="return searchBox.OnSearchSelectHide()" | |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | |
| </div> | |
| <!-- iframe showing the search results (closed by default) --> | |
| <div id="MSearchResultsWindow"> | |
| <iframe src="javascript:void(0)" frameborder="0" | |
| name="MSearchResults" id="MSearchResults"> | |
| </iframe> | |
| </div> | |
| <div class="header"> | |
| <div class="summary"> | |
| <a href="#define-members">Macros</a> | | |
| <a href="#typedef-members">Typedefs</a> | | |
| <a href="#func-members">Functions</a> </div> | |
| <div class="headertitle"> | |
| <div class="title">Key attributes<div class="ingroups"><a class="el" href="group__psacrypto.html">PSA crypto</a></div></div> </div> | |
| </div><!--header--> | |
| <div class="contents"> | |
| <a name="details" id="details"></a><h2 class="groupheader">General Description</h2> | |
| <table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> | |
| Macros</h2></td></tr> | |
| <tr class="memitem:ga249f6524d942d32050e2ecfc31e6c9d5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga249f6524d942d32050e2ecfc31e6c9d5">CY_P64_PSA_KEY_BITS_TOO_LARGE</a>   ( (<a class="el" href="group__attributes.html#ga9834218d0a577f043a7593e949bc9815">cy_p64_psa_key_bits_t</a>) ( -1 ) )</td></tr> | |
| <tr class="memdesc:ga249f6524d942d32050e2ecfc31e6c9d5"><td class="mdescLeft"> </td><td class="mdescRight">The maximum value of the type used to represent bit-sizes. <a href="#ga249f6524d942d32050e2ecfc31e6c9d5">More...</a><br /></td></tr> | |
| <tr class="separator:ga249f6524d942d32050e2ecfc31e6c9d5"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga7f20a20e88cfce65cab7a51439265cc4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga7f20a20e88cfce65cab7a51439265cc4">CY_P64_PSA_MAX_KEY_BITS</a>   0xfff8U</td></tr> | |
| <tr class="memdesc:ga7f20a20e88cfce65cab7a51439265cc4"><td class="mdescLeft"> </td><td class="mdescRight">The maximum size of a key in bits. <a href="#ga7f20a20e88cfce65cab7a51439265cc4">More...</a><br /></td></tr> | |
| <tr class="separator:ga7f20a20e88cfce65cab7a51439265cc4"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gac2778973058b124dbee630b217d70727"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gac2778973058b124dbee630b217d70727">CY_P64_PSA_CORE_KEY_ATTRIBUTES_INIT</a></td></tr> | |
| <tr class="memdesc:gac2778973058b124dbee630b217d70727"><td class="mdescLeft"> </td><td class="mdescRight">The initial value of the core key attributes. <a href="#gac2778973058b124dbee630b217d70727">More...</a><br /></td></tr> | |
| <tr class="separator:gac2778973058b124dbee630b217d70727"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga36da7ed57f918f7393f7c293aea26c36"><td class="memItemLeft" align="right" valign="top"><a id="ga36da7ed57f918f7393f7c293aea26c36"></a> | |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga36da7ed57f918f7393f7c293aea26c36">CY_P64_PSA_KEY_ATTRIBUTES_INIT</a>   { <a class="el" href="group__attributes.html#gac2778973058b124dbee630b217d70727">CY_P64_PSA_CORE_KEY_ATTRIBUTES_INIT</a>, NULL, 0 }</td></tr> | |
| <tr class="memdesc:ga36da7ed57f918f7393f7c293aea26c36"><td class="mdescLeft"> </td><td class="mdescRight">The initial value of the key attributes. <br /></td></tr> | |
| <tr class="separator:ga36da7ed57f918f7393f7c293aea26c36"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table><table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> | |
| Typedefs</h2></td></tr> | |
| <tr class="memitem:ga9834218d0a577f043a7593e949bc9815"><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga9834218d0a577f043a7593e949bc9815">cy_p64_psa_key_bits_t</a></td></tr> | |
| <tr class="memdesc:ga9834218d0a577f043a7593e949bc9815"><td class="mdescLeft"> </td><td class="mdescRight">The type used internally for key sizes. <a href="#ga9834218d0a577f043a7593e949bc9815">More...</a><br /></td></tr> | |
| <tr class="separator:ga9834218d0a577f043a7593e949bc9815"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gadf5a819ed13941e5bc4eb111edeac9eb"><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gadf5a819ed13941e5bc4eb111edeac9eb">cy_p64_psa_key_attributes_flag_t</a></td></tr> | |
| <tr class="memdesc:gadf5a819ed13941e5bc4eb111edeac9eb"><td class="mdescLeft"> </td><td class="mdescRight">A mask of flags that can be stored in key attributes. <a href="#gadf5a819ed13941e5bc4eb111edeac9eb">More...</a><br /></td></tr> | |
| <tr class="separator:gadf5a819ed13941e5bc4eb111edeac9eb"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gaff1087b4ae5d43a3a7aa9a5ea0c27015"><td class="memItemLeft" align="right" valign="top">typedef struct cy_p64_psa_key_attributes_s </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a></td></tr> | |
| <tr class="memdesc:gaff1087b4ae5d43a3a7aa9a5ea0c27015"><td class="mdescLeft"> </td><td class="mdescRight">The type of a structure containing key attributes. <a href="#gaff1087b4ae5d43a3a7aa9a5ea0c27015">More...</a><br /></td></tr> | |
| <tr class="separator:gaff1087b4ae5d43a3a7aa9a5ea0c27015"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga98132575cf2342accc2f368cb064913c"><td class="memItemLeft" align="right" valign="top">typedef struct cy_p64_psa_key_policy_s </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga98132575cf2342accc2f368cb064913c">cy_p64_psa_key_policy_t</a></td></tr> | |
| <tr class="memdesc:ga98132575cf2342accc2f368cb064913c"><td class="mdescLeft"> </td><td class="mdescRight">The type of the key policy data structure. <a href="#ga98132575cf2342accc2f368cb064913c">More...</a><br /></td></tr> | |
| <tr class="separator:ga98132575cf2342accc2f368cb064913c"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table><table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> | |
| Functions</h2></td></tr> | |
| <tr class="memitem:gaa907817d93bf5eed23d149ea225d79ea"><td class="memItemLeft" align="right" valign="top">static struct cy_p64_psa_key_attributes_s </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gaa907817d93bf5eed23d149ea225d79ea">cy_p64_psa_key_attributes_init</a> (void)</td></tr> | |
| <tr class="memdesc:gaa907817d93bf5eed23d149ea225d79ea"><td class="mdescLeft"> </td><td class="mdescRight">Sets key attributes strcuture with initial value. <a href="#gaa907817d93bf5eed23d149ea225d79ea">More...</a><br /></td></tr> | |
| <tr class="separator:gaa907817d93bf5eed23d149ea225d79ea"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga1a07395567e0c4d70f0935995a8e4f40"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga1a07395567e0c4d70f0935995a8e4f40">cy_p64_psa_set_key_id</a> (<a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes, <a class="el" href="group__key__lifetimes.html#ga83c3b77c643271df8710d809758c2774">cy_p64_psa_key_id_t</a> id)</td></tr> | |
| <tr class="memdesc:ga1a07395567e0c4d70f0935995a8e4f40"><td class="mdescLeft"> </td><td class="mdescRight">Sets key ID in key attributes strcuture. <a href="#ga1a07395567e0c4d70f0935995a8e4f40">More...</a><br /></td></tr> | |
| <tr class="separator:ga1a07395567e0c4d70f0935995a8e4f40"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga6b8c0aea609ada2a0c5d6b4587c58fc6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__key__lifetimes.html#ga83c3b77c643271df8710d809758c2774">cy_p64_psa_key_id_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga6b8c0aea609ada2a0c5d6b4587c58fc6">cy_p64_psa_get_key_id</a> (const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes)</td></tr> | |
| <tr class="memdesc:ga6b8c0aea609ada2a0c5d6b4587c58fc6"><td class="mdescLeft"> </td><td class="mdescRight">Gets key ID from key attributes strcuture. <a href="#ga6b8c0aea609ada2a0c5d6b4587c58fc6">More...</a><br /></td></tr> | |
| <tr class="separator:ga6b8c0aea609ada2a0c5d6b4587c58fc6"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gacd112ff3def917338c8a4ab1e8814992"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gacd112ff3def917338c8a4ab1e8814992">cy_p64_psa_set_key_lifetime</a> (<a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes, <a class="el" href="group__key__lifetimes.html#ga8bb4cbb109e6b5d7e8ae68d9288766ce">cy_p64_psa_key_lifetime_t</a> lifetime)</td></tr> | |
| <tr class="memdesc:gacd112ff3def917338c8a4ab1e8814992"><td class="mdescLeft"> </td><td class="mdescRight">Sets key lifetime in key attributes strcuture. <a href="#gacd112ff3def917338c8a4ab1e8814992">More...</a><br /></td></tr> | |
| <tr class="separator:gacd112ff3def917338c8a4ab1e8814992"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga5e6423750bdb2830e55e6799d078c43f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__key__lifetimes.html#ga8bb4cbb109e6b5d7e8ae68d9288766ce">cy_p64_psa_key_lifetime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga5e6423750bdb2830e55e6799d078c43f">cy_p64_psa_get_key_lifetime</a> (const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes)</td></tr> | |
| <tr class="memdesc:ga5e6423750bdb2830e55e6799d078c43f"><td class="mdescLeft"> </td><td class="mdescRight">Gets key lifetime from key attributes strcuture. <a href="#ga5e6423750bdb2830e55e6799d078c43f">More...</a><br /></td></tr> | |
| <tr class="separator:ga5e6423750bdb2830e55e6799d078c43f"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gac6dcc798b7cc86b47f5bfee544ba849a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gac6dcc798b7cc86b47f5bfee544ba849a">cy_p64_psa_set_key_usage_flags</a> (<a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes, <a class="el" href="group__policy.html#ga419a286b283b537123912fb1dc143418">cy_p64_psa_key_usage_t</a> usage_flags)</td></tr> | |
| <tr class="memdesc:gac6dcc798b7cc86b47f5bfee544ba849a"><td class="mdescLeft"> </td><td class="mdescRight">Sets key usage flags in key attributes strcuture. <a href="#gac6dcc798b7cc86b47f5bfee544ba849a">More...</a><br /></td></tr> | |
| <tr class="separator:gac6dcc798b7cc86b47f5bfee544ba849a"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gad7784effd918f7b31972086dc24377e9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__policy.html#ga419a286b283b537123912fb1dc143418">cy_p64_psa_key_usage_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gad7784effd918f7b31972086dc24377e9">cy_p64_psa_get_key_usage_flags</a> (const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes)</td></tr> | |
| <tr class="memdesc:gad7784effd918f7b31972086dc24377e9"><td class="mdescLeft"> </td><td class="mdescRight">Gets key usage flags from key attributes strcuture. <a href="#gad7784effd918f7b31972086dc24377e9">More...</a><br /></td></tr> | |
| <tr class="separator:gad7784effd918f7b31972086dc24377e9"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gaab4618d1940426b5f14fd638488b9eac"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gaab4618d1940426b5f14fd638488b9eac">cy_p64_psa_set_key_algorithm</a> (<a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes, <a class="el" href="group__crypto__types.html#gaacbbf49e9343ccc308acc8142183418d">cy_p64_psa_algorithm_t</a> alg)</td></tr> | |
| <tr class="memdesc:gaab4618d1940426b5f14fd638488b9eac"><td class="mdescLeft"> </td><td class="mdescRight">Sets key algorithm in key attributes strcuture. <a href="#gaab4618d1940426b5f14fd638488b9eac">More...</a><br /></td></tr> | |
| <tr class="separator:gaab4618d1940426b5f14fd638488b9eac"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga4c12d33429b3ca6419c8c2a407b216fa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__crypto__types.html#gaacbbf49e9343ccc308acc8142183418d">cy_p64_psa_algorithm_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga4c12d33429b3ca6419c8c2a407b216fa">cy_p64_psa_get_key_algorithm</a> (const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes)</td></tr> | |
| <tr class="memdesc:ga4c12d33429b3ca6419c8c2a407b216fa"><td class="mdescLeft"> </td><td class="mdescRight">Gets key algorithm from key attributes strcuture. <a href="#ga4c12d33429b3ca6419c8c2a407b216fa">More...</a><br /></td></tr> | |
| <tr class="separator:ga4c12d33429b3ca6419c8c2a407b216fa"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gaa0eee0fe32da70e718adcf7a07dcdec0"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gaa0eee0fe32da70e718adcf7a07dcdec0">cy_p64_psa_set_key_type</a> (<a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes, <a class="el" href="group__crypto__types.html#ga52af6d4f2b26c8bb868e93d2156d0879">cy_p64_psa_key_type_t</a> type)</td></tr> | |
| <tr class="memdesc:gaa0eee0fe32da70e718adcf7a07dcdec0"><td class="mdescLeft"> </td><td class="mdescRight">Sets key type in key attributes strcuture. <a href="#gaa0eee0fe32da70e718adcf7a07dcdec0">More...</a><br /></td></tr> | |
| <tr class="separator:gaa0eee0fe32da70e718adcf7a07dcdec0"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gad8f78f461e67056f985bff9872078f26"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__crypto__types.html#ga52af6d4f2b26c8bb868e93d2156d0879">cy_p64_psa_key_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#gad8f78f461e67056f985bff9872078f26">cy_p64_psa_get_key_type</a> (const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes)</td></tr> | |
| <tr class="memdesc:gad8f78f461e67056f985bff9872078f26"><td class="mdescLeft"> </td><td class="mdescRight">Gets key type from key attributes strcuture. <a href="#gad8f78f461e67056f985bff9872078f26">More...</a><br /></td></tr> | |
| <tr class="separator:gad8f78f461e67056f985bff9872078f26"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga118bf02df4249d1337e7bcef2225b8e0"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga118bf02df4249d1337e7bcef2225b8e0">cy_p64_psa_set_key_bits</a> (<a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes, size_t bits)</td></tr> | |
| <tr class="memdesc:ga118bf02df4249d1337e7bcef2225b8e0"><td class="mdescLeft"> </td><td class="mdescRight">Sets key length in bits in key attributes strcuture. <a href="#ga118bf02df4249d1337e7bcef2225b8e0">More...</a><br /></td></tr> | |
| <tr class="separator:ga118bf02df4249d1337e7bcef2225b8e0"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga0864576604d481f0a783c7124c7d9a64"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__attributes.html#ga0864576604d481f0a783c7124c7d9a64">cy_p64_psa_get_key_bits</a> (const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> *attributes)</td></tr> | |
| <tr class="memdesc:ga0864576604d481f0a783c7124c7d9a64"><td class="mdescLeft"> </td><td class="mdescRight">Gets key length in bits from key attributes strcuture. <a href="#ga0864576604d481f0a783c7124c7d9a64">More...</a><br /></td></tr> | |
| <tr class="separator:ga0864576604d481f0a783c7124c7d9a64"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table> | |
| <h2 class="groupheader">Macro Definition Documentation</h2> | |
| <a id="ga249f6524d942d32050e2ecfc31e6c9d5"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga249f6524d942d32050e2ecfc31e6c9d5">◆ </a></span>CY_P64_PSA_KEY_BITS_TOO_LARGE</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">#define CY_P64_PSA_KEY_BITS_TOO_LARGE   ( (<a class="el" href="group__attributes.html#ga9834218d0a577f043a7593e949bc9815">cy_p64_psa_key_bits_t</a>) ( -1 ) )</td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>The maximum value of the type used to represent bit-sizes. </p> | |
| <p>This is used to mark an invalid key size. </p> | |
| </div> | |
| </div> | |
| <a id="ga7f20a20e88cfce65cab7a51439265cc4"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga7f20a20e88cfce65cab7a51439265cc4">◆ </a></span>CY_P64_PSA_MAX_KEY_BITS</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">#define CY_P64_PSA_MAX_KEY_BITS   0xfff8U</td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>The maximum size of a key in bits. </p> | |
| <p>Currently defined as the maximum that can be represented, rounded down to a whole number of bytes. This is an uncast value so that it can be used in preprocessor conditionals. </p> | |
| </div> | |
| </div> | |
| <a id="gac2778973058b124dbee630b217d70727"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gac2778973058b124dbee630b217d70727">◆ </a></span>CY_P64_PSA_CORE_KEY_ATTRIBUTES_INIT</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">#define CY_P64_PSA_CORE_KEY_ATTRIBUTES_INIT</td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <b>Value:</b><div class="fragment"><div class="line">{ <a class="code" href="group__crypto__types.html#ga15b22b9e14bb43fba96537221d2591b8">CY_P64_PSA_KEY_TYPE_NONE</a>, 0, \</div><div class="line"> CY_P64_PSA_KEY_LIFETIME_VOLATILE, \</div><div class="line"> CY_P64_PSA_KEY_ID_INIT, \</div><div class="line"> CY_P64_PSA_KEY_POLICY_INIT, 0 }</div><div class="ttc" id="group__crypto__types_html_ga15b22b9e14bb43fba96537221d2591b8"><div class="ttname"><a href="group__crypto__types.html#ga15b22b9e14bb43fba96537221d2591b8">CY_P64_PSA_KEY_TYPE_NONE</a></div><div class="ttdeci">#define CY_P64_PSA_KEY_TYPE_NONE</div><div class="ttdoc">An invalid key type value. </div><div class="ttdef"><b>Definition:</b> cy_p64_psacrypto_values.h:291</div></div> | |
| </div><!-- fragment --> | |
| <p>The initial value of the core key attributes. </p> | |
| </div> | |
| </div> | |
| <h2 class="groupheader">Typedef Documentation</h2> | |
| <a id="ga9834218d0a577f043a7593e949bc9815"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga9834218d0a577f043a7593e949bc9815">◆ </a></span>cy_p64_psa_key_bits_t</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">typedef uint16_t <a class="el" href="group__attributes.html#ga9834218d0a577f043a7593e949bc9815">cy_p64_psa_key_bits_t</a></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>The type used internally for key sizes. </p> | |
| <p>Public interfaces use size_t, but internally we use a smaller type. </p> | |
| </div> | |
| </div> | |
| <a id="gadf5a819ed13941e5bc4eb111edeac9eb"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gadf5a819ed13941e5bc4eb111edeac9eb">◆ </a></span>cy_p64_psa_key_attributes_flag_t</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">typedef uint16_t <a class="el" href="group__attributes.html#gadf5a819ed13941e5bc4eb111edeac9eb">cy_p64_psa_key_attributes_flag_t</a></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>A mask of flags that can be stored in key attributes. </p> | |
| <p>This type is also used internally to store flags in slots. Internal flags are defined in library/psa_crypto_core.h. Internal flags may have the same value as external flags if they are properly handled during key creation and in psa_get_key_attributes. </p> | |
| </div> | |
| </div> | |
| <a id="gaff1087b4ae5d43a3a7aa9a5ea0c27015"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gaff1087b4ae5d43a3a7aa9a5ea0c27015">◆ </a></span>cy_p64_psa_key_attributes_t</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">typedef struct cy_p64_psa_key_attributes_s <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>The type of a structure containing key attributes. </p> | |
| <p>This is an opaque structure that can represent the metadata of a key object. Metadata that can be stored in attributes includes:</p><ul> | |
| <li>The location of the key in storage, indicated by its key identifier and its lifetime.</li> | |
| <li>The key's policy, comprising usage flags and a specification of the permitted algorithm(s).</li> | |
| <li>Information about the key itself: the key type and its size.</li> | |
| <li>Implementations may define additional attributes.</li> | |
| </ul> | |
| <p>The actual key material is not considered an attribute of a key. Key attributes do not contain information that is generally considered highly confidential.</p> | |
| <p>An attribute structure can be a simple data structure where each function <code>psa_set_key_xxx</code> sets a field and the corresponding function <code>psa_get_key_xxx</code> retrieves the value of the corresponding field. However, implementations may report values that are equivalent to the original one, but have a different encoding. For example, an implementation may use a more compact representation for types where many bit-patterns are invalid or not supported, and store all values that it does not support as a special marker value. In such an implementation, after setting an invalid value, the corresponding get function returns an invalid value which may not be the one that was originally stored.</p> | |
| <p>An attribute structure may contain references to auxiliary resources, for example pointers to allocated memory or indirect references to pre-calculated values. In order to free such resources, the application must call cy_p64_psa_reset_key_attributes(). As an exception, calling cy_p64_psa_reset_key_attributes() on an attribute structure is optional if the structure has only been modified by the following functions since it was initialized or last reset with cy_p64_psa_reset_key_attributes():</p><ul> | |
| <li><a class="el" href="group__attributes.html#ga1a07395567e0c4d70f0935995a8e4f40" title="Sets key ID in key attributes strcuture. ">cy_p64_psa_set_key_id()</a></li> | |
| <li><a class="el" href="group__attributes.html#gacd112ff3def917338c8a4ab1e8814992" title="Sets key lifetime in key attributes strcuture. ">cy_p64_psa_set_key_lifetime()</a></li> | |
| <li><a class="el" href="group__attributes.html#gaa0eee0fe32da70e718adcf7a07dcdec0" title="Sets key type in key attributes strcuture. ">cy_p64_psa_set_key_type()</a></li> | |
| <li><a class="el" href="group__attributes.html#ga118bf02df4249d1337e7bcef2225b8e0" title="Sets key length in bits in key attributes strcuture. ">cy_p64_psa_set_key_bits()</a></li> | |
| <li><a class="el" href="group__attributes.html#gac6dcc798b7cc86b47f5bfee544ba849a" title="Sets key usage flags in key attributes strcuture. ">cy_p64_psa_set_key_usage_flags()</a></li> | |
| <li><a class="el" href="group__attributes.html#gaab4618d1940426b5f14fd638488b9eac" title="Sets key algorithm in key attributes strcuture. ">cy_p64_psa_set_key_algorithm()</a></li> | |
| </ul> | |
| <p>Before calling any function on a key attribute structure, the application must initialize it by any of the following means:</p><ul> | |
| <li>Set the structure to all-bits-zero, for example: <div class="fragment"><div class="line"><a class="code" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> attributes;</div><div class="line">memset(&attributes, 0, <span class="keyword">sizeof</span>(attributes));</div></div><!-- fragment --></li> | |
| <li>Initialize the structure to logical zero values, for example: <div class="fragment"><div class="line"><a class="code" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> attributes = {0};</div></div><!-- fragment --></li> | |
| <li>Initialize the structure to the initializer <a class="el" href="group__attributes.html#ga36da7ed57f918f7393f7c293aea26c36" title="The initial value of the key attributes. ">CY_P64_PSA_KEY_ATTRIBUTES_INIT</a>, for example: <div class="fragment"><div class="line"><a class="code" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> attributes = <a class="code" href="group__attributes.html#ga36da7ed57f918f7393f7c293aea26c36">CY_P64_PSA_KEY_ATTRIBUTES_INIT</a>;</div></div><!-- fragment --></li> | |
| <li>Assign the result of the function <a class="el" href="group__attributes.html#gaa907817d93bf5eed23d149ea225d79ea" title="Sets key attributes strcuture with initial value. ">cy_p64_psa_key_attributes_init()</a> to the structure, for example: <div class="fragment"><div class="line"><a class="code" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> attributes;</div><div class="line">attributes = <a class="code" href="group__attributes.html#gaa907817d93bf5eed23d149ea225d79ea">cy_p64_psa_key_attributes_init</a>();</div></div><!-- fragment --></li> | |
| </ul> | |
| <p>A freshly initialized attribute structure contains the following values:</p> | |
| <ul> | |
| <li>lifetime: <a class="el" href="group__key__lifetimes.html#ga608d2a0265b5e8ef8dc22b05f17fbc7b" title="The default lifetime for volatile keys. ">CY_P64_PSA_KEY_LIFETIME_VOLATILE</a>.</li> | |
| <li>key identifier: 0 (which is not a valid key identifier).</li> | |
| <li>type: <code>0</code> (meaning that the type is unspecified).</li> | |
| <li>key size: <code>0</code> (meaning that the size is unspecified).</li> | |
| <li>usage flags: <code>0</code> (which allows no usage except exporting a public key).</li> | |
| <li>algorithm: <code>0</code> (which allows no cryptographic usage, but allows exporting).</li> | |
| </ul> | |
| <p>A typical sequence to create a key is as follows:</p><ol type="1"> | |
| <li>Create and initialize an attribute structure.</li> | |
| <li>If the key is persistent, call <a class="el" href="group__attributes.html#ga1a07395567e0c4d70f0935995a8e4f40" title="Sets key ID in key attributes strcuture. ">cy_p64_psa_set_key_id()</a>. Also call <a class="el" href="group__attributes.html#gacd112ff3def917338c8a4ab1e8814992" title="Sets key lifetime in key attributes strcuture. ">cy_p64_psa_set_key_lifetime()</a> to place the key in a non-default location.</li> | |
| <li>Set the key policy with <a class="el" href="group__attributes.html#gac6dcc798b7cc86b47f5bfee544ba849a" title="Sets key usage flags in key attributes strcuture. ">cy_p64_psa_set_key_usage_flags()</a> and <a class="el" href="group__attributes.html#gaab4618d1940426b5f14fd638488b9eac" title="Sets key algorithm in key attributes strcuture. ">cy_p64_psa_set_key_algorithm()</a>.</li> | |
| <li>Set the key type with <a class="el" href="group__attributes.html#gaa0eee0fe32da70e718adcf7a07dcdec0" title="Sets key type in key attributes strcuture. ">cy_p64_psa_set_key_type()</a>. Skip this step if copying an existing key with psa_copy_key().</li> | |
| <li>When generating a random key with <a class="el" href="group__import__export.html#ga93ee3c9c700505b08fc93c2136210fb7" title="Generates a key or key pair. ">cy_p64_psa_generate_key()</a> or deriving a key with cy_p64_psa_key_derivation_output_key(), set the desired key size with <a class="el" href="group__attributes.html#ga118bf02df4249d1337e7bcef2225b8e0" title="Sets key length in bits in key attributes strcuture. ">cy_p64_psa_set_key_bits()</a>.</li> | |
| <li>Call a key creation function: <a class="el" href="group__import__export.html#ga7999832dd9a8e2be45df12dcb54e67c2" title="Imports a key in binary format. ">cy_p64_psa_import_key()</a>, <a class="el" href="group__import__export.html#ga93ee3c9c700505b08fc93c2136210fb7" title="Generates a key or key pair. ">cy_p64_psa_generate_key()</a>, cy_p64_psa_key_derivation_output_key() or psa_copy_key(). This function reads the attribute structure, creates a key with these attributes, and outputs a handle to the newly created key.</li> | |
| <li>The attribute structure is now no longer necessary. You may call cy_p64_psa_reset_key_attributes(), although this is optional with the workflow presented here because the attributes currently defined in this specification do not require any additional resources beyond the structure itself.</li> | |
| </ol> | |
| <p>A typical sequence to query a key's attributes is as follows:</p><ol type="1"> | |
| <li>Call <a class="el" href="group__import__export.html#gacf498120967cfa9a4fcbcbe39921f750" title="Retrieves the attributes of a key. ">cy_p64_psa_get_key_attributes()</a>.</li> | |
| <li>Call <code>psa_get_key_xxx</code> functions to retrieve the attribute(s) that you are interested in.</li> | |
| <li>Call cy_p64_cy_p64_psa_reset_key_attributes() to free any resources that may be used by the attribute structure.</li> | |
| </ol> | |
| <p>Once a key is created, it is impossible to change its attributes. </p> | |
| </div> | |
| </div> | |
| <a id="ga98132575cf2342accc2f368cb064913c"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga98132575cf2342accc2f368cb064913c">◆ </a></span>cy_p64_psa_key_policy_t</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">typedef struct cy_p64_psa_key_policy_s <a class="el" href="group__attributes.html#ga98132575cf2342accc2f368cb064913c">cy_p64_psa_key_policy_t</a></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>The type of the key policy data structure. </p> | |
| <p>This is an implementation-defined <code>struct</code>. Applications should not make any assumptions about the content of this structure except as directed by the documentation of a specific implementation. </p> | |
| </div> | |
| </div> | |
| <h2 class="groupheader">Function Documentation</h2> | |
| <a id="gaa907817d93bf5eed23d149ea225d79ea"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa907817d93bf5eed23d149ea225d79ea">◆ </a></span>cy_p64_psa_key_attributes_init()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static struct cy_p64_psa_key_attributes_s cy_p64_psa_key_attributes_init </td> | |
| <td>(</td> | |
| <td class="paramtype">void </td> | |
| <td class="paramname"></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key attributes strcuture with initial value. </p> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">/p</td><td>cy_p64_psa_key_attributes_s structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ga1a07395567e0c4d70f0935995a8e4f40"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga1a07395567e0c4d70f0935995a8e4f40">◆ </a></span>cy_p64_psa_set_key_id()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static void cy_p64_psa_set_key_id </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga83c3b77c643271df8710d809758c2774">cy_p64_psa_key_id_t</a> </td> | |
| <td class="paramname"><em>id</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key ID in key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Key ID </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ga6b8c0aea609ada2a0c5d6b4587c58fc6"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6b8c0aea609ada2a0c5d6b4587c58fc6">◆ </a></span>cy_p64_psa_get_key_id()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static <a class="el" href="group__key__lifetimes.html#ga83c3b77c643271df8710d809758c2774">cy_p64_psa_key_id_t</a> cy_p64_psa_get_key_id </td> | |
| <td>(</td> | |
| <td class="paramtype">const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Gets key ID from key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">Key</td><td>ID </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="gacd112ff3def917338c8a4ab1e8814992"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gacd112ff3def917338c8a4ab1e8814992">◆ </a></span>cy_p64_psa_set_key_lifetime()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static void cy_p64_psa_set_key_lifetime </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="group__key__lifetimes.html#ga8bb4cbb109e6b5d7e8ae68d9288766ce">cy_p64_psa_key_lifetime_t</a> </td> | |
| <td class="paramname"><em>lifetime</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key lifetime in key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">lifetime</td><td>Key lifetime </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ga5e6423750bdb2830e55e6799d078c43f"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga5e6423750bdb2830e55e6799d078c43f">◆ </a></span>cy_p64_psa_get_key_lifetime()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static <a class="el" href="group__key__lifetimes.html#ga8bb4cbb109e6b5d7e8ae68d9288766ce">cy_p64_psa_key_lifetime_t</a> cy_p64_psa_get_key_lifetime </td> | |
| <td>(</td> | |
| <td class="paramtype">const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Gets key lifetime from key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">Key</td><td>lifetime </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="gac6dcc798b7cc86b47f5bfee544ba849a"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gac6dcc798b7cc86b47f5bfee544ba849a">◆ </a></span>cy_p64_psa_set_key_usage_flags()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static void cy_p64_psa_set_key_usage_flags </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="group__policy.html#ga419a286b283b537123912fb1dc143418">cy_p64_psa_key_usage_t</a> </td> | |
| <td class="paramname"><em>usage_flags</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key usage flags in key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">usage_flags</td><td>Key usage flags </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="gad7784effd918f7b31972086dc24377e9"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gad7784effd918f7b31972086dc24377e9">◆ </a></span>cy_p64_psa_get_key_usage_flags()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static <a class="el" href="group__policy.html#ga419a286b283b537123912fb1dc143418">cy_p64_psa_key_usage_t</a> cy_p64_psa_get_key_usage_flags </td> | |
| <td>(</td> | |
| <td class="paramtype">const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Gets key usage flags from key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">Key</td><td>usage flags </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="gaab4618d1940426b5f14fd638488b9eac"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gaab4618d1940426b5f14fd638488b9eac">◆ </a></span>cy_p64_psa_set_key_algorithm()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static void cy_p64_psa_set_key_algorithm </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="group__crypto__types.html#gaacbbf49e9343ccc308acc8142183418d">cy_p64_psa_algorithm_t</a> </td> | |
| <td class="paramname"><em>alg</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key algorithm in key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">alg</td><td>Key algorithm </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ga4c12d33429b3ca6419c8c2a407b216fa"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga4c12d33429b3ca6419c8c2a407b216fa">◆ </a></span>cy_p64_psa_get_key_algorithm()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static <a class="el" href="group__crypto__types.html#gaacbbf49e9343ccc308acc8142183418d">cy_p64_psa_algorithm_t</a> cy_p64_psa_get_key_algorithm </td> | |
| <td>(</td> | |
| <td class="paramtype">const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Gets key algorithm from key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">Key</td><td>algorithm </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="gaa0eee0fe32da70e718adcf7a07dcdec0"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa0eee0fe32da70e718adcf7a07dcdec0">◆ </a></span>cy_p64_psa_set_key_type()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static void cy_p64_psa_set_key_type </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="group__crypto__types.html#ga52af6d4f2b26c8bb868e93d2156d0879">cy_p64_psa_key_type_t</a> </td> | |
| <td class="paramname"><em>type</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key type in key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Key type </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="gad8f78f461e67056f985bff9872078f26"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gad8f78f461e67056f985bff9872078f26">◆ </a></span>cy_p64_psa_get_key_type()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static <a class="el" href="group__crypto__types.html#ga52af6d4f2b26c8bb868e93d2156d0879">cy_p64_psa_key_type_t</a> cy_p64_psa_get_key_type </td> | |
| <td>(</td> | |
| <td class="paramtype">const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Gets key type from key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">Key</td><td>type </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ga118bf02df4249d1337e7bcef2225b8e0"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga118bf02df4249d1337e7bcef2225b8e0">◆ </a></span>cy_p64_psa_set_key_bits()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static void cy_p64_psa_set_key_bits </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">size_t </td> | |
| <td class="paramname"><em>bits</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Sets key length in bits in key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">bits</td><td>Key length in bits </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <a id="ga0864576604d481f0a783c7124c7d9a64"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0864576604d481f0a783c7124c7d9a64">◆ </a></span>cy_p64_psa_get_key_bits()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="mlabels"> | |
| <tr> | |
| <td class="mlabels-left"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">static size_t cy_p64_psa_get_key_bits </td> | |
| <td>(</td> | |
| <td class="paramtype">const <a class="el" href="group__attributes.html#gaff1087b4ae5d43a3a7aa9a5ea0c27015">cy_p64_psa_key_attributes_t</a> * </td> | |
| <td class="paramname"><em>attributes</em></td><td>)</td> | |
| <td></td> | |
| </tr> | |
| </table> | |
| </td> | |
| <td class="mlabels-right"> | |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Gets key length in bits from key attributes strcuture. </p> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[in]</td><td class="paramname">attributes</td><td>Key attributes structure </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname">Key</td><td>length in bits </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| </div><!-- contents --> | |
| </div><!-- doc-content --> | |
| <!-- start footer part | |
| <div id="nav-path" class="navpath"> | |
| <ul> | |
| <li class="footer"> | |
| Generated for <b>PSoC64 Secure Boot Utilities Middleware Library 1.0</b> by <b>Cypress Semiconductor Corporation</b>. | |
| All rights reserved. | |
| </li> | |
| </ul> | |
| </div> | |
| --> | |
| </body> | |
| </html> |