refactor: replace OpenSSL transports and certificate imports

This commit is contained in:
Kevin Yue committed 2026-11-01 23:35:58 +08:00
1 parent 37c88c7adb
commit 14c4e24e0e
59 files changed
+1072 -1151

No files matched your search

+3 -1
View File
@@ -21,7 +21,6 @@ clap.workspace = true
log.workspace = true
serde_json.workspace = true
tokio = { workspace = true, features = ["rt-multi-thread"] }
tempfile.workspace = true
compile-time.workspace = true
home = "0.5.12"
@@ -33,3 +32,6 @@ tauri = { workspace = true, optional = true }
default = ["webview-auth"]
webview-auth = ["auth/webview-auth", "dep:tauri", "dep:tauri-build"]
release-devtools = ["auth/release-devtools"]
[dev-dependencies]
tempfile.workspace = true
+11 -29
View File
@@ -6,8 +6,6 @@ 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},
@@ -20,8 +18,6 @@ use gpapi::{
use log::info;
use serde_json::json;
use std::net::IpAddr;
#[cfg(not(target_os = "macos"))]
use tempfile::NamedTempFile;
const VERSION: &str = concat!(
env!("CARGO_PKG_VERSION"),
@@ -89,7 +85,7 @@ struct Cli {
key_password: Option<String>,
#[cfg(not(target_os = "macos"))]
#[arg(long, help = "Get around the OpenSSL `unsafe legacy renegotiation` error")]
#[arg(long, hide = true)]
fix_openssl: bool,
#[arg(long, help = "Ignore TLS errors")]
@@ -149,11 +145,6 @@ enum CliCommand {
}
impl Args for Cli {
#[cfg(not(target_os = "macos"))]
fn fix_openssl(&self) -> bool {
self.fix_openssl
}
fn ignore_tls_errors(&self) -> bool {
self.ignore_tls_errors
}
@@ -164,19 +155,12 @@ impl Args for Cli {
}
impl Cli {
#[cfg(not(target_os = "macos"))]
fn prepare_openssl(&self) -> anyhow::Result<Option<NamedTempFile>> {
async fn run(&self) -> anyhow::Result<()> {
#[cfg(not(target_os = "macos"))]
if self.fix_openssl {
info!("Fixing OpenSSL environment");
let file = openssl::fix_openssl_env()?;
return Ok(Some(file));
log::warn!("--fix-openssl is deprecated and has no effect. It will be removed in a future release.");
}
Ok(None)
}
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("manual") || browser.eq_ignore_ascii_case("remote"))
{
@@ -189,8 +173,6 @@ impl Cli {
#[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();
@@ -230,8 +212,6 @@ impl Cli {
print_auth_result(auth_result, Some(&auth_host_id));
#[cfg(not(target_os = "macos"))]
drop(openssl_conf);
return Ok(());
}
@@ -243,8 +223,6 @@ impl Cli {
self.clean,
self.window_title.clone(),
self.window_theme,
#[cfg(not(target_os = "macos"))]
openssl_conf,
)
.await?;
@@ -338,9 +316,13 @@ mod tests {
use super::*;
#[test]
fn openssl_option_is_available_only_on_supported_platforms() {
fn deprecated_openssl_option_remains_supported_but_hidden() {
let result = Cli::try_parse_from(["gpauth", "portal.example.com", "--fix-openssl"]);
assert_eq!(result.is_ok(), !cfg!(target_os = "macos"));
for flag in ["-h", "--help"] {
let help = Cli::try_parse_from(["gpauth", flag]).err().unwrap().to_string();
assert!(!help.contains("--fix-openssl"));
}
}
#[test]
@@ -348,12 +330,12 @@ mod tests {
use gpapi::error::ServerTlsErrorKind;
let tls = ServerTlsError {
server: "https://vpn.example.com".into(),
kind: ServerTlsErrorKind::LegacyRenegotiation,
kind: ServerTlsErrorKind::Certificate,
};
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"}})
json!({"serverTlsError": {"server": "https://vpn.example.com", "kind": "certificate"}})
);
assert_eq!(
serde_json::to_value(auth_outcome(Err(anyhow::anyhow!("rejected")), None)).unwrap(),
+1 -17
View File
@@ -1,11 +1,5 @@
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;
@@ -16,7 +10,6 @@ pub async fn authenticate(
clean: bool,
window_title: Option<String>,
window_theme: AuthWindowTheme,
#[cfg(not(target_os = "macos"))] mut openssl_conf: Option<NamedTempFile>,
) -> anyhow::Result<()> {
let auth_host_id = gp_params.os_profile().host_identity().host_id().to_string();
@@ -46,16 +39,7 @@ pub async fn authenticate(
Ok(())
})
.build(crate::tauri_context::get())?
.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);
}
}
}
});
.run(|_, _| {});
Ok(())
}
+40
View File
@@ -0,0 +1,40 @@
#![cfg(not(target_os = "macos"))]
use std::process::Command;
#[test]
fn deprecated_flag_warns_without_changing_auth_output_or_configuration() {
const WARNING: &str = "--fix-openssl is deprecated and has no effect. It will be removed in a future release.";
let directory = tempfile::tempdir().unwrap();
let configuration = directory.path().join("openssl.cnf");
std::fs::write(&configuration, "existing user configuration").unwrap();
for deprecated in [false, true] {
let mut command = Command::new(env!("CARGO_BIN_EXE_gpauth"));
command.arg("portal.example.com");
if deprecated {
command.arg("--fix-openssl");
}
// Reject invalid options before authentication, without making a network request.
let output = command
.args(["--browser-listen", "127.0.0.1", "--log-format", "json"])
.env("OPENSSL_CONF", &configuration)
.output()
.unwrap();
assert!(!output.status.success());
assert!(output.stdout.is_empty());
let logs = String::from_utf8(output.stderr).unwrap();
let records = logs
.lines()
.map(|line| serde_json::from_str::<serde_json::Value>(line).unwrap())
.collect::<Vec<_>>();
assert_eq!(
records.iter().filter(|record| record["message"] == WARNING).count(),
usize::from(deprecated)
);
assert!(logs.contains("requires '--browser manual'"));
assert_eq!(
std::fs::read_to_string(&configuration).unwrap(),
"existing user configuration"
);
}
}
+3 -1
View File
@@ -28,7 +28,6 @@ sysinfo.workspace = true
serde.workspace = true
serde_json.workspace = true
whoami.workspace = true
tempfile.workspace = true
reqwest.workspace = true
directories.workspace = true
compile-time.workspace = true
@@ -40,3 +39,6 @@ webview-auth = ["gpapi/webview-auth"]
[target.'cfg(target_os = "macos")'.dependencies]
gpvpnc = { path = "../../crates/gpvpnc" }
[dev-dependencies]
tempfile.workspace = true
+12 -31
View File
@@ -5,16 +5,12 @@ 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},
};
use log::info;
use sysinfo::{Pid, System};
#[cfg(not(target_os = "macos"))]
use tempfile::NamedTempFile;
use tokio::fs;
use crate::{
@@ -36,8 +32,6 @@ 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,
pub(crate) verbose: &'a InfoLevelVerbosity,
@@ -96,10 +90,7 @@ struct Cli {
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."
)]
#[arg(long, hide = true)]
fix_openssl: bool,
#[arg(long, help = "Ignore the TLS errors")]
ignore_tls_errors: bool,
@@ -127,11 +118,6 @@ struct Cli {
}
impl Args for Cli {
#[cfg(not(target_os = "macos"))]
fn fix_openssl(&self) -> bool {
self.fix_openssl
}
fn ignore_tls_errors(&self) -> bool {
self.ignore_tls_errors
}
@@ -169,17 +155,14 @@ impl Cli {
.unwrap_or(false)
}
#[cfg(not(target_os = "macos"))]
fn fix_openssl(&self) -> anyhow::Result<Option<NamedTempFile>> {
if self.fix_openssl {
let file = openssl::fix_openssl_env()?;
return Ok(Some(file));
async fn run(&self) -> anyhow::Result<()> {
#[cfg(not(target_os = "macos"))]
if self.fix_openssl
&& !(matches!(&self.command, CliCommand::Connect(args) if args.background) && self.background_worker_fd.is_none())
{
log::warn!("--fix-openssl is deprecated and has no effect. It will be removed in a future release.");
}
Ok(None)
}
async fn run(&self) -> anyhow::Result<()> {
if let CliCommand::Connect(args) = &self.command {
if args.dashboard {
crate::dashboard::validate(self.log_format)?;
@@ -214,13 +197,7 @@ impl Cli {
None
};
// 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,
verbose: &self.verbose,
@@ -370,9 +347,13 @@ mod tests {
}
#[test]
fn openssl_option_is_available_only_on_supported_platforms() {
fn deprecated_openssl_option_remains_supported_but_hidden() {
let result = Cli::try_parse_from(["gpclient", "--fix-openssl", "diagnostics"]);
assert_eq!(result.is_ok(), !cfg!(target_os = "macos"));
for flag in ["-h", "--help"] {
let help = Cli::try_parse_from(["gpclient", flag]).err().unwrap().to_string();
assert!(!help.contains("--fix-openssl"));
}
}
#[test]
-3
View File
@@ -138,9 +138,6 @@ 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")]
-14
View File
@@ -98,8 +98,6 @@ 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,
verbose: &verbose,
@@ -144,8 +142,6 @@ 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,
verbose: &verbose,
@@ -192,8 +188,6 @@ 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,
verbose: &verbose,
@@ -227,8 +221,6 @@ 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,
verbose: &verbose,
@@ -295,8 +287,6 @@ 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,
verbose: &verbose,
@@ -355,8 +345,6 @@ 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,
verbose: &verbose,
@@ -503,8 +491,6 @@ 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,
verbose: &verbose,
+1 -1
View File
@@ -185,11 +185,11 @@ impl<'a> ConnectHandler<'a> {
match identity_error {
RequestIdentityError::UnsupportedEncryption
| RequestIdentityError::LegacyKeyConversion(_)
| RequestIdentityError::UnsupportedKeyFormat
| RequestIdentityError::InvalidKey
| RequestIdentityError::InvalidCertificate
| RequestIdentityError::IncompletePkcs12
| RequestIdentityError::AmbiguousPkcs12
| RequestIdentityError::InvalidPkcs12(_) => return Err(err),
RequestIdentityError::NoKey => {
let format = self.shared_args.log_format;
+38
View File
@@ -0,0 +1,38 @@
#![cfg(not(target_os = "macos"))]
use std::process::Command;
#[test]
fn background_worker_warns_once_for_the_deprecated_flag() {
const WARNING: &str = "--fix-openssl is deprecated and has no effect. It will be removed in a future release.";
let directory = tempfile::tempdir().unwrap();
for deprecated in [false, true] {
let log = directory.path().join(format!("background-{deprecated}.log"));
let mut command = Command::new(env!("CARGO_BIN_EXE_gpclient"));
if deprecated {
command.arg("--fix-openssl");
}
let output = command
.arg("--lock-file")
.arg(directory.path().join("client.pid"))
.args([
"--log-format",
"json",
"connect",
"vpn.example.test",
"--background",
"--certificate",
])
// Fail identity preparation before authentication or a network connection.
.arg(directory.path().join("missing.pem"))
.arg("--log-file")
.arg(&log)
.output()
.unwrap();
assert!(!output.status.success());
let mut records = String::from_utf8(output.stderr).unwrap();
records.push_str(&std::fs::read_to_string(log).unwrap());
assert!(records.contains("Failed to read client identity"), "{records}");
assert_eq!(records.matches(WARNING).count(), usize::from(deprecated), "{records}");
}
}
+7 -1
View File
@@ -73,5 +73,11 @@ async fn embedded_collector_reports_missing_helpers_without_recursing_or_exposin
report["fields"]["env.XDG_CURRENT_DESKTOP"]["value"],
"TestDesktop Injected: secret"
);
assert!(!String::from_utf8_lossy(&output.stderr).contains("Using 'UnsafeLegacyServerConnect'"));
#[cfg(not(target_os = "macos"))]
assert_eq!(
String::from_utf8_lossy(&output.stderr)
.matches("--fix-openssl is deprecated and has no effect. It will be removed in a future release.")
.count(),
1
);
}
+12 -2
View File
@@ -33,7 +33,12 @@ impl<'a> FileDownloader<'a> {
}
pub async fn download(&self) -> anyhow::Result<NamedTempFile> {
let res = reqwest::get(self.url).await?.error_for_status()?;
let res = gpapi::utils::request::client_builder()
.build()?
.get(self.url)
.send()
.await?
.error_for_status()?;
let content_length = res.content_length().unwrap_or(0);
info!("Content length: {}", content_length);
@@ -79,7 +84,12 @@ impl<'a> ChecksumFetcher<'a> {
}
pub async fn fetch(&self) -> anyhow::Result<String> {
let res = reqwest::get(self.url).await?.error_for_status()?;
let res = gpapi::utils::request::client_builder()
.build()?
.get(self.url)
.send()
.await?
.error_for_status()?;
let checksum = res.text().await?.trim().to_string();
Ok(checksum)