dns.c 60.6 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
3
 * Copyright (c) 2007-2010, 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"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuituse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "router.h"
19
#include "ht.h"
20
#ifdef HAVE_EVENT2_DNS_H
21
#include <event2/event.h>
22
23
#include <event2/dns.h>
#else
24
#include <event.h>
25
#include "eventdns.h"
26
27
28
29
#ifndef HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#define HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#endif
#endif
30

31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#ifndef HAVE_EVENT2_DNS_H
struct evdns_base;
struct evdns_request;
#define evdns_base_new(x,y) tor_malloc(1)
#define evdns_base_clear_nameservers_and_suspend(base) \
  evdns_clear_nameservers_and_suspend()
#define evdns_base_search_clear(base) evdns_search_clear()
#define evdns_base_set_default_outgoing_bind_address(base, a, len)  \
  evdns_set_default_outgoing_bind_address((a),(len))
#define evdns_base_resolv_conf_parse(base, options, fname) \
  evdns_resolv_conf_parse((options), (fname))
#define evdns_base_count_nameservers(base)      \
  evdns_count_nameservers()
#define evdns_base_resume(base)                 \
  evdns_resume()
#define evdns_base_config_windows_nameservers(base)     \
  evdns_config_windows_nameservers()
48
49
#define evdns_base_set_option_(base, opt, val) \
  evdns_set_option((opt),(val),DNS_OPTIONS_ALL)
50
51
52
53
54
55
#define evdns_base_resolve_ipv4(base, addr, options, cb, ptr) \
  ((evdns_resolve_ipv4(addr, options, cb, ptr)<0) ? NULL : ((void*)1))
#define evdns_base_resolve_reverse(base, addr, options, cb, ptr) \
  ((evdns_resolve_reverse(addr, options, cb, ptr)<0) ? NULL : ((void*)1))
#define evdns_base_resolve_reverse_ipv6(base, addr, options, cb, ptr) \
  ((evdns_resolve_reverse_ipv6(addr, options, cb, ptr)<0) ? NULL : ((void*)1))
56
57
58
59
60
61
62
63

#elif defined(LIBEVENT_VERSION_NUMBER) && LIBEVENT_VERSION_NUMBER < 0x02000303
#define evdns_base_set_option_(base, opt, val) \
  evdns_base_set_option((base), (opt),(val),DNS_OPTIONS_ALL)

#else
#define evdns_base_set_option_ evdns_base_set_option

64
65
#endif

Roger Dingledine's avatar
Roger Dingledine committed
66
/** Longest hostname we're willing to resolve. */
67
68
#define MAX_ADDRESSLEN 256

69
70
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
71
72
#define RESOLVE_MAX_TIMEOUT 300

Roger Dingledine's avatar
Roger Dingledine committed
73
/** Possible outcomes from hostname lookup: permanent failure,
74
 * transient (retryable) failure, and success. */
75
76
77
78
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

79
80
81
/** Our evdns_base; this structure handles all our name lookups. */
static struct evdns_base *the_evdns_base = NULL;

82
83
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
84
85
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
86
87
88
89
90
91
/** 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;
92

Roger Dingledine's avatar
Roger Dingledine committed
93
/** Linked list of connections waiting for a DNS answer. */
94
typedef struct pending_connection_t {
95
  edge_connection_t *conn;
96
  struct pending_connection_t *next;
97
} pending_connection_t;
98

99
100
/** Value of 'magic' field for cached_resolve_t.  Used to try to catch bad
 * pointers and memory stomping. */
101
102
#define CACHED_RESOLVE_MAGIC 0x1234F00D

103
104
105
106
107
108
109
/* 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. */
110
#define CACHE_STATE_PENDING 0
111
112
113
/** 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. */
114
#define CACHE_STATE_DONE 1
115
116
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
117
#define CACHE_STATE_CACHED_VALID 2
118
119
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
120
121
#define CACHE_STATE_CACHED_FAILED 3

Roger Dingledine's avatar
Roger Dingledine committed
122
/** A DNS request: possibly completed, possibly pending; cached_resolve
123
 * structs are stored at the OR side in a hash table, and as a linked
124
125
 * list from oldest to newest.
 */
