networkstatus.c 98 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738
  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-2018, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file networkstatus.c
  8. * \brief Functions and structures for handling networkstatus documents as a
  9. * client or as a directory cache.
  10. *
  11. * A consensus networkstatus object is created by the directory
  12. * authorities. It authenticates a set of network parameters--most
  13. * importantly, the list of all the relays in the network. This list
  14. * of relays is represented as an array of routerstatus_t objects.
  15. *
  16. * There are currently two flavors of consensus. With the older "NS"
  17. * flavor, each relay is associated with a digest of its router
  18. * descriptor. Tor instances that use this consensus keep the list of
  19. * router descriptors as routerinfo_t objects stored and managed in
  20. * routerlist.c. With the newer "microdesc" flavor, each relay is
  21. * associated with a digest of the microdescriptor that the authorities
  22. * made for it. These are stored and managed in microdesc.c. Information
  23. * about the router is divided between the the networkstatus and the
  24. * microdescriptor according to the general rule that microdescriptors
  25. * should hold information that changes much less frequently than the
  26. * information in the networkstatus.
  27. *
  28. * Modern clients use microdescriptor networkstatuses. Directory caches
  29. * need to keep both kinds of networkstatus document, so they can serve them.
  30. *
  31. * This module manages fetching, holding, storing, updating, and
  32. * validating networkstatus objects. The download-and-validate process
  33. * is slightly complicated by the fact that the keys you need to
  34. * validate a consensus are stored in the authority certificates, which
  35. * you might not have yet when you download the consensus.
  36. */
  37. #define NETWORKSTATUS_PRIVATE
  38. #include "core/or/or.h"
  39. #include "app/config/config.h"
  40. #include "core/mainloop/connection.h"
  41. #include "core/mainloop/mainloop.h"
  42. #include "core/mainloop/netstatus.h"
  43. #include "core/or/channel.h"
  44. #include "core/or/channelpadding.h"
  45. #include "core/or/circuitmux.h"
  46. #include "core/or/circuitmux_ewma.h"
  47. #include "core/or/circuitstats.h"
  48. #include "core/or/connection_edge.h"
  49. #include "core/or/connection_or.h"
  50. #include "core/or/dos.h"
  51. #include "core/or/protover.h"
  52. #include "core/or/relay.h"
  53. #include "core/or/scheduler.h"
  54. #include "core/or/versions.h"
  55. #include "feature/client/bridges.h"
  56. #include "feature/client/entrynodes.h"
  57. #include "feature/client/transports.h"
  58. #include "feature/control/control.h"
  59. #include "feature/dirauth/reachability.h"
  60. #include "feature/dircache/consdiffmgr.h"
  61. #include "feature/dircache/dirserv.h"
  62. #include "feature/dirclient/dirclient.h"
  63. #include "feature/dirclient/dlstatus.h"
  64. #include "feature/dircommon/directory.h"
  65. #include "feature/dircommon/voting_schedule.h"
  66. #include "feature/dirparse/ns_parse.h"
  67. #include "feature/hibernate/hibernate.h"
  68. #include "feature/nodelist/authcert.h"
  69. #include "feature/nodelist/dirlist.h"
  70. #include "feature/nodelist/fmt_routerstatus.h"
  71. #include "feature/nodelist/microdesc.h"
  72. #include "feature/nodelist/networkstatus.h"
  73. #include "feature/nodelist/node_select.h"
  74. #include "feature/nodelist/nodelist.h"
  75. #include "feature/nodelist/routerinfo.h"
  76. #include "feature/nodelist/routerlist.h"
  77. #include "feature/nodelist/torcert.h"
  78. #include "feature/relay/routermode.h"
  79. #include "lib/crypt_ops/crypto_rand.h"
  80. #include "lib/crypt_ops/crypto_util.h"
  81. #include "feature/dirauth/dirvote.h"
  82. #include "feature/dirauth/authmode.h"
  83. #include "feature/dirauth/shared_random.h"
  84. #include "feature/dirauth/voteflags.h"
  85. #include "feature/nodelist/authority_cert_st.h"
  86. #include "feature/dircommon/dir_connection_st.h"
  87. #include "feature/dirclient/dir_server_st.h"
  88. #include "feature/nodelist/document_signature_st.h"
  89. #include "feature/nodelist/networkstatus_st.h"
  90. #include "feature/nodelist/networkstatus_voter_info_st.h"
  91. #include "feature/dirauth/ns_detached_signatures_st.h"
  92. #include "feature/nodelist/node_st.h"
  93. #include "feature/nodelist/routerinfo_st.h"
  94. #include "feature/nodelist/routerlist_st.h"
  95. #include "feature/dirauth/vote_microdesc_hash_st.h"
  96. #include "feature/nodelist/vote_routerstatus_st.h"
  97. #ifdef HAVE_UNISTD_H
  98. #include <unistd.h>
  99. #endif
  100. /** Most recently received and validated v3 "ns"-flavored consensus network
  101. * status. */
  102. STATIC networkstatus_t *current_ns_consensus = NULL;
  103. /** Most recently received and validated v3 "microdesc"-flavored consensus
  104. * network status. */
  105. STATIC networkstatus_t *current_md_consensus = NULL;
  106. /** A v3 consensus networkstatus that we've received, but which we don't
  107. * have enough certificates to be happy about. */
  108. typedef struct consensus_waiting_for_certs_t {
  109. /** The consensus itself. */
  110. networkstatus_t *consensus;
  111. /** When did we set the current value of consensus_waiting_for_certs? If
  112. * this is too recent, we shouldn't try to fetch a new consensus for a
  113. * little while, to give ourselves time to get certificates for this one. */
  114. time_t set_at;
  115. /** Set to 1 if we've been holding on to it for so long we should maybe
  116. * treat it as being bad. */
  117. int dl_failed;
  118. } consensus_waiting_for_certs_t;
  119. /** An array, for each flavor of consensus we might want, of consensuses that
  120. * we have downloaded, but which we cannot verify due to having insufficient
  121. * authority certificates. */
  122. static consensus_waiting_for_certs_t
  123. consensus_waiting_for_certs[N_CONSENSUS_FLAVORS];
  124. /** A time before which we shouldn't try to replace the current consensus:
  125. * this will be at some point after the next consensus becomes valid, but
  126. * before the current consensus becomes invalid. */
  127. static time_t time_to_download_next_consensus[N_CONSENSUS_FLAVORS];
  128. /** Download status for the current consensus networkstatus. */
  129. static download_status_t consensus_dl_status[N_CONSENSUS_FLAVORS] =
  130. {
  131. { 0, 0, 0, DL_SCHED_CONSENSUS, DL_WANT_ANY_DIRSERVER,
  132. DL_SCHED_INCREMENT_FAILURE, 0, 0 },
  133. { 0, 0, 0, DL_SCHED_CONSENSUS, DL_WANT_ANY_DIRSERVER,
  134. DL_SCHED_INCREMENT_FAILURE, 0, 0 },
  135. };
  136. #define N_CONSENSUS_BOOTSTRAP_SCHEDULES 2
  137. #define CONSENSUS_BOOTSTRAP_SOURCE_AUTHORITY 0
  138. #define CONSENSUS_BOOTSTRAP_SOURCE_ANY_DIRSERVER 1
  139. /* Using DL_SCHED_INCREMENT_ATTEMPT on these schedules means that
  140. * download_status_increment_failure won't increment these entries.
  141. * However, any bootstrap connection failures that occur after we have
  142. * a valid consensus will count against the failure counts on the non-bootstrap
  143. * schedules. There should only be one of these, as all the others will have
  144. * been cancelled. (This doesn't seem to be a significant issue.) */
  145. static download_status_t
  146. consensus_bootstrap_dl_status[N_CONSENSUS_BOOTSTRAP_SCHEDULES] =
  147. {
  148. { 0, 0, 0, DL_SCHED_CONSENSUS, DL_WANT_AUTHORITY,
  149. DL_SCHED_INCREMENT_ATTEMPT, 0, 0 },
  150. /* During bootstrap, DL_WANT_ANY_DIRSERVER means "use fallbacks". */
  151. { 0, 0, 0, DL_SCHED_CONSENSUS, DL_WANT_ANY_DIRSERVER,
  152. DL_SCHED_INCREMENT_ATTEMPT, 0, 0 },
  153. };
  154. /** True iff we have logged a warning about this OR's version being older than
  155. * listed by the authorities. */
  156. static int have_warned_about_old_version = 0;
  157. /** True iff we have logged a warning about this OR's version being newer than
  158. * listed by the authorities. */
  159. static int have_warned_about_new_version = 0;
  160. static void update_consensus_bootstrap_multiple_downloads(
  161. time_t now,
  162. const or_options_t *options);
  163. static int networkstatus_check_required_protocols(const networkstatus_t *ns,
  164. int client_mode,
  165. char **warning_out);
  166. /** Forget that we've warned about anything networkstatus-related, so we will
  167. * give fresh warnings if the same behavior happens again. */
  168. void
  169. networkstatus_reset_warnings(void)
  170. {
  171. SMARTLIST_FOREACH(nodelist_get_list(), node_t *, node,
  172. node->name_lookup_warned = 0);
  173. have_warned_about_old_version = 0;
  174. have_warned_about_new_version = 0;
  175. }
  176. /** Reset the descriptor download failure count on all networkstatus docs, so
  177. * that we can retry any long-failed documents immediately.
  178. */
  179. void
  180. networkstatus_reset_download_failures(void)
  181. {
  182. int i;
  183. log_debug(LD_GENERAL,
  184. "In networkstatus_reset_download_failures()");
  185. for (i=0; i < N_CONSENSUS_FLAVORS; ++i)
  186. download_status_reset(&consensus_dl_status[i]);
  187. for (i=0; i < N_CONSENSUS_BOOTSTRAP_SCHEDULES; ++i)
  188. download_status_reset(&consensus_bootstrap_dl_status[i]);
  189. }
  190. /** Return the filename used to cache the consensus of a given flavor */
  191. static char *
  192. networkstatus_get_cache_fname(int flav,
  193. const char *flavorname,
  194. int unverified_consensus)
  195. {
  196. char buf[128];
  197. const char *prefix;
  198. if (unverified_consensus) {
  199. prefix = "unverified";
  200. } else {
  201. prefix = "cached";
  202. }
  203. if (flav == FLAV_NS) {
  204. tor_snprintf(buf, sizeof(buf), "%s-consensus", prefix);
  205. } else {
  206. tor_snprintf(buf, sizeof(buf), "%s-%s-consensus", prefix, flavorname);
  207. }
  208. return get_cachedir_fname(buf);
  209. }
  210. /**
  211. * Read and and return the cached consensus of type <b>flavorname</b>. If
  212. * <b>unverified</b> is false, get the one we haven't verified. Return NULL if
  213. * the file isn't there. */
  214. static tor_mmap_t *
  215. networkstatus_map_cached_consensus_impl(int flav,
  216. const char *flavorname,
  217. int unverified_consensus)
  218. {
  219. char *filename = networkstatus_get_cache_fname(flav,
  220. flavorname,
  221. unverified_consensus);
  222. tor_mmap_t *result = tor_mmap_file(filename);
  223. tor_free(filename);
  224. return result;
  225. }
  226. /** Map the file containing the current cached consensus of flavor
  227. * <b>flavorname</b> */
  228. tor_mmap_t *
  229. networkstatus_map_cached_consensus(const char *flavorname)
  230. {
  231. int flav = networkstatus_parse_flavor_name(flavorname);
  232. if (flav < 0)
  233. return NULL;
  234. return networkstatus_map_cached_consensus_impl(flav, flavorname, 0);
  235. }
  236. /** Read every cached v3 consensus networkstatus from the disk. */
  237. int
  238. router_reload_consensus_networkstatus(void)
  239. {
  240. const unsigned int flags = NSSET_FROM_CACHE | NSSET_DONT_DOWNLOAD_CERTS;
  241. int flav;
  242. /* FFFF Suppress warnings if cached consensus is bad? */
  243. for (flav = 0; flav < N_CONSENSUS_FLAVORS; ++flav) {
  244. const char *flavor = networkstatus_get_flavor_name(flav);
  245. tor_mmap_t *m = networkstatus_map_cached_consensus_impl(flav, flavor, 0);
  246. if (m) {
  247. if (networkstatus_set_current_consensus(m->data, m->size,
  248. flavor, flags, NULL) < -1) {
  249. log_warn(LD_FS, "Couldn't load consensus %s networkstatus from cache",
  250. flavor);
  251. }
  252. tor_munmap_file(m);
  253. }
  254. m = networkstatus_map_cached_consensus_impl(flav, flavor, 1);
  255. if (m) {
  256. if (networkstatus_set_current_consensus(m->data, m->size,
  257. flavor,
  258. flags | NSSET_WAS_WAITING_FOR_CERTS,
  259. NULL)) {
  260. log_info(LD_FS, "Couldn't load unverified consensus %s networkstatus "
  261. "from cache", flavor);
  262. }
  263. tor_munmap_file(m);
  264. }
  265. }
  266. update_certificate_downloads(time(NULL));
  267. routers_update_all_from_networkstatus(time(NULL), 3);
  268. update_microdescs_from_networkstatus(time(NULL));
  269. return 0;
  270. }
  271. /** Free all storage held by the vote_routerstatus object <b>rs</b>. */
  272. void
  273. vote_routerstatus_free_(vote_routerstatus_t *rs)
  274. {
  275. vote_microdesc_hash_t *h, *next;
  276. if (!rs)
  277. return;
  278. tor_free(rs->version);
  279. tor_free(rs->protocols);
  280. tor_free(rs->status.exitsummary);
  281. for (h = rs->microdesc; h; h = next) {
  282. tor_free(h->microdesc_hash_line);
  283. next = h->next;
  284. tor_free(h);
  285. }
  286. tor_free(rs);
  287. }
  288. /** Free all storage held by the routerstatus object <b>rs</b>. */
  289. void
  290. routerstatus_free_(routerstatus_t *rs)
  291. {
  292. if (!rs)
  293. return;
  294. tor_free(rs->exitsummary);
  295. tor_free(rs);
  296. }
  297. /** Free all storage held in <b>sig</b> */
  298. void
  299. document_signature_free_(document_signature_t *sig)
  300. {
  301. tor_free(sig->signature);
  302. tor_free(sig);
  303. }
  304. /** Return a newly allocated copy of <b>sig</b> */
  305. document_signature_t *
  306. document_signature_dup(const document_signature_t *sig)
  307. {
  308. document_signature_t *r = tor_memdup(sig, sizeof(document_signature_t));
  309. if (r->signature)
  310. r->signature = tor_memdup(sig->signature, sig->signature_len);
  311. return r;
  312. }
  313. /** Free all storage held in <b>ns</b>. */
  314. void
  315. networkstatus_vote_free_(networkstatus_t *ns)
  316. {
  317. if (!ns)
  318. return;
  319. tor_free(ns->client_versions);
  320. tor_free(ns->server_versions);
  321. tor_free(ns->recommended_client_protocols);
  322. tor_free(ns->recommended_relay_protocols);
  323. tor_free(ns->required_client_protocols);
  324. tor_free(ns->required_relay_protocols);
  325. if (ns->known_flags) {
  326. SMARTLIST_FOREACH(ns->known_flags, char *, c, tor_free(c));
  327. smartlist_free(ns->known_flags);
  328. }
  329. if (ns->weight_params) {
  330. SMARTLIST_FOREACH(ns->weight_params, char *, c, tor_free(c));
  331. smartlist_free(ns->weight_params);
  332. }
  333. if (ns->net_params) {
  334. SMARTLIST_FOREACH(ns->net_params, char *, c, tor_free(c));
  335. smartlist_free(ns->net_params);
  336. }
  337. if (ns->supported_methods) {
  338. SMARTLIST_FOREACH(ns->supported_methods, char *, c, tor_free(c));
  339. smartlist_free(ns->supported_methods);
  340. }
  341. if (ns->package_lines) {
  342. SMARTLIST_FOREACH(ns->package_lines, char *, c, tor_free(c));
  343. smartlist_free(ns->package_lines);
  344. }
  345. if (ns->voters) {
  346. SMARTLIST_FOREACH_BEGIN(ns->voters, networkstatus_voter_info_t *, voter) {
  347. tor_free(voter->nickname);
  348. tor_free(voter->address);
  349. tor_free(voter->contact);
  350. if (voter->sigs) {
  351. SMARTLIST_FOREACH(voter->sigs, document_signature_t *, sig,
  352. document_signature_free(sig));
  353. smartlist_free(voter->sigs);
  354. }
  355. tor_free(voter);
  356. } SMARTLIST_FOREACH_END(voter);
  357. smartlist_free(ns->voters);
  358. }
  359. authority_cert_free(ns->cert);
  360. if (ns->routerstatus_list) {
  361. if (ns->type == NS_TYPE_VOTE || ns->type == NS_TYPE_OPINION) {
  362. SMARTLIST_FOREACH(ns->routerstatus_list, vote_routerstatus_t *, rs,
  363. vote_routerstatus_free(rs));
  364. } else {
  365. SMARTLIST_FOREACH(ns->routerstatus_list, routerstatus_t *, rs,
  366. routerstatus_free(rs));
  367. }
  368. smartlist_free(ns->routerstatus_list);
  369. }
  370. if (ns->bw_file_headers) {
  371. SMARTLIST_FOREACH(ns->bw_file_headers, char *, c, tor_free(c));
  372. smartlist_free(ns->bw_file_headers);
  373. }
  374. digestmap_free(ns->desc_digest_map, NULL);
  375. if (ns->sr_info.commits) {
  376. dirvote_clear_commits(ns);
  377. }
  378. tor_free(ns->sr_info.previous_srv);
  379. tor_free(ns->sr_info.current_srv);
  380. memwipe(ns, 11, sizeof(*ns));
  381. tor_free(ns);
  382. }
  383. /** Return the voter info from <b>vote</b> for the voter whose identity digest
  384. * is <b>identity</b>, or NULL if no such voter is associated with
  385. * <b>vote</b>. */
  386. networkstatus_voter_info_t *
  387. networkstatus_get_voter_by_id(networkstatus_t *vote,
  388. const char *identity)
  389. {
  390. if (!vote || !vote->voters)
  391. return NULL;
  392. SMARTLIST_FOREACH(vote->voters, networkstatus_voter_info_t *, voter,
  393. if (fast_memeq(voter->identity_digest, identity, DIGEST_LEN))
  394. return voter);
  395. return NULL;
  396. }
  397. /** Return the signature made by <b>voter</b> using the algorithm
  398. * <b>alg</b>, or NULL if none is found. */
  399. document_signature_t *
  400. networkstatus_get_voter_sig_by_alg(const networkstatus_voter_info_t *voter,
  401. digest_algorithm_t alg)
  402. {
  403. if (!voter->sigs)
  404. return NULL;
  405. SMARTLIST_FOREACH(voter->sigs, document_signature_t *, sig,
  406. if (sig->alg == alg)
  407. return sig);
  408. return NULL;
  409. }
  410. /** Check whether the signature <b>sig</b> is correctly signed with the
  411. * signing key in <b>cert</b>. Return -1 if <b>cert</b> doesn't match the
  412. * signing key; otherwise set the good_signature or bad_signature flag on
  413. * <b>voter</b>, and return 0. */
  414. int
  415. networkstatus_check_document_signature(const networkstatus_t *consensus,
  416. document_signature_t *sig,
  417. const authority_cert_t *cert)
  418. {
  419. char key_digest[DIGEST_LEN];
  420. const int dlen = sig->alg == DIGEST_SHA1 ? DIGEST_LEN : DIGEST256_LEN;
  421. char *signed_digest;
  422. size_t signed_digest_len;
  423. if (crypto_pk_get_digest(cert->signing_key, key_digest)<0)
  424. return -1;
  425. if (tor_memneq(sig->signing_key_digest, key_digest, DIGEST_LEN) ||
  426. tor_memneq(sig->identity_digest, cert->cache_info.identity_digest,
  427. DIGEST_LEN))
  428. return -1;
  429. if (authority_cert_is_blacklisted(cert)) {
  430. /* We implement blacklisting for authority signing keys by treating
  431. * all their signatures as always bad. That way we don't get into
  432. * crazy loops of dropping and re-fetching signatures. */
  433. log_warn(LD_DIR, "Ignoring a consensus signature made with deprecated"
  434. " signing key %s",
  435. hex_str(cert->signing_key_digest, DIGEST_LEN));
  436. sig->bad_signature = 1;
  437. return 0;
  438. }
  439. signed_digest_len = crypto_pk_keysize(cert->signing_key);
  440. signed_digest = tor_malloc(signed_digest_len);
  441. if (crypto_pk_public_checksig(cert->signing_key,
  442. signed_digest,
  443. signed_digest_len,
  444. sig->signature,
  445. sig->signature_len) < dlen ||
  446. tor_memneq(signed_digest, consensus->digests.d[sig->alg], dlen)) {
  447. log_warn(LD_DIR, "Got a bad signature on a networkstatus vote");
  448. sig->bad_signature = 1;
  449. } else {
  450. sig->good_signature = 1;
  451. }
  452. tor_free(signed_digest);
  453. return 0;
  454. }
  455. /** Given a v3 networkstatus consensus in <b>consensus</b>, check every
  456. * as-yet-unchecked signature on <b>consensus</b>. Return 1 if there is a
  457. * signature from every recognized authority on it, 0 if there are
  458. * enough good signatures from recognized authorities on it, -1 if we might
  459. * get enough good signatures by fetching missing certificates, and -2
  460. * otherwise. Log messages at INFO or WARN: if <b>warn</b> is over 1, warn
  461. * about every problem; if warn is at least 1, warn only if we can't get
  462. * enough signatures; if warn is negative, log nothing at all. */
  463. int
  464. networkstatus_check_consensus_signature(networkstatus_t *consensus,
  465. int warn)
  466. {
  467. int n_good = 0;
  468. int n_missing_key = 0, n_dl_failed_key = 0;
  469. int n_bad = 0;
  470. int n_unknown = 0;
  471. int n_no_signature = 0;
  472. int n_v3_authorities = get_n_authorities(V3_DIRINFO);
  473. int n_required = n_v3_authorities/2 + 1;
  474. smartlist_t *list_good = smartlist_new();
  475. smartlist_t *list_no_signature = smartlist_new();
  476. smartlist_t *need_certs_from = smartlist_new();
  477. smartlist_t *unrecognized = smartlist_new();
  478. smartlist_t *missing_authorities = smartlist_new();
  479. int severity;
  480. time_t now = time(NULL);
  481. tor_assert(consensus->type == NS_TYPE_CONSENSUS);
  482. SMARTLIST_FOREACH_BEGIN(consensus->voters, networkstatus_voter_info_t *,
  483. voter) {
  484. int good_here = 0;
  485. int bad_here = 0;
  486. int unknown_here = 0;
  487. int missing_key_here = 0, dl_failed_key_here = 0;
  488. SMARTLIST_FOREACH_BEGIN(voter->sigs, document_signature_t *, sig) {
  489. if (!sig->good_signature && !sig->bad_signature &&
  490. sig->signature) {
  491. /* we can try to check the signature. */
  492. int is_v3_auth = trusteddirserver_get_by_v3_auth_digest(
  493. sig->identity_digest) != NULL;
  494. authority_cert_t *cert =
  495. authority_cert_get_by_digests(sig->identity_digest,
  496. sig->signing_key_digest);
  497. tor_assert(tor_memeq(sig->identity_digest, voter->identity_digest,
  498. DIGEST_LEN));
  499. if (!is_v3_auth) {
  500. smartlist_add(unrecognized, voter);
  501. ++unknown_here;
  502. continue;
  503. } else if (!cert || cert->expires < now) {
  504. smartlist_add(need_certs_from, voter);
  505. ++missing_key_here;
  506. if (authority_cert_dl_looks_uncertain(sig->identity_digest))
  507. ++dl_failed_key_here;
  508. continue;
  509. }
  510. if (networkstatus_check_document_signature(consensus, sig, cert) < 0) {
  511. smartlist_add(need_certs_from, voter);
  512. ++missing_key_here;
  513. if (authority_cert_dl_looks_uncertain(sig->identity_digest))
  514. ++dl_failed_key_here;
  515. continue;
  516. }
  517. }
  518. if (sig->good_signature)
  519. ++good_here;
  520. else if (sig->bad_signature)
  521. ++bad_here;
  522. } SMARTLIST_FOREACH_END(sig);
  523. if (good_here) {
  524. ++n_good;
  525. smartlist_add(list_good, voter->nickname);
  526. } else if (bad_here) {
  527. ++n_bad;
  528. } else if (missing_key_here) {
  529. ++n_missing_key;
  530. if (dl_failed_key_here)
  531. ++n_dl_failed_key;
  532. } else if (unknown_here) {
  533. ++n_unknown;
  534. } else {
  535. ++n_no_signature;
  536. smartlist_add(list_no_signature, voter->nickname);
  537. }
  538. } SMARTLIST_FOREACH_END(voter);
  539. /* Now see whether we're missing any voters entirely. */
  540. SMARTLIST_FOREACH(router_get_trusted_dir_servers(),
  541. dir_server_t *, ds,
  542. {
  543. if ((ds->type & V3_DIRINFO) &&
  544. !networkstatus_get_voter_by_id(consensus, ds->v3_identity_digest))
  545. smartlist_add(missing_authorities, ds);
  546. });
  547. if (warn > 1 || (warn >= 0 &&
  548. (n_good + n_missing_key - n_dl_failed_key < n_required))) {
  549. severity = LOG_WARN;
  550. } else {
  551. severity = LOG_INFO;
  552. }
  553. if (warn >= 0) {
  554. SMARTLIST_FOREACH(unrecognized, networkstatus_voter_info_t *, voter,
  555. {
  556. tor_log(severity, LD_DIR, "Consensus includes unrecognized authority "
  557. "'%s' at %s:%d (contact %s; identity %s)",
  558. voter->nickname, voter->address, (int)voter->dir_port,
  559. voter->contact?voter->contact:"n/a",
  560. hex_str(voter->identity_digest, DIGEST_LEN));
  561. });
  562. SMARTLIST_FOREACH(need_certs_from, networkstatus_voter_info_t *, voter,
  563. {
  564. tor_log(severity, LD_DIR, "Looks like we need to download a new "
  565. "certificate from authority '%s' at %s:%d (contact %s; "
  566. "identity %s)",
  567. voter->nickname, voter->address, (int)voter->dir_port,
  568. voter->contact?voter->contact:"n/a",
  569. hex_str(voter->identity_digest, DIGEST_LEN));
  570. });
  571. SMARTLIST_FOREACH(missing_authorities, dir_server_t *, ds,
  572. {
  573. tor_log(severity, LD_DIR, "Consensus does not include configured "
  574. "authority '%s' at %s:%d (identity %s)",
  575. ds->nickname, ds->address, (int)ds->dir_port,
  576. hex_str(ds->v3_identity_digest, DIGEST_LEN));
  577. });
  578. {
  579. char *joined;
  580. smartlist_t *sl = smartlist_new();
  581. char *tmp = smartlist_join_strings(list_good, " ", 0, NULL);
  582. smartlist_add_asprintf(sl,
  583. "A consensus needs %d good signatures from recognized "
  584. "authorities for us to accept it. "
  585. "This %s one has %d (%s).",
  586. n_required,
  587. networkstatus_get_flavor_name(consensus->flavor),
  588. n_good, tmp);
  589. tor_free(tmp);
  590. if (n_no_signature) {
  591. tmp = smartlist_join_strings(list_no_signature, " ", 0, NULL);
  592. smartlist_add_asprintf(sl,
  593. "%d (%s) of the authorities we know didn't sign it.",
  594. n_no_signature, tmp);
  595. tor_free(tmp);
  596. }
  597. if (n_unknown) {
  598. smartlist_add_asprintf(sl,
  599. "It has %d signatures from authorities we don't "
  600. "recognize.", n_unknown);
  601. }
  602. if (n_bad) {
  603. smartlist_add_asprintf(sl, "%d of the signatures on it didn't verify "
  604. "correctly.", n_bad);
  605. }
  606. if (n_missing_key) {
  607. smartlist_add_asprintf(sl,
  608. "We were unable to check %d of the signatures, "
  609. "because we were missing the keys.", n_missing_key);
  610. }
  611. joined = smartlist_join_strings(sl, " ", 0, NULL);
  612. tor_log(severity, LD_DIR, "%s", joined);
  613. tor_free(joined);
  614. SMARTLIST_FOREACH(sl, char *, c, tor_free(c));
  615. smartlist_free(sl);
  616. }
  617. }
  618. smartlist_free(list_good);
  619. smartlist_free(list_no_signature);
  620. smartlist_free(unrecognized);
  621. smartlist_free(need_certs_from);
  622. smartlist_free(missing_authorities);
  623. if (n_good == n_v3_authorities)
  624. return 1;
  625. else if (n_good >= n_required)
  626. return 0;
  627. else if (n_good + n_missing_key >= n_required)
  628. return -1;
  629. else
  630. return -2;
  631. }
  632. /** How far in the future do we allow a network-status to get before removing
  633. * it? (seconds) */
  634. #define NETWORKSTATUS_ALLOW_SKEW (24*60*60)
  635. /** Helper for bsearching a list of routerstatus_t pointers: compare a
  636. * digest in the key to the identity digest of a routerstatus_t. */
  637. int
  638. compare_digest_to_routerstatus_entry(const void *_key, const void **_member)
  639. {
  640. const char *key = _key;
  641. const routerstatus_t *rs = *_member;
  642. return tor_memcmp(key, rs->identity_digest, DIGEST_LEN);
  643. }
  644. /** Helper for bsearching a list of routerstatus_t pointers: compare a
  645. * digest in the key to the identity digest of a routerstatus_t. */
  646. int
  647. compare_digest_to_vote_routerstatus_entry(const void *_key,
  648. const void **_member)
  649. {
  650. const char *key = _key;
  651. const vote_routerstatus_t *vrs = *_member;
  652. return tor_memcmp(key, vrs->status.identity_digest, DIGEST_LEN);
  653. }
  654. /** As networkstatus_find_entry, but do not return a const pointer */
  655. routerstatus_t *
  656. networkstatus_vote_find_mutable_entry(networkstatus_t *ns, const char *digest)
  657. {
  658. return smartlist_bsearch(ns->routerstatus_list, digest,
  659. compare_digest_to_routerstatus_entry);
  660. }
  661. /** Return the entry in <b>ns</b> for the identity digest <b>digest</b>, or
  662. * NULL if none was found. */
  663. const routerstatus_t *
  664. networkstatus_vote_find_entry(networkstatus_t *ns, const char *digest)
  665. {
  666. return networkstatus_vote_find_mutable_entry(ns, digest);
  667. }
  668. /*XXXX MOVE make this static once functions are moved into this file. */
  669. /** Search the routerstatuses in <b>ns</b> for one whose identity digest is
  670. * <b>digest</b>. Return value and set *<b>found_out</b> as for
  671. * smartlist_bsearch_idx(). */
  672. int
  673. networkstatus_vote_find_entry_idx(networkstatus_t *ns,
  674. const char *digest, int *found_out)
  675. {
  676. return smartlist_bsearch_idx(ns->routerstatus_list, digest,
  677. compare_digest_to_routerstatus_entry,
  678. found_out);
  679. }
  680. /** As router_get_consensus_status_by_descriptor_digest, but does not return
  681. * a const pointer. */
  682. MOCK_IMPL(routerstatus_t *,
  683. router_get_mutable_consensus_status_by_descriptor_digest,(
  684. networkstatus_t *consensus,
  685. const char *digest))
  686. {
  687. if (!consensus)
  688. consensus = networkstatus_get_latest_consensus();
  689. if (!consensus)
  690. return NULL;
  691. if (!consensus->desc_digest_map) {
  692. digestmap_t *m = consensus->desc_digest_map = digestmap_new();
  693. SMARTLIST_FOREACH(consensus->routerstatus_list,
  694. routerstatus_t *, rs,
  695. {
  696. digestmap_set(m, rs->descriptor_digest, rs);
  697. });
  698. }
  699. return digestmap_get(consensus->desc_digest_map, digest);
  700. }
  701. /** Return the consensus view of the status of the router whose current
  702. * <i>descriptor</i> digest in <b>consensus</b> is <b>digest</b>, or NULL if
  703. * no such router is known. */
  704. const routerstatus_t *
  705. router_get_consensus_status_by_descriptor_digest(networkstatus_t *consensus,
  706. const char *digest)
  707. {
  708. return router_get_mutable_consensus_status_by_descriptor_digest(
  709. consensus, digest);
  710. }
  711. /** Return a smartlist of all router descriptor digests in a consensus */
  712. static smartlist_t *
  713. router_get_descriptor_digests_in_consensus(networkstatus_t *consensus)
  714. {
  715. smartlist_t *result = smartlist_new();
  716. digestmap_iter_t *i;
  717. const char *digest;
  718. void *rs;
  719. char *digest_tmp;
  720. for (i = digestmap_iter_init(consensus->desc_digest_map);
  721. !(digestmap_iter_done(i));
  722. i = digestmap_iter_next(consensus->desc_digest_map, i)) {
  723. digestmap_iter_get(i, &digest, &rs);
  724. digest_tmp = tor_malloc(DIGEST_LEN);
  725. memcpy(digest_tmp, digest, DIGEST_LEN);
  726. smartlist_add(result, digest_tmp);
  727. }
  728. return result;
  729. }
  730. /** Return a smartlist of all router descriptor digests in the current
  731. * consensus */
  732. MOCK_IMPL(smartlist_t *,
  733. router_get_descriptor_digests,(void))
  734. {
  735. smartlist_t *result = NULL;
  736. if (current_ns_consensus) {
  737. result =
  738. router_get_descriptor_digests_in_consensus(current_ns_consensus);
  739. }
  740. return result;
  741. }
  742. /** Given the digest of a router descriptor, return its current download
  743. * status, or NULL if the digest is unrecognized. */
  744. MOCK_IMPL(download_status_t *,
  745. router_get_dl_status_by_descriptor_digest,(const char *d))
  746. {
  747. routerstatus_t *rs;
  748. if (!current_ns_consensus)
  749. return NULL;
  750. if ((rs = router_get_mutable_consensus_status_by_descriptor_digest(
  751. current_ns_consensus, d)))
  752. return &rs->dl_status;
  753. return NULL;
  754. }
  755. /** As router_get_consensus_status_by_id, but do not return a const pointer */
  756. routerstatus_t *
  757. router_get_mutable_consensus_status_by_id(const char *digest)
  758. {
  759. const networkstatus_t *ns = networkstatus_get_latest_consensus();
  760. if (!ns)
  761. return NULL;
  762. smartlist_t *rslist = ns->routerstatus_list;
  763. return smartlist_bsearch(rslist, digest,
  764. compare_digest_to_routerstatus_entry);
  765. }
  766. /** Return the consensus view of the status of the router whose identity
  767. * digest is <b>digest</b>, or NULL if we don't know about any such router. */
  768. const routerstatus_t *
  769. router_get_consensus_status_by_id(const char *digest)
  770. {
  771. return router_get_mutable_consensus_status_by_id(digest);
  772. }
  773. /** How frequently do directory authorities re-download fresh networkstatus
  774. * documents? */
  775. #define AUTHORITY_NS_CACHE_INTERVAL (10*60)
  776. /** How frequently do non-authority directory caches re-download fresh
  777. * networkstatus documents? */
  778. #define NONAUTHORITY_NS_CACHE_INTERVAL (60*60)
  779. /** Return true iff, given the options listed in <b>options</b>, <b>flavor</b>
  780. * is the flavor of a consensus networkstatus that we would like to fetch.
  781. *
  782. * For certificate fetches, use we_want_to_fetch_unknown_auth_certs, and
  783. * for serving fetched documents, use directory_caches_dir_info. */
  784. int
  785. we_want_to_fetch_flavor(const or_options_t *options, int flavor)
  786. {
  787. if (flavor < 0 || flavor > N_CONSENSUS_FLAVORS) {
  788. /* This flavor is crazy; we don't want it */
  789. /*XXXX handle unrecognized flavors later */
  790. return 0;
  791. }
  792. if (authdir_mode_v3(options) || directory_caches_dir_info(options)) {
  793. /* We want to serve all flavors to others, regardless if we would use
  794. * it ourselves. */
  795. return 1;
  796. }
  797. if (options->FetchUselessDescriptors) {
  798. /* In order to get all descriptors, we need to fetch all consensuses. */
  799. return 1;
  800. }
  801. /* Otherwise, we want the flavor only if we want to use it to build
  802. * circuits. */
  803. return flavor == usable_consensus_flavor();
  804. }
  805. /** Return true iff, given the options listed in <b>options</b>, we would like
  806. * to fetch and store unknown authority certificates.
  807. *
  808. * For consensus and descriptor fetches, use we_want_to_fetch_flavor, and
  809. * for serving fetched certificates, use directory_caches_unknown_auth_certs.
  810. */
  811. int
  812. we_want_to_fetch_unknown_auth_certs(const or_options_t *options)
  813. {
  814. if (authdir_mode_v3(options) ||
  815. directory_caches_unknown_auth_certs((options))) {
  816. /* We want to serve all certs to others, regardless if we would use
  817. * them ourselves. */
  818. return 1;
  819. }
  820. if (options->FetchUselessDescriptors) {
  821. /* Unknown certificates are definitely useless. */
  822. return 1;
  823. }
  824. /* Otherwise, don't fetch unknown certificates. */
  825. return 0;
  826. }
  827. /** How long will we hang onto a possibly live consensus for which we're
  828. * fetching certs before we check whether there is a better one? */
  829. #define DELAY_WHILE_FETCHING_CERTS (20*60)
  830. /** What is the minimum time we need to have waited fetching certs, before we
  831. * increment the consensus download schedule on failure? */
  832. #define MIN_DELAY_FOR_FETCH_CERT_STATUS_FAILURE (1*60)
  833. /* Check if a downloaded consensus flavor should still wait for certificates
  834. * to download now. If we decide not to wait, check if enough time has passed
  835. * to consider the certificate download failure a separate failure. If so,
  836. * fail dls.
  837. * If waiting for certificates to download, return 1. If not, return 0. */
  838. static int
  839. check_consensus_waiting_for_certs(int flavor, time_t now,
  840. download_status_t *dls)
  841. {
  842. consensus_waiting_for_certs_t *waiting;
  843. /* We should always have a known flavor, because we_want_to_fetch_flavor()
  844. * filters out unknown flavors. */
  845. tor_assert(flavor >= 0 && flavor < N_CONSENSUS_FLAVORS);
  846. waiting = &consensus_waiting_for_certs[flavor];
  847. if (waiting->consensus) {
  848. /* XXXX make sure this doesn't delay sane downloads. */
  849. if (waiting->set_at + DELAY_WHILE_FETCHING_CERTS > now &&
  850. waiting->consensus->valid_until > now) {
  851. return 1;
  852. } else {
  853. if (!waiting->dl_failed) {
  854. if (waiting->set_at + MIN_DELAY_FOR_FETCH_CERT_STATUS_FAILURE > now) {
  855. download_status_failed(dls, 0);
  856. }
  857. waiting->dl_failed=1;
  858. }
  859. }
  860. }
  861. return 0;
  862. }
  863. /** If we want to download a fresh consensus, launch a new download as
  864. * appropriate. */
  865. static void
  866. update_consensus_networkstatus_downloads(time_t now)
  867. {
  868. int i;
  869. const or_options_t *options = get_options();
  870. const int we_are_bootstrapping = networkstatus_consensus_is_bootstrapping(
  871. now);
  872. const int use_multi_conn =
  873. networkstatus_consensus_can_use_multiple_directories(options);
  874. if (should_delay_dir_fetches(options, NULL))
  875. return;
  876. for (i=0; i < N_CONSENSUS_FLAVORS; ++i) {
  877. /* XXXX need some way to download unknown flavors if we are caching. */
  878. const char *resource;
  879. networkstatus_t *c;
  880. int max_in_progress_conns = 1;
  881. if (! we_want_to_fetch_flavor(options, i))
  882. continue;
  883. c = networkstatus_get_latest_consensus_by_flavor(i);
  884. if (! (c && c->valid_after <= now && now <= c->valid_until)) {
  885. /* No live consensus? Get one now!*/
  886. time_to_download_next_consensus[i] = now;
  887. }
  888. if (time_to_download_next_consensus[i] > now)
  889. continue; /* Wait until the current consensus is older. */
  890. resource = networkstatus_get_flavor_name(i);
  891. /* Check if we already have enough connections in progress */
  892. if (we_are_bootstrapping && use_multi_conn) {
  893. max_in_progress_conns =
  894. options->ClientBootstrapConsensusMaxInProgressTries;
  895. }
  896. if (connection_dir_count_by_purpose_and_resource(
  897. DIR_PURPOSE_FETCH_CONSENSUS,
  898. resource)
  899. >= max_in_progress_conns) {
  900. continue;
  901. }
  902. /* Check if we want to launch another download for a usable consensus.
  903. * Only used during bootstrap. */
  904. if (we_are_bootstrapping && use_multi_conn
  905. && i == usable_consensus_flavor()) {
  906. /* Check if we're already downloading a usable consensus */
  907. if (networkstatus_consensus_is_already_downloading(resource))
  908. continue;
  909. /* Make multiple connections for a bootstrap consensus download. */
  910. update_consensus_bootstrap_multiple_downloads(now, options);
  911. } else {
  912. /* Check if we failed downloading a consensus too recently */
  913. /* Let's make sure we remembered to update consensus_dl_status */
  914. tor_assert(consensus_dl_status[i].schedule == DL_SCHED_CONSENSUS);
  915. if (!download_status_is_ready(&consensus_dl_status[i], now)) {
  916. continue;
  917. }
  918. /** Check if we're waiting for certificates to download. If we are,
  919. * launch download for missing directory authority certificates. */
  920. if (check_consensus_waiting_for_certs(i, now, &consensus_dl_status[i])) {
  921. update_certificate_downloads(now);
  922. continue;
  923. }
  924. /* Try the requested attempt */
  925. log_info(LD_DIR, "Launching %s standard networkstatus consensus "
  926. "download.", networkstatus_get_flavor_name(i));
  927. directory_get_from_dirserver(DIR_PURPOSE_FETCH_CONSENSUS,
  928. ROUTER_PURPOSE_GENERAL, resource,
  929. PDS_RETRY_IF_NO_SERVERS,
  930. consensus_dl_status[i].want_authority);
  931. }
  932. }
  933. }
  934. /** When we're bootstrapping, launch one or more consensus download
  935. * connections, if schedule indicates connection(s) should be made after now.
  936. * If is_authority, connect to an authority, otherwise, use a fallback
  937. * directory mirror.
  938. */
  939. static void
  940. update_consensus_bootstrap_attempt_downloads(
  941. time_t now,
  942. download_status_t *dls,
  943. download_want_authority_t want_authority)
  944. {
  945. const char *resource = networkstatus_get_flavor_name(
  946. usable_consensus_flavor());
  947. /* Let's make sure we remembered to update schedule */
  948. tor_assert(dls->schedule == DL_SCHED_CONSENSUS);
  949. /* Allow for multiple connections in the same second, if the schedule value
  950. * is 0. */
  951. while (download_status_is_ready(dls, now)) {
  952. log_info(LD_DIR, "Launching %s bootstrap %s networkstatus consensus "
  953. "download.", resource, (want_authority == DL_WANT_AUTHORITY
  954. ? "authority"
  955. : "mirror"));
  956. directory_get_from_dirserver(DIR_PURPOSE_FETCH_CONSENSUS,
  957. ROUTER_PURPOSE_GENERAL, resource,
  958. PDS_RETRY_IF_NO_SERVERS, want_authority);
  959. /* schedule the next attempt */
  960. download_status_increment_attempt(dls, resource, now);
  961. }
  962. }
  963. /** If we're bootstrapping, check the connection schedules and see if we want
  964. * to make additional, potentially concurrent, consensus download
  965. * connections.
  966. * Only call when bootstrapping, and when we want to make additional
  967. * connections. Only nodes that satisfy
  968. * networkstatus_consensus_can_use_multiple_directories make additional
  969. * connections.
  970. */
  971. static void
  972. update_consensus_bootstrap_multiple_downloads(time_t now,
  973. const or_options_t *options)
  974. {
  975. const int usable_flavor = usable_consensus_flavor();
  976. /* make sure we can use multiple connections */
  977. if (!networkstatus_consensus_can_use_multiple_directories(options)) {
  978. return;
  979. }
  980. /* Launch concurrent consensus download attempt(s) based on the mirror and
  981. * authority schedules. Try the mirror first - this makes it slightly more
  982. * likely that we'll connect to the fallback first, and then end the
  983. * authority connection attempt. */
  984. /* If a consensus download fails because it's waiting for certificates,
  985. * we'll fail both the authority and fallback schedules. This is better than
  986. * failing only one of the schedules, and having the other continue
  987. * unchecked.
  988. */
  989. /* If we don't have or can't use extra fallbacks, don't try them. */
  990. if (networkstatus_consensus_can_use_extra_fallbacks(options)) {
  991. download_status_t *dls_f =
  992. &consensus_bootstrap_dl_status[CONSENSUS_BOOTSTRAP_SOURCE_ANY_DIRSERVER];
  993. if (!check_consensus_waiting_for_certs(usable_flavor, now, dls_f)) {
  994. /* During bootstrap, DL_WANT_ANY_DIRSERVER means "use fallbacks". */
  995. update_consensus_bootstrap_attempt_downloads(now, dls_f,
  996. DL_WANT_ANY_DIRSERVER);
  997. }
  998. }
  999. /* Now try an authority. */
  1000. download_status_t *dls_a =
  1001. &consensus_bootstrap_dl_status[CONSENSUS_BOOTSTRAP_SOURCE_AUTHORITY];
  1002. if (!check_consensus_waiting_for_certs(usable_flavor, now, dls_a)) {
  1003. update_consensus_bootstrap_attempt_downloads(now, dls_a,
  1004. DL_WANT_AUTHORITY);
  1005. }
  1006. }
  1007. /** Called when an attempt to download a consensus fails: note that the
  1008. * failure occurred, and possibly retry. */
  1009. void
  1010. networkstatus_consensus_download_failed(int status_code, const char *flavname)
  1011. {
  1012. int flav = networkstatus_parse_flavor_name(flavname);
  1013. if (flav >= 0) {
  1014. tor_assert(flav < N_CONSENSUS_FLAVORS);
  1015. /* XXXX handle unrecognized flavors */
  1016. download_status_failed(&consensus_dl_status[flav], status_code);
  1017. /* Retry immediately, if appropriate. */
  1018. update_consensus_networkstatus_downloads(time(NULL));
  1019. }
  1020. }
  1021. /** How long do we (as a cache) wait after a consensus becomes non-fresh
  1022. * before trying to fetch another? */
  1023. #define CONSENSUS_MIN_SECONDS_BEFORE_CACHING 120
  1024. /** Update the time at which we'll consider replacing the current
  1025. * consensus of flavor <b>flav</b> */
  1026. static void
  1027. update_consensus_networkstatus_fetch_time_impl(time_t now, int flav)
  1028. {
  1029. const or_options_t *options = get_options();
  1030. networkstatus_t *c = networkstatus_get_latest_consensus_by_flavor(flav);
  1031. const char *flavor = networkstatus_get_flavor_name(flav);
  1032. if (! we_want_to_fetch_flavor(get_options(), flav))
  1033. return;
  1034. if (c && c->valid_after <= now && now <= c->valid_until) {
  1035. long dl_interval;
  1036. long interval = c->fresh_until - c->valid_after;
  1037. long min_sec_before_caching = CONSENSUS_MIN_SECONDS_BEFORE_CACHING;
  1038. time_t start;
  1039. if (min_sec_before_caching > interval/16) {
  1040. /* Usually we allow 2-minutes slop factor in case clocks get
  1041. desynchronized a little. If we're on a private network with
  1042. a crazy-fast voting interval, though, 2 minutes may be too
  1043. much. */
  1044. min_sec_before_caching = interval/16;
  1045. /* make sure we always delay by at least a second before caching */
  1046. if (min_sec_before_caching == 0) {
  1047. min_sec_before_caching = 1;
  1048. }
  1049. }
  1050. if (directory_fetches_dir_info_early(options)) {
  1051. /* We want to cache the next one at some point after this one
  1052. * is no longer fresh... */
  1053. start = (time_t)(c->fresh_until + min_sec_before_caching);
  1054. /* Some clients may need the consensus sooner than others. */
  1055. if (options->FetchDirInfoExtraEarly || authdir_mode_v3(options)) {
  1056. dl_interval = 60;
  1057. if (min_sec_before_caching + dl_interval > interval)
  1058. dl_interval = interval/2;
  1059. } else {
  1060. /* But only in the first half-interval after that. */
  1061. dl_interval = interval/2;
  1062. }
  1063. } else {
  1064. /* We're an ordinary client, a bridge, or a hidden service.
  1065. * Give all the caches enough time to download the consensus. */
  1066. start = (time_t)(c->fresh_until + (interval*3)/4);
  1067. /* But download the next one well before this one is expired. */
  1068. dl_interval = ((c->valid_until - start) * 7 )/ 8;
  1069. /* If we're a bridge user, make use of the numbers we just computed
  1070. * to choose the rest of the interval *after* them. */
  1071. if (directory_fetches_dir_info_later(options)) {
  1072. /* Give all the *clients* enough time to download the consensus. */
  1073. start = (time_t)(start + dl_interval + min_sec_before_caching);
  1074. /* But try to get it before ours actually expires. */
  1075. dl_interval = (c->valid_until - start) - min_sec_before_caching;
  1076. }
  1077. }
  1078. /* catch low dl_interval in crazy-fast networks */
  1079. if (dl_interval < 1)
  1080. dl_interval = 1;
  1081. /* catch late start in crazy-fast networks */
  1082. if (start+dl_interval >= c->valid_until)
  1083. start = c->valid_until - dl_interval - 1;
  1084. log_debug(LD_DIR,
  1085. "fresh_until: %ld start: %ld "
  1086. "dl_interval: %ld valid_until: %ld ",
  1087. (long)c->fresh_until, (long)start, dl_interval,
  1088. (long)c->valid_until);
  1089. /* We must not try to replace c while it's still fresh: */
  1090. tor_assert(c->fresh_until < start);
  1091. /* We must download the next one before c is invalid: */
  1092. tor_assert(start+dl_interval < c->valid_until);
  1093. time_to_download_next_consensus[flav] =
  1094. start + crypto_rand_int((int)dl_interval);
  1095. {
  1096. char tbuf1[ISO_TIME_LEN+1];
  1097. char tbuf2[ISO_TIME_LEN+1];
  1098. char tbuf3[ISO_TIME_LEN+1];
  1099. format_local_iso_time(tbuf1, c->fresh_until);
  1100. format_local_iso_time(tbuf2, c->valid_until);
  1101. format_local_iso_time(tbuf3, time_to_download_next_consensus[flav]);
  1102. log_info(LD_DIR, "Live %s consensus %s the most recent until %s and "
  1103. "will expire at %s; fetching the next one at %s.",
  1104. flavor, (c->fresh_until > now) ? "will be" : "was",
  1105. tbuf1, tbuf2, tbuf3);
  1106. }
  1107. } else {
  1108. time_to_download_next_consensus[flav] = now;
  1109. log_info(LD_DIR, "No live %s consensus; we should fetch one immediately.",
  1110. flavor);
  1111. }
  1112. }
  1113. /** Update the time at which we'll consider replacing the current
  1114. * consensus of flavor 'flavor' */
  1115. void
  1116. update_consensus_networkstatus_fetch_time(time_t now)
  1117. {
  1118. int i;
  1119. for (i = 0; i < N_CONSENSUS_FLAVORS; ++i) {
  1120. if (we_want_to_fetch_flavor(get_options(), i))
  1121. update_consensus_networkstatus_fetch_time_impl(now, i);
  1122. }
  1123. }
  1124. /** Return 1 if there's a reason we shouldn't try any directory
  1125. * fetches yet (e.g. we demand bridges and none are yet known).
  1126. * Else return 0.
  1127. * If we return 1 and <b>msg_out</b> is provided, set <b>msg_out</b>
  1128. * to an explanation of why directory fetches are delayed. (If we
  1129. * return 0, we set msg_out to NULL.)
  1130. */
  1131. int
  1132. should_delay_dir_fetches(const or_options_t *options, const char **msg_out)
  1133. {
  1134. if (msg_out) {
  1135. *msg_out = NULL;
  1136. }
  1137. if (options->DisableNetwork) {
  1138. if (msg_out) {
  1139. *msg_out = "DisableNetwork is set.";
  1140. }
  1141. log_info(LD_DIR, "Delaying dir fetches (DisableNetwork is set)");
  1142. return 1;
  1143. }
  1144. if (we_are_hibernating()) {
  1145. if (msg_out) {
  1146. *msg_out = "We are hibernating or shutting down.";
  1147. }
  1148. log_info(LD_DIR, "Delaying dir fetches (Hibernating or shutting down)");
  1149. return 1;
  1150. }
  1151. if (options->UseBridges) {
  1152. /* If we know that none of our bridges can possibly work, avoid fetching
  1153. * directory documents. But if some of them might work, try again. */
  1154. if (num_bridges_usable(1) == 0) {
  1155. if (msg_out) {
  1156. *msg_out = "No running bridges";
  1157. }
  1158. log_info(LD_DIR, "Delaying dir fetches (no running bridges known)");
  1159. return 1;
  1160. }
  1161. if (pt_proxies_configuration_pending()) {
  1162. if (msg_out) {
  1163. *msg_out = "Pluggable transport proxies still configuring";
  1164. }
  1165. log_info(LD_DIR, "Delaying dir fetches (pt proxies still configuring)");
  1166. return 1;
  1167. }
  1168. }
  1169. return 0;
  1170. }
  1171. /** Launch requests for networkstatus documents as appropriate. This is called
  1172. * when we retry all the connections on a SIGHUP and periodically by a Periodic
  1173. * event which checks whether we want to download any networkstatus documents.
  1174. */
  1175. void
  1176. update_networkstatus_downloads(time_t now)
  1177. {
  1178. const or_options_t *options = get_options();
  1179. if (should_delay_dir_fetches(options, NULL))
  1180. return;
  1181. /** Launch a consensus download request, we will wait for the consensus to
  1182. * download and when it completes we will launch a certificate download
  1183. * request. */
  1184. update_consensus_networkstatus_downloads(now);
  1185. }
  1186. /** Launch requests as appropriate for missing directory authority
  1187. * certificates. */
  1188. void
  1189. update_certificate_downloads(time_t now)
  1190. {
  1191. int i;
  1192. for (i = 0; i < N_CONSENSUS_FLAVORS; ++i) {
  1193. if (consensus_waiting_for_certs[i].consensus)
  1194. authority_certs_fetch_missing(consensus_waiting_for_certs[i].consensus,
  1195. now, NULL);
  1196. }
  1197. if (current_ns_consensus)
  1198. authority_certs_fetch_missing(current_ns_consensus, now, NULL);
  1199. if (current_md_consensus)
  1200. authority_certs_fetch_missing(current_md_consensus, now, NULL);
  1201. }
  1202. /** Return 1 if we have a consensus but we don't have enough certificates
  1203. * to start using it yet. */
  1204. int
  1205. consensus_is_waiting_for_certs(void)
  1206. {
  1207. return consensus_waiting_for_certs[usable_consensus_flavor()].consensus
  1208. ? 1 : 0;
  1209. }
  1210. /** Look up the currently active (depending on bootstrap status) download
  1211. * status for this consensus flavor and return a pointer to it.
  1212. */
  1213. MOCK_IMPL(download_status_t *,
  1214. networkstatus_get_dl_status_by_flavor,(consensus_flavor_t flavor))
  1215. {
  1216. download_status_t *dl = NULL;
  1217. const int we_are_bootstrapping =
  1218. networkstatus_consensus_is_bootstrapping(time(NULL));
  1219. if ((int)flavor <= N_CONSENSUS_FLAVORS) {
  1220. dl = &((we_are_bootstrapping ?
  1221. consensus_bootstrap_dl_status : consensus_dl_status)[flavor]);
  1222. }
  1223. return dl;
  1224. }
  1225. /** Look up the bootstrap download status for this consensus flavor
  1226. * and return a pointer to it. */
  1227. MOCK_IMPL(download_status_t *,
  1228. networkstatus_get_dl_status_by_flavor_bootstrap,(consensus_flavor_t flavor))
  1229. {
  1230. download_status_t *dl = NULL;
  1231. if ((int)flavor <= N_CONSENSUS_FLAVORS) {
  1232. dl = &(consensus_bootstrap_dl_status[flavor]);
  1233. }
  1234. return dl;
  1235. }
  1236. /** Look up the running (non-bootstrap) download status for this consensus
  1237. * flavor and return a pointer to it. */
  1238. MOCK_IMPL(download_status_t *,
  1239. networkstatus_get_dl_status_by_flavor_running,(consensus_flavor_t flavor))
  1240. {
  1241. download_status_t *dl = NULL;
  1242. if ((int)flavor <= N_CONSENSUS_FLAVORS) {
  1243. dl = &(consensus_dl_status[flavor]);
  1244. }
  1245. return dl;
  1246. }
  1247. /** Return the most recent consensus that we have downloaded, or NULL if we
  1248. * don't have one. */
  1249. MOCK_IMPL(networkstatus_t *,
  1250. networkstatus_get_latest_consensus,(void))
  1251. {
  1252. if (we_use_microdescriptors_for_circuits(get_options()))
  1253. return current_md_consensus;
  1254. else
  1255. return current_ns_consensus;
  1256. }
  1257. /** Return the latest consensus we have whose flavor matches <b>f</b>, or NULL
  1258. * if we don't have one. */
  1259. MOCK_IMPL(networkstatus_t *,
  1260. networkstatus_get_latest_consensus_by_flavor,(consensus_flavor_t f))
  1261. {
  1262. if (f == FLAV_NS)
  1263. return current_ns_consensus;
  1264. else if (f == FLAV_MICRODESC)
  1265. return current_md_consensus;
  1266. else {
  1267. tor_assert(0);
  1268. return NULL;
  1269. }
  1270. }
  1271. /** Return the most recent consensus that we have downloaded, or NULL if it is
  1272. * no longer live. */
  1273. MOCK_IMPL(networkstatus_t *,
  1274. networkstatus_get_live_consensus,(time_t now))
  1275. {
  1276. networkstatus_t *ns = networkstatus_get_latest_consensus();
  1277. if (ns && networkstatus_is_live(ns, now))
  1278. return ns;
  1279. else
  1280. return NULL;
  1281. }
  1282. /** Given a consensus in <b>ns</b>, return true iff currently live and
  1283. * unexpired. */
  1284. int
  1285. networkstatus_is_live(const networkstatus_t *ns, time_t now)
  1286. {
  1287. return (ns->valid_after <= now && now <= ns->valid_until);
  1288. }
  1289. /** Determine if <b>consensus</b> is valid or expired recently enough that
  1290. * we can still use it.
  1291. *
  1292. * Return 1 if the consensus is reasonably live, or 0 if it is too old.
  1293. */
  1294. int
  1295. networkstatus_consensus_reasonably_live(const networkstatus_t *consensus,
  1296. time_t now)
  1297. {
  1298. if (BUG(!consensus))
  1299. return 0;
  1300. return networkstatus_valid_until_is_reasonably_live(consensus->valid_until,
  1301. now);
  1302. }
  1303. /** As networkstatus_consensus_reasonably_live, but takes a valid_until
  1304. * time rather than an entire consensus. */
  1305. int
  1306. networkstatus_valid_until_is_reasonably_live(time_t valid_until,
  1307. time_t now)
  1308. {
  1309. #define REASONABLY_LIVE_TIME (24*60*60)
  1310. return (now <= valid_until + REASONABLY_LIVE_TIME);
  1311. }
  1312. /* XXXX remove this in favor of get_live_consensus. But actually,
  1313. * leave something like it for bridge users, who need to not totally
  1314. * lose if they spend a while fetching a new consensus. */
  1315. /** As networkstatus_get_live_consensus(), but is way more tolerant of expired
  1316. * consensuses. */
  1317. networkstatus_t *
  1318. networkstatus_get_reasonably_live_consensus(time_t now, int flavor)
  1319. {
  1320. networkstatus_t *consensus =
  1321. networkstatus_get_latest_consensus_by_flavor(flavor);
  1322. if (consensus &&
  1323. consensus->valid_after <= now &&
  1324. networkstatus_consensus_reasonably_live(consensus, now))
  1325. return consensus;
  1326. else
  1327. return NULL;
  1328. }
  1329. /** Check if we need to download a consensus during tor's bootstrap phase.
  1330. * If we have no consensus, or our consensus is unusably old, return 1.
  1331. * As soon as we have received a consensus, return 0, even if we don't have
  1332. * enough certificates to validate it.
  1333. * If a fallback directory gives us a consensus we can never get certs for,
  1334. * check_consensus_waiting_for_certs() will wait 20 minutes before failing
  1335. * the cert downloads. After that, a new consensus will be fetched from a
  1336. * randomly chosen fallback. */
  1337. MOCK_IMPL(int,
  1338. networkstatus_consensus_is_bootstrapping,(time_t now))
  1339. {
  1340. /* If we have a validated, reasonably live consensus, we're not
  1341. * bootstrapping a consensus at all. */
  1342. if (networkstatus_get_reasonably_live_consensus(
  1343. now,
  1344. usable_consensus_flavor())) {
  1345. return 0;
  1346. }
  1347. /* If we have a consensus, but we're waiting for certificates,
  1348. * we're not waiting for a consensus download while bootstrapping. */
  1349. if (consensus_is_waiting_for_certs()) {
  1350. return 0;
  1351. }
  1352. /* If we have no consensus, or our consensus is very old, we are
  1353. * bootstrapping, and we need to download a consensus. */
  1354. return 1;
  1355. }
  1356. /** Check if we can use multiple directories for a consensus download.
  1357. * Only clients (including bridge relays, which act like clients) benefit
  1358. * from multiple simultaneous consensus downloads. */
  1359. int
  1360. networkstatus_consensus_can_use_multiple_directories(
  1361. const or_options_t *options)
  1362. {
  1363. /* If we are a client, bridge, bridge client, or hidden service */
  1364. return !public_server_mode(options);
  1365. }
  1366. /** Check if we can use fallback directory mirrors for a consensus download.
  1367. * If we have fallbacks and don't want to fetch from the authorities,
  1368. * we can use them. */
  1369. MOCK_IMPL(int,
  1370. networkstatus_consensus_can_use_extra_fallbacks,(const or_options_t *options))
  1371. {
  1372. /* The list length comparisons are a quick way to check if we have any
  1373. * non-authority fallback directories. If we ever have any authorities that
  1374. * aren't fallback directories, we will need to change this code. */
  1375. tor_assert(smartlist_len(router_get_fallback_dir_servers())
  1376. >= smartlist_len(router_get_trusted_dir_servers()));
  1377. /* If we don't fetch from the authorities, and we have additional mirrors,
  1378. * we can use them. */
  1379. return (!directory_fetches_from_authorities(options)
  1380. && (smartlist_len(router_get_fallback_dir_servers())
  1381. > smartlist_len(router_get_trusted_dir_servers())));
  1382. }
  1383. /* Is there a consensus fetch for flavor <b>resource</b> that's far
  1384. * enough along to be attached to a circuit? */
  1385. int
  1386. networkstatus_consensus_is_already_downloading(const char *resource)
  1387. {
  1388. int answer = 0;
  1389. /* First, get a list of all the dir conns that are fetching a consensus,
  1390. * fetching *this* consensus, and are in state "reading" (meaning they
  1391. * have already flushed their request onto the socks connection). */
  1392. smartlist_t *fetching_conns =
  1393. connection_dir_list_by_purpose_resource_and_state(
  1394. DIR_PURPOSE_FETCH_CONSENSUS, resource, DIR_CONN_STATE_CLIENT_READING);
  1395. /* Then, walk through each conn, to see if its linked socks connection
  1396. * is in an attached state. We have to check this separately, since with
  1397. * the optimistic data feature, fetches can send their request to the
  1398. * socks connection and go into state 'reading', even before they're
  1399. * attached to any circuit. */
  1400. SMARTLIST_FOREACH_BEGIN(fetching_conns, dir_connection_t *, dirconn) {
  1401. /* Do any of these other dir conns have a linked socks conn that is
  1402. * attached to a circuit already? */
  1403. connection_t *base = TO_CONN(dirconn);
  1404. if (base->linked_conn &&
  1405. base->linked_conn->type == CONN_TYPE_AP &&
  1406. !AP_CONN_STATE_IS_UNATTACHED(base->linked_conn->state)) {
  1407. answer = 1;
  1408. break; /* stop looping, because we know the answer will be yes */
  1409. }
  1410. } SMARTLIST_FOREACH_END(dirconn);
  1411. smartlist_free(fetching_conns);
  1412. return answer;
  1413. }
  1414. /* Does the current, reasonably live consensus have IPv6 addresses?
  1415. * Returns 1 if there is a reasonably live consensus and its consensus method
  1416. * includes IPv6 addresses in the consensus.
  1417. * Otherwise, if there is no consensus, or the method does not include IPv6
  1418. * addresses, returns 0. */
  1419. int
  1420. networkstatus_consensus_has_ipv6(const or_options_t* options)
  1421. {
  1422. const networkstatus_t *cons = networkstatus_get_reasonably_live_consensus(
  1423. approx_time(),
  1424. usable_consensus_flavor());
  1425. /* If we have no consensus, we have no IPv6 in it */
  1426. if (!cons) {
  1427. return 0;
  1428. }
  1429. /* Different flavours of consensus gained IPv6 at different times */
  1430. if (we_use_microdescriptors_for_circuits(options)) {
  1431. return
  1432. cons->consensus_method >= MIN_METHOD_FOR_A_LINES_IN_MICRODESC_CONSENSUS;
  1433. } else {
  1434. return 1;
  1435. }
  1436. }
  1437. /** Given two router status entries for the same router identity, return 1 if
  1438. * if the contents have changed between them. Otherwise, return 0. */
  1439. static int
  1440. routerstatus_has_changed(const routerstatus_t *a, const routerstatus_t *b)
  1441. {
  1442. tor_assert(tor_memeq(a->identity_digest, b->identity_digest, DIGEST_LEN));
  1443. return strcmp(a->nickname, b->nickname) ||
  1444. fast_memneq(a->descriptor_digest, b->descriptor_digest, DIGEST_LEN) ||
  1445. a->addr != b->addr ||
  1446. a->or_port != b->or_port ||
  1447. a->dir_port != b->dir_port ||
  1448. a->is_authority != b->is_authority ||
  1449. a->is_exit != b->is_exit ||
  1450. a->is_stable != b->is_stable ||
  1451. a->is_fast != b->is_fast ||
  1452. a->is_flagged_running != b->is_flagged_running ||
  1453. a->is_named != b->is_named ||
  1454. a->is_unnamed != b->is_unnamed ||
  1455. a->is_valid != b->is_valid ||
  1456. a->is_possible_guard != b->is_possible_guard ||
  1457. a->is_bad_exit != b->is_bad_exit ||
  1458. a->is_hs_dir != b->is_hs_dir;
  1459. // XXXX this function needs a huge refactoring; it has gotten out
  1460. // XXXX of sync with routerstatus_t, and it will do so again.
  1461. }
  1462. /** Notify controllers of any router status entries that changed between
  1463. * <b>old_c</b> and <b>new_c</b>. */
  1464. static void
  1465. notify_control_networkstatus_changed(const networkstatus_t *old_c,
  1466. const networkstatus_t *new_c)
  1467. {
  1468. smartlist_t *changed;
  1469. if (old_c == new_c)
  1470. return;
  1471. /* tell the controller exactly which relays are still listed, as well
  1472. * as what they're listed as */
  1473. control_event_newconsensus(new_c);
  1474. if (!control_event_is_interesting(EVENT_NS))
  1475. return;
  1476. if (!old_c) {
  1477. control_event_networkstatus_changed(new_c->routerstatus_list);
  1478. return;
  1479. }
  1480. changed = smartlist_new();
  1481. SMARTLIST_FOREACH_JOIN(
  1482. old_c->routerstatus_list, const routerstatus_t *, rs_old,
  1483. new_c->routerstatus_list, const routerstatus_t *, rs_new,
  1484. tor_memcmp(rs_old->identity_digest,
  1485. rs_new->identity_digest, DIGEST_LEN),
  1486. smartlist_add(changed, (void*) rs_new)) {
  1487. if (routerstatus_has_changed(rs_old, rs_new))
  1488. smartlist_add(changed, (void*)rs_new);
  1489. } SMARTLIST_FOREACH_JOIN_END(rs_old, rs_new);
  1490. control_event_networkstatus_changed(changed);
  1491. smartlist_free(changed);
  1492. }
  1493. /* Called before the consensus changes from old_c to new_c. */
  1494. static void
  1495. notify_before_networkstatus_changes(const networkstatus_t *old_c,
  1496. const networkstatus_t *new_c)
  1497. {
  1498. notify_control_networkstatus_changed(old_c, new_c);
  1499. dos_consensus_has_changed(new_c);
  1500. relay_consensus_has_changed(new_c);
  1501. }
  1502. /* Called after a new consensus has been put in the global state. It is safe
  1503. * to use the consensus getters in this function. */
  1504. static void
  1505. notify_after_networkstatus_changes(void)
  1506. {
  1507. scheduler_notify_networkstatus_changed();
  1508. }
  1509. /** Copy all the ancillary information (like router download status and so on)
  1510. * from <b>old_c</b> to <b>new_c</b>. */
  1511. static void
  1512. networkstatus_copy_old_consensus_info(networkstatus_t *new_c,
  1513. const networkstatus_t *old_c)
  1514. {
  1515. if (old_c == new_c)
  1516. return;
  1517. if (!old_c || !smartlist_len(old_c->routerstatus_list))
  1518. return;
  1519. SMARTLIST_FOREACH_JOIN(old_c->routerstatus_list, routerstatus_t *, rs_old,
  1520. new_c->routerstatus_list, routerstatus_t *, rs_new,
  1521. tor_memcmp(rs_old->identity_digest,
  1522. rs_new->identity_digest, DIGEST_LEN),
  1523. STMT_NIL) {
  1524. /* Okay, so we're looking at the same identity. */
  1525. rs_new->last_dir_503_at = rs_old->last_dir_503_at;
  1526. if (tor_memeq(rs_old->descriptor_digest, rs_new->descriptor_digest,
  1527. DIGEST256_LEN)) {
  1528. /* And the same descriptor too! */
  1529. memcpy(&rs_new->dl_status, &rs_old->dl_status,sizeof(download_status_t));
  1530. }
  1531. } SMARTLIST_FOREACH_JOIN_END(rs_old, rs_new);
  1532. }
  1533. #ifdef TOR_UNIT_TESTS
  1534. /**Accept a <b>flavor</b> consensus <b>c</b> without any additional
  1535. * validation. This is exclusively for unit tests.
  1536. * We copy any ancillary information from a pre-existing consensus
  1537. * and then free the current one and replace it with the newly
  1538. * provided instance. Returns -1 on unrecognized flavor, 0 otherwise.
  1539. */
  1540. int
  1541. networkstatus_set_current_consensus_from_ns(networkstatus_t *c,
  1542. const char *flavor)
  1543. {
  1544. int flav = networkstatus_parse_flavor_name(flavor);
  1545. switch (flav) {
  1546. case FLAV_NS:
  1547. if (current_ns_consensus) {
  1548. networkstatus_copy_old_consensus_info(c, current_ns_consensus);
  1549. networkstatus_vote_free(current_ns_consensus);
  1550. }
  1551. current_ns_consensus = c;
  1552. break;
  1553. case FLAV_MICRODESC:
  1554. if (current_md_consensus) {
  1555. networkstatus_copy_old_consensus_info(c, current_md_consensus);
  1556. networkstatus_vote_free(current_md_consensus);
  1557. }
  1558. current_md_consensus = c;
  1559. break;
  1560. }
  1561. return current_md_consensus ? 0 : -1;
  1562. }
  1563. #endif /* defined(TOR_UNIT_TESTS) */
  1564. /**
  1565. * Helper for handle_missing_protocol_warning: handles either the
  1566. * client case (if <b>is_client</b> is set) or the server case otherwise.
  1567. */
  1568. static void
  1569. handle_missing_protocol_warning_impl(const networkstatus_t *c,
  1570. int is_client)
  1571. {
  1572. char *protocol_warning = NULL;
  1573. int should_exit = networkstatus_check_required_protocols(c,
  1574. is_client,
  1575. &protocol_warning);
  1576. if (protocol_warning) {
  1577. tor_log(should_exit ? LOG_ERR : LOG_WARN,
  1578. LD_GENERAL,
  1579. "%s", protocol_warning);
  1580. }
  1581. if (should_exit) {
  1582. tor_assert_nonfatal(protocol_warning);
  1583. }
  1584. tor_free(protocol_warning);
  1585. if (should_exit)
  1586. exit(1); // XXXX bad exit: should return from main.
  1587. }
  1588. /** Called when we have received a networkstatus <b>c</b>. If there are
  1589. * any _required_ protocols we are missing, log an error and exit
  1590. * immediately. If there are any _recommended_ protocols we are missing,
  1591. * warn. */
  1592. static void
  1593. handle_missing_protocol_warning(const networkstatus_t *c,
  1594. const or_options_t *options)
  1595. {
  1596. const int is_server = server_mode(options);
  1597. const int is_client = options_any_client_port_set(options) || !is_server;
  1598. if (is_server)
  1599. handle_missing_protocol_warning_impl(c, 0);
  1600. if (is_client)
  1601. handle_missing_protocol_warning_impl(c, 1);
  1602. }
  1603. /**
  1604. * Check whether we received a consensus that appears to be coming
  1605. * from the future. Because we implicitly trust the directory
  1606. * authorities' idea of the current time, we produce a warning if we
  1607. * get an early consensus.
  1608. *
  1609. * If we got a consensus that is time stamped far in the past, that
  1610. * could simply have come from a stale cache. Possible ways to get a
  1611. * consensus from the future can include:
  1612. *
  1613. * - enough directory authorities have wrong clocks
  1614. * - directory authorities collude to produce misleading time stamps
  1615. * - our own clock is wrong (this is by far the most likely)
  1616. *
  1617. * We neglect highly improbable scenarios that involve actual time
  1618. * travel.
  1619. */
  1620. STATIC void
  1621. warn_early_consensus(const networkstatus_t *c, const char *flavor,
  1622. time_t now)
  1623. {
  1624. char tbuf[ISO_TIME_LEN+1];
  1625. char dbuf[64];
  1626. long delta = now - c->valid_after;
  1627. char *flavormsg = NULL;
  1628. /** If a consensus appears more than this many seconds before it could
  1629. * possibly be a sufficiently-signed consensus, declare that our clock
  1630. * is skewed. */
  1631. #define EARLY_CONSENSUS_NOTICE_SKEW 60
  1632. /* We assume that if a majority of dirauths have accurate clocks,
  1633. * the earliest that a dirauth with a skewed clock could possibly
  1634. * publish a sufficiently-signed consensus is (valid_after -
  1635. * dist_seconds). Before that time, the skewed dirauth would be
  1636. * unable to obtain enough authority signatures for the consensus to
  1637. * be valid. */
  1638. if (now >= c->valid_after - c->dist_seconds - EARLY_CONSENSUS_NOTICE_SKEW)
  1639. return;
  1640. format_iso_time(tbuf, c->valid_after);
  1641. format_time_interval(dbuf, sizeof(dbuf), delta);
  1642. log_warn(LD_GENERAL, "Our clock is %s behind the time published in the "
  1643. "consensus network status document (%s UTC). Tor needs an "
  1644. "accurate clock to work correctly. Please check your time and "
  1645. "date settings!", dbuf, tbuf);
  1646. tor_asprintf(&flavormsg, "%s flavor consensus", flavor);
  1647. clock_skew_warning(NULL, delta, 1, LD_GENERAL, flavormsg, "CONSENSUS");
  1648. tor_free(flavormsg);
  1649. }
  1650. /** Try to replace the current cached v3 networkstatus with the one in
  1651. * <b>consensus</b>. If we don't have enough certificates to validate it,
  1652. * store it in consensus_waiting_for_certs and launch a certificate fetch.
  1653. *
  1654. * If flags & NSSET_FROM_CACHE, this networkstatus has come from the disk
  1655. * cache. If flags & NSSET_WAS_WAITING_FOR_CERTS, this networkstatus was
  1656. * already received, but we were waiting for certificates on it. If flags &
  1657. * NSSET_DONT_DOWNLOAD_CERTS, do not launch certificate downloads as needed.
  1658. * If flags & NSSET_ACCEPT_OBSOLETE, then we should be willing to take this
  1659. * consensus, even if it comes from many days in the past.
  1660. *
  1661. * If source_dir is non-NULL, it's the identity digest for a directory that
  1662. * we've just successfully retrieved a consensus or certificates from, so try
  1663. * it first to fetch any missing certificates.
  1664. *
  1665. * Return 0 on success, <0 on failure. On failure, caller should increment
  1666. * the failure count as appropriate.
  1667. *
  1668. * We return -1 for mild failures that don't need to be reported to the
  1669. * user, and -2 for more serious problems.
  1670. */
  1671. int
  1672. networkstatus_set_current_consensus(const char *consensus,
  1673. size_t consensus_len,
  1674. const char *flavor,
  1675. unsigned flags,
  1676. const char *source_dir)
  1677. {
  1678. networkstatus_t *c=NULL;
  1679. int r, result = -1;
  1680. time_t now = approx_time();
  1681. const or_options_t *options = get_options();
  1682. char *unverified_fname = NULL, *consensus_fname = NULL;
  1683. int flav = networkstatus_parse_flavor_name(flavor);
  1684. const unsigned from_cache = flags & NSSET_FROM_CACHE;
  1685. const unsigned was_waiting_for_certs = flags & NSSET_WAS_WAITING_FOR_CERTS;
  1686. const unsigned dl_certs = !(flags & NSSET_DONT_DOWNLOAD_CERTS);
  1687. const unsigned accept_obsolete = flags & NSSET_ACCEPT_OBSOLETE;
  1688. const unsigned require_flavor = flags & NSSET_REQUIRE_FLAVOR;
  1689. const common_digests_t *current_digests = NULL;
  1690. consensus_waiting_for_certs_t *waiting = NULL;
  1691. time_t current_valid_after = 0;
  1692. int free_consensus = 1; /* Free 'c' at the end of the function */
  1693. int checked_protocols_already = 0;
  1694. if (flav < 0) {
  1695. /* XXXX we don't handle unrecognized flavors yet. */
  1696. log_warn(LD_BUG, "Unrecognized consensus flavor %s", flavor);
  1697. return -2;
  1698. }
  1699. /* Make sure it's parseable. */
  1700. c = networkstatus_parse_vote_from_string(consensus,
  1701. consensus_len,
  1702. NULL, NS_TYPE_CONSENSUS);
  1703. if (!c) {
  1704. log_warn(LD_DIR, "Unable to parse networkstatus consensus");
  1705. result = -2;
  1706. goto done;
  1707. }
  1708. if (from_cache && !was_waiting_for_certs) {
  1709. /* We previously stored this; check _now_ to make sure that version-kills
  1710. * really work. This happens even before we check signatures: we did so
  1711. * before when we stored this to disk. This does mean an attacker who can
  1712. * write to the datadir can make us not start: such an attacker could
  1713. * already harm us by replacing our guards, which would be worse. */
  1714. checked_protocols_already = 1;
  1715. handle_missing_protocol_warning(c, options);
  1716. }
  1717. if ((int)c->flavor != flav) {
  1718. /* This wasn't the flavor we thought we were getting. */
  1719. if (require_flavor) {
  1720. log_warn(LD_DIR, "Got consensus with unexpected flavor %s (wanted %s)",
  1721. networkstatus_get_flavor_name(c->flavor), flavor);
  1722. goto done;
  1723. }
  1724. flav = c->flavor;
  1725. flavor = networkstatus_get_flavor_name(flav);
  1726. }
  1727. if (flav != usable_consensus_flavor() &&
  1728. !we_want_to_fetch_flavor(options, flav)) {
  1729. /* This consensus is totally boring to us: we won't use it, we didn't want
  1730. * it, and we won't serve it. Drop it. */
  1731. goto done;
  1732. }
  1733. if (from_cache && !accept_obsolete &&
  1734. c->valid_until < now-OLD_ROUTER_DESC_MAX_AGE) {
  1735. log_info(LD_DIR, "Loaded an expired consensus. Discarding.");
  1736. goto done;
  1737. }
  1738. if (!strcmp(flavor, "ns")) {
  1739. consensus_fname = get_cachedir_fname("cached-consensus");
  1740. unverified_fname = get_cachedir_fname("unverified-consensus");
  1741. if (current_ns_consensus) {
  1742. current_digests = &current_ns_consensus->digests;
  1743. current_valid_after = current_ns_consensus->valid_after;
  1744. }
  1745. } else if (!strcmp(flavor, "microdesc")) {
  1746. consensus_fname = get_cachedir_fname("cached-microdesc-consensus");
  1747. unverified_fname = get_cachedir_fname("unverified-microdesc-consensus");
  1748. if (current_md_consensus) {
  1749. current_digests = &current_md_consensus->digests;
  1750. current_valid_after = current_md_consensus->valid_after;
  1751. }
  1752. } else {
  1753. tor_assert_nonfatal_unreached();
  1754. result = -2;
  1755. goto done;
  1756. }
  1757. if (current_digests &&
  1758. tor_memeq(&c->digests, current_digests, sizeof(c->digests))) {
  1759. /* We already have this one. That's a failure. */
  1760. log_info(LD_DIR, "Got a %s consensus we already have", flavor);
  1761. goto done;
  1762. }
  1763. if (current_valid_after && c->valid_after <= current_valid_after) {
  1764. /* We have a newer one. There's no point in accepting this one,
  1765. * even if it's great. */
  1766. log_info(LD_DIR, "Got a %s consensus at least as old as the one we have",
  1767. flavor);
  1768. goto done;
  1769. }
  1770. /* Make sure it's signed enough. */
  1771. if ((r=networkstatus_check_consensus_signature(c, 1))<0) {
  1772. if (r == -1) {
  1773. /* Okay, so it _might_ be signed enough if we get more certificates. */
  1774. if (!was_waiting_for_certs) {
  1775. log_info(LD_DIR,
  1776. "Not enough certificates to check networkstatus consensus");
  1777. }
  1778. if (!current_valid_after ||
  1779. c->valid_after > current_valid_after) {
  1780. waiting = &consensus_waiting_for_certs[flav];
  1781. networkstatus_vote_free(waiting->consensus);
  1782. waiting->consensus = c;
  1783. free_consensus = 0;
  1784. waiting->set_at = now;
  1785. waiting->dl_failed = 0;
  1786. if (!from_cache) {
  1787. write_bytes_to_file(unverified_fname, consensus, consensus_len, 0);
  1788. }
  1789. if (dl_certs)
  1790. authority_certs_fetch_missing(c, now, source_dir);
  1791. /* This case is not a success or a failure until we get the certs
  1792. * or fail to get the certs. */
  1793. result = 0;
  1794. } else {
  1795. /* Even if we had enough signatures, we'd never use this as the
  1796. * latest consensus. */
  1797. if (was_waiting_for_certs && from_cache)
  1798. if (unlink(unverified_fname) != 0) {
  1799. log_warn(LD_FS,
  1800. "Failed to unlink %s: %s",
  1801. unverified_fname, strerror(errno));
  1802. }
  1803. }
  1804. goto done;
  1805. } else {
  1806. /* This can never be signed enough: Kill it. */
  1807. if (!was_waiting_for_certs) {
  1808. log_warn(LD_DIR, "Not enough good signatures on networkstatus "
  1809. "consensus");
  1810. result = -2;
  1811. }
  1812. if (was_waiting_for_certs && (r < -1) && from_cache) {
  1813. if (unlink(unverified_fname) != 0) {
  1814. log_warn(LD_FS,
  1815. "Failed to unlink %s: %s",
  1816. unverified_fname, strerror(errno));
  1817. }
  1818. }
  1819. goto done;
  1820. }
  1821. }
  1822. /* Signatures from the consensus are verified */
  1823. if (from_cache && was_waiting_for_certs) {
  1824. /* We check if the consensus is loaded from disk cache and that it
  1825. * it is an unverified consensus. If it is unverified, rename it to
  1826. * cached-*-consensus since it has been verified. */
  1827. log_info(LD_DIR, "Unverified consensus signatures verified.");
  1828. tor_rename(unverified_fname, consensus_fname);
  1829. }
  1830. if (!from_cache && flav == usable_consensus_flavor())
  1831. control_event_client_status(LOG_NOTICE, "CONSENSUS_ARRIVED");
  1832. if (!checked_protocols_already) {
  1833. handle_missing_protocol_warning(c, options);
  1834. }
  1835. /* Are we missing any certificates at all? */
  1836. if (r != 1 && dl_certs)
  1837. authority_certs_fetch_missing(c, now, source_dir);
  1838. const int is_usable_flavor = flav == usable_consensus_flavor();
  1839. /* Before we switch to the new consensus, notify that we are about to change
  1840. * it using the old consensus and the new one. */
  1841. if (is_usable_flavor) {
  1842. notify_before_networkstatus_changes(networkstatus_get_latest_consensus(),
  1843. c);
  1844. }
  1845. if (flav == FLAV_NS) {
  1846. if (current_ns_consensus) {
  1847. networkstatus_copy_old_consensus_info(c, current_ns_consensus);
  1848. networkstatus_vote_free(current_ns_consensus);
  1849. /* Defensive programming : we should set current_ns_consensus very soon
  1850. * but we're about to call some stuff in the meantime, and leaving this
  1851. * dangling pointer around has proven to be trouble. */
  1852. current_ns_consensus = NULL;
  1853. }
  1854. current_ns_consensus = c;
  1855. free_consensus = 0; /* avoid free */
  1856. } else if (flav == FLAV_MICRODESC) {
  1857. if (current_md_consensus) {
  1858. networkstatus_copy_old_consensus_info(c, current_md_consensus);
  1859. networkstatus_vote_free(current_md_consensus);
  1860. /* more defensive programming */
  1861. current_md_consensus = NULL;
  1862. }
  1863. current_md_consensus = c;
  1864. free_consensus = 0; /* avoid free */
  1865. }
  1866. waiting = &consensus_waiting_for_certs[flav];
  1867. if (waiting->consensus &&
  1868. waiting->consensus->valid_after <= c->valid_after) {
  1869. networkstatus_vote_free(waiting->consensus);
  1870. waiting->consensus = NULL;
  1871. waiting->set_at = 0;
  1872. waiting->dl_failed = 0;
  1873. if (unlink(unverified_fname) != 0) {
  1874. log_warn(LD_FS,
  1875. "Failed to unlink %s: %s",
  1876. unverified_fname, strerror(errno));
  1877. }
  1878. }
  1879. if (is_usable_flavor) {
  1880. /* Notify that we just changed the consensus so the current global value
  1881. * can be looked at. */
  1882. notify_after_networkstatus_changes();
  1883. /* The "current" consensus has just been set and it is a usable flavor so
  1884. * the first thing we need to do is recalculate the voting schedule static
  1885. * object so we can use the timings in there needed by some subsystems
  1886. * such as hidden service and shared random. */
  1887. voting_schedule_recalculate_timing(options, now);
  1888. reschedule_dirvote(options);
  1889. nodelist_set_consensus(c);
  1890. /* XXXXNM Microdescs: needs a non-ns variant. ???? NM*/
  1891. update_consensus_networkstatus_fetch_time(now);
  1892. /* Change the cell EWMA settings */
  1893. cmux_ewma_set_options(options, c);
  1894. /* XXXX this call might be unnecessary here: can changing the
  1895. * current consensus really alter our view of any OR's rate limits? */
  1896. connection_or_update_token_buckets(get_connection_array(), options);
  1897. circuit_build_times_new_consensus_params(
  1898. get_circuit_build_times_mutable(), c);
  1899. channelpadding_new_consensus_params(c);
  1900. }
  1901. /* Reset the failure count only if this consensus is actually valid. */
  1902. if (c->valid_after <= now && now <= c->valid_until) {
  1903. download_status_reset(&consensus_dl_status[flav]);
  1904. } else {
  1905. if (!from_cache)
  1906. download_status_failed(&consensus_dl_status[flav], 0);
  1907. }
  1908. if (we_want_to_fetch_flavor(options, flav)) {
  1909. if (dir_server_mode(get_options())) {
  1910. dirserv_set_cached_consensus_networkstatus(consensus,
  1911. consensus_len,
  1912. flavor,
  1913. &c->digests,
  1914. c->digest_sha3_as_signed,
  1915. c->valid_after);
  1916. consdiffmgr_add_consensus(consensus, consensus_len, c);
  1917. }
  1918. }
  1919. if (!from_cache) {
  1920. write_bytes_to_file(consensus_fname, consensus, consensus_len, 0);
  1921. }
  1922. warn_early_consensus(c, flavor, now);
  1923. /* We got a new consesus. Reset our md fetch fail cache */
  1924. microdesc_reset_outdated_dirservers_list();
  1925. router_dir_info_changed();
  1926. result = 0;
  1927. done:
  1928. if (free_consensus)
  1929. networkstatus_vote_free(c);
  1930. tor_free(consensus_fname);
  1931. tor_free(unverified_fname);
  1932. return result;
  1933. }
  1934. /** Called when we have gotten more certificates: see whether we can
  1935. * now verify a pending consensus.
  1936. *
  1937. * If source_dir is non-NULL, it's the identity digest for a directory that
  1938. * we've just successfully retrieved certificates from, so try it first to
  1939. * fetch any missing certificates.
  1940. */
  1941. void
  1942. networkstatus_note_certs_arrived(const char *source_dir)
  1943. {
  1944. int i;
  1945. for (i=0; i<N_CONSENSUS_FLAVORS; ++i) {
  1946. const char *flavor_name = networkstatus_get_flavor_name(i);
  1947. consensus_waiting_for_certs_t *waiting = &consensus_waiting_for_certs[i];
  1948. if (!waiting->consensus)
  1949. continue;
  1950. if (networkstatus_check_consensus_signature(waiting->consensus, 0)>=0) {
  1951. tor_mmap_t *mapping = networkstatus_map_cached_consensus_impl(
  1952. i, flavor_name, 1);
  1953. if (mapping) {
  1954. networkstatus_set_current_consensus(mapping->data,
  1955. mapping->size,
  1956. flavor_name,
  1957. NSSET_WAS_WAITING_FOR_CERTS,
  1958. source_dir);
  1959. }
  1960. tor_munmap_file(mapping);
  1961. }
  1962. }
  1963. }
  1964. /** If the network-status list has changed since the last time we called this
  1965. * function, update the status of every routerinfo from the network-status
  1966. * list. If <b>dir_version</b> is 2, it's a v2 networkstatus that changed.
  1967. * If <b>dir_version</b> is 3, it's a v3 consensus that changed.
  1968. */
  1969. void
  1970. routers_update_all_from_networkstatus(time_t now, int dir_version)
  1971. {
  1972. routerlist_t *rl = router_get_routerlist();
  1973. networkstatus_t *consensus = networkstatus_get_reasonably_live_consensus(now,
  1974. FLAV_NS);
  1975. if (!consensus || dir_version < 3) /* nothing more we should do */
  1976. return;
  1977. /* calls router_dir_info_changed() when it's done -- more routers
  1978. * might be up or down now, which might affect whether there's enough
  1979. * directory info. */
  1980. routers_update_status_from_consensus_networkstatus(rl->routers, 0);
  1981. SMARTLIST_FOREACH(rl->routers, routerinfo_t *, ri,
  1982. ri->cache_info.routerlist_index = ri_sl_idx);
  1983. if (rl->old_routers)
  1984. signed_descs_update_status_from_consensus_networkstatus(rl->old_routers);
  1985. if (!have_warned_about_old_version) {
  1986. int is_server = server_mode(get_options());
  1987. version_status_t status;
  1988. const char *recommended = is_server ?
  1989. consensus->server_versions : consensus->client_versions;
  1990. status = tor_version_is_obsolete(VERSION, recommended);
  1991. if (status == VS_RECOMMENDED) {
  1992. log_info(LD_GENERAL, "The directory authorities say my version is ok.");
  1993. } else if (status == VS_EMPTY) {
  1994. log_info(LD_GENERAL,
  1995. "The directory authorities don't recommend any versions.");
  1996. } else if (status == VS_NEW || status == VS_NEW_IN_SERIES) {
  1997. if (!have_warned_about_new_version) {
  1998. log_notice(LD_GENERAL, "This version of Tor (%s) is newer than any "
  1999. "recommended version%s, according to the directory "
  2000. "authorities. Recommended versions are: %s",
  2001. VERSION,
  2002. status == VS_NEW_IN_SERIES ? " in its series" : "",
  2003. recommended);
  2004. have_warned_about_new_version = 1;
  2005. control_event_general_status(LOG_WARN, "DANGEROUS_VERSION "
  2006. "CURRENT=%s REASON=%s RECOMMENDED=\"%s\"",
  2007. VERSION, "NEW", recommended);
  2008. }
  2009. } else {
  2010. log_warn(LD_GENERAL, "Please upgrade! "
  2011. "This version of Tor (%s) is %s, according to the directory "
  2012. "authorities. Recommended versions are: %s",
  2013. VERSION,
  2014. status == VS_OLD ? "obsolete" : "not recommended",
  2015. recommended);
  2016. have_warned_about_old_version = 1;
  2017. control_event_general_status(LOG_WARN, "DANGEROUS_VERSION "
  2018. "CURRENT=%s REASON=%s RECOMMENDED=\"%s\"",
  2019. VERSION, status == VS_OLD ? "OBSOLETE" : "UNRECOMMENDED",
  2020. recommended);
  2021. }
  2022. }
  2023. }
  2024. /** Given a list <b>routers</b> of routerinfo_t *, update each status field
  2025. * according to our current consensus networkstatus. May re-order
  2026. * <b>routers</b>. */
  2027. void
  2028. routers_update_status_from_consensus_networkstatus(smartlist_t *routers,
  2029. int reset_failures)
  2030. {
  2031. const or_options_t *options = get_options();
  2032. int authdir = authdir_mode_v3(options);
  2033. networkstatus_t *ns = networkstatus_get_latest_consensus();
  2034. if (!ns || !smartlist_len(ns->routerstatus_list))
  2035. return;
  2036. routers_sort_by_identity(routers);
  2037. SMARTLIST_FOREACH_JOIN(ns->routerstatus_list, routerstatus_t *, rs,
  2038. routers, routerinfo_t *, router,
  2039. tor_memcmp(rs->identity_digest,
  2040. router->cache_info.identity_digest, DIGEST_LEN),
  2041. {
  2042. }) {
  2043. /* Is it the same descriptor, or only the same identity? */
  2044. if (tor_memeq(router->cache_info.signed_descriptor_digest,
  2045. rs->descriptor_digest, DIGEST_LEN)) {
  2046. if (ns->valid_until > router->cache_info.last_listed_as_valid_until)
  2047. router->cache_info.last_listed_as_valid_until = ns->valid_until;
  2048. }
  2049. if (authdir) {
  2050. /* If we _are_ an authority, we should check whether this router
  2051. * is one that will cause us to need a reachability test. */
  2052. routerinfo_t *old_router =
  2053. router_get_mutable_by_digest(router->cache_info.identity_digest);
  2054. if (old_router != router) {
  2055. router->needs_retest_if_added =
  2056. dirserv_should_launch_reachability_test(router, old_router);
  2057. }
  2058. }
  2059. if (reset_failures) {
  2060. download_status_reset(&rs->dl_status);
  2061. }
  2062. } SMARTLIST_FOREACH_JOIN_END(rs, router);
  2063. router_dir_info_changed();
  2064. }
  2065. /** Given a list of signed_descriptor_t, update their fields (mainly, when
  2066. * they were last listed) from the most recent consensus. */
  2067. void
  2068. signed_descs_update_status_from_consensus_networkstatus(smartlist_t *descs)
  2069. {
  2070. networkstatus_t *ns = current_ns_consensus;
  2071. if (!ns)
  2072. return;
  2073. if (!ns->desc_digest_map) {
  2074. char dummy[DIGEST_LEN];
  2075. /* instantiates the digest map. */
  2076. memset(dummy, 0, sizeof(dummy));
  2077. router_get_consensus_status_by_descriptor_digest(ns, dummy);
  2078. }
  2079. SMARTLIST_FOREACH(descs, signed_descriptor_t *, d,
  2080. {
  2081. const routerstatus_t *rs = digestmap_get(ns->desc_digest_map,
  2082. d->signed_descriptor_digest);
  2083. if (rs) {
  2084. if (ns->valid_until > d->last_listed_as_valid_until)
  2085. d->last_listed_as_valid_until = ns->valid_until;
  2086. }
  2087. });
  2088. }
  2089. /** Generate networkstatus lines for a single routerstatus_t object, and
  2090. * return the result in a newly allocated string. Used only by controller
  2091. * interface (for now.) */
  2092. char *
  2093. networkstatus_getinfo_helper_single(const routerstatus_t *rs)
  2094. {
  2095. return routerstatus_format_entry(rs, NULL, NULL, NS_CONTROL_PORT,
  2096. ROUTERSTATUS_FORMAT_NO_CONSENSUS_METHOD,
  2097. NULL);
  2098. }
  2099. /** Alloc and return a string describing routerstatuses for the most
  2100. * recent info of each router we know about that is of purpose
  2101. * <b>purpose_string</b>. Return NULL if unrecognized purpose.
  2102. *
  2103. * Right now this function is oriented toward listing bridges (you
  2104. * shouldn't use this for general-purpose routers, since those
  2105. * should be listed from the consensus, not from the routers list). */
  2106. char *
  2107. networkstatus_getinfo_by_purpose(const char *purpose_string, time_t now)
  2108. {
  2109. const time_t cutoff = now - ROUTER_MAX_AGE_TO_PUBLISH;
  2110. char *answer;
  2111. routerlist_t *rl = router_get_routerlist();
  2112. smartlist_t *statuses;
  2113. const uint8_t purpose = router_purpose_from_string(purpose_string);
  2114. routerstatus_t rs;
  2115. const int bridge_auth = authdir_mode_bridge(get_options());
  2116. if (purpose == ROUTER_PURPOSE_UNKNOWN) {
  2117. log_info(LD_DIR, "Unrecognized purpose '%s' when listing router statuses.",
  2118. purpose_string);
  2119. return NULL;
  2120. }
  2121. statuses = smartlist_new();
  2122. SMARTLIST_FOREACH_BEGIN(rl->routers, routerinfo_t *, ri) {
  2123. node_t *node = node_get_mutable_by_id(ri->cache_info.identity_digest);
  2124. if (!node)
  2125. continue;
  2126. if (ri->cache_info.published_on < cutoff)
  2127. continue;
  2128. if (ri->purpose != purpose)
  2129. continue;
  2130. /* TODO: modifying the running flag in a getinfo is a bad idea */
  2131. if (bridge_auth && ri->purpose == ROUTER_PURPOSE_BRIDGE)
  2132. dirserv_set_router_is_running(ri, now);
  2133. /* then generate and write out status lines for each of them */
  2134. set_routerstatus_from_routerinfo(&rs, node, ri, now, 0);
  2135. smartlist_add(statuses, networkstatus_getinfo_helper_single(&rs));
  2136. } SMARTLIST_FOREACH_END(ri);
  2137. answer = smartlist_join_strings(statuses, "", 0, NULL);
  2138. SMARTLIST_FOREACH(statuses, char *, cp, tor_free(cp));
  2139. smartlist_free(statuses);
  2140. return answer;
  2141. }
  2142. /** Write out router status entries for all our bridge descriptors. */
  2143. void
  2144. networkstatus_dump_bridge_status_to_file(time_t now)
  2145. {
  2146. char *status = networkstatus_getinfo_by_purpose("bridge", now);
  2147. char *fname = NULL;
  2148. char *thresholds = NULL;
  2149. char *published_thresholds_and_status = NULL;
  2150. char published[ISO_TIME_LEN+1];
  2151. const routerinfo_t *me = router_get_my_routerinfo();
  2152. char fingerprint[FINGERPRINT_LEN+1];
  2153. char *fingerprint_line = NULL;
  2154. if (me && crypto_pk_get_fingerprint(me->identity_pkey,
  2155. fingerprint, 0) >= 0) {
  2156. tor_asprintf(&fingerprint_line, "fingerprint %s\n", fingerprint);
  2157. } else {
  2158. log_warn(LD_BUG, "Error computing fingerprint for bridge status.");
  2159. }
  2160. format_iso_time(published, now);
  2161. dirserv_compute_bridge_flag_thresholds();
  2162. thresholds = dirserv_get_flag_thresholds_line();
  2163. tor_asprintf(&published_thresholds_and_status,
  2164. "published %s\nflag-thresholds %s\n%s%s",
  2165. published, thresholds, fingerprint_line ? fingerprint_line : "",
  2166. status);
  2167. fname = get_datadir_fname("networkstatus-bridges");
  2168. if (write_str_to_file(fname,published_thresholds_and_status,0)<0) {
  2169. log_warn(LD_DIRSERV, "Unable to write networkstatus-bridges file.");
  2170. }
  2171. tor_free(thresholds);
  2172. tor_free(published_thresholds_and_status);
  2173. tor_free(fname);
  2174. tor_free(status);
  2175. tor_free(fingerprint_line);
  2176. }
  2177. /* DOCDOC get_net_param_from_list */
  2178. static int32_t
  2179. get_net_param_from_list(smartlist_t *net_params, const char *param_name,
  2180. int32_t default_val, int32_t min_val, int32_t max_val)
  2181. {
  2182. int32_t res = default_val;
  2183. size_t name_len = strlen(param_name);
  2184. tor_assert(max_val > min_val);
  2185. tor_assert(min_val <= default_val);
  2186. tor_assert(max_val >= default_val);
  2187. SMARTLIST_FOREACH_BEGIN(net_params, const char *, p) {
  2188. if (!strcmpstart(p, param_name) && p[name_len] == '=') {
  2189. int ok=0;
  2190. long v = tor_parse_long(p+name_len+1, 10, INT32_MIN,
  2191. INT32_MAX, &ok, NULL);
  2192. if (ok) {
  2193. res = (int32_t) v;
  2194. break;
  2195. }
  2196. }
  2197. } SMARTLIST_FOREACH_END(p);
  2198. if (res < min_val) {
  2199. log_warn(LD_DIR, "Consensus parameter %s is too small. Got %d, raising to "
  2200. "%d.", param_name, res, min_val);
  2201. res = min_val;
  2202. } else if (res > max_val) {
  2203. log_warn(LD_DIR, "Consensus parameter %s is too large. Got %d, capping to "
  2204. "%d.", param_name, res, max_val);
  2205. res = max_val;
  2206. }
  2207. tor_assert(res >= min_val);
  2208. tor_assert(res <= max_val);
  2209. return res;
  2210. }
  2211. /** Return the value of a integer parameter from the networkstatus <b>ns</b>
  2212. * whose name is <b>param_name</b>. If <b>ns</b> is NULL, try loading the
  2213. * latest consensus ourselves. Return <b>default_val</b> if no latest
  2214. * consensus, or if it has no parameter called <b>param_name</b>.
  2215. * Make sure the value parsed from the consensus is at least
  2216. * <b>min_val</b> and at most <b>max_val</b> and raise/cap the parsed value
  2217. * if necessary. */
  2218. MOCK_IMPL(int32_t,
  2219. networkstatus_get_param, (const networkstatus_t *ns, const char *param_name,
  2220. int32_t default_val, int32_t min_val, int32_t max_val))
  2221. {
  2222. if (!ns) /* if they pass in null, go find it ourselves */
  2223. ns = networkstatus_get_latest_consensus();
  2224. if (!ns || !ns->net_params)
  2225. return default_val;
  2226. return get_net_param_from_list(ns->net_params, param_name,
  2227. default_val, min_val, max_val);
  2228. }
  2229. /**
  2230. * As networkstatus_get_param(), but check torrc_value before checking the
  2231. * consensus. If torrc_value is in-range, then return it instead of the
  2232. * value from the consensus.
  2233. */
  2234. int32_t
  2235. networkstatus_get_overridable_param(const networkstatus_t *ns,
  2236. int32_t torrc_value,
  2237. const char *param_name,
  2238. int32_t default_val,
  2239. int32_t min_val, int32_t max_val)
  2240. {
  2241. if (torrc_value >= min_val && torrc_value <= max_val)
  2242. return torrc_value;
  2243. else
  2244. return networkstatus_get_param(
  2245. ns, param_name, default_val, min_val, max_val);
  2246. }
  2247. /**
  2248. * Retrieve the consensus parameter that governs the
  2249. * fixed-point precision of our network balancing 'bandwidth-weights'
  2250. * (which are themselves integer consensus values). We divide them
  2251. * by this value and ensure they never exceed this value.
  2252. */
  2253. int
  2254. networkstatus_get_weight_scale_param(networkstatus_t *ns)
  2255. {
  2256. return networkstatus_get_param(ns, "bwweightscale",
  2257. BW_WEIGHT_SCALE,
  2258. BW_MIN_WEIGHT_SCALE,
  2259. BW_MAX_WEIGHT_SCALE);
  2260. }
  2261. /** Return the value of a integer bw weight parameter from the networkstatus
  2262. * <b>ns</b> whose name is <b>weight_name</b>. If <b>ns</b> is NULL, try
  2263. * loading the latest consensus ourselves. Return <b>default_val</b> if no
  2264. * latest consensus, or if it has no parameter called <b>weight_name</b>. */
  2265. int32_t
  2266. networkstatus_get_bw_weight(networkstatus_t *ns, const char *weight_name,
  2267. int32_t default_val)
  2268. {
  2269. int32_t param;
  2270. int max;
  2271. if (!ns) /* if they pass in null, go find it ourselves */
  2272. ns = networkstatus_get_latest_consensus();
  2273. if (!ns || !ns->weight_params)
  2274. return default_val;
  2275. max = networkstatus_get_weight_scale_param(ns);
  2276. param = get_net_param_from_list(ns->weight_params, weight_name,
  2277. default_val, -1,
  2278. BW_MAX_WEIGHT_SCALE);
  2279. if (param > max) {
  2280. log_warn(LD_DIR, "Value of consensus weight %s was too large, capping "
  2281. "to %d", weight_name, max);
  2282. param = max;
  2283. }
  2284. return param;
  2285. }
  2286. /** Return the name of the consensus flavor <b>flav</b> as used to identify
  2287. * the flavor in directory documents. */
  2288. const char *
  2289. networkstatus_get_flavor_name(consensus_flavor_t flav)
  2290. {
  2291. switch (flav) {
  2292. case FLAV_NS:
  2293. return "ns";
  2294. case FLAV_MICRODESC:
  2295. return "microdesc";
  2296. default:
  2297. tor_fragile_assert();
  2298. return "??";
  2299. }
  2300. }
  2301. /** Return the consensus_flavor_t value for the flavor called <b>flavname</b>,
  2302. * or -1 if the flavor is not recognized. */
  2303. int
  2304. networkstatus_parse_flavor_name(const char *flavname)
  2305. {
  2306. if (!strcmp(flavname, "ns"))
  2307. return FLAV_NS;
  2308. else if (!strcmp(flavname, "microdesc"))
  2309. return FLAV_MICRODESC;
  2310. else
  2311. return -1;
  2312. }
  2313. /** Return 0 if this routerstatus is obsolete, too new, isn't
  2314. * running, or otherwise not a descriptor that we would make any
  2315. * use of even if we had it. Else return 1. */
  2316. int
  2317. client_would_use_router(const routerstatus_t *rs, time_t now)
  2318. {
  2319. if (!rs->is_flagged_running) {
  2320. /* If we had this router descriptor, we wouldn't even bother using it.
  2321. * (Fetching and storing depends on by we_want_to_fetch_flavor().) */
  2322. return 0;
  2323. }
  2324. if (rs->published_on + OLD_ROUTER_DESC_MAX_AGE < now) {
  2325. /* We'd drop it immediately for being too old. */
  2326. return 0;
  2327. }
  2328. if (!routerstatus_version_supports_extend2_cells(rs, 1)) {
  2329. /* We'd ignore it because it doesn't support EXTEND2 cells.
  2330. * If we don't know the version, download the descriptor so we can
  2331. * check if it supports EXTEND2 cells and ntor. */
  2332. return 0;
  2333. }
  2334. return 1;
  2335. }
  2336. /** If <b>question</b> is a string beginning with "ns/" in a format the
  2337. * control interface expects for a GETINFO question, set *<b>answer</b> to a
  2338. * newly-allocated string containing networkstatus lines for the appropriate
  2339. * ORs. Return 0 on success, -1 on unrecognized question format. */
  2340. int
  2341. getinfo_helper_networkstatus(control_connection_t *conn,
  2342. const char *question, char **answer,
  2343. const char **errmsg)
  2344. {
  2345. const routerstatus_t *status;
  2346. (void) conn;
  2347. if (!networkstatus_get_latest_consensus()) {
  2348. *answer = tor_strdup("");
  2349. return 0;
  2350. }
  2351. if (!strcmp(question, "ns/all")) {
  2352. smartlist_t *statuses = smartlist_new();
  2353. SMARTLIST_FOREACH(networkstatus_get_latest_consensus()->routerstatus_list,
  2354. const routerstatus_t *, rs,
  2355. {
  2356. smartlist_add(statuses, networkstatus_getinfo_helper_single(rs));
  2357. });
  2358. *answer = smartlist_join_strings(statuses, "", 0, NULL);
  2359. SMARTLIST_FOREACH(statuses, char *, cp, tor_free(cp));
  2360. smartlist_free(statuses);
  2361. return 0;
  2362. } else if (!strcmpstart(question, "ns/id/")) {
  2363. char d[DIGEST_LEN];
  2364. const char *q = question + 6;
  2365. if (*q == '$')
  2366. ++q;
  2367. if (base16_decode(d, DIGEST_LEN, q, strlen(q)) != DIGEST_LEN) {
  2368. *errmsg = "Data not decodeable as hex";
  2369. return -1;
  2370. }
  2371. status = router_get_consensus_status_by_id(d);
  2372. } else if (!strcmpstart(question, "ns/name/")) {
  2373. const node_t *n = node_get_by_nickname(question+8, 0);
  2374. status = n ? n->rs : NULL;
  2375. } else if (!strcmpstart(question, "ns/purpose/")) {
  2376. *answer = networkstatus_getinfo_by_purpose(question+11, time(NULL));
  2377. return *answer ? 0 : -1;
  2378. } else if (!strcmp(question, "consensus/packages")) {
  2379. const networkstatus_t *ns = networkstatus_get_latest_consensus();
  2380. if (ns && ns->package_lines)
  2381. *answer = smartlist_join_strings(ns->package_lines, "\n", 0, NULL);
  2382. else
  2383. *errmsg = "No consensus available";
  2384. return *answer ? 0 : -1;
  2385. } else if (!strcmp(question, "consensus/valid-after") ||
  2386. !strcmp(question, "consensus/fresh-until") ||
  2387. !strcmp(question, "consensus/valid-until")) {
  2388. const networkstatus_t *ns = networkstatus_get_latest_consensus();
  2389. if (ns) {
  2390. time_t t;
  2391. if (!strcmp(question, "consensus/valid-after"))
  2392. t = ns->valid_after;
  2393. else if (!strcmp(question, "consensus/fresh-until"))
  2394. t = ns->fresh_until;
  2395. else
  2396. t = ns->valid_until;
  2397. char tbuf[ISO_TIME_LEN+1];
  2398. format_iso_time(tbuf, t);
  2399. *answer = tor_strdup(tbuf);
  2400. } else {
  2401. *errmsg = "No consensus available";
  2402. }
  2403. return *answer ? 0 : -1;
  2404. } else {
  2405. return 0;
  2406. }
  2407. if (status)
  2408. *answer = networkstatus_getinfo_helper_single(status);
  2409. return 0;
  2410. }
  2411. /** Check whether the networkstatus <b>ns</b> lists any protocol
  2412. * versions as "required" or "recommended" that we do not support. If
  2413. * so, set *<b>warning_out</b> to a newly allocated string describing
  2414. * the problem.
  2415. *
  2416. * Return 1 if we should exit, 0 if we should not. */
  2417. int
  2418. networkstatus_check_required_protocols(const networkstatus_t *ns,
  2419. int client_mode,
  2420. char **warning_out)
  2421. {
  2422. const char *func = client_mode ? "client" : "relay";
  2423. const char *required, *recommended;
  2424. char *missing = NULL;
  2425. tor_assert(warning_out);
  2426. if (client_mode) {
  2427. required = ns->required_client_protocols;
  2428. recommended = ns->recommended_client_protocols;
  2429. } else {
  2430. required = ns->required_relay_protocols;
  2431. recommended = ns->recommended_relay_protocols;
  2432. }
  2433. if (!protover_all_supported(required, &missing)) {
  2434. tor_asprintf(warning_out, "At least one protocol listed as required in "
  2435. "the consensus is not supported by this version of Tor. "
  2436. "You should upgrade. This version of Tor will not work as a "
  2437. "%s on the Tor network. The missing protocols are: %s",
  2438. func, missing);
  2439. tor_free(missing);
  2440. return 1;
  2441. }
  2442. if (! protover_all_supported(recommended, &missing)) {
  2443. tor_asprintf(warning_out, "At least one protocol listed as recommended in "
  2444. "the consensus is not supported by this version of Tor. "
  2445. "You should upgrade. This version of Tor will eventually "
  2446. "stop working as a %s on the Tor network. The missing "
  2447. "protocols are: %s",
  2448. func, missing);
  2449. tor_free(missing);
  2450. }
  2451. tor_assert_nonfatal(missing == NULL);
  2452. return 0;
  2453. }
  2454. /** Free all storage held locally in this module. */
  2455. void
  2456. networkstatus_free_all(void)
  2457. {
  2458. int i;
  2459. networkstatus_vote_free(current_ns_consensus);
  2460. networkstatus_vote_free(current_md_consensus);
  2461. current_md_consensus = current_ns_consensus = NULL;
  2462. for (i=0; i < N_CONSENSUS_FLAVORS; ++i) {
  2463. consensus_waiting_for_certs_t *waiting = &consensus_waiting_for_certs[i];
  2464. if (waiting->consensus) {
  2465. networkstatus_vote_free(waiting->consensus);
  2466. waiting->consensus = NULL;
  2467. }
  2468. }
  2469. }