dns.c 46 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
/* Copyright 2003-2004 Roger Dingledine.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright 2004-2006 Roger Dingledine, Nick Mathewson. */
3
4
/* See LICENSE for licensing information */
/* $Id$ */
5
6
const char dns_c_id[] =
  "$Id$";
7

Roger Dingledine's avatar
Roger Dingledine committed
8
9
/**
 * \file dns.c
10
 * \brief Implements a local cache for DNS results for Tor servers.
11
 * We provide two asynchronous backend implementations:
12
13
14
15
16
17
 *   1) A farm of 'DNS worker' threads or processes to perform DNS lookups for
 *      onion routers and cache the results.
 *   2) A wrapper around Adam Langley's eventdns.c code, to send requests
 *      to the nameservers asynchronously.
 * (We can't just use gethostbyname() and friends because we really need to
 * be nonblocking.)
Roger Dingledine's avatar
Roger Dingledine committed
18
 **/
19

20
#include "or.h"
21
#include "../common/ht.h"
22
23
24
#ifdef USE_EVENTDNS
#include "eventdns.h"
#endif
25

Roger Dingledine's avatar
Roger Dingledine committed
26
/** Longest hostname we're willing to resolve. */
27
28
#define MAX_ADDRESSLEN 256

Roger Dingledine's avatar
Roger Dingledine committed
29
/** Maximum DNS processes to spawn. */
30
#define MAX_DNSWORKERS 100
Roger Dingledine's avatar
Roger Dingledine committed
31
/** Minimum DNS processes to spawn. */
32
#define MIN_DNSWORKERS 3
33

Roger Dingledine's avatar
Roger Dingledine committed
34
/** If more than this many processes are idle, shut down the extras. */
35
#define MAX_IDLE_DNSWORKERS 10
36

37
38
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
39
40
#define RESOLVE_MAX_TIMEOUT 300

Roger Dingledine's avatar
Roger Dingledine committed
41
/** Possible outcomes from hostname lookup: permanent failure,
42
 * transient (retryable) failure, and success. */
43
44
45
46
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

47
#ifndef USE_EVENTDNS
48
/** How many dnsworkers we have running right now. */
49
static int num_dnsworkers=0;
50
/** How many of the running dnsworkers have an assigned task right now. */
51
52
53
static int num_dnsworkers_busy=0;
/** When did we last rotate the dnsworkers? */
static time_t last_rotation_time=0;
54
55
56
57
58
59
60
61
62
#else
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
/** 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;
63
#endif
64

Roger Dingledine's avatar
Roger Dingledine committed
65
/** Linked list of connections waiting for a DNS answer. */
66
typedef struct pending_connection_t {
67
  edge_connection_t *conn;
68
  struct pending_connection_t *next;
69
} pending_connection_t;
70

71
72
#define CACHED_RESOLVE_MAGIC 0x1234F00D

73
74
75
76
77
78
79
/* 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. */
80
#define CACHE_STATE_PENDING 0
81
82
83
/** 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. */
84
#define CACHE_STATE_DONE 1
85
86
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
87
#define CACHE_STATE_CACHED_VALID 2
88
89
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
90
91
#define CACHE_STATE_CACHED_FAILED 3

Roger Dingledine's avatar
Roger Dingledine committed
92
/** A DNS request: possibly completed, possibly pending; cached_resolve
93
 * structs are stored at the OR side in a hash table, and as a linked
94
95
 * list from oldest to newest.
 */
96
typedef struct cached_resolve_t {
97
  HT_ENTRY(cached_resolve_t) node;
98
  uint32_t magic;
99
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
100
  uint32_t addr; /**< IPv4 addr for <b>address</b>. */
101
  uint8_t state; /**< Is this cached entry pending/done/valid/failed? */
102
  time_t expire; /**< Remove items from cache after this time. */
103
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
104
  /** Connections that want to know when we get an answer for this resolve. */
105
106
  pending_connection_t *pending_connections;
} cached_resolve_t;
107

108
static void purge_expired_resolves(time_t now);
109
static void dns_found_answer(const char *address, uint32_t addr, char outcome,
110
                             uint32_t ttl);
111
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
112
static int launch_resolve(edge_connection_t *exitconn);
113
#ifndef USE_EVENTDNS
114
static void dnsworkers_rotate(void);
115
static void dnsworker_main(void *data);
116
static int spawn_dnsworker(void);
117
static int spawn_enough_dnsworkers(void);
118
#else
119
static int configure_nameservers(int force);
120
#endif
121
#ifdef DEBUG_DNS_CACHE
122
static void _assert_cache_ok(void);
123
124
#define assert_cache_ok() _assert_cache_ok()
#else
125
#define assert_cache_ok() do {} while (0)
126
#endif
127
static void assert_resolve_ok(cached_resolve_t *resolve);
128

