# GlobalProtect-openconnect A GUI for GlobalProtect VPN, based on OpenConnect, supports the SSO authentication method. Inspired by [gp-saml-gui](https://github.com/dlenski/gp-saml-gui).

## Features - [x] Better Linux support - [x] Support both CLI and GUI - [x] Support both SSO and non-SSO authentication - [x] Support the FIDO2 authentication (e.g., YubiKey) - [x] Support authentication using default browser - [x] Support client certificate authentication - [x] Support multiple portals - [x] Support gateway selection - [x] Support connect gateway directly - [x] Support auto-connect on startup - [x] 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] 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 ' 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: ```bash sudo -E gpclient connect --browser default ``` Or you can try the following command if the above command does not work: ```bash gpauth --browser default 2>/dev/null | sudo gpclient connect --cookie-on-stdin ``` You can specify the browser with the `--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](./apps/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 7937C393082992E5D6E4A60453FC26B43838D761` if you encountered an error `gpg: keyserver receive failed: General error`. #### Install from deb package Download the latest deb package from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. Then install it with `apt`: ```bash sudo apt install --fix-broken globalprotect-openconnect_*.deb ``` ### Arch Linux / Manjaro #### Install from AUR Install from AUR: [globalprotect-openconnect-git](https://aur.archlinux.org/packages/globalprotect-openconnect-git/) ```bash yay -S globalprotect-openconnect-git ``` #### Install from package Download the latest package from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. Then install it with `pacman`: ```bash sudo pacman -U globalprotect-openconnect-*.pkg.tar.zst ``` ### Fedora 38 and later / Fedora Rawhide #### Install from COPR The package is available on [COPR](https://copr.fedorainfracloud.org/coprs/yuezk/globalprotect-openconnect/) for various RPM-based distributions. You can install it with the following commands: ```bash 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](https://build.opensuse.org/package/show/home:yuezk/globalprotect-openconnect) for various RPM-based distributions. You can follow the instructions [on this page](https://software.opensuse.org//download.html?project=home%3Ayuezk&package=globalprotect-openconnect) to install it. ### Other RPM-based distributions #### Install from RPM package Download the latest RPM package from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. ```bash sudo rpm -i globalprotect-openconnect-*.rpm ``` ### Gentoo It is available via `guru` and `lamdness` overlays. ```bash 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`: ```nix { inputs = { # ... other inputs globalprotect-openconnect.url = "github:yuezk/GlobalProtect-openconnect"; }; outputs = { nixpkgs, ... }@inputs: { nixosConfigurations. = nixpkgs.lib.nixosSystem { specialArgs = { inherit inputs; }; modules = [ ./configuration.nix ]; }; }; } ``` Then add `globalprotect-openconnect` to your `environment.systemPackages` in `configuration.nix`: ```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-appindicator` or `libappindicator-gtk3`. - Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. - Extract the tarball with `tar -xJf globalprotect-openconnect_${version}_${arch}.bin.tar.xz`. - Run `sudo make install` to 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](https://docs.docker.com/get-docker/) - [VS Code](https://code.visualstudio.com/) with [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (optional, for IDE support) #### Build Steps 1. Clone the repository: ```bash git clone https://github.com/yuezk/GlobalProtect-openconnect.git cd GlobalProtect-openconnect ``` 2. Build the devcontainer image: ```bash docker build -t gpoc-devcontainer .devcontainer/ ``` 3. Install `jq` in the container and build the project: ```bash docker run --privileged --cap-add=NET_ADMIN --device=/dev/net/tun \ -v "$(pwd)":/workspace -w /workspace --user root gpoc-devcontainer \ bash -c "apt-get update && apt-get install -y jq" 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" ``` 4. The built binaries will be available in `target/release/`: - `gpclient` - CLI client - `gpservice` - Background service - `gpauth` - Authentication helper - `gpgui-helper` - GUI helper #### Alternative: VS Code DevContainer 1. Open the project in VS Code 2. When prompted, click "Reopen in Container" or run the command "Dev Containers: Reopen in Container" 3. Once the container is built and running, open a terminal in VS Code and run: ```bash make build ``` ### Option 2: Local Build #### Prerequisites - [Install Rust 1.82 or later](https://www.rust-lang.org/tools/install) - Install Tauri dependencies: https://tauri.app/start/prerequisites/ - Install `perl` and `jq` - Install `openconnect >= 8.20` and `libopenconnect-dev` (or `openconnect-devel` on RPM-based distributions) - Install `pkexec`, `gnome-keyring` (or `pam_kwallet` on KDE) - Install `nodejs` and `pnpm` (optional only if you downloaded the source tarball from the release page and run with the `BUILD_FE=0` flag, see below) #### Build Steps 1. Download the source code tarball from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. Choose `globalprotect-openconnect-${version}.tar.gz`. 2. Extract the tarball with `tar -xzf globalprotect-openconnect-${version}.tar.gz`. 3. Enter the source directory and run `make build BUILD_FE=0` to build the client. 4. Run `sudo make install` to install the client. (Note, `DESTDIR` is not supported) ### Testing the Build After building, you can test the CLI client: ```bash ./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 1. How to deal with error `Secure Storage not ready` Try upgrade the client to `2.2.0` or later, which will use a file-based storage as a fallback. You need to install the `gnome-keyring` package, and restart the system (See [#321](https://github.com/yuezk/GlobalProtect-openconnect/issues/321), [#316](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)). 2. 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](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)). ## About Trial The CLI version is always free, while the GUI version is paid. There are two trial modes for the GUI version: 1. 10-day trial: You can use the GUI stable release for 10 days after the installation. 2. 14-day trial: Each beta release has a fresh trial period (at most 14 days) after released. ## License - crate [gpapi](./crates/gpapi): [MIT](./crates/gpapi/LICENSE) - crate [openconnect](./crates/openconnect): [GPL-3.0](./crates/openconnect/LICENSE) - crate [common](./crates/common): [GPL-3.0](./crates/common/LICENSE) - crate [auth](./crates/auth): [GPL-3.0](./crates/auth/LICENSE) - app [gpservice](./apps/gpservice): [GPL-3.0](./apps/gpservice/LICENSE) - app [gpclient](./apps/gpclient): [GPL-3.0](./apps/gpclient/LICENSE) - app [gpauth](./apps/gpauth): [GPL-3.0](./apps/gpauth/LICENSE) - app [gpgui-helper](./apps/gpgui-helper): [GPL-3.0](./apps/gpgui-helper/LICENSE)