126
typedef struct cached_resolve_t {
127
  HT_ENTRY(cached_resolve_t) node;
128
  uint32_t magic;
129
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
130
  union {
131
132
133
134
    struct {
      struct in6_addr addr6; /**< IPv6 addr for <b>address</b>. */
      uint32_t addr;  /**< IPv4 addr for <b>address</b>. */
    } a;
135
136
    char *hostname; /**< Hostname for <b>address</b> (if a reverse lookup) */
  } result;
137
  uint8_t state; /**< Is this cached entry pending/done/valid/failed? */
138
  uint8_t is_reverse; /**< Is this a reverse (addr-to-hostname) lookup? */
139
  time_t expire; /**< Remove items from cache after this time. */
140
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
141
  /** Connections that want to know when we get an answer for this resolve. */
142
  pending_connection_t *pending_connections;
143
144
  /** Position of this element in the heap*/
  int minheap_idx;
145
} cached_resolve_t;
146

147
static void purge_expired_resolves(time_t now);
148
static void dns_found_answer(const char *address, uint8_t is_reverse,
149
                             uint32_t addr, const char *hostname, char outcome,
150
                             uint32_t ttl);
151
152
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
153
static void add_wildcarded_test_address(const char *address);
154
static int configure_nameservers(int force);
155
static int answer_is_wildcarded(const char *ip);
156
157
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                            or_circuit_t *oncirc, char **resolved_to_hostname);
158
#ifdef DEBUG_DNS_CACHE
159
static void _assert_cache_ok(void);
160
161
#define assert_cache_ok() _assert_cache_ok()
#else
162
#define assert_cache_ok() STMT_NIL
163
#endif
164
static void assert_resolve_ok(cached_resolve_t *resolve);
165

166
167
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
168

Roger Dingledine's avatar
Roger Dingledine committed
169
/** Function to compare hashed resolves on their addresses; used to
170
 * implement hash tables. */
171
172
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
173
{
174
  /* make this smarter one day? */
175
  assert_resolve_ok(a); // Not b; b may be just a search.
176
177
178
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

179
/** Hash function for cached_resolve objects */
180
181
182
183
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
184
185
}

186
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
187
             cached_resolves_eq)
188
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
189
            cached_resolves_eq, 0.6, malloc, realloc, free)
190

191
/** Initialize the DNS cache. */
192
static void
193
init_cache_map(void)
194
{
195
  HT_INIT(cache_map, &cache_root);
196
197
}

198
/** Helper: called by eventdns when eventdns wants to log something. */
199
static void
200
evdns_log_cb(int warn, const char *msg)
201
{
202
  const char *cp;
203
204
  static int all_down = 0;
  int severity = warn ? LOG_WARN : LOG_INFO;
205
206
207
208
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
209
210
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
211
  }
212
213
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
214
    const char *err = strchr(cp, ':')+2;
215
    tor_assert(err);
216
217
218
    /* 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. */
219
    severity = LOG_INFO;
220
    control_event_server_status(LOG_NOTICE,
221
222
223
224
225
226
                                "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));
227
    severity = (all_down && warn) ? LOG_NOTICE : LOG_INFO;
228
    all_down = 0;
229
230
231
232
233
    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");
234
    all_down = 1;
235
  }
236
  log(severity, LD_EXIT, "eventdns: %s", msg);
237
238
}

239
240
/** Helper: passed to eventdns.c as a callback so it can generate random
 * numbers for transaction IDs and 0x20-hack coding. */
241
static void
242
_dns_randfn(char *b, size_t n)
243
{
244
  crypto_rand(b,n);
245
246
}

Roger Dingledine's avatar
Roger Dingledine committed
247
/** Initialize the DNS subsystem; called by the OR process. */
248
int
249
250
dns_init(void)
{
251
  init_cache_map();
252
  evdns_set_random_bytes_fn(_dns_randfn);
253
254
255
256
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
257
  return 0;
258
}
259

