networkstatus.c 98 KB

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