dns.c 57.5 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
Karsten Loesing's avatar
Karsten Loesing committed
3
 * Copyright (c) 2007-2009, The Tor Project, Inc. */
4
5
/* See LICENSE for licensing information */

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

14
#include "or.h"
15
#include "ht.h"
16
17
18
19
#ifdef HAVE_EVENT2_DNS_H
#include <event2/dns.h>
#include <event2/dns_compat.h>
#else
20
#include "eventdns.h"
21
22
23
24
#ifndef HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#define HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#endif
#endif
25

Roger Dingledine's avatar
Roger Dingledine committed
26
/** Longest hostname we're willing to resolve. */
27
28
#define MAX_ADDRESSLEN 256

29
30
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
31
32
#define RESOLVE_MAX_TIMEOUT 300

Roger Dingledine's avatar
Roger Dingledine committed
33
/** Possible outcomes from hostname lookup: permanent failure,
34
 * transient (retryable) failure, and success. */
35
36
37
38
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

39
40
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
41
42
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
43
44
45
46
47
48
/** 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;
49

Roger Dingledine's avatar
Roger Dingledine committed
50
/** Linked list of connections waiting for a DNS answer. */
51
typedef struct pending_connection_t {
52
  edge_connection_t *conn;
53
  struct pending_connection_t *next;
54
} pending_connection_t;
55

56
57
/** Value of 'magic' field for cached_resolve_t.  Used to try to catch bad
 * pointers and memory stomping. */
58
59
#define CACHED_RESOLVE_MAGIC 0x1234F00D

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

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

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

121
122
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
123

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

134
/** Hash function for cached_resolve objects */
135
136
137
138
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
139
140
}

141
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
142
             cached_resolves_eq)
143
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
144
            cached_resolves_eq, 0.6, malloc, realloc, free)
145

146
/** Initialize the DNS cache. */
147
static void
148
init_cache_map(void)
149
{
150
  HT_INIT(cache_map, &cache_root);
151
152
}

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

194
195
/** Helper: passed to eventdns.c as a callback so it can generate random
 * numbers for transaction IDs and 0x20-hack coding. */
196
static void
197
_dns_randfn(char *b, size_t n)
198
{
199
  crypto_rand(b,n);
200
201
}

Roger Dingledine's avatar
Roger Dingledine committed
202
/** Initialize the DNS subsystem; called by the OR process. */
203
int
204
205
dns_init(void)
{
206
  init_cache_map();
207
  evdns_set_random_bytes_fn(_dns_randfn);
208
209
210
211
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
212
  return 0;
213
}
214

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
418
  assert_cache_ok();
419
420
}

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

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

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

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

466
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
467
468
}

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

  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;

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

Nick Mathewson's avatar
Nick Mathewson committed
500
501
/** 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
502
 * If resolve failed, free exitconn and return -1.
503
 *
504
505
506
507
508
 * (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.)
 *
509
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
510
 * circuit.
511
 *
512
513
514
515
516
 * 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.
517
518
519
520
521
522
 *
 * 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.
523
 */
524
int
525
dns_resolve(edge_connection_t *exitconn)
526
527
528
529
530
531
{
  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;

532
533
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname);

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

568
      exitconn->on_circuit = NULL;
569
570
571

      dns_cancel_pending_resolve(exitconn->_base.address);

572
      if (!exitconn->_base.marked_for_close) {
573
        connection_free(TO_CONN(exitconn));
574
        // XXX ... and we just leak exitconn otherwise? -RD
575
576
577
        // 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
578
        // "<armadev> If that's true, there are other bugs around, where we
579
        //  don't check if it's marked, and will end up double-freeing."
580
581
        // On the other hand, I don't know of any actual bugs here, so this
        // shouldn't be holding up the rc. -RD
582
      }
583
584
585
586
587
588
589
590
591
592
593
594
595
596
      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
597
598
599
 * 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.
600
601
602
603
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                 or_circuit_t *oncirc, char **hostname_out)
604
{
605
606
607
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
608
  routerinfo_t *me;
609
  tor_addr_t addr;
610
  time_t now = time(NULL);
611
612
  uint8_t is_reverse = 0;
  int r;
613
614
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
615
  assert_cache_ok();
616
  tor_assert(oncirc);
617

618
  /* first check if exitconn->_base.address is an IP. If so, we already
619
   * know the answer. */
620
  if (tor_addr_from_str(&addr, exitconn->_base.address) >= 0) {
621
622
623
624
625
626
627
628
    if (tor_addr_family(&addr) == AF_INET) {
      tor_addr_assign(&exitconn->_base.addr, &addr);
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
      /* XXXX IPv6 */
      return -1;
    }
629
  }
630

631
632
633
634
635
  /* 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;
  }
636
637
638
639
640
641
  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;
  }
642
643

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

647
648
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
649

650
651
  /* 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
652
   * connection.
653
   */
654
655
  if ((r = tor_addr_parse_reverse_lookup_name(&addr, exitconn->_base.address,
                                              AF_UNSPEC, 0)) != 0) {
656
    if (r == 1) {
657
      is_reverse = 1;
658
659
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
660
    }
661
662
663
664
665
666
667
668
669
670
671
672
673

    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;
    }
674
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
675
    //exitconn->_base.address);
676
677
  }

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

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

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

734
  log_debug(LD_EXIT,"Launching %s.",
735
            escaped_safe_str(exitconn->_base.address));
736
  assert_cache_ok();
737

738
  return launch_resolve(exitconn);
739
740
}

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

749
750
751
752
753
754
755
756
757
758
759
#if 1
  cached_resolve_t *resolve;
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
  resolve = HT_FIND(cache_map, &cache_root, &search);
  if (!resolve)
    return;
  for (pend = resolve->pending_connections; pend; pend = pend->next) {
    tor_assert(pend->conn != conn);
  }
#else
  cached_resolve_t **resolve;
760
  HT_FOREACH(resolve, cache_map, &cache_root) {
761
    for (pend = (*resolve)->pending_connections; pend; pend = pend->next) {
762
763
      tor_assert(pend->conn != conn);
    }
764
  }
765
#endif
766
}
767

768
769
770
771
772
773
774
/** 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;
775

776
777
778
779
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
780
781
782
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
783
    }
784
785
786
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
787
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
788
 */
789
void
790
connection_dns_remove(edge_connection_t *conn)
791
{
792
793
794
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
795

796
797
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
798

799
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
800

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

Roger Dingledine's avatar
Roger Dingledine committed
808
  tor_assert(resolve->pending_connections);
809
  assert_connection_ok(TO_CONN(conn),0);
810
811
812

  pend = resolve->pending_connections;

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

Nick Mathewson's avatar
Nick Mathewson committed
836
837
838
/** 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.
839
 */
840
void
841
dns_cancel_pending_resolve(const char *address)
842
{
843
844
  pending_connection_t *pend;
  cached_resolve_t search;
845
  cached_resolve_t *resolve, *tmp;
846
  edge_connection_t *pendconn;
847
  circuit_t *circ;
848

Nick Mathewson's avatar
Nick Mathewson committed
849
  strlcpy(search.address, address, sizeof(search.address));
850

851
  resolve = HT_FIND(cache_map, &cache_root, &search);
852
853
854
  if (!resolve)
    return;

855
  if (resolve->state != CACHE_STATE_PENDING) {
856
857
858
859
860
861
862
863
864
    /* 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();
    }
865
866
867
    return;
  }

868
  if (!resolve->pending_connections) {
869
    log_warn(LD_BUG,
870
             "Address %s is pending but has no pending connections!",