dns.c 67.4 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
/** DOCDOC */
72
73
#define CACHED_RESOLVE_MAGIC 0x1234F00D

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

318
/** Free all storage held in the DNS cache and related structures. */
319
320
321
void
dns_free_all(void)
{
322
  cached_resolve_t **ptr, **next, *item;
323
324
325
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
Roger Dingledine's avatar
Roger Dingledine committed
326
        /* XXXX012 The hash lookups here could be quite slow; remove them
327
328
         * once we're happy. (Leave them in for at least 0.1.2.7-alpha, so they
         * get some testing.) -NM */
329
        if (res->state == CACHE_STATE_DONE) {
330
331
          cached_resolve_t *found = HT_FIND(cache_map, &cache_root, res);
          tor_assert(!found || found != res);
332
333
334
335
336
337
338
          _free_cached_resolve(res);
        } else {
          cached_resolve_t *found = HT_FIND(cache_map, &cache_root, res);
          tor_assert(found);
        }
      });
  }
339
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
340
    item = *ptr;
341
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
342
    _free_cached_resolve(item);
343
  }
344
  HT_CLEAR(cache_map, &cache_root);
345
346
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
347
  cached_resolve_pqueue = NULL;
348
349
350
#ifdef USE_EVENTDNS
  tor_free(resolv_conf_fname);
#endif
351
352
}

Nick Mathewson's avatar
Nick Mathewson committed
353
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
354
 * from the cache. */
355
static void
356
purge_expired_resolves(time_t now)
357
{
Nick Mathewson's avatar
Nick Mathewson committed
358
  cached_resolve_t *resolve, *removed;
359
  pending_connection_t *pend;
360
  edge_connection_t *pendconn;
361

Nick Mathewson's avatar
Nick Mathewson committed
362
  assert_cache_ok();
363
364
365
366
367
368
369
370
371
372
  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);

373
    if (resolve->state == CACHE_STATE_PENDING) {
374
      log_debug(LD_EXIT,
375
376
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
377
378
379
380
381
382
383
384
385
386
387
                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);
388
    }
389

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

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

Nick Mathewson's avatar
Nick Mathewson committed
430
  assert_cache_ok();
431
432
}

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

  buf[0] = answer_type;
450
  ttl = dns_clip_ttl(conn->address_ttl);
451
452
453
454
455

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
456
      set_uint32(buf+2, htonl(conn->_base.addr));
457
      set_uint32(buf+6, htonl(ttl));
458
      buflen = 10;
459
460
461
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
462
463
464
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
465

466
467
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
468
        set_uint32(buf+2+msglen, htonl(ttl));
469
470
471
        buflen = 6+msglen;
        break;
      }
472
473
    default:
      tor_assert(0);
474
      return;
475
    }
476
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
477

478
479
480
481
482
483
484
  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),
485
486
487
488
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

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

  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;

516
517
518
519
520
521
  if (!circ) {
    circuit_t *tmp = circuit_get_by_edge_conn(conn);
    if (! CIRCUIT_IS_ORIGIN(tmp))
      circ = TO_OR_CIRCUIT(tmp);
  }

522
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
523
  connection_edge_send_command(conn, TO_CIRCUIT(circ),
524
525
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
526
  // log_notice(LD_EXIT, "Sent");
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
}

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

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

598
599
  assert_cache_ok();

600
  is_resolve = exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE;
601

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

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

630
631
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
632

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

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

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

735
  /* Add this resolve to the cache and priority queue. */
736
  HT_INSERT(cache_map, &cache_root, resolve);
737
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
738

739
  log_debug(LD_EXIT,"Launching %s.",
740
            escaped_safe_str(exitconn->_base.address));
741
  assert_cache_ok();
742
  return launch_resolve(exitconn, oncirc);
743
744
}

745
/** Log an error and abort if conn is waiting for a DNS resolve.
746
 */
747
void
748
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
749
{
750
751
  pending_connection_t *pend;
  cached_resolve_t **resolve;
752

753
754
755
756
757
758
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
759
  }
760
}
761

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

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

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

790
791
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
792

793
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
794

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

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

  pend = resolve->pending_connections;

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

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

Nick Mathewson's avatar
Nick Mathewson committed
843
  strlcpy(search.address, address, sizeof(search.address));
844

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

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

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