dns.c 70.9 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
Nick Mathewson's avatar
Nick Mathewson committed
3
 * Copyright (c) 2007-2016, The Tor Project, Inc. */
4
5
/* See LICENSE for licensing information */

Roger Dingledine's avatar
Roger Dingledine committed
6
7
/**
 * \file dns.c
8
 * \brief Implements a local cache for DNS results for Tor servers.
Roger Dingledine's avatar
Roger Dingledine committed
9
 * This is implemented as a wrapper around Adam Langley's eventdns.c code.
10
11
 * (We can't just use gethostbyname() and friends because we really need to
 * be nonblocking.)
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 *
 * There are three main cases when a Tor relay uses dns.c to launch a DNS
 * request:
 *   <ol>
 *    <li>To check whether the DNS server is working more or less correctly.
 *      This happens via dns_launch_correctness_checks().  The answer is
 *      reported in the return value from later calls to
 *      dns_seems_to_be_broken().
 *    <li>When a client has asked the relay, in a RELAY_BEGIN cell, to connect
 *      to a given server by hostname.  This happens via dns_resolve().
 *    <li>When a client has asked the rela, in a RELAY_RESOLVE cell, to look
 *      up a given server's IP address(es) by hostname. This also happens via
 *      dns_resolve().
 *   </ol>
 *
 * Each of these gets handled a little differently.
 *
 * To check for correctness, we look up some hostname we expect to exist and
 * have real entries, some hostnames which we expect to definitely not exist,
 * and some hostnames that we expect to probably not exist.  If too many of
 * the hostnames that shouldn't exist do exist, that's a DNS hijacking
 * attempt.  If too many of the hostnames that should exist have the same
 * addresses as the ones that shouldn't exist, that's a very bad DNS hijacking
 * attempt, or a very naughty captive portal.  And if the hostnames that
 * should exist simply don't exist, we probably have a broken nameserver.
 *
 * To handle client requests, we first check our cache for answers. If there
 * isn't something up-to-date, we've got to launch A or AAAA requests as
 * appropriate.  How we handle responses to those in particular is a bit
 * complex; see dns_lookup() and set_exitconn_info_from_resolve().
 *
 * When a lookup is finally complete, the inform_pending_connections()
 * function will tell all of the streams that have been waiting for the
 * resolve, by calling connection_exit_connect() if the client sent a
 * RELAY_BEGIN cell, and by calling send_resolved_cell() or
 * send_hostname_cell() if the client sent a RELAY_RESOLVE cell.
Roger Dingledine's avatar
Roger Dingledine committed
48
 **/
49

50
51
#define DNS_PRIVATE

52
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
53
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
54
#include "circuituse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
55
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
56
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
57
#include "connection_edge.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
58
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
59
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
60
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
61
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
62
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
63
#include "router.h"
64
#include "ht.h"
65
#include "sandbox.h"
66
#include <event2/event.h>
67
#include <event2/dns.h>
68

69
70
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
71
72
#define RESOLVE_MAX_TIMEOUT 300

73
74
75
/** Our evdns_base; this structure handles all our name lookups. */
static struct evdns_base *the_evdns_base = NULL;

76
77
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
78
79
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
80
81
82
83
84
85
/** What was the resolv_conf fname we last used when configuring the
 * nameservers? Used to check whether we need to reconfigure. */
static char *resolv_conf_fname = NULL;
/** What was the mtime on the resolv.conf file we last used when configuring
 * the nameservers?  Used to check whether we need to reconfigure. */
static time_t resolv_conf_mtime = 0;
86

87
static void purge_expired_resolves(time_t now);
88
89
90
91
static void dns_found_answer(const char *address, uint8_t query_type,
                             int dns_answer,
                             const tor_addr_t *addr,
                             const char *hostname,
92
                             uint32_t ttl);
93
static void add_wildcarded_test_address(const char *address);
94
static int configure_nameservers(int force);
95
static int answer_is_wildcarded(const char *ip);
96
97
98
99
static int evdns_err_is_transient(int err);
static void inform_pending_connections(cached_resolve_t *resolve);
static void make_pending_resolve_cached(cached_resolve_t *cached);

100
#ifdef DEBUG_DNS_CACHE
101
102
static void assert_cache_ok_(void);
#define assert_cache_ok() assert_cache_ok_()
103
#else
104
#define assert_cache_ok() STMT_NIL
105
#endif
106
static void assert_resolve_ok(cached_resolve_t *resolve);
107

