mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 09:46:12 +00:00
744 lines
38 KiB
HTML
744 lines
38 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Dash Core: src/torcontrol.cpp File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Dash Core
|
|
 <span id="projectnumber">0.12.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">P2P Digital Currency</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('torcontrol_8cpp.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">torcontrol.cpp File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="torcontrol_8h_source.html">torcontrol.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="utilstrencodings_8h_source.html">utilstrencodings.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="netbase_8h_source.html">netbase.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="net_8h_source.html">net.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="util_8h_source.html">util.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="hmac__sha256_8h_source.html">crypto/hmac_sha256.h</a>"</code><br />
|
|
<code>#include <vector></code><br />
|
|
<code>#include <deque></code><br />
|
|
<code>#include <set></code><br />
|
|
<code>#include <stdlib.h></code><br />
|
|
<code>#include <boost/function.hpp></code><br />
|
|
<code>#include <boost/bind.hpp></code><br />
|
|
<code>#include <boost/signals2/signal.hpp></code><br />
|
|
<code>#include <boost/foreach.hpp></code><br />
|
|
<code>#include <boost/algorithm/string/predicate.hpp></code><br />
|
|
<code>#include <boost/algorithm/string/split.hpp></code><br />
|
|
<code>#include <boost/algorithm/string/classification.hpp></code><br />
|
|
<code>#include <boost/algorithm/string/replace.hpp></code><br />
|
|
<code>#include <event2/bufferevent.h></code><br />
|
|
<code>#include <event2/buffer.h></code><br />
|
|
<code>#include <event2/util.h></code><br />
|
|
<code>#include <event2/event.h></code><br />
|
|
<code>#include <event2/thread.h></code><br />
|
|
</div>
|
|
<p><a href="torcontrol_8cpp_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlReply.html">TorControlReply</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html">TorControlConnection</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorController.html">TorController</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a450996d9fa7b80fb9dd650ce925e99b1"><td class="memItemLeft" align="right" valign="top">static std::pair< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a450996d9fa7b80fb9dd650ce925e99b1">SplitTorReplyLine</a> (const std::string &s)</td></tr>
|
|
<tr class="separator:a450996d9fa7b80fb9dd650ce925e99b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab098931a630a840f4787a611b135d7cb"><td class="memItemLeft" align="right" valign="top">static std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#ab098931a630a840f4787a611b135d7cb">ParseTorReplyMapping</a> (const std::string &s)</td></tr>
|
|
<tr class="separator:ab098931a630a840f4787a611b135d7cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad1e3628302e6d0dc9dea3ca5772f713"><td class="memItemLeft" align="right" valign="top">static std::pair< bool, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#aad1e3628302e6d0dc9dea3ca5772f713">ReadBinaryFile</a> (const std::string &filename, size_t maxsize=std::numeric_limits< size_t >::max())</td></tr>
|
|
<tr class="separator:aad1e3628302e6d0dc9dea3ca5772f713"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2cf864ba3770a65bc76b55c5dd244d8"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#ae2cf864ba3770a65bc76b55c5dd244d8">WriteBinaryFile</a> (const std::string &filename, const std::string &data)</td></tr>
|
|
<tr class="separator:ae2cf864ba3770a65bc76b55c5dd244d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bec9f0fc81ce833a74f5066024c9ee8"><td class="memItemLeft" align="right" valign="top">static std::vector< uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a3bec9f0fc81ce833a74f5066024c9ee8">ComputeResponse</a> (const std::string &key, const std::vector< uint8_t > &cookie, const std::vector< uint8_t > &clientNonce, const std::vector< uint8_t > &serverNonce)</td></tr>
|
|
<tr class="separator:a3bec9f0fc81ce833a74f5066024c9ee8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4faed3692d57a0d7bdbecf3b37f72de0"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a4faed3692d57a0d7bdbecf3b37f72de0">TorControlThread</a> ()</td></tr>
|
|
<tr class="separator:a4faed3692d57a0d7bdbecf3b37f72de0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0575786f1b850ed6c55e2c781813055"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#ab0575786f1b850ed6c55e2c781813055">StartTorControl</a> (boost::thread_group &threadGroup, <a class="el" href="classCScheduler.html">CScheduler</a> &scheduler)</td></tr>
|
|
<tr class="separator:ab0575786f1b850ed6c55e2c781813055"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3f2e0ce7300bbbedc6da69566e426e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#aa3f2e0ce7300bbbedc6da69566e426e6">InterruptTorControl</a> ()</td></tr>
|
|
<tr class="separator:aa3f2e0ce7300bbbedc6da69566e426e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af056d7647453338e57eca61f23aebb14"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#af056d7647453338e57eca61f23aebb14">StopTorControl</a> ()</td></tr>
|
|
<tr class="separator:af056d7647453338e57eca61f23aebb14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a48ca9f53bd923a35d926ac7d60f3bdd7"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a48ca9f53bd923a35d926ac7d60f3bdd7">DEFAULT_TOR_CONTROL</a> = "127.0.0.1:9051"</td></tr>
|
|
<tr class="separator:a48ca9f53bd923a35d926ac7d60f3bdd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8289e9ca9fcecfe4d62d5ef7d0c46666"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a8289e9ca9fcecfe4d62d5ef7d0c46666">TOR_COOKIE_SIZE</a> = 32</td></tr>
|
|
<tr class="separator:a8289e9ca9fcecfe4d62d5ef7d0c46666"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90f883aa42f56e372268f4a9a02d21e9"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a90f883aa42f56e372268f4a9a02d21e9">TOR_NONCE_SIZE</a> = 32</td></tr>
|
|
<tr class="separator:a90f883aa42f56e372268f4a9a02d21e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67609d1b844b80ced729e0545a30c8e3"><td class="memItemLeft" align="right" valign="top">static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a67609d1b844b80ced729e0545a30c8e3">TOR_SAFE_SERVERKEY</a> = "Tor safe cookie authentication server-to-controller hash"</td></tr>
|
|
<tr class="separator:a67609d1b844b80ced729e0545a30c8e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0035ea23177e0ca54b7075c9dc12bd00"><td class="memItemLeft" align="right" valign="top">static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a0035ea23177e0ca54b7075c9dc12bd00">TOR_SAFE_CLIENTKEY</a> = "Tor safe cookie authentication controller-to-server hash"</td></tr>
|
|
<tr class="separator:a0035ea23177e0ca54b7075c9dc12bd00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace06bec18eda894519f2d3b4e57feda5"><td class="memItemLeft" align="right" valign="top">static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#ace06bec18eda894519f2d3b4e57feda5">RECONNECT_TIMEOUT_START</a> = 1.0</td></tr>
|
|
<tr class="separator:ace06bec18eda894519f2d3b4e57feda5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46ab5d109e7d87492a491569bd2d18e7"><td class="memItemLeft" align="right" valign="top">static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a46ab5d109e7d87492a491569bd2d18e7">RECONNECT_TIMEOUT_EXP</a> = 1.5</td></tr>
|
|
<tr class="separator:a46ab5d109e7d87492a491569bd2d18e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bed00245e126b4eff6914757499fa03"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#a2bed00245e126b4eff6914757499fa03">MAX_LINE_LENGTH</a> = 100000</td></tr>
|
|
<tr class="separator:a2bed00245e126b4eff6914757499fa03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1a154f7530a81e9dd1d63fc6b98a5c7"><td class="memItemLeft" align="right" valign="top">struct event_base * </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#ab1a154f7530a81e9dd1d63fc6b98a5c7">base</a></td></tr>
|
|
<tr class="separator:ab1a154f7530a81e9dd1d63fc6b98a5c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea80dd9e709a405335a564668e8ebb77"><td class="memItemLeft" align="right" valign="top">boost::thread </td><td class="memItemRight" valign="bottom"><a class="el" href="torcontrol_8cpp.html#aea80dd9e709a405335a564668e8ebb77">torControlThread</a></td></tr>
|
|
<tr class="separator:aea80dd9e709a405335a564668e8ebb77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a3bec9f0fc81ce833a74f5066024c9ee8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3bec9f0fc81ce833a74f5066024c9ee8">◆ </a></span>ComputeResponse()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::vector<uint8_t> ComputeResponse </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint8_t > & </td>
|
|
<td class="paramname"><em>cookie</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint8_t > & </td>
|
|
<td class="paramname"><em>clientNonce</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint8_t > & </td>
|
|
<td class="paramname"><em>serverNonce</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Compute Tor SAFECOOKIE response.</p>
|
|
<p>ServerHash is computed as: HMAC-SHA256("Tor safe cookie authentication server-to-controller hash", CookieString | ClientNonce | ServerNonce) (with the HMAC key as its first argument)</p>
|
|
<p>After a controller sends a successful AUTHCHALLENGE command, the next command sent on the connection must be an AUTHENTICATE command, and the only authentication string which that AUTHENTICATE command will accept is:</p>
|
|
<p>HMAC-SHA256("Tor safe cookie authentication controller-to-server hash", CookieString | ClientNonce | ServerNonce) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00496">496</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00507">TorController::authchallenge_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3f2e0ce7300bbbedc6da69566e426e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3f2e0ce7300bbbedc6da69566e426e6">◆ </a></span>InterruptTorControl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void InterruptTorControl </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00686">686</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00197">Interrupt()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab098931a630a840f4787a611b135d7cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab098931a630a840f4787a611b135d7cb">◆ </a></span>ParseTorReplyMapping()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::map<std::string,std::string> ParseTorReplyMapping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Parse reply arguments in the form 'METHODS=COOKIE,SAFECOOKIE COOKIEFILE=".../control_auth_cookie"'. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00264">264</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00425">TorController::add_onion_cb()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00507">TorController::authchallenge_cb()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00538">TorController::protocolinfo_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad1e3628302e6d0dc9dea3ca5772f713"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad1e3628302e6d0dc9dea3ca5772f713">◆ </a></span>ReadBinaryFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::pair<bool,std::string> ReadBinaryFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>maxsize</em> = <code>std::numeric_limits<size_t>::max()</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Read full contents of a file and return them in a std::string. Returns a pair <status, string>. If an error occurred, status will be false, otherwise status will be true and the data will be returned in string.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxsize</td><td>Puts a maximum size limit on the file that is read. If the file is larger than this, truncated data (with len > maxsize) will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00312">312</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00538">TorController::protocolinfo_cb()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00393">TorController::TorController()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a450996d9fa7b80fb9dd650ce925e99b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a450996d9fa7b80fb9dd650ce925e99b1">◆ </a></span>SplitTorReplyLine()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::pair<std::string,std::string> SplitTorReplyLine </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00249">249</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00507">TorController::authchallenge_cb()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00538">TorController::protocolinfo_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0575786f1b850ed6c55e2c781813055"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0575786f1b850ed6c55e2c781813055">◆ </a></span>StartTorControl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void StartTorControl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">boost::thread_group & </td>
|
|
<td class="paramname"><em>threadGroup</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classCScheduler.html">CScheduler</a> & </td>
|
|
<td class="paramname"><em>scheduler</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00669">669</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00942">AppInit2()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af056d7647453338e57eca61f23aebb14"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af056d7647453338e57eca61f23aebb14">◆ </a></span>StopTorControl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void StopTorControl </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00694">694</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00315">Shutdown()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4faed3692d57a0d7bdbecf3b37f72de0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4faed3692d57a0d7bdbecf3b37f72de0">◆ </a></span>TorControlThread()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void TorControlThread </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00662">662</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00669">StartTorControl()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2cf864ba3770a65bc76b55c5dd244d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2cf864ba3770a65bc76b55c5dd244d8">◆ </a></span>WriteBinaryFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool WriteBinaryFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write contents of std::string to a file. </p><dl class="section return"><dt>Returns</dt><dd>true on success. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00332">332</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00425">TorController::add_onion_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="ab1a154f7530a81e9dd1d63fc6b98a5c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1a154f7530a81e9dd1d63fc6b98a5c7">◆ </a></span>base</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct event_base* base</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00659">659</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="dash-cli_8cpp_source.html#l00158">CallRPC()</a>, <a class="el" href="keepass_8cpp_source.html#l00292">CKeePassIntegrator::doHTTPPost()</a>, <a class="el" href="httpserver_8cpp_source.html#l00537">HTTPEvent::HTTPEvent()</a>, <a class="el" href="httpserver_8cpp_source.html#l00384">InitHTTPServer()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00686">InterruptTorControl()</a>, <a class="el" href="trafficgraphwidget_8cpp_source.html#l00076">TrafficGraphWidget::paintEvent()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00669">StartTorControl()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00694">StopTorControl()</a>, <a class="el" href="httpserver_8cpp_source.html#l00316">ThreadHTTP()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00662">TorControlThread()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a48ca9f53bd923a35d926ac7d60f3bdd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48ca9f53bd923a35d926ac7d60f3bdd7">◆ </a></span>DEFAULT_TOR_CONTROL</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string DEFAULT_TOR_CONTROL = "127.0.0.1:9051"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Default control port </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00029">29</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00384">HelpMessage()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00662">TorControlThread()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bed00245e126b4eff6914757499fa03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bed00245e126b4eff6914757499fa03">◆ </a></span>MAX_LINE_LENGTH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int MAX_LINE_LENGTH = 100000</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Maximum length for lines received on <a class="el" href="classTorControlConnection.html">TorControlConnection</a>. tor-control-spec.txt mentions that there is explicitly no limit defined to line length, this is belt-and-suspenders sanity limit to prevent memory exhaustion. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00046">46</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00132">TorControlConnection::readcb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46ab5d109e7d87492a491569bd2d18e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46ab5d109e7d87492a491569bd2d18e7">◆ </a></span>RECONNECT_TIMEOUT_EXP</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const float RECONNECT_TIMEOUT_EXP = 1.5</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Exponential backoff configuration - growth factor </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00041">41</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00618">TorController::disconnected_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ace06bec18eda894519f2d3b4e57feda5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace06bec18eda894519f2d3b4e57feda5">◆ </a></span>RECONNECT_TIMEOUT_START</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const float RECONNECT_TIMEOUT_START = 1.0</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Exponential backoff configuration - initial timeout in seconds </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00039">39</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00610">TorController::connected_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8289e9ca9fcecfe4d62d5ef7d0c46666"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8289e9ca9fcecfe4d62d5ef7d0c46666">◆ </a></span>TOR_COOKIE_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int TOR_COOKIE_SIZE = 32</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Tor cookie size (from control-spec.txt) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00031">31</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00538">TorController::protocolinfo_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90f883aa42f56e372268f4a9a02d21e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90f883aa42f56e372268f4a9a02d21e9">◆ </a></span>TOR_NONCE_SIZE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int TOR_NONCE_SIZE = 32</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Size of client/server nonce for SAFECOOKIE </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00033">33</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00538">TorController::protocolinfo_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0035ea23177e0ca54b7075c9dc12bd00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0035ea23177e0ca54b7075c9dc12bd00">◆ </a></span>TOR_SAFE_CLIENTKEY</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string TOR_SAFE_CLIENTKEY = "Tor safe cookie authentication controller-to-server hash"</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>For computing clientHash in SAFECOOKIE </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00037">37</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00507">TorController::authchallenge_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67609d1b844b80ced729e0545a30c8e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67609d1b844b80ced729e0545a30c8e3">◆ </a></span>TOR_SAFE_SERVERKEY</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string TOR_SAFE_SERVERKEY = "Tor safe cookie authentication server-to-controller hash"</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>For computing serverHash in SAFECOOKIE </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00035">35</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00507">TorController::authchallenge_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea80dd9e709a405335a564668e8ebb77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea80dd9e709a405335a564668e8ebb77">◆ </a></span>torControlThread</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::thread torControlThread</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00660">660</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00669">StartTorControl()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00694">StopTorControl()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="torcontrol_8cpp.html">torcontrol.cpp</a></li>
|
|
<li class="footer">Generated on Thu Dec 14 2017 13:15:11 for Dash Core by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|