dns.c 60.6 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
3
 * Copyright (c) 2007-2010, 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.)
Roger Dingledine's avatar
Roger Dingledine committed
12
 **/
13

14
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "router.h"
17
#include "ht.h"
18
#ifdef HAVE_EVENT2_DNS_H
19
#include <event2/event.h>
20
21
#include <event2/dns.h>
#else
22
#include <event.h>
23
#include "eventdns.h"
24
25
26
27
#ifndef HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#define HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#endif
#endif
28

29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#ifndef HAVE_EVENT2_DNS_H
struct evdns_base;
struct evdns_request;
#define evdns_base_new(x,y) tor_malloc(1)
#define evdns_base_clear_nameservers_and_suspend(base) \
  evdns_clear_nameservers_and_suspend()
#define evdns_base_search_clear(base) evdns_search_clear()
#define evdns_base_set_default_outgoing_bind_address(base, a, len)  \
  evdns_set_default_outgoing_bind_address((a),(len))
#define evdns_base_resolv_conf_parse(base, options, fname) \
  evdns_resolv_conf_parse((options), (fname))
#define evdns_base_count_nameservers(base)      \
  evdns_count_nameservers()
#define evdns_base_resume(base)                 \
  evdns_resume()
#define evdns_base_config_windows_nameservers(base)     \
  evdns_config_windows_nameservers()
46
47
#define evdns_base_set_option_(base, opt, val) \
  evdns_set_option((opt),(val),DNS_OPTIONS_ALL)
48
49
50
51
52
53
#define evdns_base_resolve_ipv4(base, addr, options, cb, ptr) \
  ((evdns_resolve_ipv4(addr, options, cb, ptr)<0) ? NULL : ((void*)1))
#define evdns_base_resolve_reverse(base, addr, options, cb, ptr) \
  ((evdns_resolve_reverse(addr, options, cb, ptr)<0) ? NULL : ((void*)1))
#define evdns_base_resolve_reverse_ipv6(base, addr, options, cb, ptr) \
  ((evdns_resolve_reverse_ipv6(addr, options, cb, ptr)<0) ? NULL : ((void*)1))
54
55
56
57
58
59
60
61

#elif defined(LIBEVENT_VERSION_NUMBER) && LIBEVENT_VERSION_NUMBER < 0x02000303
#define evdns_base_set_option_(base, opt, val) \
  evdns_base_set_option((base), (opt),(val),DNS_OPTIONS_ALL)

#else
#define evdns_base_set_option_ evdns_base_set_option

62
63
#endif

Roger Dingledine's avatar
Roger Dingledine committed
64
/** Longest hostname we're willing to resolve. */
65
66
#define MAX_ADDRESSLEN 256

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

Roger Dingledine's avatar
Roger Dingledine committed
71
/** Possible outcomes from hostname lookup: permanent failure,
72
 * transient (retryable) failure, and success. */
73
74
75
76
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

77
78
79
/** Our evdns_base; this structure handles all our name lookups. */
static struct evdns_base *the_evdns_base = NULL;

80
81
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
82
83
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
84
85
86
87
88
89
/** 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;
90

Roger Dingledine's avatar
Roger Dingledine committed
91
/** Linked list of connections waiting for a DNS answer. */
92
typedef struct pending_connection_t {
93
  edge_connection_t *conn;
94
  struct pending_connection_t *next;
95
} pending_connection_t;
96

97
98
/** Value of 'magic' field for cached_resolve_t.  Used to try to catch bad
 * pointers and memory stomping. */
99
100
#define CACHED_RESOLVE_MAGIC 0x1234F00D

101
102
103
104
105
106
107
/* Possible states for a cached resolve_t */
/** We are waiting for the resolver system to tell us an answer here.
 * When we get one, or when we time out, the state of this cached_resolve_t
 * will become "DONE" and we'll possibly add a CACHED_VALID or a CACHED_FAILED
 * entry. This cached_resolve_t will be in the hash table so that we will
 * know not to launch more requests for this addr, but rather to add more
 * connections to the pending list for the addr. */
108
#define CACHE_STATE_PENDING 0
109
110
111
/** This used to be a pending cached_resolve_t, and we got an answer for it.
 * Now we're waiting for this cached_resolve_t to expire.  This should
 * have no pending connections, and should not appear in the hash table. */
112
#define CACHE_STATE_DONE 1
113
114
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
115
#define CACHE_STATE_CACHED_VALID 2
116
117
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
118
119
#define CACHE_STATE_CACHED_FAILED 3