108
109
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
110

111
/** Global: how many IPv6 requests have we made in all? */
112
static uint64_t n_ipv6_requests_made = 0;
113
/** Global: how many IPv6 requests have timed out? */
114
static uint64_t n_ipv6_timeouts = 0;
115
/** Global: Do we think that IPv6 DNS is broken? */
116
117
static int dns_is_broken_for_ipv6 = 0;

Roger Dingledine's avatar
Roger Dingledine committed
118
/** Function to compare hashed resolves on their addresses; used to
119
 * implement hash tables. */
120
static inline int
121
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
122
{
123
  /* make this smarter one day? */
124
  assert_resolve_ok(a); // Not b; b may be just a search.
125
126
127
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

128
/** Hash function for cached_resolve objects */
129
static inline unsigned int
130
131
cached_resolve_hash(cached_resolve_t *a)
{
132
  return (unsigned) siphash24g((const uint8_t*)a->address, strlen(a->address));
133
134
}

135
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
136
             cached_resolves_eq)
137
138
HT_GENERATE2(cache_map, cached_resolve_t, node, cached_resolve_hash,
             cached_resolves_eq, 0.6, tor_reallocarray_, tor_free_)
139

140
/** Initialize the DNS cache. */
141
static void
142
init_cache_map(void)
143
{
144
  HT_INIT(cache_map, &cache_root);
145
146
}

147
/** Helper: called by eventdns when eventdns wants to log something. */
148
static void
149
evdns_log_cb(int warn, const char *msg)
150
{
151
  const char *cp;
152
153
  static int all_down = 0;
  int severity = warn ? LOG_WARN : LOG_INFO;
154
155
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
156
    log_info(LD_EXIT, "eventdns: Resolve requested.");
157
    return;
158
159
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
160
  }
161
162
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
163
    const char *err = strchr(cp, ':')+2;
164
    tor_assert(err);
165
166
167
    /* Don't warn about a single failed nameserver; we'll warn with 'all
     * nameservers have failed' if we're completely out of nameservers;
     * otherwise, the situation is tolerable. */
168
    severity = LOG_INFO;
169
    control_event_server_status(LOG_NOTICE,
170
171
172
173
174
175
                                "NAMESERVER_STATUS NS=%s STATUS=DOWN ERR=%s",
                                ns, escaped(err));
    tor_free(ns);
  } else if (!strcmpstart(msg, "Nameserver ") &&
             (cp=strstr(msg, " is back up"))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
176
    severity = (all_down && warn) ? LOG_NOTICE : LOG_INFO;
177
    all_down = 0;
178
179
180
181
182
    control_event_server_status(LOG_NOTICE,
                                "NAMESERVER_STATUS NS=%s STATUS=UP", ns);
    tor_free(ns);
  } else if (!strcmp(msg, "All nameservers have failed")) {
    control_event_server_status(LOG_WARN, "NAMESERVER_ALL_DOWN");
183
    all_down = 1;
184
  }
185
  tor_log(severity, LD_EXIT, "eventdns: %s", msg);
186
187
}

188
189
/** Helper: passed to eventdns.c as a callback so it can generate random
 * numbers for transaction IDs and 0x20-hack coding. */
190
static void
191
dns_randfn_(char *b, size_t n)
192
{
193
  crypto_rand(b,n);
194
195
}

Roger Dingledine's avatar
Roger Dingledine committed
196
/** Initialize the DNS subsystem; called by the OR process. */
197
int
198
199
dns_init(void)
{
200
  init_cache_map();
201
  evdns_set_random_bytes_fn(dns_randfn_);
202
203
204
205
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
206
  return 0;
207
}
208

209
210
211
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
212
213
dns_reset(void)
{
214
  const or_options_t *options = get_options();
215
  if (! server_mode(options)) {
216
217
218
219
220
221
222
223

    if (!the_evdns_base) {
      if (!(the_evdns_base = evdns_base_new(tor_libevent_get_base(), 0))) {
        log_err(LD_BUG, "Couldn't create an evdns_base");
        return -1;
      }
    }

224
225
    evdns_base_clear_nameservers_and_suspend(the_evdns_base);
    evdns_base_search_clear(the_evdns_base);
226
227
228
229
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
230
    if (configure_nameservers(0) < 0) {
231
      return -1;
232
    }
233
  }
234
  return 0;
235
236
}

Nick Mathewson's avatar
Nick Mathewson committed
237
238
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
239
240
241
242
243
244
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

