Tor  0.4.4.0-alpha-dev
circuituse.h
Go to the documentation of this file.
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-2020, 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);
17 void circuit_remove_handled_ports(smartlist_t *needed_ports);
19  int min);
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);
28 
30 
31 void reset_bandwidth_test(void);
33 
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)
51  extend_info_t *info,
52  int flags);
53 origin_circuit_t *circuit_launch(uint8_t purpose, int flags);
54 void circuit_reset_failure_count(int timeout);
56  origin_circuit_t *circ,
57  crypt_path_t *cpath);
59 
60 void circuit_change_purpose(circuit_t *circ, uint8_t new_purpose);
61 
63  const char *address);
65 
67 
68 /* Series of helper functions for hidden services. */
69 bool circuit_purpose_is_hs_client(const uint8_t purpose);
70 bool circuit_purpose_is_hs_service(const uint8_t purpose);
71 bool circuit_purpose_is_hs_vanguards(const uint8_t purpose);
72 
73 bool circuit_is_hs_v2(const circuit_t *circ);
74 bool circuit_is_hs_v3(const circuit_t *circ);
75 
76 int circuit_should_use_vanguards(uint8_t);
77 void circuit_sent_valid_data(origin_circuit_t *circ, uint16_t relay_body_len);
78 void circuit_read_valid_data(origin_circuit_t *circ, uint16_t relay_body_len);
79 
80 #ifdef TOR_UNIT_TESTS
81 /* Used only by circuituse.c and test_circuituse.c */
82 
83 STATIC int circuit_is_available_for_use(const circuit_t *circ);
84 
85 STATIC int needs_exit_circuits(time_t now,
86  int *port_needs_uptime,
87  int *port_needs_capacity);
88 STATIC int needs_hs_server_circuits(time_t now,
89  int num_uptime_internal);
90 
91 STATIC int needs_hs_client_circuits(time_t now,
92  int *needs_uptime,
93  int *needs_capacity,
94  int num_internal,
95  int num_uptime_internal);
96 
97 STATIC int needs_circuits_for_build(int num);
98 
99 #endif /* defined(TOR_UNIT_TESTS) */
100 
101 #endif /* !defined(TOR_CIRCUITUSE_H) */
102 
void circuit_expire_building(void)
Definition: circuituse.c:457
void circuit_detach_stream(circuit_t *circ, edge_connection_t *conn)
Definition: circuituse.c:1388
void reset_bandwidth_test(void)
Definition: circuituse.c:1607
int connection_ap_handshake_attach_circuit(entry_connection_t *conn)
Definition: circuituse.c:2847
int circuit_enough_testing_circs(void)
Definition: circuituse.c:1617
bool circuit_is_hs_v2(const circuit_t *circ)
Definition: circuituse.c:2006
int circuit_purpose_is_hidden_service(uint8_t)
Definition: circuituse.c:1961
int hostname_in_track_host_exits(const or_options_t *options, const char *address)
Definition: circuituse.c:2702
int circuit_should_use_vanguards(uint8_t)
Definition: circuituse.c:2031
int circuit_stream_is_being_handled(entry_connection_t *conn, uint16_t port, int min)
Definition: circuituse.c:1035
void circuit_sent_valid_data(origin_circuit_t *circ, uint16_t relay_body_len)
Definition: circuituse.c:3163
void circuit_try_attaching_streams(origin_circuit_t *circ)
Definition: circuituse.c:1755
void circuit_build_needed_circs(time_t now)
Definition: circuituse.c:1334
#define STATIC
Definition: testsupport.h:32
void circuit_expire_waiting_for_better_guard(void)
Definition: circuituse.c:854
void circuit_read_valid_data(origin_circuit_t *circ, uint16_t relay_body_len)
Definition: circuituse.c:3184
void mark_circuit_unusable_for_new_conns(origin_circuit_t *circ)
Definition: circuituse.c:3139
void circuit_reset_failure_count(int timeout)
Definition: circuituse.c:2228
void circuit_change_purpose(circuit_t *circ, uint8_t new_purpose)
Definition: circuituse.c:3095
void circuit_log_ancient_one_hop_circuits(int age)
Definition: circuituse.c:878
void circuit_has_opened(origin_circuit_t *circ)
Definition: circuituse.c:1681
void circuit_expire_old_circuits_serverside(time_t now)
Definition: circuituse.c:1568
void circuit_remove_handled_ports(smartlist_t *needed_ports)
Definition: circuituse.c:1010
bool circuit_is_hs_v3(const circuit_t *circ)
Definition: circuituse.c:2014
bool circuit_purpose_is_hs_vanguards(const uint8_t purpose)
Definition: circuituse.c:1999
void circuit_build_failed(origin_circuit_t *circ)
Definition: circuituse.c:1772
void circuit_expire_old_circs_as_needed(time_t now)
Definition: circuituse.c:1357
origin_circuit_t * circuit_launch(uint8_t purpose, int flags)
Definition: circuituse.c:1938
origin_circuit_t * circuit_launch_by_extend_info(uint8_t purpose, extend_info_t *info, int flags)
Definition: circuituse.c:2101
int connection_ap_handshake_attach_chosen_circuit(entry_connection_t *conn, origin_circuit_t *circ, crypt_path_t *cpath)
Definition: circuituse.c:2762
bool circuit_purpose_is_hs_service(const uint8_t purpose)
Definition: circuituse.c:1991
bool circuit_purpose_is_hs_client(const uint8_t purpose)
Definition: circuituse.c:1983