Compare commits

..
Author SHA1 Message Date
github-actions[bot] bc0ac5a576 test: prepare snapshot flake for release/next 2026-11-20 18:27:33 +00:00
Kevin Yue cd0c5d805b Provide the D-Bus typelib to the NixOS accessibility test
Atspi depends on DBus-1.0, which GObject Introspection installs outside the GLib and Atspi output paths.
2026-11-21 01:43:27 +08:00
Kevin Yue 0787a5a463 Include PyGObject in the NixOS desktop test environment
The test successfully opened Settings through GTK but pyatspi could not import gi. Include the Python binding and GLib typelibs, check imports before launch, and bound the accessibility wait.
2026-11-21 01:06:51 +08:00
Kevin Yue 5d4149dff0 Open Native Shell Settings through its GTK action in NixOS tests
The offline interface test timed out before exercising the switch because its synthetic X11 shortcut did not open Settings. Activate the registered Settings action in the desktop session and keep the UI checks for the switch and relaunch.
2026-11-21 00:13:08 +08:00
Kevin Yue 731fcd0a42 Remove redundant Native Shell launcher test
The Linux upgrade test exercises the real launcher with an outdated Native Shell and a compatible Tauri binary. Keep that coverage and remove the unit fixture that rewrites its executable between version probes.
2026-11-20 22:30:08 +08:00
Kevin Yue a926226546 Align webview authentication features across client builds 2026-11-20 22:15:34 +08:00
Kevin Yue d81b1dc3ec Prefer Native Shell on supported Linux installations 2026-11-20 22:00:51 +08:00
5 changed files with 169 additions and 151 deletions

No files matched your search