245
246
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
247
248
249
250
251
252
253
254
255
256
257
uint32_t
dns_clip_ttl(uint32_t ttl)
{
  if (ttl < MIN_DNS_TTL)
    return MIN_DNS_TTL;
  else if (ttl > MAX_DNS_TTL)
    return MAX_DNS_TTL;
  else
    return ttl;
}

258
259
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
260
STATIC uint32_t
261
262
263
264
265
266
267
268
269
270
dns_get_expiry_ttl(uint32_t ttl)
{
  if (ttl < MIN_DNS_TTL)
    return MIN_DNS_TTL;
  else if (ttl > MAX_DNS_ENTRY_AGE)
    return MAX_DNS_ENTRY_AGE;
  else
    return ttl;
}

271
/** Helper: free storage held by an entry in the DNS cache. */
272
static void
273
free_cached_resolve_(cached_resolve_t *r)
274
{
275
276
  if (!r)
    return;
Nick Mathewson's avatar
Nick Mathewson committed
277
  while (r->pending_connections) {
278
    pending_connection_t *victim = r->pending_connections;
279
280
281
    r->pending_connections = victim->next;
    tor_free(victim);
  }
282
283
  if (r->res_status_hostname == RES_STATUS_DONE_OK)
    tor_free(r->result_ptr.hostname);
284
  r->magic = 0xFF00FF00;
285
286
287
  tor_free(r);
}

288
289
290
/** Compare two cached_resolve_t pointers by expiry time, and return
 * less-than-zero, zero, or greater-than-zero as appropriate. Used for
 * the priority queue implementation. */
291
static int
292
compare_cached_resolves_by_expiry_(const void *_a, const void *_b)
293
{
294
  const cached_resolve_t *a = _a, *b = _b;
295
296
297
298
299
300
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
301
302
}

303
304
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
305
306
static smartlist_t *cached_resolve_pqueue = NULL;

307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
static void
cached_resolve_add_answer(cached_resolve_t *resolve,
                          int query_type,
                          int dns_result,
                          const tor_addr_t *answer_addr,
                          const char *answer_hostname,
                          uint32_t ttl)
{
  if (query_type == DNS_PTR) {
    if (resolve->res_status_hostname != RES_STATUS_INFLIGHT)
      return;

    if (dns_result == DNS_ERR_NONE && answer_hostname) {
      resolve->result_ptr.hostname = tor_strdup(answer_hostname);
      resolve->res_status_hostname = RES_STATUS_DONE_OK;
    } else {
      resolve->result_ptr.err_hostname = dns_result;
      resolve->res_status_hostname = RES_STATUS_DONE_ERR;
    }
    resolve->ttl_hostname = ttl;
  } else if (query_type == DNS_IPv4_A) {
    if (resolve->res_status_ipv4 != RES_STATUS_INFLIGHT)
      return;

331
332
    if (dns_result == DNS_ERR_NONE && answer_addr &&
        tor_addr_family(answer_addr) == AF_INET) {
333
334
335
336
337
338
339
340
341
342
343
      resolve->result_ipv4.addr_ipv4 = tor_addr_to_ipv4h(answer_addr);
      resolve->res_status_ipv4 = RES_STATUS_DONE_OK;
    } else {
      resolve->result_ipv4.err_ipv4 = dns_result;
      resolve->res_status_ipv4 = RES_STATUS_DONE_ERR;
    }

  } else if (query_type == DNS_IPv6_AAAA) {
    if (resolve->res_status_ipv6 != RES_STATUS_INFLIGHT)
      return;

344
345
    if (dns_result == DNS_ERR_NONE && answer_addr &&
        tor_addr_family(answer_addr) == AF_INET6) {
346
347
348
349
350
351
352
353
354
355
356
      memcpy(&resolve->result_ipv6.addr_ipv6,
             tor_addr_to_in6(answer_addr),
             sizeof(struct in6_addr));
      resolve->res_status_ipv6 = RES_STATUS_DONE_OK;
    } else {
      resolve->result_ipv6.err_ipv6 = dns_result;
      resolve->res_status_ipv6 = RES_STATUS_DONE_ERR;
    }
  }
}

357
/** Return true iff there are no in-flight requests for <b>resolve</b>. */
358
359
360
361
362
363
364
365
static int
cached_resolve_have_all_answers(const cached_resolve_t *resolve)
{
  return (resolve->res_status_ipv4 != RES_STATUS_INFLIGHT &&
          resolve->res_status_ipv6 != RES_STATUS_INFLIGHT &&
          resolve->res_status_hostname != RES_STATUS_INFLIGHT);
}