Roger Dingledine's avatar
Roger Dingledine committed
120
/** A DNS request: possibly completed, possibly pending; cached_resolve
121
 * structs are stored at the OR side in a hash table, and as a linked
122
123
 * list from oldest to newest.
 */
124
typedef struct cached_resolve_t {
125
  HT_ENTRY(cached_resolve_t) node;
126
  uint32_t magic;
127
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
128
  union {
129
130
131
132
    struct {
      struct in6_addr addr6; /**< IPv6 addr for <b>address</b>. */
      uint32_t addr;  /**< IPv4 addr for <b>address</b>. */
    } a;
133
134
    char *hostname; /**< Hostname for <b>address</b> (if a reverse lookup) */
  } result;
135
  uint8_t state; /**< Is this cached entry pending/done/valid/failed? */
136
  uint8_t is_reverse; /**< Is this a reverse (addr-to-hostname) lookup? */
137
  time_t expire; /**< Remove items from cache after this time. */
138
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
139
  /** Connections that want to know when we get an answer for this resolve. */
140
  pending_connection_t *pending_connections;
141
142
  /** Position of this element in the heap*/
  int minheap_idx;
143
} cached_resolve_t;
144

145
static void purge_expired_resolves(time_t now);
146
static void dns_found_answer(const char *address, uint8_t is_reverse,
147
                             uint32_t addr, const char *hostname, char outcome,
148
                             uint32_t ttl);
149
150
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
151
static void add_wildcarded_test_address(const char *address);
152
static int configure_nameservers(int force);
153
static int answer_is_wildcarded(const char *ip);
154
155
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                            or_circuit_t *oncirc, char **resolved_to_hostname);
156
#ifdef DEBUG_DNS_CACHE
157
static void _assert_cache_ok(void);
158
159
#define assert_cache_ok() _assert_cache_ok()
#else
160
#define assert_cache_ok() STMT_NIL
161
#endif
162
static void assert_resolve_ok(cached_resolve_t *resolve);
163

164
165
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
166

Roger Dingledine's avatar
Roger Dingledine committed
167
/** Function to compare hashed resolves on their addresses; used to
168
 * implement hash tables. */
169
170
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
171
{
172
  /* make this smarter one day? */
173
  assert_resolve_ok(a); // Not b; b may be just a search.
174
175
176
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

177
/** Hash function for cached_resolve objects */
178
179
180
181
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
182
183
}

184
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
185
             cached_resolves_eq)
186
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
187
            cached_resolves_eq, 0.6, malloc, realloc, free)
188

189
/** Initialize the DNS cache. */
190
static void
191
init_cache_map(void)
192
{
193
  HT_INIT(cache_map, &cache_root);
194
195
}

196
/** Helper: called by eventdns when eventdns wants to log something. */
197
static void
198
evdns_log_cb(int warn, const char *msg)
199
{
200
  const char *cp;
201
202
  static int all_down = 0;
  int severity = warn ? LOG_WARN : LOG_INFO;
203
204
205
206
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
207
208
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
209
  }
210
211
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
212
    const char *err = strchr(cp, ':')+2;
213
    tor_assert(err);
214
215
216
    /* 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. */
217
    severity = LOG_INFO;
218
    control_event_server_status(LOG_NOTICE,
219
220
221
222
223
224
                                "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));
225
    severity = (all_down && warn) ? LOG_NOTICE : LOG_INFO;
226
    all_down = 0;
227
228
229
230
231
    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");
232
    all_down = 1;
233
  }
234
  log(severity, LD_EXIT, "eventdns: %s", msg);
235
236
}

237
238
/** Helper: passed to eventdns.c as a callback so it can generate random
 * numbers for transaction IDs and 0x20-hack coding. */
239
static void
240
_dns_randfn(char *b, size_t n)
241
{
242
  crypto_rand(b,n);
243
244
}

Roger Dingledine's avatar
Roger Dingledine committed
245
/** Initialize the DNS subsystem; called by the OR process. */
246
int
247
248
dns_init(void)
{
249
  init_cache_map();
250
  evdns_set_random_bytes_fn(_dns_randfn);
251
252
253
254
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
255
  return 0;
256
}
257

258
259
260
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
261
262
263
264
dns_reset(void)
{
  or_options_t *options = get_options();
  if (! server_mode(options)) {
265
266
267
268
269
270
271
272

    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;
      }
    }

273
274
    evdns_base_clear_nameservers_and_suspend(the_evdns_base);
    evdns_base_search_clear(the_evdns_base);
275
276
277
278
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
279
    if (configure_nameservers(0) < 0) {
280
      return -1;
281
    }
282
  }
283
  return 0;
284
285
}

