dns.c 75 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
3
 * Copyright (c) 2007-2015, 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 "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "connection_edge.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
20
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "router.h"
26
#include "ht.h"
27
#include "../common/sandbox.h"
28
#ifdef HAVE_EVENT2_DNS_H
29
#include <event2/event.h>
30
31
#include <event2/dns.h>
#else
32
#include <event.h>
33
#include "eventdns.h"
34
35
36
37
#ifndef HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#define HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#endif
#endif
38

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
#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()
56
57
#define evdns_base_set_option_(base, opt, val) \
  evdns_set_option((opt),(val),DNS_OPTIONS_ALL)
58
/* Note: our internal eventdns.c, plus Libevent 1.4, used a 1 return to
59
 * signify failure to launch a resolve. Libevent 2.0 uses a -1 return to
60
 * signify a failure on a resolve, though if we're on Libevent 2.0, we should
61
 * have event2/dns.h and never hit these macros.  Regardless, 0 is success. */
62
#define evdns_base_resolve_ipv4(base, addr, options, cb, ptr) \
63
64
  ((evdns_resolve_ipv4((addr), (options), (cb), (ptr))!=0)    \
   ? NULL : ((void*)1))
65
66
67
#define evdns_base_resolve_ipv6(base, addr, options, cb, ptr) \
  ((evdns_resolve_ipv6((addr), (options), (cb), (ptr))!=0)    \
   ? NULL : ((void*)1))
68
69
70
71
72
73
#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))
74
75
76
77
78
79
80
81

#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

82
83
#endif

Roger Dingledine's avatar
Roger Dingledine committed
84
/** Longest hostname we're willing to resolve. */
85
86
#define MAX_ADDRESSLEN 256

87
88
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
89
90
#define RESOLVE_MAX_TIMEOUT 300

91
92
93
/** Our evdns_base; this structure handles all our name lookups. */
static struct evdns_base *the_evdns_base = NULL;

94
95
/** Have we currently configured nameservers with eventdns? */
static int nameservers_configured = 0;
96
97
/** Did our most recent attempt to configure nameservers with eventdns fail? */
static int nameserver_config_failed = 0;
98
99
100
101
102
103
/** 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;
104

Roger Dingledine's avatar
Roger Dingledine committed
105
/** Linked list of connections waiting for a DNS answer. */
106
typedef struct pending_connection_t {
107
  edge_connection_t *conn;
108
  struct pending_connection_t *next;
109
} pending_connection_t;
110

111
112
/** Value of 'magic' field for cached_resolve_t.  Used to try to catch bad
 * pointers and memory stomping. */
113
114
#define CACHED_RESOLVE_MAGIC 0x1234F00D

115
116
117
/* 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
118
 * will become "DONE" and we'll possibly add a CACHED
119
120
121
 * 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. */
122
#define CACHE_STATE_PENDING 0
123
124
125
/** 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. */
126
#define CACHE_STATE_DONE 1
127
128
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
129
130
#define CACHE_STATE_CACHED 2

131
132
133
134
/** @name status values for a single DNS request.
 *
 * @{ */
/** The DNS request is in progress. */
135
#define RES_STATUS_INFLIGHT 1
136
/** The DNS request finished and gave an answer */
137
#define RES_STATUS_DONE_OK 2
138
/** The DNS request finished and gave an error */
139
#define RES_STATUS_DONE_ERR 3
140
/**@}*/
141

Roger Dingledine's avatar
Roger Dingledine committed
142
/** A DNS request: possibly completed, possibly pending; cached_resolve
143
 * structs are stored at the OR side in a hash table, and as a linked
144
145
 * list from oldest to newest.
 */