366
367
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
368
369
370
371
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
372
  if (!cached_resolve_pqueue)
373
    cached_resolve_pqueue = smartlist_new();
374
375
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
376
                       compare_cached_resolves_by_expiry_,
377
                       STRUCT_OFFSET(cached_resolve_t, minheap_idx),
378
379
380
                       resolve);
}

381
/** Free all storage held in the DNS cache and related structures. */
382
383
384
void
dns_free_all(void)
{
385
  cached_resolve_t **ptr, **next, *item;
386
  assert_cache_ok();
387
388
389
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
390
        if (res->state == CACHE_STATE_DONE)
391
          free_cached_resolve_(res);
392
393
      });
  }
394
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
395
    item = *ptr;
396
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
397
    free_cached_resolve_(item);
398
  }
399
  HT_CLEAR(cache_map, &cache_root);
400
  smartlist_free(cached_resolve_pqueue);
401
  cached_resolve_pqueue = NULL;
402
  tor_free(resolv_conf_fname);
403
404
}

405
406
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
407
static void
408
purge_expired_resolves(time_t now)
409
{
Nick Mathewson's avatar
Nick Mathewson committed
410
  cached_resolve_t *resolve, *removed;
411
  pending_connection_t *pend;
412
  edge_connection_t *pendconn;
413

Nick Mathewson's avatar
Nick Mathewson committed
414
  assert_cache_ok();
415
416
417
418
419
420
421
422
  if (!cached_resolve_pqueue)
    return;

  while (smartlist_len(cached_resolve_pqueue)) {
    resolve = smartlist_get(cached_resolve_pqueue, 0);
    if (resolve->expire > now)
      break;
    smartlist_pqueue_pop(cached_resolve_pqueue,
423
                         compare_cached_resolves_by_expiry_,
424
                         STRUCT_OFFSET(cached_resolve_t, minheap_idx));
425

426
    if (resolve->state == CACHE_STATE_PENDING) {
427
      log_debug(LD_EXIT,
428
429
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
430
                escaped_safe_str(resolve->address));
431
    } else if (resolve->state == CACHE_STATE_CACHED) {
432
433
434
435
436
437
438
439
      log_debug(LD_EXIT,
                "Forgetting old cached resolve (address %s, expires %lu)",
                escaped_safe_str(resolve->address),
                (unsigned long)resolve->expire);
      tor_assert(!resolve->pending_connections);
    } else {
      tor_assert(resolve->state == CACHE_STATE_DONE);
      tor_assert(!resolve->pending_connections);
440
    }
441

442
    if (resolve->pending_connections) {
443
      log_debug(LD_EXIT,
444
                "Closing pending connections on timed-out DNS resolve!");
445
446
447
448
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
449
        tor_assert(!SOCKET_OK(pend->conn->base_.s));
450
        pendconn = pend->conn;
451
452
        /* Prevent double-remove */
        pendconn->base_.state = EXIT_CONN_STATE_RESOLVEFAILED;
453
        if (!pendconn->base_.marked_for_close) {
454
455
456
457
          connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT);
          circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
          connection_free(TO_CONN(pendconn));
        }
458
459
        tor_free(pend);
      }
460
    }
461

462
    if (resolve->state == CACHE_STATE_CACHED ||
463
464
465
466
467
        resolve->state == CACHE_STATE_PENDING) {
      removed = HT_REMOVE(cache_map, &cache_root, resolve);
      if (removed != resolve) {
        log_err(LD_BUG, "The expired resolve we purged didn't match any in"
                " the cache. Tried to purge %s (%p); instead got %s (%p).",
468
                resolve->address, (void*)resolve,
469
                removed ? removed->address : "NULL", (void*)removed);
470
471
472
      }
      tor_assert(removed == resolve);
    } else {
473
      /* This should be in state DONE. Make sure it's not in the cache. */
474
475
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
476
    }
477
478
    if (resolve->res_status_hostname == RES_STATUS_DONE_OK)
      tor_free(resolve->result_ptr.hostname);
479
480
    resolve->magic = 0xF0BBF0BB;
    tor_free(resolve);
481
  }
482

Nick Mathewson's avatar
Nick Mathewson committed
483
  assert_cache_ok();
484
485
}

