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 */
7 /**
8  * \file nodelist.h
9  * \brief Header file for nodelist.c.
10  **/
12 #ifndef TOR_NODELIST_H
13 #define TOR_NODELIST_H
18 #define node_assert_ok(n) STMT_BEGIN { \
19  tor_assert((n)->ri || (n)->rs); \
20  } STMT_END
22 MOCK_DECL(node_t *, node_get_mutable_by_id,(const char *identity_digest));
23 MOCK_DECL(const node_t *, node_get_by_id, (const char *identity_digest));
25  const struct ed25519_public_key_t *ed_id);
27  (const struct ed25519_public_key_t *ed_id));
29 #define NNF_NO_WARN_UNNAMED (1u<<0)
31 const node_t *node_get_by_hex_id(const char *identity_digest,
32  unsigned flags);
38 void nodelist_add_addr4_to_address_set(const uint32_t addr);
41 void nodelist_remove_microdesc(const char *identity_digest, microdesc_t *md);
43 void nodelist_purge(void);
46 void nodelist_free_all(void);
47 void nodelist_assert_ok(void);
50  (const char *nickname, unsigned flags));
51 void node_get_verbose_nickname(const node_t *node,
52  char *verbose_name_out);
53 void node_get_verbose_nickname_by_id(const char *id_digest,
54  char *verbose_name_out);
55 int node_is_dir(const node_t *node);
56 int node_is_good_exit(const node_t *node);
57 int node_has_any_descriptor(const node_t *node);
59  int for_direct_connect);
60 int node_get_purpose(const node_t *node);
61 #define node_is_bridge(node) \
62  (node_get_purpose((node)) == ROUTER_PURPOSE_BRIDGE)
63 int node_is_me(const node_t *node);
64 int node_exit_policy_rejects_all(const node_t *node);
65 int node_exit_policy_is_exact(const node_t *node, sa_family_t family);
67 int node_allows_single_hop_exits(const node_t *node);
68 const char *node_get_nickname(const node_t *node);
69 const char *node_get_platform(const node_t *node);
70 uint32_t node_get_prim_addr_ipv4h(const node_t *node);
71 void node_get_address_string(const node_t *node, char *cp, size_t len);
72 long node_get_declared_uptime(const node_t *node);
73 const struct ed25519_public_key_t *node_get_ed25519_id(const node_t *node);
74 int node_ed25519_id_matches(const node_t *node,
75  const struct ed25519_public_key_t *id);
77  int compatible_with_us);
78 int node_supports_v3_hsdir(const node_t *node);
79 int node_supports_ed25519_hs_intro(const node_t *node);
82 const uint8_t *node_get_rsa_id_digest(const node_t *node);
83 MOCK_DECL(smartlist_t *,node_get_link_specifier_smartlist,(const node_t *node,
84  bool direct_conn));
85 void link_specifier_smartlist_free_(smartlist_t *ls_list);
86 #define link_specifier_smartlist_free(ls_list) \
87  FREE_AND_NULL(smartlist_t, link_specifier_smartlist_free_, (ls_list))
89 int node_has_ipv6_addr(const node_t *node);
90 int node_has_ipv6_orport(const node_t *node);
91 int node_has_ipv6_dirport(const node_t *node);
92 /* Deprecated - use node_ipv6_or_preferred or node_ipv6_dir_preferred */
93 #define node_ipv6_preferred(node) node_ipv6_or_preferred(node)
94 int node_ipv6_or_preferred(const node_t *node);
95 void node_get_prim_orport(const node_t *node, tor_addr_port_t *ap_out);
96 void node_get_pref_orport(const node_t *node, tor_addr_port_t *ap_out);
97 void node_get_pref_ipv6_orport(const node_t *node, tor_addr_port_t *ap_out);
98 int node_ipv6_dir_preferred(const node_t *node);
99 void node_get_prim_dirport(const node_t *node, tor_addr_port_t *ap_out);
100 void node_get_pref_dirport(const node_t *node, tor_addr_port_t *ap_out);
101 void node_get_pref_ipv6_dirport(const node_t *node, tor_addr_port_t *ap_out);
102 int node_has_curve25519_onion_key(const node_t *node);
104  const node_t *node);
105 crypto_pk_t *node_get_rsa_onion_key(const node_t *node);
107 MOCK_DECL(const smartlist_t *, nodelist_get_list, (void));
109 /* Temporary during transition to multiple addresses. */
110 void node_get_addr(const node_t *node, tor_addr_t *addr_out);
111 #define node_get_addr_ipv4h(n) node_get_prim_addr_ipv4h((n))
113 void nodelist_refresh_countries(void);
114 void node_set_country(node_t *node);
115 void nodelist_add_node_and_family(smartlist_t *nodes, const node_t *node);
116 int nodes_in_same_family(const node_t *node1, const node_t *node2);
118 const node_t *router_find_exact_exit_enclave(const char *address,
119  uint16_t port);
120 int node_is_unreliable(const node_t *router, int need_uptime,
121  int need_capacity, int need_guard);
122 int router_exit_policy_all_nodes_reject(const tor_addr_t *addr, uint16_t port,
123  int need_uptime);
124 void router_set_status(const char *digest, int up);
126  const tor_addr_t *a2);
128 /** router_have_minimum_dir_info tests to see if we have enough
129  * descriptor information to create circuits.
130  * If there are exits in the consensus, we wait until we have enough
131  * info to create exit paths before creating any circuits. If there are
132  * no exits in the consensus, we wait for enough info to create internal
133  * paths, and should avoid creating exit paths, as they will simply fail.
134  * We make sure we create all available circuit types at the same time. */
137 /** Set to CONSENSUS_PATH_EXIT if there is at least one exit node
138  * in the consensus. We update this flag in compute_frac_paths_available if
139  * there is at least one relay that has an Exit flag in the consensus.
140  * Used to avoid building exit circuits when they will almost certainly fail.
141  * Set to CONSENSUS_PATH_INTERNAL if there are no exits in the consensus.
142  * (This situation typically occurs during bootstrap of a test network.)
143  * Set to CONSENSUS_PATH_UNKNOWN if we have never checked, or have
144  * reason to believe our last known value was invalid or has expired.
145  */
146 typedef enum {
147  /* we haven't checked yet, or we have invalidated our previous check */
149  /* The consensus only has internal relays, and we should only
150  * create internal paths, circuits, streams, ... */
152  /* The consensus has at least one exit, and can therefore (potentially)
153  * create exit and internal paths, circuits, streams, ... */
159 void router_dir_info_changed(void);
160 const char *get_dir_info_status_string(void);
165 STATIC int node_nickname_matches(const node_t *node, const char *nickname);
167  const node_t *node);
168 STATIC int node_family_contains(const node_t *n1, const node_t *n2);
169 STATIC bool node_has_declared_family(const node_t *node);
170 STATIC void node_lookup_declared_family(smartlist_t *out, const node_t *node);
172 #ifdef TOR_UNIT_TESTS
174 STATIC void node_set_hsdir_index(node_t *node, const networkstatus_t *ns);
176 #endif /* defined(TOR_UNIT_TESTS) */
178 #endif /* defined(NODELIST_PRIVATE) */
180 MOCK_DECL(int, get_estimated_address_per_node, (void));
182 #endif /* !defined(TOR_NODELIST_H) */
const node_t * router_find_exact_exit_enclave(const char *address, uint16_t port)
Definition: nodelist.c:2201
int node_is_dir(const node_t *node)
Definition: nodelist.c:1342
const char * node_get_nickname(const node_t *node)
Definition: nodelist.c:1328
const node_t * node_get_by_nickname(const char *nickname, unsigned flags)
Definition: nodelist.c:1013
int node_exit_policy_is_exact(const node_t *node, sa_family_t family)
Definition: nodelist.c:1474
Definition: node_st.h:34
node_t * nodelist_set_routerinfo(routerinfo_t *ri, routerinfo_t **ri_old_out)
Definition: nodelist.c:514
uint16_t sa_family_t
Definition: inaddr_st.h:77
int node_is_me(const node_t *node)
Definition: nodelist.c:1635
void node_get_verbose_nickname(const node_t *node, char *verbose_name_out)
Definition: nodelist.c:1411
int node_has_any_descriptor(const node_t *node)
Definition: nodelist.c:1365
const struct ed25519_public_key_t * node_get_ed25519_id(const node_t *node)
Definition: nodelist.c:1078
smartlist_t * node_get_all_orports(const node_t *node)
Definition: nodelist.c:1531
void node_get_addr(const node_t *node, tor_addr_t *addr_out)
Definition: nodelist.c:1569
int node_ipv6_dir_preferred(const node_t *node)
Definition: nodelist.c:1799
long node_get_declared_uptime(const node_t *node)
Definition: nodelist.c:1612
void node_get_pref_dirport(const node_t *node, tor_addr_port_t *ap_out)
Definition: nodelist.c:1845
int node_is_unreliable(const node_t *router, int need_uptime, int need_capacity, int need_guard)
Definition: nodelist.c:2232
int addrs_in_same_network_family(const tor_addr_t *a1, const tor_addr_t *a2)
Definition: nodelist.c:1987
uint32_t node_get_prim_addr_ipv4h(const node_t *node)
Definition: nodelist.c:1579
node_t * node_get_mutable_by_id(const char *identity_digest)
Definition: nodelist.c:194
void node_get_pref_ipv6_orport(const node_t *node, tor_addr_port_t *ap_out)
Definition: nodelist.c:1757
const uint8_t * node_get_rsa_id_digest(const node_t *node)
Definition: nodelist.c:1224
int node_supports_ed25519_link_authentication(const node_t *node, int compatible_with_us)
Definition: nodelist.c:1162
STATIC void node_lookup_declared_family(smartlist_t *out, const node_t *node)
Definition: nodelist.c:2068
Definition: nodelist.h:146
void nodelist_free_all(void)
Definition: nodelist.c:854
#define STATIC
Definition: testsupport.h:32
void nodelist_remove_microdesc(const char *identity_digest, microdesc_t *md)
Definition: nodelist.c:740
void node_set_country(node_t *node)
Definition: nodelist.c:1962
STATIC int node_family_contains(const node_t *n1, const node_t *n2)
Definition: nodelist.c:2033
int node_exit_policy_rejects_all(const node_t *node)
Definition: nodelist.c:1457
int router_exit_policy_all_nodes_reject(const tor_addr_t *addr, uint16_t port, int need_uptime)
Definition: nodelist.c:2247
void nodelist_set_consensus(networkstatus_t *ns)
Definition: nodelist.c:624
const char * get_dir_info_status_string(void)
Definition: nodelist.c:2378
int node_allows_single_hop_exits(const node_t *node)
Definition: nodelist.c:1446
int node_supports_establish_intro_dos_extension(const node_t *node)
Definition: nodelist.c:1199
consensus_path_type_t router_have_consensus_path(void)
Definition: nodelist.c:2357
int node_supports_v3_rendezvous_point(const node_t *node)
Definition: nodelist.c:1210
void nodelist_refresh_countries(void)
Definition: nodelist.c:1977
int node_supports_ed25519_hs_intro(const node_t *node)
Definition: nodelist.c:1189
void nodelist_ensure_freshness(networkstatus_t *ns)
Definition: nodelist.c:955
void node_get_pref_ipv6_dirport(const node_t *node, tor_addr_port_t *ap_out)
Definition: nodelist.c:1860
int router_have_minimum_dir_info(void)
Definition: nodelist.c:2324
void nodelist_remove_routerinfo(routerinfo_t *ri)
Definition: nodelist.c:754
smartlist_t * nodelist_find_nodes_with_microdesc(const microdesc_t *md)
Definition: nodelist.c:794
void router_set_status(const char *digest, int up)
Definition: nodelist.c:2268
STATIC bool node_has_declared_family(const node_t *node)
Definition: nodelist.c:2048
int node_supports_v3_hsdir(const node_t *node)
Definition: nodelist.c:1179
int node_has_preferred_descriptor(const node_t *node, int for_direct_connect)
Definition: nodelist.c:1378
int nodes_in_same_family(const node_t *node1, const node_t *node2)
Definition: nodelist.c:2089
void router_dir_info_changed(void)
Definition: nodelist.c:2367
int nodelist_probably_contains_address(const tor_addr_t *addr)
Definition: nodelist.c:498
void node_get_pref_orport(const node_t *node, tor_addr_port_t *ap_out)
Definition: nodelist.c:1742
void nodelist_add_addr4_to_address_set(const uint32_t addr)
Definition: nodelist.c:476
void node_get_verbose_nickname_by_id(const char *id_digest, char *verbose_name_out)
Definition: nodelist.c:1431
const char * node_get_platform(const node_t *node)
Definition: nodelist.c:1622
const struct curve25519_public_key_t * node_get_curve25519_onion_key(const node_t *node)
Definition: nodelist.c:1916
int node_has_curve25519_onion_key(const node_t *node)
Definition: nodelist.c:1909
const node_t * node_get_by_id(const char *identity_digest)
Definition: nodelist.c:223
void node_get_prim_orport(const node_t *node, tor_addr_port_t *ap_out)
Definition: nodelist.c:1721
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
void nodelist_add_addr6_to_address_set(const tor_addr_t *addr)
Definition: nodelist.c:486
const node_t * node_get_by_hex_id(const char *identity_digest, unsigned flags)
Definition: nodelist.c:986
int node_ed25519_id_matches(const node_t *node, const ed25519_public_key_t *id)
Definition: nodelist.c:1123
node_t * nodelist_add_microdesc(microdesc_t *md)
Definition: nodelist.c:570
void nodelist_purge(void)
Definition: nodelist.c:825
int node_get_purpose(const node_t *node)
Definition: nodelist.c:1399
STATIC int node_in_nickname_smartlist(const smartlist_t *lst, const node_t *node)
Definition: nodelist.c:2021
const smartlist_t * nodelist_get_list(void)
Definition: nodelist.c:975
void node_get_prim_dirport(const node_t *node, tor_addr_port_t *ap_out)
Definition: nodelist.c:1822
void nodelist_add_node_and_family(smartlist_t *nodes, const node_t *node)
Definition: nodelist.c:2136
void node_get_address_string(const node_t *node, char *cp, size_t len)
Definition: nodelist.c:1596
void nodelist_assert_ok(void)
Definition: nodelist.c:878
int node_is_good_exit(const node_t *node)
Definition: nodelist.c:725
STATIC int node_nickname_matches(const node_t *node, const char *nickname)
Definition: nodelist.c:2009
int node_ipv6_or_preferred(const node_t *node)
Definition: nodelist.c:1691
node_t * node_get_mutable_by_ed25519_id(const ed25519_public_key_t *ed_id)
Definition: nodelist.c:207
const node_t * node_get_by_ed25519_id(const ed25519_public_key_t *ed_id)
Definition: nodelist.c:231
int count_loading_descriptors_progress(void)
Definition: nodelist.c:2668