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
//! RLPx protocol implementation in Rust

extern crate secp256k1;
extern crate rand;

extern crate sha3;
extern crate sha2;
extern crate byteorder;
extern crate crypto;
extern crate bigint;
extern crate rlp;
extern crate hexutil;
extern crate bytes;
#[macro_use]
extern crate log;
#[macro_use]
extern crate futures;
extern crate tokio_io;
extern crate tokio_core;

mod util;
pub mod ecies;
mod peer;
mod mac;
mod errors;

pub use peer::{PeerStream, CapabilityInfo};

use bigint::H512;
use util::pk2id;
use secp256k1::{PublicKey, SecretKey};
use futures::future;
use futures::{Poll, Async, StartSend, AsyncSink, Future, Stream, Sink};
use std::io;
use std::net::SocketAddr;
use std::collections::HashMap;
use tokio_core::reactor::Handle;
use tokio_core::net::{TcpListener, Incoming};
use tokio_io::{AsyncRead, AsyncWrite};
use tokio_io::codec::{Framed, Encoder, Decoder};
use rand::{Rng, thread_rng};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Sending node type specifying either all, any or a particular peer
pub enum RLPxNode {
    Any,
    All,
    Peer(H512),
}

/// Sending message for RLPx
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RLPxSendMessage {
    pub node: RLPxNode,
    pub capability_name: &'static str,
    pub id: usize,
    pub data: Vec<u8>,
}

/// Receiving message for RLPx
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RLPxReceiveMessage {
    Connected {
        node: H512,
        capabilities: Vec<CapabilityInfo>,
    },
    Disconnected {
        node: H512
    },
    Normal {
        node: H512,
        capability: CapabilityInfo,
        id: usize,
        data: Vec<u8>,
    }
}

/// A RLPx stream and sink
pub struct RLPxStream {
    streams: Vec<PeerStream>,
    futures: Vec<(H512, Box<Future<Item = PeerStream, Error = io::Error>>)>,
    incoming_futures: Vec<Box<Future<Item = PeerStream, Error = io::Error>>>,
    newly_connected: Vec<(H512, Vec<CapabilityInfo>)>,
    newly_disconnected: Vec<H512>,
    active_peers: Vec<H512>,
    secret_key: SecretKey,
    protocol_version: usize,
    client_version: String,
    capabilities: Vec<CapabilityInfo>,
    port: u16,
    tcp_incoming: Option<Incoming>,
    handle: Handle,
}

impl RLPxStream {
    /// Create a new RLPx stream
    pub fn new(handle: &Handle, secret_key: SecretKey, protocol_version: usize,
               client_version: String, capabilities: Vec<CapabilityInfo>,
               listen: Option<&SocketAddr>) -> Result<RLPxStream, io::Error> {
        Ok(RLPxStream {
            streams: Vec::new(),
            futures: Vec::new(),
            secret_key, protocol_version, client_version,
            capabilities,
            handle: handle.clone(),
            active_peers: Vec::new(),
            newly_connected: Vec::new(),
            newly_disconnected: Vec::new(),
            port: listen.map(|addr| addr.port()).unwrap_or(0),
            tcp_incoming: match listen {
                Some(addr) => Some(TcpListener::bind(addr, handle)?.incoming()),
                None => None,
            },
            incoming_futures: Vec::new(),
        })
    }

    /// Append a new peer to this RLPx stream if it does not exist
    pub fn add_peer(
        &mut self, addr: &SocketAddr, remote_id: H512
    ) {
        if !self.active_peers.contains(&remote_id) {
            info!("connecting to peer {}", remote_id);
            let future = PeerStream::connect(addr, &self.handle, self.secret_key.clone(),
                                             remote_id, self.protocol_version,
                                             self.client_version.clone(),
                                             self.capabilities.clone(), self.port);
            self.futures.push((remote_id, future));
            self.active_peers.push(remote_id);
        }
    }

