dns.c 64.7 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
101
102
103
  union {
    uint32_t addr;  /**< IPv4 addr for <b>address</b>. */
    char *hostname; /**< Hostname for <b>address</b> (if a reverse lookup) */
  } result;
104
  uint8_t state; /**< Is this cached entry pending/done/valid/failed? */
105
  uint8_t is_reverse; /**< Is this a reverse (addr-to-hostname) lookup? */
106
  time_t expire; /**< Remove items from cache after this time. */
107
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
108
  /** Connections that want to know when we get an answer for this resolve. */
109
110
  pending_connection_t *pending_connections;
} cached_resolve_t;
111

112
static void purge_expired_resolves(time_t now);
113
114
static void dns_found_answer(const char *address, int is_reverse,
                             uint32_t addr, const char *hostname, char outcome,
115
                             uint32_t ttl);
116
static void send_resolved_cell(edge_connection_t *conn, or_circuit_t *circ,
Roger Dingledine's avatar
Roger Dingledine committed
117
                               uint8_t answer_type);
118
static int launch_resolve(edge_connection_t *exitconn, or_circuit_t *circ);
119
#ifndef USE_EVENTDNS
120
static void dnsworkers_rotate(void);
121
static void dnsworker_main(void *data);
122
static int spawn_dnsworker(void);
123
static int spawn_enough_dnsworkers(void);
124
#else
125
static void add_wildcarded_test_address(const char *address);
126
static int configure_nameservers(int force);
127
static int answer_is_wildcarded(const char *ip);
128
#endif
129
#ifdef DEBUG_DNS_CACHE
130
static void _assert_cache_ok(void);
131
132
#define assert_cache_ok() _assert_cache_ok()
#else
133
#define assert_cache_ok() do {} while (0)
134
#endif
135
static void assert_resolve_ok(cached_resolve_t *resolve);
136

137
138
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
139

Roger Dingledine's avatar
Roger Dingledine committed
140
/** Function to compare hashed resolves on their addresses; used to
141
 * implement hash tables. */
142
143
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
144
{
145
  /* make this smarter one day? */
146
  assert_resolve_ok(a); // Not b; b may be just a search.
147
148
149
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

150
/** Hash function for cached_resolve objects */
151
152
153
154
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
155
156
}

157
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
158
             cached_resolves_eq);
159
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
160
            cached_resolves_eq, 0.6, malloc, realloc, free);
161

162
/** Initialize the DNS cache. */
163
static void
164
init_cache_map(void)
165
{
166
  HT_INIT(cache_map, &cache_root);
167
168
}

169
#ifdef USE_EVENTDNS
170
/** Helper: called by eventdns when eventdns wants to log something. */
171
static void
172
evdns_log_cb(int warn, const char *msg)
173
{
174
  const char *cp;
175
176
177
178
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
179
180
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
181
  }
182
183
184
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
    const char *err = strchr(cp, ':'+2);
185
186
187
188
    /* 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. */
    warn = 0;
189
    control_event_server_status(LOG_NOTICE,
190
191
192
193
194
195
196
197
198
199
200
                                "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));
    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");
201
  }
202
  log(warn?LOG_WARN:LOG_INFO, LD_EXIT, "eventdns: %s", msg);
203
204
205
}
#endif

Roger Dingledine's avatar
Roger Dingledine committed
206
/** Initialize the DNS subsystem; called by the OR process. */
207
int
208
209
dns_init(void)
{
210
  init_cache_map();
211
#ifdef USE_EVENTDNS
212
  if (server_mode(get_options()))
213
214
215
    return configure_nameservers(1);
#else
  dnsworkers_rotate();
216
#endif
217
  return 0;
218
}
219

220
/** Called when DNS-related options change (or may have changed) */
221
222
223
224
225
226
void
dns_reset(void)
{
#ifdef USE_EVENTDNS
  or_options_t *options = get_options();
  if (! server_mode(options)) {
227
228
    evdns_clear_nameservers_and_suspend();
    evdns_search_clear();
229
230
231
232
233
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
    if (configure_nameservers(0) < 0)
234
      /* XXXX012 */
235
236
237
238
239
240
241
      return;
  }
#else
  dnsworkers_rotate();
#endif
}

