src/or/circuitbuild.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-2012, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file circuitbuild.h
   9  * \brief Header file for circuitbuild.c.
  10  **/
  11
  12 #ifndef _TOR_CIRCUITBUILD_H
  13 #define _TOR_CIRCUITBUILD_H
  14
  15 /** Represents a pluggable transport proxy used by a bridge. */
  16 typedef struct {
  17   /** SOCKS version: One of PROXY_SOCKS4, PROXY_SOCKS5. */
  18   int socks_version;
  19   /** Name of pluggable transport protocol */
  20   char *name;
  21   /** Address of proxy */
  22   tor_addr_t addr;
  23   /** Port of proxy */
  24   uint16_t port;
  25   /** Boolean: We are re-parsing our transport list, and we are going to remove
  26    * this one if we don't find it in the list of configured transports. */
  27   unsigned marked_for_removal : 1;
  28 } transport_t;
  29
  30 char *circuit_list_path(origin_circuit_t *circ, int verbose);
  31 char *circuit_list_path_for_controller(origin_circuit_t *circ);
  32 void circuit_log_path(int severity, unsigned int domain,
  33                       origin_circuit_t *circ);
  34 void circuit_rep_hist_note_result(origin_circuit_t *circ);
  35 int circuit_build_times_disabled(void);
  36 origin_circuit_t *origin_circuit_init(uint8_t purpose, int flags);
  37 origin_circuit_t *circuit_establish_circuit(uint8_t purpose,
  38                                             extend_info_t *exit,
  39                                             int flags);
  40 int circuit_handle_first_hop(origin_circuit_t *circ);
  41 void circuit_n_conn_done(or_connection_t *or_conn, int status);
  42 int inform_testing_reachability(void);
  43 int circuit_timeout_want_to_count_circ(origin_circuit_t *circ);
  44 int circuit_send_next_onion_skin(origin_circuit_t *circ);
  45 void circuit_note_clock_jumped(int seconds_elapsed);
  46 int circuit_extend(cell_t *cell, circuit_t *circ);
  47 int circuit_init_cpath_crypto(crypt_path_t *cpath, const char *key_data,
  48                               int reverse);
  49 int circuit_finish_handshake(origin_circuit_t *circ, uint8_t cell_type,
  50                              const uint8_t *reply);
  51 int circuit_truncated(origin_circuit_t *circ, crypt_path_t *layer);
  52 int onionskin_answer(or_circuit_t *circ, uint8_t cell_type,
  53                      const char *payload, const char *keys);
  54 int circuit_all_predicted_ports_handled(time_t now, int *need_uptime,
  55                                         int *need_capacity);
  56
  57 int circuit_append_new_exit(origin_circuit_t *circ, extend_info_t *info);
  58 int circuit_extend_to_new_exit(origin_circuit_t *circ, extend_info_t *info);
  59 void onion_append_to_cpath(crypt_path_t **head_ptr, crypt_path_t *new_hop);
  60 extend_info_t *extend_info_alloc(const char *nickname, const char *digest,
  61                                  crypto_pk_t *onion_key,
  62                                  const tor_addr_t *addr, uint16_t port);
  63 extend_info_t *extend_info_from_router(const routerinfo_t *r,
  64                                        int for_direct_connect);
  65 extend_info_t *extend_info_from_node(const node_t *node,
  66                                      int for_direct_connect);
  67 extend_info_t *extend_info_dup(extend_info_t *info);
  68 void extend_info_free(extend_info_t *info);
  69 const node_t *build_state_get_exit_node(cpath_build_state_t *state);
  70 const char *build_state_get_exit_nickname(cpath_build_state_t *state);
  71
  72 void entry_guards_compute_status(const or_options_t *options, time_t now);
  73 int entry_guard_register_connect_status(const char *digest, int succeeded,
  74                                         int mark_relay_status, time_t now);
  75 void entry_nodes_should_be_added(void);
  76 int entry_list_is_constrained(const or_options_t *options);
  77 const node_t *choose_random_entry(cpath_build_state_t *state);
  78 int entry_guards_parse_state(or_state_t *state, int set, char **msg);
  79 void entry_guards_update_state(or_state_t *state);
  80 int getinfo_helper_entry_guards(control_connection_t *conn,
  81                                 const char *question, char **answer,
  82                                 const char **errmsg);
  83
  84 void mark_bridge_list(void);
  85 void sweep_bridge_list(void);
  86 void mark_transport_list(void);
  87 void sweep_transport_list(void);
  88
  89 int routerinfo_is_a_configured_bridge(const routerinfo_t *ri);
  90 int node_is_a_configured_bridge(const node_t *node);
  91 void learned_router_identity(const tor_addr_t *addr, uint16_t port,
  92                              const char *digest);
  93 void bridge_add_from_config(const tor_addr_t *addr, uint16_t port,
  94                             const char *digest,
  95                             const char *transport_name);
  96 void retry_bridge_descriptor_fetch_directly(const char *digest);
  97 void fetch_bridge_descriptors(const or_options_t *options, time_t now);
  98 void learned_bridge_descriptor(routerinfo_t *ri, int from_cache);
  99 int any_bridge_descriptors_known(void);
 100 int any_pending_bridge_descriptor_fetches(void);
 101 int entries_known_but_down(const or_options_t *options);
 102 void entries_retry_all(const or_options_t *options);
 103
 104 int any_bridges_dont_support_microdescriptors(void);
 105
 106 void entry_guards_free_all(void);
 107
 108 extern circuit_build_times_t circ_times;
 109 int circuit_build_times_enough_to_compute(circuit_build_times_t *cbt);
 110 void circuit_build_times_update_state(circuit_build_times_t *cbt,
 111                                       or_state_t *state);
 112 int circuit_build_times_parse_state(circuit_build_times_t *cbt,
 113                                     or_state_t *state);
 114 void circuit_build_times_count_timeout(circuit_build_times_t *cbt,
 115                                        int did_onehop);
 116 int circuit_build_times_count_close(circuit_build_times_t *cbt,
 117                                     int did_onehop, time_t start_time);
 118 void circuit_build_times_set_timeout(circuit_build_times_t *cbt);
 119 int circuit_build_times_add_time(circuit_build_times_t *cbt,
 120                                  build_time_t time);
 121 int circuit_build_times_needs_circuits(circuit_build_times_t *cbt);
 122
 123 int circuit_build_times_needs_circuits_now(circuit_build_times_t *cbt);
 124 void circuit_build_times_init(circuit_build_times_t *cbt);
 125 void circuit_build_times_free_timeouts(circuit_build_times_t *cbt);
 126 void circuit_build_times_new_consensus_params(circuit_build_times_t *cbt,
 127                                               networkstatus_t *ns);
 128 double circuit_build_times_timeout_rate(const circuit_build_times_t *cbt);
 129 double circuit_build_times_close_rate(const circuit_build_times_t *cbt);
 130
 131 #ifdef CIRCUIT_PRIVATE
 132 double circuit_build_times_calculate_timeout(circuit_build_times_t *cbt,
 133                                              double quantile);
 134 build_time_t circuit_build_times_generate_sample(circuit_build_times_t *cbt,
 135                                                  double q_lo, double q_hi);
 136 void circuit_build_times_initial_alpha(circuit_build_times_t *cbt,
 137                                        double quantile, double time_ms);
 138 int circuit_build_times_update_alpha(circuit_build_times_t *cbt);
 139 double circuit_build_times_cdf(circuit_build_times_t *cbt, double x);
 140 void circuitbuild_running_unit_tests(void);
 141 void circuit_build_times_reset(circuit_build_times_t *cbt);
 142
 143 /* Network liveness functions */
 144 int circuit_build_times_network_check_changed(circuit_build_times_t *cbt);
 145 #endif
 146
 147 /* Network liveness functions */
 148 void circuit_build_times_network_is_live(circuit_build_times_t *cbt);
 149 int circuit_build_times_network_check_live(circuit_build_times_t *cbt);
 150 void circuit_build_times_network_circ_success(circuit_build_times_t *cbt);
 151
 152 /* DOCDOC circuit_build_times_get_bw_scale */
 153 int circuit_build_times_get_bw_scale(networkstatus_t *ns);
 154
 155 void clear_transport_list(void);
 156 int transport_add_from_config(const tor_addr_t *addr, uint16_t port,
 157                                const char *name, int socks_ver);
 158 int transport_add(transport_t *t);
 159 void transport_free(transport_t *transport);
 160 transport_t *transport_new(const tor_addr_t *addr, uint16_t port,
 161                                       const char *name, int socks_ver);
 162
 163 /* DOCDOC find_transport_name_by_bridge_addrport */
 164 const char *find_transport_name_by_bridge_addrport(const tor_addr_t *addr,
 165                                                    uint16_t port);
 166
 167 int find_transport_by_bridge_addrport(const tor_addr_t *addr, uint16_t port,
 168                                       const transport_t **transport);
 169 transport_t *transport_get_by_name(const char *name);
 170
 171 #endif
 172