486
487
488
489
/* argument for send_resolved_cell only, meaning "let the answer type be ipv4
 * or ipv6 depending on the connection's address". */
#define RESOLVED_TYPE_AUTO 0xff

490
491
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
492
 * RESOLVED_TYPE_(AUTO|ERROR|ERROR_TRANSIENT|).
493
494
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
495
496
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
497
 */
498
499
500
MOCK_IMPL(STATIC void,
send_resolved_cell,(edge_connection_t *conn, uint8_t answer_type,
                    const cached_resolve_t *resolved))
501
{
502
503
  char buf[RELAY_PAYLOAD_SIZE], *cp = buf;
  size_t buflen = 0;
504
  uint32_t ttl;
505
506

  buf[0] = answer_type;
507
  ttl = dns_clip_ttl(conn->address_ttl);
508
509
510

  switch (answer_type)
    {
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
    case RESOLVED_TYPE_AUTO:
      if (resolved && resolved->res_status_ipv4 == RES_STATUS_DONE_OK) {
        cp[0] = RESOLVED_TYPE_IPV4;
        cp[1] = 4;
        set_uint32(cp+2, htonl(resolved->result_ipv4.addr_ipv4));
        set_uint32(cp+6, htonl(ttl));
        cp += 10;
      }
      if (resolved && resolved->res_status_ipv6 == RES_STATUS_DONE_OK) {
        const uint8_t *bytes = resolved->result_ipv6.addr_ipv6.s6_addr;
        cp[0] = RESOLVED_TYPE_IPV6;
        cp[1] = 16;
        memcpy(cp+2, bytes, 16);
        set_uint32(cp+18, htonl(ttl));
        cp += 22;
      }
      if (cp != buf) {
        buflen = cp - buf;
        break;
      } else {
        answer_type = RESOLVED_TYPE_ERROR;
        /* fall through. */
533
      }
534
535
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
536
537
      {
        const char *errmsg = "Error resolving hostname";
538
        size_t msglen = strlen(errmsg);
539

540
        buf[0] = answer_type;
541
542
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
543
        set_uint32(buf+2+msglen, htonl(ttl));
544
545
546
        buflen = 6+msglen;
        break;
      }
547
548
    default:
      tor_assert(0);
549
      return;
550
    }
551
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
552

553
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
554
555
}

556
557
558
/** Send a response to the RESOLVE request of a connection for an in-addr.arpa
 * address on connection <b>conn</b> which yielded the result <b>hostname</b>.
 * The answer type will be RESOLVED_HOSTNAME.
559
560
561
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
562
 * <b>conn</b>'s attached circuit.
563
 */
564
565
566
MOCK_IMPL(STATIC void,
send_resolved_hostname_cell,(edge_connection_t *conn,
                             const char *hostname))
567
568
569
570
571
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
572
  tor_assert(hostname);
573
574
575
576
577
578
579
580
581
582

  tor_assert(namelen < 256);
  ttl = dns_clip_ttl(conn->address_ttl);

  buf[0] = RESOLVED_TYPE_HOSTNAME;
  buf[1] = (uint8_t)namelen;
  memcpy(buf+2, hostname, namelen);
  set_uint32(buf+2+namelen, htonl(ttl));
  buflen = 2+namelen+4;

583
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
584
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
585
  // log_notice(LD_EXIT, "Sent");
586
587
}

Roger Dingledine's avatar
Roger Dingledine committed
588
/** See if we have a cache entry for <b>exitconn</b>-\>address. If so,
Nick Mathewson's avatar
Nick Mathewson committed
589
 * if resolve valid, put it into <b>exitconn</b>-\>addr and return 1.
Roger Dingledine's avatar
Roger Dingledine committed
590
 * If resolve failed, free exitconn and return -1.
591
 *
592
593
594
595
596
 * (For EXIT_PURPOSE_RESOLVE connections, send back a RESOLVED error cell
 * on returning -1.  For EXIT_PURPOSE_CONNECT connections, there's no
 * need to send back an END cell, since connection_exit_begin_conn will
 * do that for us.)
 *
597
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
598
 * circuit.
599
 *
600
601
602
603
604
 * Else, if seen before and pending, add conn to the pending list,
 * and return 0.
 *
 * Else, if not seen before, add conn to pending list, hand to
 * dns farm, and return 0.
605
606
607
608
609
610
 *
 * Exitconn's on_circuit field must be set, but exitconn should not
 * yet be linked onto the n_streams/resolving_streams list of that circuit.
 * On success, link the connection to n_streams if it's an exit connection.
 * On "pending", link the connection to resolving streams.  Otherwise,
 * clear its on_circuit field.
611
 */
