dns.c 62 KB
Newer Older
1
2
/* Copyright (c) 2003-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
3
 * Copyright (c) 2007-2012, 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
#ifdef HAVE_EVENT2_DNS_H
28
#include <event2/event.h>
29
30
#include <event2/dns.h>
#else
31
#include <event.h>
32
#include "eventdns.h"
33
34
35
36
#ifndef HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#define HAVE_EVDNS_SET_DEFAULT_OUTGOING_BIND_ADDRESS
#endif
#endif
37

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

#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

78
79
#endif

Roger Dingledine's avatar
Roger Dingledine committed
80
/** Longest hostname we're willing to resolve. */
81
82
#define MAX_ADDRESSLEN 256

83
84
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
85
86
#define RESOLVE_MAX_TIMEOUT 300

Roger Dingledine's avatar
Roger Dingledine committed
87
/** Possible outcomes from hostname lookup: permanent failure,
88
 * transient (retryable) failure, and success. */
89
90
91
92
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

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

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

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

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

117
118
119
120
121
122
123
/* 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. */
124
#define CACHE_STATE_PENDING 0
125
126
127
/** 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. */
128
#define CACHE_STATE_DONE 1
129
130
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
131
#define CACHE_STATE_CACHED_VALID 2
132
133
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
134
135
#define CACHE_STATE_CACHED_FAILED 3

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

161
static void purge_expired_resolves(time_t now);
162
static void dns_found_answer(const char *address, uint8_t is_reverse,
163
                             uint32_t addr, const char *hostname, char outcome,
164
                             uint32_t ttl);
165
166
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
167
static void add_wildcarded_test_address(const char *address);
168
static int configure_nameservers(int force);
169
static int answer_is_wildcarded(const char *ip);
170
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
171
172
                            or_circuit_t *oncirc, char **resolved_to_hostname,
                            int *made_connection_pending_out);
173
#ifdef DEBUG_DNS_CACHE
174
175
static void assert_cache_ok_(void);
#define assert_cache_ok() assert_cache_ok_()
176
#else
177
#define assert_cache_ok() STMT_NIL
178
#endif
179
static void assert_resolve_ok(cached_resolve_t *resolve);
180

181
182
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
183

Roger Dingledine's avatar
Roger Dingledine committed
184
/** Function to compare hashed resolves on their addresses; used to
185
 * implement hash tables. */
186
187
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
188
{
189
  /* make this smarter one day? */
190
  assert_resolve_ok(a); // Not b; b may be just a search.
191
192
193
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

194
/** Hash function for cached_resolve objects */
195
196
197
198
static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
199
200
}

201
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
202
             cached_resolves_eq)
203
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
204
            cached_resolves_eq, 0.6, malloc, realloc, free)
205

206
/** Initialize the DNS cache. */
207
static void
208
init_cache_map(void)
209
{
210
  HT_INIT(cache_map, &cache_root);
211
212
}

213
/** Helper: called by eventdns when eventdns wants to log something. */
214
static void
215
evdns_log_cb(int warn, const char *msg)
216
{
217
  const char *cp;
218
219
  static int all_down = 0;
  int severity = warn ? LOG_WARN : LOG_INFO;
220
221
222
223
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
224
225
  } else if (!strcmpstart(msg, "Search: ")) {
    return;
226
  }
227
228
  if (!strcmpstart(msg, "Nameserver ") && (cp=strstr(msg, " has failed: "))) {
    char *ns = tor_strndup(msg+11, cp-(msg+11));
229
    const char *err = strchr(cp, ':')+2;
230
    tor_assert(err);
231
232
233
    /* 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. */
234
    severity = LOG_INFO;
235
    control_event_server_status(LOG_NOTICE,
236
237
238
239
240
241
                                "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));
242
    severity = (all_down && warn) ? LOG_NOTICE : LOG_INFO;
243
    all_down = 0;
244
245
246
247
248
    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");
249
    all_down = 1;
250
  }
251
  log(severity, LD_EXIT, "eventdns: %s", msg);
252
253
}