Nick Mathewson's avatar
Nick Mathewson committed
286
287
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
288
289
290
291
292
293
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

294
295
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
296
297
298
299
300
301
302
303
304
305
306
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;
}

307
308
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
309
310
311
312
313
314
315
316
317
318
319
static uint32_t
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;
}

320
/** Helper: free storage held by an entry in the DNS cache. */
321
static void
322
_free_cached_resolve(cached_resolve_t *r)
323
{
324
325
  if (!r)
    return;
Nick Mathewson's avatar
Nick Mathewson committed
326
  while (r->pending_connections) {
327
    pending_connection_t *victim = r->pending_connections;
328
329
330
    r->pending_connections = victim->next;
    tor_free(victim);
  }
331
332
  if (r->is_reverse)
    tor_free(r->result.hostname);
333
  r->magic = 0xFF00FF00;
334
335
336
  tor_free(r);
}

337
338
339
/** 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. */
340
static int
341
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
342
{
343
  const cached_resolve_t *a = _a, *b = _b;
344
345
346
347
348
349
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
350
351
}

352
353
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
354
355
static smartlist_t *cached_resolve_pqueue = NULL;

356
357
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
358
359
360
361
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
362
363
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
364
365
366
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
367
                       STRUCT_OFFSET(cached_resolve_t, minheap_idx),
368
369
370
                       resolve);
}

371
/** Free all storage held in the DNS cache and related structures. */
372
373
374
void
dns_free_all(void)
{
375
  cached_resolve_t **ptr, **next, *item;
376
  assert_cache_ok();
377
378
379
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
380
        if (res->state == CACHE_STATE_DONE)
381
382
383
          _free_cached_resolve(res);
      });
  }
384
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
385
    item = *ptr;
386
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
387
    _free_cached_resolve(item);
388
  }
389
  HT_CLEAR(cache_map, &cache_root);
390
  smartlist_free(cached_resolve_pqueue);
391
  cached_resolve_pqueue = NULL;
392
  tor_free(resolv_conf_fname);
393
394
}

395
396
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
397
static void
398
purge_expired_resolves(time_t now)
399
{
Nick Mathewson's avatar
Nick Mathewson committed
400
  cached_resolve_t *resolve, *removed;
401
  pending_connection_t *pend;
402
  edge_connection_t *pendconn;
403

Nick Mathewson's avatar
Nick Mathewson committed
404
  assert_cache_ok();
405
406
407
408
409
410
411
412
  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,
413
414
                         _compare_cached_resolves_by_expiry,
                         STRUCT_OFFSET(cached_resolve_t, minheap_idx));
415

416
    if (resolve->state == CACHE_STATE_PENDING) {
417
      log_debug(LD_EXIT,
418
419
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
420
421
422
423
424
425
426
427
428
429
430
                escaped_safe_str(resolve->address));
    } else if (resolve->state == CACHE_STATE_CACHED_VALID ||
               resolve->state == CACHE_STATE_CACHED_FAILED) {
      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);
431
    }
432

433
    if (resolve->pending_connections) {
434
      log_debug(LD_EXIT,
435
                "Closing pending connections on timed-out DNS resolve!");
436
      tor_fragile_assert();
437
438
439
440
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
441
        tor_assert(pend->conn->_base.s == -1);
442
        pendconn = pend->conn;
443
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT);
444
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
445
        connection_free(TO_CONN(pendconn));
446
447
        tor_free(pend);
      }
448
    }
449

450
451
452
453
454
455
456
    if (resolve->state == CACHE_STATE_CACHED_VALID ||
        resolve->state == CACHE_STATE_CACHED_FAILED ||
        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).",
457
                resolve->address, (void*)resolve,
458
                removed ? removed->address : "NULL", (void*)removed);
459
460
461
      }
      tor_assert(removed == resolve);
    } else {
462
      /* This should be in state DONE. Make sure it's not in the cache. */
463
464
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
465
    }
466
467
468
469
    if (resolve->is_reverse)
      tor_free(resolve->result.hostname);
    resolve->magic = 0xF0BBF0BB;
    tor_free(resolve);
470
  }
471

Nick Mathewson's avatar
Nick Mathewson committed
472
  assert_cache_ok();
473
474
}

475
476
477
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
478
479
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
480
481
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
482
 */
