mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
515 lines
31 KiB
HTML
515 lines
31 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>ArduinoLibs: SHA256 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">ArduinoLibs
|
|
</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><a href="modules.html"><span>Modules</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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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="classSHA256-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SHA256 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>SHA-256 hash algorithm.
|
|
<a href="classSHA256.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="SHA256_8h_source.html">SHA256.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SHA256:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classSHA256.png" usemap="#SHA256_map" alt=""/>
|
|
<map id="SHA256_map" name="SHA256_map">
|
|
<area href="classHash.html" title="Abstract base class for cryptographic hash algorithms. " alt="Hash" shape="rect" coords="0,0,59,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:ab672831c542df07ff03ded25760feec2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab672831c542df07ff03ded25760feec2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#ab672831c542df07ff03ded25760feec2">SHA256</a> ()</td></tr>
|
|
<tr class="memdesc:ab672831c542df07ff03ded25760feec2"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a SHA-256 hash object. <br/></td></tr>
|
|
<tr class="separator:ab672831c542df07ff03ded25760feec2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad82f2925b612de315b289017e023a73b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad82f2925b612de315b289017e023a73b"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#ad82f2925b612de315b289017e023a73b">~SHA256</a> ()</td></tr>
|
|
<tr class="memdesc:ad82f2925b612de315b289017e023a73b"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this SHA-256 hash object after clearing sensitive information. <br/></td></tr>
|
|
<tr class="separator:ad82f2925b612de315b289017e023a73b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a103d5bc5ced792464a82cb1d7986de94"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94">hashSize</a> () const </td></tr>
|
|
<tr class="memdesc:a103d5bc5ced792464a82cb1d7986de94"><td class="mdescLeft"> </td><td class="mdescRight">Size of the hash result from <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" title="Finalizes the hashing process and returns the hash. ">finalize()</a>. <a href="#a103d5bc5ced792464a82cb1d7986de94">More...</a><br/></td></tr>
|
|
<tr class="separator:a103d5bc5ced792464a82cb1d7986de94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71bbd9064f9d6191d0647f867953a858"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#a71bbd9064f9d6191d0647f867953a858">blockSize</a> () const </td></tr>
|
|
<tr class="memdesc:a71bbd9064f9d6191d0647f867953a858"><td class="mdescLeft"> </td><td class="mdescRight">Size of the internal block used by the hash algorithm. <a href="#a71bbd9064f9d6191d0647f867953a858">More...</a><br/></td></tr>
|
|
<tr class="separator:a71bbd9064f9d6191d0647f867953a858"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9d80d8fdccffb15497bd36285afce65"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65">reset</a> ()</td></tr>
|
|
<tr class="memdesc:ad9d80d8fdccffb15497bd36285afce65"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new hashing process. <a href="#ad9d80d8fdccffb15497bd36285afce65">More...</a><br/></td></tr>
|
|
<tr class="separator:ad9d80d8fdccffb15497bd36285afce65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a555bf8efb17afd4842d2e55a1f39f27b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b">update</a> (const void *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a555bf8efb17afd4842d2e55a1f39f27b"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with more data. <a href="#a555bf8efb17afd4842d2e55a1f39f27b">More...</a><br/></td></tr>
|
|
<tr class="separator:a555bf8efb17afd4842d2e55a1f39f27b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a695157bcdf5495ba892ebac309f3abd6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6">finalize</a> (void *hash, size_t len)</td></tr>
|
|
<tr class="memdesc:a695157bcdf5495ba892ebac309f3abd6"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the hashing process and returns the hash. <a href="#a695157bcdf5495ba892ebac309f3abd6">More...</a><br/></td></tr>
|
|
<tr class="separator:a695157bcdf5495ba892ebac309f3abd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add0d1649d533b27005ccd8508398c689"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#add0d1649d533b27005ccd8508398c689">clear</a> ()</td></tr>
|
|
<tr class="memdesc:add0d1649d533b27005ccd8508398c689"><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="#add0d1649d533b27005ccd8508398c689">More...</a><br/></td></tr>
|
|
<tr class="separator:add0d1649d533b27005ccd8508398c689"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2271683d6f1c7c103272f1dec55a6871"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871">resetHMAC</a> (const void *key, size_t keyLen)</td></tr>
|
|
<tr class="memdesc:a2271683d6f1c7c103272f1dec55a6871"><td class="mdescLeft"> </td><td class="mdescRight">Resets the hash ready for a new HMAC hashing process. <a href="#a2271683d6f1c7c103272f1dec55a6871">More...</a><br/></td></tr>
|
|
<tr class="separator:a2271683d6f1c7c103272f1dec55a6871"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28bc2510c5bdaf210a012f9f21a753cd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd">finalizeHMAC</a> (const void *key, size_t keyLen, void *hash, size_t hashLen)</td></tr>
|
|
<tr class="memdesc:a28bc2510c5bdaf210a012f9f21a753cd"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the HMAC hashing process and returns the hash. <a href="#a28bc2510c5bdaf210a012f9f21a753cd">More...</a><br/></td></tr>
|
|
<tr class="separator:a28bc2510c5bdaf210a012f9f21a753cd"><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>SHA-256 hash algorithm. </p>
|
|
<p>Reference: <a href="http://en.wikipedia.org/wiki/SHA-2">http://en.wikipedia.org/wiki/SHA-2</a></p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHA512.html" title="SHA-512 hash algorithm. ">SHA512</a>, <a class="el" href="classSHA1.html" title="SHA-1 hash algorithm. ">SHA1</a>, <a class="el" href="classBLAKE2s.html" title="BLAKE2s hash algorithm. ">BLAKE2s</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="SHA256_8h_source.html#l00028">28</a> of file <a class="el" href="SHA256_8h_source.html">SHA256.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a71bbd9064f9d6191d0647f867953a858"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t SHA256::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="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94" 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="SHA256_8cpp_source.html#l00061">61</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="add0d1649d533b27005ccd8508398c689"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SHA256::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="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65" 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="SHA256_8cpp_source.html#l00133">133</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a695157bcdf5495ba892ebac309f3abd6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SHA256::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="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94" 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="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94" 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="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94" title="Size of the hash result from finalize(). ">hashSize()</a>, then the remaining bytes will left unchanged.</p>
|
|
<p>If <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" 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="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65" 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="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd" 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="SHA256_8cpp_source.html#l00102">102</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a28bc2510c5bdaf210a012f9f21a753cd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SHA256::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="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871" 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="classSHA256.html#a103d5bc5ced792464a82cb1d7986de94" 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="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a>, <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" 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="SHA256_8cpp_source.html#l00146">146</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a103d5bc5ced792464a82cb1d7986de94"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t SHA256::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="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" 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="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classSHA256.html#a71bbd9064f9d6191d0647f867953a858" 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="SHA256_8cpp_source.html#l00056">56</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad9d80d8fdccffb15497bd36285afce65"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SHA256::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="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b" title="Updates the hash with more data. ">update()</a>, <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" title="Finalizes the hashing process and returns the hash. ">finalize()</a>, <a class="el" href="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871" 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="SHA256_8cpp_source.html#l00066">66</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2271683d6f1c7c103272f1dec55a6871"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SHA256::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="classSHA256.html#a2271683d6f1c7c103272f1dec55a6871" title="Resets the hash ready for a new HMAC hashing process. ">resetHMAC()</a> and <a class="el" href="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd" 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="classSHA256.html#a28bc2510c5bdaf210a012f9f21a753cd" title="Finalizes the HMAC hashing process and returns the hash. ">finalizeHMAC()</a>, <a class="el" href="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65" 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="SHA256_8cpp_source.html#l00139">139</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a555bf8efb17afd4842d2e55a1f39f27b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SHA256::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="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" title="Finalizes the hashing process and returns the hash. ">finalize()</a> has already been called, then the behavior of <a class="el" href="classSHA256.html#a555bf8efb17afd4842d2e55a1f39f27b" title="Updates the hash with more data. ">update()</a> will be undefined. Call <a class="el" href="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65" 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="classSHA256.html#ad9d80d8fdccffb15497bd36285afce65" title="Resets the hash ready for a new hashing process. ">reset()</a>, <a class="el" href="classSHA256.html#a695157bcdf5495ba892ebac309f3abd6" 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="SHA256_8cpp_source.html#l00080">80</a> of file <a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="SHA256_8h_source.html">SHA256.h</a></li>
|
|
<li><a class="el" href="SHA256_8cpp_source.html">SHA256.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Mar 25 2015 19:36:08 for ArduinoLibs 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>
|