Files
rippled/structripple_1_1ripesha__hasher.html
2020-12-05 06:17:37 +00:00

261 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::ripesha_hasher Struct 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="structripple_1_1ripesha__hasher.html">ripesha_hasher</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="structripple_1_1ripesha__hasher-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::ripesha_hasher Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Returns the RIPEMD-160 digest of the SHA256 hash of the message.
<a href="structripple_1_1ripesha__hasher.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::ripesha_hasher:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1ripesha__hasher__coll__graph.png" border="0" usemap="#ripple_1_1ripesha__hasher_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1ripesha__hasher_coll__map" id="ripple_1_1ripesha__hasher_coll__map">
<area shape="rect" title="Returns the RIPEMD&#45;160 digest of the SHA256 hash of the message." alt="" coords="7,109,174,136"/>
<area shape="rect" href="structripple_1_1openssl__sha256__hasher.html" title="SHA&#45;256 digest." alt="" coords="5,5,176,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:abbb66f2384da0f7de0e459b56f929105"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ripesha__hasher.html#abbb66f2384da0f7de0e459b56f929105">result_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a>, 20 &gt;</td></tr>
<tr class="separator:abbb66f2384da0f7de0e459b56f929105"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:add726a953f1a77b31389137632e5525a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ripesha__hasher.html#add726a953f1a77b31389137632e5525a">operator()</a> (void const *data, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size) noexcept</td></tr>
<tr class="separator:add726a953f1a77b31389137632e5525a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3af2726d6247285ac81af46cfe0d80ee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ripesha__hasher.html#a3af2726d6247285ac81af46cfe0d80ee">operator result_type</a> () noexcept</td></tr>
<tr class="separator:a3af2726d6247285ac81af46cfe0d80ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aec6c27d8476371e8a7931798a6ae3556"><td class="memItemLeft" align="right" valign="top">static constexpr const auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ripesha__hasher.html#aec6c27d8476371e8a7931798a6ae3556">endian</a> = boost::endian::order::native</td></tr>
<tr class="separator:aec6c27d8476371e8a7931798a6ae3556"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ad0637774f689639fc00e31e7a0eb9b69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a99c0b0c19fdeb3344de589e1de43eca9">sha256_hasher</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ripesha__hasher.html#ad0637774f689639fc00e31e7a0eb9b69">h_</a></td></tr>
<tr class="separator:ad0637774f689639fc00e31e7a0eb9b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Returns the RIPEMD-160 digest of the SHA256 hash of the message. </p>
<p>This operation is used to compute the 160-bit identifier representing a Ripple account, from a message. Typically the message is the public key of the account - which is not stored in the account root.</p>
<p>The same computation is used regardless of the cryptographic scheme implied by the public key. For example, the public key may be an ed25519 public key or a secp256k1 public key. Support for new cryptographic systems may be added, using the same formula for calculating the account identifier.</p>
<p>Meets the requirements of Hasher (in hash_append) </p>
<p class="definition">Definition at line <a class="el" href="digest_8h_source.html#l00131">131</a> of file <a class="el" href="digest_8h_source.html">digest.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="abbb66f2384da0f7de0e459b56f929105"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbb66f2384da0f7de0e459b56f929105">&#9670;&nbsp;</a></span>result_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structripple_1_1ripesha__hasher.html#abbb66f2384da0f7de0e459b56f929105">ripple::ripesha_hasher::result_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a>, 20&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="digest_8h_source.html#l00139">139</a> of file <a class="el" href="digest_8h_source.html">digest.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="add726a953f1a77b31389137632e5525a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add726a953f1a77b31389137632e5525a">&#9670;&nbsp;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::ripesha_hasher::operator() </td>
<td>(</td>
<td class="paramtype">void const *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="digest_8h_source.html#l00142">142</a> of file <a class="el" href="digest_8h_source.html">digest.h</a>.</p>
</div>
</div>
<a id="a3af2726d6247285ac81af46cfe0d80ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3af2726d6247285ac81af46cfe0d80ee">&#9670;&nbsp;</a></span>operator result_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::ripesha_hasher::operator <a class="el" href="structripple_1_1ripesha__hasher.html#abbb66f2384da0f7de0e459b56f929105">result_type</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="digest_8h_source.html#l00147">147</a> of file <a class="el" href="digest_8h_source.html">digest.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad0637774f689639fc00e31e7a0eb9b69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0637774f689639fc00e31e7a0eb9b69">&#9670;&nbsp;</a></span>h_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a99c0b0c19fdeb3344de589e1de43eca9">sha256_hasher</a> ripple::ripesha_hasher::h_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="digest_8h_source.html#l00134">134</a> of file <a class="el" href="digest_8h_source.html">digest.h</a>.</p>
</div>
</div>
<a id="aec6c27d8476371e8a7931798a6ae3556"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec6c27d8476371e8a7931798a6ae3556">&#9670;&nbsp;</a></span>endian</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr const auto ripple::ripesha_hasher::endian = boost::endian::order::native</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="digest_8h_source.html#l00137">137</a> of file <a class="el" href="digest_8h_source.html">digest.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>