dns.c 55.3 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
3
 * Copyright (c) 2007-2008, The Tor Project, Inc. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
7
const char dns_c_id[] =
  "$Id$";
8

Roger Dingledine's avatar
Roger Dingledine committed
9
10
/**
 * \file dns.c
11
 * \brief Implements a local cache for DNS results for Tor servers.
Roger Dingledine's avatar
Roger Dingledine committed
12
 * This is implemented as a wrapper around Adam Langley's eventdns.c code.
13
14
 * (We can't just use gethostbyname() and friends because we really need to
 * be nonblocking.)
Roger Dingledine's avatar
Roger Dingledine committed
15
 **/
16

17
#include "or.h"
18
#include "ht.h"
19
#include "eventdns.h"
20

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

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

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

34
35
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
36
37
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
38
39
40
41
42
43
/** 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;
44

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

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

55
56
57
58
59
60
61
/* 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. */
62
#define CACHE_STATE_PENDING 0
63
64
65
/** 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. */
66
#define CACHE_STATE_DONE 1
67
68
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
69
#define CACHE_STATE_CACHED_VALID 2
70
71
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
72
73
#define CACHE_STATE_CACHED_FAILED 3

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

97
static void purge_expired_resolves(time_t now);
98
static void dns_found_answer(const char *address, uint8_t is_reverse,
99
                             uint32_t addr, const char *hostname, char outcome,
100
                             uint32_t ttl);
101
102
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
103
static void add_wildcarded_test_address(const char *address);
104
static int configure_nameservers(int force);
105
static int answer_is_wildcarded(const char *ip);
106
107
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                            or_circuit_t *oncirc, char **resolved_to_hostname);
108
#ifdef DEBUG_DNS_CACHE
109
static void _assert_cache_ok(void);
110
111
#define assert_cache_ok() _assert_cache_ok()
#else
112
#define assert_cache_ok() STMT_NIL
113
#endif
114
static void assert_resolve_ok(cached_resolve_t *resolve);
115

116
117
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
118

Roger Dingledine's avatar
Roger Dingledine committed
119
/** Function to compare hashed resolves on their addresses; used to
120
 * implement hash tables. */
121
122
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
123
{
124
  /* make this smarter one day? */
125
  assert_resolve_ok(a); // Not b; b may be just a search.
126
127
128
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

129
/** Hash function for cached_resolve objects */
130
131
132
133
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
134
135
}

136
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
137
             cached_resolves_eq)
138
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
139
            cached_resolves_eq, 0.6, malloc, realloc, free)
140

141
/** Initialize the DNS cache. */
142
static void
143
init_cache_map(void)
144
{
145
  HT_INIT(cache_map, &cache_root);
146
147
}

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

189
/* DOCDOC randfn */
190
191
static void
randfn(char *b, size_t n)
192
{
193
  crypto_rand(b,n);
194
195
}

Roger Dingledine's avatar
Roger Dingledine committed
196
/** Initialize the DNS subsystem; called by the OR process. */
197
int
198
199
dns_init(void)
{
200
  init_cache_map();
201
202
203
204
205
206
207
208
209
  evdns_set_random_bytes_fn(randfn);
  if (get_options()->ServerDNSRandomizeCase)
    evdns_set_option("randomize-case", "1", DNS_OPTIONS_ALL);
  else
    evdns_set_option("randomize-case", "0", DNS_OPTIONS_ALL);
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
210
  return 0;
211
}
212

213
214
215
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
216
217
218
219
dns_reset(void)
{
  or_options_t *options = get_options();
  if (! server_mode(options)) {
220
221
    evdns_clear_nameservers_and_suspend();
    evdns_search_clear();
222
223
224
225
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
226
    if (configure_nameservers(0) < 0) {
227
      return -1;
228
    }
229
  }
230
  return 0;
231
232
}

Nick Mathewson's avatar
Nick Mathewson committed
233
234
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
235
236
237
238
239
240
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

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

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

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

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

297
298
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
299
300
static smartlist_t *cached_resolve_pqueue = NULL;

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

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