260
261
262
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
263
264
265
266
dns_reset(void)
{
  or_options_t *options = get_options();
  if (! server_mode(options)) {
267
268
269
270
271
272
273
274

    if (!the_evdns_base) {
      if (!(the_evdns_base = evdns_base_new(tor_libevent_get_base(), 0))) {
        log_err(LD_BUG, "Couldn't create an evdns_base");
        return -1;
      }
    }

275
276
    evdns_base_clear_nameservers_and_suspend(the_evdns_base);
    evdns_base_search_clear(the_evdns_base);
277
278
279
280
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
281
    if (configure_nameservers(0) < 0) {
282
      return -1;
283
    }
284
  }
285
  return 0;
286
287
}

Nick Mathewson's avatar
Nick Mathewson committed
288
289
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
290
291
292
293
294
295
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

296
297
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
298
299
300
301
302
303
304
305
306
307
308
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;
}

309
310
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
311
312
313
314
315
316
317
318
319
320
321
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;
}

322
/** Helper: free storage held by an entry in the DNS cache. */
323
static void
324
_free_cached_resolve(cached_resolve_t *r)
325
{
326
327
  if (!r)
    return;
Nick Mathewson's avatar
Nick Mathewson committed
328
  while (r->pending_connections) {
329
    pending_connection_t *victim = r->pending_connections;
330
331
332
    r->pending_connections = victim->next;
    tor_free(victim);
  }
333
334
  if (r->is_reverse)
    tor_free(r->result.hostname);
335
  r->magic = 0xFF00FF00;
336
337
338
  tor_free(r);
}

339
340
341
/** 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. */
342
static int
343
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
344
{
345
  const cached_resolve_t *a = _a, *b = _b;
346
347
348
349
350
351
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
352
353
}

354
355
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
356
357
static smartlist_t *cached_resolve_pqueue = NULL;

358
359
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
360
361
362
363
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
364
365
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
366
367
368
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
369
                       STRUCT_OFFSET(cached_resolve_t, minheap_idx),
370
371
372
                       resolve);
}

373
/** Free all storage held in the DNS cache and related structures. */
374
375
376
void
dns_free_all(void)
{
377
  cached_resolve_t **ptr, **next, *item;
378
  assert_cache_ok();
379
380
381
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
382
        if (res->state == CACHE_STATE_DONE)
383
384
385
          _free_cached_resolve(res);
      });
  }
386
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
387
    item = *ptr;
388
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
389
    _free_cached_resolve(item);
390
  }
391
  HT_CLEAR(cache_map, &cache_root);
392
  smartlist_free(cached_resolve_pqueue);
393
  cached_resolve_pqueue = NULL;
394
  tor_free(resolv_conf_fname);
395
396
}

397
398
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
399
static void
400
purge_expired_resolves(time_t now)
401
{
Nick Mathewson's avatar
Nick Mathewson committed
402
  cached_resolve_t *resolve, *removed;
403
  pending_connection_t *pend;
404
  edge_connection_t *pendconn;
405

Nick Mathewson's avatar
Nick Mathewson committed
406
  assert_cache_ok();
407
408
409
410
411
412
413
414
  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,
415
416
                         _compare_cached_resolves_by_expiry,
                         STRUCT_OFFSET(cached_resolve_t, minheap_idx));
417

418
    if (resolve->state == CACHE_STATE_PENDING) {
419
      log_debug(LD_EXIT,
420
421
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
422
423
424
425
426
427
428
429
430
431
432
                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);
433
    }
434

435
    if (resolve->pending_connections) {
436
      log_debug(LD_EXIT,
437
                "Closing pending connections on timed-out DNS resolve!");
438
      tor_fragile_assert();
439
440
441
442
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
443
        tor_assert(pend->conn->_base.s == -1);
444
        pendconn = pend->conn;
445
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT);
446
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
447
        connection_free(TO_CONN(pendconn));
448
449
        tor_free(pend);
      }
450
    }
451

452
453
454
455
456
457
458
    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).",
459
                resolve->address, (void*)resolve,
460
                removed ? removed->address : "NULL", (void*)removed);
461
462
463
      }
      tor_assert(removed == resolve);
    } else {
464
      /* This should be in state DONE. Make sure it's not in the cache. */
465
466
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
467
    }
