use serde::Deserialize;
use serde_json::{Map, Value};
use super::discovery::OidcConfiguration;
use crate::client::AxiamClient;
use crate::error::{AxiamError, IdTokenFailureReason};
use crate::sensitive::Sensitive;
pub const BACKCHANNEL_LOGOUT_EVENT: &str = "http://schemas.openid.net/event/backchannel-logout";
pub const MAX_LOGOUT_TOKEN_AGE_SECS: i64 = 300;
#[derive(Debug, Deserialize)]
struct LogoutTokenClaims {
iss: String,
aud: String,
iat: i64,
exp: i64,
jti: String,
#[serde(default)]
sid: Option<String>,
#[serde(default)]
sub: Option<String>,
#[serde(default)]
events: Option<Map<String, Value>>,
#[serde(default)]
nonce: Option<String>,
}
pub struct LogoutUrlParams {
pub id_token: Sensitive<String>,
pub post_logout_redirect_uri: Option<String>,
pub state: Option<String>,
}
impl LogoutUrlParams {
pub fn new(id_token: Sensitive<String>) -> Self {
Self {
id_token,
post_logout_redirect_uri: None,
state: None,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct VerifiedLogoutToken {
pub sid: Option<String>,
pub sub: Option<String>,
pub jti: String,
}
impl AxiamClient {
pub fn logout_url(
&self,
configuration: &OidcConfiguration,
params: LogoutUrlParams,
) -> Result<String, AxiamError> {
let endpoint = configuration.end_session_endpoint.as_deref().ok_or_else(|| {
AxiamError::Auth {
message:
"the authorization server's discovery document advertises no end_session_endpoint: this server does not support RP-initiated logout (CONTRACT.md §12.7.2 rule 1)"
.into(),
oauth: None,
reason: None,
set_reason: None,
retry_after: None,
}
})?;
let mut url = url::Url::parse(endpoint).map_err(|e| AxiamError::Network {
message: format!("invalid end_session_endpoint in discovery document: {e}"),
source: None,
})?;
{
let mut q = url.query_pairs_mut();
q.append_pair("id_token_hint", params.id_token.expose().as_str());
if let Some(uri) = params.post_logout_redirect_uri.as_deref() {
q.append_pair("post_logout_redirect_uri", uri);
}
if let Some(state) = params.state.as_deref() {
q.append_pair("state", state);
}
}
Ok(url.to_string())
}
pub async fn verify_logout_token(
&self,
token: &str,
configuration: &OidcConfiguration,
) -> Result<VerifiedLogoutToken, AxiamError> {
let verifier = self.oidc_verifier_for(&configuration.jwks_uri)?;
let claims: LogoutTokenClaims = verifier.verify_id_token_signature(token).await?;
if claims.iss != configuration.issuer {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::InvalidIssuer,
"logout token issuer does not match the discovery document",
));
}
let client_id = self.oidc_client_id_or_err()?;
if claims.aud != client_id {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::InvalidAudience,
"logout token audience does not match this client_id",
));
}
let has_event = claims.events.as_ref().is_some_and(|e| {
e.get(BACKCHANNEL_LOGOUT_EVENT)
.is_some_and(Value::is_object)
});
if !has_event {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::InvalidSignature,
"not a logout token: the events claim does not carry \
http://schemas.openid.net/event/backchannel-logout",
));
}
if claims.nonce.is_some() {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::NonceMismatch,
"logout token carries a nonce, which Back-Channel Logout 1.0 §2.4 forbids: \
this is an ID token being replayed as a logout token",
));
}
if claims.sid.is_none() && claims.sub.is_none() {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::InvalidSignature,
"logout token names neither sid nor sub, so it identifies no session",
));
}
let now = crate::time::SystemTime::now()
.duration_since(crate::time::UNIX_EPOCH)
.map(|d| d.as_secs() as i64)
.unwrap_or(0);
let skew = self.oidc_clock_skew_sec() as i64;
if claims.exp + skew < now {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::TokenExpired,
"logout token has expired",
));
}
if claims.iat - skew > now {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::TokenExpired,
"logout token was issued in the future",
));
}
if now - claims.iat > MAX_LOGOUT_TOKEN_AGE_SECS + skew {
return Err(AxiamError::id_token_invalid(
IdTokenFailureReason::TokenExpired,
"logout token is too old to be a live delivery",
));
}
Ok(VerifiedLogoutToken {
sid: claims.sid,
sub: claims.sub,
jti: claims.jti,
})
}
}