146
typedef struct cached_resolve_t {
147
  HT_ENTRY(cached_resolve_t) node;
148
  uint32_t magic;  /**< Must be CACHED_RESOLVE_MAGIC */
149
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
150
151

  union {
152
153
    uint32_t addr_ipv4; /**< IPv4 addr for <b>address</b>, if successful.
                         * (In host order.) */
154
155
    int err_ipv4; /**< One of DNS_ERR_*, if IPv4 lookup failed. */
  } result_ipv4; /**< Outcome of IPv4 lookup */
156
  union {
157
158
159
160
    struct in6_addr addr_ipv6; /**< IPv6 addr for <b>address</b>, if
                                * successful */
    int err_ipv6; /**< One of DNS_ERR_*, if IPv6 lookup failed. */
  } result_ipv6; /**< Outcome of IPv6 lookup, if any */
161
  union {
162
163
    char *hostname; /** A hostname, if PTR lookup happened successfully*/
    int err_hostname; /** One of DNS_ERR_*, if PTR lookup failed. */
164
  } result_ptr;
165
166
167
168
169
170
  /** @name Status fields
   *
   * These take one of the RES_STATUS_* values, depending on the state
   * of the corresponding lookup.
   *
   * @{ */
171
172
173
  unsigned int res_status_ipv4 : 2;
  unsigned int res_status_ipv6 : 2;
  unsigned int res_status_hostname : 2;
174
  /**@}*/
175
  uint8_t state; /**< Is this cached entry pending/done/informative? */
176

177
  time_t expire; /**< Remove items from cache after this time. */
178
179
180
  uint32_t ttl_ipv4; /**< What TTL did the nameserver tell us? */
  uint32_t ttl_ipv6; /**< What TTL did the nameserver tell us? */
  uint32_t ttl_hostname; /**< What TTL did the nameserver tell us? */
181
  /** Connections that want to know when we get an answer for this resolve. */
182
  pending_connection_t *pending_connections;
183
184
  /** Position of this element in the heap*/
  int minheap_idx;
185
} cached_resolve_t;
186

187
static void purge_expired_resolves(time_t now);
188
189
190
191
static void dns_found_answer(const char *address, uint8_t query_type,
                             int dns_answer,
                             const tor_addr_t *addr,
                             const char *hostname,
192
                             uint32_t ttl);
193
194
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type,
                               const cached_resolve_t *resolve);
195
static int launch_resolve(cached_resolve_t *resolve);
196
static void add_wildcarded_test_address(const char *address);
197
static int configure_nameservers(int force);
198
static int answer_is_wildcarded(const char *ip);
199
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
200
                            or_circuit_t *oncirc, char **resolved_to_hostname,
201
202
                            int *made_connection_pending_out,
                            cached_resolve_t **resolve_out);
203
204
205
206
207
208
209
static int set_exitconn_info_from_resolve(edge_connection_t *exitconn,
                                          const cached_resolve_t *resolve,
                                          char **hostname_out);
static int evdns_err_is_transient(int err);
static void inform_pending_connections(cached_resolve_t *resolve);
static void make_pending_resolve_cached(cached_resolve_t *cached);

210
#ifdef DEBUG_DNS_CACHE
211
212
static void assert_cache_ok_(void);
#define assert_cache_ok() assert_cache_ok_()
213
#else
214
#define assert_cache_ok() STMT_NIL
215
#endif
216
static void assert_resolve_ok(cached_resolve_t *resolve);
217

218
219
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
220

221
/** Global: how many IPv6 requests have we made in all? */
222
static uint64_t n_ipv6_requests_made = 0;
223
/** Global: how many IPv6 requests have timed out? */
224
static uint64_t n_ipv6_timeouts = 0;
225
/** Global: Do we think that IPv6 DNS is broken? */
226
227
static int dns_is_broken_for_ipv6 = 0;

Roger Dingledine's avatar
Roger Dingledine committed
228
/** Function to compare hashed resolves on their addresses; used to
229
 * implement hash tables. */
230
231
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
232
{
233
  /* make this smarter one day? */
234
  assert_resolve_ok(a); // Not b; b may be just a search.
235
236
237
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

238
/** Hash function for cached_resolve objects */
239
240
241
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
242
  return (unsigned) siphash24g((const uint8_t*)a->address, strlen(a->address));
243
244
}

245
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
246
             cached_resolves_eq)
247
248
HT_GENERATE2(cache_map, cached_resolve_t, node, cached_resolve_hash,
             cached_resolves_eq, 0.6, tor_reallocarray_, tor_free_)
249

250
/** Initialize the DNS cache. */
251
static void
252
init_cache_map(void)
253
{
254
  HT_INIT(cache_map, &cache_root);
255
256
}

257
/** Helper: called by eventdns when eventdns wants to log something. */
258
static void
259
evdns_log_cb(int warn, const char *msg)
260
{
261
  const char *cp;
262
263
  static int all_down = 0;
  int severity = warn ? LOG_WARN : LOG_INFO;
264
265
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
266
    log_info(LD_EXIT, "eventdns: Resolve requested.");
267
    return;
268
269
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
270
  }