254
255
/** Helper: passed to eventdns.c as a callback so it can generate random
 * numbers for transaction IDs and 0x20-hack coding. */
256
static void
257
dns_randfn_(char *b, size_t n)
258
{
259
  crypto_rand(b,n);
260
261
}

Roger Dingledine's avatar
Roger Dingledine committed
262
/** Initialize the DNS subsystem; called by the OR process. */
263
int
264
265
dns_init(void)
{
266
  init_cache_map();
267
  evdns_set_random_bytes_fn(dns_randfn_);
268
269
270
271
  if (server_mode(get_options())) {
    int r = configure_nameservers(1);
    return r;
  }
272
  return 0;
273
}
274

275
276
277
/** Called when DNS-related options change (or may have changed).  Returns -1
 * on failure, 0 on success. */
int
278
279
dns_reset(void)
{
280
  const or_options_t *options = get_options();
281
  if (! server_mode(options)) {
282
283
284
285
286
287
288
289

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

290
291
    evdns_base_clear_nameservers_and_suspend(the_evdns_base);
    evdns_base_search_clear(the_evdns_base);
292
293
294
295
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
296
    if (configure_nameservers(0) < 0) {
297
      return -1;
298
    }
299
  }
300
  return 0;
301
302
}

Nick Mathewson's avatar
Nick Mathewson committed
303
304
/** Return true iff the most recent attempt to initialize the DNS subsystem
 * failed. */
305
306
307
308
309
310
int
has_dns_init_failed(void)
{
  return nameserver_config_failed;
}

311
312
/** Helper: Given a TTL from a DNS response, determine what TTL to give the
 * OP that asked us to resolve it. */
313
314
315
316
317
318
319
320
321
322
323
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;
}

324
325
/** Helper: Given a TTL from a DNS response, determine how long to hold it in
 * our cache. */
326
327
328
329
330
331
332
333
334
335
336
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;
}

337
/** Helper: free storage held by an entry in the DNS cache. */
338
static void
339
free_cached_resolve_(cached_resolve_t *r)
340
{
341
342
  if (!r)
    return;
Nick Mathewson's avatar
Nick Mathewson committed
343
  while (r->pending_connections) {
344
    pending_connection_t *victim = r->pending_connections;
345
346
347
    r->pending_connections = victim->next;
    tor_free(victim);
  }
348
349
  if (r->is_reverse)
    tor_free(r->result.hostname);
350
  r->magic = 0xFF00FF00;
351
352
353
  tor_free(r);
}

354
355
356
/** 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. */
357
static int
358
compare_cached_resolves_by_expiry_(const void *_a, const void *_b)
359
{
360
  const cached_resolve_t *a = _a, *b = _b;
361
362
363
364
365
366
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
367
368
}

369
370
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
371
372
static smartlist_t *cached_resolve_pqueue = NULL;

373
374
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
375
376
377
378
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
379
  if (!cached_resolve_pqueue)
380
    cached_resolve_pqueue = smartlist_new();
381
382
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
383
                       compare_cached_resolves_by_expiry_,
384
                       STRUCT_OFFSET(cached_resolve_t, minheap_idx),
385
386
387
                       resolve);
}

388
/** Free all storage held in the DNS cache and related structures. */
389
390
391
void
dns_free_all(void)
{
392
  cached_resolve_t **ptr, **next, *item;
393
  assert_cache_ok();
394
395
396
  if (cached_resolve_pqueue) {
    SMARTLIST_FOREACH(cached_resolve_pqueue, cached_resolve_t *, res,
      {
397
        if (res->state == CACHE_STATE_DONE)
398
          free_cached_resolve_(res);
399
400
      });
  }
401
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
402
    item = *ptr;
403
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
404
    free_cached_resolve_(item);
405
  }
