diff --git a/Cargo.lock b/Cargo.lock index 000b87b..de80a9e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -292,7 +292,7 @@ checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" [[package]] name = "auth" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "block2", @@ -554,7 +554,7 @@ dependencies = [ [[package]] name = "browser-launcher" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "log", @@ -919,7 +919,7 @@ dependencies = [ [[package]] name = "common" -version = "3.7.0" +version = "3.7.1" dependencies = [ "tempfile", ] @@ -2133,7 +2133,7 @@ dependencies = [ [[package]] name = "gp-xml" -version = "3.7.0" +version = "3.7.1" dependencies = [ "url", "xmltree", @@ -2141,7 +2141,7 @@ dependencies = [ [[package]] name = "gpapi" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "base64 0.23.1", @@ -2205,7 +2205,7 @@ dependencies = [ [[package]] name = "gpauth" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "auth", @@ -2223,7 +2223,7 @@ dependencies = [ [[package]] name = "gpclient" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "clap", @@ -2254,7 +2254,7 @@ dependencies = [ [[package]] name = "gpgui-helper" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "clap", @@ -2275,7 +2275,7 @@ dependencies = [ [[package]] name = "gphip" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "askama", @@ -2294,7 +2294,7 @@ dependencies = [ [[package]] name = "gpservice" -version = "3.7.0" +version = "3.7.1" dependencies = [ "anyhow", "axum", @@ -2332,7 +2332,7 @@ dependencies = [ [[package]] name = "gptunnel" -version = "3.7.0" +version = "3.7.1" dependencies = [ "gpapi", "log", @@ -2344,7 +2344,7 @@ dependencies = [ [[package]] name = "gpvpnc" -version = "3.7.0" +version = "3.7.1" dependencies = [ "base64 0.23.1", "ipnet", @@ -3860,7 +3860,7 @@ dependencies = [ [[package]] name = "openconnect" -version = "3.7.0" +version = "3.7.1" dependencies = [ "autotools", "cc", diff --git a/Cargo.toml b/Cargo.toml index 0d53833..3d46e24 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ members = [ [workspace.package] rust-version = "1.91" -version = "3.7.0" +version = "3.7.1" authors = ["Kevin Yue "] homepage = "https://github.com/yuezk/GlobalProtect-openconnect" edition = "2024" diff --git a/README.md b/README.md index f76966c..d04b0c8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,13 @@ **GP Connect** is a GlobalProtect VPN client built on OpenConnect. The desktop app runs on Windows, macOS, Linux, FreeBSD, and OpenBSD. The command-line client is `gpclient`. -[Features](#features) · [Installation](#installation) · [Usage](#usage) · [Troubleshooting](#troubleshooting) · [Building from source](#building-from-source) +

+ Features · + Installation · + Usage · + Troubleshooting · + Building from source +

