nodelist.c 25.1 KB
Newer Older
1
2
3
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2012, The Tor Project, Inc. */
5
6
7
/* See LICENSE for licensing information */

#include "or.h"
8
9
#include "config.h"
#include "dirserv.h"
10
11
#include "microdesc.h"
#include "networkstatus.h"
12
#include "nodelist.h"
13
#include "policies.h"
14
#include "router.h"
15
16
17
18
#include "routerlist.h"

#include <string.h>

19
static void nodelist_drop_node(node_t *node, int remove_from_ht);
20
21
22
23
24
25
26
27
28
29
30
static void node_free(node_t *node);

/** A nodelist_t holds a node_t object for every router we're "willing to use
 * for something".  Specifically, it should hold a node_t for every node that
 * is currently in the routerlist, or currently in the consensus we're using.
 */
typedef struct nodelist_t {
  /* A list of all the nodes. */
  smartlist_t *nodes;
  /* Hash table to map from node ID digest to node. */
  HT_HEAD(nodelist_map, node_t) nodes_by_id;
31

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
} nodelist_t;

static INLINE unsigned int
node_id_hash(const node_t *node)
{
#if SIZEOF_INT == 4
  const uint32_t *p = (const uint32_t*)node->identity;
  return p[0] ^ p[1] ^ p[2] ^ p[3] ^ p[4];
#elif SIZEOF_INT == 8
  const uint64_t *p = (const uint32_t*)node->identity;
  const uint32_t *p32 = (const uint32_t*)node->identity;
  return p[0] ^ p[1] ^ p32[4];
#endif
}

static INLINE unsigned int
node_id_eq(const node_t *node1, const node_t *node2)
{
50
  return tor_memeq(node1->identity, node2->identity, DIGEST_LEN);
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
}

HT_PROTOTYPE(nodelist_map, node_t, ht_ent, node_id_hash, node_id_eq);
HT_GENERATE(nodelist_map, node_t, ht_ent, node_id_hash, node_id_eq,
            0.6, malloc, realloc, free);

/** The global nodelist. */
static nodelist_t *the_nodelist=NULL;

/** Create an empty nodelist if we haven't done so already. */
static void
init_nodelist(void)
{
  if (PREDICT_UNLIKELY(the_nodelist == NULL)) {
    the_nodelist = tor_malloc_zero(sizeof(nodelist_t));
    HT_INIT(nodelist_map, &the_nodelist->nodes_by_id);
67
    the_nodelist->nodes = smartlist_new();
68
69
70
  }
}

71
/** As node_get_by_id, but returns a non-const pointer */
72
node_t *
73
node_get_mutable_by_id(const char *identity_digest)
74
75
76
77
78
79
80
81
82
83
{
  node_t search, *node;
  if (PREDICT_UNLIKELY(the_nodelist == NULL))
    return NULL;

  memcpy(&search.identity, identity_digest, DIGEST_LEN);
  node = HT_FIND(nodelist_map, &the_nodelist->nodes_by_id, &search);
  return node;
}

84
85
86
87
88
89
90
91
/** Return the node_t whose identity is <b>identity_digest</b>, or NULL
 * if no such node exists. */
const node_t *
node_get_by_id(const char *identity_digest)
{
  return node_get_mutable_by_id(identity_digest);
}

92
93
94
95
96
97
98
99
100
101
102
/** Internal: return the node_t whose identity_digest is
 * <b>identity_digest</b>.  If none exists, create a new one, add it to the
 * nodelist, and return it.
 *
 * Requires that the nodelist be initialized.
 */
static node_t *
node_get_or_create(const char *identity_digest)
{
  node_t *node;

103
  if ((node = node_get_mutable_by_id(identity_digest)))
104
105
106
107
108
109
110
111
112
    return node;

  node = tor_malloc_zero(sizeof(node_t));
  memcpy(node->identity, identity_digest, DIGEST_LEN);
  HT_INSERT(nodelist_map, &the_nodelist->nodes_by_id, node);

  smartlist_add(the_nodelist->nodes, node);
  node->nodelist_idx = smartlist_len(the_nodelist->nodes) - 1;

113
114
  node->country = -1;

115
116
117
  return node;
}

