Files
rippled/NodeIdentity_8cpp_source.html
2025-11-04 00:36:48 -08:00

159 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" 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: NodeIdentity.cpp 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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_c1a59f40492cf594814ad34c94ddc6cd.html">main</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">NodeIdentity.cpp</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">#include &lt;xrpld/app/main/Application.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpld/app/main/NodeIdentity.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpld/app/rdb/Wallet.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/core/Config.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpld/core/ConfigSections.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</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><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;PublicKey, SecretKey&gt;</a></div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="}">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="namespaceripple.html#a57d87494c31ef261ae37438efe29bcbb"> 10</a></span><a class="code hl_function" href="namespaceripple.html#a57d87494c31ef261ae37438efe29bcbb">getNodeIdentity</a>(</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app,</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> boost::program_options::variables_map <span class="keyword">const</span>&amp; cmdline)</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;Seed&gt;</a> seed;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keywordflow">if</span> (cmdline.count(<span class="stringliteral">&quot;nodeid&quot;</span>))</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> seed = <a class="code hl_function" href="namespaceripple.html#ad5ae2f77fae45053e0971880a3622b0b">parseGenericSeed</a>(cmdline[<span class="stringliteral">&quot;nodeid&quot;</span>].as&lt;std::string&gt;(), <span class="keyword">false</span>);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">if</span> (!seed)</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;Invalid &#39;nodeid&#39; in command line&quot;</span>);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> }</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (app.<a class="code hl_function" href="classripple_1_1Application.html#a0c48dd5bcaef14e30e9ef5b96b0daa39">config</a>().<a class="code hl_function" href="classripple_1_1BasicConfig.html#a09b31b8ed3c769b4c23b040c3d4798ed">exists</a>(SECTION_NODE_SEED))</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> seed = parseBase58&lt;Seed&gt;(</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> app.<a class="code hl_function" href="classripple_1_1Application.html#a0c48dd5bcaef14e30e9ef5b96b0daa39">config</a>().<a class="code hl_function" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>(SECTION_NODE_SEED).<a class="code hl_function" href="classripple_1_1Section.html#a60800f99660b48b0ea548b6cb0136b0d">lines</a>().<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/container/vector/front.html">front</a>());</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">if</span> (!seed)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;Invalid [&quot;</span> SECTION_NODE_SEED</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="stringliteral">&quot;] in configuration file&quot;</span>);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">if</span> (seed)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">auto</span> secretKey = <a class="code hl_function" href="namespaceripple.html#a71e61a96c4e0813a7b69b53f4b1d986f">generateSecretKey</a>(<a class="code hl_enumvalue" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4ddea82c2b7829b8129e5a2d53665ba4b4757">KeyType::secp256k1</a>, *seed);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">auto</span> publicKey = <a class="code hl_function" href="namespaceripple.html#a701ede864bf93a008a22a2a7fee9bfb3">derivePublicKey</a>(<a class="code hl_enumvalue" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4ddea82c2b7829b8129e5a2d53665ba4b4757">KeyType::secp256k1</a>, secretKey);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">return</span> {publicKey, secretKey};</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">auto</span> db = app.<a class="code hl_function" href="classripple_1_1Application.html#a87067819596ce9f1ff84b61b3f1adf87">getWalletDB</a>().<a class="code hl_function" href="classripple_1_1DatabaseCon.html#a16c6f729c6462f6200b724543f5c67bc">checkoutDb</a>();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">if</span> (cmdline.count(<span class="stringliteral">&quot;newnodeid&quot;</span>) != 0)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_function" href="namespaceripple.html#aa974ec7bdead671dac5a44b542714a6e">clearNodeIdentity</a>(*db);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a57d87494c31ef261ae37438efe29bcbb">getNodeIdentity</a>(*db);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>}</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition</b> <a href="Application_8h_source.html#l00094">Application.h:95</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html_a0c48dd5bcaef14e30e9ef5b96b0daa39"><div class="ttname"><a href="classripple_1_1Application.html#a0c48dd5bcaef14e30e9ef5b96b0daa39">ripple::Application::config</a></div><div class="ttdeci">virtual Config &amp; config()=0</div></div>
<div class="ttc" id="aclassripple_1_1Application_html_a87067819596ce9f1ff84b61b3f1adf87"><div class="ttname"><a href="classripple_1_1Application.html#a87067819596ce9f1ff84b61b3f1adf87">ripple::Application::getWalletDB</a></div><div class="ttdeci">virtual DatabaseCon &amp; getWalletDB()=0</div><div class="ttdoc">Retrieve the &quot;wallet database&quot;.</div></div>
<div class="ttc" id="aclassripple_1_1BasicConfig_html_a09b31b8ed3c769b4c23b040c3d4798ed"><div class="ttname"><a href="classripple_1_1BasicConfig.html#a09b31b8ed3c769b4c23b040c3d4798ed">ripple::BasicConfig::exists</a></div><div class="ttdeci">bool exists(std::string const &amp;name) const</div><div class="ttdoc">Returns true if a section with the given name exists.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8cpp_source.html#l00111">BasicConfig.cpp:111</a></div></div>
<div class="ttc" id="aclassripple_1_1BasicConfig_html_a60aca585d76b1121dd4f72b358729456"><div class="ttname"><a href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">ripple::BasicConfig::section</a></div><div class="ttdeci">Section &amp; section(std::string const &amp;name)</div><div class="ttdoc">Returns the section with the given name.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8cpp_source.html#l00117">BasicConfig.cpp:117</a></div></div>
<div class="ttc" id="aclassripple_1_1DatabaseCon_html_a16c6f729c6462f6200b724543f5c67bc"><div class="ttname"><a href="classripple_1_1DatabaseCon.html#a16c6f729c6462f6200b724543f5c67bc">ripple::DatabaseCon::checkoutDb</a></div><div class="ttdeci">LockedSociSession checkoutDb()</div><div class="ttdef"><b>Definition</b> <a href="DatabaseCon_8h_source.html#l00171">DatabaseCon.h:171</a></div></div>
<div class="ttc" id="aclassripple_1_1Section_html_a60800f99660b48b0ea548b6cb0136b0d"><div class="ttname"><a href="classripple_1_1Section.html#a60800f99660b48b0ea548b6cb0136b0d">ripple::Section::lines</a></div><div class="ttdeci">std::vector&lt; std::string &gt; const &amp; lines() const</div><div class="ttdoc">Returns all the lines in the section.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8h_source.html#l00051">BasicConfig.h:51</a></div></div>
<div class="ttc" id="afront_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/front.html">std::vector::front</a></div><div class="ttdeci">T front(T... args)</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_a57d87494c31ef261ae37438efe29bcbb"><div class="ttname"><a href="namespaceripple.html#a57d87494c31ef261ae37438efe29bcbb">ripple::getNodeIdentity</a></div><div class="ttdeci">std::pair&lt; PublicKey, SecretKey &gt; getNodeIdentity(Application &amp;app, boost::program_options::variables_map const &amp;cmdline)</div><div class="ttdoc">The cryptographic credentials identifying this server instance.</div><div class="ttdef"><b>Definition</b> <a href="NodeIdentity_8cpp_source.html#l00010">NodeIdentity.cpp:10</a></div></div>
<div class="ttc" id="anamespaceripple_html_a701ede864bf93a008a22a2a7fee9bfb3"><div class="ttname"><a href="namespaceripple.html#a701ede864bf93a008a22a2a7fee9bfb3">ripple::derivePublicKey</a></div><div class="ttdeci">PublicKey derivePublicKey(KeyType type, SecretKey const &amp;sk)</div><div class="ttdoc">Derive the public key from a secret key.</div><div class="ttdef"><b>Definition</b> <a href="SecretKey_8cpp_source.html#l00312">SecretKey.cpp:312</a></div></div>
<div class="ttc" id="anamespaceripple_html_a71e61a96c4e0813a7b69b53f4b1d986f"><div class="ttname"><a href="namespaceripple.html#a71e61a96c4e0813a7b69b53f4b1d986f">ripple::generateSecretKey</a></div><div class="ttdeci">SecretKey generateSecretKey(KeyType type, Seed const &amp;seed)</div><div class="ttdoc">Generate a new secret key deterministically.</div><div class="ttdef"><b>Definition</b> <a href="SecretKey_8cpp_source.html#l00290">SecretKey.cpp:290</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9de744cfdefe1132969eb982e57e4ddea82c2b7829b8129e5a2d53665ba4b4757"><div class="ttname"><a href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4ddea82c2b7829b8129e5a2d53665ba4b4757">ripple::KeyType::secp256k1</a></div><div class="ttdeci">@ secp256k1</div></div>
<div class="ttc" id="anamespaceripple_html_aa974ec7bdead671dac5a44b542714a6e"><div class="ttname"><a href="namespaceripple.html#aa974ec7bdead671dac5a44b542714a6e">ripple::clearNodeIdentity</a></div><div class="ttdeci">void clearNodeIdentity(soci::session &amp;session)</div><div class="ttdoc">Delete any saved public/private key associated with this node.</div><div class="ttdef"><b>Definition</b> <a href="Wallet_8cpp_source.html#l00108">Wallet.cpp:108</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad5ae2f77fae45053e0971880a3622b0b"><div class="ttname"><a href="namespaceripple.html#ad5ae2f77fae45053e0971880a3622b0b">ripple::parseGenericSeed</a></div><div class="ttdeci">std::optional&lt; Seed &gt; parseGenericSeed(std::string const &amp;str, bool rfc1751=true)</div><div class="ttdoc">Attempt to parse a string as a seed.</div><div class="ttdef"><b>Definition</b> <a href="Seed_8cpp_source.html#l00078">Seed.cpp:78</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</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>