ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-07 23:42:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9b9dfd7e60772525a8e73c805127fb458d68feb9
rippled/Sign_8h_source.html
bthomee 6863531c3e deploy: 34ef577604
2026-02-04 06:53:36 -08:00

134 lines
14 KiB
HTML
Raw 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">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpl/protocol/HashPrefix.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/protocol/PublicKey.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/STObject.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/SecretKey.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><a class="code hl_function" href="namespacexrpl.html#aca8d3524fa9df703978f872ca8bf8c5a">sign</a>(STObject&amp; st, <a class="code hl_enumeration" href="namespacexrpl.html#ac599741e6d4066bada11df4c7e8ad30a">HashPrefix</a> <span class="keyword">const</span>&amp; prefix, <a class="code hl_enumeration" href="namespacexrpl.html#a0b0d50fcc4520f33b4417f1b74eee591">KeyType</a> type, SecretKey <span class="keyword">const</span>&amp; sk, <a class="code hl_typedef" href="namespacexrpl.html#a53b3863c8cb08d41d51ac72c976ea011">SF_VL</a> <span class="keyword">const</span>&amp; sigField = sfSignature);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><a class="code hl_function" href="namespacexrpl.html#a4947b0f613ec6e52fe87414063255880">verify</a>(STObject <span class="keyword">const</span>&amp; st, <a class="code hl_enumeration" href="namespacexrpl.html#ac599741e6d4066bada11df4c7e8ad30a">HashPrefix</a> <span class="keyword">const</span>&amp; prefix, PublicKey <span class="keyword">const</span>&amp; pk, <a class="code hl_typedef" href="namespacexrpl.html#a53b3863c8cb08d41d51ac72c976ea011">SF_VL</a> <span class="keyword">const</span>&amp; sigField = sfSignature);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>Serializer</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><a class="code hl_function" href="namespacexrpl.html#afbe482275ef9cfbc2b8743efe4bfd4a2">buildMultiSigningData</a>(STObject <span class="keyword">const</span>&amp; obj, <a class="code hl_typedef" href="namespacexrpl.html#a645fcf7e35dc370816f6dd8e2fd7f146">AccountID</a> <span class="keyword">const</span>&amp; signingID);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>Serializer</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><a class="code hl_function" href="namespacexrpl.html#a0a78836f3a983c62e0a77e3cc5e19c63">startMultiSigningData</a>(STObject <span class="keyword">const</span>&amp; obj);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">inline</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00055" data-start="{" data-end="}">
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a819f79fc3eae7da1f37734ded38e1e67"> 55</a></span><a class="code hl_function" href="namespacexrpl.html#a819f79fc3eae7da1f37734ded38e1e67">finishMultiSigningData</a>(<a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; signingID, <a class="code hl_class" href="classxrpl_1_1Serializer.html">Serializer</a>&amp; s)</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>{</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> s.<a class="code hl_function" href="classxrpl_1_1Serializer.html#a4b1bb193a1957758c626c785167a5c2e">addBitString</a>(signingID);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>}</div>
</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassxrpl_1_1Serializer_html"><div class="ttname"><a href="classxrpl_1_1Serializer.html">xrpl::Serializer</a></div><div class="ttdef"><b>Definition</b> <a href="Serializer_8h_source.html#l00020">Serializer.h:21</a></div></div>
<div class="ttc" id="aclassxrpl_1_1Serializer_html_a4b1bb193a1957758c626c785167a5c2e"><div class="ttname"><a href="classxrpl_1_1Serializer.html#a4b1bb193a1957758c626c785167a5c2e">xrpl::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#l00105">Serializer.h:105</a></div></div>
<div class="ttc" id="aclassxrpl_1_1base__uint_html"><div class="ttname"><a href="classxrpl_1_1base__uint.html">xrpl::base_uint&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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#l00005">algorithm.h:5</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a0a78836f3a983c62e0a77e3cc5e19c63"><div class="ttname"><a href="namespacexrpl.html#a0a78836f3a983c62e0a77e3cc5e19c63">xrpl::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#l00075">Sign.cpp:75</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a0b0d50fcc4520f33b4417f1b74eee591"><div class="ttname"><a href="namespacexrpl.html#a0b0d50fcc4520f33b4417f1b74eee591">xrpl::KeyType</a></div><div class="ttdeci">KeyType</div><div class="ttdef"><b>Definition</b> <a href="KeyType_8h_source.html#l00008">KeyType.h:8</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a4947b0f613ec6e52fe87414063255880"><div class="ttname"><a href="namespacexrpl.html#a4947b0f613ec6e52fe87414063255880">xrpl::verify</a></div><div class="ttdeci">bool verify(PublicKey const &amp;publicKey, Slice const &amp;m, Slice const &amp;sig) noexcept</div><div class="ttdoc">Verify a signature on a message.</div><div class="ttdef"><b>Definition</b> <a href="PublicKey_8cpp_source.html#l00249">PublicKey.cpp:249</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a53b3863c8cb08d41d51ac72c976ea011"><div class="ttname"><a href="namespacexrpl.html#a53b3863c8cb08d41d51ac72c976ea011">xrpl::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="anamespacexrpl_html_a645fcf7e35dc370816f6dd8e2fd7f146"><div class="ttname"><a href="namespacexrpl.html#a645fcf7e35dc370816f6dd8e2fd7f146">xrpl::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#l00028">AccountID.h:28</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a819f79fc3eae7da1f37734ded38e1e67"><div class="ttname"><a href="namespacexrpl.html#a819f79fc3eae7da1f37734ded38e1e67">xrpl::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#l00055">Sign.h:55</a></div></div>
<div class="ttc" id="anamespacexrpl_html_ac599741e6d4066bada11df4c7e8ad30a"><div class="ttname"><a href="namespacexrpl.html#ac599741e6d4066bada11df4c7e8ad30a">xrpl::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#l00034">HashPrefix.h:34</a></div></div>
<div class="ttc" id="anamespacexrpl_html_aca8d3524fa9df703978f872ca8bf8c5a"><div class="ttname"><a href="namespacexrpl.html#aca8d3524fa9df703978f872ca8bf8c5a">xrpl::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#l00228">SecretKey.cpp:228</a></div></div>
<div class="ttc" id="anamespacexrpl_html_afbe482275ef9cfbc2b8743efe4bfd4a2"><div class="ttname"><a href="namespacexrpl.html#afbe482275ef9cfbc2b8743efe4bfd4a2">xrpl::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#l00067">Sign.cpp:67</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