483
static void
484
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
485
486
{
  char buf[RELAY_PAYLOAD_SIZE];
487
  size_t buflen;
488
  uint32_t ttl;
489
490

  buf[0] = answer_type;
491
  ttl = dns_clip_ttl(conn->address_ttl);
492
493
494
495
496

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
497
      set_uint32(buf+2, tor_addr_to_ipv4n(&conn->_base.addr));
498
      set_uint32(buf+6, htonl(ttl));
499
      buflen = 10;
500
      break;
501
    /*XXXX IP6 need ipv6 implementation */
502
503
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
504
505
      {
        const char *errmsg = "Error resolving hostname";
506
        size_t msglen = strlen(errmsg);
507

508
509
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
510
        set_uint32(buf+2+msglen, htonl(ttl));
511
512
513
        buflen = 6+msglen;
        break;
      }
514
515
    default:
      tor_assert(0);
516
      return;
517
    }
518
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
519

520
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
521
522
}

523
524
525
/** 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.
526
527
528
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
529
 * <b>conn</b>'s attached circuit.
530
531
 */
static void
532
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
533
534
535
536
537
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
538
  tor_assert(hostname);
539
540
541
542
543
544
545
546
547
548

  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;

549
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
550
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
551
  // log_notice(LD_EXIT, "Sent");
552
553
}

Nick Mathewson's avatar
Nick Mathewson committed
554
555
/** See if we have a cache entry for <b>exitconn</b>-\>address. if so,
 * if resolve valid, put it into <b>exitconn</b>-\>addr and return 1.
Roger Dingledine's avatar
Roger Dingledine committed
556
 * If resolve failed, free exitconn and return -1.
557
 *
558
559
560
561
562
 * (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.)
 *
563
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
564
 * circuit.
565
 *
566
567
568
569
570
 * 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.
571
572
573
574
575
576
 *
 * 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.
577
 */
578
int
579
dns_resolve(edge_connection_t *exitconn)
580
581
582
583
584
585
{
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
  int is_resolve, r;
  char *hostname = NULL;
  is_resolve = exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE;

586
587
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname);

588
589
  switch (r) {
    case 1:
590
591
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
592
      if (is_resolve) {
593
        /* Send the answer back right now, and detach. */
594
595
596
597
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
598
        exitconn->on_circuit = NULL;
599
      } else {
600
601
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
602
603
604
605
606
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
607
608
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
609
610
611
612
613
614
      exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
615
      /* The request failed before it could start: cancel this connection,
616
       * and stop everybody waiting for the same connection. */
617
618
619
620
      if (is_resolve) {
        send_resolved_cell(exitconn,
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT);
      }
621

622
      exitconn->on_circuit = NULL;
623
624
625

      dns_cancel_pending_resolve(exitconn->_base.address);

626
      if (!exitconn->_base.marked_for_close) {
627
        connection_free(TO_CONN(exitconn));
628
        // XXX ... and we just leak exitconn otherwise? -RD
629
630
631
        // If it's marked for close, it's on closeable_connection_lst in
        // main.c.  If it's on the closeable list, it will get freed from
        // main.c. -NM
632
        // "<armadev> If that's true, there are other bugs around, where we
633
        //  don't check if it's marked, and will end up double-freeing."
634
635
        // On the other hand, I don't know of any actual bugs here, so this
        // shouldn't be holding up the rc. -RD
636
      }
637
638
639
640
641
642
643
644
645
646
647
648
649
650
      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
651
652
653
 * 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.
654
655
656
657
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                 or_circuit_t *oncirc, char **hostname_out)
658
{
659
660
661
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
662
  routerinfo_t *me;
663
  tor_addr_t addr;
664
  time_t now = time(NULL);
665
666
  uint8_t is_reverse = 0;
  int r;
667
668
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
669
  assert_cache_ok();
670
  tor_assert(oncirc);
671

672
  /* first check if exitconn->_base.address is an IP. If so, we already
673
   * know the answer. */
674
  if (tor_addr_from_str(&addr, exitconn->_base.address) >= 0) {
675
    if (tor_addr_family(&addr) == AF_INET) {
676
      tor_addr_copy(&exitconn->_base.addr, &addr);
677
678
679
680
681
682
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
      /* XXXX IPv6 */
      return -1;
    }
683
  }
684

685
686
687
688
689
  /* If we're a non-exit, don't even do DNS lookups. */
  if (!(me = router_get_my_routerinfo()) ||
      policy_is_reject_star(me->exit_policy)) {
    return -1;
  }
690
691
692
693
694
695
  if (address_is_invalid_destination(exitconn->_base.address, 0)) {
    log(LOG_PROTOCOL_WARN, LD_EXIT,
        "Rejecting invalid destination address %s",
        escaped_safe_str(exitconn->_base.address));
    return -1;
  }
696
697

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

701
702
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
703

704
705
  /* 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
706
   * connection.
707
   */
708
709
  if ((r = tor_addr_parse_reverse_lookup_name(&addr, exitconn->_base.address,
                                              AF_UNSPEC, 0)) != 0) {
710
    if (r == 1) {
711
      is_reverse = 1;
712
713
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
714
    }
715
716
717
718
719
720
721
722
723
724
725
726
727

    if (!is_reverse || !is_resolve) {
      if (!is_reverse)
        log_info(LD_EXIT, "Bad .in-addr.arpa address \"%s\"; sending error.",
                 escaped_safe_str(exitconn->_base.address));
      else if (!is_resolve)
        log_info(LD_EXIT,
                 "Attempt to connect to a .in-addr.arpa address \"%s\"; "
                 "sending error.",
                 escaped_safe_str(exitconn->_base.address));

      return -1;
    }
728
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
729
    //exitconn->_base.address);
730
731
  }

732
  /* now check the hash table to see if 'address' is already there. */
733
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
734
  resolve = HT_FIND(cache_map, &cache_root, &search);
735
  if (resolve && resolve->expire > now) { /* already there */
736
    switch (resolve->state) {
737
738
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
739
        pending_connection = tor_malloc_zero(
740
                                      sizeof(pending_connection_t));
741
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
742
743
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
744
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
745
746
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
747
        return 0;
748
      case CACHE_STATE_CACHED_VALID:
749
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
750
                  exitconn->_base.s,
751
752
753
754
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
755
          *hostname_out = tor_strdup(resolve->result.hostname);
756
        } else {
757
          tor_addr_from_ipv4h(&exitconn->_base.addr, resolve->result.a.addr);
758
        }
759
        return 1;
760
      case CACHE_STATE_CACHED_FAILED:
761
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
762
763
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
764
        return -1;
765
766
767
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
768
    }
Roger Dingledine's avatar
Roger Dingledine committed
769
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
770
  }
771
  tor_assert(!resolve);
Roger Dingledine's avatar
Roger Dingledine committed
772
  /* not there, need to add it */
773
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
774
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
775
  resolve->state = CACHE_STATE_PENDING;
776
  resolve->minheap_idx = -1;
777
  resolve->is_reverse = is_reverse;
778
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
779

780
  /* add this connection to the pending list */
781
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
782
783
784
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;

785
  /* Add this resolve to the cache and priority queue. */
786
  HT_INSERT(cache_map, &cache_root, resolve);
787
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
788

789
  log_debug(LD_EXIT,"Launching %s.",
790
            escaped_safe_str(exitconn->_base.address));
791
  assert_cache_ok();
792

793
  return launch_resolve(exitconn);
794
795
}

