entrynodes.h 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  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. * \file entrynodes.h
  8. * \brief Header file for circuitbuild.c.
  9. **/
  10. #ifndef TOR_ENTRYNODES_H
  11. #define TOR_ENTRYNODES_H
  12. #if 1
  13. /* XXXX NM I would prefer that all of this stuff be private to
  14. * entrynodes.c. */
  15. /** An entry_guard_t represents our information about a chosen long-term
  16. * first hop, known as a "helper" node in the literature. We can't just
  17. * use a node_t, since we want to remember these even when we
  18. * don't have any directory info. */
  19. typedef struct entry_guard_t {
  20. char nickname[MAX_NICKNAME_LEN+1];
  21. char identity[DIGEST_LEN];
  22. time_t chosen_on_date; /**< Approximately when was this guard added?
  23. * "0" if we don't know. */
  24. char *chosen_by_version; /**< What tor version added this guard? NULL
  25. * if we don't know. */
  26. unsigned int made_contact : 1; /**< 0 if we have never connected to this
  27. * router, 1 if we have. */
  28. unsigned int can_retry : 1; /**< Should we retry connecting to this entry,
  29. * in spite of having it marked as unreachable?*/
  30. unsigned int path_bias_noticed : 1; /**< Did we alert the user about path
  31. * bias for this node already? */
  32. unsigned int path_bias_warned : 1; /**< Did we alert the user about path bias
  33. * for this node already? */
  34. unsigned int path_bias_extreme : 1; /**< Did we alert the user about path
  35. * bias for this node already? */
  36. unsigned int path_bias_disabled : 1; /**< Have we disabled this node because
  37. * of path bias issues? */
  38. unsigned int path_bias_use_noticed : 1; /**< Did we alert the user about path
  39. * use bias for this node already? */
  40. unsigned int path_bias_use_extreme : 1; /**< Did we alert the user about path
  41. * use bias for this node already? */
  42. unsigned int is_dir_cache : 1; /**< Is this node a directory cache? */
  43. time_t bad_since; /**< 0 if this guard is currently usable, or the time at
  44. * which it was observed to become (according to the
  45. * directory or the user configuration) unusable. */
  46. time_t unreachable_since; /**< 0 if we can connect to this guard, or the
  47. * time at which we first noticed we couldn't
  48. * connect to it. */
  49. time_t last_attempted; /**< 0 if we can connect to this guard, or the time
  50. * at which we last failed to connect to it. */
  51. double circ_attempts; /**< Number of circuits this guard has "attempted" */
  52. double circ_successes; /**< Number of successfully built circuits using
  53. * this guard as first hop. */
  54. double successful_circuits_closed; /**< Number of circuits that carried
  55. * streams successfully. */
  56. double collapsed_circuits; /**< Number of fully built circuits that were
  57. * remotely closed before any streams were
  58. * attempted. */
  59. double unusable_circuits; /**< Number of circuits for which streams were
  60. * attempted, but none succeeded. */
  61. double timeouts; /**< Number of 'right-censored' circuit timeouts for this
  62. * guard. */
  63. double use_attempts; /**< Number of circuits we tried to use with streams */
  64. double use_successes; /**< Number of successfully used circuits using
  65. * this guard as first hop. */
  66. } entry_guard_t;
  67. entry_guard_t *entry_guard_get_by_id_digest(const char *digest);
  68. void entry_guards_changed(void);
  69. const smartlist_t *get_entry_guards(void);
  70. int num_live_entry_guards(int for_directory);
  71. #endif
  72. #ifdef ENTRYNODES_PRIVATE
  73. STATIC const node_t *add_an_entry_guard(const node_t *chosen,
  74. int reset_status, int prepend,
  75. int for_discovery, int for_directory);
  76. STATIC int populate_live_entry_guards(smartlist_t *live_entry_guards,
  77. const smartlist_t *all_entry_guards,
  78. const node_t *chosen_exit,
  79. dirinfo_type_t dirinfo_type,
  80. int for_directory,
  81. int need_uptime, int need_capacity);
  82. STATIC int decide_num_guards(const or_options_t *options, int for_directory);
  83. STATIC void entry_guards_set_from_config(const or_options_t *options);
  84. /** Flags to be passed to entry_is_live() to indicate what kind of
  85. * entry nodes we are looking for. */
  86. typedef enum {
  87. ENTRY_NEED_UPTIME = 1<<0,
  88. ENTRY_NEED_CAPACITY = 1<<1,
  89. ENTRY_ASSUME_REACHABLE = 1<<2,
  90. ENTRY_NEED_DESCRIPTOR = 1<<3,
  91. } entry_is_live_flags_t;
  92. STATIC const node_t *entry_is_live(const entry_guard_t *e,
  93. entry_is_live_flags_t flags,
  94. const char **msg);
  95. STATIC int entry_is_time_to_retry(const entry_guard_t *e, time_t now);
  96. #endif
  97. void remove_all_entry_guards(void);
  98. void entry_guards_compute_status(const or_options_t *options, time_t now);
  99. int entry_guard_register_connect_status(const char *digest, int succeeded,
  100. int mark_relay_status, time_t now);
  101. void entry_nodes_should_be_added(void);
  102. int entry_list_is_constrained(const or_options_t *options);
  103. const node_t *choose_random_entry(cpath_build_state_t *state);
  104. const node_t *choose_random_dirguard(dirinfo_type_t t);
  105. int entry_guards_parse_state(or_state_t *state, int set, char **msg);
  106. void entry_guards_update_state(or_state_t *state);
  107. int getinfo_helper_entry_guards(control_connection_t *conn,
  108. const char *question, char **answer,
  109. const char **errmsg);
  110. void mark_bridge_list(void);
  111. void sweep_bridge_list(void);
  112. int addr_is_a_configured_bridge(const tor_addr_t *addr, uint16_t port,
  113. const char *digest);
  114. int extend_info_is_a_configured_bridge(const extend_info_t *ei);
  115. int routerinfo_is_a_configured_bridge(const routerinfo_t *ri);
  116. int node_is_a_configured_bridge(const node_t *node);
  117. void learned_router_identity(const tor_addr_t *addr, uint16_t port,
  118. const char *digest);
  119. struct bridge_line_t;
  120. void bridge_add_from_config(struct bridge_line_t *bridge_line);
  121. void retry_bridge_descriptor_fetch_directly(const char *digest);
  122. void fetch_bridge_descriptors(const or_options_t *options, time_t now);
  123. void learned_bridge_descriptor(routerinfo_t *ri, int from_cache);
  124. int any_bridge_descriptors_known(void);
  125. int entries_known_but_down(const or_options_t *options);
  126. void entries_retry_all(const or_options_t *options);
  127. int any_bridge_supports_microdescriptors(void);
  128. const smartlist_t *get_socks_args_by_bridge_addrport(const tor_addr_t *addr,
  129. uint16_t port);
  130. int any_bridges_dont_support_microdescriptors(void);
  131. void entry_guards_free_all(void);
  132. const char *find_transport_name_by_bridge_addrport(const tor_addr_t *addr,
  133. uint16_t port);
  134. struct transport_t;
  135. int get_transport_by_bridge_addrport(const tor_addr_t *addr, uint16_t port,
  136. const struct transport_t **transport);
  137. MOCK_DECL(int, transport_is_needed, (const char *transport_name));
  138. int validate_pluggable_transports_config(void);
  139. double pathbias_get_close_success_count(entry_guard_t *guard);
  140. double pathbias_get_use_success_count(entry_guard_t *guard);
  141. /** Contains the bandwidth of a relay as a guard and as a non-guard
  142. * after the guardfraction has been considered. */
  143. typedef struct guardfraction_bandwidth_t {
  144. /** Bandwidth as a guard after guardfraction has been considered. */
  145. int guard_bw;
  146. /** Bandwidth as a non-guard after guardfraction has been considered. */
  147. int non_guard_bw;
  148. } guardfraction_bandwidth_t;
  149. int should_apply_guardfraction(const networkstatus_t *ns);
  150. void
  151. guard_get_guardfraction_bandwidth(guardfraction_bandwidth_t *guardfraction_bw,
  152. int orig_bandwidth,
  153. uint32_t guardfraction_percentage);
  154. MOCK_DECL(smartlist_t *, list_bridge_identities, (void));
  155. MOCK_DECL(download_status_t *, get_bridge_dl_status_by_id,
  156. (const char *digest));
  157. #endif