294 lines
14 KiB
HTML
294 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SemiDrive SSDK Appication Program Interface: Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/crypto/mailbox/sdrv_crypto_mailbox_hmac.h File Reference</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="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.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">SemiDrive SSDK Appication Program Interface<span id="projectnumber"> PTG3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_ee023d43c33bfccc31aa50a48a76892b.html">include</a></li><li class="navelem"><a class="el" href="dir_e08589e132e001d864753e5516cdc279.html">crypto</a></li><li class="navelem"><a class="el" href="dir_f7beecef409612ffb7ee2f98c8e6b0b6.html">mailbox</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">sdrv_crypto_mailbox_hmac.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="sdrv__crypto__mailbox__common_8h_source.html">sdrv_crypto_mailbox_common.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="sdrv__crypto__mailbox__trng_8h_source.html">sdrv_crypto_mailbox_trng.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="sdrv__crypto__mailbox__hmac_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd__generate_m_a_c__t.html">cmd_generateMAC_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcmd__verify_m_a_c__t.html">cmd_verifyMAC_t</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a1efbca0a94323302bc7e8ce607100909"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__crypto__mailbox__hmac_8h.html#a1efbca0a94323302bc7e8ce607100909">cmd_hmac_generate_mac</a> (uint8_t mode, uint8_t *msg, uint32_t msg_bytes, <a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a> key_type, const uint8_t *key, uint16_t key_id, uint32_t key_bytes, uint8_t mac_bytes, uint8_t *out, uint8_t *mac_buf)</td></tr>
|
|
<tr class="separator:a1efbca0a94323302bc7e8ce607100909"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e7888e5251fb415eb70609735abc0df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__crypto__mailbox__hmac_8h.html#a9e7888e5251fb415eb70609735abc0df">cmd_hmac_verify_mac</a> (uint8_t mode, uint8_t *msg, uint32_t msg_bytes, <a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a> key_type, const uint8_t *key, uint16_t key_id, uint32_t key_bytes, uint8_t hmac_bytes, uint8_t *<a class="el" href="hmac_8h.html#aecaed651d825e92d52a17171c0ca4887">hmac</a>, uint8_t *mac_buf)</td></tr>
|
|
<tr class="separator:a9e7888e5251fb415eb70609735abc0df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2021 Semidrive Semiconductor. All rights reserved. </dd></dl>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a1efbca0a94323302bc7e8ce607100909" name="a1efbca0a94323302bc7e8ce607100909"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1efbca0a94323302bc7e8ce607100909">◆ </a></span>cmd_hmac_generate_mac()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a> cmd_hmac_generate_mac </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>msg_bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a> </td>
|
|
<td class="paramname"><em>key_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>key_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>key_bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mac_bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>mac_buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get hmac value </p>
|
|
<p >This function get hmac</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>hmac mode </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>msg buff </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">msg_bytes</td><td>msg len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key_type</td><td>key type </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>key buff </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key_id</td><td>key id </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key_bytes</td><td>key len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mac_bytes</td><td>mac len </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>mac buff </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mac_buf</td><td>key_id mac buf </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>CMD_RETURN_SUCCESS or error code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9e7888e5251fb415eb70609735abc0df" name="a9e7888e5251fb415eb70609735abc0df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e7888e5251fb415eb70609735abc0df">◆ </a></span>cmd_hmac_verify_mac()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a> cmd_hmac_verify_mac </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>msg_bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a> </td>
|
|
<td class="paramname"><em>key_type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>key_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>key_bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>hmac_bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>hmac</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>mac_buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>verify hmac </p>
|
|
<p >This function verify hmac.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>hmac mode </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>msg buff </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">msg_bytes</td><td>msg len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key_type</td><td>key type </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>key buff </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key_id</td><td>key id </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key_bytes</td><td>key len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">hmac_bytes</td><td>mac len </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">hmac</td><td>mac buff </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mac_buf</td><td>key_id mac buf </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>CMD_RETURN_SUCCESS or error code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|