From 86c8d188c42dd5f247ec8ddc1a94adb1cc594d7d Mon Sep 17 00:00:00 2001 From: Kevin Yue Date: Mon, 19 Oct 2026 23:26:38 +0800 Subject: [PATCH] feat: add connection dashboard and improve desktop authentication Add tunnel configuration reporting, an optional CLI dashboard, manual browser authentication, native authentication controls, and broader client identity support. Improve TLS recovery, certificate validation, desktop notifications, and platform integration. --- .github/workflows/build.yaml | 3 - .github/workflows/publish-aur-git.yaml | 17 +- Cargo.lock | 651 +++++++-- Cargo.toml | 8 +- README.md | 21 +- apps/gpauth/src/cli.rs | 96 +- apps/gpauth/src/webview_auth.rs | 10 +- apps/gpclient/Cargo.toml | 9 +- apps/gpclient/src/cli.rs | 89 +- apps/gpclient/src/connect/args.rs | 13 +- apps/gpclient/src/connect/credential.rs | 4 +- apps/gpclient/src/connect/flow_tests.rs | 7 + apps/gpclient/src/connect/gateway.rs | 45 +- apps/gpclient/src/connect/internal.rs | 68 +- apps/gpclient/src/connect/mod.rs | 16 +- .../src/connect/vpn_script/default.rs | 9 + apps/gpclient/src/connect/vpn_script/macos.rs | 86 ++ apps/gpclient/src/connect/vpn_script/mod.rs | 8 + apps/gpclient/src/dashboard/layout.rs | 625 +++++++++ apps/gpclient/src/dashboard/mod.rs | 212 +++ apps/gpclient/src/dashboard/notice.rs | 93 ++ apps/gpclient/src/dashboard/output.rs | 338 +++++ apps/gpclient/src/dashboard/restoration.rs | 71 + apps/gpclient/src/dashboard/screen.rs | 359 +++++ apps/gpclient/src/dashboard/tests.rs | 456 +++++++ apps/gpclient/src/main.rs | 1 + apps/gpclient/src/session.rs | 2 + apps/gpclient/tests/diagnostics.rs | 8 +- .../tests/fixtures/dashboard_abort.rs | 33 + apps/gpgui-helper/src-tauri/src/updater.rs | 3 +- apps/gpservice/Cargo.toml | 5 +- apps/gpservice/src/cli.rs | 12 +- apps/gpservice/src/hip_approval.rs | 6 +- apps/gpservice/src/request_dispatcher.rs | 77 +- apps/gpservice/src/vpn_script/macos.rs | 14 + apps/gpservice/src/vpn_script/mod.rs | 10 +- apps/gpservice/src/vpn_task.rs | 94 +- apps/gpservice/src/vpn_task/runtime.rs | 13 + apps/gpservice/src/ws_connection.rs | 88 +- apps/gpservice/src/ws_server.rs | 389 +++++- changelog.md | 13 + crates/auth/Cargo.toml | 28 + crates/auth/src/browser/browser_auth.rs | 34 +- crates/auth/src/webview.rs | 3 + crates/auth/src/webview/address_bar.rs | 54 + crates/auth/src/webview/auth_messenger.rs | 101 +- crates/auth/src/webview/gtk.rs | 299 ++++- crates/auth/src/webview/gtk_recovery.rs | 103 ++ crates/auth/src/webview/gtk_tls.rs | 180 +++ crates/auth/src/webview/macos.rs | 313 ++++- crates/auth/src/webview/macos/address_bar.rs | 240 ++++ crates/auth/src/webview/macos/recovery_row.rs | 332 +++++ crates/auth/src/webview/macos/tls.rs | 228 ++++ crates/auth/src/webview/recovery.rs | 298 +++++ crates/auth/src/webview/tls.rs | 47 + crates/auth/src/webview/webview_auth.rs | 312 +++-- crates/common/src/binary_paths.rs | 23 - crates/common/src/binary_paths/macos.rs | 26 - crates/gpapi/Cargo.toml | 15 +- crates/gpapi/src/auth.rs | 3 + crates/gpapi/src/clap/mod.rs | 56 +- crates/gpapi/src/credential.rs | 1 + crates/gpapi/src/error.rs | 17 +- crates/gpapi/src/error/server_tls.rs | 515 +++++++ crates/gpapi/src/error/server_tls/macos.rs | 9 + crates/gpapi/src/error/server_tls/openssl.rs | 17 + crates/gpapi/src/gateway/login.rs | 8 +- crates/gpapi/src/portal/config.rs | 20 +- crates/gpapi/src/portal/prelogin.rs | 9 +- crates/gpapi/src/process/auth_launcher.rs | 61 +- crates/gpapi/src/service/event.rs | 1 + crates/gpapi/src/service/request.rs | 1 + crates/gpapi/src/service/transport/message.rs | 73 + crates/gpapi/src/service/vpn_env.rs | 1 + crates/gpapi/src/session.rs | 1 + crates/gpapi/src/session/network/mod.rs | 2 +- crates/gpapi/src/session/transport.rs | 4 +- crates/gpapi/src/session/tunnel.rs | 353 +++++ crates/gpapi/src/utils/checksum.rs | 79 +- crates/gpapi/src/utils/identity_encoding.rs | 219 +++ crates/gpapi/src/utils/legacy_pkcs8.rs | 165 +++ crates/gpapi/src/utils/mod.rs | 40 +- .../gpapi/src/utils/pkcs12_identity/macos.rs | 24 + .../src/utils/pkcs12_identity/openssl.rs | 14 + crates/gpapi/src/utils/redact.rs | 94 +- crates/gpapi/src/utils/request.rs | 385 ++---- .../gpapi/src/utils/traditional_key/macos.rs | 17 + .../src/utils/traditional_key/openssl.rs | 49 + crates/gpapi/tests/client_identity.rs | 708 ++++++++++ .../tests/files/client-identity/README.md | 61 + .../client-identity/certificate-only.pfx | Bin 0 -> 1083 bytes .../tests/files/client-identity/ec-cert.pem | 14 + .../tests/files/client-identity/ec-pbes2.pem | 8 + .../tests/files/client-identity/ec-pkcs8.pem | 5 + .../tests/files/client-identity/ec-sec1.pem | 5 + .../client-identity/ec-traditional-aes128.pem | 8 + .../client-identity/ec-traditional-aes192.pem | 8 + .../client-identity/ec-traditional-aes256.pem | 8 + .../client-identity/ec-traditional-des3.pem | 8 + .../files/client-identity/empty-password.p12 | Bin 0 -> 3418 bytes .../tests/files/client-identity/generate.sh | 77 ++ .../tests/files/client-identity/key-only.pfx | Bin 0 -> 1527 bytes .../files/client-identity/legacy-rc2.p12 | Bin 0 -> 3260 bytes .../tests/files/client-identity/modern.p12 | Bin 0 -> 3418 bytes .../tests/files/client-identity/root.pem | 19 + .../tests/files/client-identity/rsa-cert.pem | 18 + .../rsa-pbes1-3des-password-1023.pem | 29 + .../rsa-pbes1-3des-password-1024.pem | 29 + .../files/client-identity/rsa-pbes1-3des.pem | 29 + .../rsa-pbes2-aes-128-cbc-sha1.pem | 30 + .../rsa-pbes2-aes-128-cbc-sha256.pem | 30 + .../rsa-pbes2-aes-192-cbc-sha1.pem | 30 + .../rsa-pbes2-aes-192-cbc-sha256.pem | 30 + .../files/client-identity/rsa-pbes2-des.pem | 30 + .../client-identity/rsa-pbes2-des3-sha1.pem | 30 + .../client-identity/rsa-pbes2-des3-sha256.pem | 30 + .../client-identity/rsa-pbes2-scrypt.pem | 30 + .../files/client-identity/rsa-pbes2-sha1.pem | 30 + .../client-identity/rsa-pbes2-sha256.pem | 30 + .../tests/files/client-identity/rsa-pkcs1.pem | 27 + .../tests/files/client-identity/rsa-pkcs8.pem | 28 + .../rsa-traditional-aes128.pem | 30 + .../rsa-traditional-aes192.pem | 30 + .../rsa-traditional-aes256.pem | 30 + .../client-identity/rsa-traditional-des3.pem | 30 + .../client-identity/unicode-password.p12 | Bin 0 -> 2119 bytes crates/gpapi/tests/identity_encoding.rs | 274 ++++ crates/gptunnel/Cargo.toml | 17 + crates/gptunnel/src/configuration.rs | 217 +++ crates/gptunnel/src/lib.rs | 6 + crates/gptunnel/src/monitor.rs | 637 +++++++++ crates/gpvpnc/Cargo.toml | 9 + crates/gpvpnc/src/lib.rs | 2 + crates/gpvpnc/src/macos-vpnc-script.sh | 1183 +++++++++++++++++ crates/gpvpnc/src/macos.rs | 231 ++++ crates/openconnect/build.rs | 17 +- crates/openconnect/deps/openconnect | 2 +- crates/openconnect/src/ffi/mod.rs | 14 + .../src/ffi/network_configuration.rs | 177 +++ crates/openconnect/src/ffi/tunnel.rs | 355 +++++ crates/openconnect/src/ffi/vpn.c | 51 +- crates/openconnect/src/ffi/vpn.h | 10 + crates/openconnect/src/lib.rs | 3 + .../openconnect/src/network_configuration.rs | 12 + crates/openconnect/src/tunnel.rs | 57 + crates/openconnect/src/vpn.rs | 206 ++- crates/openconnect/tests/esp_gateway.c | 202 +++ crates/openconnect/tests/esp_gateway.rs | 60 + crates/openconnect/tests/hip_protocol.rs | 6 +- .../openconnect/tests/network_configuration.c | 203 +++ .../tests/network_configuration.rs | 49 + crates/openconnect/tests/tls_backend.c | 154 +++ crates/openconnect/tests/tls_backend.rs | 90 ++ flake.nix | 21 +- nix/ci.nix | 15 +- .../globalprotect-openconnect-git/.SRCINFO | 18 +- .../globalprotect-openconnect-git/PKGBUILD | 4 +- packaging/docker/README.md | 6 +- 158 files changed, 13735 insertions(+), 1038 deletions(-) create mode 100644 apps/gpclient/src/connect/vpn_script/default.rs create mode 100644 apps/gpclient/src/connect/vpn_script/macos.rs create mode 100644 apps/gpclient/src/connect/vpn_script/mod.rs create mode 100644 apps/gpclient/src/dashboard/layout.rs create mode 100644 apps/gpclient/src/dashboard/mod.rs create mode 100644 apps/gpclient/src/dashboard/notice.rs create mode 100644 apps/gpclient/src/dashboard/output.rs create mode 100644 apps/gpclient/src/dashboard/restoration.rs create mode 100644 apps/gpclient/src/dashboard/screen.rs create mode 100644 apps/gpclient/src/dashboard/tests.rs create mode 100644 apps/gpclient/tests/fixtures/dashboard_abort.rs create mode 100644 apps/gpservice/src/vpn_script/macos.rs create mode 100644 crates/auth/src/webview/address_bar.rs create mode 100644 crates/auth/src/webview/gtk_recovery.rs create mode 100644 crates/auth/src/webview/gtk_tls.rs create mode 100644 crates/auth/src/webview/macos/address_bar.rs create mode 100644 crates/auth/src/webview/macos/recovery_row.rs create mode 100644 crates/auth/src/webview/macos/tls.rs create mode 100644 crates/auth/src/webview/recovery.rs create mode 100644 crates/auth/src/webview/tls.rs create mode 100644 crates/gpapi/src/error/server_tls.rs create mode 100644 crates/gpapi/src/error/server_tls/macos.rs create mode 100644 crates/gpapi/src/error/server_tls/openssl.rs create mode 100644 crates/gpapi/src/session/tunnel.rs create mode 100644 crates/gpapi/src/utils/identity_encoding.rs create mode 100644 crates/gpapi/src/utils/legacy_pkcs8.rs create mode 100644 crates/gpapi/src/utils/pkcs12_identity/macos.rs create mode 100644 crates/gpapi/src/utils/pkcs12_identity/openssl.rs create mode 100644 crates/gpapi/src/utils/traditional_key/macos.rs create mode 100644 crates/gpapi/src/utils/traditional_key/openssl.rs create mode 100644 crates/gpapi/tests/client_identity.rs create mode 100644 crates/gpapi/tests/files/client-identity/README.md create mode 100644 crates/gpapi/tests/files/client-identity/certificate-only.pfx create mode 100644 crates/gpapi/tests/files/client-identity/ec-cert.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-pbes2.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-pkcs8.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-sec1.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-traditional-aes128.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-traditional-aes192.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-traditional-aes256.pem create mode 100644 crates/gpapi/tests/files/client-identity/ec-traditional-des3.pem create mode 100644 crates/gpapi/tests/files/client-identity/empty-password.p12 create mode 100644 crates/gpapi/tests/files/client-identity/generate.sh create mode 100644 crates/gpapi/tests/files/client-identity/key-only.pfx create mode 100644 crates/gpapi/tests/files/client-identity/legacy-rc2.p12 create mode 100644 crates/gpapi/tests/files/client-identity/modern.p12 create mode 100644 crates/gpapi/tests/files/client-identity/root.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-cert.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1023.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1024.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes1-3des.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha1.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha256.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha1.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha256.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-des.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha1.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha256.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-scrypt.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-sha1.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pbes2-sha256.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pkcs1.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-pkcs8.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-traditional-aes128.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-traditional-aes192.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-traditional-aes256.pem create mode 100644 crates/gpapi/tests/files/client-identity/rsa-traditional-des3.pem create mode 100644 crates/gpapi/tests/files/client-identity/unicode-password.p12 create mode 100644 crates/gpapi/tests/identity_encoding.rs create mode 100644 crates/gptunnel/Cargo.toml create mode 100644 crates/gptunnel/src/configuration.rs create mode 100644 crates/gptunnel/src/lib.rs create mode 100644 crates/gptunnel/src/monitor.rs create mode 100644 crates/gpvpnc/Cargo.toml create mode 100644 crates/gpvpnc/src/lib.rs create mode 100644 crates/gpvpnc/src/macos-vpnc-script.sh create mode 100644 crates/gpvpnc/src/macos.rs create mode 100644 crates/openconnect/src/ffi/network_configuration.rs create mode 100644 crates/openconnect/src/ffi/tunnel.rs create mode 100644 crates/openconnect/src/network_configuration.rs create mode 100644 crates/openconnect/src/tunnel.rs create mode 100644 crates/openconnect/tests/esp_gateway.c create mode 100644 crates/openconnect/tests/esp_gateway.rs create mode 100644 crates/openconnect/tests/network_configuration.c create mode 100644 crates/openconnect/tests/network_configuration.rs create mode 100644 crates/openconnect/tests/tls_backend.c create mode 100644 crates/openconnect/tests/tls_backend.rs diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 30c529a..b605e94 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -44,9 +44,6 @@ on: - .devcontainer branches: - main - - hotfix/* - - feature/* - - release/* tags: - v*.*.* diff --git a/.github/workflows/publish-aur-git.yaml b/.github/workflows/publish-aur-git.yaml index 79b823a..9699a30 100644 --- a/.github/workflows/publish-aur-git.yaml +++ b/.github/workflows/publish-aur-git.yaml @@ -44,23 +44,34 @@ jobs: run: | pacman -Syu --noconfirm --needed \ appmenu-gtk-module \ + autoconf \ + automake \ cargo \ curl \ desktop-file-utils \ file \ git \ + gettext \ + gmp \ + gnutls \ libappindicator-gtk3 \ + libp11-kit \ libsecret \ + libtool \ libxml2 \ + lz4 \ + make \ namcap \ - openconnect \ + nettle \ openssl \ + patch \ pkgconf \ librsvg \ shared-mime-info \ - vpnc \ wget \ - webkit2gtk-4.1 + webkit2gtk-4.1 \ + xdg-utils \ + zlib - name: Save committed .SRCINFO if: ${{ github.event_name == 'push' }} diff --git a/Cargo.lock b/Cargo.lock index 7ab8ed6..069260b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -34,6 +34,31 @@ dependencies = [ "inout 0.2.2", ] +[[package]] +name = "aes" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35f0f96ce78e38c3dc6d8948aa8163d06385be74000f3c7a95bf1eef35d3ea32" +dependencies = [ + "cipher 0.5.2", + "cpubits", + "cpufeatures 0.3.1", +] + +[[package]] +name = "aes-gcm" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f2b8006a0c83f52b62ba44a97b58bf76fe2f70a329e588f67f89691d93d498f" +dependencies = [ + "aead 0.6.1", + "aes", + "cipher 0.5.2", + "ctr", + "ctutils", + "ghash", +] + [[package]] name = "aho-corasick" version = "1.1.5" @@ -58,6 +83,12 @@ dependencies = [ "alloc-no-stdlib", ] +[[package]] +name = "allocator-api2" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923" + [[package]] name = "android_system_properties" version = "0.1.6" @@ -123,6 +154,15 @@ version = "1.0.104" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "330a5ed07fa54e4702c9d6c4174f74427fc0ef6e214bbd677ae50a5099946470" +[[package]] +name = "approx" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cab112f0a86d568ea0e627cc1d6be74a1e9cd55214684db5561995f6dad897c6" +dependencies = [ + "num-traits", +] + [[package]] name = "ascii" version = "1.1.0" @@ -182,17 +222,6 @@ dependencies = [ "winnow 1.0.4", ] -[[package]] -name = "async-trait" -version = "0.1.92" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" -dependencies = [ - "proc-macro2", - "quote", - "syn 3.0.9", -] - [[package]] name = "atk" version = "0.18.2" @@ -224,17 +253,19 @@ checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" [[package]] name = "auth" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "block2", "browser-launcher", "gpapi", + "gtk", "html-escape", "log", "objc2", "objc2-app-kit", "objc2-foundation", + "objc2-security", "objc2-web-kit", "regex", "tauri", @@ -242,6 +273,7 @@ dependencies = [ "tiny_http", "tokio", "tokio-util", + "url", "uuid", "uzers", "webkit2gtk", @@ -329,6 +361,12 @@ version = "0.23.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5" +[[package]] +name = "base64ct" +version = "1.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2af50177e190e07a26ab74f8b1efbfe2ef87da2116221318cb1c2e82baf7de06" + [[package]] name = "basic-toml" version = "0.1.10" @@ -405,6 +443,15 @@ dependencies = [ "hybrid-array", ] +[[package]] +name = "block-padding" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "710f1dd022ef4e93f8a438b4ba958de7f64308434fa6a87104481645cc30068b" +dependencies = [ + "hybrid-array", +] + [[package]] name = "block2" version = "0.6.2" @@ -461,7 +508,7 @@ dependencies = [ [[package]] name = "browser-launcher" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "log", @@ -485,6 +532,12 @@ version = "3.20.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" +[[package]] +name = "by_address" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64fa3c856b712db6612c019f14756e64e4bcea13337a6b33b696333a9eaa2d06" + [[package]] name = "bytemuck" version = "1.25.2" @@ -574,6 +627,24 @@ dependencies = [ "toml 1.1.8+spec-1.1.0", ] +[[package]] +name = "castaway" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dec551ab6e7578819132c713a93c022a05d60159dc86e7a7050223577484c55a" +dependencies = [ + "rustversion", +] + +[[package]] +name = "cbc" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce2dc9ee5f88d11e0beb842c88b33c8a5cf0d1329c4b19494af42b07dbfe8896" +dependencies = [ + "cipher 0.5.2", +] + [[package]] name = "cc" version = "1.8.0" @@ -789,11 +860,25 @@ dependencies = [ [[package]] name = "common" -version = "3.0.5" +version = "3.0.6" dependencies = [ "tempfile", ] +[[package]] +name = "compact_str" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9dfdd1c2274d9aa354115b09dc9a901d6c5576818cdf70d14cae2bdb47df00ab" +dependencies = [ + "castaway", + "cfg-if", + "itoa", + "rustversion", + "ryu", + "static_assertions", +] + [[package]] name = "compile-time" version = "0.4.0" @@ -899,6 +984,12 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7f8f80099a98041a3d1622845c271458a2d73e688351bf3cb999266764b81d48" +[[package]] +name = "cpubits" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15b85f9c39137c3a891689859392b1bd49812121d0d61c9caf00d46ed5ce06ae" + [[package]] name = "cpufeatures" version = "0.2.17" @@ -935,25 +1026,6 @@ dependencies = [ "crossbeam-utils", ] -[[package]] -name = "crossbeam-deque" -version = "0.8.8" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "622f3fc73690be383c7214310406f28a90e6edeadc3cea882f9d71e495b9711a" -dependencies = [ - "crossbeam-epoch", - "crossbeam-utils", -] - -[[package]] -name = "crossbeam-epoch" -version = "0.9.21" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d" -dependencies = [ - "crossbeam-utils", -] - [[package]] name = "crossbeam-utils" version = "0.8.23" @@ -970,6 +1042,7 @@ dependencies = [ "crossterm_winapi", "derive_more", "document-features", + "filedescriptor", "mio", "parking_lot", "rustix", @@ -1037,6 +1110,15 @@ version = "1.0.13" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "914a755b7c2d4af2bdcff7ce1739e2db9a1b81a9b07123d8015786ae03c0980d" +[[package]] +name = "ctr" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baaca1c4b237092596f64d571e9db6ce4109c4ef9742e27590f1709594461f21" +dependencies = [ + "cipher 0.5.2", +] + [[package]] name = "ctutils" version = "0.4.3" @@ -1153,6 +1235,30 @@ dependencies = [ "thiserror 2.0.21", ] +[[package]] +name = "der" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a878c850e9e421b20262e9b41f9c860e4785fa07541c266b62ff9d1ef998a80a" +dependencies = [ + "const-oid", + "der_derive", + "flagset", + "pem-rfc7468", + "zeroize", +] + +[[package]] +name = "der_derive" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59600e2c2d636fde9b65e99cc6445ac770c63d3628195ff39932b8d6d7409903" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + [[package]] name = "deranged" version = "0.5.8" @@ -1184,6 +1290,15 @@ dependencies = [ "syn 2.0.119", ] +[[package]] +name = "des" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "916a94e407b54f9034d71dd748234cd1e516ced6284009906ae246f177eafe5a" +dependencies = [ + "cipher 0.5.2", +] + [[package]] name = "digest" version = "0.10.7" @@ -1203,6 +1318,7 @@ dependencies = [ "block-buffer 0.12.1", "const-oid", "crypto-common 0.2.2", + "ctutils", ] [[package]] @@ -1474,6 +1590,17 @@ dependencies = [ "rustc_version", ] +[[package]] +name = "filedescriptor" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e40758ed24c9b2eeb76c35fb0aebc66c626084edd827e07e1552279814c6682d" +dependencies = [ + "libc", + "thiserror 1.0.69", + "winapi", +] + [[package]] name = "filetime" version = "0.2.29" @@ -1490,6 +1617,12 @@ version = "0.1.14" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "aedcfb3409746eddb02b9e19ebda1c3394f759a152e48ee875a0844d1b955484" +[[package]] +name = "flagset" +version = "0.4.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7ac824320a75a52197e8f2d787f6a38b6718bb6897a35142d749af3c0e8f4fe" + [[package]] name = "flate2" version = "1.1.10" @@ -1810,6 +1943,15 @@ dependencies = [ "rand_core 0.10.1", ] +[[package]] +name = "ghash" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2eecf2d5dc9b66b732b97707a0210906b1d30523eb773193ab777c0c84b3e8d5" +dependencies = [ + "polyval", +] + [[package]] name = "gio" version = "0.18.4" @@ -1908,7 +2050,7 @@ dependencies = [ [[package]] name = "gpapi" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "base64 0.23.1", @@ -1925,21 +2067,22 @@ dependencies = [ "log", "log-reload", "md5", + "native-tls", "netdev", "nix", "openssl", "os_info", "oslog", "pem", + "pkcs8", "proptest", - "redact-engine", "regex", "reqwest", + "security-framework", "serde", "serde_json", "serde_urlencoded", "sha2 0.11.1", - "sha256", "snow", "socket2", "specta", @@ -1954,13 +2097,14 @@ dependencies = [ "uzers", "version-compare", "whoami", + "x509-cert", "xmltree", "zeroize", ] [[package]] name = "gpauth" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "auth", @@ -1979,23 +2123,28 @@ dependencies = [ [[package]] name = "gpclient" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "clap", "common", "compile-time", + "crossterm", "directories", "env_logger", "gpapi", "gphip", + "gptunnel", + "gpvpnc", "inquire", "log", "nix", "openconnect", + "ratatui", "reqwest", "serde", "serde_json", + "strip-ansi-escapes", "sysinfo", "tempfile", "tokio", @@ -2006,7 +2155,7 @@ dependencies = [ [[package]] name = "gpgui-helper" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "clap", @@ -2027,7 +2176,7 @@ dependencies = [ [[package]] name = "gphip" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "askama", @@ -2044,7 +2193,7 @@ dependencies = [ [[package]] name = "gpservice" -version = "3.0.5" +version = "3.0.6" dependencies = [ "anyhow", "axum", @@ -2057,6 +2206,8 @@ dependencies = [ "getrandom 0.4.3", "gpapi", "gphip", + "gptunnel", + "gpvpnc", "log", "mac_address", "nix", @@ -2064,7 +2215,6 @@ dependencies = [ "openssl", "serde", "serde_json", - "sha256", "tar", "tempfile", "thiserror 2.0.21", @@ -2076,6 +2226,25 @@ dependencies = [ "zeroize", ] +[[package]] +name = "gptunnel" +version = "3.0.6" +dependencies = [ + "gpapi", + "log", + "openconnect", + "serde_json", + "tokio", + "uuid", +] + +[[package]] +name = "gpvpnc" +version = "3.0.6" +dependencies = [ + "log", +] + [[package]] name = "gtk" version = "0.18.2" @@ -2158,6 +2327,11 @@ name = "hashbrown" version = "0.17.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash", +] [[package]] name = "heck" @@ -2177,6 +2351,15 @@ version = "0.4.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" +[[package]] +name = "hmac" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6303bc9732ae41b04cb554b844a762b4115a61bfaa81e3e83050991eeb56863f" +dependencies = [ + "digest 0.11.3", +] + [[package]] name = "home" version = "0.5.12" @@ -2508,6 +2691,15 @@ dependencies = [ "serde_core", ] +[[package]] +name = "indoc" +version = "2.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a37b2691796cffeb8a8cd305ac66e65841559f147f4e63231d0eafa4db5384d1" +dependencies = [ + "rustversion", +] + [[package]] name = "infer" version = "0.22.0" @@ -2532,6 +2724,7 @@ version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "4250ce6452e92010fdf7268ccc5d14faa80bb12fc741938534c58f16804e03c7" dependencies = [ + "block-padding", "hybrid-array", ] @@ -2549,6 +2742,19 @@ dependencies = [ "unicode-width", ] +[[package]] +name = "instability" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c3b5acc1e2fd9375041a388da33d1eb8aed5f7a8c0dd3543e3ea2805adfbe20" +dependencies = [ + "darling", + "indoc", + "proc-macro2", + "quote", + "syn 3.0.9", +] + [[package]] name = "ipnet" version = "2.12.2" @@ -2589,6 +2795,15 @@ version = "1.70.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" +[[package]] +name = "itertools" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b192c782037fadd9cfa75548310488aabdbf3d2da73885b31bd0abd03351285" +dependencies = [ + "either", +] + [[package]] name = "itoa" version = "1.0.18" @@ -2779,6 +2994,17 @@ dependencies = [ "serde_json", ] +[[package]] +name = "kasuari" +version = "0.4.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f14c90e40a6133f4805b83542a7ed7364f56070b447f56e7f4e90297122209" +dependencies = [ + "hashbrown 0.17.1", + "portable-atomic", + "thiserror 2.0.21", +] + [[package]] name = "keyboard-types" version = "0.8.3" @@ -2838,6 +3064,12 @@ dependencies = [ "winapi", ] +[[package]] +name = "libm" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6d2cec3eae94f9f509c767b45932f1ada8350c4bdb85af2fcab4a3c14807981" + [[package]] name = "libredox" version = "0.1.25" @@ -2847,6 +3079,15 @@ dependencies = [ "libc", ] +[[package]] +name = "line-clipping" +version = "0.3.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e752191d037c44ad111a8caa762921926658402f01cc1253f7bef2020ece4f5e" +dependencies = [ + "bitflags 2.13.2", +] + [[package]] name = "linux-raw-sys" version = "0.12.1" @@ -2889,6 +3130,15 @@ dependencies = [ "log", ] +[[package]] +name = "lru" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef9ac18847474e638e3702b76c65d4eb93428471a74778ef0f1be711717f89b5" +dependencies = [ + "hashbrown 0.17.1", +] + [[package]] name = "lzma-sys" version = "0.1.20" @@ -3477,7 +3727,7 @@ dependencies = [ [[package]] name = "openconnect" -version = "3.0.5" +version = "3.0.6" dependencies = [ "autotools", "cc", @@ -3562,6 +3812,39 @@ dependencies = [ "cc", ] +[[package]] +name = "palette" +version = "0.7.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddeed8580d347d2abf3dcf06a5f0b3dc020258338526b277847cd4248a70fc64" +dependencies = [ + "approx", + "libm", + "palette_derive", + "palette_math", +] + +[[package]] +name = "palette_derive" +version = "0.7.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88537020289b719d81be994ccf1bbf4990f477e2f69ee52fe3e45f43a02e56be" +dependencies = [ + "by_address", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "palette_math" +version = "0.7.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e6eb142958d64335fb0e345c5b9ead2ecd6fc438c307e9d7d3c4fd428dbaf12" +dependencies = [ + "libm", +] + [[package]] name = "pango" version = "0.18.3" @@ -3610,6 +3893,16 @@ dependencies = [ "windows-link", ] +[[package]] +name = "pbkdf2" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112d82ceb8c5bf524d9af484d4e4970c9fd5a0cc15ba14ad93dccd28873b0629" +dependencies = [ + "digest 0.11.3", + "hmac", +] + [[package]] name = "pem" version = "4.0.0" @@ -3620,6 +3913,15 @@ dependencies = [ "serde_core", ] +[[package]] +name = "pem-rfc7468" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6305423e0e7738146434843d1694d621cce767262b2a86910beab705e4493d9" +dependencies = [ + "base64ct", +] + [[package]] name = "percent-encoding" version = "2.3.2" @@ -3685,6 +3987,37 @@ version = "0.2.17" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" +[[package]] +name = "pkcs5" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63d440a804ec8d6fafbb6b84471e013286658d373248927692ab3366686220ca" +dependencies = [ + "aes", + "aes-gcm", + "cbc", + "der", + "des", + "pbkdf2", + "rand_core 0.10.1", + "scrypt", + "sha1 0.11.0", + "sha2 0.11.1", + "spki", +] + +[[package]] +name = "pkcs8" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "451913da69c775a56034ea8d9003d27ee8948e12443eae7c038ba100a4f21cb7" +dependencies = [ + "der", + "pkcs5", + "rand_core 0.10.1", + "spki", +] + [[package]] name = "pkg-config" version = "0.3.34" @@ -3751,6 +4084,17 @@ dependencies = [ "universal-hash 0.6.1", ] +[[package]] +name = "polyval" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0fa31d631f2b2cb2a544d0aa321ce847a94764d701ca2becc411138b93d49cd" +dependencies = [ + "cpubits", + "cpufeatures 0.3.1", + "universal-hash 0.6.1", +] + [[package]] name = "portable-atomic" version = "1.15.0" @@ -3969,46 +4313,78 @@ dependencies = [ "rand_core 0.10.1", ] +[[package]] +name = "ratatui" +version = "0.30.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3274ba0a2c5e1bcad2a2005d20f4dc59dad26b2eb0940fb094500dba4099d57d" +dependencies = [ + "instability", + "ratatui-core", + "ratatui-crossterm", + "ratatui-widgets", + "serde", +] + +[[package]] +name = "ratatui-core" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cbb175c433c8e28a809d1f5773a2ae96e68c0ce40db865cbab1020bf33ae479c" +dependencies = [ + "bitflags 2.13.2", + "compact_str", + "hashbrown 0.17.1", + "itertools", + "kasuari", + "lru", + "palette", + "serde", + "strum", + "thiserror 2.0.21", + "unicode-segmentation", + "unicode-truncate", + "unicode-width", +] + +[[package]] +name = "ratatui-crossterm" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "567584a3b0e6a8203c23de40b4861497266725eb5363dbfd18a1edd603cca9f0" +dependencies = [ + "cfg-if", + "crossterm", + "instability", + "ratatui-core", +] + +[[package]] +name = "ratatui-widgets" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "66e3d19bcc9130ca376277d93b60767ff121ace3be06f5f95f81dd68956407d1" +dependencies = [ + "bitflags 2.13.2", + "hashbrown 0.17.1", + "indoc", + "instability", + "itertools", + "line-clipping", + "ratatui-core", + "serde", + "strum", + "time", + "unicode-segmentation", + "unicode-width", +] + [[package]] name = "raw-window-handle" version = "0.6.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "20675572f6f24e9e76ef639bc5552774ed45f1c30e2951e1e99c59888861c539" -[[package]] -name = "rayon" -version = "1.12.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fb39b166781f92d482534ef4b4b1b2568f42613b53e5b6c160e24cfbfa30926d" -dependencies = [ - "either", - "rayon-core", -] - -[[package]] -name = "rayon-core" -version = "1.13.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91" -dependencies = [ - "crossbeam-deque", - "crossbeam-utils", -] - -[[package]] -name = "redact-engine" -version = "0.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "94d4ba41ad2b45cb0d6df9719881b43fca399dfa084debba338a08d5d599b52c" -dependencies = [ - "anyhow", - "rayon", - "regex", - "serde", - "serde_derive", - "serde_regex", -] - [[package]] name = "redox_syscall" version = "0.5.18" @@ -4219,6 +4595,16 @@ version = "1.0.23" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f" +[[package]] +name = "salsa20" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f874456e72520ff1375a06c588eaf074b0f01f9e9e1aada45bd9b7954a6e42c" +dependencies = [ + "cfg-if", + "cipher 0.5.2", +] + [[package]] name = "same-file" version = "1.0.6" @@ -4294,6 +4680,18 @@ version = "1.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" +[[package]] +name = "scrypt" +version = "0.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d87af57419b594aa23fa95f09f0e06d80d84ba01c26148c43844cad6ff4485f0" +dependencies = [ + "cfg-if", + "pbkdf2", + "salsa20", + "sha2 0.11.1", +] + [[package]] name = "security-framework" version = "3.7.0" @@ -4412,16 +4810,6 @@ dependencies = [ "zmij", ] -[[package]] -name = "serde_regex" -version = "1.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bafc8d0c5330cecff10f16b459b479fd9acaa5b4acd7167301414e21b0057012" -dependencies = [ - "regex", - "serde", -] - [[package]] name = "serde_repr" version = "0.1.21" @@ -4577,18 +4965,6 @@ dependencies = [ "digest 0.11.3", ] -[[package]] -name = "sha256" -version = "1.6.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f880fc8562bdeb709793f00eb42a2ad0e672c4f883bbe59122b926eca935c8f6" -dependencies = [ - "async-trait", - "bytes", - "hex", - "sha2 0.10.9", -] - [[package]] name = "shlex" version = "2.0.1" @@ -4761,12 +5137,28 @@ dependencies = [ "syn 2.0.119", ] +[[package]] +name = "spki" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ef958a98b9d5da290cfc78946e9f3e61e1e62a18db0d92cac0b83cc161491a9" +dependencies = [ + "base64ct", + "der", +] + [[package]] name = "stable_deref_trait" version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" +[[package]] +name = "static_assertions" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" + [[package]] name = "string_cache" version = "0.9.0" @@ -4791,12 +5183,42 @@ dependencies = [ "quote", ] +[[package]] +name = "strip-ansi-escapes" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2a8f8038e7e7969abb3f1b7c2a811225e9296da208539e0f79c5251d6cac0025" +dependencies = [ + "vte", +] + [[package]] name = "strsim" version = "0.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" +[[package]] +name = "strum" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9628de9b8791db39ceda2b119bbe13134770b56c138ec1d3af810d045c04f9bd" +dependencies = [ + "strum_macros", +] + +[[package]] +name = "strum_macros" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab85eea0270ee17587ed4156089e10b9e6880ee688791d45a905f5b1ca36f664" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + [[package]] name = "subtle" version = "2.6.1" @@ -5659,6 +6081,17 @@ version = "1.13.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c6f5d3c3b1bf09027a88a6bc961fc00497d651009560b5463668dc81b0fa87a8" +[[package]] +name = "unicode-truncate" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16b380a1238663e5f8a691f9039c73e1cdae598a30e9855f541d29b08b53e9a5" +dependencies = [ + "itertools", + "unicode-segmentation", + "unicode-width", +] + [[package]] name = "unicode-width" version = "0.2.2" @@ -5795,6 +6228,15 @@ dependencies = [ "libc", ] +[[package]] +name = "vte" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "231fdcd7ef3037e8330d8e17e61011a2c244126acc0a982f4040ac3f9f0bc077" +dependencies = [ + "memchr", +] + [[package]] name = "wait-timeout" version = "0.2.1" @@ -6503,6 +6945,17 @@ dependencies = [ "pkg-config", ] +[[package]] +name = "x509-cert" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "105ef4642d9cb137ef83d623d0e4bf08b8adf69e9918ca904a174adb6d3d038b" +dependencies = [ + "const-oid", + "der", + "spki", +] + [[package]] name = "xattr" version = "1.6.1" diff --git a/Cargo.toml b/Cargo.toml index 4f8dd06..92f7777 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ members = [ [workspace.package] rust-version = "1.91" -version = "3.0.5" +version = "3.0.6" authors = ["Kevin Yue "] homepage = "https://github.com/yuezk/GlobalProtect-openconnect" edition = "2024" @@ -30,7 +30,8 @@ dns-lookup = "4.0.2" env_logger = "0.11" is_executable = "1.0" log = "0.4" -regex = "1" +# RUST_LOG accepts user-supplied Unicode property filters through env_logger. +regex = { version = "1", default-features = false, features = ["std", "perf", "unicode"] } reqwest = { version = "0.13", default-features = false, features = ["native-tls", "charset", "http2", "system-proxy", "json", "form", "query"] } openssl = "0.10" pem = "4" @@ -50,11 +51,10 @@ futures-util = "0.3" uzers = "0.12" whoami = "2" thiserror = "2" -redact-engine = "0.1" compile-time = "0.4" serde_urlencoded = "0.7" md5 = "0.8" -sha256 = { version = "1", default-features = false } +sha2 = { version = "0.11", default-features = false } which = "8" uuid = "1" netdev = "0.46.3" diff --git a/README.md b/README.md index 49d22ea..cbf47fa 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,8 @@ Options: -V, --version Print version ``` +The `--fix-openssl` option is available on Linux, FreeBSD, and OpenBSD. macOS uses native TLS and GnuTLS and does not accept this option. + > **Tip:** Use `gpclient help ` for detailed information on a specific command. #### HIP reports @@ -95,6 +97,8 @@ Use `gpclient` directly for browser-based authentication. It opens the browser a sudo gpclient connect --browser ``` +For standalone CLI installations, use `--browser manual` (`--browser remote` before v3.0.6): open the printed URL and paste the resulting `globalprotectcallback:…` data into the terminal. + To reuse a saved portal cookie for later connections, add `--cookie-cache`: ```bash @@ -109,10 +113,9 @@ sudo gpclient connect --browser --cookie-cache=/absolute/path/to/cookie **Browser Options:** -- 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` to automatically select an available browser - Use `--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 manual` for standalone CLI installations or headless servers ### Graphical User Interface @@ -365,18 +368,18 @@ docker run --rm -it --cap-add=NET_ADMIN --device=/dev/net/tun \ connect ``` -For browser authentication in a headless environment, use remote browser authentication: +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: \ - connect --browser remote + connect --browser manual ``` On a host with multiple network interfaces, use `--browser-listen` to select the IP address reachable from the browser machine: ```bash -gpclient connect --browser remote --browser-listen 192.168.107.15 +gpclient connect --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: @@ -384,7 +387,7 @@ On a Linux host, add host networking if the VPN routes should affect the host ne ```bash docker run --rm -it --network host --cap-add=NET_ADMIN --device=/dev/net/tun \ yuezk/globalprotect-openconnect: \ - connect --browser remote + connect --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. @@ -513,7 +516,7 @@ Verify the CLI client is working correctly: ### Build Options - `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 +- `BUILD_WEBVIEW_AUTH=0` – Build `gpauth` without embedded browser authentication; use an external browser or manual authentication - `INCLUDE_GUI=1` – Download the matching published Linux desktop application for installation - `OFFLINE=1` – Build in offline mode using vendored dependencies @@ -539,7 +542,7 @@ sudo gpclient connect --browser 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. +On a headless server, use `--browser manual` and complete authentication from another machine. ## NetworkManager Integration diff --git a/apps/gpauth/src/cli.rs b/apps/gpauth/src/cli.rs index e578225..a29f37c 100644 --- a/apps/gpauth/src/cli.rs +++ b/apps/gpauth/src/cli.rs @@ -6,17 +6,21 @@ use clap::Parser; use clap::Subcommand; #[cfg(feature = "webview-auth")] use gpapi::auth::AuthWindowTheme; +#[cfg(not(target_os = "macos"))] +use gpapi::utils::openssl; use gpapi::{ auth::{AuthenticationCancelled, SamlAuthData, SamlAuthResult}, clap::{Args, InfoLevelVerbosity, args::Os, handle_error}, + error::ServerTlsError, gp_params::GpParams, log_format::LogFormat, os_profile::{ClientOs, OsProfile}, - utils::{normalize_server, openssl}, + utils::normalize_server, }; use log::info; use serde_json::json; use std::net::IpAddr; +#[cfg(not(target_os = "macos"))] use tempfile::NamedTempFile; const VERSION: &str = concat!( @@ -84,6 +88,7 @@ struct Cli { #[arg(short = 'p', long, help = "The key passphrase of the private key")] key_password: Option, + #[cfg(not(target_os = "macos"))] #[arg(long, help = "Get around the OpenSSL `unsafe legacy renegotiation` error")] fix_openssl: bool, @@ -104,13 +109,13 @@ struct Cli { #[arg( long, - help = "Use external browser authentication. With no value, auto-select Chrome, Firefox, then system default. Use `default` for the system default browser or `remote` for headless servers.", + help = "Use a browser; omit the value to auto-select. Use `manual` to open the URL and paste the callback.", default_missing_value = "auto", num_args=0..=1 )] browser: Option, - #[arg(long, help = "Listen on this IP address when using '--browser remote'")] + #[arg(long, help = "Listen on this IP address when using '--browser manual'")] browser_listen: Option, #[cfg(feature = "webview-auth")] @@ -144,6 +149,7 @@ enum CliCommand { } impl Args for Cli { + #[cfg(not(target_os = "macos"))] fn fix_openssl(&self) -> bool { self.fix_openssl } @@ -158,10 +164,8 @@ impl Args for Cli { } impl Cli { - fn prepare_env(&self) -> anyhow::Result> { - #[cfg(feature = "webview-auth")] - gpapi::utils::env_utils::patch_gui_runtime_env(self.hidpi); - + #[cfg(not(target_os = "macos"))] + fn prepare_openssl(&self) -> anyhow::Result> { if self.fix_openssl { info!("Fixing OpenSSL environment"); let file = openssl::fix_openssl_env()?; @@ -174,16 +178,19 @@ impl Cli { async fn run(&self) -> anyhow::Result<()> { if self.browser_listen.is_some() - && !matches!(self.browser.as_deref(), Some(browser) if browser.eq_ignore_ascii_case("remote")) + && !matches!(self.browser.as_deref(), Some(browser) if browser.eq_ignore_ascii_case("manual") || browser.eq_ignore_ascii_case("remote")) { - anyhow::bail!("The '--browser-listen' option requires '--browser remote'"); + anyhow::bail!("The '--browser-listen' option requires '--browser manual'"); } if self.ignore_tls_errors { info!("TLS errors will be ignored"); } - let openssl_conf = self.prepare_env()?; + #[cfg(feature = "webview-auth")] + gpapi::utils::env_utils::patch_gui_runtime_env(self.hidpi); + #[cfg(not(target_os = "macos"))] + let openssl_conf = self.prepare_openssl()?; let server = normalize_server(self.server.as_deref().expect("server is required for authentication"))?; let gp_params = self.build_gp_params(); @@ -194,7 +201,17 @@ impl Cli { let auth_request = match self.saml_request.as_deref() { Some(auth_request) => auth_request.to_string(), - None => auth_prelogin(&server, &gp_params, self.external_browser_requested(), self.gateway).await?, + None => match auth_prelogin(&server, &gp_params, self.external_browser_requested(), self.gateway).await { + Ok(request) => request, + Err(error) => { + let Some(tls) = error.downcast_ref::().cloned() else { + return Err(error); + }; + handle_error(error, self); + print_auth_result(Err(tls.into()), None); + return Ok(()); + } + }, }; #[cfg(feature = "webview-auth")] @@ -213,7 +230,7 @@ impl Cli { print_auth_result(auth_result, Some(&auth_host_id)); - // explicitly drop openssl_conf to avoid the unused variable warning + #[cfg(not(target_os = "macos"))] drop(openssl_conf); return Ok(()); } @@ -226,6 +243,7 @@ impl Cli { self.clean, self.window_title.clone(), self.window_theme, + #[cfg(not(target_os = "macos"))] openssl_conf, ) .await?; @@ -298,7 +316,11 @@ pub async fn run() { } pub fn print_auth_result(auth_result: anyhow::Result, host_id: Option<&str>) { - let auth_result = match auth_result { + println!("{}", json!(auth_outcome(auth_result, host_id))); +} + +fn auth_outcome(auth_result: anyhow::Result, host_id: Option<&str>) -> SamlAuthResult { + match auth_result { Ok(auth_data) => { let auth_data = match host_id { Some(host_id) => auth_data.with_host_id(host_id), @@ -307,16 +329,54 @@ pub fn print_auth_result(auth_result: anyhow::Result, host_id: Opt SamlAuthResult::Success(auth_data) } Err(err) if err.downcast_ref::().is_some() => SamlAuthResult::Cancelled, - Err(err) => SamlAuthResult::Failure(format!("{}", err)), - }; - - println!("{}", json!(auth_result)); + Err(err) => match err.downcast::() { + Ok(tls) => SamlAuthResult::ServerTlsError(tls), + Err(err) => SamlAuthResult::Failure(err.to_string()), + }, + } } #[cfg(test)] mod tests { use super::*; + #[test] + fn openssl_option_is_available_only_on_supported_platforms() { + let result = Cli::try_parse_from(["gpauth", "portal.example.com", "--fix-openssl"]); + assert_eq!(result.is_ok(), !cfg!(target_os = "macos")); + } + + #[test] + fn result_keeps_server_tls_kind_and_generic_failure_format() { + use gpapi::error::ServerTlsErrorKind; + let tls = ServerTlsError { + server: "https://vpn.example.com".into(), + kind: ServerTlsErrorKind::LegacyRenegotiation, + }; + let outcome = auth_outcome(Err(anyhow::Error::new(tls).context("retry failed")), None); + assert_eq!( + serde_json::to_value(outcome).unwrap(), + json!({"serverTlsError": {"server": "https://vpn.example.com", "kind": "legacyRenegotiation"}}) + ); + assert_eq!( + serde_json::to_value(auth_outcome(Err(anyhow::anyhow!("rejected")), None)).unwrap(), + json!({"failure": "rejected"}) + ); + } + + #[test] + fn retry_result_preserves_client_certificate_requirement() { + let error = ServerTlsError { + server: "https://vpn.example.com".into(), + kind: gpapi::error::ServerTlsErrorKind::ClientCertificateRequired, + }; + let outcome = auth_outcome(Err(anyhow::Error::new(error).context("retry failed")), None); + assert_eq!( + serde_json::to_value(outcome).unwrap(), + json!({"serverTlsError": {"server": "https://vpn.example.com", "kind": "clientCertificateRequired"}}) + ); + } + /// gpauth's own result already goes to stdout as JSON; this makes its *logs* /// readable the same way, so a caller driving it does not have to parse prose /// on stderr to find out why an attempt failed. @@ -399,7 +459,7 @@ mod tests { "gpauth", "portal.example.com", "--browser", - "remote", + "manual", "--browser-listen", "192.168.107.15", ]) diff --git a/apps/gpauth/src/webview_auth.rs b/apps/gpauth/src/webview_auth.rs index 0b162ca..4a836bc 100644 --- a/apps/gpauth/src/webview_auth.rs +++ b/apps/gpauth/src/webview_auth.rs @@ -1,7 +1,10 @@ use auth::{WebviewAuthenticator, apply_auth_theme}; use gpapi::{auth::AuthWindowTheme, gp_params::GpParams}; +#[cfg(not(target_os = "macos"))] use log::info; +#[cfg(not(target_os = "macos"))] use tauri::RunEvent; +#[cfg(not(target_os = "macos"))] use tempfile::NamedTempFile; use crate::cli::print_auth_result; @@ -13,7 +16,7 @@ pub async fn authenticate( clean: bool, window_title: Option, window_theme: AuthWindowTheme, - mut openssl_conf: Option, + #[cfg(not(target_os = "macos"))] mut openssl_conf: Option, ) -> anyhow::Result<()> { let auth_host_id = gp_params.os_profile().host_identity().host_id().to_string(); @@ -43,8 +46,9 @@ pub async fn authenticate( Ok(()) }) .build(crate::tauri_context::get())? - .run(move |_app_handle, event| { - if let RunEvent::Exit = event { + .run(move |_app_handle, _event| { + #[cfg(not(target_os = "macos"))] + if let RunEvent::Exit = _event { if let Some(file) = openssl_conf.take() { if let Err(err) = file.close() { info!("Error closing OpenSSL config file: {}", err); diff --git a/apps/gpclient/Cargo.toml b/apps/gpclient/Cargo.toml index 08c80bb..e927499 100644 --- a/apps/gpclient/Cargo.toml +++ b/apps/gpclient/Cargo.toml @@ -11,13 +11,17 @@ common = { path = "../../crates/common" } gpapi = { path = "../../crates/gpapi", features = ["clap"] } gphip = { path = "../../crates/gphip" } openconnect = { path = "../../crates/openconnect" } +gptunnel = { path = "../../crates/gptunnel" } anyhow.workspace = true clap.workspace = true env_logger.workspace = true inquire = "0.9" log.workspace = true -nix = { version = "0.31", features = ["fs", "signal", "process"] } +nix = { version = "0.31", features = ["fs", "signal", "process", "poll", "term"] } +ratatui = { version = "=0.30.2", default-features = false, features = ["crossterm", "unstable-rendered-line-info"] } +crossterm = { version = "0.29", features = ["use-dev-tty"] } +strip-ansi-escapes = "0.2" tokio = { workspace = true, features = ["rt-multi-thread"] } tokio-util.workspace = true sysinfo.workspace = true @@ -33,3 +37,6 @@ uzers.workspace = true [features] default = ["webview-auth"] webview-auth = ["gpapi/webview-auth"] + +[target.'cfg(target_os = "macos")'.dependencies] +gpvpnc = { path = "../../crates/gpvpnc" } diff --git a/apps/gpclient/src/cli.rs b/apps/gpclient/src/cli.rs index df84aaf..32a990c 100644 --- a/apps/gpclient/src/cli.rs +++ b/apps/gpclient/src/cli.rs @@ -5,13 +5,15 @@ use std::{ use anyhow::bail; use clap::{Parser, Subcommand}; +#[cfg(not(target_os = "macos"))] +use gpapi::utils::openssl; use gpapi::{ clap::{Args, InfoLevelVerbosity, handle_error}, log_format::{LogFormat, write_json_record}, - utils::openssl, }; use log::info; use sysinfo::{Pid, System}; +#[cfg(not(target_os = "macos"))] use tempfile::NamedTempFile; use tokio::fs; @@ -34,6 +36,7 @@ const VERSION: &str = concat!( ); pub(crate) struct SharedArgs<'a> { + #[cfg(not(target_os = "macos"))] pub(crate) fix_openssl: bool, pub(crate) ignore_tls_errors: bool, pub(crate) lock_file: &'a Path, @@ -92,6 +95,7 @@ struct Cli { #[command(subcommand)] command: CliCommand, + #[cfg(not(target_os = "macos"))] #[arg( long, help = "Uses extended compatibility mode for OpenSSL operations to support a broader range of systems and formats." @@ -123,6 +127,7 @@ struct Cli { } impl Args for Cli { + #[cfg(not(target_os = "macos"))] fn fix_openssl(&self) -> bool { self.fix_openssl } @@ -164,6 +169,7 @@ impl Cli { .unwrap_or(false) } + #[cfg(not(target_os = "macos"))] fn fix_openssl(&self) -> anyhow::Result> { if self.fix_openssl { let file = openssl::fix_openssl_env()?; @@ -174,6 +180,11 @@ impl Cli { } async fn run(&self) -> anyhow::Result<()> { + if let CliCommand::Connect(args) = &self.command { + if args.dashboard { + crate::dashboard::validate(self.log_format)?; + } + } if self.background_worker_fd.is_some() && !matches!(&self.command, CliCommand::Connect(args) if args.background) { bail!("Background worker requires connect --background"); } @@ -205,8 +216,10 @@ impl Cli { // The temp file will be dropped automatically when the file handle is dropped // So, declare it here to ensure it's not dropped + #[cfg(not(target_os = "macos"))] let _file = self.fix_openssl()?; let shared_args = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: self.fix_openssl, ignore_tls_errors: self.ignore_tls_errors, lock_file: &self.lock_file, @@ -263,7 +276,13 @@ fn build_logger(cli: &Cli) -> env_logger::Builder { pub(crate) async fn run() { let cli = Cli::parse(); - build_logger(&cli).init(); + if matches!(&cli.command, CliCommand::Connect(args) if args.dashboard) { + let logger = build_logger(&cli).build(); + log::set_max_level(logger.filter()); + log::set_boxed_logger(Box::new(crate::dashboard::NoticeLogger::new(logger))).expect("failed to initialize logger"); + } else { + build_logger(&cli).init(); + } info!("gpclient started: {}", VERSION); @@ -325,10 +344,42 @@ mod tests { ); } + #[test] + fn dashboard_is_opt_in_and_conflicts_with_noninteractive_connection_modes() { + for option in ["--background", "--cookie-only"] { + assert!(Cli::try_parse_from(["gpclient", "connect", "portal.example.com", "--dashboard", option]).is_err()); + } + assert!(Cli::try_parse_from(["gpclient", "connect", "portal.example.com", "--stats"]).is_err()); + let cli = Cli::try_parse_from([ + "gpclient", + "connect", + "portal.example.com", + "--dashboard", + "--cookie-on-stdin", + ]) + .unwrap(); + assert!(matches!(cli.command, CliCommand::Connect(args) if args.dashboard)); + let cli = Cli::try_parse_from(["gpclient", "connect", "portal.example.com"]).unwrap(); + assert!(matches!(cli.command, CliCommand::Connect(args) if !args.dashboard)); + assert!( + crate::dashboard::validate(LogFormat::Json) + .unwrap_err() + .to_string() + .contains("--log-format json") + ); + } + + #[test] + fn openssl_option_is_available_only_on_supported_platforms() { + let result = Cli::try_parse_from(["gpclient", "--fix-openssl", "diagnostics"]); + assert_eq!(result.is_ok(), !cfg!(target_os = "macos")); + } + #[test] fn diagnostics_accepts_output_options_and_runs_alongside_the_client() { let cli = Cli::try_parse_from([ "gpclient", + #[cfg(not(target_os = "macos"))] "--fix-openssl", "diagnostics", "--json", @@ -501,6 +552,40 @@ mod tests { captured.contents() } + #[test] + fn unicode_property_log_filters_keep_matching_and_excluding_records() { + for (pattern, matching, excluded) in [ + (r"\p{Greek}", "α", "plain ASCII"), + (r"\p{Mark}", "\u{0301}", "plain ASCII"), + (r"\p{Alphabetic}", "α", "123"), + (r"\p{Grapheme_Extend}", "\u{0301}", "plain ASCII"), + ] { + let captured = Captured::default(); + let logger = build_logger(&parse_cli(&["gpclient", "disconnect"])) + .parse_filters(&format!("info/{pattern}")) + .target(env_logger::Target::Pipe(Box::new(captured.clone()))) + .build(); + for message in [excluded, matching] { + logger.log( + &log::Record::builder() + .level(log::Level::Info) + .target("gpclient") + .args(format_args!("{message}")) + .build(), + ); + } + let output = captured.contents(); + assert!( + output.contains(matching), + "filter {pattern} dropped its matching record" + ); + assert!( + !output.contains(excluded), + "filter {pattern} allowed an excluded record" + ); + } + } + /// The point of the flag: with `json`, a caller gets fields, and gets them one /// record per line so the stream can be read incrementally. #[test] diff --git a/apps/gpclient/src/connect/args.rs b/apps/gpclient/src/connect/args.rs index d0c22ac..44e5bc9 100644 --- a/apps/gpclient/src/connect/args.rs +++ b/apps/gpclient/src/connect/args.rs @@ -20,6 +20,13 @@ pub(crate) struct ConnectArgs { )] pub(crate) background: bool, + #[arg( + long, + conflicts_with_all = ["background", "cookie_only"], + help = "Show an interactive connection dashboard after sign-in (requires a foreground terminal)" + )] + pub(crate) dashboard: bool, + #[arg( long, requires = "background", @@ -158,13 +165,13 @@ pub(crate) struct ConnectArgs { #[arg( long, - help = "Use external browser authentication. With no value, auto-select Chrome, Firefox, then system default. Use `default` for the system default browser or `remote` for headless servers.", + help = "Use a browser; omit the value to auto-select. Use `manual` to open the URL and paste the callback.", default_missing_value = "auto", num_args=0..=1 )] pub(super) browser: Option, - #[arg(long, help = "Listen on this IP address when using '--browser remote'")] + #[arg(long, help = "Listen on this IP address when using '--browser manual'")] pub(super) browser_listen: Option, #[arg( @@ -299,7 +306,7 @@ mod tests { "test", "portal.example.com", "--browser", - "remote", + "manual", "--browser-listen", "192.168.107.15", ]) diff --git a/apps/gpclient/src/connect/credential.rs b/apps/gpclient/src/connect/credential.rs index 04bb303..276f347 100644 --- a/apps/gpclient/src/connect/credential.rs +++ b/apps/gpclient/src/connect/credential.rs @@ -129,7 +129,6 @@ impl ConnectHandler<'_> { .gateway(is_gateway) .saml_request(prelogin.saml_request()) .os_profile(&os_profile) - .fix_openssl(self.shared_args.fix_openssl) .ignore_tls_errors(self.shared_args.ignore_tls_errors) .certificate(self.args.certificate.as_deref()) .sslkey(self.args.sslkey.as_deref()) @@ -139,6 +138,9 @@ impl ConnectHandler<'_> { .log_format(self.shared_args.log_format) .verbose(verbose); + #[cfg(not(target_os = "macos"))] + let auth_launcher = auth_launcher.fix_openssl(self.shared_args.fix_openssl); + #[cfg(feature = "webview-auth")] let use_default_browser = external_browser_supported && self.args.default_browser; #[cfg(feature = "webview-auth")] diff --git a/apps/gpclient/src/connect/flow_tests.rs b/apps/gpclient/src/connect/flow_tests.rs index 0bd79b9..a6c3df4 100644 --- a/apps/gpclient/src/connect/flow_tests.rs +++ b/apps/gpclient/src/connect/flow_tests.rs @@ -98,6 +98,7 @@ async fn cached_tunnel_authentication_does_not_require_portal_discovery() { let lock = directory.path().join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, @@ -143,6 +144,7 @@ async fn internal_tunnel_keeps_gateway_authentication_after_portal_cookie_reject let lock = directory.path().join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, @@ -190,6 +192,7 @@ async fn rendering_recovery_fetches_new_prelogin_metadata_and_preserves_gateway_ let lock = directory.path().join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, @@ -224,6 +227,7 @@ async fn cancellation_during_recovery_prelogin_stops_request() { let lock = directory.path().join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, @@ -291,6 +295,7 @@ async fn auth_crash_uses_fresh_saml_and_clean_once_with_shared_budget() { let lock = directory.path().join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, @@ -350,6 +355,7 @@ async fn exhausted_auth_recovery_is_terminal_before_portal_gateway_fallback() { let lock = directory.path().join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, @@ -497,6 +503,7 @@ printf '%s\n' '{"success":{"username":"alice","preloginCookie":"new-cookie"}}' let lock = directory.join("client.pid"); let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0); let shared = SharedArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: true, lock_file: &lock, diff --git a/apps/gpclient/src/connect/gateway.rs b/apps/gpclient/src/connect/gateway.rs index 4bb1fe8..e3aec50 100644 --- a/apps/gpclient/src/connect/gateway.rs +++ b/apps/gpclient/src/connect/gateway.rs @@ -20,14 +20,14 @@ use gpapi::{ }; use inquire::Text; use log::{Level, info, warn}; -use openconnect::{HipScript, HipSource, Vpn, VpnBuilder}; +use openconnect::{HipScript, HipSource, VpnBuilder}; use tokio::{runtime::Handle, task::JoinHandle}; use crate::session::{ SessionContextInput, build_session_context, session_info_from_vpn, spawn_session_runtime_with_info, }; -use super::{ConnectHandler, args::cookie_cache_path}; +use super::{ConnectHandler, args::cookie_cache_path, vpn_script}; const OPENCONNECT_INTERRUPTED_EXIT_CODE: i32 = -4; @@ -443,10 +443,8 @@ impl ConnectHandler<'_> { disable_ipv6: self.args.disable_ipv6, extension_auth: Some(extension_auth), }); - let vpn_builder = Vpn::builder(gateway, cookie) - .script(self.args.script.clone()) + let vpn_builder = vpn_script::builder(gateway, cookie, self.args) .interface(self.args.interface.clone()) - .script_tun(self.args.script_tun) .certificate(certificate) .sslkey(sslkey) .key_password(key_password) @@ -458,15 +456,6 @@ impl ConnectHandler<'_> { .local_hostname(self.args.local_hostname.clone()) .dpd_interval(self.args.dpd_interval.unwrap_or(0)) .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) .build() .map_err(|err| GatewayConnectError::before_establishment(err.into()))?; @@ -491,6 +480,16 @@ impl ConnectHandler<'_> { .transpose() .map_err(GatewayConnectError::before_establishment)?; + let mut dashboard = if self.args.dashboard { + Some( + crate::dashboard::Dashboard::prepare(gateway.to_owned(), self.cancellation.clone()) + .map_err(GatewayConnectError::before_establishment)?, + ) + } else { + None + }; + let monitor = gptunnel::TunnelMonitor::attach(vpn.clone()); + let disconnect_task = tokio::spawn(async move { cancellation.cancelled().await; info!("Received the interrupt signal, disconnecting..."); @@ -523,7 +522,7 @@ impl ConnectHandler<'_> { session_task_on_connect.lock().unwrap().replace(task); }) }); - let mut background_error = None; + let mut output_error = None; let connect_result = tokio::select! { result = &mut worker => result, established = established_rx => { @@ -537,6 +536,12 @@ impl ConnectHandler<'_> { self.logout_gateway(&server).await; } }, || { + if let Some(dashboard) = &mut dashboard { + if let Err(error) = dashboard.start_tunnel(monitor.clone()) { + self.cancellation.cancel(); + output_error = Some(error); + } + } if let (Some(background), Some(stdio)) = (&self.background, &mut background_stdio) { let detach = if self.pid_written.load(Ordering::SeqCst) { background.detach(stdio) @@ -545,7 +550,7 @@ impl ConnectHandler<'_> { }; if let Err(error) = detach { self.cancellation.cancel(); - background_error = Some(error); + output_error = Some(error); } } }).await @@ -554,6 +559,12 @@ impl ConnectHandler<'_> { } } }; + monitor.stop().await; + if let Some(dashboard) = &mut dashboard { + if let Err(error) = dashboard.finish() { + output_error = Some(error); + } + } let tunnel_established = tunnel_established.load(Ordering::SeqCst); disconnect_task.abort(); let _ = disconnect_task.await; @@ -564,7 +575,7 @@ impl ConnectHandler<'_> { let _ = task.await; } - if let Some(error) = background_error { + if let Some(error) = output_error { return Err(GatewayConnectError::after_establishment(error)); } diff --git a/apps/gpclient/src/connect/internal.rs b/apps/gpclient/src/connect/internal.rs index a9b45aa..b818e6d 100644 --- a/apps/gpclient/src/connect/internal.rs +++ b/apps/gpclient/src/connect/internal.rs @@ -112,6 +112,18 @@ impl ConnectHandler<'_> { let source = Arc::new(source); let validate_network = network.clone(); let validate_detection = detection.clone(); + let members = crate::dashboard::InternalMembers::default(); + let dashboard_members = members.clone(); + let (established_tx, established_rx) = tokio::sync::oneshot::channel(); + let established_tx = std::sync::Mutex::new(Some(established_tx)); + let mut dashboard = if self.args.dashboard { + Some(crate::dashboard::Dashboard::prepare( + authenticated[0].0.server().to_owned(), + cancellation.clone(), + )?) + } else { + None + }; let callbacks = SessionCallbacks { produce_report: Arc::new(move |request, control| { control.check()?; @@ -143,12 +155,23 @@ impl ConnectHandler<'_> { ) }), report_submitted: Arc::new(|_, _| {}), - status_changed: Arc::new(|member| match member.maintenance { - MaintenanceState::Healthy => info!( - "Internal network — authenticated: {} (IPv4: {:?}, IPv6: {:?})", - member.gateway, member.client_ip, member.client_ipv6 - ), - state => info!("Internal gateway {}: {state:?}", member.gateway), + status_changed: Arc::new(move |member| { + match member.maintenance { + MaintenanceState::Healthy => { + info!( + "Internal network — authenticated: {} (IPv4: {:?}, IPv6: {:?})", + member.gateway, member.client_ip, member.client_ipv6 + ); + if let Some(established) = established_tx.lock().unwrap().take() { + let _ = established.send(()); + } + } + state => info!("Internal gateway {}: {state:?}", member.gateway), + } + members.lock().unwrap().insert( + member.gateway.server().to_owned(), + format!("{}: {:?}", member.gateway, member.maintenance), + ); }), validate_network: Arc::new(move |cancellation| { let network = validate_network.clone(); @@ -183,13 +206,38 @@ impl ConnectHandler<'_> { std::sync::atomic::Ordering::SeqCst, ); let mut sessions = self.sessions.take(); - let result = maintain_non_tunnel_sessions(&mut sessions, policy, callbacks, cancellation, async move { - network_signal.await.unwrap_or(SessionEndReason::NetworkChanged) - }) - .await; + let mut dashboard_error = None; + let result = { + let maintenance = maintain_non_tunnel_sessions(&mut sessions, policy, callbacks, cancellation, async move { + network_signal.await.unwrap_or(SessionEndReason::NetworkChanged) + }); + tokio::pin!(maintenance); + tokio::select! { + result = &mut maintenance => result, + established = established_rx => { + if established.is_ok() { + if let Some(dashboard) = &mut dashboard { + if let Err(error) = dashboard.start_internal(dashboard_members) { + self.cancellation.cancel(); + dashboard_error = Some(error); + } + } + } + maintenance.await + } + } + }; + if let Some(dashboard) = &mut dashboard { + if let Err(error) = dashboard.finish() { + dashboard_error = Some(error); + } + } self.sessions.replace(sessions); monitor_cancel.cancel(); monitor.await.context("Internal network monitor failed")?; + if let Some(error) = dashboard_error { + return Err(error); + } match result? { SessionExit::Disconnected => Ok(()), SessionExit::Failed(reason) => bail!("Internal session ended: {reason:?}. Connect again to authenticate."), diff --git a/apps/gpclient/src/connect/mod.rs b/apps/gpclient/src/connect/mod.rs index 4c8062d..e78999e 100644 --- a/apps/gpclient/src/connect/mod.rs +++ b/apps/gpclient/src/connect/mod.rs @@ -4,6 +4,7 @@ mod credential; mod flow_tests; mod gateway; mod internal; +mod vpn_script; use std::cell::RefCell; use std::sync::{ @@ -153,9 +154,9 @@ impl<'a> ConnectHandler<'a> { async fn handle_attempt(&self) -> anyhow::Result<()> { if self.args.browser_listen.is_some() - && !matches!(self.args.browser.as_deref(), Some(browser) if browser.eq_ignore_ascii_case("remote")) + && !matches!(self.args.browser.as_deref(), Some(browser) if browser.eq_ignore_ascii_case("manual") || browser.eq_ignore_ascii_case("remote")) { - bail!("The '--browser-listen' option requires '--browser remote'"); + bail!("The '--browser-listen' option requires '--browser manual'"); } #[cfg(feature = "webview-auth")] @@ -178,11 +179,18 @@ impl<'a> ConnectHandler<'a> { { return Err(err); } - let Some(root_cause) = err.root_cause().downcast_ref::() else { + let Some(identity_error) = err.downcast_ref::() else { return Err(err); }; - match root_cause { + match identity_error { + RequestIdentityError::UnsupportedEncryption + | RequestIdentityError::LegacyKeyConversion(_) + | RequestIdentityError::UnsupportedKeyFormat + | RequestIdentityError::InvalidKey + | RequestIdentityError::InvalidCertificate + | RequestIdentityError::IncompletePkcs12 + | RequestIdentityError::InvalidPkcs12(_) => return Err(err), RequestIdentityError::NoKey => { let format = self.shared_args.log_format; report( diff --git a/apps/gpclient/src/connect/vpn_script/default.rs b/apps/gpclient/src/connect/vpn_script/default.rs new file mode 100644 index 0000000..3d1b702 --- /dev/null +++ b/apps/gpclient/src/connect/vpn_script/default.rs @@ -0,0 +1,9 @@ +use openconnect::{Vpn, VpnBuilder}; + +use crate::connect::ConnectArgs; + +pub(crate) fn builder(server: &str, cookie: &str, args: &ConnectArgs) -> VpnBuilder { + Vpn::builder(server, cookie) + .script(args.script.clone()) + .script_tun(args.script_tun) +} diff --git a/apps/gpclient/src/connect/vpn_script/macos.rs b/apps/gpclient/src/connect/vpn_script/macos.rs new file mode 100644 index 0000000..e31c1db --- /dev/null +++ b/apps/gpclient/src/connect/vpn_script/macos.rs @@ -0,0 +1,86 @@ +use std::ffi::OsStr; + +use openconnect::{Vpn, VpnBuilder}; + +use crate::connect::ConnectArgs; + +pub(crate) fn builder(server: &str, cookie: &str, args: &ConnectArgs) -> VpnBuilder { + let configured_script = std::env::var_os("GP_VPNC_SCRIPT"); + configure_builder(server, cookie, args, configured_script.as_deref()) +} + +fn configure_builder(server: &str, cookie: &str, args: &ConnectArgs, configured_script: Option<&OsStr>) -> VpnBuilder { + let builder = Vpn::builder(server, cookie) + .script(args.script.clone()) + .script_tun(args.script_tun); + let has_environment_script = configured_script.is_some_and(|value| !value.is_empty()); + if args.script.is_none() && !args.script_tun && !has_environment_script { + builder.network_configuration_handler(|configuration| { + gpvpnc::macos::configure_network(&configuration.reason, &configuration.environment) + }) + } else { + builder + } +} + +#[cfg(test)] +mod tests { + use super::*; + use clap::Parser; + + #[derive(Parser)] + struct TestCli { + #[command(flatten)] + args: ConnectArgs, + } + + fn args(options: &[&str]) -> ConnectArgs { + TestCli::try_parse_from( + ["connect", "vpn.example.com"] + .into_iter() + .chain(options.iter().copied()), + ) + .unwrap() + .args + } + + #[test] + fn default_does_not_require_an_installed_script() { + for configured in [None, Some(OsStr::new(""))] { + assert!( + configure_builder("server", "cookie", &args(&[]), configured) + .build() + .is_ok() + ); + assert!( + configure_builder("server", "cookie", &args(&[]), configured) + .script("/bin/sh".to_string()) + .script_tun(true) + .build() + .is_err() + ); + } + } + + #[test] + fn explicit_commands_and_script_tunnels_remain_supported() { + for options in [ + vec!["--script", "exec /bin/sh"], + vec!["--script", "/bin/sh", "--script-tun"], + ] { + assert!( + configure_builder("server", "cookie", &args(&options), None) + .build() + .is_ok() + ); + } + } + + #[test] + fn environment_override_does_not_install_default_callback() { + let builder = configure_builder("server", "cookie", &args(&[]), Some(OsStr::new("/bin/sh"))); + // Converting the selected builder to an explicit packet script would fail + // if the embedded configuration callback had replaced the environment override. + assert!(builder.script("/bin/sh".to_string()).script_tun(true).build().is_ok()); + } +} diff --git a/apps/gpclient/src/connect/vpn_script/mod.rs b/apps/gpclient/src/connect/vpn_script/mod.rs new file mode 100644 index 0000000..397255a --- /dev/null +++ b/apps/gpclient/src/connect/vpn_script/mod.rs @@ -0,0 +1,8 @@ +#[cfg(target_os = "macos")] +#[path = "macos.rs"] +mod platform; +#[cfg(not(target_os = "macos"))] +#[path = "default.rs"] +mod platform; + +pub(super) use platform::builder; diff --git a/apps/gpclient/src/dashboard/layout.rs b/apps/gpclient/src/dashboard/layout.rs new file mode 100644 index 0000000..290a044 --- /dev/null +++ b/apps/gpclient/src/dashboard/layout.rs @@ -0,0 +1,625 @@ +//! Dashboard presentation only; connection ownership and sampling stay outside this module. +use crossterm::event::KeyCode; +use gpapi::session::tunnel::{TunnelList, TunnelPhase, TunnelState, TunnelStatisticsSnapshot, TunnelStatisticsState}; +use ratatui::{ + Frame, + buffer::Buffer, + layout::Rect, + style::{Color, Modifier, Style}, + text::{Line, Span}, + widgets::{Paragraph, Widget, Wrap}, +}; + +use super::output::plain_text; + +const MAX_CONTENT_WIDTH: u16 = 120; +const LABEL_WIDTH: usize = 12; + +#[derive(Default)] +pub(super) struct DetailScroll { + offset: u16, + maximum: u16, + page: u16, +} + +impl DetailScroll { + pub(super) fn handle_key(&mut self, key: KeyCode) { + self.offset = match key { + KeyCode::Up => self.offset.saturating_sub(1), + KeyCode::Down => self.offset.saturating_add(1), + KeyCode::PageUp => self.offset.saturating_sub(self.page), + KeyCode::PageDown => self.offset.saturating_add(self.page), + KeyCode::Home => 0, + KeyCode::End => self.maximum, + _ => self.offset, + } + .min(self.maximum); + } + + pub(super) fn can_scroll(&self) -> bool { + self.maximum > 0 + } + + fn update(&mut self, content_height: u16, viewport_height: u16) { + self.maximum = if viewport_height == 0 { + 0 + } else { + content_height.saturating_sub(viewport_height) + }; + self.offset = self.offset.min(self.maximum); + self.page = viewport_height.saturating_sub(1).max(1); + } +} + +pub(super) fn phase_label(phase: TunnelPhase) -> &'static str { + match phase { + TunnelPhase::Establishing => "Establishing", + TunnelPhase::Connected => "Connected", + TunnelPhase::Reconnecting => "Reconnecting", + TunnelPhase::Ended => "Disconnected", + } +} + +fn uptime(milliseconds: u64) -> String { + let seconds = milliseconds / 1000; + format!("{:02}:{:02}:{:02}", seconds / 3600, (seconds / 60) % 60, seconds % 60) +} + +fn bytes(value: u64) -> String { + const UNITS: [&str; 7] = ["B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"]; + let mut amount = value as f64; + let mut unit = 0; + while amount >= 1024.0 && unit < UNITS.len() - 1 { + amount /= 1024.0; + unit += 1; + } + if unit == 0 { + format!("{value} B") + } else { + format!("{amount:.1} {}", UNITS[unit]) + } +} + +fn muted(text: impl Into) -> Span<'static> { + Span::styled(text.into(), Style::default().fg(Color::DarkGray)) +} + +fn heading(text: impl Into) -> Line<'static> { + Line::styled( + text.into(), + Style::default().fg(Color::Cyan).add_modifier(Modifier::BOLD), + ) +} + +pub(super) fn row(label: &str, value: impl Into) -> Line<'static> { + Line::from(vec![ + muted(format!("{label:>) -> Paragraph<'static> { + Paragraph::new(lines).wrap(Wrap { trim: false }) +} + +fn summary(server: &str, state: &TunnelState, width: u16) -> Paragraph<'static> { + let status = Span::styled( + format!("{:= 64 { + vec![Line::from(vec![ + status, + Span::raw(format!( + "{} Uptime {}", + state.transport.label(), + uptime(state.elapsed_ms) + )), + ])] + } else { + vec![ + Line::from(status), + row("Transport", state.transport.label()), + row("Uptime", uptime(state.elapsed_ms)), + ] + }; + lines.insert(0, row("Server", server)); + paragraph(lines) +} + +fn traffic(statistics: &TunnelStatisticsSnapshot, width: u16) -> Paragraph<'static> { + let mut lines = vec![heading("TRAFFIC")]; + if let Some(view) = statistics.view() { + let label = match view.state { + TunnelStatisticsState::Disabled => "disabled", + TunnelStatisticsState::Waiting => "waiting for sample", + TunnelStatisticsState::Fresh => "live", + TunnelStatisticsState::Stale => "stale", + TunnelStatisticsState::Ended => "ended", + }; + lines[0] = heading(format!("TRAFFIC · {label}")); + if let Some(sample) = &view.sample { + if width >= 56 { + let rows = [ + ("Bytes", bytes(sample.received_bytes), bytes(sample.sent_bytes)), + ( + "Packets", + sample.received_packets.to_string(), + sample.sent_packets.to_string(), + ), + ]; + // Size to the values, while keeping room for full u64 counters and a + // visible gap even when both numeric columns are filled. + let numeric_width = rows + .iter() + .flat_map(|(_, received, sent)| [received.len(), sent.len()]) + .max() + .unwrap_or(0) + .max(10); + lines.push(Line::from(muted(format!( + "{:<10}{:>numeric_width$} {:>numeric_width$}", + "", "Received", "Sent" + )))); + for (label, received, sent) in rows { + lines.push(Line::from(vec![ + muted(format!("{label:<10}")), + Span::raw(format!("{received:>numeric_width$} {sent:>numeric_width$}")), + ])); + } + } else { + lines.push(row("Received", bytes(sample.received_bytes))); + lines.push(row("Sent", bytes(sample.sent_bytes))); + lines.push(row("Packets in", sample.received_packets.to_string())); + lines.push(row("Packets out", sample.sent_packets.to_string())); + } + if view.state != TunnelStatisticsState::Fresh { + if let Some(age) = view.sample_age_ms { + lines.push(row("Sample age", format!("{} seconds", age / 1000))); + } + } + } + } else { + lines.push(row("Statistics", "unavailable")); + } + paragraph(lines) +} + +fn list_rows(lines: &mut Vec>, label: &str, value: &TunnelList) { + if value.items.is_empty() && !value.truncated { + lines.push(row(label, "none")); + } else { + for (index, item) in value.items.iter().enumerate() { + lines.push(row(if index == 0 { label } else { "" }, item)); + } + if value.truncated { + lines.push(row("", format!("[truncated; {} total]", value.total_count))); + } + } +} + +fn routes(lines: &mut Vec>, label: &str, list: &TunnelList, width: u16) { + lines.push(row(label, list.total_count.to_string())); + // Only whole entries move between columns. Long individual entries wrap through + // Paragraph rather than disappearing off the edge of a narrow terminal. + let entries: Vec<_> = list.items.iter().map(|item| plain_text(item.as_bytes())).collect(); + let cell_width = entries.iter().map(|item| Line::raw(item).width()).max().unwrap_or(0) + 3; + let columns = (width as usize / cell_width).clamp(1, 3); + for chunk in entries.chunks(columns) { + let mut spans = Vec::new(); + for (index, entry) in chunk.iter().enumerate() { + spans.push(Span::raw(entry.clone())); + if index + 1 < chunk.len() { + spans.push(Span::raw(" ".repeat(cell_width - Line::raw(entry).width()))); + } + } + lines.push(Line::from(spans)); + } + if list.truncated { + lines.push(Line::raw(format!( + "[truncated; showing {} of {}]", + list.items.len(), + list.total_count + ))); + } +} + +fn details(state: &TunnelState, statistics: &TunnelStatisticsSnapshot, width: u16) -> Buffer { + let traffic = traffic(statistics, width); + let traffic_height = traffic.line_count(width) as u16; + let mut tunnel = vec![heading("TUNNEL")]; + let mut dns = vec![heading("DNS")]; + let mut route_lines = vec![heading("ROUTES")]; + if let Some(config) = &state.configuration { + tunnel.extend([ + row("Interface", config.interface.as_deref().unwrap_or("none")), + row( + "IPv4", + config + .ipv4 + .as_ref() + .map(|address| address.display()) + .unwrap_or_else(|| "none".into()), + ), + row( + "IPv6", + config + .ipv6 + .as_ref() + .map(|address| address.display()) + .unwrap_or_else(|| "none".into()), + ), + row("Gateway", config.server_ip.as_deref().unwrap_or("none")), + row( + "MTU", + config.mtu.map(|mtu| mtu.to_string()).unwrap_or_else(|| "none".into()), + ), + ]); + list_rows(&mut dns, "Servers", &config.dns); + list_rows(&mut dns, "Domains", &config.search_domains); + list_rows(&mut dns, "Split DNS", &config.split_dns); + routes(&mut route_lines, "Included", &config.included_routes, width); + routes(&mut route_lines, "Excluded", &config.excluded_routes, width); + if config.truncated { + route_lines.push(row("Configuration", "truncated")); + } + } else { + tunnel.push(row("Configuration", "unavailable")); + } + let tunnel = paragraph(tunnel); + let dns = paragraph(dns); + let routes = paragraph(route_lines); + let columns = width >= 88; + let column_width = if columns { (width - 4) / 2 } else { width }; + let tunnel_height = tunnel.line_count(column_width) as u16; + let dns_height = dns.line_count(column_width) as u16; + let network_height = if columns { + tunnel_height.max(dns_height) + } else { + tunnel_height + 1 + dns_height + }; + let network_y = traffic_height + 1; + let routes_y = network_y + network_height + 1; + let height = routes_y + routes.line_count(width) as u16; + let mut buffer = Buffer::empty(Rect::new(0, 0, width, height)); + traffic.render(Rect::new(0, 0, width, traffic_height), &mut buffer); + tunnel.render(Rect::new(0, network_y, column_width, tunnel_height), &mut buffer); + let (dns_x, dns_y) = if columns { + (column_width + 4, network_y) + } else { + (0, network_y + tunnel_height + 1) + }; + dns.render(Rect::new(dns_x, dns_y, column_width, dns_height), &mut buffer); + routes.render(Rect::new(0, routes_y, width, height - routes_y), &mut buffer); + buffer +} + +pub(super) fn render_tunnel( + frame: &mut Frame, + area: Rect, + server: &str, + state: &TunnelState, + statistics: &TunnelStatisticsSnapshot, + scroll: &mut DetailScroll, +) { + if area.is_empty() { + return; + } + let area = Rect { + width: area.width.min(MAX_CONTENT_WIDTH), + ..area + }; + let full_summary = summary(server, state, area.width); + let summary = if full_summary.line_count(area.width) + 2 > area.height as usize { + Paragraph::new(phase_label(state.phase)) + } else { + full_summary + }; + let summary_height = (summary.line_count(area.width) as u16).min(area.height); + frame.render_widget(summary, Rect::new(area.x, area.y, area.width, summary_height)); + let body_y = summary_height.saturating_add(1).min(area.height); + let viewport = Rect::new(area.x, area.y + body_y, area.width, area.height - body_y); + let buffer = details(state, statistics, area.width); + scroll.update(buffer.area.height, viewport.height); + // Render the full detail layout with Ratatui, then expose just the scrolled rows. + // This preserves wrapped fields and aligned columns through terminal resizes. + for y in 0..viewport.height { + if y + scroll.offset >= buffer.area.height { + break; + } + for x in 0..viewport.width { + frame.buffer_mut()[(viewport.x + x, viewport.y + y)] = buffer[(x, y + scroll.offset)].clone(); + } + } +} + +#[cfg(test)] +mod tests { + use gpapi::session::tunnel::{TunnelStatistics, TunnelStatisticsView, TunnelTransport}; + use ratatui::{Terminal, backend::TestBackend}; + + use super::*; + + fn state() -> TunnelState { + serde_json::from_value(serde_json::json!({ + "tunnelId": "00000000-0000-0000-0000-000000000001", + "sequence": "1", "phase": "connected", "configurationRevision": "1", + "transport": "ipsecEsp", "elapsedMs": "177000", + "configuration": { + "interface": "tun0", "serverIp": "220.191.185.154", + "ipv4": {"address": "10.197.121.152", "prefixLength": 32, "netmask": null}, + "ipv6": null, "mtu": 1439, "truncated": false, + "dns": {"items": ["10.197.82.140", "10.15.70.11"], "totalCount": 2, "truncated": false}, + "searchDomains": {"items": ["corp.microstrategy.com"], "totalCount": 1, "truncated": false}, + "splitDns": {"items": [], "totalCount": 0, "truncated": false}, + "includedRoutes": {"items": ["10.15.70.11/32", "10.197.82.140/32", "185.199.108.0/22", "2001:db8:1234:5678::/64"], "totalCount": 5, "truncated": true}, + "excludedRoutes": {"items": ["192.168.0.0/16"], "totalCount": 1, "truncated": false} + } + })).unwrap() + } + + fn statistics(state: &TunnelState) -> TunnelStatisticsSnapshot { + TunnelStatisticsSnapshot::Available(TunnelStatisticsView { + sequence: 1, + tunnel_id: state.tunnel_id, + state_sequence: 1, + phase: state.phase, + transport: TunnelTransport::IpsecEsp, + state: TunnelStatisticsState::Fresh, + elapsed_ms: state.elapsed_ms, + sample_age_ms: Some(0), + sample: Some(TunnelStatistics { + tunnel_id: state.tunnel_id, + sequence: 1, + state_sequence: 1, + configuration_revision: 1, + elapsed_ms: state.elapsed_ms, + received_bytes: 1_258_291, + sent_bytes: 71_578, + received_packets: u64::MAX, + sent_packets: 702, + }), + }) + } + + fn text(buffer: &Buffer) -> String { + (0..buffer.area.height) + .map(|y| { + (0..buffer.area.width) + .map(|x| buffer[(x, y)].symbol()) + .collect::() + .trim_end() + .to_string() + }) + .collect::>() + .join("\n") + } + + #[test] + fn server_and_transport_share_a_column_through_status_changes() { + let mut state = state(); + for width in [40, 64, 120] { + for phase in [ + TunnelPhase::Establishing, + TunnelPhase::Connected, + TunnelPhase::Reconnecting, + TunnelPhase::Ended, + ] { + state.phase = phase; + let mut buffer = Buffer::empty(Rect::new(0, 0, width, 8)); + summary("vpn.example.com", &state, width).render(buffer.area, &mut buffer); + let rendered = text(&buffer); + let server = rendered.lines().find(|line| line.contains("vpn.example.com")).unwrap(); + let transport = rendered.lines().find(|line| line.contains("IPsec (ESP)")).unwrap(); + assert_eq!(server.find("vpn.example.com"), Some(14)); + assert_eq!( + transport.find("IPsec (ESP)"), + server.find("vpn.example.com"), + "{phase:?} at width {width}" + ); + assert!(rendered.lines().any(|line| line.starts_with(phase_label(phase)))); + } + } + } + + #[test] + fn wide_layout_groups_settings_and_keeps_routes_and_counters_intact() { + let state = state(); + let buffer = details(&state, &statistics(&state), 100); + let text = text(&buffer); + let headings = text.lines().find(|line| line.starts_with("TUNNEL")).unwrap(); + assert!(headings.contains("DNS")); + assert!(text.contains("18446744073709551615")); + assert!(text.contains("1.2 MiB")); + assert!(text.contains("69.9 KiB")); + assert!(text.contains("2001:db8:1234:5678::/64")); + assert!(text.contains("[truncated; showing 4 of 5]")); + assert!(text.contains("192.168.0.0/16")); + let received_column = text + .lines() + .find(|line| line.contains("Received")) + .unwrap() + .find("Received") + .unwrap() + + "Received".len(); + let bytes_column = text + .lines() + .find(|line| line.starts_with("Bytes")) + .unwrap() + .find("1.2 MiB") + .unwrap() + + "1.2 MiB".len(); + assert_eq!(received_column, bytes_column); + } + + #[test] + fn traffic_columns_stay_compact_with_a_visible_gap() { + let state = state(); + let mut stats = statistics(&state); + let TunnelStatisticsSnapshot::Available(view) = &mut stats else { + unreachable!() + }; + view.sample.as_mut().unwrap().received_packets = 6518; + let mut buffer = Buffer::empty(Rect::new(0, 0, 120, 4)); + traffic(&stats, 120).render(buffer.area, &mut buffer); + let rendered = text(&buffer); + for line in rendered.lines() { + assert!( + line.len() <= 40, + "traffic row should not expand with the terminal: {line}" + ); + } + let TunnelStatisticsSnapshot::Available(view) = &mut stats else { + unreachable!() + }; + view.sample.as_mut().unwrap().received_packets = u64::MAX; + view.sample.as_mut().unwrap().sent_packets = u64::MAX; + let mut buffer = Buffer::empty(Rect::new(0, 0, 56, 4)); + traffic(&stats, 56).render(buffer.area, &mut buffer); + assert!(text(&buffer).contains("18446744073709551615 18446744073709551615")); + } + + #[test] + fn wide_terminal_keeps_content_left_aligned_and_within_120_columns() { + let state = state(); + let stats = statistics(&state); + let mut terminal = Terminal::new(TestBackend::new(220, 40)).unwrap(); + let mut scroll = DetailScroll::default(); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &stats, &mut scroll)) + .unwrap(); + let wide = terminal.backend().buffer().clone(); + terminal.backend_mut().resize(120, 40); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &stats, &mut scroll)) + .unwrap(); + for y in 0..40 { + for x in 0..220 { + if x < 120 { + assert_eq!(wide[(x, y)], terminal.backend().buffer()[(x, y)]); + } else { + assert_eq!(wide[(x, y)].symbol(), " "); + } + } + } + } + + #[test] + fn routes_use_at_most_three_columns_and_keep_every_entry() { + let list = TunnelList { + items: (1..=7).map(|n| format!("10.0.{n}.0/24")).collect(), + total_count: 7, + truncated: false, + }; + let mut lines = Vec::new(); + routes(&mut lines, "Included", &list, 220); + let mut buffer = Buffer::empty(Rect::new(0, 0, 220, 4)); + paragraph(lines).render(buffer.area, &mut buffer); + let rendered = text(&buffer); + let route_rows: Vec<_> = rendered.lines().skip(1).collect(); + assert_eq!(route_rows.len(), 3); + for line in route_rows { + assert!(line.split_whitespace().count() <= 3); + } + for entry in &list.items { + assert!(rendered.contains(entry)); + } + } + + #[test] + fn narrow_layout_stacks_sections_without_losing_routes() { + let state = state(); + for width in [24, 60, 87] { + let text = text(&details(&state, &statistics(&state), width)); + assert!(text.lines().any(|line| line == "TUNNEL")); + assert!(text.lines().any(|line| line == "DNS")); + assert!(text.contains("2001:db8:1234:5678::/64")); + assert!(text.contains("192.168.0.0/16")); + } + } + + #[test] + fn scrolling_reaches_last_route_and_resize_clamps_offset_with_summary_pinned() { + let state = state(); + let statistics = statistics(&state); + let mut terminal = Terminal::new(TestBackend::new(60, 14)).unwrap(); + let mut scroll = DetailScroll::default(); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &statistics, &mut scroll)) + .unwrap(); + assert!(scroll.can_scroll()); + scroll.handle_key(KeyCode::End); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &statistics, &mut scroll)) + .unwrap(); + let rendered = text(terminal.backend().buffer()); + assert!(rendered.contains("Connected")); + assert!(rendered.contains("vpn.example.com")); + assert!(rendered.contains("192.168.0.0/16")); + terminal.backend_mut().resize(100, 50); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &statistics, &mut scroll)) + .unwrap(); + assert!(!scroll.can_scroll()); + assert_eq!(scroll.offset, 0); + assert!(text(terminal.backend().buffer()).contains("TRAFFIC · live")); + } + + #[test] + fn very_short_body_keeps_status_and_scrollable_details_visible() { + let state = state(); + for (width, height) in [(60, 6), (24, 3)] { + let mut terminal = Terminal::new(TestBackend::new(width, height)).unwrap(); + let mut scroll = DetailScroll::default(); + let stats = statistics(&state); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &stats, &mut scroll)) + .unwrap(); + assert!(text(terminal.backend().buffer()).contains("Connected")); + assert!(text(terminal.backend().buffer()).contains("TRAFFIC")); + scroll.handle_key(KeyCode::End); + terminal + .draw(|frame| render_tunnel(frame, frame.area(), "vpn.example.com", &state, &stats, &mut scroll)) + .unwrap(); + assert!(text(terminal.backend().buffer()).contains("192.168.0.0/16")); + scroll.handle_key(KeyCode::PageUp); + let page_up = scroll.offset; + assert!(page_up < scroll.maximum); + scroll.handle_key(KeyCode::Up); + assert!(scroll.offset < page_up); + scroll.handle_key(KeyCode::Down); + assert_eq!(scroll.offset, page_up); + scroll.handle_key(KeyCode::PageDown); + assert_eq!(scroll.offset, scroll.maximum); + scroll.handle_key(KeyCode::Home); + assert_eq!(scroll.offset, 0); + } + } + + #[test] + fn stale_and_missing_configuration_remain_explicit() { + let mut state = state(); + let mut statistics = statistics(&state); + let TunnelStatisticsSnapshot::Available(view) = &mut statistics else { + unreachable!() + }; + view.state = TunnelStatisticsState::Stale; + view.sample_age_ms = Some(12_000); + state.configuration = None; + let rendered = text(&details(&state, &statistics, 100)); + assert!(rendered.contains("TRAFFIC · stale")); + assert!(rendered.contains("12 seconds")); + assert!(rendered.contains("unavailable")); + assert!(rendered.contains("1.2 MiB")); + } + + #[test] + fn units_and_long_sessions_are_explicit() { + assert_eq!(bytes(1024), "1.0 KiB"); + assert_eq!(bytes(0), "0 B"); + assert_eq!(uptime(90_061_000), "25:01:01"); + } +} diff --git a/apps/gpclient/src/dashboard/mod.rs b/apps/gpclient/src/dashboard/mod.rs new file mode 100644 index 0000000..2ba870b --- /dev/null +++ b/apps/gpclient/src/dashboard/mod.rs @@ -0,0 +1,212 @@ +//! Optional foreground presentation. Connection ownership stays with ConnectHandler. +mod layout; +mod notice; +mod output; +mod restoration; +mod screen; +#[cfg(test)] +mod tests; + +use std::{ + fs::{File, OpenOptions}, + io::IsTerminal, + os::fd::AsRawFd, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + mpsc, + }, + thread::JoinHandle, +}; + +use anyhow::{Context, ensure}; +use gpapi::log_format::LogFormat; +use nix::unistd::{getpgrp, tcgetpgrp}; +use tokio_util::sync::CancellationToken; + +pub(crate) use notice::{NoticeLogger, session_notice}; +use output::OutputRouting; + +pub(crate) type InternalMembers = Arc>>; + +pub(crate) fn validate(format: LogFormat) -> anyhow::Result<()> { + ensure!( + format == LogFormat::Text, + "--dashboard conflicts with --log-format json" + ); + ensure!( + std::env::var_os("TERM").is_some_and(|term| term != "dumb"), + "--dashboard requires a capable terminal (TERM must not be dumb)" + ); + let tty = terminal()?; + ensure!( + std::io::stderr().is_terminal(), + "--dashboard requires stderr attached to the controlling terminal" + ); + let stderr = output::duplicate(2)?; + ensure!( + same_terminal(&stderr, &tty), + "--dashboard requires stderr attached to the controlling terminal" + ); + ensure!( + tcgetpgrp(&tty)? == getpgrp(), + "--dashboard requires a foreground terminal" + ); + Ok(()) +} + +fn terminal() -> anyhow::Result { + OpenOptions::new() + .read(true) + .write(true) + .open("/dev/tty") + .context("--dashboard requires a controlling terminal") +} + +fn same_terminal(first: &File, second: &File) -> bool { + // /dev/tty is a multiplexor node, so its st_rdev differs from the underlying + // PTY. A session has one controlling terminal; compare terminal session IDs. + let first_session = unsafe { nix::libc::tcgetsid(first.as_raw_fd()) }; + let second_session = unsafe { nix::libc::tcgetsid(second.as_raw_fd()) }; + first_session >= 0 && first_session == second_session +} + +pub(super) enum Content { + Tunnel(Arc), + Internal(InternalMembers), +} + +pub(super) enum Command { + Suspend, + Resume, +} + +pub(crate) struct Dashboard { + routing: OutputRouting, + server: String, + cancellation: CancellationToken, + stop: Arc, + worker: Option>, + signals: Vec>, + error: Arc>>, +} + +impl Dashboard { + /// Install before native startup so persistent children inherit captured descriptors. + pub(crate) fn prepare(server: String, cancellation: CancellationToken) -> anyhow::Result { + let capture_stdout = + std::io::stdout().is_terminal() && same_terminal(&output::duplicate(1)?, &output::duplicate(2)?); + Ok(Self { + routing: OutputRouting::install(capture_stdout, cancellation.clone())?, + server, + cancellation, + stop: Arc::default(), + worker: None, + signals: Vec::new(), + error: Arc::default(), + }) + } + + pub(crate) fn start_tunnel(&mut self, monitor: Arc) -> anyhow::Result<()> { + self.start(Content::Tunnel(monitor.clone()))?; + monitor.set_statistics_enabled(true); + Ok(()) + } + + pub(crate) fn start_internal(&mut self, members: InternalMembers) -> anyhow::Result<()> { + self.start(Content::Internal(members)) + } + + fn start(&mut self, content: Content) -> anyhow::Result<()> { + ensure!(self.worker.is_none(), "Dashboard already started"); + let (commands, receiver) = mpsc::channel(); + for (kind, command) in [ + ( + tokio::signal::unix::SignalKind::from_raw(nix::libc::SIGTSTP), + Command::Suspend, + ), + ( + tokio::signal::unix::SignalKind::from_raw(nix::libc::SIGCONT), + Command::Resume, + ), + ] { + let mut signal = tokio::signal::unix::signal(kind)?; + let commands = commands.clone(); + self.signals.push(tokio::spawn(async move { + while signal.recv().await.is_some() { + let command = match command { + Command::Suspend => Command::Suspend, + Command::Resume => Command::Resume, + }; + if commands.send(command).is_err() { + break; + } + } + })); + } + let mut hangup = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::hangup())?; + let cancellation = self.cancellation.clone(); + self.signals.push(tokio::spawn(async move { + if hangup.recv().await.is_some() { + cancellation.cancel(); + } + })); + let (ready, started) = mpsc::sync_channel(1); + let context = screen::Context { + terminal: terminal()?, + output: self.routing.original_error.clone(), + saved_stdout: self.routing.saved_output(), + saved_stdin_flags: self.routing.saved_input_flags(), + history: self.routing.history(), + passthrough: self.routing.passthrough(), + gate: self.routing.gate(), + stop: self.stop.clone(), + cancellation: self.cancellation.clone(), + notice: notice::slot(), + server: self.server.clone(), + content, + commands: receiver, + }; + let error = self.error.clone(); + let cancellation = self.cancellation.clone(); + self.worker = Some(std::thread::Builder::new().name("dashboard".into()).spawn(move || { + let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| screen::run(context, ready))); + let failure = match result { + Ok(Ok(())) => None, + Ok(Err(failure)) => Some(format!("{failure:#}")), + Err(_) => Some("Dashboard renderer panicked".into()), + }; + if let Some(failure) = failure { + *error.lock().unwrap_or_else(|error| error.into_inner()) = Some(failure); + cancellation.cancel(); + } + })?); + started.recv().context("Dashboard stopped during initialization")??; + Ok(()) + } + + /// Called after native shutdown and network cleanup, while capture still drains. + pub(crate) fn finish(&mut self) -> anyhow::Result<()> { + self.stop.store(true, Ordering::Release); + if let Some(worker) = self.worker.take() { + let _ = worker.join(); + } + for signal in self.signals.drain(..) { + signal.abort(); + } + self.routing.restore(); + if let Some(error) = self.routing.take_error() { + anyhow::bail!("Dashboard failed: {error}"); + } + if let Some(error) = self.error.lock().unwrap_or_else(|error| error.into_inner()).take() { + anyhow::bail!("Dashboard failed: {error}"); + } + Ok(()) + } +} + +impl Drop for Dashboard { + fn drop(&mut self) { + let _ = self.finish(); + } +} diff --git a/apps/gpclient/src/dashboard/notice.rs b/apps/gpclient/src/dashboard/notice.rs new file mode 100644 index 0000000..8fdc57e --- /dev/null +++ b/apps/gpclient/src/dashboard/notice.rs @@ -0,0 +1,93 @@ +use std::sync::{Arc, Mutex, OnceLock}; + +use log::{Level, Log}; + +use super::output::plain_text; + +#[derive(Clone)] +pub(super) struct Notice { + pub(super) level: Level, + pub(super) message: String, +} + +pub(super) type NoticeSlot = Arc>>; +static NOTICES: OnceLock = OnceLock::new(); + +pub(super) fn slot() -> NoticeSlot { + NOTICES.get_or_init(Arc::default).clone() +} + +pub(crate) fn session_notice(level: Level, message: &str) { + if let Some(slot) = NOTICES.get() { + let mut end = message.len().min(8192); + while !message.is_char_boundary(end) { + end -= 1; + } + *slot.lock().unwrap_or_else(|error| error.into_inner()) = Some(Notice { + level, + message: plain_text(message[..end].as_bytes()), + }); + } +} + +/// Metadata goes to the notice slot; descriptor capture owns the sole history entry. +pub(crate) struct NoticeLogger { + inner: env_logger::Logger, +} + +impl NoticeLogger { + pub(crate) fn new(inner: env_logger::Logger) -> Self { + let _ = slot(); + Self { inner } + } +} + +impl Log for NoticeLogger { + fn enabled(&self, metadata: &log::Metadata<'_>) -> bool { + self.inner.enabled(metadata) + } + fn log(&self, record: &log::Record<'_>) { + if self.inner.matches(record) { + if record.level() <= Level::Warn { + session_notice(record.level(), &record.args().to_string()); + } + self.inner.log(record); + } + } + fn flush(&self) { + self.inner.flush(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn notice_tap_honors_message_filters_and_keeps_warning_severity() { + let logger = NoticeLogger::new( + env_logger::Builder::new() + .parse_filters("warn/allowed") + .target(env_logger::Target::Pipe(Box::new(std::io::sink()))) + .build(), + ); + session_notice(Level::Info, "previous event"); + logger.log( + &log::Record::builder() + .level(Level::Warn) + .args(format_args!("filtered warning")) + .build(), + ); + assert_eq!(slot().lock().unwrap().as_ref().unwrap().message, "previous event"); + logger.log( + &log::Record::builder() + .level(Level::Warn) + .args(format_args!("allowed warning")) + .build(), + ); + let current = slot(); + let notice = current.lock().unwrap(); + assert_eq!(notice.as_ref().unwrap().level, Level::Warn); + assert_eq!(notice.as_ref().unwrap().message, "allowed warning"); + } +} diff --git a/apps/gpclient/src/dashboard/output.rs b/apps/gpclient/src/dashboard/output.rs new file mode 100644 index 0000000..2d1ced6 --- /dev/null +++ b/apps/gpclient/src/dashboard/output.rs @@ -0,0 +1,338 @@ +//! Own terminal output while the native worker and its children are running. +use std::{ + collections::VecDeque, + fs::File, + io::{self, Read, Write}, + os::fd::{AsFd, FromRawFd}, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + }, + thread::{self, JoinHandle}, + time::{Duration, Instant}, +}; + +use anyhow::Context; +use nix::{ + fcntl::{FcntlArg, FdFlag, OFlag, fcntl}, + poll::{PollFd, PollFlags, poll}, + unistd::{dup2_stderr, dup2_stdout}, +}; +use tokio_util::sync::CancellationToken; + +const MAX_LINES: usize = 2_000; +const MAX_BYTES: usize = 1_048_576; +const MAX_LINE_BYTES: usize = 8_192; + +#[derive(Default)] +pub(super) struct History { + lines: VecDeque, + bytes: usize, + discarded: u64, + partial: [String; 2], +} + +impl History { + fn push(&mut self, line: String) { + self.bytes += line.len(); + self.lines.push_back(line); + while self.lines.len() > MAX_LINES || self.bytes > MAX_BYTES { + if let Some(line) = self.lines.pop_front() { + self.bytes -= line.len(); + self.discarded = self.discarded.saturating_add(1); + } + } + } + + pub(super) fn tail(&self, count: usize) -> Vec { + if count == 0 { + return Vec::new(); + } + let mut lines = Vec::new(); + if self.discarded > 0 { + lines.push(format!("[{} older log lines discarded]", self.discarded)); + } + let partial_count = self.partial.iter().filter(|line| !line.is_empty()).count(); + let retained_count = count.saturating_sub(lines.len() + partial_count); + lines.extend( + self + .lines + .iter() + .skip(self.lines.len().saturating_sub(retained_count)) + .cloned(), + ); + lines.extend(self.partial.iter().filter(|line| !line.is_empty()).cloned()); + lines.truncate(count); + lines + } +} + +pub(super) fn plain_text(bytes: &[u8]) -> String { + String::from_utf8_lossy(&strip_ansi_escapes::strip(bytes)) + .chars() + .filter(|ch| !ch.is_control() || *ch == '\t') + .collect() +} + +struct LineDecoder { + bytes: Vec, + truncated: bool, + stream: usize, +} + +impl LineDecoder { + fn new(stream: usize) -> Self { + Self { + bytes: Vec::new(), + truncated: false, + stream, + } + } + + fn text(&self) -> String { + let suffix = if self.truncated { " [line truncated]" } else { "" }; + format!("{}{suffix}", plain_text(&self.bytes)) + } + + fn ingest(&mut self, bytes: &[u8], history: &mut History) { + for byte in bytes { + if *byte == b'\n' { + history.push(self.text()); + self.bytes.clear(); + self.truncated = false; + } else if self.bytes.len() < MAX_LINE_BYTES { + self.bytes.push(*byte); + } else { + self.truncated = true; + } + } + history.partial[self.stream] = if self.bytes.is_empty() && !self.truncated { + String::new() + } else { + self.text() + }; + } + + fn finish(&mut self, history: &mut History) { + if !self.bytes.is_empty() || self.truncated { + history.push(self.text()); + } + history.partial[self.stream].clear(); + } +} + +/// The duplicate is close-on-exec: helpers inherit the capture pipe, never the renderer. +pub(super) fn duplicate(fd: i32) -> io::Result { + let duplicate = unsafe { nix::libc::fcntl(fd, nix::libc::F_DUPFD_CLOEXEC, 3) }; + if duplicate < 0 { + return Err(io::Error::last_os_error()); + } + Ok(unsafe { File::from_raw_fd(duplicate) }) +} + +pub(super) struct OutputRouting { + pub(super) original_error: Arc, + original_input_flags: FdFlag, + original_output: Option>, + history: Arc>, + passthrough: Arc, + stop: Arc, + readers: Vec>, + gate: Arc>, + error: Arc>>, + restored: bool, +} + +impl OutputRouting { + pub(super) fn install(capture_stdout: bool, cancellation: CancellationToken) -> anyhow::Result { + io::stdout().flush()?; + io::stderr().flush()?; + unsafe { + nix::libc::fflush(std::ptr::null_mut()); + } + let mut routing = Self { + original_error: Arc::new(duplicate(2)?), + original_input_flags: FdFlag::from_bits_truncate(fcntl(io::stdin(), FcntlArg::F_GETFD)?), + original_output: capture_stdout.then(|| duplicate(1).map(Arc::new)).transpose()?, + history: Arc::default(), + passthrough: Arc::new(AtomicBool::new(true)), + stop: Arc::default(), + readers: Vec::new(), + gate: Arc::default(), + error: Arc::default(), + restored: false, + }; + routing.capture(1, routing.original_error.clone(), cancellation.clone())?; + if let Some(original) = routing.original_output.clone() { + routing.capture(0, original, cancellation)?; + } + // Authentication may have initialized Crossterm's global reader with fd 0. + // Keep that descriptor stable, but do not let executed helpers inherit it. + // Script-TUN packet I/O continues through its separate VPNFD socket. + fcntl( + io::stdin(), + FcntlArg::F_SETFD(routing.original_input_flags | FdFlag::FD_CLOEXEC), + )?; + Ok(routing) + } + + fn capture(&mut self, stream: usize, destination: Arc, cancellation: CancellationToken) -> anyhow::Result<()> { + let (reader, writer) = io::pipe()?; + // Polling plus nonblocking reads lets teardown bound inherited pipe lifetimes. + fcntl(&reader, FcntlArg::F_SETFL(OFlag::O_NONBLOCK))?; + let history = self.history.clone(); + let passthrough = self.passthrough.clone(); + let stop = self.stop.clone(); + let gate = self.gate.clone(); + let error = self.error.clone(); + let thread = thread::Builder::new() + .name(format!("dashboard-output-{stream}")) + .spawn(move || { + let mut reader = reader; + let mut decoder = LineDecoder::new(stream); + let mut buffer = [0; 4096]; + let mut deadline = None; + loop { + if stop.load(Ordering::Acquire) && deadline.is_none() { + deadline = Some(Instant::now() + Duration::from_millis(250)); + } + if deadline.is_some_and(|deadline| Instant::now() >= deadline) { + break; + } + let mut descriptors = [PollFd::new(reader.as_fd(), PollFlags::POLLIN)]; + match poll(&mut descriptors, 50u16) { + Ok(0) => { + if deadline.is_some() { + break; + } + continue; + } + Ok(_) => {} + Err(nix::errno::Errno::EINTR) => continue, + Err(failure) => { + *error.lock().unwrap_or_else(|error| error.into_inner()) = + Some(format!("Cannot poll dashboard output: {failure}")); + cancellation.cancel(); + break; + } + } + match reader.read(&mut buffer) { + Ok(0) => break, + Ok(length) => { + { + let _gate = gate.lock().unwrap_or_else(|error| error.into_inner()); + if passthrough.load(Ordering::Acquire) { + if let Err(failure) = (&*destination).write_all(&buffer[..length]) { + *error.lock().unwrap_or_else(|error| error.into_inner()) = + Some(format!("Cannot forward dashboard output: {failure}")); + cancellation.cancel(); + } + } + } + decoder.ingest( + &buffer[..length], + &mut history.lock().unwrap_or_else(|error| error.into_inner()), + ); + } + Err(error) if matches!(error.kind(), io::ErrorKind::WouldBlock | io::ErrorKind::Interrupted) => continue, + Err(failure) => { + *error.lock().unwrap_or_else(|error| error.into_inner()) = + Some(format!("Cannot read dashboard output: {failure}")); + cancellation.cancel(); + break; + } + } + } + decoder.finish(&mut history.lock().unwrap_or_else(|error| error.into_inner())); + }) + .context("Cannot start dashboard output reader")?; + self.readers.push(thread); + if stream == 0 { + dup2_stdout(&writer)?; + } else { + dup2_stderr(&writer)?; + } + Ok(()) + } + + pub(super) fn history(&self) -> Arc> { + self.history.clone() + } + pub(super) fn passthrough(&self) -> Arc { + self.passthrough.clone() + } + pub(super) fn gate(&self) -> Arc> { + self.gate.clone() + } + pub(super) fn saved_output(&self) -> Option> { + self.original_output.clone() + } + pub(super) fn saved_input_flags(&self) -> FdFlag { + self.original_input_flags + } + pub(super) fn take_error(&self) -> Option { + self.error.lock().unwrap_or_else(|error| error.into_inner()).take() + } + + pub(super) fn restore(&mut self) { + if self.restored { + return; + } + let _ = io::stdout().flush(); + let _ = io::stderr().flush(); + unsafe { + nix::libc::fflush(std::ptr::null_mut()); + } + let _ = dup2_stderr(&*self.original_error); + let _ = fcntl(io::stdin(), FcntlArg::F_SETFD(self.original_input_flags)); + if let Some(output) = &self.original_output { + let _ = dup2_stdout(&**output); + } + self.stop.store(true, Ordering::Release); + for reader in self.readers.drain(..) { + let _ = reader.join(); + } + self.restored = true; + } +} + +impl Drop for OutputRouting { + fn drop(&mut self) { + self.restore(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn split_utf8_and_unterminated_lines_are_preserved_without_escape_commands() { + for stream in [0, 1] { + let mut history = History::default(); + let mut decoder = LineDecoder::new(stream); + let bytes = "connected 日本語\x1b[2J\npartial".as_bytes(); + for byte in bytes { + decoder.ingest(&[*byte], &mut history); + } + assert_eq!(history.tail(10), ["connected 日本語", "partial"]); + decoder.finish(&mut history); + assert_eq!(history.tail(10), ["connected 日本語", "partial"]); + } + } + + #[test] + fn hostile_long_lines_and_history_are_bounded() { + let mut history = History::default(); + let mut decoder = LineDecoder::new(0); + decoder.ingest(&vec![b'x'; MAX_LINE_BYTES * 3], &mut history); + decoder.ingest(b"\n", &mut history); + assert!(history.lines[0].ends_with("[line truncated]")); + for _ in 0..MAX_LINES + 10 { + decoder.ingest(b"line\n", &mut history); + } + assert!(history.lines.len() <= MAX_LINES); + assert!(history.bytes <= MAX_BYTES); + assert!(history.tail(10)[0].contains("discarded")); + } +} diff --git a/apps/gpclient/src/dashboard/restoration.rs b/apps/gpclient/src/dashboard/restoration.rs new file mode 100644 index 0000000..bc5a484 --- /dev/null +++ b/apps/gpclient/src/dashboard/restoration.rs @@ -0,0 +1,71 @@ +//! Panic restoration must remain independent of renderer and output-ingestion locks. +use std::{ + fs::File, + io, + os::fd::AsRawFd, + sync::{ + Arc, + atomic::{AtomicBool, Ordering}, + }, +}; + +pub(super) struct TerminalRestoration { + terminal: File, + error: Arc, + output: Option>, + input_flags: nix::fcntl::FdFlag, + termios: nix::libc::termios, + active: AtomicBool, +} + +impl TerminalRestoration { + pub(super) fn install( + terminal: File, + error: Arc, + output: Option>, + input_flags: nix::fcntl::FdFlag, + ) -> io::Result> { + let mut termios = std::mem::MaybeUninit::uninit(); + if unsafe { nix::libc::tcgetattr(terminal.as_raw_fd(), termios.as_mut_ptr()) } != 0 { + return Err(io::Error::last_os_error()); + } + let restoration = Arc::new(Self { + terminal, + error, + output, + input_flags, + termios: unsafe { termios.assume_init() }, + active: AtomicBool::new(false), + }); + let previous = std::panic::take_hook(); + let panic_restoration = restoration.clone(); + std::panic::set_hook(Box::new(move |panic| { + panic_restoration.restore(); + previous(panic); + })); + Ok(restoration) + } + + pub(super) fn arm(&self) { + self.active.store(true, Ordering::Release); + } + pub(super) fn disarm(&self) { + self.active.store(false, Ordering::Release); + } + + pub(super) fn restore(&self) { + if !self.active.swap(false, Ordering::AcqRel) { + return; + } + unsafe { + nix::libc::tcsetattr(self.terminal.as_raw_fd(), nix::libc::TCSANOW, &self.termios); + let sequence = b"\x1b[?25h\x1b[?1049l"; + nix::libc::write(self.error.as_raw_fd(), sequence.as_ptr().cast(), sequence.len()); + nix::libc::dup2(self.error.as_raw_fd(), 2); + nix::libc::fcntl(0, nix::libc::F_SETFD, self.input_flags.bits()); + if let Some(output) = &self.output { + nix::libc::dup2(output.as_raw_fd(), 1); + } + } + } +} diff --git a/apps/gpclient/src/dashboard/screen.rs b/apps/gpclient/src/dashboard/screen.rs new file mode 100644 index 0000000..75f0533 --- /dev/null +++ b/apps/gpclient/src/dashboard/screen.rs @@ -0,0 +1,359 @@ +use std::{ + fs::File, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + mpsc, + }, + time::{Duration, Instant}, +}; + +use anyhow::{Context as _, ensure}; +use crossterm::{ + cursor::Show, + event::{self, Event, KeyCode, KeyEventKind, KeyModifiers}, + execute, + terminal::{EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode}, +}; +use gpapi::session::tunnel::TunnelPhase; +use log::Level; +use nix::unistd::{getpgrp, tcgetpgrp}; +use ratatui::{ + Terminal, + backend::CrosstermBackend, + layout::{Constraint, Layout}, + style::{Color, Modifier, Style}, + text::Line, + widgets::{Block, Borders, Paragraph, Wrap}, +}; +use tokio_util::sync::CancellationToken; + +use super::{ + Command, Content, + layout::{DetailScroll, phase_label, render_tunnel, row}, + notice::{Notice, NoticeSlot}, + output::{History, plain_text}, + restoration::TerminalRestoration, +}; + +pub(super) struct Context { + pub(super) terminal: File, + pub(super) output: Arc, + pub(super) saved_stdout: Option>, + pub(super) saved_stdin_flags: nix::fcntl::FdFlag, + pub(super) history: Arc>, + pub(super) passthrough: Arc, + pub(super) gate: Arc>, + pub(super) stop: Arc, + pub(super) cancellation: CancellationToken, + pub(super) notice: NoticeSlot, + pub(super) server: String, + pub(super) content: Content, + pub(super) commands: mpsc::Receiver, +} + +struct Screen { + terminal: Terminal>, + restore: Arc, + controlling_terminal: File, + passthrough: Arc, + gate: Arc>, + active: bool, +} + +impl Screen { + fn new(context: &Context) -> anyhow::Result { + let restore = TerminalRestoration::install( + context.terminal.try_clone()?, + context.output.clone(), + context.saved_stdout.clone(), + context.saved_stdin_flags, + )?; + let terminal = Terminal::new(CrosstermBackend::new(context.output.try_clone()?))?; + let mut screen = Self { + terminal, + restore, + controlling_terminal: context.terminal.try_clone()?, + passthrough: context.passthrough.clone(), + gate: context.gate.clone(), + active: false, + }; + screen.enter()?; + Ok(screen) + } + + fn enter(&mut self) -> anyhow::Result<()> { + if self.active { + return Ok(()); + } + ensure!( + tcgetpgrp(&self.controlling_terminal)? == getpgrp(), + "Dashboard is no longer in the foreground" + ); + let _gate = self.gate.lock().unwrap_or_else(|error| error.into_inner()); + self.passthrough.store(false, Ordering::Release); + // Arm before changing termios, including partial initialization failures. + self.restore.arm(); + self.active = true; + enable_raw_mode()?; + execute!(self.terminal.backend_mut(), EnterAlternateScreen)?; + // Terminal::clear queries cursor position through process stdout. Fullscreen + // resize clears and resets buffers through our saved terminal backend only. + self.terminal.resize(self.terminal.size()?.into())?; + Ok(()) + } + + fn leave(&mut self) { + if !self.active { + return; + } + let _gate = self.gate.lock().unwrap_or_else(|error| error.into_inner()); + let _ = disable_raw_mode(); + let _ = execute!(self.terminal.backend_mut(), Show, LeaveAlternateScreen); + self.restore.disarm(); + self.passthrough.store(true, Ordering::Release); + self.active = false; + } + + fn suspend(&mut self) { + self.leave(); + // SIGSTOP avoids recursion through our SIGTSTP listener. The shell resumes us. + unsafe { + nix::libc::raise(nix::libc::SIGSTOP); + } + } +} + +impl Drop for Screen { + fn drop(&mut self) { + self.leave(); + } +} + +pub(super) fn run(context: Context, ready: mpsc::SyncSender>) -> anyhow::Result<()> { + let screen = Screen::new(&context); + let mut screen = match screen { + Ok(screen) => { + let _ = ready.send(Ok(())); + screen + } + Err(error) => { + let _ = ready.send(Err(anyhow::anyhow!("{error:#}"))); + return Err(error); + } + }; + let mut logs = false; + let mut scroll = DetailScroll::default(); + let mut next_draw = Instant::now(); + let mut dirty = true; + while !context.stop.load(Ordering::Acquire) { + for command in context.commands.try_iter() { + match command { + Command::Suspend => screen.suspend(), + Command::Resume => {} + } + } + if !screen.active { + if tcgetpgrp(&context.terminal)? == getpgrp() { + screen.enter()?; + } else { + std::thread::sleep(Duration::from_millis(100)); + continue; + } + } + if dirty || Instant::now() >= next_draw { + draw(&mut screen.terminal, &context, logs, &mut scroll)?; + next_draw = Instant::now() + Duration::from_secs(1); + dirty = false; + } + if event::poll(Duration::from_millis(100)).context("Cannot read dashboard input")? { + if let Event::Key(key) = event::read()? { + if key.kind != KeyEventKind::Press { + continue; + } + match key.code { + KeyCode::Tab | KeyCode::BackTab => { + logs = !logs; + dirty = true; + } + KeyCode::Up | KeyCode::Down | KeyCode::PageUp | KeyCode::PageDown | KeyCode::Home | KeyCode::End if !logs => { + scroll.handle_key(key.code); + dirty = true; + } + KeyCode::Char('c') if key.modifiers.contains(KeyModifiers::CONTROL) => { + context.cancellation.cancel(); + dirty = true; + } + KeyCode::Char('z') if key.modifiers.contains(KeyModifiers::CONTROL) => screen.suspend(), + _ => {} + } + } + } + } + Ok(()) +} + +fn draw( + terminal: &mut Terminal>, + context: &Context, + logs: bool, + scroll: &mut DetailScroll, +) -> anyhow::Result<()> { + terminal.draw(|frame| { + let area = frame.area(); + if area.height < 8 || area.width < 24 { + frame.render_widget( + Paragraph::new("GP Connect\nCtrl+C Disconnect").wrap(Wrap { trim: false }), + area, + ); + return; + } + let compact = area.height < 18; + let footer_height = if area.width < 80 { 2 } else { 1 }; + let [header, body, notice, footer] = Layout::vertical([ + Constraint::Length(2), + Constraint::Min(1), + Constraint::Length(if compact { 1 } else { 3 }), + Constraint::Length(footer_height), + ]) + .areas(area); + let view = if logs { "Live logs" } else { "Dashboard" }; + frame.render_widget( + Paragraph::new(format!(" GP Connect · {view}")) + .style(Style::default().fg(Color::Cyan).add_modifier(Modifier::BOLD)) + .block(Block::default().borders(Borders::BOTTOM)), + header, + ); + let mut lines = vec![row("Server", context.server.clone()), Line::default()]; + if logs { + let history = context.history.lock().unwrap_or_else(|error| error.into_inner()); + let tail = history.tail(body.height as usize); + lines = tail.into_iter().map(Line::raw).collect(); + let skip = lines.len().saturating_sub(body.height as usize); + lines.drain(..skip); + } else { + match &context.content { + Content::Tunnel(monitor) => { + render_tunnel( + frame, + body, + &context.server, + &monitor.state(), + &monitor.statistics(), + scroll, + ); + } + Content::Internal(members) => { + lines.push(row("Status", "Internal network session")); + lines.push(Line::raw("Tunnel statistics unavailable (non-tunnel session)")); + lines.push(Line::default()); + lines.extend( + members + .lock() + .unwrap_or_else(|error| error.into_inner()) + .values() + .map(|member| Line::raw(plain_text(member.as_bytes()))), + ); + } + } + } + if logs || matches!(context.content, Content::Internal(_)) { + frame.render_widget(Paragraph::new(lines).wrap(Wrap { trim: false }), body); + } + let current = context.notice.lock().unwrap_or_else(|error| error.into_inner()).clone(); + let current = match &context.content { + Content::Tunnel(monitor) => { + let state = monitor.state(); + Some(notice_for_status(current, state.phase, state.transport)) + } + Content::Internal(_) => current, + }; + if let Some(current) = current { + let color = if current.level <= Level::Warn { + Color::Yellow + } else { + Color::Gray + }; + let block = if compact { + Block::default() + } else { + Block::default().title("Latest event").borders(Borders::TOP) + }; + frame.render_widget( + Paragraph::new(current.message) + .style(Style::default().fg(color)) + .wrap(Wrap { trim: false }) + .block(block), + notice, + ); + } + let ending = if context.cancellation.is_cancelled() { + "Disconnecting…" + } else { + "Ctrl+C Disconnect" + }; + frame.render_widget( + footer_text(logs, ending, scroll.can_scroll(), area.width).style(Style::default().fg(Color::DarkGray)), + footer, + ); + })?; + Ok(()) +} + +fn footer_text(logs: bool, ending: &str, scrollable: bool, width: u16) -> Paragraph<'static> { + let view = if logs { "Dashboard" } else { "Logs" }; + let scrolling = scrollable && !logs; + let text = if width < 80 { + format!("{ending}\nTab {view}{}", if scrolling { " ↑↓ Scroll" } else { "" }) + } else { + format!( + "Tab {view} {ending}{}", + if scrolling { " ↑↓/PgUp/PgDn Scroll" } else { "" } + ) + }; + Paragraph::new(text) +} + +fn notice_for_status( + notice: Option, + phase: TunnelPhase, + transport: gpapi::session::tunnel::TunnelTransport, +) -> Notice { + notice.unwrap_or_else(|| Notice { + level: Level::Info, + message: format!("{} · {}", phase_label(phase), transport.label()), + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn narrow_footer_keeps_disconnect_switch_and_scroll_hints_visible() { + use ratatui::{buffer::Buffer, layout::Rect, widgets::Widget}; + let area = Rect::new(0, 0, 24, 2); + let mut buffer = Buffer::empty(area); + footer_text(false, "Ctrl+C Disconnect", true, area.width).render(area, &mut buffer); + let lines: Vec = (0..2) + .map(|y| (0..24).map(|x| buffer[(x, y)].symbol()).collect()) + .collect(); + assert!(lines[0].contains("Ctrl+C Disconnect")); + assert!(lines[1].contains("Tab Logs")); + assert!(lines[1].contains("↑↓ Scroll")); + } + + #[test] + fn status_transitions_cannot_overwrite_an_existing_warning() { + use gpapi::session::tunnel::TunnelTransport; + let warning = Notice { + level: Level::Warn, + message: "ESP unavailable; using SSL".into(), + }; + let first = notice_for_status(Some(warning), TunnelPhase::Connected, TunnelTransport::SslTls); + let reconnecting = notice_for_status(Some(first), TunnelPhase::Reconnecting, TunnelTransport::Unavailable); + let resumed = notice_for_status(Some(reconnecting), TunnelPhase::Connected, TunnelTransport::IpsecEsp); + assert_eq!(resumed.level, Level::Warn); + assert_eq!(resumed.message, "ESP unavailable; using SSL"); + } +} diff --git a/apps/gpclient/src/dashboard/tests.rs b/apps/gpclient/src/dashboard/tests.rs new file mode 100644 index 0000000..2d3ce97 --- /dev/null +++ b/apps/gpclient/src/dashboard/tests.rs @@ -0,0 +1,456 @@ +//! Terminal integration runs in child test processes so descriptor/signal changes +//! cannot capture another test's output or change its controlling terminal. +use std::{ + fs::File, + io::{self, Read, Write}, + os::unix::process::CommandExt, + process::{Child, Command, Stdio}, + time::{Duration, Instant}, +}; + +use nix::{ + fcntl::{FcntlArg, OFlag, fcntl}, + pty::{Winsize, openpty}, + sys::signal::{Signal, kill}, + unistd::Pid, +}; + +use super::*; + +struct Fixture { + child: Child, + master: File, + slave: File, + output: Vec, +} + +impl Fixture { + fn start(piped: bool) -> Self { + Self::start_mode(if piped { "piped" } else { "terminal" }, piped) + } + + fn start_mode(mode: &str, piped: bool) -> Self { + let mut command = Command::new(std::env::current_exe().unwrap()); + command + .args([ + "--exact", + "dashboard::tests::terminal_fixture", + "--ignored", + "--nocapture", + ]) + .env("GPCLIENT_DASHBOARD_FIXTURE", mode); + Self::spawn(command, piped) + } + + fn spawn(mut command: Command, piped: bool) -> Self { + let pty = openpty( + Some(&Winsize { + ws_row: 40, + ws_col: 100, + ws_xpixel: 0, + ws_ypixel: 0, + }), + None, + ) + .unwrap(); + let master = File::from(pty.master); + let slave = File::from(pty.slave); + fcntl(&master, FcntlArg::F_SETFL(OFlag::O_NONBLOCK)).unwrap(); + command + .env("TERM", "xterm-256color") + .stdin(if piped { + Stdio::piped() + } else { + Stdio::from(slave.try_clone().unwrap()) + }) + .stdout(if piped { + Stdio::piped() + } else { + Stdio::from(slave.try_clone().unwrap()) + }) + .stderr(Stdio::from(slave.try_clone().unwrap())); + unsafe { + command.pre_exec(|| { + if nix::libc::setsid() < 0 { + return Err(io::Error::last_os_error()); + } + if nix::libc::ioctl(2, nix::libc::TIOCSCTTY as _, 0) < 0 { + return Err(io::Error::last_os_error()); + } + let no_core = nix::libc::rlimit { + rlim_cur: 0, + rlim_max: 0, + }; + nix::libc::setrlimit(nix::libc::RLIMIT_CORE, &no_core); + Ok(()) + }); + } + let mut child = command.spawn().unwrap(); + if piped { + child.stdin.take().unwrap().write_all(b"fixture-cookie\n").unwrap(); + } + Self { + child, + master, + slave, + output: Vec::new(), + } + } + + fn drain(&mut self) { + let mut bytes = [0; 8192]; + loop { + match self.master.read(&mut bytes) { + Ok(0) => break, + Ok(length) => self.output.extend_from_slice(&bytes[..length]), + Err(error) if error.kind() == io::ErrorKind::WouldBlock => break, + Err(error) if error.raw_os_error() == Some(nix::libc::EIO) => break, + Err(error) => panic!("PTY read: {error}"), + } + } + } + + fn wait_text(&mut self, text: &str) { + let deadline = Instant::now() + Duration::from_secs(10); + loop { + self.drain(); + let plain = strip_ansi_escapes::strip(&self.output); + if String::from_utf8_lossy(&plain).contains(text) { + return; + } + if let Some(status) = self.child.try_wait().unwrap() { + panic!( + "Fixture exited {status} before {text:?}: {}", + String::from_utf8_lossy(&self.output) + ); + } + assert!( + Instant::now() < deadline, + "Missing {text:?}: {}", + String::from_utf8_lossy(&self.output) + ); + std::thread::sleep(Duration::from_millis(20)); + } + } + + fn finish(&mut self) { + self.wait_text("DASHBOARD_RESTORED"); + let attrs = nix::sys::termios::tcgetattr(&self.slave).unwrap(); + assert!(attrs.local_flags.contains(nix::sys::termios::LocalFlags::ICANON)); + assert!(attrs.local_flags.contains(nix::sys::termios::LocalFlags::ECHO)); + self.master.write_all(b"\n").unwrap(); + let deadline = Instant::now() + Duration::from_secs(10); + loop { + self.drain(); + if let Some(status) = self.child.try_wait().unwrap() { + assert!( + status.success(), + "Fixture failed {status}: {}", + String::from_utf8_lossy(&self.output) + ); + self.drain(); + break; + } + assert!(Instant::now() < deadline, "Fixture did not restore/exit"); + std::thread::sleep(Duration::from_millis(20)); + } + assert!(String::from_utf8_lossy(&self.output).contains("DASHBOARD_RESTORED")); + } +} + +impl Drop for Fixture { + fn drop(&mut self) { + // A failed assertion must not leave a suspended child or its helper alive. + let _ = kill(Pid::from_raw(self.child.id() as i32), Signal::SIGCONT); + let _ = self.child.kill(); + let _ = self.child.wait(); + } +} + +#[test] +fn panel_switches_to_captured_child_logs_and_ctrl_c_restores_terminal() { + let mut fixture = Fixture::start(false); + fixture.wait_text("Internal"); + fixture.master.write_all(b"\t").unwrap(); + fixture.wait_text("Live logs"); + fixture.wait_text("child-stderr-after-entry"); + fixture.master.write_all(b"\x03").unwrap(); + fixture.finish(); +} + +#[test] +fn warning_before_first_tunnel_frame_remains_visible() { + let mut fixture = Fixture::start_mode("tunnel", false); + fixture.wait_text("initial-fallback-warning"); + fixture.master.write_all(b"\x03").unwrap(); + fixture.finish(); +} + +#[test] +fn connected_tunnel_samples_statistics_and_accepts_ctrl_c() { + let mut fixture = Fixture::start_mode("active-tunnel", false); + fixture.wait_text("IPsec"); + fixture.wait_text("(ESP)"); + fixture.wait_text("Received"); + fixture.wait_text("4.0"); + fixture.master.write_all(b"\x03").unwrap(); + fixture.finish(); +} + +#[test] +fn authenticated_terminal_input_remains_usable_after_dashboard_entry() { + let mut fixture = Fixture::start_mode("prompted-tunnel", false); + fixture.wait_text("Received"); + fixture.master.write_all(b"\t").unwrap(); + fixture.wait_text("Live logs"); + fixture.master.write_all(b"\x03").unwrap(); + fixture.finish(); +} + +#[test] +fn piped_credentials_and_stdout_redirection_preserve_their_streams() { + let mut fixture = Fixture::start(true); + fixture.wait_text("Internal"); + fixture.master.write_all(b"\x03").unwrap(); + fixture.finish(); + let mut output = String::new(); + fixture + .child + .stdout + .take() + .unwrap() + .read_to_string(&mut output) + .unwrap(); + assert!(output.contains("redirected-stdout")); + assert!(!output.contains('\x1b')); +} + +#[test] +fn external_termination_and_suspend_resume_restore_terminal() { + let mut fixture = Fixture::start(false); + fixture.wait_text("Internal"); + kill(Pid::from_raw(fixture.child.id() as i32), Signal::SIGTSTP).unwrap(); + let deadline = Instant::now() + Duration::from_secs(5); + loop { + let attrs = nix::sys::termios::tcgetattr(&fixture.slave).unwrap(); + if attrs.local_flags.contains(nix::sys::termios::LocalFlags::ICANON) { + break; + } + assert!(Instant::now() < deadline, "suspend did not restore termios"); + std::thread::sleep(Duration::from_millis(20)); + } + kill(Pid::from_raw(fixture.child.id() as i32), Signal::SIGCONT).unwrap(); + std::thread::sleep(Duration::from_millis(200)); + kill(Pid::from_raw(fixture.child.id() as i32), Signal::SIGTERM).unwrap(); + fixture.finish(); +} + +#[test] +fn actual_panic_hook_restores_terminal_with_panic_abort() { + let dependencies = std::env::current_exe().unwrap().parent().unwrap().to_path_buf(); + let nix = std::fs::read_dir(&dependencies) + .unwrap() + .filter_map(Result::ok) + .map(|entry| entry.path()) + .find(|path| { + path.file_name().unwrap().to_string_lossy().starts_with("libnix-") + && path.extension().is_some_and(|ext| ext == "rlib") + }) + .expect("compiled nix rlib"); + let directory = tempfile::tempdir().unwrap(); + let binary = directory.path().join("dashboard-abort"); + let build = Command::new("rustc") + .args(["--edition=2024", "-C", "panic=abort", "-A", "dead_code"]) + .arg(format!( + "{}/tests/fixtures/dashboard_abort.rs", + env!("CARGO_MANIFEST_DIR") + )) + .arg("--extern") + .arg(format!("nix={}", nix.display())) + .arg("-L") + .arg(format!("dependency={}", dependencies.display())) + .arg("-o") + .arg(&binary) + .output() + .unwrap(); + assert!( + build.status.success(), + "Abort fixture compilation failed: {}", + String::from_utf8_lossy(&build.stderr) + ); + let mut fixture = Fixture::spawn(Command::new(binary), false); + fixture.wait_text("ABORT_FIXTURE_READY"); + fixture.master.write_all(b"x").unwrap(); + fixture.wait_text("ABORT_HOOK_RESTORED"); + let attrs = nix::sys::termios::tcgetattr(&fixture.slave).unwrap(); + assert!(attrs.local_flags.contains(nix::sys::termios::LocalFlags::ICANON)); + assert!(attrs.local_flags.contains(nix::sys::termios::LocalFlags::ECHO)); + fixture.master.write_all(b"\n").unwrap(); + let deadline = Instant::now() + Duration::from_secs(5); + loop { + fixture.drain(); + if let Some(status) = fixture.child.try_wait().unwrap() { + assert!(!status.success(), "panic=abort fixture unexpectedly succeeded"); + break; + } + assert!(Instant::now() < deadline, "abort fixture did not exit"); + std::thread::sleep(Duration::from_millis(20)); + } + fixture.drain(); + assert!(String::from_utf8_lossy(&fixture.output).contains("intentional abort-hook fixture panic")); +} + +#[test] +#[ignore = "runs in an isolated PTY subprocess"] +fn terminal_fixture() { + let mode = std::env::var("GPCLIENT_DASHBOARD_FIXTURE").expect("subprocess fixture only"); + if mode == "active-tunnel" || mode == "prompted-tunnel" { + env_logger::builder() + .filter_level(log::LevelFilter::Info) + .try_init() + .unwrap(); + } + if mode == "piped" { + let mut credentials = String::new(); + std::io::stdin().read_to_string(&mut credentials).unwrap(); + assert_eq!(credentials, "fixture-cookie\n"); + } + validate(LogFormat::Text).unwrap(); + if mode == "prompted-tunnel" { + // Authentication prompts use Crossterm before dashboard output routing. + // Exercise its real global reader initialization while stdin is the TTY. + let _ = crossterm::event::poll(Duration::from_millis(1)).unwrap(); + } + let runtime = tokio::runtime::Runtime::new().unwrap(); + runtime.block_on(async { + let cancellation = CancellationToken::new(); + let signal_cancel = cancellation.clone(); + let signals = tokio::spawn(async move { + gpapi::utils::shutdown_signal().await; + signal_cancel.cancel(); + }); + let input_flags = fcntl(std::io::stdin(), FcntlArg::F_GETFD).unwrap(); + let mut dashboard = Dashboard::prepare("vpn.example.com".into(), cancellation.clone()).unwrap(); + eprintln!("child-stderr-before-entry"); + // Native VPN helpers exec /bin/sh without Rust's standard-fd repair. + let mut child = Command::new("/bin/sh") + .args([ + "-c", + r#" + sleep 1 + if test -t 0; then exit 1; fi + if read -r input 2>/dev/null; then exit 1; fi + printf '%s\n' child-stderr-after-entry >&2 + "#, + ]) + .spawn() + .unwrap(); + let members = InternalMembers::default(); + members + .lock() + .unwrap() + .insert("internal.example.com".into(), "internal.example.com: Healthy".into()); + let mut native = None; + let monitor = if mode == "tunnel" || mode == "active-tunnel" || mode == "prompted-tunnel" { + let vpn = Arc::new( + openconnect::Vpn::builder("vpn.example.com", "fixture-cookie") + .network_configuration_handler(|_| Ok(())) + .build() + .unwrap(), + ); + let monitor = gptunnel::TunnelMonitor::attach(vpn.clone()); + if mode == "active-tunnel" || mode == "prompted-tunnel" { + native = Some(active_native_fixture(vpn, cancellation.clone())); + } + let _ = notice::slot(); + session_notice(log::Level::Warn, "initial-fallback-warning"); + dashboard.start_tunnel(monitor.clone()).unwrap(); + Some(monitor) + } else { + dashboard.start_internal(members).unwrap(); + None + }; + println!("redirected-stdout"); + tokio::time::timeout(Duration::from_secs(15), cancellation.cancelled()) + .await + .unwrap(); + assert!( + child.wait().unwrap().success(), + "helper must not inherit dashboard input" + ); + if let Some(monitor) = monitor { + monitor.stop().await; + } + if let Some(native) = native { + native.join().unwrap(); + } + dashboard.finish().unwrap(); + assert_eq!(fcntl(std::io::stdin(), FcntlArg::F_GETFD).unwrap(), input_flags); + signals.abort(); + eprintln!("DASHBOARD_RESTORED"); + let mut acknowledgement = String::new(); + let mut tty = std::fs::OpenOptions::new().read(true).open("/dev/tty").unwrap(); + use std::io::BufRead; + std::io::BufReader::new(&mut tty) + .read_line(&mut acknowledgement) + .unwrap(); + }); +} + +fn active_native_fixture(vpn: Arc, cancellation: CancellationToken) -> std::thread::JoinHandle<()> { + use std::{ + ffi::{c_int, c_void}, + os::fd::AsRawFd, + os::unix::net::UnixStream, + }; + #[repr(C)] + struct Statistics { + tx_pkts: u64, + tx_bytes: u64, + rx_pkts: u64, + rx_bytes: u64, + } + unsafe extern "C" { + fn vpn_attach_command_pipe(vpn: *mut c_void, fd: c_int) -> c_int; + fn vpn_detach_command_pipe(vpn: *mut c_void); + fn vpn_tunnel_event(vpn: *mut c_void, event: c_int); + fn vpn_tunnel_statistics(vpn: *mut c_void, statistics: *const Statistics); + } + let (sender, mut receiver) = UnixStream::pair().unwrap(); + receiver.set_nonblocking(true).unwrap(); + let pointer = Arc::as_ptr(&vpn).cast_mut().cast(); + // SAFETY: the fixture retains Vpn and both endpoints through detach; event + // numbers and statistics layout match the native bridge used in production. + unsafe { + assert_eq!(vpn_attach_command_pipe(pointer, sender.as_raw_fd()), 0); + vpn_tunnel_event(pointer, 1); + vpn_tunnel_event(pointer, 5); + } + std::thread::spawn(move || { + let pointer = Arc::as_ptr(&vpn).cast_mut().cast(); + let mut command = [0]; + while !cancellation.is_cancelled() { + match receiver.read(&mut command) { + Ok(1) if command[0] == b's' => unsafe { + vpn_tunnel_statistics( + pointer, + &Statistics { + tx_pkts: 2, + tx_bytes: 1024, + rx_pkts: 4, + rx_bytes: 4096, + }, + ); + }, + Err(error) if error.kind() == io::ErrorKind::WouldBlock => std::thread::sleep(Duration::from_millis(10)), + other => panic!("Unexpected native fixture command: {other:?}"), + } + } + // SAFETY: all native observations finish before the retained Vpn is freed. + unsafe { + vpn_detach_command_pipe(pointer); + vpn_tunnel_event(pointer, 7); + } + drop(sender); + }) +} diff --git a/apps/gpclient/src/main.rs b/apps/gpclient/src/main.rs index 1d2790d..571d0a8 100644 --- a/apps/gpclient/src/main.rs +++ b/apps/gpclient/src/main.rs @@ -1,6 +1,7 @@ mod background; mod cli; mod connect; +mod dashboard; mod diagnostics; mod disconnect; mod hip; diff --git a/apps/gpclient/src/session.rs b/apps/gpclient/src/session.rs index ada811a..1e972c4 100644 --- a/apps/gpclient/src/session.rs +++ b/apps/gpclient/src/session.rs @@ -75,6 +75,7 @@ async fn run_session_runtime(session_ctx: SessionContext, mut session_info: Sess tokio::time::sleep(schedule.delay).await; + crate::dashboard::session_notice(Level::Warn, &schedule.message); report(log_format, Level::Warn, &format!("\nWARNING: {}", schedule.message)); if !schedule.should_auto_extend { @@ -90,6 +91,7 @@ async fn run_session_runtime(session_ctx: SessionContext, mut session_info: Sess return; }; + crate::dashboard::session_notice(Level::Info, "Session extended."); report(log_format, Level::Info, "Session extended."); session_info = next_session_info; } diff --git a/apps/gpclient/tests/diagnostics.rs b/apps/gpclient/tests/diagnostics.rs index d953e8a..e1e2b04 100644 --- a/apps/gpclient/tests/diagnostics.rs +++ b/apps/gpclient/tests/diagnostics.rs @@ -30,7 +30,13 @@ async fn embedded_collector_reports_missing_helpers_without_recursing_or_exposin let output = tokio::time::timeout( Duration::from_secs(30), Command::new(env!("CARGO_BIN_EXE_gpclient")) - .args(["--fix-openssl", "diagnostics", "--json", "--output"]) + .args([ + #[cfg(not(target_os = "macos"))] + "--fix-openssl", + "diagnostics", + "--json", + "--output", + ]) .arg(&report_file) .env("PATH", format!("{}:/usr/bin:/bin", bin.display())) .env("GP_AUTH_BINARY", dir.path().join("missing-gpauth")) diff --git a/apps/gpclient/tests/fixtures/dashboard_abort.rs b/apps/gpclient/tests/fixtures/dashboard_abort.rs new file mode 100644 index 0000000..50b174f --- /dev/null +++ b/apps/gpclient/tests/fixtures/dashboard_abort.rs @@ -0,0 +1,33 @@ +//! Compiled by the PTY test with -C panic=abort against the production hook. +#[path = "../../src/dashboard/restoration.rs"] +mod restoration; + +use std::{fs::{File, OpenOptions}, io::{Read, Write}, os::fd::{AsRawFd, FromRawFd}, sync::Arc}; + +fn main() { + let tty = OpenOptions::new().read(true).write(true).open("/dev/tty").unwrap(); + let error = Arc::new(unsafe { File::from_raw_fd(nix::libc::fcntl(2, nix::libc::F_DUPFD_CLOEXEC, 3)) }); + let input_flags = nix::fcntl::FdFlag::from_bits_truncate(unsafe { nix::libc::fcntl(0, nix::libc::F_GETFD) }); + let previous = std::panic::take_hook(); + std::panic::set_hook(Box::new(move |panic| { + assert_eq!(unsafe { nix::libc::fcntl(0, nix::libc::F_GETFD) }, input_flags.bits()); + previous(panic); + eprintln!("ABORT_HOOK_RESTORED"); + let mut acknowledgement = String::new(); + std::io::stdin().read_line(&mut acknowledgement).unwrap(); + })); + let restore = restoration::TerminalRestoration::install(tty.try_clone().unwrap(), error.clone(), None, input_flags).unwrap(); + restore.arm(); + unsafe { nix::libc::fcntl(0, nix::libc::F_SETFD, input_flags.bits() | nix::libc::FD_CLOEXEC); } + let mut termios = std::mem::MaybeUninit::uninit(); + unsafe { + assert_eq!(nix::libc::tcgetattr(tty.as_raw_fd(), termios.as_mut_ptr()), 0); + let mut raw = termios.assume_init(); + nix::libc::cfmakeraw(&mut raw); + assert_eq!(nix::libc::tcsetattr(tty.as_raw_fd(), nix::libc::TCSANOW, &raw), 0); + } + (&*error).write_all(b"\x1b[?1049hABORT_FIXTURE_READY").unwrap(); + let mut trigger = [0]; + (&tty).read_exact(&mut trigger).unwrap(); + panic!("intentional abort-hook fixture panic"); +} diff --git a/apps/gpgui-helper/src-tauri/src/updater.rs b/apps/gpgui-helper/src-tauri/src/updater.rs index 7f16ff4..1fc4748 100644 --- a/apps/gpgui-helper/src-tauri/src/updater.rs +++ b/apps/gpgui-helper/src-tauri/src/updater.rs @@ -250,7 +250,7 @@ async fn run_installer_connection( }; let _ = command.reply.send(result); } - ServerMessage::Event { .. } | ServerMessage::Snapshot { .. } => {} + ServerMessage::Event { .. } | ServerMessage::Snapshot { .. } | ServerMessage::TunnelStatistics { .. } => {} ServerMessage::Attached { .. } => bail!("Service sent a duplicate attach response"), }, Message::Ping(data) => socket.send(Message::Pong(data)).await?, @@ -631,6 +631,7 @@ mod tests { current_revision: 0, snapshot: VpnEnv { vpn_state: VpnState::Disconnected, + tunnel_state: None, vpnc_script: None, auth_executable: String::new(), host_info: HostInfo { diff --git a/apps/gpservice/Cargo.toml b/apps/gpservice/Cargo.toml index 2228bc8..7295693 100644 --- a/apps/gpservice/Cargo.toml +++ b/apps/gpservice/Cargo.toml @@ -8,8 +8,8 @@ license.workspace = true common = { path = "../../crates/common" } gpapi = { path = "../../crates/gpapi", features = ["clap", "logger"] } gphip = { path = "../../crates/gphip" } +gptunnel = { path = "../../crates/gptunnel" } base64.workspace = true -sha256.workspace = true openconnect = { path = "../../crates/openconnect" } clap.workspace = true anyhow.workspace = true @@ -37,3 +37,6 @@ nix = { version = "0.31", features = ["fs", "socket", "user"] } [dev-dependencies] openssl.workspace = true tokio-tungstenite = "0.29" + +[target.'cfg(target_os = "macos")'.dependencies] +gpvpnc = { path = "../../crates/gpvpnc" } diff --git a/apps/gpservice/src/cli.rs b/apps/gpservice/src/cli.rs index 7b256fe..a5573c9 100644 --- a/apps/gpservice/src/cli.rs +++ b/apps/gpservice/src/cli.rs @@ -119,23 +119,13 @@ impl Cli { } else { None }; - let brokered_scripts_dir = if externally_brokered { - let executable = std::env::current_exe().context("Failed to locate the gpservice executable")?; - let contents_dir = executable - .parent() - .and_then(std::path::Path::parent) - .context("gpservice is not inside a macOS application bundle")?; - Some(contents_dir.join("Resources/Scripts")) - } else { - None - }; let (mut vpn_task, lifecycle) = VpnTask::new(vpn_state_tx, externally_brokered, Arc::clone(®istry)); let dispatcher = Arc::new(RequestDispatcher::new( lifecycle.clone(), Arc::clone(&gui_restart_requested), Arc::clone(&redaction), !externally_brokered, - brokered_scripts_dir, + externally_brokered, )); #[cfg(target_os = "macos")] let idle_vpn_state_rx = vpn_state_rx.clone(); diff --git a/apps/gpservice/src/hip_approval.rs b/apps/gpservice/src/hip_approval.rs index 1da7461..e61294d 100644 --- a/apps/gpservice/src/hip_approval.rs +++ b/apps/gpservice/src/hip_approval.rs @@ -7,7 +7,7 @@ use std::{ use anyhow::{Context, ensure}; use base64::{Engine, engine::general_purpose::STANDARD}; -use gpapi::hip::HipApprovalStatus; +use gpapi::{hip::HipApprovalStatus, utils::checksum::sha256_hex}; use serde::{Deserialize, Serialize}; use tempfile::Builder; use uuid::Uuid; @@ -169,7 +169,7 @@ fn install_at( let info = ApprovalInfo { approval_id: approval_id.clone(), owner_uid: approving_uid, - sha256: sha256::digest(contents), + sha256: sha256_hex(contents), original_path, }; let staged = Builder::new().prefix(".install-").tempdir_in(base)?; @@ -232,7 +232,7 @@ fn resolve_at_with_control( } ensure!(!contents.is_empty(), "Approved HIP script is empty"); ensure!( - sha256::digest(&contents) == info.sha256, + sha256_hex(&contents) == info.sha256, "Approved HIP script digest mismatch" ); control.check()?; diff --git a/apps/gpservice/src/request_dispatcher.rs b/apps/gpservice/src/request_dispatcher.rs index c707dd1..2d85772 100644 --- a/apps/gpservice/src/request_dispatcher.rs +++ b/apps/gpservice/src/request_dispatcher.rs @@ -78,16 +78,19 @@ pub struct RequestDispatcher { redaction: Arc, install_lock: Mutex<()>, gui_management_enabled: bool, - brokered_scripts_dir: Option, + externally_brokered: bool, } impl RequestDispatcher { + pub fn subscribe_tunnel(&self) -> tokio::sync::watch::Receiver { + self.lifecycle.subscribe_tunnel() + } pub fn new( lifecycle: crate::vpn_task::LifecycleHandle, gui_restart_requested: Arc, redaction: Arc, gui_management_enabled: bool, - brokered_scripts_dir: Option, + externally_brokered: bool, ) -> Self { Self { lifecycle, @@ -95,7 +98,7 @@ impl RequestDispatcher { redaction, install_lock: Mutex::new(()), gui_management_enabled, - brokered_scripts_dir, + externally_brokered, } } @@ -108,7 +111,7 @@ impl RequestDispatcher { ) -> Result { match request { WsRequest::Connect(request) => { - if let Err(message) = self.validate_connect_paths(&request) { + if let Err(message) = self.validate_connect_request(&request) { return Err(ServiceResult::rejected(ServiceErrorCode::InvalidRequest, message)); } let redaction_values = request @@ -197,12 +200,8 @@ impl RequestDispatcher { desktop_uid, edited_report, } => { - let prepared = crate::vpn_task::prepare_connection( - *request, - self.brokered_scripts_dir.is_some(), - preparation.cancellation(), - ) - .await; + let prepared = + crate::vpn_task::prepare_connection(*request, self.externally_brokered, preparation.cancellation()).await; return match prepared { Ok(connection) => preparation.commit(connection, desktop_uid, edited_report), Err(error) => { @@ -271,19 +270,19 @@ impl RequestDispatcher { | WsRequest::PreviewHipReport(_) | WsRequest::GetHipApprovalStatus { .. } | WsRequest::ReadHipPreviewChunk(_) - | WsRequest::GetLastSubmittedHipReport => { + | WsRequest::GetLastSubmittedHipReport + | WsRequest::SetTunnelStatisticsEnabled { .. } => { unreachable!("session-bound request was already dispatched") } } } - fn validate_connect_paths(&self, request: &gpapi::service::request::ConnectRequest) -> Result<(), &'static str> { - let Some(scripts) = &self.brokered_scripts_dir else { + fn validate_connect_request(&self, request: &gpapi::service::request::ConnectRequest) -> Result<(), &'static str> { + if !self.externally_brokered { return Ok(()); - }; - let expected_script = scripts.join("vpnc-script").to_string_lossy().into_owned(); - if request.args().vpnc_script().as_deref() != Some(expected_script.as_str()) { - return Err("macOS VPN script must be the bundled script"); + } + if request.args().vpnc_script().is_some() { + return Err("macOS does not support custom VPN scripts"); } if matches!( request.args().hip_source(), @@ -520,7 +519,7 @@ mod tests { #[test] fn installs_gui_at_the_supplied_target() { let archive = compressed_gui_archive(b"gui binary"); - let checksum = sha256::try_digest(archive.path()).unwrap(); + let checksum = gpapi::utils::checksum::file_sha256(archive.path()).unwrap(); let output = tempfile::tempdir().unwrap(); let target = output.path().join("gpclient/gpgui"); @@ -549,7 +548,7 @@ mod tests { Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), false, - Some(std::path::PathBuf::from("/app/Contents/Resources/Scripts")), + true, ); let ServiceResult::Rejected(rejection) = dispatcher.dispatch(WsRequest::RestartGui).await else { panic!("brokered mode accepted GUI restart"); @@ -558,9 +557,7 @@ mod tests { let gateway = Gateway::new("Gateway".into(), "vpn.example.com".into()); let info = gpapi::service::vpn_state::ConnectInfo::new("portal.example.com".into(), gateway.clone(), vec![gateway]); - let request = test_request(info) - .with_vpnc_script(Some("/app/Contents/Resources/Scripts/vpnc-script".to_string())) - .with_certificate(Some("/Users/example/client.pem".to_string())); + let request = test_request(info).with_certificate(Some("/Users/example/client.pem".to_string())); let ServiceResult::Rejected(rejection) = dispatcher.dispatch(WsRequest::Connect(Box::new(request))).await else { panic!("brokered mode accepted a root-readable identity path"); }; @@ -568,33 +565,37 @@ mod tests { } #[test] - fn brokered_mode_accepts_only_resource_script_paths() { + fn brokered_mode_rejects_script_overrides() { let dispatcher = RequestDispatcher::new( crate::vpn_task::LifecycleHandle::for_tests(), Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), false, - Some(std::path::PathBuf::from("/app/Contents/Resources/Scripts")), + true, ); let gateway = Gateway::new("Gateway".into(), "vpn.example.com".into()); let info = gpapi::service::vpn_state::ConnectInfo::new("portal.example.com".into(), gateway.clone(), vec![gateway]); - let bundled = - test_request(info.clone()).with_vpnc_script(Some("/app/Contents/Resources/Scripts/vpnc-script".to_string())); - assert_eq!(dispatcher.validate_connect_paths(&bundled), Ok(())); + let embedded = test_request(info.clone()); + assert_eq!(dispatcher.validate_connect_request(&embedded), Ok(())); - let old_layout = test_request(info.clone()).with_vpnc_script(Some("/app/Contents/Helpers/vpnc-script".to_string())); - assert_eq!( - dispatcher.validate_connect_paths(&old_layout), - Err("macOS VPN script must be the bundled script") - ); + for script in [ + "/app/Contents/Resources/Scripts/vpnc-script", + "/tmp/custom-vpnc-script", + "echo untrusted", + "", + ] { + let custom = test_request(info.clone()).with_vpnc_script(Some(script.to_string())); + assert_eq!( + dispatcher.validate_connect_request(&custom), + Err("macOS does not support custom VPN scripts") + ); + } - let custom = test_request(info) - .with_vpnc_script(Some("/app/Contents/Resources/Scripts/vpnc-script".to_string())) - .with_hip_source(gpapi::hip::HipSource::UserScript { - path: "/tmp/hip.sh".into(), - }); + let custom = test_request(info).with_hip_source(gpapi::hip::HipSource::UserScript { + path: "/tmp/hip.sh".into(), + }); assert_eq!( - dispatcher.validate_connect_paths(&custom), + dispatcher.validate_connect_request(&custom), Err("macOS does not support custom HIP scripts") ); } diff --git a/apps/gpservice/src/vpn_script/macos.rs b/apps/gpservice/src/vpn_script/macos.rs new file mode 100644 index 0000000..0f2fb69 --- /dev/null +++ b/apps/gpservice/src/vpn_script/macos.rs @@ -0,0 +1,14 @@ +use gpapi::service::request::ConnectArgs; +use openconnect::{Vpn, VpnBuilder}; + +pub(crate) fn builder(server: &str, cookie: &str, args: &ConnectArgs) -> anyhow::Result { + anyhow::ensure!( + args.vpnc_script().is_none(), + "macOS does not support custom VPN scripts" + ); + Ok( + Vpn::builder(server, cookie).network_configuration_handler(|configuration| { + gpvpnc::macos::configure_network(&configuration.reason, &configuration.environment) + }), + ) +} diff --git a/apps/gpservice/src/vpn_script/mod.rs b/apps/gpservice/src/vpn_script/mod.rs index 756f3ac..5097dc8 100644 --- a/apps/gpservice/src/vpn_script/mod.rs +++ b/apps/gpservice/src/vpn_script/mod.rs @@ -1,7 +1,15 @@ #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] #[path = "privileged_unix.rs"] mod platform; -#[cfg(not(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd")))] +#[cfg(target_os = "macos")] +#[path = "macos.rs"] +mod platform; +#[cfg(not(any( + target_os = "linux", + target_os = "freebsd", + target_os = "openbsd", + target_os = "macos" +)))] #[path = "default.rs"] mod platform; #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd", test))] diff --git a/apps/gpservice/src/vpn_task.rs b/apps/gpservice/src/vpn_task.rs index c97149b..b6989c1 100644 --- a/apps/gpservice/src/vpn_task.rs +++ b/apps/gpservice/src/vpn_task.rs @@ -32,9 +32,20 @@ mod runtime; pub(crate) struct LifecycleHandle { events: mpsc::Sender, admissions: Arc>, + tunnel: watch::Sender, +} + +#[derive(Clone, Default)] +pub(crate) struct TunnelBinding { + pub attempt: u64, + pub monitor: Option>, + pub non_tunnel: bool, } impl LifecycleHandle { + pub fn subscribe_tunnel(&self) -> watch::Receiver { + self.tunnel.subscribe() + } pub fn reserve_connect(&self) -> Result { let mut admissions = self.admissions.lock().expect("VPN lifecycle admissions mutex poisoned"); if admissions.closed { @@ -370,6 +381,10 @@ enum AdmissionPhase { } enum LifecycleEvent { + TunnelMonitor { + attempt: u64, + monitor: Arc, + }, Start { attempt: u64, connection: PreparedConnection, @@ -429,6 +444,7 @@ impl VpnTask { let lifecycle = LifecycleHandle { events: events_tx, admissions: Arc::new(Mutex::new(Admissions::default())), + tunnel: watch::channel(TunnelBinding::default()).0, }; let task = Self { events, @@ -493,6 +509,16 @@ impl VpnTask { async fn handle_event(&mut self, event: LifecycleEvent) { match event { + LifecycleEvent::TunnelMonitor { attempt, monitor } => { + if self.active.as_ref().is_some_and(|active| active.attempt == attempt) { + let non_tunnel = false; + self.lifecycle.tunnel.send_replace(TunnelBinding { + attempt, + monitor: Some(monitor), + non_tunnel, + }); + } + } LifecycleEvent::Start { attempt, connection, @@ -526,6 +552,16 @@ impl VpnTask { session_id: Option, ) { let activated = self.lifecycle.activate_attempt(attempt); + self.lifecycle.tunnel.send_replace(TunnelBinding { + attempt, + monitor: None, + non_tunnel: connection + .request + .plan() + .members() + .iter() + .all(|member| member.authentication.mode() == gpapi::session::SessionMode::NonTunnel), + }); let info = connection.request.info().clone(); let allow_extend_session = connection.request.args().allow_extend_session(); let cancellation = self.lifecycle.attempt_cancellation(attempt); @@ -661,6 +697,12 @@ impl VpnTask { if let Some(session_id) = active.session_id { self.registry.clear_successful_hip_report(session_id); } + if self.lifecycle.tunnel.borrow().monitor.is_none() { + self.lifecycle.tunnel.send_replace(TunnelBinding { + attempt, + ..Default::default() + }); + } if let Some(reason) = active.failure { self.send_state(VpnState::Failed(reason)); self.lifecycle.clear_attempt(attempt); @@ -815,49 +857,22 @@ mod tests { ); } - fn identity_material() -> (openssl::pkey::PKey, openssl::x509::X509) { - use openssl::{ - asn1::Asn1Time, - hash::MessageDigest, - pkey::PKey, - rsa::Rsa, - x509::{X509, X509NameBuilder}, - }; - let key = PKey::from_rsa(Rsa::generate(2048).unwrap()).unwrap(); - let mut name = X509NameBuilder::new().unwrap(); - name.append_entry_by_text("CN", "service-identity-fixture").unwrap(); - let name = name.build(); - let mut certificate = X509::builder().unwrap(); - certificate.set_version(2).unwrap(); - certificate.set_subject_name(&name).unwrap(); - certificate.set_issuer_name(&name).unwrap(); - certificate.set_pubkey(&key).unwrap(); - certificate - .set_not_before(&Asn1Time::days_from_now(0).unwrap()) - .unwrap(); - certificate.set_not_after(&Asn1Time::days_from_now(1).unwrap()).unwrap(); - certificate.sign(&key, MessageDigest::sha256()).unwrap(); - (key, certificate.build()) - } - #[test] fn tunnel_identity_paths_allow_large_files_and_retain_loaded_material() { - let (key, certificate) = identity_material(); + let certificate = include_bytes!("../../../crates/gpapi/tests/files/client-identity/rsa-cert.pem"); + let key = include_bytes!("../../../crates/gpapi/tests/files/client-identity/rsa-pkcs8.pem"); let directory = tempfile::tempdir().unwrap(); let path = directory.path().join("identity.pem"); - let mut pem = certificate.to_pem().unwrap(); - pem.extend(key.private_key_to_pem_pkcs8().unwrap()); + let mut pem = certificate.to_vec(); + pem.extend(key); pem.resize(gpapi::service::request::MAX_CLIENT_IDENTITY_DATA + 1, b'\n'); std::fs::write(&path, pem).unwrap(); let request = identity_request().with_certificate(Some(path.to_str().unwrap().into())); let identity = prepare_identity(request.args(), false).unwrap().unwrap(); std::fs::remove_file(path).unwrap(); - assert_eq!(identity.certificate_data(), certificate.to_pem().unwrap()); + assert_eq!(identity.certificate_data(), certificate); let files = identity.write_files(None).unwrap(); - assert_eq!( - std::fs::read(files.certificate()).unwrap(), - certificate.to_pem().unwrap() - ); + assert_eq!(std::fs::read(files.certificate()).unwrap(), certificate); assert!(files.key().is_some()); } @@ -881,17 +896,8 @@ mod tests { #[test] fn protected_pkcs12_import_retains_password_and_single_file_material() { - use openssl::pkcs12::Pkcs12; - let (key, certificate) = identity_material(); - let password = "service-fixture-password"; - let p12 = Pkcs12::builder() - .name("fixture") - .pkey(&key) - .cert(&certificate) - .build2(password) - .unwrap() - .to_der() - .unwrap(); + let password = "fixture-password"; + let p12 = include_bytes!("../../../crates/gpapi/tests/files/client-identity/modern.p12").to_vec(); let request = identity_request() .with_certificate_data(Some(p12.clone())) .with_key_password(Some(password.into())); diff --git a/apps/gpservice/src/vpn_task/runtime.rs b/apps/gpservice/src/vpn_task/runtime.rs index ac2f606..3b4391e 100644 --- a/apps/gpservice/src/vpn_task/runtime.rs +++ b/apps/gpservice/src/vpn_task/runtime.rs @@ -262,6 +262,18 @@ async fn run_tunnel( if cancellation.is_cancelled() { return; } + let monitor = gptunnel::TunnelMonitor::attach(prepared.vpn.clone()); + if events + .send(LifecycleEvent::TunnelMonitor { + attempt, + monitor: monitor.clone(), + }) + .await + .is_err() + { + monitor.stop().await; + return; + } let vpn = prepared.vpn.clone(); // The native tunnel keeps its reconnect endpoint and cookie current and owns // normal logout. The ledger remains responsible only before native execution. @@ -291,6 +303,7 @@ async fn run_tunnel( Ok(code) => warn!("Tunnel worker exited with status {code}"), Err(error) => warn!("Tunnel worker failed: {error}"), } + monitor.stop().await; } pub(super) fn stop_for_revoked_approval(lifecycle: &LifecycleHandle, cancellation: &CancellationToken) { diff --git a/apps/gpservice/src/ws_connection.rs b/apps/gpservice/src/ws_connection.rs index 937a077..f5f6769 100644 --- a/apps/gpservice/src/ws_connection.rs +++ b/apps/gpservice/src/ws_connection.rs @@ -1,4 +1,11 @@ -use std::{collections::HashSet, sync::Arc, time::Duration}; +use std::{ + collections::HashSet, + sync::{ + Arc, + atomic::{AtomicBool, Ordering}, + }, + time::Duration, +}; use axum::extract::ws::{CloseFrame, Message, Utf8Bytes, WebSocket}; use futures::StreamExt; @@ -34,6 +41,9 @@ pub(crate) struct ConnectionControl { connection_id: Uuid, tx: mpsc::Sender, close_tx: watch::Sender>, + statistics: watch::Sender>, + statistics_enabled: Arc, + committed: Arc, } impl ConnectionControl { @@ -44,6 +54,9 @@ impl ConnectionControl { connection_id, tx, close_tx, + statistics: watch::channel(None).0, + statistics_enabled: Arc::new(AtomicBool::new(false)), + committed: Arc::new(AtomicBool::new(false)), }, close_rx, ) @@ -62,9 +75,43 @@ impl ConnectionControl { } pub fn close(&self, reason: CloseReason) { + self.set_statistics_enabled(false); self.close_tx.send_replace(Some(reason)); } + pub fn mark_committed(&self) { + self.committed.store(true, Ordering::Release); + } + + pub fn is_committed(&self) -> bool { + self.committed.load(Ordering::Acquire) + } + + pub fn statistics_enabled(&self) -> bool { + self.statistics_enabled.load(Ordering::Acquire) + } + + pub fn set_statistics_enabled(&self, enabled: bool) { + self.statistics_enabled.store(enabled, Ordering::Release); + if !enabled { + self.statistics.send_replace(None); + } + } + + pub fn clear_statistics(&self) { + self.statistics.send_replace(None); + } + + pub fn publish_statistics(&self, snapshot: gpapi::session::tunnel::TunnelStatisticsSnapshot) { + if self.statistics_enabled() && !self.is_closed() { + self.statistics.send_replace(Some(snapshot)); + } + } + + pub fn subscribe_statistics(&self) -> watch::Receiver> { + self.statistics.subscribe() + } + pub async fn send_reply(&self, id: Uuid, result: ServiceResult) { let _ = self.tx.send(ConnectionCommand::Reply { id, result }).await; } @@ -96,12 +143,14 @@ impl WsConnection { info!("Authenticated GUI connection {}", control.connection_id()); let mut pending_requests = HashSet::new(); + let mut statistics_rx = control.subscribe_statistics(); let mut heartbeat = tokio::time::interval(Duration::from_secs(1)); let mut last_outbound = Instant::now(); let mut pong_deadline = None; loop { tokio::select! { + biased; command = command_rx.recv() => { let Some(command) = command else { break }; match command { @@ -181,6 +230,16 @@ impl WsConnection { pong_deadline = Some(now + PONG_TIMEOUT); } } + changed = statistics_rx.changed() => { + if changed.is_err() { break; } + let snapshot = statistics_rx.borrow_and_update().clone(); + if control.statistics_enabled() { + if let Some(snapshot) = snapshot { + if send_encrypted(&mut socket, &mut noise, &ServerMessage::TunnelStatistics { snapshot }).await.is_err() { break; } + last_outbound = Instant::now(); + } + } + } } } @@ -341,6 +400,14 @@ async fn handle_client_message( return Err(()); } + if let WsRequest::SetTunnelStatisticsEnabled { enabled } = request { + let result = ctx + .set_statistics_enabled(control, session_id, generation, enabled) + .await; + control.send(ConnectionCommand::Reply { id, result }).map_err(|_| ())?; + return Ok(()); + } + if let WsRequest::StoreEditedHipReportChunk(report) = request { let upload_id = report.upload_id.as_deref().and_then(|id| Uuid::parse_str(id).ok()); let result = if report.upload_id.is_some() && upload_id.is_none() { @@ -596,7 +663,7 @@ mod tests { Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), true, - None, + false, )); let (_state_tx, state_rx) = watch::channel(VpnState::Disconnected); let context = Arc::new(WsServerContext::new( @@ -669,6 +736,23 @@ mod tests { } if id == request_id )); + let statistics_id = Uuid::new_v4(); + let request = ClientMessage::Request { + id: statistics_id, + request: WsRequest::SetTunnelStatisticsEnabled { enabled: true }, + }; + socket + .send(ClientFrame::Binary(noise.encrypt(&request).unwrap().into())) + .await + .unwrap(); + let reply = noise + .decrypt::(&receive_client_binary(&mut socket).await) + .unwrap(); + assert!(matches!(reply, ServerMessage::Reply { + id, + result: ServiceResult::TunnelStatisticsSnapshot(gpapi::session::tunnel::TunnelStatisticsSnapshot::Unavailable { reason: gpapi::session::tunnel::TunnelUnavailableReason::NoTunnel }), + } if id == statistics_id)); + let update_id = Uuid::new_v4(); let update_file = tempfile::NamedTempFile::new().unwrap(); std::fs::write(update_file.path(), b"invalid archive").unwrap(); diff --git a/apps/gpservice/src/ws_server.rs b/apps/gpservice/src/ws_server.rs index 4a07a98..e346c96 100644 --- a/apps/gpservice/src/ws_server.rs +++ b/apps/gpservice/src/ws_server.rs @@ -9,6 +9,7 @@ use gpapi::{ vpn_env::{HostInfo, VpnEnv}, vpn_state::VpnState, }, + session::tunnel::{TunnelStatisticsSnapshot, TunnelUnavailableReason}, utils::lock_file::LockFile, }; use log::{info, warn}; @@ -31,6 +32,28 @@ struct ServiceState { revision: u64, snapshot: VpnEnv, connections: HashMap, + tunnel: crate::vpn_task::TunnelBinding, +} + +impl ServiceState { + fn refresh_demand(&self) { + if let Some(monitor) = &self.tunnel.monitor { + monitor.set_statistics_enabled( + self + .connections + .values() + .any(|connection| connection.statistics_enabled() && !connection.is_closed()), + ); + } + } + + fn snapshot(&self) -> VpnEnv { + let mut snapshot = self.snapshot.clone(); + if let Some(monitor) = &self.tunnel.monitor { + snapshot.tunnel_state = Some(monitor.state()); + } + snapshot + } } pub(crate) struct WsServerContext { @@ -57,6 +80,7 @@ impl WsServerContext { revision: 0, snapshot: build_snapshot(vpn_state_rx.borrow().clone()), connections: HashMap::new(), + tunnel: Default::default(), }), handshake_slots: Arc::new(Semaphore::new(16)), hip_previews: crate::hip_preview::HipPreviews::new(), @@ -91,12 +115,14 @@ impl WsServerContext { let mut state = self.state.lock().await; let prepared = self.registry.prepare_attach(permit)?; + let mut attached = ServerMessage::Attached { + connection_id: control.connection_id(), + current_revision: state.revision, + snapshot: state.snapshot(), + }; + fit_snapshot_message(&mut attached).map_err(|_| SessionError::Unavailable)?; control - .send(ConnectionCommand::Send(ServerMessage::Attached { - connection_id: control.connection_id(), - current_revision: state.revision, - snapshot: state.snapshot.clone(), - })) + .send(ConnectionCommand::Send(attached)) .map_err(|_| SessionError::Unavailable)?; state.connections.insert(control.connection_id(), control); Ok(prepared) @@ -117,42 +143,49 @@ impl WsServerContext { } match self.registry.commit_attach(permit, connection.clone()) { Ok(replaced) => { + connection.mark_committed(); if let Some(replaced) = &replaced { + replaced.set_statistics_enabled(false); state.connections.remove(&replaced.connection_id()); } + state.refresh_demand(); Ok(replaced) } Err(err) => { state.connections.remove(&connection.connection_id()); + state.refresh_demand(); Err(err) } } } pub async fn abandon_connection(&self, connection_id: Uuid) { - self.state.lock().await.connections.remove(&connection_id); + let mut state = self.state.lock().await; + state.connections.remove(&connection_id); + state.refresh_demand(); } pub async fn remove_closed_connections(&self) { - self - .state - .lock() - .await - .connections - .retain(|_, connection| !connection.is_closed()); + let mut state = self.state.lock().await; + state.connections.retain(|_, connection| !connection.is_closed()); + state.refresh_demand(); } pub async fn send_snapshot(&self, control: &ConnectionControl) -> Result<(), ()> { let state = self.state.lock().await; - control.send(ConnectionCommand::Send(ServerMessage::Snapshot { + let mut message = ServerMessage::Snapshot { current_revision: state.revision, - snapshot: state.snapshot.clone(), - })) + snapshot: state.snapshot(), + }; + fit_snapshot_message(&mut message)?; + control.send(ConnectionCommand::Send(message)) } pub async fn remove_connection(&self, connection_id: Uuid, session_id: Uuid, generation: u64) { self.registry.disconnect_if_current(session_id, generation); - self.state.lock().await.connections.remove(&connection_id); + let mut state = self.state.lock().await; + state.connections.remove(&connection_id); + state.refresh_demand(); } pub async fn send_event(&self, event: WsEvent) { @@ -161,6 +194,8 @@ impl WsServerContext { state.snapshot = env.clone(); } else if let WsEvent::VpnState(vpn_state) = &event { state.snapshot.vpn_state = vpn_state.clone(); + } else if let WsEvent::TunnelState(tunnel) = &event { + state.snapshot.tunnel_state = tunnel.clone(); } let Some(revision) = state.revision.checked_add(1) else { @@ -168,6 +203,7 @@ impl WsServerContext { connection.close(CloseReason::InternalError); } state.connections.clear(); + state.refresh_demand(); return; }; state.revision = revision; @@ -186,6 +222,97 @@ impl WsServerContext { false } }); + state.refresh_demand(); + } + + pub async fn set_statistics_enabled( + &self, + control: &ConnectionControl, + session_id: Uuid, + generation: u64, + enabled: bool, + ) -> gpapi::service::transport::ServiceResult { + use gpapi::service::transport::{ServiceErrorCode, ServiceResult}; + let state = self.state.lock().await; + if !control.is_committed() + || control.is_closed() + || !state.connections.contains_key(&control.connection_id()) + || !self.registry.is_current(session_id, generation) + { + return ServiceResult::rejected( + ServiceErrorCode::InvalidRequest, + "Service attachment is no longer active", + ); + } + control.set_statistics_enabled(enabled); + state.refresh_demand(); + let snapshot = match &state.tunnel.monitor { + Some(monitor) => monitor.statistics(), + None => TunnelStatisticsSnapshot::Unavailable { + reason: if state.tunnel.non_tunnel { + TunnelUnavailableReason::NonTunnel + } else { + TunnelUnavailableReason::NoTunnel + }, + }, + }; + ServiceResult::TunnelStatisticsSnapshot(if enabled { snapshot } else { snapshot.disabled() }) + } + + async fn bind_tunnel(&self, binding: crate::vpn_task::TunnelBinding) { + let mut state = self.state.lock().await; + if let Some(previous) = &state.tunnel.monitor { + previous.set_statistics_enabled(false); + } + state.tunnel = binding; + for connection in state.connections.values() { + connection.clear_statistics(); + } + state.refresh_demand(); + let tunnel_state = state.tunnel.monitor.as_ref().map(|monitor| monitor.state()); + drop(state); + self.send_event(WsEvent::TunnelState(tunnel_state)).await; + let state = self.state.lock().await; + let snapshot = match &state.tunnel.monitor { + Some(monitor) => monitor.statistics(), + None => TunnelStatisticsSnapshot::unavailable(if state.tunnel.non_tunnel { + TunnelUnavailableReason::NonTunnel + } else { + TunnelUnavailableReason::NoTunnel + }), + }; + for connection in state.connections.values() { + connection.publish_statistics(snapshot.clone()); + } + } + + async fn publish_tunnel(&self, attempt: u64) { + let state = self.state.lock().await; + if state.tunnel.attempt != attempt { + return; + } + let Some(monitor) = &state.tunnel.monitor else { + return; + }; + let current = monitor.state(); + let changed = state + .snapshot + .tunnel_state + .as_ref() + .is_none_or(|previous| previous.tunnel_id != current.tunnel_id || previous.sequence != current.sequence); + drop(state); + if changed { + self.send_event(WsEvent::TunnelState(Some(current))).await; + } + let state = self.state.lock().await; + if state.tunnel.attempt != attempt { + return; + } + if let Some(monitor) = &state.tunnel.monitor { + for connection in state.connections.values() { + connection.publish_statistics(monitor.statistics()); + } + } } } @@ -240,6 +367,7 @@ impl WsServer { _ = watch_vpn_state(self.vpn_state_rx.clone(), Arc::clone(&self.ctx)) => { info!("VPN state watch task completed"); } + _ = watch_tunnel(self.ctx.dispatcher.subscribe_tunnel(), Arc::clone(&self.ctx)) => {} result = axum::serve(listener, routes::routes(Arc::clone(&self.ctx))) => { if let Err(err) = result { warn!("WS server stopped: {err}"); @@ -264,6 +392,7 @@ impl WsServer { fn build_snapshot(vpn_state: VpnState) -> VpnEnv { VpnEnv { + tunnel_state: None, vpn_state, vpnc_script: find_vpnc_script(), auth_executable: binary_paths::gpauth().to_string_lossy().into_owned(), @@ -273,6 +402,36 @@ fn build_snapshot(vpn_state: VpnState) -> VpnEnv { } } +/// Apply the observation's explicit truncation policy to the space remaining in +/// a complete envelope. Existing host/connection facts are never shortened. +fn fit_snapshot_message(message: &mut ServerMessage) -> Result<(), ()> { + let encoded_size = serde_json::to_vec(&message).map_err(|_| ())?.len(); + let Some(excess) = encoded_size.checked_sub(gpapi::service::transport::MAX_PLAINTEXT) else { + return Ok(()); + }; + if excess == 0 { + return Ok(()); + } + let snapshot = match message { + ServerMessage::Attached { snapshot, .. } | ServerMessage::Snapshot { snapshot, .. } => snapshot, + _ => return Err(()), + }; + let configuration = snapshot + .tunnel_state + .as_mut() + .and_then(|state| state.configuration.as_mut()) + .ok_or(())?; + let configuration_size = serde_json::to_vec(&configuration).map_err(|_| ())?.len(); + let remaining = configuration_size.checked_sub(excess).ok_or(())?; + if !configuration.limit_encoded_size(remaining) { + return Err(()); + } + if serde_json::to_vec(message).map_err(|_| ())?.len() > gpapi::service::transport::MAX_PLAINTEXT { + return Err(()); + } + Ok(()) +} + #[cfg(test)] mod tests { use std::sync::{Arc, atomic::AtomicBool}; @@ -285,6 +444,171 @@ mod tests { use super::*; + fn context() -> (Arc, Arc) { + let registry = Arc::new(SessionRegistry::for_tests(Uuid::new_v4())); + let dispatcher = Arc::new(RequestDispatcher::new( + crate::vpn_task::LifecycleHandle::for_tests(), + Arc::new(AtomicBool::new(false)), + Arc::new(Redaction::new()), + true, + false, + )); + let (_, state_rx) = watch::channel(VpnState::Disconnected); + ( + Arc::new(WsServerContext::new( + env!("CARGO_PKG_VERSION"), + registry.clone(), + dispatcher, + &state_rx, + )), + registry, + ) + } + + async fn attach( + context: &WsServerContext, + registry: &Arc, + ) -> (ConnectionControl, Uuid, u64, mpsc::Receiver) { + let credential = registry.issue(env!("CARGO_PKG_VERSION"), None).unwrap(); + let permit = registry + .begin_handshake( + credential.service_instance_id(), + credential.session_id(), + credential.product_version(), + ) + .unwrap(); + let (tx, mut rx) = mpsc::channel(8); + let (control, _) = ConnectionControl::new(Uuid::new_v4(), tx); + let prepared = context.prepare_connection(&permit, control.clone()).await.unwrap(); + rx.recv().await.unwrap(); + context.commit_connection(&permit, &control).await.unwrap(); + (control, credential.session_id(), prepared.generation, rx) + } + + #[tokio::test] + async fn statistics_demand_is_per_attachment_and_does_not_consume_revisions() { + use gpapi::service::transport::ServiceResult; + use gpapi::session::tunnel::TunnelStatisticsState; + let (context, registry) = context(); + let (a, a_session, a_generation, _a_rx) = attach(&context, ®istry).await; + let (b, b_session, b_generation, _b_rx) = attach(&context, ®istry).await; + let vpn = Arc::new( + openconnect::Vpn::builder("vpn.example.com", "cookie") + .network_configuration_handler(|_| Ok(())) + .build() + .unwrap(), + ); + let monitor = gptunnel::TunnelMonitor::attach(vpn); + context + .bind_tunnel(crate::vpn_task::TunnelBinding { + attempt: 1, + monitor: Some(monitor.clone()), + non_tunnel: false, + }) + .await; + let revision = context.state.lock().await.revision; + for (connection, session, generation) in [(&a, a_session, a_generation), (&b, b_session, b_generation)] { + assert!(matches!( + context + .set_statistics_enabled(connection, session, generation, true) + .await, + ServiceResult::TunnelStatisticsSnapshot(_) + )); + } + assert_eq!( + monitor.statistics().view().unwrap().state, + TunnelStatisticsState::Waiting + ); + let ServiceResult::TunnelStatisticsSnapshot(disabled) = + context.set_statistics_enabled(&b, b_session, b_generation, false).await + else { + panic!("expected snapshot"); + }; + assert_eq!(disabled.view().unwrap().state, TunnelStatisticsState::Disabled); + assert_eq!( + monitor.statistics().view().unwrap().state, + TunnelStatisticsState::Waiting + ); + context + .remove_connection(a.connection_id(), a_session, a_generation) + .await; + assert_eq!( + monitor.statistics().view().unwrap().state, + TunnelStatisticsState::Disabled + ); + assert_eq!(context.state.lock().await.revision, revision); + monitor.stop().await; + } + + #[tokio::test] + async fn sample_slot_coalesces_without_consuming_control_queue_and_disable_clears_it() { + let (context, registry) = context(); + let (control, session, generation, mut commands) = attach(&context, ®istry).await; + context + .set_statistics_enabled(&control, session, generation, true) + .await; + let mut samples = control.subscribe_statistics(); + let snapshot = TunnelStatisticsSnapshot::unavailable(TunnelUnavailableReason::NoTunnel); + for _ in 0..1000 { + control.publish_statistics(snapshot.clone()); + } + assert_eq!(samples.borrow_and_update().as_ref(), Some(&snapshot)); + assert!(commands.try_recv().is_err()); + context + .set_statistics_enabled(&control, session, generation, false) + .await; + assert!(samples.borrow().is_none()); + control.publish_statistics(snapshot); + assert!(samples.borrow().is_none()); + } + + #[test] + fn snapshot_budget_trims_observation_without_changing_existing_metadata() { + use gpapi::session::tunnel::{TunnelConfiguration, TunnelPhase, TunnelState, TunnelTransport}; + let mut snapshot = build_snapshot(VpnState::Disconnected); + let mut configuration = TunnelConfiguration::default(); + configuration.included_routes.items = vec!["r".repeat(1000); 15]; + configuration.included_routes.total_count = 15; + snapshot.tunnel_state = Some(TunnelState { + tunnel_id: Uuid::nil(), + sequence: 4, + phase: TunnelPhase::Connected, + configuration_revision: 1, + configuration: Some(configuration), + transport: TunnelTransport::IpsecEsp, + elapsed_ms: 600_000, + }); + let original_metadata = "a".repeat(52_000); + snapshot.auth_executable = original_metadata.clone(); + let mut message = ServerMessage::Snapshot { + current_revision: 9, + snapshot, + }; + assert!(serde_json::to_vec(&message).unwrap().len() > gpapi::service::transport::MAX_PLAINTEXT); + fit_snapshot_message(&mut message).unwrap(); + assert!(serde_json::to_vec(&message).unwrap().len() <= gpapi::service::transport::MAX_PLAINTEXT); + let ServerMessage::Snapshot { + mut snapshot, + current_revision, + } = message + else { + unreachable!() + }; + assert_eq!(current_revision, 9); + assert_eq!(snapshot.auth_executable, original_metadata); + let configuration = snapshot.tunnel_state.as_ref().unwrap().configuration.as_ref().unwrap(); + assert!(configuration.included_routes.truncated); + assert_eq!(configuration.included_routes.total_count, 15); + snapshot.auth_executable = "a".repeat(gpapi::service::transport::MAX_PLAINTEXT); + assert!( + fit_snapshot_message(&mut ServerMessage::Snapshot { + current_revision: 9, + snapshot + }) + .is_err() + ); + } + #[tokio::test] async fn resync_snapshot_is_ordered_with_state_events() { let registry = Arc::new(SessionRegistry::for_tests(Uuid::new_v4())); @@ -301,7 +625,7 @@ mod tests { Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), true, - None, + false, )); let (_state_tx, state_rx) = watch::channel(VpnState::Disconnected); let context = Arc::new(WsServerContext::new( @@ -351,7 +675,7 @@ mod tests { Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), true, - None, + false, )); let (_state_tx, state_rx) = watch::channel(VpnState::Disconnected); let context = Arc::new(WsServerContext::new( @@ -397,3 +721,32 @@ async fn watch_vpn_state(mut vpn_state_rx: watch::Receiver, ctx: Arc, ctx: Arc) { + loop { + let binding = binding_rx.borrow_and_update().clone(); + let mut updates = binding.monitor.as_ref().map(|monitor| monitor.subscribe()); + let attempt = binding.attempt; + ctx.bind_tunnel(binding).await; + loop { + tokio::select! { + biased; + changed = binding_rx.changed() => { + if changed.is_err() { return; } + break; + } + changed = async { + match &mut updates { + Some(receiver) => receiver.changed().await, + None => std::future::pending().await, + } + } => { + if changed.is_err() { break; } + // Fence an update against a new lifecycle binding already published. + if binding_rx.has_changed().unwrap_or(true) { break; } + ctx.publish_tunnel(attempt).await; + } + } + } + } +} diff --git a/changelog.md b/changelog.md index dd6beb0..6a15b9d 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,18 @@ # Changelog +## 3.0.6 + +### Changed + +- Embedded macOS VPN network configuration and added configuration logs for troubleshooting. + +### Fixed + +- Fixed desktop notifications disappearing immediately on GNOME. +- Corrected the notification sender to GP Connect and clarified update notification titles on Linux and BSD. +- Fixed ESP tunnel setup when a gateway reports a zero address, including load-balanced gateways. +- Removed obsolete OpenConnect package dependencies from the AUR package. + ## 3.0.5 ### Added diff --git a/crates/auth/Cargo.toml b/crates/auth/Cargo.toml index 372e8b7..a227ab2 100644 --- a/crates/auth/Cargo.toml +++ b/crates/auth/Cargo.toml @@ -26,9 +26,11 @@ tauri = { workspace = true, optional = true } regex = { workspace = true, optional = true } tokio-util = { workspace = true, optional = true } html-escape = { version = "0.3", optional = true } +url = { workspace = true, optional = true } [target.'cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))'.dependencies] webkit2gtk = { version = "2", optional = true } +gtk = { version = "0.18", optional = true } [target.'cfg(target_os = "macos")'.dependencies] block2 = { version = "0.6", optional = true } @@ -36,6 +38,7 @@ objc2 = { version = "0.6", optional = true } objc2-app-kit = { version = "0.3", default-features = false, features = ["std", "NSWorkspace", "block2"], optional = true } objc2-foundation = { version = "0.3", optional = true } objc2-web-kit = { version = "0.3", optional = true } +objc2-security = { version = "0.3", default-features = false, features = ["std", "SecBase", "SecTrust", "SecCertificate"], optional = true } [features] browser-auth = [ @@ -54,11 +57,36 @@ webview-auth = [ "dep:regex", "dep:tokio-util", "dep:html-escape", + "dep:url", + "dep:gtk", "dep:webkit2gtk", "dep:block2", "dep:objc2", "dep:objc2-foundation", "dep:objc2-web-kit", + "dep:objc2-security", + "objc2-app-kit/NSAlert", + "dep:objc2-app-kit", + "objc2-app-kit/NSView", + "objc2-app-kit/NSText", + "objc2-app-kit/NSTextView", + "objc2-app-kit/NSTextContainer", + "objc2-app-kit/NSParagraphStyle", + "objc2-app-kit/NSFont", + "objc2-app-kit/NSBox", + "objc2-app-kit/NSButton", + "objc2-app-kit/NSButtonCell", + "objc2-app-kit/NSEvent", + "objc2-app-kit/NSTextField", + "objc2-app-kit/NSProgressIndicator", + "objc2-app-kit/NSColor", + "objc2-app-kit/NSResponder", + "objc2-app-kit/NSAccessibilityProtocols", + "objc2-app-kit/NSWindow", + "objc2-app-kit/NSToolbar", + "objc2-app-kit/NSToolbarItem", + "objc2-app-kit/NSLayoutAnchor", + "objc2-app-kit/NSLayoutConstraint", ] release-devtools = ["webview-auth", "tauri/devtools"] diff --git a/crates/auth/src/browser/browser_auth.rs b/crates/auth/src/browser/browser_auth.rs index 7ea360c..b6b3d81 100644 --- a/crates/auth/src/browser/browser_auth.rs +++ b/crates/auth/src/browser/browser_auth.rs @@ -26,7 +26,7 @@ impl<'a> BrowserAuthenticator<'a> { } pub async fn authenticate(&self) -> anyhow::Result { - let callback_receiver = if is_remote_browser(self.browser) { + let callback_receiver = if is_manual_browser(self.browser) { None } else { ensure_auth_callback_handler()?; @@ -41,7 +41,7 @@ impl<'a> BrowserAuthenticator<'a> { auth_server.serve_request(&auth_request); }); - if is_remote_browser(self.browser) { + if is_manual_browser(self.browser) { info!( r#" @@ -69,7 +69,7 @@ Note that the URL is only valid for a single use. } async fn determine_addr(&self) -> anyhow::Result { - if is_remote_browser(self.browser) { + if is_manual_browser(self.browser) { let local_ip = match self.browser_listen { Some(ip) => ip, None => detect_local_ip().await?, @@ -81,8 +81,8 @@ Note that the URL is only valid for a single use. } } -fn is_remote_browser(browser: &str) -> bool { - browser.eq_ignore_ascii_case("remote") +fn is_manual_browser(browser: &str) -> bool { + browser.eq_ignore_ascii_case("manual") || browser.eq_ignore_ascii_case("remote") } /// Detect the local IP address by creating a UDP socket and connecting to an external address @@ -120,20 +120,24 @@ mod tests { } #[test] - fn browser_remote_remains_auth_specific() { - assert!(is_remote_browser("remote")); - assert!(is_remote_browser("REMOTE")); - assert_ne!(LaunchBrowser::from_name("remote"), LaunchBrowser::Default); + fn browser_manual_remains_auth_specific() { + assert!(is_manual_browser("manual")); + assert!(is_manual_browser("MANUAL")); + assert!(is_manual_browser("remote")); + assert!(is_manual_browser("REMOTE")); + assert_ne!(LaunchBrowser::from_name("manual"), LaunchBrowser::Default); } #[tokio::test] - async fn remote_browser_uses_explicit_listen_address() { + async fn manual_browser_uses_explicit_listen_address() { let listen_ip = "192.168.107.15".parse().unwrap(); - let authenticator = BrowserAuthenticator::new("request", "remote", Some(listen_ip)); + for browser in ["manual", "MANUAL", "remote", "REMOTE"] { + let authenticator = BrowserAuthenticator::new("request", browser, Some(listen_ip)); - assert_eq!( - authenticator.determine_addr().await.unwrap(), - SocketAddr::new(listen_ip, 0) - ); + assert_eq!( + authenticator.determine_addr().await.unwrap(), + SocketAddr::new(listen_ip, 0) + ); + } } } diff --git a/crates/auth/src/webview.rs b/crates/auth/src/webview.rs index 071d14f..24cba82 100644 --- a/crates/auth/src/webview.rs +++ b/crates/auth/src/webview.rs @@ -1,4 +1,7 @@ +mod address_bar; mod auth_messenger; +mod recovery; +mod tls; mod webview_auth; #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] diff --git a/crates/auth/src/webview/address_bar.rs b/crates/auth/src/webview/address_bar.rs new file mode 100644 index 0000000..dbfa124 --- /dev/null +++ b/crates/auth/src/webview/address_bar.rs @@ -0,0 +1,54 @@ +pub const TOOLBAR_HEIGHT: f64 = 40.0; +pub const LOADING_ADDRESS: &str = "Loading sign-in page…"; + +/// Display web addresses with query strings and fragments, but without credentials. +pub fn display_address(uri: Option<&str>) -> String { + let Some(mut url) = uri.and_then(|uri| url::Url::parse(uri).ok()) else { + return LOADING_ADDRESS.to_string(); + }; + if !matches!(url.scheme(), "http" | "https") || url.host_str().is_none() { + return LOADING_ADDRESS.to_string(); + } + + let _ = url.set_username(""); + let _ = url.set_password(None); + url.into() +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn hides_credentials_but_preserves_query_and_fragment() { + assert_eq!( + display_address(Some( + "https://user:secret@login.example:8443/saml?SAMLRequest=secret#token" + )), + "https://login.example:8443/saml?SAMLRequest=secret#token" + ); + } + + #[test] + fn preserves_scheme_host_and_encoded_path() { + assert_eq!( + display_address(Some("http://example.com/a%20b")), + "http://example.com/a%20b" + ); + assert_eq!(display_address(Some("https://[::1]:8443/")), "https://[::1]:8443/"); + } + + #[test] + fn uses_placeholder_for_local_pages_and_callbacks() { + for uri in [ + None, + Some(""), + Some("invalid"), + Some("about:blank"), + Some("data:text/html,secret"), + Some("globalprotectcallback:secret"), + ] { + assert_eq!(display_address(uri), LOADING_ADDRESS); + } + } +} diff --git a/crates/auth/src/webview/auth_messenger.rs b/crates/auth/src/webview/auth_messenger.rs index 379974c..df952c2 100644 --- a/crates/auth/src/webview/auth_messenger.rs +++ b/crates/auth/src/webview/auth_messenger.rs @@ -1,7 +1,9 @@ +use super::tls::TlsFailure; use anyhow::bail; use gpapi::{auth::SamlAuthData, error::AuthDataParseError}; use log::{error, info}; use regex::Regex; +use std::sync::atomic::{AtomicU64, Ordering}; use tokio::sync::{RwLock, mpsc}; use tokio_util::sync::CancellationToken; @@ -14,36 +16,30 @@ pub(crate) enum AuthDataLocation { #[derive(Debug)] pub(crate) enum AuthError { - /// Failed to load page due to TLS error - #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] - TlsError, - /// 1. Found auth data in headers/body but it's invalid - /// 2. Loaded an empty page, failed to load page. etc. + /// A certificate or TLS handshake failure in the native webview. + Tls(TlsFailure), + /// The authentication service returned a temporary failure. + TemporarilyUnavailable, + /// A sign-in request could not be loaded. + LoadFailed(anyhow::Error), + /// Found auth data in headers/body but it's invalid. Invalid(anyhow::Error, AuthDataLocation), - /// No auth data found in headers/body - NotFound(AuthDataLocation), } impl AuthError { pub fn invalid_from_body(err: anyhow::Error) -> Self { Self::Invalid(err, AuthDataLocation::Body) } - - pub fn not_found_in_body() -> Self { - Self::NotFound(AuthDataLocation::Body) - } -} - -#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] -impl AuthError { - pub fn not_found_in_headers() -> Self { - Self::NotFound(AuthDataLocation::Headers) - } } pub(crate) enum AuthEvent { - Data(SamlAuthData, AuthDataLocation), - Error(AuthError), + Data(u64, SamlAuthData, AuthDataLocation), + Error(u64, AuthError), + NoAuthData(u64, AuthDataLocation), + PageLoaded(u64), + Retry, + RequestTlsException, + TlsAccepted(u64), RaiseWindow, Close, } @@ -52,6 +48,7 @@ pub struct AuthMessenger { tx: mpsc::UnboundedSender, rx: RwLock>, raise_window_cancel_token: RwLock>, + generation: AtomicU64, } impl AuthMessenger { @@ -62,6 +59,7 @@ impl AuthMessenger { tx, rx: RwLock::new(rx), raise_window_cancel_token: Default::default(), + generation: AtomicU64::new(0), } } @@ -79,12 +77,12 @@ impl AuthMessenger { } } - pub fn send_auth_error(&self, err: AuthError) { - self.send_auth_event(AuthEvent::Error(err)); + pub fn generation(&self) -> u64 { + self.generation.load(Ordering::SeqCst) } - fn send_auth_data(&self, data: SamlAuthData, location: AuthDataLocation) { - self.send_auth_event(AuthEvent::Data(data, location)); + pub fn begin_attempt(&self) { + self.generation.fetch_add(1, Ordering::SeqCst); } pub fn schedule_raise_window(&self, delay: u64) { @@ -132,9 +130,9 @@ impl AuthMessenger { } } - pub fn read_from_html(&self, html: &str) { + pub fn read_from_html(&self, html: &str, generation: u64) { if html.contains("Temporarily Unavailable") { - return self.send_auth_error(AuthError::invalid_from_body(anyhow::anyhow!("Temporarily Unavailable"))); + return self.send_auth_event(AuthEvent::Error(generation, AuthError::TemporarilyUnavailable)); } let auth_result = SamlAuthData::from_html(html).or_else(|err| { @@ -149,18 +147,20 @@ impl AuthMessenger { }); match auth_result { - Ok(data) => self.send_auth_data(data, AuthDataLocation::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())), + Ok(data) => self.send_auth_event(AuthEvent::Data(generation, data, AuthDataLocation::Body)), + Err(AuthDataParseError::NotFound) => { + self.send_auth_event(AuthEvent::NoAuthData(generation, AuthDataLocation::Body)) + } + Err(err) => self.send_auth_event(AuthEvent::Error(generation, AuthError::invalid_from_body(err.into()))), } } #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] - pub fn read_from_response(&self, auth_response: &impl super::webview_auth::GetHeader) { + pub fn read_from_response(&self, auth_response: &impl super::webview_auth::GetHeader, generation: u64) { use log::warn; let Some(status) = auth_response.get_header("saml-auth-status") else { - return self.send_auth_error(AuthError::not_found_in_headers()); + return self.send_auth_event(AuthEvent::NoAuthData(generation, AuthDataLocation::Headers)); }; // Do not send auth error when reading from headers, as the html body may contain the auth data @@ -174,7 +174,7 @@ impl AuthMessenger { let portal_userauthcookie = auth_response.get_header("portal-userauthcookie"); match SamlAuthData::new(username, prelogin_cookie, portal_userauthcookie) { - Ok(auth_data) => self.send_auth_data(auth_data, AuthDataLocation::Headers), + Ok(auth_data) => self.send_auth_event(AuthEvent::Data(generation, auth_data, AuthDataLocation::Headers)), Err(err) => { warn!("Failed to read auth data from headers: {}", err); } @@ -193,6 +193,43 @@ fn extract_gpcallback(html: &str) -> Option { mod tests { use super::*; + #[tokio::test] + async fn ordinary_sign_in_page_is_an_observation_with_its_original_generation() { + let messenger = AuthMessenger::new(); + messenger.read_from_html("

Sign in

", 7); + assert!(matches!( + messenger.subscribe().await.unwrap(), + AuthEvent::NoAuthData(7, AuthDataLocation::Body) + )); + } + + #[tokio::test] + async fn distinguishes_temporary_failure_from_rejected_authentication() { + let messenger = AuthMessenger::new(); + messenger.read_from_html("Temporarily Unavailable", 0); + assert!(matches!( + messenger.subscribe().await.unwrap(), + AuthEvent::Error(0, AuthError::TemporarilyUnavailable) + )); + messenger.read_from_html("0", 0); + assert!(matches!( + messenger.subscribe().await.unwrap(), + AuthEvent::Error(0, AuthError::Invalid(..)) + )); + } + + #[tokio::test] + async fn html_callbacks_keep_the_generation_that_started_the_read() { + let messenger = AuthMessenger::new(); + let generation = messenger.generation(); + messenger.begin_attempt(); + messenger.read_from_html("Temporarily Unavailable", generation); + match messenger.subscribe().await.unwrap() { + AuthEvent::Error(generation, _) => assert_ne!(generation, messenger.generation()), + _ => panic!("Expected an authentication error"), + } + } + #[test] fn extract_gpcallback_some() { let html = r#" diff --git a/crates/auth/src/webview/gtk.rs b/crates/auth/src/webview/gtk.rs index a907613..6928351 100644 --- a/crates/auth/src/webview/gtk.rs +++ b/crates/auth/src/webview/gtk.rs @@ -1,8 +1,9 @@ -use std::sync::Arc; +use std::{cell::Cell, rc::Rc, sync::Arc}; -use anyhow::bail; +use anyhow::{Context, bail}; use gpapi::utils::redact::redact_uri; -use log::warn; +use gtk::prelude::*; +use log::{info, warn}; use tauri::webview::PlatformWebview; use webkit2gtk::{ LoadEvent, SettingsExt, TLSErrorsPolicy, URIResponseExt, WebResource, WebResourceExt, WebViewExt, @@ -10,10 +11,26 @@ use webkit2gtk::{ }; use super::{ - auth_messenger::AuthError, + auth_messenger::{AuthError, AuthEvent, AuthMessenger}, + recovery::RecoveryStatus, webview_auth::{GetHeader, PlatformWebviewExt}, }; +#[path = "gtk_recovery.rs"] +mod recovery_row; +#[path = "gtk_tls.rs"] +mod tls; + +fn action_button(label: &str) -> anyhow::Result { + let button = gtk::Button::with_label(label); + let spacing = gtk::CssProvider::new(); + spacing.load_from_data(b"button { padding: 4px 12px; }")?; + button + .style_context() + .add_provider(&spacing, gtk::STYLE_PROVIDER_PRIORITY_APPLICATION); + Ok(button) +} + impl GetHeader for WebResource { fn get_header(&self, key: &str) -> Option { self @@ -25,6 +42,62 @@ impl GetHeader for WebResource { } impl PlatformWebviewExt for PlatformWebview { + fn install_auth_controls(&self, window: &tauri::WebviewWindow, messenger: Arc) -> anyhow::Result<()> { + use super::address_bar::display_address; + + let entry = gtk::Entry::new(); + entry.set_editable(false); + entry.set_can_focus(true); + entry.set_direction(gtk::TextDirection::Ltr); + entry.set_text(&display_address(self.inner().uri().as_deref())); + let header = gtk::Box::new(gtk::Orientation::Vertical, 4); + header.style_context().add_class(gtk::STYLE_CLASS_TOOLBAR); + header.style_context().add_class(gtk::STYLE_CLASS_PRIMARY_TOOLBAR); + header.style_context().add_class("gpauth-header"); + // One native header owns the outer padding and the gap between its rows. + // Keep theme colors, borders, focus styling, and natural button sizes. + let spacing = gtk::CssProvider::new(); + spacing.load_from_data(b".gpauth-header { padding: 6px; } entry { min-height: 22px; padding: 2px 6px; }")?; + entry + .style_context() + .add_provider(&spacing, gtk::STYLE_PROVIDER_PRIORITY_APPLICATION); + header + .style_context() + .add_provider(&spacing, gtk::STYLE_PROVIDER_PRIORITY_APPLICATION); + header.pack_start(&entry, false, false, 0); + header.show_all(); + recovery_row::install(&self.inner(), &header, Arc::clone(&messenger))?; + let container = window.default_vbox()?; + container.pack_start(&header, false, false, 0); + container.reorder_child(&header, 0); + let separator = gtk::Separator::new(gtk::Orientation::Horizontal); + container.pack_start(&separator, false, false, 0); + container.reorder_child(&separator, 1); + separator.show(); + + // Observe the top-level URI, including redirects and history API changes. + let address = entry.clone(); + self.inner().connect_uri_notify(move |webview| { + address.set_text(&display_address(webview.uri().as_deref())); + address.set_position(0); + }); + tls::install(&self.inner(), Arc::clone(&messenger)); + install_navigation_observers(&self.inner(), messenger, entry); + Ok(()) + } + + fn set_recovery_status(&self, status: RecoveryStatus) -> anyhow::Result<()> { + recovery_row::update(&self.inner(), status) + } + + fn stop_loading(&self) { + self.inner().stop_loading(); + } + + fn confirm_tls_exception(&self) -> anyhow::Result<()> { + tls::confirm(&self.inner()) + } + fn ignore_tls_errors(&self) -> anyhow::Result<()> { if let Some(manager) = self.inner().website_data_manager() { manager.set_tls_errors_policy(TLSErrorsPolicy::Ignore); @@ -34,7 +107,7 @@ impl PlatformWebviewExt for PlatformWebview { } fn user_agent(&self) -> anyhow::Result { - let Some(settings) = self.inner().settings() else { + let Some(settings) = WebViewExt::settings(&self.inner()) else { bail!("Failed to get webview settings"); }; @@ -45,7 +118,7 @@ impl PlatformWebviewExt for PlatformWebview { } fn set_user_agent(&self, user_agent: &str) -> anyhow::Result<()> { - let Some(settings) = self.inner().settings() else { + let Some(settings) = WebViewExt::settings(&self.inner()) else { bail!("Failed to get webview settings"); }; @@ -54,72 +127,188 @@ impl PlatformWebviewExt for PlatformWebview { } fn load_url(&self, url: &str) -> anyhow::Result<()> { + prepare_navigation(&self.inner())?; self.inner().load_uri(url); Ok(()) } fn load_html(&self, html: &str) -> anyhow::Result<()> { + prepare_navigation(&self.inner())?; self.inner().load_html(html, None); Ok(()) } +} - fn get_html(&self, callback: Box) + 'static>) { - let script = "document.documentElement.outerHTML"; - self - .inner() - .evaluate_javascript(script, None, None, Cancellable::NONE, move |result| match result { - Ok(value) => callback(Ok(value.to_string())), - Err(err) => callback(Err(anyhow::anyhow!(err))), - }); +const NAVIGATION_KEY: &str = "gpauth-navigation"; + +#[derive(Default)] +struct NavigationAttempts { + pending: Cell>, + current: Cell>, +} + +impl NavigationAttempts { + fn started(&self, generation: u64) { + self.current.set(Some(self.pending.take().unwrap_or(generation))); } } -pub trait PlatformWebviewOnResponse { - fn on_response(&self, callback: Box) + 'static>); +struct NavigationObserver { + attempts: NavigationAttempts, + messenger: Arc, } -impl PlatformWebviewOnResponse for PlatformWebview { - fn on_response(&self, callback: Box) + 'static>) { - let wv = self.inner(); - let callback = Arc::new(callback); - let callback_clone = Arc::clone(&callback); +fn prepare_navigation(webview: &webkit2gtk::WebView) -> anyhow::Result<()> { + let observer = + unsafe { webview.data::>(NAVIGATION_KEY) }.context("Navigation observer is unavailable")?; + let observer = unsafe { observer.as_ref() }; + observer.attempts.pending.set(Some(observer.messenger.generation())); + Ok(()) +} - wv.connect_load_changed(move |wv, event| { - if event != LoadEvent::Finished { - return; +fn install_navigation_observers(webview: &webkit2gtk::WebView, messenger: Arc, address: gtk::Entry) { + let observer = Rc::new(NavigationObserver { + attempts: NavigationAttempts::default(), + messenger, + }); + unsafe { + webview.set_data(NAVIGATION_KEY, Rc::clone(&observer)); + } + let loading = Rc::clone(&observer); + webview.connect_load_changed(move |webview, event| { + match event { + LoadEvent::Started => { + loading.attempts.started(loading.messenger.generation()); + loading.messenger.cancel_raise_window(); } - - let Some(web_resource) = wv.main_resource() else { - return; - }; - - let uri = web_resource.uri().unwrap_or("".into()); - if uri.is_empty() { - callback_clone(Err(AuthError::invalid_from_body(anyhow::anyhow!("Empty URI")))); - } else { - callback_clone(Ok(web_resource)); + LoadEvent::Committed => { + if let Some(generation) = loading.attempts.current.get() { + info!( + "Started loading page: {}", + redact_uri(webview.uri().as_deref().unwrap_or_default()) + ); + read_navigation_html(webview, Arc::clone(&loading.messenger), generation); + } } - }); - - wv.connect_load_failed_with_tls_errors(move |_wv, uri, cert, err| { - let redacted_uri = redact_uri(uri); - warn!( - "Failed to load uri: {} with error: {}, cert: {}", - redacted_uri, err, cert - ); - - callback(Err(AuthError::TlsError)); - true - }); - - wv.connect_load_failed(move |_wv, _event, uri, err| { - let redacted_uri = redact_uri(uri); - if !uri.starts_with("globalprotectcallback:") { - warn!("Failed to load uri: {} with error: {}", redacted_uri, err); + LoadEvent::Finished => { + // WebKitGTK finishes a cancelled load before starting its replacement. + // Retain that load's generation instead of relabeling it at callback time. + let Some(generation) = loading.attempts.current.take() else { + return; + }; + info!( + "Finished loading page: {}", + redact_uri(webview.uri().as_deref().unwrap_or_default()) + ); + read_navigation_html(webview, Arc::clone(&loading.messenger), generation); + if let Some(resource) = webview.main_resource() { + let uri = resource.uri().unwrap_or_default(); + if uri.is_empty() { + loading.messenger.send_auth_event(AuthEvent::Error( + generation, + AuthError::invalid_from_body(anyhow::anyhow!("Empty URI")), + )); + } else { + loading.messenger.read_from_response(&resource, generation); + } + } + loading.messenger.send_auth_event(AuthEvent::PageLoaded(generation)); } - // NOTE: Don't send error here, since load_changed event will be triggered after this - // true to stop other handlers from being invoked for the event. false to propagate the event further. - true - }); + _ => {} + } + }); + + let tls = Rc::clone(&observer); + let tls_address = address.clone(); + webview.connect_load_failed_with_tls_errors(move |webview, uri, cert, err| { + warn!( + "Failed to load uri: {} with error: {}, cert: {}", + redact_uri(uri), + err, + cert + ); + if let Some(generation) = tls.attempts.current.take() { + if generation != tls.messenger.generation() { + return true; + } + show_failed_address(&tls_address, uri); + let failure = tls::record_failure(webview, uri, cert, err, generation); + tls + .messenger + .send_auth_event(AuthEvent::Error(generation, AuthError::Tls(failure))); + } + true + }); + + webview.connect_load_failed(move |_webview, _event, uri, err| { + if let Some(generation) = observer.attempts.current.take() { + if generation != observer.messenger.generation() { + return true; + } + if !uri.starts_with("globalprotectcallback:") && !err.matches(webkit2gtk::NetworkError::Cancelled) { + warn!("Failed to load uri: {} with error: {}", redact_uri(uri), err); + show_failed_address(&address, uri); + let error = if err.kind::().is_some() { + AuthError::Tls(super::tls::TlsFailure { + host: url::Url::parse(uri) + .ok() + .and_then(|uri| uri.host_str().map(str::to_owned)) + .unwrap_or_default(), + reason: super::tls::TlsFailureReason::Handshake, + can_continue: false, + }) + } else { + AuthError::LoadFailed(anyhow::anyhow!("{}", err)) + }; + observer.messenger.send_auth_event(AuthEvent::Error(generation, error)); + } + } + true + }); +} + +// A failed provisional load may leave WebView.uri unset. +fn show_failed_address(entry: >k::Entry, uri: &str) { + entry.set_text(&super::address_bar::display_address(Some(uri))); + entry.set_position(0); +} + +fn read_navigation_html(webview: &webkit2gtk::WebView, messenger: Arc, generation: u64) { + webview.evaluate_javascript( + "document.documentElement.outerHTML", + None, + None, + Cancellable::NONE, + move |result| match result { + Ok(value) => messenger.read_from_html(&value.to_string(), generation), + Err(err) => warn!("Failed to get html: {}", err), + }, + ); +} + +#[cfg(test)] +mod tests { + use super::NavigationAttempts; + + #[test] + fn cancelled_load_keeps_its_generation_until_replacement_starts() { + let attempts = NavigationAttempts::default(); + attempts.started(0); + attempts.pending.set(Some(2)); + // The previous load's cancellation/finish arrives after retry generation advances. + assert_eq!(attempts.current.take(), Some(0)); + attempts.started(2); + assert_eq!(attempts.current.take(), Some(2)); + } + + #[test] + fn requested_generation_survives_attempt_changes_before_native_start() { + let attempts = NavigationAttempts::default(); + attempts.pending.set(Some(2)); + attempts.started(3); + assert_eq!(attempts.current.take(), Some(2)); + // User navigation after that load starts in the current attempt. + attempts.started(3); + assert_eq!(attempts.current.take(), Some(3)); } } diff --git a/crates/auth/src/webview/gtk_recovery.rs b/crates/auth/src/webview/gtk_recovery.rs new file mode 100644 index 0000000..8a3876e --- /dev/null +++ b/crates/auth/src/webview/gtk_recovery.rs @@ -0,0 +1,103 @@ +use std::sync::Arc; + +use anyhow::Context; +use gtk::prelude::*; +use webkit2gtk::WebView; + +use super::super::{ + auth_messenger::{AuthEvent, AuthMessenger}, + recovery::RecoveryStatus, +}; + +const CONTROLS_KEY: &str = "gpauth-recovery-controls"; + +struct RecoveryRow { + row: gtk::Box, + spinner: gtk::Spinner, + label: gtk::Label, + retry: gtk::Button, + proceed: gtk::Button, + cancel: gtk::Button, + detail: gtk::Label, +} + +pub(super) fn install(webview: &WebView, header: >k::Box, messenger: Arc) -> anyhow::Result<()> { + let row = gtk::Box::new(gtk::Orientation::Horizontal, 8); + // Align status text with the address text's 6px inset and native 1px border. + row.set_margin_start(7); + let spinner = gtk::Spinner::new(); + spinner.set_valign(gtk::Align::Center); + let label = gtk::Label::new(None); + label.set_xalign(0.0); + label.set_ellipsize(gtk::pango::EllipsizeMode::End); + let detail = gtk::Label::new(None); + detail.set_xalign(0.0); + detail.set_ellipsize(gtk::pango::EllipsizeMode::End); + detail.style_context().add_class("dim-label"); + detail.set_no_show_all(true); + let copy = gtk::Box::new(gtk::Orientation::Vertical, 2); + copy.set_valign(gtk::Align::Center); + copy.pack_start(&label, false, false, 0); + copy.pack_start(&detail, false, false, 0); + copy.show(); + let retry = super::action_button("Try Again")?; + retry.set_valign(gtk::Align::Center); + let proceed = super::action_button("Continue Anyway…")?; + proceed.set_valign(gtk::Align::Center); + proceed.set_no_show_all(true); + let cancel = super::action_button("Cancel")?; + cancel.set_valign(gtk::Align::Center); + // Showing or raising the window must not override recovery-state visibility. + row.set_no_show_all(true); + spinner.set_no_show_all(true); + retry.set_no_show_all(true); + label.show(); + cancel.set_no_show_all(true); + let retry_messenger = Arc::clone(&messenger); + retry.connect_clicked(move |_| retry_messenger.send_auth_event(AuthEvent::Retry)); + let proceed_messenger = Arc::clone(&messenger); + proceed.connect_clicked(move |_| proceed_messenger.send_auth_event(AuthEvent::RequestTlsException)); + cancel.connect_clicked(move |_| messenger.send_auth_event(AuthEvent::Close)); + row.pack_start(&spinner, false, false, 0); + row.pack_start(©, true, true, 0); + row.pack_start(&retry, false, false, 0); + row.pack_start(&proceed, false, false, 0); + row.pack_start(&cancel, false, false, 0); + header.pack_start(&row, false, false, 0); + // The WebView owns the controls for exactly its native lifetime, on the GTK thread. + unsafe { + webview.set_data( + CONTROLS_KEY, + RecoveryRow { + row, + spinner, + label, + retry, + proceed, + cancel, + detail, + }, + ); + } + Ok(()) +} + +pub(super) fn update(webview: &WebView, status: RecoveryStatus) -> anyhow::Result<()> { + let controls = unsafe { webview.data::(CONTROLS_KEY) }.context("Recovery controls are unavailable")?; + let controls = unsafe { controls.as_ref() }; + controls.label.set_text(status.message()); + controls.detail.set_text(status.detail()); + controls.detail.set_visible(!status.detail().is_empty()); + controls.retry.set_visible(status.can_retry()); + controls.proceed.set_visible(status.can_continue()); + controls.cancel.set_visible(status.blocks_page()); + controls.spinner.set_visible(status.is_busy()); + if status.is_busy() { + controls.spinner.start(); + } else { + controls.spinner.stop(); + } + controls.row.set_visible(status != RecoveryStatus::Hidden); + webview.set_sensitive(!status.blocks_page()); + Ok(()) +} diff --git a/crates/auth/src/webview/gtk_tls.rs b/crates/auth/src/webview/gtk_tls.rs new file mode 100644 index 0000000..d9dae7d --- /dev/null +++ b/crates/auth/src/webview/gtk_tls.rs @@ -0,0 +1,180 @@ +use std::{ + cell::{Cell, RefCell}, + rc::Rc, + sync::Arc, +}; + +use anyhow::Context; +use gtk::prelude::*; +use webkit2gtk::{ + WebContextExt, WebView, WebViewExt, + gio::{TlsCertificate, TlsCertificateFlags}, +}; + +use super::super::{ + auth_messenger::{AuthEvent, AuthMessenger}, + tls::{TlsFailure, TlsFailureReason}, +}; + +const TLS_KEY: &str = "gpauth-tls"; + +#[derive(Clone)] +struct PendingCertificate { + generation: u64, + certificate: TlsCertificate, + failure: TlsFailure, +} + +struct TlsState { + pending: RefCell>, + confirmation_open: Cell, + messenger: Arc, +} + +pub(super) fn install(webview: &WebView, messenger: Arc) { + unsafe { + webview.set_data( + TLS_KEY, + Rc::new(TlsState { + pending: RefCell::new(None), + confirmation_open: Cell::new(false), + messenger, + }), + ); + } +} + +fn state(webview: &WebView) -> anyhow::Result> { + let data = unsafe { webview.data::>(TLS_KEY) }.context("TLS controls are unavailable")?; + Ok(unsafe { data.as_ref() }.clone()) +} + +pub(super) fn record_failure( + webview: &WebView, + uri: &str, + certificate: &TlsCertificate, + flags: TlsCertificateFlags, + generation: u64, +) -> TlsFailure { + let reason = if flags.contains(TlsCertificateFlags::EXPIRED) { + TlsFailureReason::Expired + } else if flags.contains(TlsCertificateFlags::NOT_ACTIVATED) { + TlsFailureReason::NotYetValid + } else if flags.contains(TlsCertificateFlags::BAD_IDENTITY) { + TlsFailureReason::HostnameMismatch + } else if flags.contains(TlsCertificateFlags::UNKNOWN_CA) { + TlsFailureReason::Untrusted + } else { + TlsFailureReason::InvalidCertificate + }; + let host = url::Url::parse(uri) + .ok() + .filter(|uri| uri.scheme() == "https") + .and_then(|uri| uri.host_str().map(str::to_owned)); + let failure = TlsFailure { + host: host.clone().unwrap_or_default(), + reason, + can_continue: reason.is_certificate_error() && host.is_some(), + }; + if let Ok(state) = state(webview) { + *state.pending.borrow_mut() = host.map(|_| PendingCertificate { + generation, + certificate: certificate.clone(), + failure: failure.clone(), + }); + } + failure +} + +pub(super) fn confirm(webview: &WebView) -> anyhow::Result<()> { + let state = state(webview)?; + let pending = state + .pending + .borrow() + .clone() + .context("No certificate error is awaiting confirmation")?; + if pending.generation != state.messenger.generation() || state.confirmation_open.get() { + return Ok(()); + } + let parent = webview + .toplevel() + .and_then(|widget| widget.downcast::().ok()) + .context("Auth window is unavailable")?; + let dialog = gtk::Dialog::builder() + .transient_for(&parent) + .modal(true) + .destroy_with_parent(true) + .title("Certificate Warning") + .use_header_bar(0) + .resizable(false) + .build(); + let content = dialog.content_area(); + content.set_spacing(12); + content.set_margin_top(18); + content.set_margin_bottom(18); + content.set_margin_start(18); + content.set_margin_end(18); + let title = gtk::Label::new(None); + title.set_markup(&format!( + "{}", + gtk::glib::markup_escape_text(&pending.failure.confirmation_title()) + )); + let message = gtk::Label::new(Some(&pending.failure.confirmation_message())); + for label in [&title, &message] { + label.set_xalign(0.0); + label.set_line_wrap(true); + label.set_line_wrap_mode(gtk::pango::WrapMode::WordChar); + label.set_max_width_chars(48); + content.pack_start(label, false, false, 0); + } + let actions = gtk::ButtonBox::new(gtk::Orientation::Horizontal); + actions.set_layout(gtk::ButtonBoxStyle::End); + actions.set_spacing(8); + actions.set_margin_top(6); + content.pack_start(&actions, false, false, 0); + for (label, response) in [ + ("Cancel", gtk::ResponseType::Cancel), + ("Continue Anyway", gtk::ResponseType::Accept), + ] { + let button = super::action_button(label)?; + button.set_can_default(true); + let weak_dialog = dialog.downgrade(); + button.connect_clicked(move |_| { + if let Some(dialog) = weak_dialog.upgrade() { + dialog.response(response); + } + }); + actions.pack_start(&button, false, false, 0); + actions.set_child_non_homogeneous(&button, true); + if response == gtk::ResponseType::Cancel { + dialog.set_default(Some(&button)); + } + } + state.confirmation_open.set(true); + let weak = webview.downgrade(); + dialog.connect_response(move |dialog, response| { + state.confirmation_open.set(false); + if response == gtk::ResponseType::Accept && pending.generation == state.messenger.generation() { + if let Some(webview) = weak.upgrade() { + let current = state.pending.borrow().as_ref().is_some_and(|current| { + current.generation == pending.generation + && current.certificate == pending.certificate + && current.failure.host == pending.failure.host + }); + if current { + if let Some(context) = webview.context() { + // This single-window auth process discards its WebContext on exit. + context.allow_tls_certificate_for_host(&pending.certificate, &pending.failure.host); + state.pending.borrow_mut().take(); + state + .messenger + .send_auth_event(AuthEvent::TlsAccepted(pending.generation)); + } + } + } + } + dialog.close(); + }); + dialog.show_all(); + Ok(()) +} diff --git a/crates/auth/src/webview/macos.rs b/crates/auth/src/webview/macos.rs index ab0fb72..f19adda 100644 --- a/crates/auth/src/webview/macos.rs +++ b/crates/auth/src/webview/macos.rs @@ -1,58 +1,149 @@ -use std::{ffi::c_void, ptr}; +use std::{ + cell::{Cell, RefCell}, + collections::HashMap, + ffi::c_void, + ptr, + sync::Arc, +}; use anyhow::{Context, bail}; use block2::{DynBlock, RcBlock}; +use gpapi::utils::redact::redact_uri; +use log::{info, warn}; use objc2::{ - DefinedClass, MainThreadOnly, define_class, - ffi::{OBJC_ASSOCIATION_RETAIN_NONATOMIC, objc_setAssociatedObject}, + DefinedClass, MainThreadOnly, Message, define_class, + ffi::{OBJC_ASSOCIATION_RETAIN_NONATOMIC, objc_getAssociatedObject, objc_setAssociatedObject}, msg_send, rc::Retained, runtime::{AnyObject, ProtocolObject, Sel}, + sel, }; use objc2_foundation::{ MainThreadMarker, NSError, NSObject, NSObjectNSKeyValueCoding, NSObjectProtocol, NSString, NSURL, - NSURLAuthenticationChallenge, NSURLAuthenticationMethodServerTrust, NSURLCredential, NSURLRequest, + NSURLAuthenticationChallenge, NSURLAuthenticationMethodServerTrust, NSURLCredential, NSURLErrorCancelled, + NSURLErrorDomain, NSURLErrorFailingURLErrorKey, NSURLErrorUnsupportedURL, NSURLRequest, NSURLSessionAuthChallengeDisposition, }; -use objc2_web_kit::{WKNavigationDelegate, WKWebView}; +use objc2_web_kit::{WKNavigation, WKNavigationDelegate, WKWebView}; use tauri::webview::PlatformWebview; -use super::webview_auth::PlatformWebviewExt; +use super::{ + auth_messenger::{AuthError, AuthEvent, AuthMessenger}, + recovery::RecoveryStatus, + webview_auth::PlatformWebviewExt, +}; -static TLS_NAVIGATION_DELEGATE_KEY: u8 = 0; +#[path = "macos/address_bar.rs"] +mod address_bar; +#[path = "macos/recovery_row.rs"] +mod recovery_row; +#[path = "macos/tls.rs"] +mod tls; -struct TlsNavigationDelegateIvars { +static AUTH_NAVIGATION_DELEGATE_KEY: u8 = 0; + +struct AuthNavigationDelegateIvars { original: Retained>, + messenger: Arc, + ignore_tls_errors: Cell, + navigations: RefCell, u64)>>, + tls: RefCell, } define_class!( #[unsafe(super = NSObject)] #[thread_kind = MainThreadOnly] - #[ivars = TlsNavigationDelegateIvars] - struct TlsNavigationDelegate; + #[ivars = AuthNavigationDelegateIvars] + struct AuthNavigationDelegate; - unsafe impl NSObjectProtocol for TlsNavigationDelegate {} + unsafe impl NSObjectProtocol for AuthNavigationDelegate {} #[allow(non_snake_case)] - unsafe impl WKNavigationDelegate for TlsNavigationDelegate { + unsafe impl WKNavigationDelegate for AuthNavigationDelegate { + #[unsafe(method(webView:didStartProvisionalNavigation:))] + unsafe fn webView_didStartProvisionalNavigation(&self, webview: &WKWebView, navigation: Option<&WKNavigation>) { + self.track_navigation(navigation); + self.ivars().messenger.cancel_raise_window(); + let original = &self.ivars().original; + if original.respondsToSelector(sel!(webView:didStartProvisionalNavigation:)) { + unsafe { original.webView_didStartProvisionalNavigation(webview, navigation); } + } + } + + #[unsafe(method(webView:didCommitNavigation:))] + unsafe fn webView_didCommitNavigation(&self, webview: &WKWebView, navigation: Option<&WKNavigation>) { + if let Some(generation) = self.navigation_generation(navigation) { + info!("Started loading page: {}", navigation_address(webview)); + read_navigation_html(webview, Arc::clone(&self.ivars().messenger), generation); + } + let original = &self.ivars().original; + if original.respondsToSelector(sel!(webView:didCommitNavigation:)) { + unsafe { original.webView_didCommitNavigation(webview, navigation); } + } + } + + #[unsafe(method(webView:didFinishNavigation:))] + unsafe fn webView_didFinishNavigation(&self, webview: &WKWebView, navigation: Option<&WKNavigation>) { + if let Some(generation) = self.finish_navigation(navigation) { + info!("Finished loading page: {}", navigation_address(webview)); + read_navigation_html(webview, Arc::clone(&self.ivars().messenger), generation); + self.ivars().messenger.send_auth_event(AuthEvent::PageLoaded(generation)); + } + let original = &self.ivars().original; + if original.respondsToSelector(sel!(webView:didFinishNavigation:)) { + unsafe { original.webView_didFinishNavigation(webview, navigation); } + } + } + + #[unsafe(method(webView:didFailProvisionalNavigation:withError:))] + unsafe fn webView_didFailProvisionalNavigation_withError(&self, webview: &WKWebView, navigation: Option<&WKNavigation>, error: &NSError) { + self.report_load_failure(webview, navigation, error); + let original = &self.ivars().original; + if original.respondsToSelector(sel!(webView:didFailProvisionalNavigation:withError:)) { + unsafe { original.webView_didFailProvisionalNavigation_withError(webview, navigation, error); } + } + } + + #[unsafe(method(webView:didFailNavigation:withError:))] + unsafe fn webView_didFailNavigation_withError(&self, webview: &WKWebView, navigation: Option<&WKNavigation>, error: &NSError) { + self.report_load_failure(webview, navigation, error); + let original = &self.ivars().original; + if original.respondsToSelector(sel!(webView:didFailNavigation:withError:)) { + unsafe { original.webView_didFailNavigation_withError(webview, navigation, error); } + } + } + #[unsafe(method(webView:didReceiveAuthenticationChallenge:completionHandler:))] unsafe fn webView_didReceiveAuthenticationChallenge_completionHandler( &self, - _webview: &WKWebView, + webview: &WKWebView, challenge: &NSURLAuthenticationChallenge, completion_handler: &DynBlock, ) { + // Preserve Wry's normal authentication challenge handling unless the caller + // approved this certificate or requested the ignore-TLS-errors behavior. let protection_space = challenge.protectionSpace(); - let is_server_trust = protection_space - .authenticationMethod() - .isEqualToString(unsafe { NSURLAuthenticationMethodServerTrust }); - + let is_server_trust = protection_space.authenticationMethod().isEqualToString(unsafe { NSURLAuthenticationMethodServerTrust }); + let server_trust: *mut AnyObject = if is_server_trust { + msg_send![&*protection_space, serverTrust] + } else { ptr::null_mut() }; + let approved = std::ptr::NonNull::new(server_trust.cast::()).is_some_and(|trust| { + self.ivars().tls.borrow().allows(&protection_space.host().to_string(), unsafe { trust.as_ref() }) + }); + if !self.ivars().ignore_tls_errors.get() && !approved { + let original = &self.ivars().original; + if original.respondsToSelector(sel!(webView:didReceiveAuthenticationChallenge:completionHandler:)) { + unsafe { original.webView_didReceiveAuthenticationChallenge_completionHandler(webview, challenge, completion_handler); } + } else { + completion_handler.call((challenge_disposition(false), ptr::null_mut())); + } + return; + } if !is_server_trust { completion_handler.call((challenge_disposition(false), ptr::null_mut())); return; } - let server_trust: *mut AnyObject = msg_send![&*protection_space, serverTrust]; if server_trust.is_null() { completion_handler.call((challenge_disposition(false), ptr::null_mut())); return; @@ -64,7 +155,7 @@ define_class!( } } - impl TlsNavigationDelegate { + impl AuthNavigationDelegate { #[unsafe(method(respondsToSelector:))] fn responds_to_selector(&self, selector: Sel) -> bool { let responds: bool = unsafe { msg_send![super(self), respondsToSelector: selector] }; @@ -82,10 +173,92 @@ define_class!( } ); -impl TlsNavigationDelegate { - fn new(original: Retained>, mtm: MainThreadMarker) -> Retained { - let this = Self::alloc(mtm).set_ivars(TlsNavigationDelegateIvars { original }); - unsafe { msg_send![super(this), init] } +impl AuthNavigationDelegate { + fn track_navigation(&self, navigation: Option<&WKNavigation>) { + if let Some(navigation) = navigation { + let key = navigation as *const WKNavigation as usize; + self + .ivars() + .navigations + .borrow_mut() + .entry(key) + .or_insert_with(|| (navigation.retain(), self.ivars().messenger.generation())); + } + } + + fn navigation_generation(&self, navigation: Option<&WKNavigation>) -> Option { + let key = navigation? as *const WKNavigation as usize; + self + .ivars() + .navigations + .borrow() + .get(&key) + .map(|(_, generation)| *generation) + } + + fn finish_navigation(&self, navigation: Option<&WKNavigation>) -> Option { + let key = navigation? as *const WKNavigation as usize; + self + .ivars() + .navigations + .borrow_mut() + .remove(&key) + .map(|(_, generation)| generation) + } + + fn report_load_failure(&self, webview: &WKWebView, navigation: Option<&WKNavigation>, error: &NSError) { + let Some(generation) = self.finish_navigation(navigation) else { + return; + }; + if generation != self.ivars().messenger.generation() { + return; + } + let is_url_error = error.domain().isEqualToString(unsafe { NSURLErrorDomain }); + if is_url_error && error.code() == NSURLErrorCancelled { + return; + } + if is_url_error && error.code() == NSURLErrorUnsupportedURL { + let callback = error + .userInfo() + .objectForKey(unsafe { NSURLErrorFailingURLErrorKey }) + .and_then(|value| value.downcast::().ok()) + .and_then(|url| url.scheme()); + if callback.is_some_and(|scheme| scheme.to_string() == "globalprotectcallback") { + return; + } + } + let messenger = &self.ivars().messenger; + if let Some(failure) = self.ivars().tls.borrow_mut().record_failure(webview, error, generation) { + messenger.send_auth_event(AuthEvent::Error(generation, failure)); + return; + } + // Log codes rather than NSError descriptions, which may contain callback URLs. + messenger.send_auth_event(AuthEvent::Error( + generation, + AuthError::LoadFailed(anyhow::anyhow!( + "Navigation failed: {} ({})", + error.domain(), + error.code() + )), + )); + } +} + +fn navigation_delegate(webview: &WKWebView) -> Option> { + unsafe { + let pointer = objc_getAssociatedObject( + webview as *const WKWebView as *mut AnyObject, + &AUTH_NAVIGATION_DELEGATE_KEY as *const u8 as *const c_void, + ) + .cast::(); + Retained::retain(pointer.cast_mut()) + } +} + +fn track_requested_navigation(webview: &WKWebView, navigation: Option<&WKNavigation>) { + let delegate = navigation_delegate(webview); + if let Some(delegate) = delegate { + delegate.track_navigation(navigation); } } @@ -97,15 +270,22 @@ fn challenge_disposition(is_server_trust: bool) -> NSURLSessionAuthChallengeDisp } } -fn install_tls_navigation_delegate(webview: &WKWebView) -> anyhow::Result<()> { +fn install_navigation_delegate(webview: &WKWebView, messenger: Arc) -> anyhow::Result<()> { let original = unsafe { webview.navigationDelegate() }.context("WebView navigation delegate is unavailable")?; let mtm = MainThreadMarker::new().context("WebView must be configured on the main thread")?; - let delegate = TlsNavigationDelegate::new(original, mtm); + let delegate = AuthNavigationDelegate::alloc(mtm).set_ivars(AuthNavigationDelegateIvars { + original, + messenger, + ignore_tls_errors: Cell::new(false), + tls: RefCell::new(tls::TlsState::default()), + navigations: RefCell::new(HashMap::new()), + }); + let delegate: Retained = unsafe { msg_send![super(delegate), init] }; unsafe { objc_setAssociatedObject( webview as *const WKWebView as *mut AnyObject, - &TLS_NAVIGATION_DELEGATE_KEY as *const u8 as *const c_void, + &AUTH_NAVIGATION_DELEGATE_KEY as *const u8 as *const c_void, Retained::as_ptr(&delegate).cast_mut().cast(), OBJC_ASSOCIATION_RETAIN_NONATOMIC, ); @@ -139,9 +319,47 @@ mod tests { } impl PlatformWebviewExt for PlatformWebview { + fn install_auth_controls(&self, window: &tauri::WebviewWindow, messenger: Arc) -> anyhow::Result<()> { + let webview: &WKWebView = unsafe { &*self.inner().cast() }; + address_bar::install(webview)?; + install_navigation_delegate(webview, Arc::clone(&messenger))?; + recovery_row::install(webview, messenger)?; + let window_handle = window.clone(); + window.on_window_event(move |event| { + if matches!( + event, + tauri::WindowEvent::Resized(_) | tauri::WindowEvent::ScaleFactorChanged { .. } + ) { + let _ = window_handle.with_webview(|webview| { + let webview: &WKWebView = unsafe { &*webview.inner().cast() }; + address_bar::resize(webview); + }); + } + }); + Ok(()) + } + + fn set_recovery_status(&self, status: RecoveryStatus) -> anyhow::Result<()> { + let webview: &WKWebView = unsafe { &*self.inner().cast() }; + recovery_row::update(webview, status) + } + + fn stop_loading(&self) { + let webview: &WKWebView = unsafe { &*self.inner().cast() }; + unsafe { + webview.stopLoading(); + } + } + + fn confirm_tls_exception(&self) -> anyhow::Result<()> { + tls::confirm(unsafe { &*self.inner().cast::() }) + } + fn ignore_tls_errors(&self) -> anyhow::Result<()> { let webview: &WKWebView = unsafe { &*self.inner().cast() }; - install_tls_navigation_delegate(webview) + let delegate = navigation_delegate(webview).context("Auth navigation delegate is unavailable")?; + delegate.ivars().ignore_tls_errors.set(true); + Ok(()) } fn user_agent(&self) -> anyhow::Result { @@ -173,7 +391,8 @@ impl PlatformWebviewExt for PlatformWebview { let url = NSURL::URLWithString(&NSString::from_str(url)).ok_or_else(|| anyhow::anyhow!("Invalid URL"))?; let request = NSURLRequest::requestWithURL(&url); - wv.loadRequest(&request); + let navigation = wv.loadRequest(&request); + track_requested_navigation(wv, navigation.as_deref()); } Ok(()) @@ -182,31 +401,31 @@ impl PlatformWebviewExt for PlatformWebview { fn load_html(&self, html: &str) -> anyhow::Result<()> { unsafe { let wv: &WKWebView = &*self.inner().cast(); - wv.loadHTMLString_baseURL(&NSString::from_str(html), None); + let navigation = wv.loadHTMLString_baseURL(&NSString::from_str(html), None); + track_requested_navigation(wv, navigation.as_deref()); } Ok(()) } +} - fn get_html(&self, callback: Box) + 'static>) { - unsafe { - let wv: &WKWebView = &*self.inner().cast(); +fn navigation_address(webview: &WKWebView) -> String { + let url = unsafe { webview.URL() }.and_then(|url| url.absoluteString()); + redact_uri(&url.map(|url| url.to_string()).unwrap_or_default()) +} - let js_callback = RcBlock::new(move |body: *mut AnyObject, err: *mut NSError| { - if let Some(err) = err.as_ref() { - let code = err.code(); - let message = err.localizedDescription(); - callback(Err(anyhow::anyhow!("Error {}: {}", code, message))); - } else { - let body: &NSString = &*body.cast(); - callback(Ok(body.to_string())); - } - }); - - wv.evaluateJavaScript_completionHandler( - &NSString::from_str("document.documentElement.outerHTML"), - Some(&js_callback), - ); +fn read_navigation_html(webview: &WKWebView, messenger: Arc, generation: u64) { + let callback = RcBlock::new(move |body: *mut AnyObject, error: *mut NSError| { + if let Some(error) = unsafe { error.as_ref() } { + warn!("Failed to get html: {} ({})", error.domain(), error.code()); + } else if let Some(body) = unsafe { body.as_ref() }.and_then(|body| body.downcast_ref::()) { + messenger.read_from_html(&body.to_string(), generation); } + }); + unsafe { + webview.evaluateJavaScript_completionHandler( + &NSString::from_str("document.documentElement.outerHTML"), + Some(&callback), + ); } } diff --git a/crates/auth/src/webview/macos/address_bar.rs b/crates/auth/src/webview/macos/address_bar.rs new file mode 100644 index 0000000..f98ed45 --- /dev/null +++ b/crates/auth/src/webview/macos/address_bar.rs @@ -0,0 +1,240 @@ +use std::{ffi::c_void, ptr}; + +use anyhow::Context; +use objc2::{ + DefinedClass, MainThreadOnly, Message, define_class, + ffi::{OBJC_ASSOCIATION_RETAIN_NONATOMIC, objc_getAssociatedObject, objc_setAssociatedObject}, + msg_send, + rc::Retained, + runtime::{AnyObject, ProtocolObject}, +}; +use objc2_app_kit::{ + NSAccessibility, NSAutoresizingMaskOptions, NSBox, NSBoxType, NSColor, NSFont, NSLayoutConstraint, + NSLayoutConstraintOrientation, NSLineBreakMode, NSTextView, NSToolbar, NSToolbarDelegate, NSToolbarDisplayMode, + NSToolbarItem, NSToolbarItemIdentifier, NSWindowTitleVisibility, NSWindowToolbarStyle, +}; +use objc2_foundation::{ + MainThreadMarker, NSArray, NSDictionary, NSKeyValueChangeKey, NSKeyValueObservingOptions, NSObject, + NSObjectNSKeyValueObserverRegistration, NSObjectProtocol, NSPoint, NSRect, NSSize, NSString, +}; +use objc2_web_kit::WKWebView; + +use super::super::address_bar::{LOADING_ADDRESS, display_address}; + +static ADDRESS_TOOLBAR_KEY: u8 = 0; +const ADDRESS_ITEM_ID: &str = "com.yuezk.gpauth.address"; + +define_class!( + #[unsafe(super = NSTextView)] + #[thread_kind = MainThreadOnly] + struct AddressView; + + impl AddressView { + #[unsafe(method(intrinsicContentSize))] + fn intrinsic_content_size(&self) -> NSSize { + // URL length must not determine the toolbar item's width. + NSSize::new(-1.0, 22.0) + } + } +); + +struct AddressToolbarIvars { + webview: Retained, + address_view: Retained, + separator: Retained, +} + +define_class!( + // The content view retains the delegate because NSToolbar's delegate is weak. + // Drop unregisters URL observation before releasing the retained webview. + #[unsafe(super = NSObject)] + #[thread_kind = MainThreadOnly] + #[ivars = AddressToolbarIvars] + struct AddressToolbar; + + unsafe impl NSObjectProtocol for AddressToolbar {} + + unsafe impl NSToolbarDelegate for AddressToolbar { + #[unsafe(method_id(toolbar:itemForItemIdentifier:willBeInsertedIntoToolbar:))] + fn toolbar_item( + &self, + _toolbar: &NSToolbar, + identifier: &NSToolbarItemIdentifier, + inserting: bool, + ) -> Option> { + if !inserting || !identifier.isEqualToString(&NSString::from_str(ADDRESS_ITEM_ID)) { + None + } else { + let item = NSToolbarItem::initWithItemIdentifier(NSToolbarItem::alloc(self.mtm()), identifier); + item.setLabel(&NSString::from_str("Sign-in page address")); + item.setBordered(true); + item.setView(Some(&self.ivars().address_view)); + Some(item) + } + } + + #[unsafe(method_id(toolbarDefaultItemIdentifiers:))] + fn default_items(&self, _toolbar: &NSToolbar) -> Retained> { + NSArray::from_retained_slice(&[NSString::from_str(ADDRESS_ITEM_ID)]) + } + + #[unsafe(method_id(toolbarAllowedItemIdentifiers:))] + fn allowed_items(&self, _toolbar: &NSToolbar) -> Retained> { + NSArray::from_retained_slice(&[NSString::from_str(ADDRESS_ITEM_ID)]) + } + } + + impl AddressToolbar { + #[unsafe(method(observeValueForKeyPath:ofObject:change:context:))] + fn observe_url( + &self, + _key_path: Option<&NSString>, + _object: Option<&AnyObject>, + _change: Option<&NSDictionary>, + _context: *mut c_void, + ) { + let uri = unsafe { self.ivars().webview.URL() }.and_then(|url| url.absoluteString()); + let address = display_address(uri.as_ref().map(|uri| uri.to_string()).as_deref()); + self.ivars().address_view.setString(&NSString::from_str(&address)); + } + } +); + +impl Drop for AddressToolbar { + fn drop(&mut self) { + // This private observer registers only URL and remains on the main thread. + unsafe { + self + .ivars() + .webview + .removeObserver_forKeyPath(self, &NSString::from_str("URL")); + } + } +} + +pub(super) fn install(webview: &WKWebView) -> anyhow::Result<()> { + let mtm = MainThreadMarker::new().context("Toolbar must be installed on the main thread")?; + let parent = unsafe { webview.superview() }.context("Webview has no containing view")?; + let window = webview.window().context("Webview has no window")?; + parent.setWantsLayer(true); + let address_view: Retained = + unsafe { msg_send![AddressView::alloc(mtm), initWithFrame: NSRect::default()] }; + // Use one native text layout for display and selection. + address_view.setString(&NSString::from_str(LOADING_ADDRESS)); + address_view.setDrawsBackground(false); + // Keep NSTextView's visible-rect cursor tracking inside the address bar. + address_view.setClipsToBounds(true); + address_view.setRichText(false); + address_view.setHorizontallyResizable(false); + address_view.setVerticallyResizable(false); + address_view.setTextContainerInset(NSSize::new(6.0, 3.0)); + address_view.setEditable(false); + address_view.setSelectable(true); + address_view.setFont(Some(&NSFont::systemFontOfSize(12.0))); + address_view.setContentHuggingPriority_forOrientation(1.0, NSLayoutConstraintOrientation::Horizontal); + address_view.setAccessibilityLabel(Some(&NSString::from_str("Sign-in page address"))); + if let Some(container) = unsafe { address_view.textContainer() } { + container.setWidthTracksTextView(true); + container.setLineFragmentPadding(0.0); + container.setMaximumNumberOfLines(1); + container.setLineBreakMode(NSLineBreakMode::ByTruncatingTail); + } + // AppKit measures the toolbar item's minimum and maximum width from its view. + NSLayoutConstraint::activateConstraints(&NSArray::from_retained_slice(&[ + address_view.widthAnchor().constraintGreaterThanOrEqualToConstant(200.0), + address_view.widthAnchor().constraintLessThanOrEqualToConstant(10000.0), + address_view.heightAnchor().constraintEqualToConstant(22.0), + ])); + let separator = NSBox::new(mtm); + separator + .setAutoresizingMask(NSAutoresizingMaskOptions::ViewWidthSizable | NSAutoresizingMaskOptions::ViewMinYMargin); + separator.setBoxType(NSBoxType::Custom); + separator.setBorderWidth(0.0); + separator.setCornerRadius(0.0); + separator.setFillColor(&NSColor::separatorColor()); + parent.addSubview(&separator); + let delegate = AddressToolbar::alloc(mtm).set_ivars(AddressToolbarIvars { + webview: webview.retain(), + address_view: Retained::into_super(address_view), + separator, + }); + let delegate: Retained = unsafe { msg_send![super(delegate), init] }; + // Observe the current URL independently of navigation callbacks. + unsafe { + webview.addObserver_forKeyPath_options_context( + &delegate, + &NSString::from_str("URL"), + NSKeyValueObservingOptions::Initial, + ptr::null_mut(), + ); + objc_setAssociatedObject( + Retained::as_ptr(&parent).cast_mut().cast(), + &ADDRESS_TOOLBAR_KEY as *const u8 as *const c_void, + Retained::as_ptr(&delegate).cast_mut().cast(), + OBJC_ASSOCIATION_RETAIN_NONATOMIC, + ); + } + let toolbar = NSToolbar::initWithIdentifier(NSToolbar::alloc(mtm), &NSString::from_str("com.yuezk.gpauth.toolbar")); + toolbar.setAllowsUserCustomization(false); + toolbar.setDisplayMode(NSToolbarDisplayMode::IconOnly); + toolbar.setDelegate(Some(ProtocolObject::from_ref(&*delegate))); + window.setTitleVisibility(NSWindowTitleVisibility::Visible); + if objc2::available!(macos = 11.0) { + window.setToolbarStyle(NSWindowToolbarStyle::Expanded); + } + window.setToolbar(Some(&toolbar)); + window.setInitialFirstResponder(Some(webview)); + resize(webview); + Ok(()) +} + +pub(super) fn address_view(webview: &WKWebView) -> Option> { + let parent = unsafe { webview.superview() }?; + let delegate = unsafe { + objc_getAssociatedObject( + Retained::as_ptr(&parent).cast_mut().cast(), + &ADDRESS_TOOLBAR_KEY as *const u8 as *const c_void, + ) + .cast::() + .as_ref() + }?; + Some(delegate.ivars().address_view.clone()) +} + +pub(super) fn show_address(webview: &WKWebView, uri: &str) { + if let Some(view) = address_view(webview) { + view.setString(&NSString::from_str(&display_address(Some(uri)))); + } +} + +pub(super) fn resize(webview: &WKWebView) { + let Some(parent) = (unsafe { webview.superview() }) else { + return; + }; + let Some(window) = webview.window() else { + return; + }; + // Keep the native separator outside WebKit so page backgrounds cannot cover it. + let content = parent.convertRect_fromView(window.contentLayoutRect(), None); + let separator_height = 1.0 / window.backingScaleFactor(); + let recovery_height = super::recovery_row::layout(webview, content); + let page_height = (content.size.height - recovery_height - separator_height).max(0.0); + let delegate = unsafe { + objc_getAssociatedObject( + Retained::as_ptr(&parent).cast_mut().cast(), + &ADDRESS_TOOLBAR_KEY as *const u8 as *const c_void, + ) + .cast::() + .as_ref() + }; + if let Some(delegate) = delegate { + delegate.ivars().separator.setFrame(NSRect::new( + NSPoint::new(content.origin.x, content.origin.y + page_height), + NSSize::new(content.size.width, separator_height), + )); + } + webview.setFrame(NSRect::new( + content.origin, + NSSize::new(content.size.width, page_height), + )); +} diff --git a/crates/auth/src/webview/macos/recovery_row.rs b/crates/auth/src/webview/macos/recovery_row.rs new file mode 100644 index 0000000..973e2c3 --- /dev/null +++ b/crates/auth/src/webview/macos/recovery_row.rs @@ -0,0 +1,332 @@ +use std::{ + cell::{Cell, RefCell}, + ffi::c_void, + ptr, + sync::Arc, +}; + +use anyhow::Context; +use block2::RcBlock; +use objc2::{ + DefinedClass, MainThreadOnly, Message, define_class, + ffi::{OBJC_ASSOCIATION_RETAIN_NONATOMIC, objc_getAssociatedObject, objc_setAssociatedObject}, + msg_send, + rc::{Retained, Weak}, + runtime::AnyObject, + sel, +}; +use objc2_app_kit::{ + NSAutoresizingMaskOptions, NSBezelStyle, NSBox, NSBoxType, NSButton, NSColor, NSControlSize, NSEvent, NSEventMask, + NSEventModifierFlags, NSFont, NSLineBreakMode, NSProgressIndicator, NSProgressIndicatorStyle, NSTextField, + NSTitlePosition, NSView, +}; +use objc2_foundation::{MainThreadMarker, NSObject, NSObjectProtocol, NSPoint, NSRect, NSSize, NSString}; +use objc2_web_kit::WKWebView; + +use super::super::{ + auth_messenger::{AuthEvent, AuthMessenger}, + recovery::RecoveryStatus, +}; + +static RECOVERY_ROW_KEY: u8 = 0; + +struct RecoveryRowIvars { + webview: Retained, + messenger: Arc, + row: Retained, + blocker: Retained, + label: Retained, + detail: Retained, + proceed: Retained, + status: Cell, + spinner: Retained, + retry: Retained, + cancel: Retained, + keyboard_monitor: RefCell>>, +} + +define_class!( + #[unsafe(super = NSObject)] + #[thread_kind = MainThreadOnly] + #[ivars = RecoveryRowIvars] + struct RecoveryRow; + + unsafe impl NSObjectProtocol for RecoveryRow {} + + impl RecoveryRow { + #[unsafe(method(retry:))] + fn retry(&self, _sender: &AnyObject) { + self.ivars().messenger.send_auth_event(AuthEvent::Retry); + } + + #[unsafe(method(continueTls:))] + fn continue_tls(&self, _sender: &AnyObject) { + self.ivars().messenger.send_auth_event(AuthEvent::RequestTlsException); + } + + #[unsafe(method(cancel:))] + fn cancel(&self, _sender: &AnyObject) { + self.ivars().messenger.send_auth_event(AuthEvent::Close); + } + } +); + +impl Drop for RecoveryRow { + fn drop(&mut self) { + if let Some(monitor) = self.ivars().keyboard_monitor.borrow_mut().take() { + unsafe { + NSEvent::removeMonitor(&monitor); + } + } + } +} + +impl RecoveryRow { + fn handle_key(&self, event: &NSEvent) -> bool { + let controls = self.ivars(); + if !controls.status.get().blocks_page() { + return false; + } + let Some(window) = controls.webview.window() else { + return false; + }; + if window.attachedSheet().is_some() || event.window(self.mtm()).as_deref() != Some(&*window) { + return false; + } + let responder = window.firstResponder(); + let modifiers = event.modifierFlags(); + if event.keyCode() == 48 && !modifiers.intersects(NSEventModifierFlags::Command | NSEventModifierFlags::Control) { + // Explicit traversal also works when the system skips buttons in its default key loop. + let Some(address) = super::address_bar::address_view(&controls.webview) else { + return false; + }; + let mut views: Vec<&NSView> = vec![&address]; + if !controls.retry.isHidden() { + views.push(&controls.retry); + } + if !controls.proceed.isHidden() { + views.push(&controls.proceed); + } + views.push(&controls.cancel); + let current = responder.as_ref().and_then(|responder| { + views.iter().position(|view| { + ptr::eq( + (*view) as *const NSView as *const c_void, + Retained::as_ptr(responder).cast(), + ) + }) + }); + let next = match current { + Some(index) if modifiers.contains(NSEventModifierFlags::Shift) => (index + views.len() - 1) % views.len(), + Some(index) => (index + 1) % views.len(), + None => views.len() - 1, + }; + window.makeFirstResponder(Some(views[next])); + return true; + } + // If WebKit regains focus programmatically, do not deliver keys to the covered page. + if responder + .as_deref() + .and_then(|responder| responder.downcast_ref::()) + .is_some_and(|view| view.isDescendantOf(&controls.webview)) + { + window.makeFirstResponder(Some(&controls.cancel)); + return true; + } + false + } +} + +pub(super) fn install(webview: &WKWebView, messenger: Arc) -> anyhow::Result<()> { + let mtm = MainThreadMarker::new().context("Recovery controls require the main thread")?; + let parent = unsafe { webview.superview() }.context("Webview has no containing view")?; + let row = NSBox::new(mtm); + // AppKit may resize the parent after the application's window resize callback. + row.setAutoresizingMask(NSAutoresizingMaskOptions::ViewWidthSizable | NSAutoresizingMaskOptions::ViewMinYMargin); + row.setBoxType(NSBoxType::Custom); + row.setTitlePosition(NSTitlePosition::NoTitle); + row.setContentViewMargins(NSSize::new(0.0, 0.0)); + row.setBorderWidth(0.0); + row.setCornerRadius(0.0); + row.setFillColor(&NSColor::windowBackgroundColor()); + let label = NSTextField::labelWithString(&NSString::new(), mtm); + label.setFont(Some(&NSFont::systemFontOfSize(12.0))); + label.setLineBreakMode(NSLineBreakMode::ByTruncatingTail); + label.setAutoresizingMask(NSAutoresizingMaskOptions::ViewWidthSizable); + let detail = NSTextField::labelWithString(&NSString::new(), mtm); + detail.setFont(Some(&NSFont::systemFontOfSize(11.0))); + detail.setTextColor(Some(&NSColor::secondaryLabelColor())); + detail.setLineBreakMode(NSLineBreakMode::ByTruncatingTail); + detail.setAutoresizingMask(NSAutoresizingMaskOptions::ViewWidthSizable); + let spinner = NSProgressIndicator::new(mtm); + spinner.setStyle(NSProgressIndicatorStyle::Spinning); + spinner.setControlSize(NSControlSize::Small); + spinner.setIndeterminate(true); + let retry = unsafe { NSButton::buttonWithTitle_target_action(&NSString::from_str("Try Again"), None, None, mtm) }; + let cancel = unsafe { NSButton::buttonWithTitle_target_action(&NSString::from_str("Cancel"), None, None, mtm) }; + let proceed = + unsafe { NSButton::buttonWithTitle_target_action(&NSString::from_str("Continue Anyway…"), None, None, mtm) }; + for button in [&retry, &proceed, &cancel] { + button.setAutoresizingMask(NSAutoresizingMaskOptions::ViewMinXMargin); + button.setBezelStyle(NSBezelStyle::Push); + button.setControlSize(NSControlSize::Small); + button.setFont(Some(&NSFont::systemFontOfSize(12.0))); + row.addSubview(button); + } + row.addSubview(&label); + row.addSubview(&detail); + row.addSubview(&spinner); + let blocker = NSView::new(mtm); + blocker + .setAutoresizingMask(NSAutoresizingMaskOptions::ViewWidthSizable | NSAutoresizingMaskOptions::ViewHeightSizable); + parent.addSubview(&blocker); + parent.addSubview(&row); + row.setHidden(true); + blocker.setHidden(true); + let controller = RecoveryRow::alloc(mtm).set_ivars(RecoveryRowIvars { + webview: webview.retain(), + messenger, + row, + blocker, + label, + detail, + proceed, + status: Cell::new(RecoveryStatus::Hidden), + spinner, + retry, + cancel, + keyboard_monitor: RefCell::new(None), + }); + let controller: Retained = unsafe { msg_send![super(controller), init] }; + let weak_controller = Weak::from_retained(&controller); + let handler = RcBlock::new(move |event: std::ptr::NonNull| { + let blocked = weak_controller + .load() + .is_some_and(|controller| controller.handle_key(unsafe { event.as_ref() })); + if blocked { ptr::null_mut() } else { event.as_ptr() } + }); + let monitor = unsafe { NSEvent::addLocalMonitorForEventsMatchingMask_handler(NSEventMask::KeyDown, &handler) } + .context("Failed to guard keyboard input during sign-in recovery")?; + *controller.ivars().keyboard_monitor.borrow_mut() = Some(monitor); + unsafe { + controller.ivars().retry.setTarget(Some(&controller)); + controller.ivars().retry.setAction(Some(sel!(retry:))); + controller.ivars().proceed.setTarget(Some(&controller)); + controller.ivars().proceed.setAction(Some(sel!(continueTls:))); + controller.ivars().cancel.setTarget(Some(&controller)); + controller.ivars().cancel.setAction(Some(sel!(cancel:))); + objc_setAssociatedObject( + Retained::as_ptr(&parent).cast_mut().cast(), + &RECOVERY_ROW_KEY as *const u8 as *const c_void, + Retained::as_ptr(&controller).cast_mut().cast(), + OBJC_ASSOCIATION_RETAIN_NONATOMIC, + ); + } + Ok(()) +} + +fn controller(webview: &WKWebView) -> Option> { + let parent = unsafe { webview.superview() }?; + unsafe { + let pointer = objc_getAssociatedObject( + Retained::as_ptr(&parent).cast_mut().cast(), + &RECOVERY_ROW_KEY as *const u8 as *const c_void, + ) + .cast::(); + Retained::retain(pointer.cast_mut()) + } +} + +pub(super) fn update(webview: &WKWebView, status: RecoveryStatus) -> anyhow::Result<()> { + let controller = controller(webview).context("Recovery controls are unavailable")?; + let controls = controller.ivars(); + let was_blocking = controls.status.replace(status).blocks_page(); + let hidden = status == RecoveryStatus::Hidden; + controls.label.setStringValue(&NSString::from_str(status.message())); + controls.detail.setStringValue(&NSString::from_str(status.detail())); + controls.detail.setHidden(status.detail().is_empty()); + controls.retry.setHidden(!status.can_retry()); + controls.proceed.setHidden(!status.can_continue()); + controls.cancel.setHidden(!status.blocks_page()); + controls.spinner.setHidden(!status.is_busy()); + unsafe { + if status.is_busy() { + controls.spinner.startAnimation(None); + } else { + controls.spinner.stopAnimation(None); + } + } + controls.row.setHidden(hidden); + controls.blocker.setHidden(!status.blocks_page()); + if was_blocking != status.blocks_page() { + if let Some(window) = webview.window() { + if !status.blocks_page() { + window.makeFirstResponder(Some(webview)); + } else { + window.makeFirstResponder(Some(&controls.cancel)); + } + } + } + super::address_bar::resize(webview); + Ok(()) +} + +/// Position the row above the page and return the height reserved for it. +pub(super) fn layout(webview: &WKWebView, content: NSRect) -> f64 { + let Some(controller) = controller(webview) else { + return 0.0; + }; + let controls = controller.ivars(); + if controls.row.isHidden() { + return 0.0; + } + let height = if controls.status.get().detail().is_empty() { + 36.0 + } else { + 52.0 + }; + let width = content.size.width; + controls.row.setFrame(NSRect::new( + NSPoint::new(content.origin.x, content.origin.y + content.size.height - height), + NSSize::new(width, height), + )); + controls.blocker.setFrame(NSRect::new( + content.origin, + NSSize::new(width, (content.size.height - height).max(0.0)), + )); + controls.cancel.setFrame(NSRect::new( + NSPoint::new(width - 80.0, (height - 26.0) / 2.0), + NSSize::new(72.0, 26.0), + )); + controls.retry.setFrame(NSRect::new( + NSPoint::new( + width - 162.0 - if controls.proceed.isHidden() { 0.0 } else { 132.0 }, + (height - 26.0) / 2.0, + ), + NSSize::new(78.0, 26.0), + )); + controls.proceed.setFrame(NSRect::new( + NSPoint::new(width - 212.0, (height - 26.0) / 2.0), + NSSize::new(128.0, 26.0), + )); + controls + .spinner + .setFrame(NSRect::new(NSPoint::new(12.0, 10.0), NSSize::new(16.0, 16.0))); + let left = if controls.spinner.isHidden() { 12.0 } else { 36.0 }; + let right = if !controls.proceed.isHidden() { + width - 220.0 + } else if !controls.retry.isHidden() { + width - 170.0 + } else { + width - 88.0 + }; + controls.label.setFrame(NSRect::new( + NSPoint::new(left, height - 26.0), + NSSize::new((right - left).max(0.0), 17.0), + )); + controls.detail.setFrame(NSRect::new( + NSPoint::new(left, 7.0), + NSSize::new((right - left).max(0.0), 15.0), + )); + height +} diff --git a/crates/auth/src/webview/macos/tls.rs b/crates/auth/src/webview/macos/tls.rs new file mode 100644 index 0000000..258abf3 --- /dev/null +++ b/crates/auth/src/webview/macos/tls.rs @@ -0,0 +1,228 @@ +use anyhow::Context; +use block2::RcBlock; +use objc2::{DefinedClass, MainThreadOnly, rc::Weak}; +use objc2_app_kit::{NSAlert, NSAlertSecondButtonReturn, NSAlertStyle}; +use objc2_foundation::{ + NSError, NSString, NSURL, NSURLErrorDomain, NSURLErrorFailingURLErrorKey, NSURLErrorFailingURLPeerTrustErrorKey, + NSUnderlyingErrorKey, +}; +use objc2_security::{SecTrust, errSecHostNameMismatch}; +use objc2_web_kit::WKWebView; + +use super::super::{ + auth_messenger::{AuthError, AuthEvent}, + tls::{TlsFailure, TlsFailureReason}, +}; + +#[derive(Clone)] +struct CertificateException { + host: String, + certificate: Vec, +} + +#[derive(Clone)] +struct PendingCertificate { + generation: u64, + failure: TlsFailure, + exception: CertificateException, +} + +#[derive(Default)] +pub(super) struct TlsState { + pending: Option, + exceptions: Vec, +} + +impl TlsState { + fn approve(&mut self, pending: &PendingCertificate, generation: u64) -> bool { + if pending.generation != generation + || self.pending.as_ref().is_none_or(|current| { + current.generation != pending.generation + || current.exception.certificate != pending.exception.certificate + || current.exception.host != pending.exception.host + }) + { + return false; + } + self.exceptions.push(pending.exception.clone()); + self.pending = None; + true + } + + pub fn record_failure(&mut self, webview: &WKWebView, error: &NSError, generation: u64) -> Option { + if !error.domain().isEqualToString(unsafe { NSURLErrorDomain }) { + return None; + } + let reason = match error.code() { + -1200 => TlsFailureReason::Handshake, + -1201 => TlsFailureReason::Expired, + -1202 => TlsFailureReason::InvalidCertificate, + -1203 => TlsFailureReason::Untrusted, + -1204 => TlsFailureReason::NotYetValid, + _ => return None, + }; + let reason = if has_hostname_mismatch(error, 0) { + TlsFailureReason::HostnameMismatch + } else { + reason + }; + let url = error + .userInfo() + .objectForKey(unsafe { NSURLErrorFailingURLErrorKey })? + .downcast::() + .ok()?; + let host = url.host()?.to_string().to_ascii_lowercase(); + if let Some(uri) = url.absoluteString() { + super::address_bar::show_address(webview, &uri.to_string()); + } + let trust = error + .userInfo() + .objectForKey(unsafe { NSURLErrorFailingURLPeerTrustErrorKey }); + let certificate = trust.and_then(|trust| { + // Foundation documents this entry as a SecTrustRef. + let trust = unsafe { &*(objc2::rc::Retained::as_ptr(&trust).cast::()) }; + certificate_data(trust) + }); + let failure = TlsFailure { + host: host.clone(), + reason, + can_continue: reason.is_certificate_error() && certificate.is_some(), + }; + self.pending = certificate + .filter(|_| failure.can_continue) + .map(|certificate| PendingCertificate { + generation, + failure: failure.clone(), + exception: CertificateException { host, certificate }, + }); + Some(AuthError::Tls(failure)) + } + + pub fn allows(&self, host: &str, trust: &SecTrust) -> bool { + if self.exceptions.is_empty() { + return false; + } + let Some(certificate) = certificate_data(trust) else { + return false; + }; + self + .exceptions + .iter() + .any(|exception| exception.host.eq_ignore_ascii_case(host) && exception.certificate == certificate) + } +} + +fn has_hostname_mismatch(error: &NSError, depth: usize) -> bool { + if depth > 4 { + return false; + } + if error.code() == errSecHostNameMismatch as isize { + return true; + } + error + .userInfo() + .objectForKey(unsafe { NSUnderlyingErrorKey }) + .and_then(|value| value.downcast::().ok()) + .is_some_and(|error| has_hostname_mismatch(&error, depth + 1)) +} + +fn certificate_data(trust: &SecTrust) -> Option> { + // Retain the leaf immediately. No trust evaluation or mutation runs here. + #[allow(deprecated)] + let certificate = unsafe { trust.certificate_at_index(0) }?; + Some(unsafe { certificate.data() }.to_vec()) +} + +pub(super) fn confirm(webview: &WKWebView) -> anyhow::Result<()> { + let delegate = super::navigation_delegate(webview).context("Auth navigation delegate is unavailable")?; + let pending = delegate + .ivars() + .tls + .borrow() + .pending + .clone() + .context("No certificate error is awaiting confirmation")?; + if pending.generation != delegate.ivars().messenger.generation() { + return Ok(()); + } + let window = webview.window().context("Auth window is unavailable")?; + if window.attachedSheet().is_some() { + return Ok(()); + } + let alert = NSAlert::new(delegate.mtm()); + alert.setAlertStyle(NSAlertStyle::Warning); + alert.setMessageText(&NSString::from_str(&pending.failure.confirmation_title())); + alert.setInformativeText(&NSString::from_str(&pending.failure.confirmation_message())); + alert.addButtonWithTitle(&NSString::from_str("Cancel")); + alert.addButtonWithTitle(&NSString::from_str("Continue Anyway")); + let weak = Weak::from_retained(&delegate); + let handler = RcBlock::new(move |response: isize| { + let Some(delegate) = weak.load() else { + return; + }; + if response != NSAlertSecondButtonReturn || pending.generation != delegate.ivars().messenger.generation() { + return; + } + let mut state = delegate.ivars().tls.borrow_mut(); + if !state.approve(&pending, delegate.ivars().messenger.generation()) { + return; + } + drop(state); + delegate + .ivars() + .messenger + .send_auth_event(AuthEvent::TlsAccepted(pending.generation)); + }); + alert.beginSheetModalForWindow_completionHandler(&window, Some(&handler)); + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn pending() -> PendingCertificate { + PendingCertificate { + generation: 1, + failure: TlsFailure { + host: "login.example".into(), + reason: TlsFailureReason::Expired, + can_continue: true, + }, + exception: CertificateException { + host: "login.example".into(), + certificate: vec![1, 2, 3], + }, + } + } + + #[test] + fn certificate_approval_rejects_stale_attempts_and_replacement_certificates() { + let original = pending(); + let mut state = TlsState { + pending: Some(original.clone()), + ..TlsState::default() + }; + assert!(!state.approve(&original, 2)); + let mut replacement = original.clone(); + replacement.exception.certificate = vec![4, 5, 6]; + state.pending = Some(replacement); + assert!(!state.approve(&original, 1)); + assert!(state.exceptions.is_empty()); + } + + #[test] + fn certificate_approval_is_specific_to_the_host_and_consumed_once() { + let original = pending(); + let mut state = TlsState { + pending: Some(original.clone()), + ..TlsState::default() + }; + let mut other_host = original.clone(); + other_host.exception.host = "other.example".into(); + assert!(!state.approve(&other_host, 1)); + assert!(state.approve(&original, 1)); + assert_eq!(state.exceptions.len(), 1); + assert!(!state.approve(&original, 1)); + } +} diff --git a/crates/auth/src/webview/recovery.rs b/crates/auth/src/webview/recovery.rs new file mode 100644 index 0000000..a3db72a --- /dev/null +++ b/crates/auth/src/webview/recovery.rs @@ -0,0 +1,298 @@ +use super::tls::TlsFailureReason; + +/// Native UI state for recovering an embedded sign-in session. +#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] +pub(super) enum RecoveryStatus { + #[default] + Hidden, + Restarting, + Loading, + Failed, + Rejected, + Tls { + reason: TlsFailureReason, + can_continue: bool, + }, + CertificateBypassed, +} + +impl RecoveryStatus { + pub fn message(self) -> &'static str { + match self { + Self::Hidden => "", + Self::Restarting => "Restarting sign-in…", + Self::Loading => "Loading sign-in…", + Self::Failed => "Couldn’t restart sign-in.", + Self::Rejected => "Sign-in wasn’t completed.", + Self::Tls { + reason: TlsFailureReason::Handshake, + .. + } => "Secure connection failed.", + Self::Tls { .. } => "Cannot verify this server’s identity.", + Self::CertificateBypassed => "Certificate verification bypassed in this window.", + } + } + + pub fn detail(self) -> &'static str { + match self { + Self::Tls { reason, .. } => reason.message(), + _ => "", + } + } + + pub fn can_continue(self) -> bool { + match self { + Self::Tls { reason, can_continue } => can_continue && reason.is_certificate_error(), + _ => false, + } + } + + pub fn blocks_page(self) -> bool { + !matches!(self, Self::Hidden | Self::CertificateBypassed) + } + + pub fn accepts_auth_data(self) -> bool { + matches!(self, Self::Hidden | Self::Loading | Self::CertificateBypassed) + } + + pub fn is_busy(self) -> bool { + matches!(self, Self::Restarting | Self::Loading) + } + + pub fn can_retry(self) -> bool { + matches!( + self, + Self::Failed + | Self::Rejected + | Self::Tls { + reason: TlsFailureReason::Handshake, + .. + } + ) + } +} + +#[derive(Default)] +pub(super) struct Recovery { + status: RecoveryStatus, + automatic_retry_used: bool, + certificate_bypassed: bool, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub(super) enum RetrySource { + FreshPrelogin, + SuppliedRequest, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub(super) enum RetryTiming { + Immediate, + AutomaticDelay, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub(super) struct RetryPlan { + pub source: RetrySource, + pub timing: RetryTiming, +} + +impl Recovery { + pub fn status(&self) -> RecoveryStatus { + self.status + } + + pub fn loading(&mut self) { + self.status = RecoveryStatus::Loading; + } + + pub fn load_failed(&mut self) { + self.status = RecoveryStatus::Failed; + } + + pub fn tls_failed(&mut self, reason: TlsFailureReason, can_continue: bool) { + self.status = RecoveryStatus::Tls { reason, can_continue }; + } + + pub fn certificate_accepted(&mut self) -> Option { + if !self.status.can_continue() { + return None; + } + self.certificate_bypassed = true; + self.status = RecoveryStatus::Restarting; + Some(RetryPlan { + source: RetrySource::SuppliedRequest, + timing: RetryTiming::Immediate, + }) + } + + /// Temporary service failures get one automatic restart per dialog. + /// Duplicate failures while restarting or awaiting user action are ignored. + pub fn failure(&mut self, temporary: bool) -> Option { + if !matches!( + self.status, + RecoveryStatus::Hidden | RecoveryStatus::Loading | RecoveryStatus::CertificateBypassed + ) { + return None; + } + if temporary && !self.automatic_retry_used { + self.automatic_retry_used = true; + self.status = RecoveryStatus::Restarting; + return Some(RetryPlan { + source: RetrySource::FreshPrelogin, + timing: RetryTiming::AutomaticDelay, + }); + } + self.status = if temporary { + RecoveryStatus::Failed + } else { + RecoveryStatus::Rejected + }; + None + } + + pub fn retry(&mut self) -> Option { + if !self.status.can_retry() { + return None; + } + let source = if matches!(self.status, RecoveryStatus::Tls { .. }) { + RetrySource::SuppliedRequest + } else { + RetrySource::FreshPrelogin + }; + self.status = RecoveryStatus::Restarting; + Some(RetryPlan { + source, + timing: RetryTiming::Immediate, + }) + } + + pub fn page_loaded(&mut self) { + if self.status == RecoveryStatus::Loading { + self.status = if self.certificate_bypassed { + RecoveryStatus::CertificateBypassed + } else { + RecoveryStatus::Hidden + }; + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn retry_plans_preserve_request_source_and_timing() { + let mut recovery = Recovery::default(); + assert_eq!( + recovery.failure(true), + Some(RetryPlan { + source: RetrySource::FreshPrelogin, + timing: RetryTiming::AutomaticDelay, + }) + ); + recovery.load_failed(); + assert_eq!( + recovery.retry(), + Some(RetryPlan { + source: RetrySource::FreshPrelogin, + timing: RetryTiming::Immediate, + }) + ); + recovery.tls_failed(TlsFailureReason::Expired, true); + assert_eq!( + recovery.certificate_accepted(), + Some(RetryPlan { + source: RetrySource::SuppliedRequest, + timing: RetryTiming::Immediate, + }) + ); + assert!(recovery.certificate_accepted().is_none()); + } + + #[test] + fn tls_failure_blocks_credentials_and_is_not_cleared_by_page_completion() { + let mut recovery = Recovery { + status: RecoveryStatus::Tls { + reason: TlsFailureReason::Expired, + can_continue: true, + }, + ..Recovery::default() + }; + assert!(recovery.status.blocks_page()); + assert!(!recovery.status.accepts_auth_data()); + assert!(recovery.status.can_continue()); + recovery.page_loaded(); + assert!(matches!(recovery.status, RecoveryStatus::Tls { .. })); + assert!(recovery.failure(true).is_none()); + assert!(matches!(recovery.status, RecoveryStatus::Tls { .. })); + assert!(recovery.retry().is_none()); + assert!(recovery.status.can_continue()); + } + + #[test] + fn handshake_failures_never_offer_a_certificate_exception() { + let status = RecoveryStatus::Tls { + reason: TlsFailureReason::Handshake, + can_continue: true, + }; + assert!(!status.can_continue()); + assert!(status.can_retry()); + assert!(status.blocks_page()); + } + + #[test] + fn certificate_notice_keeps_successful_page_interactive() { + let mut recovery = Recovery { + certificate_bypassed: true, + status: RecoveryStatus::Loading, + ..Recovery::default() + }; + recovery.page_loaded(); + assert_eq!(recovery.status, RecoveryStatus::CertificateBypassed); + assert!(!recovery.status.blocks_page()); + assert!(recovery.status.accepts_auth_data()); + assert!(recovery.failure(false).is_none()); + assert_eq!(recovery.status, RecoveryStatus::Rejected); + } + + #[test] + fn temporary_failure_retries_once_even_after_manual_restarts() { + let mut recovery = Recovery::default(); + assert!(recovery.failure(true).is_some()); + assert!(recovery.failure(true).is_none()); + recovery.status = RecoveryStatus::Loading; + recovery.page_loaded(); + assert!(recovery.failure(true).is_none()); + assert_eq!(recovery.status, RecoveryStatus::Failed); + assert!(recovery.retry().is_some()); + recovery.status = RecoveryStatus::Loading; + assert!(recovery.failure(true).is_none()); + assert_eq!(recovery.status, RecoveryStatus::Failed); + } + + #[test] + fn rejected_auth_requires_user_action_and_deduplicates_errors() { + let mut recovery = Recovery::default(); + assert!(recovery.failure(false).is_none()); + assert_eq!(recovery.status, RecoveryStatus::Rejected); + assert!(recovery.failure(true).is_none()); + assert!(recovery.retry().is_some()); + assert!(recovery.retry().is_none()); + } + + #[test] + fn page_completion_does_not_clear_errors_or_pending_prelogin() { + let mut recovery = Recovery::default(); + recovery.failure(false); + recovery.page_loaded(); + assert_eq!(recovery.status, RecoveryStatus::Rejected); + recovery.retry(); + recovery.page_loaded(); + assert_eq!(recovery.status, RecoveryStatus::Restarting); + recovery.status = RecoveryStatus::Loading; + recovery.page_loaded(); + assert_eq!(recovery.status, RecoveryStatus::Hidden); + } +} diff --git a/crates/auth/src/webview/tls.rs b/crates/auth/src/webview/tls.rs new file mode 100644 index 0000000..f96015a --- /dev/null +++ b/crates/auth/src/webview/tls.rs @@ -0,0 +1,47 @@ +/// A TLS failure that can be presented without exposing request parameters. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub(super) enum TlsFailureReason { + Expired, + NotYetValid, + Untrusted, + HostnameMismatch, + InvalidCertificate, + Handshake, +} + +impl TlsFailureReason { + pub fn is_certificate_error(self) -> bool { + self != Self::Handshake + } + + pub fn message(self) -> &'static str { + match self { + Self::Expired => "The certificate has expired.", + Self::NotYetValid => "The certificate is not valid yet.", + Self::Untrusted => "The certificate was issued by an untrusted authority.", + Self::HostnameMismatch => "The certificate does not match this server’s hostname.", + Self::InvalidCertificate => "The server’s certificate could not be verified.", + Self::Handshake => "The server could not establish a compatible TLS connection.", + } + } +} + +#[derive(Clone, Debug)] +pub(super) struct TlsFailure { + pub host: String, + pub reason: TlsFailureReason, + pub can_continue: bool, +} + +impl TlsFailure { + pub fn confirmation_title(&self) -> String { + format!("Continue to {}?", self.host) + } + + pub fn confirmation_message(&self) -> String { + format!( + "{} Your sign-in information could be intercepted.\n\nThis exception applies only to this host until this sign-in window closes.", + self.reason.message() + ) + } +} diff --git a/crates/auth/src/webview/webview_auth.rs b/crates/auth/src/webview/webview_auth.rs index df043b1..5073201 100644 --- a/crates/auth/src/webview/webview_auth.rs +++ b/crates/auth/src/webview/webview_auth.rs @@ -1,10 +1,11 @@ -use std::{sync::Arc, time::Duration}; +use std::{future::Future, pin::Pin, sync::Arc, time::Duration}; use anyhow::bail; #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] use gpapi::utils::window::{WindowTypeHint, set_window_type_hint}; use gpapi::{ auth::{AuthWindowTheme, AuthenticationCancelled, SamlAuthData}, + error::ServerTlsError, gp_params::GpParams, os_profile::{WebviewUserAgent, WebviewUserAgentTransform}, utils::{redact::redact_uri, window::get_title_bar_height}, @@ -12,17 +13,26 @@ use gpapi::{ use log::{info, warn}; #[cfg(target_os = "macos")] use tauri::Manager; -use tauri::{ - AppHandle, WebviewUrl, WebviewWindow, WindowEvent, - webview::{PageLoadEvent, PageLoadPayload}, -}; +use tauri::{AppHandle, WebviewUrl, WebviewWindow, WindowEvent}; use tokio::{sync::oneshot, time}; use crate::auth_prelogin; +use super::address_bar::TOOLBAR_HEIGHT; use super::auth_messenger::{AuthError, AuthEvent, AuthMessenger}; +use super::recovery::{Recovery, RecoveryStatus, RetryPlan, RetrySource, RetryTiming}; + +const RESTART_TIMEOUT: Duration = Duration::from_secs(30); pub trait PlatformWebviewExt { + fn install_auth_controls(&self, window: &WebviewWindow, messenger: Arc) -> anyhow::Result<()>; + + fn set_recovery_status(&self, status: RecoveryStatus) -> anyhow::Result<()>; + + fn stop_loading(&self); + + fn confirm_tls_exception(&self) -> anyhow::Result<()>; + fn ignore_tls_errors(&self) -> anyhow::Result<()>; fn user_agent(&self) -> anyhow::Result; @@ -33,8 +43,6 @@ pub trait PlatformWebviewExt { fn load_html(&self, html: &str) -> anyhow::Result<()>; - fn get_html(&self, callback: Box) + 'static>); - fn load_auth_request(&self, auth_request: &str) -> anyhow::Result<()> { if auth_request.starts_with("http") { info!("Loading auth request as URL: {}", redact_uri(auth_request)); @@ -59,8 +67,6 @@ pub struct WebviewAuthenticator<'a> { clean: bool, window_title: &'a str, window_theme: AuthWindowTheme, - - is_retrying: tokio::sync::RwLock, } fn native_theme(theme: AuthWindowTheme) -> Option { @@ -89,7 +95,6 @@ impl<'a> WebviewAuthenticator<'a> { clean: false, window_title: "GlobalProtect Login", window_theme: AuthWindowTheme::System, - is_retrying: Default::default(), } } @@ -120,39 +125,13 @@ impl<'a> WebviewAuthenticator<'a> { pub async fn authenticate(&self, app_handle: &AppHandle) -> anyhow::Result { let auth_messenger = Arc::new(AuthMessenger::new()); - let auth_messenger_clone = Arc::clone(&auth_messenger); - - let on_page_load = move |auth_window: WebviewWindow, event: PageLoadPayload<'_>| { - let auth_messenger_clone = Arc::clone(&auth_messenger_clone); - let redacted_url = redact_uri(event.url().as_str()); - - match event.event() { - PageLoadEvent::Started => { - info!("Started loading page: {}", redacted_url); - auth_messenger_clone.cancel_raise_window(); - } - PageLoadEvent::Finished => { - info!("Finished loading page: {}", redacted_url); - } - } - - // Read auth data from the page no matter whether it's finished loading or not - // Because we found that the finished event may not be triggered in some cases (e.g., on macOS) - let _ = auth_window.with_webview(move |wv| { - wv.get_html(Box::new(move |html| match html { - Ok(html) => auth_messenger_clone.read_from_html(&html), - Err(err) => warn!("Failed to get html: {}", err), - })); - }); - }; - let auth_window_builder = WebviewWindow::builder(app_handle, "auth_window", WebviewUrl::default()) - .on_page_load(on_page_load) .title(self.window_title) .theme(native_theme(self.window_theme)) .devtools(cfg!(any(debug_assertions, feature = "release-devtools"))); let auth_window = auth_window_builder - .inner_size(900.0, 650.0 + get_title_bar_height()) + .inner_size(900.0, 650.0 + get_title_bar_height() + TOOLBAR_HEIGHT) + .min_inner_size(400.0, 300.0) .focused(true) .visible(false) .center() @@ -161,38 +140,169 @@ impl<'a> WebviewAuthenticator<'a> { #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] set_window_type_hint(&auth_window, WindowTypeHint::Dialog)?; - self - .setup_auth_window(&auth_window, Arc::clone(&auth_messenger)) - .await?; - - if present_after_setup(self.clean) { - self.raise_window(&auth_window); + let messenger = Arc::clone(&auth_messenger); + let raise_task = tokio::spawn(async move { + time::sleep(Duration::from_secs(10)).await; + messenger.send_auth_event(AuthEvent::RaiseWindow); + }); + let result = async { + self + .setup_auth_window(&auth_window, Arc::clone(&auth_messenger)) + .await?; + if present_after_setup(self.clean) { + self.raise_window(&auth_window); + } + self.wait_for_auth(&auth_window, Arc::clone(&auth_messenger)).await } + .await; + + raise_task.abort(); + auth_messenger.begin_attempt(); + auth_messenger.cancel_raise_window(); + // Preserve the authentication outcome even if native teardown fails. + if let Err(error) = auth_window.close() { + warn!("Failed to close authentication window: {error}"); + } + result + } + + async fn wait_for_auth( + &self, + auth_window: &WebviewWindow, + auth_messenger: Arc, + ) -> anyhow::Result { + let mut recovery = Recovery::default(); + let mut restart: Option> + Send + '_>>> = None; + let mut loading_deadline = None; loop { - match auth_messenger.subscribe().await? { - AuthEvent::Close => bail!(AuthenticationCancelled), - AuthEvent::RaiseWindow => self.raise_window(&auth_window), - #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] - AuthEvent::Error(AuthError::TlsError) => bail!(gpapi::error::PortalError::TlsError), - AuthEvent::Error(AuthError::NotFound(location)) => { + let event = tokio::select! { + event = auth_messenger.subscribe() => event?, + result = async { + match restart.as_mut() { + Some(restart) => restart.await, + None => std::future::pending().await, + } + } => { + restart = None; + match result { + Ok(auth_request) => { + // Fence off reads and cancellation notifications from the old page. + auth_messenger.begin_attempt(); + recovery.loading(); + loading_deadline = Some(time::Instant::now() + RESTART_TIMEOUT); + self.load_restarted_sign_in(auth_window, &auth_messenger, auth_request)?; + } + Err(err) => { + warn!("Failed to restart sign-in: {}", err); + if err.downcast_ref::().is_some() { + return Err(err); + } + recovery.load_failed(); + } + } + self.update_recovery(auth_window, recovery.status())?; + continue; + } + _ = async { + match loading_deadline { + Some(deadline) => time::sleep_until(deadline).await, + None => std::future::pending().await, + } + } => { + loading_deadline = None; + recovery.load_failed(); + self.update_recovery(auth_window, recovery.status())?; + continue; + } + }; + let mut retry_plan = None; + match event { + AuthEvent::Close => { + bail!(AuthenticationCancelled); + } + AuthEvent::RaiseWindow => self.raise_window(auth_window), + AuthEvent::Data(generation, ..) + | AuthEvent::Error(generation, _) + | AuthEvent::NoAuthData(generation, _) + | AuthEvent::PageLoaded(generation) + | AuthEvent::TlsAccepted(generation) + if generation != auth_messenger.generation() => + { + continue; + } + AuthEvent::Error(_, AuthError::Tls(failure)) => { + warn!("TLS failure for {}: {}", failure.host, failure.reason.message()); + restart = None; + loading_deadline = None; + recovery.tls_failed(failure.reason, failure.can_continue); + } + AuthEvent::RequestTlsException => { + if recovery.status().can_continue() { + auth_window.with_webview(|wv| { + if let Err(err) = wv.confirm_tls_exception() { + warn!("Failed to confirm certificate exception: {}", err); + } + })?; + } + } + AuthEvent::TlsAccepted(_) => { + retry_plan = recovery.certificate_accepted(); + } + AuthEvent::NoAuthData(_, location) => { info!( "No auth data found in {:?}, it may not be the /SAML20/SP/ACS endpoint", location ); - self.handle_not_found(&auth_window, &auth_messenger); + self.handle_not_found(auth_window, &auth_messenger); } - AuthEvent::Error(AuthError::Invalid(err, location)) => { + AuthEvent::Error(_, AuthError::Invalid(err, location)) => { warn!("Got invalid auth data in {:?}: {}", location, err); - self.retry_auth(&auth_window).await; + recovery.failure(false); } - AuthEvent::Data(auth_data, location) => { + AuthEvent::Error(_, AuthError::TemporarilyUnavailable) => { + retry_plan = recovery.failure(true); + } + AuthEvent::Error(_, AuthError::LoadFailed(err)) => { + if matches!( + recovery.status(), + RecoveryStatus::Loading | RecoveryStatus::Hidden | RecoveryStatus::CertificateBypassed + ) { + warn!("Failed to load sign-in: {}", err); + recovery.load_failed(); + loading_deadline = None; + } + } + AuthEvent::Retry => { + retry_plan = recovery.retry(); + } + AuthEvent::PageLoaded(_) => { + recovery.page_loaded(); + if !recovery.status().blocks_page() { + loading_deadline = None; + } + } + AuthEvent::Data(_, auth_data, location) => { + if !recovery.status().accepts_auth_data() { + continue; + } info!("Got auth data from {:?}", location); - auth_window.close()?; return Ok(auth_data); } } + if let Some(plan) = retry_plan { + loading_deadline = None; + auth_messenger.begin_attempt(); + auth_window.with_webview(|wv| wv.stop_loading())?; + restart = Some(Box::pin(async move { + time::timeout(RESTART_TIMEOUT, self.request_sign_in(plan)).await? + })); + } + if recovery.status() != RecoveryStatus::Loading { + loading_deadline = None; + } + self.update_recovery(auth_window, recovery.status())?; } } @@ -216,13 +326,6 @@ impl<'a> WebviewAuthenticator<'a> { } }); - // Show the window after 10 seconds, so that the user can see the window if the auth process is stuck - let auth_messenger_clone = Arc::clone(&auth_messenger); - tokio::spawn(async move { - time::sleep(Duration::from_secs(10)).await; - auth_messenger_clone.send_auth_event(AuthEvent::RaiseWindow); - }); - let auth_request = match self.auth_request { Some(auth_request) => auth_request.to_string(), None => auth_prelogin(&self.server, &self.gp_params, false, false).await?, @@ -231,19 +334,13 @@ impl<'a> WebviewAuthenticator<'a> { let (tx, rx) = oneshot::channel::>(); let ignore_tls_errors = self.gp_params.ignore_tls_errors(); let webview_user_agent = self.webview_user_agent.clone(); + let window = auth_window.clone(); // Set up webview auth_window.with_webview(move |wv| { - #[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))] - { - use super::platform_impl::PlatformWebviewOnResponse; - wv.on_response(Box::new(move |response| match response { - Ok(response) => auth_messenger.read_from_response(&response), - Err(err) => auth_messenger.send_auth_error(err), - })); - } - + let controls_messenger = Arc::clone(&auth_messenger); let result = || -> anyhow::Result<()> { + wv.install_auth_controls(&window, controls_messenger)?; if ignore_tls_errors { wv.ignore_tls_errors()?; } @@ -271,49 +368,48 @@ impl<'a> WebviewAuthenticator<'a> { auth_messenger.schedule_raise_window(2); } - async fn retry_auth(&self, auth_window: &WebviewWindow) { - let mut is_retrying = self.is_retrying.write().await; - if *is_retrying { - info!("Already retrying authentication, skipping..."); - return; + fn update_recovery(&self, auth_window: &WebviewWindow, status: RecoveryStatus) -> anyhow::Result<()> { + if status != RecoveryStatus::Hidden { + self.raise_window(auth_window); } - - *is_retrying = true; - drop(is_retrying); - - if let Err(err) = self.retry_auth_impl(auth_window).await { - warn!("Failed to retry authentication: {}", err); - } - - *self.is_retrying.write().await = false; - } - - async fn retry_auth_impl(&self, auth_window: &WebviewWindow) -> anyhow::Result<()> { - info!("Retrying authentication..."); - - auth_window.eval( r#" - var loading = document.createElement("div"); - loading.innerHTML = '
Got invalid token, retrying...
'; - loading.style = "position: fixed; top: 0; left: 0; width: 100%; height: 100%; background: rgba(255, 255, 255, 0.85); z-index: 99999;"; - document.body.appendChild(loading); - "#)?; - - let auth_request = auth_prelogin(&self.server, &self.gp_params, false, false).await?; - - let (tx, rx) = oneshot::channel::>(); - let webview_user_agent = self.webview_user_agent.clone(); auth_window.with_webview(move |wv| { - let result = || -> anyhow::Result<()> { - load_auth_request_with_user_agent(&wv, webview_user_agent.as_ref(), &auth_request) - }(); - - if let Err(result) = tx.send(result) { - warn!("Failed to send retry auth result: {:?}", result); + if let Err(err) = wv.set_recovery_status(status) { + warn!("Failed to update sign-in status: {}", err); } })?; + Ok(()) + } - rx.await??; + async fn request_sign_in(&self, plan: RetryPlan) -> anyhow::Result { + info!("Restarting sign-in..."); + if plan.timing == RetryTiming::AutomaticDelay { + time::sleep(Duration::from_secs(1)).await; + } + if plan.source == RetrySource::SuppliedRequest { + if let Some(request) = self.auth_request { + return Ok(request.to_owned()); + } + } + auth_prelogin(self.server, self.gp_params, false, false).await + } + fn load_restarted_sign_in( + &self, + auth_window: &WebviewWindow, + messenger: &Arc, + auth_request: String, + ) -> anyhow::Result<()> { + let webview_user_agent = self.webview_user_agent.clone(); + let generation = messenger.generation(); + let messenger = Arc::clone(messenger); + auth_window.with_webview(move |wv| { + if generation != messenger.generation() { + return; + } + if let Err(err) = load_auth_request_with_user_agent(&wv, webview_user_agent.as_ref(), &auth_request) { + messenger.send_auth_event(AuthEvent::Error(generation, AuthError::LoadFailed(err))); + } + })?; Ok(()) } diff --git a/crates/common/src/binary_paths.rs b/crates/common/src/binary_paths.rs index da0d40d..7498a62 100644 --- a/crates/common/src/binary_paths.rs +++ b/crates/common/src/binary_paths.rs @@ -108,17 +108,6 @@ fn sibling_binary_for_executable(executable: &Path, binary_name: &str) -> Option None } -#[cfg(target_os = "macos")] -pub fn bundled_vpnc_script() -> Option { - bundled_vpnc_script_for_executable(&env::current_exe().ok()?) -} - -#[cfg(target_os = "macos")] -fn bundled_vpnc_script_for_executable(executable: &Path) -> Option { - let executable = executable.canonicalize().ok()?; - macos::vpnc_script_path(&executable) -} - fn is_file(path: &Path) -> bool { path.is_file() } @@ -174,18 +163,6 @@ mod tests { 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] diff --git a/crates/common/src/binary_paths/macos.rs b/crates/common/src/binary_paths/macos.rs index bd0b972..4a765fa 100644 --- a/crates/common/src/binary_paths/macos.rs +++ b/crates/common/src/binary_paths/macos.rs @@ -17,29 +17,3 @@ fn contents_dir(executable: &Path) -> Option<&Path> { pub(super) fn helper_path(executable: &Path, binary_name: &str) -> Option { Some(contents_dir(executable)?.join("Helpers").join(binary_name)) } - -pub(super) fn vpnc_script_path(executable: &Path) -> Option { - 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()); - } -} diff --git a/crates/gpapi/Cargo.toml b/crates/gpapi/Cargo.toml index 3318901..9190e4c 100644 --- a/crates/gpapi/Cargo.toml +++ b/crates/gpapi/Cargo.toml @@ -13,9 +13,10 @@ base64.workspace = true dns-lookup.workspace = true log.workspace = true reqwest.workspace = true -openssl.workspace = true -version-compare = "0.2" +native-tls = "0.2" pem.workspace = true +pkcs8 = { version = "0.11", features = ["pem", "encryption", "sha1-insecure", "3des", "des-insecure"] } +x509-cert = { version = "0.3", default-features = false } xmltree.workspace = true serde.workspace = true specta = { workspace = true, features = ["derive", "uuid"] } @@ -27,14 +28,12 @@ whoami.workspace = true tempfile.workspace = true thiserror.workspace = true chacha20poly1305 = { version = "0.11", features = ["zeroize"] } -redact-engine.workspace = true url.workspace = true regex.workspace = true uzers.workspace = true serde_urlencoded.workspace = true md5.workspace = true -sha256.workspace = true -sha2 = { version = "0.11", default-features = false } +sha2.workspace = true uuid = { workspace = true, features = ["v4", "v5", "serde"] } chrono.workspace = true humantime.workspace = true @@ -54,13 +53,19 @@ env_logger = { workspace = true, optional = true } log-reload = { version = "0.1", optional = true } [target.'cfg(target_os="macos")'.dependencies] +security-framework = "3" oslog = { version = "0.2", default-features = false, optional = true } # Dependencies for Linux and other OSes only [target.'cfg(not(any(target_os="macos", target_os="windows")))'.dependencies] gtk = { version = "0.18", optional = true } +[target.'cfg(not(target_os = "macos"))'.dependencies] +openssl.workspace = true +version-compare = "0.2" + [dev-dependencies] +openssl.workspace = true proptest.workspace = true tokio = { workspace = true, features = ["test-util"] } diff --git a/crates/gpapi/src/auth.rs b/crates/gpapi/src/auth.rs index 5250f21..794b3a2 100644 --- a/crates/gpapi/src/auth.rs +++ b/crates/gpapi/src/auth.rs @@ -49,6 +49,7 @@ pub enum SamlAuthResult { Success(SamlAuthData), Cancelled, Failure(String), + ServerTlsError(crate::error::ServerTlsError), } #[derive(Debug)] @@ -68,6 +69,7 @@ impl SamlAuthResult { SamlAuthResult::Success(_) => true, SamlAuthResult::Cancelled => false, SamlAuthResult::Failure(_) => false, + SamlAuthResult::ServerTlsError(_) => false, } } @@ -76,6 +78,7 @@ impl SamlAuthResult { SamlAuthResult::Success(auth_data) => auth_data.host_id(), SamlAuthResult::Cancelled => None, SamlAuthResult::Failure(_) => None, + SamlAuthResult::ServerTlsError(_) => None, } } } diff --git a/crates/gpapi/src/clap/mod.rs b/crates/gpapi/src/clap/mod.rs index 55c9c69..61c8d07 100644 --- a/crates/gpapi/src/clap/mod.rs +++ b/crates/gpapi/src/clap/mod.rs @@ -4,13 +4,14 @@ use clap_verbosity_flag::{LogLevel, Verbosity, VerbosityFilter}; use log::Level; use crate::{ - error::PortalError, + error::ServerTlsErrorKind, log_format::{LogFormat, write_json_record}, }; pub mod args; pub trait Args { + #[cfg(not(target_os = "macos"))] fn fix_openssl(&self) -> bool; fn ignore_tls_errors(&self) -> bool; @@ -26,7 +27,7 @@ pub trait Args { /// workaround. Empty when there is nothing useful to say — including when the /// relevant option is already in use. fn retry_hints(err: &anyhow::Error, args: &impl Args) -> Vec { - let Some(err) = err.downcast_ref::() else { + let Some(kind) = ServerTlsErrorKind::from_error(err) else { return Vec::new(); }; @@ -42,14 +43,15 @@ fn retry_hints(err: &anyhow::Error, args: &impl Args) -> Vec { // users already see; keep it exactly. let mut hints = Vec::new(); - if err.is_legacy_openssl_error() && !args.fix_openssl() { + #[cfg(not(target_os = "macos"))] + if kind == ServerTlsErrorKind::LegacyRenegotiation && !args.fix_openssl() { let (program, rest) = command_line(); hints.push(format!( "Re-run it with the `--fix-openssl` option to work around this issue, e.g.:\n\n{program} --fix-openssl {rest}" )); } - if err.is_tls_error() && !args.ignore_tls_errors() { + if kind == ServerTlsErrorKind::Certificate && !args.ignore_tls_errors() { let (program, rest) = command_line(); hints.push(format!( "Re-run it with the `--ignore-tls-errors` option to ignore the certificate error, e.g.:\n\n{program} --ignore-tls-errors {rest}" @@ -191,15 +193,25 @@ mod tests { use anyhow::anyhow; use super::*; + use crate::error::ServerTlsError; + + fn certificate_error() -> ServerTlsError { + ServerTlsError { + server: "https://vpn.example.com".into(), + kind: ServerTlsErrorKind::Certificate, + } + } #[derive(Default)] struct TestArgs { + #[cfg(not(target_os = "macos"))] fix_openssl: bool, ignore_tls_errors: bool, log_format: LogFormat, } impl Args for TestArgs { + #[cfg(not(target_os = "macos"))] fn fix_openssl(&self) -> bool { self.fix_openssl } @@ -224,7 +236,7 @@ mod tests { }; let mut out = Vec::new(); - handle_error_to(&mut out, anyhow!(PortalError::TlsError), &args).expect("writing to a Vec cannot fail"); + handle_error_to(&mut out, anyhow!(certificate_error()), &args).expect("writing to a Vec cannot fail"); let out = String::from_utf8(out).expect("output should be UTF-8"); for line in out.lines() { @@ -235,7 +247,7 @@ mod tests { #[test] fn a_tls_failure_suggests_ignoring_tls_errors() { - let hints = retry_hints(&anyhow!(PortalError::TlsError), &TestArgs::default()); + let hints = retry_hints(&anyhow!(certificate_error()), &TestArgs::default()); assert_eq!(hints.len(), 1, "expected one hint, got {hints:?}"); assert!(hints[0].contains("--ignore-tls-errors"), "got {:?}", hints[0]); @@ -247,6 +259,34 @@ mod tests { ); } + #[test] + fn hints_distinguish_legacy_and_unknown_tls_and_respect_both_flags() { + let legacy = ServerTlsError { + server: "https://vpn.example.com".into(), + kind: ServerTlsErrorKind::LegacyRenegotiation, + }; + let hints = retry_hints(&anyhow!(legacy.clone()), &TestArgs::default()); + if cfg!(target_os = "macos") { + assert!(hints.is_empty()); + } else { + assert_eq!(hints.len(), 1); + assert!(hints[0].contains("--fix-openssl")); + } + let args = TestArgs { + #[cfg(not(target_os = "macos"))] + fix_openssl: true, + ignore_tls_errors: true, + ..Default::default() + }; + assert!(retry_hints(&anyhow!(legacy), &args).is_empty()); + assert!(retry_hints(&anyhow!(certificate_error()), &args).is_empty()); + let other = ServerTlsError { + server: "https://vpn.example.com".into(), + kind: ServerTlsErrorKind::Other, + }; + assert!(retry_hints(&anyhow!(other), &TestArgs::default()).is_empty()); + } + /// Suggesting an option the user already passed is noise, and in JSON mode it /// would be an extra record on every failed run. #[test] @@ -256,7 +296,7 @@ mod tests { ..Default::default() }; - assert!(retry_hints(&anyhow!(PortalError::TlsError), &args).is_empty()); + assert!(retry_hints(&anyhow!(certificate_error()), &args).is_empty()); } /// Most failures have no known workaround; inventing advice for them would @@ -272,7 +312,7 @@ mod tests { let hints = vec!["Re-run it with the `--ignore-tls-errors` option".to_string()]; let mut out = Vec::new(); - write_failure(&mut out, format, &anyhow!(PortalError::TlsError), &hints).expect("writing to a Vec cannot fail"); + write_failure(&mut out, format, &anyhow!(certificate_error()), &hints).expect("writing to a Vec cannot fail"); String::from_utf8(out).expect("output should be UTF-8") } diff --git a/crates/gpapi/src/credential.rs b/crates/gpapi/src/credential.rs index 2617fcc..a5cb5ef 100644 --- a/crates/gpapi/src/credential.rs +++ b/crates/gpapi/src/credential.rs @@ -252,6 +252,7 @@ impl TryFrom for Credential { SamlAuthResult::Success(auth_data) => Ok(Self::from(auth_data)), SamlAuthResult::Cancelled => bail!(AuthenticationCancelled), SamlAuthResult::Failure(err) => bail!(err), + SamlAuthResult::ServerTlsError(err) => Err(err.into()), } } } diff --git a/crates/gpapi/src/error.rs b/crates/gpapi/src/error.rs index a87ad45..76164a2 100644 --- a/crates/gpapi/src/error.rs +++ b/crates/gpapi/src/error.rs @@ -1,5 +1,8 @@ use thiserror::Error; +mod server_tls; +pub use server_tls::{ServerTlsError, ServerTlsErrorKind}; + #[derive(Error, Debug)] pub enum PortalError { #[error("Prelogin error: {0}")] @@ -10,18 +13,14 @@ pub enum PortalError { #[error(transparent)] NetworkError(#[from] reqwest::Error), - - #[error("TLS error")] - TlsError, } impl PortalError { - pub fn is_legacy_openssl_error(&self) -> bool { - format!("{:?}", self).contains("unsafe legacy renegotiation") - } - - pub fn is_tls_error(&self) -> bool { - matches!(self, PortalError::TlsError) || format!("{:?}", self).contains("certificate verify failed") + fn tls_error_kind(&self) -> Option { + match self { + Self::NetworkError(error) => server_tls::classify(error), + _ => None, + } } } diff --git a/crates/gpapi/src/error/server_tls.rs b/crates/gpapi/src/error/server_tls.rs new file mode 100644 index 0000000..c221d43 --- /dev/null +++ b/crates/gpapi/src/error/server_tls.rs @@ -0,0 +1,515 @@ +use std::{error::Error, fmt}; + +use serde::{Deserialize, Serialize}; + +use super::PortalError; + +#[cfg(target_os = "macos")] +#[path = "server_tls/macos.rs"] +mod backend; +#[cfg(not(target_os = "macos"))] +#[path = "server_tls/openssl.rs"] +mod backend; + +/// A VPN HTTP TLS failure. The server identifies the configured VPN origin, +/// not necessarily the peer that failed after an HTTP redirect. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ServerTlsError { + pub server: String, + pub kind: ServerTlsErrorKind, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub enum ServerTlsErrorKind { + Certificate, + ClientCertificateRequired, + LegacyRenegotiation, + Other, +} + +impl ServerTlsError { + pub(crate) fn from_request(server: &url::Url, error: &(dyn Error + 'static)) -> Option { + Some(Self { + server: server.origin().ascii_serialization(), + kind: classify(error)?, + }) + } +} + +impl fmt::Display for ServerTlsError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let message = match self.kind { + ServerTlsErrorKind::Certificate => "The server's certificate could not be verified", + ServerTlsErrorKind::ClientCertificateRequired => "The server requires a client certificate", + ServerTlsErrorKind::LegacyRenegotiation => "The server requires unsafe legacy TLS renegotiation", + ServerTlsErrorKind::Other => "A secure connection to the server could not be established", + }; + write!(f, "{message}: {}", self.server) + } +} + +impl Error for ServerTlsError {} + +impl ServerTlsErrorKind { + /// One classification interface for CLI hints and desktop error mapping. + pub fn from_error(error: &anyhow::Error) -> Option { + error.chain().find_map(|source| { + source + .downcast_ref::() + .map(|error| error.kind) + .or_else(|| { + source + .downcast_ref::() + .and_then(PortalError::tls_error_kind) + }) + }) + } +} + +pub(super) fn classify(error: &(dyn Error + 'static)) -> Option { + let mut source = Some(error); + let mut fallback = None; + while let Some(error) = source { + if let Some(tls) = error.downcast_ref::() { + return Some(tls.kind); + } + if let Some(kind) = backend::classify(error) { + return Some(kind); + } + if let Some(tls) = error.downcast_ref::() { + let kind = classify_native(tls); + if kind != ServerTlsErrorKind::Other { + return Some(kind); + } + fallback = Some(kind); + } + source = error + .downcast_ref::() + .and_then(|error| error.get_ref().map(|inner| inner as &(dyn Error + 'static))) + .or_else(|| error.source()); + } + fallback +} + +fn classify_native(error: &native_tls::Error) -> ServerTlsErrorKind { + // native-tls hides some backend reason codes and verification results. Keep + // backend text matching here, scoped to a confirmed native TLS error. + let detail = format!("{error:?}").to_ascii_lowercase(); + classify_native_detail(&detail) +} + +fn classify_native_detail(detail: &str) -> ServerTlsErrorKind { + // native-tls forwards Security.framework's Debug representation, but hides + // its OSStatus from the public error chain. Prefer that status to localized + // text, including for peer alerts that can mention a rejected client cert. + if let Some(code) = detail + .strip_prefix("error { code: ") + .and_then(|detail| detail.split_once(',')) + .and_then(|(code, _)| code.parse::().ok()) + { + return classify_macos_status(code); + } + if detail.contains("unsafe legacy renegotiation") { + return ServerTlsErrorKind::LegacyRenegotiation; + } + if detail.contains("alert certificate required") { + return ServerTlsErrorKind::ClientCertificateRequired; + } + let certificate = [ + "certificate verify failed", + "certificate verification failed", + "certificate was not trusted", + "certificate is not trusted", + "self signed certificate", + "hostname mismatch", + "certificate has expired", + "certificate is not yet valid", + "certificate has been revoked", + ] + .iter() + .any(|reason| detail.contains(reason)); + if certificate { + ServerTlsErrorKind::Certificate + } else { + ServerTlsErrorKind::Other + } +} + +fn classify_macos_status(code: i32) -> ServerTlsErrorKind { + if code == -9863 { + return ServerTlsErrorKind::ClientCertificateRequired; + } + // Local server-certificate validation failures from Security/SecBase.h. + // Peer alerts (errSSLPeer*) reject our client certificate; protocol/cipher, + // keychain, and internal errors also cannot be fixed by skipping server trust. + let certificate = matches!( + code, + -9807 // errSSLXCertChainInvalid + | -9812 // errSSLUnknownRootCert + | -9813 // errSSLNoRootCert + | -9814 // errSSLCertExpired + | -9815 // errSSLCertNotYetValid + | -9843 // errSSLHostNameMismatch + | -9884 // errSSLATSLeafCertificateHashAlgorithmViolation + | -9885 // errSSLATSCertificateHashAlgorithmViolation + | -9886 // errSSLATSCertificateTrustViolation + | -67602 // errSecHostNameMismatch + | -67603 // errSecUnknownCriticalExtensionFlag + | -67604 // errSecNoBasicConstraints + | -67605 // errSecNoBasicConstraintsCA + | -67606 // errSecInvalidAuthorityKeyID + | -67607 // errSecInvalidSubjectKeyID + | -67608 // errSecInvalidKeyUsageForPolicy + | -67609 // errSecInvalidExtendedKeyUsage + | -67610 // errSecInvalidIDLinkage + | -67611 // errSecPathLengthConstraintExceeded + | -67612 // errSecInvalidRoot + | -67629 // errSecSSLBadExtendedKeyUsage + | -67654 // errSecTrustSettingDeny + | -67818 // errSecCertificateExpired + | -67819 // errSecCertificateNotValidYet + | -67820 // errSecCertificateRevoked + | -67821 // errSecCertificateSuspended + | -67826 // errSecInvalidCertAuthority + | -67843 // errSecNotTrusted + | -67899 // errSecCertificatePolicyNotAllowed + | -67900 // errSecCertificateNameNotAllowed + | -67901 // errSecCertificateValidityPeriodTooLong + | -67902 // errSecCertificateIsCA + | -67903 // errSecCertificateDuplicateExtension + | -67904 // errSecMissingQualifiedCertStatement + ); + if certificate { + ServerTlsErrorKind::Certificate + } else { + ServerTlsErrorKind::Other + } +} + +#[cfg(test)] +mod tests { + use super::*; + use openssl::{ + asn1::Asn1Time, + hash::MessageDigest, + pkey::PKey, + rsa::Rsa, + ssl::{SslAcceptor, SslMethod, SslVerifyMode}, + x509::{X509, X509NameBuilder}, + }; + use std::{ + io::{Read, Write}, + net::TcpListener, + thread, + time::Duration, + }; + + #[test] + fn explicit_client_certificate_requirement_has_a_distinct_kind() { + let kind = classify_native_detail("error { code: -9863, message: \"localized message\" }"); + assert_eq!(serde_json::to_value(kind).unwrap(), "clientCertificateRequired"); + assert_eq!( + classify_native_detail("error { code: -9842, message: \"client cert requested\" }"), + ServerTlsErrorKind::Other + ); + } + + #[test] + fn macos_certificate_statuses_do_not_depend_on_the_error_message() { + for code in [-67818, -67819, -67820, -67843, -67602, -67629, -67899, -67901] { + let detail = format!("error {{ code: {code}, message: \"localized message\" }}"); + assert_eq!( + classify_native_detail(&detail), + ServerTlsErrorKind::Certificate, + "{code}" + ); + } + } + + #[test] + fn macos_peer_alerts_and_handshake_errors_are_not_certificate_validation_failures() { + for (code, message) in [ + (-9800, "SSL protocol error"), + (-9801, "Cipher Suite negotiation failure"), + (-9828, "peer certificate has expired"), + (-9831, "unknown certificate authority"), + (-9850, "weak ephemeral DH key"), + ] { + let detail = format!("error {{ code: {code}, message: \"{message}\" }}").to_ascii_lowercase(); + assert_eq!(classify_native_detail(&detail), ServerTlsErrorKind::Other, "{code}"); + } + } + + fn server(tls: bool) -> (String, thread::JoinHandle<()>) { + server_with_client_auth(tls, SslVerifyMode::NONE) + } + + fn server_with_client_auth(tls: bool, verify: SslVerifyMode) -> (String, thread::JoinHandle<()>) { + let key = PKey::from_rsa(Rsa::generate(2048).unwrap()).unwrap(); + let mut name = X509NameBuilder::new().unwrap(); + name.append_entry_by_text("CN", "localhost").unwrap(); + let name = name.build(); + let mut cert = X509::builder().unwrap(); + cert.set_version(2).unwrap(); + cert.set_subject_name(&name).unwrap(); + cert.set_issuer_name(&name).unwrap(); + cert.set_pubkey(&key).unwrap(); + cert.set_not_before(&Asn1Time::days_from_now(0).unwrap()).unwrap(); + cert.set_not_after(&Asn1Time::days_from_now(1).unwrap()).unwrap(); + cert.sign(&key, MessageDigest::sha256()).unwrap(); + let mut acceptor = SslAcceptor::mozilla_intermediate_v5(SslMethod::tls()).unwrap(); + acceptor.set_private_key(&key).unwrap(); + acceptor.set_certificate(&cert.build()).unwrap(); + acceptor.set_verify(verify); + acceptor + .set_ca_file(concat!( + env!("CARGO_MANIFEST_DIR"), + "/tests/files/client-identity/root.pem" + )) + .unwrap(); + let acceptor = acceptor.build(); + let listener = TcpListener::bind("127.0.0.1:0").unwrap(); + let address = format!("https://{}", listener.local_addr().unwrap()); + let worker = thread::spawn(move || { + let (mut stream, _) = listener.accept().unwrap(); + stream.set_read_timeout(Some(Duration::from_secs(5))).unwrap(); + stream.set_write_timeout(Some(Duration::from_secs(5))).unwrap(); + let body = "SuccessREDIRECTaHR0cHM6Ly9pZHAuZXhhbXBsZS5jb20v"; + let response = format!( + "HTTP/1.1 200 OK\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{body}", + body.len() + ); + let mut request = [0; 8192]; + if tls { + if let Ok(mut stream) = acceptor.accept(stream) { + let _ = stream.read(&mut request); + let _ = stream.write_all(response.as_bytes()); + } + } else { + let _ = stream.read(&mut request); + let _ = stream.write_all(response.as_bytes()); + } + }); + (address, worker) + } + + #[tokio::test] + async fn prelogin_returns_typed_certificate_failure_with_only_the_server_origin() { + use crate::{ + gp_params::GpParams, + os_profile::{ClientOs, OsProfile}, + portal::{PreloginOptions, prelogin}, + }; + let (address, worker) = server(true); + let profile = OsProfile::builder(ClientOs::Linux).build(); + let params = GpParams::builder(profile).build(); + let error = prelogin(&address, ¶ms, PreloginOptions::default()) + .await + .unwrap_err(); + worker.join().unwrap(); + let tls = error + .downcast_ref::() + .unwrap_or_else(|| panic!("unclassified: {error:?}")); + assert_eq!(tls.kind, ServerTlsErrorKind::Certificate); + assert_eq!(tls.server, address); + } + + #[tokio::test] + async fn certificate_bypass_allows_prelogin() { + use crate::{ + gp_params::GpParams, + os_profile::{ClientOs, OsProfile}, + portal::{PreloginOptions, prelogin}, + }; + let (address, worker) = server(true); + let params = GpParams::builder(OsProfile::builder(ClientOs::Linux).build()) + .ignore_tls_errors(true) + .build(); + let result = prelogin(&address, ¶ms, PreloginOptions::default()).await; + worker.join().unwrap(); + assert!(matches!(result.unwrap(), crate::portal::Prelogin::Saml(_))); + } + + #[tokio::test] + async fn incompatible_tls_is_not_a_certificate_error_even_with_bypass() { + let (address, worker) = server(false); + let error = reqwest::Client::builder() + .no_proxy() + .danger_accept_invalid_certs(true) + .build() + .unwrap() + .get(&address) + .send() + .await + .unwrap_err(); + worker.join().unwrap(); + let tls = ServerTlsError::from_request(&url::Url::parse(&address).unwrap(), &error).unwrap(); + assert_eq!(tls.kind, ServerTlsErrorKind::Other); + } + + #[tokio::test] + async fn connection_refused_is_not_tls() { + let listener = TcpListener::bind("127.0.0.1:0").unwrap(); + let address = format!("https://{}", listener.local_addr().unwrap()); + drop(listener); + let error = reqwest::Client::builder() + .no_proxy() + .build() + .unwrap() + .get(address) + .send() + .await + .unwrap_err(); + assert_eq!(classify(&error), None); + } + + #[cfg(target_os = "macos")] + #[test] + fn wrapped_macos_io_status_retains_the_client_certificate_requirement() { + let error = std::io::Error::other(std::io::Error::other(security_framework::base::Error::from(-9863))); + let server = url::Url::parse("https://vpn.example.com/login?token=secret").unwrap(); + let tls = ServerTlsError::from_request(&server, &error).unwrap(); + assert_eq!(tls.kind, ServerTlsErrorKind::ClientCertificateRequired); + assert_eq!(tls.server, "https://vpn.example.com"); + assert_eq!(classify(&std::io::Error::other("alert certificate required")), None); + } + + #[test] + fn rendering_recovery_retains_client_certificate_requirement() { + use crate::process::rendering_recovery::{RecoveryState, RenderingCrash}; + use std::os::unix::process::ExitStatusExt; + let mut recovery = RecoveryState::default(); + assert!( + recovery.recover( + &RenderingCrash { + status: std::process::ExitStatus::from_raw(71 << 8) + } + .into() + ) + ); + let error = recovery.terminal( + ServerTlsError { + server: "https://vpn.example.com".into(), + kind: ServerTlsErrorKind::ClientCertificateRequired, + } + .into(), + ); + assert_eq!( + ServerTlsErrorKind::from_error(&error), + Some(ServerTlsErrorKind::ClientCertificateRequired) + ); + } + + #[tokio::test] + async fn required_client_certificate_is_not_bypassed_by_ignoring_server_trust() { + use crate::{ + gp_params::GpParams, + os_profile::{ClientOs, OsProfile}, + portal::{PreloginOptions, prelogin}, + }; + let params = GpParams::builder(OsProfile::builder(ClientOs::Linux).build()) + .ignore_tls_errors(true) + .build(); + let credential = crate::credential::PasswordCredential::new("alice", "password").into(); + let cancellation = tokio_util::sync::CancellationToken::new(); + for operation in ["prelogin", "config", "gateway"] { + let (address, worker) = server_with_client_auth(true, SslVerifyMode::PEER | SslVerifyMode::FAIL_IF_NO_PEER_CERT); + let error = match operation { + "prelogin" => prelogin(&address, ¶ms, PreloginOptions::default()) + .await + .err() + .unwrap(), + "config" => crate::portal::retrieve_config(&address, &credential, ¶ms, &cancellation) + .await + .err() + .unwrap(), + _ => crate::gateway::GatewayLoginClient::new(&address, params.clone()) + .unwrap() + .login(&credential, None, &cancellation) + .await + .err() + .unwrap(), + }; + worker.join().unwrap(); + let kind = + ServerTlsErrorKind::from_error(&error).unwrap_or_else(|| panic!("{operation}: unclassified: {error:?}")); + // Secure Transport's TLS 1.2 handshake can return only a generic peer alert. + if cfg!(target_os = "macos") { + assert!(matches!( + kind, + ServerTlsErrorKind::ClientCertificateRequired | ServerTlsErrorKind::Other + )); + } else { + assert_eq!( + kind, + ServerTlsErrorKind::ClientCertificateRequired, + "{operation}: {error:?}" + ); + } + } + } + + #[tokio::test] + async fn prelogin_accepts_a_valid_identity_and_an_optional_certificate_request() { + use crate::{ + gp_params::GpParams, + os_profile::{ClientOs, OsProfile}, + portal::{PreloginOptions, prelogin}, + }; + for required in [false, true] { + let verify = if required { + SslVerifyMode::PEER | SslVerifyMode::FAIL_IF_NO_PEER_CERT + } else { + SslVerifyMode::PEER + }; + let (address, worker) = server_with_client_auth(true, verify); + let mut builder = GpParams::builder(OsProfile::builder(ClientOs::Linux).build()); + builder.ignore_tls_errors(true); + if required { + builder + .certificate(Some( + concat!(env!("CARGO_MANIFEST_DIR"), "/tests/files/client-identity/rsa-cert.pem").to_owned(), + )) + .sslkey(Some( + concat!(env!("CARGO_MANIFEST_DIR"), "/tests/files/client-identity/rsa-pkcs8.pem").to_owned(), + )); + } + let result = prelogin(&address, &builder.build(), PreloginOptions::default()).await; + worker.join().unwrap(); + assert!(matches!(result.unwrap(), crate::portal::Prelogin::Saml(_))); + } + } + + #[tokio::test] + async fn failed_response_reads_preserve_the_transport_cause() { + for status in [200, 403] { + let listener = TcpListener::bind("127.0.0.1:0").unwrap(); + let address = format!("http://{}", listener.local_addr().unwrap()); + let worker = thread::spawn(move || { + let (mut stream, _) = listener.accept().unwrap(); + stream.set_read_timeout(Some(Duration::from_secs(5))).unwrap(); + let mut request = [0; 8192]; + stream.read(&mut request).unwrap(); + write!( + stream, + "HTTP/1.1 {status} Test\r\nContent-Length: 100\r\nConnection: close\r\n\r\ntruncated" + ) + .unwrap(); + }); + let response = reqwest::Client::builder() + .no_proxy() + .build() + .unwrap() + .get(address) + .send() + .await + .unwrap(); + let error = crate::utils::parse_gp_response(response).await.unwrap_err(); + assert_eq!(error.status.as_u16(), status); + assert!(error.source().unwrap().is::()); + worker.join().unwrap(); + } + } +} diff --git a/crates/gpapi/src/error/server_tls/macos.rs b/crates/gpapi/src/error/server_tls/macos.rs new file mode 100644 index 0000000..e5e34af --- /dev/null +++ b/crates/gpapi/src/error/server_tls/macos.rs @@ -0,0 +1,9 @@ +use std::error::Error; + +use super::{ServerTlsErrorKind, classify_macos_status}; + +pub(super) fn classify(error: &(dyn Error + 'static)) -> Option { + error + .downcast_ref::() + .map(|error| classify_macos_status(error.code())) +} diff --git a/crates/gpapi/src/error/server_tls/openssl.rs b/crates/gpapi/src/error/server_tls/openssl.rs new file mode 100644 index 0000000..cbbde63 --- /dev/null +++ b/crates/gpapi/src/error/server_tls/openssl.rs @@ -0,0 +1,17 @@ +use std::error::Error; + +use super::ServerTlsErrorKind; + +pub(super) fn classify(error: &(dyn Error + 'static)) -> Option { + let stack = error.downcast_ref::().or_else(|| { + error + .downcast_ref::() + .and_then(openssl::ssl::Error::ssl_error) + })?; + // ERR_LIB_SSL and SSL_R_TLSV13_ALERT_CERTIFICATE_REQUIRED from sslerr.h. + stack + .errors() + .iter() + .any(|error| error.library_code() == 20 && error.reason_code() == 1116) + .then_some(ServerTlsErrorKind::ClientCertificateRequired) +} diff --git a/crates/gpapi/src/gateway/login.rs b/crates/gpapi/src/gateway/login.rs index 8b01502..30d7909 100644 --- a/crates/gpapi/src/gateway/login.rs +++ b/crates/gpapi/src/gateway/login.rs @@ -254,12 +254,18 @@ async fn receive_gateway_login( .await .map_err(|e| { warn!("Network error: {:?}", e); - anyhow::anyhow!(PortalError::NetworkError(e)) + match crate::error::ServerTlsError::from_request(origin, &e) { + Some(tls) => anyhow::anyhow!(tls), + None => anyhow::anyhow!(PortalError::NetworkError(e)), + } })?; let endpoint = res.remote_addr(); let url = res.url().clone(); let res = parse_gp_response(res).await.map_err(|err| { + if let Some(tls) = crate::error::ServerTlsError::from_request(origin, &err) { + return anyhow::anyhow!(tls); + } warn!("Gateway login response failed: {}", err.reason); anyhow::anyhow!("Gateway login error: {}", err.reason) })?; diff --git a/crates/gpapi/src/portal/config.rs b/crates/gpapi/src/portal/config.rs index 8d67429..2ef5aec 100644 --- a/crates/gpapi/src/portal/config.rs +++ b/crates/gpapi/src/portal/config.rs @@ -10,7 +10,7 @@ use xmltree::Element; use crate::{ credential::{AuthCookieCredential, Credential}, - error::PortalError, + error::{PortalError, ServerTlsError}, gateway::{Gateway, parse_gateways}, gp_params::GpParams, params, @@ -149,6 +149,7 @@ pub async fn retrieve_config( cancellation: &CancellationToken, ) -> anyhow::Result { let portal = normalize_server(portal)?; + let server_url = url::Url::parse(&portal)?; let server = remove_url_scheme(&portal); let url = format!("{}/global-protect/getconfig.esp", portal); @@ -170,10 +171,16 @@ pub async fn retrieve_config( result = async { let res = client.post(&url).form(&request_params.body).send().await.map_err(|e| { warn!("Network error: {:?}", e); - anyhow::anyhow!(PortalError::NetworkError(e)) + match ServerTlsError::from_request(&server_url, &e) { + Some(tls) => anyhow::anyhow!(tls), + None => anyhow::anyhow!(PortalError::NetworkError(e)), + } })?; parse_gp_response(res).await.or_else(|err| { + if let Some(tls) = ServerTlsError::from_request(&server_url, &err) { + return Err(anyhow::anyhow!(tls)); + } if err.status == StatusCode::NOT_FOUND { bail!(PortalError::ConfigError("Config endpoint not found".to_string())); } @@ -227,16 +234,23 @@ async fn retrieve_csc_config( let swg_nonce = csc::swg_nonce(); let params = csc::csc_params(&csc_req, username, gp_params, &swg_nonce); let url = format!("{}/global-protect/getconfig_csc.esp", portal); + let server_url = url::Url::parse(portal)?; info!("Portal CSC config request summary: {}", csc_req.summary()); info!("Portal CSC config request params: {}", redact_params(¶ms)); let res = client.post(&url).form(¶ms).send().await.map_err(|e| { warn!("Network error: {:?}", e); - anyhow::anyhow!(PortalError::NetworkError(e)) + match ServerTlsError::from_request(&server_url, &e) { + Some(tls) => anyhow::anyhow!(tls), + None => anyhow::anyhow!(PortalError::NetworkError(e)), + } })?; parse_gp_response(res).await.or_else(|err| { + if let Some(tls) = ServerTlsError::from_request(&server_url, &err) { + return Err(anyhow::anyhow!(tls)); + } if err.status == StatusCode::NOT_FOUND { bail!(PortalError::ConfigError("CSC config endpoint not found".to_string())); } diff --git a/crates/gpapi/src/portal/prelogin.rs b/crates/gpapi/src/portal/prelogin.rs index 43a98a6..6de091f 100644 --- a/crates/gpapi/src/portal/prelogin.rs +++ b/crates/gpapi/src/portal/prelogin.rs @@ -135,6 +135,7 @@ pub async fn prelogin(portal: &str, gp_params: &GpParams, options: PreloginOptio ); let client = Client::try_from(gp_params)?; + let server_url = url::Url::parse(&portal)?; let mut request = client.post(&prelogin_url); if !request_params.query.is_empty() { @@ -146,10 +147,16 @@ pub async fn prelogin(portal: &str, gp_params: &GpParams, options: PreloginOptio let res = request.send().await.map_err(|e| { warn!("Network error: {:?}", e); - anyhow::anyhow!(PortalError::NetworkError(e)) + match crate::error::ServerTlsError::from_request(&server_url, &e) { + Some(error) => anyhow!(error), + None => anyhow!(PortalError::NetworkError(e)), + } })?; let res_xml = parse_gp_response(res).await.or_else(|err| { + if let Some(tls) = crate::error::ServerTlsError::from_request(&server_url, &err) { + return Err(anyhow!(tls)); + } if err.status == StatusCode::NOT_FOUND { bail!(PortalError::PreloginError("Prelogin endpoint not found".to_string())) } diff --git a/crates/gpapi/src/process/auth_launcher.rs b/crates/gpapi/src/process/auth_launcher.rs index 8481082..1919a52 100644 --- a/crates/gpapi/src/process/auth_launcher.rs +++ b/crates/gpapi/src/process/auth_launcher.rs @@ -33,6 +33,7 @@ pub struct SamlAuthLauncher<'a> { certificate: Option<&'a str>, sslkey: Option<&'a str>, key_password: Option<&'a str>, + #[cfg(not(target_os = "macos"))] fix_openssl: bool, ignore_tls_errors: bool, #[cfg(feature = "webview-auth")] @@ -66,6 +67,7 @@ impl<'a> SamlAuthLauncher<'a> { certificate: None, sslkey: None, key_password: None, + #[cfg(not(target_os = "macos"))] fix_openssl: false, ignore_tls_errors: false, #[cfg(feature = "webview-auth")] @@ -113,6 +115,7 @@ impl<'a> SamlAuthLauncher<'a> { self } + #[cfg(not(target_os = "macos"))] pub fn fix_openssl(mut self, fix_openssl: bool) -> Self { self.fix_openssl = fix_openssl; self @@ -226,6 +229,7 @@ impl<'a> SamlAuthLauncher<'a> { auth_cmd.arg("--client-version").arg(client_version); } + #[cfg(not(target_os = "macos"))] if self.fix_openssl { auth_cmd.arg("--fix-openssl"); } @@ -343,10 +347,12 @@ impl<'a> SamlAuthLauncher<'a> { } } -/// `gpauth --browser remote` reads the pasted `globalprotectcallback:` data from the user's terminal. +/// `gpauth --browser manual` reads the pasted `globalprotectcallback:` data from the user's terminal. fn auth_stdin(browser: Option<&str>) -> ChildInput<'static> { match browser { - Some(browser) if browser.eq_ignore_ascii_case("remote") => ChildInput::Terminal, + Some(browser) if browser.eq_ignore_ascii_case("manual") || browser.eq_ignore_ascii_case("remote") => { + ChildInput::Terminal + } _ => ChildInput::Null, } } @@ -376,6 +382,53 @@ mod tests { use super::*; use crate::os_profile::{ClientOs, OsProfileBuilder}; + #[test] + fn server_tls_result_survives_process_decoding_as_a_typed_error() { + use crate::error::{ServerTlsError, ServerTlsErrorKind}; + use std::os::unix::process::ExitStatusExt; + let output = std::process::Output { + status: std::process::ExitStatus::from_raw(0), + stdout: br#"{"serverTlsError":{"server":"https://vpn.example.com:8443","kind":"certificate"}}"#.to_vec(), + stderr: Vec::new(), + }; + let error = decode_auth_output(output, false).unwrap_err(); + assert_eq!( + error.downcast_ref::(), + Some(&ServerTlsError { + server: "https://vpn.example.com:8443".into(), + kind: ServerTlsErrorKind::Certificate, + }) + ); + } + + #[test] + fn client_certificate_required_result_survives_process_decoding() { + use crate::error::{ServerTlsError, ServerTlsErrorKind}; + use std::os::unix::process::ExitStatusExt; + let output = std::process::Output { + status: std::process::ExitStatus::from_raw(0), + stdout: br#"{"serverTlsError":{"server":"https://vpn.example.com","kind":"clientCertificateRequired"}}"#.to_vec(), + stderr: Vec::new(), + }; + let error = decode_auth_output(output, false).unwrap_err(); + let tls = error.downcast_ref::().unwrap(); + assert_eq!(tls.kind, ServerTlsErrorKind::ClientCertificateRequired); + assert_eq!(tls.server, "https://vpn.example.com"); + } + + #[test] + fn launches_with_platform_tls_options() { + let launcher = SamlAuthLauncher::new("vpn.example.com").ignore_tls_errors(true); + #[cfg(not(target_os = "macos"))] + let launcher = launcher.fix_openssl(true); + let args = child_args(launcher); + assert_eq!( + args.iter().any(|arg| arg == "--fix-openssl"), + !cfg!(target_os = "macos") + ); + assert!(args.iter().any(|arg| arg == "--ignore-tls-errors")); + } + #[test] fn os_profile_sets_os_from_profile() { let profile = OsProfileBuilder::new(ClientOs::Linux).client_version("6.0.0").build(); @@ -463,7 +516,9 @@ mod tests { } #[test] - fn only_a_remote_browser_reads_the_terminal() { + fn only_a_manual_browser_reads_the_terminal() { + assert!(matches!(auth_stdin(Some("manual")), ChildInput::Terminal)); + assert!(matches!(auth_stdin(Some("MANUAL")), ChildInput::Terminal)); assert!(matches!(auth_stdin(Some("remote")), ChildInput::Terminal)); assert!(matches!(auth_stdin(Some("REMOTE")), ChildInput::Terminal)); assert!(matches!(auth_stdin(Some("firefox")), ChildInput::Null)); diff --git a/crates/gpapi/src/service/event.rs b/crates/gpapi/src/service/event.rs index de7095c..c9ad5ee 100644 --- a/crates/gpapi/src/service/event.rs +++ b/crates/gpapi/src/service/event.rs @@ -5,6 +5,7 @@ use crate::service::{vpn_env::VpnEnv, vpn_state::VpnState}; /// Events that can be emitted by the service #[derive(Debug, Serialize, Deserialize, Clone)] pub enum WsEvent { + TunnelState(Option), VpnEnv(VpnEnv), VpnState(VpnState), ActiveGui, diff --git a/crates/gpapi/src/service/request.rs b/crates/gpapi/src/service/request.rs index f280da6..a45c708 100644 --- a/crates/gpapi/src/service/request.rs +++ b/crates/gpapi/src/service/request.rs @@ -380,6 +380,7 @@ pub struct UpdateLogLevelRequest(pub String); /// Requests that can be sent to the service #[derive(Debug, Deserialize, Serialize)] pub enum WsRequest { + SetTunnelStatisticsEnabled { enabled: bool }, Connect(Box), Disconnect(DisconnectRequest), StopNonTunnelAttachment { connection_id: uuid::Uuid }, diff --git a/crates/gpapi/src/service/transport/message.rs b/crates/gpapi/src/service/transport/message.rs index 19529d5..b81d492 100644 --- a/crates/gpapi/src/service/transport/message.rs +++ b/crates/gpapi/src/service/transport/message.rs @@ -17,6 +17,9 @@ pub enum ClientMessage { #[derive(Debug, Serialize, Deserialize)] #[serde(tag = "type", content = "data", rename_all = "camelCase", deny_unknown_fields)] pub enum ServerMessage { + TunnelStatistics { + snapshot: crate::session::tunnel::TunnelStatisticsSnapshot, + }, Attached { connection_id: Uuid, current_revision: u64, @@ -39,6 +42,7 @@ pub enum ServerMessage { #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] #[serde(tag = "type", content = "data", rename_all = "camelCase", deny_unknown_fields)] pub enum ServiceResult { + TunnelStatisticsSnapshot(crate::session::tunnel::TunnelStatisticsSnapshot), Accepted, StoredHipReport { report_id: String, @@ -192,4 +196,73 @@ mod tests { let encoded = encode(&message).unwrap(); assert!(encoded.len() <= MAX_PLAINTEXT); } + + #[test] + fn full_configuration_and_large_metadata_fit_complete_snapshot_envelopes_at_the_budget() { + use crate::{ + os_profile::HostIdentity, + service::{ + vpn_env::HostInfo, + vpn_state::{ConnectedInfo, VpnState}, + }, + session::tunnel::{MAX_CONFIGURATION_BYTES, TunnelConfiguration, TunnelPhase, TunnelState, TunnelTransport}, + }; + let mut configuration = TunnelConfiguration::default(); + configuration.included_routes.items = vec!["r".repeat(1024); 15]; + configuration.included_routes.items.push(String::new()); + configuration.included_routes.total_count = 16; + let padding = MAX_CONFIGURATION_BYTES - serde_json::to_vec(&configuration).unwrap().len(); + assert!(padding <= 1024); + *configuration.included_routes.items.last_mut().unwrap() = "r".repeat(padding); + assert_eq!( + serde_json::to_vec(&configuration).unwrap().len(), + MAX_CONFIGURATION_BYTES + ); + let gateway = Gateway::new("Gateway".repeat(20), "vpn.example.com".into()); + let info = ConnectInfo::new("portal.example.com".into(), gateway.clone(), vec![gateway; 32]); + let snapshot = VpnEnv { + tunnel_state: Some(TunnelState { + tunnel_id: Uuid::new_v4(), + sequence: u64::MAX, + phase: TunnelPhase::Connected, + configuration_revision: u64::MAX, + configuration: Some(configuration), + transport: TunnelTransport::IpsecEsp, + elapsed_ms: u64::MAX, + }), + vpn_state: VpnState::Connected(Box::new(ConnectedInfo::new(info, None))), + vpnc_script: Some("s".repeat(1024)), + auth_executable: "a".repeat(1024), + host_info: HostInfo { + host_identity: HostIdentity::collect(), + }, + }; + for mut message in [ + ServerMessage::Attached { + connection_id: Uuid::new_v4(), + current_revision: u64::MAX, + snapshot: snapshot.clone(), + }, + ServerMessage::Snapshot { + current_revision: u64::MAX, + snapshot, + }, + ] { + let remaining = MAX_PLAINTEXT - encode(&message).unwrap().len(); + let snapshot = match &mut message { + ServerMessage::Attached { snapshot, .. } | ServerMessage::Snapshot { snapshot, .. } => snapshot, + _ => unreachable!(), + }; + // Existing host/connection metadata has no declared maximum. Fill the + // remaining envelope budget, then assert its actual boundary explicitly. + snapshot.auth_executable.push_str(&"a".repeat(remaining)); + assert_eq!(encode(&message).unwrap().len(), MAX_PLAINTEXT); + let snapshot = match &mut message { + ServerMessage::Attached { snapshot, .. } | ServerMessage::Snapshot { snapshot, .. } => snapshot, + _ => unreachable!(), + }; + snapshot.auth_executable.push('a'); + assert!(matches!(encode(&message), Err(TransportError::MessageTooLarge))); + } + } } diff --git a/crates/gpapi/src/service/vpn_env.rs b/crates/gpapi/src/service/vpn_env.rs index 56a14eb..3796280 100644 --- a/crates/gpapi/src/service/vpn_env.rs +++ b/crates/gpapi/src/service/vpn_env.rs @@ -18,6 +18,7 @@ pub struct HostInfo { /// to the client so that it can configure itself accordingly. #[derive(Debug, Serialize, Deserialize, Clone)] pub struct VpnEnv { + pub tunnel_state: Option, /// The VPN connection state pub vpn_state: VpnState, diff --git a/crates/gpapi/src/session.rs b/crates/gpapi/src/session.rs index e3aa473..a9a2468 100644 --- a/crates/gpapi/src/session.rs +++ b/crates/gpapi/src/session.rs @@ -9,6 +9,7 @@ mod gateway_sessions; pub mod network; pub mod non_tunnel; pub mod transport; +pub mod tunnel; pub use connection::*; pub use gateway_sessions::{ClientAddresses, GatewaySession, GatewaySessions}; diff --git a/crates/gpapi/src/session/network/mod.rs b/crates/gpapi/src/session/network/mod.rs index 37c833b..b53df9b 100644 --- a/crates/gpapi/src/session/network/mod.rs +++ b/crates/gpapi/src/session/network/mod.rs @@ -223,7 +223,7 @@ impl PhysicalNetwork { } fn fingerprint(&self) -> anyhow::Result { - Ok(sha256::digest(serde_json::to_vec(&self.snapshot)?)) + Ok(crate::utils::checksum::sha256_hex(serde_json::to_vec(&self.snapshot)?)) } pub fn capture(control: &dyn CollectionControl) -> anyhow::Result { diff --git a/crates/gpapi/src/session/transport.rs b/crates/gpapi/src/session/transport.rs index cd27160..7c74271 100644 --- a/crates/gpapi/src/session/transport.rs +++ b/crates/gpapi/src/session/transport.rs @@ -320,8 +320,8 @@ fn parse_hip_check(root: &Element) -> Result { .map_err(|_| GatewayRequestError::MalformedResponse)?, None => 0, }; - // Limit this client's supported response delay to one hour. The official - // registry scheduling cap is not evidence of a wire-protocol maximum. + // Accept response delays up to one hour as a client policy, not a + // wire-protocol maximum. if delay > 3600 { return Err(GatewayRequestError::MalformedResponse); } diff --git a/crates/gpapi/src/session/tunnel.rs b/crates/gpapi/src/session/tunnel.rs new file mode 100644 index 0000000..741994e --- /dev/null +++ b/crates/gpapi/src/session/tunnel.rs @@ -0,0 +1,353 @@ +//! Observed tunnel data, shared by standalone clients and service consumers. +//! These values describe negotiated settings, not verified operating-system state. + +use serde::{Deserialize, Serialize}; +use specta::Type; +use uuid::Uuid; + +pub const MAX_CONFIGURATION_BYTES: usize = 16 * 1024; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub enum TunnelPhase { + Establishing, + Connected, + Reconnecting, + Ended, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub enum TunnelTransport { + Negotiating, + IpsecEsp, + SslTls, + Unavailable, +} + +impl TunnelTransport { + pub fn is_active(self) -> bool { + matches!(self, Self::IpsecEsp | Self::SslTls) + } + + pub fn label(self) -> &'static str { + match self { + Self::Negotiating => "Negotiating", + Self::IpsecEsp => "IPsec (ESP)", + Self::SslTls => "SSL/TLS", + Self::Unavailable => "Unavailable", + } + } +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub struct TunnelList { + pub items: Vec, + pub total_count: u32, + pub truncated: bool, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub struct TunnelAddress { + pub address: String, + pub netmask: Option, + pub prefix_length: Option, +} + +impl TunnelAddress { + pub fn display(&self) -> String { + match self.prefix_length { + Some(prefix) => format!("{}/{prefix}", self.address), + None => match &self.netmask { + Some(netmask) => format!("{} (mask {netmask})", self.address), + None => self.address.clone(), + }, + } + } +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub struct TunnelConfiguration { + pub interface: Option, + pub ipv4: Option, + pub ipv6: Option, + pub server_ip: Option, + pub dns: TunnelList, + pub search_domains: TunnelList, + pub split_dns: TunnelList, + pub included_routes: TunnelList, + pub excluded_routes: TunnelList, + pub mtu: Option, + pub truncated: bool, +} + +impl TunnelConfiguration { + /// Bound observation payloads without modifying native network configuration. + /// Whole list entries are omitted before shortening scalar text. Counts and + /// truncation flags preserve the distinction between absent and omitted data. + /// Returns false if even the fixed JSON shape cannot fit the supplied budget. + pub fn limit_encoded_size(&mut self, limit: usize) -> bool { + while serde_json::to_vec(self).expect("configuration is serializable").len() > limit { + self.truncated = true; + let lists = [ + &mut self.excluded_routes, + &mut self.included_routes, + &mut self.split_dns, + &mut self.search_domains, + &mut self.dns, + ]; + if let Some(list) = lists.into_iter().find(|list| !list.items.is_empty()) { + list.items.pop(); + list.truncated = true; + continue; + } + let mut scalars = vec![&mut self.interface, &mut self.server_ip]; + if let Some(address) = &mut self.ipv4 { + scalars.push(&mut address.netmask); + if address.address.len() > 128 { + address.address.truncate(address.address.floor_char_boundary(128)); + address.prefix_length = None; + } + } + if let Some(address) = &mut self.ipv6 { + scalars.push(&mut address.netmask); + if address.address.len() > 128 { + address.address.truncate(address.address.floor_char_boundary(128)); + address.prefix_length = None; + } + } + match scalars + .into_iter() + .max_by_key(|value| value.as_ref().map_or(0, String::len)) + { + Some(Some(text)) if !text.is_empty() => { + text.truncate(text.floor_char_boundary(text.len() / 2)); + } + _ => return serde_json::to_vec(self).expect("configuration is serializable").len() <= limit, + } + } + true + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub struct TunnelState { + pub tunnel_id: Uuid, + #[serde(with = "decimal")] + #[specta(type = String)] + pub sequence: u64, + pub phase: TunnelPhase, + #[serde(with = "decimal")] + #[specta(type = String)] + pub configuration_revision: u64, + pub configuration: Option, + pub transport: TunnelTransport, + #[serde(with = "decimal")] + #[specta(type = String)] + pub elapsed_ms: u64, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub struct TunnelStatistics { + pub tunnel_id: Uuid, + #[serde(with = "decimal")] + #[specta(type = String)] + pub sequence: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub state_sequence: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub configuration_revision: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub elapsed_ms: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub received_bytes: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub sent_bytes: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub received_packets: u64, + #[serde(with = "decimal")] + #[specta(type = String)] + pub sent_packets: u64, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub enum TunnelStatisticsState { + Disabled, + Waiting, + Fresh, + Stale, + Ended, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub struct TunnelStatisticsView { + #[serde(with = "decimal")] + #[specta(type = String)] + pub sequence: u64, + pub tunnel_id: Uuid, + #[serde(with = "decimal")] + #[specta(type = String)] + pub state_sequence: u64, + pub phase: TunnelPhase, + pub transport: TunnelTransport, + pub state: TunnelStatisticsState, + #[serde(with = "decimal")] + #[specta(type = String)] + pub elapsed_ms: u64, + #[serde(with = "optional_decimal")] + #[specta(type = Option)] + pub sample_age_ms: Option, + pub sample: Option, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(rename_all = "camelCase")] +pub enum TunnelUnavailableReason { + NoTunnel, + NonTunnel, + ObservationFailed, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)] +#[serde(tag = "kind", rename_all = "camelCase")] +pub enum TunnelStatisticsSnapshot { + Available(TunnelStatisticsView), + Unavailable { reason: TunnelUnavailableReason }, +} + +impl TunnelStatisticsSnapshot { + pub fn unavailable(reason: TunnelUnavailableReason) -> Self { + Self::Unavailable { reason } + } + + pub fn view(&self) -> Option<&TunnelStatisticsView> { + match self { + Self::Available(view) => Some(view), + Self::Unavailable { .. } => None, + } + } + + pub fn tunnel_id(&self) -> Option { + self.view().map(|view| view.tunnel_id) + } + + pub fn sequence(&self) -> Option { + self.view().map(|view| view.sequence) + } + + pub fn state_sequence(&self) -> Option { + self.view().map(|view| view.state_sequence) + } + + pub fn disabled(&self) -> Self { + let mut snapshot = self.clone(); + if let Self::Available(view) = &mut snapshot { + if view.state != TunnelStatisticsState::Ended { + view.state = TunnelStatisticsState::Disabled; + } + } + snapshot + } + + pub fn stale(&self) -> Self { + let mut snapshot = self.clone(); + if let Self::Available(view) = &mut snapshot { + if matches!( + view.state, + TunnelStatisticsState::Fresh | TunnelStatisticsState::Waiting + ) { + view.state = TunnelStatisticsState::Stale; + } + } + snapshot + } +} + +mod decimal { + use serde::{Deserialize, Deserializer, Serializer}; + + pub fn serialize(value: &u64, serializer: S) -> Result { + serializer.collect_str(value) + } + + pub fn deserialize<'de, D: Deserializer<'de>>(deserializer: D) -> Result { + let value = String::deserialize(deserializer)?; + if value.is_empty() || !value.bytes().all(|byte| byte.is_ascii_digit()) { + return Err(serde::de::Error::custom("expected an unsigned decimal string")); + } + value.parse().map_err(serde::de::Error::custom) + } +} + +mod optional_decimal { + use serde::{Deserialize, Deserializer, Serialize, Serializer}; + + pub fn serialize(value: &Option, serializer: S) -> Result { + value.map(|value| value.to_string()).serialize(serializer) + } + + pub fn deserialize<'de, D: Deserializer<'de>>(deserializer: D) -> Result, D::Error> { + Option::::deserialize(deserializer)? + .map(|value| { + if value.is_empty() || !value.bytes().all(|byte| byte.is_ascii_digit()) { + return Err(serde::de::Error::custom("expected an unsigned decimal string")); + } + value.parse().map_err(serde::de::Error::custom) + }) + .transpose() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn counters_above_javascript_precision_round_trip_as_decimal_strings() { + let sample = TunnelStatistics { + tunnel_id: Uuid::nil(), + sequence: 1, + state_sequence: 1, + configuration_revision: 1, + elapsed_ms: 1000, + received_bytes: (1_u64 << 53) + 1, + sent_bytes: u64::MAX, + received_packets: 3, + sent_packets: 4, + }; + let value = serde_json::to_value(&sample).unwrap(); + assert_eq!(value["receivedBytes"], "9007199254740993"); + assert_eq!(value["sentBytes"], "18446744073709551615"); + assert_eq!( + serde_json::from_value::(value.clone()).unwrap(), + sample + ); + let mut numeric = value; + numeric["receivedBytes"] = serde_json::json!(9007199254740993_u64); + assert!(serde_json::from_value::(numeric).is_err()); + } + + #[test] + fn unavailable_has_no_synthetic_counters() { + let snapshot = TunnelStatisticsSnapshot::unavailable(TunnelUnavailableReason::NonTunnel); + let value = serde_json::to_value(&snapshot).unwrap(); + assert_eq!(value, serde_json::json!({"kind": "unavailable", "reason": "nonTunnel"})); + assert_eq!( + serde_json::from_value::(value).unwrap(), + snapshot + ); + } +} diff --git a/crates/gpapi/src/utils/checksum.rs b/crates/gpapi/src/utils/checksum.rs index 6290040..094cf96 100644 --- a/crates/gpapi/src/utils/checksum.rs +++ b/crates/gpapi/src/utils/checksum.rs @@ -1,10 +1,43 @@ -use std::path::Path; +use std::{ + fmt::Write as _, + fs::File, + io::{self, Read}, + path::Path, +}; use anyhow::bail; +use sha2::{Digest, Sha256}; + +pub fn sha256_hex(data: impl AsRef<[u8]>) -> String { + digest_hex(&Sha256::digest(data.as_ref())) +} + +pub fn file_sha256(path: impl AsRef) -> io::Result { + let mut file = File::open(path)?; + let mut hasher = Sha256::new(); + let mut buffer = [0; 8192]; + loop { + let count = match file.read(&mut buffer) { + Ok(0) => break, + Ok(count) => count, + Err(error) if error.kind() == io::ErrorKind::Interrupted => continue, + Err(error) => return Err(error), + }; + hasher.update(&buffer[..count]); + } + Ok(digest_hex(&hasher.finalize())) +} + +fn digest_hex(digest: &[u8]) -> String { + let mut hex = String::with_capacity(digest.len() * 2); + for byte in digest { + write!(&mut hex, "{byte:02x}").expect("writing to a String cannot fail"); + } + hex +} pub fn verify_checksum(path: &str, expected: &str) -> anyhow::Result<()> { - let file = Path::new(&path); - let checksum = sha256::try_digest(&file)?; + let checksum = file_sha256(path)?; if checksum != expected { bail!("Checksum mismatch, expected: {}, actual: {}", expected, checksum); @@ -12,3 +45,43 @@ pub fn verify_checksum(path: &str, expected: &str) -> anyhow::Result<()> { Ok(()) } + +#[cfg(test)] +mod tests { + use std::io::Write; + + use super::*; + + #[test] + fn known_sha256_vectors_use_lowercase_hex() { + assert_eq!( + sha256_hex(b""), + "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" + ); + assert_eq!( + sha256_hex(b"abc"), + "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad" + ); + } + + #[test] + fn hashes_files_across_buffer_boundaries_and_checks_expected_digest() { + let mut file = tempfile::NamedTempFile::new().unwrap(); + file.write_all(&vec![b'a'; 1_000_000]).unwrap(); + let expected = "cdc76e5c9914fb9281a1c7e284d73e67f1809a48a497200e046d39ccc7112cd0"; + + assert_eq!(file_sha256(file.path()).unwrap(), expected); + verify_checksum(file.path().to_str().unwrap(), expected).unwrap(); + assert!(verify_checksum(file.path().to_str().unwrap(), "wrong").is_err()); + } + + #[test] + fn hashes_empty_files_and_propagates_file_errors() { + let file = tempfile::NamedTempFile::new().unwrap(); + assert_eq!(file_sha256(file.path()).unwrap(), sha256_hex(b"")); + let directory = tempfile::tempdir().unwrap(); + let error = file_sha256(directory.path().join("missing")).unwrap_err(); + assert_eq!(error.kind(), std::io::ErrorKind::NotFound); + assert!(file_sha256(directory.path()).is_err()); + } +} diff --git a/crates/gpapi/src/utils/identity_encoding.rs b/crates/gpapi/src/utils/identity_encoding.rs new file mode 100644 index 0000000..59a001b --- /dev/null +++ b/crates/gpapi/src/utils/identity_encoding.rs @@ -0,0 +1,219 @@ +//! PEM/DER normalization; usable key and certificate imports stay with native TLS. +use pkcs8::{ + AlgorithmIdentifierRef, EncryptedPrivateKeyInfoRef, ObjectIdentifier, PrivateKeyInfoRef, SecretDocument, + der::{ + Decode, Reader, SliceReader, Tag, Tagged, + asn1::{AnyRef, OctetStringRef, SequenceRef}, + }, +}; +use zeroize::Zeroizing; + +use super::{request::RequestIdentityError, traditional_key}; + +pub(super) enum TraditionalKeyFormat { + Sec1Der, + PlainPem, + EncryptedPem, +} + +struct PemBlock { + tag: String, + headers: pem::HeaderMap, + contents: Zeroizing>, +} + +impl PemBlock { + fn encoded(&self) -> Zeroizing> { + let mut block = pem::Pem::new(&self.tag, self.contents.as_slice()); + *block.headers_mut() = self.headers.clone(); + let encoded = Zeroizing::new(pem::encode(&block).into_bytes()); + // The PEM crate owns a copy of the decoded private key as well. + drop(Zeroizing::new(block.into_contents())); + encoded + } +} + +fn is_pem(bytes: &[u8]) -> bool { + bytes.windows(b"-----BEGIN".len()).any(|part| part == b"-----BEGIN") +} + +// Adopt decoded blocks immediately, including ignored keys in combined files. +fn blocks(bytes: &[u8]) -> Result, pem::PemError> { + Ok( + pem::parse_many(bytes)? + .into_iter() + .map(|block| PemBlock { + tag: block.tag().to_owned(), + headers: block.headers().clone(), + contents: Zeroizing::new(block.into_contents()), + }) + .collect(), + ) +} + +pub(super) fn private_key(bytes: &[u8], passphrase: Option<&str>) -> anyhow::Result>> { + let pem_input = is_pem(bytes); + let block = if pem_input { + blocks(bytes) + .map_err(|_| RequestIdentityError::InvalidKey)? + .into_iter() + .find(|block| block.tag.ends_with("PRIVATE KEY")) + .ok_or(RequestIdentityError::NoKey)? + } else { + // Unlike combined PEM, a standalone DER certificate cannot include a key. + if x509_cert::Certificate::from_der(bytes).is_ok() { + return Err(RequestIdentityError::NoKey.into()); + } + PemBlock { + tag: der_key_tag(bytes) + .map_err(|_| RequestIdentityError::InvalidKey)? + .to_owned(), + headers: pem::HeaderMap::default(), + contents: Zeroizing::new(bytes.to_vec()), + } + }; + let der = &block.contents; + let document = if traditional_encryption(&block)? { + if !matches!(block.tag.as_str(), "RSA PRIVATE KEY" | "EC PRIVATE KEY") { + return Err(RequestIdentityError::InvalidKey.into()); + } + traditional_key::normalize(&block.encoded(), TraditionalKeyFormat::EncryptedPem, passphrase)? + } else { + match block.tag.as_str() { + "PRIVATE KEY" => SecretDocument::try_from(der.as_slice()).map_err(|_| RequestIdentityError::InvalidKey)?, + "RSA PRIVATE KEY" => { + // PKCS#8 stores the original PKCS#1 bytes inside an RSA algorithm envelope. + // Native TLS validates the RSA key, as it does for existing PKCS#8 input. + let algorithm = AlgorithmIdentifierRef { + oid: ObjectIdentifier::new_unwrap("1.2.840.113549.1.1.1"), + parameters: Some(AnyRef::NULL), + }; + let private_key = OctetStringRef::new(der).map_err(|_| RequestIdentityError::InvalidKey)?; + let info = PrivateKeyInfoRef::new(algorithm, private_key); + SecretDocument::encode_msg(&info).map_err(|_| RequestIdentityError::InvalidKey)? + } + "ENCRYPTED PRIVATE KEY" => decrypt(der, passphrase)?, + "EC PRIVATE KEY" => { + if pem_input { + traditional_key::normalize(&block.encoded(), TraditionalKeyFormat::PlainPem, passphrase)? + } else { + traditional_key::normalize(der, TraditionalKeyFormat::Sec1Der, passphrase)? + } + } + _ => return Err(RequestIdentityError::UnsupportedKeyFormat.into()), + } + }; + PrivateKeyInfoRef::from_der(document.as_bytes()).map_err(|_| RequestIdentityError::InvalidKey)?; + let pem = document.to_pem("PRIVATE KEY", pkcs8::LineEnding::LF)?; + Ok(Zeroizing::new(pem.as_bytes().to_vec())) +} + +// Only choose a container here. The selected decoder/native importer validates +// the key. Decoding the complete outer sequence rejects concatenated DER input. +fn der_key_tag(bytes: &[u8]) -> Result<&'static str, pkcs8::der::Error> { + let sequence = <&SequenceRef>::from_der(bytes)?; + let mut reader = SliceReader::new(sequence.as_bytes())?; + let first: AnyRef = reader.decode()?; + Ok(match (first.tag(), Tag::peek(&reader)?) { + (Tag::Integer, Tag::Sequence) => "PRIVATE KEY", + (Tag::Integer, Tag::Integer) => "RSA PRIVATE KEY", + (Tag::Integer, Tag::OctetString) => "EC PRIVATE KEY", + (Tag::Sequence, Tag::OctetString) => "ENCRYPTED PRIVATE KEY", + _ => return Err(pkcs8::der::ErrorKind::Failed.into()), + }) +} + +fn traditional_encryption(block: &PemBlock) -> Result { + let mut proc_type = None; + let mut dek_info = None; + for (name, value) in block.headers.iter() { + let slot = match name { + "Proc-Type" => &mut proc_type, + "DEK-Info" => &mut dek_info, + _ => continue, + }; + if slot.replace(value).is_some() { + return Err(RequestIdentityError::InvalidKey); + } + } + if proc_type.is_none() && dek_info.is_none() { + return Ok(false); + } + let (Some("4,ENCRYPTED"), Some(dek_info)) = (proc_type, dek_info) else { + return Err(RequestIdentityError::InvalidKey); + }; + let (cipher, iv) = dek_info.split_once(',').ok_or(RequestIdentityError::InvalidKey)?; + let block_size = match cipher { + "AES-128-CBC" | "AES-192-CBC" | "AES-256-CBC" => 16, + "DES-EDE3-CBC" => 8, + _ => return Err(RequestIdentityError::UnsupportedEncryption), + }; + if iv.len() != block_size * 2 + || !iv.bytes().all(|byte| byte.is_ascii_hexdigit()) + || block.contents.is_empty() + || block.contents.len() % block_size != 0 + { + return Err(RequestIdentityError::InvalidKey); + } + Ok(true) +} + +fn decrypt(der: &[u8], passphrase: Option<&str>) -> anyhow::Result { + // pkcs5 collapses unknown outer PBE OIDs into a generic DER value error. + // Inspect the typed envelope first so legacy PBE is not called malformed. + let algorithm = pkcs8::der::asn1::AnyRef::from_der(der) + .and_then(|value| { + value.sequence(|reader| { + let algorithm = pkcs8::AlgorithmIdentifierRef::decode(reader)?; + let _: &pkcs8::der::asn1::OctetStringRef = reader.decode()?; + Ok(algorithm.oid) + }) + }) + .map_err(|_| RequestIdentityError::InvalidKey)?; + if algorithm != pkcs8::pkcs5::pbes2::PBES2_OID { + // PKCS#12 PBE-SHA1-3DES inside standalone PKCS#8 is not implemented by + // RustCrypto. Only this known legacy scheme uses the optional executable. + if algorithm == pkcs8::ObjectIdentifier::new_unwrap("1.2.840.113549.1.12.1.3") { + return super::legacy_pkcs8::decrypt(der, passphrase); + } + return Err(RequestIdentityError::UnsupportedEncryption.into()); + } + // Decode the full encryption scheme, including its KDF/PRF/cipher, before + // asking for a password. Unsupported algorithms must not cause prompt loops. + let encrypted = EncryptedPrivateKeyInfoRef::from_der(der).map_err(|error| match error.kind() { + pkcs8::der::ErrorKind::OidUnknown { .. } => RequestIdentityError::UnsupportedEncryption, + _ => RequestIdentityError::InvalidKey, + })?; + let passphrase = passphrase.ok_or(RequestIdentityError::NoPassphrase("PEM"))?; + let mut plaintext = Zeroizing::new(encrypted.encrypted_data.as_bytes().to_vec()); + let decrypted = encrypted + .encryption_algorithm + .decrypt_in_place(passphrase, &mut plaintext) + .map_err(|_| RequestIdentityError::DecryptError("PEM"))?; + SecretDocument::try_from(decrypted).map_err(|_| RequestIdentityError::DecryptError("PEM").into()) +} + +pub(super) fn certificate_chain(bytes: &[u8]) -> anyhow::Result>> { + if !is_pem(bytes) { + return certificate_pem(bytes).map(|pem| Zeroizing::new(pem.into_bytes())); + } + let mut chain = Zeroizing::new(Vec::new()); + for block in blocks(bytes).map_err(|_| RequestIdentityError::InvalidCertificate)? { + if block.tag == "CERTIFICATE" { + let encoded = certificate_pem(&block.contents)?; + chain.extend_from_slice(encoded.as_bytes()); + } + } + if chain.is_empty() { + return Err(RequestIdentityError::InvalidCertificate.into()); + } + Ok(chain) +} + +fn certificate_pem(der: &[u8]) -> anyhow::Result { + x509_cert::Certificate::from_der(der).map_err(|_| RequestIdentityError::InvalidCertificate)?; + Ok(pem::encode_config( + &pem::Pem::new("CERTIFICATE", der), + pem::EncodeConfig::new().set_line_ending(pem::LineEnding::LF), + )) +} diff --git a/crates/gpapi/src/utils/legacy_pkcs8.rs b/crates/gpapi/src/utils/legacy_pkcs8.rs new file mode 100644 index 0000000..868a8b3 --- /dev/null +++ b/crates/gpapi/src/utils/legacy_pkcs8.rs @@ -0,0 +1,165 @@ +//! Optional compatibility conversion for standalone PKCS#12 PBE-SHA1-3DES keys. +//! The executable is a runtime option, not a linked or bundled dependency. +use std::{ + io::{ErrorKind, Read, Write}, + os::{fd::AsFd, unix::process::CommandExt}, + process::{Child, Command, Stdio}, + thread, + time::{Duration, Instant}, +}; + +use nix::{ + fcntl::{FcntlArg, OFlag, fcntl}, + sys::signal::{Signal, killpg}, + unistd::Pid, +}; +use pkcs8::SecretDocument; +use zeroize::Zeroizing; + +use super::request::RequestIdentityError::{self, LegacyKeyConversion}; + +const TIMEOUT: Duration = Duration::from_secs(10); +const MAX_OUTPUT: u64 = 1024 * 1024; +const MAX_PASSWORD_BYTES: usize = 1023; + +// The converter owns a separate process group, including wrapper descendants. +// Clean up that group and reap the direct child on every return path. +struct Converter(Child); + +impl Drop for Converter { + fn drop(&mut self) { + let _ = killpg(Pid::from_raw(self.0.id() as i32), Signal::SIGKILL); + let _ = self.0.wait(); + } +} + +fn nonblocking(pipe: &impl AsFd) -> anyhow::Result<()> { + fcntl(pipe, FcntlArg::F_SETFL(OFlag::O_NONBLOCK)) + .map_err(|_| LegacyKeyConversion("could not configure converter pipes"))?; + Ok(()) +} + +// Read at most one chunk per iteration so a busy pipe cannot starve the deadline. +// Returns true only after EOF; inherited pipes remain subject to the deadline. +fn read_output(pipe: &mut impl Read, output: &mut Zeroizing>, limit: u64) -> anyhow::Result { + let mut buffer = Zeroizing::new([0u8; 8192]); + match pipe.read(buffer.as_mut_slice()) { + Ok(0) => Ok(true), + Ok(count) => { + if output.len() as u64 + count as u64 > limit { + return Err(LegacyKeyConversion("converter output exceeds the size limit").into()); + } + output.extend_from_slice(&buffer[..count]); + Ok(false) + } + Err(error) if matches!(error.kind(), ErrorKind::WouldBlock | ErrorKind::Interrupted) => Ok(false), + Err(_) => Err(LegacyKeyConversion("could not read converter output").into()), + } +} + +pub(super) fn decrypt(der: &[u8], passphrase: Option<&str>) -> anyhow::Result { + let passphrase = passphrase.ok_or(RequestIdentityError::NoPassphrase("PEM"))?; + // The command's line reader reserves one byte for a terminator. The linked + // OpenSSL API accepted 1024 bytes, but the CLI would truncate that password. + if passphrase.len() > MAX_PASSWORD_BYTES { + return Err(LegacyKeyConversion("the password exceeds OpenSSL's 1023-byte input limit").into()); + } + // OpenSSL's pipe password source reads one line. Never silently truncate it. + if passphrase.contains(['\r', '\n', '\0']) { + return Err(LegacyKeyConversion("the password cannot be passed through OpenSSL's line-based input").into()); + } + + // Only encrypted input touches disk, in a private temporary file. The + // original file is never changed and decrypted output stays in memory. + let mut input = tempfile::NamedTempFile::new()?; + input.write_all(pem::encode(&pem::Pem::new("ENCRYPTED PRIVATE KEY", der)).as_bytes())?; + let child = Command::new("openssl") + .args([ + "pkcs8", "-topk8", "-nocrypt", "-inform", "PEM", "-outform", "DER", "-in", + ]) + .arg(input.path()) + .args(["-passin", "stdin"]) + .env("LC_ALL", "C") + .process_group(0) + .stdin(Stdio::piped()) + .stdout(Stdio::piped()) + .stderr(Stdio::piped()) + .spawn() + .map_err(|_| LegacyKeyConversion("the openssl executable is unavailable"))?; + let mut converter = Converter(child); + let mut stdin = converter.0.stdin.take(); + let mut stdout = converter.0.stdout.take().unwrap(); + let mut stderr = converter.0.stderr.take().unwrap(); + nonblocking(stdin.as_ref().unwrap())?; + nonblocking(&stdout)?; + nonblocking(&stderr)?; + let mut password = Zeroizing::new(passphrase.as_bytes().to_vec()); + password.push(b'\n'); + let mut written = 0; + let mut input_failed = false; + let mut output = Zeroizing::new(Vec::new()); + let mut diagnostic = Zeroizing::new(Vec::new()); + let mut output_done = false; + let mut diagnostic_done = false; + let mut status = None; + let started = Instant::now(); + let status = loop { + if started.elapsed() >= TIMEOUT { + return Err(LegacyKeyConversion("conversion timed out").into()); + } + if let Some(pipe) = stdin.as_mut() { + match pipe.write(&password[written..]) { + Ok(0) => { + input_failed = true; + stdin = None; + } + Ok(count) => { + written += count; + if written == password.len() { + stdin = None; + } + } + Err(error) if matches!(error.kind(), ErrorKind::WouldBlock | ErrorKind::Interrupted) => {} + Err(_) => { + input_failed = true; + stdin = None; + } + } + } + if !output_done { + output_done = read_output(&mut stdout, &mut output, MAX_OUTPUT)?; + } + if !diagnostic_done { + diagnostic_done = read_output(&mut stderr, &mut diagnostic, 16 * 1024)?; + } + if status.is_none() { + status = converter + .0 + .try_wait() + .map_err(|_| LegacyKeyConversion("could not wait for the converter"))?; + } + if let Some(status) = status { + if output_done && diagnostic_done && stdin.is_none() { + break status; + } + } + thread::sleep(Duration::from_millis(20)); + }; + if status.success() && input_failed { + return Err(LegacyKeyConversion("could not send the password").into()); + } + + if !status.success() { + // Never include the command's output in user-facing errors: it can contain + // key material. Preserve the old Linux password retry contract only for + // an explicit decryption failure, not missing cipher/provider support. + if [b"bad decrypt".as_slice(), b"pkcs12 cipherfinal error".as_slice()] + .iter() + .any(|message| diagnostic.windows(message.len()).any(|window| window == *message)) + { + return Err(RequestIdentityError::DecryptError("PEM").into()); + } + return Err(LegacyKeyConversion("this OpenSSL installation cannot decrypt the key").into()); + } + SecretDocument::try_from(output.as_slice()).map_err(|_| LegacyKeyConversion("invalid converted key").into()) +} diff --git a/crates/gpapi/src/utils/mod.rs b/crates/gpapi/src/utils/mod.rs index 120995e..0daf63c 100644 --- a/crates/gpapi/src/utils/mod.rs +++ b/crates/gpapi/src/utils/mod.rs @@ -5,10 +5,25 @@ pub mod checksum; pub mod crypto; pub mod endpoint; pub mod env_utils; +mod identity_encoding; +mod legacy_pkcs8; pub mod lock_file; +#[cfg(not(target_os = "macos"))] pub mod openssl; +#[cfg(target_os = "macos")] +#[path = "pkcs12_identity/macos.rs"] +mod pkcs12_identity; +#[cfg(not(target_os = "macos"))] +#[path = "pkcs12_identity/openssl.rs"] +mod pkcs12_identity; pub mod redact; pub mod request; +#[cfg(target_os = "macos")] +#[path = "traditional_key/macos.rs"] +mod traditional_key; +#[cfg(not(target_os = "macos"))] +#[path = "traditional_key/openssl.rs"] +mod traditional_key; #[cfg(feature = "tauri")] pub mod window; @@ -51,6 +66,8 @@ pub struct GpError { pub status: StatusCode, pub reason: String, body: String, + #[source] + source: Option, } impl GpError { @@ -63,9 +80,7 @@ pub async fn parse_gp_response(res: Response) -> anyhow::Result let status = res.status(); if status.is_client_error() || status.is_server_error() { - let (reason, body) = parse_gp_error(res).await; - - return Err(GpError { status, reason, body }); + return Err(parse_gp_error(res).await); } res.text().await.map_err(|err| { @@ -75,21 +90,28 @@ pub async fn parse_gp_response(res: Response) -> anyhow::Result status, reason: "failed to read response".to_string(), body: "".to_string(), + source: Some(err), } }) } -async fn parse_gp_error(res: Response) -> (String, String) { +async fn parse_gp_error(res: Response) -> GpError { + let status = res.status(); let reason = res .headers() .get("x-private-pan-globalprotect") .map_or_else(|| "", |v| v.to_str().unwrap_or("")) .to_string(); - let res = res.text().await.map_or_else( - |_| "".to_string(), - |v| if v.is_empty() { "".to_string() } else { v }, - ); + let (body, source) = match res.text().await { + Ok(body) => (if body.is_empty() { "".to_string() } else { body }, None), + Err(error) => ("".to_string(), Some(error)), + }; - (reason, res) + GpError { + status, + reason, + body, + source, + } } diff --git a/crates/gpapi/src/utils/pkcs12_identity/macos.rs b/crates/gpapi/src/utils/pkcs12_identity/macos.rs new file mode 100644 index 0000000..9653c22 --- /dev/null +++ b/crates/gpapi/src/utils/pkcs12_identity/macos.rs @@ -0,0 +1,24 @@ +use security_framework::{import_export::Pkcs12ImportOptions, os::macos::keychain::CreateOptions}; + +use super::request::RequestIdentityError; + +pub(super) fn ensure_complete(bytes: &[u8], password: &str) -> anyhow::Result<()> { + // native-tls assumes a successful import has a last item with an identity. + // Incomplete archives violate that assumption and panic. Inspect them first + // in a private temporary keychain, never the user's default keychain. + let directory = tempfile::tempdir()?; + let keychain = CreateOptions::new() + .password(&uuid::Uuid::new_v4().to_string()) + .create(directory.path().join("identity.keychain"))?; + if let Ok(imports) = Pkcs12ImportOptions::new() + .keychain(keychain) + .passphrase(password) + .import(bytes) + && !imports.last().is_some_and(|item| item.identity.is_some()) + { + return Err(RequestIdentityError::IncompletePkcs12.into()); + } + // Leave failed imports to reqwest so password errors retain their existing + // classification and native error chain. + Ok(()) +} diff --git a/crates/gpapi/src/utils/pkcs12_identity/openssl.rs b/crates/gpapi/src/utils/pkcs12_identity/openssl.rs new file mode 100644 index 0000000..7ddedf9 --- /dev/null +++ b/crates/gpapi/src/utils/pkcs12_identity/openssl.rs @@ -0,0 +1,14 @@ +use openssl::pkcs12::Pkcs12; + +use super::request::RequestIdentityError; + +pub(super) fn ensure_complete(bytes: &[u8], password: &str) -> anyhow::Result<()> { + // Parse errors belong to the existing native TLS importer. A successful parse + // lets us report incomplete archives without suggesting a password change. + if let Ok(archive) = Pkcs12::from_der(bytes).and_then(|archive| archive.parse2(password)) + && (archive.pkey.is_none() || archive.cert.is_none()) + { + return Err(RequestIdentityError::IncompletePkcs12.into()); + } + Ok(()) +} diff --git a/crates/gpapi/src/utils/redact.rs b/crates/gpapi/src/utils/redact.rs index 712c847..3ae7d66 100644 --- a/crates/gpapi/src/utils/redact.rs +++ b/crates/gpapi/src/utils/redact.rs @@ -1,11 +1,10 @@ use std::sync::RwLock; -use redact_engine::{Pattern, Redaction as RedactEngine}; use regex::Regex; use url::{Url, form_urlencoded}; pub struct Redaction { - redact_engine: RwLock>, + patterns: RwLock>, } impl Default for Redaction { @@ -16,56 +15,45 @@ impl Default for Redaction { impl Redaction { pub fn new() -> Self { - let redact_engine = RedactEngine::custom("[**********]").add_pattern(Pattern { - test: Regex::new("(((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4})").unwrap(), - group: 1, - }); - Self { - redact_engine: RwLock::new(Some(redact_engine)), + patterns: RwLock::new(vec![ + Regex::new("(((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4})").unwrap(), + ]), } } pub fn add_value(&self, text: &str) -> anyhow::Result<()> { - let mut redact_engine = self - .redact_engine - .write() - .map_err(|_| anyhow::anyhow!("Failed to acquire write lock on redact engine"))?; - - *redact_engine = Some( - redact_engine - .take() - .ok_or_else(|| anyhow::anyhow!("Failed to take redact engine"))? - .add_value(text)?, - ); - - Ok(()) + self.add_values(&[text]) } pub fn add_values(&self, texts: &[&str]) -> anyhow::Result<()> { - let mut redact_engine = self - .redact_engine + let patterns = texts + .iter() + .map(|text| Regex::new(®ex::escape(text))) + .collect::, _>>()?; + self + .patterns .write() - .map_err(|_| anyhow::anyhow!("Failed to acquire write lock on redact engine"))?; - - *redact_engine = Some( - redact_engine - .take() - .ok_or_else(|| anyhow::anyhow!("Failed to take redact engine"))? - .add_values(texts.to_vec())?, - ); + .map_err(|_| anyhow::anyhow!("Failed to acquire write lock on redaction patterns"))? + .extend(patterns); Ok(()) } pub fn redact_str(&self, text: &str) -> String { - self - .redact_engine + let patterns = self + .patterns .read() - .expect("Failed to acquire read lock on redact engine") - .as_ref() - .expect("Failed to get redact engine") - .redact_str(text) + .expect("Failed to acquire read lock on redaction patterns"); + let mut redacted = text.to_owned(); + // Match the original text, then replace in registration order. Matching the + // replacements would change how overlapping values are redacted. + for pattern in patterns.iter() { + for matched in pattern.find_iter(text) { + redacted = redacted.replacen(matched.as_str(), "[**********]", 1); + } + } + redacted } } @@ -180,6 +168,38 @@ fn redact_query(query: Option<&str>) -> Option { mod tests { use super::*; + #[test] + fn redacts_repeated_ipv4_addresses() { + assert_eq!( + Redaction::new().redact_str("from 192.0.2.1 to 198.51.100.9, then 192.0.2.1"), + "from [**********] to [**********], then [**********]" + ); + } + + #[test] + fn registered_values_are_literal_and_support_unicode() { + let redaction = Redaction::new(); + redaction.add_values(&["a.b+$[x]", "秘密🔑"]).unwrap(); + + assert_eq!( + redaction.redact_str("a.b+$[x] 秘密🔑 a.b+$[x] aXb"), + "[**********] [**********] [**********] aXb" + ); + } + + #[test] + fn overlapping_values_keep_registration_order() { + let redaction = Redaction::new(); + redaction.add_values(&["foobar", "foo"]).unwrap(); + + assert_eq!(redaction.redact_str("foobar foo"), "[**********] [**********]"); + } + + #[test] + fn unicode_word_characters_preserve_ipv4_boundaries() { + assert_eq!(Redaction::new().redact_str("192.0.2.1é"), "192.0.2.1é"); + } + #[test] fn it_should_not_redact_value() { let text = "fo"; diff --git a/crates/gpapi/src/utils/request.rs b/crates/gpapi/src/utils/request.rs index ad79723..92d89b1 100644 --- a/crates/gpapi/src/utils/request.rs +++ b/crates/gpapi/src/utils/request.rs @@ -1,10 +1,11 @@ use std::{fmt, fs, io::Write, path::Path, sync::Arc}; use anyhow::{Context, ensure}; -use openssl::{pkey::PKey, x509::X509}; use reqwest::Identity; use zeroize::Zeroizing; +use super::{identity_encoding, pkcs12_identity}; + #[derive(Debug, thiserror::Error)] pub enum RequestIdentityError { #[error("Failed to find the private key")] @@ -13,6 +14,24 @@ pub enum RequestIdentityError { NoPassphrase(&'static str), #[error("Failed to decrypt private key")] DecryptError(&'static str), + #[error( + "Unsupported private key encryption. Convert the key to modern PKCS#8 using PBES2 with AES before importing it" + )] + UnsupportedEncryption, + #[error( + "Could not convert the legacy private key with OpenSSL: {0}. Convert the key to modern PKCS#8 using PBES2 with AES before importing it" + )] + LegacyKeyConversion(&'static str), + #[error("Unsupported private key format. Convert the key to PKCS#8 before importing it")] + UnsupportedKeyFormat, + #[error("Invalid private key")] + InvalidKey, + #[error("Invalid certificate or certificate chain")] + InvalidCertificate, + #[error("The PKCS#12 file must contain both a client certificate and its private key")] + IncompletePkcs12, + #[error("Could not open the PKCS#12 certificate. Check the password and certificate file")] + InvalidPkcs12(#[source] reqwest::Error), } /// Loaded once by the authentication owner. PEM keys are decrypted once; PKCS#12 @@ -41,37 +60,17 @@ impl fmt::Debug for ClientIdentity { impl ClientIdentity { pub fn load(certificate: &str, key: Option<&str>, passphrase: Option<&str>) -> anyhow::Result { let certificate_bytes = read_identity_file(certificate)?; - if certificate.ends_with(".p12") || certificate.ends_with(".pfx") { - let passphrase = passphrase.ok_or(RequestIdentityError::NoPassphrase("PKCS#12"))?; - return Self::from_data(certificate_bytes, None, Some(passphrase)); + let extension = Path::new(certificate).extension().and_then(|value| value.to_str()); + if extension.is_some_and(|value| value.eq_ignore_ascii_case("p12") || value.eq_ignore_ascii_case("pfx")) { + return Self::from_data(certificate_bytes, None, passphrase); } let key_bytes = match key { Some(path) => read_identity_file(path)?, None => certificate_bytes.clone(), }; - // Keep the previous first-private-key rule: unrelated later blocks must not - // change which key is selected or whether the caller is prompted. - let key = pem::parse_many(&*key_bytes)? - .into_iter() - .find(|pem| pem.tag().ends_with("PRIVATE KEY")) - .ok_or(RequestIdentityError::NoKey)?; - let key_pem = Zeroizing::new(pem::encode(&key)); - let key = if key.tag().ends_with("ENCRYPTED PRIVATE KEY") { - let passphrase = passphrase.ok_or(RequestIdentityError::NoPassphrase("PEM"))?; - let key = PKey::private_key_from_pem_passphrase(key_pem.as_bytes(), passphrase.as_bytes()) - .map_err(|_| RequestIdentityError::DecryptError("PEM"))?; - Zeroizing::new(key.private_key_to_pem_pkcs8()?) - } else { - Zeroizing::new(key_pem.as_bytes().to_vec()) - }; - // Strip private-key blocks before importing the certificate chain: macOS - // otherwise imports the same key twice for combined PEM files. - let mut certificate = Zeroizing::new(Vec::new()); - for cert in X509::stack_from_pem(&certificate_bytes)? { - certificate.extend(cert.to_pem()?); - } - let identity = Identity::from_pkcs8_pem(&certificate, &key)?; - let key = Zeroizing::new(PKey::private_key_from_pem(&key)?.private_key_to_pem_pkcs8()?); + let key = identity_encoding::private_key(&key_bytes, passphrase)?; + let certificate = identity_encoding::certificate_chain(&certificate_bytes)?; + let identity = pem_request_identity(&certificate, &key)?; Ok(Self { material: Arc::new(IdentityMaterial { certificate, @@ -90,12 +89,21 @@ impl ClientIdentity { passphrase: Option<&str>, ) -> anyhow::Result { let (identity, passphrase) = match &key { - Some(key) => (Identity::from_pkcs8_pem(&certificate, key)?, None), + Some(key) => (pem_request_identity(&certificate, key)?, None), None => { - let passphrase = passphrase.ok_or(RequestIdentityError::NoPassphrase("PKCS#12"))?; + pkcs12_identity::ensure_complete(&certificate, passphrase.unwrap_or_default())?; + // A blank settings field is stored as None. Try the empty password so + // passwordless archives work, but keep prompting for protected ones. + let identity = Identity::from_pkcs12_der(&certificate, passphrase.unwrap_or_default()).map_err(|error| { + if passphrase.is_none() { + RequestIdentityError::NoPassphrase("PKCS#12") + } else { + RequestIdentityError::InvalidPkcs12(error) + } + })?; ( - Identity::from_pkcs12_der(&certificate, passphrase)?, - Some(Zeroizing::new(passphrase.to_owned())), + identity, + Some(Zeroizing::new(passphrase.unwrap_or_default().to_owned())), ) } }; @@ -152,6 +160,20 @@ impl ClientIdentityFiles { } } +fn pem_request_identity(certificate: &[u8], key: &[u8]) -> anyhow::Result { + let error_context = + "Client certificate and private key cannot be used together. Check that the private key matches the certificate"; + let identity = Identity::from_pkcs8_pem(certificate, key).context(error_context)?; + // Native TLS may defer the certificate/key match check until connector creation. + // Build the same client used for requests without making a network connection. + reqwest::Client::builder() + .no_proxy() + .identity(identity.clone()) + .build() + .context(error_context)?; + Ok(identity) +} + fn read_identity_file(path: &str) -> anyhow::Result>> { Ok(Zeroizing::new( fs::read(path).context("Failed to read client identity")?, @@ -189,50 +211,15 @@ pub fn create_identity(cert: &str, key: Option<&str>, passphrase: Option<&str>) #[cfg(test)] mod tests { use super::*; - use openssl::pkcs12::Pkcs12; - fn generated_identity() -> (Vec, Vec) { - use openssl::{asn1::Asn1Time, hash::MessageDigest, rsa::Rsa, x509::X509NameBuilder}; - let key = PKey::from_rsa(Rsa::generate(2048).unwrap()).unwrap(); - let mut name = X509NameBuilder::new().unwrap(); - name.append_entry_by_text("CN", "identity-fixture").unwrap(); - let name = name.build(); - let mut certificate = X509::builder().unwrap(); - certificate.set_version(2).unwrap(); - certificate.set_subject_name(&name).unwrap(); - certificate.set_issuer_name(&name).unwrap(); - certificate.set_pubkey(&key).unwrap(); - certificate - .set_not_before(&Asn1Time::days_from_now(0).unwrap()) - .unwrap(); - certificate.set_not_after(&Asn1Time::days_from_now(1).unwrap()).unwrap(); - certificate.sign(&key, MessageDigest::sha256()).unwrap(); - ( - certificate.build().to_pem().unwrap(), - key.private_key_to_pem_pkcs8().unwrap(), - ) - } - - #[test] - fn pem_uses_first_private_key_without_prompting_for_later_encrypted_keys() { - let (certificate, key) = generated_identity(); - let encrypted = PKey::private_key_from_pem(&key) - .unwrap() - .private_key_to_pem_pkcs8_passphrase(openssl::symm::Cipher::aes_256_cbc(), b"unused") - .unwrap(); - let mut source = tempfile::NamedTempFile::new().unwrap(); - source.write_all(&certificate).unwrap(); - source.write_all(&key).unwrap(); - source.write_all(&encrypted).unwrap(); - let identity = ClientIdentity::load(source.path().to_str().unwrap(), None, None).unwrap(); - assert_eq!(identity.key_data().unwrap(), key); - } + const CERTIFICATE: &[u8] = include_bytes!("../../tests/files/client-identity/rsa-cert.pem"); + const KEY: &[u8] = include_bytes!("../../tests/files/client-identity/rsa-pkcs8.pem"); + const ENCRYPTED_KEY: &[u8] = include_bytes!("../../tests/files/client-identity/rsa-pbes2-sha256.pem"); #[test] fn pem_without_key_reports_missing_key_even_with_passphrase() { - let (certificate, _) = generated_identity(); let mut source = tempfile::NamedTempFile::new().unwrap(); - source.write_all(&certificate).unwrap(); + source.write_all(CERTIFICATE).unwrap(); for passphrase in [None, Some("unused")] { let error = ClientIdentity::load(source.path().to_str().unwrap(), None, passphrase).unwrap_err(); assert!(matches!( @@ -244,249 +231,57 @@ mod tests { #[test] fn local_identity_loading_is_not_limited_by_service_message_size() { - let (certificate, key) = generated_identity(); let mut source = tempfile::NamedTempFile::new().unwrap(); - source.write_all(&certificate).unwrap(); - source.write_all(&key).unwrap(); + source.write_all(CERTIFICATE).unwrap(); + source.write_all(KEY).unwrap(); source.write_all(&vec![b'\n'; 33 * 1024]).unwrap(); let identity = ClientIdentity::load(source.path().to_str().unwrap(), None, None).unwrap(); - assert_eq!(identity.certificate_data(), certificate); - assert_eq!(identity.key_data().unwrap(), key); + assert_eq!(identity.certificate_data(), CERTIFICATE); + assert_eq!(identity.key_data().unwrap(), KEY); } #[test] - fn pem_passphrases_preserve_prompt_errors_and_accept_separate_keys() { - let (certificate, key) = generated_identity(); - let mut cert_file = tempfile::NamedTempFile::new().unwrap(); - cert_file.write_all(&certificate).unwrap(); - let mut key_file = tempfile::NamedTempFile::new().unwrap(); - let encrypted = PKey::private_key_from_pem(&key) - .unwrap() - .private_key_to_pem_pkcs8_passphrase(openssl::symm::Cipher::aes_256_cbc(), b"correct") - .unwrap(); - key_file.write_all(&encrypted).unwrap(); - let cert = cert_file.path().to_str().unwrap(); - let key_path = Some(key_file.path().to_str().unwrap()); - for (passphrase, missing) in [(None, true), (Some("wrong"), false)] { - let error = ClientIdentity::load(cert, key_path, passphrase).unwrap_err(); - match error.downcast_ref::().unwrap() { - RequestIdentityError::NoPassphrase("PEM") => assert!(missing), - RequestIdentityError::DecryptError("PEM") => assert!(!missing), - other => panic!("Unexpected identity error: {other}"), + fn create_identity_preserves_password_errors_and_builds_a_native_request_client() { + let mut source = tempfile::NamedTempFile::new().unwrap(); + source.write_all(CERTIFICATE).unwrap(); + source.write_all(ENCRYPTED_KEY).unwrap(); + for (password, missing) in [(None, true), (Some("wrong"), false)] { + let error = create_identity(source.path().to_str().unwrap(), None, password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(missing), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(!missing), + other => panic!("Unexpected identity error: {other:?}"), } } - let loaded = ClientIdentity::load(cert, key_path, Some("correct")).unwrap(); - assert_eq!(loaded.key_data().unwrap(), key); - fs::write(key_file.path(), &key).unwrap(); - for passphrase in [None, Some("ignored for unencrypted key")] { - assert_eq!( - ClientIdentity::load(cert, key_path, passphrase) - .unwrap() - .key_data() - .unwrap(), - key - ); - } + let identity = create_identity(source.path().to_str().unwrap(), None, Some("fixture-password")).unwrap(); + drop(source); + reqwest::Client::builder().identity(identity).build().unwrap(); } #[test] - fn loaded_identity_survives_original_file_replacement_and_owns_private_files() { + fn unencrypted_key_ignores_unused_password_and_archive_owned_file_is_private() { use std::os::unix::fs::PermissionsExt; - let (certificate, key) = generated_identity(); - let directory = tempfile::tempdir().unwrap(); - let source = directory.path().join("combined.pem"); - let mut combined = certificate.clone(); - combined.extend(&key); - fs::write(&source, &combined).unwrap(); - let identity = ClientIdentity::load(source.to_str().unwrap(), None, None).unwrap(); - fs::write(&source, "changed after authentication").unwrap(); - assert_eq!(identity.certificate_data(), certificate); - assert_eq!(identity.key_data().unwrap(), key); - assert!(!format!("{identity:?}").contains("PRIVATE KEY")); - let files = identity.write_files(Some(directory.path())).unwrap(); - let certificate_path = files.certificate().to_owned(); - let key_path = files.key().unwrap().to_owned(); - assert_eq!(fs::read(&certificate_path).unwrap(), certificate); - assert_eq!(fs::read(&key_path).unwrap(), key); - assert_eq!(fs::metadata(&key_path).unwrap().permissions().mode() & 0o777, 0o600); + let identity = ClientIdentity::from_data( + Zeroizing::new(CERTIFICATE.to_vec()), + Some(Zeroizing::new(KEY.to_vec())), + Some("unused password"), + ) + .unwrap(); + assert!(identity.key_password().is_none()); + let archive = include_bytes!("../../tests/files/client-identity/modern.p12").to_vec(); + let identity = ClientIdentity::from_data(Zeroizing::new(archive), None, Some("fixture-password")).unwrap(); + let files = identity.write_files(None).unwrap(); + let path = files.certificate().to_owned(); + assert!(path.ends_with(".p12")); + assert!(files.key().is_none()); + assert_eq!(fs::metadata(&path).unwrap().permissions().mode() & 0o777, 0o600); drop(files); - assert!(!Path::new(&certificate_path).exists()); - assert!(!Path::new(&key_path).exists()); - // The request identity remains valid after its original files disappear. - fs::remove_file(&source).unwrap(); + assert!(!Path::new(&path).exists()); reqwest::Client::builder() .identity(identity.request_identity()) .build() .unwrap(); } - - #[test] - fn pkcs12_preserves_original_data_password_and_owned_native_files() { - let (certificate, key) = generated_identity(); - let certificate = X509::from_pem(&certificate).unwrap(); - let key = PKey::private_key_from_pem(&key).unwrap(); - let mut builder = Pkcs12::builder(); - builder.name("identity-fixture").pkey(&key).cert(&certificate); - let encoded = builder.build2("fixture-password").unwrap().to_der().unwrap(); - for suffix in [".p12", ".pfx"] { - let mut source = tempfile::Builder::new().suffix(suffix).tempfile().unwrap(); - source.write_all(&encoded).unwrap(); - let path = source.path().to_str().unwrap(); - assert!(ClientIdentity::load(path, None, None).is_err()); - assert!(ClientIdentity::load(path, None, Some("wrong")).is_err()); - // PKCS#12 has always ignored a separately configured key path. - let identity = ClientIdentity::load(path, Some("missing-key-file"), Some("fixture-password")).unwrap(); - fs::write(source.path(), b"replaced after login").unwrap(); - assert_eq!(identity.certificate_data(), encoded); - assert!(identity.key_data().is_none()); - assert_eq!(identity.key_password(), Some("fixture-password")); - assert!(!format!("{identity:?}").contains("fixture-password")); - let files = identity.write_files(None).unwrap(); - assert!(files.certificate().ends_with(".p12")); - assert!(files.key().is_none()); - ClientIdentity::load(files.certificate(), files.key(), identity.key_password()).unwrap(); - let owned_path = files.certificate().to_owned(); - drop(files); - assert!(!Path::new(&owned_path).exists()); - } - let empty_password = builder.build2("").unwrap().to_der().unwrap(); - // Empty-password support varies by native backend and PKCS#12 algorithms. - // Match the previous native import instead of introducing another parser. - let previously_accepted = Identity::from_pkcs12_der(&empty_password, "").is_ok(); - assert_eq!( - ClientIdentity::from_data(Zeroizing::new(empty_password), None, Some("")).is_ok(), - previously_accepted - ); - } - - #[test] - fn pkcs12_retains_chain_without_reordering_or_reencoding() { - use openssl::{ - asn1::Asn1Time, - hash::MessageDigest, - rsa::Rsa, - stack::Stack, - x509::{X509NameBuilder, extension::BasicConstraints}, - }; - fn certificate( - name: &str, - parent: Option<(&X509, &PKey)>, - ca: bool, - ) -> (X509, PKey) { - let key = PKey::from_rsa(Rsa::generate(2048).unwrap()).unwrap(); - let mut subject = X509NameBuilder::new().unwrap(); - subject.append_entry_by_text("CN", name).unwrap(); - let subject = subject.build(); - let mut cert = X509::builder().unwrap(); - cert.set_version(2).unwrap(); - let serial = openssl::bn::BigNum::from_u32(name.len() as u32) - .unwrap() - .to_asn1_integer() - .unwrap(); - cert.set_serial_number(&serial).unwrap(); - cert.set_subject_name(&subject).unwrap(); - cert - .set_issuer_name(parent.map(|(cert, _)| cert.subject_name()).unwrap_or(&subject)) - .unwrap(); - cert.set_pubkey(&key).unwrap(); - cert.set_not_before(&Asn1Time::days_from_now(0).unwrap()).unwrap(); - cert.set_not_after(&Asn1Time::days_from_now(1).unwrap()).unwrap(); - if ca { - cert - .append_extension(BasicConstraints::new().critical().ca().build().unwrap()) - .unwrap(); - } - cert - .sign(parent.map(|(_, key)| key).unwrap_or(&key), MessageDigest::sha256()) - .unwrap(); - (cert.build(), key) - } - let (root, root_key) = certificate("root", None, true); - let (intermediate, intermediate_key) = certificate("intermediate", Some((&root, &root_key)), true); - let (leaf, key) = certificate("client", Some((&intermediate, &intermediate_key)), false); - // This is the reverse CA stack consumed by the previous native-tls path. - let mut ca = Stack::new().unwrap(); - ca.push(root.clone()).unwrap(); - ca.push(intermediate.clone()).unwrap(); - let mut builder = Pkcs12::builder(); - builder.name("chain-fixture").pkey(&key).cert(&leaf).ca(ca); - let encoded = builder.build2("fixture-password").unwrap().to_der().unwrap(); - let mut source = tempfile::Builder::new().suffix(".p12").tempfile().unwrap(); - source.write_all(&encoded).unwrap(); - let identity = ClientIdentity::load(source.path().to_str().unwrap(), None, Some("fixture-password")).unwrap(); - assert_eq!(identity.certificate_data(), encoded); - assert!(identity.key_data().is_none()); - ClientIdentity::from_data( - Zeroizing::new(identity.certificate_data().to_vec()), - None, - identity.key_password(), - ) - .unwrap(); - } - - #[test] - fn create_identity_from_pem_requires_passphrase() { - let cert = "tests/files/badssl.com-client.pem"; - let identity = create_identity(cert, None, None); - - assert!(identity.is_err()); - assert!(identity.unwrap_err().to_string().contains("No passphrase provided")); - } - - #[test] - #[cfg(not(target_os = "macos"))] - fn create_identity_from_pem_with_passphrase() { - let cert = "tests/files/badssl.com-client.pem"; - let passphrase = "badssl.com"; - - let identity = create_identity(cert, None, Some(passphrase)); - - assert!(identity.is_ok()); - } - - #[test] - #[cfg(not(target_os = "macos"))] - fn create_identity_from_pem_unencrypted_key() { - let cert = "tests/files/badssl.com-client-unencrypted.pem"; - let identity = create_identity(cert, None, None); - println!("{:?}", identity); - - assert!(identity.is_ok()); - } - - #[test] - #[cfg(not(target_os = "macos"))] - fn create_identity_from_pem_cert_and_encrypted_key() { - let cert = "tests/files/badssl.com-client.pem"; - let key = "tests/files/badssl.com-client.pem"; - let passphrase = "badssl.com"; - - let identity = create_identity(cert, Some(key), Some(passphrase)); - - assert!(identity.is_ok()); - } - - #[test] - fn create_identity_from_pem_cert_and_encrypted_key_no_passphrase() { - let cert = "tests/files/badssl.com-client.pem"; - let key = "tests/files/badssl.com-client.pem"; - - let identity = create_identity(cert, Some(key), None); - - assert!(identity.is_err()); - assert!(identity.unwrap_err().to_string().contains("No passphrase provided")); - } - - #[test] - #[cfg(not(target_os = "macos"))] - fn create_identity_from_pem_cert_and_unencrypted_key() { - let cert = "tests/files/badssl.com-client.pem"; - let key = "tests/files/badssl.com-client-unencrypted.pem"; - - let identity = create_identity(cert, Some(key), None); - - assert!(identity.is_ok()); - } } #[derive(Debug, thiserror::Error)] diff --git a/crates/gpapi/src/utils/traditional_key/macos.rs b/crates/gpapi/src/utils/traditional_key/macos.rs new file mode 100644 index 0000000..6c59699 --- /dev/null +++ b/crates/gpapi/src/utils/traditional_key/macos.rs @@ -0,0 +1,17 @@ +use pkcs8::SecretDocument; + +use super::{identity_encoding::TraditionalKeyFormat, request::RequestIdentityError}; + +pub(super) fn normalize( + _bytes: &[u8], + format: TraditionalKeyFormat, + _passphrase: Option<&str>, +) -> anyhow::Result { + Err( + match format { + TraditionalKeyFormat::EncryptedPem => RequestIdentityError::UnsupportedEncryption, + TraditionalKeyFormat::PlainPem | TraditionalKeyFormat::Sec1Der => RequestIdentityError::UnsupportedKeyFormat, + } + .into(), + ) +} diff --git a/crates/gpapi/src/utils/traditional_key/openssl.rs b/crates/gpapi/src/utils/traditional_key/openssl.rs new file mode 100644 index 0000000..1234053 --- /dev/null +++ b/crates/gpapi/src/utils/traditional_key/openssl.rs @@ -0,0 +1,49 @@ +use openssl::{ + error::ErrorStack, + pkey::{Id, PKey}, +}; +use pkcs8::SecretDocument; +use zeroize::Zeroizing; + +use super::{identity_encoding::TraditionalKeyFormat, request::RequestIdentityError}; + +pub(super) fn normalize( + bytes: &[u8], + format: TraditionalKeyFormat, + passphrase: Option<&str>, +) -> anyhow::Result { + let key = match format { + TraditionalKeyFormat::Sec1Der => PKey::private_key_from_der(bytes), + TraditionalKeyFormat::PlainPem => PKey::private_key_from_pem_passphrase(bytes, b""), + TraditionalKeyFormat::EncryptedPem => { + let passphrase = passphrase.ok_or(RequestIdentityError::NoPassphrase("PEM"))?; + anyhow::ensure!( + !passphrase.as_bytes().contains(&0), + "Private key passphrases containing NUL are not supported" + ); + PKey::private_key_from_pem_passphrase(bytes, passphrase.as_bytes()) + } + } + .map_err(import_error)?; + if !matches!(key.id(), Id::RSA | Id::EC) { + return Err(RequestIdentityError::UnsupportedKeyFormat.into()); + } + let der = Zeroizing::new( + key + .private_key_to_pkcs8() + .map_err(|_| RequestIdentityError::InvalidKey)?, + ); + Ok(SecretDocument::try_from(der.as_slice()).map_err(|_| RequestIdentityError::InvalidKey)?) +} + +fn import_error(error: ErrorStack) -> RequestIdentityError { + // Inspect only known backend reasons. Never expose the native error stack or + // turn an unclassified decoder failure into a password retry loop. + if error.errors().iter().any(|error| error.reason() == Some("bad decrypt")) { + RequestIdentityError::DecryptError("PEM") + } else if error.errors().iter().any(|error| error.reason() == Some("unsupported")) { + RequestIdentityError::UnsupportedEncryption + } else { + RequestIdentityError::InvalidKey + } +} diff --git a/crates/gpapi/tests/client_identity.rs b/crates/gpapi/tests/client_identity.rs new file mode 100644 index 0000000..be58047 --- /dev/null +++ b/crates/gpapi/tests/client_identity.rs @@ -0,0 +1,708 @@ +//! Public identity compatibility and native import behavior. +use std::{fs, path::PathBuf}; + +use gpapi::utils::request::{ClientIdentity, RequestIdentityError}; + +const PASSWORD: &str = "fixture-password"; + +fn fixture(name: &str) -> PathBuf { + PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("tests/files/client-identity") + .join(name) +} + +fn load(certificate: &str, key: &str, password: Option<&str>) -> anyhow::Result { + ClientIdentity::load( + fixture(certificate).to_str().unwrap(), + Some(fixture(key).to_str().unwrap()), + password, + ) +} + +#[test] +fn rsa_pkcs8_loads_without_a_password() { + let identity = load("rsa-cert.pem", "rsa-pkcs8.pem", None).unwrap(); + assert_eq!(identity.certificate_data(), fs::read(fixture("rsa-cert.pem")).unwrap()); + assert_eq!( + identity.key_data().unwrap(), + fs::read(fixture("rsa-pkcs8.pem")).unwrap() + ); + assert!(identity.key_password().is_none()); +} + +#[test] +fn ec_pkcs8_records_native_import_compatibility() { + let result = load("ec-cert.pem", "ec-pkcs8.pem", None); + if cfg!(target_os = "macos") { + // Apple native-tls import currently rejects this P-256 PKCS#8 fixture. + assert!( + result + .unwrap_err() + .downcast_ref::() + .unwrap() + .is_builder() + ); + } else { + assert_eq!( + result.unwrap().key_data().unwrap(), + fs::read(fixture("ec-pkcs8.pem")).unwrap() + ); + } +} + +#[test] +fn encrypted_pkcs8_keys_normalize_to_the_same_private_key() { + for (key, expected, certificate) in [ + ("rsa-pbes2-sha1.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("rsa-pbes2-sha256.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("rsa-pbes2-aes-128-cbc-sha1.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("rsa-pbes2-aes-128-cbc-sha256.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("rsa-pbes2-aes-192-cbc-sha1.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("rsa-pbes2-aes-192-cbc-sha256.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("rsa-pbes2-scrypt.pem", "rsa-pkcs8.pem", "rsa-cert.pem"), + ("ec-pbes2.pem", "ec-pkcs8.pem", "ec-cert.pem"), + ] { + let result = load(certificate, key, Some(PASSWORD)); + if cfg!(target_os = "macos") && certificate == "ec-cert.pem" { + assert!( + result + .unwrap_err() + .downcast_ref::() + .unwrap() + .is_builder() + ); + } else { + let identity = result.unwrap_or_else(|error| panic!("{key}: {error}")); + assert_eq!( + identity.key_data().unwrap(), + fs::read(fixture(expected)).unwrap(), + "{key}" + ); + assert!(identity.key_password().is_none()); + } + for (password, missing) in [(None, true), (Some("incorrect"), false)] { + let error = load(certificate, key, password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(missing), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(!missing), + other => panic!("{key}: unexpected error {other:?}"), + } + } + } +} + +#[test] +fn combined_pem_preserves_the_certificate_chain_and_removes_key_blocks() { + let mut chain = fs::read(fixture("rsa-cert.pem")).unwrap(); + chain.extend(fs::read(fixture("root.pem")).unwrap()); + let mut combined = chain.clone(); + let key = fs::read(fixture("rsa-pkcs8.pem")).unwrap(); + combined.extend(&key); + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("combined.pem"); + fs::write(&source, combined).unwrap(); + let identity = ClientIdentity::load(source.to_str().unwrap(), None, None).unwrap(); + assert_eq!(identity.certificate_data(), chain); + assert_eq!(identity.key_data().unwrap(), key); +} + +#[test] +fn rsa_pkcs1_normalizes_to_pkcs8_in_separate_and_combined_files() { + let certificate = fs::read(fixture("rsa-cert.pem")).unwrap(); + let expected = fs::read(fixture("rsa-pkcs8.pem")).unwrap(); + for password in [None, Some("unused")] { + let identity = load("rsa-cert.pem", "rsa-pkcs1.pem", password).unwrap(); + assert_eq!(identity.certificate_data(), certificate); + assert_eq!(identity.key_data().unwrap(), expected); + assert!(identity.key_password().is_none()); + } + + let mut combined = certificate.clone(); + combined.extend(fs::read(fixture("rsa-pkcs1.pem")).unwrap()); + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("combined.pem"); + fs::write(&source, combined).unwrap(); + let identity = ClientIdentity::load(source.to_str().unwrap(), None, None).unwrap(); + assert_eq!(identity.certificate_data(), certificate); + assert_eq!(identity.key_data().unwrap(), expected); +} + +#[test] +fn malformed_rsa_pkcs1_is_rejected_by_native_import() { + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("invalid-key.pem"); + fs::write(&source, pem::encode(&pem::Pem::new("RSA PRIVATE KEY", vec![0x30, 0]))).unwrap(); + let error = ClientIdentity::load( + fixture("rsa-cert.pem").to_str().unwrap(), + Some(source.to_str().unwrap()), + None, + ) + .unwrap_err(); + assert!(error.downcast_ref::().is_some()); +} + +fn check_archive(name: &str, password: &str) { + let source = fixture(name); + let path = source.to_str().unwrap(); + let identity = ClientIdentity::load(path, None, Some(password)).unwrap(); + assert_eq!(identity.certificate_data(), fs::read(&source).unwrap()); + assert!(identity.key_data().is_none()); + assert_eq!(identity.key_password(), Some(password)); + let files = identity.write_files(None).unwrap(); + ClientIdentity::load(files.certificate(), files.key(), identity.key_password()).unwrap(); + assert!(ClientIdentity::load(path, None, Some("incorrect")).is_err()); + let error = ClientIdentity::load(path, None, None).unwrap_err(); + assert!(matches!( + error.downcast_ref::(), + Some(RequestIdentityError::NoPassphrase("PKCS#12")) + )); + // The MAC is at the end of these fixtures. Change authenticated archive data + // (a byte in the friendly name), leaving valid ASN.1 and ciphertext intact. + let mut corrupted = fs::read(&source).unwrap(); + let label = [0, b'f', 0, b'i', 0, b'x', 0, b't', 0, b'u', 0, b'r', 0, b'e']; + let offset = corrupted + .windows(label.len()) + .position(|window| window == label) + .unwrap(); + corrupted[offset + 1] = b'F'; + let directory = tempfile::tempdir().unwrap(); + let damaged = directory.path().join("damaged.p12"); + fs::write(&damaged, corrupted).unwrap(); + assert!(ClientIdentity::load(damaged.to_str().unwrap(), None, Some(password)).is_err()); +} + +#[test] +fn incomplete_pkcs12_reports_that_both_certificate_and_key_are_required() { + for name in ["certificate-only.pfx", "key-only.pfx"] { + let bytes = fs::read(fixture(name)).unwrap(); + for result in [ + ClientIdentity::load(fixture(name).to_str().unwrap(), None, Some(PASSWORD)), + ClientIdentity::from_data(zeroize::Zeroizing::new(bytes.clone()), None, Some(PASSWORD)), + ] { + let error = result.unwrap_err(); + assert_eq!( + error.to_string(), + "The PKCS#12 file must contain both a client certificate and its private key", + "{name}" + ); + } + } +} + +#[test] +fn modern_pkcs12_checks_password_and_archive_integrity() { + check_archive("modern.p12", PASSWORD); +} + +#[test] +fn pkcs12_password_errors_explain_how_to_recover() { + let archive = fs::read(fixture("modern.p12")).unwrap(); + for password in ["incorrect", ""] { + let errors = [ + ClientIdentity::load(fixture("modern.p12").to_str().unwrap(), None, Some(password)).unwrap_err(), + ClientIdentity::from_data(zeroize::Zeroizing::new(archive.clone()), None, Some(password)).unwrap_err(), + ]; + for error in errors { + assert!(matches!( + error.downcast_ref::(), + Some(RequestIdentityError::InvalidPkcs12(_)) + )); + let message = error.to_string(); + assert!(message.contains("PKCS#12"), "{message}"); + assert!(message.contains("password") && message.contains("file"), "{message}"); + assert!(!format!("{error:?}").contains("incorrect")); + assert!(error.chain().any(|cause| cause.is::())); + } + } +} + +#[test] +// Apple's native importer rejects this empty-password fixture; its native +// compatibility decision is covered by archive_snapshot_and_pfx_preserve_native_import_contract. +#[cfg(not(target_os = "macos"))] +fn empty_pkcs12_password_survives_loading_and_transport() { + let archive = fs::read(fixture("empty-password.p12")).unwrap(); + for password in [None, Some("")] { + let loaded = ClientIdentity::load(fixture("empty-password.p12").to_str().unwrap(), None, password).unwrap(); + assert_eq!(loaded.key_password(), Some("")); + let restored = ClientIdentity::from_data(zeroize::Zeroizing::new(archive.clone()), None, password).unwrap(); + assert_eq!(restored.key_password(), Some("")); + let files = restored.write_files(None).unwrap(); + ClientIdentity::load(files.certificate(), files.key(), restored.key_password()).unwrap(); + } +} + +#[test] +fn pkcs12_accepts_non_ascii_passwords() { + check_archive("unicode-password.p12", "pässword-密码"); +} + +#[test] +fn legacy_rc2_pkcs12_checks_password_and_archive_integrity() { + #[cfg(not(target_os = "macos"))] + if std::env::var_os("GP_IDENTITY_LEGACY_TEST_CHILD").is_none() { + // OpenSSL providers are process-global. Exercise the existing legacy-mode + // configuration in an isolated process, without affecting parallel tests. + let directory = tempfile::tempdir().unwrap(); + let config = directory.path().join("openssl.cnf"); + fs::write(&config, gpapi::utils::openssl::openssl_conf()).unwrap(); + let status = std::process::Command::new(std::env::current_exe().unwrap()) + .args([ + "--exact", + "legacy_rc2_pkcs12_checks_password_and_archive_integrity", + "--nocapture", + ]) + .env("OPENSSL_CONF", config) + .env("GP_IDENTITY_LEGACY_TEST_CHILD", "1") + .status() + .unwrap(); + assert!(status.success()); + return; + } + check_archive("legacy-rc2.p12", PASSWORD); +} + +#[test] +fn invalid_certificate_and_private_key_data_are_rejected() { + let directory = tempfile::tempdir().unwrap(); + let invalid = directory.path().join("invalid.pem"); + fs::write(&invalid, b"not a certificate or private key").unwrap(); + assert!( + ClientIdentity::load( + invalid.to_str().unwrap(), + Some(fixture("rsa-pkcs8.pem").to_str().unwrap()), + None, + ) + .is_err() + ); + let error = ClientIdentity::load( + fixture("rsa-cert.pem").to_str().unwrap(), + Some(invalid.to_str().unwrap()), + None, + ) + .unwrap_err(); + assert!(matches!( + error.downcast_ref::(), + Some(RequestIdentityError::InvalidKey) + )); +} + +#[test] +fn pbes2_legacy_ciphers_remain_supported() { + for key in ["rsa-pbes2-des3-sha1.pem", "rsa-pbes2-des3-sha256.pem"] { + let identity = load("rsa-cert.pem", key, Some(PASSWORD)).unwrap(); + assert_eq!( + identity.key_data().unwrap(), + fs::read(fixture("rsa-pkcs8.pem")).unwrap() + ); + for (password, missing) in [(None, true), (Some("incorrect"), false)] { + let error = load("rsa-cert.pem", key, password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(missing), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(!missing), + other => panic!("{key}: unexpected error {other:?}"), + } + } + } +} + +#[test] +fn legacy_pkcs8_conversion_preserves_the_key_and_password_errors() { + let identity = load("rsa-cert.pem", "rsa-pbes1-3des.pem", Some(PASSWORD)).unwrap(); + assert_eq!( + identity.key_data().unwrap(), + fs::read(fixture("rsa-pkcs8.pem")).unwrap() + ); + assert!(identity.key_password().is_none()); + for (password, missing) in [(None, true), (Some("incorrect"), false)] { + let error = load("rsa-cert.pem", "rsa-pbes1-3des.pem", password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(missing), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(!missing), + other => panic!("unexpected legacy password error: {other:?}"), + } + } +} + +#[test] +#[cfg(not(target_os = "macos"))] +fn legacy_pkcs8_matches_previous_linux_openssl_processing() { + let encrypted = fs::read(fixture("rsa-pbes1-3des.pem")).unwrap(); + let previous = openssl::pkey::PKey::private_key_from_pem_passphrase(&encrypted, PASSWORD.as_bytes()) + .unwrap() + .private_key_to_pem_pkcs8() + .unwrap(); + let identity = load("rsa-cert.pem", "rsa-pbes1-3des.pem", Some(PASSWORD)).unwrap(); + assert_eq!(identity.key_data().unwrap(), previous); + assert!(openssl::pkey::PKey::private_key_from_pem_passphrase(&encrypted, b"incorrect").is_err()); +} + +#[test] +fn legacy_pkcs8_converter_failures_are_terminal_and_modern_keys_need_no_executable() { + use std::os::unix::fs::PermissionsExt; + + const CHILD: &str = "GP_LEGACY_CONVERTER_TEST"; + if let Ok(case) = std::env::var(CHILD) { + let started = std::time::Instant::now(); + let error = load("rsa-cert.pem", "rsa-pbes1-3des.pem", Some(PASSWORD)).unwrap_err(); + assert!( + started.elapsed() < std::time::Duration::from_secs(12), + "conversion exceeded its deadline" + ); + assert!( + matches!( + error.downcast_ref::(), + Some(RequestIdentityError::LegacyKeyConversion(_)) + ), + "{error:?}" + ); + let message = format!("{error:?}"); + assert!(message.contains("Convert the key to modern PKCS#8")); + assert!(!message.contains(PASSWORD)); + assert!(!message.contains("PRIVATE KEY")); + if case == "missing" { + assert!(message.contains("unavailable")); + } else if case.starts_with("timeout") { + assert!(message.contains("timed out")); + } + for key in ["rsa-pkcs8.pem", "rsa-pbes2-sha256.pem"] { + let identity = load("rsa-cert.pem", key, Some(PASSWORD)).unwrap(); + assert_eq!( + identity.key_data().unwrap(), + fs::read(fixture("rsa-pkcs8.pem")).unwrap() + ); + } + return; + } + + // PATH is process-global; isolate executable discovery from parallel tests. + for (case, script) in [ + ("missing", None), + ( + "unsupported", + Some("#!/bin/sh\nprintf 'unsupported: fixture-password PRIVATE KEY' >&2\nexit 1\n"), + ), + ("invalid-output", Some("#!/bin/sh\nprintf 'invalid converted key'\n")), + ("timeout-wrapper", Some("#!/bin/sh\n/bin/sleep 14\n")), + ("timeout-exited-wrapper", Some("#!/bin/sh\n/bin/sleep 14 &\nexit 0\n")), + ] { + let directory = tempfile::tempdir().unwrap(); + if let Some(script) = script { + let executable = directory.path().join("openssl"); + fs::write(&executable, script).unwrap(); + fs::set_permissions(executable, fs::Permissions::from_mode(0o700)).unwrap(); + } + let status = std::process::Command::new(std::env::current_exe().unwrap()) + .args([ + "--exact", + "legacy_pkcs8_converter_failures_are_terminal_and_modern_keys_need_no_executable", + "--nocapture", + ]) + .env("PATH", directory.path()) + .env(CHILD, case) + .status() + .unwrap(); + assert!(status.success(), "converter case: {case}"); + } +} + +#[test] +fn legacy_converter_reports_its_password_length_limit_without_requesting_a_retry() { + let password = "x".repeat(1024); + let encrypted = fs::read(fixture("rsa-pbes1-3des-password-1024.pem")).unwrap(); + // The previous linked API accepted this boundary. The CLI cannot carry it; + // report that limitation rather than calling the correct password wrong. + openssl::pkey::PKey::private_key_from_pem_passphrase(&encrypted, password.as_bytes()).unwrap(); + let error = load("rsa-cert.pem", "rsa-pbes1-3des-password-1024.pem", Some(&password)).unwrap_err(); + assert!( + matches!( + error.downcast_ref::(), + Some(RequestIdentityError::LegacyKeyConversion(_)) + ), + "{error:?}" + ); + assert!(error.to_string().contains("1023-byte")); + let accepted = load( + "rsa-cert.pem", + "rsa-pbes1-3des-password-1023.pem", + Some(&"x".repeat(1023)), + ) + .unwrap(); + assert_eq!( + accepted.key_data().unwrap(), + fs::read(fixture("rsa-pkcs8.pem")).unwrap() + ); +} + +#[test] +fn legacy_conversion_keeps_original_files_and_rejects_line_breaks_in_passwords() { + let original = fs::read(fixture("rsa-pbes1-3des.pem")).unwrap(); + for password in [ + PASSWORD, + "incorrect", + "password\nsecond line", + "password\r", + "password\0", + ] { + let result = load("rsa-cert.pem", "rsa-pbes1-3des.pem", Some(password)); + if password == PASSWORD { + result.unwrap(); + } else if password != "incorrect" { + assert!(matches!( + result.unwrap_err().downcast_ref::(), + Some(RequestIdentityError::LegacyKeyConversion(_)) + )); + } else { + assert!(matches!( + result.unwrap_err().downcast_ref::(), + Some(RequestIdentityError::DecryptError("PEM")) + )); + } + assert_eq!(fs::read(fixture("rsa-pbes1-3des.pem")).unwrap(), original); + } +} + +#[test] +fn first_key_selection_controls_password_prompt_and_ignores_later_keys() { + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("combined.pem"); + let certificate = fs::read(fixture("rsa-cert.pem")).unwrap(); + let plain = fs::read(fixture("rsa-pkcs8.pem")).unwrap(); + let encrypted = fs::read(fixture("rsa-pbes2-sha256.pem")).unwrap(); + for (first, second, needs_password) in [(&plain, &encrypted, false), (&encrypted, &plain, true)] { + let mut combined = certificate.clone(); + combined.extend(first); + combined.extend(second); + fs::write(&source, combined).unwrap(); + if needs_password { + let error = ClientIdentity::load(source.to_str().unwrap(), None, None).unwrap_err(); + assert!(matches!( + error.downcast_ref::(), + Some(RequestIdentityError::NoPassphrase("PEM")) + )); + } + let identity = ClientIdentity::load( + source.to_str().unwrap(), + None, + if needs_password { Some(PASSWORD) } else { None }, + ) + .unwrap(); + assert_eq!(identity.key_data().unwrap(), plain); + } +} + +#[test] +fn prepared_pem_round_trip_retains_snapshot_and_private_file_lifecycle() { + use std::os::unix::fs::PermissionsExt; + use zeroize::Zeroizing; + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("identity.pem"); + let mut combined = fs::read(fixture("rsa-cert.pem")).unwrap(); + combined.extend(fs::read(fixture("rsa-pkcs8.pem")).unwrap()); + fs::write(&source, combined).unwrap(); + let loaded = ClientIdentity::load(source.to_str().unwrap(), None, None).unwrap(); + let snapshot = ClientIdentity::from_data( + Zeroizing::new(loaded.certificate_data().to_vec()), + Some(Zeroizing::new(loaded.key_data().unwrap().to_vec())), + Some("unused-pem-password"), + ) + .unwrap(); + fs::write(&source, b"replaced after authentication").unwrap(); + drop(loaded); + let clone = snapshot.clone(); + drop(snapshot); + assert!(clone.key_password().is_none()); + let debug = format!("{clone:?}"); + assert!(debug.contains("")); + assert!(!debug.contains("PRIVATE KEY")); + assert!(!debug.contains("unused-pem-password")); + let files = clone.write_files(Some(directory.path())).unwrap(); + let certificate = PathBuf::from(files.certificate()); + let key = PathBuf::from(files.key().unwrap()); + for path in [&certificate, &key] { + assert_eq!(fs::metadata(path).unwrap().permissions().mode() & 0o777, 0o600); + } + assert_eq!(fs::read(&certificate).unwrap(), clone.certificate_data()); + assert_eq!(fs::read(&key).unwrap(), clone.key_data().unwrap()); + ClientIdentity::load(files.certificate(), files.key(), None).unwrap(); + drop(files); + assert!(!certificate.exists() && !key.exists()); +} + +#[test] +fn archive_snapshot_and_pfx_preserve_native_import_contract() { + use zeroize::Zeroizing; + let directory = tempfile::tempdir().unwrap(); + let path = directory.path().join("identity.pfx"); + let data = fs::read(fixture("modern.p12")).unwrap(); + fs::write(&path, &data).unwrap(); + let identity = ClientIdentity::load(path.to_str().unwrap(), Some("nonexistent-key"), Some(PASSWORD)).unwrap(); + fs::remove_file(path).unwrap(); + let restored = ClientIdentity::from_data( + Zeroizing::new(identity.certificate_data().to_vec()), + None, + identity.key_password(), + ) + .unwrap(); + assert_eq!(restored.certificate_data(), data); + assert_eq!(restored.key_password(), Some(PASSWORD)); + assert!(restored.key_data().is_none()); + assert!(!format!("{restored:?}").contains(PASSWORD)); + let empty = fs::read(fixture("empty-password.p12")).unwrap(); + // Preserve the native backend's existing empty-password decision. + let expected = reqwest::Identity::from_pkcs12_der(&empty, "").is_ok(); + assert_eq!( + ClientIdentity::from_data(Zeroizing::new(empty), None, Some("")).is_ok(), + expected + ); +} + +#[test] +fn malformed_certificate_der_and_private_key_der_are_rejected_without_secret_output() { + let directory = tempfile::tempdir().unwrap(); + let invalid = directory.path().join("invalid.pem"); + for (tag, invalid_certificate) in [("CERTIFICATE", true), ("PRIVATE KEY", false)] { + let invalid_der = b"secret-invalid-der-material"; + fs::write(&invalid, pem::encode(&pem::Pem::new(tag, invalid_der))).unwrap(); + let result = if invalid_certificate { + ClientIdentity::load( + invalid.to_str().unwrap(), + Some(fixture("rsa-pkcs8.pem").to_str().unwrap()), + None, + ) + } else { + ClientIdentity::load( + fixture("rsa-cert.pem").to_str().unwrap(), + Some(invalid.to_str().unwrap()), + None, + ) + }; + let error = result.unwrap_err(); + for message in [error.to_string(), format!("{error:?}")] { + assert!(!message.contains("secret-invalid-der-material")); + assert!(!message.contains("c2VjcmV0LWludmFsaWQtZGVyLW1hdGVyaWFs")); + } + } +} + +#[test] +fn pbes2_des_remains_supported_without_native_legacy_provider() { + let identity = load("rsa-cert.pem", "rsa-pbes2-des.pem", Some(PASSWORD)).unwrap(); + assert_eq!( + identity.key_data().unwrap(), + fs::read(fixture("rsa-pkcs8.pem")).unwrap() + ); + for (password, missing) in [(None, true), (Some("incorrect"), false)] { + let error = load("rsa-cert.pem", "rsa-pbes2-des.pem", password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(missing), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(!missing), + other => panic!("unexpected error {other:?}"), + } + } +} + +fn assert_unsupported_pbes2_algorithm(oid_der: &[u8]) { + let mut encrypted = pem::parse(fs::read(fixture("rsa-pbes2-sha256.pem")).unwrap()).unwrap(); + let mut der = encrypted.contents().to_vec(); + let matches: Vec<_> = der + .windows(oid_der.len()) + .enumerate() + .filter_map(|(offset, window)| (window == oid_der).then_some(offset)) + .collect(); + assert_eq!( + matches.len(), + 1, + "the fixture must contain exactly the intended algorithm OID" + ); + // An unknown OID in the same arc preserves ASN.1 structure and algorithm + // parameters, isolating algorithm recognition from malformed DER handling. + der[matches[0] + oid_der.len() - 1] = 0x7f; + encrypted = pem::Pem::new(encrypted.tag(), der); + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("unsupported.pem"); + fs::write(&source, pem::encode(&encrypted)).unwrap(); + for password in [None, Some(PASSWORD), Some("incorrect")] { + let error = ClientIdentity::load( + fixture("rsa-cert.pem").to_str().unwrap(), + Some(source.to_str().unwrap()), + password, + ) + .unwrap_err(); + assert!(matches!( + error.downcast_ref::(), + Some(RequestIdentityError::UnsupportedEncryption) + )); + let message = error.to_string().to_lowercase(); + assert!( + message.contains("unsupported") && message.contains("encryption"), + "{message}" + ); + } +} + +#[test] +fn unsupported_pbes2_kdf_is_identified_before_password_prompt() { + // PBKDF2, 1.2.840.113549.1.5.12. + assert_unsupported_pbes2_algorithm(&[0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x05, 0x0c]); +} + +#[test] +fn unsupported_pbes2_cipher_is_identified_before_password_prompt() { + // AES256-CBC, 2.16.840.1.101.3.4.1.42. + assert_unsupported_pbes2_algorithm(&[0x06, 0x09, 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x01, 0x2a]); +} + +#[test] +fn unsupported_pbes2_prf_is_identified_before_password_prompt() { + // HMAC-SHA256, 1.2.840.113549.2.9. + assert_unsupported_pbes2_algorithm(&[0x06, 0x08, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x09]); +} + +#[test] +fn malformed_encrypted_pkcs8_does_not_request_a_password_or_expose_material() { + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("malformed.pem"); + fs::write( + &source, + pem::encode(&pem::Pem::new( + "ENCRYPTED PRIVATE KEY", + b"secret-malformed-encrypted-key", + )), + ) + .unwrap(); + for password in [None, Some(PASSWORD), Some("incorrect")] { + let error = ClientIdentity::load( + fixture("rsa-cert.pem").to_str().unwrap(), + Some(source.to_str().unwrap()), + password, + ) + .unwrap_err(); + assert!(!matches!( + error.downcast_ref::(), + Some(RequestIdentityError::NoPassphrase(_) | RequestIdentityError::DecryptError(_)) + )); + for message in [error.to_string(), format!("{error:?}")] { + assert!(!message.contains("secret-malformed-encrypted-key")); + assert!(!message.contains("c2VjcmV0LW1hbGZvcm1lZC1lbmNyeXB0ZWQta2V5")); + } + } +} + +#[test] +fn mismatched_certificate_key_is_rejected_before_request_client_creation() { + let certificate = fs::read(fixture("root.pem")).unwrap(); + let key = fs::read(fixture("rsa-pkcs8.pem")).unwrap(); + let error = load("root.pem", "rsa-pkcs8.pem", None).unwrap_err(); + assert!( + error + .to_string() + .contains("Check that the private key matches the certificate") + ); + let error = ClientIdentity::from_data(certificate.into(), Some(key.into()), None).unwrap_err(); + assert!( + error + .to_string() + .contains("Check that the private key matches the certificate") + ); +} diff --git a/crates/gpapi/tests/files/client-identity/README.md b/crates/gpapi/tests/files/client-identity/README.md new file mode 100644 index 0000000..f61ca95 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/README.md @@ -0,0 +1,61 @@ +# Public client identity fixtures + +These generated keys and certificates are **public test data**, never production +credentials. Passwords are `fixture-password`, except `unicode-password.p12`, +which uses `pässword-密码`, and the `rsa-pbes1-3des-password-{1023,1024}.pem` +fixtures, which use `x` repeated the indicated number of bytes. + +Regenerate intentionally with OpenSSL 3: + +```sh +OPENSSL_BIN=/path/to/openssl bash generate.sh +``` + +Generation is random; it replaces the keys, certificates, and archives together. +The test runner reads checked-in files. Legacy standalone conversion tests +require an `openssl` executable on PATH (OpenSSL or compatible LibreSSL). +No fixture generation is needed to run the tests. + +| Files | Contents | +| --- | --- | +| `root.pem`, `rsa-cert.pem`, `ec-cert.pem` | Test root and issued RSA-2048 / P-256 client certificates, SHA256 signatures | +| `rsa-pkcs8.pem`, `ec-pkcs8.pem` | Plain PKCS#8 keys; expected normalized output | +| `rsa-pkcs1.pem`, `ec-sec1.pem` | Same keys in traditional containers | +| `{rsa,ec}-traditional-{aes128,aes192,aes256,des3}.pem` | Traditional encrypted PEM with AES-CBC or 3DES-CBC; password `fixture-password` | +| `rsa-pbes2-sha1.pem`, `rsa-pbes2-sha256.pem` | Encrypted PKCS#8, AES256-CBC/PBKDF2 with SHA1 or SHA256 PRF | +| `rsa-pbes2-aes-{128,192}-cbc-{sha1,sha256}.pem` | AES128/192-CBC with PBKDF2 SHA1/SHA256 | +| `rsa-pbes2-des3-{sha1,sha256}.pem` | PBES2 3DES-CBC with PBKDF2 SHA1/SHA256; distinct from the legacy PBE scheme handled by optional conversion | +| `rsa-pbes2-des.pem` | PBES2 DES-CBC/PBKDF2-SHA256; Rust processing requires no native legacy provider | +| `rsa-pbes2-scrypt.pem` | PBES2 AES256-CBC with scrypt | +| `rsa-pbes1-3des-password-{1023,1024}.pem` | Same legacy encryption with passwords at the CLI input boundary; the linked importer accepts 1024 bytes, while the converter reports its 1023-byte limit explicitly | +| `rsa-pbes1-3des.pem` | Legacy PKCS#12 SHA1/3DES scheme inside standalone encrypted PKCS#8; optional OpenSSL executable conversion case | +| `empty-password.p12` | RSA leaf/key/root with an empty password, preserving native backend acceptance | +| `ec-pbes2.pem` | Encrypted EC PKCS#8, AES256-CBC/PBKDF2-SHA256 | +| `modern.p12`, `unicode-password.p12` | Leaf/key/root, AES256-CBC/PBKDF2-SHA256, SHA256 MAC; RSA and EC respectively | +| `certificate-only.pfx`, `key-only.pfx` | Incomplete PKCS#12 archives: certificate without key, and key without certificate; password `fixture-password` | +| `legacy-rc2.p12` | Issue #437 case: RC2-40 certificate bags, SHA1/3DES key bag, SHA1 MAC | + +`tests/client_identity.rs` records native import compatibility and the owned +identity lifecycle. `tests/identity_encoding.rs` covers container normalization: +DER certificates and keys, RSA PKCS#1, Linux/BSD EC SEC1 and traditional encrypted +PEM, first-key selection, malformed encryption headers, and archive extension +capitalization. macOS rejects SEC1 and traditional encrypted PEM before password +handling. Its native importer also rejects the P-256 PKCS#8 PEM fixture, although +its native PKCS#12 import accepts the EC archive. Legacy-provider setup is isolated +in a child process on Linux/BSD. + +Standalone PKCS#8 PBE-SHA1-3DES uses optional OpenSSL executable conversion, +with missing/wrong passwords preserving the old Linux prompt/retry contract. +Other unsupported schemes retain explicit conversion guidance. PBES2 DES/3DES +use Rust processing and need no executable. Child-process tests isolate PATH +for absent/unsupported/stalled converters, invalid output, and secret-free errors. +Timeout coverage includes wrappers whose descendants retain pipes after the +wrapper exits or is killed; all pipe I/O shares the process deadline. +Linux/BSD additionally compare the result with the former linked OpenSSL importer. + +The tests check archive integrity by changing the UTF-16 friendly name without +changing the MAC, and compare normalized PEM output against the independent +checked-in plaintext key. Public integration tests cover first-key selection, +retained snapshots, private-file permissions and cleanup, `.pfx`, empty-password +backend behavior, and chain retention. Unit tests in `utils/request.rs` cover +missing keys, large local files, and native request-client construction. diff --git a/crates/gpapi/tests/files/client-identity/certificate-only.pfx b/crates/gpapi/tests/files/client-identity/certificate-only.pfx new file mode 100644 index 0000000000000000000000000000000000000000..73c9440931af2289c0d636e68fdb6c48045dfc46 GIT binary patch literal 1083 zcmXqLVlii8WHxAGe#*wF)#lOmotKfFaX}OFHI^pkOF-dsKzs@z#Rinx4HVkW#K-`o zHXvje4dUS(R$hZ3149It$3TTez_I>}i&cS6Mujm$_Jm^YqfAU33ZoR%lqPZV(FAK9?#D;G%-7@i47DMocQO#uD>aZbHrrN zNPFjLvL~7UlKC#vxVP};i3SBPlW!6m_NhijUs^q@Kr>df`{QRz^&`jTyy*MC=cnvJ z-mG?Y^L#CyUFvo6<{MtyUy{1@-L&+ihvuIT8G&Mw2L%1Uu2K5Z_Cxl)H-n&~$lZGq zx9uyYPEK6GAraR-ohfc+8*3ADdw!<6Yo5N_m+)JuZYb-cy~$_kJ$XK3BeVLNfo^gC$`WBc@kR3f&HMZ+E!0dCX76KDK7L8AH1M6r)kW`L6x_Bv>K7lqOO`c#<*kDf6(YAj z-_O0&<@1J3NboHxth*A9XKiPJh{{*%Q3HNRFbh##^ z7?SmJ@vE#e&$V84$g_XzNMbv6b#ZU`!~&BK&W(F27v4FcvFSqJ@5G4UdnG)}kG|&W zo2GPx=h!;4`UB_MY~#C^i?%+nnXzYo&*%JqjEgp1{8u8`Y+@nMIOWl=>)MAGm(Lf_ z^7}VwPgV!R+wc<2b*E)tW!ySra_iOEn|4gBQIC7)PfW6TD8s&8d3~$0MbhO(X$b=R zuV_x2`^8shS$iPUEYn}g%QGFe>@VzC*E6sEM9-zHt&?~E&|GrhLGj^T=YN?geSY*I z*sFTq#m5Qf{Iyj+7fb%E$S;4xs@1wvYr}Sx-(maKxAHy6et)`sp7lgc+3RZ(R{njO zrJ(vsTy0z-;kUgUSyUSi;BU}(S#&t^=FtPCs)cGn($%U|Rt zdaE(ouy>Eb@^^?emh=*=^Yo`>XmEf$}Z@Fn{jc literal 0 HcmV?d00001 diff --git a/crates/gpapi/tests/files/client-identity/ec-cert.pem b/crates/gpapi/tests/files/client-identity/ec-cert.pem new file mode 100644 index 0000000..902e124 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-cert.pem @@ -0,0 +1,14 @@ +-----BEGIN CERTIFICATE----- +MIICMDCCARigAwIBAgIBCjANBgkqhkiG9w0BAQsFADAgMR4wHAYDVQQDDBVHUCBJ +ZGVudGl0eSBUZXN0IFJvb3QwHhcNMjYxMDE3MTQxNzM0WhcNMzYxMDE0MTQxNzM0 +WjAeMRwwGgYDVQQDDBNHUCBJZGVudGl0eSBUZXN0IGVjMFkwEwYHKoZIzj0CAQYI +KoZIzj0DAQcDQgAEQm/MjfzelUwWBxNReuqsrrLfBs1ygHeqX6NXBCLWyRWqTI/q +BIwba6G3zcnZaArnCw+XsMsBvTtphuiDHouPW6NCMEAwHQYDVR0OBBYEFGySvrUf +Wg99yhlvRHe5VcdQV+6sMB8GA1UdIwQYMBaAFNxaJz5kx8+buL1L+wnHUfOmNKDR +MA0GCSqGSIb3DQEBCwUAA4IBAQCT4yKBspPRj66lz7y1KjMh0Ju/rVtBlE4pVtbb +BYGi29kKVwJyv1GnzKGsbiW7YFEvcBiQFiPV1veab4UR90ESm/SUFXCzwhCkCkQr +sYO/tDSyh4vO9zstpN6524lhnEhNqhxrDjwlbHov9Ycsk7nchR2ZXYe7NPF2SZQ3 +j+NWgOAGHk+xveyfev1sQV8oYn4WL550D0DfCDIVc2n7UdQ2MPw/fvNd1hI6uBUl +BrYV+BKeeghn7p7NsesfXqVIuXYbgJ7GFwNh3s3Kdx3p1DQZ37f4P3reSBc7i03+ +9GmRlPj62a8GnxXFoCcfH4HHp6LkUptZTtHkgyVbsS1Uayj1 +-----END CERTIFICATE----- diff --git a/crates/gpapi/tests/files/client-identity/ec-pbes2.pem b/crates/gpapi/tests/files/client-identity/ec-pbes2.pem new file mode 100644 index 0000000..2196d17 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-pbes2.pem @@ -0,0 +1,8 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIH0MF8GCSqGSIb3DQEFDTBSMDEGCSqGSIb3DQEFDDAkBBBP0Qie1d771HAwIaHr +16KPAgIIADAMBggqhkiG9w0CCQUAMB0GCWCGSAFlAwQBKgQQJKzM5wh1ay4NLYmy +CL43wQSBkLXODq5G55naOF0acp52yJseQ/gpFxKweaqh+dbErhComdC1WW6X1m3x +yQZTSGkn9BXXovKbpNPgPbPb7Oks1TEQU33RMi6t89tbZHj757yEY0b+WPpH5Y1g +JUE/r2kqpdki7oz5d38R0j7eD1sG/cOvpnkq1jVzp32wRp3cKugLOWx/dC45AhzP +X1ZAbDubOg== +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/ec-pkcs8.pem b/crates/gpapi/tests/files/client-identity/ec-pkcs8.pem new file mode 100644 index 0000000..bfb2f64 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-pkcs8.pem @@ -0,0 +1,5 @@ +-----BEGIN PRIVATE KEY----- +MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgwiAZclkH//xmntM5 +q9LIH7sus8oUbh5BnwXHHfRtPNShRANCAARCb8yN/N6VTBYHE1F66qyust8GzXKA +d6pfo1cEItbJFapMj+oEjBtrobfNydloCucLD5ewywG9O2mG6IMei49b +-----END PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/ec-sec1.pem b/crates/gpapi/tests/files/client-identity/ec-sec1.pem new file mode 100644 index 0000000..e422e3a --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-sec1.pem @@ -0,0 +1,5 @@ +-----BEGIN EC PRIVATE KEY----- +MHcCAQEEIMIgGXJZB//8Zp7TOavSyB+7LrPKFG4eQZ8Fxx30bTzUoAoGCCqGSM49 +AwEHoUQDQgAEQm/MjfzelUwWBxNReuqsrrLfBs1ygHeqX6NXBCLWyRWqTI/qBIwb +a6G3zcnZaArnCw+XsMsBvTtphuiDHouPWw== +-----END EC PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/ec-traditional-aes128.pem b/crates/gpapi/tests/files/client-identity/ec-traditional-aes128.pem new file mode 100644 index 0000000..14780a0 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-traditional-aes128.pem @@ -0,0 +1,8 @@ +-----BEGIN EC PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-128-CBC,EDBB75FE8E4A9290FC3447531722071E + +sg0ogRPLzqBeQztwc20ZPqnuQp/2Lv9a1oqY0SLcWm+z0WXVehUSvOVj6vxBCvuX +TVzLYA4q6eEIyaCMEzIFLN/A39gmjBhWZK7+amp0orDuFBHoEbAcUJnGpAglj75f +lsKGNAfn5p1WEbB2MFFI6WwKgMFDGvKqK1Dw3crQk8s= +-----END EC PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/ec-traditional-aes192.pem b/crates/gpapi/tests/files/client-identity/ec-traditional-aes192.pem new file mode 100644 index 0000000..d1e268d --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-traditional-aes192.pem @@ -0,0 +1,8 @@ +-----BEGIN EC PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-192-CBC,DBD38A287B2D983EF72D8314BE8AA5C3 + +m/fzWalU1WmEf76dMsUktNG1Jo/Fvd2hKlaGB0/ITNd/tZuVf6pvz4c8+MhJ7dZ5 +FPVCe/P8crwM9D4beq8TvUq51U2jfy1iejGU9z9lMsXiutpKIOAsG4iSv0FeZALq +cCuZ7tpw1LkIZTfRBoFkQmqYN7oZHtwP7+oGbEDNr5E= +-----END EC PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/ec-traditional-aes256.pem b/crates/gpapi/tests/files/client-identity/ec-traditional-aes256.pem new file mode 100644 index 0000000..d45f7c4 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-traditional-aes256.pem @@ -0,0 +1,8 @@ +-----BEGIN EC PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-256-CBC,5105F89A3448CA69E8C9784A9876D6F8 + +FkTcZ+6JtBHQHimcNXHOYiRI8s3n7lMXuss97oBQvqA/duUT2oItEQbQ548uJol2 +Xqs0uMKY5H0tvZPUoD9zOWCMIlip7Yj0n5eF5sXU+Nx3aGQHWLmroDA84iCagXRy +4YGFRiZsgC2GAOGapTcR62jCyIMYgqyJgUyq3JJWtPA= +-----END EC PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/ec-traditional-des3.pem b/crates/gpapi/tests/files/client-identity/ec-traditional-des3.pem new file mode 100644 index 0000000..6a2a2c2 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/ec-traditional-des3.pem @@ -0,0 +1,8 @@ +-----BEGIN EC PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: DES-EDE3-CBC,C4ABB907B69450C1 + +4KvcHjy6UN2l0uf5dPwSrEn8eG4aqvUP0wTUazeqmZ0wFYm3BxNX+Ml44SYXk7rC +BKWAFGGjE19I+Y8FiwiIUTx3Jq3sV0/zLROPcw2fv3IxtOjWbnJEppOBrgPfg2Zq +FxSQq/C6TyARgxb7muzGFiCD5uuuZthlr3yobSu2jJw= +-----END EC PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/empty-password.p12 b/crates/gpapi/tests/files/client-identity/empty-password.p12 new file mode 100644 index 0000000000000000000000000000000000000000..f7d45c335d57e7cbdaeec6e7907f0d8ffc4633a5 GIT binary patch literal 3418 zcmai%XE+;*7si7GvDMzIGQLFw^VXA+Mjg*A4XdCw({u5(9zpE&75W8M6 z+*nj_v>E7NUEN&z81>kKoMC~bv_1_a-n0osR5IKjhfFl=y^$+#p)BnuAB|v$FL0h&*v2oP3OzVW- zPvA$PFmW!AB`fJHbw^(>w>a_nr5G#{y&6lKonGK8+CLZI_ zHS;#xYijZ_)~glA5%>iCKX$x9#RYHa!dx*lwz% zxDu(g5?HPf^J;5bau>bvnjjS%A`&0_dCoF*WA!7fM#0?eGcI&R*h&Z|XC?35g*UCx zZYcN|2Vd5cKsTJJG3*YoDhFC82d#OaS*VMAZ!6$j4is^M{8Q#f3X&~ zi(RL*(ztBi-fW*^%$F5nqRi4%b0;0BZfPhiC65LWZ!8PK`Ug+`;0u~ITcHZgqcNw} zjR??I0zH#)3nCB1a5A68pFw86aw5*Qo)kuPgiRqek*J5#KeNQ#tCv)zniH7d4Jab-}K?DXh=<8de)}7a!>{D2vD*n=~yMxB2o*UZI z#B%=S5t~)Ab*}v!+>(T6 zZvTuG9`7(EK)3n5#);-RR$$|hXRG&_Gh1w>LP>MG=REF9DqW5HD~%Q`fz@^;ms(u7 zwowG|%A>1>%`b!yHL>X}&*KJurC;kDeM5YLY1I1^T)nR;irUGq6fql^yHo zvFCA&xqm1Uee2R5vBmC8>+v(z;3tzlcw;&=Y;A??fH$ppKJDlB4=6ddiBH?_qx$$X zyOw3SV6o~e+@_N|Jt0>+8au8B4Cc+XUFg^FPCzW4$%IS-2A28%vv~9qth^ zXVt-BMd2FY8;!W0)2-i!_;J$hSqb{Pvo%^r3`)%G6I?%j)uSl3nMNx(wRhn<8Va8K zsAHC-f=3%o(qLXe^3#Kn&QCEnie=1(xdDSWWe-(PW^P>+A;N}R$LMtvQBbKZ<) zUwoc@&&%JABlvZVcEqFZNM2NRfM_)0U9p!F0>oWp0^`mObi>tp7bWTDX?+*>GSVT% z*uoOcH+Y3}-te7!Fx-`?^ss8yT#Qd_(mY;Bad447s}-%uMtJtW-tTk@l%;3OJ(JUX;1iJMnhsqzKpfbvXD`OQf&I5EzBm>P1>tsOZe{RwDFSc^7`u0TQZyt zGm&ZLmS4uY%VlbX;SjMbyK{uGlAmc4MApTpqQPX1?q#iUr$u36G@oob(UeA22*9R2 zoN~hbr4IP6jJ#(I(X*tv6M)J8{={rGTfM-CFDMx>6A>T^!KZB?iv9U#XPJVsy@P{T zOxF{b@!Ftb|K=9=K_U8aHGA)|vfNRuR=0d}ad9t;5znn4&7T|Wx%Zb}uV%!1)I$-V zs((267g#|>Km;iNx19aE(kW^GW-c8K8ToHh?YF4(Um)GP3}CT7dz^*$74R>&GY0%8 zNQduv!72xgBx@L|glB)|7XlGLykrQYxrIP3ZDhvXrredr4QOHtWntE^J&ls?-o`tK zx4fC|Z3kXxx$`UdnMT2)s#P|Z$JD0>h)$}f^H+0Mq_;#shb{x?`~7k`DBH{nDR*$1 z9R-82Zq!ij^~C^JkLfm1-Lqv=8(8gaseABMBA-z|@#eC3&rjR2%xkjg<|Qg}O;|_! z&|ENVzUcZM>O1Pj^I#TMxYwVc*0%`(lymiJgi97YzTPEze&M7v+w&OgTQmxv9iHCn zNwF<4%d6*m+Qko#^LM*zCd>kVn}hVs1Eb1ZZ~ST-AvubD9r{9?}zAX zYb#w#&e}uIA~h28TZI}+zfLTiPL%%gP|~QnDyobgS!K?AIe*bNSbHk#IFbYODL%o3 zQOV3JQo(OyAC!N4Pu;?C7nD;!+Y%Q{D%glIYPZf#x>G~THdob+-DjSXwX+Q9!2T?d zcm9zCkO^C*^{Ydo8qWK}BV3pU0sDN-Qx1f4_;>*f>$-F>$8l>g94X!IS(fgKYn6ET zfy?xc$=a#Lw!g2Pw6F~zS<3U%pmL3d3?)?-qgOi?_}--`k9%|7{uj9Rn?80r;YyHt{ zGwN74iE^>3y!Cxj=WbmaTHup=dmbwXeN8Q^L_oVGX7pPZLqkhUu~rGH`E9;Y^q(= zHtLpyBX29+ewt`p15l+N_eg+ee!;nBW7ofR1mZ~avMNxqW~cY-_t|wPF!W>FZ!X>r zVL*Ov2)*8SvOSzQJ!p* zZItpj+>0hUxcjQx8+qY~tIXC4aRv{LQrkpa_-h=-;H{mJAAPk3ZciSvCez*M@=9TJ zz}uvix=B%2Jdsbrhdo&Ik?z)!dOo>BT9hXswO-#AG#T>~He)`(o%s#jyvged@j5Qf zsuEm$`qKJ?N2W!;#W9HqRnlI3ZTGpR-K!sxJV5aeS4GIJTz1@lMHarwM0P7OqJ!2g z7#ZJ`5KIhlL9SM^sY=)?L2SE4+4YDJ>jiEKhpESOp|&E2iJ9wK?fhXNFaHMS3)%c- zs~MjteR0+Lq{lM+P$D}?8`c_#TzE3g{nKRQ8xZ4_opJ+MUtku3bZfzQ#0109H zQLEfu7uir)!(k|7V?T29ZL96KE`{mv!MeE`&*!|`_EyH=qqYdCw@Z+hjkyiagn8wT zJN{^;mec#|d-yv|!K`vj{0snhfF~dX5C{kY_ygRaBLCWKa_m6Xrrq_^!M<2>$YnWz z$M0)-MM94l^cGYOO8?InLQVz(00k8phXY40Oc3`fpNNP`XjAy@7VVK?Bxv?A3pTnR b)YE}XVJAlOVKyWDM>o*0*dmntUy1xb@k(A@ literal 0 HcmV?d00001 diff --git a/crates/gpapi/tests/files/client-identity/generate.sh b/crates/gpapi/tests/files/client-identity/generate.sh new file mode 100644 index 0000000..5ee1607 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/generate.sh @@ -0,0 +1,77 @@ +#!/usr/bin/env bash +# Public test identities only. Run with OpenSSL 3; no production credentials. +set -euo pipefail +cd "$(dirname "$0")" +openssl_bin=${OPENSSL_BIN:-openssl} +scratch=$(mktemp -d) +trap 'rm -rf "$scratch"' EXIT + +"$openssl_bin" req -x509 -newkey rsa:2048 -noenc -sha256 -days 3650 \ + -subj '/CN=GP Identity Test Root' -addext 'basicConstraints=critical,CA:TRUE' \ + -keyout "$scratch/root.key" -out root.pem +"$openssl_bin" genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -out rsa-pkcs8.pem +"$openssl_bin" genpkey -algorithm EC -pkeyopt ec_paramgen_curve:P-256 -out ec-pkcs8.pem +for algorithm in rsa ec; do + "$openssl_bin" req -new -key "$algorithm-pkcs8.pem" -subj "/CN=GP Identity Test $algorithm" \ + -out "$scratch/$algorithm.csr" + "$openssl_bin" x509 -req -in "$scratch/$algorithm.csr" -CA root.pem -CAkey "$scratch/root.key" \ + -set_serial 10 -days 3650 -sha256 -out "$algorithm-cert.pem" +done +"$openssl_bin" rsa -in rsa-pkcs8.pem -traditional -out rsa-pkcs1.pem +"$openssl_bin" ec -in ec-pkcs8.pem -out ec-sec1.pem +for cipher in aes128 aes192 aes256 des3; do + "$openssl_bin" rsa -in rsa-pkcs8.pem -traditional -"$cipher" \ + -passout pass:fixture-password -out "rsa-traditional-$cipher.pem" + "$openssl_bin" ec -in ec-pkcs8.pem -"$cipher" \ + -passout pass:fixture-password -out "ec-traditional-$cipher.pem" +done +for prf in sha1 sha256; do + if [[ "$prf" == sha1 ]]; then + prf_name=hmacWithSHA1 + else + prf_name=hmacWithSHA256 + fi + "$openssl_bin" pkcs8 -topk8 -in rsa-pkcs8.pem -v2 aes-256-cbc -v2prf "$prf_name" \ + -passout pass:fixture-password -out "rsa-pbes2-$prf.pem" +done +for cipher in aes-128-cbc aes-192-cbc des3; do + for prf in sha1 sha256; do + if [[ "$prf" == sha1 ]]; then + prf_name=hmacWithSHA1 + else + prf_name=hmacWithSHA256 + fi + "$openssl_bin" pkcs8 -topk8 -in rsa-pkcs8.pem -v2 "$cipher" -v2prf "$prf_name" \ + -passout pass:fixture-password -out "rsa-pbes2-$cipher-$prf.pem" + done +done +"$openssl_bin" pkcs8 -topk8 -in rsa-pkcs8.pem -scrypt -v2 aes-256-cbc \ + -passout pass:fixture-password -out rsa-pbes2-scrypt.pem +"$openssl_bin" pkcs8 -topk8 -in rsa-pkcs8.pem -v1 PBE-SHA1-3DES \ + -passout pass:fixture-password -out rsa-pbes1-3des.pem +for length in 1023 1024; do + printf -v password '%*s' "$length" '' + password=${password// /x} + "$openssl_bin" pkcs8 -topk8 -in rsa-pkcs8.pem -v1 PBE-SHA1-3DES \ + -passout "pass:$password" -out "rsa-pbes1-3des-password-$length.pem" +done +"$openssl_bin" pkcs8 -topk8 -in ec-pkcs8.pem -v2 aes-256-cbc \ + -passout pass:fixture-password -out ec-pbes2.pem +"$openssl_bin" pkcs12 -export -inkey rsa-pkcs8.pem -in rsa-cert.pem -certfile root.pem \ + -name fixture -passout pass:fixture-password -out modern.p12 +"$openssl_bin" pkcs12 -export -legacy -inkey rsa-pkcs8.pem -in rsa-cert.pem -certfile root.pem \ + -keypbe PBE-SHA1-3DES -certpbe PBE-SHA1-RC2-40 -macalg SHA1 \ + -name fixture -passout pass:fixture-password -out legacy-rc2.p12 +"$openssl_bin" pkcs12 -export -inkey ec-pkcs8.pem -in ec-cert.pem -certfile root.pem \ + -name fixture -passout 'pass:pässword-密码' -out unicode-password.p12 +"$openssl_bin" pkcs12 -export -inkey rsa-pkcs8.pem -in rsa-cert.pem -certfile root.pem \ + -name fixture -passout pass: -out empty-password.p12 +# DES requires the legacy provider in OpenSSL 3, unlike PBES2 3DES. +"$openssl_bin" pkcs8 -provider default -provider legacy -topk8 -in rsa-pkcs8.pem \ + -v2 des-cbc -v2prf hmacWithSHA256 -passout pass:fixture-password -out rsa-pbes2-des.pem + +# Incomplete identity archives exercise validation before native TLS import. +"$openssl_bin" pkcs12 -export -nokeys -in rsa-cert.pem \ + -name fixture -passout pass:fixture-password -out certificate-only.pfx +"$openssl_bin" pkcs12 -export -nocerts -inkey rsa-pkcs8.pem \ + -name fixture -passout pass:fixture-password -out key-only.pfx diff --git a/crates/gpapi/tests/files/client-identity/key-only.pfx b/crates/gpapi/tests/files/client-identity/key-only.pfx new file mode 100644 index 0000000000000000000000000000000000000000..7214e18e9d00f7574b77ed22e30c7494e9ab1236 GIT binary patch literal 1527 zcmV+thDZTr0|Wso1Q3(Dwj?gqTnE`+`J`07kK6=;1ke&HG`jM$xdO)G$(Z7d z=rUuKBi-Myw3t_@pbpf>pL0>ld)rWr7{OGy#qSp;nQg!H!H$-2Z?^*F-xu%>>X0hY~cNBBDgJVGAc%0|yR#)|cN57^8Fu zA>Eu&1hV)qInk{i)()N?fqGawJUXEAv<5_CZrYvu%`e4}Jrn3`sgUtB6_hw8gZhH# zgy7*`P4trCC4Fm6f;DS~l0x$C)RoitWmW0AWRkHn8LtT6hX<-hcP2ZuMNK>`YhJ9% z;6fxOjqN){rs0adU-mU^-`t}=IJ7f*!>^tbTy?O#UsxfZ)*V;$Ro5wFI2nCFom|~- z>*>}Nhu zais*z4eWu*>9$&t>%AxZ%>?CY#);69a%=E_?Km2I zKZbZG+UMRD@k^^04W{)V!aJ5e{B55xQ4a%CE83WOC7VGV+*OToAp9JmaSZl8WE#$E zDMw5$C0M0Az!w*FhV72=CGkdfPt`rky$EkYouNEjijISstGW^C3l5H?eiv8dKnXAg z)N#bEBy_P~IeFa%?CSB$>%JzqyEIx1HqR{x$@H8#VmYriGXX)Lkk@3V@d2Z$u8yv< z6=zB1hnJx`2$mT*VK8jX!a(-v6*0q|sjPJ# z;kc(L<25N~t}PV@FXzOWd_iN)P?kQYb*Y(;QbZ6m$N>pvvuuuzwuvHI0rf@O-L&OF zeM)gorFEbq#)3=MY?coWn`ycu#UXOBI90XrTu^f0v+gVcpmL|{KQ27{*c?U_re z2ZmDq1y99y%~zm;$H+W`KxUNhmh#vW5^GjSQVEsXg4*k`#Q;w%mDqW`qhgPYZ{13Q zdK9&Y4B9;cI3n?4!zg?s-T%(?n<(*e%iQSY_(e*)i&);2EiHQXz#O}TuETkl=%Kw$ zL|~3|Ihvw5%TmHG7fvNAId{j6|DLf()}p~-7n#T?!JF3OFbdjfh^Wa_Ia{~Be)fMo z_ht%XO(Ds-WX~dRAf3}V>}~gv>FCxT<739{f;=CPC8bUxs^x{wu0CEQ4jd+yh6Ixt zD!%{?-rbo({l>vl-zLFpqZlBD30|mch`XagJcH5Qez}muh;bXeOcgLo4R$2}wh`39 zeDm{6x-+GtjBd~c3dq{qVRlV| zKAlK3$YDD8BaN-3^0ikz7t_)YrS>BQR@Ps>3mu#K)>^MuHeMK*2DPd9EG{#q0*wW>zuvsX^GNVVoO-K->Oi(@!HC;gOJFQQ#i5`2n^R#SVtiYP8&L}1|jA-L;?@Wy`6!Q8xkZRK9D?HtQ zWEx1EE?LFw7v39jGu^r69gVPhVixeI(7}M3tA6*`@~BQjverP?l&EB^WcO{)U>Cy7sc zUa((({*N__BQ>d!N&COp=+r0=)@?|{L!5-5(*5FdayGJ9X+>`dC$H_nYRZfKeJmDJW^&6vqRF$s&MP?uz-lSyMR5rEX zraEsHM&U{@{Xpt`?NL-mEjbVJp+95Ag2kJ|w_sr;TwzR7Z{sboeu3g#s6FvU1gh`j zZ)zWd%U@LEE%K~wgzil^bkz;1e@bszePI_7CenvtOP>*DDx&bJ)~+2oFq%Bw^;p=j z_QfoO*04VlmtQzi98cn5JygJSp;cM7lE$QcLM-Ry<+mTsS{6U4Pc4YenxJSK$i1W2 zgBedPTog+r6|D+BqaV^S1(!RppF|E93GtpzQOPe#kE9VCx*RB|4U?EPDr4HL2Y<-z z2Kui<<5^d5^o;DaYNJK|gCV-vT*2ThmpOLW&F!CrX@qU;L)Rsa7{_6x z_SxaPz}yReS}`z z;X=%3Pc4X%Gu|$GFQpWBDUb^p1diZlJ{<{x1^2y@!seg$*c;ZP_Z2u*YmXCNl?h5Y z`NMWo2-jSL`wX_uQ_)%$Y%|HW_S<5k+qp7w6S|aEYir>CgD0Z#Dh_f^YWW7`!478+ zecaJZa^_j8<{xZ>JJvjpIuB51fWznJ#;L&4U7!%}Q3u}x7?);y`1oLu@EsoQ3?12k zO3qS1m?N?9t!w{10OHLY#S65mu>jl5^}0NtW>$%_7Fpwxlh|)l@3+IYp0QBeuK$Xr zD(rEY?+xDt&6xBZ4PEy(|0K}Q|WrH+bxD3X(00YpN0orcT^x>8zD>^W*YFHDizPQW9wV?;P zutJ7L*m}0G?B7X)kQ~oGRMtrnSdE6!dTz#^xp64eOu|baZ62Pw<6*;E)=Qj?YJE&i~m~#K(wzOY!TgJzqP+5EQ7l^N3 z@cwauu;G*^h`VuM)Ev8~P#m9kC^`D~4|fWxXv!pUC~ z1M}29x|W<6*R=Lh1~8h>9z@RGyK?`es@eSUUGcX)CR~r3g}r`?zt*4TFd*lwG!v|2 z&G_2CB~(#zDK=jP}2Lq1zW|-zG!y?T|V>O_00>= zt;w5-JSaAwb;lPJsWnw3bIrXCNj9+RP*ll^6z1B|_!pUG;pT_@dyZAGUZL+s`fre&#wb;U7A{oR?+~xdq#X7oH^j);3;6~3P5W-xz3(yrl5UHlv}0y<>7<) zYH-^Wo>>SZz*p_BHVrE)ee^8OR*=a45hT8YtJf>>o8wEE#yCg|KB*%bppKl$WCumN zAIfe#uPd-I8(lQy4dxC#h2m7LxePv7I*X|Pn`=|5BYrbdxb8M4%JwkND+xk7@--n$ z+ly;ufq^G;v_9fdD{h_;g8~^N-U)o*TE^&l&s(^b z_Yj$E1=a4EZ<8FeL|kMe+rUA-v|w(p zn?)>5U3xFhl%+`9Sx<*@kX{0=9b_s<_0xc_KauW0Co!tY^G@NvS< zXX4Vnc^q}LH&gr5r>APfn*7j7MaFMaXs%)3ysSyG$cQ&ue`NBt^I$iB0XlZI+O^jd z_S?}F6LlF@`0UwHOr)NM0M2s1w@12T^z%}`m~(kWDf>wCr_`|O!LoAfn_yqAMqrJ+ zPi$4t7ZV~)6H>`M5pXEmtDgz*su!*?_v$^Llp^P5WFTp?tRS=xlA;ExD^$?XJE-w> zub+0qQil5B2x=2Q)3t|<#&WuFNk-PE9t@wa%?qjojn48mA?VB98v?kZ8?DMNyhR`X zPSLCmoSoWW<%Vy#s(D8znrumpDO*5-3R^7Z!%f|bKEGqWXl2&NDxxZC+lU2;*5qxz zag7Ax0RD4O66)nWBkZRM=>wwb@s0?|*>j9Vq{sq5k{&mWP$rTd$P2!--ZlAx9ou1s z*AXZqHm@!cqxtMt}M^s$dr( zTz*UorD()=a7^J{J4q5*c{Q3?;fSb)m3^|BV4D;&N7e7mJ@&3=uW`Q4;1QNGHO-e* z?ReDBxH`7M#l)mrL!=j+1K4#cp;&t5!Yxc=io|8taGrjD z$$AWLZKqm)G3vr2swbx(U?v^hbk2EBXT1@u7sy#=I*J~}NhqD=P~U3XQXT^Z%skdj z%er$mEKZe!<30oThEvJJmKGcu14g`{&Se#5t(y68MZ1M@yDqW;e`=oA88A>JD)|5s z|G|=h-m>e}%`%6Wmar7cU8E(~Ua=bE3A3Pxue&)=;(_bItWl|LMbFJ=>2h}67%fb@;w|jjr4pMK* zr^&zHd3oIq+`?&`O%rO7Gg&%59u3B_BMPOlN%s!{0wH?pEL6U)ypekuw_Bk<-O9J0 z&c@%8YwLZO2UWWs+3NEBW6$@~JKZ-fLD;1=k=*}XM=BO+1|B+q3*bH=0PqOl3-AUw zBL)7!e@U}KSYGWcANPES28sNx1aNw7RaV7!Adm`3J|q>CLW~X!f>Qt>EHs`vLKoat m?qP9rlJ&`U=|j-SYzV`X+G=2&tW?A@>NkF$wfWWGWBM=Sp$n@3 literal 0 HcmV?d00001 diff --git a/crates/gpapi/tests/files/client-identity/modern.p12 b/crates/gpapi/tests/files/client-identity/modern.p12 new file mode 100644 index 0000000000000000000000000000000000000000..6d2a2560deda8cec71b56133f2f1fe29073d72da GIT binary patch literal 3418 zcmai%S2P?77lmh-F+}e*qQ&S&j}ax&d+!rQ7c~Sy)R9p`T+yOLzk2T?2%<$7M(<^a z-a@oLcl~$W`*0v1U%s?;XjFi5MVZn=nRA+I)b5y z_FyOo{ND&K8wKJ0Z9#E>fZvPd-vkJ={6~O^VR|s3e>=Kifmtrx$zYY?T(4EZ z2nj`>{gCGGiWbzvti@myUvE)`7qt4dA~mwbJw=%;6dn~95rguQ^2&-&z~5idZQfQ!tEQeOspM$G+6>#VO1+kj##o28qhh(1dD=LQzq~+db$sFEvaiD&`1M*i654LeMfuA zC!*G-3Ls784i+(B$}@mMz-TY<*juY5^gGY%)1c>>PViqtuev1!_0V-DbB9hVjfQu> z1l4XMjGAS%H~7x$MMUX#)9QVTl+K7YU-chwk{s0dV#8(!M4RzAsKqNZ8`p=YWY?|s znAMC^2Wk=KbocBISRHFs?XCMs=W~vrwgYqRgv68sA4p){fUd(XiXh9u1WM<%LWT3o zu)OzA)HO)3X}p$8DcOUHB7M+Q*q)jo+HMoiDxJJHlyhv;ZN^JqW5W{K1{G7fi7qnvqT3;{m<0G~%3TUVxJJ(9W(&3Xker|lh^ibQgF4m!Sk8qm0)Md%F-426O)$@@x zKeT?4CRb8VLTfZ&DZihm{mJQ4wWQl*i~n(e_H9xsewYYPg68`^`+D;jYnHSbFkRMh z5-K^T(68tO>fEcSI;|fV-K+PRxEVfqBQiRo_r=*y*V2gB^d`U0)LP~(PuSMU=d|oV zw-+BndYv5HB*j0uY#HzMCaCX!Gp#AeweDqWV{(jRjT?PNnm@;}8F`#ZdQ_LyMP()N zedEoM(N+n2f$1o%S+L+MWsh*%@jW?T+ zIc>uL;)*1A><${h`$*W$Zf?#=Mxr!u=oWid21h{1*iV5vWz>TkM_dW~z&z_$inkPf zmMbbF6ErT-Z#)-J#LqB1Q=QRFV@>FJWtj$m2ArHf3EBr;E=wZH!b^sxEDYE^IcKL3I)2 zF=lHQR@il?3|S>|UTTq$aJ!CRjtQ5BW=bbE1Smi!wXt&7+lo7&4sgWVWvt4RVZ=J8{OJDo#a9kb#gQ ziQNQncUtf_uDfSF-OC?jGfX<0k=RAKO@`KxYP3Hn;KO<1OsSyUPiY;1WE4&Anx4E) z>5iGFyn^b~SZNWP6O^+NeZfb5A_-kchZ;T*-}qd&dYV(DKouYP=G>*m8AYx$5EUoj zahcy!!x1h!+Jf<9!!?+2bL#~t%E1{Jg&$FV17?d6Oxvp#I z4yz^k>4KPQw`0r=qZ?icbIg;;XJ}_JHc$}(BgYeO+kYU2(Vc@#MzC#YkmU<)7OX(V zx&&c>7eF_UL!D>xG%muhXGMu^!=iG=aTC?P>#CkS>`$rO@u zf!6T{&OVI_XJK);XT#_=zfhNcCjS7w$Qi){C~Sn0PckxOyYh<=qJKsY8k=xGo?c06(eAhG1SOJhZY0r{58TPUEk0$yf~=QYJIBgo+TPDbNz6jsFn>o}y;%D_bFV@GSbL{W1L6Dw8PFSsyb;k7k zEGKC1U3bImJt(CZ^(GNag1O1Ykxcs~&&^$%s~E?~AFUh`vJc)iq9n^3lXIPxw>$|8 zI9@8?$5$w)GR^4lAh$e#-IAGJn~Q^_T3#>!bOdfs&wHc@_T$y6dVhfUk}n_JTEgOE zCV5vX+y2G6t!uEf5%y$*|M5c&p&TcQY$4=2wcg7!aLK+9i81tDWSHqYp=3~ zwGbU|@Y{M_pEI3}k!@*kdc&c3-R~`?4I`zj#6>w?n4YzHzuNBa&Nk}MF69qSC~m)L zadJef{7iW&H9EK6@} z7hbY1f7RoEkIEtv>QS6=3&-7Q>fqPEiidMUX+fUaH-@47K!Yx+A zmO{?|AZIv;VIIHKeB9_n1}`ti^JPfsxtr4(MhH3bRw!%s+-6MWF}6q8ow1Uyqbf1k z=z#mEM4x$D!@LXEQv9+7fs_YaXg=Ii z%{_ND2-Sa`HsP%|7O?1_+!v-mnO)2}8cr=nJs()wJ36DF?U-boIUK|DK8NF_`1fKV zg}>Uv-`|vgN{Eb^1Yi$%4)6td0lWd806Q4_zcIBC4T!3KZ|$fnT_!h~SN|FjSsAQ%8*F}Ju+K`wJ_d6@bjhHi+^!go^_IV(^>6<;PUo8|RP1w?js Wx){4m)o1D5ymG2%=ZgO8BmWO=Gd|h? literal 0 HcmV?d00001 diff --git a/crates/gpapi/tests/files/client-identity/root.pem b/crates/gpapi/tests/files/client-identity/root.pem new file mode 100644 index 0000000..fdc8e08 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/root.pem @@ -0,0 +1,19 @@ +-----BEGIN CERTIFICATE----- +MIIDADCCAeigAwIBAgIUch4EHQx2jG1SVy93ALCnjWiZz1cwDQYJKoZIhvcNAQEL +BQAwIDEeMBwGA1UEAwwVR1AgSWRlbnRpdHkgVGVzdCBSb290MB4XDTI2MTAxNzE0 +MTczNFoXDTM2MTAxNDE0MTczNFowIDEeMBwGA1UEAwwVR1AgSWRlbnRpdHkgVGVz +dCBSb290MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAorjY7yd+KUlM +afkNbdRn8JyJnD/C/blSOcT4qghiGiFrEF3hUvui1bkZSF4CwkyO/d/DVlf5RE57 ++mSlK/0omDptJifR10NExqNq5pFPYZ+Do7Y75w4NyyPj759ruUTonpm7EFYqQOc8 +N/QiFfanisQ5D1CO2PwVBe7aKodAgihq6C8SmBKCBRR9m8HDmtckmKnQWNczxOBh +7BbAx4WxiQSHxIrt3woSps1QfEHcYTZhPKD7EDRGEMryBvYdI2dtIjVQwRJ4t/r+ +9sQeK5fJVNYxVjpdtqMJCLT4INBzIKaPKy2R1geWy5a1Zn6EJ1uIx3f6H0NU02Cr +Rj5sN3Yw7wIDAQABozIwMDAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBTcWic+ +ZMfPm7i9S/sJx1HzpjSg0TANBgkqhkiG9w0BAQsFAAOCAQEAoHAmAMuG4joVReqb +81rOQScHfai6lwBVKXsC5lJj/ptfk8n252TObO9s2beOl6mYPs4nMRmq8NIc2ezA +CvlndpQhgHhesTIvZGVG43/4Zy3YrzbMSfrYOdlKe6rlIvVbZcMkRIyUbUFVkDO3 +QjNfOHXMNGCV+2K+/1moru0OkU8fvla1m2b2N6FZIS5q62SVm9HSppqTj/nWS4kD +q987vf177vX0qTLWM7YchI+N7IzQyNLElfajJ7SiCBNCz5AggYuwEPmVXdnrdlCe +XP7P4t/tZqch0ZpkOvCK2glTNIc+4PHvZ7aNANvaR08QXmSKiwbWX8X9EMdFia7c +VvQVDQ== +-----END CERTIFICATE----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-cert.pem b/crates/gpapi/tests/files/client-identity/rsa-cert.pem new file mode 100644 index 0000000..31aa93e --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-cert.pem @@ -0,0 +1,18 @@ +-----BEGIN CERTIFICATE----- +MIIC/DCCAeSgAwIBAgIBCjANBgkqhkiG9w0BAQsFADAgMR4wHAYDVQQDDBVHUCBJ +ZGVudGl0eSBUZXN0IFJvb3QwHhcNMjYxMDE3MTQxNzM0WhcNMzYxMDE0MTQxNzM0 +WjAfMR0wGwYDVQQDDBRHUCBJZGVudGl0eSBUZXN0IHJzYTCCASIwDQYJKoZIhvcN +AQEBBQADggEPADCCAQoCggEBAN3VB3+IqFOlVY6OF/A9OqVqP0BzoIq5sWvR9mxW +BHyvU5KZG/Xp7a2OF+OOE4jRzPdLgKq31k8tYgwYy6C31jVgUemDyBOwuudiBEcG +0DZ6gGEtE4uyPnFqJQGgBg9HW8uY/Ie0+6+95F6lpjn0ARqum3Hr/+N/oslACPFM +1uJTkVCwaviLFUYjb3Ox6wUTRVtVLEph2Iw3525VfuI9BKQw4NZ51wESpCjXvEB2 +8+CO2k3UB9egMdaez+Sl85vbP1bWjcYbz1fEDWz8gGK+YhvoPL6nsLOEIXEeY53x +aW3z9Tlb3CSmEeYdZuwXv1cQGrIihTHpWjWQ2wJ7MJJ/1ocCAwEAAaNCMEAwHQYD +VR0OBBYEFD9xPMh2lH691o/ln18HGnmKxdkwMB8GA1UdIwQYMBaAFNxaJz5kx8+b +uL1L+wnHUfOmNKDRMA0GCSqGSIb3DQEBCwUAA4IBAQA4Zwzc5QqTaTqzf6TT3IjA +3g24dOffu6EOkAg2gtp9cJLtC7cyTKBMTK8vGX7PlNR7cjBP0VgmRSyWMGcCXSpz +1eXKHHVbgCj6+9lPRAm9Ahwpcewg0s5BAMS1lEpOEbYtgHBuz302oBNXYS7MGaeO +h88rJPhrkZyFqosZ9G7/EPiKladhmeS5IaMsageD4aBZyRInt1ehSaQqxFGyDKk1 +jOuGffOKlVqTBADC5U4rj9d12SGxgKb353vhjzQ1ceBm2P6FiKcmhHHYn1WrQtot +En0FWqACC2ZekQ6sQm2ZRx9SYlKd6fWnJ4+7IsH5+wgsApub0eHGEutECIN9Za5o +-----END CERTIFICATE----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1023.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1023.pem new file mode 100644 index 0000000..4786dc4 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1023.pem @@ -0,0 +1,29 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIE6jAcBgoqhkiG9w0BDAEDMA4ECLOZZqD+VLtQAgIIAASCBMiGiqam4dNtVdxD +KpskK3iDnYL00TNXKNeHM/vwsJp1J9l1oIUq9ftWd3hFucd3tfTBIyE3BB6tCxDh +D3EJWeIvgIfsKLCX7vB4GJhUTBA4zVwKgdvr61RYpwd2MfJYXN3d3u0BkUDhyoSz +lTheKH4Ip+/GG3jpyq2pbDjHTBEFW7b3JuM3nvnC6hDiVXtjFhfGKWwa/sOpfmyf +20Nj0RGP0eIlVz9XGXuZ23VWk8u9oF3rVY18qRThyNSCPJG+qAgyuKioKqw1MOKZ +1RjD1kiDwSnz+aDDSI8y5/XE883Nawd3Gvi3SyZXd4FWwd6G49zoPdyJsODZt04G +DzdT0jeaCaPNkGO1xoZ2VVmlRhC7sB3Bf69kKsZOryLMuKGm9CLDWH78i6TjoQV+ +oVJjna1liFcw9ws1sZxagNsr1JxPuOTzNk9hzgBKl5LUUloIL1nhhyUzoA8M4BPt +0Cc/b4yrs2pTgyozC+xGQZt7crxSg70VYgfHL0Jx5wM1+5SFBKHxhsYojl0uD2uI +PIjtm26agFkw4QXvh/vUKuuu4LBQLrrdN91UX5ovcQ2r1SmG0AFNoQtvx2C8pMjx +tEKngF5Uk+rL8zv6v0Hl7J2yU+LIF2LsgSBLYXpEzQNmakZvDa0Ib74ZOfGbMLmd +ZuUIIH0eqzSXwkrrjQ2SFAzlAg9vgq/93MWLTpBN3gifR3R5xHq1i/GYkWCPVGEL +HFuE1w6oZAWrxm/p6HFlSJYc+d6PoMRFSUQObi2Ta/tH0KjsKNLwv36PEvER/teN +6ks6/f8aADQDTw+xi/SCM7rIOHas14b6QE/ILVmXpFitbFpe7c0YDKo5Cm/viO68 +eqqchWJX5PUVI7gAthmCDtKX4SBmImsdxsBl1zr28FVQsP62A0m91XxRjrIABABe +IuuV/9WSd5wHJ4Elh0OW+uYw3vFvfxIRBjKbD610Se0ZDLL+PbKQHXK8Mm+NmBdi +LkXNyHo0asrmQYSdQWYPnglmrQZpfuOKQUNipsagQvd/q0KpE1YK+UGtzPFWf9Nv +DkyZTb6qG3jAMNNP9kWe+i03e1YGW7HB0I9ac4CPFG/FxDfDk3o6tt8fT3y/Aa6z +HHOP5C+GtaNcG8BWTkzwEwYlyu496Tw+C2K+PWQ4zdw/kBLjkP3/8yKnFDQMoeRL +eHX+Aho9OHioXe3gX7Ya+Bgp/8koarW0XsPIRyMCQ5x4oRtYp+sIPf6BJ1a3WvM2 +owhTo2/DC7kWnAbJBGpodKeydwM7lYFsrTv+JsjbtyqDP7z++G8dhCDTXvgzFZKg +N7d5HqwCYkmmneNFMNntgvivdWjQvrb6H4jexWF5FIpoLUCW5EO6dVyRsC4d3A6j +PC5GKCh4fZB+LhfIYGkrzLDx0iaAKWv16as+fHSY8vDBFhUFed6INsMlHNEuOEpX +GtM1QzGta4GbVNVue7XIRjiY/XPzQ1RmZPwOCzBi03PFwbt7zti13v0oQs49W7Yh +5E+yu7PQPKxr1WbmmU8e0U5NF0bkPsFVauUKFCOC164nEn0zGZRSyFL54O7+lF+b +zAPRM0zYEVbCkkQsF87ToGwPRY9LoNikP14MV1npujkWIK1wZ/eysBACDCdW8mxR +X2ONO70h8TsO1R6KS5Y= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1024.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1024.pem new file mode 100644 index 0000000..a5b04b5 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des-password-1024.pem @@ -0,0 +1,29 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIE6jAcBgoqhkiG9w0BDAEDMA4ECOIH1TuPOHfxAgIIAASCBMgcv+kci9FRoLjr +zYevFdoYS66/aUAy0V/173CuRMb1hzwsxfXeoRzTgXaWXUOExJX2PSCIai2cwCcj +SvZUXPSQz+9aWrZjO/R+tWfKW0ttmT6Et2Kfps6MkJpRK/jbmaYOISpNa/8ROCty +A7P6f4KNFeRhU89TgLqegm+so4un7d/n9vwYQBC1oCaRuCvxuNIugbnVKJkJ2RMx +e7JLk16HVox8UGb66knS5kvaFVZZzJasmxN/tLg9kyomzopOMQZJ5E5uLD2CyndV +Wh8OTwHbH6MOGOfhSi7eETWaveUvR9CMfm5YwTLM9RJHGlhl6J0NO8eZBd+IyA08 +jP2UYtLo2Lgx0ZobAUCfx9ZWFmQH//wnOyyiU4HzmIrUVUFPj2LsnYUyypAl54lp +hFLf0P5oPFdNc1GfYEW7REBrJilj+4R1ycY1jw2o/WYntJUyFSYJ4rUXadzpv7el +BGvbob04atktipdFF7Y/OfcOk0kuf/BdLNchayUYAHMNv8V+BB7c2EuiHA4Rg5sv +J6egzKEpyJmdhvAWiEZavDpr0mz0KjZQVSGDmZ//ZWWponR/8vWhT2HRjFd6UAeP +YFAnH+Hk8JlsGKcsrQMybECQTsyGNnUDlAZhu6doiWPGnT+27l7iyNGCoxCXw7Nd +PXXMkPk6vFakvS4pe10jgNn+nV8K6w1yK8mOcA0yzaSx4vM0H4WU1k3wGhkGLzAp +qStyAMLeR5vC8ZEOslj+5UchBpKCgROz2TuHDerHRJOw/CTECKP/LitXkYgjH4Z8 +6PgPNDhQhScVDsy6xvt5TayWckfqVsCUtfzcfN7xxYsfLlMHxkV5m8guFpcZNpbi +87/k/xeL1UaFXxWGf4l8yWL2t1Td29PAF6Tb24ly3XLnsTcapJ4WCfdq5Pou5IAE +PsoBex6XhKv5O8zzBZJKW0KWhvQTevpW3qLnb9jmr7NuCnSEAgsjF+K2HTDWJXb5 +FUwoDYZXkonoI8PD/df5RvyuhzwwUz7KwFpZ0gGpEKT11JYFTk+f/9UrYSdGrvf5 +wEepxJBYnPc028JZKnOkLptGp75DE/KIXCfPY5sG72AQfFekAf1gXFL9zWyRYnxg +HhDSHUZsZze6U5tcrqtpUNagu/F/RXaDWBvnntiQNEM2zwtjgakBb/oDVZ5x+7Sc +hTqN51MfsTTRAdqKJWMY/BZGkW0E2NF8/mPF/JdQcyeb4edSbyO/ZNlnS9xx4OGu +ZmoYMWW//fFhFc62Q4zR4f/C7o0WgkXgu8mitjCxZ4JInJGqyLwHKdLW6Dka3Yig +Cw88bpV4G2RwyvVNP7RyPiabHClrfZzhhHq2Qltawr08RZmBKX1S0EepH6p6125G +Bbd2lSL5NS4g3VN70/pcdBSYbiTCL6Cmbxii14CPk1d+nnm6+RwrrcNkjjbqVQpM +GlRfu807yjAHqAqwa45DEeFufGPY2bX1BjEWsw4l6tgI0nEmaKRurfcv6Ns0SeD/ +1t+ondPjd6QUIo0fdUkU/2O99QpI8r0nORa8Df98nSIkzgfC+G/WXLonJ2EWVGUR +3hIXf2x/vFSVnH2gIHlP3vUjQv7igw8igoNBy6iCwxzvH0DKu998qZ+w9KWPJMfv +7gRfkOUwSwgzBYFu/2g= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des.pem new file mode 100644 index 0000000..273bbe8 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes1-3des.pem @@ -0,0 +1,29 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIE6jAcBgoqhkiG9w0BDAEDMA4ECDtyfmLnGHYhAgIIAASCBMhHyOEtS/9MoAGa +wi1/ZFn4Ol6kT4XT2u4xG1UrxloDY+OhhgsBWudpbbJmjRvKBSE/YQCtzMWnEEUu +B2PjaGvsaFBFC9rmN3jqTJ5nJO5DUVOIALePywt92ALLgt8BH2os6okPI6ggAdb8 +D4EeBd8NGMnbx6a6H80udbOJVAALtcrqu/dfB2V9ERX3Qu5aICpqDb1nstu3IENg +qS2n2iF3tRelCMfuBTKgh2yDrGq1BLhda8SMQDAZeEAMAcjPHot7/L/JRq+QWtOT +shSTljSq2VfXdRTyfAeuhkVBUaIvFXMtE+W3zaJb1TF0xSwhUVUp+Aq4XitfX5qt +A+JqZKPwQdJMja8U3YhWKmciegP0Idr3G9ImbKsesUC5pzRZYZ2VYDJVbniIxyLD +MbMgKTgQvdVyiz2jrikdw0dK7BEx5aOX2VrtShY95NoA92Dpe17uyCLdT/23zuKp +BoyS3OqFzMVnt2MTsDrwaCfIhRh/XI3+m7ZH+e+9ofzsS9FqQRBXcK2MGInhNcXn +fkzLBG3WhUCvxCc3J4AYyDg3eXPeg+Vb0cSMXtmbRmA155ZvKO5AwDc6cw0WrOPt +lpXZkF+ioedxuDFqg3iFJPDS75pUHO7IXvpAOOdywbqgpXeE2Ckmg0dCINJ8v+r3 +UCJ8HpH951Vv403WisWDeZO6Ho9a1V6ppj7qzCAMtwrpHHnB6C3WApfVUPFOVyVE +84ZFeZBAgV0B4stXXx2Q8mF2RtVGMMwajuAJaSyUOwF5sXmM79UuEkjx1gwTwEbw +kkkLbAngfW4zGgtwnS4uIP3IqebifLWOhyjJ1NIxO01yJAYuoQRNUnAh1cExiz4S +K81yYbIrnyTWHgPkPiypqjdZI6j8GxxQCO0X8YdI2iz/E+c0az4VBJ2akD/rSyC3 +wIridvEt0G7RWuoovQt9xQItASfOX35HAXbrn33rILEz/lqN2U0jY07Pir+IHT5T +7xECfjmD/4GUVqf/tBl59h80x6oO2rB2FpbMxjESHk9pRjBbBamLB43mZBBnZzed +SY8QtCjxWdmn5sajANFiSTO/h80hZ91C28vCkbuBLR4NyakiCFE79CTp2iLGcLdT +RTqMD3FJM84dRPu4UrD0LRcyi2qE/gawKTj2KeBFHlDrKZlYCY/uQ6y690motqPH +SRcmxBmZwcXKoGRT6ec8ozS6C1YEyxzd0yxdnoB111HQkFArx7kZpC4P3irdg+Sw +RYcSpxODXwS8lWoSK8UFi4k7t+E+7VLTBEC1EsuUYKksy1g2qQyHUbFb/jjOmexD +sfnZnr/g7/F/FQqRrW1NZbjd0k6o/LgvZL1JaYKdGvJ8lkxlY4WISmYrtKWOvsts +V8wiQ6oTOrZf+oDxjYGfOwPC9QmajoY7k2Vusez2ttQQisW4GDdx49AVrvJ4QmWb +oGxB9viYbgkDbD95vDSqgfUJ9bsIKe8Qn1yx6hR/s+GscS9AtmoajSsUGsO2E2ev +05lD6EJmK47M0i/h5WnRVX3oA4CPFN0cNB5F2tNHWTntMw/x5uycWSPzxsp2QTJD +VfZKgxxrnP9Gm7pDwYfIOA+LY7AEih0x3qB+YhSiPKwOpae88IziBnsrUJHEpAQh +Ve5OtXnZeBcxz/5Ilhg= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha1.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha1.pem new file mode 100644 index 0000000..ae97a38 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha1.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFJzBRBgkqhkiG9w0BBQ0wRDAjBgkqhkiG9w0BBQwwFgQQft6DBWIbHgpjlxNy +okK36AICCAAwHQYJYIZIAWUDBAECBBA2isANf7/e55ARv/6IU4JpBIIE0CDVlFD1 +k402g/2yIShzDS3UBeHanmtvUDxfmX0wWVnqBcXKmGFaY8NJGGRXh+1OJFMuxeST +VPAePwNOWA0dqEl889KP/3zJE+/YCtwru1P1DETWAXTQNsXCJmUw++SMcrz+FyV9 +4Ouli5s6CXMDUb7BAcQDjyhMdEqIuvf6CLoUSfBXuy5yUNBOakzL79tGGt5+D5QE +C5cdsFSzF8Ft8uOFHh785fdL7tHRJJHZfqdVi6oXLtdqPmoAHXo3YBSClmfBA6q8 +djXEqSSjyqWcVy6KEpb/dJSmMYXOwbY76M+yK4IdBOkRg2eHLLN22T4YAgMFHIo5 +S5WP7tNr5RguD2VPOEZKkf44POBdooHweS8fagmLTd9XELafCBaSlIUv5sSTkjuG +Ck6g0SCOdkO/qlBur2j/zAoidW9dnsC5TKM4GBNLpnkgo5KQ53AeFbQhcIEo2RM7 +qMnpKdD3/WJ5vlgsOX36+WpGc0qxkBx7LDlR4PIlpZTAJAl/LjKUAfWjlpnrw4K+ +tdQ3+C5Ukhms83o0jXFDw9gPc2xlYD6CssZB9JlvjUx3JOBS3LsK2XTzjic7Ur3/ +3bceXWsowpiVzAIgI4ExPlf/igQRZKlEnI7fG1zgDV08jf/KD/x9ynJZBnhvXRdm +ycEaTrNQJGqxVRWyCkQIx3TC/wgXfwq0wxDjZBl/nxe3s/1aHEhlhXMsYhpX0djd +tJF+Ep6SuyTerdh4iRZ3KqnbfFyLlRFe35ZAgTP6gqhAc5UgSAmjWfghY4O98SuA +wPhYxDcR76r6waLXL1PXc01g2eYrnVK6Mo95H+cFdyR8ATZ1UV6QHv6AwbYJfY1H +W0E3scCjVwFzpNbA9Ds7XcWJ346vFfkHI3GrJT2/K1LqseYhcSZRf2AOgQZXOhwn +tHIddX7MhtiLXEApSviYtJXipwT1ljphuDVy/eMMJEL6vLOZ3QLTOghqdKJjX3LJ +eJcpvD3f2TGBAH5sArnOerYh2rXl4qkivOhQmnxMNdGkXQzYyNijrcLqFzdrJ5Dd +oqfjTuqcvi4VgQ/lhYokPmBJZ5MzCPx5igqMQVUxURXlJE2cslm0JwIcFTTt0+Sy +HRU4xNby2x6WnLbNcyyaaTnFKErm5FbDZ1z+OvOL2W6AuWvDIvKLfZ2gjSYYYm7y +aDe/LuGJ/qJhxAhmSNDjaSXISote7U2sVcXxY/YmHGHkp4L7DSxKr5l+oUeV2L+9 +IzFWUQJdPj7NgejJsI1434mul7VZQp0aO7aE3rPjw9InhH3PO7XBT3yc7mRZtSE1 +reRr++mkBuEaIIezSv3f8+wBOmplb0/u1XGAEEjL9+GjjvX3m5RAnz3lKKuOAJhn +arZJe35qpmToPNDkIQ4mvkUxwPP3y7Wi17gMjcle6SVd9ptmx79DxkxSZ+E65a3N +aGskitbLzPubHfq3QNPU7Pt6LBN0L0TtMIeMAgAJmabyhJCdx9/18NU2duUU2DLQ +yReUCgwXQ5ieTO4HSvucEjPRGAVKOgzffpCBXaYnnbjOZSsf3kYCvFdaxDaachH/ +4ArQ3mDmziXMQ4hx/8sEIf4pIUpet1DlRbAj57EPIB1Ku8XLOSkVVZbPkAxJMnAC +Ae4pr90Xgcku0Jw+x+W5b7KM9dBcMkhAWdSA +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha256.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha256.pem new file mode 100644 index 0000000..3774dcd --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-128-cbc-sha256.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFNTBfBgkqhkiG9w0BBQ0wUjAxBgkqhkiG9w0BBQwwJAQQUMDHiJimtHsFhgkH +/eKmgQICCAAwDAYIKoZIhvcNAgkFADAdBglghkgBZQMEAQIEEECRU4yQy19B5dms +VIJMoJUEggTQ/hSTxuPKqqWJkgDE3oklGg9RlISVR47O0lHQVhg3zE9Bq70oj7wq +E+ilG+1wIfzj6alsPgVQz18nC+61bc4nrTT8dzPap9PnciUtbv4eyMQl8KHYv3M3 +9K+J5GxaMKRzLZi9U8Vqr7JHK+PA/SMGnhyjUFt98Ine3kD8fQUXRG7ZabAAiCuD +F71wz//JqNYnq/hOuB0il2vOryCSLegROSyjlnzn86+SonSuWQ1fQy8yciFSlgqE +Qn5gqturXRM7JM8HnoOAvN3TLOAxqErveUUMNevrAZtgbXVXcOu5pv8NDFoZmbqR +IetXmIRispeotDLAN5ZJ23jRFN4wUNwgPC+YoGopZ+qGyl4XwtRNhE7vYByV2ix0 +XXOQvvtyTPT4qigB/Axbo16eT3ZuBEtdOtd5XLqpjhw5BrkTgv4CCmOmRQPaTd3G +US6kVesAXECEVc7jEwibPlHeN7SDhvE9S7QbzkBnmq1+u6NkjEDmS2K8WfSI/Xzz +/BFC8SHKvoalmIfhxVERF8hrnzB1+Iy55JnUzmRSDCYzSPZ3NYcLQOYSBH11RH/A +RapaPrKmjYVT7J0Ymggy01Yv8CzcbaPRWSaQ9i2TIzrbtvOln7NrUc0yJ+aeuU6O +B/fNrDN+PtAje1iqX6yJzigUT7H5V0MEaYLTRtcEKA+dBA7vNUklX4A8/QPLEx84 +6sZ6c9aRzb2OYX31xTcNvR7OMsGnJXhNEX44ZkXcjFCUBC9dMUBSKhyN4NMbZjMk ++LTNHOuSA9t9YR8aIhzkVJKv0LhdJYYB/25DnOli62J/etiZGu+7l5Xyd3mkyasI +sOompL5tjfQH2jQeTfwntWZjBPHOxWvPontJmzTJhnuv+N1thMtpTmAJ/XWnvLKT +n85xmtIiqCkoSK0U3TKs2iJBB+DhvEEceBUBPQdetFQOa1cks0qhoSiLdIFuvolR +vkTTYvYgs+JXAtbM8ftF9zyO1dugEQC6P4a5C9aOYX1CVHYoFAR/U/rJMOruQ5Vp +IvxZ9ew23I/qFmZMH+71be1zGqDGNAlE8OPRxJ1qnQXHsx79ea5omeY8zlQ6OXI1 +JbTHdGs/by1k7xQqH2JBp8ZPkHmMxYgmyPO8eI1+igFLdNVsoWdDLWYAOkeFRXJb +kcJhwUAOsLTcWiztpG8b1xwTTDgdnmNA84uZQ5S/9dlDvZP1YAh41FNWSa0n6VIZ +2Ba0/wz6+1jACaYSkkR13rbwSJKMhOT1b/WmD0mts0P9URXKaNoCVJ3l6xSt3Gzu +intZbmDUTSmzWQS5rlrn3Yv5ST97ZlJXpSnn+hpAFCFtkvFaJncw6gXD+mxlQyO4 +o/GJlyxNwiwY+gQk04wFkm3gVgXRJW4X7dlDhstbaajjS1coTIwK8OyQhN59cAAh +6KbMNpglSst4PGLcsMg9ksYlswBR4EpAwqpXansxyIlD7GqV8NgmRpW2n10wXEcH +LkL/Rlq6Z3h3SHVoGbSZBmLmoQeEgBEIXrSpZG/35GqDv7/Nzkqc3nVJVmCJm6Kk +IgjwzgjM7jVcd9mZGM7M+7ZImBr3dnlSv/HbtIGbEsI9ATEnXhsNB4q3tWFGmRJf +b6br/ec69POUVBPWS6XRx+YvAKz96cGtzb81Aa3aoa3Qu+D6/wWXC7s= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha1.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha1.pem new file mode 100644 index 0000000..cac664d --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha1.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFJzBRBgkqhkiG9w0BBQ0wRDAjBgkqhkiG9w0BBQwwFgQQZ/Awu/UgqU7guQ0o +iUbVJQICCAAwHQYJYIZIAWUDBAEWBBCZv8MLB6vhKR9lbtkDUru5BIIE0L0CIxIL +G7qAmJ1dK2yUlZ5uH9k58ApCYz/xxFcyB4H6xRgumORe38WOKH76UqO4az8B0X+N +tkftkOjG4sXtizKIqT2krJtEBH0SZKleylz8TzdZuVD13/dloEoouhR4vIxjPQcT +UeAso21Nobc5o8gTevZutpu8JBmK0mkVc8aKHQVLgR0LXMFsBbcTa8QKgWKhc21w +OtxM1XPfvYxHJ6EwPSJBJrt2Ri3bBAUprO4vysmfuCvHgyIhjJKC8AY2ugfOBVmI +YotJgbqrxXVEsfEdTHHTdYSN21zpELWlGi1dWBbJiYA5o7pCc7vF4OYOgOO3ci58 +zLdnMUUYE77qrwM+SfYbKFDxFElbiCxeG2nlmRzqSCmZmEWIZmGiNItqbt5cxrZs +Ef4omAPI0uUy2wfey/9moflVS28GY/7NjKFeMuGZ1od+ixml4qGXssYyt8UfvzDb ++p6dGvFPBUyAVtmwpPjUU5g9mYrupMUB/BAWhazSL/DDTH/9Zynl0co+/AszTUvN +ufHHvcndUA7el42OylMbycZlVla2ZdCVsuNexIfr/9TlFpINqxKmKyWlaYvHXju/ +T6DCItC/ADvmaa0j6Aw8FPf/ArPPFp9a7N6y93WcCp07Ydm5U07cm82biLF6qida +sj7YEj0qUxLXtDSgYzFvywmiB86MpryxnvQXoaZN53gWWeSzZhpRWghBsnWxgIco +zenjxiS45nnwRXby4mXpPpNpWVnC0YaTvN1tPvHaM+dAUkxa6BA9xU/uXatofr28 +zM6YldvNOR99fsuk3zRvPQm0Pj3jszUG48kWXsAgZ/w8AVDiIq0GFm46QDNxm6QL +RuTl04MajnskNpj0i6nqs3s8ooBbhYfd+dKUyVAzpLByshewuMniCdVvPGdn8HXP +bYbFvMHlD+7sQoFJ4990TwsdCBPjwqbFo1mGbieCL/okncqU7QCOrGWhwFYIy7Wt +4VIAwVqkh7tVG56te0C1hJj4V7rWzVNw12Y4/NlkQBWvZlrGCVLelBLF3vX6/R1c +OlG+wTuUNswBbnBZzcprjvU4XaeufU0ntsiAgXt4sFTRWwmHZTMf9lHT4GVkVH+3 +ugMtiL+ePdcWcGYmhPFg1m4atveSoMB0m3vkUJDF/KMDiQaC52FwhXr/G/2wU+GE +G6HmnK60AsucXqolZgWjizID/t5DRhIicFfqx8a9Ik6g+qrZoPMzrfIqjsUKIeXN +uCvMICHJ+mFy0riFZCOrZMggBregYXdV+mrCpcV18lxCmri+vYXaiY2NaVhcUJOL +R/OJiQeWuK4kCQvWnj3YiN9kbUHGfFHH56oeMKbcv+oOha2/ATe7/XlhH3LOYXp9 ++DOqP+wVlSPQZ7rGCubI+Msc1Zpx/PoyN/VnXDs8A2H5bMUv8+RdAUkzSe3KoMWi +KKrB7MbombXrhc7l9dK5vCU5YWAES3c20XzzqZ+SNBUBeFubmfVwdpQXge7sUHAP +kh9Yyyc78ruwZrPE4x0d0mQmdYbWK6fqAO0VWuF6YrRfGaPBUFbHEXCVk5YBc4+O +biLmxV/POGF6L0VLlaXnkpMk6qIUpILmoS5FQaz8KLetlAPd5pQuhkOmnaBYGeTE +d78fn68IHzmRw/wdyd7/f3I/74vO0HcFFy01 +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha256.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha256.pem new file mode 100644 index 0000000..8cc8616 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-aes-192-cbc-sha256.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFNTBfBgkqhkiG9w0BBQ0wUjAxBgkqhkiG9w0BBQwwJAQQmMpdf0SW+0mImHRc +f+sCfQICCAAwDAYIKoZIhvcNAgkFADAdBglghkgBZQMEARYEEOsN895q1a1mGbHO +Kxzey60EggTQGHNs2taO3LNbjDhdj9T8JuMXNcoWqpLIIf0OQypqrTA4yXm1KZT2 +lQ2X8WqTZwSy2qHknDJtVGGaZ7UTQ62eATzqSnh7qU6207h8oLQo5n+V6L/Gt271 +nCeVp6G8h40Pj2qf8vPnXnRHTaZCT9mXKhcxyk3yI+6p7ufAepXADl8vYvPwHQQK +ay1ojyR4ZgRwJx5rqf/1DzFI6zUJ1DUuCsiq6WwdYutX2SbZrY8AsBrov4HXdDfm +ifOVCJgES7leBBKMk3TqLPpkcWPjT55ek6CUJDbc1eO7L1vMyNSYbtAnMLW//0wV +phwYn1p+IgZAFRLKgalE2tWAJYu5v425pgFLqALpGfOsL5np88pP4r0ozrRzX0Sc +VhpFUsOFxbyVj5AQUZBYtKpoE8IoxlPaQOYagoDbfN2QbIgjnn41i54YWMx4QrTi +O/oAT5sRaj5AcPxX29Nq1RExA2KNd3mmiB9/CXjG0VxwxOAi+NX9FRz35Ny7JOaM +JeH2ljudiE+p725A0AN1Dpw7xNAqvPhpznvxm8s5oyy9sypS95bYNOoyZw+qOVt/ +8S9nosoy9i6b3GjKYDMf5ZKS++W/1nUiri8aKdr5wlVh+Z9327B3gpBakCM8m2EO +2RfAokJ1n4vIqlVzE4u8pGw0YsYiBHcY+swgyg0BR2sjeqS2Q2HSZqP7SyPbnFLc +RBoRwCnbENWZzVyXp289p2jnqjZo8TyjvYCJLqtJU+1rs3nv2Pw0DYJWgIKFYX3n +sjQrKiDZ5lGysjfKakRLJIzjqenGmsl8+0k7PGYElFT7Wlp7faLfkcLgPa+0Sl0x +e8aH1ktmdPTO4VnQC+fplqwrBYxBgfA1txnCa20twESLaNHqLqfe26t9vErNxssx +UDIw/El+3rBJlDjrjnbDQ+jwbAtcXQFhwNLMvnB+eLF7ALylrfU1H8+TvptbghfV +1GQgidw9rJ7UvQGkcPOsa0vDMnnzSev0xJf1d0t3YlRMGP7N2RRO3SqjeYET4pzh +TsOrVjYMA7se8vmyf64nNk/4w6pOsmW3SEO+fro3dH4J0MwP8d/+swdLpZlESVME +fLLMRwOxR5Pzr30v8sSl77tVm99g3gdXiZHmo24E2vK9MjSvHBs6LEwX7NezAD15 +ZzeKRe8FeaigJTu68UNbIFMGXds0A4pP5DOYTkY1T0/LdUT/kC0hS/h4rfi6ebjZ +fQEH4Z7Fax5khP089fUs8HLpAuNBlcDEl1gY/QUcQ+ZPQ2ybnv0xiH3AO1Gfe7iA +W1x+Btu2Y/KBIewtt6WfC7tfU6Ymau2xhb+YeWOchHGdx9+TJvmlfSeGbfazaFUT +v6WJBmeMRPYLglFiPtOBtv+a1sa/CRtI5aeQu/Vt7/NpgUt+bmdFhSb1BaLVDMnd +XV+e47lpg/rrmGwEIpNKutxo2LTeRGyO5p68362S3t9XpJVEbo6pUT1H/e9I4tqq +bMnI+Y158sbEOXHrjAtPR/qyHt84g2HPWd9kBzofYfsH23crbCP88a61EuSSSDeW +WZiV+4CyLZiFAdPtHjGotcNCy2SKSQVbtTleOssDz7k2LVLingCg1zy/smzv6vQ3 +WwsDQwfvlNelsrs/5C9t8V3/TAKKuZOQqQk6QHJQ6MJpnPicNlZpKjc= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-des.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-des.pem new file mode 100644 index 0000000..3e37024 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-des.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFITBTBgkqhkiG9w0BBQ0wRjAxBgkqhkiG9w0BBQwwJAQQL3LfHM5IdiCRo6Jd +on16lgICCAAwDAYIKoZIhvcNAgkFADARBgUrDgMCBwQIjWTulk7Fx0EEggTIn5mg +71yBz4udwScnd56j8gTT8+UkZvz9kHhDevWSfcU0uhSjqpoaWxyz1cEUJ0pGFY+E +fw79QkrAWwkO4mWmj2QD/aqFNBBSTdVYAVmrxcj7VyyxXfA1vX55gjGHZG7QyEZE +l2FbRCTURSQX8OVg07k3AnelvhAXQZaR8MPGIIQO2Lmi+1JrY2fwTkqWz5i8sPfe +Ujmqhis/5o8mtCNYE7yIT7m3L1/BGc1kkleMxOtKAGs/0ZrCzv7ChrAHthnC+EKF +qD1yfFJdJtOyZjaSPJerMvAOm5ERUqKhmolIwW41i2VpJTj9VtCVqRvmDPDWJLqM +XvjBOzZkY+sAUAHDmYuk7RnKq7/IiL07ggrZdYWfLfX0evQeNE/FnBpDoqdu6cX3 +0lwBtiBRHVXLvwKiGPZ/szEMAzIBL2PE0LxJy/VlbQ8ZR0HRXzZ+Vyt0Zj7/ymVt +RUel9Bjn6N8JFXvxMY1f5d3Oe2DI1r0WZX25HJ5tpvjqtf4FYI51uy07j3NxaWWv +jwPp2t661UXPKp1+kTT5WVGVxK6XLY4KWfYRzDAnj3SyzsP6SeF4RMOZD3NaleNk +H4MSCrOLiJ4pSLpw9vvO44QE94uIs3/91rJTHC7Y6Q4cqrQRSwwaWVD0dE6yDPR5 +V4ueYZIYDWnhh5ynnm4MoKUFm72UlYoBtZ75eiNjTtsxojzWmrqYqc7aq+vJ6Pe8 +KbDHwwBPm17HX/XKrDDFvuWss6cGCB2wwO6YMWuX1oIxvqCSs5AY2hU3NYlonBpq +bYeZHDSX8LfsV+bGKJOazj0neo/CgWkf9yK6kQKQ/9zSRCuKqPP/y2XOWiUuk/Pn +rCI1nwB2lANFiPkPPCwrZfBXJ80EYehwxyhzDkPAQz8b04F/AFCElovMoQvhr1/X +8sxkruEyD88+ZAM5nuXWFXBSfySw6YmKmN9+jG58MRnLL568aQTyIvrePJK25P28 +xbpSb+widMmFYSDrxjzxl2iUcdTdR7pUX/qldO2oOngXA8FfDxhNuOJtidoPMGBF +ygypYHxIMrhmEV42tXODE5uBi1KWtJ8xEGhcJqvsOrWWf7cv//aPTmdSv/kcazCk +ReNlVLk3vUAjA18OiW83unQjWt0J0jJ0F5jQTm7WfW9VB7L55qe9ExexNFl5CPJc +JYNWSBvg6MlEzvk+rD/hDOszFdrLS5A3HtJIY9+3qO+OlqFtlp9JIaXmfke2dMy1 +PHHLD1PgYZ5vyBIJbf00QKclsVG5vrLYvDTv9kNKZJhVxbagzax1b6WGY6GIrR9N +8dRQpkCCYqUYgzanpkLQfofxb+TTv6JSQIRZSHKpxR7wQBuS7lT+6fTRE1tPB4OU +JPXn3W1jx05K/OxeyCFtpN/xLnnQKvnj4ZU6DXB9vO3UydUtCSpq9KvDvm55lll4 +ZkuGey11V+pn23s3ygVFuV4oPvg9zk5wHUQAlWkUL818T9pIwFLN+H10rNSVitB+ +YxlgGQfLhKsjyuUyTpKUwhqp6idosFkioWB5lmLoP5Brdsm7eOYe/sLEbUKxbEFD +xKKA7XVaqJQEPb8+069Q9iTlxv00Zng4plMNtKh2r9j9h1VOEQzLaV33yS6Wmuw6 +XJXa4mML2vuEWv8kpnetqCG/8aFu +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha1.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha1.pem new file mode 100644 index 0000000..5471227 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha1.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFFjBIBgkqhkiG9w0BBQ0wOzAjBgkqhkiG9w0BBQwwFgQQr23WBmE1lkxsGA1t +yZ+WjAICCAAwFAYIKoZIhvcNAwcECDNnS5hARTEYBIIEyI/XTneU4bZPrEbXBVuY +eunGKPNfmUJAfTftRO8w7K5j0zXo01Q9POdPbuNvVPsQQhv10Lq3hAjOeoMbWIGR +NW2a8/Ru+0ycr4hUwzbV/tkV5iSgisDVFucjaqrJaBSaV90HibWcXWHTHD/KN29H +G2Iz6VeG6EZ5RVr3LIkACwfHthXp6Sm3FmVcY3Oo1xfs7iMIuMLT8hu+4OrtuN37 +8tX8x3Bq57jy3R+Z2acx1IMo/RE0JdtsaiZEoAjFamT0XbcULO1mWmCpslTmJLez +v60/lF/VC+HJJdM3NVlNW7i1YbbDN9i4Rciu1zWUJDsKjxOLhU45/EhXbffC0EoS +/24XGmnJKZLoaDUJQtJImXNNVNYkY04LM0zD4vhOD6XZl2L53UHOLV6FBW2laHeA +CV7ZifPY6roh/ySzHtGuOc+aMFSycMkCTjGJPtb35qHSQMv1dzEoJrEh0L/IVIv9 +7OoQXwR5RI+wzDZ65QB4aRk+zKEstmK+XMMLDeO3wJS1bf92E32y0ikLhfBoyaOh +lTQMXnx3gX464Tupe+FvFvUuNtZPlOg2bv1ZgLotnPpu2bDBmC2OVbI28/OjpQF+ +ji4ytdNlO4mN2WMnjEFKLN6T+ysymc/Q/mIDAnczsl8PbDZF2U0QRM7Eaa6OA08Z +v7aRn/Xb0+uCUoGzBL1t/yfmrm/+FYXZiJ5VuLFmgp3ij9TckG2nKgow2T6Rvl+h +VYpnXhF4mZVs5S/j//EQH8cdav7QrXWMmp0cOoHSks/VtY8PwRyIB9qEajCNUIqq +7updsXvCJjIACYfB7Dbfj+E4A+LlHGGHvJk3oIcyvtH3++3TqVy+r0whUPO63HLS +tVct9rUdyWbD7CMjSA+nu2AulMbhP5SBeZzahM8svIms71DFrUEtpxQD8V2H84BL +62ZpvI2asZk7/WDK5Ndcef8ntPxIn6adOai8nPpjns2WHg9KTJYI2BXuwu9NQRJc +4S1oj/f2nKrdPpGmR8EZ4JQgUx7wzyFL657J9ZnZsTpxrAtkxn+qzv4JmwnLtasQ +3SKFEmMmnZiGyaW9KHOan3sPSbVLHn/dArxT4Oz47lingsT3TW6E15gCqSEKbHsV +qGtlCoj3zFzmVW7y4UFXrOz93BBmaR1nI3nwLokSoxPMD+hoXjlsexpCrOKdWHQ+ +RaRmpiLRwGwH+ukrRwIfPCwS7+an4lUxOmFM327zvcJiVaLMLk0oHVFgl8wRUKWN +7Cn9KIKtt/1M2v1k94EV+sr2zO2SRO4659rKJ2WHT5HeBhbaAe08Oz9EW9aealKL +kMEE5S9bqHVu9amz2RuJ92V8Fjs3bTBYSV/spl85VAH0Q7pMUKRHALuUe/sBI2A2 +miyum1F6WSslnxEC88PGFzbF87qZEkntF+nJheP2GnqUV4XDCvvvNfGkt40NGcv8 +v/rnVBJFGpgOLd4S2BxBaaKM9HhM9qtiHrTeo536FAENDfkNO1IDeytLqMZlK0os +eHRLfG0NMKpMMMndyJ1BuvJHOIu5Ph3LcP2ghuVVnbvDO0thqblGCXWsjOEfuhFF +cIUFlGyWVyh9RsFmqZgGJ/ACJ2yr/ENgATWPNEMhHWUp07hUphNFGk+0p+SWrCsW ++caljkPly+7J0A== +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha256.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha256.pem new file mode 100644 index 0000000..8c70fdf --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-des3-sha256.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFJDBWBgkqhkiG9w0BBQ0wSTAxBgkqhkiG9w0BBQwwJAQQPrSU6A8HS2rfL2Aw +tj4NAgICCAAwDAYIKoZIhvcNAgkFADAUBggqhkiG9w0DBwQIlos2bamhisgEggTI +DrQM/Syozmo0P0VjQYYB1LHUw/LRP/m+/7vJSDtg9gsxmFlhe7fOFc9nBV2Lk1aT +QcvADQm3vzmQxWllXIcqHUAbnt9YmMCxOX5rgfxNC2OIRwsxKENcIxASUrurDNd2 +YfSyEYKdqNGbgpCOFQZN279Fak1IaGaWWfnhvVV1tfrtmNKd4DuW/JB5BVLKeZXC +xZJ9KyocmciAROXYglEiucsWz0wYo8DgvtIy/hb0gInoigjnGOWRG6yQ1lqrPtHm +Irua5+OkxZx2ApbPeIEc0O6XJ54clMyEpqT61w20mzk+pDbVMfjTASeDzr2M0hn7 +FC0jhlfNympE5lUn9l3lH802xmiY6JTpvA09Bag4UIUy6oOs2upN3RNnmhNTLRtN +CYb/q+n4WQdih61V8M1jCulwx9mkPvzcfoFB7PZhX0spxD9sANHqwU7mbE46jByj +4kmCI/C8VLi0WeO5OGWyQ2shxxrWekm0NuB5ISiiymCKOndRjZQ3Ith1V2XpY/1H +uyzAZlN4+6qDVbvNIxsDuJZwvTJ3eYNUcZjtGrikGGzOX17qKlzZTOIgI6rnj/w3 +rPI3AWNhQ3QJGBD78xn2qo1a8JDYQWNLO/SqnwE+YFlU5WJZzNIEAia/nxsi8O6q +eKiPoEI2HoUhsVoISUKHheRtxQFKOlkPt3b7gBXBDbLLSyCzaNeNog5IiAyw4eVJ +u37Eb43Jgb98/krkeTZ6GRlavnhiC//pHosoWOManKxyZqlgs2ien5ckdfg0mWqc +GIJ00N+bDS2NbV5vpe8eyz94SSD2+9CLBKYXJQjEfEvMak3P8tW+qtWYke5WyAbW +DtVB5t7lWbWBa77DWYHmlRa5S6do3plvzdRBxubIoCfrU0KfmcOEIIMqbhNZs5j4 +ibM07jbxFU6VBgSxx4oLuz58C8PMzdLAgNnukuf6z4Bq7JWV4aBIRX7TErMtnfRW +5ntuetBrMMlsDl2wtrmzwdqKPMWBWLKw3S0UFodb3MAAUXUsR2xCJoDD38tSoUcK +43ssjIyoDKcd25FMys5F83/c8SZ0XKs67HK/CNvccHJA0XPckZNutmVw6K47LBD1 +BpStmjYJJh0pfwJnfrHP4JFlEP7IgtWBIAmdBuWKIrBGTMssNo9Bxy6+cLWofWfi +yedTTyxiAJ4KFEdAwobB3tm5BwBQK0/d9L96kMa3m5uAuza4fFIyL4gnH21fqN75 +0EzrvY9gQYtPQ6whddIq0JrD8wWGpLpWn7OgokaDgQ53meff2ruN6YThoTW0u+Qv +/bJnLMnJcGFMcJTmTycYfBrsl2VkkW1EMKxru2F96KgYlYPvHNLZ8aCkpq3uCHm2 +3oh+MWBSKaDjlcdUSrTajdmdk9Zh9EQCpBlkq5cTyuynFwg1HG7sh1rdEZVwY3fb ++s+KIXRqCcPL6gyjJgyVNfErA1u/N5wDULHhUumjuc+HdxEUlfv4c+TMbWBP2TxJ +XdW21KbhieCIDsQt5PT60pWHHKJwbKbnn8Sg3yvJDLlFHggvdis+RW6T2Sl4MCwr +BLwrSefk4ijG5ZRECwu3EQCVMhGXugsGbCZZfWsdqDMhKQvdSkL/lQ5K2R7vznBm +SKWz9ZnsuzKy2iei+Eo7Mi8QkFsHAtIz +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-scrypt.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-scrypt.pem new file mode 100644 index 0000000..26cbec4 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-scrypt.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFLTBXBgkqhkiG9w0BBQ0wSjApBgkrBgEEAdpHBAswHAQQkgTpdQ411Ys804mz +q4IgEwICQAACAQgCAQEwHQYJYIZIAWUDBAEqBBDGBKQPNzHgMGm1qU+XV4jyBIIE +0P79+IJrTRV4ZknEZLX9xYrlIqYzCjTMTE3o2E4Ht5EUrdcR1keHV0nDMT5VMDXd +8mKV9jGoPMT8VEHjtJ38dLykQTpX4O1ZlSj8K+qpA90cv3KJKuGYHUDwhc6hXjSj +ubQGcsf858uFyZ0zvZQAOXj8AVscFv0J9gnWyZcRQzIT2D3z+bW4h0i4Q2yrq1Qz +JEL8o2BBk3ulPFf6ma/4PgFV7HP71HMV7j9vRpo/Nqx5GzcaSF6UhXzIN2OpPY6p +moOxpnBaBaSpqEXV0JhRFIb/dBOZkY6B5HqHSINh/YUvRxSCGmiLTxbATa0Et6sC +lsVcYJfKck4sRq50wlFuN886BzHpaiPbMA6Rm2hVq2YS4bxWObawLC9jtCJqPC7v +hRp3rAsJBnpENNn3/n/k06hHpa0QnRDCNdeRZ8ao3H67wGvCkBibNkYkVQgElXTn +PLj12+py3HH4ba2FBHDdQkxFY5CYF/MsGHjVtvzUSyF0FTSfl8bz6weyDJRyhesK +VYf/l1MOM9e1/wqDZ1l5/gMvzwItnOy76pjTC5UjGxNfcOTwEDPyaZNNecVgsf3E +KeH106jmmslghBZWCdlpxYKsgbYW6ldy9IppG+3WOxr8NFDCnbxOe6KSei1ZRHfL +4LOT63v8/BaZWimjCbV8OrQlDDE1oWsMESZFeBFH2yVhR1VRgMEy7dj9GcqCufZc +Mfvlj4jFFnnmqcqR+YwvLpN7OD6sB7xeyib5YdUzGJKAuU5QC5XHv9894TNr4gQb +siGzdaK6iiRLy/WJEi7MyY9Qd0QTitz1H0Yr5P5tSPie/smBUxn1hPRPRQrBJnpd +yZt/7XgLwJTmKhWPEEBD7hTC4ZERvpcHdcV57mIFfNF1lndCEpoNdu/kUeKLD0eu +vEwWKTpDFRuIXtmSQ6uWnFDmhN/CO/YOJjl8ftazUwttlrgzjr9qKRHgynn7FsuH +zIim4wxTSQ9IuWmFlobCMCPHF2IWyyp1Y0hH7sP2ztsu7p9ecZwWY9O+JUiawccR +bWinzP//oG4SzuQqzmP1DLfnkCppwHk+4kneeq9Ies98BUkUVP/pMQdU/R2PMKbk +nOKheQ+QiaU1Xo2Q2+8Kb9Li4dwHfrJAvmpXOZZnXF/n1Fso1QArQJLuf9x8DzPR +YULR1XVTdIlsq87XENM7r4xuqrA9rZK1uxjFa0UUxDxT8t4aZ8wMqfstO5JQqL5u +ZMGN4ATF9JJHz5ndfrnNTmVJTkBlJMp3LabIi4A8aUo0zEdC07bsseSQFFUL228R +m6LsitvvqnQA9425y6Fdh+hWn0N47TTMChBI8P9WBHeKlo3+soTxhW08Fztk5Ypp +80zlgAEQLsqCCkZLnUys0B3vSu2ipcp1RWI7fFdNzr7qXdfpraF6kpPkI6vsGuS4 +8DnB13vjfGm22DM0gyahrgWbEYbh0qjdPU9YNFkAdw22QZZM7DRxgexABo2cBJ4b +DsZyR6X9mAUF+GoM9uk6LlNHOBjJhf1hQghUFafzXAnv2uRWTKElX8495BQIMkJf +7wWvD0xFouyOaBs2WG2sVvqLEsuaDWma5hl8OHfIBy/bGtM7kTTPpyW7GJhl7UpS +ECr2FeCU+AxE4d1fLLSk0NJ3p6D15BUD4J3jZsCXUKWV +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-sha1.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-sha1.pem new file mode 100644 index 0000000..18cc210 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-sha1.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFJzBRBgkqhkiG9w0BBQ0wRDAjBgkqhkiG9w0BBQwwFgQQaWRBwIFvqszAZR3q +Ela+lwICCAAwHQYJYIZIAWUDBAEqBBAhUTeex/AihIZOOCw+Di7xBIIE0O2QU8kp +fBGNyBtIJNFfeWw14v3nTRYO2YUjOCTYc86xPNJK4yV69+lxuQ1ibGQim6QSaGU0 +xoooQh1UoTHNpp9hEF+7dcvGJkOzTg5UqshrNL9d+x5CbIyfiMO23pa69VnBWeRo +4TwICc7MMT95FUkbONjbIg0jqtaCsmIEIvIIfj/jk87yAGfAqfY/5IbenXP3526M +xzMGDn5ysPYsIVNN672uRoRLL8XlR6oFVqA2Gljg38+jq5vfj7dQeRuWk0Np27Uu +dbv01SJctGIr+oLcD6gN+WQLhxgudJxy7jkmYBB6Gt669Wqnevv0konv6fk6w9hJ +Y7/220hSbLxuD0Qki34zJQ9Illi0OmsAuw575/2aEHozaJkvUPsXfbiCDiO6ykQm +HPjAMKmOIC07Uz/4VYF4EiBW94VE46kjfsXeSratSNcrZjl3qcEyQvdbNgfxhwjg +jVBotU3DHI4wK8V4Xd5lWmB+GArW+p0dtUJ6IuE3ca2oiWHqlKg8HnwFIC5v6vkj +IuCx5r8KvCjz/WnuHKSE0urJrLDYYA8RBmYzvZqUexa0IPJP+48q6qjzusMitnyq +Mh16Io6fx3EQU0+0WbqEHrzqSNWm17dSlCI2Vq6gzsK1yWKG/BCaEGA5lZxC4+lE +9dCSA0/CBdXFwcLB7d1Fym7lTmaHcJou0rywqkeDvA4lSMamaFbkPkzkrZ2lJMgJ +4YSRhj1KZMUjkgVQkOqKrPrsgVnPXwi+2i3qcqSBOZbzAkdVPnlKVi2Zn7yW8nT6 +slXg25zYpiYAKV038Oj+rkaGBF7JAwwFFAj6eUP27p+AukQUUp8guyiQvBJWBdBw +raWhqxP6nHwHx+4eFIoXHdl32PU5ToRHagJVdOJGimZcPCyryavaXVt59TiOmcXm +644rJfi2ey49N1VzEYwk2nVSZIQSCkeANnwbEt9V37GeDLk5132nfhWxhXSra1GC +nXjlmIrHS9nBBhg6Hz4tWnC24CHau5gS3beK4ZF3gUxVbJ4V76et+LCKXd+qFErH +A7M2r0GrWRqA5yMNGNX5616mILZ2h5KqPmIIycuF6hQtKJQvyQuGXvRQQa9k77dT +8T7ujEAODCjsXJumejB65vPNgxCehZqLrqUxX6MGgkvFrdEMBh/HvnrnuCxY5uvi +OWjqiHzLkoBPuE5EiMLBD9K0ATABOYs0oyQmNMqzTVSAdJ1QTdEl7lyS58A2FN25 +E5l972/DFFsiJA47YEI5c7heYnZtXadTa3eYqWkkR6C0ZCzM+WFvz5JDdaOXkFq1 +b2dSC4+NCoO7mlOR0j8tf1UKU0gk6b3478z36eghhJ8hFAaaTtkZRd+Gg5Q5Jln1 +Pz/lHQ9aPxSNYVDWJS4uGXwoKcoC6tb1y82mwoB6dHvJdAzF4palRdqW9mugXB/0 +X/euNQJr9X0GxzPmeml4BwF+zR34DyoF47t9oNqZ+D+ZZZ+85KFN5qpWxQ+78aON +kmLJS2aDLFbbixAinSWtC7T2WlrunRKtqhHbD16OlSwaqSbCTK/BXvAcyjQOCRWU +V6gskJ6Dup1pFscy63jW4H0nreH4hLignVAafxpo7HGJU3/UI+HsWrgNxL5yusoe ++MTlZRDeoBLKnH9aXKW887SVzPcZIJw82QOo +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pbes2-sha256.pem b/crates/gpapi/tests/files/client-identity/rsa-pbes2-sha256.pem new file mode 100644 index 0000000..e17d680 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pbes2-sha256.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFNTBfBgkqhkiG9w0BBQ0wUjAxBgkqhkiG9w0BBQwwJAQQKNgPQnRyv9a3bJxh +F/mvLwICCAAwDAYIKoZIhvcNAgkFADAdBglghkgBZQMEASoEEHm8bkHGT8F6igjH +EjG0tWoEggTQSV1Rw99vpqwXzU9twY9QPlk/OX9znHaHJhjURg6MocfiRPRVY73l +pALAqX88fwD0opmYPcVn1FgN5I/xg7hHu7nXXeddAGnEvO4z3uP2pJXeankjwPwB +upJRXIpRScenybVA9t+OQj9RQW+Wm0l7/yArgiiV5h8lprQWIQEYOVqnFsQ+wrQB +jHaoH5sJmrOuRKDqQRJqvmANzbNrWDCTcAoTf9tB4lZqJ/7/SLQBeh39AiepXcMt +JzCOPbn02UJ0DhHT+PZS6ZAyADYDNfgSxY8oh6oK3DO1JS5uzVLHyWx89uXJk7eX +qWX5y91Qv5simVN6Eyhtb7Zxwc6Q2ux+6J1WrTIDV9F9KyZINvcQyeYn0QAhOh8w +D46jpKSS7WplW4hzYC4YBSldPlFlc1DEDlyPP4rRP4ngyFS10fVH8SGblWFBSq9T +f5mA21b5Mww7T4MEuhXNl9DIIJGmm+MvzYin3OGUVXxpScPtzUjaZxFXMzNoxnuL +sRHlAD9O+zAqmLK9DMF1iohoZ1tcxSueNE4YkeTovZNFuZ+3HjBDdInk3P/bTS07 +Vp/7Vaii6sYDZ/55nP6XOdeLfW2TbfJ1HUqdngXlaEK389d+gvmTq4s4ULM1OxuM +BOABk3c+8hOQGZc4B6AgMhYSDWX1yy0W8mmElUxPtucGPmb/fzgzNcJAhPWSwja0 +cKPoIOnSGwBGDpgdZ57Mlp7+eGebQ6VxnmsBP/JWWsrewMf2FQrgrMMJ9lKHn7oU +Rn1RoVZmBRDm9baKPSPVr1qJrlHF1xFondx3LaKozlSLOQDezi2iG5bbGXNsFb7T +JmpdndDgCCqX+ws4A7fRLn2Uh3bt0+JlTO55EjNTF1DvYXTo2ml/WG0SR8rS3t0S +6VCOr3mVSMfgyZ3ZOb4Zf4U/5mmP8e2CfmlTBSzLt6xCmglVOw3NkJGlNCYSPbsq +N8Hv0VR71lfb3CjFqy5PocJnB52/TdLpCOZMMag8FbdSW6hOenAf8P+tspN2qVDc +yjOB2SBWNkxmFdo8+P2Sok6DEgBHhpINMRw1CF53MeuKVRLJ4/qS1paxy2HTiAEb +SOcuTC407Db22H2xhg/eDSzEF8hPhPr7YlgM/JPK34iAtWd0AxpbaPZd+qgkMXSa +YeKRx1RoQHxiocmbyOwoDWXHvqvLVYih76zaJEMSi6cpfMnT+DiwcgRleDSmEirO +c8S+px665NbKB6SPCTkkoBkTRarfVt/09zorNOa97R+06RR3esxK9moIKqclhRGa +t8/JpOcax59bnr6+NfdlW2utMbCyqFtP7HzTw5aAXd+SyWDry5bQtmNTOcWGLPLC +oyoxvsMLjImPIjd5oLu8bvkJYTC+bNt1O0Acmh2qHCYMp2jf7FKbmByeByZod1F4 +q8cuiPiUtgjpztK3wKR8G9Yb/j4BtNz5NidcY7CyFrF7dpClxhznFsD8GOCkoS2B +2rhYCawDRycMT9KSnogSndhC/Frfv8qJq6pdZcis1eS/aSJ3KZEaXTccOALH3pcq +FN2hDlLh0Lk+LuqWQWgFOF0vvaLBC/fHG8C3SqCGw5lZm+Iv81nZvKMpg64xTfNP +ohUIaNfOhfEHWavDqX1O5Yc79mpjUHZPJ02TxeKa5e1PEfCAT4TLKSQ= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pkcs1.pem b/crates/gpapi/tests/files/client-identity/rsa-pkcs1.pem new file mode 100644 index 0000000..7ce77e0 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pkcs1.pem @@ -0,0 +1,27 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIEpAIBAAKCAQEA3dUHf4ioU6VVjo4X8D06pWo/QHOgirmxa9H2bFYEfK9Tkpkb +9entrY4X444TiNHM90uAqrfWTy1iDBjLoLfWNWBR6YPIE7C652IERwbQNnqAYS0T +i7I+cWolAaAGD0dby5j8h7T7r73kXqWmOfQBGq6bcev/43+iyUAI8UzW4lORULBq ++IsVRiNvc7HrBRNFW1UsSmHYjDfnblV+4j0EpDDg1nnXARKkKNe8QHbz4I7aTdQH +16Ax1p7P5KXzm9s/VtaNxhvPV8QNbPyAYr5iG+g8vqews4QhcR5jnfFpbfP1OVvc +JKYR5h1m7Be/VxAasiKFMelaNZDbAnswkn/WhwIDAQABAoIBAGqKGylNxWYy9FXc +ebPIfGegkRNP1S17RLJfa0YZw9rsS6uPPGYNfTjLEz8XZ9tgw9uLWBbl5xgs2Deu +GvIsCMWm5oBL6eZHDWT+ZsaEB7D6gbjqMMZ5i1LmIzLWG8Lvxy8P4Uz+B5kejtVE +IoMX5QXfEUoUCdhF3zVfu0vE1zln+zxDmVehChPaI1iSPtu/+Ce4e4DGKmw2T+k/ +bcPaKre5S0JfZpq1b6LDufvbAhu/WYIo0/2LLfXYSyfN2RWkK91qbeIkbjctzC7t +RZDSqjD0qj5Np8h1pRL64L3KH6WOlKxJ5YLiuykike1Ri29QRascocGjP8lMHLM7 +hftH37ECgYEA+Egdq8HAlhMEoGuPkYh7PnhxK2PsVFKZN3VlUiQhCXMB9SZ81VcR ++RLKz7wMZ9yeXo2je4eQxFCTxuKveWHiOQh0tnRtnzGaRqv4QDUm0XFCLXwdPhDp +bXo4KuEVqRICOLJEe9GIOJO0xvzcwTv2A1YzTnu1G1pg7GaeiG4Si3cCgYEA5Lpr +7goqHEJEUm6MTowkXzuahXRv0lOAkZkb16hjzUW4RJuKNHvyibaqBVTQ6b7iRLNK +omyXLUMamShYB353IKMWldAT4D4TNBirblJYN/z2h2nf05ZdQGGHAuTTmz3HsYhT +twDNLJqhb3cGQAX/lLPXQx74HdjGyvQjmhf1sXECgYEAmL3U8xtpXWopyH8jfcbW ++yGhja4Vb/K4q7OfN59ea6/DHowk9CJyviZfetkXULYa/9RnJNHLr9pab1p51VTw +lWGsW6rY3bzoSl31hZqtXOAudEkMvGgvEtjDwS1j4/VeRH73Pq0y/otwBZL+RCqd +OIRJYBke28sIIacoFIqTAhUCgYEAzzAC9lQkwwZP5y+WTsxpYg6WsQ7BAA99peXA +L8Cr7tSZzyPptBMWpyJcrome2C19vud90tV0t55SaKv/2YH4HQs+OSSL7JOuR4GV +QFC88rJlClKgWoSZIel2J+vptnTm/+zSkDHcqOvFEjgJ5FLKqgOiGX3jGP41TMCL +w1iyyTECgYBJCzaBLXXPDPMWNK/5aTo0GRuO714kiwehvp1K+sSRKz85qx4r8Cb/ +anDVf8ONZR5mIzKUgEO3HppTKgG+yfgQg2cTsNZXuWwOl8FV83I7Zno7HMm5Rem+ +NyHj0Yb+k3D4TyB2AVE4YD78u5jXFIWrJVroIAO7mRXwD/gkZWphcA== +-----END RSA PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-pkcs8.pem b/crates/gpapi/tests/files/client-identity/rsa-pkcs8.pem new file mode 100644 index 0000000..73d56d5 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-pkcs8.pem @@ -0,0 +1,28 @@ +-----BEGIN PRIVATE KEY----- +MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDd1Qd/iKhTpVWO +jhfwPTqlaj9Ac6CKubFr0fZsVgR8r1OSmRv16e2tjhfjjhOI0cz3S4Cqt9ZPLWIM +GMugt9Y1YFHpg8gTsLrnYgRHBtA2eoBhLROLsj5xaiUBoAYPR1vLmPyHtPuvveRe +paY59AEarptx6//jf6LJQAjxTNbiU5FQsGr4ixVGI29zsesFE0VbVSxKYdiMN+du +VX7iPQSkMODWedcBEqQo17xAdvPgjtpN1AfXoDHWns/kpfOb2z9W1o3GG89XxA1s +/IBivmIb6Dy+p7CzhCFxHmOd8Wlt8/U5W9wkphHmHWbsF79XEBqyIoUx6Vo1kNsC +ezCSf9aHAgMBAAECggEAaoobKU3FZjL0Vdx5s8h8Z6CRE0/VLXtEsl9rRhnD2uxL +q488Zg19OMsTPxdn22DD24tYFuXnGCzYN64a8iwIxabmgEvp5kcNZP5mxoQHsPqB +uOowxnmLUuYjMtYbwu/HLw/hTP4HmR6O1UQigxflBd8RShQJ2EXfNV+7S8TXOWf7 +PEOZV6EKE9ojWJI+27/4J7h7gMYqbDZP6T9tw9oqt7lLQl9mmrVvosO5+9sCG79Z +gijT/Yst9dhLJ83ZFaQr3Wpt4iRuNy3MLu1FkNKqMPSqPk2nyHWlEvrgvcofpY6U +rEnlguK7KSKR7VGLb1BFqxyhwaM/yUwcszuF+0ffsQKBgQD4SB2rwcCWEwSga4+R +iHs+eHErY+xUUpk3dWVSJCEJcwH1JnzVVxH5EsrPvAxn3J5ejaN7h5DEUJPG4q95 +YeI5CHS2dG2fMZpGq/hANSbRcUItfB0+EOltejgq4RWpEgI4skR70Yg4k7TG/NzB +O/YDVjNOe7UbWmDsZp6IbhKLdwKBgQDkumvuCiocQkRSboxOjCRfO5qFdG/SU4CR +mRvXqGPNRbhEm4o0e/KJtqoFVNDpvuJEs0qibJctQxqZKFgHfncgoxaV0BPgPhM0 +GKtuUlg3/PaHad/Tll1AYYcC5NObPcexiFO3AM0smqFvdwZABf+Us9dDHvgd2MbK +9COaF/WxcQKBgQCYvdTzG2ldainIfyN9xtb7IaGNrhVv8rirs583n15rr8MejCT0 +InK+Jl962RdQthr/1Gck0cuv2lpvWnnVVPCVYaxbqtjdvOhKXfWFmq1c4C50SQy8 +aC8S2MPBLWPj9V5Efvc+rTL+i3AFkv5EKp04hElgGR7bywghpygUipMCFQKBgQDP +MAL2VCTDBk/nL5ZOzGliDpaxDsEAD32l5cAvwKvu1JnPI+m0ExanIlyuiZ7YLX2+ +533S1XS3nlJoq//ZgfgdCz45JIvsk65HgZVAULzysmUKUqBahJkh6XYn6+m2dOb/ +7NKQMdyo68USOAnkUsqqA6IZfeMY/jVMwIvDWLLJMQKBgEkLNoEtdc8M8xY0r/lp +OjQZG47vXiSLB6G+nUr6xJErPzmrHivwJv9qcNV/w41lHmYjMpSAQ7cemlMqAb7J ++BCDZxOw1le5bA6XwVXzcjtmejscyblF6b43IePRhv6TcPhPIHYBUThgPvy7mNcU +haslWuggA7uZFfAP+CRlamFw +-----END PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-traditional-aes128.pem b/crates/gpapi/tests/files/client-identity/rsa-traditional-aes128.pem new file mode 100644 index 0000000..06a918f --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-traditional-aes128.pem @@ -0,0 +1,30 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-128-CBC,1DA771DCC527783F6EFD4C6CD926AB1D + +jBGtgZupvnF4w3Abxswu06uk/GZt8fe6HJ8LqwqhiO4grseWfTgUFD/UoQzuAO8U +YrtKDbf1A/Ps0oe6pUeHUwIyw5nUU3gryFTmip5cqVuEOZJNdxCTV6Vyc5j4DQzc +cGOOBLR6bgi0l/lc2B6dHIlWYv/elnK7oYHbEOVehX8w4hQzLG00fDQmxyEQqBBA +HwZWfTLCEYHMdKf0RelPYk5OwbUq7ePn4EqNXHddmEvZNK0LVOfD9KFO/4Yy6DIa +5kLfOG/E3J82ldvwn1AYVKKCPjdKNl45u52wfgL/GbDxv29p/Z2HqEGhs5iA4weK +GW4X2psQJPFRIzXLu5Jz1+BBVKjNYAmuEKwhOzh4VXKLafNkgU1CS2sQzhNrCASD ++YP3++Q1zpuQTzChKwhUjO2xhljC+844Gic/hvPx6vcU2zDTNCGkSMhhCnSlrkql +GZJMKxtVhvi5UxwND25tVNMtMvDqC770lYdcMcsDVoCN26Xc3syr7Mq10peXWqkl +wfAEWonbD+bxsmeYkl5SKKMZ+MyB2uSdlB56Q8DdowNIHHMHGKPRBsBA0Yl8A7bY +/cNUWWF1SJSZjk3BxakIOcPKFLPUkJ/3ynajoJEo3QJDEF0C+2yWPc7y1B+aOVuD +ON0s9kNNmbETo9vCBHHBs8LOX4nW6lRNCYE9PdlvN+ThTyzlCM0FAc2pPaHoxzUM +Kz28/vQbwrHU4Yn+COtOMO75vDHLIzhb0PiA+8S4CsPkRg8kSjzO1odzw+9QDjcA +EbFqtpHW0lGiAWgTOCXcNN6EjTyswm45IIU1ajbDrecpGFwK8LM+A7cyHXDkNDaY +5aJVwysOdhgFCu/70pz26cloX3UWQN79Mu7yBIduNX4NkfL9UaAehiauj2Tvyw8v +SZNs/WW4BrAWN6LfXb3bSYl4Utid0oyu1jFWAMMOPnr0yOW4K01h/UpYiDXV937+ +zzujYIKl8r0fsX0gksiLaFEWDWLQZHEa507/FIeVZbdJwmbAbZoXjvM9lEsQihHl +hg3t1Jxgu1PlD0a+J2EllxMWo1ImBAMnF7cEAE9MzN4gXcTR4KqI74CQ/ux4CNur +0+IqOx1wcnV0Z7b5Iss0cXvsowtZeh3ywRbYhZlPvh3ztC1DQ0z+oAgRoXd/A69/ +aU5hKPz2Bs0XVueah4YLZRDrD5v/JPuoqU1BE1IxshQzIf22KEj/iNnVz8WeB6n7 +PK2GZlmbv5JspatNOuCCnWNKVVyN30FJu4Zs9V7M8iNI+ehk9E7giE1Cb+HYGN0P +IJHGzAck1vdq4WxHaQOLtM1qcKthf0NyVxQKcO7KYe7HDIaVjUsUr9Oz+UG2Qwxi +yiB5XsjbU9dFn8X57HMqvZOW8kICnucqurFx3RruO1CrWG0OlRytP8BjtI+sCLnl +Y7OYuRHLJClJZMgVCJfWNC7wjvX39gY1PjbYVzNwGhnOFu12jXFE7+s0KT2G575M +XQE8OZ208P1rlDo0PHvs2tlk1bOz942m14tpABzXkEIC35OHjwj6Vi+aGrU4kv2i +HhVTsSwPDrCf5acTlmawxKoj2jAey8xHRlrV6O7B94mEJFCEbHjw7thVd3ssoSLT +-----END RSA PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-traditional-aes192.pem b/crates/gpapi/tests/files/client-identity/rsa-traditional-aes192.pem new file mode 100644 index 0000000..8f368a1 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-traditional-aes192.pem @@ -0,0 +1,30 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-192-CBC,3676585752281E1F13CD59E6EB36EC8C + +ImHFk1Pvr7eeFtS7eorBiq1eMNEJqn7ydhMOsP+4GCJ42zihMSbkwIbEt5Q7h3oO +G0aZvr0vwnYIvWWwc9s7jdpbKU4w6ll00xDL2bmbFGoyJx9li8fiYL7SrHg1Uw6A +0VFKuBCBjndQaRAw1+YFETscIcw2g3qdeaO2C4DKLQqCE/INucGCAljzjcevRNIo +lxM27bQQgO2iI99LVAeXwPFgGij0QBJnI50Fydsv+b65Pn5AVl8Q842Qjb6OuKs5 +UinlPMSzvZ824FO8Q4eGHyVVII2o9RGQRm249szyxwm/a5TetGzMQaZo3vERYTtL +fR65j0YiCuqfCb8seKywtvcUITRo2Da5bS+ZvxUxuP01JyEd+0N/h/ekUyBBg1q5 +pb91zrdI4aL2he1m6EQYqzxka6UZWrKiKaw5UEVb9cC2fftxaInRa8h/WDqCN8U4 +ukVg2SLDMT+6BWTeEVSFOY6727Dy9a9UBneHc1ejvX0lrUmsL0w42tH2AI+WZx0c +saRp7ali+/Gj5E7otchakMAfjusZ0pNCcuRHaPY6QMswacDU7o/7l5z/P12eyrTv +lTnwdJbnsi8Pd7MsY1GSbRmmwfsv7zvDufYnSBD5AWUx97kODpfIr4QP4tv2m1ms +tVJ5kvyYQW0z0/oNSac8tbekKxfgRFoQUkebMuEJBiKmXm127fCm5M7eatMhE66L +mvV61lZ3LoENFpTZAmcPmNwqce/LWlJV2LgJkmUJB1apwZYss9uE1AgHQwKvl9mf +vyBDU3D94Ro5/uxb2xjNNXrN5FGa7+GXkoRNxBcD32KqlMJLPYZDdweVVC+jepY0 +jNAV/Hf7YtX59SSOYNXOQPZYDQPr715//RDlcXJxKHVu0/uUHuEu+EAV335uWFUA +fTYsbkStYyGtJAmOUwavv7DVAfVqGJxKDsyxqm7PJtpr5njvlbsHwh2+xMPxLhyE +GAY5AWv3VLOu+b0RzpPz13Ja1nhjrb5xM1Ece5UhOMrUDOPs/XOK6pVMOfSiS6O4 +W8V00bOiYElp/xrhFmLrxKU95CnOs/FFFNM7y++ZozJLfetj58IavKf4tvgZKHx8 +izsOnKn59Eabl42T8/Kzh+mmsKJp8UYbNfq+J2haUmmwtLW39Crxh4whDKsWhmqd ++/gB8ssp4I3VqphNnW42hmqfE9J62sb1llU33ZwN6zoKKekvDQgv1CPzTMMGWjSx +SgaIuF7Fl4zcV1V1nQcdMaQlgwDhbxuqpvl6r//q+76tiVOpI0kgXZJFxj7Czc7u +9/Q0xKhjshKxTD941HkoEXS+nQX9+nxqK4PTgHxsmuAtm5SI7BiBKrByKyFKiz9i +XiPIlpMwWxP2Hbb6fkmzcqT83GE+3IXw+zYIg9aPu+kB7Vhp4ZAOA99lvf7i5D7z +5P0Qij/7+XDRbDLArtYKng7Ly33NoZ9mmsW6BIw4wE5L07xGjuqrh6ni8lQ+gF/8 +6NrXL26W6tUv/us62J396mOgY7dWz332PzWCTFEAJFkiLvx/GpQJQMAB6FTcc7Rd +KeDM8dvtKu8bb6NRYOAmg8icIzTbcGhnFHZbiFfaqBX8Qd3yWk10KmdJipU3Rn+t +-----END RSA PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-traditional-aes256.pem b/crates/gpapi/tests/files/client-identity/rsa-traditional-aes256.pem new file mode 100644 index 0000000..298b07b --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-traditional-aes256.pem @@ -0,0 +1,30 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-256-CBC,C47A164F22721903963FC768F2BFF0FD + +Ultu7rEweaaOx6V8pce+mVsFmaDSOGyZjBk9eUOIcdIEseDmzms4TBNyYBddUrhb +6AiIwo1kz/2D7YED7dEckyuZyX9LETDcno3MwwDrXAve0Nn7zj4qgHl+Pj2GBfWf +PioDdmXHthbOjJp5rHgR9+gYbhPYnBW09OV6ml1WnPjqOlpsI1izKa3sWBsje0/W +rNiHM4AZ2TJbrI9/rb9Nvd3X4t0RdsKsHpocxuBzq9YOKTt/rxD3uwI3fBkwyySZ +PZhWxBL1iydiMwTWpXd6RwpH20pjUWyxzBdeb03py8ZE6kW8nA/GT5pu+wKnWoLk +c/I1S0tKcI/LjRrOtorBNyHy2+sVH4vQVHCiCA6JV0+7u+uNP2SekQ/+8OsXB6bk +KRslQeuIrEhqdUmwkrdxP5fu6034/pPFdBHo4qbIYRY+vCvzJYuRLQfyapzSacNo +qloRG/aMxJtg1SZdQnE/Zt7bj1tow3b/Ks4fmX/xdO12Ye9GrEbEXu3yXGky7yz8 +z/n9eUYvhUP2qvVxqvHEZlEnyixTRRC5YO8PovpWAM7XdhbdVculfgqYm8JQaqcy +DBkT5t6AExvRpTXqkIAG+RMlsUHCoFVMJJyGK7eMtg94RP+Y97bAaAlch4Cw/ulH +9m56MluMtbThKRy4gxIojNb/Vd9poAMmNJVlB5gY5UGrbeLWxvVZzFDcv5BmadIa +iJyJ/TrLvHhH9umewBqGYafnNJNdlp2PbZ0eRx7idCwlhOwhhuBJZTqLNoKK+CYt +6GrG04IZQB+N2id9hXTNyomaASBXgc3Nq+CnLssIpPLfHB0O4f7boYwlPCzsIrWE +EAeGBOZv3Njv9iuKX9HhB8GDNcQ4TSJ1ShsnqULDpbklza+fL8HEmD00BKY4AuIO +RmH5CgmHgW0MwBuX2kJDd7Hrz9WJB6vKNOLuNsai5xX9L+Ivsk+RB+YQLoMSBk24 +DpD+LRgKTdY/vakinHpR9inznUjBQbg0KZtmqxlcznlVmo5Gx3imWmCNurmW+wwQ +kn4mj0gI99VMWbWwJu1mUVt2j3Zy1PgeYbCtG26VfOW7a+jl7+a31LIn9taQzFH2 +20788uRl96kx3ijETCt/VGuqj+tZx8bcCz4o+22K2ycqzYlStKq17PCm2yrWYbXD +nWEdXpASv+blugFDH/GvBSf5RGP0HYbSIIVxcruvJerlIkc9tWb5+gs/beEzV/Xu +c3BYz5fpljecprZJq8TvBvb5T8mK1D3YdZnp7COWxY+I7wt9PP5GTqOzYFmauFZO +/AOx0VickKMhfLLC4LkLGfYnaRpMpQ9pB3Z8AhLsY3mxXBxKYacIT6dgUXafpRKO +13ILxvG+VC6Q9yScm6GpL8gsldxDQXzQ6STyDjw5wR42MqtqA4tTmnkxSlsPdj9i +R4WeUjAtUXj/VBfB9X85LVjpN+thHpZwYtpvYdWk4CAqVAl8pjHkndm4oWpKxMXC +OeQpZVsd/t5ZKGDwccKrUm10nQmeDw4NNzQDsLWCB15E60cegsGcBa27BVwYhVnf +25iyJp525Sio9LFJDNk3UNSof2n2TrbF9EyhRIZhx2guIxKomntoAuT1NcxiDEUz +-----END RSA PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/rsa-traditional-des3.pem b/crates/gpapi/tests/files/client-identity/rsa-traditional-des3.pem new file mode 100644 index 0000000..bb30487 --- /dev/null +++ b/crates/gpapi/tests/files/client-identity/rsa-traditional-des3.pem @@ -0,0 +1,30 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: DES-EDE3-CBC,083D46DC0D0EFB2C + +iJLYLqu75j6reCA0CvZLBN7SpZzJufa3emjV+vlCzcZAbIa0WDdRzaME6m14y+aC +x6Diz6K/kfIugjtYeGoXIPix1HJsSpCN+WH016vs2Ne95UTBcwH3QOHGyDmyGhj8 +mWLzc9ikc8P4SHGYJ6vDCgY5GUpgoUZ61Mdwc+W4ZWZnin7igU8u/qlS7zJP1yVH +PA0LPBd6X64fF5hwmno+13ObKikP4YFLjArt440H2GYdD3gYfOCOXWmtAqD2KA8j +Ewvvm9jjx4yqWHd4am9vVZgK0rnfaHtGEo8XrN1b79Mzl0m5BEE966jJep7NYhSO +MrEQV7r8IhQ+6FZ2USKnboAcc5TI3XuzLsfZH50eLRlXMNy/f1/fbIWLzmdd4FU2 +hi/Pb/NAuGqHPMHunjyRUJciJB2FnT8MqXtWnggAgKVFAouzFqkSBh3D0pBMWnMQ +XJdbAWEGz+SWiDu2oUOoOMYsNSVujpoeW2H6O7A+IDw45KJCaBE7eCiDvcAiZvVD ++hEIO31nVUlXahxso6oBfaN+7SZZAh2UFAiY2i1sQVi2OSC1xArngpomqwKrYlhJ +15OQ7Qo24bRzqRzrmP1tGRy6MfFnadh92eXpNs3irY+cG1f3Roy2HKvAOk8yx9OF +rmJy6XaV7PasGAghx4/obIwbDw2ALNpQqkKrPb9TnQQvMHiCK/1Wag5KfKM89F6V +XP95dVDobstkAY4Y7TxrI6ql0vF7cKcJbiFAEMLusvlpIVDAVWwFJMRMsWmvcDVq +Ym4bQvZ1GuhLNehW1BO6HKR78uEtnwZtbdDHWnyRy0ZcnxmyKIXiNFBIhhmgMQ97 +QV8rL57jANJRE+d40ds76bvYI6grEqqXr+8tRJ0+km2HhgKcnt8KDIuoU0WTmfL1 +qp5kF3TucH4bUqWuTo5kALMqTuMOBz/vuhV7pztDbmrbz2vdb3GHlYqiTkDejgVN +1M6GgqArGRw+8Tldw1+MeL6ORg4YsLRQvdI9OKsw8hIVn7WPUQptLHOrb6QxryQI +wUpx7c+c8aZqkbqAp9/2KPCuiGfgiq7RJgtFHlFaHIG9q6ulKv8Oo+ULA/eLTaP4 +rwUNzF6fFKXwnfwbPj2LxbHYQ18q0pWJpvTR+7/a8osCipwb+MZTzQ33ckghjeQG ++zCa1rRRvha7oe641WTq9hbKUnBJa385/7xkhGfCTuhRsqOui83UAnC+GXdKsJaS +pfstw1zVlKMHetW0WRaboQu5LHMCdYYOOUJSRSzJN0+r3m9PrfA9y7UR9usrhYUZ +s4bY0louuzyZ6u7N67v0hVFvgVHEyuWavXHHRzlau3jrcqD57Fpp9zZP+TDEf7aW +VKTJYsbdVhbpQnQhRcSUHC78NqVp1dXf85i6Fr/dLBuG68VcR3pvK7xxTPsrv7Bd +a9c9ORbF+wgMJc0LwjFo5N27c1NfnWCJXf4rPUhjtnpcF3Vs5p/0rKWxdYDHC4gi +KobPxDZgVdFpPzfXHGvNzz6pX1o3okKtD76f6apFI/uKn14MhFRAspWMoX39YPkv +kzklzSVOziWQ+c5lO9JWofs18y3Yawdu9SPoyrQOFfQV7aCTgX54E2qNmS9gksLd +-----END RSA PRIVATE KEY----- diff --git a/crates/gpapi/tests/files/client-identity/unicode-password.p12 b/crates/gpapi/tests/files/client-identity/unicode-password.p12 new file mode 100644 index 0000000000000000000000000000000000000000..00009d45b5da534114659cf9ea49a3953722cba2 GIT binary patch literal 2119 zcmai#dpOgJAIG=ZhH@*E+>c8Q;XB8r#Bv!Tb31lg<(kCmxP*g6(Mz`{p$Ihr~W*De4h97e!u_tJkR@|7eExThJb|tqVO7ARGV~y zv?UG}22+T_Z=gis$#3x}K!jiXS-~kp_}OpKDF_(!OsPCR#((H|LLed_KnyPO|E~~H7zj{;i~5jGfc=G_U~Q<>JC4n|t=!$0 zvzP+D%zPatfe7PQ5z?{d!?%x(y)%7u#Nh0K$>+8uYTa*q+O?6&9X{_l22{ilr7vX? zyB$(4?9$K=^ye7ov6cQ(6%mzhlhi4E3FV#QkWZF-jPw#JXOv&>G8WBsk+{S}knqWn zzH8g3j@`?8QJQz9_g06Xii}G>SUHrV)vRSL%fRnEbu9(mLh=2(?|Q5XL@h~eg(i7$pSAI7^v%34r?rfR4C zSY!Y(B5>7D35abLNM?D(A3nSft*mm-gsc7DYT9li*!oF|Qj_(CzR-;fnpa)x$D=-` zo0H8C{MfSMVN}$td6VPyE7Q#7lwb5^F~g(h%(L{hOsPi&qMWD>3B2q|AU0Z<-xf%+f=)d;0MWP9ws^utu%`tRQ@eV013uNrWS7%Uc?fx z`t-j)^Oz-CypP!}vAhNaT%be%`~ABYpVD!aSdtzy_MO!(S0!Z?wFduBIZU|VOKxV04O?AY$WXUW@vQ^q@0rvJi&pZM{3@I zy{j_ycHr|I{iEYw?BGS>92L8NB2&Z z0}0c+1ABW9H_rQO*`MiFX?0cHV7)985qTzV8Y3A7nqH=~vTda|2I5(?@|mur6TD8d zDngS}dUaZNMeE7gwO6&#+&Hct(xxNV9$KNnb}JXL?CZ!VR@}z1W>t2F>w+UDo>T7a zpCE>7+EZ`^a%qY!C5@se!@{D3<581?0YFkl?~-A|NJz^4*uEKbzd;P$_H^nE)Ji3_ z$0KseNB5!ygFJ;$+dmUXrJU)-<~f~3DTQrWJG`#56xYNjX~fScc4fZ}43;JLvZ9-n zx-Er`&xOF0S{@*1caP?dc}u*Td@EBHw9nkT>7F62O(vj>qrp@A+z+zZwU-%D=7aPmYaJmHO&Z3+;4VGWk@Y)K3H?q zYJGZYHP55XN!VIblIqxcaFA}vh;@HPVR~Q>RqpFC8?KtNYeM>q@wC^Cog#K{F`bvM$F!L|F#b}z z>j+x$S}bU#6TGJ+IY{nO#+}7JpF@DobE)Z4nW;FJ1}^RcRy$(wawa}n9;@m4Fo3H! z22yoSG&6JZjq0nD^gtriLIVxHdL}!#@Y7mCOdqlajlYo z2oS-6Ke+K7MBvjTwJ3+?ysSl!cZnrUwobPcGq)8_+tJ-PLhB zI2M?XdzB+FSmMkwt+J7iUs}l)+l{MpOlnL@@9TX)UYeLq_8ly^?viXJZ$%E@3r58{ z{ziw6$joh&OnxS+==ag3uH_NO*WWU;mnuAM9n68AP% zrZw(>&0G#?BhlYc`R^2>GDs<93D5-)9uy6V0R0IH1Nj5$KWka!KB$b(AM|!i?_%wQ z=K7vB$?S{9IPp(_J%9wne;^kEhJm1}z6Haooq}AA2#Bz>QYrsw3|*C*CST2?S2NOu d#2QneQX1&Cg_Vb`h>v?th7|3q8vZ`${{S5C*%AN% literal 0 HcmV?d00001 diff --git a/crates/gpapi/tests/identity_encoding.rs b/crates/gpapi/tests/identity_encoding.rs new file mode 100644 index 0000000..4954541 --- /dev/null +++ b/crates/gpapi/tests/identity_encoding.rs @@ -0,0 +1,274 @@ +//! Container compatibility through the public identity loader, using public fixtures. +use std::{ + fs, + path::{Path, PathBuf}, +}; + +use gpapi::utils::request::{ClientIdentity, RequestIdentityError}; + +const PASSWORD: &str = "fixture-password"; + +fn fixture(name: &str) -> PathBuf { + Path::new(env!("CARGO_MANIFEST_DIR")) + .join("tests/files/client-identity") + .join(name) +} + +fn bytes(name: &str) -> Vec { + fs::read(fixture(name)).unwrap() +} + +fn load(certificate: &Path, key: &Path, password: Option<&str>) -> anyhow::Result { + ClientIdentity::load(certificate.to_str().unwrap(), Some(key.to_str().unwrap()), password) +} + +#[test] +fn der_certificates_and_rsa_keys_normalize_to_the_existing_pem_identity() { + let directory = tempfile::tempdir().unwrap(); + let certificate = directory.path().join("client.cer"); + let key = directory.path().join("client.key"); + fs::write(&certificate, pem::parse(bytes("rsa-cert.pem")).unwrap().contents()).unwrap(); + let missing = ClientIdentity::load(certificate.to_str().unwrap(), None, None).unwrap_err(); + assert!(matches!( + missing.downcast_ref::(), + Some(RequestIdentityError::NoKey) + )); + for name in ["rsa-pkcs8.pem", "rsa-pkcs1.pem", "rsa-pbes2-sha256.pem"] { + fs::write(&key, pem::parse(bytes(name)).unwrap().contents()).unwrap(); + let identity = load(&certificate, &key, Some(PASSWORD)).unwrap_or_else(|error| panic!("{name}: {error}")); + assert_eq!(identity.certificate_data(), bytes("rsa-cert.pem")); + assert_eq!(identity.key_data().unwrap(), bytes("rsa-pkcs8.pem")); + assert!(identity.key_password().is_none()); + let snapshot = ClientIdentity::from_data( + zeroize::Zeroizing::new(identity.certificate_data().to_vec()), + Some(zeroize::Zeroizing::new(identity.key_data().unwrap().to_vec())), + None, + ) + .unwrap(); + assert_eq!(snapshot.key_data(), identity.key_data()); + } +} + +#[test] +fn encrypted_der_preserves_password_errors() { + let directory = tempfile::tempdir().unwrap(); + let key = directory.path().join("key.der"); + fs::write(&key, pem::parse(bytes("rsa-pbes2-sha256.pem")).unwrap().contents()).unwrap(); + for (password, missing) in [(None, true), (Some("incorrect"), false)] { + let error = load(&fixture("rsa-cert.pem"), &key, password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(missing), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(!missing), + other => panic!("unexpected DER password error: {other:?}"), + } + } +} + +#[test] +fn ec_sec1_normalizes_on_linux_and_bsd_and_is_terminal_on_macos() { + let directory = tempfile::tempdir().unwrap(); + let key = directory.path().join("ec.der"); + fs::write(&key, pem::parse(bytes("ec-sec1.pem")).unwrap().contents()).unwrap(); + for source in [fixture("ec-sec1.pem"), key] { + for password in [None, Some(PASSWORD)] { + let result = load(&fixture("ec-cert.pem"), &source, password); + if cfg!(target_os = "macos") { + assert!(matches!( + result.unwrap_err().downcast_ref::(), + Some(RequestIdentityError::UnsupportedKeyFormat) + )); + } else { + assert_eq!(result.unwrap().key_data().unwrap(), bytes("ec-pkcs8.pem")); + } + } + } +} + +#[test] +fn traditional_encrypted_pem_has_platform_specific_support_and_password_errors() { + for algorithm in ["rsa", "ec"] { + for cipher in ["aes128", "aes192", "aes256", "des3"] { + let certificate = fixture(&format!("{algorithm}-cert.pem")); + let key = fixture(&format!("{algorithm}-traditional-{cipher}.pem")); + for password in [None, Some("incorrect"), Some(PASSWORD)] { + let result = load(&certificate, &key, password); + if cfg!(target_os = "macos") { + assert!(matches!( + result.unwrap_err().downcast_ref::(), + Some(RequestIdentityError::UnsupportedEncryption) + )); + } else if password == Some(PASSWORD) { + let identity = result.unwrap_or_else(|error| panic!("{key:?}: {error}")); + assert_eq!(identity.key_data().unwrap(), bytes(&format!("{algorithm}-pkcs8.pem"))); + assert!(identity.key_password().is_none()); + } else { + let error = result.unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PEM")) => assert!(password.is_none()), + Some(RequestIdentityError::DecryptError("PEM")) => assert!(password.is_some()), + other => panic!("{key:?}: unexpected password error {other:?}"), + } + } + } + } + } +} + +#[test] +#[cfg(not(target_os = "macos"))] +fn traditional_passphrase_with_nul_returns_a_redacted_terminal_error() { + let error = load( + &fixture("rsa-cert.pem"), + &fixture("rsa-traditional-aes256.pem"), + Some("secret-password\0do-not-log"), + ) + .unwrap_err(); + assert!(!matches!( + error.downcast_ref::(), + Some(RequestIdentityError::NoPassphrase(_) | RequestIdentityError::DecryptError(_)) + )); + for diagnostic in [error.to_string(), format!("{error:?}")] { + assert!(!diagnostic.contains("secret-password")); + assert!(!diagnostic.contains("do-not-log")); + assert!(!diagnostic.contains("115, 101, 99, 114, 101, 116")); + } +} + +#[test] +fn first_traditional_encrypted_key_controls_combined_pem_loading() { + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("combined.pem"); + let mut chain = bytes("rsa-cert.pem"); + chain.extend(bytes("root.pem")); + let mut combined = chain.clone(); + combined.extend(bytes("rsa-traditional-aes256.pem")); + combined.extend(bytes("rsa-pkcs8.pem")); + fs::write(&source, &combined).unwrap(); + for password in [None, Some(PASSWORD)] { + let result = ClientIdentity::load(source.to_str().unwrap(), None, password); + if cfg!(target_os = "macos") { + assert!(matches!( + result.unwrap_err().downcast_ref::(), + Some(RequestIdentityError::UnsupportedEncryption) + )); + } else if password.is_none() { + assert!(matches!( + result.unwrap_err().downcast_ref::(), + Some(RequestIdentityError::NoPassphrase("PEM")) + )); + } else { + let identity = result.unwrap(); + assert_eq!(identity.certificate_data(), chain); + assert_eq!(identity.key_data().unwrap(), bytes("rsa-pkcs8.pem")); + } + } + assert_eq!(fs::read(source).unwrap(), combined); +} + +#[test] +fn malformed_traditional_headers_are_terminal_and_do_not_expose_material() { + let directory = tempfile::tempdir().unwrap(); + let key = directory.path().join("invalid.pem"); + for (headers, unsupported) in [ + (vec![("Proc-Type", "4,ENCRYPTED")], false), + ( + vec![("DEK-Info", "AES-256-CBC,00000000000000000000000000000000")], + false, + ), + ( + vec![ + ("Proc-Type", "4,ENCRYPTED"), + ("DEK-Info", "AES-256-CBC,invalid-secret-iv"), + ], + false, + ), + ( + vec![("Proc-Type", "4,ENCRYPTED"), ("DEK-Info", "AES-256-CBC,00")], + false, + ), + ( + vec![ + ("Proc-Type", "4,ENCRYPTED"), + ("Proc-Type", "4,ENCRYPTED"), + ("DEK-Info", "AES-256-CBC,00000000000000000000000000000000"), + ], + false, + ), + ( + vec![ + ("Proc-Type", "4,ENCRYPTED"), + ("DEK-Info", "UNKNOWN-CIPHER,00000000000000000000000000000000"), + ], + true, + ), + ] { + let mut block = pem::Pem::new("RSA PRIVATE KEY", b"secret-invalid-key-material"); + for (name, value) in headers { + block.headers_mut().add(name, value).unwrap(); + } + fs::write(&key, pem::encode(&block)).unwrap(); + for password in [None, Some("secret-passphrase")] { + let error = load(&fixture("rsa-cert.pem"), &key, password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::UnsupportedEncryption) => assert!(unsupported), + Some(RequestIdentityError::InvalidKey) => assert!(!unsupported), + other => panic!("unexpected traditional header error: {other:?}"), + } + let diagnostic = format!("{error:?}"); + for secret in ["secret-invalid-key-material", "secret-passphrase", "invalid-secret-iv"] { + assert!(!diagnostic.contains(secret)); + } + } + } +} + +#[test] +fn der_with_trailing_data_is_rejected_for_certificates_and_keys() { + let directory = tempfile::tempdir().unwrap(); + let source = directory.path().join("trailing.der"); + for name in [ + "rsa-cert.pem", + "rsa-pkcs1.pem", + "rsa-pkcs8.pem", + "rsa-pbes2-sha256.pem", + "ec-sec1.pem", + ] { + let mut der = pem::parse(bytes(name)).unwrap().into_contents(); + der.push(0); + fs::write(&source, der).unwrap(); + let result = if name == "rsa-cert.pem" { + load(&source, &fixture("rsa-pkcs8.pem"), Some(PASSWORD)) + } else { + load(&fixture("rsa-cert.pem"), &source, Some(PASSWORD)) + }; + let error = result.unwrap_err(); + assert!( + matches!( + error.downcast_ref::(), + Some(RequestIdentityError::InvalidKey | RequestIdentityError::InvalidCertificate) + ), + "{name}: {error}" + ); + } +} + +#[test] +fn pkcs12_extensions_are_ascii_case_insensitive() { + let directory = tempfile::tempdir().unwrap(); + let archive = bytes("modern.p12"); + for extension in ["P12", "p12", "PFX", "pFx"] { + let path = directory.path().join(format!("identity.{extension}")); + fs::write(&path, &archive).unwrap(); + let identity = ClientIdentity::load(path.to_str().unwrap(), None, Some(PASSWORD)).unwrap(); + assert_eq!(identity.certificate_data(), archive); + assert!(identity.key_data().is_none()); + for password in [None, Some("incorrect")] { + let error = ClientIdentity::load(path.to_str().unwrap(), None, password).unwrap_err(); + match error.downcast_ref::() { + Some(RequestIdentityError::NoPassphrase("PKCS#12")) => assert!(password.is_none()), + Some(RequestIdentityError::InvalidPkcs12(_)) => assert!(password.is_some()), + other => panic!("unexpected archive error: {other:?}"), + } + } + } +} diff --git a/crates/gptunnel/Cargo.toml b/crates/gptunnel/Cargo.toml new file mode 100644 index 0000000..98ac043 --- /dev/null +++ b/crates/gptunnel/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "gptunnel" +rust-version.workspace = true +version.workspace = true +edition.workspace = true +license = "MIT" + +[dependencies] +gpapi = { path = "../gpapi" } +openconnect = { path = "../openconnect" } +log.workspace = true +tokio = { workspace = true, features = ["rt", "sync", "time", "macros"] } +uuid = { workspace = true, features = ["v4"] } + +[dev-dependencies] +serde_json.workspace = true +tokio = { workspace = true, features = ["test-util"] } diff --git a/crates/gptunnel/src/configuration.rs b/crates/gptunnel/src/configuration.rs new file mode 100644 index 0000000..f3e7479 --- /dev/null +++ b/crates/gptunnel/src/configuration.rs @@ -0,0 +1,217 @@ +use std::net::{Ipv4Addr, Ipv6Addr}; + +use gpapi::session::tunnel::{MAX_CONFIGURATION_BYTES, TunnelAddress, TunnelConfiguration, TunnelList, TunnelState}; +use log::{debug, info}; +use openconnect::tunnel::{Configuration, NativeList}; + +pub(crate) fn normalize(configuration: Configuration) -> TunnelConfiguration { + let ipv4 = configuration.ipv4.map(|address| { + let prefix_length = address + .parse::() + .ok() + .and_then(|_| configuration.netmask.as_deref().and_then(ipv4_prefix)); + TunnelAddress { + address, + netmask: configuration.netmask, + prefix_length, + } + }); + let ipv6 = configuration.ipv6.map(|address| { + let prefix_length = configuration + .netmask6 + .as_deref() + .and_then(|mask| ipv6_prefix(&address, mask)); + TunnelAddress { + address, + netmask: configuration.netmask6, + prefix_length, + } + }); + let mut configuration = TunnelConfiguration { + interface: configuration.interface, + ipv4, + ipv6, + server_ip: configuration.server_ip, + dns: list(configuration.dns), + search_domains: list(configuration.search_domains), + split_dns: list(configuration.split_dns), + included_routes: list(configuration.included_routes), + excluded_routes: list(configuration.excluded_routes), + mtu: configuration.mtu, + truncated: configuration.truncated, + }; + assert!(configuration.limit_encoded_size(MAX_CONFIGURATION_BYTES)); + configuration +} + +fn list(list: NativeList) -> TunnelList { + TunnelList { + items: list.items, + total_count: list.total_count, + truncated: list.truncated, + } +} + +fn ipv4_prefix(mask: &str) -> Option { + let mask = u32::from(mask.parse::().ok()?); + let prefix = mask.leading_ones(); + let expected = if prefix == 0 { 0 } else { u32::MAX << (32 - prefix) }; + (mask == expected).then_some(prefix as u8) +} + +fn ipv6_prefix(address: &str, mask: &str) -> Option { + let (network_address, prefix) = mask.split_once('/')?; + if network_address.parse::().ok()? != address.parse::().ok()? { + return None; + } + prefix.parse::().ok().filter(|prefix| *prefix <= 128) +} + +fn escaped(value: &str) -> String { + value.chars().flat_map(char::escape_debug).collect() +} + +fn optional(value: Option<&str>) -> String { + value.map(escaped).unwrap_or_else(|| "none".into()) +} + +fn addresses(address: Option<&TunnelAddress>) -> String { + match address { + Some(address) => escaped(&address.display()), + None => "none".into(), + } +} + +fn values(list: &TunnelList) -> String { + let mut value = if list.items.is_empty() { + "none".into() + } else { + list + .items + .iter() + .map(|item| escaped(item)) + .collect::>() + .join(", ") + }; + if list.truncated { + value.push_str(&format!( + " ({} of {} shown; truncated)", + list.items.len(), + list.total_count + )); + } + value +} + +pub(crate) fn log_configuration(state: &TunnelState) { + debug!( + "VPN configuration: tunnel {}, revision {}", + state.tunnel_id, state.configuration_revision + ); + let Some(configuration) = &state.configuration else { + info!("VPN configuration: unavailable"); + return; + }; + info!("VPN interface: {}", optional(configuration.interface.as_deref())); + info!("VPN IPv4: {}", addresses(configuration.ipv4.as_ref())); + info!("VPN IPv6: {}", addresses(configuration.ipv6.as_ref())); + info!("VPN gateway IP: {}", optional(configuration.server_ip.as_deref())); + info!("VPN DNS: {}", values(&configuration.dns)); + info!("VPN search domains: {}", values(&configuration.search_domains)); + info!("VPN split DNS: {}", values(&configuration.split_dns)); + info!( + "VPN routes: {} included, {} excluded", + configuration.included_routes.total_count, configuration.excluded_routes.total_count + ); + for (kind, routes) in [ + ("included", &configuration.included_routes), + ("excluded", &configuration.excluded_routes), + ] { + for route in &routes.items { + debug!("VPN {kind} route: {}", escaped(route)); + } + if routes.truncated { + debug!( + "VPN {kind} routes truncated ({} of {} shown)", + routes.items.len(), + routes.total_count + ); + } + } + let mtu = configuration + .mtu + .map(|mtu| mtu.to_string()) + .unwrap_or_else(|| "unavailable".into()); + info!("VPN MTU: {mtu}"); + if configuration.truncated { + info!("VPN configuration: truncated"); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn masks_preserve_missing_or_invalid_prefixes() { + let configuration = normalize(Configuration { + ipv4: Some("10.0.0.2".into()), + netmask: Some("255.0.255.0".into()), + ipv6: Some("2001:db8::2".into()), + netmask6: Some("2001:db8::2/64".into()), + ..Default::default() + }); + let ipv4 = configuration.ipv4.unwrap(); + assert_eq!(ipv4.prefix_length, None); + assert_eq!(ipv4.netmask.as_deref(), Some("255.0.255.0")); + assert_eq!(ipv4.display(), "10.0.0.2 (mask 255.0.255.0)"); + assert_eq!(configuration.ipv6.unwrap().prefix_length, Some(64)); + assert_eq!(ipv4_prefix("0.0.0.0"), Some(0)); + assert_eq!(ipv4_prefix("255.255.255.255"), Some(32)); + assert_eq!(ipv6_prefix("2001:db8::2", "2001:db8::3/64"), None); + assert_eq!( + normalize(Configuration { + ipv4: Some("invalid".into()), + netmask: Some("255.255.255.0".into()), + ..Default::default() + }) + .ipv4 + .unwrap() + .prefix_length, + None + ); + assert_eq!( + normalize(Configuration { + ipv4: Some("10.0.0.2".into()), + ..Default::default() + }) + .ipv4 + .unwrap() + .prefix_length, + None + ); + } + + #[test] + fn escaped_route_lists_fit_the_contract_budget_without_claiming_completeness() { + let routes = NativeList { + items: vec!["\u{1}".repeat(1024); 16], + total_count: 20, + truncated: true, + }; + let configuration = normalize(Configuration { + included_routes: routes, + ..Default::default() + }); + assert!(serde_json::to_vec(&configuration).unwrap().len() <= MAX_CONFIGURATION_BYTES); + assert_eq!(configuration.included_routes.total_count, 20); + assert!(configuration.included_routes.truncated); + assert!(configuration.truncated); + assert!(configuration.included_routes.items.len() < 16); + } + + #[test] + fn control_characters_cannot_create_log_lines_or_terminal_sequences() { + assert_eq!(escaped("corp\n\u{1b}[2J"), "corp\\n\\u{1b}[2J"); + } +} diff --git a/crates/gptunnel/src/lib.rs b/crates/gptunnel/src/lib.rs new file mode 100644 index 0000000..6bc39ed --- /dev/null +++ b/crates/gptunnel/src/lib.rs @@ -0,0 +1,6 @@ +//! Shared observation of native tunnels, independent of terminal and service transport. + +mod configuration; +mod monitor; + +pub use monitor::{TunnelMonitor, TunnelUpdate}; diff --git a/crates/gptunnel/src/monitor.rs b/crates/gptunnel/src/monitor.rs new file mode 100644 index 0000000..01b634d --- /dev/null +++ b/crates/gptunnel/src/monitor.rs @@ -0,0 +1,637 @@ +use std::{ + sync::{Arc, Mutex, Weak}, + time::Duration, +}; + +use gpapi::session::tunnel::{ + TunnelPhase, TunnelState, TunnelStatistics, TunnelStatisticsSnapshot, TunnelStatisticsState, TunnelStatisticsView, + TunnelTransport, +}; +use log::{info, warn}; +use openconnect::{ + Vpn, + tunnel::{Event, Statistics, Transport}, +}; +use tokio::{ + sync::{Notify, watch}, + task::JoinHandle, + time::Instant, +}; +use uuid::Uuid; + +use crate::configuration::{log_configuration, normalize}; + +const SAMPLE_INTERVAL: Duration = Duration::from_secs(2); +const SAMPLE_TIMEOUT: Duration = Duration::from_secs(4); + +#[derive(Clone, Debug)] +pub struct TunnelUpdate { + pub state: TunnelState, + pub statistics: TunnelStatisticsSnapshot, +} + +struct RequestStamp { + generation: u64, + state_sequence: u64, + issued: Instant, +} + +struct RetainedSample { + value: TunnelStatistics, + acquired: Instant, +} + +struct Observation { + state: TunnelState, + sequence: u64, + statistics_sequence: u64, + started: Option, + ended_elapsed: Option, + configuration_observed: bool, + enabled: bool, + generation: u64, + pending: Option, + sample: Option, + statistics_state: TunnelStatisticsState, + finished: bool, + request_failed: bool, +} + +impl Observation { + fn new() -> Self { + Self { + state: TunnelState { + tunnel_id: Uuid::new_v4(), + sequence: 1, + phase: TunnelPhase::Establishing, + configuration_revision: 0, + configuration: None, + transport: TunnelTransport::Negotiating, + elapsed_ms: 0, + }, + sequence: 1, + statistics_sequence: 1, + started: None, + ended_elapsed: None, + configuration_observed: false, + enabled: false, + generation: 0, + pending: None, + sample: None, + statistics_state: TunnelStatisticsState::Disabled, + finished: false, + request_failed: false, + } + } + + fn next_sequence(&mut self) -> u64 { + // A 64-bit sequence cannot exhaust in a practical tunnel lifetime. Never + // wrap an ordering token into an earlier generation. + self.sequence = self + .sequence + .checked_add(1) + .expect("tunnel observation sequence exhausted"); + self.sequence + } + + fn elapsed_ms(&self, now: Instant) -> u64 { + if let Some(elapsed) = self.ended_elapsed { + return elapsed; + } + self + .started + .map_or(0, |started| millis(now.saturating_duration_since(started))) + } + + fn active(&self) -> bool { + !self.finished && self.state.phase == TunnelPhase::Connected && self.state.transport.is_active() + } + + fn project(&self, now: Instant) -> TunnelUpdate { + let mut state = self.state.clone(); + state.elapsed_ms = self.elapsed_ms(now); + let statistics = TunnelStatisticsSnapshot::Available(TunnelStatisticsView { + sequence: self.statistics_sequence, + tunnel_id: state.tunnel_id, + state_sequence: state.sequence, + phase: state.phase, + transport: state.transport, + state: self.statistics_state, + elapsed_ms: state.elapsed_ms, + sample_age_ms: self + .sample + .as_ref() + .map(|sample| millis(now.saturating_duration_since(sample.acquired))), + sample: self.sample.as_ref().map(|sample| sample.value.clone()), + }); + TunnelUpdate { state, statistics } + } + + fn invalidate_statistics(&mut self) { + self.statistics_state = if self.finished { + TunnelStatisticsState::Ended + } else if !self.enabled { + TunnelStatisticsState::Disabled + } else if self.sample.is_some() || !self.active() { + TunnelStatisticsState::Stale + } else { + TunnelStatisticsState::Waiting + }; + self.statistics_sequence = self.next_sequence(); + } + + fn state_changed(&mut self) { + self.state.sequence = self.next_sequence(); + self.invalidate_statistics(); + } + + fn enable(&mut self, enabled: bool) -> bool { + if self.finished || self.enabled == enabled { + return false; + } + self.enabled = enabled; + self.generation = self + .generation + .checked_add(1) + .expect("tunnel collection generation exhausted"); + self.statistics_state = if enabled { + TunnelStatisticsState::Waiting + } else { + TunnelStatisticsState::Disabled + }; + self.statistics_sequence = self.next_sequence(); + true + } + + fn finish(&mut self, now: Instant) { + if self.finished { + return; + } + self.ended_elapsed = Some(self.elapsed_ms(now)); + self.finished = true; + self.enabled = false; + self.pending = None; + self.state.phase = TunnelPhase::Ended; + self.state.transport = TunnelTransport::Unavailable; + self.state_changed(); + } + + /// Returns whether the configuration/transport should be logged. Logging is + /// performed outside the observation lock and never includes traffic samples. + fn apply(&mut self, event: Event, now: Instant) -> (bool, bool) { + if self.finished { + return (false, false); + } + match event { + Event::Configuration(configuration) => { + let configuration = configuration.map(normalize); + if self.configuration_observed && self.state.configuration == configuration { + return (false, false); + } + self.configuration_observed = true; + self.state.configuration = configuration; + self.state.configuration_revision = self + .state + .configuration_revision + .checked_add(1) + .expect("configuration revision exhausted"); + self.state_changed(); + (true, false) + } + Event::Established => { + self.started.get_or_insert(now); + if self.state.phase != TunnelPhase::Connected { + self.state.phase = TunnelPhase::Connected; + self.state_changed(); + } + (false, false) + } + Event::Reconnected => { + if self.started.is_some() && self.state.phase != TunnelPhase::Connected { + self.state.phase = TunnelPhase::Connected; + self.state_changed(); + } + (false, false) + } + Event::Reconnecting => { + let phase = if self.started.is_some() { + TunnelPhase::Reconnecting + } else { + TunnelPhase::Establishing + }; + if self.state.phase != phase { + self.state.phase = phase; + self.state_changed(); + } + (false, false) + } + Event::Transport(transport) => { + let transport = match transport { + Transport::Negotiating => TunnelTransport::Negotiating, + Transport::IpsecEsp => TunnelTransport::IpsecEsp, + Transport::SslTls => TunnelTransport::SslTls, + Transport::Unavailable => TunnelTransport::Unavailable, + }; + if self.state.transport == transport { + return (false, false); + } + self.state.transport = transport; + self.state_changed(); + (false, true) + } + Event::Statistics(statistics) => { + self.receive_statistics(statistics, now); + (false, false) + } + Event::Ended => { + self.finish(now); + (false, false) + } + } + } + + fn receive_statistics(&mut self, statistics: Statistics, now: Instant) { + let Some(stamp) = self.pending.take() else { + return; + }; + if !self.enabled + || !self.active() + || stamp.generation != self.generation + || stamp.state_sequence != self.state.sequence + { + return; + } + let sequence = self.next_sequence(); + self.sample = Some(RetainedSample { + value: TunnelStatistics { + tunnel_id: self.state.tunnel_id, + sequence, + state_sequence: self.state.sequence, + configuration_revision: self.state.configuration_revision, + elapsed_ms: self.elapsed_ms(now), + received_bytes: statistics.received_bytes, + sent_bytes: statistics.sent_bytes, + received_packets: statistics.received_packets, + sent_packets: statistics.sent_packets, + }, + acquired: now, + }); + self.statistics_sequence = sequence; + self.statistics_state = TunnelStatisticsState::Fresh; + } +} + +/// One native tunnel's negotiated state and optional sampler. The connection +/// owner must join `Vpn::connect` before calling `stop`. +pub struct TunnelMonitor { + vpn: Arc, + observation: Mutex, + updates: watch::Sender, + wake: Arc, + worker: Mutex>>, +} + +impl TunnelMonitor { + pub fn attach(vpn: Arc) -> Arc { + let observation = Observation::new(); + let (updates, _) = watch::channel(observation.project(Instant::now())); + let monitor = Arc::new(Self { + vpn, + observation: Mutex::new(observation), + updates, + wake: Arc::new(Notify::new()), + worker: Mutex::new(None), + }); + let observer = Arc::downgrade(&monitor); + monitor.vpn.set_tunnel_observer(move |event| { + if let Some(monitor) = observer.upgrade() { + monitor.observe(event); + } + }); + let worker = tokio::spawn(sample(Arc::downgrade(&monitor), monitor.wake.clone())); + *monitor.worker.lock().unwrap() = Some(worker); + monitor + } + + pub fn subscribe(&self) -> watch::Receiver { + self.updates.subscribe() + } + + pub fn state(&self) -> TunnelState { + self.observation.lock().unwrap().project(Instant::now()).state + } + + pub fn statistics(&self) -> TunnelStatisticsSnapshot { + self.observation.lock().unwrap().project(Instant::now()).statistics + } + + pub fn set_statistics_enabled(&self, enabled: bool) { + let mut observation = self.observation.lock().unwrap(); + if observation.enable(enabled) { + self.publish(&observation); + self.wake.notify_one(); + } + } + + /// End observation after native execution has returned. This does not request + /// VPN disconnect or take over its credential/network cleanup. + pub fn finish(&self) { + let mut observation = self.observation.lock().unwrap(); + observation.finish(Instant::now()); + self.publish(&observation); + drop(observation); + self.vpn.clear_tunnel_observer(); + self.wake.notify_one(); + } + + pub async fn stop(&self) { + self.finish(); + let worker = self.worker.lock().unwrap().take(); + if let Some(worker) = worker { + let _ = worker.await; + } + } + + fn publish(&self, observation: &Observation) { + self.updates.send_replace(observation.project(Instant::now())); + } + + fn observe(&self, event: Event) { + let is_statistics = matches!(event, Event::Statistics(_)); + let mut observation = self.observation.lock().unwrap(); + let (configuration_changed, transport_changed) = observation.apply(event, Instant::now()); + self.publish(&observation); + let state = observation.project(Instant::now()).state; + let retry = is_statistics + && observation.sample.as_ref().is_none_or(|sample| { + sample.value.state_sequence != observation.state.sequence + || observation.statistics_state != TunnelStatisticsState::Fresh + }); + drop(observation); + if configuration_changed { + log_configuration(&state); + } + if transport_changed { + info!("VPN transport: {}", state.transport.label()); + } + if !is_statistics || retry { + self.wake.notify_one(); + } + } + + fn request_sample(&self) -> bool { + let mut observation = self.observation.lock().unwrap(); + if observation.finished { + return false; + } + if !observation.enabled || !observation.active() { + return true; + } + let now = Instant::now(); + if let Some(pending) = &observation.pending { + if now.saturating_duration_since(pending.issued) >= SAMPLE_TIMEOUT + && observation.statistics_state != TunnelStatisticsState::Stale + { + observation.statistics_state = TunnelStatisticsState::Stale; + observation.statistics_sequence = observation.next_sequence(); + self.publish(&observation); + } + return true; + } + match self.vpn.request_statistics() { + Ok(true) => { + observation.pending = Some(RequestStamp { + generation: observation.generation, + state_sequence: observation.state.sequence, + issued: now, + }); + observation.request_failed = false; + } + Ok(false) => {} + Err(error) => { + if !observation.request_failed { + warn!("VPN statistics request failed: {error}"); + observation.request_failed = true; + } + observation.statistics_state = TunnelStatisticsState::Stale; + observation.statistics_sequence = observation.next_sequence(); + self.publish(&observation); + } + } + true + } +} + +impl Drop for TunnelMonitor { + fn drop(&mut self) { + self.vpn.clear_tunnel_observer(); + if let Some(worker) = self.worker.get_mut().unwrap().take() { + worker.abort(); + } + } +} + +async fn sample(monitor: Weak, wake: Arc) { + loop { + let enabled = { + let Some(monitor) = monitor.upgrade() else { + return; + }; + if !monitor.request_sample() { + return; + } + monitor.observation.lock().unwrap().enabled + }; + if enabled { + tokio::select! { + _ = wake.notified() => {} + _ = tokio::time::sleep(SAMPLE_INTERVAL) => {} + } + } else { + wake.notified().await; + } + } +} + +fn millis(duration: Duration) -> u64 { + duration.as_millis().min(u64::MAX as u128) as u64 +} + +#[cfg(test)] +mod tests { + use super::*; + + fn connected(now: Instant) -> Observation { + let mut observation = Observation::new(); + observation.apply(Event::Established, now); + observation.apply(Event::Transport(Transport::IpsecEsp), now); + observation + } + + fn request(observation: &mut Observation, now: Instant) { + observation.pending = Some(RequestStamp { + generation: observation.generation, + state_sequence: observation.state.sequence, + issued: now, + }); + } + + #[test] + fn retries_before_first_tun_establishment_do_not_start_session_elapsed_time() { + let now = Instant::now(); + let mut observation = Observation::new(); + observation.apply(Event::Reconnecting, now); + observation.apply(Event::Reconnected, now + Duration::from_secs(10)); + let update = observation.project(now + Duration::from_secs(60)); + assert_eq!(update.state.phase, TunnelPhase::Establishing); + assert_eq!(update.state.elapsed_ms, 0); + assert_eq!(update.statistics.view().unwrap().elapsed_ms, 0); + observation.apply(Event::Established, now + Duration::from_secs(61)); + assert_eq!( + observation.project(now + Duration::from_secs(62)).state.elapsed_ms, + 1000 + ); + } + + #[test] + fn late_sample_after_disable_reenable_cannot_become_fresh() { + let now = Instant::now(); + let mut observation = connected(now); + observation.enable(true); + request(&mut observation, now); + observation.enable(false); + observation.enable(true); + observation.receive_statistics( + Statistics { + received_bytes: 5, + ..Default::default() + }, + now, + ); + assert!(observation.pending.is_none()); + assert!(observation.sample.is_none()); + assert_eq!(observation.statistics_state, TunnelStatisticsState::Waiting); + request(&mut observation, now); + observation.receive_statistics( + Statistics { + received_bytes: 8, + ..Default::default() + }, + now, + ); + assert_eq!(observation.sample.as_ref().unwrap().value.received_bytes, 8); + assert_eq!(observation.statistics_state, TunnelStatisticsState::Fresh); + } + + #[test] + fn reconnect_preserves_elapsed_and_rejects_old_transport_sample() { + let now = Instant::now(); + let mut observation = connected(now); + observation.enable(true); + request(&mut observation, now); + observation.apply(Event::Reconnecting, now + Duration::from_secs(2)); + observation.apply(Event::Transport(Transport::Unavailable), now + Duration::from_secs(2)); + observation.apply(Event::Reconnected, now + Duration::from_secs(5)); + observation.apply(Event::Transport(Transport::SslTls), now + Duration::from_secs(5)); + observation.receive_statistics(Statistics::default(), now + Duration::from_secs(5)); + assert!(observation.sample.is_none()); + request(&mut observation, now + Duration::from_secs(5)); + observation.receive_statistics( + Statistics { + sent_bytes: 40, + ..Default::default() + }, + now + Duration::from_secs(6), + ); + assert_eq!(observation.elapsed_ms(now + Duration::from_secs(6)), 6000); + assert_eq!(observation.sample.as_ref().unwrap().value.sent_bytes, 40); + assert_eq!(observation.statistics_state, TunnelStatisticsState::Fresh); + } + + #[test] + fn time_projection_does_not_poll_or_rewrite_acquisition_time() { + let now = Instant::now(); + let mut observation = connected(now); + observation.enable(true); + request(&mut observation, now); + observation.receive_statistics(Statistics::default(), now + Duration::from_secs(1)); + let later = observation.project(now + Duration::from_secs(600)); + assert_eq!(later.state.elapsed_ms, 600000); + let view = later.statistics.view().unwrap(); + assert_eq!(view.sample_age_ms, Some(599000)); + assert_eq!(view.sample.as_ref().unwrap().elapsed_ms, 1000); + assert!(observation.pending.is_none()); + observation.finish(now + Duration::from_secs(601)); + assert_eq!( + observation.project(now + Duration::from_secs(700)).state.elapsed_ms, + 601000 + ); + } + + #[cfg(unix)] + #[tokio::test(start_paused = true)] + async fn sampling_is_demand_driven_and_coalesces_commands_on_the_native_pipe() { + use std::{ + io::Read, + os::{fd::AsRawFd, unix::net::UnixStream}, + }; + + unsafe extern "C" { + fn vpn_attach_command_pipe(vpn: *mut std::ffi::c_void, fd: std::ffi::c_int) -> std::ffi::c_int; + fn vpn_detach_command_pipe(vpn: *mut std::ffi::c_void); + } + + let vpn = Arc::new( + Vpn::builder("vpn.example.com", "cookie") + .network_configuration_handler(|_| Ok(())) + .build() + .unwrap(), + ); + let (sender, mut receiver) = UnixStream::pair().unwrap(); + sender.set_nonblocking(true).unwrap(); + receiver.set_nonblocking(true).unwrap(); + let pointer = Arc::as_ptr(&vpn).cast_mut().cast(); + // SAFETY: this test owns the live Vpn and both socket endpoints, and detaches + // the borrowed command descriptor before either endpoint or Vpn is dropped. + assert_eq!(unsafe { vpn_attach_command_pipe(pointer, sender.as_raw_fd()) }, 0); + let monitor = TunnelMonitor::attach(vpn.clone()); + monitor.observe(Event::Established); + monitor.observe(Event::Transport(Transport::IpsecEsp)); + tokio::task::yield_now().await; + tokio::time::advance(Duration::from_secs(60)).await; + tokio::task::yield_now().await; + let mut command = [0]; + assert_eq!( + receiver.read(&mut command).unwrap_err().kind(), + std::io::ErrorKind::WouldBlock + ); + assert!(monitor.observation.lock().unwrap().pending.is_none()); + assert_eq!( + monitor.statistics().view().unwrap().state, + TunnelStatisticsState::Disabled + ); + + monitor.set_statistics_enabled(true); + tokio::task::yield_now().await; + assert_eq!(receiver.read(&mut command).unwrap(), 1); + assert_eq!(command, [b's']); + tokio::time::advance(Duration::from_secs(6)).await; + tokio::task::yield_now().await; + assert_eq!( + receiver.read(&mut command).unwrap_err().kind(), + std::io::ErrorKind::WouldBlock + ); + assert_eq!(monitor.statistics().view().unwrap().state, TunnelStatisticsState::Stale); + monitor.set_statistics_enabled(false); + tokio::time::advance(Duration::from_secs(60)).await; + tokio::task::yield_now().await; + assert_eq!( + receiver.read(&mut command).unwrap_err().kind(), + std::io::ErrorKind::WouldBlock + ); + + monitor.stop().await; + // SAFETY: pointer still identifies the Vpn retained by this test. + unsafe { vpn_detach_command_pipe(pointer) }; + } +} diff --git a/crates/gpvpnc/Cargo.toml b/crates/gpvpnc/Cargo.toml new file mode 100644 index 0000000..2113cfa --- /dev/null +++ b/crates/gpvpnc/Cargo.toml @@ -0,0 +1,9 @@ +[package] +name = "gpvpnc" +rust-version.workspace = true +version.workspace = true +edition.workspace = true +license.workspace = true + +[target.'cfg(target_os = "macos")'.dependencies] +log.workspace = true diff --git a/crates/gpvpnc/src/lib.rs b/crates/gpvpnc/src/lib.rs new file mode 100644 index 0000000..ed50e7d --- /dev/null +++ b/crates/gpvpnc/src/lib.rs @@ -0,0 +1,2 @@ +#[cfg(target_os = "macos")] +pub mod macos; diff --git a/crates/gpvpnc/src/macos-vpnc-script.sh b/crates/gpvpnc/src/macos-vpnc-script.sh new file mode 100644 index 0000000..857769f --- /dev/null +++ b/crates/gpvpnc/src/macos-vpnc-script.sh @@ -0,0 +1,1183 @@ +#!/bin/sh +# +# Originally part of vpnc source code: +# © 2005-2012 Maurice Massar, Jörg Mayer, Antonio Borneo et al. +# © 2009-2022 David Woodhouse , Daniel Lenski et al. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +# +################ +# +# List of parameters passed through environment +#* reason -- why this script was called, one of: pre-init connect disconnect reconnect attempt-reconnect +#* VPNGATEWAY -- VPN gateway address (always present) +#* VPNPID -- PID of the process controlling the VPN (OpenConnect v9.0+) +#* TUNDEV -- tunnel device (always present) +#* IDLE_TIMEOUT -- gateway's idle timeout in seconds (OpenConnect v8.06+); unused +#* LOG_LEVEL -- log level; ERROR=0, INFO=1, DEBUG=2, TRACE=3 (OpenConnect v9.0+) +#* INTERNAL_IP4_ADDRESS -- address (always present) +#* INTERNAL_IP4_MTU -- MTU (often unset) +#* INTERNAL_IP4_NETMASK -- netmask (often unset) +#* INTERNAL_IP4_NETMASKLEN -- netmask length (often unset) +#* INTERNAL_IP4_NETADDR -- address of network (only present if netmask is set) +#* INTERNAL_IP4_DNS -- list of DNS servers +#* INTERNAL_IP4_NBNS -- list of WINS servers +#* INTERNAL_IP6_ADDRESS -- IPv6 address +#* INTERNAL_IP6_NETMASK -- IPv6 netmask +#* INTERNAL_IP6_DNS -- IPv6 list of dns servers +#* CISCO_DEF_DOMAIN -- default domain name +#* CISCO_BANNER -- banner from server +#* CISCO_SPLIT_DNS -- DNS search domain list +#* CISCO_SPLIT_INC -- number of networks in split-network-list +#* CISCO_SPLIT_INC_%d_ADDR -- network address +#* CISCO_SPLIT_INC_%d_MASK -- subnet mask (for example: 255.255.255.0) +#* CISCO_SPLIT_INC_%d_MASKLEN -- subnet masklen (for example: 24) +#* CISCO_SPLIT_INC_%d_PROTOCOL -- protocol (often just 0); unused +#* CISCO_SPLIT_INC_%d_SPORT -- source port (often just 0); unused +#* CISCO_SPLIT_INC_%d_DPORT -- destination port (often just 0); unused +#* CISCO_IPV6_SPLIT_INC -- number of networks in IPv6 split-network-list +#* CISCO_IPV6_SPLIT_INC_%d_ADDR -- IPv6 network address +#* CISCO_IPV6_SPLIT_INC_$%d_MASKLEN -- IPv6 subnet masklen +# +# The split tunnel variables above have *_EXC* counterparts for network +# addresses to be excluded from the VPN tunnel. + +# FIXMEs: + +# Section A: route handling + +# 1) The 3 values CISCO_SPLIT_INC_%d_PROTOCOL/SPORT/DPORT are currently being ignored +# In order to use them, we'll probably need os specific solutions +# * Linux: iptables -t mangle -I PREROUTING -j ROUTE --oif $TUNDEV +# This would be an *alternative* to changing the routes (and thus 2) and 3) +# shouldn't be relevant at all) +# 2) There are two different functions to set routes: generic routes and the +# default route. Why isn't the defaultroute handled via the generic route case? +# 3) In the split tunnel case, all routes but the default route might get replaced +# without getting restored later. We should explicitly check and save them just +# like the defaultroute +# 4) Replies to a dhcp-server should never be sent into the tunnel + +# Section B: Split DNS handling + +# 1) Maybe dnsmasq can do something like that +# 2) Parse DNS packets going out via tunnel and redirect them to original DNS-server + +# ======== For test logging (CI/CD will uncomment automatically) ========= + +#TRACE# echo "------------------" +#TRACE# echo "vpnc-script environment:" +#TRACE# env | grep -E '^(CISCO_|INTERNAL_IP|VPNGATEWAY|TUNDEV|IDLE_TIMEOUT|reason)' | sort +#TRACE# echo "------------------" +#TRACE# set -x + +# =========== script (variable) setup ==================================== + +PATH=/sbin:/usr/sbin:$PATH + +OS="`uname -s`" + +# Use the PID of the controlling process (vpnc or OpenConnect) to +# uniquely identify this VPN connection. Normally, the parent process +# is a shell, and the grandparent's PID is the relevant one. +# OpenConnect v9.0+ provides VPNPID, so we don't need to determine it. +if [ -z "$VPNPID" ]; then + VPNPID=$PPID + PCMD=`ps -c -o command= -p $PPID` + case "$PCMD" in + *sh) VPNPID=`ps -o ppid= -p $PPID` ;; + esac +fi + +DEFAULT_ROUTE_FILE=/var/run/vpnc/defaultroute.${VPNPID} +DEFAULT_ROUTE_FILE_IPV6=/var/run/vpnc/defaultroute_ipv6.${VPNPID} +RESOLV_CONF_BACKUP=/var/run/vpnc/resolv.conf-backup.${VPNPID} +SCRIPTNAME=$(basename "$0") + +# some systems, eg. Darwin & FreeBSD, prune /var/run on boot +if [ ! -d "/var/run/vpnc" ]; then + mkdir -p /var/run/vpnc + [ -x /sbin/restorecon ] && /sbin/restorecon /var/run/vpnc +fi + +if ifconfig --help 2>&1 | grep BusyBox > /dev/null; then + ifconfig_syntax_inet="" +else + ifconfig_syntax_inet="inet" +fi + +if [ "$OS" = "Linux" ]; then + IPROUTE="`command -v ip | grep '^/'`" + ifconfig_syntax_ptp="pointopoint" + route_syntax_gw="gw" + route_syntax_del="del" + route_syntax_netmask="netmask" + route_syntax_inet6="-6" + route_syntax_inet6_host="-6" + route_syntax_inet6_net="-6" + ifconfig_syntax_add_inet6="add" + ifconfig_syntax_del() { case "$1" in *:*) echo del "$1" ;; *) echo 0.0.0.0 ;; esac; } + netstat_syntax_ipv6="-6" +else + # iproute2 is Linux only; if `command -v ip` returns something on another OS, it's likely an unrelated tool + # (see https://github.com/dlenski/openconnect/issues/132#issuecomment-470475009) + IPROUTE="" + ifconfig_syntax_ptp="" + route_syntax_gw="" + route_syntax_del="delete" + route_syntax_netmask="-netmask" + route_syntax_inet6="-inet6" + route_syntax_inet6_host="-inet6 -host" + route_syntax_inet6_net="-inet6 -net" + ifconfig_syntax_del() { case "$1" in *:*) echo inet6 "$1" delete ;; *) echo "$1" delete ;; esac; } + ifconfig_syntax_add_inet6="inet6" + netstat_syntax_ipv6="-f inet6" +fi +if [ "$OS" = "SunOS" ]; then + route_syntax_interface="-interface" + ifconfig_syntax_ptpv6="$INTERNAL_IP6_ADDRESS" +else + route_syntax_interface="" + ifconfig_syntax_ptpv6="" +fi + +RESOLVEDENABLED=0 +# detect usage of systemd-resolved via nss-resolve... +grep '^hosts' /etc/nsswitch.conf 2>/dev/null | grep resolve >/dev/null 2>&1 || \ +# or via nss-dns with /etc/resolv.conf under control of systemd-resolved +(grep '^hosts' /etc/nsswitch.conf 2>/dev/null | grep dns >/dev/null 2>&1 && readlink /etc/resolv.conf | grep -e '/run/systemd/resolve/stub-resolv.conf$' -e '/usr/lib/systemd/resolv.conf$' -e '/run/systemd/resolve/resolv.conf$' >/dev/null 2>&1) +if [ $? = 0 ];then + command resolvectl status >/dev/null 2>&1 || command systemd-resolve --status >/dev/null 2>&1 + if [ $? = 0 ];then + RESOLVEDENABLED=1 + fi +fi + +if [ -r /etc/openwrt_release ] && [ -n "$OPENWRT_INTERFACE" ]; then + . /etc/functions.sh + include /lib/network + MODIFYRESOLVCONF=modify_resolvconf_openwrt + RESTORERESOLVCONF=restore_resolvconf_openwrt +elif [ -x /usr/bin/resolvectl ] && [ ${RESOLVEDENABLED} = 1 ]; then + # For systemd-resolved (version 239 and above) + MODIFYRESOLVCONF=modify_resolved_manager + RESTORERESOLVCONF=restore_resolved_manager +elif [ -x /usr/bin/busctl ] && [ ${RESOLVEDENABLED} = 1 ]; then + # For systemd-resolved (version 229 and above) + MODIFYRESOLVCONF=modify_resolved_manager_old + RESTORERESOLVCONF=restore_resolved_manager_old +elif [ -x /sbin/resolvconf ] && [ "`basename $(readlink /sbin/resolvconf) 2> /dev/null`" != resolvectl ]; then + # Optional tool on Debian, Ubuntu, Gentoo, FreeBSD and DragonFly BSD + # (ignored if symlink to resolvctl, created by some versions of systemd-resolved) + MODIFYRESOLVCONF=modify_resolvconf_manager + RESTORERESOLVCONF=restore_resolvconf_manager +elif [ -x /sbin/netconfig ] && [ ! -f /etc/slackware-version ]; then + # tool on Suse after 11.1 + # Slackware's netconfig is an unrelated tool that should not be invoked here + # (see https://www.linuxquestions.org/questions/slackware-14/vpnc-on-slackware-14-2-is-bringing-up-network-configuration-dialog-each-time-4175595447/#post5646866) + MODIFYRESOLVCONF=modify_resolvconf_suse_netconfig + RESTORERESOLVCONF=restore_resolvconf_suse_netconfig +elif [ -x /sbin/modify_resolvconf ]; then + # Mandatory tool on Suse earlier than 11.1 + MODIFYRESOLVCONF=modify_resolvconf_suse + RESTORERESOLVCONF=restore_resolvconf_suse +elif [ -x /usr/sbin/unbound-control ] && /usr/sbin/unbound-control status > /dev/null 2>&1; then + MODIFYRESOLVCONF=modify_resolvconf_unbound + RESTORERESOLVCONF=restore_resolvconf_unbound +elif [ -x /usr/sbin/rcctl ] && /usr/sbin/rcctl check resolvd >/dev/null; then + # OpenBSD's resolvd by sending route messages + MODIFYRESOLVCONF=modify_resolvconf_resolvd + RESTORERESOLVCONF=restore_resolvconf_resolvd +else # Generic for any OS + MODIFYRESOLVCONF=modify_resolvconf_generic + RESTORERESOLVCONF=restore_resolvconf_generic +fi + + +# =========== tunnel interface handling ==================================== + +do_ifconfig() { + if [ -n "$INTERNAL_IP4_MTU" ]; then + MTU=$INTERNAL_IP4_MTU + elif [ -n "$IPROUTE" ]; then + MTUDEV=`$IPROUTE route get "$VPNGATEWAY" | sed -ne 's/^.*dev \([a-z0-9]*\).*$/\1/p'` + MTU=`$IPROUTE link show "$MTUDEV" | sed -ne 's/^.*mtu \([[:digit:]]\+\).*$/\1/p'` + if [ -n "$MTU" ]; then + MTU=`expr $MTU - 88` + fi + fi + + if [ -z "$MTU" ]; then + MTU=1412 + fi + + # Point to point interface require a netmask of 255.255.255.255 on some systems + if [ -n "$IPROUTE" ]; then + $IPROUTE link set dev "$TUNDEV" up mtu "$MTU" + $IPROUTE addr add "$INTERNAL_IP4_ADDRESS/32" peer "$INTERNAL_IP4_ADDRESS" dev "$TUNDEV" + else + ifconfig "$TUNDEV" ${ifconfig_syntax_inet} "$INTERNAL_IP4_ADDRESS" $ifconfig_syntax_ptp "$INTERNAL_IP4_ADDRESS" netmask 255.255.255.255 mtu ${MTU} up + fi + + if [ -n "$INTERNAL_IP4_NETMASK" ]; then + set_network_route "$INTERNAL_IP4_NETADDR" "$INTERNAL_IP4_NETMASK" "$INTERNAL_IP4_NETMASKLEN" "$TUNDEV" + fi + + # If the netmask is provided, it contains the address _and_ netmask + if [ -n "$INTERNAL_IP6_ADDRESS" ] && [ -z "$INTERNAL_IP6_NETMASK" ]; then + INTERNAL_IP6_NETMASK="$INTERNAL_IP6_ADDRESS/128" + fi + if [ -n "$INTERNAL_IP6_NETMASK" ]; then + if [ -n "$IPROUTE" ]; then + $IPROUTE -6 addr add $INTERNAL_IP6_NETMASK dev $TUNDEV + else + # Unlike for Legacy IP, we don't specify the dest_address + # here on *BSD. OpenBSD for one will refuse to accept + # incoming packets to that address if we do. + # OpenVPN does the same (gives dest_address for Legacy IP + # but not for IPv6). + # Only Solaris needs it; hence $ifconfig_syntax_ptpv6 + ifconfig "$TUNDEV" $ifconfig_syntax_add_inet6 $INTERNAL_IP6_NETMASK $ifconfig_syntax_ptpv6 mtu $MTU up + fi + fi +} + +# =========== route handling ==================================== + +if [ -n "$IPROUTE" ]; then + fix_ip_get_output () { + sed -e 's/ /\n/g' | \ + sed -ne "1 s|\$|${1}|p;/via/{N;p};/dev/{N;p};/src/{N;p};/mtu/{N;p};/metric/{N;p};/onlink/{p}" + } + + # returns all routes to a destination *except* those through $TUNDEV, + # sorted by increasing metric (with absent metric as last) + list_non_loopback_routes () { + echo "$1" | grep -q : && FAMILY=-6 ROOT=::/0 || FAMILY=-4 ROOT=0/0 + # put metric in front, sort by metric, then chop off first two fields (metric and destination) + $IPROUTE $FAMILY route show to "$1" root "$ROOT" | + awk '/dev '"$TUNDEV"'/ { next; } { printf "%s %s\n", (match($0, /metric ([^ ]+)/) ? substr($0, RSTART+7, RLENGTH-7) : 4294967295), $0; }' | + sort -n | cut -d' ' -f3- + } + + set_vpngateway_route() { + # We'll attempt to add a host route to the gateway through every route that matches + # its address (excluding those through TUNDEV because the goal is to avoid loopback). + echo "$VPNGATEWAY" | grep -q : && FAMILY=-6 || FAMILY=-4 + + list_non_loopback_routes "$VPNGATEWAY" | + while read LINE ; do + # We do not want to use 'replace', since a route to the gateway that already + # exists is mostly likely the correct one (e.g. the case of a reconnect attempt + # after dead-peer detection, but no change in the underlying network devices). + $IPROUTE $FAMILY route add `echo "$VPNGATEWAY $LINE" | fix_ip_get_output` 2>/dev/null + done + if [ $FAMILY != -4 ]; then + $IPROUTE $FAMILY route flush cache 2>/dev/null + fi + } + + del_vpngateway_route() { + echo "$VPNGATEWAY" | grep -q : && FAMILY=-6 || FAMILY=-4 + + $IPROUTE route $route_syntax_del "$VPNGATEWAY" + if [ $FAMILY != -4 ]; then + $IPROUTE $FAMILY route flush cache 2>/dev/null + fi + } + + set_default_route() { + $IPROUTE route | grep '^default' | fix_ip_get_output > "$DEFAULT_ROUTE_FILE" + $IPROUTE route replace default dev "$TUNDEV" + } + + set_network_route() { + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + NETDEV="$4" + NETGW="$5" + if [ -n "$NETGW" ]; then + $IPROUTE route replace "$NETWORK/$NETMASKLEN" dev "$NETDEV" via "$NETGW" + else + $IPROUTE route replace "$NETWORK/$NETMASKLEN" dev "$NETDEV" + fi + } + + set_exclude_route() { + # add explicit route to keep current routing for this target + # (keep traffic separate from VPN tunnel) + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + list_non_loopback_routes "$NETWORK/$NETMASKLEN" | + while read LINE ; do + $IPROUTE route add `echo "$NETWORK/$NETMASKLEN $LINE" | fix_ip_get_output` 2>/dev/null + done + } + + del_exclude_route() { + # FIXME: In theory, this could delete existing routes which are + # identical to split-exclude routes specified by VPNGATEWAY + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + $IPROUTE route $route_syntax_del "$NETWORK/$NETMASKLEN" + } + + reset_default_route() { + if [ -s "$DEFAULT_ROUTE_FILE" ]; then + $IPROUTE route replace `cat "$DEFAULT_ROUTE_FILE"` + rm -f -- "$DEFAULT_ROUTE_FILE" + fi + } + + del_network_route() { + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + NETDEV="$4" + $IPROUTE route $route_syntax_del "$NETWORK/$NETMASKLEN" dev "$NETDEV" + } + + set_ipv6_default_route() { + # We don't save/restore IPv6 default route; just add a higher-priority one. + $IPROUTE -6 route add default dev "$TUNDEV" metric 1 + $IPROUTE -6 route flush cache 2>/dev/null + } + + set_ipv6_network_route() { + NETWORK="$1" + NETMASKLEN="$2" + NETDEV="$3" + NETGW="$4" + if [ -n "$NETGW" ]; then + $IPROUTE -6 route replace "$NETWORK/$NETMASKLEN" dev "$NETDEV" via "$NETGW" + else + $IPROUTE -6 route replace "$NETWORK/$NETMASKLEN" dev "$NETDEV" + fi + $IPROUTE -6 route flush cache 2>/dev/null + } + + set_ipv6_exclude_route() { + NETWORK="$1" + NETMASKLEN="$2" + set_exclude_route "$NETWORK" nomask "$NETMASKLEN" + } + + reset_ipv6_default_route() { + $IPROUTE -6 route del default dev "$TUNDEV" + $IPROUTE -6 route flush cache 2>/dev/null + } + + del_ipv6_network_route() { + NETWORK="$1" + NETMASKLEN="$2" + NETDEV="$3" + $IPROUTE -6 route del "$NETWORK/$NETMASKLEN" dev "$NETDEV" + $IPROUTE -6 route flush cache 2>/dev/null + } + + del_ipv6_exclude_route() { + # FIXME: In theory, this could delete existing routes which are + # identical to split-exclude routes specified by VPNGATEWAY + NETWORK="$1" + NETMASKLEN="$2" + $IPROUTE -6 route del "$NETWORK/$NETMASKLEN" + $IPROUTE -6 route flush cache 2>/dev/null + } +else # use route command + get_default_gw() { + # Intended behavior, starting with `netstat -r -n` output: + # - keep lines starting with 'default' or '0.0.0.0', but exclude bogus routes '0.0.0.0/nn' where nn != 0 + # - remove lines containing IPv6 addresses (':') + # - remove lines for link-local routes (https://superuser.com/a/1067742) + # - remove lines containing $TUNDEV (we don't want loopback) + netstat -r -n | awk '/:/ { next; } /link#/ { next; } /^(default|0\.0\.0\.0([[:space:]]|\/0))/ { print $2; exit; } /[[:space:]]'"$TUNDEV"'([[:space:]]|$)/ { next; }' + } + + set_vpngateway_route() { + # Unlike with iproute2, there is no way to determine which current + # route(s) match the VPN gateway, so we simply find a default + # route and use its gateway. + case "$VPNGATEWAY" in + *:*) route add $route_syntax_inet6_host "$VPNGATEWAY" $route_syntax_gw "`get_ipv6_default_gw`";; + *) route add -host "$VPNGATEWAY" $route_syntax_gw "`get_default_gw`";; + esac + } + + del_vpngateway_route() { + case "$VPNGATEWAY" in + *:*) route $route_syntax_del $route_syntax_inet6_host "$VPNGATEWAY" $route_syntax_gw "`get_ipv6_default_gw`";; + *) route $route_syntax_del -host "$VPNGATEWAY" $route_syntax_gw "`get_default_gw`";; + esac + } + + set_default_route() { + DEFAULTGW="`get_default_gw`" + echo "$DEFAULTGW" > "$DEFAULT_ROUTE_FILE" + route $route_syntax_del default $route_syntax_gw "$DEFAULTGW" + route add default $route_syntax_gw "$INTERNAL_IP4_ADDRESS" $route_syntax_interface + } + + set_network_route() { + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + if [ -n "$5" ]; then + NETGW="$5" + else + NETGW="$INTERNAL_IP4_ADDRESS" + fi + # ifconfig already installs the tunnel's /32 route. macOS rejects + # adding another route to that address through itself as a gateway. + if [ "$NETMASKLEN" = 32 ] && [ "$NETWORK" = "$INTERNAL_IP4_ADDRESS" ] && [ "$NETGW" = "$INTERNAL_IP4_ADDRESS" ]; then + return 0 + fi + route add -net "$NETWORK" $route_syntax_netmask "$NETMASK" $route_syntax_gw "$NETGW" $route_syntax_interface + } + + set_exclude_route() { + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + DEFAULTGW="${DEFAULTGW:-`get_default_gw`}" + if [ -z "$DEFAULTGW" ]; then + echo "cannot find route for exclude route $NETWORK/$NETMASKLEN, ignoring" >&2 + return + fi + # Add explicit route to keep traffic for this target separate + # from tunnel. FIXME: We use default gateway - this is our best + # guess in absence of "ip" command to query effective route. + route add -net "$NETWORK" $route_syntax_netmask "$NETMASK" $route_syntax_gw "$DEFAULTGW" $route_syntax_interface + } + + del_exclude_route() { + # FIXME: This can delete existing routes in case they're + # identical to split-exclude routes specified by VPNGATEWAY + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + route $route_syntax_del -net "$NETWORK" $route_syntax_netmask "$NETMASK" + } + + reset_default_route() { + if [ -s "$DEFAULT_ROUTE_FILE" ]; then + route $route_syntax_del default $route_syntax_gw `get_default_gw` $route_syntax_interface + route add default $route_syntax_gw `cat "$DEFAULT_ROUTE_FILE"` + rm -f -- "$DEFAULT_ROUTE_FILE" + fi + } + + del_network_route() { + NETWORK="$1" + NETMASK="$2" + NETMASKLEN="$3" + if [ -n "$5" ]; then + NETGW="$5" + else + NETGW="$INTERNAL_IP4_ADDRESS" + fi + # Leave the automatically installed tunnel route to interface teardown. + if [ "$NETMASKLEN" = 32 ] && [ "$NETWORK" = "$INTERNAL_IP4_ADDRESS" ] && [ "$NETGW" = "$INTERNAL_IP4_ADDRESS" ]; then + return 0 + fi + route $route_syntax_del -net "$NETWORK" $route_syntax_netmask "$NETMASK" $route_syntax_gw "$NETGW" + } + + get_ipv6_default_gw() { + # Intended behavior, starting with `netstat -r -n` IPv6 output: + # - keep lines starting with 'default' or '::' + # - append %$interface to link-local routes (fe80::/10) + # - remove lines for loopback interface (lo) + # - remove lines containing $TUNDEV (we don't want loopback) + # FIXME: is there a better way to exclude loopback routes than filtering interface /^lo/? + netstat -r -n $netstat_syntax_ipv6 | awk '/^(default|::\/0)/ { if ($NF!~/^lo/ && $NF!~/'"$TUNDEV"'([[:space:]]|$)/) { print ($2~/^fe[89ab]/ ? $2"%"$NF : $2); } }' + } + + set_ipv6_default_route() { + DEFAULTGW="`get_ipv6_default_gw`" + echo "$DEFAULTGW" > "$DEFAULT_ROUTE_FILE_IPV6" + route $route_syntax_del $route_syntax_inet6 default $route_syntax_gw "$DEFAULTGW" + route add $route_syntax_inet6 default $route_syntax_gw "$INTERNAL_IP6_ADDRESS" $route_syntax_interface + } + + set_ipv6_network_route() { + NETWORK="$1" + NETMASK="$2" + DEVICE="$3" + if [ -n "$4" ]; then + NETGW="$4" + elif [ "$OS" = "Linux" ]; then + route add $route_syntax_inet6_net "$NETWORK/$NETMASK" dev "$DEVICE" + return + else + NETGW="$INTERNAL_IP6_ADDRESS" + fi + + route add $route_syntax_inet6_net "$NETWORK/$NETMASK" $route_syntax_gw "$NETGW" $route_syntax_interface + : + } + + set_ipv6_exclude_route() { + NETWORK="$1" + NETMASK="$2" + IPV6DEFAULTGW="${IPV6DEFAULTGW:-`get_ipv6_default_gw`}" + if [ -z "$IPV6DEFAULTGW" ]; then + echo "cannot find route for exclude route $NETWORK/$NETMASKLEN, ignoring" >&2 + return + fi + # Add explicit route to keep traffic for this target separate + # from tunnel. FIXME: We use default gateway - this is our best + # guess in absence of "ip" command to query effective route. + route add $route_syntax_inet6_net "$NETWORK/$NETMASK" "$IPV6DEFAULTGW" $route_syntax_interface + : + } + + reset_ipv6_default_route() { + if [ -s "$DEFAULT_ROUTE_FILE_IPV6" ]; then + route $route_syntax_del $route_syntax_inet6 default $route_syntax_gw "`get_ipv6_default_gw`" $route_syntax_interface + route add $route_syntax_inet6 default $route_syntax_gw `cat "$DEFAULT_ROUTE_FILE_IPV6"` + rm -f -- "$DEFAULT_ROUTE_FILE_IPV6" + fi + : + } + + del_ipv6_network_route() { + NETWORK="$1" + NETMASK="$2" + DEVICE="$3" + if [ -n "$4" ]; then + NETGW="$4" + elif [ "$OS" = "Linux" ]; then + route $route_syntax_del $route_syntax_inet6 "$NETWORK/$NETMASK" dev "$DEVICE" + return + else + NETGW="$INTERNAL_IP6_ADDRESS" + fi + route $route_syntax_del $route_syntax_inet6 "$NETWORK/$NETMASK" $route_syntax_gw "$NETGW" + : + } + + del_ipv6_exclude_route() { + NETWORK="$1" + NETMASK="$2" + route $route_syntax_del $route_syntax_inet6 "$NETWORK/$NETMASK" + : + } + +fi + +# =========== resolv.conf handling ==================================== + +# =========== resolv.conf handling for any OS ========================= + +modify_resolvconf_generic() { + grep '^#@VPNC_GENERATED@' /etc/resolv.conf > /dev/null 2>&1 || cp -- /etc/resolv.conf "$RESOLV_CONF_BACKUP" + NEW_RESOLVCONF="#@VPNC_GENERATED@ -- this file is generated by vpnc +# and will be overwritten by vpnc +# as long as the above mark is intact" + + DOMAINS="$CISCO_DEF_DOMAIN" + + exec 6< "$RESOLV_CONF_BACKUP" + while read LINE <&6 ; do + case "$LINE" in + # omit; we will overwrite these + nameserver*) ;; + # extract listed domains and prepend to list + domain* | search*) DOMAINS="${LINE#* } $DOMAINS" ;; + # retain other lines + *) NEW_RESOLVCONF="$NEW_RESOLVCONF +$LINE" ;; + esac + done + exec 6<&- + + for i in $INTERNAL_IP4_DNS ; do + NEW_RESOLVCONF="$NEW_RESOLVCONF +nameserver $i" + done + # note that "search" is mutually exclusive with "domain"; + # "search" allows multiple domains to be listed, so use that + if [ -n "$DOMAINS" ]; then + NEW_RESOLVCONF="$NEW_RESOLVCONF +search $DOMAINS" + fi + echo "$NEW_RESOLVCONF" > /etc/resolv.conf + + if [ "$OS" = "Darwin" ]; then + case "`uname -r`" in + # Skip for pre-10.4 systems + 4.*|5.*|6.*|7.*) + ;; + # 10.4 and later require use of scutil for DNS to work properly + *) + OVERRIDE_PRIMARY="" + if [ -n "$CISCO_SPLIT_INC" ]; then + if [ $CISCO_SPLIT_INC -lt 1 ]; then + # Must override for correct default route + # Cannot use multiple DNS matching in this case + OVERRIDE_PRIMARY='d.add OverridePrimary # 1' + fi + # Overriding the default gateway breaks split routing + OVERRIDE_GATEWAY="" + # Not overriding the default gateway breaks usage of + # INTERNAL_IP4_DNS. Prepend INTERNAL_IP4_DNS to list + # of used DNS servers + SERVICE=`echo "show State:/Network/Global/IPv4" | scutil | grep -oE '[a-fA-F0-9]{8}-([a-fA-F0-9]{4}-){3}[a-fA-F0-9]{12}'` + SERVICE_DNS=`echo "show State:/Network/Service/$SERVICE/DNS" | scutil | grep -oE '([0-9]{1,3}[\.]){3}[0-9]{1,3}' | xargs` + if [ X"$SERVICE_DNS" != X"$INTERNAL_IP4_DNS" ]; then + scutil >/dev/null 2>&1 <<-EOF + open + get State:/Network/Service/$SERVICE/DNS + d.add ServerAddresses * $INTERNAL_IP4_DNS $SERVICE_DNS + set State:/Network/Service/$SERVICE/DNS + close + EOF + fi + else + # No split routing. Override default gateway + OVERRIDE_GATEWAY="d.add Router $INTERNAL_IP4_ADDRESS" + fi + # Uncomment the following if/fi pair to use multiple + # DNS matching when available. When multiple DNS matching + # is present, anything reading the /etc/resolv.conf file + # directly will probably not work as intended. + #if [ -z "$CISCO_DEF_DOMAIN" ]; then + # Cannot use multiple DNS matching without a domain + OVERRIDE_PRIMARY='d.add OverridePrimary # 1' + #fi + scutil >/dev/null 2>&1 <<-EOF + open + d.init + d.add ServerAddresses * $INTERNAL_IP4_DNS + set State:/Network/Service/$TUNDEV/DNS + d.init + $OVERRIDE_GATEWAY + d.add Addresses * $INTERNAL_IP4_ADDRESS + d.add SubnetMasks * 255.255.255.255 + d.add InterfaceName $TUNDEV + $OVERRIDE_PRIMARY + set State:/Network/Service/$TUNDEV/IPv4 + close + EOF + if [ -n "$CISCO_DEF_DOMAIN" ]; then + scutil >/dev/null 2>&1 <<-EOF + open + get State:/Network/Service/$TUNDEV/DNS + d.add DomainName $CISCO_DEF_DOMAIN + d.add SearchDomains * $CISCO_DEF_DOMAIN + d.add SupplementalMatchDomains * $CISCO_DEF_DOMAIN + set State:/Network/Service/$TUNDEV/DNS + close + EOF + fi + # For newer MacOS versions it is needed to set DNS + ACTIVE_INTERFACE=`route -n get default | grep interface | awk '{print $2}'` + ACTIVE_NETWORK_SERVICE=`networksetup -listnetworkserviceorder | grep -B 1 "$ACTIVE_INTERFACE" | head -n 1 | awk '/\([0-9]+\)/{ print }'|cut -d " " -f2-` + networksetup -setdnsservers "$ACTIVE_NETWORK_SERVICE" $INTERNAL_IP4_DNS + ;; + esac + fi +} + +restore_resolvconf_generic() { + if [ ! -f "$RESOLV_CONF_BACKUP" ]; then + return + fi + grep '^#@VPNC_GENERATED@' /etc/resolv.conf > /dev/null 2>&1 && cat "$RESOLV_CONF_BACKUP" > /etc/resolv.conf + rm -f -- "$RESOLV_CONF_BACKUP" + + if [ "$OS" = "Darwin" ]; then + case "`uname -r`" in + # Skip for pre-10.4 systems + 4.*|5.*|6.*|7.*) + ;; + # 10.4 and later require use of scutil for DNS to work properly + *) + scutil >/dev/null 2>&1 <<-EOF + open + remove State:/Network/Service/$TUNDEV/IPv4 + remove State:/Network/Service/$TUNDEV/DNS + close + EOF + # Split routing required prepending of INTERNAL_IP4_DNS + # to list of used DNS servers + if [ -n "$CISCO_SPLIT_INC" ]; then + SERVICE=`echo "show State:/Network/Global/IPv4" | scutil | grep -oE '[a-fA-F0-9]{8}-([a-fA-F0-9]{4}-){3}[a-fA-F0-9]{12}'` + SERVICE_DNS=`echo "show State:/Network/Service/$SERVICE/DNS" | scutil | grep -oE '([0-9]{1,3}[\.]){3}[0-9]{1,3}'` + FILTERED_SERVICE_DNS=`echo "$SERVICE_DNS" | grep -Fv "$(echo $INTERNAL_IP4_DNS | tr ' ' '\n')" | xargs` + if [ -n "$FILTERED_SERVICE_DNS" ]; then + scutil >/dev/null 2>&1 <<-EOF + open + get State:/Network/Service/$SERVICE/DNS + d.add ServerAddresses * ${FILTERED_SERVICE_DNS} + set State:/Network/Service/$SERVICE/DNS + close + EOF + fi + fi + # For newer MacOS versions it is needed to unset DNS + ACTIVE_INTERFACE=`route -n get default | grep interface | awk '{print $2}'` + ACTIVE_NETWORK_SERVICE=`networksetup -listnetworkserviceorder | grep -B 1 "$ACTIVE_INTERFACE" | head -n 1 | awk '/\([0-9]+\)/{ print }'|cut -d " " -f2-` + networksetup -setdnsservers "$ACTIVE_NETWORK_SERVICE" Empty + ;; + esac + fi +} +# === resolv.conf handling via /sbin/netconfig (Suse 11.1) ===================== + +# Suse provides a script that modifies resolv.conf. Use it because it will +# restart/reload all other services that care about it (e.g. lwresd). [unclear if this is still true, but probably --mlk] + +modify_resolvconf_suse_netconfig() +{ + /sbin/netconfig modify -s vpnc -i "$TUNDEV" <<-EOF + INTERFACE='$TUNDEV' + DNSSERVERS='$INTERNAL_IP4_DNS' + DNSDOMAIN='$CISCO_DEF_DOMAIN' + EOF +} +# Restore resolv.conf to old contents on Suse +restore_resolvconf_suse_netconfig() +{ + /sbin/netconfig remove -s vpnc -i "$TUNDEV" +} + +# === resolv.conf handling via /sbin/modify_resolvconf (Suse) ===================== + +# Suse provides a script that modifies resolv.conf. Use it because it will +# restart/reload all other services that care about it (e.g. lwresd). + +modify_resolvconf_suse() +{ + FULL_SCRIPTNAME=$(readlink -f "$0") + set -- + [ -n "$INTERNAL_IP4_DNS" ] && set -- "$@" -n "$INTERNAL_IP4_DNS" + [ -n "$CISCO_DEF_DOMAIN" ] && set -- "$@" -d "$CISCO_DEF_DOMAIN" + /sbin/modify_resolvconf modify -s vpnc -p "$SCRIPTNAME" -f "$FULL_SCRIPTNAME" -e "$TUNDEV" "$@" -t "This file was created by $SCRIPTNAME" +} + +# Restore resolv.conf to old contents on Suse +restore_resolvconf_suse() +{ + FULL_SCRIPTNAME=$(readlink -f "$0") + /sbin/modify_resolvconf restore -s vpnc -p "$SCRIPTNAME" -f "$FULL_SCRIPTNAME" -e "$TUNDEV" +} + +# === resolv.conf handling via UCI (OpenWRT) ========= + +modify_resolvconf_openwrt() { + add_dns $OPENWRT_INTERFACE $INTERNAL_IP4_DNS +} + +restore_resolvconf_openwrt() { + remove_dns $OPENWRT_INTERFACE +} + +# === resolv.conf handling via /sbin/resolvconf (Debian, Ubuntu, Gentoo)) ========= + +modify_resolvconf_manager() { + NEW_RESOLVCONF="" + for i in $INTERNAL_IP4_DNS; do + NEW_RESOLVCONF="$NEW_RESOLVCONF +nameserver $i" + done + if [ -n "$CISCO_DEF_DOMAIN" ]; then + NEW_RESOLVCONF="$NEW_RESOLVCONF +search $CISCO_DEF_DOMAIN" + fi + echo "$NEW_RESOLVCONF" | /sbin/resolvconf -a $TUNDEV +} + +restore_resolvconf_manager() { + /sbin/resolvconf -d $TUNDEV +} + +# === resolv.conf handling via systemd-resolved ========= + +AF_INET=2 + +get_if_index() { + local link + link="$(ip link show dev "$1")" || return $? + echo ${link} | awk -F: '{print $1}' +} + +busctl_call() { + local dest node + dest=org.freedesktop.resolve1 + node=/org/freedesktop/resolve1 + busctl call "$dest" "${node}" "${dest}.Manager" "$@" +} + +busctl_set_nameservers() { + local if_index addresses args addr + if_index=$1 + shift + addresses="$@" + args="$if_index $#" + for addr in ${addresses}; do + args="$args ${AF_INET} 4 $(echo $addr | sed 's/[.]/ /g')" + done + busctl_call SetLinkDNS 'ia(iay)' ${args} +} + +resolvectl_set_nameservers() { + local if_index addresses + if_index=$1 + shift + addresses="$@" + /usr/bin/resolvectl dns $if_index $addresses +} + +busctl_set_search() { + local if_index domains args domain + if_index=$1 + shift + domains="$@" + args="$if_index $#" + for domain in ${domains}; do + args="$args ${domain} false" + done + busctl_call SetLinkDomains 'ia(sb)' ${args} +} + +resolvectl_set_search() { + local if_index domains + if_index=$1 + shift + domains="$@" + /usr/bin/resolvectl domain $if_index $domains +} + +modify_resolved_manager() { + local if_index split_dns_list + if_index=$(get_if_index $TUNDEV) + split_dns_list=$(echo $CISCO_SPLIT_DNS | tr ',' ' ') + resolvectl_set_nameservers $if_index $INTERNAL_IP4_DNS + if [ -n "$CISCO_DEF_DOMAIN" ] || [ -n "$split_dns_list" ]; then + resolvectl_set_search $if_index $CISCO_DEF_DOMAIN $split_dns_list + fi +} + +modify_resolved_manager_old() { + local if_index + if_index=$(get_if_index $TUNDEV) + busctl_set_nameservers $if_index $INTERNAL_IP4_DNS + if [ -n "$CISCO_DEF_DOMAIN" ]; then + busctl_set_search $if_index $CISCO_DEF_DOMAIN + fi +} + +restore_resolved_manager() { + local if_index + if_index=$(get_if_index $TUNDEV) + /usr/bin/resolvectl revert $if_index +} + +restore_resolved_manager_old() { + local if_index + if_index=$(get_if_index $TUNDEV) + busctl_call RevertLink 'i' $if_index +} + +# === resolv.conf handling via unbound ========= + +modify_resolvconf_unbound() { + if [ -n "$CISCO_DEF_DOMAIN" ]; then + /usr/sbin/unbound-control forward_add +i ${CISCO_DEF_DOMAIN} ${INTERNAL_IP4_DNS} + /usr/sbin/unbound-control flush_requestlist + /usr/sbin/unbound-control flush_zone ${CISCO_DEF_DOMAIN} + # flush infra cache + for i in $INTERNAL_IP4_DNS ; do + /usr/sbin/unbound-control flush_infra "$i" + done + + fi +} + +restore_resolvconf_unbound() { + if [ -n "$CISCO_DEF_DOMAIN" ]; then + /usr/sbin/unbound-control forward_remove +i ${CISCO_DEF_DOMAIN} + /usr/sbin/unbound-control flush_zone ${CISCO_DEF_DOMAIN} + /usr/sbin/unbound-control flush_requestlist + fi +} + +# === resolv.conf handling via resolvd (OpenBSD) ========= + +modify_resolvconf_resolvd() { + /sbin/route nameserver $TUNDEV $INTERNAL_IP4_DNS $INTERNAL_IP6_DNS +} + +restore_resolvconf_resolvd() { + /sbin/route nameserver $TUNDEV +} + +# ========= Toplevel state handling ======================================= + +do_pre_init() { + if [ "$OS" = "Linux" ]; then + if (exec 6< /dev/net/tun) > /dev/null 2>&1 ; then + : + else # can't open /dev/net/tun + test -e /proc/sys/kernel/modprobe && `cat /proc/sys/kernel/modprobe` tun 2>/dev/null + # make sure tun device exists + if [ ! -e /dev/net/tun ]; then + mkdir -p /dev/net + mknod -m 0640 /dev/net/tun c 10 200 + [ -x /sbin/restorecon ] && /sbin/restorecon /dev/net/tun + fi + # workaround for a possible latency caused by udev, sleep max. 10s + for x in $(seq 100) ; do + (exec 6<> /dev/net/tun) > /dev/null 2>&1 && break; + sleep 0.1 + done + fi + elif [ "$OS" = "FreeBSD" -o "$OS" = "DragonFly" ]; then + if ! ifconfig $TUNDEV > /dev/null; then + ifconfig $TUNDEV create + fi + elif [ "$OS" = "GNU/kFreeBSD" ]; then + if [ ! -e /dev/tun ]; then + kldload if_tun + fi + elif [ "$OS" = "NetBSD" ]; then + : + elif [ "$OS" = "OpenBSD" ]; then + if ! ifconfig $TUNDEV > /dev/null; then + ifconfig $TUNDEV create + fi + : + elif [ "$OS" = "SunOS" ]; then + : + elif [ "$OS" = "Darwin" ]; then + : + fi +} + +do_connect() { + if [ -n "$CISCO_BANNER" ]; then + echo "Connect Banner:" + echo "$CISCO_BANNER" | while read LINE ; do echo "|" "$LINE" ; done + echo + fi + + case "$VPNGATEWAY" in + 127.*|::1) ;; # localhost (probably proxy) + *) set_vpngateway_route ;; + esac + do_ifconfig + if [ -n "$CISCO_SPLIT_EXC" ]; then + i=0 + while [ $i -lt $CISCO_SPLIT_EXC ] ; do + eval NETWORK="\${CISCO_SPLIT_EXC_${i}_ADDR}" + eval NETMASK="\${CISCO_SPLIT_EXC_${i}_MASK}" + eval NETMASKLEN="\${CISCO_SPLIT_EXC_${i}_MASKLEN}" + case "$NETWORK" in + 0.*|127.*|169.254.*) echo "ignoring non-forwardable exclude route $NETWORK/$NETMASKLEN" >&2 ;; + *) set_exclude_route "$NETWORK" "$NETMASK" "$NETMASKLEN" ;; + esac + i=`expr $i + 1` + done + fi + if [ -n "$CISCO_IPV6_SPLIT_EXC" ]; then + # untested + i=0 + while [ $i -lt $CISCO_IPV6_SPLIT_EXC ] ; do + eval NETWORK="\${CISCO_IPV6_SPLIT_EXC_${i}_ADDR}" + eval NETMASKLEN="\${CISCO_IPV6_SPLIT_EXC_${i}_MASKLEN}" + set_ipv6_exclude_route "$NETWORK" "$NETMASKLEN" + i=`expr $i + 1` + done + fi + if [ -n "$CISCO_SPLIT_INC" ]; then + i=0 + while [ $i -lt $CISCO_SPLIT_INC ] ; do + eval NETWORK="\${CISCO_SPLIT_INC_${i}_ADDR}" + eval NETMASK="\${CISCO_SPLIT_INC_${i}_MASK}" + eval NETMASKLEN="\${CISCO_SPLIT_INC_${i}_MASKLEN}" + if [ "$NETWORK" != "0.0.0.0" ]; then + set_network_route "$NETWORK" "$NETMASK" "$NETMASKLEN" "$TUNDEV" + else + set_default_route + fi + i=`expr $i + 1` + done + elif [ -n "$INTERNAL_IP4_ADDRESS" ]; then + set_default_route + fi + if [ -n "$CISCO_IPV6_SPLIT_INC" ]; then + i=0 + while [ $i -lt $CISCO_IPV6_SPLIT_INC ] ; do + eval NETWORK="\${CISCO_IPV6_SPLIT_INC_${i}_ADDR}" + eval NETMASKLEN="\${CISCO_IPV6_SPLIT_INC_${i}_MASKLEN}" + if [ $NETMASKLEN -eq 0 ]; then + set_ipv6_default_route + else + set_ipv6_network_route "$NETWORK" "$NETMASKLEN" "$TUNDEV" + fi + i=`expr $i + 1` + done + elif [ -n "$INTERNAL_IP6_NETMASK" -o -n "$INTERNAL_IP6_ADDRESS" ]; then + set_ipv6_default_route + fi + + if [ -n "$INTERNAL_IP4_DNS" ]; then + $MODIFYRESOLVCONF + fi +} + +do_disconnect() { + if [ -n "$CISCO_SPLIT_INC" ]; then + i=0 + while [ $i -lt $CISCO_SPLIT_INC ] ; do + eval NETWORK="\${CISCO_SPLIT_INC_${i}_ADDR}" + eval NETMASK="\${CISCO_SPLIT_INC_${i}_MASK}" + eval NETMASKLEN="\${CISCO_SPLIT_INC_${i}_MASKLEN}" + if [ "$NETWORK" != "0.0.0.0" ]; then + # FIXME: This doesn't restore previously overwritten + # routes. + del_network_route "$NETWORK" "$NETMASK" "$NETMASKLEN" "$TUNDEV" + else + reset_default_route + fi + i=`expr $i + 1` + done + else + reset_default_route + fi + if [ -n "$CISCO_SPLIT_EXC" ]; then + i=0 + while [ $i -lt $CISCO_SPLIT_EXC ] ; do + eval NETWORK="\${CISCO_SPLIT_EXC_${i}_ADDR}" + eval NETMASK="\${CISCO_SPLIT_EXC_${i}_MASK}" + eval NETMASKLEN="\${CISCO_SPLIT_EXC_${i}_MASKLEN}" + case "$NETWORK" in + 0.*|127.*|169.254.*) ;; # ignoring non-forwardable exclude route + *) del_exclude_route "$NETWORK" "$NETMASK" "$NETMASKLEN" ;; + esac + i=`expr $i + 1` + done + fi + if [ -n "$CISCO_IPV6_SPLIT_EXC" ]; then + # untested + i=0 + while [ $i -lt $CISCO_IPV6_SPLIT_EXC ] ; do + eval NETWORK="\${CISCO_IPV6_SPLIT_EXC_${i}_ADDR}" + eval NETMASKLEN="\${CISCO_IPV6_SPLIT_EXC_${i}_MASKLEN}" + del_ipv6_exclude_route "$NETWORK" "$NETMASKLEN" + i=`expr $i + 1` + done + fi + if [ -n "$CISCO_IPV6_SPLIT_INC" ]; then + i=0 + while [ $i -lt $CISCO_IPV6_SPLIT_INC ] ; do + eval NETWORK="\${CISCO_IPV6_SPLIT_INC_${i}_ADDR}" + eval NETMASKLEN="\${CISCO_IPV6_SPLIT_INC_${i}_MASKLEN}" + if [ $NETMASKLEN -eq 0 ]; then + reset_ipv6_default_route + else + del_ipv6_network_route "$NETWORK" "$NETMASKLEN" "$TUNDEV" + fi + i=`expr $i + 1` + done + elif [ -n "$INTERNAL_IP6_NETMASK" -o -n "$INTERNAL_IP6_ADDRESS" ]; then + reset_ipv6_default_route + fi + + del_vpngateway_route + + if [ -n "$INTERNAL_IP4_DNS" ]; then + $RESTORERESOLVCONF + fi + + + if [ -n "$IPROUTE" ]; then + if [ -n "$INTERNAL_IP4_ADDRESS" ]; then + $IPROUTE addr del "$INTERNAL_IP4_ADDRESS/255.255.255.255" peer "$INTERNAL_IP4_ADDRESS" dev "$TUNDEV" + fi + # If the netmask is provided, it contains the address _and_ netmask + if [ -n "$INTERNAL_IP6_ADDRESS" ] && [ -z "$INTERNAL_IP6_NETMASK" ]; then + INTERNAL_IP6_NETMASK="$INTERNAL_IP6_ADDRESS/128" + fi + if [ -n "$INTERNAL_IP6_NETMASK" ]; then + $IPROUTE -6 addr del $INTERNAL_IP6_NETMASK dev $TUNDEV + fi + $IPROUTE link set dev "$TUNDEV" down + else + if [ -n "$INTERNAL_IP4_ADDRESS" ]; then + ifconfig "$TUNDEV" `ifconfig_syntax_del "$INTERNAL_IP4_ADDRESS"` + fi + if [ -n "$INTERNAL_IP6_ADDRESS" ] && [ -z "$INTERNAL_IP6_NETMASK" ]; then + INTERNAL_IP6_NETMASK="$INTERNAL_IP6_ADDRESS/128" + fi + if [ -n "$INTERNAL_IP6_NETMASK" ]; then + ifconfig "$TUNDEV" `ifconfig_syntax_del "$INTERNAL_IP6_NETMASK"` + fi + ifconfig "$TUNDEV" down + fi + + case "$OS" in + NetBSD|OpenBSD) # and probably others... + ifconfig "$TUNDEV" destroy + ;; + FreeBSD|DragonFly) + ifconfig "$TUNDEV" destroy > /dev/null 2>&1 & + ;; + esac +} + +do_attempt_reconnect() { + set_vpngateway_route +} + +#### Main + +if [ -z "$reason" ]; then + echo "this script must be called from vpnc" 1>&2 + exit 1 +fi + +case "$reason" in + pre-init) + do_pre_init + ;; + connect) + do_connect + ;; + disconnect) + do_disconnect + ;; + attempt-reconnect) + # Invoked before each attempt to re-establish the session. + # If the underlying physical connection changed, we might + # be left with a route to the VPN server through the VPN + # itself, which would need to be fixed. + do_attempt_reconnect + ;; + reconnect) + # After successfully re-establishing the session. + : + ;; + *) + echo "unknown reason '$reason'. Maybe vpnc-script is out of date" 1>&2 + exit 1 + ;; +esac + +exit 0 diff --git a/crates/gpvpnc/src/macos.rs b/crates/gpvpnc/src/macos.rs new file mode 100644 index 0000000..1d1f46a --- /dev/null +++ b/crates/gpvpnc/src/macos.rs @@ -0,0 +1,231 @@ +use std::{ + io::{self, BufRead, BufReader, Read}, + process::{Command, Stdio}, + thread, +}; + +const VPNC_SCRIPT: &str = include_str!("macos-vpnc-script.sh"); + +pub fn configure_network(reason: &str, environment: &[(String, Option)]) -> io::Result<()> { + run_script(VPNC_SCRIPT, reason, environment) +} + +fn run_script(script: &str, reason: &str, environment: &[(String, Option)]) -> io::Result<()> { + // Only compiled-in content reaches the shell. Gateway values stay in a + // child-local environment, never interpolated into shell commands. + let mut command = Command::new("/bin/sh"); + command.args(["-c", script, "vpnc-script"]).env_clear().current_dir("/"); + for (name, value) in environment { + match value { + Some(value) => { + command.env(name, value); + } + None => { + command.env_remove(name); + } + } + } + command + .env("reason", reason) + .env("PATH", "/usr/bin:/bin:/usr/sbin:/sbin") + .env("HOME", "/var/root") + .stdout(Stdio::piped()) + .stderr(Stdio::piped()); + let mut child = command.spawn()?; + let stdout = child.stdout.take().expect("stdout is piped"); + let stderr = child.stderr.take().expect("stderr is piped"); + let status = thread::scope(|scope| { + // Drain both pipes while waiting, so either stream can exceed pipe capacity. + let stdout = scope.spawn(|| log_output(stdout, reason, log::Level::Info)); + let stderr = scope.spawn(|| log_output(stderr, reason, log::Level::Warn)); + let status = child.wait(); + let stdout = stdout + .join() + .unwrap_or_else(|_| Err(io::Error::other("VPN script stdout reader panicked"))); + let stderr = stderr + .join() + .unwrap_or_else(|_| Err(io::Error::other("VPN script stderr reader panicked"))); + stdout?; + stderr?; + status + })?; + if status.success() { + Ok(()) + } else { + Err(io::Error::other(format!( + "VPN configuration failed for {reason}: {status}" + ))) + } +} + +fn log_output(output: impl Read, reason: &str, level: log::Level) -> io::Result<()> { + let mut reader = BufReader::new(output); + let mut line = Vec::new(); + loop { + line.clear(); + // Split oversized lines into bounded chunks, including output without a newline. + if reader.by_ref().take(8192).read_until(b'\n', &mut line)? == 0 { + return Ok(()); + } + if line.last() == Some(&b'\n') { + line.pop(); + if line.last() == Some(&b'\r') { + line.pop(); + } + } + log::log!(level, "vpnc-script [{reason}]: {}", String::from_utf8_lossy(&line)); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::sync::Mutex; + + struct CapturedLogs(Mutex>); + + static LOGS: CapturedLogs = CapturedLogs(Mutex::new(Vec::new())); + + impl log::Log for CapturedLogs { + fn enabled(&self, _: &log::Metadata<'_>) -> bool { + true + } + + fn log(&self, record: &log::Record<'_>) { + let message = record.args().to_string(); + if message.starts_with("vpnc-script [capture-test]: ") { + self.0.lock().unwrap().push((record.level(), message)); + } + } + + fn flush(&self) {} + } + + #[test] + fn captures_both_streams_with_levels_and_reason_even_on_failure() { + log::set_logger(&LOGS).unwrap(); + log::set_max_level(log::LevelFilter::Info); + let error = run_script( + "printf 'first\\n\\nlast'; printf 'warning\\r\\nfinal' >&2; exit 23", + "capture-test", + &[], + ) + .unwrap_err(); + assert!(error.to_string().contains("23")); + let mut records = std::mem::take(&mut *LOGS.0.lock().unwrap()); + records.sort(); + let mut expected = vec![ + (log::Level::Info, "vpnc-script [capture-test]: first".to_string()), + (log::Level::Info, "vpnc-script [capture-test]: ".to_string()), + (log::Level::Info, "vpnc-script [capture-test]: last".to_string()), + (log::Level::Warn, "vpnc-script [capture-test]: warning".to_string()), + (log::Level::Warn, "vpnc-script [capture-test]: final".to_string()), + ]; + expected.sort(); + assert_eq!(records, expected); + + // Each stream exceeds pipe capacity. Both must be drained before wait returns. + run_script( + r#" + i=0 + while [ "$i" -lt 3000 ]; do + printf 'stdout-abcdefghijklmnopqrstuvwxyz0123456789\n' + printf 'stderr-abcdefghijklmnopqrstuvwxyz0123456789\n' >&2 + i=$((i + 1)) + done + "#, + "capture-test", + &[], + ) + .unwrap(); + let records = std::mem::take(&mut *LOGS.0.lock().unwrap()); + assert_eq!( + records.iter().filter(|(level, _)| *level == log::Level::Info).count(), + 3000 + ); + assert_eq!( + records.iter().filter(|(level, _)| *level == log::Level::Warn).count(), + 3000 + ); + + log_output(&vec![b'x'; 20000][..], "capture-test", log::Level::Info).unwrap(); + log_output(&[0xff, b'\n'][..], "capture-test", log::Level::Warn).unwrap(); + let records = std::mem::take(&mut *LOGS.0.lock().unwrap()); + let prefix = "vpnc-script [capture-test]: "; + assert_eq!(records.len(), 4); + assert_eq!(records[0].1.len() - prefix.len(), 8192); + assert_eq!(records[1].1.len() - prefix.len(), 8192); + assert_eq!(records[2].1.len() - prefix.len(), 3616); + assert_eq!(records[3], (log::Level::Warn, format!("{prefix}\u{fffd}"))); + } + + #[test] + fn embedded_shell_syntax_is_valid_and_does_not_load_vpnc_hooks() { + assert!( + Command::new("/bin/sh") + .args(["-n", "-c", VPNC_SCRIPT, "vpnc-script"]) + .status() + .unwrap() + .success() + ); + assert!(!VPNC_SCRIPT.contains("/etc/vpnc")); + assert!(!VPNC_SCRIPT.contains("run_hooks")); + } + + #[test] + fn tunnel_self_routes_are_skipped_without_skipping_other_routes() { + // Exercise the embedded route functions with a recorder instead of changing + // the host's routing table or running the script's initialization. + let mut script = String::from( + "route() { printf '%s\\n' \"$*\"; }\n\ + INTERNAL_IP4_ADDRESS=10.197.121.133\n\ + route_syntax_netmask=-netmask\n\ + route_syntax_del=delete\n", + ); + for name in ["set_network_route", "del_network_route"] { + let declaration = format!("\t{name}() {{"); + let start = VPNC_SCRIPT.rfind(&declaration).unwrap(); + let end = start + VPNC_SCRIPT[start..].find("\n\t}").unwrap() + 3; + script.push_str(&VPNC_SCRIPT[start..end]); + script.push('\n'); + } + script.push_str( + "set_network_route 10.197.121.133 255.255.255.255 32 utun7\n\ + del_network_route 10.197.121.133 255.255.255.255 32 utun7\n\ + set_network_route 10.15.70.11 255.255.255.255 32 utun7\n\ + set_network_route 10.0.0.0 255.0.0.0 8 utun7\n\ + del_network_route 10.15.70.11 255.255.255.255 32 utun7\n\ + set_network_route 10.197.121.133 255.255.255.255 32 utun7 10.197.121.1\n", + ); + let output = Command::new("/bin/sh").args(["-c", &script]).output().unwrap(); + assert!(output.status.success()); + assert!(output.stderr.is_empty()); + assert_eq!( + String::from_utf8(output.stdout).unwrap(), + "add -net 10.15.70.11 -netmask 255.255.255.255 10.197.121.133\n\ + add -net 10.0.0.0 -netmask 255.0.0.0 10.197.121.133\n\ + delete -net 10.15.70.11 -netmask 255.255.255.255 10.197.121.133\n\ + add -net 10.197.121.133 -netmask 255.255.255.255 10.197.121.1\n" + ); + } + + #[test] + fn runner_passes_configuration_as_data_and_uses_a_trusted_environment() { + let environment = vec![ + ("TUNDEV".into(), Some("utun3; exit 99".into())), + ("UNSET_VARIABLE".into(), None), + ("PATH".into(), Some("/untrusted".into())), + ]; + run_script( + r#" + [ "$0" = vpnc-script ] && [ "$reason" = connect ] && + [ "$TUNDEV" = 'utun3; exit 99' ] && [ -z "${UNSET_VARIABLE+x}" ] && + [ "$PATH" = /usr/bin:/bin:/usr/sbin:/sbin ] && [ "$HOME" = /var/root ] + "#, + "connect", + &environment, + ) + .unwrap(); + assert!(run_script("exit 23", "connect", &environment).is_err()); + } +} diff --git a/crates/openconnect/build.rs b/crates/openconnect/build.rs index 8bf911a..d10f7b6 100644 --- a/crates/openconnect/build.rs +++ b/crates/openconnect/build.rs @@ -117,7 +117,11 @@ fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { #[cfg(target_os = "macos")] { - config.disable_static().enable_shared().without("gnutls", None); + config + .disable_static() + .enable_shared() + .with("gnutls", None) + .without("openssl", None); config.ldflag("-liconv"); config.env("LIBS", "-liconv"); } @@ -139,6 +143,15 @@ fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { #[cfg(target_os = "macos")] { + let configuration = std::fs::read_to_string(dst.join("build/config.h")) + .expect("Failed to read the OpenConnect TLS backend configuration"); + assert!( + configuration.lines().any(|line| line == "#define OPENCONNECT_GNUTLS 1") + && !configuration + .lines() + .any(|line| line == "#define OPENCONNECT_OPENSSL 1"), + "macOS OpenConnect must use GnuTLS" + ); // Do not embed Cargo's temporary build directory in consumers of this library. let library = std::fs::canonicalize(lib_dir.join("libopenconnect.dylib")).unwrap(); let library_name = library.file_name().unwrap().to_str().unwrap(); @@ -198,7 +211,7 @@ fn main() { // Using pkg-config to find system deps pkg_config::probe_library("zlib").unwrap(); #[cfg(target_os = "macos")] - pkg_config::probe_library("openssl").unwrap(); + pkg_config::probe_library("gnutls").unwrap(); #[cfg(not(target_os = "macos"))] { diff --git a/crates/openconnect/deps/openconnect b/crates/openconnect/deps/openconnect index 0557ead..fa45f13 160000 --- a/crates/openconnect/deps/openconnect +++ b/crates/openconnect/deps/openconnect @@ -1 +1 @@ -Subproject commit 0557ead16b7ac825473edb0ab19f54443dcfaa56 +Subproject commit fa45f13d063a72dadfeb4ab0e7875a705621407b diff --git a/crates/openconnect/src/ffi/mod.rs b/crates/openconnect/src/ffi/mod.rs index 839d6c3..f107995 100644 --- a/crates/openconnect/src/ffi/mod.rs +++ b/crates/openconnect/src/ffi/mod.rs @@ -1,10 +1,13 @@ mod hip; +mod network_configuration; +mod tunnel; use crate::Vpn; use hip::HipGenerateFn; pub(crate) use hip::{ HipControlRaw, HipScriptRaw, collect_hip_script, collect_hip_source, generate_hip_report, script_environment, }; use log::{debug, info, trace, warn}; +pub(crate) use network_configuration::{VpnOptionRaw, configure_network}; use std::ffi::{c_char, c_int, c_long, c_void}; use std::panic::{AssertUnwindSafe, catch_unwind}; @@ -26,6 +29,7 @@ pub(crate) struct ConnectOptions { pub local_hostname: *const c_char, pub script: *const c_char, + pub configure_network: Option c_int>, pub interface: *const c_char, pub script_tun: u32, @@ -61,6 +65,7 @@ pub(crate) struct VpnSessionInfoRaw { #[link(name = "vpn")] unsafe extern "C" { fn vpn_write_cancel(fd: c_int) -> c_int; + fn vpn_write_statistics(fd: c_int) -> c_int; #[link_name = "vpn_connect"] fn vpn_connect( options: *const ConnectOptions, @@ -78,6 +83,15 @@ pub(crate) fn write_cancel(fd: i32) -> std::io::Result<()> { } } +pub(crate) fn write_statistics(fd: i32) -> std::io::Result<()> { + let error = unsafe { vpn_write_statistics(fd) }; + if error == 0 { + Ok(()) + } else { + Err(std::io::Error::from_raw_os_error(error)) + } +} + #[unsafe(no_mangle)] extern "C" fn vpn_attach_command_pipe(vpn: *mut c_void, fd: c_int) -> c_int { unsafe { &*(vpn as *const Vpn) }.attach_command_pipe(fd).into() diff --git a/crates/openconnect/src/ffi/network_configuration.rs b/crates/openconnect/src/ffi/network_configuration.rs new file mode 100644 index 0000000..c7027d1 --- /dev/null +++ b/crates/openconnect/src/ffi/network_configuration.rs @@ -0,0 +1,177 @@ +use std::{ + ffi::{CStr, c_char, c_int, c_void}, + io, + panic::{AssertUnwindSafe, catch_unwind}, +}; + +use crate::{NetworkConfiguration, Vpn}; + +/// Matches OpenConnect's oc_vpn_option list. Borrowed for this invocation only. +#[repr(C)] +pub(crate) struct VpnOptionRaw { + pub option: *const c_char, + pub value: *const c_char, + pub next: *const VpnOptionRaw, +} + +/// # Safety +/// A non-null `value` must point to a readable, NUL-terminated string that +/// remains valid and unchanged until this function returns. +unsafe fn read_string(value: *const c_char) -> io::Result { + if value.is_null() { + return Err(io::Error::from_raw_os_error(libc::EINVAL)); + } + // SAFETY: The caller guarantees a valid C string; null was rejected above. + unsafe { CStr::from_ptr(value) } + .to_str() + .map(str::to_owned) + .map_err(|_| io::Error::from_raw_os_error(libc::EINVAL)) +} + +/// # Safety +/// Non-null strings must satisfy `read_string`'s contract. `options` must be +/// null or a finite, acyclic list of aligned, readable nodes. The list and its +/// strings must remain valid and unchanged until this function returns. +unsafe fn snapshot(reason: *const c_char, mut options: *const VpnOptionRaw) -> io::Result { + // SAFETY: The caller guarantees the string lifetime and validity. + let reason = unsafe { read_string(reason)? }; + let mut environment = Vec::new(); + while !options.is_null() { + // SAFETY: This is a non-null node in the valid list supplied by the caller. + let option = unsafe { &*options }; + // SAFETY: Node strings satisfy read_string's contract, including null handling. + let name = unsafe { read_string(option.option)? }; + let value = if option.value.is_null() { + None + } else { + // SAFETY: The caller guarantees this non-null string's validity and lifetime. + Some(unsafe { read_string(option.value)? }) + }; + environment.push((name, value)); + options = option.next; + } + Ok(NetworkConfiguration { reason, environment }) +} + +/// # Safety +/// `data` must point to an aligned, live `Vpn` that may be shared immutably for +/// this entire invocation. `reason` and `options` must satisfy `snapshot`'s +/// contract. OpenConnect invokes this callback synchronously during `connect`, +/// including cleanup, before the borrowed `Vpn` or configuration data is freed. +pub(crate) unsafe extern "C" fn configure_network( + data: *mut c_void, + reason: *const c_char, + options: *const VpnOptionRaw, +) -> c_int { + let result = catch_unwind(AssertUnwindSafe(|| { + // SAFETY: The caller supplies the live Vpn pointer registered for this connection. + let vpn = unsafe { &*(data as *const Vpn) }; + // SAFETY: The caller keeps OpenConnect's list and strings valid during this call. + let configuration = unsafe { snapshot(reason, options)? }; + let handler = vpn + .network_configuration_handler + .as_ref() + .ok_or_else(|| io::Error::from_raw_os_error(libc::EINVAL))?; + handler(&configuration) + })); + match result { + Ok(Ok(())) => 0, + Ok(Err(error)) => { + log::warn!("Network configuration failed: {error}"); + -error.raw_os_error().filter(|code| *code > 0).unwrap_or(libc::EIO) + } + Err(_) => { + log::warn!("Network configuration handler panicked"); + -libc::EIO + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::{ + ffi::CString, + sync::{Arc, Mutex}, + }; + + #[test] + fn callback_copies_configuration_and_preserves_unset_values() { + let observed = Arc::new(Mutex::new(None)); + let output = observed.clone(); + let vpn = Vpn::builder("server", "cookie") + .network_configuration_handler(move |configuration| { + *output.lock().unwrap() = Some(configuration.clone()); + Ok(()) + }) + .build() + .unwrap(); + let name = CString::new("TUNDEV").unwrap(); + let value = CString::new("utun3").unwrap(); + let unset_name = CString::new("INTERNAL_IP6_ADDRESS").unwrap(); + let unset = VpnOptionRaw { + option: unset_name.as_ptr(), + value: std::ptr::null(), + next: std::ptr::null(), + }; + let option = VpnOptionRaw { + option: name.as_ptr(), + value: value.as_ptr(), + next: &unset, + }; + // SAFETY: vpn, both list nodes, and their C strings remain live for the call. + let result = unsafe { configure_network((&vpn as *const Vpn).cast_mut().cast(), c"connect".as_ptr(), &option) }; + assert_eq!(result, 0); + let configuration = observed.lock().unwrap().take().unwrap(); + assert_eq!(configuration.reason, "connect"); + assert_eq!( + configuration.environment, + vec![ + ("TUNDEV".into(), Some("utun3".into())), + ("INTERNAL_IP6_ADDRESS".into(), None) + ] + ); + } + + #[test] + fn callback_errors_and_panics_do_not_cross_ffi() { + for panics in [false, true] { + let vpn = Vpn::builder("server", "cookie") + .network_configuration_handler(move |_| { + if panics { + panic!("test panic"); + } + Err(io::Error::from_raw_os_error(libc::EPERM)) + }) + .build() + .unwrap(); + // SAFETY: vpn and the static reason are live; a null list is permitted. + let result = unsafe { + configure_network( + (&vpn as *const Vpn).cast_mut().cast(), + c"connect".as_ptr(), + std::ptr::null(), + ) + }; + assert_eq!(result, if panics { -libc::EIO } else { -libc::EPERM }); + } + } + + #[test] + fn callback_rejects_script_options() { + assert!( + Vpn::builder("server", "cookie") + .network_configuration_handler(|_| Ok(())) + .script_tun(true) + .build() + .is_err() + ); + assert!( + Vpn::builder("server", "cookie") + .network_configuration_handler(|_| Ok(())) + .script(Some("/bin/true".into())) + .build() + .is_err() + ); + } +} diff --git a/crates/openconnect/src/ffi/tunnel.rs b/crates/openconnect/src/ffi/tunnel.rs new file mode 100644 index 0000000..3d4d42a --- /dev/null +++ b/crates/openconnect/src/ffi/tunnel.rs @@ -0,0 +1,355 @@ +use std::{ + ffi::{CStr, c_char, c_int, c_void}, + panic::{AssertUnwindSafe, catch_unwind}, +}; + +use crate::{ + Vpn, + tunnel::{Configuration, Event, NativeList, Statistics, Transport}, +}; + +const TEXT_LIMIT: usize = 1024; +const COPY_BUDGET: usize = 16 * 1024; +const LIST_LIMIT: usize = 256; + +#[repr(C)] +struct SplitInclude { + route: *const c_char, + next: *const SplitInclude, +} + +/// Matches oc_ip_info in the bundled public openconnect.h. +#[repr(C)] +struct IpInfo { + addr: *const c_char, + netmask: *const c_char, + addr6: *const c_char, + netmask6: *const c_char, + dns: [*const c_char; 3], + nbns: [*const c_char; 3], + domain: *const c_char, + proxy_pac: *const c_char, + mtu: c_int, + split_dns: *const SplitInclude, + split_includes: *const SplitInclude, + split_excludes: *const SplitInclude, + gateway_addr: *const c_char, +} + +#[repr(C)] +struct Stats { + tx_pkts: u64, + tx_bytes: u64, + rx_pkts: u64, + rx_bytes: u64, +} + +struct CopyBudget { + remaining: usize, + truncated: bool, +} + +impl CopyBudget { + fn new() -> Self { + Self { + remaining: COPY_BUDGET, + truncated: false, + } + } + + fn text(&mut self, bytes: &[u8]) -> String { + let limit = self.remaining.min(TEXT_LIMIT).min(bytes.len()); + // Lossy UTF-8 is bounded before allocation, then truncated at a character + // boundary so replacement characters cannot exceed the retained budget. + let mut text = String::from_utf8_lossy(&bytes[..limit]).into_owned(); + let mut end = text.len().min(limit); + while !text.is_char_boundary(end) { + end -= 1; + } + text.truncate(end); + self.truncated |= end < bytes.len(); + self.remaining -= text.len(); + text + } + + unsafe fn optional(&mut self, value: *const c_char) -> Option { + if value.is_null() { + return None; + } + // The native value is NUL terminated and borrowed only during the callback. + // Bound the scan as well as the retained allocation for scalar fields. + let length = unsafe { libc::strnlen(value, TEXT_LIMIT + 1) }; + Some(self.text(unsafe { std::slice::from_raw_parts(value.cast(), length) })) + } + + fn push(&mut self, list: &mut NativeList, bytes: &[u8]) { + list.total_count = list.total_count.saturating_add(1); + // Retain whole list entries; the native list is not a user-owned buffer. + if list.items.len() >= LIST_LIMIT || bytes.len() > TEXT_LIMIT || bytes.len() > self.remaining { + list.truncated = true; + self.truncated = true; + return; + } + let text = self.text(bytes); + list.truncated |= text.len() != bytes.len(); + list.items.push(text); + } + + unsafe fn routes(&mut self, mut node: *const SplitInclude) -> NativeList { + let mut list = NativeList::default(); + while !node.is_null() { + let entry = unsafe { &*node }; + if !entry.route.is_null() { + self.push(&mut list, unsafe { CStr::from_ptr(entry.route) }.to_bytes()); + } + node = entry.next; + } + list + } +} + +unsafe fn configuration(interface: *const c_char, raw: &IpInfo) -> Configuration { + let mut budget = CopyBudget::new(); + let mut result = Configuration { + interface: unsafe { budget.optional(interface) }, + ipv4: unsafe { budget.optional(raw.addr) }, + netmask: unsafe { budget.optional(raw.netmask) }, + ipv6: unsafe { budget.optional(raw.addr6) }, + netmask6: unsafe { budget.optional(raw.netmask6) }, + server_ip: unsafe { budget.optional(raw.gateway_addr) }, + mtu: u32::try_from(raw.mtu).ok().filter(|mtu| *mtu > 0), + ..Configuration::default() + }; + for server in raw.dns { + if !server.is_null() { + budget.push(&mut result.dns, unsafe { CStr::from_ptr(server) }.to_bytes()); + } + } + if !raw.domain.is_null() { + // GlobalProtect builds its search list with spaces in gpst.c. + for domain in unsafe { CStr::from_ptr(raw.domain) } + .to_bytes() + .split(u8::is_ascii_whitespace) + { + if !domain.is_empty() { + budget.push(&mut result.search_domains, domain); + } + } + } + result.split_dns = unsafe { budget.routes(raw.split_dns) }; + result.included_routes = unsafe { budget.routes(raw.split_includes) }; + result.excluded_routes = unsafe { budget.routes(raw.split_excludes) }; + result.truncated = budget.truncated; + result +} + +fn observe(vpn: *mut c_void, action: impl FnOnce(&Vpn)) { + if vpn.is_null() { + return; + } + // All exports are called synchronously with the live Vpn registered by connect. + if catch_unwind(AssertUnwindSafe(|| action(unsafe { &*vpn.cast::() }))).is_err() { + log::warn!("Tunnel observer panicked"); + } +} + +#[unsafe(no_mangle)] +extern "C" fn vpn_tunnel_configuration(vpn: *mut c_void, interface: *const c_char, info: *const IpInfo) { + observe(vpn, |vpn| { + let configuration = unsafe { info.as_ref().map(|info| configuration(interface, info)) }; + vpn.on_tunnel_event(Event::Configuration(configuration)); + }); +} + +#[unsafe(no_mangle)] +extern "C" fn vpn_tunnel_event(vpn: *mut c_void, event: c_int) { + observe(vpn, |vpn| match event { + 0 => vpn.on_tunnel_event(Event::Transport(Transport::Negotiating)), + 1 => vpn.on_tunnel_event(Event::Transport(Transport::IpsecEsp)), + 2 => vpn.on_tunnel_event(Event::Transport(Transport::SslTls)), + 3 => vpn.on_tunnel_event(Event::Transport(Transport::Unavailable)), + 4 => { + vpn.on_tunnel_event(Event::Transport(Transport::Unavailable)); + vpn.on_tunnel_event(Event::Reconnecting); + } + 5 => vpn.on_tunnel_event(Event::Established), + 6 => vpn.on_tunnel_event(Event::Reconnected), + 7 => { + vpn.on_tunnel_event(Event::Transport(Transport::Unavailable)); + vpn.on_tunnel_event(Event::Ended); + } + _ => log::warn!("Unknown native tunnel observation: {event}"), + }); +} + +#[unsafe(no_mangle)] +extern "C" fn vpn_tunnel_statistics(vpn: *mut c_void, stats: *const Stats) { + observe(vpn, |vpn| { + vpn.statistics_received(); + if let Some(stats) = unsafe { stats.as_ref() } { + vpn.on_tunnel_event(Event::Statistics(Statistics { + received_bytes: stats.rx_bytes, + sent_bytes: stats.tx_bytes, + received_packets: stats.rx_pkts, + sent_packets: stats.tx_pkts, + })); + } + }); +} + +#[cfg(test)] +mod tests { + use super::*; + use std::{ + ffi::CString, + sync::{Arc, Mutex}, + }; + + fn empty_info() -> IpInfo { + // Every pointer is nullable, and zero MTU denotes unavailable. + unsafe { std::mem::zeroed() } + } + + #[test] + fn snapshot_owns_configuration_and_preserves_native_mask_semantics() { + let domain = CString::new("one.example two.example\tthree.example").unwrap(); + let ipv6 = CString::new("2001:db8::1").unwrap(); + let mask6 = CString::new("2001:db8::1/64").unwrap(); + let server = CString::new("2001:db8::53").unwrap(); + let route = CString::new("10.0.0.0/8").unwrap(); + let node = SplitInclude { + route: route.as_ptr(), + next: std::ptr::null(), + }; + let raw = IpInfo { + domain: domain.as_ptr(), + addr6: ipv6.as_ptr(), + netmask6: mask6.as_ptr(), + dns: [server.as_ptr(), std::ptr::null(), std::ptr::null()], + split_includes: &node, + mtu: 1400, + ..empty_info() + }; + let snapshot = unsafe { configuration(std::ptr::null(), &raw) }; + drop((domain, ipv6, mask6, server, route)); + assert_eq!( + snapshot.search_domains.items, + ["one.example", "two.example", "three.example"] + ); + assert_eq!(snapshot.dns.items, ["2001:db8::53"]); + assert_eq!(snapshot.netmask6.as_deref(), Some("2001:db8::1/64")); + assert_eq!(snapshot.included_routes.items, ["10.0.0.0/8"]); + assert_eq!(snapshot.mtu, Some(1400)); + assert!(!snapshot.truncated); + } + + #[test] + fn observation_budget_keeps_whole_entries_and_counts_omitted_values() { + let domain = CString::new( + std::iter::repeat_n("example.internal", 2000) + .collect::>() + .join(" "), + ) + .unwrap(); + let long_ipv6 = CString::new("界".repeat(500)).unwrap(); + let raw = IpInfo { + domain: domain.as_ptr(), + addr6: long_ipv6.as_ptr(), + ..empty_info() + }; + let snapshot = unsafe { configuration(std::ptr::null(), &raw) }; + assert!(snapshot.truncated); + assert!(snapshot.ipv6.as_ref().unwrap().len() <= TEXT_LIMIT); + assert_eq!(snapshot.search_domains.total_count, 2000); + assert!(snapshot.search_domains.truncated); + assert!(snapshot.search_domains.items.len() <= LIST_LIMIT); + assert!( + snapshot + .search_domains + .items + .iter() + .all(|item| item == "example.internal") + ); + let retained = snapshot.ipv6.unwrap().len() + snapshot.search_domains.items.iter().map(String::len).sum::(); + assert!(retained <= COPY_BUDGET); + } + + #[test] + fn observer_deduplicates_transport_and_survives_panics() { + let vpn = Vpn::builder("vpn.example.com", "cookie") + .script_path("/bin/sh".to_owned()) + .build() + .unwrap(); + let events = Arc::new(Mutex::new(Vec::new())); + let collected = events.clone(); + vpn.set_tunnel_observer(move |event| collected.lock().unwrap().push(event)); + let pointer = (&vpn as *const Vpn).cast_mut().cast(); + vpn_tunnel_event(pointer, 1); + vpn_tunnel_event(pointer, 1); + vpn_tunnel_event(pointer, 4); + vpn_tunnel_event(pointer, 6); + vpn_tunnel_event(pointer, 7); + assert_eq!( + *events.lock().unwrap(), + [ + Event::Transport(Transport::IpsecEsp), + Event::Transport(Transport::Unavailable), + Event::Reconnecting, + Event::Reconnected, + Event::Ended, + ] + ); + vpn.set_tunnel_observer(|_| panic!("test observer panic")); + vpn_tunnel_event(pointer, 5); + vpn.clear_tunnel_observer(); + vpn_tunnel_event(pointer, 5); + } + + #[test] + fn statistics_callback_clears_pending_before_notifying_observer() { + use std::{ + io::Read, + os::{fd::AsRawFd, unix::net::UnixStream}, + }; + let vpn = Arc::new( + Vpn::builder("vpn.example.com", "cookie") + .script_path("/bin/sh".to_owned()) + .build() + .unwrap(), + ); + let (mut reader, writer) = UnixStream::pair().unwrap(); + reader.set_nonblocking(true).unwrap(); + assert!(!vpn.attach_command_pipe(writer.as_raw_fd())); + assert!(vpn.request_statistics().unwrap()); + let received = Arc::new(Mutex::new(None)); + let captured = received.clone(); + let weak = Arc::downgrade(&vpn); + vpn.set_tunnel_observer(move |event| { + if let Event::Statistics(statistics) = event { + *captured.lock().unwrap() = Some(statistics); + assert!(weak.upgrade().unwrap().request_statistics().unwrap()); + } + }); + let raw = Stats { + tx_pkts: u64::MAX, + tx_bytes: 1 << 54, + rx_pkts: 12, + rx_bytes: 34, + }; + vpn_tunnel_statistics(Arc::as_ptr(&vpn).cast_mut().cast(), &raw); + assert_eq!( + *received.lock().unwrap(), + Some(Statistics { + sent_packets: u64::MAX, + sent_bytes: 1 << 54, + received_packets: 12, + received_bytes: 34, + }) + ); + let mut commands = [0; 2]; + reader.read_exact(&mut commands).unwrap(); + assert_eq!(commands, [b's', b's']); + vpn.detach_command_pipe(); + vpn.clear_tunnel_observer(); + } +} diff --git a/crates/openconnect/src/ffi/vpn.c b/crates/openconnect/src/ffi/vpn.c index 291cd08..35e1548 100644 --- a/crates/openconnect/src/ffi/vpn.c +++ b/crates/openconnect/src/ffi/vpn.c @@ -15,6 +15,34 @@ struct vpn_context { vpn_connected_callback on_connected; }; +static void observe_configuration(struct vpn_context *context) +{ + const struct oc_ip_info *info = NULL; + if (openconnect_get_ip_info(context->vpninfo, &info, NULL, NULL)) + info = NULL; + vpn_tunnel_configuration(context->options->user_data, + openconnect_get_ifname(context->vpninfo), info); +} + +static void observe_reconnected(void *private_data) +{ + struct vpn_context *context = private_data; + observe_configuration(context); + vpn_tunnel_event(context->options->user_data, VPN_TUNNEL_RECONNECTED); +} + +static void observe_tunnel(void *private_data, enum openconnect_tunnel_event event) +{ + struct vpn_context *context = private_data; + vpn_tunnel_event(context->options->user_data, event); +} + +static void observe_statistics(void *private_data, const struct oc_stats *stats) +{ + struct vpn_context *context = private_data; + vpn_tunnel_statistics(context->options->user_data, stats); +} + /* Validate the peer certificate */ static int validate_peer_cert(__attribute__((unused)) void *_vpninfo, const char *reason) @@ -54,6 +82,8 @@ static void setup_tun_handler(void *private_data) } if (!ret) { + observe_configuration(context); + vpn_tunnel_event(options->user_data, VPN_TUNNEL_ESTABLISHED); vpn_session_info session_info = { .auth_expiration = (long)openconnect_get_auth_expiration(_vpninfo), .lifetime_secs = openconnect_get_gp_session_lifetime(_vpninfo), @@ -84,7 +114,7 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) INFO("OS: %s", options->os); INFO("CLIENT_VERSION: %s", options->client_version); INFO("HOST_ID: %s", options->host_id ? options->host_id : "(not set)"); - INFO("VPNC_SCRIPT: %s", options->script); + INFO("Network configuration: %s", options->configure_network ? "callback" : options->script); INFO("SCRIPT_TUN: %d", options->script_tun); INFO("CSD_USER: %d", options->hip_script.uid); INFO("CSD_WRAPPER: %s", options->hip_script.path); @@ -101,10 +131,14 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) if (!vpninfo) { ERROR("openconnect_vpninfo_new failed"); + vpn_tunnel_event(options->user_data, VPN_TUNNEL_ENDED); return 1; } context.vpninfo = vpninfo; + openconnect_set_tunnel_handler(vpninfo, observe_tunnel); + openconnect_set_reconnected_handler(vpninfo, observe_reconnected); + openconnect_set_stats_handler(vpninfo, observe_statistics); openconnect_set_gp_hip_report_callback(vpninfo, options->user_data, options->on_hip_report_submitted); context.command_fd = openconnect_setup_cmd_pipe(vpninfo); @@ -191,6 +225,7 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) openconnect_set_dpd(vpninfo, options->dpd_interval); } // Essential step + vpn_tunnel_event(options->user_data, OC_TUNNEL_NEGOTIATING); if (openconnect_make_cstp_connection(vpninfo) != 0) { ERROR("openconnect_make_cstp_connection failed"); goto cleanup; @@ -200,6 +235,8 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) openconnect_disable_dtls(vpninfo); } // Essential step + openconnect_set_configure_tun_handler(vpninfo, options->user_data, + options->configure_network); openconnect_set_setup_tun_handler(vpninfo, setup_tun_handler); while (1) { @@ -216,7 +253,9 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) } cleanup: vpn_detach_command_pipe(options->user_data); + openconnect_set_tunnel_handler(vpninfo, NULL); openconnect_vpninfo_free(vpninfo); + vpn_tunnel_event(options->user_data, VPN_TUNNEL_ENDED); return result; } @@ -231,6 +270,16 @@ int vpn_write_cancel(int fd) return written == 1 ? 0 : (written < 0 ? errno : EIO); } +int vpn_write_statistics(int fd) +{ + char command = OC_CMD_STATS; + ssize_t written; + do { + written = write(fd, &command, 1); + } while (written < 0 && errno == EINTR); + return written == 1 ? 0 : (written < 0 ? errno : EIO); +} + int vpn_collect_hip_report(const vpn_hip_script *script, const struct openconnect_gp_hip_request *request, const struct openconnect_gp_hip_control *control, openconnect_gp_hip_generate_fn generate, void *data, diff --git a/crates/openconnect/src/ffi/vpn.h b/crates/openconnect/src/ffi/vpn.h index 3881634..17412bc 100644 --- a/crates/openconnect/src/ffi/vpn.h +++ b/crates/openconnect/src/ffi/vpn.h @@ -44,6 +44,7 @@ typedef struct vpn_options { const char *local_hostname; const char *script; + openconnect_configure_tun_fn configure_network; const char *interface; const int script_tun; @@ -70,6 +71,15 @@ int vpn_collect_hip_report(const vpn_hip_script *, const struct openconnect_gp_h extern int vpn_attach_command_pipe(void *user_data, int fd); extern void vpn_detach_command_pipe(void *user_data); +enum vpn_tunnel_event { + VPN_TUNNEL_ESTABLISHED = 5, + VPN_TUNNEL_RECONNECTED, + VPN_TUNNEL_ENDED, +}; +extern void vpn_tunnel_event(void *user_data, int event); +extern void vpn_tunnel_configuration(void *user_data, const char *interface, + const struct oc_ip_info *info); +extern void vpn_tunnel_statistics(void *user_data, const struct oc_stats *stats); extern void vpn_log(int level, const char *msg); diff --git a/crates/openconnect/src/lib.rs b/crates/openconnect/src/lib.rs index 140fde0..366b80e 100644 --- a/crates/openconnect/src/lib.rs +++ b/crates/openconnect/src/lib.rs @@ -1,8 +1,11 @@ mod ffi; mod hip; +mod network_configuration; +pub mod tunnel; mod vpn; mod vpn_utils; pub use hip::*; +pub use network_configuration::*; pub use vpn::*; pub use vpn_utils::*; diff --git a/crates/openconnect/src/network_configuration.rs b/crates/openconnect/src/network_configuration.rs new file mode 100644 index 0000000..24836f7 --- /dev/null +++ b/crates/openconnect/src/network_configuration.rs @@ -0,0 +1,12 @@ +use std::io; + +pub type NetworkConfigurationHandler = dyn Fn(&NetworkConfiguration) -> io::Result<()> + Send + Sync; + +/// OpenConnect's configuration inputs for one lifecycle event. +/// Values are copied from OpenConnect before calling the handler. A missing +/// value means the variable must be unset, rather than inherited by a child. +#[derive(Debug, Clone)] +pub struct NetworkConfiguration { + pub reason: String, + pub environment: Vec<(String, Option)>, +} diff --git a/crates/openconnect/src/tunnel.rs b/crates/openconnect/src/tunnel.rs new file mode 100644 index 0000000..05f1797 --- /dev/null +++ b/crates/openconnect/src/tunnel.rs @@ -0,0 +1,57 @@ +//! Owned observations of one native tunnel. Callbacks run synchronously on the +//! connection thread; observers must return promptly and must not call connect. + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum Transport { + Negotiating, + IpsecEsp, + SslTls, + Unavailable, +} + +#[derive(Clone, Debug, Default, PartialEq, Eq)] +pub struct NativeList { + pub items: Vec, + pub total_count: u32, + pub truncated: bool, +} + +/// Negotiated settings, not proof that OS network configuration succeeded. +/// Copy limits apply only to observation and never alter native configuration. +#[derive(Clone, Debug, Default, PartialEq, Eq)] +pub struct Configuration { + pub interface: Option, + pub ipv4: Option, + pub netmask: Option, + pub ipv6: Option, + pub netmask6: Option, + pub server_ip: Option, + pub dns: NativeList, + pub search_domains: NativeList, + pub split_dns: NativeList, + pub included_routes: NativeList, + pub excluded_routes: NativeList, + pub mtu: Option, + pub truncated: bool, +} + +/// Plaintext packets crossing TUN, excluding outer transport overhead. Sent +/// counters measure local TUN reads, not confirmed delivery to the VPN server. +#[derive(Clone, Debug, Default, PartialEq, Eq)] +pub struct Statistics { + pub received_bytes: u64, + pub sent_bytes: u64, + pub received_packets: u64, + pub sent_packets: u64, +} + +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum Event { + Configuration(Option), + Established, + Reconnecting, + Reconnected, + Transport(Transport), + Statistics(Statistics), + Ended, +} diff --git a/crates/openconnect/src/vpn.rs b/crates/openconnect/src/vpn.rs index 4266e50..d6c0b7a 100644 --- a/crates/openconnect/src/vpn.rs +++ b/crates/openconnect/src/vpn.rs @@ -7,10 +7,11 @@ use std::{ use log::{info, warn}; use crate::vpn_utils::{check_executable, find_vpnc_script}; -use crate::{HipSource, ffi}; +use crate::{HipSource, NetworkConfiguration, NetworkConfigurationHandler, ffi}; type OnConnectedCallback = Arc>>>; type OnHipReportCallback = RwLock>>; +type OnTunnelCallback = RwLock>>; #[derive(Debug, Clone, Default, PartialEq, Eq)] pub struct VpnSessionInfo { @@ -72,6 +73,7 @@ struct Cancellation { struct CancellationState { requested: bool, command_fd: Option, + statistics_pending: bool, } impl Cancellation { @@ -82,7 +84,31 @@ impl Cancellation { } fn detach(&self) { - self.state.lock().unwrap().command_fd = None; + let mut state = self.state.lock().unwrap(); + state.command_fd = None; + state.statistics_pending = false; + } + + fn request_statistics(&self) -> io::Result { + let mut state = self.state.lock().unwrap(); + if state.requested || state.statistics_pending { + return Ok(false); + } + let Some(fd) = state.command_fd else { + return Ok(false); + }; + match ffi::write_statistics(fd) { + Ok(()) => { + state.statistics_pending = true; + Ok(true) + } + Err(error) if error.kind() == io::ErrorKind::WouldBlock => Ok(false), + Err(error) => Err(error), + } + } + + fn statistics_received(&self) { + self.state.lock().unwrap().statistics_pending = false; } fn cancel(&self) -> io::Result<()> { @@ -110,7 +136,8 @@ pub struct Vpn { host_id: Option, local_hostname: Option, - script: CString, + script: Option, + pub(crate) network_configuration_handler: Option>, interface: Option, script_tun: bool, @@ -131,9 +158,45 @@ pub struct Vpn { callback: OnConnectedCallback, hip_report_callback: OnHipReportCallback, + tunnel_callback: OnTunnelCallback, + observed_transport: Mutex>, } impl Vpn { + /// Install before `connect`. The observer runs synchronously on the native + /// connection thread and must return promptly. Clear it after joining connect. + pub fn set_tunnel_observer(&self, callback: impl Fn(crate::tunnel::Event) + Send + Sync + 'static) { + *self.tunnel_callback.write().unwrap() = Some(Arc::new(callback)); + } + + pub fn clear_tunnel_observer(&self) { + *self.tunnel_callback.write().unwrap() = None; + } + + /// Signal a nonblocking statistics request. False means no command was issued + /// because collection was coalesced, unavailable, cancelled, or the pipe full. + pub fn request_statistics(&self) -> io::Result { + self.cancellation.request_statistics() + } + + pub(crate) fn statistics_received(&self) { + self.cancellation.statistics_received(); + } + + pub(crate) fn on_tunnel_event(&self, event: crate::tunnel::Event) { + if let crate::tunnel::Event::Transport(transport) = &event { + let mut previous = self.observed_transport.lock().unwrap(); + if previous.as_ref() == Some(transport) { + return; + } + *previous = Some(*transport); + } + let callback = self.tunnel_callback.read().unwrap().clone(); + if let Some(callback) = callback { + callback(event); + } + } + pub fn builder(server: &str, cookie: &str) -> VpnBuilder { VpnBuilder::new(server, cookie) } @@ -217,7 +280,11 @@ impl Vpn { host_id: Self::option_to_ptr(&self.host_id), local_hostname: Self::option_to_ptr(&self.local_hostname), - script: self.script.as_ptr(), + script: Self::option_to_ptr(&self.script), + configure_network: self + .network_configuration_handler + .as_ref() + .map(|_| ffi::configure_network as _), interface: Self::option_to_ptr(&self.interface), script_tun: self.script_tun as u32, @@ -275,6 +342,7 @@ pub struct VpnBuilder { server: String, cookie: String, script: Option, + network_configuration_handler: Option>, script_is_path: bool, interface: Option, script_tun: bool, @@ -307,6 +375,7 @@ impl VpnBuilder { server: server.to_string(), cookie: cookie.to_string(), script: None, + network_configuration_handler: None, script_is_path: false, interface: None, script_tun: false, @@ -345,6 +414,17 @@ impl VpnBuilder { self } + /// Handle network configuration synchronously on OpenConnect's connection thread. + /// Replaces the external configuration script, not the tunnel device or packet I/O. + /// The handler receives a snapshot; it must not mutate the process environment. + pub fn network_configuration_handler( + mut self, + handler: impl Fn(&NetworkConfiguration) -> io::Result<()> + Send + Sync + 'static, + ) -> Self { + self.network_configuration_handler = Some(Arc::new(handler)); + self + } + pub fn interface>>(mut self, interface: T) -> Self { self.interface = interface.into(); self @@ -435,8 +515,16 @@ impl VpnBuilder { self } - fn determine_script(&self) -> Result { - match &self.script { + fn resolve_script(&self) -> Result, VpnError> { + if self.network_configuration_handler.is_some() { + if self.script.is_some() || self.script_tun { + return Err(VpnError::new( + "Network configuration handler conflicts with script options".into(), + )); + } + return Ok(None); + } + let script = match &self.script { Some(script) => { if self.script_is_path && !std::path::Path::new(script).exists() { return Err(VpnError::new(format!("VPN script does not exist: {script}"))); @@ -445,16 +533,17 @@ impl VpnBuilder { Ok(script.clone()) } None => find_vpnc_script().ok_or_else(|| VpnError::new(String::from("Failed to find vpnc-script"))), - } - } - - pub fn build(self) -> Result { - let script = self.determine_script()?; + }?; let script = if self.script_is_path || self.script.is_none() { shell_quote_path(&script) } else { script }; + Ok(Some(Self::to_cstring(&script))) + } + + pub fn build(self) -> Result { + let script = self.resolve_script()?; let user_agent = self.user_agent.unwrap_or_default(); let os = self.os.unwrap_or("linux".to_string()); @@ -471,7 +560,8 @@ impl VpnBuilder { host_id: self.host_id.as_deref().map(Self::to_cstring), local_hostname: self.local_hostname.as_deref().map(Self::to_cstring), - script: Self::to_cstring(&script), + script, + network_configuration_handler: self.network_configuration_handler, interface: self.interface.as_deref().map(Self::to_cstring), script_tun: self.script_tun, @@ -491,6 +581,8 @@ impl VpnBuilder { callback: Default::default(), hip_report_callback: Default::default(), + tunnel_callback: Default::default(), + observed_transport: Default::default(), }) } @@ -525,7 +617,7 @@ mod tests { .build() .unwrap(); - assert_eq!(vpn.script.to_str().unwrap(), command); + assert_eq!(vpn.script.as_ref().unwrap().to_str().unwrap(), command); } #[test] @@ -535,7 +627,7 @@ mod tests { .build() .unwrap(); - assert_eq!(vpn.script.to_str().unwrap(), "'/bin/sh'"); + assert_eq!(vpn.script.as_ref().unwrap().to_str().unwrap(), "'/bin/sh'"); } #[test] @@ -598,7 +690,8 @@ mod tests { client_version: None, host_id: Some(CString::new("profile-host-id").unwrap()), local_hostname: None, - script: CString::new("/bin/true").unwrap(), + script: Some(CString::new("/bin/true").unwrap()), + network_configuration_handler: None, interface: None, script_tun: false, certificate: None, @@ -614,6 +707,8 @@ mod tests { no_xmlpost: false, callback: Default::default(), hip_report_callback: Default::default(), + tunnel_callback: Default::default(), + observed_transport: Default::default(), }; let options = vpn.build_connect_options(); @@ -661,23 +756,38 @@ mod tests { ffi::{c_int, c_void}, fs::File, os::fd::AsFd, + os::unix::process::CommandExt, process::{Command, Stdio}, }; const CHILD: &str = "OPENCONNECT_TEST_PIPE_FAILURE"; if std::env::var_os(CHILD).is_none() { // Limit descriptors only in a subprocess, leaving the test runner untouched. - let output = Command::new("sh") + let mut child = Command::new(std::env::current_exe().unwrap()); + child .args([ - "-c", - "ulimit -n 64 && exec \"$1\" --exact vpn::tests::command_pipe_failure_preserves_stdin --nocapture", - "sh", + "--exact", + "vpn::tests::command_pipe_failure_preserves_stdin", + "--nocapture", ]) - .arg(std::env::current_exe().unwrap()) .env(CHILD, "1") - .stdin(Stdio::null()) - .output() - .unwrap(); + .stdin(Stdio::null()); + // Launch directly: system shells can strip the dynamic-library search + // environment required by the replaceable macOS OpenConnect library. + unsafe { + child.pre_exec(|| { + let limit = libc::rlimit { + rlim_cur: 64, + rlim_max: 64, + }; + if libc::setrlimit(libc::RLIMIT_NOFILE, &limit) == 0 { + Ok(()) + } else { + Err(io::Error::last_os_error()) + } + }); + } + let output = child.output().unwrap(); assert!( output.status.success(), "{}\n{}", @@ -812,4 +922,54 @@ mod tests { cancellation.cancel().unwrap(); assert_eq!(reader.read(&mut [0]).unwrap_err().kind(), io::ErrorKind::WouldBlock); } + + #[test] + fn statistics_are_coalesced_and_fenced_by_cancellation_and_detach() { + use std::{ + io::Read, + os::{fd::AsRawFd, unix::net::UnixStream}, + }; + let cancellation = Cancellation::default(); + let (mut reader, writer) = UnixStream::pair().unwrap(); + reader.set_nonblocking(true).unwrap(); + assert!(!cancellation.request_statistics().unwrap()); + assert!(!cancellation.attach(writer.as_raw_fd())); + assert!(cancellation.request_statistics().unwrap()); + assert!(!cancellation.request_statistics().unwrap()); + let mut command = [0]; + reader.read_exact(&mut command).unwrap(); + assert_eq!(command, [b's']); + cancellation.statistics_received(); + assert!(cancellation.request_statistics().unwrap()); + reader.read_exact(&mut command).unwrap(); + cancellation.cancel().unwrap(); + assert!(!cancellation.request_statistics().unwrap()); + reader.read_exact(&mut command).unwrap(); + assert_eq!(command, [b'x']); + cancellation.detach(); + assert!(!cancellation.state.lock().unwrap().statistics_pending); + assert!(!cancellation.request_statistics().unwrap()); + assert_eq!(reader.read(&mut command).unwrap_err().kind(), io::ErrorKind::WouldBlock); + } + + #[test] + fn full_command_pipe_does_not_latch_a_statistics_request() { + use std::{ + io::{Read, Write}, + os::{fd::AsRawFd, unix::net::UnixStream}, + }; + let cancellation = Cancellation::default(); + let (mut reader, mut writer) = UnixStream::pair().unwrap(); + reader.set_nonblocking(true).unwrap(); + writer.set_nonblocking(true).unwrap(); + while writer.write(&[0; 1024]).is_ok() {} + while writer.write(&[0]).is_ok() {} + assert!(!cancellation.attach(writer.as_raw_fd())); + assert!(!cancellation.request_statistics().unwrap()); + assert!(!cancellation.state.lock().unwrap().statistics_pending); + let mut bytes = [0; 4096]; + while reader.read(&mut bytes).is_ok() {} + assert!(cancellation.request_statistics().unwrap()); + cancellation.detach(); + } } diff --git a/crates/openconnect/tests/esp_gateway.c b/crates/openconnect/tests/esp_gateway.c new file mode 100644 index 0000000..98a9bff --- /dev/null +++ b/crates/openconnect/tests/esp_gateway.c @@ -0,0 +1,202 @@ +/* Exercise the production parser and probe dispatch, inspecting packets at the + * encryption boundary. No VPN server, privileged networking, or real keys. */ +#define construct_esp_packet inspect_esp_packet +#define openconnect_open_https fixture_open_https +#include "gpst.c" +#undef construct_esp_packet +#undef openconnect_open_https +#include "gpst_nlb.c" +#include + +static const char *expected_destination; +static int packets_inspected; +static enum openconnect_tunnel_event observed_events[4]; +static int observed_count; +static int ssl_response_valid; + +int fixture_open_https(struct openconnect_info *vpninfo) +{ + return 0; +} + +static int fixture_ssl_write(struct openconnect_info *vpninfo, char *buf, size_t len) +{ + return len; +} + +static int fixture_ssl_read(struct openconnect_info *vpninfo, char *buf, size_t len) +{ + const char *response = ssl_response_valid ? "START_TUNNEL" : "invalid"; + assert(len >= strlen(response)); + memcpy(buf, response, strlen(response)); + return strlen(response); +} + +static void observe_transport(void *data, enum openconnect_tunnel_event event) +{ + assert(observed_count < 4); + observed_events[observed_count++] = event; +} + +static void progress(void *data, int level, const char *format, ...) +{ + if (level > PRG_INFO) + return; + va_list args; + va_start(args, format); + vfprintf(stderr, format, args); + va_end(args); +} + +int inspect_esp_packet(struct openconnect_info *vpninfo, struct pkt *pkt, uint8_t next_header) +{ + struct in_addr destination; + struct ip *ip = (void *)pkt->data; + struct icmp *icmp = (void *)(pkt->data + sizeof(*ip)); + const unsigned char *payload; + size_t payload_len; + + assert(inet_pton(AF_INET, expected_destination, &destination) == 1); + assert(next_header == IPPROTO_IPIP); + assert(ip->ip_v == 4 && ip->ip_p == IPPROTO_ICMP); + assert(ip->ip_dst.s_addr == destination.s_addr); + assert(ip->ip_src.s_addr == inet_addr("10.253.0.120")); + assert(icmp->icmp_type == ICMP_ECHO); + if (vpninfo->gp_nlb.enabled) + payload = gpst_nlb_probe_payload(&payload_len); + else { + payload = (const unsigned char *)magic_ping_payload_gcm; + payload_len = sizeof(magic_ping_payload_gcm); + } + assert(pkt->len == sizeof(*ip) + ICMP_MINLEN + payload_len); + assert(!memcmp(pkt->data + sizeof(*ip) + ICMP_MINLEN, payload, payload_len)); + packets_inspected++; + /* Send a placeholder datagram over a local socket pair. */ + return 1; +} + +int main(int argc, char **argv) +{ + static const char key[] = + "000000000000000000000000000000000000000000000000000000000000000000000000"; + static const char nlb_config[] = + "256" + "0000000000000000000000000000000000000000000000000000000000000000" + "fixture" + "fixture3600"; + const char *gateway = "0.0.0.0", *default_gateway = "192.0.2.10"; + char xml[4096], gateway_xml[128]; + struct sockaddr_in peer = { .sin_family = AF_INET }; + struct openconnect_info *vpninfo; + xmlDoc *doc; + int sockets[2], nlb, invalid, length; + + assert(argc == 2); + nlb = !strncmp(argv[1], "nlb-", 4); + invalid = !strcmp(argv[1], "regular-invalid") || !strcmp(argv[1], "regular-missing"); + if (!strcmp(argv[1], "regular-address") || !strcmp(argv[1], "nlb-address")) + gateway = "192.0.2.1"; + else if (!strcmp(argv[1], "regular-invalid")) + gateway = "invalid"; + if (!strcmp(argv[1], "nlb-client-vip")) + default_gateway = "0.0.0.0"; + if (!strcmp(argv[1], "regular-missing")) + gateway_xml[0] = 0; + else + snprintf(gateway_xml, sizeof(gateway_xml), "%s", gateway); + length = snprintf(xml, sizeof(xml), + "%s10.253.0.120" + "%s" + "4501aes-256-gcmsha1" + "0x123456780x87654321" + "288%s" + "288%s" + "%s", gateway_xml, default_gateway, key, key, nlb ? nlb_config : ""); + assert(length > 0 && length < sizeof(xml)); + doc = xmlReadMemory(xml, length, "config.xml", NULL, XML_PARSE_NONET); + assert(doc); + vpninfo = openconnect_vpninfo_new("ESP gateway test", NULL, NULL, NULL, progress, NULL); + assert(vpninfo); + assert(!openconnect_set_protocol(vpninfo, "gp")); + vpninfo->peer_addr = malloc(sizeof(peer)); + assert(vpninfo->peer_addr); + memcpy(vpninfo->peer_addr, &peer, sizeof(peer)); + assert(!gpst_parse_config_xml(vpninfo, xmlDocGetRootElement(doc), NULL)); + xmlFreeDoc(doc); + assert(!!vpninfo->gp_nlb.enabled == nlb); + if (invalid) { + assert(!vpninfo->esp_magic_af); + assert(!vpninfo->delay_tunnel_reason); + openconnect_vpninfo_free(vpninfo); + return 0; + } + assert(vpninfo->esp_magic_af == AF_INET); + assert(!memcmp(vpninfo->esp_magic, &(struct in_addr){ .s_addr = inet_addr(gateway) }, 4)); + assert(vpninfo->delay_tunnel_reason); + assert(vpninfo->dtls_state == DTLS_SECRET); + assert(!socketpair(AF_UNIX, SOCK_DGRAM, 0, sockets)); + vpninfo->dtls_fd = sockets[0]; + if (nlb) { + const char *vip = gateway; + if (!strcmp(gateway, "0.0.0.0")) { + vip = default_gateway; + if (!strcmp(default_gateway, "0.0.0.0")) + vip = "10.253.0.120"; + } + assert(vpninfo->gp_nlb.tunnel_vip); + assert(!strcmp(vpninfo->gp_nlb.tunnel_vip, vip)); + assert(!gpst_nlb_prepare(vpninfo)); + assert(vpninfo->gp_nlb.control_state == GP_NLB_CONTROL_PENDING); + assert(!gpst_nlb_control_ready(vpninfo)); + assert(!memcmp(vpninfo->esp_magic, &(struct in_addr){ .s_addr = inet_addr(vip) }, 4)); + /* Model completed tunnel control: keepalives must use the real inner + * gateway, not the zero probe address or the initial virtual IP. */ + vpninfo->gp_nlb.control_state = GP_NLB_CONTROL_READY; + vpninfo->gp_nlb.inner_gw_ip = strdup("192.0.2.20"); + expected_destination = "192.0.2.20"; + assert(!gpst_esp_send_probes(vpninfo)); + assert(packets_inspected == 3); + assert(vpninfo->gp_nlb.keepalive_sent); + free(vpninfo->gp_nlb.inner_gw_ip); + vpninfo->gp_nlb.inner_gw_ip = NULL; + expected_destination = vip; + assert(!gpst_nlb_send_esp_keepalive(vpninfo)); + assert(packets_inspected == 4); + } else { + assert(!vpninfo->gp_nlb.tunnel_vip || strcmp(vpninfo->gp_nlb.tunnel_vip, "0.0.0.0")); + expected_destination = gateway; + assert(!gpst_esp_send_probes(vpninfo)); + assert(packets_inspected == 1); + /* Configuration/probes alone do not advertise ESP. Exercise the actual + * GP activation and ESP shutdown paths rather than synthesizing events. */ + int timeout = 1000; + openconnect_set_tunnel_handler(vpninfo, observe_transport); + assert(observed_count == 0); + vpninfo->dtls_state = DTLS_CONNECTED; + memset(&vpninfo->ssl_times, 0, sizeof(vpninfo->ssl_times)); + vpninfo->trojan_interval = 0; + assert(!gpst_mainloop(vpninfo, &timeout, 0)); + assert(vpninfo->dtls_state == DTLS_ESTABLISHED); + assert(observed_count == 1 && observed_events[0] == OC_TUNNEL_IPSEC_ESP); + esp_close(vpninfo); + assert(observed_count == 2 && observed_events[1] == OC_TUNNEL_UNAVAILABLE); + /* Repeated shutdown of an inactive transport cannot claim another loss. */ + esp_close(vpninfo); + assert(observed_count == 2); + /* Replace only HTTPS I/O: run the actual SSL response acceptance path. */ + vpninfo->dtls_state = DTLS_DISABLED; + vpninfo->ssl_read = fixture_ssl_read; + vpninfo->ssl_write = fixture_ssl_write; + openconnect_set_cookie(vpninfo, "user=test&authcookie=fixture"); + free(vpninfo->urlpath); + vpninfo->urlpath = strdup("ssl-tunnel-connect.sslvpn"); + assert(gpst_connect(vpninfo) == -EINVAL); + assert(observed_count == 2); + ssl_response_valid = 1; + assert(!gpst_connect(vpninfo)); + assert(observed_count == 3 && observed_events[2] == OC_TUNNEL_SSL_TLS); + } + close(sockets[1]); + openconnect_vpninfo_free(vpninfo); + return 0; +} diff --git a/crates/openconnect/tests/esp_gateway.rs b/crates/openconnect/tests/esp_gateway.rs new file mode 100644 index 0000000..f38a209 --- /dev/null +++ b/crates/openconnect/tests/esp_gateway.rs @@ -0,0 +1,60 @@ +use std::{fs, path::PathBuf, process::Command}; + +#[test] +fn c_esp_gateway_configuration_and_probes() { + let manifest = PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let build = PathBuf::from(env!("OPENCONNECT_PROTOCOL_BUILD")); + let source = PathBuf::from(env!("OPENCONNECT_PROTOCOL_SOURCE")); + let directory = tempfile::tempdir().unwrap(); + let executable = directory.path().join("esp-gateway"); + let mut packages = vec!["libxml-2.0", "gnutls"]; + if fs::read_to_string(build.join("config.h")) + .unwrap() + .contains("#define HAVE_LZ4 ") + { + packages.push("liblz4"); + } + let flags = Command::new("pkg-config") + .arg("--cflags") + .args(packages) + .output() + .unwrap(); + assert!(flags.status.success(), "{}", String::from_utf8_lossy(&flags.stderr)); + let output = Command::new(build.join("libtool")) + .args(["--mode=link", "cc"]) + .arg(manifest.join("tests/esp_gateway.c")) + .arg("-I") + .arg(&build) + .arg("-I") + .arg(&source) + .arg("-I") + .arg(source.join("json")) + .args(String::from_utf8(flags.stdout).unwrap().split_whitespace()) + .arg(build.join("libopenconnect.la")) + .arg("-o") + .arg(&executable) + .output() + .unwrap(); + assert!(output.status.success(), "{}", String::from_utf8_lossy(&output.stderr)); + for case in [ + "regular-zero", + "regular-address", + "regular-invalid", + "regular-missing", + "nlb-zero", + "nlb-address", + "nlb-client-vip", + ] { + let output = Command::new(build.join("libtool")) + .arg("--mode=execute") + .arg(&executable) + .arg(case) + .output() + .unwrap(); + assert!( + output.status.success(), + "{case}: {}", + String::from_utf8_lossy(&output.stderr) + ); + } +} diff --git a/crates/openconnect/tests/hip_protocol.rs b/crates/openconnect/tests/hip_protocol.rs index 2f38760..2faa010 100644 --- a/crates/openconnect/tests/hip_protocol.rs +++ b/crates/openconnect/tests/hip_protocol.rs @@ -34,11 +34,7 @@ fn c_protocol_submits_initial_periodic_and_reconnect_reports() { fs::create_dir(&directory.0).unwrap(); let executable = directory.0.join("hip-protocol"); let flags = Command::new("pkg-config") - .args([ - "--cflags", - "libxml-2.0", - if cfg!(target_os = "macos") { "openssl" } else { "gnutls" }, - ]) + .args(["--cflags", "libxml-2.0", "gnutls"]) .output() .unwrap(); assert!(flags.status.success()); diff --git a/crates/openconnect/tests/network_configuration.c b/crates/openconnect/tests/network_configuration.c new file mode 100644 index 0000000..0c2644f --- /dev/null +++ b/crates/openconnect/tests/network_configuration.c @@ -0,0 +1,203 @@ +/* No privileged networking: exercise the actual configuration dispatcher. */ +#include +#include "openconnect-internal.h" +#include + +struct state { + pid_t parent; + const char *reason; + int calls; + int result; + const char *failure_reason; + const char **expected_reasons; + int expected_count; + int tcp_connections; + int reconnection_notifications; + int reconnect_started; +}; + +static int configure(void *data, const char *reason, const struct oc_vpn_option *env) +{ + struct state *state = data; + const struct oc_vpn_option *option; + int found = 0; + assert(getpid() == state->parent); + if (state->expected_reasons) { + assert(state->calls < state->expected_count); + assert(!strcmp(reason, state->expected_reasons[state->calls])); + } else { + assert(!strcmp(reason, state->reason)); + } + for (option = env; option; option = option->next) { + if (!strcmp(option->option, "GP_TEST_CONFIG")) { + assert(!strcmp(option->value, "child value")); + found = 1; + } + } + assert(found); + assert(!strcmp(getenv("GP_TEST_CONFIG"), "parent value")); + state->calls++; + return !state->failure_reason || !strcmp(reason, state->failure_reason) ? state->result : 0; +} + +static void progress(void *data, int level, const char *format, ...) {} + + +/* The production library.c is compiled with os_setup_tun redirected here. + * All setup, configuration dispatch, attachment, and cleanup code stays real. */ +static int device_fd = -1; +static int device_creations; +intptr_t test_os_setup_tun(struct openconnect_info *vpninfo) +{ + device_creations++; + assert(device_fd >= 0); + free(vpninfo->ifname); + vpninfo->ifname = strdup("gp-test-tun"); + assert(vpninfo->ifname); + return device_fd; +} + +static struct openconnect_info *new_vpn(struct state *state) +{ + struct openconnect_info *vpninfo = openconnect_vpninfo_new("network callback test", NULL, NULL, NULL, progress, state); + assert(vpninfo); + script_setenv(vpninfo, "GP_TEST_CONFIG", "child value", 0, 0); + openconnect_set_configure_tun_handler(vpninfo, state, configure); + return vpninfo; +} + +static void connect_failure_rolls_back(void) +{ + const char *expected[] = { "pre-init", "connect", "disconnect" }; + struct state state = { + .parent = getpid(), .result = -EPERM, .failure_reason = "connect", + .expected_reasons = expected, .expected_count = 3, + }; + struct openconnect_info *vpninfo = new_vpn(&state); + int fds[2]; + assert(!pipe(fds)); + device_fd = fds[0]; + assert(openconnect_setup_tun_device(vpninfo, NULL, NULL) == -EPERM); + assert(device_creations == 1); + assert(state.calls == 3); + assert(vpninfo->tun_fd == -1); + assert(fcntl(fds[0], F_GETFD) == -1 && errno == EBADF); + close(fds[1]); + openconnect_vpninfo_free(vpninfo); + /* Freeing an already rolled-back connection must not disconnect again. */ + assert(state.calls == 3); + device_fd = -1; +} + +static int tcp_connect(struct openconnect_info *vpninfo) +{ + struct state *state = vpninfo->cbdata; + state->tcp_connections++; + return 0; +} + +static void reconnected(void *data) +{ + struct state *state = data; + state->reconnection_notifications++; +} + +static void tunnel_event(void *data, enum openconnect_tunnel_event event) +{ + struct state *state = data; + assert(event == OC_TUNNEL_RECONNECTING); + state->reconnect_started++; + /* Start observation precedes configuration callbacks and new TCP work. */ + assert(state->calls == 0); +} + +static void reconnect_refusal_propagates(void) +{ + const char *expected[] = { "attempt-reconnect", "reconnect" }; + struct state state = { + .parent = getpid(), .result = -EPERM, .failure_reason = "attempt-reconnect", + .expected_reasons = expected, .expected_count = 1, + }; + struct openconnect_info *vpninfo = new_vpn(&state); + const struct vpn_proto *original = vpninfo->proto; + struct vpn_proto protocol = *original; + int fds[2]; + assert(!pipe(fds)); + vpninfo->tun_fd = fds[0]; + protocol.tcp_connect = tcp_connect; + protocol.proto = PROTO_GPST; + vpninfo->proto = &protocol; + openconnect_set_reconnected_handler(vpninfo, reconnected); + openconnect_set_tunnel_handler(vpninfo, tunnel_event); + + /* Attempt refusal prevents even the protocol's reconnect request. */ + assert(ssl_reconnect(vpninfo) == -EPERM); + assert(state.calls == 1 && state.tcp_connections == 0); + assert(state.reconnection_notifications == 0); + + /* Post-reconnect refusal prevents the successful reconnection observer. */ + state.calls = 0; + state.expected_count = 2; + state.failure_reason = "reconnect"; + state.result = -EACCES; + assert(ssl_reconnect(vpninfo) == -EACCES); + assert(state.calls == 2 && state.tcp_connections == 1); + assert(state.reconnection_notifications == 0); + + state.calls = 0; + state.result = 0; + assert(!ssl_reconnect(vpninfo)); + assert(state.calls == 2 && state.tcp_connections == 2); + assert(state.reconnection_notifications == 1); + assert(state.reconnect_started == 3); + + state.expected_reasons = NULL; + state.reason = "disconnect"; + os_shutdown_tun(vpninfo); + assert(fcntl(fds[0], F_GETFD) == -1 && errno == EBADF); + close(fds[1]); + vpninfo->proto = original; + openconnect_vpninfo_free(vpninfo); +} + +int main(void) +{ + const char *reasons[] = { "pre-init", "connect", "attempt-reconnect", "reconnect", "disconnect" }; + struct state state = { .parent = getpid() }; + struct openconnect_info *vpninfo = new_vpn(&state); + int fds[2], i; + assert(vpninfo); + assert(!setenv("GP_TEST_CONFIG", "parent value", 1)); + script_setenv(vpninfo, "GP_TEST_CONFIG", "child value", 0, 0); + openconnect_set_configure_tun_handler(vpninfo, &state, configure); + /* A callback works without an external script and executes before fork. */ + assert(!vpninfo->vpnc_script); + for (i = 0; i < 5; i++) { + state.reason = reasons[i]; + assert(!script_config_tun(vpninfo, reasons[i])); + } + assert(state.calls == 5); + state.result = -EPERM; + state.reason = "pre-init"; + /* Refusal propagates before attempting to create an OS tunnel device. */ + assert(openconnect_setup_tun_device(vpninfo, NULL, NULL) == -EPERM); + assert(vpninfo->tun_fd == -1); + assert(device_creations == 0); + state.result = 0; + state.reason = "disconnect"; + /* The callback path owns the created descriptor even with no script path. */ + assert(!pipe(fds)); + vpninfo->tun_fd = fds[0]; + os_shutdown_tun(vpninfo); + assert(vpninfo->tun_fd == -1); + assert(fcntl(fds[0], F_GETFD) == -1 && errno == EBADF); + close(fds[1]); + assert(state.calls == 7); + openconnect_set_configure_tun_handler(vpninfo, NULL, NULL); + assert(!script_config_tun(vpninfo, "connect")); + assert(state.calls == 7); + openconnect_vpninfo_free(vpninfo); + connect_failure_rolls_back(); + reconnect_refusal_propagates(); + return 0; +} diff --git a/crates/openconnect/tests/network_configuration.rs b/crates/openconnect/tests/network_configuration.rs new file mode 100644 index 0000000..0b76ee1 --- /dev/null +++ b/crates/openconnect/tests/network_configuration.rs @@ -0,0 +1,49 @@ +use std::{fs, path::PathBuf, process::Command}; + +#[test] +fn c_network_configuration_lifecycle_and_failure_paths() { + let manifest = PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let build = PathBuf::from(env!("OPENCONNECT_PROTOCOL_BUILD")); + let source = PathBuf::from(env!("OPENCONNECT_PROTOCOL_SOURCE")); + let directory = std::env::temp_dir().join(format!("gp-network-configuration-{}", std::process::id())); + fs::create_dir_all(&directory).unwrap(); + let executable = directory.join("network-configuration"); + let flags = Command::new("pkg-config") + .args(["--cflags", "libxml-2.0", "gnutls"]) + .output() + .unwrap(); + assert!(flags.status.success()); + let output = Command::new(build.join("libtool")) + .args(["--mode=link", "cc"]) + .arg(manifest.join("tests/network_configuration.c")) + // Compile the production setup implementation with only OS device creation + // replaced, so rollback is exercised without privileges or a real TUN. + .arg(source.join("library.c")) + .arg("-Dos_setup_tun=test_os_setup_tun") + .arg("-I") + .arg(&build) + .arg("-I") + .arg(&source) + .arg("-I") + .arg(source.join("json")) + .args(String::from_utf8(flags.stdout).unwrap().split_whitespace()) + .arg(build.join("libopenconnect.la")) + .arg("-o") + .arg(&executable) + .output() + .unwrap(); + assert!( + output.status.success(), + "{}: {}", + output.status, + String::from_utf8_lossy(&output.stderr) + ); + let output = Command::new(&executable).output().unwrap(); + fs::remove_dir_all(&directory).unwrap(); + assert!( + output.status.success(), + "{}: {}", + output.status, + String::from_utf8_lossy(&output.stderr) + ); +} diff --git a/crates/openconnect/tests/tls_backend.c b/crates/openconnect/tests/tls_backend.c new file mode 100644 index 0000000..8aabfd7 --- /dev/null +++ b/crates/openconnect/tests/tls_backend.c @@ -0,0 +1,154 @@ +/* Exercise the production OpenConnect TLS client against a local GnuTLS peer. */ +#include +#include "openconnect-internal.h" +#include +#include +#include +#include +#include + +struct peer { + int listener, legacy, expect_rejection, handshake, renegotiation, require_identity; + gnutls_certificate_credentials_t credentials; +}; +struct policy { int accept, calls, unsafe_renegotiation_denied; }; + +static void progress(void *data, int level, const char *format, ...) +{ + va_list args; + char message[2048]; + struct policy *policy = data; + if (level > PRG_DEBUG) return; + va_start(args, format); + vsnprintf(message, sizeof(message), format, args); + va_end(args); + fputs(message, stderr); + if (strstr(message, gnutls_strerror(GNUTLS_E_UNSAFE_RENEGOTIATION_DENIED))) + policy->unsafe_renegotiation_denied = 1; +} + +static int certificate_policy(void *data, const char *reason) +{ + struct policy *policy = data; + assert(reason && *reason); + policy->calls++; + return policy->accept ? 0 : -EINVAL; +} + +static void *serve(void *data) +{ + struct peer *peer = data; + gnutls_session_t session; + int fd = accept(peer->listener, NULL, NULL); + struct timeval timeout = { .tv_sec = 5 }; + assert(fd >= 0); + assert(!setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, &timeout, sizeof(timeout))); + assert(!setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO, &timeout, sizeof(timeout))); + assert(!gnutls_init(&session, GNUTLS_SERVER)); + assert(!gnutls_priority_set_direct(session, peer->legacy + ? "NORMAL:-VERS-ALL:+VERS-TLS1.2:%DISABLE_SAFE_RENEGOTIATION" + : "NORMAL:-VERS-ALL:+VERS-TLS1.2", NULL)); + assert(!gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, peer->credentials)); + if (peer->require_identity) + gnutls_certificate_server_set_request(session, GNUTLS_CERT_REQUIRE); + gnutls_transport_set_int(session, fd); + gnutls_handshake_set_timeout(session, 5000); + peer->handshake = gnutls_handshake(session); + if (!peer->expect_rejection) { + unsigned int status, count; + assert(!peer->handshake); + if (peer->require_identity) { + assert(gnutls_certificate_get_peers(session, &count) && count > 0); + assert(!gnutls_certificate_verify_peers2(session, &status)); + assert(!status); + } + assert(gnutls_safe_renegotiation_status(session) == !peer->legacy); + assert(gnutls_record_send(session, "OK", 2) == 2); + if (peer->legacy) { + assert(!gnutls_rehandshake(session)); + peer->renegotiation = gnutls_handshake(session); + } + } + gnutls_deinit(session); + close(fd); + return NULL; +} + +static void check(const char *cert, const char *key, const char *ca, + int legacy, int trusted, int accept_certificate, const char *identity, const char *identity_key) +{ + struct peer peer = { .legacy = legacy, .expect_rejection = !trusted && !accept_certificate, + .require_identity = identity != NULL }; + struct policy policy = { .accept = accept_certificate }; + struct sockaddr_in address = { .sin_family = AF_INET, .sin_addr.s_addr = htonl(INADDR_LOOPBACK) }; + socklen_t address_length = sizeof(address); + pthread_t thread; + char url[128], record[16]; + int result; + struct openconnect_info *client; + assert(!gnutls_certificate_allocate_credentials(&peer.credentials)); + assert(!gnutls_certificate_set_x509_key_file(peer.credentials, cert, key, GNUTLS_X509_FMT_PEM)); + if (peer.require_identity) + assert(gnutls_certificate_set_x509_trust_file(peer.credentials, ca, GNUTLS_X509_FMT_PEM) > 0); + peer.listener = socket(AF_INET, SOCK_STREAM, 0); + assert(peer.listener >= 0); + assert(!bind(peer.listener, (struct sockaddr *)&address, sizeof(address))); + assert(!getsockname(peer.listener, (struct sockaddr *)&address, &address_length)); + assert(!listen(peer.listener, 1)); + assert(!pthread_create(&thread, NULL, serve, &peer)); + client = openconnect_vpninfo_new("TLS backend regression", certificate_policy, NULL, NULL, progress, &policy); + assert(client); + /* localhost matches the fixture certificate; no external DNS or connection. */ + snprintf(url, sizeof(url), "https://localhost:%u/", ntohs(address.sin_port)); + assert(!openconnect_parse_url(client, url)); + if (trusted) assert(!openconnect_set_cafile(client, ca)); + if (identity) assert(!openconnect_set_client_cert(client, identity, identity_key)); + result = openconnect_open_https(client); + if (peer.expect_rejection) { + assert(result < 0); + assert(policy.calls == 1); + } else { + assert(!result); + assert(policy.calls == !trusted); + assert(client->ssl_read(client, record, sizeof(record)) == 2); + assert(!memcmp(record, "OK", 2)); + if (legacy) { + assert(client->ssl_read(client, record, sizeof(record)) < 0); + /* OpenConnect translates backend failures to -EIO. Its progress + * callback preserves the specific GnuTLS failure; require that + * reason so a timeout/disconnect cannot pass as policy refusal. */ + assert(policy.unsafe_renegotiation_denied); + } + } + openconnect_vpninfo_free(client); + assert(!pthread_join(thread, NULL)); + if (legacy) { + assert(peer.renegotiation < 0); + } + close(peer.listener); + gnutls_certificate_free_credentials(peer.credentials); +} + +int main(int argc, char **argv) +{ + assert(argc == 6); + signal(SIGPIPE, SIG_IGN); + assert(!openconnect_init_ssl()); +#ifdef __APPLE__ + /* Read-only check of the source-built library's native Keychain integration. + * Local fixture trust is tested separately, without changing OS trust settings. */ + { + gnutls_certificate_credentials_t system; + assert(!gnutls_certificate_allocate_credentials(&system)); + assert(gnutls_certificate_set_x509_system_trust(system) > 0); + gnutls_certificate_free_credentials(system); + } +#endif + check(argv[1], argv[2], argv[3], 0, 1, 0, NULL, NULL); + check(argv[1], argv[2], argv[3], 0, 0, 0, NULL, NULL); + check(argv[1], argv[2], argv[3], 0, 0, 1, NULL, NULL); + check(argv[1], argv[2], argv[3], 1, 1, 0, NULL, NULL); + check(argv[1], argv[2], argv[3], 0, 1, 0, argv[4], argv[5]); + puts("OpenConnect: trusted TLS, certificate rejection/acceptance, legacy initial handshake, unsafe renegotiation refusal, mutual TLS passed"); + return 0; +} diff --git a/crates/openconnect/tests/tls_backend.rs b/crates/openconnect/tests/tls_backend.rs new file mode 100644 index 0000000..ef8065a --- /dev/null +++ b/crates/openconnect/tests/tls_backend.rs @@ -0,0 +1,90 @@ +use std::{ + fs, + os::unix::process::CommandExt, + path::{Path, PathBuf}, + process::{Child, Command}, + time::{Duration, Instant}, +}; + +struct TestDirectory(PathBuf); +impl Drop for TestDirectory { + fn drop(&mut self) { + let _ = fs::remove_dir_all(&self.0); + } +} + +struct ChildGuard(Child); +impl Drop for ChildGuard { + fn drop(&mut self) { + unsafe { libc::kill(-(self.0.id() as i32), libc::SIGKILL) }; + let _ = self.0.wait(); + } +} + +fn run_bounded(command: &mut Command, log: &Path) { + let output = fs::File::create(log).unwrap(); + let mut child = ChildGuard( + command + .process_group(0) + .stdout(output.try_clone().unwrap()) + .stderr(output) + .spawn() + .unwrap(), + ); + let deadline = Instant::now() + Duration::from_secs(45); + loop { + if let Some(status) = child.0.try_wait().unwrap() { + assert!(status.success(), "{status}: {}", fs::read_to_string(log).unwrap()); + return; + } + assert!( + Instant::now() < deadline, + "TLS test timed out: {}", + fs::read_to_string(log).unwrap() + ); + std::thread::sleep(Duration::from_millis(20)); + } +} + +#[test] +fn openconnect_certificate_policy_and_legacy_renegotiation() { + let manifest = PathBuf::from(env!("CARGO_MANIFEST_DIR")); + let build = PathBuf::from(env!("OPENCONNECT_PROTOCOL_BUILD")); + let source = PathBuf::from(env!("OPENCONNECT_PROTOCOL_SOURCE")); + let directory = TestDirectory(std::env::temp_dir().join(format!("gp-tls-backend-{}", std::process::id()))); + fs::create_dir(&directory.0).unwrap(); + let executable = directory.0.join("tls-backend"); + let flags = Command::new("pkg-config") + .args(["--cflags", "--libs", "libxml-2.0", "gnutls"]) + .output() + .unwrap(); + assert!(flags.status.success(), "{}", String::from_utf8_lossy(&flags.stderr)); + run_bounded( + Command::new(build.join("libtool")) + .args(["--mode=link", "cc", "-pthread"]) + .arg(manifest.join("tests/tls_backend.c")) + .arg("-I") + .arg(&build) + .arg("-I") + .arg(&source) + .arg("-I") + .arg(source.join("json")) + .arg(build.join("libopenconnect.la")) + .args(String::from_utf8(flags.stdout).unwrap().split_whitespace()) + .arg("-o") + .arg(&executable), + &directory.0.join("compile.log"), + ); + let certificates = manifest.join("deps/openconnect/tests/certs"); + run_bounded( + Command::new(build.join("libtool")) + .arg("--mode=execute") + .arg(executable) + .arg(certificates.join("server-cert.pem")) + .arg(certificates.join("server-key.pem")) + .arg(certificates.join("ca.pem")) + .arg(certificates.join("user-cert.pem")) + .arg(certificates.join("user-key-pkcs1.pem")), + &directory.0.join("runtime.log"), + ); +} diff --git a/flake.nix b/flake.nix index 32be958..cfcd585 100644 --- a/flake.nix +++ b/flake.nix @@ -29,8 +29,8 @@ cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml); pname = "globalprotect-openconnect"; version = cargoToml.workspace.package.version; - releaseTag = "v3.0.4"; - releaseVersion = "3.0.4"; + releaseTag = "v3.0.5"; + releaseVersion = "3.0.5"; toolchain = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml; @@ -55,8 +55,8 @@ cpu = pkgs.stdenv.hostPlatform.parsed.cpu.name; gpguiHashes = { - x86_64 = "sha256-T14EbI8ja9i9kbVP/LirAjGupPeUtrVQx41ls02dx2U="; - aarch64 = "sha256-DWR9uLMlmjai8LRarbhmxPr1Cg3ejtGkcxmxkfwwfEA="; + x86_64 = "sha256-b0hqpAr/Sz9z+UTCmAGV3eIO8sNUjrH34NZZYcLyzzw="; + aarch64 = "sha256-QQh/T/fknvPeZ1UdRCo2idiIBX1LTJHSwQ2MK/j3Gm0="; }; gpguiArchive = pkgs.fetchurl { @@ -70,8 +70,8 @@ }; binaryHashes = { - x86_64 = "sha256-TqOqrWhanDX9IHKcRxT0+3s5kSHr/pSqXDdMH/v+Bwg="; - aarch64 = "sha256-EhoJ4GvJX0/+HmZVuDCXMfiTRgiFmb0QvB5jDNvEb1I="; + x86_64 = "sha256-zbs/StUxfD3nf5mjUiGTu3CUI96SkB+r0DD6kcvCqjY="; + aarch64 = "sha256-QGuTJvAlj9maV++LFQGdjSZCUYafFx60AzyZjulnEes="; }; binaryArchive = pkgs.fetchurl { @@ -209,9 +209,12 @@ ''; }) {}; - prebuilt = lib.makeOverridable ({ binaries ? binaryPackage, gui ? gpgui }: pkgs.stdenv.mkDerivation { - inherit pname; - version = releaseVersion; + prebuilt = lib.makeOverridable ({ + binaries ? binaryPackage, + gui ? gpgui, + version ? releaseVersion, + }: pkgs.stdenv.mkDerivation { + inherit pname version; src = binaries; dontBuild = true; diff --git a/nix/ci.nix b/nix/ci.nix index c89b351..e7d48ca 100644 --- a/nix/ci.nix +++ b/nix/ci.nix @@ -19,7 +19,11 @@ let binaries = unpack "gp-ci-binaries" "GP_BINARY_ARCHIVE"; gui = unpack "gp-ci-gui" "GP_GUI_ARCHIVE"; sourcePackage = gp.packages.${system}.fromSource.override { inherit gui; }; - prebuiltPackage = gp.packages.${system}.prebuilt.override { inherit binaries gui; }; + prebuiltInputs = { + inherit binaries gui; + version = sourcePackage.version; + }; + prebuiltPackage = gp.packages.${system}.prebuilt.override prebuiltInputs; hostSystem = nixpkgs.lib.nixosSystem { inherit system; modules = [ @@ -27,9 +31,7 @@ let ({ options, ... }: { programs.globalprotect-openconnect = { enable = true; - package = options.programs.globalprotect-openconnect.package.default.override { - inherit binaries gui; - }; + package = options.programs.globalprotect-openconnect.package.default.override prebuiltInputs; }; system.stateVersion = "25.11"; }) @@ -38,8 +40,9 @@ let modulePackage = hostSystem.config.programs.globalprotect-openconnect.package; in { source = sourcePackage; - prebuilt = prebuiltPackage; - module = assert builtins.elem modulePackage hostSystem.config.environment.systemPackages; + prebuilt = assert prebuiltPackage.version == sourcePackage.version; prebuiltPackage; + module = assert modulePackage.version == sourcePackage.version; + assert builtins.elem modulePackage hostSystem.config.environment.systemPackages; assert hostSystem.config.services.ayatana-indicators.enable; assert hostSystem.config.security.polkit.enable; assert hostSystem.config.security.wrappers.pkexec.enable; diff --git a/packaging/aur/globalprotect-openconnect-git/.SRCINFO b/packaging/aur/globalprotect-openconnect-git/.SRCINFO index 54c5d0e..d035828 100644 --- a/packaging/aur/globalprotect-openconnect-git/.SRCINFO +++ b/packaging/aur/globalprotect-openconnect-git/.SRCINFO @@ -9,23 +9,29 @@ pkgbase = globalprotect-openconnect-git license = GPL3 makedepends = git makedepends = pkg-config - makedepends = openconnect>=8.20 - makedepends = webkit2gtk-4.1 + makedepends = make + makedepends = autoconf + makedepends = automake + makedepends = gettext + makedepends = libtool + makedepends = patch makedepends = curl makedepends = wget makedepends = file - makedepends = openssl makedepends = appmenu-gtk-module - makedepends = libappindicator-gtk3 makedepends = librsvg - makedepends = libsecret makedepends = cargo - depends = vpnc depends = openssl depends = webkit2gtk-4.1 depends = libappindicator-gtk3 depends = libsecret depends = libxml2 + depends = zlib + depends = lz4 + depends = gnutls + depends = libp11-kit + depends = nettle + depends = gmp depends = shared-mime-info depends = desktop-file-utils depends = xdg-utils diff --git a/packaging/aur/globalprotect-openconnect-git/PKGBUILD b/packaging/aur/globalprotect-openconnect-git/PKGBUILD index 9c06fac..41a1e7f 100644 --- a/packaging/aur/globalprotect-openconnect-git/PKGBUILD +++ b/packaging/aur/globalprotect-openconnect-git/PKGBUILD @@ -9,8 +9,8 @@ arch=(x86_64 aarch64) url="https://github.com/yuezk/GlobalProtect-openconnect" license=('GPL3') -makedepends=(git pkg-config 'openconnect>=8.20' webkit2gtk-4.1 curl wget file openssl appmenu-gtk-module libappindicator-gtk3 librsvg libsecret cargo) -depends=(vpnc openssl webkit2gtk-4.1 libappindicator-gtk3 libsecret libxml2 shared-mime-info desktop-file-utils xdg-utils) +makedepends=(git pkg-config make autoconf automake gettext libtool patch curl wget file appmenu-gtk-module librsvg cargo) +depends=(openssl webkit2gtk-4.1 libappindicator-gtk3 libsecret libxml2 zlib lz4 gnutls libp11-kit nettle gmp shared-mime-info desktop-file-utils xdg-utils) optdepends=('wmctrl: for window management') conflicts=('globalprotect-openconnect') diff --git a/packaging/docker/README.md b/packaging/docker/README.md index 57cacd0..ffd1d37 100644 --- a/packaging/docker/README.md +++ b/packaging/docker/README.md @@ -25,12 +25,12 @@ docker run --rm -it --cap-add=NET_ADMIN --device=/dev/net/tun \ connect ``` -For browser authentication in a headless environment, use remote browser authentication: +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: \ - connect --browser remote + connect --browser manual ``` On a Linux host, add host networking if the VPN routes should affect the host network namespace: @@ -38,7 +38,7 @@ On a Linux host, add host networking if the VPN routes should affect the host ne ```bash docker run --rm -it --network host --cap-add=NET_ADMIN --device=/dev/net/tun \ yuezk/globalprotect-openconnect: \ - connect --browser remote + connect --browser manual ``` 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.