From e1b962f5e269fd62c49eb6ca3ed887bad9811ead Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Fri, 24 Nov 2023 12:17:22 +0000
Subject: [PATCH] Get rid of @Context variables in Endpoint classes
---
src/main/java/org/keycloak/protocol/cas/CASLoginProtocol.java | 83 +++++++++++++++++++++++++++++------------
1 files changed, 59 insertions(+), 24 deletions(-)
diff --git a/src/main/java/org/keycloak/protocol/cas/CASLoginProtocol.java b/src/main/java/org/keycloak/protocol/cas/CASLoginProtocol.java
index 7d82a9a..5c47e9d 100644
--- a/src/main/java/org/keycloak/protocol/cas/CASLoginProtocol.java
+++ b/src/main/java/org/keycloak/protocol/cas/CASLoginProtocol.java
@@ -1,22 +1,28 @@
package org.keycloak.protocol.cas;
+import jakarta.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.core.UriInfo;
import org.apache.http.HttpEntity;
import org.jboss.logging.Logger;
import org.keycloak.common.util.KeycloakUriBuilder;
+import org.keycloak.common.util.Time;
+import org.keycloak.events.Details;
import org.keycloak.events.EventBuilder;
import org.keycloak.events.EventType;
import org.keycloak.forms.login.LoginFormsProvider;
import org.keycloak.models.*;
import org.keycloak.protocol.LoginProtocol;
import org.keycloak.protocol.cas.utils.LogoutHelper;
-import org.keycloak.services.managers.ClientSessionCode;
+import org.keycloak.protocol.oidc.utils.OAuth2Code;
+import org.keycloak.protocol.oidc.utils.OAuth2CodeParser;
+import org.keycloak.services.ErrorPage;
import org.keycloak.services.managers.ResourceAdminManager;
+import org.keycloak.sessions.AuthenticationSessionModel;
-import javax.ws.rs.core.HttpHeaders;
-import javax.ws.rs.core.Response;
-import javax.ws.rs.core.UriInfo;
import java.io.IOException;
import java.net.URI;
+import java.util.UUID;
public class CASLoginProtocol implements LoginProtocol {
private static final Logger logger = Logger.getLogger(CASLoginProtocol.class);
@@ -24,12 +30,14 @@
public static final String LOGIN_PROTOCOL = "cas";
public static final String SERVICE_PARAM = "service";
+ public static final String TARGET_PARAM = "TARGET";
public static final String RENEW_PARAM = "renew";
public static final String GATEWAY_PARAM = "gateway";
public static final String TICKET_PARAM = "ticket";
public static final String FORMAT_PARAM = "format";
public static final String TICKET_RESPONSE_PARAM = "ticket";
+ public static final String SAMLART_RESPONSE_PARAM = "SAMLart";
public static final String SERVICE_TICKET_PREFIX = "ST-";
public static final String SESSION_SERVICE_TICKET = "service_ticket";
@@ -84,14 +92,28 @@
}
@Override
- public Response authenticated(UserSessionModel userSession, ClientSessionCode accessCode) {
- ClientSessionModel clientSession = accessCode.getClientSession();
+ public Response authenticated(AuthenticationSessionModel authSession, UserSessionModel userSession, ClientSessionContext clientSessionCtx) {
+ AuthenticatedClientSessionModel clientSession = clientSessionCtx.getClientSession();
- String service = clientSession.getRedirectUri();
+ String service = authSession.getRedirectUri();
//TODO validate service
- accessCode.setAction(ClientSessionModel.Action.CODE_TO_TOKEN.name());
+
+ OAuth2Code codeData = new OAuth2Code(UUID.randomUUID().toString(),
+ Time.currentTime() + userSession.getRealm().getAccessCodeLifespan(),
+ null, null, authSession.getRedirectUri(), null, null,
+ userSession.getId());
+ String code = OAuth2CodeParser.persistCode(session, clientSession, codeData);
+
KeycloakUriBuilder uriBuilder = KeycloakUriBuilder.fromUri(service);
- uriBuilder.queryParam(TICKET_RESPONSE_PARAM, SERVICE_TICKET_PREFIX + accessCode.getCode());
+
+ String loginTicket = SERVICE_TICKET_PREFIX + code;
+
+ if (authSession.getClientNotes().containsKey(CASLoginProtocol.TARGET_PARAM)) {
+ // This was a SAML 1.1 auth request so return the ticket ID as "SAMLart" instead of "ticket"
+ uriBuilder.queryParam(SAMLART_RESPONSE_PARAM, loginTicket);
+ } else {
+ uriBuilder.queryParam(TICKET_RESPONSE_PARAM, loginTicket);
+ }
URI redirectUri = uriBuilder.build();
@@ -100,12 +122,17 @@
}
@Override
- public Response sendError(ClientSessionModel clientSession, Error error) {
- return Response.serverError().entity(error).build();
+ public Response sendError(AuthenticationSessionModel authSession, Error error) {
+ if (authSession.getClientNotes().containsKey(CASLoginProtocol.GATEWAY_PARAM)) {
+ if (error == Error.PASSIVE_INTERACTION_REQUIRED || error == Error.PASSIVE_LOGIN_REQUIRED) {
+ return Response.status(302).location(URI.create(authSession.getRedirectUri())).build();
+ }
+ }
+ return ErrorPage.error(session, authSession, Response.Status.INTERNAL_SERVER_ERROR, error.name());
}
@Override
- public void backchannelLogout(UserSessionModel userSession, ClientSessionModel clientSession) {
+ public Response backchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession) {
String logoutUrl = clientSession.getRedirectUri();
String serviceTicket = clientSession.getNote(CASLoginProtocol.SESSION_SERVICE_TICKET);
//check if session is fully authenticated (i.e. serviceValidate has been called)
@@ -113,12 +140,13 @@
sendSingleLogoutRequest(logoutUrl, serviceTicket);
}
ClientModel client = clientSession.getClient();
- new ResourceAdminManager(session).logoutClientSession(uriInfo.getRequestUri(), realm, client, clientSession);
+ new ResourceAdminManager(session).logoutClientSession(realm, client, clientSession);
+ return Response.ok().build();
}
private void sendSingleLogoutRequest(String logoutUrl, String serviceTicket) {
- HttpEntity requestEntity = LogoutHelper.buildSingleLogoutRequest(serviceTicket);
try {
+ HttpEntity requestEntity = LogoutHelper.buildSingleLogoutRequest(serviceTicket);
LogoutHelper.postWithRedirect(session, logoutUrl, requestEntity);
logger.debug("Sent CAS single logout for service " + logoutUrl);
} catch (IOException e) {
@@ -127,29 +155,36 @@
}
@Override
- public Response frontchannelLogout(UserSessionModel userSession, ClientSessionModel clientSession) {
+ public Response frontchannelLogout(UserSessionModel userSession, AuthenticatedClientSessionModel clientSession) {
// todo oidc redirect support
throw new RuntimeException("NOT IMPLEMENTED");
}
@Override
- public Response finishLogout(UserSessionModel userSession) {
+ public Response finishBrowserLogout(UserSessionModel userSession, AuthenticationSessionModel logoutSession) {
String redirectUri = userSession.getNote(CASLoginProtocol.LOGOUT_REDIRECT_URI);
- event.event(EventType.LOGOUT);
- event.user(userSession.getUser()).session(userSession).success();
- LoginFormsProvider infoPage = session.getProvider(LoginFormsProvider.class).setSuccess("Logout successful");
+ event.event(EventType.LOGOUT)
+ .user(userSession.getUser())
+ .session(userSession)
+ .detail(Details.USERNAME, userSession.getUser().getUsername());
+
if (redirectUri != null) {
- infoPage.setAttribute("pageRedirectUri", redirectUri);
- } else {
- infoPage.setAttribute("skipLink", true);
+ event.detail(Details.REDIRECT_URI, redirectUri);
+ event.success();
+ return Response.status(302).location(URI.create(redirectUri)).build();
}
+
+ event.success();
+
+ LoginFormsProvider infoPage = session.getProvider(LoginFormsProvider.class).setSuccess("Logout successful");
+ infoPage.setAttribute("skipLink", true);
return infoPage.createInfoPage();
}
@Override
- public boolean requireReauthentication(UserSessionModel userSession, ClientSessionModel clientSession) {
- return "true".equals(clientSession.getNote(CASLoginProtocol.RENEW_PARAM));
+ public boolean requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession) {
+ return "true".equals(authSession.getClientNote(CASLoginProtocol.RENEW_PARAM));
}
@Override
--
Gitblit v1.9.1