271
272
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
273
    const char *err = strchr(cp, ':')+2;
274
    tor_assert(err);
275
276
277
    /* 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. */
278
    severity = LOG_INFO;
279
    control_event_server_status(LOG_NOTICE,
280
281
282
283
284
285
                                "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));
286
    severity = (all_down && warn) ? LOG_NOTICE : LOG_INFO;
287
    all_down = 0;
288
289
290
291
292
    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");
293
    all_down = 1;
294
  }
295
  tor_log(severity, LD_EXIT, "eventdns: %s", msg);
296
297
}

298
299
/** Helper: passed to eventdns.c as a callback so it can generate random
 * numbers for transaction IDs and 0x20-hack coding. */
300
static void
301
dns_randfn_(char *b, size_t n)
302
{
303
  crypto_rand(b,n);
304
305
}

Roger Dingledine's avatar
Roger Dingledine committed
306
/** Initialize the DNS subsystem; called by the OR process. */
307
int
308
309
dns_init(void)
{
310
  init_cache_map();
311
  evdns_set_random_bytes_fn(dns_randfn_);
312
313
314
315
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
316
  return 0;
317
}
318

319
320
321
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
322
323
dns_reset(void)
{
324
  const or_options_t *options = get_options();
325
  if (! server_mode(options)) {
326
327
328
329
330
331
332
333

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

334
335
    evdns_base_clear_nameservers_and_suspend(the_evdns_base);
    evdns_base_search_clear(the_evdns_base);
336
337
338
339
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
340
    if (configure_nameservers(0) < 0) {
341
      return -1;
342
    }
343
  }
344
  return 0;
345
346
}

Nick Mathewson's avatar
Nick Mathewson committed
347
348
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
349
350
351
352
353
354
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

355
356
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
357
358
359
360
361
362
363
364
365
366
367
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;
}

368
369
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
370
371
372
373
374
375
376
377
378
379
380
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;
}

381
/** Helper: free storage held by an entry in the DNS cache. */
382
static void
383
free_cached_resolve_(cached_resolve_t *r)
384
{
385
386
  if (!r)
    return;
Nick Mathewson's avatar
Nick Mathewson committed
387
  while (r->pending_connections) {
388
    pending_connection_t *victim = r->pending_connections;
389
390
391
    r->pending_connections = victim->next;
    tor_free(victim);
  }
392
393
  if (r->res_status_hostname == RES_STATUS_DONE_OK)
    tor_free(r->result_ptr.hostname);
394
  r->magic = 0xFF00FF00;
395
396
397
  tor_free(r);
}

398
399
400
/** 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. */
401
static int
402
compare_cached_resolves_by_expiry_(const void *_a, const void *_b)
403
{
404
  const cached_resolve_t *a = _a, *b = _b;
405
406
407
408
409
410
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
411
412
}

413
414
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
415
416
static smartlist_t *cached_resolve_pqueue = NULL;

417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
static void
cached_resolve_add_answer(cached_resolve_t *resolve,
                          int query_type,
                          int dns_result,
                          const tor_addr_t *answer_addr,
                          const char *answer_hostname,
                          uint32_t ttl)
{
  if (query_type == DNS_PTR) {
    if (resolve->res_status_hostname != RES_STATUS_INFLIGHT)
      return;

    if (dns_result == DNS_ERR_NONE && answer_hostname) {
      resolve->result_ptr.hostname = tor_strdup(answer_hostname);
      resolve->res_status_hostname = RES_STATUS_DONE_OK;
    } else {
      resolve->result_ptr.err_hostname = dns_result;
      resolve->res_status_hostname = RES_STATUS_DONE_ERR;
    }
    resolve->ttl_hostname = ttl;
  } else if (query_type == DNS_IPv4_A) {
    if (resolve->res_status_ipv4 != RES_STATUS_INFLIGHT)
      return;

441
442
    if (dns_result == DNS_ERR_NONE && answer_addr &&
        tor_addr_family(answer_addr) == AF_INET) {
443
444
445
446
447
448
449
450
451
452
453
      resolve->result_ipv4.addr_ipv4 = tor_addr_to_ipv4h(answer_addr);
      resolve->res_status_ipv4 = RES_STATUS_DONE_OK;
    } else {
      resolve->result_ipv4.err_ipv4 = dns_result;
      resolve->res_status_ipv4 = RES_STATUS_DONE_ERR;
    }

  } else if (query_type == DNS_IPv6_AAAA) {
    if (resolve->res_status_ipv6 != RES_STATUS_INFLIGHT)
      return;

454
455
    if (dns_result == DNS_ERR_NONE && answer_addr &&
        tor_addr_family(answer_addr) == AF_INET6) {
456
457
458
459
460
461
462
463
464
465
466
      memcpy(&resolve->result_ipv6.addr_ipv6,
             tor_addr_to_in6(answer_addr),
             sizeof(struct in6_addr));
      resolve->res_status_ipv6 = RES_STATUS_DONE_OK;
    } else {
      resolve->result_ipv6.err_ipv6 = dns_result;
      resolve->res_status_ipv6 = RES_STATUS_DONE_ERR;
    }
  }
}

