src/or/dirserv.h

   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-2016, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file dirserv.h
   9  * \brief Header file for dirserv.c.
  10  **/
  11
  12 #ifndef TOR_DIRSERV_H
  13 #define TOR_DIRSERV_H
  14
  15 #include "testsupport.h"
  16
  17 /** What fraction (1 over this number) of the relay ID space do we
  18  * (as a directory authority) launch connections to at each reachability
  19  * test? */
  20 #define REACHABILITY_MODULO_PER_TEST 128
  21
  22 /** How often (in seconds) do we launch reachability tests? */
  23 #define REACHABILITY_TEST_INTERVAL 10
  24
  25 /** How many seconds apart are the reachability tests for a given relay? */
  26 #define REACHABILITY_TEST_CYCLE_PERIOD \
  27   (REACHABILITY_TEST_INTERVAL*REACHABILITY_MODULO_PER_TEST)
  28
  29 /** Maximum length of an exit policy summary. */
  30 #define MAX_EXITPOLICY_SUMMARY_LEN 1000
  31
  32 /** Maximum allowable length of a version line in a networkstatus. */
  33 #define MAX_V_LINE_LEN 128
  34
  35 int connection_dirserv_flushed_some(dir_connection_t *conn);
  36
  37 int dirserv_add_own_fingerprint(crypto_pk_t *pk);
  38 int dirserv_load_fingerprint_file(void);
  39 void dirserv_free_fingerprint_list(void);
  40 enum was_router_added_t dirserv_add_multiple_descriptors(
  41                                      const char *desc, uint8_t purpose,
  42                                      const char *source,
  43                                      const char **msg);
  44 enum was_router_added_t dirserv_add_descriptor(routerinfo_t *ri,
  45                                                const char **msg,
  46                                                const char *source);
  47 void dirserv_set_router_is_running(routerinfo_t *router, time_t now);
  48 int list_server_status_v1(smartlist_t *routers, char **router_status_out,
  49                           int for_controller);
  50 int dirserv_dump_directory_to_string(char **dir_out,
  51                                      crypto_pk_t *private_key);
  52 char *dirserv_get_flag_thresholds_line(void);
  53 void dirserv_compute_bridge_flag_thresholds(const smartlist_t *routers);
  54
  55 int directory_fetches_from_authorities(const or_options_t *options);
  56 int directory_fetches_dir_info_early(const or_options_t *options);
  57 int directory_fetches_dir_info_later(const or_options_t *options);
  58 int directory_caches_unknown_auth_certs(const or_options_t *options);
  59 int directory_caches_dir_info(const or_options_t *options);
  60 int directory_permits_begindir_requests(const or_options_t *options);
  61 int directory_too_idle_to_fetch_descriptors(const or_options_t *options,
  62                                             time_t now);
  63
  64 cached_dir_t *dirserv_get_consensus(const char *flavor_name);
  65 void dirserv_set_cached_consensus_networkstatus(const char *consensus,
  66                                               const char *flavor_name,
  67                                               const common_digests_t *digests,
  68                                               time_t published);
  69 void dirserv_clear_old_networkstatuses(time_t cutoff);
  70 int dirserv_get_routerdesc_fingerprints(smartlist_t *fps_out, const char *key,
  71                                         const char **msg,
  72                                         int for_unencrypted_conn,
  73                                         int is_extrainfo);
  74 int dirserv_get_routerdescs(smartlist_t *descs_out, const char *key,
  75                             const char **msg);
  76 void dirserv_orconn_tls_done(const tor_addr_t *addr,
  77                              uint16_t or_port,
  78                              const char *digest_rcvd);
  79 int dirserv_should_launch_reachability_test(const routerinfo_t *ri,
  80                                             const routerinfo_t *ri_old);
  81 void dirserv_single_reachability_test(time_t now, routerinfo_t *router);
  82 void dirserv_test_reachability(time_t now);
  83 int authdir_wants_to_reject_router(routerinfo_t *ri, const char **msg,
  84                                    int complain,
  85                                    int *valid_out);
  86 uint32_t dirserv_router_get_status(const routerinfo_t *router,
  87                                    const char **msg,
  88                                    int severity);
  89 void dirserv_set_node_flags_from_authoritative_status(node_t *node,
  90                                                       uint32_t authstatus);
  91
  92 int dirserv_would_reject_router(const routerstatus_t *rs);
  93 int dirserv_remove_old_statuses(smartlist_t *fps, time_t cutoff);
  94 int dirserv_have_any_serverdesc(smartlist_t *fps, int spool_src);
  95 int dirserv_have_any_microdesc(const smartlist_t *fps);
  96 size_t dirserv_estimate_data_size(smartlist_t *fps, int is_serverdescs,
  97                                   int compressed);
  98 size_t dirserv_estimate_microdesc_size(const smartlist_t *fps, int compressed);
  99
 100 char *routerstatus_format_entry(
 101                               const routerstatus_t *rs, const char *platform,
 102                               routerstatus_format_type_t format,
 103                               const vote_routerstatus_t *vrs);
 104 void dirserv_free_all(void);
 105 void cached_dir_decref(cached_dir_t *d);
 106 cached_dir_t *new_cached_dir(char *s, time_t published);
 107
 108 int validate_recommended_package_line(const char *line);
 109
 110 #ifdef DIRSERV_PRIVATE
 111
 112 STATIC void dirserv_set_routerstatus_testing(routerstatus_t *rs);
 113
 114 /* Put the MAX_MEASUREMENT_AGE #define here so unit tests can see it */
 115 #define MAX_MEASUREMENT_AGE (3*24*60*60) /* 3 days */
 116
 117 STATIC int measured_bw_line_parse(measured_bw_line_t *out, const char *line);
 118
 119 STATIC int measured_bw_line_apply(measured_bw_line_t *parsed_line,
 120                            smartlist_t *routerstatuses);
 121
 122 STATIC void dirserv_cache_measured_bw(const measured_bw_line_t *parsed_line,
 123                                time_t as_of);
 124 STATIC void dirserv_clear_measured_bw_cache(void);
 125 STATIC void dirserv_expire_measured_bw_cache(time_t now);
 126 STATIC int dirserv_get_measured_bw_cache_size(void);
 127 STATIC int dirserv_query_measured_bw_cache_kb(const char *node_id,
 128                                               long *bw_out,
 129                                               time_t *as_of_out);
 130 STATIC int dirserv_has_measured_bw(const char *node_id);
 131
 132 STATIC int
 133 dirserv_read_guardfraction_file_from_str(const char *guardfraction_file_str,
 134                                       smartlist_t *vote_routerstatuses);
 135 #endif
 136
 137 int dirserv_read_measured_bandwidths(const char *from_file,
 138                                      smartlist_t *routerstatuses);
 139
 140 int dirserv_read_guardfraction_file(const char *fname,
 141                                  smartlist_t *vote_routerstatuses);
 142
 143 #endif
 144