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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
//! This module provides the [`PathBuilder`] helper for building vanguard [`TorPath`]s.
use std::result::Result as StdResult;
use rand::Rng;
use tor_error::{Bug, internal};
use tor_guardmgr::vanguards::{Layer, VanguardMgr};
use tor_linkspec::HasRelayIds;
use tor_netdir::{NetDir, Relay};
use tor_relay_selection::{RelayExclusion, RelaySelector};
use tor_rtcompat::Runtime;
use crate::path::{MaybeOwnedRelay, TorPath};
use crate::{Error, Result};
/// A vanguard path builder.
///
/// A `PathBuilder` is a state machine whose current state is the [`HopKind`] of its last hop.
/// Not all state transitions are valid. For the permissible state transitions, see
/// [update_last_hop_kind](PathBuilder::update_last_hop_kind).
///
/// This type is an implementation detail that should remain private.
/// Used by [`VanguardHsPathBuilder`](super::VanguardHsPathBuilder).
pub(super) struct PathBuilder<'n, 'a, RT: Runtime, R: Rng> {
/// The relays in the path.
hops: Vec<MaybeOwnedRelay<'n>>,
/// The network directory.
netdir: &'n NetDir,
/// The vanguard manager.
vanguards: &'a VanguardMgr<RT>,
/// An RNG for selecting vanguards and middle relays.
rng: &'a mut R,
/// The `HopKind` of the last hop in the path.
last_hop_kind: HopKind,
}
/// The type of a `PathBuilder` hop.
#[derive(Copy, Clone, Debug, PartialEq, derive_more::Display)]
enum HopKind {
/// The L1 guard.
Guard,
/// A vanguard from the specified [`Layer`].
Vanguard(Layer),
/// A middle relay.
Middle,
}
impl<'n, 'a, RT: Runtime, R: Rng> PathBuilder<'n, 'a, RT, R> {
/// Create a new `PathBuilder`.
pub(super) fn new(
rng: &'a mut R,
netdir: &'n NetDir,
vanguards: &'a VanguardMgr<RT>,
l1_guard: MaybeOwnedRelay<'n>,
) -> Self {
Self {
hops: vec![l1_guard],
netdir,
vanguards,
rng,
last_hop_kind: HopKind::Guard,
}
}
/// Extend the path with a vanguard.
pub(super) fn add_vanguard(
mut self,
selector: &RelaySelector<'n>,
layer: Layer,
) -> Result<Self> {
let selector = selector_excluding_neighbors(selector, &self.hops);
let vanguard: MaybeOwnedRelay = self
.vanguards
.select_vanguard(&mut self.rng, self.netdir, layer, &selector)?
.into();
let () = self.add_hop(vanguard, HopKind::Vanguard(layer))?;
Ok(self)
}
/// Extend the path with a middle relay.
pub(super) fn add_middle(mut self, selector: &RelaySelector<'n>) -> Result<Self> {
let middle =
select_middle_for_vanguard_circ(&self.hops, self.netdir, selector, self.rng)?.into();
let () = self.add_hop(middle, HopKind::Middle)?;
Ok(self)
}
/// Return a [`TorPath`] built using the hops from this `PathBuilder`.
pub(super) fn build(self) -> Result<TorPath<'n>> {
use HopKind::*;
use Layer::*;
match self.last_hop_kind {
Vanguard(Layer3) | Middle => Ok(TorPath::new_multihop_from_maybe_owned(self.hops)),
_ => Err(internal!(
"tried to build TorPath from incomplete PathBuilder (last_hop_kind={})",
self.last_hop_kind
)
.into()),
}
}
/// Try to append `hop` to the end of the path.
///
/// This also causes the `PathBuilder` to transition to the state represented by `hop_kind`,
/// if the transition is valid.
///
/// Returns an error if the `hop_kind` is incompatible with the `HopKind` of the last hop.
fn add_hop(&mut self, hop: MaybeOwnedRelay<'n>, hop_kind: HopKind) -> StdResult<(), Bug> {
self.update_last_hop_kind(hop_kind)?;
self.hops.push(hop);
Ok(())
}
/// Transition to the state specified by `kind`.
///
/// The state of the `PathBuilder` is represented by the [`HopKind`] of its last hop.
/// This function should be called whenever a new hop is added
/// (e.g. in [`add_hop`](PathBuilder::add_hop)), to set the current state to the
/// [`HopKind`] of the new hop.
///
/// Not all transitions are valid. The permissible state transitions are:
/// * `G -> L2`
/// * `L2 -> L3`
/// * `L2 -> M`
/// * `L3 -> M`
fn update_last_hop_kind(&mut self, kind: HopKind) -> StdResult<(), Bug> {
use HopKind::*;
use Layer::*;
match (self.last_hop_kind, kind) {
(Guard, Vanguard(Layer2))
| (Vanguard(Layer2), Vanguard(Layer3))
| (Vanguard(Layer2), Middle)
| (Vanguard(Layer3), Middle) => {
self.last_hop_kind = kind;
}
(_, _) => {
return Err(internal!(
"tried to build an invalid vanguard path: cannot add a {kind} hop after {}",
self.last_hop_kind
));
}
}
Ok(())
}
}
/// Build a [`RelayExclusion`] that excludes the specified relays.
fn exclude_identities<'a, T: HasRelayIds + 'a>(exclude_ids: &[&T]) -> RelayExclusion<'a> {
RelayExclusion::exclude_identities(
exclude_ids
.iter()
.flat_map(|relay| relay.identities())
.map(|id| id.to_owned())
.collect(),
)
}
/// Create a `RelayExclusion` suitable for selecting the next hop to add to `hops`.
fn exclude_neighbors<'n, T: HasRelayIds + 'n>(hops: &[T]) -> RelayExclusion<'n> {
// We must exclude the last 2 hops in the path,
// because a relay can't extend to itself or to its predecessor.
let skip_n = 2;
let neighbors = hops.iter().rev().take(skip_n).collect::<Vec<&T>>();
exclude_identities(&neighbors[..])
}
/// Select a middle relay that can be appended to a vanguard circuit.
///
/// Used by [`PathBuilder`] to build [`TorPath`]s of the form
///
/// G - L2 - M
/// G - L2 - L3 - M
///
/// If full vanguards are enabled, this is also used by [`HsCircPool`](crate::hspool::HsCircPool),
/// for extending NAIVE circuits to become GUARDED circuits.
pub(crate) fn select_middle_for_vanguard_circ<'n, R: Rng, T: HasRelayIds + 'n>(
hops: &[T],
netdir: &'n NetDir,
selector: &RelaySelector<'n>,
rng: &mut R,
) -> Result<Relay<'n>> {
let selector = selector_excluding_neighbors(selector, hops);
let (extra_hop, info) = selector.select_relay(rng, netdir);
extra_hop.ok_or_else(|| Error::NoRelay {
path_kind: "onion-service vanguard circuit",
role: "extra hop",
problem: info.to_string(),
})
}
/// Extend the selector T to also exclude neighbors, based on `hops`.
fn selector_excluding_neighbors<'n, T: HasRelayIds + 'n>(
selector: &RelaySelector<'n>,
hops: &[T],
) -> RelaySelector<'n> {
let mut selector = selector.clone();
let neighbor_exclusion = exclude_neighbors(hops);
selector.push_restriction(neighbor_exclusion.into());
selector
}
|
