routerlist.c 200 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773
  1. /* Copyright (c) 2001 Matej Pfajfar.
  2. * Copyright (c) 2001-2004, Roger Dingledine.
  3. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4. * Copyright (c) 2007-2016, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file routerlist.c
  8. * \brief Code to
  9. * maintain and access the global list of routerinfos for known
  10. * servers.
  11. *
  12. * A "routerinfo_t" object represents a single self-signed router
  13. * descriptor, as generated by a Tor relay in order to tell the rest of
  14. * the world about its keys, address, and capabilities. An
  15. * "extrainfo_t" object represents an adjunct "extra-info" object,
  16. * certified by a corresponding router descriptor, reporting more
  17. * information about the relay that nearly all users will not need.
  18. *
  19. * Most users will not use router descriptors for most relays. Instead,
  20. * they use the information in microdescriptors and in the consensus
  21. * networkstatus.
  22. *
  23. * Right now, routerinfo_t objects are used in these ways:
  24. * <ul>
  25. * <li>By clients, in order to learn about bridge keys and capabilities.
  26. * (Bridges aren't listed in the consensus networkstatus, so they
  27. * can't have microdescriptors.)
  28. * <li>By relays, since relays want more information about other relays
  29. * than they can learn from microdescriptors. (TODO: Is this still true?)
  30. * <li>By authorities, which receive them and use them to generate the
  31. * consensus and the microdescriptors.
  32. * <li>By all directory caches, which download them in case somebody
  33. * else wants them.
  34. * </ul>
  35. *
  36. * Routerinfos are mostly created by parsing them from a string, in
  37. * routerparse.c. We store them to disk on receiving them, and
  38. * periodically discard the ones we don't need. On restarting, we
  39. * re-read them from disk. (This also applies to extrainfo documents, if
  40. * we are configured to fetch them.)
  41. *
  42. * In order to keep our list of routerinfos up-to-date, we periodically
  43. * check whether there are any listed in the latest consensus (or in the
  44. * votes from other authorities, if we are an authority) that we don't
  45. * have. (This also applies to extrainfo documents, if we are
  46. * configured to fetch them.)
  47. *
  48. * Almost nothing in Tor should use a routerinfo_t to refer directly to
  49. * a relay; instead, almost everything should use node_t (implemented in
  50. * nodelist.c), which provides a common interface to routerinfo_t,
  51. * routerstatus_t, and microdescriptor_t.
  52. *
  53. * <br>
  54. *
  55. * This module also has some of the functions used for choosing random
  56. * nodes according to different rules and weights. Historically, they
  57. * were all in this module. Now, they are spread across this module,
  58. * nodelist.c, and networkstatus.c. (TODO: Fix that.)
  59. *
  60. * <br>
  61. *
  62. * (For historical reasons) this module also contains code for handling
  63. * the list of fallback directories, the list of directory authorities,
  64. * and the list of authority certificates.
  65. *
  66. * For the directory authorities, we have a list containing the public
  67. * identity key, and contact points, for each authority. The
  68. * authorities receive descriptors from relays, and publish consensuses,
  69. * descriptors, and microdescriptors. This list is pre-configured.
  70. *
  71. * Fallback directories are well-known, stable, but untrusted directory
  72. * caches that clients which have not yet bootstrapped can use to get
  73. * their first networkstatus consensus, in order to find out where the
  74. * Tor network really is. This list is pre-configured in
  75. * fallback_dirs.inc. Every authority also serves as a fallback.
  76. *
  77. * Both fallback directories and directory authorities are are
  78. * represented by a dir_server_t.
  79. *
  80. * Authority certificates are signed with authority identity keys; they
  81. * are used to authenticate shorter-term authority signing keys. We
  82. * fetch them when we find a consensus or a vote that has been signed
  83. * with a signing key we don't recognize. We cache them on disk and
  84. * load them on startup. Authority operators generate them with the
  85. * "tor-gencert" utility.
  86. *
  87. * TODO: Authority certificates should be a separate module.
  88. *
  89. * TODO: dir_server_t stuff should be in a separate module.
  90. **/
  91. #define ROUTERLIST_PRIVATE
  92. #include "or.h"
  93. #include "backtrace.h"
  94. #include "bridges.h"
  95. #include "crypto_ed25519.h"
  96. #include "circuitstats.h"
  97. #include "config.h"
  98. #include "connection.h"
  99. #include "control.h"
  100. #include "directory.h"
  101. #include "dirserv.h"
  102. #include "dirvote.h"
  103. #include "entrynodes.h"
  104. #include "fp_pair.h"
  105. #include "geoip.h"
  106. #include "hibernate.h"
  107. #include "main.h"
  108. #include "microdesc.h"
  109. #include "networkstatus.h"
  110. #include "nodelist.h"
  111. #include "policies.h"
  112. #include "reasons.h"
  113. #include "rendcommon.h"
  114. #include "rendservice.h"
  115. #include "rephist.h"
  116. #include "router.h"
  117. #include "routerlist.h"
  118. #include "routerparse.h"
  119. #include "routerset.h"
  120. #include "sandbox.h"
  121. #include "torcert.h"
  122. // #define DEBUG_ROUTERLIST
  123. /****************************************************************************/
  124. /* Typed wrappers for different digestmap types; used to avoid type
  125. * confusion. */
  126. DECLARE_TYPED_DIGESTMAP_FNS(sdmap_, digest_sd_map_t, signed_descriptor_t)
  127. DECLARE_TYPED_DIGESTMAP_FNS(rimap_, digest_ri_map_t, routerinfo_t)
  128. DECLARE_TYPED_DIGESTMAP_FNS(eimap_, digest_ei_map_t, extrainfo_t)
  129. DECLARE_TYPED_DIGESTMAP_FNS(dsmap_, digest_ds_map_t, download_status_t)
  130. #define SDMAP_FOREACH(map, keyvar, valvar) \
  131. DIGESTMAP_FOREACH(sdmap_to_digestmap(map), keyvar, signed_descriptor_t *, \
  132. valvar)
  133. #define RIMAP_FOREACH(map, keyvar, valvar) \
  134. DIGESTMAP_FOREACH(rimap_to_digestmap(map), keyvar, routerinfo_t *, valvar)
  135. #define EIMAP_FOREACH(map, keyvar, valvar) \
  136. DIGESTMAP_FOREACH(eimap_to_digestmap(map), keyvar, extrainfo_t *, valvar)
  137. #define DSMAP_FOREACH(map, keyvar, valvar) \
  138. DIGESTMAP_FOREACH(dsmap_to_digestmap(map), keyvar, download_status_t *, \
  139. valvar)
  140. /* Forward declaration for cert_list_t */
  141. typedef struct cert_list_t cert_list_t;
  142. /* static function prototypes */
  143. static int compute_weighted_bandwidths(const smartlist_t *sl,
  144. bandwidth_weight_rule_t rule,
  145. double **bandwidths_out);
  146. static const routerstatus_t *router_pick_trusteddirserver_impl(
  147. const smartlist_t *sourcelist, dirinfo_type_t auth,
  148. int flags, int *n_busy_out);
  149. static const routerstatus_t *router_pick_dirserver_generic(
  150. smartlist_t *sourcelist,
  151. dirinfo_type_t type, int flags);
  152. static void mark_all_dirservers_up(smartlist_t *server_list);
  153. static void dir_server_free(dir_server_t *ds);
  154. static int signed_desc_digest_is_recognized(signed_descriptor_t *desc);
  155. static const char *signed_descriptor_get_body_impl(
  156. const signed_descriptor_t *desc,
  157. int with_annotations);
  158. static void list_pending_downloads(digestmap_t *result,
  159. digest256map_t *result256,
  160. int purpose, const char *prefix);
  161. static void list_pending_fpsk_downloads(fp_pair_map_t *result);
  162. static void launch_dummy_descriptor_download_as_needed(time_t now,
  163. const or_options_t *options);
  164. static void download_status_reset_by_sk_in_cl(cert_list_t *cl,
  165. const char *digest);
  166. static int download_status_is_ready_by_sk_in_cl(cert_list_t *cl,
  167. const char *digest,
  168. time_t now, int max_failures);
  169. /****************************************************************************/
  170. /** Global list of a dir_server_t object for each directory
  171. * authority. */
  172. static smartlist_t *trusted_dir_servers = NULL;
  173. /** Global list of dir_server_t objects for all directory authorities
  174. * and all fallback directory servers. */
  175. static smartlist_t *fallback_dir_servers = NULL;
  176. /** List of certificates for a single authority, and download status for
  177. * latest certificate.
  178. */
  179. struct cert_list_t {
  180. /*
  181. * The keys of download status map are cert->signing_key_digest for pending
  182. * downloads by (identity digest/signing key digest) pair; functions such
  183. * as authority_cert_get_by_digest() already assume these are unique.
  184. */
  185. struct digest_ds_map_t *dl_status_map;
  186. /* There is also a dlstatus for the download by identity key only */
  187. download_status_t dl_status_by_id;
  188. smartlist_t *certs;
  189. };
  190. /** Map from v3 identity key digest to cert_list_t. */
  191. static digestmap_t *trusted_dir_certs = NULL;
  192. /** True iff any key certificate in at least one member of
  193. * <b>trusted_dir_certs</b> has changed since we last flushed the
  194. * certificates to disk. */
  195. static int trusted_dir_servers_certs_changed = 0;
  196. /** Global list of all of the routers that we know about. */
  197. static routerlist_t *routerlist = NULL;
  198. /** List of strings for nicknames we've already warned about and that are
  199. * still unknown / unavailable. */
  200. static smartlist_t *warned_nicknames = NULL;
  201. /** The last time we tried to download any routerdesc, or 0 for "never". We
  202. * use this to rate-limit download attempts when the number of routerdescs to
  203. * download is low. */
  204. static time_t last_descriptor_download_attempted = 0;
  205. /** Return the number of directory authorities whose type matches some bit set
  206. * in <b>type</b> */
  207. int
  208. get_n_authorities(dirinfo_type_t type)
  209. {
  210. int n = 0;
  211. if (!trusted_dir_servers)
  212. return 0;
  213. SMARTLIST_FOREACH(trusted_dir_servers, dir_server_t *, ds,
  214. if (ds->type & type)
  215. ++n);
  216. return n;
  217. }
  218. /** Initialise schedule, want_authority, and increment on in the download
  219. * status dlstatus, then call download_status_reset() on it.
  220. * It is safe to call this function or download_status_reset() multiple times
  221. * on a new dlstatus. But it should *not* be called after a dlstatus has been
  222. * used to count download attempts or failures. */
  223. static void
  224. download_status_cert_init(download_status_t *dlstatus)
  225. {
  226. dlstatus->schedule = DL_SCHED_CONSENSUS;
  227. dlstatus->want_authority = DL_WANT_ANY_DIRSERVER;
  228. dlstatus->increment_on = DL_SCHED_INCREMENT_FAILURE;
  229. dlstatus->backoff = DL_SCHED_RANDOM_EXPONENTIAL;
  230. dlstatus->last_backoff_position = 0;
  231. dlstatus->last_delay_used = 0;
  232. /* Use the new schedule to set next_attempt_at */
  233. download_status_reset(dlstatus);
  234. }
  235. /** Reset the download status of a specified element in a dsmap */
  236. static void
  237. download_status_reset_by_sk_in_cl(cert_list_t *cl, const char *digest)
  238. {
  239. download_status_t *dlstatus = NULL;
  240. tor_assert(cl);
  241. tor_assert(digest);
  242. /* Make sure we have a dsmap */
  243. if (!(cl->dl_status_map)) {
  244. cl->dl_status_map = dsmap_new();
  245. }
  246. /* Look for a download_status_t in the map with this digest */
  247. dlstatus = dsmap_get(cl->dl_status_map, digest);
  248. /* Got one? */
  249. if (!dlstatus) {
  250. /* Insert before we reset */
  251. dlstatus = tor_malloc_zero(sizeof(*dlstatus));
  252. dsmap_set(cl->dl_status_map, digest, dlstatus);
  253. download_status_cert_init(dlstatus);
  254. }
  255. tor_assert(dlstatus);
  256. /* Go ahead and reset it */
  257. download_status_reset(dlstatus);
  258. }
  259. /**
  260. * Return true if the download for this signing key digest in cl is ready
  261. * to be re-attempted.
  262. */
  263. static int
  264. download_status_is_ready_by_sk_in_cl(cert_list_t *cl,
  265. const char *digest,
  266. time_t now, int max_failures)
  267. {
  268. int rv = 0;
  269. download_status_t *dlstatus = NULL;
  270. tor_assert(cl);
  271. tor_assert(digest);
  272. /* Make sure we have a dsmap */
  273. if (!(cl->dl_status_map)) {
  274. cl->dl_status_map = dsmap_new();
  275. }
  276. /* Look for a download_status_t in the map with this digest */
  277. dlstatus = dsmap_get(cl->dl_status_map, digest);
  278. /* Got one? */
  279. if (dlstatus) {
  280. /* Use download_status_is_ready() */
  281. rv = download_status_is_ready(dlstatus, now, max_failures);
  282. } else {
  283. /*
  284. * If we don't know anything about it, return 1, since we haven't
  285. * tried this one before. We need to create a new entry here,
  286. * too.
  287. */
  288. dlstatus = tor_malloc_zero(sizeof(*dlstatus));
  289. download_status_cert_init(dlstatus);
  290. dsmap_set(cl->dl_status_map, digest, dlstatus);
  291. rv = 1;
  292. }
  293. return rv;
  294. }
  295. /** Helper: Return the cert_list_t for an authority whose authority ID is
  296. * <b>id_digest</b>, allocating a new list if necessary. */
  297. static cert_list_t *
  298. get_cert_list(const char *id_digest)
  299. {
  300. cert_list_t *cl;
  301. if (!trusted_dir_certs)
  302. trusted_dir_certs = digestmap_new();
  303. cl = digestmap_get(trusted_dir_certs, id_digest);
  304. if (!cl) {
  305. cl = tor_malloc_zero(sizeof(cert_list_t));
  306. download_status_cert_init(&cl->dl_status_by_id);
  307. cl->certs = smartlist_new();
  308. cl->dl_status_map = dsmap_new();
  309. digestmap_set(trusted_dir_certs, id_digest, cl);
  310. }
  311. return cl;
  312. }
  313. /** Return a list of authority ID digests with potentially enumerable lists
  314. * of download_status_t objects; used by controller GETINFO queries.
  315. */
  316. MOCK_IMPL(smartlist_t *,
  317. list_authority_ids_with_downloads, (void))
  318. {
  319. smartlist_t *ids = smartlist_new();
  320. digestmap_iter_t *i;
  321. const char *digest;
  322. char *tmp;
  323. void *cl;
  324. if (trusted_dir_certs) {
  325. for (i = digestmap_iter_init(trusted_dir_certs);
  326. !(digestmap_iter_done(i));
  327. i = digestmap_iter_next(trusted_dir_certs, i)) {
  328. /*
  329. * We always have at least dl_status_by_id to query, so no need to
  330. * probe deeper than the existence of a cert_list_t.
  331. */
  332. digestmap_iter_get(i, &digest, &cl);
  333. tmp = tor_malloc(DIGEST_LEN);
  334. memcpy(tmp, digest, DIGEST_LEN);
  335. smartlist_add(ids, tmp);
  336. }
  337. }
  338. /* else definitely no downlaods going since nothing even has a cert list */
  339. return ids;
  340. }
  341. /** Given an authority ID digest, return a pointer to the default download
  342. * status, or NULL if there is no such entry in trusted_dir_certs */
  343. MOCK_IMPL(download_status_t *,
  344. id_only_download_status_for_authority_id, (const char *digest))
  345. {
  346. download_status_t *dl = NULL;
  347. cert_list_t *cl;
  348. if (trusted_dir_certs) {
  349. cl = digestmap_get(trusted_dir_certs, digest);
  350. if (cl) {
  351. dl = &(cl->dl_status_by_id);
  352. }
  353. }
  354. return dl;
  355. }
  356. /** Given an authority ID digest, return a smartlist of signing key digests
  357. * for which download_status_t is potentially queryable, or NULL if no such
  358. * authority ID digest is known. */
  359. MOCK_IMPL(smartlist_t *,
  360. list_sk_digests_for_authority_id, (const char *digest))
  361. {
  362. smartlist_t *sks = NULL;
  363. cert_list_t *cl;
  364. dsmap_iter_t *i;
  365. const char *sk_digest;
  366. char *tmp;
  367. download_status_t *dl;
  368. if (trusted_dir_certs) {
  369. cl = digestmap_get(trusted_dir_certs, digest);
  370. if (cl) {
  371. sks = smartlist_new();
  372. if (cl->dl_status_map) {
  373. for (i = dsmap_iter_init(cl->dl_status_map);
  374. !(dsmap_iter_done(i));
  375. i = dsmap_iter_next(cl->dl_status_map, i)) {
  376. /* Pull the digest out and add it to the list */
  377. dsmap_iter_get(i, &sk_digest, &dl);
  378. tmp = tor_malloc(DIGEST_LEN);
  379. memcpy(tmp, sk_digest, DIGEST_LEN);
  380. smartlist_add(sks, tmp);
  381. }
  382. }
  383. }
  384. }
  385. return sks;
  386. }
  387. /** Given an authority ID digest and a signing key digest, return the
  388. * download_status_t or NULL if none exists. */
  389. MOCK_IMPL(download_status_t *,
  390. download_status_for_authority_id_and_sk,
  391. (const char *id_digest, const char *sk_digest))
  392. {
  393. download_status_t *dl = NULL;
  394. cert_list_t *cl = NULL;
  395. if (trusted_dir_certs) {
  396. cl = digestmap_get(trusted_dir_certs, id_digest);
  397. if (cl && cl->dl_status_map) {
  398. dl = dsmap_get(cl->dl_status_map, sk_digest);
  399. }
  400. }
  401. return dl;
  402. }
  403. /** Release all space held by a cert_list_t */
  404. static void
  405. cert_list_free(cert_list_t *cl)
  406. {
  407. if (!cl)
  408. return;
  409. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, cert,
  410. authority_cert_free(cert));
  411. smartlist_free(cl->certs);
  412. dsmap_free(cl->dl_status_map, tor_free_);
  413. tor_free(cl);
  414. }
  415. /** Wrapper for cert_list_free so we can pass it to digestmap_free */
  416. static void
  417. cert_list_free_(void *cl)
  418. {
  419. cert_list_free(cl);
  420. }
  421. /** Reload the cached v3 key certificates from the cached-certs file in
  422. * the data directory. Return 0 on success, -1 on failure. */
  423. int
  424. trusted_dirs_reload_certs(void)
  425. {
  426. char *filename;
  427. char *contents;
  428. int r;
  429. filename = get_datadir_fname("cached-certs");
  430. contents = read_file_to_str(filename, RFTS_IGNORE_MISSING, NULL);
  431. tor_free(filename);
  432. if (!contents)
  433. return 0;
  434. r = trusted_dirs_load_certs_from_string(
  435. contents,
  436. TRUSTED_DIRS_CERTS_SRC_FROM_STORE, 1, NULL);
  437. tor_free(contents);
  438. return r;
  439. }
  440. /** Helper: return true iff we already have loaded the exact cert
  441. * <b>cert</b>. */
  442. static inline int
  443. already_have_cert(authority_cert_t *cert)
  444. {
  445. cert_list_t *cl = get_cert_list(cert->cache_info.identity_digest);
  446. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, c,
  447. {
  448. if (tor_memeq(c->cache_info.signed_descriptor_digest,
  449. cert->cache_info.signed_descriptor_digest,
  450. DIGEST_LEN))
  451. return 1;
  452. });
  453. return 0;
  454. }
  455. /** Load a bunch of new key certificates from the string <b>contents</b>. If
  456. * <b>source</b> is TRUSTED_DIRS_CERTS_SRC_FROM_STORE, the certificates are
  457. * from the cache, and we don't need to flush them to disk. If we are a
  458. * dirauth loading our own cert, source is TRUSTED_DIRS_CERTS_SRC_SELF.
  459. * Otherwise, source is download type: TRUSTED_DIRS_CERTS_SRC_DL_BY_ID_DIGEST
  460. * or TRUSTED_DIRS_CERTS_SRC_DL_BY_ID_SK_DIGEST. If <b>flush</b> is true, we
  461. * need to flush any changed certificates to disk now. Return 0 on success,
  462. * -1 if any certs fail to parse.
  463. *
  464. * If source_dir is non-NULL, it's the identity digest for a directory that
  465. * we've just successfully retrieved certificates from, so try it first to
  466. * fetch any missing certificates.
  467. */
  468. int
  469. trusted_dirs_load_certs_from_string(const char *contents, int source,
  470. int flush, const char *source_dir)
  471. {
  472. dir_server_t *ds;
  473. const char *s, *eos;
  474. int failure_code = 0;
  475. int from_store = (source == TRUSTED_DIRS_CERTS_SRC_FROM_STORE);
  476. int added_trusted_cert = 0;
  477. for (s = contents; *s; s = eos) {
  478. authority_cert_t *cert = authority_cert_parse_from_string(s, &eos);
  479. cert_list_t *cl;
  480. if (!cert) {
  481. failure_code = -1;
  482. break;
  483. }
  484. ds = trusteddirserver_get_by_v3_auth_digest(
  485. cert->cache_info.identity_digest);
  486. log_debug(LD_DIR, "Parsed certificate for %s",
  487. ds ? ds->nickname : "unknown authority");
  488. if (already_have_cert(cert)) {
  489. /* we already have this one. continue. */
  490. log_info(LD_DIR, "Skipping %s certificate for %s that we "
  491. "already have.",
  492. from_store ? "cached" : "downloaded",
  493. ds ? ds->nickname : "an old or new authority");
  494. /*
  495. * A duplicate on download should be treated as a failure, so we call
  496. * authority_cert_dl_failed() to reset the download status to make sure
  497. * we can't try again. Since we've implemented the fp-sk mechanism
  498. * to download certs by signing key, this should be much rarer than it
  499. * was and is perhaps cause for concern.
  500. */
  501. if (!from_store) {
  502. if (authdir_mode(get_options())) {
  503. log_warn(LD_DIR,
  504. "Got a certificate for %s, but we already have it. "
  505. "Maybe they haven't updated it. Waiting for a while.",
  506. ds ? ds->nickname : "an old or new authority");
  507. } else {
  508. log_info(LD_DIR,
  509. "Got a certificate for %s, but we already have it. "
  510. "Maybe they haven't updated it. Waiting for a while.",
  511. ds ? ds->nickname : "an old or new authority");
  512. }
  513. /*
  514. * This is where we care about the source; authority_cert_dl_failed()
  515. * needs to know whether the download was by fp or (fp,sk) pair to
  516. * twiddle the right bit in the download map.
  517. */
  518. if (source == TRUSTED_DIRS_CERTS_SRC_DL_BY_ID_DIGEST) {
  519. authority_cert_dl_failed(cert->cache_info.identity_digest,
  520. NULL, 404);
  521. } else if (source == TRUSTED_DIRS_CERTS_SRC_DL_BY_ID_SK_DIGEST) {
  522. authority_cert_dl_failed(cert->cache_info.identity_digest,
  523. cert->signing_key_digest, 404);
  524. }
  525. }
  526. authority_cert_free(cert);
  527. continue;
  528. }
  529. if (ds) {
  530. added_trusted_cert = 1;
  531. log_info(LD_DIR, "Adding %s certificate for directory authority %s with "
  532. "signing key %s", from_store ? "cached" : "downloaded",
  533. ds->nickname, hex_str(cert->signing_key_digest,DIGEST_LEN));
  534. } else {
  535. int adding = we_want_to_fetch_unknown_auth_certs(get_options());
  536. log_info(LD_DIR, "%s %s certificate for unrecognized directory "
  537. "authority with signing key %s",
  538. adding ? "Adding" : "Not adding",
  539. from_store ? "cached" : "downloaded",
  540. hex_str(cert->signing_key_digest,DIGEST_LEN));
  541. if (!adding) {
  542. authority_cert_free(cert);
  543. continue;
  544. }
  545. }
  546. cl = get_cert_list(cert->cache_info.identity_digest);
  547. smartlist_add(cl->certs, cert);
  548. if (ds && cert->cache_info.published_on > ds->addr_current_at) {
  549. /* Check to see whether we should update our view of the authority's
  550. * address. */
  551. if (cert->addr && cert->dir_port &&
  552. (ds->addr != cert->addr ||
  553. ds->dir_port != cert->dir_port)) {
  554. char *a = tor_dup_ip(cert->addr);
  555. log_notice(LD_DIR, "Updating address for directory authority %s "
  556. "from %s:%d to %s:%d based on certificate.",
  557. ds->nickname, ds->address, (int)ds->dir_port,
  558. a, cert->dir_port);
  559. tor_free(a);
  560. ds->addr = cert->addr;
  561. ds->dir_port = cert->dir_port;
  562. }
  563. ds->addr_current_at = cert->cache_info.published_on;
  564. }
  565. if (!from_store)
  566. trusted_dir_servers_certs_changed = 1;
  567. }
  568. if (flush)
  569. trusted_dirs_flush_certs_to_disk();
  570. /* call this even if failure_code is <0, since some certs might have
  571. * succeeded, but only pass source_dir if there were no failures,
  572. * and at least one more authority certificate was added to the store.
  573. * This avoids retrying a directory that's serving bad or entirely duplicate
  574. * certificates. */
  575. if (failure_code == 0 && added_trusted_cert) {
  576. networkstatus_note_certs_arrived(source_dir);
  577. } else {
  578. networkstatus_note_certs_arrived(NULL);
  579. }
  580. return failure_code;
  581. }
  582. /** Save all v3 key certificates to the cached-certs file. */
  583. void
  584. trusted_dirs_flush_certs_to_disk(void)
  585. {
  586. char *filename;
  587. smartlist_t *chunks;
  588. if (!trusted_dir_servers_certs_changed || !trusted_dir_certs)
  589. return;
  590. chunks = smartlist_new();
  591. DIGESTMAP_FOREACH(trusted_dir_certs, key, cert_list_t *, cl) {
  592. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, cert,
  593. {
  594. sized_chunk_t *c = tor_malloc(sizeof(sized_chunk_t));
  595. c->bytes = cert->cache_info.signed_descriptor_body;
  596. c->len = cert->cache_info.signed_descriptor_len;
  597. smartlist_add(chunks, c);
  598. });
  599. } DIGESTMAP_FOREACH_END;
  600. filename = get_datadir_fname("cached-certs");
  601. if (write_chunks_to_file(filename, chunks, 0, 0)) {
  602. log_warn(LD_FS, "Error writing certificates to disk.");
  603. }
  604. tor_free(filename);
  605. SMARTLIST_FOREACH(chunks, sized_chunk_t *, c, tor_free(c));
  606. smartlist_free(chunks);
  607. trusted_dir_servers_certs_changed = 0;
  608. }
  609. static int
  610. compare_certs_by_pubdates(const void **_a, const void **_b)
  611. {
  612. const authority_cert_t *cert1 = *_a, *cert2=*_b;
  613. if (cert1->cache_info.published_on < cert2->cache_info.published_on)
  614. return -1;
  615. else if (cert1->cache_info.published_on > cert2->cache_info.published_on)
  616. return 1;
  617. else
  618. return 0;
  619. }
  620. /** Remove all expired v3 authority certificates that have been superseded for
  621. * more than 48 hours or, if not expired, that were published more than 7 days
  622. * before being superseded. (If the most recent cert was published more than 48
  623. * hours ago, then we aren't going to get any consensuses signed with older
  624. * keys.) */
  625. static void
  626. trusted_dirs_remove_old_certs(void)
  627. {
  628. time_t now = time(NULL);
  629. #define DEAD_CERT_LIFETIME (2*24*60*60)
  630. #define SUPERSEDED_CERT_LIFETIME (2*24*60*60)
  631. if (!trusted_dir_certs)
  632. return;
  633. DIGESTMAP_FOREACH(trusted_dir_certs, key, cert_list_t *, cl) {
  634. /* Sort the list from first-published to last-published */
  635. smartlist_sort(cl->certs, compare_certs_by_pubdates);
  636. SMARTLIST_FOREACH_BEGIN(cl->certs, authority_cert_t *, cert) {
  637. if (cert_sl_idx == smartlist_len(cl->certs) - 1) {
  638. /* This is the most recently published cert. Keep it. */
  639. continue;
  640. }
  641. authority_cert_t *next_cert = smartlist_get(cl->certs, cert_sl_idx+1);
  642. const time_t next_cert_published = next_cert->cache_info.published_on;
  643. if (next_cert_published > now) {
  644. /* All later certs are published in the future. Keep everything
  645. * we didn't discard. */
  646. break;
  647. }
  648. int should_remove = 0;
  649. if (cert->expires + DEAD_CERT_LIFETIME < now) {
  650. /* Certificate has been expired for at least DEAD_CERT_LIFETIME.
  651. * Remove it. */
  652. should_remove = 1;
  653. } else if (next_cert_published + SUPERSEDED_CERT_LIFETIME < now) {
  654. /* Certificate has been superseded for OLD_CERT_LIFETIME.
  655. * Remove it.
  656. */
  657. should_remove = 1;
  658. }
  659. if (should_remove) {
  660. SMARTLIST_DEL_CURRENT_KEEPORDER(cl->certs, cert);
  661. authority_cert_free(cert);
  662. trusted_dir_servers_certs_changed = 1;
  663. }
  664. } SMARTLIST_FOREACH_END(cert);
  665. } DIGESTMAP_FOREACH_END;
  666. #undef DEAD_CERT_LIFETIME
  667. #undef OLD_CERT_LIFETIME
  668. trusted_dirs_flush_certs_to_disk();
  669. }
  670. /** Return the newest v3 authority certificate whose v3 authority identity key
  671. * has digest <b>id_digest</b>. Return NULL if no such authority is known,
  672. * or it has no certificate. */
  673. authority_cert_t *
  674. authority_cert_get_newest_by_id(const char *id_digest)
  675. {
  676. cert_list_t *cl;
  677. authority_cert_t *best = NULL;
  678. if (!trusted_dir_certs ||
  679. !(cl = digestmap_get(trusted_dir_certs, id_digest)))
  680. return NULL;
  681. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, cert,
  682. {
  683. if (!best || cert->cache_info.published_on > best->cache_info.published_on)
  684. best = cert;
  685. });
  686. return best;
  687. }
  688. /** Return the newest v3 authority certificate whose directory signing key has
  689. * digest <b>sk_digest</b>. Return NULL if no such certificate is known.
  690. */
  691. authority_cert_t *
  692. authority_cert_get_by_sk_digest(const char *sk_digest)
  693. {
  694. authority_cert_t *c;
  695. if (!trusted_dir_certs)
  696. return NULL;
  697. if ((c = get_my_v3_authority_cert()) &&
  698. tor_memeq(c->signing_key_digest, sk_digest, DIGEST_LEN))
  699. return c;
  700. if ((c = get_my_v3_legacy_cert()) &&
  701. tor_memeq(c->signing_key_digest, sk_digest, DIGEST_LEN))
  702. return c;
  703. DIGESTMAP_FOREACH(trusted_dir_certs, key, cert_list_t *, cl) {
  704. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, cert,
  705. {
  706. if (tor_memeq(cert->signing_key_digest, sk_digest, DIGEST_LEN))
  707. return cert;
  708. });
  709. } DIGESTMAP_FOREACH_END;
  710. return NULL;
  711. }
  712. /** Return the v3 authority certificate with signing key matching
  713. * <b>sk_digest</b>, for the authority with identity digest <b>id_digest</b>.
  714. * Return NULL if no such authority is known. */
  715. authority_cert_t *
  716. authority_cert_get_by_digests(const char *id_digest,
  717. const char *sk_digest)
  718. {
  719. cert_list_t *cl;
  720. if (!trusted_dir_certs ||
  721. !(cl = digestmap_get(trusted_dir_certs, id_digest)))
  722. return NULL;
  723. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, cert,
  724. if (tor_memeq(cert->signing_key_digest, sk_digest, DIGEST_LEN))
  725. return cert; );
  726. return NULL;
  727. }
  728. /** Add every known authority_cert_t to <b>certs_out</b>. */
  729. void
  730. authority_cert_get_all(smartlist_t *certs_out)
  731. {
  732. tor_assert(certs_out);
  733. if (!trusted_dir_certs)
  734. return;
  735. DIGESTMAP_FOREACH(trusted_dir_certs, key, cert_list_t *, cl) {
  736. SMARTLIST_FOREACH(cl->certs, authority_cert_t *, c,
  737. smartlist_add(certs_out, c));
  738. } DIGESTMAP_FOREACH_END;
  739. }
  740. /** Called when an attempt to download a certificate with the authority with
  741. * ID <b>id_digest</b> and, if not NULL, signed with key signing_key_digest
  742. * fails with HTTP response code <b>status</b>: remember the failure, so we
  743. * don't try again immediately. */
  744. void
  745. authority_cert_dl_failed(const char *id_digest,
  746. const char *signing_key_digest, int status)
  747. {
  748. cert_list_t *cl;
  749. download_status_t *dlstatus = NULL;
  750. char id_digest_str[2*DIGEST_LEN+1];
  751. char sk_digest_str[2*DIGEST_LEN+1];
  752. if (!trusted_dir_certs ||
  753. !(cl = digestmap_get(trusted_dir_certs, id_digest)))
  754. return;
  755. /*
  756. * Are we noting a failed download of the latest cert for the id digest,
  757. * or of a download by (id, signing key) digest pair?
  758. */
  759. if (!signing_key_digest) {
  760. /* Just by id digest */
  761. download_status_failed(&cl->dl_status_by_id, status);
  762. } else {
  763. /* Reset by (id, signing key) digest pair
  764. *
  765. * Look for a download_status_t in the map with this digest
  766. */
  767. dlstatus = dsmap_get(cl->dl_status_map, signing_key_digest);
  768. /* Got one? */
  769. if (dlstatus) {
  770. download_status_failed(dlstatus, status);
  771. } else {
  772. /*
  773. * Do this rather than hex_str(), since hex_str clobbers
  774. * old results and we call twice in the param list.
  775. */
  776. base16_encode(id_digest_str, sizeof(id_digest_str),
  777. id_digest, DIGEST_LEN);
  778. base16_encode(sk_digest_str, sizeof(sk_digest_str),
  779. signing_key_digest, DIGEST_LEN);
  780. log_warn(LD_BUG,
  781. "Got failure for cert fetch with (fp,sk) = (%s,%s), with "
  782. "status %d, but knew nothing about the download.",
  783. id_digest_str, sk_digest_str, status);
  784. }
  785. }
  786. }
  787. static const char *BAD_SIGNING_KEYS[] = {
  788. "09CD84F751FD6E955E0F8ADB497D5401470D697E", // Expires 2015-01-11 16:26:31
  789. "0E7E9C07F0969D0468AD741E172A6109DC289F3C", // Expires 2014-08-12 10:18:26
  790. "57B85409891D3FB32137F642FDEDF8B7F8CDFDCD", // Expires 2015-02-11 17:19:09
  791. "87326329007AF781F587AF5B594E540B2B6C7630", // Expires 2014-07-17 11:10:09
  792. "98CC82342DE8D298CF99D3F1A396475901E0D38E", // Expires 2014-11-10 13:18:56
  793. "9904B52336713A5ADCB13E4FB14DC919E0D45571", // Expires 2014-04-20 20:01:01
  794. "9DCD8E3F1DD1597E2AD476BBA28A1A89F3095227", // Expires 2015-01-16 03:52:30
  795. "A61682F34B9BB9694AC98491FE1ABBFE61923941", // Expires 2014-06-11 09:25:09
  796. "B59F6E99C575113650C99F1C425BA7B20A8C071D", // Expires 2014-07-31 13:22:10
  797. "D27178388FA75B96D37FA36E0B015227DDDBDA51", // Expires 2014-08-04 04:01:57
  798. NULL,
  799. };
  800. /** Return true iff <b>cert</b> authenticates some atuhority signing key
  801. * which, because of the old openssl heartbleed vulnerability, should
  802. * never be trusted. */
  803. int
  804. authority_cert_is_blacklisted(const authority_cert_t *cert)
  805. {
  806. char hex_digest[HEX_DIGEST_LEN+1];
  807. int i;
  808. base16_encode(hex_digest, sizeof(hex_digest),
  809. cert->signing_key_digest, sizeof(cert->signing_key_digest));
  810. for (i = 0; BAD_SIGNING_KEYS[i]; ++i) {
  811. if (!strcasecmp(hex_digest, BAD_SIGNING_KEYS[i])) {
  812. return 1;
  813. }
  814. }
  815. return 0;
  816. }
  817. /** Return true iff when we've been getting enough failures when trying to
  818. * download the certificate with ID digest <b>id_digest</b> that we're willing
  819. * to start bugging the user about it. */
  820. int
  821. authority_cert_dl_looks_uncertain(const char *id_digest)
  822. {
  823. #define N_AUTH_CERT_DL_FAILURES_TO_BUG_USER 2
  824. cert_list_t *cl;
  825. int n_failures;
  826. if (!trusted_dir_certs ||
  827. !(cl = digestmap_get(trusted_dir_certs, id_digest)))
  828. return 0;
  829. n_failures = download_status_get_n_failures(&cl->dl_status_by_id);
  830. return n_failures >= N_AUTH_CERT_DL_FAILURES_TO_BUG_USER;
  831. }
  832. /* Fetch the authority certificates specified in resource.
  833. * If we are a bridge client, and node is a configured bridge, fetch from node
  834. * using dir_hint as the fingerprint. Otherwise, if rs is not NULL, fetch from
  835. * rs. Otherwise, fetch from a random directory mirror. */
  836. static void
  837. authority_certs_fetch_resource_impl(const char *resource,
  838. const char *dir_hint,
  839. const node_t *node,
  840. const routerstatus_t *rs)
  841. {
  842. const or_options_t *options = get_options();
  843. int get_via_tor = purpose_needs_anonymity(DIR_PURPOSE_FETCH_CERTIFICATE, 0,
  844. resource);
  845. /* Make sure bridge clients never connect to anything but a bridge */
  846. if (options->UseBridges) {
  847. if (node && !node_is_a_configured_bridge(node)) {
  848. /* If we're using bridges, and node is not a bridge, use a 3-hop path. */
  849. get_via_tor = 1;
  850. } else if (!node) {
  851. /* If we're using bridges, and there's no node, use a 3-hop path. */
  852. get_via_tor = 1;
  853. }
  854. }
  855. const dir_indirection_t indirection = get_via_tor ? DIRIND_ANONYMOUS
  856. : DIRIND_ONEHOP;
  857. /* If we've just downloaded a consensus from a bridge, re-use that
  858. * bridge */
  859. if (options->UseBridges && node && node->ri && !get_via_tor) {
  860. /* clients always make OR connections to bridges */
  861. tor_addr_port_t or_ap;
  862. /* we are willing to use a non-preferred address if we need to */
  863. fascist_firewall_choose_address_node(node, FIREWALL_OR_CONNECTION, 0,
  864. &or_ap);
  865. directory_initiate_command(&or_ap.addr, or_ap.port,
  866. NULL, 0, /*no dirport*/
  867. dir_hint,
  868. DIR_PURPOSE_FETCH_CERTIFICATE,
  869. 0,
  870. indirection,
  871. resource, NULL, 0, 0);
  872. return;
  873. }
  874. if (rs) {
  875. /* If we've just downloaded a consensus from a directory, re-use that
  876. * directory */
  877. directory_initiate_command_routerstatus(rs,
  878. DIR_PURPOSE_FETCH_CERTIFICATE,
  879. 0, indirection, resource, NULL,
  880. 0, 0, NULL);
  881. return;
  882. }
  883. /* Otherwise, we want certs from a random fallback or directory
  884. * mirror, because they will almost always succeed. */
  885. directory_get_from_dirserver(DIR_PURPOSE_FETCH_CERTIFICATE, 0,
  886. resource, PDS_RETRY_IF_NO_SERVERS,
  887. DL_WANT_ANY_DIRSERVER);
  888. }
  889. /** Try to download any v3 authority certificates that we may be missing. If
  890. * <b>status</b> is provided, try to get all the ones that were used to sign
  891. * <b>status</b>. Additionally, try to have a non-expired certificate for
  892. * every V3 authority in trusted_dir_servers. Don't fetch certificates we
  893. * already have.
  894. *
  895. * If dir_hint is non-NULL, it's the identity digest for a directory that
  896. * we've just successfully retrieved a consensus or certificates from, so try
  897. * it first to fetch any missing certificates.
  898. **/
  899. void
  900. authority_certs_fetch_missing(networkstatus_t *status, time_t now,
  901. const char *dir_hint)
  902. {
  903. /*
  904. * The pending_id digestmap tracks pending certificate downloads by
  905. * identity digest; the pending_cert digestmap tracks pending downloads
  906. * by (identity digest, signing key digest) pairs.
  907. */
  908. digestmap_t *pending_id;
  909. fp_pair_map_t *pending_cert;
  910. /*
  911. * The missing_id_digests smartlist will hold a list of id digests
  912. * we want to fetch the newest cert for; the missing_cert_digests
  913. * smartlist will hold a list of fp_pair_t with an identity and
  914. * signing key digest.
  915. */
  916. smartlist_t *missing_cert_digests, *missing_id_digests;
  917. char *resource = NULL;
  918. cert_list_t *cl;
  919. const or_options_t *options = get_options();
  920. const int keep_unknown = we_want_to_fetch_unknown_auth_certs(options);
  921. fp_pair_t *fp_tmp = NULL;
  922. char id_digest_str[2*DIGEST_LEN+1];
  923. char sk_digest_str[2*DIGEST_LEN+1];
  924. if (should_delay_dir_fetches(options, NULL))
  925. return;
  926. pending_cert = fp_pair_map_new();
  927. pending_id = digestmap_new();
  928. missing_cert_digests = smartlist_new();
  929. missing_id_digests = smartlist_new();
  930. /*
  931. * First, we get the lists of already pending downloads so we don't
  932. * duplicate effort.
  933. */
  934. list_pending_downloads(pending_id, NULL,
  935. DIR_PURPOSE_FETCH_CERTIFICATE, "fp/");
  936. list_pending_fpsk_downloads(pending_cert);
  937. /*
  938. * Now, we download any trusted authority certs we don't have by
  939. * identity digest only. This gets the latest cert for that authority.
  940. */
  941. SMARTLIST_FOREACH_BEGIN(trusted_dir_servers, dir_server_t *, ds) {
  942. int found = 0;
  943. if (!(ds->type & V3_DIRINFO))
  944. continue;
  945. if (smartlist_contains_digest(missing_id_digests,
  946. ds->v3_identity_digest))
  947. continue;
  948. cl = get_cert_list(ds->v3_identity_digest);
  949. SMARTLIST_FOREACH_BEGIN(cl->certs, authority_cert_t *, cert) {
  950. if (now < cert->expires) {
  951. /* It's not expired, and we weren't looking for something to
  952. * verify a consensus with. Call it done. */
  953. download_status_reset(&(cl->dl_status_by_id));
  954. /* No sense trying to download it specifically by signing key hash */
  955. download_status_reset_by_sk_in_cl(cl, cert->signing_key_digest);
  956. found = 1;
  957. break;
  958. }
  959. } SMARTLIST_FOREACH_END(cert);
  960. if (!found &&
  961. download_status_is_ready(&(cl->dl_status_by_id), now,
  962. options->TestingCertMaxDownloadTries) &&
  963. !digestmap_get(pending_id, ds->v3_identity_digest)) {
  964. log_info(LD_DIR,
  965. "No current certificate known for authority %s "
  966. "(ID digest %s); launching request.",
  967. ds->nickname, hex_str(ds->v3_identity_digest, DIGEST_LEN));
  968. smartlist_add(missing_id_digests, ds->v3_identity_digest);
  969. }
  970. } SMARTLIST_FOREACH_END(ds);
  971. /*
  972. * Next, if we have a consensus, scan through it and look for anything
  973. * signed with a key from a cert we don't have. Those get downloaded
  974. * by (fp,sk) pair, but if we don't know any certs at all for the fp
  975. * (identity digest), and it's one of the trusted dir server certs
  976. * we started off above or a pending download in pending_id, don't
  977. * try to get it yet. Most likely, the one we'll get for that will
  978. * have the right signing key too, and we'd just be downloading
  979. * redundantly.
  980. */
  981. if (status) {
  982. SMARTLIST_FOREACH_BEGIN(status->voters, networkstatus_voter_info_t *,
  983. voter) {
  984. if (!smartlist_len(voter->sigs))
  985. continue; /* This authority never signed this consensus, so don't
  986. * go looking for a cert with key digest 0000000000. */
  987. if (!keep_unknown &&
  988. !trusteddirserver_get_by_v3_auth_digest(voter->identity_digest))
  989. continue; /* We don't want unknown certs, and we don't know this
  990. * authority.*/
  991. /*
  992. * If we don't know *any* cert for this authority, and a download by ID
  993. * is pending or we added it to missing_id_digests above, skip this
  994. * one for now to avoid duplicate downloads.
  995. */
  996. cl = get_cert_list(voter->identity_digest);
  997. if (smartlist_len(cl->certs) == 0) {
  998. /* We have no certs at all for this one */
  999. /* Do we have a download of one pending? */
  1000. if (digestmap_get(pending_id, voter->identity_digest))
  1001. continue;
  1002. /*
  1003. * Are we about to launch a download of one due to the trusted
  1004. * dir server check above?
  1005. */
  1006. if (smartlist_contains_digest(missing_id_digests,
  1007. voter->identity_digest))
  1008. continue;
  1009. }
  1010. SMARTLIST_FOREACH_BEGIN(voter->sigs, document_signature_t *, sig) {
  1011. authority_cert_t *cert =
  1012. authority_cert_get_by_digests(voter->identity_digest,
  1013. sig->signing_key_digest);
  1014. if (cert) {
  1015. if (now < cert->expires)
  1016. download_status_reset_by_sk_in_cl(cl, sig->signing_key_digest);
  1017. continue;
  1018. }
  1019. if (download_status_is_ready_by_sk_in_cl(
  1020. cl, sig->signing_key_digest,
  1021. now, options->TestingCertMaxDownloadTries) &&
  1022. !fp_pair_map_get_by_digests(pending_cert,
  1023. voter->identity_digest,
  1024. sig->signing_key_digest)) {
  1025. /*
  1026. * Do this rather than hex_str(), since hex_str clobbers
  1027. * old results and we call twice in the param list.
  1028. */
  1029. base16_encode(id_digest_str, sizeof(id_digest_str),
  1030. voter->identity_digest, DIGEST_LEN);
  1031. base16_encode(sk_digest_str, sizeof(sk_digest_str),
  1032. sig->signing_key_digest, DIGEST_LEN);
  1033. if (voter->nickname) {
  1034. log_info(LD_DIR,
  1035. "We're missing a certificate from authority %s "
  1036. "(ID digest %s) with signing key %s: "
  1037. "launching request.",
  1038. voter->nickname, id_digest_str, sk_digest_str);
  1039. } else {
  1040. log_info(LD_DIR,
  1041. "We're missing a certificate from authority ID digest "
  1042. "%s with signing key %s: launching request.",
  1043. id_digest_str, sk_digest_str);
  1044. }
  1045. /* Allocate a new fp_pair_t to append */
  1046. fp_tmp = tor_malloc(sizeof(*fp_tmp));
  1047. memcpy(fp_tmp->first, voter->identity_digest, sizeof(fp_tmp->first));
  1048. memcpy(fp_tmp->second, sig->signing_key_digest,
  1049. sizeof(fp_tmp->second));
  1050. smartlist_add(missing_cert_digests, fp_tmp);
  1051. }
  1052. } SMARTLIST_FOREACH_END(sig);
  1053. } SMARTLIST_FOREACH_END(voter);
  1054. }
  1055. /* Bridge clients look up the node for the dir_hint */
  1056. const node_t *node = NULL;
  1057. /* All clients, including bridge clients, look up the routerstatus for the
  1058. * dir_hint */
  1059. const routerstatus_t *rs = NULL;
  1060. /* If we still need certificates, try the directory that just successfully
  1061. * served us a consensus or certificates.
  1062. * As soon as the directory fails to provide additional certificates, we try
  1063. * another, randomly selected directory. This avoids continual retries.
  1064. * (We only ever have one outstanding request per certificate.)
  1065. */
  1066. if (dir_hint) {
  1067. if (options->UseBridges) {
  1068. /* Bridge clients try the nodelist. If the dir_hint is from an authority,
  1069. * or something else fetched over tor, we won't find the node here, but
  1070. * we will find the rs. */
  1071. node = node_get_by_id(dir_hint);
  1072. }
  1073. /* All clients try the consensus routerstatus, then the fallback
  1074. * routerstatus */
  1075. rs = router_get_consensus_status_by_id(dir_hint);
  1076. if (!rs) {
  1077. /* This will also find authorities */
  1078. const dir_server_t *ds = router_get_fallback_dirserver_by_digest(
  1079. dir_hint);
  1080. if (ds) {
  1081. rs = &ds->fake_status;
  1082. }
  1083. }
  1084. if (!node && !rs) {
  1085. log_warn(LD_BUG, "Directory %s delivered a consensus, but %s"
  1086. "no routerstatus could be found for it.",
  1087. options->UseBridges ? "no node and " : "",
  1088. hex_str(dir_hint, DIGEST_LEN));
  1089. }
  1090. }
  1091. /* Do downloads by identity digest */
  1092. if (smartlist_len(missing_id_digests) > 0) {
  1093. int need_plus = 0;
  1094. smartlist_t *fps = smartlist_new();
  1095. smartlist_add_strdup(fps, "fp/");
  1096. SMARTLIST_FOREACH_BEGIN(missing_id_digests, const char *, d) {
  1097. char *fp = NULL;
  1098. if (digestmap_get(pending_id, d))
  1099. continue;
  1100. base16_encode(id_digest_str, sizeof(id_digest_str),
  1101. d, DIGEST_LEN);
  1102. if (need_plus) {
  1103. tor_asprintf(&fp, "+%s", id_digest_str);
  1104. } else {
  1105. /* No need for tor_asprintf() in this case; first one gets no '+' */
  1106. fp = tor_strdup(id_digest_str);
  1107. need_plus = 1;
  1108. }
  1109. smartlist_add(fps, fp);
  1110. } SMARTLIST_FOREACH_END(d);
  1111. if (smartlist_len(fps) > 1) {
  1112. resource = smartlist_join_strings(fps, "", 0, NULL);
  1113. /* node and rs are directories that just gave us a consensus or
  1114. * certificates */
  1115. authority_certs_fetch_resource_impl(resource, dir_hint, node, rs);
  1116. tor_free(resource);
  1117. }
  1118. /* else we didn't add any: they were all pending */
  1119. SMARTLIST_FOREACH(fps, char *, cp, tor_free(cp));
  1120. smartlist_free(fps);
  1121. }
  1122. /* Do downloads by identity digest/signing key pair */
  1123. if (smartlist_len(missing_cert_digests) > 0) {
  1124. int need_plus = 0;
  1125. smartlist_t *fp_pairs = smartlist_new();
  1126. smartlist_add_strdup(fp_pairs, "fp-sk/");
  1127. SMARTLIST_FOREACH_BEGIN(missing_cert_digests, const fp_pair_t *, d) {
  1128. char *fp_pair = NULL;
  1129. if (fp_pair_map_get(pending_cert, d))
  1130. continue;
  1131. /* Construct string encodings of the digests */
  1132. base16_encode(id_digest_str, sizeof(id_digest_str),
  1133. d->first, DIGEST_LEN);
  1134. base16_encode(sk_digest_str, sizeof(sk_digest_str),
  1135. d->second, DIGEST_LEN);
  1136. /* Now tor_asprintf() */
  1137. if (need_plus) {
  1138. tor_asprintf(&fp_pair, "+%s-%s", id_digest_str, sk_digest_str);
  1139. } else {
  1140. /* First one in the list doesn't get a '+' */
  1141. tor_asprintf(&fp_pair, "%s-%s", id_digest_str, sk_digest_str);
  1142. need_plus = 1;
  1143. }
  1144. /* Add it to the list of pairs to request */
  1145. smartlist_add(fp_pairs, fp_pair);
  1146. } SMARTLIST_FOREACH_END(d);
  1147. if (smartlist_len(fp_pairs) > 1) {
  1148. resource = smartlist_join_strings(fp_pairs, "", 0, NULL);
  1149. /* node and rs are directories that just gave us a consensus or
  1150. * certificates */
  1151. authority_certs_fetch_resource_impl(resource, dir_hint, node, rs);
  1152. tor_free(resource);
  1153. }
  1154. /* else they were all pending */
  1155. SMARTLIST_FOREACH(fp_pairs, char *, p, tor_free(p));
  1156. smartlist_free(fp_pairs);
  1157. }
  1158. smartlist_free(missing_id_digests);
  1159. SMARTLIST_FOREACH(missing_cert_digests, fp_pair_t *, p, tor_free(p));
  1160. smartlist_free(missing_cert_digests);
  1161. digestmap_free(pending_id, NULL);
  1162. fp_pair_map_free(pending_cert, NULL);
  1163. }
  1164. /* Router descriptor storage.
  1165. *
  1166. * Routerdescs are stored in a big file, named "cached-descriptors". As new
  1167. * routerdescs arrive, we append them to a journal file named
  1168. * "cached-descriptors.new".
  1169. *
  1170. * From time to time, we replace "cached-descriptors" with a new file
  1171. * containing only the live, non-superseded descriptors, and clear
  1172. * cached-routers.new.
  1173. *
  1174. * On startup, we read both files.
  1175. */
  1176. /** Helper: return 1 iff the router log is so big we want to rebuild the
  1177. * store. */
  1178. static int
  1179. router_should_rebuild_store(desc_store_t *store)
  1180. {
  1181. if (store->store_len > (1<<16))
  1182. return (store->journal_len > store->store_len / 2 ||
  1183. store->bytes_dropped > store->store_len / 2);
  1184. else
  1185. return store->journal_len > (1<<15);
  1186. }
  1187. /** Return the desc_store_t in <b>rl</b> that should be used to store
  1188. * <b>sd</b>. */
  1189. static inline desc_store_t *
  1190. desc_get_store(routerlist_t *rl, const signed_descriptor_t *sd)
  1191. {
  1192. if (sd->is_extrainfo)
  1193. return &rl->extrainfo_store;
  1194. else
  1195. return &rl->desc_store;
  1196. }
  1197. /** Add the signed_descriptor_t in <b>desc</b> to the router
  1198. * journal; change its saved_location to SAVED_IN_JOURNAL and set its
  1199. * offset appropriately. */
  1200. static int
  1201. signed_desc_append_to_journal(signed_descriptor_t *desc,
  1202. desc_store_t *store)
  1203. {
  1204. char *fname = get_datadir_fname_suffix(store->fname_base, ".new");
  1205. const char *body = signed_descriptor_get_body_impl(desc,1);
  1206. size_t len = desc->signed_descriptor_len + desc->annotations_len;
  1207. if (append_bytes_to_file(fname, body, len, 1)) {
  1208. log_warn(LD_FS, "Unable to store router descriptor");
  1209. tor_free(fname);
  1210. return -1;
  1211. }
  1212. desc->saved_location = SAVED_IN_JOURNAL;
  1213. tor_free(fname);
  1214. desc->saved_offset = store->journal_len;
  1215. store->journal_len += len;
  1216. return 0;
  1217. }
  1218. /** Sorting helper: return &lt;0, 0, or &gt;0 depending on whether the
  1219. * signed_descriptor_t* in *<b>a</b> is older, the same age as, or newer than
  1220. * the signed_descriptor_t* in *<b>b</b>. */
  1221. static int
  1222. compare_signed_descriptors_by_age_(const void **_a, const void **_b)
  1223. {
  1224. const signed_descriptor_t *r1 = *_a, *r2 = *_b;
  1225. return (int)(r1->published_on - r2->published_on);
  1226. }
  1227. #define RRS_FORCE 1
  1228. #define RRS_DONT_REMOVE_OLD 2
  1229. /** If the journal of <b>store</b> is too long, or if RRS_FORCE is set in
  1230. * <b>flags</b>, then atomically replace the saved router store with the
  1231. * routers currently in our routerlist, and clear the journal. Unless
  1232. * RRS_DONT_REMOVE_OLD is set in <b>flags</b>, delete expired routers before
  1233. * rebuilding the store. Return 0 on success, -1 on failure.
  1234. */
  1235. static int
  1236. router_rebuild_store(int flags, desc_store_t *store)
  1237. {
  1238. smartlist_t *chunk_list = NULL;
  1239. char *fname = NULL, *fname_tmp = NULL;
  1240. int r = -1;
  1241. off_t offset = 0;
  1242. smartlist_t *signed_descriptors = NULL;
  1243. int nocache=0;
  1244. size_t total_expected_len = 0;
  1245. int had_any;
  1246. int force = flags & RRS_FORCE;
  1247. if (!force && !router_should_rebuild_store(store)) {
  1248. r = 0;
  1249. goto done;
  1250. }
  1251. if (!routerlist) {
  1252. r = 0;
  1253. goto done;
  1254. }
  1255. if (store->type == EXTRAINFO_STORE)
  1256. had_any = !eimap_isempty(routerlist->extra_info_map);
  1257. else
  1258. had_any = (smartlist_len(routerlist->routers)+
  1259. smartlist_len(routerlist->old_routers))>0;
  1260. /* Don't save deadweight. */
  1261. if (!(flags & RRS_DONT_REMOVE_OLD))
  1262. routerlist_remove_old_routers();
  1263. log_info(LD_DIR, "Rebuilding %s cache", store->description);
  1264. fname = get_datadir_fname(store->fname_base);
  1265. fname_tmp = get_datadir_fname_suffix(store->fname_base, ".tmp");
  1266. chunk_list = smartlist_new();
  1267. /* We sort the routers by age to enhance locality on disk. */
  1268. signed_descriptors = smartlist_new();
  1269. if (store->type == EXTRAINFO_STORE) {
  1270. eimap_iter_t *iter;
  1271. for (iter = eimap_iter_init(routerlist->extra_info_map);
  1272. !eimap_iter_done(iter);
  1273. iter = eimap_iter_next(routerlist->extra_info_map, iter)) {
  1274. const char *key;
  1275. extrainfo_t *ei;
  1276. eimap_iter_get(iter, &key, &ei);
  1277. smartlist_add(signed_descriptors, &ei->cache_info);
  1278. }
  1279. } else {
  1280. SMARTLIST_FOREACH(routerlist->old_routers, signed_descriptor_t *, sd,
  1281. smartlist_add(signed_descriptors, sd));
  1282. SMARTLIST_FOREACH(routerlist->routers, routerinfo_t *, ri,
  1283. smartlist_add(signed_descriptors, &ri->cache_info));
  1284. }
  1285. smartlist_sort(signed_descriptors, compare_signed_descriptors_by_age_);
  1286. /* Now, add the appropriate members to chunk_list */
  1287. SMARTLIST_FOREACH_BEGIN(signed_descriptors, signed_descriptor_t *, sd) {
  1288. sized_chunk_t *c;
  1289. const char *body = signed_descriptor_get_body_impl(sd, 1);
  1290. if (!body) {
  1291. log_warn(LD_BUG, "No descriptor available for router.");
  1292. goto done;
  1293. }
  1294. if (sd->do_not_cache) {
  1295. ++nocache;
  1296. continue;
  1297. }
  1298. c = tor_malloc(sizeof(sized_chunk_t));
  1299. c->bytes = body;
  1300. c->len = sd->signed_descriptor_len + sd->annotations_len;
  1301. total_expected_len += c->len;
  1302. smartlist_add(chunk_list, c);
  1303. } SMARTLIST_FOREACH_END(sd);
  1304. if (write_chunks_to_file(fname_tmp, chunk_list, 1, 1)<0) {
  1305. log_warn(LD_FS, "Error writing router store to disk.");
  1306. goto done;
  1307. }
  1308. /* Our mmap is now invalid. */
  1309. if (store->mmap) {
  1310. int res = tor_munmap_file(store->mmap);
  1311. store->mmap = NULL;
  1312. if (res != 0) {
  1313. log_warn(LD_FS, "Unable to munmap route store in %s", fname);
  1314. }
  1315. }
  1316. if (replace_file(fname_tmp, fname)<0) {
  1317. log_warn(LD_FS, "Error replacing old router store: %s", strerror(errno));
  1318. goto done;
  1319. }
  1320. errno = 0;
  1321. store->mmap = tor_mmap_file(fname);
  1322. if (! store->mmap) {
  1323. if (errno == ERANGE) {
  1324. /* empty store.*/
  1325. if (total_expected_len) {
  1326. log_warn(LD_FS, "We wrote some bytes to a new descriptor file at '%s',"
  1327. " but when we went to mmap it, it was empty!", fname);
  1328. } else if (had_any) {
  1329. log_info(LD_FS, "We just removed every descriptor in '%s'. This is "
  1330. "okay if we're just starting up after a long time. "
  1331. "Otherwise, it's a bug.", fname);
  1332. }
  1333. } else {
  1334. log_warn(LD_FS, "Unable to mmap new descriptor file at '%s'.",fname);
  1335. }
  1336. }
  1337. log_info(LD_DIR, "Reconstructing pointers into cache");
  1338. offset = 0;
  1339. SMARTLIST_FOREACH_BEGIN(signed_descriptors, signed_descriptor_t *, sd) {
  1340. if (sd->do_not_cache)
  1341. continue;
  1342. sd->saved_location = SAVED_IN_CACHE;
  1343. if (store->mmap) {
  1344. tor_free(sd->signed_descriptor_body); // sets it to null
  1345. sd->saved_offset = offset;
  1346. }
  1347. offset += sd->signed_descriptor_len + sd->annotations_len;
  1348. signed_descriptor_get_body(sd); /* reconstruct and assert */
  1349. } SMARTLIST_FOREACH_END(sd);
  1350. tor_free(fname);
  1351. fname = get_datadir_fname_suffix(store->fname_base, ".new");
  1352. write_str_to_file(fname, "", 1);
  1353. r = 0;
  1354. store->store_len = (size_t) offset;
  1355. store->journal_len = 0;
  1356. store->bytes_dropped = 0;
  1357. done:
  1358. smartlist_free(signed_descriptors);
  1359. tor_free(fname);
  1360. tor_free(fname_tmp);
  1361. if (chunk_list) {
  1362. SMARTLIST_FOREACH(chunk_list, sized_chunk_t *, c, tor_free(c));
  1363. smartlist_free(chunk_list);
  1364. }
  1365. return r;
  1366. }
  1367. /** Helper: Reload a cache file and its associated journal, setting metadata
  1368. * appropriately. If <b>extrainfo</b> is true, reload the extrainfo store;
  1369. * else reload the router descriptor store. */
  1370. static int
  1371. router_reload_router_list_impl(desc_store_t *store)
  1372. {
  1373. char *fname = NULL, *contents = NULL;
  1374. struct stat st;
  1375. int extrainfo = (store->type == EXTRAINFO_STORE);
  1376. store->journal_len = store->store_len = 0;
  1377. fname = get_datadir_fname(store->fname_base);
  1378. if (store->mmap) {
  1379. /* get rid of it first */
  1380. int res = tor_munmap_file(store->mmap);
  1381. store->mmap = NULL;
  1382. if (res != 0) {
  1383. log_warn(LD_FS, "Failed to munmap %s", fname);
  1384. tor_free(fname);
  1385. return -1;
  1386. }
  1387. }
  1388. store->mmap = tor_mmap_file(fname);
  1389. if (store->mmap) {
  1390. store->store_len = store->mmap->size;
  1391. if (extrainfo)
  1392. router_load_extrainfo_from_string(store->mmap->data,
  1393. store->mmap->data+store->mmap->size,
  1394. SAVED_IN_CACHE, NULL, 0);
  1395. else
  1396. router_load_routers_from_string(store->mmap->data,
  1397. store->mmap->data+store->mmap->size,
  1398. SAVED_IN_CACHE, NULL, 0, NULL);
  1399. }
  1400. tor_free(fname);
  1401. fname = get_datadir_fname_suffix(store->fname_base, ".new");
  1402. /* don't load empty files - we wouldn't get any data, even if we tried */
  1403. if (file_status(fname) == FN_FILE)
  1404. contents = read_file_to_str(fname, RFTS_BIN|RFTS_IGNORE_MISSING, &st);
  1405. if (contents) {
  1406. if (extrainfo)
  1407. router_load_extrainfo_from_string(contents, NULL,SAVED_IN_JOURNAL,
  1408. NULL, 0);
  1409. else
  1410. router_load_routers_from_string(contents, NULL, SAVED_IN_JOURNAL,
  1411. NULL, 0, NULL);
  1412. store->journal_len = (size_t) st.st_size;
  1413. tor_free(contents);
  1414. }
  1415. tor_free(fname);
  1416. if (store->journal_len) {
  1417. /* Always clear the journal on startup.*/
  1418. router_rebuild_store(RRS_FORCE, store);
  1419. } else if (!extrainfo) {
  1420. /* Don't cache expired routers. (This is in an else because
  1421. * router_rebuild_store() also calls remove_old_routers().) */
  1422. routerlist_remove_old_routers();
  1423. }
  1424. return 0;
  1425. }
  1426. /** Load all cached router descriptors and extra-info documents from the
  1427. * store. Return 0 on success and -1 on failure.
  1428. */
  1429. int
  1430. router_reload_router_list(void)
  1431. {
  1432. routerlist_t *rl = router_get_routerlist();
  1433. if (router_reload_router_list_impl(&rl->desc_store))
  1434. return -1;
  1435. if (router_reload_router_list_impl(&rl->extrainfo_store))
  1436. return -1;
  1437. return 0;
  1438. }
  1439. /** Return a smartlist containing a list of dir_server_t * for all
  1440. * known trusted dirservers. Callers must not modify the list or its
  1441. * contents.
  1442. */
  1443. const smartlist_t *
  1444. router_get_trusted_dir_servers(void)
  1445. {
  1446. if (!trusted_dir_servers)
  1447. trusted_dir_servers = smartlist_new();
  1448. return trusted_dir_servers;
  1449. }
  1450. const smartlist_t *
  1451. router_get_fallback_dir_servers(void)
  1452. {
  1453. if (!fallback_dir_servers)
  1454. fallback_dir_servers = smartlist_new();
  1455. return fallback_dir_servers;
  1456. }
  1457. /** Try to find a running dirserver that supports operations of <b>type</b>.
  1458. *
  1459. * If there are no running dirservers in our routerlist and the
  1460. * <b>PDS_RETRY_IF_NO_SERVERS</b> flag is set, set all the fallback ones
  1461. * (including authorities) as running again, and pick one.
  1462. *
  1463. * If the <b>PDS_IGNORE_FASCISTFIREWALL</b> flag is set, then include
  1464. * dirservers that we can't reach.
  1465. *
  1466. * If the <b>PDS_ALLOW_SELF</b> flag is not set, then don't include ourself
  1467. * (if we're a dirserver).
  1468. *
  1469. * Don't pick a fallback directory mirror if any non-fallback is viable;
  1470. * (the fallback directory mirrors include the authorities)
  1471. * try to avoid using servers that have returned 503 recently.
  1472. */
  1473. const routerstatus_t *
  1474. router_pick_directory_server(dirinfo_type_t type, int flags)
  1475. {
  1476. int busy = 0;
  1477. const routerstatus_t *choice;
  1478. if (!routerlist)
  1479. return NULL;
  1480. choice = router_pick_directory_server_impl(type, flags, &busy);
  1481. if (choice || !(flags & PDS_RETRY_IF_NO_SERVERS))
  1482. return choice;
  1483. if (busy) {
  1484. /* If the reason that we got no server is that servers are "busy",
  1485. * we must be excluding good servers because we already have serverdesc
  1486. * fetches with them. Do not mark down servers up because of this. */
  1487. tor_assert((flags & (PDS_NO_EXISTING_SERVERDESC_FETCH|
  1488. PDS_NO_EXISTING_MICRODESC_FETCH)));
  1489. return NULL;
  1490. }
  1491. log_info(LD_DIR,
  1492. "No reachable router entries for dirservers. "
  1493. "Trying them all again.");
  1494. /* mark all fallback directory mirrors as up again */
  1495. mark_all_dirservers_up(fallback_dir_servers);
  1496. /* try again */
  1497. choice = router_pick_directory_server_impl(type, flags, NULL);
  1498. return choice;
  1499. }
  1500. /** Return the dir_server_t for the directory authority whose identity
  1501. * key hashes to <b>digest</b>, or NULL if no such authority is known.
  1502. */
  1503. dir_server_t *
  1504. router_get_trusteddirserver_by_digest(const char *digest)
  1505. {
  1506. if (!trusted_dir_servers)
  1507. return NULL;
  1508. SMARTLIST_FOREACH(trusted_dir_servers, dir_server_t *, ds,
  1509. {
  1510. if (tor_memeq(ds->digest, digest, DIGEST_LEN))
  1511. return ds;
  1512. });
  1513. return NULL;
  1514. }
  1515. /** Return the dir_server_t for the fallback dirserver whose identity
  1516. * key hashes to <b>digest</b>, or NULL if no such fallback is in the list of
  1517. * fallback_dir_servers. (fallback_dir_servers is affected by the FallbackDir
  1518. * and UseDefaultFallbackDirs torrc options.)
  1519. * The list of fallback directories includes the list of authorities.
  1520. */
  1521. dir_server_t *
  1522. router_get_fallback_dirserver_by_digest(const char *digest)
  1523. {
  1524. if (!fallback_dir_servers)
  1525. return NULL;
  1526. if (!digest)
  1527. return NULL;
  1528. SMARTLIST_FOREACH(fallback_dir_servers, dir_server_t *, ds,
  1529. {
  1530. if (tor_memeq(ds->digest, digest, DIGEST_LEN))
  1531. return ds;
  1532. });
  1533. return NULL;
  1534. }
  1535. /** Return 1 if any fallback dirserver's identity key hashes to <b>digest</b>,
  1536. * or 0 if no such fallback is in the list of fallback_dir_servers.
  1537. * (fallback_dir_servers is affected by the FallbackDir and
  1538. * UseDefaultFallbackDirs torrc options.)
  1539. * The list of fallback directories includes the list of authorities.
  1540. */
  1541. int
  1542. router_digest_is_fallback_dir(const char *digest)
  1543. {
  1544. return (router_get_fallback_dirserver_by_digest(digest) != NULL);
  1545. }
  1546. /** Return the dir_server_t for the directory authority whose
  1547. * v3 identity key hashes to <b>digest</b>, or NULL if no such authority
  1548. * is known.
  1549. */
  1550. MOCK_IMPL(dir_server_t *,
  1551. trusteddirserver_get_by_v3_auth_digest, (const char *digest))
  1552. {
  1553. if (!trusted_dir_servers)
  1554. return NULL;
  1555. SMARTLIST_FOREACH(trusted_dir_servers, dir_server_t *, ds,
  1556. {
  1557. if (tor_memeq(ds->v3_identity_digest, digest, DIGEST_LEN) &&
  1558. (ds->type & V3_DIRINFO))
  1559. return ds;
  1560. });
  1561. return NULL;
  1562. }
  1563. /** Try to find a running directory authority. Flags are as for
  1564. * router_pick_directory_server.
  1565. */
  1566. const routerstatus_t *
  1567. router_pick_trusteddirserver(dirinfo_type_t type, int flags)
  1568. {
  1569. return router_pick_dirserver_generic(trusted_dir_servers, type, flags);
  1570. }
  1571. /** Try to find a running fallback directory. Flags are as for
  1572. * router_pick_directory_server.
  1573. */
  1574. const routerstatus_t *
  1575. router_pick_fallback_dirserver(dirinfo_type_t type, int flags)
  1576. {
  1577. return router_pick_dirserver_generic(fallback_dir_servers, type, flags);
  1578. }
  1579. /** Try to find a running fallback directory. Flags are as for
  1580. * router_pick_directory_server.
  1581. */
  1582. static const routerstatus_t *
  1583. router_pick_dirserver_generic(smartlist_t *sourcelist,
  1584. dirinfo_type_t type, int flags)
  1585. {
  1586. const routerstatus_t *choice;
  1587. int busy = 0;
  1588. choice = router_pick_trusteddirserver_impl(sourcelist, type, flags, &busy);
  1589. if (choice || !(flags & PDS_RETRY_IF_NO_SERVERS))
  1590. return choice;
  1591. if (busy) {
  1592. /* If the reason that we got no server is that servers are "busy",
  1593. * we must be excluding good servers because we already have serverdesc
  1594. * fetches with them. Do not mark down servers up because of this. */
  1595. tor_assert((flags & (PDS_NO_EXISTING_SERVERDESC_FETCH|
  1596. PDS_NO_EXISTING_MICRODESC_FETCH)));
  1597. return NULL;
  1598. }
  1599. log_info(LD_DIR,
  1600. "No dirservers are reachable. Trying them all again.");
  1601. mark_all_dirservers_up(sourcelist);
  1602. return router_pick_trusteddirserver_impl(sourcelist, type, flags, NULL);
  1603. }
  1604. /* Check if we already have a directory fetch from ap, for serverdesc
  1605. * (including extrainfo) or microdesc documents.
  1606. * If so, return 1, if not, return 0.
  1607. * Also returns 0 if addr is NULL, tor_addr_is_null(addr), or dir_port is 0.
  1608. */
  1609. STATIC int
  1610. router_is_already_dir_fetching(const tor_addr_port_t *ap, int serverdesc,
  1611. int microdesc)
  1612. {
  1613. if (!ap || tor_addr_is_null(&ap->addr) || !ap->port) {
  1614. return 0;
  1615. }
  1616. /* XX/teor - we're not checking tunnel connections here, see #17848
  1617. */
  1618. if (serverdesc && (
  1619. connection_get_by_type_addr_port_purpose(
  1620. CONN_TYPE_DIR, &ap->addr, ap->port, DIR_PURPOSE_FETCH_SERVERDESC)
  1621. || connection_get_by_type_addr_port_purpose(
  1622. CONN_TYPE_DIR, &ap->addr, ap->port, DIR_PURPOSE_FETCH_EXTRAINFO))) {
  1623. return 1;
  1624. }
  1625. if (microdesc && (
  1626. connection_get_by_type_addr_port_purpose(
  1627. CONN_TYPE_DIR, &ap->addr, ap->port, DIR_PURPOSE_FETCH_MICRODESC))) {
  1628. return 1;
  1629. }
  1630. return 0;
  1631. }
  1632. /* Check if we already have a directory fetch from the ipv4 or ipv6
  1633. * router, for serverdesc (including extrainfo) or microdesc documents.
  1634. * If so, return 1, if not, return 0.
  1635. */
  1636. static int
  1637. router_is_already_dir_fetching_(uint32_t ipv4_addr,
  1638. const tor_addr_t *ipv6_addr,
  1639. uint16_t dir_port,
  1640. int serverdesc,
  1641. int microdesc)
  1642. {
  1643. tor_addr_port_t ipv4_dir_ap, ipv6_dir_ap;
  1644. /* Assume IPv6 DirPort is the same as IPv4 DirPort */
  1645. tor_addr_from_ipv4h(&ipv4_dir_ap.addr, ipv4_addr);
  1646. ipv4_dir_ap.port = dir_port;
  1647. tor_addr_copy(&ipv6_dir_ap.addr, ipv6_addr);
  1648. ipv6_dir_ap.port = dir_port;
  1649. return (router_is_already_dir_fetching(&ipv4_dir_ap, serverdesc, microdesc)
  1650. || router_is_already_dir_fetching(&ipv6_dir_ap, serverdesc, microdesc));
  1651. }
  1652. #ifndef LOG_FALSE_POSITIVES_DURING_BOOTSTRAP
  1653. #define LOG_FALSE_POSITIVES_DURING_BOOTSTRAP 0
  1654. #endif
  1655. /* Log a message if rs is not found or not a preferred address */
  1656. static void
  1657. router_picked_poor_directory_log(const routerstatus_t *rs)
  1658. {
  1659. const networkstatus_t *usable_consensus;
  1660. usable_consensus = networkstatus_get_reasonably_live_consensus(time(NULL),
  1661. usable_consensus_flavor());
  1662. #if !LOG_FALSE_POSITIVES_DURING_BOOTSTRAP
  1663. /* Don't log early in the bootstrap process, it's normal to pick from a
  1664. * small pool of nodes. Of course, this won't help if we're trying to
  1665. * diagnose bootstrap issues. */
  1666. if (!smartlist_len(nodelist_get_list()) || !usable_consensus
  1667. || !router_have_minimum_dir_info()) {
  1668. return;
  1669. }
  1670. #endif
  1671. /* We couldn't find a node, or the one we have doesn't fit our preferences.
  1672. * Sometimes this is normal, sometimes it can be a reachability issue. */
  1673. if (!rs) {
  1674. /* This happens a lot, so it's at debug level */
  1675. log_debug(LD_DIR, "Wanted to make an outgoing directory connection, but "
  1676. "we couldn't find a directory that fit our criteria. "
  1677. "Perhaps we will succeed next time with less strict criteria.");
  1678. } else if (!fascist_firewall_allows_rs(rs, FIREWALL_OR_CONNECTION, 1)
  1679. && !fascist_firewall_allows_rs(rs, FIREWALL_DIR_CONNECTION, 1)
  1680. ) {
  1681. /* This is rare, and might be interesting to users trying to diagnose
  1682. * connection issues on dual-stack machines. */
  1683. log_info(LD_DIR, "Selected a directory %s with non-preferred OR and Dir "
  1684. "addresses for launching an outgoing connection: "
  1685. "IPv4 %s OR %d Dir %d IPv6 %s OR %d Dir %d",
  1686. routerstatus_describe(rs),
  1687. fmt_addr32(rs->addr), rs->or_port,
  1688. rs->dir_port, fmt_addr(&rs->ipv6_addr),
  1689. rs->ipv6_orport, rs->dir_port);
  1690. }
  1691. }
  1692. #undef LOG_FALSE_POSITIVES_DURING_BOOTSTRAP
  1693. /** How long do we avoid using a directory server after it's given us a 503? */
  1694. #define DIR_503_TIMEOUT (60*60)
  1695. /* Common retry code for router_pick_directory_server_impl and
  1696. * router_pick_trusteddirserver_impl. Retry with the non-preferred IP version.
  1697. * Must be called before RETRY_WITHOUT_EXCLUDE().
  1698. *
  1699. * If we got no result, and we are applying IP preferences, and we are a
  1700. * client that could use an alternate IP version, try again with the
  1701. * opposite preferences. */
  1702. #define RETRY_ALTERNATE_IP_VERSION(retry_label) \
  1703. STMT_BEGIN \
  1704. if (result == NULL && try_ip_pref && options->ClientUseIPv4 \
  1705. && fascist_firewall_use_ipv6(options) && !server_mode(options) \
  1706. && !n_busy) { \
  1707. n_excluded = 0; \
  1708. n_busy = 0; \
  1709. try_ip_pref = 0; \
  1710. goto retry_label; \
  1711. } \
  1712. STMT_END \
  1713. /* Common retry code for router_pick_directory_server_impl and
  1714. * router_pick_trusteddirserver_impl. Retry without excluding nodes, but with
  1715. * the preferred IP version. Must be called after RETRY_ALTERNATE_IP_VERSION().
  1716. *
  1717. * If we got no result, and we are excluding nodes, and StrictNodes is
  1718. * not set, try again without excluding nodes. */
  1719. #define RETRY_WITHOUT_EXCLUDE(retry_label) \
  1720. STMT_BEGIN \
  1721. if (result == NULL && try_excluding && !options->StrictNodes \
  1722. && n_excluded && !n_busy) { \
  1723. try_excluding = 0; \
  1724. n_excluded = 0; \
  1725. n_busy = 0; \
  1726. try_ip_pref = 1; \
  1727. goto retry_label; \
  1728. } \
  1729. STMT_END
  1730. /* Common code used in the loop within router_pick_directory_server_impl and
  1731. * router_pick_trusteddirserver_impl.
  1732. *
  1733. * Check if the given <b>identity</b> supports extrainfo. If not, skip further
  1734. * checks.
  1735. */
  1736. #define SKIP_MISSING_TRUSTED_EXTRAINFO(type, identity) \
  1737. STMT_BEGIN \
  1738. int is_trusted_extrainfo = router_digest_is_trusted_dir_type( \
  1739. (identity), EXTRAINFO_DIRINFO); \
  1740. if (((type) & EXTRAINFO_DIRINFO) && \
  1741. !router_supports_extrainfo((identity), is_trusted_extrainfo)) \
  1742. continue; \
  1743. STMT_END
  1744. /* When iterating through the routerlist, can OR address/port preference
  1745. * and reachability checks be skipped?
  1746. */
  1747. int
  1748. router_skip_or_reachability(const or_options_t *options, int try_ip_pref)
  1749. {
  1750. /* Servers always have and prefer IPv4.
  1751. * And if clients are checking against the firewall for reachability only,
  1752. * but there's no firewall, don't bother checking */
  1753. return server_mode(options) || (!try_ip_pref && !firewall_is_fascist_or());
  1754. }
  1755. /* When iterating through the routerlist, can Dir address/port preference
  1756. * and reachability checks be skipped?
  1757. */
  1758. static int
  1759. router_skip_dir_reachability(const or_options_t *options, int try_ip_pref)
  1760. {
  1761. /* Servers always have and prefer IPv4.
  1762. * And if clients are checking against the firewall for reachability only,
  1763. * but there's no firewall, don't bother checking */
  1764. return server_mode(options) || (!try_ip_pref && !firewall_is_fascist_dir());
  1765. }
  1766. /** Pick a random running valid directory server/mirror from our
  1767. * routerlist. Arguments are as for router_pick_directory_server(), except:
  1768. *
  1769. * If <b>n_busy_out</b> is provided, set *<b>n_busy_out</b> to the number of
  1770. * directories that we excluded for no other reason than
  1771. * PDS_NO_EXISTING_SERVERDESC_FETCH or PDS_NO_EXISTING_MICRODESC_FETCH.
  1772. */
  1773. STATIC const routerstatus_t *
  1774. router_pick_directory_server_impl(dirinfo_type_t type, int flags,
  1775. int *n_busy_out)
  1776. {
  1777. const or_options_t *options = get_options();
  1778. const node_t *result;
  1779. smartlist_t *direct, *tunnel;
  1780. smartlist_t *trusted_direct, *trusted_tunnel;
  1781. smartlist_t *overloaded_direct, *overloaded_tunnel;
  1782. time_t now = time(NULL);
  1783. const networkstatus_t *consensus = networkstatus_get_latest_consensus();
  1784. const int requireother = ! (flags & PDS_ALLOW_SELF);
  1785. const int fascistfirewall = ! (flags & PDS_IGNORE_FASCISTFIREWALL);
  1786. const int no_serverdesc_fetching =(flags & PDS_NO_EXISTING_SERVERDESC_FETCH);
  1787. const int no_microdesc_fetching = (flags & PDS_NO_EXISTING_MICRODESC_FETCH);
  1788. int try_excluding = 1, n_excluded = 0, n_busy = 0;
  1789. int try_ip_pref = 1;
  1790. if (!consensus)
  1791. return NULL;
  1792. retry_search:
  1793. direct = smartlist_new();
  1794. tunnel = smartlist_new();
  1795. trusted_direct = smartlist_new();
  1796. trusted_tunnel = smartlist_new();
  1797. overloaded_direct = smartlist_new();
  1798. overloaded_tunnel = smartlist_new();
  1799. const int skip_or_fw = router_skip_or_reachability(options, try_ip_pref);
  1800. const int skip_dir_fw = router_skip_dir_reachability(options, try_ip_pref);
  1801. const int must_have_or = directory_must_use_begindir(options);
  1802. /* Find all the running dirservers we know about. */
  1803. SMARTLIST_FOREACH_BEGIN(nodelist_get_list(), const node_t *, node) {
  1804. int is_trusted;
  1805. int is_overloaded;
  1806. const routerstatus_t *status = node->rs;
  1807. const country_t country = node->country;
  1808. if (!status)
  1809. continue;
  1810. if (!node->is_running || !node_is_dir(node) || !node->is_valid)
  1811. continue;
  1812. if (requireother && router_digest_is_me(node->identity))
  1813. continue;
  1814. SKIP_MISSING_TRUSTED_EXTRAINFO(type, node->identity);
  1815. if (try_excluding &&
  1816. routerset_contains_routerstatus(options->ExcludeNodes, status,
  1817. country)) {
  1818. ++n_excluded;
  1819. continue;
  1820. }
  1821. if (router_is_already_dir_fetching_(status->addr,
  1822. &status->ipv6_addr,
  1823. status->dir_port,
  1824. no_serverdesc_fetching,
  1825. no_microdesc_fetching)) {
  1826. ++n_busy;
  1827. continue;
  1828. }
  1829. is_overloaded = status->last_dir_503_at + DIR_503_TIMEOUT > now;
  1830. is_trusted = router_digest_is_trusted_dir(node->identity);
  1831. /* Clients use IPv6 addresses if the server has one and the client
  1832. * prefers IPv6.
  1833. * Add the router if its preferred address and port are reachable.
  1834. * If we don't get any routers, we'll try again with the non-preferred
  1835. * address for each router (if any). (To ensure correct load-balancing
  1836. * we try routers that only have one address both times.)
  1837. */
  1838. if (!fascistfirewall || skip_or_fw ||
  1839. fascist_firewall_allows_node(node, FIREWALL_OR_CONNECTION,
  1840. try_ip_pref))
  1841. smartlist_add(is_trusted ? trusted_tunnel :
  1842. is_overloaded ? overloaded_tunnel : tunnel, (void*)node);
  1843. else if (!must_have_or && (skip_dir_fw ||
  1844. fascist_firewall_allows_node(node, FIREWALL_DIR_CONNECTION,
  1845. try_ip_pref)))
  1846. smartlist_add(is_trusted ? trusted_direct :
  1847. is_overloaded ? overloaded_direct : direct, (void*)node);
  1848. } SMARTLIST_FOREACH_END(node);
  1849. if (smartlist_len(tunnel)) {
  1850. result = node_sl_choose_by_bandwidth(tunnel, WEIGHT_FOR_DIR);
  1851. } else if (smartlist_len(overloaded_tunnel)) {
  1852. result = node_sl_choose_by_bandwidth(overloaded_tunnel,
  1853. WEIGHT_FOR_DIR);
  1854. } else if (smartlist_len(trusted_tunnel)) {
  1855. /* FFFF We don't distinguish between trusteds and overloaded trusteds
  1856. * yet. Maybe one day we should. */
  1857. /* FFFF We also don't load balance over authorities yet. I think this
  1858. * is a feature, but it could easily be a bug. -RD */
  1859. result = smartlist_choose(trusted_tunnel);
  1860. } else if (smartlist_len(direct)) {
  1861. result = node_sl_choose_by_bandwidth(direct, WEIGHT_FOR_DIR);
  1862. } else if (smartlist_len(overloaded_direct)) {
  1863. result = node_sl_choose_by_bandwidth(overloaded_direct,
  1864. WEIGHT_FOR_DIR);
  1865. } else {
  1866. result = smartlist_choose(trusted_direct);
  1867. }
  1868. smartlist_free(direct);
  1869. smartlist_free(tunnel);
  1870. smartlist_free(trusted_direct);
  1871. smartlist_free(trusted_tunnel);
  1872. smartlist_free(overloaded_direct);
  1873. smartlist_free(overloaded_tunnel);
  1874. RETRY_ALTERNATE_IP_VERSION(retry_search);
  1875. RETRY_WITHOUT_EXCLUDE(retry_search);
  1876. if (n_busy_out)
  1877. *n_busy_out = n_busy;
  1878. router_picked_poor_directory_log(result ? result->rs : NULL);
  1879. return result ? result->rs : NULL;
  1880. }
  1881. /** Pick a random element from a list of dir_server_t, weighting by their
  1882. * <b>weight</b> field. */
  1883. static const dir_server_t *
  1884. dirserver_choose_by_weight(const smartlist_t *servers, double authority_weight)
  1885. {
  1886. int n = smartlist_len(servers);
  1887. int i;
  1888. double *weights_dbl;
  1889. uint64_t *weights_u64;
  1890. const dir_server_t *ds;
  1891. weights_dbl = tor_calloc(n, sizeof(double));
  1892. weights_u64 = tor_calloc(n, sizeof(uint64_t));
  1893. for (i = 0; i < n; ++i) {
  1894. ds = smartlist_get(servers, i);
  1895. weights_dbl[i] = ds->weight;
  1896. if (ds->is_authority)
  1897. weights_dbl[i] *= authority_weight;
  1898. }
  1899. scale_array_elements_to_u64(weights_u64, weights_dbl, n, NULL);
  1900. i = choose_array_element_by_weight(weights_u64, n);
  1901. tor_free(weights_dbl);
  1902. tor_free(weights_u64);
  1903. return (i < 0) ? NULL : smartlist_get(servers, i);
  1904. }
  1905. /** Choose randomly from among the dir_server_ts in sourcelist that
  1906. * are up. Flags are as for router_pick_directory_server_impl().
  1907. */
  1908. static const routerstatus_t *
  1909. router_pick_trusteddirserver_impl(const smartlist_t *sourcelist,
  1910. dirinfo_type_t type, int flags,
  1911. int *n_busy_out)
  1912. {
  1913. const or_options_t *options = get_options();
  1914. smartlist_t *direct, *tunnel;
  1915. smartlist_t *overloaded_direct, *overloaded_tunnel;
  1916. const routerinfo_t *me = router_get_my_routerinfo();
  1917. const routerstatus_t *result = NULL;
  1918. time_t now = time(NULL);
  1919. const int requireother = ! (flags & PDS_ALLOW_SELF);
  1920. const int fascistfirewall = ! (flags & PDS_IGNORE_FASCISTFIREWALL);
  1921. const int no_serverdesc_fetching =(flags & PDS_NO_EXISTING_SERVERDESC_FETCH);
  1922. const int no_microdesc_fetching =(flags & PDS_NO_EXISTING_MICRODESC_FETCH);
  1923. const double auth_weight = (sourcelist == fallback_dir_servers) ?
  1924. options->DirAuthorityFallbackRate : 1.0;
  1925. smartlist_t *pick_from;
  1926. int n_busy = 0;
  1927. int try_excluding = 1, n_excluded = 0;
  1928. int try_ip_pref = 1;
  1929. if (!sourcelist)
  1930. return NULL;
  1931. retry_search:
  1932. direct = smartlist_new();
  1933. tunnel = smartlist_new();
  1934. overloaded_direct = smartlist_new();
  1935. overloaded_tunnel = smartlist_new();
  1936. const int skip_or_fw = router_skip_or_reachability(options, try_ip_pref);
  1937. const int skip_dir_fw = router_skip_dir_reachability(options, try_ip_pref);
  1938. const int must_have_or = directory_must_use_begindir(options);
  1939. SMARTLIST_FOREACH_BEGIN(sourcelist, const dir_server_t *, d)
  1940. {
  1941. int is_overloaded =
  1942. d->fake_status.last_dir_503_at + DIR_503_TIMEOUT > now;
  1943. if (!d->is_running) continue;
  1944. if ((type & d->type) == 0)
  1945. continue;
  1946. SKIP_MISSING_TRUSTED_EXTRAINFO(type, d->digest);
  1947. if (requireother && me && router_digest_is_me(d->digest))
  1948. continue;
  1949. if (try_excluding &&
  1950. routerset_contains_routerstatus(options->ExcludeNodes,
  1951. &d->fake_status, -1)) {
  1952. ++n_excluded;
  1953. continue;
  1954. }
  1955. if (router_is_already_dir_fetching_(d->addr,
  1956. &d->ipv6_addr,
  1957. d->dir_port,
  1958. no_serverdesc_fetching,
  1959. no_microdesc_fetching)) {
  1960. ++n_busy;
  1961. continue;
  1962. }
  1963. /* Clients use IPv6 addresses if the server has one and the client
  1964. * prefers IPv6.
  1965. * Add the router if its preferred address and port are reachable.
  1966. * If we don't get any routers, we'll try again with the non-preferred
  1967. * address for each router (if any). (To ensure correct load-balancing
  1968. * we try routers that only have one address both times.)
  1969. */
  1970. if (!fascistfirewall || skip_or_fw ||
  1971. fascist_firewall_allows_dir_server(d, FIREWALL_OR_CONNECTION,
  1972. try_ip_pref))
  1973. smartlist_add(is_overloaded ? overloaded_tunnel : tunnel, (void*)d);
  1974. else if (!must_have_or && (skip_dir_fw ||
  1975. fascist_firewall_allows_dir_server(d, FIREWALL_DIR_CONNECTION,
  1976. try_ip_pref)))
  1977. smartlist_add(is_overloaded ? overloaded_direct : direct, (void*)d);
  1978. }
  1979. SMARTLIST_FOREACH_END(d);
  1980. if (smartlist_len(tunnel)) {
  1981. pick_from = tunnel;
  1982. } else if (smartlist_len(overloaded_tunnel)) {
  1983. pick_from = overloaded_tunnel;
  1984. } else if (smartlist_len(direct)) {
  1985. pick_from = direct;
  1986. } else {
  1987. pick_from = overloaded_direct;
  1988. }
  1989. {
  1990. const dir_server_t *selection =
  1991. dirserver_choose_by_weight(pick_from, auth_weight);
  1992. if (selection)
  1993. result = &selection->fake_status;
  1994. }
  1995. smartlist_free(direct);
  1996. smartlist_free(tunnel);
  1997. smartlist_free(overloaded_direct);
  1998. smartlist_free(overloaded_tunnel);
  1999. RETRY_ALTERNATE_IP_VERSION(retry_search);
  2000. RETRY_WITHOUT_EXCLUDE(retry_search);
  2001. router_picked_poor_directory_log(result);
  2002. if (n_busy_out)
  2003. *n_busy_out = n_busy;
  2004. return result;
  2005. }
  2006. /** Mark as running every dir_server_t in <b>server_list</b>. */
  2007. static void
  2008. mark_all_dirservers_up(smartlist_t *server_list)
  2009. {
  2010. if (server_list) {
  2011. SMARTLIST_FOREACH_BEGIN(server_list, dir_server_t *, dir) {
  2012. routerstatus_t *rs;
  2013. node_t *node;
  2014. dir->is_running = 1;
  2015. node = node_get_mutable_by_id(dir->digest);
  2016. if (node)
  2017. node->is_running = 1;
  2018. rs = router_get_mutable_consensus_status_by_id(dir->digest);
  2019. if (rs) {
  2020. rs->last_dir_503_at = 0;
  2021. control_event_networkstatus_changed_single(rs);
  2022. }
  2023. } SMARTLIST_FOREACH_END(dir);
  2024. }
  2025. router_dir_info_changed();
  2026. }
  2027. /** Return true iff r1 and r2 have the same address and OR port. */
  2028. int
  2029. routers_have_same_or_addrs(const routerinfo_t *r1, const routerinfo_t *r2)
  2030. {
  2031. return r1->addr == r2->addr && r1->or_port == r2->or_port &&
  2032. tor_addr_eq(&r1->ipv6_addr, &r2->ipv6_addr) &&
  2033. r1->ipv6_orport == r2->ipv6_orport;
  2034. }
  2035. /** Reset all internal variables used to count failed downloads of network
  2036. * status objects. */
  2037. void
  2038. router_reset_status_download_failures(void)
  2039. {
  2040. mark_all_dirservers_up(fallback_dir_servers);
  2041. }
  2042. /** Given a <b>router</b>, add every node_t in its family (including the
  2043. * node itself!) to <b>sl</b>.
  2044. *
  2045. * Note the type mismatch: This function takes a routerinfo, but adds nodes
  2046. * to the smartlist!
  2047. */
  2048. static void
  2049. routerlist_add_node_and_family(smartlist_t *sl, const routerinfo_t *router)
  2050. {
  2051. /* XXXX MOVE ? */
  2052. node_t fake_node;
  2053. const node_t *node = node_get_by_id(router->cache_info.identity_digest);;
  2054. if (node == NULL) {
  2055. memset(&fake_node, 0, sizeof(fake_node));
  2056. fake_node.ri = (routerinfo_t *)router;
  2057. memcpy(fake_node.identity, router->cache_info.identity_digest, DIGEST_LEN);
  2058. node = &fake_node;
  2059. }
  2060. nodelist_add_node_and_family(sl, node);
  2061. }
  2062. /** Add every suitable node from our nodelist to <b>sl</b>, so that
  2063. * we can pick a node for a circuit.
  2064. */
  2065. void
  2066. router_add_running_nodes_to_smartlist(smartlist_t *sl, int allow_invalid,
  2067. int need_uptime, int need_capacity,
  2068. int need_guard, int need_desc,
  2069. int pref_addr, int direct_conn)
  2070. {
  2071. const int check_reach = !router_skip_or_reachability(get_options(),
  2072. pref_addr);
  2073. /* XXXX MOVE */
  2074. SMARTLIST_FOREACH_BEGIN(nodelist_get_list(), const node_t *, node) {
  2075. if (!node->is_running ||
  2076. (!node->is_valid && !allow_invalid))
  2077. continue;
  2078. if (need_desc && !(node->ri || (node->rs && node->md)))
  2079. continue;
  2080. if (node->ri && node->ri->purpose != ROUTER_PURPOSE_GENERAL)
  2081. continue;
  2082. if (node_is_unreliable(node, need_uptime, need_capacity, need_guard))
  2083. continue;
  2084. /* Don't choose nodes if we are certain they can't do EXTEND2 cells */
  2085. if (node->rs && !routerstatus_version_supports_extend2_cells(node->rs, 1))
  2086. continue;
  2087. /* Don't choose nodes if we are certain they can't do ntor. */
  2088. if ((node->ri || node->md) && !node_has_curve25519_onion_key(node))
  2089. continue;
  2090. /* Choose a node with an OR address that matches the firewall rules */
  2091. if (direct_conn && check_reach &&
  2092. !fascist_firewall_allows_node(node,
  2093. FIREWALL_OR_CONNECTION,
  2094. pref_addr))
  2095. continue;
  2096. smartlist_add(sl, (void *)node);
  2097. } SMARTLIST_FOREACH_END(node);
  2098. }
  2099. /** Look through the routerlist until we find a router that has my key.
  2100. Return it. */
  2101. const routerinfo_t *
  2102. routerlist_find_my_routerinfo(void)
  2103. {
  2104. if (!routerlist)
  2105. return NULL;
  2106. SMARTLIST_FOREACH(routerlist->routers, routerinfo_t *, router,
  2107. {
  2108. if (router_is_me(router))
  2109. return router;
  2110. });
  2111. return NULL;
  2112. }
  2113. /** Return the smaller of the router's configured BandwidthRate
  2114. * and its advertised capacity. */
  2115. uint32_t
  2116. router_get_advertised_bandwidth(const routerinfo_t *router)
  2117. {
  2118. if (router->bandwidthcapacity < router->bandwidthrate)
  2119. return router->bandwidthcapacity;
  2120. return router->bandwidthrate;
  2121. }
  2122. /** Do not weight any declared bandwidth more than this much when picking
  2123. * routers by bandwidth. */
  2124. #define DEFAULT_MAX_BELIEVABLE_BANDWIDTH 10000000 /* 10 MB/sec */
  2125. /** Return the smaller of the router's configured BandwidthRate
  2126. * and its advertised capacity, capped by max-believe-bw. */
  2127. uint32_t
  2128. router_get_advertised_bandwidth_capped(const routerinfo_t *router)
  2129. {
  2130. uint32_t result = router->bandwidthcapacity;
  2131. if (result > router->bandwidthrate)
  2132. result = router->bandwidthrate;
  2133. if (result > DEFAULT_MAX_BELIEVABLE_BANDWIDTH)
  2134. result = DEFAULT_MAX_BELIEVABLE_BANDWIDTH;
  2135. return result;
  2136. }
  2137. /** Given an array of double/uint64_t unions that are currently being used as
  2138. * doubles, convert them to uint64_t, and try to scale them linearly so as to
  2139. * much of the range of uint64_t. If <b>total_out</b> is provided, set it to
  2140. * the sum of all elements in the array _before_ scaling. */
  2141. STATIC void
  2142. scale_array_elements_to_u64(uint64_t *entries_out, const double *entries_in,
  2143. int n_entries,
  2144. uint64_t *total_out)
  2145. {
  2146. double total = 0.0;
  2147. double scale_factor = 0.0;
  2148. int i;
  2149. for (i = 0; i < n_entries; ++i)
  2150. total += entries_in[i];
  2151. if (total > 0.0) {
  2152. scale_factor = ((double)INT64_MAX) / total;
  2153. scale_factor /= 4.0; /* make sure we're very far away from overflowing */
  2154. }
  2155. for (i = 0; i < n_entries; ++i)
  2156. entries_out[i] = tor_llround(entries_in[i] * scale_factor);
  2157. if (total_out)
  2158. *total_out = (uint64_t) total;
  2159. }
  2160. /** Pick a random element of <b>n_entries</b>-element array <b>entries</b>,
  2161. * choosing each element with a probability proportional to its (uint64_t)
  2162. * value, and return the index of that element. If all elements are 0, choose
  2163. * an index at random. Return -1 on error.
  2164. */
  2165. STATIC int
  2166. choose_array_element_by_weight(const uint64_t *entries, int n_entries)
  2167. {
  2168. int i;
  2169. uint64_t rand_val;
  2170. uint64_t total = 0;
  2171. for (i = 0; i < n_entries; ++i)
  2172. total += entries[i];
  2173. if (n_entries < 1)
  2174. return -1;
  2175. if (total == 0)
  2176. return crypto_rand_int(n_entries);
  2177. tor_assert(total < INT64_MAX);
  2178. rand_val = crypto_rand_uint64(total);
  2179. return select_array_member_cumulative_timei(
  2180. entries, n_entries, total, rand_val);
  2181. }
  2182. /** When weighting bridges, enforce these values as lower and upper
  2183. * bound for believable bandwidth, because there is no way for us
  2184. * to verify a bridge's bandwidth currently. */
  2185. #define BRIDGE_MIN_BELIEVABLE_BANDWIDTH 20000 /* 20 kB/sec */
  2186. #define BRIDGE_MAX_BELIEVABLE_BANDWIDTH 100000 /* 100 kB/sec */
  2187. /** Return the smaller of the router's configured BandwidthRate
  2188. * and its advertised capacity, making sure to stay within the
  2189. * interval between bridge-min-believe-bw and
  2190. * bridge-max-believe-bw. */
  2191. static uint32_t
  2192. bridge_get_advertised_bandwidth_bounded(routerinfo_t *router)
  2193. {
  2194. uint32_t result = router->bandwidthcapacity;
  2195. if (result > router->bandwidthrate)
  2196. result = router->bandwidthrate;
  2197. if (result > BRIDGE_MAX_BELIEVABLE_BANDWIDTH)
  2198. result = BRIDGE_MAX_BELIEVABLE_BANDWIDTH;
  2199. else if (result < BRIDGE_MIN_BELIEVABLE_BANDWIDTH)
  2200. result = BRIDGE_MIN_BELIEVABLE_BANDWIDTH;
  2201. return result;
  2202. }
  2203. /** Return bw*1000, unless bw*1000 would overflow, in which case return
  2204. * INT32_MAX. */
  2205. static inline int32_t
  2206. kb_to_bytes(uint32_t bw)
  2207. {
  2208. return (bw > (INT32_MAX/1000)) ? INT32_MAX : bw*1000;
  2209. }
  2210. /** Helper function:
  2211. * choose a random element of smartlist <b>sl</b> of nodes, weighted by
  2212. * the advertised bandwidth of each element using the consensus
  2213. * bandwidth weights.
  2214. *
  2215. * If <b>rule</b>==WEIGHT_FOR_EXIT. we're picking an exit node: consider all
  2216. * nodes' bandwidth equally regardless of their Exit status, since there may
  2217. * be some in the list because they exit to obscure ports. If
  2218. * <b>rule</b>==NO_WEIGHTING, we're picking a non-exit node: weight
  2219. * exit-node's bandwidth less depending on the smallness of the fraction of
  2220. * Exit-to-total bandwidth. If <b>rule</b>==WEIGHT_FOR_GUARD, we're picking a
  2221. * guard node: consider all guard's bandwidth equally. Otherwise, weight
  2222. * guards proportionally less.
  2223. */
  2224. static const node_t *
  2225. smartlist_choose_node_by_bandwidth_weights(const smartlist_t *sl,
  2226. bandwidth_weight_rule_t rule)
  2227. {
  2228. double *bandwidths_dbl=NULL;
  2229. uint64_t *bandwidths_u64=NULL;
  2230. if (compute_weighted_bandwidths(sl, rule, &bandwidths_dbl) < 0)
  2231. return NULL;
  2232. bandwidths_u64 = tor_calloc(smartlist_len(sl), sizeof(uint64_t));
  2233. scale_array_elements_to_u64(bandwidths_u64, bandwidths_dbl,
  2234. smartlist_len(sl), NULL);
  2235. {
  2236. int idx = choose_array_element_by_weight(bandwidths_u64,
  2237. smartlist_len(sl));
  2238. tor_free(bandwidths_dbl);
  2239. tor_free(bandwidths_u64);
  2240. return idx < 0 ? NULL : smartlist_get(sl, idx);
  2241. }
  2242. }
  2243. /** Given a list of routers and a weighting rule as in
  2244. * smartlist_choose_node_by_bandwidth_weights, compute weighted bandwidth
  2245. * values for each node and store them in a freshly allocated
  2246. * *<b>bandwidths_out</b> of the same length as <b>sl</b>, and holding results
  2247. * as doubles. Return 0 on success, -1 on failure. */
  2248. static int
  2249. compute_weighted_bandwidths(const smartlist_t *sl,
  2250. bandwidth_weight_rule_t rule,
  2251. double **bandwidths_out)
  2252. {
  2253. int64_t weight_scale;
  2254. double Wg = -1, Wm = -1, We = -1, Wd = -1;
  2255. double Wgb = -1, Wmb = -1, Web = -1, Wdb = -1;
  2256. uint64_t weighted_bw = 0;
  2257. guardfraction_bandwidth_t guardfraction_bw;
  2258. double *bandwidths;
  2259. /* Can't choose exit and guard at same time */
  2260. tor_assert(rule == NO_WEIGHTING ||
  2261. rule == WEIGHT_FOR_EXIT ||
  2262. rule == WEIGHT_FOR_GUARD ||
  2263. rule == WEIGHT_FOR_MID ||
  2264. rule == WEIGHT_FOR_DIR);
  2265. if (smartlist_len(sl) == 0) {
  2266. log_info(LD_CIRC,
  2267. "Empty routerlist passed in to consensus weight node "
  2268. "selection for rule %s",
  2269. bandwidth_weight_rule_to_string(rule));
  2270. return -1;
  2271. }
  2272. weight_scale = networkstatus_get_weight_scale_param(NULL);
  2273. if (rule == WEIGHT_FOR_GUARD) {
  2274. Wg = networkstatus_get_bw_weight(NULL, "Wgg", -1);
  2275. Wm = networkstatus_get_bw_weight(NULL, "Wgm", -1); /* Bridges */
  2276. We = 0;
  2277. Wd = networkstatus_get_bw_weight(NULL, "Wgd", -1);
  2278. Wgb = networkstatus_get_bw_weight(NULL, "Wgb", -1);
  2279. Wmb = networkstatus_get_bw_weight(NULL, "Wmb", -1);
  2280. Web = networkstatus_get_bw_weight(NULL, "Web", -1);
  2281. Wdb = networkstatus_get_bw_weight(NULL, "Wdb", -1);
  2282. } else if (rule == WEIGHT_FOR_MID) {
  2283. Wg = networkstatus_get_bw_weight(NULL, "Wmg", -1);
  2284. Wm = networkstatus_get_bw_weight(NULL, "Wmm", -1);
  2285. We = networkstatus_get_bw_weight(NULL, "Wme", -1);
  2286. Wd = networkstatus_get_bw_weight(NULL, "Wmd", -1);
  2287. Wgb = networkstatus_get_bw_weight(NULL, "Wgb", -1);
  2288. Wmb = networkstatus_get_bw_weight(NULL, "Wmb", -1);
  2289. Web = networkstatus_get_bw_weight(NULL, "Web", -1);
  2290. Wdb = networkstatus_get_bw_weight(NULL, "Wdb", -1);
  2291. } else if (rule == WEIGHT_FOR_EXIT) {
  2292. // Guards CAN be exits if they have weird exit policies
  2293. // They are d then I guess...
  2294. We = networkstatus_get_bw_weight(NULL, "Wee", -1);
  2295. Wm = networkstatus_get_bw_weight(NULL, "Wem", -1); /* Odd exit policies */
  2296. Wd = networkstatus_get_bw_weight(NULL, "Wed", -1);
  2297. Wg = networkstatus_get_bw_weight(NULL, "Weg", -1); /* Odd exit policies */
  2298. Wgb = networkstatus_get_bw_weight(NULL, "Wgb", -1);
  2299. Wmb = networkstatus_get_bw_weight(NULL, "Wmb", -1);
  2300. Web = networkstatus_get_bw_weight(NULL, "Web", -1);
  2301. Wdb = networkstatus_get_bw_weight(NULL, "Wdb", -1);
  2302. } else if (rule == WEIGHT_FOR_DIR) {
  2303. We = networkstatus_get_bw_weight(NULL, "Wbe", -1);
  2304. Wm = networkstatus_get_bw_weight(NULL, "Wbm", -1);
  2305. Wd = networkstatus_get_bw_weight(NULL, "Wbd", -1);
  2306. Wg = networkstatus_get_bw_weight(NULL, "Wbg", -1);
  2307. Wgb = Wmb = Web = Wdb = weight_scale;
  2308. } else if (rule == NO_WEIGHTING) {
  2309. Wg = Wm = We = Wd = weight_scale;
  2310. Wgb = Wmb = Web = Wdb = weight_scale;
  2311. }
  2312. if (Wg < 0 || Wm < 0 || We < 0 || Wd < 0 || Wgb < 0 || Wmb < 0 || Wdb < 0
  2313. || Web < 0) {
  2314. log_debug(LD_CIRC,
  2315. "Got negative bandwidth weights. Defaulting to naive selection"
  2316. " algorithm.");
  2317. Wg = Wm = We = Wd = weight_scale;
  2318. Wgb = Wmb = Web = Wdb = weight_scale;
  2319. }
  2320. Wg /= weight_scale;
  2321. Wm /= weight_scale;
  2322. We /= weight_scale;
  2323. Wd /= weight_scale;
  2324. Wgb /= weight_scale;
  2325. Wmb /= weight_scale;
  2326. Web /= weight_scale;
  2327. Wdb /= weight_scale;
  2328. bandwidths = tor_calloc(smartlist_len(sl), sizeof(double));
  2329. // Cycle through smartlist and total the bandwidth.
  2330. static int warned_missing_bw = 0;
  2331. SMARTLIST_FOREACH_BEGIN(sl, const node_t *, node) {
  2332. int is_exit = 0, is_guard = 0, is_dir = 0, this_bw = 0;
  2333. double weight = 1;
  2334. double weight_without_guard_flag = 0; /* Used for guardfraction */
  2335. double final_weight = 0;
  2336. is_exit = node->is_exit && ! node->is_bad_exit;
  2337. is_guard = node->is_possible_guard;
  2338. is_dir = node_is_dir(node);
  2339. if (node->rs) {
  2340. if (!node->rs->has_bandwidth) {
  2341. /* This should never happen, unless all the authorites downgrade
  2342. * to 0.2.0 or rogue routerstatuses get inserted into our consensus. */
  2343. if (! warned_missing_bw) {
  2344. log_warn(LD_BUG,
  2345. "Consensus is missing some bandwidths. Using a naive "
  2346. "router selection algorithm");
  2347. warned_missing_bw = 1;
  2348. }
  2349. this_bw = 30000; /* Chosen arbitrarily */
  2350. } else {
  2351. this_bw = kb_to_bytes(node->rs->bandwidth_kb);
  2352. }
  2353. } else if (node->ri) {
  2354. /* bridge or other descriptor not in our consensus */
  2355. this_bw = bridge_get_advertised_bandwidth_bounded(node->ri);
  2356. } else {
  2357. /* We can't use this one. */
  2358. continue;
  2359. }
  2360. if (is_guard && is_exit) {
  2361. weight = (is_dir ? Wdb*Wd : Wd);
  2362. weight_without_guard_flag = (is_dir ? Web*We : We);
  2363. } else if (is_guard) {
  2364. weight = (is_dir ? Wgb*Wg : Wg);
  2365. weight_without_guard_flag = (is_dir ? Wmb*Wm : Wm);
  2366. } else if (is_exit) {
  2367. weight = (is_dir ? Web*We : We);
  2368. } else { // middle
  2369. weight = (is_dir ? Wmb*Wm : Wm);
  2370. }
  2371. /* These should be impossible; but overflows here would be bad, so let's
  2372. * make sure. */
  2373. if (this_bw < 0)
  2374. this_bw = 0;
  2375. if (weight < 0.0)
  2376. weight = 0.0;
  2377. if (weight_without_guard_flag < 0.0)
  2378. weight_without_guard_flag = 0.0;
  2379. /* If guardfraction information is available in the consensus, we
  2380. * want to calculate this router's bandwidth according to its
  2381. * guardfraction. Quoting from proposal236:
  2382. *
  2383. * Let Wpf denote the weight from the 'bandwidth-weights' line a
  2384. * client would apply to N for position p if it had the guard
  2385. * flag, Wpn the weight if it did not have the guard flag, and B the
  2386. * measured bandwidth of N in the consensus. Then instead of choosing
  2387. * N for position p proportionally to Wpf*B or Wpn*B, clients should
  2388. * choose N proportionally to F*Wpf*B + (1-F)*Wpn*B.
  2389. */
  2390. if (node->rs && node->rs->has_guardfraction && rule != WEIGHT_FOR_GUARD) {
  2391. /* XXX The assert should actually check for is_guard. However,
  2392. * that crashes dirauths because of #13297. This should be
  2393. * equivalent: */
  2394. tor_assert(node->rs->is_possible_guard);
  2395. guard_get_guardfraction_bandwidth(&guardfraction_bw,
  2396. this_bw,
  2397. node->rs->guardfraction_percentage);
  2398. /* Calculate final_weight = F*Wpf*B + (1-F)*Wpn*B */
  2399. final_weight =
  2400. guardfraction_bw.guard_bw * weight +
  2401. guardfraction_bw.non_guard_bw * weight_without_guard_flag;
  2402. log_debug(LD_GENERAL, "%s: Guardfraction weight %f instead of %f (%s)",
  2403. node->rs->nickname, final_weight, weight*this_bw,
  2404. bandwidth_weight_rule_to_string(rule));
  2405. } else { /* no guardfraction information. calculate the weight normally. */
  2406. final_weight = weight*this_bw;
  2407. }
  2408. bandwidths[node_sl_idx] = final_weight + 0.5;
  2409. } SMARTLIST_FOREACH_END(node);
  2410. log_debug(LD_CIRC, "Generated weighted bandwidths for rule %s based "
  2411. "on weights "
  2412. "Wg=%f Wm=%f We=%f Wd=%f with total bw "U64_FORMAT,
  2413. bandwidth_weight_rule_to_string(rule),
  2414. Wg, Wm, We, Wd, U64_PRINTF_ARG(weighted_bw));
  2415. *bandwidths_out = bandwidths;
  2416. return 0;
  2417. }
  2418. /** For all nodes in <b>sl</b>, return the fraction of those nodes, weighted
  2419. * by their weighted bandwidths with rule <b>rule</b>, for which we have
  2420. * descriptors. */
  2421. double
  2422. frac_nodes_with_descriptors(const smartlist_t *sl,
  2423. bandwidth_weight_rule_t rule)
  2424. {
  2425. double *bandwidths = NULL;
  2426. double total, present;
  2427. if (smartlist_len(sl) == 0)
  2428. return 0.0;
  2429. if (compute_weighted_bandwidths(sl, rule, &bandwidths) < 0) {
  2430. int n_with_descs = 0;
  2431. SMARTLIST_FOREACH(sl, const node_t *, node, {
  2432. if (node_has_descriptor(node))
  2433. n_with_descs++;
  2434. });
  2435. return ((double)n_with_descs) / (double)smartlist_len(sl);
  2436. }
  2437. total = present = 0.0;
  2438. SMARTLIST_FOREACH_BEGIN(sl, const node_t *, node) {
  2439. const double bw = bandwidths[node_sl_idx];
  2440. total += bw;
  2441. if (node_has_descriptor(node))
  2442. present += bw;
  2443. } SMARTLIST_FOREACH_END(node);
  2444. tor_free(bandwidths);
  2445. if (total < 1.0)
  2446. return 0;
  2447. return present / total;
  2448. }
  2449. /** Choose a random element of status list <b>sl</b>, weighted by
  2450. * the advertised bandwidth of each node */
  2451. const node_t *
  2452. node_sl_choose_by_bandwidth(const smartlist_t *sl,
  2453. bandwidth_weight_rule_t rule)
  2454. { /*XXXX MOVE */
  2455. return smartlist_choose_node_by_bandwidth_weights(sl, rule);
  2456. }
  2457. /** Return a random running node from the nodelist. Never
  2458. * pick a node that is in
  2459. * <b>excludedsmartlist</b>, or which matches <b>excludedset</b>,
  2460. * even if they are the only nodes available.
  2461. * If <b>CRN_NEED_UPTIME</b> is set in flags and any router has more than
  2462. * a minimum uptime, return one of those.
  2463. * If <b>CRN_NEED_CAPACITY</b> is set in flags, weight your choice by the
  2464. * advertised capacity of each router.
  2465. * If <b>CRN_ALLOW_INVALID</b> is not set in flags, consider only Valid
  2466. * routers.
  2467. * If <b>CRN_NEED_GUARD</b> is set in flags, consider only Guard routers.
  2468. * If <b>CRN_WEIGHT_AS_EXIT</b> is set in flags, we weight bandwidths as if
  2469. * picking an exit node, otherwise we weight bandwidths for picking a relay
  2470. * node (that is, possibly discounting exit nodes).
  2471. * If <b>CRN_NEED_DESC</b> is set in flags, we only consider nodes that
  2472. * have a routerinfo or microdescriptor -- that is, enough info to be
  2473. * used to build a circuit.
  2474. * If <b>CRN_PREF_ADDR</b> is set in flags, we only consider nodes that
  2475. * have an address that is preferred by the ClientPreferIPv6ORPort setting
  2476. * (regardless of this flag, we exclude nodes that aren't allowed by the
  2477. * firewall, including ClientUseIPv4 0 and fascist_firewall_use_ipv6() == 0).
  2478. */
  2479. const node_t *
  2480. router_choose_random_node(smartlist_t *excludedsmartlist,
  2481. routerset_t *excludedset,
  2482. router_crn_flags_t flags)
  2483. { /* XXXX MOVE */
  2484. const int need_uptime = (flags & CRN_NEED_UPTIME) != 0;
  2485. const int need_capacity = (flags & CRN_NEED_CAPACITY) != 0;
  2486. const int need_guard = (flags & CRN_NEED_GUARD) != 0;
  2487. const int allow_invalid = (flags & CRN_ALLOW_INVALID) != 0;
  2488. const int weight_for_exit = (flags & CRN_WEIGHT_AS_EXIT) != 0;
  2489. const int need_desc = (flags & CRN_NEED_DESC) != 0;
  2490. const int pref_addr = (flags & CRN_PREF_ADDR) != 0;
  2491. const int direct_conn = (flags & CRN_DIRECT_CONN) != 0;
  2492. smartlist_t *sl=smartlist_new(),
  2493. *excludednodes=smartlist_new();
  2494. const node_t *choice = NULL;
  2495. const routerinfo_t *r;
  2496. bandwidth_weight_rule_t rule;
  2497. tor_assert(!(weight_for_exit && need_guard));
  2498. rule = weight_for_exit ? WEIGHT_FOR_EXIT :
  2499. (need_guard ? WEIGHT_FOR_GUARD : WEIGHT_FOR_MID);
  2500. /* Exclude relays that allow single hop exit circuits, if the user
  2501. * wants to (such relays might be risky) */
  2502. if (get_options()->ExcludeSingleHopRelays) {
  2503. SMARTLIST_FOREACH(nodelist_get_list(), node_t *, node,
  2504. if (node_allows_single_hop_exits(node)) {
  2505. smartlist_add(excludednodes, node);
  2506. });
  2507. }
  2508. if ((r = routerlist_find_my_routerinfo()))
  2509. routerlist_add_node_and_family(excludednodes, r);
  2510. router_add_running_nodes_to_smartlist(sl, allow_invalid,
  2511. need_uptime, need_capacity,
  2512. need_guard, need_desc, pref_addr,
  2513. direct_conn);
  2514. log_debug(LD_CIRC,
  2515. "We found %d running nodes.",
  2516. smartlist_len(sl));
  2517. smartlist_subtract(sl,excludednodes);
  2518. log_debug(LD_CIRC,
  2519. "We removed %d excludednodes, leaving %d nodes.",
  2520. smartlist_len(excludednodes),
  2521. smartlist_len(sl));
  2522. if (excludedsmartlist) {
  2523. smartlist_subtract(sl,excludedsmartlist);
  2524. log_debug(LD_CIRC,
  2525. "We removed %d excludedsmartlist, leaving %d nodes.",
  2526. smartlist_len(excludedsmartlist),
  2527. smartlist_len(sl));
  2528. }
  2529. if (excludedset) {
  2530. routerset_subtract_nodes(sl,excludedset);
  2531. log_debug(LD_CIRC,
  2532. "We removed excludedset, leaving %d nodes.",
  2533. smartlist_len(sl));
  2534. }
  2535. // Always weight by bandwidth
  2536. choice = node_sl_choose_by_bandwidth(sl, rule);
  2537. smartlist_free(sl);
  2538. if (!choice && (need_uptime || need_capacity || need_guard || pref_addr)) {
  2539. /* try once more -- recurse but with fewer restrictions. */
  2540. log_info(LD_CIRC,
  2541. "We couldn't find any live%s%s%s routers; falling back "
  2542. "to list of all routers.",
  2543. need_capacity?", fast":"",
  2544. need_uptime?", stable":"",
  2545. need_guard?", guard":"");
  2546. flags &= ~ (CRN_NEED_UPTIME|CRN_NEED_CAPACITY|CRN_NEED_GUARD|
  2547. CRN_PREF_ADDR);
  2548. choice = router_choose_random_node(
  2549. excludedsmartlist, excludedset, flags);
  2550. }
  2551. smartlist_free(excludednodes);
  2552. if (!choice) {
  2553. log_warn(LD_CIRC,
  2554. "No available nodes when trying to choose node. Failing.");
  2555. }
  2556. return choice;
  2557. }
  2558. /** Helper: given an extended nickname in <b>hexdigest</b> try to decode it.
  2559. * Return 0 on success, -1 on failure. Store the result into the
  2560. * DIGEST_LEN-byte buffer at <b>digest_out</b>, the single character at
  2561. * <b>nickname_qualifier_char_out</b>, and the MAXNICKNAME_LEN+1-byte buffer
  2562. * at <b>nickname_out</b>.
  2563. *
  2564. * The recognized format is:
  2565. * HexName = Dollar? HexDigest NamePart?
  2566. * Dollar = '?'
  2567. * HexDigest = HexChar*20
  2568. * HexChar = 'a'..'f' | 'A'..'F' | '0'..'9'
  2569. * NamePart = QualChar Name
  2570. * QualChar = '=' | '~'
  2571. * Name = NameChar*(1..MAX_NICKNAME_LEN)
  2572. * NameChar = Any ASCII alphanumeric character
  2573. */
  2574. int
  2575. hex_digest_nickname_decode(const char *hexdigest,
  2576. char *digest_out,
  2577. char *nickname_qualifier_char_out,
  2578. char *nickname_out)
  2579. {
  2580. size_t len;
  2581. tor_assert(hexdigest);
  2582. if (hexdigest[0] == '$')
  2583. ++hexdigest;
  2584. len = strlen(hexdigest);
  2585. if (len < HEX_DIGEST_LEN) {
  2586. return -1;
  2587. } else if (len > HEX_DIGEST_LEN && (hexdigest[HEX_DIGEST_LEN] == '=' ||
  2588. hexdigest[HEX_DIGEST_LEN] == '~') &&
  2589. len <= HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN) {
  2590. *nickname_qualifier_char_out = hexdigest[HEX_DIGEST_LEN];
  2591. strlcpy(nickname_out, hexdigest+HEX_DIGEST_LEN+1 , MAX_NICKNAME_LEN+1);
  2592. } else if (len == HEX_DIGEST_LEN) {
  2593. ;
  2594. } else {
  2595. return -1;
  2596. }
  2597. if (base16_decode(digest_out, DIGEST_LEN,
  2598. hexdigest, HEX_DIGEST_LEN) != DIGEST_LEN)
  2599. return -1;
  2600. return 0;
  2601. }
  2602. /** Helper: Return true iff the <b>identity_digest</b> and <b>nickname</b>
  2603. * combination of a router, encoded in hexadecimal, matches <b>hexdigest</b>
  2604. * (which is optionally prefixed with a single dollar sign). Return false if
  2605. * <b>hexdigest</b> is malformed, or it doesn't match. */
  2606. int
  2607. hex_digest_nickname_matches(const char *hexdigest, const char *identity_digest,
  2608. const char *nickname, int is_named)
  2609. {
  2610. char digest[DIGEST_LEN];
  2611. char nn_char='\0';
  2612. char nn_buf[MAX_NICKNAME_LEN+1];
  2613. if (hex_digest_nickname_decode(hexdigest, digest, &nn_char, nn_buf) == -1)
  2614. return 0;
  2615. if (nn_char == '=' || nn_char == '~') {
  2616. if (!nickname)
  2617. return 0;
  2618. if (strcasecmp(nn_buf, nickname))
  2619. return 0;
  2620. if (nn_char == '=' && !is_named)
  2621. return 0;
  2622. }
  2623. return tor_memeq(digest, identity_digest, DIGEST_LEN);
  2624. }
  2625. /** Return true iff <b>router</b> is listed as named in the current
  2626. * consensus. */
  2627. int
  2628. router_is_named(const routerinfo_t *router)
  2629. {
  2630. const char *digest =
  2631. networkstatus_get_router_digest_by_nickname(router->nickname);
  2632. return (digest &&
  2633. tor_memeq(digest, router->cache_info.identity_digest, DIGEST_LEN));
  2634. }
  2635. /** Return true iff <b>digest</b> is the digest of the identity key of a
  2636. * trusted directory matching at least one bit of <b>type</b>. If <b>type</b>
  2637. * is zero (NO_DIRINFO), or ALL_DIRINFO, any authority is okay. */
  2638. int
  2639. router_digest_is_trusted_dir_type(const char *digest, dirinfo_type_t type)
  2640. {
  2641. if (!trusted_dir_servers)
  2642. return 0;
  2643. if (authdir_mode(get_options()) && router_digest_is_me(digest))
  2644. return 1;
  2645. SMARTLIST_FOREACH(trusted_dir_servers, dir_server_t *, ent,
  2646. if (tor_memeq(digest, ent->digest, DIGEST_LEN)) {
  2647. return (!type) || ((type & ent->type) != 0);
  2648. });
  2649. return 0;
  2650. }
  2651. /** If hexdigest is correctly formed, base16_decode it into
  2652. * digest, which must have DIGEST_LEN space in it.
  2653. * Return 0 on success, -1 on failure.
  2654. */
  2655. int
  2656. hexdigest_to_digest(const char *hexdigest, char *digest)
  2657. {
  2658. if (hexdigest[0]=='$')
  2659. ++hexdigest;
  2660. if (strlen(hexdigest) < HEX_DIGEST_LEN ||
  2661. base16_decode(digest,DIGEST_LEN,hexdigest,HEX_DIGEST_LEN) != DIGEST_LEN)
  2662. return -1;
  2663. return 0;
  2664. }
  2665. /** As router_get_by_id_digest,but return a pointer that you're allowed to
  2666. * modify */
  2667. routerinfo_t *
  2668. router_get_mutable_by_digest(const char *digest)
  2669. {
  2670. tor_assert(digest);
  2671. if (!routerlist) return NULL;
  2672. // routerlist_assert_ok(routerlist);
  2673. return rimap_get(routerlist->identity_map, digest);
  2674. }
  2675. /** Return the router in our routerlist whose 20-byte key digest
  2676. * is <b>digest</b>. Return NULL if no such router is known. */
  2677. const routerinfo_t *
  2678. router_get_by_id_digest(const char *digest)
  2679. {
  2680. return router_get_mutable_by_digest(digest);
  2681. }
  2682. /** Return the router in our routerlist whose 20-byte descriptor
  2683. * is <b>digest</b>. Return NULL if no such router is known. */
  2684. signed_descriptor_t *
  2685. router_get_by_descriptor_digest(const char *digest)
  2686. {
  2687. tor_assert(digest);
  2688. if (!routerlist) return NULL;
  2689. return sdmap_get(routerlist->desc_digest_map, digest);
  2690. }
  2691. /** Return the signed descriptor for the router in our routerlist whose
  2692. * 20-byte extra-info digest is <b>digest</b>. Return NULL if no such router
  2693. * is known. */
  2694. MOCK_IMPL(signed_descriptor_t *,
  2695. router_get_by_extrainfo_digest,(const char *digest))
  2696. {
  2697. tor_assert(digest);
  2698. if (!routerlist) return NULL;
  2699. return sdmap_get(routerlist->desc_by_eid_map, digest);
  2700. }
  2701. /** Return the signed descriptor for the extrainfo_t in our routerlist whose
  2702. * extra-info-digest is <b>digest</b>. Return NULL if no such extra-info
  2703. * document is known. */
  2704. signed_descriptor_t *
  2705. extrainfo_get_by_descriptor_digest(const char *digest)
  2706. {
  2707. extrainfo_t *ei;
  2708. tor_assert(digest);
  2709. if (!routerlist) return NULL;
  2710. ei = eimap_get(routerlist->extra_info_map, digest);
  2711. return ei ? &ei->cache_info : NULL;
  2712. }
  2713. /** Return a pointer to the signed textual representation of a descriptor.
  2714. * The returned string is not guaranteed to be NUL-terminated: the string's
  2715. * length will be in desc-\>signed_descriptor_len.
  2716. *
  2717. * If <b>with_annotations</b> is set, the returned string will include
  2718. * the annotations
  2719. * (if any) preceding the descriptor. This will increase the length of the
  2720. * string by desc-\>annotations_len.
  2721. *
  2722. * The caller must not free the string returned.
  2723. */
  2724. static const char *
  2725. signed_descriptor_get_body_impl(const signed_descriptor_t *desc,
  2726. int with_annotations)
  2727. {
  2728. const char *r = NULL;
  2729. size_t len = desc->signed_descriptor_len;
  2730. off_t offset = desc->saved_offset;
  2731. if (with_annotations)
  2732. len += desc->annotations_len;
  2733. else
  2734. offset += desc->annotations_len;
  2735. tor_assert(len > 32);
  2736. if (desc->saved_location == SAVED_IN_CACHE && routerlist) {
  2737. desc_store_t *store = desc_get_store(router_get_routerlist(), desc);
  2738. if (store && store->mmap) {
  2739. tor_assert(desc->saved_offset + len <= store->mmap->size);
  2740. r = store->mmap->data + offset;
  2741. } else if (store) {
  2742. log_err(LD_DIR, "We couldn't read a descriptor that is supposedly "
  2743. "mmaped in our cache. Is another process running in our data "
  2744. "directory? Exiting.");
  2745. exit(1);
  2746. }
  2747. }
  2748. if (!r) /* no mmap, or not in cache. */
  2749. r = desc->signed_descriptor_body +
  2750. (with_annotations ? 0 : desc->annotations_len);
  2751. tor_assert(r);
  2752. if (!with_annotations) {
  2753. if (fast_memcmp("router ", r, 7) && fast_memcmp("extra-info ", r, 11)) {
  2754. char *cp = tor_strndup(r, 64);
  2755. log_err(LD_DIR, "descriptor at %p begins with unexpected string %s. "
  2756. "Is another process running in our data directory? Exiting.",
  2757. desc, escaped(cp));
  2758. exit(1);
  2759. }
  2760. }
  2761. return r;
  2762. }
  2763. /** Return a pointer to the signed textual representation of a descriptor.
  2764. * The returned string is not guaranteed to be NUL-terminated: the string's
  2765. * length will be in desc-\>signed_descriptor_len.
  2766. *
  2767. * The caller must not free the string returned.
  2768. */
  2769. const char *
  2770. signed_descriptor_get_body(const signed_descriptor_t *desc)
  2771. {
  2772. return signed_descriptor_get_body_impl(desc, 0);
  2773. }
  2774. /** As signed_descriptor_get_body(), but points to the beginning of the
  2775. * annotations section rather than the beginning of the descriptor. */
  2776. const char *
  2777. signed_descriptor_get_annotations(const signed_descriptor_t *desc)
  2778. {
  2779. return signed_descriptor_get_body_impl(desc, 1);
  2780. }
  2781. /** Return the current list of all known routers. */
  2782. routerlist_t *
  2783. router_get_routerlist(void)
  2784. {
  2785. if (PREDICT_UNLIKELY(!routerlist)) {
  2786. routerlist = tor_malloc_zero(sizeof(routerlist_t));
  2787. routerlist->routers = smartlist_new();
  2788. routerlist->old_routers = smartlist_new();
  2789. routerlist->identity_map = rimap_new();
  2790. routerlist->desc_digest_map = sdmap_new();
  2791. routerlist->desc_by_eid_map = sdmap_new();
  2792. routerlist->extra_info_map = eimap_new();
  2793. routerlist->desc_store.fname_base = "cached-descriptors";
  2794. routerlist->extrainfo_store.fname_base = "cached-extrainfo";
  2795. routerlist->desc_store.type = ROUTER_STORE;
  2796. routerlist->extrainfo_store.type = EXTRAINFO_STORE;
  2797. routerlist->desc_store.description = "router descriptors";
  2798. routerlist->extrainfo_store.description = "extra-info documents";
  2799. }
  2800. return routerlist;
  2801. }
  2802. /** Free all storage held by <b>router</b>. */
  2803. void
  2804. routerinfo_free(routerinfo_t *router)
  2805. {
  2806. if (!router)
  2807. return;
  2808. tor_free(router->cache_info.signed_descriptor_body);
  2809. tor_free(router->nickname);
  2810. tor_free(router->platform);
  2811. tor_free(router->protocol_list);
  2812. tor_free(router->contact_info);
  2813. if (router->onion_pkey)
  2814. crypto_pk_free(router->onion_pkey);
  2815. tor_free(router->onion_curve25519_pkey);
  2816. if (router->identity_pkey)
  2817. crypto_pk_free(router->identity_pkey);
  2818. tor_cert_free(router->cache_info.signing_key_cert);
  2819. if (router->declared_family) {
  2820. SMARTLIST_FOREACH(router->declared_family, char *, s, tor_free(s));
  2821. smartlist_free(router->declared_family);
  2822. }
  2823. addr_policy_list_free(router->exit_policy);
  2824. short_policy_free(router->ipv6_exit_policy);
  2825. memset(router, 77, sizeof(routerinfo_t));
  2826. tor_free(router);
  2827. }
  2828. /** Release all storage held by <b>extrainfo</b> */
  2829. void
  2830. extrainfo_free(extrainfo_t *extrainfo)
  2831. {
  2832. if (!extrainfo)
  2833. return;
  2834. tor_cert_free(extrainfo->cache_info.signing_key_cert);
  2835. tor_free(extrainfo->cache_info.signed_descriptor_body);
  2836. tor_free(extrainfo->pending_sig);
  2837. memset(extrainfo, 88, sizeof(extrainfo_t)); /* debug bad memory usage */
  2838. tor_free(extrainfo);
  2839. }
  2840. /** Release storage held by <b>sd</b>. */
  2841. static void
  2842. signed_descriptor_free(signed_descriptor_t *sd)
  2843. {
  2844. if (!sd)
  2845. return;
  2846. tor_free(sd->signed_descriptor_body);
  2847. tor_cert_free(sd->signing_key_cert);
  2848. memset(sd, 99, sizeof(signed_descriptor_t)); /* Debug bad mem usage */
  2849. tor_free(sd);
  2850. }
  2851. /** Reset the given signed descriptor <b>sd</b> by freeing the allocated
  2852. * memory inside the object and by zeroing its content. */
  2853. static void
  2854. signed_descriptor_reset(signed_descriptor_t *sd)
  2855. {
  2856. tor_assert(sd);
  2857. tor_free(sd->signed_descriptor_body);
  2858. tor_cert_free(sd->signing_key_cert);
  2859. memset(sd, 0, sizeof(*sd));
  2860. }
  2861. /** Copy src into dest, and steal all references inside src so that when
  2862. * we free src, we don't mess up dest. */
  2863. static void
  2864. signed_descriptor_move(signed_descriptor_t *dest,
  2865. signed_descriptor_t *src)
  2866. {
  2867. tor_assert(dest != src);
  2868. /* Cleanup destination object before overwriting it.*/
  2869. signed_descriptor_reset(dest);
  2870. memcpy(dest, src, sizeof(signed_descriptor_t));
  2871. src->signed_descriptor_body = NULL;
  2872. src->signing_key_cert = NULL;
  2873. dest->routerlist_index = -1;
  2874. }
  2875. /** Extract a signed_descriptor_t from a general routerinfo, and free the
  2876. * routerinfo.
  2877. */
  2878. static signed_descriptor_t *
  2879. signed_descriptor_from_routerinfo(routerinfo_t *ri)
  2880. {
  2881. signed_descriptor_t *sd;
  2882. tor_assert(ri->purpose == ROUTER_PURPOSE_GENERAL);
  2883. sd = tor_malloc_zero(sizeof(signed_descriptor_t));
  2884. signed_descriptor_move(sd, &ri->cache_info);
  2885. routerinfo_free(ri);
  2886. return sd;
  2887. }
  2888. /** Helper: free the storage held by the extrainfo_t in <b>e</b>. */
  2889. static void
  2890. extrainfo_free_(void *e)
  2891. {
  2892. extrainfo_free(e);
  2893. }
  2894. /** Free all storage held by a routerlist <b>rl</b>. */
  2895. void
  2896. routerlist_free(routerlist_t *rl)
  2897. {
  2898. if (!rl)
  2899. return;
  2900. rimap_free(rl->identity_map, NULL);
  2901. sdmap_free(rl->desc_digest_map, NULL);
  2902. sdmap_free(rl->desc_by_eid_map, NULL);
  2903. eimap_free(rl->extra_info_map, extrainfo_free_);
  2904. SMARTLIST_FOREACH(rl->routers, routerinfo_t *, r,
  2905. routerinfo_free(r));
  2906. SMARTLIST_FOREACH(rl->old_routers, signed_descriptor_t *, sd,
  2907. signed_descriptor_free(sd));
  2908. smartlist_free(rl->routers);
  2909. smartlist_free(rl->old_routers);
  2910. if (rl->desc_store.mmap) {
  2911. int res = tor_munmap_file(routerlist->desc_store.mmap);
  2912. if (res != 0) {
  2913. log_warn(LD_FS, "Failed to munmap routerlist->desc_store.mmap");
  2914. }
  2915. }
  2916. if (rl->extrainfo_store.mmap) {
  2917. int res = tor_munmap_file(routerlist->extrainfo_store.mmap);
  2918. if (res != 0) {
  2919. log_warn(LD_FS, "Failed to munmap routerlist->extrainfo_store.mmap");
  2920. }
  2921. }
  2922. tor_free(rl);
  2923. router_dir_info_changed();
  2924. }
  2925. /** Log information about how much memory is being used for routerlist,
  2926. * at log level <b>severity</b>. */
  2927. void
  2928. dump_routerlist_mem_usage(int severity)
  2929. {
  2930. uint64_t livedescs = 0;
  2931. uint64_t olddescs = 0;
  2932. if (!routerlist)
  2933. return;
  2934. SMARTLIST_FOREACH(routerlist->routers, routerinfo_t *, r,
  2935. livedescs += r->cache_info.signed_descriptor_len);
  2936. SMARTLIST_FOREACH(routerlist->old_routers, signed_descriptor_t *, sd,
  2937. olddescs += sd->signed_descriptor_len);
  2938. tor_log(severity, LD_DIR,
  2939. "In %d live descriptors: "U64_FORMAT" bytes. "
  2940. "In %d old descriptors: "U64_FORMAT" bytes.",
  2941. smartlist_len(routerlist->routers), U64_PRINTF_ARG(livedescs),
  2942. smartlist_len(routerlist->old_routers), U64_PRINTF_ARG(olddescs));
  2943. }
  2944. /** Debugging helper: If <b>idx</b> is nonnegative, assert that <b>ri</b> is
  2945. * in <b>sl</b> at position <b>idx</b>. Otherwise, search <b>sl</b> for
  2946. * <b>ri</b>. Return the index of <b>ri</b> in <b>sl</b>, or -1 if <b>ri</b>
  2947. * is not in <b>sl</b>. */
  2948. static inline int
  2949. routerlist_find_elt_(smartlist_t *sl, void *ri, int idx)
  2950. {
  2951. if (idx < 0) {
  2952. idx = -1;
  2953. SMARTLIST_FOREACH(sl, routerinfo_t *, r,
  2954. if (r == ri) {
  2955. idx = r_sl_idx;
  2956. break;
  2957. });
  2958. } else {
  2959. tor_assert(idx < smartlist_len(sl));
  2960. tor_assert(smartlist_get(sl, idx) == ri);
  2961. };
  2962. return idx;
  2963. }
  2964. /** Insert an item <b>ri</b> into the routerlist <b>rl</b>, updating indices
  2965. * as needed. There must be no previous member of <b>rl</b> with the same
  2966. * identity digest as <b>ri</b>: If there is, call routerlist_replace
  2967. * instead.
  2968. */
  2969. static void
  2970. routerlist_insert(routerlist_t *rl, routerinfo_t *ri)
  2971. {
  2972. routerinfo_t *ri_old;
  2973. signed_descriptor_t *sd_old;
  2974. {
  2975. const routerinfo_t *ri_generated = router_get_my_routerinfo();
  2976. tor_assert(ri_generated != ri);
  2977. }
  2978. tor_assert(ri->cache_info.routerlist_index == -1);
  2979. ri_old = rimap_set(rl->identity_map, ri->cache_info.identity_digest, ri);
  2980. tor_assert(!ri_old);
  2981. sd_old = sdmap_set(rl->desc_digest_map,
  2982. ri->cache_info.signed_descriptor_digest,
  2983. &(ri->cache_info));
  2984. if (sd_old) {
  2985. int idx = sd_old->routerlist_index;
  2986. sd_old->routerlist_index = -1;
  2987. smartlist_del(rl->old_routers, idx);
  2988. if (idx < smartlist_len(rl->old_routers)) {
  2989. signed_descriptor_t *d = smartlist_get(rl->old_routers, idx);
  2990. d->routerlist_index = idx;
  2991. }
  2992. rl->desc_store.bytes_dropped += sd_old->signed_descriptor_len;
  2993. sdmap_remove(rl->desc_by_eid_map, sd_old->extra_info_digest);
  2994. signed_descriptor_free(sd_old);
  2995. }
  2996. if (!tor_digest_is_zero(ri->cache_info.extra_info_digest))
  2997. sdmap_set(rl->desc_by_eid_map, ri->cache_info.extra_info_digest,
  2998. &ri->cache_info);
  2999. smartlist_add(rl->routers, ri);
  3000. ri->cache_info.routerlist_index = smartlist_len(rl->routers) - 1;
  3001. nodelist_set_routerinfo(ri, NULL);
  3002. router_dir_info_changed();
  3003. #ifdef DEBUG_ROUTERLIST
  3004. routerlist_assert_ok(rl);
  3005. #endif
  3006. }
  3007. /** Adds the extrainfo_t <b>ei</b> to the routerlist <b>rl</b>, if there is a
  3008. * corresponding router in rl-\>routers or rl-\>old_routers. Return the status
  3009. * of inserting <b>ei</b>. Free <b>ei</b> if it isn't inserted. */
  3010. MOCK_IMPL(STATIC was_router_added_t,
  3011. extrainfo_insert,(routerlist_t *rl, extrainfo_t *ei, int warn_if_incompatible))
  3012. {
  3013. was_router_added_t r;
  3014. const char *compatibility_error_msg;
  3015. routerinfo_t *ri = rimap_get(rl->identity_map,
  3016. ei->cache_info.identity_digest);
  3017. signed_descriptor_t *sd =
  3018. sdmap_get(rl->desc_by_eid_map, ei->cache_info.signed_descriptor_digest);
  3019. extrainfo_t *ei_tmp;
  3020. const int severity = warn_if_incompatible ? LOG_WARN : LOG_INFO;
  3021. {
  3022. extrainfo_t *ei_generated = router_get_my_extrainfo();
  3023. tor_assert(ei_generated != ei);
  3024. }
  3025. if (!ri) {
  3026. /* This router is unknown; we can't even verify the signature. Give up.*/
  3027. r = ROUTER_NOT_IN_CONSENSUS;
  3028. goto done;
  3029. }
  3030. if (! sd) {
  3031. /* The extrainfo router doesn't have a known routerdesc to attach it to.
  3032. * This just won't work. */;
  3033. static ratelim_t no_sd_ratelim = RATELIM_INIT(1800);
  3034. r = ROUTER_BAD_EI;
  3035. log_fn_ratelim(&no_sd_ratelim, severity, LD_BUG,
  3036. "No entry found in extrainfo map.");
  3037. goto done;
  3038. }
  3039. if (tor_memneq(ei->cache_info.signed_descriptor_digest,
  3040. sd->extra_info_digest, DIGEST_LEN)) {
  3041. static ratelim_t digest_mismatch_ratelim = RATELIM_INIT(1800);
  3042. /* The sd we got from the map doesn't match the digest we used to look
  3043. * it up. This makes no sense. */
  3044. r = ROUTER_BAD_EI;
  3045. log_fn_ratelim(&digest_mismatch_ratelim, severity, LD_BUG,
  3046. "Mismatch in digest in extrainfo map.");
  3047. goto done;
  3048. }
  3049. if (routerinfo_incompatible_with_extrainfo(ri->identity_pkey, ei, sd,
  3050. &compatibility_error_msg)) {
  3051. char d1[HEX_DIGEST_LEN+1], d2[HEX_DIGEST_LEN+1];
  3052. r = (ri->cache_info.extrainfo_is_bogus) ?
  3053. ROUTER_BAD_EI : ROUTER_NOT_IN_CONSENSUS;
  3054. base16_encode(d1, sizeof(d1), ri->cache_info.identity_digest, DIGEST_LEN);
  3055. base16_encode(d2, sizeof(d2), ei->cache_info.identity_digest, DIGEST_LEN);
  3056. log_fn(severity,LD_DIR,
  3057. "router info incompatible with extra info (ri id: %s, ei id %s, "
  3058. "reason: %s)", d1, d2, compatibility_error_msg);
  3059. goto done;
  3060. }
  3061. /* Okay, if we make it here, we definitely have a router corresponding to
  3062. * this extrainfo. */
  3063. ei_tmp = eimap_set(rl->extra_info_map,
  3064. ei->cache_info.signed_descriptor_digest,
  3065. ei);
  3066. r = ROUTER_ADDED_SUCCESSFULLY;
  3067. if (ei_tmp) {
  3068. rl->extrainfo_store.bytes_dropped +=
  3069. ei_tmp->cache_info.signed_descriptor_len;
  3070. extrainfo_free(ei_tmp);
  3071. }
  3072. done:
  3073. if (r != ROUTER_ADDED_SUCCESSFULLY)
  3074. extrainfo_free(ei);
  3075. #ifdef DEBUG_ROUTERLIST
  3076. routerlist_assert_ok(rl);
  3077. #endif
  3078. return r;
  3079. }
  3080. #define should_cache_old_descriptors() \
  3081. directory_caches_dir_info(get_options())
  3082. /** If we're a directory cache and routerlist <b>rl</b> doesn't have
  3083. * a copy of router <b>ri</b> yet, add it to the list of old (not
  3084. * recommended but still served) descriptors. Else free it. */
  3085. static void
  3086. routerlist_insert_old(routerlist_t *rl, routerinfo_t *ri)
  3087. {
  3088. {
  3089. const routerinfo_t *ri_generated = router_get_my_routerinfo();
  3090. tor_assert(ri_generated != ri);
  3091. }
  3092. tor_assert(ri->cache_info.routerlist_index == -1);
  3093. if (should_cache_old_descriptors() &&
  3094. ri->purpose == ROUTER_PURPOSE_GENERAL &&
  3095. !sdmap_get(rl->desc_digest_map,
  3096. ri->cache_info.signed_descriptor_digest)) {
  3097. signed_descriptor_t *sd = signed_descriptor_from_routerinfo(ri);
  3098. sdmap_set(rl->desc_digest_map, sd->signed_descriptor_digest, sd);
  3099. smartlist_add(rl->old_routers, sd);
  3100. sd->routerlist_index = smartlist_len(rl->old_routers)-1;
  3101. if (!tor_digest_is_zero(sd->extra_info_digest))
  3102. sdmap_set(rl->desc_by_eid_map, sd->extra_info_digest, sd);
  3103. } else {
  3104. routerinfo_free(ri);
  3105. }
  3106. #ifdef DEBUG_ROUTERLIST
  3107. routerlist_assert_ok(rl);
  3108. #endif
  3109. }
  3110. /** Remove an item <b>ri</b> from the routerlist <b>rl</b>, updating indices
  3111. * as needed. If <b>idx</b> is nonnegative and smartlist_get(rl-&gt;routers,
  3112. * idx) == ri, we don't need to do a linear search over the list to decide
  3113. * which to remove. We fill the gap in rl-&gt;routers with a later element in
  3114. * the list, if any exists. <b>ri</b> is freed.
  3115. *
  3116. * If <b>make_old</b> is true, instead of deleting the router, we try adding
  3117. * it to rl-&gt;old_routers. */
  3118. void
  3119. routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int make_old, time_t now)
  3120. {
  3121. routerinfo_t *ri_tmp;
  3122. extrainfo_t *ei_tmp;
  3123. int idx = ri->cache_info.routerlist_index;
  3124. tor_assert(0 <= idx && idx < smartlist_len(rl->routers));
  3125. tor_assert(smartlist_get(rl->routers, idx) == ri);
  3126. nodelist_remove_routerinfo(ri);
  3127. /* make sure the rephist module knows that it's not running */
  3128. rep_hist_note_router_unreachable(ri->cache_info.identity_digest, now);
  3129. ri->cache_info.routerlist_index = -1;
  3130. smartlist_del(rl->routers, idx);
  3131. if (idx < smartlist_len(rl->routers)) {
  3132. routerinfo_t *r = smartlist_get(rl->routers, idx);
  3133. r->cache_info.routerlist_index = idx;
  3134. }
  3135. ri_tmp = rimap_remove(rl->identity_map, ri->cache_info.identity_digest);
  3136. router_dir_info_changed();
  3137. tor_assert(ri_tmp == ri);
  3138. if (make_old && should_cache_old_descriptors() &&
  3139. ri->purpose == ROUTER_PURPOSE_GENERAL) {
  3140. signed_descriptor_t *sd;
  3141. sd = signed_descriptor_from_routerinfo(ri);
  3142. smartlist_add(rl->old_routers, sd);
  3143. sd->routerlist_index = smartlist_len(rl->old_routers)-1;
  3144. sdmap_set(rl->desc_digest_map, sd->signed_descriptor_digest, sd);
  3145. if (!tor_digest_is_zero(sd->extra_info_digest))
  3146. sdmap_set(rl->desc_by_eid_map, sd->extra_info_digest, sd);
  3147. } else {
  3148. signed_descriptor_t *sd_tmp;
  3149. sd_tmp = sdmap_remove(rl->desc_digest_map,
  3150. ri->cache_info.signed_descriptor_digest);
  3151. tor_assert(sd_tmp == &(ri->cache_info));
  3152. rl->desc_store.bytes_dropped += ri->cache_info.signed_descriptor_len;
  3153. ei_tmp = eimap_remove(rl->extra_info_map,
  3154. ri->cache_info.extra_info_digest);
  3155. if (ei_tmp) {
  3156. rl->extrainfo_store.bytes_dropped +=
  3157. ei_tmp->cache_info.signed_descriptor_len;
  3158. extrainfo_free(ei_tmp);
  3159. }
  3160. if (!tor_digest_is_zero(ri->cache_info.extra_info_digest))
  3161. sdmap_remove(rl->desc_by_eid_map, ri->cache_info.extra_info_digest);
  3162. routerinfo_free(ri);
  3163. }
  3164. #ifdef DEBUG_ROUTERLIST
  3165. routerlist_assert_ok(rl);
  3166. #endif
  3167. }
  3168. /** Remove a signed_descriptor_t <b>sd</b> from <b>rl</b>-\>old_routers, and
  3169. * adjust <b>rl</b> as appropriate. <b>idx</b> is -1, or the index of
  3170. * <b>sd</b>. */
  3171. static void
  3172. routerlist_remove_old(routerlist_t *rl, signed_descriptor_t *sd, int idx)
  3173. {
  3174. signed_descriptor_t *sd_tmp;
  3175. extrainfo_t *ei_tmp;
  3176. desc_store_t *store;
  3177. if (idx == -1) {
  3178. idx = sd->routerlist_index;
  3179. }
  3180. tor_assert(0 <= idx && idx < smartlist_len(rl->old_routers));
  3181. /* XXXX edmanm's bridge relay triggered the following assert while
  3182. * running 0.2.0.12-alpha. If anybody triggers this again, see if we
  3183. * can get a backtrace. */
  3184. tor_assert(smartlist_get(rl->old_routers, idx) == sd);
  3185. tor_assert(idx == sd->routerlist_index);
  3186. sd->routerlist_index = -1;
  3187. smartlist_del(rl->old_routers, idx);
  3188. if (idx < smartlist_len(rl->old_routers)) {
  3189. signed_descriptor_t *d = smartlist_get(rl->old_routers, idx);
  3190. d->routerlist_index = idx;
  3191. }
  3192. sd_tmp = sdmap_remove(rl->desc_digest_map,
  3193. sd->signed_descriptor_digest);
  3194. tor_assert(sd_tmp == sd);
  3195. store = desc_get_store(rl, sd);
  3196. if (store)
  3197. store->bytes_dropped += sd->signed_descriptor_len;
  3198. ei_tmp = eimap_remove(rl->extra_info_map,
  3199. sd->extra_info_digest);
  3200. if (ei_tmp) {
  3201. rl->extrainfo_store.bytes_dropped +=
  3202. ei_tmp->cache_info.signed_descriptor_len;
  3203. extrainfo_free(ei_tmp);
  3204. }
  3205. if (!tor_digest_is_zero(sd->extra_info_digest))
  3206. sdmap_remove(rl->desc_by_eid_map, sd->extra_info_digest);
  3207. signed_descriptor_free(sd);
  3208. #ifdef DEBUG_ROUTERLIST
  3209. routerlist_assert_ok(rl);
  3210. #endif
  3211. }
  3212. /** Remove <b>ri_old</b> from the routerlist <b>rl</b>, and replace it with
  3213. * <b>ri_new</b>, updating all index info. If <b>idx</b> is nonnegative and
  3214. * smartlist_get(rl-&gt;routers, idx) == ri, we don't need to do a linear
  3215. * search over the list to decide which to remove. We put ri_new in the same
  3216. * index as ri_old, if possible. ri is freed as appropriate.
  3217. *
  3218. * If should_cache_descriptors() is true, instead of deleting the router,
  3219. * we add it to rl-&gt;old_routers. */
  3220. static void
  3221. routerlist_replace(routerlist_t *rl, routerinfo_t *ri_old,
  3222. routerinfo_t *ri_new)
  3223. {
  3224. int idx;
  3225. int same_descriptors;
  3226. routerinfo_t *ri_tmp;
  3227. extrainfo_t *ei_tmp;
  3228. {
  3229. const routerinfo_t *ri_generated = router_get_my_routerinfo();
  3230. tor_assert(ri_generated != ri_new);
  3231. }
  3232. tor_assert(ri_old != ri_new);
  3233. tor_assert(ri_new->cache_info.routerlist_index == -1);
  3234. idx = ri_old->cache_info.routerlist_index;
  3235. tor_assert(0 <= idx && idx < smartlist_len(rl->routers));
  3236. tor_assert(smartlist_get(rl->routers, idx) == ri_old);
  3237. {
  3238. routerinfo_t *ri_old_tmp=NULL;
  3239. nodelist_set_routerinfo(ri_new, &ri_old_tmp);
  3240. tor_assert(ri_old == ri_old_tmp);
  3241. }
  3242. router_dir_info_changed();
  3243. if (idx >= 0) {
  3244. smartlist_set(rl->routers, idx, ri_new);
  3245. ri_old->cache_info.routerlist_index = -1;
  3246. ri_new->cache_info.routerlist_index = idx;
  3247. /* Check that ri_old is not in rl->routers anymore: */
  3248. tor_assert( routerlist_find_elt_(rl->routers, ri_old, -1) == -1 );
  3249. } else {
  3250. log_warn(LD_BUG, "Appending entry from routerlist_replace.");
  3251. routerlist_insert(rl, ri_new);
  3252. return;
  3253. }
  3254. if (tor_memneq(ri_old->cache_info.identity_digest,
  3255. ri_new->cache_info.identity_digest, DIGEST_LEN)) {
  3256. /* digests don't match; digestmap_set won't replace */
  3257. rimap_remove(rl->identity_map, ri_old->cache_info.identity_digest);
  3258. }
  3259. ri_tmp = rimap_set(rl->identity_map,
  3260. ri_new->cache_info.identity_digest, ri_new);
  3261. tor_assert(!ri_tmp || ri_tmp == ri_old);
  3262. sdmap_set(rl->desc_digest_map,
  3263. ri_new->cache_info.signed_descriptor_digest,
  3264. &(ri_new->cache_info));
  3265. if (!tor_digest_is_zero(ri_new->cache_info.extra_info_digest)) {
  3266. sdmap_set(rl->desc_by_eid_map, ri_new->cache_info.extra_info_digest,
  3267. &ri_new->cache_info);
  3268. }
  3269. same_descriptors = tor_memeq(ri_old->cache_info.signed_descriptor_digest,
  3270. ri_new->cache_info.signed_descriptor_digest,
  3271. DIGEST_LEN);
  3272. if (should_cache_old_descriptors() &&
  3273. ri_old->purpose == ROUTER_PURPOSE_GENERAL &&
  3274. !same_descriptors) {
  3275. /* ri_old is going to become a signed_descriptor_t and go into
  3276. * old_routers */
  3277. signed_descriptor_t *sd = signed_descriptor_from_routerinfo(ri_old);
  3278. smartlist_add(rl->old_routers, sd);
  3279. sd->routerlist_index = smartlist_len(rl->old_routers)-1;
  3280. sdmap_set(rl->desc_digest_map, sd->signed_descriptor_digest, sd);
  3281. if (!tor_digest_is_zero(sd->extra_info_digest))
  3282. sdmap_set(rl->desc_by_eid_map, sd->extra_info_digest, sd);
  3283. } else {
  3284. /* We're dropping ri_old. */
  3285. if (!same_descriptors) {
  3286. /* digests don't match; The sdmap_set above didn't replace */
  3287. sdmap_remove(rl->desc_digest_map,
  3288. ri_old->cache_info.signed_descriptor_digest);
  3289. if (tor_memneq(ri_old->cache_info.extra_info_digest,
  3290. ri_new->cache_info.extra_info_digest, DIGEST_LEN)) {
  3291. ei_tmp = eimap_remove(rl->extra_info_map,
  3292. ri_old->cache_info.extra_info_digest);
  3293. if (ei_tmp) {
  3294. rl->extrainfo_store.bytes_dropped +=
  3295. ei_tmp->cache_info.signed_descriptor_len;
  3296. extrainfo_free(ei_tmp);
  3297. }
  3298. }
  3299. if (!tor_digest_is_zero(ri_old->cache_info.extra_info_digest)) {
  3300. sdmap_remove(rl->desc_by_eid_map,
  3301. ri_old->cache_info.extra_info_digest);
  3302. }
  3303. }
  3304. rl->desc_store.bytes_dropped += ri_old->cache_info.signed_descriptor_len;
  3305. routerinfo_free(ri_old);
  3306. }
  3307. #ifdef DEBUG_ROUTERLIST
  3308. routerlist_assert_ok(rl);
  3309. #endif
  3310. }
  3311. /** Extract the descriptor <b>sd</b> from old_routerlist, and re-parse
  3312. * it as a fresh routerinfo_t. */
  3313. static routerinfo_t *
  3314. routerlist_reparse_old(routerlist_t *rl, signed_descriptor_t *sd)
  3315. {
  3316. routerinfo_t *ri;
  3317. const char *body;
  3318. body = signed_descriptor_get_annotations(sd);
  3319. ri = router_parse_entry_from_string(body,
  3320. body+sd->signed_descriptor_len+sd->annotations_len,
  3321. 0, 1, NULL, NULL);
  3322. if (!ri)
  3323. return NULL;
  3324. signed_descriptor_move(&ri->cache_info, sd);
  3325. routerlist_remove_old(rl, sd, -1);
  3326. return ri;
  3327. }
  3328. /** Free all memory held by the routerlist module.
  3329. * Note: Calling routerlist_free_all() should always be paired with
  3330. * a call to nodelist_free_all(). These should only be called during
  3331. * cleanup.
  3332. */
  3333. void
  3334. routerlist_free_all(void)
  3335. {
  3336. routerlist_free(routerlist);
  3337. routerlist = NULL;
  3338. if (warned_nicknames) {
  3339. SMARTLIST_FOREACH(warned_nicknames, char *, cp, tor_free(cp));
  3340. smartlist_free(warned_nicknames);
  3341. warned_nicknames = NULL;
  3342. }
  3343. clear_dir_servers();
  3344. smartlist_free(trusted_dir_servers);
  3345. smartlist_free(fallback_dir_servers);
  3346. trusted_dir_servers = fallback_dir_servers = NULL;
  3347. if (trusted_dir_certs) {
  3348. digestmap_free(trusted_dir_certs, cert_list_free_);
  3349. trusted_dir_certs = NULL;
  3350. }
  3351. }
  3352. /** Forget that we have issued any router-related warnings, so that we'll
  3353. * warn again if we see the same errors. */
  3354. void
  3355. routerlist_reset_warnings(void)
  3356. {
  3357. if (!warned_nicknames)
  3358. warned_nicknames = smartlist_new();
  3359. SMARTLIST_FOREACH(warned_nicknames, char *, cp, tor_free(cp));
  3360. smartlist_clear(warned_nicknames); /* now the list is empty. */
  3361. networkstatus_reset_warnings();
  3362. }
  3363. /** Return 1 if the signed descriptor of this router is older than
  3364. * <b>seconds</b> seconds. Otherwise return 0. */
  3365. MOCK_IMPL(int,
  3366. router_descriptor_is_older_than,(const routerinfo_t *router, int seconds))
  3367. {
  3368. return router->cache_info.published_on < approx_time() - seconds;
  3369. }
  3370. /** Add <b>router</b> to the routerlist, if we don't already have it. Replace
  3371. * older entries (if any) with the same key. Note: Callers should not hold
  3372. * their pointers to <b>router</b> if this function fails; <b>router</b>
  3373. * will either be inserted into the routerlist or freed. Similarly, even
  3374. * if this call succeeds, they should not hold their pointers to
  3375. * <b>router</b> after subsequent calls with other routerinfo's -- they
  3376. * might cause the original routerinfo to get freed.
  3377. *
  3378. * Returns the status for the operation. Might set *<b>msg</b> if it wants
  3379. * the poster of the router to know something.
  3380. *
  3381. * If <b>from_cache</b>, this descriptor came from our disk cache. If
  3382. * <b>from_fetch</b>, we received it in response to a request we made.
  3383. * (If both are false, that means it was uploaded to us as an auth dir
  3384. * server or via the controller.)
  3385. *
  3386. * This function should be called *after*
  3387. * routers_update_status_from_consensus_networkstatus; subsequently, you
  3388. * should call router_rebuild_store and routerlist_descriptors_added.
  3389. */
  3390. was_router_added_t
  3391. router_add_to_routerlist(routerinfo_t *router, const char **msg,
  3392. int from_cache, int from_fetch)
  3393. {
  3394. const char *id_digest;
  3395. const or_options_t *options = get_options();
  3396. int authdir = authdir_mode_handles_descs(options, router->purpose);
  3397. int authdir_believes_valid = 0;
  3398. routerinfo_t *old_router;
  3399. networkstatus_t *consensus =
  3400. networkstatus_get_latest_consensus_by_flavor(FLAV_NS);
  3401. int in_consensus = 0;
  3402. tor_assert(msg);
  3403. if (!routerlist)
  3404. router_get_routerlist();
  3405. id_digest = router->cache_info.identity_digest;
  3406. old_router = router_get_mutable_by_digest(id_digest);
  3407. /* Make sure that it isn't expired. */
  3408. if (router->cert_expiration_time < approx_time()) {
  3409. routerinfo_free(router);
  3410. *msg = "Some certs on this router are expired.";
  3411. return ROUTER_CERTS_EXPIRED;
  3412. }
  3413. /* Make sure that we haven't already got this exact descriptor. */
  3414. if (sdmap_get(routerlist->desc_digest_map,
  3415. router->cache_info.signed_descriptor_digest)) {
  3416. /* If we have this descriptor already and the new descriptor is a bridge
  3417. * descriptor, replace it. If we had a bridge descriptor before and the
  3418. * new one is not a bridge descriptor, don't replace it. */
  3419. /* Only members of routerlist->identity_map can be bridges; we don't
  3420. * put bridges in old_routers. */
  3421. const int was_bridge = old_router &&
  3422. old_router->purpose == ROUTER_PURPOSE_BRIDGE;
  3423. if (routerinfo_is_a_configured_bridge(router) &&
  3424. router->purpose == ROUTER_PURPOSE_BRIDGE &&
  3425. !was_bridge) {
  3426. log_info(LD_DIR, "Replacing non-bridge descriptor with bridge "
  3427. "descriptor for router %s",
  3428. router_describe(router));
  3429. } else {
  3430. log_info(LD_DIR,
  3431. "Dropping descriptor that we already have for router %s",
  3432. router_describe(router));
  3433. *msg = "Router descriptor was not new.";
  3434. routerinfo_free(router);
  3435. return ROUTER_IS_ALREADY_KNOWN;
  3436. }
  3437. }
  3438. if (authdir) {
  3439. if (authdir_wants_to_reject_router(router, msg,
  3440. !from_cache && !from_fetch,
  3441. &authdir_believes_valid)) {
  3442. tor_assert(*msg);
  3443. routerinfo_free(router);
  3444. return ROUTER_AUTHDIR_REJECTS;
  3445. }
  3446. } else if (from_fetch) {
  3447. /* Only check the descriptor digest against the network statuses when
  3448. * we are receiving in response to a fetch. */
  3449. if (!signed_desc_digest_is_recognized(&router->cache_info) &&
  3450. !routerinfo_is_a_configured_bridge(router)) {
  3451. /* We asked for it, so some networkstatus must have listed it when we
  3452. * did. Save it if we're a cache in case somebody else asks for it. */
  3453. log_info(LD_DIR,
  3454. "Received a no-longer-recognized descriptor for router %s",
  3455. router_describe(router));
  3456. *msg = "Router descriptor is not referenced by any network-status.";
  3457. /* Only journal this desc if we want to keep old descriptors */
  3458. if (!from_cache && should_cache_old_descriptors())
  3459. signed_desc_append_to_journal(&router->cache_info,
  3460. &routerlist->desc_store);
  3461. routerlist_insert_old(routerlist, router);
  3462. return ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS;
  3463. }
  3464. }
  3465. /* We no longer need a router with this descriptor digest. */
  3466. if (consensus) {
  3467. routerstatus_t *rs = networkstatus_vote_find_mutable_entry(
  3468. consensus, id_digest);
  3469. if (rs && tor_memeq(rs->descriptor_digest,
  3470. router->cache_info.signed_descriptor_digest,
  3471. DIGEST_LEN)) {
  3472. in_consensus = 1;
  3473. }
  3474. }
  3475. if (router->purpose == ROUTER_PURPOSE_GENERAL &&
  3476. consensus && !in_consensus && !authdir) {
  3477. /* If it's a general router not listed in the consensus, then don't
  3478. * consider replacing the latest router with it. */
  3479. if (!from_cache && should_cache_old_descriptors())
  3480. signed_desc_append_to_journal(&router->cache_info,
  3481. &routerlist->desc_store);
  3482. routerlist_insert_old(routerlist, router);
  3483. *msg = "Skipping router descriptor: not in consensus.";
  3484. return ROUTER_NOT_IN_CONSENSUS;
  3485. }
  3486. /* If we're reading a bridge descriptor from our cache, and we don't
  3487. * recognize it as one of our currently configured bridges, drop the
  3488. * descriptor. Otherwise we could end up using it as one of our entry
  3489. * guards even if it isn't in our Bridge config lines. */
  3490. if (router->purpose == ROUTER_PURPOSE_BRIDGE && from_cache &&
  3491. !authdir_mode_bridge(options) &&
  3492. !routerinfo_is_a_configured_bridge(router)) {
  3493. log_info(LD_DIR, "Dropping bridge descriptor for %s because we have "
  3494. "no bridge configured at that address.",
  3495. safe_str_client(router_describe(router)));
  3496. *msg = "Router descriptor was not a configured bridge.";
  3497. routerinfo_free(router);
  3498. return ROUTER_WAS_NOT_WANTED;
  3499. }
  3500. /* If we have a router with the same identity key, choose the newer one. */
  3501. if (old_router) {
  3502. if (!in_consensus && (router->cache_info.published_on <=
  3503. old_router->cache_info.published_on)) {
  3504. /* Same key, but old. This one is not listed in the consensus. */
  3505. log_debug(LD_DIR, "Not-new descriptor for router %s",
  3506. router_describe(router));
  3507. /* Only journal this desc if we'll be serving it. */
  3508. if (!from_cache && should_cache_old_descriptors())
  3509. signed_desc_append_to_journal(&router->cache_info,
  3510. &routerlist->desc_store);
  3511. routerlist_insert_old(routerlist, router);
  3512. *msg = "Router descriptor was not new.";
  3513. return ROUTER_IS_ALREADY_KNOWN;
  3514. } else {
  3515. /* Same key, and either new, or listed in the consensus. */
  3516. log_debug(LD_DIR, "Replacing entry for router %s",
  3517. router_describe(router));
  3518. routerlist_replace(routerlist, old_router, router);
  3519. if (!from_cache) {
  3520. signed_desc_append_to_journal(&router->cache_info,
  3521. &routerlist->desc_store);
  3522. }
  3523. *msg = authdir_believes_valid ? "Valid server updated" :
  3524. ("Invalid server updated. (This dirserver is marking your "
  3525. "server as unapproved.)");
  3526. return ROUTER_ADDED_SUCCESSFULLY;
  3527. }
  3528. }
  3529. if (!in_consensus && from_cache &&
  3530. router_descriptor_is_older_than(router, OLD_ROUTER_DESC_MAX_AGE)) {
  3531. *msg = "Router descriptor was really old.";
  3532. routerinfo_free(router);
  3533. return ROUTER_WAS_TOO_OLD;
  3534. }
  3535. /* We haven't seen a router with this identity before. Add it to the end of
  3536. * the list. */
  3537. routerlist_insert(routerlist, router);
  3538. if (!from_cache) {
  3539. signed_desc_append_to_journal(&router->cache_info,
  3540. &routerlist->desc_store);
  3541. }
  3542. return ROUTER_ADDED_SUCCESSFULLY;
  3543. }
  3544. /** Insert <b>ei</b> into the routerlist, or free it. Other arguments are
  3545. * as for router_add_to_routerlist(). Return ROUTER_ADDED_SUCCESSFULLY iff
  3546. * we actually inserted it, ROUTER_BAD_EI otherwise.
  3547. */
  3548. was_router_added_t
  3549. router_add_extrainfo_to_routerlist(extrainfo_t *ei, const char **msg,
  3550. int from_cache, int from_fetch)
  3551. {
  3552. was_router_added_t inserted;
  3553. (void)from_fetch;
  3554. if (msg) *msg = NULL;
  3555. /*XXXX Do something with msg */
  3556. inserted = extrainfo_insert(router_get_routerlist(), ei, !from_cache);
  3557. if (WRA_WAS_ADDED(inserted) && !from_cache)
  3558. signed_desc_append_to_journal(&ei->cache_info,
  3559. &routerlist->extrainfo_store);
  3560. return inserted;
  3561. }
  3562. /** Sorting helper: return &lt;0, 0, or &gt;0 depending on whether the
  3563. * signed_descriptor_t* in *<b>a</b> has an identity digest preceding, equal
  3564. * to, or later than that of *<b>b</b>. */
  3565. static int
  3566. compare_old_routers_by_identity_(const void **_a, const void **_b)
  3567. {
  3568. int i;
  3569. const signed_descriptor_t *r1 = *_a, *r2 = *_b;
  3570. if ((i = fast_memcmp(r1->identity_digest, r2->identity_digest, DIGEST_LEN)))
  3571. return i;
  3572. return (int)(r1->published_on - r2->published_on);
  3573. }
  3574. /** Internal type used to represent how long an old descriptor was valid,
  3575. * where it appeared in the list of old descriptors, and whether it's extra
  3576. * old. Used only by routerlist_remove_old_cached_routers_with_id(). */
  3577. struct duration_idx_t {
  3578. int duration;
  3579. int idx;
  3580. int old;
  3581. };
  3582. /** Sorting helper: compare two duration_idx_t by their duration. */
  3583. static int
  3584. compare_duration_idx_(const void *_d1, const void *_d2)
  3585. {
  3586. const struct duration_idx_t *d1 = _d1;
  3587. const struct duration_idx_t *d2 = _d2;
  3588. return d1->duration - d2->duration;
  3589. }
  3590. /** The range <b>lo</b> through <b>hi</b> inclusive of routerlist->old_routers
  3591. * must contain routerinfo_t with the same identity and with publication time
  3592. * in ascending order. Remove members from this range until there are no more
  3593. * than max_descriptors_per_router() remaining. Start by removing the oldest
  3594. * members from before <b>cutoff</b>, then remove members which were current
  3595. * for the lowest amount of time. The order of members of old_routers at
  3596. * indices <b>lo</b> or higher may be changed.
  3597. */
  3598. static void
  3599. routerlist_remove_old_cached_routers_with_id(time_t now,
  3600. time_t cutoff, int lo, int hi,
  3601. digestset_t *retain)
  3602. {
  3603. int i, n = hi-lo+1;
  3604. unsigned n_extra, n_rmv = 0;
  3605. struct duration_idx_t *lifespans;
  3606. uint8_t *rmv, *must_keep;
  3607. smartlist_t *lst = routerlist->old_routers;
  3608. #if 1
  3609. const char *ident;
  3610. tor_assert(hi < smartlist_len(lst));
  3611. tor_assert(lo <= hi);
  3612. ident = ((signed_descriptor_t*)smartlist_get(lst, lo))->identity_digest;
  3613. for (i = lo+1; i <= hi; ++i) {
  3614. signed_descriptor_t *r = smartlist_get(lst, i);
  3615. tor_assert(tor_memeq(ident, r->identity_digest, DIGEST_LEN));
  3616. }
  3617. #endif
  3618. /* Check whether we need to do anything at all. */
  3619. {
  3620. int mdpr = directory_caches_dir_info(get_options()) ? 2 : 1;
  3621. if (n <= mdpr)
  3622. return;
  3623. n_extra = n - mdpr;
  3624. }
  3625. lifespans = tor_calloc(n, sizeof(struct duration_idx_t));
  3626. rmv = tor_calloc(n, sizeof(uint8_t));
  3627. must_keep = tor_calloc(n, sizeof(uint8_t));
  3628. /* Set lifespans to contain the lifespan and index of each server. */
  3629. /* Set rmv[i-lo]=1 if we're going to remove a server for being too old. */
  3630. for (i = lo; i <= hi; ++i) {
  3631. signed_descriptor_t *r = smartlist_get(lst, i);
  3632. signed_descriptor_t *r_next;
  3633. lifespans[i-lo].idx = i;
  3634. if (r->last_listed_as_valid_until >= now ||
  3635. (retain && digestset_contains(retain, r->signed_descriptor_digest))) {
  3636. must_keep[i-lo] = 1;
  3637. }
  3638. if (i < hi) {
  3639. r_next = smartlist_get(lst, i+1);
  3640. tor_assert(r->published_on <= r_next->published_on);
  3641. lifespans[i-lo].duration = (int)(r_next->published_on - r->published_on);
  3642. } else {
  3643. r_next = NULL;
  3644. lifespans[i-lo].duration = INT_MAX;
  3645. }
  3646. if (!must_keep[i-lo] && r->published_on < cutoff && n_rmv < n_extra) {
  3647. ++n_rmv;
  3648. lifespans[i-lo].old = 1;
  3649. rmv[i-lo] = 1;
  3650. }
  3651. }
  3652. if (n_rmv < n_extra) {
  3653. /**
  3654. * We aren't removing enough servers for being old. Sort lifespans by
  3655. * the duration of liveness, and remove the ones we're not already going to
  3656. * remove based on how long they were alive.
  3657. **/
  3658. qsort(lifespans, n, sizeof(struct duration_idx_t), compare_duration_idx_);
  3659. for (i = 0; i < n && n_rmv < n_extra; ++i) {
  3660. if (!must_keep[lifespans[i].idx-lo] && !lifespans[i].old) {
  3661. rmv[lifespans[i].idx-lo] = 1;
  3662. ++n_rmv;
  3663. }
  3664. }
  3665. }
  3666. i = hi;
  3667. do {
  3668. if (rmv[i-lo])
  3669. routerlist_remove_old(routerlist, smartlist_get(lst, i), i);
  3670. } while (--i >= lo);
  3671. tor_free(must_keep);
  3672. tor_free(rmv);
  3673. tor_free(lifespans);
  3674. }
  3675. /** Deactivate any routers from the routerlist that are more than
  3676. * ROUTER_MAX_AGE seconds old and not recommended by any networkstatuses;
  3677. * remove old routers from the list of cached routers if we have too many.
  3678. */
  3679. void
  3680. routerlist_remove_old_routers(void)
  3681. {
  3682. int i, hi=-1;
  3683. const char *cur_id = NULL;
  3684. time_t now = time(NULL);
  3685. time_t cutoff;
  3686. routerinfo_t *router;
  3687. signed_descriptor_t *sd;
  3688. digestset_t *retain;
  3689. const networkstatus_t *consensus = networkstatus_get_latest_consensus();
  3690. trusted_dirs_remove_old_certs();
  3691. if (!routerlist || !consensus)
  3692. return;
  3693. // routerlist_assert_ok(routerlist);
  3694. /* We need to guess how many router descriptors we will wind up wanting to
  3695. retain, so that we can be sure to allocate a large enough Bloom filter
  3696. to hold the digest set. Overestimating is fine; underestimating is bad.
  3697. */
  3698. {
  3699. /* We'll probably retain everything in the consensus. */
  3700. int n_max_retain = smartlist_len(consensus->routerstatus_list);
  3701. retain = digestset_new(n_max_retain);
  3702. }
  3703. cutoff = now - OLD_ROUTER_DESC_MAX_AGE;
  3704. /* Retain anything listed in the consensus. */
  3705. if (consensus) {
  3706. SMARTLIST_FOREACH(consensus->routerstatus_list, routerstatus_t *, rs,
  3707. if (rs->published_on >= cutoff)
  3708. digestset_add(retain, rs->descriptor_digest));
  3709. }
  3710. /* If we have a consensus, we should consider pruning current routers that
  3711. * are too old and that nobody recommends. (If we don't have a consensus,
  3712. * then we should get one before we decide to kill routers.) */
  3713. if (consensus) {
  3714. cutoff = now - ROUTER_MAX_AGE;
  3715. /* Remove too-old unrecommended members of routerlist->routers. */
  3716. for (i = 0; i < smartlist_len(routerlist->routers); ++i) {
  3717. router = smartlist_get(routerlist->routers, i);
  3718. if (router->cache_info.published_on <= cutoff &&
  3719. router->cache_info.last_listed_as_valid_until < now &&
  3720. !digestset_contains(retain,
  3721. router->cache_info.signed_descriptor_digest)) {
  3722. /* Too old: remove it. (If we're a cache, just move it into
  3723. * old_routers.) */
  3724. log_info(LD_DIR,
  3725. "Forgetting obsolete (too old) routerinfo for router %s",
  3726. router_describe(router));
  3727. routerlist_remove(routerlist, router, 1, now);
  3728. i--;
  3729. }
  3730. }
  3731. }
  3732. //routerlist_assert_ok(routerlist);
  3733. /* Remove far-too-old members of routerlist->old_routers. */
  3734. cutoff = now - OLD_ROUTER_DESC_MAX_AGE;
  3735. for (i = 0; i < smartlist_len(routerlist->old_routers); ++i) {
  3736. sd = smartlist_get(routerlist->old_routers, i);
  3737. if (sd->published_on <= cutoff &&
  3738. sd->last_listed_as_valid_until < now &&
  3739. !digestset_contains(retain, sd->signed_descriptor_digest)) {
  3740. /* Too old. Remove it. */
  3741. routerlist_remove_old(routerlist, sd, i--);
  3742. }
  3743. }
  3744. //routerlist_assert_ok(routerlist);
  3745. log_info(LD_DIR, "We have %d live routers and %d old router descriptors.",
  3746. smartlist_len(routerlist->routers),
  3747. smartlist_len(routerlist->old_routers));
  3748. /* Now we might have to look at routerlist->old_routers for extraneous
  3749. * members. (We'd keep all the members if we could, but we need to save
  3750. * space.) First, check whether we have too many router descriptors, total.
  3751. * We're okay with having too many for some given router, so long as the
  3752. * total number doesn't approach max_descriptors_per_router()*len(router).
  3753. */
  3754. if (smartlist_len(routerlist->old_routers) <
  3755. smartlist_len(routerlist->routers))
  3756. goto done;
  3757. /* Sort by identity, then fix indices. */
  3758. smartlist_sort(routerlist->old_routers, compare_old_routers_by_identity_);
  3759. /* Fix indices. */
  3760. for (i = 0; i < smartlist_len(routerlist->old_routers); ++i) {
  3761. signed_descriptor_t *r = smartlist_get(routerlist->old_routers, i);
  3762. r->routerlist_index = i;
  3763. }
  3764. /* Iterate through the list from back to front, so when we remove descriptors
  3765. * we don't mess up groups we haven't gotten to. */
  3766. for (i = smartlist_len(routerlist->old_routers)-1; i >= 0; --i) {
  3767. signed_descriptor_t *r = smartlist_get(routerlist->old_routers, i);
  3768. if (!cur_id) {
  3769. cur_id = r->identity_digest;
  3770. hi = i;
  3771. }
  3772. if (tor_memneq(cur_id, r->identity_digest, DIGEST_LEN)) {
  3773. routerlist_remove_old_cached_routers_with_id(now,
  3774. cutoff, i+1, hi, retain);
  3775. cur_id = r->identity_digest;
  3776. hi = i;
  3777. }
  3778. }
  3779. if (hi>=0)
  3780. routerlist_remove_old_cached_routers_with_id(now, cutoff, 0, hi, retain);
  3781. //routerlist_assert_ok(routerlist);
  3782. done:
  3783. digestset_free(retain);
  3784. router_rebuild_store(RRS_DONT_REMOVE_OLD, &routerlist->desc_store);
  3785. router_rebuild_store(RRS_DONT_REMOVE_OLD,&routerlist->extrainfo_store);
  3786. }
  3787. /** We just added a new set of descriptors. Take whatever extra steps
  3788. * we need. */
  3789. void
  3790. routerlist_descriptors_added(smartlist_t *sl, int from_cache)
  3791. {
  3792. tor_assert(sl);
  3793. control_event_descriptors_changed(sl);
  3794. SMARTLIST_FOREACH_BEGIN(sl, routerinfo_t *, ri) {
  3795. if (ri->purpose == ROUTER_PURPOSE_BRIDGE)
  3796. learned_bridge_descriptor(ri, from_cache);
  3797. if (ri->needs_retest_if_added) {
  3798. ri->needs_retest_if_added = 0;
  3799. dirserv_single_reachability_test(approx_time(), ri);
  3800. }
  3801. } SMARTLIST_FOREACH_END(ri);
  3802. }
  3803. /**
  3804. * Code to parse a single router descriptor and insert it into the
  3805. * routerlist. Return -1 if the descriptor was ill-formed; 0 if the
  3806. * descriptor was well-formed but could not be added; and 1 if the
  3807. * descriptor was added.
  3808. *
  3809. * If we don't add it and <b>msg</b> is not NULL, then assign to
  3810. * *<b>msg</b> a static string describing the reason for refusing the
  3811. * descriptor.
  3812. *
  3813. * This is used only by the controller.
  3814. */
  3815. int
  3816. router_load_single_router(const char *s, uint8_t purpose, int cache,
  3817. const char **msg)
  3818. {
  3819. routerinfo_t *ri;
  3820. was_router_added_t r;
  3821. smartlist_t *lst;
  3822. char annotation_buf[ROUTER_ANNOTATION_BUF_LEN];
  3823. tor_assert(msg);
  3824. *msg = NULL;
  3825. tor_snprintf(annotation_buf, sizeof(annotation_buf),
  3826. "@source controller\n"
  3827. "@purpose %s\n", router_purpose_to_string(purpose));
  3828. if (!(ri = router_parse_entry_from_string(s, NULL, 1, 0,
  3829. annotation_buf, NULL))) {
  3830. log_warn(LD_DIR, "Error parsing router descriptor; dropping.");
  3831. *msg = "Couldn't parse router descriptor.";
  3832. return -1;
  3833. }
  3834. tor_assert(ri->purpose == purpose);
  3835. if (router_is_me(ri)) {
  3836. log_warn(LD_DIR, "Router's identity key matches mine; dropping.");
  3837. *msg = "Router's identity key matches mine.";
  3838. routerinfo_free(ri);
  3839. return 0;
  3840. }
  3841. if (!cache) /* obey the preference of the controller */
  3842. ri->cache_info.do_not_cache = 1;
  3843. lst = smartlist_new();
  3844. smartlist_add(lst, ri);
  3845. routers_update_status_from_consensus_networkstatus(lst, 0);
  3846. r = router_add_to_routerlist(ri, msg, 0, 0);
  3847. if (!WRA_WAS_ADDED(r)) {
  3848. /* we've already assigned to *msg now, and ri is already freed */
  3849. tor_assert(*msg);
  3850. if (r == ROUTER_AUTHDIR_REJECTS)
  3851. log_warn(LD_DIR, "Couldn't add router to list: %s Dropping.", *msg);
  3852. smartlist_free(lst);
  3853. return 0;
  3854. } else {
  3855. routerlist_descriptors_added(lst, 0);
  3856. smartlist_free(lst);
  3857. log_debug(LD_DIR, "Added router to list");
  3858. return 1;
  3859. }
  3860. }
  3861. /** Given a string <b>s</b> containing some routerdescs, parse it and put the
  3862. * routers into our directory. If saved_location is SAVED_NOWHERE, the routers
  3863. * are in response to a query to the network: cache them by adding them to
  3864. * the journal.
  3865. *
  3866. * Return the number of routers actually added.
  3867. *
  3868. * If <b>requested_fingerprints</b> is provided, it must contain a list of
  3869. * uppercased fingerprints. Do not update any router whose
  3870. * fingerprint is not on the list; after updating a router, remove its
  3871. * fingerprint from the list.
  3872. *
  3873. * If <b>descriptor_digests</b> is non-zero, then the requested_fingerprints
  3874. * are descriptor digests. Otherwise they are identity digests.
  3875. */
  3876. int
  3877. router_load_routers_from_string(const char *s, const char *eos,
  3878. saved_location_t saved_location,
  3879. smartlist_t *requested_fingerprints,
  3880. int descriptor_digests,
  3881. const char *prepend_annotations)
  3882. {
  3883. smartlist_t *routers = smartlist_new(), *changed = smartlist_new();
  3884. char fp[HEX_DIGEST_LEN+1];
  3885. const char *msg;
  3886. int from_cache = (saved_location != SAVED_NOWHERE);
  3887. int allow_annotations = (saved_location != SAVED_NOWHERE);
  3888. int any_changed = 0;
  3889. smartlist_t *invalid_digests = smartlist_new();
  3890. router_parse_list_from_string(&s, eos, routers, saved_location, 0,
  3891. allow_annotations, prepend_annotations,
  3892. invalid_digests);
  3893. routers_update_status_from_consensus_networkstatus(routers, !from_cache);
  3894. log_info(LD_DIR, "%d elements to add", smartlist_len(routers));
  3895. SMARTLIST_FOREACH_BEGIN(routers, routerinfo_t *, ri) {
  3896. was_router_added_t r;
  3897. char d[DIGEST_LEN];
  3898. if (requested_fingerprints) {
  3899. base16_encode(fp, sizeof(fp), descriptor_digests ?
  3900. ri->cache_info.signed_descriptor_digest :
  3901. ri->cache_info.identity_digest,
  3902. DIGEST_LEN);
  3903. if (smartlist_contains_string(requested_fingerprints, fp)) {
  3904. smartlist_string_remove(requested_fingerprints, fp);
  3905. } else {
  3906. char *requested =
  3907. smartlist_join_strings(requested_fingerprints," ",0,NULL);
  3908. log_warn(LD_DIR,
  3909. "We received a router descriptor with a fingerprint (%s) "
  3910. "that we never requested. (We asked for: %s.) Dropping.",
  3911. fp, requested);
  3912. tor_free(requested);
  3913. routerinfo_free(ri);
  3914. continue;
  3915. }
  3916. }
  3917. memcpy(d, ri->cache_info.signed_descriptor_digest, DIGEST_LEN);
  3918. r = router_add_to_routerlist(ri, &msg, from_cache, !from_cache);
  3919. if (WRA_WAS_ADDED(r)) {
  3920. any_changed++;
  3921. smartlist_add(changed, ri);
  3922. routerlist_descriptors_added(changed, from_cache);
  3923. smartlist_clear(changed);
  3924. } else if (WRA_NEVER_DOWNLOADABLE(r)) {
  3925. download_status_t *dl_status;
  3926. dl_status = router_get_dl_status_by_descriptor_digest(d);
  3927. if (dl_status) {
  3928. log_info(LD_GENERAL, "Marking router %s as never downloadable",
  3929. hex_str(d, DIGEST_LEN));
  3930. download_status_mark_impossible(dl_status);
  3931. }
  3932. }
  3933. } SMARTLIST_FOREACH_END(ri);
  3934. SMARTLIST_FOREACH_BEGIN(invalid_digests, const uint8_t *, bad_digest) {
  3935. /* This digest is never going to be parseable. */
  3936. base16_encode(fp, sizeof(fp), (char*)bad_digest, DIGEST_LEN);
  3937. if (requested_fingerprints && descriptor_digests) {
  3938. if (! smartlist_contains_string(requested_fingerprints, fp)) {
  3939. /* But we didn't ask for it, so we should assume shennanegans. */
  3940. continue;
  3941. }
  3942. smartlist_string_remove(requested_fingerprints, fp);
  3943. }
  3944. download_status_t *dls;
  3945. dls = router_get_dl_status_by_descriptor_digest((char*)bad_digest);
  3946. if (dls) {
  3947. log_info(LD_GENERAL, "Marking router with descriptor %s as unparseable, "
  3948. "and therefore undownloadable", fp);
  3949. download_status_mark_impossible(dls);
  3950. }
  3951. } SMARTLIST_FOREACH_END(bad_digest);
  3952. SMARTLIST_FOREACH(invalid_digests, uint8_t *, d, tor_free(d));
  3953. smartlist_free(invalid_digests);
  3954. routerlist_assert_ok(routerlist);
  3955. if (any_changed)
  3956. router_rebuild_store(0, &routerlist->desc_store);
  3957. smartlist_free(routers);
  3958. smartlist_free(changed);
  3959. return any_changed;
  3960. }
  3961. /** Parse one or more extrainfos from <b>s</b> (ending immediately before
  3962. * <b>eos</b> if <b>eos</b> is present). Other arguments are as for
  3963. * router_load_routers_from_string(). */
  3964. void
  3965. router_load_extrainfo_from_string(const char *s, const char *eos,
  3966. saved_location_t saved_location,
  3967. smartlist_t *requested_fingerprints,
  3968. int descriptor_digests)
  3969. {
  3970. smartlist_t *extrainfo_list = smartlist_new();
  3971. const char *msg;
  3972. int from_cache = (saved_location != SAVED_NOWHERE);
  3973. smartlist_t *invalid_digests = smartlist_new();
  3974. router_parse_list_from_string(&s, eos, extrainfo_list, saved_location, 1, 0,
  3975. NULL, invalid_digests);
  3976. log_info(LD_DIR, "%d elements to add", smartlist_len(extrainfo_list));
  3977. SMARTLIST_FOREACH_BEGIN(extrainfo_list, extrainfo_t *, ei) {
  3978. uint8_t d[DIGEST_LEN];
  3979. memcpy(d, ei->cache_info.signed_descriptor_digest, DIGEST_LEN);
  3980. was_router_added_t added =
  3981. router_add_extrainfo_to_routerlist(ei, &msg, from_cache, !from_cache);
  3982. if (WRA_WAS_ADDED(added) && requested_fingerprints) {
  3983. char fp[HEX_DIGEST_LEN+1];
  3984. base16_encode(fp, sizeof(fp), descriptor_digests ?
  3985. ei->cache_info.signed_descriptor_digest :
  3986. ei->cache_info.identity_digest,
  3987. DIGEST_LEN);
  3988. smartlist_string_remove(requested_fingerprints, fp);
  3989. /* We silently let relays stuff us with extrainfos we didn't ask for,
  3990. * so long as we would have wanted them anyway. Since we always fetch
  3991. * all the extrainfos we want, and we never actually act on them
  3992. * inside Tor, this should be harmless. */
  3993. } else if (WRA_NEVER_DOWNLOADABLE(added)) {
  3994. signed_descriptor_t *sd = router_get_by_extrainfo_digest((char*)d);
  3995. if (sd) {
  3996. log_info(LD_GENERAL, "Marking extrainfo with descriptor %s as "
  3997. "unparseable, and therefore undownloadable",
  3998. hex_str((char*)d,DIGEST_LEN));
  3999. download_status_mark_impossible(&sd->ei_dl_status);
  4000. }
  4001. }
  4002. } SMARTLIST_FOREACH_END(ei);
  4003. SMARTLIST_FOREACH_BEGIN(invalid_digests, const uint8_t *, bad_digest) {
  4004. /* This digest is never going to be parseable. */
  4005. char fp[HEX_DIGEST_LEN+1];
  4006. base16_encode(fp, sizeof(fp), (char*)bad_digest, DIGEST_LEN);
  4007. if (requested_fingerprints) {
  4008. if (! smartlist_contains_string(requested_fingerprints, fp)) {
  4009. /* But we didn't ask for it, so we should assume shennanegans. */
  4010. continue;
  4011. }
  4012. smartlist_string_remove(requested_fingerprints, fp);
  4013. }
  4014. signed_descriptor_t *sd =
  4015. router_get_by_extrainfo_digest((char*)bad_digest);
  4016. if (sd) {
  4017. log_info(LD_GENERAL, "Marking extrainfo with descriptor %s as "
  4018. "unparseable, and therefore undownloadable", fp);
  4019. download_status_mark_impossible(&sd->ei_dl_status);
  4020. }
  4021. } SMARTLIST_FOREACH_END(bad_digest);
  4022. SMARTLIST_FOREACH(invalid_digests, uint8_t *, d, tor_free(d));
  4023. smartlist_free(invalid_digests);
  4024. routerlist_assert_ok(routerlist);
  4025. router_rebuild_store(0, &router_get_routerlist()->extrainfo_store);
  4026. smartlist_free(extrainfo_list);
  4027. }
  4028. /** Return true iff the latest ns-flavored consensus includes a descriptor
  4029. * whose digest is that of <b>desc</b>. */
  4030. static int
  4031. signed_desc_digest_is_recognized(signed_descriptor_t *desc)
  4032. {
  4033. const routerstatus_t *rs;
  4034. networkstatus_t *consensus = networkstatus_get_latest_consensus_by_flavor(
  4035. FLAV_NS);
  4036. if (consensus) {
  4037. rs = networkstatus_vote_find_entry(consensus, desc->identity_digest);
  4038. if (rs && tor_memeq(rs->descriptor_digest,
  4039. desc->signed_descriptor_digest, DIGEST_LEN))
  4040. return 1;
  4041. }
  4042. return 0;
  4043. }
  4044. /** Update downloads for router descriptors and/or microdescriptors as
  4045. * appropriate. */
  4046. void
  4047. update_all_descriptor_downloads(time_t now)
  4048. {
  4049. if (get_options()->DisableNetwork)
  4050. return;
  4051. update_router_descriptor_downloads(now);
  4052. update_microdesc_downloads(now);
  4053. launch_dummy_descriptor_download_as_needed(now, get_options());
  4054. }
  4055. /** Clear all our timeouts for fetching v3 directory stuff, and then
  4056. * give it all a try again. */
  4057. void
  4058. routerlist_retry_directory_downloads(time_t now)
  4059. {
  4060. (void)now;
  4061. log_debug(LD_GENERAL,
  4062. "In routerlist_retry_directory_downloads()");
  4063. router_reset_status_download_failures();
  4064. router_reset_descriptor_download_failures();
  4065. reschedule_directory_downloads();
  4066. }
  4067. /** Return true iff <b>router</b> does not permit exit streams.
  4068. */
  4069. int
  4070. router_exit_policy_rejects_all(const routerinfo_t *router)
  4071. {
  4072. return router->policy_is_reject_star;
  4073. }
  4074. /** Create a directory server at <b>address</b>:<b>port</b>, with OR identity
  4075. * key <b>digest</b> which has DIGEST_LEN bytes. If <b>address</b> is NULL,
  4076. * add ourself. If <b>is_authority</b>, this is a directory authority. Return
  4077. * the new directory server entry on success or NULL on failure. */
  4078. static dir_server_t *
  4079. dir_server_new(int is_authority,
  4080. const char *nickname,
  4081. const tor_addr_t *addr,
  4082. const char *hostname,
  4083. uint16_t dir_port, uint16_t or_port,
  4084. const tor_addr_port_t *addrport_ipv6,
  4085. const char *digest, const char *v3_auth_digest,
  4086. dirinfo_type_t type,
  4087. double weight)
  4088. {
  4089. dir_server_t *ent;
  4090. uint32_t a;
  4091. char *hostname_ = NULL;
  4092. tor_assert(digest);
  4093. if (weight < 0)
  4094. return NULL;
  4095. if (tor_addr_family(addr) == AF_INET)
  4096. a = tor_addr_to_ipv4h(addr);
  4097. else
  4098. return NULL;
  4099. if (!hostname)
  4100. hostname_ = tor_addr_to_str_dup(addr);
  4101. else
  4102. hostname_ = tor_strdup(hostname);
  4103. ent = tor_malloc_zero(sizeof(dir_server_t));
  4104. ent->nickname = nickname ? tor_strdup(nickname) : NULL;
  4105. ent->address = hostname_;
  4106. ent->addr = a;
  4107. ent->dir_port = dir_port;
  4108. ent->or_port = or_port;
  4109. ent->is_running = 1;
  4110. ent->is_authority = is_authority;
  4111. ent->type = type;
  4112. ent->weight = weight;
  4113. if (addrport_ipv6) {
  4114. if (tor_addr_family(&addrport_ipv6->addr) != AF_INET6) {
  4115. log_warn(LD_BUG, "Hey, I got a non-ipv6 addr as addrport_ipv6.");
  4116. tor_addr_make_unspec(&ent->ipv6_addr);
  4117. } else {
  4118. tor_addr_copy(&ent->ipv6_addr, &addrport_ipv6->addr);
  4119. ent->ipv6_orport = addrport_ipv6->port;
  4120. }
  4121. } else {
  4122. tor_addr_make_unspec(&ent->ipv6_addr);
  4123. }
  4124. memcpy(ent->digest, digest, DIGEST_LEN);
  4125. if (v3_auth_digest && (type & V3_DIRINFO))
  4126. memcpy(ent->v3_identity_digest, v3_auth_digest, DIGEST_LEN);
  4127. if (nickname)
  4128. tor_asprintf(&ent->description, "directory server \"%s\" at %s:%d",
  4129. nickname, hostname_, (int)dir_port);
  4130. else
  4131. tor_asprintf(&ent->description, "directory server at %s:%d",
  4132. hostname_, (int)dir_port);
  4133. ent->fake_status.addr = ent->addr;
  4134. tor_addr_copy(&ent->fake_status.ipv6_addr, &ent->ipv6_addr);
  4135. memcpy(ent->fake_status.identity_digest, digest, DIGEST_LEN);
  4136. if (nickname)
  4137. strlcpy(ent->fake_status.nickname, nickname,
  4138. sizeof(ent->fake_status.nickname));
  4139. else
  4140. ent->fake_status.nickname[0] = '\0';
  4141. ent->fake_status.dir_port = ent->dir_port;
  4142. ent->fake_status.or_port = ent->or_port;
  4143. ent->fake_status.ipv6_orport = ent->ipv6_orport;
  4144. return ent;
  4145. }
  4146. /** Create an authoritative directory server at
  4147. * <b>address</b>:<b>port</b>, with identity key <b>digest</b>. If
  4148. * <b>address</b> is NULL, add ourself. Return the new trusted directory
  4149. * server entry on success or NULL if we couldn't add it. */
  4150. dir_server_t *
  4151. trusted_dir_server_new(const char *nickname, const char *address,
  4152. uint16_t dir_port, uint16_t or_port,
  4153. const tor_addr_port_t *ipv6_addrport,
  4154. const char *digest, const char *v3_auth_digest,
  4155. dirinfo_type_t type, double weight)
  4156. {
  4157. uint32_t a;
  4158. tor_addr_t addr;
  4159. char *hostname=NULL;
  4160. dir_server_t *result;
  4161. if (!address) { /* The address is us; we should guess. */
  4162. if (resolve_my_address(LOG_WARN, get_options(),
  4163. &a, NULL, &hostname) < 0) {
  4164. log_warn(LD_CONFIG,
  4165. "Couldn't find a suitable address when adding ourself as a "
  4166. "trusted directory server.");
  4167. return NULL;
  4168. }
  4169. if (!hostname)
  4170. hostname = tor_dup_ip(a);
  4171. } else {
  4172. if (tor_lookup_hostname(address, &a)) {
  4173. log_warn(LD_CONFIG,
  4174. "Unable to lookup address for directory server at '%s'",
  4175. address);
  4176. return NULL;
  4177. }
  4178. hostname = tor_strdup(address);
  4179. }
  4180. tor_addr_from_ipv4h(&addr, a);
  4181. result = dir_server_new(1, nickname, &addr, hostname,
  4182. dir_port, or_port,
  4183. ipv6_addrport,
  4184. digest,
  4185. v3_auth_digest, type, weight);
  4186. tor_free(hostname);
  4187. return result;
  4188. }
  4189. /** Return a new dir_server_t for a fallback directory server at
  4190. * <b>addr</b>:<b>or_port</b>/<b>dir_port</b>, with identity key digest
  4191. * <b>id_digest</b> */
  4192. dir_server_t *
  4193. fallback_dir_server_new(const tor_addr_t *addr,
  4194. uint16_t dir_port, uint16_t or_port,
  4195. const tor_addr_port_t *addrport_ipv6,
  4196. const char *id_digest, double weight)
  4197. {
  4198. return dir_server_new(0, NULL, addr, NULL, dir_port, or_port,
  4199. addrport_ipv6,
  4200. id_digest,
  4201. NULL, ALL_DIRINFO, weight);
  4202. }
  4203. /** Add a directory server to the global list(s). */
  4204. void
  4205. dir_server_add(dir_server_t *ent)
  4206. {
  4207. if (!trusted_dir_servers)
  4208. trusted_dir_servers = smartlist_new();
  4209. if (!fallback_dir_servers)
  4210. fallback_dir_servers = smartlist_new();
  4211. if (ent->is_authority)
  4212. smartlist_add(trusted_dir_servers, ent);
  4213. smartlist_add(fallback_dir_servers, ent);
  4214. router_dir_info_changed();
  4215. }
  4216. /** Free storage held in <b>cert</b>. */
  4217. void
  4218. authority_cert_free(authority_cert_t *cert)
  4219. {
  4220. if (!cert)
  4221. return;
  4222. tor_free(cert->cache_info.signed_descriptor_body);
  4223. crypto_pk_free(cert->signing_key);
  4224. crypto_pk_free(cert->identity_key);
  4225. tor_free(cert);
  4226. }
  4227. /** Free storage held in <b>ds</b>. */
  4228. static void
  4229. dir_server_free(dir_server_t *ds)
  4230. {
  4231. if (!ds)
  4232. return;
  4233. tor_free(ds->nickname);
  4234. tor_free(ds->description);
  4235. tor_free(ds->address);
  4236. tor_free(ds);
  4237. }
  4238. /** Remove all members from the list of dir servers. */
  4239. void
  4240. clear_dir_servers(void)
  4241. {
  4242. if (fallback_dir_servers) {
  4243. SMARTLIST_FOREACH(fallback_dir_servers, dir_server_t *, ent,
  4244. dir_server_free(ent));
  4245. smartlist_clear(fallback_dir_servers);
  4246. } else {
  4247. fallback_dir_servers = smartlist_new();
  4248. }
  4249. if (trusted_dir_servers) {
  4250. smartlist_clear(trusted_dir_servers);
  4251. } else {
  4252. trusted_dir_servers = smartlist_new();
  4253. }
  4254. router_dir_info_changed();
  4255. }
  4256. /** For every current directory connection whose purpose is <b>purpose</b>,
  4257. * and where the resource being downloaded begins with <b>prefix</b>, split
  4258. * rest of the resource into base16 fingerprints (or base64 fingerprints if
  4259. * purpose==DIR_PURPOSE_FETCH_MICRODESC), decode them, and set the
  4260. * corresponding elements of <b>result</b> to a nonzero value.
  4261. */
  4262. static void
  4263. list_pending_downloads(digestmap_t *result, digest256map_t *result256,
  4264. int purpose, const char *prefix)
  4265. {
  4266. const size_t p_len = strlen(prefix);
  4267. smartlist_t *tmp = smartlist_new();
  4268. smartlist_t *conns = get_connection_array();
  4269. int flags = DSR_HEX;
  4270. if (purpose == DIR_PURPOSE_FETCH_MICRODESC)
  4271. flags = DSR_DIGEST256|DSR_BASE64;
  4272. tor_assert(result || result256);
  4273. SMARTLIST_FOREACH_BEGIN(conns, connection_t *, conn) {
  4274. if (conn->type == CONN_TYPE_DIR &&
  4275. conn->purpose == purpose &&
  4276. !conn->marked_for_close) {
  4277. const char *resource = TO_DIR_CONN(conn)->requested_resource;
  4278. if (!strcmpstart(resource, prefix))
  4279. dir_split_resource_into_fingerprints(resource + p_len,
  4280. tmp, NULL, flags);
  4281. }
  4282. } SMARTLIST_FOREACH_END(conn);
  4283. if (result) {
  4284. SMARTLIST_FOREACH(tmp, char *, d,
  4285. {
  4286. digestmap_set(result, d, (void*)1);
  4287. tor_free(d);
  4288. });
  4289. } else if (result256) {
  4290. SMARTLIST_FOREACH(tmp, uint8_t *, d,
  4291. {
  4292. digest256map_set(result256, d, (void*)1);
  4293. tor_free(d);
  4294. });
  4295. }
  4296. smartlist_free(tmp);
  4297. }
  4298. /** For every router descriptor (or extra-info document if <b>extrainfo</b> is
  4299. * true) we are currently downloading by descriptor digest, set result[d] to
  4300. * (void*)1. */
  4301. static void
  4302. list_pending_descriptor_downloads(digestmap_t *result, int extrainfo)
  4303. {
  4304. int purpose =
  4305. extrainfo ? DIR_PURPOSE_FETCH_EXTRAINFO : DIR_PURPOSE_FETCH_SERVERDESC;
  4306. list_pending_downloads(result, NULL, purpose, "d/");
  4307. }
  4308. /** For every microdescriptor we are currently downloading by descriptor
  4309. * digest, set result[d] to (void*)1.
  4310. */
  4311. void
  4312. list_pending_microdesc_downloads(digest256map_t *result)
  4313. {
  4314. list_pending_downloads(NULL, result, DIR_PURPOSE_FETCH_MICRODESC, "d/");
  4315. }
  4316. /** For every certificate we are currently downloading by (identity digest,
  4317. * signing key digest) pair, set result[fp_pair] to (void *1).
  4318. */
  4319. static void
  4320. list_pending_fpsk_downloads(fp_pair_map_t *result)
  4321. {
  4322. const char *pfx = "fp-sk/";
  4323. smartlist_t *tmp;
  4324. smartlist_t *conns;
  4325. const char *resource;
  4326. tor_assert(result);
  4327. tmp = smartlist_new();
  4328. conns = get_connection_array();
  4329. SMARTLIST_FOREACH_BEGIN(conns, connection_t *, conn) {
  4330. if (conn->type == CONN_TYPE_DIR &&
  4331. conn->purpose == DIR_PURPOSE_FETCH_CERTIFICATE &&
  4332. !conn->marked_for_close) {
  4333. resource = TO_DIR_CONN(conn)->requested_resource;
  4334. if (!strcmpstart(resource, pfx))
  4335. dir_split_resource_into_fingerprint_pairs(resource + strlen(pfx),
  4336. tmp);
  4337. }
  4338. } SMARTLIST_FOREACH_END(conn);
  4339. SMARTLIST_FOREACH_BEGIN(tmp, fp_pair_t *, fp) {
  4340. fp_pair_map_set(result, fp, (void*)1);
  4341. tor_free(fp);
  4342. } SMARTLIST_FOREACH_END(fp);
  4343. smartlist_free(tmp);
  4344. }
  4345. /** Launch downloads for all the descriptors whose digests or digests256
  4346. * are listed as digests[i] for lo <= i < hi. (Lo and hi may be out of
  4347. * range.) If <b>source</b> is given, download from <b>source</b>;
  4348. * otherwise, download from an appropriate random directory server.
  4349. */
  4350. MOCK_IMPL(STATIC void, initiate_descriptor_downloads,
  4351. (const routerstatus_t *source, int purpose, smartlist_t *digests,
  4352. int lo, int hi, int pds_flags))
  4353. {
  4354. char *resource, *cp;
  4355. int digest_len, enc_digest_len;
  4356. const char *sep;
  4357. int b64_256;
  4358. smartlist_t *tmp;
  4359. if (purpose == DIR_PURPOSE_FETCH_MICRODESC) {
  4360. /* Microdescriptors are downloaded by "-"-separated base64-encoded
  4361. * 256-bit digests. */
  4362. digest_len = DIGEST256_LEN;
  4363. enc_digest_len = BASE64_DIGEST256_LEN + 1;
  4364. sep = "-";
  4365. b64_256 = 1;
  4366. } else {
  4367. digest_len = DIGEST_LEN;
  4368. enc_digest_len = HEX_DIGEST_LEN + 1;
  4369. sep = "+";
  4370. b64_256 = 0;
  4371. }
  4372. if (lo < 0)
  4373. lo = 0;
  4374. if (hi > smartlist_len(digests))
  4375. hi = smartlist_len(digests);
  4376. if (hi-lo <= 0)
  4377. return;
  4378. tmp = smartlist_new();
  4379. for (; lo < hi; ++lo) {
  4380. cp = tor_malloc(enc_digest_len);
  4381. if (b64_256) {
  4382. digest256_to_base64(cp, smartlist_get(digests, lo));
  4383. } else {
  4384. base16_encode(cp, enc_digest_len, smartlist_get(digests, lo),
  4385. digest_len);
  4386. }
  4387. smartlist_add(tmp, cp);
  4388. }
  4389. cp = smartlist_join_strings(tmp, sep, 0, NULL);
  4390. tor_asprintf(&resource, "d/%s.z", cp);
  4391. SMARTLIST_FOREACH(tmp, char *, cp1, tor_free(cp1));
  4392. smartlist_free(tmp);
  4393. tor_free(cp);
  4394. if (source) {
  4395. /* We know which authority or directory mirror we want. */
  4396. directory_initiate_command_routerstatus(source, purpose,
  4397. ROUTER_PURPOSE_GENERAL,
  4398. DIRIND_ONEHOP,
  4399. resource, NULL, 0, 0, NULL);
  4400. } else {
  4401. directory_get_from_dirserver(purpose, ROUTER_PURPOSE_GENERAL, resource,
  4402. pds_flags, DL_WANT_ANY_DIRSERVER);
  4403. }
  4404. tor_free(resource);
  4405. }
  4406. /** Return the max number of hashes to put in a URL for a given request.
  4407. */
  4408. static int
  4409. max_dl_per_request(const or_options_t *options, int purpose)
  4410. {
  4411. /* Since squid does not like URLs >= 4096 bytes we limit it to 96.
  4412. * 4096 - strlen(http://[ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff]:65535
  4413. * /tor/server/d/.z) == 4026
  4414. * 4026/41 (40 for the hash and 1 for the + that separates them) => 98
  4415. * So use 96 because it's a nice number.
  4416. *
  4417. * For microdescriptors, the calculation is
  4418. * 4096 - strlen(http://[ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff]:65535
  4419. * /tor/micro/d/.z) == 4027
  4420. * 4027/44 (43 for the hash and 1 for the - that separates them) => 91
  4421. * So use 90 because it's a nice number.
  4422. */
  4423. int max = 96;
  4424. if (purpose == DIR_PURPOSE_FETCH_MICRODESC) {
  4425. max = 90;
  4426. }
  4427. /* If we're going to tunnel our connections, we can ask for a lot more
  4428. * in a request. */
  4429. if (directory_must_use_begindir(options)) {
  4430. max = 500;
  4431. }
  4432. return max;
  4433. }
  4434. /** Don't split our requests so finely that we are requesting fewer than
  4435. * this number per server. */
  4436. #define MIN_DL_PER_REQUEST 4
  4437. /** To prevent a single screwy cache from confusing us by selective reply,
  4438. * try to split our requests into at least this many requests. */
  4439. #define MIN_REQUESTS 3
  4440. /** If we want fewer than this many descriptors, wait until we
  4441. * want more, or until TestingClientMaxIntervalWithoutRequest has passed. */
  4442. #define MAX_DL_TO_DELAY 16
  4443. /** Given a <b>purpose</b> (FETCH_MICRODESC or FETCH_SERVERDESC) and a list of
  4444. * router descriptor digests or microdescriptor digest256s in
  4445. * <b>downloadable</b>, decide whether to delay fetching until we have more.
  4446. * If we don't want to delay, launch one or more requests to the appropriate
  4447. * directory authorities.
  4448. */
  4449. void
  4450. launch_descriptor_downloads(int purpose,
  4451. smartlist_t *downloadable,
  4452. const routerstatus_t *source, time_t now)
  4453. {
  4454. const or_options_t *options = get_options();
  4455. const char *descname;
  4456. const int fetch_microdesc = (purpose == DIR_PURPOSE_FETCH_MICRODESC);
  4457. int n_downloadable = smartlist_len(downloadable);
  4458. int i, n_per_request, max_dl_per_req;
  4459. const char *req_plural = "", *rtr_plural = "";
  4460. int pds_flags = PDS_RETRY_IF_NO_SERVERS;
  4461. tor_assert(fetch_microdesc || purpose == DIR_PURPOSE_FETCH_SERVERDESC);
  4462. descname = fetch_microdesc ? "microdesc" : "routerdesc";
  4463. if (!n_downloadable)
  4464. return;
  4465. if (!directory_fetches_dir_info_early(options)) {
  4466. if (n_downloadable >= MAX_DL_TO_DELAY) {
  4467. log_debug(LD_DIR,
  4468. "There are enough downloadable %ss to launch requests.",
  4469. descname);
  4470. } else {
  4471. /* should delay */
  4472. if ((last_descriptor_download_attempted +
  4473. options->TestingClientMaxIntervalWithoutRequest) > now)
  4474. return;
  4475. if (last_descriptor_download_attempted) {
  4476. log_info(LD_DIR,
  4477. "There are not many downloadable %ss, but we've "
  4478. "been waiting long enough (%d seconds). Downloading.",
  4479. descname,
  4480. (int)(now-last_descriptor_download_attempted));
  4481. } else {
  4482. log_info(LD_DIR,
  4483. "There are not many downloadable %ss, but we haven't "
  4484. "tried downloading descriptors recently. Downloading.",
  4485. descname);
  4486. }
  4487. }
  4488. }
  4489. if (!authdir_mode_any_nonhidserv(options)) {
  4490. /* If we wind up going to the authorities, we want to only open one
  4491. * connection to each authority at a time, so that we don't overload
  4492. * them. We do this by setting PDS_NO_EXISTING_SERVERDESC_FETCH
  4493. * regardless of whether we're a cache or not.
  4494. *
  4495. * Setting this flag can make initiate_descriptor_downloads() ignore
  4496. * requests. We need to make sure that we do in fact call
  4497. * update_router_descriptor_downloads() later on, once the connections
  4498. * have succeeded or failed.
  4499. */
  4500. pds_flags |= fetch_microdesc ?
  4501. PDS_NO_EXISTING_MICRODESC_FETCH :
  4502. PDS_NO_EXISTING_SERVERDESC_FETCH;
  4503. }
  4504. n_per_request = CEIL_DIV(n_downloadable, MIN_REQUESTS);
  4505. max_dl_per_req = max_dl_per_request(options, purpose);
  4506. if (n_per_request > max_dl_per_req)
  4507. n_per_request = max_dl_per_req;
  4508. if (n_per_request < MIN_DL_PER_REQUEST)
  4509. n_per_request = MIN_DL_PER_REQUEST;
  4510. if (n_downloadable > n_per_request)
  4511. req_plural = rtr_plural = "s";
  4512. else if (n_downloadable > 1)
  4513. rtr_plural = "s";
  4514. log_info(LD_DIR,
  4515. "Launching %d request%s for %d %s%s, %d at a time",
  4516. CEIL_DIV(n_downloadable, n_per_request), req_plural,
  4517. n_downloadable, descname, rtr_plural, n_per_request);
  4518. smartlist_sort_digests(downloadable);
  4519. for (i=0; i < n_downloadable; i += n_per_request) {
  4520. initiate_descriptor_downloads(source, purpose,
  4521. downloadable, i, i+n_per_request,
  4522. pds_flags);
  4523. }
  4524. last_descriptor_download_attempted = now;
  4525. }
  4526. /** For any descriptor that we want that's currently listed in
  4527. * <b>consensus</b>, download it as appropriate. */
  4528. void
  4529. update_consensus_router_descriptor_downloads(time_t now, int is_vote,
  4530. networkstatus_t *consensus)
  4531. {
  4532. const or_options_t *options = get_options();
  4533. digestmap_t *map = NULL;
  4534. smartlist_t *no_longer_old = smartlist_new();
  4535. smartlist_t *downloadable = smartlist_new();
  4536. routerstatus_t *source = NULL;
  4537. int authdir = authdir_mode(options);
  4538. int n_delayed=0, n_have=0, n_would_reject=0, n_wouldnt_use=0,
  4539. n_inprogress=0, n_in_oldrouters=0;
  4540. if (directory_too_idle_to_fetch_descriptors(options, now))
  4541. goto done;
  4542. if (!consensus)
  4543. goto done;
  4544. if (is_vote) {
  4545. /* where's it from, so we know whom to ask for descriptors */
  4546. dir_server_t *ds;
  4547. networkstatus_voter_info_t *voter = smartlist_get(consensus->voters, 0);
  4548. tor_assert(voter);
  4549. ds = trusteddirserver_get_by_v3_auth_digest(voter->identity_digest);
  4550. if (ds)
  4551. source = &(ds->fake_status);
  4552. else
  4553. log_warn(LD_DIR, "couldn't lookup source from vote?");
  4554. }
  4555. map = digestmap_new();
  4556. list_pending_descriptor_downloads(map, 0);
  4557. SMARTLIST_FOREACH_BEGIN(consensus->routerstatus_list, void *, rsp) {
  4558. routerstatus_t *rs =
  4559. is_vote ? &(((vote_routerstatus_t *)rsp)->status) : rsp;
  4560. signed_descriptor_t *sd;
  4561. if ((sd = router_get_by_descriptor_digest(rs->descriptor_digest))) {
  4562. const routerinfo_t *ri;
  4563. ++n_have;
  4564. if (!(ri = router_get_by_id_digest(rs->identity_digest)) ||
  4565. tor_memneq(ri->cache_info.signed_descriptor_digest,
  4566. sd->signed_descriptor_digest, DIGEST_LEN)) {
  4567. /* We have a descriptor with this digest, but either there is no
  4568. * entry in routerlist with the same ID (!ri), or there is one,
  4569. * but the identity digest differs (memneq).
  4570. */
  4571. smartlist_add(no_longer_old, sd);
  4572. ++n_in_oldrouters; /* We have it in old_routers. */
  4573. }
  4574. continue; /* We have it already. */
  4575. }
  4576. if (digestmap_get(map, rs->descriptor_digest)) {
  4577. ++n_inprogress;
  4578. continue; /* We have an in-progress download. */
  4579. }
  4580. if (!download_status_is_ready(&rs->dl_status, now,
  4581. options->TestingDescriptorMaxDownloadTries)) {
  4582. ++n_delayed; /* Not ready for retry. */
  4583. continue;
  4584. }
  4585. if (authdir && dirserv_would_reject_router(rs)) {
  4586. ++n_would_reject;
  4587. continue; /* We would throw it out immediately. */
  4588. }
  4589. if (!we_want_to_fetch_flavor(options, consensus->flavor) &&
  4590. !client_would_use_router(rs, now, options)) {
  4591. ++n_wouldnt_use;
  4592. continue; /* We would never use it ourself. */
  4593. }
  4594. if (is_vote && source) {
  4595. char time_bufnew[ISO_TIME_LEN+1];
  4596. char time_bufold[ISO_TIME_LEN+1];
  4597. const routerinfo_t *oldrouter;
  4598. oldrouter = router_get_by_id_digest(rs->identity_digest);
  4599. format_iso_time(time_bufnew, rs->published_on);
  4600. if (oldrouter)
  4601. format_iso_time(time_bufold, oldrouter->cache_info.published_on);
  4602. log_info(LD_DIR, "Learned about %s (%s vs %s) from %s's vote (%s)",
  4603. routerstatus_describe(rs),
  4604. time_bufnew,
  4605. oldrouter ? time_bufold : "none",
  4606. source->nickname, oldrouter ? "known" : "unknown");
  4607. }
  4608. smartlist_add(downloadable, rs->descriptor_digest);
  4609. } SMARTLIST_FOREACH_END(rsp);
  4610. if (!authdir_mode_handles_descs(options, ROUTER_PURPOSE_GENERAL)
  4611. && smartlist_len(no_longer_old)) {
  4612. routerlist_t *rl = router_get_routerlist();
  4613. log_info(LD_DIR, "%d router descriptors listed in consensus are "
  4614. "currently in old_routers; making them current.",
  4615. smartlist_len(no_longer_old));
  4616. SMARTLIST_FOREACH_BEGIN(no_longer_old, signed_descriptor_t *, sd) {
  4617. const char *msg;
  4618. was_router_added_t r;
  4619. routerinfo_t *ri = routerlist_reparse_old(rl, sd);
  4620. if (!ri) {
  4621. log_warn(LD_BUG, "Failed to re-parse a router.");
  4622. continue;
  4623. }
  4624. r = router_add_to_routerlist(ri, &msg, 1, 0);
  4625. if (WRA_WAS_OUTDATED(r)) {
  4626. log_warn(LD_DIR, "Couldn't add re-parsed router: %s",
  4627. msg?msg:"???");
  4628. }
  4629. } SMARTLIST_FOREACH_END(sd);
  4630. routerlist_assert_ok(rl);
  4631. }
  4632. log_info(LD_DIR,
  4633. "%d router descriptors downloadable. %d delayed; %d present "
  4634. "(%d of those were in old_routers); %d would_reject; "
  4635. "%d wouldnt_use; %d in progress.",
  4636. smartlist_len(downloadable), n_delayed, n_have, n_in_oldrouters,
  4637. n_would_reject, n_wouldnt_use, n_inprogress);
  4638. launch_descriptor_downloads(DIR_PURPOSE_FETCH_SERVERDESC,
  4639. downloadable, source, now);
  4640. digestmap_free(map, NULL);
  4641. done:
  4642. smartlist_free(downloadable);
  4643. smartlist_free(no_longer_old);
  4644. }
  4645. /** How often should we launch a server/authority request to be sure of getting
  4646. * a guess for our IP? */
  4647. /*XXXX+ this info should come from netinfo cells or something, or we should
  4648. * do this only when we aren't seeing incoming data. see bug 652. */
  4649. #define DUMMY_DOWNLOAD_INTERVAL (20*60)
  4650. /** As needed, launch a dummy router descriptor fetch to see if our
  4651. * address has changed. */
  4652. static void
  4653. launch_dummy_descriptor_download_as_needed(time_t now,
  4654. const or_options_t *options)
  4655. {
  4656. static time_t last_dummy_download = 0;
  4657. /* XXXX+ we could be smarter here; see notes on bug 652. */
  4658. /* If we're a server that doesn't have a configured address, we rely on
  4659. * directory fetches to learn when our address changes. So if we haven't
  4660. * tried to get any routerdescs in a long time, try a dummy fetch now. */
  4661. if (!options->Address &&
  4662. server_mode(options) &&
  4663. last_descriptor_download_attempted + DUMMY_DOWNLOAD_INTERVAL < now &&
  4664. last_dummy_download + DUMMY_DOWNLOAD_INTERVAL < now) {
  4665. last_dummy_download = now;
  4666. /* XX/teor - do we want an authority here, because they are less likely
  4667. * to give us the wrong address? (See #17782)
  4668. * I'm leaving the previous behaviour intact, because I don't like
  4669. * the idea of some relays contacting an authority every 20 minutes. */
  4670. directory_get_from_dirserver(DIR_PURPOSE_FETCH_SERVERDESC,
  4671. ROUTER_PURPOSE_GENERAL, "authority.z",
  4672. PDS_RETRY_IF_NO_SERVERS,
  4673. DL_WANT_ANY_DIRSERVER);
  4674. }
  4675. }
  4676. /** Launch downloads for router status as needed. */
  4677. void
  4678. update_router_descriptor_downloads(time_t now)
  4679. {
  4680. const or_options_t *options = get_options();
  4681. if (should_delay_dir_fetches(options, NULL))
  4682. return;
  4683. if (!we_fetch_router_descriptors(options))
  4684. return;
  4685. update_consensus_router_descriptor_downloads(now, 0,
  4686. networkstatus_get_reasonably_live_consensus(now, FLAV_NS));
  4687. }
  4688. /** Launch extrainfo downloads as needed. */
  4689. void
  4690. update_extrainfo_downloads(time_t now)
  4691. {
  4692. const or_options_t *options = get_options();
  4693. routerlist_t *rl;
  4694. smartlist_t *wanted;
  4695. digestmap_t *pending;
  4696. int old_routers, i, max_dl_per_req;
  4697. int n_no_ei = 0, n_pending = 0, n_have = 0, n_delay = 0, n_bogus[2] = {0,0};
  4698. if (! options->DownloadExtraInfo)
  4699. return;
  4700. if (should_delay_dir_fetches(options, NULL))
  4701. return;
  4702. if (!router_have_minimum_dir_info())
  4703. return;
  4704. pending = digestmap_new();
  4705. list_pending_descriptor_downloads(pending, 1);
  4706. rl = router_get_routerlist();
  4707. wanted = smartlist_new();
  4708. for (old_routers = 0; old_routers < 2; ++old_routers) {
  4709. smartlist_t *lst = old_routers ? rl->old_routers : rl->routers;
  4710. for (i = 0; i < smartlist_len(lst); ++i) {
  4711. signed_descriptor_t *sd;
  4712. char *d;
  4713. if (old_routers)
  4714. sd = smartlist_get(lst, i);
  4715. else
  4716. sd = &((routerinfo_t*)smartlist_get(lst, i))->cache_info;
  4717. if (sd->is_extrainfo)
  4718. continue; /* This should never happen. */
  4719. if (old_routers && !router_get_by_id_digest(sd->identity_digest))
  4720. continue; /* Couldn't check the signature if we got it. */
  4721. if (sd->extrainfo_is_bogus)
  4722. continue;
  4723. d = sd->extra_info_digest;
  4724. if (tor_digest_is_zero(d)) {
  4725. ++n_no_ei;
  4726. continue;
  4727. }
  4728. if (eimap_get(rl->extra_info_map, d)) {
  4729. ++n_have;
  4730. continue;
  4731. }
  4732. if (!download_status_is_ready(&sd->ei_dl_status, now,
  4733. options->TestingDescriptorMaxDownloadTries)) {
  4734. ++n_delay;
  4735. continue;
  4736. }
  4737. if (digestmap_get(pending, d)) {
  4738. ++n_pending;
  4739. continue;
  4740. }
  4741. const signed_descriptor_t *sd2 = router_get_by_extrainfo_digest(d);
  4742. if (sd2 != sd) {
  4743. if (sd2 != NULL) {
  4744. char d1[HEX_DIGEST_LEN+1], d2[HEX_DIGEST_LEN+1];
  4745. char d3[HEX_DIGEST_LEN+1], d4[HEX_DIGEST_LEN+1];
  4746. base16_encode(d1, sizeof(d1), sd->identity_digest, DIGEST_LEN);
  4747. base16_encode(d2, sizeof(d2), sd2->identity_digest, DIGEST_LEN);
  4748. base16_encode(d3, sizeof(d3), d, DIGEST_LEN);
  4749. base16_encode(d4, sizeof(d3), sd2->extra_info_digest, DIGEST_LEN);
  4750. log_info(LD_DIR, "Found an entry in %s with mismatched "
  4751. "router_get_by_extrainfo_digest() value. This has ID %s "
  4752. "but the entry in the map has ID %s. This has EI digest "
  4753. "%s and the entry in the map has EI digest %s.",
  4754. old_routers?"old_routers":"routers",
  4755. d1, d2, d3, d4);
  4756. } else {
  4757. char d1[HEX_DIGEST_LEN+1], d2[HEX_DIGEST_LEN+1];
  4758. base16_encode(d1, sizeof(d1), sd->identity_digest, DIGEST_LEN);
  4759. base16_encode(d2, sizeof(d2), d, DIGEST_LEN);
  4760. log_info(LD_DIR, "Found an entry in %s with NULL "
  4761. "router_get_by_extrainfo_digest() value. This has ID %s "
  4762. "and EI digest %s.",
  4763. old_routers?"old_routers":"routers",
  4764. d1, d2);
  4765. }
  4766. ++n_bogus[old_routers];
  4767. continue;
  4768. }
  4769. smartlist_add(wanted, d);
  4770. }
  4771. }
  4772. digestmap_free(pending, NULL);
  4773. log_info(LD_DIR, "Extrainfo download status: %d router with no ei, %d "
  4774. "with present ei, %d delaying, %d pending, %d downloadable, %d "
  4775. "bogus in routers, %d bogus in old_routers",
  4776. n_no_ei, n_have, n_delay, n_pending, smartlist_len(wanted),
  4777. n_bogus[0], n_bogus[1]);
  4778. smartlist_shuffle(wanted);
  4779. max_dl_per_req = max_dl_per_request(options, DIR_PURPOSE_FETCH_EXTRAINFO);
  4780. for (i = 0; i < smartlist_len(wanted); i += max_dl_per_req) {
  4781. initiate_descriptor_downloads(NULL, DIR_PURPOSE_FETCH_EXTRAINFO,
  4782. wanted, i, i+max_dl_per_req,
  4783. PDS_RETRY_IF_NO_SERVERS|PDS_NO_EXISTING_SERVERDESC_FETCH);
  4784. }
  4785. smartlist_free(wanted);
  4786. }
  4787. /** Reset the descriptor download failure count on all routers, so that we
  4788. * can retry any long-failed routers immediately.
  4789. */
  4790. void
  4791. router_reset_descriptor_download_failures(void)
  4792. {
  4793. log_debug(LD_GENERAL,
  4794. "In router_reset_descriptor_download_failures()");
  4795. networkstatus_reset_download_failures();
  4796. last_descriptor_download_attempted = 0;
  4797. if (!routerlist)
  4798. return;
  4799. SMARTLIST_FOREACH(routerlist->routers, routerinfo_t *, ri,
  4800. {
  4801. download_status_reset(&ri->cache_info.ei_dl_status);
  4802. });
  4803. SMARTLIST_FOREACH(routerlist->old_routers, signed_descriptor_t *, sd,
  4804. {
  4805. download_status_reset(&sd->ei_dl_status);
  4806. });
  4807. }
  4808. /** Any changes in a router descriptor's publication time larger than this are
  4809. * automatically non-cosmetic. */
  4810. #define ROUTER_MAX_COSMETIC_TIME_DIFFERENCE (2*60*60)
  4811. /** We allow uptime to vary from how much it ought to be by this much. */
  4812. #define ROUTER_ALLOW_UPTIME_DRIFT (6*60*60)
  4813. /** Return true iff the only differences between r1 and r2 are such that
  4814. * would not cause a recent (post 0.1.1.6) dirserver to republish.
  4815. */
  4816. int
  4817. router_differences_are_cosmetic(const routerinfo_t *r1, const routerinfo_t *r2)
  4818. {
  4819. time_t r1pub, r2pub;
  4820. long time_difference;
  4821. tor_assert(r1 && r2);
  4822. /* r1 should be the one that was published first. */
  4823. if (r1->cache_info.published_on > r2->cache_info.published_on) {
  4824. const routerinfo_t *ri_tmp = r2;
  4825. r2 = r1;
  4826. r1 = ri_tmp;
  4827. }
  4828. /* If any key fields differ, they're different. */
  4829. if (r1->addr != r2->addr ||
  4830. strcasecmp(r1->nickname, r2->nickname) ||
  4831. r1->or_port != r2->or_port ||
  4832. !tor_addr_eq(&r1->ipv6_addr, &r2->ipv6_addr) ||
  4833. r1->ipv6_orport != r2->ipv6_orport ||
  4834. r1->dir_port != r2->dir_port ||
  4835. r1->purpose != r2->purpose ||
  4836. !crypto_pk_eq_keys(r1->onion_pkey, r2->onion_pkey) ||
  4837. !crypto_pk_eq_keys(r1->identity_pkey, r2->identity_pkey) ||
  4838. strcasecmp(r1->platform, r2->platform) ||
  4839. (r1->contact_info && !r2->contact_info) || /* contact_info is optional */
  4840. (!r1->contact_info && r2->contact_info) ||
  4841. (r1->contact_info && r2->contact_info &&
  4842. strcasecmp(r1->contact_info, r2->contact_info)) ||
  4843. r1->is_hibernating != r2->is_hibernating ||
  4844. ! addr_policies_eq(r1->exit_policy, r2->exit_policy) ||
  4845. (r1->supports_tunnelled_dir_requests !=
  4846. r2->supports_tunnelled_dir_requests))
  4847. return 0;
  4848. if ((r1->declared_family == NULL) != (r2->declared_family == NULL))
  4849. return 0;
  4850. if (r1->declared_family && r2->declared_family) {
  4851. int i, n;
  4852. if (smartlist_len(r1->declared_family)!=smartlist_len(r2->declared_family))
  4853. return 0;
  4854. n = smartlist_len(r1->declared_family);
  4855. for (i=0; i < n; ++i) {
  4856. if (strcasecmp(smartlist_get(r1->declared_family, i),
  4857. smartlist_get(r2->declared_family, i)))
  4858. return 0;
  4859. }
  4860. }
  4861. /* Did bandwidth change a lot? */
  4862. if ((r1->bandwidthcapacity < r2->bandwidthcapacity/2) ||
  4863. (r2->bandwidthcapacity < r1->bandwidthcapacity/2))
  4864. return 0;
  4865. /* Did the bandwidthrate or bandwidthburst change? */
  4866. if ((r1->bandwidthrate != r2->bandwidthrate) ||
  4867. (r1->bandwidthburst != r2->bandwidthburst))
  4868. return 0;
  4869. /* Did more than 12 hours pass? */
  4870. if (r1->cache_info.published_on + ROUTER_MAX_COSMETIC_TIME_DIFFERENCE
  4871. < r2->cache_info.published_on)
  4872. return 0;
  4873. /* Did uptime fail to increase by approximately the amount we would think,
  4874. * give or take some slop? */
  4875. r1pub = r1->cache_info.published_on;
  4876. r2pub = r2->cache_info.published_on;
  4877. time_difference = labs(r2->uptime - (r1->uptime + (r2pub - r1pub)));
  4878. if (time_difference > ROUTER_ALLOW_UPTIME_DRIFT &&
  4879. time_difference > r1->uptime * .05 &&
  4880. time_difference > r2->uptime * .05)
  4881. return 0;
  4882. /* Otherwise, the difference is cosmetic. */
  4883. return 1;
  4884. }
  4885. /** Check whether <b>sd</b> describes a router descriptor compatible with the
  4886. * extrainfo document <b>ei</b>.
  4887. *
  4888. * <b>identity_pkey</b> (which must also be provided) is RSA1024 identity key
  4889. * for the router. We use it to check the signature of the extrainfo document,
  4890. * if it has not already been checked.
  4891. *
  4892. * If no router is compatible with <b>ei</b>, <b>ei</b> should be
  4893. * dropped. Return 0 for "compatible", return 1 for "reject, and inform
  4894. * whoever uploaded <b>ei</b>, and return -1 for "reject silently.". If
  4895. * <b>msg</b> is present, set *<b>msg</b> to a description of the
  4896. * incompatibility (if any).
  4897. *
  4898. * Set the extrainfo_is_bogus field in <b>sd</b> if the digests matched
  4899. * but the extrainfo was nonetheless incompatible.
  4900. **/
  4901. int
  4902. routerinfo_incompatible_with_extrainfo(const crypto_pk_t *identity_pkey,
  4903. extrainfo_t *ei,
  4904. signed_descriptor_t *sd,
  4905. const char **msg)
  4906. {
  4907. int digest_matches, digest256_matches, r=1;
  4908. tor_assert(identity_pkey);
  4909. tor_assert(sd);
  4910. tor_assert(ei);
  4911. if (ei->bad_sig) {
  4912. if (msg) *msg = "Extrainfo signature was bad, or signed with wrong key.";
  4913. return 1;
  4914. }
  4915. digest_matches = tor_memeq(ei->cache_info.signed_descriptor_digest,
  4916. sd->extra_info_digest, DIGEST_LEN);
  4917. /* Set digest256_matches to 1 if the digest is correct, or if no
  4918. * digest256 was in the ri. */
  4919. digest256_matches = tor_memeq(ei->digest256,
  4920. sd->extra_info_digest256, DIGEST256_LEN);
  4921. digest256_matches |=
  4922. tor_mem_is_zero(sd->extra_info_digest256, DIGEST256_LEN);
  4923. /* The identity must match exactly to have been generated at the same time
  4924. * by the same router. */
  4925. if (tor_memneq(sd->identity_digest,
  4926. ei->cache_info.identity_digest,
  4927. DIGEST_LEN)) {
  4928. if (msg) *msg = "Extrainfo nickname or identity did not match routerinfo";
  4929. goto err; /* different servers */
  4930. }
  4931. if (! tor_cert_opt_eq(sd->signing_key_cert,
  4932. ei->cache_info.signing_key_cert)) {
  4933. if (msg) *msg = "Extrainfo signing key cert didn't match routerinfo";
  4934. goto err; /* different servers */
  4935. }
  4936. if (ei->pending_sig) {
  4937. char signed_digest[128];
  4938. if (crypto_pk_public_checksig(identity_pkey,
  4939. signed_digest, sizeof(signed_digest),
  4940. ei->pending_sig, ei->pending_sig_len) != DIGEST_LEN ||
  4941. tor_memneq(signed_digest, ei->cache_info.signed_descriptor_digest,
  4942. DIGEST_LEN)) {
  4943. ei->bad_sig = 1;
  4944. tor_free(ei->pending_sig);
  4945. if (msg) *msg = "Extrainfo signature bad, or signed with wrong key";
  4946. goto err; /* Bad signature, or no match. */
  4947. }
  4948. ei->cache_info.send_unencrypted = sd->send_unencrypted;
  4949. tor_free(ei->pending_sig);
  4950. }
  4951. if (ei->cache_info.published_on < sd->published_on) {
  4952. if (msg) *msg = "Extrainfo published time did not match routerdesc";
  4953. goto err;
  4954. } else if (ei->cache_info.published_on > sd->published_on) {
  4955. if (msg) *msg = "Extrainfo published time did not match routerdesc";
  4956. r = -1;
  4957. goto err;
  4958. }
  4959. if (!digest256_matches && !digest_matches) {
  4960. if (msg) *msg = "Neither digest256 or digest matched "
  4961. "digest from routerdesc";
  4962. goto err;
  4963. }
  4964. if (!digest256_matches) {
  4965. if (msg) *msg = "Extrainfo digest did not match digest256 from routerdesc";
  4966. goto err; /* Digest doesn't match declared value. */
  4967. }
  4968. if (!digest_matches) {
  4969. if (msg) *msg = "Extrainfo digest did not match value from routerdesc";
  4970. goto err; /* Digest doesn't match declared value. */
  4971. }
  4972. return 0;
  4973. err:
  4974. if (digest_matches) {
  4975. /* This signature was okay, and the digest was right: This is indeed the
  4976. * corresponding extrainfo. But insanely, it doesn't match the routerinfo
  4977. * that lists it. Don't try to fetch this one again. */
  4978. sd->extrainfo_is_bogus = 1;
  4979. }
  4980. return r;
  4981. }
  4982. /* Does ri have a valid ntor onion key?
  4983. * Valid ntor onion keys exist and have at least one non-zero byte. */
  4984. int
  4985. routerinfo_has_curve25519_onion_key(const routerinfo_t *ri)
  4986. {
  4987. if (!ri) {
  4988. return 0;
  4989. }
  4990. if (!ri->onion_curve25519_pkey) {
  4991. return 0;
  4992. }
  4993. if (tor_mem_is_zero((const char*)ri->onion_curve25519_pkey->public_key,
  4994. CURVE25519_PUBKEY_LEN)) {
  4995. return 0;
  4996. }
  4997. return 1;
  4998. }
  4999. /* Is rs running a tor version known to support EXTEND2 cells?
  5000. * If allow_unknown_versions is true, return true if we can't tell
  5001. * (from a versions line or a protocols line) whether it supports extend2
  5002. * cells.
  5003. * Otherwise, return false if the version is unknown. */
  5004. int
  5005. routerstatus_version_supports_extend2_cells(const routerstatus_t *rs,
  5006. int allow_unknown_versions)
  5007. {
  5008. if (!rs) {
  5009. return allow_unknown_versions;
  5010. }
  5011. if (!rs->protocols_known) {
  5012. return allow_unknown_versions;
  5013. }
  5014. return rs->supports_extend2_cells;
  5015. }
  5016. /** Assert that the internal representation of <b>rl</b> is
  5017. * self-consistent. */
  5018. void
  5019. routerlist_assert_ok(const routerlist_t *rl)
  5020. {
  5021. routerinfo_t *r2;
  5022. signed_descriptor_t *sd2;
  5023. if (!rl)
  5024. return;
  5025. SMARTLIST_FOREACH_BEGIN(rl->routers, routerinfo_t *, r) {
  5026. r2 = rimap_get(rl->identity_map, r->cache_info.identity_digest);
  5027. tor_assert(r == r2);
  5028. sd2 = sdmap_get(rl->desc_digest_map,
  5029. r->cache_info.signed_descriptor_digest);
  5030. tor_assert(&(r->cache_info) == sd2);
  5031. tor_assert(r->cache_info.routerlist_index == r_sl_idx);
  5032. /* XXXX
  5033. *
  5034. * Hoo boy. We need to fix this one, and the fix is a bit tricky, so
  5035. * commenting this out is just a band-aid.
  5036. *
  5037. * The problem is that, although well-behaved router descriptors
  5038. * should never have the same value for their extra_info_digest, it's
  5039. * possible for ill-behaved routers to claim whatever they like there.
  5040. *
  5041. * The real answer is to trash desc_by_eid_map and instead have
  5042. * something that indicates for a given extra-info digest we want,
  5043. * what its download status is. We'll do that as a part of routerlist
  5044. * refactoring once consensus directories are in. For now,
  5045. * this rep violation is probably harmless: an adversary can make us
  5046. * reset our retry count for an extrainfo, but that's not the end
  5047. * of the world. Changing the representation in 0.2.0.x would just
  5048. * destabilize the codebase.
  5049. if (!tor_digest_is_zero(r->cache_info.extra_info_digest)) {
  5050. signed_descriptor_t *sd3 =
  5051. sdmap_get(rl->desc_by_eid_map, r->cache_info.extra_info_digest);
  5052. tor_assert(sd3 == &(r->cache_info));
  5053. }
  5054. */
  5055. } SMARTLIST_FOREACH_END(r);
  5056. SMARTLIST_FOREACH_BEGIN(rl->old_routers, signed_descriptor_t *, sd) {
  5057. r2 = rimap_get(rl->identity_map, sd->identity_digest);
  5058. tor_assert(!r2 || sd != &(r2->cache_info));
  5059. sd2 = sdmap_get(rl->desc_digest_map, sd->signed_descriptor_digest);
  5060. tor_assert(sd == sd2);
  5061. tor_assert(sd->routerlist_index == sd_sl_idx);
  5062. /* XXXX see above.
  5063. if (!tor_digest_is_zero(sd->extra_info_digest)) {
  5064. signed_descriptor_t *sd3 =
  5065. sdmap_get(rl->desc_by_eid_map, sd->extra_info_digest);
  5066. tor_assert(sd3 == sd);
  5067. }
  5068. */
  5069. } SMARTLIST_FOREACH_END(sd);
  5070. RIMAP_FOREACH(rl->identity_map, d, r) {
  5071. tor_assert(tor_memeq(r->cache_info.identity_digest, d, DIGEST_LEN));
  5072. } DIGESTMAP_FOREACH_END;
  5073. SDMAP_FOREACH(rl->desc_digest_map, d, sd) {
  5074. tor_assert(tor_memeq(sd->signed_descriptor_digest, d, DIGEST_LEN));
  5075. } DIGESTMAP_FOREACH_END;
  5076. SDMAP_FOREACH(rl->desc_by_eid_map, d, sd) {
  5077. tor_assert(!tor_digest_is_zero(d));
  5078. tor_assert(sd);
  5079. tor_assert(tor_memeq(sd->extra_info_digest, d, DIGEST_LEN));
  5080. } DIGESTMAP_FOREACH_END;
  5081. EIMAP_FOREACH(rl->extra_info_map, d, ei) {
  5082. signed_descriptor_t *sd;
  5083. tor_assert(tor_memeq(ei->cache_info.signed_descriptor_digest,
  5084. d, DIGEST_LEN));
  5085. sd = sdmap_get(rl->desc_by_eid_map,
  5086. ei->cache_info.signed_descriptor_digest);
  5087. // tor_assert(sd); // XXXX see above
  5088. if (sd) {
  5089. tor_assert(tor_memeq(ei->cache_info.signed_descriptor_digest,
  5090. sd->extra_info_digest, DIGEST_LEN));
  5091. }
  5092. } DIGESTMAP_FOREACH_END;
  5093. }
  5094. /** Allocate and return a new string representing the contact info
  5095. * and platform string for <b>router</b>,
  5096. * surrounded by quotes and using standard C escapes.
  5097. *
  5098. * THIS FUNCTION IS NOT REENTRANT. Don't call it from outside the main
  5099. * thread. Also, each call invalidates the last-returned value, so don't
  5100. * try log_warn(LD_GENERAL, "%s %s", esc_router_info(a), esc_router_info(b));
  5101. *
  5102. * If <b>router</b> is NULL, it just frees its internal memory and returns.
  5103. */
  5104. const char *
  5105. esc_router_info(const routerinfo_t *router)
  5106. {
  5107. static char *info=NULL;
  5108. char *esc_contact, *esc_platform;
  5109. tor_free(info);
  5110. if (!router)
  5111. return NULL; /* we're exiting; just free the memory we use */
  5112. esc_contact = esc_for_log(router->contact_info);
  5113. esc_platform = esc_for_log(router->platform);
  5114. tor_asprintf(&info, "Contact %s, Platform %s", esc_contact, esc_platform);
  5115. tor_free(esc_contact);
  5116. tor_free(esc_platform);
  5117. return info;
  5118. }
  5119. /** Helper for sorting: compare two routerinfos by their identity
  5120. * digest. */
  5121. static int
  5122. compare_routerinfo_by_id_digest_(const void **a, const void **b)
  5123. {
  5124. routerinfo_t *first = *(routerinfo_t **)a, *second = *(routerinfo_t **)b;
  5125. return fast_memcmp(first->cache_info.identity_digest,
  5126. second->cache_info.identity_digest,
  5127. DIGEST_LEN);
  5128. }
  5129. /** Sort a list of routerinfo_t in ascending order of identity digest. */
  5130. void
  5131. routers_sort_by_identity(smartlist_t *routers)
  5132. {
  5133. smartlist_sort(routers, compare_routerinfo_by_id_digest_);
  5134. }
  5135. /** Called when we change a node set, or when we reload the geoip IPv4 list:
  5136. * recompute all country info in all configuration node sets and in the
  5137. * routerlist. */
  5138. void
  5139. refresh_all_country_info(void)
  5140. {
  5141. const or_options_t *options = get_options();
  5142. if (options->EntryNodes)
  5143. routerset_refresh_countries(options->EntryNodes);
  5144. if (options->ExitNodes)
  5145. routerset_refresh_countries(options->ExitNodes);
  5146. if (options->ExcludeNodes)
  5147. routerset_refresh_countries(options->ExcludeNodes);
  5148. if (options->ExcludeExitNodes)
  5149. routerset_refresh_countries(options->ExcludeExitNodes);
  5150. if (options->ExcludeExitNodesUnion_)
  5151. routerset_refresh_countries(options->ExcludeExitNodesUnion_);
  5152. nodelist_refresh_countries();
  5153. }