467
/** Return true iff there are no in-flight requests for <b>resolve</b>. */
468
469
470
471
472
473
474
475
static int
cached_resolve_have_all_answers(const cached_resolve_t *resolve)
{
  return (resolve->res_status_ipv4 != RES_STATUS_INFLIGHT &&
          resolve->res_status_ipv6 != RES_STATUS_INFLIGHT &&
          resolve->res_status_hostname != RES_STATUS_INFLIGHT);
}

476
477
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
478
479
480
481
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
482
  if (!cached_resolve_pqueue)
483
    cached_resolve_pqueue = smartlist_new();
484
485
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
486
                       compare_cached_resolves_by_expiry_,
487
                       STRUCT_OFFSET(cached_resolve_t, minheap_idx),
488
489
490
                       resolve);
}

491
/** Free all storage held in the DNS cache and related structures. */
492
493
494
void
dns_free_all(void)
{
495
  cached_resolve_t **ptr, **next, *item;
496
  assert_cache_ok();
497
498
499
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
500
        if (res->state == CACHE_STATE_DONE)
501
          free_cached_resolve_(res);
502
503
      });
  }
504
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
505
    item = *ptr;
506
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
507
    free_cached_resolve_(item);
508
  }
509
  HT_CLEAR(cache_map, &cache_root);
510
  smartlist_free(cached_resolve_pqueue);
511
  cached_resolve_pqueue = NULL;
512
  tor_free(resolv_conf_fname);
513
514
}

515
516
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
517
static void
518
purge_expired_resolves(time_t now)
519
{
Nick Mathewson's avatar
Nick Mathewson committed
520
  cached_resolve_t *resolve, *removed;
521
  pending_connection_t *pend;
522
  edge_connection_t *pendconn;
523

Nick Mathewson's avatar
Nick Mathewson committed
524
  assert_cache_ok();
525
526
527
528
529
530
531
532
  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,
533
                         compare_cached_resolves_by_expiry_,
534
                         STRUCT_OFFSET(cached_resolve_t, minheap_idx));
535

536
    if (resolve->state == CACHE_STATE_PENDING) {
537
      log_debug(LD_EXIT,
538
539
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
540
                escaped_safe_str(resolve->address));
541
    } else if (resolve->state == CACHE_STATE_CACHED) {
542
543
544
545
546
547
548
549
      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);
550
    }
551

552
    if (resolve->pending_connections) {
553
      log_debug(LD_EXIT,
554
                "Closing pending connections on timed-out DNS resolve!");
555
556
557
558
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
559
        tor_assert(!SOCKET_OK(pend->conn->base_.s));
560
        pendconn = pend->conn;
561
562
        /* Prevent double-remove */
        pendconn->base_.state = EXIT_CONN_STATE_RESOLVEFAILED;
563
        if (!pendconn->base_.marked_for_close) {
564
565
566
567
          connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT);
          circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
          connection_free(TO_CONN(pendconn));
        }
568
569
        tor_free(pend);
      }
570
    }
571

572
    if (resolve->state == CACHE_STATE_CACHED ||
573
574
575
576
577
        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).",
578
                resolve->address, (void*)resolve,
579
                removed ? removed->address : "NULL", (void*)removed);
580
581
582
      }
      tor_assert(removed == resolve);
    } else {
583
      /* This should be in state DONE. Make sure it's not in the cache. */
584
585
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
586
    }
587
588
    if (resolve->res_status_hostname == RES_STATUS_DONE_OK)
      tor_free(resolve->result_ptr.hostname);
589
590
    resolve->magic = 0xF0BBF0BB;
    tor_free(resolve);
