From 352436410a73e70a8adffd8d5bfbd2bcdf97c139 Mon Sep 17 00:00:00 2001
From: Matthias Piepkorn <mpiepk@gmail.com>
Date: Sun, 29 Jan 2017 12:10:37 +0000
Subject: [PATCH] Improve serviceValidate error handling
---
src/main/java/org/keycloak/protocol/cas/utils/CASValidationException.java | 30 ++++++++++
src/main/java/org/keycloak/protocol/cas/representations/CASErrorCode.java | 18 ++++++
src/main/java/org/keycloak/protocol/cas/endpoints/ServiceValidateEndpoint.java | 8 +-
src/main/java/org/keycloak/protocol/cas/endpoints/ValidateEndpoint.java | 49 +++++++--------
src/test/java/org/keycloak/protocol/cas/ServiceResponseTest.java | 7 +-
src/main/java/org/keycloak/protocol/cas/endpoints/AuthorizationEndpoint.java | 5 -
src/main/java/org/keycloak/protocol/cas/utils/ServiceResponseHelper.java | 5 +
7 files changed, 82 insertions(+), 40 deletions(-)
diff --git a/src/main/java/org/keycloak/protocol/cas/endpoints/AuthorizationEndpoint.java b/src/main/java/org/keycloak/protocol/cas/endpoints/AuthorizationEndpoint.java
index a3d80df..aff46db 100644
--- a/src/main/java/org/keycloak/protocol/cas/endpoints/AuthorizationEndpoint.java
+++ b/src/main/java/org/keycloak/protocol/cas/endpoints/AuthorizationEndpoint.java
@@ -84,11 +84,6 @@
throw new ErrorPageException(session, Messages.CLIENT_DISABLED);
}
- if (client.isBearerOnly()) {
- event.error(Errors.NOT_ALLOWED);
- throw new ErrorPageException(session, Messages.BEARER_ONLY);
- }
-
redirectUri = RedirectUtils.verifyRedirectUri(uriInfo, service, realm, client);
event.client(client.getClientId());
diff --git a/src/main/java/org/keycloak/protocol/cas/endpoints/ServiceValidateEndpoint.java b/src/main/java/org/keycloak/protocol/cas/endpoints/ServiceValidateEndpoint.java
index b110d96..a5a3069 100644
--- a/src/main/java/org/keycloak/protocol/cas/endpoints/ServiceValidateEndpoint.java
+++ b/src/main/java/org/keycloak/protocol/cas/endpoints/ServiceValidateEndpoint.java
@@ -8,9 +8,9 @@
import org.keycloak.protocol.ProtocolMapper;
import org.keycloak.protocol.cas.mappers.CASAttributeMapper;
import org.keycloak.protocol.cas.representations.CasServiceResponse;
+import org.keycloak.protocol.cas.utils.CASValidationException;
import org.keycloak.protocol.cas.utils.ContentTypeHelper;
import org.keycloak.protocol.cas.utils.ServiceResponseHelper;
-import org.keycloak.services.ErrorResponseException;
import org.keycloak.services.managers.ClientSessionCode;
import javax.ws.rs.core.*;
@@ -45,9 +45,9 @@
}
@Override
- protected Response errorResponse(ErrorResponseException e) {
- CasServiceResponse serviceResponse = ServiceResponseHelper.createFailure("CODE", "Description");
- return prepare(Response.Status.FORBIDDEN, serviceResponse);
+ protected Response errorResponse(CASValidationException e) {
+ CasServiceResponse serviceResponse = ServiceResponseHelper.createFailure(e.getError(), e.getErrorDescription());
+ return prepare(e.getStatus(), serviceResponse);
}
private Response prepare(Response.Status status, CasServiceResponse serviceResponse) {
diff --git a/src/main/java/org/keycloak/protocol/cas/endpoints/ValidateEndpoint.java b/src/main/java/org/keycloak/protocol/cas/endpoints/ValidateEndpoint.java
index 5727b50..28fbd50 100644
--- a/src/main/java/org/keycloak/protocol/cas/endpoints/ValidateEndpoint.java
+++ b/src/main/java/org/keycloak/protocol/cas/endpoints/ValidateEndpoint.java
@@ -3,7 +3,6 @@
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;
@@ -11,12 +10,11 @@
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.*;
@@ -71,7 +69,7 @@
event.success();
return successResponse();
- } catch (ErrorResponseException e) {
+ } catch (CASValidationException e) {
return errorResponse(e);
}
}
@@ -80,26 +78,26 @@
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()
@@ -108,17 +106,12 @@
.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());
@@ -127,9 +120,13 @@
}
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());
@@ -144,7 +141,7 @@
if (parseResult.getClientSession() != null) {
session.sessions().removeClientSession(realm, parseResult.getClientSession());
}
- 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();
@@ -152,7 +149,7 @@
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);
+ throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Code is expired", Response.Status.BAD_REQUEST);
}
parseResult.getCode().setAction(null);
@@ -161,17 +158,17 @@
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());
@@ -179,12 +176,12 @@
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);
}
}
diff --git a/src/main/java/org/keycloak/protocol/cas/representations/CASErrorCode.java b/src/main/java/org/keycloak/protocol/cas/representations/CASErrorCode.java
new file mode 100644
index 0000000..d80825c
--- /dev/null
+++ b/src/main/java/org/keycloak/protocol/cas/representations/CASErrorCode.java
@@ -0,0 +1,18 @@
+package org.keycloak.protocol.cas.representations;
+
+public enum CASErrorCode {
+ /** not all of the required request parameters were present */
+ INVALID_REQUEST,
+ /** failure to meet the requirements of validation specification */
+ INVALID_TICKET_SPEC,
+ /** the service is not authorized to perform proxy authentication */
+ UNAUTHORIZED_SERVICE_PROXY,
+ /** The proxy callback specified is invalid. The credentials specified for proxy authentication do not meet the security requirements */
+ INVALID_PROXY_CALLBACK,
+ /** the ticket provided was not valid, or the ticket did not come from an initial login and renew was set on validation. */
+ INVALID_TICKET,
+ /** the ticket provided was valid, but the service specified did not match the service associated with the ticket. */
+ INVALID_SERVICE,
+ /** an internal error occurred during ticket validation */
+ INTERNAL_ERROR
+}
diff --git a/src/main/java/org/keycloak/protocol/cas/utils/CASValidationException.java b/src/main/java/org/keycloak/protocol/cas/utils/CASValidationException.java
new file mode 100644
index 0000000..31d786e
--- /dev/null
+++ b/src/main/java/org/keycloak/protocol/cas/utils/CASValidationException.java
@@ -0,0 +1,30 @@
+package org.keycloak.protocol.cas.utils;
+
+import org.keycloak.protocol.cas.representations.CASErrorCode;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+
+public class CASValidationException extends WebApplicationException {
+ private final CASErrorCode error;
+ private final String errorDescription;
+ private final Response.Status status;
+
+ public CASValidationException(CASErrorCode error, String errorDescription, Response.Status status) {
+ this.error = error;
+ this.errorDescription = errorDescription;
+ this.status = status;
+ }
+
+ public CASErrorCode getError() {
+ return error;
+ }
+
+ public String getErrorDescription() {
+ return errorDescription;
+ }
+
+ public Response.Status getStatus() {
+ return status;
+ }
+}
diff --git a/src/main/java/org/keycloak/protocol/cas/utils/ServiceResponseHelper.java b/src/main/java/org/keycloak/protocol/cas/utils/ServiceResponseHelper.java
index 8b927b8..ac1aa64 100644
--- a/src/main/java/org/keycloak/protocol/cas/utils/ServiceResponseHelper.java
+++ b/src/main/java/org/keycloak/protocol/cas/utils/ServiceResponseHelper.java
@@ -1,5 +1,6 @@
package org.keycloak.protocol.cas.utils;
+import org.keycloak.protocol.cas.representations.CASErrorCode;
import org.keycloak.protocol.cas.representations.CasServiceResponse;
import org.keycloak.protocol.cas.representations.CasServiceResponseAuthenticationFailure;
import org.keycloak.protocol.cas.representations.CasServiceResponseAuthenticationSuccess;
@@ -32,10 +33,10 @@
return response;
}
- public static CasServiceResponse createFailure(String errorCode, String errorDescription) {
+ public static CasServiceResponse createFailure(CASErrorCode errorCode, String errorDescription) {
CasServiceResponse response = new CasServiceResponse();
CasServiceResponseAuthenticationFailure failure = new CasServiceResponseAuthenticationFailure();
- failure.setCode(errorCode);
+ failure.setCode(errorCode == null ? CASErrorCode.INTERNAL_ERROR.name() : errorCode.name());
failure.setDescription(errorDescription);
response.setAuthenticationFailure(failure);
diff --git a/src/test/java/org/keycloak/protocol/cas/ServiceResponseTest.java b/src/test/java/org/keycloak/protocol/cas/ServiceResponseTest.java
index 349c0c8..284a567 100644
--- a/src/test/java/org/keycloak/protocol/cas/ServiceResponseTest.java
+++ b/src/test/java/org/keycloak/protocol/cas/ServiceResponseTest.java
@@ -1,6 +1,7 @@
package org.keycloak.protocol.cas;
import org.junit.Test;
+import org.keycloak.protocol.cas.representations.CASErrorCode;
import org.keycloak.protocol.cas.representations.CasServiceResponse;
import org.keycloak.protocol.cas.utils.ServiceResponseHelper;
import org.keycloak.protocol.cas.utils.ServiceResponseMarshaller;
@@ -45,13 +46,13 @@
private static final String EXPECTED_JSON_FAILURE = "{\n" +
" \"serviceResponse\" : {\n" +
" \"authenticationFailure\" : {\n" +
- " \"code\" : \"ERROR_CODE\",\n" +
+ " \"code\" : \"INVALID_REQUEST\",\n" +
" \"description\" : \"Error description\"\n" +
" }\n" +
" }\n" +
"}";
private static final String EXPECTED_XML_FAILURE = "<cas:serviceResponse xmlns:cas=\"http://www.yale.edu/tp/cas\">\n" +
- " <cas:authenticationFailure code=\"ERROR_CODE\">Error description</cas:authenticationFailure>\n" +
+ " <cas:authenticationFailure code=\"INVALID_REQUEST\">Error description</cas:authenticationFailure>\n" +
"</cas:serviceResponse>";
@Test
@@ -70,7 +71,7 @@
@Test
public void testErrorResponse() throws Exception {
- CasServiceResponse response = ServiceResponseHelper.createFailure("ERROR_CODE", "Error description");
+ CasServiceResponse response = ServiceResponseHelper.createFailure(CASErrorCode.INVALID_REQUEST, "Error description");
assertEquals(EXPECTED_JSON_FAILURE, ServiceResponseMarshaller.marshalJson(response));
assertEquals(EXPECTED_XML_FAILURE, ServiceResponseMarshaller.marshalXml(response));
--
Gitblit v1.9.1