policies.c 111 KB

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