129
130
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
131

Roger Dingledine's avatar
Roger Dingledine committed
132
/** Function to compare hashed resolves on their addresses; used to
133
 * implement hash tables. */
134
135
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
136
{
137
  /* make this smarter one day? */
138
  assert_resolve_ok(a); // Not b; b may be just a search.
139
140
141
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

142
/** Hash function for cached_resolve objects */
143
144
145
146
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
147
148
}

149
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
150
             cached_resolves_eq);
151
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
152
            cached_resolves_eq, 0.6, malloc, realloc, free);
153

154
/** Initialize the DNS cache. */
155
static void
156
init_cache_map(void)
157
{
158
  HT_INIT(&cache_root);
159
160
}

161
#ifdef USE_EVENTDNS
162
/** Helper: called by eventdns when eventdns wants to log something. */
163
static void
164
eventdns_log_cb(int warn, const char *msg)
165
{
166
167
168
169
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
170
171
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
172
  }
173
  log(warn?LOG_WARN:LOG_INFO, LD_EXIT, "eventdns: %s", msg);
174
175
176
}
#endif

Roger Dingledine's avatar
Roger Dingledine committed
177
/** Initialize the DNS subsystem; called by the OR process. */
178
int
179
180
dns_init(void)
{
181
  init_cache_map();
182
#ifdef USE_EVENTDNS
183
  if (server_mode(get_options()))
184
185
186
    return configure_nameservers(1);
#else
  dnsworkers_rotate();
187
#endif
188
  return 0;
189
}
190

191
/** Called when DNS-related options change (or may have changed) */
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
void
dns_reset(void)
{
#ifdef USE_EVENTDNS
  or_options_t *options = get_options();
  if (! server_mode(options)) {
    eventdns_clear_nameservers_and_suspend();
    eventdns_search_clear();
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
    if (configure_nameservers(0) < 0)
      /* XXXX */
      return;
  }
#else
  dnsworkers_rotate();
#endif
}

213
214
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
215
216
217
218
219
220
221
222
223
224
225
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;
}

226
227
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
228
229
230
231
232
233
234
235
236
237
238
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;
}

239
/** Helper: free storage held by an entry in the DNS cache. */
240
static void
241
_free_cached_resolve(cached_resolve_t *r)
242
{
Nick Mathewson's avatar
Nick Mathewson committed
243
  while (r->pending_connections) {
244
    pending_connection_t *victim = r->pending_connections;
245
246
247
    r->pending_connections = victim->next;
    tor_free(victim);
  }
248
  r->magic = 0xFF00FF00;
249
250
251
  tor_free(r);
}

252
253
254
/** 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. */
255
static int
256
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
257
{
258
  const cached_resolve_t *a = _a, *b = _b;
259
  return a->expire - b->expire;
260
261
}

262
263
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
264
265
static smartlist_t *cached_resolve_pqueue = NULL;

266
267
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
268
269
270
271
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
272
273
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
274
275
276
277
278
279
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

280
/** Free all storage held in the DNS cache and related structures. */
281
282
283
void
dns_free_all(void)
{
284
  cached_resolve_t **ptr, **next, *item;
285
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
286
    item = *ptr;
287
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
288
    _free_cached_resolve(item);
289
  }
290
  HT_CLEAR(cache_map, &cache_root);
291
292
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
293
  cached_resolve_pqueue = NULL;
294
295
296
#ifdef USE_EVENTDNS
  tor_free(resolv_conf_fname);
#endif
297
298
}

Nick Mathewson's avatar
Nick Mathewson committed
299
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
300
 * from the cache. */
301
static void
302
purge_expired_resolves(time_t now)
303
{
Nick Mathewson's avatar
Nick Mathewson committed
304
  cached_resolve_t *resolve, *removed;
305
  pending_connection_t *pend;
306
  edge_connection_t *pendconn;
307

Nick Mathewson's avatar
Nick Mathewson committed
308
  assert_cache_ok();
309
310
311
312
313
314
315
316
317
318
  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);

319
    if (resolve->state == CACHE_STATE_PENDING) {
320
      log_debug(LD_EXIT,
321
322
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
323
324
325
326
327
328
329
330
331
332
333
                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);
334
    }
335

