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
206
207
208
209
210
|
// @@ begin example lint list maintained by maint/add_warning @@
#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_time_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
#![allow(clippy::string_slice)] // See arti#2571
//! <!-- @@ end example lint list maintained by maint/add_warning @@ -->
// This example showcase how to use the trait IsolationHelper to build complex isolation rules.
// For most usages, using a combination of TorClient::isolated_client and IsolationToken should
// be enough.
use std::collections::HashSet;
use anyhow::Result;
use arti_client::isolation::IsolationHelper;
use arti_client::{IsolationToken, StreamPrefs, TorClient, TorClientConfig};
use tokio_crate as tokio;
use futures::io::{AsyncReadExt, AsyncWriteExt};
/// Example Isolation which isolate streams deemed sensitive from each other, but won't isolate
/// `Innocent` streams from other `Innocent` streams or from `Sensitive` streams.
///
/// More formally, for two streams to share the same circuit, it's required that either:
/// - at least one stream is Innocent
/// - both are Sensitive, with the same inner IsolationToken
#[derive(Debug, Clone, Copy)]
enum IsolateSensitive {
Sensitive(IsolationToken),
Innocent,
}
impl IsolateSensitive {
fn new_sensitive() -> Self {
IsolateSensitive::Sensitive(IsolationToken::new())
}
}
impl IsolationHelper for IsolateSensitive {
fn compatible_same_type(&self, other: &Self) -> bool {
match (self, other) {
(IsolateSensitive::Sensitive(i), IsolateSensitive::Sensitive(j)) => {
i.compatible_same_type(j)
}
_ => true,
}
}
fn join_same_type(&self, other: &Self) -> Option<Self> {
match (self, other) {
(IsolateSensitive::Sensitive(i), IsolateSensitive::Sensitive(j)) => {
i.join_same_type(j).map(IsolateSensitive::Sensitive)
}
(res @ IsolateSensitive::Sensitive(_), _)
| (_, res @ IsolateSensitive::Sensitive(_)) => Some(*res),
_ => Some(IsolateSensitive::Innocent),
}
}
}
/// Example Isolation which limit how many different purposes a single circuit can have.
///
/// Note that two IsolateOverused with different MAX_USAGE or different T are different types, so they
/// would get isolated from each other, even if neither has reached its MAX_USAGE.
#[derive(Debug, Clone)]
struct IsolateOverused<T, const MAX_USAGE: usize> {
usages: HashSet<T>,
}
impl<T: Eq + std::hash::Hash, const MAX_USAGE: usize> IsolateOverused<T, MAX_USAGE> {
fn new_with_usage(usage: T) -> Self {
let mut usages = HashSet::new();
usages.insert(usage);
IsolateOverused { usages }
}
}
impl<T: Eq + std::hash::Hash + Clone, const MAX_USAGE: usize> IsolationHelper
for IsolateOverused<T, MAX_USAGE>
{
fn compatible_same_type(&self, other: &Self) -> bool {
self.usages.union(&other.usages).count() <= MAX_USAGE
}
fn join_same_type(&self, other: &Self) -> Option<Self> {
let usages: HashSet<_> = self.usages.union(&other.usages).cloned().collect();
if usages.len() <= MAX_USAGE {
Some(IsolateOverused { usages })
} else {
None
}
}
}
#[tokio::main]
async fn main() -> Result<()> {
tracing_subscriber::fmt::init();
let config = TorClientConfig::default();
eprintln!("connecting to Tor...");
let tor_client = TorClient::create_bootstrapped(config).await?;
// requests using this won't be isolated from each others, or from "sensitive" requests
let innocent = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateSensitive::Innocent);
pref
};
// requests using this will be isolated from "sensitive" requests using a different
// IsolateSensitive::Sensitive. They won't be isolated from each other or from Innocent requests
let sensitive_1 = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateSensitive::new_sensitive());
pref
};
let sensitive_2 = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateSensitive::new_sensitive());
pref
};
eprintln!("sending a bunch of sensitive and innocent requests");
let mut stream = tor_client
.connect_with_prefs(("example.net", 80), &innocent)
.await?;
send_request(&mut stream, "example.net").await?;
let mut stream = tor_client
.connect_with_prefs(("example.com", 80), &sensitive_1)
.await?;
send_request(&mut stream, "example.com").await?;
let mut stream = tor_client
.connect_with_prefs(("example.com", 80), &sensitive_2)
.await?;
send_request(&mut stream, "example.com").await?;
let mut stream = tor_client
.connect_with_prefs(("example.com", 80), &sensitive_1)
.await?;
send_request(&mut stream, "example.com").await?;
// Each of these requests can share a circuit with at most 2 other usages (3 including itself).
// As there are 4 different usages, there will be at least 2 circuits used. Also as
// IsolateOverused and IsolateSensitive are not the same type, they won't share any circuits.
let first_usage = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateOverused::<_, 3>::new_with_usage("first usage"));
pref
};
let second_usage = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateOverused::<_, 3>::new_with_usage("second usage"));
pref
};
let third_usage = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateOverused::<_, 3>::new_with_usage("third usage"));
pref
};
let fourth_usage = {
let mut pref = StreamPrefs::new();
pref.set_isolation(IsolateOverused::<_, 3>::new_with_usage("fourth usage"));
pref
};
let mut stream = tor_client
.connect_with_prefs(("example.net", 80), &first_usage)
.await?;
send_request(&mut stream, "example.net").await?;
let mut stream = tor_client
.connect_with_prefs(("example.org", 80), &second_usage)
.await?;
send_request(&mut stream, "example.org").await?;
let mut stream = tor_client
.connect_with_prefs(("example.com", 80), &third_usage)
.await?;
send_request(&mut stream, "example.com").await?;
let mut stream = tor_client
.connect_with_prefs(("example.net", 80), &fourth_usage)
.await?;
send_request(&mut stream, "example.net").await?;
Ok(())
}
async fn send_request(stream: &mut arti_client::DataStream, host: &str) -> Result<()> {
stream
.write_all(
format!("GET / HTTP/1.1\r\nHost: {host}\r\nConnection: close\r\n\r\n").as_bytes(),
)
.await?;
stream.flush().await?;
let mut buf = Vec::new();
stream.read_to_end(&mut buf).await?;
println!("{}", String::from_utf8_lossy(&buf));
Ok(())
}
|