340
341
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
342
static void
343
purge_expired_resolves(time_t now)
344
{
Nick Mathewson's avatar
Nick Mathewson committed
345
  cached_resolve_t *resolve, *removed;
346
  pending_connection_t *pend;
347
  edge_connection_t *pendconn;
348

Nick Mathewson's avatar
Nick Mathewson committed
349
  assert_cache_ok();
350
351
352
353
354
355
356
357
358
359
  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);

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
416
  assert_cache_ok();
417
418
}

419
420
421
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
422
423
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
424
425
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
426
 */
427
static void
428
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
429
430
{
  char buf[RELAY_PAYLOAD_SIZE];
431
  size_t buflen;
432
  uint32_t ttl;
433
434

  buf[0] = answer_type;
435
  ttl = dns_clip_ttl(conn->address_ttl);
436
437
438
439
440

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
441
      set_uint32(buf+2, tor_addr_to_ipv4n(&conn->_base.addr));
442
      set_uint32(buf+6, htonl(ttl));
443
      buflen = 10;
444
      break;
445
    /*XXXX IP6 need ipv6 implementation */
446
447
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
448
449
      {
        const char *errmsg = "Error resolving hostname";
450
        size_t msglen = strlen(errmsg);
451

452
453
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
454
        set_uint32(buf+2+msglen, htonl(ttl));
455
456
457
        buflen = 6+msglen;
        break;
      }
458
459
    default:
      tor_assert(0);
460
      return;
461
    }
462
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
463

464
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
465
466
}

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

  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;

493
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
494
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
495
  // log_notice(LD_EXIT, "Sent");
496
497
}

Nick Mathewson's avatar
Nick Mathewson committed
498
499
/** 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.
Roger Dingledine's avatar
Roger Dingledine committed
500
 * If resolve failed, free exitconn and return -1.
501
 *
502
503
504
505
506
 * (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.)
 *
507
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
508
 * circuit.
509
 *
510
511
512
513
514
 * 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.
515
516
517
518
519
520
 *
 * 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.
521
 */
522
int
523
dns_resolve(edge_connection_t *exitconn)
524
525
526
527
528
529
{
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
  int is_resolve, r;
  char *hostname = NULL;
  is_resolve = exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE;

530
531
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname);

532
533
  switch (r) {
    case 1:
534
535
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
536
      if (is_resolve) {
537
        /* Send the answer back right now, and detach. */
538
539
540
541
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
542
        exitconn->on_circuit = NULL;
543
      } else {
544
545
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
546
547
548
549
550
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
551
552
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
553
554
555
556
557
558
      exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
559
      /* The request failed before it could start: cancel this connection,
560
       * and stop everybody waiting for the same connection. */
561
562
563
564
      if (is_resolve) {
        send_resolved_cell(exitconn,
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT);
      }
565

566
      exitconn->on_circuit = NULL;
567
568
569

      dns_cancel_pending_resolve(exitconn->_base.address);

570
      if (!exitconn->_base.marked_for_close) {
571
        connection_free(TO_CONN(exitconn));
572
        // XXX ... and we just leak exitconn otherwise? -RD
573
574
575
        // If it's marked for close, it's on closeable_connection_lst in
        // main.c.  If it's on the closeable list, it will get freed from
        // main.c. -NM
576
        // "<armadev> If that's true, there are other bugs around, where we
577
        //  don't check if it's marked, and will end up double-freeing."
578
579
        // On the other hand, I don't know of any actual bugs here, so this
        // shouldn't be holding up the rc. -RD
580
      }
581
582
583
584
585
586
587
588
589
590
591
592
593
594
      break;
    default:
      tor_assert(0);
  }

  tor_free(hostname);
  return r;
}

/** Helper function for dns_resolve: same functionality, but does not handle:
 *     - marking connections on error and clearing their on_circuit
 *     - linking connections to n_streams/resolving_streams,
 *     - sending resolved cells if we have an answer/error right away,
 *
Roger Dingledine's avatar
Roger Dingledine committed
595
596
597
 * Return -2 on a transient error. If it's a reverse resolve and it's
 * successful, sets *<b>hostname_out</b> to a newly allocated string
 * holding the cached reverse DNS value.
598
599
600
601
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                 or_circuit_t *oncirc, char **hostname_out)
602
{
603
604
605
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
606
  routerinfo_t *me;
607
  tor_addr_t addr;
608
  time_t now = time(NULL);
609
610
  uint8_t is_reverse = 0;
  int r;
611
612
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
613
  assert_cache_ok();
614
  tor_assert(oncirc);
615

616
  /* first check if exitconn->_base.address is an IP. If so, we already
617
   * know the answer. */