336
    if (resolve->pending_connections) {
337
      log_debug(LD_EXIT,
338
                "Closing pending connections on timed-out DNS resolve!");
339
      tor_fragile_assert();
340
341
342
343
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
344
        tor_assert(pend->conn->_base.s == -1);
345
        pendconn = pend->conn;
346
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
347
                            pendconn->cpath_layer);
348
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
349
        connection_free(TO_CONN(pendconn));
350
351
        tor_free(pend);
      }
352
    }
353

354
355
356
357
358
359
360
    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).",
361
362
                resolve->address, (void*)resolve,
                removed ? removed->address : "NULL", (void*)remove);
363
364
365
366
367
      }
      tor_assert(removed == resolve);
      resolve->magic = 0xF0BBF0BB;
      tor_free(resolve);
    } else {
368
      /* This should be in state DONE. Make sure it's not in the cache. */
369
370
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
371
    }
372
  }
373

Nick Mathewson's avatar
Nick Mathewson committed
374
  assert_cache_ok();
375
376
}

Roger Dingledine's avatar
Roger Dingledine committed
377
/** Send a response to the RESOLVE request of a connection. answer_type must
378
379
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
380
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
381
382
{
  char buf[RELAY_PAYLOAD_SIZE];
383
  size_t buflen;
384
  uint32_t ttl;
385
386

  buf[0] = answer_type;
387
  ttl = dns_clip_ttl(conn->address_ttl);
388
389
390
391
392

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
393
      set_uint32(buf+2, htonl(conn->_base.addr));
394
      set_uint32(buf+6, htonl(ttl));
395
      buflen = 10;
396
397
398
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
399
400
401
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
402

403
404
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
405
        set_uint32(buf+2+msglen, htonl(ttl));
406
407
408
        buflen = 6+msglen;
        break;
      }
409
410
    default:
      tor_assert(0);
411
      return;
412
    }
413
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
414
415
416
417
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

Nick Mathewson's avatar
Nick Mathewson committed
418
419
/** 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.
420
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
421
422
423
424
425
426
427
 *
 * 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.
 */
428
int
429
dns_resolve(edge_connection_t *exitconn)
430
{
431
432
433
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
434
  struct in_addr in;
435
  circuit_t *circ;
436
  time_t now = time(NULL);
437
438
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
439

440
441
  assert_cache_ok();

442
  /* first check if exitconn->_base.address is an IP. If so, we already
443
   * know the answer. */
444
445
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
446
    exitconn->address_ttl = DEFAULT_DNS_TTL;
447
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
448
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
449
    return 1;
450
451
452
  }

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

456
457
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
458

459
  /* now check the hash table to see if 'address' is already there. */
460
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
461
  resolve = HT_FIND(cache_map, &cache_root, &search);
462
  if (resolve && resolve->expire > now) { /* already there */
463
    switch (resolve->state) {
464
465
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
466
        pending_connection = tor_malloc_zero(
467
                                      sizeof(pending_connection_t));
468
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
469
470
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
471
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
472
473
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
474
        exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
475
        return 0;
476
      case CACHE_STATE_CACHED_VALID:
477
        exitconn->_base.addr = resolve->addr;
478
        exitconn->address_ttl = resolve->ttl;
479
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
480
481
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
482
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
483
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
484
        return 1;
485
      case CACHE_STATE_CACHED_FAILED:
486
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
487
488
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
489
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
490
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
491
        circ = circuit_get_by_edge_conn(exitconn);
492
493
        if (circ)
          circuit_detach_stream(circ, exitconn);
494
495
        if (!exitconn->_base.marked_for_close)
          connection_free(TO_CONN(exitconn));
496
        return -1;
497
498
499
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
500
    }
Roger Dingledine's avatar
Roger Dingledine committed
501
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
502
503
  }
  /* not there, need to add it */
504
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
505
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
506
  resolve->state = CACHE_STATE_PENDING;
507
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
508

509
  /* add this connection to the pending list */
510
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
511
512
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
513
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
514

515
  /* Add this resolve to the cache and priority queue. */
516
  HT_INSERT(cache_map, &cache_root, resolve);
517
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
518

519
  log_debug(LD_EXIT,"Launching %s.",
520
            escaped_safe_str(exitconn->_base.address));
521
  assert_cache_ok();
522
  return launch_resolve(exitconn);
523
524
}

525
/** Log an error and abort if conn is waiting for a DNS resolve.
526
 */
527
void
528
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
529
{
530
531
  pending_connection_t *pend;
  cached_resolve_t **resolve;
532

533
534
535
536
537
538
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
539
  }
