src/or/entrynodes.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-2013, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file entrynodes.h
   9  * \brief Header file for circuitbuild.c.
  10  **/
  11
  12 #ifndef TOR_ENTRYNODES_H
  13 #define TOR_ENTRYNODES_H
  14
  15 #if 1
  16 /* XXXX NM I would prefer that all of this stuff be private to
  17  * entrynodes.c. */
  18
  19 /** An entry_guard_t represents our information about a chosen long-term
  20  * first hop, known as a "helper" node in the literature. We can't just
  21  * use a node_t, since we want to remember these even when we
  22  * don't have any directory info. */
  23 typedef struct entry_guard_t {
  24   char nickname[MAX_NICKNAME_LEN+1];
  25   char identity[DIGEST_LEN];
  26   time_t chosen_on_date; /**< Approximately when was this guard added?
  27                           * "0" if we don't know. */
  28   char *chosen_by_version; /**< What tor version added this guard? NULL
  29                             * if we don't know. */
  30   unsigned int made_contact : 1; /**< 0 if we have never connected to this
  31                                   * router, 1 if we have. */
  32   unsigned int can_retry : 1; /**< Should we retry connecting to this entry,
  33                                * in spite of having it marked as unreachable?*/
  34   unsigned int path_bias_noticed : 1; /**< Did we alert the user about path
  35                                        * bias for this node already? */
  36   unsigned int path_bias_warned : 1; /**< Did we alert the user about path bias
  37                                       * for this node already? */
  38   unsigned int path_bias_extreme : 1; /**< Did we alert the user about path
  39                                        * bias for this node already? */
  40   unsigned int path_bias_disabled : 1; /**< Have we disabled this node because
  41                                         * of path bias issues? */
  42   unsigned int path_bias_use_noticed : 1; /**< Did we alert the user about path
  43                                        * use bias for this node already? */
  44   unsigned int path_bias_use_extreme : 1; /**< Did we alert the user about path
  45                                        * use bias for this node already? */
  46   unsigned int is_dir_cache : 1; /**< Is this node a directory cache? */
  47   time_t bad_since; /**< 0 if this guard is currently usable, or the time at
  48                       * which it was observed to become (according to the
  49                       * directory or the user configuration) unusable. */
  50   time_t unreachable_since; /**< 0 if we can connect to this guard, or the
  51                              * time at which we first noticed we couldn't
  52                              * connect to it. */
  53   time_t last_attempted; /**< 0 if we can connect to this guard, or the time
  54                           * at which we last failed to connect to it. */
  55
  56   double circ_attempts; /**< Number of circuits this guard has "attempted" */
  57   double circ_successes; /**< Number of successfully built circuits using
  58                                * this guard as first hop. */
  59   double successful_circuits_closed; /**< Number of circuits that carried
  60                                         * streams successfully. */
  61   double collapsed_circuits; /**< Number of fully built circuits that were
  62                                  * remotely closed before any streams were
  63                                  * attempted. */
  64   double unusable_circuits; /**< Number of circuits for which streams were
  65                                 *  attempted, but none succeeded. */
  66   double timeouts; /**< Number of 'right-censored' circuit timeouts for this
  67                        * guard. */
  68   double use_attempts; /**< Number of circuits we tried to use with streams */
  69   double use_successes; /**< Number of successfully used circuits using
  70                                * this guard as first hop. */
  71 } entry_guard_t;
  72
  73 entry_guard_t *entry_guard_get_by_id_digest(const char *digest);
  74 void entry_guards_changed(void);
  75 const smartlist_t *get_entry_guards(void);
  76 int num_live_entry_guards(int for_directory);
  77
  78 #endif
  79
  80 void remove_all_entry_guards(void);
  81
  82 void entry_guards_compute_status(const or_options_t *options, time_t now);
  83 int entry_guard_register_connect_status(const char *digest, int succeeded,
  84                                         int mark_relay_status, time_t now);
  85 void entry_nodes_should_be_added(void);
  86 int entry_list_is_constrained(const or_options_t *options);
  87 const node_t *choose_random_entry(cpath_build_state_t *state);
  88 const node_t *choose_random_dirguard(dirinfo_type_t t);
  89 int entry_guards_parse_state(or_state_t *state, int set, char **msg);
  90 void entry_guards_update_state(or_state_t *state);
  91 int getinfo_helper_entry_guards(control_connection_t *conn,
  92                                 const char *question, char **answer,
  93                                 const char **errmsg);
  94
  95 void mark_bridge_list(void);
  96 void sweep_bridge_list(void);
  97
  98 int routerinfo_is_a_configured_bridge(const routerinfo_t *ri);
  99 int node_is_a_configured_bridge(const node_t *node);
 100 void learned_router_identity(const tor_addr_t *addr, uint16_t port,
 101                              const char *digest);
 102 struct bridge_line_t;
 103 void bridge_add_from_config(struct bridge_line_t *bridge_line);
 104 void retry_bridge_descriptor_fetch_directly(const char *digest);
 105 void fetch_bridge_descriptors(const or_options_t *options, time_t now);
 106 void learned_bridge_descriptor(routerinfo_t *ri, int from_cache);
 107 int any_bridge_descriptors_known(void);
 108 int entries_known_but_down(const or_options_t *options);
 109 void entries_retry_all(const or_options_t *options);
 110
 111 int any_bridge_supports_microdescriptors(void);
 112 const smartlist_t *get_socks_args_by_bridge_addrport(const tor_addr_t *addr,
 113                                                      uint16_t port);
 114
 115 int any_bridges_dont_support_microdescriptors(void);
 116
 117 void entry_guards_free_all(void);
 118
 119 const char *find_transport_name_by_bridge_addrport(const tor_addr_t *addr,
 120                                                    uint16_t port);
 121 struct transport_t;
 122 int get_transport_by_bridge_addrport(const tor_addr_t *addr, uint16_t port,
 123                                       const struct transport_t **transport);
 124
 125 int transport_is_needed(const char *transport_name);
 126 int validate_pluggable_transports_config(void);
 127
 128 double pathbias_get_close_success_count(entry_guard_t *guard);
 129 double pathbias_get_use_success_count(entry_guard_t *guard);
 130
 131 #endif
 132