dns.c 67.2 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
/* Copyright 2003-2004 Roger Dingledine.
2
 * Copyright 2004-2007 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
/** Value of 'magic' field for cached_resolve_t.  Used to try to catch bad
 * pointers and memory stomping. */
73
74
#define CACHED_RESOLVE_MAGIC 0x1234F00D

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

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

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

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

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

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

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

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

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

Roger Dingledine's avatar
Roger Dingledine committed
213
/** Initialize the DNS subsystem; called by the OR process. */
214
int
215
216
dns_init(void)
{
217
  init_cache_map();
218
#ifdef USE_EVENTDNS
219
  if (server_mode(get_options()))
220
221
222
    return configure_nameservers(1);
#else
  dnsworkers_rotate();
223
#endif
224
  return 0;
225
}
226

227
228
229
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
230
231
232
233
234
dns_reset(void)
{
#ifdef USE_EVENTDNS
  or_options_t *options = get_options();
  if (! server_mode(options)) {
235
236
    evdns_clear_nameservers_and_suspend();
    evdns_search_clear();
237
238
239
240
241
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
    if (configure_nameservers(0) < 0)
242
      return -1;
243
244
245
246
  }
#else
  dnsworkers_rotate();
#endif
247
  return 0;
248
249
}

250
251
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
252
253
254
255
256
257
258
259
260
261
262
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;
}

263
264
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
265
266
267
268
269
270
271
272
273
274
275
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;
}

276
/** Helper: free storage held by an entry in the DNS cache. */
277
static void
278
_free_cached_resolve(cached_resolve_t *r)
279
{
Nick Mathewson's avatar
Nick Mathewson committed
280
  while (r->pending_connections) {
281
    pending_connection_t *victim = r->pending_connections;
282
283
284
    r->pending_connections = victim->next;
    tor_free(victim);
  }
285
286
  if (r->is_reverse)
    tor_free(r->result.hostname);
287
  r->magic = 0xFF00FF00;
288
289
290
  tor_free(r);
}

291
292
293
/** 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. */
294
static int
295
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
296
{
297
  const cached_resolve_t *a = _a, *b = _b;
298
  return a->expire - b->expire;
299
300
}

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

305
306
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
307
308
309
310
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
311
312
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
313
314
315
316
317
318
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

319
/** Free all storage held in the DNS cache and related structures. */
320
321
322
void
dns_free_all(void)
{
323
  cached_resolve_t **ptr, **next, *item;
324
  assert_cache_ok();
325
326
327
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
328
        if (res->state == CACHE_STATE_DONE)
329
330
331
          _free_cached_resolve(res);
      });
  }
332
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
333
    item = *ptr;
334
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
335
    _free_cached_resolve(item);
336
  }
337
  HT_CLEAR(cache_map, &cache_root);
338
339
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
340
  cached_resolve_pqueue = NULL;
341
342
343
#ifdef USE_EVENTDNS
  tor_free(resolv_conf_fname);
#endif
344
345
}

Nick Mathewson's avatar
Nick Mathewson committed
346
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
347
 * from the cache. */
348
static void
349
purge_expired_resolves(time_t now)
350
{
Nick Mathewson's avatar
Nick Mathewson committed
351
  cached_resolve_t *resolve, *removed;
352
  pending_connection_t *pend;
353
  edge_connection_t *pendconn;
354

Nick Mathewson's avatar
Nick Mathewson committed
355
  assert_cache_ok();
356
357
358
359
360
361
362
363
364
365
  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);

366
    if (resolve->state == CACHE_STATE_PENDING) {
367
      log_debug(LD_EXIT,
368
369
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
370
371
372
373
374
375
376
377
378
379
380
                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);
381
    }
382

383
    if (resolve->pending_connections) {
384
      log_debug(LD_EXIT,
385
                "Closing pending connections on timed-out DNS resolve!");
386
      tor_fragile_assert();
387
388
389
390
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
391
        tor_assert(pend->conn->_base.s == -1);
392
        pendconn = pend->conn;
393
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
394
                            pendconn->cpath_layer);
395
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
396
        connection_free(TO_CONN(pendconn));
397
398
        tor_free(pend);
      }
399
    }
400

401
402
403
404
405
406
407
    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).",
408
409
                resolve->address, (void*)resolve,
                removed ? removed->address : "NULL", (void*)remove);
410
411
      }
      tor_assert(removed == resolve);
412
413
      if (resolve->is_reverse)
        tor_free(resolve->result.hostname);
414
415
416
      resolve->magic = 0xF0BBF0BB;
      tor_free(resolve);
    } else {
417
      /* This should be in state DONE. Make sure it's not in the cache. */
418
419
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
420
    }
421
  }
422

Nick Mathewson's avatar
Nick Mathewson committed
423
  assert_cache_ok();
424
425
}

426
427
428
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
429
430
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
431
432
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
433
 */
434
static void
435
send_resolved_cell(edge_connection_t *conn, or_circuit_t *circ,
Roger Dingledine's avatar
Roger Dingledine committed
436
                   uint8_t answer_type)
