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
use igd_async::{self, GetAnyAddressError};
use priv_prelude::*;
use server_set::Servers;
use std::error::Error;

quick_error! {
    /// Use this error to notify socket bind failure.
    #[derive(Debug)]
    pub enum BindPublicError {
        /// Failure to use OS `bind()` function.
        Bind(e: io::Error) {
            description("error binding to local address")
            display("error binding to local address: {}", e)
            cause(e)
        }
        /// Failure to open external port.
        OpenAddr(e: OpenAddrError) {
            description("error opening external port")
            display("error opening external port: {}", e)
            cause(e)
        }
    }
}

/// Wrapper around `OpenAddrErrorKind` and IGD error.
#[derive(Debug)]
pub struct OpenAddrError {
    igd_err: Option<GetAnyAddressError>,
    kind: OpenAddrErrorKind,
}

impl fmt::Display for OpenAddrError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if let Some(ref e) = self.igd_err {
            write!(f, "IGD returned error: {}. ", e)?;
        }
        write!(f, "Hole punching failed with error: {}", self.kind)?;
        Ok(())
    }
}

impl Error for OpenAddrError {
    fn cause(&self) -> Option<&Error> {
        self.kind.cause()
    }

    fn description(&self) -> &str {
        self.kind.description()
    }
}

quick_error! {
    /// The actual type of `OpenAddrError`.
    #[derive(Debug)]
    pub enum OpenAddrErrorKind {
        /// Our public IP addresses received from traversal/STUN servers don't match.
        /// Such behavior is unexpected and we wouldn't know how to handle that.
        InconsistentAddrs(a0: SocketAddr, a1: SocketAddr) {
            description("NAT did not give us a consistent port mapping")
            display("NAT did not give us a consistent port mapping, got addresses {} and {}",
                     a0, a1)
        }
        /// *p2p* only tolerates specific number of errors. If that exceeds, *p2p* stops trying.
        HitErrorLimit(v: Vec<QueryPublicAddrError>) {
            description("hit error limit contacting traversal servers")
            display("hit error limit contacting traversal servers. {} errors: {:#?}",
                     v.len(), v)
        }
        /// *p2p* doesn't have enough traversal servers to detect our public IP address.
        LackOfServers {
            description("lack of traversal servers necessary to map port")
        }
        /// Failure to retrieve address list for network interfaces.
        IfAddrs(e: io::Error) {
            description("error getting interface addresses")
            display("error getting interface addresses: {}", e)
            cause(e)
        }
    }
}

pub fn open_addr(
    protocol: Protocol,
    bind_addr: &SocketAddr,
    handle: &Handle,
    mc: &P2p,
) -> BoxFuture<SocketAddr, OpenAddrError> {
    let addrs_res = {
        bind_addr
            .expand_local_unspecified()
            .map_err(|e| OpenAddrError {
                igd_err: None,
                kind: OpenAddrErrorKind::IfAddrs(e),
            })
    };

    let addrs = match addrs_res {
        Ok(addrs) => addrs,
        Err(e) => return future::err(e).into_boxed(),
    };

    if let Some(addr) = addrs
        .into_iter()
        .find(|addr| IpAddrExt::is_global(&addr.ip()))
    {
        trace!("we have a global local address: {}", addr);
        return future::ok(addr).into_boxed();
    }

    let bind_addr = *bind_addr;
    let handle = handle.clone();

    let mc0 = mc.clone();
    igd_async::get_any_address_open(protocol, bind_addr, &handle, mc)
        .or_else(move |igd_err| OpenAddr {
            protocol,
            igd_err: Some(igd_err),
            handle,
            bind_addr,
            known_addr_opt: None,
            traversal_servers: mc0.iter_servers(protocol),
            active_queries: stream::FuturesUnordered::new(),
            errors: Vec::new(),
            more_servers_timeout: None,
        })
        .into_boxed()
}

struct OpenAddr {
    protocol: Protocol,
    igd_err: Option<GetAnyAddressError>,
    handle: Handle,
    bind_addr: SocketAddr,
    known_addr_opt: Option<SocketAddr>,
    traversal_servers: Servers,
    active_queries: stream::FuturesUnordered<BoxFuture<SocketAddr, QueryPublicAddrError>>,
    errors: Vec<QueryPublicAddrError>,
    more_servers_timeout: Option<Timeout>,
}

impl Future for OpenAddr {
    type Item = SocketAddr;
    type Error = OpenAddrError;

    fn poll(&mut self) -> Result<Async<SocketAddr>, OpenAddrError> {
        loop {
            trace!("in open_addr loop");
            loop {
                match self.active_queries.poll() {
                    Err(e) => {
                        trace!("query returned error: {}", e);
                        self.errors.push(e);
                    }
                    Ok(Async::Ready(Some(addr))) => {
                        trace!("query returned address: {}", addr);
                        if let Some(known_addr) = self.known_addr_opt {
                            if known_addr == addr {
                                return Ok(Async::Ready(addr));
                            } else {
                                return Err(OpenAddrError {
                                    igd_err: self.igd_err.take(),
                                    kind: OpenAddrErrorKind::InconsistentAddrs(known_addr, addr),
                                });
                            }
                        }
                        self.known_addr_opt = Some(addr);
                    }
                    _ => break,
                }
            }

            if self.errors.len() >= 5 {
                let errors = mem::replace(&mut self.errors, Vec::new());
                return Err(OpenAddrError {
                    igd_err: self.igd_err.take(),
                    kind: OpenAddrErrorKind::HitErrorLimit(errors),
                });
            }

            if self.active_queries.len() == 2 {
                return Ok(Async::NotReady);
            }

            trace!("polling for new servers");
            match self.traversal_servers.poll().void_unwrap() {
                Async::Ready(Some(server_info)) => {
                    trace!("new server to query: {}", server_info);
                    let active_query = query_public_addr(
                        self.protocol,
                        &self.bind_addr,
                        &server_info,
                        &self.handle,
                    );
                    self.active_queries.push(active_query);
                    self.more_servers_timeout = None;
                }
                Async::Ready(None) => {
                    trace!("out of servers");
                    if self.active_queries.is_empty() {
                        if let Some(known_addr) = self.known_addr_opt {
                            trace!("returning unverified (!) address: {}", known_addr);
                            return Ok(Async::Ready(known_addr));
                        }
                        trace!("giving up");
                        return Err(OpenAddrError {
                            igd_err: self.igd_err.take(),
                            kind: OpenAddrErrorKind::LackOfServers,
                        });
                    }
                    trace!(
                        "waiting for {} more queries to finish",
                        self.active_queries.len()
                    );
                }
                Async::NotReady => {
                    if self.active_queries.is_empty() {
                        trace!("waiting for more servers...");
                        loop {
                            if let Some(ref mut timeout) = self.more_servers_timeout {
                                trace!("... timed out");
                                if let Async::Ready(()) = timeout.poll().void_unwrap() {
                                    if let Some(known_addr) = self.known_addr_opt {
                                        return Ok(Async::Ready(known_addr));
                                    }
                                    return Err(OpenAddrError {
                                        igd_err: self.igd_err.take(),
                                        kind: OpenAddrErrorKind::LackOfServers,
                                    });
                                }
                                break;
                            } else {
                                self.more_servers_timeout =
                                    Some(Timeout::new(Duration::from_secs(2), &self.handle));
                            }
                        }
                    }
                    return Ok(Async::NotReady);
                }
            }
        }
    }
}