612
int
613
dns_resolve(edge_connection_t *exitconn)
614
615
616
{
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
  int is_resolve, r;
617
  int made_connection_pending = 0;
618
  char *hostname = NULL;
619
  cached_resolve_t *resolve = NULL;
620
  is_resolve = exitconn->base_.purpose == EXIT_PURPOSE_RESOLVE;
621

622
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname,
623
                       &made_connection_pending, &resolve);
624

625
626
  switch (r) {
    case 1:
627
628
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
629
      if (is_resolve) {
630
        /* Send the answer back right now, and detach. */
631
632
633
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
634
          send_resolved_cell(exitconn, RESOLVED_TYPE_AUTO, resolve);
635
        exitconn->on_circuit = NULL;
636
      } else {
637
638
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
639
640
641
642
643
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
644
645
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
646
      exitconn->base_.state = EXIT_CONN_STATE_RESOLVING;
647
648
649
650
651
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
652
      /* The request failed before it could start: cancel this connection,
653
       * and stop everybody waiting for the same connection. */
654
655
      if (is_resolve) {
        send_resolved_cell(exitconn,
656
657
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT,
             NULL);
658
      }
659

660
      exitconn->on_circuit = NULL;
661

662
      dns_cancel_pending_resolve(exitconn->base_.address);
663

664
      if (!made_connection_pending && !exitconn->base_.marked_for_close) {
665
666
667
        /* If we made the connection pending, then we freed it already in
         * dns_cancel_pending_resolve().  If we marked it for close, it'll
         * get freed from the main loop.  Otherwise, can free it now. */
668
        connection_free(TO_CONN(exitconn));
669
      }
670
671
672
673
674
675
676
677
678
679
680
681
682
683
      break;
    default:
      tor_assert(0);
  }

  tor_free(hostname);
  return r;
}

/** Helper function for dns_resolve: same functionality, but does not handle:
 *     - marking connections on error and clearing their on_circuit
 *     - linking connections to n_streams/resolving_streams,
 *     - sending resolved cells if we have an answer/error right away,
 *
Roger Dingledine's avatar
Roger Dingledine committed
684
685
686
 * Return -2 on a transient error. If it's a reverse resolve and it's
 * successful, sets *<b>hostname_out</b> to a newly allocated string
 * holding the cached reverse DNS value.
687
688
689
690
 *
 * Set *<b>made_connection_pending_out</b> to true if we have placed
 * <b>exitconn</b> on the list of pending connections for some resolve; set it
 * to false otherwise.
691
692
 *
 * Set *<b>resolve_out</b> to a cached resolve, if we found one.
693
 */
694
695
MOCK_IMPL(STATIC int,
dns_resolve_impl,(edge_connection_t *exitconn, int is_resolve,
696
                 or_circuit_t *oncirc, char **hostname_out,
697
                 int *made_connection_pending_out,
698
                 cached_resolve_t **resolve_out))