540
}
541

542
543
544
545
546
547
548
/** 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;
549

550
551
552
553
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
554
555
556
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
557
    }
558
559
560
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
561
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
562
 */
563
void
564
connection_dns_remove(edge_connection_t *conn)
565
{
566
567
568
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
569

570
571
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
572

573
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
574

575
  resolve = HT_FIND(cache_map, &cache_root, &search);
576
  if (!resolve) {
577
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
578
               escaped_safe_str(conn->_base.address));
579
580
581
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
582
  tor_assert(resolve->pending_connections);
583
  assert_connection_ok(TO_CONN(conn),0);
584
585
586

  pend = resolve->pending_connections;

587
  if (pend->conn == conn) {
588
    resolve->pending_connections = pend->next;
589
    tor_free(pend);
590
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
591
              "for resolve of %s",
592
              conn->_base.s, escaped_safe_str(conn->_base.address));
593
594
    return;
  } else {
595
596
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
597
598
        victim = pend->next;
        pend->next = victim->next;
599
        tor_free(victim);
600
        log_debug(LD_EXIT,
601
                  "Connection (fd %d) no longer waiting for resolve of %s",
602
                  conn->_base.s, escaped_safe_str(conn->_base.address));
603
604
605
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
606
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
607
608
609
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
610
611
612
/** 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.
613
 */
614
void
615
dns_cancel_pending_resolve(char *address)
616
{
617
618
  pending_connection_t *pend;
  cached_resolve_t search;
619
  cached_resolve_t *resolve, *tmp;
620
  edge_connection_t *pendconn;
621
  circuit_t *circ;
622

Nick Mathewson's avatar
Nick Mathewson committed
623
  strlcpy(search.address, address, sizeof(search.address));
624

625
  resolve = HT_FIND(cache_map, &cache_root, &search);
626
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
627
628
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
629
630
631
    return;
  }

632
633
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
634
    log_warn(LD_BUG,
635
636
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
637
    tor_fragile_assert();
638
639
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
640
  tor_assert(resolve->pending_connections);
641
  tor_assert(! resolve->expire);
642

643
  /* mark all pending connections to fail */
644
  log_debug(LD_EXIT,
645
646
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
647
  while (resolve->pending_connections) {
648
    pend = resolve->pending_connections;
649
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
650
    pendconn = pend->conn;
651
652
653
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
654
655
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
656
    }
657
    circ = circuit_get_by_edge_conn(pendconn);
658
659
    if (circ)
      circuit_detach_stream(circ, pendconn);
660
    connection_free(TO_CONN(pendconn));
661
662
    resolve->pending_connections = pend->next;
    tor_free(pend);
663
664
  }

Nick Mathewson's avatar
Nick Mathewson committed
665
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
666
667
668
  if (tmp != resolve) {
    log_err(LD_BUG, "The cancelled resolve we purged didn't match any in"
            " the cache. Tried to purge %s (%p); instead got %s (%p).",
669
670
            resolve->address, (void*)resolve,
            tmp ? tmp->address : "NULL", (void*)tmp);
671
  }
Nick Mathewson's avatar
Nick Mathewson committed
672
  tor_assert(tmp == resolve);
673
  resolve->magic = 0xABABABAB;
674
  tor_free(resolve);
675
676
}

677
678
679
/** Helper: adds an entry to the DNS cache mapping <b>address</b> to the ipv4
 * address 'addr'.  'ttl is a cache ttl; 'outcome' is one of
 * DNS_RESOLVE_{FAILED_TRANSIENT|FAILED_PERMANENT|SUCCEEDED}. */
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
static void
add_answer_to_cache(const char *address, uint32_t addr, char outcome,
                    uint32_t ttl)
{
  cached_resolve_t *resolve;
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT)
    return;

  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
  resolve->magic = CACHED_RESOLVE_MAGIC;
  resolve->state = (outcome == DNS_RESOLVE_SUCCEEDED) ?
    CACHE_STATE_CACHED_VALID : CACHE_STATE_CACHED_FAILED;
  strlcpy(resolve->address, address, sizeof(resolve->address));
  resolve->addr = addr;
  resolve->ttl = ttl;
  assert_resolve_ok(resolve);
  HT_INSERT(cache_map, &cache_root, resolve);
  set_expiry(resolve, time(NULL) + dns_get_expiry_ttl(ttl));
}

