nodelist.c 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036
  1. /* Copyright (c) 2001 Matej Pfajfar.
  2. * Copyright (c) 2001-2004, Roger Dingledine.
  3. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4. * Copyright (c) 2007-2016, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file nodelist.c
  8. *
  9. * \brief Structures and functions for tracking what we know about the routers
  10. * on the Tor network, and correlating information from networkstatus,
  11. * routerinfo, and microdescs.
  12. *
  13. * The key structure here is node_t: that's the canonical way to refer
  14. * to a Tor relay that we might want to build a circuit through. Every
  15. * node_t has either a routerinfo_t, or a routerstatus_t from the current
  16. * networkstatus consensus. If it has a routerstatus_t, it will also
  17. * need to have a microdesc_t before you can use it for circuits.
  18. *
  19. * The nodelist_t is a global singleton that maps identities to node_t
  20. * objects. Access them with the node_get_*() functions. The nodelist_t
  21. * is maintained by calls throughout the codebase
  22. *
  23. * Generally, other code should not have to reach inside a node_t to
  24. * see what information it has. Instead, you should call one of the
  25. * many accessor functions that works on a generic node_t. If there
  26. * isn't one that does what you need, it's better to make such a function,
  27. * and then use it.
  28. *
  29. * For historical reasons, some of the functions that select a node_t
  30. * from the list of all usable node_t objects are in the routerlist.c
  31. * module, since they originally selected a routerinfo_t. (TODO: They
  32. * should move!)
  33. *
  34. * (TODO: Perhaps someday we should abstract the remaining ways of
  35. * talking about a relay to also be node_t instances. Those would be
  36. * routerstatus_t as used for directory requests, and dir_server_t as
  37. * used for authorities and fallback directories.)
  38. */
  39. #include "or.h"
  40. #include "address.h"
  41. #include "config.h"
  42. #include "control.h"
  43. #include "dirserv.h"
  44. #include "geoip.h"
  45. #include "main.h"
  46. #include "microdesc.h"
  47. #include "networkstatus.h"
  48. #include "nodelist.h"
  49. #include "policies.h"
  50. #include "protover.h"
  51. #include "rendservice.h"
  52. #include "router.h"
  53. #include "routerlist.h"
  54. #include "routerset.h"
  55. #include "torcert.h"
  56. #include <string.h>
  57. static void nodelist_drop_node(node_t *node, int remove_from_ht);
  58. static void node_free(node_t *node);
  59. /** count_usable_descriptors counts descriptors with these flag(s)
  60. */
  61. typedef enum {
  62. /* All descriptors regardless of flags */
  63. USABLE_DESCRIPTOR_ALL = 0,
  64. /* Only descriptors with the Exit flag */
  65. USABLE_DESCRIPTOR_EXIT_ONLY = 1
  66. } usable_descriptor_t;
  67. static void count_usable_descriptors(int *num_present,
  68. int *num_usable,
  69. smartlist_t *descs_out,
  70. const networkstatus_t *consensus,
  71. const or_options_t *options,
  72. time_t now,
  73. routerset_t *in_set,
  74. usable_descriptor_t exit_only);
  75. static void update_router_have_minimum_dir_info(void);
  76. static double get_frac_paths_needed_for_circs(const or_options_t *options,
  77. const networkstatus_t *ns);
  78. /** A nodelist_t holds a node_t object for every router we're "willing to use
  79. * for something". Specifically, it should hold a node_t for every node that
  80. * is currently in the routerlist, or currently in the consensus we're using.
  81. */
  82. typedef struct nodelist_t {
  83. /* A list of all the nodes. */
  84. smartlist_t *nodes;
  85. /* Hash table to map from node ID digest to node. */
  86. HT_HEAD(nodelist_map, node_t) nodes_by_id;
  87. } nodelist_t;
  88. static inline unsigned int
  89. node_id_hash(const node_t *node)
  90. {
  91. return (unsigned) siphash24g(node->identity, DIGEST_LEN);
  92. }
  93. static inline unsigned int
  94. node_id_eq(const node_t *node1, const node_t *node2)
  95. {
  96. return tor_memeq(node1->identity, node2->identity, DIGEST_LEN);
  97. }
  98. HT_PROTOTYPE(nodelist_map, node_t, ht_ent, node_id_hash, node_id_eq)
  99. HT_GENERATE2(nodelist_map, node_t, ht_ent, node_id_hash, node_id_eq,
  100. 0.6, tor_reallocarray_, tor_free_)
  101. /** The global nodelist. */
  102. static nodelist_t *the_nodelist=NULL;
  103. /** Create an empty nodelist if we haven't done so already. */
  104. static void
  105. init_nodelist(void)
  106. {
  107. if (PREDICT_UNLIKELY(the_nodelist == NULL)) {
  108. the_nodelist = tor_malloc_zero(sizeof(nodelist_t));
  109. HT_INIT(nodelist_map, &the_nodelist->nodes_by_id);
  110. the_nodelist->nodes = smartlist_new();
  111. }
  112. }
  113. /** As node_get_by_id, but returns a non-const pointer */
  114. node_t *
  115. node_get_mutable_by_id(const char *identity_digest)
  116. {
  117. node_t search, *node;
  118. if (PREDICT_UNLIKELY(the_nodelist == NULL))
  119. return NULL;
  120. memcpy(&search.identity, identity_digest, DIGEST_LEN);
  121. node = HT_FIND(nodelist_map, &the_nodelist->nodes_by_id, &search);
  122. return node;
  123. }
  124. /** Return the node_t whose identity is <b>identity_digest</b>, or NULL
  125. * if no such node exists. */
  126. MOCK_IMPL(const node_t *,
  127. node_get_by_id,(const char *identity_digest))
  128. {
  129. return node_get_mutable_by_id(identity_digest);
  130. }
  131. /** Internal: return the node_t whose identity_digest is
  132. * <b>identity_digest</b>. If none exists, create a new one, add it to the
  133. * nodelist, and return it.
  134. *
  135. * Requires that the nodelist be initialized.
  136. */
  137. static node_t *
  138. node_get_or_create(const char *identity_digest)
  139. {
  140. node_t *node;
  141. if ((node = node_get_mutable_by_id(identity_digest)))
  142. return node;
  143. node = tor_malloc_zero(sizeof(node_t));
  144. memcpy(node->identity, identity_digest, DIGEST_LEN);
  145. HT_INSERT(nodelist_map, &the_nodelist->nodes_by_id, node);
  146. smartlist_add(the_nodelist->nodes, node);
  147. node->nodelist_idx = smartlist_len(the_nodelist->nodes) - 1;
  148. node->country = -1;
  149. return node;
  150. }
  151. /** Called when a node's address changes. */
  152. static void
  153. node_addrs_changed(node_t *node)
  154. {
  155. node->last_reachable = node->last_reachable6 = 0;
  156. node->country = -1;
  157. }
  158. /** Add <b>ri</b> to an appropriate node in the nodelist. If we replace an
  159. * old routerinfo, and <b>ri_old_out</b> is not NULL, set *<b>ri_old_out</b>
  160. * to the previous routerinfo.
  161. */
  162. node_t *
  163. nodelist_set_routerinfo(routerinfo_t *ri, routerinfo_t **ri_old_out)
  164. {
  165. node_t *node;
  166. const char *id_digest;
  167. int had_router = 0;
  168. tor_assert(ri);
  169. init_nodelist();
  170. id_digest = ri->cache_info.identity_digest;
  171. node = node_get_or_create(id_digest);
  172. if (node->ri) {
  173. if (!routers_have_same_or_addrs(node->ri, ri)) {
  174. node_addrs_changed(node);
  175. }
  176. had_router = 1;
  177. if (ri_old_out)
  178. *ri_old_out = node->ri;
  179. } else {
  180. if (ri_old_out)
  181. *ri_old_out = NULL;
  182. }
  183. node->ri = ri;
  184. if (node->country == -1)
  185. node_set_country(node);
  186. if (authdir_mode(get_options()) && !had_router) {
  187. const char *discard=NULL;
  188. uint32_t status = dirserv_router_get_status(ri, &discard, LOG_INFO);
  189. dirserv_set_node_flags_from_authoritative_status(node, status);
  190. }
  191. return node;
  192. }
  193. /** Set the appropriate node_t to use <b>md</b> as its microdescriptor.
  194. *
  195. * Called when a new microdesc has arrived and the usable consensus flavor
  196. * is "microdesc".
  197. **/
  198. node_t *
  199. nodelist_add_microdesc(microdesc_t *md)
  200. {
  201. networkstatus_t *ns =
  202. networkstatus_get_latest_consensus_by_flavor(FLAV_MICRODESC);
  203. const routerstatus_t *rs;
  204. node_t *node;
  205. if (ns == NULL)
  206. return NULL;
  207. init_nodelist();
  208. /* Microdescriptors don't carry an identity digest, so we need to figure
  209. * it out by looking up the routerstatus. */
  210. rs = router_get_consensus_status_by_descriptor_digest(ns, md->digest);
  211. if (rs == NULL)
  212. return NULL;
  213. node = node_get_mutable_by_id(rs->identity_digest);
  214. if (node) {
  215. if (node->md)
  216. node->md->held_by_nodes--;
  217. node->md = md;
  218. md->held_by_nodes++;
  219. }
  220. return node;
  221. }
  222. /** Tell the nodelist that the current usable consensus is <b>ns</b>.
  223. * This makes the nodelist change all of the routerstatus entries for
  224. * the nodes, drop nodes that no longer have enough info to get used,
  225. * and grab microdescriptors into nodes as appropriate.
  226. */
  227. void
  228. nodelist_set_consensus(networkstatus_t *ns)
  229. {
  230. const or_options_t *options = get_options();
  231. int authdir = authdir_mode_v3(options);
  232. init_nodelist();
  233. if (ns->flavor == FLAV_MICRODESC)
  234. (void) get_microdesc_cache(); /* Make sure it exists first. */
  235. SMARTLIST_FOREACH(the_nodelist->nodes, node_t *, node,
  236. node->rs = NULL);
  237. SMARTLIST_FOREACH_BEGIN(ns->routerstatus_list, routerstatus_t *, rs) {
  238. node_t *node = node_get_or_create(rs->identity_digest);
  239. node->rs = rs;
  240. if (ns->flavor == FLAV_MICRODESC) {
  241. if (node->md == NULL ||
  242. tor_memneq(node->md->digest,rs->descriptor_digest,DIGEST256_LEN)) {
  243. if (node->md)
  244. node->md->held_by_nodes--;
  245. node->md = microdesc_cache_lookup_by_digest256(NULL,
  246. rs->descriptor_digest);
  247. if (node->md)
  248. node->md->held_by_nodes++;
  249. }
  250. }
  251. node_set_country(node);
  252. /* If we're not an authdir, believe others. */
  253. if (!authdir) {
  254. node->is_valid = rs->is_valid;
  255. node->is_running = rs->is_flagged_running;
  256. node->is_fast = rs->is_fast;
  257. node->is_stable = rs->is_stable;
  258. node->is_possible_guard = rs->is_possible_guard;
  259. node->is_exit = rs->is_exit;
  260. node->is_bad_exit = rs->is_bad_exit;
  261. node->is_hs_dir = rs->is_hs_dir;
  262. node->ipv6_preferred = 0;
  263. if (fascist_firewall_prefer_ipv6_orport(options) &&
  264. (tor_addr_is_null(&rs->ipv6_addr) == 0 ||
  265. (node->md && tor_addr_is_null(&node->md->ipv6_addr) == 0)))
  266. node->ipv6_preferred = 1;
  267. }
  268. } SMARTLIST_FOREACH_END(rs);
  269. nodelist_purge();
  270. if (! authdir) {
  271. SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
  272. /* We have no routerstatus for this router. Clear flags so we can skip
  273. * it, maybe.*/
  274. if (!node->rs) {
  275. tor_assert(node->ri); /* if it had only an md, or nothing, purge
  276. * would have removed it. */
  277. if (node->ri->purpose == ROUTER_PURPOSE_GENERAL) {
  278. /* Clear all flags. */
  279. node->is_valid = node->is_running = node->is_hs_dir =
  280. node->is_fast = node->is_stable =
  281. node->is_possible_guard = node->is_exit =
  282. node->is_bad_exit = node->ipv6_preferred = 0;
  283. }
  284. }
  285. } SMARTLIST_FOREACH_END(node);
  286. }
  287. }
  288. /** Helper: return true iff a node has a usable amount of information*/
  289. static inline int
  290. node_is_usable(const node_t *node)
  291. {
  292. return (node->rs) || (node->ri);
  293. }
  294. /** Tell the nodelist that <b>md</b> is no longer a microdescriptor for the
  295. * node with <b>identity_digest</b>. */
  296. void
  297. nodelist_remove_microdesc(const char *identity_digest, microdesc_t *md)
  298. {
  299. node_t *node = node_get_mutable_by_id(identity_digest);
  300. if (node && node->md == md) {
  301. node->md = NULL;
  302. md->held_by_nodes--;
  303. }
  304. }
  305. /** Tell the nodelist that <b>ri</b> is no longer in the routerlist. */
  306. void
  307. nodelist_remove_routerinfo(routerinfo_t *ri)
  308. {
  309. node_t *node = node_get_mutable_by_id(ri->cache_info.identity_digest);
  310. if (node && node->ri == ri) {
  311. node->ri = NULL;
  312. if (! node_is_usable(node)) {
  313. nodelist_drop_node(node, 1);
  314. node_free(node);
  315. }
  316. }
  317. }
  318. /** Remove <b>node</b> from the nodelist. (Asserts that it was there to begin
  319. * with.) */
  320. static void
  321. nodelist_drop_node(node_t *node, int remove_from_ht)
  322. {
  323. node_t *tmp;
  324. int idx;
  325. if (remove_from_ht) {
  326. tmp = HT_REMOVE(nodelist_map, &the_nodelist->nodes_by_id, node);
  327. tor_assert(tmp == node);
  328. }
  329. idx = node->nodelist_idx;
  330. tor_assert(idx >= 0);
  331. tor_assert(node == smartlist_get(the_nodelist->nodes, idx));
  332. smartlist_del(the_nodelist->nodes, idx);
  333. if (idx < smartlist_len(the_nodelist->nodes)) {
  334. tmp = smartlist_get(the_nodelist->nodes, idx);
  335. tmp->nodelist_idx = idx;
  336. }
  337. node->nodelist_idx = -1;
  338. }
  339. /** Return a newly allocated smartlist of the nodes that have <b>md</b> as
  340. * their microdescriptor. */
  341. smartlist_t *
  342. nodelist_find_nodes_with_microdesc(const microdesc_t *md)
  343. {
  344. smartlist_t *result = smartlist_new();
  345. if (the_nodelist == NULL)
  346. return result;
  347. SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
  348. if (node->md == md) {
  349. smartlist_add(result, node);
  350. }
  351. } SMARTLIST_FOREACH_END(node);
  352. return result;
  353. }
  354. /** Release storage held by <b>node</b> */
  355. static void
  356. node_free(node_t *node)
  357. {
  358. if (!node)
  359. return;
  360. if (node->md)
  361. node->md->held_by_nodes--;
  362. tor_assert(node->nodelist_idx == -1);
  363. tor_free(node);
  364. }
  365. /** Remove all entries from the nodelist that don't have enough info to be
  366. * usable for anything. */
  367. void
  368. nodelist_purge(void)
  369. {
  370. node_t **iter;
  371. if (PREDICT_UNLIKELY(the_nodelist == NULL))
  372. return;
  373. /* Remove the non-usable nodes. */
  374. for (iter = HT_START(nodelist_map, &the_nodelist->nodes_by_id); iter; ) {
  375. node_t *node = *iter;
  376. if (node->md && !node->rs) {
  377. /* An md is only useful if there is an rs. */
  378. node->md->held_by_nodes--;
  379. node->md = NULL;
  380. }
  381. if (node_is_usable(node)) {
  382. iter = HT_NEXT(nodelist_map, &the_nodelist->nodes_by_id, iter);
  383. } else {
  384. iter = HT_NEXT_RMV(nodelist_map, &the_nodelist->nodes_by_id, iter);
  385. nodelist_drop_node(node, 0);
  386. node_free(node);
  387. }
  388. }
  389. nodelist_assert_ok();
  390. }
  391. /** Release all storage held by the nodelist. */
  392. void
  393. nodelist_free_all(void)
  394. {
  395. if (PREDICT_UNLIKELY(the_nodelist == NULL))
  396. return;
  397. HT_CLEAR(nodelist_map, &the_nodelist->nodes_by_id);
  398. SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
  399. node->nodelist_idx = -1;
  400. node_free(node);
  401. } SMARTLIST_FOREACH_END(node);
  402. smartlist_free(the_nodelist->nodes);
  403. tor_free(the_nodelist);
  404. }
  405. /** Check that the nodelist is internally consistent, and consistent with
  406. * the directory info it's derived from.
  407. */
  408. void
  409. nodelist_assert_ok(void)
  410. {
  411. routerlist_t *rl = router_get_routerlist();
  412. networkstatus_t *ns = networkstatus_get_latest_consensus();
  413. digestmap_t *dm;
  414. if (!the_nodelist)
  415. return;
  416. dm = digestmap_new();
  417. /* every routerinfo in rl->routers should be in the nodelist. */
  418. if (rl) {
  419. SMARTLIST_FOREACH_BEGIN(rl->routers, routerinfo_t *, ri) {
  420. const node_t *node = node_get_by_id(ri->cache_info.identity_digest);
  421. tor_assert(node && node->ri == ri);
  422. tor_assert(fast_memeq(ri->cache_info.identity_digest,
  423. node->identity, DIGEST_LEN));
  424. tor_assert(! digestmap_get(dm, node->identity));
  425. digestmap_set(dm, node->identity, (void*)node);
  426. } SMARTLIST_FOREACH_END(ri);
  427. }
  428. /* every routerstatus in ns should be in the nodelist */
  429. if (ns) {
  430. SMARTLIST_FOREACH_BEGIN(ns->routerstatus_list, routerstatus_t *, rs) {
  431. const node_t *node = node_get_by_id(rs->identity_digest);
  432. tor_assert(node && node->rs == rs);
  433. tor_assert(fast_memeq(rs->identity_digest, node->identity, DIGEST_LEN));
  434. digestmap_set(dm, node->identity, (void*)node);
  435. if (ns->flavor == FLAV_MICRODESC) {
  436. /* If it's a microdesc consensus, every entry that has a
  437. * microdescriptor should be in the nodelist.
  438. */
  439. microdesc_t *md =
  440. microdesc_cache_lookup_by_digest256(NULL, rs->descriptor_digest);
  441. tor_assert(md == node->md);
  442. if (md)
  443. tor_assert(md->held_by_nodes >= 1);
  444. }
  445. } SMARTLIST_FOREACH_END(rs);
  446. }
  447. /* The nodelist should have no other entries, and its entries should be
  448. * well-formed. */
  449. SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
  450. tor_assert(digestmap_get(dm, node->identity) != NULL);
  451. tor_assert(node_sl_idx == node->nodelist_idx);
  452. } SMARTLIST_FOREACH_END(node);
  453. tor_assert((long)smartlist_len(the_nodelist->nodes) ==
  454. (long)HT_SIZE(&the_nodelist->nodes_by_id));
  455. digestmap_free(dm, NULL);
  456. }
  457. /** Return a list of a node_t * for every node we know about. The caller
  458. * MUST NOT modify the list. (You can set and clear flags in the nodes if
  459. * you must, but you must not add or remove nodes.) */
  460. MOCK_IMPL(smartlist_t *,
  461. nodelist_get_list,(void))
  462. {
  463. init_nodelist();
  464. return the_nodelist->nodes;
  465. }
  466. /** Given a hex-encoded nickname of the format DIGEST, $DIGEST, $DIGEST=name,
  467. * or $DIGEST~name, return the node with the matching identity digest and
  468. * nickname (if any). Return NULL if no such node exists, or if <b>hex_id</b>
  469. * is not well-formed. */
  470. const node_t *
  471. node_get_by_hex_id(const char *hex_id)
  472. {
  473. char digest_buf[DIGEST_LEN];
  474. char nn_buf[MAX_NICKNAME_LEN+1];
  475. char nn_char='\0';
  476. if (hex_digest_nickname_decode(hex_id, digest_buf, &nn_char, nn_buf)==0) {
  477. const node_t *node = node_get_by_id(digest_buf);
  478. if (!node)
  479. return NULL;
  480. if (nn_char) {
  481. const char *real_name = node_get_nickname(node);
  482. if (!real_name || strcasecmp(real_name, nn_buf))
  483. return NULL;
  484. if (nn_char == '=') {
  485. const char *named_id =
  486. networkstatus_get_router_digest_by_nickname(nn_buf);
  487. if (!named_id || tor_memneq(named_id, digest_buf, DIGEST_LEN))
  488. return NULL;
  489. }
  490. }
  491. return node;
  492. }
  493. return NULL;
  494. }
  495. /** Given a nickname (possibly verbose, possibly a hexadecimal digest), return
  496. * the corresponding node_t, or NULL if none exists. Warn the user if
  497. * <b>warn_if_unnamed</b> is set, and they have specified a router by
  498. * nickname, but the Named flag isn't set for that router. */
  499. MOCK_IMPL(const node_t *,
  500. node_get_by_nickname,(const char *nickname, int warn_if_unnamed))
  501. {
  502. if (!the_nodelist)
  503. return NULL;
  504. /* Handle these cases: DIGEST, $DIGEST, $DIGEST=name, $DIGEST~name. */
  505. {
  506. const node_t *node;
  507. if ((node = node_get_by_hex_id(nickname)) != NULL)
  508. return node;
  509. }
  510. if (!strcasecmp(nickname, UNNAMED_ROUTER_NICKNAME))
  511. return NULL;
  512. /* Okay, so if we get here, the nickname is just a nickname. Is there
  513. * a binding for it in the consensus? */
  514. {
  515. const char *named_id =
  516. networkstatus_get_router_digest_by_nickname(nickname);
  517. if (named_id)
  518. return node_get_by_id(named_id);
  519. }
  520. /* Is it marked as owned-by-someone-else? */
  521. if (networkstatus_nickname_is_unnamed(nickname)) {
  522. log_info(LD_GENERAL, "The name %s is listed as Unnamed: there is some "
  523. "router that holds it, but not one listed in the current "
  524. "consensus.", escaped(nickname));
  525. return NULL;
  526. }
  527. /* Okay, so the name is not canonical for anybody. */
  528. {
  529. smartlist_t *matches = smartlist_new();
  530. const node_t *choice = NULL;
  531. SMARTLIST_FOREACH_BEGIN(the_nodelist->nodes, node_t *, node) {
  532. if (!strcasecmp(node_get_nickname(node), nickname))
  533. smartlist_add(matches, node);
  534. } SMARTLIST_FOREACH_END(node);
  535. if (smartlist_len(matches)>1 && warn_if_unnamed) {
  536. int any_unwarned = 0;
  537. SMARTLIST_FOREACH_BEGIN(matches, node_t *, node) {
  538. if (!node->name_lookup_warned) {
  539. node->name_lookup_warned = 1;
  540. any_unwarned = 1;
  541. }
  542. } SMARTLIST_FOREACH_END(node);
  543. if (any_unwarned) {
  544. log_warn(LD_CONFIG, "There are multiple matches for the name %s, "
  545. "but none is listed as Named in the directory consensus. "
  546. "Choosing one arbitrarily.", nickname);
  547. }
  548. } else if (smartlist_len(matches)==1 && warn_if_unnamed) {
  549. char fp[HEX_DIGEST_LEN+1];
  550. node_t *node = smartlist_get(matches, 0);
  551. if (! node->name_lookup_warned) {
  552. base16_encode(fp, sizeof(fp), node->identity, DIGEST_LEN);
  553. log_warn(LD_CONFIG,
  554. "You specified a server \"%s\" by name, but the directory "
  555. "authorities do not have any key registered for this "
  556. "nickname -- so it could be used by any server, not just "
  557. "the one you meant. "
  558. "To make sure you get the same server in the future, refer "
  559. "to it by key, as \"$%s\".", nickname, fp);
  560. node->name_lookup_warned = 1;
  561. }
  562. }
  563. if (smartlist_len(matches))
  564. choice = smartlist_get(matches, 0);
  565. smartlist_free(matches);
  566. return choice;
  567. }
  568. }
  569. /** Return the Ed25519 identity key for the provided node, or NULL if it
  570. * doesn't have one. */
  571. const ed25519_public_key_t *
  572. node_get_ed25519_id(const node_t *node)
  573. {
  574. if (node->ri) {
  575. if (node->ri->cache_info.signing_key_cert) {
  576. const ed25519_public_key_t *pk =
  577. &node->ri->cache_info.signing_key_cert->signing_key;
  578. if (BUG(ed25519_public_key_is_zero(pk)))
  579. goto try_the_md;
  580. return pk;
  581. }
  582. }
  583. try_the_md:
  584. if (node->md) {
  585. if (node->md->ed25519_identity_pkey) {
  586. return node->md->ed25519_identity_pkey;
  587. }
  588. }
  589. return NULL;
  590. }
  591. /** Return true iff this node's Ed25519 identity matches <b>id</b>.
  592. * (An absent Ed25519 identity matches NULL or zero.) */
  593. int
  594. node_ed25519_id_matches(const node_t *node, const ed25519_public_key_t *id)
  595. {
  596. const ed25519_public_key_t *node_id = node_get_ed25519_id(node);
  597. if (node_id == NULL || ed25519_public_key_is_zero(node_id)) {
  598. return id == NULL || ed25519_public_key_is_zero(id);
  599. } else {
  600. return id && ed25519_pubkey_eq(node_id, id);
  601. }
  602. }
  603. /** Return true iff <b>node</b> supports authenticating itself
  604. * by ed25519 ID during the link handshake in a way that we can understand
  605. * when we probe it. */
  606. int
  607. node_supports_ed25519_link_authentication(const node_t *node)
  608. {
  609. /* XXXX Oh hm. What if some day in the future there are link handshake
  610. * versions that aren't 3 but which are ed25519 */
  611. if (! node_get_ed25519_id(node))
  612. return 0;
  613. if (node->ri) {
  614. const char *protos = node->ri->protocol_list;
  615. if (protos == NULL)
  616. return 0;
  617. return protocol_list_supports_protocol(protos, PRT_LINKAUTH, 3);
  618. }
  619. if (node->rs) {
  620. return node->rs->supports_ed25519_link_handshake;
  621. }
  622. tor_assert_nonfatal_unreached_once();
  623. return 0;
  624. }
  625. /** Return the RSA ID key's SHA1 digest for the provided node. */
  626. const uint8_t *
  627. node_get_rsa_id_digest(const node_t *node)
  628. {
  629. tor_assert(node);
  630. return (const uint8_t*)node->identity;
  631. }
  632. /** Return the nickname of <b>node</b>, or NULL if we can't find one. */
  633. const char *
  634. node_get_nickname(const node_t *node)
  635. {
  636. tor_assert(node);
  637. if (node->rs)
  638. return node->rs->nickname;
  639. else if (node->ri)
  640. return node->ri->nickname;
  641. else
  642. return NULL;
  643. }
  644. /** Return true iff the nickname of <b>node</b> is canonical, based on the
  645. * latest consensus. */
  646. int
  647. node_is_named(const node_t *node)
  648. {
  649. const char *named_id;
  650. const char *nickname = node_get_nickname(node);
  651. if (!nickname)
  652. return 0;
  653. named_id = networkstatus_get_router_digest_by_nickname(nickname);
  654. if (!named_id)
  655. return 0;
  656. return tor_memeq(named_id, node->identity, DIGEST_LEN);
  657. }
  658. /** Return true iff <b>node</b> appears to be a directory authority or
  659. * directory cache */
  660. int
  661. node_is_dir(const node_t *node)
  662. {
  663. if (node->rs) {
  664. routerstatus_t * rs = node->rs;
  665. /* This is true if supports_tunnelled_dir_requests is true which
  666. * indicates that we support directory request tunnelled or through the
  667. * DirPort. */
  668. return rs->is_v2_dir;
  669. } else if (node->ri) {
  670. routerinfo_t * ri = node->ri;
  671. /* Both tunnelled request is supported or DirPort is set. */
  672. return ri->supports_tunnelled_dir_requests;
  673. } else {
  674. return 0;
  675. }
  676. }
  677. /** Return true iff <b>node</b> has either kind of usable descriptor -- that
  678. * is, a routerdescriptor or a microdescriptor. */
  679. int
  680. node_has_descriptor(const node_t *node)
  681. {
  682. return (node->ri ||
  683. (node->rs && node->md));
  684. }
  685. /** Return the router_purpose of <b>node</b>. */
  686. int
  687. node_get_purpose(const node_t *node)
  688. {
  689. if (node->ri)
  690. return node->ri->purpose;
  691. else
  692. return ROUTER_PURPOSE_GENERAL;
  693. }
  694. /** Compute the verbose ("extended") nickname of <b>node</b> and store it
  695. * into the MAX_VERBOSE_NICKNAME_LEN+1 character buffer at
  696. * <b>verbose_name_out</b> */
  697. void
  698. node_get_verbose_nickname(const node_t *node,
  699. char *verbose_name_out)
  700. {
  701. const char *nickname = node_get_nickname(node);
  702. int is_named = node_is_named(node);
  703. verbose_name_out[0] = '$';
  704. base16_encode(verbose_name_out+1, HEX_DIGEST_LEN+1, node->identity,
  705. DIGEST_LEN);
  706. if (!nickname)
  707. return;
  708. verbose_name_out[1+HEX_DIGEST_LEN] = is_named ? '=' : '~';
  709. strlcpy(verbose_name_out+1+HEX_DIGEST_LEN+1, nickname, MAX_NICKNAME_LEN+1);
  710. }
  711. /** Compute the verbose ("extended") nickname of node with
  712. * given <b>id_digest</b> and store it into the MAX_VERBOSE_NICKNAME_LEN+1
  713. * character buffer at <b>verbose_name_out</b>
  714. *
  715. * If node_get_by_id() returns NULL, base 16 encoding of
  716. * <b>id_digest</b> is returned instead. */
  717. void
  718. node_get_verbose_nickname_by_id(const char *id_digest,
  719. char *verbose_name_out)
  720. {
  721. const node_t *node = node_get_by_id(id_digest);
  722. if (!node) {
  723. verbose_name_out[0] = '$';
  724. base16_encode(verbose_name_out+1, HEX_DIGEST_LEN+1, id_digest, DIGEST_LEN);
  725. } else {
  726. node_get_verbose_nickname(node, verbose_name_out);
  727. }
  728. }
  729. /** Return true iff it seems that <b>node</b> allows circuits to exit
  730. * through it directlry from the client. */
  731. int
  732. node_allows_single_hop_exits(const node_t *node)
  733. {
  734. if (node && node->ri)
  735. return node->ri->allow_single_hop_exits;
  736. else
  737. return 0;
  738. }
  739. /** Return true iff it seems that <b>node</b> has an exit policy that doesn't
  740. * actually permit anything to exit, or we don't know its exit policy */
  741. int
  742. node_exit_policy_rejects_all(const node_t *node)
  743. {
  744. if (node->rejects_all)
  745. return 1;
  746. if (node->ri)
  747. return node->ri->policy_is_reject_star;
  748. else if (node->md)
  749. return node->md->exit_policy == NULL ||
  750. short_policy_is_reject_star(node->md->exit_policy);
  751. else
  752. return 1;
  753. }
  754. /** Return true iff the exit policy for <b>node</b> is such that we can treat
  755. * rejecting an address of type <b>family</b> unexpectedly as a sign of that
  756. * node's failure. */
  757. int
  758. node_exit_policy_is_exact(const node_t *node, sa_family_t family)
  759. {
  760. if (family == AF_UNSPEC) {
  761. return 1; /* Rejecting an address but not telling us what address
  762. * is a bad sign. */
  763. } else if (family == AF_INET) {
  764. return node->ri != NULL;
  765. } else if (family == AF_INET6) {
  766. return 0;
  767. }
  768. tor_fragile_assert();
  769. return 1;
  770. }
  771. /* Check if the "addr" and port_field fields from r are a valid non-listening
  772. * address/port. If so, set valid to true and add a newly allocated
  773. * tor_addr_port_t containing "addr" and port_field to sl.
  774. * "addr" is an IPv4 host-order address and port_field is a uint16_t.
  775. * r is typically a routerinfo_t or routerstatus_t.
  776. */
  777. #define SL_ADD_NEW_IPV4_AP(r, port_field, sl, valid) \
  778. STMT_BEGIN \
  779. if (tor_addr_port_is_valid_ipv4h((r)->addr, (r)->port_field, 0)) { \
  780. valid = 1; \
  781. tor_addr_port_t *ap = tor_malloc(sizeof(tor_addr_port_t)); \
  782. tor_addr_from_ipv4h(&ap->addr, (r)->addr); \
  783. ap->port = (r)->port_field; \
  784. smartlist_add((sl), ap); \
  785. } \
  786. STMT_END
  787. /* Check if the "addr" and port_field fields from r are a valid non-listening
  788. * address/port. If so, set valid to true and add a newly allocated
  789. * tor_addr_port_t containing "addr" and port_field to sl.
  790. * "addr" is a tor_addr_t and port_field is a uint16_t.
  791. * r is typically a routerinfo_t or routerstatus_t.
  792. */
  793. #define SL_ADD_NEW_IPV6_AP(r, port_field, sl, valid) \
  794. STMT_BEGIN \
  795. if (tor_addr_port_is_valid(&(r)->ipv6_addr, (r)->port_field, 0)) { \
  796. valid = 1; \
  797. tor_addr_port_t *ap = tor_malloc(sizeof(tor_addr_port_t)); \
  798. tor_addr_copy(&ap->addr, &(r)->ipv6_addr); \
  799. ap->port = (r)->port_field; \
  800. smartlist_add((sl), ap); \
  801. } \
  802. STMT_END
  803. /** Return list of tor_addr_port_t with all OR ports (in the sense IP
  804. * addr + TCP port) for <b>node</b>. Caller must free all elements
  805. * using tor_free() and free the list using smartlist_free().
  806. *
  807. * XXX this is potentially a memory fragmentation hog -- if on
  808. * critical path consider the option of having the caller allocate the
  809. * memory
  810. */
  811. smartlist_t *
  812. node_get_all_orports(const node_t *node)
  813. {
  814. smartlist_t *sl = smartlist_new();
  815. int valid = 0;
  816. /* Find a valid IPv4 address and port */
  817. if (node->ri != NULL) {
  818. SL_ADD_NEW_IPV4_AP(node->ri, or_port, sl, valid);
  819. }
  820. /* If we didn't find a valid address/port in the ri, try the rs */
  821. if (!valid && node->rs != NULL) {
  822. SL_ADD_NEW_IPV4_AP(node->rs, or_port, sl, valid);
  823. }
  824. /* Find a valid IPv6 address and port */
  825. valid = 0;
  826. if (node->ri != NULL) {
  827. SL_ADD_NEW_IPV6_AP(node->ri, ipv6_orport, sl, valid);
  828. }
  829. if (!valid && node->rs != NULL) {
  830. SL_ADD_NEW_IPV6_AP(node->rs, ipv6_orport, sl, valid);
  831. }
  832. if (!valid && node->md != NULL) {
  833. SL_ADD_NEW_IPV6_AP(node->md, ipv6_orport, sl, valid);
  834. }
  835. return sl;
  836. }
  837. #undef SL_ADD_NEW_IPV4_AP
  838. #undef SL_ADD_NEW_IPV6_AP
  839. /** Wrapper around node_get_prim_orport for backward
  840. compatibility. */
  841. void
  842. node_get_addr(const node_t *node, tor_addr_t *addr_out)
  843. {
  844. tor_addr_port_t ap;
  845. node_get_prim_orport(node, &ap);
  846. tor_addr_copy(addr_out, &ap.addr);
  847. }
  848. /** Return the host-order IPv4 address for <b>node</b>, or 0 if it doesn't
  849. * seem to have one. */
  850. uint32_t
  851. node_get_prim_addr_ipv4h(const node_t *node)
  852. {
  853. /* Don't check the ORPort or DirPort, as this function isn't port-specific,
  854. * and the node might have a valid IPv4 address, yet have a zero
  855. * ORPort or DirPort.
  856. */
  857. if (node->ri && tor_addr_is_valid_ipv4h(node->ri->addr, 0)) {
  858. return node->ri->addr;
  859. } else if (node->rs && tor_addr_is_valid_ipv4h(node->rs->addr, 0)) {
  860. return node->rs->addr;
  861. }
  862. return 0;
  863. }
  864. /** Copy a string representation of an IP address for <b>node</b> into
  865. * the <b>len</b>-byte buffer at <b>buf</b>. */
  866. void
  867. node_get_address_string(const node_t *node, char *buf, size_t len)
  868. {
  869. uint32_t ipv4_addr = node_get_prim_addr_ipv4h(node);
  870. if (tor_addr_is_valid_ipv4h(ipv4_addr, 0)) {
  871. tor_addr_t addr;
  872. tor_addr_from_ipv4h(&addr, ipv4_addr);
  873. tor_addr_to_str(buf, &addr, len, 0);
  874. } else if (len > 0) {
  875. buf[0] = '\0';
  876. }
  877. }
  878. /** Return <b>node</b>'s declared uptime, or -1 if it doesn't seem to have
  879. * one. */
  880. long
  881. node_get_declared_uptime(const node_t *node)
  882. {
  883. if (node->ri)
  884. return node->ri->uptime;
  885. else
  886. return -1;
  887. }
  888. /** Return <b>node</b>'s platform string, or NULL if we don't know it. */
  889. const char *
  890. node_get_platform(const node_t *node)
  891. {
  892. /* If we wanted, we could record the version in the routerstatus_t, since
  893. * the consensus lists it. We don't, though, so this function just won't
  894. * work with microdescriptors. */
  895. if (node->ri)
  896. return node->ri->platform;
  897. else
  898. return NULL;
  899. }
  900. /** Return <b>node</b>'s time of publication, or 0 if we don't have one. */
  901. time_t
  902. node_get_published_on(const node_t *node)
  903. {
  904. if (node->ri)
  905. return node->ri->cache_info.published_on;
  906. else
  907. return 0;
  908. }
  909. /** Return true iff <b>node</b> is one representing this router. */
  910. int
  911. node_is_me(const node_t *node)
  912. {
  913. return router_digest_is_me(node->identity);
  914. }
  915. /** Return <b>node</b> declared family (as a list of names), or NULL if
  916. * the node didn't declare a family. */
  917. const smartlist_t *
  918. node_get_declared_family(const node_t *node)
  919. {
  920. if (node->ri && node->ri->declared_family)
  921. return node->ri->declared_family;
  922. else if (node->md && node->md->family)
  923. return node->md->family;
  924. else
  925. return NULL;
  926. }
  927. /* Does this node have a valid IPv6 address?
  928. * Prefer node_has_ipv6_orport() or node_has_ipv6_dirport() for
  929. * checking specific ports. */
  930. int
  931. node_has_ipv6_addr(const node_t *node)
  932. {
  933. /* Don't check the ORPort or DirPort, as this function isn't port-specific,
  934. * and the node might have a valid IPv6 address, yet have a zero
  935. * ORPort or DirPort.
  936. */
  937. if (node->ri && tor_addr_is_valid(&node->ri->ipv6_addr, 0))
  938. return 1;
  939. if (node->rs && tor_addr_is_valid(&node->rs->ipv6_addr, 0))
  940. return 1;
  941. if (node->md && tor_addr_is_valid(&node->md->ipv6_addr, 0))
  942. return 1;
  943. return 0;
  944. }
  945. /* Does this node have a valid IPv6 ORPort? */
  946. int
  947. node_has_ipv6_orport(const node_t *node)
  948. {
  949. tor_addr_port_t ipv6_orport;
  950. node_get_pref_ipv6_orport(node, &ipv6_orport);
  951. return tor_addr_port_is_valid_ap(&ipv6_orport, 0);
  952. }
  953. /* Does this node have a valid IPv6 DirPort? */
  954. int
  955. node_has_ipv6_dirport(const node_t *node)
  956. {
  957. tor_addr_port_t ipv6_dirport;
  958. node_get_pref_ipv6_dirport(node, &ipv6_dirport);
  959. return tor_addr_port_is_valid_ap(&ipv6_dirport, 0);
  960. }
  961. /** Return 1 if we prefer the IPv6 address and OR TCP port of
  962. * <b>node</b>, else 0.
  963. *
  964. * We prefer the IPv6 address if the router has an IPv6 address,
  965. * and we can use IPv6 addresses, and:
  966. * i) the node_t says that it prefers IPv6
  967. * or
  968. * ii) the router has no IPv4 OR address.
  969. *
  970. * If you don't have a node, consider looking it up.
  971. * If there is no node, use fascist_firewall_prefer_ipv6_orport().
  972. */
  973. int
  974. node_ipv6_or_preferred(const node_t *node)
  975. {
  976. const or_options_t *options = get_options();
  977. tor_addr_port_t ipv4_addr;
  978. node_assert_ok(node);
  979. /* XX/teor - node->ipv6_preferred is set from
  980. * fascist_firewall_prefer_ipv6_orport() each time the consensus is loaded.
  981. */
  982. if (!fascist_firewall_use_ipv6(options)) {
  983. return 0;
  984. } else if (node->ipv6_preferred || node_get_prim_orport(node, &ipv4_addr)) {
  985. return node_has_ipv6_orport(node);
  986. }
  987. return 0;
  988. }
  989. #define RETURN_IPV4_AP(r, port_field, ap_out) \
  990. STMT_BEGIN \
  991. if (r && tor_addr_port_is_valid_ipv4h((r)->addr, (r)->port_field, 0)) { \
  992. tor_addr_from_ipv4h(&(ap_out)->addr, (r)->addr); \
  993. (ap_out)->port = (r)->port_field; \
  994. return 0; \
  995. } \
  996. STMT_END
  997. /** Copy the primary (IPv4) OR port (IP address and TCP port) for
  998. * <b>node</b> into *<b>ap_out</b>. Return 0 if a valid address and
  999. * port was copied, else return non-zero.*/
  1000. int
  1001. node_get_prim_orport(const node_t *node, tor_addr_port_t *ap_out)
  1002. {
  1003. node_assert_ok(node);
  1004. tor_assert(ap_out);
  1005. RETURN_IPV4_AP(node->ri, or_port, ap_out);
  1006. RETURN_IPV4_AP(node->rs, or_port, ap_out);
  1007. /* Microdescriptors only have an IPv6 address */
  1008. return -1;
  1009. }
  1010. /** Copy the preferred OR port (IP address and TCP port) for
  1011. * <b>node</b> into *<b>ap_out</b>. */
  1012. void
  1013. node_get_pref_orport(const node_t *node, tor_addr_port_t *ap_out)
  1014. {
  1015. tor_assert(ap_out);
  1016. if (node_ipv6_or_preferred(node)) {
  1017. node_get_pref_ipv6_orport(node, ap_out);
  1018. } else {
  1019. /* the primary ORPort is always on IPv4 */
  1020. node_get_prim_orport(node, ap_out);
  1021. }
  1022. }
  1023. /** Copy the preferred IPv6 OR port (IP address and TCP port) for
  1024. * <b>node</b> into *<b>ap_out</b>. */
  1025. void
  1026. node_get_pref_ipv6_orport(const node_t *node, tor_addr_port_t *ap_out)
  1027. {
  1028. node_assert_ok(node);
  1029. tor_assert(ap_out);
  1030. /* Prefer routerstatus over microdesc for consistency with the
  1031. * fascist_firewall_* functions. Also check if the address or port are valid,
  1032. * and try another alternative if they are not. */
  1033. if (node->ri && tor_addr_port_is_valid(&node->ri->ipv6_addr,
  1034. node->ri->ipv6_orport, 0)) {
  1035. tor_addr_copy(&ap_out->addr, &node->ri->ipv6_addr);
  1036. ap_out->port = node->ri->ipv6_orport;
  1037. } else if (node->rs && tor_addr_port_is_valid(&node->rs->ipv6_addr,
  1038. node->rs->ipv6_orport, 0)) {
  1039. tor_addr_copy(&ap_out->addr, &node->rs->ipv6_addr);
  1040. ap_out->port = node->rs->ipv6_orport;
  1041. } else if (node->md && tor_addr_port_is_valid(&node->md->ipv6_addr,
  1042. node->md->ipv6_orport, 0)) {
  1043. tor_addr_copy(&ap_out->addr, &node->md->ipv6_addr);
  1044. ap_out->port = node->md->ipv6_orport;
  1045. } else {
  1046. tor_addr_make_null(&ap_out->addr, AF_INET6);
  1047. ap_out->port = 0;
  1048. }
  1049. }
  1050. /** Return 1 if we prefer the IPv6 address and Dir TCP port of
  1051. * <b>node</b>, else 0.
  1052. *
  1053. * We prefer the IPv6 address if the router has an IPv6 address,
  1054. * and we can use IPv6 addresses, and:
  1055. * i) the router has no IPv4 Dir address.
  1056. * or
  1057. * ii) our preference is for IPv6 Dir addresses.
  1058. *
  1059. * If there is no node, use fascist_firewall_prefer_ipv6_dirport().
  1060. */
  1061. int
  1062. node_ipv6_dir_preferred(const node_t *node)
  1063. {
  1064. const or_options_t *options = get_options();
  1065. tor_addr_port_t ipv4_addr;
  1066. node_assert_ok(node);
  1067. /* node->ipv6_preferred is set from fascist_firewall_prefer_ipv6_orport(),
  1068. * so we can't use it to determine DirPort IPv6 preference.
  1069. * This means that bridge clients will use IPv4 DirPorts by default.
  1070. */
  1071. if (!fascist_firewall_use_ipv6(options)) {
  1072. return 0;
  1073. } else if (node_get_prim_dirport(node, &ipv4_addr)
  1074. || fascist_firewall_prefer_ipv6_dirport(get_options())) {
  1075. return node_has_ipv6_dirport(node);
  1076. }
  1077. return 0;
  1078. }
  1079. /** Copy the primary (IPv4) Dir port (IP address and TCP port) for
  1080. * <b>node</b> into *<b>ap_out</b>. Return 0 if a valid address and
  1081. * port was copied, else return non-zero.*/
  1082. int
  1083. node_get_prim_dirport(const node_t *node, tor_addr_port_t *ap_out)
  1084. {
  1085. node_assert_ok(node);
  1086. tor_assert(ap_out);
  1087. RETURN_IPV4_AP(node->ri, dir_port, ap_out);
  1088. RETURN_IPV4_AP(node->rs, dir_port, ap_out);
  1089. /* Microdescriptors only have an IPv6 address */
  1090. return -1;
  1091. }
  1092. #undef RETURN_IPV4_AP
  1093. /** Copy the preferred Dir port (IP address and TCP port) for
  1094. * <b>node</b> into *<b>ap_out</b>. */
  1095. void
  1096. node_get_pref_dirport(const node_t *node, tor_addr_port_t *ap_out)
  1097. {
  1098. tor_assert(ap_out);
  1099. if (node_ipv6_dir_preferred(node)) {
  1100. node_get_pref_ipv6_dirport(node, ap_out);
  1101. } else {
  1102. /* the primary DirPort is always on IPv4 */
  1103. node_get_prim_dirport(node, ap_out);
  1104. }
  1105. }
  1106. /** Copy the preferred IPv6 Dir port (IP address and TCP port) for
  1107. * <b>node</b> into *<b>ap_out</b>. */
  1108. void
  1109. node_get_pref_ipv6_dirport(const node_t *node, tor_addr_port_t *ap_out)
  1110. {
  1111. node_assert_ok(node);
  1112. tor_assert(ap_out);
  1113. /* Check if the address or port are valid, and try another alternative if
  1114. * they are not. Note that microdescriptors have no dir_port. */
  1115. /* Assume IPv4 and IPv6 dirports are the same */
  1116. if (node->ri && tor_addr_port_is_valid(&node->ri->ipv6_addr,
  1117. node->ri->dir_port, 0)) {
  1118. tor_addr_copy(&ap_out->addr, &node->ri->ipv6_addr);
  1119. ap_out->port = node->ri->dir_port;
  1120. } else if (node->rs && tor_addr_port_is_valid(&node->rs->ipv6_addr,
  1121. node->rs->dir_port, 0)) {
  1122. tor_addr_copy(&ap_out->addr, &node->rs->ipv6_addr);
  1123. ap_out->port = node->rs->dir_port;
  1124. } else {
  1125. tor_addr_make_null(&ap_out->addr, AF_INET6);
  1126. ap_out->port = 0;
  1127. }
  1128. }
  1129. /** Return true iff <b>md</b> has a curve25519 onion key.
  1130. * Use node_has_curve25519_onion_key() instead of calling this directly. */
  1131. static int
  1132. microdesc_has_curve25519_onion_key(const microdesc_t *md)
  1133. {
  1134. if (!md) {
  1135. return 0;
  1136. }
  1137. if (!md->onion_curve25519_pkey) {
  1138. return 0;
  1139. }
  1140. if (tor_mem_is_zero((const char*)md->onion_curve25519_pkey->public_key,
  1141. CURVE25519_PUBKEY_LEN)) {
  1142. return 0;
  1143. }
  1144. return 1;
  1145. }
  1146. /** Return true iff <b>node</b> has a curve25519 onion key. */
  1147. int
  1148. node_has_curve25519_onion_key(const node_t *node)
  1149. {
  1150. if (!node)
  1151. return 0;
  1152. if (node->ri)
  1153. return routerinfo_has_curve25519_onion_key(node->ri);
  1154. else if (node->md)
  1155. return microdesc_has_curve25519_onion_key(node->md);
  1156. else
  1157. return 0;
  1158. }
  1159. /** Refresh the country code of <b>ri</b>. This function MUST be called on
  1160. * each router when the GeoIP database is reloaded, and on all new routers. */
  1161. void
  1162. node_set_country(node_t *node)
  1163. {
  1164. tor_addr_t addr = TOR_ADDR_NULL;
  1165. /* XXXXipv6 */
  1166. if (node->rs)
  1167. tor_addr_from_ipv4h(&addr, node->rs->addr);
  1168. else if (node->ri)
  1169. tor_addr_from_ipv4h(&addr, node->ri->addr);
  1170. node->country = geoip_get_country_by_addr(&addr);
  1171. }
  1172. /** Set the country code of all routers in the routerlist. */
  1173. void
  1174. nodelist_refresh_countries(void)
  1175. {
  1176. smartlist_t *nodes = nodelist_get_list();
  1177. SMARTLIST_FOREACH(nodes, node_t *, node,
  1178. node_set_country(node));
  1179. }
  1180. /** Return true iff router1 and router2 have similar enough network addresses
  1181. * that we should treat them as being in the same family */
  1182. static inline int
  1183. addrs_in_same_network_family(const tor_addr_t *a1,
  1184. const tor_addr_t *a2)
  1185. {
  1186. return 0 == tor_addr_compare_masked(a1, a2, 16, CMP_SEMANTIC);
  1187. }
  1188. /** Return true if <b>node</b>'s nickname matches <b>nickname</b>
  1189. * (case-insensitive), or if <b>node's</b> identity key digest
  1190. * matches a hexadecimal value stored in <b>nickname</b>. Return
  1191. * false otherwise. */
  1192. static int
  1193. node_nickname_matches(const node_t *node, const char *nickname)
  1194. {
  1195. const char *n = node_get_nickname(node);
  1196. if (n && nickname[0]!='$' && !strcasecmp(n, nickname))
  1197. return 1;
  1198. return hex_digest_nickname_matches(nickname,
  1199. node->identity,
  1200. n,
  1201. node_is_named(node));
  1202. }
  1203. /** Return true iff <b>node</b> is named by some nickname in <b>lst</b>. */
  1204. static inline int
  1205. node_in_nickname_smartlist(const smartlist_t *lst, const node_t *node)
  1206. {
  1207. if (!lst) return 0;
  1208. SMARTLIST_FOREACH(lst, const char *, name, {
  1209. if (node_nickname_matches(node, name))
  1210. return 1;
  1211. });
  1212. return 0;
  1213. }
  1214. /** Return true iff r1 and r2 are in the same family, but not the same
  1215. * router. */
  1216. int
  1217. nodes_in_same_family(const node_t *node1, const node_t *node2)
  1218. {
  1219. const or_options_t *options = get_options();
  1220. /* Are they in the same family because of their addresses? */
  1221. if (options->EnforceDistinctSubnets) {
  1222. tor_addr_t a1, a2;
  1223. node_get_addr(node1, &a1);
  1224. node_get_addr(node2, &a2);
  1225. if (addrs_in_same_network_family(&a1, &a2))
  1226. return 1;
  1227. }
  1228. /* Are they in the same family because the agree they are? */
  1229. {
  1230. const smartlist_t *f1, *f2;
  1231. f1 = node_get_declared_family(node1);
  1232. f2 = node_get_declared_family(node2);
  1233. if (f1 && f2 &&
  1234. node_in_nickname_smartlist(f1, node2) &&
  1235. node_in_nickname_smartlist(f2, node1))
  1236. return 1;
  1237. }
  1238. /* Are they in the same option because the user says they are? */
  1239. if (options->NodeFamilySets) {
  1240. SMARTLIST_FOREACH(options->NodeFamilySets, const routerset_t *, rs, {
  1241. if (routerset_contains_node(rs, node1) &&
  1242. routerset_contains_node(rs, node2))
  1243. return 1;
  1244. });
  1245. }
  1246. return 0;
  1247. }
  1248. /**
  1249. * Add all the family of <b>node</b>, including <b>node</b> itself, to
  1250. * the smartlist <b>sl</b>.
  1251. *
  1252. * This is used to make sure we don't pick siblings in a single path, or
  1253. * pick more than one relay from a family for our entry guard list.
  1254. * Note that a node may be added to <b>sl</b> more than once if it is
  1255. * part of <b>node</b>'s family for more than one reason.
  1256. */
  1257. void
  1258. nodelist_add_node_and_family(smartlist_t *sl, const node_t *node)
  1259. {
  1260. const smartlist_t *all_nodes = nodelist_get_list();
  1261. const smartlist_t *declared_family;
  1262. const or_options_t *options = get_options();
  1263. tor_assert(node);
  1264. declared_family = node_get_declared_family(node);
  1265. /* Let's make sure that we have the node itself, if it's a real node. */
  1266. {
  1267. const node_t *real_node = node_get_by_id(node->identity);
  1268. if (real_node)
  1269. smartlist_add(sl, (node_t*)real_node);
  1270. }
  1271. /* First, add any nodes with similar network addresses. */
  1272. if (options->EnforceDistinctSubnets) {
  1273. tor_addr_t node_addr;
  1274. node_get_addr(node, &node_addr);
  1275. SMARTLIST_FOREACH_BEGIN(all_nodes, const node_t *, node2) {
  1276. tor_addr_t a;
  1277. node_get_addr(node2, &a);
  1278. if (addrs_in_same_network_family(&a, &node_addr))
  1279. smartlist_add(sl, (void*)node2);
  1280. } SMARTLIST_FOREACH_END(node2);
  1281. }
  1282. /* Now, add all nodes in the declared_family of this node, if they
  1283. * also declare this node to be in their family. */
  1284. if (declared_family) {
  1285. /* Add every r such that router declares familyness with node, and node
  1286. * declares familyhood with router. */
  1287. SMARTLIST_FOREACH_BEGIN(declared_family, const char *, name) {
  1288. const node_t *node2;
  1289. const smartlist_t *family2;
  1290. if (!(node2 = node_get_by_nickname(name, 0)))
  1291. continue;
  1292. if (!(family2 = node_get_declared_family(node2)))
  1293. continue;
  1294. SMARTLIST_FOREACH_BEGIN(family2, const char *, name2) {
  1295. if (node_nickname_matches(node, name2)) {
  1296. smartlist_add(sl, (void*)node2);
  1297. break;
  1298. }
  1299. } SMARTLIST_FOREACH_END(name2);
  1300. } SMARTLIST_FOREACH_END(name);
  1301. }
  1302. /* If the user declared any families locally, honor those too. */
  1303. if (options->NodeFamilySets) {
  1304. SMARTLIST_FOREACH(options->NodeFamilySets, const routerset_t *, rs, {
  1305. if (routerset_contains_node(rs, node)) {
  1306. routerset_get_all_nodes(sl, rs, NULL, 0);
  1307. }
  1308. });
  1309. }
  1310. }
  1311. /** Find a router that's up, that has this IP address, and
  1312. * that allows exit to this address:port, or return NULL if there
  1313. * isn't a good one.
  1314. * Don't exit enclave to excluded relays -- it wouldn't actually
  1315. * hurt anything, but this way there are fewer confused users.
  1316. */
  1317. const node_t *
  1318. router_find_exact_exit_enclave(const char *address, uint16_t port)
  1319. {/*XXXX MOVE*/
  1320. uint32_t addr;
  1321. struct in_addr in;
  1322. tor_addr_t a;
  1323. const or_options_t *options = get_options();
  1324. if (!tor_inet_aton(address, &in))
  1325. return NULL; /* it's not an IP already */
  1326. addr = ntohl(in.s_addr);
  1327. tor_addr_from_ipv4h(&a, addr);
  1328. SMARTLIST_FOREACH(nodelist_get_list(), const node_t *, node, {
  1329. if (node_get_addr_ipv4h(node) == addr &&
  1330. node->is_running &&
  1331. compare_tor_addr_to_node_policy(&a, port, node) ==
  1332. ADDR_POLICY_ACCEPTED &&
  1333. !routerset_contains_node(options->ExcludeExitNodesUnion_, node))
  1334. return node;
  1335. });
  1336. return NULL;
  1337. }
  1338. /** Return 1 if <b>router</b> is not suitable for these parameters, else 0.
  1339. * If <b>need_uptime</b> is non-zero, we require a minimum uptime.
  1340. * If <b>need_capacity</b> is non-zero, we require a minimum advertised
  1341. * bandwidth.
  1342. * If <b>need_guard</b>, we require that the router is a possible entry guard.
  1343. */
  1344. int
  1345. node_is_unreliable(const node_t *node, int need_uptime,
  1346. int need_capacity, int need_guard)
  1347. {
  1348. if (need_uptime && !node->is_stable)
  1349. return 1;
  1350. if (need_capacity && !node->is_fast)
  1351. return 1;
  1352. if (need_guard && !node->is_possible_guard)
  1353. return 1;
  1354. return 0;
  1355. }
  1356. /** Return 1 if all running sufficiently-stable routers we can use will reject
  1357. * addr:port. Return 0 if any might accept it. */
  1358. int
  1359. router_exit_policy_all_nodes_reject(const tor_addr_t *addr, uint16_t port,
  1360. int need_uptime)
  1361. {
  1362. addr_policy_result_t r;
  1363. SMARTLIST_FOREACH_BEGIN(nodelist_get_list(), const node_t *, node) {
  1364. if (node->is_running &&
  1365. !node_is_unreliable(node, need_uptime, 0, 0)) {
  1366. r = compare_tor_addr_to_node_policy(addr, port, node);
  1367. if (r != ADDR_POLICY_REJECTED && r != ADDR_POLICY_PROBABLY_REJECTED)
  1368. return 0; /* this one could be ok. good enough. */
  1369. }
  1370. } SMARTLIST_FOREACH_END(node);
  1371. return 1; /* all will reject. */
  1372. }
  1373. /** Mark the router with ID <b>digest</b> as running or non-running
  1374. * in our routerlist. */
  1375. void
  1376. router_set_status(const char *digest, int up)
  1377. {
  1378. node_t *node;
  1379. tor_assert(digest);
  1380. SMARTLIST_FOREACH(router_get_fallback_dir_servers(),
  1381. dir_server_t *, d,
  1382. if (tor_memeq(d->digest, digest, DIGEST_LEN))
  1383. d->is_running = up);
  1384. SMARTLIST_FOREACH(router_get_trusted_dir_servers(),
  1385. dir_server_t *, d,
  1386. if (tor_memeq(d->digest, digest, DIGEST_LEN))
  1387. d->is_running = up);
  1388. node = node_get_mutable_by_id(digest);
  1389. if (node) {
  1390. #if 0
  1391. log_debug(LD_DIR,"Marking router %s as %s.",
  1392. node_describe(node), up ? "up" : "down");
  1393. #endif
  1394. if (!up && node_is_me(node) && !net_is_disabled())
  1395. log_warn(LD_NET, "We just marked ourself as down. Are your external "
  1396. "addresses reachable?");
  1397. if (bool_neq(node->is_running, up))
  1398. router_dir_info_changed();
  1399. node->is_running = up;
  1400. }
  1401. }
  1402. /** True iff, the last time we checked whether we had enough directory info
  1403. * to build circuits, the answer was "yes". If there are no exits in the
  1404. * consensus, we act as if we have 100% of the exit directory info. */
  1405. static int have_min_dir_info = 0;
  1406. /** Does the consensus contain nodes that can exit? */
  1407. static consensus_path_type_t have_consensus_path = CONSENSUS_PATH_UNKNOWN;
  1408. /** True iff enough has changed since the last time we checked whether we had
  1409. * enough directory info to build circuits that our old answer can no longer
  1410. * be trusted. */
  1411. static int need_to_update_have_min_dir_info = 1;
  1412. /** String describing what we're missing before we have enough directory
  1413. * info. */
  1414. static char dir_info_status[512] = "";
  1415. /** Return true iff we have enough consensus information to
  1416. * start building circuits. Right now, this means "a consensus that's
  1417. * less than a day old, and at least 60% of router descriptors (configurable),
  1418. * weighted by bandwidth. Treat the exit fraction as 100% if there are
  1419. * no exits in the consensus."
  1420. * To obtain the final weighted bandwidth, we multiply the
  1421. * weighted bandwidth fraction for each position (guard, middle, exit). */
  1422. int
  1423. router_have_minimum_dir_info(void)
  1424. {
  1425. static int logged_delay=0;
  1426. const char *delay_fetches_msg = NULL;
  1427. if (should_delay_dir_fetches(get_options(), &delay_fetches_msg)) {
  1428. if (!logged_delay)
  1429. log_notice(LD_DIR, "Delaying directory fetches: %s", delay_fetches_msg);
  1430. logged_delay=1;
  1431. strlcpy(dir_info_status, delay_fetches_msg, sizeof(dir_info_status));
  1432. return 0;
  1433. }
  1434. logged_delay = 0; /* reset it if we get this far */
  1435. if (PREDICT_UNLIKELY(need_to_update_have_min_dir_info)) {
  1436. update_router_have_minimum_dir_info();
  1437. }
  1438. return have_min_dir_info;
  1439. }
  1440. /** Set to CONSENSUS_PATH_EXIT if there is at least one exit node
  1441. * in the consensus. We update this flag in compute_frac_paths_available if
  1442. * there is at least one relay that has an Exit flag in the consensus.
  1443. * Used to avoid building exit circuits when they will almost certainly fail.
  1444. * Set to CONSENSUS_PATH_INTERNAL if there are no exits in the consensus.
  1445. * (This situation typically occurs during bootstrap of a test network.)
  1446. * Set to CONSENSUS_PATH_UNKNOWN if we have never checked, or have
  1447. * reason to believe our last known value was invalid or has expired.
  1448. * If we're in a network with TestingDirAuthVoteExit set,
  1449. * this can cause router_have_consensus_path() to be set to
  1450. * CONSENSUS_PATH_EXIT, even if there are no nodes with accept exit policies.
  1451. */
  1452. MOCK_IMPL(consensus_path_type_t,
  1453. router_have_consensus_path, (void))
  1454. {
  1455. return have_consensus_path;
  1456. }
  1457. /** Called when our internal view of the directory has changed. This can be
  1458. * when the authorities change, networkstatuses change, the list of routerdescs
  1459. * changes, or number of running routers changes.
  1460. */
  1461. void
  1462. router_dir_info_changed(void)
  1463. {
  1464. need_to_update_have_min_dir_info = 1;
  1465. rend_hsdir_routers_changed();
  1466. }
  1467. /** Return a string describing what we're missing before we have enough
  1468. * directory info. */
  1469. const char *
  1470. get_dir_info_status_string(void)
  1471. {
  1472. return dir_info_status;
  1473. }
  1474. /** Iterate over the servers listed in <b>consensus</b>, and count how many of
  1475. * them seem like ones we'd use (store this in *<b>num_usable</b>), and how
  1476. * many of <em>those</em> we have descriptors for (store this in
  1477. * *<b>num_present</b>).
  1478. *
  1479. * If <b>in_set</b> is non-NULL, only consider those routers in <b>in_set</b>.
  1480. * If <b>exit_only</b> is USABLE_DESCRIPTOR_EXIT_ONLY, only consider nodes
  1481. * with the Exit flag.
  1482. * If *<b>descs_out</b> is present, add a node_t for each usable descriptor
  1483. * to it.
  1484. */
  1485. static void
  1486. count_usable_descriptors(int *num_present, int *num_usable,
  1487. smartlist_t *descs_out,
  1488. const networkstatus_t *consensus,
  1489. const or_options_t *options, time_t now,
  1490. routerset_t *in_set,
  1491. usable_descriptor_t exit_only)
  1492. {
  1493. const int md = (consensus->flavor == FLAV_MICRODESC);
  1494. *num_present = 0, *num_usable = 0;
  1495. SMARTLIST_FOREACH_BEGIN(consensus->routerstatus_list, routerstatus_t *, rs)
  1496. {
  1497. const node_t *node = node_get_by_id(rs->identity_digest);
  1498. if (!node)
  1499. continue; /* This would be a bug: every entry in the consensus is
  1500. * supposed to have a node. */
  1501. if (exit_only == USABLE_DESCRIPTOR_EXIT_ONLY && ! rs->is_exit)
  1502. continue;
  1503. if (in_set && ! routerset_contains_routerstatus(in_set, rs, -1))
  1504. continue;
  1505. if (client_would_use_router(rs, now, options)) {
  1506. const char * const digest = rs->descriptor_digest;
  1507. int present;
  1508. ++*num_usable; /* the consensus says we want it. */
  1509. if (md)
  1510. present = NULL != microdesc_cache_lookup_by_digest256(NULL, digest);
  1511. else
  1512. present = NULL != router_get_by_descriptor_digest(digest);
  1513. if (present) {
  1514. /* we have the descriptor listed in the consensus. */
  1515. ++*num_present;
  1516. }
  1517. if (descs_out)
  1518. smartlist_add(descs_out, (node_t*)node);
  1519. }
  1520. }
  1521. SMARTLIST_FOREACH_END(rs);
  1522. log_debug(LD_DIR, "%d usable, %d present (%s%s).",
  1523. *num_usable, *num_present,
  1524. md ? "microdesc" : "desc",
  1525. exit_only == USABLE_DESCRIPTOR_EXIT_ONLY ? " exits" : "s");
  1526. }
  1527. /** Return an estimate of which fraction of usable paths through the Tor
  1528. * network we have available for use. Count how many routers seem like ones
  1529. * we'd use (store this in *<b>num_usable_out</b>), and how many of
  1530. * <em>those</em> we have descriptors for (store this in
  1531. * *<b>num_present_out</b>.)
  1532. *
  1533. * If **<b>status_out</b> is present, allocate a new string and print the
  1534. * available percentages of guard, middle, and exit nodes to it, noting
  1535. * whether there are exits in the consensus.
  1536. * If there are no guards in the consensus,
  1537. * we treat the exit fraction as 100%.
  1538. */
  1539. static double
  1540. compute_frac_paths_available(const networkstatus_t *consensus,
  1541. const or_options_t *options, time_t now,
  1542. int *num_present_out, int *num_usable_out,
  1543. char **status_out)
  1544. {
  1545. smartlist_t *guards = smartlist_new();
  1546. smartlist_t *mid = smartlist_new();
  1547. smartlist_t *exits = smartlist_new();
  1548. double f_guard, f_mid, f_exit;
  1549. double f_path = 0.0;
  1550. /* Used to determine whether there are any exits in the consensus */
  1551. int np = 0;
  1552. /* Used to determine whether there are any exits with descriptors */
  1553. int nu = 0;
  1554. const int authdir = authdir_mode_v3(options);
  1555. count_usable_descriptors(num_present_out, num_usable_out,
  1556. mid, consensus, options, now, NULL,
  1557. USABLE_DESCRIPTOR_ALL);
  1558. if (options->EntryNodes) {
  1559. count_usable_descriptors(&np, &nu, guards, consensus, options, now,
  1560. options->EntryNodes, USABLE_DESCRIPTOR_ALL);
  1561. } else {
  1562. SMARTLIST_FOREACH(mid, const node_t *, node, {
  1563. if (authdir) {
  1564. if (node->rs && node->rs->is_possible_guard)
  1565. smartlist_add(guards, (node_t*)node);
  1566. } else {
  1567. if (node->is_possible_guard)
  1568. smartlist_add(guards, (node_t*)node);
  1569. }
  1570. });
  1571. }
  1572. /* All nodes with exit flag
  1573. * If we're in a network with TestingDirAuthVoteExit set,
  1574. * this can cause false positives on have_consensus_path,
  1575. * incorrectly setting it to CONSENSUS_PATH_EXIT. This is
  1576. * an unavoidable feature of forcing authorities to declare
  1577. * certain nodes as exits.
  1578. */
  1579. count_usable_descriptors(&np, &nu, exits, consensus, options, now,
  1580. NULL, USABLE_DESCRIPTOR_EXIT_ONLY);
  1581. log_debug(LD_NET,
  1582. "%s: %d present, %d usable",
  1583. "exits",
  1584. np,
  1585. nu);
  1586. /* We need at least 1 exit present in the consensus to consider
  1587. * building exit paths */
  1588. /* Update our understanding of whether the consensus has exits */
  1589. consensus_path_type_t old_have_consensus_path = have_consensus_path;
  1590. have_consensus_path = ((nu > 0) ?
  1591. CONSENSUS_PATH_EXIT :
  1592. CONSENSUS_PATH_INTERNAL);
  1593. if (have_consensus_path == CONSENSUS_PATH_INTERNAL
  1594. && old_have_consensus_path != have_consensus_path) {
  1595. log_notice(LD_NET,
  1596. "The current consensus has no exit nodes. "
  1597. "Tor can only build internal paths, "
  1598. "such as paths to hidden services.");
  1599. /* However, exit nodes can reachability self-test using this consensus,
  1600. * join the network, and appear in a later consensus. This will allow
  1601. * the network to build exit paths, such as paths for world wide web
  1602. * browsing (as distinct from hidden service web browsing). */
  1603. }
  1604. f_guard = frac_nodes_with_descriptors(guards, WEIGHT_FOR_GUARD);
  1605. f_mid = frac_nodes_with_descriptors(mid, WEIGHT_FOR_MID);
  1606. f_exit = frac_nodes_with_descriptors(exits, WEIGHT_FOR_EXIT);
  1607. log_debug(LD_NET,
  1608. "f_guard: %.2f, f_mid: %.2f, f_exit: %.2f",
  1609. f_guard,
  1610. f_mid,
  1611. f_exit);
  1612. smartlist_free(guards);
  1613. smartlist_free(mid);
  1614. smartlist_free(exits);
  1615. if (options->ExitNodes) {
  1616. double f_myexit, f_myexit_unflagged;
  1617. smartlist_t *myexits= smartlist_new();
  1618. smartlist_t *myexits_unflagged = smartlist_new();
  1619. /* All nodes with exit flag in ExitNodes option */
  1620. count_usable_descriptors(&np, &nu, myexits, consensus, options, now,
  1621. options->ExitNodes, USABLE_DESCRIPTOR_EXIT_ONLY);
  1622. log_debug(LD_NET,
  1623. "%s: %d present, %d usable",
  1624. "myexits",
  1625. np,
  1626. nu);
  1627. /* Now compute the nodes in the ExitNodes option where which we don't know
  1628. * what their exit policy is, or we know it permits something. */
  1629. count_usable_descriptors(&np, &nu, myexits_unflagged,
  1630. consensus, options, now,
  1631. options->ExitNodes, USABLE_DESCRIPTOR_ALL);
  1632. log_debug(LD_NET,
  1633. "%s: %d present, %d usable",
  1634. "myexits_unflagged (initial)",
  1635. np,
  1636. nu);
  1637. SMARTLIST_FOREACH_BEGIN(myexits_unflagged, const node_t *, node) {
  1638. if (node_has_descriptor(node) && node_exit_policy_rejects_all(node)) {
  1639. SMARTLIST_DEL_CURRENT(myexits_unflagged, node);
  1640. /* this node is not actually an exit */
  1641. np--;
  1642. /* this node is unusable as an exit */
  1643. nu--;
  1644. }
  1645. } SMARTLIST_FOREACH_END(node);
  1646. log_debug(LD_NET,
  1647. "%s: %d present, %d usable",
  1648. "myexits_unflagged (final)",
  1649. np,
  1650. nu);
  1651. f_myexit= frac_nodes_with_descriptors(myexits,WEIGHT_FOR_EXIT);
  1652. f_myexit_unflagged=
  1653. frac_nodes_with_descriptors(myexits_unflagged,WEIGHT_FOR_EXIT);
  1654. log_debug(LD_NET,
  1655. "f_exit: %.2f, f_myexit: %.2f, f_myexit_unflagged: %.2f",
  1656. f_exit,
  1657. f_myexit,
  1658. f_myexit_unflagged);
  1659. /* If our ExitNodes list has eliminated every possible Exit node, and there
  1660. * were some possible Exit nodes, then instead consider nodes that permit
  1661. * exiting to some ports. */
  1662. if (smartlist_len(myexits) == 0 &&
  1663. smartlist_len(myexits_unflagged)) {
  1664. f_myexit = f_myexit_unflagged;
  1665. }
  1666. smartlist_free(myexits);
  1667. smartlist_free(myexits_unflagged);
  1668. /* This is a tricky point here: we don't want to make it easy for a
  1669. * directory to trickle exits to us until it learns which exits we have
  1670. * configured, so require that we have a threshold both of total exits
  1671. * and usable exits. */
  1672. if (f_myexit < f_exit)
  1673. f_exit = f_myexit;
  1674. }
  1675. /* if the consensus has no exits, treat the exit fraction as 100% */
  1676. if (router_have_consensus_path() != CONSENSUS_PATH_EXIT) {
  1677. f_exit = 1.0;
  1678. }
  1679. f_path = f_guard * f_mid * f_exit;
  1680. if (status_out)
  1681. tor_asprintf(status_out,
  1682. "%d%% of guards bw, "
  1683. "%d%% of midpoint bw, and "
  1684. "%d%% of exit bw%s = "
  1685. "%d%% of path bw",
  1686. (int)(f_guard*100),
  1687. (int)(f_mid*100),
  1688. (int)(f_exit*100),
  1689. (router_have_consensus_path() == CONSENSUS_PATH_EXIT ?
  1690. "" :
  1691. " (no exits in consensus)"),
  1692. (int)(f_path*100));
  1693. return f_path;
  1694. }
  1695. /** We just fetched a new set of descriptors. Compute how far through
  1696. * the "loading descriptors" bootstrapping phase we are, so we can inform
  1697. * the controller of our progress. */
  1698. int
  1699. count_loading_descriptors_progress(void)
  1700. {
  1701. int num_present = 0, num_usable=0;
  1702. time_t now = time(NULL);
  1703. const or_options_t *options = get_options();
  1704. const networkstatus_t *consensus =
  1705. networkstatus_get_reasonably_live_consensus(now,usable_consensus_flavor());
  1706. double paths, fraction;
  1707. if (!consensus)
  1708. return 0; /* can't count descriptors if we have no list of them */
  1709. paths = compute_frac_paths_available(consensus, options, now,
  1710. &num_present, &num_usable,
  1711. NULL);
  1712. fraction = paths / get_frac_paths_needed_for_circs(options,consensus);
  1713. if (fraction > 1.0)
  1714. return 0; /* it's not the number of descriptors holding us back */
  1715. return BOOTSTRAP_STATUS_LOADING_DESCRIPTORS + (int)
  1716. (fraction*(BOOTSTRAP_STATUS_CONN_OR-1 -
  1717. BOOTSTRAP_STATUS_LOADING_DESCRIPTORS));
  1718. }
  1719. /** Return the fraction of paths needed before we're willing to build
  1720. * circuits, as configured in <b>options</b>, or in the consensus <b>ns</b>. */
  1721. static double
  1722. get_frac_paths_needed_for_circs(const or_options_t *options,
  1723. const networkstatus_t *ns)
  1724. {
  1725. #define DFLT_PCT_USABLE_NEEDED 60
  1726. if (options->PathsNeededToBuildCircuits >= 0.0) {
  1727. return options->PathsNeededToBuildCircuits;
  1728. } else {
  1729. return networkstatus_get_param(ns, "min_paths_for_circs_pct",
  1730. DFLT_PCT_USABLE_NEEDED,
  1731. 25, 95)/100.0;
  1732. }
  1733. }
  1734. /** Change the value of have_min_dir_info, setting it true iff we have enough
  1735. * network and router information to build circuits. Clear the value of
  1736. * need_to_update_have_min_dir_info. */
  1737. static void
  1738. update_router_have_minimum_dir_info(void)
  1739. {
  1740. time_t now = time(NULL);
  1741. int res;
  1742. const or_options_t *options = get_options();
  1743. const networkstatus_t *consensus =
  1744. networkstatus_get_reasonably_live_consensus(now,usable_consensus_flavor());
  1745. int using_md;
  1746. if (!consensus) {
  1747. if (!networkstatus_get_latest_consensus())
  1748. strlcpy(dir_info_status, "We have no usable consensus.",
  1749. sizeof(dir_info_status));
  1750. else
  1751. strlcpy(dir_info_status, "We have no recent usable consensus.",
  1752. sizeof(dir_info_status));
  1753. res = 0;
  1754. goto done;
  1755. }
  1756. using_md = consensus->flavor == FLAV_MICRODESC;
  1757. /* Check fraction of available paths */
  1758. {
  1759. char *status = NULL;
  1760. int num_present=0, num_usable=0;
  1761. double paths = compute_frac_paths_available(consensus, options, now,
  1762. &num_present, &num_usable,
  1763. &status);
  1764. if (paths < get_frac_paths_needed_for_circs(options,consensus)) {
  1765. tor_snprintf(dir_info_status, sizeof(dir_info_status),
  1766. "We need more %sdescriptors: we have %d/%d, and "
  1767. "can only build %d%% of likely paths. (We have %s.)",
  1768. using_md?"micro":"", num_present, num_usable,
  1769. (int)(paths*100), status);
  1770. tor_free(status);
  1771. res = 0;
  1772. control_event_bootstrap(BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS, 0);
  1773. goto done;
  1774. }
  1775. tor_free(status);
  1776. res = 1;
  1777. }
  1778. done:
  1779. /* If paths have just become available in this update. */
  1780. if (res && !have_min_dir_info) {
  1781. control_event_client_status(LOG_NOTICE, "ENOUGH_DIR_INFO");
  1782. if (control_event_bootstrap(BOOTSTRAP_STATUS_CONN_OR, 0) == 0) {
  1783. log_notice(LD_DIR,
  1784. "We now have enough directory information to build circuits.");
  1785. }
  1786. }
  1787. /* If paths have just become unavailable in this update. */
  1788. if (!res && have_min_dir_info) {
  1789. int quiet = directory_too_idle_to_fetch_descriptors(options, now);
  1790. tor_log(quiet ? LOG_INFO : LOG_NOTICE, LD_DIR,
  1791. "Our directory information is no longer up-to-date "
  1792. "enough to build circuits: %s", dir_info_status);
  1793. /* a) make us log when we next complete a circuit, so we know when Tor
  1794. * is back up and usable, and b) disable some activities that Tor
  1795. * should only do while circuits are working, like reachability tests
  1796. * and fetching bridge descriptors only over circuits. */
  1797. note_that_we_maybe_cant_complete_circuits();
  1798. have_consensus_path = CONSENSUS_PATH_UNKNOWN;
  1799. control_event_client_status(LOG_NOTICE, "NOT_ENOUGH_DIR_INFO");
  1800. }
  1801. have_min_dir_info = res;
  1802. need_to_update_have_min_dir_info = 0;
  1803. }