118
119
120
/** Called when a node's address changes. */
static void
node_addrs_changed(node_t *node)
121
{
122
123
124
  node->last_reachable = node->last_reachable6 = 0;
  node->testing_since = node->testing_since6 = 0;
  node->country = -1;
125
126
}

127
128
129
130
/** Add <b>ri</b> to an appropriate node in the nodelist.  If we replace an
 * old routerinfo, and <b>ri_old_out</b> is not NULL, set *<b>ri_old_out</b>
 * to the previous routerinfo.
 */
131
node_t *
132
nodelist_set_routerinfo(routerinfo_t *ri, routerinfo_t **ri_old_out)
133
{
134
135
136
137
  node_t *node;
  const char *id_digest;
  int had_router = 0;
  tor_assert(ri);
138

139
140
141
142
143
144
145
146
147
148
149
  init_nodelist();
  id_digest = ri->cache_info.identity_digest;
  node = node_get_or_create(id_digest);

  if (node->ri) {
    if (!routers_have_same_or_addrs(node->ri, ri)) {
      node_addrs_changed(node);
    }
    had_router = 1;
    if (ri_old_out)
      *ri_old_out = node->ri;
150
  } else {
151
152
    if (ri_old_out)
      *ri_old_out = NULL;
153
  }
154
  node->ri = ri;
155
156
157
158

  if (node->country == -1)
    node_set_country(node);

159
  if (authdir_mode(get_options()) && !had_router) {
160
161
162
163
164
    const char *discard=NULL;
    uint32_t status = dirserv_router_get_status(ri, &discard);
    dirserv_set_node_flags_from_authoritative_status(node, status);
  }

165
166
167
168
169
170
171
172
173
174
175
176
177
  return node;
}

/** Set the appropriate node_t to use <b>md</b> as its microdescriptor.
 *
 * Called when a new microdesc has arrived and the usable consensus flavor
 * is "microdesc".
 **/
node_t *
nodelist_add_microdesc(microdesc_t *md)
{
  networkstatus_t *ns =
    networkstatus_get_latest_consensus_by_flavor(FLAV_MICRODESC);
178
  const routerstatus_t *rs;
179
180
181
182
183
184
185
186
187
188
  node_t *node;
  if (ns == NULL)
    return NULL;
  init_nodelist();

  /* Microdescriptors don't carry an identity digest, so we need to figure
   * it out by looking up the routerstatus. */
  rs = router_get_consensus_status_by_descriptor_digest(ns, md->digest);
  if (rs == NULL)
    return NULL;
189
  node = node_get_mutable_by_id(rs->identity_digest);
190
191
  if (node) {
    if (node->md)
192
      node->md->held_by_nodes--;
193
    node->md = md;
194
    md->held_by_nodes++;
195
  }
196
197
198
  return node;
}

Linus Nordberg's avatar
Linus Nordberg committed
199
/** Tell the nodelist that the current usable consensus is <b>ns</b>.
200
201
202
203
204
205
206
 * This makes the nodelist change all of the routerstatus entries for
 * the nodes, drop nodes that no longer have enough info to get used,
 * and grab microdescriptors into nodes as appropriate.
 */