    /// Force disconnecting a peer if it is already connected or about
    /// to be connected. Useful for removing peers on a different hard
    /// fork network
    pub fn disconnect_peer(&mut self, remote_id: H512) {
        let ref mut futures = self.futures;
        let ref mut streams = self.streams;
        let ref mut newly_disconnected = self.newly_disconnected;

        retain_mut(streams, |peer| {
            if peer.remote_id() == remote_id {
                newly_disconnected.push(remote_id);
                false
            } else {
                true
            }
        });

        retain_mut(futures, |&mut (peer_id, _)| {
            peer_id != remote_id
        });
    }

    /// Poll over new peers to resolve them to TCP streams
    pub fn poll_new_peers(&mut self) -> Poll<(), io::Error> {
        let ref mut futures = self.futures;
        let ref mut incoming_futures = self.incoming_futures;
        let ref mut streams = self.streams;
        let ref mut active_peers = self.active_peers;
        let ref mut newly_connected = self.newly_connected;

        let mut all_ready = true;

        retain_mut(futures, |&mut (remote_id, ref mut future)| {
            match future.poll() {
                Ok(Async::NotReady) => {
                    all_ready = false;
                    true
                },
                Ok(Async::Ready(peer)) => {
                    debug!("new peer connected");
                    newly_connected.push((remote_id, peer.capabilities().into()));
                    streams.push(peer);
                    false
                },
                Err(e) => {
                    error!("peer disconnected with error {}", e);
                    active_peers.retain(|peer_id| {
                        *peer_id != remote_id
                    });
                    false
                },
            }
        });

        debug!("streams {} futures {}", streams.len(), futures.len());

        if let Some(tcp_incoming) = self.tcp_incoming.as_mut() {
            loop {
                match tcp_incoming.poll()? {
                    Async::Ready(Some((stream, addr))) => {
                        incoming_futures.push(PeerStream::incoming(
                            stream, self.secret_key.clone(),
                            self.protocol_version,
                            self.client_version.clone(),
                            self.capabilities.clone(), self.port));
                    },
                    _ => break,
                }
            }
        }

        retain_mut(incoming_futures, |ref mut future| {
            match future.poll() {
                Ok(Async::NotReady) => {
                    all_ready = false;
                    true
                },
                Ok(Async::Ready(peer)) => {
                    debug!("new peer connected");
                    newly_connected.push((peer.remote_id(), peer.capabilities().into()));
                    streams.push(peer);
                    false
                },
                Err(e) => {
                    error!("peer disconnected with error {}", e);
                    false
                },
            }
        });

        if all_ready {
            Ok(Async::Ready(()))
        } else {
            Ok(Async::NotReady)
        }
    }

    /// Active peers
    pub fn active_peers(&self) -> &[H512] {
        self.active_peers.as_ref()
    }
}

fn retain_mut<T, F>(vec: &mut Vec<T>, mut f: F)
    where F: FnMut(&mut T) -> bool
{
    let len = vec.len();
    let mut del = 0;
    {
        let v = &mut **vec;

        for i in 0..len {
            if !f(&mut v[i]) {
                del += 1;
            } else if del > 0 {
                v.swap(i - del, i);
            }
        }
    }
    if del > 0 {
        vec.truncate(len - del);
    }
}

impl Stream for RLPxStream {
    type Item = RLPxReceiveMessage;
    type Error = io::Error;

    fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
        self.poll_new_peers()?;

        if self.newly_connected.len() > 0 {
            let connected = self.newly_connected.pop().unwrap();
            return Ok(Async::Ready(Some(RLPxReceiveMessage::Connected {
                node: connected.0,
                capabilities: connected.1,
            })));
        }
        if self.newly_disconnected.len() > 0 {
            return Ok(Async::Ready(Some(RLPxReceiveMessage::Disconnected {
                node: self.newly_disconnected.pop().unwrap()
            })));
        }

        let mut ret: Option<Self::Item> = None;

