dns.c 62.6 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
164
                             uint32_t addr,
                             const char *hostname, char outcome,
165
                             uint32_t ttl);
166
167
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int launch_resolve(edge_connection_t *exitconn);
168
static void add_wildcarded_test_address(const char *address);
169
static int configure_nameservers(int force);
170
static int answer_is_wildcarded(const char *ip);
171
static int dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
172
173
                            or_circuit_t *oncirc, char **resolved_to_hostname,
                            int *made_connection_pending_out);
174
#ifdef DEBUG_DNS_CACHE
175
176
static void assert_cache_ok_(void);
#define assert_cache_ok() assert_cache_ok_()
177
#else
178
#define assert_cache_ok() STMT_NIL
179
#endif
180
static void assert_resolve_ok(cached_resolve_t *resolve);
181

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

494
495
496
497
/* 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

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

513
514
515
516
517
518
519
520
521
522
  if (answer_type == RESOLVED_TYPE_AUTO) {
    sa_family_t family = tor_addr_family(&conn->base_.addr);
    if (family == AF_INET)
      answer_type = RESOLVED_TYPE_IPV4;
    else if (family == AF_INET6)
      answer_type = RESOLVED_TYPE_IPV6;
    else
      answer_type = RESOLVED_TYPE_ERROR_TRANSIENT;
  }

523
  buf[0] = answer_type;
524
  ttl = dns_clip_ttl(conn->address_ttl);
525
526
527
528
529

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
530
      set_uint32(buf+2, tor_addr_to_ipv4n(&conn->base_.addr));
531
      set_uint32(buf+6, htonl(ttl));
532
      buflen = 10;
533
      break;
534
535
536
537
538
539
540
541
542
    case RESOLVED_TYPE_IPV6:
      {
        const uint8_t *bytes = tor_addr_to_in6_addr8(&conn->base_.addr);
        buf[1] = 16;
        memcpy(buf+2, bytes, 16);
        set_uint32(buf+18, htonl(ttl));
        buflen = 22;
      }
      break;
543
544
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
545
546
      {
        const char *errmsg = "Error resolving hostname";
547
        size_t msglen = strlen(errmsg);
548

549
550
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
551
        set_uint32(buf+2+msglen, htonl(ttl));
552
553
554
        buflen = 6+msglen;
        break;
      }
555
556
    default:
      tor_assert(0);
557
      return;
558
    }
559
  // log_notice(LD_EXIT, "Sending a regular RESOLVED reply: ");
Roger Dingledine's avatar
Roger Dingledine committed
560

561
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
562
563
}

564
565
566
/** 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.
567
568
569
 *
 * If <b>circ</b> is provided, and we have a cached answer, send the
 * answer back along circ; otherwise, send the answer back along
570
 * <b>conn</b>'s attached circuit.
571
572
 */
static void
573
send_resolved_hostname_cell(edge_connection_t *conn, const char *hostname)
574
575
576
577
578
{
  char buf[RELAY_PAYLOAD_SIZE];
  size_t buflen;
  uint32_t ttl;
  size_t namelen = strlen(hostname);
579
  tor_assert(hostname);
580
581
582
583
584
585
586
587
588
589

  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;

590
  // log_notice(LD_EXIT, "Sending a reply RESOLVED reply: %s", hostname);
591
  connection_edge_send_command(conn, RELAY_COMMAND_RESOLVED, buf, buflen);
592
  // log_notice(LD_EXIT, "Sent");
593
594
}

Roger Dingledine's avatar
Roger Dingledine committed
595
/** See if we have a cache entry for <b>exitconn</b>-\>address. If so,
Nick Mathewson's avatar
Nick Mathewson committed
596
 * if resolve valid, put it into <b>exitconn</b>-\>addr and return 1.
Roger Dingledine's avatar
Roger Dingledine committed
597
 * If resolve failed, free exitconn and return -1.
598
 *
599
600
601
602
603
 * (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.)
 *
604
 * If we have a cached answer, send the answer back along <b>exitconn</b>'s
605
 * circuit.
606
 *
607
608
609
610
611
 * 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.
612
613
614
615
616
617
 *
 * 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.
618
 */
