tor_relay_selection/
lib.rs

1#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
2#![doc = include_str!("../README.md")]
3// @@ begin lint list maintained by maint/add_warning @@
4#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)
5#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)
6#![warn(missing_docs)]
7#![warn(noop_method_call)]
8#![warn(unreachable_pub)]
9#![warn(clippy::all)]
10#![deny(clippy::await_holding_lock)]
11#![deny(clippy::cargo_common_metadata)]
12#![deny(clippy::cast_lossless)]
13#![deny(clippy::checked_conversions)]
14#![warn(clippy::cognitive_complexity)]
15#![deny(clippy::debug_assert_with_mut_call)]
16#![deny(clippy::exhaustive_enums)]
17#![deny(clippy::exhaustive_structs)]
18#![deny(clippy::expl_impl_clone_on_copy)]
19#![deny(clippy::fallible_impl_from)]
20#![deny(clippy::implicit_clone)]
21#![deny(clippy::large_stack_arrays)]
22#![warn(clippy::manual_ok_or)]
23#![deny(clippy::missing_docs_in_private_items)]
24#![warn(clippy::needless_borrow)]
25#![warn(clippy::needless_pass_by_value)]
26#![warn(clippy::option_option)]
27#![deny(clippy::print_stderr)]
28#![deny(clippy::print_stdout)]
29#![warn(clippy::rc_buffer)]
30#![deny(clippy::ref_option_ref)]
31#![warn(clippy::semicolon_if_nothing_returned)]
32#![warn(clippy::trait_duplication_in_bounds)]
33#![deny(clippy::unchecked_duration_subtraction)]
34#![deny(clippy::unnecessary_wraps)]
35#![warn(clippy::unseparated_literal_suffix)]
36#![deny(clippy::unwrap_used)]
37#![deny(clippy::mod_module_files)]
38#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
39#![allow(clippy::uninlined_format_args)]
40#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
41#![allow(clippy::result_large_err)] // temporary workaround for arti#587
42#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
43#![allow(clippy::needless_lifetimes)] // See arti#1765
44#![allow(mismatched_lifetime_syntaxes)] // temporary workaround for arti#2060
45//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
46
47mod config;
48mod restriction;
49mod selector;
50mod target_port;
51mod usage;
52
53pub use config::RelaySelectionConfig;
54pub use restriction::{RelayExclusion, RelayRestriction};
55pub use selector::{RelaySelector, SelectionInfo};
56pub use target_port::TargetPort;
57pub use usage::RelayUsage;
58
59/// A property that can be provided by relays.
60///
61/// The predicates that implement this trait are typically lower level ones that
62/// represent only some of the properties that need to be checked before a relay
63/// can be used.  Code should generally use RelaySelector instead.
64pub trait LowLevelRelayPredicate {
65    /// Return true if `relay` provides this predicate.
66    fn low_level_predicate_permits_relay(&self, relay: &tor_netdir::Relay<'_>) -> bool;
67}
68
69/// Helper module for our tests.
70#[cfg(test)]
71pub(crate) mod testing {
72    // @@ begin test lint list maintained by maint/add_warning @@
73    #![allow(clippy::bool_assert_comparison)]
74    #![allow(clippy::clone_on_copy)]
75    #![allow(clippy::dbg_macro)]
76    #![allow(clippy::mixed_attributes_style)]
77    #![allow(clippy::print_stderr)]
78    #![allow(clippy::print_stdout)]
79    #![allow(clippy::single_char_pattern)]
80    #![allow(clippy::unwrap_used)]
81    #![allow(clippy::unchecked_duration_subtraction)]
82    #![allow(clippy::useless_vec)]
83    #![allow(clippy::needless_pass_by_value)]
84    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
85
86    use crate::{LowLevelRelayPredicate, RelaySelectionConfig};
87    use std::collections::HashSet;
88    use std::sync::LazyLock;
89    use tor_netdir::{NetDir, Relay, SubnetConfig};
90    use tor_netdoc::doc::netstatus::RelayFlags;
91
92    /// Use a predicate to divide a NetDir into the relays that do and do not
93    /// conform (respectively).
94    ///
95    /// # Panics
96    ///
97    /// Panics if either the "yes" list or the "no" list is empty, to ensure
98    /// that all of our tests are really testing something.
99    pub(crate) fn split_netdir<'a, P: LowLevelRelayPredicate>(
100        netdir: &'a NetDir,
101        pred: &P,
102    ) -> (Vec<Relay<'a>>, Vec<Relay<'a>>) {
103        let (yes, no): (Vec<_>, Vec<_>) = netdir
104            .relays()
105            .partition(|r| pred.low_level_predicate_permits_relay(r));
106        assert!(!yes.is_empty());
107        assert!(!no.is_empty());
108        (yes, no)
109    }
110
111    /// Return a basic configuration.
112    pub(crate) fn cfg() -> RelaySelectionConfig<'static> {
113        static STABLE_PORTS: LazyLock<HashSet<u16>> = LazyLock::new(|| [22].into_iter().collect());
114        RelaySelectionConfig {
115            long_lived_ports: &STABLE_PORTS,
116            subnet_config: SubnetConfig::default(),
117        }
118    }
119
120    // Construct a test network to exercise the various cases in this crate.
121    pub(crate) fn testnet() -> NetDir {
122        tor_netdir::testnet::construct_custom_netdir(|idx, node, _| {
123            if idx % 7 == 0 {
124                node.rs.clear_flags(RelayFlags::FAST);
125            }
126            if idx % 5 == 0 {
127                node.rs.clear_flags(RelayFlags::STABLE);
128            };
129        })
130        .unwrap()
131        .unwrap_if_sufficient()
132        .unwrap()
133    }
134}
tor_relay_selection/lib.rs

tor_relay_selection/
lib.rs