591
  }
592

Nick Mathewson's avatar
Nick Mathewson committed
593
  assert_cache_ok();
594
595
}

596
597
598
599
/* argument for send_resolved_cell only, meaning "let the answer type be ipv4
 * or ipv6 depending on the connection's address". */
#define RESOLVED_TYPE_AUTO 0xff

600
601
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
602
 * RESOLVED_TYPE_(AUTO|ERROR|ERROR_TRANSIENT|).
603
604
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
605
606
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
607
 */
608
static void
609
610
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type,
                   const cached_resolve_t *resolved)
611
{
612
613
  char buf[RELAY_PAYLOAD_SIZE], *cp = buf;
  size_t buflen = 0;
614
  uint32_t ttl;
615
616

  buf[0] = answer_type;
617
  ttl = dns_clip_ttl(conn->address_ttl);
618
619
620

  switch (answer_type)
    {
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
    case RESOLVED_TYPE_AUTO:
      if (resolved && resolved->res_status_ipv4 == RES_STATUS_DONE_OK) {
        cp[0] = RESOLVED_TYPE_IPV4;
        cp[1] = 4;
        set_uint32(cp+2, htonl(resolved->result_ipv4.addr_ipv4));
        set_uint32(cp+6, htonl(ttl));
        cp += 10;
      }
      if (resolved && resolved->res_status_ipv6 == RES_STATUS_DONE_OK) {
        const uint8_t *bytes = resolved->result_ipv6.addr_ipv6.s6_addr;
        cp[0] = RESOLVED_TYPE_IPV6;
        cp[1] = 16;
        memcpy(cp+2, bytes, 16);
        set_uint32(cp+18, htonl(ttl));
        cp += 22;
      }
      if (cp != buf) {
        buflen = cp - buf;
        break;
      } else {
        answer_type = RESOLVED_TYPE_ERROR;
        /* fall through. */
643
      }
644
645
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
646
647
      {
        const char *errmsg = "Error resolving hostname";
648
        size_t msglen = strlen(errmsg);
649

650
        buf[0] = answer_type;
651
652
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
653
        set_uint32(buf+2+msglen, htonl(ttl));
654
655
656
        buflen = 6+msglen;
        break;
      }
657
658
    default:
      tor_assert(0);
659
      return;
660
    }
661
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
662

663
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
664
665
}

666
667
668
/** 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.
669
670
671
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
672
 * <b>conn</b>'s attached circuit.
673
674
 */
static void
675
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
676
677
678
679
680
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
681
  tor_assert(hostname);
682
683
684
685
686
687
688
689
690
691

  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;

692
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
693
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
694
  // log_notice(LD_EXIT, "Sent");
695
696
}

Roger Dingledine's avatar
Roger Dingledine committed
697
/** See if we have a cache entry for <b>exitconn</b>-\>address. If so,
Nick Mathewson's avatar
Nick Mathewson committed
698
 * if resolve valid, put it into <b>exitconn</b>-\>addr and return 1.
Roger Dingledine's avatar
Roger Dingledine committed
699
 * If resolve failed, free exitconn and return -1.
700
 *
701
702
703
704
705
 * (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.)
 *
706
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
707
 * circuit.
708
 *
709
710
711
712
713
 * 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.
714
715
716
717
718
719
 *
 * 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.
720
 */
721
int
722
dns_resolve(edge_connection_t *exitconn)
723
724
725
{
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
  int is_resolve, r;
726
  int made_connection_pending = 0;
727
  char *hostname = NULL;
728
  cached_resolve_t *resolve = NULL;
729
  is_resolve = exitconn->base_.purpose == EXIT_PURPOSE_RESOLVE;
730

731
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname,
732
                       &made_connection_pending, &resolve);
733

