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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
use crate::{
application::storage::PeerMetadataStorage,
counters,
counters::NETWORK_RATE_LIMIT_METRICS,
noise::{stream::NoiseStream, HandshakeAuthMode},
peer_manager::{
conn_notifs_channel, ConnectionRequest, ConnectionRequestSender, PeerManager,
PeerManagerNotification, PeerManagerRequest, PeerManagerRequestSender,
},
protocols::{network::AppConfig, wire::handshake::v1::ProtocolIdSet},
transport::{self, AptosNetTransport, Connection, APTOS_TCP_TRANSPORT},
ProtocolId,
};
use aptos_config::{
config::{PeerSet, RateLimitConfig, HANDSHAKE_VERSION},
network_id::NetworkContext,
};
use aptos_crypto::x25519;
use aptos_infallible::RwLock;
use aptos_logger::prelude::*;
use aptos_rate_limiter::rate_limit::TokenBucketRateLimiter;
use aptos_time_service::TimeService;
use aptos_types::{chain_id::ChainId, network_address::NetworkAddress, PeerId};
use channel::{self, aptos_channel, message_queues::QueueStyle};
#[cfg(any(test, feature = "testing", feature = "fuzzing"))]
use netcore::transport::memory::MemoryTransport;
use netcore::transport::{
tcp::{TcpSocket, TcpTransport},
Transport,
};
use std::{clone::Clone, collections::HashMap, fmt::Debug, net::IpAddr, sync::Arc};
use tokio::runtime::Handle;
#[derive(Debug)]
pub enum AuthenticationMode {
MaybeMutual(x25519::PrivateKey),
Mutual(x25519::PrivateKey),
}
struct TransportContext {
chain_id: ChainId,
supported_protocols: ProtocolIdSet,
authentication_mode: AuthenticationMode,
trusted_peers: Arc<RwLock<PeerSet>>,
enable_proxy_protocol: bool,
}
impl TransportContext {
fn add_protocols(&mut self, protocols: &ProtocolIdSet) {
self.supported_protocols = self.supported_protocols.union(protocols);
}
}
struct PeerManagerContext {
pm_reqs_tx: aptos_channel::Sender<(PeerId, ProtocolId), PeerManagerRequest>,
pm_reqs_rx: aptos_channel::Receiver<(PeerId, ProtocolId), PeerManagerRequest>,
connection_reqs_tx: aptos_channel::Sender<PeerId, ConnectionRequest>,
connection_reqs_rx: aptos_channel::Receiver<PeerId, ConnectionRequest>,
peer_metadata_storage: Arc<PeerMetadataStorage>,
trusted_peers: Arc<RwLock<PeerSet>>,
upstream_handlers:
HashMap<ProtocolId, aptos_channel::Sender<(PeerId, ProtocolId), PeerManagerNotification>>,
connection_event_handlers: Vec<conn_notifs_channel::Sender>,
max_concurrent_network_reqs: usize,
channel_size: usize,
max_frame_size: usize,
inbound_connection_limit: usize,
inbound_rate_limit_config: Option<RateLimitConfig>,
outbound_rate_limit_config: Option<RateLimitConfig>,
}
impl PeerManagerContext {
#[allow(clippy::too_many_arguments)]
fn new(
pm_reqs_tx: aptos_channel::Sender<(PeerId, ProtocolId), PeerManagerRequest>,
pm_reqs_rx: aptos_channel::Receiver<(PeerId, ProtocolId), PeerManagerRequest>,
connection_reqs_tx: aptos_channel::Sender<PeerId, ConnectionRequest>,
connection_reqs_rx: aptos_channel::Receiver<PeerId, ConnectionRequest>,
peer_metadata_storage: Arc<PeerMetadataStorage>,
trusted_peers: Arc<RwLock<PeerSet>>,
upstream_handlers: HashMap<
ProtocolId,
aptos_channel::Sender<(PeerId, ProtocolId), PeerManagerNotification>,
>,
connection_event_handlers: Vec<conn_notifs_channel::Sender>,
max_concurrent_network_reqs: usize,
channel_size: usize,
max_frame_size: usize,
inbound_connection_limit: usize,
inbound_rate_limit_config: Option<RateLimitConfig>,
outbound_rate_limit_config: Option<RateLimitConfig>,
) -> Self {
Self {
pm_reqs_tx,
pm_reqs_rx,
connection_reqs_tx,
connection_reqs_rx,
peer_metadata_storage,
trusted_peers,
upstream_handlers,
connection_event_handlers,
max_concurrent_network_reqs,
channel_size,
max_frame_size,
inbound_connection_limit,
inbound_rate_limit_config,
outbound_rate_limit_config,
}
}
fn add_upstream_handler(
&mut self,
protocol_id: ProtocolId,
channel: aptos_channel::Sender<(PeerId, ProtocolId), PeerManagerNotification>,
) -> &mut Self {
self.upstream_handlers.insert(protocol_id, channel);
self
}
pub fn add_connection_event_listener(&mut self) -> conn_notifs_channel::Receiver {
let (tx, rx) = conn_notifs_channel::new();
self.connection_event_handlers.push(tx);
rx
}
}
#[cfg(any(test, feature = "testing", feature = "fuzzing"))]
type MemoryPeerManager =
PeerManager<AptosNetTransport<MemoryTransport>, NoiseStream<memsocket::MemorySocket>>;
type TcpPeerManager = PeerManager<AptosNetTransport<TcpTransport>, NoiseStream<TcpSocket>>;
enum TransportPeerManager {
#[cfg(any(test, feature = "testing", feature = "fuzzing"))]
Memory(MemoryPeerManager),
Tcp(TcpPeerManager),
}
pub struct PeerManagerBuilder {
network_context: NetworkContext,
time_service: TimeService,
transport_context: Option<TransportContext>,
peer_manager_context: Option<PeerManagerContext>,
peer_manager: Option<TransportPeerManager>,
listen_address: NetworkAddress,
}
impl PeerManagerBuilder {
#[allow(clippy::too_many_arguments)]
pub fn create(
chain_id: ChainId,
network_context: NetworkContext,
time_service: TimeService,
listen_address: NetworkAddress,
peer_metadata_storage: Arc<PeerMetadataStorage>,
trusted_peers: Arc<RwLock<PeerSet>>,
authentication_mode: AuthenticationMode,
channel_size: usize,
max_concurrent_network_reqs: usize,
max_frame_size: usize,
enable_proxy_protocol: bool,
inbound_connection_limit: usize,
inbound_rate_limit_config: Option<RateLimitConfig>,
outbound_rate_limit_config: Option<RateLimitConfig>,
) -> Self {
let (pm_reqs_tx, pm_reqs_rx) = aptos_channel::new(
QueueStyle::FIFO,
channel_size,
Some(&counters::PENDING_PEER_MANAGER_REQUESTS),
);
let (connection_reqs_tx, connection_reqs_rx) =
aptos_channel::new(QueueStyle::FIFO, channel_size, None);
Self {
network_context,
time_service,
transport_context: Some(TransportContext {
chain_id,
supported_protocols: ProtocolIdSet::empty(),
authentication_mode,
trusted_peers: trusted_peers.clone(),
enable_proxy_protocol,
}),
peer_manager_context: Some(PeerManagerContext::new(
pm_reqs_tx,
pm_reqs_rx,
connection_reqs_tx,
connection_reqs_rx,
peer_metadata_storage,
trusted_peers,
HashMap::new(),
Vec::new(),
max_concurrent_network_reqs,
channel_size,
max_frame_size,
inbound_connection_limit,
inbound_rate_limit_config,
outbound_rate_limit_config,
)),
peer_manager: None,
listen_address,
}
}
pub fn listen_address(&self) -> NetworkAddress {
self.listen_address.clone()
}
pub fn connection_reqs_tx(&self) -> aptos_channel::Sender<PeerId, ConnectionRequest> {
self.peer_manager_context
.as_ref()
.expect("Cannot access connection_reqs once PeerManager has been built")
.connection_reqs_tx
.clone()
}
fn transport_context(&mut self) -> &mut TransportContext {
self.transport_context
.as_mut()
.expect("Cannot get TransportContext once PeerManager has been built")
}
fn peer_manager_context(&mut self) -> &mut PeerManagerContext {
self.peer_manager_context
.as_mut()
.expect("Cannot get PeerManagerContext once PeerManager has been built")
}
pub fn build(&mut self, executor: &Handle) -> &mut Self {
use aptos_types::network_address::Protocol::*;
let transport_context = self
.transport_context
.take()
.expect("PeerManager can only be built once");
let protos = transport_context.supported_protocols;
let chain_id = transport_context.chain_id;
let enable_proxy_protocol = transport_context.enable_proxy_protocol;
let (key, auth_mode) = match transport_context.authentication_mode {
AuthenticationMode::MaybeMutual(key) => (
key,
HandshakeAuthMode::maybe_mutual(transport_context.trusted_peers),
),
AuthenticationMode::Mutual(key) => (
key,
HandshakeAuthMode::mutual(transport_context.trusted_peers),
),
};
self.peer_manager = match self.listen_address.as_slice() {
[Ip4(_), Tcp(_)] | [Ip6(_), Tcp(_)] => {
Some(TransportPeerManager::Tcp(self.build_with_transport(
AptosNetTransport::new(
APTOS_TCP_TRANSPORT.clone(),
self.network_context,
self.time_service.clone(),
key,
auth_mode,
HANDSHAKE_VERSION,
chain_id,
protos,
enable_proxy_protocol,
),
executor,
)))
}
#[cfg(any(test, feature = "testing", feature = "fuzzing"))]
[Memory(_)] => Some(TransportPeerManager::Memory(self.build_with_transport(
AptosNetTransport::new(
MemoryTransport,
self.network_context,
self.time_service.clone(),
key,
auth_mode,
HANDSHAKE_VERSION,
chain_id,
protos,
enable_proxy_protocol,
),
executor,
))),
_ => panic!(
"{} Unsupported listen_address: '{}', expected '/memory/<port>', \
'/ip4/<addr>/tcp/<port>', or '/ip6/<addr>/tcp/<port>'.",
self.network_context, self.listen_address
),
};
self
}
fn build_with_transport<TTransport, TSocket>(
&mut self,
transport: TTransport,
executor: &Handle,
) -> PeerManager<TTransport, TSocket>
where
TTransport: Transport<Output = Connection<TSocket>> + Send + 'static,
TSocket: transport::TSocket,
{
let pm_context = self
.peer_manager_context
.take()
.expect("PeerManager can only be built once");
let inbound_rate_limiters = token_bucket_rate_limiter(
&self.network_context,
"inbound",
pm_context.inbound_rate_limit_config,
);
let outbound_rate_limiters = token_bucket_rate_limiter(
&self.network_context,
"outbound",
pm_context.outbound_rate_limit_config,
);
let peer_mgr = PeerManager::new(
executor.clone(),
self.time_service.clone(),
transport,
self.network_context,
self.listen_address.clone(),
pm_context.peer_metadata_storage,
pm_context.trusted_peers,
pm_context.pm_reqs_rx,
pm_context.connection_reqs_rx,
pm_context.upstream_handlers,
pm_context.connection_event_handlers,
pm_context.max_concurrent_network_reqs,
pm_context.channel_size,
pm_context.max_frame_size,
pm_context.inbound_connection_limit,
inbound_rate_limiters,
outbound_rate_limiters,
);
self.listen_address = peer_mgr.listen_addr().clone();
peer_mgr
}
fn start_peer_manager<TTransport, TSocket>(
&mut self,
peer_manager: PeerManager<TTransport, TSocket>,
executor: &Handle,
) where
TTransport: Transport<Output = Connection<TSocket>> + Send + 'static,
TSocket: transport::TSocket,
{
executor.spawn(peer_manager.start());
debug!("{} Started peer manager", self.network_context);
}
pub fn start(&mut self, executor: &Handle) {
debug!("{} Starting Peer manager", self.network_context);
match self
.peer_manager
.take()
.expect("Can only start PeerManager once")
{
#[cfg(any(test, feature = "testing", feature = "fuzzing"))]
TransportPeerManager::Memory(pm) => self.start_peer_manager(pm, executor),
TransportPeerManager::Tcp(pm) => self.start_peer_manager(pm, executor),
}
}
pub fn add_connection_event_listener(&mut self) -> conn_notifs_channel::Receiver {
self.peer_manager_context
.as_mut()
.expect("Cannot add an event listener if PeerManager has already been built.")
.add_connection_event_listener()
}
pub fn add_p2p_service(
&mut self,
config: &AppConfig,
) -> (
(PeerManagerRequestSender, ConnectionRequestSender),
(
aptos_channel::Receiver<(PeerId, ProtocolId), PeerManagerNotification>,
conn_notifs_channel::Receiver,
),
) {
(self.add_client(config), self.add_service(config))
}
pub fn add_client(
&mut self,
config: &AppConfig,
) -> (PeerManagerRequestSender, ConnectionRequestSender) {
self.transport_context().add_protocols(&config.protocols);
let pm_context = self.peer_manager_context();
(
PeerManagerRequestSender::new(pm_context.pm_reqs_tx.clone()),
ConnectionRequestSender::new(pm_context.connection_reqs_tx.clone()),
)
}
pub fn add_service(
&mut self,
config: &AppConfig,
) -> (
aptos_channel::Receiver<(PeerId, ProtocolId), PeerManagerNotification>,
conn_notifs_channel::Receiver,
) {
self.transport_context().add_protocols(&config.protocols);
let (network_notifs_tx, network_notifs_rx) = config
.inbound_queue
.expect("Requires a service config")
.build();
let pm_context = self.peer_manager_context();
for protocol in config.protocols.iter() {
pm_context.add_upstream_handler(protocol, network_notifs_tx.clone());
}
let connection_notifs_rx = pm_context.add_connection_event_listener();
(network_notifs_rx, connection_notifs_rx)
}
}
fn token_bucket_rate_limiter(
network_context: &NetworkContext,
label: &'static str,
input: Option<RateLimitConfig>,
) -> TokenBucketRateLimiter<IpAddr> {
if let Some(config) = input {
if config.enabled {
return TokenBucketRateLimiter::new(
label,
network_context.to_string(),
config.initial_bucket_fill_percentage,
config.ip_byte_bucket_size,
config.ip_byte_bucket_rate,
Some(NETWORK_RATE_LIMIT_METRICS.clone()),
);
}
}
TokenBucketRateLimiter::open(label)
}