Compare commits

..
Author SHA1 Message Date
Kevin Yue fd08cdbe66 feat: release GP Connect 3.3.0 with Native Shell support 2026-11-05 23:05:14 +08:00
Kevin Yue d12d677208 Merge pull request #693 from yuezk/ci/prepare-3.3.0-release
ci: prepare Native Shell release infrastructure
2026-11-05 23:01:42 +08:00
Kevin Yue d15ebdfe3a ci: prepare Native Shell builds and publishers for 3.3.0 2026-11-05 22:59:59 +08:00
7 changed files with 150 additions and 417 deletions

No files matched your search

+3
View File
@@ -16,3 +16,6 @@ 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.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"block2", "block2",
@@ -547,7 +547,7 @@ dependencies = [
[[package]] [[package]]
name = "browser-launcher" name = "browser-launcher"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"log", "log",
@@ -911,7 +911,7 @@ dependencies = [
[[package]] [[package]]
name = "common" name = "common"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"tempfile", "tempfile",
] ]
@@ -2115,7 +2115,7 @@ dependencies = [
[[package]] [[package]]
name = "gpapi" name = "gpapi"
version = "3.2.0" version = "3.3.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.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"auth", "auth",
@@ -2193,7 +2193,7 @@ dependencies = [
[[package]] [[package]]
name = "gpclient" name = "gpclient"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"clap", "clap",
@@ -2224,7 +2224,7 @@ dependencies = [
[[package]] [[package]]
name = "gpgui-helper" name = "gpgui-helper"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"clap", "clap",
@@ -2245,7 +2245,7 @@ dependencies = [
[[package]] [[package]]
name = "gphip" name = "gphip"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"askama", "askama",
@@ -2262,7 +2262,7 @@ dependencies = [
[[package]] [[package]]
name = "gpservice" name = "gpservice"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"axum", "axum",
@@ -2297,7 +2297,7 @@ dependencies = [
[[package]] [[package]]
name = "gptunnel" name = "gptunnel"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"gpapi", "gpapi",
"log", "log",
@@ -2309,7 +2309,7 @@ dependencies = [
[[package]] [[package]]
name = "gpvpnc" name = "gpvpnc"
version = "3.2.0" version = "3.3.0"
dependencies = [ dependencies = [
"log", "log",
] ]
@@ -3823,7 +3823,7 @@ dependencies = [
[[package]] [[package]]
name = "openconnect" name = "openconnect"
version = "3.2.0" version = "3.3.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.2.0" version = "3.3.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"
+103 -403
View File
@@ -1,6 +1,8 @@
# GlobalProtect-openconnect # GlobalProtect-openconnect
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. 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.
> **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>
@@ -22,147 +24,89 @@ A GlobalProtect VPN client built on OpenConnect with support for SSO authenticat
- [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 38+ / Rawhide](#fedora-38--rawhide) - [Fedora / RHEL](#fedora--rhel)
- [openSUSE Leap 15.6+ / Tumbleweed](#opensuse-leap-156--tumbleweed) - [openSUSE](#opensuse)
- [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)
- [Official Docker Image](#official-docker-image) - [Docker](#docker)
- [Other Distributions](#other-distributions) - [Other Distributions](#other-distributions)
- [Building from Source](#building-from-source) - [Building from Source](#building-from-source)
- [Frequently Asked Questions](#frequently-asked-questions) - [Troubleshooting](#troubleshooting)
- [NetworkManager Integration](#networkmanager-integration) - [NetworkManager Integration](#networkmanager-integration)
- [Licensing](#licensing) - [Licensing](#licensing)
## Features ## Features
- **Desktop Platform Support** – macOS, Linux, FreeBSD, and OpenBSD - **Multi-Platform** – macOS (Apple silicon), Linux, FreeBSD, and OpenBSD
- **Dual Interface** – Available as both CLI and GUI applications - **Dual Interfaces** – Fast terminal CLI (`gpclient`) and desktop GUI (**GP Connect**)
- **Flexible Authentication** – Supports SSO, non-SSO, FIDO2 (e.g., YubiKey), and client certificate authentication - **Native Shell on Linux** – Ultra-low-memory native desktop GUI alongside the webview interface
- **Browser Integration** – Authenticate using your default browser or any specified browser - **Flexible Routing** – Full System VPN tunnel or local SOCKS5 proxy mode
- **Multi-Portal Support** – Connect to multiple portals and gateways - **Modern Authentication** – SAML / SSO, MFA, FIDO2 (YubiKey), client certificates, and external browser login
- **Direct Gateway Connection** – Bypass portal selection when needed - **Automated HIP Reports** – Built-in HIP report generation or custom scripts
- **Auto-Connect** – Automatically connect on system startup - **Multi-Portal & Direct Gateway** – Manage multiple saved portals or connect directly to a gateway
- **System Tray Integration** – Convenient system tray icon (requires [gnome-shell-extension-appindicator](https://extensions.gnome.org/extension/615/appindicator-support/) on GNOME) - **Desktop Integration** – Theme-aware system tray icon, auto-connect on launch, and reconnect on wake
## Usage ## Usage
### Command-Line Interface ### Command-Line Interface
The CLI is free and open source. Use it to authenticate, connect to portals or gateways, and generate HIP reports from the terminal. The open-source `gpclient` CLI handles authentication, connection lifecycle, and HIP generation:
#### Basic Commands
```bash ```bash
Usage: gpclient [OPTIONS] <COMMAND> # Connect to a portal server
sudo gpclient connect <portal>
Commands: # Connect using browser authentication (SSO / SAML)
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)
Options:
--ignore-tls-errors Ignore the TLS errors
--lock-file <LOCK_FILE> Path to the gpclient PID lock file
--log-format <LOG_FORMAT> Log output format. JSON is intended for non-interactive consumers; interactive prompts remain text. [default: text] [possible values: text, json]
-v, --verbose... Enable verbose output, -v for debug, -vv for trace
-q, --quiet... Decrease logging verbosity, -q for warnings, -qq for errors
-h, --help Print help (see more with '--help')
-V, --version Print version
```
> **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 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
``` ```
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. Run `gpclient --help` or `gpclient <command> --help` to view all available commands and options.
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
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: - **macOS**: Open **GP Connect** from Applications.
- **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 to it in **Settings → General → Interface**. > **On Linux, try Native Shell for lower memory usage.** Switch between Native Shell and Tauri 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
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. Requires Apple silicon and macOS 13+. Includes both GP Connect and the `gpclient` CLI.
#### Option 1: Install with Homebrew #### Option 1: Homebrew (Recommended)
```bash ```bash
brew install --cask yuezk/gp-connect/gp-connect brew install --cask yuezk/gp-connect/gp-connect
``` ```
Open GP Connect from Applications, or connect from the terminal: #### Option 2: DMG Installer
```bash Download the `.dmg` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page and drag GP Connect into Applications.
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: Install from PPA (Recommended) #### Option 1: PPA (Recommended)
```bash ```bash
sudo add-apt-repository ppa:yuezk/globalprotect-openconnect sudo add-apt-repository ppa:yuezk/globalprotect-openconnect
@@ -170,392 +114,152 @@ sudo apt-get update
sudo apt-get install globalprotect-openconnect sudo apt-get install globalprotect-openconnect
``` ```
> [!Note] #### Option 2: DEB Package
>
> **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
> ```
#### Option 2: Install from DEB Package Download the latest `.deb` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
Download the latest `.deb` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
```bash ```bash
sudo apt install --fix-broken ./globalprotect-openconnect_*.deb sudo apt install ./globalprotect-openconnect_*.deb
``` ```
### Arch Linux / Manjaro ### Arch Linux / Manjaro
#### Option 1: Install from AUR
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 ```bash
# Official Extra repository
sudo pacman -S globalprotect-openconnect
# AUR (git main)
yay -S globalprotect-openconnect-git yay -S globalprotect-openconnect-git
``` ```
#### Option 2: Install from the Official Extra Repository ### Fedora / RHEL
The package is also available in the official Arch Linux Extra repository. Enable the COPR 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 Leap 15.6+ / Tumbleweed ### openSUSE
#### 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 [OBS instructions](https://software.opensuse.org/download.html?project=home%3Ayuezk&package=globalprotect-openconnect) for your distribution.
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, then install: Download the latest `.apk` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```bash ```bash
sudo apk add --allow-untrusted globalprotect-openconnect-*.apk sudo apk add --allow-untrusted globalprotect-openconnect-*.apk
``` ```
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`. *(Requires `community` repository enabled for WebKitGTK and AppIndicator dependencies).*
### FreeBSD ### FreeBSD
Download the latest FreeBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install: Download the latest FreeBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```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, then install: Download the latest OpenBSD package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
```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` and `lamdness` overlays: Available via the `guru` repository:
```bash ```bash
sudo eselect repository enable guru sudo eselect repository enable guru
sudo emerge --sync guru sudo emerge --sync guru
sudo emerge --ask --verbose net-vpn/GlobalProtect-openconnect sudo emerge --ask net-vpn/GlobalProtect-openconnect
``` ```
### NixOS ### NixOS
This repository includes a flake for NixOS integration. Add the flake to your `flake.nix`:
#### 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 = { inputs.globalprotect-openconnect.url = "github:yuezk/GlobalProtect-openconnect";
# ... other inputs
globalprotect-openconnect.url = "github:yuezk/GlobalProtect-openconnect";
};
outputs = { self, nixpkgs, globalprotect-openconnect, ... }: outputs = { self, nixpkgs, globalprotect-openconnect, ... }: {
let nixosConfigurations.<hostname> = nixpkgs.lib.nixosSystem {
system = "x86_64-linux"; # or "aarch64-linux" for ARM64 modules = [
hostname = "<your-host>"; globalprotect-openconnect.nixosModules.default
in { {
nixosConfigurations.${hostname} = nixpkgs.lib.nixosSystem { programs.globalprotect-openconnect.enable = true;
inherit system; }
];
modules = [
./configuration.nix
globalprotect-openconnect.nixosModules.default
{
programs.globalprotect-openconnect.enable = true;
environment.systemPackages = [
nixpkgs.legacyPackages.${system}.gnomeExtensions.appindicator
];
}
];
};
}; };
}
} }
``` ```
Apply: Apply changes:
```bash ```bash
sudo nixos-rebuild switch sudo nixos-rebuild switch
loginctl terminate-user "$USER"
``` ```
After logging back in to GNOME, enable AppIndicator support if needed: ### Docker
```bash Run the CLI client in an official Alpine container:
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:<version> \ yuezk/globalprotect-openconnect:latest \
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
``` ```
On a host with multiple network interfaces, use `--browser-listen` to select the IP address reachable from the browser machine: *(Add `--network host` on Linux if VPN routes should apply to the host network).*
```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
#### Manual Installation Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
1. **Install dependencies:** ```bash
- WebKitGTK 4.1 (for example, `libwebkit2gtk-4.1-0` on Debian/Ubuntu) tar -xJf globalprotect-openconnect_*.bin.tar.xz
- `libsecret` cd globalprotect-openconnect_*
- `libayatana-appindicator` or `libappindicator-gtk3` sudo make install
- 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
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). ### Prerequisites (Linux)
### Method 1: Using DevContainer - [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` (or GTK 4 for Native Shell)
- Polkit (`pkexec`) for privileged tunnel setup
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. *(For FreeBSD and OpenBSD instructions, see [Building from Source on FreeBSD and OpenBSD](docs/bsd-source-build.md)).*
#### Prerequisites ### Build Steps
- [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
./target/release/gpclient --help git clone --recursive https://github.com/yuezk/GlobalProtect-openconnect.git
cd GlobalProtect-openconnect
make build
sudo make install
``` ```
### Build Options **Build Options:**
- `BUILD_GUI_HELPER=0` – Skip building and installing the GUI helper - `INCLUDE_GUI=1` – Download and install the matching desktop application bundle.
- `BUILD_WEBVIEW_AUTH=0` – Build `gpauth` without embedded browser authentication; use an external browser or manual authentication - `BUILD_WEBVIEW_AUTH=0` – Build `gpauth` without embedded browser authentication (uses external browser or manual mode).
- `INCLUDE_GUI=1` – Download the matching published Linux desktop application for installation - `BUILD_GUI_HELPER=0` – Skip building the helper UI.
- `OFFLINE=1` – Build in offline mode using vendored dependencies
## Frequently Asked Questions ## Troubleshooting
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. - **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.
### 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
@@ -564,14 +268,10 @@ On a headless server, use `--browser manual` and complete authentication from an
## Licensing ## Licensing
### Trial and Pricing - **CLI (`gpclient`)**: Free and open source (GPL-3.0).
- **GUI (GP Connect)**: Commercial desktop application with a free trial.
The **CLI version** is completely free and open source. ### Open Source Components
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,5 +1,34 @@
# 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,6 +72,7 @@ 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 gnome-keyring \ gmake pkgconf libxml2 gnutls p11-kit nettle gmp liblz4 gnome-keyring \
libayatana-appindicator polkit webkit2-gtk_41 xdg-utils libayatana-appindicator polkit webkit2-gtk_41 xdg-utils
``` ```