618
619
  if (tor_addr_from_str(&addr, exitconn->_base.address)<0) {
    tor_addr_assign(&exitconn->_base.addr, &addr);
620
    exitconn->address_ttl = DEFAULT_DNS_TTL;
621
    return 1;
622
  }
623
624
625
626
627
  /* If we're a non-exit, don't even do DNS lookups. */
  if (!(me = router_get_my_routerinfo()) ||
      policy_is_reject_star(me->exit_policy)) {
    return -1;
  }
628
629
630
631
632
633
  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));
    return -1;
  }
634
635

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

639
640
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
641

642
643
  /* 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
644
   * connection.
645
   */
646
647
  if ((r = tor_addr_parse_reverse_lookup_name(&addr, exitconn->_base.address,
                                              AF_UNSPEC, 0)) != 0) {
648
    if (r == 1) {
649
      is_reverse = 1;
650
651
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
652
    }
653
654
655
656
657
658
659
660
661
662
663
664
665

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

      return -1;
    }
666
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
667
    //exitconn->_base.address);
668
669
  }

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

717
  /* add this connection to the pending list */
718
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
719
720
721
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;

722
  /* Add this resolve to the cache and priority queue. */
723
  HT_INSERT(cache_map, &cache_root, resolve);
724
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
725

726
  log_debug(LD_EXIT,"Launching %s.",
727
            escaped_safe_str(exitconn->_base.address));
728
  assert_cache_ok();
729

730
  return launch_resolve(exitconn);
731
732
}

733
/** Log an error and abort if conn is waiting for a DNS resolve.
734
 */
735
void
736
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
737
{
738
739
  pending_connection_t *pend;
  cached_resolve_t **resolve;
740

741
742
743
744
745
746
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
747
  }
748
}
749

750
751
752
753
754
755
756
/** 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;
757

758
759
760
761
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
762
763
764
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
765
    }
766
767
768
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
769
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
770
 */
771
void
772
connection_dns_remove(edge_connection_t *conn)
773
{
774
775
776
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
777

778
779
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
780

781
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
782

783
  resolve = HT_FIND(cache_map, &cache_root, &search);
784
  if (!resolve) {
785
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
786
               escaped_safe_str(conn->_base.address));
787
788
789
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
790
  tor_assert(resolve->pending_connections);
791
  assert_connection_ok(TO_CONN(conn),0);
792
793
794

  pend = resolve->pending_connections;

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

Nick Mathewson's avatar
Nick Mathewson committed
818
819
820
/** 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.
821
 */
822
void
823
dns_cancel_pending_resolve(const char *address)
824
{
825
826
  pending_connection_t *pend;
  cached_resolve_t search;
827
  cached_resolve_t *resolve, *tmp;
828
  edge_connection_t *pendconn;
829
  circuit_t *circ;
830

Nick Mathewson's avatar
Nick Mathewson committed
831
  strlcpy(search.address, address, sizeof(search.address));
832

833
  resolve = HT_FIND(cache_map, &cache_root, &search);
834
835
836
  if (!resolve)
    return;

837
  if (resolve->state != CACHE_STATE_PENDING) {
838
839
840
841
842
843
844
845
846
    /* We can get into this state if we never actually created the pending
     * resolve, due to finding an earlier cached error or something.  Just
     * ignore it. */
    if (resolve->pending_connections) {
      log_warn(LD_BUG,
               "Address %s is not pending but has pending connections!",
               escaped_safe_str(address));
      tor_fragile_assert();
    }
847
848
849
    return;
  }

850
  if (!resolve->pending_connections) {
851
    log_warn(LD_BUG,
852
             "Address %s is pending but has no pending connections!",
853
             escaped_safe_str(address));
854
    tor_fragile_assert();
855
856
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
857
  tor_assert(resolve->pending_connections);
858

859
  /* mark all pending connections to fail */
860
  log_debug(LD_EXIT,
861
862
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
863
  while (resolve->pending_connections) {