1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
//! Vanguard manager configuration
use std::time::Duration;
use serde::{Deserialize, Serialize};
use tor_config::ConfigBuildError;
use tor_netdir::params::NetParameters;
use crate::VanguardMode;
/// The default L2 pool size.
const DEFAULT_L2_POOL_SIZE: usize = 4;
/// The default minimum lifetime of L2 guards.
const DEFAULT_L2_GUARD_LIFETIME_MIN: Duration = Duration::from_secs(3600 * 24);
/// The default maximum lifetime of L2 guards.
const DEFAULT_L2_GUARD_LIFETIME_MAX: Duration = Duration::from_secs(3600 * 24 * 12);
/// The default L3 pool size.
const DEFAULT_L3_POOL_SIZE: usize = 8;
/// The default minimum lifetime of L3 guards.
const DEFAULT_L3_GUARD_LIFETIME_MIN: Duration = Duration::from_secs(3600);
/// The default maximum lifetime of L3 guards.
const DEFAULT_L3_GUARD_LIFETIME_MAX: Duration = Duration::from_secs(3600 * 48);
/// Vanguards configuration.
#[derive(Debug, Default, Clone, Eq, PartialEq, derive_builder::Builder)]
#[builder(build_fn(error = "ConfigBuildError"))]
#[builder(derive(Debug, Serialize, Deserialize))]
#[derive(amplify::Getters)]
pub struct VanguardConfig {
/// The kind of vanguards to use.
#[builder_field_attr(serde(default))]
#[builder(default)]
#[getter(as_copy)]
pub(super) mode: VanguardMode,
}
/// A set of parameters, derived from the consensus document,
/// controlling the behavior of a [`VanguardMgr`](crate::vanguards::VanguardMgr).
///
/// Note: these are not part of [`VanguardConfig`],
/// because like all Tor network parameters,
/// they can be overridden via the `TorClientConfig::override_net_params`.
//
// TODO(#1382): vanguards_enabled and vanguards_hs_service are currently unused,
// because the vanguard mode is read from the VanguardConfig.
#[derive(Debug, Clone, amplify::Getters)]
pub struct VanguardParams {
/// The type of vanguards to use by default when building onion service circuits.
#[getter(as_copy)]
vanguards_enabled: VanguardMode,
/// If higher than `vanguards-enabled`,
/// and we are running an onion service,
/// we use this level for all our onion service circuits.
#[getter(as_copy)]
vanguards_hs_service: VanguardMode,
/// The number of guards in the L2 guardset
#[getter(as_copy)]
l2_pool_size: usize,
/// The minimum lifetime of L2 guards
#[getter(as_copy)]
l2_lifetime_min: Duration,
/// The maximum lifetime of L2 guards
#[getter(as_copy)]
l2_lifetime_max: Duration,
/// The number of guards in the L3 guardset
#[getter(as_copy)]
l3_pool_size: usize,
/// The minimum lifetime of L3 guards
#[getter(as_copy)]
l3_lifetime_min: Duration,
/// The maximum lifetime of L3 guards
#[getter(as_copy)]
l3_lifetime_max: Duration,
}
impl Default for VanguardParams {
fn default() -> Self {
Self {
vanguards_enabled: VanguardMode::Lite,
vanguards_hs_service: VanguardMode::Full,
l2_pool_size: DEFAULT_L2_POOL_SIZE,
l2_lifetime_min: DEFAULT_L2_GUARD_LIFETIME_MIN,
l2_lifetime_max: DEFAULT_L2_GUARD_LIFETIME_MAX,
l3_pool_size: DEFAULT_L3_POOL_SIZE,
l3_lifetime_min: DEFAULT_L3_GUARD_LIFETIME_MIN,
l3_lifetime_max: DEFAULT_L3_GUARD_LIFETIME_MAX,
}
}
}
impl TryFrom<&NetParameters> for VanguardParams {
type Error = tor_units::Error;
fn try_from(p: &NetParameters) -> Result<VanguardParams, Self::Error> {
/// Return a pair of `(min, max)` values representing a closed interval.
///
/// If `min <= max`, returns `(min, max)`.
/// Otherwise, returns `(default_min, default_max)`.
fn lifetime_or_default(
min: Duration,
max: Duration,
default_min: Duration,
default_max: Duration,
) -> (Duration, Duration) {
if min <= max {
(min, max)
} else {
(default_min, default_max)
}
}
let (l2_lifetime_min, l2_lifetime_max) = lifetime_or_default(
p.guard_hs_l2_lifetime_min.try_into()?,
p.guard_hs_l2_lifetime_max.try_into()?,
DEFAULT_L2_GUARD_LIFETIME_MIN,
DEFAULT_L2_GUARD_LIFETIME_MAX,
);
let (l3_lifetime_min, l3_lifetime_max) = lifetime_or_default(
p.guard_hs_l3_lifetime_min.try_into()?,
p.guard_hs_l3_lifetime_max.try_into()?,
DEFAULT_L3_GUARD_LIFETIME_MIN,
DEFAULT_L3_GUARD_LIFETIME_MAX,
);
Ok(VanguardParams {
vanguards_enabled: VanguardMode::from_net_parameter(p.vanguards_enabled),
vanguards_hs_service: VanguardMode::from_net_parameter(p.vanguards_hs_service),
l2_pool_size: p.guard_hs_l2_number.try_into()?,
l2_lifetime_min,
l2_lifetime_max,
l3_pool_size: p.guard_hs_l3_number.try_into()?,
l3_lifetime_min,
l3_lifetime_max,
})
}
}
|
