mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
274 lines
19 KiB
HTML
274 lines
19 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: GHASH 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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="classGHASH-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GHASH Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Implementation of the <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> message authenticator.
|
|
<a href="classGHASH.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="GHASH_8h_source.html">GHASH.h</a>></code></p>
|
|
<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:a3a1abd0f641bccd9b4aa1f40beb8dca3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a1abd0f641bccd9b4aa1f40beb8dca3"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#a3a1abd0f641bccd9b4aa1f40beb8dca3">GHASH</a> ()</td></tr>
|
|
<tr class="memdesc:a3a1abd0f641bccd9b4aa1f40beb8dca3"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> message authenticator. <br/></td></tr>
|
|
<tr class="separator:a3a1abd0f641bccd9b4aa1f40beb8dca3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7f63a587adf1aa1ffcdc0a6e20584fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7f63a587adf1aa1ffcdc0a6e20584fd"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#ae7f63a587adf1aa1ffcdc0a6e20584fd">~GHASH</a> ()</td></tr>
|
|
<tr class="memdesc:ae7f63a587adf1aa1ffcdc0a6e20584fd"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> message authenticator. <br/></td></tr>
|
|
<tr class="separator:ae7f63a587adf1aa1ffcdc0a6e20584fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a479a3e8c37e320bf99f54b95bf5f4c55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#a479a3e8c37e320bf99f54b95bf5f4c55">reset</a> (const void *key)</td></tr>
|
|
<tr class="memdesc:a479a3e8c37e320bf99f54b95bf5f4c55"><td class="mdescLeft"> </td><td class="mdescRight">Resets the <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> message authenticator for a new session. <a href="#a479a3e8c37e320bf99f54b95bf5f4c55">More...</a><br/></td></tr>
|
|
<tr class="separator:a479a3e8c37e320bf99f54b95bf5f4c55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a235edb14c6ed1ec55ddda595816ef1c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7">update</a> (const void *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a235edb14c6ed1ec55ddda595816ef1c7"><td class="mdescLeft"> </td><td class="mdescRight">Updates the message authenticator with more data. <a href="#a235edb14c6ed1ec55ddda595816ef1c7">More...</a><br/></td></tr>
|
|
<tr class="separator:a235edb14c6ed1ec55ddda595816ef1c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab221298ca69c9612bfbfd3dedcb28307"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307">finalize</a> (void *token, size_t len)</td></tr>
|
|
<tr class="memdesc:ab221298ca69c9612bfbfd3dedcb28307"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the authentication process and returns the token. <a href="#ab221298ca69c9612bfbfd3dedcb28307">More...</a><br/></td></tr>
|
|
<tr class="separator:ab221298ca69c9612bfbfd3dedcb28307"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c38ee9313605f1d8b12dca7cd43e4ad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#a8c38ee9313605f1d8b12dca7cd43e4ad">pad</a> ()</td></tr>
|
|
<tr class="memdesc:a8c38ee9313605f1d8b12dca7cd43e4ad"><td class="mdescLeft"> </td><td class="mdescRight">Pads the input stream with zero bytes to a multiple of 16. <a href="#a8c38ee9313605f1d8b12dca7cd43e4ad">More...</a><br/></td></tr>
|
|
<tr class="separator:a8c38ee9313605f1d8b12dca7cd43e4ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b1ee789debf56f7f24807960ef0556e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b1ee789debf56f7f24807960ef0556e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGHASH.html#a4b1ee789debf56f7f24807960ef0556e">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a4b1ee789debf56f7f24807960ef0556e"><td class="mdescLeft"> </td><td class="mdescRight">Clears the authenticator's state, removing all sensitive data. <br/></td></tr>
|
|
<tr class="separator:a4b1ee789debf56f7f24807960ef0556e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Implementation of the <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> message authenticator. </p>
|
|
<p><a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> is the message authentication part of Galois Counter Mode (<a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a>).</p>
|
|
<dl class="section note"><dt>Note</dt><dd><a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> is not the same as GMAC. <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> implements the low level hashing primitive that is used by both <a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a> and GMAC. GMAC can be simulated using <a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a> and an empty plaintext/ciphertext.</dd></dl>
|
|
<p>References: <a href="http://csrc.nist.gov/publications/nistpubs/800-38D/SP-800-38D.pdf">NIST SP 800-38D</a>, <a href="http://en.wikipedia.org/wiki/Galois/Counter_Mode">http://en.wikipedia.org/wiki/Galois/Counter_Mode</a></p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGCM.html" title="Implementation of the Galois Counter Mode (GCM). ">GCM</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="GHASH_8h_source.html#l00029">29</a> of file <a class="el" href="GHASH_8h_source.html">GHASH.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ab221298ca69c9612bfbfd3dedcb28307"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void GHASH::finalize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>token</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>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Finalizes the authentication process and returns the token. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">token</td><td>The buffer to return the token value in. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The length of the <em>token</em> buffer between 0 and 16.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>If <em>len</em> is less than 16, then the token value will be truncated to the first <em>len</em> bytes. If <em>len</em> is greater than 16, then the remaining bytes will left unchanged.</p>
|
|
<p>If <a class="el" href="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307" title="Finalizes the authentication process and returns the token. ">finalize()</a> is called again, then the returned <em>token</em> value is undefined. Call <a class="el" href="classGHASH.html#a479a3e8c37e320bf99f54b95bf5f4c55" title="Resets the GHASH message authenticator for a new session. ">reset()</a> first to start a new authentication process.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGHASH.html#a479a3e8c37e320bf99f54b95bf5f4c55" title="Resets the GHASH message authenticator for a new session. ">reset()</a>, <a class="el" href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7" title="Updates the message authenticator with more data. ">update()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="GHASH_8cpp_source.html#l00121">121</a> of file <a class="el" href="GHASH_8cpp_source.html">GHASH.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8c38ee9313605f1d8b12dca7cd43e4ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void GHASH::pad </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Pads the input stream with zero bytes to a multiple of 16. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7" title="Updates the message authenticator with more data. ">update()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="GHASH_8cpp_source.html#l00137">137</a> of file <a class="el" href="GHASH_8cpp_source.html">GHASH.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a479a3e8c37e320bf99f54b95bf5f4c55"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void GHASH::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the <a class="el" href="classGHASH.html" title="Implementation of the GHASH message authenticator. ">GHASH</a> message authenticator for a new session. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>Points to the 16 byte authentication key.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7" title="Updates the message authenticator with more data. ">update()</a>, <a class="el" href="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307" title="Finalizes the authentication process and returns the token. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="GHASH_8cpp_source.html#l00067">67</a> of file <a class="el" href="GHASH_8cpp_source.html">GHASH.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a235edb14c6ed1ec55ddda595816ef1c7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void GHASH::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>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the message authenticator 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="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307" title="Finalizes the authentication process and returns the token. ">finalize()</a> has already been called, then the behavior of <a class="el" href="classGHASH.html#a235edb14c6ed1ec55ddda595816ef1c7" title="Updates the message authenticator with more data. ">update()</a> will be undefined. Call <a class="el" href="classGHASH.html#a479a3e8c37e320bf99f54b95bf5f4c55" title="Resets the GHASH message authenticator for a new session. ">reset()</a> first to start a new authentication process.</p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGHASH.html#a8c38ee9313605f1d8b12dca7cd43e4ad" title="Pads the input stream with zero bytes to a multiple of 16. ">pad()</a>, <a class="el" href="classGHASH.html#a479a3e8c37e320bf99f54b95bf5f4c55" title="Resets the GHASH message authenticator for a new session. ">reset()</a>, <a class="el" href="classGHASH.html#ab221298ca69c9612bfbfd3dedcb28307" title="Finalizes the authentication process and returns the token. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="GHASH_8cpp_source.html#l00085">85</a> of file <a class="el" href="GHASH_8cpp_source.html">GHASH.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="GHASH_8h_source.html">GHASH.h</a></li>
|
|
<li><a class="el" href="GHASH_8cpp_source.html">GHASH.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Aug 27 2016 14:32:20 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>
|