Compare commits

..
Author SHA1 Message Date
Kevin Yue a6cf639887 fix(release): select desktop shell for update feed validation 2026-11-05 19:21:35 +08:00
Kevin Yue 197cd5748d fix(packaging): remove retired named tray icons
The desktop shells embed solid light and dark tray artwork. Remove the obsolete SVG payload and its Unix, binary-package, RPM, and asset-validation references, including the retired RPM directory entry.

Validated all 33 remaining RPM manifest entries against a staged install and checked sibling desktop assets.

Refs #690
2026-11-05 17:42:09 +08:00
Kevin Yue 907e161b12 fix(auth): open Okta Verify from embedded login
Forward com-okta-authenticator navigation to the desktop scheme handler on GTK platforms and cancel the WebView navigation. This lets FastPass hidden iframes launch Okta Verify.

Verified the failure and fix using an HTTPS iframe fixture in the Linux VM with a temporary URI handler. Linux gpauth build, 48 auth tests, and macOS auth compile check passed.

Fixes #692
2026-11-05 14:53:50 +08:00
Kevin Yue b26a416f45 feat: support system and explicit themes in GUI download helper 2026-11-05 14:24:02 +08:00
Kevin Yue 0212b7ff91 fix(packaging): declare Hogweed dependency at top level 2026-11-03 10:58:35 +08:00
Kevin Yue 9001b768c1 fix(packaging): record required library ABIs on Arch and OpenBSD 2026-11-03 00:02:24 +08:00
Kevin Yue a02dfd10ab fix: register desktop icons for authentication and downloader windows 2026-11-02 18:43:46 +08:00
Kevin Yue 6ebffad3c8 fix: align NSH build metadata and descriptor registration 2026-11-02 15:33:22 +08:00
Kevin Yue c84bfcc13a build(helper): update frontend dependencies and bundle 2026-11-02 15:00:07 +08:00
Kevin Yue aa92251d47 build: use resolver 3 and update MSRV-compatible dependencies 2026-11-02 14:51:37 +08:00
Kevin Yue b15bc2bfa5 docs: highlight Native Shell for Linux users 2026-11-02 14:51:37 +08:00
Kevin Yue d825e2b9c8 feat(gui): preflight NSH downloads and install Nix runtimes 2026-11-02 11:42:55 +08:00
Kevin Yue dcc74d805b build: remove unused OpenSSL dependencies 2026-11-02 11:42:49 +08:00
Kevin Yue 43eda033e5 refactor: align dependencies and centralize GUI activation 2026-11-01 23:35:59 +08:00
Kevin Yue 54b4d810d9 revert: remove Noto Sans license from Linux NSH artifacts
Reverts 3df556a alongside the desktop font rollback.
2026-11-01 23:35:59 +08:00
Kevin Yue e108ce50dc build: include Noto Sans license in Linux NSH artifacts 2026-11-01 23:35:59 +08:00
Kevin Yue 18ce000640 fix(certificates): report legacy key password length limit 2026-11-01 23:35:58 +08:00
Kevin Yue 14c4e24e0e refactor: replace OpenSSL transports and certificate imports 2026-11-01 23:35:58 +08:00
Kevin Yue 37c88c7adb fix(packaging): remove downloaded NSH binary on uninstall 2026-11-01 23:35:58 +08:00
Kevin Yue f2ec8c7770 feat(gui): require confirmation before interface downloads 2026-11-01 23:35:58 +08:00
Kevin Yue 1698397af3 ci(nsh): remove ICU4C build dependency 2026-11-01 23:35:58 +08:00
Kevin Yue eb8f919121 fix(packaging): map Linux desktop entry to GP Connect app ID 2026-11-01 23:35:58 +08:00
Kevin Yue b4529398b0 fix: align macOS default route detection across network setup 2026-11-01 23:35:57 +08:00
Kevin Yue c53911e7b8 ci(macos): cache validated public native libraries 2026-11-01 23:35:57 +08:00
Kevin Yue 580438e8eb refactor(api): scope GUI preference directories to desktop support 2026-11-01 23:35:57 +08:00
Kevin Yue 92943e0a9d ci: identify overdue Rust tests and last running target by hash 2026-11-01 23:35:57 +08:00
Kevin Yue 6f2f8e1265 ci: report hashed Rust panic locations without private paths 2026-11-01 23:35:57 +08:00
Kevin Yue f643180b59 ci: build the BSD desktop package with safe compiler diagnostics 2026-11-01 23:35:57 +08:00
Kevin Yue 3a643fe6ff ci: identify BSD build phases without exposing private output 2026-11-01 23:35:56 +08:00
Kevin Yue 66b1cf3c47 fix(packaging): require the FreeBSD LZ4 runtime library 2026-11-01 23:35:56 +08:00
Kevin Yue 472806ca73 ci: omit debug and incremental artifacts from private test builds 2026-11-01 23:35:56 +08:00
Kevin Yue d7de2df53b ci: install FreeBSD LZ4 and expose safe native test diagnostics 2026-11-01 23:35:56 +08:00
Kevin Yue 6ef2f0497d ci: report private Rust failure metadata without source output 2026-11-01 23:35:56 +08:00
Kevin Yue 0436a18e42 ci: embed the selected desktop source identity in native builds 2026-11-01 23:35:56 +08:00
Kevin Yue 56489a4e90 ci: install D-Bus development files for Native Shell 2026-11-01 23:35:55 +08:00
Kevin Yue 6316f8d68e chore(linux): identify selected GUI in launch diagnostics 2026-11-01 23:35:55 +08:00
Kevin Yue d9e00bc3c9 ci: retain ICU notices and verify portable NSH linkage 2026-11-01 23:35:55 +08:00
Kevin Yue e284840d89 feat(linux): switch desktop interfaces and preserve selection on upgrade 2026-11-01 23:35:55 +08:00
Kevin Yue 0df25fbd28 ci: publish Linux Native Shell alongside desktop assets 2026-11-01 23:35:55 +08:00
Kevin Yue 8e3bb8ff11 chore(desktop): verify shared tray asset location 2026-11-01 23:35:55 +08:00
Kevin Yue a7c571a2c1 refactor(auth): expose callback validation for desktop core 2026-11-01 23:35:55 +08:00
Kevin Yue 2b38de10f6 feat: select NSH by default for macOS artifacts 2026-11-01 23:35:54 +08:00
Kevin Yue 4aa7b66313 ci: verify and select the NSH macOS shell explicitly 2026-11-01 23:35:54 +08:00
Kevin Yue ce5a19c131 ci(macos): verify selected desktop shell before publication 2026-11-01 23:35:54 +08:00
Kevin Yue e7ddc2ca2a feat(gpapi): expose connection gateway choices 2026-11-01 23:35:54 +08:00
Kevin Yue 4635b1b4b8 feat(gpapi): expose pure prelogin response parsing 2026-11-01 23:35:54 +08:00
Kevin Yue 0cb246b0c5 fix: parse gateway addresses before IPv4 resolution 2026-11-01 23:35:54 +08:00
Kevin Yue fabc7d4461 fix: resolve gateway route using the parsed hostname 2026-11-01 23:35:53 +08:00
Kevin Yue d2fcf66be8 fix: restore globe rim and RGBA icon assets 2026-11-01 23:35:53 +08:00
Kevin Yue ae504dfbbe chore: update shipped app icons to hybrid artwork 2026-11-01 23:35:53 +08:00
Kevin Yue fca3076b64 refactor: remove unused iOS OpenConnect integration
Remove the iOS native-library build adapter and unused packet-endpoint builder and Rust/C FFI path. Keep the desktop build in build.rs with explicit macOS, Linux, FreeBSD and OpenBSD support.

