mirror of
https://github.com/yuezk/GlobalProtect-openconnect.git
synced 2026-11-20 06:56:17 -05:00
fix(gpclient): keep cookie cache when the cached login gets no answer (#712)
* fix(gpclient): keep cookie cache when the cached login gets no answer A connect or timeout error during the cached gateway login or cached portal discovery deleted the --cookie-cache file and fell back to SAML, although the server never rejected the cookie. Keep the cache and return the error for unanswered requests; only clear it when the server responds. * fix(gpclient): preserve cached cookies for all failed requests --------- Co-authored-by: Kevin Yue <[email protected]>
This commit is contained in:
1 parent
1072a35817
commit
754b220a9d
3 files changed
+172
-19
No files matched your search
@@ -36,6 +36,27 @@ fn login_response() -> String {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async fn read_request(stream: &mut tokio::net::TcpStream) -> String {
|
||||||
|
let mut request = Vec::new();
|
||||||
|
loop {
|
||||||
|
let mut buf = [0; 4096];
|
||||||
|
let count = stream.read(&mut buf).await.unwrap();
|
||||||
|
assert_ne!(count, 0, "Request ended before its body");
|
||||||
|
request.extend_from_slice(&buf[..count]);
|
||||||
|
if let Some(end) = request.windows(4).position(|bytes| bytes == b"\r\n\r\n") {
|
||||||
|
let headers = String::from_utf8_lossy(&request[..end]).to_ascii_lowercase();
|
||||||
|
let length = headers
|
||||||
|
.lines()
|
||||||
|
.find_map(|line| line.strip_prefix("content-length:"))
|
||||||
|
.map(|value| value.trim().parse::<usize>().unwrap())
|
||||||
|
.unwrap_or(0);
|
||||||
|
if request.len() >= end + 4 + length {
|
||||||
|
return String::from_utf8(request).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async fn gateway(responses: Vec<(&'static str, String)>) -> (String, tokio::task::JoinHandle<Vec<String>>) {
|
async fn gateway(responses: Vec<(&'static str, String)>) -> (String, tokio::task::JoinHandle<Vec<String>>) {
|
||||||
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||||
let origin = format!("http://{}", listener.local_addr().unwrap());
|
let origin = format!("http://{}", listener.local_addr().unwrap());
|
||||||
@@ -44,25 +65,7 @@ async fn gateway(responses: Vec<(&'static str, String)>) -> (String, tokio::task
|
|||||||
let mut requests = Vec::new();
|
let mut requests = Vec::new();
|
||||||
for (status, body) in responses {
|
for (status, body) in responses {
|
||||||
let (mut stream, _) = listener.accept().await.unwrap();
|
let (mut stream, _) = listener.accept().await.unwrap();
|
||||||
let mut request = Vec::new();
|
requests.push(read_request(&mut stream).await);
|
||||||
loop {
|
|
||||||
let mut buf = [0; 4096];
|
|
||||||
let count = stream.read(&mut buf).await.unwrap();
|
|
||||||
assert_ne!(count, 0, "Request ended before its body");
|
|
||||||
request.extend_from_slice(&buf[..count]);
|
|
||||||
if let Some(end) = request.windows(4).position(|bytes| bytes == b"\r\n\r\n") {
|
|
||||||
let headers = String::from_utf8_lossy(&request[..end]).to_ascii_lowercase();
|
|
||||||
let length = headers
|
|
||||||
.lines()
|
|
||||||
.find_map(|line| line.strip_prefix("content-length:"))
|
|
||||||
.map(|value| value.trim().parse::<usize>().unwrap())
|
|
||||||
.unwrap_or(0);
|
|
||||||
if request.len() >= end + 4 + length {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
requests.push(String::from_utf8(request).unwrap());
|
|
||||||
stream
|
stream
|
||||||
.write_all(
|
.write_all(
|
||||||
format!(
|
format!(
|
||||||
@@ -126,6 +129,138 @@ async fn cached_tunnel_authentication_does_not_require_portal_discovery() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn unreachable_gateway_keeps_cached_cookie() {
|
||||||
|
// Nothing listens here: the cached gateway login gets no answer at all.
|
||||||
|
let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
|
||||||
|
let gateway = format!("http://{}", listener.local_addr().unwrap());
|
||||||
|
drop(listener);
|
||||||
|
let directory = tempfile::tempdir().unwrap();
|
||||||
|
let cache = directory.path().join("cookie.json");
|
||||||
|
let args = TestArgs::parse_from([
|
||||||
|
"test",
|
||||||
|
"http://unavailable-portal.invalid",
|
||||||
|
"--cookie-only",
|
||||||
|
"--cookie-cache",
|
||||||
|
cache.to_str().unwrap(),
|
||||||
|
])
|
||||||
|
.connect;
|
||||||
|
let lock = directory.path().join("client.pid");
|
||||||
|
let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0);
|
||||||
|
let shared = SharedArgs {
|
||||||
|
ignore_tls_errors: true,
|
||||||
|
lock_file: &lock,
|
||||||
|
verbose: &verbose,
|
||||||
|
log_format: LogFormat::Text,
|
||||||
|
};
|
||||||
|
let handler = ConnectHandler::new(&args, &shared);
|
||||||
|
cookie_store::save(
|
||||||
|
&cache,
|
||||||
|
&StoredCookie::new(
|
||||||
|
args.server.clone(),
|
||||||
|
"alice".into(),
|
||||||
|
handler.os_profile.borrow().host_identity().host_id().into(),
|
||||||
|
gateway,
|
||||||
|
AuthCookieCredential::new("alice", "portal-cookie", ""),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
assert!(handler.handle_impl().await.is_err());
|
||||||
|
assert!(
|
||||||
|
cache.exists(),
|
||||||
|
"a login that got no answer must not delete the cookie cache"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn gateway_closing_without_response_keeps_cached_cookie() {
|
||||||
|
closed_connection_keeps_cached_cookie(false).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn portal_closing_without_response_keeps_cached_cookie() {
|
||||||
|
closed_connection_keeps_cached_cookie(true).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn closed_connection_keeps_cached_cookie(portal_discovery: bool) {
|
||||||
|
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||||
|
let origin = format!("http://{}", listener.local_addr().unwrap());
|
||||||
|
let worker = tokio::spawn(async move {
|
||||||
|
tokio::time::timeout(Duration::from_secs(5), async move {
|
||||||
|
if portal_discovery {
|
||||||
|
let (mut stream, _) = listener.accept().await.unwrap();
|
||||||
|
assert!(read_request(&mut stream).await.contains("/global-protect/prelogin.esp"));
|
||||||
|
let body = "<prelogin-response><status>Success</status></prelogin-response>";
|
||||||
|
stream
|
||||||
|
.write_all(
|
||||||
|
format!(
|
||||||
|
"HTTP/1.1 200 OK\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{body}",
|
||||||
|
body.len()
|
||||||
|
)
|
||||||
|
.as_bytes(),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
}
|
||||||
|
let (mut stream, _) = listener.accept().await.unwrap();
|
||||||
|
// Read the complete request, then close without sending HTTP headers.
|
||||||
|
read_request(&mut stream).await
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
.expect("Connection-closing fixture timed out")
|
||||||
|
});
|
||||||
|
let directory = tempfile::tempdir().unwrap();
|
||||||
|
let cache = directory.path().join("cookie.json");
|
||||||
|
let args = TestArgs::parse_from([
|
||||||
|
"test",
|
||||||
|
&origin,
|
||||||
|
"--cookie-only",
|
||||||
|
"--cookie-cache",
|
||||||
|
cache.to_str().unwrap(),
|
||||||
|
])
|
||||||
|
.connect;
|
||||||
|
let lock = directory.path().join("client.pid");
|
||||||
|
let verbose = gpapi::clap::InfoLevelVerbosity::new(0, 0);
|
||||||
|
let shared = SharedArgs {
|
||||||
|
ignore_tls_errors: true,
|
||||||
|
lock_file: &lock,
|
||||||
|
verbose: &verbose,
|
||||||
|
log_format: LogFormat::Text,
|
||||||
|
};
|
||||||
|
let handler = ConnectHandler::new(&args, &shared);
|
||||||
|
cookie_store::save(
|
||||||
|
&cache,
|
||||||
|
&StoredCookie::new(
|
||||||
|
args.server.clone(),
|
||||||
|
"alice".into(),
|
||||||
|
handler.os_profile.borrow().host_identity().host_id().into(),
|
||||||
|
origin.clone(),
|
||||||
|
AuthCookieCredential::new("alice", "portal-cookie", ""),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
let result = if portal_discovery {
|
||||||
|
handler.connect_portal_with_prelogin(&origin).await
|
||||||
|
} else {
|
||||||
|
handler.handle_impl().await
|
||||||
|
};
|
||||||
|
let error = result.unwrap_err();
|
||||||
|
let Some(gpapi::error::PortalError::NetworkError(network)) = error.downcast_ref() else {
|
||||||
|
panic!("Expected a network error, got {error:?}");
|
||||||
|
};
|
||||||
|
assert!(network.is_request());
|
||||||
|
assert!(!network.is_connect());
|
||||||
|
assert!(!network.is_timeout());
|
||||||
|
assert!(cache.exists(), "an unanswered request must not delete the cookie cache");
|
||||||
|
let request = worker.await.unwrap();
|
||||||
|
assert!(request.contains("portal-cookie"));
|
||||||
|
if portal_discovery {
|
||||||
|
assert!(request.starts_with("POST /global-protect/getconfig.esp "));
|
||||||
|
} else {
|
||||||
|
assert!(request.starts_with("POST /ssl-vpn/login.esp "));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn internal_tunnel_keeps_gateway_authentication_after_portal_cookie_rejection() {
|
async fn internal_tunnel_keeps_gateway_authentication_after_portal_cookie_rejection() {
|
||||||
let (origin, worker) = gateway(vec![
|
let (origin, worker) = gateway(vec![
|
||||||
|
|||||||
@@ -101,6 +101,11 @@ impl ConnectHandler<'_> {
|
|||||||
{
|
{
|
||||||
return Some(Err(error));
|
return Some(Err(error));
|
||||||
}
|
}
|
||||||
|
// A failed request does not establish that the cookie was rejected.
|
||||||
|
if is_network_error(&error) {
|
||||||
|
warn!("Cached gateway authentication request failed: {error}");
|
||||||
|
return Some(Err(error));
|
||||||
|
}
|
||||||
cookie_store::clear(&path);
|
cookie_store::clear(&path);
|
||||||
warn!("Cached gateway authentication failed: {error}");
|
warn!("Cached gateway authentication failed: {error}");
|
||||||
return None;
|
return None;
|
||||||
@@ -830,3 +835,11 @@ mod tests {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A failed request says nothing about whether a cached cookie is still valid.
|
||||||
|
pub(super) fn is_network_error(error: &anyhow::Error) -> bool {
|
||||||
|
matches!(
|
||||||
|
error.downcast_ref::<gpapi::error::PortalError>(),
|
||||||
|
Some(gpapi::error::PortalError::NetworkError(_))
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -292,6 +292,11 @@ impl<'a> ConnectHandler<'a> {
|
|||||||
Ok(config) => Some((cred, config)),
|
Ok(config) => Some((cred, config)),
|
||||||
Err(error) => {
|
Err(error) => {
|
||||||
self.check_cancelled()?;
|
self.check_cancelled()?;
|
||||||
|
// A failed request does not establish that the cookie was rejected.
|
||||||
|
if gateway::is_network_error(&error) {
|
||||||
|
warn!("Cached portal authentication request failed: {error}");
|
||||||
|
return Err(error);
|
||||||
|
}
|
||||||
warn!("Cached portal authentication failed: {error}");
|
warn!("Cached portal authentication failed: {error}");
|
||||||
self.clear_cookie_cache();
|
self.clear_cookie_cache();
|
||||||
None
|
None
|
||||||
|
|||||||
Reference in new issue
Block a user