diff --git a/crates/irtt-client/src/client.rs b/crates/irtt-client/src/client.rs new file mode 100644 index 0000000..437c1ce --- /dev/null +++ b/crates/irtt-client/src/client.rs @@ -0,0 +1,699 @@ +use std::{ + io, + net::{SocketAddr, UdpSocket}, + time::Duration, +}; + +use irtt_proto::{ + close::CloseRequest, decode_open_reply, encode_close_request, encode_open_request, flags, + OpenReply, OpenRequest, Params, ServerFill, PROTOCOL_VERSION, +}; + +use crate::{ + config::{ClientConfig, RunMode}, + error::ClientError, + event::{ClientEvent, OpenOutcome}, + session::{validate_negotiated_params, ClientState, NegotiatedParams}, + socket::{connect_udp_socket, resolve_remote, validate_open_timeouts}, + timing::ClientTimestamp, +}; + +const MAX_OPEN_PACKET_SIZE: usize = 512; + +#[derive(Debug)] +pub struct Client { + config: ClientConfig, + socket: UdpSocket, + remote: SocketAddr, + requested: Params, + negotiated: Option, + state: ClientState, +} + +impl Client { + pub fn connect(config: ClientConfig) -> Result { + validate_open_timeouts(&config.open_timeouts)?; + let remote = resolve_remote(&config)?; + let socket = connect_udp_socket(&config.socket_config, remote)?; + let requested = params_from_config(&config)?; + + Ok(Self { + config, + socket, + remote, + requested, + negotiated: None, + state: ClientState::Connected, + }) + } + + pub fn open(&mut self, now: ClientTimestamp) -> Result { + validate_open_timeouts(&self.config.open_timeouts)?; + let request = OpenRequest { + params: self.requested.clone(), + close: self.config.run_mode == RunMode::NoTest, + }; + let packet = encode_open_request(&request, self.config.hmac_key.as_deref())?; + let mut buf = [0_u8; MAX_OPEN_PACKET_SIZE]; + + for timeout in &self.config.open_timeouts { + self.socket.set_read_timeout(Some(*timeout))?; + self.socket.send(&packet)?; + + match self.socket.recv(&mut buf) { + Ok(size) => { + let reply = decode_open_reply(&buf[..size], self.config.hmac_key.as_deref())?; + return self.accept_open_reply(reply, now); + } + Err(err) + if matches!( + err.kind(), + io::ErrorKind::WouldBlock | io::ErrorKind::TimedOut + ) => {} + Err(err) => return Err(ClientError::Socket(err)), + } + } + + Err(ClientError::OpenTimeout) + } + + pub fn close(&mut self, now: ClientTimestamp) -> Result, ClientError> { + let token = match self.state { + ClientState::Open { token } => token, + ClientState::Closed => return Err(ClientError::AlreadyClosed), + ClientState::Connected | ClientState::NoTestCompleted => { + return Err(ClientError::NotOpen) + } + }; + + let packet = + encode_close_request(&CloseRequest { token }, self.config.hmac_key.as_deref())?; + self.socket.send(&packet)?; + self.state = ClientState::Closed; + + Ok(vec![ClientEvent::SessionClosed { + remote: self.remote, + token, + at: now, + }]) + } + + fn accept_open_reply( + &mut self, + reply: OpenReply, + now: ClientTimestamp, + ) -> Result { + if reply.params.protocol_version != PROTOCOL_VERSION { + return Err(ClientError::ProtocolVersionMismatch { + requested: PROTOCOL_VERSION, + received: reply.params.protocol_version, + }); + } + + let reply_is_close = flags::has(reply.flags, flags::FLAG_CLOSE); + match self.config.run_mode { + RunMode::Normal if reply_is_close => Err(ClientError::ServerRejected), + RunMode::Normal if reply.token == 0 => Err(ClientError::ZeroToken), + RunMode::Normal => self.accept_normal_open(reply, now), + RunMode::NoTest if !reply_is_close => Err(ClientError::UnexpectedNoTestReply), + RunMode::NoTest if reply.token != 0 => { + Err(ClientError::NonZeroNoTestToken { token: reply.token }) + } + RunMode::NoTest => self.accept_no_test_open(reply, now), + } + } + + fn accept_normal_open( + &mut self, + reply: OpenReply, + now: ClientTimestamp, + ) -> Result { + validate_negotiated_params( + &self.requested, + &reply.params, + self.config.negotiation_policy, + )?; + let negotiated = NegotiatedParams { + params: reply.params.clone(), + }; + self.negotiated = Some(negotiated.clone()); + self.state = ClientState::Open { token: reply.token }; + let event = ClientEvent::SessionStarted { + remote: self.remote, + token: reply.token, + negotiated: negotiated.clone(), + at: now, + }; + + Ok(OpenOutcome::Started { + remote: self.remote, + token: reply.token, + negotiated, + event, + }) + } + + fn accept_no_test_open( + &mut self, + reply: OpenReply, + now: ClientTimestamp, + ) -> Result { + validate_negotiated_params( + &self.requested, + &reply.params, + self.config.negotiation_policy, + )?; + let negotiated = NegotiatedParams { + params: reply.params.clone(), + }; + self.negotiated = Some(negotiated.clone()); + self.state = ClientState::NoTestCompleted; + let event = ClientEvent::NoTestCompleted { + remote: self.remote, + negotiated: negotiated.clone(), + at: now, + }; + Ok(OpenOutcome::NoTestCompleted { + remote: self.remote, + negotiated, + event, + }) + } +} + +fn params_from_config(config: &ClientConfig) -> Result { + Ok(Params { + protocol_version: PROTOCOL_VERSION, + duration_ns: duration_to_ns(config.duration.unwrap_or_default())?, + interval_ns: duration_to_ns(config.interval)?, + length: i64::from(config.length), + received_stats: config.received_stats, + stamp_at: config.stamp_at, + clock: config.clock, + dscp: i64::from(config.dscp), + server_fill: config.server_fill.clone().map(|value| ServerFill { value }), + }) +} + +fn duration_to_ns(duration: Duration) -> Result { + i64::try_from(duration.as_nanos()).map_err(|_| ClientError::DurationOverflow) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::config::{NegotiationPolicy, DEFAULT_OPEN_TIMEOUTS}; + use irtt_proto::{ + compute_hmac_in_place, flags::FLAG_HMAC, flags::FLAG_OPEN, flags::FLAG_REPLY, verify_hmac, + Clock, ReceivedStats, StampAt, HMAC_SIZE, MAGIC, + }; + use std::{ + net::UdpSocket, + sync::mpsc, + thread::{self, JoinHandle}, + }; + + const TOKEN: u64 = 0x1234_5678_90ab_cdef; + const HMAC_OFFSET: usize = 4; + + struct FakeServer { + addr: SocketAddr, + rx: mpsc::Receiver>, + done: JoinHandle<()>, + } + + impl FakeServer { + fn join(self) { + self.done.join().unwrap(); + } + } + + fn default_test_config(addr: SocketAddr) -> ClientConfig { + ClientConfig { + server_addr: addr.to_string(), + open_timeouts: vec![Duration::from_millis(200), Duration::from_millis(200)], + ..ClientConfig::default() + } + } + + fn start_fake_server(handler: F) -> FakeServer + where + F: FnOnce(UdpSocket, mpsc::Sender>) + Send + 'static, + { + let socket = UdpSocket::bind("127.0.0.1:0").unwrap(); + let addr = socket.local_addr().unwrap(); + let (tx, rx) = mpsc::channel(); + let done = thread::spawn(move || handler(socket, tx)); + FakeServer { addr, rx, done } + } + + fn recv_request(socket: &UdpSocket, tx: &mpsc::Sender>) -> (Vec, SocketAddr) { + let mut buf = [0_u8; 512]; + let (size, peer) = socket.recv_from(&mut buf).unwrap(); + let packet = buf[..size].to_vec(); + tx.send(packet.clone()).unwrap(); + (packet, peer) + } + + fn open_reply(flags: u8, token: u64, params: &Params, hmac_key: Option<&[u8]>) -> Vec { + let mut packet = Vec::new(); + packet.extend_from_slice(&MAGIC); + packet.push(flags | hmac_key.map_or(0, |_| FLAG_HMAC)); + if hmac_key.is_some() { + packet.extend_from_slice(&[0_u8; HMAC_SIZE]); + } + packet.extend_from_slice(&token.to_le_bytes()); + packet.extend_from_slice(¶ms.encode()); + if let Some(key) = hmac_key { + compute_hmac_in_place(key, &mut packet, HMAC_OFFSET).unwrap(); + } + packet + } + + fn open_success_server(params: Params) -> FakeServer { + start_fake_server(move |socket, tx| { + let (_, peer) = recv_request(&socket, &tx); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, None); + socket.send_to(&reply, peer).unwrap(); + }) + } + + fn no_test_server(params: Params, token: u64) -> FakeServer { + start_fake_server(move |socket, tx| { + let (request, peer) = recv_request(&socket, &tx); + assert_eq!(request[3] & flags::FLAG_CLOSE, flags::FLAG_CLOSE); + let reply = open_reply( + FLAG_OPEN | FLAG_REPLY | flags::FLAG_CLOSE, + token, + ¶ms, + None, + ); + socket.send_to(&reply, peer).unwrap(); + }) + } + + fn assert_open_started(outcome: OpenOutcome) -> NegotiatedParams { + match outcome { + OpenOutcome::Started { + token, negotiated, .. + } => { + assert_eq!(token, TOKEN); + negotiated + } + OpenOutcome::NoTestCompleted { .. } => panic!("unexpected no-test outcome"), + } + } + + fn assert_no_test_completed(outcome: OpenOutcome) -> NegotiatedParams { + match outcome { + OpenOutcome::NoTestCompleted { + negotiated, event, .. + } => { + assert!(matches!( + event, + ClientEvent::NoTestCompleted { + negotiated: ref event_params, + .. + } if *event_params == negotiated + )); + negotiated + } + OpenOutcome::Started { .. } => panic!("unexpected started outcome"), + } + } + + #[test] + fn client_config_default() { + let config = ClientConfig::default(); + assert_eq!(config.duration, Some(Duration::from_secs(3))); + assert_eq!(config.interval, Duration::from_secs(1)); + assert_eq!(config.length, 0); + assert_eq!(config.received_stats, ReceivedStats::Both); + assert_eq!(config.stamp_at, StampAt::Both); + assert_eq!(config.clock, Clock::Both); + assert_eq!(config.dscp, 0); + assert_eq!(config.hmac_key, None); + assert_eq!(config.server_fill, None); + assert_eq!(config.open_timeouts, DEFAULT_OPEN_TIMEOUTS); + assert_eq!(config.run_mode, RunMode::Normal); + assert_eq!(config.negotiation_policy, NegotiationPolicy::Strict); + } + + #[test] + fn address_resolution_connects_to_local_fake_server() { + let server = start_fake_server(|socket, tx| { + let _ = recv_request(&socket, &tx); + }); + let client = Client::connect(default_test_config(server.addr)).unwrap(); + client.socket.send(b"ping").unwrap(); + assert_eq!(server.rx.recv().unwrap(), b"ping"); + server.join(); + } + + #[test] + fn successful_open_handshake() { + let config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + let params = params_from_config(&config).unwrap(); + let server = open_success_server(params.clone()); + let mut client = Client::connect(default_test_config(server.addr)).unwrap(); + + let negotiated = assert_open_started(client.open(ClientTimestamp::now()).unwrap()); + assert_eq!(negotiated.params, params); + assert!(matches!(client.state, ClientState::Open { token: TOKEN })); + server.join(); + } + + #[test] + fn open_retries_after_first_timeout() { + let server = start_fake_server(|socket, tx| { + let (first, _) = recv_request(&socket, &tx); + let (_, peer) = recv_request(&socket, &tx); + let params = Params::decode(&first[4..]).unwrap(); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, None); + assert_eq!(first[3] & FLAG_OPEN, FLAG_OPEN); + socket.send_to(&reply, peer).unwrap(); + }); + let config = ClientConfig { + open_timeouts: vec![Duration::from_millis(200), Duration::from_millis(500)], + ..default_test_config(server.addr) + }; + let mut client = Client::connect(config).unwrap(); + let outcome = client.open(ClientTimestamp::now()).unwrap(); + assert_open_started(outcome); + assert_eq!(server.rx.iter().take(2).count(), 2); + server.join(); + } + + #[test] + fn open_timeout_after_all_timeouts() { + let server = start_fake_server(|socket, tx| { + socket + .set_read_timeout(Some(Duration::from_millis(700))) + .unwrap(); + while recv_request_timeout(&socket, &tx).is_some() {} + }); + let config = ClientConfig { + open_timeouts: vec![Duration::from_millis(200), Duration::from_millis(200)], + ..default_test_config(server.addr) + }; + let mut client = Client::connect(config).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::OpenTimeout) + )); + assert_eq!(server.rx.iter().take(2).count(), 2); + server.join(); + } + + fn recv_request_timeout( + socket: &UdpSocket, + tx: &mpsc::Sender>, + ) -> Option<(Vec, SocketAddr)> { + let mut buf = [0_u8; 512]; + match socket.recv_from(&mut buf) { + Ok((size, peer)) => { + let packet = buf[..size].to_vec(); + tx.send(packet.clone()).unwrap(); + Some((packet, peer)) + } + Err(_) => None, + } + } + + #[test] + fn strict_negotiation_accepts_identical_params() { + let config = ClientConfig::default(); + let params = params_from_config(&config).unwrap(); + assert!(validate_negotiated_params(¶ms, ¶ms, NegotiationPolicy::Strict).is_ok()); + } + + #[test] + fn strict_negotiation_rejects_changed_params() { + let config = ClientConfig::default(); + let requested = params_from_config(&config).unwrap(); + let mut returned = requested.clone(); + returned.dscp = 1; + assert!(matches!( + validate_negotiated_params(&requested, &returned, NegotiationPolicy::Strict), + Err(ClientError::NegotiationRejected { .. }) + )); + } + + #[test] + fn loose_negotiation_accepts_server_restricted_params() { + let config = ClientConfig::default(); + let requested = params_from_config(&config).unwrap(); + let mut returned = requested.clone(); + returned.duration_ns /= 2; + returned.length = 0; + assert!( + validate_negotiated_params(&requested, &returned, NegotiationPolicy::Loose).is_ok() + ); + } + + #[test] + fn protocol_version_mismatch_fails() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.negotiation_policy = NegotiationPolicy::Loose; + let mut params = params_from_config(&config).unwrap(); + params.protocol_version = 2; + let server = open_success_server(params); + let mut client = Client::connect(default_test_config(server.addr)).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::ProtocolVersionMismatch { received: 2, .. }) + )); + server.join(); + } + + #[test] + fn server_rejection_fails_in_normal_mode() { + let config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + let params = params_from_config(&config).unwrap(); + let server = start_fake_server(move |socket, tx| { + let (_, peer) = recv_request(&socket, &tx); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY | flags::FLAG_CLOSE, 0, ¶ms, None); + socket.send_to(&reply, peer).unwrap(); + }); + let mut client = Client::connect(default_test_config(server.addr)).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::ServerRejected) + )); + server.join(); + } + + #[test] + fn no_test_open_close_succeeds_on_open_reply_close() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.run_mode = RunMode::NoTest; + let params = params_from_config(&config).unwrap(); + let server = no_test_server(params.clone(), 0); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + let negotiated = assert_no_test_completed(client.open(ClientTimestamp::now()).unwrap()); + assert_eq!(negotiated.params, params); + assert_eq!(client.negotiated.as_ref(), Some(&negotiated)); + assert!(matches!( + client.close(ClientTimestamp::now()), + Err(ClientError::NotOpen) + )); + server.join(); + } + + #[test] + fn no_test_success_validates_params() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.run_mode = RunMode::NoTest; + let params = params_from_config(&config).unwrap(); + let server = no_test_server(params.clone(), 0); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + let negotiated = assert_no_test_completed(client.open(ClientTimestamp::now()).unwrap()); + assert_eq!(negotiated.params, params); + server.join(); + } + + #[test] + fn no_test_rejects_non_close_open_reply() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.run_mode = RunMode::NoTest; + let params = params_from_config(&config).unwrap(); + let server = open_success_server(params); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::UnexpectedNoTestReply) + )); + server.join(); + } + + #[test] + fn no_test_rejects_non_zero_token_with_close_reply() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.run_mode = RunMode::NoTest; + let params = params_from_config(&config).unwrap(); + let server = no_test_server(params, TOKEN); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::NonZeroNoTestToken { token: TOKEN }) + )); + server.join(); + } + + #[test] + fn no_test_strict_negotiation_rejects_changed_params() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.run_mode = RunMode::NoTest; + let mut params = params_from_config(&config).unwrap(); + params.dscp = 1; + let server = no_test_server(params, 0); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::NegotiationRejected { .. }) + )); + server.join(); + } + + #[test] + fn no_test_loose_negotiation_accepts_restricted_params() { + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.run_mode = RunMode::NoTest; + config.negotiation_policy = NegotiationPolicy::Loose; + let mut params = params_from_config(&config).unwrap(); + params.duration_ns /= 2; + let server = no_test_server(params.clone(), 0); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + let negotiated = assert_no_test_completed(client.open(ClientTimestamp::now()).unwrap()); + assert_eq!(negotiated.params, params); + server.join(); + } + + #[test] + fn close_sends_one_close_packet_with_negotiated_token() { + let config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + let params = params_from_config(&config).unwrap(); + let server = start_fake_server(move |socket, tx| { + let (_, peer) = recv_request(&socket, &tx); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, None); + socket.send_to(&reply, peer).unwrap(); + let _ = recv_request(&socket, &tx); + }); + let mut client = Client::connect(default_test_config(server.addr)).unwrap(); + assert_open_started(client.open(ClientTimestamp::now()).unwrap()); + let events = client.close(ClientTimestamp::now()).unwrap(); + assert_eq!(events.len(), 1); + let packets: Vec<_> = server.rx.iter().take(2).collect(); + let close = &packets[1]; + assert_eq!(close[3], flags::FLAG_CLOSE); + assert_eq!(u64::from_le_bytes(close[4..12].try_into().unwrap()), TOKEN); + server.join(); + } + + #[test] + fn hmac_open_success() { + let key = b"secret".to_vec(); + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.hmac_key = Some(key.clone()); + let params = params_from_config(&config).unwrap(); + let server = start_fake_server(move |socket, tx| { + let (request, peer) = recv_request(&socket, &tx); + verify_hmac(&key, &request, HMAC_OFFSET).unwrap(); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, Some(&key)); + socket.send_to(&reply, peer).unwrap(); + }); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert_open_started(client.open(ClientTimestamp::now()).unwrap()); + server.join(); + } + + #[test] + fn hmac_open_rejects_missing_hmac() { + let key = b"secret".to_vec(); + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.hmac_key = Some(key); + let params = params_from_config(&config).unwrap(); + let server = start_fake_server(move |socket, tx| { + let (_, peer) = recv_request(&socket, &tx); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, None); + socket.send_to(&reply, peer).unwrap(); + }); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::Protocol( + irtt_proto::ProtoError::HmacPresenceMismatch + )) + )); + server.join(); + } + + #[test] + fn hmac_open_rejects_bad_hmac() { + let key = b"secret".to_vec(); + let wrong_key = b"wrong".to_vec(); + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.hmac_key = Some(key); + let params = params_from_config(&config).unwrap(); + let server = start_fake_server(move |socket, tx| { + let (_, peer) = recv_request(&socket, &tx); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, Some(&wrong_key)); + socket.send_to(&reply, peer).unwrap(); + }); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert!(matches!( + client.open(ClientTimestamp::now()), + Err(ClientError::Protocol(irtt_proto::ProtoError::BadHmac)) + )); + server.join(); + } + + #[test] + fn hmac_close_packet_includes_valid_hmac() { + let key = b"secret".to_vec(); + let mut config = default_test_config(SocketAddr::from(([127, 0, 0, 1], 1))); + config.hmac_key = Some(key.clone()); + let params = params_from_config(&config).unwrap(); + let server_key = key.clone(); + let server = start_fake_server(move |socket, tx| { + let (_, peer) = recv_request(&socket, &tx); + let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, ¶ms, Some(&server_key)); + socket.send_to(&reply, peer).unwrap(); + let _ = recv_request(&socket, &tx); + }); + config.server_addr = server.addr.to_string(); + let mut client = Client::connect(config).unwrap(); + assert_open_started(client.open(ClientTimestamp::now()).unwrap()); + client.close(ClientTimestamp::now()).unwrap(); + let packets: Vec<_> = server.rx.iter().take(2).collect(); + let close = &packets[1]; + assert_eq!(close[3], flags::FLAG_CLOSE | FLAG_HMAC); + verify_hmac(&key, close, HMAC_OFFSET).unwrap(); + assert_eq!( + u64::from_le_bytes(close[4 + HMAC_SIZE..12 + HMAC_SIZE].try_into().unwrap()), + TOKEN + ); + server.join(); + } + + #[test] + fn minimum_open_timeout_under_200ms_is_rejected() { + let config = ClientConfig { + open_timeouts: vec![Duration::from_millis(199)], + ..ClientConfig::default() + }; + assert!(matches!( + Client::connect(config), + Err(ClientError::OpenTimeoutTooSmall { .. }) + )); + } +}