dns.c 57.6 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
#ifdef HAVE_EVENT2_DNS_H
17
#include <event2/event.h>
18
19
20
#include <event2/dns.h>
#include <event2/dns_compat.h>
#else
21
#include <event.h>
22
#include "eventdns.h"
23
24
25
26
#ifndef HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#define HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#endif
#endif
27

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
420
  assert_cache_ok();
421
422
}

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

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

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

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

468
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
469
470
}

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

  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;

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

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.
Roger Dingledine's avatar
Roger Dingledine committed
504
 * If resolve failed, free exitconn 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
int
527
dns_resolve(edge_connection_t *exitconn)
528
529
530
531
532
533
{
  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;

534
535
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname);

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

570
      exitconn->on_circuit = NULL;
571
572
573

      dns_cancel_pending_resolve(exitconn->_base.address);

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

620
  /* first check if exitconn->_base.address is an IP. If so, we already
621
   * know the answer. */
622
  if (tor_addr_from_str(&addr, exitconn->_base.address) >= 0) {
623
624
625
626
627
628
629
630
    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;
    }
631
  }
632

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

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

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

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

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

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

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

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

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

740
  return launch_resolve(exitconn);
741
742
}

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

751
752
753
754
755
756
757
758
759
760
761
#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;
762
  HT_FOREACH(resolve, cache_map, &cache_root) {
763
    for (pend = (*resolve)->pending_connections; pend; pend = pend->next) {
764
765
      tor_assert(pend->conn != conn);
    }
766
  }
767
#endif
768
}
769

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

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

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

798
799
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
800

801
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
802

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

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

  pend = resolve->pending_connections;

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

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

Nick Mathewson's avatar
Nick Mathewson committed
851
  strlcpy(search.address, address, sizeof(search.address));
852

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

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