| | |
| | | import org.jboss.logging.Logger; |
| | | import org.jboss.resteasy.annotations.cache.NoCache; |
| | | import org.jboss.resteasy.spi.HttpRequest; |
| | | import org.keycloak.OAuthErrorException; |
| | | import org.keycloak.common.ClientConnection; |
| | | import org.keycloak.events.Details; |
| | | import org.keycloak.events.Errors; |
| | |
| | | import org.keycloak.events.EventType; |
| | | import org.keycloak.models.*; |
| | | import org.keycloak.protocol.cas.CASLoginProtocol; |
| | | import org.keycloak.protocol.cas.representations.CASErrorCode; |
| | | import org.keycloak.protocol.cas.utils.CASValidationException; |
| | | import org.keycloak.protocol.oidc.utils.RedirectUtils; |
| | | import org.keycloak.services.ErrorPageException; |
| | | import org.keycloak.services.ErrorResponseException; |
| | | import org.keycloak.services.managers.AuthenticationManager; |
| | | import org.keycloak.services.managers.ClientSessionCode; |
| | | import org.keycloak.services.messages.Messages; |
| | | |
| | | import javax.ws.rs.GET; |
| | | import javax.ws.rs.core.*; |
| | | import java.lang.reflect.Method; |
| | | |
| | | public class ValidateEndpoint { |
| | | protected static final Logger logger = Logger.getLogger(org.keycloak.protocol.oidc.endpoints.LogoutEndpoint.class); |
| | | protected static final Logger logger = Logger.getLogger(ValidateEndpoint.class); |
| | | |
| | | private static final String RESPONSE_OK = "yes\n"; |
| | | private static final String RESPONSE_FAILED = "no\n"; |
| | |
| | | protected RealmModel realm; |
| | | protected EventBuilder event; |
| | | protected ClientModel client; |
| | | protected ClientSessionModel clientSession; |
| | | protected AuthenticatedClientSessionModel clientSession; |
| | | |
| | | public ValidateEndpoint(RealmModel realm, EventBuilder event) { |
| | | this.realm = realm; |
| | |
| | | MultivaluedMap<String, String> params = uriInfo.getQueryParameters(); |
| | | String service = params.getFirst(CASLoginProtocol.SERVICE_PARAM); |
| | | String ticket = params.getFirst(CASLoginProtocol.TICKET_PARAM); |
| | | boolean renew = "true".equalsIgnoreCase(params.getFirst(CASLoginProtocol.RENEW_PARAM)); |
| | | boolean renew = params.containsKey(CASLoginProtocol.RENEW_PARAM); |
| | | |
| | | event.event(EventType.CODE_TO_TOKEN); |
| | | |
| | |
| | | |
| | | event.success(); |
| | | return successResponse(); |
| | | } catch (ErrorResponseException e) { |
| | | } catch (CASValidationException e) { |
| | | return errorResponse(e); |
| | | } |
| | | } |
| | |
| | | return Response.ok(RESPONSE_OK).type(MediaType.TEXT_PLAIN).build(); |
| | | } |
| | | |
| | | protected Response errorResponse(ErrorResponseException e) { |
| | | return Response.status(Response.Status.UNAUTHORIZED).entity(RESPONSE_FAILED).type(MediaType.TEXT_PLAIN).build(); |
| | | protected Response errorResponse(CASValidationException e) { |
| | | return Response.status(e.getStatus()).entity(RESPONSE_FAILED).type(MediaType.TEXT_PLAIN).build(); |
| | | } |
| | | |
| | | private void checkSsl() { |
| | | if (!uriInfo.getBaseUri().getScheme().equals("https") && realm.getSslRequired().isRequired(clientConnection)) { |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "HTTPS required", Response.Status.FORBIDDEN); |
| | | throw new CASValidationException(CASErrorCode.INVALID_REQUEST, "HTTPS required", Response.Status.FORBIDDEN); |
| | | } |
| | | } |
| | | |
| | | private void checkRealm() { |
| | | if (!realm.isEnabled()) { |
| | | throw new ErrorResponseException("access_denied", "Realm not enabled", Response.Status.FORBIDDEN); |
| | | throw new CASValidationException(CASErrorCode.INTERNAL_ERROR, "Realm not enabled", Response.Status.FORBIDDEN); |
| | | } |
| | | } |
| | | |
| | | private void checkClient(String service) { |
| | | if (service == null) { |
| | | event.error(Errors.INVALID_REQUEST); |
| | | throw new ErrorPageException(session, Messages.MISSING_PARAMETER, CASLoginProtocol.SERVICE_PARAM); |
| | | throw new CASValidationException(CASErrorCode.INVALID_REQUEST, "Missing parameter: " + CASLoginProtocol.SERVICE_PARAM, Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | client = realm.getClients().stream() |
| | |
| | | .findFirst().orElse(null); |
| | | if (client == null) { |
| | | event.error(Errors.CLIENT_NOT_FOUND); |
| | | throw new ErrorPageException(session, Messages.CLIENT_NOT_FOUND); |
| | | throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Client not found", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | if (!client.isEnabled()) { |
| | | event.error(Errors.CLIENT_DISABLED); |
| | | throw new ErrorPageException(session, Messages.CLIENT_DISABLED); |
| | | } |
| | | |
| | | if (client.isBearerOnly()) { |
| | | event.error(Errors.NOT_ALLOWED); |
| | | throw new ErrorPageException(session, Messages.BEARER_ONLY); |
| | | throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Client disabled", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | event.client(client.getClientId()); |
| | |
| | | } |
| | | |
| | | private void checkTicket(String ticket, boolean requireReauth) { |
| | | if (ticket == null || !ticket.startsWith(CASLoginProtocol.SERVICE_TICKET_PREFIX)) { |
| | | if (ticket == null) { |
| | | event.error(Errors.INVALID_CODE); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "Missing or invalid parameter: " + CASLoginProtocol.TICKET_PARAM, Response.Status.BAD_REQUEST); |
| | | throw new CASValidationException(CASErrorCode.INVALID_REQUEST, "Missing parameter: " + CASLoginProtocol.TICKET_PARAM, Response.Status.BAD_REQUEST); |
| | | } |
| | | if (!ticket.startsWith(CASLoginProtocol.SERVICE_TICKET_PREFIX)) { |
| | | event.error(Errors.INVALID_CODE); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET_SPEC, "Malformed service ticket", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | String code = ticket.substring(CASLoginProtocol.SERVICE_TICKET_PREFIX.length()); |
| | | |
| | | ClientSessionCode.ParseResult parseResult = ClientSessionCode.parseResult(code, session, realm); |
| | | if (parseResult.isClientSessionNotFound() || parseResult.isIllegalHash()) { |
| | | String[] parts = code.split("\\."); |
| | | if (parts.length == 2) { |
| | | event.detail(Details.CODE_ID, parts[1]); |
| | | } |
| | | String[] parts = code.split("\\."); |
| | | if (parts.length == 4) { |
| | | event.detail(Details.CODE_ID, parts[2]); |
| | | } |
| | | |
| | | ClientSessionCode.ParseResult<AuthenticatedClientSessionModel> parseResult; |
| | | try { |
| | | // Keycloak >3.4 branch: Parameter event was added to ClientSessionCode.parseResult |
| | | Method parseResultMethod = ClientSessionCode.class.getMethod("parseResult", |
| | | String.class, KeycloakSession.class, RealmModel.class, EventBuilder.class, Class.class); |
| | | parseResult = (ClientSessionCode.ParseResult<AuthenticatedClientSessionModel>) parseResultMethod.invoke( |
| | | null, code, session, realm, event, AuthenticatedClientSessionModel.class); |
| | | } catch (ReflectiveOperationException e) { |
| | | // Keycloak <=3.3 branch |
| | | parseResult = ClientSessionCode.parseResult(code, session, realm, AuthenticatedClientSessionModel.class); |
| | | } |
| | | if (parseResult.isAuthSessionNotFound() || parseResult.isIllegalHash()) { |
| | | event.error(Errors.INVALID_CODE); |
| | | if (parseResult.getClientSession() != null) { |
| | | session.sessions().removeClientSession(realm, parseResult.getClientSession()); |
| | | |
| | | // Attempt to use same code twice should invalidate existing clientSession |
| | | AuthenticatedClientSessionModel clientSession = parseResult.getClientSession(); |
| | | if (clientSession != null) { |
| | | clientSession.setUserSession(null); |
| | | } |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "Code not valid", Response.Status.BAD_REQUEST); |
| | | |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Code not valid", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | clientSession = parseResult.getClientSession(); |
| | | event.detail(Details.CODE_ID, clientSession.getId()); |
| | | |
| | | if (!parseResult.getCode().isValid(ClientSessionModel.Action.CODE_TO_TOKEN.name(), ClientSessionCode.ActionType.CLIENT)) { |
| | | event.error(Errors.INVALID_CODE); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "Code is expired", Response.Status.BAD_REQUEST); |
| | | try { |
| | | // Keycloak >3.4 branch: Method isExpiredToken was added |
| | | Method isExpiredToken = ClientSessionCode.ParseResult.class.getMethod("isExpiredToken"); |
| | | if ((Boolean) isExpiredToken.invoke(parseResult)) { |
| | | event.error(Errors.EXPIRED_CODE); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Code is expired", Response.Status.BAD_REQUEST); |
| | | } |
| | | } catch (ReflectiveOperationException e) { |
| | | // Keycloak <=3.3 branch |
| | | if (!parseResult.getCode().isValid(AuthenticatedClientSessionModel.Action.CODE_TO_TOKEN.name(), ClientSessionCode.ActionType.CLIENT)) { |
| | | event.error(Errors.INVALID_CODE); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Code is expired", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | parseResult.getCode().setAction(null); |
| | | } |
| | | |
| | | parseResult.getCode().setAction(null); |
| | | clientSession.setNote(CASLoginProtocol.SESSION_SERVICE_TICKET, ticket); |
| | | |
| | | if (requireReauth && AuthenticationManager.isSSOAuthentication(clientSession)) { |
| | | event.error(Errors.SESSION_EXPIRED); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Interactive authentication was requested but not performed", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | UserSessionModel userSession = clientSession.getUserSession(); |
| | | |
| | | if (userSession == null) { |
| | | event.error(Errors.USER_SESSION_NOT_FOUND); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "User session not found", Response.Status.BAD_REQUEST); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "User session not found", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | UserModel user = userSession.getUser(); |
| | | if (user == null) { |
| | | event.error(Errors.USER_NOT_FOUND); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "User not found", Response.Status.BAD_REQUEST); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "User not found", Response.Status.BAD_REQUEST); |
| | | } |
| | | if (!user.isEnabled()) { |
| | | event.error(Errors.USER_DISABLED); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "User disabled", Response.Status.BAD_REQUEST); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "User disabled", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | event.user(userSession.getUser()); |
| | |
| | | |
| | | if (!client.getClientId().equals(clientSession.getClient().getClientId())) { |
| | | event.error(Errors.INVALID_CODE); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "Auth error", Response.Status.BAD_REQUEST); |
| | | throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Auth error", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | if (!AuthenticationManager.isSessionValid(realm, userSession)) { |
| | | event.error(Errors.USER_SESSION_NOT_FOUND); |
| | | throw new ErrorResponseException(OAuthErrorException.INVALID_GRANT, "Session not active", Response.Status.BAD_REQUEST); |
| | | throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Session not active", Response.Status.BAD_REQUEST); |
| | | } |
| | | |
| | | } |