699
{
700
701
702
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
703
  int is_reverse = 0;
704
  tor_addr_t addr;
705
  time_t now = time(NULL);
706
  int r;
707
  assert_connection_ok(TO_CONN(exitconn), 0);
708
  tor_assert(!SOCKET_OK(exitconn->base_.s));
709
  assert_cache_ok();
710
  tor_assert(oncirc);
711
  *made_connection_pending_out = 0;
712

713
  /* first check if exitconn->base_.address is an IP. If so, we already
714
   * know the answer. */
715
  if (tor_addr_parse(&addr, exitconn->base_.address) >= 0) {
716
717
    if (tor_addr_family(&addr) == AF_INET ||
        tor_addr_family(&addr) == AF_INET6) {
718
      tor_addr_copy(&exitconn->base_.addr, &addr);
719
720
721
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
722
      /* XXXX unspec? Bogus? */
723
724
      return -1;
    }
725
  }
726

727
  /* If we're a non-exit, don't even do DNS lookups. */
728
  if (router_my_exit_policy_is_reject_star())
729
    return -1;
730

731
  if (address_is_invalid_destination(exitconn->base_.address, 0)) {
732
    tor_log(LOG_PROTOCOL_WARN, LD_EXIT,
733
        "Rejecting invalid destination address %s",
734
        escaped_safe_str(exitconn->base_.address));
735
736
    return -1;
  }
737
738

  /* then take this opportunity to see if there are any expired
739
   * resolves in the hash table. */
740
  purge_expired_resolves(now);
741

742
743
  /* lower-case exitconn->base_.address, so it's in canonical form */
  tor_strlower(exitconn->base_.address);
744

745
746
  /* Check whether this is a reverse lookup.  If it's malformed, or it's a
   * .in-addr.arpa address but this isn't a resolve request, kill the
747
   * connection.
748
   */
749
  if ((r = tor_addr_parse_PTR_name(&addr, exitconn->base_.address,
750
                                              AF_UNSPEC, 0)) != 0) {
751
    if (r == 1) {
752
      is_reverse = 1;
753
754
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
755
    }
756
757
758
759

    if (!is_reverse || !is_resolve) {
      if (!is_reverse)
        log_info(LD_EXIT, "Bad .in-addr.arpa address \"%s\"; sending error.",
760
                 escaped_safe_str(exitconn->base_.address));
761
762
763
764
      else if (!is_resolve)
        log_info(LD_EXIT,
                 "Attempt to connect to a .in-addr.arpa address \"%s\"; "
                 "sending error.",
765
                 escaped_safe_str(exitconn->base_.address));
766
767
768

      return -1;
    }
769
    //log_notice(LD_EXIT, "Looks like an address %s",
770
    //exitconn->base_.address);
771
  }
772
  exitconn->is_reverse_dns_lookup = is_reverse;
773

774
  /* now check the hash table to see if 'address' is already there. */
775
  strlcpy(search.address, exitconn->base_.address, sizeof(search.address));
776
  resolve = HT_FIND(cache_map, &cache_root, &search);
777
  if (resolve && resolve->expire > now) { /* already there */
778
    switch (resolve->state) {
779
780
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
781
        pending_connection = tor_malloc_zero(
782
                                      sizeof(pending_connection_t));
783
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
784
785
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
786
        *made_connection_pending_out = 1;
787
788
        log_debug(LD_EXIT,"Connection (fd "TOR_SOCKET_T_FORMAT") waiting "
                  "for pending DNS resolve of %s", exitconn->base_.s,
789
                  escaped_safe_str(exitconn->base_.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
790
        return 0;
791
      case CACHE_STATE_CACHED:
792
793
        log_debug(LD_EXIT,"Connection (fd "TOR_SOCKET_T_FORMAT") found "
                  "cached answer for %s",
794
                  exitconn->base_.s,
795
                  escaped_safe_str(resolve->address));
796

797
798
        *resolve_out = resolve;

799
        return set_exitconn_info_from_resolve(exitconn, resolve, hostname_out);
800
801
802
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
803
    }
Roger Dingledine's avatar
Roger Dingledine committed
804
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
805
  }
806
  tor_assert(!resolve);
Roger Dingledine's avatar
Roger Dingledine committed
807
  /* not there, need to add it */
808
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
809
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
810
  resolve->state = CACHE_STATE_PENDING;
811
  resolve->minheap_idx = -1;
812
  strlcpy(resolve->address, exitconn->base_.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
813

814
  /* add this connection to the pending list */
815
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
816
817
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
818
  *made_connection_pending_out = 1;
Roger Dingledine's avatar
Roger Dingledine committed
819

820
  /* Add this resolve to the cache and priority queue. */
821
  HT_INSERT(cache_map, &cache_root, resolve);
822
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
823

824
  log_debug(LD_EXIT,"Launching %s.",
825
            escaped_safe_str(exitconn->base_.address));
826
  assert_cache_ok();
827

828
829
830
  return launch_resolve(resolve);
}

831
/** Given an exit connection <b>exitconn</b>, and a cached_resolve_t
832
833
834
835
836
837
838
839
 * <b>resolve</b> whose DNS lookups have all either succeeded or failed,
 * update the appropriate fields (address_ttl and addr) of <b>exitconn</b>.
 *
 * The logic can be complicated here, since we might have launched both
 * an A lookup and an AAAA lookup, and since either of those might have
 * succeeded or failed, and since we want to answer a RESOLVE cell with
 * a full answer but answer a BEGIN cell with whatever answer the client
 * would accept <i>and</i> we could still connect to.
840
841
842
843
844
845
846
 *
 * If this is a reverse lookup, set *<b>hostname_out</b> to a newly allocated
 * copy of the name resulting hostname.
 *
 * Return -2 on a transient error, -1 on a permenent error, and 1 on
 * a successful lookup.
 */
rl1987's avatar
rl1987 committed
847
848
849
850
MOCK_IMPL(STATIC int,
set_exitconn_info_from_resolve,(edge_connection_t *exitconn,
                                const cached_resolve_t *resolve,
                                char **hostname_out))
851
852
{
  int ipv4_ok, ipv6_ok, answer_with_ipv4, r;
853
854
  uint32_t begincell_flags;
  const int is_resolve = exitconn->base_.purpose == EXIT_PURPOSE_RESOLVE;
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
  tor_assert(exitconn);
  tor_assert(resolve);

  if (exitconn->is_reverse_dns_lookup) {
    exitconn->address_ttl = resolve->ttl_hostname;
    if (resolve->res_status_hostname == RES_STATUS_DONE_OK) {
      *hostname_out = tor_strdup(resolve->result_ptr.hostname);
      return 1;
    } else {
      return -1;
    }
  }

  /* If we're here then the connection wants one or either of ipv4, ipv6, and
   * we can give it one or both. */
870
871
872
873
874
875
  if (is_resolve) {
    begincell_flags = BEGIN_FLAG_IPV6_OK;
  } else {
    begincell_flags = exitconn->begincell_flags;
  }

876
  ipv4_ok = (resolve->res_status_ipv4 == RES_STATUS_DONE_OK) &&
877
    ! (begincell_flags & BEGIN_FLAG_IPV4_NOT_OK);
878
  ipv6_ok = (resolve->res_status_ipv6 == RES_STATUS_DONE_OK) &&
879
    (begincell_flags & BEGIN_FLAG_IPV6_OK) &&
880
881
882
    get_options()->IPv6Exit;

  /* Now decide which one to actually give. */
883
884
885
  if (ipv4_ok && ipv6_ok && is_resolve) {
    answer_with_ipv4 = 1;
  } else if (ipv4_ok && ipv6_ok) {
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
    /* If we have both, see if our exit policy has an opinion. */
    const uint16_t port = exitconn->base_.port;
    int ipv4_allowed, ipv6_allowed;
    tor_addr_t a4, a6;
    tor_addr_from_ipv4h(&a4, resolve->result_ipv4.addr_ipv4);
    tor_addr_from_in6(&a6, &resolve->result_ipv6.addr_ipv6);
    ipv4_allowed = !router_compare_to_my_exit_policy(&a4, port);
    ipv6_allowed = !router_compare_to_my_exit_policy(&a6, port);
    if (ipv4_allowed && !ipv6_allowed) {
      answer_with_ipv4 = 1;
    } else if (ipv6_allowed && !ipv4_allowed) {
      answer_with_ipv4 = 0;
    } else {
      /* Our exit policy would permit both.  Answer with whichever the user
       * prefers */
901
      answer_with_ipv4 = !(begincell_flags &
902
903
904
905
906
907
908
909
910
911
                           BEGIN_FLAG_IPV6_PREFERRED);
    }
  } else {
    /* Otherwise if one is okay, send it back. */
    if (ipv4_ok) {
      answer_with_ipv4 = 1;
    } else if (ipv6_ok) {
      answer_with_ipv4 = 0;
    } else {
      /* Neither one was okay. Choose based on user preference. */
912
      answer_with_ipv4 = !(begincell_flags &
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
                           BEGIN_FLAG_IPV6_PREFERRED);
    }
  }

  /* Finally, we write the answer back. */
  r = 1;
  if (answer_with_ipv4) {
    if (resolve->res_status_ipv4 == RES_STATUS_DONE_OK) {
      tor_addr_from_ipv4h(&exitconn->base_.addr,
                          resolve->result_ipv4.addr_ipv4);
    } else {
      r = evdns_err_is_transient(resolve->result_ipv4.err_ipv4) ? -2 : -1;
    }

    exitconn->address_ttl = resolve->ttl_ipv4;
  } else {
    if (resolve->res_status_ipv6 == RES_STATUS_DONE_OK) {
      tor_addr_from_in6(&exitconn->base_.addr,
                        &resolve->result_ipv6.addr_ipv6);
    } else {
      r = evdns_err_is_transient(resolve->result_ipv6.err_ipv6) ? -2 : -1;
    }

    exitconn->address_ttl = resolve->ttl_ipv6;
  }

  return r;
940
941
}

942
/** Log an error and abort if conn is waiting for a DNS resolve.
943