619
int
620
dns_resolve(edge_connection_t *exitconn)
621
622
623
{
  or_circuit_t *oncirc = TO_OR_CIRCUIT(exitconn->on_circuit);
  int is_resolve, r;
624
  int made_connection_pending = 0;
625
  char *hostname = NULL;
626
  is_resolve = exitconn->base_.purpose == EXIT_PURPOSE_RESOLVE;
627

628
629
  r = dns_resolve_impl(exitconn, is_resolve, oncirc, &hostname,
                       &made_connection_pending);
630

631
632
  switch (r) {
    case 1:
633
634
      /* We got an answer without a lookup -- either the answer was
       * cached, or it was obvious (like an IP address). */
635
      if (is_resolve) {
636
        /* Send the answer back right now, and detach. */
637
638
639
        if (hostname)
          send_resolved_hostname_cell(exitconn, hostname);
        else
640
          send_resolved_cell(exitconn, RESOLVED_TYPE_AUTO);
641
        exitconn->on_circuit = NULL;
642
      } else {
643
644
        /* Add to the n_streams list; the calling function will send back a
         * connected cell. */
645
646
647
648
649
        exitconn->next_stream = oncirc->n_streams;
        oncirc->n_streams = exitconn;
      }
      break;
    case 0:
650
651
      /* The request is pending: add the connection into the linked list of
       * resolving_streams on this circuit. */
652
      exitconn->base_.state = EXIT_CONN_STATE_RESOLVING;
653
654
655
656
657
      exitconn->next_stream = oncirc->resolving_streams;
      oncirc->resolving_streams = exitconn;
      break;
    case -2:
    case -1:
658
      /* The request failed before it could start: cancel this connection,
659
       * and stop everybody waiting for the same connection. */
660
661
662
663
      if (is_resolve) {
        send_resolved_cell(exitconn,
             (r == -1) ? RESOLVED_TYPE_ERROR : RESOLVED_TYPE_ERROR_TRANSIENT);
      }
664

665
      exitconn->on_circuit = NULL;
666

667
      dns_cancel_pending_resolve(exitconn->base_.address);
668

669
      if (!made_connection_pending && !exitconn->base_.marked_for_close) {
670
671
672
        /* 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. */
673
        connection_free(TO_CONN(exitconn));
674
      }
675
676
677
678
679
680
681
682
683
684
685
686
687
688
      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
689
690
691
 * 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.
692
693
694
695
 *
 * 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.
696
697
698
 */
static int
dns_resolve_impl(edge_connection_t *exitconn, int is_resolve,
699
700
                 or_circuit_t *oncirc, char **hostname_out,
                 int *made_connection_pending_out)
701
{
702
703
704
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
705
  const routerinfo_t *me;
706
  tor_addr_t addr;
707
  time_t now = time(NULL);
708
709
  uint8_t is_reverse = 0;
  int r;
710
  assert_connection_ok(TO_CONN(exitconn), 0);
711
  tor_assert(!SOCKET_OK(exitconn->base_.s));
712
  assert_cache_ok();
713
  tor_assert(oncirc);
714
  *made_connection_pending_out = 0;
715

716
  /* first check if exitconn->base_.address is an IP. If so, we already
717
   * know the answer. */
718
  if (tor_addr_parse(&addr, exitconn->base_.address) >= 0) {
719
720
    if (tor_addr_family(&addr) == AF_INET ||
        tor_addr_family(&addr) == AF_INET6) {
721
      tor_addr_copy(&exitconn->base_.addr, &addr);
722
723
724
      exitconn->address_ttl = DEFAULT_DNS_TTL;
      return 1;
    } else {
725
      /* XXXX unspec? Bogus? */
726
727
      return -1;
    }
728
  }
729

730
731
732
733
734
  /* 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;
  }
735
  if (address_is_invalid_destination(exitconn->base_.address, 0)) {
736
737
    log(LOG_PROTOCOL_WARN, LD_EXIT,
        "Rejecting invalid destination address %s",
738
        escaped_safe_str(exitconn->base_.address));
739
740
    return -1;
  }
741
742

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

746
747
  /* lower-case exitconn->base_.address, so it's in canonical form */
  tor_strlower(exitconn->base_.address);
748

749
750
  /* 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
751
   * connection.
752
   */
753
  if ((r = tor_addr_parse_PTR_name(&addr, exitconn->base_.address,
754
                                              AF_UNSPEC, 0)) != 0) {
755
    if (r == 1) {
756
      is_reverse = 1;
757
758
      if (tor_addr_is_internal(&addr, 0)) /* internal address? */
        return -1;
759
    }
760
761
762
763

    if (!is_reverse || !is_resolve) {
      if (!is_reverse)
        log_info(LD_EXIT, "Bad .in-addr.arpa address \"%s\"; sending error.",
764
                 escaped_safe_str(exitconn->base_.address));
765
766
767
768
      else if (!is_resolve)
        log_info(LD_EXIT,
                 "Attempt to connect to a .in-addr.arpa address \"%s\"; "
                 "sending error.",
769
                 escaped_safe_str(exitconn->base_.address));
770
771
772

      return -1;
    }
773
    //log_notice(LD_EXIT, "Looks like an address %s",
774
    //exitconn->base_.address);
775
776
  }

777
  /* now check the hash table to see if 'address' is already there. */
778
  strlcpy(search.address, exitconn->base_.address, sizeof(search.address));
779
  resolve = HT_FIND(cache_map, &cache_root, &search);
780
  if (resolve && resolve->expire > now) { /* already there */
781
    switch (resolve->state) {
782
783
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
784
        pending_connection = tor_malloc_zero(
785
                                      sizeof(pending_connection_t));
786
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
787
788
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
789
        *made_connection_pending_out = 1;
790
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
791
792
                  "resolve of %s", exitconn->base_.s,
                  escaped_safe_str(exitconn->base_.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
793
        return 0;
794
      case CACHE_STATE_CACHED_VALID:
795
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
796
                  exitconn->base_.s,
797
798
799
800
                  escaped_safe_str(resolve->address));
        exitconn->address_ttl = resolve->ttl;
        if (resolve->is_reverse) {
          tor_assert(is_resolve);
801
          *hostname_out = tor_strdup(resolve->result.hostname);
802
        } else {
803
          tor_addr_from_ipv4h(&exitconn->base_.addr, resolve->result.a.addr);
804
        }
805
        return 1;
806
      case CACHE_STATE_CACHED_FAILED:
807
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
808
809
                  exitconn->base_.s,
                  escaped_safe_str(exitconn->base_.address));
810
        return -1;
811
812
813
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
814
    }
Roger Dingledine's avatar
Roger Dingledine committed
815
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
816
  }
817
  tor_assert(!resolve);
Roger Dingledine's avatar
Roger Dingledine committed
818
  /* not there, need to add it */
819
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
820
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
821
  resolve->state = CACHE_STATE_PENDING;
822
  resolve->minheap_idx = -1;
823
  resolve->is_reverse = is_reverse;
824
  strlcpy(resolve->address, exitconn->base_.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
825

826
  /* add this connection to the pending list */
827
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
828
829
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
830
  *made_connection_pending_out = 1;
Roger Dingledine's avatar
Roger Dingledine committed
831

832
  /* Add this resolve to the cache and priority queue. */
833
  HT_INSERT(cache_map, &cache_root, resolve);
834
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
835

836
  log_debug(LD_EXIT,"Launching %s.",
837
            escaped_safe_str(exitconn->base_.address));
838
  assert_cache_ok();
839

840
  return launch_resolve(exitconn);
841
842
}

843
/** Log an error and abort if conn is waiting for a DNS resolve.
844
 */
845
void
846
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
847
{
848
  pending_connection_t *pend;
849
  cached_resolve_t search;
850

851
852
#if 1
  cached_resolve_t *resolve;
853
  strlcpy(search.address, conn->base_.address, sizeof(search.address));
854
855
856
857
858
859
860
861
  resolve = HT_FIND(cache_map, &cache_root, &search);
  if (!resolve)
    return;
  for (pend = resolve->pending_connections; pend; pend = pend->next) {