437
438
{
  char buf[RELAY_PAYLOAD_SIZE];
439
  size_t buflen;
440
  uint32_t ttl;
441
442

  buf[0] = answer_type;
443
  ttl = dns_clip_ttl(conn->address_ttl);
444
445
446
447
448

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
449
      set_uint32(buf+2, htonl(conn->_base.addr));
450
      set_uint32(buf+6, htonl(ttl));
451
      buflen = 10;
452
453
454
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
455
456
457
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
458

459
460
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
461
        set_uint32(buf+2+msglen, htonl(ttl));
462
463
464
        buflen = 6+msglen;
        break;
      }
465
466
    default:
      tor_assert(0);
467
      return;
468
    }
469
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
470

471
472
473
474
475
476
477
  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),
478
479
480
481
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

482
483
484
/** 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.
485
486
487
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
488
 * <b>conn</b>'s attached circuit.
489
490
 */
static void
491
send_resolved_hostname_cell(edge_connection_t *conn, or_circuit_t *circ,
Roger Dingledine's avatar
Roger Dingledine committed
492
                            const char *hostname)
493
494
495
496
497
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
498
  tor_assert(hostname);
499
500
501
502
503
504
505
506
507
508

  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;

509
510
511
512
513
514
  if (!circ) {
    circuit_t *tmp = circuit_get_by_edge_conn(conn);
    if (! CIRCUIT_IS_ORIGIN(tmp))
      circ = TO_OR_CIRCUIT(tmp);
  }

515
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
516
  connection_edge_send_command(conn, TO_CIRCUIT(circ),
517
518
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
519
  // log_notice(LD_EXIT, "Sent");
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
}

/** 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. */

544
  memcpy(buf, address, len);
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
  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
564
565
/** 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.
566
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
567
 *
568
569
570
571
572
 * (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.)
 *
573
574
 * 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
575
576
 * the answer back along <b>exitconn</b>'s attached circuit.
 *
577
578
579
580
581
582
 * 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.
 */
583
int
584
dns_resolve(edge_connection_t *exitconn, or_circuit_t *oncirc)
585
{
586
587
588
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
589
  circuit_t *circ;
590
  struct in_addr in;
591
  time_t now = time(NULL);
592
  int is_reverse = 0, is_resolve, r;
593
594
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
595

596
597
  assert_cache_ok();

598
  is_resolve = exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE;
599

600
  /* first check if exitconn->_base.address is an IP. If so, we already
601
   * know the answer. */
602
603
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
604
    exitconn->address_ttl = DEFAULT_DNS_TTL;
605
    if (is_resolve)
606
      send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_IPV4);
607
    return 1;
608
  }
609
610
611
612
613
614
615
616
617
618
619
620
621
  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));
    if (is_resolve)
      send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_ERROR);
    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;
  }
622
623

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

627
628
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
629

630
631
  /* 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
632
   * connection.
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
   */
  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)
656
        send_resolved_cell(exitconn, oncirc, RESOLVED_TYPE_ERROR);
657
658
659
660
661
662
663
      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;
    }
664
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
665
    //exitconn->_base.address);
666
667
  }

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

725
  /* add this connection to the pending list */
726
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
727
728
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
729
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
730

731
  /* Add this resolve to the cache and priority queue. */
732
  HT_INSERT(cache_map, &cache_root, resolve);
733
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
734

735
  log_debug(LD_EXIT,"Launching %s.",
736
            escaped_safe_str(exitconn->_base.address));
737
  assert_cache_ok();
738
  return launch_resolve(exitconn, oncirc);
739
740
}

741
/** Log an error and abort if conn is waiting for a DNS resolve.
742
 */
743
void
744
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
745
{
746
747
  pending_connection_t *pend;
  cached_resolve_t **resolve;
748

749
750
751
752
753
754
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
755
  }
756
}
757

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

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

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

786
787
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
788

789
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
790

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

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

  pend = resolve->pending_connections;

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

Nick Mathewson's avatar
Nick Mathewson committed
826
827
828
/** 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.
829
 */
830
void
831
dns_cancel_pending_resolve(const char *address)
832
{
833
834
  pending_connection_t *pend;
  cached_resolve_t search;
835
  cached_resolve_t *resolve, *tmp;
836
  edge_connection_t *pendconn;
837
  circuit_t *circ;
838

Nick Mathewson's avatar
Nick Mathewson committed
839
  strlcpy(search.address, address, sizeof(search.address));
840

841
  resolve = HT_FIND(cache_map, &cache_root, &search);
842
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
843
844
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
845
846
847
    return;
  }

848
849
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
850
    log_warn(LD_BUG,
851
852
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
853
    tor_fragile_assert();
854
855
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
856
  tor_assert(resolve->pending_connections);
857

858
  /* mark all pending connections to fail */
859
  log_debug(LD_EXIT,
860
861
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
862
  while (resolve->pending_connections) {
863
    pend = resolve->pending_connections;
864
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
865
    pendconn = pend->conn;
866
867
868
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
869
870
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
871
    }
872
    circ = circuit_get_by_edge_conn(pendconn);
873
874
    if (circ)
      circuit_detach_stream(circ