PRCYCoin  2.0.0.7rc1
P2P Digital Currency
torcontrol.cpp
Go to the documentation of this file.
1 // Copyright (c) 2015-2016 The Bitcoin Core developers
2 // Copyright (c) 2017 The Zcash developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #include "torcontrol.h"
7 
8 #include "chainparams.h"
9 #include "utilstrencodings.h"
10 #include "netbase.h"
11 #include "net.h"
12 #include "util.h"
13 #include "crypto/hmac_sha256.h"
14 
15 #include <vector>
16 #include <deque>
17 #include <set>
18 #include <stdlib.h>
19 
20 #include <boost/function.hpp>
21 #include <boost/bind.hpp>
22 #include <boost/signals2/signal.hpp>
23 #include <boost/algorithm/string/predicate.hpp>
24 #include <boost/algorithm/string/split.hpp>
25 #include <boost/algorithm/string/classification.hpp>
26 #include <boost/algorithm/string/replace.hpp>
27 
28 #include <event2/bufferevent.h>
29 #include <event2/buffer.h>
30 #include <event2/util.h>
31 #include <event2/event.h>
32 #include <event2/thread.h>
33 
35 const std::string DEFAULT_TOR_CONTROL = "127.0.0.1:9051";
37 static const int TOR_COOKIE_SIZE = 32;
39 static const int TOR_NONCE_SIZE = 32;
41 static const std::string TOR_SAFE_SERVERKEY = "Tor safe cookie authentication server-to-controller hash";
43 static const std::string TOR_SAFE_CLIENTKEY = "Tor safe cookie authentication controller-to-server hash";
45 static const float RECONNECT_TIMEOUT_START = 1.0;
47 static const float RECONNECT_TIMEOUT_EXP = 1.5;
52 static const int MAX_LINE_LENGTH = 100000;
53 
54 /****** Low-level TorControlConnection ********/
55 
58 {
59 public:
61 
62  int code;
63  std::vector<std::string> lines;
64 
65  void Clear()
66  {
67  code = 0;
68  lines.clear();
69  }
70 };
71 
76 {
77 public:
78  typedef boost::function<void(TorControlConnection&)> ConnectionCB;
79  typedef boost::function<void(TorControlConnection &,const TorControlReply &)> ReplyHandlerCB;
80 
83  TorControlConnection(struct event_base *base);
85 
93  bool Connect(const std::string &target, const ConnectionCB& connected, const ConnectionCB& disconnected);
94 
98  bool Disconnect();
99 
104  bool Command(const std::string &cmd, const ReplyHandlerCB& reply_handler);
105 
107  boost::signals2::signal<void(TorControlConnection &,const TorControlReply &)> async_handler;
108 private:
110  boost::function<void(TorControlConnection&)> connected;
112  boost::function<void(TorControlConnection&)> disconnected;
114  struct event_base *base;
116  struct bufferevent *b_conn;
120  std::deque<ReplyHandlerCB> reply_handlers;
121 
123  static void readcb(struct bufferevent *bev, void *ctx);
124  static void eventcb(struct bufferevent *bev, short what, void *ctx);
125 };
126 
128  base(_base), b_conn(0)
129 {
130 }
131 
133 {
134  if (b_conn)
135  bufferevent_free(b_conn);
136 }
137 
138 void TorControlConnection::readcb(struct bufferevent *bev, void *ctx)
139 {
141  struct evbuffer *input = bufferevent_get_input(bev);
142  size_t n_read_out = 0;
143  char *line;
144  assert(input);
145  // If there is not a whole line to read, evbuffer_readln returns NULL
146  while((line = evbuffer_readln(input, &n_read_out, EVBUFFER_EOL_CRLF)) != NULL)
147  {
148  std::string s(line, n_read_out);
149  free(line);
150  if (s.size() < 4) // Short line
151  continue;
152  // <status>(-|+| )<data><CRLF>
153  self->message.code = atoi(s.substr(0,3));
154  self->message.lines.push_back(s.substr(4));
155  char ch = s[3]; // '-','+' or ' '
156  if (ch == ' ') {
157  // Final line, dispatch reply and clean up
158  if (self->message.code >= 600) {
159  // Dispatch async notifications to async handler
160  // Synchronous and asynchronous messages are never interleaved
161  self->async_handler(*self, self->message);
162  } else {
163  if (!self->reply_handlers.empty()) {
164  // Invoke reply handler with message
165  self->reply_handlers.front()(*self, self->message);
166  self->reply_handlers.pop_front();
167  } else {
168  LogPrint(BCLog::TOR, "tor: Received unexpected sync reply %i\n", self->message.code);
169  }
170  }
171  self->message.Clear();
172  }
173  }
174  // Check for size of buffer - protect against memory exhaustion with very long lines
175  // Do this after evbuffer_readln to make sure all full lines have been
176  // removed from the buffer. Everything left is an incomplete line.
177  if (evbuffer_get_length(input) > MAX_LINE_LENGTH) {
178  LogPrintf("tor: Disconnecting because MAX_LINE_LENGTH exceeded\n");
179  self->Disconnect();
180  }
181 }
182 
183 void TorControlConnection::eventcb(struct bufferevent *bev, short what, void *ctx)
184 {
186  if (what & BEV_EVENT_CONNECTED) {
187  LogPrint(BCLog::TOR, "tor: Successfully connected!\n");
188  self->connected(*self);
189  } else if (what & (BEV_EVENT_EOF|BEV_EVENT_ERROR)) {
190  if (what & BEV_EVENT_ERROR) {
191  LogPrint(BCLog::TOR, "tor: Error connecting to Tor control socket\n");
192  } else {
193  LogPrint(BCLog::TOR, "tor: End of stream\n");
194  }
195  self->Disconnect();
196  self->disconnected(*self);
197  }
198 }
199 
200 bool TorControlConnection::Connect(const std::string &target, const ConnectionCB& _connected, const ConnectionCB& _disconnected)
201 {
202  if (b_conn)
203  Disconnect();
204  // Parse target address:port
205  struct sockaddr_storage connect_to_addr;
206  int connect_to_addrlen = sizeof(connect_to_addr);
207  if (evutil_parse_sockaddr_port(target.c_str(),
208  (struct sockaddr*)&connect_to_addr, &connect_to_addrlen)<0) {
209  LogPrintf("tor: Error parsing socket address %s\n", target);
210  return false;
211  }
212 
213  // Create a new socket, set up callbacks and enable notification bits
214  b_conn = bufferevent_socket_new(base, -1, BEV_OPT_CLOSE_ON_FREE);
215  if (!b_conn)
216  return false;
217  bufferevent_setcb(b_conn, TorControlConnection::readcb, NULL, TorControlConnection::eventcb, this);
218  bufferevent_enable(b_conn, EV_READ|EV_WRITE);
219  this->connected = _connected;
220  this->disconnected = _disconnected;
221 
222  // Finally, connect to target
223  if (bufferevent_socket_connect(b_conn, (struct sockaddr*)&connect_to_addr, connect_to_addrlen) < 0) {
224  LogPrintf("tor: Error connecting to address %s\n", target);
225  return false;
226  }
227  return true;
228 }
229 
231 {
232  if (b_conn)
233  bufferevent_free(b_conn);
234  b_conn = 0;
235  return true;
236 }
237 
238 bool TorControlConnection::Command(const std::string &cmd, const ReplyHandlerCB& reply_handler)
239 {
240  if (!b_conn)
241  return false;
242  struct evbuffer *buf = bufferevent_get_output(b_conn);
243  if (!buf)
244  return false;
245  evbuffer_add(buf, cmd.data(), cmd.size());
246  evbuffer_add(buf, "\r\n", 2);
247  reply_handlers.push_back(reply_handler);
248  return true;
249 }
250 
251 /****** General parsing utilities ********/
252 
253 /* Split reply line in the form 'AUTH METHODS=...' into a type
254  * 'AUTH' and arguments 'METHODS=...'.
255  * Grammar is implicitly defined in https://spec.torproject.org/control-spec by
256  * the server reply formats for PROTOCOLINFO (S3.21) and AUTHCHALLENGE (S3.24).
257  */
258 static std::pair<std::string,std::string> SplitTorReplyLine(const std::string &s)
259 {
260  size_t ptr=0;
261  std::string type;
262  while (ptr < s.size() && s[ptr] != ' ') {
263  type.push_back(s[ptr]);
264  ++ptr;
265  }
266  if (ptr < s.size())
267  ++ptr; // skip ' '
268  return make_pair(type, s.substr(ptr));
269 }
270 
277 static std::map<std::string,std::string> ParseTorReplyMapping(const std::string &s)
278 {
279  std::map<std::string,std::string> mapping;
280  size_t ptr=0;
281  while (ptr < s.size()) {
282  std::string key, value;
283  while (ptr < s.size() && s[ptr] != '=' && s[ptr] != ' ') {
284  key.push_back(s[ptr]);
285  ++ptr;
286  }
287  if (ptr == s.size()) // unexpected end of line
288  return std::map<std::string,std::string>();
289  if (s[ptr] == ' ') // The remaining string is an OptArguments
290  break;
291  ++ptr; // skip '='
292  if (ptr < s.size() && s[ptr] == '"') { // Quoted string
293  ++ptr; // skip opening '"'
294  bool escape_next = false;
295  while (ptr < s.size() && (escape_next || s[ptr] != '"')) {
296  // Repeated backslashes must be interpreted as pairs
297  escape_next = (s[ptr] == '\\' && !escape_next);
298  value.push_back(s[ptr]);
299  ++ptr;
300  }
301  if (ptr == s.size()) // unexpected end of line
302  return std::map<std::string,std::string>();
303  ++ptr; // skip closing '"'
314  std::string escaped_value;
315  for (size_t i = 0; i < value.size(); ++i) {
316  if (value[i] == '\\') {
317  // This will always be valid, because if the QuotedString
318  // ended in an odd number of backslashes, then the parser
319  // would already have returned above, due to a missing
320  // terminating double-quote.
321  ++i;
322  if (value[i] == 'n') {
323  escaped_value.push_back('\n');
324  } else if (value[i] == 't') {
325  escaped_value.push_back('\t');
326  } else if (value[i] == 'r') {
327  escaped_value.push_back('\r');
328  } else if ('0' <= value[i] && value[i] <= '7') {
329  size_t j;
330  // Octal escape sequences have a limit of three octal digits,
331  // but terminate at the first character that is not a valid
332  // octal digit if encountered sooner.
333  for (j = 1; j < 3 && (i+j) < value.size() && '0' <= value[i+j] && value[i+j] <= '7'; ++j) {}
334  // Tor restricts first digit to 0-3 for three-digit octals.
335  // A leading digit of 4-7 would therefore be interpreted as
336  // a two-digit octal.
337  if (j == 3 && value[i] > '3') {
338  j--;
339  }
340  escaped_value.push_back(strtol(value.substr(i, j).c_str(), NULL, 8));
341  // Account for automatic incrementing at loop end
342  i += j - 1;
343  } else {
344  escaped_value.push_back(value[i]);
345  }
346  } else {
347  escaped_value.push_back(value[i]);
348  }
349  }
350  value = escaped_value;
351  } else { // Unquoted value. Note that values can contain '=' at will, just no spaces
352  while (ptr < s.size() && s[ptr] != ' ') {
353  value.push_back(s[ptr]);
354  ++ptr;
355  }
356  }
357  if (ptr < s.size() && s[ptr] == ' ')
358  ++ptr; // skip ' ' after key=value
359  mapping[key] = value;
360  }
361  return mapping;
362 }
363 
371 static std::pair<bool,std::string> ReadBinaryFile(const fs::path &filename, size_t maxsize=std::numeric_limits<size_t>::max())
372 {
373  FILE *f = fsbridge::fopen(filename, "rb");
374  if (f == NULL)
375  return std::make_pair(false,"");
376  std::string retval;
377  char buffer[128];
378  size_t n;
379  while ((n=fread(buffer, 1, sizeof(buffer), f)) > 0) {
380  // Check for reading errors so we don't return any data if we couldn't
381  // read the entire file (or up to maxsize)
382  if (ferror(f)) {
383  fclose(f);
384  return std::make_pair(false,"");
385  }
386  retval.append(buffer, buffer+n);
387  if (retval.size() > maxsize)
388  break;
389  }
390  fclose(f);
391  return std::make_pair(true,retval);
392 }
393 
397 static bool WriteBinaryFile(const fs::path &filename, const std::string &data)
398 {
399  FILE *f = fsbridge::fopen(filename, "wb");
400  if (f == NULL)
401  return false;
402  if (fwrite(data.data(), 1, data.size(), f) != data.size()) {
403  fclose(f);
404  return false;
405  }
406  fclose(f);
407  return true;
408 }
409 
410 /****** Bitcoin specific TorController implementation ********/
411 
416 {
417 public:
418  TorController(struct event_base* base, const std::string& target);
419  ~TorController();
420 
422  fs::path GetPrivateKeyFile();
423 
425  void Reconnect();
426 private:
427  struct event_base* base;
428  std::string target;
430  std::string private_key;
431  std::string service_id;
432  bool reconnect;
433  struct event *reconnect_ev;
437  std::vector<uint8_t> cookie;
439  std::vector<uint8_t> clientNonce;
440 
444  void auth_cb(TorControlConnection& conn, const TorControlReply& reply);
453 
455  static void reconnect_cb(evutil_socket_t fd, short what, void *arg);
456 };
457 
458 TorController::TorController(struct event_base* _base, const std::string& _target):
459  base(_base),
460  target(_target), conn(base), reconnect(true), reconnect_ev(0),
461  reconnect_timeout(RECONNECT_TIMEOUT_START)
462 {
463  reconnect_ev = event_new(base, -1, 0, reconnect_cb, this);
464  if (!reconnect_ev)
465  LogPrintf("tor: Failed to create event for reconnection: out of memory?\n");
466  // Start connection attempts immediately
467  if (!conn.Connect(_target, boost::bind(&TorController::connected_cb, this, _1),
468  boost::bind(&TorController::disconnected_cb, this, _1) )) {
469  LogPrintf("tor: Initiating connection to Tor control port %s failed\n", _target);
470  }
471  // Read service private key if cached
472  std::pair<bool,std::string> pkf = ReadBinaryFile(GetPrivateKeyFile());
473  if (pkf.first) {
474  LogPrint(BCLog::TOR, "tor: Reading cached private key from %s\n", GetPrivateKeyFile().string());
475  private_key = pkf.second;
476  }
477 }
478 
480 {
481  if (reconnect_ev) {
482  event_free(reconnect_ev);
483  reconnect_ev = 0;
484  }
485  if (service.IsValid()) {
487  }
488 }
489 
491 {
492  if (reply.code == 250) {
493  LogPrint(BCLog::TOR, "tor: ADD_ONION successful\n");
494  for (const std::string &s : reply.lines) {
495  std::map<std::string,std::string> m = ParseTorReplyMapping(s);
496  std::map<std::string,std::string>::iterator i;
497  if ((i = m.find("ServiceID")) != m.end())
498  service_id = i->second;
499  if ((i = m.find("PrivateKey")) != m.end())
500  private_key = i->second;
501  }
502  if (service_id.empty()) {
503  LogPrintf("tor: Error parsing ADD_ONION parameters:\n");
504  for (const std::string &s : reply.lines) {
505  LogPrintf(" %s\n", SanitizeString(s));
506  }
507  return;
508  }
509  service = LookupNumeric(std::string(service_id+".onion").c_str(), Params().GetDefaultPort());
510  LogPrintf("tor: Got service ID %s, advertising service %s\n", service_id, service.ToString());
511  if (WriteBinaryFile(GetPrivateKeyFile(), private_key)) {
512  LogPrint(BCLog::TOR, "tor: Cached service private key to %s\n", GetPrivateKeyFile().string());
513  } else {
514  LogPrintf("tor: Error writing service private key to %s\n", GetPrivateKeyFile().string());
515  }
517  // ... onion requested - keep connection open
518  } else if (reply.code == 510) { // 510 Unrecognized command
519  LogPrintf("tor: Add onion failed with unrecognized command (You probably need to upgrade Tor)\n");
520  } else {
521  LogPrintf("tor: Add onion failed; error code %d\n", reply.code);
522  }
523 }
524 
526 {
527  if (reply.code == 250) {
528  LogPrint(BCLog::TOR, "tor: Authentication successful\n");
529 
530  // Now that we know Tor is running setup the proxy for onion addresses
531  // if -onion isn't set to something else.
532  if (GetArg("-onion", "") == "") {
533  CService resolved(LookupNumeric("127.0.0.1", 9050));
534  proxyType addrOnion = proxyType(resolved, true);
535  SetProxy(NET_TOR, addrOnion);
536  SetLimited(NET_TOR, false);
537  }
538 
539  // Finally - now create the service
540  if (private_key.empty()) // No private key, generate one
541  private_key = "NEW:RSA1024"; // Explicitly request RSA1024 - see issue #9214
542  // Request hidden service, redirect port.
543  // Note that the 'virtual' port is always the default port to avoid decloaking nodes using other ports.
544  _conn.Command(strprintf("ADD_ONION %s Port=%i,127.0.0.1:%i", private_key, Params().GetDefaultPort(), GetListenPort()),
545  boost::bind(&TorController::add_onion_cb, this, _1, _2));
546  } else {
547  LogPrintf("tor: Authentication failed\n");
548  }
549 }
550 
567 static std::vector<uint8_t> ComputeResponse(const std::string &key, const std::vector<uint8_t> &cookie, const std::vector<uint8_t> &clientNonce, const std::vector<uint8_t> &serverNonce)
568 {
569  CHMAC_SHA256 computeHash((const uint8_t*)key.data(), key.size());
570  std::vector<uint8_t> computedHash(CHMAC_SHA256::OUTPUT_SIZE, 0);
571  computeHash.Write(cookie.data(), cookie.size());
572  computeHash.Write(clientNonce.data(), clientNonce.size());
573  computeHash.Write(serverNonce.data(), serverNonce.size());
574  computeHash.Finalize(computedHash.data());
575  return computedHash;
576 }
577 
579 {
580  if (reply.code == 250) {
581  LogPrint(BCLog::TOR, "tor: SAFECOOKIE authentication challenge successful\n");
582  std::pair<std::string,std::string> l = SplitTorReplyLine(reply.lines[0]);
583  if (l.first == "AUTHCHALLENGE") {
584  std::map<std::string,std::string> m = ParseTorReplyMapping(l.second);
585  if (m.empty()) {
586  LogPrintf("tor: Error parsing AUTHCHALLENGE parameters: %s\n", SanitizeString(l.second));
587  return;
588  }
589  std::vector<uint8_t> serverHash = ParseHex(m["SERVERHASH"]);
590  std::vector<uint8_t> serverNonce = ParseHex(m["SERVERNONCE"]);
591  LogPrint(BCLog::TOR, "tor: AUTHCHALLENGE ServerHash %s ServerNonce %s\n", HexStr(serverHash), HexStr(serverNonce));
592  if (serverNonce.size() != 32) {
593  LogPrintf("tor: ServerNonce is not 32 bytes, as required by spec\n");
594  return;
595  }
596 
597  std::vector<uint8_t> computedServerHash = ComputeResponse(TOR_SAFE_SERVERKEY, cookie, clientNonce, serverNonce);
598  if (computedServerHash != serverHash) {
599  LogPrintf("tor: ServerHash %s does not match expected ServerHash %s\n", HexStr(serverHash), HexStr(computedServerHash));
600  return;
601  }
602 
603  std::vector<uint8_t> computedClientHash = ComputeResponse(TOR_SAFE_CLIENTKEY, cookie, clientNonce, serverNonce);
604  _conn.Command("AUTHENTICATE " + HexStr(computedClientHash), boost::bind(&TorController::auth_cb, this, _1, _2));
605  } else {
606  LogPrintf("tor: Invalid reply to AUTHCHALLENGE\n");
607  }
608  } else {
609  LogPrintf("tor: SAFECOOKIE authentication challenge failed\n");
610  }
611 }
612 
614 {
615  if (reply.code == 250) {
616  std::set<std::string> methods;
617  std::string cookiefile;
618  /*
619  * 250-AUTH METHODS=COOKIE,SAFECOOKIE COOKIEFILE="/home/x/.tor/control_auth_cookie"
620  * 250-AUTH METHODS=NULL
621  * 250-AUTH METHODS=HASHEDPASSWORD
622  */
623  for (const std::string &s : reply.lines) {
624  std::pair<std::string,std::string> l = SplitTorReplyLine(s);
625  if (l.first == "AUTH") {
626  std::map<std::string,std::string> m = ParseTorReplyMapping(l.second);
627  std::map<std::string,std::string>::iterator i;
628  if ((i = m.find("METHODS")) != m.end())
629  boost::split(methods, i->second, boost::is_any_of(","));
630  if ((i = m.find("COOKIEFILE")) != m.end())
631  cookiefile = i->second;
632  } else if (l.first == "VERSION") {
633  std::map<std::string,std::string> m = ParseTorReplyMapping(l.second);
634  std::map<std::string,std::string>::iterator i;
635  if ((i = m.find("Tor")) != m.end()) {
636  LogPrint(BCLog::TOR, "tor: Connected to Tor version %s\n", i->second);
637  }
638  }
639  }
640  for (const std::string &s : methods) {
641  LogPrint(BCLog::TOR, "tor: Supported authentication method: %s\n", s);
642  }
643  // Prefer NULL, otherwise SAFECOOKIE. If a password is provided, use HASHEDPASSWORD
644  /* Authentication:
645  * cookie: hex-encoded ~/.tor/control_auth_cookie
646  * password: "password"
647  */
648  std::string torpassword = GetArg("-torpassword", "");
649  if (!torpassword.empty()) {
650  if (methods.count("HASHEDPASSWORD")) {
651  LogPrint(BCLog::TOR, "tor: Using HASHEDPASSWORD authentication\n");
652  boost::replace_all(torpassword, "\"", "\\\"");
653  _conn.Command("AUTHENTICATE \"" + torpassword + "\"", boost::bind(&TorController::auth_cb, this, _1, _2));
654  } else {
655  LogPrintf("tor: Password provided with -torpassword, but HASHEDPASSWORD authentication is not available\n");
656  }
657  } else if (methods.count("NULL")) {
658  LogPrint(BCLog::TOR, "tor: Using NULL authentication\n");
659  _conn.Command("AUTHENTICATE", boost::bind(&TorController::auth_cb, this, _1, _2));
660  } else if (methods.count("SAFECOOKIE")) {
661  // Cookie: hexdump -e '32/1 "%02x""\n"' ~/.tor/control_auth_cookie
662  LogPrint(BCLog::TOR, "tor: Using SAFECOOKIE authentication, reading cookie authentication from %s\n", cookiefile);
663  std::pair<bool,std::string> status_cookie = ReadBinaryFile(cookiefile, TOR_COOKIE_SIZE);
664  if (status_cookie.first && status_cookie.second.size() == TOR_COOKIE_SIZE) {
665  cookie = std::vector<uint8_t>(status_cookie.second.begin(), status_cookie.second.end());
666  clientNonce = std::vector<uint8_t>(TOR_NONCE_SIZE, 0);
667  GetRandBytes(&clientNonce[0], TOR_NONCE_SIZE);
668  _conn.Command("AUTHCHALLENGE SAFECOOKIE " + HexStr(clientNonce), boost::bind(&TorController::authchallenge_cb, this, _1, _2));
669  } else {
670  if (status_cookie.first) {
671  LogPrintf("tor: Authentication cookie %s is not exactly %i bytes, as is required by the spec\n", cookiefile, TOR_COOKIE_SIZE);
672  } else {
673  LogPrintf("tor: Authentication cookie %s could not be opened (check permissions)\n", cookiefile);
674  }
675  }
676  } else if (methods.count("HASHEDPASSWORD")) {
677  LogPrintf("tor: The only supported authentication mechanism left is password, but no password provided with -torpassword\n");
678  } else {
679  LogPrintf("tor: No supported authentication method\n");
680  }
681  } else {
682  LogPrintf("tor: Requesting protocol info failed\n");
683  }
684 }
685 
687 {
688  reconnect_timeout = RECONNECT_TIMEOUT_START;
689  // First send a PROTOCOLINFO command to figure out what authentication is expected
690  if (!_conn.Command("PROTOCOLINFO 1", boost::bind(&TorController::protocolinfo_cb, this, _1, _2)))
691  LogPrintf("tor: Error sending initial protocolinfo command\n");
692 }
693 
695 {
696  // Stop advertising service when disconnected
697  if (service.IsValid())
699  service = CService();
700  if (!reconnect)
701  return;
702 
703  LogPrint(BCLog::TOR, "tor: Not connected to Tor control port %s, trying to reconnect\n", target);
704 
705  // Single-shot timer for reconnect. Use exponential backoff.
706  struct timeval time = MillisToTimeval(int64_t(reconnect_timeout * 1000.0));
707  if (reconnect_ev)
708  event_add(reconnect_ev, &time);
709  reconnect_timeout *= RECONNECT_TIMEOUT_EXP;
710 }
711 
713 {
714  /* Try to reconnect and reestablish if we get booted - for example, Tor
715  * may be restarting.
716  */
717  if (!conn.Connect(target, boost::bind(&TorController::connected_cb, this, _1),
718  boost::bind(&TorController::disconnected_cb, this, _1) )) {
719  LogPrintf("tor: Re-initiating connection to Tor control port %s failed\n", target);
720  }
721 }
722 
724 {
725  return GetDataDir() / "onion_private_key";
726 }
727 
728 void TorController::reconnect_cb(evutil_socket_t fd, short what, void *arg)
729 {
730  TorController *self = (TorController*)arg;
731  self->Reconnect();
732 }
733 
734 /****** Thread ********/
735 static struct event_base *gBase;
736 static boost::thread torControlThread;
737 
738 static void TorControlThread()
739 {
740  TorController ctrl(gBase, GetArg("-torcontrol", DEFAULT_TOR_CONTROL));
741 
742  event_base_dispatch(gBase);
743 }
744 
745 void StartTorControl(boost::thread_group& threadGroup/*, CScheduler& scheduler*/)
746 {
747  assert(!gBase);
748 #ifdef WIN32
749  evthread_use_windows_threads();
750 #else
751  evthread_use_pthreads();
752 #endif
753  gBase = event_base_new();
754  if (!gBase) {
755  LogPrintf("tor: Unable to create event_base\n");
756  return;
757  }
758 
759  torControlThread = boost::thread(boost::bind(&TraceThread<void (*)()>, "torcontrol", &TorControlThread));
760 }
761 
763 {
764  if (gBase) {
765  LogPrintf("tor: Thread interrupt\n");
766  event_base_loopbreak(gBase);
767  }
768 }
769 
771 {
772  // try_join_for() avoids the wallet not closing during a repair-restart. For a 'normal' wallet exit
773  if (gBase) {
774  torControlThread.try_join_for(boost::chrono::seconds(1));
775  event_base_free(gBase);
776  gBase = 0;
777  }
778 }
TorControlReply
Reply from Tor, can be single or multi-line.
Definition: torcontrol.cpp:57
TorControlConnection::Connect
bool Connect(const std::string &target, const ConnectionCB &connected, const ConnectionCB &disconnected)
Connect to a Tor control port.
Definition: torcontrol.cpp:200
TorController::conn
TorControlConnection conn
Definition: torcontrol.cpp:429
CService
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:133
TorControlConnection::Disconnect
bool Disconnect()
Disconnect from Tor control port.
Definition: torcontrol.cpp:230
TorControlConnection::async_handler
boost::signals2::signal< void(TorControlConnection &, const TorControlReply &)> async_handler
Response handlers for async replies.
Definition: torcontrol.cpp:107
hmac_sha256.h
NET_TOR
@ NET_TOR
Definition: netaddress.h:24
TorControlConnection::b_conn
struct bufferevent * b_conn
Connection to control socket.
Definition: torcontrol.cpp:116
TorControlReply::code
int code
Definition: torcontrol.cpp:62
TorController::connected_cb
void connected_cb(TorControlConnection &conn)
Callback after successful connection.
Definition: torcontrol.cpp:686
TorController::protocolinfo_cb
void protocolinfo_cb(TorControlConnection &conn, const TorControlReply &reply)
Callback for PROTOCOLINFO result.
Definition: torcontrol.cpp:613
fsbridge::fopen
FILE * fopen(const fs::path &p, const char *mode)
Definition: fs.cpp:13
ParseHex
std::vector< unsigned char > ParseHex(const char *psz)
Definition: utilstrencodings.cpp:77
TorControlConnection
Low-level handling for Tor control connection.
Definition: torcontrol.cpp:75
CHMAC_SHA256
A hasher class for HMAC-SHA-256.
Definition: hmac_sha256.h:14
TorController::cookie
std::vector< uint8_t > cookie
Cookie for SAFECOOKIE auth.
Definition: torcontrol.cpp:437
TorControlConnection::reply_handlers
std::deque< ReplyHandlerCB > reply_handlers
Response handlers.
Definition: torcontrol.cpp:120
TorController::~TorController
~TorController()
Definition: torcontrol.cpp:479
TorControlReply::Clear
void Clear()
Definition: torcontrol.cpp:65
InterruptTorControl
void InterruptTorControl()
Definition: torcontrol.cpp:762
TorControlConnection::readcb
static void readcb(struct bufferevent *bev, void *ctx)
Libevent handlers: internal.
Definition: torcontrol.cpp:138
TorController::TorController
TorController(struct event_base *base, const std::string &target)
Definition: torcontrol.cpp:458
StartTorControl
void StartTorControl(boost::thread_group &threadGroup)
Definition: torcontrol.cpp:745
TorController::disconnected_cb
void disconnected_cb(TorControlConnection &conn)
Callback after connection lost or failed connection attempt.
Definition: torcontrol.cpp:694
SanitizeString
std::string SanitizeString(const std::string &str, int rule)
Remove unsafe chars.
Definition: utilstrencodings.cpp:32
chainparams.h
proxyType
Definition: netbase.h:28
TorController::reconnect_ev
struct event * reconnect_ev
Definition: torcontrol.cpp:433
atoi
int atoi(const std::string &str)
Definition: utilstrencodings.cpp:587
CService::ToString
std::string ToString() const
Definition: netaddress.cpp:568
DEFAULT_TOR_CONTROL
const std::string DEFAULT_TOR_CONTROL
Default control port.
Definition: torcontrol.cpp:35
GetRandBytes
void GetRandBytes(unsigned char *buf, int num)
Functions to gather random data via the OpenSSL PRNG.
Definition: random.cpp:273
TorController::add_onion_cb
void add_onion_cb(TorControlConnection &conn, const TorControlReply &reply)
Callback for ADD_ONION result.
Definition: torcontrol.cpp:490
MillisToTimeval
struct timeval MillisToTimeval(int64_t nTimeout)
Convert milliseconds to a struct timeval for e.g.
Definition: netbase.cpp:244
TorController::service_id
std::string service_id
Definition: torcontrol.cpp:431
TorControlReply::TorControlReply
TorControlReply()
Definition: torcontrol.cpp:60
TorController::target
std::string target
Definition: torcontrol.cpp:428
TorControlConnection::TorControlConnection
TorControlConnection(struct event_base *base)
Create a new TorControlConnection.
Definition: torcontrol.cpp:127
HexStr
std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
Definition: utilstrencodings.h:85
TorControlReply::lines
std::vector< std::string > lines
Definition: torcontrol.cpp:63
LogPrintf
#define LogPrintf(...)
Definition: logging.h:147
CNetAddr::IsValid
bool IsValid() const
Definition: netaddress.cpp:188
BCLog::TOR
@ TOR
Definition: logging.h:41
TorController::service
CService service
Definition: torcontrol.cpp:435
RemoveLocal
bool RemoveLocal(const CService &addr)
Definition: net.cpp:237
GetListenPort
unsigned short GetListenPort()
Definition: net.cpp:114
TorController::base
struct event_base * base
Definition: torcontrol.cpp:427
LogPrint
#define LogPrint(category,...)
Definition: logging.h:162
TorController::auth_cb
void auth_cb(TorControlConnection &conn, const TorControlReply &reply)
Callback for AUTHENTICATE result.
Definition: torcontrol.cpp:525
TorController::reconnect
bool reconnect
Definition: torcontrol.cpp:432
CHMAC_SHA256::OUTPUT_SIZE
static const size_t OUTPUT_SIZE
Definition: hmac_sha256.h:21
TorController::Reconnect
void Reconnect()
Reconnect, after getting disconnected.
Definition: torcontrol.cpp:712
SetProxy
bool SetProxy(enum Network net, const proxyType &addrProxy)
Definition: netbase.cpp:548
strprintf
#define strprintf
Definition: tinyformat.h:1056
TorController::clientNonce
std::vector< uint8_t > clientNonce
ClientNonce for SAFECOOKIE auth.
Definition: torcontrol.cpp:439
CKey::size
unsigned int size() const
Simple read-only vector-like interface.
Definition: key.h:99
LOCAL_MANUAL
@ LOCAL_MANUAL
Definition: net.h:127
TorControlConnection::connected
boost::function< void(TorControlConnection &)> connected
Callback when ready for use.
Definition: torcontrol.cpp:110
torcontrol.h
TorControlConnection::Command
bool Command(const std::string &cmd, const ReplyHandlerCB &reply_handler)
Send a command, register a handler for the reply.
Definition: torcontrol.cpp:238
key
CKey key
Definition: bip38tooldialog.cpp:173
SetLimited
void SetLimited(enum Network net, bool fLimited)
Make a particular network entirely off-limits (no automatic connects to it)
Definition: net.cpp:245
TorController::reconnect_timeout
float reconnect_timeout
Definition: torcontrol.cpp:434
TorController::authchallenge_cb
void authchallenge_cb(TorControlConnection &conn, const TorControlReply &reply)
Callback for AUTHCHALLENGE result.
Definition: torcontrol.cpp:578
LookupNumeric
CService LookupNumeric(const char *pszName, int portDefault)
Definition: netbase.cpp:234
GetDataDir
const fs::path & GetDataDir(bool fNetSpecific)
Definition: util.cpp:349
Params
const CChainParams & Params()
Return the currently selected parameters.
Definition: chainparams.cpp:463
TorController
Controller that connects to Tor control socket, authenticate, then create and maintain a ephemeral hi...
Definition: torcontrol.cpp:415
TraceThread
void TraceThread(const char *name, Callable func)
Definition: util.h:169
StopTorControl
void StopTorControl()
Definition: torcontrol.cpp:770
netbase.h
utilstrencodings.h
TorController::private_key
std::string private_key
Definition: torcontrol.cpp:430
TorControlConnection::ReplyHandlerCB
boost::function< void(TorControlConnection &, const TorControlReply &)> ReplyHandlerCB
Definition: torcontrol.cpp:79
TorController::GetPrivateKeyFile
fs::path GetPrivateKeyFile()
Get name fo file to store private key in.
Definition: torcontrol.cpp:723
TorControlConnection::~TorControlConnection
~TorControlConnection()
Definition: torcontrol.cpp:132
TorControlConnection::ConnectionCB
boost::function< void(TorControlConnection &)> ConnectionCB
Definition: torcontrol.cpp:78
net.h
TorControlConnection::eventcb
static void eventcb(struct bufferevent *bev, short what, void *ctx)
Definition: torcontrol.cpp:183
GetArg
std::string GetArg(const std::string &strArg, const std::string &strDefault)
Return string argument or default value.
Definition: util.cpp:241
TorControlConnection::message
TorControlReply message
Message being received.
Definition: torcontrol.cpp:118
util.h
TorControlConnection::base
struct event_base * base
Libevent event base.
Definition: torcontrol.cpp:114
TorControlConnection::disconnected
boost::function< void(TorControlConnection &)> disconnected
Callback when connection lost.
Definition: torcontrol.cpp:112
TorController::reconnect_cb
static void reconnect_cb(evutil_socket_t fd, short what, void *arg)
Callback for reconnect timer.
Definition: torcontrol.cpp:728
AddLocal
bool AddLocal(const CService &addr, int nScore)
Definition: net.cpp:208