routerlist.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. /* Copyright (c) 2001-2004, Roger Dingledine.
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2013, 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);
  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. int router_reload_router_list(void);
  36. int authority_cert_dl_looks_uncertain(const char *id_digest);
  37. const smartlist_t *router_get_trusted_dir_servers(void);
  38. const smartlist_t *router_get_fallback_dir_servers(void);
  39. int authority_cert_is_blacklisted(const authority_cert_t *cert);
  40. const routerstatus_t *router_pick_directory_server(dirinfo_type_t type,
  41. int flags);
  42. dir_server_t *router_get_trusteddirserver_by_digest(const char *d);
  43. dir_server_t *router_get_fallback_dirserver_by_digest(
  44. const char *digest);
  45. dir_server_t *trusteddirserver_get_by_v3_auth_digest(const char *d);
  46. const routerstatus_t *router_pick_trusteddirserver(dirinfo_type_t type,
  47. int flags);
  48. const routerstatus_t *router_pick_fallback_dirserver(dirinfo_type_t type,
  49. int flags);
  50. int router_get_my_share_of_directory_requests(double *v3_share_out);
  51. void router_reset_status_download_failures(void);
  52. int routers_have_same_or_addrs(const routerinfo_t *r1, const routerinfo_t *r2);
  53. const routerinfo_t *routerlist_find_my_routerinfo(void);
  54. uint32_t router_get_advertised_bandwidth(const routerinfo_t *router);
  55. uint32_t router_get_advertised_bandwidth_capped(const routerinfo_t *router);
  56. const node_t *node_sl_choose_by_bandwidth(const smartlist_t *sl,
  57. bandwidth_weight_rule_t rule);
  58. double frac_nodes_with_descriptors(const smartlist_t *sl,
  59. bandwidth_weight_rule_t rule);
  60. const node_t *router_choose_random_node(smartlist_t *excludedsmartlist,
  61. struct routerset_t *excludedset,
  62. router_crn_flags_t flags);
  63. int router_is_named(const routerinfo_t *router);
  64. int router_digest_is_trusted_dir_type(const char *digest,
  65. dirinfo_type_t type);
  66. #define router_digest_is_trusted_dir(d) \
  67. router_digest_is_trusted_dir_type((d), NO_DIRINFO)
  68. int router_addr_is_trusted_dir(uint32_t addr);
  69. int hexdigest_to_digest(const char *hexdigest, char *digest);
  70. const routerinfo_t *router_get_by_id_digest(const char *digest);
  71. routerinfo_t *router_get_mutable_by_digest(const char *digest);
  72. signed_descriptor_t *router_get_by_descriptor_digest(const char *digest);
  73. signed_descriptor_t *router_get_by_extrainfo_digest(const char *digest);
  74. signed_descriptor_t *extrainfo_get_by_descriptor_digest(const char *digest);
  75. const char *signed_descriptor_get_body(const signed_descriptor_t *desc);
  76. const char *signed_descriptor_get_annotations(const signed_descriptor_t *desc);
  77. routerlist_t *router_get_routerlist(void);
  78. void routerinfo_free(routerinfo_t *router);
  79. void extrainfo_free(extrainfo_t *extrainfo);
  80. void routerlist_free(routerlist_t *rl);
  81. void dump_routerlist_mem_usage(int severity);
  82. void routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int make_old,
  83. time_t now);
  84. void routerlist_free_all(void);
  85. void routerlist_reset_warnings(void);
  86. static int WRA_WAS_ADDED(was_router_added_t s);
  87. static int WRA_WAS_OUTDATED(was_router_added_t s);
  88. static int WRA_WAS_REJECTED(was_router_added_t s);
  89. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  90. * was added. It might still be necessary to check whether the descriptor
  91. * generator should be notified.
  92. */
  93. static INLINE int
  94. WRA_WAS_ADDED(was_router_added_t s) {
  95. return s == ROUTER_ADDED_SUCCESSFULLY || s == ROUTER_ADDED_NOTIFY_GENERATOR;
  96. }
  97. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  98. * was not added because it was either:
  99. * - not in the consensus
  100. * - neither in the consensus nor in any networkstatus document
  101. * - it was outdated.
  102. */
  103. static INLINE int WRA_WAS_OUTDATED(was_router_added_t s)
  104. {
  105. return (s == ROUTER_WAS_NOT_NEW ||
  106. s == ROUTER_NOT_IN_CONSENSUS ||
  107. s == ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS);
  108. }
  109. /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  110. * was flat-out rejected. */
  111. static INLINE int WRA_WAS_REJECTED(was_router_added_t s)
  112. {
  113. return (s == ROUTER_AUTHDIR_REJECTS);
  114. }
  115. was_router_added_t router_add_to_routerlist(routerinfo_t *router,
  116. const char **msg,
  117. int from_cache,
  118. int from_fetch);
  119. was_router_added_t router_add_extrainfo_to_routerlist(
  120. extrainfo_t *ei, const char **msg,
  121. int from_cache, int from_fetch);
  122. void routerlist_descriptors_added(smartlist_t *sl, int from_cache);
  123. void routerlist_remove_old_routers(void);
  124. int router_load_single_router(const char *s, uint8_t purpose, int cache,
  125. const char **msg);
  126. int router_load_routers_from_string(const char *s, const char *eos,
  127. saved_location_t saved_location,
  128. smartlist_t *requested_fingerprints,
  129. int descriptor_digests,
  130. const char *prepend_annotations);
  131. void router_load_extrainfo_from_string(const char *s, const char *eos,
  132. saved_location_t saved_location,
  133. smartlist_t *requested_fingerprints,
  134. int descriptor_digests);
  135. void routerlist_retry_directory_downloads(time_t now);
  136. int router_exit_policy_rejects_all(const routerinfo_t *router);
  137. dir_server_t *trusted_dir_server_new(const char *nickname, const char *address,
  138. uint16_t dir_port, uint16_t or_port,
  139. const char *digest, const char *v3_auth_digest,
  140. dirinfo_type_t type, double weight);
  141. dir_server_t *fallback_dir_server_new(const tor_addr_t *addr,
  142. uint16_t dir_port, uint16_t or_port,
  143. const char *id_digest, double weight);
  144. void dir_server_add(dir_server_t *ent);
  145. void authority_cert_free(authority_cert_t *cert);
  146. void clear_dir_servers(void);
  147. void update_consensus_router_descriptor_downloads(time_t now, int is_vote,
  148. networkstatus_t *consensus);
  149. void update_router_descriptor_downloads(time_t now);
  150. void update_all_descriptor_downloads(time_t now);
  151. void update_extrainfo_downloads(time_t now);
  152. void router_reset_descriptor_download_failures(void);
  153. int router_differences_are_cosmetic(const routerinfo_t *r1,
  154. const routerinfo_t *r2);
  155. int routerinfo_incompatible_with_extrainfo(const routerinfo_t *ri,
  156. extrainfo_t *ei,
  157. signed_descriptor_t *sd,
  158. const char **msg);
  159. void routerlist_assert_ok(const routerlist_t *rl);
  160. const char *esc_router_info(const routerinfo_t *router);
  161. void routers_sort_by_identity(smartlist_t *routers);
  162. void refresh_all_country_info(void);
  163. int hid_serv_get_responsible_directories(smartlist_t *responsible_dirs,
  164. const char *id);
  165. int hid_serv_acting_as_directory(void);
  166. int hid_serv_responsible_for_desc_id(const char *id);
  167. void list_pending_microdesc_downloads(digestmap_t *result);
  168. void launch_descriptor_downloads(int purpose,
  169. smartlist_t *downloadable,
  170. const routerstatus_t *source,
  171. time_t now);
  172. int hex_digest_nickname_decode(const char *hexdigest,
  173. char *digest_out,
  174. char *nickname_qualifier_out,
  175. char *nickname_out);
  176. int hex_digest_nickname_matches(const char *hexdigest,
  177. const char *identity_digest,
  178. const char *nickname, int is_named);
  179. #ifdef ROUTERLIST_PRIVATE
  180. /** Helper type for choosing routers by bandwidth: contains a union of
  181. * double and uint64_t. Before we call scale_array_elements_to_u64, it holds
  182. * a double; after, it holds a uint64_t. */
  183. typedef union u64_dbl_t {
  184. uint64_t u64;
  185. double dbl;
  186. } u64_dbl_t;
  187. STATIC int choose_array_element_by_weight(const u64_dbl_t *entries,
  188. int n_entries);
  189. STATIC void scale_array_elements_to_u64(u64_dbl_t *entries, int n_entries,
  190. uint64_t *total_out);
  191. MOCK_DECL(int, router_descriptor_is_older_than, (const routerinfo_t *router,
  192. int seconds));
  193. #endif
  194. #endif