bip_handshake 0.7.1

Common handshaking interface as well as a default handshake implementation
Documentation 
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

use handshake::handler::HandshakeType;
use transport::Transport;
use message::initiate::InitiateMessage;
use filter::filters::Filters;
use handshake::handler;
use handshake::handler::timer::HandshakeTimer;

use futures::future::{self, Future};
use tokio_core::reactor::Handle;

/// Handle the initiation of connections, which are returned as a HandshakeType.
pub fn initiator_handler<T>(item: InitiateMessage, context: &(T, Filters, Handle, HandshakeTimer)) -> Box<Future<Item=Option<HandshakeType<T::Socket>>,Error=()>>
    where T: Transport {
    let &(ref transport, ref filters, ref handle, ref timer) = context;

    if handler::should_filter(Some(item.address()), Some(item.protocol()), None, Some(item.hash()), None, filters) {
        Box::new(future::ok(None))
    } else {
        let res_connect = transport.connect(item.address(), handle)
            .map(|connect| timer.timeout(connect));

        Box::new(future::lazy(|| res_connect)
            .flatten()
            .map(|socket| {
                Some(HandshakeType::Initiate(socket, item))
            })
            .or_else(|_| Ok(None))
        )    
    }
}

#[cfg(test)]
mod tests {
    use filter::filters::Filters;
    use handshake::handler::HandshakeType;
    use filter::filters::test_filters::{BlockAddrFilter, BlockProtocolFilter, BlockPeerIdFilter};
    use message::protocol::Protocol;
    use message::initiate::InitiateMessage;
    use transport::test_transports::MockTransport;
    use handshake::handler::timer::HandshakeTimer;
    use std::time::Duration;

    use bip_util::bt::{self, InfoHash, PeerId};
    use futures::Future;
    use tokio_core::reactor::{Core};
    use tokio_timer;

    fn any_peer_id() -> PeerId {
        [22u8; bt::PEER_ID_LEN].into()
    }

    fn any_info_hash() -> InfoHash {
        [55u8; bt::INFO_HASH_LEN].into()
    }

    #[test]
    fn positive_empty_filter() {
        let core = Core::new().unwrap();
        let exp_message = InitiateMessage::new(Protocol::BitTorrent, any_info_hash(), "1.2.3.4:5".parse().unwrap());
        let timer = HandshakeTimer::new(tokio_timer::wheel().build(), Duration::from_millis(1000));

        let recv_enum_item = super::initiator_handler(exp_message.clone(), &(MockTransport, Filters::new(), core.handle(), timer)).wait().unwrap();
        let recv_item = match recv_enum_item {
            Some(HandshakeType::Initiate(_, msg)) => msg,
            Some(HandshakeType::Complete(_, _))   |
            None                                  => panic!("Expected HandshakeType::Initiate")
        };

        assert_eq!(exp_message, recv_item);
    }

    #[test]
    fn positive_passes_filter() {
        let core = Core::new().unwrap();
        let timer = HandshakeTimer::new(tokio_timer::wheel().build(), Duration::from_millis(1000));
        
        let filters = Filters::new();
        filters.add_filter(BlockAddrFilter::new("2.3.4.5:6".parse().unwrap()));

        let exp_message = InitiateMessage::new(Protocol::BitTorrent, any_info_hash(), "1.2.3.4:5".parse().unwrap());

        let recv_enum_item = super::initiator_handler(exp_message.clone(), &(MockTransport, filters, core.handle(), timer)).wait().unwrap();
        let recv_item = match recv_enum_item {
            Some(HandshakeType::Initiate(_, msg)) => msg,
            Some(HandshakeType::Complete(_, _))   |
            None                                  => panic!("Expected HandshakeType::Initiate")
        };

        assert_eq!(exp_message, recv_item);
    }

    #[test]
    fn positive_needs_data_filter() {
        let core = Core::new().unwrap();
        let timer = HandshakeTimer::new(tokio_timer::wheel().build(), Duration::from_millis(1000));
        
        let filters = Filters::new();
        filters.add_filter(BlockPeerIdFilter::new(any_peer_id()));

        let exp_message = InitiateMessage::new(Protocol::BitTorrent, any_info_hash(), "1.2.3.4:5".parse().unwrap());

        let recv_enum_item = super::initiator_handler(exp_message.clone(), &(MockTransport, filters, core.handle(), timer)).wait().unwrap();
        let recv_item = match recv_enum_item {
            Some(HandshakeType::Initiate(_, msg)) => msg,
            Some(HandshakeType::Complete(_, _))   |
            None                                  => panic!("Expected HandshakeType::Initiate")
        };

        assert_eq!(exp_message, recv_item);
    }

    #[test]
    fn positive_fails_filter() {
        let core = Core::new().unwrap();
        let timer = HandshakeTimer::new(tokio_timer::wheel().build(), Duration::from_millis(1000));
        
        let filters = Filters::new();
        filters.add_filter(BlockProtocolFilter::new(Protocol::Custom(vec![1, 2, 3, 4])));

        let exp_message = InitiateMessage::new(Protocol::Custom(vec![1, 2, 3, 4]), any_info_hash(), "1.2.3.4:5".parse().unwrap());

        let recv_enum_item = super::initiator_handler(exp_message.clone(), &(MockTransport, filters, core.handle(), timer)).wait().unwrap();
        match recv_enum_item {
            None                                => (),
            Some(HandshakeType::Initiate(_, _)) |
            Some(HandshakeType::Complete(_, _)) => panic!("Expected No Handshake")
        }
    }
}