void
nodelist_set_consensus(networkstatus_t *ns)
{
207
  const or_options_t *options = get_options();
208
  int authdir = authdir_mode_v2(options) || authdir_mode_v3(options);
209

210
  init_nodelist();
211
212
  if (ns->flavor == FLAV_MICRODESC)
    (void) get_microdesc_cache(); /* Make sure it exists first. */
213
214
215
216
217
218
219
220
221

  SMARTLIST_FOREACH(the_nodelist->nodes, node_t *, node,
                    node->rs = NULL);

  SMARTLIST_FOREACH_BEGIN(ns->routerstatus_list, routerstatus_t *, rs) {
    node_t *node = node_get_or_create(rs->identity_digest);
    node->rs = rs;
    if (ns->flavor == FLAV_MICRODESC) {
      if (node->md == NULL ||
222
          tor_memneq(node->md->digest,rs->descriptor_digest,DIGEST256_LEN)) {
223
        if (node->md)
224
          node->md->held_by_nodes--;
225
226
        node->md = microdesc_cache_lookup_by_digest256(NULL,
                                                       rs->descriptor_digest);
227
        if (node->md)
228
          node->md->held_by_nodes++;
229
230
      }
    }
231
232
233
234
235
236

    node_set_country(node);

    /* If we're not an authdir, believe others. */
    if (!authdir) {
      node->is_valid = rs->is_valid;
237
      node->is_running = rs->is_flagged_running;
238
239
240
241
242
243
244
      node->is_fast = rs->is_fast;
      node->is_stable = rs->is_stable;
      node->is_possible_guard = rs->is_possible_guard;
      node->is_exit = rs->is_exit;
      node->is_bad_directory = rs->is_bad_directory;
      node->is_bad_exit = rs->is_bad_exit;
      node->is_hs_dir = rs->is_hs_dir;
245
246
      if (options->ClientPreferIPv6ORPort == 1)
        node->ipv6_preferred = !tor_addr_is_null(&rs->ipv6_addr);
247
248
    }

249
  } SMARTLIST_FOREACH_END(rs);
250

251
  nodelist_purge();
252
253
254
255
256
257
258
259
260
261
262
263
264

  if (! authdir) {
    SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
      /* We have no routerstatus for this router. Clear flags so we can skip
       * it, maybe.*/
      if (!node->rs) {
        tor_assert(node->ri); /* if it had only an md, or nothing, purge
                               * would have removed it. */
        if (node->ri->purpose == ROUTER_PURPOSE_GENERAL) {
          /* Clear all flags. */
          node->is_valid = node->is_running = node->is_hs_dir =
            node->is_fast = node->is_stable =
            node->is_possible_guard = node->is_exit =
265
266
            node->is_bad_exit = node->is_bad_directory =
            node->ipv6_preferred = 0;
267
268
269
270
        }
      }
    } SMARTLIST_FOREACH_END(node);
  }
271
272
273
274
275
276
277
278
279
280
281
282
283
284
}

/** Helper: return true iff a node has a usable amount of information*/
static INLINE int
node_is_usable(const node_t *node)
{
  return (node->rs) || (node->ri);
}

/** Tell the nodelist that <b>md</b> is no longer a microdescriptor for the
 * node with <b>identity_digest</b>. */
void
nodelist_remove_microdesc(const char *identity_digest, microdesc_t *md)
{
285
  node_t *node = node_get_mutable_by_id(identity_digest);
286
  if (node && node->md == md) {
287
    node->md = NULL;
288
    md->held_by_nodes--;
289
  }
290
291
292
293
294
295
}

/** Tell the nodelist that <b>ri</b> is no longer in the routerlist. */
void
nodelist_remove_routerinfo(routerinfo_t *ri)
{
296
  node_t *node = node_get_mutable_by_id(ri->cache_info.identity_digest);
297
298
299
  if (node && node->ri == ri) {
    node->ri = NULL;
    if (! node_is_usable(node)) {
300
      nodelist_drop_node(node, 1);
301
302
303
304
305
306
307
308
      node_free(node);
    }
  }
}

/** Remove <b>node</b> from the nodelist.  (Asserts that it was there to begin
 * with.) */
static void
309
nodelist_drop_node(node_t *node, int remove_from_ht)
310
311
312
{
  node_t *tmp;
  int idx;
313
314
315
316
  if (remove_from_ht) {
    tmp = HT_REMOVE(nodelist_map, &the_nodelist->nodes_by_id, node);
    tor_assert(tmp == node);
  }
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

  idx = node->nodelist_idx;
  tor_assert(idx >= 0);

  tor_assert(node == smartlist_get(the_nodelist->nodes, idx));
  smartlist_del(the_nodelist->nodes, idx);
  if (idx < smartlist_len(the_nodelist->nodes)) {
    tmp = smartlist_get(the_nodelist->nodes, idx);
    tmp->nodelist_idx = idx;
  }
  node->nodelist_idx = -1;
}