468
469
470
471
    if (resolve->is_reverse)
      tor_free(resolve->result.hostname);
    resolve->magic = 0xF0BBF0BB;
    tor_free(resolve);
472
  }
473

Nick Mathewson's avatar
Nick Mathewson committed
474
  assert_cache_ok();
475
476
}

477
478
479
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
480
481
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
482
483
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
484
 */
485
static void
486
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
487
488
{
  char buf[RELAY_PAYLOAD_SIZE];
489
  size_t buflen;
490
  uint32_t ttl;
491
492

  buf[0] = answer_type;
493
  ttl = dns_clip_ttl(conn->address_ttl);
494
495
496
497
498

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
499
      set_uint32(buf+2, tor_addr_to_ipv4n(&conn->_base.addr));
500
      set_uint32(buf+6, htonl(ttl));
501
      buflen = 10;
502
      break;
503
    /*XXXX IP6 need ipv6 implementation */
504
505
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
506
507
      {
        const char *errmsg = "Error resolving hostname";
508
        size_t msglen = strlen(errmsg);
509

510
511
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
512
        set_uint32(buf+2+msglen, htonl(ttl));
513
514
515
        buflen = 6+msglen;
        break;
      }
516
517
    default:
      tor_assert(0);
518
      return;
519
    }
520
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
521

522
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
523
524
}

525
526
527
/** 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.
528
529
530
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
531
 * <b>conn</b>'s attached circuit.
532
533
 */
static void
534
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
535
536
537
538
539
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
540
  tor_assert(hostname);
541
542
543
544
545
546
547
548
549
550

  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;

551
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
552
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
553
  // log_notice(LD_EXIT, "Sent");
554
555
}

Nick Mathewson's avatar
Nick Mathewson committed
556
557
/** 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
558
 * If resolve failed, free exitconn and return -1.
559
 *
560
561
562
563
564
 * (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.)
 *
565
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
566
 * circuit.
567
 *
568
569
570
571
572
 * 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.
573
574
575
576
577
578
 *
 * 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.
579
 */
580
int
581
dns_resolve(edge_connection_t *exitconn)
582
583
584
585
586
587
{
  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;

588
589
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname);

