dirserv.h 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  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-2017, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file dirserv.h
  8. * \brief Header file for dirserv.c.
  9. **/
  10. #ifndef TOR_DIRSERV_H
  11. #define TOR_DIRSERV_H
  12. #include "testsupport.h"
  13. /** What fraction (1 over this number) of the relay ID space do we
  14. * (as a directory authority) launch connections to at each reachability
  15. * test? */
  16. #define REACHABILITY_MODULO_PER_TEST 128
  17. /** How often (in seconds) do we launch reachability tests? */
  18. #define REACHABILITY_TEST_INTERVAL 10
  19. /** How many seconds apart are the reachability tests for a given relay? */
  20. #define REACHABILITY_TEST_CYCLE_PERIOD \
  21. (REACHABILITY_TEST_INTERVAL*REACHABILITY_MODULO_PER_TEST)
  22. /** Maximum length of an exit policy summary. */
  23. #define MAX_EXITPOLICY_SUMMARY_LEN 1000
  24. /** Maximum allowable length of a version line in a networkstatus. */
  25. #define MAX_V_LINE_LEN 128
  26. /** Ways to convert a spoolable_resource_t to a bunch of bytes. */
  27. typedef enum dir_spool_source_t {
  28. DIR_SPOOL_SERVER_BY_DIGEST=1, DIR_SPOOL_SERVER_BY_FP,
  29. DIR_SPOOL_EXTRA_BY_DIGEST, DIR_SPOOL_EXTRA_BY_FP,
  30. DIR_SPOOL_MICRODESC,
  31. DIR_SPOOL_NETWORKSTATUS,
  32. DIR_SPOOL_CONSENSUS_CACHE_ENTRY,
  33. } dir_spool_source_t;
  34. #define dir_spool_source_bitfield_t ENUM_BF(dir_spool_source_t)
  35. /** Object to remember the identity of an object that we are spooling,
  36. * or about to spool, in response to a directory request.
  37. *
  38. * (Why do we spool? Because some directory responses are very large,
  39. * and we don't want to just shove the complete answer into the output
  40. * buffer: that would take a ridiculous amount of RAM.)
  41. *
  42. * If the spooled resource is relatively small (like microdescriptors,
  43. * descriptors, etc), we look them up by ID as needed, and add the whole
  44. * thing onto the output buffer at once. If the spooled reseource is
  45. * big (like networkstatus documents), we reference-count it, and add it
  46. * a few K at a time.
  47. */
  48. typedef struct spooled_resource_t {
  49. /**
  50. * If true, we add the entire object to the outbuf. If false,
  51. * we spool the object a few K at a time.
  52. */
  53. unsigned spool_eagerly : 1;
  54. /**
  55. * Tells us what kind of object to get, and how to look it up.
  56. */
  57. dir_spool_source_bitfield_t spool_source : 7;
  58. /**
  59. * Tells us the specific object to spool.
  60. */
  61. uint8_t digest[DIGEST256_LEN];
  62. /**
  63. * A large object that we're spooling. Holds a reference count. Only
  64. * used when spool_eagerly is false.
  65. */
  66. struct cached_dir_t *cached_dir_ref;
  67. /**
  68. * A different kind of large object that we might be spooling. Also
  69. * reference-counted. Also only used when spool_eagerly is false.
  70. */
  71. struct consensus_cache_entry_t *consensus_cache_entry;
  72. const uint8_t *cce_body;
  73. size_t cce_len;
  74. /**
  75. * The current offset into cached_dir or cce_body. Only used when
  76. * spool_eagerly is false */
  77. off_t cached_dir_offset;
  78. } spooled_resource_t;
  79. int connection_dirserv_flushed_some(dir_connection_t *conn);
  80. int dirserv_add_own_fingerprint(crypto_pk_t *pk);
  81. int dirserv_load_fingerprint_file(void);
  82. void dirserv_free_fingerprint_list(void);
  83. enum was_router_added_t dirserv_add_multiple_descriptors(
  84. const char *desc, uint8_t purpose,
  85. const char *source,
  86. const char **msg);
  87. enum was_router_added_t dirserv_add_descriptor(routerinfo_t *ri,
  88. const char **msg,
  89. const char *source);
  90. void dirserv_set_router_is_running(routerinfo_t *router, time_t now);
  91. int list_server_status_v1(smartlist_t *routers, char **router_status_out,
  92. int for_controller);
  93. char *dirserv_get_flag_thresholds_line(void);
  94. void dirserv_compute_bridge_flag_thresholds(void);
  95. int directory_fetches_from_authorities(const or_options_t *options);
  96. int directory_fetches_dir_info_early(const or_options_t *options);
  97. int directory_fetches_dir_info_later(const or_options_t *options);
  98. int directory_caches_unknown_auth_certs(const or_options_t *options);
  99. int directory_caches_dir_info(const or_options_t *options);
  100. int directory_permits_begindir_requests(const or_options_t *options);
  101. int directory_too_idle_to_fetch_descriptors(const or_options_t *options,
  102. time_t now);
  103. cached_dir_t *dirserv_get_consensus(const char *flavor_name);
  104. void dirserv_set_cached_consensus_networkstatus(const char *consensus,
  105. const char *flavor_name,
  106. const common_digests_t *digests,
  107. const uint8_t *sha3_as_signed,
  108. time_t published);
  109. void dirserv_clear_old_networkstatuses(time_t cutoff);
  110. int dirserv_get_routerdesc_spool(smartlist_t *spools_out, const char *key,
  111. dir_spool_source_t source,
  112. int conn_is_encrypted,
  113. const char **msg_out);
  114. int dirserv_get_routerdescs(smartlist_t *descs_out, const char *key,
  115. const char **msg);
  116. void dirserv_orconn_tls_done(const tor_addr_t *addr,
  117. uint16_t or_port,
  118. const char *digest_rcvd,
  119. const ed25519_public_key_t *ed_id_rcvd);
  120. int dirserv_should_launch_reachability_test(const routerinfo_t *ri,
  121. const routerinfo_t *ri_old);
  122. void dirserv_single_reachability_test(time_t now, routerinfo_t *router);
  123. void dirserv_test_reachability(time_t now);
  124. int authdir_wants_to_reject_router(routerinfo_t *ri, const char **msg,
  125. int complain,
  126. int *valid_out);
  127. uint32_t dirserv_router_get_status(const routerinfo_t *router,
  128. const char **msg,
  129. int severity);
  130. void dirserv_set_node_flags_from_authoritative_status(node_t *node,
  131. uint32_t authstatus);
  132. int dirserv_would_reject_router(const routerstatus_t *rs);
  133. char *routerstatus_format_entry(
  134. const routerstatus_t *rs,
  135. const char *version,
  136. const char *protocols,
  137. routerstatus_format_type_t format,
  138. int consensus_method,
  139. const vote_routerstatus_t *vrs);
  140. void dirserv_free_all(void);
  141. void cached_dir_decref(cached_dir_t *d);
  142. cached_dir_t *new_cached_dir(char *s, time_t published);
  143. int validate_recommended_package_line(const char *line);
  144. #ifdef DIRSERV_PRIVATE
  145. STATIC void dirserv_set_routerstatus_testing(routerstatus_t *rs);
  146. /* Put the MAX_MEASUREMENT_AGE #define here so unit tests can see it */
  147. #define MAX_MEASUREMENT_AGE (3*24*60*60) /* 3 days */
  148. STATIC int measured_bw_line_parse(measured_bw_line_t *out, const char *line);
  149. STATIC int measured_bw_line_apply(measured_bw_line_t *parsed_line,
  150. smartlist_t *routerstatuses);
  151. STATIC void dirserv_cache_measured_bw(const measured_bw_line_t *parsed_line,
  152. time_t as_of);
  153. STATIC void dirserv_clear_measured_bw_cache(void);
  154. STATIC void dirserv_expire_measured_bw_cache(time_t now);
  155. STATIC int dirserv_get_measured_bw_cache_size(void);
  156. STATIC int dirserv_query_measured_bw_cache_kb(const char *node_id,
  157. long *bw_out,
  158. time_t *as_of_out);
  159. STATIC int dirserv_has_measured_bw(const char *node_id);
  160. STATIC int
  161. dirserv_read_guardfraction_file_from_str(const char *guardfraction_file_str,
  162. smartlist_t *vote_routerstatuses);
  163. #endif /* defined(DIRSERV_PRIVATE) */
  164. int dirserv_read_measured_bandwidths(const char *from_file,
  165. smartlist_t *routerstatuses);
  166. int dirserv_read_guardfraction_file(const char *fname,
  167. smartlist_t *vote_routerstatuses);
  168. spooled_resource_t *spooled_resource_new(dir_spool_source_t source,
  169. const uint8_t *digest,
  170. size_t digestlen);
  171. spooled_resource_t *spooled_resource_new_from_cache_entry(
  172. struct consensus_cache_entry_t *entry);
  173. void spooled_resource_free_(spooled_resource_t *spooled);
  174. #define spooled_resource_free(sp) \
  175. FREE_AND_NULL(spooled_resource_t, spooled_resource_free_, (sp))
  176. void dirserv_spool_remove_missing_and_guess_size(dir_connection_t *conn,
  177. time_t cutoff,
  178. int compression,
  179. size_t *size_out,
  180. int *n_expired_out);
  181. void dirserv_spool_sort(dir_connection_t *conn);
  182. void dir_conn_clear_spool(dir_connection_t *conn);
  183. #endif /* !defined(TOR_DIRSERV_H) */