/** Release storage held by <b>node</b>  */
static void
node_free(node_t *node)
{
  if (!node)
    return;
336
  if (node->md)
337
    node->md->held_by_nodes--;
338
339
340
341
342
343
344
345
346
347
348
349
350
  tor_assert(node->nodelist_idx == -1);
  tor_free(node);
}

/** Remove all entries from the nodelist that don't have enough info to be
 * usable for anything. */
void
nodelist_purge(void)
{
  node_t **iter;
  if (PREDICT_UNLIKELY(the_nodelist == NULL))
    return;

351
  /* Remove the non-usable nodes. */
352
353
354
  for (iter = HT_START(nodelist_map, &the_nodelist->nodes_by_id); iter; ) {
    node_t *node = *iter;

355
356
    if (node->md && !node->rs) {
      /* An md is only useful if there is an rs. */
357
      node->md->held_by_nodes--;
358
359
360
      node->md = NULL;
    }

361
362
363
364
    if (node_is_usable(node)) {
      iter = HT_NEXT(nodelist_map, &the_nodelist->nodes_by_id, iter);
    } else {
      iter = HT_NEXT_RMV(nodelist_map, &the_nodelist->nodes_by_id, iter);
365
      nodelist_drop_node(node, 0);
366
367
368
      node_free(node);
    }
  }
369
  nodelist_assert_ok();
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
}

/** Release all storage held by the nodelist. */
void
nodelist_free_all(void)
{
  if (PREDICT_UNLIKELY(the_nodelist == NULL))
    return;

  HT_CLEAR(nodelist_map, &the_nodelist->nodes_by_id);
  SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
    node->nodelist_idx = -1;
    node_free(node);
  } SMARTLIST_FOREACH_END(node);

  smartlist_free(the_nodelist->nodes);

  tor_free(the_nodelist);
}

/** Check that the nodelist is internally consistent, and consistent with
 * the directory info it's derived from.
 */
void
nodelist_assert_ok(void)
{
  routerlist_t *rl = router_get_routerlist();
  networkstatus_t *ns = networkstatus_get_latest_consensus();
398
  digestmap_t *dm;
399
400
401
402

  if (!the_nodelist)
    return;

403
404
  dm = digestmap_new();

405
406
407
  /* every routerinfo in rl->routers should be in the nodelist. */
  if (rl) {
    SMARTLIST_FOREACH_BEGIN(rl->routers, routerinfo_t *, ri) {
408
      const node_t *node = node_get_by_id(ri->cache_info.identity_digest);
409
      tor_assert(node && node->ri == ri);
410
      tor_assert(fast_memeq(ri->cache_info.identity_digest,
411
412
                             node->identity, DIGEST_LEN));
      tor_assert(! digestmap_get(dm, node->identity));
413
      digestmap_set(dm, node->identity, (void*)node);
414
415
416
417
418
419
    } SMARTLIST_FOREACH_END(ri);
  }

  /* every routerstatus in ns should be in the nodelist */
  if (ns) {
    SMARTLIST_FOREACH_BEGIN(ns->routerstatus_list, routerstatus_t *, rs) {
420
      const node_t *node = node_get_by_id(rs->identity_digest);
421
      tor_assert(node && node->rs == rs);
422
      tor_assert(fast_memeq(rs->identity_digest, node->identity, DIGEST_LEN));
423
      digestmap_set(dm, node->identity, (void*)node);
424
      if (ns->flavor == FLAV_MICRODESC) {
425
426
        /* If it's a microdesc consensus, every entry that has a
         * microdescriptor should be in the nodelist.
427
428
429
430
         */
        microdesc_t *md =
          microdesc_cache_lookup_by_digest256(NULL, rs->descriptor_digest);
        tor_assert(md == node->md);
431
        if (md)
432
          tor_assert(md->held_by_nodes >= 1);
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
      }
    } SMARTLIST_FOREACH_END(rs);
  }

  /* The nodelist should have no other entries, and its entries should be
   * well-formed. */
  SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
    tor_assert(digestmap_get(dm, node->identity) != NULL);
    tor_assert(node_sl_idx == node->nodelist_idx);
  } SMARTLIST_FOREACH_END(node);

  tor_assert((long)smartlist_len(the_nodelist->nodes) ==
             (long)HT_SIZE(&the_nodelist->nodes_by_id));

  digestmap_free(dm, NULL);
}