Generated
+13 -13
View File
@@ -292,7 +292,7 @@ checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0"
[[package]]
name = "auth"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"block2",
@@ -554,7 +554,7 @@ dependencies = [
[[package]]
name = "browser-launcher"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"log",
@@ -919,7 +919,7 @@ dependencies = [
[[package]]
name = "common"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"tempfile",
]
@@ -2133,7 +2133,7 @@ dependencies = [
[[package]]
name = "gp-xml"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"url",
"xmltree",
@@ -2141,7 +2141,7 @@ dependencies = [
[[package]]
name = "gpapi"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"base64 0.23.1",
@@ -2205,7 +2205,7 @@ dependencies = [
[[package]]
name = "gpauth"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"auth",
@@ -2223,7 +2223,7 @@ dependencies = [
[[package]]
name = "gpclient"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"clap",
@@ -2254,7 +2254,7 @@ dependencies = [
[[package]]
name = "gpgui-helper"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"clap",
@@ -2275,7 +2275,7 @@ dependencies = [
[[package]]
name = "gphip"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"askama",
@@ -2294,7 +2294,7 @@ dependencies = [
[[package]]
name = "gpservice"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"anyhow",
"axum",
@@ -2332,7 +2332,7 @@ dependencies = [
[[package]]
name = "gptunnel"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"gpapi",
"log",
@@ -2344,7 +2344,7 @@ dependencies = [
[[package]]
name = "gpvpnc"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"base64 0.23.1",
"ipnet",
@@ -3860,7 +3860,7 @@ dependencies = [
[[package]]
name = "openconnect"
version = "3.7.0"
version = "3.6.0"
dependencies = [
"autotools",
"cc",
+1 -1
View File
@@ -11,7 +11,7 @@ members = [
[workspace.package]
rust-version = "1.91"
version = "3.7.0"
version = "3.6.0"
authors = ["Kevin Yue <[email protected]>"]
homepage = "https://github.com/yuezk/GlobalProtect-openconnect"
edition = "2024"
+146 -125
View File
@@ -1,8 +1,8 @@
# GlobalProtect-openconnect
**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`.
A GlobalProtect VPN client built on OpenConnect. GP Connect runs on Windows, macOS, Linux, FreeBSD, and OpenBSD.
[Features](#features) · [Installation](#installation) · [Usage](#usage) · [Troubleshooting](#troubleshooting) · [Building from source](#building-from-source)
> **Disclaimer**: GP Connect is an independent third-party client for GlobalProtect VPN networks. It is not affiliated with or endorsed by Palo Alto Networks, Inc.
<p align="center">
<picture>
@@ -12,71 +12,111 @@
</picture>
</p>
GP Connect is an independent project. It is not affiliated with or endorsed by Palo Alto Networks, Inc.
> **Inspired by** [gp-saml-gui](https://github.com/dlenski/gp-saml-gui)
## Table of Contents
- [Features](#features)
- [Usage](#usage)
- [Command-Line Interface](#command-line-interface)
- [Graphical User Interface](#graphical-user-interface)
- [Installation](#installation)
- [Windows](#windows)
- [macOS](#macos)
- [Debian / Ubuntu](#debian--ubuntu)
- [Arch Linux / Manjaro](#arch-linux--manjaro)
- [Fedora / RHEL](#fedora--rhel)
- [openSUSE](#opensuse)
- [Alpine Linux](#alpine-linux)
- [FreeBSD](#freebsd)
- [OpenBSD](#openbsd)
- [Gentoo](#gentoo)
- [NixOS](#nixos)
- [Docker](#docker)
- [Other Distributions](#other-distributions)
- [Building from Source](#building-from-source)
- [Troubleshooting](#troubleshooting)
- [NetworkManager Integration](#networkmanager-integration)
- [Licensing](#licensing)
## Features
- Browser-based SSO and MFA, including security keys supported by the identity provider. Client certificates are also supported.
- System VPN tunnel or local SOCKS5 and HTTP proxies for individual applications.
- Multiple saved portals and direct gateway connections.
- Built-in host information profile (HIP) reporting and support for custom HIP scripts.
- System tray controls and automatic connection on launch.
- Native Shell, a lightweight desktop interface for supported Linux systems.
- **Multi-Platform** – Windows (x64 and ARM64), macOS (Apple silicon), Linux, FreeBSD, and OpenBSD
- **Dual Interfaces** – Desktop GUI (**GP Connect**) and terminal CLI (`gpclient`, on macOS, Linux, and BSD)
- **Native Shell on Linux** – Ultra-low-memory native desktop GUI alongside the webview interface
- **Flexible Routing** – Full System VPN tunnel or local SOCKS5 proxy mode
- **Modern Authentication** – SAML / SSO, MFA, FIDO2 (YubiKey), client certificates, and external browser login
- **Automated HIP Reports** – Built-in HIP report generation or custom scripts
- **Multi-Portal & Direct Gateway** – Manage multiple saved portals or connect directly to a gateway
- **Desktop Integration** – Theme-aware system tray icon, auto-connect on launch, and reconnect on wake
## Usage
### Command-Line Interface
On macOS, Linux, and BSD, the open-source `gpclient` CLI handles authentication, connection lifecycle, and HIP generation:
```bash
# Connect to a portal server
sudo gpclient connect <portal>
# Connect using browser authentication (SSO / SAML)
sudo gpclient connect <portal> --browser
# Connect directly to a gateway server
sudo gpclient connect <gateway> --as-gateway
# Connect with automatic HIP report generation
sudo gpclient connect <portal> --hip
# Headless / remote server authentication (prints auth URL to open in any browser)
sudo gpclient connect <portal> --browser manual
# Disconnect
sudo gpclient disconnect
```
Run `gpclient --help` or `gpclient <command> --help` to view all available commands and options.
### Graphical User Interface
- **Windows**: Open **GP Connect** from the Start menu.
- **macOS**: Open **GP Connect** from Applications.
- **Linux / BSD**: Launch GP Connect from your application menu or run:
```bash
gpclient launch-gui
```
> [!TIP]
> On Linux, GP Connect uses Native Shell when your system supports it. Your saved interface choice takes priority. Switch while disconnected in **Settings → General → Interface**.
>
> If the window stays blank, fully quit GP Connect and run `gpclient launch-gui --interface tauri`. To select Native Shell, use `--interface nsh`. The choice is saved when the interface starts.
## Installation
| Platform | Installation instructions |
| --- | --- |
| Windows and macOS | [Windows](#windows) · [macOS](#macos) |
| Linux | [Alpine](#alpine-linux) · [Arch / Manjaro](#arch-linux--manjaro) · [Debian / Ubuntu](#debian--ubuntu) · [Fedora / RHEL](#fedora--rhel) · [Gentoo](#gentoo) · [NixOS](#nixos) · [openSUSE](#opensuse) · [Other distributions](#other-distributions) |
| BSD | [FreeBSD](#freebsd) · [OpenBSD](#openbsd) |
| Container | [Docker](#docker) |
### Windows
Download the Windows installer for [x64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/GPConnect_3.7.0_windows-x64-setup.exe) or [ARM64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/GPConnect_3.7.0_windows-arm64-setup.exe). Run it and approve the administrator prompt.
1. Download the **x64** or **ARM64** installer for your PC from [GitHub Releases](https://github.com/yuezk/GlobalProtect-openconnect/releases/latest).
2. Run the installer and approve the administrator prompt.
3. Open **GP Connect** from the Start menu.
### macOS
Requires Apple silicon and macOS 13+.
Requires Apple silicon and macOS 13+. Includes both GP Connect and the `gpclient` CLI.
#### Homebrew
#### Option 1: Homebrew (Recommended)
```bash
brew install --cask yuezk/gp-connect/gp-connect
```
#### DMG installer
#### Option 2: DMG Installer
Open the [Apple silicon DMG](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/GPConnect_3.7.0_arm64.dmg) and drag GP Connect into Applications.
### Alpine Linux
Download the APK for [x86_64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect-3.7.0-r1-x86_64.apk) or [ARM64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect-3.7.0-r1-aarch64.apk).
```bash
sudo apk add --allow-untrusted globalprotect-openconnect-*.apk
```
Enable the Alpine `community` repository for WebKitGTK.
### Arch Linux / Manjaro
Install the stable package from the Extra repository.
```bash
sudo pacman -S globalprotect-openconnect
```
For the development version from the main branch, use the AUR package.
```bash
yay -S globalprotect-openconnect-git
```
Download the `.dmg` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page and drag GP Connect into Applications.
### Debian / Ubuntu
#### Ubuntu PPA
#### Option 1: PPA (Recommended)
```bash
sudo add-apt-repository ppa:yuezk/globalprotect-openconnect
@@ -84,14 +124,24 @@ sudo apt-get update
sudo apt-get install globalprotect-openconnect
```
#### Debian or Ubuntu release package
#### Option 2: DEB Package
Download the DEB for [amd64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect_3.7.0-1_amd64.deb) or [arm64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect_3.7.0-1_arm64.deb).
Download the latest `.deb` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash
sudo apt install ./globalprotect-openconnect_*.deb
```
### Arch Linux / Manjaro
```bash
# Official Extra repository
sudo pacman -S globalprotect-openconnect
# AUR (git main)
yay -S globalprotect-openconnect-git
```
### Fedora / RHEL
Enable the COPR repository:
@@ -101,6 +151,36 @@ sudo dnf copr enable yuezk/globalprotect-openconnect
sudo dnf install globalprotect-openconnect
```
### openSUSE
Packages are available on the [openSUSE Build Service](https://build.opensuse.org/package/show/home:yuezk/globalprotect-openconnect). Follow the [OBS instructions](https://software.opensuse.org/download.html?project=home%3Ayuezk&package=globalprotect-openconnect) for your distribution.
### Alpine Linux
Download the latest `.apk` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash
sudo apk add --allow-untrusted globalprotect-openconnect-*.apk
```
*(Requires the `community` repository for WebKitGTK dependencies).*
### FreeBSD
Download the latest FreeBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash
sudo pkg install ./globalprotect-openconnect-*-freebsd-*.pkg
```
### OpenBSD
Download the latest OpenBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash
doas pkg_add -D unsigned ./globalprotect-openconnect-*-openbsd-*.tgz
```
### Gentoo
Add the overlay:
@@ -111,15 +191,13 @@ sudo eselect repository add yuezk git https://github.com/yuezk/gentoo-overlay.gi
sudo emerge --sync yuezk
```
On glibc systems, install the prebuilt package:
Install the prebuilt package (glibc):
```bash
sudo emerge --ask net-vpn/globalprotect-openconnect-bin::yuezk
```
The source package is `net-vpn/globalprotect-openconnect::yuezk`.
If Portage requests keyword or USE flag changes, review and apply them, then rerun the install command.
For a source build, use `net-vpn/globalprotect-openconnect::yuezk`. If Portage requests keyword or USE flag changes, review and apply them, then rerun the install command.
### NixOS
@@ -148,96 +226,38 @@ Apply changes:
sudo nixos-rebuild switch
```
### openSUSE
Packages are available on the [openSUSE Build Service](https://build.opensuse.org/package/show/home:yuezk/globalprotect-openconnect). Follow the [OBS instructions](https://software.opensuse.org/download.html?project=home%3Ayuezk&package=globalprotect-openconnect) for your distribution.
### 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).
```bash
tar -xJf globalprotect-openconnect_*.bin.tar.xz
cd globalprotect-openconnect_3.7.0
sudo make install
```
### FreeBSD
Download the [FreeBSD package for amd64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect-3.7.0-freebsd-amd64.pkg).
```bash
sudo pkg install ./globalprotect-openconnect-*-freebsd-*.pkg
```
### OpenBSD
Download the [OpenBSD package for amd64](https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v3.7.0/globalprotect-openconnect-3.7.0-openbsd-amd64.tgz).
```bash
doas pkg_add -D unsigned ./globalprotect-openconnect-*-openbsd-*.tgz
```
### Docker
Run the CLI in the project’s Alpine container. Replace `vpn.example.com` with your portal address.
Run the CLI client in an official Alpine container:
```bash
docker run --rm -it --cap-add=NET_ADMIN --device=/dev/net/tun \
yuezk/globalprotect-openconnect:latest \
connect vpn.example.com --browser manual
connect <portal> --browser manual
```
On Linux, add `--network host` to apply VPN routes to the host network.
*(Add `--network host` on Linux if VPN routes should apply to the host network).*
## Usage
### Other Distributions
### Desktop
Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
Open **GP Connect**, enter your GlobalProtect portal address, and sign in. On Linux and BSD, you can also launch the app with `gpclient launch-gui`.
### Command line
On Linux, BSD, or macOS with Homebrew, replace `vpn.example.com` with your portal address. Use `doas` instead of `sudo` on OpenBSD.
```sh
sudo gpclient connect vpn.example.com
```bash
tar -xJf globalprotect-openconnect_*.bin.tar.xz
cd globalprotect-openconnect_*
sudo make install
```
| Command | Action |
| --- | --- |
| `sudo gpclient disconnect` | Disconnect |
| `sudo gpclient connect vpn.example.com --browser` | Sign in with a browser |
| `sudo gpclient connect gateway.example.com --as-gateway` | Connect directly to a gateway |
| `sudo gpclient connect vpn.example.com --hip` | Connect with HIP reporting enabled |
See `gpclient connect --help` for all connection options.
### Connecting over SSH
For portals that allow external-browser sign-in, run this command on the remote host:
```sh
sudo gpclient connect vpn.example.com --browser manual
```
Open the printed URL in a browser that can reach the remote host. After signing in, paste the callback URL into the SSH terminal.
## Troubleshooting
- **Blank Linux window.** Quit GP Connect and run `gpclient launch-gui --interface tauri`. To switch back, quit and rerun with `--interface nsh`.
- **Reporting a problem.** Run `gpclient diagnostics` and include the relevant output in your issue. See the [diagnostics guide](docs/diagnostics.md) for details.
## Building from Source
### Prerequisites (Linux)
- [Rust](https://www.rust-lang.org/tools/install) 1.91 or later
- Build tools: `make`, `pkg-config`, `autoconf`, `automake`, `libtool`, `gettext`
- Libraries: `gmp`, `gnutls`, `nettle`, `libxml2`, `zlib`, `lz4`, `p11-kit`, `libsecret`, and `webkit2gtk-4.1` for the embedded sign-in window and download helper. Native Shell also requires GTK 4.14 or later.
- Libraries: `gmp`, `gnutls`, `nettle`, `libxml2`, `zlib`, `lz4`, `p11-kit`, `libsecret`, and `webkit2gtk-4.1` for the embedded sign-in window and download helper. Native Shell also requires GTK 4.14 or later. The generic glibc build requires glibc 2.39 or later
- Polkit (`pkexec`) for privileged tunnel setup
For BSD build requirements, see [Building from Source on FreeBSD and OpenBSD](docs/bsd-source-build.md).
*(For FreeBSD and OpenBSD instructions, see [Building from Source on FreeBSD and OpenBSD](docs/bsd-source-build.md)).*
### Build Steps
@@ -254,6 +274,11 @@ sudo make install
- `BUILD_WEBVIEW_AUTH=0` – Disable embedded browser authentication in both `gpclient` and `gpauth`. External-browser and manual sign-in remain available.
- `BUILD_GUI_HELPER=0` – Skip building the helper UI.
## Troubleshooting
- **Headless / Remote Login**: When running without a desktop display or over SSH, use `--browser manual`. Open the printed URL in any browser and paste the callback URL back into the terminal.
- **Diagnostics**: If you encounter issues, run `gpclient diagnostics` or follow the [diagnostics guide](docs/diagnostics.md) when opening an issue.
## NetworkManager Integration
- [WMP/GlobalProtect-SAML-NetworkManager](https://github.com/WMP/GlobalProtect-SAML-NetworkManager) – NetworkManager VPN plugin with SAML/SSO support for GNOME and KDE Plasma
@@ -278,7 +303,3 @@ sudo make install
| [gpclient](./apps/gpclient) | Application | [GPL-3.0](./apps/gpclient/LICENSE) |
| [gpauth](./apps/gpauth) | Application | [GPL-3.0](./apps/gpauth/LICENSE) |
| [gpgui-helper](./apps/gpgui-helper) | Application | [GPL-3.0](./apps/gpgui-helper/LICENSE) |
## Acknowledgments
Inspired by [gp-saml-gui](https://github.com/dlenski/gp-saml-gui).
+1 -4
View File
@@ -1,12 +1,9 @@
# Changelog
## 3.7.0
## 3.7.0 (unreleased)
- Linux now opens Native Shell by default on supported systems, including Alpine. Upgrades keep your saved interface choice.
- To choose an interface after quitting GP Connect, run `gpclient launch-gui --interface tauri` or `gpclient launch-gui --interface nsh`.
- Linux packages include both Native Shell and Tauri so you can switch interfaces without a separate download.
- The README now documents source and prebuilt installation from the Gentoo overlay.
- Source builds with `BUILD_WEBVIEW_AUTH=0` disable embedded browser sign-in in both `gpclient` and `gpauth`.
## 3.6.0
+8 -8
View File
@@ -29,8 +29,8 @@
cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);
pname = "globalprotect-openconnect";
version = cargoToml.workspace.package.version;
releaseTag = "v3.7.0";
releaseVersion = "3.7.0";
releaseTag = "snapshot";
releaseVersion = "3.6.0";
toolchain = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
@@ -55,8 +55,8 @@
cpu = pkgs.stdenv.hostPlatform.parsed.cpu.name;
gpguiHashes = {
x86_64 = "sha256-eIvocMn4j+CiA1FMuib1/BvMEw4kcO5h4zAhbSHXFf0=";
aarch64 = "sha256-pBH7KccAAnxLcCD5+wJxEAwpdu+QRHHncrytwoBgzh4=";
x86_64 = "sha256-LZJcNoaOILCwdF2sNszY2efN/E2yn1rzcRphrrZGfMQ=";
aarch64 = "sha256-HVzn7lJQfowPzAO5bcryZ+qdYYoP6Z0QCGSsK8McawA=";
};
gpguiArchive = pkgs.fetchurl {
@@ -70,8 +70,8 @@
};
nshHashes = {
x86_64 = "sha256-STlK1Wtx840a0TtIgxXJDINnVmfiedSNVcapGF154dY=";
aarch64 = "sha256-HekBfUrlRavNzA+1g6EvxN4iiGDevEv0stsVEyL6Ejk=";
x86_64 = "sha256-/GyMeGZaUJwsP6A8I83hNcom4zQTOdEGEhP2ETJOp1w=";
aarch64 = "sha256-eTz+X1HBeG1M0Vgf7PI1hTNDlFFoXBZ8Ag3EWMc5PUU=";
};
nshArchive = pkgs.fetchurl {
@@ -94,8 +94,8 @@
'';
binaryHashes = {
x86_64 = "sha256-1YFxjH6+garb/bneZRqVHAOfPQGBEvWaruAk573bZhc=";
aarch64 = "sha256-RnXdAcS2UWKwhWtlGSLs8fM4u2iRLx0w6SR42sOX9yk=";
x86_64 = "sha256-unxCRj+Fn2FxQfdpprAzsFwg8YveDb9iN1bSguQ67o4=";
aarch64 = "sha256-EGnSCLCT02jVOiVYeLR+iaKYc7q0O96cF+8t55HIJ0s=";
};
binaryArchive = pkgs.fetchurl {