mirror of
https://github.com/yuezk/GlobalProtect-openconnect.git
synced 2026-11-19 06:26:14 -05:00
refactor: update session extension flow
This commit is contained in:
19 files changed
+927
-419
No files matched your search
@@ -9,22 +9,43 @@ use reqwest::Client;
|
||||
use xmltree::Element;
|
||||
|
||||
use crate::{
|
||||
error::PortalError,
|
||||
credential::Credential,
|
||||
gateway::login::{GatewayLogin, gateway_login_with_extend_lifetime},
|
||||
gp_params::GpParams,
|
||||
service::{
|
||||
session::{SessionInfo, SessionRequestArgs, SessionWarning},
|
||||
},
|
||||
session::SessionRequestArgs,
|
||||
utils::{normalize_server, parse_gp_response, xml::ElementExt},
|
||||
};
|
||||
|
||||
const EXTEND_SESSION_MESSAGE: &str = "User Session Extension";
|
||||
const EXTEND_SESSION_COMMENT: &str = "User extends the login lifetime";
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct SessionExtensionAuth {
|
||||
credential: Credential,
|
||||
gp_params: GpParams,
|
||||
}
|
||||
|
||||
impl SessionExtensionAuth {
|
||||
pub fn new(credential: Credential, gp_params: GpParams) -> Self {
|
||||
Self { credential, gp_params }
|
||||
}
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for SessionExtensionAuth {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.debug_struct("SessionExtensionAuth")
|
||||
.field("username", &self.credential.username())
|
||||
.field("gp_params", &"<redacted>")
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct SessionContext {
|
||||
server: String,
|
||||
portal: String,
|
||||
session_args: SessionRequestArgs,
|
||||
extension_auth: Option<SessionExtensionAuth>,
|
||||
}
|
||||
|
||||
impl SessionContext {
|
||||
@@ -33,9 +54,15 @@ impl SessionContext {
|
||||
server,
|
||||
portal,
|
||||
session_args,
|
||||
extension_auth: None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn with_extension_auth(mut self, extension_auth: SessionExtensionAuth) -> Self {
|
||||
self.extension_auth = Some(extension_auth);
|
||||
self
|
||||
}
|
||||
|
||||
pub fn server(&self) -> &str {
|
||||
&self.server
|
||||
}
|
||||
@@ -47,35 +74,15 @@ impl SessionContext {
|
||||
pub fn session_args(&self) -> &SessionRequestArgs {
|
||||
&self.session_args
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn retrieve_session_info_for_gateway(server: &str, args: &SessionRequestArgs) -> anyhow::Result<SessionInfo> {
|
||||
let base_url = normalize_server(server)?;
|
||||
let client = build_session_client(args)?;
|
||||
let form = build_session_form(args)?;
|
||||
let url = format!("{base_url}/ssl-vpn/getconfig.esp");
|
||||
|
||||
info!("Retrieving gateway session info");
|
||||
|
||||
let response = client.post(&url).form(&form).send().await.map_err(|err| {
|
||||
warn!("Network error: {:?}", err);
|
||||
anyhow::anyhow!(PortalError::NetworkError(err))
|
||||
})?;
|
||||
|
||||
let response = parse_gp_response(response).await?;
|
||||
let response = response.trim();
|
||||
if !response.starts_with('<') {
|
||||
return Err(anyhow::anyhow!("Gateway session info error: {response}"));
|
||||
fn extension_auth(&self) -> Option<&SessionExtensionAuth> {
|
||||
self.extension_auth.as_ref()
|
||||
}
|
||||
|
||||
let root = Element::parse(response.as_bytes())?;
|
||||
let session_info = parse_session_info(&root)?;
|
||||
info!("Parsed session info: {:?}", session_info);
|
||||
|
||||
Ok(session_info)
|
||||
}
|
||||
|
||||
pub async fn extend_session(ctx: &SessionContext) -> anyhow::Result<SessionInfo> {
|
||||
pub async fn extend_session(ctx: &SessionContext) -> anyhow::Result<()> {
|
||||
extend_session_lifetime(ctx).await?;
|
||||
|
||||
let base_url = normalize_server(ctx.server())?;
|
||||
let client = build_session_client(ctx.session_args())?;
|
||||
let form = build_extend_session_form(ctx)?;
|
||||
@@ -91,15 +98,27 @@ pub async fn extend_session(ctx: &SessionContext) -> anyhow::Result<SessionInfo>
|
||||
info!("Extend-session gateway response status: {}", status);
|
||||
|
||||
match status.as_str() {
|
||||
"success" => {
|
||||
let session_info = retrieve_session_info_for_gateway(ctx.server(), ctx.session_args()).await?;
|
||||
info!("Extend-session refreshed session info: {:?}", session_info);
|
||||
Ok(session_info)
|
||||
}
|
||||
"success" => Ok(()),
|
||||
status => bail!("Extend session rejected: {status}"),
|
||||
}
|
||||
}
|
||||
|
||||
async fn extend_session_lifetime(ctx: &SessionContext) -> anyhow::Result<()> {
|
||||
let auth = ctx
|
||||
.extension_auth()
|
||||
.ok_or_else(|| anyhow::anyhow!("Session extension requires retained gateway auth state"))?;
|
||||
|
||||
let login = gateway_login_with_extend_lifetime(ctx.server(), &auth.credential, &auth.gp_params).await?;
|
||||
validate_extension_login(login)
|
||||
}
|
||||
|
||||
fn validate_extension_login(login: GatewayLogin) -> anyhow::Result<()> {
|
||||
match login {
|
||||
GatewayLogin::Cookie(_) => Ok(()),
|
||||
GatewayLogin::Mfa(_, _) => bail!("Session extension requires an interactive gateway challenge"),
|
||||
}
|
||||
}
|
||||
|
||||
fn build_session_client(args: &SessionRequestArgs) -> anyhow::Result<Client> {
|
||||
let mut builder = GpParams::builder();
|
||||
builder.user_agent(args.user_agent().as_deref().unwrap_or_default());
|
||||
@@ -113,109 +132,6 @@ fn build_session_client(args: &SessionRequestArgs) -> anyhow::Result<Client> {
|
||||
Client::try_from(&builder.build())
|
||||
}
|
||||
|
||||
fn build_session_form(args: &SessionRequestArgs) -> anyhow::Result<HashMap<String, String>> {
|
||||
let mut form = HashMap::from([
|
||||
("client-type".to_string(), "1".to_string()),
|
||||
("protocol-version".to_string(), "p1".to_string()),
|
||||
("internal".to_string(), "no".to_string()),
|
||||
(
|
||||
"app-version".to_string(),
|
||||
args.client_version().unwrap_or_else(|| "6.3.0-33".to_string()),
|
||||
),
|
||||
(
|
||||
"ipv6-support".to_string(),
|
||||
if args.disable_ipv6() { "no" } else { "yes" }.to_string(),
|
||||
),
|
||||
(
|
||||
"clientos".to_string(),
|
||||
args.os().unwrap_or_default().as_str().to_string(),
|
||||
),
|
||||
("hmac-algo".to_string(), "sha1,md5,sha256".to_string()),
|
||||
("enc-algo".to_string(), "aes-128-cbc,aes-256-cbc".to_string()),
|
||||
]);
|
||||
|
||||
if let Some(os_version) = args.os_version() {
|
||||
form.insert("os-version".to_string(), os_version);
|
||||
}
|
||||
|
||||
form.extend(serde_urlencoded::from_str::<HashMap<String, String>>(args.cookie())?);
|
||||
|
||||
Ok(form)
|
||||
}
|
||||
|
||||
fn parse_session_info(root: &Element) -> anyhow::Result<SessionInfo> {
|
||||
let user_expires = parse_optional_u32(root, "user-expires")?.or(parse_optional_u32(root, "user_expires")?);
|
||||
let lifetime_secs = parse_optional_u32(root, "lifetime")?;
|
||||
|
||||
Ok(SessionInfo {
|
||||
lifetime_secs,
|
||||
user_expires,
|
||||
expires_in_human: build_human_readable_expiry(user_expires, lifetime_secs),
|
||||
lifetime_warning: parse_warning(root, "lifetime-notify-prior", "lifetime-notify-message")?,
|
||||
inactivity_warning: parse_warning(root, "inactivity-notify-prior", "inactivity-notify-message")?,
|
||||
admin_logout_message: root.descendant_text("admin-logout-notify-message"),
|
||||
allow_extend_session: parse_bool_flag(root.descendant_text("allow-extend-session").as_deref()),
|
||||
})
|
||||
}
|
||||
|
||||
fn parse_warning(root: &Element, prior_tag: &str, message_tag: &str) -> anyhow::Result<Option<SessionWarning>> {
|
||||
let prior_secs = parse_optional_u32(root, prior_tag)?;
|
||||
let message = root.descendant_text(message_tag).filter(|value| !value.is_empty());
|
||||
|
||||
Ok(match (prior_secs, message) {
|
||||
(Some(prior_secs), Some(message)) => Some(SessionWarning { prior_secs, message }),
|
||||
_ => None,
|
||||
})
|
||||
}
|
||||
|
||||
fn parse_optional_u32(root: &Element, tag: &str) -> anyhow::Result<Option<u32>> {
|
||||
let Some(value) = root.descendant_text(tag) else {
|
||||
return Ok(None);
|
||||
};
|
||||
let value = value.trim();
|
||||
if value.is_empty() {
|
||||
return Ok(None);
|
||||
}
|
||||
|
||||
Ok(Some(value.parse()?))
|
||||
}
|
||||
|
||||
fn parse_bool_flag(value: Option<&str>) -> bool {
|
||||
matches!(value, Some("yes" | "true" | "1"))
|
||||
}
|
||||
|
||||
fn build_human_readable_expiry(user_expires: Option<u32>, lifetime_secs: Option<u32>) -> Option<String> {
|
||||
if let Some(user_expires) = user_expires {
|
||||
let now = SystemTime::now().duration_since(UNIX_EPOCH).ok()?.as_secs();
|
||||
return Some(format_human_duration((user_expires as u64).saturating_sub(now)));
|
||||
}
|
||||
|
||||
lifetime_secs.map(|secs| format_human_duration(secs as u64))
|
||||
}
|
||||
|
||||
fn format_human_duration(total_secs: u64) -> String {
|
||||
let days = total_secs / 86_400;
|
||||
let hours = (total_secs % 86_400) / 3_600;
|
||||
let minutes = (total_secs % 3_600) / 60;
|
||||
let seconds = total_secs % 60;
|
||||
|
||||
let mut parts = Vec::new();
|
||||
if days > 0 {
|
||||
parts.push(format!("{days}days"));
|
||||
}
|
||||
if hours > 0 {
|
||||
parts.push(format!("{hours}h"));
|
||||
}
|
||||
if minutes > 0 {
|
||||
parts.push(format!("{minutes}m"));
|
||||
}
|
||||
if seconds > 0 || parts.is_empty() {
|
||||
parts.push(format!("{seconds}s"));
|
||||
}
|
||||
|
||||
parts.join(" ")
|
||||
}
|
||||
|
||||
fn parse_cookie_form(args: &SessionRequestArgs) -> anyhow::Result<HashMap<String, String>> {
|
||||
Ok(serde_urlencoded::from_str(args.cookie())?)
|
||||
}
|
||||
@@ -249,10 +165,7 @@ fn unix_timestamp() -> u64 {
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use crate::{
|
||||
gp_params::ClientOs,
|
||||
service::session::SessionRequestArgs,
|
||||
};
|
||||
use crate::{gp_params::ClientOs, session::SessionRequestArgs};
|
||||
|
||||
use super::*;
|
||||
|
||||
@@ -265,87 +178,7 @@ mod tests {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn builds_gateway_session_form() {
|
||||
let form = build_session_form(&build_session_args()).unwrap();
|
||||
|
||||
assert_eq!(form.get("client-type").map(String::as_str), Some("1"));
|
||||
assert_eq!(form.get("protocol-version").map(String::as_str), Some("p1"));
|
||||
assert_eq!(form.get("internal").map(String::as_str), Some("no"));
|
||||
assert_eq!(form.get("app-version").map(String::as_str), Some("6.3.1-12"));
|
||||
assert_eq!(form.get("ipv6-support").map(String::as_str), Some("no"));
|
||||
assert_eq!(form.get("clientos").map(String::as_str), Some("Mac"));
|
||||
assert_eq!(form.get("os-version").map(String::as_str), Some("macOS 15.0"));
|
||||
assert_eq!(form.get("authcookie").map(String::as_str), Some("AUTH"));
|
||||
assert_eq!(form.get("portal").map(String::as_str), Some("vpn.example.com"));
|
||||
assert_eq!(form.get("user").map(String::as_str), Some("alice"));
|
||||
assert_eq!(form.get("preferred-ip").map(String::as_str), Some("10.0.0.10"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn builds_gateway_session_form_with_ipv6_enabled() {
|
||||
let args = SessionRequestArgs::new("authcookie=AUTH".to_string()).with_client_version(Some("6.3.1-12".to_string()));
|
||||
|
||||
let form = build_session_form(&args).unwrap();
|
||||
|
||||
assert_eq!(form.get("ipv6-support").map(String::as_str), Some("yes"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parses_session_info() {
|
||||
let xml = r#"
|
||||
<response>
|
||||
<lifetime>43200</lifetime>
|
||||
<user-expires>1776828409</user-expires>
|
||||
<lifetime-notify-prior>1800</lifetime-notify-prior>
|
||||
<lifetime-notify-message>The VPN will disconnect after 12 hours.</lifetime-notify-message>
|
||||
<inactivity-notify-prior>300</inactivity-notify-prior>
|
||||
<inactivity-notify-message>The VPN will disconnect after 5 minutes of inactivity.</inactivity-notify-message>
|
||||
<admin-logout-notify-message>Logged out by administrator.</admin-logout-notify-message>
|
||||
<allow-extend-session>yes</allow-extend-session>
|
||||
</response>
|
||||
"#;
|
||||
let root = Element::parse(xml.as_bytes()).unwrap();
|
||||
|
||||
let info = parse_session_info(&root).unwrap();
|
||||
|
||||
assert_eq!(info.lifetime_secs, Some(43200));
|
||||
assert_eq!(info.user_expires, Some(1776828409));
|
||||
assert!(info.expires_in_human.as_ref().is_some_and(|value| !value.is_empty()));
|
||||
assert_eq!(info.lifetime_warning.unwrap().prior_secs, 1800);
|
||||
assert_eq!(info.inactivity_warning.unwrap().prior_secs, 300);
|
||||
assert_eq!(
|
||||
info.admin_logout_message.as_deref(),
|
||||
Some("Logged out by administrator.")
|
||||
);
|
||||
assert!(info.allow_extend_session);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parses_allow_extend_session_false() {
|
||||
let xml = r#"<response><allow-extend-session>no</allow-extend-session></response>"#;
|
||||
let root = Element::parse(xml.as_bytes()).unwrap();
|
||||
|
||||
let info = parse_session_info(&root).unwrap();
|
||||
|
||||
assert!(!info.allow_extend_session);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parses_user_expires_underscore_variant() {
|
||||
let xml = r#"
|
||||
<response>
|
||||
<user_expires>1779810767</user_expires>
|
||||
</response>
|
||||
"#;
|
||||
let root = Element::parse(xml.as_bytes()).unwrap();
|
||||
|
||||
let info = parse_session_info(&root).unwrap();
|
||||
|
||||
assert_eq!(info.user_expires, Some(1779810767));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn active_session_context_preserves_connect_args_for_refresh() {
|
||||
fn active_session_context_preserves_connect_args_for_extension() {
|
||||
let session_args = build_session_args();
|
||||
let ctx = SessionContext::new(
|
||||
"vpn.example.com".to_string(),
|
||||
@@ -353,11 +186,12 @@ mod tests {
|
||||
session_args,
|
||||
);
|
||||
|
||||
let form = build_session_form(ctx.session_args()).unwrap();
|
||||
let form = parse_cookie_form(ctx.session_args()).unwrap();
|
||||
|
||||
assert_eq!(form.get("ipv6-support").map(String::as_str), Some("no"));
|
||||
assert_eq!(form.get("clientos").map(String::as_str), Some("Mac"));
|
||||
assert_eq!(form.get("os-version").map(String::as_str), Some("macOS 15.0"));
|
||||
assert_eq!(form.get("authcookie").map(String::as_str), Some("AUTH"));
|
||||
assert_eq!(form.get("portal").map(String::as_str), Some("vpn.example.com"));
|
||||
assert_eq!(form.get("user").map(String::as_str), Some("alice"));
|
||||
assert_eq!(form.get("preferred-ip").map(String::as_str), Some("10.0.0.10"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -399,4 +233,14 @@ mod tests {
|
||||
"Malformed extend session response"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rejects_extension_login_mfa_challenge() {
|
||||
assert_eq!(
|
||||
validate_extension_login(GatewayLogin::Mfa("MFA required".to_string(), "input".to_string()))
|
||||
.unwrap_err()
|
||||
.to_string(),
|
||||
"Session extension requires an interactive gateway challenge"
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user