mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
608 lines
38 KiB
HTML
608 lines
38 KiB
HTML
<!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.6"/>
|
|
<title>Arduino Cryptography Library: BLAKE2s Class 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/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Arduino Cryptography Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classBLAKE2s-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">BLAKE2s Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> hash algorithm.
|
|
<a href="classBLAKE2s.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="BLAKE2s_8h_source.html">BLAKE2s.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BLAKE2s:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classBLAKE2s.png" usemap="#BLAKE2s_map" alt=""/>
|
|
<map id="BLAKE2s_map" name="BLAKE2s_map">
|
|
<area href="classHash.html" title="Abstract base class for cryptographic hash algorithms. " alt="Hash" shape="rect" coords="0,0,65,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7345f4e08c19d7a8c278282b46df21a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7345f4e08c19d7a8c278282b46df21a2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a7345f4e08c19d7a8c278282b46df21a2">BLAKE2s</a> ()</td></tr>
|
|
<tr class="memdesc:a7345f4e08c19d7a8c278282b46df21a2"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> hash object. <br/></td></tr>
|
|
<tr class="separator:a7345f4e08c19d7a8c278282b46df21a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b3187ecaa3d3c8febfbb40c0f779aa7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b3187ecaa3d3c8febfbb40c0f779aa7"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a4b3187ecaa3d3c8febfbb40c0f779aa7">~BLAKE2s</a> ()</td></tr>
|
|
<tr class="memdesc:a4b3187ecaa3d3c8febfbb40c0f779aa7"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> hash object after clearing sensitive information. <br/></td></tr>
|
|
<tr class="separator:a4b3187ecaa3d3c8febfbb40c0f779aa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9f50aac096f92ba27b1b2dd48df4c52"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52">hashSize</a> () const </td></tr>
|
|
<tr class="memdesc:af9f50aac096f92ba27b1b2dd48df4c52"><td class="mdescLeft"> </td><td class="mdescRight">Size of the hash result from <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a>. <a href="#af9f50aac096f92ba27b1b2dd48df4c52">More...</a><br/></td></tr>
|
|
<tr class="separator:af9f50aac096f92ba27b1b2dd48df4c52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b5403734c20a0591d72a98912e4a305"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a9b5403734c20a0591d72a98912e4a305">blockSize</a> () const </td></tr>
|
|
<tr class="memdesc:a9b5403734c20a0591d72a98912e4a305"><td class="mdescLeft"> </td><td class="mdescRight">Size of the internal block used by the hash algorithm. <a href="#a9b5403734c20a0591d72a98912e4a305">More...</a><br/></td></tr>
|
|
<tr class="separator:a9b5403734c20a0591d72a98912e4a305"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a778776d15316c182fdb2df5a89b3ca02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02">reset</a> ()</td></tr>
|
|
<tr class="memdesc:a778776d15316c182fdb2df5a89b3ca02"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new hashing process. <a href="#a778776d15316c182fdb2df5a89b3ca02">More...</a><br/></td></tr>
|
|
<tr class="separator:a778776d15316c182fdb2df5a89b3ca02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91ba6bc39e42002ac61114ced1d0af6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a91ba6bc39e42002ac61114ced1d0af6d">reset</a> (uint8_t outputLength)</td></tr>
|
|
<tr class="memdesc:a91ba6bc39e42002ac61114ced1d0af6d"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new hashing process with a specified output length. <a href="#a91ba6bc39e42002ac61114ced1d0af6d">More...</a><br/></td></tr>
|
|
<tr class="separator:a91ba6bc39e42002ac61114ced1d0af6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0edaf2a5d47e1e821a64421f26162f95"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a0edaf2a5d47e1e821a64421f26162f95">reset</a> (const void *key, size_t keyLen, uint8_t outputLength=32)</td></tr>
|
|
<tr class="memdesc:a0edaf2a5d47e1e821a64421f26162f95"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new hashing process with a specified key and output length. <a href="#a0edaf2a5d47e1e821a64421f26162f95">More...</a><br/></td></tr>
|
|
<tr class="separator:a0edaf2a5d47e1e821a64421f26162f95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa192da2fa044b03cccaf11e87fdf9911"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a> (const void *data, size_t len)</td></tr>
|
|
<tr class="memdesc:aa192da2fa044b03cccaf11e87fdf9911"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with more data. <a href="#aa192da2fa044b03cccaf11e87fdf9911">More...</a><br/></td></tr>
|
|
<tr class="separator:aa192da2fa044b03cccaf11e87fdf9911"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a751a3d772cbe1cd1dad83dbd09853b1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b">finalize</a> (void *hash, size_t len)</td></tr>
|
|
<tr class="memdesc:a751a3d772cbe1cd1dad83dbd09853b1b"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the hashing process and returns the hash. <a href="#a751a3d772cbe1cd1dad83dbd09853b1b">More...</a><br/></td></tr>
|
|
<tr class="separator:a751a3d772cbe1cd1dad83dbd09853b1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0848885f52df51dc53949d32a206e72d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a0848885f52df51dc53949d32a206e72d">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a0848885f52df51dc53949d32a206e72d"><td class="mdescLeft"> </td><td class="mdescRight">Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing process. <a href="#a0848885f52df51dc53949d32a206e72d">More...</a><br/></td></tr>
|
|
<tr class="separator:a0848885f52df51dc53949d32a206e72d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f9745854704b34a508497105ca5e2fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">resetHMAC</a> (const void *key, size_t keyLen)</td></tr>
|
|
<tr class="memdesc:a7f9745854704b34a508497105ca5e2fd"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new HMAC hashing process. <a href="#a7f9745854704b34a508497105ca5e2fd">More...</a><br/></td></tr>
|
|
<tr class="separator:a7f9745854704b34a508497105ca5e2fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f910f3bd48cc4a9c5330c31bcda31fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">finalizeHMAC</a> (const void *key, size_t keyLen, void *hash, size_t hashLen)</td></tr>
|
|
<tr class="memdesc:a3f910f3bd48cc4a9c5330c31bcda31fc"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the HMAC hashing process and returns the hash. <a href="#a3f910f3bd48cc4a9c5330c31bcda31fc">More...</a><br/></td></tr>
|
|
<tr class="separator:a3f910f3bd48cc4a9c5330c31bcda31fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classHash"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classHash')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classHash.html">Hash</a></td></tr>
|
|
<tr class="memitem:af482880ad75b67a09d2dcb5e86244d80 inherit pub_methods_classHash"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af482880ad75b67a09d2dcb5e86244d80"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#af482880ad75b67a09d2dcb5e86244d80">Hash</a> ()</td></tr>
|
|
<tr class="memdesc:af482880ad75b67a09d2dcb5e86244d80 inherit pub_methods_classHash"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new hash object. <br/></td></tr>
|
|
<tr class="separator:af482880ad75b67a09d2dcb5e86244d80 inherit pub_methods_classHash"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e4b4797dda8678aaed058bae155813e inherit pub_methods_classHash"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#a4e4b4797dda8678aaed058bae155813e">~Hash</a> ()</td></tr>
|
|
<tr class="memdesc:a4e4b4797dda8678aaed058bae155813e inherit pub_methods_classHash"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this hash object. <a href="#a4e4b4797dda8678aaed058bae155813e">More...</a><br/></td></tr>
|
|
<tr class="separator:a4e4b4797dda8678aaed058bae155813e inherit pub_methods_classHash"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_methods_classHash"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classHash')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classHash.html">Hash</a></td></tr>
|
|
<tr class="memitem:ab6f40c9af91dc3d738d9fcce59af63cc inherit pro_methods_classHash"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#ab6f40c9af91dc3d738d9fcce59af63cc">formatHMACKey</a> (void *block, const void *key, size_t len, uint8_t pad)</td></tr>
|
|
<tr class="memdesc:ab6f40c9af91dc3d738d9fcce59af63cc inherit pro_methods_classHash"><td class="mdescLeft"> </td><td class="mdescRight">Formats a HMAC key into a block. <a href="#ab6f40c9af91dc3d738d9fcce59af63cc">More...</a><br/></td></tr>
|
|
<tr class="separator:ab6f40c9af91dc3d738d9fcce59af63cc inherit pro_methods_classHash"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> hash algorithm. </p>
|
|
<p><a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> is a variation on the <a class="el" href="classChaCha.html" title="ChaCha stream cipher. ">ChaCha</a> stream cipher, designed for hashing, with a 256-bit hash output. It is intended as a high performance replacement for <a class="el" href="classSHA256.html" title="SHA-256 hash algorithm. ">SHA256</a> for when speed is critical but exact <a class="el" href="classSHA256.html" title="SHA-256 hash algorithm. ">SHA256</a> compatibility is not.</p>
|
|
<p>This class supports two types of keyed hash. The BLAKE2 keyed hash and traditional HMAC. The BLAKE2 keyed hash is recommended unless there is some higher-level application need to be compatible with the HMAC construction. The keyed hash is computed as follows:</p>
|
|
<div class="fragment"><div class="line"><a class="code" href="classBLAKE2s.html">BLAKE2s</a> blake;</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02">reset</a>(key, <span class="keyword">sizeof</span>(key), outputLength);</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data1, <span class="keyword">sizeof</span>(data1));</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data2, <span class="keyword">sizeof</span>(data2));</div>
|
|
<div class="line">...</div>
|
|
<div class="line">blake.update(dataN, <span class="keyword">sizeof</span>(dataN));</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b">finalize</a>(hash, outputLength);</div>
|
|
</div><!-- fragment --><p>The HMAC is computed as follows (the output length is always 32):</p>
|
|
<div class="fragment"><div class="line"><a class="code" href="classBLAKE2s.html">BLAKE2s</a> blake;</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">resetHMAC</a>(key, <span class="keyword">sizeof</span>(key));</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data1, <span class="keyword">sizeof</span>(data1));</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">update</a>(data2, <span class="keyword">sizeof</span>(data2));</div>
|
|
<div class="line">...</div>
|
|
<div class="line">blake.update(dataN, <span class="keyword">sizeof</span>(dataN));</div>
|
|
<div class="line">blake.<a class="code" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">finalizeHMAC</a>(key, <span class="keyword">sizeof</span>(key), hash, 32);</div>
|
|
</div><!-- fragment --><p>References: <a href="https://blake2.net/,">https://blake2.net/,</a> <a href="http://tools.ietf.org/html/rfc7693">RFC 7693</a></p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2b.html" title="BLAKE2b hash algorithm. ">BLAKE2b</a>, <a class="el" href="classSHA256.html" title="SHA-256 hash algorithm. ">SHA256</a>, <a class="el" href="classSHA3__256.html" title="SHA3-256 hash algorithm. ">SHA3_256</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8h_source.html#l00028">28</a> of file <a class="el" href="BLAKE2s_8h_source.html">BLAKE2s.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a9b5403734c20a0591d72a98912e4a305"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t BLAKE2s::blockSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Size of the internal block used by the hash algorithm. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" title="Size of the hash result from finalize(). ">hashSize()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#a4e4297812e3483410556830fe5d47bdf">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00094">94</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0848885f52df51dc53949d32a206e72d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::clear </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing process. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#a4a959469433cd9348ab7f3ac6228bb34">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00227">227</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a751a3d772cbe1cd1dad83dbd09853b1b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::finalize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>hash</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Finalizes the hashing process and returns the hash. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hash</td><td>The buffer to return the hash value in. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The length of the <em>hash</em> buffer, normally <a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" title="Size of the hash result from finalize(). ">hashSize()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>If <em>len</em> is less than <a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" title="Size of the hash result from finalize(). ">hashSize()</a>, then the hash value will be truncated to the first <em>len</em> bytes. If <em>len</em> is greater than <a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" title="Size of the hash result from finalize(). ">hashSize()</a>, then the remaining bytes will left unchanged.</p>
|
|
<p>If <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> is called again, then the returned <em>hash</em> value is undefined. Call <a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a> first to start a new hashing process.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00211">211</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3f910f3bd48cc4a9c5330c31bcda31fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::finalizeHMAC </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>keyLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>hash</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>hashLen</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Finalizes the HMAC hashing process and returns the hash. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>Points to the HMAC key for the hashing process. The contents of this array must be identical to the value passed to <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>. </td></tr>
|
|
<tr><td class="paramname">keyLen</td><td>Size of the HMAC <em>key</em> in bytes. </td></tr>
|
|
<tr><td class="paramname">hash</td><td>The buffer to return the hash value in. </td></tr>
|
|
<tr><td class="paramname">hashLen</td><td>The length of the <em>hash</em> buffer, normally <a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52" title="Size of the hash result from finalize(). ">hashSize()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00240">240</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af9f50aac096f92ba27b1b2dd48df4c52"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t BLAKE2s::hashSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Size of the hash result from <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a>. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classBLAKE2s.html#a9b5403734c20a0591d72a98912e4a305" title="Size of the internal block used by the hash algorithm. ">blockSize()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00089">89</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a778776d15316c182fdb2df5a89b3ca02"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the hash ready for a new hashing process. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00109">109</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a91ba6bc39e42002ac61114ced1d0af6d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>outputLength</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the hash ready for a new hashing process with a specified output length. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">outputLength</td><td>The output length to use for the final hash in bytes, between 1 and 32. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00130">130</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0edaf2a5d47e1e821a64421f26162f95"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>keyLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>outputLength</em> = <code>32</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the hash ready for a new hashing process with a specified key and output length. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>Points to the key. </td></tr>
|
|
<tr><td class="paramname">keyLen</td><td>The length of the key in bytes, between 0 and 32. </td></tr>
|
|
<tr><td class="paramname">outputLength</td><td>The output length to use for the final hash in bytes, between 1 and 32.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>If <em>keyLen</em> is greater than 32, then the <em>key</em> will be truncated to the first 32 bytes. </p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00160">160</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7f9745854704b34a508497105ca5e2fd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::resetHMAC </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>keyLen</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the hash ready for a new HMAC hashing process. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>Points to the HMAC key for the hashing process. </td></tr>
|
|
<tr><td class="paramname">keyLen</td><td>Size of the HMAC <em>key</em> in bytes.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The following example computes a HMAC over a series of data blocks with a specific key:</p>
|
|
<div class="fragment"><div class="line">hash.resetHMAC(key, <span class="keyword">sizeof</span>(key));</div>
|
|
<div class="line">hash.update(data1, <span class="keyword">sizeof</span>(data1));</div>
|
|
<div class="line">hash.update(data2, <span class="keyword">sizeof</span>(data2));</div>
|
|
<div class="line">...</div>
|
|
<div class="line">hash.update(dataN, <span class="keyword">sizeof</span>(dataN));</div>
|
|
<div class="line">hash.finalizeHMAC(key, <span class="keyword">sizeof</span>(key), hmac, <span class="keyword">sizeof</span>(hmac));</div>
|
|
</div><!-- fragment --><p>The same key must be passed to both <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00233">233</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa192da2fa044b03cccaf11e87fdf9911"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BLAKE2s::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the hash with more data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Data to be hashed. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes of data to be hashed.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>If <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> has already been called, then the behavior of <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911" title="Updates the hash with more data. ">update()</a> will be undefined. Call <a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a> first to start a new hashing process.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c">Hash</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="BLAKE2s_8cpp_source.html#l00189">189</a> of file <a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="BLAKE2s_8h_source.html">BLAKE2s.h</a></li>
|
|
<li><a class="el" href="BLAKE2s_8cpp_source.html">BLAKE2s.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Apr 27 2018 12:01:32 for Arduino Cryptography Library by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|