dns.c 53.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
 * This is implemetned as a wrapper around Adam Langley's eventdns.c code.
12
13
 * (We can't just use gethostbyname() and friends because we really need to
 * be nonblocking.)
Roger Dingledine's avatar
Roger Dingledine committed
14
 **/
15

16
#include "or.h"
17
#include "../common/ht.h"
18
#include "eventdns.h"
19

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

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

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

33
34
35
36
37
38
39
40
/** 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;
41

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

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

52
53
54
55
56
57
58
/* Possible states for a cached resolve_t */
/** We are waiting for the resolver system to tell us an answer here.
 * When we get one, or when we time out, the state of this cached_resolve_t
 * will become "DONE" and we'll possibly add a CACHED_VALID or a CACHED_FAILED
 * entry. This cached_resolve_t will be in the hash table so that we will
 * know not to launch more requests for this addr, but rather to add more
 * connections to the pending list for the addr. */
59
#define CACHE_STATE_PENDING 0
60
61
62
/** This used to be a pending cached_resolve_t, and we got an answer for it.
 * Now we're waiting for this cached_resolve_t to expire.  This should
 * have no pending connections, and should not appear in the hash table. */
63
#define CACHE_STATE_DONE 1
64
65
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
66
#define CACHE_STATE_CACHED_VALID 2
67
68
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
69
70
#define CACHE_STATE_CACHED_FAILED 3

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

91
static void purge_expired_resolves(time_t now);
92
93
static void dns_found_answer(const char *address, int is_reverse,
                             uint32_t addr, const char *hostname, char outcome,
94
                             uint32_t ttl);
95
96
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
97
static void add_wildcarded_test_address(const char *address);
98
static int configure_nameservers(int force);
99
static int answer_is_wildcarded(const char *ip);
100
#ifdef DEBUG_DNS_CACHE
101
static void _assert_cache_ok(void);
102
103
#define assert_cache_ok() _assert_cache_ok()
#else
104
#define assert_cache_ok() do {} while (0)
105
#endif
106
static void assert_resolve_ok(cached_resolve_t *resolve);
107

108
109
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
110

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

121
/** Hash function for cached_resolve objects */
122
123
124
125
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
126
127
}

128
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
129
             cached_resolves_eq);
130
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
131
            cached_resolves_eq, 0.6, malloc, realloc, free);
132

133
/** Initialize the DNS cache. */
134
static void
135
init_cache_map(void)
136
{
137
  HT_INIT(cache_map, &cache_root);
138
139
}

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

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

190
191
192
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
193
194
195
196
dns_reset(void)
{
  or_options_t *options = get_options();
  if (! server_mode(options)) {
197
198
    evdns_clear_nameservers_and_suspend();
    evdns_search_clear();
199
200
201
202
203
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
    if (configure_nameservers(0) < 0)
204
      return -1;
205
  }
206
  return 0;
207
208
}

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

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

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

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

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

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

278
/** Free all storage held in the DNS cache and related structures. */
279
280
281
void
dns_free_all(void)
{
282
  cached_resolve_t **ptr, **next, *item;
283
  assert_cache_ok();
284
285
286
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
287
        if (res->state == CACHE_STATE_DONE)
288
289
290
          _free_cached_resolve(res);
      });
  }
291
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
292
    item = *ptr;
293
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
294
    _free_cached_resolve(item);
295
  }
296
  HT_CLEAR(cache_map, &cache_root);
297
298
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
299
  cached_resolve_pqueue = NULL;
300
  tor_free(resolv_conf_fname);
301
302
}

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

Nick Mathewson's avatar
Nick Mathewson committed
312
  assert_cache_ok();
313
314
315
316
317
318
319
320
321
322
  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);

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
379
  assert_cache_ok();
380
381
}

382
383
384
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
385
386
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
387
388
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
389
 */
390
static void
391
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
392
393
{
  char buf[RELAY_PAYLOAD_SIZE];
394
  size_t buflen;
395
  uint32_t ttl;
396
397

  buf[0] = answer_type;
398
  ttl = dns_clip_ttl(conn->address_ttl);
399
400
401
402
403

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
404
      set_uint32(buf+2, htonl(conn->_base.addr));
405
      set_uint32(buf+6, htonl(ttl));
406
      buflen = 10;
407
408
409
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
410
411
412
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
413

414
415
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
416
        set_uint32(buf+2+msglen, htonl(ttl));
417
418
419
        buflen = 6+msglen;
        break;
      }
420
421
    default:
      tor_assert(0);
422
      return;
