control.c 214 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449
  1. /* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  2. * Copyright (c) 2007-2015, The Tor Project, Inc. */
  3. /* See LICENSE for licensing information */
  4. /**
  5. * \file control.c
  6. * \brief Implementation for Tor's control-socket interface.
  7. * See doc/spec/control-spec.txt for full details on protocol.
  8. **/
  9. #define CONTROL_PRIVATE
  10. #include "or.h"
  11. #include "addressmap.h"
  12. #include "buffers.h"
  13. #include "channel.h"
  14. #include "channeltls.h"
  15. #include "circuitbuild.h"
  16. #include "circuitlist.h"
  17. #include "circuitstats.h"
  18. #include "circuituse.h"
  19. #include "command.h"
  20. #include "compat_libevent.h"
  21. #include "config.h"
  22. #include "confparse.h"
  23. #include "connection.h"
  24. #include "connection_edge.h"
  25. #include "connection_or.h"
  26. #include "control.h"
  27. #include "directory.h"
  28. #include "dirserv.h"
  29. #include "dnsserv.h"
  30. #include "entrynodes.h"
  31. #include "geoip.h"
  32. #include "hibernate.h"
  33. #include "main.h"
  34. #include "networkstatus.h"
  35. #include "nodelist.h"
  36. #include "policies.h"
  37. #include "reasons.h"
  38. #include "rendclient.h"
  39. #include "rendcommon.h"
  40. #include "rendservice.h"
  41. #include "rephist.h"
  42. #include "router.h"
  43. #include "routerlist.h"
  44. #include "routerparse.h"
  45. #ifndef _WIN32
  46. #include <pwd.h>
  47. #include <sys/resource.h>
  48. #endif
  49. #ifdef HAVE_EVENT2_EVENT_H
  50. #include <event2/event.h>
  51. #else
  52. #include <event.h>
  53. #endif
  54. #include "crypto_s2k.h"
  55. #include "procmon.h"
  56. /** Yield true iff <b>s</b> is the state of a control_connection_t that has
  57. * finished authentication and is accepting commands. */
  58. #define STATE_IS_OPEN(s) ((s) == CONTROL_CONN_STATE_OPEN)
  59. /** Bitfield: The bit 1&lt;&lt;e is set if <b>any</b> open control
  60. * connection is interested in events of type <b>e</b>. We use this
  61. * so that we can decide to skip generating event messages that nobody
  62. * has interest in without having to walk over the global connection
  63. * list to find out.
  64. **/
  65. typedef uint64_t event_mask_t;
  66. /** An event mask of all the events that any controller is interested in
  67. * receiving. */
  68. static event_mask_t global_event_mask = 0;
  69. /** True iff we have disabled log messages from being sent to the controller */
  70. static int disable_log_messages = 0;
  71. /** Macro: true if any control connection is interested in events of type
  72. * <b>e</b>. */
  73. #define EVENT_IS_INTERESTING(e) \
  74. (!! (global_event_mask & EVENT_MASK_(e)))
  75. /** If we're using cookie-type authentication, how long should our cookies be?
  76. */
  77. #define AUTHENTICATION_COOKIE_LEN 32
  78. /** If true, we've set authentication_cookie to a secret code and
  79. * stored it to disk. */
  80. static int authentication_cookie_is_set = 0;
  81. /** If authentication_cookie_is_set, a secret cookie that we've stored to disk
  82. * and which we're using to authenticate controllers. (If the controller can
  83. * read it off disk, it has permission to connect.) */
  84. static uint8_t *authentication_cookie = NULL;
  85. #define SAFECOOKIE_SERVER_TO_CONTROLLER_CONSTANT \
  86. "Tor safe cookie authentication server-to-controller hash"
  87. #define SAFECOOKIE_CONTROLLER_TO_SERVER_CONSTANT \
  88. "Tor safe cookie authentication controller-to-server hash"
  89. #define SAFECOOKIE_SERVER_NONCE_LEN DIGEST256_LEN
  90. /** The list of onion services that have been added via ADD_ONION that do not
  91. * belong to any particular control connection.
  92. */
  93. static smartlist_t *detached_onion_services = NULL;
  94. /** A sufficiently large size to record the last bootstrap phase string. */
  95. #define BOOTSTRAP_MSG_LEN 1024
  96. /** What was the last bootstrap phase message we sent? We keep track
  97. * of this so we can respond to getinfo status/bootstrap-phase queries. */
  98. static char last_sent_bootstrap_message[BOOTSTRAP_MSG_LEN];
  99. static void connection_printf_to_buf(control_connection_t *conn,
  100. const char *format, ...)
  101. CHECK_PRINTF(2,3);
  102. static void send_control_event_impl(uint16_t event, event_format_t which,
  103. const char *format, va_list ap)
  104. CHECK_PRINTF(3,0);
  105. static int control_event_status(int type, int severity, const char *format,
  106. va_list args)
  107. CHECK_PRINTF(3,0);
  108. static void send_control_done(control_connection_t *conn);
  109. static void send_control_event(uint16_t event, event_format_t which,
  110. const char *format, ...)
  111. CHECK_PRINTF(3,4);
  112. static int handle_control_setconf(control_connection_t *conn, uint32_t len,
  113. char *body);
  114. static int handle_control_resetconf(control_connection_t *conn, uint32_t len,
  115. char *body);
  116. static int handle_control_getconf(control_connection_t *conn, uint32_t len,
  117. const char *body);
  118. static int handle_control_loadconf(control_connection_t *conn, uint32_t len,
  119. const char *body);
  120. static int handle_control_setevents(control_connection_t *conn, uint32_t len,
  121. const char *body);
  122. static int handle_control_authenticate(control_connection_t *conn,
  123. uint32_t len,
  124. const char *body);
  125. static int handle_control_signal(control_connection_t *conn, uint32_t len,
  126. const char *body);
  127. static int handle_control_mapaddress(control_connection_t *conn, uint32_t len,
  128. const char *body);
  129. static char *list_getinfo_options(void);
  130. static int handle_control_getinfo(control_connection_t *conn, uint32_t len,
  131. const char *body);
  132. static int handle_control_extendcircuit(control_connection_t *conn,
  133. uint32_t len,
  134. const char *body);
  135. static int handle_control_setcircuitpurpose(control_connection_t *conn,
  136. uint32_t len, const char *body);
  137. static int handle_control_attachstream(control_connection_t *conn,
  138. uint32_t len,
  139. const char *body);
  140. static int handle_control_postdescriptor(control_connection_t *conn,
  141. uint32_t len,
  142. const char *body);
  143. static int handle_control_redirectstream(control_connection_t *conn,
  144. uint32_t len,
  145. const char *body);
  146. static int handle_control_closestream(control_connection_t *conn, uint32_t len,
  147. const char *body);
  148. static int handle_control_closecircuit(control_connection_t *conn,
  149. uint32_t len,
  150. const char *body);
  151. static int handle_control_resolve(control_connection_t *conn, uint32_t len,
  152. const char *body);
  153. static int handle_control_usefeature(control_connection_t *conn,
  154. uint32_t len,
  155. const char *body);
  156. static int handle_control_hsfetch(control_connection_t *conn, uint32_t len,
  157. const char *body);
  158. static int handle_control_hspost(control_connection_t *conn, uint32_t len,
  159. const char *body);
  160. static int handle_control_add_onion(control_connection_t *conn, uint32_t len,
  161. const char *body);
  162. static int handle_control_del_onion(control_connection_t *conn, uint32_t len,
  163. const char *body);
  164. static int write_stream_target_to_buf(entry_connection_t *conn, char *buf,
  165. size_t len);
  166. static void orconn_target_get_name(char *buf, size_t len,
  167. or_connection_t *conn);
  168. static int get_cached_network_liveness(void);
  169. static void set_cached_network_liveness(int liveness);
  170. static void flush_queued_events_cb(evutil_socket_t fd, short what, void *arg);
  171. /** Given a control event code for a message event, return the corresponding
  172. * log severity. */
  173. static INLINE int
  174. event_to_log_severity(int event)
  175. {
  176. switch (event) {
  177. case EVENT_DEBUG_MSG: return LOG_DEBUG;
  178. case EVENT_INFO_MSG: return LOG_INFO;
  179. case EVENT_NOTICE_MSG: return LOG_NOTICE;
  180. case EVENT_WARN_MSG: return LOG_WARN;
  181. case EVENT_ERR_MSG: return LOG_ERR;
  182. default: return -1;
  183. }
  184. }
  185. /** Given a log severity, return the corresponding control event code. */
  186. static INLINE int
  187. log_severity_to_event(int severity)
  188. {
  189. switch (severity) {
  190. case LOG_DEBUG: return EVENT_DEBUG_MSG;
  191. case LOG_INFO: return EVENT_INFO_MSG;
  192. case LOG_NOTICE: return EVENT_NOTICE_MSG;
  193. case LOG_WARN: return EVENT_WARN_MSG;
  194. case LOG_ERR: return EVENT_ERR_MSG;
  195. default: return -1;
  196. }
  197. }
  198. /** Helper: clear bandwidth counters of all origin circuits. */
  199. static void
  200. clear_circ_bw_fields(void)
  201. {
  202. origin_circuit_t *ocirc;
  203. SMARTLIST_FOREACH_BEGIN(circuit_get_global_list(), circuit_t *, circ) {
  204. if (!CIRCUIT_IS_ORIGIN(circ))
  205. continue;
  206. ocirc = TO_ORIGIN_CIRCUIT(circ);
  207. ocirc->n_written_circ_bw = ocirc->n_read_circ_bw = 0;
  208. }
  209. SMARTLIST_FOREACH_END(circ);
  210. }
  211. /** Set <b>global_event_mask*</b> to the bitwise OR of each live control
  212. * connection's event_mask field. */
  213. void
  214. control_update_global_event_mask(void)
  215. {
  216. smartlist_t *conns = get_connection_array();
  217. event_mask_t old_mask, new_mask;
  218. old_mask = global_event_mask;
  219. global_event_mask = 0;
  220. SMARTLIST_FOREACH(conns, connection_t *, _conn,
  221. {
  222. if (_conn->type == CONN_TYPE_CONTROL &&
  223. STATE_IS_OPEN(_conn->state)) {
  224. control_connection_t *conn = TO_CONTROL_CONN(_conn);
  225. global_event_mask |= conn->event_mask;
  226. }
  227. });
  228. new_mask = global_event_mask;
  229. /* Handle the aftermath. Set up the log callback to tell us only what
  230. * we want to hear...*/
  231. control_adjust_event_log_severity();
  232. /* ...then, if we've started logging stream or circ bw, clear the
  233. * appropriate fields. */
  234. if (! (old_mask & EVENT_STREAM_BANDWIDTH_USED) &&
  235. (new_mask & EVENT_STREAM_BANDWIDTH_USED)) {
  236. SMARTLIST_FOREACH(conns, connection_t *, conn,
  237. {
  238. if (conn->type == CONN_TYPE_AP) {
  239. edge_connection_t *edge_conn = TO_EDGE_CONN(conn);
  240. edge_conn->n_written = edge_conn->n_read = 0;
  241. }
  242. });
  243. }
  244. if (! (old_mask & EVENT_CIRC_BANDWIDTH_USED) &&
  245. (new_mask & EVENT_CIRC_BANDWIDTH_USED)) {
  246. clear_circ_bw_fields();
  247. }
  248. }
  249. /** Adjust the log severities that result in control_event_logmsg being called
  250. * to match the severity of log messages that any controllers are interested
  251. * in. */
  252. void
  253. control_adjust_event_log_severity(void)
  254. {
  255. int i;
  256. int min_log_event=EVENT_ERR_MSG, max_log_event=EVENT_DEBUG_MSG;
  257. for (i = EVENT_DEBUG_MSG; i <= EVENT_ERR_MSG; ++i) {
  258. if (EVENT_IS_INTERESTING(i)) {
  259. min_log_event = i;
  260. break;
  261. }
  262. }
  263. for (i = EVENT_ERR_MSG; i >= EVENT_DEBUG_MSG; --i) {
  264. if (EVENT_IS_INTERESTING(i)) {
  265. max_log_event = i;
  266. break;
  267. }
  268. }
  269. if (EVENT_IS_INTERESTING(EVENT_STATUS_GENERAL)) {
  270. if (min_log_event > EVENT_NOTICE_MSG)
  271. min_log_event = EVENT_NOTICE_MSG;
  272. if (max_log_event < EVENT_ERR_MSG)
  273. max_log_event = EVENT_ERR_MSG;
  274. }
  275. if (min_log_event <= max_log_event)
  276. change_callback_log_severity(event_to_log_severity(min_log_event),
  277. event_to_log_severity(max_log_event),
  278. control_event_logmsg);
  279. else
  280. change_callback_log_severity(LOG_ERR, LOG_ERR,
  281. control_event_logmsg);
  282. }
  283. /** Return true iff the event with code <b>c</b> is being sent to any current
  284. * control connection. This is useful if the amount of work needed to prepare
  285. * to call the appropriate control_event_...() function is high.
  286. */
  287. int
  288. control_event_is_interesting(int event)
  289. {
  290. return EVENT_IS_INTERESTING(event);
  291. }
  292. /** Append a NUL-terminated string <b>s</b> to the end of
  293. * <b>conn</b>-\>outbuf.
  294. */
  295. static INLINE void
  296. connection_write_str_to_buf(const char *s, control_connection_t *conn)
  297. {
  298. size_t len = strlen(s);
  299. connection_write_to_buf(s, len, TO_CONN(conn));
  300. }
  301. /** Given a <b>len</b>-character string in <b>data</b>, made of lines
  302. * terminated by CRLF, allocate a new string in *<b>out</b>, and copy the
  303. * contents of <b>data</b> into *<b>out</b>, adding a period before any period
  304. * that appears at the start of a line, and adding a period-CRLF line at
  305. * the end. Replace all LF characters sequences with CRLF. Return the number
  306. * of bytes in *<b>out</b>.
  307. */
  308. STATIC size_t
  309. write_escaped_data(const char *data, size_t len, char **out)
  310. {
  311. size_t sz_out = len+8;
  312. char *outp;
  313. const char *start = data, *end;
  314. int i;
  315. int start_of_line;
  316. for (i=0; i<(int)len; ++i) {
  317. if (data[i]== '\n')
  318. sz_out += 2; /* Maybe add a CR; maybe add a dot. */
  319. }
  320. *out = outp = tor_malloc(sz_out+1);
  321. end = data+len;
  322. start_of_line = 1;
  323. while (data < end) {
  324. if (*data == '\n') {
  325. if (data > start && data[-1] != '\r')
  326. *outp++ = '\r';
  327. start_of_line = 1;
  328. } else if (*data == '.') {
  329. if (start_of_line) {
  330. start_of_line = 0;
  331. *outp++ = '.';
  332. }
  333. } else {
  334. start_of_line = 0;
  335. }
  336. *outp++ = *data++;
  337. }
  338. if (outp < *out+2 || fast_memcmp(outp-2, "\r\n", 2)) {
  339. *outp++ = '\r';
  340. *outp++ = '\n';
  341. }
  342. *outp++ = '.';
  343. *outp++ = '\r';
  344. *outp++ = '\n';
  345. *outp = '\0'; /* NUL-terminate just in case. */
  346. tor_assert((outp - *out) <= (int)sz_out);
  347. return outp - *out;
  348. }
  349. /** Given a <b>len</b>-character string in <b>data</b>, made of lines
  350. * terminated by CRLF, allocate a new string in *<b>out</b>, and copy
  351. * the contents of <b>data</b> into *<b>out</b>, removing any period
  352. * that appears at the start of a line, and replacing all CRLF sequences
  353. * with LF. Return the number of
  354. * bytes in *<b>out</b>. */
  355. STATIC size_t
  356. read_escaped_data(const char *data, size_t len, char **out)
  357. {
  358. char *outp;
  359. const char *next;
  360. const char *end;
  361. *out = outp = tor_malloc(len+1);
  362. end = data+len;
  363. while (data < end) {
  364. /* we're at the start of a line. */
  365. if (*data == '.')
  366. ++data;
  367. next = memchr(data, '\n', end-data);
  368. if (next) {
  369. size_t n_to_copy = next-data;
  370. /* Don't copy a CR that precedes this LF. */
  371. if (n_to_copy && *(next-1) == '\r')
  372. --n_to_copy;
  373. memcpy(outp, data, n_to_copy);
  374. outp += n_to_copy;
  375. data = next+1; /* This will point at the start of the next line,
  376. * or the end of the string, or a period. */
  377. } else {
  378. memcpy(outp, data, end-data);
  379. outp += (end-data);
  380. *outp = '\0';
  381. return outp - *out;
  382. }
  383. *outp++ = '\n';
  384. }
  385. *outp = '\0';
  386. return outp - *out;
  387. }
  388. /** If the first <b>in_len_max</b> characters in <b>start</b> contain a
  389. * double-quoted string with escaped characters, return the length of that
  390. * string (as encoded, including quotes). Otherwise return -1. */
  391. static INLINE int
  392. get_escaped_string_length(const char *start, size_t in_len_max,
  393. int *chars_out)
  394. {
  395. const char *cp, *end;
  396. int chars = 0;
  397. if (*start != '\"')
  398. return -1;
  399. cp = start+1;
  400. end = start+in_len_max;
  401. /* Calculate length. */
  402. while (1) {
  403. if (cp >= end) {
  404. return -1; /* Too long. */
  405. } else if (*cp == '\\') {
  406. if (++cp == end)
  407. return -1; /* Can't escape EOS. */
  408. ++cp;
  409. ++chars;
  410. } else if (*cp == '\"') {
  411. break;
  412. } else {
  413. ++cp;
  414. ++chars;
  415. }
  416. }
  417. if (chars_out)
  418. *chars_out = chars;
  419. return (int)(cp - start+1);
  420. }
  421. /** As decode_escaped_string, but does not decode the string: copies the
  422. * entire thing, including quotation marks. */
  423. static const char *
  424. extract_escaped_string(const char *start, size_t in_len_max,
  425. char **out, size_t *out_len)
  426. {
  427. int length = get_escaped_string_length(start, in_len_max, NULL);
  428. if (length<0)
  429. return NULL;
  430. *out_len = length;
  431. *out = tor_strndup(start, *out_len);
  432. return start+length;
  433. }
  434. /** Given a pointer to a string starting at <b>start</b> containing
  435. * <b>in_len_max</b> characters, decode a string beginning with one double
  436. * quote, containing any number of non-quote characters or characters escaped
  437. * with a backslash, and ending with a final double quote. Place the resulting
  438. * string (unquoted, unescaped) into a newly allocated string in *<b>out</b>;
  439. * store its length in <b>out_len</b>. On success, return a pointer to the
  440. * character immediately following the escaped string. On failure, return
  441. * NULL. */
  442. static const char *
  443. decode_escaped_string(const char *start, size_t in_len_max,
  444. char **out, size_t *out_len)
  445. {
  446. const char *cp, *end;
  447. char *outp;
  448. int len, n_chars = 0;
  449. len = get_escaped_string_length(start, in_len_max, &n_chars);
  450. if (len<0)
  451. return NULL;
  452. end = start+len-1; /* Index of last quote. */
  453. tor_assert(*end == '\"');
  454. outp = *out = tor_malloc(len+1);
  455. *out_len = n_chars;
  456. cp = start+1;
  457. while (cp < end) {
  458. if (*cp == '\\')
  459. ++cp;
  460. *outp++ = *cp++;
  461. }
  462. *outp = '\0';
  463. tor_assert((outp - *out) == (int)*out_len);
  464. return end+1;
  465. }
  466. /** Acts like sprintf, but writes its formatted string to the end of
  467. * <b>conn</b>-\>outbuf. */
  468. static void
  469. connection_printf_to_buf(control_connection_t *conn, const char *format, ...)
  470. {
  471. va_list ap;
  472. char *buf = NULL;
  473. int len;
  474. va_start(ap,format);
  475. len = tor_vasprintf(&buf, format, ap);
  476. va_end(ap);
  477. if (len < 0) {
  478. log_err(LD_BUG, "Unable to format string for controller.");
  479. tor_assert(0);
  480. }
  481. connection_write_to_buf(buf, (size_t)len, TO_CONN(conn));
  482. tor_free(buf);
  483. }
  484. /** Write all of the open control ports to ControlPortWriteToFile */
  485. void
  486. control_ports_write_to_file(void)
  487. {
  488. smartlist_t *lines;
  489. char *joined = NULL;
  490. const or_options_t *options = get_options();
  491. if (!options->ControlPortWriteToFile)
  492. return;
  493. lines = smartlist_new();
  494. SMARTLIST_FOREACH_BEGIN(get_connection_array(), const connection_t *, conn) {
  495. if (conn->type != CONN_TYPE_CONTROL_LISTENER || conn->marked_for_close)
  496. continue;
  497. #ifdef AF_UNIX
  498. if (conn->socket_family == AF_UNIX) {
  499. smartlist_add_asprintf(lines, "UNIX_PORT=%s\n", conn->address);
  500. continue;
  501. }
  502. #endif
  503. smartlist_add_asprintf(lines, "PORT=%s:%d\n", conn->address, conn->port);
  504. } SMARTLIST_FOREACH_END(conn);
  505. joined = smartlist_join_strings(lines, "", 0, NULL);
  506. if (write_str_to_file(options->ControlPortWriteToFile, joined, 0) < 0) {
  507. log_warn(LD_CONTROL, "Writing %s failed: %s",
  508. options->ControlPortWriteToFile, strerror(errno));
  509. }
  510. #ifndef _WIN32
  511. if (options->ControlPortFileGroupReadable) {
  512. if (chmod(options->ControlPortWriteToFile, 0640)) {
  513. log_warn(LD_FS,"Unable to make %s group-readable.",
  514. options->ControlPortWriteToFile);
  515. }
  516. }
  517. #endif
  518. tor_free(joined);
  519. SMARTLIST_FOREACH(lines, char *, cp, tor_free(cp));
  520. smartlist_free(lines);
  521. }
  522. /** Send a "DONE" message down the control connection <b>conn</b>. */
  523. static void
  524. send_control_done(control_connection_t *conn)
  525. {
  526. connection_write_str_to_buf("250 OK\r\n", conn);
  527. }
  528. /** Represents an event that's queued to be sent to one or more
  529. * controllers. */
  530. typedef struct queued_event_s {
  531. uint16_t event;
  532. char *msg;
  533. } queued_event_t;
  534. /** If this is greater than 0, we don't allow new events to be queued. */
  535. static int block_event_queue = 0;
  536. /** Holds a smartlist of queued_event_t objects that may need to be sent
  537. * to one or more controllers */
  538. static smartlist_t *queued_control_events = NULL;
  539. /** An event that should fire in order to flush the contents of
  540. * queued_control_events. */
  541. static struct event *flush_queued_events_event = NULL;
  542. /** Helper: inserts an event on the list of events queued to be sent to
  543. * one or more controllers, and schedules the events to be flushed if needed.
  544. *
  545. * This function takes ownership of <b>msg</b>, and may free it.
  546. *
  547. * We queue these events rather than send them immediately in order to break
  548. * the dependency in our callgraph from code that generates events for the
  549. * controller, and the network layer at large. Otherwise, nearly every
  550. * interesting part of Tor would potentially call every other interesting part
  551. * of Tor.
  552. */
  553. MOCK_IMPL(STATIC void,
  554. queue_control_event_string,(uint16_t event, char *msg))
  555. {
  556. if (PREDICT_UNLIKELY(queued_control_events == NULL)) {
  557. queued_control_events = smartlist_new();
  558. }
  559. /* This is redundant with checks done elsewhere, but it's a last-ditch
  560. * attempt to avoid queueing something we shouldn't have to queue. */
  561. if (PREDICT_UNLIKELY( ! EVENT_IS_INTERESTING(event) )) {
  562. tor_free(msg);
  563. return;
  564. }
  565. if (block_event_queue) {
  566. tor_free(msg);
  567. return;
  568. }
  569. /* No queueing an event while queueing an event */
  570. ++block_event_queue;
  571. queued_event_t *ev = tor_malloc(sizeof(*ev));
  572. ev->event = event;
  573. ev->msg = msg;
  574. smartlist_add(queued_control_events, ev);
  575. /* We just put the first event on the queue; mark the queue to be
  576. * flushed.
  577. */
  578. if (smartlist_len(queued_control_events) == 1) {
  579. if (PREDICT_UNLIKELY(flush_queued_events_event == NULL)) {
  580. struct event_base *b = tor_libevent_get_base();
  581. tor_assert(b);
  582. flush_queued_events_event = tor_event_new(b,
  583. -1, 0, flush_queued_events_cb,
  584. NULL);
  585. tor_assert(flush_queued_events_event);
  586. }
  587. event_active(flush_queued_events_event, EV_READ, 1);
  588. }
  589. --block_event_queue;
  590. }
  591. /** Release all storage held by <b>ev</b>. */
  592. static void
  593. queued_event_free(queued_event_t *ev)
  594. {
  595. if (ev == NULL)
  596. return;
  597. tor_free(ev->msg);
  598. tor_free(ev);
  599. }
  600. /** Send every queued event to every controller that's interested in it,
  601. * and remove the events from the queue. If <b>force</b> is true,
  602. * then make all controllers send their data out immediately, since we
  603. * may be about to shut down. */
  604. static void
  605. queued_events_flush_all(int force)
  606. {
  607. smartlist_t *all_conns = get_connection_array();
  608. smartlist_t *controllers = smartlist_new();
  609. if (PREDICT_UNLIKELY(queued_control_events == NULL)) {
  610. return;
  611. }
  612. /* No queueing an event while flushing events. */
  613. ++block_event_queue;
  614. /* Gather all the controllers that will care... */
  615. SMARTLIST_FOREACH_BEGIN(all_conns, connection_t *, conn) {
  616. if (conn->type == CONN_TYPE_CONTROL &&
  617. !conn->marked_for_close &&
  618. conn->state == CONTROL_CONN_STATE_OPEN) {
  619. control_connection_t *control_conn = TO_CONTROL_CONN(conn);
  620. smartlist_add(controllers, control_conn);
  621. }
  622. } SMARTLIST_FOREACH_END(conn);
  623. SMARTLIST_FOREACH_BEGIN(queued_control_events, queued_event_t *, ev) {
  624. const event_mask_t bit = ((event_mask_t)1) << ev->event;
  625. const size_t msg_len = strlen(ev->msg);
  626. SMARTLIST_FOREACH_BEGIN(controllers, control_connection_t *,
  627. control_conn) {
  628. if (control_conn->event_mask & bit) {
  629. connection_write_to_buf(ev->msg, msg_len, TO_CONN(control_conn));
  630. }
  631. } SMARTLIST_FOREACH_END(control_conn);
  632. queued_event_free(ev);
  633. } SMARTLIST_FOREACH_END(ev);
  634. if (force) {
  635. SMARTLIST_FOREACH_BEGIN(controllers, control_connection_t *,
  636. control_conn) {
  637. connection_flush(TO_CONN(control_conn));
  638. } SMARTLIST_FOREACH_END(control_conn);
  639. }
  640. smartlist_clear(queued_control_events);
  641. smartlist_free(controllers);
  642. --block_event_queue;
  643. }
  644. /** Libevent callback: Flushes pending events to controllers that are
  645. * interested in them */
  646. static void
  647. flush_queued_events_cb(evutil_socket_t fd, short what, void *arg)
  648. {
  649. (void) fd;
  650. (void) what;
  651. (void) arg;
  652. queued_events_flush_all(0);
  653. }
  654. /** Send an event to all v1 controllers that are listening for code
  655. * <b>event</b>. The event's body is given by <b>msg</b>.
  656. *
  657. * If <b>which</b> & SHORT_NAMES, the event contains short-format names: send
  658. * it to controllers that haven't enabled the VERBOSE_NAMES feature. If
  659. * <b>which</b> & LONG_NAMES, the event contains long-format names: send it
  660. * to controllers that <em>have</em> enabled VERBOSE_NAMES.
  661. *
  662. * The EXTENDED_FORMAT and NONEXTENDED_FORMAT flags behave similarly with
  663. * respect to the EXTENDED_EVENTS feature. */
  664. MOCK_IMPL(STATIC void,
  665. send_control_event_string,(uint16_t event, event_format_t which,
  666. const char *msg))
  667. {
  668. (void) which;
  669. tor_assert(event >= EVENT_MIN_ && event <= EVENT_MAX_);
  670. queue_control_event_string(event, tor_strdup(msg));
  671. }
  672. /** Helper for send_control_event and control_event_status:
  673. * Send an event to all v1 controllers that are listening for code
  674. * <b>event</b>. The event's body is created by the printf-style format in
  675. * <b>format</b>, and other arguments as provided. */
  676. static void
  677. send_control_event_impl(uint16_t event, event_format_t which,
  678. const char *format, va_list ap)
  679. {
  680. (void) which;
  681. char *buf = NULL;
  682. int len;
  683. len = tor_vasprintf(&buf, format, ap);
  684. if (len < 0) {
  685. log_warn(LD_BUG, "Unable to format event for controller.");
  686. return;
  687. }
  688. queue_control_event_string(event, buf);
  689. }
  690. /** Send an event to all v1 controllers that are listening for code
  691. * <b>event</b>. The event's body is created by the printf-style format in
  692. * <b>format</b>, and other arguments as provided. */
  693. static void
  694. send_control_event(uint16_t event, event_format_t which,
  695. const char *format, ...)
  696. {
  697. va_list ap;
  698. va_start(ap, format);
  699. send_control_event_impl(event, which, format, ap);
  700. va_end(ap);
  701. }
  702. /** Given a text circuit <b>id</b>, return the corresponding circuit. */
  703. static origin_circuit_t *
  704. get_circ(const char *id)
  705. {
  706. uint32_t n_id;
  707. int ok;
  708. n_id = (uint32_t) tor_parse_ulong(id, 10, 0, UINT32_MAX, &ok, NULL);
  709. if (!ok)
  710. return NULL;
  711. return circuit_get_by_global_id(n_id);
  712. }
  713. /** Given a text stream <b>id</b>, return the corresponding AP connection. */
  714. static entry_connection_t *
  715. get_stream(const char *id)
  716. {
  717. uint64_t n_id;
  718. int ok;
  719. connection_t *conn;
  720. n_id = tor_parse_uint64(id, 10, 0, UINT64_MAX, &ok, NULL);
  721. if (!ok)
  722. return NULL;
  723. conn = connection_get_by_global_id(n_id);
  724. if (!conn || conn->type != CONN_TYPE_AP || conn->marked_for_close)
  725. return NULL;
  726. return TO_ENTRY_CONN(conn);
  727. }
  728. /** Helper for setconf and resetconf. Acts like setconf, except
  729. * it passes <b>use_defaults</b> on to options_trial_assign(). Modifies the
  730. * contents of body.
  731. */
  732. static int
  733. control_setconf_helper(control_connection_t *conn, uint32_t len, char *body,
  734. int use_defaults)
  735. {
  736. setopt_err_t opt_err;
  737. config_line_t *lines=NULL;
  738. char *start = body;
  739. char *errstring = NULL;
  740. const int clear_first = 1;
  741. char *config;
  742. smartlist_t *entries = smartlist_new();
  743. /* We have a string, "body", of the format '(key(=val|="val")?)' entries
  744. * separated by space. break it into a list of configuration entries. */
  745. while (*body) {
  746. char *eq = body;
  747. char *key;
  748. char *entry;
  749. while (!TOR_ISSPACE(*eq) && *eq != '=')
  750. ++eq;
  751. key = tor_strndup(body, eq-body);
  752. body = eq+1;
  753. if (*eq == '=') {
  754. char *val=NULL;
  755. size_t val_len=0;
  756. if (*body != '\"') {
  757. char *val_start = body;
  758. while (!TOR_ISSPACE(*body))
  759. body++;
  760. val = tor_strndup(val_start, body-val_start);
  761. val_len = strlen(val);
  762. } else {
  763. body = (char*)extract_escaped_string(body, (len - (body-start)),
  764. &val, &val_len);
  765. if (!body) {
  766. connection_write_str_to_buf("551 Couldn't parse string\r\n", conn);
  767. SMARTLIST_FOREACH(entries, char *, cp, tor_free(cp));
  768. smartlist_free(entries);
  769. tor_free(key);
  770. return 0;
  771. }
  772. }
  773. tor_asprintf(&entry, "%s %s", key, val);
  774. tor_free(key);
  775. tor_free(val);
  776. } else {
  777. entry = key;
  778. }
  779. smartlist_add(entries, entry);
  780. while (TOR_ISSPACE(*body))
  781. ++body;
  782. }
  783. smartlist_add(entries, tor_strdup(""));
  784. config = smartlist_join_strings(entries, "\n", 0, NULL);
  785. SMARTLIST_FOREACH(entries, char *, cp, tor_free(cp));
  786. smartlist_free(entries);
  787. if (config_get_lines(config, &lines, 0) < 0) {
  788. log_warn(LD_CONTROL,"Controller gave us config lines we can't parse.");
  789. connection_write_str_to_buf("551 Couldn't parse configuration\r\n",
  790. conn);
  791. tor_free(config);
  792. return 0;
  793. }
  794. tor_free(config);
  795. opt_err = options_trial_assign(lines, use_defaults, clear_first, &errstring);
  796. {
  797. const char *msg;
  798. switch (opt_err) {
  799. case SETOPT_ERR_MISC:
  800. msg = "552 Unrecognized option";
  801. break;
  802. case SETOPT_ERR_PARSE:
  803. msg = "513 Unacceptable option value";
  804. break;
  805. case SETOPT_ERR_TRANSITION:
  806. msg = "553 Transition not allowed";
  807. break;
  808. case SETOPT_ERR_SETTING:
  809. default:
  810. msg = "553 Unable to set option";
  811. break;
  812. case SETOPT_OK:
  813. config_free_lines(lines);
  814. send_control_done(conn);
  815. return 0;
  816. }
  817. log_warn(LD_CONTROL,
  818. "Controller gave us config lines that didn't validate: %s",
  819. errstring);
  820. connection_printf_to_buf(conn, "%s: %s\r\n", msg, errstring);
  821. config_free_lines(lines);
  822. tor_free(errstring);
  823. return 0;
  824. }
  825. }
  826. /** Called when we receive a SETCONF message: parse the body and try
  827. * to update our configuration. Reply with a DONE or ERROR message.
  828. * Modifies the contents of body.*/
  829. static int
  830. handle_control_setconf(control_connection_t *conn, uint32_t len, char *body)
  831. {
  832. return control_setconf_helper(conn, len, body, 0);
  833. }
  834. /** Called when we receive a RESETCONF message: parse the body and try
  835. * to update our configuration. Reply with a DONE or ERROR message.
  836. * Modifies the contents of body. */
  837. static int
  838. handle_control_resetconf(control_connection_t *conn, uint32_t len, char *body)
  839. {
  840. return control_setconf_helper(conn, len, body, 1);
  841. }
  842. /** Called when we receive a GETCONF message. Parse the request, and
  843. * reply with a CONFVALUE or an ERROR message */
  844. static int
  845. handle_control_getconf(control_connection_t *conn, uint32_t body_len,
  846. const char *body)
  847. {
  848. smartlist_t *questions = smartlist_new();
  849. smartlist_t *answers = smartlist_new();
  850. smartlist_t *unrecognized = smartlist_new();
  851. char *msg = NULL;
  852. size_t msg_len;
  853. const or_options_t *options = get_options();
  854. int i, len;
  855. (void) body_len; /* body is NUL-terminated; so we can ignore len. */
  856. smartlist_split_string(questions, body, " ",
  857. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  858. SMARTLIST_FOREACH_BEGIN(questions, const char *, q) {
  859. if (!option_is_recognized(q)) {
  860. smartlist_add(unrecognized, (char*) q);
  861. } else {
  862. config_line_t *answer = option_get_assignment(options,q);
  863. if (!answer) {
  864. const char *name = option_get_canonical_name(q);
  865. smartlist_add_asprintf(answers, "250-%s\r\n", name);
  866. }
  867. while (answer) {
  868. config_line_t *next;
  869. smartlist_add_asprintf(answers, "250-%s=%s\r\n",
  870. answer->key, answer->value);
  871. next = answer->next;
  872. tor_free(answer->key);
  873. tor_free(answer->value);
  874. tor_free(answer);
  875. answer = next;
  876. }
  877. }
  878. } SMARTLIST_FOREACH_END(q);
  879. if ((len = smartlist_len(unrecognized))) {
  880. for (i=0; i < len-1; ++i)
  881. connection_printf_to_buf(conn,
  882. "552-Unrecognized configuration key \"%s\"\r\n",
  883. (char*)smartlist_get(unrecognized, i));
  884. connection_printf_to_buf(conn,
  885. "552 Unrecognized configuration key \"%s\"\r\n",
  886. (char*)smartlist_get(unrecognized, len-1));
  887. } else if ((len = smartlist_len(answers))) {
  888. char *tmp = smartlist_get(answers, len-1);
  889. tor_assert(strlen(tmp)>4);
  890. tmp[3] = ' ';
  891. msg = smartlist_join_strings(answers, "", 0, &msg_len);
  892. connection_write_to_buf(msg, msg_len, TO_CONN(conn));
  893. } else {
  894. connection_write_str_to_buf("250 OK\r\n", conn);
  895. }
  896. SMARTLIST_FOREACH(answers, char *, cp, tor_free(cp));
  897. smartlist_free(answers);
  898. SMARTLIST_FOREACH(questions, char *, cp, tor_free(cp));
  899. smartlist_free(questions);
  900. smartlist_free(unrecognized);
  901. tor_free(msg);
  902. return 0;
  903. }
  904. /** Called when we get a +LOADCONF message. */
  905. static int
  906. handle_control_loadconf(control_connection_t *conn, uint32_t len,
  907. const char *body)
  908. {
  909. setopt_err_t retval;
  910. char *errstring = NULL;
  911. const char *msg = NULL;
  912. (void) len;
  913. retval = options_init_from_string(NULL, body, CMD_RUN_TOR, NULL, &errstring);
  914. if (retval != SETOPT_OK)
  915. log_warn(LD_CONTROL,
  916. "Controller gave us config file that didn't validate: %s",
  917. errstring);
  918. switch (retval) {
  919. case SETOPT_ERR_PARSE:
  920. msg = "552 Invalid config file";
  921. break;
  922. case SETOPT_ERR_TRANSITION:
  923. msg = "553 Transition not allowed";
  924. break;
  925. case SETOPT_ERR_SETTING:
  926. msg = "553 Unable to set option";
  927. break;
  928. case SETOPT_ERR_MISC:
  929. default:
  930. msg = "550 Unable to load config";
  931. break;
  932. case SETOPT_OK:
  933. break;
  934. }
  935. if (msg) {
  936. if (errstring)
  937. connection_printf_to_buf(conn, "%s: %s\r\n", msg, errstring);
  938. else
  939. connection_printf_to_buf(conn, "%s\r\n", msg);
  940. } else {
  941. send_control_done(conn);
  942. }
  943. tor_free(errstring);
  944. return 0;
  945. }
  946. /** Helper structure: maps event values to their names. */
  947. struct control_event_t {
  948. uint16_t event_code;
  949. const char *event_name;
  950. };
  951. /** Table mapping event values to their names. Used to implement SETEVENTS
  952. * and GETINFO events/names, and to keep they in sync. */
  953. static const struct control_event_t control_event_table[] = {
  954. { EVENT_CIRCUIT_STATUS, "CIRC" },
  955. { EVENT_CIRCUIT_STATUS_MINOR, "CIRC_MINOR" },
  956. { EVENT_STREAM_STATUS, "STREAM" },
  957. { EVENT_OR_CONN_STATUS, "ORCONN" },
  958. { EVENT_BANDWIDTH_USED, "BW" },
  959. { EVENT_DEBUG_MSG, "DEBUG" },
  960. { EVENT_INFO_MSG, "INFO" },
  961. { EVENT_NOTICE_MSG, "NOTICE" },
  962. { EVENT_WARN_MSG, "WARN" },
  963. { EVENT_ERR_MSG, "ERR" },
  964. { EVENT_NEW_DESC, "NEWDESC" },
  965. { EVENT_ADDRMAP, "ADDRMAP" },
  966. { EVENT_AUTHDIR_NEWDESCS, "AUTHDIR_NEWDESCS" },
  967. { EVENT_DESCCHANGED, "DESCCHANGED" },
  968. { EVENT_NS, "NS" },
  969. { EVENT_STATUS_GENERAL, "STATUS_GENERAL" },
  970. { EVENT_STATUS_CLIENT, "STATUS_CLIENT" },
  971. { EVENT_STATUS_SERVER, "STATUS_SERVER" },
  972. { EVENT_GUARD, "GUARD" },
  973. { EVENT_STREAM_BANDWIDTH_USED, "STREAM_BW" },
  974. { EVENT_CLIENTS_SEEN, "CLIENTS_SEEN" },
  975. { EVENT_NEWCONSENSUS, "NEWCONSENSUS" },
  976. { EVENT_BUILDTIMEOUT_SET, "BUILDTIMEOUT_SET" },
  977. { EVENT_SIGNAL, "SIGNAL" },
  978. { EVENT_CONF_CHANGED, "CONF_CHANGED"},
  979. { EVENT_CONN_BW, "CONN_BW" },
  980. { EVENT_CELL_STATS, "CELL_STATS" },
  981. { EVENT_TB_EMPTY, "TB_EMPTY" },
  982. { EVENT_CIRC_BANDWIDTH_USED, "CIRC_BW" },
  983. { EVENT_TRANSPORT_LAUNCHED, "TRANSPORT_LAUNCHED" },
  984. { EVENT_HS_DESC, "HS_DESC" },
  985. { EVENT_HS_DESC_CONTENT, "HS_DESC_CONTENT" },
  986. { EVENT_NETWORK_LIVENESS, "NETWORK_LIVENESS" },
  987. { 0, NULL },
  988. };
  989. /** Called when we get a SETEVENTS message: update conn->event_mask,
  990. * and reply with DONE or ERROR. */
  991. static int
  992. handle_control_setevents(control_connection_t *conn, uint32_t len,
  993. const char *body)
  994. {
  995. int event_code;
  996. event_mask_t event_mask = 0;
  997. smartlist_t *events = smartlist_new();
  998. (void) len;
  999. smartlist_split_string(events, body, " ",
  1000. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  1001. SMARTLIST_FOREACH_BEGIN(events, const char *, ev)
  1002. {
  1003. if (!strcasecmp(ev, "EXTENDED")) {
  1004. continue;
  1005. } else {
  1006. int i;
  1007. event_code = -1;
  1008. for (i = 0; control_event_table[i].event_name != NULL; ++i) {
  1009. if (!strcasecmp(ev, control_event_table[i].event_name)) {
  1010. event_code = control_event_table[i].event_code;
  1011. break;
  1012. }
  1013. }
  1014. if (event_code == -1) {
  1015. connection_printf_to_buf(conn, "552 Unrecognized event \"%s\"\r\n",
  1016. ev);
  1017. SMARTLIST_FOREACH(events, char *, e, tor_free(e));
  1018. smartlist_free(events);
  1019. return 0;
  1020. }
  1021. }
  1022. event_mask |= (((event_mask_t)1) << event_code);
  1023. }
  1024. SMARTLIST_FOREACH_END(ev);
  1025. SMARTLIST_FOREACH(events, char *, e, tor_free(e));
  1026. smartlist_free(events);
  1027. conn->event_mask = event_mask;
  1028. control_update_global_event_mask();
  1029. send_control_done(conn);
  1030. return 0;
  1031. }
  1032. /** Decode the hashed, base64'd passwords stored in <b>passwords</b>.
  1033. * Return a smartlist of acceptable passwords (unterminated strings of
  1034. * length S2K_RFC2440_SPECIFIER_LEN+DIGEST_LEN) on success, or NULL on
  1035. * failure.
  1036. */
  1037. smartlist_t *
  1038. decode_hashed_passwords(config_line_t *passwords)
  1039. {
  1040. char decoded[64];
  1041. config_line_t *cl;
  1042. smartlist_t *sl = smartlist_new();
  1043. tor_assert(passwords);
  1044. for (cl = passwords; cl; cl = cl->next) {
  1045. const char *hashed = cl->value;
  1046. if (!strcmpstart(hashed, "16:")) {
  1047. if (base16_decode(decoded, sizeof(decoded), hashed+3, strlen(hashed+3))<0
  1048. || strlen(hashed+3) != (S2K_RFC2440_SPECIFIER_LEN+DIGEST_LEN)*2) {
  1049. goto err;
  1050. }
  1051. } else {
  1052. if (base64_decode(decoded, sizeof(decoded), hashed, strlen(hashed))
  1053. != S2K_RFC2440_SPECIFIER_LEN+DIGEST_LEN) {
  1054. goto err;
  1055. }
  1056. }
  1057. smartlist_add(sl,
  1058. tor_memdup(decoded, S2K_RFC2440_SPECIFIER_LEN+DIGEST_LEN));
  1059. }
  1060. return sl;
  1061. err:
  1062. SMARTLIST_FOREACH(sl, char*, cp, tor_free(cp));
  1063. smartlist_free(sl);
  1064. return NULL;
  1065. }
  1066. /** Called when we get an AUTHENTICATE message. Check whether the
  1067. * authentication is valid, and if so, update the connection's state to
  1068. * OPEN. Reply with DONE or ERROR.
  1069. */
  1070. static int
  1071. handle_control_authenticate(control_connection_t *conn, uint32_t len,
  1072. const char *body)
  1073. {
  1074. int used_quoted_string = 0;
  1075. const or_options_t *options = get_options();
  1076. const char *errstr = "Unknown error";
  1077. char *password;
  1078. size_t password_len;
  1079. const char *cp;
  1080. int i;
  1081. int bad_cookie=0, bad_password=0;
  1082. smartlist_t *sl = NULL;
  1083. if (!len) {
  1084. password = tor_strdup("");
  1085. password_len = 0;
  1086. } else if (TOR_ISXDIGIT(body[0])) {
  1087. cp = body;
  1088. while (TOR_ISXDIGIT(*cp))
  1089. ++cp;
  1090. i = (int)(cp - body);
  1091. tor_assert(i>0);
  1092. password_len = i/2;
  1093. password = tor_malloc(password_len + 1);
  1094. if (base16_decode(password, password_len+1, body, i)<0) {
  1095. connection_write_str_to_buf(
  1096. "551 Invalid hexadecimal encoding. Maybe you tried a plain text "
  1097. "password? If so, the standard requires that you put it in "
  1098. "double quotes.\r\n", conn);
  1099. connection_mark_for_close(TO_CONN(conn));
  1100. tor_free(password);
  1101. return 0;
  1102. }
  1103. } else {
  1104. if (!decode_escaped_string(body, len, &password, &password_len)) {
  1105. connection_write_str_to_buf("551 Invalid quoted string. You need "
  1106. "to put the password in double quotes.\r\n", conn);
  1107. connection_mark_for_close(TO_CONN(conn));
  1108. return 0;
  1109. }
  1110. used_quoted_string = 1;
  1111. }
  1112. if (conn->safecookie_client_hash != NULL) {
  1113. /* The controller has chosen safe cookie authentication; the only
  1114. * acceptable authentication value is the controller-to-server
  1115. * response. */
  1116. tor_assert(authentication_cookie_is_set);
  1117. if (password_len != DIGEST256_LEN) {
  1118. log_warn(LD_CONTROL,
  1119. "Got safe cookie authentication response with wrong length "
  1120. "(%d)", (int)password_len);
  1121. errstr = "Wrong length for safe cookie response.";
  1122. goto err;
  1123. }
  1124. if (tor_memneq(conn->safecookie_client_hash, password, DIGEST256_LEN)) {
  1125. log_warn(LD_CONTROL,
  1126. "Got incorrect safe cookie authentication response");
  1127. errstr = "Safe cookie response did not match expected value.";
  1128. goto err;
  1129. }
  1130. tor_free(conn->safecookie_client_hash);
  1131. goto ok;
  1132. }
  1133. if (!options->CookieAuthentication && !options->HashedControlPassword &&
  1134. !options->HashedControlSessionPassword) {
  1135. /* if Tor doesn't demand any stronger authentication, then
  1136. * the controller can get in with anything. */
  1137. goto ok;
  1138. }
  1139. if (options->CookieAuthentication) {
  1140. int also_password = options->HashedControlPassword != NULL ||
  1141. options->HashedControlSessionPassword != NULL;
  1142. if (password_len != AUTHENTICATION_COOKIE_LEN) {
  1143. if (!also_password) {
  1144. log_warn(LD_CONTROL, "Got authentication cookie with wrong length "
  1145. "(%d)", (int)password_len);
  1146. errstr = "Wrong length on authentication cookie.";
  1147. goto err;
  1148. }
  1149. bad_cookie = 1;
  1150. } else if (tor_memneq(authentication_cookie, password, password_len)) {
  1151. if (!also_password) {
  1152. log_warn(LD_CONTROL, "Got mismatched authentication cookie");
  1153. errstr = "Authentication cookie did not match expected value.";
  1154. goto err;
  1155. }
  1156. bad_cookie = 1;
  1157. } else {
  1158. goto ok;
  1159. }
  1160. }
  1161. if (options->HashedControlPassword ||
  1162. options->HashedControlSessionPassword) {
  1163. int bad = 0;
  1164. smartlist_t *sl_tmp;
  1165. char received[DIGEST_LEN];
  1166. int also_cookie = options->CookieAuthentication;
  1167. sl = smartlist_new();
  1168. if (options->HashedControlPassword) {
  1169. sl_tmp = decode_hashed_passwords(options->HashedControlPassword);
  1170. if (!sl_tmp)
  1171. bad = 1;
  1172. else {
  1173. smartlist_add_all(sl, sl_tmp);
  1174. smartlist_free(sl_tmp);
  1175. }
  1176. }
  1177. if (options->HashedControlSessionPassword) {
  1178. sl_tmp = decode_hashed_passwords(options->HashedControlSessionPassword);
  1179. if (!sl_tmp)
  1180. bad = 1;
  1181. else {
  1182. smartlist_add_all(sl, sl_tmp);
  1183. smartlist_free(sl_tmp);
  1184. }
  1185. }
  1186. if (bad) {
  1187. if (!also_cookie) {
  1188. log_warn(LD_BUG,
  1189. "Couldn't decode HashedControlPassword: invalid base16");
  1190. errstr="Couldn't decode HashedControlPassword value in configuration.";
  1191. goto err;
  1192. }
  1193. bad_password = 1;
  1194. SMARTLIST_FOREACH(sl, char *, cp, tor_free(cp));
  1195. smartlist_free(sl);
  1196. sl = NULL;
  1197. } else {
  1198. SMARTLIST_FOREACH(sl, char *, expected,
  1199. {
  1200. secret_to_key_rfc2440(received,DIGEST_LEN,
  1201. password,password_len,expected);
  1202. if (tor_memeq(expected + S2K_RFC2440_SPECIFIER_LEN,
  1203. received, DIGEST_LEN))
  1204. goto ok;
  1205. });
  1206. SMARTLIST_FOREACH(sl, char *, cp, tor_free(cp));
  1207. smartlist_free(sl);
  1208. sl = NULL;
  1209. if (used_quoted_string)
  1210. errstr = "Password did not match HashedControlPassword value from "
  1211. "configuration";
  1212. else
  1213. errstr = "Password did not match HashedControlPassword value from "
  1214. "configuration. Maybe you tried a plain text password? "
  1215. "If so, the standard requires that you put it in double quotes.";
  1216. bad_password = 1;
  1217. if (!also_cookie)
  1218. goto err;
  1219. }
  1220. }
  1221. /** We only get here if both kinds of authentication failed. */
  1222. tor_assert(bad_password && bad_cookie);
  1223. log_warn(LD_CONTROL, "Bad password or authentication cookie on controller.");
  1224. errstr = "Password did not match HashedControlPassword *or* authentication "
  1225. "cookie.";
  1226. err:
  1227. tor_free(password);
  1228. connection_printf_to_buf(conn, "515 Authentication failed: %s\r\n", errstr);
  1229. connection_mark_for_close(TO_CONN(conn));
  1230. if (sl) { /* clean up */
  1231. SMARTLIST_FOREACH(sl, char *, cp, tor_free(cp));
  1232. smartlist_free(sl);
  1233. }
  1234. return 0;
  1235. ok:
  1236. log_info(LD_CONTROL, "Authenticated control connection ("TOR_SOCKET_T_FORMAT
  1237. ")", conn->base_.s);
  1238. send_control_done(conn);
  1239. conn->base_.state = CONTROL_CONN_STATE_OPEN;
  1240. tor_free(password);
  1241. if (sl) { /* clean up */
  1242. SMARTLIST_FOREACH(sl, char *, cp, tor_free(cp));
  1243. smartlist_free(sl);
  1244. }
  1245. return 0;
  1246. }
  1247. /** Called when we get a SAVECONF command. Try to flush the current options to
  1248. * disk, and report success or failure. */
  1249. static int
  1250. handle_control_saveconf(control_connection_t *conn, uint32_t len,
  1251. const char *body)
  1252. {
  1253. (void) len;
  1254. (void) body;
  1255. if (options_save_current()<0) {
  1256. connection_write_str_to_buf(
  1257. "551 Unable to write configuration to disk.\r\n", conn);
  1258. } else {
  1259. send_control_done(conn);
  1260. }
  1261. return 0;
  1262. }
  1263. struct signal_t {
  1264. int sig;
  1265. const char *signal_name;
  1266. };
  1267. static const struct signal_t signal_table[] = {
  1268. { SIGHUP, "RELOAD" },
  1269. { SIGHUP, "HUP" },
  1270. { SIGINT, "SHUTDOWN" },
  1271. { SIGUSR1, "DUMP" },
  1272. { SIGUSR1, "USR1" },
  1273. { SIGUSR2, "DEBUG" },
  1274. { SIGUSR2, "USR2" },
  1275. { SIGTERM, "HALT" },
  1276. { SIGTERM, "TERM" },
  1277. { SIGTERM, "INT" },
  1278. { SIGNEWNYM, "NEWNYM" },
  1279. { SIGCLEARDNSCACHE, "CLEARDNSCACHE"},
  1280. { SIGHEARTBEAT, "HEARTBEAT"},
  1281. { 0, NULL },
  1282. };
  1283. /** Called when we get a SIGNAL command. React to the provided signal, and
  1284. * report success or failure. (If the signal results in a shutdown, success
  1285. * may not be reported.) */
  1286. static int
  1287. handle_control_signal(control_connection_t *conn, uint32_t len,
  1288. const char *body)
  1289. {
  1290. int sig = -1;
  1291. int i;
  1292. int n = 0;
  1293. char *s;
  1294. (void) len;
  1295. while (body[n] && ! TOR_ISSPACE(body[n]))
  1296. ++n;
  1297. s = tor_strndup(body, n);
  1298. for (i = 0; signal_table[i].signal_name != NULL; ++i) {
  1299. if (!strcasecmp(s, signal_table[i].signal_name)) {
  1300. sig = signal_table[i].sig;
  1301. break;
  1302. }
  1303. }
  1304. if (sig < 0)
  1305. connection_printf_to_buf(conn, "552 Unrecognized signal code \"%s\"\r\n",
  1306. s);
  1307. tor_free(s);
  1308. if (sig < 0)
  1309. return 0;
  1310. send_control_done(conn);
  1311. /* Flush the "done" first if the signal might make us shut down. */
  1312. if (sig == SIGTERM || sig == SIGINT)
  1313. connection_flush(TO_CONN(conn));
  1314. process_signal(sig);
  1315. return 0;
  1316. }
  1317. /** Called when we get a TAKEOWNERSHIP command. Mark this connection
  1318. * as an owning connection, so that we will exit if the connection
  1319. * closes. */
  1320. static int
  1321. handle_control_takeownership(control_connection_t *conn, uint32_t len,
  1322. const char *body)
  1323. {
  1324. (void)len;
  1325. (void)body;
  1326. conn->is_owning_control_connection = 1;
  1327. log_info(LD_CONTROL, "Control connection %d has taken ownership of this "
  1328. "Tor instance.",
  1329. (int)(conn->base_.s));
  1330. send_control_done(conn);
  1331. return 0;
  1332. }
  1333. /** Return true iff <b>addr</b> is unusable as a mapaddress target because of
  1334. * containing funny characters. */
  1335. static int
  1336. address_is_invalid_mapaddress_target(const char *addr)
  1337. {
  1338. if (!strcmpstart(addr, "*."))
  1339. return address_is_invalid_destination(addr+2, 1);
  1340. else
  1341. return address_is_invalid_destination(addr, 1);
  1342. }
  1343. /** Called when we get a MAPADDRESS command; try to bind all listed addresses,
  1344. * and report success or failure. */
  1345. static int
  1346. handle_control_mapaddress(control_connection_t *conn, uint32_t len,
  1347. const char *body)
  1348. {
  1349. smartlist_t *elts;
  1350. smartlist_t *lines;
  1351. smartlist_t *reply;
  1352. char *r;
  1353. size_t sz;
  1354. (void) len; /* body is NUL-terminated, so it's safe to ignore the length. */
  1355. lines = smartlist_new();
  1356. elts = smartlist_new();
  1357. reply = smartlist_new();
  1358. smartlist_split_string(lines, body, " ",
  1359. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  1360. SMARTLIST_FOREACH_BEGIN(lines, char *, line) {
  1361. tor_strlower(line);
  1362. smartlist_split_string(elts, line, "=", 0, 2);
  1363. if (smartlist_len(elts) == 2) {
  1364. const char *from = smartlist_get(elts,0);
  1365. const char *to = smartlist_get(elts,1);
  1366. if (address_is_invalid_mapaddress_target(to)) {
  1367. smartlist_add_asprintf(reply,
  1368. "512-syntax error: invalid address '%s'", to);
  1369. log_warn(LD_CONTROL,
  1370. "Skipping invalid argument '%s' in MapAddress msg", to);
  1371. } else if (!strcmp(from, ".") || !strcmp(from, "0.0.0.0") ||
  1372. !strcmp(from, "::")) {
  1373. const char type =
  1374. !strcmp(from,".") ? RESOLVED_TYPE_HOSTNAME :
  1375. (!strcmp(from, "0.0.0.0") ? RESOLVED_TYPE_IPV4 : RESOLVED_TYPE_IPV6);
  1376. const char *address = addressmap_register_virtual_address(
  1377. type, tor_strdup(to));
  1378. if (!address) {
  1379. smartlist_add_asprintf(reply,
  1380. "451-resource exhausted: skipping '%s'", line);
  1381. log_warn(LD_CONTROL,
  1382. "Unable to allocate address for '%s' in MapAddress msg",
  1383. safe_str_client(line));
  1384. } else {
  1385. smartlist_add_asprintf(reply, "250-%s=%s", address, to);
  1386. }
  1387. } else {
  1388. const char *msg;
  1389. if (addressmap_register_auto(from, to, 1,
  1390. ADDRMAPSRC_CONTROLLER, &msg) < 0) {
  1391. smartlist_add_asprintf(reply,
  1392. "512-syntax error: invalid address mapping "
  1393. " '%s': %s", line, msg);
  1394. log_warn(LD_CONTROL,
  1395. "Skipping invalid argument '%s' in MapAddress msg: %s",
  1396. line, msg);
  1397. } else {
  1398. smartlist_add_asprintf(reply, "250-%s", line);
  1399. }
  1400. }
  1401. } else {
  1402. smartlist_add_asprintf(reply, "512-syntax error: mapping '%s' is "
  1403. "not of expected form 'foo=bar'.", line);
  1404. log_info(LD_CONTROL, "Skipping MapAddress '%s': wrong "
  1405. "number of items.",
  1406. safe_str_client(line));
  1407. }
  1408. SMARTLIST_FOREACH(elts, char *, cp, tor_free(cp));
  1409. smartlist_clear(elts);
  1410. } SMARTLIST_FOREACH_END(line);
  1411. SMARTLIST_FOREACH(lines, char *, cp, tor_free(cp));
  1412. smartlist_free(lines);
  1413. smartlist_free(elts);
  1414. if (smartlist_len(reply)) {
  1415. ((char*)smartlist_get(reply,smartlist_len(reply)-1))[3] = ' ';
  1416. r = smartlist_join_strings(reply, "\r\n", 1, &sz);
  1417. connection_write_to_buf(r, sz, TO_CONN(conn));
  1418. tor_free(r);
  1419. } else {
  1420. const char *response =
  1421. "512 syntax error: not enough arguments to mapaddress.\r\n";
  1422. connection_write_to_buf(response, strlen(response), TO_CONN(conn));
  1423. }
  1424. SMARTLIST_FOREACH(reply, char *, cp, tor_free(cp));
  1425. smartlist_free(reply);
  1426. return 0;
  1427. }
  1428. /** Implementation helper for GETINFO: knows the answers for various
  1429. * trivial-to-implement questions. */
  1430. static int
  1431. getinfo_helper_misc(control_connection_t *conn, const char *question,
  1432. char **answer, const char **errmsg)
  1433. {
  1434. (void) conn;
  1435. if (!strcmp(question, "version")) {
  1436. *answer = tor_strdup(get_version());
  1437. } else if (!strcmp(question, "bw-event-cache")) {
  1438. *answer = get_bw_samples();
  1439. } else if (!strcmp(question, "config-file")) {
  1440. const char *a = get_torrc_fname(0);
  1441. if (a)
  1442. *answer = tor_strdup(a);
  1443. } else if (!strcmp(question, "config-defaults-file")) {
  1444. const char *a = get_torrc_fname(1);
  1445. if (a)
  1446. *answer = tor_strdup(a);
  1447. } else if (!strcmp(question, "config-text")) {
  1448. *answer = options_dump(get_options(), OPTIONS_DUMP_MINIMAL);
  1449. } else if (!strcmp(question, "info/names")) {
  1450. *answer = list_getinfo_options();
  1451. } else if (!strcmp(question, "dormant")) {
  1452. int dormant = rep_hist_circbuilding_dormant(time(NULL));
  1453. *answer = tor_strdup(dormant ? "1" : "0");
  1454. } else if (!strcmp(question, "events/names")) {
  1455. int i;
  1456. smartlist_t *event_names = smartlist_new();
  1457. for (i = 0; control_event_table[i].event_name != NULL; ++i) {
  1458. smartlist_add(event_names, (char *)control_event_table[i].event_name);
  1459. }
  1460. *answer = smartlist_join_strings(event_names, " ", 0, NULL);
  1461. smartlist_free(event_names);
  1462. } else if (!strcmp(question, "signal/names")) {
  1463. smartlist_t *signal_names = smartlist_new();
  1464. int j;
  1465. for (j = 0; signal_table[j].signal_name != NULL; ++j) {
  1466. smartlist_add(signal_names, (char*)signal_table[j].signal_name);
  1467. }
  1468. *answer = smartlist_join_strings(signal_names, " ", 0, NULL);
  1469. smartlist_free(signal_names);
  1470. } else if (!strcmp(question, "features/names")) {
  1471. *answer = tor_strdup("VERBOSE_NAMES EXTENDED_EVENTS");
  1472. } else if (!strcmp(question, "address")) {
  1473. uint32_t addr;
  1474. if (router_pick_published_address(get_options(), &addr) < 0) {
  1475. *errmsg = "Address unknown";
  1476. return -1;
  1477. }
  1478. *answer = tor_dup_ip(addr);
  1479. } else if (!strcmp(question, "traffic/read")) {
  1480. tor_asprintf(answer, U64_FORMAT, U64_PRINTF_ARG(get_bytes_read()));
  1481. } else if (!strcmp(question, "traffic/written")) {
  1482. tor_asprintf(answer, U64_FORMAT, U64_PRINTF_ARG(get_bytes_written()));
  1483. } else if (!strcmp(question, "process/pid")) {
  1484. int myPid = -1;
  1485. #ifdef _WIN32
  1486. myPid = _getpid();
  1487. #else
  1488. myPid = getpid();
  1489. #endif
  1490. tor_asprintf(answer, "%d", myPid);
  1491. } else if (!strcmp(question, "process/uid")) {
  1492. #ifdef _WIN32
  1493. *answer = tor_strdup("-1");
  1494. #else
  1495. int myUid = geteuid();
  1496. tor_asprintf(answer, "%d", myUid);
  1497. #endif
  1498. } else if (!strcmp(question, "process/user")) {
  1499. #ifdef _WIN32
  1500. *answer = tor_strdup("");
  1501. #else
  1502. int myUid = geteuid();
  1503. const struct passwd *myPwEntry = tor_getpwuid(myUid);
  1504. if (myPwEntry) {
  1505. *answer = tor_strdup(myPwEntry->pw_name);
  1506. } else {
  1507. *answer = tor_strdup("");
  1508. }
  1509. #endif
  1510. } else if (!strcmp(question, "process/descriptor-limit")) {
  1511. int max_fds=-1;
  1512. set_max_file_descriptors(0, &max_fds);
  1513. tor_asprintf(answer, "%d", max_fds);
  1514. } else if (!strcmp(question, "limits/max-mem-in-queues")) {
  1515. tor_asprintf(answer, U64_FORMAT,
  1516. U64_PRINTF_ARG(get_options()->MaxMemInQueues));
  1517. } else if (!strcmp(question, "dir-usage")) {
  1518. *answer = directory_dump_request_log();
  1519. } else if (!strcmp(question, "fingerprint")) {
  1520. crypto_pk_t *server_key;
  1521. if (!server_mode(get_options())) {
  1522. *errmsg = "Not running in server mode";
  1523. return -1;
  1524. }
  1525. server_key = get_server_identity_key();
  1526. *answer = tor_malloc(HEX_DIGEST_LEN+1);
  1527. crypto_pk_get_fingerprint(server_key, *answer, 0);
  1528. }
  1529. return 0;
  1530. }
  1531. /** Awful hack: return a newly allocated string based on a routerinfo and
  1532. * (possibly) an extrainfo, sticking the read-history and write-history from
  1533. * <b>ei</b> into the resulting string. The thing you get back won't
  1534. * necessarily have a valid signature.
  1535. *
  1536. * New code should never use this; it's for backward compatibility.
  1537. *
  1538. * NOTE: <b>ri_body</b> is as returned by signed_descriptor_get_body: it might
  1539. * not be NUL-terminated. */
  1540. static char *
  1541. munge_extrainfo_into_routerinfo(const char *ri_body,
  1542. const signed_descriptor_t *ri,
  1543. const signed_descriptor_t *ei)
  1544. {
  1545. char *out = NULL, *outp;
  1546. int i;
  1547. const char *router_sig;
  1548. const char *ei_body = signed_descriptor_get_body(ei);
  1549. size_t ri_len = ri->signed_descriptor_len;
  1550. size_t ei_len = ei->signed_descriptor_len;
  1551. if (!ei_body)
  1552. goto bail;
  1553. outp = out = tor_malloc(ri_len+ei_len+1);
  1554. if (!(router_sig = tor_memstr(ri_body, ri_len, "\nrouter-signature")))
  1555. goto bail;
  1556. ++router_sig;
  1557. memcpy(out, ri_body, router_sig-ri_body);
  1558. outp += router_sig-ri_body;
  1559. for (i=0; i < 2; ++i) {
  1560. const char *kwd = i ? "\nwrite-history " : "\nread-history ";
  1561. const char *cp, *eol;
  1562. if (!(cp = tor_memstr(ei_body, ei_len, kwd)))
  1563. continue;
  1564. ++cp;
  1565. if (!(eol = memchr(cp, '\n', ei_len - (cp-ei_body))))
  1566. continue;
  1567. memcpy(outp, cp, eol-cp+1);
  1568. outp += eol-cp+1;
  1569. }
  1570. memcpy(outp, router_sig, ri_len - (router_sig-ri_body));
  1571. *outp++ = '\0';
  1572. tor_assert(outp-out < (int)(ri_len+ei_len+1));
  1573. return out;
  1574. bail:
  1575. tor_free(out);
  1576. return tor_strndup(ri_body, ri->signed_descriptor_len);
  1577. }
  1578. /** Implementation helper for GETINFO: answers requests for information about
  1579. * which ports are bound. */
  1580. static int
  1581. getinfo_helper_listeners(control_connection_t *control_conn,
  1582. const char *question,
  1583. char **answer, const char **errmsg)
  1584. {
  1585. int type;
  1586. smartlist_t *res;
  1587. (void)control_conn;
  1588. (void)errmsg;
  1589. if (!strcmp(question, "net/listeners/or"))
  1590. type = CONN_TYPE_OR_LISTENER;
  1591. else if (!strcmp(question, "net/listeners/dir"))
  1592. type = CONN_TYPE_DIR_LISTENER;
  1593. else if (!strcmp(question, "net/listeners/socks"))
  1594. type = CONN_TYPE_AP_LISTENER;
  1595. else if (!strcmp(question, "net/listeners/trans"))
  1596. type = CONN_TYPE_AP_TRANS_LISTENER;
  1597. else if (!strcmp(question, "net/listeners/natd"))
  1598. type = CONN_TYPE_AP_NATD_LISTENER;
  1599. else if (!strcmp(question, "net/listeners/dns"))
  1600. type = CONN_TYPE_AP_DNS_LISTENER;
  1601. else if (!strcmp(question, "net/listeners/control"))
  1602. type = CONN_TYPE_CONTROL_LISTENER;
  1603. else
  1604. return 0; /* unknown key */
  1605. res = smartlist_new();
  1606. SMARTLIST_FOREACH_BEGIN(get_connection_array(), connection_t *, conn) {
  1607. struct sockaddr_storage ss;
  1608. socklen_t ss_len = sizeof(ss);
  1609. if (conn->type != type || conn->marked_for_close || !SOCKET_OK(conn->s))
  1610. continue;
  1611. if (getsockname(conn->s, (struct sockaddr *)&ss, &ss_len) < 0) {
  1612. smartlist_add_asprintf(res, "%s:%d", conn->address, (int)conn->port);
  1613. } else {
  1614. char *tmp = tor_sockaddr_to_str((struct sockaddr *)&ss);
  1615. smartlist_add(res, esc_for_log(tmp));
  1616. tor_free(tmp);
  1617. }
  1618. } SMARTLIST_FOREACH_END(conn);
  1619. *answer = smartlist_join_strings(res, " ", 0, NULL);
  1620. SMARTLIST_FOREACH(res, char *, cp, tor_free(cp));
  1621. smartlist_free(res);
  1622. return 0;
  1623. }
  1624. /** Implementation helper for GETINFO: knows the answers for questions about
  1625. * directory information. */
  1626. static int
  1627. getinfo_helper_dir(control_connection_t *control_conn,
  1628. const char *question, char **answer,
  1629. const char **errmsg)
  1630. {
  1631. const node_t *node;
  1632. const routerinfo_t *ri = NULL;
  1633. (void) control_conn;
  1634. if (!strcmpstart(question, "desc/id/")) {
  1635. node = node_get_by_hex_id(question+strlen("desc/id/"));
  1636. if (node)
  1637. ri = node->ri;
  1638. if (ri) {
  1639. const char *body = signed_descriptor_get_body(&ri->cache_info);
  1640. if (body)
  1641. *answer = tor_strndup(body, ri->cache_info.signed_descriptor_len);
  1642. }
  1643. } else if (!strcmpstart(question, "desc/name/")) {
  1644. /* XXX023 Setting 'warn_if_unnamed' here is a bit silly -- the
  1645. * warning goes to the user, not to the controller. */
  1646. node = node_get_by_nickname(question+strlen("desc/name/"), 1);
  1647. if (node)
  1648. ri = node->ri;
  1649. if (ri) {
  1650. const char *body = signed_descriptor_get_body(&ri->cache_info);
  1651. if (body)
  1652. *answer = tor_strndup(body, ri->cache_info.signed_descriptor_len);
  1653. }
  1654. } else if (!strcmp(question, "desc/all-recent")) {
  1655. routerlist_t *routerlist = router_get_routerlist();
  1656. smartlist_t *sl = smartlist_new();
  1657. if (routerlist && routerlist->routers) {
  1658. SMARTLIST_FOREACH(routerlist->routers, const routerinfo_t *, ri,
  1659. {
  1660. const char *body = signed_descriptor_get_body(&ri->cache_info);
  1661. if (body)
  1662. smartlist_add(sl,
  1663. tor_strndup(body, ri->cache_info.signed_descriptor_len));
  1664. });
  1665. }
  1666. *answer = smartlist_join_strings(sl, "", 0, NULL);
  1667. SMARTLIST_FOREACH(sl, char *, c, tor_free(c));
  1668. smartlist_free(sl);
  1669. } else if (!strcmp(question, "desc/all-recent-extrainfo-hack")) {
  1670. /* XXXX Remove this once Torstat asks for extrainfos. */
  1671. routerlist_t *routerlist = router_get_routerlist();
  1672. smartlist_t *sl = smartlist_new();
  1673. if (routerlist && routerlist->routers) {
  1674. SMARTLIST_FOREACH_BEGIN(routerlist->routers, const routerinfo_t *, ri) {
  1675. const char *body = signed_descriptor_get_body(&ri->cache_info);
  1676. signed_descriptor_t *ei = extrainfo_get_by_descriptor_digest(
  1677. ri->cache_info.extra_info_digest);
  1678. if (ei && body) {
  1679. smartlist_add(sl, munge_extrainfo_into_routerinfo(body,
  1680. &ri->cache_info, ei));
  1681. } else if (body) {
  1682. smartlist_add(sl,
  1683. tor_strndup(body, ri->cache_info.signed_descriptor_len));
  1684. }
  1685. } SMARTLIST_FOREACH_END(ri);
  1686. }
  1687. *answer = smartlist_join_strings(sl, "", 0, NULL);
  1688. SMARTLIST_FOREACH(sl, char *, c, tor_free(c));
  1689. smartlist_free(sl);
  1690. } else if (!strcmpstart(question, "hs/client/desc/id/")) {
  1691. rend_cache_entry_t *e = NULL;
  1692. question += strlen("hs/client/desc/id/");
  1693. if (strlen(question) != REND_SERVICE_ID_LEN_BASE32) {
  1694. *errmsg = "Invalid address";
  1695. return -1;
  1696. }
  1697. if (!rend_cache_lookup_entry(question, -1, &e)) {
  1698. /* Descriptor found in cache */
  1699. *answer = tor_strdup(e->desc);
  1700. } else {
  1701. *errmsg = "Not found in cache";
  1702. return -1;
  1703. }
  1704. } else if (!strcmpstart(question, "md/id/")) {
  1705. const node_t *node = node_get_by_hex_id(question+strlen("md/id/"));
  1706. const microdesc_t *md = NULL;
  1707. if (node) md = node->md;
  1708. if (md && md->body) {
  1709. *answer = tor_strndup(md->body, md->bodylen);
  1710. }
  1711. } else if (!strcmpstart(question, "md/name/")) {
  1712. /* XXX023 Setting 'warn_if_unnamed' here is a bit silly -- the
  1713. * warning goes to the user, not to the controller. */
  1714. const node_t *node = node_get_by_nickname(question+strlen("md/name/"), 1);
  1715. /* XXXX duplicated code */
  1716. const microdesc_t *md = NULL;
  1717. if (node) md = node->md;
  1718. if (md && md->body) {
  1719. *answer = tor_strndup(md->body, md->bodylen);
  1720. }
  1721. } else if (!strcmpstart(question, "desc-annotations/id/")) {
  1722. node = node_get_by_hex_id(question+strlen("desc-annotations/id/"));
  1723. if (node)
  1724. ri = node->ri;
  1725. if (ri) {
  1726. const char *annotations =
  1727. signed_descriptor_get_annotations(&ri->cache_info);
  1728. if (annotations)
  1729. *answer = tor_strndup(annotations,
  1730. ri->cache_info.annotations_len);
  1731. }
  1732. } else if (!strcmpstart(question, "dir/server/")) {
  1733. size_t answer_len = 0;
  1734. char *url = NULL;
  1735. smartlist_t *descs = smartlist_new();
  1736. const char *msg;
  1737. int res;
  1738. char *cp;
  1739. tor_asprintf(&url, "/tor/%s", question+4);
  1740. res = dirserv_get_routerdescs(descs, url, &msg);
  1741. if (res) {
  1742. log_warn(LD_CONTROL, "getinfo '%s': %s", question, msg);
  1743. smartlist_free(descs);
  1744. tor_free(url);
  1745. *errmsg = msg;
  1746. return -1;
  1747. }
  1748. SMARTLIST_FOREACH(descs, signed_descriptor_t *, sd,
  1749. answer_len += sd->signed_descriptor_len);
  1750. cp = *answer = tor_malloc(answer_len+1);
  1751. SMARTLIST_FOREACH(descs, signed_descriptor_t *, sd,
  1752. {
  1753. memcpy(cp, signed_descriptor_get_body(sd),
  1754. sd->signed_descriptor_len);
  1755. cp += sd->signed_descriptor_len;
  1756. });
  1757. *cp = '\0';
  1758. tor_free(url);
  1759. smartlist_free(descs);
  1760. } else if (!strcmpstart(question, "dir/status/")) {
  1761. *answer = tor_strdup("");
  1762. } else if (!strcmp(question, "dir/status-vote/current/consensus")) { /* v3 */
  1763. if (directory_caches_dir_info(get_options())) {
  1764. const cached_dir_t *consensus = dirserv_get_consensus("ns");
  1765. if (consensus)
  1766. *answer = tor_strdup(consensus->dir);
  1767. }
  1768. if (!*answer) { /* try loading it from disk */
  1769. char *filename = get_datadir_fname("cached-consensus");
  1770. *answer = read_file_to_str(filename, RFTS_IGNORE_MISSING, NULL);
  1771. tor_free(filename);
  1772. }
  1773. } else if (!strcmp(question, "network-status")) { /* v1 */
  1774. routerlist_t *routerlist = router_get_routerlist();
  1775. if (!routerlist || !routerlist->routers ||
  1776. list_server_status_v1(routerlist->routers, answer, 1) < 0) {
  1777. return -1;
  1778. }
  1779. } else if (!strcmpstart(question, "extra-info/digest/")) {
  1780. question += strlen("extra-info/digest/");
  1781. if (strlen(question) == HEX_DIGEST_LEN) {
  1782. char d[DIGEST_LEN];
  1783. signed_descriptor_t *sd = NULL;
  1784. if (base16_decode(d, sizeof(d), question, strlen(question))==0) {
  1785. /* XXXX this test should move into extrainfo_get_by_descriptor_digest,
  1786. * but I don't want to risk affecting other parts of the code,
  1787. * especially since the rules for using our own extrainfo (including
  1788. * when it might be freed) are different from those for using one
  1789. * we have downloaded. */
  1790. if (router_extrainfo_digest_is_me(d))
  1791. sd = &(router_get_my_extrainfo()->cache_info);
  1792. else
  1793. sd = extrainfo_get_by_descriptor_digest(d);
  1794. }
  1795. if (sd) {
  1796. const char *body = signed_descriptor_get_body(sd);
  1797. if (body)
  1798. *answer = tor_strndup(body, sd->signed_descriptor_len);
  1799. }
  1800. }
  1801. }
  1802. return 0;
  1803. }
  1804. /** Allocate and return a description of <b>circ</b>'s current status,
  1805. * including its path (if any). */
  1806. static char *
  1807. circuit_describe_status_for_controller(origin_circuit_t *circ)
  1808. {
  1809. char *rv;
  1810. smartlist_t *descparts = smartlist_new();
  1811. {
  1812. char *vpath = circuit_list_path_for_controller(circ);
  1813. if (*vpath) {
  1814. smartlist_add(descparts, vpath);
  1815. } else {
  1816. tor_free(vpath); /* empty path; don't put an extra space in the result */
  1817. }
  1818. }
  1819. {
  1820. cpath_build_state_t *build_state = circ->build_state;
  1821. smartlist_t *flaglist = smartlist_new();
  1822. char *flaglist_joined;
  1823. if (build_state->onehop_tunnel)
  1824. smartlist_add(flaglist, (void *)"ONEHOP_TUNNEL");
  1825. if (build_state->is_internal)
  1826. smartlist_add(flaglist, (void *)"IS_INTERNAL");
  1827. if (build_state->need_capacity)
  1828. smartlist_add(flaglist, (void *)"NEED_CAPACITY");
  1829. if (build_state->need_uptime)
  1830. smartlist_add(flaglist, (void *)"NEED_UPTIME");
  1831. /* Only emit a BUILD_FLAGS argument if it will have a non-empty value. */
  1832. if (smartlist_len(flaglist)) {
  1833. flaglist_joined = smartlist_join_strings(flaglist, ",", 0, NULL);
  1834. smartlist_add_asprintf(descparts, "BUILD_FLAGS=%s", flaglist_joined);
  1835. tor_free(flaglist_joined);
  1836. }
  1837. smartlist_free(flaglist);
  1838. }
  1839. smartlist_add_asprintf(descparts, "PURPOSE=%s",
  1840. circuit_purpose_to_controller_string(circ->base_.purpose));
  1841. {
  1842. const char *hs_state =
  1843. circuit_purpose_to_controller_hs_state_string(circ->base_.purpose);
  1844. if (hs_state != NULL) {
  1845. smartlist_add_asprintf(descparts, "HS_STATE=%s", hs_state);
  1846. }
  1847. }
  1848. if (circ->rend_data != NULL) {
  1849. smartlist_add_asprintf(descparts, "REND_QUERY=%s",
  1850. circ->rend_data->onion_address);
  1851. }
  1852. {
  1853. char tbuf[ISO_TIME_USEC_LEN+1];
  1854. format_iso_time_nospace_usec(tbuf, &circ->base_.timestamp_created);
  1855. smartlist_add_asprintf(descparts, "TIME_CREATED=%s", tbuf);
  1856. }
  1857. // Show username and/or password if available.
  1858. if (circ->socks_username_len > 0) {
  1859. char* socks_username_escaped = esc_for_log_len(circ->socks_username,
  1860. (size_t) circ->socks_username_len);
  1861. smartlist_add_asprintf(descparts, "SOCKS_USERNAME=%s",
  1862. socks_username_escaped);
  1863. tor_free(socks_username_escaped);
  1864. }
  1865. if (circ->socks_password_len > 0) {
  1866. char* socks_password_escaped = esc_for_log_len(circ->socks_password,
  1867. (size_t) circ->socks_password_len);
  1868. smartlist_add_asprintf(descparts, "SOCKS_PASSWORD=%s",
  1869. socks_password_escaped);
  1870. tor_free(socks_password_escaped);
  1871. }
  1872. rv = smartlist_join_strings(descparts, " ", 0, NULL);
  1873. SMARTLIST_FOREACH(descparts, char *, cp, tor_free(cp));
  1874. smartlist_free(descparts);
  1875. return rv;
  1876. }
  1877. /** Implementation helper for GETINFO: knows how to generate summaries of the
  1878. * current states of things we send events about. */
  1879. static int
  1880. getinfo_helper_events(control_connection_t *control_conn,
  1881. const char *question, char **answer,
  1882. const char **errmsg)
  1883. {
  1884. (void) control_conn;
  1885. if (!strcmp(question, "circuit-status")) {
  1886. smartlist_t *status = smartlist_new();
  1887. SMARTLIST_FOREACH_BEGIN(circuit_get_global_list(), circuit_t *, circ_) {
  1888. origin_circuit_t *circ;
  1889. char *circdesc;
  1890. const char *state;
  1891. if (! CIRCUIT_IS_ORIGIN(circ_) || circ_->marked_for_close)
  1892. continue;
  1893. circ = TO_ORIGIN_CIRCUIT(circ_);
  1894. if (circ->base_.state == CIRCUIT_STATE_OPEN)
  1895. state = "BUILT";
  1896. else if (circ->cpath)
  1897. state = "EXTENDED";
  1898. else
  1899. state = "LAUNCHED";
  1900. circdesc = circuit_describe_status_for_controller(circ);
  1901. smartlist_add_asprintf(status, "%lu %s%s%s",
  1902. (unsigned long)circ->global_identifier,
  1903. state, *circdesc ? " " : "", circdesc);
  1904. tor_free(circdesc);
  1905. }
  1906. SMARTLIST_FOREACH_END(circ_);
  1907. *answer = smartlist_join_strings(status, "\r\n", 0, NULL);
  1908. SMARTLIST_FOREACH(status, char *, cp, tor_free(cp));
  1909. smartlist_free(status);
  1910. } else if (!strcmp(question, "stream-status")) {
  1911. smartlist_t *conns = get_connection_array();
  1912. smartlist_t *status = smartlist_new();
  1913. char buf[256];
  1914. SMARTLIST_FOREACH_BEGIN(conns, connection_t *, base_conn) {
  1915. const char *state;
  1916. entry_connection_t *conn;
  1917. circuit_t *circ;
  1918. origin_circuit_t *origin_circ = NULL;
  1919. if (base_conn->type != CONN_TYPE_AP ||
  1920. base_conn->marked_for_close ||
  1921. base_conn->state == AP_CONN_STATE_SOCKS_WAIT ||
  1922. base_conn->state == AP_CONN_STATE_NATD_WAIT)
  1923. continue;
  1924. conn = TO_ENTRY_CONN(base_conn);
  1925. switch (base_conn->state)
  1926. {
  1927. case AP_CONN_STATE_CONTROLLER_WAIT:
  1928. case AP_CONN_STATE_CIRCUIT_WAIT:
  1929. if (conn->socks_request &&
  1930. SOCKS_COMMAND_IS_RESOLVE(conn->socks_request->command))
  1931. state = "NEWRESOLVE";
  1932. else
  1933. state = "NEW";
  1934. break;
  1935. case AP_CONN_STATE_RENDDESC_WAIT:
  1936. case AP_CONN_STATE_CONNECT_WAIT:
  1937. state = "SENTCONNECT"; break;
  1938. case AP_CONN_STATE_RESOLVE_WAIT:
  1939. state = "SENTRESOLVE"; break;
  1940. case AP_CONN_STATE_OPEN:
  1941. state = "SUCCEEDED"; break;
  1942. default:
  1943. log_warn(LD_BUG, "Asked for stream in unknown state %d",
  1944. base_conn->state);
  1945. continue;
  1946. }
  1947. circ = circuit_get_by_edge_conn(ENTRY_TO_EDGE_CONN(conn));
  1948. if (circ && CIRCUIT_IS_ORIGIN(circ))
  1949. origin_circ = TO_ORIGIN_CIRCUIT(circ);
  1950. write_stream_target_to_buf(conn, buf, sizeof(buf));
  1951. smartlist_add_asprintf(status, "%lu %s %lu %s",
  1952. (unsigned long) base_conn->global_identifier,state,
  1953. origin_circ?
  1954. (unsigned long)origin_circ->global_identifier : 0ul,
  1955. buf);
  1956. } SMARTLIST_FOREACH_END(base_conn);
  1957. *answer = smartlist_join_strings(status, "\r\n", 0, NULL);
  1958. SMARTLIST_FOREACH(status, char *, cp, tor_free(cp));
  1959. smartlist_free(status);
  1960. } else if (!strcmp(question, "orconn-status")) {
  1961. smartlist_t *conns = get_connection_array();
  1962. smartlist_t *status = smartlist_new();
  1963. SMARTLIST_FOREACH_BEGIN(conns, connection_t *, base_conn) {
  1964. const char *state;
  1965. char name[128];
  1966. or_connection_t *conn;
  1967. if (base_conn->type != CONN_TYPE_OR || base_conn->marked_for_close)
  1968. continue;
  1969. conn = TO_OR_CONN(base_conn);
  1970. if (conn->base_.state == OR_CONN_STATE_OPEN)
  1971. state = "CONNECTED";
  1972. else if (conn->nickname)
  1973. state = "LAUNCHED";
  1974. else
  1975. state = "NEW";
  1976. orconn_target_get_name(name, sizeof(name), conn);
  1977. smartlist_add_asprintf(status, "%s %s", name, state);
  1978. } SMARTLIST_FOREACH_END(base_conn);
  1979. *answer = smartlist_join_strings(status, "\r\n", 0, NULL);
  1980. SMARTLIST_FOREACH(status, char *, cp, tor_free(cp));
  1981. smartlist_free(status);
  1982. } else if (!strcmpstart(question, "address-mappings/")) {
  1983. time_t min_e, max_e;
  1984. smartlist_t *mappings;
  1985. question += strlen("address-mappings/");
  1986. if (!strcmp(question, "all")) {
  1987. min_e = 0; max_e = TIME_MAX;
  1988. } else if (!strcmp(question, "cache")) {
  1989. min_e = 2; max_e = TIME_MAX;
  1990. } else if (!strcmp(question, "config")) {
  1991. min_e = 0; max_e = 0;
  1992. } else if (!strcmp(question, "control")) {
  1993. min_e = 1; max_e = 1;
  1994. } else {
  1995. return 0;
  1996. }
  1997. mappings = smartlist_new();
  1998. addressmap_get_mappings(mappings, min_e, max_e, 1);
  1999. *answer = smartlist_join_strings(mappings, "\r\n", 0, NULL);
  2000. SMARTLIST_FOREACH(mappings, char *, cp, tor_free(cp));
  2001. smartlist_free(mappings);
  2002. } else if (!strcmpstart(question, "status/")) {
  2003. /* Note that status/ is not a catch-all for events; there's only supposed
  2004. * to be a status GETINFO if there's a corresponding STATUS event. */
  2005. if (!strcmp(question, "status/circuit-established")) {
  2006. *answer = tor_strdup(have_completed_a_circuit() ? "1" : "0");
  2007. } else if (!strcmp(question, "status/enough-dir-info")) {
  2008. *answer = tor_strdup(router_have_minimum_dir_info() ? "1" : "0");
  2009. } else if (!strcmp(question, "status/good-server-descriptor") ||
  2010. !strcmp(question, "status/accepted-server-descriptor")) {
  2011. /* They're equivalent for now, until we can figure out how to make
  2012. * good-server-descriptor be what we want. See comment in
  2013. * control-spec.txt. */
  2014. *answer = tor_strdup(directories_have_accepted_server_descriptor()
  2015. ? "1" : "0");
  2016. } else if (!strcmp(question, "status/reachability-succeeded/or")) {
  2017. *answer = tor_strdup(check_whether_orport_reachable() ? "1" : "0");
  2018. } else if (!strcmp(question, "status/reachability-succeeded/dir")) {
  2019. *answer = tor_strdup(check_whether_dirport_reachable() ? "1" : "0");
  2020. } else if (!strcmp(question, "status/reachability-succeeded")) {
  2021. tor_asprintf(answer, "OR=%d DIR=%d",
  2022. check_whether_orport_reachable() ? 1 : 0,
  2023. check_whether_dirport_reachable() ? 1 : 0);
  2024. } else if (!strcmp(question, "status/bootstrap-phase")) {
  2025. *answer = tor_strdup(last_sent_bootstrap_message);
  2026. } else if (!strcmpstart(question, "status/version/")) {
  2027. int is_server = server_mode(get_options());
  2028. networkstatus_t *c = networkstatus_get_latest_consensus();
  2029. version_status_t status;
  2030. const char *recommended;
  2031. if (c) {
  2032. recommended = is_server ? c->server_versions : c->client_versions;
  2033. status = tor_version_is_obsolete(VERSION, recommended);
  2034. } else {
  2035. recommended = "?";
  2036. status = VS_UNKNOWN;
  2037. }
  2038. if (!strcmp(question, "status/version/recommended")) {
  2039. *answer = tor_strdup(recommended);
  2040. return 0;
  2041. }
  2042. if (!strcmp(question, "status/version/current")) {
  2043. switch (status)
  2044. {
  2045. case VS_RECOMMENDED: *answer = tor_strdup("recommended"); break;
  2046. case VS_OLD: *answer = tor_strdup("obsolete"); break;
  2047. case VS_NEW: *answer = tor_strdup("new"); break;
  2048. case VS_NEW_IN_SERIES: *answer = tor_strdup("new in series"); break;
  2049. case VS_UNRECOMMENDED: *answer = tor_strdup("unrecommended"); break;
  2050. case VS_EMPTY: *answer = tor_strdup("none recommended"); break;
  2051. case VS_UNKNOWN: *answer = tor_strdup("unknown"); break;
  2052. default: tor_fragile_assert();
  2053. }
  2054. } else if (!strcmp(question, "status/version/num-versioning") ||
  2055. !strcmp(question, "status/version/num-concurring")) {
  2056. tor_asprintf(answer, "%d", get_n_authorities(V3_DIRINFO));
  2057. log_warn(LD_GENERAL, "%s is deprecated; it no longer gives useful "
  2058. "information", question);
  2059. }
  2060. } else if (!strcmp(question, "status/clients-seen")) {
  2061. char *bridge_stats = geoip_get_bridge_stats_controller(time(NULL));
  2062. if (!bridge_stats) {
  2063. *errmsg = "No bridge-client stats available";
  2064. return -1;
  2065. }
  2066. *answer = bridge_stats;
  2067. } else if (!strcmp(question, "status/fresh-relay-descs")) {
  2068. if (!server_mode(get_options())) {
  2069. *errmsg = "Only relays have descriptors";
  2070. return -1;
  2071. }
  2072. routerinfo_t *r;
  2073. extrainfo_t *e;
  2074. if (router_build_fresh_descriptor(&r, &e) < 0) {
  2075. *errmsg = "Error generating descriptor";
  2076. return -1;
  2077. }
  2078. size_t size = r->cache_info.signed_descriptor_len + 1;
  2079. if (e) {
  2080. size += e->cache_info.signed_descriptor_len + 1;
  2081. }
  2082. tor_assert(r->cache_info.signed_descriptor_len);
  2083. char *descs = tor_malloc(size);
  2084. char *cp = descs;
  2085. memcpy(cp, signed_descriptor_get_body(&r->cache_info),
  2086. r->cache_info.signed_descriptor_len);
  2087. cp += r->cache_info.signed_descriptor_len - 1;
  2088. if (e) {
  2089. if (cp[0] == '\0') {
  2090. cp[0] = '\n';
  2091. } else if (cp[0] != '\n') {
  2092. cp[1] = '\n';
  2093. cp++;
  2094. }
  2095. memcpy(cp, signed_descriptor_get_body(&e->cache_info),
  2096. e->cache_info.signed_descriptor_len);
  2097. cp += e->cache_info.signed_descriptor_len - 1;
  2098. }
  2099. if (cp[0] == '\n') {
  2100. cp[0] = '\0';
  2101. } else if (cp[0] != '\0') {
  2102. cp[1] = '\0';
  2103. }
  2104. *answer = descs;
  2105. routerinfo_free(r);
  2106. extrainfo_free(e);
  2107. } else {
  2108. return 0;
  2109. }
  2110. }
  2111. return 0;
  2112. }
  2113. /** Implementation helper for GETINFO: knows how to enumerate hidden services
  2114. * created via the control port. */
  2115. static int
  2116. getinfo_helper_onions(control_connection_t *control_conn,
  2117. const char *question, char **answer,
  2118. const char **errmsg)
  2119. {
  2120. smartlist_t *onion_list = NULL;
  2121. if (control_conn && !strcmp(question, "onions/current")) {
  2122. onion_list = control_conn->ephemeral_onion_services;
  2123. } else if (!strcmp(question, "onions/detached")) {
  2124. onion_list = detached_onion_services;
  2125. } else {
  2126. return 0;
  2127. }
  2128. if (!onion_list || smartlist_len(onion_list) == 0) {
  2129. if (errmsg) {
  2130. *errmsg = "No onion services of the specified type.";
  2131. }
  2132. return -1;
  2133. }
  2134. if (answer) {
  2135. *answer = smartlist_join_strings(onion_list, "\r\n", 0, NULL);
  2136. }
  2137. return 0;
  2138. }
  2139. /** Implementation helper for GETINFO: answers queries about network
  2140. * liveness. */
  2141. static int
  2142. getinfo_helper_liveness(control_connection_t *control_conn,
  2143. const char *question, char **answer,
  2144. const char **errmsg)
  2145. {
  2146. (void)control_conn;
  2147. (void)errmsg;
  2148. if (strcmp(question, "network-liveness") == 0) {
  2149. if (get_cached_network_liveness()) {
  2150. *answer = tor_strdup("up");
  2151. } else {
  2152. *answer = tor_strdup("down");
  2153. }
  2154. }
  2155. return 0;
  2156. }
  2157. /** Callback function for GETINFO: on a given control connection, try to
  2158. * answer the question <b>q</b> and store the newly-allocated answer in
  2159. * *<b>a</b>. If an internal error occurs, return -1 and optionally set
  2160. * *<b>error_out</b> to point to an error message to be delivered to the
  2161. * controller. On success, _or if the key is not recognized_, return 0. Do not
  2162. * set <b>a</b> if the key is not recognized.
  2163. */
  2164. typedef int (*getinfo_helper_t)(control_connection_t *,
  2165. const char *q, char **a,
  2166. const char **error_out);
  2167. /** A single item for the GETINFO question-to-answer-function table. */
  2168. typedef struct getinfo_item_t {
  2169. const char *varname; /**< The value (or prefix) of the question. */
  2170. getinfo_helper_t fn; /**< The function that knows the answer: NULL if
  2171. * this entry is documentation-only. */
  2172. const char *desc; /**< Description of the variable. */
  2173. int is_prefix; /** Must varname match exactly, or must it be a prefix? */
  2174. } getinfo_item_t;
  2175. #define ITEM(name, fn, desc) { name, getinfo_helper_##fn, desc, 0 }
  2176. #define PREFIX(name, fn, desc) { name, getinfo_helper_##fn, desc, 1 }
  2177. #define DOC(name, desc) { name, NULL, desc, 0 }
  2178. /** Table mapping questions accepted by GETINFO to the functions that know how
  2179. * to answer them. */
  2180. static const getinfo_item_t getinfo_items[] = {
  2181. ITEM("version", misc, "The current version of Tor."),
  2182. ITEM("bw-event-cache", misc, "Cached BW events for a short interval."),
  2183. ITEM("config-file", misc, "Current location of the \"torrc\" file."),
  2184. ITEM("config-defaults-file", misc, "Current location of the defaults file."),
  2185. ITEM("config-text", misc,
  2186. "Return the string that would be written by a saveconf command."),
  2187. ITEM("accounting/bytes", accounting,
  2188. "Number of bytes read/written so far in the accounting interval."),
  2189. ITEM("accounting/bytes-left", accounting,
  2190. "Number of bytes left to write/read so far in the accounting interval."),
  2191. ITEM("accounting/enabled", accounting, "Is accounting currently enabled?"),
  2192. ITEM("accounting/hibernating", accounting, "Are we hibernating or awake?"),
  2193. ITEM("accounting/interval-start", accounting,
  2194. "Time when the accounting period starts."),
  2195. ITEM("accounting/interval-end", accounting,
  2196. "Time when the accounting period ends."),
  2197. ITEM("accounting/interval-wake", accounting,
  2198. "Time to wake up in this accounting period."),
  2199. ITEM("helper-nodes", entry_guards, NULL), /* deprecated */
  2200. ITEM("entry-guards", entry_guards,
  2201. "Which nodes are we using as entry guards?"),
  2202. ITEM("fingerprint", misc, NULL),
  2203. PREFIX("config/", config, "Current configuration values."),
  2204. DOC("config/names",
  2205. "List of configuration options, types, and documentation."),
  2206. DOC("config/defaults",
  2207. "List of default values for configuration options. "
  2208. "See also config/names"),
  2209. ITEM("info/names", misc,
  2210. "List of GETINFO options, types, and documentation."),
  2211. ITEM("events/names", misc,
  2212. "Events that the controller can ask for with SETEVENTS."),
  2213. ITEM("signal/names", misc, "Signal names recognized by the SIGNAL command"),
  2214. ITEM("features/names", misc, "What arguments can USEFEATURE take?"),
  2215. PREFIX("desc/id/", dir, "Router descriptors by ID."),
  2216. PREFIX("desc/name/", dir, "Router descriptors by nickname."),
  2217. ITEM("desc/all-recent", dir,
  2218. "All non-expired, non-superseded router descriptors."),
  2219. ITEM("desc/all-recent-extrainfo-hack", dir, NULL), /* Hack. */
  2220. PREFIX("md/id/", dir, "Microdescriptors by ID"),
  2221. PREFIX("md/name/", dir, "Microdescriptors by name"),
  2222. PREFIX("extra-info/digest/", dir, "Extra-info documents by digest."),
  2223. PREFIX("hs/client/desc/id", dir,
  2224. "Hidden Service descriptor in client's cache by onion."),
  2225. PREFIX("net/listeners/", listeners, "Bound addresses by type"),
  2226. ITEM("ns/all", networkstatus,
  2227. "Brief summary of router status (v2 directory format)"),
  2228. PREFIX("ns/id/", networkstatus,
  2229. "Brief summary of router status by ID (v2 directory format)."),
  2230. PREFIX("ns/name/", networkstatus,
  2231. "Brief summary of router status by nickname (v2 directory format)."),
  2232. PREFIX("ns/purpose/", networkstatus,
  2233. "Brief summary of router status by purpose (v2 directory format)."),
  2234. PREFIX("consensus/", networkstatus,
  2235. "Information about and from the ns consensus."),
  2236. ITEM("network-status", dir,
  2237. "Brief summary of router status (v1 directory format)"),
  2238. ITEM("network-liveness", liveness,
  2239. "Current opinion on whether the network is live"),
  2240. ITEM("circuit-status", events, "List of current circuits originating here."),
  2241. ITEM("stream-status", events,"List of current streams."),
  2242. ITEM("orconn-status", events, "A list of current OR connections."),
  2243. ITEM("dormant", misc,
  2244. "Is Tor dormant (not building circuits because it's idle)?"),
  2245. PREFIX("address-mappings/", events, NULL),
  2246. DOC("address-mappings/all", "Current address mappings."),
  2247. DOC("address-mappings/cache", "Current cached DNS replies."),
  2248. DOC("address-mappings/config",
  2249. "Current address mappings from configuration."),
  2250. DOC("address-mappings/control", "Current address mappings from controller."),
  2251. PREFIX("status/", events, NULL),
  2252. DOC("status/circuit-established",
  2253. "Whether we think client functionality is working."),
  2254. DOC("status/enough-dir-info",
  2255. "Whether we have enough up-to-date directory information to build "
  2256. "circuits."),
  2257. DOC("status/bootstrap-phase",
  2258. "The last bootstrap phase status event that Tor sent."),
  2259. DOC("status/clients-seen",
  2260. "Breakdown of client countries seen by a bridge."),
  2261. DOC("status/fresh-relay-descs",
  2262. "A fresh relay/ei descriptor pair for Tor's current state. Not stored."),
  2263. DOC("status/version/recommended", "List of currently recommended versions."),
  2264. DOC("status/version/current", "Status of the current version."),
  2265. DOC("status/version/num-versioning", "Number of versioning authorities."),
  2266. DOC("status/version/num-concurring",
  2267. "Number of versioning authorities agreeing on the status of the "
  2268. "current version"),
  2269. ITEM("address", misc, "IP address of this Tor host, if we can guess it."),
  2270. ITEM("traffic/read", misc,"Bytes read since the process was started."),
  2271. ITEM("traffic/written", misc,
  2272. "Bytes written since the process was started."),
  2273. ITEM("process/pid", misc, "Process id belonging to the main tor process."),
  2274. ITEM("process/uid", misc, "User id running the tor process."),
  2275. ITEM("process/user", misc,
  2276. "Username under which the tor process is running."),
  2277. ITEM("process/descriptor-limit", misc, "File descriptor limit."),
  2278. ITEM("limits/max-mem-in-queues", misc, "Actual limit on memory in queues"),
  2279. ITEM("dir-usage", misc, "Breakdown of bytes transferred over DirPort."),
  2280. PREFIX("desc-annotations/id/", dir, "Router annotations by hexdigest."),
  2281. PREFIX("dir/server/", dir,"Router descriptors as retrieved from a DirPort."),
  2282. PREFIX("dir/status/", dir,
  2283. "v2 networkstatus docs as retrieved from a DirPort."),
  2284. ITEM("dir/status-vote/current/consensus", dir,
  2285. "v3 Networkstatus consensus as retrieved from a DirPort."),
  2286. ITEM("exit-policy/default", policies,
  2287. "The default value appended to the configured exit policy."),
  2288. ITEM("exit-policy/full", policies, "The entire exit policy of onion router"),
  2289. ITEM("exit-policy/ipv4", policies, "IPv4 parts of exit policy"),
  2290. ITEM("exit-policy/ipv6", policies, "IPv6 parts of exit policy"),
  2291. PREFIX("ip-to-country/", geoip, "Perform a GEOIP lookup"),
  2292. ITEM("onions/current", onions,
  2293. "Onion services owned by the current control connection."),
  2294. ITEM("onions/detached", onions,
  2295. "Onion services detached from the control connection."),
  2296. { NULL, NULL, NULL, 0 }
  2297. };
  2298. /** Allocate and return a list of recognized GETINFO options. */
  2299. static char *
  2300. list_getinfo_options(void)
  2301. {
  2302. int i;
  2303. smartlist_t *lines = smartlist_new();
  2304. char *ans;
  2305. for (i = 0; getinfo_items[i].varname; ++i) {
  2306. if (!getinfo_items[i].desc)
  2307. continue;
  2308. smartlist_add_asprintf(lines, "%s%s -- %s\n",
  2309. getinfo_items[i].varname,
  2310. getinfo_items[i].is_prefix ? "*" : "",
  2311. getinfo_items[i].desc);
  2312. }
  2313. smartlist_sort_strings(lines);
  2314. ans = smartlist_join_strings(lines, "", 0, NULL);
  2315. SMARTLIST_FOREACH(lines, char *, cp, tor_free(cp));
  2316. smartlist_free(lines);
  2317. return ans;
  2318. }
  2319. /** Lookup the 'getinfo' entry <b>question</b>, and return
  2320. * the answer in <b>*answer</b> (or NULL if key not recognized).
  2321. * Return 0 if success or unrecognized, or -1 if recognized but
  2322. * internal error. */
  2323. static int
  2324. handle_getinfo_helper(control_connection_t *control_conn,
  2325. const char *question, char **answer,
  2326. const char **err_out)
  2327. {
  2328. int i;
  2329. *answer = NULL; /* unrecognized key by default */
  2330. for (i = 0; getinfo_items[i].varname; ++i) {
  2331. int match;
  2332. if (getinfo_items[i].is_prefix)
  2333. match = !strcmpstart(question, getinfo_items[i].varname);
  2334. else
  2335. match = !strcmp(question, getinfo_items[i].varname);
  2336. if (match) {
  2337. tor_assert(getinfo_items[i].fn);
  2338. return getinfo_items[i].fn(control_conn, question, answer, err_out);
  2339. }
  2340. }
  2341. return 0; /* unrecognized */
  2342. }
  2343. /** Called when we receive a GETINFO command. Try to fetch all requested
  2344. * information, and reply with information or error message. */
  2345. static int
  2346. handle_control_getinfo(control_connection_t *conn, uint32_t len,
  2347. const char *body)
  2348. {
  2349. smartlist_t *questions = smartlist_new();
  2350. smartlist_t *answers = smartlist_new();
  2351. smartlist_t *unrecognized = smartlist_new();
  2352. char *msg = NULL, *ans = NULL;
  2353. int i;
  2354. (void) len; /* body is NUL-terminated, so it's safe to ignore the length. */
  2355. smartlist_split_string(questions, body, " ",
  2356. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  2357. SMARTLIST_FOREACH_BEGIN(questions, const char *, q) {
  2358. const char *errmsg = NULL;
  2359. if (handle_getinfo_helper(conn, q, &ans, &errmsg) < 0) {
  2360. if (!errmsg)
  2361. errmsg = "Internal error";
  2362. connection_printf_to_buf(conn, "551 %s\r\n", errmsg);
  2363. goto done;
  2364. }
  2365. if (!ans) {
  2366. smartlist_add(unrecognized, (char*)q);
  2367. } else {
  2368. smartlist_add(answers, tor_strdup(q));
  2369. smartlist_add(answers, ans);
  2370. }
  2371. } SMARTLIST_FOREACH_END(q);
  2372. if (smartlist_len(unrecognized)) {
  2373. for (i=0; i < smartlist_len(unrecognized)-1; ++i)
  2374. connection_printf_to_buf(conn,
  2375. "552-Unrecognized key \"%s\"\r\n",
  2376. (char*)smartlist_get(unrecognized, i));
  2377. connection_printf_to_buf(conn,
  2378. "552 Unrecognized key \"%s\"\r\n",
  2379. (char*)smartlist_get(unrecognized, i));
  2380. goto done;
  2381. }
  2382. for (i = 0; i < smartlist_len(answers); i += 2) {
  2383. char *k = smartlist_get(answers, i);
  2384. char *v = smartlist_get(answers, i+1);
  2385. if (!strchr(v, '\n') && !strchr(v, '\r')) {
  2386. connection_printf_to_buf(conn, "250-%s=", k);
  2387. connection_write_str_to_buf(v, conn);
  2388. connection_write_str_to_buf("\r\n", conn);
  2389. } else {
  2390. char *esc = NULL;
  2391. size_t esc_len;
  2392. esc_len = write_escaped_data(v, strlen(v), &esc);
  2393. connection_printf_to_buf(conn, "250+%s=\r\n", k);
  2394. connection_write_to_buf(esc, esc_len, TO_CONN(conn));
  2395. tor_free(esc);
  2396. }
  2397. }
  2398. connection_write_str_to_buf("250 OK\r\n", conn);
  2399. done:
  2400. SMARTLIST_FOREACH(answers, char *, cp, tor_free(cp));
  2401. smartlist_free(answers);
  2402. SMARTLIST_FOREACH(questions, char *, cp, tor_free(cp));
  2403. smartlist_free(questions);
  2404. smartlist_free(unrecognized);
  2405. tor_free(msg);
  2406. return 0;
  2407. }
  2408. /** Given a string, convert it to a circuit purpose. */
  2409. static uint8_t
  2410. circuit_purpose_from_string(const char *string)
  2411. {
  2412. if (!strcasecmpstart(string, "purpose="))
  2413. string += strlen("purpose=");
  2414. if (!strcasecmp(string, "general"))
  2415. return CIRCUIT_PURPOSE_C_GENERAL;
  2416. else if (!strcasecmp(string, "controller"))
  2417. return CIRCUIT_PURPOSE_CONTROLLER;
  2418. else
  2419. return CIRCUIT_PURPOSE_UNKNOWN;
  2420. }
  2421. /** Return a newly allocated smartlist containing the arguments to the command
  2422. * waiting in <b>body</b>. If there are fewer than <b>min_args</b> arguments,
  2423. * or if <b>max_args</b> is nonnegative and there are more than
  2424. * <b>max_args</b> arguments, send a 512 error to the controller, using
  2425. * <b>command</b> as the command name in the error message. */
  2426. static smartlist_t *
  2427. getargs_helper(const char *command, control_connection_t *conn,
  2428. const char *body, int min_args, int max_args)
  2429. {
  2430. smartlist_t *args = smartlist_new();
  2431. smartlist_split_string(args, body, " ",
  2432. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  2433. if (smartlist_len(args) < min_args) {
  2434. connection_printf_to_buf(conn, "512 Missing argument to %s\r\n",command);
  2435. goto err;
  2436. } else if (max_args >= 0 && smartlist_len(args) > max_args) {
  2437. connection_printf_to_buf(conn, "512 Too many arguments to %s\r\n",command);
  2438. goto err;
  2439. }
  2440. return args;
  2441. err:
  2442. SMARTLIST_FOREACH(args, char *, s, tor_free(s));
  2443. smartlist_free(args);
  2444. return NULL;
  2445. }
  2446. /** Helper. Return the first element of <b>sl</b> at index <b>start_at</b> or
  2447. * higher that starts with <b>prefix</b>, case-insensitive. Return NULL if no
  2448. * such element exists. */
  2449. static const char *
  2450. find_element_starting_with(smartlist_t *sl, int start_at, const char *prefix)
  2451. {
  2452. int i;
  2453. for (i = start_at; i < smartlist_len(sl); ++i) {
  2454. const char *elt = smartlist_get(sl, i);
  2455. if (!strcasecmpstart(elt, prefix))
  2456. return elt;
  2457. }
  2458. return NULL;
  2459. }
  2460. /** Helper. Return true iff s is an argument that we should treat as a
  2461. * key-value pair. */
  2462. static int
  2463. is_keyval_pair(const char *s)
  2464. {
  2465. /* An argument is a key-value pair if it has an =, and it isn't of the form
  2466. * $fingeprint=name */
  2467. return strchr(s, '=') && s[0] != '$';
  2468. }
  2469. /** Called when we get an EXTENDCIRCUIT message. Try to extend the listed
  2470. * circuit, and report success or failure. */
  2471. static int
  2472. handle_control_extendcircuit(control_connection_t *conn, uint32_t len,
  2473. const char *body)
  2474. {
  2475. smartlist_t *router_nicknames=NULL, *nodes=NULL;
  2476. origin_circuit_t *circ = NULL;
  2477. int zero_circ;
  2478. uint8_t intended_purpose = CIRCUIT_PURPOSE_C_GENERAL;
  2479. smartlist_t *args;
  2480. (void) len;
  2481. router_nicknames = smartlist_new();
  2482. args = getargs_helper("EXTENDCIRCUIT", conn, body, 1, -1);
  2483. if (!args)
  2484. goto done;
  2485. zero_circ = !strcmp("0", (char*)smartlist_get(args,0));
  2486. if (zero_circ) {
  2487. const char *purp = find_element_starting_with(args, 1, "PURPOSE=");
  2488. if (purp) {
  2489. intended_purpose = circuit_purpose_from_string(purp);
  2490. if (intended_purpose == CIRCUIT_PURPOSE_UNKNOWN) {
  2491. connection_printf_to_buf(conn, "552 Unknown purpose \"%s\"\r\n", purp);
  2492. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2493. smartlist_free(args);
  2494. goto done;
  2495. }
  2496. }
  2497. if ((smartlist_len(args) == 1) ||
  2498. (smartlist_len(args) >= 2 && is_keyval_pair(smartlist_get(args, 1)))) {
  2499. // "EXTENDCIRCUIT 0" || EXTENDCIRCUIT 0 foo=bar"
  2500. circ = circuit_launch(intended_purpose, CIRCLAUNCH_NEED_CAPACITY);
  2501. if (!circ) {
  2502. connection_write_str_to_buf("551 Couldn't start circuit\r\n", conn);
  2503. } else {
  2504. connection_printf_to_buf(conn, "250 EXTENDED %lu\r\n",
  2505. (unsigned long)circ->global_identifier);
  2506. }
  2507. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2508. smartlist_free(args);
  2509. goto done;
  2510. }
  2511. // "EXTENDCIRCUIT 0 router1,router2" ||
  2512. // "EXTENDCIRCUIT 0 router1,router2 PURPOSE=foo"
  2513. }
  2514. if (!zero_circ && !(circ = get_circ(smartlist_get(args,0)))) {
  2515. connection_printf_to_buf(conn, "552 Unknown circuit \"%s\"\r\n",
  2516. (char*)smartlist_get(args, 0));
  2517. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2518. smartlist_free(args);
  2519. goto done;
  2520. }
  2521. if (smartlist_len(args) < 2) {
  2522. connection_printf_to_buf(conn,
  2523. "512 syntax error: not enough arguments.\r\n");
  2524. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2525. smartlist_free(args);
  2526. goto done;
  2527. }
  2528. smartlist_split_string(router_nicknames, smartlist_get(args,1), ",", 0, 0);
  2529. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2530. smartlist_free(args);
  2531. nodes = smartlist_new();
  2532. SMARTLIST_FOREACH_BEGIN(router_nicknames, const char *, n) {
  2533. const node_t *node = node_get_by_nickname(n, 1);
  2534. if (!node) {
  2535. connection_printf_to_buf(conn, "552 No such router \"%s\"\r\n", n);
  2536. goto done;
  2537. }
  2538. if (!node_has_descriptor(node)) {
  2539. connection_printf_to_buf(conn, "552 No descriptor for \"%s\"\r\n", n);
  2540. goto done;
  2541. }
  2542. smartlist_add(nodes, (void*)node);
  2543. } SMARTLIST_FOREACH_END(n);
  2544. if (!smartlist_len(nodes)) {
  2545. connection_write_str_to_buf("512 No router names provided\r\n", conn);
  2546. goto done;
  2547. }
  2548. if (zero_circ) {
  2549. /* start a new circuit */
  2550. circ = origin_circuit_init(intended_purpose, 0);
  2551. }
  2552. /* now circ refers to something that is ready to be extended */
  2553. SMARTLIST_FOREACH(nodes, const node_t *, node,
  2554. {
  2555. extend_info_t *info = extend_info_from_node(node, 0);
  2556. tor_assert(info); /* True, since node_has_descriptor(node) == true */
  2557. circuit_append_new_exit(circ, info);
  2558. extend_info_free(info);
  2559. });
  2560. /* now that we've populated the cpath, start extending */
  2561. if (zero_circ) {
  2562. int err_reason = 0;
  2563. if ((err_reason = circuit_handle_first_hop(circ)) < 0) {
  2564. circuit_mark_for_close(TO_CIRCUIT(circ), -err_reason);
  2565. connection_write_str_to_buf("551 Couldn't start circuit\r\n", conn);
  2566. goto done;
  2567. }
  2568. } else {
  2569. if (circ->base_.state == CIRCUIT_STATE_OPEN) {
  2570. int err_reason = 0;
  2571. circuit_set_state(TO_CIRCUIT(circ), CIRCUIT_STATE_BUILDING);
  2572. if ((err_reason = circuit_send_next_onion_skin(circ)) < 0) {
  2573. log_info(LD_CONTROL,
  2574. "send_next_onion_skin failed; circuit marked for closing.");
  2575. circuit_mark_for_close(TO_CIRCUIT(circ), -err_reason);
  2576. connection_write_str_to_buf("551 Couldn't send onion skin\r\n", conn);
  2577. goto done;
  2578. }
  2579. }
  2580. }
  2581. connection_printf_to_buf(conn, "250 EXTENDED %lu\r\n",
  2582. (unsigned long)circ->global_identifier);
  2583. if (zero_circ) /* send a 'launched' event, for completeness */
  2584. control_event_circuit_status(circ, CIRC_EVENT_LAUNCHED, 0);
  2585. done:
  2586. SMARTLIST_FOREACH(router_nicknames, char *, n, tor_free(n));
  2587. smartlist_free(router_nicknames);
  2588. smartlist_free(nodes);
  2589. return 0;
  2590. }
  2591. /** Called when we get a SETCIRCUITPURPOSE message. If we can find the
  2592. * circuit and it's a valid purpose, change it. */
  2593. static int
  2594. handle_control_setcircuitpurpose(control_connection_t *conn,
  2595. uint32_t len, const char *body)
  2596. {
  2597. origin_circuit_t *circ = NULL;
  2598. uint8_t new_purpose;
  2599. smartlist_t *args;
  2600. (void) len; /* body is NUL-terminated, so it's safe to ignore the length. */
  2601. args = getargs_helper("SETCIRCUITPURPOSE", conn, body, 2, -1);
  2602. if (!args)
  2603. goto done;
  2604. if (!(circ = get_circ(smartlist_get(args,0)))) {
  2605. connection_printf_to_buf(conn, "552 Unknown circuit \"%s\"\r\n",
  2606. (char*)smartlist_get(args, 0));
  2607. goto done;
  2608. }
  2609. {
  2610. const char *purp = find_element_starting_with(args,1,"PURPOSE=");
  2611. if (!purp) {
  2612. connection_write_str_to_buf("552 No purpose given\r\n", conn);
  2613. goto done;
  2614. }
  2615. new_purpose = circuit_purpose_from_string(purp);
  2616. if (new_purpose == CIRCUIT_PURPOSE_UNKNOWN) {
  2617. connection_printf_to_buf(conn, "552 Unknown purpose \"%s\"\r\n", purp);
  2618. goto done;
  2619. }
  2620. }
  2621. circuit_change_purpose(TO_CIRCUIT(circ), new_purpose);
  2622. connection_write_str_to_buf("250 OK\r\n", conn);
  2623. done:
  2624. if (args) {
  2625. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2626. smartlist_free(args);
  2627. }
  2628. return 0;
  2629. }
  2630. /** Called when we get an ATTACHSTREAM message. Try to attach the requested
  2631. * stream, and report success or failure. */
  2632. static int
  2633. handle_control_attachstream(control_connection_t *conn, uint32_t len,
  2634. const char *body)
  2635. {
  2636. entry_connection_t *ap_conn = NULL;
  2637. origin_circuit_t *circ = NULL;
  2638. int zero_circ;
  2639. smartlist_t *args;
  2640. crypt_path_t *cpath=NULL;
  2641. int hop=0, hop_line_ok=1;
  2642. (void) len;
  2643. args = getargs_helper("ATTACHSTREAM", conn, body, 2, -1);
  2644. if (!args)
  2645. return 0;
  2646. zero_circ = !strcmp("0", (char*)smartlist_get(args,1));
  2647. if (!(ap_conn = get_stream(smartlist_get(args, 0)))) {
  2648. connection_printf_to_buf(conn, "552 Unknown stream \"%s\"\r\n",
  2649. (char*)smartlist_get(args, 0));
  2650. } else if (!zero_circ && !(circ = get_circ(smartlist_get(args, 1)))) {
  2651. connection_printf_to_buf(conn, "552 Unknown circuit \"%s\"\r\n",
  2652. (char*)smartlist_get(args, 1));
  2653. } else if (circ) {
  2654. const char *hopstring = find_element_starting_with(args,2,"HOP=");
  2655. if (hopstring) {
  2656. hopstring += strlen("HOP=");
  2657. hop = (int) tor_parse_ulong(hopstring, 10, 0, INT_MAX,
  2658. &hop_line_ok, NULL);
  2659. if (!hop_line_ok) { /* broken hop line */
  2660. connection_printf_to_buf(conn, "552 Bad value hop=%s\r\n", hopstring);
  2661. }
  2662. }
  2663. }
  2664. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2665. smartlist_free(args);
  2666. if (!ap_conn || (!zero_circ && !circ) || !hop_line_ok)
  2667. return 0;
  2668. if (ENTRY_TO_CONN(ap_conn)->state != AP_CONN_STATE_CONTROLLER_WAIT &&
  2669. ENTRY_TO_CONN(ap_conn)->state != AP_CONN_STATE_CONNECT_WAIT &&
  2670. ENTRY_TO_CONN(ap_conn)->state != AP_CONN_STATE_RESOLVE_WAIT) {
  2671. connection_write_str_to_buf(
  2672. "555 Connection is not managed by controller.\r\n",
  2673. conn);
  2674. return 0;
  2675. }
  2676. /* Do we need to detach it first? */
  2677. if (ENTRY_TO_CONN(ap_conn)->state != AP_CONN_STATE_CONTROLLER_WAIT) {
  2678. edge_connection_t *edge_conn = ENTRY_TO_EDGE_CONN(ap_conn);
  2679. circuit_t *tmpcirc = circuit_get_by_edge_conn(edge_conn);
  2680. connection_edge_end(edge_conn, END_STREAM_REASON_TIMEOUT);
  2681. /* Un-mark it as ending, since we're going to reuse it. */
  2682. edge_conn->edge_has_sent_end = 0;
  2683. edge_conn->end_reason = 0;
  2684. if (tmpcirc)
  2685. circuit_detach_stream(tmpcirc, edge_conn);
  2686. TO_CONN(edge_conn)->state = AP_CONN_STATE_CONTROLLER_WAIT;
  2687. }
  2688. if (circ && (circ->base_.state != CIRCUIT_STATE_OPEN)) {
  2689. connection_write_str_to_buf(
  2690. "551 Can't attach stream to non-open origin circuit\r\n",
  2691. conn);
  2692. return 0;
  2693. }
  2694. /* Is this a single hop circuit? */
  2695. if (circ && (circuit_get_cpath_len(circ)<2 || hop==1)) {
  2696. const node_t *node = NULL;
  2697. char *exit_digest = NULL;
  2698. if (circ->build_state &&
  2699. circ->build_state->chosen_exit &&
  2700. !tor_digest_is_zero(circ->build_state->chosen_exit->identity_digest)) {
  2701. exit_digest = circ->build_state->chosen_exit->identity_digest;
  2702. node = node_get_by_id(exit_digest);
  2703. }
  2704. /* Do both the client and relay allow one-hop exit circuits? */
  2705. if (!node ||
  2706. !node_allows_single_hop_exits(node) ||
  2707. !get_options()->AllowSingleHopCircuits) {
  2708. connection_write_str_to_buf(
  2709. "551 Can't attach stream to this one-hop circuit.\r\n", conn);
  2710. return 0;
  2711. }
  2712. tor_assert(exit_digest);
  2713. ap_conn->chosen_exit_name = tor_strdup(hex_str(exit_digest, DIGEST_LEN));
  2714. }
  2715. if (circ && hop>0) {
  2716. /* find this hop in the circuit, and set cpath */
  2717. cpath = circuit_get_cpath_hop(circ, hop);
  2718. if (!cpath) {
  2719. connection_printf_to_buf(conn,
  2720. "551 Circuit doesn't have %d hops.\r\n", hop);
  2721. return 0;
  2722. }
  2723. }
  2724. if (connection_ap_handshake_rewrite_and_attach(ap_conn, circ, cpath) < 0) {
  2725. connection_write_str_to_buf("551 Unable to attach stream\r\n", conn);
  2726. return 0;
  2727. }
  2728. send_control_done(conn);
  2729. return 0;
  2730. }
  2731. /** Called when we get a POSTDESCRIPTOR message. Try to learn the provided
  2732. * descriptor, and report success or failure. */
  2733. static int
  2734. handle_control_postdescriptor(control_connection_t *conn, uint32_t len,
  2735. const char *body)
  2736. {
  2737. char *desc;
  2738. const char *msg=NULL;
  2739. uint8_t purpose = ROUTER_PURPOSE_GENERAL;
  2740. int cache = 0; /* eventually, we may switch this to 1 */
  2741. const char *cp = memchr(body, '\n', len);
  2742. smartlist_t *args = smartlist_new();
  2743. tor_assert(cp);
  2744. ++cp;
  2745. char *cmdline = tor_memdup_nulterm(body, cp-body);
  2746. smartlist_split_string(args, cmdline, " ",
  2747. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  2748. SMARTLIST_FOREACH_BEGIN(args, char *, option) {
  2749. if (!strcasecmpstart(option, "purpose=")) {
  2750. option += strlen("purpose=");
  2751. purpose = router_purpose_from_string(option);
  2752. if (purpose == ROUTER_PURPOSE_UNKNOWN) {
  2753. connection_printf_to_buf(conn, "552 Unknown purpose \"%s\"\r\n",
  2754. option);
  2755. goto done;
  2756. }
  2757. } else if (!strcasecmpstart(option, "cache=")) {
  2758. option += strlen("cache=");
  2759. if (!strcasecmp(option, "no"))
  2760. cache = 0;
  2761. else if (!strcasecmp(option, "yes"))
  2762. cache = 1;
  2763. else {
  2764. connection_printf_to_buf(conn, "552 Unknown cache request \"%s\"\r\n",
  2765. option);
  2766. goto done;
  2767. }
  2768. } else { /* unrecognized argument? */
  2769. connection_printf_to_buf(conn,
  2770. "512 Unexpected argument \"%s\" to postdescriptor\r\n", option);
  2771. goto done;
  2772. }
  2773. } SMARTLIST_FOREACH_END(option);
  2774. read_escaped_data(cp, len-(cp-body), &desc);
  2775. switch (router_load_single_router(desc, purpose, cache, &msg)) {
  2776. case -1:
  2777. if (!msg) msg = "Could not parse descriptor";
  2778. connection_printf_to_buf(conn, "554 %s\r\n", msg);
  2779. break;
  2780. case 0:
  2781. if (!msg) msg = "Descriptor not added";
  2782. connection_printf_to_buf(conn, "251 %s\r\n",msg);
  2783. break;
  2784. case 1:
  2785. send_control_done(conn);
  2786. break;
  2787. }
  2788. tor_free(desc);
  2789. done:
  2790. SMARTLIST_FOREACH(args, char *, arg, tor_free(arg));
  2791. smartlist_free(args);
  2792. tor_free(cmdline);
  2793. return 0;
  2794. }
  2795. /** Called when we receive a REDIRECTSTERAM command. Try to change the target
  2796. * address of the named AP stream, and report success or failure. */
  2797. static int
  2798. handle_control_redirectstream(control_connection_t *conn, uint32_t len,
  2799. const char *body)
  2800. {
  2801. entry_connection_t *ap_conn = NULL;
  2802. char *new_addr = NULL;
  2803. uint16_t new_port = 0;
  2804. smartlist_t *args;
  2805. (void) len;
  2806. args = getargs_helper("REDIRECTSTREAM", conn, body, 2, -1);
  2807. if (!args)
  2808. return 0;
  2809. if (!(ap_conn = get_stream(smartlist_get(args, 0)))
  2810. || !ap_conn->socks_request) {
  2811. connection_printf_to_buf(conn, "552 Unknown stream \"%s\"\r\n",
  2812. (char*)smartlist_get(args, 0));
  2813. } else {
  2814. int ok = 1;
  2815. if (smartlist_len(args) > 2) { /* they included a port too */
  2816. new_port = (uint16_t) tor_parse_ulong(smartlist_get(args, 2),
  2817. 10, 1, 65535, &ok, NULL);
  2818. }
  2819. if (!ok) {
  2820. connection_printf_to_buf(conn, "512 Cannot parse port \"%s\"\r\n",
  2821. (char*)smartlist_get(args, 2));
  2822. } else {
  2823. new_addr = tor_strdup(smartlist_get(args, 1));
  2824. }
  2825. }
  2826. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2827. smartlist_free(args);
  2828. if (!new_addr)
  2829. return 0;
  2830. strlcpy(ap_conn->socks_request->address, new_addr,
  2831. sizeof(ap_conn->socks_request->address));
  2832. if (new_port)
  2833. ap_conn->socks_request->port = new_port;
  2834. tor_free(new_addr);
  2835. send_control_done(conn);
  2836. return 0;
  2837. }
  2838. /** Called when we get a CLOSESTREAM command; try to close the named stream
  2839. * and report success or failure. */
  2840. static int
  2841. handle_control_closestream(control_connection_t *conn, uint32_t len,
  2842. const char *body)
  2843. {
  2844. entry_connection_t *ap_conn=NULL;
  2845. uint8_t reason=0;
  2846. smartlist_t *args;
  2847. int ok;
  2848. (void) len;
  2849. args = getargs_helper("CLOSESTREAM", conn, body, 2, -1);
  2850. if (!args)
  2851. return 0;
  2852. else if (!(ap_conn = get_stream(smartlist_get(args, 0))))
  2853. connection_printf_to_buf(conn, "552 Unknown stream \"%s\"\r\n",
  2854. (char*)smartlist_get(args, 0));
  2855. else {
  2856. reason = (uint8_t) tor_parse_ulong(smartlist_get(args,1), 10, 0, 255,
  2857. &ok, NULL);
  2858. if (!ok) {
  2859. connection_printf_to_buf(conn, "552 Unrecognized reason \"%s\"\r\n",
  2860. (char*)smartlist_get(args, 1));
  2861. ap_conn = NULL;
  2862. }
  2863. }
  2864. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2865. smartlist_free(args);
  2866. if (!ap_conn)
  2867. return 0;
  2868. connection_mark_unattached_ap(ap_conn, reason);
  2869. send_control_done(conn);
  2870. return 0;
  2871. }
  2872. /** Called when we get a CLOSECIRCUIT command; try to close the named circuit
  2873. * and report success or failure. */
  2874. static int
  2875. handle_control_closecircuit(control_connection_t *conn, uint32_t len,
  2876. const char *body)
  2877. {
  2878. origin_circuit_t *circ = NULL;
  2879. int safe = 0;
  2880. smartlist_t *args;
  2881. (void) len;
  2882. args = getargs_helper("CLOSECIRCUIT", conn, body, 1, -1);
  2883. if (!args)
  2884. return 0;
  2885. if (!(circ=get_circ(smartlist_get(args, 0))))
  2886. connection_printf_to_buf(conn, "552 Unknown circuit \"%s\"\r\n",
  2887. (char*)smartlist_get(args, 0));
  2888. else {
  2889. int i;
  2890. for (i=1; i < smartlist_len(args); ++i) {
  2891. if (!strcasecmp(smartlist_get(args, i), "IfUnused"))
  2892. safe = 1;
  2893. else
  2894. log_info(LD_CONTROL, "Skipping unknown option %s",
  2895. (char*)smartlist_get(args,i));
  2896. }
  2897. }
  2898. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2899. smartlist_free(args);
  2900. if (!circ)
  2901. return 0;
  2902. if (!safe || !circ->p_streams) {
  2903. circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_REQUESTED);
  2904. }
  2905. send_control_done(conn);
  2906. return 0;
  2907. }
  2908. /** Called when we get a RESOLVE command: start trying to resolve
  2909. * the listed addresses. */
  2910. static int
  2911. handle_control_resolve(control_connection_t *conn, uint32_t len,
  2912. const char *body)
  2913. {
  2914. smartlist_t *args, *failed;
  2915. int is_reverse = 0;
  2916. (void) len; /* body is nul-terminated; it's safe to ignore the length */
  2917. if (!(conn->event_mask & (((event_mask_t)1)<<EVENT_ADDRMAP))) {
  2918. log_warn(LD_CONTROL, "Controller asked us to resolve an address, but "
  2919. "isn't listening for ADDRMAP events. It probably won't see "
  2920. "the answer.");
  2921. }
  2922. args = smartlist_new();
  2923. smartlist_split_string(args, body, " ",
  2924. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  2925. {
  2926. const char *modearg = find_element_starting_with(args, 0, "mode=");
  2927. if (modearg && !strcasecmp(modearg, "mode=reverse"))
  2928. is_reverse = 1;
  2929. }
  2930. failed = smartlist_new();
  2931. SMARTLIST_FOREACH(args, const char *, arg, {
  2932. if (!is_keyval_pair(arg)) {
  2933. if (dnsserv_launch_request(arg, is_reverse, conn)<0)
  2934. smartlist_add(failed, (char*)arg);
  2935. }
  2936. });
  2937. send_control_done(conn);
  2938. SMARTLIST_FOREACH(failed, const char *, arg, {
  2939. control_event_address_mapped(arg, arg, time(NULL),
  2940. "internal", 0);
  2941. });
  2942. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  2943. smartlist_free(args);
  2944. smartlist_free(failed);
  2945. return 0;
  2946. }
  2947. /** Called when we get a PROTOCOLINFO command: send back a reply. */
  2948. static int
  2949. handle_control_protocolinfo(control_connection_t *conn, uint32_t len,
  2950. const char *body)
  2951. {
  2952. const char *bad_arg = NULL;
  2953. smartlist_t *args;
  2954. (void)len;
  2955. conn->have_sent_protocolinfo = 1;
  2956. args = smartlist_new();
  2957. smartlist_split_string(args, body, " ",
  2958. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  2959. SMARTLIST_FOREACH(args, const char *, arg, {
  2960. int ok;
  2961. tor_parse_long(arg, 10, 0, LONG_MAX, &ok, NULL);
  2962. if (!ok) {
  2963. bad_arg = arg;
  2964. break;
  2965. }
  2966. });
  2967. if (bad_arg) {
  2968. connection_printf_to_buf(conn, "513 No such version %s\r\n",
  2969. escaped(bad_arg));
  2970. /* Don't tolerate bad arguments when not authenticated. */
  2971. if (!STATE_IS_OPEN(TO_CONN(conn)->state))
  2972. connection_mark_for_close(TO_CONN(conn));
  2973. goto done;
  2974. } else {
  2975. const or_options_t *options = get_options();
  2976. int cookies = options->CookieAuthentication;
  2977. char *cfile = get_controller_cookie_file_name();
  2978. char *abs_cfile;
  2979. char *esc_cfile;
  2980. char *methods;
  2981. abs_cfile = make_path_absolute(cfile);
  2982. esc_cfile = esc_for_log(abs_cfile);
  2983. {
  2984. int passwd = (options->HashedControlPassword != NULL ||
  2985. options->HashedControlSessionPassword != NULL);
  2986. smartlist_t *mlist = smartlist_new();
  2987. if (cookies) {
  2988. smartlist_add(mlist, (char*)"COOKIE");
  2989. smartlist_add(mlist, (char*)"SAFECOOKIE");
  2990. }
  2991. if (passwd)
  2992. smartlist_add(mlist, (char*)"HASHEDPASSWORD");
  2993. if (!cookies && !passwd)
  2994. smartlist_add(mlist, (char*)"NULL");
  2995. methods = smartlist_join_strings(mlist, ",", 0, NULL);
  2996. smartlist_free(mlist);
  2997. }
  2998. connection_printf_to_buf(conn,
  2999. "250-PROTOCOLINFO 1\r\n"
  3000. "250-AUTH METHODS=%s%s%s\r\n"
  3001. "250-VERSION Tor=%s\r\n"
  3002. "250 OK\r\n",
  3003. methods,
  3004. cookies?" COOKIEFILE=":"",
  3005. cookies?esc_cfile:"",
  3006. escaped(VERSION));
  3007. tor_free(methods);
  3008. tor_free(cfile);
  3009. tor_free(abs_cfile);
  3010. tor_free(esc_cfile);
  3011. }
  3012. done:
  3013. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  3014. smartlist_free(args);
  3015. return 0;
  3016. }
  3017. /** Called when we get an AUTHCHALLENGE command. */
  3018. static int
  3019. handle_control_authchallenge(control_connection_t *conn, uint32_t len,
  3020. const char *body)
  3021. {
  3022. const char *cp = body;
  3023. char *client_nonce;
  3024. size_t client_nonce_len;
  3025. char server_hash[DIGEST256_LEN];
  3026. char server_hash_encoded[HEX_DIGEST256_LEN+1];
  3027. char server_nonce[SAFECOOKIE_SERVER_NONCE_LEN];
  3028. char server_nonce_encoded[(2*SAFECOOKIE_SERVER_NONCE_LEN) + 1];
  3029. cp += strspn(cp, " \t\n\r");
  3030. if (!strcasecmpstart(cp, "SAFECOOKIE")) {
  3031. cp += strlen("SAFECOOKIE");
  3032. } else {
  3033. connection_write_str_to_buf("513 AUTHCHALLENGE only supports SAFECOOKIE "
  3034. "authentication\r\n", conn);
  3035. connection_mark_for_close(TO_CONN(conn));
  3036. return -1;
  3037. }
  3038. if (!authentication_cookie_is_set) {
  3039. connection_write_str_to_buf("515 Cookie authentication is disabled\r\n",
  3040. conn);
  3041. connection_mark_for_close(TO_CONN(conn));
  3042. return -1;
  3043. }
  3044. cp += strspn(cp, " \t\n\r");
  3045. if (*cp == '"') {
  3046. const char *newcp =
  3047. decode_escaped_string(cp, len - (cp - body),
  3048. &client_nonce, &client_nonce_len);
  3049. if (newcp == NULL) {
  3050. connection_write_str_to_buf("513 Invalid quoted client nonce\r\n",
  3051. conn);
  3052. connection_mark_for_close(TO_CONN(conn));
  3053. return -1;
  3054. }
  3055. cp = newcp;
  3056. } else {
  3057. size_t client_nonce_encoded_len = strspn(cp, "0123456789ABCDEFabcdef");
  3058. client_nonce_len = client_nonce_encoded_len / 2;
  3059. client_nonce = tor_malloc_zero(client_nonce_len);
  3060. if (base16_decode(client_nonce, client_nonce_len,
  3061. cp, client_nonce_encoded_len) < 0) {
  3062. connection_write_str_to_buf("513 Invalid base16 client nonce\r\n",
  3063. conn);
  3064. connection_mark_for_close(TO_CONN(conn));
  3065. tor_free(client_nonce);
  3066. return -1;
  3067. }
  3068. cp += client_nonce_encoded_len;
  3069. }
  3070. cp += strspn(cp, " \t\n\r");
  3071. if (*cp != '\0' ||
  3072. cp != body + len) {
  3073. connection_write_str_to_buf("513 Junk at end of AUTHCHALLENGE command\r\n",
  3074. conn);
  3075. connection_mark_for_close(TO_CONN(conn));
  3076. tor_free(client_nonce);
  3077. return -1;
  3078. }
  3079. const int fail = crypto_rand(server_nonce, SAFECOOKIE_SERVER_NONCE_LEN);
  3080. tor_assert(!fail);
  3081. /* Now compute and send the server-to-controller response, and the
  3082. * server's nonce. */
  3083. tor_assert(authentication_cookie != NULL);
  3084. {
  3085. size_t tmp_len = (AUTHENTICATION_COOKIE_LEN +
  3086. client_nonce_len +
  3087. SAFECOOKIE_SERVER_NONCE_LEN);
  3088. char *tmp = tor_malloc_zero(tmp_len);
  3089. char *client_hash = tor_malloc_zero(DIGEST256_LEN);
  3090. memcpy(tmp, authentication_cookie, AUTHENTICATION_COOKIE_LEN);
  3091. memcpy(tmp + AUTHENTICATION_COOKIE_LEN, client_nonce, client_nonce_len);
  3092. memcpy(tmp + AUTHENTICATION_COOKIE_LEN + client_nonce_len,
  3093. server_nonce, SAFECOOKIE_SERVER_NONCE_LEN);
  3094. crypto_hmac_sha256(server_hash,
  3095. SAFECOOKIE_SERVER_TO_CONTROLLER_CONSTANT,
  3096. strlen(SAFECOOKIE_SERVER_TO_CONTROLLER_CONSTANT),
  3097. tmp,
  3098. tmp_len);
  3099. crypto_hmac_sha256(client_hash,
  3100. SAFECOOKIE_CONTROLLER_TO_SERVER_CONSTANT,
  3101. strlen(SAFECOOKIE_CONTROLLER_TO_SERVER_CONSTANT),
  3102. tmp,
  3103. tmp_len);
  3104. conn->safecookie_client_hash = client_hash;
  3105. tor_free(tmp);
  3106. }
  3107. base16_encode(server_hash_encoded, sizeof(server_hash_encoded),
  3108. server_hash, sizeof(server_hash));
  3109. base16_encode(server_nonce_encoded, sizeof(server_nonce_encoded),
  3110. server_nonce, sizeof(server_nonce));
  3111. connection_printf_to_buf(conn,
  3112. "250 AUTHCHALLENGE SERVERHASH=%s "
  3113. "SERVERNONCE=%s\r\n",
  3114. server_hash_encoded,
  3115. server_nonce_encoded);
  3116. tor_free(client_nonce);
  3117. return 0;
  3118. }
  3119. /** Called when we get a USEFEATURE command: parse the feature list, and
  3120. * set up the control_connection's options properly. */
  3121. static int
  3122. handle_control_usefeature(control_connection_t *conn,
  3123. uint32_t len,
  3124. const char *body)
  3125. {
  3126. smartlist_t *args;
  3127. int bad = 0;
  3128. (void) len; /* body is nul-terminated; it's safe to ignore the length */
  3129. args = smartlist_new();
  3130. smartlist_split_string(args, body, " ",
  3131. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  3132. SMARTLIST_FOREACH_BEGIN(args, const char *, arg) {
  3133. if (!strcasecmp(arg, "VERBOSE_NAMES"))
  3134. ;
  3135. else if (!strcasecmp(arg, "EXTENDED_EVENTS"))
  3136. ;
  3137. else {
  3138. connection_printf_to_buf(conn, "552 Unrecognized feature \"%s\"\r\n",
  3139. arg);
  3140. bad = 1;
  3141. break;
  3142. }
  3143. } SMARTLIST_FOREACH_END(arg);
  3144. if (!bad) {
  3145. send_control_done(conn);
  3146. }
  3147. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  3148. smartlist_free(args);
  3149. return 0;
  3150. }
  3151. /** Implementation for the DROPGUARDS command. */
  3152. static int
  3153. handle_control_dropguards(control_connection_t *conn,
  3154. uint32_t len,
  3155. const char *body)
  3156. {
  3157. smartlist_t *args;
  3158. (void) len; /* body is nul-terminated; it's safe to ignore the length */
  3159. args = smartlist_new();
  3160. smartlist_split_string(args, body, " ",
  3161. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  3162. if (smartlist_len(args)) {
  3163. connection_printf_to_buf(conn, "512 Too many arguments to DROPGUARDS\r\n");
  3164. } else {
  3165. remove_all_entry_guards();
  3166. send_control_done(conn);
  3167. }
  3168. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  3169. smartlist_free(args);
  3170. return 0;
  3171. }
  3172. /** Implementation for the HSFETCH command. */
  3173. static int
  3174. handle_control_hsfetch(control_connection_t *conn, uint32_t len,
  3175. const char *body)
  3176. {
  3177. int i;
  3178. char digest[DIGEST_LEN], *hsaddress = NULL, *arg1 = NULL, *desc_id = NULL;
  3179. smartlist_t *args = NULL, *hsdirs = NULL;
  3180. (void) len; /* body is nul-terminated; it's safe to ignore the length */
  3181. static const char *hsfetch_command = "HSFETCH";
  3182. static const char *v2_str = "v2-";
  3183. const size_t v2_str_len = strlen(v2_str);
  3184. rend_data_t *rend_query = NULL;
  3185. /* Make sure we have at least one argument, the HSAddress. */
  3186. args = getargs_helper(hsfetch_command, conn, body, 1, -1);
  3187. if (!args) {
  3188. goto exit;
  3189. }
  3190. /* Extract the first argument (either HSAddress or DescID). */
  3191. arg1 = smartlist_get(args, 0);
  3192. /* Test if it's an HS address without the .onion part. */
  3193. if (rend_valid_service_id(arg1)) {
  3194. hsaddress = arg1;
  3195. } else if (strcmpstart(arg1, v2_str) == 0 &&
  3196. rend_valid_descriptor_id(arg1 + v2_str_len) &&
  3197. base32_decode(digest, sizeof(digest), arg1 + v2_str_len,
  3198. REND_DESC_ID_V2_LEN_BASE32) == 0) {
  3199. /* We have a well formed version 2 descriptor ID. Keep the decoded value
  3200. * of the id. */
  3201. desc_id = digest;
  3202. } else {
  3203. connection_printf_to_buf(conn, "513 Unrecognized \"%s\"\r\n",
  3204. arg1);
  3205. goto done;
  3206. }
  3207. static const char *opt_server = "SERVER=";
  3208. /* Skip first argument because it's the HSAddress or DescID. */
  3209. for (i = 1; i < smartlist_len(args); ++i) {
  3210. const char *arg = smartlist_get(args, i);
  3211. const node_t *node;
  3212. if (!strcasecmpstart(arg, opt_server)) {
  3213. const char *server;
  3214. server = arg + strlen(opt_server);
  3215. node = node_get_by_hex_id(server);
  3216. if (!node) {
  3217. connection_printf_to_buf(conn, "552 Server \"%s\" not found\r\n",
  3218. server);
  3219. goto done;
  3220. }
  3221. if (!hsdirs) {
  3222. /* Stores routerstatus_t object for each specified server. */
  3223. hsdirs = smartlist_new();
  3224. }
  3225. /* Valid server, add it to our local list. */
  3226. smartlist_add(hsdirs, node->rs);
  3227. } else {
  3228. connection_printf_to_buf(conn, "513 Unexpected argument \"%s\"\r\n",
  3229. arg);
  3230. goto done;
  3231. }
  3232. }
  3233. rend_query = rend_data_client_create(hsaddress, desc_id, NULL,
  3234. REND_NO_AUTH);
  3235. if (rend_query == NULL) {
  3236. connection_printf_to_buf(conn, "551 Error creating the HS query\r\n");
  3237. goto done;
  3238. }
  3239. /* Using a descriptor ID, we force the user to provide at least one
  3240. * hsdir server using the SERVER= option. */
  3241. if (desc_id && (!hsdirs || !smartlist_len(hsdirs))) {
  3242. connection_printf_to_buf(conn, "512 %s option is required\r\n",
  3243. opt_server);
  3244. goto done;
  3245. }
  3246. /* We are about to trigger HSDir fetch so send the OK now because after
  3247. * that 650 event(s) are possible so better to have the 250 OK before them
  3248. * to avoid out of order replies. */
  3249. send_control_done(conn);
  3250. /* Trigger the fetch using the built rend query and possibly a list of HS
  3251. * directory to use. This function ignores the client cache thus this will
  3252. * always send a fetch command. */
  3253. rend_client_fetch_v2_desc(rend_query, hsdirs);
  3254. done:
  3255. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  3256. smartlist_free(args);
  3257. /* Contains data pointer that we don't own thus no cleanup. */
  3258. smartlist_free(hsdirs);
  3259. rend_data_free(rend_query);
  3260. exit:
  3261. return 0;
  3262. }
  3263. /** Implementation for the HSPOST command. */
  3264. static int
  3265. handle_control_hspost(control_connection_t *conn,
  3266. uint32_t len,
  3267. const char *body)
  3268. {
  3269. static const char *opt_server = "SERVER=";
  3270. smartlist_t *args = smartlist_new();
  3271. smartlist_t *hs_dirs = NULL;
  3272. const char *encoded_desc = body;
  3273. size_t encoded_desc_len = len;
  3274. char *cp = memchr(body, '\n', len);
  3275. char *argline = tor_strndup(body, cp-body);
  3276. /* If any SERVER= options were specified, try parse the options line */
  3277. if (!strcasecmpstart(argline, opt_server)) {
  3278. /* encoded_desc begins after a newline character */
  3279. cp = cp + 1;
  3280. encoded_desc = cp;
  3281. encoded_desc_len = len-(cp-body);
  3282. smartlist_split_string(args, argline, " ",
  3283. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  3284. SMARTLIST_FOREACH_BEGIN(args, const char *, arg) {
  3285. if (!strcasecmpstart(arg, opt_server)) {
  3286. const char *server = arg + strlen(opt_server);
  3287. const node_t *node = node_get_by_hex_id(server);
  3288. if (!node || !node->rs) {
  3289. connection_printf_to_buf(conn, "552 Server \"%s\" not found\r\n",
  3290. server);
  3291. goto done;
  3292. }
  3293. if (!node->rs->is_hs_dir) {
  3294. connection_printf_to_buf(conn, "552 Server \"%s\" is not a HSDir"
  3295. "\r\n", server);
  3296. goto done;
  3297. }
  3298. /* Valid server, add it to our local list. */
  3299. if (!hs_dirs)
  3300. hs_dirs = smartlist_new();
  3301. smartlist_add(hs_dirs, node->rs);
  3302. } else {
  3303. connection_printf_to_buf(conn, "512 Unexpected argument \"%s\"\r\n",
  3304. arg);
  3305. goto done;
  3306. }
  3307. } SMARTLIST_FOREACH_END(arg);
  3308. }
  3309. /* Read the dot encoded descriptor, and parse it. */
  3310. rend_encoded_v2_service_descriptor_t *desc =
  3311. tor_malloc_zero(sizeof(rend_encoded_v2_service_descriptor_t));
  3312. read_escaped_data(encoded_desc, encoded_desc_len, &desc->desc_str);
  3313. rend_service_descriptor_t *parsed = NULL;
  3314. char *intro_content = NULL;
  3315. size_t intro_size;
  3316. size_t encoded_size;
  3317. const char *next_desc;
  3318. if (!rend_parse_v2_service_descriptor(&parsed, desc->desc_id, &intro_content,
  3319. &intro_size, &encoded_size,
  3320. &next_desc, desc->desc_str, 1)) {
  3321. /* Post the descriptor. */
  3322. char serviceid[REND_SERVICE_ID_LEN_BASE32+1];
  3323. if (!rend_get_service_id(parsed->pk, serviceid)) {
  3324. smartlist_t *descs = smartlist_new();
  3325. smartlist_add(descs, desc);
  3326. /* We are about to trigger HS descriptor upload so send the OK now
  3327. * because after that 650 event(s) are possible so better to have the
  3328. * 250 OK before them to avoid out of order replies. */
  3329. send_control_done(conn);
  3330. /* Trigger the descriptor upload */
  3331. directory_post_to_hs_dir(parsed, descs, hs_dirs, serviceid, 0);
  3332. smartlist_free(descs);
  3333. }
  3334. rend_service_descriptor_free(parsed);
  3335. } else {
  3336. connection_printf_to_buf(conn, "554 Invalid descriptor\r\n");
  3337. }
  3338. tor_free(intro_content);
  3339. rend_encoded_v2_service_descriptor_free(desc);
  3340. done:
  3341. tor_free(argline);
  3342. smartlist_free(hs_dirs); /* Contents belong to the rend service code. */
  3343. SMARTLIST_FOREACH(args, char *, arg, tor_free(arg));
  3344. smartlist_free(args);
  3345. return 0;
  3346. }
  3347. /** Called when we get a ADD_ONION command; parse the body, and set up
  3348. * the new ephemeral Onion Service. */
  3349. static int
  3350. handle_control_add_onion(control_connection_t *conn,
  3351. uint32_t len,
  3352. const char *body)
  3353. {
  3354. smartlist_t *args;
  3355. size_t arg_len;
  3356. (void) len; /* body is nul-terminated; it's safe to ignore the length */
  3357. args = getargs_helper("ADD_ONION", conn, body, 2, -1);
  3358. if (!args)
  3359. return 0;
  3360. arg_len = smartlist_len(args);
  3361. /* Parse all of the arguments that do not involve handling cryptographic
  3362. * material first, since there's no reason to touch that at all if any of
  3363. * the other arguments are malformed.
  3364. */
  3365. smartlist_t *port_cfgs = smartlist_new();
  3366. int discard_pk = 0;
  3367. int detach = 0;
  3368. int max_streams = 0;
  3369. int max_streams_close_circuit = 0;
  3370. for (size_t i = 1; i < arg_len; i++) {
  3371. static const char *port_prefix = "Port=";
  3372. static const char *flags_prefix = "Flags=";
  3373. static const char *max_s_prefix = "MaxStreams=";
  3374. const char *arg = smartlist_get(args, i);
  3375. if (!strcasecmpstart(arg, port_prefix)) {
  3376. /* "Port=VIRTPORT[,TARGET]". */
  3377. const char *port_str = arg + strlen(port_prefix);
  3378. rend_service_port_config_t *cfg =
  3379. rend_service_parse_port_config(port_str, ",", NULL);
  3380. if (!cfg) {
  3381. connection_printf_to_buf(conn, "512 Invalid VIRTPORT/TARGET\r\n");
  3382. goto out;
  3383. }
  3384. smartlist_add(port_cfgs, cfg);
  3385. } else if (!strcasecmpstart(arg, max_s_prefix)) {
  3386. /* "MaxStreams=[0..65535]". */
  3387. const char *max_s_str = arg + strlen(max_s_prefix);
  3388. int ok = 0;
  3389. max_streams = (int)tor_parse_long(max_s_str, 10, 0, 65535, &ok, NULL);
  3390. if (!ok) {
  3391. connection_printf_to_buf(conn, "512 Invalid MaxStreams\r\n");
  3392. goto out;
  3393. }
  3394. } else if (!strcasecmpstart(arg, flags_prefix)) {
  3395. /* "Flags=Flag[,Flag]", where Flag can be:
  3396. * * 'DiscardPK' - If tor generates the keypair, do not include it in
  3397. * the response.
  3398. * * 'Detach' - Do not tie this onion service to any particular control
  3399. * connection.
  3400. * * 'MaxStreamsCloseCircuit' - Close the circuit if MaxStreams is
  3401. * exceeded.
  3402. */
  3403. static const char *discard_flag = "DiscardPK";
  3404. static const char *detach_flag = "Detach";
  3405. static const char *max_s_close_flag = "MaxStreamsCloseCircuit";
  3406. smartlist_t *flags = smartlist_new();
  3407. int bad = 0;
  3408. smartlist_split_string(flags, arg + strlen(flags_prefix), ",",
  3409. SPLIT_IGNORE_BLANK, 0);
  3410. if (smartlist_len(flags) < 1) {
  3411. connection_printf_to_buf(conn, "512 Invalid 'Flags' argument\r\n");
  3412. bad = 1;
  3413. }
  3414. SMARTLIST_FOREACH_BEGIN(flags, const char *, flag)
  3415. {
  3416. if (!strcasecmp(flag, discard_flag)) {
  3417. discard_pk = 1;
  3418. } else if (!strcasecmp(flag, detach_flag)) {
  3419. detach = 1;
  3420. } else if (!strcasecmp(flag, max_s_close_flag)) {
  3421. max_streams_close_circuit = 1;
  3422. } else {
  3423. connection_printf_to_buf(conn,
  3424. "512 Invalid 'Flags' argument: %s\r\n",
  3425. escaped(flag));
  3426. bad = 1;
  3427. break;
  3428. }
  3429. } SMARTLIST_FOREACH_END(flag);
  3430. SMARTLIST_FOREACH(flags, char *, cp, tor_free(cp));
  3431. smartlist_free(flags);
  3432. if (bad)
  3433. goto out;
  3434. } else {
  3435. connection_printf_to_buf(conn, "513 Invalid argument\r\n");
  3436. goto out;
  3437. }
  3438. }
  3439. if (smartlist_len(port_cfgs) == 0) {
  3440. connection_printf_to_buf(conn, "512 Missing 'Port' argument\r\n");
  3441. goto out;
  3442. }
  3443. /* Parse the "keytype:keyblob" argument. */
  3444. crypto_pk_t *pk = NULL;
  3445. const char *key_new_alg = NULL;
  3446. char *key_new_blob = NULL;
  3447. char *err_msg = NULL;
  3448. pk = add_onion_helper_keyarg(smartlist_get(args, 0), discard_pk,
  3449. &key_new_alg, &key_new_blob,
  3450. &err_msg);
  3451. if (!pk) {
  3452. if (err_msg) {
  3453. connection_write_str_to_buf(err_msg, conn);
  3454. tor_free(err_msg);
  3455. }
  3456. goto out;
  3457. }
  3458. tor_assert(!err_msg);
  3459. /* Create the HS, using private key pk, and port config port_cfg.
  3460. * rend_service_add_ephemeral() will take ownership of pk and port_cfg,
  3461. * regardless of success/failure.
  3462. */
  3463. char *service_id = NULL;
  3464. int ret = rend_service_add_ephemeral(pk, port_cfgs, max_streams,
  3465. max_streams_close_circuit,
  3466. &service_id);
  3467. port_cfgs = NULL; /* port_cfgs is now owned by the rendservice code. */
  3468. switch (ret) {
  3469. case RSAE_OKAY:
  3470. {
  3471. char *buf = NULL;
  3472. tor_assert(service_id);
  3473. if (key_new_alg) {
  3474. tor_assert(key_new_blob);
  3475. tor_asprintf(&buf,
  3476. "250-ServiceID=%s\r\n"
  3477. "250-PrivateKey=%s:%s\r\n"
  3478. "250 OK\r\n",
  3479. service_id,
  3480. key_new_alg,
  3481. key_new_blob);
  3482. } else {
  3483. tor_asprintf(&buf,
  3484. "250-ServiceID=%s\r\n"
  3485. "250 OK\r\n",
  3486. service_id);
  3487. }
  3488. if (detach) {
  3489. if (!detached_onion_services)
  3490. detached_onion_services = smartlist_new();
  3491. smartlist_add(detached_onion_services, service_id);
  3492. } else {
  3493. if (!conn->ephemeral_onion_services)
  3494. conn->ephemeral_onion_services = smartlist_new();
  3495. smartlist_add(conn->ephemeral_onion_services, service_id);
  3496. }
  3497. connection_write_str_to_buf(buf, conn);
  3498. memwipe(buf, 0, strlen(buf));
  3499. tor_free(buf);
  3500. break;
  3501. }
  3502. case RSAE_BADPRIVKEY:
  3503. connection_printf_to_buf(conn, "551 Failed to generate onion address\r\n");
  3504. break;
  3505. case RSAE_ADDREXISTS:
  3506. connection_printf_to_buf(conn, "550 Onion address collision\r\n");
  3507. break;
  3508. case RSAE_BADVIRTPORT:
  3509. connection_printf_to_buf(conn, "512 Invalid VIRTPORT/TARGET\r\n");
  3510. break;
  3511. case RSAE_INTERNAL: /* FALLSTHROUGH */
  3512. default:
  3513. connection_printf_to_buf(conn, "551 Failed to add Onion Service\r\n");
  3514. }
  3515. if (key_new_blob) {
  3516. memwipe(key_new_blob, 0, strlen(key_new_blob));
  3517. tor_free(key_new_blob);
  3518. }
  3519. out:
  3520. if (port_cfgs) {
  3521. SMARTLIST_FOREACH(port_cfgs, rend_service_port_config_t*, p,
  3522. rend_service_port_config_free(p));
  3523. smartlist_free(port_cfgs);
  3524. }
  3525. SMARTLIST_FOREACH(args, char *, cp, {
  3526. memwipe(cp, 0, strlen(cp));
  3527. tor_free(cp);
  3528. });
  3529. smartlist_free(args);
  3530. return 0;
  3531. }
  3532. /** Helper function to handle parsing the KeyType:KeyBlob argument to the
  3533. * ADD_ONION command. Return a new crypto_pk_t and if a new key was generated
  3534. * and the private key not discarded, the algorithm and serialized private key,
  3535. * or NULL and an optional control protocol error message on failure. The
  3536. * caller is responsible for freeing the returned key_new_blob and err_msg.
  3537. *
  3538. * Note: The error messages returned are deliberately vague to avoid echoing
  3539. * key material.
  3540. */
  3541. STATIC crypto_pk_t *
  3542. add_onion_helper_keyarg(const char *arg, int discard_pk,
  3543. const char **key_new_alg_out, char **key_new_blob_out,
  3544. char **err_msg_out)
  3545. {
  3546. smartlist_t *key_args = smartlist_new();
  3547. crypto_pk_t *pk = NULL;
  3548. const char *key_new_alg = NULL;
  3549. char *key_new_blob = NULL;
  3550. char *err_msg = NULL;
  3551. int ok = 0;
  3552. smartlist_split_string(key_args, arg, ":", SPLIT_IGNORE_BLANK, 0);
  3553. if (smartlist_len(key_args) != 2) {
  3554. err_msg = tor_strdup("512 Invalid key type/blob\r\n");
  3555. goto err;
  3556. }
  3557. /* The format is "KeyType:KeyBlob". */
  3558. static const char *key_type_new = "NEW";
  3559. static const char *key_type_best = "BEST";
  3560. static const char *key_type_rsa1024 = "RSA1024";
  3561. const char *key_type = smartlist_get(key_args, 0);
  3562. const char *key_blob = smartlist_get(key_args, 1);
  3563. if (!strcasecmp(key_type_rsa1024, key_type)) {
  3564. /* "RSA:<Base64 Blob>" - Loading a pre-existing RSA1024 key. */
  3565. pk = crypto_pk_base64_decode(key_blob, strlen(key_blob));
  3566. if (!pk) {
  3567. err_msg = tor_strdup("512 Failed to decode RSA key\r\n");
  3568. goto err;
  3569. }
  3570. if (crypto_pk_num_bits(pk) != PK_BYTES*8) {
  3571. err_msg = tor_strdup("512 Invalid RSA key size\r\n");
  3572. goto err;
  3573. }
  3574. } else if (!strcasecmp(key_type_new, key_type)) {
  3575. /* "NEW:<Algorithm>" - Generating a new key, blob as algorithm. */
  3576. if (!strcasecmp(key_type_rsa1024, key_blob) ||
  3577. !strcasecmp(key_type_best, key_blob)) {
  3578. /* "RSA1024", RSA 1024 bit, also currently "BEST" by default. */
  3579. pk = crypto_pk_new();
  3580. if (crypto_pk_generate_key(pk)) {
  3581. tor_asprintf(&err_msg, "551 Failed to generate %s key\r\n",
  3582. key_type_rsa1024);
  3583. goto err;
  3584. }
  3585. if (!discard_pk) {
  3586. if (crypto_pk_base64_encode(pk, &key_new_blob)) {
  3587. tor_asprintf(&err_msg, "551 Failed to encode %s key\r\n",
  3588. key_type_rsa1024);
  3589. goto err;
  3590. }
  3591. key_new_alg = key_type_rsa1024;
  3592. }
  3593. } else {
  3594. err_msg = tor_strdup("513 Invalid key type\r\n");
  3595. goto err;
  3596. }
  3597. } else {
  3598. err_msg = tor_strdup("513 Invalid key type\r\n");
  3599. goto err;
  3600. }
  3601. /* Succeded in loading or generating a private key. */
  3602. tor_assert(pk);
  3603. ok = 1;
  3604. err:
  3605. SMARTLIST_FOREACH(key_args, char *, cp, {
  3606. memwipe(cp, 0, strlen(cp));
  3607. tor_free(cp);
  3608. });
  3609. smartlist_free(key_args);
  3610. if (!ok) {
  3611. crypto_pk_free(pk);
  3612. pk = NULL;
  3613. }
  3614. if (err_msg_out) {
  3615. *err_msg_out = err_msg;
  3616. } else {
  3617. tor_free(err_msg);
  3618. }
  3619. *key_new_alg_out = key_new_alg;
  3620. *key_new_blob_out = key_new_blob;
  3621. return pk;
  3622. }
  3623. /** Called when we get a DEL_ONION command; parse the body, and remove
  3624. * the existing ephemeral Onion Service. */
  3625. static int
  3626. handle_control_del_onion(control_connection_t *conn,
  3627. uint32_t len,
  3628. const char *body)
  3629. {
  3630. smartlist_t *args;
  3631. (void) len; /* body is nul-terminated; it's safe to ignore the length */
  3632. args = getargs_helper("DEL_ONION", conn, body, 1, 1);
  3633. if (!args)
  3634. return 0;
  3635. const char *service_id = smartlist_get(args, 0);
  3636. if (!rend_valid_service_id(service_id)) {
  3637. connection_printf_to_buf(conn, "512 Malformed Onion Service id\r\n");
  3638. goto out;
  3639. }
  3640. /* Determine if the onion service belongs to this particular control
  3641. * connection, or if it is in the global list of detached services. If it
  3642. * is in neither, either the service ID is invalid in some way, or it
  3643. * explicitly belongs to a different control connection, and an error
  3644. * should be returned.
  3645. */
  3646. smartlist_t *services[2] = {
  3647. conn->ephemeral_onion_services,
  3648. detached_onion_services
  3649. };
  3650. smartlist_t *onion_services = NULL;
  3651. int idx = -1;
  3652. for (size_t i = 0; i < ARRAY_LENGTH(services); i++) {
  3653. idx = smartlist_string_pos(services[i], service_id);
  3654. if (idx != -1) {
  3655. onion_services = services[i];
  3656. break;
  3657. }
  3658. }
  3659. if (onion_services == NULL) {
  3660. connection_printf_to_buf(conn, "552 Unknown Onion Service id\r\n");
  3661. } else {
  3662. int ret = rend_service_del_ephemeral(service_id);
  3663. if (ret) {
  3664. /* This should *NEVER* fail, since the service is on either the
  3665. * per-control connection list, or the global one.
  3666. */
  3667. log_warn(LD_BUG, "Failed to remove Onion Service %s.",
  3668. escaped(service_id));
  3669. tor_fragile_assert();
  3670. }
  3671. /* Remove/scrub the service_id from the appropriate list. */
  3672. char *cp = smartlist_get(onion_services, idx);
  3673. smartlist_del(onion_services, idx);
  3674. memwipe(cp, 0, strlen(cp));
  3675. tor_free(cp);
  3676. send_control_done(conn);
  3677. }
  3678. out:
  3679. SMARTLIST_FOREACH(args, char *, cp, {
  3680. memwipe(cp, 0, strlen(cp));
  3681. tor_free(cp);
  3682. });
  3683. smartlist_free(args);
  3684. return 0;
  3685. }
  3686. /** Called when <b>conn</b> has no more bytes left on its outbuf. */
  3687. int
  3688. connection_control_finished_flushing(control_connection_t *conn)
  3689. {
  3690. tor_assert(conn);
  3691. return 0;
  3692. }
  3693. /** Called when <b>conn</b> has gotten its socket closed. */
  3694. int
  3695. connection_control_reached_eof(control_connection_t *conn)
  3696. {
  3697. tor_assert(conn);
  3698. log_info(LD_CONTROL,"Control connection reached EOF. Closing.");
  3699. connection_mark_for_close(TO_CONN(conn));
  3700. return 0;
  3701. }
  3702. static void lost_owning_controller(const char *owner_type,
  3703. const char *loss_manner)
  3704. ATTR_NORETURN;
  3705. /** Shut down this Tor instance in the same way that SIGINT would, but
  3706. * with a log message appropriate for the loss of an owning controller. */
  3707. static void
  3708. lost_owning_controller(const char *owner_type, const char *loss_manner)
  3709. {
  3710. log_notice(LD_CONTROL, "Owning controller %s has %s -- exiting now.",
  3711. owner_type, loss_manner);
  3712. /* XXXX Perhaps this chunk of code should be a separate function,
  3713. * called here and by process_signal(SIGINT). */
  3714. tor_cleanup();
  3715. exit(0);
  3716. }
  3717. /** Called when <b>conn</b> is being freed. */
  3718. void
  3719. connection_control_closed(control_connection_t *conn)
  3720. {
  3721. tor_assert(conn);
  3722. conn->event_mask = 0;
  3723. control_update_global_event_mask();
  3724. /* Close all ephemeral Onion Services if any.
  3725. * The list and it's contents are scrubbed/freed in connection_free_.
  3726. */
  3727. if (conn->ephemeral_onion_services) {
  3728. SMARTLIST_FOREACH(conn->ephemeral_onion_services, char *, cp, {
  3729. rend_service_del_ephemeral(cp);
  3730. });
  3731. }
  3732. if (conn->is_owning_control_connection) {
  3733. lost_owning_controller("connection", "closed");
  3734. }
  3735. }
  3736. /** Return true iff <b>cmd</b> is allowable (or at least forgivable) at this
  3737. * stage of the protocol. */
  3738. static int
  3739. is_valid_initial_command(control_connection_t *conn, const char *cmd)
  3740. {
  3741. if (conn->base_.state == CONTROL_CONN_STATE_OPEN)
  3742. return 1;
  3743. if (!strcasecmp(cmd, "PROTOCOLINFO"))
  3744. return (!conn->have_sent_protocolinfo &&
  3745. conn->safecookie_client_hash == NULL);
  3746. if (!strcasecmp(cmd, "AUTHCHALLENGE"))
  3747. return (conn->safecookie_client_hash == NULL);
  3748. if (!strcasecmp(cmd, "AUTHENTICATE") ||
  3749. !strcasecmp(cmd, "QUIT"))
  3750. return 1;
  3751. return 0;
  3752. }
  3753. /** Do not accept any control command of more than 1MB in length. Anything
  3754. * that needs to be anywhere near this long probably means that one of our
  3755. * interfaces is broken. */
  3756. #define MAX_COMMAND_LINE_LENGTH (1024*1024)
  3757. /** Wrapper around peek_(evbuffer|buf)_has_control0 command: presents the same
  3758. * interface as those underlying functions, but takes a connection_t intead of
  3759. * an evbuffer or a buf_t.
  3760. */
  3761. static int
  3762. peek_connection_has_control0_command(connection_t *conn)
  3763. {
  3764. IF_HAS_BUFFEREVENT(conn, {
  3765. struct evbuffer *input = bufferevent_get_input(conn->bufev);
  3766. return peek_evbuffer_has_control0_command(input);
  3767. }) ELSE_IF_NO_BUFFEREVENT {
  3768. return peek_buf_has_control0_command(conn->inbuf);
  3769. }
  3770. }
  3771. /** Called when data has arrived on a v1 control connection: Try to fetch
  3772. * commands from conn->inbuf, and execute them.
  3773. */
  3774. int
  3775. connection_control_process_inbuf(control_connection_t *conn)
  3776. {
  3777. size_t data_len;
  3778. uint32_t cmd_data_len;
  3779. int cmd_len;
  3780. char *args;
  3781. tor_assert(conn);
  3782. tor_assert(conn->base_.state == CONTROL_CONN_STATE_OPEN ||
  3783. conn->base_.state == CONTROL_CONN_STATE_NEEDAUTH);
  3784. if (!conn->incoming_cmd) {
  3785. conn->incoming_cmd = tor_malloc(1024);
  3786. conn->incoming_cmd_len = 1024;
  3787. conn->incoming_cmd_cur_len = 0;
  3788. }
  3789. if (conn->base_.state == CONTROL_CONN_STATE_NEEDAUTH &&
  3790. peek_connection_has_control0_command(TO_CONN(conn))) {
  3791. /* Detect v0 commands and send a "no more v0" message. */
  3792. size_t body_len;
  3793. char buf[128];
  3794. set_uint16(buf+2, htons(0x0000)); /* type == error */
  3795. set_uint16(buf+4, htons(0x0001)); /* code == internal error */
  3796. strlcpy(buf+6, "The v0 control protocol is not supported by Tor 0.1.2.17 "
  3797. "and later; upgrade your controller.",
  3798. sizeof(buf)-6);
  3799. body_len = 2+strlen(buf+6)+2; /* code, msg, nul. */
  3800. set_uint16(buf+0, htons(body_len));
  3801. connection_write_to_buf(buf, 4+body_len, TO_CONN(conn));
  3802. connection_mark_and_flush(TO_CONN(conn));
  3803. return 0;
  3804. }
  3805. again:
  3806. while (1) {
  3807. size_t last_idx;
  3808. int r;
  3809. /* First, fetch a line. */
  3810. do {
  3811. data_len = conn->incoming_cmd_len - conn->incoming_cmd_cur_len;
  3812. r = connection_fetch_from_buf_line(TO_CONN(conn),
  3813. conn->incoming_cmd+conn->incoming_cmd_cur_len,
  3814. &data_len);
  3815. if (r == 0)
  3816. /* Line not all here yet. Wait. */
  3817. return 0;
  3818. else if (r == -1) {
  3819. if (data_len + conn->incoming_cmd_cur_len > MAX_COMMAND_LINE_LENGTH) {
  3820. connection_write_str_to_buf("500 Line too long.\r\n", conn);
  3821. connection_stop_reading(TO_CONN(conn));
  3822. connection_mark_and_flush(TO_CONN(conn));
  3823. }
  3824. while (conn->incoming_cmd_len < data_len+conn->incoming_cmd_cur_len)
  3825. conn->incoming_cmd_len *= 2;
  3826. conn->incoming_cmd = tor_realloc(conn->incoming_cmd,
  3827. conn->incoming_cmd_len);
  3828. }
  3829. } while (r != 1);
  3830. tor_assert(data_len);
  3831. last_idx = conn->incoming_cmd_cur_len;
  3832. conn->incoming_cmd_cur_len += (int)data_len;
  3833. /* We have appended a line to incoming_cmd. Is the command done? */
  3834. if (last_idx == 0 && *conn->incoming_cmd != '+')
  3835. /* One line command, didn't start with '+'. */
  3836. break;
  3837. /* XXXX this code duplication is kind of dumb. */
  3838. if (last_idx+3 == conn->incoming_cmd_cur_len &&
  3839. tor_memeq(conn->incoming_cmd + last_idx, ".\r\n", 3)) {
  3840. /* Just appended ".\r\n"; we're done. Remove it. */
  3841. conn->incoming_cmd[last_idx] = '\0';
  3842. conn->incoming_cmd_cur_len -= 3;
  3843. break;
  3844. } else if (last_idx+2 == conn->incoming_cmd_cur_len &&
  3845. tor_memeq(conn->incoming_cmd + last_idx, ".\n", 2)) {
  3846. /* Just appended ".\n"; we're done. Remove it. */
  3847. conn->incoming_cmd[last_idx] = '\0';
  3848. conn->incoming_cmd_cur_len -= 2;
  3849. break;
  3850. }
  3851. /* Otherwise, read another line. */
  3852. }
  3853. data_len = conn->incoming_cmd_cur_len;
  3854. /* Okay, we now have a command sitting on conn->incoming_cmd. See if we
  3855. * recognize it.
  3856. */
  3857. cmd_len = 0;
  3858. while ((size_t)cmd_len < data_len
  3859. && !TOR_ISSPACE(conn->incoming_cmd[cmd_len]))
  3860. ++cmd_len;
  3861. conn->incoming_cmd[cmd_len]='\0';
  3862. args = conn->incoming_cmd+cmd_len+1;
  3863. tor_assert(data_len>(size_t)cmd_len);
  3864. data_len -= (cmd_len+1); /* skip the command and NUL we added after it */
  3865. while (TOR_ISSPACE(*args)) {
  3866. ++args;
  3867. --data_len;
  3868. }
  3869. /* If the connection is already closing, ignore further commands */
  3870. if (TO_CONN(conn)->marked_for_close) {
  3871. return 0;
  3872. }
  3873. /* Otherwise, Quit is always valid. */
  3874. if (!strcasecmp(conn->incoming_cmd, "QUIT")) {
  3875. connection_write_str_to_buf("250 closing connection\r\n", conn);
  3876. connection_mark_and_flush(TO_CONN(conn));
  3877. return 0;
  3878. }
  3879. if (conn->base_.state == CONTROL_CONN_STATE_NEEDAUTH &&
  3880. !is_valid_initial_command(conn, conn->incoming_cmd)) {
  3881. connection_write_str_to_buf("514 Authentication required.\r\n", conn);
  3882. connection_mark_for_close(TO_CONN(conn));
  3883. return 0;
  3884. }
  3885. if (data_len >= UINT32_MAX) {
  3886. connection_write_str_to_buf("500 A 4GB command? Nice try.\r\n", conn);
  3887. connection_mark_for_close(TO_CONN(conn));
  3888. return 0;
  3889. }
  3890. /* XXXX Why is this not implemented as a table like the GETINFO
  3891. * items are? Even handling the plus signs at the beginnings of
  3892. * commands wouldn't be very hard with proper macros. */
  3893. cmd_data_len = (uint32_t)data_len;
  3894. if (!strcasecmp(conn->incoming_cmd, "SETCONF")) {
  3895. if (handle_control_setconf(conn, cmd_data_len, args))
  3896. return -1;
  3897. } else if (!strcasecmp(conn->incoming_cmd, "RESETCONF")) {
  3898. if (handle_control_resetconf(conn, cmd_data_len, args))
  3899. return -1;
  3900. } else if (!strcasecmp(conn->incoming_cmd, "GETCONF")) {
  3901. if (handle_control_getconf(conn, cmd_data_len, args))
  3902. return -1;
  3903. } else if (!strcasecmp(conn->incoming_cmd, "+LOADCONF")) {
  3904. if (handle_control_loadconf(conn, cmd_data_len, args))
  3905. return -1;
  3906. } else if (!strcasecmp(conn->incoming_cmd, "SETEVENTS")) {
  3907. if (handle_control_setevents(conn, cmd_data_len, args))
  3908. return -1;
  3909. } else if (!strcasecmp(conn->incoming_cmd, "AUTHENTICATE")) {
  3910. if (handle_control_authenticate(conn, cmd_data_len, args))
  3911. return -1;
  3912. } else if (!strcasecmp(conn->incoming_cmd, "SAVECONF")) {
  3913. if (handle_control_saveconf(conn, cmd_data_len, args))
  3914. return -1;
  3915. } else if (!strcasecmp(conn->incoming_cmd, "SIGNAL")) {
  3916. if (handle_control_signal(conn, cmd_data_len, args))
  3917. return -1;
  3918. } else if (!strcasecmp(conn->incoming_cmd, "TAKEOWNERSHIP")) {
  3919. if (handle_control_takeownership(conn, cmd_data_len, args))
  3920. return -1;
  3921. } else if (!strcasecmp(conn->incoming_cmd, "MAPADDRESS")) {
  3922. if (handle_control_mapaddress(conn, cmd_data_len, args))
  3923. return -1;
  3924. } else if (!strcasecmp(conn->incoming_cmd, "GETINFO")) {
  3925. if (handle_control_getinfo(conn, cmd_data_len, args))
  3926. return -1;
  3927. } else if (!strcasecmp(conn->incoming_cmd, "EXTENDCIRCUIT")) {
  3928. if (handle_control_extendcircuit(conn, cmd_data_len, args))
  3929. return -1;
  3930. } else if (!strcasecmp(conn->incoming_cmd, "SETCIRCUITPURPOSE")) {
  3931. if (handle_control_setcircuitpurpose(conn, cmd_data_len, args))
  3932. return -1;
  3933. } else if (!strcasecmp(conn->incoming_cmd, "SETROUTERPURPOSE")) {
  3934. connection_write_str_to_buf("511 SETROUTERPURPOSE is obsolete.\r\n", conn);
  3935. } else if (!strcasecmp(conn->incoming_cmd, "ATTACHSTREAM")) {
  3936. if (handle_control_attachstream(conn, cmd_data_len, args))
  3937. return -1;
  3938. } else if (!strcasecmp(conn->incoming_cmd, "+POSTDESCRIPTOR")) {
  3939. if (handle_control_postdescriptor(conn, cmd_data_len, args))
  3940. return -1;
  3941. } else if (!strcasecmp(conn->incoming_cmd, "REDIRECTSTREAM")) {
  3942. if (handle_control_redirectstream(conn, cmd_data_len, args))
  3943. return -1;
  3944. } else if (!strcasecmp(conn->incoming_cmd, "CLOSESTREAM")) {
  3945. if (handle_control_closestream(conn, cmd_data_len, args))
  3946. return -1;
  3947. } else if (!strcasecmp(conn->incoming_cmd, "CLOSECIRCUIT")) {
  3948. if (handle_control_closecircuit(conn, cmd_data_len, args))
  3949. return -1;
  3950. } else if (!strcasecmp(conn->incoming_cmd, "USEFEATURE")) {
  3951. if (handle_control_usefeature(conn, cmd_data_len, args))
  3952. return -1;
  3953. } else if (!strcasecmp(conn->incoming_cmd, "RESOLVE")) {
  3954. if (handle_control_resolve(conn, cmd_data_len, args))
  3955. return -1;
  3956. } else if (!strcasecmp(conn->incoming_cmd, "PROTOCOLINFO")) {
  3957. if (handle_control_protocolinfo(conn, cmd_data_len, args))
  3958. return -1;
  3959. } else if (!strcasecmp(conn->incoming_cmd, "AUTHCHALLENGE")) {
  3960. if (handle_control_authchallenge(conn, cmd_data_len, args))
  3961. return -1;
  3962. } else if (!strcasecmp(conn->incoming_cmd, "DROPGUARDS")) {
  3963. if (handle_control_dropguards(conn, cmd_data_len, args))
  3964. return -1;
  3965. } else if (!strcasecmp(conn->incoming_cmd, "HSFETCH")) {
  3966. if (handle_control_hsfetch(conn, cmd_data_len, args))
  3967. return -1;
  3968. } else if (!strcasecmp(conn->incoming_cmd, "+HSPOST")) {
  3969. if (handle_control_hspost(conn, cmd_data_len, args))
  3970. return -1;
  3971. } else if (!strcasecmp(conn->incoming_cmd, "ADD_ONION")) {
  3972. int ret = handle_control_add_onion(conn, cmd_data_len, args);
  3973. memwipe(args, 0, cmd_data_len); /* Scrub the private key. */
  3974. if (ret)
  3975. return -1;
  3976. } else if (!strcasecmp(conn->incoming_cmd, "DEL_ONION")) {
  3977. int ret = handle_control_del_onion(conn, cmd_data_len, args);
  3978. memwipe(args, 0, cmd_data_len); /* Scrub the service id/pk. */
  3979. if (ret)
  3980. return -1;
  3981. } else {
  3982. connection_printf_to_buf(conn, "510 Unrecognized command \"%s\"\r\n",
  3983. conn->incoming_cmd);
  3984. }
  3985. conn->incoming_cmd_cur_len = 0;
  3986. goto again;
  3987. }
  3988. /** Something major has happened to circuit <b>circ</b>: tell any
  3989. * interested control connections. */
  3990. int
  3991. control_event_circuit_status(origin_circuit_t *circ, circuit_status_event_t tp,
  3992. int reason_code)
  3993. {
  3994. const char *status;
  3995. char reasons[64] = "";
  3996. if (!EVENT_IS_INTERESTING(EVENT_CIRCUIT_STATUS))
  3997. return 0;
  3998. tor_assert(circ);
  3999. switch (tp)
  4000. {
  4001. case CIRC_EVENT_LAUNCHED: status = "LAUNCHED"; break;
  4002. case CIRC_EVENT_BUILT: status = "BUILT"; break;
  4003. case CIRC_EVENT_EXTENDED: status = "EXTENDED"; break;
  4004. case CIRC_EVENT_FAILED: status = "FAILED"; break;
  4005. case CIRC_EVENT_CLOSED: status = "CLOSED"; break;
  4006. default:
  4007. log_warn(LD_BUG, "Unrecognized status code %d", (int)tp);
  4008. tor_fragile_assert();
  4009. return 0;
  4010. }
  4011. if (tp == CIRC_EVENT_FAILED || tp == CIRC_EVENT_CLOSED) {
  4012. const char *reason_str = circuit_end_reason_to_control_string(reason_code);
  4013. char unk_reason_buf[16];
  4014. if (!reason_str) {
  4015. tor_snprintf(unk_reason_buf, 16, "UNKNOWN_%d", reason_code);
  4016. reason_str = unk_reason_buf;
  4017. }
  4018. if (reason_code > 0 && reason_code & END_CIRC_REASON_FLAG_REMOTE) {
  4019. tor_snprintf(reasons, sizeof(reasons),
  4020. " REASON=DESTROYED REMOTE_REASON=%s", reason_str);
  4021. } else {
  4022. tor_snprintf(reasons, sizeof(reasons),
  4023. " REASON=%s", reason_str);
  4024. }
  4025. }
  4026. {
  4027. char *circdesc = circuit_describe_status_for_controller(circ);
  4028. const char *sp = strlen(circdesc) ? " " : "";
  4029. send_control_event(EVENT_CIRCUIT_STATUS, ALL_FORMATS,
  4030. "650 CIRC %lu %s%s%s%s\r\n",
  4031. (unsigned long)circ->global_identifier,
  4032. status, sp,
  4033. circdesc,
  4034. reasons);
  4035. tor_free(circdesc);
  4036. }
  4037. return 0;
  4038. }
  4039. /** Something minor has happened to circuit <b>circ</b>: tell any
  4040. * interested control connections. */
  4041. static int
  4042. control_event_circuit_status_minor(origin_circuit_t *circ,
  4043. circuit_status_minor_event_t e,
  4044. int purpose, const struct timeval *tv)
  4045. {
  4046. const char *event_desc;
  4047. char event_tail[160] = "";
  4048. if (!EVENT_IS_INTERESTING(EVENT_CIRCUIT_STATUS_MINOR))
  4049. return 0;
  4050. tor_assert(circ);
  4051. switch (e)
  4052. {
  4053. case CIRC_MINOR_EVENT_PURPOSE_CHANGED:
  4054. event_desc = "PURPOSE_CHANGED";
  4055. {
  4056. /* event_tail can currently be up to 68 chars long */
  4057. const char *hs_state_str =
  4058. circuit_purpose_to_controller_hs_state_string(purpose);
  4059. tor_snprintf(event_tail, sizeof(event_tail),
  4060. " OLD_PURPOSE=%s%s%s",
  4061. circuit_purpose_to_controller_string(purpose),
  4062. (hs_state_str != NULL) ? " OLD_HS_STATE=" : "",
  4063. (hs_state_str != NULL) ? hs_state_str : "");
  4064. }
  4065. break;
  4066. case CIRC_MINOR_EVENT_CANNIBALIZED:
  4067. event_desc = "CANNIBALIZED";
  4068. {
  4069. /* event_tail can currently be up to 130 chars long */
  4070. const char *hs_state_str =
  4071. circuit_purpose_to_controller_hs_state_string(purpose);
  4072. const struct timeval *old_timestamp_began = tv;
  4073. char tbuf[ISO_TIME_USEC_LEN+1];
  4074. format_iso_time_nospace_usec(tbuf, old_timestamp_began);
  4075. tor_snprintf(event_tail, sizeof(event_tail),
  4076. " OLD_PURPOSE=%s%s%s OLD_TIME_CREATED=%s",
  4077. circuit_purpose_to_controller_string(purpose),
  4078. (hs_state_str != NULL) ? " OLD_HS_STATE=" : "",
  4079. (hs_state_str != NULL) ? hs_state_str : "",
  4080. tbuf);
  4081. }
  4082. break;
  4083. default:
  4084. log_warn(LD_BUG, "Unrecognized status code %d", (int)e);
  4085. tor_fragile_assert();
  4086. return 0;
  4087. }
  4088. {
  4089. char *circdesc = circuit_describe_status_for_controller(circ);
  4090. const char *sp = strlen(circdesc) ? " " : "";
  4091. send_control_event(EVENT_CIRCUIT_STATUS_MINOR, ALL_FORMATS,
  4092. "650 CIRC_MINOR %lu %s%s%s%s\r\n",
  4093. (unsigned long)circ->global_identifier,
  4094. event_desc, sp,
  4095. circdesc,
  4096. event_tail);
  4097. tor_free(circdesc);
  4098. }
  4099. return 0;
  4100. }
  4101. /**
  4102. * <b>circ</b> has changed its purpose from <b>old_purpose</b>: tell any
  4103. * interested controllers.
  4104. */
  4105. int
  4106. control_event_circuit_purpose_changed(origin_circuit_t *circ,
  4107. int old_purpose)
  4108. {
  4109. return control_event_circuit_status_minor(circ,
  4110. CIRC_MINOR_EVENT_PURPOSE_CHANGED,
  4111. old_purpose,
  4112. NULL);
  4113. }
  4114. /**
  4115. * <b>circ</b> has changed its purpose from <b>old_purpose</b>, and its
  4116. * created-time from <b>old_tv_created</b>: tell any interested controllers.
  4117. */
  4118. int
  4119. control_event_circuit_cannibalized(origin_circuit_t *circ,
  4120. int old_purpose,
  4121. const struct timeval *old_tv_created)
  4122. {
  4123. return control_event_circuit_status_minor(circ,
  4124. CIRC_MINOR_EVENT_CANNIBALIZED,
  4125. old_purpose,
  4126. old_tv_created);
  4127. }
  4128. /** Given an AP connection <b>conn</b> and a <b>len</b>-character buffer
  4129. * <b>buf</b>, determine the address:port combination requested on
  4130. * <b>conn</b>, and write it to <b>buf</b>. Return 0 on success, -1 on
  4131. * failure. */
  4132. static int
  4133. write_stream_target_to_buf(entry_connection_t *conn, char *buf, size_t len)
  4134. {
  4135. char buf2[256];
  4136. if (conn->chosen_exit_name)
  4137. if (tor_snprintf(buf2, sizeof(buf2), ".%s.exit", conn->chosen_exit_name)<0)
  4138. return -1;
  4139. if (!conn->socks_request)
  4140. return -1;
  4141. if (tor_snprintf(buf, len, "%s%s%s:%d",
  4142. conn->socks_request->address,
  4143. conn->chosen_exit_name ? buf2 : "",
  4144. !conn->chosen_exit_name && connection_edge_is_rendezvous_stream(
  4145. ENTRY_TO_EDGE_CONN(conn)) ? ".onion" : "",
  4146. conn->socks_request->port)<0)
  4147. return -1;
  4148. return 0;
  4149. }
  4150. /** Something has happened to the stream associated with AP connection
  4151. * <b>conn</b>: tell any interested control connections. */
  4152. int
  4153. control_event_stream_status(entry_connection_t *conn, stream_status_event_t tp,
  4154. int reason_code)
  4155. {
  4156. char reason_buf[64];
  4157. char addrport_buf[64];
  4158. const char *status;
  4159. circuit_t *circ;
  4160. origin_circuit_t *origin_circ = NULL;
  4161. char buf[256];
  4162. const char *purpose = "";
  4163. tor_assert(conn->socks_request);
  4164. if (!EVENT_IS_INTERESTING(EVENT_STREAM_STATUS))
  4165. return 0;
  4166. if (tp == STREAM_EVENT_CLOSED &&
  4167. (reason_code & END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED))
  4168. return 0;
  4169. write_stream_target_to_buf(conn, buf, sizeof(buf));
  4170. reason_buf[0] = '\0';
  4171. switch (tp)
  4172. {
  4173. case STREAM_EVENT_SENT_CONNECT: status = "SENTCONNECT"; break;
  4174. case STREAM_EVENT_SENT_RESOLVE: status = "SENTRESOLVE"; break;
  4175. case STREAM_EVENT_SUCCEEDED: status = "SUCCEEDED"; break;
  4176. case STREAM_EVENT_FAILED: status = "FAILED"; break;
  4177. case STREAM_EVENT_CLOSED: status = "CLOSED"; break;
  4178. case STREAM_EVENT_NEW: status = "NEW"; break;
  4179. case STREAM_EVENT_NEW_RESOLVE: status = "NEWRESOLVE"; break;
  4180. case STREAM_EVENT_FAILED_RETRIABLE: status = "DETACHED"; break;
  4181. case STREAM_EVENT_REMAP: status = "REMAP"; break;
  4182. default:
  4183. log_warn(LD_BUG, "Unrecognized status code %d", (int)tp);
  4184. return 0;
  4185. }
  4186. if (reason_code && (tp == STREAM_EVENT_FAILED ||
  4187. tp == STREAM_EVENT_CLOSED ||
  4188. tp == STREAM_EVENT_FAILED_RETRIABLE)) {
  4189. const char *reason_str = stream_end_reason_to_control_string(reason_code);
  4190. char *r = NULL;
  4191. if (!reason_str) {
  4192. tor_asprintf(&r, " UNKNOWN_%d", reason_code);
  4193. reason_str = r;
  4194. }
  4195. if (reason_code & END_STREAM_REASON_FLAG_REMOTE)
  4196. tor_snprintf(reason_buf, sizeof(reason_buf),
  4197. " REASON=END REMOTE_REASON=%s", reason_str);
  4198. else
  4199. tor_snprintf(reason_buf, sizeof(reason_buf),
  4200. " REASON=%s", reason_str);
  4201. tor_free(r);
  4202. } else if (reason_code && tp == STREAM_EVENT_REMAP) {
  4203. switch (reason_code) {
  4204. case REMAP_STREAM_SOURCE_CACHE:
  4205. strlcpy(reason_buf, " SOURCE=CACHE", sizeof(reason_buf));
  4206. break;
  4207. case REMAP_STREAM_SOURCE_EXIT:
  4208. strlcpy(reason_buf, " SOURCE=EXIT", sizeof(reason_buf));
  4209. break;
  4210. default:
  4211. tor_snprintf(reason_buf, sizeof(reason_buf), " REASON=UNKNOWN_%d",
  4212. reason_code);
  4213. /* XXX do we want SOURCE=UNKNOWN_%d above instead? -RD */
  4214. break;
  4215. }
  4216. }
  4217. if (tp == STREAM_EVENT_NEW || tp == STREAM_EVENT_NEW_RESOLVE) {
  4218. /*
  4219. * When the control conn is an AF_UNIX socket and we have no address,
  4220. * it gets set to "(Tor_internal)"; see dnsserv_launch_request() in
  4221. * dnsserv.c.
  4222. */
  4223. if (strcmp(ENTRY_TO_CONN(conn)->address, "(Tor_internal)") != 0) {
  4224. tor_snprintf(addrport_buf,sizeof(addrport_buf), " SOURCE_ADDR=%s:%d",
  4225. ENTRY_TO_CONN(conn)->address, ENTRY_TO_CONN(conn)->port);
  4226. } else {
  4227. /*
  4228. * else leave it blank so control on AF_UNIX doesn't need to make
  4229. * something up.
  4230. */
  4231. addrport_buf[0] = '\0';
  4232. }
  4233. } else {
  4234. addrport_buf[0] = '\0';
  4235. }
  4236. if (tp == STREAM_EVENT_NEW_RESOLVE) {
  4237. purpose = " PURPOSE=DNS_REQUEST";
  4238. } else if (tp == STREAM_EVENT_NEW) {
  4239. if (conn->use_begindir) {
  4240. connection_t *linked = ENTRY_TO_CONN(conn)->linked_conn;
  4241. int linked_dir_purpose = -1;
  4242. if (linked && linked->type == CONN_TYPE_DIR)
  4243. linked_dir_purpose = linked->purpose;
  4244. if (DIR_PURPOSE_IS_UPLOAD(linked_dir_purpose))
  4245. purpose = " PURPOSE=DIR_UPLOAD";
  4246. else
  4247. purpose = " PURPOSE=DIR_FETCH";
  4248. } else
  4249. purpose = " PURPOSE=USER";
  4250. }
  4251. circ = circuit_get_by_edge_conn(ENTRY_TO_EDGE_CONN(conn));
  4252. if (circ && CIRCUIT_IS_ORIGIN(circ))
  4253. origin_circ = TO_ORIGIN_CIRCUIT(circ);
  4254. send_control_event(EVENT_STREAM_STATUS, ALL_FORMATS,
  4255. "650 STREAM "U64_FORMAT" %s %lu %s%s%s%s\r\n",
  4256. U64_PRINTF_ARG(ENTRY_TO_CONN(conn)->global_identifier),
  4257. status,
  4258. origin_circ?
  4259. (unsigned long)origin_circ->global_identifier : 0ul,
  4260. buf, reason_buf, addrport_buf, purpose);
  4261. /* XXX need to specify its intended exit, etc? */
  4262. return 0;
  4263. }
  4264. /** Figure out the best name for the target router of an OR connection
  4265. * <b>conn</b>, and write it into the <b>len</b>-character buffer
  4266. * <b>name</b>. */
  4267. static void
  4268. orconn_target_get_name(char *name, size_t len, or_connection_t *conn)
  4269. {
  4270. const node_t *node = node_get_by_id(conn->identity_digest);
  4271. if (node) {
  4272. tor_assert(len > MAX_VERBOSE_NICKNAME_LEN);
  4273. node_get_verbose_nickname(node, name);
  4274. } else if (! tor_digest_is_zero(conn->identity_digest)) {
  4275. name[0] = '$';
  4276. base16_encode(name+1, len-1, conn->identity_digest,
  4277. DIGEST_LEN);
  4278. } else {
  4279. tor_snprintf(name, len, "%s:%d",
  4280. conn->base_.address, conn->base_.port);
  4281. }
  4282. }
  4283. /** Called when the status of an OR connection <b>conn</b> changes: tell any
  4284. * interested control connections. <b>tp</b> is the new status for the
  4285. * connection. If <b>conn</b> has just closed or failed, then <b>reason</b>
  4286. * may be the reason why.
  4287. */
  4288. int
  4289. control_event_or_conn_status(or_connection_t *conn, or_conn_status_event_t tp,
  4290. int reason)
  4291. {
  4292. int ncircs = 0;
  4293. const char *status;
  4294. char name[128];
  4295. char ncircs_buf[32] = {0}; /* > 8 + log10(2^32)=10 + 2 */
  4296. if (!EVENT_IS_INTERESTING(EVENT_OR_CONN_STATUS))
  4297. return 0;
  4298. switch (tp)
  4299. {
  4300. case OR_CONN_EVENT_LAUNCHED: status = "LAUNCHED"; break;
  4301. case OR_CONN_EVENT_CONNECTED: status = "CONNECTED"; break;
  4302. case OR_CONN_EVENT_FAILED: status = "FAILED"; break;
  4303. case OR_CONN_EVENT_CLOSED: status = "CLOSED"; break;
  4304. case OR_CONN_EVENT_NEW: status = "NEW"; break;
  4305. default:
  4306. log_warn(LD_BUG, "Unrecognized status code %d", (int)tp);
  4307. return 0;
  4308. }
  4309. if (conn->chan) {
  4310. ncircs = circuit_count_pending_on_channel(TLS_CHAN_TO_BASE(conn->chan));
  4311. } else {
  4312. ncircs = 0;
  4313. }
  4314. ncircs += connection_or_get_num_circuits(conn);
  4315. if (ncircs && (tp == OR_CONN_EVENT_FAILED || tp == OR_CONN_EVENT_CLOSED)) {
  4316. tor_snprintf(ncircs_buf, sizeof(ncircs_buf), " NCIRCS=%d", ncircs);
  4317. }
  4318. orconn_target_get_name(name, sizeof(name), conn);
  4319. send_control_event(EVENT_OR_CONN_STATUS, ALL_FORMATS,
  4320. "650 ORCONN %s %s%s%s%s ID="U64_FORMAT"\r\n",
  4321. name, status,
  4322. reason ? " REASON=" : "",
  4323. orconn_end_reason_to_control_string(reason),
  4324. ncircs_buf,
  4325. U64_PRINTF_ARG(conn->base_.global_identifier));
  4326. return 0;
  4327. }
  4328. /**
  4329. * Print out STREAM_BW event for a single conn
  4330. */
  4331. int
  4332. control_event_stream_bandwidth(edge_connection_t *edge_conn)
  4333. {
  4334. circuit_t *circ;
  4335. origin_circuit_t *ocirc;
  4336. if (EVENT_IS_INTERESTING(EVENT_STREAM_BANDWIDTH_USED)) {
  4337. if (!edge_conn->n_read && !edge_conn->n_written)
  4338. return 0;
  4339. send_control_event(EVENT_STREAM_BANDWIDTH_USED, ALL_FORMATS,
  4340. "650 STREAM_BW "U64_FORMAT" %lu %lu\r\n",
  4341. U64_PRINTF_ARG(edge_conn->base_.global_identifier),
  4342. (unsigned long)edge_conn->n_read,
  4343. (unsigned long)edge_conn->n_written);
  4344. circ = circuit_get_by_edge_conn(edge_conn);
  4345. if (circ && CIRCUIT_IS_ORIGIN(circ)) {
  4346. ocirc = TO_ORIGIN_CIRCUIT(circ);
  4347. ocirc->n_read_circ_bw += edge_conn->n_read;
  4348. ocirc->n_written_circ_bw += edge_conn->n_written;
  4349. }
  4350. edge_conn->n_written = edge_conn->n_read = 0;
  4351. }
  4352. return 0;
  4353. }
  4354. /** A second or more has elapsed: tell any interested control
  4355. * connections how much bandwidth streams have used. */
  4356. int
  4357. control_event_stream_bandwidth_used(void)
  4358. {
  4359. if (EVENT_IS_INTERESTING(EVENT_STREAM_BANDWIDTH_USED)) {
  4360. smartlist_t *conns = get_connection_array();
  4361. edge_connection_t *edge_conn;
  4362. SMARTLIST_FOREACH_BEGIN(conns, connection_t *, conn)
  4363. {
  4364. if (conn->type != CONN_TYPE_AP)
  4365. continue;
  4366. edge_conn = TO_EDGE_CONN(conn);
  4367. if (!edge_conn->n_read && !edge_conn->n_written)
  4368. continue;
  4369. send_control_event(EVENT_STREAM_BANDWIDTH_USED, ALL_FORMATS,
  4370. "650 STREAM_BW "U64_FORMAT" %lu %lu\r\n",
  4371. U64_PRINTF_ARG(edge_conn->base_.global_identifier),
  4372. (unsigned long)edge_conn->n_read,
  4373. (unsigned long)edge_conn->n_written);
  4374. edge_conn->n_written = edge_conn->n_read = 0;
  4375. }
  4376. SMARTLIST_FOREACH_END(conn);
  4377. }
  4378. return 0;
  4379. }
  4380. /** A second or more has elapsed: tell any interested control connections
  4381. * how much bandwidth origin circuits have used. */
  4382. int
  4383. control_event_circ_bandwidth_used(void)
  4384. {
  4385. origin_circuit_t *ocirc;
  4386. if (!EVENT_IS_INTERESTING(EVENT_CIRC_BANDWIDTH_USED))
  4387. return 0;
  4388. SMARTLIST_FOREACH_BEGIN(circuit_get_global_list(), circuit_t *, circ) {
  4389. if (!CIRCUIT_IS_ORIGIN(circ))
  4390. continue;
  4391. ocirc = TO_ORIGIN_CIRCUIT(circ);
  4392. if (!ocirc->n_read_circ_bw && !ocirc->n_written_circ_bw)
  4393. continue;
  4394. send_control_event(EVENT_CIRC_BANDWIDTH_USED, ALL_FORMATS,
  4395. "650 CIRC_BW ID=%d READ=%lu WRITTEN=%lu\r\n",
  4396. ocirc->global_identifier,
  4397. (unsigned long)ocirc->n_read_circ_bw,
  4398. (unsigned long)ocirc->n_written_circ_bw);
  4399. ocirc->n_written_circ_bw = ocirc->n_read_circ_bw = 0;
  4400. }
  4401. SMARTLIST_FOREACH_END(circ);
  4402. return 0;
  4403. }
  4404. /** Print out CONN_BW event for a single OR/DIR/EXIT <b>conn</b> and reset
  4405. * bandwidth counters. */
  4406. int
  4407. control_event_conn_bandwidth(connection_t *conn)
  4408. {
  4409. const char *conn_type_str;
  4410. if (!get_options()->TestingEnableConnBwEvent ||
  4411. !EVENT_IS_INTERESTING(EVENT_CONN_BW))
  4412. return 0;
  4413. if (!conn->n_read_conn_bw && !conn->n_written_conn_bw)
  4414. return 0;
  4415. switch (conn->type) {
  4416. case CONN_TYPE_OR:
  4417. conn_type_str = "OR";
  4418. break;
  4419. case CONN_TYPE_DIR:
  4420. conn_type_str = "DIR";
  4421. break;
  4422. case CONN_TYPE_EXIT:
  4423. conn_type_str = "EXIT";
  4424. break;
  4425. default:
  4426. return 0;
  4427. }
  4428. send_control_event(EVENT_CONN_BW, ALL_FORMATS,
  4429. "650 CONN_BW ID="U64_FORMAT" TYPE=%s "
  4430. "READ=%lu WRITTEN=%lu\r\n",
  4431. U64_PRINTF_ARG(conn->global_identifier),
  4432. conn_type_str,
  4433. (unsigned long)conn->n_read_conn_bw,
  4434. (unsigned long)conn->n_written_conn_bw);
  4435. conn->n_written_conn_bw = conn->n_read_conn_bw = 0;
  4436. return 0;
  4437. }
  4438. /** A second or more has elapsed: tell any interested control
  4439. * connections how much bandwidth connections have used. */
  4440. int
  4441. control_event_conn_bandwidth_used(void)
  4442. {
  4443. if (get_options()->TestingEnableConnBwEvent &&
  4444. EVENT_IS_INTERESTING(EVENT_CONN_BW)) {
  4445. SMARTLIST_FOREACH(get_connection_array(), connection_t *, conn,
  4446. control_event_conn_bandwidth(conn));
  4447. }
  4448. return 0;
  4449. }
  4450. /** Helper: iterate over cell statistics of <b>circ</b> and sum up added
  4451. * cells, removed cells, and waiting times by cell command and direction.
  4452. * Store results in <b>cell_stats</b>. Free cell statistics of the
  4453. * circuit afterwards. */
  4454. void
  4455. sum_up_cell_stats_by_command(circuit_t *circ, cell_stats_t *cell_stats)
  4456. {
  4457. memset(cell_stats, 0, sizeof(cell_stats_t));
  4458. SMARTLIST_FOREACH_BEGIN(circ->testing_cell_stats,
  4459. testing_cell_stats_entry_t *, ent) {
  4460. tor_assert(ent->command <= CELL_COMMAND_MAX_);
  4461. if (!ent->removed && !ent->exitward) {
  4462. cell_stats->added_cells_appward[ent->command] += 1;
  4463. } else if (!ent->removed && ent->exitward) {
  4464. cell_stats->added_cells_exitward[ent->command] += 1;
  4465. } else if (!ent->exitward) {
  4466. cell_stats->removed_cells_appward[ent->command] += 1;
  4467. cell_stats->total_time_appward[ent->command] += ent->waiting_time * 10;
  4468. } else {
  4469. cell_stats->removed_cells_exitward[ent->command] += 1;
  4470. cell_stats->total_time_exitward[ent->command] += ent->waiting_time * 10;
  4471. }
  4472. tor_free(ent);
  4473. } SMARTLIST_FOREACH_END(ent);
  4474. smartlist_free(circ->testing_cell_stats);
  4475. circ->testing_cell_stats = NULL;
  4476. }
  4477. /** Helper: append a cell statistics string to <code>event_parts</code>,
  4478. * prefixed with <code>key</code>=. Statistics consist of comma-separated
  4479. * key:value pairs with lower-case command strings as keys and cell
  4480. * numbers or total waiting times as values. A key:value pair is included
  4481. * if the entry in <code>include_if_non_zero</code> is not zero, but with
  4482. * the (possibly zero) entry from <code>number_to_include</code>. Both
  4483. * arrays are expected to have a length of CELL_COMMAND_MAX_ + 1. If no
  4484. * entry in <code>include_if_non_zero</code> is positive, no string will
  4485. * be added to <code>event_parts</code>. */
  4486. void
  4487. append_cell_stats_by_command(smartlist_t *event_parts, const char *key,
  4488. const uint64_t *include_if_non_zero,
  4489. const uint64_t *number_to_include)
  4490. {
  4491. smartlist_t *key_value_strings = smartlist_new();
  4492. int i;
  4493. for (i = 0; i <= CELL_COMMAND_MAX_; i++) {
  4494. if (include_if_non_zero[i] > 0) {
  4495. smartlist_add_asprintf(key_value_strings, "%s:"U64_FORMAT,
  4496. cell_command_to_string(i),
  4497. U64_PRINTF_ARG(number_to_include[i]));
  4498. }
  4499. }
  4500. if (smartlist_len(key_value_strings) > 0) {
  4501. char *joined = smartlist_join_strings(key_value_strings, ",", 0, NULL);
  4502. smartlist_add_asprintf(event_parts, "%s=%s", key, joined);
  4503. SMARTLIST_FOREACH(key_value_strings, char *, cp, tor_free(cp));
  4504. tor_free(joined);
  4505. }
  4506. smartlist_free(key_value_strings);
  4507. }
  4508. /** Helper: format <b>cell_stats</b> for <b>circ</b> for inclusion in a
  4509. * CELL_STATS event and write result string to <b>event_string</b>. */
  4510. void
  4511. format_cell_stats(char **event_string, circuit_t *circ,
  4512. cell_stats_t *cell_stats)
  4513. {
  4514. smartlist_t *event_parts = smartlist_new();
  4515. if (CIRCUIT_IS_ORIGIN(circ)) {
  4516. origin_circuit_t *ocirc = TO_ORIGIN_CIRCUIT(circ);
  4517. smartlist_add_asprintf(event_parts, "ID=%lu",
  4518. (unsigned long)ocirc->global_identifier);
  4519. } else if (TO_OR_CIRCUIT(circ)->p_chan) {
  4520. or_circuit_t *or_circ = TO_OR_CIRCUIT(circ);
  4521. smartlist_add_asprintf(event_parts, "InboundQueue=%lu",
  4522. (unsigned long)or_circ->p_circ_id);
  4523. smartlist_add_asprintf(event_parts, "InboundConn="U64_FORMAT,
  4524. U64_PRINTF_ARG(or_circ->p_chan->global_identifier));
  4525. append_cell_stats_by_command(event_parts, "InboundAdded",
  4526. cell_stats->added_cells_appward,
  4527. cell_stats->added_cells_appward);
  4528. append_cell_stats_by_command(event_parts, "InboundRemoved",
  4529. cell_stats->removed_cells_appward,
  4530. cell_stats->removed_cells_appward);
  4531. append_cell_stats_by_command(event_parts, "InboundTime",
  4532. cell_stats->removed_cells_appward,
  4533. cell_stats->total_time_appward);
  4534. }
  4535. if (circ->n_chan) {
  4536. smartlist_add_asprintf(event_parts, "OutboundQueue=%lu",
  4537. (unsigned long)circ->n_circ_id);
  4538. smartlist_add_asprintf(event_parts, "OutboundConn="U64_FORMAT,
  4539. U64_PRINTF_ARG(circ->n_chan->global_identifier));
  4540. append_cell_stats_by_command(event_parts, "OutboundAdded",
  4541. cell_stats->added_cells_exitward,
  4542. cell_stats->added_cells_exitward);
  4543. append_cell_stats_by_command(event_parts, "OutboundRemoved",
  4544. cell_stats->removed_cells_exitward,
  4545. cell_stats->removed_cells_exitward);
  4546. append_cell_stats_by_command(event_parts, "OutboundTime",
  4547. cell_stats->removed_cells_exitward,
  4548. cell_stats->total_time_exitward);
  4549. }
  4550. *event_string = smartlist_join_strings(event_parts, " ", 0, NULL);
  4551. SMARTLIST_FOREACH(event_parts, char *, cp, tor_free(cp));
  4552. smartlist_free(event_parts);
  4553. }
  4554. /** A second or more has elapsed: tell any interested control connection
  4555. * how many cells have been processed for a given circuit. */
  4556. int
  4557. control_event_circuit_cell_stats(void)
  4558. {
  4559. cell_stats_t *cell_stats;
  4560. char *event_string;
  4561. if (!get_options()->TestingEnableCellStatsEvent ||
  4562. !EVENT_IS_INTERESTING(EVENT_CELL_STATS))
  4563. return 0;
  4564. cell_stats = tor_malloc(sizeof(cell_stats_t));;
  4565. SMARTLIST_FOREACH_BEGIN(circuit_get_global_list(), circuit_t *, circ) {
  4566. if (!circ->testing_cell_stats)
  4567. continue;
  4568. sum_up_cell_stats_by_command(circ, cell_stats);
  4569. format_cell_stats(&event_string, circ, cell_stats);
  4570. send_control_event(EVENT_CELL_STATS, ALL_FORMATS,
  4571. "650 CELL_STATS %s\r\n", event_string);
  4572. tor_free(event_string);
  4573. }
  4574. SMARTLIST_FOREACH_END(circ);
  4575. tor_free(cell_stats);
  4576. return 0;
  4577. }
  4578. /** Tokens in <b>bucket</b> have been refilled: the read bucket was empty
  4579. * for <b>read_empty_time</b> millis, the write bucket was empty for
  4580. * <b>write_empty_time</b> millis, and buckets were last refilled
  4581. * <b>milliseconds_elapsed</b> millis ago. Only emit TB_EMPTY event if
  4582. * either read or write bucket have been empty before. */
  4583. int
  4584. control_event_tb_empty(const char *bucket, uint32_t read_empty_time,
  4585. uint32_t write_empty_time,
  4586. int milliseconds_elapsed)
  4587. {
  4588. if (get_options()->TestingEnableTbEmptyEvent &&
  4589. EVENT_IS_INTERESTING(EVENT_TB_EMPTY) &&
  4590. (read_empty_time > 0 || write_empty_time > 0)) {
  4591. send_control_event(EVENT_TB_EMPTY, ALL_FORMATS,
  4592. "650 TB_EMPTY %s READ=%d WRITTEN=%d "
  4593. "LAST=%d\r\n",
  4594. bucket, read_empty_time, write_empty_time,
  4595. milliseconds_elapsed);
  4596. }
  4597. return 0;
  4598. }
  4599. /* about 5 minutes worth. */
  4600. #define N_BW_EVENTS_TO_CACHE 300
  4601. /* Index into cached_bw_events to next write. */
  4602. static int next_measurement_idx = 0;
  4603. /* number of entries set in n_measurements */
  4604. static int n_measurements = 0;
  4605. static struct cached_bw_event_s {
  4606. uint32_t n_read;
  4607. uint32_t n_written;
  4608. } cached_bw_events[N_BW_EVENTS_TO_CACHE];
  4609. /** A second or more has elapsed: tell any interested control
  4610. * connections how much bandwidth we used. */
  4611. int
  4612. control_event_bandwidth_used(uint32_t n_read, uint32_t n_written)
  4613. {
  4614. cached_bw_events[next_measurement_idx].n_read = n_read;
  4615. cached_bw_events[next_measurement_idx].n_written = n_written;
  4616. if (++next_measurement_idx == N_BW_EVENTS_TO_CACHE)
  4617. next_measurement_idx = 0;
  4618. if (n_measurements < N_BW_EVENTS_TO_CACHE)
  4619. ++n_measurements;
  4620. if (EVENT_IS_INTERESTING(EVENT_BANDWIDTH_USED)) {
  4621. send_control_event(EVENT_BANDWIDTH_USED, ALL_FORMATS,
  4622. "650 BW %lu %lu\r\n",
  4623. (unsigned long)n_read,
  4624. (unsigned long)n_written);
  4625. }
  4626. return 0;
  4627. }
  4628. STATIC char *
  4629. get_bw_samples(void)
  4630. {
  4631. int i;
  4632. int idx = (next_measurement_idx + N_BW_EVENTS_TO_CACHE - n_measurements)
  4633. % N_BW_EVENTS_TO_CACHE;
  4634. tor_assert(0 <= idx && idx < N_BW_EVENTS_TO_CACHE);
  4635. smartlist_t *elements = smartlist_new();
  4636. for (i = 0; i < n_measurements; ++i) {
  4637. tor_assert(0 <= idx && idx < N_BW_EVENTS_TO_CACHE);
  4638. const struct cached_bw_event_s *bwe = &cached_bw_events[idx];
  4639. smartlist_add_asprintf(elements, "%u,%u",
  4640. (unsigned)bwe->n_read,
  4641. (unsigned)bwe->n_written);
  4642. idx = (idx + 1) % N_BW_EVENTS_TO_CACHE;
  4643. }
  4644. char *result = smartlist_join_strings(elements, " ", 0, NULL);
  4645. SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
  4646. smartlist_free(elements);
  4647. return result;
  4648. }
  4649. /** Called when we are sending a log message to the controllers: suspend
  4650. * sending further log messages to the controllers until we're done. Used by
  4651. * CONN_LOG_PROTECT. */
  4652. void
  4653. disable_control_logging(void)
  4654. {
  4655. ++disable_log_messages;
  4656. }
  4657. /** We're done sending a log message to the controllers: re-enable controller
  4658. * logging. Used by CONN_LOG_PROTECT. */
  4659. void
  4660. enable_control_logging(void)
  4661. {
  4662. if (--disable_log_messages < 0)
  4663. tor_assert(0);
  4664. }
  4665. /** We got a log message: tell any interested control connections. */
  4666. void
  4667. control_event_logmsg(int severity, uint32_t domain, const char *msg)
  4668. {
  4669. int event;
  4670. /* Don't even think of trying to add stuff to a buffer from a cpuworker
  4671. * thread. */
  4672. if (! in_main_thread())
  4673. return;
  4674. if (disable_log_messages)
  4675. return;
  4676. if (domain == LD_BUG && EVENT_IS_INTERESTING(EVENT_STATUS_GENERAL) &&
  4677. severity <= LOG_NOTICE) {
  4678. char *esc = esc_for_log(msg);
  4679. ++disable_log_messages;
  4680. control_event_general_status(severity, "BUG REASON=%s", esc);
  4681. --disable_log_messages;
  4682. tor_free(esc);
  4683. }
  4684. event = log_severity_to_event(severity);
  4685. if (event >= 0 && EVENT_IS_INTERESTING(event)) {
  4686. char *b = NULL;
  4687. const char *s;
  4688. if (strchr(msg, '\n')) {
  4689. char *cp;
  4690. b = tor_strdup(msg);
  4691. for (cp = b; *cp; ++cp)
  4692. if (*cp == '\r' || *cp == '\n')
  4693. *cp = ' ';
  4694. }
  4695. switch (severity) {
  4696. case LOG_DEBUG: s = "DEBUG"; break;
  4697. case LOG_INFO: s = "INFO"; break;
  4698. case LOG_NOTICE: s = "NOTICE"; break;
  4699. case LOG_WARN: s = "WARN"; break;
  4700. case LOG_ERR: s = "ERR"; break;
  4701. default: s = "UnknownLogSeverity"; break;
  4702. }
  4703. ++disable_log_messages;
  4704. send_control_event(event, ALL_FORMATS, "650 %s %s\r\n", s, b?b:msg);
  4705. if (severity == LOG_ERR) {
  4706. /* Force a flush, since we may be about to die horribly */
  4707. queued_events_flush_all(1);
  4708. }
  4709. --disable_log_messages;
  4710. tor_free(b);
  4711. }
  4712. }
  4713. /** Called whenever we receive new router descriptors: tell any
  4714. * interested control connections. <b>routers</b> is a list of
  4715. * routerinfo_t's.
  4716. */
  4717. int
  4718. control_event_descriptors_changed(smartlist_t *routers)
  4719. {
  4720. char *msg;
  4721. if (!EVENT_IS_INTERESTING(EVENT_NEW_DESC))
  4722. return 0;
  4723. {
  4724. smartlist_t *names = smartlist_new();
  4725. char *ids;
  4726. SMARTLIST_FOREACH(routers, routerinfo_t *, ri, {
  4727. char *b = tor_malloc(MAX_VERBOSE_NICKNAME_LEN+1);
  4728. router_get_verbose_nickname(b, ri);
  4729. smartlist_add(names, b);
  4730. });
  4731. ids = smartlist_join_strings(names, " ", 0, NULL);
  4732. tor_asprintf(&msg, "650 NEWDESC %s\r\n", ids);
  4733. send_control_event_string(EVENT_NEW_DESC, ALL_FORMATS, msg);
  4734. tor_free(ids);
  4735. tor_free(msg);
  4736. SMARTLIST_FOREACH(names, char *, cp, tor_free(cp));
  4737. smartlist_free(names);
  4738. }
  4739. return 0;
  4740. }
  4741. /** Called when an address mapping on <b>from</b> from changes to <b>to</b>.
  4742. * <b>expires</b> values less than 3 are special; see connection_edge.c. If
  4743. * <b>error</b> is non-NULL, it is an error code describing the failure
  4744. * mode of the mapping.
  4745. */
  4746. int
  4747. control_event_address_mapped(const char *from, const char *to, time_t expires,
  4748. const char *error, const int cached)
  4749. {
  4750. if (!EVENT_IS_INTERESTING(EVENT_ADDRMAP))
  4751. return 0;
  4752. if (expires < 3 || expires == TIME_MAX)
  4753. send_control_event(EVENT_ADDRMAP, ALL_FORMATS,
  4754. "650 ADDRMAP %s %s NEVER %s%s"
  4755. "CACHED=\"%s\"\r\n",
  4756. from, to, error?error:"", error?" ":"",
  4757. cached?"YES":"NO");
  4758. else {
  4759. char buf[ISO_TIME_LEN+1];
  4760. char buf2[ISO_TIME_LEN+1];
  4761. format_local_iso_time(buf,expires);
  4762. format_iso_time(buf2,expires);
  4763. send_control_event(EVENT_ADDRMAP, ALL_FORMATS,
  4764. "650 ADDRMAP %s %s \"%s\""
  4765. " %s%sEXPIRES=\"%s\" CACHED=\"%s\"\r\n",
  4766. from, to, buf,
  4767. error?error:"", error?" ":"",
  4768. buf2, cached?"YES":"NO");
  4769. }
  4770. return 0;
  4771. }
  4772. /** The authoritative dirserver has received a new descriptor that
  4773. * has passed basic syntax checks and is properly self-signed.
  4774. *
  4775. * Notify any interested party of the new descriptor and what has
  4776. * been done with it, and also optionally give an explanation/reason. */
  4777. int
  4778. control_event_or_authdir_new_descriptor(const char *action,
  4779. const char *desc, size_t desclen,
  4780. const char *msg)
  4781. {
  4782. char firstline[1024];
  4783. char *buf;
  4784. size_t totallen;
  4785. char *esc = NULL;
  4786. size_t esclen;
  4787. if (!EVENT_IS_INTERESTING(EVENT_AUTHDIR_NEWDESCS))
  4788. return 0;
  4789. tor_snprintf(firstline, sizeof(firstline),
  4790. "650+AUTHDIR_NEWDESC=\r\n%s\r\n%s\r\n",
  4791. action,
  4792. msg ? msg : "");
  4793. /* Escape the server descriptor properly */
  4794. esclen = write_escaped_data(desc, desclen, &esc);
  4795. totallen = strlen(firstline) + esclen + 1;
  4796. buf = tor_malloc(totallen);
  4797. strlcpy(buf, firstline, totallen);
  4798. strlcpy(buf+strlen(firstline), esc, totallen);
  4799. send_control_event_string(EVENT_AUTHDIR_NEWDESCS, ALL_FORMATS,
  4800. buf);
  4801. send_control_event_string(EVENT_AUTHDIR_NEWDESCS, ALL_FORMATS,
  4802. "650 OK\r\n");
  4803. tor_free(esc);
  4804. tor_free(buf);
  4805. return 0;
  4806. }
  4807. /** Cached liveness for network liveness events and GETINFO
  4808. */
  4809. static int network_is_live = 0;
  4810. static int
  4811. get_cached_network_liveness(void)
  4812. {
  4813. return network_is_live;
  4814. }
  4815. static void
  4816. set_cached_network_liveness(int liveness)
  4817. {
  4818. network_is_live = liveness;
  4819. }
  4820. /** The network liveness has changed; this is called from circuitstats.c
  4821. * whenever we receive a cell, or when timeout expires and we assume the
  4822. * network is down. */
  4823. int
  4824. control_event_network_liveness_update(int liveness)
  4825. {
  4826. if (liveness > 0) {
  4827. if (get_cached_network_liveness() <= 0) {
  4828. /* Update cached liveness */
  4829. set_cached_network_liveness(1);
  4830. log_debug(LD_CONTROL, "Sending NETWORK_LIVENESS UP");
  4831. send_control_event_string(EVENT_NETWORK_LIVENESS, ALL_FORMATS,
  4832. "650 NETWORK_LIVENESS UP\r\n");
  4833. }
  4834. /* else was already live, no-op */
  4835. } else {
  4836. if (get_cached_network_liveness() > 0) {
  4837. /* Update cached liveness */
  4838. set_cached_network_liveness(0);
  4839. log_debug(LD_CONTROL, "Sending NETWORK_LIVENESS DOWN");
  4840. send_control_event_string(EVENT_NETWORK_LIVENESS, ALL_FORMATS,
  4841. "650 NETWORK_LIVENESS DOWN\r\n");
  4842. }
  4843. /* else was already dead, no-op */
  4844. }
  4845. return 0;
  4846. }
  4847. /** Helper function for NS-style events. Constructs and sends an event
  4848. * of type <b>event</b> with string <b>event_string</b> out of the set of
  4849. * networkstatuses <b>statuses</b>. Currently it is used for NS events
  4850. * and NEWCONSENSUS events. */
  4851. static int
  4852. control_event_networkstatus_changed_helper(smartlist_t *statuses,
  4853. uint16_t event,
  4854. const char *event_string)
  4855. {
  4856. smartlist_t *strs;
  4857. char *s, *esc = NULL;
  4858. if (!EVENT_IS_INTERESTING(event) || !smartlist_len(statuses))
  4859. return 0;
  4860. strs = smartlist_new();
  4861. smartlist_add(strs, tor_strdup("650+"));
  4862. smartlist_add(strs, tor_strdup(event_string));
  4863. smartlist_add(strs, tor_strdup("\r\n"));
  4864. SMARTLIST_FOREACH(statuses, const routerstatus_t *, rs,
  4865. {
  4866. s = networkstatus_getinfo_helper_single(rs);
  4867. if (!s) continue;
  4868. smartlist_add(strs, s);
  4869. });
  4870. s = smartlist_join_strings(strs, "", 0, NULL);
  4871. write_escaped_data(s, strlen(s), &esc);
  4872. SMARTLIST_FOREACH(strs, char *, cp, tor_free(cp));
  4873. smartlist_free(strs);
  4874. tor_free(s);
  4875. send_control_event_string(event, ALL_FORMATS, esc);
  4876. send_control_event_string(event, ALL_FORMATS,
  4877. "650 OK\r\n");
  4878. tor_free(esc);
  4879. return 0;
  4880. }
  4881. /** Called when the routerstatus_ts <b>statuses</b> have changed: sends
  4882. * an NS event to any controller that cares. */
  4883. int
  4884. control_event_networkstatus_changed(smartlist_t *statuses)
  4885. {
  4886. return control_event_networkstatus_changed_helper(statuses, EVENT_NS, "NS");
  4887. }
  4888. /** Called when we get a new consensus networkstatus. Sends a NEWCONSENSUS
  4889. * event consisting of an NS-style line for each relay in the consensus. */
  4890. int
  4891. control_event_newconsensus(const networkstatus_t *consensus)
  4892. {
  4893. if (!control_event_is_interesting(EVENT_NEWCONSENSUS))
  4894. return 0;
  4895. return control_event_networkstatus_changed_helper(
  4896. consensus->routerstatus_list, EVENT_NEWCONSENSUS, "NEWCONSENSUS");
  4897. }
  4898. /** Called when we compute a new circuitbuildtimeout */
  4899. int
  4900. control_event_buildtimeout_set(buildtimeout_set_event_t type,
  4901. const char *args)
  4902. {
  4903. const char *type_string = NULL;
  4904. if (!control_event_is_interesting(EVENT_BUILDTIMEOUT_SET))
  4905. return 0;
  4906. switch (type) {
  4907. case BUILDTIMEOUT_SET_EVENT_COMPUTED:
  4908. type_string = "COMPUTED";
  4909. break;
  4910. case BUILDTIMEOUT_SET_EVENT_RESET:
  4911. type_string = "RESET";
  4912. break;
  4913. case BUILDTIMEOUT_SET_EVENT_SUSPENDED:
  4914. type_string = "SUSPENDED";
  4915. break;
  4916. case BUILDTIMEOUT_SET_EVENT_DISCARD:
  4917. type_string = "DISCARD";
  4918. break;
  4919. case BUILDTIMEOUT_SET_EVENT_RESUME:
  4920. type_string = "RESUME";
  4921. break;
  4922. default:
  4923. type_string = "UNKNOWN";
  4924. break;
  4925. }
  4926. send_control_event(EVENT_BUILDTIMEOUT_SET, ALL_FORMATS,
  4927. "650 BUILDTIMEOUT_SET %s %s\r\n",
  4928. type_string, args);
  4929. return 0;
  4930. }
  4931. /** Called when a signal has been processed from signal_callback */
  4932. int
  4933. control_event_signal(uintptr_t signal)
  4934. {
  4935. const char *signal_string = NULL;
  4936. if (!control_event_is_interesting(EVENT_SIGNAL))
  4937. return 0;
  4938. switch (signal) {
  4939. case SIGHUP:
  4940. signal_string = "RELOAD";
  4941. break;
  4942. case SIGUSR1:
  4943. signal_string = "DUMP";
  4944. break;
  4945. case SIGUSR2:
  4946. signal_string = "DEBUG";
  4947. break;
  4948. case SIGNEWNYM:
  4949. signal_string = "NEWNYM";
  4950. break;
  4951. case SIGCLEARDNSCACHE:
  4952. signal_string = "CLEARDNSCACHE";
  4953. break;
  4954. case SIGHEARTBEAT:
  4955. signal_string = "HEARTBEAT";
  4956. break;
  4957. default:
  4958. log_warn(LD_BUG, "Unrecognized signal %lu in control_event_signal",
  4959. (unsigned long)signal);
  4960. return -1;
  4961. }
  4962. send_control_event(EVENT_SIGNAL, ALL_FORMATS, "650 SIGNAL %s\r\n",
  4963. signal_string);
  4964. return 0;
  4965. }
  4966. /** Called when a single local_routerstatus_t has changed: Sends an NS event
  4967. * to any controller that cares. */
  4968. int
  4969. control_event_networkstatus_changed_single(const routerstatus_t *rs)
  4970. {
  4971. smartlist_t *statuses;
  4972. int r;
  4973. if (!EVENT_IS_INTERESTING(EVENT_NS))
  4974. return 0;
  4975. statuses = smartlist_new();
  4976. smartlist_add(statuses, (void*)rs);
  4977. r = control_event_networkstatus_changed(statuses);
  4978. smartlist_free(statuses);
  4979. return r;
  4980. }
  4981. /** Our own router descriptor has changed; tell any controllers that care.
  4982. */
  4983. int
  4984. control_event_my_descriptor_changed(void)
  4985. {
  4986. send_control_event(EVENT_DESCCHANGED, ALL_FORMATS, "650 DESCCHANGED\r\n");
  4987. return 0;
  4988. }
  4989. /** Helper: sends a status event where <b>type</b> is one of
  4990. * EVENT_STATUS_{GENERAL,CLIENT,SERVER}, where <b>severity</b> is one of
  4991. * LOG_{NOTICE,WARN,ERR}, and where <b>format</b> is a printf-style format
  4992. * string corresponding to <b>args</b>. */
  4993. static int
  4994. control_event_status(int type, int severity, const char *format, va_list args)
  4995. {
  4996. char *user_buf = NULL;
  4997. char format_buf[160];
  4998. const char *status, *sev;
  4999. switch (type) {
  5000. case EVENT_STATUS_GENERAL:
  5001. status = "STATUS_GENERAL";
  5002. break;
  5003. case EVENT_STATUS_CLIENT:
  5004. status = "STATUS_CLIENT";
  5005. break;
  5006. case EVENT_STATUS_SERVER:
  5007. status = "STATUS_SERVER";
  5008. break;
  5009. default:
  5010. log_warn(LD_BUG, "Unrecognized status type %d", type);
  5011. return -1;
  5012. }
  5013. switch (severity) {
  5014. case LOG_NOTICE:
  5015. sev = "NOTICE";
  5016. break;
  5017. case LOG_WARN:
  5018. sev = "WARN";
  5019. break;
  5020. case LOG_ERR:
  5021. sev = "ERR";
  5022. break;
  5023. default:
  5024. log_warn(LD_BUG, "Unrecognized status severity %d", severity);
  5025. return -1;
  5026. }
  5027. if (tor_snprintf(format_buf, sizeof(format_buf), "650 %s %s",
  5028. status, sev)<0) {
  5029. log_warn(LD_BUG, "Format string too long.");
  5030. return -1;
  5031. }
  5032. tor_vasprintf(&user_buf, format, args);
  5033. send_control_event(type, ALL_FORMATS, "%s %s\r\n", format_buf, user_buf);
  5034. tor_free(user_buf);
  5035. return 0;
  5036. }
  5037. #define CONTROL_EVENT_STATUS_BODY(event, sev) \
  5038. int r; \
  5039. do { \
  5040. va_list ap; \
  5041. if (!EVENT_IS_INTERESTING(event)) \
  5042. return 0; \
  5043. \
  5044. va_start(ap, format); \
  5045. r = control_event_status((event), (sev), format, ap); \
  5046. va_end(ap); \
  5047. } while (0)
  5048. /** Format and send an EVENT_STATUS_GENERAL event whose main text is obtained
  5049. * by formatting the arguments using the printf-style <b>format</b>. */
  5050. int
  5051. control_event_general_status(int severity, const char *format, ...)
  5052. {
  5053. CONTROL_EVENT_STATUS_BODY(EVENT_STATUS_GENERAL, severity);
  5054. return r;
  5055. }
  5056. /** Format and send an EVENT_STATUS_GENERAL LOG_ERR event, and flush it to the
  5057. * controller(s) immediately. */
  5058. int
  5059. control_event_general_error(const char *format, ...)
  5060. {
  5061. CONTROL_EVENT_STATUS_BODY(EVENT_STATUS_GENERAL, LOG_ERR);
  5062. /* Force a flush, since we may be about to die horribly */
  5063. queued_events_flush_all(1);
  5064. return r;
  5065. }
  5066. /** Format and send an EVENT_STATUS_CLIENT event whose main text is obtained
  5067. * by formatting the arguments using the printf-style <b>format</b>. */
  5068. int
  5069. control_event_client_status(int severity, const char *format, ...)
  5070. {
  5071. CONTROL_EVENT_STATUS_BODY(EVENT_STATUS_CLIENT, severity);
  5072. return r;
  5073. }
  5074. /** Format and send an EVENT_STATUS_CLIENT LOG_ERR event, and flush it to the
  5075. * controller(s) immediately. */
  5076. int
  5077. control_event_client_error(const char *format, ...)
  5078. {
  5079. CONTROL_EVENT_STATUS_BODY(EVENT_STATUS_CLIENT, LOG_ERR);
  5080. /* Force a flush, since we may be about to die horribly */
  5081. queued_events_flush_all(1);
  5082. return r;
  5083. }
  5084. /** Format and send an EVENT_STATUS_SERVER event whose main text is obtained
  5085. * by formatting the arguments using the printf-style <b>format</b>. */
  5086. int
  5087. control_event_server_status(int severity, const char *format, ...)
  5088. {
  5089. CONTROL_EVENT_STATUS_BODY(EVENT_STATUS_SERVER, severity);
  5090. return r;
  5091. }
  5092. /** Format and send an EVENT_STATUS_SERVER LOG_ERR event, and flush it to the
  5093. * controller(s) immediately. */
  5094. int
  5095. control_event_server_error(const char *format, ...)
  5096. {
  5097. CONTROL_EVENT_STATUS_BODY(EVENT_STATUS_SERVER, LOG_ERR);
  5098. /* Force a flush, since we may be about to die horribly */
  5099. queued_events_flush_all(1);
  5100. return r;
  5101. }
  5102. /** Called when the status of an entry guard with the given <b>nickname</b>
  5103. * and identity <b>digest</b> has changed to <b>status</b>: tells any
  5104. * controllers that care. */
  5105. int
  5106. control_event_guard(const char *nickname, const char *digest,
  5107. const char *status)
  5108. {
  5109. char hbuf[HEX_DIGEST_LEN+1];
  5110. base16_encode(hbuf, sizeof(hbuf), digest, DIGEST_LEN);
  5111. if (!EVENT_IS_INTERESTING(EVENT_GUARD))
  5112. return 0;
  5113. {
  5114. char buf[MAX_VERBOSE_NICKNAME_LEN+1];
  5115. const node_t *node = node_get_by_id(digest);
  5116. if (node) {
  5117. node_get_verbose_nickname(node, buf);
  5118. } else {
  5119. tor_snprintf(buf, sizeof(buf), "$%s~%s", hbuf, nickname);
  5120. }
  5121. send_control_event(EVENT_GUARD, ALL_FORMATS,
  5122. "650 GUARD ENTRY %s %s\r\n", buf, status);
  5123. }
  5124. return 0;
  5125. }
  5126. /** Called when a configuration option changes. This is generally triggered
  5127. * by SETCONF requests and RELOAD/SIGHUP signals. The <b>elements</b> is
  5128. * a smartlist_t containing (key, value, ...) pairs in sequence.
  5129. * <b>value</b> can be NULL. */
  5130. int
  5131. control_event_conf_changed(const smartlist_t *elements)
  5132. {
  5133. int i;
  5134. char *result;
  5135. smartlist_t *lines;
  5136. if (!EVENT_IS_INTERESTING(EVENT_CONF_CHANGED) ||
  5137. smartlist_len(elements) == 0) {
  5138. return 0;
  5139. }
  5140. lines = smartlist_new();
  5141. for (i = 0; i < smartlist_len(elements); i += 2) {
  5142. char *k = smartlist_get(elements, i);
  5143. char *v = smartlist_get(elements, i+1);
  5144. if (v == NULL) {
  5145. smartlist_add_asprintf(lines, "650-%s", k);
  5146. } else {
  5147. smartlist_add_asprintf(lines, "650-%s=%s", k, v);
  5148. }
  5149. }
  5150. result = smartlist_join_strings(lines, "\r\n", 0, NULL);
  5151. send_control_event(EVENT_CONF_CHANGED, 0,
  5152. "650-CONF_CHANGED\r\n%s\r\n650 OK\r\n", result);
  5153. tor_free(result);
  5154. SMARTLIST_FOREACH(lines, char *, cp, tor_free(cp));
  5155. smartlist_free(lines);
  5156. return 0;
  5157. }
  5158. /** Helper: Return a newly allocated string containing a path to the
  5159. * file where we store our authentication cookie. */
  5160. char *
  5161. get_controller_cookie_file_name(void)
  5162. {
  5163. const or_options_t *options = get_options();
  5164. if (options->CookieAuthFile && strlen(options->CookieAuthFile)) {
  5165. return tor_strdup(options->CookieAuthFile);
  5166. } else {
  5167. return get_datadir_fname("control_auth_cookie");
  5168. }
  5169. }
  5170. /* Initialize the cookie-based authentication system of the
  5171. * ControlPort. If <b>enabled</b> is 0, then disable the cookie
  5172. * authentication system. */
  5173. int
  5174. init_control_cookie_authentication(int enabled)
  5175. {
  5176. char *fname = NULL;
  5177. int retval;
  5178. if (!enabled) {
  5179. authentication_cookie_is_set = 0;
  5180. return 0;
  5181. }
  5182. fname = get_controller_cookie_file_name();
  5183. retval = init_cookie_authentication(fname, "", /* no header */
  5184. AUTHENTICATION_COOKIE_LEN,
  5185. get_options()->CookieAuthFileGroupReadable,
  5186. &authentication_cookie,
  5187. &authentication_cookie_is_set);
  5188. tor_free(fname);
  5189. return retval;
  5190. }
  5191. /** A copy of the process specifier of Tor's owning controller, or
  5192. * NULL if this Tor instance is not currently owned by a process. */
  5193. static char *owning_controller_process_spec = NULL;
  5194. /** A process-termination monitor for Tor's owning controller, or NULL
  5195. * if this Tor instance is not currently owned by a process. */
  5196. static tor_process_monitor_t *owning_controller_process_monitor = NULL;
  5197. static void owning_controller_procmon_cb(void *unused) ATTR_NORETURN;
  5198. /** Process-termination monitor callback for Tor's owning controller
  5199. * process. */
  5200. static void
  5201. owning_controller_procmon_cb(void *unused)
  5202. {
  5203. (void)unused;
  5204. lost_owning_controller("process", "vanished");
  5205. }
  5206. /** Set <b>process_spec</b> as Tor's owning controller process.
  5207. * Exit on failure. */
  5208. void
  5209. monitor_owning_controller_process(const char *process_spec)
  5210. {
  5211. const char *msg;
  5212. tor_assert((owning_controller_process_spec == NULL) ==
  5213. (owning_controller_process_monitor == NULL));
  5214. if (owning_controller_process_spec != NULL) {
  5215. if ((process_spec != NULL) && !strcmp(process_spec,
  5216. owning_controller_process_spec)) {
  5217. /* Same process -- return now, instead of disposing of and
  5218. * recreating the process-termination monitor. */
  5219. return;
  5220. }
  5221. /* We are currently owned by a process, and we should no longer be
  5222. * owned by it. Free the process-termination monitor. */
  5223. tor_process_monitor_free(owning_controller_process_monitor);
  5224. owning_controller_process_monitor = NULL;
  5225. tor_free(owning_controller_process_spec);
  5226. owning_controller_process_spec = NULL;
  5227. }
  5228. tor_assert((owning_controller_process_spec == NULL) &&
  5229. (owning_controller_process_monitor == NULL));
  5230. if (process_spec == NULL)
  5231. return;
  5232. owning_controller_process_spec = tor_strdup(process_spec);
  5233. owning_controller_process_monitor =
  5234. tor_process_monitor_new(tor_libevent_get_base(),
  5235. owning_controller_process_spec,
  5236. LD_CONTROL,
  5237. owning_controller_procmon_cb, NULL,
  5238. &msg);
  5239. if (owning_controller_process_monitor == NULL) {
  5240. log_err(LD_BUG, "Couldn't create process-termination monitor for "
  5241. "owning controller: %s. Exiting.",
  5242. msg);
  5243. owning_controller_process_spec = NULL;
  5244. tor_cleanup();
  5245. exit(0);
  5246. }
  5247. }
  5248. /** Convert the name of a bootstrapping phase <b>s</b> into strings
  5249. * <b>tag</b> and <b>summary</b> suitable for display by the controller. */
  5250. static int
  5251. bootstrap_status_to_string(bootstrap_status_t s, const char **tag,
  5252. const char **summary)
  5253. {
  5254. switch (s) {
  5255. case BOOTSTRAP_STATUS_UNDEF:
  5256. *tag = "undef";
  5257. *summary = "Undefined";
  5258. break;
  5259. case BOOTSTRAP_STATUS_STARTING:
  5260. *tag = "starting";
  5261. *summary = "Starting";
  5262. break;
  5263. case BOOTSTRAP_STATUS_CONN_DIR:
  5264. *tag = "conn_dir";
  5265. *summary = "Connecting to directory server";
  5266. break;
  5267. case BOOTSTRAP_STATUS_HANDSHAKE:
  5268. *tag = "status_handshake";
  5269. *summary = "Finishing handshake";
  5270. break;
  5271. case BOOTSTRAP_STATUS_HANDSHAKE_DIR:
  5272. *tag = "handshake_dir";
  5273. *summary = "Finishing handshake with directory server";
  5274. break;
  5275. case BOOTSTRAP_STATUS_ONEHOP_CREATE:
  5276. *tag = "onehop_create";
  5277. *summary = "Establishing an encrypted directory connection";
  5278. break;
  5279. case BOOTSTRAP_STATUS_REQUESTING_STATUS:
  5280. *tag = "requesting_status";
  5281. *summary = "Asking for networkstatus consensus";
  5282. break;
  5283. case BOOTSTRAP_STATUS_LOADING_STATUS:
  5284. *tag = "loading_status";
  5285. *summary = "Loading networkstatus consensus";
  5286. break;
  5287. case BOOTSTRAP_STATUS_LOADING_KEYS:
  5288. *tag = "loading_keys";
  5289. *summary = "Loading authority key certs";
  5290. break;
  5291. case BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS:
  5292. *tag = "requesting_descriptors";
  5293. /* XXXX this appears to incorrectly report internal on most loads */
  5294. *summary = router_have_consensus_path() == CONSENSUS_PATH_INTERNAL ?
  5295. "Asking for relay descriptors for internal paths" :
  5296. "Asking for relay descriptors";
  5297. break;
  5298. /* If we're sure there are no exits in the consensus,
  5299. * inform the controller by adding "internal"
  5300. * to the status summaries.
  5301. * (We only check this while loading descriptors,
  5302. * so we may not know in the earlier stages.)
  5303. * But if there are exits, we can't be sure whether
  5304. * we're creating internal or exit paths/circuits.
  5305. * XXXX Or should be use different tags or statuses
  5306. * for internal and exit/all? */
  5307. case BOOTSTRAP_STATUS_LOADING_DESCRIPTORS:
  5308. *tag = "loading_descriptors";
  5309. *summary = router_have_consensus_path() == CONSENSUS_PATH_INTERNAL ?
  5310. "Loading relay descriptors for internal paths" :
  5311. "Loading relay descriptors";
  5312. break;
  5313. case BOOTSTRAP_STATUS_CONN_OR:
  5314. *tag = "conn_or";
  5315. *summary = router_have_consensus_path() == CONSENSUS_PATH_INTERNAL ?
  5316. "Connecting to the Tor network internally" :
  5317. "Connecting to the Tor network";
  5318. break;
  5319. case BOOTSTRAP_STATUS_HANDSHAKE_OR:
  5320. *tag = "handshake_or";
  5321. *summary = router_have_consensus_path() == CONSENSUS_PATH_INTERNAL ?
  5322. "Finishing handshake with first hop of internal circuit" :
  5323. "Finishing handshake with first hop";
  5324. break;
  5325. case BOOTSTRAP_STATUS_CIRCUIT_CREATE:
  5326. *tag = "circuit_create";
  5327. *summary = router_have_consensus_path() == CONSENSUS_PATH_INTERNAL ?
  5328. "Establishing an internal Tor circuit" :
  5329. "Establishing a Tor circuit";
  5330. break;
  5331. case BOOTSTRAP_STATUS_DONE:
  5332. *tag = "done";
  5333. *summary = "Done";
  5334. break;
  5335. default:
  5336. // log_warn(LD_BUG, "Unrecognized bootstrap status code %d", s);
  5337. *tag = *summary = "unknown";
  5338. return -1;
  5339. }
  5340. return 0;
  5341. }
  5342. /** What percentage through the bootstrap process are we? We remember
  5343. * this so we can avoid sending redundant bootstrap status events, and
  5344. * so we can guess context for the bootstrap messages which are
  5345. * ambiguous. It starts at 'undef', but gets set to 'starting' while
  5346. * Tor initializes. */
  5347. static int bootstrap_percent = BOOTSTRAP_STATUS_UNDEF;
  5348. /** As bootstrap_percent, but holds the bootstrapping level at which we last
  5349. * logged a NOTICE-level message. We use this, plus BOOTSTRAP_PCT_INCREMENT,
  5350. * to avoid flooding the log with a new message every time we get a few more
  5351. * microdescriptors */
  5352. static int notice_bootstrap_percent = 0;
  5353. /** How many problems have we had getting to the next bootstrapping phase?
  5354. * These include failure to establish a connection to a Tor relay,
  5355. * failures to finish the TLS handshake, failures to validate the
  5356. * consensus document, etc. */
  5357. static int bootstrap_problems = 0;
  5358. /** We only tell the controller once we've hit a threshold of problems
  5359. * for the current phase. */
  5360. #define BOOTSTRAP_PROBLEM_THRESHOLD 10
  5361. /** When our bootstrapping progress level changes, but our bootstrapping
  5362. * status has not advanced, we only log at NOTICE when we have made at least
  5363. * this much progress.
  5364. */
  5365. #define BOOTSTRAP_PCT_INCREMENT 5
  5366. /** Called when Tor has made progress at bootstrapping its directory
  5367. * information and initial circuits.
  5368. *
  5369. * <b>status</b> is the new status, that is, what task we will be doing
  5370. * next. <b>progress</b> is zero if we just started this task, else it
  5371. * represents progress on the task.
  5372. *
  5373. * Return true if we logged a message at level NOTICE, and false otherwise.
  5374. */
  5375. int
  5376. control_event_bootstrap(bootstrap_status_t status, int progress)
  5377. {
  5378. const char *tag, *summary;
  5379. char buf[BOOTSTRAP_MSG_LEN];
  5380. if (bootstrap_percent == BOOTSTRAP_STATUS_DONE)
  5381. return 0; /* already bootstrapped; nothing to be done here. */
  5382. /* special case for handshaking status, since our TLS handshaking code
  5383. * can't distinguish what the connection is going to be for. */
  5384. if (status == BOOTSTRAP_STATUS_HANDSHAKE) {
  5385. if (bootstrap_percent < BOOTSTRAP_STATUS_CONN_OR) {
  5386. status = BOOTSTRAP_STATUS_HANDSHAKE_DIR;
  5387. } else {
  5388. status = BOOTSTRAP_STATUS_HANDSHAKE_OR;
  5389. }
  5390. }
  5391. if (status > bootstrap_percent ||
  5392. (progress && progress > bootstrap_percent)) {
  5393. int loglevel = LOG_NOTICE;
  5394. bootstrap_status_to_string(status, &tag, &summary);
  5395. if (status <= bootstrap_percent &&
  5396. (progress < notice_bootstrap_percent + BOOTSTRAP_PCT_INCREMENT)) {
  5397. /* We log the message at info if the status hasn't advanced, and if less
  5398. * than BOOTSTRAP_PCT_INCREMENT progress has been made.
  5399. */
  5400. loglevel = LOG_INFO;
  5401. }
  5402. tor_log(loglevel, LD_CONTROL,
  5403. "Bootstrapped %d%%: %s", progress ? progress : status, summary);
  5404. tor_snprintf(buf, sizeof(buf),
  5405. "BOOTSTRAP PROGRESS=%d TAG=%s SUMMARY=\"%s\"",
  5406. progress ? progress : status, tag, summary);
  5407. tor_snprintf(last_sent_bootstrap_message,
  5408. sizeof(last_sent_bootstrap_message),
  5409. "NOTICE %s", buf);
  5410. control_event_client_status(LOG_NOTICE, "%s", buf);
  5411. if (status > bootstrap_percent) {
  5412. bootstrap_percent = status; /* new milestone reached */
  5413. }
  5414. if (progress > bootstrap_percent) {
  5415. /* incremental progress within a milestone */
  5416. bootstrap_percent = progress;
  5417. bootstrap_problems = 0; /* Progress! Reset our problem counter. */
  5418. }
  5419. if (loglevel == LOG_NOTICE &&
  5420. bootstrap_percent > notice_bootstrap_percent) {
  5421. /* Remember that we gave a notice at this level. */
  5422. notice_bootstrap_percent = bootstrap_percent;
  5423. }
  5424. return loglevel == LOG_NOTICE;
  5425. }
  5426. return 0;
  5427. }
  5428. /** Called when Tor has failed to make bootstrapping progress in a way
  5429. * that indicates a problem. <b>warn</b> gives a hint as to why, and
  5430. * <b>reason</b> provides an "or_conn_end_reason" tag. <b>or_conn</b>
  5431. * is the connection that caused this problem.
  5432. */
  5433. MOCK_IMPL(void,
  5434. control_event_bootstrap_problem, (const char *warn, int reason,
  5435. or_connection_t *or_conn))
  5436. {
  5437. int status = bootstrap_percent;
  5438. const char *tag = "", *summary = "";
  5439. char buf[BOOTSTRAP_MSG_LEN];
  5440. const char *recommendation = "ignore";
  5441. int severity;
  5442. /* bootstrap_percent must not be in "undefined" state here. */
  5443. tor_assert(status >= 0);
  5444. if (or_conn->have_noted_bootstrap_problem)
  5445. return;
  5446. or_conn->have_noted_bootstrap_problem = 1;
  5447. if (bootstrap_percent == 100)
  5448. return; /* already bootstrapped; nothing to be done here. */
  5449. bootstrap_problems++;
  5450. if (bootstrap_problems >= BOOTSTRAP_PROBLEM_THRESHOLD)
  5451. recommendation = "warn";
  5452. if (reason == END_OR_CONN_REASON_NO_ROUTE)
  5453. recommendation = "warn";
  5454. /* If we are using bridges and all our OR connections are now
  5455. closed, it means that we totally failed to connect to our
  5456. bridges. Throw a warning. */
  5457. if (get_options()->UseBridges && !any_other_active_or_conns(or_conn))
  5458. recommendation = "warn";
  5459. if (we_are_hibernating())
  5460. recommendation = "ignore";
  5461. while (status>=0 && bootstrap_status_to_string(status, &tag, &summary) < 0)
  5462. status--; /* find a recognized status string based on current progress */
  5463. status = bootstrap_percent; /* set status back to the actual number */
  5464. severity = !strcmp(recommendation, "warn") ? LOG_WARN : LOG_INFO;
  5465. log_fn(severity,
  5466. LD_CONTROL, "Problem bootstrapping. Stuck at %d%%: %s. (%s; %s; "
  5467. "count %d; recommendation %s; host %s at %s:%d)",
  5468. status, summary, warn,
  5469. orconn_end_reason_to_control_string(reason),
  5470. bootstrap_problems, recommendation,
  5471. hex_str(or_conn->identity_digest, DIGEST_LEN),
  5472. or_conn->base_.address,
  5473. or_conn->base_.port);
  5474. connection_or_report_broken_states(severity, LD_HANDSHAKE);
  5475. tor_snprintf(buf, sizeof(buf),
  5476. "BOOTSTRAP PROGRESS=%d TAG=%s SUMMARY=\"%s\" WARNING=\"%s\" REASON=%s "
  5477. "COUNT=%d RECOMMENDATION=%s HOSTID=\"%s\" HOSTADDR=\"%s:%d\"",
  5478. bootstrap_percent, tag, summary, warn,
  5479. orconn_end_reason_to_control_string(reason), bootstrap_problems,
  5480. recommendation,
  5481. hex_str(or_conn->identity_digest, DIGEST_LEN),
  5482. or_conn->base_.address,
  5483. (int)or_conn->base_.port);
  5484. tor_snprintf(last_sent_bootstrap_message,
  5485. sizeof(last_sent_bootstrap_message),
  5486. "WARN %s", buf);
  5487. control_event_client_status(LOG_WARN, "%s", buf);
  5488. }
  5489. /** We just generated a new summary of which countries we've seen clients
  5490. * from recently. Send a copy to the controller in case it wants to
  5491. * display it for the user. */
  5492. void
  5493. control_event_clients_seen(const char *controller_str)
  5494. {
  5495. send_control_event(EVENT_CLIENTS_SEEN, 0,
  5496. "650 CLIENTS_SEEN %s\r\n", controller_str);
  5497. }
  5498. /** A new pluggable transport called <b>transport_name</b> was
  5499. * launched on <b>addr</b>:<b>port</b>. <b>mode</b> is either
  5500. * "server" or "client" depending on the mode of the pluggable
  5501. * transport.
  5502. * "650" SP "TRANSPORT_LAUNCHED" SP Mode SP Name SP Address SP Port
  5503. */
  5504. void
  5505. control_event_transport_launched(const char *mode, const char *transport_name,
  5506. tor_addr_t *addr, uint16_t port)
  5507. {
  5508. send_control_event(EVENT_TRANSPORT_LAUNCHED, ALL_FORMATS,
  5509. "650 TRANSPORT_LAUNCHED %s %s %s %u\r\n",
  5510. mode, transport_name, fmt_addr(addr), port);
  5511. }
  5512. /** Convert rendezvous auth type to string for HS_DESC control events
  5513. */
  5514. const char *
  5515. rend_auth_type_to_string(rend_auth_type_t auth_type)
  5516. {
  5517. const char *str;
  5518. switch (auth_type) {
  5519. case REND_NO_AUTH:
  5520. str = "NO_AUTH";
  5521. break;
  5522. case REND_BASIC_AUTH:
  5523. str = "BASIC_AUTH";
  5524. break;
  5525. case REND_STEALTH_AUTH:
  5526. str = "STEALTH_AUTH";
  5527. break;
  5528. default:
  5529. str = "UNKNOWN";
  5530. }
  5531. return str;
  5532. }
  5533. /** Return a longname the node whose identity is <b>id_digest</b>. If
  5534. * node_get_by_id() returns NULL, base 16 encoding of <b>id_digest</b> is
  5535. * returned instead.
  5536. *
  5537. * This function is not thread-safe. Each call to this function invalidates
  5538. * previous values returned by this function.
  5539. */
  5540. MOCK_IMPL(const char *,
  5541. node_describe_longname_by_id,(const char *id_digest))
  5542. {
  5543. static char longname[MAX_VERBOSE_NICKNAME_LEN+1];
  5544. node_get_verbose_nickname_by_id(id_digest, longname);
  5545. return longname;
  5546. }
  5547. /** Return either the onion address if the given pointer is a non empty
  5548. * string else the unknown string. */
  5549. static const char *
  5550. rend_hsaddress_str_or_unknown(const char *onion_address)
  5551. {
  5552. static const char *str_unknown = "UNKNOWN";
  5553. const char *str_ret = str_unknown;
  5554. /* No valid pointer, unknown it is. */
  5555. if (!onion_address) {
  5556. goto end;
  5557. }
  5558. /* Empty onion address thus we don't know, unknown it is. */
  5559. if (onion_address[0] == '\0') {
  5560. goto end;
  5561. }
  5562. /* All checks are good so return the given onion address. */
  5563. str_ret = onion_address;
  5564. end:
  5565. return str_ret;
  5566. }
  5567. /** send HS_DESC requested event.
  5568. *
  5569. * <b>rend_query</b> is used to fetch requested onion address and auth type.
  5570. * <b>hs_dir</b> is the description of contacting hs directory.
  5571. * <b>desc_id_base32</b> is the ID of requested hs descriptor.
  5572. */
  5573. void
  5574. control_event_hs_descriptor_requested(const rend_data_t *rend_query,
  5575. const char *id_digest,
  5576. const char *desc_id_base32)
  5577. {
  5578. if (!id_digest || !rend_query || !desc_id_base32) {
  5579. log_warn(LD_BUG, "Called with rend_query==%p, "
  5580. "id_digest==%p, desc_id_base32==%p",
  5581. rend_query, id_digest, desc_id_base32);
  5582. return;
  5583. }
  5584. send_control_event(EVENT_HS_DESC, ALL_FORMATS,
  5585. "650 HS_DESC REQUESTED %s %s %s %s\r\n",
  5586. rend_hsaddress_str_or_unknown(rend_query->onion_address),
  5587. rend_auth_type_to_string(rend_query->auth_type),
  5588. node_describe_longname_by_id(id_digest),
  5589. desc_id_base32);
  5590. }
  5591. /** For an HS descriptor query <b>rend_data</b>, using the
  5592. * <b>onion_address</b> and HSDir fingerprint <b>hsdir_fp</b>, find out
  5593. * which descriptor ID in the query is the right one.
  5594. *
  5595. * Return a pointer of the binary descriptor ID found in the query's object
  5596. * or NULL if not found. */
  5597. static const char *
  5598. get_desc_id_from_query(const rend_data_t *rend_data, const char *hsdir_fp)
  5599. {
  5600. int replica;
  5601. const char *desc_id = NULL;
  5602. /* Possible if the fetch was done using a descriptor ID. This means that
  5603. * the HSFETCH command was used. */
  5604. if (!tor_digest_is_zero(rend_data->desc_id_fetch)) {
  5605. desc_id = rend_data->desc_id_fetch;
  5606. goto end;
  5607. }
  5608. /* OK, we have an onion address so now let's find which descriptor ID
  5609. * is the one associated with the HSDir fingerprint. */
  5610. for (replica = 0; replica < REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS;
  5611. replica++) {
  5612. const char *digest = rend_data->descriptor_id[replica];
  5613. SMARTLIST_FOREACH_BEGIN(rend_data->hsdirs_fp, char *, fingerprint) {
  5614. if (tor_memcmp(fingerprint, hsdir_fp, DIGEST_LEN) == 0) {
  5615. /* Found it! This descriptor ID is the right one. */
  5616. desc_id = digest;
  5617. goto end;
  5618. }
  5619. } SMARTLIST_FOREACH_END(fingerprint);
  5620. }
  5621. end:
  5622. return desc_id;
  5623. }
  5624. /** send HS_DESC upload event.
  5625. *
  5626. * <b>service_id</b> is the descriptor onion address.
  5627. * <b>hs_dir</b> is the description of contacting hs directory.
  5628. * <b>desc_id_base32</b> is the ID of requested hs descriptor.
  5629. */
  5630. void
  5631. control_event_hs_descriptor_upload(const char *service_id,
  5632. const char *id_digest,
  5633. const char *desc_id_base32)
  5634. {
  5635. if (!service_id || !id_digest || !desc_id_base32) {
  5636. log_warn(LD_BUG, "Called with service_digest==%p, "
  5637. "desc_id_base32==%p, id_digest==%p", service_id,
  5638. desc_id_base32, id_digest);
  5639. return;
  5640. }
  5641. send_control_event(EVENT_HS_DESC, ALL_FORMATS,
  5642. "650 HS_DESC UPLOAD %s UNKNOWN %s %s\r\n",
  5643. service_id,
  5644. node_describe_longname_by_id(id_digest),
  5645. desc_id_base32);
  5646. }
  5647. /** send HS_DESC event after got response from hs directory.
  5648. *
  5649. * NOTE: this is an internal function used by following functions:
  5650. * control_event_hs_descriptor_received
  5651. * control_event_hs_descriptor_failed
  5652. *
  5653. * So do not call this function directly.
  5654. */
  5655. void
  5656. control_event_hs_descriptor_receive_end(const char *action,
  5657. const char *onion_address,
  5658. const rend_data_t *rend_data,
  5659. const char *id_digest,
  5660. const char *reason)
  5661. {
  5662. char *desc_id_field = NULL;
  5663. char *reason_field = NULL;
  5664. char desc_id_base32[REND_DESC_ID_V2_LEN_BASE32 + 1];
  5665. const char *desc_id = NULL;
  5666. if (!action || !id_digest || !rend_data || !onion_address) {
  5667. log_warn(LD_BUG, "Called with action==%p, id_digest==%p, "
  5668. "rend_data==%p, onion_address==%p", action, id_digest,
  5669. rend_data, onion_address);
  5670. return;
  5671. }
  5672. desc_id = get_desc_id_from_query(rend_data, id_digest);
  5673. if (desc_id != NULL) {
  5674. /* Set the descriptor ID digest to base32 so we can send it. */
  5675. base32_encode(desc_id_base32, sizeof(desc_id_base32), desc_id,
  5676. DIGEST_LEN);
  5677. /* Extra whitespace is needed before the value. */
  5678. tor_asprintf(&desc_id_field, " %s", desc_id_base32);
  5679. }
  5680. if (reason) {
  5681. tor_asprintf(&reason_field, " REASON=%s", reason);
  5682. }
  5683. send_control_event(EVENT_HS_DESC, ALL_FORMATS,
  5684. "650 HS_DESC %s %s %s %s%s%s\r\n",
  5685. action,
  5686. rend_hsaddress_str_or_unknown(onion_address),
  5687. rend_auth_type_to_string(rend_data->auth_type),
  5688. node_describe_longname_by_id(id_digest),
  5689. desc_id_field ? desc_id_field : "",
  5690. reason_field ? reason_field : "");
  5691. tor_free(desc_id_field);
  5692. tor_free(reason_field);
  5693. }
  5694. /** send HS_DESC event after got response from hs directory.
  5695. *
  5696. * NOTE: this is an internal function used by following functions:
  5697. * control_event_hs_descriptor_uploaded
  5698. * control_event_hs_descriptor_upload_failed
  5699. *
  5700. * So do not call this function directly.
  5701. */
  5702. void
  5703. control_event_hs_descriptor_upload_end(const char *action,
  5704. const char *id_digest,
  5705. const char *reason)
  5706. {
  5707. char *reason_field = NULL;
  5708. if (!action || !id_digest) {
  5709. log_warn(LD_BUG, "Called with action==%p, id_digest==%p", action,
  5710. id_digest);
  5711. return;
  5712. }
  5713. if (reason) {
  5714. tor_asprintf(&reason_field, " REASON=%s", reason);
  5715. }
  5716. send_control_event(EVENT_HS_DESC, ALL_FORMATS,
  5717. "650 HS_DESC %s UNKNOWN UNKNOWN %s%s\r\n",
  5718. action,
  5719. node_describe_longname_by_id(id_digest),
  5720. reason_field ? reason_field : "");
  5721. tor_free(reason_field);
  5722. }
  5723. /** send HS_DESC RECEIVED event
  5724. *
  5725. * called when we successfully received a hidden service descriptor.
  5726. */
  5727. void
  5728. control_event_hs_descriptor_received(const char *onion_address,
  5729. const rend_data_t *rend_data,
  5730. const char *id_digest)
  5731. {
  5732. if (!rend_data || !id_digest || !onion_address) {
  5733. log_warn(LD_BUG, "Called with rend_data==%p, id_digest==%p, "
  5734. "onion_address==%p", rend_data, id_digest, onion_address);
  5735. return;
  5736. }
  5737. control_event_hs_descriptor_receive_end("RECEIVED", onion_address,
  5738. rend_data, id_digest, NULL);
  5739. }
  5740. /** send HS_DESC UPLOADED event
  5741. *
  5742. * called when we successfully uploaded a hidden service descriptor.
  5743. */
  5744. void
  5745. control_event_hs_descriptor_uploaded(const char *id_digest)
  5746. {
  5747. if (!id_digest) {
  5748. log_warn(LD_BUG, "Called with id_digest==%p",
  5749. id_digest);
  5750. return;
  5751. }
  5752. control_event_hs_descriptor_upload_end("UPLOADED", id_digest, NULL);
  5753. }
  5754. /** Send HS_DESC event to inform controller that query <b>rend_query</b>
  5755. * failed to retrieve hidden service descriptor identified by
  5756. * <b>id_digest</b>. If <b>reason</b> is not NULL, add it to REASON=
  5757. * field.
  5758. */
  5759. void
  5760. control_event_hs_descriptor_failed(const rend_data_t *rend_data,
  5761. const char *id_digest,
  5762. const char *reason)
  5763. {
  5764. if (!rend_data || !id_digest) {
  5765. log_warn(LD_BUG, "Called with rend_data==%p, id_digest==%p",
  5766. rend_data, id_digest);
  5767. return;
  5768. }
  5769. control_event_hs_descriptor_receive_end("FAILED",
  5770. rend_data->onion_address,
  5771. rend_data, id_digest, reason);
  5772. }
  5773. /** send HS_DESC_CONTENT event after completion of a successful fetch from
  5774. * hs directory. */
  5775. void
  5776. control_event_hs_descriptor_content(const char *onion_address,
  5777. const char *desc_id,
  5778. const char *hsdir_id_digest,
  5779. const char *content)
  5780. {
  5781. static const char *event_name = "HS_DESC_CONTENT";
  5782. char *esc_content = NULL;
  5783. if (!onion_address || !desc_id || !hsdir_id_digest) {
  5784. log_warn(LD_BUG, "Called with onion_address==%p, desc_id==%p, "
  5785. "hsdir_id_digest==%p", onion_address, desc_id, hsdir_id_digest);
  5786. return;
  5787. }
  5788. if (content == NULL) {
  5789. /* Point it to empty content so it can still be escaped. */
  5790. content = "";
  5791. }
  5792. write_escaped_data(content, strlen(content), &esc_content);
  5793. send_control_event(EVENT_HS_DESC_CONTENT, ALL_FORMATS,
  5794. "650+%s %s %s %s\r\n%s650 OK\r\n",
  5795. event_name,
  5796. rend_hsaddress_str_or_unknown(onion_address),
  5797. desc_id,
  5798. node_describe_longname_by_id(hsdir_id_digest),
  5799. esc_content);
  5800. tor_free(esc_content);
  5801. }
  5802. /** Send HS_DESC event to inform controller upload of hidden service
  5803. * descriptor identified by <b>id_digest</b> failed. If <b>reason</b>
  5804. * is not NULL, add it to REASON= field.
  5805. */
  5806. void
  5807. control_event_hs_descriptor_upload_failed(const char *id_digest,
  5808. const char *reason)
  5809. {
  5810. if (!id_digest) {
  5811. log_warn(LD_BUG, "Called with id_digest==%p",
  5812. id_digest);
  5813. return;
  5814. }
  5815. control_event_hs_descriptor_upload_end("UPLOAD_FAILED",
  5816. id_digest, reason);
  5817. }
  5818. /** Free any leftover allocated memory of the control.c subsystem. */
  5819. void
  5820. control_free_all(void)
  5821. {
  5822. if (authentication_cookie) /* Free the auth cookie */
  5823. tor_free(authentication_cookie);
  5824. if (detached_onion_services) { /* Free the detached onion services */
  5825. SMARTLIST_FOREACH(detached_onion_services, char *, cp, tor_free(cp));
  5826. smartlist_free(detached_onion_services);
  5827. }
  5828. if (queued_control_events) {
  5829. SMARTLIST_FOREACH(queued_control_events, queued_event_t *, ev,
  5830. queued_event_free(ev));
  5831. smartlist_free(queued_control_events);
  5832. queued_control_events = NULL;
  5833. }
  5834. if (flush_queued_events_event) {
  5835. tor_event_free(flush_queued_events_event);
  5836. flush_queued_events_event = NULL;
  5837. }
  5838. }
  5839. #ifdef TOR_UNIT_TESTS
  5840. /* For testing: change the value of global_event_mask */
  5841. void
  5842. control_testing_set_global_event_mask(uint64_t mask)
  5843. {
  5844. global_event_mask = mask;
  5845. }
  5846. #endif