406
  HT_CLEAR(cache_map, &cache_root);
407
  smartlist_free(cached_resolve_pqueue);
408
  cached_resolve_pqueue = NULL;
409
  tor_free(resolv_conf_fname);
410
411
}

412
413
/** Remove every cached_resolve whose <b>expire</b> time is before or
 * equal to <b>now</b> from the cache. */
414
static void
415
purge_expired_resolves(time_t now)
416
{
Nick Mathewson's avatar
Nick Mathewson committed
417
  cached_resolve_t *resolve, *removed;
418
  pending_connection_t *pend;
419
  edge_connection_t *pendconn;
420

Nick Mathewson's avatar
Nick Mathewson committed
421
  assert_cache_ok();
422
423
424
425
426
427
428
429
  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,
430
                         compare_cached_resolves_by_expiry_,
431
                         STRUCT_OFFSET(cached_resolve_t, minheap_idx));
432

433
    if (resolve->state == CACHE_STATE_PENDING) {
434
      log_debug(LD_EXIT,
435
436
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
437
438
439
440
441
442
443
444
445
446
447
                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);
448
    }
449

450
    if (resolve->pending_connections) {
451
      log_debug(LD_EXIT,
452
                "Closing pending connections on timed-out DNS resolve!");
453
454
455
456
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
457
        tor_assert(!SOCKET_OK(pend->conn->base_.s));
458
        pendconn = pend->conn;
459
        if (!pendconn->base_.marked_for_close) {
460
461
462
463
          connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT);
          circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
          connection_free(TO_CONN(pendconn));
        }
464
465
        tor_free(pend);
      }
466
    }
467

468
469
470
471
472
473
474
    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).",
475
                resolve->address, (void*)resolve,
476
                removed ? removed->address : "NULL", (void*)removed);
477
478
479
      }
      tor_assert(removed == resolve);
    } else {
480
      /* This should be in state DONE. Make sure it's not in the cache. */
481
482
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
483
    }
484
485
486
487
    if (resolve->is_reverse)
      tor_free(resolve->result.hostname);
    resolve->magic = 0xF0BBF0BB;
    tor_free(resolve);
488
  }
489

Nick Mathewson's avatar
Nick Mathewson committed
490
  assert_cache_ok();
491
492
}

493
494
495
/** Send a response to the RESOLVE request of a connection.
 * <b>answer_type</b> must be one of
 * RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT).
496
497
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
498
499
 * answer back along circ; otherwise, send the answer back along
 * <b>conn</b>'s attached circuit.
500
 */
501
static void
502
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
503
504
{
  char buf[RELAY_PAYLOAD_SIZE];
505
  size_t buflen;
506
  uint32_t ttl;
507
508

  buf[0] = answer_type;
509
  ttl = dns_clip_ttl(conn->address_ttl);
510
511
512
513
514

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
515
      set_uint32(buf+2, tor_addr_to_ipv4n(&conn->base_.addr));
516
      set_uint32(buf+6, htonl(ttl));
517
      buflen = 10;
518
      break;
519
    /*XXXX IP6 need ipv6 implementation */
520
521
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
522
523
      {
        const char *errmsg = "Error resolving hostname";
524
        size_t msglen = strlen(errmsg);
525

526
527
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
528
        set_uint32(buf+2+msglen, htonl(ttl));
529
530
531
        buflen = 6+msglen;
        break;
      }
532
533
    default:
      tor_assert(0);
534
      return;
535
    }
536
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
537

538
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
539
540
}

541
542
543
/** 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.
544
545
546
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
547
 * <b>conn</b>'s attached circuit.
548
549
 */
static void
550
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
551
552
553
554
555
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
556
  tor_assert(hostname);
557
558
559
560
561
562
563
564
565
566

  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;

567
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
568
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
569
  // log_notice(LD_EXIT, "Sent");
570
571
}