700
701
702
703
704
/** Called on the OR side when a DNS worker or the eventdns library tells us
 * the outcome of a DNS resolve: tell all pending connections about the result
 * of the lookup, and cache the value.  (<b>address</b> is a NUL-terminated
 * string containing the address to look up; <b>addr</b> is an IPv4 address in
 * host order; <b>outcome</b> is one of
Nick Mathewson's avatar
Nick Mathewson committed
705
 * DNS_RESOLVE_{FAILED_TRANSIENT|FAILED_PERMANENT|SUCCEEDED}.
706
 */
707
static void
708
709
dns_found_answer(const char *address, uint32_t addr, char outcome,
                 uint32_t ttl)
710
{
711
712
  pending_connection_t *pend;
  cached_resolve_t search;
713
  cached_resolve_t *resolve, *removed;
714
  edge_connection_t *pendconn;
715
  circuit_t *circ;
716

717
718
  assert_cache_ok();

Nick Mathewson's avatar
Nick Mathewson committed
719
  strlcpy(search.address, address, sizeof(search.address));
720

721
  resolve = HT_FIND(cache_map, &cache_root, &search);
722
  if (!resolve) {
723
724
    log_info(LD_EXIT,"Resolved unasked address %s; caching anyway.",
             escaped_safe_str(address));
725
    add_answer_to_cache(address, addr, outcome, ttl);
726
    return;
727
  }
728
  assert_resolve_ok(resolve);
729

730
  if (resolve->state != CACHE_STATE_PENDING) {
731
732
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
733
734
    log_notice(LD_EXIT, "Resolved %s which was already resolved; ignoring",
               escaped_safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
735
    tor_assert(resolve->pending_connections == NULL);
736
737
738
739
740
741
    return;
  }
  /* Removed this assertion: in fact, we'll sometimes get a double answer
   * to the same question.  This can happen when we ask one worker to resolve
   * X.Y.Z., then we cancel the request, and then we ask another worker to
   * resolve X.Y.Z. */
Roger Dingledine's avatar
Roger Dingledine committed
742
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
743

744
  while (resolve->pending_connections) {
745
    pend = resolve->pending_connections;
746
747
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
748
    assert_connection_ok(TO_CONN(pendconn),time(NULL));
749
750
    pendconn->_base.addr = addr;
    pendconn->address_ttl = ttl;
751

752
    if (outcome != DNS_RESOLVE_SUCCEEDED) {
753
      /* prevent double-remove. */
754
755
      pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
756
757
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED,
                            pendconn->cpath_layer);
758
        /* This detach must happen after we send the end cell. */
759
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
760
      } else {
761
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
762
        /* This detach must happen after we send the resolved cell. */
763
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
764
      }
765
      connection_free(TO_CONN(pendconn));
Roger Dingledine's avatar
Roger Dingledine committed
766
    } else {
767
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
768
        /* prevent double-remove. */
769
        pend->conn->_base.state = EXIT_CONN_STATE_CONNECTING;
770

771
        circ = circuit_get_by_edge_conn(pend->conn);
772
        tor_assert(circ);
773
        tor_assert(!CIRCUIT_IS_ORIGIN(circ));
774
775
776
        /* unlink pend->conn from resolving_streams, */
        circuit_detach_stream(circ, pend->conn);
        /* and link it to n_streams */
777
        pend->conn->next_stream = TO_OR_CIRCUIT(circ)->n_streams;
778
        pend->conn->on_circuit = circ;
779
        TO_OR_CIRCUIT(circ)->n_streams = pend->conn;
780
781
782
783
784

        connection_exit_connect(pend->conn);
      } else {
        /* prevent double-remove.  This isn't really an accurate state,
         * but it does the right thing. */
785
        pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
786
        send_resolved_cell(pendconn, RESOLVED_TYPE_IPV4);
787
        circ = circuit_get_by_edge_conn(pendconn);
788
789
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
790
        connection_free(TO_CONN(pendconn));
791
      }
Roger Dingledine's avatar
Roger Dingledine committed
792
    }
793
794
    resolve->pending_connections = pend->next;
    tor_free(pend);
795
  }
796

797
798
799
800
801
  resolve->state = CACHE_STATE_DONE;
  removed = HT_REMOVE(cache_map, &cache_root, &search);
  if (removed != resolve) {
    log_err(LD_BUG, "The pending resolve we found wasn't removable from"
            " the cache. Tried to purge %s (%p); instead got %s (%p).",
802
803
            resolve->address, (void*)resolve,
            removed ? removed->address : "NULL", (void*)removed);
804
  }
805
806
  assert_resolve_ok(resolve);
  assert_cache_ok(