450
451
452
453
454
455
456
457
458
459
/** Return a list of a node_t * for every node we know about.  The caller
 * MUST NOT modify the list. (You can set and clear flags in the nodes if
 * you must, but you must not add or remove nodes.) */
smartlist_t *
nodelist_get_list(void)
{
  init_nodelist();
  return the_nodelist->nodes;
}

Nick Mathewson's avatar
Nick Mathewson committed
460
461
462
463
/** Given a hex-encoded nickname of the format DIGEST, $DIGEST, $DIGEST=name,
 * or $DIGEST~name, return the node with the matching identity digest and
 * nickname (if any).  Return NULL if no such node exists, or if <b>hex_id</b>
 * is not well-formed. */
464
const node_t *
Nick Mathewson's avatar
Nick Mathewson committed
465
node_get_by_hex_id(const char *hex_id)
466
467
468
469
470
{
  char digest_buf[DIGEST_LEN];
  char nn_buf[MAX_NICKNAME_LEN+1];
  char nn_char='\0';

Nick Mathewson's avatar
Nick Mathewson committed
471
  if (hex_digest_nickname_decode(hex_id, digest_buf, &nn_char, nn_buf)==0) {
472
473
474
475
476
477
478
479
480
481
    const node_t *node = node_get_by_id(digest_buf);
    if (!node)
      return NULL;
    if (nn_char) {
      const char *real_name = node_get_nickname(node);
      if (!real_name || strcasecmp(real_name, nn_buf))
        return NULL;
      if (nn_char == '=') {
        const char *named_id =
          networkstatus_get_router_digest_by_nickname(nn_buf);
482
        if (!named_id || tor_memneq(named_id, digest_buf, DIGEST_LEN))
483
484
485
486
487
488
          return NULL;
      }
    }
    return node;
  }

Nick Mathewson's avatar
Nick Mathewson committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
  return NULL;
}

/** Given a nickname (possibly verbose, possibly a hexadecimal digest), return
 * the corresponding node_t, or NULL if none exists.  Warn the user if
 * <b>warn_if_unnamed</b> is set, and they have specified a router by
 * nickname, but the Named flag isn't set for that router. */
