1
0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-29 08:12:40 +02:00
libnx/hmac_8h_source.html
2025-05-08 06:59:12 +00:00

161 lines
20 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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/crypto/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">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_2874fbf892ad5b8020be2442f929b820.html">crypto</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"> * @file hmac.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Hardware accelerated HMAC-SHA(1, 256) implementation.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;<a class="code" href="sha1_8h.html">sha1.h</a>&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="sha256_8h.html">sha256.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">/// Context for HMAC-SHA1 operations.</span></div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="structHmacSha1Context.html"> 11</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <a class="code hl_struct" href="structSha1Context.html">Sha1Context</a> sha_ctx;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> key[SHA1_BLOCK_SIZE / <span class="keyword">sizeof</span>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>)];</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> mac[SHA1_HASH_SIZE / <span class="keyword">sizeof</span>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>)];</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordtype">bool</span> finalized;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>} <a class="code hl_struct" href="structHmacSha1Context.html">HmacSha1Context</a>;</div>
</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/// Context for HMAC-SHA256 operations.</span></div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="structHmacSha256Context.html"> 19</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_struct" href="structSha256Context.html">Sha256Context</a> sha_ctx;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> key[SHA256_BLOCK_SIZE / <span class="keyword">sizeof</span>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>)];</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> mac[SHA256_HASH_SIZE / <span class="keyword">sizeof</span>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>)];</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">bool</span> finalized;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>} <a class="code hl_struct" href="structHmacSha256Context.html">HmacSha256Context</a>;</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#ifndef HMAC_SHA1_KEY_MAX</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#define HMAC_SHA1_KEY_MAX (sizeof(((HmacSha1Context *)NULL)-&gt;key))</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#ifndef HMAC_SHA256_KEY_MAX</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#define HMAC_SHA256_KEY_MAX (sizeof(((HmacSha256Context *)NULL)-&gt;key))</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">/// Initialize a HMAC-SHA256 context.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="hmac_8h.html#af9dea0ed545fedf95811dc1e57fdad96"> 34</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#af9dea0ed545fedf95811dc1e57fdad96">hmacSha256ContextCreate</a>(<a class="code hl_struct" href="structHmacSha256Context.html">HmacSha256Context</a> *out, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> key_size);<span class="comment"></span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">/// Updates HMAC-SHA256 context with data to hash</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="hmac_8h.html#ae2af4e27366a4b8c51abcccb22e9d4b7"> 36</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#ae2af4e27366a4b8c51abcccb22e9d4b7">hmacSha256ContextUpdate</a>(<a class="code hl_struct" href="structHmacSha256Context.html">HmacSha256Context</a> *ctx, <span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> size);<span class="comment"></span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">/// Gets the context&#39;s output mac, finalizes the context.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="hmac_8h.html#aceee0205cfc2d714d3809bea7f84e3af"> 38</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#aceee0205cfc2d714d3809bea7f84e3af">hmacSha256ContextGetMac</a>(<a class="code hl_struct" href="structHmacSha256Context.html">HmacSha256Context</a> *ctx, <span class="keywordtype">void</span> *dst);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"></span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">/// Simple all-in-one HMAC-SHA256 calculator.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="hmac_8h.html#ae52e15bf214cc8c08a83f918c780ff83"> 41</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#ae52e15bf214cc8c08a83f918c780ff83">hmacSha256CalculateMac</a>(<span class="keywordtype">void</span> *dst, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> key_size, <span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">/// Initialize a HMAC-SHA1 context.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="hmac_8h.html#ab551635e4197e28bae8ef0cfe532feca"> 44</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#ab551635e4197e28bae8ef0cfe532feca">hmacSha1ContextCreate</a>(<a class="code hl_struct" href="structHmacSha1Context.html">HmacSha1Context</a> *out, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> key_size);<span class="comment"></span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">/// Updates HMAC-SHA1 context with data to hash</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="hmac_8h.html#a683db62d71399787455bd1abf25721a1"> 46</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#a683db62d71399787455bd1abf25721a1">hmacSha1ContextUpdate</a>(<a class="code hl_struct" href="structHmacSha1Context.html">HmacSha1Context</a> *ctx, <span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> size);<span class="comment"></span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">/// Gets the context&#39;s output mac, finalizes the context.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="hmac_8h.html#a07281f27d191e2ded13b51c4dd0069f9"> 48</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#a07281f27d191e2ded13b51c4dd0069f9">hmacSha1ContextGetMac</a>(<a class="code hl_struct" href="structHmacSha1Context.html">HmacSha1Context</a> *ctx, <span class="keywordtype">void</span> *dst);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"></span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">/// Simple all-in-one HMAC-SHA1 calculator.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="hmac_8h.html#ae99080bc94ec78657271eed049abd6e9"> 51</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="hmac_8h.html#ae99080bc94ec78657271eed049abd6e9">hmacSha1CalculateMac</a>(<span class="keywordtype">void</span> *dst, <span class="keyword">const</span> <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> key_size, <span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> size);</div>
<div class="ttc" id="ahmac_8h_html_a07281f27d191e2ded13b51c4dd0069f9"><div class="ttname"><a href="hmac_8h.html#a07281f27d191e2ded13b51c4dd0069f9">hmacSha1ContextGetMac</a></div><div class="ttdeci">void hmacSha1ContextGetMac(HmacSha1Context *ctx, void *dst)</div><div class="ttdoc">Gets the context's output mac, finalizes the context.</div></div>
<div class="ttc" id="ahmac_8h_html_a683db62d71399787455bd1abf25721a1"><div class="ttname"><a href="hmac_8h.html#a683db62d71399787455bd1abf25721a1">hmacSha1ContextUpdate</a></div><div class="ttdeci">void hmacSha1ContextUpdate(HmacSha1Context *ctx, const void *src, size_t size)</div><div class="ttdoc">Updates HMAC-SHA1 context with data to hash.</div></div>
<div class="ttc" id="ahmac_8h_html_ab551635e4197e28bae8ef0cfe532feca"><div class="ttname"><a href="hmac_8h.html#ab551635e4197e28bae8ef0cfe532feca">hmacSha1ContextCreate</a></div><div class="ttdeci">void hmacSha1ContextCreate(HmacSha1Context *out, const void *key, size_t key_size)</div><div class="ttdoc">Initialize a HMAC-SHA1 context.</div></div>
<div class="ttc" id="ahmac_8h_html_aceee0205cfc2d714d3809bea7f84e3af"><div class="ttname"><a href="hmac_8h.html#aceee0205cfc2d714d3809bea7f84e3af">hmacSha256ContextGetMac</a></div><div class="ttdeci">void hmacSha256ContextGetMac(HmacSha256Context *ctx, void *dst)</div><div class="ttdoc">Gets the context's output mac, finalizes the context.</div></div>
<div class="ttc" id="ahmac_8h_html_ae2af4e27366a4b8c51abcccb22e9d4b7"><div class="ttname"><a href="hmac_8h.html#ae2af4e27366a4b8c51abcccb22e9d4b7">hmacSha256ContextUpdate</a></div><div class="ttdeci">void hmacSha256ContextUpdate(HmacSha256Context *ctx, const void *src, size_t size)</div><div class="ttdoc">Updates HMAC-SHA256 context with data to hash.</div></div>
<div class="ttc" id="ahmac_8h_html_ae52e15bf214cc8c08a83f918c780ff83"><div class="ttname"><a href="hmac_8h.html#ae52e15bf214cc8c08a83f918c780ff83">hmacSha256CalculateMac</a></div><div class="ttdeci">void hmacSha256CalculateMac(void *dst, const void *key, size_t key_size, const void *src, size_t size)</div><div class="ttdoc">Simple all-in-one HMAC-SHA256 calculator.</div></div>
<div class="ttc" id="ahmac_8h_html_ae99080bc94ec78657271eed049abd6e9"><div class="ttname"><a href="hmac_8h.html#ae99080bc94ec78657271eed049abd6e9">hmacSha1CalculateMac</a></div><div class="ttdeci">void hmacSha1CalculateMac(void *dst, const void *key, size_t key_size, const void *src, size_t size)</div><div class="ttdoc">Simple all-in-one HMAC-SHA1 calculator.</div></div>
<div class="ttc" id="ahmac_8h_html_af9dea0ed545fedf95811dc1e57fdad96"><div class="ttname"><a href="hmac_8h.html#af9dea0ed545fedf95811dc1e57fdad96">hmacSha256ContextCreate</a></div><div class="ttdeci">void hmacSha256ContextCreate(HmacSha256Context *out, const void *key, size_t key_size)</div><div class="ttdoc">Initialize a HMAC-SHA256 context.</div></div>
<div class="ttc" id="asha1_8h_html"><div class="ttname"><a href="sha1_8h.html">sha1.h</a></div><div class="ttdoc">Hardware accelerated SHA1 implementation.</div></div>
<div class="ttc" id="asha256_8h_html"><div class="ttname"><a href="sha256_8h.html">sha256.h</a></div><div class="ttdoc">Hardware accelerated SHA256 implementation.</div></div>
<div class="ttc" id="astructHmacSha1Context_html"><div class="ttname"><a href="structHmacSha1Context.html">HmacSha1Context</a></div><div class="ttdoc">Context for HMAC-SHA1 operations.</div><div class="ttdef"><b>Definition</b> hmac.h:11</div></div>
<div class="ttc" id="astructHmacSha256Context_html"><div class="ttname"><a href="structHmacSha256Context.html">HmacSha256Context</a></div><div class="ttdoc">Context for HMAC-SHA256 operations.</div><div class="ttdef"><b>Definition</b> hmac.h:19</div></div>
<div class="ttc" id="astructSha1Context_html"><div class="ttname"><a href="structSha1Context.html">Sha1Context</a></div><div class="ttdoc">Context for SHA1 operations.</div><div class="ttdef"><b>Definition</b> sha1.h:18</div></div>
<div class="ttc" id="astructSha256Context_html"><div class="ttname"><a href="structSha256Context.html">Sha256Context</a></div><div class="ttdoc">Context for SHA256 operations.</div><div class="ttdef"><b>Definition</b> sha256.h:19</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:21</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.8
</small></address>
</body>
</html>