mirror of
https://github.com/yuezk/GlobalProtect-openconnect.git
synced 2026-11-18 22:16:18 -05:00
feat: prepare 3.0.0 release
This commit is contained in:
252 files changed
+26210
-7457
No files matched your search
+274
-16
@@ -1,9 +1,13 @@
|
||||
use std::{env::temp_dir, fs::File, str::FromStr};
|
||||
use std::{
|
||||
path::{Path, PathBuf},
|
||||
str::FromStr,
|
||||
};
|
||||
|
||||
use anyhow::bail;
|
||||
use clap::{Parser, Subcommand};
|
||||
use gpapi::{
|
||||
clap::{Args, InfoLevelVerbosity, handle_error},
|
||||
log_format::{LogFormat, write_json_record},
|
||||
utils::openssl,
|
||||
};
|
||||
use log::info;
|
||||
@@ -31,7 +35,9 @@ const VERSION: &str = concat!(
|
||||
pub(crate) struct SharedArgs<'a> {
|
||||
pub(crate) fix_openssl: bool,
|
||||
pub(crate) ignore_tls_errors: bool,
|
||||
pub(crate) lock_file: &'a Path,
|
||||
pub(crate) verbose: &'a InfoLevelVerbosity,
|
||||
pub(crate) log_format: LogFormat,
|
||||
}
|
||||
|
||||
#[derive(Subcommand)]
|
||||
@@ -44,6 +50,21 @@ enum CliCommand {
|
||||
LaunchGui(LaunchGuiArgs),
|
||||
#[command(about = "Generate HIP report")]
|
||||
Hip(HipArgs),
|
||||
#[command(hide = true)]
|
||||
DetectInternalHost {
|
||||
#[arg(long)]
|
||||
address: std::net::IpAddr,
|
||||
#[arg(long)]
|
||||
hostname: String,
|
||||
},
|
||||
#[command(hide = true)]
|
||||
ResolveGateway {
|
||||
host: String,
|
||||
#[arg(long, default_value_t = 443)]
|
||||
port: u16,
|
||||
#[arg(long)]
|
||||
disable_ipv6: bool,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Parser)]
|
||||
@@ -75,6 +96,21 @@ struct Cli {
|
||||
fix_openssl: bool,
|
||||
#[arg(long, help = "Ignore the TLS errors")]
|
||||
ignore_tls_errors: bool,
|
||||
#[arg(
|
||||
long,
|
||||
global = true,
|
||||
default_value = GP_CLIENT_LOCK_FILE,
|
||||
help = "Path to the gpclient PID lock file"
|
||||
)]
|
||||
lock_file: PathBuf,
|
||||
|
||||
#[arg(
|
||||
long,
|
||||
value_enum,
|
||||
default_value_t = LogFormat::Text,
|
||||
help = "Log output format. JSON is intended for non-interactive consumers; interactive prompts remain text."
|
||||
)]
|
||||
log_format: LogFormat,
|
||||
|
||||
#[command(flatten)]
|
||||
verbose: InfoLevelVerbosity,
|
||||
@@ -88,11 +124,23 @@ impl Args for Cli {
|
||||
fn ignore_tls_errors(&self) -> bool {
|
||||
self.ignore_tls_errors
|
||||
}
|
||||
|
||||
fn log_format(&self) -> LogFormat {
|
||||
self.log_format
|
||||
}
|
||||
}
|
||||
|
||||
impl Cli {
|
||||
fn can_run_alongside_client(&self) -> bool {
|
||||
match &self.command {
|
||||
CliCommand::Connect(_) => false,
|
||||
CliCommand::LaunchGui(args) => args.is_auth_callback(),
|
||||
_ => true,
|
||||
}
|
||||
}
|
||||
|
||||
async fn is_running(&self) -> bool {
|
||||
let Ok(c) = fs::read_to_string(GP_CLIENT_LOCK_FILE).await else {
|
||||
let Ok(c) = fs::read_to_string(&self.lock_file).await else {
|
||||
return false;
|
||||
};
|
||||
|
||||
@@ -121,7 +169,7 @@ impl Cli {
|
||||
|
||||
async fn run(&self) -> anyhow::Result<()> {
|
||||
// check if an instance is running
|
||||
if !matches!(self.command, CliCommand::Disconnect(_)) && self.is_running().await {
|
||||
if !self.can_run_alongside_client() && self.is_running().await {
|
||||
bail!("Another instance of the client is already running");
|
||||
}
|
||||
|
||||
@@ -131,7 +179,9 @@ impl Cli {
|
||||
let shared_args = SharedArgs {
|
||||
fix_openssl: self.fix_openssl,
|
||||
ignore_tls_errors: self.ignore_tls_errors,
|
||||
lock_file: &self.lock_file,
|
||||
verbose: &self.verbose,
|
||||
log_format: self.log_format,
|
||||
};
|
||||
|
||||
if self.ignore_tls_errors {
|
||||
@@ -140,35 +190,44 @@ impl Cli {
|
||||
|
||||
match &self.command {
|
||||
CliCommand::Connect(args) => ConnectHandler::new(args, &shared_args).handle().await,
|
||||
CliCommand::Disconnect(args) => DisconnectHandler::new(args).handle().await,
|
||||
CliCommand::Disconnect(args) => DisconnectHandler::new(args, shared_args.lock_file).handle().await,
|
||||
CliCommand::LaunchGui(args) => LaunchGuiHandler::new(args).handle().await,
|
||||
CliCommand::Hip(args) => HipHandler::new(args).handle().await,
|
||||
CliCommand::DetectInternalHost { address, hostname } => {
|
||||
let internal = gpapi::session::network::native::detect_in_helper(*address, hostname)?;
|
||||
println!("{}", serde_json::to_string(&internal)?);
|
||||
Ok(())
|
||||
}
|
||||
CliCommand::ResolveGateway {
|
||||
host,
|
||||
port,
|
||||
disable_ipv6,
|
||||
} => {
|
||||
let addresses = gpapi::session::network::native::lookup_in_helper(host, *port, *disable_ipv6)?;
|
||||
println!("{}", serde_json::to_string(&addresses)?);
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn init_logger(cli: &Cli) {
|
||||
fn build_logger(cli: &Cli) -> env_logger::Builder {
|
||||
let mut builder = env_logger::builder();
|
||||
builder.filter_level(cli.verbose.log_level_filter());
|
||||
|
||||
// Output the log messages to a file if the command is the auth callback
|
||||
if let CliCommand::LaunchGui(args) = &cli.command {
|
||||
let auth_data = args.auth_data.as_deref().unwrap_or_default();
|
||||
if !auth_data.is_empty()
|
||||
&& let Ok(log_file) = File::create(temp_dir().join("gpcallback.log"))
|
||||
{
|
||||
let target = Box::new(log_file);
|
||||
builder.target(env_logger::Target::Pipe(target));
|
||||
}
|
||||
// Text is env_logger's own format, so leave it untouched rather than
|
||||
// reimplementing it.
|
||||
if cli.log_format == LogFormat::Json {
|
||||
builder.format(write_json_record);
|
||||
}
|
||||
|
||||
builder.init();
|
||||
builder
|
||||
}
|
||||
|
||||
pub(crate) async fn run() {
|
||||
let cli = Cli::parse();
|
||||
|
||||
init_logger(&cli);
|
||||
build_logger(&cli).init();
|
||||
|
||||
info!("gpclient started: {}", VERSION);
|
||||
|
||||
@@ -177,3 +236,202 @@ pub(crate) async fn run() {
|
||||
std::process::exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::{
|
||||
io::Write,
|
||||
sync::{Arc, Mutex},
|
||||
};
|
||||
|
||||
use log::Log;
|
||||
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn resolver_helper_runs_alongside_client_and_is_hidden_from_help() {
|
||||
let cli = Cli::try_parse_from([
|
||||
"gpclient",
|
||||
"resolve-gateway",
|
||||
"localhost",
|
||||
"--port",
|
||||
"444",
|
||||
"--disable-ipv6",
|
||||
])
|
||||
.unwrap();
|
||||
assert!(cli.can_run_alongside_client());
|
||||
use clap::CommandFactory;
|
||||
let help = Cli::command().render_help().to_string();
|
||||
assert!(!help.contains("resolve-gateway"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lock_file_defaults_to_standard_path() {
|
||||
let cli = Cli::try_parse_from(["gpclient", "connect", "portal.example.com"]).expect("cli should parse");
|
||||
|
||||
assert_eq!(cli.lock_file, PathBuf::from(GP_CLIENT_LOCK_FILE));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lock_file_can_be_overridden_after_subcommand() {
|
||||
let cli = Cli::try_parse_from([
|
||||
"gpclient",
|
||||
"connect",
|
||||
"portal.example.com",
|
||||
"--lock-file",
|
||||
"/tmp/gpclient-portal.lock",
|
||||
])
|
||||
.expect("global lock file option should parse after subcommand");
|
||||
|
||||
assert_eq!(cli.lock_file, PathBuf::from("/tmp/gpclient-portal.lock"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hip_can_run_alongside_connected_client() {
|
||||
let cli = Cli::try_parse_from([
|
||||
"gpclient",
|
||||
"hip",
|
||||
"--client-version",
|
||||
"6.2.4-49",
|
||||
"--client-os",
|
||||
"Mac",
|
||||
"--cookie",
|
||||
"user=alice",
|
||||
"--md5",
|
||||
"test",
|
||||
])
|
||||
.expect("HIP arguments should parse");
|
||||
|
||||
assert!(cli.can_run_alongside_client());
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
|
||||
fn launch_gui_accepts_auth_callback() {
|
||||
let cli = Cli::try_parse_from([
|
||||
"gpclient",
|
||||
"launch-gui",
|
||||
"globalprotectcallback:cas-as=1&[email protected]&token=token",
|
||||
])
|
||||
.expect("authentication callback should parse");
|
||||
|
||||
assert!(matches!(
|
||||
&cli.command,
|
||||
CliCommand::LaunchGui(args) if args.is_auth_callback()
|
||||
));
|
||||
assert!(cli.can_run_alongside_client());
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
|
||||
fn launch_gui_rejects_callback_with_minimized() {
|
||||
assert!(Cli::try_parse_from(["gpclient", "launch-gui", "globalprotectcallback:token", "--minimized",]).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "openbsd"))]
|
||||
fn launch_gui_rejects_non_callback_positional() {
|
||||
assert!(Cli::try_parse_from(["gpclient", "launch-gui", "https://example.com/callback"]).is_err());
|
||||
}
|
||||
|
||||
fn parse_cli(args: &[&str]) -> Cli {
|
||||
Cli::try_parse_from(args).expect("arguments should parse")
|
||||
}
|
||||
|
||||
/// Text stays the default: a plain `gpclient connect` must keep the output it
|
||||
/// has always had, or every existing user's terminal changes under them.
|
||||
#[test]
|
||||
fn log_format_defaults_to_text() {
|
||||
assert_eq!(parse_cli(&["gpclient", "disconnect"]).log_format, LogFormat::Text);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn log_format_accepts_json() {
|
||||
assert_eq!(
|
||||
parse_cli(&["gpclient", "--log-format", "json", "disconnect"]).log_format,
|
||||
LogFormat::Json
|
||||
);
|
||||
}
|
||||
|
||||
/// An unknown value is a mistake worth reporting rather than silently
|
||||
/// falling back to text, which would leave a caller parsing prose.
|
||||
#[test]
|
||||
fn log_format_rejects_an_unknown_value() {
|
||||
// `.err()` rather than `unwrap_err()`: the Ok side is `Cli`, which is not
|
||||
// `Debug`, and it is not worth deriving it just to print an error we expect.
|
||||
let err = Cli::try_parse_from(["gpclient", "--log-format", "yaml", "disconnect"])
|
||||
.err()
|
||||
.expect("an unknown log format should be rejected");
|
||||
let msg = err.to_string();
|
||||
assert!(msg.contains("yaml"), "error should name the input: {msg}");
|
||||
assert!(msg.contains("json"), "error should list the valid values: {msg}");
|
||||
}
|
||||
|
||||
/// A `Write` that keeps what was written, so the logger can be driven for
|
||||
/// real instead of asserting on how it was configured.
|
||||
#[derive(Clone, Default)]
|
||||
struct Captured(Arc<Mutex<Vec<u8>>>);
|
||||
|
||||
impl Captured {
|
||||
fn contents(&self) -> String {
|
||||
String::from_utf8(self.0.lock().unwrap().clone()).expect("log output should be UTF-8")
|
||||
}
|
||||
}
|
||||
|
||||
impl Write for Captured {
|
||||
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
|
||||
self.0.lock().unwrap().extend_from_slice(buf);
|
||||
Ok(buf.len())
|
||||
}
|
||||
|
||||
fn flush(&mut self) -> std::io::Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
fn log_one_record(args: &[&str]) -> String {
|
||||
let captured = Captured::default();
|
||||
let logger = build_logger(&parse_cli(args))
|
||||
.target(env_logger::Target::Pipe(Box::new(captured.clone())))
|
||||
.build();
|
||||
|
||||
// Drive the logger directly: `init()` installs a global that a second test
|
||||
// could not replace.
|
||||
logger.log(
|
||||
&log::Record::builder()
|
||||
.level(log::Level::Info)
|
||||
.target("gpclient")
|
||||
.args(format_args!("connected to {}", "vpn.example.com"))
|
||||
.build(),
|
||||
);
|
||||
logger.flush();
|
||||
|
||||
captured.contents()
|
||||
}
|
||||
|
||||
/// 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]
|
||||
fn json_format_emits_one_json_object_per_record() {
|
||||
let out = log_one_record(&["gpclient", "--log-format", "json", "disconnect"]);
|
||||
|
||||
let lines: Vec<_> = out.lines().collect();
|
||||
assert_eq!(lines.len(), 1, "expected exactly one line, got: {out:?}");
|
||||
|
||||
let v: serde_json::Value = serde_json::from_str(lines[0]).unwrap_or_else(|e| panic!("not JSON: {out:?} ({e})"));
|
||||
assert_eq!(v["level"], "INFO");
|
||||
assert_eq!(v["target"], "gpclient");
|
||||
assert_eq!(v["message"], "connected to vpn.example.com");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn text_format_is_left_alone() {
|
||||
let out = log_one_record(&["gpclient", "disconnect"]);
|
||||
|
||||
assert!(out.contains("connected to vpn.example.com"), "message missing: {out:?}");
|
||||
assert!(
|
||||
serde_json::from_str::<serde_json::Value>(out.trim()).is_err(),
|
||||
"text output should not be JSON: {out:?}"
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user