or.h 228 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589
  1. /* Copyright (c) 2001 Matej Pfajfar.
  2. * Copyright (c) 2001-2004, Roger Dingledine.
  3. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4. * Copyright (c) 2007-2017, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file or.h
  8. * \brief Master header file for Tor-specific functionality.
  9. **/
  10. #ifndef TOR_OR_H
  11. #define TOR_OR_H
  12. #include "orconfig.h"
  13. #ifdef HAVE_UNISTD_H
  14. #include <unistd.h>
  15. #endif
  16. #ifdef HAVE_SIGNAL_H
  17. #include <signal.h>
  18. #endif
  19. #ifdef HAVE_NETDB_H
  20. #include <netdb.h>
  21. #endif
  22. #ifdef HAVE_SYS_PARAM_H
  23. #include <sys/param.h> /* FreeBSD needs this to know what version it is */
  24. #endif
  25. #include "torint.h"
  26. #ifdef HAVE_SYS_FCNTL_H
  27. #include <sys/fcntl.h>
  28. #endif
  29. #ifdef HAVE_FCNTL_H
  30. #include <fcntl.h>
  31. #endif
  32. #ifdef HAVE_SYS_IOCTL_H
  33. #include <sys/ioctl.h>
  34. #endif
  35. #ifdef HAVE_SYS_UN_H
  36. #include <sys/un.h>
  37. #endif
  38. #ifdef HAVE_SYS_STAT_H
  39. #include <sys/stat.h>
  40. #endif
  41. #ifdef HAVE_NETINET_IN_H
  42. #include <netinet/in.h>
  43. #endif
  44. #ifdef HAVE_ARPA_INET_H
  45. #include <arpa/inet.h>
  46. #endif
  47. #ifdef HAVE_ERRNO_H
  48. #include <errno.h>
  49. #endif
  50. #ifdef HAVE_ASSERT_H
  51. #include <assert.h>
  52. #endif
  53. #ifdef HAVE_TIME_H
  54. #include <time.h>
  55. #endif
  56. #ifdef _WIN32
  57. #include <winsock2.h>
  58. #include <io.h>
  59. #include <process.h>
  60. #include <direct.h>
  61. #include <windows.h>
  62. #endif /* defined(_WIN32) */
  63. #include "crypto.h"
  64. #include "crypto_format.h"
  65. #include "tortls.h"
  66. #include "torlog.h"
  67. #include "container.h"
  68. #include "compress.h"
  69. #include "address.h"
  70. #include "compat_libevent.h"
  71. #include "ht.h"
  72. #include "confline.h"
  73. #include "replaycache.h"
  74. #include "crypto_curve25519.h"
  75. #include "crypto_ed25519.h"
  76. #include "tor_queue.h"
  77. #include "util_format.h"
  78. #include "hs_circuitmap.h"
  79. /* These signals are defined to help handle_control_signal work.
  80. */
  81. #ifndef SIGHUP
  82. #define SIGHUP 1
  83. #endif
  84. #ifndef SIGINT
  85. #define SIGINT 2
  86. #endif
  87. #ifndef SIGUSR1
  88. #define SIGUSR1 10
  89. #endif
  90. #ifndef SIGUSR2
  91. #define SIGUSR2 12
  92. #endif
  93. #ifndef SIGTERM
  94. #define SIGTERM 15
  95. #endif
  96. /* Controller signals start at a high number so we don't
  97. * conflict with system-defined signals. */
  98. #define SIGNEWNYM 129
  99. #define SIGCLEARDNSCACHE 130
  100. #define SIGHEARTBEAT 131
  101. #if (SIZEOF_CELL_T != 0)
  102. /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
  103. * that our stuff always calls cell_t something different. */
  104. #define cell_t tor_cell_t
  105. #endif
  106. #ifdef ENABLE_TOR2WEB_MODE
  107. #define NON_ANONYMOUS_MODE_ENABLED 1
  108. #endif
  109. /** Helper macro: Given a pointer to to.base_, of type from*, return &to. */
  110. #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, base_))
  111. /** Length of longest allowable configured nickname. */
  112. #define MAX_NICKNAME_LEN 19
  113. /** Length of a router identity encoded as a hexadecimal digest, plus
  114. * possible dollar sign. */
  115. #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
  116. /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
  117. * equal sign or tilde, nickname. */
  118. #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
  119. /** Maximum size, in bytes, for resized buffers. */
  120. #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
  121. /** Maximum size, in bytes, for any directory object that we've downloaded. */
  122. #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
  123. /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
  124. * of an HTTP request or response. */
  125. #define MAX_HEADERS_SIZE 50000
  126. /** Maximum size, in bytes, for any directory object that we're accepting
  127. * as an upload. */
  128. #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
  129. /** Maximum size, in bytes, of a single router descriptor uploaded to us
  130. * as a directory authority. Caches and clients fetch whatever descriptors
  131. * the authorities tell them to fetch, and don't care about size. */
  132. #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
  133. /** Maximum size of a single extrainfo document, as above. */
  134. #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
  135. /** Minimum lifetime for an onion key in days. */
  136. #define MIN_ONION_KEY_LIFETIME_DAYS (1)
  137. /** Maximum lifetime for an onion key in days. */
  138. #define MAX_ONION_KEY_LIFETIME_DAYS (90)
  139. /** Default lifetime for an onion key in days. */
  140. #define DEFAULT_ONION_KEY_LIFETIME_DAYS (28)
  141. /** Minimum grace period for acceptance of an onion key in days.
  142. * The maximum value is defined in proposal #274 as being the current network
  143. * consensus parameter for "onion-key-rotation-days". */
  144. #define MIN_ONION_KEY_GRACE_PERIOD_DAYS (1)
  145. /** Default grace period for acceptance of an onion key in days. */
  146. #define DEFAULT_ONION_KEY_GRACE_PERIOD_DAYS (7)
  147. /** How often we should check the network consensus if it is time to rotate or
  148. * expire onion keys. */
  149. #define ONION_KEY_CONSENSUS_CHECK_INTERVAL (60*60)
  150. /** How often do we rotate TLS contexts? */
  151. #define MAX_SSL_KEY_LIFETIME_INTERNAL (2*60*60)
  152. /** How old do we allow a router to get before removing it
  153. * from the router list? In seconds. */
  154. #define ROUTER_MAX_AGE (60*60*48)
  155. /** How old can a router get before we (as a server) will no longer
  156. * consider it live? In seconds. */
  157. #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*24)
  158. /** How old do we let a saved descriptor get before force-removing it? */
  159. #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
  160. /** Possible rules for generating circuit IDs on an OR connection. */
  161. typedef enum {
  162. CIRC_ID_TYPE_LOWER=0, /**< Pick from 0..1<<15-1. */
  163. CIRC_ID_TYPE_HIGHER=1, /**< Pick from 1<<15..1<<16-1. */
  164. /** The other side of a connection is an OP: never create circuits to it,
  165. * and let it use any circuit ID it wants. */
  166. CIRC_ID_TYPE_NEITHER=2
  167. } circ_id_type_t;
  168. #define circ_id_type_bitfield_t ENUM_BF(circ_id_type_t)
  169. #define CONN_TYPE_MIN_ 3
  170. /** Type for sockets listening for OR connections. */
  171. #define CONN_TYPE_OR_LISTENER 3
  172. /** A bidirectional TLS connection transmitting a sequence of cells.
  173. * May be from an OR to an OR, or from an OP to an OR. */
  174. #define CONN_TYPE_OR 4
  175. /** A TCP connection from an onion router to a stream's destination. */
  176. #define CONN_TYPE_EXIT 5
  177. /** Type for sockets listening for SOCKS connections. */
  178. #define CONN_TYPE_AP_LISTENER 6
  179. /** A SOCKS proxy connection from the user application to the onion
  180. * proxy. */
  181. #define CONN_TYPE_AP 7
  182. /** Type for sockets listening for HTTP connections to the directory server. */
  183. #define CONN_TYPE_DIR_LISTENER 8
  184. /** Type for HTTP connections to the directory server. */
  185. #define CONN_TYPE_DIR 9
  186. /* Type 10 is unused. */
  187. /** Type for listening for connections from user interface process. */
  188. #define CONN_TYPE_CONTROL_LISTENER 11
  189. /** Type for connections from user interface process. */
  190. #define CONN_TYPE_CONTROL 12
  191. /** Type for sockets listening for transparent connections redirected by pf or
  192. * netfilter. */
  193. #define CONN_TYPE_AP_TRANS_LISTENER 13
  194. /** Type for sockets listening for transparent connections redirected by
  195. * natd. */
  196. #define CONN_TYPE_AP_NATD_LISTENER 14
  197. /** Type for sockets listening for DNS requests. */
  198. #define CONN_TYPE_AP_DNS_LISTENER 15
  199. /** Type for connections from the Extended ORPort. */
  200. #define CONN_TYPE_EXT_OR 16
  201. /** Type for sockets listening for Extended ORPort connections. */
  202. #define CONN_TYPE_EXT_OR_LISTENER 17
  203. /** Type for sockets listening for HTTP CONNECT tunnel connections. */
  204. #define CONN_TYPE_AP_HTTP_CONNECT_LISTENER 18
  205. #define CONN_TYPE_MAX_ 19
  206. /* !!!! If _CONN_TYPE_MAX is ever over 31, we must grow the type field in
  207. * connection_t. */
  208. /* Proxy client types */
  209. #define PROXY_NONE 0
  210. #define PROXY_CONNECT 1
  211. #define PROXY_SOCKS4 2
  212. #define PROXY_SOCKS5 3
  213. /* !!!! If there is ever a PROXY_* type over 3, we must grow the proxy_type
  214. * field in or_connection_t */
  215. /* Pluggable transport proxy type. Don't use this in or_connection_t,
  216. * instead use the actual underlying proxy type (see above). */
  217. #define PROXY_PLUGGABLE 4
  218. /* Proxy client handshake states */
  219. /* We use a proxy but we haven't even connected to it yet. */
  220. #define PROXY_INFANT 1
  221. /* We use an HTTP proxy and we've sent the CONNECT command. */
  222. #define PROXY_HTTPS_WANT_CONNECT_OK 2
  223. /* We use a SOCKS4 proxy and we've sent the CONNECT command. */
  224. #define PROXY_SOCKS4_WANT_CONNECT_OK 3
  225. /* We use a SOCKS5 proxy and we try to negotiate without
  226. any authentication . */
  227. #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 4
  228. /* We use a SOCKS5 proxy and we try to negotiate with
  229. Username/Password authentication . */
  230. #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 5
  231. /* We use a SOCKS5 proxy and we just sent our credentials. */
  232. #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 6
  233. /* We use a SOCKS5 proxy and we just sent our CONNECT command. */
  234. #define PROXY_SOCKS5_WANT_CONNECT_OK 7
  235. /* We use a proxy and we CONNECTed successfully!. */
  236. #define PROXY_CONNECTED 8
  237. /** True iff <b>x</b> is an edge connection. */
  238. #define CONN_IS_EDGE(x) \
  239. ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
  240. /** State for any listener connection. */
  241. #define LISTENER_STATE_READY 0
  242. #define OR_CONN_STATE_MIN_ 1
  243. /** State for a connection to an OR: waiting for connect() to finish. */
  244. #define OR_CONN_STATE_CONNECTING 1
  245. /** State for a connection to an OR: waiting for proxy handshake to complete */
  246. #define OR_CONN_STATE_PROXY_HANDSHAKING 2
  247. /** State for an OR connection client: SSL is handshaking, not done
  248. * yet. */
  249. #define OR_CONN_STATE_TLS_HANDSHAKING 3
  250. /** State for a connection to an OR: We're doing a second SSL handshake for
  251. * renegotiation purposes. (V2 handshake only.) */
  252. #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
  253. /** State for a connection at an OR: We're waiting for the client to
  254. * renegotiate (to indicate a v2 handshake) or send a versions cell (to
  255. * indicate a v3 handshake) */
  256. #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
  257. /** State for an OR connection: We're done with our SSL handshake, we've done
  258. * renegotiation, but we haven't yet negotiated link protocol versions and
  259. * sent a netinfo cell. */
  260. #define OR_CONN_STATE_OR_HANDSHAKING_V2 6
  261. /** State for an OR connection: We're done with our SSL handshake, but we
  262. * haven't yet negotiated link protocol versions, done a V3 handshake, and
  263. * sent a netinfo cell. */
  264. #define OR_CONN_STATE_OR_HANDSHAKING_V3 7
  265. /** State for an OR connection: Ready to send/receive cells. */
  266. #define OR_CONN_STATE_OPEN 8
  267. #define OR_CONN_STATE_MAX_ 8
  268. /** States of the Extended ORPort protocol. Be careful before changing
  269. * the numbers: they matter. */
  270. #define EXT_OR_CONN_STATE_MIN_ 1
  271. /** Extended ORPort authentication is waiting for the authentication
  272. * type selected by the client. */
  273. #define EXT_OR_CONN_STATE_AUTH_WAIT_AUTH_TYPE 1
  274. /** Extended ORPort authentication is waiting for the client nonce. */
  275. #define EXT_OR_CONN_STATE_AUTH_WAIT_CLIENT_NONCE 2
  276. /** Extended ORPort authentication is waiting for the client hash. */
  277. #define EXT_OR_CONN_STATE_AUTH_WAIT_CLIENT_HASH 3
  278. #define EXT_OR_CONN_STATE_AUTH_MAX 3
  279. /** Authentication finished and the Extended ORPort is now accepting
  280. * traffic. */
  281. #define EXT_OR_CONN_STATE_OPEN 4
  282. /** Extended ORPort is flushing its last messages and preparing to
  283. * start accepting OR connections. */
  284. #define EXT_OR_CONN_STATE_FLUSHING 5
  285. #define EXT_OR_CONN_STATE_MAX_ 5
  286. #define EXIT_CONN_STATE_MIN_ 1
  287. /** State for an exit connection: waiting for response from DNS farm. */
  288. #define EXIT_CONN_STATE_RESOLVING 1
  289. /** State for an exit connection: waiting for connect() to finish. */
  290. #define EXIT_CONN_STATE_CONNECTING 2
  291. /** State for an exit connection: open and ready to transmit data. */
  292. #define EXIT_CONN_STATE_OPEN 3
  293. /** State for an exit connection: waiting to be removed. */
  294. #define EXIT_CONN_STATE_RESOLVEFAILED 4
  295. #define EXIT_CONN_STATE_MAX_ 4
  296. /* The AP state values must be disjoint from the EXIT state values. */
  297. #define AP_CONN_STATE_MIN_ 5
  298. /** State for a SOCKS connection: waiting for SOCKS request. */
  299. #define AP_CONN_STATE_SOCKS_WAIT 5
  300. /** State for a SOCKS connection: got a y.onion URL; waiting to receive
  301. * rendezvous descriptor. */
  302. #define AP_CONN_STATE_RENDDESC_WAIT 6
  303. /** The controller will attach this connection to a circuit; it isn't our
  304. * job to do so. */
  305. #define AP_CONN_STATE_CONTROLLER_WAIT 7
  306. /** State for a SOCKS connection: waiting for a completed circuit. */
  307. #define AP_CONN_STATE_CIRCUIT_WAIT 8
  308. /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
  309. #define AP_CONN_STATE_CONNECT_WAIT 9
  310. /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
  311. #define AP_CONN_STATE_RESOLVE_WAIT 10
  312. /** State for a SOCKS connection: ready to send and receive. */
  313. #define AP_CONN_STATE_OPEN 11
  314. /** State for a transparent natd connection: waiting for original
  315. * destination. */
  316. #define AP_CONN_STATE_NATD_WAIT 12
  317. /** State for an HTTP tunnel: waiting for an HTTP CONNECT command. */
  318. #define AP_CONN_STATE_HTTP_CONNECT_WAIT 13
  319. #define AP_CONN_STATE_MAX_ 13
  320. /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
  321. * edge connection is not attached to any circuit. */
  322. #define AP_CONN_STATE_IS_UNATTACHED(s) \
  323. ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
  324. #define DIR_CONN_STATE_MIN_ 1
  325. /** State for connection to directory server: waiting for connect(). */
  326. #define DIR_CONN_STATE_CONNECTING 1
  327. /** State for connection to directory server: sending HTTP request. */
  328. #define DIR_CONN_STATE_CLIENT_SENDING 2
  329. /** State for connection to directory server: reading HTTP response. */
  330. #define DIR_CONN_STATE_CLIENT_READING 3
  331. /** State for connection to directory server: happy and finished. */
  332. #define DIR_CONN_STATE_CLIENT_FINISHED 4
  333. /** State for connection at directory server: waiting for HTTP request. */
  334. #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
  335. /** State for connection at directory server: sending HTTP response. */
  336. #define DIR_CONN_STATE_SERVER_WRITING 6
  337. #define DIR_CONN_STATE_MAX_ 6
  338. /** True iff the purpose of <b>conn</b> means that it's a server-side
  339. * directory connection. */
  340. #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
  341. #define CONTROL_CONN_STATE_MIN_ 1
  342. /** State for a control connection: Authenticated and accepting v1 commands. */
  343. #define CONTROL_CONN_STATE_OPEN 1
  344. /** State for a control connection: Waiting for authentication; speaking
  345. * protocol v1. */
  346. #define CONTROL_CONN_STATE_NEEDAUTH 2
  347. #define CONTROL_CONN_STATE_MAX_ 2
  348. #define DIR_PURPOSE_MIN_ 4
  349. /** A connection to a directory server: set after a v2 rendezvous
  350. * descriptor is downloaded. */
  351. #define DIR_PURPOSE_HAS_FETCHED_RENDDESC_V2 4
  352. /** A connection to a directory server: download one or more server
  353. * descriptors. */
  354. #define DIR_PURPOSE_FETCH_SERVERDESC 6
  355. /** A connection to a directory server: download one or more extra-info
  356. * documents. */
  357. #define DIR_PURPOSE_FETCH_EXTRAINFO 7
  358. /** A connection to a directory server: upload a server descriptor. */
  359. #define DIR_PURPOSE_UPLOAD_DIR 8
  360. /** A connection to a directory server: upload a v3 networkstatus vote. */
  361. #define DIR_PURPOSE_UPLOAD_VOTE 10
  362. /** A connection to a directory server: upload a v3 consensus signature */
  363. #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
  364. /** A connection to a directory server: download one or more v3 networkstatus
  365. * votes. */
  366. #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
  367. /** A connection to a directory server: download a v3 detached signatures
  368. * object for a consensus. */
  369. #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
  370. /** A connection to a directory server: download a v3 networkstatus
  371. * consensus. */
  372. #define DIR_PURPOSE_FETCH_CONSENSUS 14
  373. /** A connection to a directory server: download one or more directory
  374. * authority certificates. */
  375. #define DIR_PURPOSE_FETCH_CERTIFICATE 15
  376. /** Purpose for connection at a directory server. */
  377. #define DIR_PURPOSE_SERVER 16
  378. /** A connection to a hidden service directory server: upload a v2 rendezvous
  379. * descriptor. */
  380. #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
  381. /** A connection to a hidden service directory server: download a v2 rendezvous
  382. * descriptor. */
  383. #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
  384. /** A connection to a directory server: download a microdescriptor. */
  385. #define DIR_PURPOSE_FETCH_MICRODESC 19
  386. /** A connection to a hidden service directory: upload a v3 descriptor. */
  387. #define DIR_PURPOSE_UPLOAD_HSDESC 20
  388. /** A connection to a hidden service directory: fetch a v3 descriptor. */
  389. #define DIR_PURPOSE_FETCH_HSDESC 21
  390. /** A connection to a directory server: set after a hidden service descriptor
  391. * is downloaded. */
  392. #define DIR_PURPOSE_HAS_FETCHED_HSDESC 22
  393. #define DIR_PURPOSE_MAX_ 22
  394. /** True iff <b>p</b> is a purpose corresponding to uploading
  395. * data to a directory server. */
  396. #define DIR_PURPOSE_IS_UPLOAD(p) \
  397. ((p)==DIR_PURPOSE_UPLOAD_DIR || \
  398. (p)==DIR_PURPOSE_UPLOAD_VOTE || \
  399. (p)==DIR_PURPOSE_UPLOAD_SIGNATURES || \
  400. (p)==DIR_PURPOSE_UPLOAD_RENDDESC_V2 || \
  401. (p)==DIR_PURPOSE_UPLOAD_HSDESC)
  402. #define EXIT_PURPOSE_MIN_ 1
  403. /** This exit stream wants to do an ordinary connect. */
  404. #define EXIT_PURPOSE_CONNECT 1
  405. /** This exit stream wants to do a resolve (either normal or reverse). */
  406. #define EXIT_PURPOSE_RESOLVE 2
  407. #define EXIT_PURPOSE_MAX_ 2
  408. /* !!!! If any connection purpose is ever over 31, we must grow the type
  409. * field in connection_t. */
  410. /** Circuit state: I'm the origin, still haven't done all my handshakes. */
  411. #define CIRCUIT_STATE_BUILDING 0
  412. /** Circuit state: Waiting to process the onionskin. */
  413. #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
  414. /** Circuit state: I'd like to deliver a create, but my n_chan is still
  415. * connecting. */
  416. #define CIRCUIT_STATE_CHAN_WAIT 2
  417. /** Circuit state: the circuit is open but we don't want to actually use it
  418. * until we find out if a better guard will be available.
  419. */
  420. #define CIRCUIT_STATE_GUARD_WAIT 3
  421. /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
  422. #define CIRCUIT_STATE_OPEN 4
  423. #define CIRCUIT_PURPOSE_MIN_ 1
  424. /* these circuits were initiated elsewhere */
  425. #define CIRCUIT_PURPOSE_OR_MIN_ 1
  426. /** OR-side circuit purpose: normal circuit, at OR. */
  427. #define CIRCUIT_PURPOSE_OR 1
  428. /** OR-side circuit purpose: At OR, from the service, waiting for intro from
  429. * clients. */
  430. #define CIRCUIT_PURPOSE_INTRO_POINT 2
  431. /** OR-side circuit purpose: At OR, from the client, waiting for the service.
  432. */
  433. #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
  434. /** OR-side circuit purpose: At OR, both circuits have this purpose. */
  435. #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
  436. #define CIRCUIT_PURPOSE_OR_MAX_ 4
  437. /* these circuits originate at this node */
  438. /* here's how circ client-side purposes work:
  439. * normal circuits are C_GENERAL.
  440. * circuits that are c_introducing are either on their way to
  441. * becoming open, or they are open and waiting for a
  442. * suitable rendcirc before they send the intro.
  443. * circuits that are c_introduce_ack_wait have sent the intro,
  444. * but haven't gotten a response yet.
  445. * circuits that are c_establish_rend are either on their way
  446. * to becoming open, or they are open and have sent the
  447. * establish_rendezvous cell but haven't received an ack.
  448. * circuits that are c_rend_ready are open and have received a
  449. * rend ack, but haven't heard from the service yet. if they have a
  450. * buildstate->pending_final_cpath then they're expecting a
  451. * cell from the service, else they're not.
  452. * circuits that are c_rend_ready_intro_acked are open, and
  453. * some intro circ has sent its intro and received an ack.
  454. * circuits that are c_rend_joined are open, have heard from
  455. * the service, and are talking to it.
  456. */
  457. /** Client-side circuit purpose: Normal circuit, with cpath. */
  458. #define CIRCUIT_PURPOSE_C_GENERAL 5
  459. #define CIRCUIT_PURPOSE_C_HS_MIN_ 6
  460. /** Client-side circuit purpose: at the client, connecting to intro point. */
  461. #define CIRCUIT_PURPOSE_C_INTRODUCING 6
  462. /** Client-side circuit purpose: at the client, sent INTRODUCE1 to intro point,
  463. * waiting for ACK/NAK. */
  464. #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
  465. /** Client-side circuit purpose: at the client, introduced and acked, closing.
  466. */
  467. #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
  468. /** Client-side circuit purpose: at the client, waiting for ack. */
  469. #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
  470. /** Client-side circuit purpose: at the client, waiting for the service. */
  471. #define CIRCUIT_PURPOSE_C_REND_READY 10
  472. /** Client-side circuit purpose: at the client, waiting for the service,
  473. * INTRODUCE has been acknowledged. */
  474. #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
  475. /** Client-side circuit purpose: at the client, rendezvous established. */
  476. #define CIRCUIT_PURPOSE_C_REND_JOINED 12
  477. /** This circuit is used for getting hsdirs */
  478. #define CIRCUIT_PURPOSE_C_HSDIR_GET 13
  479. #define CIRCUIT_PURPOSE_C_HS_MAX_ 13
  480. /** This circuit is used for build time measurement only */
  481. #define CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT 14
  482. #define CIRCUIT_PURPOSE_C_MAX_ 14
  483. #define CIRCUIT_PURPOSE_S_HS_MIN_ 15
  484. /** Hidden-service-side circuit purpose: at the service, waiting for
  485. * introductions. */
  486. #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 15
  487. /** Hidden-service-side circuit purpose: at the service, successfully
  488. * established intro. */
  489. #define CIRCUIT_PURPOSE_S_INTRO 16
  490. /** Hidden-service-side circuit purpose: at the service, connecting to rend
  491. * point. */
  492. #define CIRCUIT_PURPOSE_S_CONNECT_REND 17
  493. /** Hidden-service-side circuit purpose: at the service, rendezvous
  494. * established. */
  495. #define CIRCUIT_PURPOSE_S_REND_JOINED 18
  496. /** This circuit is used for uploading hsdirs */
  497. #define CIRCUIT_PURPOSE_S_HSDIR_POST 19
  498. #define CIRCUIT_PURPOSE_S_HS_MAX_ 19
  499. /** A testing circuit; not meant to be used for actual traffic. */
  500. #define CIRCUIT_PURPOSE_TESTING 20
  501. /** A controller made this circuit and Tor should not use it. */
  502. #define CIRCUIT_PURPOSE_CONTROLLER 21
  503. /** This circuit is used for path bias probing only */
  504. #define CIRCUIT_PURPOSE_PATH_BIAS_TESTING 22
  505. /** This circuit is used for vanguards/restricted paths.
  506. *
  507. * This type of circuit is *only* created preemptively and never
  508. * on-demand. When an HS operation needs to take place (e.g. connect to an
  509. * intro point), these circuits are then cannibalized and repurposed to the
  510. * actual needed HS purpose. */
  511. #define CIRCUIT_PURPOSE_HS_VANGUARDS 23
  512. #define CIRCUIT_PURPOSE_MAX_ 23
  513. /** A catch-all for unrecognized purposes. Currently we don't expect
  514. * to make or see any circuits with this purpose. */
  515. #define CIRCUIT_PURPOSE_UNKNOWN 255
  516. /** True iff the circuit purpose <b>p</b> is for a circuit that
  517. * originated at this node. */
  518. #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>CIRCUIT_PURPOSE_OR_MAX_)
  519. /** True iff the circuit purpose <b>p</b> is for a circuit that originated
  520. * here to serve as a client. (Hidden services don't count here.) */
  521. #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
  522. ((p)> CIRCUIT_PURPOSE_OR_MAX_ && \
  523. (p)<=CIRCUIT_PURPOSE_C_MAX_)
  524. /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
  525. #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
  526. /** True iff the circuit purpose <b>p</b> is for an established rendezvous
  527. * circuit. */
  528. #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
  529. ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
  530. (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
  531. /** True iff the circuit_t c is actually an or_circuit_t */
  532. #define CIRCUIT_IS_ORCIRC(c) (((circuit_t *)(c))->magic == OR_CIRCUIT_MAGIC)
  533. /** How many circuits do we want simultaneously in-progress to handle
  534. * a given stream? */
  535. #define MIN_CIRCUITS_HANDLING_STREAM 2
  536. /* These RELAY_COMMAND constants define values for relay cell commands, and
  537. * must match those defined in tor-spec.txt. */
  538. #define RELAY_COMMAND_BEGIN 1
  539. #define RELAY_COMMAND_DATA 2
  540. #define RELAY_COMMAND_END 3
  541. #define RELAY_COMMAND_CONNECTED 4
  542. #define RELAY_COMMAND_SENDME 5
  543. #define RELAY_COMMAND_EXTEND 6
  544. #define RELAY_COMMAND_EXTENDED 7
  545. #define RELAY_COMMAND_TRUNCATE 8
  546. #define RELAY_COMMAND_TRUNCATED 9
  547. #define RELAY_COMMAND_DROP 10
  548. #define RELAY_COMMAND_RESOLVE 11
  549. #define RELAY_COMMAND_RESOLVED 12
  550. #define RELAY_COMMAND_BEGIN_DIR 13
  551. #define RELAY_COMMAND_EXTEND2 14
  552. #define RELAY_COMMAND_EXTENDED2 15
  553. #define RELAY_COMMAND_ESTABLISH_INTRO 32
  554. #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
  555. #define RELAY_COMMAND_INTRODUCE1 34
  556. #define RELAY_COMMAND_INTRODUCE2 35
  557. #define RELAY_COMMAND_RENDEZVOUS1 36
  558. #define RELAY_COMMAND_RENDEZVOUS2 37
  559. #define RELAY_COMMAND_INTRO_ESTABLISHED 38
  560. #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
  561. #define RELAY_COMMAND_INTRODUCE_ACK 40
  562. /* Reasons why an OR connection is closed. */
  563. #define END_OR_CONN_REASON_DONE 1
  564. #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
  565. #define END_OR_CONN_REASON_OR_IDENTITY 3
  566. #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
  567. #define END_OR_CONN_REASON_TIMEOUT 5
  568. #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
  569. #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
  570. #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
  571. #define END_OR_CONN_REASON_PT_MISSING 9 /* PT failed or not available */
  572. #define END_OR_CONN_REASON_MISC 10
  573. /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
  574. * documentation of these. The values must match. */
  575. #define END_STREAM_REASON_MISC 1
  576. #define END_STREAM_REASON_RESOLVEFAILED 2
  577. #define END_STREAM_REASON_CONNECTREFUSED 3
  578. #define END_STREAM_REASON_EXITPOLICY 4
  579. #define END_STREAM_REASON_DESTROY 5
  580. #define END_STREAM_REASON_DONE 6
  581. #define END_STREAM_REASON_TIMEOUT 7
  582. #define END_STREAM_REASON_NOROUTE 8
  583. #define END_STREAM_REASON_HIBERNATING 9
  584. #define END_STREAM_REASON_INTERNAL 10
  585. #define END_STREAM_REASON_RESOURCELIMIT 11
  586. #define END_STREAM_REASON_CONNRESET 12
  587. #define END_STREAM_REASON_TORPROTOCOL 13
  588. #define END_STREAM_REASON_NOTDIRECTORY 14
  589. #define END_STREAM_REASON_ENTRYPOLICY 15
  590. /* These high-numbered end reasons are not part of the official spec,
  591. * and are not intended to be put in relay end cells. They are here
  592. * to be more informative when sending back socks replies to the
  593. * application. */
  594. /* XXXX 256 is no longer used; feel free to reuse it. */
  595. /** We were unable to attach the connection to any circuit at all. */
  596. /* XXXX the ways we use this one don't make a lot of sense. */
  597. #define END_STREAM_REASON_CANT_ATTACH 257
  598. /** We can't connect to any directories at all, so we killed our streams
  599. * before they can time out. */
  600. #define END_STREAM_REASON_NET_UNREACHABLE 258
  601. /** This is a SOCKS connection, and the client used (or misused) the SOCKS
  602. * protocol in a way we couldn't handle. */
  603. #define END_STREAM_REASON_SOCKSPROTOCOL 259
  604. /** This is a transparent proxy connection, but we can't extract the original
  605. * target address:port. */
  606. #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
  607. /** This is a connection on the NATD port, and the destination IP:Port was
  608. * either ill-formed or out-of-range. */
  609. #define END_STREAM_REASON_INVALID_NATD_DEST 261
  610. /** The target address is in a private network (like 127.0.0.1 or 10.0.0.1);
  611. * you don't want to do that over a randomly chosen exit */
  612. #define END_STREAM_REASON_PRIVATE_ADDR 262
  613. /** This is an HTTP tunnel connection and the client used or misused HTTP in a
  614. * way we can't handle.
  615. */
  616. #define END_STREAM_REASON_HTTPPROTOCOL 263
  617. /** Bitwise-and this value with endreason to mask out all flags. */
  618. #define END_STREAM_REASON_MASK 511
  619. /** Bitwise-or this with the argument to control_event_stream_status
  620. * to indicate that the reason came from an END cell. */
  621. #define END_STREAM_REASON_FLAG_REMOTE 512
  622. /** Bitwise-or this with the argument to control_event_stream_status
  623. * to indicate that we already sent a CLOSED stream event. */
  624. #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
  625. /** Bitwise-or this with endreason to indicate that we already sent
  626. * a socks reply, and no further reply needs to be sent from
  627. * connection_mark_unattached_ap(). */
  628. #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
  629. /** Reason for remapping an AP connection's address: we have a cached
  630. * answer. */
  631. #define REMAP_STREAM_SOURCE_CACHE 1
  632. /** Reason for remapping an AP connection's address: the exit node told us an
  633. * answer. */
  634. #define REMAP_STREAM_SOURCE_EXIT 2
  635. /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
  636. #define RESOLVED_TYPE_HOSTNAME 0
  637. #define RESOLVED_TYPE_IPV4 4
  638. #define RESOLVED_TYPE_IPV6 6
  639. #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
  640. #define RESOLVED_TYPE_ERROR 0xF1
  641. /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
  642. * call; they only go to the controller for tracking */
  643. /* Closing introduction point that were opened in parallel. */
  644. #define END_CIRC_REASON_IP_NOW_REDUNDANT -4
  645. /** Our post-timeout circuit time measurement period expired.
  646. * We must give up now */
  647. #define END_CIRC_REASON_MEASUREMENT_EXPIRED -3
  648. /** We couldn't build a path for this circuit. */
  649. #define END_CIRC_REASON_NOPATH -2
  650. /** Catch-all "other" reason for closing origin circuits. */
  651. #define END_CIRC_AT_ORIGIN -1
  652. /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
  653. * documentation of these. */
  654. #define END_CIRC_REASON_MIN_ 0
  655. #define END_CIRC_REASON_NONE 0
  656. #define END_CIRC_REASON_TORPROTOCOL 1
  657. #define END_CIRC_REASON_INTERNAL 2
  658. #define END_CIRC_REASON_REQUESTED 3
  659. #define END_CIRC_REASON_HIBERNATING 4
  660. #define END_CIRC_REASON_RESOURCELIMIT 5
  661. #define END_CIRC_REASON_CONNECTFAILED 6
  662. #define END_CIRC_REASON_OR_IDENTITY 7
  663. #define END_CIRC_REASON_CHANNEL_CLOSED 8
  664. #define END_CIRC_REASON_FINISHED 9
  665. #define END_CIRC_REASON_TIMEOUT 10
  666. #define END_CIRC_REASON_DESTROYED 11
  667. #define END_CIRC_REASON_NOSUCHSERVICE 12
  668. #define END_CIRC_REASON_MAX_ 12
  669. /** Bitwise-OR this with the argument to circuit_mark_for_close() or
  670. * control_event_circuit_status() to indicate that the reason was
  671. * passed through from a destroy or truncate cell. */
  672. #define END_CIRC_REASON_FLAG_REMOTE 512
  673. /** Length of 'y' portion of 'y.onion' URL. */
  674. #define REND_SERVICE_ID_LEN_BASE32 16
  675. /** Length of 'y.onion' including '.onion' URL. */
  676. #define REND_SERVICE_ADDRESS_LEN (16+1+5)
  677. /** Length of a binary-encoded rendezvous service ID. */
  678. #define REND_SERVICE_ID_LEN 10
  679. /** Time period for which a v2 descriptor will be valid. */
  680. #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
  681. /** Time period within which two sets of v2 descriptors will be uploaded in
  682. * parallel. */
  683. #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
  684. /** Number of non-consecutive replicas (i.e. distributed somewhere
  685. * in the ring) for a descriptor. */
  686. #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
  687. /** Number of consecutive replicas for a descriptor. */
  688. #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
  689. /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
  690. #define REND_DESC_ID_V2_LEN_BASE32 BASE32_DIGEST_LEN
  691. /** Length of the base32-encoded secret ID part of versioned hidden service
  692. * descriptors. */
  693. #define REND_SECRET_ID_PART_LEN_BASE32 BASE32_DIGEST_LEN
  694. /** Length of the base32-encoded hash of an introduction point's
  695. * identity key. */
  696. #define REND_INTRO_POINT_ID_LEN_BASE32 BASE32_DIGEST_LEN
  697. /** Length of the descriptor cookie that is used for client authorization
  698. * to hidden services. */
  699. #define REND_DESC_COOKIE_LEN 16
  700. /** Length of the base64-encoded descriptor cookie that is used for
  701. * exchanging client authorization between hidden service and client. */
  702. #define REND_DESC_COOKIE_LEN_BASE64 22
  703. /** Length of client identifier in encrypted introduction points for hidden
  704. * service authorization type 'basic'. */
  705. #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
  706. /** Multiple of the number of clients to which the real number of clients
  707. * is padded with fake clients for hidden service authorization type
  708. * 'basic'. */
  709. #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
  710. /** Length of client entry consisting of client identifier and encrypted
  711. * session key for hidden service authorization type 'basic'. */
  712. #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
  713. + CIPHER_KEY_LEN)
  714. /** Maximum size of v2 hidden service descriptors. */
  715. #define REND_DESC_MAX_SIZE (20 * 1024)
  716. /** Legal characters for use in authorized client names for a hidden
  717. * service. */
  718. #define REND_LEGAL_CLIENTNAME_CHARACTERS \
  719. "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
  720. /** Maximum length of authorized client names for a hidden service. */
  721. #define REND_CLIENTNAME_MAX_LEN 16
  722. /** Length of the rendezvous cookie that is used to connect circuits at the
  723. * rendezvous point. */
  724. #define REND_COOKIE_LEN DIGEST_LEN
  725. /** Client authorization type that a hidden service performs. */
  726. typedef enum rend_auth_type_t {
  727. REND_NO_AUTH = 0,
  728. REND_BASIC_AUTH = 1,
  729. REND_STEALTH_AUTH = 2,
  730. } rend_auth_type_t;
  731. /** Client-side configuration of authorization for a hidden service. */
  732. typedef struct rend_service_authorization_t {
  733. uint8_t descriptor_cookie[REND_DESC_COOKIE_LEN];
  734. char onion_address[REND_SERVICE_ADDRESS_LEN+1];
  735. rend_auth_type_t auth_type;
  736. } rend_service_authorization_t;
  737. /** Client- and server-side data that is used for hidden service connection
  738. * establishment. Not all fields contain data depending on where this struct
  739. * is used. */
  740. typedef struct rend_data_t {
  741. /* Hidden service protocol version of this base object. */
  742. uint32_t version;
  743. /** List of HSDir fingerprints on which this request has been sent to. This
  744. * contains binary identity digest of the directory of size DIGEST_LEN. */
  745. smartlist_t *hsdirs_fp;
  746. /** Rendezvous cookie used by both, client and service. */
  747. char rend_cookie[REND_COOKIE_LEN];
  748. /** Number of streams associated with this rendezvous circuit. */
  749. int nr_streams;
  750. } rend_data_t;
  751. typedef struct rend_data_v2_t {
  752. /* Rendezvous base data. */
  753. rend_data_t base_;
  754. /** Onion address (without the .onion part) that a client requests. */
  755. char onion_address[REND_SERVICE_ID_LEN_BASE32+1];
  756. /** Descriptor ID for each replicas computed from the onion address. If
  757. * the onion address is empty, this array MUST be empty. We keep them so
  758. * we know when to purge our entry in the last hsdir request table. */
  759. char descriptor_id[REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS][DIGEST_LEN];
  760. /** (Optional) descriptor cookie that is used by a client. */
  761. char descriptor_cookie[REND_DESC_COOKIE_LEN];
  762. /** Authorization type for accessing a service used by a client. */
  763. rend_auth_type_t auth_type;
  764. /** Descriptor ID for a client request. The control port command HSFETCH
  765. * uses this. It's set if the descriptor query should only use this
  766. * descriptor ID. */
  767. char desc_id_fetch[DIGEST_LEN];
  768. /** Hash of the hidden service's PK used by a service. */
  769. char rend_pk_digest[DIGEST_LEN];
  770. } rend_data_v2_t;
  771. /* From a base rend_data_t object <b>d</d>, return the v2 object. */
  772. static inline
  773. rend_data_v2_t *TO_REND_DATA_V2(const rend_data_t *d)
  774. {
  775. tor_assert(d);
  776. tor_assert(d->version == 2);
  777. return DOWNCAST(rend_data_v2_t, d);
  778. }
  779. /* Stub because we can't include hs_ident.h. */
  780. struct hs_ident_edge_conn_t;
  781. struct hs_ident_dir_conn_t;
  782. struct hs_ident_circuit_t;
  783. /* Stub because we can't include hs_common.h. */
  784. struct hsdir_index_t;
  785. /** Time interval for tracking replays of DH public keys received in
  786. * INTRODUCE2 cells. Used only to avoid launching multiple
  787. * simultaneous attempts to connect to the same rendezvous point. */
  788. #define REND_REPLAY_TIME_INTERVAL (5 * 60)
  789. /** Used to indicate which way a cell is going on a circuit. */
  790. typedef enum {
  791. CELL_DIRECTION_IN=1, /**< The cell is moving towards the origin. */
  792. CELL_DIRECTION_OUT=2, /**< The cell is moving away from the origin. */
  793. } cell_direction_t;
  794. /** Initial value for both sides of a circuit transmission window when the
  795. * circuit is initialized. Measured in cells. */
  796. #define CIRCWINDOW_START 1000
  797. #define CIRCWINDOW_START_MIN 100
  798. #define CIRCWINDOW_START_MAX 1000
  799. /** Amount to increment a circuit window when we get a circuit SENDME. */
  800. #define CIRCWINDOW_INCREMENT 100
  801. /** Initial value on both sides of a stream transmission window when the
  802. * stream is initialized. Measured in cells. */
  803. #define STREAMWINDOW_START 500
  804. /** Amount to increment a stream window when we get a stream SENDME. */
  805. #define STREAMWINDOW_INCREMENT 50
  806. /** Maximum number of queued cells on a circuit for which we are the
  807. * midpoint before we give up and kill it. This must be >= circwindow
  808. * to avoid killing innocent circuits, and >= circwindow*2 to give
  809. * leaky-pipe a chance of working someday. The ORCIRC_MAX_MIDDLE_KILL_THRESH
  810. * ratio controls the margin of error between emitting a warning and
  811. * killing the circuit.
  812. */
  813. #define ORCIRC_MAX_MIDDLE_CELLS (CIRCWINDOW_START_MAX*2)
  814. /** Ratio of hard (circuit kill) to soft (warning) thresholds for the
  815. * ORCIRC_MAX_MIDDLE_CELLS tests.
  816. */
  817. #define ORCIRC_MAX_MIDDLE_KILL_THRESH (1.1f)
  818. /* Cell commands. These values are defined in tor-spec.txt. */
  819. #define CELL_PADDING 0
  820. #define CELL_CREATE 1
  821. #define CELL_CREATED 2
  822. #define CELL_RELAY 3
  823. #define CELL_DESTROY 4
  824. #define CELL_CREATE_FAST 5
  825. #define CELL_CREATED_FAST 6
  826. #define CELL_VERSIONS 7
  827. #define CELL_NETINFO 8
  828. #define CELL_RELAY_EARLY 9
  829. #define CELL_CREATE2 10
  830. #define CELL_CREATED2 11
  831. #define CELL_PADDING_NEGOTIATE 12
  832. #define CELL_VPADDING 128
  833. #define CELL_CERTS 129
  834. #define CELL_AUTH_CHALLENGE 130
  835. #define CELL_AUTHENTICATE 131
  836. #define CELL_AUTHORIZE 132
  837. #define CELL_COMMAND_MAX_ 132
  838. /** How long to test reachability before complaining to the user. */
  839. #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
  840. /** Legal characters in a nickname. */
  841. #define LEGAL_NICKNAME_CHARACTERS \
  842. "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
  843. /** Name to use in client TLS certificates if no nickname is given. Once
  844. * Tor 0.1.2.x is obsolete, we can remove this. */
  845. #define DEFAULT_CLIENT_NICKNAME "client"
  846. /** Name chosen by routers that don't configure nicknames */
  847. #define UNNAMED_ROUTER_NICKNAME "Unnamed"
  848. /** Number of bytes in a SOCKS4 header. */
  849. #define SOCKS4_NETWORK_LEN 8
  850. /*
  851. * Relay payload:
  852. * Relay command [1 byte]
  853. * Recognized [2 bytes]
  854. * Stream ID [2 bytes]
  855. * Partial SHA-1 [4 bytes]
  856. * Length [2 bytes]
  857. * Relay payload [498 bytes]
  858. */
  859. /** Number of bytes in a cell, minus cell header. */
  860. #define CELL_PAYLOAD_SIZE 509
  861. /** Number of bytes in a cell transmitted over the network, in the longest
  862. * form */
  863. #define CELL_MAX_NETWORK_SIZE 514
  864. /** Maximum length of a header on a variable-length cell. */
  865. #define VAR_CELL_MAX_HEADER_SIZE 7
  866. static int get_cell_network_size(int wide_circ_ids);
  867. static inline int get_cell_network_size(int wide_circ_ids)
  868. {
  869. return wide_circ_ids ? CELL_MAX_NETWORK_SIZE : CELL_MAX_NETWORK_SIZE - 2;
  870. }
  871. static int get_var_cell_header_size(int wide_circ_ids);
  872. static inline int get_var_cell_header_size(int wide_circ_ids)
  873. {
  874. return wide_circ_ids ? VAR_CELL_MAX_HEADER_SIZE :
  875. VAR_CELL_MAX_HEADER_SIZE - 2;
  876. }
  877. static int get_circ_id_size(int wide_circ_ids);
  878. static inline int get_circ_id_size(int wide_circ_ids)
  879. {
  880. return wide_circ_ids ? 4 : 2;
  881. }
  882. /** Number of bytes in a relay cell's header (not including general cell
  883. * header). */
  884. #define RELAY_HEADER_SIZE (1+2+2+4+2)
  885. /** Largest number of bytes that can fit in a relay cell payload. */
  886. #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
  887. /** Identifies a circuit on an or_connection */
  888. typedef uint32_t circid_t;
  889. /** Identifies a stream on a circuit */
  890. typedef uint16_t streamid_t;
  891. /* channel_t typedef; struct channel_s is in channel.h */
  892. typedef struct channel_s channel_t;
  893. /* channel_listener_t typedef; struct channel_listener_s is in channel.h */
  894. typedef struct channel_listener_s channel_listener_t;
  895. /* channel states for channel_t */
  896. typedef enum {
  897. /*
  898. * Closed state - channel is inactive
  899. *
  900. * Permitted transitions from:
  901. * - CHANNEL_STATE_CLOSING
  902. * Permitted transitions to:
  903. * - CHANNEL_STATE_OPENING
  904. */
  905. CHANNEL_STATE_CLOSED = 0,
  906. /*
  907. * Opening state - channel is trying to connect
  908. *
  909. * Permitted transitions from:
  910. * - CHANNEL_STATE_CLOSED
  911. * Permitted transitions to:
  912. * - CHANNEL_STATE_CLOSING
  913. * - CHANNEL_STATE_ERROR
  914. * - CHANNEL_STATE_OPEN
  915. */
  916. CHANNEL_STATE_OPENING,
  917. /*
  918. * Open state - channel is active and ready for use
  919. *
  920. * Permitted transitions from:
  921. * - CHANNEL_STATE_MAINT
  922. * - CHANNEL_STATE_OPENING
  923. * Permitted transitions to:
  924. * - CHANNEL_STATE_CLOSING
  925. * - CHANNEL_STATE_ERROR
  926. * - CHANNEL_STATE_MAINT
  927. */
  928. CHANNEL_STATE_OPEN,
  929. /*
  930. * Maintenance state - channel is temporarily offline for subclass specific
  931. * maintenance activities such as TLS renegotiation.
  932. *
  933. * Permitted transitions from:
  934. * - CHANNEL_STATE_OPEN
  935. * Permitted transitions to:
  936. * - CHANNEL_STATE_CLOSING
  937. * - CHANNEL_STATE_ERROR
  938. * - CHANNEL_STATE_OPEN
  939. */
  940. CHANNEL_STATE_MAINT,
  941. /*
  942. * Closing state - channel is shutting down
  943. *
  944. * Permitted transitions from:
  945. * - CHANNEL_STATE_MAINT
  946. * - CHANNEL_STATE_OPEN
  947. * Permitted transitions to:
  948. * - CHANNEL_STATE_CLOSED,
  949. * - CHANNEL_STATE_ERROR
  950. */
  951. CHANNEL_STATE_CLOSING,
  952. /*
  953. * Error state - channel has experienced a permanent error
  954. *
  955. * Permitted transitions from:
  956. * - CHANNEL_STATE_CLOSING
  957. * - CHANNEL_STATE_MAINT
  958. * - CHANNEL_STATE_OPENING
  959. * - CHANNEL_STATE_OPEN
  960. * Permitted transitions to:
  961. * - None
  962. */
  963. CHANNEL_STATE_ERROR,
  964. /*
  965. * Placeholder for maximum state value
  966. */
  967. CHANNEL_STATE_LAST
  968. } channel_state_t;
  969. /* channel listener states for channel_listener_t */
  970. typedef enum {
  971. /*
  972. * Closed state - channel listener is inactive
  973. *
  974. * Permitted transitions from:
  975. * - CHANNEL_LISTENER_STATE_CLOSING
  976. * Permitted transitions to:
  977. * - CHANNEL_LISTENER_STATE_LISTENING
  978. */
  979. CHANNEL_LISTENER_STATE_CLOSED = 0,
  980. /*
  981. * Listening state - channel listener is listening for incoming
  982. * connections
  983. *
  984. * Permitted transitions from:
  985. * - CHANNEL_LISTENER_STATE_CLOSED
  986. * Permitted transitions to:
  987. * - CHANNEL_LISTENER_STATE_CLOSING
  988. * - CHANNEL_LISTENER_STATE_ERROR
  989. */
  990. CHANNEL_LISTENER_STATE_LISTENING,
  991. /*
  992. * Closing state - channel listener is shutting down
  993. *
  994. * Permitted transitions from:
  995. * - CHANNEL_LISTENER_STATE_LISTENING
  996. * Permitted transitions to:
  997. * - CHANNEL_LISTENER_STATE_CLOSED,
  998. * - CHANNEL_LISTENER_STATE_ERROR
  999. */
  1000. CHANNEL_LISTENER_STATE_CLOSING,
  1001. /*
  1002. * Error state - channel listener has experienced a permanent error
  1003. *
  1004. * Permitted transitions from:
  1005. * - CHANNEL_STATE_CLOSING
  1006. * - CHANNEL_STATE_LISTENING
  1007. * Permitted transitions to:
  1008. * - None
  1009. */
  1010. CHANNEL_LISTENER_STATE_ERROR,
  1011. /*
  1012. * Placeholder for maximum state value
  1013. */
  1014. CHANNEL_LISTENER_STATE_LAST
  1015. } channel_listener_state_t;
  1016. /* TLS channel stuff */
  1017. typedef struct channel_tls_s channel_tls_t;
  1018. /* circuitmux_t typedef; struct circuitmux_s is in circuitmux.h */
  1019. typedef struct circuitmux_s circuitmux_t;
  1020. /** Parsed onion routing cell. All communication between nodes
  1021. * is via cells. */
  1022. typedef struct cell_t {
  1023. circid_t circ_id; /**< Circuit which received the cell. */
  1024. uint8_t command; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
  1025. * CELL_DESTROY, etc */
  1026. uint8_t payload[CELL_PAYLOAD_SIZE]; /**< Cell body. */
  1027. } cell_t;
  1028. /** Parsed variable-length onion routing cell. */
  1029. typedef struct var_cell_t {
  1030. /** Type of the cell: CELL_VERSIONS, etc. */
  1031. uint8_t command;
  1032. /** Circuit thich received the cell */
  1033. circid_t circ_id;
  1034. /** Number of bytes actually stored in <b>payload</b> */
  1035. uint16_t payload_len;
  1036. /** Payload of this cell */
  1037. uint8_t payload[FLEXIBLE_ARRAY_MEMBER];
  1038. } var_cell_t;
  1039. /** A parsed Extended ORPort message. */
  1040. typedef struct ext_or_cmd_t {
  1041. uint16_t cmd; /** Command type */
  1042. uint16_t len; /** Body length */
  1043. char body[FLEXIBLE_ARRAY_MEMBER]; /** Message body */
  1044. } ext_or_cmd_t;
  1045. /** A cell as packed for writing to the network. */
  1046. typedef struct packed_cell_t {
  1047. /** Next cell queued on this circuit. */
  1048. TOR_SIMPLEQ_ENTRY(packed_cell_t) next;
  1049. char body[CELL_MAX_NETWORK_SIZE]; /**< Cell as packed for network. */
  1050. uint32_t inserted_timestamp; /**< Time (in timestamp units) when this cell
  1051. * was inserted */
  1052. } packed_cell_t;
  1053. /** A queue of cells on a circuit, waiting to be added to the
  1054. * or_connection_t's outbuf. */
  1055. typedef struct cell_queue_t {
  1056. /** Linked list of packed_cell_t*/
  1057. TOR_SIMPLEQ_HEAD(cell_simpleq, packed_cell_t) head;
  1058. int n; /**< The number of cells in the queue. */
  1059. } cell_queue_t;
  1060. /** A single queued destroy cell. */
  1061. typedef struct destroy_cell_t {
  1062. TOR_SIMPLEQ_ENTRY(destroy_cell_t) next;
  1063. circid_t circid;
  1064. uint32_t inserted_timestamp; /**< Time (in timestamp units) when this cell
  1065. * was inserted */
  1066. uint8_t reason;
  1067. } destroy_cell_t;
  1068. /** A queue of destroy cells on a channel. */
  1069. typedef struct destroy_cell_queue_t {
  1070. /** Linked list of packed_cell_t */
  1071. TOR_SIMPLEQ_HEAD(dcell_simpleq, destroy_cell_t) head;
  1072. int n; /**< The number of cells in the queue. */
  1073. } destroy_cell_queue_t;
  1074. /** Beginning of a RELAY cell payload. */
  1075. typedef struct {
  1076. uint8_t command; /**< The end-to-end relay command. */
  1077. uint16_t recognized; /**< Used to tell whether cell is for us. */
  1078. streamid_t stream_id; /**< Which stream is this cell associated with? */
  1079. char integrity[4]; /**< Used to tell whether cell is corrupted. */
  1080. uint16_t length; /**< How long is the payload body? */
  1081. } relay_header_t;
  1082. typedef struct socks_request_t socks_request_t;
  1083. typedef struct entry_port_cfg_t {
  1084. /* Client port types (socks, dns, trans, natd) only: */
  1085. uint8_t isolation_flags; /**< Zero or more isolation flags */
  1086. int session_group; /**< A session group, or -1 if this port is not in a
  1087. * session group. */
  1088. /* Socks only: */
  1089. /** When both no-auth and user/pass are advertised by a SOCKS client, select
  1090. * no-auth. */
  1091. unsigned int socks_prefer_no_auth : 1;
  1092. /** When ISO_SOCKSAUTH is in use, Keep-Alive circuits indefinitely. */
  1093. unsigned int socks_iso_keep_alive : 1;
  1094. /* Client port types only: */
  1095. unsigned int ipv4_traffic : 1;
  1096. unsigned int ipv6_traffic : 1;
  1097. unsigned int prefer_ipv6 : 1;
  1098. unsigned int dns_request : 1;
  1099. unsigned int onion_traffic : 1;
  1100. /** For a socks listener: should we cache IPv4/IPv6 DNS information that
  1101. * exit nodes tell us?
  1102. *
  1103. * @{ */
  1104. unsigned int cache_ipv4_answers : 1;
  1105. unsigned int cache_ipv6_answers : 1;
  1106. /** @} */
  1107. /** For a socks listeners: if we find an answer in our client-side DNS cache,
  1108. * should we use it?
  1109. *
  1110. * @{ */
  1111. unsigned int use_cached_ipv4_answers : 1;
  1112. unsigned int use_cached_ipv6_answers : 1;
  1113. /** @} */
  1114. /** For socks listeners: When we can automap an address to IPv4 or IPv6,
  1115. * do we prefer IPv6? */
  1116. unsigned int prefer_ipv6_virtaddr : 1;
  1117. } entry_port_cfg_t;
  1118. typedef struct server_port_cfg_t {
  1119. /* Server port types (or, dir) only: */
  1120. unsigned int no_advertise : 1;
  1121. unsigned int no_listen : 1;
  1122. unsigned int all_addrs : 1;
  1123. unsigned int bind_ipv4_only : 1;
  1124. unsigned int bind_ipv6_only : 1;
  1125. } server_port_cfg_t;
  1126. /* Values for connection_t.magic: used to make sure that downcasts (casts from
  1127. * connection_t to foo_connection_t) are safe. */
  1128. #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
  1129. #define OR_CONNECTION_MAGIC 0x7D31FF03u
  1130. #define EDGE_CONNECTION_MAGIC 0xF0374013u
  1131. #define ENTRY_CONNECTION_MAGIC 0xbb4a5703
  1132. #define DIR_CONNECTION_MAGIC 0x9988ffeeu
  1133. #define CONTROL_CONNECTION_MAGIC 0x8abc765du
  1134. #define LISTENER_CONNECTION_MAGIC 0x1a1ac741u
  1135. struct buf_t;
  1136. /** Description of a connection to another host or process, and associated
  1137. * data.
  1138. *
  1139. * A connection is named based on what it's connected to -- an "OR
  1140. * connection" has a Tor node on the other end, an "exit
  1141. * connection" has a website or other server on the other end, and an
  1142. * "AP connection" has an application proxy (and thus a user) on the
  1143. * other end.
  1144. *
  1145. * Every connection has a type and a state. Connections never change
  1146. * their type, but can go through many state changes in their lifetime.
  1147. *
  1148. * Every connection has two associated input and output buffers.
  1149. * Listeners don't use them. For non-listener connections, incoming
  1150. * data is appended to conn->inbuf, and outgoing data is taken from
  1151. * conn->outbuf. Connections differ primarily in the functions called
  1152. * to fill and drain these buffers.
  1153. */
  1154. typedef struct connection_t {
  1155. uint32_t magic; /**< For memory debugging: must equal one of
  1156. * *_CONNECTION_MAGIC. */
  1157. uint8_t state; /**< Current state of this connection. */
  1158. unsigned int type:5; /**< What kind of connection is this? */
  1159. unsigned int purpose:5; /**< Only used for DIR and EXIT types currently. */
  1160. /* The next fields are all one-bit booleans. Some are only applicable to
  1161. * connection subtypes, but we hold them here anyway, to save space.
  1162. */
  1163. unsigned int read_blocked_on_bw:1; /**< Boolean: should we start reading
  1164. * again once the bandwidth throttler allows it? */
  1165. unsigned int write_blocked_on_bw:1; /**< Boolean: should we start writing
  1166. * again once the bandwidth throttler allows
  1167. * writes? */
  1168. unsigned int hold_open_until_flushed:1; /**< Despite this connection's being
  1169. * marked for close, do we flush it
  1170. * before closing it? */
  1171. unsigned int inbuf_reached_eof:1; /**< Boolean: did read() return 0 on this
  1172. * conn? */
  1173. /** Set to 1 when we're inside connection_flushed_some to keep us from
  1174. * calling connection_handle_write() recursively. */
  1175. unsigned int in_flushed_some:1;
  1176. /** True if connection_handle_write is currently running on this connection.
  1177. */
  1178. unsigned int in_connection_handle_write:1;
  1179. /* For linked connections:
  1180. */
  1181. unsigned int linked:1; /**< True if there is, or has been, a linked_conn. */
  1182. /** True iff we'd like to be notified about read events from the
  1183. * linked conn. */
  1184. unsigned int reading_from_linked_conn:1;
  1185. /** True iff we're willing to write to the linked conn. */
  1186. unsigned int writing_to_linked_conn:1;
  1187. /** True iff we're currently able to read on the linked conn, and our
  1188. * read_event should be made active with libevent. */
  1189. unsigned int active_on_link:1;
  1190. /** True iff we've called connection_close_immediate() on this linked
  1191. * connection. */
  1192. unsigned int linked_conn_is_closed:1;
  1193. /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
  1194. unsigned int proxy_state:4;
  1195. /** Our socket; set to TOR_INVALID_SOCKET if this connection is closed,
  1196. * or has no socket. */
  1197. tor_socket_t s;
  1198. int conn_array_index; /**< Index into the global connection array. */
  1199. struct event *read_event; /**< Libevent event structure. */
  1200. struct event *write_event; /**< Libevent event structure. */
  1201. struct buf_t *inbuf; /**< Buffer holding data read over this connection. */
  1202. struct buf_t *outbuf; /**< Buffer holding data to write over this
  1203. * connection. */
  1204. size_t outbuf_flushlen; /**< How much data should we try to flush from the
  1205. * outbuf? */
  1206. time_t timestamp_lastread; /**< When was the last time libevent said we could
  1207. * read? */
  1208. time_t timestamp_lastwritten; /**< When was the last time libevent said we
  1209. * could write? */
  1210. time_t timestamp_created; /**< When was this connection_t created? */
  1211. int socket_family; /**< Address family of this connection's socket. Usually
  1212. * AF_INET, but it can also be AF_UNIX, or AF_INET6 */
  1213. tor_addr_t addr; /**< IP that socket "s" is directly connected to;
  1214. * may be the IP address for a proxy or pluggable transport,
  1215. * see "address" for the address of the final destination.
  1216. */
  1217. uint16_t port; /**< If non-zero, port that socket "s" is directly connected
  1218. * to; may be the port for a proxy or pluggable transport,
  1219. * see "address" for the port at the final destination. */
  1220. uint16_t marked_for_close; /**< Should we close this conn on the next
  1221. * iteration of the main loop? (If true, holds
  1222. * the line number where this connection was
  1223. * marked.) */
  1224. const char *marked_for_close_file; /**< For debugging: in which file were
  1225. * we marked for close? */
  1226. char *address; /**< FQDN (or IP) and port of the final destination for this
  1227. * connection; this is always the remote address, it is
  1228. * passed to a proxy or pluggable transport if one in use.
  1229. * See "addr" and "port" for the address that socket "s" is
  1230. * directly connected to.
  1231. * strdup into this, because free_connection() frees it. */
  1232. /** Another connection that's connected to this one in lieu of a socket. */
  1233. struct connection_t *linked_conn;
  1234. /** Unique identifier for this connection on this Tor instance. */
  1235. uint64_t global_identifier;
  1236. /** Bytes read since last call to control_event_conn_bandwidth_used().
  1237. * Only used if we're configured to emit CONN_BW events. */
  1238. uint32_t n_read_conn_bw;
  1239. /** Bytes written since last call to control_event_conn_bandwidth_used().
  1240. * Only used if we're configured to emit CONN_BW events. */
  1241. uint32_t n_written_conn_bw;
  1242. } connection_t;
  1243. /** Subtype of connection_t; used for a listener socket. */
  1244. typedef struct listener_connection_t {
  1245. connection_t base_;
  1246. /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
  1247. * to the evdns_server_port it uses to listen to and answer connections. */
  1248. struct evdns_server_port *dns_server_port;
  1249. entry_port_cfg_t entry_cfg;
  1250. } listener_connection_t;
  1251. /** Minimum length of the random part of an AUTH_CHALLENGE cell. */
  1252. #define OR_AUTH_CHALLENGE_LEN 32
  1253. /**
  1254. * @name Certificate types for CERTS cells.
  1255. *
  1256. * These values are defined by the protocol, and affect how an X509
  1257. * certificate in a CERTS cell is interpreted and used.
  1258. *
  1259. * @{ */
  1260. /** A certificate that authenticates a TLS link key. The subject key
  1261. * must match the key used in the TLS handshake; it must be signed by
  1262. * the identity key. */
  1263. #define OR_CERT_TYPE_TLS_LINK 1
  1264. /** A self-signed identity certificate. The subject key must be a
  1265. * 1024-bit RSA key. */
  1266. #define OR_CERT_TYPE_ID_1024 2
  1267. /** A certificate that authenticates a key used in an AUTHENTICATE cell
  1268. * in the v3 handshake. The subject key must be a 1024-bit RSA key; it
  1269. * must be signed by the identity key */
  1270. #define OR_CERT_TYPE_AUTH_1024 3
  1271. /* DOCDOC */
  1272. #define OR_CERT_TYPE_RSA_ED_CROSSCERT 7
  1273. /**@}*/
  1274. /** The first supported type of AUTHENTICATE cell. It contains
  1275. * a bunch of structures signed with an RSA1024 key. The signed
  1276. * structures include a HMAC using negotiated TLS secrets, and a digest
  1277. * of all cells sent or received before the AUTHENTICATE cell (including
  1278. * the random server-generated AUTH_CHALLENGE cell).
  1279. */
  1280. #define AUTHTYPE_RSA_SHA256_TLSSECRET 1
  1281. /** As AUTHTYPE_RSA_SHA256_TLSSECRET, but instead of using the
  1282. * negotiated TLS secrets, uses exported keying material from the TLS
  1283. * session as described in RFC 5705.
  1284. *
  1285. * Not used by today's tors, since everything that supports this
  1286. * also supports ED25519_SHA256_5705, which is better.
  1287. **/
  1288. #define AUTHTYPE_RSA_SHA256_RFC5705 2
  1289. /** As AUTHTYPE_RSA_SHA256_RFC5705, but uses an Ed25519 identity key to
  1290. * authenticate. */
  1291. #define AUTHTYPE_ED25519_SHA256_RFC5705 3
  1292. /*
  1293. * NOTE: authchallenge_type_is_better() relies on these AUTHTYPE codes
  1294. * being sorted in order of preference. If we someday add one with
  1295. * a higher numerical value that we don't like as much, we should revise
  1296. * authchallenge_type_is_better().
  1297. */
  1298. /** The length of the part of the AUTHENTICATE cell body that the client and
  1299. * server can generate independently (when using RSA_SHA256_TLSSECRET). It
  1300. * contains everything except the client's timestamp, the client's randomly
  1301. * generated nonce, and the signature. */
  1302. #define V3_AUTH_FIXED_PART_LEN (8+(32*6))
  1303. /** The length of the part of the AUTHENTICATE cell body that the client
  1304. * signs. */
  1305. #define V3_AUTH_BODY_LEN (V3_AUTH_FIXED_PART_LEN + 8 + 16)
  1306. /** Structure to hold all the certificates we've received on an OR connection
  1307. */
  1308. typedef struct or_handshake_certs_t {
  1309. /** True iff we originated this connection. */
  1310. int started_here;
  1311. /** The cert for the 'auth' RSA key that's supposed to sign the AUTHENTICATE
  1312. * cell. Signed with the RSA identity key. */
  1313. tor_x509_cert_t *auth_cert;
  1314. /** The cert for the 'link' RSA key that was used to negotiate the TLS
  1315. * connection. Signed with the RSA identity key. */
  1316. tor_x509_cert_t *link_cert;
  1317. /** A self-signed identity certificate: the RSA identity key signed
  1318. * with itself. */
  1319. tor_x509_cert_t *id_cert;
  1320. /** The Ed25519 signing key, signed with the Ed25519 identity key. */
  1321. struct tor_cert_st *ed_id_sign;
  1322. /** A digest of the X509 link certificate for the TLS connection, signed
  1323. * with the Ed25519 siging key. */
  1324. struct tor_cert_st *ed_sign_link;
  1325. /** The Ed25519 authentication key (that's supposed to sign an AUTHENTICATE
  1326. * cell) , signed with the Ed25519 siging key. */
  1327. struct tor_cert_st *ed_sign_auth;
  1328. /** The Ed25519 identity key, crosssigned with the RSA identity key. */
  1329. uint8_t *ed_rsa_crosscert;
  1330. /** The length of <b>ed_rsa_crosscert</b> in bytes */
  1331. size_t ed_rsa_crosscert_len;
  1332. } or_handshake_certs_t;
  1333. /** Stores flags and information related to the portion of a v2/v3 Tor OR
  1334. * connection handshake that happens after the TLS handshake is finished.
  1335. */
  1336. typedef struct or_handshake_state_t {
  1337. /** When was the VERSIONS cell sent on this connection? Used to get
  1338. * an estimate of the skew in the returning NETINFO reply. */
  1339. time_t sent_versions_at;
  1340. /** True iff we originated this connection */
  1341. unsigned int started_here : 1;
  1342. /** True iff we have received and processed a VERSIONS cell. */
  1343. unsigned int received_versions : 1;
  1344. /** True iff we have received and processed an AUTH_CHALLENGE cell */
  1345. unsigned int received_auth_challenge : 1;
  1346. /** True iff we have received and processed a CERTS cell. */
  1347. unsigned int received_certs_cell : 1;
  1348. /** True iff we have received and processed an AUTHENTICATE cell */
  1349. unsigned int received_authenticate : 1;
  1350. /* True iff we've received valid authentication to some identity. */
  1351. unsigned int authenticated : 1;
  1352. unsigned int authenticated_rsa : 1;
  1353. unsigned int authenticated_ed25519 : 1;
  1354. /* True iff we have sent a netinfo cell */
  1355. unsigned int sent_netinfo : 1;
  1356. /** The signing->ed25519 link certificate corresponding to the x509
  1357. * certificate we used on the TLS connection (if this is a server-side
  1358. * connection). We make a copy of this here to prevent a race condition
  1359. * caused by TLS context rotation. */
  1360. struct tor_cert_st *own_link_cert;
  1361. /** True iff we should feed outgoing cells into digest_sent and
  1362. * digest_received respectively.
  1363. *
  1364. * From the server's side of the v3 handshake, we want to capture everything
  1365. * from the VERSIONS cell through and including the AUTH_CHALLENGE cell.
  1366. * From the client's, we want to capture everything from the VERSIONS cell
  1367. * through but *not* including the AUTHENTICATE cell.
  1368. *
  1369. * @{ */
  1370. unsigned int digest_sent_data : 1;
  1371. unsigned int digest_received_data : 1;
  1372. /**@}*/
  1373. /** Identity RSA digest that we have received and authenticated for our peer
  1374. * on this connection. */
  1375. uint8_t authenticated_rsa_peer_id[DIGEST_LEN];
  1376. /** Identity Ed25519 public key that we have received and authenticated for
  1377. * our peer on this connection. */
  1378. ed25519_public_key_t authenticated_ed25519_peer_id;
  1379. /** Digests of the cells that we have sent or received as part of a V3
  1380. * handshake. Used for making and checking AUTHENTICATE cells.
  1381. *
  1382. * @{
  1383. */
  1384. crypto_digest_t *digest_sent;
  1385. crypto_digest_t *digest_received;
  1386. /** @} */
  1387. /** Certificates that a connection initiator sent us in a CERTS cell; we're
  1388. * holding on to them until we get an AUTHENTICATE cell.
  1389. */
  1390. or_handshake_certs_t *certs;
  1391. } or_handshake_state_t;
  1392. /** Length of Extended ORPort connection identifier. */
  1393. #define EXT_OR_CONN_ID_LEN DIGEST_LEN /* 20 */
  1394. /*
  1395. * OR_CONN_HIGHWATER and OR_CONN_LOWWATER moved from connection_or.c so
  1396. * channeltls.c can see them too.
  1397. */
  1398. /** When adding cells to an OR connection's outbuf, keep adding until the
  1399. * outbuf is at least this long, or we run out of cells. */
  1400. #define OR_CONN_HIGHWATER (32*1024)
  1401. /** Add cells to an OR connection's outbuf whenever the outbuf's data length
  1402. * drops below this size. */
  1403. #define OR_CONN_LOWWATER (16*1024)
  1404. /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
  1405. * cells over TLS. */
  1406. typedef struct or_connection_t {
  1407. connection_t base_;
  1408. /** Hash of the public RSA key for the other side's identity key, or zeroes
  1409. * if the other side hasn't shown us a valid identity key. */
  1410. char identity_digest[DIGEST_LEN];
  1411. /** Extended ORPort connection identifier. */
  1412. char *ext_or_conn_id;
  1413. /** This is the ClientHash value we expect to receive from the
  1414. * client during the Extended ORPort authentication protocol. We
  1415. * compute it upon receiving the ClientNoce from the client, and we
  1416. * compare it with the acual ClientHash value sent by the
  1417. * client. */
  1418. char *ext_or_auth_correct_client_hash;
  1419. /** String carrying the name of the pluggable transport
  1420. * (e.g. "obfs2") that is obfuscating this connection. If no
  1421. * pluggable transports are used, it's NULL. */
  1422. char *ext_or_transport;
  1423. char *nickname; /**< Nickname of OR on other side (if any). */
  1424. tor_tls_t *tls; /**< TLS connection state. */
  1425. int tls_error; /**< Last tor_tls error code. */
  1426. /** When we last used this conn for any client traffic. If not
  1427. * recent, we can rate limit it further. */
  1428. /* Channel using this connection */
  1429. channel_tls_t *chan;
  1430. tor_addr_t real_addr; /**< The actual address that this connection came from
  1431. * or went to. The <b>addr</b> field is prone to
  1432. * getting overridden by the address from the router
  1433. * descriptor matching <b>identity_digest</b>. */
  1434. /** Should this connection be used for extending circuits to the server
  1435. * matching the <b>identity_digest</b> field? Set to true if we're pretty
  1436. * sure we aren't getting MITMed, either because we're connected to an
  1437. * address listed in a server descriptor, or because an authenticated
  1438. * NETINFO cell listed the address we're connected to as recognized. */
  1439. unsigned int is_canonical:1;
  1440. /** True iff this is an outgoing connection. */
  1441. unsigned int is_outgoing:1;
  1442. unsigned int proxy_type:2; /**< One of PROXY_NONE...PROXY_SOCKS5 */
  1443. unsigned int wide_circ_ids:1;
  1444. /** True iff this connection has had its bootstrap failure logged with
  1445. * control_event_bootstrap_problem. */
  1446. unsigned int have_noted_bootstrap_problem:1;
  1447. /** True iff this is a client connection and its address has been put in the
  1448. * geoip cache and handled by the DoS mitigation subsystem. We use this to
  1449. * insure we have a coherent count of concurrent connection. */
  1450. unsigned int tracked_for_dos_mitigation : 1;
  1451. uint16_t link_proto; /**< What protocol version are we using? 0 for
  1452. * "none negotiated yet." */
  1453. uint16_t idle_timeout; /**< How long can this connection sit with no
  1454. * circuits on it before we close it? Based on
  1455. * IDLE_CIRCUIT_TIMEOUT_{NON,}CANONICAL and
  1456. * on is_canonical, randomized. */
  1457. or_handshake_state_t *handshake_state; /**< If we are setting this connection
  1458. * up, state information to do so. */
  1459. time_t timestamp_lastempty; /**< When was the outbuf last completely empty?*/
  1460. /* bandwidth* and *_bucket only used by ORs in OPEN state: */
  1461. int bandwidthrate; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
  1462. int bandwidthburst; /**< Max bucket size for this conn. (OPEN ORs only.) */
  1463. int read_bucket; /**< When this hits 0, stop receiving. Every second we
  1464. * add 'bandwidthrate' to this, capping it at
  1465. * bandwidthburst. (OPEN ORs only) */
  1466. int write_bucket; /**< When this hits 0, stop writing. Like read_bucket. */
  1467. /** Last emptied read token bucket in msec since midnight; only used if
  1468. * TB_EMPTY events are enabled. */
  1469. uint32_t read_emptied_time;
  1470. /** Last emptied write token bucket in msec since midnight; only used if
  1471. * TB_EMPTY events are enabled. */
  1472. uint32_t write_emptied_time;
  1473. /*
  1474. * Count the number of bytes flushed out on this orconn, and the number of
  1475. * bytes TLS actually sent - used for overhead estimation for scheduling.
  1476. */
  1477. uint64_t bytes_xmitted, bytes_xmitted_by_tls;
  1478. } or_connection_t;
  1479. /** Subtype of connection_t for an "edge connection" -- that is, an entry (ap)
  1480. * connection, or an exit. */
  1481. typedef struct edge_connection_t {
  1482. connection_t base_;
  1483. struct edge_connection_t *next_stream; /**< Points to the next stream at this
  1484. * edge, if any */
  1485. int package_window; /**< How many more relay cells can I send into the
  1486. * circuit? */
  1487. int deliver_window; /**< How many more relay cells can end at me? */
  1488. struct circuit_t *on_circuit; /**< The circuit (if any) that this edge
  1489. * connection is using. */
  1490. /** A pointer to which node in the circ this conn exits at. Set for AP
  1491. * connections and for hidden service exit connections. */
  1492. struct crypt_path_t *cpath_layer;
  1493. /** What rendezvous service are we querying for (if an AP) or providing (if
  1494. * an exit)? */
  1495. rend_data_t *rend_data;
  1496. /* Hidden service connection identifier for edge connections. Used by the HS
  1497. * client-side code to identify client SOCKS connections and by the
  1498. * service-side code to match HS circuits with their streams. */
  1499. struct hs_ident_edge_conn_t *hs_ident;
  1500. uint32_t address_ttl; /**< TTL for address-to-addr mapping on exit
  1501. * connection. Exit connections only. */
  1502. uint32_t begincell_flags; /** Flags sent or received in the BEGIN cell
  1503. * for this connection */
  1504. streamid_t stream_id; /**< The stream ID used for this edge connection on its
  1505. * circuit */
  1506. /** The reason why this connection is closing; passed to the controller. */
  1507. uint16_t end_reason;
  1508. /** Bytes read since last call to control_event_stream_bandwidth_used() */
  1509. uint32_t n_read;
  1510. /** Bytes written since last call to control_event_stream_bandwidth_used() */
  1511. uint32_t n_written;
  1512. /** True iff this connection is for a DNS request only. */
  1513. unsigned int is_dns_request:1;
  1514. /** True iff this connection is for a PTR DNS request. (exit only) */
  1515. unsigned int is_reverse_dns_lookup:1;
  1516. unsigned int edge_has_sent_end:1; /**< For debugging; only used on edge
  1517. * connections. Set once we've set the stream end,
  1518. * and check in connection_about_to_close_connection().
  1519. */
  1520. /** True iff we've blocked reading until the circuit has fewer queued
  1521. * cells. */
  1522. unsigned int edge_blocked_on_circ:1;
  1523. /** Unique ID for directory requests; this used to be in connection_t, but
  1524. * that's going away and being used on channels instead. We still tag
  1525. * edge connections with dirreq_id from circuits, so it's copied here. */
  1526. uint64_t dirreq_id;
  1527. } edge_connection_t;
  1528. /** Subtype of edge_connection_t for an "entry connection" -- that is, a SOCKS
  1529. * connection, a DNS request, a TransPort connection or a NATD connection */
  1530. typedef struct entry_connection_t {
  1531. edge_connection_t edge_;
  1532. /** Nickname of planned exit node -- used with .exit support. */
  1533. /* XXX prop220: we need to make chosen_exit_name able to encode Ed IDs too.
  1534. * That's logically part of the UI parts for prop220 though. */
  1535. char *chosen_exit_name;
  1536. socks_request_t *socks_request; /**< SOCKS structure describing request (AP
  1537. * only.) */
  1538. /* === Isolation related, AP only. === */
  1539. entry_port_cfg_t entry_cfg;
  1540. /** AP only: The newnym epoch in which we created this connection. */
  1541. unsigned nym_epoch;
  1542. /** AP only: The original requested address before we rewrote it. */
  1543. char *original_dest_address;
  1544. /* Other fields to isolate on already exist. The ClientAddr is addr. The
  1545. ClientProtocol is a combination of type and socks_request->
  1546. socks_version. SocksAuth is socks_request->username/password.
  1547. DestAddr is in socks_request->address. */
  1548. /** Number of times we've reassigned this application connection to
  1549. * a new circuit. We keep track because the timeout is longer if we've
  1550. * already retried several times. */
  1551. uint8_t num_socks_retries;
  1552. /** For AP connections only: buffer for data that we have sent
  1553. * optimistically, which we might need to re-send if we have to
  1554. * retry this connection. */
  1555. struct buf_t *pending_optimistic_data;
  1556. /* For AP connections only: buffer for data that we previously sent
  1557. * optimistically which we are currently re-sending as we retry this
  1558. * connection. */
  1559. struct buf_t *sending_optimistic_data;
  1560. /** If this is a DNSPort connection, this field holds the pending DNS
  1561. * request that we're going to try to answer. */
  1562. struct evdns_server_request *dns_server_request;
  1563. #define DEBUGGING_17659
  1564. #ifdef DEBUGGING_17659
  1565. uint16_t marked_pending_circ_line;
  1566. const char *marked_pending_circ_file;
  1567. #endif
  1568. #define NUM_CIRCUITS_LAUNCHED_THRESHOLD 10
  1569. /** Number of times we've launched a circuit to handle this stream. If
  1570. * it gets too high, that could indicate an inconsistency between our
  1571. * "launch a circuit to handle this stream" logic and our "attach our
  1572. * stream to one of the available circuits" logic. */
  1573. unsigned int num_circuits_launched:4;
  1574. /** True iff this stream must attach to a one-hop circuit (e.g. for
  1575. * begin_dir). */
  1576. unsigned int want_onehop:1;
  1577. /** True iff this stream should use a BEGIN_DIR relay command to establish
  1578. * itself rather than BEGIN (either via onehop or via a whole circuit). */
  1579. unsigned int use_begindir:1;
  1580. /** For AP connections only. If 1, and we fail to reach the chosen exit,
  1581. * stop requiring it. */
  1582. unsigned int chosen_exit_optional:1;
  1583. /** For AP connections only. If non-zero, this exit node was picked as
  1584. * a result of the TrackHostExit, and the value decrements every time
  1585. * we fail to complete a circuit to our chosen exit -- if it reaches
  1586. * zero, abandon the associated mapaddress. */
  1587. unsigned int chosen_exit_retries:3;
  1588. /** True iff this is an AP connection that came from a transparent or
  1589. * NATd connection */
  1590. unsigned int is_transparent_ap:1;
  1591. /** For AP connections only: Set if this connection's target exit node
  1592. * allows optimistic data (that is, data sent on this stream before
  1593. * the exit has sent a CONNECTED cell) and we have chosen to use it.
  1594. */
  1595. unsigned int may_use_optimistic_data : 1;
  1596. /** Are we a socks SocksSocket listener? */
  1597. unsigned int is_socks_socket:1;
  1598. } entry_connection_t;
  1599. /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
  1600. * connection to retrieve or serve directory material. */
  1601. typedef struct dir_connection_t {
  1602. connection_t base_;
  1603. /** Which 'resource' did we ask the directory for? This is typically the part
  1604. * of the URL string that defines, relative to the directory conn purpose,
  1605. * what thing we want. For example, in router descriptor downloads by
  1606. * descriptor digest, it contains "d/", then one or more +-separated
  1607. * fingerprints.
  1608. **/
  1609. char *requested_resource;
  1610. unsigned int dirconn_direct:1; /**< Is this dirconn direct, or via Tor? */
  1611. /** If we're fetching descriptors, what router purpose shall we assign
  1612. * to them? */
  1613. uint8_t router_purpose;
  1614. /** List of spooled_resource_t for objects that we're spooling. We use
  1615. * it from back to front. */
  1616. smartlist_t *spool;
  1617. /** The compression object doing on-the-fly compression for spooled data. */
  1618. tor_compress_state_t *compress_state;
  1619. /** What rendezvous service are we querying for? */
  1620. rend_data_t *rend_data;
  1621. /* Hidden service connection identifier for dir connections: Used by HS
  1622. client-side code to fetch HS descriptors, and by the service-side code to
  1623. upload descriptors. */
  1624. struct hs_ident_dir_conn_t *hs_ident;
  1625. /** If this is a one-hop connection, tracks the state of the directory guard
  1626. * for this connection (if any). */
  1627. struct circuit_guard_state_t *guard_state;
  1628. char identity_digest[DIGEST_LEN]; /**< Hash of the public RSA key for
  1629. * the directory server's signing key. */
  1630. /** Unique ID for directory requests; this used to be in connection_t, but
  1631. * that's going away and being used on channels instead. The dirserver still
  1632. * needs this for the incoming side, so it's moved here. */
  1633. uint64_t dirreq_id;
  1634. #ifdef MEASUREMENTS_21206
  1635. /** Number of RELAY_DATA cells received. */
  1636. uint32_t data_cells_received;
  1637. /** Number of RELAY_DATA cells sent. */
  1638. uint32_t data_cells_sent;
  1639. #endif /* defined(MEASUREMENTS_21206) */
  1640. } dir_connection_t;
  1641. /** Subtype of connection_t for an connection to a controller. */
  1642. typedef struct control_connection_t {
  1643. connection_t base_;
  1644. uint64_t event_mask; /**< Bitfield: which events does this controller
  1645. * care about?
  1646. * EVENT_MAX_ is >31, so we need a 64 bit mask */
  1647. /** True if we have sent a protocolinfo reply on this connection. */
  1648. unsigned int have_sent_protocolinfo:1;
  1649. /** True if we have received a takeownership command on this
  1650. * connection. */
  1651. unsigned int is_owning_control_connection:1;
  1652. /** List of ephemeral onion services belonging to this connection. */
  1653. smartlist_t *ephemeral_onion_services;
  1654. /** If we have sent an AUTHCHALLENGE reply on this connection and
  1655. * have not received a successful AUTHENTICATE command, points to
  1656. * the value which the client must send to authenticate itself;
  1657. * otherwise, NULL. */
  1658. char *safecookie_client_hash;
  1659. /** Amount of space allocated in incoming_cmd. */
  1660. uint32_t incoming_cmd_len;
  1661. /** Number of bytes currently stored in incoming_cmd. */
  1662. uint32_t incoming_cmd_cur_len;
  1663. /** A control command that we're reading from the inbuf, but which has not
  1664. * yet arrived completely. */
  1665. char *incoming_cmd;
  1666. } control_connection_t;
  1667. /** Cast a connection_t subtype pointer to a connection_t **/
  1668. #define TO_CONN(c) (&(((c)->base_)))
  1669. /** Cast a entry_connection_t subtype pointer to a edge_connection_t **/
  1670. #define ENTRY_TO_EDGE_CONN(c) (&(((c))->edge_))
  1671. /** Cast a entry_connection_t subtype pointer to a connection_t **/
  1672. #define ENTRY_TO_CONN(c) (TO_CONN(ENTRY_TO_EDGE_CONN(c)))
  1673. /** Convert a connection_t* to an or_connection_t*; assert if the cast is
  1674. * invalid. */
  1675. static or_connection_t *TO_OR_CONN(connection_t *);
  1676. /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
  1677. * invalid. */
  1678. static dir_connection_t *TO_DIR_CONN(connection_t *);
  1679. /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
  1680. * invalid. */
  1681. static edge_connection_t *TO_EDGE_CONN(connection_t *);
  1682. /** Convert a connection_t* to an entry_connection_t*; assert if the cast is
  1683. * invalid. */
  1684. static entry_connection_t *TO_ENTRY_CONN(connection_t *);
  1685. /** Convert a edge_connection_t* to an entry_connection_t*; assert if the cast
  1686. * is invalid. */
  1687. static entry_connection_t *EDGE_TO_ENTRY_CONN(edge_connection_t *);
  1688. /** Convert a connection_t* to an control_connection_t*; assert if the cast is
  1689. * invalid. */
  1690. static control_connection_t *TO_CONTROL_CONN(connection_t *);
  1691. /** Convert a connection_t* to an listener_connection_t*; assert if the cast is
  1692. * invalid. */
  1693. static listener_connection_t *TO_LISTENER_CONN(connection_t *);
  1694. static inline or_connection_t *TO_OR_CONN(connection_t *c)
  1695. {
  1696. tor_assert(c->magic == OR_CONNECTION_MAGIC);
  1697. return DOWNCAST(or_connection_t, c);
  1698. }
  1699. static inline dir_connection_t *TO_DIR_CONN(connection_t *c)
  1700. {
  1701. tor_assert(c->magic == DIR_CONNECTION_MAGIC);
  1702. return DOWNCAST(dir_connection_t, c);
  1703. }
  1704. static inline edge_connection_t *TO_EDGE_CONN(connection_t *c)
  1705. {
  1706. tor_assert(c->magic == EDGE_CONNECTION_MAGIC ||
  1707. c->magic == ENTRY_CONNECTION_MAGIC);
  1708. return DOWNCAST(edge_connection_t, c);
  1709. }
  1710. static inline entry_connection_t *TO_ENTRY_CONN(connection_t *c)
  1711. {
  1712. tor_assert(c->magic == ENTRY_CONNECTION_MAGIC);
  1713. return (entry_connection_t*) SUBTYPE_P(c, entry_connection_t, edge_.base_);
  1714. }
  1715. static inline entry_connection_t *EDGE_TO_ENTRY_CONN(edge_connection_t *c)
  1716. {
  1717. tor_assert(c->base_.magic == ENTRY_CONNECTION_MAGIC);
  1718. return (entry_connection_t*) SUBTYPE_P(c, entry_connection_t, edge_);
  1719. }
  1720. static inline control_connection_t *TO_CONTROL_CONN(connection_t *c)
  1721. {
  1722. tor_assert(c->magic == CONTROL_CONNECTION_MAGIC);
  1723. return DOWNCAST(control_connection_t, c);
  1724. }
  1725. static inline listener_connection_t *TO_LISTENER_CONN(connection_t *c)
  1726. {
  1727. tor_assert(c->magic == LISTENER_CONNECTION_MAGIC);
  1728. return DOWNCAST(listener_connection_t, c);
  1729. }
  1730. /** What action type does an address policy indicate: accept or reject? */
  1731. typedef enum {
  1732. ADDR_POLICY_ACCEPT=1,
  1733. ADDR_POLICY_REJECT=2,
  1734. } addr_policy_action_t;
  1735. #define addr_policy_action_bitfield_t ENUM_BF(addr_policy_action_t)
  1736. /** A reference-counted address policy rule. */
  1737. typedef struct addr_policy_t {
  1738. int refcnt; /**< Reference count */
  1739. /** What to do when the policy matches.*/
  1740. addr_policy_action_bitfield_t policy_type:2;
  1741. unsigned int is_private:1; /**< True iff this is the pseudo-address,
  1742. * "private". */
  1743. unsigned int is_canonical:1; /**< True iff this policy is the canonical
  1744. * copy (stored in a hash table to avoid
  1745. * duplication of common policies) */
  1746. maskbits_t maskbits; /**< Accept/reject all addresses <b>a</b> such that the
  1747. * first <b>maskbits</b> bits of <b>a</b> match
  1748. * <b>addr</b>. */
  1749. /** Base address to accept or reject.
  1750. *
  1751. * Note that wildcards are treated
  1752. * differntly depending on address family. An AF_UNSPEC address means
  1753. * "All addresses, IPv4 or IPv6." An AF_INET address with maskbits==0 means
  1754. * "All IPv4 addresses" and an AF_INET6 address with maskbits == 0 means
  1755. * "All IPv6 addresses".
  1756. **/
  1757. tor_addr_t addr;
  1758. uint16_t prt_min; /**< Lowest port number to accept/reject. */
  1759. uint16_t prt_max; /**< Highest port number to accept/reject. */
  1760. } addr_policy_t;
  1761. /** A cached_dir_t represents a cacheable directory object, along with its
  1762. * compressed form. */
  1763. typedef struct cached_dir_t {
  1764. char *dir; /**< Contents of this object, NUL-terminated. */
  1765. char *dir_compressed; /**< Compressed contents of this object. */
  1766. size_t dir_len; /**< Length of <b>dir</b> (not counting its NUL). */
  1767. size_t dir_compressed_len; /**< Length of <b>dir_compressed</b>. */
  1768. time_t published; /**< When was this object published. */
  1769. common_digests_t digests; /**< Digests of this object (networkstatus only) */
  1770. /** Sha3 digest (also ns only) */
  1771. uint8_t digest_sha3_as_signed[DIGEST256_LEN];
  1772. int refcnt; /**< Reference count for this cached_dir_t. */
  1773. } cached_dir_t;
  1774. /** Enum used to remember where a signed_descriptor_t is stored and how to
  1775. * manage the memory for signed_descriptor_body. */
  1776. typedef enum {
  1777. /** The descriptor isn't stored on disk at all: the copy in memory is
  1778. * canonical; the saved_offset field is meaningless. */
  1779. SAVED_NOWHERE=0,
  1780. /** The descriptor is stored in the cached_routers file: the
  1781. * signed_descriptor_body is meaningless; the signed_descriptor_len and
  1782. * saved_offset are used to index into the mmaped cache file. */
  1783. SAVED_IN_CACHE,
  1784. /** The descriptor is stored in the cached_routers.new file: the
  1785. * signed_descriptor_body and saved_offset fields are both set. */
  1786. /* FFFF (We could also mmap the file and grow the mmap as needed, or
  1787. * lazy-load the descriptor text by using seek and read. We don't, for
  1788. * now.)
  1789. */
  1790. SAVED_IN_JOURNAL
  1791. } saved_location_t;
  1792. #define saved_location_bitfield_t ENUM_BF(saved_location_t)
  1793. /** Enumeration: what directory object is being downloaded?
  1794. * This determines which schedule is selected to perform the download. */
  1795. typedef enum {
  1796. DL_SCHED_GENERIC = 0,
  1797. DL_SCHED_CONSENSUS = 1,
  1798. DL_SCHED_BRIDGE = 2,
  1799. } download_schedule_t;
  1800. #define download_schedule_bitfield_t ENUM_BF(download_schedule_t)
  1801. /** Enumeration: is the download schedule for downloading from an authority,
  1802. * or from any available directory mirror?
  1803. * During bootstrap, "any" means a fallback (or an authority, if there
  1804. * are no fallbacks).
  1805. * When we have a valid consensus, "any" means any directory server. */
  1806. typedef enum {
  1807. DL_WANT_ANY_DIRSERVER = 0,
  1808. DL_WANT_AUTHORITY = 1,
  1809. } download_want_authority_t;
  1810. #define download_want_authority_bitfield_t \
  1811. ENUM_BF(download_want_authority_t)
  1812. /** Enumeration: do we want to increment the schedule position each time a
  1813. * connection is attempted (these attempts can be concurrent), or do we want
  1814. * to increment the schedule position after a connection fails? */
  1815. typedef enum {
  1816. DL_SCHED_INCREMENT_FAILURE = 0,
  1817. DL_SCHED_INCREMENT_ATTEMPT = 1,
  1818. } download_schedule_increment_t;
  1819. #define download_schedule_increment_bitfield_t \
  1820. ENUM_BF(download_schedule_increment_t)
  1821. /** Enumeration: do we want to use the random exponential backoff
  1822. * mechanism? */
  1823. typedef enum {
  1824. DL_SCHED_DETERMINISTIC = 0,
  1825. DL_SCHED_RANDOM_EXPONENTIAL = 1,
  1826. } download_schedule_backoff_t;
  1827. #define download_schedule_backoff_bitfield_t \
  1828. ENUM_BF(download_schedule_backoff_t)
  1829. /** Information about our plans for retrying downloads for a downloadable
  1830. * directory object.
  1831. * Each type of downloadable directory object has a corresponding retry
  1832. * <b>schedule</b>, which can be different depending on whether the object is
  1833. * being downloaded from an authority or a mirror (<b>want_authority</b>).
  1834. * <b>next_attempt_at</b> contains the next time we will attempt to download
  1835. * the object.
  1836. * For schedules that <b>increment_on</b> failure, <b>n_download_failures</b>
  1837. * is used to determine the position in the schedule. (Each schedule is a
  1838. * smartlist of integer delays, parsed from a CSV option.) Every time a
  1839. * connection attempt fails, <b>n_download_failures</b> is incremented,
  1840. * the new delay value is looked up from the schedule, and
  1841. * <b>next_attempt_at</b> is set delay seconds from the time the previous
  1842. * connection failed. Therefore, at most one failure-based connection can be
  1843. * in progress for each download_status_t.
  1844. * For schedules that <b>increment_on</b> attempt, <b>n_download_attempts</b>
  1845. * is used to determine the position in the schedule. Every time a
  1846. * connection attempt is made, <b>n_download_attempts</b> is incremented,
  1847. * the new delay value is looked up from the schedule, and
  1848. * <b>next_attempt_at</b> is set delay seconds from the time the previous
  1849. * connection was attempted. Therefore, multiple concurrent attempted-based
  1850. * connections can be in progress for each download_status_t.
  1851. * After an object is successfully downloaded, any other concurrent connections
  1852. * are terminated. A new schedule which starts at position 0 is used for
  1853. * subsequent downloads of the same object.
  1854. */
  1855. typedef struct download_status_t {
  1856. time_t next_attempt_at; /**< When should we try downloading this object
  1857. * again? */
  1858. uint8_t n_download_failures; /**< Number of failed downloads of the most
  1859. * recent object, since the last success. */
  1860. uint8_t n_download_attempts; /**< Number of (potentially concurrent) attempts
  1861. * to download the most recent object, since
  1862. * the last success. */
  1863. download_schedule_bitfield_t schedule : 8; /**< What kind of object is being
  1864. * downloaded? This determines the
  1865. * schedule used for the download.
  1866. */
  1867. download_want_authority_bitfield_t want_authority : 1; /**< Is the download
  1868. * happening from an authority
  1869. * or a mirror? This determines
  1870. * the schedule used for the
  1871. * download. */
  1872. download_schedule_increment_bitfield_t increment_on : 1; /**< does this
  1873. * schedule increment on each attempt,
  1874. * or after each failure? */
  1875. download_schedule_backoff_bitfield_t backoff : 1; /**< do we use the
  1876. * deterministic schedule, or random
  1877. * exponential backoffs?
  1878. * Increment on failure schedules
  1879. * always use exponential backoff. */
  1880. uint8_t last_backoff_position; /**< number of attempts/failures, depending
  1881. * on increment_on, when we last recalculated
  1882. * the delay. Only updated if backoff
  1883. * == 1. */
  1884. int last_delay_used; /**< last delay used for random exponential backoff;
  1885. * only updated if backoff == 1 */
  1886. } download_status_t;
  1887. /** If n_download_failures is this high, the download can never happen. */
  1888. #define IMPOSSIBLE_TO_DOWNLOAD 255
  1889. /** The max size we expect router descriptor annotations we create to
  1890. * be. We'll accept larger ones if we see them on disk, but we won't
  1891. * create any that are larger than this. */
  1892. #define ROUTER_ANNOTATION_BUF_LEN 256
  1893. /** Information need to cache an onion router's descriptor. */
  1894. typedef struct signed_descriptor_t {
  1895. /** Pointer to the raw server descriptor, preceded by annotations. Not
  1896. * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
  1897. * pointer is null. */
  1898. char *signed_descriptor_body;
  1899. /** Length of the annotations preceding the server descriptor. */
  1900. size_t annotations_len;
  1901. /** Length of the server descriptor. */
  1902. size_t signed_descriptor_len;
  1903. /** Digest of the server descriptor, computed as specified in
  1904. * dir-spec.txt. */
  1905. char signed_descriptor_digest[DIGEST_LEN];
  1906. /** Identity digest of the router. */
  1907. char identity_digest[DIGEST_LEN];
  1908. /** Declared publication time of the descriptor. */
  1909. time_t published_on;
  1910. /** For routerdescs only: digest of the corresponding extrainfo. */
  1911. char extra_info_digest[DIGEST_LEN];
  1912. /** For routerdescs only: A SHA256-digest of the extrainfo (if any) */
  1913. char extra_info_digest256[DIGEST256_LEN];
  1914. /** Certificate for ed25519 signing key. */
  1915. struct tor_cert_st *signing_key_cert;
  1916. /** For routerdescs only: Status of downloading the corresponding
  1917. * extrainfo. */
  1918. download_status_t ei_dl_status;
  1919. /** Where is the descriptor saved? */
  1920. saved_location_t saved_location;
  1921. /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
  1922. * this descriptor in the corresponding file. */
  1923. off_t saved_offset;
  1924. /** What position is this descriptor within routerlist->routers or
  1925. * routerlist->old_routers? -1 for none. */
  1926. int routerlist_index;
  1927. /** The valid-until time of the most recent consensus that listed this
  1928. * descriptor. 0 for "never listed in a consensus, so far as we know." */
  1929. time_t last_listed_as_valid_until;
  1930. /* If true, we do not ever try to save this object in the cache. */
  1931. unsigned int do_not_cache : 1;
  1932. /* If true, this item is meant to represent an extrainfo. */
  1933. unsigned int is_extrainfo : 1;
  1934. /* If true, we got an extrainfo for this item, and the digest was right,
  1935. * but it was incompatible. */
  1936. unsigned int extrainfo_is_bogus : 1;
  1937. /* If true, we are willing to transmit this item unencrypted. */
  1938. unsigned int send_unencrypted : 1;
  1939. } signed_descriptor_t;
  1940. /** A signed integer representing a country code. */
  1941. typedef int16_t country_t;
  1942. /** Flags used to summarize the declared protocol versions of a relay,
  1943. * so we don't need to parse them again and again. */
  1944. typedef struct protover_summary_flags_t {
  1945. /** True iff we have a proto line for this router, or a versions line
  1946. * from which we could infer the protocols. */
  1947. unsigned int protocols_known:1;
  1948. /** True iff this router has a version or protocol list that allows it to
  1949. * accept EXTEND2 cells. This requires Relay=2. */
  1950. unsigned int supports_extend2_cells:1;
  1951. /** True iff this router has a protocol list that allows it to negotiate
  1952. * ed25519 identity keys on a link handshake with us. This
  1953. * requires LinkAuth=3. */
  1954. unsigned int supports_ed25519_link_handshake_compat:1;
  1955. /** True iff this router has a protocol list that allows it to negotiate
  1956. * ed25519 identity keys on a link handshake, at all. This requires some
  1957. * LinkAuth=X for X >= 3. */
  1958. unsigned int supports_ed25519_link_handshake_any:1;
  1959. /** True iff this router has a protocol list that allows it to be an
  1960. * introduction point supporting ed25519 authentication key which is part of
  1961. * the v3 protocol detailed in proposal 224. This requires HSIntro=4. */
  1962. unsigned int supports_ed25519_hs_intro : 1;
  1963. /** True iff this router has a protocol list that allows it to be an hidden
  1964. * service directory supporting version 3 as seen in proposal 224. This
  1965. * requires HSDir=2. */
  1966. unsigned int supports_v3_hsdir : 1;
  1967. /** True iff this router has a protocol list that allows it to be an hidden
  1968. * service rendezvous point supporting version 3 as seen in proposal 224.
  1969. * This requires HSRend=2. */
  1970. unsigned int supports_v3_rendezvous_point: 1;
  1971. } protover_summary_flags_t;
  1972. /** Information about another onion router in the network. */
  1973. typedef struct {
  1974. signed_descriptor_t cache_info;
  1975. char *nickname; /**< Human-readable OR name. */
  1976. uint32_t addr; /**< IPv4 address of OR, in host order. */
  1977. uint16_t or_port; /**< Port for TLS connections. */
  1978. uint16_t dir_port; /**< Port for HTTP directory connections. */
  1979. /** A router's IPv6 address, if it has one. */
  1980. /* XXXXX187 Actually these should probably be part of a list of addresses,
  1981. * not just a special case. Use abstractions to access these; don't do it
  1982. * directly. */
  1983. tor_addr_t ipv6_addr;
  1984. uint16_t ipv6_orport;
  1985. crypto_pk_t *onion_pkey; /**< Public RSA key for onions. */
  1986. crypto_pk_t *identity_pkey; /**< Public RSA key for signing. */
  1987. /** Public curve25519 key for onions */
  1988. curve25519_public_key_t *onion_curve25519_pkey;
  1989. /** What's the earliest expiration time on all the certs in this
  1990. * routerinfo? */
  1991. time_t cert_expiration_time;
  1992. char *platform; /**< What software/operating system is this OR using? */
  1993. char *protocol_list; /**< Encoded list of subprotocol versions supported
  1994. * by this OR */
  1995. /* link info */
  1996. uint32_t bandwidthrate; /**< How many bytes does this OR add to its token
  1997. * bucket per second? */
  1998. uint32_t bandwidthburst; /**< How large is this OR's token bucket? */
  1999. /** How many bytes/s is this router known to handle? */
  2000. uint32_t bandwidthcapacity;
  2001. smartlist_t *exit_policy; /**< What streams will this OR permit
  2002. * to exit on IPv4? NULL for 'reject *:*'. */
  2003. /** What streams will this OR permit to exit on IPv6?
  2004. * NULL for 'reject *:*' */
  2005. struct short_policy_t *ipv6_exit_policy;
  2006. long uptime; /**< How many seconds the router claims to have been up */
  2007. smartlist_t *declared_family; /**< Nicknames of router which this router
  2008. * claims are its family. */
  2009. char *contact_info; /**< Declared contact info for this router. */
  2010. unsigned int is_hibernating:1; /**< Whether the router claims to be
  2011. * hibernating */
  2012. unsigned int caches_extra_info:1; /**< Whether the router says it caches and
  2013. * serves extrainfo documents. */
  2014. unsigned int allow_single_hop_exits:1; /**< Whether the router says
  2015. * it allows single hop exits. */
  2016. unsigned int wants_to_be_hs_dir:1; /**< True iff this router claims to be
  2017. * a hidden service directory. */
  2018. unsigned int policy_is_reject_star:1; /**< True iff the exit policy for this
  2019. * router rejects everything. */
  2020. /** True if, after we have added this router, we should re-launch
  2021. * tests for it. */
  2022. unsigned int needs_retest_if_added:1;
  2023. /** True iff this router included "tunnelled-dir-server" in its descriptor,
  2024. * implying it accepts tunnelled directory requests, or it advertised
  2025. * dir_port > 0. */
  2026. unsigned int supports_tunnelled_dir_requests:1;
  2027. /** Used during voting to indicate that we should not include an entry for
  2028. * this routerinfo. Used only during voting. */
  2029. unsigned int omit_from_vote:1;
  2030. /** Flags to summarize the protocol versions for this routerinfo_t. */
  2031. protover_summary_flags_t pv;
  2032. /** Tor can use this router for general positions in circuits; we got it
  2033. * from a directory server as usual, or we're an authority and a server
  2034. * uploaded it. */
  2035. #define ROUTER_PURPOSE_GENERAL 0
  2036. /** Tor should avoid using this router for circuit-building: we got it
  2037. * from a controller. If the controller wants to use it, it'll have to
  2038. * ask for it by identity. */
  2039. #define ROUTER_PURPOSE_CONTROLLER 1
  2040. /** Tor should use this router only for bridge positions in circuits: we got
  2041. * it via a directory request from the bridge itself, or a bridge
  2042. * authority. */
  2043. #define ROUTER_PURPOSE_BRIDGE 2
  2044. /** Tor should not use this router; it was marked in cached-descriptors with
  2045. * a purpose we didn't recognize. */
  2046. #define ROUTER_PURPOSE_UNKNOWN 255
  2047. /** In what way did we find out about this router? One of ROUTER_PURPOSE_*.
  2048. * Routers of different purposes are kept segregated and used for different
  2049. * things; see notes on ROUTER_PURPOSE_* macros above.
  2050. */
  2051. uint8_t purpose;
  2052. } routerinfo_t;
  2053. /** Information needed to keep and cache a signed extra-info document. */
  2054. typedef struct extrainfo_t {
  2055. signed_descriptor_t cache_info;
  2056. /** SHA256 digest of this document */
  2057. uint8_t digest256[DIGEST256_LEN];
  2058. /** The router's nickname. */
  2059. char nickname[MAX_NICKNAME_LEN+1];
  2060. /** True iff we found the right key for this extra-info, verified the
  2061. * signature, and found it to be bad. */
  2062. unsigned int bad_sig : 1;
  2063. /** If present, we didn't have the right key to verify this extra-info,
  2064. * so this is a copy of the signature in the document. */
  2065. char *pending_sig;
  2066. /** Length of pending_sig. */
  2067. size_t pending_sig_len;
  2068. } extrainfo_t;
  2069. /** Contents of a single router entry in a network status object.
  2070. */
  2071. typedef struct routerstatus_t {
  2072. time_t published_on; /**< When was this router published? */
  2073. char nickname[MAX_NICKNAME_LEN+1]; /**< The nickname this router says it
  2074. * has. */
  2075. char identity_digest[DIGEST_LEN]; /**< Digest of the router's identity
  2076. * key. */
  2077. /** Digest of the router's most recent descriptor or microdescriptor.
  2078. * If it's a descriptor, we only use the first DIGEST_LEN bytes. */
  2079. char descriptor_digest[DIGEST256_LEN];
  2080. uint32_t addr; /**< IPv4 address for this router, in host order. */
  2081. uint16_t or_port; /**< OR port for this router. */
  2082. uint16_t dir_port; /**< Directory port for this router. */
  2083. tor_addr_t ipv6_addr; /**< IPv6 address for this router. */
  2084. uint16_t ipv6_orport; /**<IPV6 OR port for this router. */
  2085. unsigned int is_authority:1; /**< True iff this router is an authority. */
  2086. unsigned int is_exit:1; /**< True iff this router is a good exit. */
  2087. unsigned int is_stable:1; /**< True iff this router stays up a long time. */
  2088. unsigned int is_fast:1; /**< True iff this router has good bandwidth. */
  2089. /** True iff this router is called 'running' in the consensus. We give it
  2090. * this funny name so that we don't accidentally use this bit as a view of
  2091. * whether we think the router is *currently* running. If that's what you
  2092. * want to know, look at is_running in node_t. */
  2093. unsigned int is_flagged_running:1;
  2094. unsigned int is_named:1; /**< True iff "nickname" belongs to this router. */
  2095. unsigned int is_unnamed:1; /**< True iff "nickname" belongs to another
  2096. * router. */
  2097. unsigned int is_valid:1; /**< True iff this router isn't invalid. */
  2098. unsigned int is_possible_guard:1; /**< True iff this router would be a good
  2099. * choice as an entry guard. */
  2100. unsigned int is_bad_exit:1; /**< True iff this node is a bad choice for
  2101. * an exit node. */
  2102. unsigned int is_hs_dir:1; /**< True iff this router is a v2-or-later hidden
  2103. * service directory. */
  2104. unsigned int is_v2_dir:1; /** True iff this router publishes an open DirPort
  2105. * or it claims to accept tunnelled dir requests.
  2106. */
  2107. unsigned int has_bandwidth:1; /**< The vote/consensus had bw info */
  2108. unsigned int has_exitsummary:1; /**< The vote/consensus had exit summaries */
  2109. unsigned int bw_is_unmeasured:1; /**< This is a consensus entry, with
  2110. * the Unmeasured flag set. */
  2111. /** Flags to summarize the protocol versions for this routerstatus_t. */
  2112. protover_summary_flags_t pv;
  2113. uint32_t bandwidth_kb; /**< Bandwidth (capacity) of the router as reported in
  2114. * the vote/consensus, in kilobytes/sec. */
  2115. /** The consensus has guardfraction information for this router. */
  2116. unsigned int has_guardfraction:1;
  2117. /** The guardfraction value of this router. */
  2118. uint32_t guardfraction_percentage;
  2119. char *exitsummary; /**< exit policy summary -
  2120. * XXX weasel: this probably should not stay a string. */
  2121. /* ---- The fields below aren't derived from the networkstatus; they
  2122. * hold local information only. */
  2123. time_t last_dir_503_at; /**< When did this router last tell us that it
  2124. * was too busy to serve directory info? */
  2125. download_status_t dl_status;
  2126. } routerstatus_t;
  2127. /** A single entry in a parsed policy summary, describing a range of ports. */
  2128. typedef struct short_policy_entry_t {
  2129. uint16_t min_port, max_port;
  2130. } short_policy_entry_t;
  2131. /** A short_poliy_t is the parsed version of a policy summary. */
  2132. typedef struct short_policy_t {
  2133. /** True if the members of 'entries' are port ranges to accept; false if
  2134. * they are port ranges to reject */
  2135. unsigned int is_accept : 1;
  2136. /** The actual number of values in 'entries'. */
  2137. unsigned int n_entries : 31;
  2138. /** An array of 0 or more short_policy_entry_t values, each describing a
  2139. * range of ports that this policy accepts or rejects (depending on the
  2140. * value of is_accept).
  2141. */
  2142. short_policy_entry_t entries[FLEXIBLE_ARRAY_MEMBER];
  2143. } short_policy_t;
  2144. /** A microdescriptor is the smallest amount of information needed to build a
  2145. * circuit through a router. They are generated by the directory authorities,
  2146. * using information from the uploaded routerinfo documents. They are not
  2147. * self-signed, but are rather authenticated by having their hash in a signed
  2148. * networkstatus document. */
  2149. typedef struct microdesc_t {
  2150. /** Hashtable node, used to look up the microdesc by its digest. */
  2151. HT_ENTRY(microdesc_t) node;
  2152. /* Cache information */
  2153. /** When was this microdescriptor last listed in a consensus document?
  2154. * Once a microdesc has been unlisted long enough, we can drop it.
  2155. */
  2156. time_t last_listed;
  2157. /** Where is this microdescriptor currently stored? */
  2158. saved_location_bitfield_t saved_location : 3;
  2159. /** If true, do not attempt to cache this microdescriptor on disk. */
  2160. unsigned int no_save : 1;
  2161. /** If true, this microdesc has an entry in the microdesc_map */
  2162. unsigned int held_in_map : 1;
  2163. /** Reference count: how many node_ts have a reference to this microdesc? */
  2164. unsigned int held_by_nodes;
  2165. /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
  2166. * microdescriptor in the cache. */
  2167. off_t off;
  2168. /* The string containing the microdesc. */
  2169. /** A pointer to the encoded body of the microdescriptor. If the
  2170. * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
  2171. * mmap'd region. Otherwise, it is a malloc'd string. The string might not
  2172. * be NUL-terminated; take the length from <b>bodylen</b>. */
  2173. char *body;
  2174. /** The length of the microdescriptor in <b>body</b>. */
  2175. size_t bodylen;
  2176. /** A SHA256-digest of the microdescriptor. */
  2177. char digest[DIGEST256_LEN];
  2178. /* Fields in the microdescriptor. */
  2179. /** As routerinfo_t.onion_pkey */
  2180. crypto_pk_t *onion_pkey;
  2181. /** As routerinfo_t.onion_curve25519_pkey */
  2182. curve25519_public_key_t *onion_curve25519_pkey;
  2183. /** Ed25519 identity key, if included. */
  2184. ed25519_public_key_t *ed25519_identity_pkey;
  2185. /** As routerinfo_t.ipv6_addr */
  2186. tor_addr_t ipv6_addr;
  2187. /** As routerinfo_t.ipv6_orport */
  2188. uint16_t ipv6_orport;
  2189. /** As routerinfo_t.family */
  2190. smartlist_t *family;
  2191. /** IPv4 exit policy summary */
  2192. short_policy_t *exit_policy;
  2193. /** IPv6 exit policy summary */
  2194. short_policy_t *ipv6_exit_policy;
  2195. } microdesc_t;
  2196. /** A node_t represents a Tor router.
  2197. *
  2198. * Specifically, a node_t is a Tor router as we are using it: a router that
  2199. * we are considering for circuits, connections, and so on. A node_t is a
  2200. * thin wrapper around the routerstatus, routerinfo, and microdesc for a
  2201. * single router, and provides a consistent interface for all of them.
  2202. *
  2203. * Also, a node_t has mutable state. While a routerinfo, a routerstatus,
  2204. * and a microdesc have[*] only the information read from a router
  2205. * descriptor, a consensus entry, and a microdescriptor (respectively)...
  2206. * a node_t has flags based on *our own current opinion* of the node.
  2207. *
  2208. * [*] Actually, there is some leftover information in each that is mutable.
  2209. * We should try to excise that.
  2210. */
  2211. typedef struct node_t {
  2212. /* Indexing information */
  2213. /** Used to look up the node_t by its identity digest. */
  2214. HT_ENTRY(node_t) ht_ent;
  2215. /** Used to look up the node_t by its ed25519 identity digest. */
  2216. HT_ENTRY(node_t) ed_ht_ent;
  2217. /** Position of the node within the list of nodes */
  2218. int nodelist_idx;
  2219. /** The identity digest of this node_t. No more than one node_t per
  2220. * identity may exist at a time. */
  2221. char identity[DIGEST_LEN];
  2222. /** The ed25519 identity of this node_t. This field is nonzero iff we
  2223. * currently have an ed25519 identity for this node in either md or ri,
  2224. * _and_ this node has been inserted to the ed25519-to-node map in the
  2225. * nodelist.
  2226. */
  2227. ed25519_public_key_t ed25519_id;
  2228. microdesc_t *md;
  2229. routerinfo_t *ri;
  2230. routerstatus_t *rs;
  2231. /* local info: copied from routerstatus, then possibly frobbed based
  2232. * on experience. Authorities set this stuff directly. Note that
  2233. * these reflect knowledge of the primary (IPv4) OR port only. */
  2234. unsigned int is_running:1; /**< As far as we know, is this OR currently
  2235. * running? */
  2236. unsigned int is_valid:1; /**< Has a trusted dirserver validated this OR?
  2237. * (For Authdir: Have we validated this OR?) */
  2238. unsigned int is_fast:1; /** Do we think this is a fast OR? */
  2239. unsigned int is_stable:1; /** Do we think this is a stable OR? */
  2240. unsigned int is_possible_guard:1; /**< Do we think this is an OK guard? */
  2241. unsigned int is_exit:1; /**< Do we think this is an OK exit? */
  2242. unsigned int is_bad_exit:1; /**< Do we think this exit is censored, borked,
  2243. * or otherwise nasty? */
  2244. unsigned int is_hs_dir:1; /**< True iff this router is a hidden service
  2245. * directory according to the authorities. */
  2246. /* Local info: warning state. */
  2247. unsigned int name_lookup_warned:1; /**< Have we warned the user for referring
  2248. * to this (unnamed) router by nickname?
  2249. */
  2250. /** Local info: we treat this node as if it rejects everything */
  2251. unsigned int rejects_all:1;
  2252. /* Local info: derived. */
  2253. /** True if the IPv6 OR port is preferred over the IPv4 OR port.
  2254. * XX/teor - can this become out of date if the torrc changes? */
  2255. unsigned int ipv6_preferred:1;
  2256. /** According to the geoip db what country is this router in? */
  2257. /* XXXprop186 what is this suppose to mean with multiple OR ports? */
  2258. country_t country;
  2259. /* The below items are used only by authdirservers for
  2260. * reachability testing. */
  2261. /** When was the last time we could reach this OR? */
  2262. time_t last_reachable; /* IPv4. */
  2263. time_t last_reachable6; /* IPv6. */
  2264. /* Hidden service directory index data. This is used by a service or client
  2265. * in order to know what's the hs directory index for this node at the time
  2266. * the consensus is set. */
  2267. struct hsdir_index_t *hsdir_index;
  2268. } node_t;
  2269. /** Linked list of microdesc hash lines for a single router in a directory
  2270. * vote.
  2271. */
  2272. typedef struct vote_microdesc_hash_t {
  2273. /** Next element in the list, or NULL. */
  2274. struct vote_microdesc_hash_t *next;
  2275. /** The raw contents of the microdesc hash line, from the "m" through the
  2276. * newline. */
  2277. char *microdesc_hash_line;
  2278. } vote_microdesc_hash_t;
  2279. /** The claim about a single router, made in a vote. */
  2280. typedef struct vote_routerstatus_t {
  2281. routerstatus_t status; /**< Underlying 'status' object for this router.
  2282. * Flags are redundant. */
  2283. /** How many known-flags are allowed in a vote? This is the width of
  2284. * the flags field of vote_routerstatus_t */
  2285. #define MAX_KNOWN_FLAGS_IN_VOTE 64
  2286. uint64_t flags; /**< Bit-field for all recognized flags; index into
  2287. * networkstatus_t.known_flags. */
  2288. char *version; /**< The version that the authority says this router is
  2289. * running. */
  2290. char *protocols; /**< The protocols that this authority says this router
  2291. * provides. */
  2292. unsigned int has_measured_bw:1; /**< The vote had a measured bw */
  2293. /** True iff the vote included an entry for ed25519 ID, or included
  2294. * "id ed25519 none" to indicate that there was no ed25519 ID. */
  2295. unsigned int has_ed25519_listing:1;
  2296. /** True if the Ed25519 listing here is the consensus-opinion for the
  2297. * Ed25519 listing; false if there was no consensus on Ed25519 key status,
  2298. * or if this VRS doesn't reflect it. */
  2299. unsigned int ed25519_reflects_consensus:1;
  2300. uint32_t measured_bw_kb; /**< Measured bandwidth (capacity) of the router */
  2301. /** The hash or hashes that the authority claims this microdesc has. */
  2302. vote_microdesc_hash_t *microdesc;
  2303. /** Ed25519 identity for this router, or zero if it has none. */
  2304. uint8_t ed25519_id[ED25519_PUBKEY_LEN];
  2305. } vote_routerstatus_t;
  2306. /** A signature of some document by an authority. */
  2307. typedef struct document_signature_t {
  2308. /** Declared SHA-1 digest of this voter's identity key */
  2309. char identity_digest[DIGEST_LEN];
  2310. /** Declared SHA-1 digest of signing key used by this voter. */
  2311. char signing_key_digest[DIGEST_LEN];
  2312. /** Algorithm used to compute the digest of the document. */
  2313. digest_algorithm_t alg;
  2314. /** Signature of the signed thing. */
  2315. char *signature;
  2316. /** Length of <b>signature</b> */
  2317. int signature_len;
  2318. unsigned int bad_signature : 1; /**< Set to true if we've tried to verify
  2319. * the sig, and we know it's bad. */
  2320. unsigned int good_signature : 1; /**< Set to true if we've verified the sig
  2321. * as good. */
  2322. } document_signature_t;
  2323. /** Information about a single voter in a vote or a consensus. */
  2324. typedef struct networkstatus_voter_info_t {
  2325. /** Declared SHA-1 digest of this voter's identity key */
  2326. char identity_digest[DIGEST_LEN];
  2327. char *nickname; /**< Nickname of this voter */
  2328. /** Digest of this voter's "legacy" identity key, if any. In vote only; for
  2329. * consensuses, we treat legacy keys as additional signers. */
  2330. char legacy_id_digest[DIGEST_LEN];
  2331. char *address; /**< Address of this voter, in string format. */
  2332. uint32_t addr; /**< Address of this voter, in IPv4, in host order. */
  2333. uint16_t dir_port; /**< Directory port of this voter */
  2334. uint16_t or_port; /**< OR port of this voter */
  2335. char *contact; /**< Contact information for this voter. */
  2336. char vote_digest[DIGEST_LEN]; /**< Digest of this voter's vote, as signed. */
  2337. /* Nothing from here on is signed. */
  2338. /** The signature of the document and the signature's status. */
  2339. smartlist_t *sigs;
  2340. } networkstatus_voter_info_t;
  2341. typedef struct networkstatus_sr_info_t {
  2342. /* Indicate if the dirauth partitipates in the SR protocol with its vote.
  2343. * This is tied to the SR flag in the vote. */
  2344. unsigned int participate:1;
  2345. /* Both vote and consensus: Current and previous SRV. If list is empty,
  2346. * this means none were found in either the consensus or vote. */
  2347. struct sr_srv_t *previous_srv;
  2348. struct sr_srv_t *current_srv;
  2349. /* Vote only: List of commitments. */
  2350. smartlist_t *commits;
  2351. } networkstatus_sr_info_t;
  2352. /** Enumerates the possible seriousness values of a networkstatus document. */
  2353. typedef enum {
  2354. NS_TYPE_VOTE,
  2355. NS_TYPE_CONSENSUS,
  2356. NS_TYPE_OPINION,
  2357. } networkstatus_type_t;
  2358. /** Enumerates recognized flavors of a consensus networkstatus document. All
  2359. * flavors of a consensus are generated from the same set of votes, but they
  2360. * present different types information to different versions of Tor. */
  2361. typedef enum {
  2362. FLAV_NS = 0,
  2363. FLAV_MICRODESC = 1,
  2364. } consensus_flavor_t;
  2365. /** How many different consensus flavors are there? */
  2366. #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
  2367. /** A common structure to hold a v3 network status vote, or a v3 network
  2368. * status consensus. */
  2369. typedef struct networkstatus_t {
  2370. networkstatus_type_t type; /**< Vote, consensus, or opinion? */
  2371. consensus_flavor_t flavor; /**< If a consensus, what kind? */
  2372. unsigned int has_measured_bws : 1;/**< True iff this networkstatus contains
  2373. * measured= bandwidth values. */
  2374. time_t published; /**< Vote only: Time when vote was written. */
  2375. time_t valid_after; /**< Time after which this vote or consensus applies. */
  2376. time_t fresh_until; /**< Time before which this is the most recent vote or
  2377. * consensus. */
  2378. time_t valid_until; /**< Time after which this vote or consensus should not
  2379. * be used. */
  2380. /** Consensus only: what method was used to produce this consensus? */
  2381. int consensus_method;
  2382. /** Vote only: what methods is this voter willing to use? */
  2383. smartlist_t *supported_methods;
  2384. /** List of 'package' lines describing hashes of downloadable packages */
  2385. smartlist_t *package_lines;
  2386. /** How long does this vote/consensus claim that authorities take to
  2387. * distribute their votes to one another? */
  2388. int vote_seconds;
  2389. /** How long does this vote/consensus claim that authorities take to
  2390. * distribute their consensus signatures to one another? */
  2391. int dist_seconds;
  2392. /** Comma-separated list of recommended client software, or NULL if this
  2393. * voter has no opinion. */
  2394. char *client_versions;
  2395. char *server_versions;
  2396. /** Lists of subprotocol versions which are _recommended_ for relays and
  2397. * clients, or which are _require_ for relays and clients. Tor shouldn't
  2398. * make any more network connections if a required protocol is missing.
  2399. */
  2400. char *recommended_relay_protocols;
  2401. char *recommended_client_protocols;
  2402. char *required_relay_protocols;
  2403. char *required_client_protocols;
  2404. /** List of flags that this vote/consensus applies to routers. If a flag is
  2405. * not listed here, the voter has no opinion on what its value should be. */
  2406. smartlist_t *known_flags;
  2407. /** List of key=value strings for the parameters in this vote or
  2408. * consensus, sorted by key. */
  2409. smartlist_t *net_params;
  2410. /** List of key=value strings for the bw weight parameters in the
  2411. * consensus. */
  2412. smartlist_t *weight_params;
  2413. /** List of networkstatus_voter_info_t. For a vote, only one element
  2414. * is included. For a consensus, one element is included for every voter
  2415. * whose vote contributed to the consensus. */
  2416. smartlist_t *voters;
  2417. struct authority_cert_t *cert; /**< Vote only: the voter's certificate. */
  2418. /** Digests of this document, as signed. */
  2419. common_digests_t digests;
  2420. /** A SHA3-256 digest of the document, not including signatures: used for
  2421. * consensus diffs */
  2422. uint8_t digest_sha3_as_signed[DIGEST256_LEN];
  2423. /** List of router statuses, sorted by identity digest. For a vote,
  2424. * the elements are vote_routerstatus_t; for a consensus, the elements
  2425. * are routerstatus_t. */
  2426. smartlist_t *routerstatus_list;
  2427. /** If present, a map from descriptor digest to elements of
  2428. * routerstatus_list. */
  2429. digestmap_t *desc_digest_map;
  2430. /** Contains the shared random protocol data from a vote or consensus. */
  2431. networkstatus_sr_info_t sr_info;
  2432. } networkstatus_t;
  2433. /** A set of signatures for a networkstatus consensus. Unless otherwise
  2434. * noted, all fields are as for networkstatus_t. */
  2435. typedef struct ns_detached_signatures_t {
  2436. time_t valid_after;
  2437. time_t fresh_until;
  2438. time_t valid_until;
  2439. strmap_t *digests; /**< Map from flavor name to digestset_t */
  2440. strmap_t *signatures; /**< Map from flavor name to list of
  2441. * document_signature_t */
  2442. } ns_detached_signatures_t;
  2443. /** Allowable types of desc_store_t. */
  2444. typedef enum store_type_t {
  2445. ROUTER_STORE = 0,
  2446. EXTRAINFO_STORE = 1
  2447. } store_type_t;
  2448. /** A 'store' is a set of descriptors saved on disk, with accompanying
  2449. * journal, mmaped as needed, rebuilt as needed. */
  2450. typedef struct desc_store_t {
  2451. /** Filename (within DataDir) for the store. We append .tmp to this
  2452. * filename for a temporary file when rebuilding the store, and .new to this
  2453. * filename for the journal. */
  2454. const char *fname_base;
  2455. /** Human-readable description of what this store contains. */
  2456. const char *description;
  2457. tor_mmap_t *mmap; /**< A mmap for the main file in the store. */
  2458. store_type_t type; /**< What's stored in this store? */
  2459. /** The size of the router log, in bytes. */
  2460. size_t journal_len;
  2461. /** The size of the router store, in bytes. */
  2462. size_t store_len;
  2463. /** Total bytes dropped since last rebuild: this is space currently
  2464. * used in the cache and the journal that could be freed by a rebuild. */
  2465. size_t bytes_dropped;
  2466. } desc_store_t;
  2467. /** Contents of a directory of onion routers. */
  2468. typedef struct {
  2469. /** Map from server identity digest to a member of routers. */
  2470. struct digest_ri_map_t *identity_map;
  2471. /** Map from server descriptor digest to a signed_descriptor_t from
  2472. * routers or old_routers. */
  2473. struct digest_sd_map_t *desc_digest_map;
  2474. /** Map from extra-info digest to an extrainfo_t. Only exists for
  2475. * routers in routers or old_routers. */
  2476. struct digest_ei_map_t *extra_info_map;
  2477. /** Map from extra-info digests to a signed_descriptor_t for a router
  2478. * descriptor having that extra-info digest. Only exists for
  2479. * routers in routers or old_routers. */
  2480. struct digest_sd_map_t *desc_by_eid_map;
  2481. /** List of routerinfo_t for all currently live routers we know. */
  2482. smartlist_t *routers;
  2483. /** List of signed_descriptor_t for older router descriptors we're
  2484. * caching. */
  2485. smartlist_t *old_routers;
  2486. /** Store holding server descriptors. If present, any router whose
  2487. * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
  2488. * starting at cache_info.saved_offset */
  2489. desc_store_t desc_store;
  2490. /** Store holding extra-info documents. */
  2491. desc_store_t extrainfo_store;
  2492. } routerlist_t;
  2493. /** Information on router used when extending a circuit. We don't need a
  2494. * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
  2495. * connection, and onion_key to create the onionskin. Note that for onehop
  2496. * general-purpose tunnels, the onion_key is NULL. */
  2497. typedef struct extend_info_t {
  2498. char nickname[MAX_HEX_NICKNAME_LEN+1]; /**< This router's nickname for
  2499. * display. */
  2500. /** Hash of this router's RSA identity key. */
  2501. char identity_digest[DIGEST_LEN];
  2502. /** Ed25519 identity for this router, if any. */
  2503. ed25519_public_key_t ed_identity;
  2504. uint16_t port; /**< OR port. */
  2505. tor_addr_t addr; /**< IP address. */
  2506. crypto_pk_t *onion_key; /**< Current onionskin key. */
  2507. curve25519_public_key_t curve25519_onion_key;
  2508. } extend_info_t;
  2509. /** Certificate for v3 directory protocol: binds long-term authority identity
  2510. * keys to medium-term authority signing keys. */
  2511. typedef struct authority_cert_t {
  2512. /** Information relating to caching this cert on disk and looking it up. */
  2513. signed_descriptor_t cache_info;
  2514. /** This authority's long-term authority identity key. */
  2515. crypto_pk_t *identity_key;
  2516. /** This authority's medium-term signing key. */
  2517. crypto_pk_t *signing_key;
  2518. /** The digest of <b>signing_key</b> */
  2519. char signing_key_digest[DIGEST_LEN];
  2520. /** The listed expiration time of this certificate. */
  2521. time_t expires;
  2522. /** This authority's IPv4 address, in host order. */
  2523. uint32_t addr;
  2524. /** This authority's directory port. */
  2525. uint16_t dir_port;
  2526. } authority_cert_t;
  2527. /** Bitfield enum type listing types of information that directory authorities
  2528. * can be authoritative about, and that directory caches may or may not cache.
  2529. *
  2530. * Note that the granularity here is based on authority granularity and on
  2531. * cache capabilities. Thus, one particular bit may correspond in practice to
  2532. * a few types of directory info, so long as every authority that pronounces
  2533. * officially about one of the types prounounces officially about all of them,
  2534. * and so long as every cache that caches one of them caches all of them.
  2535. */
  2536. typedef enum {
  2537. NO_DIRINFO = 0,
  2538. /** Serves/signs v3 directory information: votes, consensuses, certs */
  2539. V3_DIRINFO = 1 << 2,
  2540. /** Serves bridge descriptors. */
  2541. BRIDGE_DIRINFO = 1 << 4,
  2542. /** Serves extrainfo documents. */
  2543. EXTRAINFO_DIRINFO=1 << 5,
  2544. /** Serves microdescriptors. */
  2545. MICRODESC_DIRINFO=1 << 6,
  2546. } dirinfo_type_t;
  2547. #define ALL_DIRINFO ((dirinfo_type_t)((1<<7)-1))
  2548. #define CRYPT_PATH_MAGIC 0x70127012u
  2549. struct fast_handshake_state_t;
  2550. struct ntor_handshake_state_t;
  2551. #define ONION_HANDSHAKE_TYPE_TAP 0x0000
  2552. #define ONION_HANDSHAKE_TYPE_FAST 0x0001
  2553. #define ONION_HANDSHAKE_TYPE_NTOR 0x0002
  2554. #define MAX_ONION_HANDSHAKE_TYPE 0x0002
  2555. typedef struct {
  2556. uint16_t tag;
  2557. union {
  2558. struct fast_handshake_state_t *fast;
  2559. crypto_dh_t *tap;
  2560. struct ntor_handshake_state_t *ntor;
  2561. } u;
  2562. } onion_handshake_state_t;
  2563. /** Holds accounting information for a single step in the layered encryption
  2564. * performed by a circuit. Used only at the client edge of a circuit. */
  2565. typedef struct crypt_path_t {
  2566. uint32_t magic;
  2567. /* crypto environments */
  2568. /** Encryption key and counter for cells heading towards the OR at this
  2569. * step. */
  2570. crypto_cipher_t *f_crypto;
  2571. /** Encryption key and counter for cells heading back from the OR at this
  2572. * step. */
  2573. crypto_cipher_t *b_crypto;
  2574. /** Digest state for cells heading towards the OR at this step. */
  2575. crypto_digest_t *f_digest; /* for integrity checking */
  2576. /** Digest state for cells heading away from the OR at this step. */
  2577. crypto_digest_t *b_digest;
  2578. /** Current state of the handshake as performed with the OR at this
  2579. * step. */
  2580. onion_handshake_state_t handshake_state;
  2581. /** Diffie-hellman handshake state for performing an introduction
  2582. * operations */
  2583. crypto_dh_t *rend_dh_handshake_state;
  2584. /** Negotiated key material shared with the OR at this step. */
  2585. char rend_circ_nonce[DIGEST_LEN];/* KH in tor-spec.txt */
  2586. /** Information to extend to the OR at this step. */
  2587. extend_info_t *extend_info;
  2588. /** Is the circuit built to this step? Must be one of:
  2589. * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
  2590. * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
  2591. * and not received an EXTENDED/CREATED)
  2592. * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
  2593. uint8_t state;
  2594. #define CPATH_STATE_CLOSED 0
  2595. #define CPATH_STATE_AWAITING_KEYS 1
  2596. #define CPATH_STATE_OPEN 2
  2597. struct crypt_path_t *next; /**< Link to next crypt_path_t in the circuit.
  2598. * (The list is circular, so the last node
  2599. * links to the first.) */
  2600. struct crypt_path_t *prev; /**< Link to previous crypt_path_t in the
  2601. * circuit. */
  2602. int package_window; /**< How many cells are we allowed to originate ending
  2603. * at this step? */
  2604. int deliver_window; /**< How many cells are we willing to deliver originating
  2605. * at this step? */
  2606. } crypt_path_t;
  2607. /** A reference-counted pointer to a crypt_path_t, used only to share
  2608. * the final rendezvous cpath to be used on a service-side rendezvous
  2609. * circuit among multiple circuits built in parallel to the same
  2610. * destination rendezvous point. */
  2611. typedef struct {
  2612. /** The reference count. */
  2613. unsigned int refcount;
  2614. /** The pointer. Set to NULL when the crypt_path_t is put into use
  2615. * on an opened rendezvous circuit. */
  2616. crypt_path_t *cpath;
  2617. } crypt_path_reference_t;
  2618. #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
  2619. #define DH_KEY_LEN DH_BYTES
  2620. /** Information used to build a circuit. */
  2621. typedef struct {
  2622. /** Intended length of the final circuit. */
  2623. int desired_path_len;
  2624. /** How to extend to the planned exit node. */
  2625. extend_info_t *chosen_exit;
  2626. /** Whether every node in the circ must have adequate uptime. */
  2627. unsigned int need_uptime : 1;
  2628. /** Whether every node in the circ must have adequate capacity. */
  2629. unsigned int need_capacity : 1;
  2630. /** Whether the last hop was picked with exiting in mind. */
  2631. unsigned int is_internal : 1;
  2632. /** Did we pick this as a one-hop tunnel (not safe for other streams)?
  2633. * These are for encrypted dir conns that exit to this router, not
  2634. * for arbitrary exits from the circuit. */
  2635. unsigned int onehop_tunnel : 1;
  2636. /** The crypt_path_t to append after rendezvous: used for rendezvous. */
  2637. crypt_path_t *pending_final_cpath;
  2638. /** A ref-counted reference to the crypt_path_t to append after
  2639. * rendezvous; used on the service side. */
  2640. crypt_path_reference_t *service_pending_final_cpath_ref;
  2641. /** How many times has building a circuit for this task failed? */
  2642. int failure_count;
  2643. /** At what time should we give up on this task? */
  2644. time_t expiry_time;
  2645. } cpath_build_state_t;
  2646. /** "magic" value for an origin_circuit_t */
  2647. #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
  2648. /** "magic" value for an or_circuit_t */
  2649. #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
  2650. /** "magic" value for a circuit that would have been freed by circuit_free,
  2651. * but which we're keeping around until a cpuworker reply arrives. See
  2652. * circuit_free() for more documentation. */
  2653. #define DEAD_CIRCUIT_MAGIC 0xdeadc14c
  2654. struct create_cell_t;
  2655. /** Entry in the cell stats list of a circuit; used only if CELL_STATS
  2656. * events are enabled. */
  2657. typedef struct testing_cell_stats_entry_t {
  2658. uint8_t command; /**< cell command number. */
  2659. /** Waiting time in centiseconds if this event is for a removed cell,
  2660. * or 0 if this event is for adding a cell to the queue. 22 bits can
  2661. * store more than 11 hours, enough to assume that a circuit with this
  2662. * delay would long have been closed. */
  2663. unsigned int waiting_time:22;
  2664. unsigned int removed:1; /**< 0 for added to, 1 for removed from queue. */
  2665. unsigned int exitward:1; /**< 0 for app-ward, 1 for exit-ward. */
  2666. } testing_cell_stats_entry_t;
  2667. /**
  2668. * A circuit is a path over the onion routing
  2669. * network. Applications can connect to one end of the circuit, and can
  2670. * create exit connections at the other end of the circuit. AP and exit
  2671. * connections have only one circuit associated with them (and thus these
  2672. * connection types are closed when the circuit is closed), whereas
  2673. * OR connections multiplex many circuits at once, and stay standing even
  2674. * when there are no circuits running over them.
  2675. *
  2676. * A circuit_t structure can fill one of two roles. First, a or_circuit_t
  2677. * links two connections together: either an edge connection and an OR
  2678. * connection, or two OR connections. (When joined to an OR connection, a
  2679. * circuit_t affects only cells sent to a particular circID on that
  2680. * connection. When joined to an edge connection, a circuit_t affects all
  2681. * data.)
  2682. * Second, an origin_circuit_t holds the cipher keys and state for sending data
  2683. * along a given circuit. At the OP, it has a sequence of ciphers, each
  2684. * of which is shared with a single OR along the circuit. Separate
  2685. * ciphers are used for data going "forward" (away from the OP) and
  2686. * "backward" (towards the OP). At the OR, a circuit has only two stream
  2687. * ciphers: one for data going forward, and one for data going backward.
  2688. */
  2689. typedef struct circuit_t {
  2690. uint32_t magic; /**< For memory and type debugging: must equal
  2691. * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
  2692. /** The channel that is next in this circuit. */
  2693. channel_t *n_chan;
  2694. /**
  2695. * The circuit_id used in the next (forward) hop of this circuit;
  2696. * this is unique to n_chan, but this ordered pair is globally
  2697. * unique:
  2698. *
  2699. * (n_chan->global_identifier, n_circ_id)
  2700. */
  2701. circid_t n_circ_id;
  2702. /**
  2703. * Circuit mux associated with n_chan to which this circuit is attached;
  2704. * NULL if we have no n_chan.
  2705. */
  2706. circuitmux_t *n_mux;
  2707. /** Queue of cells waiting to be transmitted on n_chan */
  2708. cell_queue_t n_chan_cells;
  2709. /**
  2710. * The hop to which we want to extend this circuit. Should be NULL if
  2711. * the circuit has attached to a channel.
  2712. */
  2713. extend_info_t *n_hop;
  2714. /** True iff we are waiting for n_chan_cells to become less full before
  2715. * allowing p_streams to add any more cells. (Origin circuit only.) */
  2716. unsigned int streams_blocked_on_n_chan : 1;
  2717. /** True iff we are waiting for p_chan_cells to become less full before
  2718. * allowing n_streams to add any more cells. (OR circuit only.) */
  2719. unsigned int streams_blocked_on_p_chan : 1;
  2720. /** True iff we have queued a delete backwards on this circuit, but not put
  2721. * it on the output buffer. */
  2722. unsigned int p_delete_pending : 1;
  2723. /** True iff we have queued a delete forwards on this circuit, but not put
  2724. * it on the output buffer. */
  2725. unsigned int n_delete_pending : 1;
  2726. /** True iff this circuit has received a DESTROY cell in either direction */
  2727. unsigned int received_destroy : 1;
  2728. uint8_t state; /**< Current status of this circuit. */
  2729. uint8_t purpose; /**< Why are we creating this circuit? */
  2730. /** How many relay data cells can we package (read from edge streams)
  2731. * on this circuit before we receive a circuit-level sendme cell asking
  2732. * for more? */
  2733. int package_window;
  2734. /** How many relay data cells will we deliver (write to edge streams)
  2735. * on this circuit? When deliver_window gets low, we send some
  2736. * circuit-level sendme cells to indicate that we're willing to accept
  2737. * more. */
  2738. int deliver_window;
  2739. /** Temporary field used during circuits_handle_oom. */
  2740. uint32_t age_tmp;
  2741. /** For storage while n_chan is pending (state CIRCUIT_STATE_CHAN_WAIT). */
  2742. struct create_cell_t *n_chan_create_cell;
  2743. /** When did circuit construction actually begin (ie send the
  2744. * CREATE cell or begin cannibalization).
  2745. *
  2746. * Note: This timer will get reset if we decide to cannibalize
  2747. * a circuit. It may also get reset during certain phases of hidden
  2748. * service circuit use.
  2749. *
  2750. * We keep this timestamp with a higher resolution than most so that the
  2751. * circuit-build-time tracking code can get millisecond resolution.
  2752. */
  2753. struct timeval timestamp_began;
  2754. /** This timestamp marks when the init_circuit_base constructor ran. */
  2755. struct timeval timestamp_created;
  2756. /** When the circuit was first used, or 0 if the circuit is clean.
  2757. *
  2758. * XXXX Note that some code will artificially adjust this value backward
  2759. * in time in order to indicate that a circuit shouldn't be used for new
  2760. * streams, but that it can stay alive as long as it has streams on it.
  2761. * That's a kludge we should fix.
  2762. *
  2763. * XXX The CBT code uses this field to record when HS-related
  2764. * circuits entered certain states. This usage probably won't
  2765. * interfere with this field's primary purpose, but we should
  2766. * document it more thoroughly to make sure of that.
  2767. *
  2768. * XXX The SocksPort option KeepaliveIsolateSOCKSAuth will artificially
  2769. * adjust this value forward each time a suitable stream is attached to an
  2770. * already constructed circuit, potentially keeping the circuit alive
  2771. * indefinitely.
  2772. */
  2773. time_t timestamp_dirty;
  2774. uint16_t marked_for_close; /**< Should we close this circuit at the end of
  2775. * the main loop? (If true, holds the line number
  2776. * where this circuit was marked.) */
  2777. const char *marked_for_close_file; /**< For debugging: in which file was this
  2778. * circuit marked for close? */
  2779. /** For what reason (See END_CIRC_REASON...) is this circuit being closed?
  2780. * This field is set in circuit_mark_for_close and used later in
  2781. * circuit_about_to_free. */
  2782. int marked_for_close_reason;
  2783. /** As marked_for_close_reason, but reflects the underlying reason for
  2784. * closing this circuit.
  2785. */
  2786. int marked_for_close_orig_reason;
  2787. /** Unique ID for measuring tunneled network status requests. */
  2788. uint64_t dirreq_id;
  2789. /** Index in smartlist of all circuits (global_circuitlist). */
  2790. int global_circuitlist_idx;
  2791. /** Next circuit in the doubly-linked ring of circuits waiting to add
  2792. * cells to n_conn. NULL if we have no cells pending, or if we're not
  2793. * linked to an OR connection. */
  2794. struct circuit_t *next_active_on_n_chan;
  2795. /** Previous circuit in the doubly-linked ring of circuits waiting to add
  2796. * cells to n_conn. NULL if we have no cells pending, or if we're not
  2797. * linked to an OR connection. */
  2798. struct circuit_t *prev_active_on_n_chan;
  2799. /** Various statistics about cells being added to or removed from this
  2800. * circuit's queues; used only if CELL_STATS events are enabled and
  2801. * cleared after being sent to control port. */
  2802. smartlist_t *testing_cell_stats;
  2803. /** If set, points to an HS token that this circuit might be carrying.
  2804. * Used by the HS circuitmap. */
  2805. hs_token_t *hs_token;
  2806. /** Hashtable node: used to look up the circuit by its HS token using the HS
  2807. circuitmap. */
  2808. HT_ENTRY(circuit_t) hs_circuitmap_node;
  2809. } circuit_t;
  2810. /** Largest number of relay_early cells that we can send on a given
  2811. * circuit. */
  2812. #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
  2813. /**
  2814. * Describes the circuit building process in simplified terms based
  2815. * on the path bias accounting state for a circuit.
  2816. *
  2817. * NOTE: These state values are enumerated in the order for which we
  2818. * expect circuits to transition through them. If you add states,
  2819. * you need to preserve this overall ordering. The various pathbias
  2820. * state transition and accounting functions (pathbias_mark_* and
  2821. * pathbias_count_*) contain ordinal comparisons to enforce proper
  2822. * state transitions for corrections.
  2823. *
  2824. * This state machine and the associated logic was created to prevent
  2825. * miscounting due to unknown cases of circuit reuse. See also tickets
  2826. * #6475 and #7802.
  2827. */
  2828. typedef enum {
  2829. /** This circuit is "new". It has not yet completed a first hop
  2830. * or been counted by the path bias code. */
  2831. PATH_STATE_NEW_CIRC = 0,
  2832. /** This circuit has completed one/two hops, and has been counted by
  2833. * the path bias logic. */
  2834. PATH_STATE_BUILD_ATTEMPTED = 1,
  2835. /** This circuit has been completely built */
  2836. PATH_STATE_BUILD_SUCCEEDED = 2,
  2837. /** Did we try to attach any SOCKS streams or hidserv introductions to
  2838. * this circuit?
  2839. *
  2840. * Note: If we ever implement end-to-end stream timing through test
  2841. * stream probes (#5707), we must *not* set this for those probes
  2842. * (or any other automatic streams) because the adversary could
  2843. * just tag at a later point.
  2844. */
  2845. PATH_STATE_USE_ATTEMPTED = 3,
  2846. /** Did any SOCKS streams or hidserv introductions actually succeed on
  2847. * this circuit?
  2848. *
  2849. * If any streams detatch/fail from this circuit, the code transitions
  2850. * the circuit back to PATH_STATE_USE_ATTEMPTED to ensure we probe. See
  2851. * pathbias_mark_use_rollback() for that.
  2852. */
  2853. PATH_STATE_USE_SUCCEEDED = 4,
  2854. /**
  2855. * This is a special state to indicate that we got a corrupted
  2856. * relay cell on a circuit and we don't intend to probe it.
  2857. */
  2858. PATH_STATE_USE_FAILED = 5,
  2859. /**
  2860. * This is a special state to indicate that we already counted
  2861. * the circuit. Used to guard against potential state machine
  2862. * violations.
  2863. */
  2864. PATH_STATE_ALREADY_COUNTED = 6,
  2865. } path_state_t;
  2866. #define path_state_bitfield_t ENUM_BF(path_state_t)
  2867. /** An origin_circuit_t holds data necessary to build and use a circuit.
  2868. */
  2869. typedef struct origin_circuit_t {
  2870. circuit_t base_;
  2871. /** Linked list of AP streams (or EXIT streams if hidden service)
  2872. * associated with this circuit. */
  2873. edge_connection_t *p_streams;
  2874. /** Bytes read from any attached stream since last call to
  2875. * control_event_circ_bandwidth_used(). Only used if we're configured
  2876. * to emit CIRC_BW events. */
  2877. uint32_t n_read_circ_bw;
  2878. /** Bytes written to any attached stream since last call to
  2879. * control_event_circ_bandwidth_used(). Only used if we're configured
  2880. * to emit CIRC_BW events. */
  2881. uint32_t n_written_circ_bw;
  2882. /** Build state for this circuit. It includes the intended path
  2883. * length, the chosen exit router, rendezvous information, etc.
  2884. */
  2885. cpath_build_state_t *build_state;
  2886. /** The doubly-linked list of crypt_path_t entries, one per hop,
  2887. * for this circuit. This includes ciphers for each hop,
  2888. * integrity-checking digests for each hop, and package/delivery
  2889. * windows for each hop.
  2890. */
  2891. crypt_path_t *cpath;
  2892. /** Holds all rendezvous data on either client or service side. */
  2893. rend_data_t *rend_data;
  2894. /** Holds hidden service identifier on either client or service side. This
  2895. * is for both introduction and rendezvous circuit. */
  2896. struct hs_ident_circuit_t *hs_ident;
  2897. /** Holds the data that the entry guard system uses to track the
  2898. * status of the guard this circuit is using, and thereby to determine
  2899. * whether this circuit can be used. */
  2900. struct circuit_guard_state_t *guard_state;
  2901. /** Index into global_origin_circuit_list for this circuit. -1 if not
  2902. * present. */
  2903. int global_origin_circuit_list_idx;
  2904. /** How many more relay_early cells can we send on this circuit, according
  2905. * to the specification? */
  2906. unsigned int remaining_relay_early_cells : 4;
  2907. /** Set if this circuit is insanely old and we already informed the user */
  2908. unsigned int is_ancient : 1;
  2909. /** Set if this circuit has already been opened. Used to detect
  2910. * cannibalized circuits. */
  2911. unsigned int has_opened : 1;
  2912. /**
  2913. * Path bias state machine. Used to ensure integrity of our
  2914. * circuit building and usage accounting. See path_state_t
  2915. * for more details.
  2916. */
  2917. path_state_bitfield_t path_state : 3;
  2918. /* If this flag is set, we should not consider attaching any more
  2919. * connections to this circuit. */
  2920. unsigned int unusable_for_new_conns : 1;
  2921. /**
  2922. * Tristate variable to guard against pathbias miscounting
  2923. * due to circuit purpose transitions changing the decision
  2924. * of pathbias_should_count(). This variable is informational
  2925. * only. The current results of pathbias_should_count() are
  2926. * the official decision for pathbias accounting.
  2927. */
  2928. uint8_t pathbias_shouldcount;
  2929. #define PATHBIAS_SHOULDCOUNT_UNDECIDED 0
  2930. #define PATHBIAS_SHOULDCOUNT_IGNORED 1
  2931. #define PATHBIAS_SHOULDCOUNT_COUNTED 2
  2932. /** For path probing. Store the temporary probe stream ID
  2933. * for response comparison */
  2934. streamid_t pathbias_probe_id;
  2935. /** For path probing. Store the temporary probe address nonce
  2936. * (in host byte order) for response comparison. */
  2937. uint32_t pathbias_probe_nonce;
  2938. /** Set iff this is a hidden-service circuit which has timed out
  2939. * according to our current circuit-build timeout, but which has
  2940. * been kept around because it might still succeed in connecting to
  2941. * its destination, and which is not a fully-connected rendezvous
  2942. * circuit.
  2943. *
  2944. * (We clear this flag for client-side rendezvous circuits when they
  2945. * are 'joined' to the other side's rendezvous circuit, so that
  2946. * connection_ap_handshake_attach_circuit can put client streams on
  2947. * the circuit. We also clear this flag for service-side rendezvous
  2948. * circuits when they are 'joined' to a client's rend circ, but only
  2949. * for symmetry with the client case. Client-side introduction
  2950. * circuits are closed when we get a joined rend circ, and
  2951. * service-side introduction circuits never have this flag set.) */
  2952. unsigned int hs_circ_has_timed_out : 1;
  2953. /** Set iff this circuit has been given a relaxed timeout because
  2954. * no circuits have opened. Used to prevent spamming logs. */
  2955. unsigned int relaxed_timeout : 1;
  2956. /** Set iff this is a service-side rendezvous circuit for which a
  2957. * new connection attempt has been launched. We consider launching
  2958. * a new service-side rend circ to a client when the previous one
  2959. * fails; now that we don't necessarily close a service-side rend
  2960. * circ when we launch a new one to the same client, this flag keeps
  2961. * us from launching two retries for the same failed rend circ. */
  2962. unsigned int hs_service_side_rend_circ_has_been_relaunched : 1;
  2963. /** What commands were sent over this circuit that decremented the
  2964. * RELAY_EARLY counter? This is for debugging task 878. */
  2965. uint8_t relay_early_commands[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT];
  2966. /** How many RELAY_EARLY cells have been sent over this circuit? This is
  2967. * for debugging task 878, too. */
  2968. int relay_early_cells_sent;
  2969. /** The next stream_id that will be tried when we're attempting to
  2970. * construct a new AP stream originating at this circuit. */
  2971. streamid_t next_stream_id;
  2972. /* The intro key replaces the hidden service's public key if purpose is
  2973. * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
  2974. * descriptor is used. */
  2975. crypto_pk_t *intro_key;
  2976. /** Quasi-global identifier for this circuit; used for control.c */
  2977. /* XXXX NM This can get re-used after 2**32 circuits. */
  2978. uint32_t global_identifier;
  2979. /** True if we have associated one stream to this circuit, thereby setting
  2980. * the isolation parameters for this circuit. Note that this doesn't
  2981. * necessarily mean that we've <em>attached</em> any streams to the circuit:
  2982. * we may only have marked up this circuit during the launch process.
  2983. */
  2984. unsigned int isolation_values_set : 1;
  2985. /** True iff any stream has <em>ever</em> been attached to this circuit.
  2986. *
  2987. * In a better world we could use timestamp_dirty for this, but
  2988. * timestamp_dirty is far too overloaded at the moment.
  2989. */
  2990. unsigned int isolation_any_streams_attached : 1;
  2991. /** A bitfield of ISO_* flags for every isolation field such that this
  2992. * circuit has had streams with more than one value for that field
  2993. * attached to it. */
  2994. uint8_t isolation_flags_mixed;
  2995. /** @name Isolation parameters
  2996. *
  2997. * If any streams have been associated with this circ (isolation_values_set
  2998. * == 1), and all streams associated with the circuit have had the same
  2999. * value for some field ((isolation_flags_mixed & ISO_FOO) == 0), then these
  3000. * elements hold the value for that field.
  3001. *
  3002. * Note again that "associated" is not the same as "attached": we
  3003. * preliminarily associate streams with a circuit while the circuit is being
  3004. * launched, so that we can tell whether we need to launch more circuits.
  3005. *
  3006. * @{
  3007. */
  3008. uint8_t client_proto_type;
  3009. uint8_t client_proto_socksver;
  3010. uint16_t dest_port;
  3011. tor_addr_t client_addr;
  3012. char *dest_address;
  3013. int session_group;
  3014. unsigned nym_epoch;
  3015. size_t socks_username_len;
  3016. uint8_t socks_password_len;
  3017. /* Note that the next two values are NOT NUL-terminated; see
  3018. socks_username_len and socks_password_len for their lengths. */
  3019. char *socks_username;
  3020. char *socks_password;
  3021. /** Global identifier for the first stream attached here; used by
  3022. * ISO_STREAM. */
  3023. uint64_t associated_isolated_stream_global_id;
  3024. /**@}*/
  3025. /** A list of addr_policy_t for this circuit in particular. Used by
  3026. * adjust_exit_policy_from_exitpolicy_failure.
  3027. */
  3028. smartlist_t *prepend_policy;
  3029. /** How long do we wait before closing this circuit if it remains
  3030. * completely idle after it was built, in seconds? This value
  3031. * is randomized on a per-circuit basis from CircuitsAvailableTimoeut
  3032. * to 2*CircuitsAvailableTimoeut. */
  3033. int circuit_idle_timeout;
  3034. } origin_circuit_t;
  3035. struct onion_queue_t;
  3036. /** An or_circuit_t holds information needed to implement a circuit at an
  3037. * OR. */
  3038. typedef struct or_circuit_t {
  3039. circuit_t base_;
  3040. /** Next circuit in the doubly-linked ring of circuits waiting to add
  3041. * cells to p_chan. NULL if we have no cells pending, or if we're not
  3042. * linked to an OR connection. */
  3043. struct circuit_t *next_active_on_p_chan;
  3044. /** Previous circuit in the doubly-linked ring of circuits waiting to add
  3045. * cells to p_chan. NULL if we have no cells pending, or if we're not
  3046. * linked to an OR connection. */
  3047. struct circuit_t *prev_active_on_p_chan;
  3048. /** Pointer to an entry on the onion queue, if this circuit is waiting for a
  3049. * chance to give an onionskin to a cpuworker. Used only in onion.c */
  3050. struct onion_queue_t *onionqueue_entry;
  3051. /** Pointer to a workqueue entry, if this circuit has given an onionskin to
  3052. * a cpuworker and is waiting for a response. Used to decide whether it is
  3053. * safe to free a circuit or if it is still in use by a cpuworker. */
  3054. struct workqueue_entry_s *workqueue_entry;
  3055. /** The circuit_id used in the previous (backward) hop of this circuit. */
  3056. circid_t p_circ_id;
  3057. /** Queue of cells waiting to be transmitted on p_conn. */
  3058. cell_queue_t p_chan_cells;
  3059. /** The channel that is previous in this circuit. */
  3060. channel_t *p_chan;
  3061. /**
  3062. * Circuit mux associated with p_chan to which this circuit is attached;
  3063. * NULL if we have no p_chan.
  3064. */
  3065. circuitmux_t *p_mux;
  3066. /** Linked list of Exit streams associated with this circuit. */
  3067. edge_connection_t *n_streams;
  3068. /** Linked list of Exit streams associated with this circuit that are
  3069. * still being resolved. */
  3070. edge_connection_t *resolving_streams;
  3071. /** The cipher used by intermediate hops for cells heading toward the
  3072. * OP. */
  3073. crypto_cipher_t *p_crypto;
  3074. /** The cipher used by intermediate hops for cells heading away from
  3075. * the OP. */
  3076. crypto_cipher_t *n_crypto;
  3077. /** The integrity-checking digest used by intermediate hops, for
  3078. * cells packaged here and heading towards the OP.
  3079. */
  3080. crypto_digest_t *p_digest;
  3081. /** The integrity-checking digest used by intermediate hops, for
  3082. * cells packaged at the OP and arriving here.
  3083. */
  3084. crypto_digest_t *n_digest;
  3085. /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
  3086. * is not marked for close. */
  3087. struct or_circuit_t *rend_splice;
  3088. /** Stores KH for the handshake. */
  3089. char rend_circ_nonce[DIGEST_LEN];/* KH in tor-spec.txt */
  3090. /** How many more relay_early cells can we send on this circuit, according
  3091. * to the specification? */
  3092. unsigned int remaining_relay_early_cells : 4;
  3093. /* We have already received an INTRODUCE1 cell on this circuit. */
  3094. unsigned int already_received_introduce1 : 1;
  3095. /** If set, this circuit carries HS traffic. Consider it in any HS
  3096. * statistics. */
  3097. unsigned int circuit_carries_hs_traffic_stats : 1;
  3098. /** Number of cells that were removed from circuit queue; reset every
  3099. * time when writing buffer stats to disk. */
  3100. uint32_t processed_cells;
  3101. /** Total time in milliseconds that cells spent in both app-ward and
  3102. * exit-ward queues of this circuit; reset every time when writing
  3103. * buffer stats to disk. */
  3104. uint64_t total_cell_waiting_time;
  3105. /** Maximum cell queue size for a middle relay; this is stored per circuit
  3106. * so append_cell_to_circuit_queue() can adjust it if it changes. If set
  3107. * to zero, it is initialized to the default value.
  3108. */
  3109. uint32_t max_middle_cells;
  3110. } or_circuit_t;
  3111. #if REND_COOKIE_LEN != DIGEST_LEN
  3112. #error "The REND_TOKEN_LEN macro assumes REND_COOKIE_LEN == DIGEST_LEN"
  3113. #endif
  3114. #define REND_TOKEN_LEN DIGEST_LEN
  3115. /** Convert a circuit subtype to a circuit_t. */
  3116. #define TO_CIRCUIT(x) (&((x)->base_))
  3117. /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Assert
  3118. * if the cast is impossible. */
  3119. static or_circuit_t *TO_OR_CIRCUIT(circuit_t *);
  3120. static const or_circuit_t *CONST_TO_OR_CIRCUIT(const circuit_t *);
  3121. /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
  3122. * Assert if the cast is impossible. */
  3123. static origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *);
  3124. static const origin_circuit_t *CONST_TO_ORIGIN_CIRCUIT(const circuit_t *);
  3125. /** Return 1 iff <b>node</b> has Exit flag and no BadExit flag.
  3126. * Otherwise, return 0.
  3127. */
  3128. static inline int node_is_good_exit(const node_t *node)
  3129. {
  3130. return node->is_exit && ! node->is_bad_exit;
  3131. }
  3132. static inline or_circuit_t *TO_OR_CIRCUIT(circuit_t *x)
  3133. {
  3134. tor_assert(x->magic == OR_CIRCUIT_MAGIC);
  3135. return DOWNCAST(or_circuit_t, x);
  3136. }
  3137. static inline const or_circuit_t *CONST_TO_OR_CIRCUIT(const circuit_t *x)
  3138. {
  3139. tor_assert(x->magic == OR_CIRCUIT_MAGIC);
  3140. return DOWNCAST(or_circuit_t, x);
  3141. }
  3142. static inline origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *x)
  3143. {
  3144. tor_assert(x->magic == ORIGIN_CIRCUIT_MAGIC);
  3145. return DOWNCAST(origin_circuit_t, x);
  3146. }
  3147. static inline const origin_circuit_t *CONST_TO_ORIGIN_CIRCUIT(
  3148. const circuit_t *x)
  3149. {
  3150. tor_assert(x->magic == ORIGIN_CIRCUIT_MAGIC);
  3151. return DOWNCAST(origin_circuit_t, x);
  3152. }
  3153. /* limits for TCP send and recv buffer size used for constrained sockets */
  3154. #define MIN_CONSTRAINED_TCP_BUFFER 2048
  3155. #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
  3156. /** @name Isolation flags
  3157. Ways to isolate client streams
  3158. @{
  3159. */
  3160. /** Isolate based on destination port */
  3161. #define ISO_DESTPORT (1u<<0)
  3162. /** Isolate based on destination address */
  3163. #define ISO_DESTADDR (1u<<1)
  3164. /** Isolate based on SOCKS authentication */
  3165. #define ISO_SOCKSAUTH (1u<<2)
  3166. /** Isolate based on client protocol choice */
  3167. #define ISO_CLIENTPROTO (1u<<3)
  3168. /** Isolate based on client address */
  3169. #define ISO_CLIENTADDR (1u<<4)
  3170. /** Isolate based on session group (always on). */
  3171. #define ISO_SESSIONGRP (1u<<5)
  3172. /** Isolate based on newnym epoch (always on). */
  3173. #define ISO_NYM_EPOCH (1u<<6)
  3174. /** Isolate all streams (Internal only). */
  3175. #define ISO_STREAM (1u<<7)
  3176. /**@}*/
  3177. /** Default isolation level for ports. */
  3178. #define ISO_DEFAULT (ISO_CLIENTADDR|ISO_SOCKSAUTH|ISO_SESSIONGRP|ISO_NYM_EPOCH)
  3179. /** Indicates that we haven't yet set a session group on a port_cfg_t. */
  3180. #define SESSION_GROUP_UNSET -1
  3181. /** Session group reserved for directory connections */
  3182. #define SESSION_GROUP_DIRCONN -2
  3183. /** Session group reserved for resolve requests launched by a controller */
  3184. #define SESSION_GROUP_CONTROL_RESOLVE -3
  3185. /** First automatically allocated session group number */
  3186. #define SESSION_GROUP_FIRST_AUTO -4
  3187. /** Configuration for a single port that we're listening on. */
  3188. typedef struct port_cfg_t {
  3189. tor_addr_t addr; /**< The actual IP to listen on, if !is_unix_addr. */
  3190. int port; /**< The configured port, or CFG_AUTO_PORT to tell Tor to pick its
  3191. * own port. */
  3192. uint8_t type; /**< One of CONN_TYPE_*_LISTENER */
  3193. unsigned is_unix_addr : 1; /**< True iff this is an AF_UNIX address. */
  3194. unsigned is_group_writable : 1;
  3195. unsigned is_world_writable : 1;
  3196. unsigned relax_dirmode_check : 1;
  3197. entry_port_cfg_t entry_cfg;
  3198. server_port_cfg_t server_cfg;
  3199. /* Unix sockets only: */
  3200. /** Path for an AF_UNIX address */
  3201. char unix_addr[FLEXIBLE_ARRAY_MEMBER];
  3202. } port_cfg_t;
  3203. typedef struct routerset_t routerset_t;
  3204. /** A magic value for the (Socks|OR|...)Port options below, telling Tor
  3205. * to pick its own port. */
  3206. #define CFG_AUTO_PORT 0xc4005e
  3207. /** Enumeration of outbound address configuration types:
  3208. * Exit-only, OR-only, or both */
  3209. typedef enum {OUTBOUND_ADDR_EXIT, OUTBOUND_ADDR_OR,
  3210. OUTBOUND_ADDR_EXIT_AND_OR,
  3211. OUTBOUND_ADDR_MAX} outbound_addr_t;
  3212. /** Configuration options for a Tor process. */
  3213. typedef struct {
  3214. uint32_t magic_;
  3215. /** What should the tor process actually do? */
  3216. enum {
  3217. CMD_RUN_TOR=0, CMD_LIST_FINGERPRINT, CMD_HASH_PASSWORD,
  3218. CMD_VERIFY_CONFIG, CMD_RUN_UNITTESTS, CMD_DUMP_CONFIG,
  3219. CMD_KEYGEN,
  3220. CMD_KEY_EXPIRATION,
  3221. } command;
  3222. char *command_arg; /**< Argument for command-line option. */
  3223. config_line_t *Logs; /**< New-style list of configuration lines
  3224. * for logs */
  3225. int LogTimeGranularity; /**< Log resolution in milliseconds. */
  3226. int LogMessageDomains; /**< Boolean: Should we log the domain(s) in which
  3227. * each log message occurs? */
  3228. int TruncateLogFile; /**< Boolean: Should we truncate the log file
  3229. before we start writing? */
  3230. char *SyslogIdentityTag; /**< Identity tag to add for syslog logging. */
  3231. char *AndroidIdentityTag; /**< Identity tag to add for Android logging. */
  3232. char *DebugLogFile; /**< Where to send verbose log messages. */
  3233. char *DataDirectory_option; /**< Where to store long-term data, as
  3234. * configured by the user. */
  3235. char *DataDirectory; /**< Where to store long-term data, as modified. */
  3236. int DataDirectoryGroupReadable; /**< Boolean: Is the DataDirectory g+r? */
  3237. char *KeyDirectory_option; /**< Where to store keys, as
  3238. * configured by the user. */
  3239. char *KeyDirectory; /**< Where to store keys data, as modified. */
  3240. int KeyDirectoryGroupReadable; /**< Boolean: Is the KeyDirectory g+r? */
  3241. char *CacheDirectory_option; /**< Where to store cached data, as
  3242. * configured by the user. */
  3243. char *CacheDirectory; /**< Where to store cached data, as modified. */
  3244. int CacheDirectoryGroupReadable; /**< Boolean: Is the CacheDirectory g+r? */
  3245. char *Nickname; /**< OR only: nickname of this onion router. */
  3246. char *Address; /**< OR only: configured address for this onion router. */
  3247. char *PidFile; /**< Where to store PID of Tor process. */
  3248. routerset_t *ExitNodes; /**< Structure containing nicknames, digests,
  3249. * country codes and IP address patterns of ORs to
  3250. * consider as exits. */
  3251. routerset_t *EntryNodes;/**< Structure containing nicknames, digests,
  3252. * country codes and IP address patterns of ORs to
  3253. * consider as entry points. */
  3254. int StrictNodes; /**< Boolean: When none of our EntryNodes or ExitNodes
  3255. * are up, or we need to access a node in ExcludeNodes,
  3256. * do we just fail instead? */
  3257. routerset_t *ExcludeNodes;/**< Structure containing nicknames, digests,
  3258. * country codes and IP address patterns of ORs
  3259. * not to use in circuits. But see StrictNodes
  3260. * above. */
  3261. routerset_t *ExcludeExitNodes;/**< Structure containing nicknames, digests,
  3262. * country codes and IP address patterns of
  3263. * ORs not to consider as exits. */
  3264. /** Union of ExcludeNodes and ExcludeExitNodes */
  3265. routerset_t *ExcludeExitNodesUnion_;
  3266. int DisableAllSwap; /**< Boolean: Attempt to call mlockall() on our
  3267. * process for all current and future memory. */
  3268. config_line_t *ExitPolicy; /**< Lists of exit policy components. */
  3269. int ExitPolicyRejectPrivate; /**< Should we not exit to reserved private
  3270. * addresses, and our own published addresses?
  3271. */
  3272. int ExitPolicyRejectLocalInterfaces; /**< Should we not exit to local
  3273. * interface addresses?
  3274. * Includes OutboundBindAddresses and
  3275. * configured ports. */
  3276. int ReducedExitPolicy; /**<Should we use the Reduced Exit Policy? */
  3277. config_line_t *SocksPolicy; /**< Lists of socks policy components */
  3278. config_line_t *DirPolicy; /**< Lists of dir policy components */
  3279. /** Local address to bind outbound sockets */
  3280. config_line_t *OutboundBindAddress;
  3281. /** Local address to bind outbound relay sockets */
  3282. config_line_t *OutboundBindAddressOR;
  3283. /** Local address to bind outbound exit sockets */
  3284. config_line_t *OutboundBindAddressExit;
  3285. /** Addresses derived from the various OutboundBindAddress lines.
  3286. * [][0] is IPv4, [][1] is IPv6
  3287. */
  3288. tor_addr_t OutboundBindAddresses[OUTBOUND_ADDR_MAX][2];
  3289. /** Directory server only: which versions of
  3290. * Tor should we tell users to run? */
  3291. config_line_t *RecommendedVersions;
  3292. config_line_t *RecommendedClientVersions;
  3293. config_line_t *RecommendedServerVersions;
  3294. config_line_t *RecommendedPackages;
  3295. /** Whether dirservers allow router descriptors with private IPs. */
  3296. int DirAllowPrivateAddresses;
  3297. /** Whether routers accept EXTEND cells to routers with private IPs. */
  3298. int ExtendAllowPrivateAddresses;
  3299. char *User; /**< Name of user to run Tor as. */
  3300. config_line_t *ORPort_lines; /**< Ports to listen on for OR connections. */
  3301. /** Ports to listen on for extended OR connections. */
  3302. config_line_t *ExtORPort_lines;
  3303. /** Ports to listen on for SOCKS connections. */
  3304. config_line_t *SocksPort_lines;
  3305. /** Ports to listen on for transparent pf/netfilter connections. */
  3306. config_line_t *TransPort_lines;
  3307. char *TransProxyType; /**< What kind of transparent proxy
  3308. * implementation are we using? */
  3309. /** Parsed value of TransProxyType. */
  3310. enum {
  3311. TPT_DEFAULT,
  3312. TPT_PF_DIVERT,
  3313. TPT_IPFW,
  3314. TPT_TPROXY,
  3315. } TransProxyType_parsed;
  3316. config_line_t *NATDPort_lines; /**< Ports to listen on for transparent natd
  3317. * connections. */
  3318. /** Ports to listen on for HTTP Tunnel connections. */
  3319. config_line_t *HTTPTunnelPort_lines;
  3320. config_line_t *ControlPort_lines; /**< Ports to listen on for control
  3321. * connections. */
  3322. config_line_t *ControlSocket; /**< List of Unix Domain Sockets to listen on
  3323. * for control connections. */
  3324. int ControlSocketsGroupWritable; /**< Boolean: Are control sockets g+rw? */
  3325. int SocksSocketsGroupWritable; /**< Boolean: Are SOCKS sockets g+rw? */
  3326. /** Ports to listen on for directory connections. */
  3327. config_line_t *DirPort_lines;
  3328. config_line_t *DNSPort_lines; /**< Ports to listen on for DNS requests. */
  3329. /* MaxMemInQueues value as input by the user. We clean this up to be
  3330. * MaxMemInQueues. */
  3331. uint64_t MaxMemInQueues_raw;
  3332. uint64_t MaxMemInQueues;/**< If we have more memory than this allocated
  3333. * for queues and buffers, run the OOM handler */
  3334. /** Above this value, consider ourselves low on RAM. */
  3335. uint64_t MaxMemInQueues_low_threshold;
  3336. /** @name port booleans
  3337. *
  3338. * Derived booleans: For server ports and ControlPort, true iff there is a
  3339. * non-listener port on an AF_INET or AF_INET6 address of the given type
  3340. * configured in one of the _lines options above.
  3341. * For client ports, also true if there is a unix socket configured.
  3342. * If you are checking for client ports, you may want to use:
  3343. * SocksPort_set || TransPort_set || NATDPort_set || DNSPort_set ||
  3344. * HTTPTunnelPort_set
  3345. * rather than SocksPort_set.
  3346. *
  3347. * @{
  3348. */
  3349. unsigned int ORPort_set : 1;
  3350. unsigned int SocksPort_set : 1;
  3351. unsigned int TransPort_set : 1;
  3352. unsigned int NATDPort_set : 1;
  3353. unsigned int ControlPort_set : 1;
  3354. unsigned int DirPort_set : 1;
  3355. unsigned int DNSPort_set : 1;
  3356. unsigned int ExtORPort_set : 1;
  3357. unsigned int HTTPTunnelPort_set : 1;
  3358. /**@}*/
  3359. int AssumeReachable; /**< Whether to publish our descriptor regardless. */
  3360. int AuthoritativeDir; /**< Boolean: is this an authoritative directory? */
  3361. int V3AuthoritativeDir; /**< Boolean: is this an authoritative directory
  3362. * for version 3 directories? */
  3363. int VersioningAuthoritativeDir; /**< Boolean: is this an authoritative
  3364. * directory that's willing to recommend
  3365. * versions? */
  3366. int BridgeAuthoritativeDir; /**< Boolean: is this an authoritative directory
  3367. * that aggregates bridge descriptors? */
  3368. /** If set on a bridge relay, it will include this value on a new
  3369. * "bridge-distribution-request" line in its bridge descriptor. */
  3370. char *BridgeDistribution;
  3371. /** If set on a bridge authority, it will answer requests on its dirport
  3372. * for bridge statuses -- but only if the requests use this password. */
  3373. char *BridgePassword;
  3374. /** If BridgePassword is set, this is a SHA256 digest of the basic http
  3375. * authenticator for it. Used so we can do a time-independent comparison. */
  3376. char *BridgePassword_AuthDigest_;
  3377. int UseBridges; /**< Boolean: should we start all circuits with a bridge? */
  3378. config_line_t *Bridges; /**< List of bootstrap bridge addresses. */
  3379. config_line_t *ClientTransportPlugin; /**< List of client
  3380. transport plugins. */
  3381. config_line_t *ServerTransportPlugin; /**< List of client
  3382. transport plugins. */
  3383. /** List of TCP/IP addresses that transports should listen at. */
  3384. config_line_t *ServerTransportListenAddr;
  3385. /** List of options that must be passed to pluggable transports. */
  3386. config_line_t *ServerTransportOptions;
  3387. int BridgeRelay; /**< Boolean: are we acting as a bridge relay? We make
  3388. * this explicit so we can change how we behave in the
  3389. * future. */
  3390. /** Boolean: if we know the bridge's digest, should we get new
  3391. * descriptors from the bridge authorities or from the bridge itself? */
  3392. int UpdateBridgesFromAuthority;
  3393. int AvoidDiskWrites; /**< Boolean: should we never cache things to disk?
  3394. * Not used yet. */
  3395. int ClientOnly; /**< Boolean: should we never evolve into a server role? */
  3396. int ReducedConnectionPadding; /**< Boolean: Should we try to keep connections
  3397. open shorter and pad them less against
  3398. connection-level traffic analysis? */
  3399. /** Autobool: if auto, then connection padding will be negotiated by client
  3400. * and server. If 0, it will be fully disabled. If 1, the client will still
  3401. * pad to the server regardless of server support. */
  3402. int ConnectionPadding;
  3403. /** To what authority types do we publish our descriptor? Choices are
  3404. * "v1", "v2", "v3", "bridge", or "". */
  3405. smartlist_t *PublishServerDescriptor;
  3406. /** A bitfield of authority types, derived from PublishServerDescriptor. */
  3407. dirinfo_type_t PublishServerDescriptor_;
  3408. /** Boolean: do we publish hidden service descriptors to the HS auths? */
  3409. int PublishHidServDescriptors;
  3410. int FetchServerDescriptors; /**< Do we fetch server descriptors as normal? */
  3411. int FetchHidServDescriptors; /**< and hidden service descriptors? */
  3412. int MinUptimeHidServDirectoryV2; /**< As directory authority, accept hidden
  3413. * service directories after what time? */
  3414. int FetchUselessDescriptors; /**< Do we fetch non-running descriptors too? */
  3415. int AllDirActionsPrivate; /**< Should every directory action be sent
  3416. * through a Tor circuit? */
  3417. /** Run in 'tor2web mode'? (I.e. only make client connections to hidden
  3418. * services, and use a single hop for all hidden-service-related
  3419. * circuits.) */
  3420. int Tor2webMode;
  3421. /** A routerset that should be used when picking RPs for HS circuits. */
  3422. routerset_t *Tor2webRendezvousPoints;
  3423. /** A routerset that should be used when picking middle nodes for HS
  3424. * circuits. */
  3425. routerset_t *HSLayer2Nodes;
  3426. /** A routerset that should be used when picking third-hop nodes for HS
  3427. * circuits. */
  3428. routerset_t *HSLayer3Nodes;
  3429. /** Onion Services in HiddenServiceSingleHopMode make one-hop (direct)
  3430. * circuits between the onion service server, and the introduction and
  3431. * rendezvous points. (Onion service descriptors are still posted using
  3432. * 3-hop paths, to avoid onion service directories blocking the service.)
  3433. * This option makes every hidden service instance hosted by
  3434. * this tor instance a Single Onion Service.
  3435. * HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be
  3436. * set to 1.
  3437. * Use rend_service_allow_non_anonymous_connection() or
  3438. * rend_service_reveal_startup_time() instead of using this option directly.
  3439. */
  3440. int HiddenServiceSingleHopMode;
  3441. /* Makes hidden service clients and servers non-anonymous on this tor
  3442. * instance. Allows the non-anonymous HiddenServiceSingleHopMode. Enables
  3443. * non-anonymous behaviour in the hidden service protocol.
  3444. * Use rend_service_non_anonymous_mode_enabled() instead of using this option
  3445. * directly.
  3446. */
  3447. int HiddenServiceNonAnonymousMode;
  3448. int ConnLimit; /**< Demanded minimum number of simultaneous connections. */
  3449. int ConnLimit_; /**< Maximum allowed number of simultaneous connections. */
  3450. int ConnLimit_high_thresh; /**< start trying to lower socket usage if we
  3451. * have this many. */
  3452. int ConnLimit_low_thresh; /**< try to get down to here after socket
  3453. * exhaustion. */
  3454. int RunAsDaemon; /**< If true, run in the background. (Unix only) */
  3455. int FascistFirewall; /**< Whether to prefer ORs reachable on open ports. */
  3456. smartlist_t *FirewallPorts; /**< Which ports our firewall allows
  3457. * (strings). */
  3458. config_line_t *ReachableAddresses; /**< IP:ports our firewall allows. */
  3459. config_line_t *ReachableORAddresses; /**< IP:ports for OR conns. */
  3460. config_line_t *ReachableDirAddresses; /**< IP:ports for Dir conns. */
  3461. int ConstrainedSockets; /**< Shrink xmit and recv socket buffers. */
  3462. uint64_t ConstrainedSockSize; /**< Size of constrained buffers. */
  3463. /** Whether we should drop exit streams from Tors that we don't know are
  3464. * relays. One of "0" (never refuse), "1" (always refuse), or "-1" (do
  3465. * what the consensus says, defaulting to 'refuse' if the consensus says
  3466. * nothing). */
  3467. int RefuseUnknownExits;
  3468. /** Application ports that require all nodes in circ to have sufficient
  3469. * uptime. */
  3470. smartlist_t *LongLivedPorts;
  3471. /** Application ports that are likely to be unencrypted and
  3472. * unauthenticated; we reject requests for them to prevent the
  3473. * user from screwing up and leaking plaintext secrets to an
  3474. * observer somewhere on the Internet. */
  3475. smartlist_t *RejectPlaintextPorts;
  3476. /** Related to RejectPlaintextPorts above, except this config option
  3477. * controls whether we warn (in the log and via a controller status
  3478. * event) every time a risky connection is attempted. */
  3479. smartlist_t *WarnPlaintextPorts;
  3480. /** Should we try to reuse the same exit node for a given host */
  3481. smartlist_t *TrackHostExits;
  3482. int TrackHostExitsExpire; /**< Number of seconds until we expire an
  3483. * addressmap */
  3484. config_line_t *AddressMap; /**< List of address map directives. */
  3485. int AutomapHostsOnResolve; /**< If true, when we get a resolve request for a
  3486. * hostname ending with one of the suffixes in
  3487. * <b>AutomapHostsSuffixes</b>, map it to a
  3488. * virtual address. */
  3489. /** List of suffixes for <b>AutomapHostsOnResolve</b>. The special value
  3490. * "." means "match everything." */
  3491. smartlist_t *AutomapHostsSuffixes;
  3492. int RendPostPeriod; /**< How often do we post each rendezvous service
  3493. * descriptor? Remember to publish them independently. */
  3494. int KeepalivePeriod; /**< How often do we send padding cells to keep
  3495. * connections alive? */
  3496. int SocksTimeout; /**< How long do we let a socks connection wait
  3497. * unattached before we fail it? */
  3498. int LearnCircuitBuildTimeout; /**< If non-zero, we attempt to learn a value
  3499. * for CircuitBuildTimeout based on timeout
  3500. * history. Use circuit_build_times_disabled()
  3501. * rather than checking this value directly. */
  3502. int CircuitBuildTimeout; /**< Cull non-open circuits that were born at
  3503. * least this many seconds ago. Used until
  3504. * adaptive algorithm learns a new value. */
  3505. int CircuitsAvailableTimeout; /**< Try to have an open circuit for at
  3506. least this long after last activity */
  3507. int CircuitStreamTimeout; /**< If non-zero, detach streams from circuits
  3508. * and try a new circuit if the stream has been
  3509. * waiting for this many seconds. If zero, use
  3510. * our default internal timeout schedule. */
  3511. int MaxOnionQueueDelay; /*< DOCDOC */
  3512. int NewCircuitPeriod; /**< How long do we use a circuit before building
  3513. * a new one? */
  3514. int MaxCircuitDirtiness; /**< Never use circs that were first used more than
  3515. this interval ago. */
  3516. uint64_t BandwidthRate; /**< How much bandwidth, on average, are we willing
  3517. * to use in a second? */
  3518. uint64_t BandwidthBurst; /**< How much bandwidth, at maximum, are we willing
  3519. * to use in a second? */
  3520. uint64_t MaxAdvertisedBandwidth; /**< How much bandwidth are we willing to
  3521. * tell other nodes we have? */
  3522. uint64_t RelayBandwidthRate; /**< How much bandwidth, on average, are we
  3523. * willing to use for all relayed conns? */
  3524. uint64_t RelayBandwidthBurst; /**< How much bandwidth, at maximum, will we
  3525. * use in a second for all relayed conns? */
  3526. uint64_t PerConnBWRate; /**< Long-term bw on a single TLS conn, if set. */
  3527. uint64_t PerConnBWBurst; /**< Allowed burst on a single TLS conn, if set. */
  3528. int NumCPUs; /**< How many CPUs should we try to use? */
  3529. config_line_t *RendConfigLines; /**< List of configuration lines
  3530. * for rendezvous services. */
  3531. config_line_t *HidServAuth; /**< List of configuration lines for client-side
  3532. * authorizations for hidden services */
  3533. char *ContactInfo; /**< Contact info to be published in the directory. */
  3534. int HeartbeatPeriod; /**< Log heartbeat messages after this many seconds
  3535. * have passed. */
  3536. int MainloopStats; /**< Log main loop statistics as part of the
  3537. * heartbeat messages. */
  3538. char *HTTPProxy; /**< hostname[:port] to use as http proxy, if any. */
  3539. tor_addr_t HTTPProxyAddr; /**< Parsed IPv4 addr for http proxy, if any. */
  3540. uint16_t HTTPProxyPort; /**< Parsed port for http proxy, if any. */
  3541. char *HTTPProxyAuthenticator; /**< username:password string, if any. */
  3542. char *HTTPSProxy; /**< hostname[:port] to use as https proxy, if any. */
  3543. tor_addr_t HTTPSProxyAddr; /**< Parsed addr for https proxy, if any. */
  3544. uint16_t HTTPSProxyPort; /**< Parsed port for https proxy, if any. */
  3545. char *HTTPSProxyAuthenticator; /**< username:password string, if any. */
  3546. char *Socks4Proxy; /**< hostname:port to use as a SOCKS4 proxy, if any. */
  3547. tor_addr_t Socks4ProxyAddr; /**< Derived from Socks4Proxy. */
  3548. uint16_t Socks4ProxyPort; /**< Derived from Socks4Proxy. */
  3549. char *Socks5Proxy; /**< hostname:port to use as a SOCKS5 proxy, if any. */
  3550. tor_addr_t Socks5ProxyAddr; /**< Derived from Sock5Proxy. */
  3551. uint16_t Socks5ProxyPort; /**< Derived from Socks5Proxy. */
  3552. char *Socks5ProxyUsername; /**< Username for SOCKS5 authentication, if any */
  3553. char *Socks5ProxyPassword; /**< Password for SOCKS5 authentication, if any */
  3554. /** List of configuration lines for replacement directory authorities.
  3555. * If you just want to replace one class of authority at a time,
  3556. * use the "Alternate*Authority" options below instead. */
  3557. config_line_t *DirAuthorities;
  3558. /** List of fallback directory servers */
  3559. config_line_t *FallbackDir;
  3560. /** Whether to use the default hard-coded FallbackDirs */
  3561. int UseDefaultFallbackDirs;
  3562. /** Weight to apply to all directory authority rates if considering them
  3563. * along with fallbackdirs */
  3564. double DirAuthorityFallbackRate;
  3565. /** If set, use these main (currently v3) directory authorities and
  3566. * not the default ones. */
  3567. config_line_t *AlternateDirAuthority;
  3568. /** If set, use these bridge authorities and not the default one. */
  3569. config_line_t *AlternateBridgeAuthority;
  3570. config_line_t *MyFamily_lines; /**< Declared family for this OR. */
  3571. config_line_t *MyFamily; /**< Declared family for this OR, normalized */
  3572. config_line_t *NodeFamilies; /**< List of config lines for
  3573. * node families */
  3574. smartlist_t *NodeFamilySets; /**< List of parsed NodeFamilies values. */
  3575. config_line_t *AuthDirBadExit; /**< Address policy for descriptors to
  3576. * mark as bad exits. */
  3577. config_line_t *AuthDirReject; /**< Address policy for descriptors to
  3578. * reject. */
  3579. config_line_t *AuthDirInvalid; /**< Address policy for descriptors to
  3580. * never mark as valid. */
  3581. /** @name AuthDir...CC
  3582. *
  3583. * Lists of country codes to mark as BadExit, or Invalid, or to
  3584. * reject entirely.
  3585. *
  3586. * @{
  3587. */
  3588. smartlist_t *AuthDirBadExitCCs;
  3589. smartlist_t *AuthDirInvalidCCs;
  3590. smartlist_t *AuthDirRejectCCs;
  3591. /**@}*/
  3592. int AuthDirListBadExits; /**< True iff we should list bad exits,
  3593. * and vote for all other exits as good. */
  3594. int AuthDirMaxServersPerAddr; /**< Do not permit more than this
  3595. * number of servers per IP address. */
  3596. int AuthDirHasIPv6Connectivity; /**< Boolean: are we on IPv6? */
  3597. int AuthDirPinKeys; /**< Boolean: Do we enforce key-pinning? */
  3598. /** If non-zero, always vote the Fast flag for any relay advertising
  3599. * this amount of capacity or more. */
  3600. uint64_t AuthDirFastGuarantee;
  3601. /** If non-zero, this advertised capacity or more is always sufficient
  3602. * to satisfy the bandwidth requirement for the Guard flag. */
  3603. uint64_t AuthDirGuardBWGuarantee;
  3604. char *AccountingStart; /**< How long is the accounting interval, and when
  3605. * does it start? */
  3606. uint64_t AccountingMax; /**< How many bytes do we allow per accounting
  3607. * interval before hibernation? 0 for "never
  3608. * hibernate." */
  3609. /** How do we determine when our AccountingMax has been reached?
  3610. * "max" for when in or out reaches AccountingMax
  3611. * "sum" for when in plus out reaches AccountingMax
  3612. * "in" for when in reaches AccountingMax
  3613. * "out" for when out reaches AccountingMax */
  3614. char *AccountingRule_option;
  3615. enum { ACCT_MAX, ACCT_SUM, ACCT_IN, ACCT_OUT } AccountingRule;
  3616. /** Base64-encoded hash of accepted passwords for the control system. */
  3617. config_line_t *HashedControlPassword;
  3618. /** As HashedControlPassword, but not saved. */
  3619. config_line_t *HashedControlSessionPassword;
  3620. int CookieAuthentication; /**< Boolean: do we enable cookie-based auth for
  3621. * the control system? */
  3622. char *CookieAuthFile; /**< Filesystem location of a ControlPort
  3623. * authentication cookie. */
  3624. char *ExtORPortCookieAuthFile; /**< Filesystem location of Extended
  3625. * ORPort authentication cookie. */
  3626. int CookieAuthFileGroupReadable; /**< Boolean: Is the CookieAuthFile g+r? */
  3627. int ExtORPortCookieAuthFileGroupReadable; /**< Boolean: Is the
  3628. * ExtORPortCookieAuthFile g+r? */
  3629. int LeaveStreamsUnattached; /**< Boolean: Does Tor attach new streams to
  3630. * circuits itself (0), or does it expect a controller
  3631. * to cope? (1) */
  3632. int DisablePredictedCircuits; /**< Boolean: does Tor preemptively
  3633. * make circuits in the background (0),
  3634. * or not (1)? */
  3635. /** Process specifier for a controller that ‘owns’ this Tor
  3636. * instance. Tor will terminate if its owning controller does. */
  3637. char *OwningControllerProcess;
  3638. /** FD specifier for a controller that owns this Tor instance. */
  3639. int OwningControllerFD;
  3640. int ShutdownWaitLength; /**< When we get a SIGINT and we're a server, how
  3641. * long do we wait before exiting? */
  3642. char *SafeLogging; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
  3643. /* Derived from SafeLogging */
  3644. enum {
  3645. SAFELOG_SCRUB_ALL, SAFELOG_SCRUB_RELAY, SAFELOG_SCRUB_NONE
  3646. } SafeLogging_;
  3647. int Sandbox; /**< Boolean: should sandboxing be enabled? */
  3648. int SafeSocks; /**< Boolean: should we outright refuse application
  3649. * connections that use socks4 or socks5-with-local-dns? */
  3650. int ProtocolWarnings; /**< Boolean: when other parties screw up the Tor
  3651. * protocol, is it a warn or an info in our logs? */
  3652. int TestSocks; /**< Boolean: when we get a socks connection, do we loudly
  3653. * log whether it was DNS-leaking or not? */
  3654. int HardwareAccel; /**< Boolean: Should we enable OpenSSL hardware
  3655. * acceleration where available? */
  3656. /** Token Bucket Refill resolution in milliseconds. */
  3657. int TokenBucketRefillInterval;
  3658. char *AccelName; /**< Optional hardware acceleration engine name. */
  3659. char *AccelDir; /**< Optional hardware acceleration engine search dir. */
  3660. /** Boolean: Do we try to enter from a smallish number
  3661. * of fixed nodes? */
  3662. int UseEntryGuards_option;
  3663. /** Internal variable to remember whether we're actually acting on
  3664. * UseEntryGuards_option -- when we're a non-anonymous Tor2web client or
  3665. * Single Onion Service, it is always false, otherwise we use the value of
  3666. * UseEntryGuards_option. */
  3667. int UseEntryGuards;
  3668. int NumEntryGuards; /**< How many entry guards do we try to establish? */
  3669. /** If 1, we use any guardfraction information we see in the
  3670. * consensus. If 0, we don't. If -1, let the consensus parameter
  3671. * decide. */
  3672. int UseGuardFraction;
  3673. int NumDirectoryGuards; /**< How many dir guards do we try to establish?
  3674. * If 0, use value from NumEntryGuards. */
  3675. int RephistTrackTime; /**< How many seconds do we keep rephist info? */
  3676. /** Should we always fetch our dir info on the mirror schedule (which
  3677. * means directly from the authorities) no matter our other config? */
  3678. int FetchDirInfoEarly;
  3679. /** Should we fetch our dir info at the start of the consensus period? */
  3680. int FetchDirInfoExtraEarly;
  3681. int DirCache; /**< Cache all directory documents and accept requests via
  3682. * tunnelled dir conns from clients. If 1, enabled (default);
  3683. * If 0, disabled. */
  3684. char *VirtualAddrNetworkIPv4; /**< Address and mask to hand out for virtual
  3685. * MAPADDRESS requests for IPv4 addresses */
  3686. char *VirtualAddrNetworkIPv6; /**< Address and mask to hand out for virtual
  3687. * MAPADDRESS requests for IPv6 addresses */
  3688. int ServerDNSSearchDomains; /**< Boolean: If set, we don't force exit
  3689. * addresses to be FQDNs, but rather search for them in
  3690. * the local domains. */
  3691. int ServerDNSDetectHijacking; /**< Boolean: If true, check for DNS failure
  3692. * hijacking. */
  3693. int ServerDNSRandomizeCase; /**< Boolean: Use the 0x20-hack to prevent
  3694. * DNS poisoning attacks. */
  3695. char *ServerDNSResolvConfFile; /**< If provided, we configure our internal
  3696. * resolver from the file here rather than from
  3697. * /etc/resolv.conf (Unix) or the registry (Windows). */
  3698. char *DirPortFrontPage; /**< This is a full path to a file with an html
  3699. disclaimer. This allows a server administrator to show
  3700. that they're running Tor and anyone visiting their server
  3701. will know this without any specialized knowledge. */
  3702. int DisableDebuggerAttachment; /**< Currently Linux only specific attempt to
  3703. disable ptrace; needs BSD testing. */
  3704. /** Boolean: if set, we start even if our resolv.conf file is missing
  3705. * or broken. */
  3706. int ServerDNSAllowBrokenConfig;
  3707. /** Boolean: if set, then even connections to private addresses will get
  3708. * rate-limited. */
  3709. int CountPrivateBandwidth;
  3710. smartlist_t *ServerDNSTestAddresses; /**< A list of addresses that definitely
  3711. * should be resolvable. Used for
  3712. * testing our DNS server. */
  3713. int EnforceDistinctSubnets; /**< If true, don't allow multiple routers in the
  3714. * same network zone in the same circuit. */
  3715. int PortForwarding; /**< If true, use NAT-PMP or UPnP to automatically
  3716. * forward the DirPort and ORPort on the NAT device */
  3717. char *PortForwardingHelper; /** < Filename or full path of the port
  3718. forwarding helper executable */
  3719. int AllowNonRFC953Hostnames; /**< If true, we allow connections to hostnames
  3720. * with weird characters. */
  3721. /** If true, we try resolving hostnames with weird characters. */
  3722. int ServerDNSAllowNonRFC953Hostnames;
  3723. /** If true, we try to download extra-info documents (and we serve them,
  3724. * if we are a cache). For authorities, this is always true. */
  3725. int DownloadExtraInfo;
  3726. /** If true, we're configured to collect statistics on clients
  3727. * requesting network statuses from us as directory. */
  3728. int DirReqStatistics_option;
  3729. /** Internal variable to remember whether we're actually acting on
  3730. * DirReqStatistics_option -- yes if it's set and we're a server, else no. */
  3731. int DirReqStatistics;
  3732. /** If true, the user wants us to collect statistics on port usage. */
  3733. int ExitPortStatistics;
  3734. /** If true, the user wants us to collect connection statistics. */
  3735. int ConnDirectionStatistics;
  3736. /** If true, the user wants us to collect cell statistics. */
  3737. int CellStatistics;
  3738. /** If true, the user wants us to collect padding statistics. */
  3739. int PaddingStatistics;
  3740. /** If true, the user wants us to collect statistics as entry node. */
  3741. int EntryStatistics;
  3742. /** If true, the user wants us to collect statistics as hidden service
  3743. * directory, introduction point, or rendezvous point. */
  3744. int HiddenServiceStatistics_option;
  3745. /** Internal variable to remember whether we're actually acting on
  3746. * HiddenServiceStatistics_option -- yes if it's set and we're a server,
  3747. * else no. */
  3748. int HiddenServiceStatistics;
  3749. /** If true, include statistics file contents in extra-info documents. */
  3750. int ExtraInfoStatistics;
  3751. /** If true, do not believe anybody who tells us that a domain resolves
  3752. * to an internal address, or that an internal address has a PTR mapping.
  3753. * Helps avoid some cross-site attacks. */
  3754. int ClientDNSRejectInternalAddresses;
  3755. /** If true, do not accept any requests to connect to internal addresses
  3756. * over randomly chosen exits. */
  3757. int ClientRejectInternalAddresses;
  3758. /** If true, clients may connect over IPv4. If false, they will avoid
  3759. * connecting over IPv4. We enforce this for OR and Dir connections. */
  3760. int ClientUseIPv4;
  3761. /** If true, clients may connect over IPv6. If false, they will avoid
  3762. * connecting over IPv4. We enforce this for OR and Dir connections.
  3763. * Use fascist_firewall_use_ipv6() instead of accessing this value
  3764. * directly. */
  3765. int ClientUseIPv6;
  3766. /** If true, prefer an IPv6 OR port over an IPv4 one for entry node
  3767. * connections. If auto, bridge clients prefer IPv6, and other clients
  3768. * prefer IPv4. Use node_ipv6_or_preferred() instead of accessing this value
  3769. * directly. */
  3770. int ClientPreferIPv6ORPort;
  3771. /** If true, prefer an IPv6 directory port over an IPv4 one for direct
  3772. * directory connections. If auto, bridge clients prefer IPv6, and other
  3773. * clients prefer IPv4. Use fascist_firewall_prefer_ipv6_dirport() instead of
  3774. * accessing this value directly. */
  3775. int ClientPreferIPv6DirPort;
  3776. /** The length of time that we think a consensus should be fresh. */
  3777. int V3AuthVotingInterval;
  3778. /** The length of time we think it will take to distribute votes. */
  3779. int V3AuthVoteDelay;
  3780. /** The length of time we think it will take to distribute signatures. */
  3781. int V3AuthDistDelay;
  3782. /** The number of intervals we think a consensus should be valid. */
  3783. int V3AuthNIntervalsValid;
  3784. /** Should advertise and sign consensuses with a legacy key, for key
  3785. * migration purposes? */
  3786. int V3AuthUseLegacyKey;
  3787. /** Location of bandwidth measurement file */
  3788. char *V3BandwidthsFile;
  3789. /** Location of guardfraction file */
  3790. char *GuardfractionFile;
  3791. /** Authority only: key=value pairs that we add to our networkstatus
  3792. * consensus vote on the 'params' line. */
  3793. char *ConsensusParams;
  3794. /** Authority only: minimum number of measured bandwidths we must see
  3795. * before we only believe measured bandwidths to assign flags. */
  3796. int MinMeasuredBWsForAuthToIgnoreAdvertised;
  3797. /** The length of time that we think an initial consensus should be fresh.
  3798. * Only altered on testing networks. */
  3799. int TestingV3AuthInitialVotingInterval;
  3800. /** The length of time we think it will take to distribute initial votes.
  3801. * Only altered on testing networks. */
  3802. int TestingV3AuthInitialVoteDelay;
  3803. /** The length of time we think it will take to distribute initial
  3804. * signatures. Only altered on testing networks.*/
  3805. int TestingV3AuthInitialDistDelay;
  3806. /** Offset in seconds added to the starting time for consensus
  3807. voting. Only altered on testing networks. */
  3808. int TestingV3AuthVotingStartOffset;
  3809. /** If an authority has been around for less than this amount of time, it
  3810. * does not believe its reachability information is accurate. Only
  3811. * altered on testing networks. */
  3812. int TestingAuthDirTimeToLearnReachability;
  3813. /** Clients don't download any descriptor this recent, since it will
  3814. * probably not have propagated to enough caches. Only altered on testing
  3815. * networks. */
  3816. int TestingEstimatedDescriptorPropagationTime;
  3817. /** Schedule for when servers should download things in general. Only
  3818. * altered on testing networks. */
  3819. smartlist_t *TestingServerDownloadSchedule;
  3820. /** Schedule for when clients should download things in general. Only
  3821. * altered on testing networks. */
  3822. smartlist_t *TestingClientDownloadSchedule;
  3823. /** Schedule for when servers should download consensuses. Only altered
  3824. * on testing networks. */
  3825. smartlist_t *TestingServerConsensusDownloadSchedule;
  3826. /** Schedule for when clients should download consensuses. Only altered
  3827. * on testing networks. */
  3828. smartlist_t *TestingClientConsensusDownloadSchedule;
  3829. /** Schedule for when clients should download consensuses from authorities
  3830. * if they are bootstrapping (that is, they don't have a usable, reasonably
  3831. * live consensus). Only used by clients fetching from a list of fallback
  3832. * directory mirrors.
  3833. *
  3834. * This schedule is incremented by (potentially concurrent) connection
  3835. * attempts, unlike other schedules, which are incremented by connection
  3836. * failures. Only altered on testing networks. */
  3837. smartlist_t *ClientBootstrapConsensusAuthorityDownloadSchedule;
  3838. /** Schedule for when clients should download consensuses from fallback
  3839. * directory mirrors if they are bootstrapping (that is, they don't have a
  3840. * usable, reasonably live consensus). Only used by clients fetching from a
  3841. * list of fallback directory mirrors.
  3842. *
  3843. * This schedule is incremented by (potentially concurrent) connection
  3844. * attempts, unlike other schedules, which are incremented by connection
  3845. * failures. Only altered on testing networks. */
  3846. smartlist_t *ClientBootstrapConsensusFallbackDownloadSchedule;
  3847. /** Schedule for when clients should download consensuses from authorities
  3848. * if they are bootstrapping (that is, they don't have a usable, reasonably
  3849. * live consensus). Only used by clients which don't have or won't fetch
  3850. * from a list of fallback directory mirrors.
  3851. *
  3852. * This schedule is incremented by (potentially concurrent) connection
  3853. * attempts, unlike other schedules, which are incremented by connection
  3854. * failures. Only altered on testing networks. */
  3855. smartlist_t *ClientBootstrapConsensusAuthorityOnlyDownloadSchedule;
  3856. /** Schedule for when clients should download bridge descriptors. Only
  3857. * altered on testing networks. */
  3858. smartlist_t *TestingBridgeDownloadSchedule;
  3859. /** Schedule for when clients should download bridge descriptors when they
  3860. * have no running bridges. Only altered on testing networks. */
  3861. smartlist_t *TestingBridgeBootstrapDownloadSchedule;
  3862. /** When directory clients have only a few descriptors to request, they
  3863. * batch them until they have more, or until this amount of time has
  3864. * passed. Only altered on testing networks. */
  3865. int TestingClientMaxIntervalWithoutRequest;
  3866. /** How long do we let a directory connection stall before expiring
  3867. * it? Only altered on testing networks. */
  3868. int TestingDirConnectionMaxStall;
  3869. /** How many times will we try to fetch a consensus before we give
  3870. * up? Only altered on testing networks. */
  3871. int TestingConsensusMaxDownloadTries;
  3872. /** How many times will a client try to fetch a consensus while
  3873. * bootstrapping using a list of fallback directories, before it gives up?
  3874. * Only altered on testing networks. */
  3875. int ClientBootstrapConsensusMaxDownloadTries;
  3876. /** How many times will a client try to fetch a consensus while
  3877. * bootstrapping using only a list of authorities, before it gives up?
  3878. * Only altered on testing networks. */
  3879. int ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries;
  3880. /** How many simultaneous in-progress connections will we make when trying
  3881. * to fetch a consensus before we wait for one to complete, timeout, or
  3882. * error out? Only altered on testing networks. */
  3883. int ClientBootstrapConsensusMaxInProgressTries;
  3884. /** How many times will we try to download a router's descriptor before
  3885. * giving up? Only altered on testing networks. */
  3886. int TestingDescriptorMaxDownloadTries;
  3887. /** How many times will we try to download a microdescriptor before
  3888. * giving up? Only altered on testing networks. */
  3889. int TestingMicrodescMaxDownloadTries;
  3890. /** How many times will we try to fetch a certificate before giving
  3891. * up? Only altered on testing networks. */
  3892. int TestingCertMaxDownloadTries;
  3893. /** If true, we take part in a testing network. Change the defaults of a
  3894. * couple of other configuration options and allow to change the values
  3895. * of certain configuration options. */
  3896. int TestingTorNetwork;
  3897. /** Minimum value for the Exit flag threshold on testing networks. */
  3898. uint64_t TestingMinExitFlagThreshold;
  3899. /** Minimum value for the Fast flag threshold on testing networks. */
  3900. uint64_t TestingMinFastFlagThreshold;
  3901. /** Relays in a testing network which should be voted Exit
  3902. * regardless of exit policy. */
  3903. routerset_t *TestingDirAuthVoteExit;
  3904. int TestingDirAuthVoteExitIsStrict;
  3905. /** Relays in a testing network which should be voted Guard
  3906. * regardless of uptime and bandwidth. */
  3907. routerset_t *TestingDirAuthVoteGuard;
  3908. int TestingDirAuthVoteGuardIsStrict;
  3909. /** Relays in a testing network which should be voted HSDir
  3910. * regardless of uptime and DirPort. */
  3911. routerset_t *TestingDirAuthVoteHSDir;
  3912. int TestingDirAuthVoteHSDirIsStrict;
  3913. /** Enable CONN_BW events. Only altered on testing networks. */
  3914. int TestingEnableConnBwEvent;
  3915. /** Enable CELL_STATS events. Only altered on testing networks. */
  3916. int TestingEnableCellStatsEvent;
  3917. /** Enable TB_EMPTY events. Only altered on testing networks. */
  3918. int TestingEnableTbEmptyEvent;
  3919. /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
  3920. * count of how many client addresses have contacted us so that we can help
  3921. * the bridge authority guess which countries have blocked access to us. */
  3922. int BridgeRecordUsageByCountry;
  3923. /** Optionally, IPv4 and IPv6 GeoIP data. */
  3924. char *GeoIPFile;
  3925. char *GeoIPv6File;
  3926. /** Autobool: if auto, then any attempt to Exclude{Exit,}Nodes a particular
  3927. * country code will exclude all nodes in ?? and A1. If true, all nodes in
  3928. * ?? and A1 are excluded. Has no effect if we don't know any GeoIP data. */
  3929. int GeoIPExcludeUnknown;
  3930. /** If true, SIGHUP should reload the torrc. Sometimes controllers want
  3931. * to make this false. */
  3932. int ReloadTorrcOnSIGHUP;
  3933. /* The main parameter for picking circuits within a connection.
  3934. *
  3935. * If this value is positive, when picking a cell to relay on a connection,
  3936. * we always relay from the circuit whose weighted cell count is lowest.
  3937. * Cells are weighted exponentially such that if one cell is sent
  3938. * 'CircuitPriorityHalflife' seconds before another, it counts for half as
  3939. * much.
  3940. *
  3941. * If this value is zero, we're disabling the cell-EWMA algorithm.
  3942. *
  3943. * If this value is negative, we're using the default approach
  3944. * according to either Tor or a parameter set in the consensus.
  3945. */
  3946. double CircuitPriorityHalflife;
  3947. /** Set to true if the TestingTorNetwork configuration option is set.
  3948. * This is used so that options_validate() has a chance to realize that
  3949. * the defaults have changed. */
  3950. int UsingTestNetworkDefaults_;
  3951. /** If 1, we try to use microdescriptors to build circuits. If 0, we don't.
  3952. * If -1, Tor decides. */
  3953. int UseMicrodescriptors;
  3954. /** File where we should write the ControlPort. */
  3955. char *ControlPortWriteToFile;
  3956. /** Should that file be group-readable? */
  3957. int ControlPortFileGroupReadable;
  3958. #define MAX_MAX_CLIENT_CIRCUITS_PENDING 1024
  3959. /** Maximum number of non-open general-purpose origin circuits to allow at
  3960. * once. */
  3961. int MaxClientCircuitsPending;
  3962. /** If 1, we always send optimistic data when it's supported. If 0, we
  3963. * never use it. If -1, we do what the consensus says. */
  3964. int OptimisticData;
  3965. /** If 1, we accept and launch no external network connections, except on
  3966. * control ports. */
  3967. int DisableNetwork;
  3968. /**
  3969. * Parameters for path-bias detection.
  3970. * @{
  3971. * These options override the default behavior of Tor's (**currently
  3972. * experimental**) path bias detection algorithm. To try to find broken or
  3973. * misbehaving guard nodes, Tor looks for nodes where more than a certain
  3974. * fraction of circuits through that guard fail to get built.
  3975. *
  3976. * The PathBiasCircThreshold option controls how many circuits we need to
  3977. * build through a guard before we make these checks. The
  3978. * PathBiasNoticeRate, PathBiasWarnRate and PathBiasExtremeRate options
  3979. * control what fraction of circuits must succeed through a guard so we
  3980. * won't write log messages. If less than PathBiasExtremeRate circuits
  3981. * succeed *and* PathBiasDropGuards is set to 1, we disable use of that
  3982. * guard.
  3983. *
  3984. * When we have seen more than PathBiasScaleThreshold circuits through a
  3985. * guard, we scale our observations by 0.5 (governed by the consensus) so
  3986. * that new observations don't get swamped by old ones.
  3987. *
  3988. * By default, or if a negative value is provided for one of these options,
  3989. * Tor uses reasonable defaults from the networkstatus consensus document.
  3990. * If no defaults are available there, these options default to 150, .70,
  3991. * .50, .30, 0, and 300 respectively.
  3992. */
  3993. int PathBiasCircThreshold;
  3994. double PathBiasNoticeRate;
  3995. double PathBiasWarnRate;
  3996. double PathBiasExtremeRate;
  3997. int PathBiasDropGuards;
  3998. int PathBiasScaleThreshold;
  3999. /** @} */
  4000. /**
  4001. * Parameters for path-bias use detection
  4002. * @{
  4003. * Similar to the above options, these options override the default behavior
  4004. * of Tor's (**currently experimental**) path use bias detection algorithm.
  4005. *
  4006. * Where as the path bias parameters govern thresholds for successfully
  4007. * building circuits, these four path use bias parameters govern thresholds
  4008. * only for circuit usage. Circuits which receive no stream usage are not
  4009. * counted by this detection algorithm. A used circuit is considered
  4010. * successful if it is capable of carrying streams or otherwise receiving
  4011. * well-formed responses to RELAY cells.
  4012. *
  4013. * By default, or if a negative value is provided for one of these options,
  4014. * Tor uses reasonable defaults from the networkstatus consensus document.
  4015. * If no defaults are available there, these options default to 20, .80,
  4016. * .60, and 100, respectively.
  4017. */
  4018. int PathBiasUseThreshold;
  4019. double PathBiasNoticeUseRate;
  4020. double PathBiasExtremeUseRate;
  4021. int PathBiasScaleUseThreshold;
  4022. /** @} */
  4023. int IPv6Exit; /**< Do we support exiting to IPv6 addresses? */
  4024. /** Fraction: */
  4025. double PathsNeededToBuildCircuits;
  4026. /** What expiry time shall we place on our SSL certs? "0" means we
  4027. * should guess a suitable value. */
  4028. int SSLKeyLifetime;
  4029. /** How long (seconds) do we keep a guard before picking a new one? */
  4030. int GuardLifetime;
  4031. /** Is this an exit node? This is a tristate, where "1" means "yes, and use
  4032. * the default exit policy if none is given" and "0" means "no; exit policy
  4033. * is 'reject *'" and "auto" (-1) means "same as 1, but warn the user."
  4034. *
  4035. * XXXX Eventually, the default will be 0. */
  4036. int ExitRelay;
  4037. /** For how long (seconds) do we declare our signing keys to be valid? */
  4038. int SigningKeyLifetime;
  4039. /** For how long (seconds) do we declare our link keys to be valid? */
  4040. int TestingLinkCertLifetime;
  4041. /** For how long (seconds) do we declare our auth keys to be valid? */
  4042. int TestingAuthKeyLifetime;
  4043. /** How long before signing keys expire will we try to make a new one? */
  4044. int TestingSigningKeySlop;
  4045. /** How long before link keys expire will we try to make a new one? */
  4046. int TestingLinkKeySlop;
  4047. /** How long before auth keys expire will we try to make a new one? */
  4048. int TestingAuthKeySlop;
  4049. /** Force use of offline master key features: never generate a master
  4050. * ed25519 identity key except from tor --keygen */
  4051. int OfflineMasterKey;
  4052. enum {
  4053. FORCE_PASSPHRASE_AUTO=0,
  4054. FORCE_PASSPHRASE_ON,
  4055. FORCE_PASSPHRASE_OFF
  4056. } keygen_force_passphrase;
  4057. int use_keygen_passphrase_fd;
  4058. int keygen_passphrase_fd;
  4059. int change_key_passphrase;
  4060. char *master_key_fname;
  4061. /** Autobool: Do we try to retain capabilities if we can? */
  4062. int KeepBindCapabilities;
  4063. /** Maximum total size of unparseable descriptors to log during the
  4064. * lifetime of this Tor process.
  4065. */
  4066. uint64_t MaxUnparseableDescSizeToLog;
  4067. /** Bool (default: 1): Switch for the shared random protocol. Only
  4068. * relevant to a directory authority. If off, the authority won't
  4069. * participate in the protocol. If on (default), a flag is added to the
  4070. * vote indicating participation. */
  4071. int AuthDirSharedRandomness;
  4072. /** If 1, we skip all OOS checks. */
  4073. int DisableOOSCheck;
  4074. /** Autobool: Should we include Ed25519 identities in extend2 cells?
  4075. * If -1, we should do whatever the consensus parameter says. */
  4076. int ExtendByEd25519ID;
  4077. /** Bool (default: 1): When testing routerinfos as a directory authority,
  4078. * do we enforce Ed25519 identity match? */
  4079. /* NOTE: remove this option someday. */
  4080. int AuthDirTestEd25519LinkKeys;
  4081. /** Bool (default: 0): Tells if a %include was used on torrc */
  4082. int IncludeUsed;
  4083. /** The seconds after expiration which we as a relay should keep old
  4084. * consensuses around so that we can generate diffs from them. If 0,
  4085. * use the default. */
  4086. int MaxConsensusAgeForDiffs;
  4087. /** Bool (default: 0). Tells Tor to never try to exec another program.
  4088. */
  4089. int NoExec;
  4090. /** Have the KIST scheduler run every X milliseconds. If less than zero, do
  4091. * not use the KIST scheduler but use the old vanilla scheduler instead. If
  4092. * zero, do what the consensus says and fall back to using KIST as if this is
  4093. * set to "10 msec" if the consensus doesn't say anything. */
  4094. int KISTSchedRunInterval;
  4095. /** A multiplier for the KIST per-socket limit calculation. */
  4096. double KISTSockBufSizeFactor;
  4097. /** The list of scheduler type string ordered by priority that is first one
  4098. * has to be tried first. Default: KIST,KISTLite,Vanilla */
  4099. smartlist_t *Schedulers;
  4100. /* An ordered list of scheduler_types mapped from Schedulers. */
  4101. smartlist_t *SchedulerTypes_;
  4102. /** List of files that were opened by %include in torrc and torrc-defaults */
  4103. smartlist_t *FilesOpenedByIncludes;
  4104. /** If true, Tor shouldn't install any posix signal handlers, since it is
  4105. * running embedded inside another process.
  4106. */
  4107. int DisableSignalHandlers;
  4108. /** Autobool: Is the circuit creation DoS mitigation subsystem enabled? */
  4109. int DoSCircuitCreationEnabled;
  4110. /** Minimum concurrent connection needed from one single address before any
  4111. * defense is used. */
  4112. int DoSCircuitCreationMinConnections;
  4113. /** Circuit rate used to refill the token bucket. */
  4114. int DoSCircuitCreationRate;
  4115. /** Maximum allowed burst of circuits. Reaching that value, the address is
  4116. * detected as malicious and a defense might be used. */
  4117. int DoSCircuitCreationBurst;
  4118. /** When an address is marked as malicous, what defense should be used
  4119. * against it. See the dos_cc_defense_type_t enum. */
  4120. int DoSCircuitCreationDefenseType;
  4121. /** For how much time (in seconds) the defense is applicable for a malicious
  4122. * address. A random time delta is added to the defense time of an address
  4123. * which will be between 1 second and half of this value. */
  4124. int DoSCircuitCreationDefenseTimePeriod;
  4125. /** Autobool: Is the DoS connection mitigation subsystem enabled? */
  4126. int DoSConnectionEnabled;
  4127. /** Maximum concurrent connection allowed per address. */
  4128. int DoSConnectionMaxConcurrentCount;
  4129. /** When an address is reaches the maximum count, what defense should be
  4130. * used against it. See the dos_conn_defense_type_t enum. */
  4131. int DoSConnectionDefenseType;
  4132. /** Autobool: Do we refuse single hop client rendezvous? */
  4133. int DoSRefuseSingleHopClientRendezvous;
  4134. } or_options_t;
  4135. #define LOG_PROTOCOL_WARN (get_protocol_warning_severity_level())
  4136. /** Persistent state for an onion router, as saved to disk. */
  4137. typedef struct {
  4138. uint32_t magic_;
  4139. /** The time at which we next plan to write the state to the disk. Equal to
  4140. * TIME_MAX if there are no savable changes, 0 if there are changes that
  4141. * should be saved right away. */
  4142. time_t next_write;
  4143. /** When was the state last written to disk? */
  4144. time_t LastWritten;
  4145. /** Fields for accounting bandwidth use. */
  4146. time_t AccountingIntervalStart;
  4147. uint64_t AccountingBytesReadInInterval;
  4148. uint64_t AccountingBytesWrittenInInterval;
  4149. int AccountingSecondsActive;
  4150. int AccountingSecondsToReachSoftLimit;
  4151. time_t AccountingSoftLimitHitAt;
  4152. uint64_t AccountingBytesAtSoftLimit;
  4153. uint64_t AccountingExpectedUsage;
  4154. /** A list of Entry Guard-related configuration lines. (pre-prop271) */
  4155. config_line_t *EntryGuards;
  4156. /** A list of guard-related configuration lines. (post-prop271) */
  4157. config_line_t *Guard;
  4158. config_line_t *TransportProxies;
  4159. /** Cached revision counters for active hidden services on this host */
  4160. config_line_t *HidServRevCounter;
  4161. /** These fields hold information on the history of bandwidth usage for
  4162. * servers. The "Ends" fields hold the time when we last updated the
  4163. * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
  4164. * of the entries of Values. The "Values" lists hold decimal string
  4165. * representations of the number of bytes read or written in each
  4166. * interval. The "Maxima" list holds decimal strings describing the highest
  4167. * rate achieved during the interval.
  4168. */
  4169. time_t BWHistoryReadEnds;
  4170. int BWHistoryReadInterval;
  4171. smartlist_t *BWHistoryReadValues;
  4172. smartlist_t *BWHistoryReadMaxima;
  4173. time_t BWHistoryWriteEnds;
  4174. int BWHistoryWriteInterval;
  4175. smartlist_t *BWHistoryWriteValues;
  4176. smartlist_t *BWHistoryWriteMaxima;
  4177. time_t BWHistoryDirReadEnds;
  4178. int BWHistoryDirReadInterval;
  4179. smartlist_t *BWHistoryDirReadValues;
  4180. smartlist_t *BWHistoryDirReadMaxima;
  4181. time_t BWHistoryDirWriteEnds;
  4182. int BWHistoryDirWriteInterval;
  4183. smartlist_t *BWHistoryDirWriteValues;
  4184. smartlist_t *BWHistoryDirWriteMaxima;
  4185. /** Build time histogram */
  4186. config_line_t * BuildtimeHistogram;
  4187. int TotalBuildTimes;
  4188. int CircuitBuildAbandonedCount;
  4189. /** What version of Tor wrote this state file? */
  4190. char *TorVersion;
  4191. /** Holds any unrecognized values we found in the state file, in the order
  4192. * in which we found them. */
  4193. config_line_t *ExtraLines;
  4194. /** When did we last rotate our onion key? "0" for 'no idea'. */
  4195. time_t LastRotatedOnionKey;
  4196. } or_state_t;
  4197. /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
  4198. * state is already scheduled to be written to disk earlier than <b>when</b>.
  4199. */
  4200. static inline void or_state_mark_dirty(or_state_t *state, time_t when)
  4201. {
  4202. if (state->next_write > when)
  4203. state->next_write = when;
  4204. }
  4205. #define MAX_SOCKS_REPLY_LEN 1024
  4206. #define MAX_SOCKS_ADDR_LEN 256
  4207. #define SOCKS_NO_AUTH 0x00
  4208. #define SOCKS_USER_PASS 0x02
  4209. /** Please open a TCP connection to this addr:port. */
  4210. #define SOCKS_COMMAND_CONNECT 0x01
  4211. /** Please turn this FQDN into an IP address, privately. */
  4212. #define SOCKS_COMMAND_RESOLVE 0xF0
  4213. /** Please turn this IP address into an FQDN, privately. */
  4214. #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
  4215. /* || 0 is for -Wparentheses-equality (-Wall?) appeasement under clang */
  4216. #define SOCKS_COMMAND_IS_CONNECT(c) (((c)==SOCKS_COMMAND_CONNECT) || 0)
  4217. #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
  4218. (c)==SOCKS_COMMAND_RESOLVE_PTR)
  4219. /** State of a SOCKS request from a user to an OP. Also used to encode other
  4220. * information for non-socks user request (such as those on TransPort and
  4221. * DNSPort) */
  4222. struct socks_request_t {
  4223. /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
  4224. * 0 means that no socks handshake ever took place, and this is just a
  4225. * stub connection (e.g. see connection_ap_make_link()). */
  4226. uint8_t socks_version;
  4227. /** If using socks5 authentication, which authentication type did we
  4228. * negotiate? currently we support 0 (no authentication) and 2
  4229. * (username/password). */
  4230. uint8_t auth_type;
  4231. /** What is this stream's goal? One of the SOCKS_COMMAND_* values */
  4232. uint8_t command;
  4233. /** Which kind of listener created this stream? */
  4234. uint8_t listener_type;
  4235. size_t replylen; /**< Length of <b>reply</b>. */
  4236. uint8_t reply[MAX_SOCKS_REPLY_LEN]; /**< Write an entry into this string if
  4237. * we want to specify our own socks reply,
  4238. * rather than using the default socks4 or
  4239. * socks5 socks reply. We use this for the
  4240. * two-stage socks5 handshake.
  4241. */
  4242. char address[MAX_SOCKS_ADDR_LEN]; /**< What address did the client ask to
  4243. connect to/resolve? */
  4244. uint16_t port; /**< What port did the client ask to connect to? */
  4245. unsigned int has_finished : 1; /**< Has the SOCKS handshake finished? Used to
  4246. * make sure we send back a socks reply for
  4247. * every connection. */
  4248. unsigned int got_auth : 1; /**< Have we received any authentication data? */
  4249. /** If this is set, we will choose "no authentication" instead of
  4250. * "username/password" authentication if both are offered. Used as input to
  4251. * parse_socks. */
  4252. unsigned int socks_prefer_no_auth : 1;
  4253. /** Number of bytes in username; 0 if username is NULL */
  4254. size_t usernamelen;
  4255. /** Number of bytes in password; 0 if password is NULL */
  4256. uint8_t passwordlen;
  4257. /** The negotiated username value if any (for socks5), or the entire
  4258. * authentication string (for socks4). This value is NOT nul-terminated;
  4259. * see usernamelen for its length. */
  4260. char *username;
  4261. /** The negotiated password value if any (for socks5). This value is NOT
  4262. * nul-terminated; see passwordlen for its length. */
  4263. char *password;
  4264. };
  4265. /********************************* circuitbuild.c **********************/
  4266. /** How many hops does a general-purpose circuit have by default? */
  4267. #define DEFAULT_ROUTE_LEN 3
  4268. /* Circuit Build Timeout "public" structures. */
  4269. /** Precision multiplier for the Bw weights */
  4270. #define BW_WEIGHT_SCALE 10000
  4271. #define BW_MIN_WEIGHT_SCALE 1
  4272. #define BW_MAX_WEIGHT_SCALE INT32_MAX
  4273. /** Total size of the circuit timeout history to accumulate.
  4274. * 1000 is approx 2.5 days worth of continual-use circuits. */
  4275. #define CBT_NCIRCUITS_TO_OBSERVE 1000
  4276. /** Width of the histogram bins in milliseconds */
  4277. #define CBT_BIN_WIDTH ((build_time_t)50)
  4278. /** Number of modes to use in the weighted-avg computation of Xm */
  4279. #define CBT_DEFAULT_NUM_XM_MODES 3
  4280. #define CBT_MIN_NUM_XM_MODES 1
  4281. #define CBT_MAX_NUM_XM_MODES 20
  4282. /** A build_time_t is milliseconds */
  4283. typedef uint32_t build_time_t;
  4284. /**
  4285. * CBT_BUILD_ABANDONED is our flag value to represent a force-closed
  4286. * circuit (Aka a 'right-censored' pareto value).
  4287. */
  4288. #define CBT_BUILD_ABANDONED ((build_time_t)(INT32_MAX-1))
  4289. #define CBT_BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
  4290. /** Save state every 10 circuits */
  4291. #define CBT_SAVE_STATE_EVERY 10
  4292. /* Circuit build times consensus parameters */
  4293. /**
  4294. * How long to wait before actually closing circuits that take too long to
  4295. * build in terms of CDF quantile.
  4296. */
  4297. #define CBT_DEFAULT_CLOSE_QUANTILE 95
  4298. #define CBT_MIN_CLOSE_QUANTILE CBT_MIN_QUANTILE_CUTOFF
  4299. #define CBT_MAX_CLOSE_QUANTILE CBT_MAX_QUANTILE_CUTOFF
  4300. /**
  4301. * How many circuits count as recent when considering if the
  4302. * connection has gone gimpy or changed.
  4303. */
  4304. #define CBT_DEFAULT_RECENT_CIRCUITS 20
  4305. #define CBT_MIN_RECENT_CIRCUITS 3
  4306. #define CBT_MAX_RECENT_CIRCUITS 1000
  4307. /**
  4308. * Maximum count of timeouts that finish the first hop in the past
  4309. * RECENT_CIRCUITS before calculating a new timeout.
  4310. *
  4311. * This tells us whether to abandon timeout history and set
  4312. * the timeout back to whatever circuit_build_times_get_initial_timeout()
  4313. * gives us.
  4314. */
  4315. #define CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT (CBT_DEFAULT_RECENT_CIRCUITS*9/10)
  4316. #define CBT_MIN_MAX_RECENT_TIMEOUT_COUNT 3
  4317. #define CBT_MAX_MAX_RECENT_TIMEOUT_COUNT 10000
  4318. /** Minimum circuits before estimating a timeout */
  4319. #define CBT_DEFAULT_MIN_CIRCUITS_TO_OBSERVE 100
  4320. #define CBT_MIN_MIN_CIRCUITS_TO_OBSERVE 1
  4321. #define CBT_MAX_MIN_CIRCUITS_TO_OBSERVE 10000
  4322. /** Cutoff percentile on the CDF for our timeout estimation. */
  4323. #define CBT_DEFAULT_QUANTILE_CUTOFF 80
  4324. #define CBT_MIN_QUANTILE_CUTOFF 10
  4325. #define CBT_MAX_QUANTILE_CUTOFF 99
  4326. double circuit_build_times_quantile_cutoff(void);
  4327. /** How often in seconds should we build a test circuit */
  4328. #define CBT_DEFAULT_TEST_FREQUENCY 10
  4329. #define CBT_MIN_TEST_FREQUENCY 1
  4330. #define CBT_MAX_TEST_FREQUENCY INT32_MAX
  4331. /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
  4332. #define CBT_DEFAULT_TIMEOUT_MIN_VALUE (1500)
  4333. #define CBT_MIN_TIMEOUT_MIN_VALUE 500
  4334. #define CBT_MAX_TIMEOUT_MIN_VALUE INT32_MAX
  4335. /** Initial circuit build timeout in milliseconds */
  4336. #define CBT_DEFAULT_TIMEOUT_INITIAL_VALUE (60*1000)
  4337. #define CBT_MIN_TIMEOUT_INITIAL_VALUE CBT_MIN_TIMEOUT_MIN_VALUE
  4338. #define CBT_MAX_TIMEOUT_INITIAL_VALUE INT32_MAX
  4339. int32_t circuit_build_times_initial_timeout(void);
  4340. #if CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT < CBT_MIN_MAX_RECENT_TIMEOUT_COUNT
  4341. #error "RECENT_CIRCUITS is set too low."
  4342. #endif
  4343. /** Information about the state of our local network connection */
  4344. typedef struct {
  4345. /** The timestamp we last completed a TLS handshake or received a cell */
  4346. time_t network_last_live;
  4347. /** If the network is not live, how many timeouts has this caused? */
  4348. int nonlive_timeouts;
  4349. /** Circular array of circuits that have made it to the first hop. Slot is
  4350. * 1 if circuit timed out, 0 if circuit succeeded */
  4351. int8_t *timeouts_after_firsthop;
  4352. /** Number of elements allocated for the above array */
  4353. int num_recent_circs;
  4354. /** Index into circular array. */
  4355. int after_firsthop_idx;
  4356. } network_liveness_t;
  4357. typedef struct circuit_build_times_s circuit_build_times_t;
  4358. /********************************* config.c ***************************/
  4359. /** An error from options_trial_assign() or options_init_from_string(). */
  4360. typedef enum setopt_err_t {
  4361. SETOPT_OK = 0,
  4362. SETOPT_ERR_MISC = -1,
  4363. SETOPT_ERR_PARSE = -2,
  4364. SETOPT_ERR_TRANSITION = -3,
  4365. SETOPT_ERR_SETTING = -4,
  4366. } setopt_err_t;
  4367. /********************************* connection_edge.c *************************/
  4368. /** Enumerates possible origins of a client-side address mapping. */
  4369. typedef enum {
  4370. /** We're remapping this address because the controller told us to. */
  4371. ADDRMAPSRC_CONTROLLER,
  4372. /** We're remapping this address because of an AutomapHostsOnResolve
  4373. * configuration. */
  4374. ADDRMAPSRC_AUTOMAP,
  4375. /** We're remapping this address because our configuration (via torrc, the
  4376. * command line, or a SETCONF command) told us to. */
  4377. ADDRMAPSRC_TORRC,
  4378. /** We're remapping this address because we have TrackHostExit configured,
  4379. * and we want to remember to use the same exit next time. */
  4380. ADDRMAPSRC_TRACKEXIT,
  4381. /** We're remapping this address because we got a DNS resolution from a
  4382. * Tor server that told us what its value was. */
  4383. ADDRMAPSRC_DNS,
  4384. /** No remapping has occurred. This isn't a possible value for an
  4385. * addrmap_entry_t; it's used as a null value when we need to answer "Why
  4386. * did this remapping happen." */
  4387. ADDRMAPSRC_NONE
  4388. } addressmap_entry_source_t;
  4389. #define addressmap_entry_source_bitfield_t ENUM_BF(addressmap_entry_source_t)
  4390. /********************************* control.c ***************************/
  4391. /** Used to indicate the type of a circuit event passed to the controller.
  4392. * The various types are defined in control-spec.txt */
  4393. typedef enum circuit_status_event_t {
  4394. CIRC_EVENT_LAUNCHED = 0,
  4395. CIRC_EVENT_BUILT = 1,
  4396. CIRC_EVENT_EXTENDED = 2,
  4397. CIRC_EVENT_FAILED = 3,
  4398. CIRC_EVENT_CLOSED = 4,
  4399. } circuit_status_event_t;
  4400. /** Used to indicate the type of a CIRC_MINOR event passed to the controller.
  4401. * The various types are defined in control-spec.txt . */
  4402. typedef enum circuit_status_minor_event_t {
  4403. CIRC_MINOR_EVENT_PURPOSE_CHANGED,
  4404. CIRC_MINOR_EVENT_CANNIBALIZED,
  4405. } circuit_status_minor_event_t;
  4406. /** Used to indicate the type of a stream event passed to the controller.
  4407. * The various types are defined in control-spec.txt */
  4408. typedef enum stream_status_event_t {
  4409. STREAM_EVENT_SENT_CONNECT = 0,
  4410. STREAM_EVENT_SENT_RESOLVE = 1,
  4411. STREAM_EVENT_SUCCEEDED = 2,
  4412. STREAM_EVENT_FAILED = 3,
  4413. STREAM_EVENT_CLOSED = 4,
  4414. STREAM_EVENT_NEW = 5,
  4415. STREAM_EVENT_NEW_RESOLVE = 6,
  4416. STREAM_EVENT_FAILED_RETRIABLE = 7,
  4417. STREAM_EVENT_REMAP = 8
  4418. } stream_status_event_t;
  4419. /** Used to indicate the type of an OR connection event passed to the
  4420. * controller. The various types are defined in control-spec.txt */
  4421. typedef enum or_conn_status_event_t {
  4422. OR_CONN_EVENT_LAUNCHED = 0,
  4423. OR_CONN_EVENT_CONNECTED = 1,
  4424. OR_CONN_EVENT_FAILED = 2,
  4425. OR_CONN_EVENT_CLOSED = 3,
  4426. OR_CONN_EVENT_NEW = 4,
  4427. } or_conn_status_event_t;
  4428. /** Used to indicate the type of a buildtime event */
  4429. typedef enum buildtimeout_set_event_t {
  4430. BUILDTIMEOUT_SET_EVENT_COMPUTED = 0,
  4431. BUILDTIMEOUT_SET_EVENT_RESET = 1,
  4432. BUILDTIMEOUT_SET_EVENT_SUSPENDED = 2,
  4433. BUILDTIMEOUT_SET_EVENT_DISCARD = 3,
  4434. BUILDTIMEOUT_SET_EVENT_RESUME = 4
  4435. } buildtimeout_set_event_t;
  4436. /** Execute the statement <b>stmt</b>, which may log events concerning the
  4437. * connection <b>conn</b>. To prevent infinite loops, disable log messages
  4438. * being sent to controllers if <b>conn</b> is a control connection.
  4439. *
  4440. * Stmt must not contain any return or goto statements.
  4441. */
  4442. #define CONN_LOG_PROTECT(conn, stmt) \
  4443. STMT_BEGIN \
  4444. int _log_conn_is_control; \
  4445. tor_assert(conn); \
  4446. _log_conn_is_control = (conn->type == CONN_TYPE_CONTROL); \
  4447. if (_log_conn_is_control) \
  4448. disable_control_logging(); \
  4449. STMT_BEGIN stmt; STMT_END; \
  4450. if (_log_conn_is_control) \
  4451. enable_control_logging(); \
  4452. STMT_END
  4453. /** Enum describing various stages of bootstrapping, for use with controller
  4454. * bootstrap status events. The values range from 0 to 100. */
  4455. typedef enum {
  4456. BOOTSTRAP_STATUS_UNDEF=-1,
  4457. BOOTSTRAP_STATUS_STARTING=0,
  4458. BOOTSTRAP_STATUS_CONN_DIR=5,
  4459. BOOTSTRAP_STATUS_HANDSHAKE=-2,
  4460. BOOTSTRAP_STATUS_HANDSHAKE_DIR=10,
  4461. BOOTSTRAP_STATUS_ONEHOP_CREATE=15,
  4462. BOOTSTRAP_STATUS_REQUESTING_STATUS=20,
  4463. BOOTSTRAP_STATUS_LOADING_STATUS=25,
  4464. BOOTSTRAP_STATUS_LOADING_KEYS=40,
  4465. BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS=45,
  4466. BOOTSTRAP_STATUS_LOADING_DESCRIPTORS=50,
  4467. BOOTSTRAP_STATUS_CONN_OR=80,
  4468. BOOTSTRAP_STATUS_HANDSHAKE_OR=85,
  4469. BOOTSTRAP_STATUS_CIRCUIT_CREATE=90,
  4470. BOOTSTRAP_STATUS_DONE=100
  4471. } bootstrap_status_t;
  4472. /********************************* directory.c ***************************/
  4473. /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
  4474. typedef struct {
  4475. char first[DIGEST_LEN];
  4476. char second[DIGEST_LEN];
  4477. } fp_pair_t;
  4478. /********************************* dirserv.c ***************************/
  4479. /** An enum to describe what format we're generating a routerstatus line in.
  4480. */
  4481. typedef enum {
  4482. /** For use in a v2 opinion */
  4483. NS_V2,
  4484. /** For use in a consensus networkstatus document (ns flavor) */
  4485. NS_V3_CONSENSUS,
  4486. /** For use in a vote networkstatus document */
  4487. NS_V3_VOTE,
  4488. /** For passing to the controlport in response to a GETINFO request */
  4489. NS_CONTROL_PORT,
  4490. /** For use in a consensus networkstatus document (microdesc flavor) */
  4491. NS_V3_CONSENSUS_MICRODESC
  4492. } routerstatus_format_type_t;
  4493. #ifdef DIRSERV_PRIVATE
  4494. typedef struct measured_bw_line_t {
  4495. char node_id[DIGEST_LEN];
  4496. char node_hex[MAX_HEX_NICKNAME_LEN+1];
  4497. long int bw_kb;
  4498. } measured_bw_line_t;
  4499. #endif /* defined(DIRSERV_PRIVATE) */
  4500. /********************************* dirvote.c ************************/
  4501. /** Describes the schedule by which votes should be generated. */
  4502. typedef struct vote_timing_t {
  4503. /** Length in seconds between one consensus becoming valid and the next
  4504. * becoming valid. */
  4505. int vote_interval;
  4506. /** For how many intervals is a consensus valid? */
  4507. int n_intervals_valid;
  4508. /** Time in seconds allowed to propagate votes */
  4509. int vote_delay;
  4510. /** Time in seconds allowed to propagate signatures */
  4511. int dist_delay;
  4512. } vote_timing_t;
  4513. /********************************* geoip.c **************************/
  4514. /** Indicates an action that we might be noting geoip statistics on.
  4515. * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
  4516. * the others, we're not.
  4517. */
  4518. typedef enum {
  4519. /** We've noticed a connection as a bridge relay or entry guard. */
  4520. GEOIP_CLIENT_CONNECT = 0,
  4521. /** We've served a networkstatus consensus as a directory server. */
  4522. GEOIP_CLIENT_NETWORKSTATUS = 1,
  4523. } geoip_client_action_t;
  4524. /** Indicates either a positive reply or a reason for rejectng a network
  4525. * status request that will be included in geoip statistics. */
  4526. typedef enum {
  4527. /** Request is answered successfully. */
  4528. GEOIP_SUCCESS = 0,
  4529. /** V3 network status is not signed by a sufficient number of requested
  4530. * authorities. */
  4531. GEOIP_REJECT_NOT_ENOUGH_SIGS = 1,
  4532. /** Requested network status object is unavailable. */
  4533. GEOIP_REJECT_UNAVAILABLE = 2,
  4534. /** Requested network status not found. */
  4535. GEOIP_REJECT_NOT_FOUND = 3,
  4536. /** Network status has not been modified since If-Modified-Since time. */
  4537. GEOIP_REJECT_NOT_MODIFIED = 4,
  4538. /** Directory is busy. */
  4539. GEOIP_REJECT_BUSY = 5,
  4540. } geoip_ns_response_t;
  4541. #define GEOIP_NS_RESPONSE_NUM 6
  4542. /** Directory requests that we are measuring can be either direct or
  4543. * tunneled. */
  4544. typedef enum {
  4545. DIRREQ_DIRECT = 0,
  4546. DIRREQ_TUNNELED = 1,
  4547. } dirreq_type_t;
  4548. /** Possible states for either direct or tunneled directory requests that
  4549. * are relevant for determining network status download times. */
  4550. typedef enum {
  4551. /** Found that the client requests a network status; applies to both
  4552. * direct and tunneled requests; initial state of a request that we are
  4553. * measuring. */
  4554. DIRREQ_IS_FOR_NETWORK_STATUS = 0,
  4555. /** Finished writing a network status to the directory connection;
  4556. * applies to both direct and tunneled requests; completes a direct
  4557. * request. */
  4558. DIRREQ_FLUSHING_DIR_CONN_FINISHED = 1,
  4559. /** END cell sent to circuit that initiated a tunneled request. */
  4560. DIRREQ_END_CELL_SENT = 2,
  4561. /** Flushed last cell from queue of the circuit that initiated a
  4562. * tunneled request to the outbuf of the OR connection. */
  4563. DIRREQ_CIRC_QUEUE_FLUSHED = 3,
  4564. /** Flushed last byte from buffer of the channel belonging to the
  4565. * circuit that initiated a tunneled request; completes a tunneled
  4566. * request. */
  4567. DIRREQ_CHANNEL_BUFFER_FLUSHED = 4
  4568. } dirreq_state_t;
  4569. #define WRITE_STATS_INTERVAL (24*60*60)
  4570. /********************************* microdesc.c *************************/
  4571. typedef struct microdesc_cache_t microdesc_cache_t;
  4572. /********************************* networkstatus.c *********************/
  4573. /** Possible statuses of a version of Tor, given opinions from the directory
  4574. * servers. */
  4575. typedef enum version_status_t {
  4576. VS_RECOMMENDED=0, /**< This version is listed as recommended. */
  4577. VS_OLD=1, /**< This version is older than any recommended version. */
  4578. VS_NEW=2, /**< This version is newer than any recommended version. */
  4579. VS_NEW_IN_SERIES=3, /**< This version is newer than any recommended version
  4580. * in its series, but later recommended versions exist.
  4581. */
  4582. VS_UNRECOMMENDED=4, /**< This version is not recommended (general case). */
  4583. VS_EMPTY=5, /**< The version list was empty; no agreed-on versions. */
  4584. VS_UNKNOWN, /**< We have no idea. */
  4585. } version_status_t;
  4586. /********************************* policies.c ************************/
  4587. /** Outcome of applying an address policy to an address. */
  4588. typedef enum {
  4589. /** The address was accepted */
  4590. ADDR_POLICY_ACCEPTED=0,
  4591. /** The address was rejected */
  4592. ADDR_POLICY_REJECTED=-1,
  4593. /** Part of the address was unknown, but as far as we can tell, it was
  4594. * accepted. */
  4595. ADDR_POLICY_PROBABLY_ACCEPTED=1,
  4596. /** Part of the address was unknown, but as far as we can tell, it was
  4597. * rejected. */
  4598. ADDR_POLICY_PROBABLY_REJECTED=2,
  4599. } addr_policy_result_t;
  4600. /********************************* rephist.c ***************************/
  4601. /** Possible public/private key operations in Tor: used to keep track of where
  4602. * we're spending our time. */
  4603. typedef enum {
  4604. SIGN_DIR, SIGN_RTR,
  4605. VERIFY_DIR, VERIFY_RTR,
  4606. ENC_ONIONSKIN, DEC_ONIONSKIN,
  4607. TLS_HANDSHAKE_C, TLS_HANDSHAKE_S,
  4608. REND_CLIENT, REND_MID, REND_SERVER,
  4609. } pk_op_t;
  4610. /********************************* rendcommon.c ***************************/
  4611. /** Hidden-service side configuration of client authorization. */
  4612. typedef struct rend_authorized_client_t {
  4613. char *client_name;
  4614. uint8_t descriptor_cookie[REND_DESC_COOKIE_LEN];
  4615. crypto_pk_t *client_key;
  4616. } rend_authorized_client_t;
  4617. /** ASCII-encoded v2 hidden service descriptor. */
  4618. typedef struct rend_encoded_v2_service_descriptor_t {
  4619. char desc_id[DIGEST_LEN]; /**< Descriptor ID. */
  4620. char *desc_str; /**< Descriptor string. */
  4621. } rend_encoded_v2_service_descriptor_t;
  4622. /** The maximum number of non-circuit-build-timeout failures a hidden
  4623. * service client will tolerate while trying to build a circuit to an
  4624. * introduction point. See also rend_intro_point_t.unreachable_count. */
  4625. #define MAX_INTRO_POINT_REACHABILITY_FAILURES 5
  4626. /** The minimum and maximum number of distinct INTRODUCE2 cells which a
  4627. * hidden service's introduction point will receive before it begins to
  4628. * expire. */
  4629. #define INTRO_POINT_MIN_LIFETIME_INTRODUCTIONS 16384
  4630. /* Double the minimum value so the interval is [min, min * 2]. */
  4631. #define INTRO_POINT_MAX_LIFETIME_INTRODUCTIONS \
  4632. (INTRO_POINT_MIN_LIFETIME_INTRODUCTIONS * 2)
  4633. /** The minimum number of seconds that an introduction point will last
  4634. * before expiring due to old age. (If it receives
  4635. * INTRO_POINT_LIFETIME_INTRODUCTIONS INTRODUCE2 cells, it may expire
  4636. * sooner.)
  4637. *
  4638. * XXX Should this be configurable? */
  4639. #define INTRO_POINT_LIFETIME_MIN_SECONDS (18*60*60)
  4640. /** The maximum number of seconds that an introduction point will last
  4641. * before expiring due to old age.
  4642. *
  4643. * XXX Should this be configurable? */
  4644. #define INTRO_POINT_LIFETIME_MAX_SECONDS (24*60*60)
  4645. /** The maximum number of circuit creation retry we do to an intro point
  4646. * before giving up. We try to reuse intro point that fails during their
  4647. * lifetime so this is a hard limit on the amount of time we do that. */
  4648. #define MAX_INTRO_POINT_CIRCUIT_RETRIES 3
  4649. /** Introduction point information. Used both in rend_service_t (on
  4650. * the service side) and in rend_service_descriptor_t (on both the
  4651. * client and service side). */
  4652. typedef struct rend_intro_point_t {
  4653. extend_info_t *extend_info; /**< Extend info for connecting to this
  4654. * introduction point via a multi-hop path. */
  4655. crypto_pk_t *intro_key; /**< Introduction key that replaces the service
  4656. * key, if this descriptor is V2. */
  4657. /** (Client side only) Flag indicating that a timeout has occurred
  4658. * after sending an INTRODUCE cell to this intro point. After a
  4659. * timeout, an intro point should not be tried again during the same
  4660. * hidden service connection attempt, but it may be tried again
  4661. * during a future connection attempt. */
  4662. unsigned int timed_out : 1;
  4663. /** (Client side only) The number of times we have failed to build a
  4664. * circuit to this intro point for some reason other than our
  4665. * circuit-build timeout. See also MAX_INTRO_POINT_REACHABILITY_FAILURES. */
  4666. unsigned int unreachable_count : 3;
  4667. /** (Service side only) Flag indicating that this intro point was
  4668. * included in the last HS descriptor we generated. */
  4669. unsigned int listed_in_last_desc : 1;
  4670. /** (Service side only) A replay cache recording the RSA-encrypted parts
  4671. * of INTRODUCE2 cells this intro point's circuit has received. This is
  4672. * used to prevent replay attacks. */
  4673. replaycache_t *accepted_intro_rsa_parts;
  4674. /** (Service side only) Count of INTRODUCE2 cells accepted from this
  4675. * intro point.
  4676. */
  4677. int accepted_introduce2_count;
  4678. /** (Service side only) Number of maximum INTRODUCE2 cells that this IP
  4679. * will accept. This is a random value between
  4680. * INTRO_POINT_MIN_LIFETIME_INTRODUCTIONS and
  4681. * INTRO_POINT_MAX_LIFETIME_INTRODUCTIONS. */
  4682. int max_introductions;
  4683. /** (Service side only) The time at which this intro point was first
  4684. * published, or -1 if this intro point has not yet been
  4685. * published. */
  4686. time_t time_published;
  4687. /** (Service side only) The time at which this intro point should
  4688. * (start to) expire, or -1 if we haven't decided when this intro
  4689. * point should expire. */
  4690. time_t time_to_expire;
  4691. /** (Service side only) The amount of circuit creation we've made to this
  4692. * intro point. This is incremented every time we do a circuit relaunch on
  4693. * this object which is triggered when the circuit dies but the node is
  4694. * still in the consensus. After MAX_INTRO_POINT_CIRCUIT_RETRIES, we give
  4695. * up on it. */
  4696. unsigned int circuit_retries;
  4697. /** (Service side only) Set if this intro point has an established circuit
  4698. * and unset if it doesn't. */
  4699. unsigned int circuit_established:1;
  4700. } rend_intro_point_t;
  4701. #define REND_PROTOCOL_VERSION_BITMASK_WIDTH 16
  4702. /** Information used to connect to a hidden service. Used on both the
  4703. * service side and the client side. */
  4704. typedef struct rend_service_descriptor_t {
  4705. crypto_pk_t *pk; /**< This service's public key. */
  4706. int version; /**< Version of the descriptor format: 0 or 2. */
  4707. time_t timestamp; /**< Time when the descriptor was generated. */
  4708. /** Bitmask: which introduce/rendezvous protocols are supported?
  4709. * (We allow bits '0', '1', '2' and '3' to be set.) */
  4710. unsigned protocols : REND_PROTOCOL_VERSION_BITMASK_WIDTH;
  4711. /** List of the service's introduction points. Elements are removed if
  4712. * introduction attempts fail. */
  4713. smartlist_t *intro_nodes;
  4714. /** Has descriptor been uploaded to all hidden service directories? */
  4715. int all_uploads_performed;
  4716. /** List of hidden service directories to which an upload request for
  4717. * this descriptor could be sent. Smartlist exists only when at least one
  4718. * of the previous upload requests failed (otherwise it's not important
  4719. * to know which uploads succeeded and which not). */
  4720. smartlist_t *successful_uploads;
  4721. } rend_service_descriptor_t;
  4722. /********************************* routerlist.c ***************************/
  4723. /** Represents information about a single trusted or fallback directory
  4724. * server. */
  4725. typedef struct dir_server_t {
  4726. char *description;
  4727. char *nickname;
  4728. char *address; /**< Hostname. */
  4729. /* XX/teor - why do we duplicate the address and port fields here and in
  4730. * fake_status? Surely we could just use fake_status (#17867). */
  4731. tor_addr_t ipv6_addr; /**< IPv6 address if present; AF_UNSPEC if not */
  4732. uint32_t addr; /**< IPv4 address. */
  4733. uint16_t dir_port; /**< Directory port. */
  4734. uint16_t or_port; /**< OR port: Used for tunneling connections. */
  4735. uint16_t ipv6_orport; /**< OR port corresponding to ipv6_addr. */
  4736. double weight; /** Weight used when selecting this node at random */
  4737. char digest[DIGEST_LEN]; /**< Digest of identity key. */
  4738. char v3_identity_digest[DIGEST_LEN]; /**< Digest of v3 (authority only,
  4739. * high-security) identity key. */
  4740. unsigned int is_running:1; /**< True iff we think this server is running. */
  4741. unsigned int is_authority:1; /**< True iff this is a directory authority
  4742. * of some kind. */
  4743. /** True iff this server has accepted the most recent server descriptor
  4744. * we tried to upload to it. */
  4745. unsigned int has_accepted_serverdesc:1;
  4746. /** What kind of authority is this? (Bitfield.) */
  4747. dirinfo_type_t type;
  4748. time_t addr_current_at; /**< When was the document that we derived the
  4749. * address information from published? */
  4750. routerstatus_t fake_status; /**< Used when we need to pass this trusted
  4751. * dir_server_t to
  4752. * directory_request_set_routerstatus.
  4753. * as a routerstatus_t. Not updated by the
  4754. * router-status management code!
  4755. **/
  4756. } dir_server_t;
  4757. #define RELAY_REQUIRED_MIN_BANDWIDTH (75*1024)
  4758. #define BRIDGE_REQUIRED_MIN_BANDWIDTH (50*1024)
  4759. #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
  4760. /* Flags for pick_directory_server() and pick_trusteddirserver(). */
  4761. /** Flag to indicate that we should not automatically be willing to use
  4762. * ourself to answer a directory request.
  4763. * Passed to router_pick_directory_server (et al).*/
  4764. #define PDS_ALLOW_SELF (1<<0)
  4765. /** Flag to indicate that if no servers seem to be up, we should mark all
  4766. * directory servers as up and try again.
  4767. * Passed to router_pick_directory_server (et al).*/
  4768. #define PDS_RETRY_IF_NO_SERVERS (1<<1)
  4769. /** Flag to indicate that we should not exclude directory servers that
  4770. * our ReachableAddress settings would exclude. This usually means that
  4771. * we're going to connect to the server over Tor, and so we don't need to
  4772. * worry about our firewall telling us we can't.
  4773. * Passed to router_pick_directory_server (et al).*/
  4774. #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
  4775. /** Flag to indicate that we should not use any directory authority to which
  4776. * we have an existing directory connection for downloading server descriptors
  4777. * or extrainfo documents.
  4778. *
  4779. * Passed to router_pick_directory_server (et al)
  4780. */
  4781. #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
  4782. /** Flag to indicate that we should not use any directory authority to which
  4783. * we have an existing directory connection for downloading microdescs.
  4784. *
  4785. * Passed to router_pick_directory_server (et al)
  4786. */
  4787. #define PDS_NO_EXISTING_MICRODESC_FETCH (1<<4)
  4788. /** Possible ways to weight routers when choosing one randomly. See
  4789. * routerlist_sl_choose_by_bandwidth() for more information.*/
  4790. typedef enum bandwidth_weight_rule_t {
  4791. NO_WEIGHTING, WEIGHT_FOR_EXIT, WEIGHT_FOR_MID, WEIGHT_FOR_GUARD,
  4792. WEIGHT_FOR_DIR
  4793. } bandwidth_weight_rule_t;
  4794. /** Flags to be passed to control router_choose_random_node() to indicate what
  4795. * kind of nodes to pick according to what algorithm. */
  4796. typedef enum {
  4797. CRN_NEED_UPTIME = 1<<0,
  4798. CRN_NEED_CAPACITY = 1<<1,
  4799. CRN_NEED_GUARD = 1<<2,
  4800. /* XXXX not used, apparently. */
  4801. CRN_WEIGHT_AS_EXIT = 1<<5,
  4802. CRN_NEED_DESC = 1<<6,
  4803. /* On clients, only provide nodes that satisfy ClientPreferIPv6OR */
  4804. CRN_PREF_ADDR = 1<<7,
  4805. /* On clients, only provide nodes that we can connect to directly, based on
  4806. * our firewall rules */
  4807. CRN_DIRECT_CONN = 1<<8,
  4808. /* On clients, only provide nodes with HSRend >= 2 protocol version which
  4809. * is required for hidden service version >= 3. */
  4810. CRN_RENDEZVOUS_V3 = 1<<9,
  4811. } router_crn_flags_t;
  4812. /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
  4813. typedef enum was_router_added_t {
  4814. /* Router was added successfully. */
  4815. ROUTER_ADDED_SUCCESSFULLY = 1,
  4816. /* Extrainfo document was rejected because no corresponding router
  4817. * descriptor was found OR router descriptor was rejected because
  4818. * it was incompatible with its extrainfo document. */
  4819. ROUTER_BAD_EI = -1,
  4820. /* Router descriptor was rejected because it is already known. */
  4821. ROUTER_IS_ALREADY_KNOWN = -2,
  4822. /* General purpose router was rejected, because it was not listed
  4823. * in consensus. */
  4824. ROUTER_NOT_IN_CONSENSUS = -3,
  4825. /* Router was neither in directory consensus nor in any of
  4826. * networkstatus documents. Caching it to access later.
  4827. * (Applies to fetched descriptors only.) */
  4828. ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS = -4,
  4829. /* Router was rejected by directory authority. */
  4830. ROUTER_AUTHDIR_REJECTS = -5,
  4831. /* Bridge descriptor was rejected because such bridge was not one
  4832. * of the bridges we have listed in our configuration. */
  4833. ROUTER_WAS_NOT_WANTED = -6,
  4834. /* Router descriptor was rejected because it was older than
  4835. * OLD_ROUTER_DESC_MAX_AGE. */
  4836. ROUTER_WAS_TOO_OLD = -7, /* note contrast with 'NOT_NEW' */
  4837. /* DOCDOC */
  4838. ROUTER_CERTS_EXPIRED = -8
  4839. } was_router_added_t;
  4840. /********************************* routerparse.c ************************/
  4841. #define MAX_STATUS_TAG_LEN 32
  4842. /** Structure to hold parsed Tor versions. This is a little messier
  4843. * than we would like it to be, because we changed version schemes with 0.1.0.
  4844. *
  4845. * See version-spec.txt for the whole business.
  4846. */
  4847. typedef struct tor_version_t {
  4848. int major;
  4849. int minor;
  4850. int micro;
  4851. /** Release status. For version in the post-0.1 format, this is always
  4852. * VER_RELEASE. */
  4853. enum { VER_PRE=0, VER_RC=1, VER_RELEASE=2, } status;
  4854. int patchlevel;
  4855. char status_tag[MAX_STATUS_TAG_LEN];
  4856. int svn_revision;
  4857. int git_tag_len;
  4858. char git_tag[DIGEST_LEN];
  4859. } tor_version_t;
  4860. #endif /* !defined(TOR_OR_H) */