242
243
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
244
245
246
247
248
249
250
251
252
253
254
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;
}

255
256
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
257
258
259
260
261
262
263
264
265
266
267
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;
}

268
/** Helper: free storage held by an entry in the DNS cache. */
269
static void
270
_free_cached_resolve(cached_resolve_t *r)
271
{
Nick Mathewson's avatar
Nick Mathewson committed
272
  while (r->pending_connections) {
273
    pending_connection_t *victim = r->pending_connections;
274
275
276
    r->pending_connections = victim->next;
    tor_free(victim);
  }
277
278
  if (r->is_reverse)
    tor_free(r->result.hostname);
279
  r->magic = 0xFF00FF00;
280
281
282
  tor_free(r);
}

283
284
285
/** 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. */
286
static int
287
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
288
{
289
  const cached_resolve_t *a = _a, *b = _b;
290
  return a->expire - b->expire;
291
292
}

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

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

311
/** Free all storage held in the DNS cache and related structures. */
312
313
314
void
dns_free_all(void)
{
315
  cached_resolve_t **ptr, **next, *item;
316
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
317
    item = *ptr;
318
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
319
    _free_cached_resolve(item);
320
  }
321
  HT_CLEAR(cache_map, &cache_root);
322
323
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
324
  cached_resolve_pqueue = NULL;
325
326
327
#ifdef USE_EVENTDNS
  tor_free(resolv_conf_fname);
#endif
328
329
}

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

Nick Mathewson's avatar
Nick Mathewson committed
339
  assert_cache_ok();
340
341
342
343
344
345
346
347
348
349
  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);

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
407
  assert_cache_ok();
408
409
}

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

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

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
433
      set_uint32(buf+2, htonl(conn->_base.addr));
434
      set_uint32(buf+6, htonl(ttl));
435
      buflen = 10;
436
437
438
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
439
440
441
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
442

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

455
456
457
458
459
460
461
  if (!circ) {
    circuit_t *tmp = circuit_get_by_edge_conn(conn);
    if (! CIRCUIT_IS_ORIGIN(tmp))
      circ = TO_OR_CIRCUIT(tmp);
  }

  connection_edge_send_command(conn, TO_CIRCUIT(circ),
462
463
464
465
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

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

  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;

492
493
494
495
496
497
  if (!circ) {
    circuit_t *tmp = circuit_get_by_edge_conn(conn);
    if (! CIRCUIT_IS_ORIGIN(tmp))
      circ = TO_OR_CIRCUIT(tmp);
  }

498
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
499
  connection_edge_send_command(conn, TO_CIRCUIT(circ),
500
501
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
502
  // log_notice(LD_EXIT, "Sent");
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
}

/** Given a lower-case <b>address</b>, check to see whether it's a
 * 1.2.3.4.in-addr.arpa address used for reverse lookups.  If so,
 * parse it and place the address in <b>in</b> if present. Return 1 on success;
 * 0 if the address is not in in-addr.arpa format, and -1 if the address is
 * malformed. */
static int
parse_inaddr_arpa_address(const char *address, struct in_addr *in)
{
  char buf[INET_NTOA_BUF_LEN];
  char *cp;
  size_t len;
  struct in_addr inaddr;

  cp = strstr(address, ".in-addr.arpa");
  if (!cp || *(cp+strlen(".in-addr.arpa")))
    return 0; /* not an .in-addr.arpa address  */

  len = cp - address;

  if (len >= INET_NTOA_BUF_LEN)
    return -1; /* Too long. */

527
  memcpy(buf, address, len);
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
  buf[len] = '\0';
  if (tor_inet_aton(buf, &inaddr) == 0)
    return -1; /* malformed. */

  if (in) {
    uint32_t a;
    /* reverse the bytes */
    a = (  ((inaddr.s_addr & 0x000000fful) << 24)
          |((inaddr.s_addr & 0x0000ff00ul) << 8)
          |((inaddr.s_addr & 0x00ff0000ul) >> 8)
          |((inaddr.s_addr & 0xff000000ul) >> 24));
    inaddr.s_addr = a;

    memcpy(in, &inaddr, sizeof(inaddr));
  }

  return 1;
}

Nick Mathewson's avatar
Nick Mathewson committed
547
548
/** 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.
549
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
550
 *
551
552
 * If <b>oncirc</b> is provided, and this is a resolve request, we have
 * a cached answer, send the answer back along oncirc; otherwise, send
553
554
 * the answer back along <b>exitconn</b>'s attached circuit.
 *
555
556
557
558
559
560
 * 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.
 */
561
int
562
dns_resolve(edge_connection_t *exitconn, or_circuit_t *oncirc)
563
{
564
565
566
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
567
  circuit_t *circ;
568
  struct in_addr in;
569
  time_t now = time(NULL);
570
  int is_reverse = 0, is_resolve, r;
571
572
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
573

574
575
  assert_cache_ok();

576
  is_resolve = exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE;
577

578
  /* first check if exitconn->_base.address is an IP. If so, we already
579
   * know the answer. */
580
581
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
582
    exitconn->address_ttl = DEFAULT_DNS_TTL;
583
    if (is_resolve)
584
      send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_IPV4);
585
    return 1;
586
587
588
  }

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

