mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 19:15:54 +00:00
156 lines
18 KiB
HTML
156 lines
18 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: 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 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&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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_PROTOCOL_SIGN_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_PROTOCOL_SIGN_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/protocol/HashPrefix.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/protocol/PublicKey.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/protocol/STObject.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <ripple/protocol/SecretKey.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="namespaceripple.html#a93d957d4aa50cd0c2b37f05453a0dd68">sign</a>(</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  STObject& st,</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bd">HashPrefix</a> <span class="keyword">const</span>& prefix,</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  SecretKey <span class="keyword">const</span>& sk,</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="namespaceripple.html#a82de550a2a342b5dedcdcd51f0828188">SF_Blob</a> <span class="keyword">const</span>& sigField = <a class="code" href="namespaceripple.html#a6925a9f817dd31a1903b95d285620277">sfSignature</a>);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="namespaceripple.html#a018bcf9b2ddbc1ace229d8c0a37fdd79">verify</a>(</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  STObject <span class="keyword">const</span>& st,</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bd">HashPrefix</a> <span class="keyword">const</span>& prefix,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  PublicKey <span class="keyword">const</span>& pk,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="namespaceripple.html#a82de550a2a342b5dedcdcd51f0828188">SF_Blob</a> <span class="keyword">const</span>& sigField = <a class="code" href="namespaceripple.html#a6925a9f817dd31a1903b95d285620277">sfSignature</a>);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> Serializer</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="namespaceripple.html#af191d8616acdfc276176e516985c2e1e">buildMultiSigningData</a>(STObject <span class="keyword">const</span>& obj, <a class="code" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> <span class="keyword">const</span>& signingID);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> Serializer</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <a class="code" href="namespaceripple.html#a042dbcb9466c5b62ce6f32f219561020">startMultiSigningData</a>(STObject <span class="keyword">const</span>& obj);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">inline</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="namespaceripple.html#a27da45f422eb6323d237d8769806a2d3"> 85</a></span> <a class="code" href="namespaceripple.html#a27da45f422eb6323d237d8769806a2d3">finishMultiSigningData</a>(<a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& signingID, <a class="code" href="classripple_1_1Serializer.html">Serializer</a>& s)</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> {</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  s.<a class="code" href="classripple_1_1Serializer.html#a96daec54ca0c8ec7f6e7e683e9abbe0e">addBitString</a>(signingID);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="autility_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a6925a9f817dd31a1903b95d285620277"><div class="ttname"><a href="namespaceripple.html#a6925a9f817dd31a1903b95d285620277">ripple::sfSignature</a></div><div class="ttdeci">const SF_Blob sfSignature(access, STI_VL, 6, "Signature", SField::sMD_Default, SField::notSigning)</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00460">SField.h:460</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 &signingID, Serializer &s)</div><div class="ttdef"><b>Definition:</b> <a href="Sign_8h_source.html#l00085">Sign.h:85</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a82de550a2a342b5dedcdcd51f0828188"><div class="ttname"><a href="namespaceripple.html#a82de550a2a342b5dedcdcd51f0828188">ripple::SF_Blob</a></div><div class="ttdeci">TypedField< STBlob > SF_Blob</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00326">SField.h:326</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a018bcf9b2ddbc1ace229d8c0a37fdd79"><div class="ttname"><a href="namespaceripple.html#a018bcf9b2ddbc1ace229d8c0a37fdd79">ripple::verify</a></div><div class="ttdeci">bool verify(PublicKey const &publicKey, Slice const &m, Slice const &sig, bool mustBeFullyCanonical)</div><div class="ttdoc">Verify a signature on a message.</div><div class="ttdef"><b>Definition:</b> <a href="PublicKey_8cpp_source.html#l00268">PublicKey.cpp:268</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</a></div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00063">base_uint.h:63</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#l00054">HashPrefix.h:54</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a042dbcb9466c5b62ce6f32f219561020"><div class="ttname"><a href="namespaceripple.html#a042dbcb9466c5b62ce6f32f219561020">ripple::startMultiSigningData</a></div><div class="ttdeci">Serializer startMultiSigningData(STObject const &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#l00095">Sign.cpp:95</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#l00028">KeyType.h:28</a></div></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#l00039">Serializer.h:39</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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< Bits, Tag > const &v)</div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8h_source.html#l00097">Serializer.h:97</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a93d957d4aa50cd0c2b37f05453a0dd68"><div class="ttname"><a href="namespaceripple.html#a93d957d4aa50cd0c2b37f05453a0dd68">ripple::sign</a></div><div class="ttdeci">Buffer sign(PublicKey const &pk, SecretKey const &sk, Slice const &m)</div><div class="ttdoc">Generate a signature for a message.</div><div class="ttdef"><b>Definition:</b> <a href="SecretKey_8cpp_source.html#l00124">SecretKey.cpp:124</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_af191d8616acdfc276176e516985c2e1e"><div class="ttname"><a href="namespaceripple.html#af191d8616acdfc276176e516985c2e1e">ripple::buildMultiSigningData</a></div><div class="ttdeci">Serializer buildMultiSigningData(STObject const &obj, AccountID const &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#l00087">Sign.cpp:87</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< 160, detail::AccountIDTag > 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#l00047">AccountID.h:47</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|