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-2017, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Header file for nodelist.c.
12 #ifndef TOR_NODELIST_H
13 #define TOR_NODELIST_H
15 #define node_assert_ok(n) STMT_BEGIN { \
16 tor_assert((n)->ri || (n)->rs); \
19 node_t
*node_get_mutable_by_id(const char *identity_digest
);
20 MOCK_DECL(const node_t
*, node_get_by_id
, (const char *identity_digest
));
21 node_t
*node_get_mutable_by_ed25519_id(const ed25519_public_key_t
*ed_id
);
22 MOCK_DECL(const node_t
*, node_get_by_ed25519_id
,
23 (const ed25519_public_key_t
*ed_id
));
25 #define NNF_NO_WARN_UNNAMED (1u<<0)
27 const node_t
*node_get_by_hex_id(const char *identity_digest
,
29 node_t
*nodelist_set_routerinfo(routerinfo_t
*ri
, routerinfo_t
**ri_old_out
);
30 node_t
*nodelist_add_microdesc(microdesc_t
*md
);
31 void nodelist_set_consensus(networkstatus_t
*ns
);
33 void nodelist_remove_microdesc(const char *identity_digest
, microdesc_t
*md
);
34 void nodelist_remove_routerinfo(routerinfo_t
*ri
);
35 void nodelist_purge(void);
36 smartlist_t
*nodelist_find_nodes_with_microdesc(const microdesc_t
*md
);
38 void nodelist_recompute_all_hsdir_indices(void);
40 void nodelist_free_all(void);
41 void nodelist_assert_ok(void);
43 MOCK_DECL(const node_t
*, node_get_by_nickname
,
44 (const char *nickname
, unsigned flags
));
45 void node_get_verbose_nickname(const node_t
*node
,
46 char *verbose_name_out
);
47 void node_get_verbose_nickname_by_id(const char *id_digest
,
48 char *verbose_name_out
);
49 int node_is_dir(const node_t
*node
);
50 int node_has_descriptor(const node_t
*node
);
51 int node_get_purpose(const node_t
*node
);
52 #define node_is_bridge(node) \
53 (node_get_purpose((node)) == ROUTER_PURPOSE_BRIDGE)
54 int node_is_me(const node_t
*node
);
55 int node_exit_policy_rejects_all(const node_t
*node
);
56 int node_exit_policy_is_exact(const node_t
*node
, sa_family_t family
);
57 smartlist_t
*node_get_all_orports(const node_t
*node
);
58 int node_allows_single_hop_exits(const node_t
*node
);
59 const char *node_get_nickname(const node_t
*node
);
60 const char *node_get_platform(const node_t
*node
);
61 uint32_t node_get_prim_addr_ipv4h(const node_t
*node
);
62 void node_get_address_string(const node_t
*node
, char *cp
, size_t len
);
63 long node_get_declared_uptime(const node_t
*node
);
64 const smartlist_t
*node_get_declared_family(const node_t
*node
);
65 const ed25519_public_key_t
*node_get_ed25519_id(const node_t
*node
);
66 int node_ed25519_id_matches(const node_t
*node
,
67 const ed25519_public_key_t
*id
);
68 int node_supports_ed25519_link_authentication(const node_t
*node
);
69 int node_supports_v3_hsdir(const node_t
*node
);
70 int node_supports_ed25519_hs_intro(const node_t
*node
);
71 int node_supports_v3_rendezvous_point(const node_t
*node
);
72 const uint8_t *node_get_rsa_id_digest(const node_t
*node
);
74 int node_has_ipv6_addr(const node_t
*node
);
75 int node_has_ipv6_orport(const node_t
*node
);
76 int node_has_ipv6_dirport(const node_t
*node
);
77 /* Deprecated - use node_ipv6_or_preferred or node_ipv6_dir_preferred */
78 #define node_ipv6_preferred(node) node_ipv6_or_preferred(node)
79 int node_ipv6_or_preferred(const node_t
*node
);
80 int node_get_prim_orport(const node_t
*node
, tor_addr_port_t
*ap_out
);
81 void node_get_pref_orport(const node_t
*node
, tor_addr_port_t
*ap_out
);
82 void node_get_pref_ipv6_orport(const node_t
*node
, tor_addr_port_t
*ap_out
);
83 int node_ipv6_dir_preferred(const node_t
*node
);
84 int node_get_prim_dirport(const node_t
*node
, tor_addr_port_t
*ap_out
);
85 void node_get_pref_dirport(const node_t
*node
, tor_addr_port_t
*ap_out
);
86 void node_get_pref_ipv6_dirport(const node_t
*node
, tor_addr_port_t
*ap_out
);
87 int node_has_curve25519_onion_key(const node_t
*node
);
89 MOCK_DECL(smartlist_t
*, nodelist_get_list
, (void));
91 /* Temporary during transition to multiple addresses. */
92 void node_get_addr(const node_t
*node
, tor_addr_t
*addr_out
);
93 #define node_get_addr_ipv4h(n) node_get_prim_addr_ipv4h((n))
95 void nodelist_refresh_countries(void);
96 void node_set_country(node_t
*node
);
97 void nodelist_add_node_and_family(smartlist_t
*nodes
, const node_t
*node
);
98 int nodes_in_same_family(const node_t
*node1
, const node_t
*node2
);
100 const node_t
*router_find_exact_exit_enclave(const char *address
,
102 int node_is_unreliable(const node_t
*router
, int need_uptime
,
103 int need_capacity
, int need_guard
);
104 int router_exit_policy_all_nodes_reject(const tor_addr_t
*addr
, uint16_t port
,
106 void router_set_status(const char *digest
, int up
);
107 int addrs_in_same_network_family(const tor_addr_t
*a1
,
108 const tor_addr_t
*a2
);
110 /** router_have_minimum_dir_info tests to see if we have enough
111 * descriptor information to create circuits.
112 * If there are exits in the consensus, we wait until we have enough
113 * info to create exit paths before creating any circuits. If there are
114 * no exits in the consensus, we wait for enough info to create internal
115 * paths, and should avoid creating exit paths, as they will simply fail.
116 * We make sure we create all available circuit types at the same time. */
117 MOCK_DECL(int, router_have_minimum_dir_info
,(void));
119 /** Set to CONSENSUS_PATH_EXIT if there is at least one exit node
120 * in the consensus. We update this flag in compute_frac_paths_available if
121 * there is at least one relay that has an Exit flag in the consensus.
122 * Used to avoid building exit circuits when they will almost certainly fail.
123 * Set to CONSENSUS_PATH_INTERNAL if there are no exits in the consensus.
124 * (This situation typically occurs during bootstrap of a test network.)
125 * Set to CONSENSUS_PATH_UNKNOWN if we have never checked, or have
126 * reason to believe our last known value was invalid or has expired.
129 /* we haven't checked yet, or we have invalidated our previous check */
130 CONSENSUS_PATH_UNKNOWN
= -1,
131 /* The consensus only has internal relays, and we should only
132 * create internal paths, circuits, streams, ... */
133 CONSENSUS_PATH_INTERNAL
= 0,
134 /* The consensus has at least one exit, and can therefore (potentially)
135 * create exit and internal paths, circuits, streams, ... */
136 CONSENSUS_PATH_EXIT
= 1
137 } consensus_path_type_t
;
139 MOCK_DECL(consensus_path_type_t
, router_have_consensus_path
, (void));
141 void router_dir_info_changed(void);
142 const char *get_dir_info_status_string(void);
143 int count_loading_descriptors_progress(void);
145 #ifdef NODELIST_PRIVATE
147 #ifdef TOR_UNIT_TESTS
150 node_set_hsdir_index(node_t
*node
, const networkstatus_t
*ns
);
152 #endif /* defined(TOR_UNIT_TESTS) */
154 #endif /* defined(NODELIST_PRIVATE) */
156 #endif /* !defined(TOR_NODELIST_H) */