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

            
47
// TODO #2010: Remove this global allow, and either propagate it to the functions that need it,
48
// or make those functions less complex.
49
#![allow(clippy::cognitive_complexity)]
50
// TODO #1645 (either remove this, or decide to have it everywhere)
51
#![cfg_attr(
52
    not(all(feature = "full", feature = "experimental")),
53
    allow(unused, unreachable_pub)
54
)]
55

            
56
#[cfg(feature = "bench")]
57
pub mod bench_utils;
58
pub mod channel;
59
mod congestion;
60
mod crypto;
61
pub mod memquota;
62
pub mod stream;
63
pub(crate) mod tunnel;
64
mod util;
65

            
66
pub use util::err::{Error, ResolveError};
67
pub use util::skew::ClockSkew;
68

            
69
pub use channel::params::ChannelPaddingInstructions;
70
pub use congestion::params as ccparams;
71
pub use crypto::cell::{HopNum, HopNumDisplay};
72
pub use tunnel::{circuit, HopLocation, TargetHop};
73

            
74
/// A Result type for this crate.
75
pub type Result<T> = std::result::Result<T, Error>;
76

            
77
use std::fmt::Debug;
78
use tor_memquota::{
79
    mq_queue::{self, ChannelSpec as _},
80
    HasMemoryCost,
81
};
82
use tor_rtcompat::DynTimeProvider;
83

            
84
#[doc(hidden)]
85
pub use {derive_deftly, tor_memquota};
86

            
87
/// Timestamp object that we update whenever we get incoming traffic.
88
///
89
/// Used to implement [`time_since_last_incoming_traffic`]
90
static LAST_INCOMING_TRAFFIC: util::ts::AtomicOptTimestamp = util::ts::AtomicOptTimestamp::new();
91

            
92
/// Called whenever we receive incoming traffic.
93
///
94
/// Used to implement [`time_since_last_incoming_traffic`]
95
#[inline]
96
292
pub(crate) fn note_incoming_traffic() {
97
292
    LAST_INCOMING_TRAFFIC.update();
98
292
}
99

            
100
/// Return the amount of time since we last received "incoming traffic".
101
///
102
/// This is a global counter, and is subject to interference from
103
/// other users of the `tor_proto`.  Its only permissible use is for
104
/// checking how recently we have been definitely able to receive
105
/// incoming traffic.
106
///
107
/// When enabled, this timestamp is updated whenever we receive a valid
108
/// cell, and whenever we complete a channel handshake.
109
///
110
/// Returns `None` if we never received "incoming traffic".
111
403307
pub fn time_since_last_incoming_traffic() -> Option<std::time::Duration> {
112
403307
    LAST_INCOMING_TRAFFIC.time_since_update().map(Into::into)
113
403307
}
114

            
115
/// Make an MPSC queue, of any type, that participates in memquota, but a fake one for testing
116
#[cfg(any(test, feature = "testing"))] // Used by Channel::new_fake which is also feature=testing
117
1268
pub(crate) fn fake_mpsc<T: HasMemoryCost + Debug + Send>(
118
1268
    buffer: usize,
119
1268
) -> (
120
1268
    mq_queue::Sender<T, mq_queue::MpscSpec>,
121
1268
    mq_queue::Receiver<T, mq_queue::MpscSpec>,
122
1268
) {
123
1268
    mq_queue::MpscSpec::new(buffer)
124
1268
        .new_mq(
125
1268
            // The fake Account doesn't care about the data ages, so this will do.
126
1268
            //
127
1268
            // Thiw would be wrong to use generally in tests, where we might want to mock time,
128
1268
            // since we end up, here with totally *different* mocked time.
129
1268
            // But it's OK here, and saves passing a runtime parameter into this function.
130
1268
            DynTimeProvider::new(tor_rtmock::MockRuntime::default()),
131
1268
            &tor_memquota::Account::new_noop(),
132
1268
        )
133
1268
        .expect("create fake mpsc")
134
1268
}
135

            
136
/// Return a list of the protocols [supported](tor_protover::doc_supported)
137
/// by this crate, running as a client.
138
237
pub fn supported_client_protocols() -> tor_protover::Protocols {
139
    use tor_protover::named::*;
140
    // WARNING: REMOVING ELEMENTS FROM THIS LIST CAN BE DANGEROUS!
141
    // SEE [`tor_protover::doc_changing`]
142
237
    [
143
237
        LINK_V4,
144
237
        LINK_V5,
145
237
        LINKAUTH_ED25519_SHA256_EXPORTER,
146
237
        FLOWCTRL_AUTH_SENDME,
147
237
        RELAY_NTOR,
148
237
        RELAY_EXTEND_IPv6,
149
237
        RELAY_NTORV3,
150
237
    ]
151
237
    .into_iter()
152
237
    .collect()
153
237
}
154

            
155
#[cfg(test)]
156
mod test {
157
    // @@ begin test lint list maintained by maint/add_warning @@
158
    #![allow(clippy::bool_assert_comparison)]
159
    #![allow(clippy::clone_on_copy)]
160
    #![allow(clippy::dbg_macro)]
161
    #![allow(clippy::mixed_attributes_style)]
162
    #![allow(clippy::print_stderr)]
163
    #![allow(clippy::print_stdout)]
164
    #![allow(clippy::single_char_pattern)]
165
    #![allow(clippy::unwrap_used)]
166
    #![allow(clippy::unchecked_duration_subtraction)]
167
    #![allow(clippy::useless_vec)]
168
    #![allow(clippy::needless_pass_by_value)]
169
    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
170

            
171
    use super::*;
172

            
173
    #[test]
174
    fn protocols() {
175
        let pr = supported_client_protocols();
176
        let expected = "FlowCtrl=1 Link=4-5 LinkAuth=3 Relay=2-4".parse().unwrap();
177
        assert_eq!(pr, expected);
178
    }
179
}