Files
E3_boot/doc/Doxygen/html/hmac_8h_source.html
2025-11-07 10:05:24 +08:00

161 lines
18 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/cacc/hash_hmac/hmac.h Source File</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">&#160;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&amp;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&amp;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_610f8d7993e1efb130988b94d1ce0406.html">cacc</a></li><li class="navelem"><a class="el" href="dir_b72364d7e98d9670c31edd79748aba06.html">hash_hmac</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">hmac.h</div></div>
</div><!--header-->
<div class="contents">
<a href="hmac_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*****************************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> *</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *Copyright (c) 2021-2029 Semidrive Incorporated. All rights reserved.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *Software License Agreement</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> ******************************************************************************</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> */</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#ifndef HMAC_H</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#define HMAC_H</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &quot;<a class="code" href="hash_8h.html">hash.h</a>&quot;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="hmac_8h.html#aed2dd27691e7d6f3ea4973ce7444ac09"> 18</a></span><span class="preprocessor">#define HMAC_IPAD (0x36363636)</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="hmac_8h.html#a24c8fbb6a428a1982f1f1169ce6337a4"> 19</a></span><span class="preprocessor">#define HMAC_OPAD (0x5c5c5c5c)</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="hmac_8h.html#a46d3fe549e8ced3eb4a844e7807ebb6e"> 20</a></span><span class="preprocessor">#define HMAC_IPAD_XOR_OPAD (HMAC_IPAD ^ HMAC_OPAD)</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/*HMAC context*/</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structhmac__ctx__t.html"> 23</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structhmac__ctx__t.html#a6057540408e998ce984791fe4fe1ddad"> 24</a></span> uint32_t K0[<a class="code hl_define" href="hash__basic_8h.html#ab969ff74042d15b7d5d1c67a2eb2dbc4">HASH_BLOCK_MAX_WORD_LEN</a>];</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structhmac__ctx__t.html#a314bee167ad4706994b5f2851800b199"> 25</a></span> uint32_t <a class="code hl_variable" href="structhmac__ctx__t.html#a314bee167ad4706994b5f2851800b199">key_flag</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structhmac__ctx__t.html#a2cdc10efc039ec95dbd8e537e33a55ad"> 26</a></span> <a class="code hl_enumeration" href="hash__basic_8h.html#a00fe0f9a183db2595b5d11be1ebcf3f8">HASH_ALG</a> <a class="code hl_variable" href="structhmac__ctx__t.html#a2cdc10efc039ec95dbd8e537e33a55ad">hash_alg</a>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structhmac__ctx__t.html#a51b3c08144c22123fb912c95cd16de72"> 27</a></span> <a class="code hl_struct" href="structhash__ctx__t.html">hash_ctx_t</a> hash_ctx[1];</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>} <a class="code hl_struct" href="structhmac__ctx__t.html">hmac_ctx_t</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/*HMAC DMA context*/</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#ifdef HASH_DMA_FUNCTION</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_struct" href="structhmac__ctx__t.html">hmac_ctx_t</a> hmac_ctx[1];</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> hash_dma_ctx_t hash_dma_ctx[1];</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>} hmac_dma_ctx_t;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="hmac_8h.html#a70fd46c6fafff373538a685478d8c320"> 38</a></span>uint32_t <a class="code hl_function" href="hmac_8h.html#a70fd46c6fafff373538a685478d8c320">hmac_init</a>(<a class="code hl_struct" href="structhmac__ctx__t.html">hmac_ctx_t</a> *ctx, <a class="code hl_enumeration" href="hash__basic_8h.html#a00fe0f9a183db2595b5d11be1ebcf3f8">HASH_ALG</a> hash_alg, uint8_t *key,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> uint16_t sp_key_idx, uint32_t key_bytes);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="hmac_8h.html#aeb73f6a7023ce43941658c2a85ed5ddf"> 41</a></span>uint32_t <a class="code hl_function" href="hmac_8h.html#aeb73f6a7023ce43941658c2a85ed5ddf">hmac_update</a>(<a class="code hl_struct" href="structhmac__ctx__t.html">hmac_ctx_t</a> *ctx, <span class="keyword">const</span> uint8_t *msg, uint32_t msg_bytes);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="hmac_8h.html#a3c4f32f5bdce45a90a1bc7c04b3a8842"> 43</a></span>uint32_t <a class="code hl_function" href="hmac_8h.html#a3c4f32f5bdce45a90a1bc7c04b3a8842">hmac_final</a>(<a class="code hl_struct" href="structhmac__ctx__t.html">hmac_ctx_t</a> *ctx, uint8_t *mac);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="hmac_8h.html#aecaed651d825e92d52a17171c0ca4887"> 45</a></span>uint32_t <a class="code hl_function" href="hmac_8h.html#aecaed651d825e92d52a17171c0ca4887">hmac</a>(<a class="code hl_enumeration" href="hash__basic_8h.html#a00fe0f9a183db2595b5d11be1ebcf3f8">HASH_ALG</a> hash_alg, uint8_t *key, uint16_t sp_key_idx,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> uint32_t key_bytes, uint8_t *msg, uint32_t msg_bytes,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> uint8_t *mac);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#ifdef HASH_DMA_FUNCTION</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>uint32_t hmac_dma_init(hmac_dma_ctx_t *ctx, <a class="code hl_enumeration" href="hash__basic_8h.html#a00fe0f9a183db2595b5d11be1ebcf3f8">HASH_ALG</a> hash_alg,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">const</span> uint8_t *key, uint16_t sp_key_idx,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> uint32_t key_bytes, <a class="code hl_typedef" href="hash__basic_8h.html#a54d6c4b8175a2575f3434a1540cbb1cf">HASH_CALLBACK</a> callback);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>uint32_t hmac_dma_update_blocks(hmac_dma_ctx_t *ctx, uint32_t *msg,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> uint32_t msg_words, uint32_t *tmp_iterator);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>uint32_t hmac_dma_final(hmac_dma_ctx_t *ctx, uint32_t *remainder_msg,</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> uint32_t remainder_bytes, uint32_t *tmp_iterator,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> uint8_t *mac);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>uint32_t hmac_dma(<a class="code hl_enumeration" href="hash__basic_8h.html#a00fe0f9a183db2595b5d11be1ebcf3f8">HASH_ALG</a> hash_alg, uint8_t *key, uint16_t sp_key_idx,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> uint32_t key_bytes, uint32_t *msg, uint32_t msg_bytes,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> uint32_t *tmp_iterator, uint8_t *mac, <a class="code hl_typedef" href="hash__basic_8h.html#a54d6c4b8175a2575f3434a1540cbb1cf">HASH_CALLBACK</a> callback);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>}</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="ahash_8h_html"><div class="ttname"><a href="hash_8h.html">hash.h</a></div></div>
<div class="ttc" id="ahash__basic_8h_html_a00fe0f9a183db2595b5d11be1ebcf3f8"><div class="ttname"><a href="hash__basic_8h.html#a00fe0f9a183db2595b5d11be1ebcf3f8">HASH_ALG</a></div><div class="ttdeci">HASH_ALG</div><div class="ttdef"><b>Definition:</b> hash_basic.h:131</div></div>
<div class="ttc" id="ahash__basic_8h_html_a54d6c4b8175a2575f3434a1540cbb1cf"><div class="ttname"><a href="hash__basic_8h.html#a54d6c4b8175a2575f3434a1540cbb1cf">HASH_CALLBACK</a></div><div class="ttdeci">void(* HASH_CALLBACK)(void)</div><div class="ttdef"><b>Definition:</b> hash_basic.h:195</div></div>
<div class="ttc" id="ahash__basic_8h_html_ab969ff74042d15b7d5d1c67a2eb2dbc4"><div class="ttname"><a href="hash__basic_8h.html#ab969ff74042d15b7d5d1c67a2eb2dbc4">HASH_BLOCK_MAX_WORD_LEN</a></div><div class="ttdeci">#define HASH_BLOCK_MAX_WORD_LEN</div><div class="ttdef"><b>Definition:</b> hash_basic.h:104</div></div>
<div class="ttc" id="ahmac_8h_html_a3c4f32f5bdce45a90a1bc7c04b3a8842"><div class="ttname"><a href="hmac_8h.html#a3c4f32f5bdce45a90a1bc7c04b3a8842">hmac_final</a></div><div class="ttdeci">uint32_t hmac_final(hmac_ctx_t *ctx, uint8_t *mac)</div></div>
<div class="ttc" id="ahmac_8h_html_a70fd46c6fafff373538a685478d8c320"><div class="ttname"><a href="hmac_8h.html#a70fd46c6fafff373538a685478d8c320">hmac_init</a></div><div class="ttdeci">uint32_t hmac_init(hmac_ctx_t *ctx, HASH_ALG hash_alg, uint8_t *key, uint16_t sp_key_idx, uint32_t key_bytes)</div></div>
<div class="ttc" id="ahmac_8h_html_aeb73f6a7023ce43941658c2a85ed5ddf"><div class="ttname"><a href="hmac_8h.html#aeb73f6a7023ce43941658c2a85ed5ddf">hmac_update</a></div><div class="ttdeci">uint32_t hmac_update(hmac_ctx_t *ctx, const uint8_t *msg, uint32_t msg_bytes)</div></div>
<div class="ttc" id="ahmac_8h_html_aecaed651d825e92d52a17171c0ca4887"><div class="ttname"><a href="hmac_8h.html#aecaed651d825e92d52a17171c0ca4887">hmac</a></div><div class="ttdeci">uint32_t hmac(HASH_ALG hash_alg, uint8_t *key, uint16_t sp_key_idx, uint32_t key_bytes, uint8_t *msg, uint32_t msg_bytes, uint8_t *mac)</div></div>
<div class="ttc" id="astructhash__ctx__t_html"><div class="ttname"><a href="structhash__ctx__t.html">hash_ctx_t</a></div><div class="ttdef"><b>Definition:</b> hash.h:24</div></div>
<div class="ttc" id="astructhmac__ctx__t_html"><div class="ttname"><a href="structhmac__ctx__t.html">hmac_ctx_t</a></div><div class="ttdef"><b>Definition:</b> hmac.h:23</div></div>
<div class="ttc" id="astructhmac__ctx__t_html_a2cdc10efc039ec95dbd8e537e33a55ad"><div class="ttname"><a href="structhmac__ctx__t.html#a2cdc10efc039ec95dbd8e537e33a55ad">hmac_ctx_t::hash_alg</a></div><div class="ttdeci">HASH_ALG hash_alg</div><div class="ttdef"><b>Definition:</b> hmac.h:26</div></div>
<div class="ttc" id="astructhmac__ctx__t_html_a314bee167ad4706994b5f2851800b199"><div class="ttname"><a href="structhmac__ctx__t.html#a314bee167ad4706994b5f2851800b199">hmac_ctx_t::key_flag</a></div><div class="ttdeci">uint32_t key_flag</div><div class="ttdef"><b>Definition:</b> hmac.h:25</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>