mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
289 lines
20 KiB
HTML
289 lines
20 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: Poly1305 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="classPoly1305-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Poly1305 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator.
|
|
<a href="classPoly1305.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Poly1305_8h_source.html">Poly1305.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:a7d62e7cd2d67f1c72142580036066fa2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d62e7cd2d67f1c72142580036066fa2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#a7d62e7cd2d67f1c72142580036066fa2">Poly1305</a> ()</td></tr>
|
|
<tr class="memdesc:a7d62e7cd2d67f1c72142580036066fa2"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator. <br/></td></tr>
|
|
<tr class="separator:a7d62e7cd2d67f1c72142580036066fa2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac021b5ebbc123fa4c0ee36330472c25d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac021b5ebbc123fa4c0ee36330472c25d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#ac021b5ebbc123fa4c0ee36330472c25d">~Poly1305</a> ()</td></tr>
|
|
<tr class="memdesc:ac021b5ebbc123fa4c0ee36330472c25d"><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator after clearing all sensitive information. <br/></td></tr>
|
|
<tr class="separator:ac021b5ebbc123fa4c0ee36330472c25d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a544839403d0a19300c239708bc1e6ed8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8">reset</a> (const void *key)</td></tr>
|
|
<tr class="memdesc:a544839403d0a19300c239708bc1e6ed8"><td class="mdescLeft"> </td><td class="mdescRight">Resets the <a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator for a new session. <a href="#a544839403d0a19300c239708bc1e6ed8">More...</a><br/></td></tr>
|
|
<tr class="separator:a544839403d0a19300c239708bc1e6ed8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4e0b647ff93f501bd01459b1616557c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c">update</a> (const void *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ae4e0b647ff93f501bd01459b1616557c"><td class="mdescLeft"> </td><td class="mdescRight">Updates the message authenticator with more data. <a href="#ae4e0b647ff93f501bd01459b1616557c">More...</a><br/></td></tr>
|
|
<tr class="separator:ae4e0b647ff93f501bd01459b1616557c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab3fa6c5f6fa7d9ca6c82bead38f499c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c">finalize</a> (const void *nonce, void *token, size_t len)</td></tr>
|
|
<tr class="memdesc:aab3fa6c5f6fa7d9ca6c82bead38f499c"><td class="mdescLeft"> </td><td class="mdescRight">Finalizes the authentication process and returns the token. <a href="#aab3fa6c5f6fa7d9ca6c82bead38f499c">More...</a><br/></td></tr>
|
|
<tr class="separator:aab3fa6c5f6fa7d9ca6c82bead38f499c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaea2f40c1f22dcc2f8f690c793fb4388"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#aaea2f40c1f22dcc2f8f690c793fb4388">pad</a> ()</td></tr>
|
|
<tr class="memdesc:aaea2f40c1f22dcc2f8f690c793fb4388"><td class="mdescLeft"> </td><td class="mdescRight">Pads the input stream with zero bytes to a multiple of 16. <a href="#aaea2f40c1f22dcc2f8f690c793fb4388">More...</a><br/></td></tr>
|
|
<tr class="separator:aaea2f40c1f22dcc2f8f690c793fb4388"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3f3392b9a2bd0f3472e7e50dd7e21dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3f3392b9a2bd0f3472e7e50dd7e21dd"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPoly1305.html#ae3f3392b9a2bd0f3472e7e50dd7e21dd">clear</a> ()</td></tr>
|
|
<tr class="memdesc:ae3f3392b9a2bd0f3472e7e50dd7e21dd"><td class="mdescLeft"> </td><td class="mdescRight">Clears the authenticator's state, removing all sensitive data. <br/></td></tr>
|
|
<tr class="separator:ae3f3392b9a2bd0f3472e7e50dd7e21dd"><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="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator. </p>
|
|
<p><a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> is a message authenticator designed by Daniel J. Bernstein. An arbitrary-length message is broken up into 16-byte chunks and fed into a polynomial mod 2<sup>130</sup> - 5 based on the 16-byte authentication key. The final polynomial value is then combined with a 16-byte nonce to create the authentication token.</p>
|
|
<p>The following example demonstrates how to compute an authentication token for a message made up of several blocks under a specific key and nonce:</p>
|
|
<div class="fragment"><div class="line"><a class="code" href="classPoly1305.html">Poly1305</a> poly1305;</div>
|
|
<div class="line">uint8_t token[16];</div>
|
|
<div class="line">poly1305.<a class="code" href="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8">reset</a>(key);</div>
|
|
<div class="line">poly1305.<a class="code" href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c">update</a>(block1, <span class="keyword">sizeof</span>(block1));</div>
|
|
<div class="line">poly1305.<a class="code" href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c">update</a>(block2, <span class="keyword">sizeof</span>(block2));</div>
|
|
<div class="line">...</div>
|
|
<div class="line">poly1305.update(blockN, <span class="keyword">sizeof</span>(blockN));</div>
|
|
<div class="line">poly1305.<a class="code" href="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c">finalize</a>(nonce, token, <span class="keyword">sizeof</span>(token));</div>
|
|
</div><!-- fragment --><p>In the original <a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> specification, the nonce was encrypted with AES and a second 16-byte key. Since then, common practice has been for the caller to encrypt the nonce which gives the caller more flexibility as to how to derive and/or encrypt the nonce.</p>
|
|
<p>References: <a href="http://en.wikipedia.org/wiki/Poly1305-AES,">http://en.wikipedia.org/wiki/Poly1305-AES,</a> <a href="http://cr.yp.to/mac.html">http://cr.yp.to/mac.html</a> </p>
|
|
|
|
<p>Definition at line <a class="el" href="Poly1305_8h_source.html#l00029">29</a> of file <a class="el" href="Poly1305_8h_source.html">Poly1305.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aab3fa6c5f6fa7d9ca6c82bead38f499c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Poly1305::finalize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>nonce</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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">nonce</td><td>Points to the 16-bit nonce to combine with the token. </td></tr>
|
|
<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="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c" 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="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8" title="Resets the Poly1305 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="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8" title="Resets the Poly1305 message authenticator for a new session. ">reset()</a>, <a class="el" href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c" title="Updates the message authenticator with more data. ">update()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Poly1305_8cpp_source.html#l00182">182</a> of file <a class="el" href="Poly1305_8cpp_source.html">Poly1305.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaea2f40c1f22dcc2f8f690c793fb4388"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Poly1305::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="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c" title="Updates the message authenticator with more data. ">update()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Poly1305_8cpp_source.html#l00254">254</a> of file <a class="el" href="Poly1305_8cpp_source.html">Poly1305.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a544839403d0a19300c239708bc1e6ed8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Poly1305::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="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</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="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c" title="Updates the message authenticator with more data. ">update()</a>, <a class="el" href="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c" title="Finalizes the authentication process and returns the token. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Poly1305_8cpp_source.html#l00113">113</a> of file <a class="el" href="Poly1305_8cpp_source.html">Poly1305.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae4e0b647ff93f501bd01459b1616557c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Poly1305::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="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c" title="Finalizes the authentication process and returns the token. ">finalize()</a> has already been called, then the behavior of <a class="el" href="classPoly1305.html#ae4e0b647ff93f501bd01459b1616557c" title="Updates the message authenticator with more data. ">update()</a> will be undefined. Call <a class="el" href="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8" title="Resets the Poly1305 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="classPoly1305.html#aaea2f40c1f22dcc2f8f690c793fb4388" title="Pads the input stream with zero bytes to a multiple of 16. ">pad()</a>, <a class="el" href="classPoly1305.html#a544839403d0a19300c239708bc1e6ed8" title="Resets the Poly1305 message authenticator for a new session. ">reset()</a>, <a class="el" href="classPoly1305.html#aab3fa6c5f6fa7d9ca6c82bead38f499c" title="Finalizes the authentication process and returns the token. ">finalize()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="Poly1305_8cpp_source.html#l00145">145</a> of file <a class="el" href="Poly1305_8cpp_source.html">Poly1305.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="Poly1305_8h_source.html">Poly1305.h</a></li>
|
|
<li><a class="el" href="Poly1305_8cpp_source.html">Poly1305.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Aug 18 2016 18:42:11 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>
|