734
735
  switch (r) {
    case 1:
736
737
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
738
      if (is_resolve) {
739
        /* Send the answer back right now, and detach. */
740
741
742
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
743
          send_resolved_cell(exitconn, RESOLVED_TYPE_AUTO, resolve);
744
        exitconn->on_circuit = NULL;
745
      } else {
746
747
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
748
749
750
751
752
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
753
754
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
755
      exitconn->base_.state = EXIT_CONN_STATE_RESOLVING;
756
757
758
759
760
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
761
      /* The request failed before it could start: cancel this connection,
762
       * and stop everybody waiting for the same connection. */
763
764
      if (is_resolve) {
        send_resolved_cell(exitconn,
765
766
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT,
             NULL);
767
      }
768

769
      exitconn->on_circuit = NULL;
770

771
      dns_cancel_pending_resolve(exitconn->base_.address);
772

773
      if (!made_connection_pending && !exitconn->base_.marked_for_close) {
774
775
776
        /* If we made the connection pending, then we freed it already in
         * dns_cancel_pending_resolve().  If we marked it for close, it'll
         * get freed from the main loop.  Otherwise, can free it now. */
777
        connection_free(TO_CONN(exitconn));
778
      }
779
780
781
782
783
784
785
786
787
788
789
790
791
792
      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
793
794
795
 * 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.
796
797
798
799
 *
 * Set *<b>made_connection_pending_out</b> to true if we have placed
 * <b>exitconn</b> on the list of pending connections for some resolve; set it
 * to false otherwise.
800
801
 *
 * Set *<b>resolve_out</b> to a cached resolve, if we found one.
802
803
804
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
805
                 or_circuit_t *oncirc, char **hostname_out,
806
807
                 int *made_connection_pending_out,
                 cached_resolve_t **resolve_out)
808
{
809
810
811
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
812
  int is_reverse = 0;
813
  tor_addr_t addr;
814
  time_t now = time(NULL);
815
  int r;
816
  assert_connection_ok(TO_CONN(exitconn), 0);
817
  tor_assert(!SOCKET_OK(exitconn->base_.s));
818
  assert_cache_ok();
819
  tor_assert(oncirc);
820
  *made_connection_pending_out = 0;
821

822
  /* first check if exitconn->base_.address is an IP. If so, we already
823
   * know the answer. */
824
  if (tor_addr_parse(&addr, exitconn->base_.address) >= 0) {
825
826
    if (tor_addr_family(&addr) == AF_INET ||
        tor_addr_family(&addr) == AF_INET6) {
827
      tor_addr_copy(&exitconn->base_.addr, &addr);
828
829
830
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
831
      /* XXXX unspec? Bogus? */
832
833
      return -1;
    }
834
  }
835

836
  /* If we're a non-exit, don't even do DNS lookups. */
837
  if (router_my_exit_policy_is_reject_star())
838
    return -1;
839

840
  if (address_is_invalid_destination(exitconn->base_.address, 0)) {
841
    tor_log(LOG_PROTOCOL_WARN, LD_EXIT,
842
        "Rejecting invalid destination address %s",
843
        escaped_safe_str(exitconn->base_.address));
844
845
    return -1;
  }
846
847

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

851
852
  /* lower-case exitconn->base_.address, so it's in canonical form */
  tor_strlower(exitconn->base_.address);
853

854
855
  /* 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
856
   * connection.
857
   */
858
  if ((r = tor_addr_parse_PTR_name(&addr, exitconn->base_.address,
859
                                              AF_UNSPEC, 0)) != 0) {
860
    if (r == 1) {
861
      is_reverse = 1;
862
863
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
864
    }
865
866
867
868

    if (!is_reverse || !is_resolve) {
      if (!is_reverse)
        log_info(LD_EXIT, "Bad .in-addr.arpa address \"%s\"; sending error.",
869
                 escaped_safe_str(exitconn->base_.address));
870
871
872
873
      else if (!is_resolve)
        log_info(LD_EXIT,
                 "Attempt to connect to a .in-addr.arpa address \"%s\"; "
                 "sending error.",
874
                 escaped_safe_str(exitconn->base_.address));
875
876
877

      return -1;
    }
878
    //log_notice(LD_EXIT, "Looks like an address %s",
879
    //exitconn->base_.address);
880
  }
881
  exitconn->is_reverse_dns_lookup = is_reverse;
882

883
  /* now check the hash table to see if 'address' is already there. */
884
  strlcpy(search.address, exitconn->base_.address, sizeof(search.address));
885
  resolve = HT_FIND(cache_map, &cache_root, &search);
886
  if (resolve && resolve->expire > now) { /* already there */
887
    switch (resolve->state) {
888
889
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
890
        pending_connection = tor_malloc_zero(
891
                                      sizeof(pending_connection_t));
892
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
893
894
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
895
        *made_connection_pending_out = 1;
896
897
        log_debug(LD_EXIT,"Connection (fd "TOR_SOCKET_T_FORMAT") waiting "
                  "for pending DNS resolve of %s", exitconn->base_