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

148 lines
17 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: RFC1751.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_fa77fa27b6f9b14852ffed773edfc41e.html">crypto</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">RFC1751.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_CRYPTO_RFC1751_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_CRYPTO_RFC1751_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;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a>&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="foldopen" id="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classripple_1_1RFC1751.html"> 9</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1RFC1751.html">RFC1751</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>{</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">static</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#af459389c62d84b58724ccacd7381728c">getKeyFromEnglish</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&amp; strKey, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; strHuman);</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">static</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a50b856967d944b469921298051e612d5">getEnglishFromKey</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&amp; strHuman, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; strKey);</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a93467ef6e16d8ef1ba9a9e21de9b5f6b">getWordFromBlob</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* blob, <span class="keywordtype">size_t</span> bytes);</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="keyword">private</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a8a2b6c8f1ea360d496c839963d93cee3">extract</a>(<span class="keywordtype">char</span> <span class="keyword">const</span>* s, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> length);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a4920c2875aeaaa69202c32ad850f64ee">btoe</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&amp; strHuman, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; strData);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">static</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a6926c806baab6753f2e911ba2ba5b67a">insert</a>(<span class="keywordtype">char</span>* s, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> length);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">static</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a25a3b2c7ca08637f945bfb1f4c09f9d1">standard</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&amp; strWord);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">static</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a034240ef7b8a14533d7f23e08bcedf21">wsrch</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; strWord, <span class="keywordtype">int</span> iMin, <span class="keywordtype">int</span> iMax);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">static</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_function" href="classripple_1_1RFC1751.html#a10c179bdbdd950867927eca2d9d455cf">etob</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&amp; strData, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::string&gt;</a> vsHuman);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1RFC1751.html#a35e69db1b4808a0a0115cd650e476148"> 42</a></span> <span class="keyword">static</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code hl_variable" href="classripple_1_1RFC1751.html#a35e69db1b4808a0a0115cd650e476148">s_dictionary</a>[];</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>};</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html"><div class="ttname"><a href="classripple_1_1RFC1751.html">ripple::RFC1751</a></div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8h_source.html#l00009">RFC1751.h:10</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a034240ef7b8a14533d7f23e08bcedf21"><div class="ttname"><a href="classripple_1_1RFC1751.html#a034240ef7b8a14533d7f23e08bcedf21">ripple::RFC1751::wsrch</a></div><div class="ttdeci">static int wsrch(std::string const &amp;strWord, int iMin, int iMax)</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00363">RFC1751.cpp:363</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a10c179bdbdd950867927eca2d9d455cf"><div class="ttname"><a href="classripple_1_1RFC1751.html#a10c179bdbdd950867927eca2d9d455cf">ripple::RFC1751::etob</a></div><div class="ttdeci">static int etob(std::string &amp;strData, std::vector&lt; std::string &gt; vsHuman)</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00397">RFC1751.cpp:397</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a25a3b2c7ca08637f945bfb1f4c09f9d1"><div class="ttname"><a href="classripple_1_1RFC1751.html#a25a3b2c7ca08637f945bfb1f4c09f9d1">ripple::RFC1751::standard</a></div><div class="ttdeci">static void standard(std::string &amp;strWord)</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00346">RFC1751.cpp:346</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a35e69db1b4808a0a0115cd650e476148"><div class="ttname"><a href="classripple_1_1RFC1751.html#a35e69db1b4808a0a0115cd650e476148">ripple::RFC1751::s_dictionary</a></div><div class="ttdeci">static char const * s_dictionary[]</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8h_source.html#l00042">RFC1751.h:42</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a4920c2875aeaaa69202c32ad850f64ee"><div class="ttname"><a href="classripple_1_1RFC1751.html#a4920c2875aeaaa69202c32ad850f64ee">ripple::RFC1751::btoe</a></div><div class="ttdeci">static void btoe(std::string &amp;strHuman, std::string const &amp;strData)</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00285">RFC1751.cpp:285</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a50b856967d944b469921298051e612d5"><div class="ttname"><a href="classripple_1_1RFC1751.html#a50b856967d944b469921298051e612d5">ripple::RFC1751::getEnglishFromKey</a></div><div class="ttdeci">static void getEnglishFromKey(std::string &amp;strHuman, std::string const &amp;strKey)</div><div class="ttdoc">Convert to human from a 128 bit key in big-endian format.</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00477">RFC1751.cpp:477</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a6926c806baab6753f2e911ba2ba5b67a"><div class="ttname"><a href="classripple_1_1RFC1751.html#a6926c806baab6753f2e911ba2ba5b67a">ripple::RFC1751::insert</a></div><div class="ttdeci">static void insert(char *s, int x, int start, int length)</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00307">RFC1751.cpp:307</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a8a2b6c8f1ea360d496c839963d93cee3"><div class="ttname"><a href="classripple_1_1RFC1751.html#a8a2b6c8f1ea360d496c839963d93cee3">ripple::RFC1751::extract</a></div><div class="ttdeci">static unsigned long extract(char const *s, int start, int length)</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00256">RFC1751.cpp:256</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_a93467ef6e16d8ef1ba9a9e21de9b5f6b"><div class="ttname"><a href="classripple_1_1RFC1751.html#a93467ef6e16d8ef1ba9a9e21de9b5f6b">ripple::RFC1751::getWordFromBlob</a></div><div class="ttdeci">static std::string getWordFromBlob(void const *blob, size_t bytes)</div><div class="ttdoc">Chooses a single dictionary word from the data.</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00488">RFC1751.cpp:488</a></div></div>
<div class="ttc" id="aclassripple_1_1RFC1751_html_af459389c62d84b58724ccacd7381728c"><div class="ttname"><a href="classripple_1_1RFC1751.html#af459389c62d84b58724ccacd7381728c">ripple::RFC1751::getKeyFromEnglish</a></div><div class="ttdeci">static int getKeyFromEnglish(std::string &amp;strKey, std::string const &amp;strHuman)</div><div class="ttdoc">Convert words separated by spaces into a 128 bit key in big-endian format.</div><div class="ttdef"><b>Definition</b> <a href="RFC1751_8cpp_source.html#l00444">RFC1751.cpp:444</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="astring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string.html">string</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/vector.html">vector</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