ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/Sign_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

146 lines
15 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: Sign.h Source File</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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_8d04e3c0b58cad28d7755ed462d1b6c0.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Sign.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_PROTOCOL_SIGN_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_PROTOCOL_SIGN_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/protocol/HashPrefix.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/protocol/PublicKey.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/protocol/STObject.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/protocol/SecretKey.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><a class="code hl_function" href="namespaceripple.html#a72ab42f87d2351b89ba8f47f5cfa70ba">sign</a>(</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> STObject&amp; st,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_enumeration" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bd">HashPrefix</a> <span class="keyword">const</span>&amp; prefix,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_enumeration" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> SecretKey <span class="keyword">const</span>&amp; sk,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_typedef" href="namespaceripple.html#a03c8cffd1833956fca7837f2f735401c">SF_VL</a> <span class="keyword">const</span>&amp; sigField = sfSignature);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><a class="code hl_function" href="namespaceripple.html#a3549cb4c3d81efe240ad20c147e48ac7">verify</a>(</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> STObject <span class="keyword">const</span>&amp; st,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_enumeration" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bd">HashPrefix</a> <span class="keyword">const</span>&amp; prefix,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> PublicKey <span class="keyword">const</span>&amp; pk,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_typedef" href="namespaceripple.html#a03c8cffd1833956fca7837f2f735401c">SF_VL</a> <span class="keyword">const</span>&amp; sigField = sfSignature);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>Serializer</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><a class="code hl_function" href="namespaceripple.html#a3bb99b88cdf3f0a2cc944c5daeaf00b6">buildMultiSigningData</a>(STObject <span class="keyword">const</span>&amp; obj, <a class="code hl_typedef" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> <span class="keyword">const</span>&amp; signingID);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>Serializer</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><a class="code hl_function" href="namespaceripple.html#a33c9bc54d3b0b2ea693de1fd821b1c3f">startMultiSigningData</a>(STObject <span class="keyword">const</span>&amp; obj);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">inline</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="namespaceripple.html#a27da45f422eb6323d237d8769806a2d3"> 65</a></span><a class="code hl_function" href="namespaceripple.html#a27da45f422eb6323d237d8769806a2d3">finishMultiSigningData</a>(<a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; signingID, <a class="code hl_class" href="classripple_1_1Serializer.html">Serializer</a>&amp; s)</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>{</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> s.<a class="code hl_function" href="classripple_1_1Serializer.html#a96daec54ca0c8ec7f6e7e683e9abbe0e">addBitString</a>(signingID);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>}</div>
</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1Serializer_html"><div class="ttname"><a href="classripple_1_1Serializer.html">ripple::Serializer</a></div><div class="ttdef"><b>Definition</b> <a href="Serializer_8h_source.html#l00021">Serializer.h:22</a></div></div>
<div class="ttc" id="aclassripple_1_1Serializer_html_a96daec54ca0c8ec7f6e7e683e9abbe0e"><div class="ttname"><a href="classripple_1_1Serializer.html#a96daec54ca0c8ec7f6e7e683e9abbe0e">ripple::Serializer::addBitString</a></div><div class="ttdeci">int addBitString(base_uint&lt; Bits, Tag &gt; const &amp;v)</div><div class="ttdef"><b>Definition</b> <a href="Serializer_8h_source.html#l00112">Serializer.h:112</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a00ae0d729cb3e35b6bcac9a27ebb5284"><div class="ttname"><a href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">ripple::AccountID</a></div><div class="ttdeci">base_uint&lt; 160, detail::AccountIDTag &gt; AccountID</div><div class="ttdoc">A 160-bit unsigned that uniquely identifies an account.</div><div class="ttdef"><b>Definition</b> <a href="AccountID_8h_source.html#l00029">AccountID.h:29</a></div></div>
<div class="ttc" id="anamespaceripple_html_a03c8cffd1833956fca7837f2f735401c"><div class="ttname"><a href="namespaceripple.html#a03c8cffd1833956fca7837f2f735401c">ripple::SF_VL</a></div><div class="ttdeci">TypedField&lt; STBlob &gt; SF_VL</div><div class="ttdef"><b>Definition</b> <a href="SField_8h_source.html#l00350">SField.h:350</a></div></div>
<div class="ttc" id="anamespaceripple_html_a27da45f422eb6323d237d8769806a2d3"><div class="ttname"><a href="namespaceripple.html#a27da45f422eb6323d237d8769806a2d3">ripple::finishMultiSigningData</a></div><div class="ttdeci">void finishMultiSigningData(AccountID const &amp;signingID, Serializer &amp;s)</div><div class="ttdef"><b>Definition</b> <a href="Sign_8h_source.html#l00065">Sign.h:65</a></div></div>
<div class="ttc" id="anamespaceripple_html_a33c9bc54d3b0b2ea693de1fd821b1c3f"><div class="ttname"><a href="namespaceripple.html#a33c9bc54d3b0b2ea693de1fd821b1c3f">ripple::startMultiSigningData</a></div><div class="ttdeci">Serializer startMultiSigningData(STObject const &amp;obj)</div><div class="ttdoc">Break the multi-signing hash computation into 2 parts for optimization.</div><div class="ttdef"><b>Definition</b> <a href="Sign_8cpp_source.html#l00085">Sign.cpp:85</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3549cb4c3d81efe240ad20c147e48ac7"><div class="ttname"><a href="namespaceripple.html#a3549cb4c3d81efe240ad20c147e48ac7">ripple::verify</a></div><div class="ttdeci">bool verify(PublicKey const &amp;publicKey, Slice const &amp;m, Slice const &amp;sig, bool mustBeFullyCanonical=true) noexcept</div><div class="ttdoc">Verify a signature on a message.</div><div class="ttdef"><b>Definition</b> <a href="PublicKey_8cpp_source.html#l00270">PublicKey.cpp:270</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3bb99b88cdf3f0a2cc944c5daeaf00b6"><div class="ttname"><a href="namespaceripple.html#a3bb99b88cdf3f0a2cc944c5daeaf00b6">ripple::buildMultiSigningData</a></div><div class="ttdeci">Serializer buildMultiSigningData(STObject const &amp;obj, AccountID const &amp;signingID)</div><div class="ttdoc">Return a Serializer suitable for computing a multisigning TxnSignature.</div><div class="ttdef"><b>Definition</b> <a href="Sign_8cpp_source.html#l00077">Sign.cpp:77</a></div></div>
<div class="ttc" id="anamespaceripple_html_a72ab42f87d2351b89ba8f47f5cfa70ba"><div class="ttname"><a href="namespaceripple.html#a72ab42f87d2351b89ba8f47f5cfa70ba">ripple::sign</a></div><div class="ttdeci">Buffer sign(PublicKey const &amp;pk, SecretKey const &amp;sk, Slice const &amp;message)</div><div class="ttdoc">Generate a signature for a message.</div><div class="ttdef"><b>Definition</b> <a href="SecretKey_8cpp_source.html#l00237">SecretKey.cpp:237</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9de744cfdefe1132969eb982e57e4dde"><div class="ttname"><a href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">ripple::KeyType</a></div><div class="ttdeci">KeyType</div><div class="ttdef"><b>Definition</b> <a href="KeyType_8h_source.html#l00009">KeyType.h:9</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad5143ceada01141772ae4aab984f94bd"><div class="ttname"><a href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bd">ripple::HashPrefix</a></div><div class="ttdeci">HashPrefix</div><div class="ttdoc">Prefix for hashing functions.</div><div class="ttdef"><b>Definition</b> <a href="HashPrefix_8h_source.html#l00036">HashPrefix.h:36</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink