or.h 147 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517
  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-2010, 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. char 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. char 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, etc.
  932. */
  933. unsigned int is_bad_for_new_circs:1;
  934. uint8_t link_proto; /**< What protocol version are we using? 0 for
  935. * "none negotiated yet." */
  936. circid_t next_circ_id; /**< Which circ_id do we try to use next on
  937. * this connection? This is always in the
  938. * range 0..1<<15-1. */
  939. or_handshake_state_t *handshake_state; /**< If we are setting this connection
  940. * up, state information to do so. */
  941. time_t timestamp_lastempty; /**< When was the outbuf last completely empty?*/
  942. time_t timestamp_last_added_nonpadding; /** When did we last add a
  943. * non-padding cell to the outbuf? */
  944. /* bandwidth* and *_bucket only used by ORs in OPEN state: */
  945. int bandwidthrate; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
  946. int bandwidthburst; /**< Max bucket size for this conn. (OPEN ORs only.) */
  947. int read_bucket; /**< When this hits 0, stop receiving. Every second we
  948. * add 'bandwidthrate' to this, capping it at
  949. * bandwidthburst. (OPEN ORs only) */
  950. int write_bucket; /**< When this hits 0, stop writing. Like read_bucket. */
  951. int n_circuits; /**< How many circuits use this connection as p_conn or
  952. * n_conn ? */
  953. /** Double-linked ring of circuits with queued cells waiting for room to
  954. * free up on this connection's outbuf. Every time we pull cells from a
  955. * circuit, we advance this pointer to the next circuit in the ring. */
  956. struct circuit_t *active_circuits;
  957. /** Priority queue of cell_ewma_t for circuits with queued cells waiting for
  958. * room to free up on this connection's outbuf. Kept in heap order
  959. * according to EWMA.
  960. *
  961. * This is redundant with active_circuits; if we ever decide only to use the
  962. * cell_ewma algorithm for choosing circuits, we can remove active_circuits.
  963. */
  964. smartlist_t *active_circuit_pqueue;
  965. /** The tick on which the cell_ewma_ts in active_circuit_pqueue last had
  966. * their ewma values rescaled. */
  967. unsigned active_circuit_pqueue_last_recalibrated;
  968. struct or_connection_t *next_with_same_id; /**< Next connection with same
  969. * identity digest as this one. */
  970. } or_connection_t;
  971. /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
  972. * connection, or an exit. */
  973. typedef struct edge_connection_t {
  974. connection_t _base;
  975. struct edge_connection_t *next_stream; /**< Points to the next stream at this
  976. * edge, if any */
  977. struct crypt_path_t *cpath_layer; /**< A pointer to which node in the circ
  978. * this conn exits at. */
  979. int package_window; /**< How many more relay cells can I send into the
  980. * circuit? */
  981. int deliver_window; /**< How many more relay cells can end at me? */
  982. /** Nickname of planned exit node -- used with .exit support. */
  983. char *chosen_exit_name;
  984. socks_request_t *socks_request; /**< SOCKS structure describing request (AP
  985. * only.) */
  986. struct circuit_t *on_circuit; /**< The circuit (if any) that this edge
  987. * connection is using. */
  988. uint32_t address_ttl; /**< TTL for address-to-addr mapping on exit
  989. * connection. Exit connections only. */
  990. streamid_t stream_id; /**< The stream ID used for this edge connection on its
  991. * circuit */
  992. /** The reason why this connection is closing; passed to the controller. */
  993. uint16_t end_reason;
  994. /** Bytes read since last call to control_event_stream_bandwidth_used() */
  995. uint32_t n_read;
  996. /** Bytes written since last call to control_event_stream_bandwidth_used() */
  997. uint32_t n_written;
  998. /** What rendezvous service are we querying for? (AP only) */
  999. rend_data_t *rend_data;
  1000. /** Number of times we've reassigned this application connection to
  1001. * a new circuit. We keep track because the timeout is longer if we've
  1002. * already retried several times. */
  1003. uint8_t num_socks_retries;
  1004. /** True iff this connection is for a DNS request only. */
  1005. unsigned int is_dns_request:1;
  1006. /** True iff this stream must attach to a one-hop circuit (e.g. for
  1007. * begin_dir). */
  1008. unsigned int want_onehop:1;
  1009. /** True iff this stream should use a BEGIN_DIR relay command to establish
  1010. * itself rather than BEGIN (either via onehop or via a whole circuit). */
  1011. unsigned int use_begindir:1;
  1012. unsigned int edge_has_sent_end:1; /**< For debugging; only used on edge
  1013. * connections. Set once we've set the stream end,
  1014. * and check in connection_about_to_close_connection().
  1015. */
  1016. /** True iff we've blocked reading until the circuit has fewer queued
  1017. * cells. */
  1018. unsigned int edge_blocked_on_circ:1;
  1019. /** For AP connections only. If 1, and we fail to reach the chosen exit,
  1020. * stop requiring it. */
  1021. unsigned int chosen_exit_optional:1;
  1022. /** For AP connections only. If non-zero, this exit node was picked as
  1023. * a result of the TrackHostExit, and the value decrements every time
  1024. * we fail to complete a circuit to our chosen exit -- if it reaches
  1025. * zero, abandon the associated mapaddress. */
  1026. unsigned int chosen_exit_retries:3;
  1027. /** If this is a DNSPort connection, this field holds the pending DNS
  1028. * request that we're going to try to answer. */
  1029. struct evdns_server_request *dns_server_request;
  1030. } edge_connection_t;
  1031. /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
  1032. * connection to retrieve or serve directory material. */
  1033. typedef struct dir_connection_t {
  1034. connection_t _base;
  1035. char *requested_resource; /**< Which 'resource' did we ask the directory
  1036. * for? */
  1037. unsigned int dirconn_direct:1; /**< Is this dirconn direct, or via Tor? */
  1038. /* Used only for server sides of some dir connections, to implement
  1039. * "spooling" of directory material to the outbuf. Otherwise, we'd have
  1040. * to append everything to the outbuf in one enormous chunk. */
  1041. /** What exactly are we spooling right now? */
  1042. enum {
  1043. DIR_SPOOL_NONE=0, DIR_SPOOL_SERVER_BY_DIGEST, DIR_SPOOL_SERVER_BY_FP,
  1044. DIR_SPOOL_EXTRA_BY_DIGEST, DIR_SPOOL_EXTRA_BY_FP,
  1045. DIR_SPOOL_CACHED_DIR, DIR_SPOOL_NETWORKSTATUS,
  1046. DIR_SPOOL_MICRODESC, /* NOTE: if we add another entry, add another bit. */
  1047. } dir_spool_src : 3;
  1048. /** If we're fetching descriptors, what router purpose shall we assign
  1049. * to them? */
  1050. uint8_t router_purpose;
  1051. /** List of fingerprints for networkstatuses or descriptors to be spooled. */
  1052. smartlist_t *fingerprint_stack;
  1053. /** A cached_dir_t object that we're currently spooling out */
  1054. struct cached_dir_t *cached_dir;
  1055. /** The current offset into cached_dir. */
  1056. off_t cached_dir_offset;
  1057. /** The zlib object doing on-the-fly compression for spooled data. */
  1058. tor_zlib_state_t *zlib_state;
  1059. /** What rendezvous service are we querying for? */
  1060. rend_data_t *rend_data;
  1061. char identity_digest[DIGEST_LEN]; /**< Hash of the public RSA key for
  1062. * the directory server's signing key. */
  1063. } dir_connection_t;
  1064. /** Subtype of connection_t for an connection to a controller. */
  1065. typedef struct control_connection_t {
  1066. connection_t _base;
  1067. uint32_t event_mask; /**< Bitfield: which events does this controller
  1068. * care about? */
  1069. /** True if we have sent a protocolinfo reply on this connection. */
  1070. unsigned int have_sent_protocolinfo:1;
  1071. /** Amount of space allocated in incoming_cmd. */
  1072. uint32_t incoming_cmd_len;
  1073. /** Number of bytes currently stored in incoming_cmd. */
  1074. uint32_t incoming_cmd_cur_len;
  1075. /** A control command that we're reading from the inbuf, but which has not
  1076. * yet arrived completely. */
  1077. char *incoming_cmd;
  1078. } control_connection_t;
  1079. /** Cast a connection_t subtype pointer to a connection_t **/
  1080. #define TO_CONN(c) (&(((c)->_base)))
  1081. /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
  1082. #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
  1083. /** Convert a connection_t* to an or_connection_t*; assert if the cast is
  1084. * invalid. */
  1085. static or_connection_t *TO_OR_CONN(connection_t *);
  1086. /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
  1087. * invalid. */
  1088. static dir_connection_t *TO_DIR_CONN(connection_t *);
  1089. /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
  1090. * invalid. */
  1091. static edge_connection_t *TO_EDGE_CONN(connection_t *);
  1092. /** Convert a connection_t* to an control_connection_t*; assert if the cast is
  1093. * invalid. */
  1094. static control_connection_t *TO_CONTROL_CONN(connection_t *);
  1095. static INLINE or_connection_t *TO_OR_CONN(connection_t *c)
  1096. {
  1097. tor_assert(c->magic == OR_CONNECTION_MAGIC);
  1098. return DOWNCAST(or_connection_t, c);
  1099. }
  1100. static INLINE dir_connection_t *TO_DIR_CONN(connection_t *c)
  1101. {
  1102. tor_assert(c->magic == DIR_CONNECTION_MAGIC);
  1103. return DOWNCAST(dir_connection_t, c);
  1104. }
  1105. static INLINE edge_connection_t *TO_EDGE_CONN(connection_t *c)
  1106. {
  1107. tor_assert(c->magic == EDGE_CONNECTION_MAGIC);
  1108. return DOWNCAST(edge_connection_t, c);
  1109. }
  1110. static INLINE control_connection_t *TO_CONTROL_CONN(connection_t *c)
  1111. {
  1112. tor_assert(c->magic == CONTROL_CONNECTION_MAGIC);
  1113. return DOWNCAST(control_connection_t, c);
  1114. }
  1115. /** What action type does an address policy indicate: accept or reject? */
  1116. typedef enum {
  1117. ADDR_POLICY_ACCEPT=1,
  1118. ADDR_POLICY_REJECT=2,
  1119. } addr_policy_action_t;
  1120. /** A reference-counted address policy rule. */
  1121. typedef struct addr_policy_t {
  1122. int refcnt; /**< Reference count */
  1123. addr_policy_action_t policy_type:2;/**< What to do when the policy matches.*/
  1124. unsigned int is_private:1; /**< True iff this is the pseudo-address,
  1125. * "private". */
  1126. unsigned int is_canonical:1; /**< True iff this policy is the canonical
  1127. * copy (stored in a hash table to avoid
  1128. * duplication of common policies) */
  1129. maskbits_t maskbits; /**< Accept/reject all addresses <b>a</b> such that the
  1130. * first <b>maskbits</b> bits of <b>a</b> match
  1131. * <b>addr</b>. */
  1132. tor_addr_t addr; /**< Base address to accept or reject. */
  1133. uint16_t prt_min; /**< Lowest port number to accept/reject. */
  1134. uint16_t prt_max; /**< Highest port number to accept/reject. */
  1135. } addr_policy_t;
  1136. /** A cached_dir_t represents a cacheable directory object, along with its
  1137. * compressed form. */
  1138. typedef struct cached_dir_t {
  1139. char *dir; /**< Contents of this object, NUL-terminated. */
  1140. char *dir_z; /**< Compressed contents of this object. */
  1141. size_t dir_len; /**< Length of <b>dir</b> (not counting its NUL). */
  1142. size_t dir_z_len; /**< Length of <b>dir_z</b>. */
  1143. time_t published; /**< When was this object published. */
  1144. digests_t digests; /**< Digests of this object (networkstatus only) */
  1145. int refcnt; /**< Reference count for this cached_dir_t. */
  1146. } cached_dir_t;
  1147. /** Enum used to remember where a signed_descriptor_t is stored and how to
  1148. * manage the memory for signed_descriptor_body. */
  1149. typedef enum {
  1150. /** The descriptor isn't stored on disk at all: the copy in memory is
  1151. * canonical; the saved_offset field is meaningless. */
  1152. SAVED_NOWHERE=0,
  1153. /** The descriptor is stored in the cached_routers file: the
  1154. * signed_descriptor_body is meaningless; the signed_descriptor_len and
  1155. * saved_offset are used to index into the mmaped cache file. */
  1156. SAVED_IN_CACHE,
  1157. /** The descriptor is stored in the cached_routers.new file: the
  1158. * signed_descriptor_body and saved_offset fields are both set. */
  1159. /* FFFF (We could also mmap the file and grow the mmap as needed, or
  1160. * lazy-load the descriptor text by using seek and read. We don't, for
  1161. * now.)
  1162. */
  1163. SAVED_IN_JOURNAL
  1164. } saved_location_t;
  1165. /** Enumeration: what kind of download schedule are we using for a given
  1166. * object? */
  1167. typedef enum {
  1168. DL_SCHED_GENERIC = 0,
  1169. DL_SCHED_CONSENSUS = 1,
  1170. DL_SCHED_BRIDGE = 2,
  1171. } download_schedule_t;
  1172. /** Information about our plans for retrying downloads for a downloadable
  1173. * object. */
  1174. typedef struct download_status_t {
  1175. time_t next_attempt_at; /**< When should we try downloading this descriptor
  1176. * again? */
  1177. uint8_t n_download_failures; /**< Number of failures trying to download the
  1178. * most recent descriptor. */
  1179. download_schedule_t schedule : 8;
  1180. } download_status_t;
  1181. /** If n_download_failures is this high, the download can never happen. */
  1182. #define IMPOSSIBLE_TO_DOWNLOAD 255
  1183. /** The max size we expect router descriptor annotations we create to
  1184. * be. We'll accept larger ones if we see them on disk, but we won't
  1185. * create any that are larger than this. */
  1186. #define ROUTER_ANNOTATION_BUF_LEN 256
  1187. /** Information need to cache an onion router's descriptor. */
  1188. typedef struct signed_descriptor_t {
  1189. /** Pointer to the raw server descriptor, preceded by annotations. Not
  1190. * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
  1191. * pointer is null. */
  1192. char *signed_descriptor_body;
  1193. /** Length of the annotations preceding the server descriptor. */
  1194. size_t annotations_len;
  1195. /** Length of the server descriptor. */
  1196. size_t signed_descriptor_len;
  1197. /** Digest of the server descriptor, computed as specified in
  1198. * dir-spec.txt. */
  1199. char signed_descriptor_digest[DIGEST_LEN];
  1200. /** Identity digest of the router. */
  1201. char identity_digest[DIGEST_LEN];
  1202. /** Declared publication time of the descriptor. */
  1203. time_t published_on;
  1204. /** For routerdescs only: digest of the corresponding extrainfo. */
  1205. char extra_info_digest[DIGEST_LEN];
  1206. /** For routerdescs only: Status of downloading the corresponding
  1207. * extrainfo. */
  1208. download_status_t ei_dl_status;
  1209. /** Where is the descriptor saved? */
  1210. saved_location_t saved_location;
  1211. /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
  1212. * this descriptor in the corresponding file. */
  1213. off_t saved_offset;
  1214. /** What position is this descriptor within routerlist->routers or
  1215. * routerlist->old_routers? -1 for none. */
  1216. int routerlist_index;
  1217. /** The valid-until time of the most recent consensus that listed this
  1218. * descriptor, or a bit after the publication time of the most recent v2
  1219. * networkstatus that listed it. 0 for "never listed in a consensus or
  1220. * status, so far as we know." */
  1221. time_t last_listed_as_valid_until;
  1222. #ifdef TRACK_SERVED_TIME
  1223. /** The last time we served anybody this descriptor. Used for internal
  1224. * testing to see whether we're holding on to descriptors too long. */
  1225. time_t last_served_at; /*XXXX remove if not useful. */
  1226. #endif
  1227. /* If true, we do not ever try to save this object in the cache. */
  1228. unsigned int do_not_cache : 1;
  1229. /* If true, this item is meant to represent an extrainfo. */
  1230. unsigned int is_extrainfo : 1;
  1231. /* If true, we got an extrainfo for this item, and the digest was right,
  1232. * but it was incompatible. */
  1233. unsigned int extrainfo_is_bogus : 1;
  1234. /* If true, we are willing to transmit this item unencrypted. */
  1235. unsigned int send_unencrypted : 1;
  1236. } signed_descriptor_t;
  1237. /** A signed integer representing a country code. */
  1238. typedef int16_t country_t;
  1239. /** Information about another onion router in the network. */
  1240. typedef struct {
  1241. signed_descriptor_t cache_info;
  1242. char *address; /**< Location of OR: either a hostname or an IP address. */
  1243. char *nickname; /**< Human-readable OR name. */
  1244. uint32_t addr; /**< IPv4 address of OR, in host order. */
  1245. uint16_t or_port; /**< Port for TLS connections. */
  1246. uint16_t dir_port; /**< Port for HTTP directory connections. */
  1247. crypto_pk_env_t *onion_pkey; /**< Public RSA key for onions. */
  1248. crypto_pk_env_t *identity_pkey; /**< Public RSA key for signing. */
  1249. char *platform; /**< What software/operating system is this OR using? */
  1250. /* link info */
  1251. uint32_t bandwidthrate; /**< How many bytes does this OR add to its token
  1252. * bucket per second? */
  1253. uint32_t bandwidthburst; /**< How large is this OR's token bucket? */
  1254. /** How many bytes/s is this router known to handle? */
  1255. uint32_t bandwidthcapacity;
  1256. smartlist_t *exit_policy; /**< What streams will this OR permit
  1257. * to exit? NULL for 'reject *:*'. */
  1258. long uptime; /**< How many seconds the router claims to have been up */
  1259. smartlist_t *declared_family; /**< Nicknames of router which this router
  1260. * claims are its family. */
  1261. char *contact_info; /**< Declared contact info for this router. */
  1262. unsigned int is_hibernating:1; /**< Whether the router claims to be
  1263. * hibernating */
  1264. unsigned int has_old_dnsworkers:1; /**< Whether the router is using
  1265. * dnsworker code. */
  1266. unsigned int caches_extra_info:1; /**< Whether the router caches and serves
  1267. * extrainfo documents. */
  1268. unsigned int allow_single_hop_exits:1; /**< Whether the router allows
  1269. * single hop exits. */
  1270. /* local info */
  1271. unsigned int is_running:1; /**< As far as we know, is this OR currently
  1272. * running? */
  1273. unsigned int is_valid:1; /**< Has a trusted dirserver validated this OR?
  1274. * (For Authdir: Have we validated this OR?)
  1275. */
  1276. unsigned int is_named:1; /**< Do we believe the nickname that this OR gives
  1277. * us? */
  1278. unsigned int is_fast:1; /** Do we think this is a fast OR? */
  1279. unsigned int is_stable:1; /** Do we think this is a stable OR? */
  1280. unsigned int is_possible_guard:1; /**< Do we think this is an OK guard? */
  1281. unsigned int is_exit:1; /**< Do we think this is an OK exit? */
  1282. unsigned int is_bad_exit:1; /**< Do we think this exit is censored, borked,
  1283. * or otherwise nasty? */
  1284. unsigned int is_bad_directory:1; /**< Do we think this directory is junky,
  1285. * underpowered, or otherwise useless? */
  1286. unsigned int wants_to_be_hs_dir:1; /**< True iff this router claims to be
  1287. * a hidden service directory. */
  1288. unsigned int is_hs_dir:1; /**< True iff this router is a hidden service
  1289. * directory according to the authorities. */
  1290. unsigned int policy_is_reject_star:1; /**< True iff the exit policy for this
  1291. * router rejects everything. */
  1292. /** True if, after we have added this router, we should re-launch
  1293. * tests for it. */
  1294. unsigned int needs_retest_if_added:1;
  1295. /** Tor can use this router for general positions in circuits. */
  1296. #define ROUTER_PURPOSE_GENERAL 0
  1297. /** Tor should avoid using this router for circuit-building. */
  1298. #define ROUTER_PURPOSE_CONTROLLER 1
  1299. /** Tor should use this router only for bridge positions in circuits. */
  1300. #define ROUTER_PURPOSE_BRIDGE 2
  1301. /** Tor should not use this router; it was marked in cached-descriptors with
  1302. * a purpose we didn't recognize. */
  1303. #define ROUTER_PURPOSE_UNKNOWN 255
  1304. uint8_t purpose; /** What positions in a circuit is this router good for? */
  1305. /* The below items are used only by authdirservers for
  1306. * reachability testing. */
  1307. /** When was the last time we could reach this OR? */
  1308. time_t last_reachable;
  1309. /** When did we start testing reachability for this OR? */
  1310. time_t testing_since;
  1311. /** According to the geoip db what country is this router in? */
  1312. country_t country;
  1313. } routerinfo_t;
  1314. /** Information needed to keep and cache a signed extra-info document. */
  1315. typedef struct extrainfo_t {
  1316. signed_descriptor_t cache_info;
  1317. /** The router's nickname. */
  1318. char nickname[MAX_NICKNAME_LEN+1];
  1319. /** True iff we found the right key for this extra-info, verified the
  1320. * signature, and found it to be bad. */
  1321. unsigned int bad_sig : 1;
  1322. /** If present, we didn't have the right key to verify this extra-info,
  1323. * so this is a copy of the signature in the document. */
  1324. char *pending_sig;
  1325. /** Length of pending_sig. */
  1326. size_t pending_sig_len;
  1327. } extrainfo_t;
  1328. /** Contents of a single router entry in a network status object.
  1329. */
  1330. typedef struct routerstatus_t {
  1331. time_t published_on; /**< When was this router published? */
  1332. char nickname[MAX_NICKNAME_LEN+1]; /**< The nickname this router says it
  1333. * has. */
  1334. char identity_digest[DIGEST_LEN]; /**< Digest of the router's identity
  1335. * key. */
  1336. char descriptor_digest[DIGEST_LEN]; /**< Digest of the router's most recent
  1337. * descriptor. */
  1338. uint32_t addr; /**< IPv4 address for this router. */
  1339. uint16_t or_port; /**< OR port for this router. */
  1340. uint16_t dir_port; /**< Directory port for this router. */
  1341. unsigned int is_authority:1; /**< True iff this router is an authority. */
  1342. unsigned int is_exit:1; /**< True iff this router is a good exit. */
  1343. unsigned int is_stable:1; /**< True iff this router stays up a long time. */
  1344. unsigned int is_fast:1; /**< True iff this router has good bandwidth. */
  1345. unsigned int is_running:1; /**< True iff this router is up. */
  1346. unsigned int is_named:1; /**< True iff "nickname" belongs to this router. */
  1347. unsigned int is_unnamed:1; /**< True iff "nickname" belongs to another
  1348. * router. */
  1349. unsigned int is_valid:1; /**< True iff this router isn't invalid. */
  1350. unsigned int is_v2_dir:1; /**< True iff this router can serve directory
  1351. * information with v2 of the directory
  1352. * protocol. (All directory caches cache v1
  1353. * directories.) */
  1354. unsigned int is_possible_guard:1; /**< True iff this router would be a good
  1355. * choice as an entry guard. */
  1356. unsigned int is_bad_exit:1; /**< True iff this node is a bad choice for
  1357. * an exit node. */
  1358. unsigned int is_bad_directory:1; /**< Do we think this directory is junky,
  1359. * underpowered, or otherwise useless? */
  1360. unsigned int is_hs_dir:1; /**< True iff this router is a v2-or-later hidden
  1361. * service directory. */
  1362. /** True iff we know version info for this router. (i.e., a "v" entry was
  1363. * included.) We'll replace all these with a big tor_version_t or a char[]
  1364. * if the number of traits we care about ever becomes incredibly big. */
  1365. unsigned int version_known:1;
  1366. /** True iff this router is a version that supports BEGIN_DIR cells. */
  1367. unsigned int version_supports_begindir:1;
  1368. /** True iff this router is a version that supports conditional consensus
  1369. * downloads (signed by list of authorities). */
  1370. unsigned int version_supports_conditional_consensus:1;
  1371. /** True iff this router is a version that we can post extrainfo docs to. */
  1372. unsigned int version_supports_extrainfo_upload:1;
  1373. /** True iff this router is a version that, if it caches directory info,
  1374. * we can get v3 downloads from. */
  1375. unsigned int version_supports_v3_dir:1;
  1376. unsigned int has_bandwidth:1; /**< The vote/consensus had bw info */
  1377. unsigned int has_exitsummary:1; /**< The vote/consensus had exit summaries */
  1378. unsigned int has_measured_bw:1; /**< The vote/consensus had a measured bw */
  1379. uint32_t measured_bw; /**< Measured bandwidth (capacity) of the router */
  1380. uint32_t bandwidth; /**< Bandwidth (capacity) of the router as reported in
  1381. * the vote/consensus, in kilobytes/sec. */
  1382. char *exitsummary; /**< exit policy summary -
  1383. * XXX weasel: this probably should not stay a string. */
  1384. /* ---- The fields below aren't derived from the networkstatus; they
  1385. * hold local information only. */
  1386. /** True if we, as a directory mirror, want to download the corresponding
  1387. * routerinfo from the authority who gave us this routerstatus. (That is,
  1388. * if we don't have the routerinfo, and if we haven't already tried to get it
  1389. * from this authority.) Applies in v2 networkstatus document only.
  1390. */
  1391. unsigned int need_to_mirror:1;
  1392. unsigned int name_lookup_warned:1; /**< Have we warned the user for referring
  1393. * to this (unnamed) router by nickname?
  1394. */
  1395. time_t last_dir_503_at; /**< When did this router last tell us that it
  1396. * was too busy to serve directory info? */
  1397. download_status_t dl_status;
  1398. } routerstatus_t;
  1399. /** A microdescriptor is the smallest amount of information needed to build a
  1400. * circuit through a router. They are generated by the directory authorities,
  1401. * using information from the uploaded routerinfo documents. They are not
  1402. * self-signed, but are rather authenticated by having their hash in a signed
  1403. * networkstatus document. */
  1404. typedef struct microdesc_t {
  1405. /** Hashtable node, used to look up the microdesc by its digest. */
  1406. HT_ENTRY(microdesc_t) node;
  1407. /* Cache information */
  1408. /** When was this microdescriptor last listed in a consensus document?
  1409. * Once a microdesc has been unlisted long enough, we can drop it.
  1410. */
  1411. time_t last_listed;
  1412. /** Where is this microdescriptor currently stored? */
  1413. saved_location_t saved_location : 3;
  1414. /** If true, do not attempt to cache this microdescriptor on disk. */
  1415. unsigned int no_save : 1;
  1416. /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
  1417. * microdescriptor in the cache. */
  1418. off_t off;
  1419. /* The string containing the microdesc. */
  1420. /** A pointer to the encoded body of the microdescriptor. If the
  1421. * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
  1422. * mmap'd region. Otherwise, it is a malloc'd string. The string might not
  1423. * be NUL-terminated; take the length from <b>bodylen</b>. */
  1424. char *body;
  1425. /** The length of the microdescriptor in <b>body</b>. */
  1426. size_t bodylen;
  1427. /** A SHA256-digest of the microdescriptor. */
  1428. char digest[DIGEST256_LEN];
  1429. /* Fields in the microdescriptor. */
  1430. /** As routerinfo_t.onion_pkey */
  1431. crypto_pk_env_t *onion_pkey;
  1432. /** As routerinfo_t.family */
  1433. smartlist_t *family;
  1434. /** Encoded exit policy summary */
  1435. char *exitsummary; /**< exit policy summary -
  1436. * XXX this probably should not stay a string. */
  1437. } microdesc_t;
  1438. /** How many times will we try to download a router's descriptor before giving
  1439. * up? */
  1440. #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
  1441. /** Contents of a v2 (non-consensus, non-vote) network status object. */
  1442. typedef struct networkstatus_v2_t {
  1443. /** When did we receive the network-status document? */
  1444. time_t received_on;
  1445. /** What was the digest of the document? */
  1446. char networkstatus_digest[DIGEST_LEN];
  1447. /* These fields come from the actual network-status document.*/
  1448. time_t published_on; /**< Declared publication date. */
  1449. char *source_address; /**< Canonical directory server hostname. */
  1450. uint32_t source_addr; /**< Canonical directory server IP. */
  1451. uint16_t source_dirport; /**< Canonical directory server dirport. */
  1452. unsigned int binds_names:1; /**< True iff this directory server binds
  1453. * names. */
  1454. unsigned int recommends_versions:1; /**< True iff this directory server
  1455. * recommends client and server software
  1456. * versions. */
  1457. unsigned int lists_bad_exits:1; /**< True iff this directory server marks
  1458. * malfunctioning exits as bad. */
  1459. /** True iff this directory server marks malfunctioning directories as
  1460. * bad. */
  1461. unsigned int lists_bad_directories:1;
  1462. char identity_digest[DIGEST_LEN]; /**< Digest of signing key. */
  1463. char *contact; /**< How to contact directory admin? (may be NULL). */
  1464. crypto_pk_env_t *signing_key; /**< Key used to sign this directory. */
  1465. char *client_versions; /**< comma-separated list of recommended client
  1466. * versions. */
  1467. char *server_versions; /**< comma-separated list of recommended server
  1468. * versions. */
  1469. smartlist_t *entries; /**< List of routerstatus_t*. This list is kept
  1470. * sorted by identity_digest. */
  1471. } networkstatus_v2_t;
  1472. typedef struct vote_microdesc_hash_t {
  1473. struct vote_microdesc_hash_t *next;
  1474. char *microdesc_hash_line;
  1475. } vote_microdesc_hash_t;
  1476. /** The claim about a single router, made in a vote. */
  1477. typedef struct vote_routerstatus_t {
  1478. routerstatus_t status; /**< Underlying 'status' object for this router.
  1479. * Flags are redundant. */
  1480. uint64_t flags; /**< Bit-field for all recognized flags; index into
  1481. * networkstatus_t.known_flags. */
  1482. char *version; /**< The version that the authority says this router is
  1483. * running. */
  1484. vote_microdesc_hash_t *microdesc;
  1485. } vote_routerstatus_t;
  1486. /** A signature of some document by an authority. */
  1487. typedef struct document_signature_t {
  1488. /** Declared SHA-1 digest of this voter's identity key */
  1489. char identity_digest[DIGEST_LEN];
  1490. /** Declared SHA-1 digest of signing key used by this voter. */
  1491. char signing_key_digest[DIGEST_LEN];
  1492. /** Algorithm used to compute the digest of the document. */
  1493. digest_algorithm_t alg;
  1494. /** Signature of the signed thing. */
  1495. char *signature;
  1496. /** Length of <b>signature</b> */
  1497. int signature_len;
  1498. unsigned int bad_signature : 1; /**< Set to true if we've tried to verify
  1499. * the sig, and we know it's bad. */
  1500. unsigned int good_signature : 1; /**< Set to true if we've verified the sig
  1501. * as good. */
  1502. } document_signature_t;
  1503. /** Information about a single voter in a vote or a consensus. */
  1504. typedef struct networkstatus_voter_info_t {
  1505. /** Declared SHA-1 digest of this voter's identity key */
  1506. char identity_digest[DIGEST_LEN];
  1507. char *nickname; /**< Nickname of this voter */
  1508. /** Digest of this voter's "legacy" identity key, if any. In vote only; for
  1509. * consensuses, we treat legacy keys as additional signers. */
  1510. char legacy_id_digest[DIGEST_LEN];
  1511. char *address; /**< Address of this voter, in string format. */
  1512. uint32_t addr; /**< Address of this voter, in IPv4, in host order. */
  1513. uint16_t dir_port; /**< Directory port of this voter */
  1514. uint16_t or_port; /**< OR port of this voter */
  1515. char *contact; /**< Contact information for this voter. */
  1516. char vote_digest[DIGEST_LEN]; /**< Digest of this voter's vote, as signed. */
  1517. /* Nothing from here on is signed. */
  1518. /** The signature of the document and the signature's status. */
  1519. smartlist_t *sigs;
  1520. } networkstatus_voter_info_t;
  1521. /** Enumerates the possible seriousness values of a networkstatus document. */
  1522. typedef enum {
  1523. NS_TYPE_VOTE,
  1524. NS_TYPE_CONSENSUS,
  1525. NS_TYPE_OPINION,
  1526. } networkstatus_type_t;
  1527. /** Enumerates recognized flavors of a consensus networkstatus document. All
  1528. * flavors of a consensus are generated from the same set of votes, but they
  1529. * present different types information to different versions of Tor. */
  1530. typedef enum {
  1531. FLAV_NS = 0,
  1532. FLAV_MICRODESC = 1,
  1533. } consensus_flavor_t;
  1534. /** Which consensus flavor do we actually want to use to build circuits? */
  1535. #define USABLE_CONSENSUS_FLAVOR FLAV_NS
  1536. /** How many different consensus flavors are there? */
  1537. #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
  1538. /** A common structure to hold a v3 network status vote, or a v3 network
  1539. * status consensus. */
  1540. typedef struct networkstatus_t {
  1541. networkstatus_type_t type : 8; /**< Vote, consensus, or opinion? */
  1542. consensus_flavor_t flavor : 8; /**< If a consensus, what kind? */
  1543. time_t published; /**< Vote only: Time when vote was written. */
  1544. time_t valid_after; /**< Time after which this vote or consensus applies. */
  1545. time_t fresh_until; /**< Time before which this is the most recent vote or
  1546. * consensus. */
  1547. time_t valid_until; /**< Time after which this vote or consensus should not
  1548. * be used. */
  1549. /** Consensus only: what method was used to produce this consensus? */
  1550. int consensus_method;
  1551. /** Vote only: what methods is this voter willing to use? */
  1552. smartlist_t *supported_methods;
  1553. /** How long does this vote/consensus claim that authorities take to
  1554. * distribute their votes to one another? */
  1555. int vote_seconds;
  1556. /** How long does this vote/consensus claim that authorities take to
  1557. * distribute their consensus signatures to one another? */
  1558. int dist_seconds;
  1559. /** Comma-separated list of recommended client software, or NULL if this
  1560. * voter has no opinion. */
  1561. char *client_versions;
  1562. char *server_versions;
  1563. /** List of flags that this vote/consensus applies to routers. If a flag is
  1564. * not listed here, the voter has no opinion on what its value should be. */
  1565. smartlist_t *known_flags;
  1566. /** List of key=value strings for the parameters in this vote or
  1567. * consensus, sorted by key. */
  1568. smartlist_t *net_params;
  1569. /** List of key=value strings for the bw weight parameters in the
  1570. * consensus. */
  1571. smartlist_t *weight_params;
  1572. /** List of networkstatus_voter_info_t. For a vote, only one element
  1573. * is included. For a consensus, one element is included for every voter
  1574. * whose vote contributed to the consensus. */
  1575. smartlist_t *voters;
  1576. struct authority_cert_t *cert; /**< Vote only: the voter's certificate. */
  1577. /** Digests of this document, as signed. */
  1578. digests_t digests;
  1579. /** List of router statuses, sorted by identity digest. For a vote,
  1580. * the elements are vote_routerstatus_t; for a consensus, the elements
  1581. * are routerstatus_t. */
  1582. smartlist_t *routerstatus_list;
  1583. /** If present, a map from descriptor digest to elements of
  1584. * routerstatus_list. */
  1585. digestmap_t *desc_digest_map;
  1586. } networkstatus_t;
  1587. /** A set of signatures for a networkstatus consensus. Unless otherwise
  1588. * noted, all fields are as for networkstatus_t. */
  1589. typedef struct ns_detached_signatures_t {
  1590. time_t valid_after;
  1591. time_t fresh_until;
  1592. time_t valid_until;
  1593. strmap_t *digests; /**< Map from flavor name to digestset_t */
  1594. strmap_t *signatures; /**< Map from flavor name to list of
  1595. * document_signature_t */
  1596. } ns_detached_signatures_t;
  1597. /** Allowable types of desc_store_t. */
  1598. typedef enum store_type_t {
  1599. ROUTER_STORE = 0,
  1600. EXTRAINFO_STORE = 1
  1601. } store_type_t;
  1602. /** A 'store' is a set of descriptors saved on disk, with accompanying
  1603. * journal, mmaped as needed, rebuilt as needed. */
  1604. typedef struct desc_store_t {
  1605. /** Filename (within DataDir) for the store. We append .tmp to this
  1606. * filename for a temporary file when rebuilding the store, and .new to this
  1607. * filename for the journal. */
  1608. const char *fname_base;
  1609. /** Alternative (obsolete) value for fname_base: if the file named by
  1610. * fname_base isn't present, we read from here instead, but we never write
  1611. * here. */
  1612. const char *fname_alt_base;
  1613. /** Human-readable description of what this store contains. */
  1614. const char *description;
  1615. tor_mmap_t *mmap; /**< A mmap for the main file in the store. */
  1616. store_type_t type; /**< What's stored in this store? */
  1617. /** The size of the router log, in bytes. */
  1618. size_t journal_len;
  1619. /** The size of the router store, in bytes. */
  1620. size_t store_len;
  1621. /** Total bytes dropped since last rebuild: this is space currently
  1622. * used in the cache and the journal that could be freed by a rebuild. */
  1623. size_t bytes_dropped;
  1624. } desc_store_t;
  1625. /** Contents of a directory of onion routers. */
  1626. typedef struct {
  1627. /** Map from server identity digest to a member of routers. */
  1628. struct digest_ri_map_t *identity_map;
  1629. /** Map from server descriptor digest to a signed_descriptor_t from
  1630. * routers or old_routers. */
  1631. struct digest_sd_map_t *desc_digest_map;
  1632. /** Map from extra-info digest to an extrainfo_t. Only exists for
  1633. * routers in routers or old_routers. */
  1634. struct digest_ei_map_t *extra_info_map;
  1635. /** Map from extra-info digests to a signed_descriptor_t for a router
  1636. * descriptor having that extra-info digest. Only exists for
  1637. * routers in routers or old_routers. */
  1638. struct digest_sd_map_t *desc_by_eid_map;
  1639. /** List of routerinfo_t for all currently live routers we know. */
  1640. smartlist_t *routers;
  1641. /** List of signed_descriptor_t for older router descriptors we're
  1642. * caching. */
  1643. smartlist_t *old_routers;
  1644. /** Store holding server descriptors. If present, any router whose
  1645. * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
  1646. * starting at cache_info.saved_offset */
  1647. desc_store_t desc_store;
  1648. /** Store holding extra-info documents. */
  1649. desc_store_t extrainfo_store;
  1650. } routerlist_t;
  1651. /** Information on router used when extending a circuit. We don't need a
  1652. * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
  1653. * connection, and onion_key to create the onionskin. Note that for onehop
  1654. * general-purpose tunnels, the onion_key is NULL. */
  1655. typedef struct extend_info_t {
  1656. char nickname[MAX_HEX_NICKNAME_LEN+1]; /**< This router's nickname for
  1657. * display. */
  1658. char identity_digest[DIGEST_LEN]; /**< Hash of this router's identity key. */
  1659. uint16_t port; /**< OR port. */
  1660. tor_addr_t addr; /**< IP address. */
  1661. crypto_pk_env_t *onion_key; /**< Current onionskin key. */
  1662. } extend_info_t;
  1663. /** Certificate for v3 directory protocol: binds long-term authority identity
  1664. * keys to medium-term authority signing keys. */
  1665. typedef struct authority_cert_t {
  1666. /** Information relating to caching this cert on disk and looking it up. */
  1667. signed_descriptor_t cache_info;
  1668. /** This authority's long-term authority identity key. */
  1669. crypto_pk_env_t *identity_key;
  1670. /** This authority's medium-term signing key. */
  1671. crypto_pk_env_t *signing_key;
  1672. /** The digest of <b>signing_key</b> */
  1673. char signing_key_digest[DIGEST_LEN];
  1674. /** The listed expiration time of this certificate. */
  1675. time_t expires;
  1676. /** This authority's IPv4 address, in host order. */
  1677. uint32_t addr;
  1678. /** This authority's directory port. */
  1679. uint16_t dir_port;
  1680. /** True iff this certificate was cross-certified by signing the identity
  1681. * key with the signing key. */
  1682. uint8_t is_cross_certified;
  1683. } authority_cert_t;
  1684. /** Bitfield enum type listing types of directory authority/directory
  1685. * server. */
  1686. typedef enum {
  1687. NO_AUTHORITY = 0,
  1688. /** Serves/signs v1 directory information: Big lists of routers, and short
  1689. * routerstatus documents. */
  1690. V1_AUTHORITY = 1 << 0,
  1691. /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
  1692. V2_AUTHORITY = 1 << 1,
  1693. /** Serves/signs v3 directory information: votes, consensuses, certs */
  1694. V3_AUTHORITY = 1 << 2,
  1695. /** Serves hidden service descriptors. */
  1696. HIDSERV_AUTHORITY = 1 << 3,
  1697. /** Serves bridge descriptors. */
  1698. BRIDGE_AUTHORITY = 1 << 4,
  1699. /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
  1700. EXTRAINFO_CACHE = 1 << 5,
  1701. } authority_type_t;
  1702. #define CRYPT_PATH_MAGIC 0x70127012u
  1703. /** Holds accounting information for a single step in the layered encryption
  1704. * performed by a circuit. Used only at the client edge of a circuit. */
  1705. typedef struct crypt_path_t {
  1706. uint32_t magic;
  1707. /* crypto environments */
  1708. /** Encryption key and counter for cells heading towards the OR at this
  1709. * step. */
  1710. crypto_cipher_env_t *f_crypto;
  1711. /** Encryption key and counter for cells heading back from the OR at this
  1712. * step. */
  1713. crypto_cipher_env_t *b_crypto;
  1714. /** Digest state for cells heading towards the OR at this step. */
  1715. crypto_digest_env_t *f_digest; /* for integrity checking */
  1716. /** Digest state for cells heading away from the OR at this step. */
  1717. crypto_digest_env_t *b_digest;
  1718. /** Current state of Diffie-Hellman key negotiation with the OR at this
  1719. * step. */
  1720. crypto_dh_env_t *dh_handshake_state;
  1721. /** Current state of 'fast' (non-PK) key negotiation with the OR at this
  1722. * step. Used to save CPU when TLS is already providing all the
  1723. * authentication, secrecy, and integrity we need, and we're already
  1724. * distinguishable from an OR.
  1725. */
  1726. char fast_handshake_state[DIGEST_LEN];
  1727. /** Negotiated key material shared with the OR at this step. */
  1728. char handshake_digest[DIGEST_LEN];/* KH in tor-spec.txt */
  1729. /** Information to extend to the OR at this step. */
  1730. extend_info_t *extend_info;
  1731. /** Is the circuit built to this step? Must be one of:
  1732. * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
  1733. * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
  1734. * and not received an EXTENDED/CREATED)
  1735. * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
  1736. uint8_t state;
  1737. #define CPATH_STATE_CLOSED 0
  1738. #define CPATH_STATE_AWAITING_KEYS 1
  1739. #define CPATH_STATE_OPEN 2
  1740. struct crypt_path_t *next; /**< Link to next crypt_path_t in the circuit.
  1741. * (The list is circular, so the last node
  1742. * links to the first.) */
  1743. struct crypt_path_t *prev; /**< Link to previous crypt_path_t in the
  1744. * circuit. */
  1745. int package_window; /**< How many cells are we allowed to originate ending
  1746. * at this step? */
  1747. int deliver_window; /**< How many cells are we willing to deliver originating
  1748. * at this step? */
  1749. } crypt_path_t;
  1750. #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
  1751. #define DH_KEY_LEN DH_BYTES
  1752. #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
  1753. CIPHER_KEY_LEN+\
  1754. DH_KEY_LEN)
  1755. #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
  1756. /** Information used to build a circuit. */
  1757. typedef struct {
  1758. /** Intended length of the final circuit. */
  1759. int desired_path_len;
  1760. /** How to extend to the planned exit node. */
  1761. extend_info_t *chosen_exit;
  1762. /** Whether every node in the circ must have adequate uptime. */
  1763. int need_uptime;
  1764. /** Whether every node in the circ must have adequate capacity. */
  1765. int need_capacity;
  1766. /** Whether the last hop was picked with exiting in mind. */
  1767. int is_internal;
  1768. /** Did we pick this as a one-hop tunnel (not safe for other conns)?
  1769. * These are for encrypted connections that exit to this router, not
  1770. * for arbitrary exits from the circuit. */
  1771. int onehop_tunnel;
  1772. /** The crypt_path_t to append after rendezvous: used for rendezvous. */
  1773. crypt_path_t *pending_final_cpath;
  1774. /** How many times has building a circuit for this task failed? */
  1775. int failure_count;
  1776. /** At what time should we give up on this task? */
  1777. time_t expiry_time;
  1778. } cpath_build_state_t;
  1779. /**
  1780. * The cell_ewma_t structure keeps track of how many cells a circuit has
  1781. * transferred recently. It keeps an EWMA (exponentially weighted moving
  1782. * average) of the number of cells flushed from the circuit queue onto a
  1783. * connection in connection_or_flush_from_first_active_circuit().
  1784. */
  1785. typedef struct {
  1786. /** The last 'tick' at which we recalibrated cell_count.
  1787. *
  1788. * A cell sent at exactly the start of this tick has weight 1.0. Cells sent
  1789. * since the start of this tick have weight greater than 1.0; ones sent
  1790. * earlier have less weight. */
  1791. unsigned last_adjusted_tick;
  1792. /** The EWMA of the cell count. */
  1793. double cell_count;
  1794. /** True iff this is the cell count for a circuit's previous
  1795. * connection. */
  1796. unsigned int is_for_p_conn : 1;
  1797. /** The position of the circuit within the OR connection's priority
  1798. * queue. */
  1799. int heap_index;
  1800. } cell_ewma_t;
  1801. #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
  1802. #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
  1803. /**
  1804. * A circuit is a path over the onion routing
  1805. * network. Applications can connect to one end of the circuit, and can
  1806. * create exit connections at the other end of the circuit. AP and exit
  1807. * connections have only one circuit associated with them (and thus these
  1808. * connection types are closed when the circuit is closed), whereas
  1809. * OR connections multiplex many circuits at once, and stay standing even
  1810. * when there are no circuits running over them.
  1811. *
  1812. * A circuit_t structure can fill one of two roles. First, a or_circuit_t
  1813. * links two connections together: either an edge connection and an OR
  1814. * connection, or two OR connections. (When joined to an OR connection, a
  1815. * circuit_t affects only cells sent to a particular circID on that
  1816. * connection. When joined to an edge connection, a circuit_t affects all
  1817. * data.)
  1818. * Second, an origin_circuit_t holds the cipher keys and state for sending data
  1819. * along a given circuit. At the OP, it has a sequence of ciphers, each
  1820. * of which is shared with a single OR along the circuit. Separate
  1821. * ciphers are used for data going "forward" (away from the OP) and
  1822. * "backward" (towards the OP). At the OR, a circuit has only two stream
  1823. * ciphers: one for data going forward, and one for data going backward.
  1824. */
  1825. typedef struct circuit_t {
  1826. uint32_t magic; /**< For memory and type debugging: must equal
  1827. * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
  1828. /** Queue of cells waiting to be transmitted on n_conn. */
  1829. cell_queue_t n_conn_cells;
  1830. /** The OR connection that is next in this circuit. */
  1831. or_connection_t *n_conn;
  1832. /** The circuit_id used in the next (forward) hop of this circuit. */
  1833. circid_t n_circ_id;
  1834. /** The hop to which we want to extend this circuit. Should be NULL if
  1835. * the circuit has attached to a connection. */
  1836. extend_info_t *n_hop;
  1837. /** True iff we are waiting for n_conn_cells to become less full before
  1838. * allowing p_streams to add any more cells. (Origin circuit only.) */
  1839. unsigned int streams_blocked_on_n_conn : 1;
  1840. /** True iff we are waiting for p_conn_cells to become less full before
  1841. * allowing n_streams to add any more cells. (OR circuit only.) */
  1842. unsigned int streams_blocked_on_p_conn : 1;
  1843. uint8_t state; /**< Current status of this circuit. */
  1844. uint8_t purpose; /**< Why are we creating this circuit? */
  1845. /** How many relay data cells can we package (read from edge streams)
  1846. * on this circuit before we receive a circuit-level sendme cell asking
  1847. * for more? */
  1848. int package_window;
  1849. /** How many relay data cells will we deliver (write to edge streams)
  1850. * on this circuit? When deliver_window gets low, we send some
  1851. * circuit-level sendme cells to indicate that we're willing to accept
  1852. * more. */
  1853. int deliver_window;
  1854. /** For storage while n_conn is pending
  1855. * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
  1856. * length ONIONSKIN_CHALLENGE_LEN. */
  1857. char *n_conn_onionskin;
  1858. time_t timestamp_created; /**< When was this circuit created? */
  1859. time_t timestamp_dirty; /**< When the circuit was first used, or 0 if the
  1860. * circuit is clean. */
  1861. struct timeval highres_created; /**< When exactly was the circuit created? */
  1862. uint16_t marked_for_close; /**< Should we close this circuit at the end of
  1863. * the main loop? (If true, holds the line number
  1864. * where this circuit was marked.) */
  1865. const char *marked_for_close_file; /**< For debugging: in which file was this
  1866. * circuit marked for close? */
  1867. /** Next circuit in the doubly-linked ring of circuits waiting to add
  1868. * cells to n_conn. NULL if we have no cells pending, or if we're not
  1869. * linked to an OR connection. */
  1870. struct circuit_t *next_active_on_n_conn;
  1871. /** Previous circuit in the doubly-linked ring of circuits waiting to add
  1872. * cells to n_conn. NULL if we have no cells pending, or if we're not
  1873. * linked to an OR connection. */
  1874. struct circuit_t *prev_active_on_n_conn;
  1875. struct circuit_t *next; /**< Next circuit in linked list of all circuits. */
  1876. /** Unique ID for measuring tunneled network status requests. */
  1877. uint64_t dirreq_id;
  1878. /** The EWMA count for the number of cells flushed from the
  1879. * n_conn_cells queue. Used to determine which circuit to flush from next.
  1880. */
  1881. cell_ewma_t n_cell_ewma;
  1882. } circuit_t;
  1883. /** Largest number of relay_early cells that we can send on a given
  1884. * circuit. */
  1885. #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
  1886. /** An origin_circuit_t holds data necessary to build and use a circuit.
  1887. */
  1888. typedef struct origin_circuit_t {
  1889. circuit_t _base;
  1890. /** Linked list of AP streams (or EXIT streams if hidden service)
  1891. * associated with this circuit. */
  1892. edge_connection_t *p_streams;
  1893. /** Build state for this circuit. It includes the intended path
  1894. * length, the chosen exit router, rendezvous information, etc.
  1895. */
  1896. cpath_build_state_t *build_state;
  1897. /** The doubly-linked list of crypt_path_t entries, one per hop,
  1898. * for this circuit. This includes ciphers for each hop,
  1899. * integrity-checking digests for each hop, and package/delivery
  1900. * windows for each hop.
  1901. */
  1902. crypt_path_t *cpath;
  1903. /** Holds all rendezvous data on either client or service side. */
  1904. rend_data_t *rend_data;
  1905. /** How many more relay_early cells can we send on this circuit, according
  1906. * to the specification? */
  1907. unsigned int remaining_relay_early_cells : 4;
  1908. /** Set if this circuit is insanely old and we already informed the user */
  1909. unsigned int is_ancient : 1;
  1910. /** Set if this circuit has already been opened. Used to detect
  1911. * cannibalized circuits. */
  1912. unsigned int has_opened : 1;
  1913. /** What commands were sent over this circuit that decremented the
  1914. * RELAY_EARLY counter? This is for debugging task 878. */
  1915. uint8_t relay_early_commands[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT];
  1916. /** How many RELAY_EARLY cells have been sent over this circuit? This is
  1917. * for debugging task 878, too. */
  1918. int relay_early_cells_sent;
  1919. /** The next stream_id that will be tried when we're attempting to
  1920. * construct a new AP stream originating at this circuit. */
  1921. streamid_t next_stream_id;
  1922. /* The intro key replaces the hidden service's public key if purpose is
  1923. * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
  1924. * descriptor is used. */
  1925. crypto_pk_env_t *intro_key;
  1926. /** Quasi-global identifier for this circuit; used for control.c */
  1927. /* XXXX NM This can get re-used after 2**32 circuits. */
  1928. uint32_t global_identifier;
  1929. } origin_circuit_t;
  1930. /** An or_circuit_t holds information needed to implement a circuit at an
  1931. * OR. */
  1932. typedef struct or_circuit_t {
  1933. circuit_t _base;
  1934. /** Next circuit in the doubly-linked ring of circuits waiting to add
  1935. * cells to p_conn. NULL if we have no cells pending, or if we're not
  1936. * linked to an OR connection. */
  1937. struct circuit_t *next_active_on_p_conn;
  1938. /** Previous circuit in the doubly-linked ring of circuits waiting to add
  1939. * cells to p_conn. NULL if we have no cells pending, or if we're not
  1940. * linked to an OR connection. */
  1941. struct circuit_t *prev_active_on_p_conn;
  1942. /** The circuit_id used in the previous (backward) hop of this circuit. */
  1943. circid_t p_circ_id;
  1944. /** Queue of cells waiting to be transmitted on p_conn. */
  1945. cell_queue_t p_conn_cells;
  1946. /** The OR connection that is previous in this circuit. */
  1947. or_connection_t *p_conn;
  1948. /** Linked list of Exit streams associated with this circuit. */
  1949. edge_connection_t *n_streams;
  1950. /** Linked list of Exit streams associated with this circuit that are
  1951. * still being resolved. */
  1952. edge_connection_t *resolving_streams;
  1953. /** The cipher used by intermediate hops for cells heading toward the
  1954. * OP. */
  1955. crypto_cipher_env_t *p_crypto;
  1956. /** The cipher used by intermediate hops for cells heading away from
  1957. * the OP. */
  1958. crypto_cipher_env_t *n_crypto;
  1959. /** The integrity-checking digest used by intermediate hops, for
  1960. * cells packaged here and heading towards the OP.
  1961. */
  1962. crypto_digest_env_t *p_digest;
  1963. /** The integrity-checking digest used by intermediate hops, for
  1964. * cells packaged at the OP and arriving here.
  1965. */
  1966. crypto_digest_env_t *n_digest;
  1967. /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
  1968. * is not marked for close. */
  1969. struct or_circuit_t *rend_splice;
  1970. #if REND_COOKIE_LEN >= DIGEST_LEN
  1971. #define REND_TOKEN_LEN REND_COOKIE_LEN
  1972. #else
  1973. #define REND_TOKEN_LEN DIGEST_LEN
  1974. #endif
  1975. /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
  1976. * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
  1977. * otherwise.
  1978. * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
  1979. */
  1980. char rend_token[REND_TOKEN_LEN];
  1981. /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
  1982. char handshake_digest[DIGEST_LEN]; /**< Stores KH for the handshake. */
  1983. /** How many more relay_early cells can we send on this circuit, according
  1984. * to the specification? */
  1985. unsigned int remaining_relay_early_cells : 4;
  1986. /** True iff this circuit was made with a CREATE_FAST cell. */
  1987. unsigned int is_first_hop : 1;
  1988. /** Number of cells that were removed from circuit queue; reset every
  1989. * time when writing buffer stats to disk. */
  1990. uint32_t processed_cells;
  1991. /** Total time in milliseconds that cells spent in both app-ward and
  1992. * exit-ward queues of this circuit; reset every time when writing
  1993. * buffer stats to disk. */
  1994. uint64_t total_cell_waiting_time;
  1995. /** The EWMA count for the number of cells flushed from the
  1996. * p_conn_cells queue. */
  1997. cell_ewma_t p_cell_ewma;
  1998. } or_circuit_t;
  1999. /** Convert a circuit subtype to a circuit_t.*/
  2000. #define TO_CIRCUIT(x) (&((x)->_base))
  2001. /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
  2002. * if the cast is impossible. */
  2003. static or_circuit_t *TO_OR_CIRCUIT(circuit_t *);
  2004. /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
  2005. * Asserts if the cast is impossible. */
  2006. static origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *);
  2007. static INLINE or_circuit_t *TO_OR_CIRCUIT(circuit_t *x)
  2008. {
  2009. tor_assert(x->magic == OR_CIRCUIT_MAGIC);
  2010. return DOWNCAST(or_circuit_t, x);
  2011. }
  2012. static INLINE origin_circuit_t *TO_ORIGIN_CIRCUIT(circuit_t *x)
  2013. {
  2014. tor_assert(x->magic == ORIGIN_CIRCUIT_MAGIC);
  2015. return DOWNCAST(origin_circuit_t, x);
  2016. }
  2017. /** Bitfield type: things that we're willing to use invalid routers for. */
  2018. typedef enum invalid_router_usage_t {
  2019. ALLOW_INVALID_ENTRY =1,
  2020. ALLOW_INVALID_EXIT =2,
  2021. ALLOW_INVALID_MIDDLE =4,
  2022. ALLOW_INVALID_RENDEZVOUS =8,
  2023. ALLOW_INVALID_INTRODUCTION=16,
  2024. } invalid_router_usage_t;
  2025. /* limits for TCP send and recv buffer size used for constrained sockets */
  2026. #define MIN_CONSTRAINED_TCP_BUFFER 2048
  2027. #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
  2028. /** A linked list of lines in a config file. */
  2029. typedef struct config_line_t {
  2030. char *key;
  2031. char *value;
  2032. struct config_line_t *next;
  2033. } config_line_t;
  2034. typedef struct routerset_t routerset_t;
  2035. /** Configuration options for a Tor process. */
  2036. typedef struct {
  2037. uint32_t _magic;
  2038. /** What should the tor process actually do? */
  2039. enum {
  2040. CMD_RUN_TOR=0, CMD_LIST_FINGERPRINT, CMD_HASH_PASSWORD,
  2041. CMD_VERIFY_CONFIG, CMD_RUN_UNITTESTS
  2042. } command;
  2043. const char *command_arg; /**< Argument for command-line option. */
  2044. config_line_t *Logs; /**< New-style list of configuration lines
  2045. * for logs */
  2046. char *DebugLogFile; /**< Where to send verbose log messages. */
  2047. char *DataDirectory; /**< OR only: where to store long-term data. */
  2048. char *Nickname; /**< OR only: nickname of this onion router. */
  2049. char *Address; /**< OR only: configured address for this onion router. */
  2050. char *PidFile; /**< Where to store PID of Tor process. */
  2051. routerset_t *ExitNodes; /**< Structure containing nicknames, digests,
  2052. * country codes and IP address patterns of ORs to
  2053. * consider as exits. */
  2054. routerset_t *EntryNodes;/**< Structure containing nicknames, digests,
  2055. * country codes and IP address patterns of ORs to
  2056. * consider as entry points. */
  2057. int StrictNodes; /**< Boolean: When none of our EntryNodes or ExitNodes
  2058. * are up, or we need to access a node in ExcludeNodes,
  2059. * do we just fail instead? */
  2060. routerset_t *ExcludeNodes;/**< Structure containing nicknames, digests,
  2061. * country codes and IP address patterns of ORs
  2062. * not to use in circuits. But see StrictNodes
  2063. * above. */
  2064. routerset_t *ExcludeExitNodes;/**< Structure containing nicknames, digests,
  2065. * country codes and IP address patterns of
  2066. * ORs not to consider as exits. */
  2067. /** Union of ExcludeNodes and ExcludeExitNodes */
  2068. struct routerset_t *_ExcludeExitNodesUnion;
  2069. int DisableAllSwap; /**< Boolean: Attempt to call mlockall() on our
  2070. * process for all current and future memory. */
  2071. /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
  2072. smartlist_t *AllowInvalidNodes;
  2073. /** Bitmask; derived from AllowInvalidNodes. */
  2074. invalid_router_usage_t _AllowInvalid;
  2075. config_line_t *ExitPolicy; /**< Lists of exit policy components. */
  2076. int ExitPolicyRejectPrivate; /**< Should we not exit to local addresses? */
  2077. config_line_t *SocksPolicy; /**< Lists of socks policy components */
  2078. config_line_t *DirPolicy; /**< Lists of dir policy components */
  2079. /** Addresses to bind for listening for SOCKS connections. */
  2080. config_line_t *SocksListenAddress;
  2081. /** Addresses to bind for listening for transparent pf/netfilter
  2082. * connections. */
  2083. config_line_t *TransListenAddress;
  2084. /** Addresses to bind for listening for transparent natd connections */
  2085. config_line_t *NatdListenAddress;
  2086. /** Addresses to bind for listening for SOCKS connections. */
  2087. config_line_t *DNSListenAddress;
  2088. /** Addresses to bind for listening for OR connections. */
  2089. config_line_t *ORListenAddress;
  2090. /** Addresses to bind for listening for directory connections. */
  2091. config_line_t *DirListenAddress;
  2092. /** Addresses to bind for listening for control connections. */
  2093. config_line_t *ControlListenAddress;
  2094. /** Local address to bind outbound sockets */
  2095. char *OutboundBindAddress;
  2096. /** Directory server only: which versions of
  2097. * Tor should we tell users to run? */
  2098. config_line_t *RecommendedVersions;
  2099. config_line_t *RecommendedClientVersions;
  2100. config_line_t *RecommendedServerVersions;
  2101. /** Whether dirservers refuse router descriptors with private IPs. */
  2102. int DirAllowPrivateAddresses;
  2103. char *User; /**< Name of user to run Tor as. */
  2104. char *Group; /**< Name of group to run Tor as. */
  2105. int ORPort; /**< Port to listen on for OR connections. */
  2106. int SocksPort; /**< Port to listen on for SOCKS connections. */
  2107. /** Port to listen on for transparent pf/netfilter connections. */
  2108. int TransPort;
  2109. int NatdPort; /**< Port to listen on for transparent natd connections. */
  2110. int ControlPort; /**< Port to listen on for control connections. */
  2111. config_line_t *ControlSocket; /**< List of Unix Domain Sockets to listen on
  2112. * for control connections. */
  2113. int DirPort; /**< Port to listen on for directory connections. */
  2114. int DNSPort; /**< Port to listen on for DNS requests. */
  2115. int AssumeReachable; /**< Whether to publish our descriptor regardless. */
  2116. int AuthoritativeDir; /**< Boolean: is this an authoritative directory? */
  2117. int V1AuthoritativeDir; /**< Boolean: is this an authoritative directory
  2118. * for version 1 directories? */
  2119. int V2AuthoritativeDir; /**< Boolean: is this an authoritative directory
  2120. * for version 2 directories? */
  2121. int V3AuthoritativeDir; /**< Boolean: is this an authoritative directory
  2122. * for version 3 directories? */
  2123. int HSAuthoritativeDir; /**< Boolean: does this an authoritative directory
  2124. * handle hidden service requests? */
  2125. int NamingAuthoritativeDir; /**< Boolean: is this an authoritative directory
  2126. * that's willing to bind names? */
  2127. int VersioningAuthoritativeDir; /**< Boolean: is this an authoritative
  2128. * directory that's willing to recommend
  2129. * versions? */
  2130. int BridgeAuthoritativeDir; /**< Boolean: is this an authoritative directory
  2131. * that aggregates bridge descriptors? */
  2132. /** If set on a bridge authority, it will answer requests on its dirport
  2133. * for bridge statuses -- but only if the requests use this password.
  2134. * If set on a bridge user, request bridge statuses, and use this password
  2135. * when doing so. */
  2136. char *BridgePassword;
  2137. int UseBridges; /**< Boolean: should we start all circuits with a bridge? */
  2138. config_line_t *Bridges; /**< List of bootstrap bridge addresses. */
  2139. int BridgeRelay; /**< Boolean: are we acting as a bridge relay? We make
  2140. * this explicit so we can change how we behave in the
  2141. * future. */
  2142. /** Boolean: if we know the bridge's digest, should we get new
  2143. * descriptors from the bridge authorities or from the bridge itself? */
  2144. int UpdateBridgesFromAuthority;
  2145. int AvoidDiskWrites; /**< Boolean: should we never cache things to disk?
  2146. * Not used yet. */
  2147. int ClientOnly; /**< Boolean: should we never evolve into a server role? */
  2148. /** Boolean: should we never publish a descriptor? Deprecated. */
  2149. int NoPublish;
  2150. /** To what authority types do we publish our descriptor? Choices are
  2151. * "v1", "v2", "v3", "bridge", or "". */
  2152. smartlist_t *PublishServerDescriptor;
  2153. /** An authority type, derived from PublishServerDescriptor. */
  2154. authority_type_t _PublishServerDescriptor;
  2155. /** Boolean: do we publish hidden service descriptors to the HS auths? */
  2156. int PublishHidServDescriptors;
  2157. int FetchServerDescriptors; /**< Do we fetch server descriptors as normal? */
  2158. int FetchHidServDescriptors; /** and hidden service descriptors? */
  2159. int HidServDirectoryV2; /**< Do we participate in the HS DHT? */
  2160. int MinUptimeHidServDirectoryV2; /**< As directory authority, accept hidden
  2161. * service directories after what time? */
  2162. int FetchUselessDescriptors; /**< Do we fetch non-running descriptors too? */
  2163. int AllDirActionsPrivate; /**< Should every directory action be sent
  2164. * through a Tor circuit? */
  2165. int ConnLimit; /**< Demanded minimum number of simultaneous connections. */
  2166. int _ConnLimit; /**< Maximum allowed number of simultaneous connections. */
  2167. int RunAsDaemon; /**< If true, run in the background. (Unix only) */
  2168. int FascistFirewall; /**< Whether to prefer ORs reachable on open ports. */
  2169. smartlist_t *FirewallPorts; /**< Which ports our firewall allows
  2170. * (strings). */
  2171. config_line_t *ReachableAddresses; /**< IP:ports our firewall allows. */
  2172. config_line_t *ReachableORAddresses; /**< IP:ports for OR conns. */
  2173. config_line_t *ReachableDirAddresses; /**< IP:ports for Dir conns. */
  2174. int ConstrainedSockets; /**< Shrink xmit and recv socket buffers. */
  2175. uint64_t ConstrainedSockSize; /**< Size of constrained buffers. */
  2176. /** Whether we should drop exit streams from Tors that we don't know
  2177. * are relays. XXX022 In here for 0.2.2.11 as a temporary test before
  2178. * we switch over to putting it in consensusparams. -RD */
  2179. int RefuseUnknownExits;
  2180. /** Application ports that require all nodes in circ to have sufficient
  2181. * uptime. */
  2182. smartlist_t *LongLivedPorts;
  2183. /** Application ports that are likely to be unencrypted and
  2184. * unauthenticated; we reject requests for them to prevent the
  2185. * user from screwing up and leaking plaintext secrets to an
  2186. * observer somewhere on the Internet. */
  2187. smartlist_t *RejectPlaintextPorts;
  2188. /** Related to RejectPlaintextPorts above, except this config option
  2189. * controls whether we warn (in the log and via a controller status
  2190. * event) every time a risky connection is attempted. */
  2191. smartlist_t *WarnPlaintextPorts;
  2192. /** Should we try to reuse the same exit node for a given host */
  2193. smartlist_t *TrackHostExits;
  2194. int TrackHostExitsExpire; /**< Number of seconds until we expire an
  2195. * addressmap */
  2196. config_line_t *AddressMap; /**< List of address map directives. */
  2197. int AutomapHostsOnResolve; /**< If true, when we get a resolve request for a
  2198. * hostname ending with one of the suffixes in
  2199. * <b>AutomapHostsSuffixes</b>, map it to a
  2200. * virtual address. */
  2201. smartlist_t *AutomapHostsSuffixes; /**< List of suffixes for
  2202. * <b>AutomapHostsOnResolve</b>. */
  2203. int RendPostPeriod; /**< How often do we post each rendezvous service
  2204. * descriptor? Remember to publish them independently. */
  2205. int KeepalivePeriod; /**< How often do we send padding cells to keep
  2206. * connections alive? */
  2207. int SocksTimeout; /**< How long do we let a socks connection wait
  2208. * unattached before we fail it? */
  2209. int LearnCircuitBuildTimeout; /**< If non-zero, we attempt to learn a value
  2210. * for CircuitBuildTimeout based on timeout
  2211. * history */
  2212. int CircuitBuildTimeout; /**< Cull non-open circuits that were born at
  2213. * least this many seconds ago. Used until
  2214. * adaptive algorithm learns a new value. */
  2215. int CircuitIdleTimeout; /**< Cull open clean circuits that were born
  2216. * at least this many seconds ago. */
  2217. int CircuitStreamTimeout; /**< If non-zero, detach streams from circuits
  2218. * and try a new circuit if the stream has been
  2219. * waiting for this many seconds. If zero, use
  2220. * our default internal timeout schedule. */
  2221. int MaxOnionsPending; /**< How many circuit CREATE requests do we allow
  2222. * to wait simultaneously before we start dropping
  2223. * them? */
  2224. int NewCircuitPeriod; /**< How long do we use a circuit before building
  2225. * a new one? */
  2226. int MaxCircuitDirtiness; /**< Never use circs that were first used more than
  2227. this interval ago. */
  2228. uint64_t BandwidthRate; /**< How much bandwidth, on average, are we willing
  2229. * to use in a second? */
  2230. uint64_t BandwidthBurst; /**< How much bandwidth, at maximum, are we willing
  2231. * to use in a second? */
  2232. uint64_t MaxAdvertisedBandwidth; /**< How much bandwidth are we willing to
  2233. * tell people we have? */
  2234. uint64_t RelayBandwidthRate; /**< How much bandwidth, on average, are we
  2235. * willing to use for all relayed conns? */
  2236. uint64_t RelayBandwidthBurst; /**< How much bandwidth, at maximum, will we
  2237. * use in a second for all relayed conns? */
  2238. uint64_t PerConnBWRate; /**< Long-term bw on a single TLS conn, if set. */
  2239. uint64_t PerConnBWBurst; /**< Allowed burst on a single TLS conn, if set. */
  2240. int NumCpus; /**< How many CPUs should we try to use? */
  2241. int RunTesting; /**< If true, create testing circuits to measure how well the
  2242. * other ORs are running. */
  2243. config_line_t *RendConfigLines; /**< List of configuration lines
  2244. * for rendezvous services. */
  2245. config_line_t *HidServAuth; /**< List of configuration lines for client-side
  2246. * authorizations for hidden services */
  2247. char *ContactInfo; /**< Contact info to be published in the directory. */
  2248. char *HttpProxy; /**< hostname[:port] to use as http proxy, if any. */
  2249. tor_addr_t HttpProxyAddr; /**< Parsed IPv4 addr for http proxy, if any. */
  2250. uint16_t HttpProxyPort; /**< Parsed port for http proxy, if any. */
  2251. char *HttpProxyAuthenticator; /**< username:password string, if any. */
  2252. char *HttpsProxy; /**< hostname[:port] to use as https proxy, if any. */
  2253. tor_addr_t HttpsProxyAddr; /**< Parsed addr for https proxy, if any. */
  2254. uint16_t HttpsProxyPort; /**< Parsed port for https proxy, if any. */
  2255. char *HttpsProxyAuthenticator; /**< username:password string, if any. */
  2256. char *Socks4Proxy; /**< hostname:port to use as a SOCKS4 proxy, if any. */
  2257. tor_addr_t Socks4ProxyAddr; /**< Derived from Socks4Proxy. */
  2258. uint16_t Socks4ProxyPort; /**< Derived from Socks4Proxy. */
  2259. char *Socks5Proxy; /**< hostname:port to use as a SOCKS5 proxy, if any. */
  2260. tor_addr_t Socks5ProxyAddr; /**< Derived from Sock5Proxy. */
  2261. uint16_t Socks5ProxyPort; /**< Derived from Socks5Proxy. */
  2262. char *Socks5ProxyUsername; /**< Username for SOCKS5 authentication, if any */
  2263. char *Socks5ProxyPassword; /**< Password for SOCKS5 authentication, if any */
  2264. /** List of configuration lines for replacement directory authorities.
  2265. * If you just want to replace one class of authority at a time,
  2266. * use the "Alternate*Authority" options below instead. */
  2267. config_line_t *DirServers;
  2268. /** If set, use these main (currently v3) directory authorities and
  2269. * not the default ones. */
  2270. config_line_t *AlternateDirAuthority;
  2271. /** If set, use these bridge authorities and not the default one. */
  2272. config_line_t *AlternateBridgeAuthority;
  2273. /** If set, use these HS authorities and not the default ones. */
  2274. config_line_t *AlternateHSAuthority;
  2275. char *MyFamily; /**< Declared family for this OR. */
  2276. config_line_t *NodeFamilies; /**< List of config lines for
  2277. * node families */
  2278. config_line_t *AuthDirBadDir; /**< Address policy for descriptors to
  2279. * mark as bad dir mirrors. */
  2280. config_line_t *AuthDirBadExit; /**< Address policy for descriptors to
  2281. * mark as bad exits. */
  2282. config_line_t *AuthDirReject; /**< Address policy for descriptors to
  2283. * reject. */
  2284. config_line_t *AuthDirInvalid; /**< Address policy for descriptors to
  2285. * never mark as valid. */
  2286. int AuthDirListBadDirs; /**< True iff we should list bad dirs,
  2287. * and vote for all other dir mirrors as good. */
  2288. int AuthDirListBadExits; /**< True iff we should list bad exits,
  2289. * and vote for all other exits as good. */
  2290. int AuthDirRejectUnlisted; /**< Boolean: do we reject all routers that
  2291. * aren't named in our fingerprint file? */
  2292. int AuthDirMaxServersPerAddr; /**< Do not permit more than this
  2293. * number of servers per IP address. */
  2294. int AuthDirMaxServersPerAuthAddr; /**< Do not permit more than this
  2295. * number of servers per IP address shared
  2296. * with an authority. */
  2297. char *AccountingStart; /**< How long is the accounting interval, and when
  2298. * does it start? */
  2299. uint64_t AccountingMax; /**< How many bytes do we allow per accounting
  2300. * interval before hibernation? 0 for "never
  2301. * hibernate." */
  2302. /** Base64-encoded hash of accepted passwords for the control system. */
  2303. config_line_t *HashedControlPassword;
  2304. /** As HashedControlPassword, but not saved. */
  2305. config_line_t *HashedControlSessionPassword;
  2306. int CookieAuthentication; /**< Boolean: do we enable cookie-based auth for
  2307. * the control system? */
  2308. char *CookieAuthFile; /**< Location of a cookie authentication file. */
  2309. int CookieAuthFileGroupReadable; /**< Boolean: Is the CookieAuthFile g+r? */
  2310. int LeaveStreamsUnattached; /**< Boolean: Does Tor attach new streams to
  2311. * circuits itself (0), or does it expect a controller
  2312. * to cope? (1) */
  2313. int DisablePredictedCircuits; /**< Boolean: does Tor preemptively
  2314. * make circuits in the background (0),
  2315. * or not (1)? */
  2316. int ShutdownWaitLength; /**< When we get a SIGINT and we're a server, how
  2317. * long do we wait before exiting? */
  2318. char *SafeLogging; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
  2319. /* Derived from SafeLogging */
  2320. enum {
  2321. SAFELOG_SCRUB_ALL, SAFELOG_SCRUB_RELAY, SAFELOG_SCRUB_NONE
  2322. } _SafeLogging;
  2323. int SafeSocks; /**< Boolean: should we outright refuse application
  2324. * connections that use socks4 or socks5-with-local-dns? */
  2325. #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
  2326. LOG_WARN : LOG_INFO)
  2327. int ProtocolWarnings; /**< Boolean: when other parties screw up the Tor
  2328. * protocol, is it a warn or an info in our logs? */
  2329. int TestSocks; /**< Boolean: when we get a socks connection, do we loudly
  2330. * log whether it was DNS-leaking or not? */
  2331. int HardwareAccel; /**< Boolean: Should we enable OpenSSL hardware
  2332. * acceleration where available? */
  2333. char *AccelName; /**< Optional hardware acceleration engine name. */
  2334. char *AccelDir; /**< Optional hardware acceleration engine search dir. */
  2335. int UseEntryGuards; /**< Boolean: Do we try to enter from a smallish number
  2336. * of fixed nodes? */
  2337. int NumEntryGuards; /**< How many entry guards do we try to establish? */
  2338. int RephistTrackTime; /**< How many seconds do we keep rephist info? */
  2339. int FastFirstHopPK; /**< If Tor believes it is safe, should we save a third
  2340. * of our PK time by sending CREATE_FAST cells? */
  2341. /** Should we always fetch our dir info on the mirror schedule (which
  2342. * means directly from the authorities) no matter our other config? */
  2343. int FetchDirInfoEarly;
  2344. /** Should we fetch our dir info at the start of the consensus period? */
  2345. int FetchDirInfoExtraEarly;
  2346. char *VirtualAddrNetwork; /**< Address and mask to hand out for virtual
  2347. * MAPADDRESS requests. */
  2348. int ServerDNSSearchDomains; /**< Boolean: If set, we don't force exit
  2349. * addresses to be FQDNs, but rather search for them in
  2350. * the local domains. */
  2351. int ServerDNSDetectHijacking; /**< Boolean: If true, check for DNS failure
  2352. * hijacking. */
  2353. int ServerDNSRandomizeCase; /**< Boolean: Use the 0x20-hack to prevent
  2354. * DNS poisoning attacks. */
  2355. char *ServerDNSResolvConfFile; /**< If provided, we configure our internal
  2356. * resolver from the file here rather than from
  2357. * /etc/resolv.conf (Unix) or the registry (Windows). */
  2358. char *DirPortFrontPage; /**< This is a full path to a file with an html
  2359. disclaimer. This allows a server administrator to show
  2360. that they're running Tor and anyone visiting their server
  2361. will know this without any specialized knowledge. */
  2362. /** Boolean: if set, we start even if our resolv.conf file is missing
  2363. * or broken. */
  2364. int ServerDNSAllowBrokenConfig;
  2365. smartlist_t *ServerDNSTestAddresses; /**< A list of addresses that definitely
  2366. * should be resolvable. Used for
  2367. * testing our DNS server. */
  2368. int EnforceDistinctSubnets; /**< If true, don't allow multiple routers in the
  2369. * same network zone in the same circuit. */
  2370. int TunnelDirConns; /**< If true, use BEGIN_DIR rather than BEGIN when
  2371. * possible. */
  2372. int PreferTunneledDirConns; /**< If true, avoid dirservers that don't
  2373. * support BEGIN_DIR, when possible. */
  2374. int AllowNonRFC953Hostnames; /**< If true, we allow connections to hostnames
  2375. * with weird characters. */
  2376. /** If true, we try resolving hostnames with weird characters. */
  2377. int ServerDNSAllowNonRFC953Hostnames;
  2378. /** If true, we try to download extra-info documents (and we serve them,
  2379. * if we are a cache). For authorities, this is always true. */
  2380. int DownloadExtraInfo;
  2381. /** If true, and we are acting as a relay, allow exit circuits even when
  2382. * we are the first hop of a circuit. */
  2383. int AllowSingleHopExits;
  2384. /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
  2385. * circuits that we build. */
  2386. int ExcludeSingleHopRelays;
  2387. /** If true, and the controller tells us to use a one-hop circuit, and the
  2388. * exit allows it, we use it. */
  2389. int AllowSingleHopCircuits;
  2390. /** If true, we convert "www.google.com.foo.exit" addresses on the
  2391. * socks/trans/natd ports into "www.google.com" addresses that
  2392. * exit from the node "foo". Disabled by default since attacking
  2393. * websites and exit relays can use it to manipulate your path
  2394. * selection. */
  2395. int AllowDotExit;
  2396. /** If true, we will warn if a user gives us only an IP address
  2397. * instead of a hostname. */
  2398. int WarnUnsafeSocks;
  2399. /** If true, the user wants us to collect statistics on clients
  2400. * requesting network statuses from us as directory. */
  2401. int DirReqStatistics;
  2402. /** If true, the user wants us to collect statistics on port usage. */
  2403. int ExitPortStatistics;
  2404. /** If true, the user wants us to collect cell statistics. */
  2405. int CellStatistics;
  2406. /** If true, the user wants us to collect statistics as entry node. */
  2407. int EntryStatistics;
  2408. /** If true, include statistics file contents in extra-info documents. */
  2409. int ExtraInfoStatistics;
  2410. /** If true, do not believe anybody who tells us that a domain resolves
  2411. * to an internal address, or that an internal address has a PTR mapping.
  2412. * Helps avoid some cross-site attacks. */
  2413. int ClientDNSRejectInternalAddresses;
  2414. /** The length of time that we think a consensus should be fresh. */
  2415. int V3AuthVotingInterval;
  2416. /** The length of time we think it will take to distribute votes. */
  2417. int V3AuthVoteDelay;
  2418. /** The length of time we think it will take to distribute signatures. */
  2419. int V3AuthDistDelay;
  2420. /** The number of intervals we think a consensus should be valid. */
  2421. int V3AuthNIntervalsValid;
  2422. /** Should advertise and sign consensuses with a legacy key, for key
  2423. * migration purposes? */
  2424. int V3AuthUseLegacyKey;
  2425. /** Location of bandwidth measurement file */
  2426. char *V3BandwidthsFile;
  2427. /** Authority only: key=value pairs that we add to our networkstatus
  2428. * consensus vote on the 'params' line. */
  2429. char *ConsensusParams;
  2430. /** The length of time that we think an initial consensus should be fresh.
  2431. * Only altered on testing networks. */
  2432. int TestingV3AuthInitialVotingInterval;
  2433. /** The length of time we think it will take to distribute initial votes.
  2434. * Only altered on testing networks. */
  2435. int TestingV3AuthInitialVoteDelay;
  2436. /** The length of time we think it will take to distribute initial
  2437. * signatures. Only altered on testing networks.*/
  2438. int TestingV3AuthInitialDistDelay;
  2439. /** If an authority has been around for less than this amount of time, it
  2440. * does not believe its reachability information is accurate. Only
  2441. * altered on testing networks. */
  2442. int TestingAuthDirTimeToLearnReachability;
  2443. /** Clients don't download any descriptor this recent, since it will
  2444. * probably not have propagated to enough caches. Only altered on testing
  2445. * networks. */
  2446. int TestingEstimatedDescriptorPropagationTime;
  2447. /** If true, we take part in a testing network. Change the defaults of a
  2448. * couple of other configuration options and allow to change the values
  2449. * of certain configuration options. */
  2450. int TestingTorNetwork;
  2451. /** File to check for a consensus networkstatus, if we don't have one
  2452. * cached. */
  2453. char *FallbackNetworkstatusFile;
  2454. /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
  2455. * count of how many client addresses have contacted us so that we can help
  2456. * the bridge authority guess which countries have blocked access to us. */
  2457. int BridgeRecordUsageByCountry;
  2458. /** Optionally, a file with GeoIP data. */
  2459. char *GeoIPFile;
  2460. /** If true, SIGHUP should reload the torrc. Sometimes controllers want
  2461. * to make this false. */
  2462. int ReloadTorrcOnSIGHUP;
  2463. /* The main parameter for picking circuits within a connection.
  2464. *
  2465. * If this value is positive, when picking a cell to relay on a connection,
  2466. * we always relay from the circuit whose weighted cell count is lowest.
  2467. * Cells are weighted exponentially such that if one cell is sent
  2468. * 'CircuitPriorityHalflife' seconds before another, it counts for half as
  2469. * much.
  2470. *
  2471. * If this value is zero, we're disabling the cell-EWMA algorithm.
  2472. *
  2473. * If this value is negative, we're using the default approach
  2474. * according to either Tor or a parameter set in the consensus.
  2475. */
  2476. double CircuitPriorityHalflife;
  2477. } or_options_t;
  2478. /** Persistent state for an onion router, as saved to disk. */
  2479. typedef struct {
  2480. uint32_t _magic;
  2481. /** The time at which we next plan to write the state to the disk. Equal to
  2482. * TIME_MAX if there are no savable changes, 0 if there are changes that
  2483. * should be saved right away. */
  2484. time_t next_write;
  2485. /** When was the state last written to disk? */
  2486. time_t LastWritten;
  2487. /** Fields for accounting bandwidth use. */
  2488. time_t AccountingIntervalStart;
  2489. uint64_t AccountingBytesReadInInterval;
  2490. uint64_t AccountingBytesWrittenInInterval;
  2491. int AccountingSecondsActive;
  2492. int AccountingSecondsToReachSoftLimit;
  2493. time_t AccountingSoftLimitHitAt;
  2494. uint64_t AccountingBytesAtSoftLimit;
  2495. uint64_t AccountingExpectedUsage;
  2496. /** A list of Entry Guard-related configuration lines. */
  2497. config_line_t *EntryGuards;
  2498. /** These fields hold information on the history of bandwidth usage for
  2499. * servers. The "Ends" fields hold the time when we last updated the
  2500. * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
  2501. * of the entries of Values. The "Values" lists hold decimal string
  2502. * representations of the number of bytes read or written in each
  2503. * interval. */
  2504. time_t BWHistoryReadEnds;
  2505. int BWHistoryReadInterval;
  2506. smartlist_t *BWHistoryReadValues;
  2507. time_t BWHistoryWriteEnds;
  2508. int BWHistoryWriteInterval;
  2509. smartlist_t *BWHistoryWriteValues;
  2510. time_t BWHistoryDirReadEnds;
  2511. int BWHistoryDirReadInterval;
  2512. smartlist_t *BWHistoryDirReadValues;
  2513. time_t BWHistoryDirWriteEnds;
  2514. int BWHistoryDirWriteInterval;
  2515. smartlist_t *BWHistoryDirWriteValues;
  2516. /** Build time histogram */
  2517. config_line_t * BuildtimeHistogram;
  2518. unsigned int TotalBuildTimes;
  2519. unsigned int CircuitBuildAbandonedCount;
  2520. /** What version of Tor wrote this state file? */
  2521. char *TorVersion;
  2522. /** Holds any unrecognized values we found in the state file, in the order
  2523. * in which we found them. */
  2524. config_line_t *ExtraLines;
  2525. /** When did we last rotate our onion key? "0" for 'no idea'. */
  2526. time_t LastRotatedOnionKey;
  2527. } or_state_t;
  2528. /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
  2529. * state is already scheduled to be written to disk earlier than <b>when</b>.
  2530. */
  2531. static INLINE void or_state_mark_dirty(or_state_t *state, time_t when)
  2532. {
  2533. if (state->next_write > when)
  2534. state->next_write = when;
  2535. }
  2536. #define MAX_SOCKS_REPLY_LEN 1024
  2537. #define MAX_SOCKS_ADDR_LEN 256
  2538. /** Please open a TCP connection to this addr:port. */
  2539. #define SOCKS_COMMAND_CONNECT 0x01
  2540. /** Please turn this FQDN into an IP address, privately. */
  2541. #define SOCKS_COMMAND_RESOLVE 0xF0
  2542. /** Please turn this IP address into an FQDN, privately. */
  2543. #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
  2544. #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
  2545. #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
  2546. (c)==SOCKS_COMMAND_RESOLVE_PTR)
  2547. /** State of a SOCKS request from a user to an OP. Also used to encode other
  2548. * information for non-socks user request (such as those on TransPort and
  2549. * DNSPort) */
  2550. struct socks_request_t {
  2551. /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
  2552. * 0 means that no socks handshake ever took place, and this is just a
  2553. * stub connection (e.g. see connection_ap_make_link()). */
  2554. char socks_version;
  2555. int command; /**< What is this stream's goal? One from the above list. */
  2556. size_t replylen; /**< Length of <b>reply</b>. */
  2557. char reply[MAX_SOCKS_REPLY_LEN]; /**< Write an entry into this string if
  2558. * we want to specify our own socks reply,
  2559. * rather than using the default socks4 or
  2560. * socks5 socks reply. We use this for the
  2561. * two-stage socks5 handshake.
  2562. */
  2563. char address[MAX_SOCKS_ADDR_LEN]; /**< What address did the client ask to
  2564. connect to/resolve? */
  2565. uint16_t port; /**< What port did the client ask to connect to? */
  2566. unsigned int has_finished : 1; /**< Has the SOCKS handshake finished? Used to
  2567. * make sure we send back a socks reply for
  2568. * every connection. */
  2569. };
  2570. /* all the function prototypes go here */
  2571. /********************************* circuitbuild.c **********************/
  2572. /** How many hops does a general-purpose circuit have by default? */
  2573. #define DEFAULT_ROUTE_LEN 3
  2574. /* Circuit Build Timeout "public" structures. */
  2575. /** Total size of the circuit timeout history to accumulate.
  2576. * 1000 is approx 2.5 days worth of continual-use circuits. */
  2577. #define CBT_NCIRCUITS_TO_OBSERVE 1000
  2578. /** Width of the histogram bins in milliseconds */
  2579. #define CBT_BIN_WIDTH ((build_time_t)50)
  2580. /** Number of modes to use in the weighted-avg computation of Xm */
  2581. #define CBT_DEFAULT_NUM_XM_MODES 3
  2582. /** A build_time_t is milliseconds */
  2583. typedef uint32_t build_time_t;
  2584. /**
  2585. * CBT_BUILD_ABANDONED is our flag value to represent a force-closed
  2586. * circuit (Aka a 'right-censored' pareto value).
  2587. */
  2588. #define CBT_BUILD_ABANDONED ((build_time_t)(INT32_MAX-1))
  2589. #define CBT_BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
  2590. /** Save state every 10 circuits */
  2591. #define CBT_SAVE_STATE_EVERY 10
  2592. /* Circuit Build Timeout network liveness constants */
  2593. /**
  2594. * Have we received a cell in the last N circ attempts?
  2595. *
  2596. * This tells us when to temporarily switch back to
  2597. * BUILD_TIMEOUT_INITIAL_VALUE until we start getting cells,
  2598. * at which point we switch back to computing the timeout from
  2599. * our saved history.
  2600. */
  2601. #define CBT_NETWORK_NONLIVE_TIMEOUT_COUNT 3
  2602. /**
  2603. * This tells us when to toss out the last streak of N timeouts.
  2604. *
  2605. * If instead we start getting cells, we switch back to computing the timeout
  2606. * from our saved history.
  2607. */
  2608. #define CBT_NETWORK_NONLIVE_DISCARD_COUNT (CBT_NETWORK_NONLIVE_TIMEOUT_COUNT*2)
  2609. /* Circuit build times consensus parameters */
  2610. /**
  2611. * How long to wait before actually closing circuits that take too long to
  2612. * build in terms of CDF quantile.
  2613. */
  2614. #define CBT_DEFAULT_CLOSE_QUANTILE 95
  2615. /**
  2616. * How many circuits count as recent when considering if the
  2617. * connection has gone gimpy or changed.
  2618. */
  2619. #define CBT_DEFAULT_RECENT_CIRCUITS 20
  2620. /**
  2621. * Maximum count of timeouts that finish the first hop in the past
  2622. * RECENT_CIRCUITS before calculating a new timeout.
  2623. *
  2624. * This tells us to abandon timeout history and set
  2625. * the timeout back to BUILD_TIMEOUT_INITIAL_VALUE.
  2626. */
  2627. #define CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT (CBT_DEFAULT_RECENT_CIRCUITS*9/10)
  2628. /** Minimum circuits before estimating a timeout */
  2629. #define CBT_DEFAULT_MIN_CIRCUITS_TO_OBSERVE 100
  2630. /** Cutoff percentile on the CDF for our timeout estimation. */
  2631. #define CBT_DEFAULT_QUANTILE_CUTOFF 80
  2632. double circuit_build_times_quantile_cutoff(void);
  2633. /** How often in seconds should we build a test circuit */
  2634. #define CBT_DEFAULT_TEST_FREQUENCY 60
  2635. /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
  2636. #define CBT_DEFAULT_TIMEOUT_MIN_VALUE (2*1000)
  2637. /** Initial circuit build timeout in milliseconds */
  2638. #define CBT_DEFAULT_TIMEOUT_INITIAL_VALUE (60*1000)
  2639. int32_t circuit_build_times_initial_timeout(void);
  2640. #if CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT < 1 || \
  2641. CBT_NETWORK_NONLIVE_DISCARD_COUNT < 1 || \
  2642. CBT_NETWORK_NONLIVE_TIMEOUT_COUNT < 1
  2643. #error "RECENT_CIRCUITS is set too low."
  2644. #endif
  2645. /** Information about the state of our local network connection */
  2646. typedef struct {
  2647. /** The timestamp we last completed a TLS handshake or received a cell */
  2648. time_t network_last_live;
  2649. /** If the network is not live, how many timeouts has this caused? */
  2650. int nonlive_timeouts;
  2651. /** If the network is not live, have we yet discarded our history? */
  2652. int nonlive_discarded;
  2653. /** Circular array of circuits that have made it to the first hop. Slot is
  2654. * 1 if circuit timed out, 0 if circuit succeeded */
  2655. int8_t *timeouts_after_firsthop;
  2656. /** Number of elements allocated for the above array */
  2657. int num_recent_circs;
  2658. /** Index into circular array. */
  2659. int after_firsthop_idx;
  2660. /** Timeout gathering is suspended if non-zero. The old timeout value
  2661. * is stored here in that case. */
  2662. double suspended_timeout;
  2663. /** Timeout gathering is suspended if non-zero. The old close value
  2664. * is stored here in that case. */
  2665. double suspended_close_timeout;
  2666. } network_liveness_t;
  2667. /** Structure for circuit build times history */
  2668. typedef struct {
  2669. /** The circular array of recorded build times in milliseconds */
  2670. build_time_t circuit_build_times[CBT_NCIRCUITS_TO_OBSERVE];
  2671. /** Current index in the circuit_build_times circular array */
  2672. int build_times_idx;
  2673. /** Total number of build times accumulated. Max CBT_NCIRCUITS_TO_OBSERVE */
  2674. int total_build_times;
  2675. /** Information about the state of our local network connection */
  2676. network_liveness_t liveness;
  2677. /** Last time we built a circuit. Used to decide to build new test circs */
  2678. time_t last_circ_at;
  2679. /** "Minimum" value of our pareto distribution (actually mode) */
  2680. build_time_t Xm;
  2681. /** alpha exponent for pareto dist. */
  2682. double alpha;
  2683. /** Have we computed a timeout? */
  2684. int have_computed_timeout;
  2685. /** The exact value for that timeout in milliseconds. Stored as a double
  2686. * to maintain precision from calculations to and from quantile value. */
  2687. double timeout_ms;
  2688. /** How long we wait before actually closing the circuit. */
  2689. double close_ms;
  2690. } circuit_build_times_t;
  2691. /********************************* config.c ***************************/
  2692. /** An error from options_trial_assign() or options_init_from_string(). */
  2693. typedef enum setopt_err_t {
  2694. SETOPT_OK = 0,
  2695. SETOPT_ERR_MISC = -1,
  2696. SETOPT_ERR_PARSE = -2,
  2697. SETOPT_ERR_TRANSITION = -3,
  2698. SETOPT_ERR_SETTING = -4,
  2699. } setopt_err_t;
  2700. /********************************* connection_edge.c *************************/
  2701. /** Enumerates possible origins of a client-side address mapping. */
  2702. typedef enum {
  2703. /** We're remapping this address because the controller told us to. */
  2704. ADDRMAPSRC_CONTROLLER,
  2705. /** We're remapping this address because our configuration (via torrc, the
  2706. * command line, or a SETCONF command) told us to. */
  2707. ADDRMAPSRC_TORRC,
  2708. /** We're remapping this address because we have TrackHostExit configured,
  2709. * and we want to remember to use the same exit next time. */
  2710. ADDRMAPSRC_TRACKEXIT,
  2711. /** We're remapping this address because we got a DNS resolution from a
  2712. * Tor server that told us what its value was. */
  2713. ADDRMAPSRC_DNS,
  2714. } addressmap_entry_source_t;
  2715. /********************************* control.c ***************************/
  2716. /** Used to indicate the type of a circuit event passed to the controller.
  2717. * The various types are defined in control-spec.txt */
  2718. typedef enum circuit_status_event_t {
  2719. CIRC_EVENT_LAUNCHED = 0,
  2720. CIRC_EVENT_BUILT = 1,
  2721. CIRC_EVENT_EXTENDED = 2,
  2722. CIRC_EVENT_FAILED = 3,
  2723. CIRC_EVENT_CLOSED = 4,
  2724. } circuit_status_event_t;
  2725. /** Used to indicate the type of a stream event passed to the controller.
  2726. * The various types are defined in control-spec.txt */
  2727. typedef enum stream_status_event_t {
  2728. STREAM_EVENT_SENT_CONNECT = 0,
  2729. STREAM_EVENT_SENT_RESOLVE = 1,
  2730. STREAM_EVENT_SUCCEEDED = 2,
  2731. STREAM_EVENT_FAILED = 3,
  2732. STREAM_EVENT_CLOSED = 4,
  2733. STREAM_EVENT_NEW = 5,
  2734. STREAM_EVENT_NEW_RESOLVE = 6,
  2735. STREAM_EVENT_FAILED_RETRIABLE = 7,
  2736. STREAM_EVENT_REMAP = 8
  2737. } stream_status_event_t;
  2738. /** Used to indicate the type of an OR connection event passed to the
  2739. * controller. The various types are defined in control-spec.txt */
  2740. typedef enum or_conn_status_event_t {
  2741. OR_CONN_EVENT_LAUNCHED = 0,
  2742. OR_CONN_EVENT_CONNECTED = 1,
  2743. OR_CONN_EVENT_FAILED = 2,
  2744. OR_CONN_EVENT_CLOSED = 3,
  2745. OR_CONN_EVENT_NEW = 4,
  2746. } or_conn_status_event_t;
  2747. /** Used to indicate the type of a buildtime event */
  2748. typedef enum buildtimeout_set_event_t {
  2749. BUILDTIMEOUT_SET_EVENT_COMPUTED = 0,
  2750. BUILDTIMEOUT_SET_EVENT_RESET = 1,
  2751. BUILDTIMEOUT_SET_EVENT_SUSPENDED = 2,
  2752. BUILDTIMEOUT_SET_EVENT_DISCARD = 3,
  2753. BUILDTIMEOUT_SET_EVENT_RESUME = 4
  2754. } buildtimeout_set_event_t;
  2755. /** Execute the statement <b>stmt</b>, which may log events concerning the
  2756. * connection <b>conn</b>. To prevent infinite loops, disable log messages
  2757. * being sent to controllers if <b>conn</b> is a control connection.
  2758. *
  2759. * Stmt must not contain any return or goto statements.
  2760. */
  2761. #define CONN_LOG_PROTECT(conn, stmt) \
  2762. STMT_BEGIN \
  2763. int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
  2764. if (_log_conn_is_control) \
  2765. disable_control_logging(); \
  2766. STMT_BEGIN stmt; STMT_END; \
  2767. if (_log_conn_is_control) \
  2768. enable_control_logging(); \
  2769. STMT_END
  2770. /** Enum describing various stages of bootstrapping, for use with controller
  2771. * bootstrap status events. The values range from 0 to 100. */
  2772. typedef enum {
  2773. BOOTSTRAP_STATUS_UNDEF=-1,
  2774. BOOTSTRAP_STATUS_STARTING=0,
  2775. BOOTSTRAP_STATUS_CONN_DIR=5,
  2776. BOOTSTRAP_STATUS_HANDSHAKE=-2,
  2777. BOOTSTRAP_STATUS_HANDSHAKE_DIR=10,
  2778. BOOTSTRAP_STATUS_ONEHOP_CREATE=15,
  2779. BOOTSTRAP_STATUS_REQUESTING_STATUS=20,
  2780. BOOTSTRAP_STATUS_LOADING_STATUS=25,
  2781. BOOTSTRAP_STATUS_LOADING_KEYS=40,
  2782. BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS=45,
  2783. BOOTSTRAP_STATUS_LOADING_DESCRIPTORS=50,
  2784. BOOTSTRAP_STATUS_CONN_OR=80,
  2785. BOOTSTRAP_STATUS_HANDSHAKE_OR=85,
  2786. BOOTSTRAP_STATUS_CIRCUIT_CREATE=90,
  2787. BOOTSTRAP_STATUS_DONE=100
  2788. } bootstrap_status_t;
  2789. /********************************* directory.c ***************************/
  2790. /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
  2791. typedef struct {
  2792. char first[DIGEST_LEN];
  2793. char second[DIGEST_LEN];
  2794. } fp_pair_t;
  2795. /********************************* dirserv.c ***************************/
  2796. typedef enum {
  2797. NS_V2, NS_V3_CONSENSUS, NS_V3_VOTE, NS_CONTROL_PORT,
  2798. NS_V3_CONSENSUS_MICRODESC
  2799. } routerstatus_format_type_t;
  2800. #ifdef DIRSERV_PRIVATE
  2801. typedef struct measured_bw_line_t {
  2802. char node_id[DIGEST_LEN];
  2803. char node_hex[MAX_HEX_NICKNAME_LEN+1];
  2804. long int bw;
  2805. } measured_bw_line_t;
  2806. #endif
  2807. /********************************* dirvote.c ************************/
  2808. /** Describes the schedule by which votes should be generated. */
  2809. typedef struct vote_timing_t {
  2810. int vote_interval;
  2811. int n_intervals_valid;
  2812. int vote_delay;
  2813. int dist_delay;
  2814. } vote_timing_t;
  2815. /********************************* geoip.c **************************/
  2816. /** Round all GeoIP results to the next multiple of this value, to avoid
  2817. * leaking information. */
  2818. #define DIR_RECORD_USAGE_GRANULARITY 8
  2819. /** Time interval: Flush geoip data to disk this often. */
  2820. #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
  2821. /** How long do we have to have observed per-country request history before
  2822. * we are willing to talk about it? */
  2823. #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
  2824. /** Indicates an action that we might be noting geoip statistics on.
  2825. * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
  2826. * the others, we're not.
  2827. */
  2828. typedef enum {
  2829. /** We've noticed a connection as a bridge relay or entry guard. */
  2830. GEOIP_CLIENT_CONNECT = 0,
  2831. /** We've served a networkstatus consensus as a directory server. */
  2832. GEOIP_CLIENT_NETWORKSTATUS = 1,
  2833. /** We've served a v2 networkstatus consensus as a directory server. */
  2834. GEOIP_CLIENT_NETWORKSTATUS_V2 = 2,
  2835. } geoip_client_action_t;
  2836. /** Indicates either a positive reply or a reason for rejectng a network
  2837. * status request that will be included in geoip statistics. */
  2838. typedef enum {
  2839. /** Request is answered successfully. */
  2840. GEOIP_SUCCESS = 0,
  2841. /** V3 network status is not signed by a sufficient number of requested
  2842. * authorities. */
  2843. GEOIP_REJECT_NOT_ENOUGH_SIGS = 1,
  2844. /** Requested network status object is unavailable. */
  2845. GEOIP_REJECT_UNAVAILABLE = 2,
  2846. /** Requested network status not found. */
  2847. GEOIP_REJECT_NOT_FOUND = 3,
  2848. /** Network status has not been modified since If-Modified-Since time. */
  2849. GEOIP_REJECT_NOT_MODIFIED = 4,
  2850. /** Directory is busy. */
  2851. GEOIP_REJECT_BUSY = 5,
  2852. } geoip_ns_response_t;
  2853. #define GEOIP_NS_RESPONSE_NUM 6
  2854. /** Directory requests that we are measuring can be either direct or
  2855. * tunneled. */
  2856. typedef enum {
  2857. DIRREQ_DIRECT = 0,
  2858. DIRREQ_TUNNELED = 1,
  2859. } dirreq_type_t;
  2860. /** Possible states for either direct or tunneled directory requests that
  2861. * are relevant for determining network status download times. */
  2862. typedef enum {
  2863. /** Found that the client requests a network status; applies to both
  2864. * direct and tunneled requests; initial state of a request that we are
  2865. * measuring. */
  2866. DIRREQ_IS_FOR_NETWORK_STATUS = 0,
  2867. /** Finished writing a network status to the directory connection;
  2868. * applies to both direct and tunneled requests; completes a direct
  2869. * request. */
  2870. DIRREQ_FLUSHING_DIR_CONN_FINISHED = 1,
  2871. /** END cell sent to circuit that initiated a tunneled request. */
  2872. DIRREQ_END_CELL_SENT = 2,
  2873. /** Flushed last cell from queue of the circuit that initiated a
  2874. * tunneled request to the outbuf of the OR connection. */
  2875. DIRREQ_CIRC_QUEUE_FLUSHED = 3,
  2876. /** Flushed last byte from buffer of the OR connection belonging to the
  2877. * circuit that initiated a tunneled request; completes a tunneled
  2878. * request. */
  2879. DIRREQ_OR_CONN_BUFFER_FLUSHED = 4
  2880. } dirreq_state_t;
  2881. #define WRITE_STATS_INTERVAL (24*60*60)
  2882. /********************************* microdesc.c *************************/
  2883. typedef struct microdesc_cache_t microdesc_cache_t;
  2884. /********************************* networkstatus.c *********************/
  2885. /** Location where we found a v2 networkstatus. */
  2886. typedef enum {
  2887. NS_FROM_CACHE, NS_FROM_DIR_BY_FP, NS_FROM_DIR_ALL, NS_GENERATED
  2888. } v2_networkstatus_source_t;
  2889. /** Possible statuses of a version of Tor, given opinions from the directory
  2890. * servers. */
  2891. typedef enum version_status_t {
  2892. VS_RECOMMENDED=0, /**< This version is listed as recommended. */
  2893. VS_OLD=1, /**< This version is older than any recommended version. */
  2894. VS_NEW=2, /**< This version is newer than any recommended version. */
  2895. VS_NEW_IN_SERIES=3, /**< This version is newer than any recommended version
  2896. * in its series, but later recommended versions exist.
  2897. */
  2898. VS_UNRECOMMENDED=4, /**< This version is not recommended (general case). */
  2899. VS_EMPTY=5, /**< The version list was empty; no agreed-on versions. */
  2900. VS_UNKNOWN, /**< We have no idea. */
  2901. } version_status_t;
  2902. /********************************* policies.c ************************/
  2903. /** Outcome of applying an address policy to an address. */
  2904. typedef enum {
  2905. /** The address was accepted */
  2906. ADDR_POLICY_ACCEPTED=0,
  2907. /** The address was rejected */
  2908. ADDR_POLICY_REJECTED=-1,
  2909. /** Part of the address was unknown, but as far as we can tell, it was
  2910. * accepted. */
  2911. ADDR_POLICY_PROBABLY_ACCEPTED=1,
  2912. /** Part of the address was unknown, but as far as we can tell, it was
  2913. * rejected. */
  2914. ADDR_POLICY_PROBABLY_REJECTED=2
  2915. } addr_policy_result_t;
  2916. /********************************* rephist.c ***************************/
  2917. /** Possible public/private key operations in Tor: used to keep track of where
  2918. * we're spending our time. */
  2919. typedef enum {
  2920. SIGN_DIR, SIGN_RTR,
  2921. VERIFY_DIR, VERIFY_RTR,
  2922. ENC_ONIONSKIN, DEC_ONIONSKIN,
  2923. TLS_HANDSHAKE_C, TLS_HANDSHAKE_S,
  2924. REND_CLIENT, REND_MID, REND_SERVER,
  2925. } pk_op_t;
  2926. /********************************* rendcommon.c ***************************/
  2927. /** Hidden-service side configuration of client authorization. */
  2928. typedef struct rend_authorized_client_t {
  2929. char *client_name;
  2930. char descriptor_cookie[REND_DESC_COOKIE_LEN];
  2931. crypto_pk_env_t *client_key;
  2932. } rend_authorized_client_t;
  2933. /** ASCII-encoded v2 hidden service descriptor. */
  2934. typedef struct rend_encoded_v2_service_descriptor_t {
  2935. char desc_id[DIGEST_LEN]; /**< Descriptor ID. */
  2936. char *desc_str; /**< Descriptor string. */
  2937. } rend_encoded_v2_service_descriptor_t;
  2938. /** Introduction point information. */
  2939. typedef struct rend_intro_point_t {
  2940. extend_info_t *extend_info; /**< Extend info of this introduction point. */
  2941. crypto_pk_env_t *intro_key; /**< Introduction key that replaces the service
  2942. * key, if this descriptor is V2. */
  2943. } rend_intro_point_t;
  2944. /** Information used to connect to a hidden service. */
  2945. typedef struct rend_service_descriptor_t {
  2946. crypto_pk_env_t *pk; /**< This service's public key. */
  2947. int version; /**< Version of the descriptor format: 0 or 2. */
  2948. time_t timestamp; /**< Time when the descriptor was generated. */
  2949. uint16_t protocols; /**< Bitmask: which rendezvous protocols are supported?
  2950. * (We allow bits '0', '1', and '2' to be set.) */
  2951. /** List of the service's introduction points. Elements are removed if
  2952. * introduction attempts fail. */
  2953. smartlist_t *intro_nodes;
  2954. /** Has descriptor been uploaded to all hidden service directories? */
  2955. int all_uploads_performed;
  2956. /** List of hidden service directories to which an upload request for
  2957. * this descriptor could be sent. Smartlist exists only when at least one
  2958. * of the previous upload requests failed (otherwise it's not important
  2959. * to know which uploads succeeded and which not). */
  2960. smartlist_t *successful_uploads;
  2961. } rend_service_descriptor_t;
  2962. /** A cached rendezvous descriptor. */
  2963. typedef struct rend_cache_entry_t {
  2964. size_t len; /**< Length of <b>desc</b> */
  2965. time_t received; /**< When was the descriptor received? */
  2966. char *desc; /**< Service descriptor */
  2967. rend_service_descriptor_t *parsed; /**< Parsed value of 'desc' */
  2968. } rend_cache_entry_t;
  2969. /********************************* routerlist.c ***************************/
  2970. /** Represents information about a single trusted directory server. */
  2971. typedef struct trusted_dir_server_t {
  2972. char *description;
  2973. char *nickname;
  2974. char *address; /**< Hostname. */
  2975. uint32_t addr; /**< IPv4 address. */
  2976. uint16_t dir_port; /**< Directory port. */
  2977. uint16_t or_port; /**< OR port: Used for tunneling connections. */
  2978. char digest[DIGEST_LEN]; /**< Digest of identity key. */
  2979. char v3_identity_digest[DIGEST_LEN]; /**< Digest of v3 (authority only,
  2980. * high-security) identity key. */
  2981. unsigned int is_running:1; /**< True iff we think this server is running. */
  2982. /** True iff this server has accepted the most recent server descriptor
  2983. * we tried to upload to it. */
  2984. unsigned int has_accepted_serverdesc:1;
  2985. /** What kind of authority is this? (Bitfield.) */
  2986. authority_type_t type;
  2987. download_status_t v2_ns_dl_status; /**< Status of downloading this server's
  2988. * v2 network status. */
  2989. time_t addr_current_at; /**< When was the document that we derived the
  2990. * address information from published? */
  2991. routerstatus_t fake_status; /**< Used when we need to pass this trusted
  2992. * dir_server_t to directory_initiate_command_*
  2993. * as a routerstatus_t. Not updated by the
  2994. * router-status management code!
  2995. **/
  2996. } trusted_dir_server_t;
  2997. #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
  2998. #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
  2999. /* Flags for pick_directory_server and pick_trusteddirserver. */
  3000. /** Flag to indicate that we should not automatically be willing to use
  3001. * ourself to answer a directory request.
  3002. * Passed to router_pick_directory_server (et al).*/
  3003. #define PDS_ALLOW_SELF (1<<0)
  3004. /** Flag to indicate that if no servers seem to be up, we should mark all
  3005. * directory servers as up and try again.
  3006. * Passed to router_pick_directory_server (et al).*/
  3007. #define PDS_RETRY_IF_NO_SERVERS (1<<1)
  3008. /** Flag to indicate that we should not exclude directory servers that
  3009. * our ReachableAddress settings would exclude. This usually means that
  3010. * we're going to connect to the server over Tor, and so we don't need to
  3011. * worry about our firewall telling us we can't.
  3012. * Passed to router_pick_directory_server (et al).*/
  3013. #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
  3014. /** Flag to indicate that we should not use any directory authority to which
  3015. * we have an existing directory connection for downloading server descriptors
  3016. * or extrainfo documents.
  3017. *
  3018. * Passed to router_pick_directory_server (et al)
  3019. *
  3020. * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
  3021. * not pick_directory_server. If we make it work on pick_directory_server
  3022. * too, we could conservatively make it only prevent multiple fetches to
  3023. * the same authority, or we could aggressively make it prevent multiple
  3024. * fetches to _any_ single directory server.]
  3025. */
  3026. #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
  3027. #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
  3028. /** Possible ways to weight routers when choosing one randomly. See
  3029. * routerlist_sl_choose_by_bandwidth() for more information.*/
  3030. typedef enum bandwidth_weight_rule_t {
  3031. NO_WEIGHTING, WEIGHT_FOR_EXIT, WEIGHT_FOR_MID, WEIGHT_FOR_GUARD,
  3032. WEIGHT_FOR_DIR
  3033. } bandwidth_weight_rule_t;
  3034. /** Flags to be passed to control router_choose_random_node() to indicate what
  3035. * kind of nodes to pick according to what algorithm. */
  3036. typedef enum {
  3037. CRN_NEED_UPTIME = 1<<0,
  3038. CRN_NEED_CAPACITY = 1<<1,
  3039. CRN_NEED_GUARD = 1<<2,
  3040. CRN_ALLOW_INVALID = 1<<3,
  3041. /* XXXX not used, apparently. */
  3042. CRN_WEIGHT_AS_EXIT = 1<<5
  3043. } router_crn_flags_t;
  3044. /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
  3045. typedef enum was_router_added_t {
  3046. ROUTER_ADDED_SUCCESSFULLY = 1,
  3047. ROUTER_ADDED_NOTIFY_GENERATOR = 0,
  3048. ROUTER_BAD_EI = -1,
  3049. ROUTER_WAS_NOT_NEW = -2,
  3050. ROUTER_NOT_IN_CONSENSUS = -3,
  3051. ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS = -4,
  3052. ROUTER_AUTHDIR_REJECTS = -5,
  3053. } was_router_added_t;
  3054. /********************************* routerparse.c ************************/
  3055. #define MAX_STATUS_TAG_LEN 32
  3056. /** Structure to hold parsed Tor versions. This is a little messier
  3057. * than we would like it to be, because we changed version schemes with 0.1.0.
  3058. *
  3059. * See version-spec.txt for the whole business.
  3060. */
  3061. typedef struct tor_version_t {
  3062. int major;
  3063. int minor;
  3064. int micro;
  3065. /** Release status. For version in the post-0.1 format, this is always
  3066. * VER_RELEASE. */
  3067. enum { VER_PRE=0, VER_RC=1, VER_RELEASE=2, } status;
  3068. int patchlevel;
  3069. char status_tag[MAX_STATUS_TAG_LEN];
  3070. int svn_revision;
  3071. int git_tag_len;
  3072. char git_tag[DIGEST_LEN];
  3073. } tor_version_t;
  3074. #endif