12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955 |
- /* Copyright (c) 2001 Matej Pfajfar.
- * Copyright (c) 2001-2004, Roger Dingledine.
- * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
- * Copyright (c) 2007-2017, The Tor Project, Inc. */
- /* See LICENSE for licensing information */
- /**
- * \file config.c
- * \brief Code to interpret the user's configuration of Tor.
- *
- * This module handles torrc configuration file, including parsing it,
- * combining it with torrc.defaults and the command line, allowing
- * user changes to it (via editing and SIGHUP or via the control port),
- * writing it back to disk (because of SAVECONF from the control port),
- * and -- most importantly, acting on it.
- *
- * The module additionally has some tools for manipulating and
- * inspecting values that are calculated as a result of the
- * configured options.
- *
- * <h3>How to add new options</h3>
- *
- * To add new items to the torrc, there are a minimum of three places to edit:
- * <ul>
- * <li>The or_options_t structure in or.h, where the options are stored.
- * <li>The option_vars_ array below in this module, which configures
- * the names of the torrc options, their types, their multiplicities,
- * and their mappings to fields in or_options_t.
- * <li>The manual in doc/tor.1.txt, to document what the new option
- * is, and how it works.
- * </ul>
- *
- * Additionally, you might need to edit these places too:
- * <ul>
- * <li>options_validate() below, in case you want to reject some possible
- * values of the new configuration option.
- * <li>options_transition_allowed() below, in case you need to
- * forbid some or all changes in the option while Tor is
- * running.
- * <li>options_transition_affects_workers(), in case changes in the option
- * might require Tor to relaunch or reconfigure its worker threads.
- * <li>options_transition_affects_descriptor(), in case changes in the
- * option might require a Tor relay to build and publish a new server
- * descriptor.
- * <li>options_act() and/or options_act_reversible(), in case there's some
- * action that needs to be taken immediately based on the option's
- * value.
- * </ul>
- *
- * <h3>Changing the value of an option</h3>
- *
- * Because of the SAVECONF command from the control port, it's a bad
- * idea to change the value of any user-configured option in the
- * or_options_t. If you want to sometimes do this anyway, we recommend
- * that you create a secondary field in or_options_t; that you have the
- * user option linked only to the secondary field; that you use the
- * secondary field to initialize the one that Tor actually looks at; and that
- * you use the one Tor looks as the one that you modify.
- **/
- #define CONFIG_PRIVATE
- #include "or.h"
- #include "bridges.h"
- #include "compat.h"
- #include "addressmap.h"
- #include "channel.h"
- #include "circuitbuild.h"
- #include "circuitlist.h"
- #include "circuitmux.h"
- #include "circuitmux_ewma.h"
- #include "circuitstats.h"
- #include "compress.h"
- #include "config.h"
- #include "connection.h"
- #include "connection_edge.h"
- #include "connection_or.h"
- #include "control.h"
- #include "confparse.h"
- #include "cpuworker.h"
- #include "dirserv.h"
- #include "dirvote.h"
- #include "dns.h"
- #include "entrynodes.h"
- #include "geoip.h"
- #include "hibernate.h"
- #include "main.h"
- #include "networkstatus.h"
- #include "nodelist.h"
- #include "policies.h"
- #include "relay.h"
- #include "rendclient.h"
- #include "rendservice.h"
- #include "rephist.h"
- #include "router.h"
- #include "sandbox.h"
- #include "util.h"
- #include "routerlist.h"
- #include "routerset.h"
- #include "scheduler.h"
- #include "statefile.h"
- #include "transports.h"
- #include "ext_orport.h"
- #ifdef _WIN32
- #include <shlobj.h>
- #endif
- #include "procmon.h"
- #ifdef HAVE_SYSTEMD
- # if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
- /* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
- * Coverity. Here's a kludge to unconfuse it.
- */
- # define __INCLUDE_LEVEL__ 2
- # endif
- #include <systemd/sd-daemon.h>
- #endif
- /* Prefix used to indicate a Unix socket in a FooPort configuration. */
- static const char unix_socket_prefix[] = "unix:";
- /* Prefix used to indicate a Unix socket with spaces in it, in a FooPort
- * configuration. */
- static const char unix_q_socket_prefix[] = "unix:\"";
- /** A list of abbreviations and aliases to map command-line options, obsolete
- * option names, or alternative option names, to their current values. */
- static config_abbrev_t option_abbrevs_[] = {
- PLURAL(AuthDirBadDirCC),
- PLURAL(AuthDirBadExitCC),
- PLURAL(AuthDirInvalidCC),
- PLURAL(AuthDirRejectCC),
- PLURAL(EntryNode),
- PLURAL(ExcludeNode),
- PLURAL(Tor2webRendezvousPoint),
- PLURAL(FirewallPort),
- PLURAL(LongLivedPort),
- PLURAL(HiddenServiceNode),
- PLURAL(HiddenServiceExcludeNode),
- PLURAL(NumCPU),
- PLURAL(RendNode),
- PLURAL(RecommendedPackage),
- PLURAL(RendExcludeNode),
- PLURAL(StrictEntryNode),
- PLURAL(StrictExitNode),
- PLURAL(StrictNode),
- { "l", "Log", 1, 0},
- { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
- { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
- { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
- { "BandwidthRateBytes", "BandwidthRate", 0, 0},
- { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
- { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
- { "DirServer", "DirAuthority", 0, 0}, /* XXXX later, make this warn? */
- { "MaxConn", "ConnLimit", 0, 1},
- { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
- { "ORBindAddress", "ORListenAddress", 0, 0},
- { "DirBindAddress", "DirListenAddress", 0, 0},
- { "SocksBindAddress", "SocksListenAddress", 0, 0},
- { "UseHelperNodes", "UseEntryGuards", 0, 0},
- { "NumHelperNodes", "NumEntryGuards", 0, 0},
- { "UseEntryNodes", "UseEntryGuards", 0, 0},
- { "NumEntryNodes", "NumEntryGuards", 0, 0},
- { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
- { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
- { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
- { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
- { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
- { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
- { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
- { NULL, NULL, 0, 0},
- };
- /** An entry for config_vars: "The option <b>name</b> has type
- * CONFIG_TYPE_<b>conftype</b>, and corresponds to
- * or_options_t.<b>member</b>"
- */
- #define VAR(name,conftype,member,initvalue) \
- { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
- initvalue }
- /** As VAR, but the option name and member name are the same. */
- #define V(member,conftype,initvalue) \
- VAR(#member, conftype, member, initvalue)
- /** An entry for config_vars: "The option <b>name</b> is obsolete." */
- #define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
- /**
- * Macro to declare *Port options. Each one comes in three entries.
- * For example, most users should use "SocksPort" to configure the
- * socks port, but TorBrowser wants to use __SocksPort so that it
- * isn't stored by SAVECONF. The SocksPortLines virtual option is
- * used to query both options from the controller.
- */
- #define VPORT(member) \
- VAR(#member "Lines", LINELIST_V, member ## _lines, NULL), \
- VAR(#member, LINELIST_S, member ## _lines, NULL), \
- VAR("__" #member, LINELIST_S, member ## _lines, NULL)
- /** Array of configuration options. Until we disallow nonstandard
- * abbreviations, order is significant, since the first matching option will
- * be chosen first.
- */
- static config_var_t option_vars_[] = {
- V(AccountingMax, MEMUNIT, "0 bytes"),
- VAR("AccountingRule", STRING, AccountingRule_option, "max"),
- V(AccountingStart, STRING, NULL),
- V(Address, STRING, NULL),
- V(AllowDotExit, BOOL, "0"),
- OBSOLETE("AllowInvalidNodes"),
- V(AllowNonRFC953Hostnames, BOOL, "0"),
- OBSOLETE("AllowSingleHopCircuits"),
- OBSOLETE("AllowSingleHopExits"),
- V(AlternateBridgeAuthority, LINELIST, NULL),
- V(AlternateDirAuthority, LINELIST, NULL),
- OBSOLETE("AlternateHSAuthority"),
- V(AssumeReachable, BOOL, "0"),
- OBSOLETE("AuthDirBadDir"),
- OBSOLETE("AuthDirBadDirCCs"),
- V(AuthDirBadExit, LINELIST, NULL),
- V(AuthDirBadExitCCs, CSV, ""),
- V(AuthDirInvalid, LINELIST, NULL),
- V(AuthDirInvalidCCs, CSV, ""),
- V(AuthDirFastGuarantee, MEMUNIT, "100 KB"),
- V(AuthDirGuardBWGuarantee, MEMUNIT, "2 MB"),
- V(AuthDirPinKeys, BOOL, "1"),
- V(AuthDirReject, LINELIST, NULL),
- V(AuthDirRejectCCs, CSV, ""),
- OBSOLETE("AuthDirRejectUnlisted"),
- OBSOLETE("AuthDirListBadDirs"),
- V(AuthDirListBadExits, BOOL, "0"),
- V(AuthDirMaxServersPerAddr, UINT, "2"),
- OBSOLETE("AuthDirMaxServersPerAuthAddr"),
- V(AuthDirHasIPv6Connectivity, BOOL, "0"),
- VAR("AuthoritativeDirectory", BOOL, AuthoritativeDir, "0"),
- V(AutomapHostsOnResolve, BOOL, "0"),
- V(AutomapHostsSuffixes, CSV, ".onion,.exit"),
- V(AvoidDiskWrites, BOOL, "0"),
- V(BandwidthBurst, MEMUNIT, "1 GB"),
- V(BandwidthRate, MEMUNIT, "1 GB"),
- V(BridgeAuthoritativeDir, BOOL, "0"),
- VAR("Bridge", LINELIST, Bridges, NULL),
- V(BridgePassword, STRING, NULL),
- V(BridgeRecordUsageByCountry, BOOL, "1"),
- V(BridgeRelay, BOOL, "0"),
- V(CellStatistics, BOOL, "0"),
- V(LearnCircuitBuildTimeout, BOOL, "1"),
- V(CircuitBuildTimeout, INTERVAL, "0"),
- V(CircuitIdleTimeout, INTERVAL, "1 hour"),
- V(CircuitStreamTimeout, INTERVAL, "0"),
- V(CircuitPriorityHalflife, DOUBLE, "-100.0"), /*negative:'Use default'*/
- V(ClientDNSRejectInternalAddresses, BOOL,"1"),
- V(ClientOnly, BOOL, "0"),
- V(ClientPreferIPv6ORPort, AUTOBOOL, "auto"),
- V(ClientPreferIPv6DirPort, AUTOBOOL, "auto"),
- V(ClientRejectInternalAddresses, BOOL, "1"),
- V(ClientTransportPlugin, LINELIST, NULL),
- V(ClientUseIPv6, BOOL, "0"),
- V(ClientUseIPv4, BOOL, "1"),
- V(ConsensusParams, STRING, NULL),
- V(ConnLimit, UINT, "1000"),
- V(ConnDirectionStatistics, BOOL, "0"),
- V(ConstrainedSockets, BOOL, "0"),
- V(ConstrainedSockSize, MEMUNIT, "8192"),
- V(ContactInfo, STRING, NULL),
- OBSOLETE("ControlListenAddress"),
- VPORT(ControlPort),
- V(ControlPortFileGroupReadable,BOOL, "0"),
- V(ControlPortWriteToFile, FILENAME, NULL),
- V(ControlSocket, LINELIST, NULL),
- V(ControlSocketsGroupWritable, BOOL, "0"),
- V(SocksSocketsGroupWritable, BOOL, "0"),
- V(CookieAuthentication, BOOL, "0"),
- V(CookieAuthFileGroupReadable, BOOL, "0"),
- V(CookieAuthFile, STRING, NULL),
- V(CountPrivateBandwidth, BOOL, "0"),
- V(DataDirectory, FILENAME, NULL),
- V(DataDirectoryGroupReadable, BOOL, "0"),
- V(DisableOOSCheck, BOOL, "1"),
- V(DisableNetwork, BOOL, "0"),
- V(DirAllowPrivateAddresses, BOOL, "0"),
- V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
- OBSOLETE("DirListenAddress"),
- V(DirPolicy, LINELIST, NULL),
- VPORT(DirPort),
- V(DirPortFrontPage, FILENAME, NULL),
- VAR("DirReqStatistics", BOOL, DirReqStatistics_option, "1"),
- VAR("DirAuthority", LINELIST, DirAuthorities, NULL),
- V(DirCache, BOOL, "1"),
- V(DirAuthorityFallbackRate, DOUBLE, "1.0"),
- V(DisableAllSwap, BOOL, "0"),
- V(DisableDebuggerAttachment, BOOL, "1"),
- OBSOLETE("DisableIOCP"),
- OBSOLETE("DisableV2DirectoryInfo_"),
- OBSOLETE("DynamicDHGroups"),
- VPORT(DNSPort),
- OBSOLETE("DNSListenAddress"),
- V(DownloadExtraInfo, BOOL, "0"),
- V(TestingEnableConnBwEvent, BOOL, "0"),
- V(TestingEnableCellStatsEvent, BOOL, "0"),
- V(TestingEnableTbEmptyEvent, BOOL, "0"),
- V(EnforceDistinctSubnets, BOOL, "1"),
- V(EntryNodes, ROUTERSET, NULL),
- V(EntryStatistics, BOOL, "0"),
- V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
- V(ExcludeNodes, ROUTERSET, NULL),
- V(ExcludeExitNodes, ROUTERSET, NULL),
- OBSOLETE("ExcludeSingleHopRelays"),
- V(ExitNodes, ROUTERSET, NULL),
- V(ExitPolicy, LINELIST, NULL),
- V(ExitPolicyRejectPrivate, BOOL, "1"),
- V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
- V(ExitPortStatistics, BOOL, "0"),
- V(ExtendAllowPrivateAddresses, BOOL, "0"),
- V(ExitRelay, AUTOBOOL, "auto"),
- VPORT(ExtORPort),
- V(ExtORPortCookieAuthFile, STRING, NULL),
- V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
- V(ExtraInfoStatistics, BOOL, "1"),
- V(ExtendByEd25519ID, AUTOBOOL, "auto"),
- V(FallbackDir, LINELIST, NULL),
- V(UseDefaultFallbackDirs, BOOL, "1"),
- OBSOLETE("FallbackNetworkstatusFile"),
- V(FascistFirewall, BOOL, "0"),
- V(FirewallPorts, CSV, ""),
- OBSOLETE("FastFirstHopPK"),
- V(FetchDirInfoEarly, BOOL, "0"),
- V(FetchDirInfoExtraEarly, BOOL, "0"),
- V(FetchServerDescriptors, BOOL, "1"),
- V(FetchHidServDescriptors, BOOL, "1"),
- V(FetchUselessDescriptors, BOOL, "0"),
- OBSOLETE("FetchV2Networkstatus"),
- V(GeoIPExcludeUnknown, AUTOBOOL, "auto"),
- #ifdef _WIN32
- V(GeoIPFile, FILENAME, "<default>"),
- V(GeoIPv6File, FILENAME, "<default>"),
- #else
- V(GeoIPFile, FILENAME,
- SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
- V(GeoIPv6File, FILENAME,
- SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
- #endif
- OBSOLETE("Group"),
- V(GuardLifetime, INTERVAL, "0 minutes"),
- V(HardwareAccel, BOOL, "0"),
- V(HeartbeatPeriod, INTERVAL, "6 hours"),
- V(AccelName, STRING, NULL),
- V(AccelDir, FILENAME, NULL),
- V(HashedControlPassword, LINELIST, NULL),
- OBSOLETE("HidServDirectoryV2"),
- VAR("HiddenServiceDir", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceDirGroupReadable", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines, NULL),
- VAR("HiddenServicePort", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
- VAR("HiddenServiceAllowUnknownPorts",LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceMaxStreams",LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceMaxStreamsCloseCircuit",LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceNumIntroductionPoints", LINELIST_S, RendConfigLines, NULL),
- VAR("HiddenServiceStatistics", BOOL, HiddenServiceStatistics_option, "1"),
- V(HidServAuth, LINELIST, NULL),
- OBSOLETE("CloseHSClientCircuitsImmediatelyOnTimeout"),
- OBSOLETE("CloseHSServiceRendCircuitsImmediatelyOnTimeout"),
- V(HiddenServiceSingleHopMode, BOOL, "0"),
- V(HiddenServiceNonAnonymousMode,BOOL, "0"),
- V(HTTPProxy, STRING, NULL),
- V(HTTPProxyAuthenticator, STRING, NULL),
- V(HTTPSProxy, STRING, NULL),
- V(HTTPSProxyAuthenticator, STRING, NULL),
- V(IPv6Exit, BOOL, "0"),
- VAR("ServerTransportPlugin", LINELIST, ServerTransportPlugin, NULL),
- V(ServerTransportListenAddr, LINELIST, NULL),
- V(ServerTransportOptions, LINELIST, NULL),
- V(SigningKeyLifetime, INTERVAL, "30 days"),
- V(Socks4Proxy, STRING, NULL),
- V(Socks5Proxy, STRING, NULL),
- V(Socks5ProxyUsername, STRING, NULL),
- V(Socks5ProxyPassword, STRING, NULL),
- V(KeepalivePeriod, INTERVAL, "5 minutes"),
- V(KeepBindCapabilities, AUTOBOOL, "auto"),
- VAR("Log", LINELIST, Logs, NULL),
- V(LogMessageDomains, BOOL, "0"),
- V(LogTimeGranularity, MSEC_INTERVAL, "1 second"),
- V(TruncateLogFile, BOOL, "0"),
- V(SyslogIdentityTag, STRING, NULL),
- V(LongLivedPorts, CSV,
- "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
- VAR("MapAddress", LINELIST, AddressMap, NULL),
- V(MaxAdvertisedBandwidth, MEMUNIT, "1 GB"),
- V(MaxCircuitDirtiness, INTERVAL, "10 minutes"),
- V(MaxClientCircuitsPending, UINT, "32"),
- VAR("MaxMemInQueues", MEMUNIT, MaxMemInQueues_raw, "0"),
- OBSOLETE("MaxOnionsPending"),
- V(MaxOnionQueueDelay, MSEC_INTERVAL, "1750 msec"),
- V(MaxUnparseableDescSizeToLog, MEMUNIT, "10 MB"),
- V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
- V(MyFamily, STRING, NULL),
- V(NewCircuitPeriod, INTERVAL, "30 seconds"),
- OBSOLETE("NamingAuthoritativeDirectory"),
- OBSOLETE("NATDListenAddress"),
- VPORT(NATDPort),
- V(Nickname, STRING, NULL),
- V(PredictedPortsRelevanceTime, INTERVAL, "1 hour"),
- OBSOLETE("WarnUnsafeSocks"),
- VAR("NodeFamily", LINELIST, NodeFamilies, NULL),
- V(NumCPUs, UINT, "0"),
- V(NumDirectoryGuards, UINT, "0"),
- V(NumEntryGuards, UINT, "0"),
- V(OfflineMasterKey, BOOL, "0"),
- OBSOLETE("ORListenAddress"),
- VPORT(ORPort),
- V(OutboundBindAddress, LINELIST, NULL),
- V(OutboundBindAddressOR, LINELIST, NULL),
- V(OutboundBindAddressExit, LINELIST, NULL),
- OBSOLETE("PathBiasDisableRate"),
- V(PathBiasCircThreshold, INT, "-1"),
- V(PathBiasNoticeRate, DOUBLE, "-1"),
- V(PathBiasWarnRate, DOUBLE, "-1"),
- V(PathBiasExtremeRate, DOUBLE, "-1"),
- V(PathBiasScaleThreshold, INT, "-1"),
- OBSOLETE("PathBiasScaleFactor"),
- OBSOLETE("PathBiasMultFactor"),
- V(PathBiasDropGuards, AUTOBOOL, "0"),
- OBSOLETE("PathBiasUseCloseCounts"),
- V(PathBiasUseThreshold, INT, "-1"),
- V(PathBiasNoticeUseRate, DOUBLE, "-1"),
- V(PathBiasExtremeUseRate, DOUBLE, "-1"),
- V(PathBiasScaleUseThreshold, INT, "-1"),
- V(PathsNeededToBuildCircuits, DOUBLE, "-1"),
- V(PerConnBWBurst, MEMUNIT, "0"),
- V(PerConnBWRate, MEMUNIT, "0"),
- V(PidFile, STRING, NULL),
- V(TestingTorNetwork, BOOL, "0"),
- V(TestingMinExitFlagThreshold, MEMUNIT, "0"),
- V(TestingMinFastFlagThreshold, MEMUNIT, "0"),
- V(TestingLinkCertLifetime, INTERVAL, "2 days"),
- V(TestingAuthKeyLifetime, INTERVAL, "2 days"),
- V(TestingLinkKeySlop, INTERVAL, "3 hours"),
- V(TestingAuthKeySlop, INTERVAL, "3 hours"),
- V(TestingSigningKeySlop, INTERVAL, "1 day"),
- V(OptimisticData, AUTOBOOL, "auto"),
- V(PortForwarding, BOOL, "0"),
- V(PortForwardingHelper, FILENAME, "tor-fw-helper"),
- OBSOLETE("PreferTunneledDirConns"),
- V(ProtocolWarnings, BOOL, "0"),
- V(PublishServerDescriptor, CSV, "1"),
- V(PublishHidServDescriptors, BOOL, "1"),
- V(ReachableAddresses, LINELIST, NULL),
- V(ReachableDirAddresses, LINELIST, NULL),
- V(ReachableORAddresses, LINELIST, NULL),
- V(RecommendedVersions, LINELIST, NULL),
- V(RecommendedClientVersions, LINELIST, NULL),
- V(RecommendedServerVersions, LINELIST, NULL),
- V(RecommendedPackages, LINELIST, NULL),
- V(RefuseUnknownExits, AUTOBOOL, "auto"),
- V(RejectPlaintextPorts, CSV, ""),
- V(RelayBandwidthBurst, MEMUNIT, "0"),
- V(RelayBandwidthRate, MEMUNIT, "0"),
- V(RendPostPeriod, INTERVAL, "1 hour"),
- V(RephistTrackTime, INTERVAL, "24 hours"),
- V(RunAsDaemon, BOOL, "0"),
- OBSOLETE("RunTesting"), // currently unused
- V(Sandbox, BOOL, "0"),
- V(SafeLogging, STRING, "1"),
- V(SafeSocks, BOOL, "0"),
- V(ServerDNSAllowBrokenConfig, BOOL, "1"),
- V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
- V(ServerDNSDetectHijacking, BOOL, "1"),
- V(ServerDNSRandomizeCase, BOOL, "1"),
- V(ServerDNSResolvConfFile, STRING, NULL),
- V(ServerDNSSearchDomains, BOOL, "0"),
- V(ServerDNSTestAddresses, CSV,
- "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
- V(SchedulerLowWaterMark__, MEMUNIT, "100 MB"),
- V(SchedulerHighWaterMark__, MEMUNIT, "101 MB"),
- V(SchedulerMaxFlushCells__, UINT, "1000"),
- V(ShutdownWaitLength, INTERVAL, "30 seconds"),
- OBSOLETE("SocksListenAddress"),
- V(SocksPolicy, LINELIST, NULL),
- VPORT(SocksPort),
- V(SocksTimeout, INTERVAL, "2 minutes"),
- V(SSLKeyLifetime, INTERVAL, "0"),
- OBSOLETE("StrictEntryNodes"),
- OBSOLETE("StrictExitNodes"),
- V(StrictNodes, BOOL, "0"),
- OBSOLETE("Support022HiddenServices"),
- V(TestSocks, BOOL, "0"),
- V(TokenBucketRefillInterval, MSEC_INTERVAL, "100 msec"),
- V(Tor2webMode, BOOL, "0"),
- V(Tor2webRendezvousPoints, ROUTERSET, NULL),
- OBSOLETE("TLSECGroup"),
- V(TrackHostExits, CSV, NULL),
- V(TrackHostExitsExpire, INTERVAL, "30 minutes"),
- OBSOLETE("TransListenAddress"),
- VPORT(TransPort),
- V(TransProxyType, STRING, "default"),
- OBSOLETE("TunnelDirConns"),
- V(UpdateBridgesFromAuthority, BOOL, "0"),
- V(UseBridges, BOOL, "0"),
- VAR("UseEntryGuards", BOOL, UseEntryGuards_option, "1"),
- OBSOLETE("UseEntryGuardsAsDirGuards"),
- V(UseGuardFraction, AUTOBOOL, "auto"),
- V(UseMicrodescriptors, AUTOBOOL, "auto"),
- OBSOLETE("UseNTorHandshake"),
- V(User, STRING, NULL),
- OBSOLETE("UserspaceIOCPBuffers"),
- V(AuthDirSharedRandomness, BOOL, "1"),
- V(AuthDirTestEd25519LinkKeys, BOOL, "1"),
- OBSOLETE("V1AuthoritativeDirectory"),
- OBSOLETE("V2AuthoritativeDirectory"),
- VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir, "0"),
- V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
- V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
- V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
- V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
- V(V3AuthVotingInterval, INTERVAL, "1 hour"),
- V(V3AuthVoteDelay, INTERVAL, "5 minutes"),
- V(V3AuthDistDelay, INTERVAL, "5 minutes"),
- V(V3AuthNIntervalsValid, UINT, "3"),
- V(V3AuthUseLegacyKey, BOOL, "0"),
- V(V3BandwidthsFile, FILENAME, NULL),
- V(GuardfractionFile, FILENAME, NULL),
- VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
- OBSOLETE("VoteOnHidServDirectoriesV2"),
- V(VirtualAddrNetworkIPv4, STRING, "127.192.0.0/10"),
- V(VirtualAddrNetworkIPv6, STRING, "[FE80::]/10"),
- V(WarnPlaintextPorts, CSV, "23,109,110,143"),
- OBSOLETE("UseFilteringSSLBufferevents"),
- OBSOLETE("__UseFilteringSSLBufferevents"),
- VAR("__ReloadTorrcOnSIGHUP", BOOL, ReloadTorrcOnSIGHUP, "1"),
- VAR("__AllDirActionsPrivate", BOOL, AllDirActionsPrivate, "0"),
- VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
- VAR("__LeaveStreamsUnattached",BOOL, LeaveStreamsUnattached, "0"),
- VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
- NULL),
- VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
- V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
- V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 60, 60, 120, "
- "300, 900, 2147483647"),
- V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 60, 300, 600, "
- "2147483647"),
- V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
- "300, 600, 1800, 1800, 1800, 1800, "
- "1800, 3600, 7200"),
- V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
- "300, 600, 1800, 3600, 3600, 3600, "
- "10800, 21600, 43200"),
- /* With the ClientBootstrapConsensus*Download* below:
- * Clients with only authorities will try:
- * - 3 authorities over 10 seconds, then wait 60 minutes.
- * Clients with authorities and fallbacks will try:
- * - 2 authorities and 4 fallbacks over 21 seconds, then wait 60 minutes.
- * Clients will also retry when an application request arrives.
- * After a number of failed reqests, clients retry every 3 days + 1 hour.
- *
- * Clients used to try 2 authorities over 10 seconds, then wait for
- * 60 minutes or an application request.
- *
- * When clients have authorities and fallbacks available, they use these
- * schedules: (we stagger the times to avoid thundering herds) */
- V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
- "6, 11, 3600, 10800, 25200, 54000, 111600, 262800" /* 3 days + 1 hour */),
- V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
- "0, 1, 4, 11, 3600, 10800, 25200, 54000, 111600, 262800"),
- /* When clients only have authorities available, they use this schedule: */
- V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
- "0, 3, 7, 3600, 10800, 25200, 54000, 111600, 262800"),
- /* We don't want to overwhelm slow networks (or mirrors whose replies are
- * blocked), but we also don't want to fail if only some mirrors are
- * blackholed. Clients will try 3 directories simultaneously.
- * (Relays never use simultaneous connections.) */
- V(ClientBootstrapConsensusMaxInProgressTries, UINT, "3"),
- V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "1200, 900, 900, 3600"),
- V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
- V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
- V(TestingConsensusMaxDownloadTries, UINT, "8"),
- /* Since we try connections rapidly and simultaneously, we can afford
- * to give up earlier. (This protects against overloading directories.) */
- V(ClientBootstrapConsensusMaxDownloadTries, UINT, "7"),
- /* We want to give up much earlier if we're only using authorities. */
- V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "4"),
- V(TestingDescriptorMaxDownloadTries, UINT, "8"),
- V(TestingMicrodescMaxDownloadTries, UINT, "8"),
- V(TestingCertMaxDownloadTries, UINT, "8"),
- V(TestingDirAuthVoteExit, ROUTERSET, NULL),
- V(TestingDirAuthVoteExitIsStrict, BOOL, "0"),
- V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
- V(TestingDirAuthVoteGuardIsStrict, BOOL, "0"),
- V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
- V(TestingDirAuthVoteHSDirIsStrict, BOOL, "0"),
- VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
- { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
- };
- /** Override default values with these if the user sets the TestingTorNetwork
- * option. */
- static const config_var_t testing_tor_network_defaults[] = {
- V(ServerDNSAllowBrokenConfig, BOOL, "1"),
- V(DirAllowPrivateAddresses, BOOL, "1"),
- V(EnforceDistinctSubnets, BOOL, "0"),
- V(AssumeReachable, BOOL, "1"),
- V(AuthDirMaxServersPerAddr, UINT, "0"),
- V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
- "0, 2, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
- V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
- "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
- V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
- "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
- V(ClientBootstrapConsensusMaxDownloadTries, UINT, "80"),
- V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "80"),
- V(ClientDNSRejectInternalAddresses, BOOL,"0"), // deprecated in 0.2.9.2-alpha
- V(ClientRejectInternalAddresses, BOOL, "0"),
- V(CountPrivateBandwidth, BOOL, "1"),
- V(ExitPolicyRejectPrivate, BOOL, "0"),
- V(ExtendAllowPrivateAddresses, BOOL, "1"),
- V(V3AuthVotingInterval, INTERVAL, "5 minutes"),
- V(V3AuthVoteDelay, INTERVAL, "20 seconds"),
- V(V3AuthDistDelay, INTERVAL, "20 seconds"),
- V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
- V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
- V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
- V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
- V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
- V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
- V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
- V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 5, 10, 15, "
- "20, 30, 60"),
- V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, 15, 20, "
- "30, 60"),
- V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
- "15, 20, 30, 60"),
- V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
- "15, 20, 30, 60"),
- V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "60, 30, 30, 60"),
- V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "5 seconds"),
- V(TestingDirConnectionMaxStall, INTERVAL, "30 seconds"),
- V(TestingConsensusMaxDownloadTries, UINT, "80"),
- V(TestingDescriptorMaxDownloadTries, UINT, "80"),
- V(TestingMicrodescMaxDownloadTries, UINT, "80"),
- V(TestingCertMaxDownloadTries, UINT, "80"),
- V(TestingEnableConnBwEvent, BOOL, "1"),
- V(TestingEnableCellStatsEvent, BOOL, "1"),
- V(TestingEnableTbEmptyEvent, BOOL, "1"),
- VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
- V(RendPostPeriod, INTERVAL, "2 minutes"),
- { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
- };
- #undef VAR
- #undef V
- #undef OBSOLETE
- static const config_deprecation_t option_deprecation_notes_[] = {
- /* Deprecated since 0.2.9.2-alpha... */
- { "AllowDotExit", "Unrestricted use of the .exit notation can be used for "
- "a wide variety of application-level attacks." },
- { "ClientDNSRejectInternalAddresses", "Turning this on makes your client "
- "easier to fingerprint, and may open you to esoteric attacks." },
- /* End of options deprecated since 0.2.9.2-alpha. */
- { NULL, NULL }
- };
- #ifdef _WIN32
- static char *get_windows_conf_root(void);
- #endif
- static int options_act_reversible(const or_options_t *old_options, char **msg);
- static int options_transition_allowed(const or_options_t *old,
- const or_options_t *new,
- char **msg);
- static int options_transition_affects_workers(
- const or_options_t *old_options, const or_options_t *new_options);
- static int options_transition_affects_descriptor(
- const or_options_t *old_options, const or_options_t *new_options);
- static int check_nickname_list(char **lst, const char *name, char **msg);
- static char *get_bindaddr_from_transport_listen_line(const char *line,
- const char *transport);
- static int parse_ports(or_options_t *options, int validate_only,
- char **msg_out, int *n_ports_out,
- int *world_writable_control_socket);
- static int check_server_ports(const smartlist_t *ports,
- const or_options_t *options,
- int *num_low_ports_out);
- static int validate_data_directory(or_options_t *options);
- static int write_configuration_file(const char *fname,
- const or_options_t *options);
- static int options_init_logs(const or_options_t *old_options,
- or_options_t *options, int validate_only);
- static void init_libevent(const or_options_t *options);
- static int opt_streq(const char *s1, const char *s2);
- static int parse_outbound_addresses(or_options_t *options, int validate_only,
- char **msg);
- static void config_maybe_load_geoip_files_(const or_options_t *options,
- const or_options_t *old_options);
- static int options_validate_cb(void *old_options, void *options,
- void *default_options,
- int from_setconf, char **msg);
- static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
- int log_guess);
- /** Magic value for or_options_t. */
- #define OR_OPTIONS_MAGIC 9090909
- /** Configuration format for or_options_t. */
- STATIC config_format_t options_format = {
- sizeof(or_options_t),
- OR_OPTIONS_MAGIC,
- STRUCT_OFFSET(or_options_t, magic_),
- option_abbrevs_,
- option_deprecation_notes_,
- option_vars_,
- options_validate_cb,
- NULL
- };
- /*
- * Functions to read and write the global options pointer.
- */
- /** Command-line and config-file options. */
- static or_options_t *global_options = NULL;
- /** The fallback options_t object; this is where we look for options not
- * in torrc before we fall back to Tor's defaults. */
- static or_options_t *global_default_options = NULL;
- /** Name of most recently read torrc file. */
- static char *torrc_fname = NULL;
- /** Name of the most recently read torrc-defaults file.*/
- static char *torrc_defaults_fname;
- /** Configuration options set by command line. */
- static config_line_t *global_cmdline_options = NULL;
- /** Non-configuration options set by the command line */
- static config_line_t *global_cmdline_only_options = NULL;
- /** Boolean: Have we parsed the command line? */
- static int have_parsed_cmdline = 0;
- /** Contents of most recently read DirPortFrontPage file. */
- static char *global_dirfrontpagecontents = NULL;
- /** List of port_cfg_t for all configured ports. */
- static smartlist_t *configured_ports = NULL;
- /** Return the contents of our frontpage string, or NULL if not configured. */
- MOCK_IMPL(const char*,
- get_dirportfrontpage, (void))
- {
- return global_dirfrontpagecontents;
- }
- /** Returns the currently configured options. */
- MOCK_IMPL(or_options_t *,
- get_options_mutable, (void))
- {
- tor_assert(global_options);
- return global_options;
- }
- /** Returns the currently configured options */
- MOCK_IMPL(const or_options_t *,
- get_options,(void))
- {
- return get_options_mutable();
- }
- /** Change the current global options to contain <b>new_val</b> instead of
- * their current value; take action based on the new value; free the old value
- * as necessary. Returns 0 on success, -1 on failure.
- */
- int
- set_options(or_options_t *new_val, char **msg)
- {
- int i;
- smartlist_t *elements;
- config_line_t *line;
- or_options_t *old_options = global_options;
- global_options = new_val;
- /* Note that we pass the *old* options below, for comparison. It
- * pulls the new options directly out of global_options. */
- if (options_act_reversible(old_options, msg)<0) {
- tor_assert(*msg);
- global_options = old_options;
- return -1;
- }
- if (options_act(old_options) < 0) { /* acting on the options failed. die. */
- log_err(LD_BUG,
- "Acting on config options left us in a broken state. Dying.");
- exit(1);
- }
- /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
- * just starting up then the old_options will be undefined. */
- if (old_options && old_options != global_options) {
- elements = smartlist_new();
- for (i=0; options_format.vars[i].name; ++i) {
- const config_var_t *var = &options_format.vars[i];
- const char *var_name = var->name;
- if (var->type == CONFIG_TYPE_LINELIST_S ||
- var->type == CONFIG_TYPE_OBSOLETE) {
- continue;
- }
- if (!config_is_same(&options_format, new_val, old_options, var_name)) {
- line = config_get_assigned_option(&options_format, new_val,
- var_name, 1);
- if (line) {
- config_line_t *next;
- for (; line; line = next) {
- next = line->next;
- smartlist_add(elements, line->key);
- smartlist_add(elements, line->value);
- tor_free(line);
- }
- } else {
- smartlist_add_strdup(elements, options_format.vars[i].name);
- smartlist_add(elements, NULL);
- }
- }
- }
- control_event_conf_changed(elements);
- SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
- smartlist_free(elements);
- }
- if (old_options != global_options)
- or_options_free(old_options);
- return 0;
- }
- extern const char tor_git_revision[]; /* from tor_main.c */
- /** The version of this Tor process, as parsed. */
- static char *the_tor_version = NULL;
- /** A shorter version of this Tor process's version, for export in our router
- * descriptor. (Does not include the git version, if any.) */
- static char *the_short_tor_version = NULL;
- /** Return the current Tor version. */
- const char *
- get_version(void)
- {
- if (the_tor_version == NULL) {
- if (strlen(tor_git_revision)) {
- tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
- tor_git_revision);
- } else {
- the_tor_version = tor_strdup(get_short_version());
- }
- }
- return the_tor_version;
- }
- /** Return the current Tor version, without any git tag. */
- const char *
- get_short_version(void)
- {
- if (the_short_tor_version == NULL) {
- #ifdef TOR_BUILD_TAG
- tor_asprintf(&the_short_tor_version, "%s (%s)", VERSION, TOR_BUILD_TAG);
- #else
- the_short_tor_version = tor_strdup(VERSION);
- #endif
- }
- return the_short_tor_version;
- }
- /** Release additional memory allocated in options
- */
- STATIC void
- or_options_free(or_options_t *options)
- {
- if (!options)
- return;
- routerset_free(options->ExcludeExitNodesUnion_);
- if (options->NodeFamilySets) {
- SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
- rs, routerset_free(rs));
- smartlist_free(options->NodeFamilySets);
- }
- tor_free(options->BridgePassword_AuthDigest_);
- tor_free(options->command_arg);
- tor_free(options->master_key_fname);
- config_free(&options_format, options);
- }
- /** Release all memory and resources held by global configuration structures.
- */
- void
- config_free_all(void)
- {
- or_options_free(global_options);
- global_options = NULL;
- or_options_free(global_default_options);
- global_default_options = NULL;
- config_free_lines(global_cmdline_options);
- global_cmdline_options = NULL;
- config_free_lines(global_cmdline_only_options);
- global_cmdline_only_options = NULL;
- if (configured_ports) {
- SMARTLIST_FOREACH(configured_ports,
- port_cfg_t *, p, port_cfg_free(p));
- smartlist_free(configured_ports);
- configured_ports = NULL;
- }
- tor_free(torrc_fname);
- tor_free(torrc_defaults_fname);
- tor_free(global_dirfrontpagecontents);
- tor_free(the_short_tor_version);
- tor_free(the_tor_version);
- }
- /** Make <b>address</b> -- a piece of information related to our operation as
- * a client -- safe to log according to the settings in options->SafeLogging,
- * and return it.
- *
- * (We return "[scrubbed]" if SafeLogging is "1", and address otherwise.)
- */
- const char *
- safe_str_client(const char *address)
- {
- tor_assert(address);
- if (get_options()->SafeLogging_ == SAFELOG_SCRUB_ALL)
- return "[scrubbed]";
- else
- return address;
- }
- /** Make <b>address</b> -- a piece of information of unspecified sensitivity
- * -- safe to log according to the settings in options->SafeLogging, and
- * return it.
- *
- * (We return "[scrubbed]" if SafeLogging is anything besides "0", and address
- * otherwise.)
- */
- const char *
- safe_str(const char *address)
- {
- tor_assert(address);
- if (get_options()->SafeLogging_ != SAFELOG_SCRUB_NONE)
- return "[scrubbed]";
- else
- return address;
- }
- /** Equivalent to escaped(safe_str_client(address)). See reentrancy note on
- * escaped(): don't use this outside the main thread, or twice in the same
- * log statement. */
- const char *
- escaped_safe_str_client(const char *address)
- {
- if (get_options()->SafeLogging_ == SAFELOG_SCRUB_ALL)
- return "[scrubbed]";
- else
- return escaped(address);
- }
- /** Equivalent to escaped(safe_str(address)). See reentrancy note on
- * escaped(): don't use this outside the main thread, or twice in the same
- * log statement. */
- const char *
- escaped_safe_str(const char *address)
- {
- if (get_options()->SafeLogging_ != SAFELOG_SCRUB_NONE)
- return "[scrubbed]";
- else
- return escaped(address);
- }
- /** List of default directory authorities */
- static const char *default_authorities[] = {
- "moria1 orport=9101 "
- "v3ident=D586D18309DED4CD6D57C18FDB97EFA96D330566 "
- "128.31.0.39:9131 9695 DFC3 5FFE B861 329B 9F1A B04C 4639 7020 CE31",
- "tor26 orport=443 "
- "v3ident=14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 "
- "ipv6=[2001:858:2:2:aabb:0:563b:1526]:443 "
- "86.59.21.38:80 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
- "dizum orport=443 "
- "v3ident=E8A9C45EDE6D711294FADF8E7951F4DE6CA56B58 "
- "194.109.206.212:80 7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
- "Bifroest orport=443 bridge "
- "37.218.247.217:80 1D8F 3A91 C37C 5D1C 4C19 B1AD 1D0C FBE8 BF72 D8E1",
- "gabelmoo orport=443 "
- "v3ident=ED03BB616EB2F60BEC80151114BB25CEF515B226 "
- "ipv6=[2001:638:a000:4140::ffff:189]:443 "
- "131.188.40.189:80 F204 4413 DAC2 E02E 3D6B CF47 35A1 9BCA 1DE9 7281",
- "dannenberg orport=443 "
- "v3ident=0232AF901C31A04EE9848595AF9BB7620D4C5B2E "
- "193.23.244.244:80 7BE6 83E6 5D48 1413 21C5 ED92 F075 C553 64AC 7123",
- "maatuska orport=80 "
- "v3ident=49015F787433103580E3B66A1707A00E60F2D15B "
- "ipv6=[2001:67c:289c::9]:80 "
- "171.25.193.9:443 BD6A 8292 55CB 08E6 6FBE 7D37 4836 3586 E46B 3810",
- "Faravahar orport=443 "
- "v3ident=EFCBE720AB3A82B99F9E953CD5BF50F7EEFC7B97 "
- "154.35.175.225:80 CF6D 0AAF B385 BE71 B8E1 11FC 5CFF 4B47 9237 33BC",
- "longclaw orport=443 "
- "v3ident=23D15D965BC35114467363C165C4F724B64B4F66 "
- "ipv6=[2620:13:4000:8000:60:f3ff:fea1:7cff]:443 "
- "199.254.238.52:80 74A9 1064 6BCE EFBC D2E8 74FC 1DC9 9743 0F96 8145",
- NULL
- };
- /** List of fallback directory authorities. The list is generated by opt-in of
- * relays that meet certain stability criteria.
- */
- static const char *default_fallbacks[] = {
- #include "fallback_dirs.inc"
- NULL
- };
- /** Add the default directory authorities directly into the trusted dir list,
- * but only add them insofar as they share bits with <b>type</b>.
- * Each authority's bits are restricted to the bits shared with <b>type</b>.
- * If <b>type</b> is ALL_DIRINFO or NO_DIRINFO (zero), add all authorities. */
- STATIC void
- add_default_trusted_dir_authorities(dirinfo_type_t type)
- {
- int i;
- for (i=0; default_authorities[i]; i++) {
- if (parse_dir_authority_line(default_authorities[i], type, 0)<0) {
- log_err(LD_BUG, "Couldn't parse internal DirAuthority line %s",
- default_authorities[i]);
- }
- }
- }
- /** Add the default fallback directory servers into the fallback directory
- * server list. */
- MOCK_IMPL(void,
- add_default_fallback_dir_servers,(void))
- {
- int i;
- for (i=0; default_fallbacks[i]; i++) {
- if (parse_dir_fallback_line(default_fallbacks[i], 0)<0) {
- log_err(LD_BUG, "Couldn't parse internal FallbackDir line %s",
- default_fallbacks[i]);
- }
- }
- }
- /** Look at all the config options for using alternate directory
- * authorities, and make sure none of them are broken. Also, warn the
- * user if we changed any dangerous ones.
- */
- static int
- validate_dir_servers(or_options_t *options, or_options_t *old_options)
- {
- config_line_t *cl;
- if (options->DirAuthorities &&
- (options->AlternateDirAuthority || options->AlternateBridgeAuthority)) {
- log_warn(LD_CONFIG,
- "You cannot set both DirAuthority and Alternate*Authority.");
- return -1;
- }
- /* do we want to complain to the user about being partitionable? */
- if ((options->DirAuthorities &&
- (!old_options ||
- !config_lines_eq(options->DirAuthorities,
- old_options->DirAuthorities))) ||
- (options->AlternateDirAuthority &&
- (!old_options ||
- !config_lines_eq(options->AlternateDirAuthority,
- old_options->AlternateDirAuthority)))) {
- log_warn(LD_CONFIG,
- "You have used DirAuthority or AlternateDirAuthority to "
- "specify alternate directory authorities in "
- "your configuration. This is potentially dangerous: it can "
- "make you look different from all other Tor users, and hurt "
- "your anonymity. Even if you've specified the same "
- "authorities as Tor uses by default, the defaults could "
- "change in the future. Be sure you know what you're doing.");
- }
- /* Now go through the four ways you can configure an alternate
- * set of directory authorities, and make sure none are broken. */
- for (cl = options->DirAuthorities; cl; cl = cl->next)
- if (parse_dir_authority_line(cl->value, NO_DIRINFO, 1)<0)
- return -1;
- for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
- if (parse_dir_authority_line(cl->value, NO_DIRINFO, 1)<0)
- return -1;
- for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
- if (parse_dir_authority_line(cl->value, NO_DIRINFO, 1)<0)
- return -1;
- for (cl = options->FallbackDir; cl; cl = cl->next)
- if (parse_dir_fallback_line(cl->value, 1)<0)
- return -1;
- return 0;
- }
- /** Look at all the config options and assign new dir authorities
- * as appropriate.
- */
- int
- consider_adding_dir_servers(const or_options_t *options,
- const or_options_t *old_options)
- {
- config_line_t *cl;
- int need_to_update =
- !smartlist_len(router_get_trusted_dir_servers()) ||
- !smartlist_len(router_get_fallback_dir_servers()) || !old_options ||
- !config_lines_eq(options->DirAuthorities, old_options->DirAuthorities) ||
- !config_lines_eq(options->FallbackDir, old_options->FallbackDir) ||
- (options->UseDefaultFallbackDirs != old_options->UseDefaultFallbackDirs) ||
- !config_lines_eq(options->AlternateBridgeAuthority,
- old_options->AlternateBridgeAuthority) ||
- !config_lines_eq(options->AlternateDirAuthority,
- old_options->AlternateDirAuthority);
- if (!need_to_update)
- return 0; /* all done */
- /* "You cannot set both DirAuthority and Alternate*Authority."
- * Checking that this restriction holds allows us to simplify
- * the unit tests. */
- tor_assert(!(options->DirAuthorities &&
- (options->AlternateDirAuthority
- || options->AlternateBridgeAuthority)));
- /* Start from a clean slate. */
- clear_dir_servers();
- if (!options->DirAuthorities) {
- /* then we may want some of the defaults */
- dirinfo_type_t type = NO_DIRINFO;
- if (!options->AlternateBridgeAuthority) {
- type |= BRIDGE_DIRINFO;
- }
- if (!options->AlternateDirAuthority) {
- type |= V3_DIRINFO | EXTRAINFO_DIRINFO | MICRODESC_DIRINFO;
- /* Only add the default fallback directories when the DirAuthorities,
- * AlternateDirAuthority, and FallbackDir directory config options
- * are set to their defaults, and when UseDefaultFallbackDirs is 1. */
- if (!options->FallbackDir && options->UseDefaultFallbackDirs) {
- add_default_fallback_dir_servers();
- }
- }
- /* if type == NO_DIRINFO, we don't want to add any of the
- * default authorities, because we've replaced them all */
- if (type != NO_DIRINFO)
- add_default_trusted_dir_authorities(type);
- }
- for (cl = options->DirAuthorities; cl; cl = cl->next)
- if (parse_dir_authority_line(cl->value, NO_DIRINFO, 0)<0)
- return -1;
- for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
- if (parse_dir_authority_line(cl->value, NO_DIRINFO, 0)<0)
- return -1;
- for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
- if (parse_dir_authority_line(cl->value, NO_DIRINFO, 0)<0)
- return -1;
- for (cl = options->FallbackDir; cl; cl = cl->next)
- if (parse_dir_fallback_line(cl->value, 0)<0)
- return -1;
- return 0;
- }
- /* Helps determine flags to pass to switch_id. */
- static int have_low_ports = -1;
- /** Fetch the active option list, and take actions based on it. All of the
- * things we do should survive being done repeatedly. If present,
- * <b>old_options</b> contains the previous value of the options.
- *
- * Return 0 if all goes well, return -1 if things went badly.
- */
- static int
- options_act_reversible(const or_options_t *old_options, char **msg)
- {
- smartlist_t *new_listeners = smartlist_new();
- smartlist_t *replaced_listeners = smartlist_new();
- static int libevent_initialized = 0;
- or_options_t *options = get_options_mutable();
- int running_tor = options->command == CMD_RUN_TOR;
- int set_conn_limit = 0;
- int r = -1;
- int logs_marked = 0, logs_initialized = 0;
- int old_min_log_level = get_min_log_level();
- /* Daemonize _first_, since we only want to open most of this stuff in
- * the subprocess. Libevent bases can't be reliably inherited across
- * processes. */
- if (running_tor && options->RunAsDaemon) {
- /* No need to roll back, since you can't change the value. */
- start_daemon();
- }
- #ifdef HAVE_SYSTEMD
- /* Our PID may have changed, inform supervisor */
- sd_notifyf(0, "MAINPID=%ld\n", (long int)getpid());
- #endif
- #ifndef HAVE_SYS_UN_H
- if (options->ControlSocket || options->ControlSocketsGroupWritable) {
- *msg = tor_strdup("Unix domain sockets (ControlSocket) not supported "
- "on this OS/with this build.");
- goto rollback;
- }
- #else
- if (options->ControlSocketsGroupWritable && !options->ControlSocket) {
- *msg = tor_strdup("Setting ControlSocketGroupWritable without setting"
- "a ControlSocket makes no sense.");
- goto rollback;
- }
- #endif
- if (running_tor) {
- int n_ports=0;
- /* We need to set the connection limit before we can open the listeners. */
- if (! sandbox_is_active()) {
- if (set_max_file_descriptors((unsigned)options->ConnLimit,
- &options->ConnLimit_) < 0) {
- *msg = tor_strdup("Problem with ConnLimit value. "
- "See logs for details.");
- goto rollback;
- }
- set_conn_limit = 1;
- } else {
- tor_assert(old_options);
- options->ConnLimit_ = old_options->ConnLimit_;
- }
- /* Set up libevent. (We need to do this before we can register the
- * listeners as listeners.) */
- if (running_tor && !libevent_initialized) {
- init_libevent(options);
- libevent_initialized = 1;
- /* This has to come up after libevent is initialized. */
- control_initialize_event_queue();
- /*
- * Initialize the scheduler - this has to come after
- * options_init_from_torrc() sets up libevent - why yes, that seems
- * completely sensible to hide the libevent setup in the option parsing
- * code! It also needs to happen before init_keys(), so it needs to
- * happen here too. How yucky. */
- scheduler_init();
- }
- /* Adjust the port configuration so we can launch listeners. */
- if (parse_ports(options, 0, msg, &n_ports, NULL)) {
- if (!*msg)
- *msg = tor_strdup("Unexpected problem parsing port config");
- goto rollback;
- }
- /* Set the hibernation state appropriately.*/
- consider_hibernation(time(NULL));
- /* Launch the listeners. (We do this before we setuid, so we can bind to
- * ports under 1024.) We don't want to rebind if we're hibernating. If
- * networking is disabled, this will close all but the control listeners,
- * but disable those. */
- if (!we_are_hibernating()) {
- if (retry_all_listeners(replaced_listeners, new_listeners,
- options->DisableNetwork) < 0) {
- *msg = tor_strdup("Failed to bind one of the listener ports.");
- goto rollback;
- }
- }
- if (options->DisableNetwork) {
- /* Aggressively close non-controller stuff, NOW */
- log_notice(LD_NET, "DisableNetwork is set. Tor will not make or accept "
- "non-control network connections. Shutting down all existing "
- "connections.");
- connection_mark_all_noncontrol_connections();
- /* We can't complete circuits until the network is re-enabled. */
- note_that_we_maybe_cant_complete_circuits();
- }
- }
- #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
- /* Open /dev/pf before dropping privileges. */
- if (options->TransPort_set &&
- options->TransProxyType_parsed == TPT_DEFAULT) {
- if (get_pf_socket() < 0) {
- *msg = tor_strdup("Unable to open /dev/pf for transparent proxy.");
- goto rollback;
- }
- }
- #endif
- /* Attempt to lock all current and future memory with mlockall() only once */
- if (options->DisableAllSwap) {
- if (tor_mlockall() == -1) {
- *msg = tor_strdup("DisableAllSwap failure. Do you have proper "
- "permissions?");
- goto done;
- }
- }
- /* Setuid/setgid as appropriate */
- if (options->User) {
- tor_assert(have_low_ports != -1);
- unsigned switch_id_flags = 0;
- if (options->KeepBindCapabilities == 1) {
- switch_id_flags |= SWITCH_ID_KEEP_BINDLOW;
- switch_id_flags |= SWITCH_ID_WARN_IF_NO_CAPS;
- }
- if (options->KeepBindCapabilities == -1 && have_low_ports) {
- switch_id_flags |= SWITCH_ID_KEEP_BINDLOW;
- }
- if (switch_id(options->User, switch_id_flags) != 0) {
- /* No need to roll back, since you can't change the value. */
- *msg = tor_strdup("Problem with User value. See logs for details.");
- goto done;
- }
- }
- /* Ensure data directory is private; create if possible. */
- cpd_check_t cpd_opts = running_tor ? CPD_CREATE : CPD_CHECK;
- if (options->DataDirectoryGroupReadable)
- cpd_opts |= CPD_GROUP_READ;
- if (check_private_dir(options->DataDirectory,
- cpd_opts,
- options->User)<0) {
- tor_asprintf(msg,
- "Couldn't access/create private data directory \"%s\"",
- options->DataDirectory);
- goto done;
- /* No need to roll back, since you can't change the value. */
- }
- #ifndef _WIN32
- if (options->DataDirectoryGroupReadable) {
- /* Only new dirs created get new opts, also enforce group read. */
- if (chmod(options->DataDirectory, 0750)) {
- log_warn(LD_FS,"Unable to make %s group-readable: %s",
- options->DataDirectory, strerror(errno));
- }
- }
- #endif
- /* Bail out at this point if we're not going to be a client or server:
- * we don't run Tor itself. */
- if (!running_tor)
- goto commit;
- mark_logs_temp(); /* Close current logs once new logs are open. */
- logs_marked = 1;
- /* Configure the tor_log(s) */
- if (options_init_logs(old_options, options, 0)<0) {
- *msg = tor_strdup("Failed to init Log options. See logs for details.");
- goto rollback;
- }
- logs_initialized = 1;
- commit:
- r = 0;
- if (logs_marked) {
- log_severity_list_t *severity =
- tor_malloc_zero(sizeof(log_severity_list_t));
- close_temp_logs();
- add_callback_log(severity, control_event_logmsg);
- control_adjust_event_log_severity();
- tor_free(severity);
- tor_log_update_sigsafe_err_fds();
- }
- if (logs_initialized) {
- flush_log_messages_from_startup();
- }
- {
- const char *badness = NULL;
- int bad_safelog = 0, bad_severity = 0, new_badness = 0;
- if (options->SafeLogging_ != SAFELOG_SCRUB_ALL) {
- bad_safelog = 1;
- if (!old_options || old_options->SafeLogging_ != options->SafeLogging_)
- new_badness = 1;
- }
- if (get_min_log_level() >= LOG_INFO) {
- bad_severity = 1;
- if (get_min_log_level() != old_min_log_level)
- new_badness = 1;
- }
- if (bad_safelog && bad_severity)
- badness = "you disabled SafeLogging, and "
- "you're logging more than \"notice\"";
- else if (bad_safelog)
- badness = "you disabled SafeLogging";
- else
- badness = "you're logging more than \"notice\"";
- if (new_badness)
- log_warn(LD_GENERAL, "Your log may contain sensitive information - %s. "
- "Don't log unless it serves an important reason. "
- "Overwrite the log afterwards.", badness);
- }
- SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
- {
- int marked = conn->marked_for_close;
- log_notice(LD_NET, "Closing old %s on %s:%d",
- conn_type_to_string(conn->type), conn->address, conn->port);
- connection_close_immediate(conn);
- if (!marked) {
- connection_mark_for_close(conn);
- }
- });
- if (set_conn_limit) {
- /*
- * If we adjusted the conn limit, recompute the OOS threshold too
- *
- * How many possible sockets to keep in reserve? If we have lots of
- * possible sockets, keep this below a limit and set ConnLimit_high_thresh
- * very close to ConnLimit_, but if ConnLimit_ is low, shrink it in
- * proportion.
- *
- * Somewhat arbitrarily, set socks_in_reserve to 5% of ConnLimit_, but
- * cap it at 64.
- */
- int socks_in_reserve = options->ConnLimit_ / 20;
- if (socks_in_reserve > 64) socks_in_reserve = 64;
- options->ConnLimit_high_thresh = options->ConnLimit_ - socks_in_reserve;
- options->ConnLimit_low_thresh = (options->ConnLimit_ / 4) * 3;
- log_info(LD_GENERAL,
- "Recomputed OOS thresholds: ConnLimit %d, ConnLimit_ %d, "
- "ConnLimit_high_thresh %d, ConnLimit_low_thresh %d",
- options->ConnLimit, options->ConnLimit_,
- options->ConnLimit_high_thresh,
- options->ConnLimit_low_thresh);
- /* Give the OOS handler a chance with the new thresholds */
- connection_check_oos(get_n_open_sockets(), 0);
- }
- goto done;
- rollback:
- r = -1;
- tor_assert(*msg);
- if (logs_marked) {
- rollback_log_changes();
- control_adjust_event_log_severity();
- }
- if (set_conn_limit && old_options)
- set_max_file_descriptors((unsigned)old_options->ConnLimit,
- &options->ConnLimit_);
- SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
- {
- log_notice(LD_NET, "Closing partially-constructed %s on %s:%d",
- conn_type_to_string(conn->type), conn->address, conn->port);
- connection_close_immediate(conn);
- connection_mark_for_close(conn);
- });
- done:
- smartlist_free(new_listeners);
- smartlist_free(replaced_listeners);
- return r;
- }
- /** If we need to have a GEOIP ip-to-country map to run with our configured
- * options, return 1 and set *<b>reason_out</b> to a description of why. */
- int
- options_need_geoip_info(const or_options_t *options, const char **reason_out)
- {
- int bridge_usage =
- options->BridgeRelay && options->BridgeRecordUsageByCountry;
- int routerset_usage =
- routerset_needs_geoip(options->EntryNodes) ||
- routerset_needs_geoip(options->ExitNodes) ||
- routerset_needs_geoip(options->ExcludeExitNodes) ||
- routerset_needs_geoip(options->ExcludeNodes) ||
- routerset_needs_geoip(options->Tor2webRendezvousPoints);
- if (routerset_usage && reason_out) {
- *reason_out = "We've been configured to use (or avoid) nodes in certain "
- "countries, and we need GEOIP information to figure out which ones they "
- "are.";
- } else if (bridge_usage && reason_out) {
- *reason_out = "We've been configured to see which countries can access "
- "us as a bridge, and we need GEOIP information to tell which countries "
- "clients are in.";
- }
- return bridge_usage || routerset_usage;
- }
- /** Return the bandwidthrate that we are going to report to the authorities
- * based on the config options. */
- uint32_t
- get_effective_bwrate(const or_options_t *options)
- {
- uint64_t bw = options->BandwidthRate;
- if (bw > options->MaxAdvertisedBandwidth)
- bw = options->MaxAdvertisedBandwidth;
- if (options->RelayBandwidthRate > 0 && bw > options->RelayBandwidthRate)
- bw = options->RelayBandwidthRate;
- /* ensure_bandwidth_cap() makes sure that this cast can't overflow. */
- return (uint32_t)bw;
- }
- /** Return the bandwidthburst that we are going to report to the authorities
- * based on the config options. */
- uint32_t
- get_effective_bwburst(const or_options_t *options)
- {
- uint64_t bw = options->BandwidthBurst;
- if (options->RelayBandwidthBurst > 0 && bw > options->RelayBandwidthBurst)
- bw = options->RelayBandwidthBurst;
- /* ensure_bandwidth_cap() makes sure that this cast can't overflow. */
- return (uint32_t)bw;
- }
- /**
- * Return true if changing the configuration from <b>old</b> to <b>new</b>
- * affects the guard susbsystem.
- */
- static int
- options_transition_affects_guards(const or_options_t *old,
- const or_options_t *new)
- {
- /* NOTE: Make sure this function stays in sync with
- * entry_guards_set_filtered_flags */
- tor_assert(old);
- tor_assert(new);
- return
- (old->UseEntryGuards != new->UseEntryGuards ||
- old->UseBridges != new->UseBridges ||
- old->ClientUseIPv4 != new->ClientUseIPv4 ||
- old->ClientUseIPv6 != new->ClientUseIPv6 ||
- old->FascistFirewall != new->FascistFirewall ||
- !routerset_equal(old->ExcludeNodes, new->ExcludeNodes) ||
- !routerset_equal(old->EntryNodes, new->EntryNodes) ||
- !smartlist_strings_eq(old->FirewallPorts, new->FirewallPorts) ||
- !config_lines_eq(old->Bridges, new->Bridges) ||
- !config_lines_eq(old->ReachableORAddresses, new->ReachableORAddresses) ||
- !config_lines_eq(old->ReachableDirAddresses, new->ReachableDirAddresses));
- }
- /** Fetch the active option list, and take actions based on it. All of the
- * things we do should survive being done repeatedly. If present,
- * <b>old_options</b> contains the previous value of the options.
- *
- * Return 0 if all goes well, return -1 if it's time to die.
- *
- * Note: We haven't moved all the "act on new configuration" logic
- * here yet. Some is still in do_hup() and other places.
- */
- STATIC int
- options_act(const or_options_t *old_options)
- {
- config_line_t *cl;
- or_options_t *options = get_options_mutable();
- int running_tor = options->command == CMD_RUN_TOR;
- char *msg=NULL;
- const int transition_affects_workers =
- old_options && options_transition_affects_workers(old_options, options);
- int old_ewma_enabled;
- const int transition_affects_guards =
- old_options && options_transition_affects_guards(old_options, options);
- /* disable ptrace and later, other basic debugging techniques */
- {
- /* Remember if we already disabled debugger attachment */
- static int disabled_debugger_attach = 0;
- /* Remember if we already warned about being configured not to disable
- * debugger attachment */
- static int warned_debugger_attach = 0;
- /* Don't disable debugger attachment when we're running the unit tests. */
- if (options->DisableDebuggerAttachment && !disabled_debugger_attach &&
- running_tor) {
- int ok = tor_disable_debugger_attach();
- /* LCOV_EXCL_START the warned_debugger_attach is 0 can't reach inside. */
- if (warned_debugger_attach && ok == 1) {
- log_notice(LD_CONFIG, "Disabled attaching debuggers for unprivileged "
- "users.");
- }
- /* LCOV_EXCL_STOP */
- disabled_debugger_attach = (ok == 1);
- } else if (!options->DisableDebuggerAttachment &&
- !warned_debugger_attach) {
- log_notice(LD_CONFIG, "Not disabling debugger attaching for "
- "unprivileged users.");
- warned_debugger_attach = 1;
- }
- }
- /* Write control ports to disk as appropriate */
- control_ports_write_to_file();
- if (running_tor && !have_lockfile()) {
- if (try_locking(options, 1) < 0)
- return -1;
- }
- if (consider_adding_dir_servers(options, old_options) < 0)
- return -1;
- if (rend_non_anonymous_mode_enabled(options)) {
- log_warn(LD_GENERAL, "This copy of Tor was compiled or configured to run "
- "in a non-anonymous mode. It will provide NO ANONYMITY.");
- }
- #ifdef ENABLE_TOR2WEB_MODE
- /* LCOV_EXCL_START */
- if (!options->Tor2webMode) {
- log_err(LD_CONFIG, "This copy of Tor was compiled to run in "
- "'tor2web mode'. It can only be run with the Tor2webMode torrc "
- "option enabled.");
- return -1;
- }
- /* LCOV_EXCL_STOP */
- #else
- if (options->Tor2webMode) {
- log_err(LD_CONFIG, "This copy of Tor was not compiled to run in "
- "'tor2web mode'. It cannot be run with the Tor2webMode torrc "
- "option enabled. To enable Tor2webMode recompile with the "
- "--enable-tor2web-mode option.");
- return -1;
- }
- #endif
- /* If we are a bridge with a pluggable transport proxy but no
- Extended ORPort, inform the user that they are missing out. */
- if (server_mode(options) && options->ServerTransportPlugin &&
- !options->ExtORPort_lines) {
- log_notice(LD_CONFIG, "We use pluggable transports but the Extended "
- "ORPort is disabled. Tor and your pluggable transports proxy "
- "communicate with each other via the Extended ORPort so it "
- "is suggested you enable it: it will also allow your Bridge "
- "to collect statistics about its clients that use pluggable "
- "transports. Please enable it using the ExtORPort torrc option "
- "(e.g. set 'ExtORPort auto').");
- }
- if (options->Bridges) {
- mark_bridge_list();
- for (cl = options->Bridges; cl; cl = cl->next) {
- bridge_line_t *bridge_line = parse_bridge_line(cl->value);
- if (!bridge_line) {
- log_warn(LD_BUG,
- "Previously validated Bridge line could not be added!");
- return -1;
- }
- bridge_add_from_config(bridge_line);
- }
- sweep_bridge_list();
- }
- if (running_tor && rend_config_services(options, 0)<0) {
- log_warn(LD_BUG,
- "Previously validated hidden services line could not be added!");
- return -1;
- }
- if (running_tor && rend_parse_service_authorization(options, 0) < 0) {
- log_warn(LD_BUG, "Previously validated client authorization for "
- "hidden services could not be added!");
- return -1;
- }
- /* Load state */
- if (! or_state_loaded() && running_tor) {
- if (or_state_load())
- return -1;
- rep_hist_load_mtbf_data(time(NULL));
- }
- /* If we have an ExtORPort, initialize its auth cookie. */
- if (running_tor &&
- init_ext_or_cookie_authentication(!!options->ExtORPort_lines) < 0) {
- log_warn(LD_CONFIG,"Error creating Extended ORPort cookie file.");
- return -1;
- }
- mark_transport_list();
- pt_prepare_proxy_list_for_config_read();
- if (!options->DisableNetwork) {
- if (options->ClientTransportPlugin) {
- for (cl = options->ClientTransportPlugin; cl; cl = cl->next) {
- if (parse_transport_line(options, cl->value, 0, 0) < 0) {
- log_warn(LD_BUG,
- "Previously validated ClientTransportPlugin line "
- "could not be added!");
- return -1;
- }
- }
- }
- if (options->ServerTransportPlugin && server_mode(options)) {
- for (cl = options->ServerTransportPlugin; cl; cl = cl->next) {
- if (parse_transport_line(options, cl->value, 0, 1) < 0) {
- log_warn(LD_BUG,
- "Previously validated ServerTransportPlugin line "
- "could not be added!");
- return -1;
- }
- }
- }
- }
- sweep_transport_list();
- sweep_proxy_list();
- /* Start the PT proxy configuration. By doing this configuration
- here, we also figure out which proxies need to be restarted and
- which not. */
- if (pt_proxies_configuration_pending() && !net_is_disabled())
- pt_configure_remaining_proxies();
- /* Bail out at this point if we're not going to be a client or server:
- * we want to not fork, and to log stuff to stderr. */
- if (!running_tor)
- return 0;
- /* Finish backgrounding the process */
- if (options->RunAsDaemon) {
- /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
- finish_daemon(options->DataDirectory);
- }
- /* We want to reinit keys as needed before we do much of anything else:
- keys are important, and other things can depend on them. */
- if (transition_affects_workers ||
- (options->V3AuthoritativeDir && (!old_options ||
- !old_options->V3AuthoritativeDir))) {
- if (init_keys() < 0) {
- log_warn(LD_BUG,"Error initializing keys; exiting");
- return -1;
- }
- }
- /* Write our PID to the PID file. If we do not have write permissions we
- * will log a warning */
- if (options->PidFile && !sandbox_is_active()) {
- write_pidfile(options->PidFile);
- }
- /* Register addressmap directives */
- config_register_addressmaps(options);
- parse_virtual_addr_network(options->VirtualAddrNetworkIPv4, AF_INET,0,NULL);
- parse_virtual_addr_network(options->VirtualAddrNetworkIPv6, AF_INET6,0,NULL);
- /* Update address policies. */
- if (policies_parse_from_options(options) < 0) {
- /* This should be impossible, but let's be sure. */
- log_warn(LD_BUG,"Error parsing already-validated policy options.");
- return -1;
- }
- if (init_control_cookie_authentication(options->CookieAuthentication) < 0) {
- log_warn(LD_CONFIG,"Error creating control cookie authentication file.");
- return -1;
- }
- monitor_owning_controller_process(options->OwningControllerProcess);
- /* reload keys as needed for rendezvous services. */
- if (rend_service_load_all_keys(NULL)<0) {
- log_warn(LD_GENERAL,"Error loading rendezvous service keys");
- return -1;
- }
- /* Set up scheduler thresholds */
- scheduler_set_watermarks((uint32_t)options->SchedulerLowWaterMark__,
- (uint32_t)options->SchedulerHighWaterMark__,
- (options->SchedulerMaxFlushCells__ > 0) ?
- options->SchedulerMaxFlushCells__ : 1000);
- /* Set up accounting */
- if (accounting_parse_options(options, 0)<0) {
- log_warn(LD_CONFIG,"Error in accounting options");
- return -1;
- }
- if (accounting_is_enabled(options))
- configure_accounting(time(NULL));
- old_ewma_enabled = cell_ewma_enabled();
- /* Change the cell EWMA settings */
- cell_ewma_set_scale_factor(options, networkstatus_get_latest_consensus());
- /* If we just enabled ewma, set the cmux policy on all active channels */
- if (cell_ewma_enabled() && !old_ewma_enabled) {
- channel_set_cmux_policy_everywhere(&ewma_policy);
- } else if (!cell_ewma_enabled() && old_ewma_enabled) {
- /* Turn it off everywhere */
- channel_set_cmux_policy_everywhere(NULL);
- }
- /* Update the BridgePassword's hashed version as needed. We store this as a
- * digest so that we can do side-channel-proof comparisons on it.
- */
- if (options->BridgePassword) {
- char *http_authenticator;
- http_authenticator = alloc_http_authenticator(options->BridgePassword);
- if (!http_authenticator) {
- log_warn(LD_BUG, "Unable to allocate HTTP authenticator. Not setting "
- "BridgePassword.");
- return -1;
- }
- options->BridgePassword_AuthDigest_ = tor_malloc(DIGEST256_LEN);
- crypto_digest256(options->BridgePassword_AuthDigest_,
- http_authenticator, strlen(http_authenticator),
- DIGEST_SHA256);
- tor_free(http_authenticator);
- }
- if (parse_outbound_addresses(options, 0, &msg) < 0) {
- log_warn(LD_BUG, "Failed parsing outbound bind addresses: %s", msg);
- tor_free(msg);
- return -1;
- }
- config_maybe_load_geoip_files_(options, old_options);
- if (geoip_is_loaded(AF_INET) && options->GeoIPExcludeUnknown) {
- /* ExcludeUnknown is true or "auto" */
- const int is_auto = options->GeoIPExcludeUnknown == -1;
- int changed;
- changed = routerset_add_unknown_ccs(&options->ExcludeNodes, is_auto);
- changed += routerset_add_unknown_ccs(&options->ExcludeExitNodes, is_auto);
- if (changed)
- routerset_add_unknown_ccs(&options->ExcludeExitNodesUnion_, is_auto);
- }
- /* Check for transitions that need action. */
- if (old_options) {
- int revise_trackexithosts = 0;
- int revise_automap_entries = 0;
- int abandon_circuits = 0;
- if ((options->UseEntryGuards && !old_options->UseEntryGuards) ||
- options->UseBridges != old_options->UseBridges ||
- (options->UseBridges &&
- !config_lines_eq(options->Bridges, old_options->Bridges)) ||
- !routerset_equal(old_options->ExcludeNodes,options->ExcludeNodes) ||
- !routerset_equal(old_options->ExcludeExitNodes,
- options->ExcludeExitNodes) ||
- !routerset_equal(old_options->EntryNodes, options->EntryNodes) ||
- !routerset_equal(old_options->ExitNodes, options->ExitNodes) ||
- !routerset_equal(old_options->Tor2webRendezvousPoints,
- options->Tor2webRendezvousPoints) ||
- options->StrictNodes != old_options->StrictNodes) {
- log_info(LD_CIRC,
- "Changed to using entry guards or bridges, or changed "
- "preferred or excluded node lists. "
- "Abandoning previous circuits.");
- abandon_circuits = 1;
- }
- if (transition_affects_guards) {
- if (guards_update_all()) {
- abandon_circuits = 1;
- }
- }
- if (abandon_circuits) {
- circuit_mark_all_unused_circs();
- circuit_mark_all_dirty_circs_as_unusable();
- revise_trackexithosts = 1;
- }
- if (!smartlist_strings_eq(old_options->TrackHostExits,
- options->TrackHostExits))
- revise_trackexithosts = 1;
- if (revise_trackexithosts)
- addressmap_clear_excluded_trackexithosts(options);
- if (!options->AutomapHostsOnResolve &&
- old_options->AutomapHostsOnResolve) {
- revise_automap_entries = 1;
- } else {
- if (!smartlist_strings_eq(old_options->AutomapHostsSuffixes,
- options->AutomapHostsSuffixes))
- revise_automap_entries = 1;
- else if (!opt_streq(old_options->VirtualAddrNetworkIPv4,
- options->VirtualAddrNetworkIPv4) ||
- !opt_streq(old_options->VirtualAddrNetworkIPv6,
- options->VirtualAddrNetworkIPv6))
- revise_automap_entries = 1;
- }
- if (revise_automap_entries)
- addressmap_clear_invalid_automaps(options);
- /* How long should we delay counting bridge stats after becoming a bridge?
- * We use this so we don't count clients who used our bridge thinking it is
- * a relay. If you change this, don't forget to change the log message
- * below. It's 4 hours (the time it takes to stop being used by clients)
- * plus some extra time for clock skew. */
- #define RELAY_BRIDGE_STATS_DELAY (6 * 60 * 60)
- if (! bool_eq(options->BridgeRelay, old_options->BridgeRelay)) {
- int was_relay = 0;
- if (options->BridgeRelay) {
- time_t int_start = time(NULL);
- if (config_lines_eq(old_options->ORPort_lines,options->ORPort_lines)) {
- int_start += RELAY_BRIDGE_STATS_DELAY;
- was_relay = 1;
- }
- geoip_bridge_stats_init(int_start);
- log_info(LD_CONFIG, "We are acting as a bridge now. Starting new "
- "GeoIP stats interval%s.", was_relay ? " in 6 "
- "hours from now" : "");
- } else {
- geoip_bridge_stats_term();
- log_info(LD_GENERAL, "We are no longer acting as a bridge. "
- "Forgetting GeoIP stats.");
- }
- }
- if (transition_affects_workers) {
- log_info(LD_GENERAL,
- "Worker-related options changed. Rotating workers.");
- if (server_mode(options) && !server_mode(old_options)) {
- cpu_init();
- ip_address_changed(0);
- if (have_completed_a_circuit() || !any_predicted_circuits(time(NULL)))
- inform_testing_reachability();
- }
- cpuworkers_rotate_keyinfo();
- if (dns_reset())
- return -1;
- } else {
- if (dns_reset())
- return -1;
- }
- if (options->PerConnBWRate != old_options->PerConnBWRate ||
- options->PerConnBWBurst != old_options->PerConnBWBurst)
- connection_or_update_token_buckets(get_connection_array(), options);
- }
- /* Only collect directory-request statistics on relays and bridges. */
- options->DirReqStatistics = options->DirReqStatistics_option &&
- server_mode(options);
- options->HiddenServiceStatistics =
- options->HiddenServiceStatistics_option && server_mode(options);
- if (options->CellStatistics || options->DirReqStatistics ||
- options->EntryStatistics || options->ExitPortStatistics ||
- options->ConnDirectionStatistics ||
- options->HiddenServiceStatistics ||
- options->BridgeAuthoritativeDir) {
- time_t now = time(NULL);
- int print_notice = 0;
- /* Only collect other relay-only statistics on relays. */
- if (!public_server_mode(options)) {
- options->CellStatistics = 0;
- options->EntryStatistics = 0;
- options->ConnDirectionStatistics = 0;
- options->ExitPortStatistics = 0;
- }
- if ((!old_options || !old_options->CellStatistics) &&
- options->CellStatistics) {
- rep_hist_buffer_stats_init(now);
- print_notice = 1;
- }
- if ((!old_options || !old_options->DirReqStatistics) &&
- options->DirReqStatistics) {
- if (geoip_is_loaded(AF_INET)) {
- geoip_dirreq_stats_init(now);
- print_notice = 1;
- } else {
- /* disable statistics collection since we have no geoip file */
- options->DirReqStatistics = 0;
- if (options->ORPort_set)
- log_notice(LD_CONFIG, "Configured to measure directory request "
- "statistics, but no GeoIP database found. "
- "Please specify a GeoIP database using the "
- "GeoIPFile option.");
- }
- }
- if ((!old_options || !old_options->EntryStatistics) &&
- options->EntryStatistics && !should_record_bridge_info(options)) {
- if (geoip_is_loaded(AF_INET) || geoip_is_loaded(AF_INET6)) {
- geoip_entry_stats_init(now);
- print_notice = 1;
- } else {
- options->EntryStatistics = 0;
- log_notice(LD_CONFIG, "Configured to measure entry node "
- "statistics, but no GeoIP database found. "
- "Please specify a GeoIP database using the "
- "GeoIPFile option.");
- }
- }
- if ((!old_options || !old_options->ExitPortStatistics) &&
- options->ExitPortStatistics) {
- rep_hist_exit_stats_init(now);
- print_notice = 1;
- }
- if ((!old_options || !old_options->ConnDirectionStatistics) &&
- options->ConnDirectionStatistics) {
- rep_hist_conn_stats_init(now);
- }
- if ((!old_options || !old_options->HiddenServiceStatistics) &&
- options->HiddenServiceStatistics) {
- log_info(LD_CONFIG, "Configured to measure hidden service statistics.");
- rep_hist_hs_stats_init(now);
- }
- if ((!old_options || !old_options->BridgeAuthoritativeDir) &&
- options->BridgeAuthoritativeDir) {
- rep_hist_desc_stats_init(now);
- print_notice = 1;
- }
- if (print_notice)
- log_notice(LD_CONFIG, "Configured to measure statistics. Look for "
- "the *-stats files that will first be written to the "
- "data directory in 24 hours from now.");
- }
- /* If we used to have statistics enabled but we just disabled them,
- stop gathering them. */
- if (old_options && old_options->CellStatistics &&
- !options->CellStatistics)
- rep_hist_buffer_stats_term();
- if (old_options && old_options->DirReqStatistics &&
- !options->DirReqStatistics)
- geoip_dirreq_stats_term();
- if (old_options && old_options->EntryStatistics &&
- !options->EntryStatistics)
- geoip_entry_stats_term();
- if (old_options && old_options->HiddenServiceStatistics &&
- !options->HiddenServiceStatistics)
- rep_hist_hs_stats_term();
- if (old_options && old_options->ExitPortStatistics &&
- !options->ExitPortStatistics)
- rep_hist_exit_stats_term();
- if (old_options && old_options->ConnDirectionStatistics &&
- !options->ConnDirectionStatistics)
- rep_hist_conn_stats_term();
- if (old_options && old_options->BridgeAuthoritativeDir &&
- !options->BridgeAuthoritativeDir)
- rep_hist_desc_stats_term();
- /* Since our options changed, we might need to regenerate and upload our
- * server descriptor.
- */
- if (!old_options ||
- options_transition_affects_descriptor(old_options, options))
- mark_my_descriptor_dirty("config change");
- /* We may need to reschedule some directory stuff if our status changed. */
- if (old_options) {
- if (authdir_mode_v3(options) && !authdir_mode_v3(old_options))
- dirvote_recalculate_timing(options, time(NULL));
- if (!bool_eq(directory_fetches_dir_info_early(options),
- directory_fetches_dir_info_early(old_options)) ||
- !bool_eq(directory_fetches_dir_info_later(options),
- directory_fetches_dir_info_later(old_options))) {
- /* Make sure update_router_have_minimum_dir_info() gets called. */
- router_dir_info_changed();
- /* We might need to download a new consensus status later or sooner than
- * we had expected. */
- update_consensus_networkstatus_fetch_time(time(NULL));
- }
- }
- /* Load the webpage we're going to serve every time someone asks for '/' on
- our DirPort. */
- tor_free(global_dirfrontpagecontents);
- if (options->DirPortFrontPage) {
- global_dirfrontpagecontents =
- read_file_to_str(options->DirPortFrontPage, 0, NULL);
- if (!global_dirfrontpagecontents) {
- log_warn(LD_CONFIG,
- "DirPortFrontPage file '%s' not found. Continuing anyway.",
- options->DirPortFrontPage);
- }
- }
- return 0;
- }
- typedef enum {
- TAKES_NO_ARGUMENT = 0,
- ARGUMENT_NECESSARY = 1,
- ARGUMENT_OPTIONAL = 2
- } takes_argument_t;
- static const struct {
- const char *name;
- takes_argument_t takes_argument;
- } CMDLINE_ONLY_OPTIONS[] = {
- { "-f", ARGUMENT_NECESSARY },
- { "--allow-missing-torrc", TAKES_NO_ARGUMENT },
- { "--defaults-torrc", ARGUMENT_NECESSARY },
- { "--hash-password", ARGUMENT_NECESSARY },
- { "--dump-config", ARGUMENT_OPTIONAL },
- { "--list-fingerprint", TAKES_NO_ARGUMENT },
- { "--keygen", TAKES_NO_ARGUMENT },
- { "--newpass", TAKES_NO_ARGUMENT },
- { "--no-passphrase", TAKES_NO_ARGUMENT },
- { "--passphrase-fd", ARGUMENT_NECESSARY },
- { "--verify-config", TAKES_NO_ARGUMENT },
- { "--ignore-missing-torrc", TAKES_NO_ARGUMENT },
- { "--quiet", TAKES_NO_ARGUMENT },
- { "--hush", TAKES_NO_ARGUMENT },
- { "--version", TAKES_NO_ARGUMENT },
- { "--library-versions", TAKES_NO_ARGUMENT },
- { "-h", TAKES_NO_ARGUMENT },
- { "--help", TAKES_NO_ARGUMENT },
- { "--list-torrc-options", TAKES_NO_ARGUMENT },
- { "--list-deprecated-options",TAKES_NO_ARGUMENT },
- { "--nt-service", TAKES_NO_ARGUMENT },
- { "-nt-service", TAKES_NO_ARGUMENT },
- { NULL, 0 },
- };
- /** Helper: Read a list of configuration options from the command line. If
- * successful, or if ignore_errors is set, put them in *<b>result</b>, put the
- * commandline-only options in *<b>cmdline_result</b>, and return 0;
- * otherwise, return -1 and leave *<b>result</b> and <b>cmdline_result</b>
- * alone. */
- int
- config_parse_commandline(int argc, char **argv, int ignore_errors,
- config_line_t **result,
- config_line_t **cmdline_result)
- {
- config_line_t *param = NULL;
- config_line_t *front = NULL;
- config_line_t **new = &front;
- config_line_t *front_cmdline = NULL;
- config_line_t **new_cmdline = &front_cmdline;
- char *s, *arg;
- int i = 1;
- while (i < argc) {
- unsigned command = CONFIG_LINE_NORMAL;
- takes_argument_t want_arg = ARGUMENT_NECESSARY;
- int is_cmdline = 0;
- int j;
- for (j = 0; CMDLINE_ONLY_OPTIONS[j].name != NULL; ++j) {
- if (!strcmp(argv[i], CMDLINE_ONLY_OPTIONS[j].name)) {
- is_cmdline = 1;
- want_arg = CMDLINE_ONLY_OPTIONS[j].takes_argument;
- break;
- }
- }
- s = argv[i];
- /* Each keyword may be prefixed with one or two dashes. */
- if (*s == '-')
- s++;
- if (*s == '-')
- s++;
- /* Figure out the command, if any. */
- if (*s == '+') {
- s++;
- command = CONFIG_LINE_APPEND;
- } else if (*s == '/') {
- s++;
- command = CONFIG_LINE_CLEAR;
- /* A 'clear' command has no argument. */
- want_arg = 0;
- }
- const int is_last = (i == argc-1);
- if (want_arg == ARGUMENT_NECESSARY && is_last) {
- if (ignore_errors) {
- arg = tor_strdup("");
- } else {
- log_warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.",
- argv[i]);
- config_free_lines(front);
- config_free_lines(front_cmdline);
- return -1;
- }
- } else if (want_arg == ARGUMENT_OPTIONAL && is_last) {
- arg = tor_strdup("");
- } else {
- arg = (want_arg != TAKES_NO_ARGUMENT) ? tor_strdup(argv[i+1]) :
- tor_strdup("");
- }
- param = tor_malloc_zero(sizeof(config_line_t));
- param->key = is_cmdline ? tor_strdup(argv[i]) :
- tor_strdup(config_expand_abbrev(&options_format, s, 1, 1));
- param->value = arg;
- param->command = command;
- param->next = NULL;
- log_debug(LD_CONFIG, "command line: parsed keyword '%s', value '%s'",
- param->key, param->value);
- if (is_cmdline) {
- *new_cmdline = param;
- new_cmdline = &((*new_cmdline)->next);
- } else {
- *new = param;
- new = &((*new)->next);
- }
- i += want_arg ? 2 : 1;
- }
- *cmdline_result = front_cmdline;
- *result = front;
- return 0;
- }
- /** Return true iff key is a valid configuration option. */
- int
- option_is_recognized(const char *key)
- {
- const config_var_t *var = config_find_option(&options_format, key);
- return (var != NULL);
- }
- /** Return the canonical name of a configuration option, or NULL
- * if no such option exists. */
- const char *
- option_get_canonical_name(const char *key)
- {
- const config_var_t *var = config_find_option(&options_format, key);
- return var ? var->name : NULL;
- }
- /** Return a canonical list of the options assigned for key.
- */
- config_line_t *
- option_get_assignment(const or_options_t *options, const char *key)
- {
- return config_get_assigned_option(&options_format, options, key, 1);
- }
- /** Try assigning <b>list</b> to the global options. You do this by duping
- * options, assigning list to the new one, then validating it. If it's
- * ok, then throw out the old one and stick with the new one. Else,
- * revert to old and return failure. Return SETOPT_OK on success, or
- * a setopt_err_t on failure.
- *
- * If not success, point *<b>msg</b> to a newly allocated string describing
- * what went wrong.
- */
- setopt_err_t
- options_trial_assign(config_line_t *list, unsigned flags, char **msg)
- {
- int r;
- or_options_t *trial_options = config_dup(&options_format, get_options());
- if ((r=config_assign(&options_format, trial_options,
- list, flags, msg)) < 0) {
- or_options_free(trial_options);
- return r;
- }
- if (options_validate(get_options_mutable(), trial_options,
- global_default_options, 1, msg) < 0) {
- or_options_free(trial_options);
- return SETOPT_ERR_PARSE; /*XXX make this a separate return value. */
- }
- if (options_transition_allowed(get_options(), trial_options, msg) < 0) {
- or_options_free(trial_options);
- return SETOPT_ERR_TRANSITION;
- }
- if (set_options(trial_options, msg)<0) {
- or_options_free(trial_options);
- return SETOPT_ERR_SETTING;
- }
- /* we liked it. put it in place. */
- return SETOPT_OK;
- }
- /** Print a usage message for tor. */
- static void
- print_usage(void)
- {
- printf(
- "Copyright (c) 2001-2004, Roger Dingledine\n"
- "Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson\n"
- "Copyright (c) 2007-2017, The Tor Project, Inc.\n\n"
- "tor -f <torrc> [args]\n"
- "See man page for options, or https://www.torproject.org/ for "
- "documentation.\n");
- }
- /** Print all non-obsolete torrc options. */
- static void
- list_torrc_options(void)
- {
- int i;
- for (i = 0; option_vars_[i].name; ++i) {
- const config_var_t *var = &option_vars_[i];
- if (var->type == CONFIG_TYPE_OBSOLETE ||
- var->type == CONFIG_TYPE_LINELIST_V)
- continue;
- printf("%s\n", var->name);
- }
- }
- /** Print all deprecated but non-obsolete torrc options. */
- static void
- list_deprecated_options(void)
- {
- const config_deprecation_t *d;
- for (d = option_deprecation_notes_; d->name; ++d) {
- printf("%s\n", d->name);
- }
- }
- /** Last value actually set by resolve_my_address. */
- static uint32_t last_resolved_addr = 0;
- /** Accessor for last_resolved_addr from outside this file. */
- uint32_t
- get_last_resolved_addr(void)
- {
- return last_resolved_addr;
- }
- /** Reset last_resolved_addr from outside this file. */
- void
- reset_last_resolved_addr(void)
- {
- last_resolved_addr = 0;
- }
- /* Return true if <b>options</b> is using the default authorities, and false
- * if any authority-related option has been overridden. */
- int
- using_default_dir_authorities(const or_options_t *options)
- {
- return (!options->DirAuthorities && !options->AlternateDirAuthority);
- }
- /**
- * Attempt getting our non-local (as judged by tor_addr_is_internal()
- * function) IP address using following techniques, listed in
- * order from best (most desirable, try first) to worst (least
- * desirable, try if everything else fails).
- *
- * First, attempt using <b>options-\>Address</b> to get our
- * non-local IP address.
- *
- * If <b>options-\>Address</b> represents a non-local IP address,
- * consider it ours.
- *
- * If <b>options-\>Address</b> is a DNS name that resolves to
- * a non-local IP address, consider this IP address ours.
- *
- * If <b>options-\>Address</b> is NULL, fall back to getting local
- * hostname and using it in above-described ways to try and
- * get our IP address.
- *
- * In case local hostname cannot be resolved to a non-local IP
- * address, try getting an IP address of network interface
- * in hopes it will be non-local one.
- *
- * Fail if one or more of the following is true:
- * - DNS name in <b>options-\>Address</b> cannot be resolved.
- * - <b>options-\>Address</b> is a local host address.
- * - Attempt at getting local hostname fails.
- * - Attempt at getting network interface address fails.
- *
- * Return 0 if all is well, or -1 if we can't find a suitable
- * public IP address.
- *
- * If we are returning 0:
- * - Put our public IP address (in host order) into *<b>addr_out</b>.
- * - If <b>method_out</b> is non-NULL, set *<b>method_out</b> to a static
- * string describing how we arrived at our answer.
- * - "CONFIGURED" - parsed from IP address string in
- * <b>options-\>Address</b>
- * - "RESOLVED" - resolved from DNS name in <b>options-\>Address</b>
- * - "GETHOSTNAME" - resolved from a local hostname.
- * - "INTERFACE" - retrieved from a network interface.
- * - If <b>hostname_out</b> is non-NULL, and we resolved a hostname to
- * get our address, set *<b>hostname_out</b> to a newly allocated string
- * holding that hostname. (If we didn't get our address by resolving a
- * hostname, set *<b>hostname_out</b> to NULL.)
- *
- * XXXX ipv6
- */
- int
- resolve_my_address(int warn_severity, const or_options_t *options,
- uint32_t *addr_out,
- const char **method_out, char **hostname_out)
- {
- struct in_addr in;
- uint32_t addr; /* host order */
- char hostname[256];
- const char *method_used;
- const char *hostname_used;
- int explicit_ip=1;
- int explicit_hostname=1;
- int from_interface=0;
- char *addr_string = NULL;
- const char *address = options->Address;
- int notice_severity = warn_severity <= LOG_NOTICE ?
- LOG_NOTICE : warn_severity;
- tor_addr_t myaddr;
- tor_assert(addr_out);
- /*
- * Step one: Fill in 'hostname' to be our best guess.
- */
- if (address && *address) {
- strlcpy(hostname, address, sizeof(hostname));
- } else { /* then we need to guess our address */
- explicit_ip = 0; /* it's implicit */
- explicit_hostname = 0; /* it's implicit */
- if (tor_gethostname(hostname, sizeof(hostname)) < 0) {
- log_fn(warn_severity, LD_NET,"Error obtaining local hostname");
- return -1;
- }
- log_debug(LD_CONFIG, "Guessed local host name as '%s'", hostname);
- }
- /*
- * Step two: Now that we know 'hostname', parse it or resolve it. If
- * it doesn't parse or resolve, look at the interface address. Set 'addr'
- * to be our (host-order) 32-bit answer.
- */
- if (tor_inet_aton(hostname, &in) == 0) {
- /* then we have to resolve it */
- explicit_ip = 0;
- if (tor_lookup_hostname(hostname, &addr)) { /* failed to resolve */
- uint32_t interface_ip; /* host order */
- if (explicit_hostname) {
- log_fn(warn_severity, LD_CONFIG,
- "Could not resolve local Address '%s'. Failing.", hostname);
- return -1;
- }
- log_fn(notice_severity, LD_CONFIG,
- "Could not resolve guessed local hostname '%s'. "
- "Trying something else.", hostname);
- if (get_interface_address(warn_severity, &interface_ip)) {
- log_fn(warn_severity, LD_CONFIG,
- "Could not get local interface IP address. Failing.");
- return -1;
- }
- from_interface = 1;
- addr = interface_ip;
- log_fn(notice_severity, LD_CONFIG, "Learned IP address '%s' for "
- "local interface. Using that.", fmt_addr32(addr));
- strlcpy(hostname, "<guessed from interfaces>", sizeof(hostname));
- } else { /* resolved hostname into addr */
- tor_addr_from_ipv4h(&myaddr, addr);
- if (!explicit_hostname &&
- tor_addr_is_internal(&myaddr, 0)) {
- tor_addr_t interface_ip;
- log_fn(notice_severity, LD_CONFIG, "Guessed local hostname '%s' "
- "resolves to a private IP address (%s). Trying something "
- "else.", hostname, fmt_addr32(addr));
- if (get_interface_address6(warn_severity, AF_INET, &interface_ip)<0) {
- log_fn(warn_severity, LD_CONFIG,
- "Could not get local interface IP address. Too bad.");
- } else if (tor_addr_is_internal(&interface_ip, 0)) {
- log_fn(notice_severity, LD_CONFIG,
- "Interface IP address '%s' is a private address too. "
- "Ignoring.", fmt_addr(&interface_ip));
- } else {
- from_interface = 1;
- addr = tor_addr_to_ipv4h(&interface_ip);
- log_fn(notice_severity, LD_CONFIG,
- "Learned IP address '%s' for local interface."
- " Using that.", fmt_addr32(addr));
- strlcpy(hostname, "<guessed from interfaces>", sizeof(hostname));
- }
- }
- }
- } else {
- addr = ntohl(in.s_addr); /* set addr so that addr_string is not
- * illformed */
- }
- /*
- * Step three: Check whether 'addr' is an internal IP address, and error
- * out if it is and we don't want that.
- */
- tor_addr_from_ipv4h(&myaddr,addr);
- addr_string = tor_dup_ip(addr);
- if (tor_addr_is_internal(&myaddr, 0)) {
- /* make sure we're ok with publishing an internal IP */
- if (using_default_dir_authorities(options)) {
- /* if they are using the default authorities, disallow internal IPs
- * always. */
- log_fn(warn_severity, LD_CONFIG,
- "Address '%s' resolves to private IP address '%s'. "
- "Tor servers that use the default DirAuthorities must have "
- "public IP addresses.", hostname, addr_string);
- tor_free(addr_string);
- return -1;
- }
- if (!explicit_ip) {
- /* even if they've set their own authorities, require an explicit IP if
- * they're using an internal address. */
- log_fn(warn_severity, LD_CONFIG, "Address '%s' resolves to private "
- "IP address '%s'. Please set the Address config option to be "
- "the IP address you want to use.", hostname, addr_string);
- tor_free(addr_string);
- return -1;
- }
- }
- /*
- * Step four: We have a winner! 'addr' is our answer for sure, and
- * 'addr_string' is its string form. Fill out the various fields to
- * say how we decided it.
- */
- log_debug(LD_CONFIG, "Resolved Address to '%s'.", addr_string);
- if (explicit_ip) {
- method_used = "CONFIGURED";
- hostname_used = NULL;
- } else if (explicit_hostname) {
- method_used = "RESOLVED";
- hostname_used = hostname;
- } else if (from_interface) {
- method_used = "INTERFACE";
- hostname_used = NULL;
- } else {
- method_used = "GETHOSTNAME";
- hostname_used = hostname;
- }
- *addr_out = addr;
- if (method_out)
- *method_out = method_used;
- if (hostname_out)
- *hostname_out = hostname_used ? tor_strdup(hostname_used) : NULL;
- /*
- * Step five: Check if the answer has changed since last time (or if
- * there was no last time), and if so call various functions to keep
- * us up-to-date.
- */
- if (last_resolved_addr && last_resolved_addr != *addr_out) {
- /* Leave this as a notice, regardless of the requested severity,
- * at least until dynamic IP address support becomes bulletproof. */
- log_notice(LD_NET,
- "Your IP address seems to have changed to %s "
- "(METHOD=%s%s%s). Updating.",
- addr_string, method_used,
- hostname_used ? " HOSTNAME=" : "",
- hostname_used ? hostname_used : "");
- ip_address_changed(0);
- }
- if (last_resolved_addr != *addr_out) {
- control_event_server_status(LOG_NOTICE,
- "EXTERNAL_ADDRESS ADDRESS=%s METHOD=%s%s%s",
- addr_string, method_used,
- hostname_used ? " HOSTNAME=" : "",
- hostname_used ? hostname_used : "");
- }
- last_resolved_addr = *addr_out;
- /*
- * And finally, clean up and return success.
- */
- tor_free(addr_string);
- return 0;
- }
- /** Return true iff <b>addr</b> is judged to be on the same network as us, or
- * on a private network.
- */
- MOCK_IMPL(int,
- is_local_addr, (const tor_addr_t *addr))
- {
- if (tor_addr_is_internal(addr, 0))
- return 1;
- /* Check whether ip is on the same /24 as we are. */
- if (get_options()->EnforceDistinctSubnets == 0)
- return 0;
- if (tor_addr_family(addr) == AF_INET) {
- uint32_t ip = tor_addr_to_ipv4h(addr);
- /* It's possible that this next check will hit before the first time
- * resolve_my_address actually succeeds. (For clients, it is likely that
- * resolve_my_address will never be called at all). In those cases,
- * last_resolved_addr will be 0, and so checking to see whether ip is on
- * the same /24 as last_resolved_addr will be the same as checking whether
- * it was on net 0, which is already done by tor_addr_is_internal.
- */
- if ((last_resolved_addr & (uint32_t)0xffffff00ul)
- == (ip & (uint32_t)0xffffff00ul))
- return 1;
- }
- return 0;
- }
- /** Return a new empty or_options_t. Used for testing. */
- or_options_t *
- options_new(void)
- {
- return config_new(&options_format);
- }
- /** Set <b>options</b> to hold reasonable defaults for most options.
- * Each option defaults to zero. */
- void
- options_init(or_options_t *options)
- {
- config_init(&options_format, options);
- }
- /** Return a string containing a possible configuration file that would give
- * the configuration in <b>options</b>. If <b>minimal</b> is true, do not
- * include options that are the same as Tor's defaults.
- */
- char *
- options_dump(const or_options_t *options, int how_to_dump)
- {
- const or_options_t *use_defaults;
- int minimal;
- switch (how_to_dump) {
- case OPTIONS_DUMP_MINIMAL:
- use_defaults = global_default_options;
- minimal = 1;
- break;
- case OPTIONS_DUMP_DEFAULTS:
- use_defaults = NULL;
- minimal = 1;
- break;
- case OPTIONS_DUMP_ALL:
- use_defaults = NULL;
- minimal = 0;
- break;
- default:
- log_warn(LD_BUG, "Bogus value for how_to_dump==%d", how_to_dump);
- return NULL;
- }
- return config_dump(&options_format, use_defaults, options, minimal, 0);
- }
- /** Return 0 if every element of sl is a string holding a decimal
- * representation of a port number, or if sl is NULL.
- * Otherwise set *msg and return -1. */
- static int
- validate_ports_csv(smartlist_t *sl, const char *name, char **msg)
- {
- int i;
- tor_assert(name);
- if (!sl)
- return 0;
- SMARTLIST_FOREACH(sl, const char *, cp,
- {
- i = atoi(cp);
- if (i < 1 || i > 65535) {
- tor_asprintf(msg, "Port '%s' out of range in %s", cp, name);
- return -1;
- }
- });
- return 0;
- }
- /** If <b>value</b> exceeds ROUTER_MAX_DECLARED_BANDWIDTH, write
- * a complaint into *<b>msg</b> using string <b>desc</b>, and return -1.
- * Else return 0.
- */
- static int
- ensure_bandwidth_cap(uint64_t *value, const char *desc, char **msg)
- {
- if (*value > ROUTER_MAX_DECLARED_BANDWIDTH) {
- /* This handles an understandable special case where somebody says "2gb"
- * whereas our actual maximum is 2gb-1 (INT_MAX) */
- --*value;
- }
- if (*value > ROUTER_MAX_DECLARED_BANDWIDTH) {
- tor_asprintf(msg, "%s ("U64_FORMAT") must be at most %d",
- desc, U64_PRINTF_ARG(*value),
- ROUTER_MAX_DECLARED_BANDWIDTH);
- return -1;
- }
- return 0;
- }
- /** Parse an authority type from <b>options</b>-\>PublishServerDescriptor
- * and write it to <b>options</b>-\>PublishServerDescriptor_. Treat "1"
- * as "v3" unless BridgeRelay is 1, in which case treat it as "bridge".
- * Treat "0" as "".
- * Return 0 on success or -1 if not a recognized authority type (in which
- * case the value of PublishServerDescriptor_ is undefined). */
- static int
- compute_publishserverdescriptor(or_options_t *options)
- {
- smartlist_t *list = options->PublishServerDescriptor;
- dirinfo_type_t *auth = &options->PublishServerDescriptor_;
- *auth = NO_DIRINFO;
- if (!list) /* empty list, answer is none */
- return 0;
- SMARTLIST_FOREACH_BEGIN(list, const char *, string) {
- if (!strcasecmp(string, "v1"))
- log_warn(LD_CONFIG, "PublishServerDescriptor v1 has no effect, because "
- "there are no v1 directory authorities anymore.");
- else if (!strcmp(string, "1"))
- if (options->BridgeRelay)
- *auth |= BRIDGE_DIRINFO;
- else
- *auth |= V3_DIRINFO;
- else if (!strcasecmp(string, "v2"))
- log_warn(LD_CONFIG, "PublishServerDescriptor v2 has no effect, because "
- "there are no v2 directory authorities anymore.");
- else if (!strcasecmp(string, "v3"))
- *auth |= V3_DIRINFO;
- else if (!strcasecmp(string, "bridge"))
- *auth |= BRIDGE_DIRINFO;
- else if (!strcasecmp(string, "hidserv"))
- log_warn(LD_CONFIG,
- "PublishServerDescriptor hidserv is invalid. See "
- "PublishHidServDescriptors.");
- else if (!strcasecmp(string, "") || !strcmp(string, "0"))
- /* no authority */;
- else
- return -1;
- } SMARTLIST_FOREACH_END(string);
- return 0;
- }
- /** Lowest allowable value for RendPostPeriod; if this is too low, hidden
- * services can overload the directory system. */
- #define MIN_REND_POST_PERIOD (10*60)
- #define MIN_REND_POST_PERIOD_TESTING (5)
- /** Highest allowable value for PredictedPortsRelevanceTime; if this is
- * too high, our selection of exits will decrease for an extended
- * period of time to an uncomfortable level .*/
- #define MAX_PREDICTED_CIRCS_RELEVANCE (60*60)
- /** Highest allowable value for RendPostPeriod. */
- #define MAX_DIR_PERIOD ((7*24*60*60)/2)
- /** Lowest allowable value for MaxCircuitDirtiness; if this is too low, Tor
- * will generate too many circuits and potentially overload the network. */
- #define MIN_MAX_CIRCUIT_DIRTINESS 10
- /** Highest allowable value for MaxCircuitDirtiness: prevents time_t
- * overflows. */
- #define MAX_MAX_CIRCUIT_DIRTINESS (30*24*60*60)
- /** Lowest allowable value for CircuitStreamTimeout; if this is too low, Tor
- * will generate too many circuits and potentially overload the network. */
- #define MIN_CIRCUIT_STREAM_TIMEOUT 10
- /** Lowest allowable value for HeartbeatPeriod; if this is too low, we might
- * expose more information than we're comfortable with. */
- #define MIN_HEARTBEAT_PERIOD (30*60)
- /** Lowest recommended value for CircuitBuildTimeout; if it is set too low
- * and LearnCircuitBuildTimeout is off, the failure rate for circuit
- * construction may be very high. In that case, if it is set below this
- * threshold emit a warning.
- * */
- #define RECOMMENDED_MIN_CIRCUIT_BUILD_TIMEOUT (10)
- static int
- options_validate_cb(void *old_options, void *options, void *default_options,
- int from_setconf, char **msg)
- {
- return options_validate(old_options, options, default_options,
- from_setconf, msg);
- }
- #define REJECT(arg) \
- STMT_BEGIN *msg = tor_strdup(arg); return -1; STMT_END
- #if defined(__GNUC__) && __GNUC__ <= 3
- #define COMPLAIN(args...) \
- STMT_BEGIN log_warn(LD_CONFIG, args); STMT_END
- #else
- #define COMPLAIN(args, ...) \
- STMT_BEGIN log_warn(LD_CONFIG, args, ##__VA_ARGS__); STMT_END
- #endif
- /** Log a warning message iff <b>filepath</b> is not absolute.
- * Warning message must contain option name <b>option</b> and
- * an absolute path that <b>filepath</b> will resolve to.
- *
- * In case <b>filepath</b> is absolute, do nothing.
- */
- static void
- warn_if_option_path_is_relative(const char *option,
- char *filepath)
- {
- if (filepath && path_is_relative(filepath)) {
- char *abs_path = make_path_absolute(filepath);
- COMPLAIN("Path for %s (%s) is relative and will resolve to %s."
- " Is this what you wanted?", option, filepath, abs_path);
- tor_free(abs_path);
- }
- }
- /** Scan <b>options</b> for occurances of relative file/directory
- * path and log a warning whenever it is found.
- */
- static void
- warn_about_relative_paths(or_options_t *options)
- {
- tor_assert(options);
- warn_if_option_path_is_relative("CookieAuthFile",
- options->CookieAuthFile);
- warn_if_option_path_is_relative("ExtORPortCookieAuthFile",
- options->ExtORPortCookieAuthFile);
- warn_if_option_path_is_relative("DirPortFrontPage",
- options->DirPortFrontPage);
- warn_if_option_path_is_relative("V3BandwidthsFile",
- options->V3BandwidthsFile);
- warn_if_option_path_is_relative("ControlPortWriteToFile",
- options->ControlPortWriteToFile);
- warn_if_option_path_is_relative("GeoIPFile",options->GeoIPFile);
- warn_if_option_path_is_relative("GeoIPv6File",options->GeoIPv6File);
- warn_if_option_path_is_relative("Log",options->DebugLogFile);
- warn_if_option_path_is_relative("AccelDir",options->AccelDir);
- warn_if_option_path_is_relative("DataDirectory",options->DataDirectory);
- warn_if_option_path_is_relative("PidFile",options->PidFile);
- for (config_line_t *hs_line = options->RendConfigLines; hs_line;
- hs_line = hs_line->next) {
- if (!strcasecmp(hs_line->key, "HiddenServiceDir"))
- warn_if_option_path_is_relative("HiddenServiceDir",hs_line->value);
- }
- }
- /* Validate options related to single onion services.
- * Modifies some options that are incompatible with single onion services.
- * On failure returns -1, and sets *msg to an error string.
- * Returns 0 on success. */
- STATIC int
- options_validate_single_onion(or_options_t *options, char **msg)
- {
- /* The two single onion service options must have matching values. */
- if (options->HiddenServiceSingleHopMode &&
- !options->HiddenServiceNonAnonymousMode) {
- REJECT("HiddenServiceSingleHopMode does not provide any server anonymity. "
- "It must be used with HiddenServiceNonAnonymousMode set to 1.");
- }
- if (options->HiddenServiceNonAnonymousMode &&
- !options->HiddenServiceSingleHopMode) {
- REJECT("HiddenServiceNonAnonymousMode does not provide any server "
- "anonymity. It must be used with HiddenServiceSingleHopMode set to "
- "1.");
- }
- /* Now that we've checked that the two options are consistent, we can safely
- * call the rend_service_* functions that abstract these options. */
- /* If you run an anonymous client with an active Single Onion service, the
- * client loses anonymity. */
- const int client_port_set = (options->SocksPort_set ||
- options->TransPort_set ||
- options->NATDPort_set ||
- options->DNSPort_set);
- if (rend_service_non_anonymous_mode_enabled(options) && client_port_set &&
- !options->Tor2webMode) {
- REJECT("HiddenServiceNonAnonymousMode is incompatible with using Tor as "
- "an anonymous client. Please set Socks/Trans/NATD/DNSPort to 0, or "
- "revert HiddenServiceNonAnonymousMode to 0.");
- }
- /* If you run a hidden service in non-anonymous mode, the hidden service
- * loses anonymity, even if SOCKSPort / Tor2web mode isn't used. */
- if (!rend_service_non_anonymous_mode_enabled(options) &&
- options->RendConfigLines && options->Tor2webMode) {
- REJECT("Non-anonymous (Tor2web) mode is incompatible with using Tor as a "
- "hidden service. Please remove all HiddenServiceDir lines, or use "
- "a version of tor compiled without --enable-tor2web-mode, or use "
- "HiddenServiceNonAnonymousMode.");
- }
- if (rend_service_allow_non_anonymous_connection(options)
- && options->UseEntryGuards) {
- /* Single Onion services only use entry guards when uploading descriptors;
- * all other connections are one-hop. Further, Single Onions causes the
- * hidden service code to do things which break the path bias
- * detector, and it's far easier to turn off entry guards (and
- * thus the path bias detector with it) than to figure out how to
- * make path bias compatible with single onions.
- */
- log_notice(LD_CONFIG,
- "HiddenServiceSingleHopMode is enabled; disabling "
- "UseEntryGuards.");
- options->UseEntryGuards = 0;
- }
- return 0;
- }
- /** Return 0 if every setting in <b>options</b> is reasonable, is a
- * permissible transition from <b>old_options</b>, and none of the
- * testing-only settings differ from <b>default_options</b> unless in
- * testing mode. Else return -1. Should have no side effects, except for
- * normalizing the contents of <b>options</b>.
- *
- * On error, tor_strdup an error explanation into *<b>msg</b>.
- *
- * XXX
- * If <b>from_setconf</b>, we were called by the controller, and our
- * Log line should stay empty. If it's 0, then give us a default log
- * if there are no logs defined.
- */
- STATIC int
- options_validate(or_options_t *old_options, or_options_t *options,
- or_options_t *default_options, int from_setconf, char **msg)
- {
- int i;
- config_line_t *cl;
- const char *uname = get_uname();
- int n_ports=0;
- int world_writable_control_socket=0;
- tor_assert(msg);
- *msg = NULL;
- /* Set UseEntryGuards from the configured value, before we check it below.
- * We change UseEntryGuards when it's incompatible with other options,
- * but leave UseEntryGuards_option with the original value.
- * Always use the value of UseEntryGuards, not UseEntryGuards_option. */
- options->UseEntryGuards = options->UseEntryGuards_option;
- warn_about_relative_paths(options);
- if (server_mode(options) &&
- (!strcmpstart(uname, "Windows 95") ||
- !strcmpstart(uname, "Windows 98") ||
- !strcmpstart(uname, "Windows Me"))) {
- log_warn(LD_CONFIG, "Tor is running as a server, but you are "
- "running %s; this probably won't work. See "
- "https://www.torproject.org/docs/faq.html#BestOSForRelay "
- "for details.", uname);
- }
- if (parse_ports(options, 1, msg, &n_ports,
- &world_writable_control_socket) < 0)
- return -1;
- if (parse_outbound_addresses(options, 1, msg) < 0)
- return -1;
- if (validate_data_directory(options)<0)
- REJECT("Invalid DataDirectory");
- if (options->Nickname == NULL) {
- if (server_mode(options)) {
- options->Nickname = tor_strdup(UNNAMED_ROUTER_NICKNAME);
- }
- } else {
- if (!is_legal_nickname(options->Nickname)) {
- tor_asprintf(msg,
- "Nickname '%s', nicknames must be between 1 and 19 characters "
- "inclusive, and must contain only the characters [a-zA-Z0-9].",
- options->Nickname);
- return -1;
- }
- }
- if (server_mode(options) && !options->ContactInfo)
- log_notice(LD_CONFIG, "Your ContactInfo config option is not set. "
- "Please consider setting it, so we can contact you if your server is "
- "misconfigured or something else goes wrong.");
- /* Special case on first boot if no Log options are given. */
- if (!options->Logs && !options->RunAsDaemon && !from_setconf) {
- if (quiet_level == 0)
- config_line_append(&options->Logs, "Log", "notice stdout");
- else if (quiet_level == 1)
- config_line_append(&options->Logs, "Log", "warn stdout");
- }
- /* Validate the tor_log(s) */
- if (options_init_logs(old_options, options, 1)<0)
- REJECT("Failed to validate Log options. See logs for details.");
- if (authdir_mode(options)) {
- /* confirm that our address isn't broken, so we can complain now */
- uint32_t tmp;
- if (resolve_my_address(LOG_WARN, options, &tmp, NULL, NULL) < 0)
- REJECT("Failed to resolve/guess local address. See logs for details.");
- }
- if (server_mode(options) && options->RendConfigLines)
- log_warn(LD_CONFIG,
- "Tor is currently configured as a relay and a hidden service. "
- "That's not very secure: you should probably run your hidden service "
- "in a separate Tor process, at least -- see "
- "https://trac.torproject.org/8742");
- /* XXXX require that the only port not be DirPort? */
- /* XXXX require that at least one port be listened-upon. */
- if (n_ports == 0 && !options->RendConfigLines)
- log_warn(LD_CONFIG,
- "SocksPort, TransPort, NATDPort, DNSPort, and ORPort are all "
- "undefined, and there aren't any hidden services configured. "
- "Tor will still run, but probably won't do anything.");
- options->TransProxyType_parsed = TPT_DEFAULT;
- #ifdef USE_TRANSPARENT
- if (options->TransProxyType) {
- if (!strcasecmp(options->TransProxyType, "default")) {
- options->TransProxyType_parsed = TPT_DEFAULT;
- } else if (!strcasecmp(options->TransProxyType, "pf-divert")) {
- #if !defined(OpenBSD) && !defined( DARWIN )
- /* Later versions of OS X have pf */
- REJECT("pf-divert is a OpenBSD-specific "
- "and OS X/Darwin-specific feature.");
- #else
- options->TransProxyType_parsed = TPT_PF_DIVERT;
- #endif
- } else if (!strcasecmp(options->TransProxyType, "tproxy")) {
- #if !defined(__linux__)
- REJECT("TPROXY is a Linux-specific feature.");
- #else
- options->TransProxyType_parsed = TPT_TPROXY;
- #endif
- } else if (!strcasecmp(options->TransProxyType, "ipfw")) {
- #ifndef KERNEL_MAY_SUPPORT_IPFW
- /* Earlier versions of OS X have ipfw */
- REJECT("ipfw is a FreeBSD-specific "
- "and OS X/Darwin-specific feature.");
- #else
- options->TransProxyType_parsed = TPT_IPFW;
- #endif
- } else {
- REJECT("Unrecognized value for TransProxyType");
- }
- if (strcasecmp(options->TransProxyType, "default") &&
- !options->TransPort_set) {
- REJECT("Cannot use TransProxyType without any valid TransPort.");
- }
- }
- #else
- if (options->TransPort_set)
- REJECT("TransPort is disabled in this build.");
- #endif
- if (options->TokenBucketRefillInterval <= 0
- || options->TokenBucketRefillInterval > 1000) {
- REJECT("TokenBucketRefillInterval must be between 1 and 1000 inclusive.");
- }
- if (options->ExcludeExitNodes || options->ExcludeNodes) {
- options->ExcludeExitNodesUnion_ = routerset_new();
- routerset_union(options->ExcludeExitNodesUnion_,options->ExcludeExitNodes);
- routerset_union(options->ExcludeExitNodesUnion_,options->ExcludeNodes);
- }
- if (options->SchedulerLowWaterMark__ == 0 ||
- options->SchedulerLowWaterMark__ > UINT32_MAX) {
- log_warn(LD_GENERAL, "Bad SchedulerLowWaterMark__ option");
- return -1;
- } else if (options->SchedulerHighWaterMark__ <=
- options->SchedulerLowWaterMark__ ||
- options->SchedulerHighWaterMark__ > UINT32_MAX) {
- log_warn(LD_GENERAL, "Bad SchedulerHighWaterMark option");
- return -1;
- }
- if (options->NodeFamilies) {
- options->NodeFamilySets = smartlist_new();
- for (cl = options->NodeFamilies; cl; cl = cl->next) {
- routerset_t *rs = routerset_new();
- if (routerset_parse(rs, cl->value, cl->key) == 0) {
- smartlist_add(options->NodeFamilySets, rs);
- } else {
- routerset_free(rs);
- }
- }
- }
- if (options->ExcludeNodes && options->StrictNodes) {
- COMPLAIN("You have asked to exclude certain relays from all positions "
- "in your circuits. Expect hidden services and other Tor "
- "features to be broken in unpredictable ways.");
- }
- for (cl = options->RecommendedPackages; cl; cl = cl->next) {
- if (! validate_recommended_package_line(cl->value)) {
- log_warn(LD_CONFIG, "Invalid RecommendedPackage line %s will be ignored",
- escaped(cl->value));
- }
- }
- if (options->AuthoritativeDir) {
- if (!options->ContactInfo && !options->TestingTorNetwork)
- REJECT("Authoritative directory servers must set ContactInfo");
- if (!options->RecommendedClientVersions)
- options->RecommendedClientVersions =
- config_lines_dup(options->RecommendedVersions);
- if (!options->RecommendedServerVersions)
- options->RecommendedServerVersions =
- config_lines_dup(options->RecommendedVersions);
- if (options->VersioningAuthoritativeDir &&
- (!options->RecommendedClientVersions ||
- !options->RecommendedServerVersions))
- REJECT("Versioning authoritative dir servers must set "
- "Recommended*Versions.");
- if (options->UseEntryGuards) {
- log_info(LD_CONFIG, "Authoritative directory servers can't set "
- "UseEntryGuards. Disabling.");
- options->UseEntryGuards = 0;
- }
- if (!options->DownloadExtraInfo && authdir_mode_any_main(options)) {
- log_info(LD_CONFIG, "Authoritative directories always try to download "
- "extra-info documents. Setting DownloadExtraInfo.");
- options->DownloadExtraInfo = 1;
- }
- if (!(options->BridgeAuthoritativeDir ||
- options->V3AuthoritativeDir))
- REJECT("AuthoritativeDir is set, but none of "
- "(Bridge/V3)AuthoritativeDir is set.");
- /* If we have a v3bandwidthsfile and it's broken, complain on startup */
- if (options->V3BandwidthsFile && !old_options) {
- dirserv_read_measured_bandwidths(options->V3BandwidthsFile, NULL);
- }
- /* same for guardfraction file */
- if (options->GuardfractionFile && !old_options) {
- dirserv_read_guardfraction_file(options->GuardfractionFile, NULL);
- }
- }
- if (options->AuthoritativeDir && !options->DirPort_set)
- REJECT("Running as authoritative directory, but no DirPort set.");
- if (options->AuthoritativeDir && !options->ORPort_set)
- REJECT("Running as authoritative directory, but no ORPort set.");
- if (options->AuthoritativeDir && options->ClientOnly)
- REJECT("Running as authoritative directory, but ClientOnly also set.");
- if (options->FetchDirInfoExtraEarly && !options->FetchDirInfoEarly)
- REJECT("FetchDirInfoExtraEarly requires that you also set "
- "FetchDirInfoEarly");
- if (options->ConnLimit <= 0) {
- tor_asprintf(msg,
- "ConnLimit must be greater than 0, but was set to %d",
- options->ConnLimit);
- return -1;
- }
- if (options->PathsNeededToBuildCircuits >= 0.0) {
- if (options->PathsNeededToBuildCircuits < 0.25) {
- log_warn(LD_CONFIG, "PathsNeededToBuildCircuits is too low. Increasing "
- "to 0.25");
- options->PathsNeededToBuildCircuits = 0.25;
- } else if (options->PathsNeededToBuildCircuits > 0.95) {
- log_warn(LD_CONFIG, "PathsNeededToBuildCircuits is too high. Decreasing "
- "to 0.95");
- options->PathsNeededToBuildCircuits = 0.95;
- }
- }
- if (options->MaxClientCircuitsPending <= 0 ||
- options->MaxClientCircuitsPending > MAX_MAX_CLIENT_CIRCUITS_PENDING) {
- tor_asprintf(msg,
- "MaxClientCircuitsPending must be between 1 and %d, but "
- "was set to %d", MAX_MAX_CLIENT_CIRCUITS_PENDING,
- options->MaxClientCircuitsPending);
- return -1;
- }
- if (validate_ports_csv(options->FirewallPorts, "FirewallPorts", msg) < 0)
- return -1;
- if (validate_ports_csv(options->LongLivedPorts, "LongLivedPorts", msg) < 0)
- return -1;
- if (validate_ports_csv(options->RejectPlaintextPorts,
- "RejectPlaintextPorts", msg) < 0)
- return -1;
- if (validate_ports_csv(options->WarnPlaintextPorts,
- "WarnPlaintextPorts", msg) < 0)
- return -1;
- if (options->FascistFirewall && !options->ReachableAddresses) {
- if (options->FirewallPorts && smartlist_len(options->FirewallPorts)) {
- /* We already have firewall ports set, so migrate them to
- * ReachableAddresses, which will set ReachableORAddresses and
- * ReachableDirAddresses if they aren't set explicitly. */
- smartlist_t *instead = smartlist_new();
- config_line_t *new_line = tor_malloc_zero(sizeof(config_line_t));
- new_line->key = tor_strdup("ReachableAddresses");
- /* If we're configured with the old format, we need to prepend some
- * open ports. */
- SMARTLIST_FOREACH(options->FirewallPorts, const char *, portno,
- {
- int p = atoi(portno);
- if (p<0) continue;
- smartlist_add_asprintf(instead, "*:%d", p);
- });
- new_line->value = smartlist_join_strings(instead,",",0,NULL);
- /* These have been deprecated since 0.1.1.5-alpha-cvs */
- log_notice(LD_CONFIG,
- "Converting FascistFirewall and FirewallPorts "
- "config options to new format: \"ReachableAddresses %s\"",
- new_line->value);
- options->ReachableAddresses = new_line;
- SMARTLIST_FOREACH(instead, char *, cp, tor_free(cp));
- smartlist_free(instead);
- } else {
- /* We do not have FirewallPorts set, so add 80 to
- * ReachableDirAddresses, and 443 to ReachableORAddresses. */
- if (!options->ReachableDirAddresses) {
- config_line_t *new_line = tor_malloc_zero(sizeof(config_line_t));
- new_line->key = tor_strdup("ReachableDirAddresses");
- new_line->value = tor_strdup("*:80");
- options->ReachableDirAddresses = new_line;
- log_notice(LD_CONFIG, "Converting FascistFirewall config option "
- "to new format: \"ReachableDirAddresses *:80\"");
- }
- if (!options->ReachableORAddresses) {
- config_line_t *new_line = tor_malloc_zero(sizeof(config_line_t));
- new_line->key = tor_strdup("ReachableORAddresses");
- new_line->value = tor_strdup("*:443");
- options->ReachableORAddresses = new_line;
- log_notice(LD_CONFIG, "Converting FascistFirewall config option "
- "to new format: \"ReachableORAddresses *:443\"");
- }
- }
- }
- /* Terminate Reachable*Addresses with reject *
- */
- for (i=0; i<3; i++) {
- config_line_t **linep =
- (i==0) ? &options->ReachableAddresses :
- (i==1) ? &options->ReachableORAddresses :
- &options->ReachableDirAddresses;
- if (!*linep)
- continue;
- /* We need to end with a reject *:*, not an implicit accept *:* */
- for (;;) {
- linep = &((*linep)->next);
- if (!*linep) {
- *linep = tor_malloc_zero(sizeof(config_line_t));
- (*linep)->key = tor_strdup(
- (i==0) ? "ReachableAddresses" :
- (i==1) ? "ReachableORAddresses" :
- "ReachableDirAddresses");
- (*linep)->value = tor_strdup("reject *:*");
- break;
- }
- }
- }
- if ((options->ReachableAddresses ||
- options->ReachableORAddresses ||
- options->ReachableDirAddresses ||
- options->ClientUseIPv4 == 0) &&
- server_mode(options))
- REJECT("Servers must be able to freely connect to the rest "
- "of the Internet, so they must not set Reachable*Addresses "
- "or FascistFirewall or FirewallPorts or ClientUseIPv4 0.");
- if (options->UseBridges &&
- server_mode(options))
- REJECT("Servers must be able to freely connect to the rest "
- "of the Internet, so they must not set UseBridges.");
- /* If both of these are set, we'll end up with funny behavior where we
- * demand enough entrynodes be up and running else we won't build
- * circuits, yet we never actually use them. */
- if (options->UseBridges && options->EntryNodes)
- REJECT("You cannot set both UseBridges and EntryNodes.");
- /* If we have UseBridges as 1 and UseEntryGuards as 0, we end up bypassing
- * the use of bridges */
- if (options->UseBridges && !options->UseEntryGuards)
- REJECT("Setting UseBridges requires also setting UseEntryGuards.");
- options->MaxMemInQueues =
- compute_real_max_mem_in_queues(options->MaxMemInQueues_raw,
- server_mode(options));
- options->MaxMemInQueues_low_threshold = (options->MaxMemInQueues / 4) * 3;
- if (!options->SafeLogging ||
- !strcasecmp(options->SafeLogging, "0")) {
- options->SafeLogging_ = SAFELOG_SCRUB_NONE;
- } else if (!strcasecmp(options->SafeLogging, "relay")) {
- options->SafeLogging_ = SAFELOG_SCRUB_RELAY;
- } else if (!strcasecmp(options->SafeLogging, "1")) {
- options->SafeLogging_ = SAFELOG_SCRUB_ALL;
- } else {
- tor_asprintf(msg,
- "Unrecognized value '%s' in SafeLogging",
- escaped(options->SafeLogging));
- return -1;
- }
- if (compute_publishserverdescriptor(options) < 0) {
- tor_asprintf(msg, "Unrecognized value in PublishServerDescriptor");
- return -1;
- }
- if ((options->BridgeRelay
- || options->PublishServerDescriptor_ & BRIDGE_DIRINFO)
- && (options->PublishServerDescriptor_ & V3_DIRINFO)) {
- REJECT("Bridges are not supposed to publish router descriptors to the "
- "directory authorities. Please correct your "
- "PublishServerDescriptor line.");
- }
- if (options->BridgeRelay && options->DirPort_set) {
- log_warn(LD_CONFIG, "Can't set a DirPort on a bridge relay; disabling "
- "DirPort");
- config_free_lines(options->DirPort_lines);
- options->DirPort_lines = NULL;
- options->DirPort_set = 0;
- }
- if (options->MinUptimeHidServDirectoryV2 < 0) {
- log_warn(LD_CONFIG, "MinUptimeHidServDirectoryV2 option must be at "
- "least 0 seconds. Changing to 0.");
- options->MinUptimeHidServDirectoryV2 = 0;
- }
- const int min_rendpostperiod =
- options->TestingTorNetwork ?
- MIN_REND_POST_PERIOD_TESTING : MIN_REND_POST_PERIOD;
- if (options->RendPostPeriod < min_rendpostperiod) {
- log_warn(LD_CONFIG, "RendPostPeriod option is too short; "
- "raising to %d seconds.", min_rendpostperiod);
- options->RendPostPeriod = min_rendpostperiod;;
- }
- if (options->RendPostPeriod > MAX_DIR_PERIOD) {
- log_warn(LD_CONFIG, "RendPostPeriod is too large; clipping to %ds.",
- MAX_DIR_PERIOD);
- options->RendPostPeriod = MAX_DIR_PERIOD;
- }
- if (options->PredictedPortsRelevanceTime >
- MAX_PREDICTED_CIRCS_RELEVANCE) {
- log_warn(LD_CONFIG, "PredictedPortsRelevanceTime is too large; "
- "clipping to %ds.", MAX_PREDICTED_CIRCS_RELEVANCE);
- options->PredictedPortsRelevanceTime = MAX_PREDICTED_CIRCS_RELEVANCE;
- }
- /* Check the Single Onion Service options */
- if (options_validate_single_onion(options, msg) < 0)
- return -1;
- #ifdef ENABLE_TOR2WEB_MODE
- if (options->Tor2webMode && options->UseEntryGuards) {
- /* tor2web mode clients do not (and should not) use entry guards
- * in any meaningful way. Further, tor2web mode causes the hidden
- * service client code to do things which break the path bias
- * detector, and it's far easier to turn off entry guards (and
- * thus the path bias detector with it) than to figure out how to
- * make a piece of code which cannot possibly help tor2web mode
- * users compatible with tor2web mode.
- */
- log_notice(LD_CONFIG,
- "Tor2WebMode is enabled; disabling UseEntryGuards.");
- options->UseEntryGuards = 0;
- }
- #endif
- if (options->Tor2webRendezvousPoints && !options->Tor2webMode) {
- REJECT("Tor2webRendezvousPoints cannot be set without Tor2webMode.");
- }
- if (options->EntryNodes && !options->UseEntryGuards) {
- REJECT("If EntryNodes is set, UseEntryGuards must be enabled.");
- }
- if (!(options->UseEntryGuards) &&
- (options->RendConfigLines != NULL) &&
- !rend_service_allow_non_anonymous_connection(options)) {
- log_warn(LD_CONFIG,
- "UseEntryGuards is disabled, but you have configured one or more "
- "hidden services on this Tor instance. Your hidden services "
- "will be very easy to locate using a well-known attack -- see "
- "http://freehaven.net/anonbib/#hs-attack06 for details.");
- }
- if (options->EntryNodes &&
- routerset_is_list(options->EntryNodes) &&
- (routerset_len(options->EntryNodes) == 1) &&
- (options->RendConfigLines != NULL)) {
- tor_asprintf(msg,
- "You have one single EntryNodes and at least one hidden service "
- "configured. This is bad because it's very easy to locate your "
- "entry guard which can then lead to the deanonymization of your "
- "hidden service -- for more details, see "
- "https://trac.torproject.org/projects/tor/ticket/14917. "
- "For this reason, the use of one EntryNodes with an hidden "
- "service is prohibited until a better solution is found.");
- return -1;
- }
- /* Inform the hidden service operator that pinning EntryNodes can possibly
- * be harmful for the service anonymity. */
- if (options->EntryNodes &&
- routerset_is_list(options->EntryNodes) &&
- (options->RendConfigLines != NULL)) {
- log_warn(LD_CONFIG,
- "EntryNodes is set with multiple entries and at least one "
- "hidden service is configured. Pinning entry nodes can possibly "
- "be harmful to the service anonymity. Because of this, we "
- "recommend you either don't do that or make sure you know what "
- "you are doing. For more details, please look at "
- "https://trac.torproject.org/projects/tor/ticket/21155.");
- }
- /* Single Onion Services: non-anonymous hidden services */
- if (rend_service_non_anonymous_mode_enabled(options)) {
- log_warn(LD_CONFIG,
- "HiddenServiceNonAnonymousMode is set. Every hidden service on "
- "this tor instance is NON-ANONYMOUS. If "
- "the HiddenServiceNonAnonymousMode option is changed, Tor will "
- "refuse to launch hidden services from the same directories, to "
- "protect your anonymity against config errors. This setting is "
- "for experimental use only.");
- }
- if (!options->LearnCircuitBuildTimeout && options->CircuitBuildTimeout &&
- options->CircuitBuildTimeout < RECOMMENDED_MIN_CIRCUIT_BUILD_TIMEOUT) {
- log_warn(LD_CONFIG,
- "CircuitBuildTimeout is shorter (%d seconds) than the recommended "
- "minimum (%d seconds), and LearnCircuitBuildTimeout is disabled. "
- "If tor isn't working, raise this value or enable "
- "LearnCircuitBuildTimeout.",
- options->CircuitBuildTimeout,
- RECOMMENDED_MIN_CIRCUIT_BUILD_TIMEOUT );
- } else if (!options->LearnCircuitBuildTimeout &&
- !options->CircuitBuildTimeout) {
- int severity = LOG_NOTICE;
- /* Be a little quieter if we've deliberately disabled
- * LearnCircuitBuildTimeout. */
- if (circuit_build_times_disabled(options)) {
- severity = LOG_INFO;
- }
- log_fn(severity, LD_CONFIG, "You disabled LearnCircuitBuildTimeout, but "
- "didn't specify a CircuitBuildTimeout. I'll pick a plausible "
- "default.");
- }
- if (options->PathBiasNoticeRate > 1.0) {
- tor_asprintf(msg,
- "PathBiasNoticeRate is too high. "
- "It must be between 0 and 1.0");
- return -1;
- }
- if (options->PathBiasWarnRate > 1.0) {
- tor_asprintf(msg,
- "PathBiasWarnRate is too high. "
- "It must be between 0 and 1.0");
- return -1;
- }
- if (options->PathBiasExtremeRate > 1.0) {
- tor_asprintf(msg,
- "PathBiasExtremeRate is too high. "
- "It must be between 0 and 1.0");
- return -1;
- }
- if (options->PathBiasNoticeUseRate > 1.0) {
- tor_asprintf(msg,
- "PathBiasNoticeUseRate is too high. "
- "It must be between 0 and 1.0");
- return -1;
- }
- if (options->PathBiasExtremeUseRate > 1.0) {
- tor_asprintf(msg,
- "PathBiasExtremeUseRate is too high. "
- "It must be between 0 and 1.0");
- return -1;
- }
- if (options->MaxCircuitDirtiness < MIN_MAX_CIRCUIT_DIRTINESS) {
- log_warn(LD_CONFIG, "MaxCircuitDirtiness option is too short; "
- "raising to %d seconds.", MIN_MAX_CIRCUIT_DIRTINESS);
- options->MaxCircuitDirtiness = MIN_MAX_CIRCUIT_DIRTINESS;
- }
- if (options->MaxCircuitDirtiness > MAX_MAX_CIRCUIT_DIRTINESS) {
- log_warn(LD_CONFIG, "MaxCircuitDirtiness option is too high; "
- "setting to %d days.", MAX_MAX_CIRCUIT_DIRTINESS/86400);
- options->MaxCircuitDirtiness = MAX_MAX_CIRCUIT_DIRTINESS;
- }
- if (options->CircuitStreamTimeout &&
- options->CircuitStreamTimeout < MIN_CIRCUIT_STREAM_TIMEOUT) {
- log_warn(LD_CONFIG, "CircuitStreamTimeout option is too short; "
- "raising to %d seconds.", MIN_CIRCUIT_STREAM_TIMEOUT);
- options->CircuitStreamTimeout = MIN_CIRCUIT_STREAM_TIMEOUT;
- }
- if (options->HeartbeatPeriod &&
- options->HeartbeatPeriod < MIN_HEARTBEAT_PERIOD) {
- log_warn(LD_CONFIG, "HeartbeatPeriod option is too short; "
- "raising to %d seconds.", MIN_HEARTBEAT_PERIOD);
- options->HeartbeatPeriod = MIN_HEARTBEAT_PERIOD;
- }
- if (options->KeepalivePeriod < 1)
- REJECT("KeepalivePeriod option must be positive.");
- if (options->PortForwarding && options->Sandbox) {
- REJECT("PortForwarding is not compatible with Sandbox; at most one can "
- "be set");
- }
- if (ensure_bandwidth_cap(&options->BandwidthRate,
- "BandwidthRate", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->BandwidthBurst,
- "BandwidthBurst", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->MaxAdvertisedBandwidth,
- "MaxAdvertisedBandwidth", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->RelayBandwidthRate,
- "RelayBandwidthRate", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->RelayBandwidthBurst,
- "RelayBandwidthBurst", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->PerConnBWRate,
- "PerConnBWRate", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->PerConnBWBurst,
- "PerConnBWBurst", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->AuthDirFastGuarantee,
- "AuthDirFastGuarantee", msg) < 0)
- return -1;
- if (ensure_bandwidth_cap(&options->AuthDirGuardBWGuarantee,
- "AuthDirGuardBWGuarantee", msg) < 0)
- return -1;
- if (options->RelayBandwidthRate && !options->RelayBandwidthBurst)
- options->RelayBandwidthBurst = options->RelayBandwidthRate;
- if (options->RelayBandwidthBurst && !options->RelayBandwidthRate)
- options->RelayBandwidthRate = options->RelayBandwidthBurst;
- if (server_mode(options)) {
- const unsigned required_min_bw =
- public_server_mode(options) ?
- RELAY_REQUIRED_MIN_BANDWIDTH : BRIDGE_REQUIRED_MIN_BANDWIDTH;
- const char * const optbridge =
- public_server_mode(options) ? "" : "bridge ";
- if (options->BandwidthRate < required_min_bw) {
- tor_asprintf(msg,
- "BandwidthRate is set to %d bytes/second. "
- "For %sservers, it must be at least %u.",
- (int)options->BandwidthRate, optbridge,
- required_min_bw);
- return -1;
- } else if (options->MaxAdvertisedBandwidth <
- required_min_bw/2) {
- tor_asprintf(msg,
- "MaxAdvertisedBandwidth is set to %d bytes/second. "
- "For %sservers, it must be at least %u.",
- (int)options->MaxAdvertisedBandwidth, optbridge,
- required_min_bw/2);
- return -1;
- }
- if (options->RelayBandwidthRate &&
- options->RelayBandwidthRate < required_min_bw) {
- tor_asprintf(msg,
- "RelayBandwidthRate is set to %d bytes/second. "
- "For %sservers, it must be at least %u.",
- (int)options->RelayBandwidthRate, optbridge,
- required_min_bw);
- return -1;
- }
- }
- if (options->RelayBandwidthRate > options->RelayBandwidthBurst)
- REJECT("RelayBandwidthBurst must be at least equal "
- "to RelayBandwidthRate.");
- if (options->BandwidthRate > options->BandwidthBurst)
- REJECT("BandwidthBurst must be at least equal to BandwidthRate.");
- /* if they set relaybandwidth* really high but left bandwidth*
- * at the default, raise the defaults. */
- if (options->RelayBandwidthRate > options->BandwidthRate)
- options->BandwidthRate = options->RelayBandwidthRate;
- if (options->RelayBandwidthBurst > options->BandwidthBurst)
- options->BandwidthBurst = options->RelayBandwidthBurst;
- if (accounting_parse_options(options, 1)<0)
- REJECT("Failed to parse accounting options. See logs for details.");
- if (options->AccountingMax) {
- if (options->RendConfigLines && server_mode(options)) {
- log_warn(LD_CONFIG, "Using accounting with a hidden service and an "
- "ORPort is risky: your hidden service(s) and your public "
- "address will all turn off at the same time, which may alert "
- "observers that they are being run by the same party.");
- } else if (config_count_key(options->RendConfigLines,
- "HiddenServiceDir") > 1) {
- log_warn(LD_CONFIG, "Using accounting with multiple hidden services is "
- "risky: they will all turn off at the same time, which may "
- "alert observers that they are being run by the same party.");
- }
- }
- options->AccountingRule = ACCT_MAX;
- if (options->AccountingRule_option) {
- if (!strcmp(options->AccountingRule_option, "sum"))
- options->AccountingRule = ACCT_SUM;
- else if (!strcmp(options->AccountingRule_option, "max"))
- options->AccountingRule = ACCT_MAX;
- else if (!strcmp(options->AccountingRule_option, "in"))
- options->AccountingRule = ACCT_IN;
- else if (!strcmp(options->AccountingRule_option, "out"))
- options->AccountingRule = ACCT_OUT;
- else
- REJECT("AccountingRule must be 'sum', 'max', 'in', or 'out'");
- }
- if (options->DirPort_set && !options->DirCache) {
- REJECT("DirPort configured but DirCache disabled. DirPort requires "
- "DirCache.");
- }
- if (options->BridgeRelay && !options->DirCache) {
- REJECT("We're a bridge but DirCache is disabled. BridgeRelay requires "
- "DirCache.");
- }
- if (server_mode(options)) {
- char *dircache_msg = NULL;
- if (have_enough_mem_for_dircache(options, 0, &dircache_msg)) {
- log_warn(LD_CONFIG, "%s", dircache_msg);
- tor_free(dircache_msg);
- }
- }
- if (options->HTTPProxy) { /* parse it now */
- if (tor_addr_port_lookup(options->HTTPProxy,
- &options->HTTPProxyAddr, &options->HTTPProxyPort) < 0)
- REJECT("HTTPProxy failed to parse or resolve. Please fix.");
- if (options->HTTPProxyPort == 0) { /* give it a default */
- options->HTTPProxyPort = 80;
- }
- }
- if (options->HTTPProxyAuthenticator) {
- if (strlen(options->HTTPProxyAuthenticator) >= 512)
- REJECT("HTTPProxyAuthenticator is too long (>= 512 chars).");
- }
- if (options->HTTPSProxy) { /* parse it now */
- if (tor_addr_port_lookup(options->HTTPSProxy,
- &options->HTTPSProxyAddr, &options->HTTPSProxyPort) <0)
- REJECT("HTTPSProxy failed to parse or resolve. Please fix.");
- if (options->HTTPSProxyPort == 0) { /* give it a default */
- options->HTTPSProxyPort = 443;
- }
- }
- if (options->HTTPSProxyAuthenticator) {
- if (strlen(options->HTTPSProxyAuthenticator) >= 512)
- REJECT("HTTPSProxyAuthenticator is too long (>= 512 chars).");
- }
- if (options->Socks4Proxy) { /* parse it now */
- if (tor_addr_port_lookup(options->Socks4Proxy,
- &options->Socks4ProxyAddr,
- &options->Socks4ProxyPort) <0)
- REJECT("Socks4Proxy failed to parse or resolve. Please fix.");
- if (options->Socks4ProxyPort == 0) { /* give it a default */
- options->Socks4ProxyPort = 1080;
- }
- }
- if (options->Socks5Proxy) { /* parse it now */
- if (tor_addr_port_lookup(options->Socks5Proxy,
- &options->Socks5ProxyAddr,
- &options->Socks5ProxyPort) <0)
- REJECT("Socks5Proxy failed to parse or resolve. Please fix.");
- if (options->Socks5ProxyPort == 0) { /* give it a default */
- options->Socks5ProxyPort = 1080;
- }
- }
- /* Check if more than one exclusive proxy type has been enabled. */
- if (!!options->Socks4Proxy + !!options->Socks5Proxy +
- !!options->HTTPSProxy > 1)
- REJECT("You have configured more than one proxy type. "
- "(Socks4Proxy|Socks5Proxy|HTTPSProxy)");
- /* Check if the proxies will give surprising behavior. */
- if (options->HTTPProxy && !(options->Socks4Proxy ||
- options->Socks5Proxy ||
- options->HTTPSProxy)) {
- log_warn(LD_CONFIG, "HTTPProxy configured, but no SOCKS proxy or "
- "HTTPS proxy configured. Watch out: this configuration will "
- "proxy unencrypted directory connections only.");
- }
- if (options->Socks5ProxyUsername) {
- size_t len;
- len = strlen(options->Socks5ProxyUsername);
- if (len < 1 || len > MAX_SOCKS5_AUTH_FIELD_SIZE)
- REJECT("Socks5ProxyUsername must be between 1 and 255 characters.");
- if (!options->Socks5ProxyPassword)
- REJECT("Socks5ProxyPassword must be included with Socks5ProxyUsername.");
- len = strlen(options->Socks5ProxyPassword);
- if (len < 1 || len > MAX_SOCKS5_AUTH_FIELD_SIZE)
- REJECT("Socks5ProxyPassword must be between 1 and 255 characters.");
- } else if (options->Socks5ProxyPassword)
- REJECT("Socks5ProxyPassword must be included with Socks5ProxyUsername.");
- if (options->HashedControlPassword) {
- smartlist_t *sl = decode_hashed_passwords(options->HashedControlPassword);
- if (!sl) {
- REJECT("Bad HashedControlPassword: wrong length or bad encoding");
- } else {
- SMARTLIST_FOREACH(sl, char*, cp, tor_free(cp));
- smartlist_free(sl);
- }
- }
- if (options->HashedControlSessionPassword) {
- smartlist_t *sl = decode_hashed_passwords(
- options->HashedControlSessionPassword);
- if (!sl) {
- REJECT("Bad HashedControlSessionPassword: wrong length or bad encoding");
- } else {
- SMARTLIST_FOREACH(sl, char*, cp, tor_free(cp));
- smartlist_free(sl);
- }
- }
- if (options->OwningControllerProcess) {
- const char *validate_pspec_msg = NULL;
- if (tor_validate_process_specifier(options->OwningControllerProcess,
- &validate_pspec_msg)) {
- tor_asprintf(msg, "Bad OwningControllerProcess: %s",
- validate_pspec_msg);
- return -1;
- }
- }
- if ((options->ControlPort_set || world_writable_control_socket) &&
- !options->HashedControlPassword &&
- !options->HashedControlSessionPassword &&
- !options->CookieAuthentication) {
- log_warn(LD_CONFIG, "Control%s is %s, but no authentication method "
- "has been configured. This means that any program on your "
- "computer can reconfigure your Tor. That's bad! You should "
- "upgrade your Tor controller as soon as possible.",
- options->ControlPort_set ? "Port" : "Socket",
- options->ControlPort_set ? "open" : "world writable");
- }
- if (options->CookieAuthFileGroupReadable && !options->CookieAuthFile) {
- log_warn(LD_CONFIG, "CookieAuthFileGroupReadable is set, but will have "
- "no effect: you must specify an explicit CookieAuthFile to "
- "have it group-readable.");
- }
- if (options->MyFamily && options->BridgeRelay) {
- log_warn(LD_CONFIG, "Listing a family for a bridge relay is not "
- "supported: it can reveal bridge fingerprints to censors. "
- "You should also make sure you aren't listing this bridge's "
- "fingerprint in any other MyFamily.");
- }
- if (check_nickname_list(&options->MyFamily, "MyFamily", msg))
- return -1;
- for (cl = options->NodeFamilies; cl; cl = cl->next) {
- routerset_t *rs = routerset_new();
- if (routerset_parse(rs, cl->value, cl->key)) {
- routerset_free(rs);
- return -1;
- }
- routerset_free(rs);
- }
- if (validate_addr_policies(options, msg) < 0)
- return -1;
- /* If FallbackDir is set, we don't UseDefaultFallbackDirs */
- if (options->UseDefaultFallbackDirs && options->FallbackDir) {
- log_info(LD_CONFIG, "You have set UseDefaultFallbackDirs 1 and "
- "FallbackDir(s). Ignoring UseDefaultFallbackDirs, and "
- "using the FallbackDir(s) you have set.");
- }
- if (validate_dir_servers(options, old_options) < 0)
- REJECT("Directory authority/fallback line did not parse. See logs "
- "for details.");
- if (options->UseBridges && !options->Bridges)
- REJECT("If you set UseBridges, you must specify at least one bridge.");
- for (cl = options->Bridges; cl; cl = cl->next) {
- bridge_line_t *bridge_line = parse_bridge_line(cl->value);
- if (!bridge_line)
- REJECT("Bridge line did not parse. See logs for details.");
- bridge_line_free(bridge_line);
- }
- for (cl = options->ClientTransportPlugin; cl; cl = cl->next) {
- if (parse_transport_line(options, cl->value, 1, 0) < 0)
- REJECT("Invalid client transport line. See logs for details.");
- }
- for (cl = options->ServerTransportPlugin; cl; cl = cl->next) {
- if (parse_transport_line(options, cl->value, 1, 1) < 0)
- REJECT("Invalid server transport line. See logs for details.");
- }
- if (options->ServerTransportPlugin && !server_mode(options)) {
- log_notice(LD_GENERAL, "Tor is not configured as a relay but you specified"
- " a ServerTransportPlugin line (%s). The ServerTransportPlugin "
- "line will be ignored.",
- escaped(options->ServerTransportPlugin->value));
- }
- for (cl = options->ServerTransportListenAddr; cl; cl = cl->next) {
- /** If get_bindaddr_from_transport_listen_line() fails with
- 'transport' being NULL, it means that something went wrong
- while parsing the ServerTransportListenAddr line. */
- char *bindaddr = get_bindaddr_from_transport_listen_line(cl->value, NULL);
- if (!bindaddr)
- REJECT("ServerTransportListenAddr did not parse. See logs for details.");
- tor_free(bindaddr);
- }
- if (options->ServerTransportListenAddr && !options->ServerTransportPlugin) {
- log_notice(LD_GENERAL, "You need at least a single managed-proxy to "
- "specify a transport listen address. The "
- "ServerTransportListenAddr line will be ignored.");
- }
- for (cl = options->ServerTransportOptions; cl; cl = cl->next) {
- /** If get_options_from_transport_options_line() fails with
- 'transport' being NULL, it means that something went wrong
- while parsing the ServerTransportOptions line. */
- smartlist_t *options_sl =
- get_options_from_transport_options_line(cl->value, NULL);
- if (!options_sl)
- REJECT("ServerTransportOptions did not parse. See logs for details.");
- SMARTLIST_FOREACH(options_sl, char *, cp, tor_free(cp));
- smartlist_free(options_sl);
- }
- if (options->ConstrainedSockets) {
- /* If the user wants to constrain socket buffer use, make sure the desired
- * limit is between MIN|MAX_TCPSOCK_BUFFER in k increments. */
- if (options->ConstrainedSockSize < MIN_CONSTRAINED_TCP_BUFFER ||
- options->ConstrainedSockSize > MAX_CONSTRAINED_TCP_BUFFER ||
- options->ConstrainedSockSize % 1024) {
- tor_asprintf(msg,
- "ConstrainedSockSize is invalid. Must be a value between %d and %d "
- "in 1024 byte increments.",
- MIN_CONSTRAINED_TCP_BUFFER, MAX_CONSTRAINED_TCP_BUFFER);
- return -1;
- }
- if (options->DirPort_set) {
- /* Providing cached directory entries while system TCP buffers are scarce
- * will exacerbate the socket errors. Suggest that this be disabled. */
- COMPLAIN("You have requested constrained socket buffers while also "
- "serving directory entries via DirPort. It is strongly "
- "suggested that you disable serving directory requests when "
- "system TCP buffer resources are scarce.");
- }
- }
- if (options->V3AuthVoteDelay + options->V3AuthDistDelay >=
- options->V3AuthVotingInterval/2) {
- /*
- This doesn't work, but it seems like it should:
- what code is preventing the interval being less than twice the lead-up?
- if (options->TestingTorNetwork) {
- if (options->V3AuthVoteDelay + options->V3AuthDistDelay >=
- options->V3AuthVotingInterval) {
- REJECT("V3AuthVoteDelay plus V3AuthDistDelay must be less than "
- "V3AuthVotingInterval");
- } else {
- COMPLAIN("V3AuthVoteDelay plus V3AuthDistDelay is more than half "
- "V3AuthVotingInterval. This may lead to "
- "consensus instability, particularly if clocks drift.");
- }
- } else {
- */
- REJECT("V3AuthVoteDelay plus V3AuthDistDelay must be less than half "
- "V3AuthVotingInterval");
- /*
- }
- */
- }
- if (options->V3AuthVoteDelay < MIN_VOTE_SECONDS) {
- if (options->TestingTorNetwork) {
- if (options->V3AuthVoteDelay < MIN_VOTE_SECONDS_TESTING) {
- REJECT("V3AuthVoteDelay is way too low.");
- } else {
- COMPLAIN("V3AuthVoteDelay is very low. "
- "This may lead to failure to vote for a consensus.");
- }
- } else {
- REJECT("V3AuthVoteDelay is way too low.");
- }
- }
- if (options->V3AuthDistDelay < MIN_DIST_SECONDS) {
- if (options->TestingTorNetwork) {
- if (options->V3AuthDistDelay < MIN_DIST_SECONDS_TESTING) {
- REJECT("V3AuthDistDelay is way too low.");
- } else {
- COMPLAIN("V3AuthDistDelay is very low. "
- "This may lead to missing votes in a consensus.");
- }
- } else {
- REJECT("V3AuthDistDelay is way too low.");
- }
- }
- if (options->V3AuthNIntervalsValid < 2)
- REJECT("V3AuthNIntervalsValid must be at least 2.");
- if (options->V3AuthVotingInterval < MIN_VOTE_INTERVAL) {
- if (options->TestingTorNetwork) {
- if (options->V3AuthVotingInterval < MIN_VOTE_INTERVAL_TESTING) {
- REJECT("V3AuthVotingInterval is insanely low.");
- } else {
- COMPLAIN("V3AuthVotingInterval is very low. "
- "This may lead to failure to synchronise for a consensus.");
- }
- } else {
- REJECT("V3AuthVotingInterval is insanely low.");
- }
- } else if (options->V3AuthVotingInterval > 24*60*60) {
- REJECT("V3AuthVotingInterval is insanely high.");
- } else if (((24*60*60) % options->V3AuthVotingInterval) != 0) {
- COMPLAIN("V3AuthVotingInterval does not divide evenly into 24 hours.");
- }
- if (rend_config_services(options, 1) < 0)
- REJECT("Failed to configure rendezvous options. See logs for details.");
- /* Parse client-side authorization for hidden services. */
- if (rend_parse_service_authorization(options, 1) < 0)
- REJECT("Failed to configure client authorization for hidden services. "
- "See logs for details.");
- if (parse_virtual_addr_network(options->VirtualAddrNetworkIPv4,
- AF_INET, 1, msg)<0)
- return -1;
- if (parse_virtual_addr_network(options->VirtualAddrNetworkIPv6,
- AF_INET6, 1, msg)<0)
- return -1;
- if (options->TestingTorNetwork &&
- !(options->DirAuthorities ||
- (options->AlternateDirAuthority &&
- options->AlternateBridgeAuthority))) {
- REJECT("TestingTorNetwork may only be configured in combination with "
- "a non-default set of DirAuthority or both of "
- "AlternateDirAuthority and AlternateBridgeAuthority configured.");
- }
- #define CHECK_DEFAULT(arg) \
- STMT_BEGIN \
- if (!options->TestingTorNetwork && \
- !options->UsingTestNetworkDefaults_ && \
- !config_is_same(&options_format,options, \
- default_options,#arg)) { \
- REJECT(#arg " may only be changed in testing Tor " \
- "networks!"); \
- } STMT_END
- CHECK_DEFAULT(TestingV3AuthInitialVotingInterval);
- CHECK_DEFAULT(TestingV3AuthInitialVoteDelay);
- CHECK_DEFAULT(TestingV3AuthInitialDistDelay);
- CHECK_DEFAULT(TestingV3AuthVotingStartOffset);
- CHECK_DEFAULT(TestingAuthDirTimeToLearnReachability);
- CHECK_DEFAULT(TestingEstimatedDescriptorPropagationTime);
- CHECK_DEFAULT(TestingServerDownloadSchedule);
- CHECK_DEFAULT(TestingClientDownloadSchedule);
- CHECK_DEFAULT(TestingServerConsensusDownloadSchedule);
- CHECK_DEFAULT(TestingClientConsensusDownloadSchedule);
- CHECK_DEFAULT(TestingBridgeDownloadSchedule);
- CHECK_DEFAULT(TestingClientMaxIntervalWithoutRequest);
- CHECK_DEFAULT(TestingDirConnectionMaxStall);
- CHECK_DEFAULT(TestingConsensusMaxDownloadTries);
- CHECK_DEFAULT(TestingDescriptorMaxDownloadTries);
- CHECK_DEFAULT(TestingMicrodescMaxDownloadTries);
- CHECK_DEFAULT(TestingCertMaxDownloadTries);
- CHECK_DEFAULT(TestingAuthKeyLifetime);
- CHECK_DEFAULT(TestingLinkCertLifetime);
- CHECK_DEFAULT(TestingSigningKeySlop);
- CHECK_DEFAULT(TestingAuthKeySlop);
- CHECK_DEFAULT(TestingLinkKeySlop);
- #undef CHECK_DEFAULT
- if (options->SigningKeyLifetime < options->TestingSigningKeySlop*2)
- REJECT("SigningKeyLifetime is too short.");
- if (options->TestingLinkCertLifetime < options->TestingAuthKeySlop*2)
- REJECT("LinkCertLifetime is too short.");
- if (options->TestingAuthKeyLifetime < options->TestingLinkKeySlop*2)
- REJECT("TestingAuthKeyLifetime is too short.");
- if (options->TestingV3AuthInitialVotingInterval
- < MIN_VOTE_INTERVAL_TESTING_INITIAL) {
- REJECT("TestingV3AuthInitialVotingInterval is insanely low.");
- } else if (((30*60) % options->TestingV3AuthInitialVotingInterval) != 0) {
- REJECT("TestingV3AuthInitialVotingInterval does not divide evenly into "
- "30 minutes.");
- }
- if (options->TestingV3AuthInitialVoteDelay < MIN_VOTE_SECONDS_TESTING) {
- REJECT("TestingV3AuthInitialVoteDelay is way too low.");
- }
- if (options->TestingV3AuthInitialDistDelay < MIN_DIST_SECONDS_TESTING) {
- REJECT("TestingV3AuthInitialDistDelay is way too low.");
- }
- if (options->TestingV3AuthInitialVoteDelay +
- options->TestingV3AuthInitialDistDelay >=
- options->TestingV3AuthInitialVotingInterval) {
- REJECT("TestingV3AuthInitialVoteDelay plus TestingV3AuthInitialDistDelay "
- "must be less than TestingV3AuthInitialVotingInterval");
- }
- if (options->TestingV3AuthVotingStartOffset >
- MIN(options->TestingV3AuthInitialVotingInterval,
- options->V3AuthVotingInterval)) {
- REJECT("TestingV3AuthVotingStartOffset is higher than the voting "
- "interval.");
- } else if (options->TestingV3AuthVotingStartOffset < 0) {
- REJECT("TestingV3AuthVotingStartOffset must be non-negative.");
- }
- if (options->TestingAuthDirTimeToLearnReachability < 0) {
- REJECT("TestingAuthDirTimeToLearnReachability must be non-negative.");
- } else if (options->TestingAuthDirTimeToLearnReachability > 2*60*60) {
- COMPLAIN("TestingAuthDirTimeToLearnReachability is insanely high.");
- }
- if (options->TestingEstimatedDescriptorPropagationTime < 0) {
- REJECT("TestingEstimatedDescriptorPropagationTime must be non-negative.");
- } else if (options->TestingEstimatedDescriptorPropagationTime > 60*60) {
- COMPLAIN("TestingEstimatedDescriptorPropagationTime is insanely high.");
- }
- if (options->TestingClientMaxIntervalWithoutRequest < 1) {
- REJECT("TestingClientMaxIntervalWithoutRequest is way too low.");
- } else if (options->TestingClientMaxIntervalWithoutRequest > 3600) {
- COMPLAIN("TestingClientMaxIntervalWithoutRequest is insanely high.");
- }
- if (options->TestingDirConnectionMaxStall < 5) {
- REJECT("TestingDirConnectionMaxStall is way too low.");
- } else if (options->TestingDirConnectionMaxStall > 3600) {
- COMPLAIN("TestingDirConnectionMaxStall is insanely high.");
- }
- if (options->TestingConsensusMaxDownloadTries < 2) {
- REJECT("TestingConsensusMaxDownloadTries must be greater than 2.");
- } else if (options->TestingConsensusMaxDownloadTries > 800) {
- COMPLAIN("TestingConsensusMaxDownloadTries is insanely high.");
- }
- if (options->ClientBootstrapConsensusMaxDownloadTries < 2) {
- REJECT("ClientBootstrapConsensusMaxDownloadTries must be greater "
- "than 2."
- );
- } else if (options->ClientBootstrapConsensusMaxDownloadTries > 800) {
- COMPLAIN("ClientBootstrapConsensusMaxDownloadTries is insanely "
- "high.");
- }
- if (options->ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries
- < 2) {
- REJECT("ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries must "
- "be greater than 2."
- );
- } else if (
- options->ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries
- > 800) {
- COMPLAIN("ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries is "
- "insanely high.");
- }
- if (options->ClientBootstrapConsensusMaxInProgressTries < 1) {
- REJECT("ClientBootstrapConsensusMaxInProgressTries must be greater "
- "than 0.");
- } else if (options->ClientBootstrapConsensusMaxInProgressTries
- > 100) {
- COMPLAIN("ClientBootstrapConsensusMaxInProgressTries is insanely "
- "high.");
- }
- if (options->TestingDescriptorMaxDownloadTries < 2) {
- REJECT("TestingDescriptorMaxDownloadTries must be greater than 1.");
- } else if (options->TestingDescriptorMaxDownloadTries > 800) {
- COMPLAIN("TestingDescriptorMaxDownloadTries is insanely high.");
- }
- if (options->TestingMicrodescMaxDownloadTries < 2) {
- REJECT("TestingMicrodescMaxDownloadTries must be greater than 1.");
- } else if (options->TestingMicrodescMaxDownloadTries > 800) {
- COMPLAIN("TestingMicrodescMaxDownloadTries is insanely high.");
- }
- if (options->TestingCertMaxDownloadTries < 2) {
- REJECT("TestingCertMaxDownloadTries must be greater than 1.");
- } else if (options->TestingCertMaxDownloadTries > 800) {
- COMPLAIN("TestingCertMaxDownloadTries is insanely high.");
- }
- if (options->TestingEnableConnBwEvent &&
- !options->TestingTorNetwork && !options->UsingTestNetworkDefaults_) {
- REJECT("TestingEnableConnBwEvent may only be changed in testing "
- "Tor networks!");
- }
- if (options->TestingEnableCellStatsEvent &&
- !options->TestingTorNetwork && !options->UsingTestNetworkDefaults_) {
- REJECT("TestingEnableCellStatsEvent may only be changed in testing "
- "Tor networks!");
- }
- if (options->TestingEnableTbEmptyEvent &&
- !options->TestingTorNetwork && !options->UsingTestNetworkDefaults_) {
- REJECT("TestingEnableTbEmptyEvent may only be changed in testing "
- "Tor networks!");
- }
- if (options->TestingTorNetwork) {
- log_warn(LD_CONFIG, "TestingTorNetwork is set. This will make your node "
- "almost unusable in the public Tor network, and is "
- "therefore only advised if you are building a "
- "testing Tor network!");
- }
- if (options->AccelName && !options->HardwareAccel)
- options->HardwareAccel = 1;
- if (options->AccelDir && !options->AccelName)
- REJECT("Can't use hardware crypto accelerator dir without engine name.");
- if (options->PublishServerDescriptor)
- SMARTLIST_FOREACH(options->PublishServerDescriptor, const char *, pubdes, {
- if (!strcmp(pubdes, "1") || !strcmp(pubdes, "0"))
- if (smartlist_len(options->PublishServerDescriptor) > 1) {
- COMPLAIN("You have passed a list of multiple arguments to the "
- "PublishServerDescriptor option that includes 0 or 1. "
- "0 or 1 should only be used as the sole argument. "
- "This configuration will be rejected in a future release.");
- break;
- }
- });
- if (options->BridgeRelay == 1 && ! options->ORPort_set)
- REJECT("BridgeRelay is 1, ORPort is not set. This is an invalid "
- "combination.");
- return 0;
- }
- #undef REJECT
- #undef COMPLAIN
- /* Given the value that the user has set for MaxMemInQueues, compute the
- * actual maximum value. We clip this value if it's too low, and autodetect
- * it if it's set to 0. */
- static uint64_t
- compute_real_max_mem_in_queues(const uint64_t val, int log_guess)
- {
- uint64_t result;
- if (val == 0) {
- #define ONE_GIGABYTE (U64_LITERAL(1) << 30)
- #define ONE_MEGABYTE (U64_LITERAL(1) << 20)
- #if SIZEOF_VOID_P >= 8
- #define MAX_DEFAULT_MAXMEM (8*ONE_GIGABYTE)
- #else
- #define MAX_DEFAULT_MAXMEM (2*ONE_GIGABYTE)
- #endif
- /* The user didn't pick a memory limit. Choose a very large one
- * that is still smaller than the system memory */
- static int notice_sent = 0;
- size_t ram = 0;
- if (get_total_system_memory(&ram) < 0) {
- /* We couldn't determine our total system memory! */
- #if SIZEOF_VOID_P >= 8
- /* 64-bit system. Let's hope for 8 GB. */
- result = 8 * ONE_GIGABYTE;
- #else
- /* (presumably) 32-bit system. Let's hope for 1 GB. */
- result = ONE_GIGABYTE;
- #endif
- } else {
- /* We detected it, so let's pick 3/4 of the total RAM as our limit. */
- const uint64_t avail = (ram / 4) * 3;
- /* Make sure it's in range from 0.25 GB to 8 GB. */
- if (avail > MAX_DEFAULT_MAXMEM) {
- /* If you want to use more than this much RAM, you need to configure
- it yourself */
- result = MAX_DEFAULT_MAXMEM;
- } else if (avail < ONE_GIGABYTE / 4) {
- result = ONE_GIGABYTE / 4;
- } else {
- result = avail;
- }
- }
- if (log_guess && ! notice_sent) {
- log_notice(LD_CONFIG, "%sMaxMemInQueues is set to "U64_FORMAT" MB. "
- "You can override this by setting MaxMemInQueues by hand.",
- ram ? "Based on detected system memory, " : "",
- U64_PRINTF_ARG(result / ONE_MEGABYTE));
- notice_sent = 1;
- }
- return result;
- } else if (val < ONE_GIGABYTE / 4) {
- log_warn(LD_CONFIG, "MaxMemInQueues must be at least 256 MB for now. "
- "Ideally, have it as large as you can afford.");
- return ONE_GIGABYTE / 4;
- } else {
- /* The value was fine all along */
- return val;
- }
- }
- /* If we have less than 300 MB suggest disabling dircache */
- #define DIRCACHE_MIN_MEM_MB 300
- #define DIRCACHE_MIN_MEM_BYTES (DIRCACHE_MIN_MEM_MB*ONE_MEGABYTE)
- #define STRINGIFY(val) #val
- /** Create a warning message for emitting if we are a dircache but may not have
- * enough system memory, or if we are not a dircache but probably should be.
- * Return -1 when a message is returned in *msg*, else return 0. */
- STATIC int
- have_enough_mem_for_dircache(const or_options_t *options, size_t total_mem,
- char **msg)
- {
- *msg = NULL;
- /* XXX We should possibly be looking at MaxMemInQueues here
- * unconditionally. Or we should believe total_mem unconditionally. */
- if (total_mem == 0) {
- if (get_total_system_memory(&total_mem) < 0) {
- total_mem = options->MaxMemInQueues >= SIZE_MAX ?
- SIZE_MAX : (size_t)options->MaxMemInQueues;
- }
- }
- if (options->DirCache) {
- if (total_mem < DIRCACHE_MIN_MEM_BYTES) {
- if (options->BridgeRelay) {
- *msg = tor_strdup("Running a Bridge with less than "
- STRINGIFY(DIRCACHE_MIN_MEM_MB) " MB of memory is not "
- "recommended.");
- } else {
- *msg = tor_strdup("Being a directory cache (default) with less than "
- STRINGIFY(DIRCACHE_MIN_MEM_MB) " MB of memory is not "
- "recommended and may consume most of the available "
- "resources, consider disabling this functionality by "
- "setting the DirCache option to 0.");
- }
- }
- } else {
- if (total_mem >= DIRCACHE_MIN_MEM_BYTES) {
- *msg = tor_strdup("DirCache is disabled and we are configured as a "
- "relay. This may disqualify us from becoming a guard in the "
- "future.");
- }
- }
- return *msg == NULL ? 0 : -1;
- }
- #undef STRINGIFY
- /** Helper: return true iff s1 and s2 are both NULL, or both non-NULL
- * equal strings. */
- static int
- opt_streq(const char *s1, const char *s2)
- {
- return 0 == strcmp_opt(s1, s2);
- }
- /** Check if any of the previous options have changed but aren't allowed to. */
- static int
- options_transition_allowed(const or_options_t *old,
- const or_options_t *new_val,
- char **msg)
- {
- if (!old)
- return 0;
- if (!opt_streq(old->PidFile, new_val->PidFile)) {
- *msg = tor_strdup("PidFile is not allowed to change.");
- return -1;
- }
- if (old->RunAsDaemon != new_val->RunAsDaemon) {
- *msg = tor_strdup("While Tor is running, changing RunAsDaemon "
- "is not allowed.");
- return -1;
- }
- if (old->Sandbox != new_val->Sandbox) {
- *msg = tor_strdup("While Tor is running, changing Sandbox "
- "is not allowed.");
- return -1;
- }
- if (strcmp(old->DataDirectory,new_val->DataDirectory)!=0) {
- tor_asprintf(msg,
- "While Tor is running, changing DataDirectory "
- "(\"%s\"->\"%s\") is not allowed.",
- old->DataDirectory, new_val->DataDirectory);
- return -1;
- }
- if (!opt_streq(old->User, new_val->User)) {
- *msg = tor_strdup("While Tor is running, changing User is not allowed.");
- return -1;
- }
- if (old->KeepBindCapabilities != new_val->KeepBindCapabilities) {
- *msg = tor_strdup("While Tor is running, changing KeepBindCapabilities is "
- "not allowed.");
- return -1;
- }
- if (!opt_streq(old->SyslogIdentityTag, new_val->SyslogIdentityTag)) {
- *msg = tor_strdup("While Tor is running, changing "
- "SyslogIdentityTag is not allowed.");
- return -1;
- }
- if ((old->HardwareAccel != new_val->HardwareAccel)
- || !opt_streq(old->AccelName, new_val->AccelName)
- || !opt_streq(old->AccelDir, new_val->AccelDir)) {
- *msg = tor_strdup("While Tor is running, changing OpenSSL hardware "
- "acceleration engine is not allowed.");
- return -1;
- }
- if (old->TestingTorNetwork != new_val->TestingTorNetwork) {
- *msg = tor_strdup("While Tor is running, changing TestingTorNetwork "
- "is not allowed.");
- return -1;
- }
- if (old->DisableAllSwap != new_val->DisableAllSwap) {
- *msg = tor_strdup("While Tor is running, changing DisableAllSwap "
- "is not allowed.");
- return -1;
- }
- if (old->TokenBucketRefillInterval != new_val->TokenBucketRefillInterval) {
- *msg = tor_strdup("While Tor is running, changing TokenBucketRefill"
- "Interval is not allowed");
- return -1;
- }
- if (old->HiddenServiceSingleHopMode != new_val->HiddenServiceSingleHopMode) {
- *msg = tor_strdup("While Tor is running, changing "
- "HiddenServiceSingleHopMode is not allowed.");
- return -1;
- }
- if (old->HiddenServiceNonAnonymousMode !=
- new_val->HiddenServiceNonAnonymousMode) {
- *msg = tor_strdup("While Tor is running, changing "
- "HiddenServiceNonAnonymousMode is not allowed.");
- return -1;
- }
- if (old->DisableDebuggerAttachment &&
- !new_val->DisableDebuggerAttachment) {
- *msg = tor_strdup("While Tor is running, disabling "
- "DisableDebuggerAttachment is not allowed.");
- return -1;
- }
- if (sandbox_is_active()) {
- #define SB_NOCHANGE_STR(opt) \
- do { \
- if (! opt_streq(old->opt, new_val->opt)) { \
- *msg = tor_strdup("Can't change " #opt " while Sandbox is active"); \
- return -1; \
- } \
- } while (0)
- SB_NOCHANGE_STR(Address);
- SB_NOCHANGE_STR(ServerDNSResolvConfFile);
- SB_NOCHANGE_STR(DirPortFrontPage);
- SB_NOCHANGE_STR(CookieAuthFile);
- SB_NOCHANGE_STR(ExtORPortCookieAuthFile);
- #undef SB_NOCHANGE_STR
- if (! config_lines_eq(old->Logs, new_val->Logs)) {
- *msg = tor_strdup("Can't change Logs while Sandbox is active");
- return -1;
- }
- if (old->ConnLimit != new_val->ConnLimit) {
- *msg = tor_strdup("Can't change ConnLimit while Sandbox is active");
- return -1;
- }
- if (server_mode(old) != server_mode(new_val)) {
- *msg = tor_strdup("Can't start/stop being a server while "
- "Sandbox is active");
- return -1;
- }
- }
- return 0;
- }
- /** Return 1 if any change from <b>old_options</b> to <b>new_options</b>
- * will require us to rotate the CPU and DNS workers; else return 0. */
- static int
- options_transition_affects_workers(const or_options_t *old_options,
- const or_options_t *new_options)
- {
- if (!opt_streq(old_options->DataDirectory, new_options->DataDirectory) ||
- old_options->NumCPUs != new_options->NumCPUs ||
- !config_lines_eq(old_options->ORPort_lines, new_options->ORPort_lines) ||
- old_options->ServerDNSSearchDomains !=
- new_options->ServerDNSSearchDomains ||
- old_options->SafeLogging_ != new_options->SafeLogging_ ||
- old_options->ClientOnly != new_options->ClientOnly ||
- public_server_mode(old_options) != public_server_mode(new_options) ||
- !config_lines_eq(old_options->Logs, new_options->Logs) ||
- old_options->LogMessageDomains != new_options->LogMessageDomains)
- return 1;
- /* Check whether log options match. */
- /* Nothing that changed matters. */
- return 0;
- }
- /** Return 1 if any change from <b>old_options</b> to <b>new_options</b>
- * will require us to generate a new descriptor; else return 0. */
- static int
- options_transition_affects_descriptor(const or_options_t *old_options,
- const or_options_t *new_options)
- {
- /* XXX We can be smarter here. If your DirPort isn't being
- * published and you just turned it off, no need to republish. Etc. */
- if (!opt_streq(old_options->DataDirectory, new_options->DataDirectory) ||
- !opt_streq(old_options->Nickname,new_options->Nickname) ||
- !opt_streq(old_options->Address,new_options->Address) ||
- !config_lines_eq(old_options->ExitPolicy,new_options->ExitPolicy) ||
- old_options->ExitRelay != new_options->ExitRelay ||
- old_options->ExitPolicyRejectPrivate !=
- new_options->ExitPolicyRejectPrivate ||
- old_options->ExitPolicyRejectLocalInterfaces !=
- new_options->ExitPolicyRejectLocalInterfaces ||
- old_options->IPv6Exit != new_options->IPv6Exit ||
- !config_lines_eq(old_options->ORPort_lines,
- new_options->ORPort_lines) ||
- !config_lines_eq(old_options->DirPort_lines,
- new_options->DirPort_lines) ||
- old_options->ClientOnly != new_options->ClientOnly ||
- old_options->DisableNetwork != new_options->DisableNetwork ||
- old_options->PublishServerDescriptor_ !=
- new_options->PublishServerDescriptor_ ||
- get_effective_bwrate(old_options) != get_effective_bwrate(new_options) ||
- get_effective_bwburst(old_options) !=
- get_effective_bwburst(new_options) ||
- !opt_streq(old_options->ContactInfo, new_options->ContactInfo) ||
- !opt_streq(old_options->MyFamily, new_options->MyFamily) ||
- !opt_streq(old_options->AccountingStart, new_options->AccountingStart) ||
- old_options->AccountingMax != new_options->AccountingMax ||
- old_options->AccountingRule != new_options->AccountingRule ||
- public_server_mode(old_options) != public_server_mode(new_options) ||
- old_options->DirCache != new_options->DirCache ||
- old_options->AssumeReachable != new_options->AssumeReachable)
- return 1;
- return 0;
- }
- #ifdef _WIN32
- /** Return the directory on windows where we expect to find our application
- * data. */
- static char *
- get_windows_conf_root(void)
- {
- static int is_set = 0;
- static char path[MAX_PATH*2+1];
- TCHAR tpath[MAX_PATH] = {0};
- LPITEMIDLIST idl;
- IMalloc *m;
- HRESULT result;
- if (is_set)
- return path;
- /* Find X:\documents and settings\username\application data\ .
- * We would use SHGetSpecialFolder path, but that wasn't added until IE4.
- */
- #ifdef ENABLE_LOCAL_APPDATA
- #define APPDATA_PATH CSIDL_LOCAL_APPDATA
- #else
- #define APPDATA_PATH CSIDL_APPDATA
- #endif
- if (!SUCCEEDED(SHGetSpecialFolderLocation(NULL, APPDATA_PATH, &idl))) {
- getcwd(path,MAX_PATH);
- is_set = 1;
- log_warn(LD_CONFIG,
- "I couldn't find your application data folder: are you "
- "running an ancient version of Windows 95? Defaulting to \"%s\"",
- path);
- return path;
- }
- /* Convert the path from an "ID List" (whatever that is!) to a path. */
- result = SHGetPathFromIDList(idl, tpath);
- #ifdef UNICODE
- wcstombs(path,tpath,sizeof(path));
- path[sizeof(path)-1] = '\0';
- #else
- strlcpy(path,tpath,sizeof(path));
- #endif
- /* Now we need to free the memory that the path-idl was stored in. In
- * typical Windows fashion, we can't just call 'free()' on it. */
- SHGetMalloc(&m);
- if (m) {
- m->lpVtbl->Free(m, idl);
- m->lpVtbl->Release(m);
- }
- if (!SUCCEEDED(result)) {
- return NULL;
- }
- strlcat(path,"\\tor",MAX_PATH);
- is_set = 1;
- return path;
- }
- #endif
- /** Return the default location for our torrc file (if <b>defaults_file</b> is
- * false), or for the torrc-defaults file (if <b>defaults_file</b> is true). */
- static const char *
- get_default_conf_file(int defaults_file)
- {
- #ifdef DISABLE_SYSTEM_TORRC
- (void) defaults_file;
- return NULL;
- #elif defined(_WIN32)
- if (defaults_file) {
- static char defaults_path[MAX_PATH+1];
- tor_snprintf(defaults_path, MAX_PATH, "%s\\torrc-defaults",
- get_windows_conf_root());
- return defaults_path;
- } else {
- static char path[MAX_PATH+1];
- tor_snprintf(path, MAX_PATH, "%s\\torrc",
- get_windows_conf_root());
- return path;
- }
- #else
- return defaults_file ? CONFDIR "/torrc-defaults" : CONFDIR "/torrc";
- #endif
- }
- /** Verify whether lst is a string containing valid-looking comma-separated
- * nicknames, or NULL. Will normalise <b>lst</b> to prefix '$' to any nickname
- * or fingerprint that needs it. Return 0 on success.
- * Warn and return -1 on failure.
- */
- static int
- check_nickname_list(char **lst, const char *name, char **msg)
- {
- int r = 0;
- smartlist_t *sl;
- int changes = 0;
- if (!*lst)
- return 0;
- sl = smartlist_new();
- smartlist_split_string(sl, *lst, ",",
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK|SPLIT_STRIP_SPACE, 0);
- SMARTLIST_FOREACH_BEGIN(sl, char *, s)
- {
- if (!is_legal_nickname_or_hexdigest(s)) {
- // check if first char is dollar
- if (s[0] != '$') {
- // Try again but with a dollar symbol prepended
- char *prepended;
- tor_asprintf(&prepended, "$%s", s);
- if (is_legal_nickname_or_hexdigest(prepended)) {
- // The nickname is valid when it's prepended, swap the current
- // version with a prepended one
- tor_free(s);
- SMARTLIST_REPLACE_CURRENT(sl, s, prepended);
- changes = 1;
- continue;
- }
- // Still not valid, free and fallback to error message
- tor_free(prepended);
- }
- tor_asprintf(msg, "Invalid nickname '%s' in %s line", s, name);
- r = -1;
- break;
- }
- }
- SMARTLIST_FOREACH_END(s);
- // Replace the caller's nickname list with a fixed one
- if (changes && r == 0) {
- char *newNicknames = smartlist_join_strings(sl, ", ", 0, NULL);
- tor_free(*lst);
- *lst = newNicknames;
- }
- SMARTLIST_FOREACH(sl, char *, s, tor_free(s));
- smartlist_free(sl);
- return r;
- }
- /** Learn config file name from command line arguments, or use the default.
- *
- * If <b>defaults_file</b> is true, we're looking for torrc-defaults;
- * otherwise, we're looking for the regular torrc_file.
- *
- * Set *<b>using_default_fname</b> to true if we're using the default
- * configuration file name; or false if we've set it from the command line.
- *
- * Set *<b>ignore_missing_torrc</b> to true if we should ignore the resulting
- * filename if it doesn't exist.
- */
- static char *
- find_torrc_filename(config_line_t *cmd_arg,
- int defaults_file,
- int *using_default_fname, int *ignore_missing_torrc)
- {
- char *fname=NULL;
- config_line_t *p_index;
- const char *fname_opt = defaults_file ? "--defaults-torrc" : "-f";
- const char *ignore_opt = defaults_file ? NULL : "--ignore-missing-torrc";
- if (defaults_file)
- *ignore_missing_torrc = 1;
- for (p_index = cmd_arg; p_index; p_index = p_index->next) {
- if (!strcmp(p_index->key, fname_opt)) {
- if (fname) {
- log_warn(LD_CONFIG, "Duplicate %s options on command line.",
- fname_opt);
- tor_free(fname);
- }
- fname = expand_filename(p_index->value);
- {
- char *absfname;
- absfname = make_path_absolute(fname);
- tor_free(fname);
- fname = absfname;
- }
- *using_default_fname = 0;
- } else if (ignore_opt && !strcmp(p_index->key,ignore_opt)) {
- *ignore_missing_torrc = 1;
- }
- }
- if (*using_default_fname) {
- /* didn't find one, try CONFDIR */
- const char *dflt = get_default_conf_file(defaults_file);
- file_status_t st = file_status(dflt);
- if (dflt && (st == FN_FILE || st == FN_EMPTY)) {
- fname = tor_strdup(dflt);
- } else {
- #ifndef _WIN32
- char *fn = NULL;
- if (!defaults_file) {
- fn = expand_filename("~/.torrc");
- }
- if (fn) {
- file_status_t hmst = file_status(fn);
- if (hmst == FN_FILE || hmst == FN_EMPTY || dflt == NULL) {
- fname = fn;
- } else {
- tor_free(fn);
- fname = tor_strdup(dflt);
- }
- } else {
- fname = dflt ? tor_strdup(dflt) : NULL;
- }
- #else
- fname = dflt ? tor_strdup(dflt) : NULL;
- #endif
- }
- }
- return fname;
- }
- /** Read the torrc from standard input and return it as a string.
- * Upon failure, return NULL.
- */
- static char *
- load_torrc_from_stdin(void)
- {
- size_t sz_out;
- return read_file_to_str_until_eof(STDIN_FILENO,SIZE_MAX,&sz_out);
- }
- /** Load a configuration file from disk, setting torrc_fname or
- * torrc_defaults_fname if successful.
- *
- * If <b>defaults_file</b> is true, load torrc-defaults; otherwise load torrc.
- *
- * Return the contents of the file on success, and NULL on failure.
- */
- static char *
- load_torrc_from_disk(config_line_t *cmd_arg, int defaults_file)
- {
- char *fname=NULL;
- char *cf = NULL;
- int using_default_torrc = 1;
- int ignore_missing_torrc = 0;
- char **fname_var = defaults_file ? &torrc_defaults_fname : &torrc_fname;
- if (*fname_var == NULL) {
- fname = find_torrc_filename(cmd_arg, defaults_file,
- &using_default_torrc, &ignore_missing_torrc);
- tor_free(*fname_var);
- *fname_var = fname;
- } else {
- fname = *fname_var;
- }
- log_debug(LD_CONFIG, "Opening config file \"%s\"", fname?fname:"<NULL>");
- /* Open config file */
- file_status_t st = fname ? file_status(fname) : FN_EMPTY;
- if (fname == NULL ||
- !(st == FN_FILE || st == FN_EMPTY) ||
- !(cf = read_file_to_str(fname,0,NULL))) {
- if (using_default_torrc == 1 || ignore_missing_torrc) {
- if (!defaults_file)
- log_notice(LD_CONFIG, "Configuration file \"%s\" not present, "
- "using reasonable defaults.", fname);
- tor_free(fname); /* sets fname to NULL */
- *fname_var = NULL;
- cf = tor_strdup("");
- } else {
- log_warn(LD_CONFIG,
- "Unable to open configuration file \"%s\".", fname);
- goto err;
- }
- } else {
- log_notice(LD_CONFIG, "Read configuration file \"%s\".", fname);
- }
- return cf;
- err:
- tor_free(fname);
- *fname_var = NULL;
- return NULL;
- }
- /** Read a configuration file into <b>options</b>, finding the configuration
- * file location based on the command line. After loading the file
- * call options_init_from_string() to load the config.
- * Return 0 if success, -1 if failure. */
- int
- options_init_from_torrc(int argc, char **argv)
- {
- char *cf=NULL, *cf_defaults=NULL;
- int command;
- int retval = -1;
- char *command_arg = NULL;
- char *errmsg=NULL;
- config_line_t *p_index = NULL;
- config_line_t *cmdline_only_options = NULL;
- /* Go through command-line variables */
- if (! have_parsed_cmdline) {
- /* Or we could redo the list every time we pass this place.
- * It does not really matter */
- if (config_parse_commandline(argc, argv, 0, &global_cmdline_options,
- &global_cmdline_only_options) < 0) {
- goto err;
- }
- have_parsed_cmdline = 1;
- }
- cmdline_only_options = global_cmdline_only_options;
- if (config_line_find(cmdline_only_options, "-h") ||
- config_line_find(cmdline_only_options, "--help")) {
- print_usage();
- exit(0);
- }
- if (config_line_find(cmdline_only_options, "--list-torrc-options")) {
- /* For validating whether we've documented everything. */
- list_torrc_options();
- exit(0);
- }
- if (config_line_find(cmdline_only_options, "--list-deprecated-options")) {
- /* For validating whether what we have deprecated really exists. */
- list_deprecated_options();
- exit(0);
- }
- if (config_line_find(cmdline_only_options, "--version")) {
- printf("Tor version %s.\n",get_version());
- exit(0);
- }
- if (config_line_find(cmdline_only_options, "--library-versions")) {
- printf("Tor version %s. \n", get_version());
- printf("Library versions\tCompiled\t\tRuntime\n");
- printf("Libevent\t\t%-15s\t\t%s\n",
- tor_libevent_get_header_version_str(),
- tor_libevent_get_version_str());
- printf("OpenSSL \t\t%-15s\t\t%s\n",
- crypto_openssl_get_header_version_str(),
- crypto_openssl_get_version_str());
- if (tor_compress_supports_method(ZLIB_METHOD)) {
- printf("Zlib \t\t%-15s\t\t%s\n",
- tor_compress_version_str(ZLIB_METHOD),
- tor_compress_header_version_str(ZLIB_METHOD));
- }
- if (tor_compress_supports_method(LZMA_METHOD)) {
- printf("Liblzma \t\t%-15s\t\t%s\n",
- tor_compress_version_str(LZMA_METHOD),
- tor_compress_header_version_str(LZMA_METHOD));
- }
- if (tor_compress_supports_method(ZSTD_METHOD)) {
- printf("Libzstd \t\t%-15s\t\t%s\n",
- tor_compress_version_str(ZSTD_METHOD),
- tor_compress_header_version_str(ZSTD_METHOD));
- }
- //TODO: Hex versions?
- exit(0);
- }
- command = CMD_RUN_TOR;
- for (p_index = cmdline_only_options; p_index; p_index = p_index->next) {
- if (!strcmp(p_index->key,"--keygen")) {
- command = CMD_KEYGEN;
- } else if (!strcmp(p_index->key,"--list-fingerprint")) {
- command = CMD_LIST_FINGERPRINT;
- } else if (!strcmp(p_index->key, "--hash-password")) {
- command = CMD_HASH_PASSWORD;
- command_arg = p_index->value;
- } else if (!strcmp(p_index->key, "--dump-config")) {
- command = CMD_DUMP_CONFIG;
- command_arg = p_index->value;
- } else if (!strcmp(p_index->key, "--verify-config")) {
- command = CMD_VERIFY_CONFIG;
- }
- }
- if (command == CMD_HASH_PASSWORD) {
- cf_defaults = tor_strdup("");
- cf = tor_strdup("");
- } else {
- cf_defaults = load_torrc_from_disk(cmdline_only_options, 1);
- const config_line_t *f_line = config_line_find(cmdline_only_options,
- "-f");
- const int read_torrc_from_stdin =
- (f_line != NULL && strcmp(f_line->value, "-") == 0);
- if (read_torrc_from_stdin) {
- cf = load_torrc_from_stdin();
- } else {
- cf = load_torrc_from_disk(cmdline_only_options, 0);
- }
- if (!cf) {
- if (config_line_find(cmdline_only_options, "--allow-missing-torrc")) {
- cf = tor_strdup("");
- } else {
- goto err;
- }
- }
- }
- retval = options_init_from_string(cf_defaults, cf, command, command_arg,
- &errmsg);
- if (retval < 0)
- goto err;
- if (config_line_find(cmdline_only_options, "--no-passphrase")) {
- if (command == CMD_KEYGEN) {
- get_options_mutable()->keygen_force_passphrase = FORCE_PASSPHRASE_OFF;
- } else {
- log_err(LD_CONFIG, "--no-passphrase specified without --keygen!");
- exit(1);
- }
- }
- if (config_line_find(cmdline_only_options, "--newpass")) {
- if (command == CMD_KEYGEN) {
- get_options_mutable()->change_key_passphrase = 1;
- } else {
- log_err(LD_CONFIG, "--newpass specified without --keygen!");
- exit(1);
- }
- }
- {
- const config_line_t *fd_line = config_line_find(cmdline_only_options,
- "--passphrase-fd");
- if (fd_line) {
- if (get_options()->keygen_force_passphrase == FORCE_PASSPHRASE_OFF) {
- log_err(LD_CONFIG, "--no-passphrase specified with --passphrase-fd!");
- exit(1);
- } else if (command != CMD_KEYGEN) {
- log_err(LD_CONFIG, "--passphrase-fd specified without --keygen!");
- exit(1);
- } else {
- const char *v = fd_line->value;
- int ok = 1;
- long fd = tor_parse_long(v, 10, 0, INT_MAX, &ok, NULL);
- if (fd < 0 || ok == 0) {
- log_err(LD_CONFIG, "Invalid --passphrase-fd value %s", escaped(v));
- exit(1);
- }
- get_options_mutable()->keygen_passphrase_fd = (int)fd;
- get_options_mutable()->use_keygen_passphrase_fd = 1;
- get_options_mutable()->keygen_force_passphrase = FORCE_PASSPHRASE_ON;
- }
- }
- }
- {
- const config_line_t *key_line = config_line_find(cmdline_only_options,
- "--master-key");
- if (key_line) {
- if (command != CMD_KEYGEN) {
- log_err(LD_CONFIG, "--master-key without --keygen!");
- exit(1);
- } else {
- get_options_mutable()->master_key_fname = tor_strdup(key_line->value);
- }
- }
- }
- err:
- tor_free(cf);
- tor_free(cf_defaults);
- if (errmsg) {
- log_warn(LD_CONFIG,"%s", errmsg);
- tor_free(errmsg);
- }
- return retval < 0 ? -1 : 0;
- }
- /** Load the options from the configuration in <b>cf</b>, validate
- * them for consistency and take actions based on them.
- *
- * Return 0 if success, negative on error:
- * * -1 for general errors.
- * * -2 for failure to parse/validate,
- * * -3 for transition not allowed
- * * -4 for error while setting the new options
- */
- setopt_err_t
- options_init_from_string(const char *cf_defaults, const char *cf,
- int command, const char *command_arg,
- char **msg)
- {
- or_options_t *oldoptions, *newoptions, *newdefaultoptions=NULL;
- config_line_t *cl;
- int retval;
- setopt_err_t err = SETOPT_ERR_MISC;
- tor_assert(msg);
- oldoptions = global_options; /* get_options unfortunately asserts if
- this is the first time we run*/
- newoptions = tor_malloc_zero(sizeof(or_options_t));
- newoptions->magic_ = OR_OPTIONS_MAGIC;
- options_init(newoptions);
- newoptions->command = command;
- newoptions->command_arg = command_arg ? tor_strdup(command_arg) : NULL;
- for (int i = 0; i < 2; ++i) {
- const char *body = i==0 ? cf_defaults : cf;
- if (!body)
- continue;
- /* get config lines, assign them */
- retval = config_get_lines(body, &cl, 1);
- if (retval < 0) {
- err = SETOPT_ERR_PARSE;
- goto err;
- }
- retval = config_assign(&options_format, newoptions, cl,
- CAL_WARN_DEPRECATIONS, msg);
- config_free_lines(cl);
- if (retval < 0) {
- err = SETOPT_ERR_PARSE;
- goto err;
- }
- if (i==0)
- newdefaultoptions = config_dup(&options_format, newoptions);
- }
- if (newdefaultoptions == NULL) {
- newdefaultoptions = config_dup(&options_format, global_default_options);
- }
- /* Go through command-line variables too */
- retval = config_assign(&options_format, newoptions,
- global_cmdline_options, CAL_WARN_DEPRECATIONS, msg);
- if (retval < 0) {
- err = SETOPT_ERR_PARSE;
- goto err;
- }
- /* If this is a testing network configuration, change defaults
- * for a list of dependent config options, re-initialize newoptions
- * with the new defaults, and assign all options to it second time. */
- if (newoptions->TestingTorNetwork) {
- /* XXXX this is a bit of a kludge. perhaps there's a better way to do
- * this? We could, for example, make the parsing algorithm do two passes
- * over the configuration. If it finds any "suite" options like
- * TestingTorNetwork, it could change the defaults before its second pass.
- * Not urgent so long as this seems to work, but at any sign of trouble,
- * let's clean it up. -NM */
- /* Change defaults. */
- for (int i = 0; testing_tor_network_defaults[i].name; ++i) {
- const config_var_t *new_var = &testing_tor_network_defaults[i];
- config_var_t *old_var =
- config_find_option_mutable(&options_format, new_var->name);
- tor_assert(new_var);
- tor_assert(old_var);
- old_var->initvalue = new_var->initvalue;
- if ((config_find_deprecation(&options_format, new_var->name))) {
- log_warn(LD_GENERAL, "Testing options override the deprecated "
- "option %s. Is that intentional?",
- new_var->name);
- }
- }
- /* Clear newoptions and re-initialize them with new defaults. */
- or_options_free(newoptions);
- or_options_free(newdefaultoptions);
- newdefaultoptions = NULL;
- newoptions = tor_malloc_zero(sizeof(or_options_t));
- newoptions->magic_ = OR_OPTIONS_MAGIC;
- options_init(newoptions);
- newoptions->command = command;
- newoptions->command_arg = command_arg ? tor_strdup(command_arg) : NULL;
- /* Assign all options a second time. */
- for (int i = 0; i < 2; ++i) {
- const char *body = i==0 ? cf_defaults : cf;
- if (!body)
- continue;
- /* get config lines, assign them */
- retval = config_get_lines(body, &cl, 1);
- if (retval < 0) {
- err = SETOPT_ERR_PARSE;
- goto err;
- }
- retval = config_assign(&options_format, newoptions, cl, 0, msg);
- config_free_lines(cl);
- if (retval < 0) {
- err = SETOPT_ERR_PARSE;
- goto err;
- }
- if (i==0)
- newdefaultoptions = config_dup(&options_format, newoptions);
- }
- /* Assign command-line variables a second time too */
- retval = config_assign(&options_format, newoptions,
- global_cmdline_options, 0, msg);
- if (retval < 0) {
- err = SETOPT_ERR_PARSE;
- goto err;
- }
- }
- /* Validate newoptions */
- if (options_validate(oldoptions, newoptions, newdefaultoptions,
- 0, msg) < 0) {
- err = SETOPT_ERR_PARSE; /*XXX make this a separate return value.*/
- goto err;
- }
- if (options_transition_allowed(oldoptions, newoptions, msg) < 0) {
- err = SETOPT_ERR_TRANSITION;
- goto err;
- }
- if (set_options(newoptions, msg)) {
- err = SETOPT_ERR_SETTING;
- goto err; /* frees and replaces old options */
- }
- or_options_free(global_default_options);
- global_default_options = newdefaultoptions;
- return SETOPT_OK;
- err:
- or_options_free(newoptions);
- or_options_free(newdefaultoptions);
- if (*msg) {
- char *old_msg = *msg;
- tor_asprintf(msg, "Failed to parse/validate config: %s", old_msg);
- tor_free(old_msg);
- }
- return err;
- }
- /** Return the location for our configuration file. May return NULL.
- */
- const char *
- get_torrc_fname(int defaults_fname)
- {
- const char *fname = defaults_fname ? torrc_defaults_fname : torrc_fname;
- if (fname)
- return fname;
- else
- return get_default_conf_file(defaults_fname);
- }
- /** Adjust the address map based on the MapAddress elements in the
- * configuration <b>options</b>
- */
- void
- config_register_addressmaps(const or_options_t *options)
- {
- smartlist_t *elts;
- config_line_t *opt;
- const char *from, *to, *msg;
- addressmap_clear_configured();
- elts = smartlist_new();
- for (opt = options->AddressMap; opt; opt = opt->next) {
- smartlist_split_string(elts, opt->value, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 2);
- if (smartlist_len(elts) < 2) {
- log_warn(LD_CONFIG,"MapAddress '%s' has too few arguments. Ignoring.",
- opt->value);
- goto cleanup;
- }
- from = smartlist_get(elts,0);
- to = smartlist_get(elts,1);
- if (to[0] == '.' || from[0] == '.') {
- log_warn(LD_CONFIG,"MapAddress '%s' is ambiguous - address starts with a"
- "'.'. Ignoring.",opt->value);
- goto cleanup;
- }
- if (addressmap_register_auto(from, to, 0, ADDRMAPSRC_TORRC, &msg) < 0) {
- log_warn(LD_CONFIG,"MapAddress '%s' failed: %s. Ignoring.", opt->value,
- msg);
- goto cleanup;
- }
- if (smartlist_len(elts) > 2)
- log_warn(LD_CONFIG,"Ignoring extra arguments to MapAddress.");
- cleanup:
- SMARTLIST_FOREACH(elts, char*, cp, tor_free(cp));
- smartlist_clear(elts);
- }
- smartlist_free(elts);
- }
- /** As addressmap_register(), but detect the wildcarded status of "from" and
- * "to", and do not steal a reference to <b>to</b>. */
- /* XXXX move to connection_edge.c */
- int
- addressmap_register_auto(const char *from, const char *to,
- time_t expires,
- addressmap_entry_source_t addrmap_source,
- const char **msg)
- {
- int from_wildcard = 0, to_wildcard = 0;
- *msg = "whoops, forgot the error message";
- if (!strcmp(to, "*") || !strcmp(from, "*")) {
- *msg = "can't remap from or to *";
- return -1;
- }
- /* Detect asterisks in expressions of type: '*.example.com' */
- if (!strncmp(from,"*.",2)) {
- from += 2;
- from_wildcard = 1;
- }
- if (!strncmp(to,"*.",2)) {
- to += 2;
- to_wildcard = 1;
- }
- if (to_wildcard && !from_wildcard) {
- *msg = "can only use wildcard (i.e. '*.') if 'from' address "
- "uses wildcard also";
- return -1;
- }
- if (address_is_invalid_destination(to, 1)) {
- *msg = "destination is invalid";
- return -1;
- }
- addressmap_register(from, tor_strdup(to), expires, addrmap_source,
- from_wildcard, to_wildcard);
- return 0;
- }
- /**
- * Initialize the logs based on the configuration file.
- */
- static int
- options_init_logs(const or_options_t *old_options, or_options_t *options,
- int validate_only)
- {
- config_line_t *opt;
- int ok;
- smartlist_t *elts;
- int run_as_daemon =
- #ifdef _WIN32
- 0;
- #else
- options->RunAsDaemon;
- #endif
- if (options->LogTimeGranularity <= 0) {
- log_warn(LD_CONFIG, "Log time granularity '%d' has to be positive.",
- options->LogTimeGranularity);
- return -1;
- } else if (1000 % options->LogTimeGranularity != 0 &&
- options->LogTimeGranularity % 1000 != 0) {
- int granularity = options->LogTimeGranularity;
- if (granularity < 40) {
- do granularity++;
- while (1000 % granularity != 0);
- } else if (granularity < 1000) {
- granularity = 1000 / granularity;
- while (1000 % granularity != 0)
- granularity--;
- granularity = 1000 / granularity;
- } else {
- granularity = 1000 * ((granularity / 1000) + 1);
- }
- log_warn(LD_CONFIG, "Log time granularity '%d' has to be either a "
- "divisor or a multiple of 1 second. Changing to "
- "'%d'.",
- options->LogTimeGranularity, granularity);
- if (!validate_only)
- set_log_time_granularity(granularity);
- } else {
- if (!validate_only)
- set_log_time_granularity(options->LogTimeGranularity);
- }
- ok = 1;
- elts = smartlist_new();
- for (opt = options->Logs; opt; opt = opt->next) {
- log_severity_list_t *severity;
- const char *cfg = opt->value;
- severity = tor_malloc_zero(sizeof(log_severity_list_t));
- if (parse_log_severity_config(&cfg, severity) < 0) {
- log_warn(LD_CONFIG, "Couldn't parse log levels in Log option 'Log %s'",
- opt->value);
- ok = 0; goto cleanup;
- }
- smartlist_split_string(elts, cfg, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 2);
- if (smartlist_len(elts) == 0)
- smartlist_add_strdup(elts, "stdout");
- if (smartlist_len(elts) == 1 &&
- (!strcasecmp(smartlist_get(elts,0), "stdout") ||
- !strcasecmp(smartlist_get(elts,0), "stderr"))) {
- int err = smartlist_len(elts) &&
- !strcasecmp(smartlist_get(elts,0), "stderr");
- if (!validate_only) {
- if (run_as_daemon) {
- log_warn(LD_CONFIG,
- "Can't log to %s with RunAsDaemon set; skipping stdout",
- err?"stderr":"stdout");
- } else {
- add_stream_log(severity, err?"<stderr>":"<stdout>",
- fileno(err?stderr:stdout));
- }
- }
- goto cleanup;
- }
- if (smartlist_len(elts) == 1 &&
- !strcasecmp(smartlist_get(elts,0), "syslog")) {
- #ifdef HAVE_SYSLOG_H
- if (!validate_only) {
- add_syslog_log(severity, options->SyslogIdentityTag);
- }
- #else
- log_warn(LD_CONFIG, "Syslog is not supported on this system. Sorry.");
- #endif
- goto cleanup;
- }
- if (smartlist_len(elts) == 2 &&
- !strcasecmp(smartlist_get(elts,0), "file")) {
- if (!validate_only) {
- char *fname = expand_filename(smartlist_get(elts, 1));
- /* Truncate if TruncateLogFile is set and we haven't seen this option
- line before. */
- int truncate_log = 0;
- if (options->TruncateLogFile) {
- truncate_log = 1;
- if (old_options) {
- config_line_t *opt2;
- for (opt2 = old_options->Logs; opt2; opt2 = opt2->next)
- if (!strcmp(opt->value, opt2->value)) {
- truncate_log = 0;
- break;
- }
- }
- }
- if (add_file_log(severity, fname, truncate_log) < 0) {
- log_warn(LD_CONFIG, "Couldn't open file for 'Log %s': %s",
- opt->value, strerror(errno));
- ok = 0;
- }
- tor_free(fname);
- }
- goto cleanup;
- }
- log_warn(LD_CONFIG, "Bad syntax on file Log option 'Log %s'",
- opt->value);
- ok = 0; goto cleanup;
- cleanup:
- SMARTLIST_FOREACH(elts, char*, cp, tor_free(cp));
- smartlist_clear(elts);
- tor_free(severity);
- }
- smartlist_free(elts);
- if (ok && !validate_only)
- logs_set_domain_logging(options->LogMessageDomains);
- return ok?0:-1;
- }
- /** Given a smartlist of SOCKS arguments to be passed to a transport
- * proxy in <b>args</b>, validate them and return -1 if they are
- * corrupted. Return 0 if they seem OK. */
- static int
- validate_transport_socks_arguments(const smartlist_t *args)
- {
- char *socks_string = NULL;
- size_t socks_string_len;
- tor_assert(args);
- tor_assert(smartlist_len(args) > 0);
- SMARTLIST_FOREACH_BEGIN(args, const char *, s) {
- if (!string_is_key_value(LOG_WARN, s)) { /* items should be k=v items */
- log_warn(LD_CONFIG, "'%s' is not a k=v item.", s);
- return -1;
- }
- } SMARTLIST_FOREACH_END(s);
- socks_string = pt_stringify_socks_args(args);
- if (!socks_string)
- return -1;
- socks_string_len = strlen(socks_string);
- tor_free(socks_string);
- if (socks_string_len > MAX_SOCKS5_AUTH_SIZE_TOTAL) {
- log_warn(LD_CONFIG, "SOCKS arguments can't be more than %u bytes (%lu).",
- MAX_SOCKS5_AUTH_SIZE_TOTAL,
- (unsigned long) socks_string_len);
- return -1;
- }
- return 0;
- }
- /** Deallocate a bridge_line_t structure. */
- /* private */ void
- bridge_line_free(bridge_line_t *bridge_line)
- {
- if (!bridge_line)
- return;
- if (bridge_line->socks_args) {
- SMARTLIST_FOREACH(bridge_line->socks_args, char*, s, tor_free(s));
- smartlist_free(bridge_line->socks_args);
- }
- tor_free(bridge_line->transport_name);
- tor_free(bridge_line);
- }
- /** Parse the contents of a string, <b>line</b>, containing a Bridge line,
- * into a bridge_line_t.
- *
- * Validates that the IP:PORT, fingerprint, and SOCKS arguments (given to the
- * Pluggable Transport, if a one was specified) are well-formed.
- *
- * Returns NULL If the Bridge line could not be validated, and returns a
- * bridge_line_t containing the parsed information otherwise.
- *
- * Bridge line format:
- * Bridge [transport] IP:PORT [id-fingerprint] [k=v] [k=v] ...
- */
- /* private */ bridge_line_t *
- parse_bridge_line(const char *line)
- {
- smartlist_t *items = NULL;
- char *addrport=NULL, *fingerprint=NULL;
- char *field=NULL;
- bridge_line_t *bridge_line = tor_malloc_zero(sizeof(bridge_line_t));
- items = smartlist_new();
- smartlist_split_string(items, line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, -1);
- if (smartlist_len(items) < 1) {
- log_warn(LD_CONFIG, "Too few arguments to Bridge line.");
- goto err;
- }
- /* first field is either a transport name or addrport */
- field = smartlist_get(items, 0);
- smartlist_del_keeporder(items, 0);
- if (string_is_C_identifier(field)) {
- /* It's a transport name. */
- bridge_line->transport_name = field;
- if (smartlist_len(items) < 1) {
- log_warn(LD_CONFIG, "Too few items to Bridge line.");
- goto err;
- }
- addrport = smartlist_get(items, 0); /* Next field is addrport then. */
- smartlist_del_keeporder(items, 0);
- } else {
- addrport = field;
- }
- if (tor_addr_port_parse(LOG_INFO, addrport,
- &bridge_line->addr, &bridge_line->port, 443)<0) {
- log_warn(LD_CONFIG, "Error parsing Bridge address '%s'", addrport);
- goto err;
- }
- /* If transports are enabled, next field could be a fingerprint or a
- socks argument. If transports are disabled, next field must be
- a fingerprint. */
- if (smartlist_len(items)) {
- if (bridge_line->transport_name) { /* transports enabled: */
- field = smartlist_get(items, 0);
- smartlist_del_keeporder(items, 0);
- /* If it's a key=value pair, then it's a SOCKS argument for the
- transport proxy... */
- if (string_is_key_value(LOG_DEBUG, field)) {
- bridge_line->socks_args = smartlist_new();
- smartlist_add(bridge_line->socks_args, field);
- } else { /* ...otherwise, it's the bridge fingerprint. */
- fingerprint = field;
- }
- } else { /* transports disabled: */
- fingerprint = smartlist_join_strings(items, "", 0, NULL);
- }
- }
- /* Handle fingerprint, if it was provided. */
- if (fingerprint) {
- if (strlen(fingerprint) != HEX_DIGEST_LEN) {
- log_warn(LD_CONFIG, "Key digest for Bridge is wrong length.");
- goto err;
- }
- if (base16_decode(bridge_line->digest, DIGEST_LEN,
- fingerprint, HEX_DIGEST_LEN) != DIGEST_LEN) {
- log_warn(LD_CONFIG, "Unable to decode Bridge key digest.");
- goto err;
- }
- }
- /* If we are using transports, any remaining items in the smartlist
- should be k=v values. */
- if (bridge_line->transport_name && smartlist_len(items)) {
- if (!bridge_line->socks_args)
- bridge_line->socks_args = smartlist_new();
- /* append remaining items of 'items' to 'socks_args' */
- smartlist_add_all(bridge_line->socks_args, items);
- smartlist_clear(items);
- tor_assert(smartlist_len(bridge_line->socks_args) > 0);
- }
- if (bridge_line->socks_args) {
- if (validate_transport_socks_arguments(bridge_line->socks_args) < 0)
- goto err;
- }
- goto done;
- err:
- bridge_line_free(bridge_line);
- bridge_line = NULL;
- done:
- SMARTLIST_FOREACH(items, char*, s, tor_free(s));
- smartlist_free(items);
- tor_free(addrport);
- tor_free(fingerprint);
- return bridge_line;
- }
- /** Read the contents of a ClientTransportPlugin or ServerTransportPlugin
- * line from <b>line</b>, depending on the value of <b>server</b>. Return 0
- * if the line is well-formed, and -1 if it isn't.
- *
- * If <b>validate_only</b> is 0, the line is well-formed, and the transport is
- * needed by some bridge:
- * - If it's an external proxy line, add the transport described in the line to
- * our internal transport list.
- * - If it's a managed proxy line, launch the managed proxy.
- */
- STATIC int
- parse_transport_line(const or_options_t *options,
- const char *line, int validate_only,
- int server)
- {
- smartlist_t *items = NULL;
- int r;
- const char *transports = NULL;
- smartlist_t *transport_list = NULL;
- char *type = NULL;
- char *addrport = NULL;
- tor_addr_t addr;
- uint16_t port = 0;
- int socks_ver = PROXY_NONE;
- /* managed proxy options */
- int is_managed = 0;
- char **proxy_argv = NULL;
- char **tmp = NULL;
- int proxy_argc, i;
- int is_useless_proxy = 1;
- int line_length;
- /* Split the line into space-separated tokens */
- items = smartlist_new();
- smartlist_split_string(items, line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, -1);
- line_length = smartlist_len(items);
- if (line_length < 3) {
- log_warn(LD_CONFIG,
- "Too few arguments on %sTransportPlugin line.",
- server ? "Server" : "Client");
- goto err;
- }
- /* Get the first line element, split it to commas into
- transport_list (in case it's multiple transports) and validate
- the transport names. */
- transports = smartlist_get(items, 0);
- transport_list = smartlist_new();
- smartlist_split_string(transport_list, transports, ",",
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
- SMARTLIST_FOREACH_BEGIN(transport_list, const char *, transport_name) {
- /* validate transport names */
- if (!string_is_C_identifier(transport_name)) {
- log_warn(LD_CONFIG, "Transport name is not a C identifier (%s).",
- transport_name);
- goto err;
- }
- /* see if we actually need the transports provided by this proxy */
- if (!validate_only && transport_is_needed(transport_name))
- is_useless_proxy = 0;
- } SMARTLIST_FOREACH_END(transport_name);
- type = smartlist_get(items, 1);
- if (!strcmp(type, "exec")) {
- is_managed = 1;
- } else if (server && !strcmp(type, "proxy")) {
- /* 'proxy' syntax only with ServerTransportPlugin */
- is_managed = 0;
- } else if (!server && !strcmp(type, "socks4")) {
- /* 'socks4' syntax only with ClientTransportPlugin */
- is_managed = 0;
- socks_ver = PROXY_SOCKS4;
- } else if (!server && !strcmp(type, "socks5")) {
- /* 'socks5' syntax only with ClientTransportPlugin */
- is_managed = 0;
- socks_ver = PROXY_SOCKS5;
- } else {
- log_warn(LD_CONFIG,
- "Strange %sTransportPlugin type '%s'",
- server ? "Server" : "Client", type);
- goto err;
- }
- if (is_managed && options->Sandbox) {
- log_warn(LD_CONFIG,
- "Managed proxies are not compatible with Sandbox mode."
- "(%sTransportPlugin line was %s)",
- server ? "Server" : "Client", escaped(line));
- goto err;
- }
- if (is_managed) {
- /* managed */
- if (!server && !validate_only && is_useless_proxy) {
- log_info(LD_GENERAL,
- "Pluggable transport proxy (%s) does not provide "
- "any needed transports and will not be launched.",
- line);
- }
- /*
- * If we are not just validating, use the rest of the line as the
- * argv of the proxy to be launched. Also, make sure that we are
- * only launching proxies that contribute useful transports.
- */
- if (!validate_only && (server || !is_useless_proxy)) {
- proxy_argc = line_length - 2;
- tor_assert(proxy_argc > 0);
- proxy_argv = tor_calloc((proxy_argc + 1), sizeof(char *));
- tmp = proxy_argv;
- for (i = 0; i < proxy_argc; i++) {
- /* store arguments */
- *tmp++ = smartlist_get(items, 2);
- smartlist_del_keeporder(items, 2);
- }
- *tmp = NULL; /* terminated with NULL, just like execve() likes it */
- /* kickstart the thing */
- if (server) {
- pt_kickstart_server_proxy(transport_list, proxy_argv);
- } else {
- pt_kickstart_client_proxy(transport_list, proxy_argv);
- }
- }
- } else {
- /* external */
- /* ClientTransportPlugins connecting through a proxy is managed only. */
- if (!server && (options->Socks4Proxy || options->Socks5Proxy ||
- options->HTTPSProxy)) {
- log_warn(LD_CONFIG, "You have configured an external proxy with another "
- "proxy type. (Socks4Proxy|Socks5Proxy|HTTPSProxy)");
- goto err;
- }
- if (smartlist_len(transport_list) != 1) {
- log_warn(LD_CONFIG,
- "You can't have an external proxy with more than "
- "one transport.");
- goto err;
- }
- addrport = smartlist_get(items, 2);
- if (tor_addr_port_lookup(addrport, &addr, &port) < 0) {
- log_warn(LD_CONFIG,
- "Error parsing transport address '%s'", addrport);
- goto err;
- }
- if (!port) {
- log_warn(LD_CONFIG,
- "Transport address '%s' has no port.", addrport);
- goto err;
- }
- if (!validate_only) {
- log_info(LD_DIR, "%s '%s' at %s.",
- server ? "Server transport" : "Transport",
- transports, fmt_addrport(&addr, port));
- if (!server) {
- transport_add_from_config(&addr, port,
- smartlist_get(transport_list, 0),
- socks_ver);
- }
- }
- }
- r = 0;
- goto done;
- err:
- r = -1;
- done:
- SMARTLIST_FOREACH(items, char*, s, tor_free(s));
- smartlist_free(items);
- if (transport_list) {
- SMARTLIST_FOREACH(transport_list, char*, s, tor_free(s));
- smartlist_free(transport_list);
- }
- return r;
- }
- /** Given a ServerTransportListenAddr <b>line</b>, return its
- * <address:port> string. Return NULL if the line was not
- * well-formed.
- *
- * If <b>transport</b> is set, return NULL if the line is not
- * referring to <b>transport</b>.
- *
- * The returned string is allocated on the heap and it's the
- * responsibility of the caller to free it. */
- static char *
- get_bindaddr_from_transport_listen_line(const char *line,const char *transport)
- {
- smartlist_t *items = NULL;
- const char *parsed_transport = NULL;
- char *addrport = NULL;
- tor_addr_t addr;
- uint16_t port = 0;
- items = smartlist_new();
- smartlist_split_string(items, line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, -1);
- if (smartlist_len(items) < 2) {
- log_warn(LD_CONFIG,"Too few arguments on ServerTransportListenAddr line.");
- goto err;
- }
- parsed_transport = smartlist_get(items, 0);
- addrport = tor_strdup(smartlist_get(items, 1));
- /* If 'transport' is given, check if it matches the one on the line */
- if (transport && strcmp(transport, parsed_transport))
- goto err;
- /* Validate addrport */
- if (tor_addr_port_parse(LOG_WARN, addrport, &addr, &port, -1)<0) {
- log_warn(LD_CONFIG, "Error parsing ServerTransportListenAddr "
- "address '%s'", addrport);
- goto err;
- }
- goto done;
- err:
- tor_free(addrport);
- addrport = NULL;
- done:
- SMARTLIST_FOREACH(items, char*, s, tor_free(s));
- smartlist_free(items);
- return addrport;
- }
- /** Given a ServerTransportOptions <b>line</b>, return a smartlist
- * with the options. Return NULL if the line was not well-formed.
- *
- * If <b>transport</b> is set, return NULL if the line is not
- * referring to <b>transport</b>.
- *
- * The returned smartlist and its strings are allocated on the heap
- * and it's the responsibility of the caller to free it. */
- smartlist_t *
- get_options_from_transport_options_line(const char *line,const char *transport)
- {
- smartlist_t *items = smartlist_new();
- smartlist_t *options = smartlist_new();
- const char *parsed_transport = NULL;
- smartlist_split_string(items, line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, -1);
- if (smartlist_len(items) < 2) {
- log_warn(LD_CONFIG,"Too few arguments on ServerTransportOptions line.");
- goto err;
- }
- parsed_transport = smartlist_get(items, 0);
- /* If 'transport' is given, check if it matches the one on the line */
- if (transport && strcmp(transport, parsed_transport))
- goto err;
- SMARTLIST_FOREACH_BEGIN(items, const char *, option) {
- if (option_sl_idx == 0) /* skip the transport field (first field)*/
- continue;
- /* validate that it's a k=v value */
- if (!string_is_key_value(LOG_WARN, option)) {
- log_warn(LD_CONFIG, "%s is not a k=v value.", escaped(option));
- goto err;
- }
- /* add it to the options smartlist */
- smartlist_add_strdup(options, option);
- log_debug(LD_CONFIG, "Added %s to the list of options", escaped(option));
- } SMARTLIST_FOREACH_END(option);
- goto done;
- err:
- SMARTLIST_FOREACH(options, char*, s, tor_free(s));
- smartlist_free(options);
- options = NULL;
- done:
- SMARTLIST_FOREACH(items, char*, s, tor_free(s));
- smartlist_free(items);
- return options;
- }
- /** Given the name of a pluggable transport in <b>transport</b>, check
- * the configuration file to see if the user has explicitly asked for
- * it to listen on a specific port. Return a <address:port> string if
- * so, otherwise NULL. */
- char *
- get_transport_bindaddr_from_config(const char *transport)
- {
- config_line_t *cl;
- const or_options_t *options = get_options();
- for (cl = options->ServerTransportListenAddr; cl; cl = cl->next) {
- char *bindaddr =
- get_bindaddr_from_transport_listen_line(cl->value, transport);
- if (bindaddr)
- return bindaddr;
- }
- return NULL;
- }
- /** Given the name of a pluggable transport in <b>transport</b>, check
- * the configuration file to see if the user has asked us to pass any
- * parameters to the pluggable transport. Return a smartlist
- * containing the parameters, otherwise NULL. */
- smartlist_t *
- get_options_for_server_transport(const char *transport)
- {
- config_line_t *cl;
- const or_options_t *options = get_options();
- for (cl = options->ServerTransportOptions; cl; cl = cl->next) {
- smartlist_t *options_sl =
- get_options_from_transport_options_line(cl->value, transport);
- if (options_sl)
- return options_sl;
- }
- return NULL;
- }
- /** Read the contents of a DirAuthority line from <b>line</b>. If
- * <b>validate_only</b> is 0, and the line is well-formed, and it
- * shares any bits with <b>required_type</b> or <b>required_type</b>
- * is NO_DIRINFO (zero), then add the dirserver described in the line
- * (minus whatever bits it's missing) as a valid authority.
- * Return 0 on success or filtering out by type,
- * or -1 if the line isn't well-formed or if we can't add it. */
- STATIC int
- parse_dir_authority_line(const char *line, dirinfo_type_t required_type,
- int validate_only)
- {
- smartlist_t *items = NULL;
- int r;
- char *addrport=NULL, *address=NULL, *nickname=NULL, *fingerprint=NULL;
- tor_addr_port_t ipv6_addrport, *ipv6_addrport_ptr = NULL;
- uint16_t dir_port = 0, or_port = 0;
- char digest[DIGEST_LEN];
- char v3_digest[DIGEST_LEN];
- dirinfo_type_t type = 0;
- double weight = 1.0;
- items = smartlist_new();
- smartlist_split_string(items, line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, -1);
- if (smartlist_len(items) < 1) {
- log_warn(LD_CONFIG, "No arguments on DirAuthority line.");
- goto err;
- }
- if (is_legal_nickname(smartlist_get(items, 0))) {
- nickname = smartlist_get(items, 0);
- smartlist_del_keeporder(items, 0);
- }
- while (smartlist_len(items)) {
- char *flag = smartlist_get(items, 0);
- if (TOR_ISDIGIT(flag[0]))
- break;
- if (!strcasecmp(flag, "hs") ||
- !strcasecmp(flag, "no-hs")) {
- log_warn(LD_CONFIG, "The DirAuthority options 'hs' and 'no-hs' are "
- "obsolete; you don't need them any more.");
- } else if (!strcasecmp(flag, "bridge")) {
- type |= BRIDGE_DIRINFO;
- } else if (!strcasecmp(flag, "no-v2")) {
- /* obsolete, but may still be contained in DirAuthority lines generated
- by various tools */;
- } else if (!strcasecmpstart(flag, "orport=")) {
- int ok;
- char *portstring = flag + strlen("orport=");
- or_port = (uint16_t) tor_parse_long(portstring, 10, 1, 65535, &ok, NULL);
- if (!ok)
- log_warn(LD_CONFIG, "Invalid orport '%s' on DirAuthority line.",
- portstring);
- } else if (!strcmpstart(flag, "weight=")) {
- int ok;
- const char *wstring = flag + strlen("weight=");
- weight = tor_parse_double(wstring, 0, (double)UINT64_MAX, &ok, NULL);
- if (!ok) {
- log_warn(LD_CONFIG, "Invalid weight '%s' on DirAuthority line.",flag);
- weight=1.0;
- }
- } else if (!strcasecmpstart(flag, "v3ident=")) {
- char *idstr = flag + strlen("v3ident=");
- if (strlen(idstr) != HEX_DIGEST_LEN ||
- base16_decode(v3_digest, DIGEST_LEN,
- idstr, HEX_DIGEST_LEN) != DIGEST_LEN) {
- log_warn(LD_CONFIG, "Bad v3 identity digest '%s' on DirAuthority line",
- flag);
- } else {
- type |= V3_DIRINFO|EXTRAINFO_DIRINFO|MICRODESC_DIRINFO;
- }
- } else if (!strcasecmpstart(flag, "ipv6=")) {
- if (ipv6_addrport_ptr) {
- log_warn(LD_CONFIG, "Redundant ipv6 addr/port on DirAuthority line");
- } else {
- if (tor_addr_port_parse(LOG_WARN, flag+strlen("ipv6="),
- &ipv6_addrport.addr, &ipv6_addrport.port,
- -1) < 0
- || tor_addr_family(&ipv6_addrport.addr) != AF_INET6) {
- log_warn(LD_CONFIG, "Bad ipv6 addr/port %s on DirAuthority line",
- escaped(flag));
- goto err;
- }
- ipv6_addrport_ptr = &ipv6_addrport;
- }
- } else {
- log_warn(LD_CONFIG, "Unrecognized flag '%s' on DirAuthority line",
- flag);
- }
- tor_free(flag);
- smartlist_del_keeporder(items, 0);
- }
- if (smartlist_len(items) < 2) {
- log_warn(LD_CONFIG, "Too few arguments to DirAuthority line.");
- goto err;
- }
- addrport = smartlist_get(items, 0);
- smartlist_del_keeporder(items, 0);
- if (addr_port_lookup(LOG_WARN, addrport, &address, NULL, &dir_port)<0) {
- log_warn(LD_CONFIG, "Error parsing DirAuthority address '%s'", addrport);
- goto err;
- }
- if (!dir_port) {
- log_warn(LD_CONFIG, "Missing port in DirAuthority address '%s'",addrport);
- goto err;
- }
- fingerprint = smartlist_join_strings(items, "", 0, NULL);
- if (strlen(fingerprint) != HEX_DIGEST_LEN) {
- log_warn(LD_CONFIG, "Key digest '%s' for DirAuthority is wrong length %d.",
- fingerprint, (int)strlen(fingerprint));
- goto err;
- }
- if (base16_decode(digest, DIGEST_LEN,
- fingerprint, HEX_DIGEST_LEN) != DIGEST_LEN) {
- log_warn(LD_CONFIG, "Unable to decode DirAuthority key digest.");
- goto err;
- }
- if (!validate_only && (!required_type || required_type & type)) {
- dir_server_t *ds;
- if (required_type)
- type &= required_type; /* pare down what we think of them as an
- * authority for. */
- log_debug(LD_DIR, "Trusted %d dirserver at %s:%d (%s)", (int)type,
- address, (int)dir_port, (char*)smartlist_get(items,0));
- if (!(ds = trusted_dir_server_new(nickname, address, dir_port, or_port,
- ipv6_addrport_ptr,
- digest, v3_digest, type, weight)))
- goto err;
- dir_server_add(ds);
- }
- r = 0;
- goto done;
- err:
- r = -1;
- done:
- SMARTLIST_FOREACH(items, char*, s, tor_free(s));
- smartlist_free(items);
- tor_free(addrport);
- tor_free(address);
- tor_free(nickname);
- tor_free(fingerprint);
- return r;
- }
- /** Read the contents of a FallbackDir line from <b>line</b>. If
- * <b>validate_only</b> is 0, and the line is well-formed, then add the
- * dirserver described in the line as a fallback directory. Return 0 on
- * success, or -1 if the line isn't well-formed or if we can't add it. */
- int
- parse_dir_fallback_line(const char *line,
- int validate_only)
- {
- int r = -1;
- smartlist_t *items = smartlist_new(), *positional = smartlist_new();
- int orport = -1;
- uint16_t dirport;
- tor_addr_t addr;
- int ok;
- char id[DIGEST_LEN];
- char *address=NULL;
- tor_addr_port_t ipv6_addrport, *ipv6_addrport_ptr = NULL;
- double weight=1.0;
- memset(id, 0, sizeof(id));
- smartlist_split_string(items, line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, -1);
- SMARTLIST_FOREACH_BEGIN(items, const char *, cp) {
- const char *eq = strchr(cp, '=');
- ok = 1;
- if (! eq) {
- smartlist_add(positional, (char*)cp);
- continue;
- }
- if (!strcmpstart(cp, "orport=")) {
- orport = (int)tor_parse_long(cp+strlen("orport="), 10,
- 1, 65535, &ok, NULL);
- } else if (!strcmpstart(cp, "id=")) {
- ok = base16_decode(id, DIGEST_LEN, cp+strlen("id="),
- strlen(cp)-strlen("id=")) == DIGEST_LEN;
- } else if (!strcasecmpstart(cp, "ipv6=")) {
- if (ipv6_addrport_ptr) {
- log_warn(LD_CONFIG, "Redundant ipv6 addr/port on FallbackDir line");
- } else {
- if (tor_addr_port_parse(LOG_WARN, cp+strlen("ipv6="),
- &ipv6_addrport.addr, &ipv6_addrport.port,
- -1) < 0
- || tor_addr_family(&ipv6_addrport.addr) != AF_INET6) {
- log_warn(LD_CONFIG, "Bad ipv6 addr/port %s on FallbackDir line",
- escaped(cp));
- goto end;
- }
- ipv6_addrport_ptr = &ipv6_addrport;
- }
- } else if (!strcmpstart(cp, "weight=")) {
- int num_ok;
- const char *wstring = cp + strlen("weight=");
- weight = tor_parse_double(wstring, 0, (double)UINT64_MAX, &num_ok, NULL);
- if (!num_ok) {
- log_warn(LD_CONFIG, "Invalid weight '%s' on FallbackDir line.", cp);
- weight=1.0;
- }
- }
- if (!ok) {
- log_warn(LD_CONFIG, "Bad FallbackDir option %s", escaped(cp));
- goto end;
- }
- } SMARTLIST_FOREACH_END(cp);
- if (smartlist_len(positional) != 1) {
- log_warn(LD_CONFIG, "Couldn't parse FallbackDir line %s", escaped(line));
- goto end;
- }
- if (tor_digest_is_zero(id)) {
- log_warn(LD_CONFIG, "Missing identity on FallbackDir line");
- goto end;
- }
- if (orport <= 0) {
- log_warn(LD_CONFIG, "Missing orport on FallbackDir line");
- goto end;
- }
- if (tor_addr_port_split(LOG_INFO, smartlist_get(positional, 0),
- &address, &dirport) < 0 ||
- tor_addr_parse(&addr, address)<0) {
- log_warn(LD_CONFIG, "Couldn't parse address:port %s on FallbackDir line",
- (const char*)smartlist_get(positional, 0));
- goto end;
- }
- if (!validate_only) {
- dir_server_t *ds;
- ds = fallback_dir_server_new(&addr, dirport, orport, ipv6_addrport_ptr,
- id, weight);
- if (!ds) {
- log_warn(LD_CONFIG, "Couldn't create FallbackDir %s", escaped(line));
- goto end;
- }
- dir_server_add(ds);
- }
- r = 0;
- end:
- SMARTLIST_FOREACH(items, char *, cp, tor_free(cp));
- smartlist_free(items);
- smartlist_free(positional);
- tor_free(address);
- return r;
- }
- /** Allocate and return a new port_cfg_t with reasonable defaults. */
- STATIC port_cfg_t *
- port_cfg_new(size_t namelen)
- {
- tor_assert(namelen <= SIZE_T_CEILING - sizeof(port_cfg_t) - 1);
- port_cfg_t *cfg = tor_malloc_zero(sizeof(port_cfg_t) + namelen + 1);
- cfg->entry_cfg.ipv4_traffic = 1;
- cfg->entry_cfg.ipv6_traffic = 1;
- cfg->entry_cfg.dns_request = 1;
- cfg->entry_cfg.onion_traffic = 1;
- cfg->entry_cfg.cache_ipv4_answers = 1;
- cfg->entry_cfg.prefer_ipv6_virtaddr = 1;
- return cfg;
- }
- /** Free all storage held in <b>port</b> */
- STATIC void
- port_cfg_free(port_cfg_t *port)
- {
- tor_free(port);
- }
- /** Warn for every port in <b>ports</b> of type <b>listener_type</b> that is
- * on a publicly routable address. */
- static void
- warn_nonlocal_client_ports(const smartlist_t *ports, const char *portname,
- int listener_type)
- {
- SMARTLIST_FOREACH_BEGIN(ports, const port_cfg_t *, port) {
- if (port->type != listener_type)
- continue;
- if (port->is_unix_addr) {
- /* Unix sockets aren't accessible over a network. */
- } else if (!tor_addr_is_internal(&port->addr, 1)) {
- log_warn(LD_CONFIG, "You specified a public address '%s' for %sPort. "
- "Other people on the Internet might find your computer and "
- "use it as an open proxy. Please don't allow this unless you "
- "have a good reason.",
- fmt_addrport(&port->addr, port->port), portname);
- } else if (!tor_addr_is_loopback(&port->addr)) {
- log_notice(LD_CONFIG, "You configured a non-loopback address '%s' "
- "for %sPort. This allows everybody on your local network to "
- "use your machine as a proxy. Make sure this is what you "
- "wanted.",
- fmt_addrport(&port->addr, port->port), portname);
- }
- } SMARTLIST_FOREACH_END(port);
- }
- /** Warn for every Extended ORPort port in <b>ports</b> that is on a
- * publicly routable address. */
- static void
- warn_nonlocal_ext_orports(const smartlist_t *ports, const char *portname)
- {
- SMARTLIST_FOREACH_BEGIN(ports, const port_cfg_t *, port) {
- if (port->type != CONN_TYPE_EXT_OR_LISTENER)
- continue;
- if (port->is_unix_addr)
- continue;
- /* XXX maybe warn even if address is RFC1918? */
- if (!tor_addr_is_internal(&port->addr, 1)) {
- log_warn(LD_CONFIG, "You specified a public address '%s' for %sPort. "
- "This is not advised; this address is supposed to only be "
- "exposed on localhost so that your pluggable transport "
- "proxies can connect to it.",
- fmt_addrport(&port->addr, port->port), portname);
- }
- } SMARTLIST_FOREACH_END(port);
- }
- /** Given a list of port_cfg_t in <b>ports</b>, warn if any controller port
- * there is listening on any non-loopback address. If <b>forbid_nonlocal</b>
- * is true, then emit a stronger warning and remove the port from the list.
- */
- static void
- warn_nonlocal_controller_ports(smartlist_t *ports, unsigned forbid_nonlocal)
- {
- int warned = 0;
- SMARTLIST_FOREACH_BEGIN(ports, port_cfg_t *, port) {
- if (port->type != CONN_TYPE_CONTROL_LISTENER)
- continue;
- if (port->is_unix_addr)
- continue;
- if (!tor_addr_is_loopback(&port->addr)) {
- if (forbid_nonlocal) {
- if (!warned)
- log_warn(LD_CONFIG,
- "You have a ControlPort set to accept "
- "unauthenticated connections from a non-local address. "
- "This means that programs not running on your computer "
- "can reconfigure your Tor, without even having to guess a "
- "password. That's so bad that I'm closing your ControlPort "
- "for you. If you need to control your Tor remotely, try "
- "enabling authentication and using a tool like stunnel or "
- "ssh to encrypt remote access.");
- warned = 1;
- port_cfg_free(port);
- SMARTLIST_DEL_CURRENT(ports, port);
- } else {
- log_warn(LD_CONFIG, "You have a ControlPort set to accept "
- "connections from a non-local address. This means that "
- "programs not running on your computer can reconfigure your "
- "Tor. That's pretty bad, since the controller "
- "protocol isn't encrypted! Maybe you should just listen on "
- "127.0.0.1 and use a tool like stunnel or ssh to encrypt "
- "remote connections to your control port.");
- return; /* No point in checking the rest */
- }
- }
- } SMARTLIST_FOREACH_END(port);
- }
- /**
- * Take a string (<b>line</b>) that begins with either an address:port, a
- * port, or an AF_UNIX address, optionally quoted, prefixed with
- * "unix:". Parse that line, and on success, set <b>addrport_out</b> to a new
- * string containing the beginning portion (without prefix). Iff there was a
- * unix: prefix, set <b>is_unix_out</b> to true. On success, also set
- * <b>rest_out</b> to point to the part of the line after the address portion.
- *
- * Return 0 on success, -1 on failure.
- */
- int
- port_cfg_line_extract_addrport(const char *line,
- char **addrport_out,
- int *is_unix_out,
- const char **rest_out)
- {
- tor_assert(line);
- tor_assert(addrport_out);
- tor_assert(is_unix_out);
- tor_assert(rest_out);
- line = eat_whitespace(line);
- if (!strcmpstart(line, unix_q_socket_prefix)) {
- // It starts with unix:"
- size_t sz;
- *is_unix_out = 1;
- *addrport_out = NULL;
- line += strlen(unix_socket_prefix); /*No q: Keep the quote */
- *rest_out = unescape_string(line, addrport_out, &sz);
- if (!*rest_out || (*addrport_out && sz != strlen(*addrport_out))) {
- tor_free(*addrport_out);
- return -1;
- }
- *rest_out = eat_whitespace(*rest_out);
- return 0;
- } else {
- // Is there a unix: prefix?
- if (!strcmpstart(line, unix_socket_prefix)) {
- line += strlen(unix_socket_prefix);
- *is_unix_out = 1;
- } else {
- *is_unix_out = 0;
- }
- const char *end = find_whitespace(line);
- if (BUG(!end)) {
- end = strchr(line, '\0'); // LCOV_EXCL_LINE -- this can't be NULL
- }
- tor_assert(end && end >= line);
- *addrport_out = tor_strndup(line, end - line);
- *rest_out = eat_whitespace(end);
- return 0;
- }
- }
- static void
- warn_client_dns_cache(const char *option, int disabling)
- {
- if (disabling)
- return;
- warn_deprecated_option(option,
- "Client-side DNS cacheing enables a wide variety of route-"
- "capture attacks. If a single bad exit node lies to you about "
- "an IP address, cacheing that address would make you visit "
- "an address of the attacker's choice every time you connected "
- "to your destination.");
- }
- /**
- * Parse port configuration for a single port type.
- *
- * Read entries of the "FooPort" type from the list <b>ports</b>. Syntax is
- * that FooPort can have any number of entries of the format
- * "[Address:][Port] IsolationOptions".
- *
- * In log messages, describe the port type as <b>portname</b>.
- *
- * If no address is specified, default to <b>defaultaddr</b>. If no
- * FooPort is given, default to defaultport (if 0, there is no default).
- *
- * If CL_PORT_NO_STREAM_OPTIONS is set in <b>flags</b>, do not allow stream
- * isolation options in the FooPort entries.
- *
- * If CL_PORT_WARN_NONLOCAL is set in <b>flags</b>, warn if any of the
- * ports are not on a local address. If CL_PORT_FORBID_NONLOCAL is set,
- * this is a control port with no password set: don't even allow it.
- *
- * If CL_PORT_SERVER_OPTIONS is set in <b>flags</b>, do not allow stream
- * isolation options in the FooPort entries; instead allow the
- * server-port option set.
- *
- * If CL_PORT_TAKES_HOSTNAMES is set in <b>flags</b>, allow the options
- * {No,}IPv{4,6}Traffic.
- *
- * On success, if <b>out</b> is given, add a new port_cfg_t entry to
- * <b>out</b> for every port that the client should listen on. Return 0
- * on success, -1 on failure.
- */
- STATIC int
- parse_port_config(smartlist_t *out,
- const config_line_t *ports,
- const char *portname,
- int listener_type,
- const char *defaultaddr,
- int defaultport,
- const unsigned flags)
- {
- smartlist_t *elts;
- int retval = -1;
- const unsigned is_control = (listener_type == CONN_TYPE_CONTROL_LISTENER);
- const unsigned is_ext_orport = (listener_type == CONN_TYPE_EXT_OR_LISTENER);
- const unsigned allow_no_stream_options = flags & CL_PORT_NO_STREAM_OPTIONS;
- const unsigned use_server_options = flags & CL_PORT_SERVER_OPTIONS;
- const unsigned warn_nonlocal = flags & CL_PORT_WARN_NONLOCAL;
- const unsigned forbid_nonlocal = flags & CL_PORT_FORBID_NONLOCAL;
- const unsigned default_to_group_writable =
- flags & CL_PORT_DFLT_GROUP_WRITABLE;
- const unsigned takes_hostnames = flags & CL_PORT_TAKES_HOSTNAMES;
- const unsigned is_unix_socket = flags & CL_PORT_IS_UNIXSOCKET;
- int got_zero_port=0, got_nonzero_port=0;
- char *unix_socket_path = NULL;
- /* If there's no FooPort, then maybe make a default one. */
- if (! ports) {
- if (defaultport && defaultaddr && out) {
- port_cfg_t *cfg = port_cfg_new(is_unix_socket ? strlen(defaultaddr) : 0);
- cfg->type = listener_type;
- if (is_unix_socket) {
- tor_addr_make_unspec(&cfg->addr);
- memcpy(cfg->unix_addr, defaultaddr, strlen(defaultaddr) + 1);
- cfg->is_unix_addr = 1;
- } else {
- cfg->port = defaultport;
- tor_addr_parse(&cfg->addr, defaultaddr);
- }
- cfg->entry_cfg.session_group = SESSION_GROUP_UNSET;
- cfg->entry_cfg.isolation_flags = ISO_DEFAULT;
- smartlist_add(out, cfg);
- }
- return 0;
- }
- /* At last we can actually parse the FooPort lines. The syntax is:
- * [Addr:](Port|auto) [Options].*/
- elts = smartlist_new();
- char *addrport = NULL;
- for (; ports; ports = ports->next) {
- tor_addr_t addr;
- int port;
- int sessiongroup = SESSION_GROUP_UNSET;
- unsigned isolation = ISO_DEFAULT;
- int prefer_no_auth = 0;
- int socks_iso_keep_alive = 0;
- uint16_t ptmp=0;
- int ok;
- /* This must be kept in sync with port_cfg_new's defaults */
- int no_listen = 0, no_advertise = 0, all_addrs = 0,
- bind_ipv4_only = 0, bind_ipv6_only = 0,
- ipv4_traffic = 1, ipv6_traffic = 1, prefer_ipv6 = 0, dns_request = 1,
- onion_traffic = 1,
- cache_ipv4 = 1, use_cached_ipv4 = 0,
- cache_ipv6 = 0, use_cached_ipv6 = 0,
- prefer_ipv6_automap = 1, world_writable = 0, group_writable = 0,
- relax_dirmode_check = 0,
- has_used_unix_socket_only_option = 0;
- int is_unix_tagged_addr = 0;
- const char *rest_of_line = NULL;
- if (port_cfg_line_extract_addrport(ports->value,
- &addrport, &is_unix_tagged_addr, &rest_of_line)<0) {
- log_warn(LD_CONFIG, "Invalid %sPort line with unparsable address",
- portname);
- goto err;
- }
- if (strlen(addrport) == 0) {
- log_warn(LD_CONFIG, "Invalid %sPort line with no address", portname);
- goto err;
- }
- /* Split the remainder... */
- smartlist_split_string(elts, rest_of_line, NULL,
- SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
- /* Let's start to check if it's a Unix socket path. */
- if (is_unix_tagged_addr) {
- #ifndef HAVE_SYS_UN_H
- log_warn(LD_CONFIG, "Unix sockets not supported on this system.");
- goto err;
- #endif
- unix_socket_path = addrport;
- addrport = NULL;
- }
- if (unix_socket_path &&
- ! conn_listener_type_supports_af_unix(listener_type)) {
- log_warn(LD_CONFIG, "%sPort does not support unix sockets", portname);
- goto err;
- }
- if (unix_socket_path) {
- port = 1;
- } else if (is_unix_socket) {
- if (BUG(!addrport))
- goto err; // LCOV_EXCL_LINE unreachable, but coverity can't tell that
- unix_socket_path = tor_strdup(addrport);
- if (!strcmp(addrport, "0"))
- port = 0;
- else
- port = 1;
- } else if (!strcmp(addrport, "auto")) {
- port = CFG_AUTO_PORT;
- int af = tor_addr_parse(&addr, defaultaddr);
- tor_assert(af >= 0);
- } else if (!strcasecmpend(addrport, ":auto")) {
- char *addrtmp = tor_strndup(addrport, strlen(addrport)-5);
- port = CFG_AUTO_PORT;
- if (tor_addr_port_lookup(addrtmp, &addr, &ptmp)<0 || ptmp) {
- log_warn(LD_CONFIG, "Invalid address '%s' for %sPort",
- escaped(addrport), portname);
- tor_free(addrtmp);
- goto err;
- }
- tor_free(addrtmp);
- } else {
- /* Try parsing integer port before address, because, who knows?
- "9050" might be a valid address. */
- port = (int) tor_parse_long(addrport, 10, 0, 65535, &ok, NULL);
- if (ok) {
- int af = tor_addr_parse(&addr, defaultaddr);
- tor_assert(af >= 0);
- } else if (tor_addr_port_lookup(addrport, &addr, &ptmp) == 0) {
- if (ptmp == 0) {
- log_warn(LD_CONFIG, "%sPort line has address but no port", portname);
- goto err;
- }
- port = ptmp;
- } else {
- log_warn(LD_CONFIG, "Couldn't parse address %s for %sPort",
- escaped(addrport), portname);
- goto err;
- }
- }
- if (unix_socket_path && default_to_group_writable)
- group_writable = 1;
- /* Now parse the rest of the options, if any. */
- if (use_server_options) {
- /* This is a server port; parse advertising options */
- SMARTLIST_FOREACH_BEGIN(elts, char *, elt) {
- if (!strcasecmp(elt, "NoAdvertise")) {
- no_advertise = 1;
- } else if (!strcasecmp(elt, "NoListen")) {
- no_listen = 1;
- #if 0
- /* not implemented yet. */
- } else if (!strcasecmp(elt, "AllAddrs")) {
- all_addrs = 1;
- #endif
- } else if (!strcasecmp(elt, "IPv4Only")) {
- bind_ipv4_only = 1;
- } else if (!strcasecmp(elt, "IPv6Only")) {
- bind_ipv6_only = 1;
- } else {
- log_warn(LD_CONFIG, "Unrecognized %sPort option '%s'",
- portname, escaped(elt));
- }
- } SMARTLIST_FOREACH_END(elt);
- if (no_advertise && no_listen) {
- log_warn(LD_CONFIG, "Tried to set both NoListen and NoAdvertise "
- "on %sPort line '%s'",
- portname, escaped(ports->value));
- goto err;
- }
- if (bind_ipv4_only && bind_ipv6_only) {
- log_warn(LD_CONFIG, "Tried to set both IPv4Only and IPv6Only "
- "on %sPort line '%s'",
- portname, escaped(ports->value));
- goto err;
- }
- if (bind_ipv4_only && tor_addr_family(&addr) == AF_INET6) {
- log_warn(LD_CONFIG, "Could not interpret %sPort address as IPv6",
- portname);
- goto err;
- }
- if (bind_ipv6_only && tor_addr_family(&addr) == AF_INET) {
- log_warn(LD_CONFIG, "Could not interpret %sPort address as IPv4",
- portname);
- goto err;
- }
- } else {
- /* This is a client port; parse isolation options */
- SMARTLIST_FOREACH_BEGIN(elts, char *, elt) {
- int no = 0, isoflag = 0;
- const char *elt_orig = elt;
- if (!strcasecmpstart(elt, "SessionGroup=")) {
- int group = (int)tor_parse_long(elt+strlen("SessionGroup="),
- 10, 0, INT_MAX, &ok, NULL);
- if (!ok || !allow_no_stream_options) {
- log_warn(LD_CONFIG, "Invalid %sPort option '%s'",
- portname, escaped(elt));
- goto err;
- }
- if (sessiongroup >= 0) {
- log_warn(LD_CONFIG, "Multiple SessionGroup options on %sPort",
- portname);
- goto err;
- }
- sessiongroup = group;
- continue;
- }
- if (!strcasecmpstart(elt, "No")) {
- no = 1;
- elt += 2;
- }
- if (!strcasecmp(elt, "GroupWritable")) {
- group_writable = !no;
- has_used_unix_socket_only_option = 1;
- continue;
- } else if (!strcasecmp(elt, "WorldWritable")) {
- world_writable = !no;
- has_used_unix_socket_only_option = 1;
- continue;
- } else if (!strcasecmp(elt, "RelaxDirModeCheck")) {
- relax_dirmode_check = !no;
- has_used_unix_socket_only_option = 1;
- continue;
- }
- if (allow_no_stream_options) {
- log_warn(LD_CONFIG, "Unrecognized %sPort option '%s'",
- portname, escaped(elt));
- continue;
- }
- if (takes_hostnames) {
- if (!strcasecmp(elt, "IPv4Traffic")) {
- ipv4_traffic = ! no;
- continue;
- } else if (!strcasecmp(elt, "IPv6Traffic")) {
- ipv6_traffic = ! no;
- continue;
- } else if (!strcasecmp(elt, "PreferIPv6")) {
- prefer_ipv6 = ! no;
- continue;
- } else if (!strcasecmp(elt, "DNSRequest")) {
- dns_request = ! no;
- continue;
- } else if (!strcasecmp(elt, "OnionTraffic")) {
- onion_traffic = ! no;
- continue;
- } else if (!strcasecmp(elt, "OnionTrafficOnly")) {
- /* Only connect to .onion addresses. Equivalent to
- * NoDNSRequest, NoIPv4Traffic, NoIPv6Traffic. The option
- * NoOnionTrafficOnly is not supported, it's too confusing. */
- if (no) {
- log_warn(LD_CONFIG, "Unsupported %sPort option 'No%s'. Use "
- "DNSRequest, IPv4Traffic, and/or IPv6Traffic instead.",
- portname, escaped(elt));
- } else {
- ipv4_traffic = ipv6_traffic = dns_request = 0;
- }
- continue;
- }
- }
- if (!strcasecmp(elt, "CacheIPv4DNS")) {
- warn_client_dns_cache(elt, no); // since 0.2.9.2-alpha
- cache_ipv4 = ! no;
- continue;
- } else if (!strcasecmp(elt, "CacheIPv6DNS")) {
- warn_client_dns_cache(elt, no); // since 0.2.9.2-alpha
- cache_ipv6 = ! no;
- continue;
- } else if (!strcasecmp(elt, "CacheDNS")) {
- warn_client_dns_cache(elt, no); // since 0.2.9.2-alpha
- cache_ipv4 = cache_ipv6 = ! no;
- continue;
- } else if (!strcasecmp(elt, "UseIPv4Cache")) {
- warn_client_dns_cache(elt, no); // since 0.2.9.2-alpha
- use_cached_ipv4 = ! no;
- continue;
- } else if (!strcasecmp(elt, "UseIPv6Cache")) {
- warn_client_dns_cache(elt, no); // since 0.2.9.2-alpha
- use_cached_ipv6 = ! no;
- continue;
- } else if (!strcasecmp(elt, "UseDNSCache")) {
- warn_client_dns_cache(elt, no); // since 0.2.9.2-alpha
- use_cached_ipv4 = use_cached_ipv6 = ! no;
- continue;
- } else if (!strcasecmp(elt, "PreferIPv6Automap")) {
- prefer_ipv6_automap = ! no;
- continue;
- } else if (!strcasecmp(elt, "PreferSOCKSNoAuth")) {
- prefer_no_auth = ! no;
- continue;
- } else if (!strcasecmp(elt, "KeepAliveIsolateSOCKSAuth")) {
- socks_iso_keep_alive = ! no;
- continue;
- }
- if (!strcasecmpend(elt, "s"))
- elt[strlen(elt)-1] = '\0'; /* kill plurals. */
- if (!strcasecmp(elt, "IsolateDestPort")) {
- isoflag = ISO_DESTPORT;
- } else if (!strcasecmp(elt, "IsolateDestAddr")) {
- isoflag = ISO_DESTADDR;
- } else if (!strcasecmp(elt, "IsolateSOCKSAuth")) {
- isoflag = ISO_SOCKSAUTH;
- } else if (!strcasecmp(elt, "IsolateClientProtocol")) {
- isoflag = ISO_CLIENTPROTO;
- } else if (!strcasecmp(elt, "IsolateClientAddr")) {
- isoflag = ISO_CLIENTADDR;
- } else {
- log_warn(LD_CONFIG, "Unrecognized %sPort option '%s'",
- portname, escaped(elt_orig));
- }
- if (no) {
- isolation &= ~isoflag;
- } else {
- isolation |= isoflag;
- }
- } SMARTLIST_FOREACH_END(elt);
- }
- if (port)
- got_nonzero_port = 1;
- else
- got_zero_port = 1;
- if (dns_request == 0 && listener_type == CONN_TYPE_AP_DNS_LISTENER) {
- log_warn(LD_CONFIG, "You have a %sPort entry with DNS disabled; that "
- "won't work.", portname);
- goto err;
- }
- if (ipv4_traffic == 0 && ipv6_traffic == 0 && onion_traffic == 0
- && listener_type != CONN_TYPE_AP_DNS_LISTENER) {
- log_warn(LD_CONFIG, "You have a %sPort entry with all of IPv4 and "
- "IPv6 and .onion disabled; that won't work.", portname);
- goto err;
- }
- if (dns_request == 1 && ipv4_traffic == 0 && ipv6_traffic == 0
- && listener_type != CONN_TYPE_AP_DNS_LISTENER) {
- log_warn(LD_CONFIG, "You have a %sPort entry with DNSRequest enabled, "
- "but IPv4 and IPv6 disabled; DNS-based sites won't work.",
- portname);
- goto err;
- }
- if ( has_used_unix_socket_only_option && ! unix_socket_path) {
- log_warn(LD_CONFIG, "You have a %sPort entry with GroupWritable, "
- "WorldWritable, or RelaxDirModeCheck, but it is not a "
- "unix socket.", portname);
- goto err;
- }
- if (!(isolation & ISO_SOCKSAUTH) && socks_iso_keep_alive) {
- log_warn(LD_CONFIG, "You have a %sPort entry with both "
- "NoIsolateSOCKSAuth and KeepAliveIsolateSOCKSAuth set.",
- portname);
- goto err;
- }
- if (unix_socket_path && (isolation & ISO_CLIENTADDR)) {
- /* `IsolateClientAddr` is nonsensical in the context of AF_LOCAL.
- * just silently remove the isolation flag.
- */
- isolation &= ~ISO_CLIENTADDR;
- }
- if (out && port) {
- size_t namelen = unix_socket_path ? strlen(unix_socket_path) : 0;
- port_cfg_t *cfg = port_cfg_new(namelen);
- if (unix_socket_path) {
- tor_addr_make_unspec(&cfg->addr);
- memcpy(cfg->unix_addr, unix_socket_path, namelen + 1);
- cfg->is_unix_addr = 1;
- tor_free(unix_socket_path);
- } else {
- tor_addr_copy(&cfg->addr, &addr);
- cfg->port = port;
- }
- cfg->type = listener_type;
- cfg->is_world_writable = world_writable;
- cfg->is_group_writable = group_writable;
- cfg->relax_dirmode_check = relax_dirmode_check;
- cfg->entry_cfg.isolation_flags = isolation;
- cfg->entry_cfg.session_group = sessiongroup;
- cfg->server_cfg.no_advertise = no_advertise;
- cfg->server_cfg.no_listen = no_listen;
- cfg->server_cfg.all_addrs = all_addrs;
- cfg->server_cfg.bind_ipv4_only = bind_ipv4_only;
- cfg->server_cfg.bind_ipv6_only = bind_ipv6_only;
- cfg->entry_cfg.ipv4_traffic = ipv4_traffic;
- cfg->entry_cfg.ipv6_traffic = ipv6_traffic;
- cfg->entry_cfg.prefer_ipv6 = prefer_ipv6;
- cfg->entry_cfg.dns_request = dns_request;
- cfg->entry_cfg.onion_traffic = onion_traffic;
- cfg->entry_cfg.cache_ipv4_answers = cache_ipv4;
- cfg->entry_cfg.cache_ipv6_answers = cache_ipv6;
- cfg->entry_cfg.use_cached_ipv4_answers = use_cached_ipv4;
- cfg->entry_cfg.use_cached_ipv6_answers = use_cached_ipv6;
- cfg->entry_cfg.prefer_ipv6_virtaddr = prefer_ipv6_automap;
- cfg->entry_cfg.socks_prefer_no_auth = prefer_no_auth;
- if (! (isolation & ISO_SOCKSAUTH))
- cfg->entry_cfg.socks_prefer_no_auth = 1;
- cfg->entry_cfg.socks_iso_keep_alive = socks_iso_keep_alive;
- smartlist_add(out, cfg);
- }
- SMARTLIST_FOREACH(elts, char *, cp, tor_free(cp));
- smartlist_clear(elts);
- tor_free(addrport);
- }
- if (warn_nonlocal && out) {
- if (is_control)
- warn_nonlocal_controller_ports(out, forbid_nonlocal);
- else if (is_ext_orport)
- warn_nonlocal_ext_orports(out, portname);
- else
- warn_nonlocal_client_ports(out, portname, listener_type);
- }
- if (got_zero_port && got_nonzero_port) {
- log_warn(LD_CONFIG, "You specified a nonzero %sPort along with '%sPort 0' "
- "in the same configuration. Did you mean to disable %sPort or "
- "not?", portname, portname, portname);
- goto err;
- }
- retval = 0;
- err:
- SMARTLIST_FOREACH(elts, char *, cp, tor_free(cp));
- smartlist_free(elts);
- tor_free(unix_socket_path);
- tor_free(addrport);
- return retval;
- }
- /** Return the number of ports which are actually going to listen with type
- * <b>listenertype</b>. Do not count no_listen ports. Only count unix
- * sockets if count_sockets is true. */
- static int
- count_real_listeners(const smartlist_t *ports, int listenertype,
- int count_sockets)
- {
- int n = 0;
- SMARTLIST_FOREACH_BEGIN(ports, port_cfg_t *, port) {
- if (port->server_cfg.no_listen)
- continue;
- if (!count_sockets && port->is_unix_addr)
- continue;
- if (port->type != listenertype)
- continue;
- ++n;
- } SMARTLIST_FOREACH_END(port);
- return n;
- }
- /** Parse all ports from <b>options</b>. On success, set *<b>n_ports_out</b>
- * to the number of ports that are listed, update the *Port_set values in
- * <b>options</b>, and return 0. On failure, set *<b>msg</b> to a
- * description of the problem and return -1.
- *
- * If <b>validate_only</b> is false, set configured_client_ports to the
- * new list of ports parsed from <b>options</b>.
- **/
- static int
- parse_ports(or_options_t *options, int validate_only,
- char **msg, int *n_ports_out,
- int *world_writable_control_socket)
- {
- smartlist_t *ports;
- int retval = -1;
- ports = smartlist_new();
- *n_ports_out = 0;
- const unsigned gw_flag = options->SocksSocketsGroupWritable ?
- CL_PORT_DFLT_GROUP_WRITABLE : 0;
- if (parse_port_config(ports,
- options->SocksPort_lines,
- "Socks", CONN_TYPE_AP_LISTENER,
- "127.0.0.1", 9050,
- CL_PORT_WARN_NONLOCAL|CL_PORT_TAKES_HOSTNAMES|gw_flag) < 0) {
- *msg = tor_strdup("Invalid SocksPort configuration");
- goto err;
- }
- if (parse_port_config(ports,
- options->DNSPort_lines,
- "DNS", CONN_TYPE_AP_DNS_LISTENER,
- "127.0.0.1", 0,
- CL_PORT_WARN_NONLOCAL|CL_PORT_TAKES_HOSTNAMES) < 0) {
- *msg = tor_strdup("Invalid DNSPort configuration");
- goto err;
- }
- if (parse_port_config(ports,
- options->TransPort_lines,
- "Trans", CONN_TYPE_AP_TRANS_LISTENER,
- "127.0.0.1", 0,
- CL_PORT_WARN_NONLOCAL) < 0) {
- *msg = tor_strdup("Invalid TransPort configuration");
- goto err;
- }
- if (parse_port_config(ports,
- options->NATDPort_lines,
- "NATD", CONN_TYPE_AP_NATD_LISTENER,
- "127.0.0.1", 0,
- CL_PORT_WARN_NONLOCAL) < 0) {
- *msg = tor_strdup("Invalid NatdPort configuration");
- goto err;
- }
- {
- unsigned control_port_flags = CL_PORT_NO_STREAM_OPTIONS |
- CL_PORT_WARN_NONLOCAL;
- const int any_passwords = (options->HashedControlPassword ||
- options->HashedControlSessionPassword ||
- options->CookieAuthentication);
- if (! any_passwords)
- control_port_flags |= CL_PORT_FORBID_NONLOCAL;
- if (options->ControlSocketsGroupWritable)
- control_port_flags |= CL_PORT_DFLT_GROUP_WRITABLE;
- if (parse_port_config(ports,
- options->ControlPort_lines,
- "Control", CONN_TYPE_CONTROL_LISTENER,
- "127.0.0.1", 0,
- control_port_flags) < 0) {
- *msg = tor_strdup("Invalid ControlPort configuration");
- goto err;
- }
- if (parse_port_config(ports, options->ControlSocket,
- "ControlSocket",
- CONN_TYPE_CONTROL_LISTENER, NULL, 0,
- control_port_flags | CL_PORT_IS_UNIXSOCKET) < 0) {
- *msg = tor_strdup("Invalid ControlSocket configuration");
- goto err;
- }
- }
- if (! options->ClientOnly) {
- if (parse_port_config(ports,
- options->ORPort_lines,
- "OR", CONN_TYPE_OR_LISTENER,
- "0.0.0.0", 0,
- CL_PORT_SERVER_OPTIONS) < 0) {
- *msg = tor_strdup("Invalid ORPort configuration");
- goto err;
- }
- if (parse_port_config(ports,
- options->ExtORPort_lines,
- "ExtOR", CONN_TYPE_EXT_OR_LISTENER,
- "127.0.0.1", 0,
- CL_PORT_SERVER_OPTIONS|CL_PORT_WARN_NONLOCAL) < 0) {
- *msg = tor_strdup("Invalid ExtORPort configuration");
- goto err;
- }
- if (parse_port_config(ports,
- options->DirPort_lines,
- "Dir", CONN_TYPE_DIR_LISTENER,
- "0.0.0.0", 0,
- CL_PORT_SERVER_OPTIONS) < 0) {
- *msg = tor_strdup("Invalid DirPort configuration");
- goto err;
- }
- }
- int n_low_ports = 0;
- if (check_server_ports(ports, options, &n_low_ports) < 0) {
- *msg = tor_strdup("Misconfigured server ports");
- goto err;
- }
- if (have_low_ports < 0)
- have_low_ports = (n_low_ports > 0);
- *n_ports_out = smartlist_len(ports);
- retval = 0;
- /* Update the *Port_set options. The !! here is to force a boolean out of
- an integer. */
- options->ORPort_set =
- !! count_real_listeners(ports, CONN_TYPE_OR_LISTENER, 0);
- options->SocksPort_set =
- !! count_real_listeners(ports, CONN_TYPE_AP_LISTENER, 1);
- options->TransPort_set =
- !! count_real_listeners(ports, CONN_TYPE_AP_TRANS_LISTENER, 1);
- options->NATDPort_set =
- !! count_real_listeners(ports, CONN_TYPE_AP_NATD_LISTENER, 1);
- /* Use options->ControlSocket to test if a control socket is set */
- options->ControlPort_set =
- !! count_real_listeners(ports, CONN_TYPE_CONTROL_LISTENER, 0);
- options->DirPort_set =
- !! count_real_listeners(ports, CONN_TYPE_DIR_LISTENER, 0);
- options->DNSPort_set =
- !! count_real_listeners(ports, CONN_TYPE_AP_DNS_LISTENER, 1);
- options->ExtORPort_set =
- !! count_real_listeners(ports, CONN_TYPE_EXT_OR_LISTENER, 0);
- if (world_writable_control_socket) {
- SMARTLIST_FOREACH(ports, port_cfg_t *, p,
- if (p->type == CONN_TYPE_CONTROL_LISTENER &&
- p->is_unix_addr &&
- p->is_world_writable) {
- *world_writable_control_socket = 1;
- break;
- });
- }
- if (!validate_only) {
- if (configured_ports) {
- SMARTLIST_FOREACH(configured_ports,
- port_cfg_t *, p, port_cfg_free(p));
- smartlist_free(configured_ports);
- }
- configured_ports = ports;
- ports = NULL; /* prevent free below. */
- }
- err:
- if (ports) {
- SMARTLIST_FOREACH(ports, port_cfg_t *, p, port_cfg_free(p));
- smartlist_free(ports);
- }
- return retval;
- }
- /* Does port bind to IPv4? */
- static int
- port_binds_ipv4(const port_cfg_t *port)
- {
- return tor_addr_family(&port->addr) == AF_INET ||
- (tor_addr_family(&port->addr) == AF_UNSPEC
- && !port->server_cfg.bind_ipv6_only);
- }
- /* Does port bind to IPv6? */
- static int
- port_binds_ipv6(const port_cfg_t *port)
- {
- return tor_addr_family(&port->addr) == AF_INET6 ||
- (tor_addr_family(&port->addr) == AF_UNSPEC
- && !port->server_cfg.bind_ipv4_only);
- }
- /** Given a list of <b>port_cfg_t</b> in <b>ports</b>, check them for internal
- * consistency and warn as appropriate. Set *<b>n_low_ports_out</b> to the
- * number of sub-1024 ports we will be binding. */
- static int
- check_server_ports(const smartlist_t *ports,
- const or_options_t *options,
- int *n_low_ports_out)
- {
- int n_orport_advertised = 0;
- int n_orport_advertised_ipv4 = 0;
- int n_orport_listeners = 0;
- int n_dirport_advertised = 0;
- int n_dirport_listeners = 0;
- int n_low_port = 0;
- int r = 0;
- SMARTLIST_FOREACH_BEGIN(ports, const port_cfg_t *, port) {
- if (port->type == CONN_TYPE_DIR_LISTENER) {
- if (! port->server_cfg.no_advertise)
- ++n_dirport_advertised;
- if (! port->server_cfg.no_listen)
- ++n_dirport_listeners;
- } else if (port->type == CONN_TYPE_OR_LISTENER) {
- if (! port->server_cfg.no_advertise) {
- ++n_orport_advertised;
- if (port_binds_ipv4(port))
- ++n_orport_advertised_ipv4;
- }
- if (! port->server_cfg.no_listen)
- ++n_orport_listeners;
- } else {
- continue;
- }
- #ifndef _WIN32
- if (!port->server_cfg.no_listen && port->port < 1024)
- ++n_low_port;
- #endif
- } SMARTLIST_FOREACH_END(port);
- if (n_orport_advertised && !n_orport_listeners) {
- log_warn(LD_CONFIG, "We are advertising an ORPort, but not actually "
- "listening on one.");
- r = -1;
- }
- if (n_orport_listeners && !n_orport_advertised) {
- log_warn(LD_CONFIG, "We are listening on an ORPort, but not advertising "
- "any ORPorts. This will keep us from building a %s "
- "descriptor, and make us impossible to use.",
- options->BridgeRelay ? "bridge" : "router");
- r = -1;
- }
- if (n_dirport_advertised && !n_dirport_listeners) {
- log_warn(LD_CONFIG, "We are advertising a DirPort, but not actually "
- "listening on one.");
- r = -1;
- }
- if (n_dirport_advertised > 1) {
- log_warn(LD_CONFIG, "Can't advertise more than one DirPort.");
- r = -1;
- }
- if (n_orport_advertised && !n_orport_advertised_ipv4 &&
- !options->BridgeRelay) {
- log_warn(LD_CONFIG, "Configured non-bridge only to listen on an IPv6 "
- "address.");
- r = -1;
- }
- if (n_low_port && options->AccountingMax &&
- (!have_capability_support() || options->KeepBindCapabilities == 0)) {
- const char *extra = "";
- if (options->KeepBindCapabilities == 0 && have_capability_support())
- extra = ", and you have disabled KeepBindCapabilities.";
- log_warn(LD_CONFIG,
- "You have set AccountingMax to use hibernation. You have also "
- "chosen a low DirPort or OrPort%s."
- "This combination can make Tor stop "
- "working when it tries to re-attach the port after a period of "
- "hibernation. Please choose a different port or turn off "
- "hibernation unless you know this combination will work on your "
- "platform.", extra);
- }
- if (n_low_ports_out)
- *n_low_ports_out = n_low_port;
- return r;
- }
- /** Return a list of port_cfg_t for client ports parsed from the
- * options. */
- MOCK_IMPL(const smartlist_t *,
- get_configured_ports,(void))
- {
- if (!configured_ports)
- configured_ports = smartlist_new();
- return configured_ports;
- }
- /** Return an address:port string representation of the address
- * where the first <b>listener_type</b> listener waits for
- * connections. Return NULL if we couldn't find a listener. The
- * string is allocated on the heap and it's the responsibility of the
- * caller to free it after use.
- *
- * This function is meant to be used by the pluggable transport proxy
- * spawning code, please make sure that it fits your purposes before
- * using it. */
- char *
- get_first_listener_addrport_string(int listener_type)
- {
- static const char *ipv4_localhost = "127.0.0.1";
- static const char *ipv6_localhost = "[::1]";
- const char *address;
- uint16_t port;
- char *string = NULL;
- if (!configured_ports)
- return NULL;
- SMARTLIST_FOREACH_BEGIN(configured_ports, const port_cfg_t *, cfg) {
- if (cfg->server_cfg.no_listen)
- continue;
- if (cfg->type == listener_type &&
- tor_addr_family(&cfg->addr) != AF_UNSPEC) {
- /* We found the first listener of the type we are interested in! */
- /* If a listener is listening on INADDR_ANY, assume that it's
- also listening on 127.0.0.1, and point the transport proxy
- there: */
- if (tor_addr_is_null(&cfg->addr))
- address = tor_addr_is_v4(&cfg->addr) ? ipv4_localhost : ipv6_localhost;
- else
- address = fmt_and_decorate_addr(&cfg->addr);
- /* If a listener is configured with port 'auto', we are forced
- to iterate all listener connections and find out in which
- port it ended up listening: */
- if (cfg->port == CFG_AUTO_PORT) {
- port = router_get_active_listener_port_by_type_af(listener_type,
- tor_addr_family(&cfg->addr));
- if (!port)
- return NULL;
- } else {
- port = cfg->port;
- }
- tor_asprintf(&string, "%s:%u", address, port);
- return string;
- }
- } SMARTLIST_FOREACH_END(cfg);
- return NULL;
- }
- /** Return the first advertised port of type <b>listener_type</b> in
- * <b>address_family</b>. Returns 0 when no port is found, and when passed
- * AF_UNSPEC. */
- int
- get_first_advertised_port_by_type_af(int listener_type, int address_family)
- {
- if (address_family == AF_UNSPEC)
- return 0;
- const smartlist_t *conf_ports = get_configured_ports();
- SMARTLIST_FOREACH_BEGIN(conf_ports, const port_cfg_t *, cfg) {
- if (cfg->type == listener_type &&
- !cfg->server_cfg.no_advertise) {
- if ((address_family == AF_INET && port_binds_ipv4(cfg)) ||
- (address_family == AF_INET6 && port_binds_ipv6(cfg))) {
- return cfg->port;
- }
- }
- } SMARTLIST_FOREACH_END(cfg);
- return 0;
- }
- /** Return the first advertised address of type <b>listener_type</b> in
- * <b>address_family</b>. Returns NULL if there is no advertised address,
- * and when passed AF_UNSPEC. */
- const tor_addr_t *
- get_first_advertised_addr_by_type_af(int listener_type, int address_family)
- {
- if (address_family == AF_UNSPEC)
- return NULL;
- if (!configured_ports)
- return NULL;
- SMARTLIST_FOREACH_BEGIN(configured_ports, const port_cfg_t *, cfg) {
- if (cfg->type == listener_type &&
- !cfg->server_cfg.no_advertise) {
- if ((address_family == AF_INET && port_binds_ipv4(cfg)) ||
- (address_family == AF_INET6 && port_binds_ipv6(cfg))) {
- return &cfg->addr;
- }
- }
- } SMARTLIST_FOREACH_END(cfg);
- return NULL;
- }
- /** Return 1 if a port exists of type <b>listener_type</b> on <b>addr</b> and
- * <b>port</b>. If <b>check_wildcard</b> is true, INADDR[6]_ANY and AF_UNSPEC
- * addresses match any address of the appropriate family; and port -1 matches
- * any port.
- * To match auto ports, pass CFG_PORT_AUTO. (Does not match on the actual
- * automatically chosen listener ports.) */
- int
- port_exists_by_type_addr_port(int listener_type, const tor_addr_t *addr,
- int port, int check_wildcard)
- {
- if (!configured_ports || !addr)
- return 0;
- SMARTLIST_FOREACH_BEGIN(configured_ports, const port_cfg_t *, cfg) {
- if (cfg->type == listener_type) {
- if (cfg->port == port || (check_wildcard && port == -1)) {
- /* Exact match */
- if (tor_addr_eq(&cfg->addr, addr)) {
- return 1;
- }
- /* Skip wildcard matches if we're not doing them */
- if (!check_wildcard) {
- continue;
- }
- /* Wildcard matches IPv4 */
- const int cfg_v4 = port_binds_ipv4(cfg);
- const int cfg_any_v4 = tor_addr_is_null(&cfg->addr) && cfg_v4;
- const int addr_v4 = tor_addr_family(addr) == AF_INET ||
- tor_addr_family(addr) == AF_UNSPEC;
- const int addr_any_v4 = tor_addr_is_null(&cfg->addr) && addr_v4;
- if ((cfg_any_v4 && addr_v4) || (cfg_v4 && addr_any_v4)) {
- return 1;
- }
- /* Wildcard matches IPv6 */
- const int cfg_v6 = port_binds_ipv6(cfg);
- const int cfg_any_v6 = tor_addr_is_null(&cfg->addr) && cfg_v6;
- const int addr_v6 = tor_addr_family(addr) == AF_INET6 ||
- tor_addr_family(addr) == AF_UNSPEC;
- const int addr_any_v6 = tor_addr_is_null(&cfg->addr) && addr_v6;
- if ((cfg_any_v6 && addr_v6) || (cfg_v6 && addr_any_v6)) {
- return 1;
- }
- }
- }
- } SMARTLIST_FOREACH_END(cfg);
- return 0;
- }
- /* Like port_exists_by_type_addr_port, but accepts a host-order IPv4 address
- * instead. */
- int
- port_exists_by_type_addr32h_port(int listener_type, uint32_t addr_ipv4h,
- int port, int check_wildcard)
- {
- tor_addr_t ipv4;
- tor_addr_from_ipv4h(&ipv4, addr_ipv4h);
- return port_exists_by_type_addr_port(listener_type, &ipv4, port,
- check_wildcard);
- }
- /** Adjust the value of options->DataDirectory, or fill it in if it's
- * absent. Return 0 on success, -1 on failure. */
- static int
- normalize_data_directory(or_options_t *options)
- {
- #ifdef _WIN32
- char *p;
- if (options->DataDirectory)
- return 0; /* all set */
- p = tor_malloc(MAX_PATH);
- strlcpy(p,get_windows_conf_root(),MAX_PATH);
- options->DataDirectory = p;
- return 0;
- #else
- const char *d = options->DataDirectory;
- if (!d)
- d = "~/.tor";
- if (strncmp(d,"~/",2) == 0) {
- char *fn = expand_filename(d);
- if (!fn) {
- log_warn(LD_CONFIG,"Failed to expand filename \"%s\".", d);
- return -1;
- }
- if (!options->DataDirectory && !strcmp(fn,"/.tor")) {
- /* If our homedir is /, we probably don't want to use it. */
- /* Default to LOCALSTATEDIR/tor which is probably closer to what we
- * want. */
- log_warn(LD_CONFIG,
- "Default DataDirectory is \"~/.tor\". This expands to "
- "\"%s\", which is probably not what you want. Using "
- "\"%s"PATH_SEPARATOR"tor\" instead", fn, LOCALSTATEDIR);
- tor_free(fn);
- fn = tor_strdup(LOCALSTATEDIR PATH_SEPARATOR "tor");
- }
- tor_free(options->DataDirectory);
- options->DataDirectory = fn;
- }
- return 0;
- #endif
- }
- /** Check and normalize the value of options->DataDirectory; return 0 if it
- * is sane, -1 otherwise. */
- static int
- validate_data_directory(or_options_t *options)
- {
- if (normalize_data_directory(options) < 0)
- return -1;
- tor_assert(options->DataDirectory);
- if (strlen(options->DataDirectory) > (512-128)) {
- log_warn(LD_CONFIG, "DataDirectory is too long.");
- return -1;
- }
- return 0;
- }
- /** This string must remain the same forevermore. It is how we
- * recognize that the torrc file doesn't need to be backed up. */
- #define GENERATED_FILE_PREFIX "# This file was generated by Tor; " \
- "if you edit it, comments will not be preserved"
- /** This string can change; it tries to give the reader an idea
- * that editing this file by hand is not a good plan. */
- #define GENERATED_FILE_COMMENT "# The old torrc file was renamed " \
- "to torrc.orig.1 or similar, and Tor will ignore it"
- /** Save a configuration file for the configuration in <b>options</b>
- * into the file <b>fname</b>. If the file already exists, and
- * doesn't begin with GENERATED_FILE_PREFIX, rename it. Otherwise
- * replace it. Return 0 on success, -1 on failure. */
- static int
- write_configuration_file(const char *fname, const or_options_t *options)
- {
- char *old_val=NULL, *new_val=NULL, *new_conf=NULL;
- int rename_old = 0, r;
- if (!fname)
- return -1;
- switch (file_status(fname)) {
- /* create backups of old config files, even if they're empty */
- case FN_FILE:
- case FN_EMPTY:
- old_val = read_file_to_str(fname, 0, NULL);
- if (!old_val || strcmpstart(old_val, GENERATED_FILE_PREFIX)) {
- rename_old = 1;
- }
- tor_free(old_val);
- break;
- case FN_NOENT:
- break;
- case FN_ERROR:
- case FN_DIR:
- default:
- log_warn(LD_CONFIG,
- "Config file \"%s\" is not a file? Failing.", fname);
- return -1;
- }
- if (!(new_conf = options_dump(options, OPTIONS_DUMP_MINIMAL))) {
- log_warn(LD_BUG, "Couldn't get configuration string");
- goto err;
- }
- tor_asprintf(&new_val, "%s\n%s\n\n%s",
- GENERATED_FILE_PREFIX, GENERATED_FILE_COMMENT, new_conf);
- if (rename_old) {
- int i = 1;
- char *fn_tmp = NULL;
- while (1) {
- tor_asprintf(&fn_tmp, "%s.orig.%d", fname, i);
- if (file_status(fn_tmp) == FN_NOENT)
- break;
- tor_free(fn_tmp);
- ++i;
- }
- log_notice(LD_CONFIG, "Renaming old configuration file to \"%s\"", fn_tmp);
- if (tor_rename(fname, fn_tmp) < 0) {//XXXX sandbox doesn't allow
- log_warn(LD_FS,
- "Couldn't rename configuration file \"%s\" to \"%s\": %s",
- fname, fn_tmp, strerror(errno));
- tor_free(fn_tmp);
- goto err;
- }
- tor_free(fn_tmp);
- }
- if (write_str_to_file(fname, new_val, 0) < 0)
- goto err;
- r = 0;
- goto done;
- err:
- r = -1;
- done:
- tor_free(new_val);
- tor_free(new_conf);
- return r;
- }
- /**
- * Save the current configuration file value to disk. Return 0 on
- * success, -1 on failure.
- **/
- int
- options_save_current(void)
- {
- /* This fails if we can't write to our configuration file.
- *
- * If we try falling back to datadirectory or something, we have a better
- * chance of saving the configuration, but a better chance of doing
- * something the user never expected. */
- return write_configuration_file(get_torrc_fname(0), get_options());
- }
- /** Return the number of cpus configured in <b>options</b>. If we are
- * told to auto-detect the number of cpus, return the auto-detected number. */
- int
- get_num_cpus(const or_options_t *options)
- {
- if (options->NumCPUs == 0) {
- int n = compute_num_cpus();
- return (n >= 1) ? n : 1;
- } else {
- return options->NumCPUs;
- }
- }
- /**
- * Initialize the libevent library.
- */
- static void
- init_libevent(const or_options_t *options)
- {
- tor_libevent_cfg cfg;
- tor_assert(options);
- configure_libevent_logging();
- /* If the kernel complains that some method (say, epoll) doesn't
- * exist, we don't care about it, since libevent will cope.
- */
- suppress_libevent_log_msg("Function not implemented");
- memset(&cfg, 0, sizeof(cfg));
- cfg.num_cpus = get_num_cpus(options);
- cfg.msec_per_tick = options->TokenBucketRefillInterval;
- tor_libevent_initialize(&cfg);
- suppress_libevent_log_msg(NULL);
- }
- /** Return a newly allocated string holding a filename relative to the data
- * directory. If <b>sub1</b> is present, it is the first path component after
- * the data directory. If <b>sub2</b> is also present, it is the second path
- * component after the data directory. If <b>suffix</b> is present, it
- * is appended to the filename.
- *
- * Examples:
- * get_datadir_fname2_suffix("a", NULL, NULL) -> $DATADIR/a
- * get_datadir_fname2_suffix("a", NULL, ".tmp") -> $DATADIR/a.tmp
- * get_datadir_fname2_suffix("a", "b", ".tmp") -> $DATADIR/a/b/.tmp
- * get_datadir_fname2_suffix("a", "b", NULL) -> $DATADIR/a/b
- *
- * Note: Consider using the get_datadir_fname* macros in or.h.
- */
- MOCK_IMPL(char *,
- options_get_datadir_fname2_suffix,(const or_options_t *options,
- const char *sub1, const char *sub2,
- const char *suffix))
- {
- char *fname = NULL;
- size_t len;
- tor_assert(options);
- tor_assert(options->DataDirectory);
- tor_assert(sub1 || !sub2); /* If sub2 is present, sub1 must be present. */
- len = strlen(options->DataDirectory);
- if (sub1) {
- len += strlen(sub1)+1;
- if (sub2)
- len += strlen(sub2)+1;
- }
- if (suffix)
- len += strlen(suffix);
- len++;
- fname = tor_malloc(len);
- if (sub1) {
- if (sub2) {
- tor_snprintf(fname, len, "%s"PATH_SEPARATOR"%s"PATH_SEPARATOR"%s",
- options->DataDirectory, sub1, sub2);
- } else {
- tor_snprintf(fname, len, "%s"PATH_SEPARATOR"%s",
- options->DataDirectory, sub1);
- }
- } else {
- strlcpy(fname, options->DataDirectory, len);
- }
- if (suffix)
- strlcat(fname, suffix, len);
- return fname;
- }
- /** Check wether the data directory has a private subdirectory
- * <b>subdir</b>. If not, try to create it. Return 0 on success,
- * -1 otherwise. */
- int
- check_or_create_data_subdir(const char *subdir)
- {
- char *statsdir = get_datadir_fname(subdir);
- int return_val = 0;
- if (check_private_dir(statsdir, CPD_CREATE, get_options()->User) < 0) {
- log_warn(LD_HIST, "Unable to create %s/ directory!", subdir);
- return_val = -1;
- }
- tor_free(statsdir);
- return return_val;
- }
- /** Create a file named <b>fname</b> with contents <b>str</b> in the
- * subdirectory <b>subdir</b> of the data directory. <b>descr</b>
- * should be a short description of the file's content and will be
- * used for the warning message, if it's present and the write process
- * fails. Return 0 on success, -1 otherwise.*/
- int
- write_to_data_subdir(const char* subdir, const char* fname,
- const char* str, const char* descr)
- {
- char *filename = get_datadir_fname2(subdir, fname);
- int return_val = 0;
- if (write_str_to_file(filename, str, 0) < 0) {
- log_warn(LD_HIST, "Unable to write %s to disk!", descr ? descr : fname);
- return_val = -1;
- }
- tor_free(filename);
- return return_val;
- }
- /** Given a file name check to see whether the file exists but has not been
- * modified for a very long time. If so, remove it. */
- void
- remove_file_if_very_old(const char *fname, time_t now)
- {
- #define VERY_OLD_FILE_AGE (28*24*60*60)
- struct stat st;
- log_debug(LD_FS, "stat()ing %s", fname);
- if (stat(sandbox_intern_string(fname), &st)==0 &&
- st.st_mtime < now-VERY_OLD_FILE_AGE) {
- char buf[ISO_TIME_LEN+1];
- format_local_iso_time(buf, st.st_mtime);
- log_notice(LD_GENERAL, "Obsolete file %s hasn't been modified since %s. "
- "Removing it.", fname, buf);
- if (unlink(fname) != 0) {
- log_warn(LD_FS, "Failed to unlink %s: %s",
- fname, strerror(errno));
- }
- }
- }
- /** Return a smartlist of ports that must be forwarded by
- * tor-fw-helper. The smartlist contains the ports in a string format
- * that is understandable by tor-fw-helper. */
- smartlist_t *
- get_list_of_ports_to_forward(void)
- {
- smartlist_t *ports_to_forward = smartlist_new();
- int port = 0;
- /** XXX TODO tor-fw-helper does not support forwarding ports to
- other hosts than the local one. If the user is binding to a
- different IP address, tor-fw-helper won't work. */
- port = router_get_advertised_or_port(get_options()); /* Get ORPort */
- if (port)
- smartlist_add_asprintf(ports_to_forward, "%d:%d", port, port);
- port = router_get_advertised_dir_port(get_options(), 0); /* Get DirPort */
- if (port)
- smartlist_add_asprintf(ports_to_forward, "%d:%d", port, port);
- /* Get ports of transport proxies */
- {
- smartlist_t *transport_ports = get_transport_proxy_ports();
- if (transport_ports) {
- smartlist_add_all(ports_to_forward, transport_ports);
- smartlist_free(transport_ports);
- }
- }
- if (!smartlist_len(ports_to_forward)) {
- smartlist_free(ports_to_forward);
- ports_to_forward = NULL;
- }
- return ports_to_forward;
- }
- /** Helper to implement GETINFO functions about configuration variables (not
- * their values). Given a "config/names" question, set *<b>answer</b> to a
- * new string describing the supported configuration variables and their
- * types. */
- int
- getinfo_helper_config(control_connection_t *conn,
- const char *question, char **answer,
- const char **errmsg)
- {
- (void) conn;
- (void) errmsg;
- if (!strcmp(question, "config/names")) {
- smartlist_t *sl = smartlist_new();
- int i;
- for (i = 0; option_vars_[i].name; ++i) {
- const config_var_t *var = &option_vars_[i];
- const char *type;
- /* don't tell controller about triple-underscore options */
- if (!strncmp(option_vars_[i].name, "___", 3))
- continue;
- switch (var->type) {
- case CONFIG_TYPE_STRING: type = "String"; break;
- case CONFIG_TYPE_FILENAME: type = "Filename"; break;
- case CONFIG_TYPE_UINT: type = "Integer"; break;
- case CONFIG_TYPE_INT: type = "SignedInteger"; break;
- case CONFIG_TYPE_PORT: type = "Port"; break;
- case CONFIG_TYPE_INTERVAL: type = "TimeInterval"; break;
- case CONFIG_TYPE_MSEC_INTERVAL: type = "TimeMsecInterval"; break;
- case CONFIG_TYPE_MEMUNIT: type = "DataSize"; break;
- case CONFIG_TYPE_DOUBLE: type = "Float"; break;
- case CONFIG_TYPE_BOOL: type = "Boolean"; break;
- case CONFIG_TYPE_AUTOBOOL: type = "Boolean+Auto"; break;
- case CONFIG_TYPE_ISOTIME: type = "Time"; break;
- case CONFIG_TYPE_ROUTERSET: type = "RouterList"; break;
- case CONFIG_TYPE_CSV: type = "CommaList"; break;
- case CONFIG_TYPE_CSV_INTERVAL: type = "TimeIntervalCommaList"; break;
- case CONFIG_TYPE_LINELIST: type = "LineList"; break;
- case CONFIG_TYPE_LINELIST_S: type = "Dependent"; break;
- case CONFIG_TYPE_LINELIST_V: type = "Virtual"; break;
- default:
- case CONFIG_TYPE_OBSOLETE:
- type = NULL; break;
- }
- if (!type)
- continue;
- smartlist_add_asprintf(sl, "%s %s\n",var->name,type);
- }
- *answer = smartlist_join_strings(sl, "", 0, NULL);
- SMARTLIST_FOREACH(sl, char *, c, tor_free(c));
- smartlist_free(sl);
- } else if (!strcmp(question, "config/defaults")) {
- smartlist_t *sl = smartlist_new();
- int dirauth_lines_seen = 0, fallback_lines_seen = 0;
- for (int i = 0; option_vars_[i].name; ++i) {
- const config_var_t *var = &option_vars_[i];
- if (var->initvalue != NULL) {
- if (strcmp(option_vars_[i].name, "DirAuthority") == 0) {
- /*
- * Count dirauth lines we have a default for; we'll use the
- * count later to decide whether to add the defaults manually
- */
- ++dirauth_lines_seen;
- }
- if (strcmp(option_vars_[i].name, "FallbackDir") == 0) {
- /*
- * Similarly count fallback lines, so that we can decided later
- * to add the defaults manually.
- */
- ++fallback_lines_seen;
- }
- char *val = esc_for_log(var->initvalue);
- smartlist_add_asprintf(sl, "%s %s\n",var->name,val);
- tor_free(val);
- }
- }
- if (dirauth_lines_seen == 0) {
- /*
- * We didn't see any directory authorities with default values,
- * so add the list of default authorities manually.
- */
- /*
- * default_authorities is defined earlier in this file and
- * is a const char ** NULL-terminated array of dirauth config
- * lines.
- */
- for (const char **i = default_authorities; *i != NULL; ++i) {
- char *val = esc_for_log(*i);
- smartlist_add_asprintf(sl, "DirAuthority %s\n", val);
- tor_free(val);
- }
- }
- if (fallback_lines_seen == 0 &&
- get_options()->UseDefaultFallbackDirs == 1) {
- /*
- * We didn't see any explicitly configured fallback mirrors,
- * so add the defaults to the list manually.
- *
- * default_fallbacks is included earlier in this file and
- * is a const char ** NULL-terminated array of fallback config lines.
- */
- const char **i;
- for (i = default_fallbacks; *i != NULL; ++i) {
- char *val = esc_for_log(*i);
- smartlist_add_asprintf(sl, "FallbackDir %s\n", val);
- tor_free(val);
- }
- }
- *answer = smartlist_join_strings(sl, "", 0, NULL);
- SMARTLIST_FOREACH(sl, char *, c, tor_free(c));
- smartlist_free(sl);
- }
- return 0;
- }
- /* Check whether an address has already been set against the options
- * depending on address family and destination type. Any exsting
- * value will lead to a fail, even if it is the same value. If not
- * set and not only validating, copy it into this location too.
- * Returns 0 on success or -1 if this address is already set.
- */
- static int
- verify_and_store_outbound_address(sa_family_t family, tor_addr_t *addr,
- outbound_addr_t type, or_options_t *options, int validate_only)
- {
- if (type>=OUTBOUND_ADDR_MAX || (family!=AF_INET && family!=AF_INET6)) {
- return -1;
- }
- int fam_index=0;
- if (family==AF_INET6) {
- fam_index=1;
- }
- tor_addr_t *dest=&options->OutboundBindAddresses[type][fam_index];
- if (!tor_addr_is_null(dest)) {
- return -1;
- }
- if (!validate_only) {
- tor_addr_copy(dest, addr);
- }
- return 0;
- }
- /* Parse a list of address lines for a specific destination type.
- * Will store them into the options if not validate_only. If a
- * problem occurs, a suitable error message is store in msg.
- * Returns 0 on success or -1 if any address is already set.
- */
- static int
- parse_outbound_address_lines(const config_line_t *lines, outbound_addr_t type,
- or_options_t *options, int validate_only, char **msg)
- {
- tor_addr_t addr;
- sa_family_t family;
- while (lines) {
- family = tor_addr_parse(&addr, lines->value);
- if (verify_and_store_outbound_address(family, &addr, type,
- options, validate_only)) {
- if (msg)
- tor_asprintf(msg, "Multiple%s%s outbound bind addresses "
- "configured: %s",
- family==AF_INET?" IPv4":(family==AF_INET6?" IPv6":""),
- type==OUTBOUND_ADDR_OR?" OR":
- (type==OUTBOUND_ADDR_EXIT?" exit":""), lines->value);
- return -1;
- }
- lines = lines->next;
- }
- return 0;
- }
- /** Parse outbound bind address option lines. If <b>validate_only</b>
- * is not 0 update OutboundBindAddresses in <b>options</b>.
- * Only one address can be set for any of these values.
- * On failure, set <b>msg</b> (if provided) to a newly allocated string
- * containing a description of the problem and return -1.
- */
- static int
- parse_outbound_addresses(or_options_t *options, int validate_only, char **msg)
- {
- if (!validate_only) {
- memset(&options->OutboundBindAddresses, 0,
- sizeof(options->OutboundBindAddresses));
- }
- parse_outbound_address_lines(options->OutboundBindAddress,
- OUTBOUND_ADDR_EXIT_AND_OR, options, validate_only, msg);
- parse_outbound_address_lines(options->OutboundBindAddressOR,
- OUTBOUND_ADDR_OR, options, validate_only, msg);
- parse_outbound_address_lines(options->OutboundBindAddressExit,
- OUTBOUND_ADDR_EXIT, options, validate_only, msg);
- return 0;
- }
- /** Load one of the geoip files, <a>family</a> determining which
- * one. <a>default_fname</a> is used if on Windows and
- * <a>fname</a> equals "<default>". */
- static void
- config_load_geoip_file_(sa_family_t family,
- const char *fname,
- const char *default_fname)
- {
- #ifdef _WIN32
- char *free_fname = NULL; /* Used to hold any temporary-allocated value */
- /* XXXX Don't use this "<default>" junk; make our filename options
- * understand prefixes somehow. -NM */
- if (!strcmp(fname, "<default>")) {
- const char *conf_root = get_windows_conf_root();
- tor_asprintf(&free_fname, "%s\\%s", conf_root, default_fname);
- fname = free_fname;
- }
- geoip_load_file(family, fname);
- tor_free(free_fname);
- #else
- (void)default_fname;
- geoip_load_file(family, fname);
- #endif
- }
- /** Load geoip files for IPv4 and IPv6 if <a>options</a> and
- * <a>old_options</a> indicate we should. */
- static void
- config_maybe_load_geoip_files_(const or_options_t *options,
- const or_options_t *old_options)
- {
- /* XXXX Reload GeoIPFile on SIGHUP. -NM */
- if (options->GeoIPFile &&
- ((!old_options || !opt_streq(old_options->GeoIPFile,
- options->GeoIPFile))
- || !geoip_is_loaded(AF_INET)))
- config_load_geoip_file_(AF_INET, options->GeoIPFile, "geoip");
- if (options->GeoIPv6File &&
- ((!old_options || !opt_streq(old_options->GeoIPv6File,
- options->GeoIPv6File))
- || !geoip_is_loaded(AF_INET6)))
- config_load_geoip_file_(AF_INET6, options->GeoIPv6File, "geoip6");
- }
- /** Initialize cookie authentication (used so far by the ControlPort
- * and Extended ORPort).
- *
- * Allocate memory and create a cookie (of length <b>cookie_len</b>)
- * in <b>cookie_out</b>.
- * Then write it down to <b>fname</b> and prepend it with <b>header</b>.
- *
- * If <b>group_readable</b> is set, set <b>fname</b> to be readable
- * by the default GID.
- *
- * If the whole procedure was successful, set
- * <b>cookie_is_set_out</b> to True. */
- int
- init_cookie_authentication(const char *fname, const char *header,
- int cookie_len, int group_readable,
- uint8_t **cookie_out, int *cookie_is_set_out)
- {
- char cookie_file_str_len = strlen(header) + cookie_len;
- char *cookie_file_str = tor_malloc(cookie_file_str_len);
- int retval = -1;
- /* We don't want to generate a new cookie every time we call
- * options_act(). One should be enough. */
- if (*cookie_is_set_out) {
- retval = 0; /* we are all set */
- goto done;
- }
- /* If we've already set the cookie, free it before re-setting
- it. This can happen if we previously generated a cookie, but
- couldn't write it to a disk. */
- if (*cookie_out)
- tor_free(*cookie_out);
- /* Generate the cookie */
- *cookie_out = tor_malloc(cookie_len);
- crypto_rand((char *)*cookie_out, cookie_len);
- /* Create the string that should be written on the file. */
- memcpy(cookie_file_str, header, strlen(header));
- memcpy(cookie_file_str+strlen(header), *cookie_out, cookie_len);
- if (write_bytes_to_file(fname, cookie_file_str, cookie_file_str_len, 1)) {
- log_warn(LD_FS,"Error writing auth cookie to %s.", escaped(fname));
- goto done;
- }
- #ifndef _WIN32
- if (group_readable) {
- if (chmod(fname, 0640)) {
- log_warn(LD_FS,"Unable to make %s group-readable.", escaped(fname));
- }
- }
- #else
- (void) group_readable;
- #endif
- /* Success! */
- log_info(LD_GENERAL, "Generated auth cookie file in '%s'.", escaped(fname));
- *cookie_is_set_out = 1;
- retval = 0;
- done:
- memwipe(cookie_file_str, 0, cookie_file_str_len);
- tor_free(cookie_file_str);
- return retval;
- }
|