592
593
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
594

595
596
  /* 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
597
   * connection.
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
   */
  if ((r = parse_inaddr_arpa_address(exitconn->_base.address, NULL)) != 0) {
    if (r == 1)
      is_reverse = 1;

#ifdef USE_EVENTDNS
    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));
#else
    if (1) {
      log_info(LD_PROTOCOL, "Dnsworker code does not support in-addr.arpa "
               "domain, but received a request for \"%s\"; sending error.",
               escaped_safe_str(exitconn->_base.address));
#endif

      if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
621
        send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_ERROR);
622
623
624
625
626
627
628
      circ = circuit_get_by_edge_conn(exitconn);
      if (circ)
        circuit_detach_stream(circ, exitconn);
      if (!exitconn->_base.marked_for_close)
        connection_free(TO_CONN(exitconn));
      return -1;
    }
629
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
630
    //exitconn->_base.address);
631
632
  }

633
  /* now check the hash table to see if 'address' is already there. */
634
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
635
  resolve = HT_FIND(cache_map, &cache_root, &search);
636
  if (resolve && resolve->expire > now) { /* already there */
637
    switch (resolve->state) {
638
639
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
640
        pending_connection = tor_malloc_zero(
641
                                      sizeof(pending_connection_t));
642
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
643
644
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
645
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
646
647
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
648
        exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
649
        return 0;
650
      case CACHE_STATE_CACHED_VALID:
651
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
652
                  exitconn->_base.s,
653
654
655
656
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
657
          send_resolved_hostname_cell(exitconn, oncirc,
Roger Dingledine's avatar
Roger Dingledine committed
658
                                      resolve->result.hostname);
659
660
661
        } else {
          exitconn->_base.addr = resolve->result.addr;
          if (is_resolve)
662
            send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_IPV4);
663
        }
664
        return 1;
665
      case CACHE_STATE_CACHED_FAILED:
666
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
667
668
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
669
        /*  XXXX012 send back indication of failure for connect case? -NM*/
670
        if (is_resolve)
671
          send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_ERROR);
672
        circ = circuit_get_by_edge_conn(exitconn);
673
674
        if (circ)
          circuit_detach_stream(circ, exitconn);
675
676
        if (!exitconn->_base.marked_for_close)
          connection_free(TO_CONN(exitconn));
677
        return -1;
678
679
680
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
681
    }
Roger Dingledine's avatar
Roger Dingledine committed
682
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
683
684
  }
  /* not there, need to add it */
685
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
686
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
687
  resolve->state = CACHE_STATE_PENDING;
688
  resolve->is_reverse = is_reverse;
689
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
690

691
  /* add this connection to the pending list */
692
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
693
694
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
695
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
696

697
  /* Add this resolve to the cache and priority queue. */
698
  HT_INSERT(cache_map, &cache_root, resolve);
699
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
700

701
  log_debug(LD_EXIT,"Launching %s.",
702
            escaped_safe_str(exitconn->_base.address));
703
  assert_cache_ok();