423
    }
424
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
425

426
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
427
428
}

429
430
431
/** 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.
432
433
434
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
435
 * <b>conn</b>'s attached circuit.
436
437
 */
static void
438
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
439
440
441
442
443
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
444
  tor_assert(hostname);
445
446
447
448
449
450
451
452
453
454

  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;

455
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
456
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
457
  // log_notice(LD_EXIT, "Sent");
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
}

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

482
  memcpy(buf, address, len);
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  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
502
503
/** 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.
504
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
505
 *
506
507
508
509
510
 * (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.)
 *
511
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
512
 * circuit.
513
 *
514
515
516
517
518
 * 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.
519
520
521
522
523
524
 *
 * Exitconn's on_circuit field must be set, but exitconn should not
 * yet be linked onto the n_streams/resolving_streams list of that circuit.
 * On success, link the connection to n_streams if it's an exit connection.
 * On "pending", link the connection to resolving streams.  Otherwise,
 * clear its on_circuit field.
525
 */
526
527
/* XXXX020 Split this into a helper that checks whether there is an answer,
 * and a caller that takes appropriate action based on what happened. */
528
int
529
dns_resolve(edge_connection_t *exitconn)
530
{
531
532
533
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
534
  struct in_addr in;
535
  time_t now = time(NULL);
536
  int is_reverse = 0, is_resolve, r;
537
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
538
539
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
540
  assert_cache_ok();
541
  tor_assert(oncirc);
542

543
  is_resolve = exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE;
544

545
  /* first check if exitconn->_base.address is an IP. If so, we already
546
   * know the answer. */
547
548
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
549
    exitconn->address_ttl = DEFAULT_DNS_TTL;
550
    if (is_resolve) {
551
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
552
553
554
555
    } else {
      exitconn->next_stream = oncirc->n_streams;
      oncirc->n_streams = exitconn;
    }
556
    return 1;
557
  }
558
559
560
561
562
  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)
563
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
564
565
    //circuit_detach_stream(TO_CIRCUIT(oncirc), exitconn);
    exitconn->on_circuit = NULL;
566
567
568
569
    if (!exitconn->_base.marked_for_close)
      connection_free(TO_CONN(exitconn));
    return -1;
  }
570
571

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

575
576
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
577

578
579
  /* 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
580
   * connection.
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
   */
  if ((r = parse_inaddr_arpa_address(exitconn->_base.address, NULL)) != 0) {
    if (r == 1)
      is_reverse = 1;

    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));

      if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
597
        send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
598
599
      //circuit_detach_stream(TO_CIRCUIT(oncirc), exitconn);
      exitconn->on_circuit = NULL;
600
601
602
603
      if (!exitconn->_base.marked_for_close)
        connection_free(TO_CONN(exitconn));
      return -1;
    }
604
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
605
    //exitconn->_base.address);
606
607
  }

608
  /* now check the hash table to see if 'address' is already there. */
609
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
610
  resolve = HT_FIND(cache_map, &cache_root, &search);
611
  if (resolve && resolve->expire > now) { /* already there */
612
    switch (resolve->state) {
613
614
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
615
        pending_connection = tor_malloc_zero(
616
                                      sizeof(pending_connection_t));
617
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
618
619
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
620
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
621
622
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
623
        exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
624
625
626

        exitconn->next_stream = oncirc->resolving_streams;
        oncirc->resolving_streams = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
627
        return 0;
628
      case CACHE_STATE_CACHED_VALID:
629
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
630
                  exitconn->_base.s,
631
632
633
634
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
635
          send_resolved_hostname_cell(exitconn,
Roger Dingledine's avatar
Roger Dingledine committed
636
                                      resolve->result.hostname);
637
638
639
        } else {
          exitconn->_base.addr = resolve->result.addr;
          if (is_resolve)
640
            send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
641
        }
642
643
644
645
646
647
        if (!is_resolve) {
          /* It's a connect; add it into the linked list of n_streams on this
             circuit */
          exitconn->next_stream = oncirc->n_streams;
          oncirc->n_streams = exitconn;
        }
648
        return 1;
649
      case CACHE_STATE_CACHED_FAILED:
650
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
651
652
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
653
        if (is_resolve)
654
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
655
656
        // circuit_detach_stream(TO_CIRCUIT(oncirc), exitconn);
        exitconn->on_circuit = NULL;
657
658
        if (!exitconn->_base.marked_for_close)
          connection_free(TO_CONN(exitconn));
659
        return -1;
660
661
662
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
663
    }
