routerparse.c
上传用户:awang829
上传日期:2019-07-14
资源大小:2356k
文件大小:134k
源码类别:

网络

开发平台:

Unix_Linux

  1. /* Copyright (c) 2001 Matej Pfajfar.
  2.  * Copyright (c) 2001-2004, Roger Dingledine.
  3.  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4.  * Copyright (c) 2007-2009, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7.  * file routerparse.c
  8.  * brief Code to parse and validate router descriptors and directories.
  9.  **/
  10. #include "or.h"
  11. #include "memarea.h"
  12. /****************************************************************************/
  13. /** Enumeration of possible token types.  The ones starting with K_ correspond
  14.  * to directory 'keywords'. _ERR is an error in the tokenizing process, _EOF
  15.  * is an end-of-file marker, and _NIL is used to encode not-a-token.
  16.  */
  17. typedef enum {
  18.   K_ACCEPT = 0,
  19.   K_ACCEPT6,
  20.   K_DIRECTORY_SIGNATURE,
  21.   K_RECOMMENDED_SOFTWARE,
  22.   K_REJECT,
  23.   K_REJECT6,
  24.   K_ROUTER,
  25.   K_SIGNED_DIRECTORY,
  26.   K_SIGNING_KEY,
  27.   K_ONION_KEY,
  28.   K_ROUTER_SIGNATURE,
  29.   K_PUBLISHED,
  30.   K_RUNNING_ROUTERS,
  31.   K_ROUTER_STATUS,
  32.   K_PLATFORM,
  33.   K_OPT,
  34.   K_BANDWIDTH,
  35.   K_CONTACT,
  36.   K_NETWORK_STATUS,
  37.   K_UPTIME,
  38.   K_DIR_SIGNING_KEY,
  39.   K_FAMILY,
  40.   K_FINGERPRINT,
  41.   K_HIBERNATING,
  42.   K_READ_HISTORY,
  43.   K_WRITE_HISTORY,
  44.   K_NETWORK_STATUS_VERSION,
  45.   K_DIR_SOURCE,
  46.   K_DIR_OPTIONS,
  47.   K_CLIENT_VERSIONS,
  48.   K_SERVER_VERSIONS,
  49.   K_P,
  50.   K_R,
  51.   K_S,
  52.   K_V,
  53.   K_W,
  54.   K_EVENTDNS,
  55.   K_EXTRA_INFO,
  56.   K_EXTRA_INFO_DIGEST,
  57.   K_CACHES_EXTRA_INFO,
  58.   K_HIDDEN_SERVICE_DIR,
  59.   K_ALLOW_SINGLE_HOP_EXITS,
  60.   K_DIR_KEY_CERTIFICATE_VERSION,
  61.   K_DIR_IDENTITY_KEY,
  62.   K_DIR_KEY_PUBLISHED,
  63.   K_DIR_KEY_EXPIRES,
  64.   K_DIR_KEY_CERTIFICATION,
  65.   K_DIR_KEY_CROSSCERT,
  66.   K_DIR_ADDRESS,
  67.   K_VOTE_STATUS,
  68.   K_VALID_AFTER,
  69.   K_FRESH_UNTIL,
  70.   K_VALID_UNTIL,
  71.   K_VOTING_DELAY,
  72.   K_KNOWN_FLAGS,
  73.   K_PARAMS,
  74.   K_VOTE_DIGEST,
  75.   K_CONSENSUS_DIGEST,
  76.   K_CONSENSUS_METHODS,
  77.   K_CONSENSUS_METHOD,
  78.   K_LEGACY_DIR_KEY,
  79.   A_PURPOSE,
  80.   _A_UNKNOWN,
  81.   R_RENDEZVOUS_SERVICE_DESCRIPTOR,
  82.   R_VERSION,
  83.   R_PERMANENT_KEY,
  84.   R_SECRET_ID_PART,
  85.   R_PUBLICATION_TIME,
  86.   R_PROTOCOL_VERSIONS,
  87.   R_INTRODUCTION_POINTS,
  88.   R_SIGNATURE,
  89.   R_IPO_IDENTIFIER,
  90.   R_IPO_IP_ADDRESS,
  91.   R_IPO_ONION_PORT,
  92.   R_IPO_ONION_KEY,
  93.   R_IPO_SERVICE_KEY,
  94.   C_CLIENT_NAME,
  95.   C_DESCRIPTOR_COOKIE,
  96.   C_CLIENT_KEY,
  97.   _ERR,
  98.   _EOF,
  99.   _NIL
  100. } directory_keyword;
  101. #define MIN_ANNOTATION A_PURPOSE
  102. #define MAX_ANNOTATION _A_UNKNOWN
  103. /** Structure to hold a single directory token.
  104.  *
  105.  * We parse a directory by breaking it into "tokens", each consisting
  106.  * of a keyword, a line full of arguments, and a binary object.  The
  107.  * arguments and object are both optional, depending on the keyword
  108.  * type.
  109.  *
  110.  * This structure is only allocated in memareas; do not allocate it on
  111.  * the heap, or token_free() won't work.
  112.  */
  113. typedef struct directory_token_t {
  114.   directory_keyword tp;        /**< Type of the token. */
  115.   int n_args:30;               /**< Number of elements in args */
  116.   char **args;                 /**< Array of arguments from keyword line. */
  117.   char *object_type;           /**< -----BEGIN [object_type]-----*/
  118.   size_t object_size;          /**< Bytes in object_body */
  119.   char *object_body;           /**< Contents of object, base64-decoded. */
  120.   crypto_pk_env_t *key;        /**< For public keys only.  Heap-allocated. */
  121.   char *error;                 /**< For _ERR tokens only. */
  122. } directory_token_t;
  123. /* ********************************************************************** */
  124. /** We use a table of rules to decide how to parse each token type. */
  125. /** Rules for whether the keyword needs an object. */
  126. typedef enum {
  127.   NO_OBJ,        /**< No object, ever. */
  128.   NEED_OBJ,      /**< Object is required. */
  129.   NEED_SKEY_1024,/**< Object is required, and must be a 1024 bit private key */
  130.   NEED_KEY_1024, /**< Object is required, and must be a 1024 bit public key */
  131.   NEED_KEY,      /**< Object is required, and must be a public key. */
  132.   OBJ_OK,        /**< Object is optional. */
  133. } obj_syntax;
  134. #define AT_START 1
  135. #define AT_END 2
  136. /** Determines the parsing rules for a single token type. */
  137. typedef struct token_rule_t {
  138.   /** The string value of the keyword identifying the type of item. */
  139.   const char *t;
  140.   /** The corresponding directory_keyword enum. */
  141.   directory_keyword v;
  142.   /** Minimum number of arguments for this item */
  143.   int min_args;
  144.   /** Maximum number of arguments for this item */
  145.   int max_args;
  146.   /** If true, we concatenate all arguments for this item into a single
  147.    * string. */
  148.   int concat_args;
  149.   /** Requirements on object syntax for this item. */
  150.   obj_syntax os;
  151.   /** Lowest number of times this item may appear in a document. */
  152.   int min_cnt;
  153.   /** Highest number of times this item may appear in a document. */
  154.   int max_cnt;
  155.   /** One or more of AT_START/AT_END to limit where the item may appear in a
  156.    * document. */
  157.   int pos;
  158.   /** True iff this token is an annotation. */
  159.   int is_annotation;
  160. } token_rule_t;
  161. /*
  162.  * Helper macros to define token tables.  's' is a string, 't' is a
  163.  * directory_keyword, 'a' is a trio of argument multiplicities, and 'o' is an
  164.  * object syntax.
  165.  *
  166.  */
  167. /** Appears to indicate the end of a table. */
  168. #define END_OF_TABLE { NULL, _NIL, 0,0,0, NO_OBJ, 0, INT_MAX, 0, 0 }
  169. /** An item with no restrictions: used for obsolete document types */
  170. #define T(s,t,a,o)    { s, t, a, o, 0, INT_MAX, 0, 0 }
  171. /** An item with no restrictions on multiplicity or location. */
  172. #define T0N(s,t,a,o)  { s, t, a, o, 0, INT_MAX, 0, 0 }
  173. /** An item that must appear exactly once */
  174. #define T1(s,t,a,o)   { s, t, a, o, 1, 1, 0, 0 }
  175. /** An item that must appear exactly once, at the start of the document */
  176. #define T1_START(s,t,a,o)   { s, t, a, o, 1, 1, AT_START, 0 }
  177. /** An item that must appear exactly once, at the end of the document */
  178. #define T1_END(s,t,a,o)   { s, t, a, o, 1, 1, AT_END, 0 }
  179. /** An item that must appear one or more times */
  180. #define T1N(s,t,a,o)  { s, t, a, o, 1, INT_MAX, 0, 0 }
  181. /** An item that must appear no more than once */
  182. #define T01(s,t,a,o)  { s, t, a, o, 0, 1, 0, 0 }
  183. /** An annotation that must appear no more than once */
  184. #define A01(s,t,a,o)  { s, t, a, o, 0, 1, 0, 1 }
  185. /* Argument multiplicity: any number of arguments. */
  186. #define ARGS        0,INT_MAX,0
  187. /* Argument multiplicity: no arguments. */
  188. #define NO_ARGS     0,0,0
  189. /* Argument multiplicity: concatenate all arguments. */
  190. #define CONCAT_ARGS 1,1,1
  191. /* Argument multiplicity: at least <b>n</b> arguments. */
  192. #define GE(n)       n,INT_MAX,0
  193. /* Argument multiplicity: exactly <b>n</b> arguments. */
  194. #define EQ(n)       n,n,0
  195. /** List of tokens allowable in router descriptors */
  196. static token_rule_t routerdesc_token_table[] = {
  197.   T0N("reject",              K_REJECT,              ARGS,    NO_OBJ ),
  198.   T0N("accept",              K_ACCEPT,              ARGS,    NO_OBJ ),
  199.   T0N("reject6",             K_REJECT6,             ARGS,    NO_OBJ ),
  200.   T0N("accept6",             K_ACCEPT6,             ARGS,    NO_OBJ ),
  201.   T1_START( "router",        K_ROUTER,              GE(5),   NO_OBJ ),
  202.   T1( "signing-key",         K_SIGNING_KEY,         NO_ARGS, NEED_KEY_1024 ),
  203.   T1( "onion-key",           K_ONION_KEY,           NO_ARGS, NEED_KEY_1024 ),
  204.   T1_END( "router-signature",    K_ROUTER_SIGNATURE,    NO_ARGS, NEED_OBJ ),
  205.   T1( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
  206.   T01("uptime",              K_UPTIME,              GE(1),   NO_OBJ ),
  207.   T01("fingerprint",         K_FINGERPRINT,     CONCAT_ARGS, NO_OBJ ),
  208.   T01("hibernating",         K_HIBERNATING,         GE(1),   NO_OBJ ),
  209.   T01("platform",            K_PLATFORM,        CONCAT_ARGS, NO_OBJ ),
  210.   T01("contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  211.   T01("read-history",        K_READ_HISTORY,        ARGS,    NO_OBJ ),
  212.   T01("write-history",       K_WRITE_HISTORY,       ARGS,    NO_OBJ ),
  213.   T01("extra-info-digest",   K_EXTRA_INFO_DIGEST,   GE(1),   NO_OBJ ),
  214.   T01("hidden-service-dir",  K_HIDDEN_SERVICE_DIR,  NO_ARGS, NO_OBJ ),
  215.   T01("allow-single-hop-exits",K_ALLOW_SINGLE_HOP_EXITS,    NO_ARGS, NO_OBJ ),
  216.   T01("family",              K_FAMILY,              ARGS,    NO_OBJ ),
  217.   T01("caches-extra-info",   K_CACHES_EXTRA_INFO,   NO_ARGS, NO_OBJ ),
  218.   T01("eventdns",            K_EVENTDNS,            ARGS,    NO_OBJ ),
  219.   T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  220.   T1( "bandwidth",           K_BANDWIDTH,           GE(3),   NO_OBJ ),
  221.   A01("@purpose",            A_PURPOSE,             GE(1),   NO_OBJ ),
  222.   END_OF_TABLE
  223. };
  224. /** List of tokens allowable in extra-info documents. */
  225. static token_rule_t extrainfo_token_table[] = {
  226.   T1_END( "router-signature",    K_ROUTER_SIGNATURE,    NO_ARGS, NEED_OBJ ),
  227.   T1( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
  228.   T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  229.   T01("read-history",        K_READ_HISTORY,        ARGS,    NO_OBJ ),
  230.   T01("write-history",       K_WRITE_HISTORY,       ARGS,    NO_OBJ ),
  231.   T1_START( "extra-info",          K_EXTRA_INFO,          GE(2),   NO_OBJ ),
  232.   END_OF_TABLE
  233. };
  234. /** List of tokens allowable in the body part of v2 and v3 networkstatus
  235.  * documents. */
  236. static token_rule_t rtrstatus_token_table[] = {
  237.   T01("p",                   K_P,               CONCAT_ARGS, NO_OBJ ),
  238.   T1( "r",                   K_R,                   GE(8),   NO_OBJ ),
  239.   T1( "s",                   K_S,                   ARGS,    NO_OBJ ),
  240.   T01("v",                   K_V,               CONCAT_ARGS, NO_OBJ ),
  241.   T01("w",                   K_W,                   ARGS,    NO_OBJ ),
  242.   T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  243.   END_OF_TABLE
  244. };
  245. /** List of tokens allowable in the header part of v2 networkstatus documents.
  246.  */
  247. static token_rule_t netstatus_token_table[] = {
  248.   T1( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
  249.   T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  250.   T1( "contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  251.   T1( "dir-signing-key",     K_DIR_SIGNING_KEY,  NO_ARGS,    NEED_KEY_1024 ),
  252.   T1( "fingerprint",         K_FINGERPRINT,     CONCAT_ARGS, NO_OBJ ),
  253.   T1_START("network-status-version", K_NETWORK_STATUS_VERSION,
  254.                                                     GE(1),   NO_OBJ ),
  255.   T1( "dir-source",          K_DIR_SOURCE,          GE(3),   NO_OBJ ),
  256.   T01("dir-options",         K_DIR_OPTIONS,         ARGS,    NO_OBJ ),
  257.   T01("client-versions",     K_CLIENT_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  258.   T01("server-versions",     K_SERVER_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  259.   END_OF_TABLE
  260. };
  261. /** List of tokens allowable in the footer of v1/v2 directory/networkstatus
  262.  * footers. */
  263. static token_rule_t dir_footer_token_table[] = {
  264.   T1("directory-signature", K_DIRECTORY_SIGNATURE, EQ(1), NEED_OBJ ),
  265.   END_OF_TABLE
  266. };
  267. /** List of tokens allowable in v1 directory headers/footers. */
  268. static token_rule_t dir_token_table[] = {
  269.   /* don't enforce counts; this is obsolete. */
  270.   T( "network-status",      K_NETWORK_STATUS,      NO_ARGS, NO_OBJ ),
  271.   T( "directory-signature", K_DIRECTORY_SIGNATURE, ARGS,    NEED_OBJ ),
  272.   T( "recommended-software",K_RECOMMENDED_SOFTWARE,CONCAT_ARGS, NO_OBJ ),
  273.   T( "signed-directory",    K_SIGNED_DIRECTORY,    NO_ARGS, NO_OBJ ),
  274.   T( "running-routers",     K_RUNNING_ROUTERS,     ARGS,    NO_OBJ ),
  275.   T( "router-status",       K_ROUTER_STATUS,       ARGS,    NO_OBJ ),
  276.   T( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
  277.   T( "opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  278.   T( "contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  279.   T( "dir-signing-key",     K_DIR_SIGNING_KEY,     ARGS,    OBJ_OK ),
  280.   T( "fingerprint",         K_FINGERPRINT,     CONCAT_ARGS, NO_OBJ ),
  281.   END_OF_TABLE
  282. };
  283. /** List of tokens common to V3 authority certificates and V3 consensuses. */
  284. #define CERTIFICATE_MEMBERS                                                  
  285.   T1("dir-key-certificate-version", K_DIR_KEY_CERTIFICATE_VERSION,           
  286.                                                      GE(1),       NO_OBJ ),  
  287.   T1("dir-identity-key", K_DIR_IDENTITY_KEY,         NO_ARGS,     NEED_KEY ),
  288.   T1("dir-key-published",K_DIR_KEY_PUBLISHED,        CONCAT_ARGS, NO_OBJ),   
  289.   T1("dir-key-expires",  K_DIR_KEY_EXPIRES,          CONCAT_ARGS, NO_OBJ),   
  290.   T1("dir-signing-key",  K_DIR_SIGNING_KEY,          NO_ARGS,     NEED_KEY ),
  291.   T01("dir-key-crosscert", K_DIR_KEY_CROSSCERT,       NO_ARGS,    NEED_OBJ ),
  292.   T1("dir-key-certification", K_DIR_KEY_CERTIFICATION,                       
  293.                                                      NO_ARGS,     NEED_OBJ), 
  294.   T01("dir-address",     K_DIR_ADDRESS,              GE(1),       NO_OBJ),
  295. /** List of tokens allowable in V3 authority certificates. */
  296. static token_rule_t dir_key_certificate_table[] = {
  297.   CERTIFICATE_MEMBERS
  298.   T1("fingerprint",      K_FINGERPRINT,              CONCAT_ARGS, NO_OBJ ),
  299.   END_OF_TABLE
  300. };
  301. /** List of tokens allowable in rendezvous service descriptors */
  302. static token_rule_t desc_token_table[] = {
  303.   T1_START("rendezvous-service-descriptor", R_RENDEZVOUS_SERVICE_DESCRIPTOR,
  304.            EQ(1), NO_OBJ),
  305.   T1("version", R_VERSION, EQ(1), NO_OBJ),
  306.   T1("permanent-key", R_PERMANENT_KEY, NO_ARGS, NEED_KEY_1024),
  307.   T1("secret-id-part", R_SECRET_ID_PART, EQ(1), NO_OBJ),
  308.   T1("publication-time", R_PUBLICATION_TIME, CONCAT_ARGS, NO_OBJ),
  309.   T1("protocol-versions", R_PROTOCOL_VERSIONS, EQ(1), NO_OBJ),
  310.   T01("introduction-points", R_INTRODUCTION_POINTS, NO_ARGS, NEED_OBJ),
  311.   T1_END("signature", R_SIGNATURE, NO_ARGS, NEED_OBJ),
  312.   END_OF_TABLE
  313. };
  314. /** List of tokens allowed in the (encrypted) list of introduction points of
  315.  * rendezvous service descriptors */
  316. static token_rule_t ipo_token_table[] = {
  317.   T1_START("introduction-point", R_IPO_IDENTIFIER, EQ(1), NO_OBJ),
  318.   T1("ip-address", R_IPO_IP_ADDRESS, EQ(1), NO_OBJ),
  319.   T1("onion-port", R_IPO_ONION_PORT, EQ(1), NO_OBJ),
  320.   T1("onion-key", R_IPO_ONION_KEY, NO_ARGS, NEED_KEY_1024),
  321.   T1("service-key", R_IPO_SERVICE_KEY, NO_ARGS, NEED_KEY_1024),
  322.   END_OF_TABLE
  323. };
  324. /** List of tokens allowed in the (possibly encrypted) list of introduction
  325.  * points of rendezvous service descriptors */
  326. static token_rule_t client_keys_token_table[] = {
  327.   T1_START("client-name", C_CLIENT_NAME, CONCAT_ARGS, NO_OBJ),
  328.   T1("descriptor-cookie", C_DESCRIPTOR_COOKIE, EQ(1), NO_OBJ),
  329.   T01("client-key", C_CLIENT_KEY, NO_ARGS, NEED_SKEY_1024),
  330.   END_OF_TABLE
  331. };
  332. /** List of tokens allowed in V3 networkstatus votes. */
  333. static token_rule_t networkstatus_token_table[] = {
  334.   T1("network-status-version", K_NETWORK_STATUS_VERSION,
  335.                                                    GE(1),       NO_OBJ ),
  336.   T1("vote-status",            K_VOTE_STATUS,      GE(1),       NO_OBJ ),
  337.   T1("published",              K_PUBLISHED,        CONCAT_ARGS, NO_OBJ ),
  338.   T1("valid-after",            K_VALID_AFTER,      CONCAT_ARGS, NO_OBJ ),
  339.   T1("fresh-until",            K_FRESH_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  340.   T1("valid-until",            K_VALID_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  341.   T1("voting-delay",           K_VOTING_DELAY,     GE(2),       NO_OBJ ),
  342.   T1("known-flags",            K_KNOWN_FLAGS,      ARGS,        NO_OBJ ),
  343.   T01("params",                K_PARAMS,           ARGS,        NO_OBJ ),
  344.   T( "fingerprint",            K_FINGERPRINT,      CONCAT_ARGS, NO_OBJ ),
  345.   CERTIFICATE_MEMBERS
  346.   T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  347.   T1( "contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  348.   T1( "dir-source",          K_DIR_SOURCE,      GE(6),       NO_OBJ ),
  349.   T01("legacy-dir-key",      K_LEGACY_DIR_KEY,  GE(1),       NO_OBJ ),
  350.   T1( "known-flags",         K_KNOWN_FLAGS,     CONCAT_ARGS, NO_OBJ ),
  351.   T01("client-versions",     K_CLIENT_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  352.   T01("server-versions",     K_SERVER_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  353.   T1( "consensus-methods",   K_CONSENSUS_METHODS, GE(1),     NO_OBJ ),
  354.   END_OF_TABLE
  355. };
  356. /** List of tokens allowed in V3 networkstatus consensuses. */
  357. static token_rule_t networkstatus_consensus_token_table[] = {
  358.   T1("network-status-version", K_NETWORK_STATUS_VERSION,
  359.                                                    GE(1),       NO_OBJ ),
  360.   T1("vote-status",            K_VOTE_STATUS,      GE(1),       NO_OBJ ),
  361.   T1("valid-after",            K_VALID_AFTER,      CONCAT_ARGS, NO_OBJ ),
  362.   T1("fresh-until",            K_FRESH_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  363.   T1("valid-until",            K_VALID_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  364.   T1("voting-delay",           K_VOTING_DELAY,     GE(2),       NO_OBJ ),
  365.   T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  366.   T1N("dir-source",          K_DIR_SOURCE,          GE(6),   NO_OBJ ),
  367.   T1N("contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  368.   T1N("vote-digest",         K_VOTE_DIGEST,         GE(1),   NO_OBJ ),
  369.   T1( "known-flags",         K_KNOWN_FLAGS,     CONCAT_ARGS, NO_OBJ ),
  370.   T01("client-versions",     K_CLIENT_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  371.   T01("server-versions",     K_SERVER_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  372.   T01("consensus-method",    K_CONSENSUS_METHOD,    EQ(1),   NO_OBJ),
  373.   T01("params",                K_PARAMS,           ARGS,        NO_OBJ ),
  374.   END_OF_TABLE
  375. };
  376. /** List of tokens allowable in the footer of v1/v2 directory/networkstatus
  377.  * footers. */
  378. static token_rule_t networkstatus_vote_footer_token_table[] = {
  379.   T(  "directory-signature", K_DIRECTORY_SIGNATURE, GE(2),   NEED_OBJ ),
  380.   END_OF_TABLE
  381. };
  382. /** List of tokens allowable in detached networkstatus signature documents. */
  383. static token_rule_t networkstatus_detached_signature_token_table[] = {
  384.   T1_START("consensus-digest", K_CONSENSUS_DIGEST, GE(1),       NO_OBJ ),
  385.   T1("valid-after",            K_VALID_AFTER,      CONCAT_ARGS, NO_OBJ ),
  386.   T1("fresh-until",            K_FRESH_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  387.   T1("valid-until",            K_VALID_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  388.   T1N("directory-signature", K_DIRECTORY_SIGNATURE, GE(2),   NEED_OBJ ),
  389.   END_OF_TABLE
  390. };
  391. #undef T
  392. /* static function prototypes */
  393. static int router_add_exit_policy(routerinfo_t *router,directory_token_t *tok);
  394. static addr_policy_t *router_parse_addr_policy(directory_token_t *tok);
  395. static addr_policy_t *router_parse_addr_policy_private(directory_token_t *tok);
  396. static int router_get_hash_impl(const char *s, char *digest,
  397.                                 const char *start_str, const char *end_str,
  398.                                 char end_char);
  399. static void token_free(directory_token_t *tok);
  400. static smartlist_t *find_all_exitpolicy(smartlist_t *s);
  401. static directory_token_t *_find_by_keyword(smartlist_t *s,
  402.                                            directory_keyword keyword,
  403.                                            const char *keyword_str);
  404. #define find_by_keyword(s, keyword) _find_by_keyword((s), (keyword), #keyword)
  405. static directory_token_t *find_opt_by_keyword(smartlist_t *s,
  406.                                               directory_keyword keyword);
  407. #define TS_ANNOTATIONS_OK 1
  408. #define TS_NOCHECK 2
  409. #define TS_NO_NEW_ANNOTATIONS 4
  410. static int tokenize_string(memarea_t *area,
  411.                            const char *start, const char *end,
  412.                            smartlist_t *out,
  413.                            token_rule_t *table,
  414.                            int flags);
  415. static directory_token_t *get_next_token(memarea_t *area,
  416.                                          const char **s,
  417.                                          const char *eos,
  418.                                          token_rule_t *table);
  419. #define CST_CHECK_AUTHORITY   (1<<0)
  420. #define CST_NO_CHECK_OBJTYPE  (1<<1)
  421. static int check_signature_token(const char *digest,
  422.                                  directory_token_t *tok,
  423.                                  crypto_pk_env_t *pkey,
  424.                                  int flags,
  425.                                  const char *doctype);
  426. static crypto_pk_env_t *find_dir_signing_key(const char *str, const char *eos);
  427. static int tor_version_same_series(tor_version_t *a, tor_version_t *b);
  428. #undef DEBUG_AREA_ALLOC
  429. #ifdef DEBUG_AREA_ALLOC
  430. #define DUMP_AREA(a,name) STMT_BEGIN                              
  431.   size_t alloc=0, used=0;                                         
  432.   memarea_get_stats((a),&alloc,&used);                            
  433.   log_debug(LD_MM, "Area for %s has %lu allocated; using %lu.",   
  434.             name, (unsigned long)alloc, (unsigned long)used);     
  435.   STMT_END
  436. #else
  437. #define DUMP_AREA(a,name) STMT_NIL
  438. #endif
  439. /** Set <b>digest</b> to the SHA-1 digest of the hash of the directory in
  440.  * <b>s</b>.  Return 0 on success, -1 on failure.
  441.  */
  442. int
  443. router_get_dir_hash(const char *s, char *digest)
  444. {
  445.   return router_get_hash_impl(s,digest,
  446.                               "signed-directory","ndirectory-signature",'n');
  447. }
  448. /** Set <b>digest</b> to the SHA-1 digest of the hash of the first router in
  449.  * <b>s</b>. Return 0 on success, -1 on failure.
  450.  */
  451. int
  452. router_get_router_hash(const char *s, char *digest)
  453. {
  454.   return router_get_hash_impl(s,digest,
  455.                               "router ","nrouter-signature", 'n');
  456. }
  457. /** Set <b>digest</b> to the SHA-1 digest of the hash of the running-routers
  458.  * string in <b>s</b>. Return 0 on success, -1 on failure.
  459.  */
  460. int
  461. router_get_runningrouters_hash(const char *s, char *digest)
  462. {
  463.   return router_get_hash_impl(s,digest,
  464.                               "network-status","ndirectory-signature", 'n');
  465. }
  466. /** Set <b>digest</b> to the SHA-1 digest of the hash of the network-status
  467.  * string in <b>s</b>.  Return 0 on success, -1 on failure. */
  468. int
  469. router_get_networkstatus_v2_hash(const char *s, char *digest)
  470. {
  471.   return router_get_hash_impl(s,digest,
  472.                               "network-status-version","ndirectory-signature",
  473.                               'n');
  474. }
  475. /** Set <b>digest</b> to the SHA-1 digest of the hash of the network-status
  476.  * string in <b>s</b>.  Return 0 on success, -1 on failure. */
  477. int
  478. router_get_networkstatus_v3_hash(const char *s, char *digest)
  479. {
  480.   return router_get_hash_impl(s,digest,
  481.                               "network-status-version","ndirectory-signature",
  482.                               ' ');
  483. }
  484. /** Set <b>digest</b> to the SHA-1 digest of the hash of the extrainfo
  485.  * string in <b>s</b>.  Return 0 on success, -1 on failure. */
  486. int
  487. router_get_extrainfo_hash(const char *s, char *digest)
  488. {
  489.   return router_get_hash_impl(s,digest,"extra-info","nrouter-signature",'n');
  490. }
  491. /** Helper: used to generate signatures for routers, directories and
  492.  * network-status objects.  Given a digest in <b>digest</b> and a secret
  493.  * <b>private_key</b>, generate an PKCS1-padded signature, BASE64-encode it,
  494.  * surround it with -----BEGIN/END----- pairs, and write it to the
  495.  * <b>buf_len</b>-byte buffer at <b>buf</b>.  Return 0 on success, -1 on
  496.  * failure.
  497.  */
  498. int
  499. router_append_dirobj_signature(char *buf, size_t buf_len, const char *digest,
  500.                                crypto_pk_env_t *private_key)
  501. {
  502.   char *signature;
  503.   size_t i;
  504.   signature = tor_malloc(crypto_pk_keysize(private_key));
  505.   if (crypto_pk_private_sign(private_key, signature, digest, DIGEST_LEN) < 0) {
  506.     log_warn(LD_BUG,"Couldn't sign digest.");
  507.     goto err;
  508.   }
  509.   if (strlcat(buf, "-----BEGIN SIGNATURE-----n", buf_len) >= buf_len)
  510.     goto truncated;
  511.   i = strlen(buf);
  512.   if (base64_encode(buf+i, buf_len-i, signature, 128) < 0) {
  513.     log_warn(LD_BUG,"couldn't base64-encode signature");
  514.     goto err;
  515.   }
  516.   if (strlcat(buf, "-----END SIGNATURE-----n", buf_len) >= buf_len)
  517.     goto truncated;
  518.   tor_free(signature);
  519.   return 0;
  520.  truncated:
  521.   log_warn(LD_BUG,"tried to exceed string length.");
  522.  err:
  523.   tor_free(signature);
  524.   return -1;
  525. }
  526. /** Return VS_RECOMMENDED if <b>myversion</b> is contained in
  527.  * <b>versionlist</b>.  Else, return VS_EMPTY if versionlist has no
  528.  * entries. Else, return VS_OLD if every member of
  529.  * <b>versionlist</b> is newer than <b>myversion</b>.  Else, return
  530.  * VS_NEW_IN_SERIES if there is at least one member of <b>versionlist</b> in
  531.  * the same series (major.minor.micro) as <b>myversion</b>, but no such member
  532.  * is newer than <b>myversion.</b>.  Else, return VS_NEW if every member of
  533.  * <b>versionlist</b> is older than <b>myversion</b>.  Else, return
  534.  * VS_UNRECOMMENDED.
  535.  *
  536.  * (versionlist is a comma-separated list of version strings,
  537.  * optionally prefixed with "Tor".  Versions that can't be parsed are
  538.  * ignored.)
  539.  */
  540. version_status_t
  541. tor_version_is_obsolete(const char *myversion, const char *versionlist)
  542. {
  543.   tor_version_t mine, other;
  544.   int found_newer = 0, found_older = 0, found_newer_in_series = 0,
  545.     found_any_in_series = 0, r, same;
  546.   version_status_t ret = VS_UNRECOMMENDED;
  547.   smartlist_t *version_sl;
  548.   log_debug(LD_CONFIG,"Checking whether version '%s' is in '%s'",
  549.             myversion, versionlist);
  550.   if (tor_version_parse(myversion, &mine)) {
  551.     log_err(LD_BUG,"I couldn't parse my own version (%s)", myversion);
  552.     tor_assert(0);
  553.   }
  554.   version_sl = smartlist_create();
  555.   smartlist_split_string(version_sl, versionlist, ",", SPLIT_SKIP_SPACE, 0);
  556.   if (!strlen(versionlist)) { /* no authorities cared or agreed */
  557.     ret = VS_EMPTY;
  558.     goto done;
  559.   }
  560.   SMARTLIST_FOREACH(version_sl, const char *, cp, {
  561.     if (!strcmpstart(cp, "Tor "))
  562.       cp += 4;
  563.     if (tor_version_parse(cp, &other)) {
  564.       /* Couldn't parse other; it can't be a match. */
  565.     } else {
  566.       same = tor_version_same_series(&mine, &other);
  567.       if (same)
  568.         found_any_in_series = 1;
  569.       r = tor_version_compare(&mine, &other);
  570.       if (r==0) {
  571.         ret = VS_RECOMMENDED;
  572.         goto done;
  573.       } else if (r<0) {
  574.         found_newer = 1;
  575.         if (same)
  576.           found_newer_in_series = 1;
  577.       } else if (r>0) {
  578.         found_older = 1;
  579.       }
  580.     }
  581.   });
  582.   /* We didn't find the listed version. Is it new or old? */
  583.   if (found_any_in_series && !found_newer_in_series && found_newer) {
  584.     ret = VS_NEW_IN_SERIES;
  585.   } else if (found_newer && !found_older) {
  586.     ret = VS_OLD;
  587.   } else if (found_older && !found_newer) {
  588.     ret = VS_NEW;
  589.   } else {
  590.     ret = VS_UNRECOMMENDED;
  591.   }
  592.  done:
  593.   SMARTLIST_FOREACH(version_sl, char *, version, tor_free(version));
  594.   smartlist_free(version_sl);
  595.   return ret;
  596. }
  597. /** Read a signed directory from <b>str</b>.  If it's well-formed, return 0.
  598.  * Otherwise, return -1.  If we're a directory cache, cache it.
  599.  */
  600. int
  601. router_parse_directory(const char *str)
  602. {
  603.   directory_token_t *tok;
  604.   char digest[DIGEST_LEN];
  605.   time_t published_on;
  606.   int r;
  607.   const char *end, *cp;
  608.   smartlist_t *tokens = NULL;
  609.   crypto_pk_env_t *declared_key = NULL;
  610.   memarea_t *area = memarea_new();
  611.   /* XXXX This could be simplified a lot, but it will all go away
  612.    * once pre-0.1.1.8 is obsolete, and for now it's better not to
  613.    * touch it. */
  614.   if (router_get_dir_hash(str, digest)) {
  615.     log_warn(LD_DIR, "Unable to compute digest of directory");
  616.     goto err;
  617.   }
  618.   log_debug(LD_DIR,"Received directory hashes to %s",hex_str(digest,4));
  619.   /* Check signature first, before we try to tokenize. */
  620.   cp = str;
  621.   while (cp && (end = strstr(cp+1, "ndirectory-signature")))
  622.     cp = end;
  623.   if (cp == str || !cp) {
  624.     log_warn(LD_DIR, "No signature found on directory."); goto err;
  625.   }
  626.   ++cp;
  627.   tokens = smartlist_create();
  628.   if (tokenize_string(area,cp,strchr(cp,''),tokens,dir_token_table,0)) {
  629.     log_warn(LD_DIR, "Error tokenizing directory signature"); goto err;
  630.   }
  631.   if (smartlist_len(tokens) != 1) {
  632.     log_warn(LD_DIR, "Unexpected number of tokens in signature"); goto err;
  633.   }
  634.   tok=smartlist_get(tokens,0);
  635.   if (tok->tp != K_DIRECTORY_SIGNATURE) {
  636.     log_warn(LD_DIR,"Expected a single directory signature"); goto err;
  637.   }
  638.   declared_key = find_dir_signing_key(str, str+strlen(str));
  639.   note_crypto_pk_op(VERIFY_DIR);
  640.   if (check_signature_token(digest, tok, declared_key,
  641.                             CST_CHECK_AUTHORITY, "directory")<0)
  642.     goto err;
  643.   SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  644.   smartlist_clear(tokens);
  645.   memarea_clear(area);
  646.   /* Now try to parse the first part of the directory. */
  647.   if ((end = strstr(str,"nrouter "))) {
  648.     ++end;
  649.   } else if ((end = strstr(str, "ndirectory-signature"))) {
  650.     ++end;
  651.   } else {
  652.     end = str + strlen(str);
  653.   }
  654.   if (tokenize_string(area,str,end,tokens,dir_token_table,0)) {
  655.     log_warn(LD_DIR, "Error tokenizing directory"); goto err;
  656.   }
  657.   tok = find_by_keyword(tokens, K_PUBLISHED);
  658.   tor_assert(tok->n_args == 1);
  659.   if (parse_iso_time(tok->args[0], &published_on) < 0) {
  660.      goto err;
  661.   }
  662.   /* Now that we know the signature is okay, and we have a
  663.    * publication time, cache the directory. */
  664.   if (directory_caches_v1_dir_info(get_options()) &&
  665.       !authdir_mode_v1(get_options()))
  666.     dirserv_set_cached_directory(str, published_on, 0);
  667.   r = 0;
  668.   goto done;
  669.  err:
  670.   r = -1;
  671.  done:
  672.   if (declared_key) crypto_free_pk_env(declared_key);
  673.   if (tokens) {
  674.     SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  675.     smartlist_free(tokens);
  676.   }
  677.   if (area) {
  678.     DUMP_AREA(area, "v1 directory");
  679.     memarea_drop_all(area);
  680.   }
  681.   return r;
  682. }
  683. /** Read a signed router status statement from <b>str</b>.  If it's
  684.  * well-formed, return 0.  Otherwise, return -1.  If we're a directory cache,
  685.  * cache it.*/
  686. int
  687. router_parse_runningrouters(const char *str)
  688. {
  689.   char digest[DIGEST_LEN];
  690.   directory_token_t *tok;
  691.   time_t published_on;
  692.   int r = -1;
  693.   crypto_pk_env_t *declared_key = NULL;
  694.   smartlist_t *tokens = NULL;
  695.   const char *eos = str + strlen(str);
  696.   memarea_t *area = NULL;
  697.   if (router_get_runningrouters_hash(str, digest)) {
  698.     log_warn(LD_DIR, "Unable to compute digest of running-routers");
  699.     goto err;
  700.   }
  701.   area = memarea_new();
  702.   tokens = smartlist_create();
  703.   if (tokenize_string(area,str,eos,tokens,dir_token_table,0)) {
  704.     log_warn(LD_DIR, "Error tokenizing running-routers"); goto err;
  705.   }
  706.   tok = smartlist_get(tokens,0);
  707.   if (tok->tp != K_NETWORK_STATUS) {
  708.     log_warn(LD_DIR, "Network-status starts with wrong token");
  709.     goto err;
  710.   }
  711.   tok = find_by_keyword(tokens, K_PUBLISHED);
  712.   tor_assert(tok->n_args == 1);
  713.   if (parse_iso_time(tok->args[0], &published_on) < 0) {
  714.      goto err;
  715.   }
  716.   if (!(tok = find_opt_by_keyword(tokens, K_DIRECTORY_SIGNATURE))) {
  717.     log_warn(LD_DIR, "Missing signature on running-routers");
  718.     goto err;
  719.   }
  720.   declared_key = find_dir_signing_key(str, eos);
  721.   note_crypto_pk_op(VERIFY_DIR);
  722.   if (check_signature_token(digest, tok, declared_key,
  723.                             CST_CHECK_AUTHORITY, "running-routers")
  724.       < 0)
  725.     goto err;
  726.   /* Now that we know the signature is okay, and we have a
  727.    * publication time, cache the list. */
  728.   if (get_options()->DirPort && !authdir_mode_v1(get_options()))
  729.     dirserv_set_cached_directory(str, published_on, 1);
  730.   r = 0;
  731.  err:
  732.   if (declared_key) crypto_free_pk_env(declared_key);
  733.   if (tokens) {
  734.     SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  735.     smartlist_free(tokens);
  736.   }
  737.   if (area) {
  738.     DUMP_AREA(area, "v1 running-routers");
  739.     memarea_drop_all(area);
  740.   }
  741.   return r;
  742. }
  743. /** Given a directory or running-routers string in <b>str</b>, try to
  744.  * find the its dir-signing-key token (if any).  If this token is
  745.  * present, extract and return the key.  Return NULL on failure. */
  746. static crypto_pk_env_t *
  747. find_dir_signing_key(const char *str, const char *eos)
  748. {
  749.   const char *cp;
  750.   directory_token_t *tok;
  751.   crypto_pk_env_t *key = NULL;
  752.   memarea_t *area = NULL;
  753.   tor_assert(str);
  754.   tor_assert(eos);
  755.   /* Is there a dir-signing-key in the directory? */
  756.   cp = tor_memstr(str, eos-str, "nopt dir-signing-key");
  757.   if (!cp)
  758.     cp = tor_memstr(str, eos-str, "ndir-signing-key");
  759.   if (!cp)
  760.     return NULL;
  761.   ++cp; /* Now cp points to the start of the token. */
  762.   area = memarea_new();
  763.   tok = get_next_token(area, &cp, eos, dir_token_table);
  764.   if (!tok) {
  765.     log_warn(LD_DIR, "Unparseable dir-signing-key token");
  766.     goto done;
  767.   }
  768.   if (tok->tp != K_DIR_SIGNING_KEY) {
  769.     log_warn(LD_DIR, "Dir-signing-key token did not parse as expected");
  770.     goto done;
  771.   }
  772.   if (tok->key) {
  773.     key = tok->key;
  774.     tok->key = NULL; /* steal reference. */
  775.   } else {
  776.     log_warn(LD_DIR, "Dir-signing-key token contained no key");
  777.   }
  778.  done:
  779.   if (tok) token_free(tok);
  780.   if (area) {
  781.     DUMP_AREA(area, "dir-signing-key token");
  782.     memarea_drop_all(area);
  783.   }
  784.   return key;
  785. }
  786. /** Return true iff <b>key</b> is allowed to sign directories.
  787.  */
  788. static int
  789. dir_signing_key_is_trusted(crypto_pk_env_t *key)
  790. {
  791.   char digest[DIGEST_LEN];
  792.   if (!key) return 0;
  793.   if (crypto_pk_get_digest(key, digest) < 0) {
  794.     log_warn(LD_DIR, "Error computing dir-signing-key digest");
  795.     return 0;
  796.   }
  797.   if (!router_digest_is_trusted_dir(digest)) {
  798.     log_warn(LD_DIR, "Listed dir-signing-key is not trusted");
  799.     return 0;
  800.   }
  801.   return 1;
  802. }
  803. /** Check whether the object body of the token in <b>tok</b> has a good
  804.  * signature for <b>digest</b> using key <b>pkey</b>.  If
  805.  * <b>CST_CHECK_AUTHORITY</b> is set, make sure that <b>pkey</b> is the key of
  806.  * a directory authority.  If <b>CST_NO_CHECK_OBJTYPE</b> is set, do not check
  807.  * the object type of the signature object. Use <b>doctype</b> as the type of
  808.  * the document when generating log messages.  Return 0 on success, negative
  809.  * on failure.
  810.  */
  811. static int
  812. check_signature_token(const char *digest,
  813.                       directory_token_t *tok,
  814.                       crypto_pk_env_t *pkey,
  815.                       int flags,
  816.                       const char *doctype)
  817. {
  818.   char *signed_digest;
  819.   const int check_authority = (flags & CST_CHECK_AUTHORITY);
  820.   const int check_objtype = ! (flags & CST_NO_CHECK_OBJTYPE);
  821.   tor_assert(pkey);
  822.   tor_assert(tok);
  823.   tor_assert(digest);
  824.   tor_assert(doctype);
  825.   if (check_authority && !dir_signing_key_is_trusted(pkey)) {
  826.     log_warn(LD_DIR, "Key on %s did not come from an authority; rejecting",
  827.              doctype);
  828.     return -1;
  829.   }
  830.   if (check_objtype) {
  831.     if (strcmp(tok->object_type, "SIGNATURE")) {
  832.       log_warn(LD_DIR, "Bad object type on %s signature", doctype);
  833.       return -1;
  834.     }
  835.   }
  836.   signed_digest = tor_malloc(tok->object_size);
  837.   if (crypto_pk_public_checksig(pkey, signed_digest, tok->object_body,
  838.                                 tok->object_size)
  839.       != DIGEST_LEN) {
  840.     log_warn(LD_DIR, "Error reading %s: invalid signature.", doctype);
  841.     tor_free(signed_digest);
  842.     return -1;
  843.   }
  844. //  log_debug(LD_DIR,"Signed %s hash starts %s", doctype,
  845. //            hex_str(signed_digest,4));
  846.   if (memcmp(digest, signed_digest, DIGEST_LEN)) {
  847.     log_warn(LD_DIR, "Error reading %s: signature does not match.", doctype);
  848.     tor_free(signed_digest);
  849.     return -1;
  850.   }
  851.   tor_free(signed_digest);
  852.   return 0;
  853. }
  854. /** Helper: move *<b>s_ptr</b> ahead to the next router, the next extra-info,
  855.  * or to the first of the annotations proceeding the next router or
  856.  * extra-info---whichever comes first.  Set <b>is_extrainfo_out</b> to true if
  857.  * we found an extrainfo, or false if found a router. Do not scan beyond
  858.  * <b>eos</b>.  Return -1 if we found nothing; 0 if we found something. */
  859. static int
  860. find_start_of_next_router_or_extrainfo(const char **s_ptr,
  861.                                        const char *eos,
  862.                                        int *is_extrainfo_out)
  863. {
  864.   const char *annotations = NULL;
  865.   const char *s = *s_ptr;
  866.   s = eat_whitespace_eos(s, eos);
  867.   while (s < eos-32) {  /* 32 gives enough room for a the first keyword. */
  868.     /* We're at the start of a line. */
  869.     tor_assert(*s != 'n');
  870.     if (*s == '@' && !annotations) {
  871.       annotations = s;
  872.     } else if (*s == 'r' && !strcmpstart(s, "router ")) {
  873.       *s_ptr = annotations ? annotations : s;
  874.       *is_extrainfo_out = 0;
  875.       return 0;
  876.     } else if (*s == 'e' && !strcmpstart(s, "extra-info ")) {
  877.       *s_ptr = annotations ? annotations : s;
  878.       *is_extrainfo_out = 1;
  879.       return 0;
  880.     }
  881.     if (!(s = memchr(s+1, 'n', eos-(s+1))))
  882.       break;
  883.     s = eat_whitespace_eos(s, eos);
  884.   }
  885.   return -1;
  886. }
  887. /** Given a string *<b>s</b> containing a concatenated sequence of router
  888.  * descriptors (or extra-info documents if <b>is_extrainfo</b> is set), parses
  889.  * them and stores the result in <b>dest</b>.  All routers are marked running
  890.  * and valid.  Advances *s to a point immediately following the last router
  891.  * entry.  Ignore any trailing router entries that are not complete.
  892.  *
  893.  * If <b>saved_location</b> isn't SAVED_IN_CACHE, make a local copy of each
  894.  * descriptor in the signed_descriptor_body field of each routerinfo_t.  If it
  895.  * isn't SAVED_NOWHERE, remember the offset of each descriptor.
  896.  *
  897.  * Returns 0 on success and -1 on failure.
  898.  */
  899. int
  900. router_parse_list_from_string(const char **s, const char *eos,
  901.                               smartlist_t *dest,
  902.                               saved_location_t saved_location,
  903.                               int want_extrainfo,
  904.                               int allow_annotations,
  905.                               const char *prepend_annotations)
  906. {
  907.   routerinfo_t *router;
  908.   extrainfo_t *extrainfo;
  909.   signed_descriptor_t *signed_desc;
  910.   void *elt;
  911.   const char *end, *start;
  912.   int have_extrainfo;
  913.   tor_assert(s);
  914.   tor_assert(*s);
  915.   tor_assert(dest);
  916.   start = *s;
  917.   if (!eos)
  918.     eos = *s + strlen(*s);
  919.   tor_assert(eos >= *s);
  920.   while (1) {
  921.     if (find_start_of_next_router_or_extrainfo(s, eos, &have_extrainfo) < 0)
  922.       break;
  923.     end = tor_memstr(*s, eos-*s, "nrouter-signature");
  924.     if (end)
  925.       end = tor_memstr(end, eos-end, "n-----END SIGNATURE-----n");
  926.     if (end)
  927.       end += strlen("n-----END SIGNATURE-----n");
  928.     if (!end)
  929.       break;
  930.     elt = NULL;
  931.     if (have_extrainfo && want_extrainfo) {
  932.       routerlist_t *rl = router_get_routerlist();
  933.       extrainfo = extrainfo_parse_entry_from_string(*s, end,
  934.                                        saved_location != SAVED_IN_CACHE,
  935.                                        rl->identity_map);
  936.       if (extrainfo) {
  937.         signed_desc = &extrainfo->cache_info;
  938.         elt = extrainfo;
  939.       }
  940.     } else if (!have_extrainfo && !want_extrainfo) {
  941.       router = router_parse_entry_from_string(*s, end,
  942.                                               saved_location != SAVED_IN_CACHE,
  943.                                               allow_annotations,
  944.                                               prepend_annotations);
  945.       if (router) {
  946.         log_debug(LD_DIR, "Read router '%s', purpose '%s'",
  947.                   router->nickname, router_purpose_to_string(router->purpose));
  948.         signed_desc = &router->cache_info;
  949.         elt = router;
  950.       }
  951.     }
  952.     if (!elt) {
  953.       *s = end;
  954.       continue;
  955.     }
  956.     if (saved_location != SAVED_NOWHERE) {
  957.       signed_desc->saved_location = saved_location;
  958.       signed_desc->saved_offset = *s - start;
  959.     }
  960.     *s = end;
  961.     smartlist_add(dest, elt);
  962.   }
  963.   return 0;
  964. }
  965. /* For debugging: define to count every descriptor digest we've seen so we
  966.  * know if we need to try harder to avoid duplicate verifies. */
  967. #undef COUNT_DISTINCT_DIGESTS
  968. #ifdef COUNT_DISTINCT_DIGESTS
  969. static digestmap_t *verified_digests = NULL;
  970. #endif
  971. /** Log the total count of the number of distinct router digests we've ever
  972.  * verified.  When compared to the number of times we've verified routerdesc
  973.  * signatures <i>in toto</i>, this will tell us if we're doing too much
  974.  * multiple-verification. */
  975. void
  976. dump_distinct_digest_count(int severity)
  977. {
  978. #ifdef COUNT_DISTINCT_DIGESTS
  979.   if (!verified_digests)
  980.     verified_digests = digestmap_new();
  981.   log(severity, LD_GENERAL, "%d *distinct* router digests verified",
  982.       digestmap_size(verified_digests));
  983. #else
  984.   (void)severity; /* suppress "unused parameter" warning */
  985. #endif
  986. }
  987. /** Helper function: reads a single router entry from *<b>s</b> ...
  988.  * *<b>end</b>.  Mallocs a new router and returns it if all goes well, else
  989.  * returns NULL.  If <b>cache_copy</b> is true, duplicate the contents of
  990.  * s through end into the signed_descriptor_body of the resulting
  991.  * routerinfo_t.
  992.  *
  993.  * If <b>allow_annotations</b>, it's okay to encounter annotations in <b>s</b>
  994.  * before the router; if it's false, reject the router if it's annotated.  If
  995.  * <b>prepend_annotations</b> is set, it should contain some annotations:
  996.  * append them to the front of the router before parsing it, and keep them
  997.  * around when caching the router.
  998.  *
  999.  * Only one of allow_annotations and prepend_annotations may be set.
  1000.  */
  1001. routerinfo_t *
  1002. router_parse_entry_from_string(const char *s, const char *end,
  1003.                                int cache_copy, int allow_annotations,
  1004.                                const char *prepend_annotations)
  1005. {
  1006.   routerinfo_t *router = NULL;
  1007.   char digest[128];
  1008.   smartlist_t *tokens = NULL, *exit_policy_tokens = NULL;
  1009.   directory_token_t *tok;
  1010.   struct in_addr in;
  1011.   const char *start_of_annotations, *cp;
  1012.   size_t prepend_len = prepend_annotations ? strlen(prepend_annotations) : 0;
  1013.   int ok = 1;
  1014.   memarea_t *area = NULL;
  1015.   tor_assert(!allow_annotations || !prepend_annotations);
  1016.   if (!end) {
  1017.     end = s + strlen(s);
  1018.   }
  1019.   /* point 'end' to a point immediately after the final newline. */
  1020.   while (end > s+2 && *(end-1) == 'n' && *(end-2) == 'n')
  1021.     --end;
  1022.   area = memarea_new();
  1023.   tokens = smartlist_create();
  1024.   if (prepend_annotations) {
  1025.     if (tokenize_string(area,prepend_annotations,NULL,tokens,
  1026.                         routerdesc_token_table,TS_NOCHECK)) {
  1027.       log_warn(LD_DIR, "Error tokenizing router descriptor (annotations).");
  1028.       goto err;
  1029.     }
  1030.   }
  1031.   start_of_annotations = s;
  1032.   cp = tor_memstr(s, end-s, "nrouter ");
  1033.   if (!cp) {
  1034.     if (end-s < 7 || strcmpstart(s, "router ")) {
  1035.       log_warn(LD_DIR, "No router keyword found.");
  1036.       goto err;
  1037.     }
  1038.   } else {
  1039.     s = cp+1;
  1040.   }
  1041.   if (allow_annotations && start_of_annotations != s) {
  1042.     if (tokenize_string(area,start_of_annotations,s,tokens,
  1043.                         routerdesc_token_table,TS_NOCHECK)) {
  1044.       log_warn(LD_DIR, "Error tokenizing router descriptor (annotations).");
  1045.       goto err;
  1046.     }
  1047.   }
  1048.   if (router_get_router_hash(s, digest) < 0) {
  1049.     log_warn(LD_DIR, "Couldn't compute router hash.");
  1050.     goto err;
  1051.   }
  1052.   {
  1053.     int flags = 0;
  1054.     if (allow_annotations)
  1055.       flags |= TS_ANNOTATIONS_OK;
  1056.     if (prepend_annotations)
  1057.       flags |= TS_ANNOTATIONS_OK|TS_NO_NEW_ANNOTATIONS;
  1058.     if (tokenize_string(area,s,end,tokens,routerdesc_token_table, flags)) {
  1059.       log_warn(LD_DIR, "Error tokenizing router descriptor.");
  1060.       goto err;
  1061.     }
  1062.   }
  1063.   if (smartlist_len(tokens) < 2) {
  1064.     log_warn(LD_DIR, "Impossibly short router descriptor.");
  1065.     goto err;
  1066.   }
  1067.   tok = find_by_keyword(tokens, K_ROUTER);
  1068.   tor_assert(tok->n_args >= 5);
  1069.   router = tor_malloc_zero(sizeof(routerinfo_t));
  1070.   router->country = -1;
  1071.   router->cache_info.routerlist_index = -1;
  1072.   router->cache_info.annotations_len = s-start_of_annotations + prepend_len;
  1073.   router->cache_info.signed_descriptor_len = end-s;
  1074.   if (cache_copy) {
  1075.     size_t len = router->cache_info.signed_descriptor_len +
  1076.                  router->cache_info.annotations_len;
  1077.     char *cp =
  1078.       router->cache_info.signed_descriptor_body = tor_malloc(len+1);
  1079.     if (prepend_annotations) {
  1080.       memcpy(cp, prepend_annotations, prepend_len);
  1081.       cp += prepend_len;
  1082.     }
  1083.     /* This assertion will always succeed.
  1084.      * len == signed_desc_len + annotations_len
  1085.      *     == end-s + s-start_of_annotations + prepend_len
  1086.      *     == end-start_of_annotations + prepend_len
  1087.      * We already wrote prepend_len bytes into the buffer; now we're
  1088.      * writing end-start_of_annotations -NM. */
  1089.     tor_assert(cp+(end-start_of_annotations) ==
  1090.                router->cache_info.signed_descriptor_body+len);
  1091.     memcpy(cp, start_of_annotations, end-start_of_annotations);
  1092.     router->cache_info.signed_descriptor_body[len] = '';
  1093.     tor_assert(strlen(router->cache_info.signed_descriptor_body) == len);
  1094.   }
  1095.   memcpy(router->cache_info.signed_descriptor_digest, digest, DIGEST_LEN);
  1096.   router->nickname = tor_strdup(tok->args[0]);
  1097.   if (!is_legal_nickname(router->nickname)) {
  1098.     log_warn(LD_DIR,"Router nickname is invalid");
  1099.     goto err;
  1100.   }
  1101.   router->address = tor_strdup(tok->args[1]);
  1102.   if (!tor_inet_aton(router->address, &in)) {
  1103.     log_warn(LD_DIR,"Router address is not an IP address.");
  1104.     goto err;
  1105.   }
  1106.   router->addr = ntohl(in.s_addr);
  1107.   router->or_port =
  1108.     (uint16_t) tor_parse_long(tok->args[2],10,0,65535,&ok,NULL);
  1109.   if (!ok) {
  1110.     log_warn(LD_DIR,"Invalid OR port %s", escaped(tok->args[2]));
  1111.     goto err;
  1112.   }
  1113.   router->dir_port =
  1114.     (uint16_t) tor_parse_long(tok->args[4],10,0,65535,&ok,NULL);
  1115.   if (!ok) {
  1116.     log_warn(LD_DIR,"Invalid dir port %s", escaped(tok->args[4]));
  1117.     goto err;
  1118.   }
  1119.   tok = find_by_keyword(tokens, K_BANDWIDTH);
  1120.   tor_assert(tok->n_args >= 3);
  1121.   router->bandwidthrate = (int)
  1122.     tor_parse_long(tok->args[0],10,1,INT_MAX,&ok,NULL);
  1123.   if (!ok) {
  1124.     log_warn(LD_DIR, "bandwidthrate %s unreadable or 0. Failing.",
  1125.              escaped(tok->args[0]));
  1126.     goto err;
  1127.   }
  1128.   router->bandwidthburst =
  1129.     (int) tor_parse_long(tok->args[1],10,0,INT_MAX,&ok,NULL);
  1130.   if (!ok) {
  1131.     log_warn(LD_DIR, "Invalid bandwidthburst %s", escaped(tok->args[1]));
  1132.     goto err;
  1133.   }
  1134.   router->bandwidthcapacity = (int)
  1135.     tor_parse_long(tok->args[2],10,0,INT_MAX,&ok,NULL);
  1136.   if (!ok) {
  1137.     log_warn(LD_DIR, "Invalid bandwidthcapacity %s", escaped(tok->args[1]));
  1138.     goto err;
  1139.   }
  1140.   if ((tok = find_opt_by_keyword(tokens, A_PURPOSE))) {
  1141.     tor_assert(tok->n_args);
  1142.     router->purpose = router_purpose_from_string(tok->args[0]);
  1143.   } else {
  1144.     router->purpose = ROUTER_PURPOSE_GENERAL;
  1145.   }
  1146.   router->cache_info.send_unencrypted =
  1147.     (router->purpose == ROUTER_PURPOSE_GENERAL) ? 1 : 0;
  1148.   if ((tok = find_opt_by_keyword(tokens, K_UPTIME))) {
  1149.     tor_assert(tok->n_args >= 1);
  1150.     router->uptime = tor_parse_long(tok->args[0],10,0,LONG_MAX,&ok,NULL);
  1151.     if (!ok) {
  1152.       log_warn(LD_DIR, "Invalid uptime %s", escaped(tok->args[0]));
  1153.       goto err;
  1154.     }
  1155.   }
  1156.   if ((tok = find_opt_by_keyword(tokens, K_HIBERNATING))) {
  1157.     tor_assert(tok->n_args >= 1);
  1158.     router->is_hibernating
  1159.       = (tor_parse_long(tok->args[0],10,0,LONG_MAX,NULL,NULL) != 0);
  1160.   }
  1161.   tok = find_by_keyword(tokens, K_PUBLISHED);
  1162.   tor_assert(tok->n_args == 1);
  1163.   if (parse_iso_time(tok->args[0], &router->cache_info.published_on) < 0)
  1164.     goto err;
  1165.   tok = find_by_keyword(tokens, K_ONION_KEY);
  1166.   router->onion_pkey = tok->key;
  1167.   tok->key = NULL; /* Prevent free */
  1168.   tok = find_by_keyword(tokens, K_SIGNING_KEY);
  1169.   router->identity_pkey = tok->key;
  1170.   tok->key = NULL; /* Prevent free */
  1171.   if (crypto_pk_get_digest(router->identity_pkey,
  1172.                            router->cache_info.identity_digest)) {
  1173.     log_warn(LD_DIR, "Couldn't calculate key digest"); goto err;
  1174.   }
  1175.   if ((tok = find_opt_by_keyword(tokens, K_FINGERPRINT))) {
  1176.     /* If there's a fingerprint line, it must match the identity digest. */
  1177.     char d[DIGEST_LEN];
  1178.     tor_assert(tok->n_args == 1);
  1179.     tor_strstrip(tok->args[0], " ");
  1180.     if (base16_decode(d, DIGEST_LEN, tok->args[0], strlen(tok->args[0]))) {
  1181.       log_warn(LD_DIR, "Couldn't decode router fingerprint %s",
  1182.                escaped(tok->args[0]));
  1183.       goto err;
  1184.     }
  1185.     if (memcmp(d,router->cache_info.identity_digest, DIGEST_LEN)!=0) {
  1186.       log_warn(LD_DIR, "Fingerprint '%s' does not match identity digest.",
  1187.                tok->args[0]);
  1188.       goto err;
  1189.     }
  1190.   }
  1191.   if ((tok = find_opt_by_keyword(tokens, K_PLATFORM))) {
  1192.     router->platform = tor_strdup(tok->args[0]);
  1193.   }
  1194.   if ((tok = find_opt_by_keyword(tokens, K_CONTACT))) {
  1195.     router->contact_info = tor_strdup(tok->args[0]);
  1196.   }
  1197.   if ((tok = find_opt_by_keyword(tokens, K_EVENTDNS))) {
  1198.     router->has_old_dnsworkers = tok->n_args && !strcmp(tok->args[0], "0");
  1199.   } else if (router->platform) {
  1200.     if (! tor_version_as_new_as(router->platform, "0.1.2.2-alpha"))
  1201.       router->has_old_dnsworkers = 1;
  1202.   }
  1203.   exit_policy_tokens = find_all_exitpolicy(tokens);
  1204.   if (!smartlist_len(exit_policy_tokens)) {
  1205.     log_warn(LD_DIR, "No exit policy tokens in descriptor.");
  1206.     goto err;
  1207.   }
  1208.   SMARTLIST_FOREACH(exit_policy_tokens, directory_token_t *, t,
  1209.                     if (router_add_exit_policy(router,t)<0) {
  1210.                       log_warn(LD_DIR,"Error in exit policy");
  1211.                       goto err;
  1212.                     });
  1213.   policy_expand_private(&router->exit_policy);
  1214.   if (policy_is_reject_star(router->exit_policy))
  1215.     router->policy_is_reject_star = 1;
  1216.   if ((tok = find_opt_by_keyword(tokens, K_FAMILY)) && tok->n_args) {
  1217.     int i;
  1218.     router->declared_family = smartlist_create();
  1219.     for (i=0;i<tok->n_args;++i) {
  1220.       if (!is_legal_nickname_or_hexdigest(tok->args[i])) {
  1221.         log_warn(LD_DIR, "Illegal nickname %s in family line",
  1222.                  escaped(tok->args[i]));
  1223.         goto err;
  1224.       }
  1225.       smartlist_add(router->declared_family, tor_strdup(tok->args[i]));
  1226.     }
  1227.   }
  1228.   if ((tok = find_opt_by_keyword(tokens, K_CACHES_EXTRA_INFO)))
  1229.     router->caches_extra_info = 1;
  1230.   if ((tok = find_opt_by_keyword(tokens, K_ALLOW_SINGLE_HOP_EXITS)))
  1231.     router->allow_single_hop_exits = 1;
  1232.   if ((tok = find_opt_by_keyword(tokens, K_EXTRA_INFO_DIGEST))) {
  1233.     tor_assert(tok->n_args >= 1);
  1234.     if (strlen(tok->args[0]) == HEX_DIGEST_LEN) {
  1235.       base16_decode(router->cache_info.extra_info_digest,
  1236.                     DIGEST_LEN, tok->args[0], HEX_DIGEST_LEN);
  1237.     } else {
  1238.       log_warn(LD_DIR, "Invalid extra info digest %s", escaped(tok->args[0]));
  1239.     }
  1240.   }
  1241.   if ((tok = find_opt_by_keyword(tokens, K_HIDDEN_SERVICE_DIR))) {
  1242.     router->wants_to_be_hs_dir = 1;
  1243.   }
  1244.   tok = find_by_keyword(tokens, K_ROUTER_SIGNATURE);
  1245.   note_crypto_pk_op(VERIFY_RTR);
  1246. #ifdef COUNT_DISTINCT_DIGESTS
  1247.   if (!verified_digests)
  1248.     verified_digests = digestmap_new();
  1249.   digestmap_set(verified_digests, signed_digest, (void*)(uintptr_t)1);
  1250. #endif
  1251.   if (check_signature_token(digest, tok, router->identity_pkey, 0,
  1252.                             "router descriptor") < 0)
  1253.     goto err;
  1254.   routerinfo_set_country(router);
  1255.   if (!router->or_port) {
  1256.     log_warn(LD_DIR,"or_port unreadable or 0. Failing.");
  1257.     goto err;
  1258.   }
  1259.   if (!router->platform) {
  1260.     router->platform = tor_strdup("<unknown>");
  1261.   }
  1262.   goto done;
  1263.  err:
  1264.   routerinfo_free(router);
  1265.   router = NULL;
  1266.  done:
  1267.   if (tokens) {
  1268.     SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  1269.     smartlist_free(tokens);
  1270.   }
  1271.   if (exit_policy_tokens) {
  1272.     smartlist_free(exit_policy_tokens);
  1273.   }
  1274.   if (area) {
  1275.     DUMP_AREA(area, "routerinfo");
  1276.     memarea_drop_all(area);
  1277.   }
  1278.   return router;
  1279. }
  1280. /** Parse a single extrainfo entry from the string <b>s</b>, ending at
  1281.  * <b>end</b>.  (If <b>end</b> is NULL, parse up to the end of <b>s</b>.)  If
  1282.  * <b>cache_copy</b> is true, make a copy of the extra-info document in the
  1283.  * cache_info fields of the result.  If <b>routermap</b> is provided, use it
  1284.  * as a map from router identity to routerinfo_t when looking up signing keys.
  1285.  */
  1286. extrainfo_t *
  1287. extrainfo_parse_entry_from_string(const char *s, const char *end,
  1288.                            int cache_copy, struct digest_ri_map_t *routermap)
  1289. {
  1290.   extrainfo_t *extrainfo = NULL;
  1291.   char digest[128];
  1292.   smartlist_t *tokens = NULL;
  1293.   directory_token_t *tok;
  1294.   crypto_pk_env_t *key = NULL;
  1295.   routerinfo_t *router = NULL;
  1296.   memarea_t *area = NULL;
  1297.   if (!end) {
  1298.     end = s + strlen(s);
  1299.   }
  1300.   /* point 'end' to a point immediately after the final newline. */
  1301.   while (end > s+2 && *(end-1) == 'n' && *(end-2) == 'n')
  1302.     --end;
  1303.   if (router_get_extrainfo_hash(s, digest) < 0) {
  1304.     log_warn(LD_DIR, "Couldn't compute router hash.");
  1305.     goto err;
  1306.   }
  1307.   tokens = smartlist_create();
  1308.   area = memarea_new();
  1309.   if (tokenize_string(area,s,end,tokens,extrainfo_token_table,0)) {
  1310.     log_warn(LD_DIR, "Error tokenizing extra-info document.");
  1311.     goto err;
  1312.   }
  1313.   if (smartlist_len(tokens) < 2) {
  1314.     log_warn(LD_DIR, "Impossibly short extra-info document.");
  1315.     goto err;
  1316.   }
  1317.   tok = smartlist_get(tokens,0);
  1318.   if (tok->tp != K_EXTRA_INFO) {
  1319.     log_warn(LD_DIR,"Entry does not start with "extra-info"");
  1320.     goto err;
  1321.   }
  1322.   extrainfo = tor_malloc_zero(sizeof(extrainfo_t));
  1323.   extrainfo->cache_info.is_extrainfo = 1;
  1324.   if (cache_copy)
  1325.     extrainfo->cache_info.signed_descriptor_body = tor_strndup(s, end-s);
  1326.   extrainfo->cache_info.signed_descriptor_len = end-s;
  1327.   memcpy(extrainfo->cache_info.signed_descriptor_digest, digest, DIGEST_LEN);
  1328.   tor_assert(tok->n_args >= 2);
  1329.   if (!is_legal_nickname(tok->args[0])) {
  1330.     log_warn(LD_DIR,"Bad nickname %s on "extra-info"",escaped(tok->args[0]));
  1331.     goto err;
  1332.   }
  1333.   strlcpy(extrainfo->nickname, tok->args[0], sizeof(extrainfo->nickname));
  1334.   if (strlen(tok->args[1]) != HEX_DIGEST_LEN ||
  1335.       base16_decode(extrainfo->cache_info.identity_digest, DIGEST_LEN,
  1336.                     tok->args[1], HEX_DIGEST_LEN)) {
  1337.     log_warn(LD_DIR,"Invalid fingerprint %s on "extra-info"",
  1338.              escaped(tok->args[1]));
  1339.     goto err;
  1340.   }
  1341.   tok = find_by_keyword(tokens, K_PUBLISHED);
  1342.   if (parse_iso_time(tok->args[0], &extrainfo->cache_info.published_on)) {
  1343.     log_warn(LD_DIR,"Invalid published time %s on "extra-info"",
  1344.              escaped(tok->args[0]));
  1345.     goto err;
  1346.   }
  1347.   if (routermap &&
  1348.       (router = digestmap_get((digestmap_t*)routermap,
  1349.                               extrainfo->cache_info.identity_digest))) {
  1350.     key = router->identity_pkey;
  1351.   }
  1352.   tok = find_by_keyword(tokens, K_ROUTER_SIGNATURE);
  1353.   if (strcmp(tok->object_type, "SIGNATURE") ||
  1354.       tok->object_size < 128 || tok->object_size > 512) {
  1355.     log_warn(LD_DIR, "Bad object type or length on extra-info signature");
  1356.     goto err;
  1357.   }
  1358.   if (key) {
  1359.     note_crypto_pk_op(VERIFY_RTR);
  1360.     if (check_signature_token(digest, tok, key, 0, "extra-info") < 0)
  1361.       goto err;
  1362.     if (router)
  1363.       extrainfo->cache_info.send_unencrypted =
  1364.         router->cache_info.send_unencrypted;
  1365.   } else {
  1366.     extrainfo->pending_sig = tor_memdup(tok->object_body,
  1367.                                         tok->object_size);
  1368.     extrainfo->pending_sig_len = tok->object_size;
  1369.   }
  1370.   goto done;
  1371.  err:
  1372.   if (extrainfo)
  1373.     extrainfo_free(extrainfo);
  1374.   extrainfo = NULL;
  1375.  done:
  1376.   if (tokens) {
  1377.     SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  1378.     smartlist_free(tokens);
  1379.   }
  1380.   if (area) {
  1381.     DUMP_AREA(area, "extrainfo");
  1382.     memarea_drop_all(area);
  1383.   }
  1384.   return extrainfo;
  1385. }
  1386. /** Parse a key certificate from <b>s</b>; point <b>end-of-string</b> to
  1387.  * the first character after the certificate. */
  1388. authority_cert_t *
  1389. authority_cert_parse_from_string(const char *s, const char **end_of_string)
  1390. {
  1391.   authority_cert_t *cert = NULL, *old_cert;
  1392.   smartlist_t *tokens = NULL;
  1393.   char digest[DIGEST_LEN];
  1394.   directory_token_t *tok;
  1395.   char fp_declared[DIGEST_LEN];
  1396.   char *eos;
  1397.   size_t len;
  1398.   int found;
  1399.   memarea_t *area = NULL;
  1400.   s = eat_whitespace(s);
  1401.   eos = strstr(s, "ndir-key-certification");
  1402.   if (! eos) {
  1403.     log_warn(LD_DIR, "No signature found on key certificate");
  1404.     return NULL;
  1405.   }
  1406.   eos = strstr(eos, "n-----END SIGNATURE-----n");
  1407.   if (! eos) {
  1408.     log_warn(LD_DIR, "No end-of-signature found on key certificate");
  1409.     return NULL;
  1410.   }
  1411.   eos = strchr(eos+2, 'n');
  1412.   tor_assert(eos);
  1413.   ++eos;
  1414.   len = eos - s;
  1415.   tokens = smartlist_create();
  1416.   area = memarea_new();
  1417.   if (tokenize_string(area,s, eos, tokens, dir_key_certificate_table, 0) < 0) {
  1418.     log_warn(LD_DIR, "Error tokenizing key certificate");
  1419.     goto err;
  1420.   }
  1421.   if (router_get_hash_impl(s, digest, "dir-key-certificate-version",
  1422.                            "ndir-key-certification", 'n') < 0)
  1423.     goto err;
  1424.   tok = smartlist_get(tokens, 0);
  1425.   if (tok->tp != K_DIR_KEY_CERTIFICATE_VERSION || strcmp(tok->args[0], "3")) {
  1426.     log_warn(LD_DIR,
  1427.              "Key certificate does not begin with a recognized version (3).");
  1428.     goto err;
  1429.   }
  1430.   cert = tor_malloc_zero(sizeof(authority_cert_t));
  1431.   memcpy(cert->cache_info.signed_descriptor_digest, digest, DIGEST_LEN);
  1432.   tok = find_by_keyword(tokens, K_DIR_SIGNING_KEY);
  1433.   tor_assert(tok->key);
  1434.   cert->signing_key = tok->key;
  1435.   tok->key = NULL;
  1436.   if (crypto_pk_get_digest(cert->signing_key, cert->signing_key_digest))
  1437.     goto err;
  1438.   tok = find_by_keyword(tokens, K_DIR_IDENTITY_KEY);
  1439.   tor_assert(tok->key);
  1440.   cert->identity_key = tok->key;
  1441.   tok->key = NULL;
  1442.   tok = find_by_keyword(tokens, K_FINGERPRINT);
  1443.   tor_assert(tok->n_args);
  1444.   if (base16_decode(fp_declared, DIGEST_LEN, tok->args[0],
  1445.                     strlen(tok->args[0]))) {
  1446.     log_warn(LD_DIR, "Couldn't decode key certificate fingerprint %s",
  1447.              escaped(tok->args[0]));
  1448.     goto err;
  1449.   }
  1450.   if (crypto_pk_get_digest(cert->identity_key,
  1451.                            cert->cache_info.identity_digest))
  1452.     goto err;
  1453.   if (memcmp(cert->cache_info.identity_digest, fp_declared, DIGEST_LEN)) {
  1454.     log_warn(LD_DIR, "Digest of certificate key didn't match declared "
  1455.              "fingerprint");
  1456.     goto err;
  1457.   }
  1458.   tok = find_opt_by_keyword(tokens, K_DIR_ADDRESS);
  1459.   if (tok) {
  1460.     struct in_addr in;
  1461.     char *address = NULL;
  1462.     tor_assert(tok->n_args);
  1463.     /* XXX021 use tor_addr_port_parse() below instead. -RD */
  1464.     if (parse_addr_port(LOG_WARN, tok->args[0], &address, NULL,
  1465.                         &cert->dir_port)<0 ||
  1466.         tor_inet_aton(address, &in) == 0) {
  1467.       log_warn(LD_DIR, "Couldn't parse dir-address in certificate");
  1468.       tor_free(address);
  1469.       goto err;
  1470.     }
  1471.     cert->addr = ntohl(in.s_addr);
  1472.     tor_free(address);
  1473.   }
  1474.   tok = find_by_keyword(tokens, K_DIR_KEY_PUBLISHED);
  1475.   if (parse_iso_time(tok->args[0], &cert->cache_info.published_on) < 0) {
  1476.      goto err;
  1477.   }
  1478.   tok = find_by_keyword(tokens, K_DIR_KEY_EXPIRES);
  1479.   if (parse_iso_time(tok->args[0], &cert->expires) < 0) {
  1480.      goto err;
  1481.   }
  1482.   tok = smartlist_get(tokens, smartlist_len(tokens)-1);
  1483.   if (tok->tp != K_DIR_KEY_CERTIFICATION) {
  1484.     log_warn(LD_DIR, "Certificate didn't end with dir-key-certification.");
  1485.     goto err;
  1486.   }
  1487.   /* If we already have this cert, don't bother checking the signature. */
  1488.   old_cert = authority_cert_get_by_digests(
  1489.                                      cert->cache_info.identity_digest,
  1490.                                      cert->signing_key_digest);
  1491.   found = 0;
  1492.   if (old_cert) {
  1493.     /* XXXX We could just compare signed_descriptor_digest, but that wouldn't
  1494.      * buy us much. */
  1495.     if (old_cert->cache_info.signed_descriptor_len == len &&
  1496.         old_cert->cache_info.signed_descriptor_body &&
  1497.         !memcmp(s, old_cert->cache_info.signed_descriptor_body, len)) {
  1498.       log_debug(LD_DIR, "We already checked the signature on this "
  1499.                 "certificate; no need to do so again.");
  1500.       found = 1;
  1501.       cert->is_cross_certified = old_cert->is_cross_certified;
  1502.     }
  1503.   }
  1504.   if (!found) {
  1505.     if (check_signature_token(digest, tok, cert->identity_key, 0,
  1506.                               "key certificate")) {
  1507.       goto err;
  1508.     }
  1509.     if ((tok = find_opt_by_keyword(tokens, K_DIR_KEY_CROSSCERT))) {
  1510.       /* XXXX Once all authorities generate cross-certified certificates,
  1511.        * make this field mandatory. */
  1512.       if (check_signature_token(cert->cache_info.identity_digest,
  1513.                                 tok,
  1514.                                 cert->signing_key,
  1515.                                 CST_NO_CHECK_OBJTYPE,
  1516.                                 "key cross-certification")) {
  1517.         goto err;
  1518.       }
  1519.       cert->is_cross_certified = 1;
  1520.     }
  1521.   }
  1522.   cert->cache_info.signed_descriptor_len = len;
  1523.   cert->cache_info.signed_descriptor_body = tor_malloc(len+1);
  1524.   memcpy(cert->cache_info.signed_descriptor_body, s, len);
  1525.   cert->cache_info.signed_descriptor_body[len] = 0;
  1526.   cert->cache_info.saved_location = SAVED_NOWHERE;
  1527.   if (end_of_string) {
  1528.     *end_of_string = eat_whitespace(eos);
  1529.   }
  1530.   SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  1531.   smartlist_free(tokens);
  1532.   if (area) {
  1533.     DUMP_AREA(area, "authority cert");
  1534.     memarea_drop_all(area);
  1535.   }
  1536.   return cert;
  1537.  err:
  1538.   authority_cert_free(cert);
  1539.   SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  1540.   smartlist_free(tokens);
  1541.   if (area) {
  1542.     DUMP_AREA(area, "authority cert");
  1543.     memarea_drop_all(area);
  1544.   }
  1545.   return NULL;
  1546. }
  1547. /** Helper: given a string <b>s</b>, return the start of the next router-status
  1548.  * object (starting with "r " at the start of a line).  If none is found,
  1549.  * return the start of the next directory signature.  If none is found, return
  1550.  * the end of the string. */
  1551. static INLINE const char *
  1552. find_start_of_next_routerstatus(const char *s)
  1553. {
  1554.   const char *eos = strstr(s, "nr ");
  1555.   if (eos) {
  1556.     const char *eos2 = tor_memstr(s, eos-s, "ndirectory-signature");
  1557.     if (eos2 && eos2 < eos)
  1558.       return eos2;
  1559.     else
  1560.       return eos+1;
  1561.   } else {
  1562.     if ((eos = strstr(s, "ndirectory-signature")))
  1563.       return eos+1;
  1564.     return s + strlen(s);
  1565.   }
  1566. }
  1567. /** Given a string at *<b>s</b>, containing a routerstatus object, and an
  1568.  * empty smartlist at <b>tokens</b>, parse and return the first router status
  1569.  * object in the string, and advance *<b>s</b> to just after the end of the
  1570.  * router status.  Return NULL and advance *<b>s</b> on error.
  1571.  *
  1572.  * If <b>vote</b> and <b>vote_rs</b> are provided, don't allocate a fresh
  1573.  * routerstatus but use <b>vote_rs</b> instead.
  1574.  *
  1575.  * If <b>consensus_method</b> is nonzero, this routerstatus is part of a
  1576.  * consensus, and we should parse it according to the method used to
  1577.  * make that consensus.
  1578.  **/
  1579. static routerstatus_t *
  1580. routerstatus_parse_entry_from_string(memarea_t *area,
  1581.                                      const char **s, smartlist_t *tokens,
  1582.                                      networkstatus_t *vote,
  1583.                                      vote_routerstatus_t *vote_rs,
  1584.                                      int consensus_method)
  1585. {
  1586.   const char *eos;
  1587.   routerstatus_t *rs = NULL;
  1588.   directory_token_t *tok;
  1589.   char timebuf[ISO_TIME_LEN+1];
  1590.   struct in_addr in;
  1591.   tor_assert(tokens);
  1592.   tor_assert(bool_eq(vote, vote_rs));
  1593.   eos = find_start_of_next_routerstatus(*s);
  1594.   if (tokenize_string(area,*s, eos, tokens, rtrstatus_token_table,0)) {
  1595.     log_warn(LD_DIR, "Error tokenizing router status");
  1596.     goto err;
  1597.   }
  1598.   if (smartlist_len(tokens) < 1) {
  1599.     log_warn(LD_DIR, "Impossibly short router status");
  1600.     goto err;
  1601.   }
  1602.   tok = find_by_keyword(tokens, K_R);
  1603.   tor_assert(tok->n_args >= 8);
  1604.   if (vote_rs) {
  1605.     rs = &vote_rs->status;
  1606.   } else {
  1607.     rs = tor_malloc_zero(sizeof(routerstatus_t));
  1608.   }
  1609.   if (!is_legal_nickname(tok->args[0])) {
  1610.     log_warn(LD_DIR,
  1611.              "Invalid nickname %s in router status; skipping.",
  1612.              escaped(tok->args[0]));
  1613.     goto err;
  1614.   }
  1615.   strlcpy(rs->nickname, tok->args[0], sizeof(rs->nickname));
  1616.   if (digest_from_base64(rs->identity_digest, tok->args[1])) {
  1617.     log_warn(LD_DIR, "Error decoding identity digest %s",
  1618.              escaped(tok->args[1]));
  1619.     goto err;
  1620.   }
  1621.   if (digest_from_base64(rs->descriptor_digest, tok->args[2])) {
  1622.     log_warn(LD_DIR, "Error decoding descriptor digest %s",
  1623.              escaped(tok->args[2]));
  1624.     goto err;
  1625.   }
  1626.   if (tor_snprintf(timebuf, sizeof(timebuf), "%s %s",
  1627.                    tok->args[3], tok->args[4]) < 0 ||
  1628.       parse_iso_time(timebuf, &rs->published_on)<0) {
  1629.     log_warn(LD_DIR, "Error parsing time '%s %s'",
  1630.              tok->args[3], tok->args[4]);
  1631.     goto err;
  1632.   }
  1633.   if (tor_inet_aton(tok->args[5], &in) == 0) {
  1634.     log_warn(LD_DIR, "Error parsing router address in network-status %s",
  1635.              escaped(tok->args[5]));
  1636.     goto err;
  1637.   }
  1638.   rs->addr = ntohl(in.s_addr);
  1639.   rs->or_port =(uint16_t) tor_parse_long(tok->args[6],10,0,65535,NULL,NULL);
  1640.   rs->dir_port = (uint16_t) tor_parse_long(tok->args[7],10,0,65535,NULL,NULL);
  1641.   tok = find_opt_by_keyword(tokens, K_S);
  1642.   if (tok && vote) {
  1643.     int i;
  1644.     vote_rs->flags = 0;
  1645.     for (i=0; i < tok->n_args; ++i) {
  1646.       int p = smartlist_string_pos(vote->known_flags, tok->args[i]);
  1647.       if (p >= 0) {
  1648.         vote_rs->flags |= (1<<p);
  1649.       } else {
  1650.         log_warn(LD_DIR, "Flags line had a flag %s not listed in known_flags.",
  1651.                  escaped(tok->args[i]));
  1652.         goto err;
  1653.       }
  1654.     }
  1655.   } else if (tok) {
  1656.     int i;
  1657.     for (i=0; i < tok->n_args; ++i) {
  1658.       if (!strcmp(tok->args[i], "Exit"))
  1659.         rs->is_exit = 1;
  1660.       else if (!strcmp(tok->args[i], "Stable"))
  1661.         rs->is_stable = 1;
  1662.       else if (!strcmp(tok->args[i], "Fast"))
  1663.         rs->is_fast = 1;
  1664.       else if (!strcmp(tok->args[i], "Running"))
  1665.         rs->is_running = 1;
  1666.       else if (!strcmp(tok->args[i], "Named"))
  1667.         rs->is_named = 1;
  1668.       else if (!strcmp(tok->args[i], "Valid"))
  1669.         rs->is_valid = 1;
  1670.       else if (!strcmp(tok->args[i], "V2Dir"))
  1671.         rs->is_v2_dir = 1;
  1672.       else if (!strcmp(tok->args[i], "Guard"))
  1673.         rs->is_possible_guard = 1;
  1674.       else if (!strcmp(tok->args[i], "BadExit"))
  1675.         rs->is_bad_exit = 1;
  1676.       else if (!strcmp(tok->args[i], "BadDirectory"))
  1677.         rs->is_bad_directory = 1;
  1678.       else if (!strcmp(tok->args[i], "Authority"))
  1679.         rs->is_authority = 1;
  1680.       else if (!strcmp(tok->args[i], "Unnamed") &&
  1681.                consensus_method >= 2) {
  1682.         /* Unnamed is computed right by consensus method 2 and later. */
  1683.         rs->is_unnamed = 1;
  1684.       } else if (!strcmp(tok->args[i], "HSDir")) {
  1685.         rs->is_hs_dir = 1;
  1686.       }
  1687.     }
  1688.   }
  1689.   if ((tok = find_opt_by_keyword(tokens, K_V))) {
  1690.     tor_assert(tok->n_args == 1);
  1691.     rs->version_known = 1;
  1692.     if (strcmpstart(tok->args[0], "Tor ")) {
  1693.       rs->version_supports_begindir = 1;
  1694.       rs->version_supports_extrainfo_upload = 1;
  1695.       rs->version_supports_conditional_consensus = 1;
  1696.     } else {
  1697.       rs->version_supports_begindir =
  1698.         tor_version_as_new_as(tok->args[0], "0.2.0.1-alpha");
  1699.       rs->version_supports_extrainfo_upload =
  1700.         tor_version_as_new_as(tok->args[0], "0.2.0.0-alpha-dev (r10070)");
  1701.       rs->version_supports_v3_dir =
  1702.         tor_version_as_new_as(tok->args[0], "0.2.0.8-alpha");
  1703.       rs->version_supports_conditional_consensus =
  1704.         tor_version_as_new_as(tok->args[0], "0.2.1.1-alpha");
  1705.     }
  1706.     if (vote_rs) {
  1707.       vote_rs->version = tor_strdup(tok->args[0]);
  1708.     }
  1709.   }
  1710.   /* handle weighting/bandwidth info */
  1711.   if ((tok = find_opt_by_keyword(tokens, K_W))) {
  1712.     int i;
  1713.     for (i=0; i < tok->n_args; ++i) {
  1714.       if (!strcmpstart(tok->args[i], "Bandwidth=")) {
  1715.         int ok;
  1716.         rs->bandwidth = (uint32_t)tor_parse_ulong(strchr(tok->args[i], '=')+1,
  1717.                                                   10, 0, UINT32_MAX,
  1718.                                                   &ok, NULL);
  1719.         if (!ok) {
  1720.           log_warn(LD_DIR, "Invalid Bandwidth %s", escaped(tok->args[i]));
  1721.           goto err;
  1722.         }
  1723.         rs->has_bandwidth = 1;
  1724.       }
  1725.     }
  1726.   }
  1727.   /* parse exit policy summaries */
  1728.   if ((tok = find_opt_by_keyword(tokens, K_P))) {
  1729.     tor_assert(tok->n_args == 1);
  1730.     if (strcmpstart(tok->args[0], "accept ") &&
  1731.         strcmpstart(tok->args[0], "reject ")) {
  1732.       log_warn(LD_DIR, "Unknown exit policy summary type %s.",
  1733.                escaped(tok->args[0]));
  1734.       goto err;
  1735.     }
  1736.     /* XXX weasel: parse this into ports and represent them somehow smart,
  1737.      * maybe not here but somewhere on if we need it for the client.
  1738.      * we should still parse it here to check it's valid tho.
  1739.      */
  1740.     rs->exitsummary = tor_strdup(tok->args[0]);
  1741.     rs->has_exitsummary = 1;
  1742.   }
  1743.   if (!strcasecmp(rs->nickname, UNNAMED_ROUTER_NICKNAME))
  1744.     rs->is_named = 0;
  1745.   goto done;
  1746.  err:
  1747.   if (rs && !vote_rs)
  1748.     routerstatus_free(rs);
  1749.   rs = NULL;
  1750.  done:
  1751.   SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
  1752.   smartlist_clear(tokens);
  1753.   if (area) {
  1754.     DUMP_AREA(area, "routerstatus entry");
  1755.     memarea_clear(area);
  1756.   }
  1757.   *s = eos;
  1758.   return rs;
  1759. }
  1760. /** Helper to sort a smartlist of pointers to routerstatus_t */
  1761. static int
  1762. _compare_routerstatus_entries(const void **_a, const void **_b)
  1763. {
  1764.   const routerstatus_t *a = *_a, *b = *_b;
  1765.   return memcmp(a->identity_digest, b->identity_digest, DIGEST_LEN);
  1766. }
  1767. /** Helper: used in call to _smartlist_uniq to clear out duplicate entries. */
  1768. static void
  1769. _free_duplicate_routerstatus_entry(void *e)
  1770. {
  1771.   log_warn(LD_DIR,
  1772.            "Network-status has two entries for the same router. "
  1773.            "Dropping one.");
  1774.   routerstatus_free(e);
  1775. }
  1776. /** Given a v2 network-status object in <b>s</b>, try to
  1777.  * parse it and return the result.  Return NULL on failure.  Check the
  1778.  * signature of the network status, but do not (yet) check the signing key for
  1779.  * authority.
  1780.  */
  1781. networkstatus_v2_t *
  1782. networkstatus_v2_parse_from_string(const char *s)
  1783. {
  1784.   const char *eos;
  1785.   smartlist_t *tokens = smartlist_create();
  1786.   smartlist_t *footer_tokens = smartlist_create();
  1787.   networkstatus_v2_t *ns = NULL;
  1788.   char ns_digest[DIGEST_LEN];
  1789.   char tmp_digest[DIGEST_LEN];
  1790.   struct in_addr in;
  1791.   directory_token_t *tok;
  1792.   int i;
  1793.   memarea_t *area = NULL;
  1794.   if (router_get_networkstatus_v2_hash(s, ns_digest)) {
  1795.     log_warn(LD_DIR, "Unable to compute digest of network-status");
  1796.     goto err;
  1797.   }
  1798.   area = memarea_new();
  1799.   eos = find_start_of_next_routerstatus(s);
  1800.   if (tokenize_string(area, s, eos, tokens, netstatus_token_table,0)) {
  1801.     log_warn(LD_DIR, "Error tokenizing network-status header.");
  1802.     goto err;
  1803.   }
  1804.   ns = tor_malloc_zero(sizeof(networkstatus_v2_t));
  1805.   memcpy(ns->networkstatus_digest, ns_digest, DIGEST_LEN);
  1806.   tok = find_by_keyword(tokens, K_NETWORK_STATUS_VERSION);
  1807.   tor_assert(tok->n_args >= 1);
  1808.   if (strcmp(tok->args[0], "2")) {
  1809.     log_warn(LD_BUG, "Got a non-v2 networkstatus. Version was "
  1810.              "%s", escaped(tok->args[0]));
  1811.     goto err;