Preserve desktop device and script-tunnel behavior, shared protocol profiles, certificate pin checks and the pinned native conformance reference.
2026-11-01 23:34:19 +08:00
Kevin Yue c29c57639a fix: preserve physical DNS while selecting VPN DNS on macOS 2026-11-01 23:34:19 +08:00
Kevin Yue da90bc80e3 feat: add portable GlobalProtect APIs and iOS tunnel support 2026-11-01 23:34:18 +08:00
7 changed files with 411 additions and 144 deletions

No files matched your search

-3
View File
@@ -16,6 +16,3 @@ gen
# Nix files # Nix files
result result
# Packages & test assets
*.ipa
Generated
+12 -12
View File
@@ -292,7 +292,7 @@ checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0"
[[package]] [[package]]
name = "auth" name = "auth"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"block2", "block2",
@@ -547,7 +547,7 @@ dependencies = [
[[package]] [[package]]
name = "browser-launcher" name = "browser-launcher"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"log", "log",
@@ -911,7 +911,7 @@ dependencies = [
[[package]] [[package]]
name = "common" name = "common"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"tempfile", "tempfile",
] ]
@@ -2115,7 +2115,7 @@ dependencies = [
[[package]] [[package]]
name = "gpapi" name = "gpapi"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"base64 0.23.1", "base64 0.23.1",
@@ -2174,7 +2174,7 @@ dependencies = [
[[package]] [[package]]
name = "gpauth" name = "gpauth"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"auth", "auth",
@@ -2193,7 +2193,7 @@ dependencies = [
[[package]] [[package]]
name = "gpclient" name = "gpclient"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"clap", "clap",
@@ -2224,7 +2224,7 @@ dependencies = [
[[package]] [[package]]
name = "gpgui-helper" name = "gpgui-helper"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"clap", "clap",
@@ -2245,7 +2245,7 @@ dependencies = [
[[package]] [[package]]
name = "gphip" name = "gphip"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"askama", "askama",
@@ -2262,7 +2262,7 @@ dependencies = [
[[package]] [[package]]
name = "gpservice" name = "gpservice"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"axum", "axum",
@@ -2297,7 +2297,7 @@ dependencies = [
[[package]] [[package]]
name = "gptunnel" name = "gptunnel"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"gpapi", "gpapi",
"log", "log",
@@ -2309,7 +2309,7 @@ dependencies = [
[[package]] [[package]]
name = "gpvpnc" name = "gpvpnc"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"log", "log",
] ]
@@ -3823,7 +3823,7 @@ dependencies = [
[[package]] [[package]]
name = "openconnect" name = "openconnect"
version = "3.3.0" version = "3.2.0"
dependencies = [ dependencies = [
"autotools", "autotools",
"cc", "cc",
+1 -1
View File
@@ -11,7 +11,7 @@ members = [
[workspace.package] [workspace.package]
rust-version = "1.91" rust-version = "1.91"
version = "3.3.0" version = "3.2.0"
authors = ["Kevin Yue <[email protected]>"] authors = ["Kevin Yue <[email protected]>"]
homepage = "https://github.com/yuezk/GlobalProtect-openconnect" homepage = "https://github.com/yuezk/GlobalProtect-openconnect"
edition = "2024" edition = "2024"
+397 -97
View File
@@ -1,8 +1,6 @@
# GlobalProtect-openconnect # GlobalProtect-openconnect
A GlobalProtect VPN client built on OpenConnect. It provides command-line tools (`gpclient`) and the GP Connect desktop application for macOS, Linux, FreeBSD, and OpenBSD. A GlobalProtect VPN client built on OpenConnect with support for SSO authentication. It provides command-line tools and the GP Connect desktop application for macOS, Linux, FreeBSD, and OpenBSD.
> **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"> <p align="center">
<picture> <picture>
@@ -24,89 +22,147 @@ A GlobalProtect VPN client built on OpenConnect. It provides command-line tools
- [macOS](#macos) - [macOS](#macos)
- [Debian / Ubuntu](#debian--ubuntu) - [Debian / Ubuntu](#debian--ubuntu)
- [Arch Linux / Manjaro](#arch-linux--manjaro) - [Arch Linux / Manjaro](#arch-linux--manjaro)
- [Fedora / RHEL](#fedora--rhel) - [Fedora 38+ / Rawhide](#fedora-38--rawhide)
- [openSUSE](#opensuse) - [openSUSE Leap 15.6+ / Tumbleweed](#opensuse-leap-156--tumbleweed)
- [Other RPM-based Distributions](#other-rpm-based-distributions)
- [Alpine Linux](#alpine-linux) - [Alpine Linux](#alpine-linux)
- [FreeBSD](#freebsd) - [FreeBSD](#freebsd)
- [OpenBSD](#openbsd) - [OpenBSD](#openbsd)
- [Gentoo](#gentoo) - [Gentoo](#gentoo)
- [NixOS](#nixos) - [NixOS](#nixos)
- [Docker](#docker) - [Official Docker Image](#official-docker-image)
- [Other Distributions](#other-distributions) - [Other Distributions](#other-distributions)
- [Building from Source](#building-from-source) - [Building from Source](#building-from-source)
- [Troubleshooting](#troubleshooting) - [Frequently Asked Questions](#frequently-asked-questions)
- [NetworkManager Integration](#networkmanager-integration) - [NetworkManager Integration](#networkmanager-integration)
- [Licensing](#licensing) - [Licensing](#licensing)
## Features ## Features
- **Multi-Platform** – macOS (Apple silicon), Linux, FreeBSD, and OpenBSD - **Desktop Platform Support** – macOS, Linux, FreeBSD, and OpenBSD
- **Dual Interfaces** – Fast terminal CLI (`gpclient`) and desktop GUI (**GP Connect**) - **Dual Interface** – Available as both CLI and GUI applications
- **Native Shell on Linux** – Ultra-low-memory native desktop GUI alongside the webview interface - **Flexible Authentication** – Supports SSO, non-SSO, FIDO2 (e.g., YubiKey), and client certificate authentication
- **Flexible Routing** – Full System VPN tunnel or local SOCKS5 proxy mode - **Browser Integration** – Authenticate using your default browser or any specified browser
- **Modern Authentication** – SAML / SSO, MFA, FIDO2 (YubiKey), client certificates, and external browser login - **Multi-Portal Support** – Connect to multiple portals and gateways
- **Automated HIP Reports** – Built-in HIP report generation or custom scripts - **Direct Gateway Connection** – Bypass portal selection when needed
- **Multi-Portal & Direct Gateway** – Manage multiple saved portals or connect directly to a gateway - **Auto-Connect** – Automatically connect on system startup
- **Desktop Integration** – Theme-aware system tray icon, auto-connect on launch, and reconnect on wake - **System Tray Integration** – Convenient system tray icon (requires [gnome-shell-extension-appindicator](https://extensions.gnome.org/extension/615/appindicator-support/) on GNOME)
## Usage ## Usage
### Command-Line Interface ### Command-Line Interface
The open-source `gpclient` CLI handles authentication, connection lifecycle, and HIP generation: The CLI is free and open source. Use it to authenticate, connect to portals or gateways, and generate HIP reports from the terminal.
#### Basic Commands
```bash ```bash
# Connect to a portal server Usage: gpclient [OPTIONS] <COMMAND>
sudo gpclient connect <portal>
# Connect using browser authentication (SSO / SAML) Commands:
sudo gpclient connect <portal> --browser connect Connect to a portal server
disconnect Disconnect from the server
launch-gui Launch the GUI
hip Generate HIP report
help Print this message or the help of the given subcommand(s)
# Connect directly to a gateway server Options:
sudo gpclient connect <gateway> --as-gateway --ignore-tls-errors Ignore the TLS errors
--lock-file <LOCK_FILE> Path to the gpclient PID lock file
# Connect with automatic HIP report generation --log-format <LOG_FORMAT> Log output format. JSON is intended for non-interactive consumers; interactive prompts remain text. [default: text] [possible values: text, json]
sudo gpclient connect <portal> --hip -v, --verbose... Enable verbose output, -v for debug, -vv for trace
-q, --quiet... Decrease logging verbosity, -q for warnings, -qq for errors
# Headless / remote server authentication (prints auth URL to open in any browser) -h, --help Print help (see more with '--help')
sudo gpclient connect <portal> --browser manual -V, --version Print version
# Disconnect
sudo gpclient disconnect
``` ```
Run `gpclient --help` or `gpclient <command> --help` to view all available commands and options.
> **Tip:** Use `gpclient help <command>` for detailed information on a specific command.
#### HIP reports
HIP is disabled in the CLI unless enabled explicitly. Use `--hip` to generate reports inside `gpclient`, including later reports requested by the gateway:
```bash
sudo gpclient connect <portal> --hip
```
Use `--hip=/absolute/path/to/script` for a custom executable. It runs as the `gpclient` process user unless `--hip-user` specifies another user. No installed HIP script is discovered automatically. `--hip-user` applies only to custom executables.
`gpclient hip` generates a report on demand for inspection; see `gpclient hip --help` for report inputs. The GUI's HIP tab supports generated reports, edited XML, and HIP Off on all desktop platforms. Linux, FreeBSD, and OpenBSD also support desktop-user scripts and explicitly approved root scripts.
#### External Browser Authentication
Use `gpclient` directly for browser-based authentication. It opens the browser as your normal desktop user while keeping VPN tunnel setup privileged:
```bash
sudo gpclient connect <portal> --browser
```
For standalone CLI installations, use `--browser manual` (`--browser remote` before v3.0.6): open the printed URL and paste the resulting `globalprotectcallback:…` data into the terminal.
To reuse a saved portal cookie for later connections, add `--cookie-cache`:
```bash
sudo gpclient connect <portal> --browser --cookie-cache
```
Add `--gateway <gateway>` to select a particular gateway. Cookie caching is handled by `gpclient`. Its default cache file is `$HOME/.config/gpclient/cookie.json`, which normally belongs to root when running with `sudo`. To choose a predictable location, specify the path explicitly:
```bash
sudo gpclient connect <portal> --browser --cookie-cache=/absolute/path/to/cookie.json
```
**Browser Options:**
- Use `--browser` to automatically select an available browser
- Use `--browser <browser>` to specify a browser (e.g., `firefox`, `chrome`)
- Use `--browser manual` for standalone CLI installations or headless servers
### Graphical User Interface ### Graphical User Interface
- **macOS**: Open **GP Connect** from Applications. GP Connect provides a desktop interface for managing VPN connections. On macOS, open GP Connect from Applications. On Linux, FreeBSD, and OpenBSD, launch it from your application menu or via the terminal:
- **Linux / BSD**: Launch GP Connect from your application menu or run:
```bash ```bash
gpclient launch-gui gpclient launch-gui
``` ```
> [!TIP] > [!TIP]
> **On Linux, try Native Shell for lower memory usage.** Switch between Native Shell and Tauri in **Settings → General → Interface**. > **On Linux, try Native Shell for lower memory usage.** Switch to it in **Settings → General → Interface**.
> [!Note]
>
> The GUI version is partially open source. The background service ([gpservice](./apps/gpservice/)) is open source, while the GUI wrapper is proprietary.
## Installation ## Installation
> [!Note]
>
> For older Linux distributions, use [v2.3.13](https://github.com/yuezk/GlobalProtect-openconnect/releases/tag/v2.3.13) instead of the latest release. It provides release assets for common distro families, including Debian/Ubuntu (`.deb`), Arch Linux / Manjaro (`.pkg.tar.zst`), RPM-based distros such as Fedora / RHEL / Rocky / AlmaLinux / CentOS (`.rpm`), and generic Linux tarballs (`.bin.tar.xz`).
### macOS ### macOS
Requires Apple silicon and macOS 13+. Includes both GP Connect and the `gpclient` CLI. GP Connect requires Apple silicon and macOS 13 or later. The macOS app includes both the desktop application and the free `gpclient` CLI. The CLI does not require a GUI license.
#### Option 1: Homebrew (Recommended) #### Option 1: Install with Homebrew
```bash ```bash
brew install --cask yuezk/gp-connect/gp-connect brew install --cask yuezk/gp-connect/gp-connect
``` ```
#### Option 2: DMG Installer Open GP Connect from Applications, or connect from the terminal:
Download the `.dmg` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page and drag GP Connect into Applications. ```bash
sudo gpclient connect <portal> --browser
```
#### Option 2: Install from DMG
Download the GP Connect `.dmg` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, open it, and drag GP Connect into Applications.
### Debian / Ubuntu ### Debian / Ubuntu
#### Option 1: PPA (Recommended) #### Option 1: Install from PPA (Recommended)
```bash ```bash
sudo add-apt-repository ppa:yuezk/globalprotect-openconnect sudo add-apt-repository ppa:yuezk/globalprotect-openconnect
@@ -114,152 +170,392 @@ sudo apt-get update
sudo apt-get install globalprotect-openconnect sudo apt-get install globalprotect-openconnect
``` ```
#### Option 2: DEB Package > [!Note]
>
> **For Linux Mint users:** If you encounter a GPG key error, import the key manually:
> ```bash
> sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 7937C393082992E5D6E4A60453FC26B43838D761
> ```
Download the latest `.deb` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page: #### Option 2: Install from DEB Package
Download the latest `.deb` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
```bash ```bash
sudo apt install ./globalprotect-openconnect_*.deb sudo apt install --fix-broken ./globalprotect-openconnect_*.deb
``` ```
### Arch Linux / Manjaro ### Arch Linux / Manjaro
```bash #### Option 1: Install from AUR
# Official Extra repository
sudo pacman -S globalprotect-openconnect
# AUR (git main) Package: [globalprotect-openconnect-git](https://aur.archlinux.org/packages/globalprotect-openconnect-git/)
You can install it using an AUR helper like [`yay`](https://github.com/Jguer/yay):
```bash
yay -S globalprotect-openconnect-git yay -S globalprotect-openconnect-git
``` ```
### Fedora / RHEL #### Option 2: Install from the Official Extra Repository
Enable the COPR repository: The package is also available in the official Arch Linux Extra repository.
Package: [globalprotect-openconnect](https://archlinux.org/packages/extra/x86_64/globalprotect-openconnect/)
> [!Note]
>
> Since the official package does not include the system tray support dependency, you need to install `libappindicator` manually:
```bash
sudo pacman -S libappindicator globalprotect-openconnect
```
#### Option 3: Install from Package
Download the latest package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
```bash
sudo pacman -U globalprotect-openconnect-*.pkg.tar.zst
```
### Fedora 38+ / Rawhide
#### Install from COPR
The package is available on [COPR](https://copr.fedorainfracloud.org/coprs/yuezk/globalprotect-openconnect/) for RPM-based distributions:
```bash ```bash
sudo dnf copr enable yuezk/globalprotect-openconnect sudo dnf copr enable yuezk/globalprotect-openconnect
sudo dnf install globalprotect-openconnect sudo dnf install globalprotect-openconnect
``` ```
### openSUSE ### openSUSE Leap 15.6+ / Tumbleweed
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. #### Install from OBS (openSUSE Build Service)
Packages are available on the [openSUSE Build Service](https://build.opensuse.org/package/show/home:yuezk/globalprotect-openconnect). Follow the [installation instructions](https://software.opensuse.org//download.html?project=home%3Ayuezk&package=globalprotect-openconnect) for your distribution.
### Other RPM-based Distributions
#### Install from RPM Package
Download the latest RPM package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash
sudo rpm -i globalprotect-openconnect-*.rpm
```
### Alpine Linux ### Alpine Linux
Download the latest `.apk` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page: Download the latest `.apk` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
```bash ```bash
sudo apk add --allow-untrusted globalprotect-openconnect-*.apk sudo apk add --allow-untrusted globalprotect-openconnect-*.apk
``` ```
*(Requires `community` repository enabled for WebKitGTK and AppIndicator dependencies).* The package uses Alpine's native musl build. Make sure the `community` repository is enabled so GUI dependencies such as `webkit2gtk-4.1`, `libsecret`, and `libayatana-appindicator` can be resolved. GUI-launched connections use polkit, and VPN tunnel creation requires `/dev/net/tun`.
### FreeBSD ### FreeBSD
Download the latest FreeBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page: Download the latest FreeBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
```bash ```bash
sudo pkg install ./globalprotect-openconnect-*-freebsd-*.pkg sudo pkg install ./globalprotect-openconnect-*-freebsd-*.pkg
``` ```
To build from source, see [Building from Source on FreeBSD and OpenBSD](./docs/bsd-source-build.md).
### OpenBSD ### OpenBSD
Download the latest OpenBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page: Download the latest OpenBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
```bash ```bash
doas pkg_add -D unsigned ./globalprotect-openconnect-*-openbsd-*.tgz doas pkg_add -D unsigned ./globalprotect-openconnect-*-openbsd-*.tgz
``` ```
To build from source, see [Building from Source on FreeBSD and OpenBSD](./docs/bsd-source-build.md).
### Gentoo ### Gentoo
Available via the `guru` repository: Available via the `guru` and `lamdness` overlays:
```bash ```bash
sudo eselect repository enable guru sudo eselect repository enable guru
sudo emerge --sync guru sudo emerge --sync guru
sudo emerge --ask net-vpn/GlobalProtect-openconnect sudo emerge --ask --verbose net-vpn/GlobalProtect-openconnect
``` ```
### NixOS ### NixOS
Add the flake to your `flake.nix`: This repository includes a flake for NixOS integration.
#### Installation Steps
Add the flake input and NixOS module to your `flake.nix`:
The module builds the package with your NixOS configuration's `pkgs`, so the
GlobalProtect GUI and the system use the same Nixpkgs dependency versions.
It also enables Polkit and its setuid `pkexec` wrapper for privileged operations.
```nix ```nix
{ {
inputs.globalprotect-openconnect.url = "github:yuezk/GlobalProtect-openconnect"; inputs = {
# ... other inputs
globalprotect-openconnect.url = "github:yuezk/GlobalProtect-openconnect";
};
outputs = { self, nixpkgs, globalprotect-openconnect, ... }:
let
system = "x86_64-linux"; # or "aarch64-linux" for ARM64
hostname = "<your-host>";
in {
nixosConfigurations.${hostname} = nixpkgs.lib.nixosSystem {
inherit system;
outputs = { self, nixpkgs, globalprotect-openconnect, ... }: {
nixosConfigurations.<hostname> = nixpkgs.lib.nixosSystem {
modules = [ modules = [
./configuration.nix
globalprotect-openconnect.nixosModules.default globalprotect-openconnect.nixosModules.default
{ {
programs.globalprotect-openconnect.enable = true; programs.globalprotect-openconnect.enable = true;
environment.systemPackages = [
nixpkgs.legacyPackages.${system}.gnomeExtensions.appindicator
];
} }
]; ];
}; };
} };
} }
``` ```
Apply changes: Apply:
```bash ```bash
sudo nixos-rebuild switch sudo nixos-rebuild switch
loginctl terminate-user "$USER"
``` ```
### Docker After logging back in to GNOME, enable AppIndicator support if needed:
Run the CLI client in an official Alpine container: ```bash
gnome-extensions enable [email protected]
```
NixOS does not run an imperative package-uninstall hook when a package is
removed from the system configuration. Remove an installed replacement VPN
script from the app settings before removing the package.
The `prebuilt` package and NixOS module use the published release pinned in `flake.nix`. Both `prebuilt` and `fromSource` run natively on the host with packaged dependencies and installer paths. The `fromSource` package builds the current flake checkout, including its Git submodules:
```bash
git submodule update --init --recursive
nix build "git+file://$PWD?submodules=1#fromSource"
```
Local source builds require initialized Git submodules and a flake URL with `submodules=1`, as shown above. For a remote source flake, use a Git URL with submodules enabled, such as `git+https://github.com/yuezk/GlobalProtect-openconnect?submodules=1#fromSource`. The `prebuilt` package and NixOS module do not require Git submodules. Build output (`target`, `.build`, and `node_modules`) is excluded from the source input. Updating release asset hashes changes the prebuilt package, independently of source builds.
Source builds also support downloading either desktop interface on NixOS. The
downloader packages the verified Tauri or Native Shell archive with Nix, including
its runtime libraries. Each installed interface has a garbage-collection root
under `/var/lib/gpclient/nix-gui`, so its dependencies remain available after
system upgrades. No Rust compilation or NixOS rebuild is needed for GUI downloads.
Prebuilt packages gain this support when their release includes the updated
service; adding the flake installer alone does not change older service binaries.
### Official Docker Image
The [official Docker image](https://hub.docker.com/r/yuezk/globalprotect-openconnect) provides the CLI tools on Alpine Linux:
```bash
docker pull yuezk/globalprotect-openconnect:<version>
```
Release images are tagged as `vX.Y.Z`, `X.Y.Z`, and `latest`.
Run it with access to the TUN device:
```bash ```bash
docker run --rm -it --cap-add=NET_ADMIN --device=/dev/net/tun \ docker run --rm -it --cap-add=NET_ADMIN --device=/dev/net/tun \
yuezk/globalprotect-openconnect:latest \ yuezk/globalprotect-openconnect:<version> \
connect <portal>
```
For browser authentication in a headless environment, use manual browser authentication:
```bash
docker run --rm -it --cap-add=NET_ADMIN --device=/dev/net/tun \
yuezk/globalprotect-openconnect:<version> \
connect <portal> --browser manual connect <portal> --browser manual
``` ```
*(Add `--network host` on Linux if VPN routes should apply to the host network).* On a host with multiple network interfaces, use `--browser-listen` to select the IP address reachable from the browser machine:
```bash
gpclient connect <portal> --browser manual --browser-listen 192.168.107.15
```
On a Linux host, add host networking if the VPN routes should affect the host network namespace:
```bash
docker run --rm -it --network host --cap-add=NET_ADMIN --device=/dev/net/tun \
yuezk/globalprotect-openconnect:<version> \
connect <portal> --browser manual
```
Without `--network host`, the VPN connection stays inside the container's network namespace. Docker Desktop on macOS and Windows does not make the host use the VPN through `--network host`; run `gpclient` on the host or use a container gateway setup for host traffic.
The image includes `gpclient` and `gpauth` only. It does not include embedded webview authentication, `gpgui-helper`, or `gpgui`.
### Other Distributions ### Other Distributions
Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page: #### Manual Installation
```bash 1. **Install dependencies:**
tar -xJf globalprotect-openconnect_*.bin.tar.xz - WebKitGTK 4.1 (for example, `libwebkit2gtk-4.1-0` on Debian/Ubuntu)
cd globalprotect-openconnect_* - `libsecret`
sudo make install - `libayatana-appindicator` or `libappindicator-gtk3`
``` - polkit (`pkexec`) for GUI-launched VPN connections
2. **Download and extract:**
Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash
tar -xJf globalprotect-openconnect_${version}_${arch}.bin.tar.xz
cd globalprotect-openconnect_${version}
```
3. **Install:**
```bash
sudo make install
```
## Building from Source ## Building from Source
### Prerequisites (Linux) The instructions below build the open-source components on Linux. For FreeBSD and OpenBSD, see [Building from Source on FreeBSD and OpenBSD](./docs/bsd-source-build.md).
- [Rust](https://www.rust-lang.org/tools/install) 1.91 or later ### Method 1: Using DevContainer
- Build tools: `make`, `pkg-config`, `autoconf`, `automake`, `libtool`, `gettext`
- Libraries: `gmp`, `gnutls`, `nettle`, `libxml2`, `zlib`, `lz4`, `p11-kit`, `libsecret`, and `webkit2gtk-4.1` (or GTK 4 for Native Shell)
- Polkit (`pkexec`) for privileged tunnel setup
*(For FreeBSD and OpenBSD instructions, see [Building from Source on FreeBSD and OpenBSD](docs/bsd-source-build.md)).* This project includes a DevContainer configuration for Linux development. The repository's `rust-toolchain.toml` selects the Rust toolchain; rustup may need to download it on the first build.
### Build Steps #### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Visual Studio Code](https://code.visualstudio.com/) (optional, for IDE support)
- [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (if using VS Code)
#### Build Steps
1. **Clone the repository:**
```bash
git clone https://github.com/yuezk/GlobalProtect-openconnect.git
cd GlobalProtect-openconnect
git submodule update --init --recursive
```
2. **Build the DevContainer image:**
```bash
docker build -t gpoc-devcontainer .devcontainer/
```
3. **Build the project:**
To build the open-source components, including the GUI helper, run:
```bash
docker run --privileged --cap-add=NET_ADMIN --device=/dev/net/tun \
--tty -v "$(pwd)":/workspace -w /workspace gpoc-devcontainer \
bash -c "export PATH=/usr/local/cargo/bin:\$PATH && make build"
```
To build without the GUI helper run the same command as above, but with `BUILD_GUI_HELPER=0` passed as an argument to `make`.
4. **Locate build artifacts:**
The compiled binaries will be available in `target/release/`:
- `gpclient` – CLI client
- `gpservice` – Background service
- `gpauth` – Authentication helper
- `gpgui-helper` – GUI helper
- `gp-hip-script-installer` – Privileged HIP script installer
- `gp-vpnc-script-installer` – Privileged VPN script installer
The proprietary GP Connect desktop application is distributed separately. Use `INCLUDE_GUI=1` with `make build` to download its matching published Linux build for installation.
#### Alternative: Using VS Code
1. Open the project in VS Code
2. When prompted, click "Reopen in Container" (or run **Dev Containers: Reopen in Container**)
3. Once the container is ready, open a terminal and run:
```bash
make build
```
### Method 2: Local Development Build
#### Prerequisites
- [Rust 1.91 or later](https://www.rust-lang.org/tools/install)
- [Tauri dependencies](https://tauri.app/start/prerequisites/)
- OpenConnect source-build dependencies: `autoconf`, `automake`, `autopoint`/`gettext`, `libtool`, `patch`, `pkg-config`, `libxml2`, `zlib`, `lz4`, `gnutls`, `p11-kit`, `nettle`, and `gmp` development packages
- `pkexec` and `gnome-keyring` (or `pam_kwallet` on KDE)
- Node.js and pnpm if rebuilding the GUI helper frontend
#### Build Steps
1. **Download source code:**
Download `globalprotect-openconnect-${version}.tar.gz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page.
2. **Extract and build:**
```bash
tar -xzf globalprotect-openconnect-${version}.tar.gz
cd globalprotect-openconnect-${version}
make build
```
3. **Install:**
```bash
sudo make install
```
To stage the files for packaging instead of installing them into the system, use `make install DESTDIR=/absolute/path/to/staging`.
### Testing Your Build
Verify the CLI client is working correctly:
```bash ```bash
git clone --recursive https://github.com/yuezk/GlobalProtect-openconnect.git ./target/release/gpclient --help
cd GlobalProtect-openconnect
make build
sudo make install
``` ```
**Build Options:** ### Build Options
- `INCLUDE_GUI=1` – Download and install the matching desktop application bundle. - `BUILD_GUI_HELPER=0` – Skip building and installing the GUI helper
- `BUILD_WEBVIEW_AUTH=0` – Build `gpauth` without embedded browser authentication (uses external browser or manual mode). - `BUILD_WEBVIEW_AUTH=0` – Build `gpauth` without embedded browser authentication; use an external browser or manual authentication
- `BUILD_GUI_HELPER=0` – Skip building the helper UI. - `INCLUDE_GUI=1` – Download the matching published Linux desktop application for installation
- `OFFLINE=1` – Build in offline mode using vendored dependencies
## Troubleshooting ## Frequently Asked Questions
- **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. When reporting a problem, follow the [diagnostics collection instructions](docs/diagnostics.md). A standalone script is available for versions without the diagnostics command; you do not need to upgrade first.
- **Diagnostics**: If you encounter issues, run `gpclient diagnostics` or follow the [diagnostics guide](docs/diagnostics.md) when opening an issue.
### Q: How do I resolve the "Secure Storage not ready" error?
Unlock your desktop keyring and ensure the application can access it. On Linux and BSD, check that a keyring service such as GNOME Keyring is installed and running in your desktop session. On macOS, check Keychain access.
Linux and BSD can use file storage when secure storage is unavailable during initial setup. An existing configuration that uses the keyring still needs access to that keyring.
See related issues: [#321](https://github.com/yuezk/GlobalProtect-openconnect/issues/321), [#316](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)
### Q: How do I fix the "cannot open display" error when using CLI?
Run the client from a terminal in your normal desktop session and use an external browser:
```bash
sudo gpclient connect <portal> --browser
```
See related issue: [#316](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)
On a headless server, use `--browser manual` and complete authentication from another machine.
## NetworkManager Integration ## NetworkManager Integration
@@ -268,10 +564,14 @@ sudo make install
## Licensing ## Licensing
- **CLI (`gpclient`)**: Free and open source (GPL-3.0). ### Trial and Pricing
- **GUI (GP Connect)**: Commercial desktop application with a free trial.
### Open Source Components The **CLI version** is completely free and open source.
The **GUI version** is a paid application with a **7-day trial**. Start the trial in the app by verifying your email address with a one-time code. Installing the app alone does not start the trial.
### Open Source Licenses
This project consists of multiple components, each with its own license:
| Component | Type | License | | Component | Type | License |
|-----------|------|---------| |-----------|------|---------|
-29
View File
@@ -1,34 +1,5 @@
# Changelog # Changelog
## 3.3.0
### Added
- Added Native Shell, a new desktop interface for macOS and Linux. macOS builds now use it by default.
- Added an Interface setting on Linux to switch between Tauri and Native Shell.
- Added tray icon appearance options for light and dark desktop panels on Linux, FreeBSD, and OpenBSD.
- Added in-app feature highlights, with a setting to turn them off.
### Improved
- Made System VPN and Local Proxy modes selectable directly from the main window.
- Refined connection details, saved-server selection, keyboard navigation, and dialog appearance.
- Removed the need for OpenSSL compatibility configuration and external OpenSSL conversion tools.
### Fixed
- Fixed macOS VPN DNS configuration and cleanup, including split-tunnel connections.
- Fixed background CLI reconnections failing after the initial connection.
- Fixed server addresses losing custom ports when pasted as URLs.
- Fixed gateway login address handling for servers with explicit ports.
- Fixed browser sign-in registration when desktop-specific settings override the callback handler on Linux, FreeBSD, or OpenBSD.
- Fixed supplied server certificate pins not being enforced during tunnel setup.
- Fixed delayed clicks activating a different control after a Native Shell view changed.
### Command-line notes
- Deprecated `--fix-openssl` on Linux, FreeBSD, and OpenBSD. Existing commands still accept it, but it has no effect.
## 3.2.0 ## 3.2.0
### Added ### Added
-1
View File
@@ -72,7 +72,6 @@ impl SwitchListener {
self.directory.path().join("control") self.directory.path().join("control")
} }
#[cfg(target_os = "linux")]
pub async fn ready(&self) -> anyhow::Result<()> { pub async fn ready(&self) -> anyhow::Result<()> {
let (mut socket, _) = self.listener.accept().await?; let (mut socket, _) = self.listener.accept().await?;
anyhow::ensure!( anyhow::ensure!(
+1 -1
View File
@@ -18,7 +18,7 @@ Install build and runtime dependencies:
```sh ```sh
sudo pkg install git rust libiconv gettext-tools autoconf automake libtool patch \ sudo pkg install git rust libiconv gettext-tools autoconf automake libtool patch \
gmake pkgconf libxml2 gnutls p11-kit nettle gmp liblz4 gnome-keyring \ gmake pkgconf libxml2 gnutls p11-kit nettle gmp gnome-keyring \
libayatana-appindicator polkit webkit2-gtk_41 xdg-utils libayatana-appindicator polkit webkit2-gtk_41 xdg-utils
``` ```