const node_t *
node_get_by_nickname(const char *nickname, int warn_if_unnamed)
{
  const node_t *node;
  if (!the_nodelist)
    return NULL;

  /* Handle these cases: DIGEST, $DIGEST, $DIGEST=name, $DIGEST~name. */
  if ((node = node_get_by_hex_id(nickname)) != NULL)
      return node;

507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  if (!strcasecmp(nickname, UNNAMED_ROUTER_NICKNAME))
    return NULL;

  /* Okay, so if we get here, the nickname is just a nickname.  Is there
   * a binding for it in the consensus? */
  {
    const char *named_id =
      networkstatus_get_router_digest_by_nickname(nickname);
    if (named_id)
      return node_get_by_id(named_id);
  }

  /* Is it marked as owned-by-someone-else? */
  if (networkstatus_nickname_is_unnamed(nickname)) {
    log_info(LD_GENERAL, "The name %s is listed as Unnamed: there is some "
             "router that holds it, but not one listed in the current "
             "consensus.", escaped(nickname));
    return NULL;
  }

  /* Okay, so the name is not canonical for anybody. */
  {
529
    smartlist_t *matches = smartlist_new();
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
    const node_t *choice = NULL;

    SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
      if (!strcasecmp(node_get_nickname(node), nickname))
        smartlist_add(matches, node);
    } SMARTLIST_FOREACH_END(node);

    if (smartlist_len(matches)>1 && warn_if_unnamed) {
      int any_unwarned = 0;
      SMARTLIST_FOREACH_BEGIN(matches, node_t *, node) {
        if (!node->name_lookup_warned) {
          node->name_lookup_warned = 1;
          any_unwarned = 1;
        }
      } SMARTLIST_FOREACH_END(node);

      if (any_unwarned) {
        log_warn(LD_CONFIG, "There are multiple matches for the name %s, "
                 "but none is listed as Named in the directory consensus. "
                 "Choosing one arbitrarily.", nickname);
      }
    } else if (smartlist_len(matches)>1 && warn_if_unnamed) {
      char fp[HEX_DIGEST_LEN+1];
      node_t *node = smartlist_get(matches, 0);
      if (node->name_lookup_warned) {
        base16_encode(fp, sizeof(fp), node->identity, DIGEST_LEN);
        log_warn(LD_CONFIG,
                 "You specified a server \"%s\" by name, but the directory "
                 "authorities do not have any key registered for this "
                 "nickname -- so it could be used by any server, not just "
                 "the one you meant. "
                 "To make sure you get the same server in the future, refer "
                 "to it by key, as \"$%s\".", nickname, fp);
        node->name_lookup_warned = 1;
      }
    }

    if (smartlist_len(matches))
      choice = smartlist_get(matches, 0);

    smartlist_free(matches);
    return choice;
  }
}

/** Return the nickname of <b>node</b>, or NULL if we can't find one. */
const char *
node_get_nickname(const node_t *node)
{
579
  tor_assert(node);
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
  if (node->rs)
    return node->rs->nickname;
  else if (node->ri)
    return node->ri->nickname;
  else
    return NULL;
}

/** Return true iff the nickname of <b>node</b> is canonical, based on the
 * latest consensus. */
int
node_is_named(const node_t *node)
{
  const char *named_id;
  const char *nickname = node_get_nickname(node);
  if (!nickname)
    return 0;
  named_id = networkstatus_get_router_digest_by_nickname(nickname);
  if (!named_id)
    return 0;
600
  return tor_memeq(named_id, node->identity, DIGEST_LEN);
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
}

/** Return true iff <b>node</b> appears to be a directory authority or
 * directory cache */
int
node_is_dir(const node_t *node)
{
  if (node->rs)
    return node->rs->dir_port != 0;
  else if (node->ri)
    return node->ri->dir_port != 0;
  else
    return 0;
}

/** Return true iff <b>node</b> has either kind of usable descriptor -- that
 * is, a routerdecriptor or a microdescriptor. */
int
node_has_descriptor(const node_t *node)
{
  return (node->ri ||
          (node->rs && node->md));
}

/** Return the router_purpose of <b>node</b>. */
int
node_get_purpose(const node_t *node)
{
  if (node->ri)
    return node->ri->purpose;
  else
    return ROUTER_PURPOSE_GENERAL;
}

/** Compute the verbose ("extended") nickname of <b>node</b> and store it
 * into the MAX_VERBOSE_NICKNAME_LEN+1 character buffer at
 * <b>verbose_nickname_out</b> */
void
node_get_verbose_nickname(const node_t *node,
                          char *verbose_name_out)
{
  const char *nickname = node_get_nickname(node);
  int is_named = node_is_named(node);
  verbose_name_out[0] = '$';
  base16_encode(verbose_name_out+1, HEX_DIGEST_LEN+1, node->identity,
                DIGEST_LEN);
  if (!nickname)
    return;
  verbose_name_out[1+HEX_DIGEST_LEN] = is_named ? '=' : '~';
  strlcpy(verbose_name_out+1+HEX_DIGEST_LEN+1, nickname, MAX_NICKNAME_LEN+1);
}

/** Return true iff it seems that <b>node</b> allows circuits to exit
 * through it directlry from the client. */
