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/Role_8h_source.html
bthomee 7ca054b7d3 deploy: 3b810c305a
2025-11-10 09:36:27 -08:00

162 lines
20 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: Role.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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_42b876eb66f74e25995e23a7c0222dc7.html">rpc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Role.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_SERVER_ROLE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SERVER_ROLE_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;xrpl/beast/net/IPEndpoint.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/json/json_value.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/resource/ResourceManager.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/server/Handoff.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpl/server/Port.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;boost/asio/ip/network_v4.hpp&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;boost/asio/ip/network_v6.hpp&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;boost/utility/string_view.hpp&gt;</span></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><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="l00015" name="l00015"></a><span class="lineno"> 15</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="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c"> 25</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a> { <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca33e9232989576b5cfaa06654217d7a1a">GUEST</a>, <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca2e40ad879e955201df4dedbf8d479a12">USER</a>, <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca1ce51056a04cffe133dd6c79fea6f044">IDENTIFIED</a>, <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca73acd9a5972130b75066c82595a1fae3">ADMIN</a>, <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2cae69e6446e892e3922e76c82e96837920">PROXY</a>, <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2cae59518181ec60bb5370c94110f1cd4bf">FORBID</a> };</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><a class="code hl_enumeration" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><a class="code hl_function" href="namespaceripple.html#ae2f9460a615e369bb54e04a6d27ca7d9">requestRole</a>(</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_enumeration" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a> <span class="keyword">const</span>&amp; required,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> Port <span class="keyword">const</span>&amp; port,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>&amp; params,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <span class="keyword">const</span>&amp; remoteIp,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a> user);</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>Resource::Consumer</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><a class="code hl_function" href="namespaceripple.html#a2422ad0d92cb70e7328daf83e0bbd85a">requestInboundEndpoint</a>(</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> Resource::Manager&amp; manager,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_class" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> <span class="keyword">const</span>&amp; remoteAddress,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_enumeration" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a> <span class="keyword">const</span>&amp; role,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a> user,</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a> <a class="code hl_function" href="namespaceripple.html#aa1d2bbcba6f5e3838895165723dae5f0">forwardedFor</a>);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><a class="code hl_function" href="namespaceripple.html#a6909f61053b6e084f46665fa9f4ee673">isUnlimited</a>(<a class="code hl_enumeration" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a> <span class="keyword">const</span>&amp; role);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><a class="code hl_function" href="namespaceripple.html#ae526cb7431d0104912811e64227383f8">ipAllowed</a>(</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_typedef" href="namespacebeast_1_1IP.html#adbe597760cb20a7aa3f2ff92f7bed2cc">beast::IP::Address</a> <span class="keyword">const</span>&amp; remoteIp,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;boost::asio::ip::network_v4&gt;</a> <span class="keyword">const</span>&amp; nets4,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;boost::asio::ip::network_v6&gt;</a> <span class="keyword">const</span>&amp; nets6);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><a class="code hl_function" href="namespaceripple.html#aa1d2bbcba6f5e3838895165723dae5f0">forwardedFor</a>(<a class="code hl_typedef" href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">http_request_type</a> <span class="keyword">const</span>&amp; request);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_view_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></div></div>
<div class="ttc" id="aclassbeast_1_1IP_1_1Endpoint_html"><div class="ttname"><a href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a></div><div class="ttdoc">A version-independent IP address and port combination.</div><div class="ttdef"><b>Definition</b> <a href="IPEndpoint_8h_source.html#l00018">IPEndpoint.h:19</a></div></div>
<div class="ttc" id="anamespacebeast_1_1IP_html_adbe597760cb20a7aa3f2ff92f7bed2cc"><div class="ttname"><a href="namespacebeast_1_1IP.html#adbe597760cb20a7aa3f2ff92f7bed2cc">beast::IP::Address</a></div><div class="ttdeci">boost::asio::ip::address Address</div><div class="ttdef"><b>Definition</b> <a href="IPAddress_8h_source.html#l00020">IPAddress.h:20</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="anamespaceripple_html_a2422ad0d92cb70e7328daf83e0bbd85a"><div class="ttname"><a href="namespaceripple.html#a2422ad0d92cb70e7328daf83e0bbd85a">ripple::requestInboundEndpoint</a></div><div class="ttdeci">Resource::Consumer requestInboundEndpoint(Resource::Manager &amp;manager, beast::IP::Endpoint const &amp;remoteAddress, Role const &amp;role, std::string_view user, std::string_view forwardedFor)</div><div class="ttdef"><b>Definition</b> <a href="Role_8cpp_source.html#l00123">Role.cpp:123</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6909f61053b6e084f46665fa9f4ee673"><div class="ttname"><a href="namespaceripple.html#a6909f61053b6e084f46665fa9f4ee673">ripple::isUnlimited</a></div><div class="ttdeci">bool isUnlimited(Role const &amp;role)</div><div class="ttdoc">ADMIN and IDENTIFIED roles shall have unlimited resources.</div><div class="ttdef"><b>Definition</b> <a href="Role_8cpp_source.html#l00106">Role.cpp:106</a></div></div>
<div class="ttc" id="anamespaceripple_html_aa1d2bbcba6f5e3838895165723dae5f0"><div class="ttname"><a href="namespaceripple.html#aa1d2bbcba6f5e3838895165723dae5f0">ripple::forwardedFor</a></div><div class="ttdeci">std::string_view forwardedFor(http_request_type const &amp;request)</div><div class="ttdef"><b>Definition</b> <a href="Role_8cpp_source.html#l00243">Role.cpp:243</a></div></div>
<div class="ttc" id="anamespaceripple_html_aa265217edeb8282e636c78b50049f4c0"><div class="ttname"><a href="namespaceripple.html#aa265217edeb8282e636c78b50049f4c0">ripple::http_request_type</a></div><div class="ttdeci">boost::beast::http::request&lt; boost::beast::http::dynamic_body &gt; http_request_type</div><div class="ttdef"><b>Definition</b> <a href="Handoff_8h_source.html#l00013">Handoff.h:14</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2c"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">ripple::Role</a></div><div class="ttdeci">Role</div><div class="ttdoc">Indicates the level of administrative permission to grant.</div><div class="ttdef"><b>Definition</b> <a href="Role_8h_source.html#l00025">Role.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca1ce51056a04cffe133dd6c79fea6f044"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca1ce51056a04cffe133dd6c79fea6f044">ripple::Role::IDENTIFIED</a></div><div class="ttdeci">@ IDENTIFIED</div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca2e40ad879e955201df4dedbf8d479a12"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca2e40ad879e955201df4dedbf8d479a12">ripple::Role::USER</a></div><div class="ttdeci">@ USER</div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca33e9232989576b5cfaa06654217d7a1a"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca33e9232989576b5cfaa06654217d7a1a">ripple::Role::GUEST</a></div><div class="ttdeci">@ GUEST</div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca73acd9a5972130b75066c82595a1fae3"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca73acd9a5972130b75066c82595a1fae3">ripple::Role::ADMIN</a></div><div class="ttdeci">@ ADMIN</div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2cae59518181ec60bb5370c94110f1cd4bf"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2cae59518181ec60bb5370c94110f1cd4bf">ripple::Role::FORBID</a></div><div class="ttdeci">@ FORBID</div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2cae69e6446e892e3922e76c82e96837920"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2cae69e6446e892e3922e76c82e96837920">ripple::Role::PROXY</a></div><div class="ttdeci">@ PROXY</div></div>
<div class="ttc" id="anamespaceripple_html_ae2f9460a615e369bb54e04a6d27ca7d9"><div class="ttname"><a href="namespaceripple.html#ae2f9460a615e369bb54e04a6d27ca7d9">ripple::requestRole</a></div><div class="ttdeci">Role requestRole(Role const &amp;required, Port const &amp;port, Json::Value const &amp;params, beast::IP::Endpoint const &amp;remoteIp, std::string_view user)</div><div class="ttdoc">Return the allowed privilege role.</div><div class="ttdef"><b>Definition</b> <a href="Role_8cpp_source.html#l00076">Role.cpp:76</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae526cb7431d0104912811e64227383f8"><div class="ttname"><a href="namespaceripple.html#ae526cb7431d0104912811e64227383f8">ripple::ipAllowed</a></div><div class="ttdeci">bool ipAllowed(beast::IP::Address const &amp;remoteIp, std::vector&lt; boost::asio::ip::network_v4 &gt; const &amp;nets4, std::vector&lt; boost::asio::ip::network_v6 &gt; const &amp;nets6)</div><div class="ttdoc">True if remoteIp is in any of adminIp.</div><div class="ttdef"><b>Definition</b> <a href="Role_8cpp_source.html#l00027">Role.cpp:27</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