704
  return launch_resolve(exitconn, oncirc);
705
706
}

707
/** Log an error and abort if conn is waiting for a DNS resolve.
708
 */
709
void
710
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
711
{
712
713
  pending_connection_t *pend;
  cached_resolve_t **resolve;
714

715
716
717
718
719
720
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
721
  }
722
}
723

724
725
726
727
728
729
730
/** 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;
731

732
733
734
735
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
736
737
738
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
739
    }
740
741
742
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
743
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
744
 */
745
void
746
connection_dns_remove(edge_connection_t *conn)
747
{
748
749
750
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
751

752
753
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
754

755
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
756

757
  resolve = HT_FIND(cache_map, &cache_root, &search);
758
  if (!resolve) {
759
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
760
               escaped_safe_str(conn->_base.address));
761
762
763
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
764
  tor_assert(resolve->pending_connections);
765
  assert_connection_ok(TO_CONN(conn),0);
766
767
768

  pend = resolve->pending_connections;

769
  if (pend->conn == conn) {
770
    resolve->pending_connections = pend->next;
771
    tor_free(pend);
772
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
773
              "for resolve of %s",
774
              conn->_base.s, escaped_safe_str(conn->_base.address));
775
776
    return;
  } else {
777
778
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
779
780
        victim = pend->next;
        pend->next = victim->next;
781
        tor_free(victim);
782
        log_debug(LD_EXIT,
783
                  "Connection (fd %d) no longer waiting for resolve of %s",
784
                  conn->_base.s, escaped_safe_str(conn->_base.address));
785
786
787
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
788
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
789
790
791
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
792
793
794
/** 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.
795
 */
796
void
797
dns_cancel_pending_resolve(const char *address)
798
{
799
800
  pending_connection_t *pend;
  cached_resolve_t search;
801
  cached_resolve_t *resolve, *tmp;
802
  edge_connection_t *pendconn;
803
  circuit_t *circ;
804

Nick Mathewson's avatar
Nick Mathewson committed
805
  strlcpy(search.address, address, sizeof(search.address));
806

807
  resolve = HT_FIND(cache_map, &cache_root, &search);
808
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
809
810
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
811
812
813
    return;
  }

814
815
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
816
    log_warn(LD_BUG,
817
818
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
819
    tor_fragile_assert();
820
821
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
822
  tor_assert(resolve->pending_connections);
823

824
  /* mark all pending connections to fail */
825
  log_debug(LD_EXIT,
826
827
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
828
  while (resolve->pending_connections) {
829
    pend = resolve->pending_connections;
830
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
831
    pendconn = pend->conn;
832
833
834
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
835
836
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
837
    }
838
    circ = circuit_get_by_edge_conn(pendconn);
839
840
    if (circ)
      circuit_detach_stream(circ, pendconn);
841
    connection_free(TO_CONN(pendconn));
842
843
    resolve->pending_connections = pend->next;
    tor_free(pend);
844
845
  }

Nick Mathewson's avatar
Nick Mathewson committed
846
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
847
848
849
  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).",
850
851
            resolve->address, (void*)resolve,
            tmp ? tmp->address : "NULL", (void*)tmp);
852
  }
Nick Mathewson's avatar
Nick Mathewson committed
853
  tor_assert(tmp == resolve);
854
855

  resolve->state = CACHE_STATE_DONE;
856
857
}

858
/** Helper: adds an entry to the DNS cache mapping <b>address</b> to the ipv4
859
860
 * address <b>addr</b> (if is_reverse is 0) or the hostname <b>hostname</b> (if
 * is_reverse is 1).  <b>ttl</b> is a cache ttl; <b>outcome</b> is one of
861
862
 * DNS_RESOLVE_{FAILED_TRANSIENT|FAILED_PERMANENT|SUCCEEDED}.
 **/
863
static void
864
865
add_answer_to_cache(const char *address, int is_reverse, uint32_t addr,
                    const char *hostname, char outcome, uint32_t ttl)
866
867
868
869
870
{
  cached_resolve_t *resolve;
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT)
    return;

871
  /* XXXX012 This is dumb, but it seems to workaround a bug I can't find.  We