Roger Dingledine's avatar
Roger Dingledine committed
664
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
665
666
  }
  /* not there, need to add it */
667
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
668
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
669
  resolve->state = CACHE_STATE_PENDING;
670
  resolve->is_reverse = is_reverse;
671
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
672

673
  /* add this connection to the pending list */
674
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
675
676
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
677
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
678

679
  /* Add this resolve to the cache and priority queue. */
680
  HT_INSERT(cache_map, &cache_root, resolve);
681
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
682

683
  log_debug(LD_EXIT,"Launching %s.",
684
            escaped_safe_str(exitconn->_base.address));
685
  assert_cache_ok();
686
687
688
689
690
691
692
693
694
695
696
697

  r = launch_resolve(exitconn);
  if (r == 0) {
    exitconn->next_stream = oncirc->resolving_streams;
    oncirc->resolving_streams = exitconn;
  } else {
    tor_assert(r<0);
    exitconn->on_circuit = NULL;
    if (!exitconn->_base.marked_for_close)
      connection_free(TO_CONN(exitconn));
  }
  return r;
698
699
}

700
/** Log an error and abort if conn is waiting for a DNS resolve.
701
 */
702
void
703
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
704
{
705
706
  pending_connection_t *pend;
  cached_resolve_t **resolve;
707

708
709
710
711
712
713
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
714
  }
715
}
716

717
718
719
720
721
722
723
/** 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;
724

725
726
727
728
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
729
730
731
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
732
    }
733
734
735
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
736
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
737
 */
738
void
739
connection_dns_remove(edge_connection_t *conn)
740
{
741
742
743
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
744

745
746
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
747

748
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
749

750
  resolve = HT_FIND(cache_map, &cache_root, &search);
751
  if (!resolve) {
752
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
753
               escaped_safe_str(conn->_base.address));
754
755
756
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
757
  tor_assert(resolve->pending_connections);
758
  assert_connection_ok(TO_CONN(conn),0);
759
760
761

  pend = resolve->pending_connections;

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

Nick Mathewson's avatar
Nick Mathewson committed
785
786
787
/** 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.
788
 */
789
void
790
dns_cancel_pending_resolve(const char *address)
791
{
792
793
  pending_connection_t *pend;
  cached_resolve_t search;
794
  cached_resolve_t *resolve, *tmp;
795
  edge_connection_t *pendconn;
796
  circuit_t *circ;
797

Nick Mathewson's avatar
Nick Mathewson committed
798
  strlcpy(search.address, address, sizeof(search.address));
799

800
  resolve = HT_FIND(cache_map, &cache_root, &search);
801
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
802
803
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
804
805
806
    return;
  }

807
808
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
809
    log_warn(LD_BUG,
810
             "Address %s is pending but has no pending connections!",
811
             escaped_safe_str(address));
812
    tor_fragile_assert();
813
814
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
815
  tor_assert(resolve->pending_connections);
816

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

Nick Mathewson's avatar
Nick Mathewson committed
839
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
840
841
842
  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).",
843
844
            resolve->address, (void*)resolve,
            tmp ? tmp->address : "NULL", (void*)tmp);
845
  }
Nick Mathewson's avatar
Nick Mathewson committed
846
  tor_assert(tmp == resolve);
847
848

  resolve->state = CACHE_STATE_DONE;
849
850
}

851
/** Helper: adds an entry to the DNS cache mapping <b>address</b> to the ipv4
852
853
 * 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
854
855
 * DNS_RESOLVE_{FAILED_TRANSIENT|FAILED_PERMANENT|SUCCEEDED}.
 **/
856
static void
857
858
add_answer_to_cache(const char *address, int is_reverse, uint32_t addr,
                    const char *hostname, char outcome, uint32_t ttl)
859
860
861
862
863
{
  cached_resolve_t *resolve;
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT)
    return;

864
865
866
867
  //log_notice(LD_EXIT, "Adding to cache: %s -> %s (%lx, %s), %d",
  //           address, is_reverse?"(reverse)":"", (unsigned long)addr,
  //           hostname?hostname:"NULL",(int)outcome);

868
869
870
871
872
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
  resolve->magic = CACHED_RESOLVE_MAGIC;
  resolve->state = (outcome == DNS_RESOLVE_SUCCEEDED) ?
    CACHE_STATE_CACHED_VALID : CACHE_STATE_CACHED_FAILED;
  strlcpy(resolve->address, address, sizeof(resolve->address));
873
  resolve->is_reverse = is_reverse;
874
  if (is_reverse) {
Nick Mathewson's avatar