or.h 219 KB

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