dns.c 57.2 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
Karsten Loesing's avatar
Karsten Loesing committed
3
 * Copyright (c) 2007-2009, 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"
15
#include "ht.h"
16
#include "eventdns.h"
17

Roger Dingledine's avatar
Roger Dingledine committed
18
/** Longest hostname we're willing to resolve. */
19
20
#define MAX_ADDRESSLEN 256

21
22
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
23
24
#define RESOLVE_MAX_TIMEOUT 300

Roger Dingledine's avatar
Roger Dingledine committed
25
/** Possible outcomes from hostname lookup: permanent failure,
26
 * transient (retryable) failure, and success. */
27
28
29
30
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

31
32
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
33
34
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
35
36
37
38
39
40
/** 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;
41

Roger Dingledine's avatar
Roger Dingledine committed
42
/** Linked list of connections waiting for a DNS answer. */
43
typedef struct pending_connection_t {
44
  edge_connection_t *conn;
45
  struct pending_connection_t *next;
46
} pending_connection_t;
47

48
49
/** Value of 'magic' field for cached_resolve_t.  Used to try to catch bad
 * pointers and memory stomping. */
50
51
#define CACHED_RESOLVE_MAGIC 0x1234F00D

52
53
54
55
56
57
58
/* 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. */
59
#define CACHE_STATE_PENDING 0
60
61
62
/** 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. */
63
#define CACHE_STATE_DONE 1
64
65
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
66
#define CACHE_STATE_CACHED_VALID 2
67
68
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
69
70
#define CACHE_STATE_CACHED_FAILED 3

Roger Dingledine's avatar
Roger Dingledine committed
71
/** A DNS request: possibly completed, possibly pending; cached_resolve
72
 * structs are stored at the OR side in a hash table, and as a linked
73
74
 * list from oldest to newest.
 */
75
typedef struct cached_resolve_t {
76
  HT_ENTRY(cached_resolve_t) node;
77
  uint32_t magic;
78
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
79
  union {
80
81
82
83
    struct {
      struct in6_addr addr6; /**< IPv6 addr for <b>address</b>. */
      uint32_t addr;  /**< IPv4 addr for <b>address</b>. */
    } a;
84
85
    char *hostname; /**< Hostname for <b>address</b> (if a reverse lookup) */
  } result;
86
  uint8_t state; /**< Is this cached entry pending/done/valid/failed? */
87
  uint8_t is_reverse; /**< Is this a reverse (addr-to-hostname) lookup? */
88
  time_t expire; /**< Remove items from cache after this time. */
89
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
90
  /** Connections that want to know when we get an answer for this resolve. */
91
92
  pending_connection_t *pending_connections;
} cached_resolve_t;
93

94
static void purge_expired_resolves(time_t now);
95
static void dns_found_answer(const char *address, uint8_t is_reverse,
96
                             uint32_t addr, const char *hostname, char outcome,
97
                             uint32_t ttl);
98
99
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
100
static void add_wildcarded_test_address(const char *address);
101
static int configure_nameservers(int force);
102
static int answer_is_wildcarded(const char *ip);
103
104
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                            or_circuit_t *oncirc, char **resolved_to_hostname);
105
#ifdef DEBUG_DNS_CACHE
106
static void _assert_cache_ok(void);
107
108
#define assert_cache_ok() _assert_cache_ok()
#else
109
#define assert_cache_ok() STMT_NIL
110
#endif
111
static void assert_resolve_ok(cached_resolve_t *resolve);
112

113
114
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
115

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

126
/** Hash function for cached_resolve objects */
127
128
129
130
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
131
132
}

133
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
134
             cached_resolves_eq)
135
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
136
            cached_resolves_eq, 0.6, malloc, realloc, free)
137

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

145
/** Helper: called by eventdns when eventdns wants to log something. */
146
static void
147
evdns_log_cb(int warn, const char *msg)
148
{
149
  const char *cp;
150
151
  static int all_down = 0;
  int severity = warn ? LOG_WARN : LOG_INFO;
152
153
154
155
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
156
157
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
158
  }
159
160
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
161
    const char *err = strchr(cp, ':')+2;
162
    tor_assert(err);
163
164
165
    /* 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. */
166
    severity = LOG_INFO;
167
    control_event_server_status(LOG_NOTICE,
168
169
170
171
172
173
                                "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));
174
    severity = (all_down && warn) ? LOG_NOTICE : LOG_INFO;
175
    all_down = 0;
176
177
178
179
180
    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");
181
    all_down = 1;
182
  }
