rusturn 0.0.7

A Rust implementation of TURN server and client
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
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

//! A Rust implementation of [TURN][RFC 5766] server and client.
//!
//! # Examples
//!
//! ```
//! use futures::Future;
//! use rustun::message::Request;
//! use rustun::transport::StunUdpTransporter;
//! use rusturn::auth::AuthParams;
//! use rusturn::transport::UdpOverTurnTransporter;
//! use stun_codec::{rfc5389, MessageDecoder, MessageEncoder};
//!
//! # fn main() -> Result<(), trackable::error::MainError> {
//! let client_auth_params = AuthParams::new("foo", "bar")?;
//! let server_auth_params =
//!     AuthParams::with_realm_and_nonce("foo", "bar", "baz", "qux")?;
//!
//! // STUN server (peer)
//! let stun_server = fibers_global::execute(rustun::server::UdpServer::start(
//!     fibers_global::handle(),
//!     "127.0.0.1:0".parse().unwrap(),
//!     rustun::server::BindingHandler,
//! ))?;
//! let stun_server_addr = stun_server.local_addr();
//! fibers_global::spawn(stun_server.map(|_| ()).map_err(|e| panic!("{}", e)));
//!
//! // TURN server
//! let turn_server = fibers_global::execute(rusturn::server::UdpServer::start(
//!     "127.0.0.1:0".parse().unwrap(),
//!     server_auth_params,
//! ))?;
//! let turn_server_addr = turn_server.local_addr();
//! fibers_global::spawn(turn_server.map_err(|e| panic!("{}", e)));
//!
//! // TURN client
//! let turn_client = fibers_global::execute(rusturn::client::UdpClient::allocate(
//!     turn_server_addr,
//!     client_auth_params
//! ))?;
//! let transporter =
//!     UdpOverTurnTransporter::<_, MessageEncoder<_>, MessageDecoder<_>>::new(turn_client);
//!
//! // STUN client (over TURN)
//! let stun_channel = rustun::channel::Channel::new(StunUdpTransporter::new(transporter));
//! let stun_client = rustun::client::Client::new(&fibers_global::handle(), stun_channel);
//!
//! // BINDING request
//! let request = Request::<rfc5389::Attribute>::new(rfc5389::methods::BINDING);
//! let response = fibers_global::execute(
//!     stun_client.call(stun_server_addr, request)
//! )?;
//! assert!(response.is_ok(), "{:?}", response);
//! # Ok(())
//! # }
//! ```
//!
//! # References
//!
//! - [RFC 5766: Traversal Using Relays around NAT (TURN)][RFC 5766]
//!
//! [RFC 5766]: https://tools.ietf.org/html/rfc5766
#[macro_use]
extern crate bytecodec;
#[cfg(test)]
extern crate fibers_global;
#[macro_use]
extern crate stun_codec;
#[macro_use]
extern crate trackable;

pub use rustun::{Error, ErrorKind, Result};

pub mod attribute;

pub mod auth;
pub mod client;
pub mod server;
pub mod transport;

mod channel_data;
mod turn_message;

#[derive(Debug)]
pub struct AsyncResult<T>(fibers::sync::oneshot::Monitor<T, Error>);
impl<T> AsyncResult<T> {
    fn new() -> (Self, AsyncReply<T>) {
        let (tx, rx) = fibers::sync::oneshot::monitor();
        (AsyncResult(rx), AsyncReply(tx))
    }
}
impl<T> futures::Future for AsyncResult<T> {
    type Item = T;
    type Error = Error;

    fn poll(&mut self) -> futures::Poll<Self::Item, Self::Error> {
        track!(self.0.poll().map_err(Error::from))
    }
}

#[derive(Debug)]
struct AsyncReply<T>(fibers::sync::oneshot::Monitored<T, Error>);
impl<T> AsyncReply<T> {
    fn send(self, result: Result<T>) {
        self.0.exit(result);
    }
}

#[cfg(test)]
mod tests {
    use futures::Future;
    use rustun::message::Request;
    use rustun::transport::StunUdpTransporter;
    use stun_codec::rfc5389;
    use stun_codec::{MessageDecoder, MessageEncoder};
    use trackable::error::MainError;

    use super::*;
    use auth::AuthParams;
    use transport::UdpOverTurnTransporter;

    #[test]
    fn it_works() -> std::result::Result<(), MainError> {
        let client_auth_params = track!(AuthParams::new("foo", "bar"))?;
        let server_auth_params =
            track!(AuthParams::with_realm_and_nonce("foo", "bar", "baz", "qux"))?;

        // STUN server (peer)
        let stun_server = fibers_global::execute(rustun::server::UdpServer::start(
            fibers_global::handle(),
            "127.0.0.1:0".parse().unwrap(),
            rustun::server::BindingHandler,
        ))?;
        let stun_server_addr = stun_server.local_addr();
        fibers_global::spawn(stun_server.map(|_| ()).map_err(|e| panic!("{}", e)));

        // TURN server
        let turn_server = fibers_global::execute(server::UdpServer::start(
            "127.0.0.1:0".parse().unwrap(),
            server_auth_params,
        ))?;
        let turn_server_addr = turn_server.local_addr();
        fibers_global::spawn(turn_server.map_err(|e| panic!("{}", e)));

        // TURN client
        let turn_client = track!(fibers_global::execute(client::UdpClient::allocate(
            turn_server_addr,
            client_auth_params
        )))?;
        let transporter =
            UdpOverTurnTransporter::<_, MessageEncoder<_>, MessageDecoder<_>>::new(turn_client);

        // STUN client (over TURN)
        let stun_channel = rustun::channel::Channel::new(StunUdpTransporter::new(transporter));
        let stun_client = rustun::client::Client::new(&fibers_global::handle(), stun_channel);

        // BINDING request
        let request = Request::<rfc5389::Attribute>::new(rfc5389::methods::BINDING);
        let response = track!(fibers_global::execute(
            stun_client.call(stun_server_addr, request)
        ))?;
        assert!(response.is_ok(), "{:?}", response);

        Ok(())
    }
}