mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
179 lines
18 KiB
HTML
179 lines
18 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: SHAKE128 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="classSHAKE128-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SHAKE128 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Function (<a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>) with 128-bit security.
|
|
<a href="classSHAKE128.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="SHAKE_8h_source.html">SHAKE.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SHAKE128:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classSHAKE128.png" usemap="#SHAKE128_map" alt=""/>
|
|
<map id="SHAKE128_map" name="SHAKE128_map">
|
|
<area href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). " alt="SHAKE" shape="rect" coords="0,56,75,80"/>
|
|
<area href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). " alt="XOF" shape="rect" coords="0,0,75,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:a7d9d435780157e944eea931b3a13df0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d9d435780157e944eea931b3a13df0d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE128.html#a7d9d435780157e944eea931b3a13df0d">SHAKE128</a> ()</td></tr>
|
|
<tr class="memdesc:a7d9d435780157e944eea931b3a13df0d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> object with 128-bit security. <br/></td></tr>
|
|
<tr class="separator:a7d9d435780157e944eea931b3a13df0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d08d5987802636fa24c6245ebbe4288"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d08d5987802636fa24c6245ebbe4288"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE128.html#a1d08d5987802636fa24c6245ebbe4288">~SHAKE128</a> ()</td></tr>
|
|
<tr class="memdesc:a1d08d5987802636fa24c6245ebbe4288"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classSHAKE128.html" title="SHAKE Extendable-Output Function (XOF) with 128-bit security. ">SHAKE128</a> object after clearing all sensitive information. <br/></td></tr>
|
|
<tr class="separator:a1d08d5987802636fa24c6245ebbe4288"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classSHAKE"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSHAKE')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSHAKE.html">SHAKE</a></td></tr>
|
|
<tr class="memitem:a1729b9a96b71185166d68a2d98fb84e9 inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1729b9a96b71185166d68a2d98fb84e9"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#a1729b9a96b71185166d68a2d98fb84e9">~SHAKE</a> ()</td></tr>
|
|
<tr class="memdesc:a1729b9a96b71185166d68a2d98fb84e9 inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> object after clearing all sensitive information. <br/></td></tr>
|
|
<tr class="separator:a1729b9a96b71185166d68a2d98fb84e9 inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a635b2475049541f73eaf577ed8e67cb7 inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#a635b2475049541f73eaf577ed8e67cb7">blockSize</a> () const </td></tr>
|
|
<tr class="memdesc:a635b2475049541f73eaf577ed8e67cb7 inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Size of the internal block used by the <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a> algorithm, in bytes. <a href="#a635b2475049541f73eaf577ed8e67cb7">More...</a><br/></td></tr>
|
|
<tr class="separator:a635b2475049541f73eaf577ed8e67cb7 inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af199eea3c22bb193638827163c2b23db inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#af199eea3c22bb193638827163c2b23db">reset</a> ()</td></tr>
|
|
<tr class="memdesc:af199eea3c22bb193638827163c2b23db inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Resets the <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a> ready for a new session. <a href="#af199eea3c22bb193638827163c2b23db">More...</a><br/></td></tr>
|
|
<tr class="separator:af199eea3c22bb193638827163c2b23db inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6f3a32427433aabe20adccb6994a4aa inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#aa6f3a32427433aabe20adccb6994a4aa">update</a> (const void *data, size_t len)</td></tr>
|
|
<tr class="memdesc:aa6f3a32427433aabe20adccb6994a4aa inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Updates the <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a> with more data. <a href="#aa6f3a32427433aabe20adccb6994a4aa">More...</a><br/></td></tr>
|
|
<tr class="separator:aa6f3a32427433aabe20adccb6994a4aa inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3fe37617644e3498d40a86e846562fb inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#ac3fe37617644e3498d40a86e846562fb">extend</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ac3fe37617644e3498d40a86e846562fb inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Generates extendable output from this <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>. <a href="#ac3fe37617644e3498d40a86e846562fb">More...</a><br/></td></tr>
|
|
<tr class="separator:ac3fe37617644e3498d40a86e846562fb inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6621c9d1ffbf8c34780b901275ceb81f inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#a6621c9d1ffbf8c34780b901275ceb81f">encrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
|
|
<tr class="memdesc:a6621c9d1ffbf8c34780b901275ceb81f inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Encrypts an input buffer with extendable output from this <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>. <a href="#a6621c9d1ffbf8c34780b901275ceb81f">More...</a><br/></td></tr>
|
|
<tr class="separator:a6621c9d1ffbf8c34780b901275ceb81f inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab86f52425c1d5b0e5c924b4f96121fe0 inherit pub_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#ab86f52425c1d5b0e5c924b4f96121fe0">clear</a> ()</td></tr>
|
|
<tr class="memdesc:ab86f52425c1d5b0e5c924b4f96121fe0 inherit pub_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Clears the hash state, removing all sensitive data, and then resets the <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a> ready for a new session. <a href="#ab86f52425c1d5b0e5c924b4f96121fe0">More...</a><br/></td></tr>
|
|
<tr class="separator:ab86f52425c1d5b0e5c924b4f96121fe0 inherit pub_methods_classSHAKE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classXOF"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXOF')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXOF.html">XOF</a></td></tr>
|
|
<tr class="memitem:a855d1bb01d46b329c57b59783cd1e075 inherit pub_methods_classXOF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a855d1bb01d46b329c57b59783cd1e075"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXOF.html#a855d1bb01d46b329c57b59783cd1e075">XOF</a> ()</td></tr>
|
|
<tr class="memdesc:a855d1bb01d46b329c57b59783cd1e075 inherit pub_methods_classXOF"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a> object. <br/></td></tr>
|
|
<tr class="separator:a855d1bb01d46b329c57b59783cd1e075 inherit pub_methods_classXOF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5164ebb6aef3e5492f81ce5d685a00af inherit pub_methods_classXOF"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXOF.html#a5164ebb6aef3e5492f81ce5d685a00af">~XOF</a> ()</td></tr>
|
|
<tr class="memdesc:a5164ebb6aef3e5492f81ce5d685a00af inherit pub_methods_classXOF"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a> object. <a href="#a5164ebb6aef3e5492f81ce5d685a00af">More...</a><br/></td></tr>
|
|
<tr class="separator:a5164ebb6aef3e5492f81ce5d685a00af inherit pub_methods_classXOF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c322679dfd211cd77ae05fb201a32e8 inherit pub_methods_classXOF"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXOF.html#a1c322679dfd211cd77ae05fb201a32e8">decrypt</a> (uint8_t *output, const uint8_t *input, size_t len)</td></tr>
|
|
<tr class="memdesc:a1c322679dfd211cd77ae05fb201a32e8 inherit pub_methods_classXOF"><td class="mdescLeft"> </td><td class="mdescRight">Decrypts an input buffer with extendable output from this <a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>. <a href="#a1c322679dfd211cd77ae05fb201a32e8">More...</a><br/></td></tr>
|
|
<tr class="separator:a1c322679dfd211cd77ae05fb201a32e8 inherit pub_methods_classXOF"><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_classSHAKE"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classSHAKE')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classSHAKE.html">SHAKE</a></td></tr>
|
|
<tr class="memitem:a9346e4d53a9d7d686911ab772fc23387 inherit pro_methods_classSHAKE"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSHAKE.html#a9346e4d53a9d7d686911ab772fc23387">SHAKE</a> (size_t capacity)</td></tr>
|
|
<tr class="memdesc:a9346e4d53a9d7d686911ab772fc23387 inherit pro_methods_classSHAKE"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> object. <a href="#a9346e4d53a9d7d686911ab772fc23387">More...</a><br/></td></tr>
|
|
<tr class="separator:a9346e4d53a9d7d686911ab772fc23387 inherit pro_methods_classSHAKE"><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="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Function (<a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>) with 128-bit security. </p>
|
|
<p>Reference: <a href="http://en.wikipedia.org/wiki/SHA-3">http://en.wikipedia.org/wiki/SHA-3</a></p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSHAKE256.html" title="SHAKE Extendable-Output Function (XOF) with 256-bit security. ">SHAKE256</a>, <a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</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="SHAKE_8h_source.html#l00052">52</a> of file <a class="el" href="SHAKE_8h_source.html">SHAKE.h</a>.</p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="SHAKE_8h_source.html">SHAKE.h</a></li>
|
|
<li><a class="el" href="SHAKE_8cpp_source.html">SHAKE.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Apr 7 2018 10:23:43 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>
|