src/core/or/circuituse.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-2021, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file circuituse.h
   9  * \brief Header file for circuituse.c.
  10  **/
  11
  12 #ifndef TOR_CIRCUITUSE_H
  13 #define TOR_CIRCUITUSE_H
  14
  15 void circuit_expire_building(void);
  16 void circuit_expire_waiting_for_better_guard(void);
  17 void circuit_remove_handled_ports(smartlist_t *needed_ports);
  18 int circuit_stream_is_being_handled(entry_connection_t *conn, uint16_t port,
  19                                     int min);
  20 void circuit_log_ancient_one_hop_circuits(int age);
  21 #if 0
  22 int circuit_conforms_to_options(const origin_circuit_t *circ,
  23                                 const or_options_t *options);
  24 #endif
  25 void circuit_build_needed_circs(time_t now);
  26 void circuit_expire_old_circs_as_needed(time_t now);
  27 void circuit_detach_stream(circuit_t *circ, edge_connection_t *conn);
  28
  29 void circuit_expire_old_circuits_serverside(time_t now);
  30
  31 void reset_bandwidth_test(void);
  32 int circuit_enough_testing_circs(void);
  33
  34 void circuit_has_opened(origin_circuit_t *circ);
  35 void circuit_try_attaching_streams(origin_circuit_t *circ);
  36 void circuit_build_failed(origin_circuit_t *circ);
  37
  38 /** Flag to set when a circuit should have only a single hop. */
  39 #define CIRCLAUNCH_ONEHOP_TUNNEL    (1<<0)
  40 /** Flag to set when a circuit needs to be built of high-uptime nodes */
  41 #define CIRCLAUNCH_NEED_UPTIME      (1<<1)
  42 /** Flag to set when a circuit needs to be built of high-capacity nodes */
  43 #define CIRCLAUNCH_NEED_CAPACITY    (1<<2)
  44 /** Flag to set when the last hop of a circuit doesn't need to be an
  45  * exit node. */
  46 #define CIRCLAUNCH_IS_INTERNAL      (1<<3)
  47 /** Flag to set when we are trying to launch a v3 rendezvous circuit. We need
  48  *  to apply some additional filters on the node picked. */
  49 #define CIRCLAUNCH_IS_V3_RP         (1<<4)
  50 /** Flag to set when we are trying to launch a self-testing circuit to our
  51  *  IPv6 ORPort. We need to apply some additional filters on the second-last
  52  *  node in the circuit. (We are both the client and the last node in the
  53  *  circuit.) */
  54 #define CIRCLAUNCH_IS_IPV6_SELFTEST (1<<5)
  55 /** Flag to set when a circuit needs the exit to support conflux. */
  56 #define CIRCLAUNCH_NEED_CONFLUX     (1<<6)
  57
  58 origin_circuit_t *circuit_launch_by_extend_info(uint8_t purpose,
  59                                                 extend_info_t *info,
  60                                                 int flags);
  61 origin_circuit_t *circuit_launch(uint8_t purpose, int flags);
  62 void circuit_reset_failure_count(int timeout);
  63 int connection_ap_handshake_attach_chosen_circuit(entry_connection_t *conn,
  64                                                   origin_circuit_t *circ,
  65                                                   crypt_path_t *cpath);
  66 int connection_ap_handshake_attach_circuit(entry_connection_t *conn);
  67
  68 void circuit_change_purpose(circuit_t *circ, uint8_t new_purpose);
  69
  70 int hostname_in_track_host_exits(const or_options_t *options,
  71                                  const char *address);
  72 void mark_circuit_unusable_for_new_conns(origin_circuit_t *circ);
  73
  74 int circuit_purpose_is_hidden_service(uint8_t);
  75
  76 /* Series of helper functions for hidden services. */
  77 bool circuit_purpose_is_hs_client(const uint8_t purpose);
  78 bool circuit_purpose_is_hs_service(const uint8_t purpose);
  79 bool circuit_purpose_is_hs_vanguards(const uint8_t purpose);
  80
  81 bool circuit_is_hs_v3(const circuit_t *circ);
  82 int circuit_is_acceptable(const origin_circuit_t *origin_circ,
  83                           const entry_connection_t *conn,
  84                           int must_be_open, uint8_t purpose,
  85                           int need_uptime, int need_internal,
  86                           time_t now);
  87
  88 int circuit_should_use_vanguards(uint8_t);
  89 void circuit_sent_valid_data(origin_circuit_t *circ, uint16_t relay_body_len);
  90 void circuit_read_valid_data(origin_circuit_t *circ, uint16_t relay_body_len);
  91
  92 #ifdef TOR_UNIT_TESTS
  93 /* Used only by circuituse.c and test_circuituse.c */
  94
  95 STATIC int circuit_is_available_for_use(const circuit_t *circ);
  96
  97 STATIC int needs_exit_circuits(time_t now,
  98                                int *port_needs_uptime,
  99                                int *port_needs_capacity);
 100 STATIC int needs_hs_server_circuits(time_t now,
 101                                     int num_uptime_internal);
 102
 103 STATIC int needs_hs_client_circuits(time_t now,
 104                                     int *needs_uptime,
 105                                     int *needs_capacity,
 106                                     int num_internal,
 107                                     int num_uptime_internal);
 108
 109 STATIC int needs_circuits_for_build(int num);
 110
 111 #endif /* defined(TOR_UNIT_TESTS) */
 112
 113 #endif /* !defined(TOR_CIRCUITUSE_H) */
 114