int
node_allows_single_hop_exits(const node_t *node)
{
658
659
660
661
  if (node && node->ri)
    return node->ri->allow_single_hop_exits;
  else
    return 0;
662
663
}

664
665
/** Return true iff it seems that <b>node</b> has an exit policy that doesn't
 * actually permit anything to exit, or we don't know its exit policy */
666
667
668
int
node_exit_policy_rejects_all(const node_t *node)
{
669
670
671
  if (node->rejects_all)
    return 1;

672
673
674
675
676
677
678
  if (node->ri)
    return node->ri->policy_is_reject_star;
  else if (node->md)
    return node->md->exit_policy == NULL ||
      short_policy_is_reject_star(node->md->exit_policy);
  else
    return 1;
679
680
}

681
682
683
684
685
686
687
688
689
690
691
/** Return list of tor_addr_port_t with all OR ports (in the sense IP
 * addr + TCP port) for <b>node</b>.  Caller must free all elements
 * using tor_free() and free the list using smartlist_free().
 *
 * XXX this is potentially a memory fragmentation hog -- if on
 * critical path consider the option of having the caller allocate the
 * memory
 */
smartlist_t *
node_get_all_orports(const node_t *node)
{
692
  smartlist_t *sl = smartlist_new();
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716

  if (node->ri != NULL) {
    if (node->ri->addr != 0) {
      tor_addr_port_t *ap = tor_malloc(sizeof(tor_addr_port_t));
      tor_addr_from_ipv4h(&ap->addr, node->ri->addr);
      ap->port = node->ri->or_port;
      smartlist_add(sl, ap);
    }
    if (!tor_addr_is_null(&node->ri->ipv6_addr)) {
      tor_addr_port_t *ap = tor_malloc(sizeof(tor_addr_port_t));
      tor_addr_copy(&ap->addr, &node->ri->ipv6_addr);
      ap->port = node->ri->or_port;
      smartlist_add(sl, ap);
    }
  } else if (node->rs != NULL) {
      tor_addr_port_t *ap = tor_malloc(sizeof(tor_addr_port_t));
      tor_addr_from_ipv4h(&ap->addr, node->rs->addr);
      ap->port = node->rs->or_port;
      smartlist_add(sl, ap);
  }

  return sl;
}

717
718
719
720
721
722
723
724
725
726
/** Wrapper around node_get_prim_orport for backward
    compatibility.  */
void
node_get_addr(const node_t *node, tor_addr_t *addr_out)
{
  tor_addr_port_t ap;
  node_get_prim_orport(node, &ap);
  tor_addr_copy(addr_out, &ap.addr);
}

727
728
729
/** Return the host-order IPv4 address for <b>node</b>, or 0 if it doesn't
 * seem to have one.  */
uint32_t
730
node_get_prim_addr_ipv4h(const node_t *node)
731
732
733
734
735
736
737
738
739
{
  if (node->ri) {
    return node->ri->addr;
  } else if (node->rs) {
    return node->rs->addr;
  }
  return 0;
}

740
741
/** Copy a string representation of an IP address for <b>node</b> into
 * the <b>len</b>-byte buffer at <b>buf</b>.  */
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
void
node_get_address_string(const node_t *node, char *buf, size_t len)
{
  if (node->ri) {
    strlcpy(buf, node->ri->address, len);
  } else if (node->rs) {
    tor_addr_t addr;
    tor_addr_from_ipv4h(&addr, node->rs->addr);
    tor_addr_to_str(buf, &addr, len, 0);
  } else {
    buf[0] = '\0';
  }
}

/** Return <b>node</b>'s declared uptime, or -1 if it doesn't seem to have
 * one. */
long
node_get_declared_uptime(const node_t *node)
{
761
762
763
764
  if (node->ri)
    return node->ri->uptime;
  else
    return -1;
765
766
}

767
/** Return <b>node</b>'s platform string, or NULL if we don't know it. */
768
769
770
const char *
node_get_platform(const node_t *node)
{
771
772
773
774
775
776
777
  /* If we wanted, we could record the version in the routerstatus_t, since
   * the consensus lists it.  We don't, though, so this function just won't
   * work with microdescriptors. */
  if (node->ri)
    return node->ri->platform;
  else
    return NULL;
778
779
}