@@ -117,7 +123,7 @@ On glibc systems, install the prebuilt package: sudo emerge --ask net-vpn/globalprotect-openconnect-bin::yuezk ``` -The source package is `net-vpn/globalprotect-openconnect::yuezk`. +The source package is `net-vpn/globalprotect-openconnect::yuezk`. For a headless installation, see the [CLI-only overlay instructions](https://github.com/yuezk/gentoo-overlay#cli-only). If Portage requests keyword or USE flag changes, review and apply them, then rerun the install command. @@ -154,7 +160,7 @@ Packages are available on the [openSUSE Build Service](https://build.opensuse.or ### Other Distributions -Requires glibc 2.39 or later. Download the archive for [x86_64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect_3.7.0_x86_64.bin.tar.xz) or [ARM64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect_3.7.0_aarch64.bin.tar.xz). +Download the archive for [x86_64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect_3.7.0_x86_64.bin.tar.xz) or [ARM64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect_3.7.0_aarch64.bin.tar.xz). ```bash tar -xJf globalprotect-openconnect_*.bin.tar.xz diff --git a/apps/gpservice/src/cli.rs b/apps/gpservice/src/cli.rs index 551d28d..53a515c 100644 --- a/apps/gpservice/src/cli.rs +++ b/apps/gpservice/src/cli.rs @@ -325,7 +325,10 @@ async fn wait_for_brokered_idle( _ = interval.tick() => {}, } - let idle = matches!(*vpn_state_rx.borrow(), VpnState::Disconnected | VpnState::Failed(_)) && registry.is_empty(); + let idle = matches!( + *vpn_state_rx.borrow(), + VpnState::Disconnected | VpnState::UnexpectedDisconnect { .. } | VpnState::Failed(_) + ) && registry.is_empty(); if !idle { idle_since = None; continue; diff --git a/apps/gpservice/src/request_dispatcher.rs b/apps/gpservice/src/request_dispatcher.rs index 5adaafb..f44be6d 100644 --- a/apps/gpservice/src/request_dispatcher.rs +++ b/apps/gpservice/src/request_dispatcher.rs @@ -174,6 +174,12 @@ impl RequestDispatcher { .stop_non_tunnel_attachment(authority.session_id, authority.generation, connection_id)?; Ok(PendingDispatch::Drain(drain)) } + WsRequest::AbandonReconnect { attempt } => { + let authority = authority + .ok_or_else(|| ServiceResult::rejected(ServiceErrorCode::InvalidRequest, "Connection session is missing"))?; + self.lifecycle.abandon_reconnect(attempt, authority.session_id); + Err(ServiceResult::Accepted) + } WsRequest::Disconnect(_) => Err(self.lifecycle.request_disconnect()), request => Ok(PendingDispatch::Other(request)), } @@ -259,6 +265,7 @@ impl RequestDispatcher { ServiceResult::Accepted } WsRequest::Connect(_) + | WsRequest::AbandonReconnect { .. } | WsRequest::StopNonTunnelAttachment { .. } | WsRequest::Disconnect(_) | WsRequest::StoreEditedHipReportChunk(_) diff --git a/apps/gpservice/src/vpn_task.rs b/apps/gpservice/src/vpn_task.rs index 8709b14..3679d79 100644 --- a/apps/gpservice/src/vpn_task.rs +++ b/apps/gpservice/src/vpn_task.rs @@ -76,6 +76,7 @@ impl LifecycleHandle { let cancellation = CancellationToken::new(); admissions.current = Some(Admission { attempt, + restart, phase: AdmissionPhase::Preparing, stop_requested: false, cancellation: cancellation.clone(), @@ -89,6 +90,19 @@ impl LifecycleHandle { }) } + pub fn abandon_reconnect(&self, attempt: u64, owner: Uuid) { + let mut admissions = self.admissions.lock().expect("VPN lifecycle admissions mutex poisoned"); + // A replacement that already owns admission will publish its own outcome. + if admissions.restart == Some((attempt, owner)) { + admissions.restart = None; + self.state.send_replace(VpnState::UnexpectedDisconnect { + attempt, + owner, + reason: None, + }); + } + } + #[cfg(test)] fn submit_test_connection( &self, @@ -217,7 +231,7 @@ impl LifecycleHandle { true } - fn clear_attempt(&self, attempt: u64) { + fn clear_attempt(&self, attempt: u64, state: Option) { let completion = { let mut admissions = self.admissions.lock().expect("VPN lifecycle admissions mutex poisoned"); let Some(admission) = admissions.current.as_ref() else { @@ -226,6 +240,20 @@ impl LifecycleHandle { if admission.attempt != attempt { return; } + let state = match admission.restart { + Some((attempt, owner)) if !admission.stop_requested && !admissions.closed => { + let reason = match state { + Some(VpnState::Failed(reason)) => Some(reason), + _ => None, + }; + Some(VpnState::UnexpectedDisconnect { attempt, owner, reason }) + } + Some(_) if state.is_none() => Some(VpnState::Disconnected), + _ => state, + }; + if let Some(state) = state { + self.state.send_replace(state); + } let completion = Arc::clone(&admission.completion); admissions.current = None; completion @@ -357,7 +385,7 @@ impl Drop for ConnectReservation { fn drop(&mut self) { if !self.transferred { self.cancellation.cancel(); - self.lifecycle.clear_attempt(self.attempt); + self.lifecycle.clear_attempt(self.attempt, None); // A full queue already wakes the actor; a closed queue has no actor to wake. let _ = self.lifecycle.events.try_send(LifecycleEvent::PreparationReleased); } @@ -375,6 +403,7 @@ struct Admissions { #[derive(Clone)] struct Admission { attempt: u64, + restart: Option<(u64, Uuid)>, phase: AdmissionPhase, stop_requested: bool, cancellation: CancellationToken, @@ -444,6 +473,7 @@ struct ActiveAttempt { task: tokio::task::JoinHandle<()>, failure: Option, reconnect_required: bool, + tunnel_established: bool, } pub(crate) struct VpnTask { @@ -638,6 +668,7 @@ impl VpnTask { task, failure: None, reconnect_required: false, + tunnel_established: false, }); if activated { self.send_state(VpnState::Connecting(Box::new(info))); @@ -720,16 +751,20 @@ impl VpnTask { self.send_state(VpnState::Connected(Box::new(info.with_members(members, failures)))); } - fn publish_connected(&self, attempt: u64, info: ConnectInfo, session_info: SessionInfo) { + fn publish_connected(&mut self, attempt: u64, info: ConnectInfo, session_info: SessionInfo) { let connected = VpnState::Connected(Box::new(ConnectedInfo::new(info, Some(session_info)))); - let admissions = self + let mut admissions = self .lifecycle .admissions .lock() .expect("VPN lifecycle admissions mutex poisoned"); - if admissions.current.as_ref().is_some_and(|admission| { + if let Some(admission) = admissions.current.as_mut().filter(|admission| { admission.attempt == attempt && admission.phase == AdmissionPhase::Active && !admission.stop_requested }) { + admission.restart = None; + if let Some(active) = self.active.as_mut().filter(|active| active.attempt == attempt) { + active.tunnel_established = true; + } self.send_state(connected); } } @@ -777,19 +812,25 @@ impl VpnTask { admission.completion.completed.store(true, Ordering::Release); admission.completion.notify.notify_waiters(); } - } else if let Some(reason) = active.failure { - self.send_state(VpnState::Failed(reason)); - self.lifecycle.clear_attempt(attempt); } else { - self.finish_attempt(attempt); + let unexpectedly_ended = active + .session_id + .filter(|_| active.tunnel_established && !active.cancellation.is_cancelled()); + let state = if let Some(owner) = unexpectedly_ended { + VpnState::UnexpectedDisconnect { + attempt, + owner, + reason: active.failure, + } + } else if let Some(reason) = active.failure { + VpnState::Failed(reason) + } else { + VpnState::Disconnected + }; + self.lifecycle.clear_attempt(attempt, Some(state)); } } - fn finish_attempt(&self, attempt: u64) { - self.send_state(VpnState::Disconnected); - self.lifecycle.clear_attempt(attempt); - } - fn send_state(&self, state: VpnState) { let _ = self.vpn_state_tx.send(state); } @@ -1067,6 +1108,7 @@ mod tests { task: tokio::spawn(async {}), failure: None, reconnect_required: false, + tunnel_established: false, }); task.send_state(VpnState::Connecting(Box::new(info))); let mut member = gpapi::session::GatewaySessionSummary { @@ -1087,6 +1129,126 @@ mod tests { task.end_attempt(0).await; } + #[tokio::test] + async fn unexpected_disconnect_requires_an_established_tunnel() { + for established in [false, true] { + let (state, observed) = watch::channel(VpnState::Disconnected); + let (mut task, lifecycle) = VpnTask::new(state, false, registry()); + let owner = Uuid::new_v4(); + let info = ConnectInfo::new( + "portal.example.com".into(), + gpapi::gateway::Gateway::new("vpn".into(), "vpn.example.com".into()), + vec![], + ); + let reservation = lifecycle.reserve_connect(None).unwrap(); + let cancellation = reservation.cancellation(); + assert_eq!( + reservation.commit( + PreparedConnection::lifecycle_fixture(test_connect_request(info.clone())), + None, + None, + Some(owner), + ), + ServiceResult::Accepted + ); + let _ = task.events.try_recv().unwrap(); + assert!(lifecycle.activate_attempt(0)); + task.active = Some(ActiveAttempt { + attempt: 0, + session_id: Some(owner), + info: info.clone(), + allow_extend_session: false, + cancellation, + task: tokio::spawn(async {}), + failure: None, + reconnect_required: false, + tunnel_established: false, + }); + if established { + task.establish_attempt(0, VpnSessionInfo::default()); + assert!(matches!(*observed.borrow(), VpnState::Connected(_))); + } + task.send_state(VpnState::Connecting(Box::new(info))); + task.end_attempt(0).await; + if established { + assert!(matches!( + *observed.borrow(), + VpnState::UnexpectedDisconnect { attempt: 0, owner: actual, .. } if actual == owner + )); + } else { + assert!(matches!(*observed.borrow(), VpnState::Disconnected)); + } + } + } + + #[test] + fn abandoning_reconnect_cannot_end_an_admitted_replacement() { + let (state, mut observed) = watch::channel(VpnState::Disconnected); + let (_task, lifecycle) = VpnTask::new(state, false, registry()); + let owner = Uuid::new_v4(); + let restart = (7, owner); + lifecycle.admissions.lock().unwrap().restart = Some(restart); + + lifecycle.abandon_reconnect(7, Uuid::new_v4()); + assert!(!observed.has_changed().unwrap()); + let replacement = lifecycle.reserve_connect(Some(restart)).unwrap(); + lifecycle.abandon_reconnect(7, owner); + assert!(!observed.has_changed().unwrap()); + + drop(replacement); + assert!(matches!( + *observed.borrow_and_update(), + VpnState::UnexpectedDisconnect { attempt: 7, owner: actual, .. } if actual == owner + )); + lifecycle.abandon_reconnect(7, owner); + assert!(!observed.has_changed().unwrap()); + } + + #[test] + fn abandoning_an_unclaimed_reconnect_reports_loss_and_rejects_late_admission() { + let (state, observed) = watch::channel(VpnState::Disconnected); + let (_task, lifecycle) = VpnTask::new(state, false, registry()); + let owner = Uuid::new_v4(); + lifecycle.admissions.lock().unwrap().restart = Some((7, owner)); + + lifecycle.abandon_reconnect(7, owner); + assert!(matches!( + *observed.borrow(), + VpnState::UnexpectedDisconnect { attempt: 7, owner: actual, .. } if actual == owner + )); + assert!(lifecycle.reserve_connect(Some((7, owner))).is_err()); + } + + #[test] + fn established_replacement_settles_the_original_reconnect() { + let (state, observed) = watch::channel(VpnState::Disconnected); + let (mut task, lifecycle) = VpnTask::new(state, false, registry()); + let owner = Uuid::new_v4(); + let info = ConnectInfo::new( + "portal.example.com".into(), + gpapi::gateway::Gateway::new("vpn".into(), "vpn.example.com".into()), + vec![], + ); + lifecycle.admissions.lock().unwrap().restart = Some((7, owner)); + let replacement = lifecycle.reserve_connect(Some((7, owner))).unwrap(); + assert_eq!( + replacement.commit( + PreparedConnection::lifecycle_fixture(test_connect_request(info.clone())), + None, + None, + Some(owner), + ), + ServiceResult::Accepted + ); + assert!(lifecycle.activate_attempt(0)); + task.publish_connected(0, info, SessionInfo::default()); + lifecycle.abandon_reconnect(7, owner); + assert!(matches!(*observed.borrow(), VpnState::Connected(_))); + + lifecycle.clear_attempt(0, Some(VpnState::Disconnected)); + assert!(matches!(*observed.borrow(), VpnState::Disconnected)); + } + #[tokio::test] async fn disconnect_completion_waits_for_the_owned_attempt_task() { let (state, state_rx) = watch::channel(VpnState::Disconnected); @@ -1122,6 +1284,7 @@ mod tests { task: worker, failure: None, reconnect_required: false, + tunnel_established: true, }); assert_eq!(lifecycle.request_disconnect(), ServiceResult::Accepted); let stop = task.events.recv().await.unwrap(); @@ -1169,6 +1332,7 @@ mod tests { task: tokio::spawn(async {}), failure: None, reconnect_required: false, + tunnel_established: false, }); task.send_state(VpnState::Connecting(Box::new( task.active.as_ref().unwrap().info.clone(), @@ -1220,7 +1384,7 @@ mod tests { fn late_established_event_is_ignored_after_disconnect_is_accepted() { let (vpn_state_tx, vpn_state_rx) = watch::channel(VpnState::Disconnected); let state_rx = vpn_state_rx.clone(); - let (task, lifecycle) = VpnTask::new(vpn_state_tx, false, registry()); + let (mut task, lifecycle) = VpnTask::new(vpn_state_tx, false, registry()); let info = ConnectInfo::new( "portal.example.com".to_string(), gpapi::gateway::Gateway::new("vpn".to_string(), "vpn.example.com".to_string()), @@ -1242,7 +1406,7 @@ mod tests { #[tokio::test] async fn disconnect_waiter_completes_for_its_attempt_before_a_later_connect() { let (vpn_state_tx, _vpn_state_rx) = watch::channel(VpnState::Disconnected); - let (task, lifecycle) = VpnTask::new(vpn_state_tx, false, registry()); + let (_task, lifecycle) = VpnTask::new(vpn_state_tx, false, registry()); let request = || { test_connect_request(ConnectInfo::new( "portal.example.com".to_string(), @@ -1261,7 +1425,7 @@ mod tests { tokio::task::yield_now().await; } - task.finish_attempt(0); + lifecycle.clear_attempt(0, Some(VpnState::Disconnected)); assert!(matches!( lifecycle.submit_test_connection(request(), None, None, None), ServiceResult::Accepted diff --git a/apps/gpservice/src/ws_server.rs b/apps/gpservice/src/ws_server.rs index 713da08..911583a 100644 --- a/apps/gpservice/src/ws_server.rs +++ b/apps/gpservice/src/ws_server.rs @@ -733,7 +733,7 @@ mod tests { async fn watch_vpn_state(mut vpn_state_rx: watch::Receiver, ctx: Arc) { while vpn_state_rx.changed().await.is_ok() { - let vpn_state = vpn_state_rx.borrow().clone(); + let vpn_state = vpn_state_rx.borrow_and_update().clone(); ctx.send_event(WsEvent::VpnState(vpn_state)).await; } } diff --git a/changelog.md b/changelog.md index 84ed312..87a3d6f 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,16 @@ # Changelog +## 3.7.1 + +### Added + +- Show a desktop notification on Windows, Linux, FreeBSD, and OpenBSD when the VPN disconnects unexpectedly and automatic reconnect fails. + +### Fixed + +- Make the Native Shell Close button visible in light mode and give it a consistent appearance across Linux themes. +- Allow turning off Compatibility Graphics in the Tauri interface. + ## 3.7.0 - Linux now opens Native Shell by default on supported systems, including Alpine. Upgrades keep your saved interface choice. diff --git a/crates/gpapi/src/service/request.rs b/crates/gpapi/src/service/request.rs index 236632b..2e91df9 100644 --- a/crates/gpapi/src/service/request.rs +++ b/crates/gpapi/src/service/request.rs @@ -427,6 +427,7 @@ pub enum WsRequest { SetWindowsPatchInterest { enabled: bool }, RefreshWindowsPatches { after: Option }, Connect(Box), + AbandonReconnect { attempt: u64 }, Disconnect(DisconnectRequest), StopNonTunnelAttachment { connection_id: uuid::Uuid }, StoreEditedHipReportChunk(StoreEditedHipReportChunkRequest), diff --git a/crates/gpapi/src/service/vpn_state.rs b/crates/gpapi/src/service/vpn_state.rs index c7d989b..1bb0f9c 100644 --- a/crates/gpapi/src/service/vpn_state.rs +++ b/crates/gpapi/src/service/vpn_state.rs @@ -116,6 +116,11 @@ impl ConnectInfo { pub enum VpnState { ReconnectRequired(Box), Disconnected, + UnexpectedDisconnect { + attempt: u64, + owner: uuid::Uuid, + reason: Option, + }, Failed(String), Connecting(Box), Connected(Box),