|  |  |  | 
|---|
|  |  |  | package org.keycloak.protocol.cas; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | import org.apache.http.HttpEntity; | 
|---|
|  |  |  | import org.jboss.logging.Logger; | 
|---|
|  |  |  | import org.keycloak.common.util.KeycloakUriBuilder; | 
|---|
|  |  |  | 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.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; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public class CASLoginProtocol implements LoginProtocol { | 
|---|
|  |  |  | private static final Logger logger = Logger.getLogger(CASLoginProtocol.class); | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public static final String LOGIN_PROTOCOL = "cas"; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public static final String SERVICE_PARAM = "service"; | 
|---|
|  |  |  | 
|---|
|  |  |  | public static final String TICKET_RESPONSE_PARAM = "ticket"; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public static final String SERVICE_TICKET_PREFIX = "ST-"; | 
|---|
|  |  |  | public static final String SESSION_SERVICE_TICKET = "service_ticket"; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public static final String LOGOUT_REDIRECT_URI = "CAS_LOGOUT_REDIRECT_URI"; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | protected KeycloakSession session; | 
|---|
|  |  |  | protected RealmModel realm; | 
|---|
|  |  |  | protected UriInfo uriInfo; | 
|---|
|  |  |  | protected HttpHeaders headers; | 
|---|
|  |  |  | protected EventBuilder event; | 
|---|
|  |  |  | private boolean requireReauth; | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public CASLoginProtocol(KeycloakSession session, RealmModel realm, UriInfo uriInfo, HttpHeaders headers, EventBuilder event, boolean requireReauth) { | 
|---|
|  |  |  | public CASLoginProtocol(KeycloakSession session, RealmModel realm, UriInfo uriInfo, HttpHeaders headers, EventBuilder event) { | 
|---|
|  |  |  | this.session = session; | 
|---|
|  |  |  | this.realm = realm; | 
|---|
|  |  |  | this.uriInfo = uriInfo; | 
|---|
|  |  |  | this.headers = headers; | 
|---|
|  |  |  | this.event = event; | 
|---|
|  |  |  | this.requireReauth = requireReauth; | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | public CASLoginProtocol() { | 
|---|
|  |  |  | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | @Override | 
|---|
|  |  |  | public Response authenticated(UserSessionModel userSession, ClientSessionCode accessCode) { | 
|---|
|  |  |  | ClientSessionModel clientSession = accessCode.getClientSession(); | 
|---|
|  |  |  | public Response authenticated(UserSessionModel userSession, ClientSessionContext clientSessionCtx) { | 
|---|
|  |  |  | AuthenticatedClientSessionModel clientSession = clientSessionCtx.getClientSession(); | 
|---|
|  |  |  | ClientSessionCode<AuthenticatedClientSessionModel> accessCode = new ClientSessionCode<>(session, realm, clientSession); | 
|---|
|  |  |  |  | 
|---|
|  |  |  | String service = clientSession.getRedirectUri(); | 
|---|
|  |  |  | //TODO validate service | 
|---|
|  |  |  | accessCode.setAction(ClientSessionModel.Action.CODE_TO_TOKEN.name()); | 
|---|
|  |  |  |  | 
|---|
|  |  |  | String code = accessCode.getOrGenerateCode(); | 
|---|
|  |  |  | KeycloakUriBuilder uriBuilder = KeycloakUriBuilder.fromUri(service); | 
|---|
|  |  |  | uriBuilder.queryParam(TICKET_RESPONSE_PARAM, SERVICE_TICKET_PREFIX + accessCode.getCode()); | 
|---|
|  |  |  | uriBuilder.queryParam(TICKET_RESPONSE_PARAM, SERVICE_TICKET_PREFIX + code); | 
|---|
|  |  |  |  | 
|---|
|  |  |  | URI redirectUri = uriBuilder.build(); | 
|---|
|  |  |  |  | 
|---|
|  |  |  | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | @Override | 
|---|
|  |  |  | public Response sendError(ClientSessionModel clientSession, Error error) { | 
|---|
|  |  |  | public Response sendError(AuthenticationSessionModel authSession, Error error) { | 
|---|
|  |  |  | return Response.serverError().entity(error).build(); | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | @Override | 
|---|
|  |  |  | public void backchannelLogout(UserSessionModel userSession, ClientSessionModel clientSession) { | 
|---|
|  |  |  | public void 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) | 
|---|
|  |  |  | if (serviceTicket != null && !serviceTicket.isEmpty()) { | 
|---|
|  |  |  | sendSingleLogoutRequest(logoutUrl, serviceTicket); | 
|---|
|  |  |  | } | 
|---|
|  |  |  | ClientModel client = clientSession.getClient(); | 
|---|
|  |  |  | new ResourceAdminManager(session).logoutClientSession(uriInfo.getRequestUri(), realm, client, clientSession); | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | private void sendSingleLogoutRequest(String logoutUrl, String serviceTicket) { | 
|---|
|  |  |  | HttpEntity requestEntity = LogoutHelper.buildSingleLogoutRequest(serviceTicket); | 
|---|
|  |  |  | try { | 
|---|
|  |  |  | LogoutHelper.postWithRedirect(session, logoutUrl, requestEntity); | 
|---|
|  |  |  | logger.debug("Sent CAS single logout for service " + logoutUrl); | 
|---|
|  |  |  | } catch (IOException e) { | 
|---|
|  |  |  | logger.warn("Failed to call CAS service for logout: " + logoutUrl, e); | 
|---|
|  |  |  | } | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | @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) { | 
|---|
|  |  |  | String redirectUri = userSession.getNote(CASLoginProtocol.LOGOUT_REDIRECT_URI); | 
|---|
|  |  |  |  | 
|---|
|  |  |  | event.event(EventType.LOGOUT); | 
|---|
|  |  |  | event.user(userSession.getUser()).session(userSession).success(); | 
|---|
|  |  |  | return Response.ok().build(); | 
|---|
|  |  |  | LoginFormsProvider infoPage = session.getProvider(LoginFormsProvider.class).setSuccess("Logout successful"); | 
|---|
|  |  |  | if (redirectUri != null) { | 
|---|
|  |  |  | infoPage.setAttribute("pageRedirectUri", redirectUri); | 
|---|
|  |  |  | } else { | 
|---|
|  |  |  | infoPage.setAttribute("skipLink", true); | 
|---|
|  |  |  | } | 
|---|
|  |  |  | return infoPage.createInfoPage(); | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | @Override | 
|---|
|  |  |  | public boolean requireReauthentication(UserSessionModel userSession, ClientSessionModel clientSession) { | 
|---|
|  |  |  | return requireReauth; | 
|---|
|  |  |  | public boolean requireReauthentication(UserSessionModel userSession, AuthenticationSessionModel authSession) { | 
|---|
|  |  |  | return "true".equals(authSession.getClientNote(CASLoginProtocol.RENEW_PARAM)); | 
|---|
|  |  |  | } | 
|---|
|  |  |  |  | 
|---|
|  |  |  | @Override | 
|---|