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
pub mod channels;
pub mod nodes;
pub mod nonces;
pub mod ports;
use nodes::Nodes;
use ports::Ports;
use nonces::Nonces;
use channels::Channels;
use faster_stun::util::long_key;
use crate::Observer;
use std::sync::atomic::{
AtomicBool,
Ordering,
};
use std::{
time::Duration,
net::SocketAddr,
sync::Arc,
thread,
};
/// Router State Tree.
///
/// this state management example maintains the status of all
/// nodes in the current service and adds a node grouping model.
/// it is necessary to specify a group for each node.
///
/// The state between groups is isolated. However,
/// it should be noted that the node key only supports
/// long-term valid passwords,does not support short-term
/// valid passwords.
pub struct Router {
realm: String,
observer: Arc<dyn Observer>,
ports: Ports,
nonces: Nonces,
nodes: Nodes,
channels: Channels,
is_close: AtomicBool,
}
impl Router {
/// create a router.
///
/// ```ignore
/// struct Events;
///
/// impl Observer for Events {
/// fn auth(&self, _addr: &SocketAddr, _name: &str) -> Option<&str> {
/// Some("test")
/// }
/// }
///
/// let _router = Router::new(
/// "test".to_string(),
/// Arc::new(Events {}),
/// );
/// ```
pub(crate) fn new(realm: String, observer: Arc<dyn Observer>) -> Arc<Self> {
let this = Arc::new(Self {
is_close: AtomicBool::new(false),
channels: Channels::new(),
nonces: Nonces::new(),
ports: Ports::new(),
nodes: Nodes::new(),
observer,
realm,
});
let this_ = this.clone();
thread::spawn(move || loop {
thread::sleep(Duration::from_secs(60));
if this_.is_close.load(Ordering::Relaxed) {
break;
}
for a in this_.nodes.get_deaths() {
this_.remove(&a);
}
for c in this_.channels.get_deaths() {
this_.channels.remove(c);
}
});
this
}
/// get router capacity.
pub fn capacity(&self) -> usize {
self.ports.capacity()
}
/// get router allocate size.
pub fn len(&self) -> usize {
self.ports.len()
}
/// get user list.
///
/// ```ignore
/// let router = Router::new(/* ... */);
///
/// assert!(router.get_users(0, 10).len() == 0);
/// ```
pub fn get_users(
&self,
skip: usize,
limit: usize,
) -> Vec<(String, Vec<SocketAddr>)> {
self.nodes.get_users(skip, limit)
}
/// get node.
///
/// ```ignore
/// let router = Router::new(/* ... */);
///
/// assert!(router.get_node().is_none());
/// ```
pub fn get_node(&self, a: &SocketAddr) -> Option<nodes::Node> {
self.nodes.get_node(a)
}
/// get node bound list.
///
/// ```ignore
/// let router = Router::new(/* ... */);
///
/// assert!(router.get_node_bounds().len() == 0);
/// ```
pub fn get_node_addrs(&self, u: &str) -> Vec<SocketAddr> {
self.nodes.get_addrs(u)
}
/// get the nonce of the node SocketAddr.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// assert!(state.get_nonce(&addr).len() == 16);
/// ```
pub fn get_nonce(&self, a: &SocketAddr) -> Arc<String> {
self.nonces.get(a)
}
/// get the password of the node SocketAddr.
///
/// require remote control service to distribute keys.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// // state.get_key(&addr, "panda")
/// ```
pub async fn get_key(
&self,
index: u8,
a: &SocketAddr,
u: &str,
) -> Option<Arc<[u8; 16]>> {
let key = self.nodes.get_secret(a);
if key.is_some() {
return key;
}
let pwd = self.observer.auth(a, u).await?;
let key = long_key(u, &pwd, &self.realm);
self.nodes.insert(index, a, u, key, pwd)
}
/// obtain the peer address bound to the current
/// node according to the channel number.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:8081".parse::<SocketAddr>().unwrap();
///
/// state.get_key(&addr, "panda");
/// state.get_key(&peer, "panda");
///
/// let addr_port = state.alloc_port(&addr).unwrap();
/// let peer_port = state.alloc_port(&peer).unwrap();
///
/// state.bind_channel(&addr, peer_port, 0x4000);
/// state.bind_channel(&peer, addr_port, 0x4000);
///
/// assert_eq!(state.get_channel_bound(&addr, 0x4000).unwrap(), peer);
/// ```
pub fn get_channel_bound(
&self,
a: &SocketAddr,
c: u16,
) -> Option<SocketAddr> {
self.channels.get_bound(a, c)
}
/// obtain the peer address bound to the current
/// node according to the port number.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:8081".parse::<SocketAddr>().unwrap();
///
/// state.get_key(&addr, "panda");
/// state.get_key(&peer, "panda");
///
/// let addr_port = state.alloc_port(&addr).unwrap();
/// let peer_port = state.alloc_port(&peer).unwrap();
///
/// state.bind_port(&peer, addr_port);
/// state.bind_port(&addr, peer_port);
///
/// assert_eq!(state.get_port_bound(&addr, peer_port), some(peer));
/// assert_eq!(state.get_port_bound(&peer, addr_port), some(addr));
/// ```
pub fn get_port_bound(&self, p: u16) -> Option<SocketAddr> {
self.ports.get(p)
}
/// get node the port.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:8081".parse::<SocketAddr>().unwrap();
///
/// state.get_key(&addr, "panda");
/// state.get_key(&peer, "panda");
///
/// let addr_port = state.alloc_port(&addr).unwrap();
/// let peer_port = state.alloc_port(&peer).unwrap();
///
/// state.bind_port(&peer, addr_port);
/// state.bind_port(&addr, peer_port);
///
/// assert_eq!(state.get_bound_port(&addr, &peer), some(peer_port));
/// assert_eq!(state.get_bound_port(&peer, &addr), some(addr_port));
/// ```
pub fn get_bound_port(
&self,
a: &SocketAddr,
p: &SocketAddr,
) -> Option<u16> {
self.ports.get_bound(a, p)
}
/// alloc a port from State.
///
/// In all cases, the server SHOULD only allocate ports from the range
/// 49152 - 65535 (the Dynamic and/or Private Port range [PORT-NUMBERS]),
/// unless the TURN server application knows, through some means not
/// specified here, that other applications running on the same host as
/// the TURN server application will not be impacted by allocating ports
/// outside this range. This condition can often be satisfied by running
/// the TURN server application on a dedicated machine and/or by
/// arranging that any other applications on the machine allocate ports
/// before the TURN server application starts. In any case, the TURN
/// server SHOULD NOT allocate ports in the range 0 - 1023 (the Well-
/// Known Port range) to discourage clients from using TURN to run
/// standard services.
///
/// NOTE: The use of randomized port assignments to avoid certain
/// types of attacks is described in [RFC6056]. It is RECOMMENDED
/// that a TURN server implement a randomized port assignment
/// algorithm from [RFC6056]. This is especially applicable to
/// servers that choose to pre-allocate a number of ports from the
/// underlying OS and then later assign them to allocations; for
/// example, a server may choose this technique to implement the
/// EVEN-PORT attribute.
///
/// The server determines the initial value of the time-to-expiry field
/// as follows. If the request contains a LIFETIME attribute, then the
/// server computes the minimum of the client's proposed lifetime and the
/// server's maximum allowed lifetime. If this computed value is greater
/// than the default lifetime, then the server uses the computed lifetime
/// as the initial value of the time-to-expiry field. Otherwise, the
/// server uses the default lifetime. It is RECOMMENDED that the server
/// use a maximum allowed lifetime value of no more than 3600 seconds (1
/// hour). Servers that implement allocation quotas or charge users for
/// allocations in some way may wish to use a smaller maximum allowed
/// lifetime (perhaps as small as the default lifetime) to more quickly
/// remove orphaned allocations (that is, allocations where the
/// corresponding client has crashed or terminated, or the client
/// connection has been lost for some reason). Also, note that the time-
/// to-expiry is recomputed with each successful Refresh request, and
/// thus, the value computed here applies only until the first refresh.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:8081".parse::<SocketAddr>().unwrap();
///
/// state.get_key(&addr, "panda");
/// state.get_key(&peer, "panda");
///
/// assert!(state.alloc_port(&addr).unwrap().is_some());
/// assert!(state.alloc_port(&peer).unwrap().is_some());
/// ```
pub fn alloc_port(&self, a: &SocketAddr) -> Option<u16> {
let port = self.ports.alloc(a)?;
self.nodes.push_port(a, port);
Some(port)
}
/// bind port for State.
///
/// A server need not do anything special to implement
/// idempotency of CreatePermission requests over UDP using the
/// "stateless stack approach". Retransmitted CreatePermission
/// requests will simply refresh the permissions.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:8081".parse::<SocketAddr>().unwrap();
///
/// state.get_key(&addr, "panda");
/// state.get_key(&peer, "panda");
///
/// let addr_port = state.alloc_port(&addr).unwrap();
/// let peer_port = state.alloc_port(&peer).unwrap();
///
/// assert!(state.bind_port(&peer, addr_port).is_some());
/// assert!(state.bind_port(&addr, peer_port).is_some());
/// ```
pub fn bind_port(&self, a: &SocketAddr, port: u16) -> Option<()> {
self.ports.bound(a, port)
}
/// bind channel number for State.
///
/// A server need not do anything special to implement
/// idempotency of ChannelBind requests over UDP using the
/// "stateless stack approach". Retransmitted ChannelBind requests
/// will simply refresh the channel binding and the corresponding
/// permission. Furthermore, the client must wait 5 minutes before
/// binding a previously bound channel number or peer address to a
/// different channel, eliminating the possibility that the
/// transaction would initially fail but succeed on a
/// retransmission.
///
/// ```ignore
/// let state = Router::new(/* ... */);
///
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:8081".parse::<SocketAddr>().unwrap();
///
/// state.get_key(&addr, "panda");
/// state.get_key(&peer, "panda");
///
/// let addr_port = state.alloc_port(&addr).unwrap();
/// let peer_port = state.alloc_port(&peer).unwrap();
///
/// assert!(state.bind_channel(&peer, addr_port, 0x4000).is_some());
/// assert!(state.bind_channel(&addr, peer_port, 0x4000).is_some());
/// ```
pub fn bind_channel(&self, a: &SocketAddr, p: u16, c: u16) -> Option<()> {
let source = self.ports.get(p)?;
self.channels.insert(a, c, &source)?;
self.nodes.push_channel(a, c)?;
Some(())
}
/// refresh node lifetime.
///
/// The server computes a value called the "desired lifetime" as follows:
/// if the request contains a LIFETIME attribute and the attribute value
/// is zero, then the "desired lifetime" is zero. Otherwise, if the
/// request contains a LIFETIME attribute, then the server computes the
/// minimum of the client's requested lifetime and the server's maximum
/// allowed lifetime. If this computed value is greater than the default
/// lifetime, then the "desired lifetime" is the computed value.
/// Otherwise, the "desired lifetime" is the default lifetime.
///
/// Subsequent processing depends on the "desired lifetime" value:
///
/// * If the "desired lifetime" is zero, then the request succeeds and the
/// allocation is deleted.
///
/// * If the "desired lifetime" is non-zero, then the request succeeds and
/// the allocation's time-to-expiry is set to the "desired lifetime".
///
/// If the request succeeds, then the server sends a success response
/// containing:
///
/// * A LIFETIME attribute containing the current value of the time-to-
/// expiry timer.
///
/// NOTE: A server need not do anything special to implement
/// idempotency of Refresh requests over UDP using the "stateless
/// stack approach". Retransmitted Refresh requests with a non-
/// zero "desired lifetime" will simply refresh the allocation. A
/// retransmitted Refresh request with a zero "desired lifetime"
/// will cause a 437 (Allocation Mismatch) response if the
/// allocation has already been deleted, but the client will treat
/// this as equivalent to a success response (see below).
///
/// ```ignore
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let state = Router::new(/* ... */);
///
/// state.get_key(&addr, "panda");
/// state.refresh(&addr, 600);
/// state.refresh(&addr, 0);
/// ```
pub fn refresh(&self, a: &SocketAddr, delay: u32) {
if delay > 0 {
self.nodes.set_lifetime(a, delay);
} else {
self.remove(a);
}
}
/// remove a node.
///
/// ```ignore
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let state = Router::new(/* ... */);
///
/// state.get_key(&addr, "panda");
/// state.remove(&addr);
/// ```
pub fn remove(&self, a: &SocketAddr) -> Option<()> {
let node = self.nodes.remove(a)?;
self.ports.remove(a, &node.ports);
for c in node.channels {
self.channels.remove(c)?;
}
self.nonces.remove(a);
self.observer.abort(a, &node.username);
Some(())
}
/// remove a node from username.
///
/// ```ignore
/// let addr = "127.0.0.1:8080".parse::<SocketAddr>().unwrap();
/// let state = Router::new(/* ... */);
///
/// state.get_key(&addr, "panda");
/// state.remove_from_user("panda");
/// ```
pub fn remove_from_user(&self, u: &str) {
for addr in self.nodes.get_addrs(u) {
self.remove(&addr);
}
}
}
impl Drop for Router {
fn drop(&mut self) {
self.is_close.store(true, Ordering::Relaxed);
}
}