183
  log(severity, LD_EXIT, "eventdns: %s", msg);
184
185
}

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

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

207
208
209
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
210
211
212
213
dns_reset(void)
{
  or_options_t *options = get_options();
  if (! server_mode(options)) {
214
215
    evdns_clear_nameservers_and_suspend();
    evdns_search_clear();
216
217
218
219
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
220
    if (configure_nameservers(0) < 0) {
221
      return -1;
222
    }
223
  }
224
  return 0;
225
226
}

Nick Mathewson's avatar
Nick Mathewson committed
227
228
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
229
230
231
232
233
234
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

235
236
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
237
238
239
240
241
242
243
244
245
246
247
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;
}

248
249
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
250
251
252
253
254
255
256
257
258
259
260
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;
}

261
/** Helper: free storage held by an entry in the DNS cache. */
262
static void
263
_free_cached_resolve(cached_resolve_t *r)
264
{
Nick Mathewson's avatar
Nick Mathewson committed
265
  while (r->pending_connections) {
266
    pending_connection_t *victim = r->pending_connections;
267
268
269
    r->pending_connections = victim->next;
    tor_free(victim);
  }
270
271
  if (r->is_reverse)
    tor_free(r->result.hostname);
272
  r->magic = 0xFF00FF00;
273
274
275
  tor_free(r);
}

276
277
278
/** 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. */
279
static int
280
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
281
{
282
  const cached_resolve_t *a = _a, *b = _b;
283
284
285
286
287
288
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
289
290
}

291
292
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
293
294
static smartlist_t *cached_resolve_pqueue = NULL;

295
296
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
297
298
299
300
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
301
302
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
303
304
305
306
307
308
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

309
/** Free all storage held in the DNS cache and related structures. */
310
311
312
void
dns_free_all(void)
{
313
  cached_resolve_t **ptr, **next, *item;
314
  assert_cache_ok();
315
316
317
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
318
        if (res->state == CACHE_STATE_DONE)
319
320
321
          _free_cached_resolve(res);
      });
  }
322
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
323
    item = *ptr;
324
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
325
    _free_cached_resolve(item);
326
  }
327
  HT_CLEAR(cache_map, &cache_root);
328
329
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
330
  cached_resolve_pqueue = NULL;
331
  tor_free(resolv_conf_fname);
332
333
}

334
335
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
336
static void
337
purge_expired_resolves(time_t now)
338
{
Nick Mathewson's avatar
Nick Mathewson committed
339
  cached_resolve_t *resolve, *removed;
340
  pending_connection_t *pend;
341
  edge_connection_t *pendconn;
342

Nick Mathewson's avatar
Nick Mathewson committed
343
  assert_cache_ok();
344
345
346
347
348
349
350
351
352
353
  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,
                         _compare_cached_resolves_by_expiry);

354
    if (resolve->state == CACHE_STATE_PENDING) {
355
      log_debug(LD_EXIT,
356
357
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
358
359
360
361
362
363
364
365
366
367
368
                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);
369
    }
370

371
    if (resolve->pending_connections) {
372
      log_debug(LD_EXIT,
373
                "Closing pending connections on timed-out DNS resolve!");
374
      tor_fragile_assert();
375
376
377
378
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
379
        tor_assert(pend->conn->_base.s == -1);
380
        pendconn = pend->conn;
381
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT);
382
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
383
        connection_free(TO_CONN(pendconn));
384
385
        tor_free(pend);
      }
386
    }
387

388
389
390
391
392
393
394
    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).",
395
396
                resolve->address, (void*)resolve,
                removed ? removed->address : "NULL", (void*)remove);
397
398
399
      }
      tor_assert(removed == resolve);
    } else {
400
      /* This should be in state DONE. Make sure it's not in the cache. */
401
402
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
403
    }
404
405
406
407
    if (resolve->is_reverse)
      tor_free(resolve->result.hostname);
    resolve->magic = 0xF0BBF0BB;
    tor_free(resolve);
408
  }
409

Nick Mathewson's avatar
Nick Mathewson committed
410
  assert_cache_ok();
411
412
}

413
414
415
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
416
417
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
418
419
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
420
 */
