routerlist.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. /* Copyright (c) 2001-2004, Roger Dingledine.
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2017, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. /**
  6. * \file routerlist.h
  7. * \brief Header file for routerlist.c.
  8. **/
  9. #ifndef TOR_ROUTERLIST_H
  10. #define TOR_ROUTERLIST_H
  11. #include "testsupport.h"
  12. int get_n_authorities(dirinfo_type_t type);
  13. int trusted_dirs_reload_certs(void);
  14. /*
  15. * Pass one of these as source to trusted_dirs_load_certs_from_string()
  16. * to indicate whence string originates; this controls error handling
  17. * behavior such as marking downloads as failed.
  18. */
  19. #define TRUSTED_DIRS_CERTS_SRC_SELF 0
  20. #define TRUSTED_DIRS_CERTS_SRC_FROM_STORE 1
  21. #define TRUSTED_DIRS_CERTS_SRC_DL_BY_ID_DIGEST 2
  22. #define TRUSTED_DIRS_CERTS_SRC_DL_BY_ID_SK_DIGEST 3
  23. #define TRUSTED_DIRS_CERTS_SRC_FROM_VOTE 4
  24. int trusted_dirs_load_certs_from_string(const char *contents, int source,
  25. int flush, const char *source_dir);
  26. void trusted_dirs_flush_certs_to_disk(void);
  27. authority_cert_t *authority_cert_get_newest_by_id(const char *id_digest);
  28. authority_cert_t *authority_cert_get_by_sk_digest(const char *sk_digest);
  29. authority_cert_t *authority_cert_get_by_digests(const char *id_digest,
  30. const char *sk_digest);
  31. void authority_cert_get_all(smartlist_t *certs_out);
  32. void authority_cert_dl_failed(const char *id_digest,
  33. const char *signing_key_digest, int status);
  34. void authority_certs_fetch_missing(networkstatus_t *status, time_t now,
  35. const char *dir_hint);
  36. int router_reload_router_list(void);
  37. int authority_cert_dl_looks_uncertain(const char *id_digest);
  38. const smartlist_t *router_get_trusted_dir_servers(void);
  39. const smartlist_t *router_get_fallback_dir_servers(void);
  40. int authority_cert_is_blacklisted(const authority_cert_t *cert);
  41. const routerstatus_t *router_pick_directory_server(dirinfo_type_t type,
  42. int flags);
  43. dir_server_t *router_get_trusteddirserver_by_digest(const char *d);
  44. dir_server_t *router_get_fallback_dirserver_by_digest(
  45. const char *digest);
  46. int router_digest_is_fallback_dir(const char *digest);
  47. MOCK_DECL(dir_server_t *, trusteddirserver_get_by_v3_auth_digest,
  48. (const char *d));
  49. const routerstatus_t *router_pick_trusteddirserver(dirinfo_type_t type,
  50. int flags);
  51. const routerstatus_t *router_pick_fallback_dirserver(dirinfo_type_t type,
  52. int flags);
  53. int router_skip_or_reachability(const or_options_t *options, int try_ip_pref);
  54. int router_get_my_share_of_directory_requests(double *v3_share_out);
  55. void router_reset_status_download_failures(void);
  56. int routers_have_same_or_addrs(const routerinfo_t *r1, const routerinfo_t *r2);
  57. void router_add_running_nodes_to_smartlist(smartlist_t *sl, int need_uptime,
  58. int need_capacity, int need_guard,
  59. int need_desc, int pref_addr,
  60. int direct_conn);
  61. const routerinfo_t *routerlist_find_my_routerinfo(void);
  62. uint32_t router_get_advertised_bandwidth(const routerinfo_t *router);
  63. uint32_t router_get_advertised_bandwidth_capped(const routerinfo_t *router);
  64. const node_t *node_sl_choose_by_bandwidth(const smartlist_t *sl,
  65. bandwidth_weight_rule_t rule);
  66. double frac_nodes_with_descriptors(const smartlist_t *sl,
  67. bandwidth_weight_rule_t rule);
  68. const node_t *router_choose_random_node(smartlist_t *excludedsmartlist,
  69. struct routerset_t *excludedset,
  70. router_crn_flags_t flags);
  71. int router_digest_is_trusted_dir_type(const char *digest,
  72. dirinfo_type_t type);
  73. #define router_digest_is_trusted_dir(d) \
  74. router_digest_is_trusted_dir_type((d), NO_DIRINFO)
  75. int hexdigest_to_digest(const char *hexdigest, char *digest);
  76. const routerinfo_t *router_get_by_id_digest(const char *digest);
  77. routerinfo_t *router_get_mutable_by_digest(const char *digest);
  78. signed_descriptor_t *router_get_by_descriptor_digest(const char *digest);
  79. MOCK_DECL(signed_descriptor_t *,router_get_by_extrainfo_digest,
  80. (const char *digest));
  81. MOCK_DECL(signed_descriptor_t *,extrainfo_get_by_descriptor_digest,
  82. (const char *digest));
  83. const char *signed_descriptor_get_body(const signed_descriptor_t *desc);
  84. const char *signed_descriptor_get_annotations(const signed_descriptor_t *desc);
  85. routerlist_t *router_get_routerlist(void);
  86. void routerinfo_free_(routerinfo_t *router);
  87. #define routerinfo_free(router) \
  88. FREE_AND_NULL(routerinfo_t, routerinfo_free_, (router))
  89. void extrainfo_free_(extrainfo_t *extrainfo);
  90. #define extrainfo_free(ei) FREE_AND_NULL(extrainfo_t, extrainfo_free_, (ei))
  91. void routerlist_free_(routerlist_t *rl);
  92. #define routerlist_free(rl) FREE_AND_NULL(routerlist_t, routerlist_free_, (rl))
  93. void dump_routerlist_mem_usage(int severity);
  94. void routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int make_old,
  95. time_t now);
  96. void routerlist_free_all(void);
  97. void routerlist_reset_warnings(void);
  98. MOCK_DECL(smartlist_t *, list_authority_ids_with_downloads, (void));
  99. MOCK_DECL(download_status_t *, id_only_download_status_for_authority_id,
  100. (const char *digest));
  101. MOCK_DECL(smartlist_t *, list_sk_digests_for_authority_id,
  102. (const char *digest));
  103. MOCK_DECL(download_status_t *, download_status_for_authority_id_and_sk,
  104. (const char *id_digest, const char *sk_digest));
  105. static int WRA_WAS_ADDED(was_router_added_t s);
  106. static int WRA_WAS_OUTDATED(was_router_added_t s);
  107. static int WRA_WAS_REJECTED(was_router_added_t s);
  108. static int WRA_NEVER_DOWNLOADABLE(was_router_added_t s);
  109. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  110. * was added. It might still be necessary to check whether the descriptor
  111. * generator should be notified.
  112. */
  113. static inline int
  114. WRA_WAS_ADDED(was_router_added_t s) {
  115. return s == ROUTER_ADDED_SUCCESSFULLY;
  116. }
  117. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  118. * was not added because it was either:
  119. * - not in the consensus
  120. * - neither in the consensus nor in any networkstatus document
  121. * - it was outdated.
  122. * - its certificates were expired.
  123. */
  124. static inline int WRA_WAS_OUTDATED(was_router_added_t s)
  125. {
  126. return (s == ROUTER_WAS_TOO_OLD ||
  127. s == ROUTER_IS_ALREADY_KNOWN ||
  128. s == ROUTER_NOT_IN_CONSENSUS ||
  129. s == ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS ||
  130. s == ROUTER_CERTS_EXPIRED);
  131. }
  132. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  133. * was flat-out rejected. */
  134. static inline int WRA_WAS_REJECTED(was_router_added_t s)
  135. {
  136. return (s == ROUTER_AUTHDIR_REJECTS);
  137. }
  138. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  139. * was flat-out rejected. */
  140. static inline int WRA_NEVER_DOWNLOADABLE(was_router_added_t s)
  141. {
  142. return (s == ROUTER_AUTHDIR_REJECTS ||
  143. s == ROUTER_BAD_EI ||
  144. s == ROUTER_WAS_TOO_OLD ||
  145. s == ROUTER_CERTS_EXPIRED);
  146. }
  147. was_router_added_t router_add_to_routerlist(routerinfo_t *router,
  148. const char **msg,
  149. int from_cache,
  150. int from_fetch);
  151. was_router_added_t router_add_extrainfo_to_routerlist(
  152. extrainfo_t *ei, const char **msg,
  153. int from_cache, int from_fetch);
  154. void routerlist_descriptors_added(smartlist_t *sl, int from_cache);
  155. void routerlist_remove_old_routers(void);
  156. int router_load_single_router(const char *s, uint8_t purpose, int cache,
  157. const char **msg);
  158. int router_load_routers_from_string(const char *s, const char *eos,
  159. saved_location_t saved_location,
  160. smartlist_t *requested_fingerprints,
  161. int descriptor_digests,
  162. const char *prepend_annotations);
  163. void router_load_extrainfo_from_string(const char *s, const char *eos,
  164. saved_location_t saved_location,
  165. smartlist_t *requested_fingerprints,
  166. int descriptor_digests);
  167. void routerlist_retry_directory_downloads(time_t now);
  168. int router_exit_policy_rejects_all(const routerinfo_t *router);
  169. dir_server_t *trusted_dir_server_new(const char *nickname, const char *address,
  170. uint16_t dir_port, uint16_t or_port,
  171. const tor_addr_port_t *addrport_ipv6,
  172. const char *digest, const char *v3_auth_digest,
  173. dirinfo_type_t type, double weight);
  174. dir_server_t *fallback_dir_server_new(const tor_addr_t *addr,
  175. uint16_t dir_port, uint16_t or_port,
  176. const tor_addr_port_t *addrport_ipv6,
  177. const char *id_digest, double weight);
  178. void dir_server_add(dir_server_t *ent);
  179. void authority_cert_free_(authority_cert_t *cert);
  180. #define authority_cert_free(cert) \
  181. FREE_AND_NULL(authority_cert_t, authority_cert_free_, (cert))
  182. void clear_dir_servers(void);
  183. void update_consensus_router_descriptor_downloads(time_t now, int is_vote,
  184. networkstatus_t *consensus);
  185. void update_router_descriptor_downloads(time_t now);
  186. void update_all_descriptor_downloads(time_t now);
  187. void update_extrainfo_downloads(time_t now);
  188. void router_reset_descriptor_download_failures(void);
  189. int router_differences_are_cosmetic(const routerinfo_t *r1,
  190. const routerinfo_t *r2);
  191. int routerinfo_incompatible_with_extrainfo(const crypto_pk_t *ri,
  192. extrainfo_t *ei,
  193. signed_descriptor_t *sd,
  194. const char **msg);
  195. int routerinfo_has_curve25519_onion_key(const routerinfo_t *ri);
  196. int routerstatus_version_supports_extend2_cells(const routerstatus_t *rs,
  197. int allow_unknown_versions);
  198. void routerlist_assert_ok(const routerlist_t *rl);
  199. const char *esc_router_info(const routerinfo_t *router);
  200. void routers_sort_by_identity(smartlist_t *routers);
  201. void refresh_all_country_info(void);
  202. void list_pending_microdesc_downloads(digest256map_t *result);
  203. void launch_descriptor_downloads(int purpose,
  204. smartlist_t *downloadable,
  205. const routerstatus_t *source,
  206. time_t now);
  207. int hex_digest_nickname_decode(const char *hexdigest,
  208. char *digest_out,
  209. char *nickname_qualifier_out,
  210. char *nickname_out);
  211. int hex_digest_nickname_matches(const char *hexdigest,
  212. const char *identity_digest,
  213. const char *nickname);
  214. #ifdef ROUTERLIST_PRIVATE
  215. STATIC int choose_array_element_by_weight(const uint64_t *entries,
  216. int n_entries);
  217. STATIC void scale_array_elements_to_u64(uint64_t *entries_out,
  218. const double *entries_in,
  219. int n_entries,
  220. uint64_t *total_out);
  221. STATIC const routerstatus_t *router_pick_directory_server_impl(
  222. dirinfo_type_t auth, int flags,
  223. int *n_busy_out);
  224. MOCK_DECL(int, router_descriptor_is_older_than, (const routerinfo_t *router,
  225. int seconds));
  226. MOCK_DECL(STATIC was_router_added_t, extrainfo_insert,
  227. (routerlist_t *rl, extrainfo_t *ei, int warn_if_incompatible));
  228. MOCK_DECL(STATIC void, initiate_descriptor_downloads,
  229. (const routerstatus_t *source, int purpose, smartlist_t *digests,
  230. int lo, int hi, int pds_flags));
  231. STATIC int router_is_already_dir_fetching(const tor_addr_port_t *ap,
  232. int serverdesc, int microdesc);
  233. #endif /* defined(ROUTERLIST_PRIVATE) */
  234. #endif /* !defined(TOR_ROUTERLIST_H) */