policies.c 109 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141
  1. /* Copyright (c) 2001-2004, Roger Dingledine.
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2017, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. /**
  6. * \file policies.c
  7. * \brief Code to parse and use address policies and exit policies.
  8. *
  9. * We have two key kinds of address policy: full and compressed. A full
  10. * policy is an array of accept/reject patterns, to be applied in order.
  11. * A short policy is simply a list of ports. This module handles both
  12. * kinds, including generic functions to apply them to addresses, and
  13. * also including code to manage the global policies that we apply to
  14. * incoming and outgoing connections.
  15. **/
  16. #define POLICIES_PRIVATE
  17. #include "or.h"
  18. #include "bridges.h"
  19. #include "config.h"
  20. #include "dirserv.h"
  21. #include "microdesc.h"
  22. #include "networkstatus.h"
  23. #include "nodelist.h"
  24. #include "policies.h"
  25. #include "router.h"
  26. #include "routerparse.h"
  27. #include "geoip.h"
  28. #include "ht.h"
  29. #include "port_cfg_st.h"
  30. /** Policy that addresses for incoming SOCKS connections must match. */
  31. static smartlist_t *socks_policy = NULL;
  32. /** Policy that addresses for incoming directory connections must match. */
  33. static smartlist_t *dir_policy = NULL;
  34. /** Policy that addresses for incoming router descriptors must match in order
  35. * to be published by us. */
  36. static smartlist_t *authdir_reject_policy = NULL;
  37. /** Policy that addresses for incoming router descriptors must match in order
  38. * to be marked as valid in our networkstatus. */
  39. static smartlist_t *authdir_invalid_policy = NULL;
  40. /** Policy that addresses for incoming router descriptors must <b>not</b>
  41. * match in order to not be marked as BadExit. */
  42. static smartlist_t *authdir_badexit_policy = NULL;
  43. /** Parsed addr_policy_t describing which addresses we believe we can start
  44. * circuits at. */
  45. static smartlist_t *reachable_or_addr_policy = NULL;
  46. /** Parsed addr_policy_t describing which addresses we believe we can connect
  47. * to directories at. */
  48. static smartlist_t *reachable_dir_addr_policy = NULL;
  49. /** Element of an exit policy summary */
  50. typedef struct policy_summary_item_t {
  51. uint16_t prt_min; /**< Lowest port number to accept/reject. */
  52. uint16_t prt_max; /**< Highest port number to accept/reject. */
  53. uint64_t reject_count; /**< Number of IP-Addresses that are rejected to
  54. this port range. */
  55. unsigned int accepted:1; /** Has this port already been accepted */
  56. } policy_summary_item_t;
  57. /** Private networks. This list is used in two places, once to expand the
  58. * "private" keyword when parsing our own exit policy, secondly to ignore
  59. * just such networks when building exit policy summaries. It is important
  60. * that all authorities agree on that list when creating summaries, so don't
  61. * just change this without a proper migration plan and a proposal and stuff.
  62. */
  63. static const char *private_nets[] = {
  64. "0.0.0.0/8", "169.254.0.0/16",
  65. "127.0.0.0/8", "192.168.0.0/16", "10.0.0.0/8", "172.16.0.0/12",
  66. "[::]/8",
  67. "[fc00::]/7", "[fe80::]/10", "[fec0::]/10", "[ff00::]/8", "[::]/127",
  68. NULL
  69. };
  70. static int policies_parse_exit_policy_internal(
  71. config_line_t *cfg,
  72. smartlist_t **dest,
  73. int ipv6_exit,
  74. int rejectprivate,
  75. const smartlist_t *configured_addresses,
  76. int reject_interface_addresses,
  77. int reject_configured_port_addresses,
  78. int add_default_policy,
  79. int add_reduced_policy);
  80. /** Replace all "private" entries in *<b>policy</b> with their expanded
  81. * equivalents. */
  82. void
  83. policy_expand_private(smartlist_t **policy)
  84. {
  85. uint16_t port_min, port_max;
  86. int i;
  87. smartlist_t *tmp;
  88. if (!*policy) /*XXXX disallow NULL policies? */
  89. return;
  90. tmp = smartlist_new();
  91. SMARTLIST_FOREACH_BEGIN(*policy, addr_policy_t *, p) {
  92. if (! p->is_private) {
  93. smartlist_add(tmp, p);
  94. continue;
  95. }
  96. for (i = 0; private_nets[i]; ++i) {
  97. addr_policy_t newpolicy;
  98. memcpy(&newpolicy, p, sizeof(addr_policy_t));
  99. newpolicy.is_private = 0;
  100. newpolicy.is_canonical = 0;
  101. if (tor_addr_parse_mask_ports(private_nets[i], 0,
  102. &newpolicy.addr,
  103. &newpolicy.maskbits, &port_min, &port_max)<0) {
  104. tor_assert_unreached();
  105. }
  106. smartlist_add(tmp, addr_policy_get_canonical_entry(&newpolicy));
  107. }
  108. addr_policy_free(p);
  109. } SMARTLIST_FOREACH_END(p);
  110. smartlist_free(*policy);
  111. *policy = tmp;
  112. }
  113. /** Expand each of the AF_UNSPEC elements in *<b>policy</b> (which indicate
  114. * protocol-neutral wildcards) into a pair of wildcard elements: one IPv4-
  115. * specific and one IPv6-specific. */
  116. void
  117. policy_expand_unspec(smartlist_t **policy)
  118. {
  119. smartlist_t *tmp;
  120. if (!*policy)
  121. return;
  122. tmp = smartlist_new();
  123. SMARTLIST_FOREACH_BEGIN(*policy, addr_policy_t *, p) {
  124. sa_family_t family = tor_addr_family(&p->addr);
  125. if (family == AF_INET6 || family == AF_INET || p->is_private) {
  126. smartlist_add(tmp, p);
  127. } else if (family == AF_UNSPEC) {
  128. addr_policy_t newpolicy_ipv4;
  129. addr_policy_t newpolicy_ipv6;
  130. memcpy(&newpolicy_ipv4, p, sizeof(addr_policy_t));
  131. memcpy(&newpolicy_ipv6, p, sizeof(addr_policy_t));
  132. newpolicy_ipv4.is_canonical = 0;
  133. newpolicy_ipv6.is_canonical = 0;
  134. if (p->maskbits != 0) {
  135. log_warn(LD_BUG, "AF_UNSPEC policy with maskbits==%d", p->maskbits);
  136. newpolicy_ipv4.maskbits = 0;
  137. newpolicy_ipv6.maskbits = 0;
  138. }
  139. tor_addr_from_ipv4h(&newpolicy_ipv4.addr, 0);
  140. tor_addr_from_ipv6_bytes(&newpolicy_ipv6.addr,
  141. "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0");
  142. smartlist_add(tmp, addr_policy_get_canonical_entry(&newpolicy_ipv4));
  143. smartlist_add(tmp, addr_policy_get_canonical_entry(&newpolicy_ipv6));
  144. addr_policy_free(p);
  145. } else {
  146. log_warn(LD_BUG, "Funny-looking address policy with family %d", family);
  147. smartlist_add(tmp, p);
  148. }
  149. } SMARTLIST_FOREACH_END(p);
  150. smartlist_free(*policy);
  151. *policy = tmp;
  152. }
  153. /**
  154. * Given a linked list of config lines containing "accept[6]" and "reject[6]"
  155. * tokens, parse them and append the result to <b>dest</b>. Return -1
  156. * if any tokens are malformed (and don't append any), else return 0.
  157. *
  158. * If <b>assume_action</b> is nonnegative, then insert its action
  159. * (ADDR_POLICY_ACCEPT or ADDR_POLICY_REJECT) for items that specify no
  160. * action.
  161. */
  162. static int
  163. parse_addr_policy(config_line_t *cfg, smartlist_t **dest,
  164. int assume_action)
  165. {
  166. smartlist_t *result;
  167. smartlist_t *entries;
  168. addr_policy_t *item;
  169. int malformed_list;
  170. int r = 0;
  171. if (!cfg)
  172. return 0;
  173. result = smartlist_new();
  174. entries = smartlist_new();
  175. for (; cfg; cfg = cfg->next) {
  176. smartlist_split_string(entries, cfg->value, ",",
  177. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
  178. SMARTLIST_FOREACH_BEGIN(entries, const char *, ent) {
  179. log_debug(LD_CONFIG,"Adding new entry '%s'",ent);
  180. malformed_list = 0;
  181. item = router_parse_addr_policy_item_from_string(ent, assume_action,
  182. &malformed_list);
  183. if (item) {
  184. smartlist_add(result, item);
  185. } else if (malformed_list) {
  186. /* the error is so severe the entire list should be discarded */
  187. log_warn(LD_CONFIG, "Malformed policy '%s'. Discarding entire policy "
  188. "list.", ent);
  189. r = -1;
  190. } else {
  191. /* the error is minor: don't add the item, but keep processing the
  192. * rest of the policies in the list */
  193. log_debug(LD_CONFIG, "Ignored policy '%s' due to non-fatal error. "
  194. "The remainder of the policy list will be used.",
  195. ent);
  196. }
  197. } SMARTLIST_FOREACH_END(ent);
  198. SMARTLIST_FOREACH(entries, char *, ent, tor_free(ent));
  199. smartlist_clear(entries);
  200. }
  201. smartlist_free(entries);
  202. if (r == -1) {
  203. addr_policy_list_free(result);
  204. } else {
  205. policy_expand_private(&result);
  206. policy_expand_unspec(&result);
  207. if (*dest) {
  208. smartlist_add_all(*dest, result);
  209. smartlist_free(result);
  210. } else {
  211. *dest = result;
  212. }
  213. }
  214. return r;
  215. }
  216. /** Helper: parse the Reachable(Dir|OR)?Addresses fields into
  217. * reachable_(or|dir)_addr_policy. The options should already have
  218. * been validated by validate_addr_policies.
  219. */
  220. static int
  221. parse_reachable_addresses(void)
  222. {
  223. const or_options_t *options = get_options();
  224. int ret = 0;
  225. if (options->ReachableDirAddresses &&
  226. options->ReachableORAddresses &&
  227. options->ReachableAddresses) {
  228. log_warn(LD_CONFIG,
  229. "Both ReachableDirAddresses and ReachableORAddresses are set. "
  230. "ReachableAddresses setting will be ignored.");
  231. }
  232. addr_policy_list_free(reachable_or_addr_policy);
  233. reachable_or_addr_policy = NULL;
  234. if (!options->ReachableORAddresses && options->ReachableAddresses)
  235. log_info(LD_CONFIG,
  236. "Using ReachableAddresses as ReachableORAddresses.");
  237. if (parse_addr_policy(options->ReachableORAddresses ?
  238. options->ReachableORAddresses :
  239. options->ReachableAddresses,
  240. &reachable_or_addr_policy, ADDR_POLICY_ACCEPT)) {
  241. log_warn(LD_CONFIG,
  242. "Error parsing Reachable%sAddresses entry; ignoring.",
  243. options->ReachableORAddresses ? "OR" : "");
  244. ret = -1;
  245. }
  246. addr_policy_list_free(reachable_dir_addr_policy);
  247. reachable_dir_addr_policy = NULL;
  248. if (!options->ReachableDirAddresses && options->ReachableAddresses)
  249. log_info(LD_CONFIG,
  250. "Using ReachableAddresses as ReachableDirAddresses");
  251. if (parse_addr_policy(options->ReachableDirAddresses ?
  252. options->ReachableDirAddresses :
  253. options->ReachableAddresses,
  254. &reachable_dir_addr_policy, ADDR_POLICY_ACCEPT)) {
  255. if (options->ReachableDirAddresses)
  256. log_warn(LD_CONFIG,
  257. "Error parsing ReachableDirAddresses entry; ignoring.");
  258. ret = -1;
  259. }
  260. /* We ignore ReachableAddresses for relays */
  261. if (!server_mode(options)) {
  262. if (policy_is_reject_star(reachable_or_addr_policy, AF_UNSPEC, 0)
  263. || policy_is_reject_star(reachable_dir_addr_policy, AF_UNSPEC,0)) {
  264. log_warn(LD_CONFIG, "Tor cannot connect to the Internet if "
  265. "ReachableAddresses, ReachableORAddresses, or "
  266. "ReachableDirAddresses reject all addresses. Please accept "
  267. "some addresses in these options.");
  268. } else if (options->ClientUseIPv4 == 1
  269. && (policy_is_reject_star(reachable_or_addr_policy, AF_INET, 0)
  270. || policy_is_reject_star(reachable_dir_addr_policy, AF_INET, 0))) {
  271. log_warn(LD_CONFIG, "You have set ClientUseIPv4 1, but "
  272. "ReachableAddresses, ReachableORAddresses, or "
  273. "ReachableDirAddresses reject all IPv4 addresses. "
  274. "Tor will not connect using IPv4.");
  275. } else if (fascist_firewall_use_ipv6(options)
  276. && (policy_is_reject_star(reachable_or_addr_policy, AF_INET6, 0)
  277. || policy_is_reject_star(reachable_dir_addr_policy, AF_INET6, 0))) {
  278. log_warn(LD_CONFIG, "You have configured tor to use or prefer IPv6 "
  279. "(or UseBridges 1), but "
  280. "ReachableAddresses, ReachableORAddresses, or "
  281. "ReachableDirAddresses reject all IPv6 addresses. "
  282. "Tor will not connect using IPv6.");
  283. }
  284. }
  285. return ret;
  286. }
  287. /* Return true iff ClientUseIPv4 0 or ClientUseIPv6 0 might block any OR or Dir
  288. * address:port combination. */
  289. static int
  290. firewall_is_fascist_impl(void)
  291. {
  292. const or_options_t *options = get_options();
  293. /* Assume every non-bridge relay has an IPv4 address.
  294. * Clients which use bridges may only know the IPv6 address of their
  295. * bridge, but they will connect regardless of the ClientUseIPv6 setting. */
  296. return options->ClientUseIPv4 == 0;
  297. }
  298. /** Return true iff the firewall options, including ClientUseIPv4 0 and
  299. * ClientUseIPv6 0, might block any OR address:port combination.
  300. * Address preferences may still change which address is selected even if
  301. * this function returns false.
  302. */
  303. int
  304. firewall_is_fascist_or(void)
  305. {
  306. return (reachable_or_addr_policy != NULL || firewall_is_fascist_impl());
  307. }
  308. /** Return true iff the firewall options, including ClientUseIPv4 0 and
  309. * ClientUseIPv6 0, might block any Dir address:port combination.
  310. * Address preferences may still change which address is selected even if
  311. * this function returns false.
  312. */
  313. int
  314. firewall_is_fascist_dir(void)
  315. {
  316. return (reachable_dir_addr_policy != NULL || firewall_is_fascist_impl());
  317. }
  318. /** Return true iff <b>policy</b> (possibly NULL) will allow a
  319. * connection to <b>addr</b>:<b>port</b>.
  320. */
  321. static int
  322. addr_policy_permits_tor_addr(const tor_addr_t *addr, uint16_t port,
  323. smartlist_t *policy)
  324. {
  325. addr_policy_result_t p;
  326. p = compare_tor_addr_to_addr_policy(addr, port, policy);
  327. switch (p) {
  328. case ADDR_POLICY_PROBABLY_ACCEPTED:
  329. case ADDR_POLICY_ACCEPTED:
  330. return 1;
  331. case ADDR_POLICY_PROBABLY_REJECTED:
  332. case ADDR_POLICY_REJECTED:
  333. return 0;
  334. default:
  335. log_warn(LD_BUG, "Unexpected result: %d", (int)p);
  336. return 0;
  337. }
  338. }
  339. /** Return true iff <b> policy</b> (possibly NULL) will allow a connection to
  340. * <b>addr</b>:<b>port</b>. <b>addr</b> is an IPv4 address given in host
  341. * order. */
  342. /* XXXX deprecate when possible. */
  343. static int
  344. addr_policy_permits_address(uint32_t addr, uint16_t port,
  345. smartlist_t *policy)
  346. {
  347. tor_addr_t a;
  348. tor_addr_from_ipv4h(&a, addr);
  349. return addr_policy_permits_tor_addr(&a, port, policy);
  350. }
  351. /** Return true iff we think our firewall will let us make a connection to
  352. * addr:port.
  353. *
  354. * If we are configured as a server, ignore any address family preference and
  355. * just use IPv4.
  356. * Otherwise:
  357. * - return false for all IPv4 addresses:
  358. * - if ClientUseIPv4 is 0, or
  359. * if pref_only and pref_ipv6 are both true;
  360. * - return false for all IPv6 addresses:
  361. * - if fascist_firewall_use_ipv6() is 0, or
  362. * - if pref_only is true and pref_ipv6 is false.
  363. *
  364. * Return false if addr is NULL or tor_addr_is_null(), or if port is 0. */
  365. STATIC int
  366. fascist_firewall_allows_address(const tor_addr_t *addr,
  367. uint16_t port,
  368. smartlist_t *firewall_policy,
  369. int pref_only, int pref_ipv6)
  370. {
  371. const or_options_t *options = get_options();
  372. const int client_mode = !server_mode(options);
  373. if (!addr || tor_addr_is_null(addr) || !port) {
  374. return 0;
  375. }
  376. /* Clients stop using IPv4 if it's disabled. In most cases, clients also
  377. * stop using IPv4 if it's not preferred.
  378. * Servers must have IPv4 enabled and preferred. */
  379. if (tor_addr_family(addr) == AF_INET && client_mode &&
  380. (!options->ClientUseIPv4 || (pref_only && pref_ipv6))) {
  381. return 0;
  382. }
  383. /* Clients and Servers won't use IPv6 unless it's enabled (and in most
  384. * cases, IPv6 must also be preferred before it will be used). */
  385. if (tor_addr_family(addr) == AF_INET6 &&
  386. (!fascist_firewall_use_ipv6(options) || (pref_only && !pref_ipv6))) {
  387. return 0;
  388. }
  389. return addr_policy_permits_tor_addr(addr, port,
  390. firewall_policy);
  391. }
  392. /** Is this client configured to use IPv6?
  393. * Returns true if the client might use IPv6 for some of its connections
  394. * (including dual-stack and IPv6-only clients), and false if it will never
  395. * use IPv6 for any connections.
  396. * Use node_ipv6_or/dir_preferred() when checking a specific node and OR/Dir
  397. * port: it supports bridge client per-node IPv6 preferences.
  398. */
  399. int
  400. fascist_firewall_use_ipv6(const or_options_t *options)
  401. {
  402. /* Clients use IPv6 if it's set, or they use bridges, or they don't use
  403. * IPv4, or they prefer it.
  404. * ClientPreferIPv6DirPort is deprecated, but check it anyway. */
  405. return (options->ClientUseIPv6 == 1 || options->ClientUseIPv4 == 0 ||
  406. options->ClientPreferIPv6ORPort == 1 ||
  407. options->ClientPreferIPv6DirPort == 1 || options->UseBridges == 1);
  408. }
  409. /** Do we prefer to connect to IPv6, ignoring ClientPreferIPv6ORPort and
  410. * ClientPreferIPv6DirPort?
  411. * If we're unsure, return -1, otherwise, return 1 for IPv6 and 0 for IPv4.
  412. */
  413. static int
  414. fascist_firewall_prefer_ipv6_impl(const or_options_t *options)
  415. {
  416. /*
  417. Cheap implementation of config options ClientUseIPv4 & ClientUseIPv6 --
  418. If we're a server or IPv6 is disabled, use IPv4.
  419. If IPv4 is disabled, use IPv6.
  420. */
  421. if (server_mode(options) || !fascist_firewall_use_ipv6(options)) {
  422. return 0;
  423. }
  424. if (!options->ClientUseIPv4) {
  425. return 1;
  426. }
  427. return -1;
  428. }
  429. /** Do we prefer to connect to IPv6 ORPorts?
  430. * Use node_ipv6_or_preferred() whenever possible: it supports bridge client
  431. * per-node IPv6 preferences.
  432. */
  433. int
  434. fascist_firewall_prefer_ipv6_orport(const or_options_t *options)
  435. {
  436. int pref_ipv6 = fascist_firewall_prefer_ipv6_impl(options);
  437. if (pref_ipv6 >= 0) {
  438. return pref_ipv6;
  439. }
  440. /* We can use both IPv4 and IPv6 - which do we prefer? */
  441. if (options->ClientPreferIPv6ORPort == 1) {
  442. return 1;
  443. }
  444. return 0;
  445. }
  446. /** Do we prefer to connect to IPv6 DirPorts?
  447. *
  448. * (node_ipv6_dir_preferred() doesn't support bridge client per-node IPv6
  449. * preferences. There's no reason to use it instead of this function.)
  450. */
  451. int
  452. fascist_firewall_prefer_ipv6_dirport(const or_options_t *options)
  453. {
  454. int pref_ipv6 = fascist_firewall_prefer_ipv6_impl(options);
  455. if (pref_ipv6 >= 0) {
  456. return pref_ipv6;
  457. }
  458. /* We can use both IPv4 and IPv6 - which do we prefer? */
  459. if (options->ClientPreferIPv6DirPort == 1) {
  460. return 1;
  461. }
  462. return 0;
  463. }
  464. /** Return true iff we think our firewall will let us make a connection to
  465. * addr:port. Uses ReachableORAddresses or ReachableDirAddresses based on
  466. * fw_connection.
  467. * If pref_only is true, return true if addr is in the client's preferred
  468. * address family, which is IPv6 if pref_ipv6 is true, and IPv4 otherwise.
  469. * If pref_only is false, ignore pref_ipv6, and return true if addr is allowed.
  470. */
  471. int
  472. fascist_firewall_allows_address_addr(const tor_addr_t *addr, uint16_t port,
  473. firewall_connection_t fw_connection,
  474. int pref_only, int pref_ipv6)
  475. {
  476. if (fw_connection == FIREWALL_OR_CONNECTION) {
  477. return fascist_firewall_allows_address(addr, port,
  478. reachable_or_addr_policy,
  479. pref_only, pref_ipv6);
  480. } else if (fw_connection == FIREWALL_DIR_CONNECTION) {
  481. return fascist_firewall_allows_address(addr, port,
  482. reachable_dir_addr_policy,
  483. pref_only, pref_ipv6);
  484. } else {
  485. log_warn(LD_BUG, "Bad firewall_connection_t value %d.",
  486. fw_connection);
  487. return 0;
  488. }
  489. }
  490. /** Return true iff we think our firewall will let us make a connection to
  491. * addr:port (ap). Uses ReachableORAddresses or ReachableDirAddresses based on
  492. * fw_connection.
  493. * pref_only and pref_ipv6 work as in fascist_firewall_allows_address_addr().
  494. */
  495. static int
  496. fascist_firewall_allows_address_ap(const tor_addr_port_t *ap,
  497. firewall_connection_t fw_connection,
  498. int pref_only, int pref_ipv6)
  499. {
  500. tor_assert(ap);
  501. return fascist_firewall_allows_address_addr(&ap->addr, ap->port,
  502. fw_connection, pref_only,
  503. pref_ipv6);
  504. }
  505. /* Return true iff we think our firewall will let us make a connection to
  506. * ipv4h_or_addr:ipv4_or_port. ipv4h_or_addr is interpreted in host order.
  507. * Uses ReachableORAddresses or ReachableDirAddresses based on
  508. * fw_connection.
  509. * pref_only and pref_ipv6 work as in fascist_firewall_allows_address_addr().
  510. */
  511. static int
  512. fascist_firewall_allows_address_ipv4h(uint32_t ipv4h_or_addr,
  513. uint16_t ipv4_or_port,
  514. firewall_connection_t fw_connection,
  515. int pref_only, int pref_ipv6)
  516. {
  517. tor_addr_t ipv4_or_addr;
  518. tor_addr_from_ipv4h(&ipv4_or_addr, ipv4h_or_addr);
  519. return fascist_firewall_allows_address_addr(&ipv4_or_addr, ipv4_or_port,
  520. fw_connection, pref_only,
  521. pref_ipv6);
  522. }
  523. /** Return true iff we think our firewall will let us make a connection to
  524. * ipv4h_addr/ipv6_addr. Uses ipv4_orport/ipv6_orport/ReachableORAddresses or
  525. * ipv4_dirport/ipv6_dirport/ReachableDirAddresses based on IPv4/IPv6 and
  526. * <b>fw_connection</b>.
  527. * pref_only and pref_ipv6 work as in fascist_firewall_allows_address_addr().
  528. */
  529. static int
  530. fascist_firewall_allows_base(uint32_t ipv4h_addr, uint16_t ipv4_orport,
  531. uint16_t ipv4_dirport,
  532. const tor_addr_t *ipv6_addr, uint16_t ipv6_orport,
  533. uint16_t ipv6_dirport,
  534. firewall_connection_t fw_connection,
  535. int pref_only, int pref_ipv6)
  536. {
  537. if (fascist_firewall_allows_address_ipv4h(ipv4h_addr,
  538. (fw_connection == FIREWALL_OR_CONNECTION
  539. ? ipv4_orport
  540. : ipv4_dirport),
  541. fw_connection,
  542. pref_only, pref_ipv6)) {
  543. return 1;
  544. }
  545. if (fascist_firewall_allows_address_addr(ipv6_addr,
  546. (fw_connection == FIREWALL_OR_CONNECTION
  547. ? ipv6_orport
  548. : ipv6_dirport),
  549. fw_connection,
  550. pref_only, pref_ipv6)) {
  551. return 1;
  552. }
  553. return 0;
  554. }
  555. /** Like fascist_firewall_allows_base(), but takes ri. */
  556. static int
  557. fascist_firewall_allows_ri_impl(const routerinfo_t *ri,
  558. firewall_connection_t fw_connection,
  559. int pref_only, int pref_ipv6)
  560. {
  561. if (!ri) {
  562. return 0;
  563. }
  564. /* Assume IPv4 and IPv6 DirPorts are the same */
  565. return fascist_firewall_allows_base(ri->addr, ri->or_port, ri->dir_port,
  566. &ri->ipv6_addr, ri->ipv6_orport,
  567. ri->dir_port, fw_connection, pref_only,
  568. pref_ipv6);
  569. }
  570. /** Like fascist_firewall_allows_rs, but takes pref_ipv6. */
  571. static int
  572. fascist_firewall_allows_rs_impl(const routerstatus_t *rs,
  573. firewall_connection_t fw_connection,
  574. int pref_only, int pref_ipv6)
  575. {
  576. if (!rs) {
  577. return 0;
  578. }
  579. /* Assume IPv4 and IPv6 DirPorts are the same */
  580. return fascist_firewall_allows_base(rs->addr, rs->or_port, rs->dir_port,
  581. &rs->ipv6_addr, rs->ipv6_orport,
  582. rs->dir_port, fw_connection, pref_only,
  583. pref_ipv6);
  584. }
  585. /** Like fascist_firewall_allows_base(), but takes rs.
  586. * When rs is a fake_status from a dir_server_t, it can have a reachable
  587. * address, even when the corresponding node does not.
  588. * nodes can be missing addresses when there's no consensus (IPv4 and IPv6),
  589. * or when there is a microdescriptor consensus, but no microdescriptors
  590. * (microdescriptors have IPv6, the microdesc consensus does not). */
  591. int
  592. fascist_firewall_allows_rs(const routerstatus_t *rs,
  593. firewall_connection_t fw_connection, int pref_only)
  594. {
  595. if (!rs) {
  596. return 0;
  597. }
  598. /* We don't have access to the node-specific IPv6 preference, so use the
  599. * generic IPv6 preference instead. */
  600. const or_options_t *options = get_options();
  601. int pref_ipv6 = (fw_connection == FIREWALL_OR_CONNECTION
  602. ? fascist_firewall_prefer_ipv6_orport(options)
  603. : fascist_firewall_prefer_ipv6_dirport(options));
  604. return fascist_firewall_allows_rs_impl(rs, fw_connection, pref_only,
  605. pref_ipv6);
  606. }
  607. /** Return true iff we think our firewall will let us make a connection to
  608. * ipv6_addr:ipv6_orport based on ReachableORAddresses.
  609. * If <b>fw_connection</b> is FIREWALL_DIR_CONNECTION, returns 0.
  610. * pref_only and pref_ipv6 work as in fascist_firewall_allows_address_addr().
  611. */
  612. static int
  613. fascist_firewall_allows_md_impl(const microdesc_t *md,
  614. firewall_connection_t fw_connection,
  615. int pref_only, int pref_ipv6)
  616. {
  617. if (!md) {
  618. return 0;
  619. }
  620. /* Can't check dirport, it doesn't have one */
  621. if (fw_connection == FIREWALL_DIR_CONNECTION) {
  622. return 0;
  623. }
  624. /* Also can't check IPv4, doesn't have that either */
  625. return fascist_firewall_allows_address_addr(&md->ipv6_addr, md->ipv6_orport,
  626. fw_connection, pref_only,
  627. pref_ipv6);
  628. }
  629. /** Like fascist_firewall_allows_base(), but takes node, and looks up pref_ipv6
  630. * from node_ipv6_or/dir_preferred(). */
  631. int
  632. fascist_firewall_allows_node(const node_t *node,
  633. firewall_connection_t fw_connection,
  634. int pref_only)
  635. {
  636. if (!node) {
  637. return 0;
  638. }
  639. node_assert_ok(node);
  640. const int pref_ipv6 = (fw_connection == FIREWALL_OR_CONNECTION
  641. ? node_ipv6_or_preferred(node)
  642. : node_ipv6_dir_preferred(node));
  643. /* Sometimes, the rs is missing the IPv6 address info, and we need to go
  644. * all the way to the md */
  645. if (node->ri && fascist_firewall_allows_ri_impl(node->ri, fw_connection,
  646. pref_only, pref_ipv6)) {
  647. return 1;
  648. } else if (node->rs && fascist_firewall_allows_rs_impl(node->rs,
  649. fw_connection,
  650. pref_only,
  651. pref_ipv6)) {
  652. return 1;
  653. } else if (node->md && fascist_firewall_allows_md_impl(node->md,
  654. fw_connection,
  655. pref_only,
  656. pref_ipv6)) {
  657. return 1;
  658. } else {
  659. /* If we know nothing, assume it's unreachable, we'll never get an address
  660. * to connect to. */
  661. return 0;
  662. }
  663. }
  664. /** Like fascist_firewall_allows_rs(), but takes ds. */
  665. int
  666. fascist_firewall_allows_dir_server(const dir_server_t *ds,
  667. firewall_connection_t fw_connection,
  668. int pref_only)
  669. {
  670. if (!ds) {
  671. return 0;
  672. }
  673. /* A dir_server_t always has a fake_status. As long as it has the same
  674. * addresses/ports in both fake_status and dir_server_t, this works fine.
  675. * (See #17867.)
  676. * fascist_firewall_allows_rs only checks the addresses in fake_status. */
  677. return fascist_firewall_allows_rs(&ds->fake_status, fw_connection,
  678. pref_only);
  679. }
  680. /** If a and b are both valid and allowed by fw_connection,
  681. * choose one based on want_a and return it.
  682. * Otherwise, return whichever is allowed.
  683. * Otherwise, return NULL.
  684. * pref_only and pref_ipv6 work as in fascist_firewall_allows_address_addr().
  685. */
  686. static const tor_addr_port_t *
  687. fascist_firewall_choose_address_impl(const tor_addr_port_t *a,
  688. const tor_addr_port_t *b,
  689. int want_a,
  690. firewall_connection_t fw_connection,
  691. int pref_only, int pref_ipv6)
  692. {
  693. const tor_addr_port_t *use_a = NULL;
  694. const tor_addr_port_t *use_b = NULL;
  695. if (fascist_firewall_allows_address_ap(a, fw_connection, pref_only,
  696. pref_ipv6)) {
  697. use_a = a;
  698. }
  699. if (fascist_firewall_allows_address_ap(b, fw_connection, pref_only,
  700. pref_ipv6)) {
  701. use_b = b;
  702. }
  703. /* If both are allowed */
  704. if (use_a && use_b) {
  705. /* Choose a if we want it */
  706. return (want_a ? use_a : use_b);
  707. } else {
  708. /* Choose a if we have it */
  709. return (use_a ? use_a : use_b);
  710. }
  711. }
  712. /** If a and b are both valid and preferred by fw_connection,
  713. * choose one based on want_a and return it.
  714. * Otherwise, return whichever is preferred.
  715. * If neither are preferred, and pref_only is false:
  716. * - If a and b are both allowed by fw_connection,
  717. * choose one based on want_a and return it.
  718. * - Otherwise, return whichever is preferred.
  719. * Otherwise, return NULL. */
  720. STATIC const tor_addr_port_t *
  721. fascist_firewall_choose_address(const tor_addr_port_t *a,
  722. const tor_addr_port_t *b,
  723. int want_a,
  724. firewall_connection_t fw_connection,
  725. int pref_only, int pref_ipv6)
  726. {
  727. const tor_addr_port_t *pref = fascist_firewall_choose_address_impl(
  728. a, b, want_a,
  729. fw_connection,
  730. 1, pref_ipv6);
  731. if (pref_only || pref) {
  732. /* If there is a preferred address, use it. If we can only use preferred
  733. * addresses, and neither address is preferred, pref will be NULL, and we
  734. * want to return NULL, so return it. */
  735. return pref;
  736. } else {
  737. /* If there's no preferred address, and we can return addresses that are
  738. * not preferred, use an address that's allowed */
  739. return fascist_firewall_choose_address_impl(a, b, want_a, fw_connection,
  740. 0, pref_ipv6);
  741. }
  742. }
  743. /** Copy an address and port into <b>ap</b> that we think our firewall will
  744. * let us connect to. Uses ipv4_addr/ipv6_addr and
  745. * ipv4_orport/ipv6_orport/ReachableORAddresses or
  746. * ipv4_dirport/ipv6_dirport/ReachableDirAddresses based on IPv4/IPv6 and
  747. * <b>fw_connection</b>.
  748. * If pref_only, only choose preferred addresses. In either case, choose
  749. * a preferred address before an address that's not preferred.
  750. * If both addresses could be chosen (they are both preferred or both allowed)
  751. * choose IPv6 if pref_ipv6 is true, otherwise choose IPv4. */
  752. static void
  753. fascist_firewall_choose_address_base(const tor_addr_t *ipv4_addr,
  754. uint16_t ipv4_orport,
  755. uint16_t ipv4_dirport,
  756. const tor_addr_t *ipv6_addr,
  757. uint16_t ipv6_orport,
  758. uint16_t ipv6_dirport,
  759. firewall_connection_t fw_connection,
  760. int pref_only,
  761. int pref_ipv6,
  762. tor_addr_port_t* ap)
  763. {
  764. const tor_addr_port_t *result = NULL;
  765. const int want_ipv4 = !pref_ipv6;
  766. tor_assert(ipv6_addr);
  767. tor_assert(ap);
  768. tor_addr_make_null(&ap->addr, AF_UNSPEC);
  769. ap->port = 0;
  770. tor_addr_port_t ipv4_ap;
  771. tor_addr_copy(&ipv4_ap.addr, ipv4_addr);
  772. ipv4_ap.port = (fw_connection == FIREWALL_OR_CONNECTION
  773. ? ipv4_orport
  774. : ipv4_dirport);
  775. tor_addr_port_t ipv6_ap;
  776. tor_addr_copy(&ipv6_ap.addr, ipv6_addr);
  777. ipv6_ap.port = (fw_connection == FIREWALL_OR_CONNECTION
  778. ? ipv6_orport
  779. : ipv6_dirport);
  780. result = fascist_firewall_choose_address(&ipv4_ap, &ipv6_ap,
  781. want_ipv4,
  782. fw_connection, pref_only,
  783. pref_ipv6);
  784. if (result) {
  785. tor_addr_copy(&ap->addr, &result->addr);
  786. ap->port = result->port;
  787. }
  788. }
  789. /** Like fascist_firewall_choose_address_base(), but takes a host-order IPv4
  790. * address as the first parameter. */
  791. static void
  792. fascist_firewall_choose_address_ipv4h(uint32_t ipv4h_addr,
  793. uint16_t ipv4_orport,
  794. uint16_t ipv4_dirport,
  795. const tor_addr_t *ipv6_addr,
  796. uint16_t ipv6_orport,
  797. uint16_t ipv6_dirport,
  798. firewall_connection_t fw_connection,
  799. int pref_only,
  800. int pref_ipv6,
  801. tor_addr_port_t* ap)
  802. {
  803. tor_addr_t ipv4_addr;
  804. tor_addr_from_ipv4h(&ipv4_addr, ipv4h_addr);
  805. tor_assert(ap);
  806. tor_addr_make_null(&ap->addr, AF_UNSPEC);
  807. ap->port = 0;
  808. fascist_firewall_choose_address_base(&ipv4_addr, ipv4_orport,
  809. ipv4_dirport, ipv6_addr,
  810. ipv6_orport, ipv6_dirport,
  811. fw_connection, pref_only,
  812. pref_ipv6, ap);
  813. }
  814. /* Some microdescriptor consensus methods have no IPv6 addresses in rs: they
  815. * are in the microdescriptors. For these consensus methods, we can't rely on
  816. * the node's IPv6 address until its microdescriptor is available (when using
  817. * microdescs).
  818. * But for bridges, rewrite_node_address_for_bridge() updates node->ri with
  819. * the configured address, so we can trust bridge addresses.
  820. * (Bridges could gain an IPv6 address if their microdescriptor arrives, but
  821. * this will never be their preferred address: that is in the config.)
  822. * Returns true if the node needs a microdescriptor for its IPv6 address, and
  823. * false if the addresses in the node are already up-to-date.
  824. */
  825. static int
  826. node_awaiting_ipv6(const or_options_t* options, const node_t *node)
  827. {
  828. tor_assert(node);
  829. /* There's no point waiting for an IPv6 address if we'd never use it */
  830. if (!fascist_firewall_use_ipv6(options)) {
  831. return 0;
  832. }
  833. /* If the node has an IPv6 address, we're not waiting */
  834. if (node_has_ipv6_addr(node)) {
  835. return 0;
  836. }
  837. /* If the current consensus method and flavour has IPv6 addresses, we're not
  838. * waiting */
  839. if (networkstatus_consensus_has_ipv6(options)) {
  840. return 0;
  841. }
  842. /* Bridge clients never use the address from a bridge's md, so there's no
  843. * need to wait for it. */
  844. if (node_is_a_configured_bridge(node)) {
  845. return 0;
  846. }
  847. /* We are waiting if we_use_microdescriptors_for_circuits() and we have no
  848. * md. */
  849. return (!node->md && we_use_microdescriptors_for_circuits(options));
  850. }
  851. /** Like fascist_firewall_choose_address_base(), but takes <b>rs</b>.
  852. * Consults the corresponding node, then falls back to rs if node is NULL.
  853. * This should only happen when there's no valid consensus, and rs doesn't
  854. * correspond to a bridge client's bridge.
  855. */
  856. void
  857. fascist_firewall_choose_address_rs(const routerstatus_t *rs,
  858. firewall_connection_t fw_connection,
  859. int pref_only, tor_addr_port_t* ap)
  860. {
  861. tor_assert(ap);
  862. tor_addr_make_null(&ap->addr, AF_UNSPEC);
  863. ap->port = 0;
  864. if (!rs) {
  865. return;
  866. }
  867. const or_options_t *options = get_options();
  868. const node_t *node = node_get_by_id(rs->identity_digest);
  869. if (node && !node_awaiting_ipv6(options, node)) {
  870. fascist_firewall_choose_address_node(node, fw_connection, pref_only, ap);
  871. } else {
  872. /* There's no node-specific IPv6 preference, so use the generic IPv6
  873. * preference instead. */
  874. int pref_ipv6 = (fw_connection == FIREWALL_OR_CONNECTION
  875. ? fascist_firewall_prefer_ipv6_orport(options)
  876. : fascist_firewall_prefer_ipv6_dirport(options));
  877. /* Assume IPv4 and IPv6 DirPorts are the same.
  878. * Assume the IPv6 OR and Dir addresses are the same. */
  879. fascist_firewall_choose_address_ipv4h(rs->addr, rs->or_port, rs->dir_port,
  880. &rs->ipv6_addr, rs->ipv6_orport,
  881. rs->dir_port, fw_connection,
  882. pref_only, pref_ipv6, ap);
  883. }
  884. }
  885. /** Like fascist_firewall_choose_address_base(), but takes <b>node</b>, and
  886. * looks up the node's IPv6 preference rather than taking an argument
  887. * for pref_ipv6. */
  888. void
  889. fascist_firewall_choose_address_node(const node_t *node,
  890. firewall_connection_t fw_connection,
  891. int pref_only, tor_addr_port_t *ap)
  892. {
  893. tor_assert(ap);
  894. tor_addr_make_null(&ap->addr, AF_UNSPEC);
  895. ap->port = 0;
  896. if (!node) {
  897. return;
  898. }
  899. node_assert_ok(node);
  900. /* Calling fascist_firewall_choose_address_node() when the node is missing
  901. * IPv6 information breaks IPv6-only clients.
  902. * If the node is a hard-coded fallback directory or authority, call
  903. * fascist_firewall_choose_address_rs() on the fake (hard-coded) routerstatus
  904. * for the node.
  905. * If it is not hard-coded, check that the node has a microdescriptor, full
  906. * descriptor (routerinfo), or is one of our configured bridges before
  907. * calling this function. */
  908. if (BUG(node_awaiting_ipv6(get_options(), node))) {
  909. return;
  910. }
  911. const int pref_ipv6_node = (fw_connection == FIREWALL_OR_CONNECTION
  912. ? node_ipv6_or_preferred(node)
  913. : node_ipv6_dir_preferred(node));
  914. tor_addr_port_t ipv4_or_ap;
  915. node_get_prim_orport(node, &ipv4_or_ap);
  916. tor_addr_port_t ipv4_dir_ap;
  917. node_get_prim_dirport(node, &ipv4_dir_ap);
  918. tor_addr_port_t ipv6_or_ap;
  919. node_get_pref_ipv6_orport(node, &ipv6_or_ap);
  920. tor_addr_port_t ipv6_dir_ap;
  921. node_get_pref_ipv6_dirport(node, &ipv6_dir_ap);
  922. /* Assume the IPv6 OR and Dir addresses are the same. */
  923. fascist_firewall_choose_address_base(&ipv4_or_ap.addr, ipv4_or_ap.port,
  924. ipv4_dir_ap.port, &ipv6_or_ap.addr,
  925. ipv6_or_ap.port, ipv6_dir_ap.port,
  926. fw_connection, pref_only,
  927. pref_ipv6_node, ap);
  928. }
  929. /** Like fascist_firewall_choose_address_rs(), but takes <b>ds</b>. */
  930. void
  931. fascist_firewall_choose_address_dir_server(const dir_server_t *ds,
  932. firewall_connection_t fw_connection,
  933. int pref_only,
  934. tor_addr_port_t *ap)
  935. {
  936. tor_assert(ap);
  937. tor_addr_make_null(&ap->addr, AF_UNSPEC);
  938. ap->port = 0;
  939. if (!ds) {
  940. return;
  941. }
  942. /* A dir_server_t always has a fake_status. As long as it has the same
  943. * addresses/ports in both fake_status and dir_server_t, this works fine.
  944. * (See #17867.)
  945. * This function relies on fascist_firewall_choose_address_rs looking up the
  946. * node if it can, because that will get the latest info for the relay. */
  947. fascist_firewall_choose_address_rs(&ds->fake_status, fw_connection,
  948. pref_only, ap);
  949. }
  950. /** Return 1 if <b>addr</b> is permitted to connect to our dir port,
  951. * based on <b>dir_policy</b>. Else return 0.
  952. */
  953. int
  954. dir_policy_permits_address(const tor_addr_t *addr)
  955. {
  956. return addr_policy_permits_tor_addr(addr, 1, dir_policy);
  957. }
  958. /** Return 1 if <b>addr</b> is permitted to connect to our socks port,
  959. * based on <b>socks_policy</b>. Else return 0.
  960. */
  961. int
  962. socks_policy_permits_address(const tor_addr_t *addr)
  963. {
  964. return addr_policy_permits_tor_addr(addr, 1, socks_policy);
  965. }
  966. /** Return true iff the address <b>addr</b> is in a country listed in the
  967. * case-insensitive list of country codes <b>cc_list</b>. */
  968. static int
  969. addr_is_in_cc_list(uint32_t addr, const smartlist_t *cc_list)
  970. {
  971. country_t country;
  972. const char *name;
  973. tor_addr_t tar;
  974. if (!cc_list)
  975. return 0;
  976. /* XXXXipv6 */
  977. tor_addr_from_ipv4h(&tar, addr);
  978. country = geoip_get_country_by_addr(&tar);
  979. name = geoip_get_country_name(country);
  980. return smartlist_contains_string_case(cc_list, name);
  981. }
  982. /** Return 1 if <b>addr</b>:<b>port</b> is permitted to publish to our
  983. * directory, based on <b>authdir_reject_policy</b>. Else return 0.
  984. */
  985. int
  986. authdir_policy_permits_address(uint32_t addr, uint16_t port)
  987. {
  988. if (! addr_policy_permits_address(addr, port, authdir_reject_policy))
  989. return 0;
  990. return !addr_is_in_cc_list(addr, get_options()->AuthDirRejectCCs);
  991. }
  992. /** Return 1 if <b>addr</b>:<b>port</b> is considered valid in our
  993. * directory, based on <b>authdir_invalid_policy</b>. Else return 0.
  994. */
  995. int
  996. authdir_policy_valid_address(uint32_t addr, uint16_t port)
  997. {
  998. if (! addr_policy_permits_address(addr, port, authdir_invalid_policy))
  999. return 0;
  1000. return !addr_is_in_cc_list(addr, get_options()->AuthDirInvalidCCs);
  1001. }
  1002. /** Return 1 if <b>addr</b>:<b>port</b> should be marked as a bad exit,
  1003. * based on <b>authdir_badexit_policy</b>. Else return 0.
  1004. */
  1005. int
  1006. authdir_policy_badexit_address(uint32_t addr, uint16_t port)
  1007. {
  1008. if (! addr_policy_permits_address(addr, port, authdir_badexit_policy))
  1009. return 1;
  1010. return addr_is_in_cc_list(addr, get_options()->AuthDirBadExitCCs);
  1011. }
  1012. #define REJECT(arg) \
  1013. STMT_BEGIN *msg = tor_strdup(arg); goto err; STMT_END
  1014. /** Config helper: If there's any problem with the policy configuration
  1015. * options in <b>options</b>, return -1 and set <b>msg</b> to a newly
  1016. * allocated description of the error. Else return 0. */
  1017. int
  1018. validate_addr_policies(const or_options_t *options, char **msg)
  1019. {
  1020. /* XXXX Maybe merge this into parse_policies_from_options, to make sure
  1021. * that the two can't go out of sync. */
  1022. smartlist_t *addr_policy=NULL;
  1023. *msg = NULL;
  1024. if (policies_parse_exit_policy_from_options(options,0,NULL,&addr_policy)) {
  1025. REJECT("Error in ExitPolicy entry.");
  1026. }
  1027. static int warned_about_exitrelay = 0;
  1028. const int exitrelay_setting_is_auto = options->ExitRelay == -1;
  1029. const int policy_accepts_something =
  1030. ! (policy_is_reject_star(addr_policy, AF_INET, 1) &&
  1031. policy_is_reject_star(addr_policy, AF_INET6, 1));
  1032. if (server_mode(options) &&
  1033. ! warned_about_exitrelay &&
  1034. exitrelay_setting_is_auto &&
  1035. policy_accepts_something) {
  1036. /* Policy accepts something */
  1037. warned_about_exitrelay = 1;
  1038. log_warn(LD_CONFIG,
  1039. "Tor is running as an exit relay%s. If you did not want this "
  1040. "behavior, please set the ExitRelay option to 0. If you do "
  1041. "want to run an exit Relay, please set the ExitRelay option "
  1042. "to 1 to disable this warning, and for forward compatibility.",
  1043. options->ExitPolicy == NULL ?
  1044. " with the default exit policy" : "");
  1045. if (options->ExitPolicy == NULL && options->ReducedExitPolicy == 0) {
  1046. log_warn(LD_CONFIG,
  1047. "In a future version of Tor, ExitRelay 0 may become the "
  1048. "default when no ExitPolicy is given.");
  1049. }
  1050. }
  1051. /* The rest of these calls *append* to addr_policy. So don't actually
  1052. * use the results for anything other than checking if they parse! */
  1053. if (parse_addr_policy(options->DirPolicy, &addr_policy, -1))
  1054. REJECT("Error in DirPolicy entry.");
  1055. if (parse_addr_policy(options->SocksPolicy, &addr_policy, -1))
  1056. REJECT("Error in SocksPolicy entry.");
  1057. if (parse_addr_policy(options->AuthDirReject, &addr_policy,
  1058. ADDR_POLICY_REJECT))
  1059. REJECT("Error in AuthDirReject entry.");
  1060. if (parse_addr_policy(options->AuthDirInvalid, &addr_policy,
  1061. ADDR_POLICY_REJECT))
  1062. REJECT("Error in AuthDirInvalid entry.");
  1063. if (parse_addr_policy(options->AuthDirBadExit, &addr_policy,
  1064. ADDR_POLICY_REJECT))
  1065. REJECT("Error in AuthDirBadExit entry.");
  1066. if (parse_addr_policy(options->ReachableAddresses, &addr_policy,
  1067. ADDR_POLICY_ACCEPT))
  1068. REJECT("Error in ReachableAddresses entry.");
  1069. if (parse_addr_policy(options->ReachableORAddresses, &addr_policy,
  1070. ADDR_POLICY_ACCEPT))
  1071. REJECT("Error in ReachableORAddresses entry.");
  1072. if (parse_addr_policy(options->ReachableDirAddresses, &addr_policy,
  1073. ADDR_POLICY_ACCEPT))
  1074. REJECT("Error in ReachableDirAddresses entry.");
  1075. err:
  1076. addr_policy_list_free(addr_policy);
  1077. return *msg ? -1 : 0;
  1078. #undef REJECT
  1079. }
  1080. /** Parse <b>string</b> in the same way that the exit policy
  1081. * is parsed, and put the processed version in *<b>policy</b>.
  1082. * Ignore port specifiers.
  1083. */
  1084. static int
  1085. load_policy_from_option(config_line_t *config, const char *option_name,
  1086. smartlist_t **policy,
  1087. int assume_action)
  1088. {
  1089. int r;
  1090. int killed_any_ports = 0;
  1091. addr_policy_list_free(*policy);
  1092. *policy = NULL;
  1093. r = parse_addr_policy(config, policy, assume_action);
  1094. if (r < 0) {
  1095. return -1;
  1096. }
  1097. if (*policy) {
  1098. SMARTLIST_FOREACH_BEGIN(*policy, addr_policy_t *, n) {
  1099. /* ports aren't used in these. */
  1100. if (n->prt_min > 1 || n->prt_max != 65535) {
  1101. addr_policy_t newp, *c;
  1102. memcpy(&newp, n, sizeof(newp));
  1103. newp.prt_min = 1;
  1104. newp.prt_max = 65535;
  1105. newp.is_canonical = 0;
  1106. c = addr_policy_get_canonical_entry(&newp);
  1107. SMARTLIST_REPLACE_CURRENT(*policy, n, c);
  1108. addr_policy_free(n);
  1109. killed_any_ports = 1;
  1110. }
  1111. } SMARTLIST_FOREACH_END(n);
  1112. }
  1113. if (killed_any_ports) {
  1114. log_warn(LD_CONFIG, "Ignoring ports in %s option.", option_name);
  1115. }
  1116. return 0;
  1117. }
  1118. /** Set all policies based on <b>options</b>, which should have been validated
  1119. * first by validate_addr_policies. */
  1120. int
  1121. policies_parse_from_options(const or_options_t *options)
  1122. {
  1123. int ret = 0;
  1124. if (load_policy_from_option(options->SocksPolicy, "SocksPolicy",
  1125. &socks_policy, -1) < 0)
  1126. ret = -1;
  1127. if (load_policy_from_option(options->DirPolicy, "DirPolicy",
  1128. &dir_policy, -1) < 0)
  1129. ret = -1;
  1130. if (load_policy_from_option(options->AuthDirReject, "AuthDirReject",
  1131. &authdir_reject_policy, ADDR_POLICY_REJECT) < 0)
  1132. ret = -1;
  1133. if (load_policy_from_option(options->AuthDirInvalid, "AuthDirInvalid",
  1134. &authdir_invalid_policy, ADDR_POLICY_REJECT) < 0)
  1135. ret = -1;
  1136. if (load_policy_from_option(options->AuthDirBadExit, "AuthDirBadExit",
  1137. &authdir_badexit_policy, ADDR_POLICY_REJECT) < 0)
  1138. ret = -1;
  1139. if (parse_reachable_addresses() < 0)
  1140. ret = -1;
  1141. return ret;
  1142. }
  1143. /** Compare two provided address policy items, and renturn -1, 0, or 1
  1144. * if the first is less than, equal to, or greater than the second. */
  1145. static int
  1146. single_addr_policy_eq(const addr_policy_t *a, const addr_policy_t *b)
  1147. {
  1148. int r;
  1149. #define CMP_FIELD(field) do { \
  1150. if (a->field != b->field) { \
  1151. return 0; \
  1152. } \
  1153. } while (0)
  1154. CMP_FIELD(policy_type);
  1155. CMP_FIELD(is_private);
  1156. /* refcnt and is_canonical are irrelevant to equality,
  1157. * they are hash table implementation details */
  1158. if ((r=tor_addr_compare(&a->addr, &b->addr, CMP_EXACT)))
  1159. return 0;
  1160. CMP_FIELD(maskbits);
  1161. CMP_FIELD(prt_min);
  1162. CMP_FIELD(prt_max);
  1163. #undef CMP_FIELD
  1164. return 1;
  1165. }
  1166. /** As single_addr_policy_eq, but compare every element of two policies.
  1167. */
  1168. int
  1169. addr_policies_eq(const smartlist_t *a, const smartlist_t *b)
  1170. {
  1171. int i;
  1172. int len_a = a ? smartlist_len(a) : 0;
  1173. int len_b = b ? smartlist_len(b) : 0;
  1174. if (len_a != len_b)
  1175. return 0;
  1176. for (i = 0; i < len_a; ++i) {
  1177. if (! single_addr_policy_eq(smartlist_get(a, i), smartlist_get(b, i)))
  1178. return 0;
  1179. }
  1180. return 1;
  1181. }
  1182. /** Node in hashtable used to store address policy entries. */
  1183. typedef struct policy_map_ent_t {
  1184. HT_ENTRY(policy_map_ent_t) node;
  1185. addr_policy_t *policy;
  1186. } policy_map_ent_t;
  1187. /* DOCDOC policy_root */
  1188. static HT_HEAD(policy_map, policy_map_ent_t) policy_root = HT_INITIALIZER();
  1189. /** Return true iff a and b are equal. */
  1190. static inline int
  1191. policy_eq(policy_map_ent_t *a, policy_map_ent_t *b)
  1192. {
  1193. return single_addr_policy_eq(a->policy, b->policy);
  1194. }
  1195. /** Return a hashcode for <b>ent</b> */
  1196. static unsigned int
  1197. policy_hash(const policy_map_ent_t *ent)
  1198. {
  1199. const addr_policy_t *a = ent->policy;
  1200. addr_policy_t aa;
  1201. memset(&aa, 0, sizeof(aa));
  1202. aa.prt_min = a->prt_min;
  1203. aa.prt_max = a->prt_max;
  1204. aa.maskbits = a->maskbits;
  1205. aa.policy_type = a->policy_type;
  1206. aa.is_private = a->is_private;
  1207. if (a->is_private) {
  1208. aa.is_private = 1;
  1209. } else {
  1210. tor_addr_copy_tight(&aa.addr, &a->addr);
  1211. }
  1212. return (unsigned) siphash24g(&aa, sizeof(aa));
  1213. }
  1214. HT_PROTOTYPE(policy_map, policy_map_ent_t, node, policy_hash,
  1215. policy_eq)
  1216. HT_GENERATE2(policy_map, policy_map_ent_t, node, policy_hash,
  1217. policy_eq, 0.6, tor_reallocarray_, tor_free_)
  1218. /** Given a pointer to an addr_policy_t, return a copy of the pointer to the
  1219. * "canonical" copy of that addr_policy_t; the canonical copy is a single
  1220. * reference-counted object. */
  1221. addr_policy_t *
  1222. addr_policy_get_canonical_entry(addr_policy_t *e)
  1223. {
  1224. policy_map_ent_t search, *found;
  1225. if (e->is_canonical)
  1226. return e;
  1227. search.policy = e;
  1228. found = HT_FIND(policy_map, &policy_root, &search);
  1229. if (!found) {
  1230. found = tor_malloc_zero(sizeof(policy_map_ent_t));
  1231. found->policy = tor_memdup(e, sizeof(addr_policy_t));
  1232. found->policy->is_canonical = 1;
  1233. found->policy->refcnt = 0;
  1234. HT_INSERT(policy_map, &policy_root, found);
  1235. }
  1236. tor_assert(single_addr_policy_eq(found->policy, e));
  1237. ++found->policy->refcnt;
  1238. return found->policy;
  1239. }
  1240. /** Helper for compare_tor_addr_to_addr_policy. Implements the case where
  1241. * addr and port are both known. */
  1242. static addr_policy_result_t
  1243. compare_known_tor_addr_to_addr_policy(const tor_addr_t *addr, uint16_t port,
  1244. const smartlist_t *policy)
  1245. {
  1246. /* We know the address and port, and we know the policy, so we can just
  1247. * compute an exact match. */
  1248. SMARTLIST_FOREACH_BEGIN(policy, addr_policy_t *, tmpe) {
  1249. if (tmpe->addr.family == AF_UNSPEC) {
  1250. log_warn(LD_BUG, "Policy contains an AF_UNSPEC address, which only "
  1251. "matches other AF_UNSPEC addresses.");
  1252. }
  1253. /* Address is known */
  1254. if (!tor_addr_compare_masked(addr, &tmpe->addr, tmpe->maskbits,
  1255. CMP_EXACT)) {
  1256. if (port >= tmpe->prt_min && port <= tmpe->prt_max) {
  1257. /* Exact match for the policy */
  1258. return tmpe->policy_type == ADDR_POLICY_ACCEPT ?
  1259. ADDR_POLICY_ACCEPTED : ADDR_POLICY_REJECTED;
  1260. }
  1261. }
  1262. } SMARTLIST_FOREACH_END(tmpe);
  1263. /* accept all by default. */
  1264. return ADDR_POLICY_ACCEPTED;
  1265. }
  1266. /** Helper for compare_tor_addr_to_addr_policy. Implements the case where
  1267. * addr is known but port is not. */
  1268. static addr_policy_result_t
  1269. compare_known_tor_addr_to_addr_policy_noport(const tor_addr_t *addr,
  1270. const smartlist_t *policy)
  1271. {
  1272. /* We look to see if there's a definite match. If so, we return that
  1273. match's value, unless there's an intervening possible match that says
  1274. something different. */
  1275. int maybe_accept = 0, maybe_reject = 0;
  1276. SMARTLIST_FOREACH_BEGIN(policy, addr_policy_t *, tmpe) {
  1277. if (tmpe->addr.family == AF_UNSPEC) {
  1278. log_warn(LD_BUG, "Policy contains an AF_UNSPEC address, which only "
  1279. "matches other AF_UNSPEC addresses.");
  1280. }
  1281. if (!tor_addr_compare_masked(addr, &tmpe->addr, tmpe->maskbits,
  1282. CMP_EXACT)) {
  1283. if (tmpe->prt_min <= 1 && tmpe->prt_max >= 65535) {
  1284. /* Definitely matches, since it covers all ports. */
  1285. if (tmpe->policy_type == ADDR_POLICY_ACCEPT) {
  1286. /* If we already hit a clause that might trigger a 'reject', than we
  1287. * can't be sure of this certain 'accept'.*/
  1288. return maybe_reject ? ADDR_POLICY_PROBABLY_ACCEPTED :
  1289. ADDR_POLICY_ACCEPTED;
  1290. } else {
  1291. return maybe_accept ? ADDR_POLICY_PROBABLY_REJECTED :
  1292. ADDR_POLICY_REJECTED;
  1293. }
  1294. } else {
  1295. /* Might match. */
  1296. if (tmpe->policy_type == ADDR_POLICY_REJECT)
  1297. maybe_reject = 1;
  1298. else
  1299. maybe_accept = 1;
  1300. }
  1301. }
  1302. } SMARTLIST_FOREACH_END(tmpe);
  1303. /* accept all by default. */
  1304. return maybe_reject ? ADDR_POLICY_PROBABLY_ACCEPTED : ADDR_POLICY_ACCEPTED;
  1305. }
  1306. /** Helper for compare_tor_addr_to_addr_policy. Implements the case where
  1307. * port is known but address is not. */
  1308. static addr_policy_result_t
  1309. compare_unknown_tor_addr_to_addr_policy(uint16_t port,
  1310. const smartlist_t *policy)
  1311. {
  1312. /* We look to see if there's a definite match. If so, we return that
  1313. match's value, unless there's an intervening possible match that says
  1314. something different. */
  1315. int maybe_accept = 0, maybe_reject = 0;
  1316. SMARTLIST_FOREACH_BEGIN(policy, addr_policy_t *, tmpe) {
  1317. if (tmpe->addr.family == AF_UNSPEC) {
  1318. log_warn(LD_BUG, "Policy contains an AF_UNSPEC address, which only "
  1319. "matches other AF_UNSPEC addresses.");
  1320. }
  1321. if (tmpe->prt_min <= port && port <= tmpe->prt_max) {
  1322. if (tmpe->maskbits == 0) {
  1323. /* Definitely matches, since it covers all addresses. */
  1324. if (tmpe->policy_type == ADDR_POLICY_ACCEPT) {
  1325. /* If we already hit a clause that might trigger a 'reject', than we
  1326. * can't be sure of this certain 'accept'.*/
  1327. return maybe_reject ? ADDR_POLICY_PROBABLY_ACCEPTED :
  1328. ADDR_POLICY_ACCEPTED;
  1329. } else {
  1330. return maybe_accept ? ADDR_POLICY_PROBABLY_REJECTED :
  1331. ADDR_POLICY_REJECTED;
  1332. }
  1333. } else {
  1334. /* Might match. */
  1335. if (tmpe->policy_type == ADDR_POLICY_REJECT)
  1336. maybe_reject = 1;
  1337. else
  1338. maybe_accept = 1;
  1339. }
  1340. }
  1341. } SMARTLIST_FOREACH_END(tmpe);
  1342. /* accept all by default. */
  1343. return maybe_reject ? ADDR_POLICY_PROBABLY_ACCEPTED : ADDR_POLICY_ACCEPTED;
  1344. }
  1345. /** Decide whether a given addr:port is definitely accepted,
  1346. * definitely rejected, probably accepted, or probably rejected by a
  1347. * given policy. If <b>addr</b> is 0, we don't know the IP of the
  1348. * target address. If <b>port</b> is 0, we don't know the port of the
  1349. * target address. (At least one of <b>addr</b> and <b>port</b> must be
  1350. * provided. If you want to know whether a policy would definitely reject
  1351. * an unknown address:port, use policy_is_reject_star().)
  1352. *
  1353. * We could do better by assuming that some ranges never match typical
  1354. * addresses (127.0.0.1, and so on). But we'll try this for now.
  1355. */
  1356. MOCK_IMPL(addr_policy_result_t,
  1357. compare_tor_addr_to_addr_policy,(const tor_addr_t *addr, uint16_t port,
  1358. const smartlist_t *policy))
  1359. {
  1360. if (!policy) {
  1361. /* no policy? accept all. */
  1362. return ADDR_POLICY_ACCEPTED;
  1363. } else if (addr == NULL || tor_addr_is_null(addr)) {
  1364. if (port == 0) {
  1365. log_info(LD_BUG, "Rejecting null address with 0 port (family %d)",
  1366. addr ? tor_addr_family(addr) : -1);
  1367. return ADDR_POLICY_REJECTED;
  1368. }
  1369. return compare_unknown_tor_addr_to_addr_policy(port, policy);
  1370. } else if (port == 0) {
  1371. return compare_known_tor_addr_to_addr_policy_noport(addr, policy);
  1372. } else {
  1373. return compare_known_tor_addr_to_addr_policy(addr, port, policy);
  1374. }
  1375. }
  1376. /** Return true iff the address policy <b>a</b> covers every case that
  1377. * would be covered by <b>b</b>, so that a,b is redundant. */
  1378. static int
  1379. addr_policy_covers(addr_policy_t *a, addr_policy_t *b)
  1380. {
  1381. if (tor_addr_family(&a->addr) != tor_addr_family(&b->addr)) {
  1382. /* You can't cover a different family. */
  1383. return 0;
  1384. }
  1385. /* We can ignore accept/reject, since "accept *:80, reject *:80" reduces
  1386. * to "accept *:80". */
  1387. if (a->maskbits > b->maskbits) {
  1388. /* a has more fixed bits than b; it can't possibly cover b. */
  1389. return 0;
  1390. }
  1391. if (tor_addr_compare_masked(&a->addr, &b->addr, a->maskbits, CMP_EXACT)) {
  1392. /* There's a fixed bit in a that's set differently in b. */
  1393. return 0;
  1394. }
  1395. return (a->prt_min <= b->prt_min && a->prt_max >= b->prt_max);
  1396. }
  1397. /** Return true iff the address policies <b>a</b> and <b>b</b> intersect,
  1398. * that is, there exists an address/port that is covered by <b>a</b> that
  1399. * is also covered by <b>b</b>.
  1400. */
  1401. static int
  1402. addr_policy_intersects(addr_policy_t *a, addr_policy_t *b)
  1403. {
  1404. maskbits_t minbits;
  1405. /* All the bits we care about are those that are set in both
  1406. * netmasks. If they are equal in a and b's networkaddresses
  1407. * then the networks intersect. If there is a difference,
  1408. * then they do not. */
  1409. if (a->maskbits < b->maskbits)
  1410. minbits = a->maskbits;
  1411. else
  1412. minbits = b->maskbits;
  1413. if (tor_addr_compare_masked(&a->addr, &b->addr, minbits, CMP_EXACT))
  1414. return 0;
  1415. if (a->prt_max < b->prt_min || b->prt_max < a->prt_min)
  1416. return 0;
  1417. return 1;
  1418. }
  1419. /** Add the exit policy described by <b>more</b> to <b>policy</b>.
  1420. */
  1421. STATIC void
  1422. append_exit_policy_string(smartlist_t **policy, const char *more)
  1423. {
  1424. config_line_t tmp;
  1425. tmp.key = NULL;
  1426. tmp.value = (char*) more;
  1427. tmp.next = NULL;
  1428. if (parse_addr_policy(&tmp, policy, -1)<0) {
  1429. log_warn(LD_BUG, "Unable to parse internally generated policy %s",more);
  1430. }
  1431. }
  1432. /** Add "reject <b>addr</b>:*" to <b>dest</b>, creating the list as needed. */
  1433. void
  1434. addr_policy_append_reject_addr(smartlist_t **dest, const tor_addr_t *addr)
  1435. {
  1436. tor_assert(dest);
  1437. tor_assert(addr);
  1438. addr_policy_t p, *add;
  1439. memset(&p, 0, sizeof(p));
  1440. p.policy_type = ADDR_POLICY_REJECT;
  1441. p.maskbits = tor_addr_family(addr) == AF_INET6 ? 128 : 32;
  1442. tor_addr_copy(&p.addr, addr);
  1443. p.prt_min = 1;
  1444. p.prt_max = 65535;
  1445. add = addr_policy_get_canonical_entry(&p);
  1446. if (!*dest)
  1447. *dest = smartlist_new();
  1448. smartlist_add(*dest, add);
  1449. log_debug(LD_CONFIG, "Adding a reject ExitPolicy 'reject %s:*'",
  1450. fmt_addr(addr));
  1451. }
  1452. /* Is addr public for the purposes of rejection? */
  1453. static int
  1454. tor_addr_is_public_for_reject(const tor_addr_t *addr)
  1455. {
  1456. return (!tor_addr_is_null(addr) && !tor_addr_is_internal(addr, 0)
  1457. && !tor_addr_is_multicast(addr));
  1458. }
  1459. /* Add "reject <b>addr</b>:*" to <b>dest</b>, creating the list as needed.
  1460. * Filter the address, only adding an IPv4 reject rule if ipv4_rules
  1461. * is true, and similarly for ipv6_rules. Check each address returns true for
  1462. * tor_addr_is_public_for_reject before adding it.
  1463. */
  1464. static void
  1465. addr_policy_append_reject_addr_filter(smartlist_t **dest,
  1466. const tor_addr_t *addr,
  1467. int ipv4_rules,
  1468. int ipv6_rules)
  1469. {
  1470. tor_assert(dest);
  1471. tor_assert(addr);
  1472. /* Only reject IP addresses which are public */
  1473. if (tor_addr_is_public_for_reject(addr)) {
  1474. /* Reject IPv4 addresses and IPv6 addresses based on the filters */
  1475. int is_ipv4 = tor_addr_is_v4(addr);
  1476. if ((is_ipv4 && ipv4_rules) || (!is_ipv4 && ipv6_rules)) {
  1477. addr_policy_append_reject_addr(dest, addr);
  1478. }
  1479. }
  1480. }
  1481. /** Add "reject addr:*" to <b>dest</b>, for each addr in addrs, creating the
  1482. * list as needed. */
  1483. void
  1484. addr_policy_append_reject_addr_list(smartlist_t **dest,
  1485. const smartlist_t *addrs)
  1486. {
  1487. tor_assert(dest);
  1488. tor_assert(addrs);
  1489. SMARTLIST_FOREACH_BEGIN(addrs, tor_addr_t *, addr) {
  1490. addr_policy_append_reject_addr(dest, addr);
  1491. } SMARTLIST_FOREACH_END(addr);
  1492. }
  1493. /** Add "reject addr:*" to <b>dest</b>, for each addr in addrs, creating the
  1494. * list as needed. Filter using */
  1495. static void
  1496. addr_policy_append_reject_addr_list_filter(smartlist_t **dest,
  1497. const smartlist_t *addrs,
  1498. int ipv4_rules,
  1499. int ipv6_rules)
  1500. {
  1501. tor_assert(dest);
  1502. tor_assert(addrs);
  1503. SMARTLIST_FOREACH_BEGIN(addrs, tor_addr_t *, addr) {
  1504. addr_policy_append_reject_addr_filter(dest, addr, ipv4_rules, ipv6_rules);
  1505. } SMARTLIST_FOREACH_END(addr);
  1506. }
  1507. /** Detect and excise "dead code" from the policy *<b>dest</b>. */
  1508. static void
  1509. exit_policy_remove_redundancies(smartlist_t *dest)
  1510. {
  1511. addr_policy_t *ap, *tmp;
  1512. int i, j;
  1513. /* Step one: kill every ipv4 thing after *4:*, every IPv6 thing after *6:*
  1514. */
  1515. {
  1516. int kill_v4=0, kill_v6=0;
  1517. for (i = 0; i < smartlist_len(dest); ++i) {
  1518. sa_family_t family;
  1519. ap = smartlist_get(dest, i);
  1520. family = tor_addr_family(&ap->addr);
  1521. if ((family == AF_INET && kill_v4) ||
  1522. (family == AF_INET6 && kill_v6)) {
  1523. smartlist_del_keeporder(dest, i--);
  1524. addr_policy_free(ap);
  1525. continue;
  1526. }
  1527. if (ap->maskbits == 0 && ap->prt_min <= 1 && ap->prt_max >= 65535) {
  1528. /* This is a catch-all line -- later lines are unreachable. */
  1529. if (family == AF_INET) {
  1530. kill_v4 = 1;
  1531. } else if (family == AF_INET6) {
  1532. kill_v6 = 1;
  1533. }
  1534. }
  1535. }
  1536. }
  1537. /* Step two: for every entry, see if there's a redundant entry
  1538. * later on, and remove it. */
  1539. for (i = 0; i < smartlist_len(dest)-1; ++i) {
  1540. ap = smartlist_get(dest, i);
  1541. for (j = i+1; j < smartlist_len(dest); ++j) {
  1542. tmp = smartlist_get(dest, j);
  1543. tor_assert(j > i);
  1544. if (addr_policy_covers(ap, tmp)) {
  1545. char p1[POLICY_BUF_LEN], p2[POLICY_BUF_LEN];
  1546. policy_write_item(p1, sizeof(p1), tmp, 0);
  1547. policy_write_item(p2, sizeof(p2), ap, 0);
  1548. log_debug(LD_CONFIG, "Removing exit policy %s (%d). It is made "
  1549. "redundant by %s (%d).", p1, j, p2, i);
  1550. smartlist_del_keeporder(dest, j--);
  1551. addr_policy_free(tmp);
  1552. }
  1553. }
  1554. }
  1555. /* Step three: for every entry A, see if there's an entry B making this one
  1556. * redundant later on. This is the case if A and B are of the same type
  1557. * (accept/reject), A is a subset of B, and there is no other entry of
  1558. * different type in between those two that intersects with A.
  1559. *
  1560. * Anybody want to double-check the logic here? XXX
  1561. */
  1562. for (i = 0; i < smartlist_len(dest)-1; ++i) {
  1563. ap = smartlist_get(dest, i);
  1564. for (j = i+1; j < smartlist_len(dest); ++j) {
  1565. // tor_assert(j > i); // j starts out at i+1; j only increases; i only
  1566. // // decreases.
  1567. tmp = smartlist_get(dest, j);
  1568. if (ap->policy_type != tmp->policy_type) {
  1569. if (addr_policy_intersects(ap, tmp))
  1570. break;
  1571. } else { /* policy_types are equal. */
  1572. if (addr_policy_covers(tmp, ap)) {
  1573. char p1[POLICY_BUF_LEN], p2[POLICY_BUF_LEN];
  1574. policy_write_item(p1, sizeof(p1), ap, 0);
  1575. policy_write_item(p2, sizeof(p2), tmp, 0);
  1576. log_debug(LD_CONFIG, "Removing exit policy %s. It is already "
  1577. "covered by %s.", p1, p2);
  1578. smartlist_del_keeporder(dest, i--);
  1579. addr_policy_free(ap);
  1580. break;
  1581. }
  1582. }
  1583. }
  1584. }
  1585. }
  1586. /** Reject private helper for policies_parse_exit_policy_internal: rejects
  1587. * publicly routable addresses on this exit relay.
  1588. *
  1589. * Add reject entries to the linked list *<b>dest</b>:
  1590. * <ul>
  1591. * <li>if configured_addresses is non-NULL, add entries that reject each
  1592. * tor_addr_t in the list as a destination.
  1593. * <li>if reject_interface_addresses is true, add entries that reject each
  1594. * public IPv4 and IPv6 address of each interface on this machine.
  1595. * <li>if reject_configured_port_addresses is true, add entries that reject
  1596. * each IPv4 and IPv6 address configured for a port.
  1597. * </ul>
  1598. *
  1599. * IPv6 entries are only added if ipv6_exit is true. (All IPv6 addresses are
  1600. * already blocked by policies_parse_exit_policy_internal if ipv6_exit is
  1601. * false.)
  1602. *
  1603. * The list in <b>dest</b> is created as needed.
  1604. */
  1605. void
  1606. policies_parse_exit_policy_reject_private(
  1607. smartlist_t **dest,
  1608. int ipv6_exit,
  1609. const smartlist_t *configured_addresses,
  1610. int reject_interface_addresses,
  1611. int reject_configured_port_addresses)
  1612. {
  1613. tor_assert(dest);
  1614. /* Reject configured addresses, if they are from public netblocks. */
  1615. if (configured_addresses) {
  1616. addr_policy_append_reject_addr_list_filter(dest, configured_addresses,
  1617. 1, ipv6_exit);
  1618. }
  1619. /* Reject configured port addresses, if they are from public netblocks. */
  1620. if (reject_configured_port_addresses) {
  1621. const smartlist_t *port_addrs = get_configured_ports();
  1622. SMARTLIST_FOREACH_BEGIN(port_addrs, port_cfg_t *, port) {
  1623. /* Only reject port IP addresses, not port unix sockets */
  1624. if (!port->is_unix_addr) {
  1625. addr_policy_append_reject_addr_filter(dest, &port->addr, 1, ipv6_exit);
  1626. }
  1627. } SMARTLIST_FOREACH_END(port);
  1628. }
  1629. /* Reject local addresses from public netblocks on any interface. */
  1630. if (reject_interface_addresses) {
  1631. smartlist_t *public_addresses = NULL;
  1632. /* Reject public IPv4 addresses on any interface */
  1633. public_addresses = get_interface_address6_list(LOG_INFO, AF_INET, 0);
  1634. addr_policy_append_reject_addr_list_filter(dest, public_addresses, 1, 0);
  1635. interface_address6_list_free(public_addresses);
  1636. /* Don't look for IPv6 addresses if we're configured as IPv4-only */
  1637. if (ipv6_exit) {
  1638. /* Reject public IPv6 addresses on any interface */
  1639. public_addresses = get_interface_address6_list(LOG_INFO, AF_INET6, 0);
  1640. addr_policy_append_reject_addr_list_filter(dest, public_addresses, 0, 1);
  1641. interface_address6_list_free(public_addresses);
  1642. }
  1643. }
  1644. /* If addresses were added multiple times, remove all but one of them. */
  1645. if (*dest) {
  1646. exit_policy_remove_redundancies(*dest);
  1647. }
  1648. }
  1649. /**
  1650. * Iterate through <b>policy</b> looking for redundant entries. Log a
  1651. * warning message with the first redundant entry, if any is found.
  1652. */
  1653. static void
  1654. policies_log_first_redundant_entry(const smartlist_t *policy)
  1655. {
  1656. int found_final_effective_entry = 0;
  1657. int first_redundant_entry = 0;
  1658. tor_assert(policy);
  1659. SMARTLIST_FOREACH_BEGIN(policy, const addr_policy_t *, p) {
  1660. sa_family_t family;
  1661. int found_ipv4_wildcard = 0, found_ipv6_wildcard = 0;
  1662. const int i = p_sl_idx;
  1663. /* Look for accept/reject *[4|6|]:* entires */
  1664. if (p->prt_min <= 1 && p->prt_max == 65535 && p->maskbits == 0) {
  1665. family = tor_addr_family(&p->addr);
  1666. /* accept/reject *:* may have already been expanded into
  1667. * accept/reject *4:*,accept/reject *6:*
  1668. * But handle both forms.
  1669. */
  1670. if (family == AF_INET || family == AF_UNSPEC) {
  1671. found_ipv4_wildcard = 1;
  1672. }
  1673. if (family == AF_INET6 || family == AF_UNSPEC) {
  1674. found_ipv6_wildcard = 1;
  1675. }
  1676. }
  1677. /* We also find accept *4:*,reject *6:* ; and
  1678. * accept *4:*,<other policies>,accept *6:* ; and similar.
  1679. * That's ok, because they make any subsequent entries redundant. */
  1680. if (found_ipv4_wildcard && found_ipv6_wildcard) {
  1681. found_final_effective_entry = 1;
  1682. /* if we're not on the final entry in the list */
  1683. if (i < smartlist_len(policy) - 1) {
  1684. first_redundant_entry = i + 1;
  1685. }
  1686. break;
  1687. }
  1688. } SMARTLIST_FOREACH_END(p);
  1689. /* Work out if there are redundant trailing entries in the policy list */
  1690. if (found_final_effective_entry && first_redundant_entry > 0) {
  1691. const addr_policy_t *p;
  1692. /* Longest possible policy is
  1693. * "accept6 ffff:ffff:..255/128:10000-65535",
  1694. * which contains a max-length IPv6 address, plus 24 characters. */
  1695. char line[TOR_ADDR_BUF_LEN + 32];
  1696. tor_assert(first_redundant_entry < smartlist_len(policy));
  1697. p = smartlist_get(policy, first_redundant_entry);
  1698. /* since we've already parsed the policy into an addr_policy_t struct,
  1699. * we might not log exactly what the user typed in */
  1700. policy_write_item(line, TOR_ADDR_BUF_LEN + 32, p, 0);
  1701. log_warn(LD_DIR, "Exit policy '%s' and all following policies are "
  1702. "redundant, as it follows accept/reject *:* rules for both "
  1703. "IPv4 and IPv6. They will be removed from the exit policy. (Use "
  1704. "accept/reject *:* as the last entry in any exit policy.)",
  1705. line);
  1706. }
  1707. }
  1708. #define DEFAULT_EXIT_POLICY \
  1709. "reject *:25,reject *:119,reject *:135-139,reject *:445," \
  1710. "reject *:563,reject *:1214,reject *:4661-4666," \
  1711. "reject *:6346-6429,reject *:6699,reject *:6881-6999,accept *:*"
  1712. #define REDUCED_EXIT_POLICY \
  1713. "accept *:20-23,accept *:43,accept *:53,accept *:79-81,accept *:88," \
  1714. "accept *:110,accept *:143,accept *:194,accept *:220,accept *:389," \
  1715. "accept *:443,accept *:464,accept *:465,accept *:531,accept *:543-544," \
  1716. "accept *:554,accept *:563,accept *:587,accept *:636,accept *:706," \
  1717. "accept *:749,accept *:873,accept *:902-904,accept *:981,accept *:989-995," \
  1718. "accept *:1194,accept *:1220,accept *:1293,accept *:1500,accept *:1533," \
  1719. "accept *:1677,accept *:1723,accept *:1755,accept *:1863," \
  1720. "accept *:2082-2083,accept *:2086-2087,accept *:2095-2096," \
  1721. "accept *:2102-2104,accept *:3128,accept *:3389,accept *:3690," \
  1722. "accept *:4321,accept *:4643,accept *:5050,accept *:5190," \
  1723. "accept *:5222-5223,accept *:5228,accept *:5900,accept *:6660-6669," \
  1724. "accept *:6679,accept *:6697,accept *:8000,accept *:8008,accept *:8074," \
  1725. "accept *:8080,accept *:8082,accept *:8087-8088,accept *:8232-8233," \
  1726. "accept *:8332-8333,accept *:8443,accept *:8888,accept *:9418," \
  1727. "accept *:9999,accept *:10000,accept *:11371,accept *:19294," \
  1728. "accept *:19638,accept *:50002,accept *:64738,reject *:*"
  1729. /** Parse the exit policy <b>cfg</b> into the linked list *<b>dest</b>.
  1730. *
  1731. * If <b>ipv6_exit</b> is false, prepend "reject *6:*" to the policy.
  1732. *
  1733. * If <b>configured_addresses</b> contains addresses:
  1734. * - prepend entries that reject the addresses in this list. These may be the
  1735. * advertised relay addresses and/or the outbound bind addresses,
  1736. * depending on the ExitPolicyRejectPrivate and
  1737. * ExitPolicyRejectLocalInterfaces settings.
  1738. * If <b>rejectprivate</b> is true:
  1739. * - prepend "reject private:*" to the policy.
  1740. * If <b>reject_interface_addresses</b> is true:
  1741. * - prepend entries that reject publicly routable interface addresses on
  1742. * this exit relay by calling policies_parse_exit_policy_reject_private
  1743. * If <b>reject_configured_port_addresses</b> is true:
  1744. * - prepend entries that reject all configured port addresses
  1745. *
  1746. * If cfg doesn't end in an absolute accept or reject and if
  1747. * <b>add_default_policy</b> is true, add the default exit
  1748. * policy afterwards.
  1749. *
  1750. * Return -1 if we can't parse cfg, else return 0.
  1751. *
  1752. * This function is used to parse the exit policy from our torrc. For
  1753. * the functions used to parse the exit policy from a router descriptor,
  1754. * see router_add_exit_policy.
  1755. */
  1756. static int
  1757. policies_parse_exit_policy_internal(config_line_t *cfg,
  1758. smartlist_t **dest,
  1759. int ipv6_exit,
  1760. int rejectprivate,
  1761. const smartlist_t *configured_addresses,
  1762. int reject_interface_addresses,
  1763. int reject_configured_port_addresses,
  1764. int add_default_policy,
  1765. int add_reduced_policy)
  1766. {
  1767. if (!ipv6_exit) {
  1768. append_exit_policy_string(dest, "reject *6:*");
  1769. }
  1770. if (rejectprivate) {
  1771. /* Reject IPv4 and IPv6 reserved private netblocks */
  1772. append_exit_policy_string(dest, "reject private:*");
  1773. }
  1774. /* Consider rejecting IPv4 and IPv6 advertised relay addresses, outbound bind
  1775. * addresses, publicly routable addresses, and configured port addresses
  1776. * on this exit relay */
  1777. policies_parse_exit_policy_reject_private(dest, ipv6_exit,
  1778. configured_addresses,
  1779. reject_interface_addresses,
  1780. reject_configured_port_addresses);
  1781. if (parse_addr_policy(cfg, dest, -1))
  1782. return -1;
  1783. /* Before we add the default policy and final rejects, check to see if
  1784. * there are any lines after accept *:* or reject *:*. These lines have no
  1785. * effect, and are most likely an error. */
  1786. policies_log_first_redundant_entry(*dest);
  1787. if (add_reduced_policy) {
  1788. append_exit_policy_string(dest, REDUCED_EXIT_POLICY);
  1789. } else if (add_default_policy) {
  1790. append_exit_policy_string(dest, DEFAULT_EXIT_POLICY);
  1791. } else {
  1792. append_exit_policy_string(dest, "reject *4:*");
  1793. append_exit_policy_string(dest, "reject *6:*");
  1794. }
  1795. exit_policy_remove_redundancies(*dest);
  1796. return 0;
  1797. }
  1798. /** Parse exit policy in <b>cfg</b> into <b>dest</b> smartlist.
  1799. *
  1800. * Prepend an entry that rejects all IPv6 destinations unless
  1801. * <b>EXIT_POLICY_IPV6_ENABLED</b> bit is set in <b>options</b> bitmask.
  1802. *
  1803. * If <b>EXIT_POLICY_REJECT_PRIVATE</b> bit is set in <b>options</b>:
  1804. * - prepend an entry that rejects all destinations in all netblocks
  1805. * reserved for private use.
  1806. * - prepend entries that reject the advertised relay addresses in
  1807. * configured_addresses
  1808. * If <b>EXIT_POLICY_REJECT_LOCAL_INTERFACES</b> bit is set in <b>options</b>:
  1809. * - prepend entries that reject publicly routable addresses on this exit
  1810. * relay by calling policies_parse_exit_policy_internal
  1811. * - prepend entries that reject the outbound bind addresses in
  1812. * configured_addresses
  1813. * - prepend entries that reject all configured port addresses
  1814. *
  1815. * If <b>EXIT_POLICY_ADD_DEFAULT</b> bit is set in <b>options</b>, append
  1816. * default exit policy entries to <b>result</b> smartlist.
  1817. */
  1818. int
  1819. policies_parse_exit_policy(config_line_t *cfg, smartlist_t **dest,
  1820. exit_policy_parser_cfg_t options,
  1821. const smartlist_t *configured_addresses)
  1822. {
  1823. int ipv6_enabled = (options & EXIT_POLICY_IPV6_ENABLED) ? 1 : 0;
  1824. int reject_private = (options & EXIT_POLICY_REJECT_PRIVATE) ? 1 : 0;
  1825. int add_default = (options & EXIT_POLICY_ADD_DEFAULT) ? 1 : 0;
  1826. int reject_local_interfaces = (options &
  1827. EXIT_POLICY_REJECT_LOCAL_INTERFACES) ? 1 : 0;
  1828. int add_reduced = (options & EXIT_POLICY_ADD_REDUCED) ? 1 : 0;
  1829. return policies_parse_exit_policy_internal(cfg,dest,ipv6_enabled,
  1830. reject_private,
  1831. configured_addresses,
  1832. reject_local_interfaces,
  1833. reject_local_interfaces,
  1834. add_default,
  1835. add_reduced);
  1836. }
  1837. /** Helper function that adds a copy of addr to a smartlist as long as it is
  1838. * non-NULL and not tor_addr_is_null().
  1839. *
  1840. * The caller is responsible for freeing all the tor_addr_t* in the smartlist.
  1841. */
  1842. static void
  1843. policies_copy_addr_to_smartlist(smartlist_t *addr_list, const tor_addr_t *addr)
  1844. {
  1845. if (addr && !tor_addr_is_null(addr)) {
  1846. tor_addr_t *addr_copy = tor_malloc(sizeof(tor_addr_t));
  1847. tor_addr_copy(addr_copy, addr);
  1848. smartlist_add(addr_list, addr_copy);
  1849. }
  1850. }
  1851. /** Helper function that adds ipv4h_addr to a smartlist as a tor_addr_t *,
  1852. * as long as it is not tor_addr_is_null(), by converting it to a tor_addr_t
  1853. * and passing it to policies_add_addr_to_smartlist.
  1854. *
  1855. * The caller is responsible for freeing all the tor_addr_t* in the smartlist.
  1856. */
  1857. static void
  1858. policies_copy_ipv4h_to_smartlist(smartlist_t *addr_list, uint32_t ipv4h_addr)
  1859. {
  1860. if (ipv4h_addr) {
  1861. tor_addr_t ipv4_tor_addr;
  1862. tor_addr_from_ipv4h(&ipv4_tor_addr, ipv4h_addr);
  1863. policies_copy_addr_to_smartlist(addr_list, &ipv4_tor_addr);
  1864. }
  1865. }
  1866. /** Helper function that adds copies of or_options->OutboundBindAddresses
  1867. * to a smartlist as tor_addr_t *, as long as or_options is non-NULL, and
  1868. * the addresses are not tor_addr_is_null(), by passing them to
  1869. * policies_add_addr_to_smartlist.
  1870. *
  1871. * The caller is responsible for freeing all the tor_addr_t* in the smartlist.
  1872. */
  1873. static void
  1874. policies_copy_outbound_addresses_to_smartlist(smartlist_t *addr_list,
  1875. const or_options_t *or_options)
  1876. {
  1877. if (or_options) {
  1878. for (int i=0;i<OUTBOUND_ADDR_MAX;i++) {
  1879. for (int j=0;j<2;j++) {
  1880. if (!tor_addr_is_null(&or_options->OutboundBindAddresses[i][j])) {
  1881. policies_copy_addr_to_smartlist(addr_list,
  1882. &or_options->OutboundBindAddresses[i][j]);
  1883. }
  1884. }
  1885. }
  1886. }
  1887. }
  1888. /** Parse <b>ExitPolicy</b> member of <b>or_options</b> into <b>result</b>
  1889. * smartlist.
  1890. * If <b>or_options->IPv6Exit</b> is false, prepend an entry that
  1891. * rejects all IPv6 destinations.
  1892. *
  1893. * If <b>or_options->ExitPolicyRejectPrivate</b> is true:
  1894. * - prepend an entry that rejects all destinations in all netblocks reserved
  1895. * for private use.
  1896. * - if local_address is non-zero, treat it as a host-order IPv4 address, and
  1897. * add it to the list of configured addresses.
  1898. * - if ipv6_local_address is non-NULL, and not the null tor_addr_t, add it
  1899. * to the list of configured addresses.
  1900. * If <b>or_options->ExitPolicyRejectLocalInterfaces</b> is true:
  1901. * - if or_options->OutboundBindAddresses[][0] (=IPv4) is not the null
  1902. * tor_addr_t, add it to the list of configured addresses.
  1903. * - if or_options->OutboundBindAddresses[][1] (=IPv6) is not the null
  1904. * tor_addr_t, add it to the list of configured addresses.
  1905. *
  1906. * If <b>or_options->BridgeRelay</b> is false, append entries of default
  1907. * Tor exit policy into <b>result</b> smartlist.
  1908. *
  1909. * If or_options->ExitRelay is false, then make our exit policy into
  1910. * "reject *:*" regardless.
  1911. */
  1912. int
  1913. policies_parse_exit_policy_from_options(const or_options_t *or_options,
  1914. uint32_t local_address,
  1915. const tor_addr_t *ipv6_local_address,
  1916. smartlist_t **result)
  1917. {
  1918. exit_policy_parser_cfg_t parser_cfg = 0;
  1919. smartlist_t *configured_addresses = NULL;
  1920. int rv = 0;
  1921. /* Short-circuit for non-exit relays */
  1922. if (or_options->ExitRelay == 0) {
  1923. append_exit_policy_string(result, "reject *4:*");
  1924. append_exit_policy_string(result, "reject *6:*");
  1925. return 0;
  1926. }
  1927. configured_addresses = smartlist_new();
  1928. /* Configure the parser */
  1929. if (or_options->IPv6Exit) {
  1930. parser_cfg |= EXIT_POLICY_IPV6_ENABLED;
  1931. }
  1932. if (or_options->ExitPolicyRejectPrivate) {
  1933. parser_cfg |= EXIT_POLICY_REJECT_PRIVATE;
  1934. }
  1935. if (!or_options->BridgeRelay) {
  1936. if (or_options->ReducedExitPolicy)
  1937. parser_cfg |= EXIT_POLICY_ADD_REDUCED;
  1938. else
  1939. parser_cfg |= EXIT_POLICY_ADD_DEFAULT;
  1940. }
  1941. if (or_options->ExitPolicyRejectLocalInterfaces) {
  1942. parser_cfg |= EXIT_POLICY_REJECT_LOCAL_INTERFACES;
  1943. }
  1944. /* Copy the configured addresses into the tor_addr_t* list */
  1945. if (or_options->ExitPolicyRejectPrivate) {
  1946. policies_copy_ipv4h_to_smartlist(configured_addresses, local_address);
  1947. policies_copy_addr_to_smartlist(configured_addresses, ipv6_local_address);
  1948. }
  1949. if (or_options->ExitPolicyRejectLocalInterfaces) {
  1950. policies_copy_outbound_addresses_to_smartlist(configured_addresses,
  1951. or_options);
  1952. }
  1953. rv = policies_parse_exit_policy(or_options->ExitPolicy, result, parser_cfg,
  1954. configured_addresses);
  1955. SMARTLIST_FOREACH(configured_addresses, tor_addr_t *, a, tor_free(a));
  1956. smartlist_free(configured_addresses);
  1957. return rv;
  1958. }
  1959. /** Add "reject *:*" to the end of the policy in *<b>dest</b>, allocating
  1960. * *<b>dest</b> as needed. */
  1961. void
  1962. policies_exit_policy_append_reject_star(smartlist_t **dest)
  1963. {
  1964. append_exit_policy_string(dest, "reject *4:*");
  1965. append_exit_policy_string(dest, "reject *6:*");
  1966. }
  1967. /** Replace the exit policy of <b>node</b> with reject *:* */
  1968. void
  1969. policies_set_node_exitpolicy_to_reject_all(node_t *node)
  1970. {
  1971. node->rejects_all = 1;
  1972. }
  1973. /** Return 1 if there is at least one /8 subnet in <b>policy</b> that
  1974. * allows exiting to <b>port</b>. Otherwise, return 0. */
  1975. static int
  1976. exit_policy_is_general_exit_helper(smartlist_t *policy, int port)
  1977. {
  1978. uint32_t mask, ip, i;
  1979. /* Is this /8 rejected (1), or undecided (0)? */
  1980. char subnet_status[256];
  1981. memset(subnet_status, 0, sizeof(subnet_status));
  1982. SMARTLIST_FOREACH_BEGIN(policy, addr_policy_t *, p) {
  1983. if (tor_addr_family(&p->addr) != AF_INET)
  1984. continue; /* IPv4 only for now */
  1985. if (p->prt_min > port || p->prt_max < port)
  1986. continue; /* Doesn't cover our port. */
  1987. mask = 0;
  1988. tor_assert(p->maskbits <= 32);
  1989. if (p->maskbits)
  1990. mask = UINT32_MAX<<(32-p->maskbits);
  1991. ip = tor_addr_to_ipv4h(&p->addr);
  1992. /* Calculate the first and last subnet that this exit policy touches
  1993. * and set it as loop boundaries. */
  1994. for (i = ((mask & ip)>>24); i <= (~((mask & ip) ^ mask)>>24); ++i) {
  1995. tor_addr_t addr;
  1996. if (subnet_status[i] != 0)
  1997. continue; /* We already reject some part of this /8 */
  1998. tor_addr_from_ipv4h(&addr, i<<24);
  1999. if (tor_addr_is_internal(&addr, 0) &&
  2000. !get_options()->DirAllowPrivateAddresses) {
  2001. continue; /* Local or non-routable addresses */
  2002. }
  2003. if (p->policy_type == ADDR_POLICY_ACCEPT) {
  2004. if (p->maskbits > 8)
  2005. continue; /* Narrower than a /8. */
  2006. /* We found an allowed subnet of at least size /8. Done
  2007. * for this port! */
  2008. return 1;
  2009. } else if (p->policy_type == ADDR_POLICY_REJECT) {
  2010. subnet_status[i] = 1;
  2011. }
  2012. }
  2013. } SMARTLIST_FOREACH_END(p);
  2014. return 0;
  2015. }
  2016. /** Return true iff <b>ri</b> is "useful as an exit node", meaning
  2017. * it allows exit to at least one /8 address space for each of ports 80
  2018. * and 443. */
  2019. int
  2020. exit_policy_is_general_exit(smartlist_t *policy)
  2021. {
  2022. if (!policy) /*XXXX disallow NULL policies? */
  2023. return 0;
  2024. return (exit_policy_is_general_exit_helper(policy, 80) &&
  2025. exit_policy_is_general_exit_helper(policy, 443));
  2026. }
  2027. /** Return false if <b>policy</b> might permit access to some addr:port;
  2028. * otherwise if we are certain it rejects everything, return true. If no
  2029. * part of <b>policy</b> matches, return <b>default_reject</b>.
  2030. * NULL policies are allowed, and treated as empty. */
  2031. int
  2032. policy_is_reject_star(const smartlist_t *policy, sa_family_t family,
  2033. int default_reject)
  2034. {
  2035. if (!policy)
  2036. return default_reject;
  2037. SMARTLIST_FOREACH_BEGIN(policy, const addr_policy_t *, p) {
  2038. if (p->policy_type == ADDR_POLICY_ACCEPT &&
  2039. (tor_addr_family(&p->addr) == family ||
  2040. tor_addr_family(&p->addr) == AF_UNSPEC)) {
  2041. return 0;
  2042. } else if (p->policy_type == ADDR_POLICY_REJECT &&
  2043. p->prt_min <= 1 && p->prt_max == 65535 &&
  2044. p->maskbits == 0 &&
  2045. (tor_addr_family(&p->addr) == family ||
  2046. tor_addr_family(&p->addr) == AF_UNSPEC)) {
  2047. return 1;
  2048. }
  2049. } SMARTLIST_FOREACH_END(p);
  2050. return default_reject;
  2051. }
  2052. /** Write a single address policy to the buf_len byte buffer at buf. Return
  2053. * the number of characters written, or -1 on failure. */
  2054. int
  2055. policy_write_item(char *buf, size_t buflen, const addr_policy_t *policy,
  2056. int format_for_desc)
  2057. {
  2058. size_t written = 0;
  2059. char addrbuf[TOR_ADDR_BUF_LEN];
  2060. const char *addrpart;
  2061. int result;
  2062. const int is_accept = policy->policy_type == ADDR_POLICY_ACCEPT;
  2063. const sa_family_t family = tor_addr_family(&policy->addr);
  2064. const int is_ip6 = (family == AF_INET6);
  2065. tor_addr_to_str(addrbuf, &policy->addr, sizeof(addrbuf), 1);
  2066. /* write accept/reject 1.2.3.4 */
  2067. if (policy->is_private) {
  2068. addrpart = "private";
  2069. } else if (policy->maskbits == 0) {
  2070. if (format_for_desc)
  2071. addrpart = "*";
  2072. else if (family == AF_INET6)
  2073. addrpart = "*6";
  2074. else if (family == AF_INET)
  2075. addrpart = "*4";
  2076. else
  2077. addrpart = "*";
  2078. } else {
  2079. addrpart = addrbuf;
  2080. }
  2081. result = tor_snprintf(buf, buflen, "%s%s %s",
  2082. is_accept ? "accept" : "reject",
  2083. (is_ip6&&format_for_desc)?"6":"",
  2084. addrpart);
  2085. if (result < 0)
  2086. return -1;
  2087. written += strlen(buf);
  2088. /* If the maskbits is 32 (IPv4) or 128 (IPv6) we don't need to give it. If
  2089. the mask is 0, we already wrote "*". */
  2090. if (policy->maskbits < (is_ip6?128:32) && policy->maskbits > 0) {
  2091. if (tor_snprintf(buf+written, buflen-written, "/%d", policy->maskbits)<0)
  2092. return -1;
  2093. written += strlen(buf+written);
  2094. }
  2095. if (policy->prt_min <= 1 && policy->prt_max == 65535) {
  2096. /* There is no port set; write ":*" */
  2097. if (written+4 > buflen)
  2098. return -1;
  2099. strlcat(buf+written, ":*", buflen-written);
  2100. written += 2;
  2101. } else if (policy->prt_min == policy->prt_max) {
  2102. /* There is only one port; write ":80". */
  2103. result = tor_snprintf(buf+written, buflen-written, ":%d", policy->prt_min);
  2104. if (result<0)
  2105. return -1;
  2106. written += result;
  2107. } else {
  2108. /* There is a range of ports; write ":79-80". */
  2109. result = tor_snprintf(buf+written, buflen-written, ":%d-%d",
  2110. policy->prt_min, policy->prt_max);
  2111. if (result<0)
  2112. return -1;
  2113. written += result;
  2114. }
  2115. if (written < buflen)
  2116. buf[written] = '\0';
  2117. else
  2118. return -1;
  2119. return (int)written;
  2120. }
  2121. /** Create a new exit policy summary, initially only with a single
  2122. * port 1-64k item */
  2123. /* XXXX This entire thing will do most stuff in O(N^2), or worse. Use an
  2124. * RB-tree if that turns out to matter. */
  2125. static smartlist_t *
  2126. policy_summary_create(void)
  2127. {
  2128. smartlist_t *summary;
  2129. policy_summary_item_t* item;
  2130. item = tor_malloc_zero(sizeof(policy_summary_item_t));
  2131. item->prt_min = 1;
  2132. item->prt_max = 65535;
  2133. item->reject_count = 0;
  2134. item->accepted = 0;
  2135. summary = smartlist_new();
  2136. smartlist_add(summary, item);
  2137. return summary;
  2138. }
  2139. /** Split the summary item in <b>item</b> at the port <b>new_starts</b>.
  2140. * The current item is changed to end at new-starts - 1, the new item
  2141. * copies reject_count and accepted from the old item,
  2142. * starts at new_starts and ends at the port where the original item
  2143. * previously ended.
  2144. */
  2145. static policy_summary_item_t*
  2146. policy_summary_item_split(policy_summary_item_t* old, uint16_t new_starts)
  2147. {
  2148. policy_summary_item_t* new;
  2149. new = tor_malloc_zero(sizeof(policy_summary_item_t));
  2150. new->prt_min = new_starts;
  2151. new->prt_max = old->prt_max;
  2152. new->reject_count = old->reject_count;
  2153. new->accepted = old->accepted;
  2154. old->prt_max = new_starts-1;
  2155. tor_assert(old->prt_min <= old->prt_max);
  2156. tor_assert(new->prt_min <= new->prt_max);
  2157. return new;
  2158. }
  2159. /* XXXX Nick says I'm going to hell for this. If he feels charitably towards
  2160. * my immortal soul, he can clean it up himself. */
  2161. #define AT(x) ((policy_summary_item_t*)smartlist_get(summary, x))
  2162. #define IPV4_BITS (32)
  2163. /* Every IPv4 address is counted as one rejection */
  2164. #define REJECT_CUTOFF_SCALE_IPV4 (0)
  2165. /* Ports are rejected in an IPv4 summary if they are rejected in more than two
  2166. * IPv4 /8 address blocks */
  2167. #define REJECT_CUTOFF_COUNT_IPV4 (U64_LITERAL(1) << \
  2168. (IPV4_BITS - REJECT_CUTOFF_SCALE_IPV4 - 7))
  2169. #define IPV6_BITS (128)
  2170. /* IPv6 /64s are counted as one rejection, anything smaller is ignored */
  2171. #define REJECT_CUTOFF_SCALE_IPV6 (64)
  2172. /* Ports are rejected in an IPv6 summary if they are rejected in more than one
  2173. * IPv6 /16 address block.
  2174. * This is roughly equivalent to the IPv4 cutoff, as only five IPv6 /12s (and
  2175. * some scattered smaller blocks) have been allocated to the RIRs.
  2176. * Network providers are typically allocated one or more IPv6 /32s.
  2177. */
  2178. #define REJECT_CUTOFF_COUNT_IPV6 (U64_LITERAL(1) << \
  2179. (IPV6_BITS - REJECT_CUTOFF_SCALE_IPV6 - 16))
  2180. /** Split an exit policy summary so that prt_min and prt_max
  2181. * fall at exactly the start and end of an item respectively.
  2182. */
  2183. static int
  2184. policy_summary_split(smartlist_t *summary,
  2185. uint16_t prt_min, uint16_t prt_max)
  2186. {
  2187. int start_at_index;
  2188. int i = 0;
  2189. while (AT(i)->prt_max < prt_min)
  2190. i++;
  2191. if (AT(i)->prt_min != prt_min) {
  2192. policy_summary_item_t* new_item;
  2193. new_item = policy_summary_item_split(AT(i), prt_min);
  2194. smartlist_insert(summary, i+1, new_item);
  2195. i++;
  2196. }
  2197. start_at_index = i;
  2198. while (AT(i)->prt_max < prt_max)
  2199. i++;
  2200. if (AT(i)->prt_max != prt_max) {
  2201. policy_summary_item_t* new_item;
  2202. new_item = policy_summary_item_split(AT(i), prt_max+1);
  2203. smartlist_insert(summary, i+1, new_item);
  2204. }
  2205. return start_at_index;
  2206. }
  2207. /** Mark port ranges as accepted if they are below the reject_count for family
  2208. */
  2209. static void
  2210. policy_summary_accept(smartlist_t *summary,
  2211. uint16_t prt_min, uint16_t prt_max,
  2212. sa_family_t family)
  2213. {
  2214. tor_assert_nonfatal_once(family == AF_INET || family == AF_INET6);
  2215. uint64_t family_reject_count = ((family == AF_INET) ?
  2216. REJECT_CUTOFF_COUNT_IPV4 :
  2217. REJECT_CUTOFF_COUNT_IPV6);
  2218. int i = policy_summary_split(summary, prt_min, prt_max);
  2219. while (i < smartlist_len(summary) &&
  2220. AT(i)->prt_max <= prt_max) {
  2221. if (!AT(i)->accepted &&
  2222. AT(i)->reject_count <= family_reject_count)
  2223. AT(i)->accepted = 1;
  2224. i++;
  2225. }
  2226. tor_assert(i < smartlist_len(summary) || prt_max==65535);
  2227. }
  2228. /** Count the number of addresses in a network in family with prefixlen
  2229. * maskbits against the given portrange. */
  2230. static void
  2231. policy_summary_reject(smartlist_t *summary,
  2232. maskbits_t maskbits,
  2233. uint16_t prt_min, uint16_t prt_max,
  2234. sa_family_t family)
  2235. {
  2236. tor_assert_nonfatal_once(family == AF_INET || family == AF_INET6);
  2237. int i = policy_summary_split(summary, prt_min, prt_max);
  2238. /* The length of a single address mask */
  2239. int addrbits = (family == AF_INET) ? IPV4_BITS : IPV6_BITS;
  2240. tor_assert_nonfatal_once(addrbits >= maskbits);
  2241. /* We divide IPv6 address counts by (1 << scale) to keep them in a uint64_t
  2242. */
  2243. int scale = ((family == AF_INET) ?
  2244. REJECT_CUTOFF_SCALE_IPV4 :
  2245. REJECT_CUTOFF_SCALE_IPV6);
  2246. tor_assert_nonfatal_once(addrbits >= scale);
  2247. if (maskbits > (addrbits - scale)) {
  2248. tor_assert_nonfatal_once(family == AF_INET6);
  2249. /* The address range is so small, we'd need billions of them to reach the
  2250. * rejection limit. So we ignore this range in the reject count. */
  2251. return;
  2252. }
  2253. uint64_t count = 0;
  2254. if (addrbits - scale - maskbits >= 64) {
  2255. tor_assert_nonfatal_once(family == AF_INET6);
  2256. /* The address range is so large, it's an automatic rejection for all ports
  2257. * in the range. */
  2258. count = UINT64_MAX;
  2259. } else {
  2260. count = (U64_LITERAL(1) << (addrbits - scale - maskbits));
  2261. }
  2262. tor_assert_nonfatal_once(count > 0);
  2263. while (i < smartlist_len(summary) &&
  2264. AT(i)->prt_max <= prt_max) {
  2265. if (AT(i)->reject_count <= UINT64_MAX - count) {
  2266. AT(i)->reject_count += count;
  2267. } else {
  2268. /* IPv4 would require a 4-billion address redundant policy to get here,
  2269. * but IPv6 just needs to have ::/0 */
  2270. if (family == AF_INET) {
  2271. tor_assert_nonfatal_unreached_once();
  2272. }
  2273. /* If we do get here, use saturating arithmetic */
  2274. AT(i)->reject_count = UINT64_MAX;
  2275. }
  2276. i++;
  2277. }
  2278. tor_assert(i < smartlist_len(summary) || prt_max==65535);
  2279. }
  2280. /** Add a single exit policy item to our summary:
  2281. *
  2282. * If it is an accept, ignore it unless it is for all IP addresses
  2283. * ("*", i.e. its prefixlen/maskbits is 0). Otherwise call
  2284. * policy_summary_accept().
  2285. *
  2286. * If it is a reject, ignore it if it is about one of the private
  2287. * networks. Otherwise call policy_summary_reject().
  2288. */
  2289. static void
  2290. policy_summary_add_item(smartlist_t *summary, addr_policy_t *p)
  2291. {
  2292. if (p->policy_type == ADDR_POLICY_ACCEPT) {
  2293. if (p->maskbits == 0) {
  2294. policy_summary_accept(summary, p->prt_min, p->prt_max, p->addr.family);
  2295. }
  2296. } else if (p->policy_type == ADDR_POLICY_REJECT) {
  2297. int is_private = 0;
  2298. int i;
  2299. for (i = 0; private_nets[i]; ++i) {
  2300. tor_addr_t addr;
  2301. maskbits_t maskbits;
  2302. if (tor_addr_parse_mask_ports(private_nets[i], 0, &addr,
  2303. &maskbits, NULL, NULL)<0) {
  2304. tor_assert(0);
  2305. }
  2306. if (tor_addr_compare(&p->addr, &addr, CMP_EXACT) == 0 &&
  2307. p->maskbits == maskbits) {
  2308. is_private = 1;
  2309. break;
  2310. }
  2311. }
  2312. if (!is_private) {
  2313. policy_summary_reject(summary, p->maskbits, p->prt_min, p->prt_max,
  2314. p->addr.family);
  2315. }
  2316. } else
  2317. tor_assert(0);
  2318. }
  2319. /** Create a string representing a summary for an exit policy.
  2320. * The summary will either be an "accept" plus a comma-separated list of port
  2321. * ranges or a "reject" plus port-ranges, depending on which is shorter.
  2322. *
  2323. * If no exits are allowed at all then "reject 1-65535" is returned. If no
  2324. * ports are blocked instead of "reject " we return "accept 1-65535". (These
  2325. * are an exception to the shorter-representation-wins rule).
  2326. */
  2327. char *
  2328. policy_summarize(smartlist_t *policy, sa_family_t family)
  2329. {
  2330. smartlist_t *summary = policy_summary_create();
  2331. smartlist_t *accepts, *rejects;
  2332. int i, last, start_prt;
  2333. size_t accepts_len, rejects_len;
  2334. char *accepts_str = NULL, *rejects_str = NULL, *shorter_str, *result;
  2335. const char *prefix;
  2336. tor_assert(policy);
  2337. /* Create the summary list */
  2338. SMARTLIST_FOREACH_BEGIN(policy, addr_policy_t *, p) {
  2339. sa_family_t f = tor_addr_family(&p->addr);
  2340. if (f != AF_INET && f != AF_INET6) {
  2341. log_warn(LD_BUG, "Weird family when summarizing address policy");
  2342. }
  2343. if (f != family)
  2344. continue;
  2345. policy_summary_add_item(summary, p);
  2346. } SMARTLIST_FOREACH_END(p);
  2347. /* Now create two lists of strings, one for accepted and one
  2348. * for rejected ports. We take care to merge ranges so that
  2349. * we avoid getting stuff like "1-4,5-9,10", instead we want
  2350. * "1-10"
  2351. */
  2352. i = 0;
  2353. start_prt = 1;
  2354. accepts = smartlist_new();
  2355. rejects = smartlist_new();
  2356. while (1) {
  2357. last = i == smartlist_len(summary)-1;
  2358. if (last ||
  2359. AT(i)->accepted != AT(i+1)->accepted) {
  2360. char buf[POLICY_BUF_LEN];
  2361. if (start_prt == AT(i)->prt_max)
  2362. tor_snprintf(buf, sizeof(buf), "%d", start_prt);
  2363. else
  2364. tor_snprintf(buf, sizeof(buf), "%d-%d", start_prt, AT(i)->prt_max);
  2365. if (AT(i)->accepted)
  2366. smartlist_add_strdup(accepts, buf);
  2367. else
  2368. smartlist_add_strdup(rejects, buf);
  2369. if (last)
  2370. break;
  2371. start_prt = AT(i+1)->prt_min;
  2372. };
  2373. i++;
  2374. };
  2375. /* Figure out which of the two stringlists will be shorter and use
  2376. * that to build the result
  2377. */
  2378. if (smartlist_len(accepts) == 0) { /* no exits at all */
  2379. result = tor_strdup("reject 1-65535");
  2380. goto cleanup;
  2381. }
  2382. if (smartlist_len(rejects) == 0) { /* no rejects at all */
  2383. result = tor_strdup("accept 1-65535");
  2384. goto cleanup;
  2385. }
  2386. accepts_str = smartlist_join_strings(accepts, ",", 0, &accepts_len);
  2387. rejects_str = smartlist_join_strings(rejects, ",", 0, &rejects_len);
  2388. if (rejects_len > MAX_EXITPOLICY_SUMMARY_LEN-strlen("reject")-1 &&
  2389. accepts_len > MAX_EXITPOLICY_SUMMARY_LEN-strlen("accept")-1) {
  2390. char *c;
  2391. shorter_str = accepts_str;
  2392. prefix = "accept";
  2393. c = shorter_str + (MAX_EXITPOLICY_SUMMARY_LEN-strlen(prefix)-1);
  2394. while (*c != ',' && c >= shorter_str)
  2395. c--;
  2396. tor_assert(c >= shorter_str);
  2397. tor_assert(*c == ',');
  2398. *c = '\0';
  2399. } else if (rejects_len < accepts_len) {
  2400. shorter_str = rejects_str;
  2401. prefix = "reject";
  2402. } else {
  2403. shorter_str = accepts_str;
  2404. prefix = "accept";
  2405. }
  2406. tor_asprintf(&result, "%s %s", prefix, shorter_str);
  2407. cleanup:
  2408. /* cleanup */
  2409. SMARTLIST_FOREACH(summary, policy_summary_item_t *, s, tor_free(s));
  2410. smartlist_free(summary);
  2411. tor_free(accepts_str);
  2412. SMARTLIST_FOREACH(accepts, char *, s, tor_free(s));
  2413. smartlist_free(accepts);
  2414. tor_free(rejects_str);
  2415. SMARTLIST_FOREACH(rejects, char *, s, tor_free(s));
  2416. smartlist_free(rejects);
  2417. return result;
  2418. }
  2419. /** Convert a summarized policy string into a short_policy_t. Return NULL
  2420. * if the string is not well-formed. */
  2421. short_policy_t *
  2422. parse_short_policy(const char *summary)
  2423. {
  2424. const char *orig_summary = summary;
  2425. short_policy_t *result;
  2426. int is_accept;
  2427. int n_entries;
  2428. short_policy_entry_t entries[MAX_EXITPOLICY_SUMMARY_LEN]; /* overkill */
  2429. const char *next;
  2430. if (!strcmpstart(summary, "accept ")) {
  2431. is_accept = 1;
  2432. summary += strlen("accept ");
  2433. } else if (!strcmpstart(summary, "reject ")) {
  2434. is_accept = 0;
  2435. summary += strlen("reject ");
  2436. } else {
  2437. log_fn(LOG_PROTOCOL_WARN, LD_DIR, "Unrecognized policy summary keyword");
  2438. return NULL;
  2439. }
  2440. n_entries = 0;
  2441. for ( ; *summary; summary = next) {
  2442. const char *comma = strchr(summary, ',');
  2443. unsigned low, high;
  2444. char dummy;
  2445. char ent_buf[32];
  2446. size_t len;
  2447. next = comma ? comma+1 : strchr(summary, '\0');
  2448. len = comma ? (size_t)(comma - summary) : strlen(summary);
  2449. if (n_entries == MAX_EXITPOLICY_SUMMARY_LEN) {
  2450. log_fn(LOG_PROTOCOL_WARN, LD_DIR, "Impossibly long policy summary %s",
  2451. escaped(orig_summary));
  2452. return NULL;
  2453. }
  2454. if (! TOR_ISDIGIT(*summary) || len > (sizeof(ent_buf)-1)) {
  2455. /* unrecognized entry format. skip it. */
  2456. continue;
  2457. }
  2458. if (len < 1) {
  2459. /* empty; skip it. */
  2460. /* XXX This happens to be unreachable, since if len==0, then *summary is
  2461. * ',' or '\0', and the TOR_ISDIGIT test above would have failed. */
  2462. continue;
  2463. }
  2464. memcpy(ent_buf, summary, len);
  2465. ent_buf[len] = '\0';
  2466. if (tor_sscanf(ent_buf, "%u-%u%c", &low, &high, &dummy) == 2) {
  2467. if (low<1 || low>65535 || high<1 || high>65535 || low>high) {
  2468. log_fn(LOG_PROTOCOL_WARN, LD_DIR,
  2469. "Found bad entry in policy summary %s", escaped(orig_summary));
  2470. return NULL;
  2471. }
  2472. } else if (tor_sscanf(ent_buf, "%u%c", &low, &dummy) == 1) {
  2473. if (low<1 || low>65535) {
  2474. log_fn(LOG_PROTOCOL_WARN, LD_DIR,
  2475. "Found bad entry in policy summary %s", escaped(orig_summary));
  2476. return NULL;
  2477. }
  2478. high = low;
  2479. } else {
  2480. log_fn(LOG_PROTOCOL_WARN, LD_DIR,"Found bad entry in policy summary %s",
  2481. escaped(orig_summary));
  2482. return NULL;
  2483. }
  2484. entries[n_entries].min_port = low;
  2485. entries[n_entries].max_port = high;
  2486. n_entries++;
  2487. }
  2488. if (n_entries == 0) {
  2489. log_fn(LOG_PROTOCOL_WARN, LD_DIR,
  2490. "Found no port-range entries in summary %s", escaped(orig_summary));
  2491. return NULL;
  2492. }
  2493. {
  2494. size_t size = offsetof(short_policy_t, entries) +
  2495. sizeof(short_policy_entry_t)*(n_entries);
  2496. result = tor_malloc_zero(size);
  2497. tor_assert( (char*)&result->entries[n_entries-1] < ((char*)result)+size);
  2498. }
  2499. result->is_accept = is_accept;
  2500. result->n_entries = n_entries;
  2501. memcpy(result->entries, entries, sizeof(short_policy_entry_t)*n_entries);
  2502. return result;
  2503. }
  2504. /** Write <b>policy</b> back out into a string. */
  2505. char *
  2506. write_short_policy(const short_policy_t *policy)
  2507. {
  2508. int i;
  2509. char *answer;
  2510. smartlist_t *sl = smartlist_new();
  2511. smartlist_add_asprintf(sl, "%s", policy->is_accept ? "accept " : "reject ");
  2512. for (i=0; i < policy->n_entries; i++) {
  2513. const short_policy_entry_t *e = &policy->entries[i];
  2514. if (e->min_port == e->max_port) {
  2515. smartlist_add_asprintf(sl, "%d", e->min_port);
  2516. } else {
  2517. smartlist_add_asprintf(sl, "%d-%d", e->min_port, e->max_port);
  2518. }
  2519. if (i < policy->n_entries-1)
  2520. smartlist_add_strdup(sl, ",");
  2521. }
  2522. answer = smartlist_join_strings(sl, "", 0, NULL);
  2523. SMARTLIST_FOREACH(sl, char *, a, tor_free(a));
  2524. smartlist_free(sl);
  2525. return answer;
  2526. }
  2527. /** Release all storage held in <b>policy</b>. */
  2528. void
  2529. short_policy_free_(short_policy_t *policy)
  2530. {
  2531. tor_free(policy);
  2532. }
  2533. /** See whether the <b>addr</b>:<b>port</b> address is likely to be accepted
  2534. * or rejected by the summarized policy <b>policy</b>. Return values are as
  2535. * for compare_tor_addr_to_addr_policy. Unlike the regular addr_policy
  2536. * functions, requires the <b>port</b> be specified. */
  2537. addr_policy_result_t
  2538. compare_tor_addr_to_short_policy(const tor_addr_t *addr, uint16_t port,
  2539. const short_policy_t *policy)
  2540. {
  2541. int i;
  2542. int found_match = 0;
  2543. int accept_;
  2544. tor_assert(port != 0);
  2545. if (addr && tor_addr_is_null(addr))
  2546. addr = NULL; /* Unspec means 'no address at all,' in this context. */
  2547. if (addr && get_options()->ClientRejectInternalAddresses &&
  2548. (tor_addr_is_internal(addr, 0) || tor_addr_is_loopback(addr)))
  2549. return ADDR_POLICY_REJECTED;
  2550. for (i=0; i < policy->n_entries; ++i) {
  2551. const short_policy_entry_t *e = &policy->entries[i];
  2552. if (e->min_port <= port && port <= e->max_port) {
  2553. found_match = 1;
  2554. break;
  2555. }
  2556. }
  2557. if (found_match)
  2558. accept_ = policy->is_accept;
  2559. else
  2560. accept_ = ! policy->is_accept;
  2561. /* ???? are these right? -NM */
  2562. /* We should be sure not to return ADDR_POLICY_ACCEPTED in the accept
  2563. * case here, because it would cause clients to believe that the node
  2564. * allows exit enclaving. Trying it anyway would open up a cool attack
  2565. * where the node refuses due to exitpolicy, the client reacts in
  2566. * surprise by rewriting the node's exitpolicy to reject *:*, and then
  2567. * an adversary targets users by causing them to attempt such connections
  2568. * to 98% of the exits.
  2569. *
  2570. * Once microdescriptors can handle addresses in special cases (e.g. if
  2571. * we ever solve ticket 1774), we can provide certainty here. -RD */
  2572. if (accept_)
  2573. return ADDR_POLICY_PROBABLY_ACCEPTED;
  2574. else
  2575. return ADDR_POLICY_REJECTED;
  2576. }
  2577. /** Return true iff <b>policy</b> seems reject all ports */
  2578. int
  2579. short_policy_is_reject_star(const short_policy_t *policy)
  2580. {
  2581. /* This doesn't need to be as much on the lookout as policy_is_reject_star,
  2582. * since policy summaries are from the consensus or from consensus
  2583. * microdescs.
  2584. */
  2585. tor_assert(policy);
  2586. /* Check for an exact match of "reject 1-65535". */
  2587. return (policy->is_accept == 0 && policy->n_entries == 1 &&
  2588. policy->entries[0].min_port == 1 &&
  2589. policy->entries[0].max_port == 65535);
  2590. }
  2591. /** Decide whether addr:port is probably or definitely accepted or rejected by
  2592. * <b>node</b>. See compare_tor_addr_to_addr_policy for details on addr/port
  2593. * interpretation. */
  2594. addr_policy_result_t
  2595. compare_tor_addr_to_node_policy(const tor_addr_t *addr, uint16_t port,
  2596. const node_t *node)
  2597. {
  2598. if (node->rejects_all)
  2599. return ADDR_POLICY_REJECTED;
  2600. if (addr && tor_addr_family(addr) == AF_INET6) {
  2601. const short_policy_t *p = NULL;
  2602. if (node->ri)
  2603. p = node->ri->ipv6_exit_policy;
  2604. else if (node->md)
  2605. p = node->md->ipv6_exit_policy;
  2606. if (p)
  2607. return compare_tor_addr_to_short_policy(addr, port, p);
  2608. else
  2609. return ADDR_POLICY_REJECTED;
  2610. }
  2611. if (node->ri) {
  2612. return compare_tor_addr_to_addr_policy(addr, port, node->ri->exit_policy);
  2613. } else if (node->md) {
  2614. if (node->md->exit_policy == NULL)
  2615. return ADDR_POLICY_REJECTED;
  2616. else
  2617. return compare_tor_addr_to_short_policy(addr, port,
  2618. node->md->exit_policy);
  2619. } else {
  2620. return ADDR_POLICY_PROBABLY_REJECTED;
  2621. }
  2622. }
  2623. /**
  2624. * Given <b>policy_list</b>, a list of addr_policy_t, produce a string
  2625. * representation of the list.
  2626. * If <b>include_ipv4</b> is true, include IPv4 entries.
  2627. * If <b>include_ipv6</b> is true, include IPv6 entries.
  2628. */
  2629. char *
  2630. policy_dump_to_string(const smartlist_t *policy_list,
  2631. int include_ipv4,
  2632. int include_ipv6)
  2633. {
  2634. smartlist_t *policy_string_list;
  2635. char *policy_string = NULL;
  2636. policy_string_list = smartlist_new();
  2637. SMARTLIST_FOREACH_BEGIN(policy_list, addr_policy_t *, tmpe) {
  2638. char *pbuf;
  2639. int bytes_written_to_pbuf;
  2640. if ((tor_addr_family(&tmpe->addr) == AF_INET6) && (!include_ipv6)) {
  2641. continue; /* Don't include IPv6 parts of address policy */
  2642. }
  2643. if ((tor_addr_family(&tmpe->addr) == AF_INET) && (!include_ipv4)) {
  2644. continue; /* Don't include IPv4 parts of address policy */
  2645. }
  2646. pbuf = tor_malloc(POLICY_BUF_LEN);
  2647. bytes_written_to_pbuf = policy_write_item(pbuf,POLICY_BUF_LEN, tmpe, 1);
  2648. if (bytes_written_to_pbuf < 0) {
  2649. log_warn(LD_BUG, "policy_dump_to_string ran out of room!");
  2650. tor_free(pbuf);
  2651. goto done;
  2652. }
  2653. smartlist_add(policy_string_list,pbuf);
  2654. } SMARTLIST_FOREACH_END(tmpe);
  2655. policy_string = smartlist_join_strings(policy_string_list, "\n", 0, NULL);
  2656. done:
  2657. SMARTLIST_FOREACH(policy_string_list, char *, str, tor_free(str));
  2658. smartlist_free(policy_string_list);
  2659. return policy_string;
  2660. }
  2661. /** Implementation for GETINFO control command: knows the answer for questions
  2662. * about "exit-policy/..." */
  2663. int
  2664. getinfo_helper_policies(control_connection_t *conn,
  2665. const char *question, char **answer,
  2666. const char **errmsg)
  2667. {
  2668. (void) conn;
  2669. (void) errmsg;
  2670. if (!strcmp(question, "exit-policy/default")) {
  2671. *answer = tor_strdup(DEFAULT_EXIT_POLICY);
  2672. } else if (!strcmp(question, "exit-policy/reject-private/default")) {
  2673. smartlist_t *private_policy_strings;
  2674. const char **priv = private_nets;
  2675. private_policy_strings = smartlist_new();
  2676. while (*priv != NULL) {
  2677. /* IPv6 addresses are in "[]" and contain ":",
  2678. * IPv4 addresses are not in "[]" and contain "." */
  2679. smartlist_add_asprintf(private_policy_strings, "reject %s:*", *priv);
  2680. priv++;
  2681. }
  2682. *answer = smartlist_join_strings(private_policy_strings,
  2683. ",", 0, NULL);
  2684. SMARTLIST_FOREACH(private_policy_strings, char *, str, tor_free(str));
  2685. smartlist_free(private_policy_strings);
  2686. } else if (!strcmp(question, "exit-policy/reject-private/relay")) {
  2687. const or_options_t *options = get_options();
  2688. int err = 0;
  2689. const routerinfo_t *me = router_get_my_routerinfo_with_err(&err);
  2690. if (!me) {
  2691. *errmsg = routerinfo_err_to_string(err);
  2692. return routerinfo_err_is_transient(err) ? -1 : 0;
  2693. }
  2694. if (!options->ExitPolicyRejectPrivate &&
  2695. !options->ExitPolicyRejectLocalInterfaces) {
  2696. *answer = tor_strdup("");
  2697. return 0;
  2698. }
  2699. smartlist_t *private_policy_list = smartlist_new();
  2700. smartlist_t *configured_addresses = smartlist_new();
  2701. /* Copy the configured addresses into the tor_addr_t* list */
  2702. if (options->ExitPolicyRejectPrivate) {
  2703. policies_copy_ipv4h_to_smartlist(configured_addresses, me->addr);
  2704. policies_copy_addr_to_smartlist(configured_addresses, &me->ipv6_addr);
  2705. }
  2706. if (options->ExitPolicyRejectLocalInterfaces) {
  2707. policies_copy_outbound_addresses_to_smartlist(configured_addresses,
  2708. options);
  2709. }
  2710. policies_parse_exit_policy_reject_private(
  2711. &private_policy_list,
  2712. options->IPv6Exit,
  2713. configured_addresses,
  2714. options->ExitPolicyRejectLocalInterfaces,
  2715. options->ExitPolicyRejectLocalInterfaces);
  2716. *answer = policy_dump_to_string(private_policy_list, 1, 1);
  2717. addr_policy_list_free(private_policy_list);
  2718. SMARTLIST_FOREACH(configured_addresses, tor_addr_t *, a, tor_free(a));
  2719. smartlist_free(configured_addresses);
  2720. } else if (!strcmpstart(question, "exit-policy/")) {
  2721. int include_ipv4 = 0;
  2722. int include_ipv6 = 0;
  2723. int err = 0;
  2724. const routerinfo_t *me = router_get_my_routerinfo_with_err(&err);
  2725. if (!me) {
  2726. *errmsg = routerinfo_err_to_string(err);
  2727. return routerinfo_err_is_transient(err) ? -1 : 0;
  2728. }
  2729. if (!strcmp(question, "exit-policy/ipv4")) {
  2730. include_ipv4 = 1;
  2731. } else if (!strcmp(question, "exit-policy/ipv6")) {
  2732. include_ipv6 = 1;
  2733. } else if (!strcmp(question, "exit-policy/full")) {
  2734. include_ipv4 = include_ipv6 = 1;
  2735. } else {
  2736. return 0; /* No such key. */
  2737. }
  2738. *answer = router_dump_exit_policy_to_string(me,include_ipv4,
  2739. include_ipv6);
  2740. }
  2741. return 0;
  2742. }
  2743. /** Release all storage held by <b>p</b>. */
  2744. void
  2745. addr_policy_list_free_(smartlist_t *lst)
  2746. {
  2747. if (!lst)
  2748. return;
  2749. SMARTLIST_FOREACH(lst, addr_policy_t *, policy, addr_policy_free(policy));
  2750. smartlist_free(lst);
  2751. }
  2752. /** Release all storage held by <b>p</b>. */
  2753. void
  2754. addr_policy_free_(addr_policy_t *p)
  2755. {
  2756. if (!p)
  2757. return;
  2758. if (--p->refcnt <= 0) {
  2759. if (p->is_canonical) {
  2760. policy_map_ent_t search, *found;
  2761. search.policy = p;
  2762. found = HT_REMOVE(policy_map, &policy_root, &search);
  2763. if (found) {
  2764. tor_assert(p == found->policy);
  2765. tor_free(found);
  2766. }
  2767. }
  2768. tor_free(p);
  2769. }
  2770. }
  2771. /** Release all storage held by policy variables. */
  2772. void
  2773. policies_free_all(void)
  2774. {
  2775. addr_policy_list_free(reachable_or_addr_policy);
  2776. reachable_or_addr_policy = NULL;
  2777. addr_policy_list_free(reachable_dir_addr_policy);
  2778. reachable_dir_addr_policy = NULL;
  2779. addr_policy_list_free(socks_policy);
  2780. socks_policy = NULL;
  2781. addr_policy_list_free(dir_policy);
  2782. dir_policy = NULL;
  2783. addr_policy_list_free(authdir_reject_policy);
  2784. authdir_reject_policy = NULL;
  2785. addr_policy_list_free(authdir_invalid_policy);
  2786. authdir_invalid_policy = NULL;
  2787. addr_policy_list_free(authdir_badexit_policy);
  2788. authdir_badexit_policy = NULL;
  2789. if (!HT_EMPTY(&policy_root)) {
  2790. policy_map_ent_t **ent;
  2791. int n = 0;
  2792. char buf[POLICY_BUF_LEN];
  2793. log_warn(LD_MM, "Still had %d address policies cached at shutdown.",
  2794. (int)HT_SIZE(&policy_root));
  2795. /* Note the first 10 cached policies to try to figure out where they
  2796. * might be coming from. */
  2797. HT_FOREACH(ent, policy_map, &policy_root) {
  2798. if (++n > 10)
  2799. break;
  2800. if (policy_write_item(buf, sizeof(buf), (*ent)->policy, 0) >= 0)
  2801. log_warn(LD_MM," %d [%d]: %s", n, (*ent)->policy->refcnt, buf);
  2802. }
  2803. }
  2804. HT_CLEAR(policy_map, &policy_root);
  2805. }