421
static void
422
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
423
424
{
  char buf[RELAY_PAYLOAD_SIZE];
425
  size_t buflen;
426
  uint32_t ttl;
427
428

  buf[0] = answer_type;
429
  ttl = dns_clip_ttl(conn->address_ttl);
430
431
432
433
434

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
435
      set_uint32(buf+2, tor_addr_to_ipv4n(&conn->_base.addr));
436
      set_uint32(buf+6, htonl(ttl));
437
      buflen = 10;
438
      break;
439
    /*XXXX IP6 need ipv6 implementation */
440
441
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
442
443
      {
        const char *errmsg = "Error resolving hostname";
444
        size_t msglen = strlen(errmsg);
445

446
447
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
448
        set_uint32(buf+2+msglen, htonl(ttl));
449
450
451
        buflen = 6+msglen;
        break;
      }
452
453
    default:
      tor_assert(0);
454
      return;
455
    }
456
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
457

458
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
459
460
}

461
462
463
/** 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.
464
465
466
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
467
 * <b>conn</b>'s attached circuit.
468
469
 */
static void
470
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
471
472
473
474
475
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
476
  tor_assert(hostname);
477
478
479
480
481
482
483
484
485
486

  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;

487
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
488
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
489
  // log_notice(LD_EXIT, "Sent");
490
491
}

Nick Mathewson's avatar
Nick Mathewson committed
492
493
/** 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
494
 * If resolve failed, free exitconn and return -1.
495
 *
496
497
498
499
500
 * (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.)
 *
501
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
502
 * circuit.
503
 *
504
505
506
507
508
 * 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.
509
510
511
512
513
514
 *
 * 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.
515
 */
516
int
517
dns_resolve(edge_connection_t *exitconn)
518
519
520
521
522
523
{
  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;

524
525
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname);

526
527
  switch (r) {
    case 1:
528
529
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
530
      if (is_resolve) {
531
        /* Send the answer back right now, and detach. */
532
533
534
535
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
536
        exitconn->on_circuit = NULL;
537
      } else {
538
539
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
540
541
542
543
544
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
545
546
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
547
548
549
550
551
552
      exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
553
      /* The request failed before it could start: cancel this connection,
554
       * and stop everybody waiting for the same connection. */
555
556
557
558
      if (is_resolve) {
        send_resolved_cell(exitconn,
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT);
      }
559

560
      exitconn->on_circuit = NULL;
561
562
563

      dns_cancel_pending_resolve(exitconn->_base.address);

564
      if (!exitconn->_base.marked_for_close) {
565
        connection_free(TO_CONN(exitconn));
566
        // XXX ... and we just leak exitconn otherwise? -RD
567
568
569
        // 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
570
        // "<armadev> If that's true, there are other bugs around, where we
571
        //  don't check if it's marked, and will end up double-freeing."
572
573
        // On the other hand, I don't know of any actual bugs here, so this
        // shouldn't be holding up the rc. -RD
574
      }
575
576
577
578
579
580
581
582
583
584
585
586
587
588
      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
589
590
591
 * 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.
592
593
594
595
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                 or_circuit_t *oncirc, char **hostname_out)
596
{
597
598
599
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
600
  routerinfo_t *me;
601
  tor_addr_t addr;
602
  time_t now = time(NULL);
603
604
  uint8_t is_reverse = 0;
  int r;
605
606
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
607
  assert_cache_ok();
608
  tor_assert(oncirc);
609

610
  /* first check if exitconn->_base.address is an IP. If so, we already
611
   * know the answer. */
612
  if (tor_addr_from_str(&addr, exitconn->_base.address) >= 0) {
613
614
615
616
617
618
619
620
    if (tor_addr_family(&addr) == AF_INET) {
      tor_addr_assign(&exitconn->_base.addr, &addr);
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
      /* XXXX IPv6 */
      return -1;
    }
621
  }
622

623
624
625
626
627
  /* 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;
  }
628
629
630
631
632
633
  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;
  }
634
635

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

639
640
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
641

642
643
  /* 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
644
   * connection.
645
   */
646
647
  if ((r = tor_addr_parse_reverse_lookup_name(&addr, exitconn->_base.address,
                                              AF_UNSPEC, 0)) != 0) {
648
    if (r == 1) {
649
      is_reverse = 1;
650
651
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
652
    }
653
654
655
656
657
658
659
660
661
662
663
664
665

    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;
    }
666
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
667
    //exitconn->_base.address);
668
669
  }

670
  /* now check the hash table to see if 'address' is already there. */
671
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
672
  resolve = HT_FIND(cache_map, &cache_root, &search);
673
  if (resolve && resolve->expire > now) { /* already there */
674
    switch (resolve->state) {
675
676
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
677
        pending_connection = tor_malloc_zero(
678
                                      sizeof(pending_connection_t));
679
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
680
681
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
682
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
683
684
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
685
        return 0;
686
      case CACHE_STATE_CACHED_VALID:
687
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
688
                  exitconn->_base.s,
689
690
691
692
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
693
          *hostname_out = tor_strdup(resolve->result.hostname);
694
        } else {
695
          tor_addr_from_ipv4h(&exitconn->_base.addr, resolve->result.a.addr);
696
        }
697
        return 1;
698
      case CACHE_STATE_CACHED_FAILED:
699
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
700
701
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
702
        return -1;
703
704
705
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
706
    }
Roger Dingledine's avatar
Roger Dingledine committed
707
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
708
  }
