routerparse.c 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562
  1. /* Copyright 2001 Matej Pfajfar.
  2. * Copyright 2001-2004 Roger Dingledine.
  3. * Copyright 2004 Roger Dingledine, Nick Mathewson. */
  4. /* See LICENSE for licensing information */
  5. /* $Id$ */
  6. const char routerparse_c_id[] = "$Id$";
  7. /**
  8. * \file routerparse.c
  9. *
  10. * \brief Code to parse and validate router descriptors and directories.
  11. **/
  12. #include "or.h"
  13. /****************************************************************************/
  14. /** Enumeration of possible token types. The ones starting with K_
  15. * correspond to directory 'keywords'. _UNRECOGNIZED is for an
  16. * unrecognized keyword; _ERR is an error in the tokenizing process,
  17. * _EOF is an end-of-file marker, and _NIL is used to encode
  18. * not-a-token.
  19. */
  20. typedef enum {
  21. K_ACCEPT,
  22. K_DIRECTORY_SIGNATURE,
  23. K_RECOMMENDED_SOFTWARE,
  24. K_REJECT,
  25. K_ROUTER,
  26. K_SIGNED_DIRECTORY,
  27. K_SIGNING_KEY,
  28. K_ONION_KEY,
  29. K_ROUTER_SIGNATURE,
  30. K_PUBLISHED,
  31. K_RUNNING_ROUTERS,
  32. K_ROUTER_STATUS,
  33. K_PLATFORM,
  34. K_OPT,
  35. K_BANDWIDTH,
  36. K_PORTS,
  37. K_DIRCACHEPORT,
  38. K_CONTACT,
  39. K_NETWORK_STATUS,
  40. K_UPTIME,
  41. K_DIR_SIGNING_KEY,
  42. K_FAMILY,
  43. _UNRECOGNIZED,
  44. _ERR,
  45. _EOF,
  46. _NIL
  47. } directory_keyword;
  48. /** Structure to hold a single directory token.
  49. *
  50. * We parse a directory by breaking it into "tokens", each consisting
  51. * of a keyword, a line full of arguments, and a binary object. The
  52. * arguments and object are both optional, depending on the keyword
  53. * type.
  54. */
  55. typedef struct directory_token_t {
  56. directory_keyword tp; /**< Type of the token. */
  57. int n_args; /**< Number of elements in args */
  58. char **args; /**< Array of arguments from keyword line. */
  59. char *object_type; /**< -----BEGIN [object_type]-----*/
  60. size_t object_size; /**< Bytes in object_body */
  61. char *object_body; /**< Contents of object, base64-decoded. */
  62. crypto_pk_env_t *key; /**< For public keys only. */
  63. const char *error; /**< For _ERR tokens only. */
  64. } directory_token_t;
  65. /* ********************************************************************** */
  66. /** We use a table of rules to decide how to parse each token type. */
  67. /** Rules for how many arguments a keyword can take. */
  68. typedef enum {
  69. NO_ARGS, /**< (1) no arguments, ever */
  70. ARGS, /**< (2) a list of arguments separated by spaces */
  71. CONCAT_ARGS, /**< or (3) the rest of the line, treated as a single argument. */
  72. } arg_syntax;
  73. /** Rules for whether the keyword needs an object. */
  74. typedef enum {
  75. NO_OBJ, /**< (1) no object, ever */
  76. NEED_OBJ, /**< (2) object is required */
  77. NEED_KEY, /**< (3) object is required, and must be a public key. */
  78. OBJ_OK, /**< or (4) object is optional. */
  79. } obj_syntax;
  80. /** Rules for where a keyword can appear. */
  81. typedef enum {
  82. ANY = 0, /**< Appears in router descriptor or in directory sections. */
  83. DIR_ONLY, /**< Appears only in directory. */
  84. RTR_ONLY, /**< Appears only in router descriptor or runningrouters */
  85. } where_syntax;
  86. /** Table mapping keywords to token value and to argument rules. */
  87. static struct {
  88. const char *t; int v; arg_syntax s; obj_syntax os; where_syntax ws;
  89. } token_table[] = {
  90. { "accept", K_ACCEPT, ARGS, NO_OBJ, RTR_ONLY },
  91. { "directory-signature", K_DIRECTORY_SIGNATURE, ARGS, NEED_OBJ,DIR_ONLY},
  92. { "reject", K_REJECT, ARGS, NO_OBJ, RTR_ONLY },
  93. { "router", K_ROUTER, ARGS, NO_OBJ, RTR_ONLY },
  94. { "recommended-software",K_RECOMMENDED_SOFTWARE,ARGS, NO_OBJ, DIR_ONLY },
  95. { "signed-directory", K_SIGNED_DIRECTORY, NO_ARGS, NO_OBJ, DIR_ONLY },
  96. { "signing-key", K_SIGNING_KEY, NO_ARGS, NEED_KEY,RTR_ONLY },
  97. { "onion-key", K_ONION_KEY, NO_ARGS, NEED_KEY,RTR_ONLY },
  98. { "router-signature", K_ROUTER_SIGNATURE, NO_ARGS, NEED_OBJ,RTR_ONLY },
  99. { "running-routers", K_RUNNING_ROUTERS, ARGS, NO_OBJ, DIR_ONLY },
  100. { "router-status", K_ROUTER_STATUS, ARGS, NO_OBJ, DIR_ONLY },
  101. { "ports", K_PORTS, ARGS, NO_OBJ, RTR_ONLY },
  102. { "bandwidth", K_BANDWIDTH, ARGS, NO_OBJ, RTR_ONLY },
  103. { "platform", K_PLATFORM, CONCAT_ARGS, NO_OBJ, RTR_ONLY },
  104. { "published", K_PUBLISHED, CONCAT_ARGS, NO_OBJ, ANY },
  105. { "opt", K_OPT, CONCAT_ARGS, OBJ_OK, ANY },
  106. { "dircacheport", K_DIRCACHEPORT, ARGS, NO_OBJ, RTR_ONLY },
  107. { "contact", K_CONTACT, CONCAT_ARGS, NO_OBJ, ANY },
  108. { "network-status", K_NETWORK_STATUS, NO_ARGS, NO_OBJ, DIR_ONLY },
  109. { "uptime", K_UPTIME, ARGS, NO_OBJ, RTR_ONLY },
  110. { "dir-signing-key", K_DIR_SIGNING_KEY, ARGS, OBJ_OK, DIR_ONLY },
  111. { "family", K_FAMILY, ARGS, NO_OBJ, RTR_ONLY },
  112. { NULL, -1, NO_ARGS, NO_OBJ, ANY }
  113. };
  114. /* static function prototypes */
  115. static int router_add_exit_policy(routerinfo_t *router,directory_token_t *tok);
  116. static addr_policy_t *router_parse_addr_policy(directory_token_t *tok);
  117. static int router_get_hash_impl(const char *s, char *digest,
  118. const char *start_str, const char *end_str);
  119. static void token_free(directory_token_t *tok);
  120. static smartlist_t *find_all_exitpolicy(smartlist_t *s);
  121. static directory_token_t *find_first_by_keyword(smartlist_t *s,
  122. directory_keyword keyword);
  123. static int tokenize_string(const char *start, const char *end,
  124. smartlist_t *out, int is_dir);
  125. static directory_token_t *get_next_token(const char **s, where_syntax where);
  126. static int check_directory_signature(const char *digest,
  127. directory_token_t *tok,
  128. crypto_pk_env_t *pkey,
  129. crypto_pk_env_t *declared_key);
  130. static crypto_pk_env_t *find_dir_signing_key(const char *str);
  131. /* static */ int is_obsolete_version(const char *myversion,
  132. const char *versionlist);
  133. /** Set <b>digest</b> to the SHA-1 digest of the hash of the directory in
  134. * <b>s</b>. Return 0 on success, nonzero on failure.
  135. */
  136. int router_get_dir_hash(const char *s, char *digest)
  137. {
  138. return router_get_hash_impl(s,digest,
  139. "signed-directory","\ndirectory-signature");
  140. }
  141. /** Set <b>digest</b> to the SHA-1 digest of the hash of the first router in
  142. * <b>s</b>. Return 0 on success, nonzero on failure.
  143. */
  144. int router_get_router_hash(const char *s, char *digest)
  145. {
  146. return router_get_hash_impl(s,digest,
  147. "router ","\nrouter-signature");
  148. }
  149. /** Set <b>digest</b> to the SHA-1 digest of the hash of the running-routers
  150. * string in <b>s</b>. Return 0 on success, nonzero on failure.
  151. */
  152. int router_get_runningrouters_hash(const char *s, char *digest)
  153. {
  154. return router_get_hash_impl(s,digest,
  155. "network-status","\ndirectory-signature");
  156. }
  157. /**
  158. * Find the first instance of "recommended-software ...\n" at the start of
  159. * a line; return a newly allocated string containing the "..." portion.
  160. * Return NULL if no such instance was found.
  161. */
  162. static char *
  163. get_recommended_software_from_directory(const char *str)
  164. {
  165. #define REC "recommended-software "
  166. const char *cp = str, *eol;
  167. size_t len = strlen(REC);
  168. cp = str;
  169. if (strcmpstart(str, REC)==0) {
  170. cp += len;
  171. } else {
  172. cp = strstr(str, "\n"REC);
  173. if (!cp)
  174. return NULL;
  175. cp += len+1;
  176. }
  177. eol = strchr(cp, '\n');
  178. if (!eol)
  179. return NULL;
  180. return tor_strndup(cp, eol-cp);
  181. #undef REC
  182. }
  183. /** Return 1 if <b>myversion</b> is not in <b>versionlist</b>, and if at least
  184. * one version of Tor on <b>versionlist</b> is newer than <b>myversion</b>.
  185. * Otherwise return 0.
  186. * (versionlist is a comma-separated list of version strings,
  187. * optionally prefixed with "Tor". Versions that can't be parsed are
  188. * ignored.) */
  189. /* static */ int is_obsolete_version(const char *myversion,
  190. const char *versionlist) {
  191. const char *vl;
  192. tor_version_t mine, other;
  193. int found_newer = 0, r, ret;
  194. static int warned_too_new=0;
  195. smartlist_t *version_sl;
  196. vl = versionlist;
  197. log_fn(LOG_DEBUG,"Checking whether version '%s' is in '%s'", myversion, versionlist);
  198. if (tor_version_parse(myversion, &mine)) {
  199. log_fn(LOG_ERR, "I couldn't parse my own version (%s)", myversion);
  200. tor_assert(0);
  201. }
  202. version_sl = smartlist_create();
  203. smartlist_split_string(version_sl, versionlist, ",", SPLIT_SKIP_SPACE, 0);
  204. SMARTLIST_FOREACH(version_sl, const char *, cp, {
  205. if (!strcmpstart(cp, "Tor "))
  206. cp += 4;
  207. if (tor_version_parse(cp, &other)) {
  208. /* Couldn't parse other; it can't be a match. */
  209. } else {
  210. r = tor_version_compare(&mine, &other);
  211. if (r==0) {
  212. ret = 0;
  213. goto done;
  214. } else if (r<0) {
  215. found_newer = 1;
  216. }
  217. }
  218. });
  219. if (!found_newer) {
  220. if (!warned_too_new) {
  221. log(LOG_WARN, "This version of Tor (%s) is newer than any on the recommended list (%s)",
  222. myversion, versionlist);
  223. warned_too_new=1;
  224. }
  225. ret = 0;
  226. } else {
  227. ret = 1;
  228. }
  229. done:
  230. SMARTLIST_FOREACH(version_sl, char *, version, tor_free(version));
  231. smartlist_free(version_sl);
  232. return ret;
  233. }
  234. /* Return 0 if myversion is supported; else log a message and return
  235. * -1 (or exit if ignoreversions is false) */
  236. int check_software_version_against_directory(const char *directory,
  237. int ignoreversion)
  238. {
  239. char *v;
  240. v = get_recommended_software_from_directory(directory);
  241. if (!v) {
  242. log_fn(LOG_WARN, "No recommended-versions string found in directory");
  243. return -1;
  244. }
  245. if (!is_obsolete_version(VERSION, v)) {
  246. tor_free(v);
  247. return 0;
  248. }
  249. log(ignoreversion ? LOG_WARN : LOG_ERR,
  250. "You are running Tor version %s, which will not work with this network.\n"
  251. "Please use %s%s.",
  252. VERSION, strchr(v,',') ? "one of " : "", v);
  253. tor_free(v);
  254. if (ignoreversion) {
  255. log(LOG_WARN, "IgnoreVersion is set. If it breaks, we told you so.");
  256. return -1;
  257. } else {
  258. fflush(0);
  259. tor_cleanup();
  260. exit(0);
  261. return -1; /* never reached */
  262. }
  263. }
  264. /** Parse a directory from <b>str</b> and, when done, store the
  265. * resulting routerlist in *<b>dest</b>, freeing the old value if
  266. * necessary.
  267. *
  268. * If <b>pkey</b> is provided, we check the directory signature with pkey.
  269. *
  270. * If <b>check_version</b> is non-zero, then examine the
  271. * Recommended-versions * line in the directory, and warn or quit
  272. * as needed.
  273. *
  274. * If <b>write_to_cache</b> is non-zero, then store this directory in
  275. * memory and/or disk as well.
  276. */
  277. int /* Should be static; exposed for unit tests */
  278. router_parse_routerlist_from_directory(const char *str,
  279. routerlist_t **dest,
  280. crypto_pk_env_t *pkey,
  281. int check_version,
  282. int write_to_cache)
  283. {
  284. directory_token_t *tok;
  285. char digest[DIGEST_LEN];
  286. routerlist_t *new_dir = NULL;
  287. char *versions = NULL;
  288. smartlist_t *good_nickname_list = NULL;
  289. time_t published_on;
  290. int i, r;
  291. const char *end, *cp;
  292. smartlist_t *tokens = NULL;
  293. char dirnickname[MAX_NICKNAME_LEN+1];
  294. crypto_pk_env_t *declared_key = NULL;
  295. if (router_get_dir_hash(str, digest)) {
  296. log_fn(LOG_WARN, "Unable to compute digest of directory");
  297. goto err;
  298. }
  299. log_fn(LOG_DEBUG,"Received directory hashes to %s",hex_str(digest,4));
  300. /* Check signature first, before we try to tokenize. */
  301. cp = str;
  302. while (cp && (end = strstr(cp+1, "\ndirectory-signature")))
  303. cp = end;
  304. if (cp == str || !cp) {
  305. log_fn(LOG_WARN, "No signature found on directory."); goto err;
  306. }
  307. ++cp;
  308. tokens = smartlist_create();
  309. if (tokenize_string(cp,strchr(cp,'\0'),tokens,1)) {
  310. log_fn(LOG_WARN, "Error tokenizing directory signature"); goto err;
  311. }
  312. if (smartlist_len(tokens) != 1) {
  313. log_fn(LOG_WARN, "Unexpected number of tokens in signature"); goto err;
  314. }
  315. tok=smartlist_get(tokens,0);
  316. if (tok->tp != K_DIRECTORY_SIGNATURE) {
  317. log_fn(LOG_WARN,"Expected a single directory signature"); goto err;
  318. }
  319. declared_key = find_dir_signing_key(str);
  320. if (check_directory_signature(digest, tok, pkey, declared_key)<0)
  321. goto err;
  322. /* now we know tok->n_args == 1, so it's safe to access tok->args[0] */
  323. if (!is_legal_nickname(tok->args[0])) {
  324. log_fn(LOG_WARN, "Directory nickname '%s' is misformed", tok->args[0]);
  325. goto err;
  326. }
  327. strlcpy(dirnickname, tok->args[0], sizeof(dirnickname));
  328. SMARTLIST_FOREACH(tokens, directory_token_t *, tok, token_free(tok));
  329. smartlist_free(tokens);
  330. tokens = NULL;
  331. /* Now that we know the signature is okay, check the version. */
  332. if (check_version)
  333. check_software_version_against_directory(str, get_options()->IgnoreVersion);
  334. /* Now try to parse the first part of the directory. */
  335. if ((end = strstr(str,"\nrouter "))) {
  336. ++end;
  337. } else if ((end = strstr(str, "\ndirectory-signature"))) {
  338. ++end;
  339. } else {
  340. end = str + strlen(str);
  341. }
  342. tokens = smartlist_create();
  343. if (tokenize_string(str,end,tokens,1)) {
  344. log_fn(LOG_WARN, "Error tokenizing directory"); goto err;
  345. }
  346. if (smartlist_len(tokens) < 1) {
  347. log_fn(LOG_WARN, "Impossibly short directory header"); goto err;
  348. }
  349. if ((tok = find_first_by_keyword(tokens, _UNRECOGNIZED))) {
  350. log_fn(LOG_WARN, "Unrecognized keyword \"%s\" in directory header; can't parse directory.",
  351. tok->args[0]);
  352. goto err;
  353. }
  354. tok = smartlist_get(tokens,0);
  355. if (tok->tp != K_SIGNED_DIRECTORY) {
  356. log_fn(LOG_WARN, "Directory doesn't start with signed-directory.");
  357. goto err;
  358. }
  359. if (!(tok = find_first_by_keyword(tokens, K_PUBLISHED))) {
  360. log_fn(LOG_WARN, "Missing published time on directory.");
  361. goto err;
  362. }
  363. tor_assert(tok->n_args == 1);
  364. if (parse_iso_time(tok->args[0], &published_on) < 0) {
  365. goto err;
  366. }
  367. /* Now that we know the signature is okay, and we have a
  368. * publication time, cache the directory. */
  369. if (!get_options()->AuthoritativeDir && write_to_cache)
  370. dirserv_set_cached_directory(str, published_on, 0);
  371. if (!(tok = find_first_by_keyword(tokens, K_RECOMMENDED_SOFTWARE))) {
  372. log_fn(LOG_WARN, "Missing recommended-software line from directory.");
  373. goto err;
  374. }
  375. if (tok->n_args > 1) {
  376. log_fn(LOG_WARN, "Invalid recommended-software line");
  377. goto err;
  378. }
  379. versions = tok->n_args ? tor_strdup(tok->args[0]) : tor_strdup("");
  380. /* Prefer router-status, then running-routers. */
  381. if (!(tok = find_first_by_keyword(tokens, K_ROUTER_STATUS))) {
  382. if (!(tok = find_first_by_keyword(tokens, K_RUNNING_ROUTERS))) {
  383. log_fn(LOG_WARN,
  384. "Missing running-routers/router-status line from directory.");
  385. goto err;
  386. }
  387. }
  388. good_nickname_list = smartlist_create();
  389. for (i=0; i<tok->n_args; ++i) {
  390. smartlist_add(good_nickname_list, tok->args[i]);
  391. }
  392. tok->n_args = 0; /* Don't free the strings in good_nickname_list yet. */
  393. /* Read the router list from s, advancing s up past the end of the last
  394. * router. */
  395. str = end;
  396. if (router_parse_list_from_string(&str, &new_dir,
  397. good_nickname_list,
  398. tok->tp==K_RUNNING_ROUTERS,
  399. published_on)) {
  400. log_fn(LOG_WARN, "Error reading routers from directory");
  401. goto err;
  402. }
  403. /* Determine if my routerinfo is considered verified. */
  404. {
  405. static int have_warned_about_unverified_status = 0;
  406. routerinfo_t *me = router_get_my_routerinfo();
  407. if (me) {
  408. if (router_update_status_from_smartlist(me,
  409. published_on, good_nickname_list, tok->tp==K_RUNNING_ROUTERS)==1 &&
  410. me->is_verified == 0 && !have_warned_about_unverified_status) {
  411. log_fn(LOG_WARN,"Dirserver '%s' lists your server as unverified. Please consider sending your identity fingerprint to the tor-ops.", dirnickname);
  412. have_warned_about_unverified_status = 1;
  413. }
  414. }
  415. }
  416. new_dir->software_versions = versions; versions = NULL;
  417. new_dir->published_on = published_on;
  418. SMARTLIST_FOREACH(tokens, directory_token_t *, tok, token_free(tok));
  419. smartlist_free(tokens);
  420. tokens = NULL;
  421. if (*dest)
  422. routerlist_free(*dest);
  423. *dest = new_dir;
  424. r = 0;
  425. goto done;
  426. err:
  427. r = -1;
  428. if (new_dir)
  429. routerlist_free(new_dir);
  430. tor_free(versions);
  431. done:
  432. if (declared_key) crypto_free_pk_env(declared_key);
  433. if (tokens) {
  434. SMARTLIST_FOREACH(tokens, directory_token_t *, tok, token_free(tok));
  435. smartlist_free(tokens);
  436. }
  437. if (good_nickname_list) {
  438. SMARTLIST_FOREACH(good_nickname_list, char *, n, tor_free(n));
  439. smartlist_free(good_nickname_list);
  440. }
  441. return r;
  442. }
  443. /* DOCDOC */
  444. running_routers_t *
  445. router_parse_runningrouters(const char *str, int write_to_cache)
  446. {
  447. char digest[DIGEST_LEN];
  448. running_routers_t *new_list = NULL;
  449. directory_token_t *tok;
  450. time_t published_on;
  451. int i;
  452. crypto_pk_env_t *declared_key = NULL;
  453. smartlist_t *tokens = NULL;
  454. if (router_get_runningrouters_hash(str, digest)) {
  455. log_fn(LOG_WARN, "Unable to compute digest of directory");
  456. goto err;
  457. }
  458. tokens = smartlist_create();
  459. if (tokenize_string(str,str+strlen(str),tokens,1)) {
  460. log_fn(LOG_WARN, "Error tokenizing directory"); goto err;
  461. }
  462. if ((tok = find_first_by_keyword(tokens, _UNRECOGNIZED))) {
  463. log_fn(LOG_WARN, "Unrecognized keyword '%s'; can't parse running-routers",
  464. tok->args[0]);
  465. goto err;
  466. }
  467. tok = smartlist_get(tokens,0);
  468. if (tok->tp != K_NETWORK_STATUS) {
  469. log_fn(LOG_WARN, "Network-status starts with wrong token");
  470. goto err;
  471. }
  472. if (!(tok = find_first_by_keyword(tokens, K_PUBLISHED))) {
  473. log_fn(LOG_WARN, "Missing published time on directory.");
  474. goto err;
  475. }
  476. tor_assert(tok->n_args == 1);
  477. if (parse_iso_time(tok->args[0], &published_on) < 0) {
  478. goto err;
  479. }
  480. /* Now that we know the signature is okay, and we have a
  481. * publication time, cache the list. */
  482. if (!get_options()->AuthoritativeDir && write_to_cache)
  483. dirserv_set_cached_directory(str, published_on, 1);
  484. if (!(tok = find_first_by_keyword(tokens, K_ROUTER_STATUS))) {
  485. if (!(tok = find_first_by_keyword(tokens, K_RUNNING_ROUTERS))) {
  486. log_fn(LOG_WARN,
  487. "Missing running-routers/router-status line from directory.");
  488. goto err;
  489. }
  490. }
  491. new_list = tor_malloc_zero(sizeof(running_routers_t));
  492. new_list->published_on = published_on;
  493. new_list->running_routers = smartlist_create();
  494. new_list->is_running_routers_format = (tok->tp == K_RUNNING_ROUTERS);
  495. for (i=0;i<tok->n_args;++i) {
  496. smartlist_add(new_list->running_routers, tok->args[i]);
  497. }
  498. tok->n_args = 0; /* Don't free the elements of tok->args. */
  499. if (!(tok = find_first_by_keyword(tokens, K_DIRECTORY_SIGNATURE))) {
  500. log_fn(LOG_WARN, "Missing signature on running-routers");
  501. goto err;
  502. }
  503. declared_key = find_dir_signing_key(str);
  504. if (check_directory_signature(digest, tok, NULL, declared_key) < 0)
  505. goto err;
  506. goto done;
  507. err:
  508. if (new_list) {
  509. running_routers_free(new_list);
  510. new_list = NULL;
  511. }
  512. done:
  513. if (declared_key) crypto_free_pk_env(declared_key);
  514. if (tokens) {
  515. SMARTLIST_FOREACH(tokens, directory_token_t *, tok, token_free(tok));
  516. smartlist_free(tokens);
  517. }
  518. return new_list;
  519. }
  520. /** Given a directory or running-routers string in <b>str</b>, try to
  521. * find the its dir-signing-key token (if any). If this token is
  522. * present, extract and return the key. Return NULL on failure. */
  523. static crypto_pk_env_t *find_dir_signing_key(const char *str)
  524. {
  525. const char *cp;
  526. directory_token_t *tok;
  527. crypto_pk_env_t *key = NULL;
  528. /* Is there a dir-signing-key in the directory? */
  529. cp = strstr(str, "\nopt dir-signing-key");
  530. if (!cp)
  531. cp = strstr(str, "\ndir-signing-key");
  532. if (!cp)
  533. return NULL;
  534. ++cp; /* Now cp points to the start of the token. */
  535. tok = get_next_token(&cp, DIR_ONLY);
  536. if (!tok) {
  537. log_fn(LOG_WARN, "Unparseable dir-signing-key token");
  538. return NULL;
  539. }
  540. if (tok->tp != K_DIR_SIGNING_KEY) {
  541. log_fn(LOG_WARN, "Dir-signing-key token did not parse as expected");
  542. return NULL;
  543. }
  544. if (tok->key) {
  545. key = tok->key;
  546. tok->key = NULL; /* steal reference. */
  547. } else if (tok->n_args >= 1) {
  548. key = crypto_pk_DER64_decode_public_key(tok->args[0]);
  549. if (!key) {
  550. log_fn(LOG_WARN, "Unparseable dir-signing-key argument");
  551. return NULL;
  552. }
  553. } else {
  554. log_fn(LOG_WARN, "Dir-signing-key token contained no key");
  555. return NULL;
  556. }
  557. token_free(tok);
  558. return key;
  559. }
  560. /** Return true iff <b>key</b> is allowed to sign directories.
  561. */
  562. static int dir_signing_key_is_trusted(crypto_pk_env_t *key)
  563. {
  564. char digest[DIGEST_LEN];
  565. if (!key) return 0;
  566. if (crypto_pk_get_digest(key, digest) < 0) {
  567. log_fn(LOG_WARN, "Error computing dir-signing-key digest");
  568. return 0;
  569. }
  570. if (!router_digest_is_trusted_dir(digest)) {
  571. log_fn(LOG_WARN, "Listed dir-signing-key is not trusted");
  572. return 0;
  573. }
  574. return 1;
  575. }
  576. /** Check whether the K_DIRECTORY_SIGNATURE token in <b>tok</b> has a
  577. * good signature for <b>digest</b>.
  578. *
  579. * If <b>declared_key</b> is set, the directory has declared what key
  580. * was used to sign it, so we will use that key only if it is an
  581. * authoritative directory signing key.
  582. *
  583. * Otherwise, if pkey is provided, try to use it.
  584. *
  585. * (New callers should always use <b>declared_key</b> when possible;
  586. * <b>pkey is only for debugging.)
  587. */
  588. static int check_directory_signature(const char *digest,
  589. directory_token_t *tok,
  590. crypto_pk_env_t *pkey,
  591. crypto_pk_env_t *declared_key)
  592. {
  593. char signed_digest[PK_BYTES];
  594. crypto_pk_env_t *_pkey = NULL;
  595. if (tok->n_args != 1) {
  596. log_fn(LOG_WARN, "Too many or too few arguments to directory-signature");
  597. return -1;
  598. }
  599. if (declared_key) {
  600. if (dir_signing_key_is_trusted(declared_key))
  601. _pkey = declared_key;
  602. }
  603. if (!_pkey && pkey) {
  604. /* pkey provided for debugging purposes */
  605. _pkey = pkey;
  606. }
  607. if (!_pkey) {
  608. log_fn(LOG_WARN, "Found directory in old (before 0.0.9pre3) format--rejecting.");
  609. return -1;
  610. }
  611. if (strcmp(tok->object_type, "SIGNATURE") || tok->object_size != 128) {
  612. log_fn(LOG_WARN, "Bad object type or length on directory signature");
  613. return -1;
  614. }
  615. tor_assert(_pkey);
  616. if (crypto_pk_public_checksig(_pkey, signed_digest, tok->object_body, 128)
  617. != 20) {
  618. log_fn(LOG_WARN, "Error reading directory: invalid signature.");
  619. return -1;
  620. }
  621. log_fn(LOG_DEBUG,"Signed directory hash starts %s", hex_str(signed_digest,4));
  622. if (memcmp(digest, signed_digest, 20)) {
  623. log_fn(LOG_WARN, "Error reading directory: signature does not match.");
  624. return -1;
  625. }
  626. return 0;
  627. }
  628. /** Given a string *<b>s</b> containing a concatenated sequence of router
  629. * descriptors, parses them and stores the result in *<b>dest</b>. If
  630. * good_nickname_list is provided, then routers are marked as
  631. * running/nonrunning and verified/unverified based on their status in the
  632. * list. Otherwise, all routers are marked running and verified. Advances
  633. * *s to a point immediately following the last router entry. Returns 0 on
  634. * success and -1 on failure.
  635. */
  636. int
  637. router_parse_list_from_string(const char **s, routerlist_t **dest,
  638. smartlist_t *good_nickname_list,
  639. int rr_format, time_t published_on)
  640. {
  641. routerinfo_t *router;
  642. smartlist_t *routers;
  643. const char *end;
  644. tor_assert(s);
  645. tor_assert(*s);
  646. routers = smartlist_create();
  647. while (1) {
  648. *s = eat_whitespace(*s);
  649. /* Don't start parsing the rest of *s unless it contains a router. */
  650. if (strcmpstart(*s, "router ")!=0)
  651. break;
  652. if ((end = strstr(*s+1, "\nrouter "))) {
  653. end++;
  654. } else if ((end = strstr(*s+1, "\ndirectory-signature"))) {
  655. end++;
  656. } else {
  657. end = *s+strlen(*s);
  658. }
  659. router = router_parse_entry_from_string(*s, end);
  660. *s = end;
  661. if (!router) {
  662. log_fn(LOG_WARN, "Error reading router; skipping");
  663. continue;
  664. }
  665. if (!good_nickname_list) {
  666. router->is_running = 1; /* start out assuming all dirservers are up */
  667. router->is_verified = 1;
  668. router->status_set_at = time(NULL);
  669. }
  670. smartlist_add(routers, router);
  671. // log_fn(LOG_DEBUG,"just added router #%d.",smartlist_len(routers));
  672. }
  673. if (good_nickname_list) {
  674. SMARTLIST_FOREACH(good_nickname_list, const char *, cp,
  675. routers_update_status_from_entry(routers, published_on,
  676. cp, rr_format));
  677. }
  678. if (*dest)
  679. routerlist_free(*dest);
  680. *dest = tor_malloc_zero(sizeof(routerlist_t));
  681. (*dest)->routers = routers;
  682. return 0;
  683. }
  684. /** Helper function: reads a single router entry from *<b>s</b> ...
  685. * *<b>end</b>. Mallocs a new router and returns it if all goes well, else
  686. * returns NULL.
  687. */
  688. routerinfo_t *router_parse_entry_from_string(const char *s,
  689. const char *end) {
  690. routerinfo_t *router = NULL;
  691. char signed_digest[128];
  692. char digest[128];
  693. smartlist_t *tokens = NULL, *exit_policy_tokens = NULL;
  694. directory_token_t *tok;
  695. int t;
  696. int ports_set, bw_set;
  697. if (!end) {
  698. end = s + strlen(s);
  699. }
  700. if (router_get_router_hash(s, digest) < 0) {
  701. log_fn(LOG_WARN, "Couldn't compute router hash.");
  702. return NULL;
  703. }
  704. tokens = smartlist_create();
  705. if (tokenize_string(s,end,tokens,0)) {
  706. log_fn(LOG_WARN, "Error tokeninzing router descriptor."); goto err;
  707. }
  708. if (smartlist_len(tokens) < 2) {
  709. log_fn(LOG_WARN, "Impossibly short router descriptor.");
  710. goto err;
  711. }
  712. if ((tok = find_first_by_keyword(tokens, _UNRECOGNIZED))) {
  713. log_fn(LOG_WARN, "Unrecognized keyword '%s'; skipping descriptor.",
  714. tok->args[0]);
  715. goto err;
  716. }
  717. tok = smartlist_get(tokens,0);
  718. if (tok->tp != K_ROUTER) {
  719. log_fn(LOG_WARN,"Entry does not start with \"router\"");
  720. goto err;
  721. }
  722. router = tor_malloc_zero(sizeof(routerinfo_t));
  723. ports_set = bw_set = 0;
  724. if (tok->n_args == 2 || tok->n_args == 5 || tok->n_args == 6) {
  725. router->nickname = tor_strdup(tok->args[0]);
  726. if (!is_legal_nickname(router->nickname)) {
  727. log_fn(LOG_WARN,"Router nickname is invalid");
  728. goto err;
  729. }
  730. router->address = tor_strdup(tok->args[1]);
  731. router->addr = 0;
  732. if (tok->n_args >= 5) {
  733. router->or_port = (uint16_t) tor_parse_long(tok->args[2],10,0,65535,NULL,NULL);
  734. router->dir_port = (uint16_t) tor_parse_long(tok->args[4],10,0,65535,NULL,NULL);
  735. ports_set = 1;
  736. }
  737. } else {
  738. log_fn(LOG_WARN,"Wrong # of arguments to \"router\" (%d)",tok->n_args);
  739. goto err;
  740. }
  741. tok = find_first_by_keyword(tokens, K_PORTS);
  742. if (tok && ports_set) {
  743. log_fn(LOG_WARN,"Redundant ports line");
  744. goto err;
  745. } else if (tok) {
  746. if (tok->n_args != 3) {
  747. log_fn(LOG_WARN,"Wrong # of arguments to \"ports\"");
  748. goto err;
  749. }
  750. router->or_port = (uint16_t) tor_parse_long(tok->args[0],10,0,65535,NULL,NULL);
  751. router->dir_port = (uint16_t) tor_parse_long(tok->args[2],10,0,65535,NULL,NULL);
  752. ports_set = 1;
  753. }
  754. tok = find_first_by_keyword(tokens, K_DIRCACHEPORT);
  755. if (tok) {
  756. if (router->dir_port)
  757. log_fn(LOG_WARN,"Redundant dircacheport line");
  758. if (tok->n_args != 1) {
  759. log_fn(LOG_WARN,"Wrong # of arguments to \"dircacheport\"");
  760. goto err;
  761. }
  762. router->dir_port = (uint16_t) tor_parse_long(tok->args[0],10,1,65535,NULL,NULL);
  763. }
  764. tok = find_first_by_keyword(tokens, K_BANDWIDTH);
  765. if (tok && bw_set) {
  766. log_fn(LOG_WARN,"Redundant bandwidth line");
  767. goto err;
  768. } else if (tok) {
  769. if (tok->n_args < 3) {
  770. /* XXXX Once 0.0.7 is *really* dead, restore this warning to its old form*/
  771. log_fn(LOG_WARN,"Not enough arguments to \"bandwidth\": must be an obsolete server. Rejecting one server (nickname '%s').", router->nickname);
  772. goto err;
  773. }
  774. router->bandwidthrate = tor_parse_long(tok->args[0],10,0,INT_MAX,NULL,NULL);
  775. router->bandwidthburst = tor_parse_long(tok->args[1],10,0,INT_MAX,NULL,NULL);
  776. router->bandwidthcapacity = tor_parse_long(tok->args[2],10,0,INT_MAX,NULL,NULL);
  777. bw_set = 1;
  778. }
  779. if ((tok = find_first_by_keyword(tokens, K_UPTIME))) {
  780. if (tok->n_args != 1) {
  781. log_fn(LOG_WARN, "Unrecognized number of args on K_UPTIME; skipping.");
  782. } else {
  783. router->uptime = tor_parse_long(tok->args[0],10,0,LONG_MAX,NULL,NULL);
  784. }
  785. }
  786. if (!(tok = find_first_by_keyword(tokens, K_PUBLISHED))) {
  787. log_fn(LOG_WARN, "Missing published time"); goto err;
  788. }
  789. tor_assert(tok->n_args == 1);
  790. if (parse_iso_time(tok->args[0], &router->published_on) < 0)
  791. goto err;
  792. if (!(tok = find_first_by_keyword(tokens, K_ONION_KEY))) {
  793. log_fn(LOG_WARN, "Missing onion key"); goto err;
  794. }
  795. if (crypto_pk_keysize(tok->key) != PK_BYTES) {
  796. log_fn(LOG_WARN, "Wrong size on onion key: %d bits!",
  797. crypto_pk_keysize(tok->key)*8);
  798. goto err;
  799. }
  800. router->onion_pkey = tok->key;
  801. tok->key = NULL; /* Prevent free */
  802. if (!(tok = find_first_by_keyword(tokens, K_SIGNING_KEY))) {
  803. log_fn(LOG_WARN, "Missing identity key"); goto err;
  804. }
  805. if (crypto_pk_keysize(tok->key) != PK_BYTES) {
  806. log_fn(LOG_WARN, "Wrong size on identity key: %d bits!",
  807. crypto_pk_keysize(tok->key)*8);
  808. goto err;
  809. }
  810. router->identity_pkey = tok->key;
  811. tok->key = NULL; /* Prevent free */
  812. if (crypto_pk_get_digest(router->identity_pkey,router->identity_digest)) {
  813. log_fn(LOG_WARN, "Couldn't calculate key digest"); goto err;
  814. }
  815. if ((tok = find_first_by_keyword(tokens, K_PLATFORM))) {
  816. router->platform = tor_strdup(tok->args[0]);
  817. }
  818. exit_policy_tokens = find_all_exitpolicy(tokens);
  819. SMARTLIST_FOREACH(exit_policy_tokens, directory_token_t *, t,
  820. if (router_add_exit_policy(router,t)<0) {
  821. log_fn(LOG_WARN,"Error in exit policy"); goto err;}
  822. );
  823. if ((tok = find_first_by_keyword(tokens, K_FAMILY)) && tok->n_args) {
  824. int i;
  825. router->declared_family = smartlist_create();
  826. for (i=0;i<tok->n_args;++i) {
  827. if (!is_legal_nickname_or_hexdigest(tok->args[i])) {
  828. log_fn(LOG_WARN, "Illegal nickname '%s' in family line", tok->args[i]);
  829. goto err;
  830. }
  831. smartlist_add(router->declared_family, tor_strdup(tok->args[i]));
  832. }
  833. }
  834. if (!(tok = find_first_by_keyword(tokens, K_ROUTER_SIGNATURE))) {
  835. log_fn(LOG_WARN, "Missing router signature"); goto err;
  836. }
  837. if (strcmp(tok->object_type, "SIGNATURE") || tok->object_size != 128) {
  838. log_fn(LOG_WARN, "Bad object type or length on router signature");
  839. goto err;
  840. }
  841. if ((t=crypto_pk_public_checksig(router->identity_pkey, signed_digest,
  842. tok->object_body, 128)) != 20) {
  843. log_fn(LOG_WARN, "Invalid signature %d",t); goto err;
  844. }
  845. if (memcmp(digest, signed_digest, 20)) {
  846. log_fn(LOG_WARN, "Mismatched signature"); goto err;
  847. }
  848. if (!ports_set) {
  849. log_fn(LOG_WARN,"No ports declared; failing."); goto err;
  850. }
  851. if (!bw_set) {
  852. log_fn(LOG_WARN,"No bandwidth declared; failing."); goto err;
  853. }
  854. if (!router->or_port) {
  855. log_fn(LOG_WARN,"or_port unreadable or 0. Failing.");
  856. goto err;
  857. }
  858. if (!router->bandwidthrate) {
  859. log_fn(LOG_WARN,"bandwidthrate unreadable or 0. Failing.");
  860. goto err;
  861. }
  862. if (!router->platform) {
  863. router->platform = tor_strdup("<unknown>");
  864. }
  865. // log_fn(LOG_DEBUG,"or_port %d, dir_port %d, bandwidthrate %u, bandwidthburst %u.",
  866. // router->or_port, router->dir_port,
  867. // (unsigned) router->bandwidthrate, (unsigned) router->bandwidthburst);
  868. goto done;
  869. return router;
  870. err:
  871. routerinfo_free(router);
  872. router = NULL;
  873. done:
  874. if (tokens) {
  875. SMARTLIST_FOREACH(tokens, directory_token_t *, tok, token_free(tok));
  876. smartlist_free(tokens);
  877. }
  878. if (exit_policy_tokens) {
  879. smartlist_free(exit_policy_tokens);
  880. }
  881. return router;
  882. }
  883. /** Parse the exit policy in the string <b>s</b> and return it.
  884. */
  885. addr_policy_t *
  886. router_parse_addr_policy_from_string(const char *s)
  887. {
  888. directory_token_t *tok = NULL;
  889. const char *cp;
  890. char *tmp;
  891. addr_policy_t *r;
  892. size_t len, idx;
  893. /* *s might not end with \n, so we need to extend it with one. */
  894. len = strlen(s);
  895. cp = tmp = tor_malloc(len+2);
  896. for (idx = 0; idx < len; ++idx) {
  897. tmp[idx] = tolower(s[idx]);
  898. }
  899. tmp[len]='\n';
  900. tmp[len+1]='\0';
  901. tok = get_next_token(&cp, RTR_ONLY);
  902. if (tok->tp == _ERR) {
  903. log_fn(LOG_WARN, "Error reading exit policy: %s", tok->error);
  904. goto err;
  905. }
  906. if (tok->tp != K_ACCEPT && tok->tp != K_REJECT) {
  907. log_fn(LOG_WARN, "Expected 'accept' or 'reject'.");
  908. goto err;
  909. }
  910. /* Now that we've gotten an exit policy, add it to the router. */
  911. r = router_parse_addr_policy(tok);
  912. goto done;
  913. err:
  914. r = NULL;
  915. done:
  916. tor_free(tmp);
  917. token_free(tok);
  918. return r;
  919. }
  920. int
  921. router_add_exit_policy_from_string(routerinfo_t *router, const char *s)
  922. {
  923. addr_policy_t *newe, *tmpe;
  924. newe = router_parse_addr_policy_from_string(s);
  925. if (!newe)
  926. return -1;
  927. for (tmpe = router->exit_policy; tmpe; tmpe=tmpe->next)
  928. ;
  929. tmpe->next = newe;
  930. return 0;
  931. }
  932. static int
  933. router_add_exit_policy(routerinfo_t *router,directory_token_t *tok)
  934. {
  935. addr_policy_t *newe, **tmpe;
  936. newe = router_parse_addr_policy(tok);
  937. if (!newe)
  938. return -1;
  939. for (tmpe = &router->exit_policy; *tmpe; tmpe=&((*tmpe)->next))
  940. ;
  941. *tmpe = newe;
  942. return 0;
  943. }
  944. /** Given a K_ACCEPT or K_REJECT token and a router, create and return
  945. * a new exit_policy_t corresponding to the token. */
  946. static addr_policy_t *
  947. router_parse_addr_policy(directory_token_t *tok) {
  948. addr_policy_t *newe;
  949. struct in_addr in;
  950. char *arg, *address;
  951. tor_assert(tok->tp == K_REJECT || tok->tp == K_ACCEPT);
  952. if (tok->n_args != 1)
  953. return NULL;
  954. arg = tok->args[0];
  955. newe = tor_malloc_zero(sizeof(addr_policy_t));
  956. newe->string = tor_malloc(8+strlen(arg));
  957. /* XXX eventually, use the code from router.c:727 to generate this */
  958. tor_snprintf(newe->string, 8+strlen(arg), "%s %s",
  959. (tok->tp == K_REJECT) ? "reject" : "accept", arg);
  960. newe->policy_type = (tok->tp == K_REJECT) ? ADDR_POLICY_REJECT
  961. : ADDR_POLICY_ACCEPT;
  962. if (parse_addr_and_port_range(arg, &newe->addr, &newe->msk,
  963. &newe->prt_min, &newe->prt_max))
  964. goto policy_read_failed;
  965. in.s_addr = htonl(newe->addr);
  966. address = tor_strdup(inet_ntoa(in));
  967. // in.s_addr = htonl(newe->msk);
  968. // log_fn(LOG_DEBUG,"%s %s/%s:%d-%d",
  969. // newe->policy_type == ADDR_POLICY_REJECT ? "reject" : "accept",
  970. // address, inet_ntoa(in), newe->prt_min, newe->prt_max);
  971. tor_free(address);
  972. return newe;
  973. policy_read_failed:
  974. tor_assert(newe->string);
  975. log_fn(LOG_WARN,"Couldn't parse line '%s'. Dropping", newe->string);
  976. tor_free(newe->string);
  977. tor_free(newe);
  978. return NULL;
  979. }
  980. void
  981. assert_addr_policy_ok(addr_policy_t *t)
  982. {
  983. addr_policy_t *t2;
  984. while (t) {
  985. tor_assert(t->policy_type == ADDR_POLICY_REJECT ||
  986. t->policy_type == ADDR_POLICY_ACCEPT);
  987. tor_assert(t->prt_min <= t->prt_max);
  988. t2 = router_parse_addr_policy_from_string(t->string);
  989. tor_assert(t2);
  990. tor_assert(t2->policy_type == t->policy_type);
  991. tor_assert(t2->addr == t->addr);
  992. tor_assert(t2->msk == t->msk);
  993. tor_assert(t2->prt_min == t->prt_min);
  994. tor_assert(t2->prt_max == t->prt_max);
  995. tor_assert(!strcmp(t2->string, t->string));
  996. tor_assert(t2->next == NULL);
  997. addr_policy_free(t2);
  998. t = t->next;
  999. }
  1000. }
  1001. /*
  1002. * Low-level tokenizer for router descriptors and directories.
  1003. */
  1004. /** Free all resources allocated for <b>tok</b> */
  1005. static void
  1006. token_free(directory_token_t *tok)
  1007. {
  1008. int i;
  1009. tor_assert(tok);
  1010. if (tok->args) {
  1011. for (i = 0; i < tok->n_args; ++i) {
  1012. tor_free(tok->args[i]);
  1013. }
  1014. tor_free(tok->args);
  1015. }
  1016. tor_free(tok->object_type);
  1017. tor_free(tok->object_body);
  1018. if (tok->key)
  1019. crypto_free_pk_env(tok->key);
  1020. tor_free(tok);
  1021. }
  1022. /** Helper function: read the next token from *s, advance *s to the end
  1023. * of the token, and return the parsed token. If 'where' is DIR_ONLY
  1024. * or RTR_ONLY, reject all tokens of the wrong type.
  1025. */
  1026. static directory_token_t *
  1027. get_next_token(const char **s, where_syntax where) {
  1028. const char *next, *obstart;
  1029. int i, done, allocated, is_opt;
  1030. directory_token_t *tok;
  1031. arg_syntax a_syn;
  1032. obj_syntax o_syn = NO_OBJ;
  1033. #define RET_ERR(msg) \
  1034. do { if (tok) token_free(tok); \
  1035. tok = tor_malloc_zero(sizeof(directory_token_t));\
  1036. tok->tp = _ERR; \
  1037. tok->error = msg; \
  1038. goto done_tokenizing; } while (0)
  1039. tok = tor_malloc_zero(sizeof(directory_token_t));
  1040. tok->tp = _ERR;
  1041. *s = eat_whitespace(*s);
  1042. if (!**s) {
  1043. tok->tp = _EOF;
  1044. return tok;
  1045. }
  1046. next = find_whitespace(*s);
  1047. if (!next) {
  1048. tok->error = "Unexpected EOF"; return tok;
  1049. }
  1050. /* It's a keyword... but which one? */
  1051. is_opt = !strncmp("opt", *s, next-*s);
  1052. if (is_opt) {
  1053. *s = eat_whitespace(next);
  1054. next = NULL;
  1055. if (**s)
  1056. next = find_whitespace(*s);
  1057. if (!**s || !next) {
  1058. RET_ERR("opt without keyword");
  1059. }
  1060. }
  1061. for (i = 0; token_table[i].t ; ++i) {
  1062. if (!strncmp(token_table[i].t, *s, next-*s)) {
  1063. /* We've found the keyword. */
  1064. tok->tp = token_table[i].v;
  1065. a_syn = token_table[i].s;
  1066. o_syn = token_table[i].os;
  1067. if (token_table[i].ws != ANY && token_table[i].ws != where) {
  1068. if (where == DIR_ONLY) {
  1069. RET_ERR("Found a router-only token in a directory section");
  1070. } else {
  1071. RET_ERR("Found a directory-only token in a router descriptor");
  1072. }
  1073. }
  1074. if (a_syn == ARGS) {
  1075. /* This keyword takes multiple arguments. */
  1076. i = 0;
  1077. done = (*next == '\n');
  1078. allocated = 32;
  1079. tok->args = tor_malloc(sizeof(char*)*32);
  1080. *s = eat_whitespace_no_nl(next);
  1081. while (**s != '\n' && !done) {
  1082. next = find_whitespace(*s);
  1083. if (*next == '\n')
  1084. done = 1;
  1085. if (i == allocated) {
  1086. allocated *= 2;
  1087. tok->args = tor_realloc(tok->args,sizeof(char*)*allocated);
  1088. }
  1089. tok->args[i++] = tor_strndup(*s,next-*s);
  1090. *s = eat_whitespace_no_nl(next+1);
  1091. }
  1092. tok->n_args = i;
  1093. } else if (a_syn == CONCAT_ARGS) {
  1094. /* The keyword takes the line as a single argument */
  1095. *s = eat_whitespace_no_nl(next);
  1096. next = strchr(*s, '\n');
  1097. if (!next)
  1098. RET_ERR("Unexpected EOF");
  1099. tok->args = tor_malloc(sizeof(char*));
  1100. tok->args[0] = tor_strndup(*s,next-*s);
  1101. tok->n_args = 1;
  1102. *s = eat_whitespace_no_nl(next+1);
  1103. } else {
  1104. /* The keyword takes no arguments. */
  1105. tor_assert(a_syn == NO_ARGS);
  1106. *s = eat_whitespace_no_nl(next);
  1107. if (**s != '\n') {
  1108. RET_ERR("Unexpected arguments");
  1109. }
  1110. tok->n_args = 0;
  1111. *s = eat_whitespace_no_nl(*s+1);
  1112. }
  1113. break;
  1114. }
  1115. }
  1116. if (tok->tp == _ERR) {
  1117. if (is_opt) {
  1118. tok->tp = K_OPT;
  1119. *s = eat_whitespace_no_nl(next);
  1120. next = strchr(*s,'\n');
  1121. if (!next)
  1122. RET_ERR("Unexpected EOF");
  1123. tok->args = tor_malloc(sizeof(char*));
  1124. tok->args[0] = tor_strndup(*s,next-*s);
  1125. tok->n_args = 1;
  1126. *s = eat_whitespace_no_nl(next+1);
  1127. o_syn = OBJ_OK;
  1128. } else {
  1129. tok->tp = _UNRECOGNIZED;
  1130. next = strchr(*s, '\n');
  1131. if (!next) {
  1132. RET_ERR("Unexpected EOF");
  1133. }
  1134. tok->args = tor_malloc(sizeof(char*));
  1135. tok->args[0] = tor_strndup(*s,next-*s);
  1136. tok->n_args = 1;
  1137. *s = next+1;
  1138. o_syn = OBJ_OK;
  1139. }
  1140. }
  1141. *s = eat_whitespace(*s);
  1142. if (strcmpstart(*s, "-----BEGIN ")) {
  1143. goto done_tokenizing;
  1144. }
  1145. obstart = *s;
  1146. *s += 11; /* length of "-----BEGIN ". */
  1147. next = strchr(*s, '\n');
  1148. if (next-*s < 6 || strcmpstart(next-5, "-----\n")) {
  1149. RET_ERR("Malformed object: bad begin line");
  1150. }
  1151. tok->object_type = tor_strndup(*s, next-*s-5);
  1152. *s = next+1;
  1153. next = strstr(*s, "-----END ");
  1154. if (!next) {
  1155. RET_ERR("Malformed object: missing end line");
  1156. }
  1157. if (!strcmp(tok->object_type, "RSA PUBLIC KEY")) {
  1158. if (strcmpstart(next, "-----END RSA PUBLIC KEY-----\n"))
  1159. RET_ERR("Malformed object: mismatched end line");
  1160. next = strchr(next,'\n')+1;
  1161. tok->key = crypto_new_pk_env();
  1162. if (crypto_pk_read_public_key_from_string(tok->key, obstart, next-obstart))
  1163. RET_ERR("Couldn't parse public key.");
  1164. *s = next;
  1165. } else {
  1166. tok->object_body = tor_malloc(next-*s); /* really, this is too much RAM. */
  1167. i = base64_decode(tok->object_body, 256, *s, next-*s);
  1168. if (i<0) {
  1169. RET_ERR("Malformed object: bad base64-encoded data");
  1170. }
  1171. tok->object_size = i;
  1172. *s = next + 9; /* length of "-----END ". */
  1173. i = strlen(tok->object_type);
  1174. if (strncmp(*s, tok->object_type, i) || strcmpstart(*s+i, "-----\n")) {
  1175. RET_ERR("Malformed object: mismatched end tag");
  1176. }
  1177. *s += i+6;
  1178. }
  1179. switch (o_syn)
  1180. {
  1181. case NO_OBJ:
  1182. if (tok->object_body)
  1183. RET_ERR("Unexpected object for keyword");
  1184. if (tok->key)
  1185. RET_ERR("Unexpected public key for keyword");
  1186. break;
  1187. case NEED_OBJ:
  1188. if (!tok->object_body)
  1189. RET_ERR("Missing object for keyword");
  1190. break;
  1191. case NEED_KEY:
  1192. if (!tok->key)
  1193. RET_ERR("Missing public key for keyword");
  1194. break;
  1195. case OBJ_OK:
  1196. break;
  1197. }
  1198. done_tokenizing:
  1199. #if 0
  1200. for (i = 0; token_table[i].t ; ++i) {
  1201. if (token_table[i].v == tok->tp) {
  1202. fputs(token_table[i].t, stdout);
  1203. break;
  1204. i = -1;
  1205. }
  1206. }
  1207. if (i) {
  1208. if (tok->tp == _UNRECOGNIZED) fputs("UNRECOGNIZED", stdout);
  1209. if (tok->tp == _ERR) fputs("ERR",stdout);
  1210. if (tok->tp == _EOF) fputs("EOF",stdout);
  1211. if (tok->tp == _NIL) fputs("_NIL",stdout);
  1212. }
  1213. for (i = 0; i < tok->n_args; ++i) {
  1214. fprintf(stdout," \"%s\"", tok->args[i]);
  1215. }
  1216. if (tok->error) { fprintf(stdout," *%s*", tok->error); }
  1217. fputs("\n",stdout);
  1218. #endif
  1219. return tok;
  1220. #undef RET_ERR
  1221. }
  1222. /** Read all tokens from a string between <b>start</b> and <b>end</b>, and add
  1223. * them to <b>out</b>. If <b>is_dir</b> is true, reject all non-directory
  1224. * tokens; else reject all non-routerdescriptor tokens.
  1225. */
  1226. static int
  1227. tokenize_string(const char *start, const char *end, smartlist_t *out,
  1228. int is_dir)
  1229. {
  1230. const char **s;
  1231. directory_token_t *tok = NULL;
  1232. where_syntax where = is_dir ? DIR_ONLY : RTR_ONLY;
  1233. s = &start;
  1234. while (*s < end && (!tok || tok->tp != _EOF)) {
  1235. tok = get_next_token(s, where);
  1236. if (tok->tp == _ERR) {
  1237. log_fn(LOG_WARN, "parse error: %s", tok->error);
  1238. return -1;
  1239. }
  1240. smartlist_add(out, tok);
  1241. *s = eat_whitespace(*s);
  1242. }
  1243. return 0;
  1244. }
  1245. /** Find the first token in <b>s</b> whose keyword is <b>keyword</b>; return
  1246. * NULL if no such keyword is found.
  1247. */
  1248. static directory_token_t *
  1249. find_first_by_keyword(smartlist_t *s, directory_keyword keyword)
  1250. {
  1251. SMARTLIST_FOREACH(s, directory_token_t *, t, if (t->tp == keyword) return t);
  1252. return NULL;
  1253. }
  1254. /** Return a newly allocated smartlist of all accept or reject tokens in
  1255. * <b>s</b>.
  1256. */
  1257. static smartlist_t *
  1258. find_all_exitpolicy(smartlist_t *s)
  1259. {
  1260. smartlist_t *out = smartlist_create();
  1261. SMARTLIST_FOREACH(s, directory_token_t *, t,
  1262. if (t->tp == K_ACCEPT || t->tp == K_REJECT)
  1263. smartlist_add(out,t));
  1264. return out;
  1265. }
  1266. /** Compute the SHA digest of the substring of <b>s</b> taken from the first
  1267. * occurrence of <b>start_str</b> through the first newline after the first
  1268. * subsequent occurrence of <b>end_str</b>; store the 20-byte result in
  1269. * <b>digest</b>; return 0 on success.
  1270. *
  1271. * If no such substring exists, return -1.
  1272. */
  1273. static int router_get_hash_impl(const char *s, char *digest,
  1274. const char *start_str,
  1275. const char *end_str)
  1276. {
  1277. char *start, *end;
  1278. start = strstr(s, start_str);
  1279. if (!start) {
  1280. log_fn(LOG_WARN,"couldn't find \"%s\"",start_str);
  1281. return -1;
  1282. }
  1283. if (start != s && *(start-1) != '\n') {
  1284. log_fn(LOG_WARN, "first occurrence of \"%s\" is not at the start of a line",
  1285. start_str);
  1286. return -1;
  1287. }
  1288. end = strstr(start+strlen(start_str), end_str);
  1289. if (!end) {
  1290. log_fn(LOG_WARN,"couldn't find \"%s\"",end_str);
  1291. return -1;
  1292. }
  1293. end = strchr(end+strlen(end_str), '\n');
  1294. if (!end) {
  1295. log_fn(LOG_WARN,"couldn't find EOL");
  1296. return -1;
  1297. }
  1298. ++end;
  1299. if (crypto_digest(digest, start, end-start)) {
  1300. log_fn(LOG_WARN,"couldn't compute digest");
  1301. return -1;
  1302. }
  1303. return 0;
  1304. }
  1305. /** Parse the Tor version of the platform string <b>platform</b>,
  1306. * and compare it to the version in <b>cutoff</b>. Return 1 if
  1307. * the router is at least as new as the cutoff, else return 0.
  1308. */
  1309. int tor_version_as_new_as(const char *platform, const char *cutoff) {
  1310. tor_version_t cutoff_version, router_version;
  1311. char *s, *start;
  1312. char tmp[128];
  1313. if (tor_version_parse(cutoff, &cutoff_version)<0) {
  1314. log_fn(LOG_WARN,"Bug: cutoff version '%s' unparseable.",cutoff);
  1315. return 0;
  1316. }
  1317. if (strcmpstart(platform,"Tor ")) /* nonstandard Tor; be safe and say yes */
  1318. return 1;
  1319. start = (char *)eat_whitespace(platform+3);
  1320. if (!*start) return 0;
  1321. s = (char *)find_whitespace(start); /* also finds '\0', which is fine */
  1322. if ((size_t)(s-start+1) >= sizeof(tmp)) /* too big, no */
  1323. return 0;
  1324. strlcpy(tmp, start, s-start+1);
  1325. if (tor_version_parse(tmp, &router_version)<0) {
  1326. log_fn(LOG_INFO,"Router version '%s' unparseable.",tmp);
  1327. return 1; /* be safe and say yes */
  1328. }
  1329. return tor_version_compare(&router_version, &cutoff_version) >= 0;
  1330. }
  1331. /** Parse a tor version from <b>s</b>, and store the result in <b>out</b>.
  1332. * Return 0 on success, -1 on failure. */
  1333. int tor_version_parse(const char *s, tor_version_t *out)
  1334. {
  1335. char *eos=NULL, *cp=NULL;
  1336. /* Format is:
  1337. * NUM dot NUM dot NUM [ ( pre | rc | dot ) NUM [ -cvs ] ]
  1338. */
  1339. tor_assert(s);
  1340. tor_assert(out);
  1341. memset(out, 0, sizeof(tor_version_t));
  1342. /* Get major. */
  1343. out->major = strtol(s,&eos,10);
  1344. if (!eos || eos==s || *eos != '.') return -1;
  1345. cp = eos+1;
  1346. /* Get minor */
  1347. out->minor = strtol(cp,&eos,10);
  1348. if (!eos || eos==cp || *eos != '.') return -1;
  1349. cp = eos+1;
  1350. /* Get micro */
  1351. out->micro = strtol(cp,&eos,10);
  1352. if (!eos || eos==cp) return -1;
  1353. if (!*eos) {
  1354. out->status = VER_RELEASE;
  1355. out->patchlevel = 0;
  1356. out->cvs = IS_NOT_CVS;
  1357. return 0;
  1358. }
  1359. cp = eos;
  1360. /* Get status */
  1361. if (*cp == '.') {
  1362. out->status = VER_RELEASE;
  1363. ++cp;
  1364. } else if (0==strncmp(cp, "pre", 3)) {
  1365. out->status = VER_PRE;
  1366. cp += 3;
  1367. } else if (0==strncmp(cp, "rc", 2)) {
  1368. out->status = VER_RC;
  1369. cp += 2;
  1370. } else {
  1371. return -1;
  1372. }
  1373. /* Get patchlevel */
  1374. out->patchlevel = strtol(cp,&eos,10);
  1375. if (!eos || eos==cp) return -1;
  1376. cp = eos;
  1377. /* Get cvs status and status tag. */
  1378. if (*cp == '-' || *cp == '.')
  1379. ++cp;
  1380. strlcpy(out->status_tag, cp, sizeof(out->status_tag));
  1381. if (0==strcmp(cp, "cvs")) {
  1382. out->cvs = IS_CVS;
  1383. } else {
  1384. out->cvs = IS_NOT_CVS;
  1385. }
  1386. return 0;
  1387. }
  1388. /** Compare two tor versions; Return <0 if a < b; 0 if a ==b, >0 if a >
  1389. * b. */
  1390. int tor_version_compare(tor_version_t *a, tor_version_t *b)
  1391. {
  1392. int i;
  1393. tor_assert(a);
  1394. tor_assert(b);
  1395. if ((i = a->major - b->major))
  1396. return i;
  1397. else if ((i = a->minor - b->minor))
  1398. return i;
  1399. else if ((i = a->micro - b->micro))
  1400. return i;
  1401. else if ((i = a->status - b->status))
  1402. return i;
  1403. else if ((i = a->patchlevel - b->patchlevel))
  1404. return i;
  1405. if (a->major > 0 || a->minor > 0) {
  1406. return strcmp(a->status_tag, b->status_tag);
  1407. } else {
  1408. return (a->cvs - b->cvs);
  1409. }
  1410. }