Roger Dingledine's avatar
Roger Dingledine committed
572
/** See if we have a cache entry for <b>exitconn</b>-\>address. If so,
Nick Mathewson's avatar
Nick Mathewson committed
573
 * if resolve valid, put it into <b>exitconn</b>-\>addr and return 1.
Roger Dingledine's avatar
Roger Dingledine committed
574
 * If resolve failed, free exitconn and return -1.
575
 *
576
577
578
579
580
 * (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.)
 *
581
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
582
 * circuit.
583
 *
584
585
586
587
588
 * 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.
589
590
591
592
593
594
 *
 * 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.
595
 */
596
int
597
dns_resolve(edge_connection_t *exitconn)
598
599
600
{
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
  int is_resolve, r;
601
  int made_connection_pending = 0;
602
  char *hostname = NULL;
603
  is_resolve = exitconn->base_.purpose == EXIT_PURPOSE_RESOLVE;
604

605
606
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname,
                       &made_connection_pending);
607

608
609
  switch (r) {
    case 1:
610
611
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
612
      if (is_resolve) {
613
        /* Send the answer back right now, and detach. */
614
615
616
617
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
618
        exitconn->on_circuit = NULL;
619
      } else {
620
621
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
622
623
624
625
626
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
627
628
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
629
      exitconn->base_.state = EXIT_CONN_STATE_RESOLVING;
630
631
632
633
634
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
635
      /* The request failed before it could start: cancel this connection,
636
       * and stop everybody waiting for the same connection. */
637
638
639
640
      if (is_resolve) {
        send_resolved_cell(exitconn,
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT);
      }
641

642
      exitconn->on_circuit = NULL;
643

644
      dns_cancel_pending_resolve(exitconn->base_.address);
645

646
      if (!made_connection_pending && !exitconn->base_.marked_for_close) {
647
648
649
        /* 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. */
650
        connection_free(TO_CONN(exitconn));
651
      }
652
653
654
655
656
657
658
659
660
661
662
663
664
665
      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
666
667
668
 * 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.
669
670
671
672
 *
 * 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.
673
674
675
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
676
677
                 or_circuit_t *oncirc, char **hostname_out,
                 int *made_connection_pending_out)
678
{
679
680
681
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
682
  const routerinfo_t *me;
683
  tor_addr_t addr;
684
  time_t now = time(NULL);
685
686
  uint8_t is_reverse = 0;
  int r;
687
  assert_connection_ok(TO_CONN(exitconn), 0);
688
  tor_assert(!SOCKET_OK(exitconn->base_.s));
689
  assert_cache_ok();
690
  tor_assert(oncirc);
691
  *made_connection_pending_out = 0;
692

693
  /* first check if exitconn->base_.address is an IP. If so, we already
694
   * know the answer. */
695
  if (tor_addr_parse(&addr, exitconn->base_.address) >= 0) {
696
    if (tor_addr_family(&addr) == AF_INET) {
697
      tor_addr_copy(&exitconn->base_.addr, &addr);
698
699
700
701
702
703
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
      /* XXXX IPv6 */
      return -1;
    }
704
  }
705

706
707
708
709
710
  /* 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;
  }
711
  if (address_is_invalid_destination(exitconn->base_.address, 0)) {
712
713
    log(LOG_PROTOCOL_WARN, LD_EXIT,
        "Rejecting invalid destination address %s",
714
        escaped_safe_str(exitconn->base_.address));
715
716
    return -1;
  }
717
718

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

722
723
  /* lower-case exitconn->base_.address, so it's in canonical form */
  tor_strlower(exitconn->base_.address);
724

725
726
  /* 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
727
   * connection.
728
   */
729
  if ((r = tor_addr_parse_PTR_name(&addr, exitconn->base_.address,
730
                                              AF_UNSPEC, 0)) != 0) {
731
    if (r == 1) {
732
      is_reverse = 1;
733
734
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
735
    }
736
737
738
739

    if (!is_reverse || !is_resolve) {
      if (!is_reverse)
        log_info(LD_EXIT, "Bad .in-addr.arpa address \"%s\"; sending error.",
740
                 escaped_safe_str(exitconn->base_.address));
741
742
743
744
      else if (!is_resolve)
        log_info(LD_EXIT,
                 "Attempt to connect to a .in-addr.arpa address \"%s\"; "
                 "sending error.",
745
                 escaped_safe_str(exitconn->base_.address));
746
747
748

      return -1;
    }
749
    //log_notice(LD_EXIT, "Looks like an address %s",
750
    //exitconn->base_.address);
751
752
  }

753
  /* now check the hash table to see if 'address' is already there. */
754
  strlcpy(search.address, exitconn->base_.address, sizeof(search.address));
755
  resolve = HT_FIND(cache_map, &cache_root, &search);
756
  if (resolve && resolve->expire > now) { /* already there */
757
    switch (resolve->state) {
758
759
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
760
        pending_connection = tor_malloc_zero(
761
                                      sizeof(pending_connection_t));
762
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
763
764
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
765
        *made_connection_pending_out = 1;
766
767
        log_debug(LD_EXIT,"Connection (fd "TOR_SOCKET_T_FORMAT") waiting "
                  "for pending DNS resolve of %s", exitconn->base_.s,
768
                  escaped_safe_str(exitconn->base_.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
769
        return 0;
770
      case CACHE_STATE_CACHED_VALID:
771
772
        log_debug(LD_EXIT,"Connection (fd "TOR_SOCKET_T_FORMAT") found "
                  "cached answer for %s",
773
                  exitconn->base_.s,
774
775
776
777
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
778
          *hostname_out = tor_strdup(resolve->result.hostname);
779
        } else {
780
          tor_addr_from_ipv4h(&exitconn->base_.addr, resolve->result.a.addr);
781
        }
782
        return 1;
783
      case CACHE_STATE_CACHED_FAILED:
784
785
        log_debug(LD_EXIT,"Connection (fd "TOR_SOCKET_T_FORMAT") found cached "
                  "error for %s",
786
787
                  exitconn->base_.s,
                  escaped_safe_str(exitconn->base_.address));
788
        return -1;
789
790
791
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
792
    }
Roger Dingledine's avatar
Roger Dingledine committed
793
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
794
  }
795
  tor_assert(!resolve);
Roger Dingledine's avatar
Roger Dingledine committed
796
  /* not there, need to add it */
797
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
798
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
799
  resolve->state = CACHE_STATE_PENDING;
800
  resolve->minheap_idx = -1;
801
  resolve->is_reverse = is_reverse;
802
  strlcpy(resolve->address, exitconn->base_.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
803

804
  /* add this connection to the pending list */
805
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
806
807
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
808
  *made_connection_pending_out = 1;
Roger Dingledine's avatar
Roger Dingledine committed
809

810
  /* Add this resolve to the cache and priority queue. */
811
  HT_INSERT(cache_map, &cache_root, resolve);
812
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
813

814
  log_debug(LD_EXIT,"Launching %s.",
815
            escaped_safe_str(exitconn->base_.address));
816
  assert_cache_ok();
817

818
  return launch_resolve(exitconn);
819
820
}

821
/** Log an error and abort if conn is waiting for a DNS resolve.
822
 */
823
void
824
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
825
{
826
  pending_connection_t *pend;
827
  cached_resolve_t search;
828

829
830
#if 1
  cached_resolve_t *resolve;
831
  strlcpy(search.address, conn->base_.address, sizeof(search.address));
832
833
834
835
836
837
838
839
  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;
840
  HT_FOREACH(resolve, cache_map, &cache_root) {
841
    for (pend = (*resolve)->pending_connections; pend; pend = pend->next) {
842
843
      tor_assert(pend->conn != conn);
    }
844
  }
845
#endif
846
}
847

848
849
850
851
852
853
854
/** 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;