780
/** Return <b>node</b>'s time of publication, or 0 if we don't have one. */
781
782
783
time_t
node_get_published_on(const node_t *node)
{
784
785
786
787
  if (node->ri)
    return node->ri->cache_info.published_on;
  else
    return 0;
788
789
790
791
792
793
794
795
796
}

/** Return true iff <b>node</b> is one representing this router. */
int
node_is_me(const node_t *node)
{
  return router_digest_is_me(node->identity);
}

797
798
799
800
801
802
803
804
805
806
807
808
/** Return <b>node</b> declared family (as a list of names), or NULL if
 * the node didn't declare a family. */
const smartlist_t *
node_get_declared_family(const node_t *node)
{
  if (node->ri && node->ri->declared_family)
    return node->ri->declared_family;
  else if (node->md && node->md->family)
    return node->md->family;
  else
    return NULL;
}
Sebastian Hahn's avatar
Sebastian Hahn committed
809

810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
/** Return 1 if we prefer the IPv6 address and OR TCP port of
 * <b>node</b>, else 0.
 *
 *  We prefer the IPv6 address if the router has an IPv6 address and
 *  i) the node_t says that we do prefer IPv6
 *  or
 *  ii) the router has no IPv4 address.  */
int
node_ipv6_preferred(const node_t *node)
{
  node_assert_ok(node);
  if (node->ri)
    return (!tor_addr_is_null(&node->ri->ipv6_addr)
            && (node->ipv6_preferred || node->ri->addr == 0));
  if (node->rs)
    return (!tor_addr_is_null(&node->rs->ipv6_addr)
            && (node->ipv6_preferred || node->rs->addr == 0));
  return 0;
}

/** Copy the primary (IPv4) OR port (IP address and TCP port) for
 * <b>node</b> into *<b>ap_out</b>. */
void
node_get_prim_orport(const node_t *node, tor_addr_port_t *ap_out)
{
  node_assert_ok(node);
  tor_assert(ap_out);

  if (node->ri) {
    tor_addr_from_ipv4h(&ap_out->addr, node->ri->addr);
    ap_out->port = node->ri->or_port;
  } else if (node->rs) {
    tor_addr_from_ipv4h(&ap_out->addr, node->rs->addr);
    ap_out->port = node->rs->or_port;
  }
}

/** Copy the preferred OR port (IP address and TCP port) for
 * <b>node</b> into *<b>ap_out</b>.  */
void
node_get_pref_orport(const node_t *node, tor_addr_port_t *ap_out)
{
  tor_assert(ap_out);

854
855
856
857
858
859
860
  /* Cheap implementation of config option ClientUseIPv6 -- simply
     don't prefer IPv6 when ClientUseIPv6 is not set. (See #4455 for
     more on this subject.) Note that this filter is too strict since
     we're hindering not only clients! Erring on the safe side
     shouldn't be a problem though. XXX move this check to where
     outgoing connections are made? -LN */
  if (get_options()->ClientUseIPv6 == 1 && node_ipv6_preferred(node))
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
    node_get_pref_ipv6_orport(node, ap_out);
  else
    node_get_prim_orport(node, ap_out);
}

/** Copy the preferred IPv6 OR port (IP address and TCP port) for
 * <b>node</b> into *<b>ap_out</b>. */
void
node_get_pref_ipv6_orport(const node_t *node, tor_addr_port_t *ap_out)
{
  node_assert_ok(node);
  tor_assert(ap_out);

  if (node->ri) {
    tor_addr_copy(&ap_out->addr, &node->ri->ipv6_addr);
    ap_out->port = node->ri->ipv6_orport;
  } else if (node->rs) {
    tor_addr_copy(&ap_out->addr, &node->rs->ipv6_addr);
    ap_out->port = node->rs->ipv6_orport;
  }
}
Nick Mathewson's avatar
Nick Mathewson committed
882