1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2007, Roger Dingledine, Nick Mathewson. */
4 /* See LICENSE for licensing information */
6 const char routerlist_c_id
[] =
12 * maintain and access the global list of routerinfos for known
18 /****************************************************************************/
20 /* static function prototypes */
21 static routerstatus_t
*router_pick_directory_server_impl(int requireother
,
24 int for_v2_directory
);
25 static routerstatus_t
*router_pick_trusteddirserver_impl(
26 authority_type_t type
, int requireother
,
27 int fascistfirewall
, int prefer_tunnel
);
28 static void mark_all_trusteddirservers_up(void);
29 static int router_nickname_matches(routerinfo_t
*router
, const char *nickname
);
30 static void routerstatus_list_update_from_networkstatus(time_t now
);
31 static void local_routerstatus_free(local_routerstatus_t
*rs
);
32 static void trusted_dir_server_free(trusted_dir_server_t
*ds
);
33 static void update_networkstatus_cache_downloads(time_t now
);
34 static void update_networkstatus_client_downloads(time_t now
);
35 static int signed_desc_digest_is_recognized(signed_descriptor_t
*desc
);
36 static void routerlist_assert_ok(routerlist_t
*rl
);
37 static int have_tried_downloading_all_statuses(int n_failures
);
38 static routerstatus_t
*networkstatus_find_entry(networkstatus_t
*ns
,
40 static local_routerstatus_t
*router_get_combined_status_by_nickname(
43 static void update_router_have_minimum_dir_info(void);
44 static void router_dir_info_changed(void);
46 /****************************************************************************/
48 /** Global list of a trusted_dir_server_t object for each trusted directory
50 static smartlist_t
*trusted_dir_servers
= NULL
;
52 /** Global list of all of the routers that we know about. */
53 static routerlist_t
*routerlist
= NULL
;
55 /** Global list of all of the current network_status documents that we know
56 * about. This list is kept sorted by published_on. */
57 static smartlist_t
*networkstatus_list
= NULL
;
59 /** Global list of local_routerstatus_t for each router, known or unknown.
60 * Kept sorted by digest. */
61 static smartlist_t
*routerstatus_list
= NULL
;
63 /** Map from lowercase nickname to digest of named server, if any. */
64 static strmap_t
*named_server_map
= NULL
;
66 /** True iff any member of networkstatus_list has changed since the last time
67 * we called routerstatus_list_update_from_networkstatus(). */
68 static int networkstatus_list_has_changed
= 0;
70 /** True iff any element of routerstatus_list has changed since the last
71 * time we called routers_update_all_from_networkstatus().*/
72 static int routerstatus_list_has_changed
= 0;
74 /** List of strings for nicknames we've already warned about and that are
75 * still unknown / unavailable. */
76 static smartlist_t
*warned_nicknames
= NULL
;
78 /** List of strings for nicknames or fingerprints we've already warned about
79 * and that are still conflicted. */
80 static smartlist_t
*warned_conflicts
= NULL
;
82 /** The last time we tried to download any routerdesc, or 0 for "never". We
83 * use this to rate-limit download attempts when the number of routerdescs to
85 static time_t last_routerdesc_download_attempted
= 0;
87 /** The last time we tried to download a networkstatus, or 0 for "never". We
88 * use this to rate-limit download attempts for directory caches (including
89 * mirrors). Clients don't use this now. */
90 static time_t last_networkstatus_download_attempted
= 0;
92 /** True iff we have logged a warning about this OR not being valid or
94 static int have_warned_about_invalid_status
= 0;
95 /** True iff we have logged a warning about this OR's version being older than
96 * listed by the authorities */
97 static int have_warned_about_old_version
= 0;
98 /** True iff we have logged a warning about this OR's version being newer than
99 * listed by the authorities */
100 static int have_warned_about_new_version
= 0;
102 /** Return the number of v2 directory authorities */
104 get_n_v2_authorities(void)
107 if (!trusted_dir_servers
)
109 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ds
,
110 if (ds
->is_v2_authority
)
115 /** Repopulate our list of network_status_t objects from the list cached on
116 * disk. Return 0 on success, -1 on failure. */
118 router_reload_networkstatus(void)
121 smartlist_t
*entries
;
124 tor_assert(get_options()->DataDirectory
);
125 if (!networkstatus_list
)
126 networkstatus_list
= smartlist_create();
128 tor_snprintf(filename
,sizeof(filename
),"%s/cached-status",
129 get_options()->DataDirectory
);
130 entries
= tor_listdir(filename
);
131 SMARTLIST_FOREACH(entries
, const char *, fn
, {
132 char buf
[DIGEST_LEN
];
133 if (strlen(fn
) != HEX_DIGEST_LEN
||
134 base16_decode(buf
, sizeof(buf
), fn
, strlen(fn
))) {
136 "Skipping cached-status file with unexpected name \"%s\"",fn
);
139 tor_snprintf(filename
,sizeof(filename
),"%s/cached-status/%s",
140 get_options()->DataDirectory
, fn
);
141 s
= read_file_to_str(filename
, 0, &st
);
143 if (router_set_networkstatus(s
, st
.st_mtime
, NS_FROM_CACHE
, NULL
)<0) {
144 log_warn(LD_FS
, "Couldn't load networkstatus from \"%s\"",filename
);
149 SMARTLIST_FOREACH(entries
, char *, fn
, tor_free(fn
));
150 smartlist_free(entries
);
151 networkstatus_list_clean(time(NULL
));
152 routers_update_all_from_networkstatus();
156 /* Router descriptor storage.
158 * Routerdescs are stored in a big file, named "cached-routers". As new
159 * routerdescs arrive, we append them to a journal file named
160 * "cached-routers.new".
162 * From time to time, we replace "cached-routers" with a new file containing
163 * only the live, non-superseded descriptors, and clear cached-routers.new.
165 * On startup, we read both files.
168 /** The size of the router log, in bytes. */
169 static size_t router_journal_len
= 0;
170 /** The size of the router store, in bytes. */
171 static size_t router_store_len
= 0;
172 /** Total bytes dropped since last rebuild. */
173 static size_t router_bytes_dropped
= 0;
175 /** Helper: return 1 iff the router log is so big we want to rebuild the
178 router_should_rebuild_store(void)
180 if (router_store_len
> (1<<16))
181 return (router_journal_len
> router_store_len
/ 2 ||
182 router_bytes_dropped
> router_store_len
/ 2);
184 return router_journal_len
> (1<<15);
187 /** Add the <b>len</b>-type router descriptor in <b>s</b> to the router
188 * journal; change its saved_location to SAVED_IN_JOURNAL and set its
189 * offset appropriately. */
191 router_append_to_journal(signed_descriptor_t
*desc
)
193 or_options_t
*options
= get_options();
194 size_t fname_len
= strlen(options
->DataDirectory
)+32;
195 char *fname
= tor_malloc(fname_len
);
196 const char *body
= signed_descriptor_get_body(desc
);
197 size_t len
= desc
->signed_descriptor_len
;
199 tor_snprintf(fname
, fname_len
, "%s/cached-routers.new",
200 options
->DataDirectory
);
202 tor_assert(len
== strlen(body
));
204 if (append_bytes_to_file(fname
, body
, len
, 1)) {
205 log_warn(LD_FS
, "Unable to store router descriptor");
209 desc
->saved_location
= SAVED_IN_JOURNAL
;
210 desc
->saved_offset
= router_journal_len
;
213 router_journal_len
+= len
;
217 /** Sorting helper: return <0, 0, or >0 depending on whether the
218 * signed_descriptor_t* in *<b>a</b> is older, the same age as, or newer than
219 * the signed_descriptor_t* in *<b>b</b>. */
221 _compare_old_routers_by_age(const void **_a
, const void **_b
)
223 const signed_descriptor_t
*r1
= *_a
, *r2
= *_b
;
224 return r1
->published_on
- r2
->published_on
;
227 /** Sorting helper: return <0, 0, or >0 depending on whether the
228 * routerinfo_t* in *<b>a</b> is older, the same age as, or newer than
229 * the routerinfo_t* in *<b>b</b>. */
231 _compare_routers_by_age(const void **_a
, const void **_b
)
233 const routerinfo_t
*r1
= *_a
, *r2
= *_b
;
234 return r1
->cache_info
.published_on
- r2
->cache_info
.published_on
;
237 /** If the journal is too long, or if <b>force</b> is true, then atomically
238 * replace the router store with the routers currently in our routerlist, and
239 * clear the journal. Return 0 on success, -1 on failure.
242 router_rebuild_store(int force
)
244 or_options_t
*options
;
246 smartlist_t
*chunk_list
= NULL
;
247 char *fname
= NULL
, *fname_tmp
= NULL
;
250 smartlist_t
*old_routers
, *routers
;
252 if (!force
&& !router_should_rebuild_store())
257 /* Don't save deadweight. */
258 routerlist_remove_old_routers();
260 log_info(LD_DIR
, "Rebuilding router descriptor cache");
262 options
= get_options();
263 fname_len
= strlen(options
->DataDirectory
)+32;
264 fname
= tor_malloc(fname_len
);
265 fname_tmp
= tor_malloc(fname_len
);
266 tor_snprintf(fname
, fname_len
, "%s/cached-routers", options
->DataDirectory
);
267 tor_snprintf(fname_tmp
, fname_len
, "%s/cached-routers.tmp",
268 options
->DataDirectory
);
270 chunk_list
= smartlist_create();
272 old_routers
= smartlist_create();
273 smartlist_add_all(old_routers
, routerlist
->old_routers
);
274 smartlist_sort(old_routers
, _compare_old_routers_by_age
);
275 routers
= smartlist_create();
276 smartlist_add_all(routers
, routerlist
->routers
);
277 smartlist_sort(routers
, _compare_routers_by_age
);
278 for (i
= 0; i
< 2; ++i
) {
279 /* We sort the routers by age to enhance locality on disk. */
280 smartlist_t
*lst
= (i
== 0) ? old_routers
: routers
;
281 /* Now, add the appropriate members to chunk_list */
282 SMARTLIST_FOREACH(lst
, void *, ptr
,
284 signed_descriptor_t
*sd
= (i
==0) ?
285 ((signed_descriptor_t
*)ptr
): &((routerinfo_t
*)ptr
)->cache_info
;
287 const char *body
= signed_descriptor_get_body(sd
);
289 log_warn(LD_BUG
, "Bug! No descriptor available for router.");
292 c
= tor_malloc(sizeof(sized_chunk_t
));
294 c
->len
= sd
->signed_descriptor_len
;
295 smartlist_add(chunk_list
, c
);
298 if (write_chunks_to_file(fname_tmp
, chunk_list
, 1)<0) {
299 log_warn(LD_FS
, "Error writing router store to disk.");
302 /* Our mmap is now invalid. */
303 if (routerlist
->mmap_descriptors
) {
304 tor_munmap_file(routerlist
->mmap_descriptors
);
306 if (replace_file(fname_tmp
, fname
)<0) {
307 log_warn(LD_FS
, "Error replacing old router store.");
311 routerlist
->mmap_descriptors
= tor_mmap_file(fname
);
312 if (! routerlist
->mmap_descriptors
)
313 log_warn(LD_FS
, "Unable to mmap new descriptor file at '%s'.",fname
);
316 for (i
= 0; i
< 2; ++i
) {
317 smartlist_t
*lst
= (i
== 0) ? old_routers
: routers
;
318 SMARTLIST_FOREACH(lst
, void *, ptr
,
320 signed_descriptor_t
*sd
= (i
==0) ?
321 ((signed_descriptor_t
*)ptr
): &((routerinfo_t
*)ptr
)->cache_info
;
323 sd
->saved_location
= SAVED_IN_CACHE
;
324 if (routerlist
->mmap_descriptors
) {
325 tor_free(sd
->signed_descriptor_body
); // sets it to null
326 sd
->saved_offset
= offset
;
328 offset
+= sd
->signed_descriptor_len
;
329 signed_descriptor_get_body(sd
);
333 tor_snprintf(fname
, fname_len
, "%s/cached-routers.new",
334 options
->DataDirectory
);
336 write_str_to_file(fname
, "", 1);
339 tor_assert(offset
>= 0);
340 router_store_len
= (size_t) offset
;
341 router_journal_len
= 0;
342 router_bytes_dropped
= 0;
344 smartlist_free(old_routers
);
345 smartlist_free(routers
);
347 SMARTLIST_FOREACH(chunk_list
, sized_chunk_t
*, c
, tor_free(c
));
348 smartlist_free(chunk_list
);
352 /** Load all cached router descriptors from the store. Return 0 on success and
356 router_reload_router_list(void)
358 or_options_t
*options
= get_options();
359 size_t fname_len
= strlen(options
->DataDirectory
)+32;
360 char *fname
= tor_malloc(fname_len
), *contents
= NULL
;
363 router_get_routerlist(); /* mallocs and inits it in place */
365 router_journal_len
= router_store_len
= 0;
367 tor_snprintf(fname
, fname_len
, "%s/cached-routers", options
->DataDirectory
);
369 if (routerlist
->mmap_descriptors
) /* get rid of it first */
370 tor_munmap_file(routerlist
->mmap_descriptors
);
372 routerlist
->mmap_descriptors
= tor_mmap_file(fname
);
373 if (routerlist
->mmap_descriptors
) {
374 router_store_len
= routerlist
->mmap_descriptors
->size
;
375 router_load_routers_from_string(routerlist
->mmap_descriptors
->data
,
376 routerlist
->mmap_descriptors
->size
,
377 SAVED_IN_CACHE
, NULL
);
380 tor_snprintf(fname
, fname_len
, "%s/cached-routers.new",
381 options
->DataDirectory
);
382 if (file_status(fname
) == FN_FILE
)
383 contents
= read_file_to_str(fname
, RFTS_BIN
|RFTS_IGNORE_MISSING
, NULL
);
385 router_load_routers_from_string(contents
, strlen(contents
),
386 SAVED_IN_JOURNAL
, NULL
);
392 if (router_journal_len
) {
393 /* Always clear the journal on startup.*/
394 router_rebuild_store(1);
396 /* Don't cache expired routers. (This is in an else because
397 * router_rebuild_store() also calls remove_old_routers().) */
398 routerlist_remove_old_routers();
404 /** Return a smartlist containing a list of trusted_dir_server_t * for all
405 * known trusted dirservers. Callers must not modify the list or its
409 router_get_trusted_dir_servers(void)
411 if (!trusted_dir_servers
)
412 trusted_dir_servers
= smartlist_create();
414 return trusted_dir_servers
;
417 /** Try to find a running dirserver. If there are no running dirservers
418 * in our routerlist and <b>retry_if_no_servers</b> is non-zero,
419 * set all the authoritative ones as running again, and pick one;
420 * if there are then no dirservers at all in our routerlist,
421 * reload the routerlist and try one last time. If for_runningrouters is
422 * true, then only pick a dirserver that can answer runningrouters queries
423 * (that is, a trusted dirserver, or one running 0.0.9rc5-cvs or later).
424 * Don't pick an authority if any non-authority is viable.
425 * Other args are as in router_pick_directory_server_impl().
428 router_pick_directory_server(int requireother
,
430 int for_v2_directory
,
431 int retry_if_no_servers
)
433 routerstatus_t
*choice
;
434 int prefer_tunnel
= get_options()->PreferTunneledDirConns
;
439 choice
= router_pick_directory_server_impl(requireother
, fascistfirewall
,
440 prefer_tunnel
, for_v2_directory
);
441 if (choice
|| !retry_if_no_servers
)
445 "No reachable router entries for dirservers. "
446 "Trying them all again.");
447 /* mark all authdirservers as up again */
448 mark_all_trusteddirservers_up();
450 choice
= router_pick_directory_server_impl(requireother
, fascistfirewall
,
451 prefer_tunnel
, for_v2_directory
);
455 log_info(LD_DIR
,"Still no %s router entries. Reloading and trying again.",
456 fascistfirewall
? "reachable" : "known");
457 if (router_reload_router_list()) {
460 /* give it one last try */
461 choice
= router_pick_directory_server_impl(requireother
, fascistfirewall
,
462 prefer_tunnel
, for_v2_directory
);
466 /** Return the trusted_dir_server_t for the directory authority whose identity
467 * key hashes to <b>digest</b>, or NULL if no such authority is known.
469 trusted_dir_server_t
*
470 router_get_trusteddirserver_by_digest(const char *digest
)
472 if (!trusted_dir_servers
)
475 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ds
,
477 if (!memcmp(ds
->digest
, digest
, DIGEST_LEN
))
484 /** Try to find a running trusted dirserver. If there are no running
485 * trusted dirservers and <b>retry_if_no_servers</b> is non-zero,
486 * set them all as running again, and try again.
487 * If <b>need_v1_authority</b> is set, return only trusted servers
488 * that are authorities for the V1 directory protocol.
489 * Other args are as in router_pick_trusteddirserver_impl().
492 router_pick_trusteddirserver(authority_type_t type
,
495 int retry_if_no_servers
)
497 routerstatus_t
*choice
;
498 int prefer_tunnel
= get_options()->PreferTunneledDirConns
;
500 choice
= router_pick_trusteddirserver_impl(type
, requireother
,
501 fascistfirewall
, prefer_tunnel
);
502 if (choice
|| !retry_if_no_servers
)
506 "No trusted dirservers are reachable. Trying them all again.");
507 mark_all_trusteddirservers_up();
508 return router_pick_trusteddirserver_impl(type
, requireother
,
509 fascistfirewall
, prefer_tunnel
);
512 /** How long do we avoid using a directory server after it's given us a 503? */
513 #define DIR_503_TIMEOUT (60*60)
515 /** Pick a random running valid directory server/mirror from our
516 * routerlist. Don't pick an authority if any non-authorities are viable.
517 * If <b>fascistfirewall</b>, make sure the router we pick is allowed
518 * by our firewall options.
519 * If <b>requireother</b>, it cannot be us. If <b>for_v2_directory</b>,
520 * choose a directory server new enough to support the v2 directory
522 * If <b>prefer_tunnel</b>, choose a directory server that is reachable
523 * and supports BEGIN_DIR cells, if possible.
524 * Try to avoid using servers that are overloaded (have returned 503
527 static routerstatus_t
*
528 router_pick_directory_server_impl(int requireother
, int fascistfirewall
,
529 int prefer_tunnel
, int for_v2_directory
)
531 routerstatus_t
*result
;
532 smartlist_t
*direct
, *tunnel
;
533 smartlist_t
*trusted_direct
, *trusted_tunnel
;
534 smartlist_t
*overloaded_direct
, *overloaded_tunnel
;
535 time_t now
= time(NULL
);
537 if (!routerstatus_list
)
540 direct
= smartlist_create();
541 tunnel
= smartlist_create();
542 trusted_direct
= smartlist_create();
543 trusted_tunnel
= smartlist_create();
544 overloaded_direct
= smartlist_create();
545 overloaded_tunnel
= smartlist_create();
547 /* Find all the running dirservers we know about. */
548 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, _local_status
,
550 routerstatus_t
*status
= &(_local_status
->status
);
552 int is_overloaded
= _local_status
->last_dir_503_at
+ DIR_503_TIMEOUT
> now
;
553 if (!status
->is_running
|| !status
->dir_port
|| !status
->is_valid
)
555 if (status
->is_bad_directory
)
557 if (requireother
&& router_digest_is_me(status
->identity_digest
))
559 is_trusted
= router_digest_is_trusted_dir(status
->identity_digest
);
560 if (for_v2_directory
&& !(status
->is_v2_dir
|| is_trusted
))
562 if (fascistfirewall
&&
564 status
->version_supports_begindir
&&
565 router_get_by_digest(status
->identity_digest
) &&
566 fascist_firewall_allows_address_or(status
->addr
, status
->or_port
))
567 smartlist_add(is_trusted
? trusted_tunnel
:
568 is_overloaded
? overloaded_tunnel
: tunnel
, status
);
569 else if (!fascistfirewall
|| (fascistfirewall
&&
570 fascist_firewall_allows_address_dir(status
->addr
,
572 smartlist_add(is_trusted
? trusted_direct
:
573 is_overloaded
? overloaded_direct
: direct
, status
);
576 if (smartlist_len(tunnel
)) {
577 result
= routerstatus_sl_choose_by_bandwidth(tunnel
);
578 } else if (smartlist_len(overloaded_tunnel
)) {
579 result
= routerstatus_sl_choose_by_bandwidth(overloaded_tunnel
);
580 } else if (smartlist_len(trusted_tunnel
)) {
581 /* FFFF We don't distinguish between trusteds and overloaded trusteds
582 * yet. Maybe one day we should. */
583 /* FFFF We also don't load balance over authorities yet. I think this
584 * is a feature, but it could easily be a bug. -RD */
585 result
= smartlist_choose(trusted_tunnel
);
586 } else if (smartlist_len(direct
)) {
587 result
= routerstatus_sl_choose_by_bandwidth(direct
);
588 } else if (smartlist_len(overloaded_direct
)) {
589 result
= routerstatus_sl_choose_by_bandwidth(overloaded_direct
);
591 result
= smartlist_choose(trusted_direct
);
593 smartlist_free(direct
);
594 smartlist_free(tunnel
);
595 smartlist_free(trusted_direct
);
596 smartlist_free(trusted_tunnel
);
597 smartlist_free(overloaded_direct
);
598 smartlist_free(overloaded_tunnel
);
602 /** Choose randomly from among the trusted dirservers that are up. If
603 * <b>fascistfirewall</b>, make sure the port we pick is allowed by our
604 * firewall options. If <b>requireother</b>, it cannot be us. If
605 * <b>need_v1_authority</b>, choose a trusted authority for the v1 directory
608 static routerstatus_t
*
609 router_pick_trusteddirserver_impl(authority_type_t type
,
610 int requireother
, int fascistfirewall
,
613 smartlist_t
*direct
, *tunnel
;
614 smartlist_t
*overloaded_direct
, *overloaded_tunnel
;
615 routerinfo_t
*me
= router_get_my_routerinfo();
616 routerstatus_t
*result
;
617 time_t now
= time(NULL
);
619 direct
= smartlist_create();
620 tunnel
= smartlist_create();
621 overloaded_direct
= smartlist_create();
622 overloaded_tunnel
= smartlist_create();
624 if (!trusted_dir_servers
)
627 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, d
,
630 d
->fake_status
.last_dir_503_at
+ DIR_503_TIMEOUT
> now
;
631 if (!d
->is_running
) continue;
632 if (type
== V1_AUTHORITY
&& !d
->is_v1_authority
)
634 if (type
== V2_AUTHORITY
&& !d
->is_v2_authority
)
636 if (type
== HIDSERV_AUTHORITY
&& !d
->is_hidserv_authority
)
638 if (requireother
&& me
&& router_digest_is_me(d
->digest
))
641 if (fascistfirewall
&&
644 router_get_by_digest(d
->digest
) &&
645 fascist_firewall_allows_address_or(d
->addr
, d
->or_port
))
646 smartlist_add(is_overloaded
? overloaded_tunnel
: tunnel
,
647 &d
->fake_status
.status
);
648 else if (!fascistfirewall
|| (fascistfirewall
&&
649 fascist_firewall_allows_address_dir(d
->addr
,
651 smartlist_add(is_overloaded
? overloaded_direct
: direct
,
652 &d
->fake_status
.status
);
655 if (smartlist_len(tunnel
)) {
656 result
= smartlist_choose(tunnel
);
657 } else if (smartlist_len(overloaded_tunnel
)) {
658 result
= smartlist_choose(overloaded_tunnel
);
659 } else if (smartlist_len(direct
)) {
660 result
= smartlist_choose(direct
);
662 result
= smartlist_choose(overloaded_direct
);
665 smartlist_free(direct
);
666 smartlist_free(tunnel
);
667 smartlist_free(overloaded_direct
);
668 smartlist_free(overloaded_tunnel
);
672 /** Go through and mark the authoritative dirservers as up. */
674 mark_all_trusteddirservers_up(void)
677 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
678 if (router_digest_is_trusted_dir(router
->cache_info
.identity_digest
) &&
679 router
->dir_port
> 0) {
680 router
->is_running
= 1;
683 if (trusted_dir_servers
) {
684 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, dir
,
686 local_routerstatus_t
*rs
;
688 dir
->n_networkstatus_failures
= 0;
689 dir
->fake_status
.last_dir_503_at
= 0;
690 rs
= router_get_combined_status_by_digest(dir
->digest
);
691 if (rs
&& !rs
->status
.is_running
) {
692 rs
->status
.is_running
= 1;
693 rs
->last_dir_503_at
= 0;
694 control_event_networkstatus_changed_single(rs
);
698 last_networkstatus_download_attempted
= 0;
699 router_dir_info_changed();
702 /** Reset all internal variables used to count failed downloads of network
705 router_reset_status_download_failures(void)
707 mark_all_trusteddirservers_up();
710 /** Look through the routerlist and identify routers that
711 * advertise the same /16 network address as <b>router</b>.
712 * Add each of them to <b>sl</b>.
715 routerlist_add_network_family(smartlist_t
*sl
, routerinfo_t
*router
)
717 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, r
,
720 (router
->addr
& 0xffff0000) == (r
->addr
& 0xffff0000))
721 smartlist_add(sl
, r
);
725 /** Add all the family of <b>router</b> to the smartlist <b>sl</b>.
726 * This is used to make sure we don't pick siblings in a single path.
729 routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
)
733 or_options_t
*options
= get_options();
735 /* First, add any routers with similar network addresses. */
736 if (options
->EnforceDistinctSubnets
)
737 routerlist_add_network_family(sl
, router
);
739 if (!router
->declared_family
)
742 /* Add every r such that router declares familyness with r, and r
743 * declares familyhood with router. */
744 SMARTLIST_FOREACH(router
->declared_family
, const char *, n
,
746 if (!(r
= router_get_by_nickname(n
, 0)))
748 if (!r
->declared_family
)
750 SMARTLIST_FOREACH(r
->declared_family
, const char *, n2
,
752 if (router_nickname_matches(router
, n2
))
753 smartlist_add(sl
, r
);
757 /* If the user declared any families locally, honor those too. */
758 for (cl
= get_options()->NodeFamilies
; cl
; cl
= cl
->next
) {
759 if (router_nickname_is_in_list(router
, cl
->value
)) {
760 add_nickname_list_to_smartlist(sl
, cl
->value
, 0);
765 /** Given a (possibly NULL) comma-and-whitespace separated list of nicknames,
766 * see which nicknames in <b>list</b> name routers in our routerlist, and add
767 * the routerinfos for those routers to <b>sl</b>. If <b>must_be_running</b>,
768 * only include routers that we think are running.
769 * Warn if any non-Named routers are specified by nickname.
772 add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
775 routerinfo_t
*router
;
776 smartlist_t
*nickname_list
;
777 int have_dir_info
= router_have_minimum_dir_info();
780 return; /* nothing to do */
783 nickname_list
= smartlist_create();
784 if (!warned_nicknames
)
785 warned_nicknames
= smartlist_create();
787 smartlist_split_string(nickname_list
, list
, ",",
788 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, 0);
790 SMARTLIST_FOREACH(nickname_list
, const char *, nick
, {
792 if (!is_legal_nickname_or_hexdigest(nick
)) {
793 log_warn(LD_CONFIG
, "Nickname '%s' is misformed; skipping", nick
);
796 router
= router_get_by_nickname(nick
, 1);
797 warned
= smartlist_string_isin(warned_nicknames
, nick
);
799 if (!must_be_running
|| router
->is_running
) {
800 smartlist_add(sl
,router
);
802 } else if (!router_get_combined_status_by_nickname(nick
,1)) {
804 log_fn(have_dir_info
? LOG_WARN
: LOG_INFO
, LD_CONFIG
,
805 "Nickname list includes '%s' which isn't a known router.",nick
);
806 smartlist_add(warned_nicknames
, tor_strdup(nick
));
810 SMARTLIST_FOREACH(nickname_list
, char *, nick
, tor_free(nick
));
811 smartlist_free(nickname_list
);
814 /** Return 1 iff any member of the (possibly NULL) comma-separated list
815 * <b>list</b> is an acceptable nickname or hexdigest for <b>router</b>. Else
819 router_nickname_is_in_list(routerinfo_t
*router
, const char *list
)
821 smartlist_t
*nickname_list
;
825 return 0; /* definitely not */
828 nickname_list
= smartlist_create();
829 smartlist_split_string(nickname_list
, list
, ",",
830 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, 0);
831 SMARTLIST_FOREACH(nickname_list
, const char *, cp
,
832 if (router_nickname_matches(router
, cp
)) {v
=1;break;});
833 SMARTLIST_FOREACH(nickname_list
, char *, cp
, tor_free(cp
));
834 smartlist_free(nickname_list
);
838 /** Add every suitable router from our routerlist to <b>sl</b>, so that
839 * we can pick a node for a circuit.
842 router_add_running_routers_to_smartlist(smartlist_t
*sl
, int allow_invalid
,
843 int need_uptime
, int need_capacity
,
849 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
851 if (router
->is_running
&&
852 router
->purpose
== ROUTER_PURPOSE_GENERAL
&&
853 (router
->is_valid
|| allow_invalid
) &&
854 !router_is_unreliable(router
, need_uptime
,
855 need_capacity
, need_guard
)) {
856 /* If it's running, and it's suitable according to the
857 * other flags we had in mind */
858 smartlist_add(sl
, router
);
863 /** Look through the routerlist until we find a router that has my key.
866 routerlist_find_my_routerinfo(void)
871 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
873 if (router_is_me(router
))
879 /** Find a router that's up, that has this IP address, and
880 * that allows exit to this address:port, or return NULL if there
884 router_find_exact_exit_enclave(const char *address
, uint16_t port
)
889 if (!tor_inet_aton(address
, &in
))
890 return NULL
; /* it's not an IP already */
891 addr
= ntohl(in
.s_addr
);
893 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
895 if (router
->is_running
&&
896 router
->addr
== addr
&&
897 compare_addr_to_addr_policy(addr
, port
, router
->exit_policy
) ==
898 ADDR_POLICY_ACCEPTED
)
904 /** Return 1 if <b>router</b> is not suitable for these parameters, else 0.
905 * If <b>need_uptime</b> is non-zero, we require a minimum uptime.
906 * If <b>need_capacity</b> is non-zero, we require a minimum advertised
908 * If <b>need_guard</b>, we require that the router is a possible entry guard.
911 router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
912 int need_capacity
, int need_guard
)
914 if (need_uptime
&& !router
->is_stable
)
916 if (need_capacity
&& !router
->is_fast
)
918 if (need_guard
&& !router
->is_possible_guard
)
923 /** Return the smaller of the router's configured BandwidthRate
924 * and its advertised capacity. */
926 router_get_advertised_bandwidth(routerinfo_t
*router
)
928 if (router
->bandwidthcapacity
< router
->bandwidthrate
)
929 return router
->bandwidthcapacity
;
930 return router
->bandwidthrate
;
933 /** Do not weight any declared bandwidth more than this much when picking
934 * routers by bandwidth. */
935 #define MAX_BELIEVABLE_BANDWIDTH 1500000 /* 1.5 MB/sec */
938 * choose a random element of smartlist <b>sl</b>, weighted by
939 * the advertised bandwidth of each element.
941 * If <b>statuses</b> is zero, then <b>sl</b> is a list of
942 * routerinfo_t's. Otherwise it's a list of routerstatus_t's.
944 * If <b>for_exit</b>, we're picking an exit node: consider all nodes'
945 * bandwidth equally regardless of their Exit status. If not <b>for_exit</b>,
946 * we're picking a non-exit node: weight exit-node's bandwidth downwards
947 * depending on the smallness of the fraction of Exit-to-total bandwidth.
950 smartlist_choose_by_bandwidth(smartlist_t
*sl
, int for_exit
, int statuses
)
953 routerinfo_t
*router
;
954 routerstatus_t
*status
;
957 uint64_t total_nonexit_bw
= 0, total_exit_bw
= 0, total_bw
= 0;
958 uint64_t rand_bw
, tmp
;
962 /* First count the total bandwidth weight, and make a list
963 * of each value. <0 means "unknown; no routerinfo." We use the
964 * bits of negative values to remember whether the router was fast (-x)&1
965 * and whether it was an exit (-x)&2. Yes, it's a hack. */
966 bandwidths
= tor_malloc(sizeof(int32_t)*smartlist_len(sl
));
968 /* Iterate over all the routerinfo_t or routerstatus_t, and */
969 for (i
= 0; i
< smartlist_len(sl
); ++i
) {
970 /* first, learn what bandwidth we think i has */
973 uint32_t this_bw
= 0;
975 /* need to extract router info */
976 status
= smartlist_get(sl
, i
);
977 router
= router_get_by_digest(status
->identity_digest
);
978 is_exit
= status
->is_exit
;
980 this_bw
= router_get_advertised_bandwidth(router
);
983 flags
= status
->is_fast
? 1 : 0;
984 flags
|= is_exit
? 2 : 0;
987 router
= smartlist_get(sl
, i
);
988 is_exit
= router
->is_exit
;
989 this_bw
= router_get_advertised_bandwidth(router
);
991 /* if they claim something huge, don't believe it */
992 if (this_bw
> MAX_BELIEVABLE_BANDWIDTH
)
993 this_bw
= MAX_BELIEVABLE_BANDWIDTH
;
995 bandwidths
[i
] = (int32_t) this_bw
; // safe since MAX_BELIEVABLE<INT32_MAX
997 total_exit_bw
+= this_bw
;
999 total_nonexit_bw
+= this_bw
;
1002 bandwidths
[i
] = -flags
;
1006 /* Now, fill in the unknown values. */
1008 int32_t avg_fast
, avg_slow
;
1009 if (total_exit_bw
+total_nonexit_bw
) {
1010 /* if there's some bandwidth, there's at least one known router,
1011 * so no worries about div by 0 here */
1012 int n_known
= smartlist_len(sl
)-n_unknown
;
1013 avg_fast
= avg_slow
= (int32_t)
1014 ((total_exit_bw
+total_nonexit_bw
)/((uint64_t) n_known
));
1019 for (i
=0; i
<smartlist_len(sl
); ++i
) {
1020 int32_t bw
= bandwidths
[i
];
1023 is_exit
= ((-bw
)&2);
1024 bandwidths
[i
] = ((-bw
)&1) ? avg_fast
: avg_slow
;
1026 total_exit_bw
+= bandwidths
[i
];
1028 total_nonexit_bw
+= bandwidths
[i
];
1032 /* If there's no bandwidth at all, pick at random. */
1033 if (!(total_exit_bw
+total_nonexit_bw
)) {
1034 tor_free(bandwidths
);
1035 return smartlist_choose(sl
);
1038 /* Figure out how to weight exits. */
1040 /* If we're choosing an exit node, exit bandwidth counts fully. */
1042 total_bw
= total_exit_bw
+ total_nonexit_bw
;
1043 } else if (total_exit_bw
< total_nonexit_bw
/ 2) {
1044 /* If we're choosing a relay and exits are greatly outnumbered, ignore
1047 total_bw
= total_nonexit_bw
;
1049 /* If we're choosing a relay and exits aren't outnumbered use the formula
1050 * from path-spec. */
1051 uint64_t leftover
= (total_exit_bw
- total_nonexit_bw
/ 2);
1052 exit_weight
= U64_TO_DBL(leftover
) /
1053 U64_TO_DBL(leftover
+ total_nonexit_bw
);
1054 total_bw
= total_nonexit_bw
+
1055 DBL_TO_U64(exit_weight
* U64_TO_DBL(total_exit_bw
));
1058 log_debug(LD_CIRC, "Total bw = "U64_FORMAT", total exit bw = "U64_FORMAT
1059 ", total nonexit bw = "U64_FORMAT", exit weight = %lf "
1061 U64_PRINTF_ARG(total_bw), U64_PRINTF_ARG(total_exit_bw),
1062 U64_PRINTF_ARG(total_nonexit_bw), exit_weight, for_exit);
1065 /* Almost done: choose a random value from the bandwidth weights. */
1066 rand_bw
= crypto_rand_uint64(total_bw
);
1068 /* Last, count through sl until we get to the element we picked */
1070 for (i
=0; i
< smartlist_len(sl
); i
++) {
1072 status
= smartlist_get(sl
, i
);
1073 is_exit
= status
->is_exit
;
1075 router
= smartlist_get(sl
, i
);
1076 is_exit
= router
->is_exit
;
1079 tmp
+= ((uint64_t)(bandwidths
[i
] * exit_weight
));
1081 tmp
+= bandwidths
[i
];
1085 tor_free(bandwidths
);
1086 return smartlist_get(sl
, i
);
1089 /** Choose a random element of router list <b>sl</b>, weighted by
1090 * the advertised bandwidth of each router.
1093 routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
, int for_exit
)
1095 return smartlist_choose_by_bandwidth(sl
, for_exit
, 0);
1098 /** Choose a random element of status list <b>sl</b>, weighted by
1099 * the advertised bandwidth of each status.
1102 routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
)
1104 return smartlist_choose_by_bandwidth(sl
, 1, 1);
1107 /** Return a random running router from the routerlist. If any node
1108 * named in <b>preferred</b> is available, pick one of those. Never
1109 * pick a node named in <b>excluded</b>, or whose routerinfo is in
1110 * <b>excludedsmartlist</b>, even if they are the only nodes
1111 * available. If <b>strict</b> is true, never pick any node besides
1112 * those in <b>preferred</b>.
1113 * If <b>need_uptime</b> is non-zero and any router has more than
1114 * a minimum uptime, return one of those.
1115 * If <b>need_capacity</b> is non-zero, weight your choice by the
1116 * advertised capacity of each router.
1117 * If ! <b>allow_invalid</b>, consider only Valid routers.
1118 * If <b>need_guard</b>, consider only Guard routers.
1119 * If <b>weight_for_exit</b>, we weight bandwidths as if picking an exit node,
1120 * otherwise we weight bandwidths for picking a relay node (that is, possibly
1121 * discounting exit nodes).
1124 router_choose_random_node(const char *preferred
,
1125 const char *excluded
,
1126 smartlist_t
*excludedsmartlist
,
1127 int need_uptime
, int need_capacity
,
1129 int allow_invalid
, int strict
,
1130 int weight_for_exit
)
1132 smartlist_t
*sl
, *excludednodes
;
1133 routerinfo_t
*choice
= NULL
;
1135 excludednodes
= smartlist_create();
1136 add_nickname_list_to_smartlist(excludednodes
,excluded
,0);
1138 /* Try the preferred nodes first. Ignore need_uptime and need_capacity
1139 * and need_guard, since the user explicitly asked for these nodes. */
1141 sl
= smartlist_create();
1142 add_nickname_list_to_smartlist(sl
,preferred
,1);
1143 smartlist_subtract(sl
,excludednodes
);
1144 if (excludedsmartlist
)
1145 smartlist_subtract(sl
,excludedsmartlist
);
1146 choice
= smartlist_choose(sl
);
1149 if (!choice
&& !strict
) {
1150 /* Then give up on our preferred choices: any node
1151 * will do that has the required attributes. */
1152 sl
= smartlist_create();
1153 router_add_running_routers_to_smartlist(sl
, allow_invalid
,
1154 need_uptime
, need_capacity
,
1156 smartlist_subtract(sl
,excludednodes
);
1157 if (excludedsmartlist
)
1158 smartlist_subtract(sl
,excludedsmartlist
);
1161 choice
= routerlist_sl_choose_by_bandwidth(sl
, weight_for_exit
);
1163 choice
= smartlist_choose(sl
);
1166 if (!choice
&& (need_uptime
|| need_capacity
|| need_guard
)) {
1167 /* try once more -- recurse but with fewer restrictions. */
1169 "We couldn't find any live%s%s%s routers; falling back "
1170 "to list of all routers.",
1171 need_capacity
?", fast":"",
1172 need_uptime
?", stable":"",
1173 need_guard
?", guard":"");
1174 choice
= router_choose_random_node(
1175 NULL
, excluded
, excludedsmartlist
,
1176 0, 0, 0, allow_invalid
, 0, weight_for_exit
);
1179 smartlist_free(excludednodes
);
1182 log_warn(LD_CIRC
, "All preferred nodes were down when trying to choose "
1183 "node, and the Strict[...]Nodes option is set. Failing.");
1186 "No available nodes when trying to choose node. Failing.");
1192 /** Return true iff the digest of <b>router</b>'s identity key,
1193 * encoded in hexadecimal, matches <b>hexdigest</b> (which is
1194 * optionally prefixed with a single dollar sign). Return false if
1195 * <b>hexdigest</b> is malformed, or it doesn't match. */
1197 router_hex_digest_matches(routerinfo_t
*router
, const char *hexdigest
)
1199 char digest
[DIGEST_LEN
];
1201 tor_assert(hexdigest
);
1202 if (hexdigest
[0] == '$')
1205 len
= strlen(hexdigest
);
1206 if (len
< HEX_DIGEST_LEN
)
1208 else if (len
> HEX_DIGEST_LEN
&&
1209 (hexdigest
[HEX_DIGEST_LEN
] == '=' ||
1210 hexdigest
[HEX_DIGEST_LEN
] == '~')) {
1211 if (strcasecmp(hexdigest
+HEX_DIGEST_LEN
+1, router
->nickname
))
1213 if (hexdigest
[HEX_DIGEST_LEN
] == '=' && !router
->is_named
)
1217 if (base16_decode(digest
, DIGEST_LEN
, hexdigest
, HEX_DIGEST_LEN
)<0)
1219 return (!memcmp(digest
, router
->cache_info
.identity_digest
, DIGEST_LEN
));
1222 /** Return true if <b>router</b>'s nickname matches <b>nickname</b>
1223 * (case-insensitive), or if <b>router's</b> identity key digest
1224 * matches a hexadecimal value stored in <b>nickname</b>. Return
1225 * false otherwise. */
1227 router_nickname_matches(routerinfo_t
*router
, const char *nickname
)
1229 if (nickname
[0]!='$' && !strcasecmp(router
->nickname
, nickname
))
1231 return router_hex_digest_matches(router
, nickname
);
1234 /** Return the router in our routerlist whose (case-insensitive)
1235 * nickname or (case-sensitive) hexadecimal key digest is
1236 * <b>nickname</b>. Return NULL if no such router is known.
1239 router_get_by_nickname(const char *nickname
, int warn_if_unnamed
)
1242 char digest
[DIGEST_LEN
];
1243 routerinfo_t
*best_match
=NULL
;
1245 char *named_digest
= NULL
;
1247 tor_assert(nickname
);
1250 if (nickname
[0] == '$')
1251 return router_get_by_hexdigest(nickname
);
1252 if (!strcasecmp(nickname
, UNNAMED_ROUTER_NICKNAME
))
1254 if (server_mode(get_options()) &&
1255 !strcasecmp(nickname
, get_options()->Nickname
))
1256 return router_get_my_routerinfo();
1258 maybedigest
= (strlen(nickname
) >= HEX_DIGEST_LEN
) &&
1259 (base16_decode(digest
,DIGEST_LEN
,nickname
,HEX_DIGEST_LEN
) == 0);
1261 if (named_server_map
&&
1262 (named_digest
= strmap_get_lc(named_server_map
, nickname
))) {
1263 return digestmap_get(routerlist
->identity_map
, named_digest
);
1266 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
1268 if (!strcasecmp(router
->nickname
, nickname
)) {
1270 if (n_matches
<= 1 || router
->is_running
)
1271 best_match
= router
;
1272 } else if (maybedigest
&&
1273 !memcmp(digest
, router
->cache_info
.identity_digest
, DIGEST_LEN
)
1275 if (router_hex_digest_matches(router
, nickname
))
1278 best_match
= router
; // XXXX NM not exactly right.
1283 if (warn_if_unnamed
&& n_matches
> 1) {
1284 smartlist_t
*fps
= smartlist_create();
1285 int any_unwarned
= 0;
1286 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
1288 local_routerstatus_t
*rs
;
1291 char fp
[HEX_DIGEST_LEN
+1];
1292 if (strcasecmp(router
->nickname
, nickname
))
1294 rs
= router_get_combined_status_by_digest(
1295 router
->cache_info
.identity_digest
);
1296 if (rs
&& !rs
->name_lookup_warned
) {
1297 rs
->name_lookup_warned
= 1;
1300 base16_encode(fp
, sizeof(fp
),
1301 router
->cache_info
.identity_digest
, DIGEST_LEN
);
1302 dlen
= 32 + HEX_DIGEST_LEN
+ strlen(router
->address
);
1303 desc
= tor_malloc(dlen
);
1304 tor_snprintf(desc
, dlen
, "\"$%s\" for the one at %s:%d",
1305 fp
, router
->address
, router
->or_port
);
1306 smartlist_add(fps
, desc
);
1309 char *alternatives
= smartlist_join_strings(fps
, "; ",0,NULL
);
1311 "There are multiple matches for the nickname \"%s\","
1312 " but none is listed as named by the directory authorities. "
1313 "Choosing one arbitrarily. If you meant one in particular, "
1314 "you should say %s.", nickname
, alternatives
);
1315 tor_free(alternatives
);
1317 SMARTLIST_FOREACH(fps
, char *, cp
, tor_free(cp
));
1318 smartlist_free(fps
);
1319 } else if (warn_if_unnamed
) {
1320 local_routerstatus_t
*rs
= router_get_combined_status_by_digest(
1321 best_match
->cache_info
.identity_digest
);
1322 if (rs
&& !rs
->name_lookup_warned
) {
1323 char fp
[HEX_DIGEST_LEN
+1];
1324 base16_encode(fp
, sizeof(fp
),
1325 best_match
->cache_info
.identity_digest
, DIGEST_LEN
);
1326 log_warn(LD_CONFIG
, "You specified a server \"%s\" by name, but this "
1327 "name is not registered, so it could be used by any server, "
1328 "not just the one you meant. "
1329 "To make sure you get the same server in the future, refer to "
1330 "it by key, as \"$%s\".", nickname
, fp
);
1331 rs
->name_lookup_warned
= 1;
1340 /** Try to find a routerinfo for <b>digest</b>. If we don't have one,
1341 * return 1. If we do, ask tor_version_as_new_as() for the answer.
1344 router_digest_version_as_new_as(const char *digest
, const char *cutoff
)
1346 routerinfo_t
*router
= router_get_by_digest(digest
);
1349 return tor_version_as_new_as(router
->platform
, cutoff
);
1352 /** Return true iff <b>digest</b> is the digest of the identity key of
1353 * a trusted directory. */
1355 router_digest_is_trusted_dir(const char *digest
)
1357 if (!trusted_dir_servers
)
1359 if (get_options()->AuthoritativeDir
&&
1360 router_digest_is_me(digest
))
1362 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ent
,
1363 if (!memcmp(digest
, ent
->digest
, DIGEST_LEN
)) return 1);
1367 /** Return the router in our routerlist whose hexadecimal key digest
1368 * is <b>hexdigest</b>. Return NULL if no such router is known. */
1370 router_get_by_hexdigest(const char *hexdigest
)
1372 char digest
[DIGEST_LEN
];
1376 tor_assert(hexdigest
);
1379 if (hexdigest
[0]=='$')
1381 len
= strlen(hexdigest
);
1382 if (len
< HEX_DIGEST_LEN
||
1383 base16_decode(digest
,DIGEST_LEN
,hexdigest
,HEX_DIGEST_LEN
) < 0)
1386 ri
= router_get_by_digest(digest
);
1388 if (len
> HEX_DIGEST_LEN
) {
1389 if (hexdigest
[HEX_DIGEST_LEN
] == '=') {
1390 if (strcasecmp(ri
->nickname
, hexdigest
+HEX_DIGEST_LEN
+1) ||
1393 } else if (hexdigest
[HEX_DIGEST_LEN
] == '~') {
1394 if (strcasecmp(ri
->nickname
, hexdigest
+HEX_DIGEST_LEN
+1))
1404 /** Return the router in our routerlist whose 20-byte key digest
1405 * is <b>digest</b>. Return NULL if no such router is known. */
1407 router_get_by_digest(const char *digest
)
1411 if (!routerlist
) return NULL
;
1413 // routerlist_assert_ok(routerlist);
1415 return digestmap_get(routerlist
->identity_map
, digest
);
1418 /** Return the router in our routerlist whose 20-byte descriptor
1419 * is <b>digest</b>. Return NULL if no such router is known. */
1420 signed_descriptor_t
*
1421 router_get_by_descriptor_digest(const char *digest
)
1425 if (!routerlist
) return NULL
;
1427 return digestmap_get(routerlist
->desc_digest_map
, digest
);
1430 /** Return a pointer to the signed textual representation of a descriptor.
1431 * The returned string is not guaranteed to be NUL-terminated: the string's
1432 * length will be in desc-\>signed_descriptor_len. */
1434 signed_descriptor_get_body(signed_descriptor_t
*desc
)
1437 size_t len
= desc
->signed_descriptor_len
;
1438 tor_assert(len
> 32);
1439 if (desc
->saved_location
== SAVED_IN_CACHE
&& routerlist
&&
1440 routerlist
->mmap_descriptors
) {
1441 tor_assert(desc
->saved_offset
+ len
<= routerlist
->mmap_descriptors
->size
);
1442 r
= routerlist
->mmap_descriptors
->data
+ desc
->saved_offset
;
1444 r
= desc
->signed_descriptor_body
;
1447 tor_assert(!memcmp("router ", r
, 7));
1449 tor_assert(!memcmp("\n-----END SIGNATURE-----\n",
1456 /** Return the current list of all known routers. */
1458 router_get_routerlist(void)
1461 routerlist
= tor_malloc_zero(sizeof(routerlist_t
));
1462 routerlist
->routers
= smartlist_create();
1463 routerlist
->old_routers
= smartlist_create();
1464 routerlist
->identity_map
= digestmap_new();
1465 routerlist
->desc_digest_map
= digestmap_new();
1470 /** Free all storage held by <b>router</b>. */
1472 routerinfo_free(routerinfo_t
*router
)
1477 tor_free(router
->cache_info
.signed_descriptor_body
);
1478 tor_free(router
->address
);
1479 tor_free(router
->nickname
);
1480 tor_free(router
->platform
);
1481 tor_free(router
->contact_info
);
1482 if (router
->onion_pkey
)
1483 crypto_free_pk_env(router
->onion_pkey
);
1484 if (router
->identity_pkey
)
1485 crypto_free_pk_env(router
->identity_pkey
);
1486 if (router
->declared_family
) {
1487 SMARTLIST_FOREACH(router
->declared_family
, char *, s
, tor_free(s
));
1488 smartlist_free(router
->declared_family
);
1490 addr_policy_free(router
->exit_policy
);
1494 /** Release storage held by <b>sd</b>. */
1496 signed_descriptor_free(signed_descriptor_t
*sd
)
1498 tor_free(sd
->signed_descriptor_body
);
1502 /** Extract a signed_descriptor_t from a routerinfo, and free the routerinfo.
1504 static signed_descriptor_t
*
1505 signed_descriptor_from_routerinfo(routerinfo_t
*ri
)
1507 signed_descriptor_t
*sd
= tor_malloc_zero(sizeof(signed_descriptor_t
));
1508 memcpy(sd
, &(ri
->cache_info
), sizeof(signed_descriptor_t
));
1509 ri
->cache_info
.signed_descriptor_body
= NULL
;
1510 routerinfo_free(ri
);
1514 /** Free all storage held by a routerlist <b>rl</b> */
1516 routerlist_free(routerlist_t
*rl
)
1519 digestmap_free(rl
->identity_map
, NULL
);
1520 digestmap_free(rl
->desc_digest_map
, NULL
);
1521 SMARTLIST_FOREACH(rl
->routers
, routerinfo_t
*, r
,
1522 routerinfo_free(r
));
1523 SMARTLIST_FOREACH(rl
->old_routers
, signed_descriptor_t
*, sd
,
1524 signed_descriptor_free(sd
));
1525 smartlist_free(rl
->routers
);
1526 smartlist_free(rl
->old_routers
);
1527 if (routerlist
->mmap_descriptors
)
1528 tor_munmap_file(routerlist
->mmap_descriptors
);
1531 router_dir_info_changed();
1535 dump_routerlist_mem_usage(int severity
)
1537 uint64_t livedescs
= 0;
1538 uint64_t olddescs
= 0;
1541 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, r
,
1542 livedescs
+= r
->cache_info
.signed_descriptor_len
);
1543 SMARTLIST_FOREACH(routerlist
->old_routers
, signed_descriptor_t
*, sd
,
1544 olddescs
+= sd
->signed_descriptor_len
);
1546 log(severity
, LD_GENERAL
,
1547 "In %d live descriptors: "U64_FORMAT
" bytes. "
1548 "In %d old descriptors: "U64_FORMAT
" bytes.",
1549 smartlist_len(routerlist
->routers
), U64_PRINTF_ARG(livedescs
),
1550 smartlist_len(routerlist
->old_routers
), U64_PRINTF_ARG(olddescs
));
1553 /** Return the greatest number of routerdescs we'll hold for any given router.
1556 max_descriptors_per_router(void)
1558 int n_authorities
= get_n_v2_authorities();
1559 return (n_authorities
< 5) ? 5 : n_authorities
;
1562 /** Return non-zero if we have a lot of extra descriptors in our
1563 * routerlist, and should get rid of some of them. Else return 0.
1565 * We should be careful to not return true too eagerly, since we
1566 * could churn. By using "+1" below, we make sure this function
1567 * only returns true at most every smartlist_len(rl-\>routers)
1571 routerlist_is_overfull(routerlist_t
*rl
)
1573 return smartlist_len(rl
->old_routers
) >
1574 smartlist_len(rl
->routers
)*(max_descriptors_per_router()+1);
1578 _routerlist_find_elt(smartlist_t
*sl
, void *ri
, int idx
)
1580 if (idx
< 0 || smartlist_get(sl
, idx
) != ri
) {
1582 SMARTLIST_FOREACH(sl
, routerinfo_t
*, r
,
1591 /** Insert an item <b>ri</b> into the routerlist <b>rl</b>, updating indices
1594 routerlist_insert(routerlist_t
*rl
, routerinfo_t
*ri
)
1596 digestmap_set(rl
->identity_map
, ri
->cache_info
.identity_digest
, ri
);
1597 digestmap_set(rl
->desc_digest_map
, ri
->cache_info
.signed_descriptor_digest
,
1599 smartlist_add(rl
->routers
, ri
);
1600 ri
->routerlist_index
= smartlist_len(rl
->routers
) - 1;
1601 router_dir_info_changed();
1602 // routerlist_assert_ok(rl);
1605 /** If we're a directory cache and routerlist <b>rl</b> doesn't have
1606 * a copy of router <b>ri</b> yet, add it to the list of old (not
1607 * recommended but still served) descriptors. Else free it. */
1609 routerlist_insert_old(routerlist_t
*rl
, routerinfo_t
*ri
)
1611 if (get_options()->DirPort
&&
1612 !digestmap_get(rl
->desc_digest_map
,
1613 ri
->cache_info
.signed_descriptor_digest
)) {
1614 signed_descriptor_t
*sd
= signed_descriptor_from_routerinfo(ri
);
1615 digestmap_set(rl
->desc_digest_map
, sd
->signed_descriptor_digest
, sd
);
1616 smartlist_add(rl
->old_routers
, sd
);
1618 routerinfo_free(ri
);
1620 // routerlist_assert_ok(rl);
1623 /** Remove an item <b>ri</b> from the routerlist <b>rl</b>, updating indices
1624 * as needed. If <b>idx</b> is nonnegative and smartlist_get(rl->routers,
1625 * idx) == ri, we don't need to do a linear search over the list to decide
1626 * which to remove. We fill the gap in rl->routers with a later element in
1627 * the list, if any exists. <b>ri</b> is freed. */
1629 routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int idx
, int make_old
)
1631 routerinfo_t
*ri_tmp
;
1632 idx
= _routerlist_find_elt(rl
->routers
, ri
, idx
);
1635 ri
->routerlist_index
= -1;
1636 smartlist_del(rl
->routers
, idx
);
1637 if (idx
< smartlist_len(rl
->routers
)) {
1638 routerinfo_t
*r
= smartlist_get(rl
->routers
, idx
);
1639 r
->routerlist_index
= idx
;
1642 ri_tmp
= digestmap_remove(rl
->identity_map
, ri
->cache_info
.identity_digest
);
1643 router_dir_info_changed();
1644 tor_assert(ri_tmp
== ri
);
1645 if (make_old
&& get_options()->DirPort
) {
1646 signed_descriptor_t
*sd
;
1647 sd
= signed_descriptor_from_routerinfo(ri
);
1648 smartlist_add(rl
->old_routers
, sd
);
1649 digestmap_set(rl
->desc_digest_map
, sd
->signed_descriptor_digest
, sd
);
1651 ri_tmp
= digestmap_remove(rl
->desc_digest_map
,
1652 ri
->cache_info
.signed_descriptor_digest
);
1653 tor_assert(ri_tmp
== ri
);
1654 router_bytes_dropped
+= ri
->cache_info
.signed_descriptor_len
;
1655 routerinfo_free(ri
);
1657 // routerlist_assert_ok(rl);
1662 routerlist_remove_old(routerlist_t
*rl
, signed_descriptor_t
*sd
, int idx
)
1664 signed_descriptor_t
*sd_tmp
;
1665 idx
= _routerlist_find_elt(rl
->old_routers
, sd
, idx
);
1668 smartlist_del(rl
->old_routers
, idx
);
1669 sd_tmp
= digestmap_remove(rl
->desc_digest_map
,
1670 sd
->signed_descriptor_digest
);
1671 tor_assert(sd_tmp
== sd
);
1672 router_bytes_dropped
+= sd
->signed_descriptor_len
;
1673 signed_descriptor_free(sd
);
1674 // routerlist_assert_ok(rl);
1677 /** Remove <b>ri_old</b> from the routerlist <b>rl</b>, and replace it with
1678 * <b>ri_new</b>, updating all index info. If <b>idx</b> is nonnegative and
1679 * smartlist_get(rl->routers, idx) == ri, we don't need to do a linear
1680 * search over the list to decide which to remove. We put ri_new in the same
1681 * index as ri_old, if possible. ri is freed as appropriate. */
1683 routerlist_replace(routerlist_t
*rl
, routerinfo_t
*ri_old
,
1684 routerinfo_t
*ri_new
, int idx
, int make_old
)
1686 tor_assert(ri_old
!= ri_new
);
1687 idx
= _routerlist_find_elt(rl
->routers
, ri_old
, idx
);
1688 router_dir_info_changed();
1690 smartlist_set(rl
->routers
, idx
, ri_new
);
1691 ri_old
->routerlist_index
= -1;
1692 ri_new
->routerlist_index
= idx
;
1694 log_warn(LD_BUG
, "Appending entry from routerlist_replace.");
1695 routerlist_insert(rl
, ri_new
);
1698 if (memcmp(ri_old
->cache_info
.identity_digest
,
1699 ri_new
->cache_info
.identity_digest
, DIGEST_LEN
)) {
1700 /* digests don't match; digestmap_set won't replace */
1701 digestmap_remove(rl
->identity_map
, ri_old
->cache_info
.identity_digest
);
1703 digestmap_set(rl
->identity_map
, ri_new
->cache_info
.identity_digest
, ri_new
);
1704 digestmap_set(rl
->desc_digest_map
,
1705 ri_new
->cache_info
.signed_descriptor_digest
, &(ri_new
->cache_info
));
1707 if (make_old
&& get_options()->DirPort
) {
1708 signed_descriptor_t
*sd
= signed_descriptor_from_routerinfo(ri_old
);
1709 smartlist_add(rl
->old_routers
, sd
);
1710 digestmap_set(rl
->desc_digest_map
, sd
->signed_descriptor_digest
, sd
);
1712 if (memcmp(ri_old
->cache_info
.signed_descriptor_digest
,
1713 ri_new
->cache_info
.signed_descriptor_digest
,
1715 /* digests don't match; digestmap_set didn't replace */
1716 digestmap_remove(rl
->desc_digest_map
,
1717 ri_old
->cache_info
.signed_descriptor_digest
);
1719 router_bytes_dropped
+= ri_old
->cache_info
.signed_descriptor_len
;
1720 routerinfo_free(ri_old
);
1722 // routerlist_assert_ok(rl);
1725 /** Free all memory held by the routerlist module. */
1727 routerlist_free_all(void)
1730 routerlist_free(routerlist
);
1732 if (warned_nicknames
) {
1733 SMARTLIST_FOREACH(warned_nicknames
, char *, cp
, tor_free(cp
));
1734 smartlist_free(warned_nicknames
);
1735 warned_nicknames
= NULL
;
1737 if (warned_conflicts
) {
1738 SMARTLIST_FOREACH(warned_conflicts
, char *, cp
, tor_free(cp
));
1739 smartlist_free(warned_conflicts
);
1740 warned_conflicts
= NULL
;
1742 if (trusted_dir_servers
) {
1743 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ds
,
1744 trusted_dir_server_free(ds
));
1745 smartlist_free(trusted_dir_servers
);
1746 trusted_dir_servers
= NULL
;
1748 if (networkstatus_list
) {
1749 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
1750 networkstatus_free(ns
));
1751 smartlist_free(networkstatus_list
);
1752 networkstatus_list
= NULL
;
1754 if (routerstatus_list
) {
1755 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, rs
,
1756 local_routerstatus_free(rs
));
1757 smartlist_free(routerstatus_list
);
1758 routerstatus_list
= NULL
;
1760 if (named_server_map
) {
1761 strmap_free(named_server_map
, _tor_free
);
1765 /** Free all storage held by the routerstatus object <b>rs</b>. */
1767 routerstatus_free(routerstatus_t
*rs
)
1772 /** Free all storage held by the local_routerstatus object <b>rs</b>. */
1774 local_routerstatus_free(local_routerstatus_t
*rs
)
1779 /** Free all storage held by the networkstatus object <b>ns</b>. */
1781 networkstatus_free(networkstatus_t
*ns
)
1783 tor_free(ns
->source_address
);
1784 tor_free(ns
->contact
);
1785 if (ns
->signing_key
)
1786 crypto_free_pk_env(ns
->signing_key
);
1787 tor_free(ns
->client_versions
);
1788 tor_free(ns
->server_versions
);
1790 SMARTLIST_FOREACH(ns
->entries
, routerstatus_t
*, rs
,
1791 routerstatus_free(rs
));
1792 smartlist_free(ns
->entries
);
1797 /** Forget that we have issued any router-related warnings, so that we'll
1798 * warn again if we see the same errors. */
1800 routerlist_reset_warnings(void)
1802 if (!warned_nicknames
)
1803 warned_nicknames
= smartlist_create();
1804 SMARTLIST_FOREACH(warned_nicknames
, char *, cp
, tor_free(cp
));
1805 smartlist_clear(warned_nicknames
); /* now the list is empty. */
1807 if (!warned_conflicts
)
1808 warned_conflicts
= smartlist_create();
1809 SMARTLIST_FOREACH(warned_conflicts
, char *, cp
, tor_free(cp
));
1810 smartlist_clear(warned_conflicts
); /* now the list is empty. */
1812 if (!routerstatus_list
)
1813 routerstatus_list
= smartlist_create();
1814 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, rs
,
1815 rs
->name_lookup_warned
= 0);
1817 have_warned_about_invalid_status
= 0;
1818 have_warned_about_old_version
= 0;
1819 have_warned_about_new_version
= 0;
1822 /** Mark the router with ID <b>digest</b> as running or non-running
1823 * in our routerlist. */
1825 router_set_status(const char *digest
, int up
)
1827 routerinfo_t
*router
;
1828 local_routerstatus_t
*status
;
1831 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, d
,
1832 if (!memcmp(d
->digest
, digest
, DIGEST_LEN
))
1833 d
->is_running
= up
);
1835 router
= router_get_by_digest(digest
);
1837 log_debug(LD_DIR
,"Marking router '%s' as %s.",
1838 router
->nickname
, up
? "up" : "down");
1839 if (!up
&& router_is_me(router
) && !we_are_hibernating())
1840 log_warn(LD_NET
, "We just marked ourself as down. Are your external "
1841 "addresses reachable?");
1842 router
->is_running
= up
;
1844 status
= router_get_combined_status_by_digest(digest
);
1845 if (status
&& status
->status
.is_running
!= up
) {
1846 status
->status
.is_running
= up
;
1847 control_event_networkstatus_changed_single(status
);
1849 router_dir_info_changed();
1852 /** Add <b>router</b> to the routerlist, if we don't already have it. Replace
1853 * older entries (if any) with the same key. Note: Callers should not hold
1854 * their pointers to <b>router</b> if this function fails; <b>router</b>
1855 * will either be inserted into the routerlist or freed.
1857 * Returns >= 0 if the router was added; less than 0 if it was not.
1859 * If we're returning non-zero, then assign to *<b>msg</b> a static string
1860 * describing the reason for not liking the routerinfo.
1862 * If the return value is less than -1, there was a problem with the
1863 * routerinfo. If the return value is equal to -1, then the routerinfo was
1864 * fine, but out-of-date. If the return value is equal to 1, the
1865 * routerinfo was accepted, but we should notify the generator of the
1866 * descriptor using the message *<b>msg</b>.
1868 * If <b>from_cache</b>, this descriptor came from our disk cache. If
1869 * <b>from_fetch</b>, we received it in response to a request we made.
1870 * (If both are false, that means it was uploaded to us as an auth dir
1871 * server or via the controller.)
1873 * This function should be called *after*
1874 * routers_update_status_from_networkstatus; subsequently, you should call
1875 * router_rebuild_store and control_event_descriptors_changed.
1878 router_add_to_routerlist(routerinfo_t
*router
, const char **msg
,
1879 int from_cache
, int from_fetch
)
1881 const char *id_digest
;
1882 int authdir
= get_options()->AuthoritativeDir
;
1883 int authdir_believes_valid
= 0;
1884 routerinfo_t
*old_router
;
1889 router_get_routerlist();
1890 if (!networkstatus_list
)
1891 networkstatus_list
= smartlist_create();
1893 id_digest
= router
->cache_info
.identity_digest
;
1895 /* Make sure that we haven't already got this exact descriptor. */
1896 if (digestmap_get(routerlist
->desc_digest_map
,
1897 router
->cache_info
.signed_descriptor_digest
)) {
1899 "Dropping descriptor that we already have for router '%s'",
1901 *msg
= "Router descriptor was not new.";
1902 routerinfo_free(router
);
1906 if (routerlist_is_overfull(routerlist
))
1907 routerlist_remove_old_routers();
1910 if (authdir_wants_to_reject_router(router
, msg
,
1911 !from_cache
&& !from_fetch
)) {
1913 routerinfo_free(router
);
1916 authdir_believes_valid
= router
->is_valid
;
1917 } else if (from_fetch
) {
1918 /* Only check the descriptor digest against the network statuses when
1919 * we are receiving in response to a fetch. */
1921 if (!signed_desc_digest_is_recognized(&router
->cache_info
)) {
1922 /* We asked for it, so some networkstatus must have listed it when we
1923 * did. Save it if we're a cache in case somebody else asks for it. */
1925 "Received a no-longer-recognized descriptor for router '%s'",
1927 *msg
= "Router descriptor is not referenced by any network-status.";
1929 /* Only journal this desc if we'll be serving it. */
1930 if (!from_cache
&& get_options()->DirPort
)
1931 router_append_to_journal(&router
->cache_info
);
1932 routerlist_insert_old(routerlist
, router
);
1937 /* We no longer need a router with this descriptor digest. */
1938 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
1940 routerstatus_t
*rs
=
1941 networkstatus_find_entry(ns
, router
->cache_info
.identity_digest
);
1942 if (rs
&& !memcmp(rs
->descriptor_digest
,
1943 router
->cache_info
.signed_descriptor_digest
,
1945 rs
->need_to_mirror
= 0;
1948 /* If we have a router with the same identity key, choose the newer one. */
1949 old_router
= digestmap_get(routerlist
->identity_map
,
1950 router
->cache_info
.identity_digest
);
1952 int pos
= old_router
->routerlist_index
;
1953 tor_assert(smartlist_get(routerlist
->routers
, pos
) == old_router
);
1955 if (router
->cache_info
.published_on
<=
1956 old_router
->cache_info
.published_on
) {
1957 /* Same key, but old */
1958 log_debug(LD_DIR
, "Skipping not-new descriptor for router '%s'",
1960 /* Only journal this desc if we'll be serving it. */
1961 if (!from_cache
&& get_options()->DirPort
)
1962 router_append_to_journal(&router
->cache_info
);
1963 routerlist_insert_old(routerlist
, router
);
1964 *msg
= "Router descriptor was not new.";
1967 /* Same key, new. */
1968 int unreachable
= 0;
1969 log_debug(LD_DIR
, "Replacing entry for router '%s/%s' [%s]",
1970 router
->nickname
, old_router
->nickname
,
1971 hex_str(id_digest
,DIGEST_LEN
));
1972 if (router
->addr
== old_router
->addr
&&
1973 router
->or_port
== old_router
->or_port
) {
1974 /* these carry over when the address and orport are unchanged.*/
1975 router
->last_reachable
= old_router
->last_reachable
;
1976 router
->testing_since
= old_router
->testing_since
;
1977 router
->num_unreachable_notifications
=
1978 old_router
->num_unreachable_notifications
;
1980 if (authdir
&& !from_cache
&& !from_fetch
&&
1981 router_have_minimum_dir_info() &&
1982 dirserv_thinks_router_is_blatantly_unreachable(router
,
1984 if (router
->num_unreachable_notifications
>= 3) {
1986 log_notice(LD_DIR
, "Notifying server '%s' that it's unreachable. "
1987 "(ContactInfo '%s', platform '%s').",
1989 router
->contact_info
? router
->contact_info
: "",
1990 router
->platform
? router
->platform
: "");
1992 log_info(LD_DIR
,"'%s' may be unreachable -- the %d previous "
1993 "descriptors were thought to be unreachable.",
1994 router
->nickname
, router
->num_unreachable_notifications
);
1995 router
->num_unreachable_notifications
++;
1998 routerlist_replace(routerlist
, old_router
, router
, pos
, 1);
2000 router_append_to_journal(&router
->cache_info
);
2002 directory_set_dirty();
2003 *msg
= unreachable
? "Dirserver believes your ORPort is unreachable" :
2004 authdir_believes_valid
? "Valid server updated" :
2005 ("Invalid server updated. (This dirserver is marking your "
2006 "server as unapproved.)");
2007 return unreachable
? 1 : 0;
2011 /* We haven't seen a router with this identity before. Add it to the end of
2013 routerlist_insert(routerlist
, router
);
2015 router_append_to_journal(&router
->cache_info
);
2016 directory_set_dirty();
2020 /** Sorting helper: return <0, 0, or >0 depending on whether the
2021 * signed_descriptor_t* in *<b>a</b> has an identity digest preceding, equal
2022 * to, or later than that of *<b>b</b>. */
2024 _compare_old_routers_by_identity(const void **_a
, const void **_b
)
2027 const signed_descriptor_t
*r1
= *_a
, *r2
= *_b
;
2028 if ((i
= memcmp(r1
->identity_digest
, r2
->identity_digest
, DIGEST_LEN
)))
2030 return r1
->published_on
- r2
->published_on
;
2033 /** Internal type used to represent how long an old descriptor was valid,
2034 * where it appeared in the list of old descriptors, and whether it's extra
2035 * old. Used only by routerlist_remove_old_cached_routers_with_id(). */
2036 struct duration_idx_t
{
2042 /** Sorting helper: compare two duration_idx_t by their duration. */
2044 _compare_duration_idx(const void *_d1
, const void *_d2
)
2046 const struct duration_idx_t
*d1
= _d1
;
2047 const struct duration_idx_t
*d2
= _d2
;
2048 return d1
->duration
- d2
->duration
;
2051 /** The range <b>lo</b> through <b>hi</b> inclusive of routerlist->old_routers
2052 * must contain routerinfo_t with the same identity and with publication time
2053 * in ascending order. Remove members from this range until there are no more
2054 * than max_descriptors_per_router() remaining. Start by removing the oldest
2055 * members from before <b>cutoff</b>, then remove members which were current
2056 * for the lowest amount of time. The order of members of old_routers at
2057 * indices <b>lo</b> or higher may be changed.
2060 routerlist_remove_old_cached_routers_with_id(time_t cutoff
, int lo
, int hi
,
2061 digestmap_t
*retain
)
2063 int i
, n
= hi
-lo
+1, n_extra
;
2065 struct duration_idx_t
*lifespans
;
2066 uint8_t *rmv
, *must_keep
;
2067 smartlist_t
*lst
= routerlist
->old_routers
;
2070 tor_assert(hi
< smartlist_len(lst
));
2071 tor_assert(lo
<= hi
);
2072 ident
= ((signed_descriptor_t
*)smartlist_get(lst
, lo
))->identity_digest
;
2073 for (i
= lo
+1; i
<= hi
; ++i
) {
2074 signed_descriptor_t
*r
= smartlist_get(lst
, i
);
2075 tor_assert(!memcmp(ident
, r
->identity_digest
, DIGEST_LEN
));
2079 /* Check whether we need to do anything at all. */
2080 n_extra
= n
- max_descriptors_per_router();
2084 lifespans
= tor_malloc_zero(sizeof(struct duration_idx_t
)*n
);
2085 rmv
= tor_malloc_zero(sizeof(uint8_t)*n
);
2086 must_keep
= tor_malloc_zero(sizeof(uint8_t)*n
);
2087 /* Set lifespans to contain the lifespan and index of each server. */
2088 /* Set rmv[i-lo]=1 if we're going to remove a server for being too old. */
2089 for (i
= lo
; i
<= hi
; ++i
) {
2090 signed_descriptor_t
*r
= smartlist_get(lst
, i
);
2091 signed_descriptor_t
*r_next
;
2092 lifespans
[i
-lo
].idx
= i
;
2093 if (retain
&& digestmap_get(retain
, r
->signed_descriptor_digest
)) {
2094 must_keep
[i
-lo
] = 1;
2097 r_next
= smartlist_get(lst
, i
+1);
2098 tor_assert(r
->published_on
<= r_next
->published_on
);
2099 lifespans
[i
-lo
].duration
= (r_next
->published_on
- r
->published_on
);
2102 lifespans
[i
-lo
].duration
= INT_MAX
;
2104 if (!must_keep
[i
-lo
] && r
->published_on
< cutoff
&& n_rmv
< n_extra
) {
2106 lifespans
[i
-lo
].old
= 1;
2111 if (n_rmv
< n_extra
) {
2113 * We aren't removing enough servers for being old. Sort lifespans by
2114 * the duration of liveness, and remove the ones we're not already going to
2115 * remove based on how long they were alive.
2117 qsort(lifespans
, n
, sizeof(struct duration_idx_t
), _compare_duration_idx
);
2118 for (i
= 0; i
< n
&& n_rmv
< n_extra
; ++i
) {
2119 if (!must_keep
[lifespans
[i
].idx
-lo
] && !lifespans
[i
].old
) {
2120 rmv
[lifespans
[i
].idx
-lo
] = 1;
2126 for (i
= hi
; i
>= lo
; --i
) {
2128 routerlist_remove_old(routerlist
, smartlist_get(lst
, i
), i
);
2130 tor_free(must_keep
);
2132 tor_free(lifespans
);
2135 /** Deactivate any routers from the routerlist that are more than
2136 * ROUTER_MAX_AGE seconds old and not recommended by any networkstatuses;
2137 * remove old routers from the list of cached routers if we have too many.
2140 routerlist_remove_old_routers(void)
2143 const char *cur_id
= NULL
;
2144 time_t now
= time(NULL
);
2146 routerinfo_t
*router
;
2147 signed_descriptor_t
*sd
;
2148 digestmap_t
*retain
;
2149 if (!routerlist
|| !networkstatus_list
)
2152 routerlist_assert_ok(routerlist
);
2154 retain
= digestmap_new();
2155 cutoff
= now
- OLD_ROUTER_DESC_MAX_AGE
;
2156 /* Build a list of all the descriptors that _anybody_ recommends. */
2157 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
2159 /* XXXX The inner loop here gets pretty expensive, and actually shows up
2160 * on some profiles. It may be the reason digestmap_set shows up in
2161 * profiles too. If instead we kept a per-descriptor digest count of
2162 * how many networkstatuses recommended each descriptor, and changed
2163 * that only when the networkstatuses changed, that would be a speed
2164 * improvement, possibly 1-4% if it also removes digestmap_set from the
2165 * profile. Not worth it for 0.1.2.x, though. The new directory
2166 * system will obsolete this whole thing in 0.2.0.x. */
2167 SMARTLIST_FOREACH(ns
->entries
, routerstatus_t
*, rs
,
2168 if (rs
->published_on
>= cutoff
)
2169 digestmap_set(retain
, rs
->descriptor_digest
, (void*)1));
2172 /* If we have a bunch of networkstatuses, we should consider pruning current
2173 * routers that are too old and that nobody recommends. (If we don't have
2174 * enough networkstatuses, then we should get more before we decide to kill
2176 if (smartlist_len(networkstatus_list
) > get_n_v2_authorities() / 2) {
2177 cutoff
= now
- ROUTER_MAX_AGE
;
2178 /* Remove too-old unrecommended members of routerlist->routers. */
2179 for (i
= 0; i
< smartlist_len(routerlist
->routers
); ++i
) {
2180 router
= smartlist_get(routerlist
->routers
, i
);
2181 if (router
->cache_info
.published_on
<= cutoff
&&
2182 !digestmap_get(retain
,router
->cache_info
.signed_descriptor_digest
)) {
2183 /* Too old: remove it. (If we're a cache, just move it into
2186 "Forgetting obsolete (too old) routerinfo for router '%s'",
2188 routerlist_remove(routerlist
, router
, i
--, 1);
2193 routerlist_assert_ok(routerlist
);
2195 /* Remove far-too-old members of routerlist->old_routers. */
2196 cutoff
= now
- OLD_ROUTER_DESC_MAX_AGE
;
2197 for (i
= 0; i
< smartlist_len(routerlist
->old_routers
); ++i
) {
2198 sd
= smartlist_get(routerlist
->old_routers
, i
);
2199 if (sd
->published_on
<= cutoff
&&
2200 !digestmap_get(retain
, sd
->signed_descriptor_digest
)) {
2201 /* Too old. Remove it. */
2202 routerlist_remove_old(routerlist
, sd
, i
--);
2206 routerlist_assert_ok(routerlist
);
2208 /* Now we might have to look at routerlist->old_routers for extraneous
2209 * members. (We'd keep all the members if we could, but we need to save
2210 * space.) First, check whether we have too many router descriptors, total.
2211 * We're okay with having too many for some given router, so long as the
2212 * total number doesn't approach max_descriptors_per_router()*len(router).
2214 if (smartlist_len(routerlist
->old_routers
) <
2215 smartlist_len(routerlist
->routers
) * (max_descriptors_per_router() - 1))
2218 smartlist_sort(routerlist
->old_routers
, _compare_old_routers_by_identity
);
2220 /* Iterate through the list from back to front, so when we remove descriptors
2221 * we don't mess up groups we haven't gotten to. */
2222 for (i
= smartlist_len(routerlist
->old_routers
)-1; i
>= 0; --i
) {
2223 signed_descriptor_t
*r
= smartlist_get(routerlist
->old_routers
, i
);
2225 cur_id
= r
->identity_digest
;
2228 if (memcmp(cur_id
, r
->identity_digest
, DIGEST_LEN
)) {
2229 routerlist_remove_old_cached_routers_with_id(cutoff
, i
+1, hi
, retain
);
2230 cur_id
= r
->identity_digest
;
2235 routerlist_remove_old_cached_routers_with_id(cutoff
, 0, hi
, retain
);
2236 routerlist_assert_ok(routerlist
);
2239 digestmap_free(retain
, NULL
);
2243 * Code to parse a single router descriptor and insert it into the
2244 * routerlist. Return -1 if the descriptor was ill-formed; 0 if the
2245 * descriptor was well-formed but could not be added; and 1 if the
2246 * descriptor was added.
2248 * If we don't add it and <b>msg</b> is not NULL, then assign to
2249 * *<b>msg</b> a static string describing the reason for refusing the
2252 * This is used only by the controller.
2255 router_load_single_router(const char *s
, uint8_t purpose
, const char **msg
)
2263 if (!(ri
= router_parse_entry_from_string(s
, NULL
, 1))) {
2264 log_warn(LD_DIR
, "Error parsing router descriptor; dropping.");
2265 *msg
= "Couldn't parse router descriptor.";
2268 ri
->purpose
= purpose
;
2269 if (router_is_me(ri
)) {
2270 log_warn(LD_DIR
, "Router's identity key matches mine; dropping.");
2271 *msg
= "Router's identity key matches mine.";
2272 routerinfo_free(ri
);
2276 lst
= smartlist_create();
2277 smartlist_add(lst
, ri
);
2278 routers_update_status_from_networkstatus(lst
, 0);
2280 if ((r
=router_add_to_routerlist(ri
, msg
, 0, 0))<0) {
2281 /* we've already assigned to *msg now, and ri is already freed */
2284 log_warn(LD_DIR
, "Couldn't add router to list: %s Dropping.", *msg
);
2285 smartlist_free(lst
);
2288 control_event_descriptors_changed(lst
);
2289 smartlist_free(lst
);
2290 log_debug(LD_DIR
, "Added router to list");
2295 /** Given a string <b>s</b> containing some routerdescs, parse it and put the
2296 * routers into our directory. If saved_location is SAVED_NOWHERE, the routers
2297 * are in response to a query to the network: cache them by adding them to
2300 * If <b>requested_fingerprints</b> is provided, it must contain a list of
2301 * uppercased identity fingerprints. Do not update any router whose
2302 * fingerprint is not on the list; after updating a router, remove its
2303 * fingerprint from the list.
2306 router_load_routers_from_string(const char *s
, size_t len
,
2307 saved_location_t saved_location
,
2308 smartlist_t
*requested_fingerprints
)
2310 smartlist_t
*routers
= smartlist_create(), *changed
= smartlist_create();
2311 char fp
[HEX_DIGEST_LEN
+1];
2313 int from_cache
= (saved_location
!= SAVED_NOWHERE
);
2315 router_parse_list_from_string(&s
, s
+len
, routers
, saved_location
);
2317 routers_update_status_from_networkstatus(routers
, !from_cache
);
2319 log_info(LD_DIR
, "%d elements to add", smartlist_len(routers
));
2321 SMARTLIST_FOREACH(routers
, routerinfo_t
*, ri
,
2323 base16_encode(fp
, sizeof(fp
), ri
->cache_info
.signed_descriptor_digest
,
2325 if (requested_fingerprints
) {
2326 if (smartlist_string_isin(requested_fingerprints
, fp
)) {
2327 smartlist_string_remove(requested_fingerprints
, fp
);
2330 smartlist_join_strings(requested_fingerprints
," ",0,NULL
);
2332 "We received a router descriptor with a fingerprint (%s) "
2333 "that we never requested. (We asked for: %s.) Dropping.",
2335 tor_free(requested
);
2336 routerinfo_free(ri
);
2341 if (router_add_to_routerlist(ri
, &msg
, from_cache
, !from_cache
) >= 0)
2342 smartlist_add(changed
, ri
);
2345 if (smartlist_len(changed
))
2346 control_event_descriptors_changed(changed
);
2348 routerlist_assert_ok(routerlist
);
2349 router_rebuild_store(0);
2351 smartlist_free(routers
);
2352 smartlist_free(changed
);
2355 /** Helper: return a newly allocated string containing the name of the filename
2356 * where we plan to cache the network status with the given identity digest. */
2358 networkstatus_get_cache_filename(const char *identity_digest
)
2360 const char *datadir
= get_options()->DataDirectory
;
2361 size_t len
= strlen(datadir
)+64;
2362 char fp
[HEX_DIGEST_LEN
+1];
2363 char *fn
= tor_malloc(len
+1);
2364 base16_encode(fp
, HEX_DIGEST_LEN
+1, identity_digest
, DIGEST_LEN
);
2365 tor_snprintf(fn
, len
, "%s/cached-status/%s",datadir
,fp
);
2369 /** Helper for smartlist_sort: Compare two networkstatus objects by
2370 * publication date. */
2372 _compare_networkstatus_published_on(const void **_a
, const void **_b
)
2374 const networkstatus_t
*a
= *_a
, *b
= *_b
;
2375 if (a
->published_on
< b
->published_on
)
2377 else if (a
->published_on
> b
->published_on
)
2383 /** Add the parsed neworkstatus in <b>ns</b> (with original document in
2384 * <b>s</b> to the disk cache (and the in-memory directory server cache) as
2387 add_networkstatus_to_cache(const char *s
,
2388 networkstatus_source_t source
,
2389 networkstatus_t
*ns
)
2391 if (source
!= NS_FROM_CACHE
) {
2392 char *fn
= networkstatus_get_cache_filename(ns
->identity_digest
);
2393 if (write_str_to_file(fn
, s
, 0)<0) {
2394 log_notice(LD_FS
, "Couldn't write cached network status to \"%s\"", fn
);
2399 if (get_options()->DirPort
)
2400 dirserv_set_cached_networkstatus_v2(s
,
2401 ns
->identity_digest
,
2407 /** How far in the future do we allow a network-status to get before removing
2409 #define NETWORKSTATUS_ALLOW_SKEW (24*60*60)
2411 /** Given a string <b>s</b> containing a network status that we received at
2412 * <b>arrived_at</b> from <b>source</b>, try to parse it, see if we want to
2413 * store it, and put it into our cache as necessary.
2415 * If <b>source</b> is NS_FROM_DIR or NS_FROM_CACHE, do not replace our
2416 * own networkstatus_t (if we're an authoritative directory server).
2418 * If <b>source</b> is NS_FROM_CACHE, do not write our networkstatus_t to the
2421 * If <b>requested_fingerprints</b> is provided, it must contain a list of
2422 * uppercased identity fingerprints. Do not update any networkstatus whose
2423 * fingerprint is not on the list; after updating a networkstatus, remove its
2424 * fingerprint from the list.
2426 * Return 0 on success, -1 on failure.
2428 * Callers should make sure that routers_update_all_from_networkstatus() is
2429 * invoked after this function succeeds.
2432 router_set_networkstatus(const char *s
, time_t arrived_at
,
2433 networkstatus_source_t source
, smartlist_t
*requested_fingerprints
)
2435 networkstatus_t
*ns
;
2439 trusted_dir_server_t
*trusted_dir
= NULL
;
2440 const char *source_desc
= NULL
;
2441 char fp
[HEX_DIGEST_LEN
+1];
2442 char published
[ISO_TIME_LEN
+1];
2444 ns
= networkstatus_parse_from_string(s
);
2446 log_warn(LD_DIR
, "Couldn't parse network status.");
2449 base16_encode(fp
, HEX_DIGEST_LEN
+1, ns
->identity_digest
, DIGEST_LEN
);
2451 router_get_trusteddirserver_by_digest(ns
->identity_digest
)) ||
2452 !trusted_dir
->is_v2_authority
) {
2453 log_info(LD_DIR
, "Network status was signed, but not by an authoritative "
2454 "directory we recognize.");
2455 if (!get_options()->DirPort
) {
2456 networkstatus_free(ns
);
2461 source_desc
= trusted_dir
->description
;
2464 if (arrived_at
> now
)
2467 ns
->received_on
= arrived_at
;
2469 format_iso_time(published
, ns
->published_on
);
2471 if (ns
->published_on
> now
+ NETWORKSTATUS_ALLOW_SKEW
) {
2472 log_warn(LD_GENERAL
, "Network status from %s was published in the future "
2473 "(%s GMT). Somebody is skewed here: check your clock. "
2475 source_desc
, published
);
2476 control_event_general_status(LOG_WARN
,
2477 "CLOCK_SKEW SOURCE=NETWORKSTATUS:%s:%d",
2478 ns
->source_address
, ns
->source_dirport
);
2482 if (!networkstatus_list
)
2483 networkstatus_list
= smartlist_create();
2485 if ( (source
== NS_FROM_DIR_BY_FP
|| source
== NS_FROM_DIR_ALL
) &&
2486 router_digest_is_me(ns
->identity_digest
)) {
2487 /* Don't replace our own networkstatus when we get it from somebody else.*/
2488 networkstatus_free(ns
);
2492 if (requested_fingerprints
) {
2493 if (smartlist_string_isin(requested_fingerprints
, fp
)) {
2494 smartlist_string_remove(requested_fingerprints
, fp
);
2496 if (source
!= NS_FROM_DIR_ALL
) {
2498 smartlist_join_strings(requested_fingerprints
," ",0,NULL
);
2500 "We received a network status with a fingerprint (%s) that we "
2501 "never requested. (We asked for: %s.) Dropping.",
2503 tor_free(requested
);
2510 if (!skewed
&& get_options()->DirPort
) {
2511 /* We got a non-trusted networkstatus, and we're a directory cache.
2512 * This means that we asked an authority, and it told us about another
2513 * authority we didn't recognize. */
2515 "We do not recognize authority (%s) but we are willing "
2517 add_networkstatus_to_cache(s
, source
, ns
);
2518 networkstatus_free(ns
);
2524 for (i
=0; i
< smartlist_len(networkstatus_list
); ++i
) {
2525 networkstatus_t
*old_ns
= smartlist_get(networkstatus_list
, i
);
2527 if (!memcmp(old_ns
->identity_digest
, ns
->identity_digest
, DIGEST_LEN
)) {
2528 if (!memcmp(old_ns
->networkstatus_digest
,
2529 ns
->networkstatus_digest
, DIGEST_LEN
)) {
2530 /* Same one we had before. */
2531 networkstatus_free(ns
);
2532 tor_assert(trusted_dir
);
2534 "Not replacing network-status from %s (published %s); "
2535 "we already have it.",
2536 trusted_dir
->description
, published
);
2537 if (old_ns
->received_on
< arrived_at
) {
2538 if (source
!= NS_FROM_CACHE
) {
2540 fn
= networkstatus_get_cache_filename(old_ns
->identity_digest
);
2541 /* We use mtime to tell when it arrived, so update that. */
2545 old_ns
->received_on
= arrived_at
;
2547 ++trusted_dir
->n_networkstatus_failures
;
2549 } else if (old_ns
->published_on
>= ns
->published_on
) {
2550 char old_published
[ISO_TIME_LEN
+1];
2551 format_iso_time(old_published
, old_ns
->published_on
);
2552 tor_assert(trusted_dir
);
2554 "Not replacing network-status from %s (published %s);"
2555 " we have a newer one (published %s) for this authority.",
2556 trusted_dir
->description
, published
,
2558 networkstatus_free(ns
);
2559 ++trusted_dir
->n_networkstatus_failures
;
2562 networkstatus_free(old_ns
);
2563 smartlist_set(networkstatus_list
, i
, ns
);
2570 if (source
!= NS_FROM_CACHE
&& trusted_dir
)
2571 trusted_dir
->n_networkstatus_failures
= 0;
2574 smartlist_add(networkstatus_list
, ns
);
2576 SMARTLIST_FOREACH(ns
->entries
, routerstatus_t
*, rs
,
2578 if (!router_get_by_descriptor_digest(rs
->descriptor_digest
))
2579 rs
->need_to_mirror
= 1;
2582 log_info(LD_DIR
, "Setting networkstatus %s %s (published %s)",
2583 source
== NS_FROM_CACHE
?"cached from":
2584 ((source
== NS_FROM_DIR_BY_FP
|| source
== NS_FROM_DIR_ALL
) ?
2585 "downloaded from":"generated for"),
2586 trusted_dir
->description
, published
);
2587 networkstatus_list_has_changed
= 1;
2588 router_dir_info_changed();
2590 smartlist_sort(networkstatus_list
, _compare_networkstatus_published_on
);
2593 add_networkstatus_to_cache(s
, source
, ns
);
2595 networkstatus_list_update_recent(now
);
2600 /** How old do we allow a network-status to get before removing it
2602 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
2603 /** Remove all very-old network_status_t objects from memory and from the
2606 networkstatus_list_clean(time_t now
)
2609 if (!networkstatus_list
)
2612 for (i
= 0; i
< smartlist_len(networkstatus_list
); ++i
) {
2613 networkstatus_t
*ns
= smartlist_get(networkstatus_list
, i
);
2615 if (ns
->published_on
+ MAX_NETWORKSTATUS_AGE
> now
)
2617 /* Okay, this one is too old. Remove it from the list, and delete it
2618 * from the cache. */
2619 smartlist_del(networkstatus_list
, i
--);
2620 fname
= networkstatus_get_cache_filename(ns
->identity_digest
);
2621 if (file_status(fname
) == FN_FILE
) {
2622 log_info(LD_DIR
, "Removing too-old networkstatus in %s", fname
);
2626 if (get_options()->DirPort
) {
2627 dirserv_set_cached_networkstatus_v2(NULL
, ns
->identity_digest
, 0);
2629 networkstatus_free(ns
);
2630 router_dir_info_changed();
2633 /* And now go through the directory cache for any cached untrusted
2634 * networkstatuses and other network info. */
2635 dirserv_clear_old_networkstatuses(now
- MAX_NETWORKSTATUS_AGE
);
2636 dirserv_clear_old_v1_info(now
);
2639 /** Helper for bsearching a list of routerstatus_t pointers.*/
2641 _compare_digest_to_routerstatus_entry(const void *_key
, const void **_member
)
2643 const char *key
= _key
;
2644 const routerstatus_t
*rs
= *_member
;
2645 return memcmp(key
, rs
->identity_digest
, DIGEST_LEN
);
2648 /** Return the entry in <b>ns</b> for the identity digest <b>digest</b>, or
2649 * NULL if none was found. */
2650 static routerstatus_t
*
2651 networkstatus_find_entry(networkstatus_t
*ns
, const char *digest
)
2653 return smartlist_bsearch(ns
->entries
, digest
,
2654 _compare_digest_to_routerstatus_entry
);
2657 /** Return the consensus view of the status of the router whose digest is
2658 * <b>digest</b>, or NULL if we don't know about any such router. */
2659 local_routerstatus_t
*
2660 router_get_combined_status_by_digest(const char *digest
)
2662 if (!routerstatus_list
)
2664 return smartlist_bsearch(routerstatus_list
, digest
,
2665 _compare_digest_to_routerstatus_entry
);
2668 /** Return a newly allocated list of the local_routerstatus_t for all routers
2669 * where we believe that the digest of their current descriptor is some digest
2670 * listed in <b>digests</b>. */
2672 router_get_combined_status_by_descriptor_digests(smartlist_t
*digests
)
2675 smartlist_t
*result
;
2677 if (!routerstatus_list
)
2680 map
= digestmap_new();
2681 result
= smartlist_create();
2682 SMARTLIST_FOREACH(digests
, const char *, d
, digestmap_set(map
, d
, (void*)1));
2684 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, lrs
, {
2685 if (digestmap_get(map
, lrs
->status
.descriptor_digest
))
2686 smartlist_add(result
, lrs
);
2689 digestmap_free(map
, NULL
);
2693 /** Given a nickname (possibly verbose, possibly a hexadecimal digest), return
2694 * the corresponding local_routerstatus_t, or NULL if none exists. Warn the
2695 * user if <b>warn_if_unnamed</b> is set, and they have specified a router by
2696 * nickname, but the Named flag isn't set for that router. */
2697 static local_routerstatus_t
*
2698 router_get_combined_status_by_nickname(const char *nickname
,
2699 int warn_if_unnamed
)
2701 char digest
[DIGEST_LEN
];
2702 local_routerstatus_t
*best
=NULL
;
2703 smartlist_t
*matches
=NULL
;
2705 if (!routerstatus_list
|| !nickname
)
2708 if (nickname
[0] == '$') {
2709 if (base16_decode(digest
, DIGEST_LEN
, nickname
+1, strlen(nickname
))<0)
2711 return router_get_combined_status_by_digest(digest
);
2712 } else if (strlen(nickname
) == HEX_DIGEST_LEN
&&
2713 (base16_decode(digest
, DIGEST_LEN
, nickname
+1, strlen(nickname
))==0)) {
2714 return router_get_combined_status_by_digest(digest
);
2717 matches
= smartlist_create();
2718 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, lrs
,
2720 if (!strcasecmp(lrs
->status
.nickname
, nickname
)) {
2721 if (lrs
->status
.is_named
) {
2722 smartlist_free(matches
);
2725 smartlist_add(matches
, lrs
);
2731 if (smartlist_len(matches
)>1 && warn_if_unnamed
) {
2733 SMARTLIST_FOREACH(matches
, local_routerstatus_t
*, lrs
,
2735 if (! lrs
->name_lookup_warned
) {
2736 lrs
->name_lookup_warned
=1;
2741 log_warn(LD_CONFIG
,"There are multiple matches for the nickname \"%s\","
2742 " but none is listed as named by the directory authorites. "
2743 "Choosing one arbitrarily.", nickname
);
2745 } else if (warn_if_unnamed
&& best
&& !best
->name_lookup_warned
) {
2746 char fp
[HEX_DIGEST_LEN
+1];
2747 base16_encode(fp
, sizeof(fp
),
2748 best
->status
.identity_digest
, DIGEST_LEN
);
2750 "When looking up a status, you specified a server \"%s\" by name, "
2751 "but the directory authorities do not have any key registered for "
2752 "this nickname -- so it could be used by any server, "
2753 "not just the one you meant. "
2754 "To make sure you get the same server in the future, refer to "
2755 "it by key, as \"$%s\".", nickname
, fp
);
2756 best
->name_lookup_warned
= 1;
2758 smartlist_free(matches
);
2762 /** Find a routerstatus_t that corresponds to <b>hexdigest</b>, if
2763 * any. Prefer ones that belong to authorities. */
2765 routerstatus_get_by_hexdigest(const char *hexdigest
)
2767 char digest
[DIGEST_LEN
];
2768 local_routerstatus_t
*rs
;
2769 trusted_dir_server_t
*ds
;
2771 if (strlen(hexdigest
) < HEX_DIGEST_LEN
||
2772 base16_decode(digest
,DIGEST_LEN
,hexdigest
,HEX_DIGEST_LEN
) < 0)
2774 if ((ds
= router_get_trusteddirserver_by_digest(digest
)))
2775 return &(ds
->fake_status
.status
);
2776 if ((rs
= router_get_combined_status_by_digest(digest
)))
2777 return &(rs
->status
);
2781 /** Return true iff any networkstatus includes a descriptor whose digest
2782 * is that of <b>desc</b>. */
2784 signed_desc_digest_is_recognized(signed_descriptor_t
*desc
)
2787 if (!networkstatus_list
)
2790 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
2792 if (!(rs
= networkstatus_find_entry(ns
, desc
->identity_digest
)))
2794 if (!memcmp(rs
->descriptor_digest
,
2795 desc
->signed_descriptor_digest
, DIGEST_LEN
))
2801 /** How frequently do directory authorities re-download fresh networkstatus
2803 #define AUTHORITY_NS_CACHE_INTERVAL (5*60)
2805 /** How frequently do non-authority directory caches re-download fresh
2806 * networkstatus documents? */
2807 #define NONAUTHORITY_NS_CACHE_INTERVAL (15*60)
2809 /** We are a directory server, and so cache network_status documents.
2810 * Initiate downloads as needed to update them. For authorities, this means
2811 * asking each trusted directory for its network-status. For caches, this
2812 * means asking a random authority for all network-statuses.
2815 update_networkstatus_cache_downloads(time_t now
)
2817 int authority
= authdir_mode(get_options());
2819 authority
? AUTHORITY_NS_CACHE_INTERVAL
: NONAUTHORITY_NS_CACHE_INTERVAL
;
2821 if (last_networkstatus_download_attempted
+ interval
>= now
)
2823 if (!trusted_dir_servers
)
2826 last_networkstatus_download_attempted
= now
;
2829 /* An authority launches a separate connection for everybody. */
2830 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ds
,
2832 char resource
[HEX_DIGEST_LEN
+6]; /* fp/hexdigit.z\0 */
2833 if (!ds
->is_v2_authority
)
2835 if (router_digest_is_me(ds
->digest
))
2837 if (connection_get_by_type_addr_port_purpose(
2838 CONN_TYPE_DIR
, ds
->addr
, ds
->dir_port
,
2839 DIR_PURPOSE_FETCH_NETWORKSTATUS
)) {
2840 /* We are already fetching this one. */
2843 strlcpy(resource
, "fp/", sizeof(resource
));
2844 base16_encode(resource
+3, sizeof(resource
)-3, ds
->digest
, DIGEST_LEN
);
2845 strlcat(resource
, ".z", sizeof(resource
));
2846 directory_initiate_command_routerstatus(
2847 &ds
->fake_status
.status
, DIR_PURPOSE_FETCH_NETWORKSTATUS
,
2848 0, /* Not private */
2850 NULL
, 0 /* No payload. */);
2853 /* A non-authority cache launches one connection to a random authority. */
2854 /* (Check whether we're currently fetching network-status objects.) */
2855 if (!connection_get_by_type_purpose(CONN_TYPE_DIR
,
2856 DIR_PURPOSE_FETCH_NETWORKSTATUS
))
2857 directory_get_from_dirserver(DIR_PURPOSE_FETCH_NETWORKSTATUS
,"all.z",1);
2861 /** How long (in seconds) does a client wait after getting a network status
2862 * before downloading the next in sequence? */
2863 #define NETWORKSTATUS_CLIENT_DL_INTERVAL (30*60)
2864 /** How many times do we allow a networkstatus download to fail before we
2865 * assume that the authority isn't publishing? */
2866 #define NETWORKSTATUS_N_ALLOWABLE_FAILURES 3
2867 /** We are not a directory cache or authority. Update our network-status list
2868 * by launching a new directory fetch for enough network-status documents "as
2869 * necessary". See function comments for implementation details.
2872 update_networkstatus_client_downloads(time_t now
)
2874 int n_live
= 0, n_dirservers
, n_running_dirservers
, needed
= 0;
2875 int fetch_latest
= 0;
2876 int most_recent_idx
= -1;
2877 trusted_dir_server_t
*most_recent
= NULL
;
2878 time_t most_recent_received
= 0;
2879 char *resource
, *cp
;
2880 size_t resource_len
;
2881 smartlist_t
*missing
;
2883 if (connection_get_by_type_purpose(CONN_TYPE_DIR
,
2884 DIR_PURPOSE_FETCH_NETWORKSTATUS
))
2887 /* This is a little tricky. We want to download enough network-status
2888 * objects so that we have all of them under
2889 * NETWORKSTATUS_MAX_AGE publication time. We want to download a new
2890 * *one* if the most recent one's publication time is under
2891 * NETWORKSTATUS_CLIENT_DL_INTERVAL.
2893 if (!get_n_v2_authorities())
2895 n_dirservers
= n_running_dirservers
= 0;
2896 missing
= smartlist_create();
2897 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ds
,
2899 networkstatus_t
*ns
= networkstatus_get_by_digest(ds
->digest
);
2900 if (!ds
->is_v2_authority
)
2903 if (ds
->n_networkstatus_failures
> NETWORKSTATUS_N_ALLOWABLE_FAILURES
)
2905 ++n_running_dirservers
;
2906 if (ns
&& ns
->published_on
> now
-NETWORKSTATUS_MAX_AGE
)
2909 smartlist_add(missing
, ds
->digest
);
2910 if (ns
&& (!most_recent
|| ns
->received_on
> most_recent_received
)) {
2911 most_recent_idx
= ds_sl_idx
; /* magic variable from FOREACH */
2913 most_recent_received
= ns
->received_on
;
2917 /* Also, download at least 1 every NETWORKSTATUS_CLIENT_DL_INTERVAL. */
2918 if (!smartlist_len(missing
) &&
2919 most_recent_received
< now
-NETWORKSTATUS_CLIENT_DL_INTERVAL
) {
2920 log_info(LD_DIR
, "Our most recent network-status document (from %s) "
2921 "is %d seconds old; downloading another.",
2922 most_recent
?most_recent
->description
:"nobody",
2923 (int)(now
-most_recent_received
));
2926 } else if (smartlist_len(missing
)) {
2927 log_info(LD_DIR
, "For %d/%d running directory servers, we have %d live"
2928 " network-status documents. Downloading %d.",
2929 n_running_dirservers
, n_dirservers
, n_live
,
2930 smartlist_len(missing
));
2931 needed
= smartlist_len(missing
);
2933 smartlist_free(missing
);
2937 /* If no networkstatus was found, choose a dirserver at random as "most
2939 if (most_recent_idx
<0)
2940 most_recent_idx
= crypto_rand_int(smartlist_len(trusted_dir_servers
));
2945 for (i
= most_recent_idx
+ 1; 1; ++i
) {
2946 trusted_dir_server_t
*ds
;
2947 if (i
>= smartlist_len(trusted_dir_servers
))
2949 ds
= smartlist_get(trusted_dir_servers
, i
);
2950 if (! ds
->is_v2_authority
)
2952 if (n_failed
>= n_dirservers
) {
2953 log_info(LD_DIR
, "All authorities have failed. Not trying any.");
2954 smartlist_free(missing
);
2957 if (ds
->n_networkstatus_failures
> NETWORKSTATUS_N_ALLOWABLE_FAILURES
) {
2961 smartlist_add(missing
, ds
->digest
);
2966 /* Build a request string for all the resources we want. */
2967 resource_len
= smartlist_len(missing
) * (HEX_DIGEST_LEN
+1) + 6;
2968 resource
= tor_malloc(resource_len
);
2969 memcpy(resource
, "fp/", 3);
2971 smartlist_sort_digests(missing
);
2972 needed
= smartlist_len(missing
);
2973 SMARTLIST_FOREACH(missing
, const char *, d
,
2975 base16_encode(cp
, HEX_DIGEST_LEN
+1, d
, DIGEST_LEN
);
2976 cp
+= HEX_DIGEST_LEN
;
2981 memcpy(cp
, ".z", 3);
2982 directory_get_from_dirserver(DIR_PURPOSE_FETCH_NETWORKSTATUS
, resource
, 1);
2984 smartlist_free(missing
);
2987 /** Launch requests for networkstatus documents as appropriate. */
2989 update_networkstatus_downloads(time_t now
)
2991 or_options_t
*options
= get_options();
2992 if (options
->DirPort
)
2993 update_networkstatus_cache_downloads(now
);
2995 update_networkstatus_client_downloads(now
);
2998 /** Return 1 if all running sufficiently-stable routers will reject
2999 * addr:port, return 0 if any might accept it. */
3001 router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
3004 addr_policy_result_t r
;
3005 if (!routerlist
) return 1;
3007 SMARTLIST_FOREACH(routerlist
->routers
, routerinfo_t
*, router
,
3009 if (router
->is_running
&&
3010 !router_is_unreliable(router
, need_uptime
, 0, 0)) {
3011 r
= compare_addr_to_addr_policy(addr
, port
, router
->exit_policy
);
3012 if (r
!= ADDR_POLICY_REJECTED
&& r
!= ADDR_POLICY_PROBABLY_REJECTED
)
3013 return 0; /* this one could be ok. good enough. */
3016 return 1; /* all will reject. */
3019 /** Return true iff <b>router</b> does not permit exit streams.
3022 router_exit_policy_rejects_all(routerinfo_t
*router
)
3024 return compare_addr_to_addr_policy(0, 0, router
->exit_policy
)
3025 == ADDR_POLICY_REJECTED
;
3028 /** Add to the list of authorized directory servers one at
3029 * <b>address</b>:<b>port</b>, with identity key <b>digest</b>. If
3030 * <b>address</b> is NULL, add ourself. */
3032 add_trusted_dir_server(const char *nickname
, const char *address
,
3033 uint16_t dir_port
, uint16_t or_port
,
3034 const char *digest
, int is_v1_authority
,
3035 int is_v2_authority
, int is_hidserv_authority
)
3037 trusted_dir_server_t
*ent
;
3039 char *hostname
= NULL
;
3041 if (!trusted_dir_servers
)
3042 trusted_dir_servers
= smartlist_create();
3044 if (!address
) { /* The address is us; we should guess. */
3045 if (resolve_my_address(LOG_WARN
, get_options(), &a
, &hostname
) < 0) {
3047 "Couldn't find a suitable address when adding ourself as a "
3048 "trusted directory server.");
3052 if (tor_lookup_hostname(address
, &a
)) {
3054 "Unable to lookup address for directory server at '%s'",
3058 hostname
= tor_strdup(address
);
3062 ent
= tor_malloc_zero(sizeof(trusted_dir_server_t
));
3063 ent
->nickname
= nickname
? tor_strdup(nickname
) : NULL
;
3064 ent
->address
= hostname
;
3066 ent
->dir_port
= dir_port
;
3067 ent
->or_port
= or_port
;
3068 ent
->is_running
= 1;
3069 ent
->is_v1_authority
= is_v1_authority
;
3070 ent
->is_v2_authority
= is_v2_authority
;
3071 ent
->is_hidserv_authority
= is_hidserv_authority
;
3072 memcpy(ent
->digest
, digest
, DIGEST_LEN
);
3074 dlen
= 64 + strlen(hostname
) + (nickname
?strlen(nickname
):0);
3075 ent
->description
= tor_malloc(dlen
);
3077 tor_snprintf(ent
->description
, dlen
, "directory server \"%s\" at %s:%d",
3078 nickname
, hostname
, (int)dir_port
);
3080 tor_snprintf(ent
->description
, dlen
, "directory server at %s:%d",
3081 hostname
, (int)dir_port
);
3083 ent
->fake_status
.status
.addr
= ent
->addr
;
3084 memcpy(ent
->fake_status
.status
.identity_digest
, digest
, DIGEST_LEN
);
3086 strlcpy(ent
->fake_status
.status
.nickname
, nickname
,
3087 sizeof(ent
->fake_status
.status
.nickname
));
3089 ent
->fake_status
.status
.nickname
[0] = '\0';
3090 ent
->fake_status
.status
.dir_port
= ent
->dir_port
;
3091 ent
->fake_status
.status
.or_port
= ent
->or_port
;
3093 smartlist_add(trusted_dir_servers
, ent
);
3094 router_dir_info_changed();
3097 /** Free storage held in <b>ds</b> */
3099 trusted_dir_server_free(trusted_dir_server_t
*ds
)
3101 tor_free(ds
->nickname
);
3102 tor_free(ds
->description
);
3103 tor_free(ds
->address
);
3107 /** Remove all members from the list of trusted dir servers. */
3109 clear_trusted_dir_servers(void)
3111 if (trusted_dir_servers
) {
3112 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ent
,
3113 trusted_dir_server_free(ent
));
3114 smartlist_clear(trusted_dir_servers
);
3116 trusted_dir_servers
= smartlist_create();
3118 router_dir_info_changed();
3121 /** Return 1 if any trusted dir server supports v1 directories,
3124 any_trusted_dir_is_v1_authority(void)
3126 if (trusted_dir_servers
)
3127 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ent
,
3128 if (ent
->is_v1_authority
) return 1);
3132 /** Return the network status with a given identity digest. */
3134 networkstatus_get_by_digest(const char *digest
)
3136 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
3138 if (!memcmp(ns
->identity_digest
, digest
, DIGEST_LEN
))
3144 /** We believe networkstatuses more recent than this when they tell us that
3145 * our server is broken, invalid, obsolete, etc. */
3146 #define SELF_OPINION_INTERVAL (90*60)
3148 /** Result of checking whether a version is recommended. */
3149 typedef struct combined_version_status_t
{
3150 /** How many networkstatuses claim to know about versions? */
3152 /** What do the majority of networkstatuses believe about this version? */
3153 version_status_t consensus
;
3154 /** How many networkstatuses constitute the majority? */
3156 } combined_version_status_t
;
3158 /** Return a string naming the versions of Tor recommended by
3159 * more than half the versioning networkstatuses. */
3161 compute_recommended_versions(time_t now
, int client
,
3162 const char *my_version
,
3163 combined_version_status_t
*status_out
)
3167 smartlist_t
*combined
, *recommended
;
3168 int n_versioning
, n_recommending
;
3170 /** holds the compromise status taken among all non-recommending
3172 version_status_t consensus
= VS_RECOMMENDED
;
3173 (void) now
; /* right now, we consider *all* statuses, regardless of age. */
3175 tor_assert(my_version
);
3176 tor_assert(status_out
);
3178 memset(status_out
, 0, sizeof(combined_version_status_t
));
3180 if (!networkstatus_list
)
3181 return tor_strdup("<none>");
3183 combined
= smartlist_create();
3184 n_versioning
= n_recommending
= 0;
3185 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
3188 smartlist_t
*versions
;
3189 version_status_t status
;
3190 if (! ns
->recommends_versions
)
3193 vers
= client
? ns
->client_versions
: ns
->server_versions
;
3196 versions
= smartlist_create();
3197 smartlist_split_string(versions
, vers
, ",",
3198 SPLIT_SKIP_SPACE
|SPLIT_IGNORE_BLANK
, 0);
3199 sort_version_list(versions
, 1);
3200 smartlist_add_all(combined
, versions
);
3201 smartlist_free(versions
);
3203 /* now, check _our_ version */
3204 status
= tor_version_is_obsolete(my_version
, vers
);
3205 if (status
== VS_RECOMMENDED
)
3207 consensus
= version_status_join(status
, consensus
);
3210 sort_version_list(combined
, 0);
3214 recommended
= smartlist_create();
3215 SMARTLIST_FOREACH(combined
, char *, cp
,
3217 if (current
&& !strcmp(cp
, current
)) {
3220 if (n_seen
> n_versioning
/2 && current
)
3221 smartlist_add(recommended
, current
);
3226 if (n_seen
> n_versioning
/2 && current
)
3227 smartlist_add(recommended
, current
);
3229 result
= smartlist_join_strings(recommended
, ", ", 0, NULL
);
3231 SMARTLIST_FOREACH(combined
, char *, cp
, tor_free(cp
));
3232 smartlist_free(combined
);
3233 smartlist_free(recommended
);
3235 status_out
->n_versioning
= n_versioning
;
3236 if (n_recommending
> n_versioning
/2) {
3237 status_out
->consensus
= VS_RECOMMENDED
;
3238 status_out
->n_concurring
= n_recommending
;
3240 status_out
->consensus
= consensus
;
3241 status_out
->n_concurring
= n_versioning
- n_recommending
;
3247 /** How many times do we have to fail at getting a networkstatus we can't find
3248 * before we're willing to believe it's okay to set up router statuses? */
3249 #define N_NS_ATTEMPTS_TO_SET_ROUTERS 4
3250 /** How many times do we have to fail at getting a networkstatus we can't find
3251 * before we're willing to believe it's okay to check our version? */
3252 #define N_NS_ATTEMPTS_TO_CHECK_VERSION 4
3254 /** If the network-status list has changed since the last time we called this
3255 * function, update the status of every routerinfo from the network-status
3259 routers_update_all_from_networkstatus(void)
3263 if (!routerlist
|| !networkstatus_list
||
3264 (!networkstatus_list_has_changed
&& !routerstatus_list_has_changed
))
3267 router_dir_info_changed();
3270 if (networkstatus_list_has_changed
)
3271 routerstatus_list_update_from_networkstatus(now
);
3273 routers_update_status_from_networkstatus(routerlist
->routers
, 0);
3275 me
= router_get_my_routerinfo();
3276 if (me
&& !have_warned_about_invalid_status
&&
3277 have_tried_downloading_all_statuses(N_NS_ATTEMPTS_TO_SET_ROUTERS
)) {
3278 int n_recent
= 0, n_listing
= 0, n_valid
= 0, n_named
= 0, n_naming
= 0;
3280 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
3282 if (ns
->received_on
+ SELF_OPINION_INTERVAL
< now
)
3285 if (ns
->binds_names
)
3287 if (!(rs
= networkstatus_find_entry(ns
, me
->cache_info
.identity_digest
)))
3297 if (n_valid
<= n_listing
/2) {
3298 log_info(LD_GENERAL
,
3299 "%d/%d recent statements from directory authorities list us "
3300 "as unapproved. Are you misconfigured?",
3301 n_listing
-n_valid
, n_listing
);
3302 have_warned_about_invalid_status
= 1;
3303 } else if (n_naming
&& !n_named
) {
3304 log_info(LD_GENERAL
, "0/%d name-binding directory authorities "
3305 "recognize your nickname. Please consider sending your "
3306 "nickname and identity fingerprint to the tor-ops.",
3308 have_warned_about_invalid_status
= 1;
3313 entry_guards_compute_status();
3315 if (!have_warned_about_old_version
&&
3316 have_tried_downloading_all_statuses(N_NS_ATTEMPTS_TO_CHECK_VERSION
)) {
3317 combined_version_status_t st
;
3318 int is_server
= server_mode(get_options());
3321 recommended
= compute_recommended_versions(now
, !is_server
, VERSION
, &st
);
3323 if (st
.n_versioning
) {
3324 if (st
.consensus
== VS_RECOMMENDED
) {
3325 log_info(LD_GENERAL
, "%d/%d statements from version-listing "
3326 "directory authorities say my version is ok.",
3327 st
.n_concurring
, st
.n_versioning
);
3328 } else if (st
.consensus
== VS_NEW
|| st
.consensus
== VS_NEW_IN_SERIES
) {
3329 if (!have_warned_about_new_version
) {
3330 log_notice(LD_GENERAL
, "This version of Tor (%s) is newer than any "
3331 "recommended version%s, according to %d/%d version-listing "
3332 "network statuses. Versions recommended by more than %d "
3333 "authorit%s are: %s",
3335 st
.consensus
== VS_NEW_IN_SERIES
? " in its series" : "",
3336 st
.n_concurring
, st
.n_versioning
, st
.n_versioning
/2,
3337 st
.n_versioning
/2 > 1 ? "ies" : "y", recommended
);
3338 have_warned_about_new_version
= 1;
3339 control_event_general_status(LOG_WARN
, "DANGEROUS_VERSION "
3340 "CURRENT=%s REASON=%s RECOMMENDED=\"%s\"",
3341 VERSION
, "NEW", recommended
);
3344 log_warn(LD_GENERAL
, "Please upgrade! "
3345 "This version of Tor (%s) is %s, according to %d/%d version-"
3346 "listing network statuses. Versions recommended by "
3347 "at least %d authorit%s are: %s",
3349 st
.consensus
== VS_OLD
? "obsolete" : "not recommended",
3350 st
.n_concurring
, st
.n_versioning
, st
.n_versioning
/2,
3351 st
.n_versioning
/2 > 1 ? "ies" : "y", recommended
);
3352 have_warned_about_old_version
= 1;
3353 control_event_general_status(LOG_WARN
, "DANGEROUS_VERSION "
3354 "CURRENT=%s REASON=%s RECOMMENDED=\"%s\"",
3355 VERSION
, st
.consensus
== VS_OLD
? "OLD" : "UNRECOMMENDED",
3359 tor_free(recommended
);
3362 routerstatus_list_has_changed
= 0;
3365 /** Allow any network-status newer than this to influence our view of who's
3367 #define DEFAULT_RUNNING_INTERVAL (60*60)
3368 /** If possible, always allow at least this many network-statuses to influence
3369 * our view of who's running. */
3370 #define MIN_TO_INFLUENCE_RUNNING 3
3372 /** Change the is_recent field of each member of networkstatus_list so that
3373 * all members more recent than DEFAULT_RUNNING_INTERVAL are recent, and
3374 * at least the MIN_TO_INFLUENCE_RUNNING most recent members are recent, and no
3375 * others are recent. Set networkstatus_list_has_changed if anything happened.
3378 networkstatus_list_update_recent(time_t now
)
3380 int n_statuses
, n_recent
, changed
, i
;
3381 char published
[ISO_TIME_LEN
+1];
3383 if (!networkstatus_list
)
3386 n_statuses
= smartlist_len(networkstatus_list
);
3389 for (i
=n_statuses
-1; i
>= 0; --i
) {
3390 networkstatus_t
*ns
= smartlist_get(networkstatus_list
, i
);
3391 trusted_dir_server_t
*ds
=
3392 router_get_trusteddirserver_by_digest(ns
->identity_digest
);
3393 const char *src
= ds
?ds
->description
:ns
->source_address
;
3394 if (n_recent
< MIN_TO_INFLUENCE_RUNNING
||
3395 ns
->published_on
+ DEFAULT_RUNNING_INTERVAL
> now
) {
3396 if (!ns
->is_recent
) {
3397 format_iso_time(published
, ns
->published_on
);
3399 "Networkstatus from %s (published %s) is now \"recent\"",
3406 if (ns
->is_recent
) {
3407 format_iso_time(published
, ns
->published_on
);
3409 "Networkstatus from %s (published %s) is "
3410 "no longer \"recent\"",
3418 networkstatus_list_has_changed
= 1;
3419 router_dir_info_changed();
3423 /** Helper for routerstatus_list_update_from_networkstatus: remember how many
3424 * authorities recommend a given descriptor digest. */
3428 } desc_digest_count_t
;
3430 /** Update our view of router status (as stored in routerstatus_list) from the
3431 * current set of network status documents (as stored in networkstatus_list).
3432 * Do nothing unless the network status list has changed since the last time
3433 * this function was called.
3436 routerstatus_list_update_from_networkstatus(time_t now
)
3438 or_options_t
*options
= get_options();
3439 int n_trusted
, n_statuses
, n_recent
= 0, n_naming
= 0;
3440 int n_listing_bad_exits
= 0, n_listing_bad_directories
= 0;
3443 networkstatus_t
**networkstatus
;
3444 smartlist_t
*result
, *changed_list
;
3446 char conflict
[DIGEST_LEN
]; /* Sentinel value */
3447 desc_digest_count_t
*digest_counts
= NULL
;
3449 /* compute which network statuses will have a vote now */
3450 networkstatus_list_update_recent(now
);
3451 router_dir_info_changed();
3453 if (!networkstatus_list_has_changed
)
3455 if (!networkstatus_list
)
3456 networkstatus_list
= smartlist_create();
3457 if (!routerstatus_list
)
3458 routerstatus_list
= smartlist_create();
3459 if (!trusted_dir_servers
)
3460 trusted_dir_servers
= smartlist_create();
3461 if (!warned_conflicts
)
3462 warned_conflicts
= smartlist_create();
3464 n_statuses
= smartlist_len(networkstatus_list
);
3465 n_trusted
= get_n_v2_authorities();
3467 if (n_statuses
<= n_trusted
/2) {
3468 /* Not enough statuses to adjust status. */
3470 "Not enough statuses to update router status list. (%d/%d)",
3471 n_statuses
, n_trusted
);
3475 log_info(LD_DIR
, "Rebuilding router status list.");
3477 index
= tor_malloc(sizeof(int)*n_statuses
);
3478 size
= tor_malloc(sizeof(int)*n_statuses
);
3479 networkstatus
= tor_malloc(sizeof(networkstatus_t
*)*n_statuses
);
3480 for (i
= 0; i
< n_statuses
; ++i
) {
3482 networkstatus
[i
] = smartlist_get(networkstatus_list
, i
);
3483 size
[i
] = smartlist_len(networkstatus
[i
]->entries
);
3484 if (networkstatus
[i
]->binds_names
)
3486 if (networkstatus
[i
]->is_recent
)
3488 if (networkstatus
[i
]->lists_bad_exits
)
3489 ++n_listing_bad_exits
;
3490 if (networkstatus
[i
]->lists_bad_directories
)
3491 ++n_listing_bad_directories
;
3494 /** Iterate over all entries in all networkstatuses, and build
3495 * name_map as a map from lc nickname to identity digest. If there
3496 * is a conflict on that nickname, map the lc nickname to conflict.
3498 name_map
= strmap_new();
3499 /* Clear the global map... */
3500 if (named_server_map
)
3501 strmap_free(named_server_map
, _tor_free
);
3502 named_server_map
= strmap_new();
3503 memset(conflict
, 0xff, sizeof(conflict
));
3504 for (i
= 0; i
< n_statuses
; ++i
) {
3505 if (!networkstatus
[i
]->binds_names
)
3507 SMARTLIST_FOREACH(networkstatus
[i
]->entries
, routerstatus_t
*, rs
,
3509 const char *other_digest
;
3512 other_digest
= strmap_get_lc(name_map
, rs
->nickname
);
3513 warned
= smartlist_string_isin(warned_conflicts
, rs
->nickname
);
3514 if (!other_digest
) {
3515 strmap_set_lc(name_map
, rs
->nickname
, rs
->identity_digest
);
3516 strmap_set_lc(named_server_map
, rs
->nickname
,
3517 tor_memdup(rs
->identity_digest
, DIGEST_LEN
));
3519 smartlist_string_remove(warned_conflicts
, rs
->nickname
);
3520 } else if (memcmp(other_digest
, rs
->identity_digest
, DIGEST_LEN
) &&
3521 other_digest
!= conflict
) {
3524 int should_warn
= options
->DirPort
&& options
->AuthoritativeDir
;
3525 char fp1
[HEX_DIGEST_LEN
+1];
3526 char fp2
[HEX_DIGEST_LEN
+1];
3527 base16_encode(fp1
, sizeof(fp1
), other_digest
, DIGEST_LEN
);
3528 base16_encode(fp2
, sizeof(fp2
), rs
->identity_digest
, DIGEST_LEN
);
3529 log_fn(should_warn
? LOG_WARN
: LOG_INFO
, LD_DIR
,
3530 "Naming authorities disagree about which key goes with %s. "
3532 rs
->nickname
, fp1
, fp2
);
3533 strmap_set_lc(name_map
, rs
->nickname
, conflict
);
3534 d
= strmap_remove_lc(named_server_map
, rs
->nickname
);
3536 smartlist_add(warned_conflicts
, tor_strdup(rs
->nickname
));
3540 smartlist_string_remove(warned_conflicts
, rs
->nickname
);
3545 result
= smartlist_create();
3546 changed_list
= smartlist_create();
3547 digest_counts
= tor_malloc_zero(sizeof(desc_digest_count_t
)*n_statuses
);
3549 /* Iterate through all of the sorted routerstatus lists in lockstep.
3551 * - For 0 <= i < n_statuses: index[i] is an index into
3552 * networkstatus[i]->entries, which has size[i] elements.
3553 * - For i1, i2, j such that 0 <= i1 < n_statuses, 0 <= i2 < n_statues, 0 <=
3554 * j < index[i1]: networkstatus[i1]->entries[j]->identity_digest <
3555 * networkstatus[i2]->entries[index[i2]]->identity_digest.
3557 * (That is, the indices are always advanced past lower digest before
3561 int n_running
=0, n_named
=0, n_valid
=0, n_listing
=0;
3562 int n_v2_dir
=0, n_fast
=0, n_stable
=0, n_exit
=0, n_guard
=0, n_bad_exit
=0;
3563 int n_bad_directory
=0;
3564 int n_version_known
=0, n_supports_begindir
=0;
3565 int n_desc_digests
=0, highest_count
=0;
3566 const char *the_name
= NULL
;
3567 local_routerstatus_t
*rs_out
, *rs_old
;
3568 routerstatus_t
*rs
, *most_recent
;
3569 networkstatus_t
*ns
;
3570 const char *lowest
= NULL
;
3572 /* Find out which of the digests appears first. */
3573 for (i
= 0; i
< n_statuses
; ++i
) {
3574 if (index
[i
] < size
[i
]) {
3575 rs
= smartlist_get(networkstatus
[i
]->entries
, index
[i
]);
3576 if (!lowest
|| memcmp(rs
->identity_digest
, lowest
, DIGEST_LEN
)<0)
3577 lowest
= rs
->identity_digest
;
3581 /* We're out of routers. Great! */
3584 /* Okay. The routers at networkstatus[i]->entries[index[i]] whose digests
3585 * match "lowest" are next in order. Iterate over them, incrementing those
3586 * index[i] as we go. */
3587 for (i
= 0; i
< n_statuses
; ++i
) {
3588 if (index
[i
] >= size
[i
])
3590 ns
= networkstatus
[i
];
3591 rs
= smartlist_get(ns
->entries
, index
[i
]);
3592 if (memcmp(rs
->identity_digest
, lowest
, DIGEST_LEN
))
3594 /* At this point, we know that we're looking at a routersatus with
3595 * identity "lowest".
3599 /* Should we name this router? Only if all the names from naming
3600 * authorities match. */
3601 if (rs
->is_named
&& ns
->binds_names
) {
3603 the_name
= rs
->nickname
;
3604 if (!strcasecmp(rs
->nickname
, the_name
)) {
3606 } else if (strcmp(the_name
,"**mismatch**")) {
3607 char hd
[HEX_DIGEST_LEN
+1];
3608 base16_encode(hd
, HEX_DIGEST_LEN
+1, rs
->identity_digest
, DIGEST_LEN
);
3609 if (! smartlist_string_isin(warned_conflicts
, hd
)) {
3611 "Naming authorities disagree about nicknames for $%s "
3612 "(\"%s\" vs \"%s\")",
3613 hd
, the_name
, rs
->nickname
);
3614 smartlist_add(warned_conflicts
, tor_strdup(hd
));
3616 the_name
= "**mismatch**";
3619 /* Keep a running count of how often which descriptor digests
3621 for (j
= 0; j
< n_desc_digests
; ++j
) {
3622 if (!memcmp(rs
->descriptor_digest
,
3623 digest_counts
[j
].rs
->descriptor_digest
, DIGEST_LEN
)) {
3624 if (++digest_counts
[j
].count
> highest_count
)
3625 highest_count
= digest_counts
[j
].count
;
3629 digest_counts
[n_desc_digests
].rs
= rs
;
3630 digest_counts
[n_desc_digests
].count
= 1;
3635 /* Now tally up the easily-tallied flags. */
3638 if (rs
->is_running
&& ns
->is_recent
)
3644 if (rs
->is_possible_guard
)
3650 if (rs
->is_bad_exit
)
3652 if (rs
->is_bad_directory
)
3654 if (rs
->version_known
)
3656 if (rs
->version_supports_begindir
)
3657 ++n_supports_begindir
;
3659 /* Go over the descriptor digests and figure out which descriptor we
3662 for (i
= 0; i
< n_desc_digests
; ++i
) {
3663 /* If any digest appears twice or more, ignore those that don't.*/
3664 if (highest_count
>= 2 && digest_counts
[i
].count
< 2)
3667 digest_counts
[i
].rs
->published_on
> most_recent
->published_on
)
3668 most_recent
= digest_counts
[i
].rs
;
3670 rs_out
= tor_malloc_zero(sizeof(local_routerstatus_t
));
3671 memcpy(&rs_out
->status
, most_recent
, sizeof(routerstatus_t
));
3672 /* Copy status info about this router, if we had any before. */
3673 if ((rs_old
= router_get_combined_status_by_digest(lowest
))) {
3674 if (!memcmp(rs_out
->status
.descriptor_digest
,
3675 most_recent
->descriptor_digest
, DIGEST_LEN
)) {
3676 rs_out
->n_download_failures
= rs_old
->n_download_failures
;
3677 rs_out
->next_attempt_at
= rs_old
->next_attempt_at
;
3679 rs_out
->name_lookup_warned
= rs_old
->name_lookup_warned
;
3680 rs_out
->last_dir_503_at
= rs_old
->last_dir_503_at
;
3682 smartlist_add(result
, rs_out
);
3683 log_debug(LD_DIR
, "Router '%s' is listed by %d/%d directories, "
3684 "named by %d/%d, validated by %d/%d, and %d/%d recent "
3685 "directories think it's running.",
3686 rs_out
->status
.nickname
,
3687 n_listing
, n_statuses
, n_named
, n_naming
, n_valid
, n_statuses
,
3688 n_running
, n_recent
);
3689 rs_out
->status
.is_named
= 0;
3690 if (the_name
&& strcmp(the_name
, "**mismatch**") && n_named
> 0) {
3691 const char *d
= strmap_get_lc(name_map
, the_name
);
3692 if (d
&& d
!= conflict
)
3693 rs_out
->status
.is_named
= 1;
3694 if (smartlist_string_isin(warned_conflicts
, rs_out
->status
.nickname
))
3695 smartlist_string_remove(warned_conflicts
, rs_out
->status
.nickname
);
3697 if (rs_out
->status
.is_named
)
3698 strlcpy(rs_out
->status
.nickname
, the_name
,
3699 sizeof(rs_out
->status
.nickname
));
3700 rs_out
->status
.is_valid
= n_valid
> n_statuses
/2;
3701 rs_out
->status
.is_running
= n_running
> n_recent
/2;
3702 rs_out
->status
.is_exit
= n_exit
> n_statuses
/2;
3703 rs_out
->status
.is_fast
= n_fast
> n_statuses
/2;
3704 rs_out
->status
.is_possible_guard
= n_guard
> n_statuses
/2;
3705 rs_out
->status
.is_stable
= n_stable
> n_statuses
/2;
3706 rs_out
->status
.is_v2_dir
= n_v2_dir
> n_statuses
/2;
3707 rs_out
->status
.is_bad_exit
= n_bad_exit
> n_listing_bad_exits
/2;
3708 rs_out
->status
.is_bad_directory
=
3709 n_bad_directory
> n_listing_bad_directories
/2;
3710 rs_out
->status
.version_known
= n_version_known
> 0;
3711 rs_out
->status
.version_supports_begindir
=
3712 n_supports_begindir
> n_version_known
/2;
3713 if (!rs_old
|| memcmp(rs_old
, rs_out
, sizeof(local_routerstatus_t
)))
3714 smartlist_add(changed_list
, rs_out
);
3716 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, rs
,
3717 local_routerstatus_free(rs
));
3719 smartlist_free(routerstatus_list
);
3720 routerstatus_list
= result
;
3722 tor_free(networkstatus
);
3725 tor_free(digest_counts
);
3726 strmap_free(name_map
, NULL
);
3728 networkstatus_list_has_changed
= 0;
3729 routerstatus_list_has_changed
= 1;
3731 control_event_networkstatus_changed(changed_list
);
3732 smartlist_free(changed_list
);
3735 /** Given a list <b>routers</b> of routerinfo_t *, update each routers's
3736 * is_named, is_valid, and is_running fields according to our current
3737 * networkstatus_t documents. */
3739 routers_update_status_from_networkstatus(smartlist_t
*routers
,
3742 trusted_dir_server_t
*ds
;
3743 local_routerstatus_t
*rs
;
3744 or_options_t
*options
= get_options();
3745 int authdir
= options
->AuthoritativeDir
;
3746 int namingdir
= options
->AuthoritativeDir
&&
3747 options
->NamingAuthoritativeDir
;
3749 if (!routerstatus_list
)
3752 SMARTLIST_FOREACH(routers
, routerinfo_t
*, router
,
3754 const char *digest
= router
->cache_info
.identity_digest
;
3755 rs
= router_get_combined_status_by_digest(digest
);
3756 ds
= router_get_trusteddirserver_by_digest(digest
);
3762 router
->is_named
= rs
->status
.is_named
;
3765 /* If we're not an authdir, believe others. */
3766 router
->is_valid
= rs
->status
.is_valid
;
3767 router
->is_running
= rs
->status
.is_running
;
3768 router
->is_fast
= rs
->status
.is_fast
;
3769 router
->is_stable
= rs
->status
.is_stable
;
3770 router
->is_possible_guard
= rs
->status
.is_possible_guard
;
3771 router
->is_exit
= rs
->status
.is_exit
;
3772 router
->is_bad_exit
= rs
->status
.is_bad_exit
;
3774 if (router
->is_running
&& ds
) {
3775 ds
->n_networkstatus_failures
= 0;
3777 if (reset_failures
) {
3778 rs
->n_download_failures
= 0;
3779 rs
->next_attempt_at
= 0;
3782 router_dir_info_changed();
3785 /** For every router descriptor we are currently downloading by descriptor
3786 * digest, set result[d] to 1. */
3788 list_pending_descriptor_downloads(digestmap_t
*result
)
3790 const char *prefix
= "d/";
3791 size_t p_len
= strlen(prefix
);
3793 connection_t
**carray
;
3794 smartlist_t
*tmp
= smartlist_create();
3797 get_connection_array(&carray
, &n_conns
);
3799 for (i
= 0; i
< n_conns
; ++i
) {
3800 connection_t
*conn
= carray
[i
];
3801 if (conn
->type
== CONN_TYPE_DIR
&&
3802 conn
->purpose
== DIR_PURPOSE_FETCH_SERVERDESC
&&
3803 !conn
->marked_for_close
) {
3804 const char *resource
= TO_DIR_CONN(conn
)->requested_resource
;
3805 if (!strcmpstart(resource
, prefix
))
3806 dir_split_resource_into_fingerprints(resource
+ p_len
,
3810 SMARTLIST_FOREACH(tmp
, char *, d
,
3812 digestmap_set(result
, d
, (void*)1);
3815 smartlist_free(tmp
);
3818 /** Launch downloads for all the descriptors whose digests are listed
3819 * as digests[i] for lo <= i < hi. (Lo and hi may be out of range.)
3820 * If <b>source</b> is given, download from <b>source</b>; otherwise,
3821 * download from an appropriate random directory server.
3824 initiate_descriptor_downloads(routerstatus_t
*source
,
3825 smartlist_t
*digests
,
3829 char *resource
, *cp
;
3835 if (hi
> smartlist_len(digests
))
3836 hi
= smartlist_len(digests
);
3838 r_len
= 8 + (HEX_DIGEST_LEN
+1)*n
;
3839 cp
= resource
= tor_malloc(r_len
);
3840 memcpy(cp
, "d/", 2);
3842 for (i
= lo
; i
< hi
; ++i
) {
3843 base16_encode(cp
, r_len
-(cp
-resource
),
3844 smartlist_get(digests
,i
), DIGEST_LEN
);
3845 cp
+= HEX_DIGEST_LEN
;
3848 memcpy(cp
-1, ".z", 3);
3851 /* We know which authority we want. */
3852 directory_initiate_command_routerstatus(source
,
3853 DIR_PURPOSE_FETCH_SERVERDESC
,
3854 0, /* not private */
3857 directory_get_from_dirserver(DIR_PURPOSE_FETCH_SERVERDESC
,
3864 /** Clients don't download any descriptor this recent, since it will probably
3865 * not have propageted to enough caches. */
3866 #define ESTIMATED_PROPAGATION_TIME (10*60)
3868 /** Return 0 if this routerstatus is obsolete, too new, isn't
3869 * running, or otherwise not a descriptor that we would make any
3870 * use of even if we had it. Else return 1. */
3872 client_would_use_router(routerstatus_t
*rs
, time_t now
, or_options_t
*options
)
3874 if (!rs
->is_running
&& !options
->FetchUselessDescriptors
) {
3875 /* If we had this router descriptor, we wouldn't even bother using it.
3876 * But, if we want to have a complete list, fetch it anyway. */
3879 if (rs
->published_on
+ ESTIMATED_PROPAGATION_TIME
> now
) {
3880 /* Most caches probably don't have this descriptor yet. */
3886 /** Return new list of ID fingerprints for routers that we (as a client) would
3889 static smartlist_t
*
3890 router_list_client_downloadable(void)
3892 int n_downloadable
= 0;
3893 smartlist_t
*downloadable
= smartlist_create();
3894 digestmap_t
*downloading
;
3895 time_t now
= time(NULL
);
3896 /* these are just used for logging */
3897 int n_not_ready
= 0, n_in_progress
= 0, n_uptodate
= 0, n_wouldnt_use
= 0;
3898 or_options_t
*options
= get_options();
3900 if (!routerstatus_list
)
3901 return downloadable
;
3903 downloading
= digestmap_new();
3904 list_pending_descriptor_downloads(downloading
);
3906 routerstatus_list_update_from_networkstatus(now
);
3907 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, rs
,
3910 if (router_get_by_descriptor_digest(rs
->status
.descriptor_digest
)) {
3911 /* We have the 'best' descriptor for this router. */
3913 } else if (!client_would_use_router(&rs
->status
, now
, options
)) {
3914 /* We wouldn't want this descriptor even if we got it. */
3916 } else if (digestmap_get(downloading
, rs
->status
.descriptor_digest
)) {
3917 /* We're downloading this one now. */
3919 } else if ((ri
= router_get_by_digest(rs
->status
.identity_digest
)) &&
3920 ri
->cache_info
.published_on
> rs
->status
.published_on
) {
3921 /* Oddly, we have a descriptor more recent than the 'best' one, but it
3922 was once best. So that's okay. */
3924 } else if (rs
->next_attempt_at
> now
) {
3925 /* We failed too recently to try again. */
3928 /* Okay, time to try it. */
3929 smartlist_add(downloadable
, rs
->status
.descriptor_digest
);
3936 "%d router descriptors are downloadable. "
3937 "%d are in progress. %d are up-to-date. "
3938 "%d are non-useful. %d failed too recently to retry.",
3939 n_downloadable
, n_in_progress
, n_uptodate
,
3940 n_wouldnt_use
, n_not_ready
);
3943 digestmap_free(downloading
, NULL
);
3944 return downloadable
;
3947 /** Initiate new router downloads as needed, using the strategy for
3948 * non-directory-servers.
3950 * We don't launch any downloads if there are fewer than MAX_DL_TO_DELAY
3951 * descriptors to get and less than MAX_CLIENT_INTERVAL_WITHOUT_REQUEST
3952 * seconds have passed.
3954 * Otherwise, we ask for all descriptors that we think are different from what
3955 * we have, and that we don't currently have an in-progress download attempt
3958 update_router_descriptor_client_downloads(time_t now
)
3960 /** Max amount of hashes to download per request.
3961 * Since squid does not like URLs >= 4096 bytes we limit it to 96.
3962 * 4096 - strlen(http://255.255.255.255/tor/server/d/.z) == 4058
3963 * 4058/41 (40 for the hash and 1 for the + that separates them) => 98
3964 * So use 96 because it's a nice number.
3966 #define MAX_DL_PER_REQUEST 96
3967 /** Don't split our requests so finely that we are requesting fewer than
3968 * this number per server. */
3969 #define MIN_DL_PER_REQUEST 4
3970 /** To prevent a single screwy cache from confusing us by selective reply,
3971 * try to split our requests into at least this this many requests. */
3972 #define MIN_REQUESTS 3
3973 /** If we want fewer than this many descriptors, wait until we
3974 * want more, or until MAX_CLIENT_INTERVAL_WITHOUT_REQUEST has
3976 #define MAX_DL_TO_DELAY 16
3977 /** When directory clients have only a few servers to request, they batch
3978 * them until they have more, or until this amount of time has passed. */
3979 #define MAX_CLIENT_INTERVAL_WITHOUT_REQUEST (10*60)
3980 smartlist_t
*downloadable
= NULL
;
3981 int should_delay
, n_downloadable
;
3982 or_options_t
*options
= get_options();
3984 if (options
->DirPort
) {
3986 "Called router_descriptor_client_downloads() on a dir mirror?");
3989 if (rep_hist_circbuilding_dormant(now
)) {
3990 log_info(LD_CIRC
, "Skipping descriptor downloads: we haven't needed "
3991 "any circuits lately.");
3995 if (networkstatus_list
&&
3996 smartlist_len(networkstatus_list
) <= get_n_v2_authorities()/2) {
3998 "Not enough networkstatus documents to launch requests.");
4002 downloadable
= router_list_client_downloadable();
4003 n_downloadable
= smartlist_len(downloadable
);
4004 if (n_downloadable
>= MAX_DL_TO_DELAY
) {
4006 "There are enough downloadable routerdescs to launch requests.");
4008 } else if (n_downloadable
== 0) {
4009 // log_debug(LD_DIR, "No routerdescs need to be downloaded.");
4012 should_delay
= (last_routerdesc_download_attempted
+
4013 MAX_CLIENT_INTERVAL_WITHOUT_REQUEST
) > now
;
4014 if (!should_delay
) {
4015 if (last_routerdesc_download_attempted
) {
4017 "There are not many downloadable routerdescs, but we've "
4018 "been waiting long enough (%d seconds). Downloading.",
4019 (int)(now
-last_routerdesc_download_attempted
));
4022 "There are not many downloadable routerdescs, but we haven't "
4023 "tried downloading descriptors recently. Downloading.");
4028 if (! should_delay
) {
4029 int i
, n_per_request
;
4030 n_per_request
= (n_downloadable
+MIN_REQUESTS
-1) / MIN_REQUESTS
;
4031 if (n_per_request
> MAX_DL_PER_REQUEST
)
4032 n_per_request
= MAX_DL_PER_REQUEST
;
4033 if (n_per_request
< MIN_DL_PER_REQUEST
)
4034 n_per_request
= MIN_DL_PER_REQUEST
;
4037 "Launching %d request%s for %d router%s, %d at a time",
4038 (n_downloadable
+n_per_request
-1)/n_per_request
,
4039 n_downloadable
>n_per_request
?"s":"",
4040 n_downloadable
, n_downloadable
>1?"s":"", n_per_request
);
4041 smartlist_sort_digests(downloadable
);
4042 for (i
=0; i
< n_downloadable
; i
+= n_per_request
) {
4043 initiate_descriptor_downloads(NULL
, downloadable
, i
, i
+n_per_request
);
4045 last_routerdesc_download_attempted
= now
;
4047 smartlist_free(downloadable
);
4050 /** Launch downloads for router status as needed, using the strategy used by
4051 * authorities and caches: download every descriptor we don't have but would
4052 * serve, from a random authority that lists it. */
4054 update_router_descriptor_cache_downloads(time_t now
)
4056 smartlist_t
**downloadable
; /* For each authority, what can we dl from it? */
4057 smartlist_t
**download_from
; /* ... and, what will we dl from it? */
4058 digestmap_t
*map
; /* Which descs are in progress, or assigned? */
4061 or_options_t
*options
= get_options();
4064 if (!options
->DirPort
) {
4065 log_warn(LD_BUG
, "Called update_router_descriptor_cache_downloads() "
4066 "on a non-dir-mirror?");
4069 if (!networkstatus_list
|| !smartlist_len(networkstatus_list
))
4072 map
= digestmap_new();
4073 n
= smartlist_len(networkstatus_list
);
4075 downloadable
= tor_malloc_zero(sizeof(smartlist_t
*) * n
);
4076 download_from
= tor_malloc_zero(sizeof(smartlist_t
*) * n
);
4078 /* Set map[d]=1 for the digest of every descriptor that we are currently
4080 list_pending_descriptor_downloads(map
);
4082 /* For the digest of every descriptor that we don't have, and that we aren't
4083 * downloading, add d to downloadable[i] if the i'th networkstatus knows
4084 * about that descriptor, and we haven't already failed to get that
4085 * descriptor from the corresponding authority.
4088 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
4090 trusted_dir_server_t
*ds
;
4092 dl
= downloadable
[ns_sl_idx
] = smartlist_create();
4093 download_from
[ns_sl_idx
] = smartlist_create();
4094 if (ns
->published_on
+ MAX_NETWORKSTATUS_AGE
+10*60 < now
) {
4095 /* Don't download if the networkstatus is almost ancient. */
4096 /* Actually, I suspect what's happening here is that we ask
4097 * for the descriptor when we have a given networkstatus,
4098 * and then we get a newer networkstatus, and then we receive
4099 * the descriptor. Having a networkstatus actually expire is
4100 * probably a rare event, and we'll probably be happiest if
4101 * we take this clause out. -RD */
4105 /* Don't try dirservers that we think are down -- we might have
4106 * just tried them and just marked them as down. */
4107 ds
= router_get_trusteddirserver_by_digest(ns
->identity_digest
);
4108 if (ds
&& !ds
->is_running
)
4111 SMARTLIST_FOREACH(ns
->entries
, routerstatus_t
* , rs
,
4113 if (!rs
->need_to_mirror
)
4115 if (router_get_by_descriptor_digest(rs
->descriptor_digest
)) {
4117 "Bug: We have a router descriptor, but need_to_mirror=1.");
4118 rs
->need_to_mirror
= 0;
4121 if (options
->AuthoritativeDir
&& dirserv_would_reject_router(rs
)) {
4122 rs
->need_to_mirror
= 0;
4125 if (digestmap_get(map
, rs
->descriptor_digest
)) {
4126 /* We're downloading it already. */
4129 /* We could download it from this guy. */
4130 smartlist_add(dl
, rs
->descriptor_digest
);
4136 /* At random, assign descriptors to authorities such that:
4137 * - if d is a member of some downloadable[x], d is a member of some
4138 * download_from[y]. (Everything we want to download, we try to download
4140 * - If d is a member of download_from[y], d is a member of downloadable[y].
4141 * (We only try to download descriptors from authorities who claim to have
4143 * - No d is a member of download_from[x] and download_from[y] s.t. x != y.
4144 * (We don't try to download anything from two authorities concurrently.)
4146 while (n_download
) {
4147 int which_ns
= crypto_rand_int(n
);
4148 smartlist_t
*dl
= downloadable
[which_ns
];
4151 if (!smartlist_len(dl
))
4153 idx
= crypto_rand_int(smartlist_len(dl
));
4154 d
= smartlist_get(dl
, idx
);
4155 if (! digestmap_get(map
, d
)) {
4156 smartlist_add(download_from
[which_ns
], d
);
4157 digestmap_set(map
, d
, (void*) 1);
4159 smartlist_del(dl
, idx
);
4163 /* Now, we can actually launch our requests. */
4164 for (i
=0; i
<n
; ++i
) {
4165 networkstatus_t
*ns
= smartlist_get(networkstatus_list
, i
);
4166 trusted_dir_server_t
*ds
=
4167 router_get_trusteddirserver_by_digest(ns
->identity_digest
);
4168 smartlist_t
*dl
= download_from
[i
];
4170 log_warn(LD_BUG
, "Networkstatus with no corresponding authority!");
4173 if (! smartlist_len(dl
))
4175 log_info(LD_DIR
, "Requesting %d descriptors from authority \"%s\"",
4176 smartlist_len(dl
), ds
->nickname
);
4177 for (j
=0; j
< smartlist_len(dl
); j
+= MAX_DL_PER_REQUEST
) {
4178 initiate_descriptor_downloads(&(ds
->fake_status
.status
), dl
, j
,
4179 j
+MAX_DL_PER_REQUEST
);
4183 for (i
=0; i
<n
; ++i
) {
4184 smartlist_free(download_from
[i
]);
4185 smartlist_free(downloadable
[i
]);
4187 tor_free(download_from
);
4188 tor_free(downloadable
);
4189 digestmap_free(map
,NULL
);
4192 /** Launch downloads for router status as needed. */
4194 update_router_descriptor_downloads(time_t now
)
4196 or_options_t
*options
= get_options();
4197 if (options
->DirPort
) {
4198 update_router_descriptor_cache_downloads(now
);
4200 update_router_descriptor_client_downloads(now
);
4204 /** Return the number of routerstatus_t in <b>entries</b> that we'd actually
4207 routerstatus_count_usable_entries(smartlist_t
*entries
)
4210 time_t now
= time(NULL
);
4211 or_options_t
*options
= get_options();
4212 SMARTLIST_FOREACH(entries
, routerstatus_t
*, rs
,
4213 if (client_would_use_router(rs
, now
, options
)) count
++);
4217 /** True iff, the last time we checked whether we had enough directory info
4218 * to build circuits, the answer was "yes". */
4219 static int have_min_dir_info
= 0;
4220 /** True iff enough has changed since the last time we checked whether we had
4221 * enough directory info to build circuits that our old answer can no longer
4223 static int need_to_update_have_min_dir_info
= 1;
4225 /** Return true iff we have enough networkstatus and router information to
4226 * start building circuits. Right now, this means "more than half the
4227 * networkstatus documents, and at least 1/4 of expected routers." */
4228 //XXX should consider whether we have enough exiting nodes here.
4230 router_have_minimum_dir_info(void)
4232 if (PREDICT(need_to_update_have_min_dir_info
, 0)) {
4233 update_router_have_minimum_dir_info();
4234 need_to_update_have_min_dir_info
= 0;
4236 return have_min_dir_info
;
4239 /** Called when our internal view of the directory has changed. This can be
4240 * when the authorities change, networkstatuses change, the list of routerdescs
4241 * changes, or number of running routers changes.
4244 router_dir_info_changed(void)
4246 need_to_update_have_min_dir_info
= 1;
4249 /** Change the value of have_min_dir_info, setting it true iff we have enough
4250 * network and router information to build circuits. Clear the value of
4251 * need_to_update_have_min_dir_info. */
4253 update_router_have_minimum_dir_info(void)
4255 int tot
= 0, num_running
= 0;
4256 int n_ns
, n_authorities
, res
, avg
;
4257 time_t now
= time(NULL
);
4258 if (!networkstatus_list
|| !routerlist
) {
4262 routerlist_remove_old_routers();
4263 networkstatus_list_clean(now
);
4265 n_authorities
= get_n_v2_authorities();
4266 n_ns
= smartlist_len(networkstatus_list
);
4267 if (n_ns
<=n_authorities
/2) {
4269 "We have %d of %d network statuses, and we want "
4270 "more than %d.", n_ns
, n_authorities
, n_authorities
/2);
4274 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
4275 tot
+= routerstatus_count_usable_entries(ns
->entries
));
4277 if (!routerstatus_list
)
4278 routerstatus_list
= smartlist_create();
4279 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, rs
,
4281 if (rs
->status
.is_running
)
4284 res
= smartlist_len(routerlist
->routers
) >= (avg
/4) && num_running
> 2;
4286 if (res
&& !have_min_dir_info
) {
4287 log(LOG_NOTICE
, LD_DIR
,
4288 "We now have enough directory information to build circuits.");
4289 control_event_client_status(LOG_NOTICE
, "ENOUGH_DIR_INFO");
4291 if (!res
&& have_min_dir_info
) {
4292 log(LOG_NOTICE
, LD_DIR
,"Our directory information is no longer up-to-date "
4293 "enough to build circuits.%s",
4294 num_running
> 2 ? "" : " (Not enough servers seem reachable -- "
4295 "is your network connection down?)");
4296 control_event_client_status(LOG_NOTICE
, "NOT_ENOUGH_DIR_INFO");
4298 have_min_dir_info
= res
;
4301 /** Return true iff we have downloaded, or attempted to download at least
4302 * n_failures times, a network status for each authority. */
4304 have_tried_downloading_all_statuses(int n_failures
)
4306 if (!trusted_dir_servers
)
4309 SMARTLIST_FOREACH(trusted_dir_servers
, trusted_dir_server_t
*, ds
,
4311 if (!ds
->is_v2_authority
)
4313 /* If we don't have the status, and we haven't failed to get the status,
4314 * we haven't tried to get the status. */
4315 if (!networkstatus_get_by_digest(ds
->digest
) &&
4316 ds
->n_networkstatus_failures
<= n_failures
)
4323 /** Reset the descriptor download failure count on all routers, so that we
4324 * can retry any long-failed routers immediately.
4327 router_reset_descriptor_download_failures(void)
4329 if (!routerstatus_list
)
4331 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, rs
,
4333 rs
->n_download_failures
= 0;
4334 rs
->next_attempt_at
= 0;
4336 tor_assert(networkstatus_list
);
4337 SMARTLIST_FOREACH(networkstatus_list
, networkstatus_t
*, ns
,
4338 SMARTLIST_FOREACH(ns
->entries
, routerstatus_t
*, rs
,
4340 if (!router_get_by_descriptor_digest(rs
->descriptor_digest
))
4341 rs
->need_to_mirror
= 1;
4343 last_routerdesc_download_attempted
= 0;
4346 /** Any changes in a router descriptor's publication time larger than this are
4347 * automatically non-cosmetic. */
4348 #define ROUTER_MAX_COSMETIC_TIME_DIFFERENCE (12*60*60)
4350 /** We allow uptime to vary from how much it ought to be by this much. */
4351 #define ROUTER_ALLOW_UPTIME_DRIFT (6*60*60)
4353 /** Return true iff the only differences between r1 and r2 are such that
4354 * would not cause a recent (post 0.1.1.6) dirserver to republish.
4357 router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
)
4359 time_t r1pub
, r2pub
;
4360 int time_difference
;
4361 tor_assert(r1
&& r2
);
4363 /* r1 should be the one that was published first. */
4364 if (r1
->cache_info
.published_on
> r2
->cache_info
.published_on
) {
4365 routerinfo_t
*ri_tmp
= r2
;
4370 /* If any key fields differ, they're different. */
4371 if (strcasecmp(r1
->address
, r2
->address
) ||
4372 strcasecmp(r1
->nickname
, r2
->nickname
) ||
4373 r1
->or_port
!= r2
->or_port
||
4374 r1
->dir_port
!= r2
->dir_port
||
4375 crypto_pk_cmp_keys(r1
->onion_pkey
, r2
->onion_pkey
) ||
4376 crypto_pk_cmp_keys(r1
->identity_pkey
, r2
->identity_pkey
) ||
4377 strcasecmp(r1
->platform
, r2
->platform
) ||
4378 (r1
->contact_info
&& !r2
->contact_info
) || /* contact_info is optional */
4379 (!r1
->contact_info
&& r2
->contact_info
) ||
4380 (r1
->contact_info
&& r2
->contact_info
&&
4381 strcasecmp(r1
->contact_info
, r2
->contact_info
)) ||
4382 r1
->is_hibernating
!= r2
->is_hibernating
||
4383 r1
->has_old_dnsworkers
!= r2
->has_old_dnsworkers
||
4384 cmp_addr_policies(r1
->exit_policy
, r2
->exit_policy
))
4386 if ((r1
->declared_family
== NULL
) != (r2
->declared_family
== NULL
))
4388 if (r1
->declared_family
&& r2
->declared_family
) {
4390 if (smartlist_len(r1
->declared_family
)!=smartlist_len(r2
->declared_family
))
4392 n
= smartlist_len(r1
->declared_family
);
4393 for (i
=0; i
< n
; ++i
) {
4394 if (strcasecmp(smartlist_get(r1
->declared_family
, i
),
4395 smartlist_get(r2
->declared_family
, i
)))
4400 /* Did bandwidth change a lot? */
4401 if ((r1
->bandwidthcapacity
< r2
->bandwidthcapacity
/2) ||
4402 (r2
->bandwidthcapacity
< r1
->bandwidthcapacity
/2))
4405 /* Did more than 12 hours pass? */
4406 if (r1
->cache_info
.published_on
+ ROUTER_MAX_COSMETIC_TIME_DIFFERENCE
4407 < r2
->cache_info
.published_on
)
4410 /* Did uptime fail to increase by approximately the amount we would think,
4411 * give or take some slop? */
4412 r1pub
= r1
->cache_info
.published_on
;
4413 r2pub
= r2
->cache_info
.published_on
;
4414 time_difference
= abs(r2
->uptime
- (r1
->uptime
+ (r2pub
- r1pub
)));
4415 if (time_difference
> ROUTER_ALLOW_UPTIME_DRIFT
&&
4416 time_difference
> r1
->uptime
* .05 &&
4417 time_difference
> r2
->uptime
* .05)
4420 /* Otherwise, the difference is cosmetic. */
4424 /** Generate networkstatus lines for a single routerstatus_t object, and
4425 * return the result in a newly allocated string. Used only by controller
4426 * interface (for now.) */
4427 /* XXXX This should eventually merge into generate_v2_networkstatus() */
4429 networkstatus_getinfo_helper_single(routerstatus_t
*rs
)
4436 char published
[ISO_TIME_LEN
+1];
4437 char ipaddr
[INET_NTOA_BUF_LEN
];
4438 char identity64
[BASE64_DIGEST_LEN
+1];
4439 char digest64
[BASE64_DIGEST_LEN
+1];
4441 format_iso_time(published
, rs
->published_on
);
4442 digest_to_base64(identity64
, rs
->identity_digest
);
4443 digest_to_base64(digest64
, rs
->descriptor_digest
);
4444 in
.s_addr
= htonl(rs
->addr
);
4445 tor_inet_ntoa(&in
, ipaddr
, sizeof(ipaddr
));
4447 f_authority
= router_digest_is_trusted_dir(rs
->identity_digest
);
4449 r
= tor_snprintf(buf
, sizeof(buf
),
4450 "r %s %s %s %s %s %d %d\n"
4451 "s%s%s%s%s%s%s%s%s%s%s\n",
4460 f_authority
?" Authority":"",
4461 rs
->is_bad_exit
?" BadExit":"",
4462 rs
->is_exit
?" Exit":"",
4463 rs
->is_fast
?" Fast":"",
4464 rs
->is_possible_guard
?" Guard":"",
4465 rs
->is_named
?" Named":"",
4466 rs
->is_stable
?" Stable":"",
4467 rs
->is_running
?" Running":"",
4468 rs
->is_valid
?" Valid":"",
4469 rs
->is_v2_dir
?" V2Dir":"");
4471 log_warn(LD_BUG
, "Not enough space in buffer.");
4473 return tor_strdup(buf
);
4476 /** If <b>question</b> is a string beginning with "ns/" in a format the
4477 * control interface expects for a GETINFO question, set *<b>answer</b> to a
4478 * newly-allocated string containing networkstatus lines for the appropriate
4479 * ORs. Return 0 on success, -1 on unrecognized question format. */
4481 getinfo_helper_networkstatus(control_connection_t
*conn
,
4482 const char *question
, char **answer
)
4484 local_routerstatus_t
*status
;
4487 if (!routerstatus_list
) {
4488 *answer
= tor_strdup("");
4492 if (!strcmp(question
, "ns/all")) {
4493 smartlist_t
*statuses
= smartlist_create();
4494 SMARTLIST_FOREACH(routerstatus_list
, local_routerstatus_t
*, lrs
,
4496 routerstatus_t
*rs
= &(lrs
->status
);
4497 smartlist_add(statuses
, networkstatus_getinfo_helper_single(rs
));
4499 *answer
= smartlist_join_strings(statuses
, "", 0, NULL
);
4500 SMARTLIST_FOREACH(statuses
, char *, cp
, tor_free(cp
));
4501 smartlist_free(statuses
);
4503 } else if (!strcmpstart(question
, "ns/id/")) {
4506 if (base16_decode(d
, DIGEST_LEN
, question
+6, strlen(question
+6)))
4508 status
= router_get_combined_status_by_digest(d
);
4509 } else if (!strcmpstart(question
, "ns/name/")) {
4510 status
= router_get_combined_status_by_nickname(question
+8, 0);
4516 *answer
= networkstatus_getinfo_helper_single(&status
->status
);
4521 /** Assert that the internal representation of <b>rl</b> is
4522 * self-consistent. */
4524 routerlist_assert_ok(routerlist_t
*rl
)
4526 digestmap_iter_t
*iter
;
4528 signed_descriptor_t
*sd2
;
4531 SMARTLIST_FOREACH(rl
->routers
, routerinfo_t
*, r
,
4533 r2
= digestmap_get(rl
->identity_map
, r
->cache_info
.identity_digest
);
4534 tor_assert(r
== r2
);
4535 sd2
= digestmap_get(rl
->desc_digest_map
,
4536 r
->cache_info
.signed_descriptor_digest
);
4537 tor_assert(&(r
->cache_info
) == sd2
);
4538 tor_assert(r
->routerlist_index
== r_sl_idx
);
4540 SMARTLIST_FOREACH(rl
->old_routers
, signed_descriptor_t
*, sd
,
4542 r2
= digestmap_get(rl
->identity_map
, sd
->identity_digest
);
4543 tor_assert(sd
!= &(r2
->cache_info
));
4544 sd2
= digestmap_get(rl
->desc_digest_map
, sd
->signed_descriptor_digest
);
4545 tor_assert(sd
== sd2
);
4547 iter
= digestmap_iter_init(rl
->identity_map
);
4548 while (!digestmap_iter_done(iter
)) {
4552 digestmap_iter_get(iter
, &d
, &_r
);
4554 tor_assert(!memcmp(r
->cache_info
.identity_digest
, d
, DIGEST_LEN
));
4555 iter
= digestmap_iter_next(rl
->identity_map
, iter
);
4557 iter
= digestmap_iter_init(rl
->desc_digest_map
);
4558 while (!digestmap_iter_done(iter
)) {
4561 signed_descriptor_t
*sd
;
4562 digestmap_iter_get(iter
, &d
, &_sd
);
4564 tor_assert(!memcmp(sd
->signed_descriptor_digest
, d
, DIGEST_LEN
));
4565 iter
= digestmap_iter_next(rl
->desc_digest_map
, iter
);
4569 /** Allocate and return a new string representing the contact info
4570 * and platform string for <b>router</b>,
4571 * surrounded by quotes and using standard C escapes.
4573 * THIS FUNCTION IS NOT REENTRANT. Don't call it from outside the main
4574 * thread. Also, each call invalidates the last-returned value, so don't
4575 * try log_warn(LD_GENERAL, "%s %s", esc_router_info(a), esc_router_info(b));
4578 esc_router_info(routerinfo_t
*router
)
4581 char *esc_contact
, *esc_platform
;
4586 esc_contact
= esc_for_log(router
->contact_info
);
4587 esc_platform
= esc_for_log(router
->platform
);
4589 len
= strlen(esc_contact
)+strlen(esc_platform
)+32;
4590 info
= tor_malloc(len
);
4591 tor_snprintf(info
, len
, "Contact %s, Platform %s", esc_contact
,
4593 tor_free(esc_contact
);
4594 tor_free(esc_platform
);