        {
            let ref mut streams = self.streams;
            let ref mut active_peers = self.active_peers;
            let ref mut newly_connected = self.newly_connected;
            let ref mut newly_disconnected = self.newly_disconnected;

            retain_mut(streams, |ref mut peer| {
                if ret.is_some() {
                    return true;
                }

                let id = peer.remote_id();
                match peer.poll() {
                    Ok(Async::NotReady) => true,
                    Ok(Async::Ready(None)) => {
                        debug!("peer disconnected no error");
                        newly_disconnected.push(id);
                        false
                    },
                    Ok(Async::Ready(Some((cap, message_id, data)))) => {
                        debug!("received RLPx data {:?}", data);
                        ret = Some(RLPxReceiveMessage::Normal {
                            node: id,
                            capability: cap,
                            id: message_id,
                            data
                        });
                        true
                    },
                    Err(e) => {
                        debug!("peer disconnected with error {:?}", e);
                        active_peers.retain(|peer_id| {
                            *peer_id != id
                        });
                        newly_disconnected.push(id);
                        false
                    },
                }
            });
        }

        if ret.is_some() {
            Ok(Async::Ready(ret))
        } else {
            if self.newly_connected.len() > 0 {
                let connected = self.newly_connected.pop().unwrap();
                return Ok(Async::Ready(Some(RLPxReceiveMessage::Connected {
                    node: connected.0,
                    capabilities: connected.1,
                })));
            }
            if self.newly_disconnected.len() > 0 {
                return Ok(Async::Ready(Some(RLPxReceiveMessage::Disconnected {
                    node: self.newly_disconnected.pop().unwrap()
                })));
            }
            Ok(Async::NotReady)
        }
    }
}

impl Sink for RLPxStream {
    type SinkItem = RLPxSendMessage;
    type SinkError = io::Error;

    fn start_send(&mut self, message: RLPxSendMessage) -> StartSend<Self::SinkItem, Self::SinkError> {
        self.poll_new_peers()?;

        let ref mut streams = self.streams;
        let ref mut active_peers = self.active_peers;
        let ref mut newly_disconnected = self.newly_disconnected;

        let mut any_ready = false;
        if match &message.node {
            &RLPxNode::Any => true,
            _ => false,
        } {
            thread_rng().shuffle(streams);
        }

        debug!("sending RLPx data: {:?}", message.data);

        retain_mut(streams, |ref mut peer| {
            let id = peer.remote_id();

            if match message.node {
                RLPxNode::Peer(peer_id) => peer_id == id,
                RLPxNode::All => true,
                RLPxNode::Any => !any_ready,
            } {
                let remote_id = peer.remote_id();
                match peer.start_send((message.capability_name, message.id, message.data.clone())) {
                    Ok(AsyncSink::Ready) => {
                        any_ready = true;
                        true
                    },
                    Ok(AsyncSink::NotReady(_)) => true,
                    Err(e) => {
                        debug!("peer disconnected with error {:?}", e);
                        active_peers.retain(|peer_id| {
                            *peer_id != remote_id
                        });
                        newly_disconnected.push(remote_id);
                        false
                    },
                }
            } else {
                true
            }
        });

        if any_ready {
            Ok(AsyncSink::Ready)
        } else {
            Ok(AsyncSink::NotReady(message))
        }
    }

    fn poll_complete(&mut self) -> Poll<(), Self::SinkError> {
        let ref mut streams = self.streams;
        let ref mut active_peers = self.active_peers;
        let ref mut newly_disconnected = self.newly_disconnected;

        let mut all_ready = true;

        retain_mut(streams, |ref mut peer| {
            let remote_id = peer.remote_id();
            match peer.poll_complete() {
                Ok(Async::Ready(())) => true,
                Ok(Async::NotReady) => {
                    all_ready = false;
                    true
                },
                Err(e) => {
                    debug!("peer disconnected with error: {:?}", e);
                    active_peers.retain(|peer_id| {
                        *peer_id != remote_id
                    });
                    newly_disconnected.push(remote_id);
                    false
                },
            }
        });

        if all_ready {
            Ok(Async::Ready(()))
        } else {
            Ok(Async::NotReady)
        }
    }
}

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
    }
}