mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
155 lines
20 KiB
HTML
155 lines
20 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: 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 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_d5da7ddd3d406e00ccd5e9ec8a805734.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 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_CRYPTO_RFC1751_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_CRYPTO_RFC1751_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 <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classripple_1_1RFC1751.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1RFC1751.html">RFC1751</a></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">static</span> <span class="keywordtype">int</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classripple_1_1RFC1751.html#af459389c62d84b58724ccacd7381728c">getKeyFromEnglish</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>& strKey, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& strHuman);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">static</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="classripple_1_1RFC1751.html#a50b856967d944b469921298051e612d5">getEnglishFromKey</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>& strHuman, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& strKey);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" 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 name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" 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 name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classripple_1_1RFC1751.html#a4920c2875aeaaa69202c32ad850f64ee">btoe</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>& strHuman, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& strData);</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" 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 name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classripple_1_1RFC1751.html#a25a3b2c7ca08637f945bfb1f4c09f9d1">standard</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>& strWord);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">static</span> <span class="keywordtype">int</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classripple_1_1RFC1751.html#a034240ef7b8a14533d7f23e08bcedf21">wsrch</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& strWord, <span class="keywordtype">int</span> iMin, <span class="keywordtype">int</span> iMax);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">static</span> <span class="keywordtype">int</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classripple_1_1RFC1751.html#a10c179bdbdd950867927eca2d9d455cf">etob</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>& strData, <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<std::string></a> vsHuman);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classripple_1_1RFC1751.html#a35e69db1b4808a0a0115cd650e476148"> 61</a></span>  <span class="keyword">static</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="classripple_1_1RFC1751.html#a35e69db1b4808a0a0115cd650e476148">s_dictionary</a>[];</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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 &strWord)</div><div class="ttdef"><b>Definition:</b> <a href="RFC1751_8cpp_source.html#l00352">RFC1751.cpp:352</a></div></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 class="ttdoc">STL class.</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#l00028">RFC1751.h:28</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 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 &strHuman, std::string const &strData)</div><div class="ttdef"><b>Definition:</b> <a href="RFC1751_8cpp_source.html#l00293">RFC1751.cpp:293</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 &strData, std::vector< std::string > vsHuman)</div><div class="ttdef"><b>Definition:</b> <a href="RFC1751_8cpp_source.html#l00403">RFC1751.cpp:403</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 &strKey, std::string const &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#l00450">RFC1751.cpp:450</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#l00315">RFC1751.cpp:315</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#l00266">RFC1751.cpp:266</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 &strHuman, std::string const &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#l00483">RFC1751.cpp:483</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_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 &strWord, int iMin, int iMax)</div><div class="ttdef"><b>Definition:</b> <a href="RFC1751_8cpp_source.html#l00369">RFC1751.cpp:369</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#l00061">RFC1751.h:61</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#l00494">RFC1751.cpp:494</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>
|
|
<!-- 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>
|