Support connect gateway (#306)

This commit is contained in:
Kevin Yue 2024-01-28 11:41:48 +08:00 committed by GitHub
parent 6fe6a1387a
commit b2bb35994f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 220 additions and 92 deletions

View File

@ -284,12 +284,10 @@ fn raise_window(window: &Arc<Window>) {
} }
} }
pub(crate) async fn portal_prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<String> { pub async fn portal_prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<String> {
info!("Portal prelogin...");
match prelogin(portal, gp_params).await? { match prelogin(portal, gp_params).await? {
Prelogin::Saml(prelogin) => Ok(prelogin.saml_request().to_string()), Prelogin::Saml(prelogin) => Ok(prelogin.saml_request().to_string()),
Prelogin::Standard(_) => Err(anyhow::anyhow!("Received non-SAML prelogin response")), Prelogin::Standard(_) => bail!("Received non-SAML prelogin response"),
} }
} }

View File

@ -25,6 +25,8 @@ const VERSION: &str = concat!(
struct Cli { struct Cli {
server: String, server: String,
#[arg(long)] #[arg(long)]
gateway: bool,
#[arg(long)]
saml_request: Option<String>, saml_request: Option<String>,
#[arg(long, default_value = GP_USER_AGENT)] #[arg(long, default_value = GP_USER_AGENT)]
user_agent: String, user_agent: String,
@ -102,6 +104,7 @@ impl Cli {
.client_os(ClientOs::from(&self.os)) .client_os(ClientOs::from(&self.os))
.os_version(self.os_version.clone()) .os_version(self.os_version.clone())
.ignore_tls_errors(self.ignore_tls_errors) .ignore_tls_errors(self.ignore_tls_errors)
.is_gateway(self.gateway)
.build(); .build();
gp_params gp_params

View File

@ -116,9 +116,7 @@ pub(crate) async fn run() {
} }
if err.contains("certificate verify failed") && !cli.ignore_tls_errors { if err.contains("certificate verify failed") && !cli.ignore_tls_errors {
eprintln!( eprintln!("\nRe-run it with the `--ignore-tls-errors` option to ignore the certificate error, e.g.:\n");
"\nRe-run it with the `--ignore-tls-errors` option to ignore the certificate error, e.g.:\n"
);
// Print the command // Print the command
let args = std::env::args().collect::<Vec<_>>(); let args = std::env::args().collect::<Vec<_>>();
eprintln!("{} --ignore-tls-errors {}\n", args[0], args[1..].join(" ")); eprintln!("{} --ignore-tls-errors {}\n", args[0], args[1..].join(" "));

View File

@ -6,9 +6,9 @@ use gpapi::{
credential::{Credential, PasswordCredential}, credential::{Credential, PasswordCredential},
gateway::gateway_login, gateway::gateway_login,
gp_params::{ClientOs, GpParams}, gp_params::{ClientOs, GpParams},
portal::{prelogin, retrieve_config, Prelogin}, portal::{prelogin, retrieve_config, PortalError, Prelogin},
process::auth_launcher::SamlAuthLauncher, process::auth_launcher::SamlAuthLauncher,
utils::{self, shutdown_signal}, utils::shutdown_signal,
GP_USER_AGENT, GP_USER_AGENT,
}; };
use inquire::{Password, PasswordDisplayMode, Select, Text}; use inquire::{Password, PasswordDisplayMode, Select, Text};
@ -81,12 +81,28 @@ impl<'a> ConnectHandler<'a> {
} }
pub(crate) async fn handle(&self) -> anyhow::Result<()> { pub(crate) async fn handle(&self) -> anyhow::Result<()> {
let portal = utils::normalize_server(self.args.server.as_str())?; let server = self.args.server.as_str();
let Err(err) = self.connect_portal_with_prelogin(server).await else {
return Ok(());
};
info!("Failed to connect portal with prelogin: {}", err);
if err.root_cause().downcast_ref::<PortalError>().is_some() {
info!("Trying the gateway authentication workflow...");
return self.connect_gateway_with_prelogin(server).await;
}
Err(err)
}
async fn connect_portal_with_prelogin(&self, portal: &str) -> anyhow::Result<()> {
let gp_params = self.build_gp_params(); let gp_params = self.build_gp_params();
let prelogin = prelogin(&portal, &gp_params).await?; let prelogin = prelogin(portal, &gp_params).await?;
let portal_credential = self.obtain_credential(&prelogin).await?;
let mut portal_config = retrieve_config(&portal, &portal_credential, &gp_params).await?; let cred = self.obtain_credential(&prelogin, portal).await?;
let mut portal_config = retrieve_config(portal, &cred, &gp_params).await?;
let selected_gateway = match &self.args.gateway { let selected_gateway = match &self.args.gateway {
Some(gateway) => portal_config Some(gateway) => portal_config
@ -109,15 +125,31 @@ impl<'a> ConnectHandler<'a> {
let gateway = selected_gateway.server(); let gateway = selected_gateway.server();
let cred = portal_config.auth_cookie().into(); let cred = portal_config.auth_cookie().into();
let token = match gateway_login(gateway, &cred, &gp_params).await { let cookie = match gateway_login(gateway, &cred, &gp_params).await {
Ok(token) => token, Ok(cookie) => cookie,
Err(_) => { Err(err) => {
info!("Gateway login failed, retrying with prelogin"); info!("Gateway login failed: {}", err);
self.gateway_login_with_prelogin(gateway).await? return self.connect_gateway_with_prelogin(gateway).await;
} }
}; };
let vpn = Vpn::builder(gateway, &token) self.connect_gateway(gateway, &cookie).await
}
async fn connect_gateway_with_prelogin(&self, gateway: &str) -> anyhow::Result<()> {
let mut gp_params = self.build_gp_params();
gp_params.set_is_gateway(true);
let prelogin = prelogin(gateway, &gp_params).await?;
let cred = self.obtain_credential(&prelogin, &gateway).await?;
let cookie = gateway_login(gateway, &cred, &gp_params).await?;
self.connect_gateway(gateway, &cookie).await
}
async fn connect_gateway(&self, gateway: &str, cookie: &str) -> anyhow::Result<()> {
let vpn = Vpn::builder(gateway, cookie)
.user_agent(self.args.user_agent.clone()) .user_agent(self.args.user_agent.clone())
.script(self.args.script.clone()) .script(self.args.script.clone())
.build(); .build();
@ -142,20 +174,17 @@ impl<'a> ConnectHandler<'a> {
Ok(()) Ok(())
} }
async fn gateway_login_with_prelogin(&self, gateway: &str) -> anyhow::Result<String> { async fn obtain_credential(
let mut gp_params = self.build_gp_params(); &self,
gp_params.set_is_gateway(true); prelogin: &Prelogin,
server: &str,
) -> anyhow::Result<Credential> {
let is_gateway = prelogin.is_gateway();
let prelogin = prelogin(gateway, &gp_params).await?;
let cred = self.obtain_credential(&prelogin).await?;
gateway_login(gateway, &cred, &gp_params).await
}
async fn obtain_credential(&self, prelogin: &Prelogin) -> anyhow::Result<Credential> {
match prelogin { match prelogin {
Prelogin::Saml(prelogin) => { Prelogin::Saml(prelogin) => {
SamlAuthLauncher::new(&self.args.server) SamlAuthLauncher::new(&self.args.server)
.gateway(is_gateway)
.saml_request(prelogin.saml_request()) .saml_request(prelogin.saml_request())
.user_agent(&self.args.user_agent) .user_agent(&self.args.user_agent)
.os(self.args.os.as_str()) .os(self.args.os.as_str())
@ -168,7 +197,8 @@ impl<'a> ConnectHandler<'a> {
.await .await
} }
Prelogin::Standard(prelogin) => { Prelogin::Standard(prelogin) => {
println!("{}", prelogin.auth_message()); let prefix = if is_gateway { "Gateway" } else { "Portal" };
println!("{} ({}: {})", prelogin.auth_message(), prefix, server);
let user = self.args.user.as_ref().map_or_else( let user = self.args.user.as_ref().map_or_else(
|| Text::new(&format!("{}:", prelogin.label_username())).prompt(), || Text::new(&format!("{}:", prelogin.label_username())).prompt(),

View File

@ -2,8 +2,8 @@ mod cli;
mod handlers; mod handlers;
mod routes; mod routes;
mod vpn_task; mod vpn_task;
mod ws_server;
mod ws_connection; mod ws_connection;
mod ws_server;
#[tokio::main] #[tokio::main]
async fn main() { async fn main() {

View File

@ -1,6 +1,9 @@
use std::sync::Arc; use std::sync::Arc;
use axum::{routing::{get, post}, Router}; use axum::{
routing::{get, post},
Router,
};
use crate::{handlers, ws_server::WsServerContext}; use crate::{handlers, ws_server::WsServerContext};

View File

@ -139,6 +139,24 @@ impl CachedCredential {
pub fn set_auth_cookie(&mut self, auth_cookie: AuthCookieCredential) { pub fn set_auth_cookie(&mut self, auth_cookie: AuthCookieCredential) {
self.auth_cookie = auth_cookie; self.auth_cookie = auth_cookie;
} }
pub fn set_username(&mut self, username: String) {
self.username = username;
}
pub fn set_password(&mut self, password: Option<String>) {
self.password = password.map(|s| s.to_string());
}
}
impl From<PasswordCredential> for CachedCredential {
fn from(value: PasswordCredential) -> Self {
Self::new(
value.username().to_owned(),
Some(value.password().to_owned()),
AuthCookieCredential::new("", "", ""),
)
}
} }
#[derive(Debug, Serialize, Deserialize, Type, Clone)] #[derive(Debug, Serialize, Deserialize, Type, Clone)]

View File

@ -1,16 +1,24 @@
use anyhow::bail;
use log::info; use log::info;
use reqwest::Client; use reqwest::Client;
use roxmltree::Document; use roxmltree::Document;
use urlencoding::encode; use urlencoding::encode;
use crate::{credential::Credential, gp_params::GpParams}; use crate::{
credential::Credential,
gp_params::GpParams,
utils::{normalize_server, remove_url_scheme},
};
pub async fn gateway_login( pub async fn gateway_login(
gateway: &str, gateway: &str,
cred: &Credential, cred: &Credential,
gp_params: &GpParams, gp_params: &GpParams,
) -> anyhow::Result<String> { ) -> anyhow::Result<String> {
let login_url = format!("https://{}/ssl-vpn/login.esp", gateway); let url = normalize_server(gateway)?;
let gateway = remove_url_scheme(&url);
let login_url = format!("{}/ssl-vpn/login.esp", url);
let client = Client::builder() let client = Client::builder()
.danger_accept_invalid_certs(gp_params.ignore_tls_errors()) .danger_accept_invalid_certs(gp_params.ignore_tls_errors())
.user_agent(gp_params.user_agent()) .user_agent(gp_params.user_agent())
@ -20,13 +28,18 @@ pub async fn gateway_login(
let extra_params = gp_params.to_params(); let extra_params = gp_params.to_params();
params.extend(extra_params); params.extend(extra_params);
params.insert("server", gateway); params.insert("server", &gateway);
info!("Gateway login, user_agent: {}", gp_params.user_agent()); info!("Gateway login, user_agent: {}", gp_params.user_agent());
let res = client.post(&login_url).form(&params).send().await?; let res = client.post(&login_url).form(&params).send().await?;
let res_xml = res.error_for_status()?.text().await?; let status = res.status();
if status.is_client_error() || status.is_server_error() {
bail!("Gateway login error: {}", status)
}
let res_xml = res.text().await?;
let doc = Document::parse(&res_xml)?; let doc = Document::parse(&res_xml)?;
build_gateway_token(&doc, gp_params.computer()) build_gateway_token(&doc, gp_params.computer())

View File

@ -31,6 +31,15 @@ impl Display for Gateway {
} }
impl Gateway { impl Gateway {
pub fn new(name: String, address: String) -> Self {
Self {
name,
address,
priority: 0,
priority_rules: vec![],
}
}
pub fn name(&self) -> &str { pub fn name(&self) -> &str {
&self.name &self.name
} }

View File

@ -1,16 +1,16 @@
use anyhow::ensure; use anyhow::bail;
use log::info; use log::info;
use reqwest::Client; use reqwest::{Client, StatusCode};
use roxmltree::Document; use roxmltree::Document;
use serde::Serialize; use serde::Serialize;
use specta::Type; use specta::Type;
use thiserror::Error;
use crate::{ use crate::{
credential::{AuthCookieCredential, Credential}, credential::{AuthCookieCredential, Credential},
gateway::{parse_gateways, Gateway}, gateway::{parse_gateways, Gateway},
gp_params::GpParams, gp_params::GpParams,
utils::{normalize_server, xml}, portal::PortalError,
utils::{normalize_server, remove_url_scheme, xml},
}; };
#[derive(Debug, Serialize, Type)] #[derive(Debug, Serialize, Type)]
@ -18,25 +18,12 @@ use crate::{
pub struct PortalConfig { pub struct PortalConfig {
portal: String, portal: String,
auth_cookie: AuthCookieCredential, auth_cookie: AuthCookieCredential,
config_cred: Credential,
gateways: Vec<Gateway>, gateways: Vec<Gateway>,
config_digest: Option<String>, config_digest: Option<String>,
} }
impl PortalConfig { impl PortalConfig {
pub fn new(
portal: String,
auth_cookie: AuthCookieCredential,
gateways: Vec<Gateway>,
config_digest: Option<String>,
) -> Self {
Self {
portal,
auth_cookie,
gateways,
config_digest,
}
}
pub fn portal(&self) -> &str { pub fn portal(&self) -> &str {
&self.portal &self.portal
} }
@ -49,6 +36,10 @@ impl PortalConfig {
&self.auth_cookie &self.auth_cookie
} }
pub fn config_cred(&self) -> &Credential {
&self.config_cred
}
/// In-place sort the gateways by region /// In-place sort the gateways by region
pub fn sort_gateways(&mut self, region: &str) { pub fn sort_gateways(&mut self, region: &str) {
let preferred_gateway = self.find_preferred_gateway(region); let preferred_gateway = self.find_preferred_gateway(region);
@ -98,12 +89,6 @@ impl PortalConfig {
} }
} }
#[derive(Error, Debug)]
pub enum PortalConfigError {
#[error("Empty response, retrying can help")]
EmptyResponse,
}
pub async fn retrieve_config( pub async fn retrieve_config(
portal: &str, portal: &str,
cred: &Credential, cred: &Credential,
@ -128,13 +113,35 @@ pub async fn retrieve_config(
info!("Portal config, user_agent: {}", gp_params.user_agent()); info!("Portal config, user_agent: {}", gp_params.user_agent());
let res = client.post(&url).form(&params).send().await?; let res = client.post(&url).form(&params).send().await?;
let res_xml = res.error_for_status()?.text().await?; let status = res.status();
ensure!(!res_xml.is_empty(), PortalConfigError::EmptyResponse); if status == StatusCode::NOT_FOUND {
bail!(PortalError::ConfigError(
"Config endpoint not found".to_string()
))
}
let doc = Document::parse(&res_xml)?; if status.is_client_error() || status.is_server_error() {
let mut gateways = bail!("Portal config error: {}", status)
parse_gateways(&doc).ok_or_else(|| anyhow::anyhow!("Failed to parse gateways"))?; }
let res_xml = res
.text()
.await
.map_err(|e| PortalError::ConfigError(e.to_string()))?;
if res_xml.is_empty() {
bail!(PortalError::ConfigError(
"Empty portal config response".to_string()
))
}
let doc = Document::parse(&res_xml).map_err(|e| PortalError::ConfigError(e.to_string()))?;
let mut gateways = parse_gateways(&doc).unwrap_or_else(|| {
info!("No gateways found in portal config");
vec![]
});
let user_auth_cookie = xml::get_child_text(&doc, "portal-userauthcookie").unwrap_or_default(); let user_auth_cookie = xml::get_child_text(&doc, "portal-userauthcookie").unwrap_or_default();
let prelogon_user_auth_cookie = let prelogon_user_auth_cookie =
@ -142,26 +149,18 @@ pub async fn retrieve_config(
let config_digest = xml::get_child_text(&doc, "config-digest"); let config_digest = xml::get_child_text(&doc, "config-digest");
if gateways.is_empty() { if gateways.is_empty() {
gateways.push(Gateway { gateways.push(Gateway::new(server.to_string(), server.to_string()));
name: server.to_string(),
address: server.to_string(),
priority: 0,
priority_rules: vec![],
});
} }
Ok(PortalConfig::new( Ok(PortalConfig {
server.to_string(), portal: server.to_string(),
AuthCookieCredential::new( auth_cookie: AuthCookieCredential::new(
cred.username(), cred.username(),
&user_auth_cookie, &user_auth_cookie,
&prelogon_user_auth_cookie, &prelogon_user_auth_cookie,
), ),
config_cred: cred.clone(),
gateways, gateways,
config_digest, config_digest,
)) })
}
fn remove_url_scheme(s: &str) -> String {
s.replace("http://", "").replace("https://", "")
} }

View File

@ -3,3 +3,13 @@ mod prelogin;
pub use config::*; pub use config::*;
pub use prelogin::*; pub use prelogin::*;
use thiserror::Error;
#[derive(Error, Debug)]
pub enum PortalError {
#[error("Portal prelogin error: {0}")]
PreloginError(String),
#[error("Portal config error: {0}")]
ConfigError(String),
}

View File

@ -1,12 +1,13 @@
use anyhow::bail; use anyhow::bail;
use log::{info, trace}; use log::info;
use reqwest::Client; use reqwest::{Client, StatusCode};
use roxmltree::Document; use roxmltree::Document;
use serde::Serialize; use serde::Serialize;
use specta::Type; use specta::Type;
use crate::{ use crate::{
gp_params::GpParams, gp_params::GpParams,
portal::PortalError,
utils::{base64, normalize_server, xml}, utils::{base64, normalize_server, xml},
}; };
@ -25,6 +26,7 @@ const REQUIRED_PARAMS: [&str; 8] = [
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct SamlPrelogin { pub struct SamlPrelogin {
region: String, region: String,
is_gateway: bool,
saml_request: String, saml_request: String,
support_default_browser: bool, support_default_browser: bool,
} }
@ -47,6 +49,7 @@ impl SamlPrelogin {
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct StandardPrelogin { pub struct StandardPrelogin {
region: String, region: String,
is_gateway: bool,
auth_message: String, auth_message: String,
label_username: String, label_username: String,
label_password: String, label_password: String,
@ -84,21 +87,27 @@ impl Prelogin {
Prelogin::Standard(standard) => standard.region(), Prelogin::Standard(standard) => standard.region(),
} }
} }
pub fn is_gateway(&self) -> bool {
match self {
Prelogin::Saml(saml) => saml.is_gateway,
Prelogin::Standard(standard) => standard.is_gateway,
}
}
} }
pub async fn prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<Prelogin> { pub async fn prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<Prelogin> {
let user_agent = gp_params.user_agent(); let user_agent = gp_params.user_agent();
info!("Portal prelogin, user_agent: {}", user_agent); info!("Prelogin with user_agent: {}", user_agent);
let portal = normalize_server(portal)?; let portal = normalize_server(portal)?;
let prelogin_url = format!( let is_gateway = gp_params.is_gateway();
"{portal}/{}/prelogin.esp", let path = if is_gateway {
if gp_params.is_gateway() { "ssl-vpn"
"ssl-vpn" } else {
} else { "global-protect"
"global-protect" };
} let prelogin_url = format!("{portal}/{}/prelogin.esp", path);
);
let mut params = gp_params.to_params(); let mut params = gp_params.to_params();
params.insert("tmp", "tmp"); params.insert("tmp", "tmp");
@ -118,9 +127,30 @@ pub async fn prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<Prel
.build()?; .build()?;
let res = client.post(&prelogin_url).form(&params).send().await?; let res = client.post(&prelogin_url).form(&params).send().await?;
let res_xml = res.error_for_status()?.text().await?; let status = res.status();
trace!("Prelogin response: {}", res_xml); if status == StatusCode::NOT_FOUND {
bail!(PortalError::PreloginError(
"Prelogin endpoint not found".to_string()
))
}
if status.is_client_error() || status.is_server_error() {
bail!("Prelogin error: {}", status)
}
let res_xml = res
.text()
.await
.map_err(|e| PortalError::PreloginError(e.to_string()))?;
let prelogin =
parse_res_xml(res_xml, is_gateway).map_err(|e| PortalError::PreloginError(e.to_string()))?;
Ok(prelogin)
}
fn parse_res_xml(res_xml: String, is_gateway: bool) -> anyhow::Result<Prelogin> {
let doc = Document::parse(&res_xml)?; let doc = Document::parse(&res_xml)?;
let status = xml::get_child_text(&doc, "status") let status = xml::get_child_text(&doc, "status")
@ -146,6 +176,7 @@ pub async fn prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<Prel
let saml_prelogin = SamlPrelogin { let saml_prelogin = SamlPrelogin {
region, region,
is_gateway,
saml_request, saml_request,
support_default_browser, support_default_browser,
}; };
@ -161,6 +192,7 @@ pub async fn prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<Prel
.unwrap_or(String::from("Please enter the login credentials")); .unwrap_or(String::from("Please enter the login credentials"));
let standard_prelogin = StandardPrelogin { let standard_prelogin = StandardPrelogin {
region, region,
is_gateway,
auth_message, auth_message,
label_username: label_username.unwrap(), label_username: label_username.unwrap(),
label_password: label_password.unwrap(), label_password: label_password.unwrap(),

View File

@ -8,6 +8,7 @@ use super::command_traits::CommandExt;
pub struct SamlAuthLauncher<'a> { pub struct SamlAuthLauncher<'a> {
server: &'a str, server: &'a str,
gateway: bool,
saml_request: Option<&'a str>, saml_request: Option<&'a str>,
user_agent: Option<&'a str>, user_agent: Option<&'a str>,
os: Option<&'a str>, os: Option<&'a str>,
@ -22,6 +23,7 @@ impl<'a> SamlAuthLauncher<'a> {
pub fn new(server: &'a str) -> Self { pub fn new(server: &'a str) -> Self {
Self { Self {
server, server,
gateway: false,
saml_request: None, saml_request: None,
user_agent: None, user_agent: None,
os: None, os: None,
@ -33,6 +35,11 @@ impl<'a> SamlAuthLauncher<'a> {
} }
} }
pub fn gateway(mut self, gateway: bool) -> Self {
self.gateway = gateway;
self
}
pub fn saml_request(mut self, saml_request: &'a str) -> Self { pub fn saml_request(mut self, saml_request: &'a str) -> Self {
self.saml_request = Some(saml_request); self.saml_request = Some(saml_request);
self self
@ -78,6 +85,10 @@ impl<'a> SamlAuthLauncher<'a> {
let mut auth_cmd = Command::new(GP_AUTH_BINARY); let mut auth_cmd = Command::new(GP_AUTH_BINARY);
auth_cmd.arg(self.server); auth_cmd.arg(self.server);
if self.gateway {
auth_cmd.arg("--gateway");
}
if let Some(saml_request) = self.saml_request { if let Some(saml_request) = self.saml_request {
auth_cmd.arg("--saml-request").arg(saml_request); auth_cmd.arg("--saml-request").arg(saml_request);
} }

View File

@ -38,3 +38,7 @@ pub fn normalize_server(server: &str) -> anyhow::Result<String> {
Ok(normalized_url) Ok(normalized_url)
} }
pub fn remove_url_scheme(s: &str) -> String {
s.replace("http://", "").replace("https://", "")
}