796
/** Log an error and abort if conn is waiting for a DNS resolve.
797
 */
798
void
799
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
800
{
801
  pending_connection_t *pend;
802
  cached_resolve_t search;
803

804
805
806
807
808
809
810
811
812
813
814
#if 1
  cached_resolve_t *resolve;
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
  resolve = HT_FIND(cache_map, &cache_root, &search);
  if (!resolve)
    return;
  for (pend = resolve->pending_connections; pend; pend = pend->next) {
    tor_assert(pend->conn != conn);
  }
#else
  cached_resolve_t **resolve;
815
  HT_FOREACH(resolve, cache_map, &cache_root) {
816
    for (pend = (*resolve)->pending_connections; pend; pend = pend->next) {
817
818
      tor_assert(pend->conn != conn);
    }
819
  }
820
#endif
821
}
822

823
824
825
826
827
828
829
/** Log an error and abort if any connection waiting for a DNS resolve is
 * corrupted. */
void
assert_all_pending_dns_resolves_ok(void)
{
  pending_connection_t *pend;
  cached_resolve_t **resolve;
830

831
832
833
834
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
835
836
837
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
838
    }
839
840
841
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
842
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
843
 */
844
void
845
connection_dns_remove(edge_connection_t *conn)
846
{
847
848
849
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
850

851
852
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
853

854
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
855

856
  resolve = HT_FIND(cache_map, &cache_root, &search);
857
  if (!resolve) {
858
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
859
               escaped_safe_str(conn->_base.address));
860
861
862
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
863
  tor_assert(resolve->pending_connections);
864
  assert_connection_ok(TO_CONN(conn),0);
865
866
867

  pend = resolve->pending_connections;

868
  if (pend->conn == conn) {
869
    resolve->pending_connections = pend->next;
870
    tor_free(pend);
871
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
872
              "for resolve of %s",
873
              conn->_base.s,
874
              escaped_safe_str(conn->_base.address));
875
876
    return;
  } else {
877
878
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {