or.h 146 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492
  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-2011, 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 __COVERITY__
  14. /* If we're building for a static analysis, turn on all the off-by-default
  15. * features. */
  16. #ifndef INSTRUMENT_DOWNLOADS
  17. #define INSTRUMENT_DOWNLOADS 1
  18. #endif
  19. #endif
  20. #ifdef MS_WINDOWS
  21. #define WIN32_WINNT 0x400
  22. #define _WIN32_WINNT 0x400
  23. #define WIN32_LEAN_AND_MEAN
  24. #endif
  25. #ifdef HAVE_UNISTD_H
  26. #include <unistd.h>
  27. #endif
  28. #ifdef HAVE_SIGNAL_H
  29. #include <signal.h>
  30. #endif
  31. #ifdef HAVE_NETDB_H
  32. #include <netdb.h>
  33. #endif
  34. #ifdef HAVE_SYS_PARAM_H
  35. #include <sys/param.h> /* FreeBSD needs this to know what version it is */
  36. #endif
  37. #include "torint.h"
  38. #ifdef HAVE_SYS_WAIT_H
  39. #include <sys/wait.h>
  40. #endif
  41. #ifdef HAVE_SYS_FCNTL_H
  42. #include <sys/fcntl.h>
  43. #endif
  44. #ifdef HAVE_FCNTL_H
  45. #include <fcntl.h>
  46. #endif
  47. #ifdef HAVE_SYS_IOCTL_H
  48. #include <sys/ioctl.h>
  49. #endif
  50. #ifdef HAVE_SYS_UN_H
  51. #include <sys/un.h>
  52. #endif
  53. #ifdef HAVE_SYS_STAT_H
  54. #include <sys/stat.h>
  55. #endif
  56. #ifdef HAVE_NETINET_IN_H
  57. #include <netinet/in.h>
  58. #endif
  59. #ifdef HAVE_ARPA_INET_H
  60. #include <arpa/inet.h>
  61. #endif
  62. #ifdef HAVE_ERRNO_H
  63. #include <errno.h>
  64. #endif
  65. #ifdef HAVE_ASSERT_H
  66. #include <assert.h>
  67. #endif
  68. #ifdef HAVE_TIME_H
  69. #include <time.h>
  70. #endif
  71. #ifdef MS_WINDOWS
  72. #include <io.h>
  73. #include <process.h>
  74. #include <direct.h>
  75. #include <windows.h>
  76. #define snprintf _snprintf
  77. #endif
  78. #include "tortls.h"
  79. #include "../common/torlog.h"
  80. #include "container.h"
  81. #include "torgzip.h"
  82. #include "address.h"
  83. #include "compat_libevent.h"
  84. #include "ht.h"
  85. /* These signals are defined to help control_signal_act work.
  86. */
  87. #ifndef SIGHUP
  88. #define SIGHUP 1
  89. #endif
  90. #ifndef SIGINT
  91. #define SIGINT 2
  92. #endif
  93. #ifndef SIGUSR1
  94. #define SIGUSR1 10
  95. #endif
  96. #ifndef SIGUSR2
  97. #define SIGUSR2 12
  98. #endif
  99. #ifndef SIGTERM
  100. #define SIGTERM 15
  101. #endif
  102. /* Controller signals start at a high number so we don't
  103. * conflict with system-defined signals. */
  104. #define SIGNEWNYM 129
  105. #define SIGCLEARDNSCACHE 130
  106. #if (SIZEOF_CELL_T != 0)
  107. /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
  108. * that our stuff always calls cell_t something different. */
  109. #define cell_t tor_cell_t
  110. #endif
  111. /** Length of longest allowable configured nickname. */
  112. #define MAX_NICKNAME_LEN 19
  113. /** Length of a router identity encoded as a hexadecimal digest, plus
  114. * possible dollar sign. */
  115. #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
  116. /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
  117. * equal sign or tilde, nickname. */
  118. #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
  119. /** Maximum size, in bytes, for resized buffers. */
  120. #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
  121. /** Maximum size, in bytes, for any directory object that we've downloaded. */
  122. #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
  123. /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
  124. * of an HTTP request or response. */
  125. #define MAX_HEADERS_SIZE 50000
  126. /** Maximum size, in bytes, for any directory object that we're accepting
  127. * as an upload. */
  128. #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
  129. /** Maximum size, in bytes, of a single router descriptor uploaded to us
  130. * as a directory authority. Caches and clients fetch whatever descriptors
  131. * the authorities tell them to fetch, and don't care about size. */
  132. #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
  133. /** Maximum size of a single extrainfo document, as above. */
  134. #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
  135. /** How long do we keep DNS cache entries before purging them (regardless of
  136. * their TTL)? */
  137. #define MAX_DNS_ENTRY_AGE (30*60)
  138. /** How long do we cache/tell clients to cache DNS records when no TTL is
  139. * known? */
  140. #define DEFAULT_DNS_TTL (30*60)
  141. /** How long can a TTL be before we stop believing it? */
  142. #define MAX_DNS_TTL (3*60*60)
  143. /** How small can a TTL be before we stop believing it? Provides rudimentary
  144. * pinning. */
  145. #define MIN_DNS_TTL 60
  146. /** How often do we rotate onion keys? */
  147. #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
  148. /** How often do we rotate TLS contexts? */
  149. #define MAX_SSL_KEY_LIFETIME (2*60*60)
  150. /** How old do we allow a router to get before removing it
  151. * from the router list? In seconds. */
  152. #define ROUTER_MAX_AGE (60*60*48)
  153. /** How old can a router get before we (as a server) will no longer
  154. * consider it live? In seconds. */
  155. #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
  156. /** How old do we let a saved descriptor get before force-removing it? */
  157. #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
  158. /** Possible rules for generating circuit IDs on an OR connection. */
  159. typedef enum {
  160. CIRC_ID_TYPE_LOWER=0, /**< Pick from 0..1<<15-1. */
  161. CIRC_ID_TYPE_HIGHER=1, /**< Pick from 1<<15..1<<16-1. */
  162. /** The other side of a connection is an OP: never create circuits to it,
  163. * and let it use any circuit ID it wants. */
  164. CIRC_ID_TYPE_NEITHER=2
  165. } circ_id_type_t;
  166. #define _CONN_TYPE_MIN 3
  167. /** Type for sockets listening for OR connections. */
  168. #define CONN_TYPE_OR_LISTENER 3
  169. /** A bidirectional TLS connection transmitting a sequence of cells.
  170. * May be from an OR to an OR, or from an OP to an OR. */
  171. #define CONN_TYPE_OR 4
  172. /** A TCP connection from an onion router to a stream's destination. */
  173. #define CONN_TYPE_EXIT 5
  174. /** Type for sockets listening for SOCKS connections. */
  175. #define CONN_TYPE_AP_LISTENER 6
  176. /** A SOCKS proxy connection from the user application to the onion
  177. * proxy. */
  178. #define CONN_TYPE_AP 7
  179. /** Type for sockets listening for HTTP connections to the directory server. */
  180. #define CONN_TYPE_DIR_LISTENER 8
  181. /** Type for HTTP connections to the directory server. */
  182. #define CONN_TYPE_DIR 9
  183. /** Connection from the main process to a CPU worker process. */
  184. #define CONN_TYPE_CPUWORKER 10
  185. /** Type for listening for connections from user interface process. */
  186. #define CONN_TYPE_CONTROL_LISTENER 11
  187. /** Type for connections from user interface process. */
  188. #define CONN_TYPE_CONTROL 12
  189. /** Type for sockets listening for transparent connections redirected by pf or
  190. * netfilter. */
  191. #define CONN_TYPE_AP_TRANS_LISTENER 13
  192. /** Type for sockets listening for transparent connections redirected by
  193. * natd. */
  194. #define CONN_TYPE_AP_NATD_LISTENER 14
  195. /** Type for sockets listening for DNS requests. */
  196. #define CONN_TYPE_AP_DNS_LISTENER 15
  197. #define _CONN_TYPE_MAX 15
  198. /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
  199. * connection_t. */
  200. /* Proxy client types */
  201. #define PROXY_NONE 0
  202. #define PROXY_CONNECT 1
  203. #define PROXY_SOCKS4 2
  204. #define PROXY_SOCKS5 3
  205. /* Proxy client handshake states */
  206. #define PROXY_HTTPS_WANT_CONNECT_OK 1
  207. #define PROXY_SOCKS4_WANT_CONNECT_OK 2
  208. #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 3
  209. #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 4
  210. #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 5
  211. #define PROXY_SOCKS5_WANT_CONNECT_OK 6
  212. #define PROXY_CONNECTED 7
  213. /** True iff <b>x</b> is an edge connection. */
  214. #define CONN_IS_EDGE(x) \
  215. ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
  216. /** State for any listener connection. */
  217. #define LISTENER_STATE_READY 0
  218. #define _CPUWORKER_STATE_MIN 1
  219. /** State for a connection to a cpuworker process that's idle. */
  220. #define CPUWORKER_STATE_IDLE 1
  221. /** State for a connection to a cpuworker process that's processing a
  222. * handshake. */
  223. #define CPUWORKER_STATE_BUSY_ONION 2
  224. #define _CPUWORKER_STATE_MAX 2
  225. #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
  226. #define _OR_CONN_STATE_MIN 1
  227. /** State for a connection to an OR: waiting for connect() to finish. */
  228. #define OR_CONN_STATE_CONNECTING 1
  229. /** State for a connection to an OR: waiting for proxy handshake to complete */
  230. #define OR_CONN_STATE_PROXY_HANDSHAKING 2
  231. /** State for a connection to an OR or client: SSL is handshaking, not done
  232. * yet. */
  233. #define OR_CONN_STATE_TLS_HANDSHAKING 3
  234. /** State for a connection to an OR: We're doing a second SSL handshake for
  235. * renegotiation purposes. */
  236. #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
  237. /** State for a connection at an OR: We're waiting for the client to
  238. * renegotiate. */
  239. #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
  240. /** State for a connection to an OR: We're done with our SSL handshake, but we
  241. * haven't yet negotiated link protocol versions and sent a netinfo cell.
  242. */
  243. #define OR_CONN_STATE_OR_HANDSHAKING 6
  244. /** State for a connection to an OR: Ready to send/receive cells. */
  245. #define OR_CONN_STATE_OPEN 7
  246. #define _OR_CONN_STATE_MAX 7
  247. #define _EXIT_CONN_STATE_MIN 1
  248. /** State for an exit connection: waiting for response from DNS farm. */
  249. #define EXIT_CONN_STATE_RESOLVING 1
  250. /** State for an exit connection: waiting for connect() to finish. */
  251. #define EXIT_CONN_STATE_CONNECTING 2
  252. /** State for an exit connection: open and ready to transmit data. */
  253. #define EXIT_CONN_STATE_OPEN 3
  254. /** State for an exit connection: waiting to be removed. */
  255. #define EXIT_CONN_STATE_RESOLVEFAILED 4
  256. #define _EXIT_CONN_STATE_MAX 4
  257. /* The AP state values must be disjoint from the EXIT state values. */
  258. #define _AP_CONN_STATE_MIN 5
  259. /** State for a SOCKS connection: waiting for SOCKS request. */
  260. #define AP_CONN_STATE_SOCKS_WAIT 5
  261. /** State for a SOCKS connection: got a y.onion URL; waiting to receive
  262. * rendezvous descriptor. */
  263. #define AP_CONN_STATE_RENDDESC_WAIT 6
  264. /** The controller will attach this connection to a circuit; it isn't our
  265. * job to do so. */
  266. #define AP_CONN_STATE_CONTROLLER_WAIT 7
  267. /** State for a SOCKS connection: waiting for a completed circuit. */
  268. #define AP_CONN_STATE_CIRCUIT_WAIT 8
  269. /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
  270. #define AP_CONN_STATE_CONNECT_WAIT 9
  271. /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
  272. #define AP_CONN_STATE_RESOLVE_WAIT 10
  273. /** State for a SOCKS connection: ready to send and receive. */
  274. #define AP_CONN_STATE_OPEN 11
  275. /** State for a transparent natd connection: waiting for original
  276. * destination. */
  277. #define AP_CONN_STATE_NATD_WAIT 12
  278. #define _AP_CONN_STATE_MAX 12
  279. /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
  280. * edge connection is not attached to any circuit. */
  281. #define AP_CONN_STATE_IS_UNATTACHED(s) \
  282. ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
  283. #define _DIR_CONN_STATE_MIN 1
  284. /** State for connection to directory server: waiting for connect(). */
  285. #define DIR_CONN_STATE_CONNECTING 1
  286. /** State for connection to directory server: sending HTTP request. */
  287. #define DIR_CONN_STATE_CLIENT_SENDING 2
  288. /** State for connection to directory server: reading HTTP response. */
  289. #define DIR_CONN_STATE_CLIENT_READING 3
  290. /** State for connection to directory server: happy and finished. */
  291. #define DIR_CONN_STATE_CLIENT_FINISHED 4
  292. /** State for connection at directory server: waiting for HTTP request. */
  293. #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
  294. /** State for connection at directory server: sending HTTP response. */
  295. #define DIR_CONN_STATE_SERVER_WRITING 6
  296. #define _DIR_CONN_STATE_MAX 6
  297. /** True iff the purpose of <b>conn</b> means that it's a server-side
  298. * directory connection. */
  299. #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
  300. #define _CONTROL_CONN_STATE_MIN 1
  301. /** State for a control connection: Authenticated and accepting v1 commands. */
  302. #define CONTROL_CONN_STATE_OPEN 1
  303. /** State for a control connection: Waiting for authentication; speaking
  304. * protocol v1. */
  305. #define CONTROL_CONN_STATE_NEEDAUTH 2
  306. #define _CONTROL_CONN_STATE_MAX 2
  307. #define _DIR_PURPOSE_MIN 3
  308. /** A connection to a directory server: download a rendezvous
  309. * descriptor. */
  310. #define DIR_PURPOSE_FETCH_RENDDESC 3
  311. /** A connection to a directory server: set after a rendezvous
  312. * descriptor is downloaded. */
  313. #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
  314. /** A connection to a directory server: download one or more v2
  315. * network-status objects */
  316. #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
  317. /** A connection to a directory server: download one or more server
  318. * descriptors. */
  319. #define DIR_PURPOSE_FETCH_SERVERDESC 6
  320. /** A connection to a directory server: download one or more extra-info
  321. * documents. */
  322. #define DIR_PURPOSE_FETCH_EXTRAINFO 7
  323. /** A connection to a directory server: upload a server descriptor. */
  324. #define DIR_PURPOSE_UPLOAD_DIR 8
  325. /** A connection to a directory server: upload a rendezvous
  326. * descriptor. */
  327. #define DIR_PURPOSE_UPLOAD_RENDDESC 9
  328. /** A connection to a directory server: upload a v3 networkstatus vote. */
  329. #define DIR_PURPOSE_UPLOAD_VOTE 10
  330. /** A connection to a directory server: upload a v3 consensus signature */
  331. #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
  332. /** A connection to a directory server: download one or more v3 networkstatus
  333. * votes. */
  334. #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
  335. /** A connection to a directory server: download a v3 detached signatures
  336. * object for a consensus. */
  337. #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
  338. /** A connection to a directory server: download a v3 networkstatus
  339. * consensus. */
  340. #define DIR_PURPOSE_FETCH_CONSENSUS 14
  341. /** A connection to a directory server: download one or more directory
  342. * authority certificates. */
  343. #define DIR_PURPOSE_FETCH_CERTIFICATE 15
  344. /** Purpose for connection at a directory server. */
  345. #define DIR_PURPOSE_SERVER 16
  346. /** A connection to a hidden service directory server: upload a v2 rendezvous
  347. * descriptor. */
  348. #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
  349. /** A connection to a hidden service directory server: download a v2 rendezvous
  350. * descriptor. */
  351. #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
  352. #define _DIR_PURPOSE_MAX 18
  353. /** True iff <b>p</b> is a purpose corresponding to uploading data to a
  354. * directory server. */
  355. #define DIR_PURPOSE_IS_UPLOAD(p) \
  356. ((p)==DIR_PURPOSE_UPLOAD_DIR || \
  357. (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
  358. (p)==DIR_PURPOSE_UPLOAD_VOTE || \
  359. (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
  360. #define _EXIT_PURPOSE_MIN 1
  361. /** This exit stream wants to do an ordinary connect. */
  362. #define EXIT_PURPOSE_CONNECT 1
  363. /** This exit stream wants to do a resolve (either normal or reverse). */
  364. #define EXIT_PURPOSE_RESOLVE 2
  365. #define _EXIT_PURPOSE_MAX 2
  366. /* !!!! If any connection purpose is ever over 31, we must grow the type
  367. * field in connection_t. */
  368. /** Circuit state: I'm the origin, still haven't done all my handshakes. */
  369. #define CIRCUIT_STATE_BUILDING 0
  370. /** Circuit state: Waiting to process the onionskin. */
  371. #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
  372. /** Circuit state: I'd like to deliver a create, but my n_conn is still
  373. * connecting. */
  374. #define CIRCUIT_STATE_OR_WAIT 2
  375. /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
  376. #define CIRCUIT_STATE_OPEN 3
  377. #define _CIRCUIT_PURPOSE_MIN 1
  378. /* these circuits were initiated elsewhere */
  379. #define _CIRCUIT_PURPOSE_OR_MIN 1
  380. /** OR-side circuit purpose: normal circuit, at OR. */
  381. #define CIRCUIT_PURPOSE_OR 1
  382. /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
  383. #define CIRCUIT_PURPOSE_INTRO_POINT 2
  384. /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
  385. #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
  386. /** OR-side circuit purpose: At OR, both circuits have this purpose. */
  387. #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
  388. #define _CIRCUIT_PURPOSE_OR_MAX 4
  389. /* these circuits originate at this node */
  390. /* here's how circ client-side purposes work:
  391. * normal circuits are C_GENERAL.
  392. * circuits that are c_introducing are either on their way to
  393. * becoming open, or they are open and waiting for a
  394. * suitable rendcirc before they send the intro.
  395. * circuits that are c_introduce_ack_wait have sent the intro,
  396. * but haven't gotten a response yet.
  397. * circuits that are c_establish_rend are either on their way
  398. * to becoming open, or they are open and have sent the
  399. * establish_rendezvous cell but haven't received an ack.
  400. * circuits that are c_rend_ready are open and have received a
  401. * rend ack, but haven't heard from bob yet. if they have a
  402. * buildstate->pending_final_cpath then they're expecting a
  403. * cell from bob, else they're not.
  404. * circuits that are c_rend_ready_intro_acked are open, and
  405. * some intro circ has sent its intro and received an ack.
  406. * circuits that are c_rend_joined are open, have heard from
  407. * bob, and are talking to him.
  408. */
  409. /** Client-side circuit purpose: Normal circuit, with cpath. */
  410. #define CIRCUIT_PURPOSE_C_GENERAL 5
  411. /** Client-side circuit purpose: at Alice, connecting to intro point. */
  412. #define CIRCUIT_PURPOSE_C_INTRODUCING 6
  413. /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
  414. * waiting for ACK/NAK. */
  415. #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
  416. /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
  417. #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
  418. /** Client-side circuit purpose: at Alice, waiting for ack. */
  419. #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
  420. /** Client-side circuit purpose: at Alice, waiting for Bob. */
  421. #define CIRCUIT_PURPOSE_C_REND_READY 10
  422. /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
  423. * has been acknowledged. */
  424. #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
  425. /** Client-side circuit purpose: at Alice, rendezvous established. */
  426. #define CIRCUIT_PURPOSE_C_REND_JOINED 12
  427. /** This circuit is used for build time measurement only */
  428. #define CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT 13
  429. #define _CIRCUIT_PURPOSE_C_MAX 13
  430. /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
  431. #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 14
  432. /** Hidden-service-side circuit purpose: at Bob, successfully established
  433. * intro. */
  434. #define CIRCUIT_PURPOSE_S_INTRO 15
  435. /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
  436. #define CIRCUIT_PURPOSE_S_CONNECT_REND 16
  437. /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
  438. #define CIRCUIT_PURPOSE_S_REND_JOINED 17
  439. /** A testing circuit; not meant to be used for actual traffic. */
  440. #define CIRCUIT_PURPOSE_TESTING 18
  441. /** A controller made this circuit and Tor should not use it. */
  442. #define CIRCUIT_PURPOSE_CONTROLLER 19
  443. #define _CIRCUIT_PURPOSE_MAX 19
  444. /** A catch-all for unrecognized purposes. Currently we don't expect
  445. * to make or see any circuits with this purpose. */
  446. #define CIRCUIT_PURPOSE_UNKNOWN 255
  447. /** True iff the circuit purpose <b>p</b> is for a circuit that
  448. * originated at this node. */
  449. #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
  450. /** True iff the circuit purpose <b>p</b> is for a circuit that originated
  451. * here to serve as a client. (Hidden services don't count here.) */
  452. #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
  453. ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
  454. (p)<=_CIRCUIT_PURPOSE_C_MAX)
  455. /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
  456. #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
  457. /** True iff the circuit purpose <b>p</b> is for an established rendezvous
  458. * circuit. */
  459. #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
  460. ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
  461. (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
  462. /** How many circuits do we want simultaneously in-progress to handle
  463. * a given stream? */
  464. #define MIN_CIRCUITS_HANDLING_STREAM 2
  465. /* These RELAY_COMMAND constants define values for relay cell commands, and
  466. * must match those defined in tor-spec.txt. */
  467. #define RELAY_COMMAND_BEGIN 1
  468. #define RELAY_COMMAND_DATA 2
  469. #define RELAY_COMMAND_END 3
  470. #define RELAY_COMMAND_CONNECTED 4
  471. #define RELAY_COMMAND_SENDME 5
  472. #define RELAY_COMMAND_EXTEND 6
  473. #define RELAY_COMMAND_EXTENDED 7
  474. #define RELAY_COMMAND_TRUNCATE 8
  475. #define RELAY_COMMAND_TRUNCATED 9
  476. #define RELAY_COMMAND_DROP 10
  477. #define RELAY_COMMAND_RESOLVE 11
  478. #define RELAY_COMMAND_RESOLVED 12
  479. #define RELAY_COMMAND_BEGIN_DIR 13
  480. #define RELAY_COMMAND_ESTABLISH_INTRO 32
  481. #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
  482. #define RELAY_COMMAND_INTRODUCE1 34
  483. #define RELAY_COMMAND_INTRODUCE2 35
  484. #define RELAY_COMMAND_RENDEZVOUS1 36
  485. #define RELAY_COMMAND_RENDEZVOUS2 37
  486. #define RELAY_COMMAND_INTRO_ESTABLISHED 38
  487. #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
  488. #define RELAY_COMMAND_INTRODUCE_ACK 40
  489. /* Reasons why an OR connection is closed. */
  490. #define END_OR_CONN_REASON_DONE 1
  491. #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
  492. #define END_OR_CONN_REASON_OR_IDENTITY 3
  493. #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
  494. #define END_OR_CONN_REASON_TIMEOUT 5
  495. #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
  496. #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
  497. #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
  498. #define END_OR_CONN_REASON_MISC 9
  499. /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
  500. * documentation of these. The values must match. */
  501. #define END_STREAM_REASON_MISC 1
  502. #define END_STREAM_REASON_RESOLVEFAILED 2
  503. #define END_STREAM_REASON_CONNECTREFUSED 3
  504. #define END_STREAM_REASON_EXITPOLICY 4
  505. #define END_STREAM_REASON_DESTROY 5
  506. #define END_STREAM_REASON_DONE 6
  507. #define END_STREAM_REASON_TIMEOUT 7
  508. #define END_STREAM_REASON_NOROUTE 8
  509. #define END_STREAM_REASON_HIBERNATING 9
  510. #define END_STREAM_REASON_INTERNAL 10
  511. #define END_STREAM_REASON_RESOURCELIMIT 11
  512. #define END_STREAM_REASON_CONNRESET 12
  513. #define END_STREAM_REASON_TORPROTOCOL 13
  514. #define END_STREAM_REASON_NOTDIRECTORY 14
  515. #define END_STREAM_REASON_ENTRYPOLICY 15
  516. /* These high-numbered end reasons are not part of the official spec,
  517. * and are not intended to be put in relay end cells. They are here
  518. * to be more informative when sending back socks replies to the
  519. * application. */
  520. /* XXXX 256 is no longer used; feel free to reuse it. */
  521. /** We were unable to attach the connection to any circuit at all. */
  522. /* XXXX the ways we use this one don't make a lot of sense. */
  523. #define END_STREAM_REASON_CANT_ATTACH 257
  524. /** We can't connect to any directories at all, so we killed our streams
  525. * before they can time out. */
  526. #define END_STREAM_REASON_NET_UNREACHABLE 258
  527. /** This is a SOCKS connection, and the client used (or misused) the SOCKS
  528. * protocol in a way we couldn't handle. */
  529. #define END_STREAM_REASON_SOCKSPROTOCOL 259
  530. /** This is a transparent proxy connection, but we can't extract the original
  531. * target address:port. */
  532. #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
  533. /** This is a connection on the NATD port, and the destination IP:Port was
  534. * either ill-formed or out-of-range. */
  535. #define END_STREAM_REASON_INVALID_NATD_DEST 261
  536. /** Bitwise-and this value with endreason to mask out all flags. */
  537. #define END_STREAM_REASON_MASK 511
  538. /** Bitwise-or this with the argument to control_event_stream_status
  539. * to indicate that the reason came from an END cell. */
  540. #define END_STREAM_REASON_FLAG_REMOTE 512
  541. /** Bitwise-or this with the argument to control_event_stream_status
  542. * to indicate that we already sent a CLOSED stream event. */
  543. #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
  544. /** Bitwise-or this with endreason to indicate that we already sent
  545. * a socks reply, and no further reply needs to be sent from
  546. * connection_mark_unattached_ap(). */
  547. #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
  548. /** Reason for remapping an AP connection's address: we have a cached
  549. * answer. */
  550. #define REMAP_STREAM_SOURCE_CACHE 1
  551. /** Reason for remapping an AP connection's address: the exit node told us an
  552. * answer. */
  553. #define REMAP_STREAM_SOURCE_EXIT 2
  554. /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
  555. #define RESOLVED_TYPE_HOSTNAME 0
  556. #define RESOLVED_TYPE_IPV4 4
  557. #define RESOLVED_TYPE_IPV6 6
  558. #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
  559. #define RESOLVED_TYPE_ERROR 0xF1
  560. /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
  561. * call; they only go to the controller for tracking */
  562. /** Our post-timeout circuit time measurement period expired.
  563. * We must give up now */
  564. #define END_CIRC_REASON_MEASUREMENT_EXPIRED -3
  565. /** We couldn't build a path for this circuit. */
  566. #define END_CIRC_REASON_NOPATH -2
  567. /** Catch-all "other" reason for closing origin circuits. */
  568. #define END_CIRC_AT_ORIGIN -1
  569. /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
  570. * documentation of these. */
  571. #define _END_CIRC_REASON_MIN 0
  572. #define END_CIRC_REASON_NONE 0
  573. #define END_CIRC_REASON_TORPROTOCOL 1
  574. #define END_CIRC_REASON_INTERNAL 2
  575. #define END_CIRC_REASON_REQUESTED 3
  576. #define END_CIRC_REASON_HIBERNATING 4
  577. #define END_CIRC_REASON_RESOURCELIMIT 5
  578. #define END_CIRC_REASON_CONNECTFAILED 6
  579. #define END_CIRC_REASON_OR_IDENTITY 7
  580. #define END_CIRC_REASON_OR_CONN_CLOSED 8
  581. #define END_CIRC_REASON_FINISHED 9
  582. #define END_CIRC_REASON_TIMEOUT 10
  583. #define END_CIRC_REASON_DESTROYED 11
  584. #define END_CIRC_REASON_NOSUCHSERVICE 12
  585. #define _END_CIRC_REASON_MAX 12
  586. /** Bitwise-OR this with the argument to circuit_mark_for_close() or
  587. * control_event_circuit_status() to indicate that the reason was
  588. * passed through from a destroy or truncate cell. */
  589. #define END_CIRC_REASON_FLAG_REMOTE 512
  590. /** Length of 'y' portion of 'y.onion' URL. */
  591. #define REND_SERVICE_ID_LEN_BASE32 16
  592. /** Length of 'y.onion' including '.onion' URL. */
  593. #define REND_SERVICE_ADDRESS_LEN (16+1+5)
  594. /** Length of a binary-encoded rendezvous service ID. */
  595. #define REND_SERVICE_ID_LEN 10
  596. /** Time period for which a v2 descriptor will be valid. */
  597. #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
  598. /** Time period within which two sets of v2 descriptors will be uploaded in
  599. * parallel. */
  600. #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
  601. /** Number of non-consecutive replicas (i.e. distributed somewhere
  602. * in the ring) for a descriptor. */
  603. #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
  604. /** Number of consecutive replicas for a descriptor. */
  605. #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
  606. /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
  607. #define REND_DESC_ID_V2_LEN_BASE32 32
  608. /** Length of the base32-encoded secret ID part of versioned hidden service
  609. * descriptors. */
  610. #define REND_SECRET_ID_PART_LEN_BASE32 32
  611. /** Length of the base32-encoded hash of an introduction point's
  612. * identity key. */
  613. #define REND_INTRO_POINT_ID_LEN_BASE32 32
  614. /** Length of the descriptor cookie that is used for client authorization
  615. * to hidden services. */
  616. #define REND_DESC_COOKIE_LEN 16
  617. /** Length of the base64-encoded descriptor cookie that is used for
  618. * exchanging client authorization between hidden service and client. */
  619. #define REND_DESC_COOKIE_LEN_BASE64 22
  620. /** Length of client identifier in encrypted introduction points for hidden
  621. * service authorization type 'basic'. */
  622. #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
  623. /** Multiple of the number of clients to which the real number of clients
  624. * is padded with fake clients for hidden service authorization type
  625. * 'basic'. */
  626. #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
  627. /** Length of client entry consisting of client identifier and encrypted
  628. * session key for hidden service authorization type 'basic'. */
  629. #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
  630. + CIPHER_KEY_LEN)
  631. /** Maximum size of v2 hidden service descriptors. */
  632. #define REND_DESC_MAX_SIZE (20 * 1024)
  633. /** Legal characters for use in authorized client names for a hidden
  634. * service. */
  635. #define REND_LEGAL_CLIENTNAME_CHARACTERS \
  636. "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
  637. /** Maximum length of authorized client names for a hidden service. */
  638. #define REND_CLIENTNAME_MAX_LEN 16
  639. /** Length of the rendezvous cookie that is used to connect circuits at the
  640. * rendezvous point. */
  641. #define REND_COOKIE_LEN DIGEST_LEN
  642. /** Client authorization type that a hidden service performs. */
  643. typedef enum rend_auth_type_t {
  644. REND_NO_AUTH = 0,
  645. REND_BASIC_AUTH = 1,
  646. REND_STEALTH_AUTH = 2,
  647. } rend_auth_type_t;
  648. /** Client-side configuration of authorization for a hidden service. */
  649. typedef struct rend_service_authorization_t {
  650. char descriptor_cookie[REND_DESC_COOKIE_LEN];
  651. char onion_address[REND_SERVICE_ADDRESS_LEN+1];
  652. rend_auth_type_t auth_type;
  653. } rend_service_authorization_t;
  654. /** Client- and server-side data that is used for hidden service connection
  655. * establishment. Not all fields contain data depending on where this struct
  656. * is used. */
  657. typedef struct rend_data_t {
  658. /** Onion address (without the .onion part) that a client requests. */
  659. char onion_address[REND_SERVICE_ID_LEN_BASE32+1];
  660. /** (Optional) descriptor cookie that is used by a client. */
  661. char descriptor_cookie[REND_DESC_COOKIE_LEN];
  662. /** Authorization type for accessing a service used by a client. */
  663. rend_auth_type_t auth_type;
  664. /** Hash of the hidden service's PK used by a service. */
  665. char rend_pk_digest[DIGEST_LEN];
  666. /** Rendezvous cookie used by both, client and service. */
  667. char rend_cookie[REND_COOKIE_LEN];
  668. } rend_data_t;
  669. /** Time interval for tracking possible replays of INTRODUCE2 cells.
  670. * Incoming cells with timestamps half of this interval in the past or
  671. * future are dropped immediately. */
  672. #define REND_REPLAY_TIME_INTERVAL (60 * 60)
  673. /** Used to indicate which way a cell is going on a circuit. */
  674. typedef enum {
  675. CELL_DIRECTION_IN=1, /**< The cell is moving towards the origin. */
  676. CELL_DIRECTION_OUT=2, /**< The cell is moving away from the origin. */
  677. } cell_direction_t;
  678. /** Initial value for both sides of a circuit transmission window when the
  679. * circuit is initialized. Measured in cells. */
  680. #define CIRCWINDOW_START 1000
  681. /** Amount to increment a circuit window when we get a circuit SENDME. */
  682. #define CIRCWINDOW_INCREMENT 100
  683. /** Initial value on both sides of a stream transmission window when the
  684. * stream is initialized. Measured in cells. */
  685. #define STREAMWINDOW_START 500
  686. /** Amount to increment a stream window when we get a stream SENDME. */
  687. #define STREAMWINDOW_INCREMENT 50
  688. /* Cell commands. These values are defined in tor-spec.txt. */
  689. #define CELL_PADDING 0
  690. #define CELL_CREATE 1
  691. #define CELL_CREATED 2
  692. #define CELL_RELAY 3
  693. #define CELL_DESTROY 4
  694. #define CELL_CREATE_FAST 5
  695. #define CELL_CREATED_FAST 6
  696. #define CELL_VERSIONS 7
  697. #define CELL_NETINFO 8
  698. #define CELL_RELAY_EARLY 9
  699. /** True iff the cell command <b>x</b> is one that implies a variable-length
  700. * cell. */
  701. #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
  702. /** How long to test reachability before complaining to the user. */
  703. #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
  704. /** Legal characters in a nickname. */
  705. #define LEGAL_NICKNAME_CHARACTERS \
  706. "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
  707. /** Name to use in client TLS certificates if no nickname is given. Once
  708. * Tor 0.1.2.x is obsolete, we can remove this. */
  709. #define DEFAULT_CLIENT_NICKNAME "client"
  710. /** Number of bytes in a SOCKS4 header. */
  711. #define SOCKS4_NETWORK_LEN 8
  712. /*
  713. * Relay payload:
  714. * Relay command [1 byte]
  715. * Recognized [2 bytes]
  716. * Stream ID [2 bytes]
  717. * Partial SHA-1 [4 bytes]
  718. * Length [2 bytes]
  719. * Relay payload [498 bytes]
  720. */
  721. /** Number of bytes in a cell, minus cell header. */
  722. #define CELL_PAYLOAD_SIZE 509
  723. /** Number of bytes in a cell transmitted over the network. */
  724. #define CELL_NETWORK_SIZE 512
  725. /** Length of a header on a variable-length cell. */
  726. #define VAR_CELL_HEADER_SIZE 5
  727. /** Number of bytes in a relay cell's header (not including general cell
  728. * header). */
  729. #define RELAY_HEADER_SIZE (1+2+2+4+2)
  730. /** Largest number of bytes that can fit in a relay cell payload. */
  731. #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
  732. /** Identifies a circuit on an or_connection */
  733. typedef uint16_t circid_t;
  734. /** Identifies a stream on a circuit */
  735. typedef uint16_t streamid_t;
  736. /** Parsed onion routing cell. All communication between nodes
  737. * is via cells. */
  738. typedef struct cell_t {
  739. circid_t circ_id; /**< Circuit which received the cell. */
  740. uint8_t command; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
  741. * CELL_DESTROY, etc */
  742. uint8_t payload[CELL_PAYLOAD_SIZE]; /**< Cell body. */
  743. } cell_t;
  744. /** Parsed variable-length onion routing cell. */
  745. typedef struct var_cell_t {
  746. uint8_t command;
  747. circid_t circ_id;
  748. uint16_t payload_len;
  749. uint8_t payload[1];
  750. } var_cell_t;
  751. /** A cell as packed for writing to the network. */
  752. typedef struct packed_cell_t {
  753. struct packed_cell_t *next; /**< Next cell queued on this circuit. */
  754. char body[CELL_NETWORK_SIZE]; /**< Cell as packed for network. */
  755. } packed_cell_t;
  756. /** Number of cells added to a circuit queue including their insertion
  757. * time on 10 millisecond detail; used for buffer statistics. */
  758. typedef struct insertion_time_elem_t {
  759. struct insertion_time_elem_t *next; /**< Next element in queue. */
  760. uint32_t insertion_time; /**< When were cells inserted (in 10 ms steps
  761. * starting at 0:00 of the current day)? */
  762. unsigned counter; /**< How many cells were inserted? */
  763. } insertion_time_elem_t;
  764. /** Queue of insertion times. */
  765. typedef struct insertion_time_queue_t {
  766. struct insertion_time_elem_t *first; /**< First element in queue. */
  767. struct insertion_time_elem_t *last; /**< Last element in queue. */
  768. } insertion_time_queue_t;
  769. /** A queue of cells on a circuit, waiting to be added to the
  770. * or_connection_t's outbuf. */
  771. typedef struct cell_queue_t {
  772. packed_cell_t *head; /**< The first cell, or NULL if the queue is empty. */
  773. packed_cell_t *tail; /**< The last cell, or NULL if the queue is empty. */
  774. int n; /**< The number of cells in the queue. */
  775. insertion_time_queue_t *insertion_times; /**< Insertion times of cells. */
  776. } cell_queue_t;
  777. /** Beginning of a RELAY cell payload. */
  778. typedef struct {
  779. uint8_t command; /**< The end-to-end relay command. */
  780. uint16_t recognized; /**< Used to tell whether cell is for us. */
  781. streamid_t stream_id; /**< Which stream is this cell associated with? */
  782. char integrity[4]; /**< Used to tell whether cell is corrupted. */
  783. uint16_t length; /**< How long is the payload body? */
  784. } relay_header_t;
  785. typedef struct buf_t buf_t;
  786. typedef struct socks_request_t socks_request_t;
  787. /* Values for connection_t.magic: used to make sure that downcasts (casts from
  788. * connection_t to foo_connection_t) are safe. */
  789. #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
  790. #define OR_CONNECTION_MAGIC 0x7D31FF03u
  791. #define EDGE_CONNECTION_MAGIC 0xF0374013u
  792. #define DIR_CONNECTION_MAGIC 0x9988ffeeu
  793. #define CONTROL_CONNECTION_MAGIC 0x8abc765du
  794. /** Description of a connection to another host or process, and associated
  795. * data.
  796. *
  797. * A connection is named based on what it's connected to -- an "OR
  798. * connection" has a Tor node on the other end, an "exit
  799. * connection" has a website or other server on the other end, and an
  800. * "AP connection" has an application proxy (and thus a user) on the
  801. * other end.
  802. *
  803. * Every connection has a type and a state. Connections never change
  804. * their type, but can go through many state changes in their lifetime.
  805. *
  806. * Every connection has two associated input and output buffers.
  807. * Listeners don't use them. For non-listener connections, incoming
  808. * data is appended to conn->inbuf, and outgoing data is taken from
  809. * conn->outbuf. Connections differ primarily in the functions called
  810. * to fill and drain these buffers.
  811. */
  812. typedef struct connection_t {
  813. uint32_t magic; /**< For memory debugging: must equal one of
  814. * *_CONNECTION_MAGIC. */
  815. uint8_t state; /**< Current state of this connection. */
  816. unsigned int type:4; /**< What kind of connection is this? */
  817. unsigned int purpose:5; /**< Only used for DIR and EXIT types currently. */
  818. /* The next fields are all one-bit booleans. Some are only applicable to
  819. * connection subtypes, but we hold them here anyway, to save space.
  820. */
  821. unsigned int read_blocked_on_bw:1; /**< Boolean: should we start reading
  822. * again once the bandwidth throttler allows it? */
  823. unsigned int write_blocked_on_bw:1; /**< Boolean: should we start writing
  824. * again once the bandwidth throttler allows
  825. * writes? */
  826. unsigned int hold_open_until_flushed:1; /**< Despite this connection's being
  827. * marked for close, do we flush it
  828. * before closing it? */
  829. unsigned int inbuf_reached_eof:1; /**< Boolean: did read() return 0 on this
  830. * conn? */
  831. /** Set to 1 when we're inside connection_flushed_some to keep us from
  832. * calling connection_handle_write() recursively. */
  833. unsigned int in_flushed_some:1;
  834. /* For linked connections:
  835. */
  836. unsigned int linked:1; /**< True if there is, or has been, a linked_conn. */
  837. /** True iff we'd like to be notified about read events from the
  838. * linked conn. */
  839. unsigned int reading_from_linked_conn:1;
  840. /** True iff we're willing to write to the linked conn. */
  841. unsigned int writing_to_linked_conn:1;
  842. /** True iff we're currently able to read on the linked conn, and our
  843. * read_event should be made active with libevent. */
  844. unsigned int active_on_link:1;
  845. /** True iff we've called connection_close_immediate() on this linked
  846. * connection. */
  847. unsigned int linked_conn_is_closed:1;
  848. /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
  849. unsigned int proxy_state:4;
  850. /** Our socket; -1 if this connection is closed, or has no socket. */
  851. evutil_socket_t s;
  852. int conn_array_index; /**< Index into the global connection array. */
  853. struct event *read_event; /**< Libevent event structure. */
  854. struct event *write_event; /**< Libevent event structure. */
  855. buf_t *inbuf; /**< Buffer holding data read over this connection. */
  856. buf_t *outbuf; /**< Buffer holding data to write over this connection. */
  857. size_t outbuf_flushlen; /**< How much data should we try to flush from the
  858. * outbuf? */
  859. time_t timestamp_lastread; /**< When was the last time libevent said we could
  860. * read? */
  861. time_t timestamp_lastwritten; /**< When was the last time libevent said we
  862. * could write? */
  863. time_t timestamp_created; /**< When was this connection_t created? */
  864. /* XXXX_IP6 make this IPv6-capable */
  865. int socket_family; /**< Address family of this connection's socket. Usually
  866. * AF_INET, but it can also be AF_UNIX, or in the future
  867. * AF_INET6 */
  868. tor_addr_t addr; /**< IP of the other side of the connection; used to
  869. * identify routers, along with port. */
  870. uint16_t port; /**< If non-zero, port on the other end
  871. * of the connection. */
  872. uint16_t marked_for_close; /**< Should we close this conn on the next
  873. * iteration of the main loop? (If true, holds
  874. * the line number where this connection was
  875. * marked.) */
  876. const char *marked_for_close_file; /**< For debugging: in which file were
  877. * we marked for close? */
  878. char *address; /**< FQDN (or IP) of the guy on the other end.
  879. * strdup into this, because free_connection() frees it. */
  880. /** Another connection that's connected to this one in lieu of a socket. */
  881. struct connection_t *linked_conn;
  882. /** Unique identifier for this connection on this Tor instance. */
  883. uint64_t global_identifier;
  884. /* XXXX022 move this field, and all the listener-only fields (just
  885. socket_family, I think), into a new listener_connection_t subtype. */
  886. /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
  887. * to the evdns_server_port is uses to listen to and answer connections. */
  888. struct evdns_server_port *dns_server_port;
  889. /** Unique ID for measuring tunneled network status requests. */
  890. uint64_t dirreq_id;
  891. } connection_t;
  892. /** Stores flags and information related to the portion of a v2 Tor OR
  893. * connection handshake that happens after the TLS handshake is finished.
  894. */
  895. typedef struct or_handshake_state_t {
  896. /** When was the VERSIONS cell sent on this connection? Used to get
  897. * an estimate of the skew in the returning NETINFO reply. */
  898. time_t sent_versions_at;
  899. /** True iff we originated this connection */
  900. unsigned int started_here : 1;
  901. /** True iff we have received and processed a VERSIONS cell. */
  902. unsigned int received_versions : 1;
  903. } or_handshake_state_t;
  904. /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
  905. * cells over TLS. */
  906. typedef struct or_connection_t {
  907. connection_t _base;
  908. /** Hash of the public RSA key for the other side's identity key, or zeroes
  909. * if the other side hasn't shown us a valid identity key. */
  910. char identity_digest[DIGEST_LEN];
  911. char *nickname; /**< Nickname of OR on other side (if any). */
  912. tor_tls_t *tls; /**< TLS connection state. */
  913. int tls_error; /**< Last tor_tls error code. */
  914. /** When we last used this conn for any client traffic. If not
  915. * recent, we can rate limit it further. */
  916. time_t client_used;
  917. tor_addr_t real_addr; /**< The actual address that this connection came from
  918. * or went to. The <b>addr</b> field is prone to
  919. * getting overridden by the address from the router
  920. * descriptor matching <b>identity_digest</b>. */
  921. circ_id_type_t circ_id_type:2; /**< When we send CREATE cells along this
  922. * connection, which half of the space should
  923. * we use? */
  924. /** Should this connection be used for extending circuits to the server
  925. * matching the <b>identity_digest</b> field? Set to true if we're pretty
  926. * sure we aren't getting MITMed, either because we're connected to an
  927. * address listed in a server descriptor, or because an authenticated
  928. * NETINFO cell listed the address we're connected to as recognized. */
  929. unsigned int is_canonical:1;
  930. /** True iff this connection shouldn't get any new circs attached to it,
  931. * because the connection is too old, or because there's a better one.
  932. * More generally, this flag is used to note an unhealthy connection;
  933. * for example, if a bad connection fails we shouldn't assume that the
  934. * router itself has a problem.
  935. */
  936. unsigned int is_bad_for_new_circs:1;
  937. uint8_t link_proto; /**< What protocol version are we using? 0 for
  938. * "none negotiated yet." */
  939. circid_t next_circ_id; /**< Which circ_id do we try to use next on
  940. * this connection? This is always in the
  941. * range 0..1<<15-1. */
  942. or_handshake_state_t *handshake_state; /**< If we are setting this connection
  943. * up, state information to do so. */
  944. time_t timestamp_lastempty; /**< When was the outbuf last completely empty?*/
  945. time_t timestamp_last_added_nonpadding; /** When did we last add a
  946. * non-padding cell to the outbuf? */
  947. /* bandwidth* and *_bucket only used by ORs in OPEN state: */
  948. int bandwidthrate; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
  949. int bandwidthburst; /**< Max bucket size for this conn. (OPEN ORs only.) */
  950. int read_bucket; /**< When this hits 0, stop receiving. Every second we
  951. * add 'bandwidthrate' to this, capping it at
  952. * bandwidthburst. (OPEN ORs only) */
  953. int write_bucket; /**< When this hits 0, stop writing. Like read_bucket. */
  954. int n_circuits; /**< How many circuits use this connection as p_conn or
  955. * n_conn ? */
  956. /** Double-linked ring of circuits with queued cells waiting for room to
  957. * free up on this connection's outbuf. Every time we pull cells from a
  958. * circuit, we advance this pointer to the next circuit in the ring. */
  959. struct circuit_t *active_circuits;
  960. /** Priority queue of cell_ewma_t for circuits with queued cells waiting for
  961. * room to free up on this connection's outbuf. Kept in heap order
  962. * according to EWMA.
  963. *
  964. * This is redundant with active_circuits; if we ever decide only to use the
  965. * cell_ewma algorithm for choosing circuits, we can remove active_circuits.
  966. */
  967. smartlist_t *active_circuit_pqueue;
  968. /** The tick on which the cell_ewma_ts in active_circuit_pqueue last had
  969. * their ewma values rescaled. */
  970. unsigned active_circuit_pqueue_last_recalibrated;
  971. struct or_connection_t *next_with_same_id; /**< Next connection with same
  972. * identity digest as this one. */
  973. } or_connection_t;
  974. /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
  975. * connection, or an exit. */
  976. typedef struct edge_connection_t {
  977. connection_t _base;
  978. struct edge_connection_t *next_stream; /**< Points to the next stream at this
  979. * edge, if any */
  980. struct crypt_path_t *cpath_layer; /**< A pointer to which node in the circ
  981. * this conn exits at. */
  982. int package_window; /**< How many more relay cells can I send into the
  983. * circuit? */
  984. int deliver_window; /**< How many more relay cells can end at me? */
  985. /** Nickname of planned exit node -- used with .exit support. */
  986. char *chosen_exit_name;
  987. socks_request_t *socks_request; /**< SOCKS structure describing request (AP
  988. * only.) */
  989. struct circuit_t *on_circuit; /**< The circuit (if any) that this edge
  990. * connection is using. */
  991. uint32_t address_ttl; /**< TTL for address-to-addr mapping on exit
  992. * connection. Exit connections only. */
  993. streamid_t stream_id; /**< The stream ID used for this edge connection on its
  994. * circuit */
  995. /** The reason why this connection is closing; passed to the controller. */
  996. uint16_t end_reason;
  997. /** Bytes read since last call to control_event_stream_bandwidth_used() */
  998. uint32_t n_read;
  999. /** Bytes written since last call to control_event_stream_bandwidth_used() */
  1000. uint32_t n_written;
  1001. /** What rendezvous service are we querying for? (AP only) */
  1002. rend_data_t *rend_data;
  1003. /** Number of times we've reassigned this application connection to
  1004. * a new circuit. We keep track because the timeout is longer if we've
  1005. * already retried several times. */
  1006. uint8_t num_socks_retries;
  1007. /** True iff this connection is for a DNS request only. */
  1008. unsigned int is_dns_request:1;
  1009. /** True iff this stream must attach to a one-hop circuit (e.g. for
  1010. * begin_dir). */
  1011. unsigned int want_onehop:1;
  1012. /** True iff this stream should use a BEGIN_DIR relay command to establish
  1013. * itself rather than BEGIN (either via onehop or via a whole circuit). */
  1014. unsigned int use_begindir:1;
  1015. unsigned int edge_has_sent_end:1; /**< For debugging; only used on edge
  1016. * connections. Set once we've set the stream end,
  1017. * and check in connection_about_to_close_connection().
  1018. */
  1019. /** True iff we've blocked reading until the circuit has fewer queued
  1020. * cells. */
  1021. unsigned int edge_blocked_on_circ:1;
  1022. /** For AP connections only. If 1, and we fail to reach the chosen exit,
  1023. * stop requiring it. */
  1024. unsigned int chosen_exit_optional:1;
  1025. /** For AP connections only. If non-zero, this exit node was picked as
  1026. * a result of the TrackHostExit, and the value decrements every time
  1027. * we fail to complete a circuit to our chosen exit -- if it reaches
  1028. * zero, abandon the associated mapaddress. */
  1029. unsigned int chosen_exit_retries:3;
  1030. /** If this is a DNSPort connection, this field holds the pending DNS
  1031. * request that we're going to try to answer. */
  1032. struct evdns_server_request *dns_server_request;
  1033. } edge_connection_t;
  1034. /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
  1035. * connection to retrieve or serve directory material. */
  1036. typedef struct dir_connection_t {
  1037. connection_t _base;
  1038. char *requested_resource; /**< Which 'resource' did we ask the directory
  1039. * for? */
  1040. unsigned int dirconn_direct:1; /**< Is this dirconn direct, or via Tor? */
  1041. /* Used only for server sides of some dir connections, to implement
  1042. * "spooling" of directory material to the outbuf. Otherwise, we'd have
  1043. * to append everything to the outbuf in one enormous chunk. */
  1044. /** What exactly are we spooling right now? */
  1045. enum {
  1046. DIR_SPOOL_NONE=0, DIR_SPOOL_SERVER_BY_DIGEST, DIR_SPOOL_SERVER_BY_FP,
  1047. DIR_SPOOL_EXTRA_BY_DIGEST, DIR_SPOOL_EXTRA_BY_FP,
  1048. DIR_SPOOL_CACHED_DIR, DIR_SPOOL_NETWORKSTATUS,
  1049. DIR_SPOOL_MICRODESC, /* NOTE: if we add another entry, add another bit. */
  1050. } dir_spool_src : 3;
  1051. /** If we're fetching descriptors, what router purpose shall we assign
  1052. * to them? */
  1053. uint8_t router_purpose;
  1054. /** List of fingerprints for networkstatuses or descriptors to be spooled. */
  1055. smartlist_t *fingerprint_stack;
  1056. /** A cached_dir_t object that we're currently spooling out */
  1057. struct cached_dir_t *cached_dir;
  1058. /** The current offset into cached_dir. */
  1059. off_t cached_dir_offset;
  1060. /** The zlib object doing on-the-fly compression for spooled data. */
  1061. tor_zlib_state_t *zlib_state;
  1062. /** What rendezvous service are we querying for? */
  1063. rend_data_t *rend_data;
  1064. char identity_digest[DIGEST_LEN]; /**< Hash of the public RSA key for
  1065. * the directory server's signing key. */
  1066. } dir_connection_t;
  1067. /** Subtype of connection_t for an connection to a controller. */
  1068. typedef struct control_connection_t {
  1069. connection_t _base;
  1070. uint32_t event_mask; /**< Bitfield: which events does this controller
  1071. * care about? */
  1072. /** True if we have sent a protocolinfo reply on this connection. */
  1073. unsigned int have_sent_protocolinfo:1;
  1074. /** Amount of space allocated in incoming_cmd. */
  1075. uint32_t incoming_cmd_len;
  1076. /** Number of bytes currently stored in incoming_cmd. */
  1077. uint32_t incoming_cmd_cur_len;
  1078. /** A control command that we're reading from the inbuf, but which has not
  1079. * yet arrived completely. */
  1080. char *incoming_cmd;
  1081. } control_connection_t;
  1082. /** Cast a connection_t subtype pointer to a connection_t **/
  1083. #define TO_CONN(c) (&(((c)->_base)))
  1084. /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
  1085. #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
  1086. /** Convert a connection_t* to an or_connection_t*; assert if the cast is
  1087. * invalid. */
  1088. static or_connection_t *TO_OR_CONN(connection_t *);
  1089. /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
  1090. * invalid. */
  1091. static dir_connection_t *TO_DIR_CONN(connection_t *);
  1092. /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
  1093. * invalid. */
  1094. static edge_connection_t *TO_EDGE_CONN(connection_t *);
  1095. /** Convert a connection_t* to an control_connection_t*; assert if the cast is
  1096. * invalid. */
  1097. static control_connection_t *TO_CONTROL_CONN(connection_t *);
  1098. static INLINE or_connection_t *TO_OR_CONN(connection_t *c)
  1099. {
  1100. tor_assert(c->magic == OR_CONNECTION_MAGIC);
  1101. return DOWNCAST(or_connection_t, c);
  1102. }
  1103. static INLINE dir_connection_t *TO_DIR_CONN(connection_t *c)
  1104. {
  1105. tor_assert(c->magic == DIR_CONNECTION_MAGIC);
  1106. return DOWNCAST(dir_connection_t, c);
  1107. }
  1108. static INLINE edge_connection_t *TO_EDGE_CONN(connection_t *c)
  1109. {
  1110. tor_assert(c->magic == EDGE_CONNECTION_MAGIC);
  1111. return DOWNCAST(edge_connection_t, c);
  1112. }
  1113. static INLINE control_connection_t *TO_CONTROL_CONN(connection_t *c)
  1114. {
  1115. tor_assert(c->magic == CONTROL_CONNECTION_MAGIC);
  1116. return DOWNCAST(control_connection_t, c);
  1117. }
  1118. /** What action type does an address policy indicate: accept or reject? */
  1119. typedef enum {
  1120. ADDR_POLICY_ACCEPT=1,
  1121. ADDR_POLICY_REJECT=2,
  1122. } addr_policy_action_t;
  1123. /** A reference-counted address policy rule. */
  1124. typedef struct addr_policy_t {
  1125. int refcnt; /**< Reference count */
  1126. addr_policy_action_t policy_type:2;/**< What to do when the policy matches.*/
  1127. unsigned int is_private:1; /**< True iff this is the pseudo-address,
  1128. * "private". */
  1129. unsigned int is_canonical:1; /**< True iff this policy is the canonical
  1130. * copy (stored in a hash table to avoid
  1131. * duplication of common policies) */
  1132. maskbits_t maskbits; /**< Accept/reject all addresses <b>a</b> such that the
  1133. * first <b>maskbits</b> bits of <b>a</b> match
  1134. * <b>addr</b>. */
  1135. tor_addr_t addr; /**< Base address to accept or reject. */
  1136. uint16_t prt_min; /**< Lowest port number to accept/reject. */
  1137. uint16_t prt_max; /**< Highest port number to accept/reject. */
  1138. } addr_policy_t;
  1139. /** A cached_dir_t represents a cacheable directory object, along with its
  1140. * compressed form. */
  1141. typedef struct cached_dir_t {
  1142. char *dir; /**< Contents of this object, NUL-terminated. */
  1143. char *dir_z; /**< Compressed contents of this object. */
  1144. size_t dir_len; /**< Length of <b>dir</b> (not counting its NUL). */
  1145. size_t dir_z_len; /**< Length of <b>dir_z</b>. */
  1146. time_t published; /**< When was this object published. */
  1147. digests_t digests; /**< Digests of this object (networkstatus only) */
  1148. int refcnt; /**< Reference count for this cached_dir_t. */
  1149. } cached_dir_t;
  1150. /** Enum used to remember where a signed_descriptor_t is stored and how to
  1151. * manage the memory for signed_descriptor_body. */
  1152. typedef enum {
  1153. /** The descriptor isn't stored on disk at all: the copy in memory is
  1154. * canonical; the saved_offset field is meaningless. */
  1155. SAVED_NOWHERE=0,
  1156. /** The descriptor is stored in the cached_routers file: the
  1157. * signed_descriptor_body is meaningless; the signed_descriptor_len and
  1158. * saved_offset are used to index into the mmaped cache file. */
  1159. SAVED_IN_CACHE,
  1160. /** The descriptor is stored in the cached_routers.new file: the
  1161. * signed_descriptor_body and saved_offset fields are both set. */
  1162. /* FFFF (We could also mmap the file and grow the mmap as needed, or
  1163. * lazy-load the descriptor text by using seek and read. We don't, for
  1164. * now.)
  1165. */
  1166. SAVED_IN_JOURNAL
  1167. } saved_location_t;
  1168. /** Enumeration: what kind of download schedule are we using for a given
  1169. * object? */
  1170. typedef enum {
  1171. DL_SCHED_GENERIC = 0,
  1172. DL_SCHED_CONSENSUS = 1,
  1173. DL_SCHED_BRIDGE = 2,
  1174. } download_schedule_t;
  1175. /** Information about our plans for retrying downloads for a downloadable
  1176. * object. */
  1177. typedef struct download_status_t {
  1178. time_t next_attempt_at; /**< When should we try downloading this descriptor
  1179. * again? */
  1180. uint8_t n_download_failures; /**< Number of failures trying to download the
  1181. * most recent descriptor. */
  1182. download_schedule_t schedule : 8;
  1183. } download_status_t;
  1184. /** If n_download_failures is this high, the download can never happen. */
  1185. #define IMPOSSIBLE_TO_DOWNLOAD 255
  1186. /** The max size we expect router descriptor annotations we create to
  1187. * be. We'll accept larger ones if we see them on disk, but we won't
  1188. * create any that are larger than this. */
  1189. #define ROUTER_ANNOTATION_BUF_LEN 256
  1190. /** Information need to cache an onion router's descriptor. */
  1191. typedef struct signed_descriptor_t {
  1192. /** Pointer to the raw server descriptor, preceded by annotations. Not
  1193. * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
  1194. * pointer is null. */
  1195. char *signed_descriptor_body;
  1196. /** Length of the annotations preceding the server descriptor. */
  1197. size_t annotations_len;
  1198. /** Length of the server descriptor. */
  1199. size_t signed_descriptor_len;
  1200. /** Digest of the server descriptor, computed as specified in
  1201. * dir-spec.txt. */
  1202. char signed_descriptor_digest[DIGEST_LEN];
  1203. /** Identity digest of the router. */
  1204. char identity_digest[DIGEST_LEN];
  1205. /** Declared publication time of the descriptor. */
  1206. time_t published_on;
  1207. /** For routerdescs only: digest of the corresponding extrainfo. */
  1208. char extra_info_digest[DIGEST_LEN];
  1209. /** For routerdescs only: Status of downloading the corresponding
  1210. * extrainfo. */
  1211. download_status_t ei_dl_status;
  1212. /** Where is the descriptor saved? */
  1213. saved_location_t saved_location;
  1214. /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
  1215. * this descriptor in the corresponding file. */
  1216. off_t saved_offset;
  1217. /** What position is this descriptor within routerlist->routers or
  1218. * routerlist->old_routers? -1 for none. */
  1219. int routerlist_index;
  1220. /** The valid-until time of the most recent consensus that listed this
  1221. * descriptor, or a bit after the publication time of the most recent v2
  1222. * networkstatus that listed it. 0 for "never listed in a consensus or
  1223. * status, so far as we know." */
  1224. time_t last_listed_as_valid_until;
  1225. #ifdef TRACK_SERVED_TIME
  1226. /** The last time we served anybody this descriptor. Used for internal
  1227. * testing to see whether we're holding on to descriptors too long. */
  1228. time_t last_served_at; /*XXXX remove if not useful. */
  1229. #endif
  1230. /* If true, we do not ever try to save this object in the cache. */
  1231. unsigned int do_not_cache : 1;
  1232. /* If true, this item is meant to represent an extrainfo. */
  1233. unsigned int is_extrainfo : 1;
  1234. /* If true, we got an extrainfo for this item, and the digest was right,
  1235. * but it was incompatible. */
  1236. unsigned int extrainfo_is_bogus : 1;
  1237. /* If true, we are willing to transmit this item unencrypted. */
  1238. unsigned int send_unencrypted : 1;
  1239. } signed_descriptor_t;
  1240. /** A signed integer representing a country code. */
  1241. typedef int16_t country_t;
  1242. /** Information about another onion router in the network. */
  1243. typedef struct {
  1244. signed_descriptor_t cache_info;
  1245. char *address; /**< Location of OR: either a hostname or an IP address. */
  1246. char *nickname; /**< Human-readable OR name. */
  1247. uint32_t addr; /**< IPv4 address of OR, in host order. */
  1248. uint16_t or_port; /**< Port for TLS connections. */
  1249. uint16_t dir_port; /**< Port for HTTP directory connections. */
  1250. crypto_pk_env_t *onion_pkey; /**< Public RSA key for onions. */
  1251. crypto_pk_env_t *identity_pkey; /**< Public RSA key for signing. */
  1252. char *platform; /**< What software/operating system is this OR using? */
  1253. /* link info */
  1254. uint32_t bandwidthrate; /**< How many bytes does this OR add to its token
  1255. * bucket per second? */
  1256. uint32_t bandwidthburst; /**< How large is this OR's token bucket? */
  1257. /** How many bytes/s is this router known to handle? */
  1258. uint32_t bandwidthcapacity;
  1259. smartlist_t *exit_policy; /**< What streams will this OR permit
  1260. * to exit? NULL for 'reject *:*'. */
  1261. long uptime; /**< How many seconds the router claims to have been up */
  1262. smartlist_t *declared_family; /**< Nicknames of router which this router
  1263. * claims are its family. */
  1264. char *contact_info; /**< Declared contact info for this router. */
  1265. unsigned int is_hibernating:1; /**< Whether the router claims to be
  1266. * hibernating */
  1267. unsigned int has_old_dnsworkers:1; /**< Whether the router is using
  1268. * dnsworker code. */
  1269. unsigned int caches_extra_info:1; /**< Whether the router caches and serves
  1270. * extrainfo documents. */
  1271. unsigned int allow_single_hop_exits:1; /**< Whether the router allows
  1272. * single hop exits. */
  1273. /* local info */
  1274. unsigned int is_running:1; /**< As far as we know, is this OR currently
  1275. * running? */
  1276. unsigned int is_valid:1; /**< Has a trusted dirserver validated this OR?
  1277. * (For Authdir: Have we validated this OR?)
  1278. */
  1279. unsigned int is_named:1; /**< Do we believe the nickname that this OR gives
  1280. * us? */
  1281. unsigned int is_fast:1; /** Do we think this is a fast OR? */
  1282. unsigned int is_stable:1; /** Do we think this is a stable OR? */
  1283. unsigned int is_possible_guard:1; /**< Do we think this is an OK guard? */
  1284. unsigned int is_exit:1; /**< Do we think this is an OK exit? */
  1285. unsigned int is_bad_exit:1; /**< Do we think this exit is censored, borked,
  1286. * or otherwise nasty? */
  1287. unsigned int is_bad_directory:1; /**< Do we think this directory is junky,
  1288. * underpowered, or otherwise useless? */
  1289. unsigned int wants_to_be_hs_dir:1; /**< True iff this router claims to be
  1290. * a hidden service directory. */
  1291. unsigned int is_hs_dir:1; /**< True iff this router is a hidden service
  1292. * directory according to the authorities. */
  1293. unsigned int policy_is_reject_star:1; /**< True iff the exit policy for this
  1294. * router rejects everything. */
  1295. /** True if, after we have added this router, we should re-launch
  1296. * tests for it. */
  1297. unsigned int needs_retest_if_added:1;
  1298. /** Tor can use this router for general positions in circuits. */
  1299. #define ROUTER_PURPOSE_GENERAL 0
  1300. /** Tor should avoid using this router for circuit-building. */
  1301. #define ROUTER_PURPOSE_CONTROLLER 1
  1302. /** Tor should use this router only for bridge positions in circuits. */
  1303. #define ROUTER_PURPOSE_BRIDGE 2
  1304. /** Tor should not use this router; it was marked in cached-descriptors with
  1305. * a purpose we didn't recognize. */
  1306. #define ROUTER_PURPOSE_UNKNOWN 255
  1307. uint8_t purpose; /** What positions in a circuit is this router good for? */
  1308. /* The below items are used only by authdirservers for
  1309. * reachability testing. */
  1310. /** When was the last time we could reach this OR? */
  1311. time_t last_reachable;
  1312. /** When did we start testing reachability for this OR? */
  1313. time_t testing_since;
  1314. /** According to the geoip db what country is this router in? */
  1315. country_t country;
  1316. } routerinfo_t;
  1317. /** Information needed to keep and cache a signed extra-info document. */
  1318. typedef struct extrainfo_t {
  1319. signed_descriptor_t cache_info;
  1320. /** The router's nickname. */
  1321. char nickname[MAX_NICKNAME_LEN+1];
  1322. /** True iff we found the right key for this extra-info, verified the
  1323. * signature, and found it to be bad. */
  1324. unsigned int bad_sig : 1;
  1325. /** If present, we didn't have the right key to verify this extra-info,
  1326. * so this is a copy of the signature in the document. */
  1327. char *pending_sig;
  1328. /** Length of pending_sig. */
  1329. size_t pending_sig_len;
  1330. } extrainfo_t;
  1331. /** Contents of a single router entry in a network status object.
  1332. */
  1333. typedef struct routerstatus_t {
  1334. time_t published_on; /**< When was this router published? */
  1335. char nickname[MAX_NICKNAME_LEN+1]; /**< The nickname this router says it
  1336. * has. */
  1337. char identity_digest[DIGEST_LEN]; /**< Digest of the router's identity
  1338. * key. */
  1339. char descriptor_digest[DIGEST_LEN]; /**< Digest of the router's most recent
  1340. * descriptor. */
  1341. uint32_t addr; /**< IPv4 address for this router. */
  1342. uint16_t or_port; /**< OR port for this router. */
  1343. uint16_t dir_port; /**< Directory port for this router. */
  1344. unsigned int is_authority:1; /**< True iff this router is an authority. */
  1345. unsigned int is_exit:1; /**< True iff this router is a good exit. */
  1346. unsigned int is_stable:1; /**< True iff this router stays up a long time. */
  1347. unsigned int is_fast:1; /**< True iff this router has good bandwidth. */
  1348. unsigned int is_running:1; /**< True iff this router is up. */
  1349. unsigned int is_named:1; /**< True iff "nickname" belongs to this router. */
  1350. unsigned int is_unnamed:1; /**< True iff "nickname" belongs to another
  1351. * router. */
  1352. unsigned int is_valid:1; /**< True iff this router isn't invalid. */
  1353. unsigned int is_v2_dir:1; /**< True iff this router can serve directory
  1354. * information with v2 of the directory
  1355. * protocol. (All directory caches cache v1
  1356. * directories.) */
  1357. unsigned int is_possible_guard:1; /**< True iff this router would be a good
  1358. * choice as an entry guard. */
  1359. unsigned int is_bad_exit:1; /**< True iff this node is a bad choice for
  1360. * an exit node. */
  1361. unsigned int is_bad_directory:1; /**< Do we think this directory is junky,
  1362. * underpowered, or otherwise useless? */
  1363. unsigned int is_hs_dir:1; /**< True iff this router is a v2-or-later hidden
  1364. * service directory. */
  1365. /** True iff we know version info for this router. (i.e., a "v" entry was
  1366. * included.) We'll replace all these with a big tor_version_t or a char[]
  1367. * if the number of traits we care about ever becomes incredibly big. */
  1368. unsigned int version_known:1;
  1369. /** True iff this router is a version that supports BEGIN_DIR cells. */
  1370. unsigned int version_supports_begindir:1;
  1371. /** True iff this router is a version that supports conditional consensus
  1372. * downloads (signed by list of authorities). */
  1373. unsigned int version_supports_conditional_consensus:1;
  1374. /** True iff this router is a version that we can post extrainfo docs to. */
  1375. unsigned int version_supports_extrainfo_upload:1;
  1376. /** True iff this router is a version that, if it caches directory info,
  1377. * we can get v3 downloads from. */
  1378. unsigned int version_supports_v3_dir:1;
  1379. unsigned int has_bandwidth:1; /**< The vote/consensus had bw info */
  1380. unsigned int has_exitsummary:1; /**< The vote/consensus had exit summaries */
  1381. unsigned int has_measured_bw:1; /**< The vote/consensus had a measured bw */
  1382. uint32_t measured_bw; /**< Measured bandwidth (capacity) of the router */
  1383. uint32_t bandwidth; /**< Bandwidth (capacity) of the router as reported in
  1384. * the vote/consensus, in kilobytes/sec. */
  1385. char *exitsummary; /**< exit policy summary -
  1386. * XXX weasel: this probably should not stay a string. */
  1387. /* ---- The fields below aren't derived from the networkstatus; they
  1388. * hold local information only. */
  1389. /** True if we, as a directory mirror, want to download the corresponding
  1390. * routerinfo from the authority who gave us this routerstatus. (That is,
  1391. * if we don't have the routerinfo, and if we haven't already tried to get it
  1392. * from this authority.) Applies in v2 networkstatus document only.
  1393. */
  1394. unsigned int need_to_mirror:1;
  1395. unsigned int name_lookup_warned:1; /**< Have we warned the user for referring
  1396. * to this (unnamed) router by nickname?
  1397. */
  1398. time_t last_dir_503_at; /**< When did this router last tell us that it
  1399. * was too busy to serve directory info? */
  1400. download_status_t dl_status;
  1401. } routerstatus_t;
  1402. /** A microdescriptor is the smallest amount of information needed to build a
  1403. * circuit through a router. They are generated by the directory authorities,
  1404. * using information from the uploaded routerinfo documents. They are not
  1405. * self-signed, but are rather authenticated by having their hash in a signed
  1406. * networkstatus document. */
  1407. typedef struct microdesc_t {
  1408. /** Hashtable node, used to look up the microdesc by its digest. */
  1409. HT_ENTRY(microdesc_t) node;
  1410. /* Cache information */
  1411. /** When was this microdescriptor last listed in a consensus document?
  1412. * Once a microdesc has been unlisted long enough, we can drop it.
  1413. */
  1414. time_t last_listed;
  1415. /** Where is this microdescriptor currently stored? */
  1416. saved_location_t saved_location : 3;
  1417. /** If true, do not attempt to cache this microdescriptor on disk. */
  1418. unsigned int no_save : 1;
  1419. /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
  1420. * microdescriptor in the cache. */
  1421. off_t off;
  1422. /* The string containing the microdesc. */
  1423. /** A pointer to the encoded body of the microdescriptor. If the
  1424. * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
  1425. * mmap'd region. Otherwise, it is a malloc'd string. The string might not
  1426. * be NUL-terminated; take the length from <b>bodylen</b>. */
  1427. char *body;
  1428. /** The length of the microdescriptor in <b>body</b>. */
  1429. size_t bodylen;
  1430. /** A SHA256-digest of the microdescriptor. */
  1431. char digest[DIGEST256_LEN];
  1432. /* Fields in the microdescriptor. */
  1433. /** As routerinfo_t.onion_pkey */
  1434. crypto_pk_env_t *onion_pkey;
  1435. /** As routerinfo_t.family */
  1436. smartlist_t *family;
  1437. /** Encoded exit policy summary */
  1438. char *exitsummary; /**< exit policy summary -
  1439. * XXX this probably should not stay a string. */
  1440. } microdesc_t;
  1441. /** How many times will we try to download a router's descriptor before giving
  1442. * up? */
  1443. #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
  1444. /** Contents of a v2 (non-consensus, non-vote) network status object. */
  1445. typedef struct networkstatus_v2_t {
  1446. /** When did we receive the network-status document? */
  1447. time_t received_on;
  1448. /** What was the digest of the document? */
  1449. char networkstatus_digest[DIGEST_LEN];
  1450. /* These fields come from the actual network-status document.*/
  1451. time_t published_on; /**< Declared publication date. */
  1452. char *source_address; /**< Canonical directory server hostname. */
  1453. uint32_t source_addr; /**< Canonical directory server IP. */
  1454. uint16_t source_dirport; /**< Canonical directory server dirport. */
  1455. unsigned int binds_names:1; /**< True iff this directory server binds
  1456. * names. */
  1457. unsigned int recommends_versions:1; /**< True iff this directory server
  1458. * recommends client and server software
  1459. * versions. */
  1460. unsigned int lists_bad_exits:1; /**< True iff this directory server marks
  1461. * malfunctioning exits as bad. */
  1462. /** True iff this directory server marks malfunctioning directories as
  1463. * bad. */
  1464. unsigned int lists_bad_directories:1;
  1465. char identity_digest[DIGEST_LEN]; /**< Digest of signing key. */
  1466. char *contact; /**< How to contact directory admin? (may be NULL). */
  1467. crypto_pk_env_t *signing_key; /**< Key used to sign this directory. */
  1468. char *client_versions; /**< comma-separated list of recommended client
  1469. * versions. */
  1470. char *server_versions; /**< comma-separated list of recommended server
  1471. * versions. */
  1472. smartlist_t *entries; /**< List of routerstatus_t*. This list is kept
  1473. * sorted by identity_digest. */
  1474. } networkstatus_v2_t;
  1475. typedef struct vote_microdesc_hash_t {
  1476. struct vote_microdesc_hash_t *next;
  1477. char *microdesc_hash_line;
  1478. } vote_microdesc_hash_t;
  1479. /** The claim about a single router, made in a vote. */
  1480. typedef struct vote_routerstatus_t {
  1481. routerstatus_t status; /**< Underlying 'status' object for this router.
  1482. * Flags are redundant. */
  1483. uint64_t flags; /**< Bit-field for all recognized flags; index into
  1484. * networkstatus_t.known_flags. */
  1485. char *version; /**< The version that the authority says this router is
  1486. * running. */
  1487. vote_microdesc_hash_t *microdesc;
  1488. } vote_routerstatus_t;
  1489. /** A signature of some document by an authority. */
  1490. typedef struct document_signature_t {
  1491. /** Declared SHA-1 digest of this voter's identity key */
  1492. char identity_digest[DIGEST_LEN];
  1493. /** Declared SHA-1 digest of signing key used by this voter. */
  1494. char signing_key_digest[DIGEST_LEN];
  1495. /** Algorithm used to compute the digest of the document. */
  1496. digest_algorithm_t alg;
  1497. /** Signature of the signed thing. */
  1498. char *signature;
  1499. /** Length of <b>signature</b> */
  1500. int signature_len;
  1501. unsigned int bad_signature : 1; /**< Set to true if we've tried to verify
  1502. * the sig, and we know it's bad. */
  1503. unsigned int good_signature : 1; /**< Set to true if we've verified the sig
  1504. * as good. */
  1505. } document_signature_t;
  1506. /** Information about a single voter in a vote or a consensus. */
  1507. typedef struct networkstatus_voter_info_t {
  1508. /** Declared SHA-1 digest of this voter's identity key */
  1509. char identity_digest[DIGEST_LEN];
  1510. char *nickname; /**< Nickname of this voter */
  1511. /** Digest of this voter's "legacy" identity key, if any. In vote only; for
  1512. * consensuses, we treat legacy keys as additional signers. */
  1513. char legacy_id_digest[DIGEST_LEN];
  1514. char *address; /**< Address of this voter, in string format. */
  1515. uint32_t addr; /**< Address of this voter, in IPv4, in host order. */
  1516. uint16_t dir_port; /**< Directory port of this voter */
  1517. uint16_t or_port; /**< OR port of this voter */
  1518. char *contact; /**< Contact information for this voter. */
  1519. char vote_digest[DIGEST_LEN]; /**< Digest of this voter's vote, as signed. */
  1520. /* Nothing from here on is signed. */
  1521. /** The signature of the document and the signature's status. */
  1522. smartlist_t *sigs;
  1523. } networkstatus_voter_info_t;
  1524. /** Enumerates the possible seriousness values of a networkstatus document. */
  1525. typedef enum {
  1526. NS_TYPE_VOTE,
  1527. NS_TYPE_CONSENSUS,
  1528. NS_TYPE_OPINION,
  1529. } networkstatus_type_t;
  1530. /** Enumerates recognized flavors of a consensus networkstatus document. All
  1531. * flavors of a consensus are generated from the same set of votes, but they
  1532. * present different types information to different versions of Tor. */
  1533. typedef enum {
  1534. FLAV_NS = 0,
  1535. FLAV_MICRODESC = 1,
  1536. } consensus_flavor_t;
  1537. /** Which consensus flavor do we actually want to use to build circuits? */
  1538. #define USABLE_CONSENSUS_FLAVOR FLAV_NS
  1539. /** How many different consensus flavors are there? */
  1540. #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
  1541. /** A common structure to hold a v3 network status vote, or a v3 network
  1542. * status consensus. */
  1543. typedef struct networkstatus_t {
  1544. networkstatus_type_t type : 8; /**< Vote, consensus, or opinion? */
  1545. consensus_flavor_t flavor : 8; /**< If a consensus, what kind? */
  1546. time_t published; /**< Vote only: Time when vote was written. */
  1547. time_t valid_after; /**< Time after which this vote or consensus applies. */
  1548. time_t fresh_until; /**< Time before which this is the most recent vote or
  1549. * consensus. */
  1550. time_t valid_until; /**< Time after which this vote or consensus should not
  1551. * be used. */
  1552. /** Consensus only: what method was used to produce this consensus? */
  1553. int consensus_method;
  1554. /** Vote only: what methods is this voter willing to use? */
  1555. smartlist_t *supported_methods;
  1556. /** How long does this vote/consensus claim that authorities take to
  1557. * distribute their votes to one another? */
  1558. int vote_seconds;
  1559. /** How long does this vote/consensus claim that authorities take to
  1560. * distribute their consensus signatures to one another? */
  1561. int dist_seconds;
  1562. /** Comma-separated list of recommended client software, or NULL if this
  1563. * voter has no opinion. */
  1564. char *client_versions;
  1565. char *server_versions;
  1566. /** List of flags that this vote/consensus applies to routers. If a flag is
  1567. * not listed here, the voter has no opinion on what its value should be. */
  1568. smartlist_t *known_flags;
  1569. /** List of key=value strings for the parameters in this vote or
  1570. * consensus, sorted by key. */
  1571. smartlist_t *net_params;
  1572. /** List of key=value strings for the bw weight parameters in the
  1573. * consensus. */
  1574. smartlist_t *weight_params;
  1575. /** List of networkstatus_voter_info_t. For a vote, only one element
  1576. * is included. For a consensus, one element is included for every voter
  1577. * whose vote contributed to the consensus. */
  1578. smartlist_t *voters;
  1579. struct authority_cert_t *cert; /**< Vote only: the voter's certificate. */
  1580. /** Digests of this document, as signed. */
  1581. digests_t digests;
  1582. /** List of router statuses, sorted by identity digest. For a vote,
  1583. * the elements are vote_routerstatus_t; for a consensus, the elements
  1584. * are routerstatus_t. */
  1585. smartlist_t *routerstatus_list;
  1586. /** If present, a map from descriptor digest to elements of
  1587. * routerstatus_list. */
  1588. digestmap_t *desc_digest_map;
  1589. } networkstatus_t;
  1590. /** A set of signatures for a networkstatus consensus. Unless otherwise
  1591. * noted, all fields are as for networkstatus_t. */
  1592. typedef struct ns_detached_signatures_t {
  1593. time_t valid_after;
  1594. time_t fresh_until;
  1595. time_t valid_until;
  1596. strmap_t *digests; /**< Map from flavor name to digestset_t */
  1597. strmap_t *signatures; /**< Map from flavor name to list of
  1598. * document_signature_t */
  1599. } ns_detached_signatures_t;
  1600. /** Allowable types of desc_store_t. */
  1601. typedef enum store_type_t {
  1602. ROUTER_STORE = 0,
  1603. EXTRAINFO_STORE = 1
  1604. } store_type_t;
  1605. /** A 'store' is a set of descriptors saved on disk, with accompanying
  1606. * journal, mmaped as needed, rebuilt as needed. */
  1607. typedef struct desc_store_t {
  1608. /** Filename (within DataDir) for the store. We append .tmp to this
  1609. * filename for a temporary file when rebuilding the store, and .new to this
  1610. * filename for the journal. */
  1611. const char *fname_base;
  1612. /** Alternative (obsolete) value for fname_base: if the file named by
  1613. * fname_base isn't present, we read from here instead, but we never write
  1614. * here. */
  1615. const char *fname_alt_base;
  1616. /** Human-readable description of what this store contains. */
  1617. const char *description;
  1618. tor_mmap_t *mmap; /**< A mmap for the main file in the store. */
  1619. store_type_t type; /**< What's stored in this store? */
  1620. /** The size of the router log, in bytes. */
  1621. size_t journal_len;
  1622. /** The size of the router store, in bytes. */
  1623. size_t store_len;
  1624. /** Total bytes dropped since last rebuild: this is space currently
  1625. * used in the cache and the journal that could be freed by a rebuild. */
  1626. size_t bytes_dropped;
  1627. } desc_store_t;
  1628. /** Contents of a directory of onion routers. */
  1629. typedef struct {
  1630. /** Map from server identity digest to a member of routers. */
  1631. struct digest_ri_map_t *identity_map;
  1632. /** Map from server descriptor digest to a signed_descriptor_t from
  1633. * routers or old_routers. */
  1634. struct digest_sd_map_t *desc_digest_map;
  1635. /** Map from extra-info digest to an extrainfo_t. Only exists for
  1636. * routers in routers or old_routers. */
  1637. struct digest_ei_map_t *extra_info_map;
  1638. /** Map from extra-info digests to a signed_descriptor_t for a router
  1639. * descriptor having that extra-info digest. Only exists for
  1640. * routers in routers or old_routers. */
  1641. struct digest_sd_map_t *desc_by_eid_map;
  1642. /** List of routerinfo_t for all currently live routers we know. */
  1643. smartlist_t *routers;
  1644. /** List of signed_descriptor_t for older router descriptors we're
  1645. * caching. */
  1646. smartlist_t *old_routers;
  1647. /** Store holding server descriptors. If present, any router whose
  1648. * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
  1649. * starting at cache_info.saved_offset */
  1650. desc_store_t desc_store;
  1651. /** Store holding extra-info documents. */
  1652. desc_store_t extrainfo_store;
  1653. } routerlist_t;
  1654. /** Information on router used when extending a circuit. We don't need a
  1655. * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
  1656. * connection, and onion_key to create the onionskin. Note that for onehop
  1657. * general-purpose tunnels, the onion_key is NULL. */
  1658. typedef struct extend_info_t {
  1659. char nickname[MAX_HEX_NICKNAME_LEN+1]; /**< This router's nickname for
  1660. * display. */
  1661. char identity_digest[DIGEST_LEN]; /**< Hash of this router's identity key. */
  1662. uint16_t port; /**< OR port. */
  1663. tor_addr_t addr; /**< IP address. */
  1664. crypto_pk_env_t *onion_key; /**< Current onionskin key. */
  1665. } extend_info_t;
  1666. /** Certificate for v3 directory protocol: binds long-term authority identity
  1667. * keys to medium-term authority signing keys. */
  1668. typedef struct authority_cert_t {
  1669. /** Information relating to caching this cert on disk and looking it up. */
  1670. signed_descriptor_t cache_info;
  1671. /** This authority's long-term authority identity key. */
  1672. crypto_pk_env_t *identity_key;
  1673. /** This authority's medium-term signing key. */
  1674. crypto_pk_env_t *signing_key;
  1675. /** The digest of <b>signing_key</b> */
  1676. char signing_key_digest[DIGEST_LEN];
  1677. /** The listed expiration time of this certificate. */
  1678. time_t expires;
  1679. /** This authority's IPv4 address, in host order. */
  1680. uint32_t addr;
  1681. /** This authority's directory port. */
  1682. uint16_t dir_port;
  1683. /** True iff this certificate was cross-certified by signing the identity
  1684. * key with the signing key. */
  1685. uint8_t is_cross_certified;
  1686. } authority_cert_t;
  1687. /** Bitfield enum type listing types of directory authority/directory
  1688. * server. */
  1689. typedef enum {
  1690. NO_AUTHORITY = 0,
  1691. /** Serves/signs v1 directory information: Big lists of routers, and short
  1692. * routerstatus documents. */
  1693. V1_AUTHORITY = 1 << 0,
  1694. /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
  1695. V2_AUTHORITY = 1 << 1,
  1696. /** Serves/signs v3 directory information: votes, consensuses, certs */
  1697. V3_AUTHORITY = 1 << 2,
  1698. /** Serves hidden service descriptors. */
  1699. HIDSERV_AUTHORITY = 1 << 3,
  1700. /** Serves bridge descriptors. */
  1701. BRIDGE_AUTHORITY = 1 << 4,
  1702. /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
  1703. EXTRAINFO_CACHE = 1 << 5,
  1704. } authority_type_t;
  1705. #define CRYPT_PATH_MAGIC 0x70127012u
  1706. /** Holds accounting information for a single step in the layered encryption
  1707. * performed by a circuit. Used only at the client edge of a circuit. */
  1708. typedef struct crypt_path_t {
  1709. uint32_t magic;
  1710. /* crypto environments */
  1711. /** Encryption key and counter for cells heading towards the OR at this
  1712. * step. */
  1713. crypto_cipher_env_t *f_crypto;
  1714. /** Encryption key and counter for cells heading back from the OR at this
  1715. * step. */
  1716. crypto_cipher_env_t *b_crypto;
  1717. /** Digest state for cells heading towards the OR at this step. */
  1718. crypto_digest_env_t *f_digest; /* for integrity checking */
  1719. /** Digest state for cells heading away from the OR at this step. */
  1720. crypto_digest_env_t *b_digest;
  1721. /** Current state of Diffie-Hellman key negotiation with the OR at this
  1722. * step. */
  1723. crypto_dh_env_t *dh_handshake_state;
  1724. /** Current state of 'fast' (non-PK) key negotiation with the OR at this
  1725. * step. Used to save CPU when TLS is already providing all the
  1726. * authentication, secrecy, and integrity we need, and we're already
  1727. * distinguishable from an OR.
  1728. */
  1729. uint8_t fast_handshake_state[DIGEST_LEN];
  1730. /** Negotiated key material shared with the OR at this step. */
  1731. char handshake_digest[DIGEST_LEN];/* KH in tor-spec.txt */
  1732. /** Information to extend to the OR at this step. */
  1733. extend_info_t *extend_info;
  1734. /** Is the circuit built to this step? Must be one of:
  1735. * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
  1736. * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
  1737. * and not received an EXTENDED/CREATED)
  1738. * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
  1739. uint8_t state;
  1740. #define CPATH_STATE_CLOSED 0
  1741. #define CPATH_STATE_AWAITING_KEYS 1
  1742. #define CPATH_STATE_OPEN 2
  1743. struct crypt_path_t *next; /**< Link to next crypt_path_t in the circuit.
  1744. * (The list is circular, so the last node
  1745. * links to the first.) */
  1746. struct crypt_path_t *prev; /**< Link to previous crypt_path_t in the
  1747. * circuit. */
  1748. int package_window; /**< How many cells are we allowed to originate ending
  1749. * at this step? */
  1750. int deliver_window; /**< How many cells are we willing to deliver originating
  1751. * at this step? */
  1752. } crypt_path_t;
  1753. #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
  1754. #define DH_KEY_LEN DH_BYTES
  1755. #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
  1756. CIPHER_KEY_LEN+\
  1757. DH_KEY_LEN)
  1758. #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
  1759. /** Information used to build a circuit. */
  1760. typedef struct {
  1761. /** Intended length of the final circuit. */
  1762. int desired_path_len;
  1763. /** How to extend to the planned exit node. */
  1764. extend_info_t *chosen_exit;
  1765. /** Whether every node in the circ must have adequate uptime. */
  1766. int need_uptime;
  1767. /** Whether every node in the circ must have adequate capacity. */
  1768. int need_capacity;
  1769. /** Whether the last hop was picked with exiting in mind. */
  1770. int is_internal;
  1771. /** Did we pick this as a one-hop tunnel (not safe for other conns)?
  1772. * These are for encrypted connections that exit to this router, not
  1773. * for arbitrary exits from the circuit. */
  1774. int onehop_tunnel;
  1775. /** The crypt_path_t to append after rendezvous: used for rendezvous. */
  1776. crypt_path_t *pending_final_cpath;
  1777. /** How many times has building a circuit for this task failed? */
  1778. int failure_count;
  1779. /** At what time should we give up on this task? */
  1780. time_t expiry_time;
  1781. } cpath_build_state_t;
  1782. /**
  1783. * The cell_ewma_t structure keeps track of how many cells a circuit has
  1784. * transferred recently. It keeps an EWMA (exponentially weighted moving
  1785. * average) of the number of cells flushed from the circuit queue onto a
  1786. * connection in connection_or_flush_from_first_active_circuit().
  1787. */
  1788. typedef struct {
  1789. /** The last 'tick' at which we recalibrated cell_count.
  1790. *
  1791. * A cell sent at exactly the start of this tick has weight 1.0. Cells sent
  1792. * since the start of this tick have weight greater than 1.0; ones sent
  1793. * earlier have less weight. */
  1794. unsigned last_adjusted_tick;
  1795. /** The EWMA of the cell count. */
  1796. double cell_count;
  1797. /** True iff this is the cell count for a circuit's previous
  1798. * connection. */
  1799. unsigned int is_for_p_conn : 1;
  1800. /** The position of the circuit within the OR connection's priority
  1801. * queue. */
  1802. int heap_index;
  1803. } cell_ewma_t;
  1804. #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
  1805. #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
  1806. /**
  1807. * A circuit is a path over the onion routing
  1808. * network. Applications can connect to one end of the circuit, and can
  1809. * create exit connections at the other end of the circuit. AP and exit
  1810. * connections have only one circuit associated with them (and thus these
  1811. * connection types are closed when the circuit is closed), whereas
  1812. * OR connections multiplex many circuits at once, and stay standing even
  1813. * when there are no circuits running over them.
  1814. *
  1815. * A circuit_t structure can fill one of two roles. First, a or_circuit_t
  1816. * links two connections together: either an edge connection and an OR
  1817. * connection, or two OR connections. (When joined to an OR connection, a
  1818. * circuit_t affects only cells sent to a particular circID on that
  1819. * connection. When joined to an edge connection, a circuit_t affects all
  1820. * data.)
  1821. * Second, an origin_circuit_t holds the cipher keys and state for sending data
  1822. * along a given circuit. At the OP, it has a sequence of ciphers, each
  1823. * of which is shared with a single OR along the circuit. Separate
  1824. * ciphers are used for data going "forward" (away from the OP) and
  1825. * "backward" (towards the OP). At the OR, a circuit has only two stream
  1826. * ciphers: one for data going forward, and one for data going backward.
  1827. */
  1828. typedef struct circuit_t {
  1829. uint32_t magic; /**< For memory and type debugging: must equal
  1830. * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
  1831. /** Queue of cells waiting to be transmitted on n_conn. */
  1832. cell_queue_t n_conn_cells;
  1833. /** The OR connection that is next in this circuit. */
  1834. or_connection_t *n_conn;
  1835. /** The circuit_id used in the next (forward) hop of this circuit. */
  1836. circid_t n_circ_id;
  1837. /** The hop to which we want to extend this circuit. Should be NULL if
  1838. * the circuit has attached to a connection. */
  1839. extend_info_t *n_hop;
  1840. /** True iff we are waiting for n_conn_cells to become less full before
  1841. * allowing p_streams to add any more cells. (Origin circuit only.) */
  1842. unsigned int streams_blocked_on_n_conn : 1;
  1843. /** True iff we are waiting for p_conn_cells to become less full before
  1844. * allowing n_streams to add any more cells. (OR circuit only.) */
  1845. unsigned int streams_blocked_on_p_conn : 1;
  1846. uint8_t state; /**< Current status of this circuit. */
  1847. uint8_t purpose; /**< Why are we creating this circuit? */
  1848. /** How many relay data cells can we package (read from edge streams)
  1849. * on this circuit before we receive a circuit-level sendme cell asking
  1850. * for more? */
  1851. int package_window;
  1852. /** How many relay data cells will we deliver (write to edge streams)
  1853. * on this circuit? When deliver_window gets low, we send some
  1854. * circuit-level sendme cells to indicate that we're willing to accept
  1855. * more. */
  1856. int deliver_window;
  1857. /** For storage while n_conn is pending
  1858. * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
  1859. * length ONIONSKIN_CHALLENGE_LEN. */
  1860. char *n_conn_onionskin;
  1861. time_t timestamp_created; /**< When was this circuit created? */
  1862. time_t timestamp_dirty; /**< When the circuit was first used, or 0 if the
  1863. * circuit is clean. */
  1864. struct timeval highres_created; /**< When exactly was the circuit created? */
  1865. uint16_t marked_for_close; /**< Should we close this circuit at the end of
  1866. * the main loop? (If true, holds the line number
  1867. * where this circuit was marked.) */
  1868. const char *marked_for_close_file; /**< For debugging: in which file was this
  1869. * circuit marked for close? */
  1870. /** Next circuit in the doubly-linked ring of circuits waiting to add
  1871. * cells to n_conn. NULL if we have no cells pending, or if we're not
  1872. * linked to an OR connection. */
  1873. struct circuit_t *next_active_on_n_conn;
  1874. /** Previous circuit in the doubly-linked ring of circuits waiting to add
  1875. * cells to n_conn. NULL if we have no cells pending, or if we're not
  1876. * linked to an OR connection. */
  1877. struct circuit_t *prev_active_on_n_conn;
  1878. struct circuit_t *next; /**< Next circuit in linked list of all circuits. */
  1879. /** Unique ID for measuring tunneled network status requests. */
  1880. uint64_t dirreq_id;
  1881. /** The EWMA count for the number of cells flushed from the
  1882. * n_conn_cells queue. Used to determine which circuit to flush from next.
  1883. */
  1884. cell_ewma_t n_cell_ewma;
  1885. } circuit_t;
  1886. /** Largest number of relay_early cells that we can send on a given
  1887. * circuit. */
  1888. #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
  1889. /** An origin_circuit_t holds data necessary to build and use a circuit.
  1890. */
  1891. typedef struct origin_circuit_t {
  1892. circuit_t _base;
  1893. /** Linked list of AP streams (or EXIT streams if hidden service)
  1894. * associated with this circuit. */
  1895. edge_connection_t *p_streams;
  1896. /** Build state for this circuit. It includes the intended path
  1897. * length, the chosen exit router, rendezvous information, etc.
  1898. */
  1899. cpath_build_state_t *build_state;
  1900. /** The doubly-linked list of crypt_path_t entries, one per hop,
  1901. * for this circuit. This includes ciphers for each hop,
  1902. * integrity-checking digests for each hop, and package/delivery
  1903. * windows for each hop.
  1904. */
  1905. crypt_path_t *cpath;
  1906. /** Holds all rendezvous data on either client or service side. */
  1907. rend_data_t *rend_data;
  1908. /** How many more relay_early cells can we send on this circuit, according
  1909. * to the specification? */
  1910. unsigned int remaining_relay_early_cells : 4;
  1911. /** Set if this circuit is insanely old and we already informed the user */
  1912. unsigned int is_ancient : 1;
  1913. /** Set if this circuit has already been opened. Used to detect
  1914. * cannibalized circuits. */
  1915. unsigned int has_opened : 1;
  1916. /** What commands were sent over this circuit that decremented the
  1917. * RELAY_EARLY counter? This is for debugging task 878. */
  1918. uint8_t relay_early_commands[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT];
  1919. /** How many RELAY_EARLY cells have been sent over this circuit? This is
  1920. * for debugging task 878, too. */
  1921. int relay_early_cells_sent;
  1922. /** The next stream_id that will be tried when we're attempting to
  1923. * construct a new AP stream originating at this circuit. */
  1924. streamid_t next_stream_id;
  1925. /* The intro key replaces the hidden service's public key if purpose is
  1926. * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
  1927. * descriptor is used. */
  1928. crypto_pk_env_t *intro_key;
  1929. /** Quasi-global identifier for this circuit; used for control.c */
  1930. /* XXXX NM This can get re-used after 2**32 circuits. */
  1931. uint32_t global_identifier;
  1932. } origin_circuit_t;
  1933. /** An or_circuit_t holds information needed to implement a circuit at an
  1934. * OR. */
  1935. typedef struct or_circuit_t {
  1936. circuit_t _base;
  1937. /** Next circuit in the doubly-linked ring of circuits waiting to add
  1938. * cells to p_conn. NULL if we have no cells pending, or if we're not
  1939. * linked to an OR connection. */
  1940. struct circuit_t *next_active_on_p_conn;
  1941. /** Previous circuit in the doubly-linked ring of circuits waiting to add
  1942. * cells to p_conn. NULL if we have no cells pending, or if we're not
  1943. * linked to an OR connection. */
  1944. struct circuit_t *prev_active_on_p_conn;
  1945. /** The circuit_id used in the previous (backward) hop of this circuit. */
  1946. circid_t p_circ_id;
  1947. /** Queue of cells waiting to be transmitted on p_conn. */
  1948. cell_queue_t p_conn_cells;
  1949. /** The OR connection that is previous in this circuit. */
  1950. or_connection_t *p_conn;
  1951. /** Linked list of Exit streams associated with this circuit. */
  1952. edge_connection_t *n_streams;
  1953. /** Linked list of Exit streams associated with this circuit that are
  1954. * still being resolved. */
  1955. edge_connection_t *resolving_streams;
  1956. /** The cipher used by intermediate hops for cells heading toward the
  1957. * OP. */
  1958. crypto_cipher_env_t *p_crypto;
  1959. /** The cipher used by intermediate hops for cells heading away from
  1960. * the OP. */
  1961. crypto_cipher_env_t *n_crypto;
  1962. /** The integrity-checking digest used by intermediate hops, for
  1963. * cells packaged here and heading towards the OP.
  1964. */
  1965. crypto_digest_env_t *p_digest;
  1966. /** The integrity-checking digest used by intermediate hops, for
  1967. * cells packaged at the OP and arriving here.
  1968. */
  1969. crypto_digest_env_t *n_digest;
  1970. /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
  1971. * is not marked for close. */
  1972. struct or_circuit_t *rend_splice;
  1973. #if REND_COOKIE_LEN >= DIGEST_LEN
  1974. #define REND_TOKEN_LEN REND_COOKIE_LEN
  1975. #else
  1976. #define REND_TOKEN_LEN DIGEST_LEN
  1977. #endif
  1978. /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
  1979. * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
  1980. * otherwise.
  1981. * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
  1982. */
  1983. char rend_token[REND_TOKEN_LEN];
  1984. /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
  1985. char handshake_digest[DIGEST_LEN]; /**< Stores KH for the handshake. */
  1986. /** How many more relay_early cells can we send on this circuit, according
  1987. * to the specification? */
  1988. unsigned int remaining_relay_early_cells : 4;
  1989. /** True iff this circuit was made with a CREATE_FAST cell. */
  1990. unsigned int is_first_hop : 1;
  1991. /** Number of cells that were removed from circuit queue; reset every
  1992. * time when writing buffer stats to disk. */
  1993. uint32_t processed_cells;
  1994. /** Total time in milliseconds that cells spent in both app-ward and
  1995. * exit-ward queues of this circuit; reset every time when writing
  1996. * buffer stats to disk. */
  1997. uint64_t total_cell_waiting_time;
  1998. /** The EWMA count for the number of cells flushed from the
  1999. * p_conn_cells queue. */
  2000. cell_ewma_t p_cell_ewma;
  2001. } or_circuit_t;
  2002. /** Convert a circuit subtype to a circuit_t.*/
  2003. #define TO_CIRCUIT(x) (&((x)->_base))
  2004. /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
  2005. * if the cast is impossible. */
  2006. static or_circuit_t *TO_OR_CIRCUIT(circuit_t *);
  2007. /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
  2008. * Asserts if the cast is impossible. */
  2009. static origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *);
  2010. static INLINE or_circuit_t *TO_OR_CIRCUIT(circuit_t *x)
  2011. {
  2012. tor_assert(x->magic == OR_CIRCUIT_MAGIC);
  2013. return DOWNCAST(or_circuit_t, x);
  2014. }
  2015. static INLINE origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *x)
  2016. {
  2017. tor_assert(x->magic == ORIGIN_CIRCUIT_MAGIC);
  2018. return DOWNCAST(origin_circuit_t, x);
  2019. }
  2020. /** Bitfield type: things that we're willing to use invalid routers for. */
  2021. typedef enum invalid_router_usage_t {
  2022. ALLOW_INVALID_ENTRY =1,
  2023. ALLOW_INVALID_EXIT =2,
  2024. ALLOW_INVALID_MIDDLE =4,
  2025. ALLOW_INVALID_RENDEZVOUS =8,
  2026. ALLOW_INVALID_INTRODUCTION=16,
  2027. } invalid_router_usage_t;
  2028. /* limits for TCP send and recv buffer size used for constrained sockets */
  2029. #define MIN_CONSTRAINED_TCP_BUFFER 2048
  2030. #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
  2031. /** A linked list of lines in a config file. */
  2032. typedef struct config_line_t {
  2033. char *key;
  2034. char *value;
  2035. struct config_line_t *next;
  2036. } config_line_t;
  2037. typedef struct routerset_t routerset_t;
  2038. /** Configuration options for a Tor process. */
  2039. typedef struct {
  2040. uint32_t _magic;
  2041. /** What should the tor process actually do? */
  2042. enum {
  2043. CMD_RUN_TOR=0, CMD_LIST_FINGERPRINT, CMD_HASH_PASSWORD,
  2044. CMD_VERIFY_CONFIG, CMD_RUN_UNITTESTS
  2045. } command;
  2046. const char *command_arg; /**< Argument for command-line option. */
  2047. config_line_t *Logs; /**< New-style list of configuration lines
  2048. * for logs */
  2049. char *DebugLogFile; /**< Where to send verbose log messages. */
  2050. char *DataDirectory; /**< OR only: where to store long-term data. */
  2051. char *Nickname; /**< OR only: nickname of this onion router. */
  2052. char *Address; /**< OR only: configured address for this onion router. */
  2053. char *PidFile; /**< Where to store PID of Tor process. */
  2054. routerset_t *ExitNodes; /**< Structure containing nicknames, digests,
  2055. * country codes and IP address patterns of ORs to
  2056. * consider as exits. */
  2057. routerset_t *EntryNodes;/**< Structure containing nicknames, digests,
  2058. * country codes and IP address patterns of ORs to
  2059. * consider as entry points. */
  2060. int StrictNodes; /**< Boolean: When none of our EntryNodes or ExitNodes
  2061. * are up, or we need to access a node in ExcludeNodes,
  2062. * do we just fail instead? */
  2063. routerset_t *ExcludeNodes;/**< Structure containing nicknames, digests,
  2064. * country codes and IP address patterns of ORs
  2065. * not to use in circuits. But see StrictNodes
  2066. * above. */
  2067. routerset_t *ExcludeExitNodes;/**< Structure containing nicknames, digests,
  2068. * country codes and IP address patterns of
  2069. * ORs not to consider as exits. */
  2070. /** Union of ExcludeNodes and ExcludeExitNodes */
  2071. struct routerset_t *_ExcludeExitNodesUnion;
  2072. int DisableAllSwap; /**< Boolean: Attempt to call mlockall() on our
  2073. * process for all current and future memory. */
  2074. /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
  2075. smartlist_t *AllowInvalidNodes;
  2076. /** Bitmask; derived from AllowInvalidNodes. */
  2077. invalid_router_usage_t _AllowInvalid;
  2078. config_line_t *ExitPolicy; /**< Lists of exit policy components. */
  2079. int ExitPolicyRejectPrivate; /**< Should we not exit to local addresses? */
  2080. config_line_t *SocksPolicy; /**< Lists of socks policy components */
  2081. config_line_t *DirPolicy; /**< Lists of dir policy components */
  2082. /** Addresses to bind for listening for SOCKS connections. */
  2083. config_line_t *SocksListenAddress;
  2084. /** Addresses to bind for listening for transparent pf/netfilter
  2085. * connections. */
  2086. config_line_t *TransListenAddress;
  2087. /** Addresses to bind for listening for transparent natd connections */
  2088. config_line_t *NATDListenAddress;
  2089. /** Addresses to bind for listening for SOCKS connections. */
  2090. config_line_t *DNSListenAddress;
  2091. /** Addresses to bind for listening for OR connections. */
  2092. config_line_t *ORListenAddress;
  2093. /** Addresses to bind for listening for directory connections. */
  2094. config_line_t *DirListenAddress;
  2095. /** Addresses to bind for listening for control connections. */
  2096. config_line_t *ControlListenAddress;
  2097. /** Local address to bind outbound sockets */
  2098. char *OutboundBindAddress;
  2099. /** Directory server only: which versions of
  2100. * Tor should we tell users to run? */
  2101. config_line_t *RecommendedVersions;
  2102. config_line_t *RecommendedClientVersions;
  2103. config_line_t *RecommendedServerVersions;
  2104. /** Whether dirservers refuse router descriptors with private IPs. */
  2105. int DirAllowPrivateAddresses;
  2106. char *User; /**< Name of user to run Tor as. */
  2107. char *Group; /**< Name of group to run Tor as. */
  2108. int ORPort; /**< Port to listen on for OR connections. */
  2109. int SocksPort; /**< Port to listen on for SOCKS connections. */
  2110. /** Port to listen on for transparent pf/netfilter connections. */
  2111. int TransPort;
  2112. int NATDPort; /**< Port to listen on for transparent natd connections. */
  2113. int ControlPort; /**< Port to listen on for control connections. */
  2114. config_line_t *ControlSocket; /**< List of Unix Domain Sockets to listen on
  2115. * for control connections. */
  2116. int DirPort; /**< Port to listen on for directory connections. */
  2117. int DNSPort; /**< Port to listen on for DNS requests. */
  2118. int AssumeReachable; /**< Whether to publish our descriptor regardless. */
  2119. int AuthoritativeDir; /**< Boolean: is this an authoritative directory? */
  2120. int V1AuthoritativeDir; /**< Boolean: is this an authoritative directory
  2121. * for version 1 directories? */
  2122. int V2AuthoritativeDir; /**< Boolean: is this an authoritative directory
  2123. * for version 2 directories? */
  2124. int V3AuthoritativeDir; /**< Boolean: is this an authoritative directory
  2125. * for version 3 directories? */
  2126. int HSAuthoritativeDir; /**< Boolean: does this an authoritative directory
  2127. * handle hidden service requests? */
  2128. int NamingAuthoritativeDir; /**< Boolean: is this an authoritative directory
  2129. * that's willing to bind names? */
  2130. int VersioningAuthoritativeDir; /**< Boolean: is this an authoritative
  2131. * directory that's willing to recommend
  2132. * versions? */
  2133. int BridgeAuthoritativeDir; /**< Boolean: is this an authoritative directory
  2134. * that aggregates bridge descriptors? */
  2135. /** If set on a bridge authority, it will answer requests on its dirport
  2136. * for bridge statuses -- but only if the requests use this password.
  2137. * If set on a bridge user, request bridge statuses, and use this password
  2138. * when doing so. */
  2139. char *BridgePassword;
  2140. int UseBridges; /**< Boolean: should we start all circuits with a bridge? */
  2141. config_line_t *Bridges; /**< List of bootstrap bridge addresses. */
  2142. int BridgeRelay; /**< Boolean: are we acting as a bridge relay? We make
  2143. * this explicit so we can change how we behave in the
  2144. * future. */
  2145. /** Boolean: if we know the bridge's digest, should we get new
  2146. * descriptors from the bridge authorities or from the bridge itself? */
  2147. int UpdateBridgesFromAuthority;
  2148. int AvoidDiskWrites; /**< Boolean: should we never cache things to disk?
  2149. * Not used yet. */
  2150. int ClientOnly; /**< Boolean: should we never evolve into a server role? */
  2151. /** To what authority types do we publish our descriptor? Choices are
  2152. * "v1", "v2", "v3", "bridge", or "". */
  2153. smartlist_t *PublishServerDescriptor;
  2154. /** An authority type, derived from PublishServerDescriptor. */
  2155. authority_type_t _PublishServerDescriptor;
  2156. /** Boolean: do we publish hidden service descriptors to the HS auths? */
  2157. int PublishHidServDescriptors;
  2158. int FetchServerDescriptors; /**< Do we fetch server descriptors as normal? */
  2159. int FetchHidServDescriptors; /** and hidden service descriptors? */
  2160. int HidServDirectoryV2; /**< Do we participate in the HS DHT? */
  2161. int MinUptimeHidServDirectoryV2; /**< As directory authority, accept hidden
  2162. * service directories after what time? */
  2163. int FetchUselessDescriptors; /**< Do we fetch non-running descriptors too? */
  2164. int AllDirActionsPrivate; /**< Should every directory action be sent
  2165. * through a Tor circuit? */
  2166. int ConnLimit; /**< Demanded minimum number of simultaneous connections. */
  2167. int _ConnLimit; /**< Maximum allowed number of simultaneous connections. */
  2168. int RunAsDaemon; /**< If true, run in the background. (Unix only) */
  2169. int FascistFirewall; /**< Whether to prefer ORs reachable on open ports. */
  2170. smartlist_t *FirewallPorts; /**< Which ports our firewall allows
  2171. * (strings). */
  2172. config_line_t *ReachableAddresses; /**< IP:ports our firewall allows. */
  2173. config_line_t *ReachableORAddresses; /**< IP:ports for OR conns. */
  2174. config_line_t *ReachableDirAddresses; /**< IP:ports for Dir conns. */
  2175. int ConstrainedSockets; /**< Shrink xmit and recv socket buffers. */
  2176. uint64_t ConstrainedSockSize; /**< Size of constrained buffers. */
  2177. /** Whether we should drop exit streams from Tors that we don't know are
  2178. * relays. One of "0" (never refuse), "1" (always refuse), or "auto" (do
  2179. * what the consensus says, defaulting to 'refuse' if the consensus says
  2180. * nothing). */
  2181. char *RefuseUnknownExits;
  2182. /** Parsed version of RefuseUnknownExits. -1 for auto. */
  2183. int RefuseUnknownExits_;
  2184. /** Application ports that require all nodes in circ to have sufficient
  2185. * uptime. */
  2186. smartlist_t *LongLivedPorts;
  2187. /** Application ports that are likely to be unencrypted and
  2188. * unauthenticated; we reject requests for them to prevent the
  2189. * user from screwing up and leaking plaintext secrets to an
  2190. * observer somewhere on the Internet. */
  2191. smartlist_t *RejectPlaintextPorts;
  2192. /** Related to RejectPlaintextPorts above, except this config option
  2193. * controls whether we warn (in the log and via a controller status
  2194. * event) every time a risky connection is attempted. */
  2195. smartlist_t *WarnPlaintextPorts;
  2196. /** Should we try to reuse the same exit node for a given host */
  2197. smartlist_t *TrackHostExits;
  2198. int TrackHostExitsExpire; /**< Number of seconds until we expire an
  2199. * addressmap */
  2200. config_line_t *AddressMap; /**< List of address map directives. */
  2201. int AutomapHostsOnResolve; /**< If true, when we get a resolve request for a
  2202. * hostname ending with one of the suffixes in
  2203. * <b>AutomapHostsSuffixes</b>, map it to a
  2204. * virtual address. */
  2205. smartlist_t *AutomapHostsSuffixes; /**< List of suffixes for
  2206. * <b>AutomapHostsOnResolve</b>. */
  2207. int RendPostPeriod; /**< How often do we post each rendezvous service
  2208. * descriptor? Remember to publish them independently. */
  2209. int KeepalivePeriod; /**< How often do we send padding cells to keep
  2210. * connections alive? */
  2211. int SocksTimeout; /**< How long do we let a socks connection wait
  2212. * unattached before we fail it? */
  2213. int LearnCircuitBuildTimeout; /**< If non-zero, we attempt to learn a value
  2214. * for CircuitBuildTimeout based on timeout
  2215. * history */
  2216. int CircuitBuildTimeout; /**< Cull non-open circuits that were born at
  2217. * least this many seconds ago. Used until
  2218. * adaptive algorithm learns a new value. */
  2219. int CircuitIdleTimeout; /**< Cull open clean circuits that were born
  2220. * at least this many seconds ago. */
  2221. int CircuitStreamTimeout; /**< If non-zero, detach streams from circuits
  2222. * and try a new circuit if the stream has been
  2223. * waiting for this many seconds. If zero, use
  2224. * our default internal timeout schedule. */
  2225. int MaxOnionsPending; /**< How many circuit CREATE requests do we allow
  2226. * to wait simultaneously before we start dropping
  2227. * them? */
  2228. int NewCircuitPeriod; /**< How long do we use a circuit before building
  2229. * a new one? */
  2230. int MaxCircuitDirtiness; /**< Never use circs that were first used more than
  2231. this interval ago. */
  2232. uint64_t BandwidthRate; /**< How much bandwidth, on average, are we willing
  2233. * to use in a second? */
  2234. uint64_t BandwidthBurst; /**< How much bandwidth, at maximum, are we willing
  2235. * to use in a second? */
  2236. uint64_t MaxAdvertisedBandwidth; /**< How much bandwidth are we willing to
  2237. * tell people we have? */
  2238. uint64_t RelayBandwidthRate; /**< How much bandwidth, on average, are we
  2239. * willing to use for all relayed conns? */
  2240. uint64_t RelayBandwidthBurst; /**< How much bandwidth, at maximum, will we
  2241. * use in a second for all relayed conns? */
  2242. uint64_t PerConnBWRate; /**< Long-term bw on a single TLS conn, if set. */
  2243. uint64_t PerConnBWBurst; /**< Allowed burst on a single TLS conn, if set. */
  2244. int NumCPUs; /**< How many CPUs should we try to use? */
  2245. //int RunTesting; /**< If true, create testing circuits to measure how well the
  2246. // * other ORs are running. */
  2247. config_line_t *RendConfigLines; /**< List of configuration lines
  2248. * for rendezvous services. */
  2249. config_line_t *HidServAuth; /**< List of configuration lines for client-side
  2250. * authorizations for hidden services */
  2251. char *ContactInfo; /**< Contact info to be published in the directory. */
  2252. char *HTTPProxy; /**< hostname[:port] to use as http proxy, if any. */
  2253. tor_addr_t HTTPProxyAddr; /**< Parsed IPv4 addr for http proxy, if any. */
  2254. uint16_t HTTPProxyPort; /**< Parsed port for http proxy, if any. */
  2255. char *HTTPProxyAuthenticator; /**< username:password string, if any. */
  2256. char *HTTPSProxy; /**< hostname[:port] to use as https proxy, if any. */
  2257. tor_addr_t HTTPSProxyAddr; /**< Parsed addr for https proxy, if any. */
  2258. uint16_t HTTPSProxyPort; /**< Parsed port for https proxy, if any. */
  2259. char *HTTPSProxyAuthenticator; /**< username:password string, if any. */
  2260. char *Socks4Proxy; /**< hostname:port to use as a SOCKS4 proxy, if any. */
  2261. tor_addr_t Socks4ProxyAddr; /**< Derived from Socks4Proxy. */
  2262. uint16_t Socks4ProxyPort; /**< Derived from Socks4Proxy. */
  2263. char *Socks5Proxy; /**< hostname:port to use as a SOCKS5 proxy, if any. */
  2264. tor_addr_t Socks5ProxyAddr; /**< Derived from Sock5Proxy. */
  2265. uint16_t Socks5ProxyPort; /**< Derived from Socks5Proxy. */
  2266. char *Socks5ProxyUsername; /**< Username for SOCKS5 authentication, if any */
  2267. char *Socks5ProxyPassword; /**< Password for SOCKS5 authentication, if any */
  2268. /** List of configuration lines for replacement directory authorities.
  2269. * If you just want to replace one class of authority at a time,
  2270. * use the "Alternate*Authority" options below instead. */
  2271. config_line_t *DirServers;
  2272. /** If set, use these main (currently v3) directory authorities and
  2273. * not the default ones. */
  2274. config_line_t *AlternateDirAuthority;
  2275. /** If set, use these bridge authorities and not the default one. */
  2276. config_line_t *AlternateBridgeAuthority;
  2277. /** If set, use these HS authorities and not the default ones. */
  2278. config_line_t *AlternateHSAuthority;
  2279. char *MyFamily; /**< Declared family for this OR. */
  2280. config_line_t *NodeFamilies; /**< List of config lines for
  2281. * node families */
  2282. config_line_t *AuthDirBadDir; /**< Address policy for descriptors to
  2283. * mark as bad dir mirrors. */
  2284. config_line_t *AuthDirBadExit; /**< Address policy for descriptors to
  2285. * mark as bad exits. */
  2286. config_line_t *AuthDirReject; /**< Address policy for descriptors to
  2287. * reject. */
  2288. config_line_t *AuthDirInvalid; /**< Address policy for descriptors to
  2289. * never mark as valid. */
  2290. int AuthDirListBadDirs; /**< True iff we should list bad dirs,
  2291. * and vote for all other dir mirrors as good. */
  2292. int AuthDirListBadExits; /**< True iff we should list bad exits,
  2293. * and vote for all other exits as good. */
  2294. int AuthDirRejectUnlisted; /**< Boolean: do we reject all routers that
  2295. * aren't named in our fingerprint file? */
  2296. int AuthDirMaxServersPerAddr; /**< Do not permit more than this
  2297. * number of servers per IP address. */
  2298. int AuthDirMaxServersPerAuthAddr; /**< Do not permit more than this
  2299. * number of servers per IP address shared
  2300. * with an authority. */
  2301. char *AccountingStart; /**< How long is the accounting interval, and when
  2302. * does it start? */
  2303. uint64_t AccountingMax; /**< How many bytes do we allow per accounting
  2304. * interval before hibernation? 0 for "never
  2305. * hibernate." */
  2306. /** Base64-encoded hash of accepted passwords for the control system. */
  2307. config_line_t *HashedControlPassword;
  2308. /** As HashedControlPassword, but not saved. */
  2309. config_line_t *HashedControlSessionPassword;
  2310. int CookieAuthentication; /**< Boolean: do we enable cookie-based auth for
  2311. * the control system? */
  2312. char *CookieAuthFile; /**< Location of a cookie authentication file. */
  2313. int CookieAuthFileGroupReadable; /**< Boolean: Is the CookieAuthFile g+r? */
  2314. int LeaveStreamsUnattached; /**< Boolean: Does Tor attach new streams to
  2315. * circuits itself (0), or does it expect a controller
  2316. * to cope? (1) */
  2317. int DisablePredictedCircuits; /**< Boolean: does Tor preemptively
  2318. * make circuits in the background (0),
  2319. * or not (1)? */
  2320. int ShutdownWaitLength; /**< When we get a SIGINT and we're a server, how
  2321. * long do we wait before exiting? */
  2322. char *SafeLogging; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
  2323. /* Derived from SafeLogging */
  2324. enum {
  2325. SAFELOG_SCRUB_ALL, SAFELOG_SCRUB_RELAY, SAFELOG_SCRUB_NONE
  2326. } _SafeLogging;
  2327. int SafeSocks; /**< Boolean: should we outright refuse application
  2328. * connections that use socks4 or socks5-with-local-dns? */
  2329. #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
  2330. LOG_WARN : LOG_INFO)
  2331. int ProtocolWarnings; /**< Boolean: when other parties screw up the Tor
  2332. * protocol, is it a warn or an info in our logs? */
  2333. int TestSocks; /**< Boolean: when we get a socks connection, do we loudly
  2334. * log whether it was DNS-leaking or not? */
  2335. int HardwareAccel; /**< Boolean: Should we enable OpenSSL hardware
  2336. * acceleration where available? */
  2337. char *AccelName; /**< Optional hardware acceleration engine name. */
  2338. char *AccelDir; /**< Optional hardware acceleration engine search dir. */
  2339. int UseEntryGuards; /**< Boolean: Do we try to enter from a smallish number
  2340. * of fixed nodes? */
  2341. int NumEntryGuards; /**< How many entry guards do we try to establish? */
  2342. int RephistTrackTime; /**< How many seconds do we keep rephist info? */
  2343. int FastFirstHopPK; /**< If Tor believes it is safe, should we save a third
  2344. * of our PK time by sending CREATE_FAST cells? */
  2345. /** Should we always fetch our dir info on the mirror schedule (which
  2346. * means directly from the authorities) no matter our other config? */
  2347. int FetchDirInfoEarly;
  2348. /** Should we fetch our dir info at the start of the consensus period? */
  2349. int FetchDirInfoExtraEarly;
  2350. char *VirtualAddrNetwork; /**< Address and mask to hand out for virtual
  2351. * MAPADDRESS requests. */
  2352. int ServerDNSSearchDomains; /**< Boolean: If set, we don't force exit
  2353. * addresses to be FQDNs, but rather search for them in
  2354. * the local domains. */
  2355. int ServerDNSDetectHijacking; /**< Boolean: If true, check for DNS failure
  2356. * hijacking. */
  2357. int ServerDNSRandomizeCase; /**< Boolean: Use the 0x20-hack to prevent
  2358. * DNS poisoning attacks. */
  2359. char *ServerDNSResolvConfFile; /**< If provided, we configure our internal
  2360. * resolver from the file here rather than from
  2361. * /etc/resolv.conf (Unix) or the registry (Windows). */
  2362. char *DirPortFrontPage; /**< This is a full path to a file with an html
  2363. disclaimer. This allows a server administrator to show
  2364. that they're running Tor and anyone visiting their server
  2365. will know this without any specialized knowledge. */
  2366. /** Boolean: if set, we start even if our resolv.conf file is missing
  2367. * or broken. */
  2368. int ServerDNSAllowBrokenConfig;
  2369. smartlist_t *ServerDNSTestAddresses; /**< A list of addresses that definitely
  2370. * should be resolvable. Used for
  2371. * testing our DNS server. */
  2372. int EnforceDistinctSubnets; /**< If true, don't allow multiple routers in the
  2373. * same network zone in the same circuit. */
  2374. int TunnelDirConns; /**< If true, use BEGIN_DIR rather than BEGIN when
  2375. * possible. */
  2376. int PreferTunneledDirConns; /**< If true, avoid dirservers that don't
  2377. * support BEGIN_DIR, when possible. */
  2378. int AllowNonRFC953Hostnames; /**< If true, we allow connections to hostnames
  2379. * with weird characters. */
  2380. /** If true, we try resolving hostnames with weird characters. */
  2381. int ServerDNSAllowNonRFC953Hostnames;
  2382. /** If true, we try to download extra-info documents (and we serve them,
  2383. * if we are a cache). For authorities, this is always true. */
  2384. int DownloadExtraInfo;
  2385. /** If true, and we are acting as a relay, allow exit circuits even when
  2386. * we are the first hop of a circuit. */
  2387. int AllowSingleHopExits;
  2388. /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
  2389. * circuits that we build. */
  2390. int ExcludeSingleHopRelays;
  2391. /** If true, and the controller tells us to use a one-hop circuit, and the
  2392. * exit allows it, we use it. */
  2393. int AllowSingleHopCircuits;
  2394. /** If true, we convert "www.google.com.foo.exit" addresses on the
  2395. * socks/trans/natd ports into "www.google.com" addresses that
  2396. * exit from the node "foo". Disabled by default since attacking
  2397. * websites and exit relays can use it to manipulate your path
  2398. * selection. */
  2399. int AllowDotExit;
  2400. /** If true, we will warn if a user gives us only an IP address
  2401. * instead of a hostname. */
  2402. int WarnUnsafeSocks;
  2403. /** If true, the user wants us to collect statistics on clients
  2404. * requesting network statuses from us as directory. */
  2405. int DirReqStatistics;
  2406. /** If true, the user wants us to collect statistics on port usage. */
  2407. int ExitPortStatistics;
  2408. /** If true, the user wants us to collect cell statistics. */
  2409. int CellStatistics;
  2410. /** If true, the user wants us to collect statistics as entry node. */
  2411. int EntryStatistics;
  2412. /** If true, include statistics file contents in extra-info documents. */
  2413. int ExtraInfoStatistics;
  2414. /** If true, do not believe anybody who tells us that a domain resolves
  2415. * to an internal address, or that an internal address has a PTR mapping.
  2416. * Helps avoid some cross-site attacks. */
  2417. int ClientDNSRejectInternalAddresses;
  2418. /** The length of time that we think a consensus should be fresh. */
  2419. int V3AuthVotingInterval;
  2420. /** The length of time we think it will take to distribute votes. */
  2421. int V3AuthVoteDelay;
  2422. /** The length of time we think it will take to distribute signatures. */
  2423. int V3AuthDistDelay;
  2424. /** The number of intervals we think a consensus should be valid. */
  2425. int V3AuthNIntervalsValid;
  2426. /** Should advertise and sign consensuses with a legacy key, for key
  2427. * migration purposes? */
  2428. int V3AuthUseLegacyKey;
  2429. /** Location of bandwidth measurement file */
  2430. char *V3BandwidthsFile;
  2431. /** Authority only: key=value pairs that we add to our networkstatus
  2432. * consensus vote on the 'params' line. */
  2433. char *ConsensusParams;
  2434. /** The length of time that we think an initial consensus should be fresh.
  2435. * Only altered on testing networks. */
  2436. int TestingV3AuthInitialVotingInterval;
  2437. /** The length of time we think it will take to distribute initial votes.
  2438. * Only altered on testing networks. */
  2439. int TestingV3AuthInitialVoteDelay;
  2440. /** The length of time we think it will take to distribute initial
  2441. * signatures. Only altered on testing networks.*/
  2442. int TestingV3AuthInitialDistDelay;
  2443. /** If an authority has been around for less than this amount of time, it
  2444. * does not believe its reachability information is accurate. Only
  2445. * altered on testing networks. */
  2446. int TestingAuthDirTimeToLearnReachability;
  2447. /** Clients don't download any descriptor this recent, since it will
  2448. * probably not have propagated to enough caches. Only altered on testing
  2449. * networks. */
  2450. int TestingEstimatedDescriptorPropagationTime;
  2451. /** If true, we take part in a testing network. Change the defaults of a
  2452. * couple of other configuration options and allow to change the values
  2453. * of certain configuration options. */
  2454. int TestingTorNetwork;
  2455. /** File to check for a consensus networkstatus, if we don't have one
  2456. * cached. */
  2457. char *FallbackNetworkstatusFile;
  2458. /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
  2459. * count of how many client addresses have contacted us so that we can help
  2460. * the bridge authority guess which countries have blocked access to us. */
  2461. int BridgeRecordUsageByCountry;
  2462. /** Optionally, a file with GeoIP data. */
  2463. char *GeoIPFile;
  2464. /** If true, SIGHUP should reload the torrc. Sometimes controllers want
  2465. * to make this false. */
  2466. int ReloadTorrcOnSIGHUP;
  2467. /* The main parameter for picking circuits within a connection.
  2468. *
  2469. * If this value is positive, when picking a cell to relay on a connection,
  2470. * we always relay from the circuit whose weighted cell count is lowest.
  2471. * Cells are weighted exponentially such that if one cell is sent
  2472. * 'CircuitPriorityHalflife' seconds before another, it counts for half as
  2473. * much.
  2474. *
  2475. * If this value is zero, we're disabling the cell-EWMA algorithm.
  2476. *
  2477. * If this value is negative, we're using the default approach
  2478. * according to either Tor or a parameter set in the consensus.
  2479. */
  2480. double CircuitPriorityHalflife;
  2481. } or_options_t;
  2482. /** Persistent state for an onion router, as saved to disk. */
  2483. typedef struct {
  2484. uint32_t _magic;
  2485. /** The time at which we next plan to write the state to the disk. Equal to
  2486. * TIME_MAX if there are no savable changes, 0 if there are changes that
  2487. * should be saved right away. */
  2488. time_t next_write;
  2489. /** When was the state last written to disk? */
  2490. time_t LastWritten;
  2491. /** Fields for accounting bandwidth use. */
  2492. time_t AccountingIntervalStart;
  2493. uint64_t AccountingBytesReadInInterval;
  2494. uint64_t AccountingBytesWrittenInInterval;
  2495. int AccountingSecondsActive;
  2496. int AccountingSecondsToReachSoftLimit;
  2497. time_t AccountingSoftLimitHitAt;
  2498. uint64_t AccountingBytesAtSoftLimit;
  2499. uint64_t AccountingExpectedUsage;
  2500. /** A list of Entry Guard-related configuration lines. */
  2501. config_line_t *EntryGuards;
  2502. /** These fields hold information on the history of bandwidth usage for
  2503. * servers. The "Ends" fields hold the time when we last updated the
  2504. * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
  2505. * of the entries of Values. The "Values" lists hold decimal string
  2506. * representations of the number of bytes read or written in each
  2507. * interval. */
  2508. time_t BWHistoryReadEnds;
  2509. int BWHistoryReadInterval;
  2510. smartlist_t *BWHistoryReadValues;
  2511. time_t BWHistoryWriteEnds;
  2512. int BWHistoryWriteInterval;
  2513. smartlist_t *BWHistoryWriteValues;
  2514. time_t BWHistoryDirReadEnds;
  2515. int BWHistoryDirReadInterval;
  2516. smartlist_t *BWHistoryDirReadValues;
  2517. time_t BWHistoryDirWriteEnds;
  2518. int BWHistoryDirWriteInterval;
  2519. smartlist_t *BWHistoryDirWriteValues;
  2520. /** Build time histogram */
  2521. config_line_t * BuildtimeHistogram;
  2522. unsigned int TotalBuildTimes;
  2523. unsigned int CircuitBuildAbandonedCount;
  2524. /** What version of Tor wrote this state file? */
  2525. char *TorVersion;
  2526. /** Holds any unrecognized values we found in the state file, in the order
  2527. * in which we found them. */
  2528. config_line_t *ExtraLines;
  2529. /** When did we last rotate our onion key? "0" for 'no idea'. */
  2530. time_t LastRotatedOnionKey;
  2531. } or_state_t;
  2532. /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
  2533. * state is already scheduled to be written to disk earlier than <b>when</b>.
  2534. */
  2535. static INLINE void or_state_mark_dirty(or_state_t *state, time_t when)
  2536. {
  2537. if (state->next_write > when)
  2538. state->next_write = when;
  2539. }
  2540. #define MAX_SOCKS_REPLY_LEN 1024
  2541. #define MAX_SOCKS_ADDR_LEN 256
  2542. /** Please open a TCP connection to this addr:port. */
  2543. #define SOCKS_COMMAND_CONNECT 0x01
  2544. /** Please turn this FQDN into an IP address, privately. */
  2545. #define SOCKS_COMMAND_RESOLVE 0xF0
  2546. /** Please turn this IP address into an FQDN, privately. */
  2547. #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
  2548. #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
  2549. #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
  2550. (c)==SOCKS_COMMAND_RESOLVE_PTR)
  2551. /** State of a SOCKS request from a user to an OP. Also used to encode other
  2552. * information for non-socks user request (such as those on TransPort and
  2553. * DNSPort) */
  2554. struct socks_request_t {
  2555. /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
  2556. * 0 means that no socks handshake ever took place, and this is just a
  2557. * stub connection (e.g. see connection_ap_make_link()). */
  2558. char socks_version;
  2559. int command; /**< What is this stream's goal? One from the above list. */
  2560. size_t replylen; /**< Length of <b>reply</b>. */
  2561. char reply[MAX_SOCKS_REPLY_LEN]; /**< Write an entry into this string if
  2562. * we want to specify our own socks reply,
  2563. * rather than using the default socks4 or
  2564. * socks5 socks reply. We use this for the
  2565. * two-stage socks5 handshake.
  2566. */
  2567. char address[MAX_SOCKS_ADDR_LEN]; /**< What address did the client ask to
  2568. connect to/resolve? */
  2569. uint16_t port; /**< What port did the client ask to connect to? */
  2570. unsigned int has_finished : 1; /**< Has the SOCKS handshake finished? Used to
  2571. * make sure we send back a socks reply for
  2572. * every connection. */
  2573. };
  2574. /* all the function prototypes go here */
  2575. /********************************* circuitbuild.c **********************/
  2576. /** How many hops does a general-purpose circuit have by default? */
  2577. #define DEFAULT_ROUTE_LEN 3
  2578. /* Circuit Build Timeout "public" structures. */
  2579. /** Total size of the circuit timeout history to accumulate.
  2580. * 1000 is approx 2.5 days worth of continual-use circuits. */
  2581. #define CBT_NCIRCUITS_TO_OBSERVE 1000
  2582. /** Width of the histogram bins in milliseconds */
  2583. #define CBT_BIN_WIDTH ((build_time_t)50)
  2584. /** Number of modes to use in the weighted-avg computation of Xm */
  2585. #define CBT_DEFAULT_NUM_XM_MODES 3
  2586. /** A build_time_t is milliseconds */
  2587. typedef uint32_t build_time_t;
  2588. /**
  2589. * CBT_BUILD_ABANDONED is our flag value to represent a force-closed
  2590. * circuit (Aka a 'right-censored' pareto value).
  2591. */
  2592. #define CBT_BUILD_ABANDONED ((build_time_t)(INT32_MAX-1))
  2593. #define CBT_BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
  2594. /** Save state every 10 circuits */
  2595. #define CBT_SAVE_STATE_EVERY 10
  2596. /* Circuit build times consensus parameters */
  2597. /**
  2598. * How long to wait before actually closing circuits that take too long to
  2599. * build in terms of CDF quantile.
  2600. */
  2601. #define CBT_DEFAULT_CLOSE_QUANTILE 95
  2602. /**
  2603. * How many circuits count as recent when considering if the
  2604. * connection has gone gimpy or changed.
  2605. */
  2606. #define CBT_DEFAULT_RECENT_CIRCUITS 20
  2607. /**
  2608. * Maximum count of timeouts that finish the first hop in the past
  2609. * RECENT_CIRCUITS before calculating a new timeout.
  2610. *
  2611. * This tells us whether to abandon timeout history and set
  2612. * the timeout back to whatever circuit_build_times_get_initial_timeout()
  2613. * gives us.
  2614. */
  2615. #define CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT (CBT_DEFAULT_RECENT_CIRCUITS*9/10)
  2616. /** Minimum circuits before estimating a timeout */
  2617. #define CBT_DEFAULT_MIN_CIRCUITS_TO_OBSERVE 100
  2618. /** Cutoff percentile on the CDF for our timeout estimation. */
  2619. #define CBT_DEFAULT_QUANTILE_CUTOFF 80
  2620. double circuit_build_times_quantile_cutoff(void);
  2621. /** How often in seconds should we build a test circuit */
  2622. #define CBT_DEFAULT_TEST_FREQUENCY 60
  2623. /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
  2624. #define CBT_DEFAULT_TIMEOUT_MIN_VALUE (1500)
  2625. /** Initial circuit build timeout in milliseconds */
  2626. #define CBT_DEFAULT_TIMEOUT_INITIAL_VALUE (60*1000)
  2627. int32_t circuit_build_times_initial_timeout(void);
  2628. #if CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT < 1
  2629. #error "RECENT_CIRCUITS is set too low."
  2630. #endif
  2631. /** Information about the state of our local network connection */
  2632. typedef struct {
  2633. /** The timestamp we last completed a TLS handshake or received a cell */
  2634. time_t network_last_live;
  2635. /** If the network is not live, how many timeouts has this caused? */
  2636. int nonlive_timeouts;
  2637. /** Circular array of circuits that have made it to the first hop. Slot is
  2638. * 1 if circuit timed out, 0 if circuit succeeded */
  2639. int8_t *timeouts_after_firsthop;
  2640. /** Number of elements allocated for the above array */
  2641. int num_recent_circs;
  2642. /** Index into circular array. */
  2643. int after_firsthop_idx;
  2644. } network_liveness_t;
  2645. /** Structure for circuit build times history */
  2646. typedef struct {
  2647. /** The circular array of recorded build times in milliseconds */
  2648. build_time_t circuit_build_times[CBT_NCIRCUITS_TO_OBSERVE];
  2649. /** Current index in the circuit_build_times circular array */
  2650. int build_times_idx;
  2651. /** Total number of build times accumulated. Max CBT_NCIRCUITS_TO_OBSERVE */
  2652. int total_build_times;
  2653. /** Information about the state of our local network connection */
  2654. network_liveness_t liveness;
  2655. /** Last time we built a circuit. Used to decide to build new test circs */
  2656. time_t last_circ_at;
  2657. /** "Minimum" value of our pareto distribution (actually mode) */
  2658. build_time_t Xm;
  2659. /** alpha exponent for pareto dist. */
  2660. double alpha;
  2661. /** Have we computed a timeout? */
  2662. int have_computed_timeout;
  2663. /** The exact value for that timeout in milliseconds. Stored as a double
  2664. * to maintain precision from calculations to and from quantile value. */
  2665. double timeout_ms;
  2666. /** How long we wait before actually closing the circuit. */
  2667. double close_ms;
  2668. } circuit_build_times_t;
  2669. /********************************* config.c ***************************/
  2670. /** An error from options_trial_assign() or options_init_from_string(). */
  2671. typedef enum setopt_err_t {
  2672. SETOPT_OK = 0,
  2673. SETOPT_ERR_MISC = -1,
  2674. SETOPT_ERR_PARSE = -2,
  2675. SETOPT_ERR_TRANSITION = -3,
  2676. SETOPT_ERR_SETTING = -4,
  2677. } setopt_err_t;
  2678. /********************************* connection_edge.c *************************/
  2679. /** Enumerates possible origins of a client-side address mapping. */
  2680. typedef enum {
  2681. /** We're remapping this address because the controller told us to. */
  2682. ADDRMAPSRC_CONTROLLER,
  2683. /** We're remapping this address because our configuration (via torrc, the
  2684. * command line, or a SETCONF command) told us to. */
  2685. ADDRMAPSRC_TORRC,
  2686. /** We're remapping this address because we have TrackHostExit configured,
  2687. * and we want to remember to use the same exit next time. */
  2688. ADDRMAPSRC_TRACKEXIT,
  2689. /** We're remapping this address because we got a DNS resolution from a
  2690. * Tor server that told us what its value was. */
  2691. ADDRMAPSRC_DNS,
  2692. } addressmap_entry_source_t;
  2693. /********************************* control.c ***************************/
  2694. /** Used to indicate the type of a circuit event passed to the controller.
  2695. * The various types are defined in control-spec.txt */
  2696. typedef enum circuit_status_event_t {
  2697. CIRC_EVENT_LAUNCHED = 0,
  2698. CIRC_EVENT_BUILT = 1,
  2699. CIRC_EVENT_EXTENDED = 2,
  2700. CIRC_EVENT_FAILED = 3,
  2701. CIRC_EVENT_CLOSED = 4,
  2702. } circuit_status_event_t;
  2703. /** Used to indicate the type of a stream event passed to the controller.
  2704. * The various types are defined in control-spec.txt */
  2705. typedef enum stream_status_event_t {
  2706. STREAM_EVENT_SENT_CONNECT = 0,
  2707. STREAM_EVENT_SENT_RESOLVE = 1,
  2708. STREAM_EVENT_SUCCEEDED = 2,
  2709. STREAM_EVENT_FAILED = 3,
  2710. STREAM_EVENT_CLOSED = 4,
  2711. STREAM_EVENT_NEW = 5,
  2712. STREAM_EVENT_NEW_RESOLVE = 6,
  2713. STREAM_EVENT_FAILED_RETRIABLE = 7,
  2714. STREAM_EVENT_REMAP = 8
  2715. } stream_status_event_t;
  2716. /** Used to indicate the type of an OR connection event passed to the
  2717. * controller. The various types are defined in control-spec.txt */
  2718. typedef enum or_conn_status_event_t {
  2719. OR_CONN_EVENT_LAUNCHED = 0,
  2720. OR_CONN_EVENT_CONNECTED = 1,
  2721. OR_CONN_EVENT_FAILED = 2,
  2722. OR_CONN_EVENT_CLOSED = 3,
  2723. OR_CONN_EVENT_NEW = 4,
  2724. } or_conn_status_event_t;
  2725. /** Used to indicate the type of a buildtime event */
  2726. typedef enum buildtimeout_set_event_t {
  2727. BUILDTIMEOUT_SET_EVENT_COMPUTED = 0,
  2728. BUILDTIMEOUT_SET_EVENT_RESET = 1,
  2729. BUILDTIMEOUT_SET_EVENT_SUSPENDED = 2,
  2730. BUILDTIMEOUT_SET_EVENT_DISCARD = 3,
  2731. BUILDTIMEOUT_SET_EVENT_RESUME = 4
  2732. } buildtimeout_set_event_t;
  2733. /** Execute the statement <b>stmt</b>, which may log events concerning the
  2734. * connection <b>conn</b>. To prevent infinite loops, disable log messages
  2735. * being sent to controllers if <b>conn</b> is a control connection.
  2736. *
  2737. * Stmt must not contain any return or goto statements.
  2738. */
  2739. #define CONN_LOG_PROTECT(conn, stmt) \
  2740. STMT_BEGIN \
  2741. int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
  2742. if (_log_conn_is_control) \
  2743. disable_control_logging(); \
  2744. STMT_BEGIN stmt; STMT_END; \
  2745. if (_log_conn_is_control) \
  2746. enable_control_logging(); \
  2747. STMT_END
  2748. /** Enum describing various stages of bootstrapping, for use with controller
  2749. * bootstrap status events. The values range from 0 to 100. */
  2750. typedef enum {
  2751. BOOTSTRAP_STATUS_UNDEF=-1,
  2752. BOOTSTRAP_STATUS_STARTING=0,
  2753. BOOTSTRAP_STATUS_CONN_DIR=5,
  2754. BOOTSTRAP_STATUS_HANDSHAKE=-2,
  2755. BOOTSTRAP_STATUS_HANDSHAKE_DIR=10,
  2756. BOOTSTRAP_STATUS_ONEHOP_CREATE=15,
  2757. BOOTSTRAP_STATUS_REQUESTING_STATUS=20,
  2758. BOOTSTRAP_STATUS_LOADING_STATUS=25,
  2759. BOOTSTRAP_STATUS_LOADING_KEYS=40,
  2760. BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS=45,
  2761. BOOTSTRAP_STATUS_LOADING_DESCRIPTORS=50,
  2762. BOOTSTRAP_STATUS_CONN_OR=80,
  2763. BOOTSTRAP_STATUS_HANDSHAKE_OR=85,
  2764. BOOTSTRAP_STATUS_CIRCUIT_CREATE=90,
  2765. BOOTSTRAP_STATUS_DONE=100
  2766. } bootstrap_status_t;
  2767. /********************************* directory.c ***************************/
  2768. /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
  2769. typedef struct {
  2770. char first[DIGEST_LEN];
  2771. char second[DIGEST_LEN];
  2772. } fp_pair_t;
  2773. /********************************* dirserv.c ***************************/
  2774. typedef enum {
  2775. NS_V2, NS_V3_CONSENSUS, NS_V3_VOTE, NS_CONTROL_PORT,
  2776. NS_V3_CONSENSUS_MICRODESC
  2777. } routerstatus_format_type_t;
  2778. #ifdef DIRSERV_PRIVATE
  2779. typedef struct measured_bw_line_t {
  2780. char node_id[DIGEST_LEN];
  2781. char node_hex[MAX_HEX_NICKNAME_LEN+1];
  2782. long int bw;
  2783. } measured_bw_line_t;
  2784. #endif
  2785. /********************************* dirvote.c ************************/
  2786. /** Describes the schedule by which votes should be generated. */
  2787. typedef struct vote_timing_t {
  2788. int vote_interval;
  2789. int n_intervals_valid;
  2790. int vote_delay;
  2791. int dist_delay;
  2792. } vote_timing_t;
  2793. /********************************* geoip.c **************************/
  2794. /** Round all GeoIP results to the next multiple of this value, to avoid
  2795. * leaking information. */
  2796. #define DIR_RECORD_USAGE_GRANULARITY 8
  2797. /** Time interval: Flush geoip data to disk this often. */
  2798. #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
  2799. /** How long do we have to have observed per-country request history before
  2800. * we are willing to talk about it? */
  2801. #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
  2802. /** Indicates an action that we might be noting geoip statistics on.
  2803. * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
  2804. * the others, we're not.
  2805. */
  2806. typedef enum {
  2807. /** We've noticed a connection as a bridge relay or entry guard. */
  2808. GEOIP_CLIENT_CONNECT = 0,
  2809. /** We've served a networkstatus consensus as a directory server. */
  2810. GEOIP_CLIENT_NETWORKSTATUS = 1,
  2811. /** We've served a v2 networkstatus consensus as a directory server. */
  2812. GEOIP_CLIENT_NETWORKSTATUS_V2 = 2,
  2813. } geoip_client_action_t;
  2814. /** Indicates either a positive reply or a reason for rejectng a network
  2815. * status request that will be included in geoip statistics. */
  2816. typedef enum {
  2817. /** Request is answered successfully. */
  2818. GEOIP_SUCCESS = 0,
  2819. /** V3 network status is not signed by a sufficient number of requested
  2820. * authorities. */
  2821. GEOIP_REJECT_NOT_ENOUGH_SIGS = 1,
  2822. /** Requested network status object is unavailable. */
  2823. GEOIP_REJECT_UNAVAILABLE = 2,
  2824. /** Requested network status not found. */
  2825. GEOIP_REJECT_NOT_FOUND = 3,
  2826. /** Network status has not been modified since If-Modified-Since time. */
  2827. GEOIP_REJECT_NOT_MODIFIED = 4,
  2828. /** Directory is busy. */
  2829. GEOIP_REJECT_BUSY = 5,
  2830. } geoip_ns_response_t;
  2831. #define GEOIP_NS_RESPONSE_NUM 6
  2832. /** Directory requests that we are measuring can be either direct or
  2833. * tunneled. */
  2834. typedef enum {
  2835. DIRREQ_DIRECT = 0,
  2836. DIRREQ_TUNNELED = 1,
  2837. } dirreq_type_t;
  2838. /** Possible states for either direct or tunneled directory requests that
  2839. * are relevant for determining network status download times. */
  2840. typedef enum {
  2841. /** Found that the client requests a network status; applies to both
  2842. * direct and tunneled requests; initial state of a request that we are
  2843. * measuring. */
  2844. DIRREQ_IS_FOR_NETWORK_STATUS = 0,
  2845. /** Finished writing a network status to the directory connection;
  2846. * applies to both direct and tunneled requests; completes a direct
  2847. * request. */
  2848. DIRREQ_FLUSHING_DIR_CONN_FINISHED = 1,
  2849. /** END cell sent to circuit that initiated a tunneled request. */
  2850. DIRREQ_END_CELL_SENT = 2,
  2851. /** Flushed last cell from queue of the circuit that initiated a
  2852. * tunneled request to the outbuf of the OR connection. */
  2853. DIRREQ_CIRC_QUEUE_FLUSHED = 3,
  2854. /** Flushed last byte from buffer of the OR connection belonging to the
  2855. * circuit that initiated a tunneled request; completes a tunneled
  2856. * request. */
  2857. DIRREQ_OR_CONN_BUFFER_FLUSHED = 4
  2858. } dirreq_state_t;
  2859. #define WRITE_STATS_INTERVAL (24*60*60)
  2860. /********************************* microdesc.c *************************/
  2861. typedef struct microdesc_cache_t microdesc_cache_t;
  2862. /********************************* networkstatus.c *********************/
  2863. /** Location where we found a v2 networkstatus. */
  2864. typedef enum {
  2865. NS_FROM_CACHE, NS_FROM_DIR_BY_FP, NS_FROM_DIR_ALL, NS_GENERATED
  2866. } v2_networkstatus_source_t;
  2867. /** Possible statuses of a version of Tor, given opinions from the directory
  2868. * servers. */
  2869. typedef enum version_status_t {
  2870. VS_RECOMMENDED=0, /**< This version is listed as recommended. */
  2871. VS_OLD=1, /**< This version is older than any recommended version. */
  2872. VS_NEW=2, /**< This version is newer than any recommended version. */
  2873. VS_NEW_IN_SERIES=3, /**< This version is newer than any recommended version
  2874. * in its series, but later recommended versions exist.
  2875. */
  2876. VS_UNRECOMMENDED=4, /**< This version is not recommended (general case). */
  2877. VS_EMPTY=5, /**< The version list was empty; no agreed-on versions. */
  2878. VS_UNKNOWN, /**< We have no idea. */
  2879. } version_status_t;
  2880. /********************************* policies.c ************************/
  2881. /** Outcome of applying an address policy to an address. */
  2882. typedef enum {
  2883. /** The address was accepted */
  2884. ADDR_POLICY_ACCEPTED=0,
  2885. /** The address was rejected */
  2886. ADDR_POLICY_REJECTED=-1,
  2887. /** Part of the address was unknown, but as far as we can tell, it was
  2888. * accepted. */
  2889. ADDR_POLICY_PROBABLY_ACCEPTED=1,
  2890. /** Part of the address was unknown, but as far as we can tell, it was
  2891. * rejected. */
  2892. ADDR_POLICY_PROBABLY_REJECTED=2
  2893. } addr_policy_result_t;
  2894. /********************************* rephist.c ***************************/
  2895. /** Possible public/private key operations in Tor: used to keep track of where
  2896. * we're spending our time. */
  2897. typedef enum {
  2898. SIGN_DIR, SIGN_RTR,
  2899. VERIFY_DIR, VERIFY_RTR,
  2900. ENC_ONIONSKIN, DEC_ONIONSKIN,
  2901. TLS_HANDSHAKE_C, TLS_HANDSHAKE_S,
  2902. REND_CLIENT, REND_MID, REND_SERVER,
  2903. } pk_op_t;
  2904. /********************************* rendcommon.c ***************************/
  2905. /** Hidden-service side configuration of client authorization. */
  2906. typedef struct rend_authorized_client_t {
  2907. char *client_name;
  2908. char descriptor_cookie[REND_DESC_COOKIE_LEN];
  2909. crypto_pk_env_t *client_key;
  2910. } rend_authorized_client_t;
  2911. /** ASCII-encoded v2 hidden service descriptor. */
  2912. typedef struct rend_encoded_v2_service_descriptor_t {
  2913. char desc_id[DIGEST_LEN]; /**< Descriptor ID. */
  2914. char *desc_str; /**< Descriptor string. */
  2915. } rend_encoded_v2_service_descriptor_t;
  2916. /** Introduction point information. */
  2917. typedef struct rend_intro_point_t {
  2918. extend_info_t *extend_info; /**< Extend info of this introduction point. */
  2919. crypto_pk_env_t *intro_key; /**< Introduction key that replaces the service
  2920. * key, if this descriptor is V2. */
  2921. } rend_intro_point_t;
  2922. /** Information used to connect to a hidden service. */
  2923. typedef struct rend_service_descriptor_t {
  2924. crypto_pk_env_t *pk; /**< This service's public key. */
  2925. int version; /**< Version of the descriptor format: 0 or 2. */
  2926. time_t timestamp; /**< Time when the descriptor was generated. */
  2927. uint16_t protocols; /**< Bitmask: which rendezvous protocols are supported?
  2928. * (We allow bits '0', '1', and '2' to be set.) */
  2929. /** List of the service's introduction points. Elements are removed if
  2930. * introduction attempts fail. */
  2931. smartlist_t *intro_nodes;
  2932. /** Has descriptor been uploaded to all hidden service directories? */
  2933. int all_uploads_performed;
  2934. /** List of hidden service directories to which an upload request for
  2935. * this descriptor could be sent. Smartlist exists only when at least one
  2936. * of the previous upload requests failed (otherwise it's not important
  2937. * to know which uploads succeeded and which not). */
  2938. smartlist_t *successful_uploads;
  2939. } rend_service_descriptor_t;
  2940. /** A cached rendezvous descriptor. */
  2941. typedef struct rend_cache_entry_t {
  2942. size_t len; /**< Length of <b>desc</b> */
  2943. time_t received; /**< When was the descriptor received? */
  2944. char *desc; /**< Service descriptor */
  2945. rend_service_descriptor_t *parsed; /**< Parsed value of 'desc' */
  2946. } rend_cache_entry_t;
  2947. /********************************* routerlist.c ***************************/
  2948. /** Represents information about a single trusted directory server. */
  2949. typedef struct trusted_dir_server_t {
  2950. char *description;
  2951. char *nickname;
  2952. char *address; /**< Hostname. */
  2953. uint32_t addr; /**< IPv4 address. */
  2954. uint16_t dir_port; /**< Directory port. */
  2955. uint16_t or_port; /**< OR port: Used for tunneling connections. */
  2956. char digest[DIGEST_LEN]; /**< Digest of identity key. */
  2957. char v3_identity_digest[DIGEST_LEN]; /**< Digest of v3 (authority only,
  2958. * high-security) identity key. */
  2959. unsigned int is_running:1; /**< True iff we think this server is running. */
  2960. /** True iff this server has accepted the most recent server descriptor
  2961. * we tried to upload to it. */
  2962. unsigned int has_accepted_serverdesc:1;
  2963. /** What kind of authority is this? (Bitfield.) */
  2964. authority_type_t type;
  2965. download_status_t v2_ns_dl_status; /**< Status of downloading this server's
  2966. * v2 network status. */
  2967. time_t addr_current_at; /**< When was the document that we derived the
  2968. * address information from published? */
  2969. routerstatus_t fake_status; /**< Used when we need to pass this trusted
  2970. * dir_server_t to directory_initiate_command_*
  2971. * as a routerstatus_t. Not updated by the
  2972. * router-status management code!
  2973. **/
  2974. } trusted_dir_server_t;
  2975. #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
  2976. #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
  2977. /* Flags for pick_directory_server and pick_trusteddirserver. */
  2978. /** Flag to indicate that we should not automatically be willing to use
  2979. * ourself to answer a directory request.
  2980. * Passed to router_pick_directory_server (et al).*/
  2981. #define PDS_ALLOW_SELF (1<<0)
  2982. /** Flag to indicate that if no servers seem to be up, we should mark all
  2983. * directory servers as up and try again.
  2984. * Passed to router_pick_directory_server (et al).*/
  2985. #define PDS_RETRY_IF_NO_SERVERS (1<<1)
  2986. /** Flag to indicate that we should not exclude directory servers that
  2987. * our ReachableAddress settings would exclude. This usually means that
  2988. * we're going to connect to the server over Tor, and so we don't need to
  2989. * worry about our firewall telling us we can't.
  2990. * Passed to router_pick_directory_server (et al).*/
  2991. #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
  2992. /** Flag to indicate that we should not use any directory authority to which
  2993. * we have an existing directory connection for downloading server descriptors
  2994. * or extrainfo documents.
  2995. *
  2996. * Passed to router_pick_directory_server (et al)
  2997. *
  2998. * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
  2999. * not pick_directory_server. If we make it work on pick_directory_server
  3000. * too, we could conservatively make it only prevent multiple fetches to
  3001. * the same authority, or we could aggressively make it prevent multiple
  3002. * fetches to _any_ single directory server.]
  3003. */
  3004. #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
  3005. #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
  3006. /** Possible ways to weight routers when choosing one randomly. See
  3007. * routerlist_sl_choose_by_bandwidth() for more information.*/
  3008. typedef enum bandwidth_weight_rule_t {
  3009. NO_WEIGHTING, WEIGHT_FOR_EXIT, WEIGHT_FOR_MID, WEIGHT_FOR_GUARD,
  3010. WEIGHT_FOR_DIR
  3011. } bandwidth_weight_rule_t;
  3012. /** Flags to be passed to control router_choose_random_node() to indicate what
  3013. * kind of nodes to pick according to what algorithm. */
  3014. typedef enum {
  3015. CRN_NEED_UPTIME = 1<<0,
  3016. CRN_NEED_CAPACITY = 1<<1,
  3017. CRN_NEED_GUARD = 1<<2,
  3018. CRN_ALLOW_INVALID = 1<<3,
  3019. /* XXXX not used, apparently. */
  3020. CRN_WEIGHT_AS_EXIT = 1<<5
  3021. } router_crn_flags_t;
  3022. /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
  3023. typedef enum was_router_added_t {
  3024. ROUTER_ADDED_SUCCESSFULLY = 1,
  3025. ROUTER_ADDED_NOTIFY_GENERATOR = 0,
  3026. ROUTER_BAD_EI = -1,
  3027. ROUTER_WAS_NOT_NEW = -2,
  3028. ROUTER_NOT_IN_CONSENSUS = -3,
  3029. ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS = -4,
  3030. ROUTER_AUTHDIR_REJECTS = -5,
  3031. } was_router_added_t;
  3032. /********************************* routerparse.c ************************/
  3033. #define MAX_STATUS_TAG_LEN 32
  3034. /** Structure to hold parsed Tor versions. This is a little messier
  3035. * than we would like it to be, because we changed version schemes with 0.1.0.
  3036. *
  3037. * See version-spec.txt for the whole business.
  3038. */
  3039. typedef struct tor_version_t {
  3040. int major;
  3041. int minor;
  3042. int micro;
  3043. /** Release status. For version in the post-0.1 format, this is always
  3044. * VER_RELEASE. */
  3045. enum { VER_PRE=0, VER_RC=1, VER_RELEASE=2, } status;
  3046. int patchlevel;
  3047. char status_tag[MAX_STATUS_TAG_LEN];
  3048. int svn_revision;
  3049. int git_tag_len;
  3050. char git_tag[DIGEST_LEN];
  3051. } tor_version_t;
  3052. #endif