From 3ee49b09c66d48c653127eaf45eb6a40d520068b Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Tue, 03 Nov 2026 21:04:42 +0000
Subject: [PATCH] Simplify token prefix validation in ProxyValidateEndpoint
---
src/main/java/org/keycloak/protocol/cas/endpoints/AbstractValidateEndpoint.java | 109 ++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 89 insertions(+), 20 deletions(-)
diff --git a/src/main/java/org/keycloak/protocol/cas/endpoints/AbstractValidateEndpoint.java b/src/main/java/org/keycloak/protocol/cas/endpoints/AbstractValidateEndpoint.java
index 54f05ca..6a93fac 100644
--- a/src/main/java/org/keycloak/protocol/cas/endpoints/AbstractValidateEndpoint.java
+++ b/src/main/java/org/keycloak/protocol/cas/endpoints/AbstractValidateEndpoint.java
@@ -12,30 +12,46 @@
import org.keycloak.protocol.cas.mappers.CASAttributeMapper;
import org.keycloak.protocol.cas.representations.CASErrorCode;
import org.keycloak.protocol.cas.utils.CASValidationException;
+import org.keycloak.protocol.cas.utils.RedirectUtils;
import org.keycloak.protocol.oidc.utils.OAuth2Code;
-import org.keycloak.protocol.oidc.utils.RedirectUtils;
import org.keycloak.services.managers.AuthenticationManager;
import org.keycloak.services.managers.UserSessionCrossDCManager;
import org.keycloak.services.util.DefaultClientSessionContext;
+import java.net.URI;
+import java.nio.charset.StandardCharsets;
import java.util.HashMap;
+import java.util.HexFormat;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
import java.util.UUID;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.HttpResponse;
-import org.apache.http.impl.client.HttpClientBuilder;
+import org.apache.http.util.EntityUtils;
+import org.keycloak.connections.httpclient.HttpClientProvider;
public abstract class AbstractValidateEndpoint {
protected final Logger logger = Logger.getLogger(getClass());
private static final Pattern DOT = Pattern.compile("\\.");
+ private static final Pattern SEPERATION_PATTERN = Pattern.compile("--");
+ private static final int PGT_CALLBACK_TIMEOUT_MS = 5000;
+ private static final RequestConfig PGT_CALLBACK_REQUEST_CONFIG = RequestConfig.custom()
+ .setConnectTimeout(PGT_CALLBACK_TIMEOUT_MS)
+ .setConnectionRequestTimeout(PGT_CALLBACK_TIMEOUT_MS)
+ .setSocketTimeout(PGT_CALLBACK_TIMEOUT_MS)
+ .setRedirectsEnabled(false)
+ .build();
protected KeycloakSession session;
protected RealmModel realm;
protected EventBuilder event;
protected ClientModel client;
+ protected String service;
protected AuthenticatedClientSessionModel clientSession;
protected String pgtIou;
@@ -65,10 +81,7 @@
event.detail(Details.REDIRECT_URI, service);
- client = realm.getClientsStream()
- .filter(c -> CASLoginProtocol.LOGIN_PROTOCOL.equals(c.getProtocol()))
- .filter(c -> RedirectUtils.verifyRedirectUri(session, service, c) != null)
- .findFirst().orElse(null);
+ client = findClient(service);
if (client == null) {
event.error(Errors.CLIENT_NOT_FOUND);
throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Client not found", Response.Status.BAD_REQUEST);
@@ -79,11 +92,20 @@
throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Client disabled", Response.Status.BAD_REQUEST);
}
+ this.service = RedirectUtils.verifyRedirectUri(session, service, client);
+
event.client(client.getClientId());
session.getContext().setClient(client);
}
+ protected ClientModel findClient(String service) {
+ return realm.getClientsStream()
+ .filter(c -> CASLoginProtocol.LOGIN_PROTOCOL.equals(c.getProtocol()))
+ .filter(c -> RedirectUtils.verifyRedirectUri(session, service, c) != null)
+ .findFirst().orElse(null);
+ }
+
protected void checkTicket(String ticket, String prefix, boolean requireReauth) {
if (ticket == null) {
event.error(Errors.INVALID_CODE);
@@ -95,16 +117,23 @@
throw new CASValidationException(CASErrorCode.INVALID_TICKET_SPEC, "Malformed service ticket", Response.Status.BAD_REQUEST);
}
- boolean isReusable = ticket.startsWith(CASLoginProtocol.PROXY_GRANTING_TICKET_PREFIX);
+ String ticketValue = ticket.substring(prefix.length());
- String[] parsed = DOT.split(ticket.substring(prefix.length()), 3);
+ boolean isReusable = ticket.startsWith(CASLoginProtocol.PROXY_GRANTING_TICKET_PREFIX);
+ // Check if the ticket is hex encoded or using old method
+ String[] parsed;
+ if (ticketValue.contains(".")) {
+ parsed = DOT.split(ticketValue, 3);
+ } else {
+ parsed = SEPERATION_PATTERN.split(ticketValue, 3);
+ }
if (parsed.length != 3) {
event.error(Errors.INVALID_CODE);
throw new CASValidationException(CASErrorCode.INVALID_TICKET_SPEC, "Invalid format of the code", Response.Status.BAD_REQUEST);
}
String codeUUID = parsed[0];
- String userSessionId = parsed[1];
+ String userSessionId = ticketValue.contains(".") ? parsed[1] : hexDecode(parsed[1]);
String clientUUID = parsed[2];
event.detail(Details.CODE_ID, userSessionId);
@@ -151,7 +180,11 @@
throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Code is expired", Response.Status.BAD_REQUEST);
}
- clientSession.setNote(CASLoginProtocol.SESSION_TICKET, ticket);
+ // Service and proxy tickets are valid only for the service they were issued for
+ if (!isReusable && (service == null || !service.equals(codeData.getRedirectUriParam()))) {
+ event.error(Errors.INVALID_REDIRECT_URI);
+ throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Ticket was not issued for this service", Response.Status.BAD_REQUEST);
+ }
if (requireReauth && AuthenticationManager.isSSOAuthentication(clientSession)) {
event.error(Errors.SESSION_EXPIRED);
@@ -173,40 +206,67 @@
if (client == null) {
client = clientSession.getClient();
- } else {
+ } else if (!prefix.equals(CASLoginProtocol.PROXY_TICKET_PREFIX)) {
+ // Proxy tickets are issued from the proxying client's session for a (possibly) different target service
if (!client.getClientId().equals(clientSession.getClient().getClientId())) {
event.error(Errors.INVALID_CODE);
throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Invalid service", Response.Status.BAD_REQUEST);
}
}
+ if (codeData.getClientUUID() != null && !codeData.getClientUUID().equals(clientUUID)) {
+ event.error(Errors.INVALID_CODE);
+ throw new CASValidationException(CASErrorCode.INVALID_SERVICE, "Invalid client", Response.Status.BAD_REQUEST);
+ }
+
if (!AuthenticationManager.isSessionValid(realm, userSession)) {
event.error(Errors.USER_SESSION_NOT_FOUND);
throw new CASValidationException(CASErrorCode.INVALID_TICKET, "Session not active", Response.Status.BAD_REQUEST);
}
+ // Single logout refers to the service ticket the client session was established with
+ if (prefix.equals(CASLoginProtocol.SERVICE_TICKET_PREFIX)) {
+ clientSession.setNote(CASLoginProtocol.SESSION_TICKET, ticket);
+ }
}
protected void createProxyGrant(String pgtUrl) {
- if ( RedirectUtils.verifyRedirectUri(session, pgtUrl, client) == null ) {
+ String verifiedPgtUrl = RedirectUtils.verifyRedirectUri(session, pgtUrl, client);
+ if (verifiedPgtUrl == null) {
event.error(Errors.INVALID_REQUEST);
throw new CASValidationException(CASErrorCode.INVALID_PROXY_CALLBACK, "Proxy callback is invalid", Response.Status.BAD_REQUEST);
}
+ // The callback receives a PGT, so require HTTPS unless the realm's "Require SSL" setting allows plain HTTP for the host
+ URI pgtUri = URI.create(verifiedPgtUrl);
+ boolean isHttps = "https".equalsIgnoreCase(pgtUri.getScheme());
+ boolean isHttp = "http".equalsIgnoreCase(pgtUri.getScheme());
+ if (pgtUri.getHost() == null || !(isHttps || (isHttp && !realm.getSslRequired().isRequired(pgtUri.getHost())))) {
+ event.error(Errors.INVALID_REQUEST);
+ throw new CASValidationException(CASErrorCode.INVALID_PROXY_CALLBACK, "Proxy callback must use HTTPS", Response.Status.BAD_REQUEST);
+ }
+
String pgtIou = getPGTIOU();
- String pgtId = getPGT(session, clientSession, pgtUrl);
+ String pgtId = getPGT(session, clientSession, verifiedPgtUrl);
try {
- HttpResponse response = HttpClientBuilder.create().build().execute(
- new HttpGet(new URIBuilder(pgtUrl).setParameter("pgtIou",pgtIou).setParameter("pgtId",pgtId).build())
- );
+ HttpGet request = new HttpGet(new URIBuilder(verifiedPgtUrl).setParameter("pgtIou",pgtIou).setParameter("pgtId",pgtId).build());
+ request.setConfig(PGT_CALLBACK_REQUEST_CONFIG);
- if (response.getStatusLine().getStatusCode() != 200) {
- throw new Exception();
+ HttpClient httpClient = session.getProvider(HttpClientProvider.class).getHttpClient();
+ HttpResponse response = httpClient.execute(request);
+ try {
+ if (response.getStatusLine().getStatusCode() != 200) {
+ throw new Exception();
+ }
+ } finally {
+ EntityUtils.consumeQuietly(response.getEntity());
}
this.pgtIou = pgtIou;
} catch (Exception e) {
+ // The PGT was not delivered, so do not leave it usable
+ session.singleUseObjects().remove(pgtId.substring(0, pgtId.indexOf("--")));
event.error(Errors.INVALID_REQUEST);
throw new CASValidationException(CASErrorCode.PROXY_CALLBACK_ERROR, "Proxy callback returned an error", Response.Status.BAD_REQUEST);
}
@@ -260,8 +320,17 @@
{
String key = UUID.randomUUID().toString();
UserSessionModel userSession = clientSession.getUserSession();
- OAuth2Code codeData = new OAuth2Code(key, Time.currentTime() + userSession.getRealm().getAccessCodeLifespan(), null, null, redirectUriParam, null, null, userSession.getId());
+ OAuth2Code codeData = new OAuth2Code(key, clientSession.getClient().getId(), Time.currentTime() + userSession.getRealm().getAccessCodeLifespan(), null, null, null, redirectUriParam, null, null, null, userSession.getId());
session.singleUseObjects().put(prefix + key, clientSession.getUserSession().getRealm().getAccessCodeLifespan(), codeData.serializeCode());
- return prefix + key + "." + clientSession.getUserSession().getId() + "." + clientSession.getClient().getId();
+ return prefix + key + "--" + hexEncode(clientSession.getUserSession().getId()) + "--" + clientSession.getClient().getId();
+ }
+
+ private String hexEncode(String value) {
+ return HexFormat.of().formatHex(value.getBytes(StandardCharsets.US_ASCII));
+ }
+
+ private String hexDecode(String hex) {
+ byte[] bytes = HexFormat.of().parseHex(hex);
+ return new String(bytes, StandardCharsets.US_ASCII);
}
}
--
Gitblit v1.10.0