mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
584 lines
37 KiB
HTML
584 lines
37 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: Hash 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="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classHash-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Hash Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Abstract base class for cryptographic hash algorithms.
|
|
<a href="classHash.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Hash_8h_source.html">Hash.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Hash:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classHash.png" usemap="#Hash_map" alt=""/>
|
|
<map id="Hash_map" name="Hash_map">
|
|
<area href="classBLAKE2b.html" title="BLAKE2b hash algorithm. " alt="BLAKE2b" shape="rect" coords="0,56,73,80"/>
|
|
<area href="classBLAKE2s.html" title="BLAKE2s hash algorithm. " alt="BLAKE2s" shape="rect" coords="83,56,156,80"/>
|
|
<area href="classSHA1.html" title="SHA-1 hash algorithm. " alt="SHA1" shape="rect" coords="166,56,239,80"/>
|
|
<area href="classSHA256.html" title="SHA-256 hash algorithm. " alt="SHA256" shape="rect" coords="249,56,322,80"/>
|
|
<area href="classSHA3__256.html" title="SHA3-256 hash algorithm. " alt="SHA3_256" shape="rect" coords="332,56,405,80"/>
|
|
<area href="classSHA3__512.html" title="SHA3-512 hash algorithm. " alt="SHA3_512" shape="rect" coords="415,56,488,80"/>
|
|
<area href="classSHA512.html" title="SHA-512 hash algorithm. " alt="SHA512" shape="rect" coords="498,56,571,80"/>
|
|
</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:af482880ad75b67a09d2dcb5e86244d80"><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"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new hash object. <br/></td></tr>
|
|
<tr class="separator:af482880ad75b67a09d2dcb5e86244d80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e4b4797dda8678aaed058bae155813e"><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"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this hash object. <a href="#a4e4b4797dda8678aaed058bae155813e">More...</a><br/></td></tr>
|
|
<tr class="separator:a4e4b4797dda8678aaed058bae155813e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcdd30de3e5ecaa2f798c0c5644d9ef8"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8">hashSize</a> () const =0</td></tr>
|
|
<tr class="memdesc:adcdd30de3e5ecaa2f798c0c5644d9ef8"><td class="mdescLeft"> </td><td class="mdescRight">Size of the hash result from <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a>. <a href="#adcdd30de3e5ecaa2f798c0c5644d9ef8">More...</a><br/></td></tr>
|
|
<tr class="separator:adcdd30de3e5ecaa2f798c0c5644d9ef8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e4297812e3483410556830fe5d47bdf"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#a4e4297812e3483410556830fe5d47bdf">blockSize</a> () const =0</td></tr>
|
|
<tr class="memdesc:a4e4297812e3483410556830fe5d47bdf"><td class="mdescLeft"> </td><td class="mdescRight">Size of the internal block used by the hash algorithm. <a href="#a4e4297812e3483410556830fe5d47bdf">More...</a><br/></td></tr>
|
|
<tr class="separator:a4e4297812e3483410556830fe5d47bdf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b94309acaa5f52386785fb780e5be61"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61">reset</a> ()=0</td></tr>
|
|
<tr class="memdesc:a7b94309acaa5f52386785fb780e5be61"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new hashing process. <a href="#a7b94309acaa5f52386785fb780e5be61">More...</a><br/></td></tr>
|
|
<tr class="separator:a7b94309acaa5f52386785fb780e5be61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec9761ee427d122e7450de8df200265c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c">update</a> (const void *data, size_t len)=0</td></tr>
|
|
<tr class="memdesc:aec9761ee427d122e7450de8df200265c"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with more data. <a href="#aec9761ee427d122e7450de8df200265c">More...</a><br/></td></tr>
|
|
<tr class="separator:aec9761ee427d122e7450de8df200265c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09b3ccec22763fc86b1415695862977c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c">finalize</a> (void *hash, size_t len)=0</td></tr>
|
|
<tr class="memdesc:a09b3ccec22763fc86b1415695862977c"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the hashing process and returns the hash. <a href="#a09b3ccec22763fc86b1415695862977c">More...</a><br/></td></tr>
|
|
<tr class="separator:a09b3ccec22763fc86b1415695862977c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a959469433cd9348ab7f3ac6228bb34"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#a4a959469433cd9348ab7f3ac6228bb34">clear</a> ()=0</td></tr>
|
|
<tr class="memdesc:a4a959469433cd9348ab7f3ac6228bb34"><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="#a4a959469433cd9348ab7f3ac6228bb34">More...</a><br/></td></tr>
|
|
<tr class="separator:a4a959469433cd9348ab7f3ac6228bb34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf50359c1f525af884721cc9034e7945"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945">resetHMAC</a> (const void *key, size_t keyLen)=0</td></tr>
|
|
<tr class="memdesc:adf50359c1f525af884721cc9034e7945"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new HMAC hashing process. <a href="#adf50359c1f525af884721cc9034e7945">More...</a><br/></td></tr>
|
|
<tr class="separator:adf50359c1f525af884721cc9034e7945"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab42fa5420cc0bda4321a3d3866cfd06"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06">finalizeHMAC</a> (const void *key, size_t keyLen, void *hash, size_t hashLen)=0</td></tr>
|
|
<tr class="memdesc:aab42fa5420cc0bda4321a3d3866cfd06"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the HMAC hashing process and returns the hash. <a href="#aab42fa5420cc0bda4321a3d3866cfd06">More...</a><br/></td></tr>
|
|
<tr class="separator:aab42fa5420cc0bda4321a3d3866cfd06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:ab6f40c9af91dc3d738d9fcce59af63cc"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Abstract base class for cryptographic hash algorithms. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><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>, <a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Hash_8h_source.html#l00029">29</a> of file <a class="el" href="Hash_8h_source.html">Hash.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a4e4b4797dda8678aaed058bae155813e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Hash::~Hash </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>Destroys this hash object. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Subclasses are responsible for clearing any sensitive data that remains in the hash object when it is destroyed.</dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classHash.html#a4a959469433cd9348ab7f3ac6228bb34" title="Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing ...">clear()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Hash_8cpp_source.html#l00048">48</a> of file <a class="el" href="Hash_8cpp_source.html">Hash.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a4e4297812e3483410556830fe5d47bdf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t Hash::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">pure 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="classHash.html#aec9761ee427d122e7450de8df200265c" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8" title="Size of the hash result from finalize(). ">hashSize()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#a4493a717bad8fa5cd35fe3aa36f25ab3">SHA3_512</a>, <a class="el" href="classSHA512.html#acf8b9bcb6be91ee70acc3700a2ffa1a1">SHA512</a>, <a class="el" href="classSHA3__256.html#a88a50ab6c2d4ad105cda2dd504d96e7c">SHA3_256</a>, <a class="el" href="classBLAKE2b.html#abec1b2320c3afaed12a29cf081b95fe2">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a9b5403734c20a0591d72a98912e4a305">BLAKE2s</a>, <a class="el" href="classSHA256.html#a71bbd9064f9d6191d0647f867953a858">SHA256</a>, and <a class="el" href="classSHA1.html#a816e3fd1a02cf1ecc67866cd8c7c309a">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4a959469433cd9348ab7f3ac6228bb34"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::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">pure 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="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#acfbc5e9b4d394f011d5132a2b156d260">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a21623759bd381285ebf7e75a00c9c8a9">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a0848885f52df51dc53949d32a206e72d">BLAKE2s</a>, <a class="el" href="classSHA512.html#a0a9104dce5f099aeba216e5fbcb1ee1a">SHA512</a>, <a class="el" href="classSHA3__256.html#a531467f995ef6fc901ad8c2b5776a8d1">SHA3_256</a>, <a class="el" href="classSHA256.html#add0d1649d533b27005ccd8508398c689">SHA256</a>, and <a class="el" href="classSHA1.html#a41a159d6565b04d3f620dcd720faaf3f">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a09b3ccec22763fc86b1415695862977c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::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">pure 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="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8" 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="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8" 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="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8" title="Size of the hash result from finalize(). ">hashSize()</a>, then the remaining bytes will left unchanged.</p>
|
|
<p>If <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" 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="classHash.html#a7b94309acaa5f52386785fb780e5be61" 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="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#ac0227aafb5f047bb50f0bd84df0b4b5b">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a0cd8146b7868bd0f4c24a3856f106d17">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a751a3d772cbe1cd1dad83dbd09853b1b">BLAKE2s</a>, <a class="el" href="classSHA512.html#afc136ad0e77de527b031db3fb8b32464">SHA512</a>, <a class="el" href="classSHA3__256.html#a8fe7cad1f83bd1bae1a0d521324247a1">SHA3_256</a>, <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6">SHA256</a>, and <a class="el" href="classSHA1.html#a5a6a8a6169aa48e0bccadb22a149ab7c">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aab42fa5420cc0bda4321a3d3866cfd06"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::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">pure 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="classHash.html#adf50359c1f525af884721cc9034e7945" 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="classHash.html#adcdd30de3e5ecaa2f798c0c5644d9ef8" 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="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#a25c9d2da26d01d46ba6b72c8a7905ea0">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a29fafbba26e3c1d896b4d4c428f7d52a">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a3f910f3bd48cc4a9c5330c31bcda31fc">BLAKE2s</a>, <a class="el" href="classSHA512.html#a1fe9533f0d3dfdb426eb3dc4bdc31904">SHA512</a>, <a class="el" href="classSHA3__256.html#a001215fa1b7d2c30717b4b5b1618d68c">SHA3_256</a>, <a class="el" href="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd">SHA256</a>, and <a class="el" href="classSHA1.html#a791db53fe9d6cc0e383b25f1da0a97b8">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab6f40c9af91dc3d738d9fcce59af63cc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::formatHMACKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>block</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>pad</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">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Formats a HMAC key into a block. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">block</td><td>The block to format the key into. Must be at least <a class="el" href="classHash.html#a4e4297812e3483410556830fe5d47bdf" title="Size of the internal block used by the hash algorithm. ">blockSize()</a> bytes in length. </td></tr>
|
|
<tr><td class="paramname">key</td><td>Points to the HMAC key for the hashing process. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the HMAC <em>key</em> in bytes. </td></tr>
|
|
<tr><td class="paramname">pad</td><td>Inner (0x36) or outer (0x5C) padding value to XOR with the formatted HMAC key.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This function is intended to help subclasses implement <a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a> by directly formatting the HMAC key into the subclass's internal block buffer and resetting the hash. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Hash_8cpp_source.html#l00162">162</a> of file <a class="el" href="Hash_8cpp_source.html">Hash.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adcdd30de3e5ecaa2f798c0c5644d9ef8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t Hash::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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Size of the hash result from <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" 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="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classHash.html#a4e4297812e3483410556830fe5d47bdf" title="Size of the internal block used by the hash algorithm. ">blockSize()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#a9f13e4d2b99dd204e96b11142e9c1803">SHA3_512</a>, <a class="el" href="classSHA512.html#a6ab3cc1e172eecf4796e4cac629e0a44">SHA512</a>, <a class="el" href="classSHA3__256.html#a2c5c08119d5ad853021f929a763784f3">SHA3_256</a>, <a class="el" href="classBLAKE2b.html#a7555de16f6918ab820170a7ed3098c89">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#af9f50aac096f92ba27b1b2dd48df4c52">BLAKE2s</a>, <a class="el" href="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94">SHA256</a>, and <a class="el" href="classSHA1.html#ab8cdb7233a8b81be07877049960ddfdd">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7b94309acaa5f52386785fb780e5be61"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::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">pure 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="classHash.html#aec9761ee427d122e7450de8df200265c" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#a435746d5a8b012f7c65050337cc4a23f">SHA3_512</a>, <a class="el" href="classSHA512.html#a0d009e8d9157c3f14323e68631c33e97">SHA512</a>, <a class="el" href="classSHA3__256.html#a57b5f29347a733e04fe47d60621f3202">SHA3_256</a>, <a class="el" href="classBLAKE2b.html#a917beae2ca6e9831a35717a526089e8a">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a778776d15316c182fdb2df5a89b3ca02">BLAKE2s</a>, <a class="el" href="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65">SHA256</a>, and <a class="el" href="classSHA1.html#ab71aaf39ed956320054861a2fbfa454f">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adf50359c1f525af884721cc9034e7945"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::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">pure 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="classHash.html#adf50359c1f525af884721cc9034e7945" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" 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="classHash.html#aab42fa5420cc0bda4321a3d3866cfd06" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#aac7133f420f2be0288965c2e863f389b">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#acb1ca4081c509d1c34b3aee465cd4494">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#a7f9745854704b34a508497105ca5e2fd">BLAKE2s</a>, <a class="el" href="classSHA512.html#a2427ad8bf8b6958df91bd5806986167c">SHA512</a>, <a class="el" href="classSHA3__256.html#a324fe4d268bbf23d7b492033fe3bc632">SHA3_256</a>, <a class="el" href="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871">SHA256</a>, and <a class="el" href="classSHA1.html#ad0a09a5100d59ff90c04ed5d4071b606">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aec9761ee427d122e7450de8df200265c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Hash::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">pure 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="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> has already been called, then the behavior of <a class="el" href="classHash.html#aec9761ee427d122e7450de8df200265c" title="Updates the hash with more data. ">update()</a> will be undefined. Call <a class="el" href="classHash.html#a7b94309acaa5f52386785fb780e5be61" 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="classHash.html#a7b94309acaa5f52386785fb780e5be61" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classHash.html#a09b3ccec22763fc86b1415695862977c" title="Finalizes the hashing process and returns the hash. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classSHA3__512.html#a0563e4c87150e6019671b4fe92fd63a4">SHA3_512</a>, <a class="el" href="classBLAKE2b.html#a468e48c66ce1738e11c922d133135069">BLAKE2b</a>, <a class="el" href="classBLAKE2s.html#aa192da2fa044b03cccaf11e87fdf9911">BLAKE2s</a>, <a class="el" href="classSHA512.html#a7d37a20d7ab431ab15d094f768b6a695">SHA512</a>, <a class="el" href="classSHA3__256.html#a8356957ea403c5da326fc6899b91ea71">SHA3_256</a>, <a class="el" href="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b">SHA256</a>, and <a class="el" href="classSHA1.html#aec77fbc5015f82bbf7055e535085656a">SHA1</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="Hash_8h_source.html">Hash.h</a></li>
|
|
<li><a class="el" href="Hash_8cpp_source.html">Hash.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>
|