10 KiB
GlobalProtect-openconnect
A GUI for GlobalProtect VPN, based on OpenConnect, supports the SSO authentication method. Inspired by gp-saml-gui.
Features
- Better Linux support
- Support both CLI and GUI
- Support both SSO and non-SSO authentication
- Support the FIDO2 authentication (e.g., YubiKey)
- Support authentication using default browser
- Support client certificate authentication
- Support multiple portals
- Support gateway selection
- Support connect gateway directly
- Support auto-connect on startup
- Support system tray icon
Usage
CLI
The CLI version is always free and open source in this repo. It has almost the same features as the GUI version.
Usage: gpclient [OPTIONS] <COMMAND>
Commands:
connect Connect to a portal server
disconnect Disconnect from the server
launch-gui Launch the GUI
help Print this message or the help of the given subcommand(s)
Options:
--fix-openssl Get around the OpenSSL `unsafe legacy renegotiation` error
--ignore-tls-errors Ignore the TLS errors
-h, --help Print help
-V, --version Print version
See 'gpclient help <command>' for more information on a specific command.
To use the external browser for authentication with the CLI version, you need to use the following command:
sudo -E gpclient connect --browser default <portal>
Or you can try the following command if the above command does not work:
gpauth <portal> --browser default 2>/dev/null | sudo gpclient connect <portal> --cookie-on-stdin
You can specify the browser with the --browser <browser> option, e.g., --browser firefox, --browser chrome, etc. Use --browser remote to use a remote browser for authentication, this will give you a URL you can access on a separate computer with a browser to complete authentication. Useful for headless servers.
GUI
The GUI version is also available after you installed it. You can launch it from the application menu or run gpclient launch-gui in the terminal.
Note
The GUI version is partially open source. Its background service is open sourced in this repo as gpservice. The GUI part is a wrapper of the background service, which is not open sourced.
Installation
Debian/Ubuntu based distributions
Install from PPA
sudo add-apt-repository ppa:yuezk/globalprotect-openconnect
sudo apt-get install globalprotect-openconnect
Note
For Linux Mint, you might need to import the GPG key with:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 7937C393082992E5D6E4A60453FC26B43838D761if you encountered an errorgpg: keyserver receive failed: General error.
Install from deb package
Download the latest deb package from releases page. Then install it with apt:
sudo apt install --fix-broken globalprotect-openconnect_*.deb
Arch Linux / Manjaro
Install from AUR
Install from AUR: globalprotect-openconnect-git
yay -S globalprotect-openconnect-git
Install from package
Download the latest package from releases page. Then install it with pacman:
sudo pacman -U globalprotect-openconnect-*.pkg.tar.zst
Fedora 38 and later / Fedora Rawhide
Install from COPR
The package is available on COPR for various RPM-based distributions. You can install it with the following commands:
sudo dnf copr enable yuezk/globalprotect-openconnect
sudo dnf install globalprotect-openconnect
openSUSE Leap 15.6 / openSUSE Tumbleweed
Install from OBS (openSUSE Build Service)
The package is also available on OBS for various RPM-based distributions. You can follow the instructions on this page to install it.
Other RPM-based distributions
Install from RPM package
Download the latest RPM package from releases page.
sudo rpm -i globalprotect-openconnect-*.rpm
Gentoo
It is available via guru and lamdness overlays.
sudo eselect repository enable guru
sudo emerge -r guru sync
sudo emerge -av net-vpn/GlobalProtect-openconnect
NixOS
This repo includes a flake for NixOS. You can add the following to your flake.nix:
{
inputs = {
# ... other inputs
globalprotect-openconnect.url = "github:yuezk/GlobalProtect-openconnect";
};
outputs = { nixpkgs, ... }@inputs: {
nixosConfigurations.<your-host> = nixpkgs.lib.nixosSystem {
specialArgs = { inherit inputs; };
modules = [
./configuration.nix
];
};
};
}
Then add globalprotect-openconnect to your environment.systemPackages in configuration.nix:
{ config, pkgs, inputs, ... }:
{
# ... other configurations
environment.systemPackages = with pkgs; [
# ... other packages
] ++ [
inputs.globalprotect-openconnect.packages.${pkgs.system}.default
];
}
Finally, run sudo nixos-rebuild switch to apply the changes.
Other distributions
- Install
openconnect >= 8.20,webkit2gtk,libsecret,libayatana-appindicatororlibappindicator-gtk3. - Download
globalprotect-openconnect_${version}_${arch}.bin.tar.xzfrom releases page. - Extract the tarball with
tar -xJf globalprotect-openconnect_${version}_${arch}.bin.tar.xz. - Run
sudo make installto install the client.
Build from source
You can build the client from source using either a devcontainer (recommended) or a local setup.
Option 1: Using DevContainer (Recommended)
This project includes a devcontainer configuration that provides a consistent build environment with all dependencies pre-installed.
Prerequisites
- Docker
- VS Code with Dev Containers extension (optional, for IDE support)
Build Steps
-
Clone the repository and submodules:
git clone https://github.com/yuezk/GlobalProtect-openconnect.git cd GlobalProtect-openconnect git submodule update --init --recursive -
Build the devcontainer image:
docker build -t gpoc-devcontainer .devcontainer/ -
Build the project:
docker run --privileged --cap-add=NET_ADMIN --device=/dev/net/tun \ -v "$(pwd)":/workspace -w /workspace gpoc-devcontainer \ bash -c "export PATH=/usr/local/cargo/bin:\$PATH && make build" -
The built binaries will be available in
target/release/:gpclient- CLI clientgpservice- Background servicegpauth- Authentication helpergpgui-helper- GUI helper
Alternative: VS Code DevContainer
- Open the project in VS Code
- When prompted, click "Reopen in Container" or run the command "Dev Containers: Reopen in Container"
- Once the container is built and running, open a terminal in VS Code and run:
make build
Option 2: Local Build
Prerequisites
- Install Rust 1.85 or later
- Install Tauri dependencies: https://tauri.app/start/prerequisites/
- Install
perl - Install
openconnect >= 8.20andlibopenconnect-dev(oropenconnect-develon RPM-based distributions) - Install
pkexec,gnome-keyring(orpam_kwalleton KDE) - Install
nodejsandpnpm(optional only if you downloaded the source tarball from the release page and run with theBUILD_FE=0flag, see below)
Build Steps
- Download the source code tarball from releases page. Choose
globalprotect-openconnect-${version}.tar.gz. - Extract the tarball with
tar -xzf globalprotect-openconnect-${version}.tar.gz. - Enter the source directory and run
make build BUILD_FE=0to build the client. - Run
sudo make installto install the client. (Note,DESTDIRis not supported)
Testing the Build
After building, you can test the CLI client:
./target/release/gpclient --help
Build Options
BUILD_GUI=0- Disable GUI components (CLI only)BUILD_FE=0- Skip frontend build (use pre-built assets)OFFLINE=1- Build in offline mode using vendored dependencies
FAQ
-
How to deal with error
Secure Storage not readyTry upgrade the client to
2.2.0or later, which will use a file-based storage as a fallback.You need to install the
gnome-keyringpackage, and restart the system (See #321, #316). -
How to deal with error
(gpauth:18869): Gtk-WARNING **: 10:33:37.566: cannot open display:If you encounter this error when using the CLI version, try to run the command with
sudo -E(See #316).
About Trial
The CLI version is always free, while the GUI version is paid. There are two trial modes for the GUI version:
- 10-day trial: You can use the GUI stable release for 10 days after the installation.
- 14-day trial: Each beta release has a fresh trial period (at most 14 days) after released.