or.h 225 KB

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