590
591
  switch (r) {
    case 1:
592
593
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
594
      if (is_resolve) {
595
        /* Send the answer back right now, and detach. */
596
597
598
599
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
600
        exitconn->on_circuit = NULL;
601
      } else {
602
603
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
604
605
606
607
608
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
609
610
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
611
612
613
614
615
616
      exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
617
      /* The request failed before it could start: cancel this connection,
618
       * and stop everybody waiting for the same connection. */
619
620
621
622
      if (is_resolve) {
        send_resolved_cell(exitconn,
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT);
      }
623

624
      exitconn->on_circuit = NULL;
625
626
627

      dns_cancel_pending_resolve(exitconn->_base.address);

628
      if (!exitconn->_base.marked_for_close) {
629
        connection_free(TO_CONN(exitconn));
630
        // XXX ... and we just leak exitconn otherwise? -RD
631
632
633
        // 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
634
        // "<armadev> If that's true, there are other bugs around, where we
635
        //  don't check if it's marked, and will end up double-freeing."
636
637
        // On the other hand, I don't know of any actual bugs here, so this
        // shouldn't be holding up the rc. -RD
638
      }
639
640
641
642
643
644
645
646
647
648
649
650
651
652
      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
653
654
655
 * 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.
656
657
658
659
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
                 or_circuit_t *oncirc, char **hostname_out)
660
{
661
662
663
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
664
  routerinfo_t *me;
665
  tor_addr_t addr;
666
  time_t now = time(NULL);
667
668
  uint8_t is_reverse = 0;
  int r;
669
670
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
671
  assert_cache_ok();
672
  tor_assert(oncirc);
673

674
  /* first check if exitconn->_base.address is an IP. If so, we already
675
   * know the answer. */
676
  if (tor_addr_from_str(&addr, exitconn->_base.address) >= 0) {
677
    if (tor_addr_family(&addr) == AF_INET) {
678
      tor_addr_copy(&exitconn->_base.addr, &addr);
679
680
681
682
683
684
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
      /* XXXX IPv6 */
      return -1;
    }
685
  }
686

687
688
689
690
691
  /* 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;
  }
692
693
694
695
696
697
  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;
  }
698
699

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

703
704
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
705

706
707
  /* 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
708
   * connection.
709
   */
710
711
  if ((r = tor_addr_parse_reverse_lookup_name(&addr, exitconn->_base.address,
                                              AF_UNSPEC, 0)) != 0) {
712
    if (r == 1) {
713
      is_reverse = 1;
714
715
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
716
    }
717
718
719
720
721
722
723
724
725
726
727
728
729

    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;
    }
730
    //log_notice(LD_EXIT, "Looks like an address %s",
Roger Dingledine's avatar
Roger Dingledine committed
731
    //exitconn->_base.address);
732
733
  }

734
  /* now check the hash table to see if 'address' is already there. */
735
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
736
  resolve = HT_FIND(cache_map, &cache_root, &search);
737
  if (resolve && resolve->expire > now) { /* already there */
738
    switch (resolve->state) {
739
740
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
741
        pending_connection = tor_malloc_zero(
742
                                      sizeof(pending_connection_t));
743
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
744
745
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
746
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
747
748
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
749
        return 0;
750
      case CACHE_STATE_CACHED_VALID:
751
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
752
                  exitconn->_base.s,
753
754
755
756
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
757
          *hostname_out = tor_strdup(resolve->result.hostname);
758
        } else {
759
          tor_addr_from_ipv4h(&exitconn->_base.addr, resolve->result.a.addr);
760
        }
761
        return 1;
762
      case CACHE_STATE_CACHED_FAILED:
763
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
764
765
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
766
        return -1;
767
768
769
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
770
    }
Roger Dingledine's avatar
Roger Dingledine committed
771
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
772
  }
773
  tor_assert(!resolve);
Roger Dingledine's avatar
Roger Dingledine committed
774
  /* not there, need to add it */
775
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
776
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
777
  resolve->state = CACHE_STATE_PENDING;
778
  resolve->minheap_idx = -1;
779
  resolve->is_reverse = is_reverse;
780
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
781

782
  /* add this connection to the pending list */
783
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
784
785
786
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;

787
  /* Add this resolve to the cache and priority queue. */
788
  HT_INSERT(cache_map, &cache_root, resolve);
789
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
790

791
  log_debug(LD_EXIT,"Launching %s.",
792
            escaped_safe_str(exitconn->_base.address));
793
  assert_cache_ok();
794

795
  return launch_resolve(exitconn);
796
797
}

798
/** Log an error and abort if conn is waiting for a DNS resolve.
799
 */
800
void
801
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
802
{
803
  pending_connection_t *pend;
804
  cached_resolve_t search;
805

806
807
808
809
810
811
812
813
814
815
816
#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;
817
  HT_FOREACH(resolve, cache_map, &cache_root) {
818
    for (pend = (*resolve)->pending_connections; pend; pend = pend->next) {
819
820
      tor_assert(pend->conn != conn);
    }
821
  }
822
#endif
823
}
824

825
826
827
828
829
830
831
/** 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;
832

833
834
835
836
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
837
838
839
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
840
    }
841
842
843
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
844
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
845
 */
846
void
847
connection_dns_remove(edge_connection_t *conn)
848
{
849
850
851
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
852

853
854
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
855

856
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
857

858
  resolve = HT_FIND(cache_map, &cache_root, &search);
859
  if (!resolve) {
860
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
861
               escaped_safe_str(conn->_base.address));
862
863
864
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
865
  tor_assert(resolve->pending_connections);
866
  assert_connection_ok(TO_CONN(conn),0);
867
868
869

  pend = resolve->pending_connections;

870
  if (pend->conn == conn) {
871
    resolve->pending_connections = pend->next;
872
    tor_free(pend);
873
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
874
              "for resolve of %s",
875
              conn->_base.s,
876
              escaped_safe_str(conn->_base.address));
877
878
    return;
  } else {