709
  tor_assert(!resolve);
Roger Dingledine's avatar
Roger Dingledine committed
710
  /* not there, need to add it */
711
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
712
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
713
  resolve->state = CACHE_STATE_PENDING;
714
  resolve->is_reverse = is_reverse;
715
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
716

717
  /* add this connection to the pending list */
718
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
719
720
721
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;

722
  /* Add this resolve to the cache and priority queue. */
723
  HT_INSERT(cache_map, &cache_root, resolve);
724
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
725

726
  log_debug(LD_EXIT,"Launching %s.",
727
            escaped_safe_str(exitconn->_base.address));
728
  assert_cache_ok();
729

730
  return launch_resolve(exitconn);
731
732
}

733
/** Log an error and abort if conn is waiting for a DNS resolve.
734
 */
735
void
736
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
737
{
738
  pending_connection_t *pend;
739
  cached_resolve_t search;
740

741
742
743
744
745
746
747
748
749
750
751
#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;
752
  HT_FOREACH(resolve, cache_map, &cache_root) {
753
    for (pend = (*resolve)->pending_connections; pend; pend = pend->next) {
754
755
      tor_assert(pend->conn != conn);
    }
756
  }
757
#endif
758
}
759

760
761
762
763
764
765
766
/** 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;
767

768
769
770
771
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
772
773
774
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
775
    }
776
777
778
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
779
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
780
 */
781
void
782
connection_dns_remove(edge_connection_t *conn)
783
{
784
785
786
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
787

788
789
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
790

791
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
792

793
  resolve = HT_FIND(cache_map, &cache_root, &search);
794
  if (!resolve) {
795
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
796
               escaped_safe_str(conn->_base.address));
797
798
799
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
800
  tor_assert(resolve->pending_connections);
801
  assert_connection_ok(TO_CONN(conn),0);
802
803
804

  pend = resolve->pending_connections;

805
  if (pend->conn == conn) {
806
    resolve->pending_connections = pend->next;
807
    tor_free(pend);
808
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
809
              "for resolve of %s",
810
              conn->_base.s, escaped_safe_str(conn->_base.address));
811
812
    return;
  } else {
813
814
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
815
816
        victim = pend->next;
        pend->next = victim->next;
817
        tor_free(victim);
818
        log_debug(LD_EXIT,
819
                  "Connection (fd %d) no longer waiting for resolve of %s",
820
                  conn->_base.s, escaped_safe_str(conn->_base.address));
821
822
823
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
824
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
825
826
827
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
828
829
830
/** Mark all connections waiting for <b>address</b> for close.  Then cancel
 * the resolve for <b>address</b> itself, and remove any cached results for
 * <b>address</b> from the cache.
831
 */
832
void
833
dns_cancel_pending_resolve(const char *address)
834
{
835
836
  pending_connection_t *pend;
  cached_resolve_t search;
837
  cached_resolve_t *resolve, *tmp;
838
  edge_connection_t *pendconn;
839
  circuit_t *circ;
840

Nick Mathewson's avatar
Nick Mathewson committed
841
  strlcpy(search.address, address, sizeof(search.address));
842

843
  resolve = HT_FIND(cache_map, &cache_root, &search);
844
845
846
  if (!resolve)
    return;

847
  if (resolve->state != CACHE_STATE_PENDING) {
848
849
850
851
852
853
854
855
856
    /* We can get into this state if we never actually created the pending
     * resolve, due to finding an earlier cached error or something.  Just
     * ignore it. */
    if (resolve->pending_connections) {
      log_warn(LD_BUG,
               "Address %s is not pending but has pending connections!",
               escaped_safe_str(address));
      tor_fragile_assert();
    }
857
858
859
    return;
  }

860
  if (!resolve->pending_connections) {
861
    log_warn(LD_BUG,
862
             "Address %s is pending but has no pending connections!",
863
             escaped_safe_str(address));
864
    tor_fragile_assert();
865
866
    return