mirror of
https://github.com/yuezk/GlobalProtect-openconnect.git
synced 2026-11-19 06:26:14 -05:00
Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
545305d12a | ||
|
|
f1a866c574 | ||
|
|
29e8d9c822 | ||
|
|
8724ed3b37 | ||
|
|
01075cb6dc | ||
|
|
b7b708e9cd |
No files matched your search
@@ -476,6 +476,7 @@ jobs:
|
|||||||
--extra-experimental-features "nix-command flakes" --print-build-logs
|
--extra-experimental-features "nix-command flakes" --print-build-logs
|
||||||
|
|
||||||
trigger-gpgui-macos:
|
trigger-gpgui-macos:
|
||||||
|
needs: test-gp
|
||||||
if: ${{ startsWith(github.ref, 'refs/tags/') || (github.event_name == 'workflow_dispatch' && inputs.build_macos) }}
|
if: ${{ startsWith(github.ref, 'refs/tags/') || (github.event_name == 'workflow_dispatch' && inputs.build_macos) }}
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
@@ -801,6 +802,7 @@ jobs:
|
|||||||
attestations: write
|
attestations: write
|
||||||
artifact-metadata: write
|
artifact-metadata: write
|
||||||
needs:
|
needs:
|
||||||
|
- test-gp
|
||||||
- nix-source
|
- nix-source
|
||||||
- nix-prebuilt
|
- nix-prebuilt
|
||||||
- tarball
|
- tarball
|
||||||
@@ -954,6 +956,7 @@ jobs:
|
|||||||
|
|
||||||
publish-docker-image:
|
publish-docker-image:
|
||||||
needs:
|
needs:
|
||||||
|
- test-gp
|
||||||
- build-docker-image
|
- build-docker-image
|
||||||
if: ${{ (github.event_name == 'workflow_dispatch' && !inputs.build_only) || startsWith(github.ref, 'refs/tags/') }}
|
if: ${{ (github.event_name == 'workflow_dispatch' && !inputs.build_only) || startsWith(github.ref, 'refs/tags/') }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|||||||
@@ -0,0 +1,118 @@
|
|||||||
|
name: Nix
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- "flake.nix"
|
||||||
|
- "flake.lock"
|
||||||
|
- "nix/**"
|
||||||
|
- ".github/workflows/nix.yaml"
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- "flake.nix"
|
||||||
|
- "flake.lock"
|
||||||
|
- "nix/**"
|
||||||
|
- ".github/workflows/nix.yaml"
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
standalone-package:
|
||||||
|
name: standalone-package (${{ matrix.platform.system }})
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
platform:
|
||||||
|
- runner: ubuntu-latest
|
||||||
|
system: x86_64-linux
|
||||||
|
- runner: ubuntu-24.04-arm
|
||||||
|
system: aarch64-linux
|
||||||
|
runs-on: ${{ matrix.platform.runner }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout GlobalProtect-openconnect
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Install Nix
|
||||||
|
uses: cachix/install-nix-action@v31
|
||||||
|
|
||||||
|
- name: Build standalone prebuilt package
|
||||||
|
run: |
|
||||||
|
nix build .#prebuilt \
|
||||||
|
--extra-experimental-features "nix-command flakes" \
|
||||||
|
--print-build-logs
|
||||||
|
|
||||||
|
- name: Inspect prebuilt package
|
||||||
|
run: |
|
||||||
|
test -x result/bin/gpclient
|
||||||
|
test -x result/bin/gpauth
|
||||||
|
test -x result/bin/gpservice
|
||||||
|
test -x result/bin/gpgui-helper
|
||||||
|
test -x result/bin/gpgui
|
||||||
|
|
||||||
|
nixos-module:
|
||||||
|
name: nixos-module (${{ matrix.platform.system }}, ${{ matrix.nixpkgs }})
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
platform:
|
||||||
|
- runner: ubuntu-latest
|
||||||
|
system: x86_64-linux
|
||||||
|
- runner: ubuntu-24.04-arm
|
||||||
|
system: aarch64-linux
|
||||||
|
nixpkgs:
|
||||||
|
- nixos-25.11
|
||||||
|
- nixos-26.05
|
||||||
|
- nixpkgs-unstable
|
||||||
|
runs-on: ${{ matrix.platform.runner }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout GlobalProtect-openconnect
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Install Nix
|
||||||
|
uses: cachix/install-nix-action@v31
|
||||||
|
|
||||||
|
- name: Build package through host NixOS module
|
||||||
|
env:
|
||||||
|
NIXPKGS_URL: github:NixOS/nixpkgs/${{ matrix.nixpkgs }}
|
||||||
|
NIX_SYSTEM: ${{ matrix.platform.system }}
|
||||||
|
run: |
|
||||||
|
nix build \
|
||||||
|
--impure \
|
||||||
|
--extra-experimental-features "nix-command flakes" \
|
||||||
|
--print-build-logs \
|
||||||
|
--expr '
|
||||||
|
let
|
||||||
|
gp = builtins.getFlake (toString ./.);
|
||||||
|
hostNixpkgs =
|
||||||
|
builtins.getFlake (builtins.getEnv "NIXPKGS_URL");
|
||||||
|
|
||||||
|
hostSystem = hostNixpkgs.lib.nixosSystem {
|
||||||
|
system = builtins.getEnv "NIX_SYSTEM";
|
||||||
|
modules = [
|
||||||
|
gp.nixosModules.default
|
||||||
|
{
|
||||||
|
programs.globalprotect-openconnect.enable = true;
|
||||||
|
system.stateVersion = "25.11";
|
||||||
|
}
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
package =
|
||||||
|
hostSystem.config.programs.globalprotect-openconnect.package;
|
||||||
|
in
|
||||||
|
assert builtins.elem package
|
||||||
|
hostSystem.config.environment.systemPackages;
|
||||||
|
assert hostSystem.config.services.ayatana-indicators.enable;
|
||||||
|
package
|
||||||
|
'
|
||||||
|
|
||||||
|
- name: Inspect module package
|
||||||
|
run: |
|
||||||
|
test -x result/bin/gpclient
|
||||||
|
test -x result/bin/gpauth
|
||||||
|
test -x result/bin/gpservice
|
||||||
|
test -x result/bin/gpgui-helper
|
||||||
|
test -x result/bin/gpgui
|
||||||
Generated
+13
-10
@@ -214,7 +214,7 @@ checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "auth"
|
name = "auth"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"block2",
|
"block2",
|
||||||
@@ -423,7 +423,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "browser-launcher"
|
name = "browser-launcher"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"log",
|
"log",
|
||||||
@@ -719,7 +719,10 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "common"
|
name = "common"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
|
dependencies = [
|
||||||
|
"tempfile",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "compile-time"
|
name = "compile-time"
|
||||||
@@ -1828,7 +1831,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "gpapi"
|
name = "gpapi"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"base64 0.22.1",
|
"base64 0.22.1",
|
||||||
@@ -1879,7 +1882,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "gpauth"
|
name = "gpauth"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"auth",
|
"auth",
|
||||||
@@ -1898,7 +1901,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "gpclient"
|
name = "gpclient"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1924,7 +1927,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "gpgui-helper"
|
name = "gpgui-helper"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1945,7 +1948,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "gphip"
|
name = "gphip"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"askama",
|
"askama",
|
||||||
@@ -1962,7 +1965,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "gpservice"
|
name = "gpservice"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"axum",
|
"axum",
|
||||||
@@ -3383,7 +3386,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "openconnect"
|
name = "openconnect"
|
||||||
version = "2.6.5"
|
version = "3.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"autotools",
|
"autotools",
|
||||||
"cc",
|
"cc",
|
||||||
|
|||||||
+1
-1
@@ -11,7 +11,7 @@ members = [
|
|||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
rust-version = "1.91"
|
rust-version = "1.91"
|
||||||
version = "2.6.5"
|
version = "3.0.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"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# GlobalProtect-openconnect
|
# GlobalProtect-openconnect
|
||||||
|
|
||||||
A modern GlobalProtect VPN client for Linux, built on OpenConnect with full support for SSO authentication. This project provides both command-line and graphical interfaces for seamless VPN connectivity.
|
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.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img width="300" src="https://github.com/user-attachments/assets/2fb6116c-dc57-43f2-af75-9c3d97ab7122">
|
<img width="300" src="https://github.com/user-attachments/assets/2fb6116c-dc57-43f2-af75-9c3d97ab7122">
|
||||||
@@ -15,12 +15,15 @@ A modern GlobalProtect VPN client for Linux, built on OpenConnect with full supp
|
|||||||
- [Command-Line Interface](#command-line-interface)
|
- [Command-Line Interface](#command-line-interface)
|
||||||
- [Graphical User Interface](#graphical-user-interface)
|
- [Graphical User Interface](#graphical-user-interface)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
|
- [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 38+ / Rawhide](#fedora-38--rawhide)
|
||||||
- [openSUSE Leap 15.6+ / Tumbleweed](#opensuse-leap-156--tumbleweed)
|
- [openSUSE Leap 15.6+ / Tumbleweed](#opensuse-leap-156--tumbleweed)
|
||||||
- [Other RPM-based Distributions](#other-rpm-based-distributions)
|
- [Other RPM-based Distributions](#other-rpm-based-distributions)
|
||||||
- [Alpine Linux](#alpine-linux)
|
- [Alpine Linux](#alpine-linux)
|
||||||
|
- [FreeBSD](#freebsd)
|
||||||
|
- [OpenBSD](#openbsd)
|
||||||
- [Gentoo](#gentoo)
|
- [Gentoo](#gentoo)
|
||||||
- [NixOS](#nixos)
|
- [NixOS](#nixos)
|
||||||
- [Official Docker Image](#official-docker-image)
|
- [Official Docker Image](#official-docker-image)
|
||||||
@@ -28,11 +31,11 @@ A modern GlobalProtect VPN client for Linux, built on OpenConnect with full supp
|
|||||||
- [Building from Source](#building-from-source)
|
- [Building from Source](#building-from-source)
|
||||||
- [Frequently Asked Questions](#frequently-asked-questions)
|
- [Frequently Asked Questions](#frequently-asked-questions)
|
||||||
- [NetworkManager Integration](#networkmanager-integration)
|
- [NetworkManager Integration](#networkmanager-integration)
|
||||||
- [License](#license)
|
- [Licensing](#licensing)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Cross-Platform Linux Support** – Optimized for various Linux distributions
|
- **Desktop Platform Support** – macOS, Linux, FreeBSD, and OpenBSD
|
||||||
- **Dual Interface** – Available as both CLI and GUI applications
|
- **Dual Interface** – Available as both CLI and GUI applications
|
||||||
- **Flexible Authentication** – Supports SSO, non-SSO, FIDO2 (e.g., YubiKey), and client certificate authentication
|
- **Flexible Authentication** – Supports SSO, non-SSO, FIDO2 (e.g., YubiKey), and client certificate authentication
|
||||||
- **Browser Integration** – Authenticate using your default browser or any specified browser
|
- **Browser Integration** – Authenticate using your default browser or any specified browser
|
||||||
@@ -45,7 +48,7 @@ A modern GlobalProtect VPN client for Linux, built on OpenConnect with full supp
|
|||||||
|
|
||||||
### Command-Line Interface
|
### Command-Line Interface
|
||||||
|
|
||||||
The CLI version is fully open source and feature-rich, providing nearly identical functionality to the GUI version.
|
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
|
#### Basic Commands
|
||||||
|
|
||||||
@@ -62,6 +65,7 @@ Commands:
|
|||||||
Options:
|
Options:
|
||||||
--fix-openssl Uses extended compatibility mode for OpenSSL operations to support a broader range of systems and formats.
|
--fix-openssl Uses extended compatibility mode for OpenSSL operations to support a broader range of systems and formats.
|
||||||
--ignore-tls-errors Ignore the TLS errors
|
--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]
|
--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
|
-v, --verbose... Enable verbose output, -v for debug, -vv for trace
|
||||||
-q, --quiet... Decrease logging verbosity, -q for warnings, -qq for errors
|
-q, --quiet... Decrease logging verbosity, -q for warnings, -qq for errors
|
||||||
@@ -85,27 +89,34 @@ Use `--hip=/absolute/path/to/script` for a custom executable. It runs as the `gp
|
|||||||
|
|
||||||
#### External Browser Authentication
|
#### External Browser Authentication
|
||||||
|
|
||||||
For browser-based authentication with the CLI:
|
Use `gpclient` directly for browser-based authentication. It opens the browser as your normal desktop user while keeping VPN tunnel setup privileged:
|
||||||
|
|
||||||
**Method 1:** Using sudo with environment preservation:
|
|
||||||
```bash
|
```bash
|
||||||
sudo gpclient connect --browser <portal>
|
sudo gpclient connect <portal> --browser
|
||||||
```
|
```
|
||||||
|
|
||||||
**Method 2:** Using authentication piping:
|
To reuse a saved portal cookie for later connections, add `--cookie-cache`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gpauth <portal> --browser 2>/dev/null | sudo gpclient connect <portal> --cookie-on-stdin
|
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:**
|
**Browser Options:**
|
||||||
- Use `--browser` to auto-select Chrome, Firefox, then the system default browser
|
|
||||||
|
- Use `--browser` to try your recognized default browser first, then another detected browser, and finally the system URL handler
|
||||||
- Use `--browser default` to use the system default browser
|
- Use `--browser default` to use the system default browser
|
||||||
- Use `--browser <browser>` to specify a browser (e.g., `firefox`, `chrome`)
|
- Use `--browser <browser>` to specify a browser (e.g., `firefox`, `chrome`)
|
||||||
- Use `--browser remote` for headless servers – this provides a URL you can access from another machine to complete authentication
|
- Use `--browser remote` for headless servers – this provides a URL you can access from another machine to complete authentication
|
||||||
|
|
||||||
### Graphical User Interface
|
### Graphical User Interface
|
||||||
|
|
||||||
The GUI application provides an intuitive interface for managing VPN connections. Launch it from your application menu or via the terminal:
|
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:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gpclient launch-gui
|
gpclient launch-gui
|
||||||
@@ -121,6 +132,26 @@ gpclient launch-gui
|
|||||||
>
|
>
|
||||||
> 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`).
|
> 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
|
||||||
|
|
||||||
|
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: Install with Homebrew
|
||||||
|
|
||||||
|
```bash
|
||||||
|
brew install --cask yuezk/gp-connect/gp-connect
|
||||||
|
```
|
||||||
|
|
||||||
|
Open GP Connect from Applications, or connect from the terminal:
|
||||||
|
|
||||||
|
```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: Install from PPA (Recommended)
|
#### Option 1: Install from PPA (Recommended)
|
||||||
@@ -143,7 +174,7 @@ sudo apt-get install globalprotect-openconnect
|
|||||||
Download the latest `.deb` package from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page, then install:
|
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 --fix-broken ./globalprotect-openconnect_*.deb
|
||||||
```
|
```
|
||||||
|
|
||||||
### Arch Linux / Manjaro
|
### Arch Linux / Manjaro
|
||||||
@@ -331,7 +362,7 @@ 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:<version> \
|
||||||
connect <portal> --cookie-on-stdin
|
connect <portal>
|
||||||
```
|
```
|
||||||
|
|
||||||
For browser authentication in a headless environment, use remote browser authentication:
|
For browser authentication in a headless environment, use remote browser authentication:
|
||||||
@@ -358,16 +389,6 @@ docker run --rm -it --network host --cap-add=NET_ADMIN --device=/dev/net/tun \
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
Alternatively, pipe `gpauth` remote-browser output into `gpclient`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run --rm -it --entrypoint gpauth yuezk/globalprotect-openconnect:<version> \
|
|
||||||
<portal> --browser remote 2>/dev/null \
|
|
||||||
| docker run --rm -i --cap-add=NET_ADMIN --device=/dev/net/tun \
|
|
||||||
yuezk/globalprotect-openconnect:<version> \
|
|
||||||
connect <portal> --cookie-on-stdin
|
|
||||||
```
|
|
||||||
|
|
||||||
The image includes `gpclient` and `gpauth` only. It does not include embedded webview authentication, `gpgui-helper`, or `gpgui`.
|
The image includes `gpclient` and `gpauth` only. It does not include embedded webview authentication, `gpgui-helper`, or `gpgui`.
|
||||||
|
|
||||||
### Other Distributions
|
### Other Distributions
|
||||||
@@ -375,14 +396,16 @@ The image includes `gpclient` and `gpauth` only. It does not include embedded we
|
|||||||
#### Manual Installation
|
#### Manual Installation
|
||||||
|
|
||||||
1. **Install dependencies:**
|
1. **Install dependencies:**
|
||||||
- `webkit2gtk`
|
- WebKitGTK 4.1 (for example, `libwebkit2gtk-4.1-0` on Debian/Ubuntu)
|
||||||
- `libsecret`
|
- `libsecret`
|
||||||
- `libayatana-appindicator` or `libappindicator-gtk3`
|
- `libayatana-appindicator` or `libappindicator-gtk3`
|
||||||
|
- polkit (`pkexec`) for GUI-launched VPN connections
|
||||||
|
|
||||||
2. **Download and extract:**
|
2. **Download and extract:**
|
||||||
Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
|
Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from the [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page:
|
||||||
```bash
|
```bash
|
||||||
tar -xJf globalprotect-openconnect_${version}_${arch}.bin.tar.xz
|
tar -xJf globalprotect-openconnect_${version}_${arch}.bin.tar.xz
|
||||||
|
cd globalprotect-openconnect_${version}
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Install:**
|
3. **Install:**
|
||||||
@@ -392,11 +415,11 @@ The image includes `gpclient` and `gpauth` only. It does not include embedded we
|
|||||||
|
|
||||||
## Building from Source
|
## Building from Source
|
||||||
|
|
||||||
You can build the application from source using either a DevContainer (recommended) or a local development environment.
|
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).
|
||||||
|
|
||||||
### Method 1: Using DevContainer (Recommended)
|
### Method 1: Using DevContainer
|
||||||
|
|
||||||
This project includes a DevContainer configuration that provides a consistent, reproducible build environment with all dependencies pre-installed.
|
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.
|
||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
@@ -420,7 +443,7 @@ This project includes a DevContainer configuration that provides a consistent, r
|
|||||||
|
|
||||||
3. **Build the project:**
|
3. **Build the project:**
|
||||||
|
|
||||||
To build everything including the GUI helper run this command:
|
To build the open-source components, including the GUI helper, run:
|
||||||
```bash
|
```bash
|
||||||
docker run --privileged --cap-add=NET_ADMIN --device=/dev/net/tun \
|
docker run --privileged --cap-add=NET_ADMIN --device=/dev/net/tun \
|
||||||
--tty -v "$(pwd)":/workspace -w /workspace gpoc-devcontainer \
|
--tty -v "$(pwd)":/workspace -w /workspace gpoc-devcontainer \
|
||||||
@@ -428,13 +451,17 @@ This project includes a DevContainer configuration that provides a consistent, r
|
|||||||
```
|
```
|
||||||
To build without the GUI helper run the same command as above, but with `BUILD_GUI_HELPER=0` passed as an argument to `make`.
|
To build without the GUI helper run the same command as above, but with `BUILD_GUI_HELPER=0` passed as an argument to `make`.
|
||||||
|
|
||||||
5. **Locate build artifacts:**
|
4. **Locate build artifacts:**
|
||||||
|
|
||||||
The compiled binaries will be available in `target/release/`:
|
The compiled binaries will be available in `target/release/`:
|
||||||
- `gpclient` – CLI client
|
- `gpclient` – CLI client
|
||||||
- `gpservice` – Background service
|
- `gpservice` – Background service
|
||||||
- `gpauth` – Authentication helper
|
- `gpauth` – Authentication helper
|
||||||
- `gpgui-helper` – GUI 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
|
#### Alternative: Using VS Code
|
||||||
|
|
||||||
@@ -453,7 +480,7 @@ This project includes a DevContainer configuration that provides a consistent, r
|
|||||||
- [Tauri dependencies](https://tauri.app/start/prerequisites/)
|
- [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
|
- 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)
|
- `pkexec` and `gnome-keyring` (or `pam_kwallet` on KDE)
|
||||||
- `nodejs` and `pnpm` (optional)
|
- Node.js and pnpm if rebuilding the GUI helper frontend
|
||||||
|
|
||||||
#### Build Steps
|
#### Build Steps
|
||||||
|
|
||||||
@@ -473,7 +500,7 @@ This project includes a DevContainer configuration that provides a consistent, r
|
|||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** `DESTDIR` is not currently supported.
|
To stage the files for packaging instead of installing them into the system, use `make install DESTDIR=/absolute/path/to/staging`.
|
||||||
|
|
||||||
### Testing Your Build
|
### Testing Your Build
|
||||||
|
|
||||||
@@ -485,29 +512,33 @@ Verify the CLI client is working correctly:
|
|||||||
|
|
||||||
### Build Options
|
### Build Options
|
||||||
|
|
||||||
- `BUILD_GUI_HELPER=0` – Build CLI components only (excludes GUI)
|
- `BUILD_GUI_HELPER=0` – Skip building and installing the GUI helper
|
||||||
|
- `BUILD_WEBVIEW_AUTH=0` – Build `gpauth` without embedded browser authentication; use an external or remote browser
|
||||||
|
- `INCLUDE_GUI=1` – Download the matching published Linux desktop application for installation
|
||||||
- `OFFLINE=1` – Build in offline mode using vendored dependencies
|
- `OFFLINE=1` – Build in offline mode using vendored dependencies
|
||||||
|
|
||||||
## Frequently Asked Questions
|
## Frequently Asked Questions
|
||||||
|
|
||||||
### Q: How do I resolve the "Secure Storage not ready" error?
|
### Q: How do I resolve the "Secure Storage not ready" error?
|
||||||
|
|
||||||
**Solution 1:** Update to version 2.2.0 or later, which includes a file-based storage fallback.
|
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.
|
||||||
|
|
||||||
**Solution 2:** Install the `gnome-keyring` package and restart your system.
|
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)
|
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?
|
### Q: How do I fix the "cannot open display" error when using CLI?
|
||||||
|
|
||||||
If you encounter `(gpauth:18869): Gtk-WARNING **: 10:33:37.566: cannot open display:`, try running the command with `sudo -E`:
|
Run the client from a terminal in your normal desktop session and use an external browser:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo -E gpclient connect <portal>
|
sudo gpclient connect <portal> --browser
|
||||||
```
|
```
|
||||||
|
|
||||||
See related issue: [#316](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)
|
See related issue: [#316](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)
|
||||||
|
|
||||||
|
On a headless server, use `--browser remote` and complete authentication from another machine.
|
||||||
|
|
||||||
## NetworkManager Integration
|
## NetworkManager Integration
|
||||||
|
|
||||||
- [WMP/GlobalProtect-SAML-NetworkManager](https://github.com/WMP/GlobalProtect-SAML-NetworkManager) – NetworkManager VPN plugin with SAML/SSO support for GNOME and KDE Plasma
|
- [WMP/GlobalProtect-SAML-NetworkManager](https://github.com/WMP/GlobalProtect-SAML-NetworkManager) – NetworkManager VPN plugin with SAML/SSO support for GNOME and KDE Plasma
|
||||||
@@ -518,7 +549,7 @@ See related issue: [#316](https://github.com/yuezk/GlobalProtect-openconnect/iss
|
|||||||
### Trial and Pricing
|
### Trial and Pricing
|
||||||
|
|
||||||
The **CLI version** is completely free and open source.
|
The **CLI version** is completely free and open source.
|
||||||
The **GUI version** is a paid application with a **7-day trial period** after installation.
|
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
|
### Open Source Licenses
|
||||||
|
|
||||||
|
|||||||
@@ -451,6 +451,15 @@ impl ConnectHandler<'_> {
|
|||||||
.local_hostname(self.args.local_hostname.clone())
|
.local_hostname(self.args.local_hostname.clone())
|
||||||
.dpd_interval(self.args.dpd_interval.unwrap_or(0))
|
.dpd_interval(self.args.dpd_interval.unwrap_or(0))
|
||||||
.no_xmlpost(self.args.no_xmlpost);
|
.no_xmlpost(self.args.no_xmlpost);
|
||||||
|
#[cfg(target_os = "macos")]
|
||||||
|
let vpn_builder = if self.args.script.is_none()
|
||||||
|
&& std::env::var_os("GP_VPNC_SCRIPT").is_none_or(|value| value.is_empty())
|
||||||
|
&& let Some(script) = common::binary_paths::bundled_vpnc_script()
|
||||||
|
{
|
||||||
|
vpn_builder.script_path(script.to_string_lossy().into_owned())
|
||||||
|
} else {
|
||||||
|
vpn_builder
|
||||||
|
};
|
||||||
let vpn = apply_os_profile(vpn_builder, &os_profile)
|
let vpn = apply_os_profile(vpn_builder, &os_profile)
|
||||||
.build()
|
.build()
|
||||||
.map_err(|err| GatewayConnectError::before_establishment(err.into()))?;
|
.map_err(|err| GatewayConnectError::before_establishment(err.into()))?;
|
||||||
|
|||||||
@@ -1,5 +1,28 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 3.0.0
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- GP Connect for Apple silicon Macs running macOS 13 or later.
|
||||||
|
- Support for internal gateways that authenticate your device without creating a VPN tunnel.
|
||||||
|
- More control over device compliance reports (HIP), including generated reports and custom scripts.
|
||||||
|
- Desktop update notifications, with in-app updates on macOS and links to new releases on Linux and BSD.
|
||||||
|
- JSON log output for CLI integrations and automation.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Refreshed the desktop connection view, gateway selection, and session details.
|
||||||
|
- Improved browser sign-in, including opening your normal user's browser when the CLI runs with elevated privileges.
|
||||||
|
- Improved session expiry warnings and session extension when allowed by your VPN administrator.
|
||||||
|
- Updated license activation and recovery. Start the seven-day desktop trial by verifying your email address in the app.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Improved cancellation, disconnect, and cached sign-in handling.
|
||||||
|
- Improved desktop window and tray behavior across macOS, Linux, FreeBSD, and OpenBSD.
|
||||||
|
- Improved package installation and desktop integration on Linux and BSD.
|
||||||
|
|
||||||
## 2.6.5
|
## 2.6.5
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ use std::{
|
|||||||
};
|
};
|
||||||
|
|
||||||
use anyhow::{Context, bail};
|
use anyhow::{Context, bail};
|
||||||
use gpapi::auth::SamlAuthData;
|
use gpapi::{auth::SamlAuthData, error::AuthDataParseError};
|
||||||
use tokio::{
|
use tokio::{
|
||||||
io::{AsyncReadExt, AsyncWriteExt},
|
io::{AsyncReadExt, AsyncWriteExt},
|
||||||
net::{UnixListener, UnixStream},
|
net::{UnixListener, UnixStream},
|
||||||
@@ -27,6 +27,7 @@ const PROTOCOL_VERSION: u8 = 1;
|
|||||||
const MAX_CALLBACK_SIZE: usize = 1024 * 1024;
|
const MAX_CALLBACK_SIZE: usize = 1024 * 1024;
|
||||||
const IO_TIMEOUT: Duration = Duration::from_secs(5);
|
const IO_TIMEOUT: Duration = Duration::from_secs(5);
|
||||||
|
|
||||||
|
// Acceptance acknowledges delivery, including an authentication failure.
|
||||||
const STATUS_ACCEPTED: u8 = 0;
|
const STATUS_ACCEPTED: u8 = 0;
|
||||||
const STATUS_INVALID_CALLBACK: u8 = 1;
|
const STATUS_INVALID_CALLBACK: u8 = 1;
|
||||||
const STATUS_UNSUPPORTED_VERSION: u8 = 2;
|
const STATUS_UNSUPPORTED_VERSION: u8 = 2;
|
||||||
@@ -70,6 +71,10 @@ impl AuthCallbackReceiver {
|
|||||||
let _ = write_response(&mut stream, STATUS_ACCEPTED).await;
|
let _ = write_response(&mut stream, STATUS_ACCEPTED).await;
|
||||||
return Ok(auth_data);
|
return Ok(auth_data);
|
||||||
}
|
}
|
||||||
|
Err(error @ AuthDataParseError::AuthenticationFailed(_)) => {
|
||||||
|
let _ = write_response(&mut stream, STATUS_ACCEPTED).await;
|
||||||
|
return Err(error.into());
|
||||||
|
}
|
||||||
Err(_) => {
|
Err(_) => {
|
||||||
let _ = write_response(&mut stream, STATUS_INVALID_CALLBACK).await;
|
let _ = write_response(&mut stream, STATUS_INVALID_CALLBACK).await;
|
||||||
}
|
}
|
||||||
@@ -419,6 +424,24 @@ mod tests {
|
|||||||
assert!(!socket_path.exists());
|
assert!(!socket_path.exists());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn reports_authentication_failure_to_waiting_receiver() {
|
||||||
|
let directory = tempdir().unwrap();
|
||||||
|
let socket_path = directory.path().join("callback.sock");
|
||||||
|
let receiver = AuthCallbackReceiver::bind_at(socket_path.clone()).unwrap();
|
||||||
|
let failure = gpapi::utils::base64::encode(b"<html><saml-auth-status>0</saml-auth-status></html>");
|
||||||
|
let callback = format!("globalprotectcallback:{failure}");
|
||||||
|
let sender = tokio::spawn(async move { forward_auth_callback_to(&callback, &socket_path).await });
|
||||||
|
|
||||||
|
let error = timeout(Duration::from_millis(500), receiver.receive())
|
||||||
|
.await
|
||||||
|
.expect("Failure callback must finish the waiting authentication")
|
||||||
|
.unwrap_err();
|
||||||
|
|
||||||
|
assert!(error.to_string().contains("Authentication failed"));
|
||||||
|
sender.await.unwrap().expect("Failure callback was delivered");
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn rejects_bad_requests_and_keeps_waiting() {
|
async fn rejects_bad_requests_and_keeps_waiting() {
|
||||||
let directory = tempdir().unwrap();
|
let directory = tempdir().unwrap();
|
||||||
@@ -430,6 +453,10 @@ mod tests {
|
|||||||
send_raw_callback(&socket_path, PROTOCOL_VERSION, "https://example.com").await,
|
send_raw_callback(&socket_path, PROTOCOL_VERSION, "https://example.com").await,
|
||||||
STATUS_INVALID_CALLBACK
|
STATUS_INVALID_CALLBACK
|
||||||
);
|
);
|
||||||
|
assert_eq!(
|
||||||
|
send_raw_callback(&socket_path, PROTOCOL_VERSION, "globalprotectcallback:not-base64").await,
|
||||||
|
STATUS_INVALID_CALLBACK
|
||||||
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
send_raw_callback(&socket_path, PROTOCOL_VERSION + 1, VALID_CALLBACK).await,
|
send_raw_callback(&socket_path, PROTOCOL_VERSION + 1, VALID_CALLBACK).await,
|
||||||
STATUS_UNSUPPORTED_VERSION
|
STATUS_UNSUPPORTED_VERSION
|
||||||
|
|||||||
@@ -150,8 +150,8 @@ impl AuthMessenger {
|
|||||||
|
|
||||||
match auth_result {
|
match auth_result {
|
||||||
Ok(data) => self.send_auth_data(data, AuthDataLocation::Body),
|
Ok(data) => self.send_auth_data(data, AuthDataLocation::Body),
|
||||||
Err(AuthDataParseError::Invalid(err)) => self.send_auth_error(AuthError::invalid_from_body(err)),
|
|
||||||
Err(AuthDataParseError::NotFound) => self.send_auth_error(AuthError::not_found_in_body()),
|
Err(AuthDataParseError::NotFound) => self.send_auth_error(AuthError::not_found_in_body()),
|
||||||
|
Err(err) => self.send_auth_error(AuthError::invalid_from_body(err.into())),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,3 +6,6 @@ authors.workspace = true
|
|||||||
homepage.workspace = true
|
homepage.workspace = true
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
tempfile.workspace = true
|
||||||
@@ -3,6 +3,9 @@ use std::{
|
|||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
#[cfg(target_os = "macos")]
|
||||||
|
mod macos;
|
||||||
|
|
||||||
#[cfg(all(
|
#[cfg(all(
|
||||||
not(debug_assertions),
|
not(debug_assertions),
|
||||||
any(target_os = "linux", target_os = "freebsd", target_os = "openbsd")
|
any(target_os = "linux", target_os = "freebsd", target_os = "openbsd")
|
||||||
@@ -80,13 +83,18 @@ fn resolve(env_key: &str, binary_name: &str, default_path: &str) -> PathBuf {
|
|||||||
|
|
||||||
fn sibling_binary(binary_name: &str) -> Option<PathBuf> {
|
fn sibling_binary(binary_name: &str) -> Option<PathBuf> {
|
||||||
let current_exe = env::current_exe().ok()?;
|
let current_exe = env::current_exe().ok()?;
|
||||||
let bin_dir = current_exe.parent()?;
|
sibling_binary_for_executable(¤t_exe, binary_name)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn sibling_binary_for_executable(executable: &Path, binary_name: &str) -> Option<PathBuf> {
|
||||||
|
let executable = executable.canonicalize().ok()?;
|
||||||
|
let bin_dir = executable.parent()?;
|
||||||
let binary = bin_dir.join(binary_name);
|
let binary = bin_dir.join(binary_name);
|
||||||
if is_file(&binary) {
|
if is_file(&binary) {
|
||||||
return Some(binary);
|
return Some(binary);
|
||||||
}
|
}
|
||||||
#[cfg(target_os = "macos")]
|
#[cfg(target_os = "macos")]
|
||||||
if let Some(binary) = bundled_helper_path(¤t_exe, binary_name)
|
if let Some(binary) = macos::helper_path(&executable, binary_name)
|
||||||
&& is_file(&binary)
|
&& is_file(&binary)
|
||||||
{
|
{
|
||||||
return Some(binary);
|
return Some(binary);
|
||||||
@@ -95,14 +103,14 @@ fn sibling_binary(binary_name: &str) -> Option<PathBuf> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(target_os = "macos")]
|
#[cfg(target_os = "macos")]
|
||||||
fn bundled_helper_path(executable: &Path, binary_name: &str) -> Option<PathBuf> {
|
pub fn bundled_vpnc_script() -> Option<PathBuf> {
|
||||||
let bin_dir = executable.parent()?;
|
bundled_vpnc_script_for_executable(&env::current_exe().ok()?)
|
||||||
let contents = bin_dir.parent()?;
|
}
|
||||||
let bundle = contents.parent()?;
|
|
||||||
if bin_dir.file_name()? != "MacOS" || contents.file_name()? != "Contents" || bundle.extension()? != "app" {
|
#[cfg(target_os = "macos")]
|
||||||
return None;
|
fn bundled_vpnc_script_for_executable(executable: &Path) -> Option<PathBuf> {
|
||||||
}
|
let executable = executable.canonicalize().ok()?;
|
||||||
Some(contents.join("Helpers").join(binary_name))
|
macos::vpnc_script_path(&executable)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_file(path: &Path) -> bool {
|
fn is_file(path: &Path) -> bool {
|
||||||
@@ -117,14 +125,44 @@ mod tests {
|
|||||||
#[cfg(target_os = "macos")]
|
#[cfg(target_os = "macos")]
|
||||||
fn desktop_resolves_helpers_in_the_actual_app_bundle_layout() {
|
fn desktop_resolves_helpers_in_the_actual_app_bundle_layout() {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
bundled_helper_path(
|
macos::helper_path(
|
||||||
Path::new("/Applications/GP Connect.app/Contents/MacOS/gpgui"),
|
Path::new("/Applications/GP Connect.app/Contents/MacOS/gpgui"),
|
||||||
"gpclient"
|
"gpclient"
|
||||||
),
|
),
|
||||||
Some(PathBuf::from("/Applications/GP Connect.app/Contents/Helpers/gpclient"))
|
Some(PathBuf::from("/Applications/GP Connect.app/Contents/Helpers/gpclient"))
|
||||||
);
|
);
|
||||||
assert!(bundled_helper_path(Path::new("/usr/local/bin/gpgui"), "gpclient").is_none());
|
assert!(macos::helper_path(Path::new("/usr/local/bin/gpgui"), "gpclient").is_none());
|
||||||
assert!(bundled_helper_path(Path::new("/tmp/Contents/MacOS/gpgui"), "gpclient").is_none());
|
assert!(macos::helper_path(Path::new("/tmp/Contents/MacOS/gpgui"), "gpclient").is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg(unix)]
|
||||||
|
fn symlinked_executable_resolves_its_bundle_paths() {
|
||||||
|
let directory = tempfile::tempdir().unwrap();
|
||||||
|
let helpers = directory.path().join("GP Connect.app/Contents/Helpers");
|
||||||
|
let bin = directory.path().join("bin");
|
||||||
|
std::fs::create_dir_all(&helpers).unwrap();
|
||||||
|
std::fs::create_dir_all(&bin).unwrap();
|
||||||
|
std::fs::write(helpers.join("gpclient"), "").unwrap();
|
||||||
|
std::fs::write(helpers.join("gpauth"), "").unwrap();
|
||||||
|
std::os::unix::fs::symlink(helpers.join("gpclient"), bin.join("gpclient")).unwrap();
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
sibling_binary_for_executable(&bin.join("gpclient"), "gpauth"),
|
||||||
|
Some(helpers.canonicalize().unwrap().join("gpauth"))
|
||||||
|
);
|
||||||
|
#[cfg(target_os = "macos")]
|
||||||
|
assert_eq!(
|
||||||
|
bundled_vpnc_script_for_executable(&bin.join("gpclient")),
|
||||||
|
Some(
|
||||||
|
helpers
|
||||||
|
.canonicalize()
|
||||||
|
.unwrap()
|
||||||
|
.parent()
|
||||||
|
.unwrap()
|
||||||
|
.join("Resources/Scripts/vpnc-script")
|
||||||
|
)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
|
fn contents_dir(executable: &Path) -> Option<&Path> {
|
||||||
|
let bin_dir = executable.parent()?;
|
||||||
|
let contents = bin_dir.parent()?;
|
||||||
|
let bundle = contents.parent()?;
|
||||||
|
let directory_name = bin_dir.file_name()?;
|
||||||
|
if (directory_name != "MacOS" && directory_name != "Helpers")
|
||||||
|
|| contents.file_name()? != "Contents"
|
||||||
|
|| bundle.extension()? != "app"
|
||||||
|
{
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
Some(contents)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(super) fn helper_path(executable: &Path, binary_name: &str) -> Option<PathBuf> {
|
||||||
|
Some(contents_dir(executable)?.join("Helpers").join(binary_name))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(super) fn vpnc_script_path(executable: &Path) -> Option<PathBuf> {
|
||||||
|
Some(contents_dir(executable)?.join("Resources/Scripts/vpnc-script"))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn bundle_entry_points_use_their_own_vpnc_script() {
|
||||||
|
for executable in [
|
||||||
|
"/Applications/GP Connect.app/Contents/Helpers/gpclient",
|
||||||
|
"/Applications/GP Connect.app/Contents/MacOS/gpgui",
|
||||||
|
] {
|
||||||
|
assert_eq!(
|
||||||
|
vpnc_script_path(Path::new(executable)),
|
||||||
|
Some(PathBuf::from(
|
||||||
|
"/Applications/GP Connect.app/Contents/Resources/Scripts/vpnc-script"
|
||||||
|
))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
assert!(vpnc_script_path(Path::new("/opt/homebrew/bin/gpclient")).is_none());
|
||||||
|
assert!(vpnc_script_path(Path::new("/tmp/Contents/Helpers/gpclient")).is_none());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -130,10 +130,7 @@ impl SamlAuthData {
|
|||||||
|
|
||||||
Ok(auth_data)
|
Ok(auth_data)
|
||||||
}
|
}
|
||||||
Some(status) => Err(AuthDataParseError::Invalid(anyhow::anyhow!(
|
Some(status) => Err(AuthDataParseError::AuthenticationFailed(status)),
|
||||||
"SAML auth status: {}",
|
|
||||||
status
|
|
||||||
))),
|
|
||||||
None => Err(AuthDataParseError::NotFound),
|
None => Err(AuthDataParseError::NotFound),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -29,12 +29,17 @@ impl PortalError {
|
|||||||
pub enum AuthDataParseError {
|
pub enum AuthDataParseError {
|
||||||
#[error("No auth data found")]
|
#[error("No auth data found")]
|
||||||
NotFound,
|
NotFound,
|
||||||
|
#[error("Authentication failed (SAML status: {0})")]
|
||||||
|
AuthenticationFailed(String),
|
||||||
#[error(transparent)]
|
#[error(transparent)]
|
||||||
Invalid(#[from] anyhow::Error),
|
Invalid(#[from] anyhow::Error),
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AuthDataParseError {
|
impl AuthDataParseError {
|
||||||
pub fn is_invalid(&self) -> bool {
|
pub fn is_invalid(&self) -> bool {
|
||||||
matches!(self, AuthDataParseError::Invalid(_))
|
matches!(
|
||||||
|
self,
|
||||||
|
AuthDataParseError::Invalid(_) | AuthDataParseError::AuthenticationFailed(_)
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -203,12 +203,20 @@ mod tests {
|
|||||||
let log_file = dir.path().join("desktop.log");
|
let log_file = dir.path().join("desktop.log");
|
||||||
fs::write(&log_file, "[gpservice] started\n").unwrap();
|
fs::write(&log_file, "[gpservice] started\n").unwrap();
|
||||||
let program = dir.path().join("gui");
|
let program = dir.path().join("gui");
|
||||||
fs::write(&program, "#!/bin/sh\nprintf '[gpgui] initialized\\n' >&2\n").unwrap();
|
|
||||||
fs::set_permissions(&program, fs::Permissions::from_mode(0o755)).unwrap();
|
|
||||||
let launcher = launcher(VERSION, vec![]).envs(HashMap::from([(
|
let launcher = launcher(VERSION, vec![]).envs(HashMap::from([(
|
||||||
"GP_LOG_FILE".to_owned(),
|
"GP_LOG_FILE".to_owned(),
|
||||||
log_file.to_str().unwrap().to_owned(),
|
log_file.to_str().unwrap().to_owned(),
|
||||||
)]));
|
)]));
|
||||||
|
let frame_len = launcher.credential.encode_frame().unwrap().len();
|
||||||
|
// Consume the credential frame like the real GUI before exiting.
|
||||||
|
fs::write(
|
||||||
|
&program,
|
||||||
|
format!(
|
||||||
|
"#!/bin/sh\ndd bs=1 count={frame_len} of=/dev/null 2>/dev/null || exit 1\nprintf '[gpgui] initialized\\n' >&2\n"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
fs::set_permissions(&program, fs::Permissions::from_mode(0o755)).unwrap();
|
||||||
|
|
||||||
assert!(launcher.launch_program(&program).await.unwrap().success());
|
assert!(launcher.launch_program(&program).await.unwrap().success());
|
||||||
assert!(launcher.launch_program(&program).await.unwrap().success());
|
assert!(launcher.launch_program(&program).await.unwrap().success());
|
||||||
|
|||||||
@@ -29,8 +29,8 @@
|
|||||||
cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);
|
cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);
|
||||||
pname = "globalprotect-openconnect";
|
pname = "globalprotect-openconnect";
|
||||||
version = cargoToml.workspace.package.version;
|
version = cargoToml.workspace.package.version;
|
||||||
releaseTag = "snapshot";
|
releaseTag = "v3.0.0";
|
||||||
releaseVersion = "2.6.5";
|
releaseVersion = "3.0.0";
|
||||||
|
|
||||||
toolchain = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
|
toolchain = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
|
||||||
|
|
||||||
@@ -55,8 +55,8 @@
|
|||||||
cpu = pkgs.stdenv.hostPlatform.parsed.cpu.name;
|
cpu = pkgs.stdenv.hostPlatform.parsed.cpu.name;
|
||||||
|
|
||||||
gpguiHashes = {
|
gpguiHashes = {
|
||||||
x86_64 = "sha256-TLL2Ay9PqiWWvWuK6tP9b+gYCNFwplmt6qQeBzIcsUQ=";
|
x86_64 = "sha256-MdY+50LtG/AmJEcJdXbXFcvyl0R4jQMOmJfQ6rlAd6c=";
|
||||||
aarch64 = "sha256-3VTpjm3tbjn5aZtbTxNicuXTUNjbM+f/yAzMj3F3O9o=";
|
aarch64 = "sha256-a8/YtYQct6/UUjbNVDN/54fHxdnRFhKahprBLyVz0xk=";
|
||||||
};
|
};
|
||||||
|
|
||||||
gpguiArchive = pkgs.fetchurl {
|
gpguiArchive = pkgs.fetchurl {
|
||||||
@@ -70,8 +70,8 @@
|
|||||||
};
|
};
|
||||||
|
|
||||||
binaryHashes = {
|
binaryHashes = {
|
||||||
x86_64 = "sha256-OHwmUKM7oEilyZJP2Fw15For1xrG2q0QnuSUrnwymJ4=";
|
x86_64 = "sha256-/PsNsK2IY/qnsVQVF3o8EFnBRP9LpjxZm7e09d8/Xig=";
|
||||||
aarch64 = "sha256-GDXwaOwtZjjy3VPNrNj4pixlPgkknYn875kIzpVpDyM=";
|
aarch64 = "sha256-W51Ek28cA0mnE3G4d7DqhDAtvqmq17QQ+i155dxarUw=";
|
||||||
};
|
};
|
||||||
|
|
||||||
binaryArchive = pkgs.fetchurl {
|
binaryArchive = pkgs.fetchurl {
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
This image provides the GlobalProtect-openconnect command-line tools on Alpine Linux. It includes:
|
This image provides the GlobalProtect-openconnect command-line tools on Alpine Linux. It includes:
|
||||||
|
|
||||||
- `gpclient` - connect to and disconnect from GlobalProtect VPN portals and gateways
|
- `gpclient` - connect to and disconnect from GlobalProtect VPN portals and gateways
|
||||||
- `gpauth` - complete authentication separately and pipe the result into `gpclient`
|
- `gpauth` - authentication helper used by `gpclient`
|
||||||
|
|
||||||
The image does not include embedded webview authentication, `gpgui-helper`, or the graphical `gpgui` application.
|
The image does not include embedded webview authentication, `gpgui-helper`, or the graphical `gpgui` application.
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ VPN tunnel creation requires access to `/dev/net/tun` and the `NET_ADMIN` capabi
|
|||||||
```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:<version> \
|
||||||
connect <portal> --cookie-on-stdin
|
connect <portal>
|
||||||
```
|
```
|
||||||
|
|
||||||
For browser authentication in a headless environment, use remote browser authentication:
|
For browser authentication in a headless environment, use remote browser authentication:
|
||||||
@@ -43,16 +43,6 @@ docker run --rm -it --network host --cap-add=NET_ADMIN --device=/dev/net/tun \
|
|||||||
|
|
||||||
Without `--network host`, the VPN connection stays inside the container 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.
|
Without `--network host`, the VPN connection stays inside the container 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.
|
||||||
|
|
||||||
You can also run `gpauth` separately and pipe its remote-browser output into `gpclient`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run --rm -it --entrypoint gpauth yuezk/globalprotect-openconnect:<version> \
|
|
||||||
<portal> --browser remote 2>/dev/null \
|
|
||||||
| docker run --rm -i --cap-add=NET_ADMIN --device=/dev/net/tun \
|
|
||||||
yuezk/globalprotect-openconnect:<version> \
|
|
||||||
connect <portal> --cookie-on-stdin
|
|
||||||
```
|
|
||||||
|
|
||||||
## Common commands
|
## Common commands
|
||||||
|
|
||||||
Show top-level help:
|
Show top-level help:
|
||||||
|
|||||||
@@ -143,7 +143,8 @@ release_snapshot() {
|
|||||||
snapshot_commit="$(git -C "$SCRIPT_DIR/.." rev-parse HEAD)"
|
snapshot_commit="$(git -C "$SCRIPT_DIR/.." rev-parse HEAD)"
|
||||||
if ! gh -R "$REPO" release view "$TAG" >/dev/null 2>&1; then
|
if ! gh -R "$REPO" release view "$TAG" >/dev/null 2>&1; then
|
||||||
gh -R "$REPO" release create "$TAG" \
|
gh -R "$REPO" release create "$TAG" \
|
||||||
--prerelease \
|
--prerelease=false \
|
||||||
|
--latest=false \
|
||||||
--target "$snapshot_commit" \
|
--target "$snapshot_commit" \
|
||||||
--title "Snapshot" \
|
--title "Snapshot" \
|
||||||
--notes "Rolling snapshot release from trusted CI builds."
|
--notes "Rolling snapshot release from trusted CI builds."
|
||||||
@@ -186,7 +187,7 @@ release_snapshot() {
|
|||||||
|
|
||||||
gh api --method PATCH "repos/$REPO/git/refs/tags/$TAG" \
|
gh api --method PATCH "repos/$REPO/git/refs/tags/$TAG" \
|
||||||
-f sha="$snapshot_commit" -F force=true >/dev/null
|
-f sha="$snapshot_commit" -F force=true >/dev/null
|
||||||
gh -R "$REPO" release edit "$TAG" --prerelease --title "Snapshot"
|
gh -R "$REPO" release edit "$TAG" --prerelease=false --latest=false --title "Snapshot"
|
||||||
}
|
}
|
||||||
|
|
||||||
release_tag() {
|
release_tag() {
|
||||||
@@ -199,12 +200,14 @@ release_tag() {
|
|||||||
# Upload source tarballs, GUI components, and BSD packages. Other Linux
|
# Upload source tarballs, GUI components, and BSD packages. Other Linux
|
||||||
# packages are built in `release.yml` from the standalone source tarball.
|
# packages are built in `release.yml` from the standalone source tarball.
|
||||||
gh -R "$REPO" release create "$TAG" \
|
gh -R "$REPO" release create "$TAG" \
|
||||||
|
--prerelease=false \
|
||||||
--title "$TAG" \
|
--title "$TAG" \
|
||||||
--notes-file "$release_notes_file"
|
--notes-file "$release_notes_file"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
mapfile -t files < <(release_assets)
|
mapfile -t files < <(release_assets)
|
||||||
GITHUB_REPOSITORY="$REPO" "$SCRIPT_DIR/upload-release-assets.sh" "$TAG" "${files[@]}"
|
GITHUB_REPOSITORY="$REPO" "$SCRIPT_DIR/upload-release-assets.sh" "$TAG" "${files[@]}"
|
||||||
|
gh -R "$REPO" release edit "$TAG" --prerelease=false
|
||||||
}
|
}
|
||||||
|
|
||||||
if [[ $TAG == *"snapshot" ]]; then
|
if [[ $TAG == *"snapshot" ]]; then
|
||||||
|
|||||||
Reference in new issue
Block a user