modules/keycloak-protocol-cas

			@@ -1,15 +1,40 @@
			/*
			* Copyright 2016 Red Hat, Inc. and/or its affiliates
			* and other contributors as indicated by the @author tags.
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package org.keycloak.protocol.oidc.utils;

			import org.jboss.logging.Logger;
			import org.keycloak.common.util.Encode;
			import org.keycloak.common.util.KeycloakUriBuilder;
			import org.keycloak.common.util.UriUtils;
			import org.keycloak.models.ClientModel;
			import org.keycloak.models.Constants;
			import org.keycloak.models.KeycloakSession;
			import org.keycloak.models.KeycloakUriInfo;
			import org.keycloak.models.RealmModel;
			import org.keycloak.protocol.oidc.OIDCLoginProtocol;
			import org.keycloak.services.Urls;
			import org.keycloak.services.util.ResolveRelative;

			import javax.ws.rs.core.UriInfo;
			import java.net.URI;
			import java.util.HashSet;
			import java.util.Collection;
			import java.util.Set;
			import java.util.TreeSet;
			import java.util.stream.Collectors;

			/**
			* @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
			@@ -18,59 +43,86 @@

			private static final Logger logger = Logger.getLogger(RedirectUtils.class);

			public static String verifyRealmRedirectUri(UriInfo uriInfo, String redirectUri, RealmModel realm) {
			Set<String> validRedirects = getValidateRedirectUris(realm);
			return verifyRedirectUri(uriInfo, redirectUri, realm, validRedirects);
			/**
			* This method is deprecated for performance and security reasons and it is available just for the
			* backwards compatibility. It is recommended to use some other methods of this class where the client is given as an argument
			* to the method, so we know the client, which redirect-uri we are trying to resolve.
			*/
			@Deprecated
			public static String verifyRealmRedirectUri(KeycloakSession session, String redirectUri) {
			Set<String> validRedirects = getValidateRedirectUris(session);
			return verifyRedirectUri(session, null, redirectUri, validRedirects, true);
			}

			public static String verifyRedirectUri(UriInfo uriInfo, String redirectUri, RealmModel realm, ClientModel client) {
			Set<String> validRedirects = client.getRedirectUris();
			return verifyRedirectUri(uriInfo, redirectUri, realm, validRedirects);
			public static String verifyRedirectUri(KeycloakSession session, String redirectUri, ClientModel client) {
			return verifyRedirectUri(session, redirectUri, client, true);
			}

			public static Set<String> resolveValidRedirects(UriInfo uriInfo, Set<String> validRedirects) {
			public static String verifyRedirectUri(KeycloakSession session, String redirectUri, ClientModel client, boolean requireRedirectUri) {
			if (client != null)
			return verifyRedirectUri(session, client.getRootUrl(), redirectUri, client.getRedirectUris(), requireRedirectUri);
			return null;
			}

			public static Set<String> resolveValidRedirects(KeycloakSession session, String rootUrl, Set<String> validRedirects) {
			// If the valid redirect URI is relative (no scheme, host, port) then use the request's scheme, host, and port
			Set<String> resolveValidRedirects = new HashSet<String>();
			// the set is ordered by length to get the longest match first
			Set<String> resolveValidRedirects = new TreeSet<>((String s1, String s2) -> s1.length() == s2.length()? s1.compareTo(s2) : s1.length() < s2.length()? 1 : -1);
			for (String validRedirect : validRedirects) {
			resolveValidRedirects.add(validRedirect); // add even relative urls.
			if (validRedirect.startsWith("/")) {
			validRedirect = relativeToAbsoluteURI(uriInfo, validRedirect);
			validRedirect = relativeToAbsoluteURI(session, rootUrl, validRedirect);
			logger.debugv("replacing relative valid redirect with: {0}", validRedirect);
			resolveValidRedirects.add(validRedirect);
			}
			resolveValidRedirects.add(validRedirect);
			}
			return resolveValidRedirects;
			}

			private static Set<String> getValidateRedirectUris(RealmModel realm) {
			Set<String> redirects = new HashSet<String>();
			for (ClientModel client : realm.getClients()) {
			for (String redirect : client.getRedirectUris()) {
			redirects.add(redirect);
			}
			}
			return redirects;
			@Deprecated
			private static Set<String> getValidateRedirectUris(KeycloakSession session) {
			RealmModel realm = session.getContext().getRealm();
			return session.clients().getAllRedirectUrisOfEnabledClients(realm).entrySet().stream()
			.filter(me -> me.getKey().isEnabled() && OIDCLoginProtocol.LOGIN_PROTOCOL.equals(me.getKey().getProtocol()) && !me.getKey().isBearerOnly() && (me.getKey().isStandardFlowEnabled() \|\| me.getKey().isImplicitFlowEnabled()))
			.map(me -> resolveValidRedirects(session, me.getKey().getRootUrl(), me.getValue()))
			.flatMap(Collection::stream)
			.collect(Collectors.toSet());
			}

			private static String verifyRedirectUri(UriInfo uriInfo, String redirectUri, RealmModel realm, Set<String> validRedirects) {
			public static String verifyRedirectUri(KeycloakSession session, String rootUrl, String redirectUri, Set<String> validRedirects, boolean requireRedirectUri) {
			KeycloakUriInfo uriInfo = session.getContext().getUri();
			RealmModel realm = session.getContext().getRealm();

			if (redirectUri == null) {
			if (validRedirects.size() != 1) return null;
			String validRedirect = validRedirects.iterator().next();
			int idx = validRedirect.indexOf("/*");
			if (idx > -1) {
			validRedirect = validRedirect.substring(0, idx);
			if (!requireRedirectUri) {
			redirectUri = getSingleValidRedirectUri(validRedirects);
			}
			redirectUri = validRedirect;

			if (redirectUri == null) {
			logger.debug("No Redirect URI parameter specified");
			return null;
			}
			} else if (validRedirects.isEmpty()) {
			logger.debug("No Redirect URIs supplied");
			redirectUri = null;
			} else {
			String r = redirectUri.indexOf('?') != -1 ? redirectUri.substring(0, redirectUri.indexOf('?')) : redirectUri;
			Set<String> resolveValidRedirects = resolveValidRedirects(uriInfo, validRedirects);
			URI originalRedirect = toUri(redirectUri);
			if (originalRedirect == null) {
			// invalid URI passed as redirectUri
			return null;
			}

			boolean valid = matchesRedirects(resolveValidRedirects, r);
			// Make the validations against fully decoded and normalized redirect-url. This also allows wildcards (case when client configured "Valid redirect-urls" contain wildcards)
			String decodedRedirectUri = decodeRedirectUri(redirectUri);
			URI decodedRedirect = toUri(decodedRedirectUri);
			decodedRedirectUri = getNormalizedRedirectUri(decodedRedirect);
			if (decodedRedirectUri == null) return null;

			if (!valid && r.startsWith(Constants.INSTALLED_APP_URL) && r.indexOf(':', Constants.INSTALLED_APP_URL.length()) >= 0) {
			String r = decodedRedirectUri;
			Set<String> resolveValidRedirects = resolveValidRedirects(session, rootUrl, validRedirects);

			String valid = matchesRedirects(resolveValidRedirects, r, true);

			if (valid == null && (r.startsWith(Constants.INSTALLED_APP_URL) \|\| r.startsWith(Constants.INSTALLED_APP_LOOPBACK)) && r.indexOf(':', Constants.INSTALLED_APP_URL.length()) >= 0) {
			int i = r.indexOf(':', Constants.INSTALLED_APP_URL.length());

			StringBuilder sb = new StringBuilder();
			@@ -83,12 +135,35 @@

			r = sb.toString();

			valid = matchesRedirects(resolveValidRedirects, r);
			valid = matchesRedirects(resolveValidRedirects, r, true);
			}
			if (valid && redirectUri.startsWith("/")) {
			redirectUri = relativeToAbsoluteURI(uriInfo, redirectUri);

			// Return the original redirectUri, which can be partially encoded - for example http://localhost:8280/foo/bar%20bar%2092%2F72/3 . Just make sure it is normalized
			redirectUri = getNormalizedRedirectUri(originalRedirect);

			// We try to check validity also for original (encoded) redirectUrl, but just in case it exactly matches some "Valid Redirect URL" specified for client (not wildcards allowed)
			if (valid == null) {
			valid = matchesRedirects(resolveValidRedirects, redirectUri, false);
			}
			redirectUri = valid ? redirectUri : null;

			if (valid != null && !originalRedirect.isAbsolute()) {
			// return absolute if the original URI is relative
			if (!redirectUri.startsWith("/")) {
			redirectUri = "/" + redirectUri;
			}
			redirectUri = relativeToAbsoluteURI(session, rootUrl, redirectUri);
			}

			String scheme = decodedRedirect.getScheme();
			if (valid != null && scheme != null) {
			// check the scheme is valid, it should be http(s) or explicitly allowed by the validation
			if (!valid.startsWith(scheme + ":") && !"http".equalsIgnoreCase(scheme) && !"https".equalsIgnoreCase(scheme)) {
			logger.debugf("Invalid URI because scheme is not allowed: %s", redirectUri);
			valid = null;
			}
			}

			redirectUri = valid != null ? redirectUri : null;
			}

			if (Constants.INSTALLED_APP_URN.equals(redirectUri)) {
			@@ -98,30 +173,124 @@
			}
			}

			private static String relativeToAbsoluteURI(UriInfo uriInfo, String relative) {
			URI baseUri = uriInfo.getBaseUri();
			String uri = baseUri.getScheme() + "://" + baseUri.getHost();
			if (baseUri.getPort() != -1) {
			uri += ":" + baseUri.getPort();
			private static URI toUri(String redirectUri) {
			URI uri = null;
			if (redirectUri != null) {
			try {
			uri = URI.create(redirectUri);
			} catch (IllegalArgumentException cause) {
			logger.debug("Invalid redirect uri", cause);
			} catch (Exception cause) {
			logger.debug("Unexpected error when parsing redirect uri", cause);
			}
			}
			relative = uri + relative;
			return relative;
			return uri;
			}

			private static boolean matchesRedirects(Set<String> validRedirects, String redirect) {
			private static String getNormalizedRedirectUri(URI uri) {
			String redirectUri = null;
			if (uri != null) {
			redirectUri = uri.normalize().toString();
			}
			return redirectUri;
			}

			// Decode redirectUri. We don't decode query and fragment as those can be encoded in the original URL.
			// URL can be decoded multiple times (in case it was encoded multiple times, or some of it's parts were encoded multiple times)
			private static String decodeRedirectUri(String redirectUri) {
			if (redirectUri == null) return null;
			int MAX_DECODING_COUNT = 5; // Max count of attempts for decoding URL (in case it was encoded multiple times)

			try {
			KeycloakUriBuilder uriBuilder = KeycloakUriBuilder.fromUri(redirectUri, false).preserveDefaultPort();
			String origQuery = uriBuilder.getQuery();
			String origFragment = uriBuilder.getFragment();
			String origUserInfo = uriBuilder.getUserInfo();
			String encodedRedirectUri = uriBuilder
			.replaceQuery(null)
			.fragment(null)
			.userInfo(null)
			.buildAsString();
			String decodedRedirectUri = null;

			for (int i = 0; i < MAX_DECODING_COUNT; i++) {
			decodedRedirectUri = Encode.decode(encodedRedirectUri);
			if (decodedRedirectUri.equals(encodedRedirectUri)) {
			// URL is decoded. We can return it (after attach original query and fragment)
			return KeycloakUriBuilder.fromUri(decodedRedirectUri, false).preserveDefaultPort()
			.replaceQuery(origQuery)
			.fragment(origFragment)
			.userInfo(origUserInfo)
			.buildAsString();
			} else {
			// Next attempt
			encodedRedirectUri = decodedRedirectUri;
			}
			}
			} catch (IllegalArgumentException iae) {
			logger.debugf("Illegal redirect URI used: %s, Details: %s", redirectUri, iae.getMessage());
			}
			logger.debugf("Was not able to decode redirect URI: %s", redirectUri);
			return null;
			}

			private static String relativeToAbsoluteURI(KeycloakSession session, String rootUrl, String relative) {
			if (rootUrl != null) {
			rootUrl = ResolveRelative.resolveRootUrl(session, rootUrl);
			}

			if (rootUrl == null \|\| rootUrl.isEmpty()) {
			rootUrl = UriUtils.getOrigin(session.getContext().getUri().getBaseUri());
			}
			StringBuilder sb = new StringBuilder();
			sb.append(rootUrl);
			sb.append(relative);
			return sb.toString();
			}

			// return the String that matched the redirect or null if not matched
			private static String matchesRedirects(Set<String> validRedirects, String redirect, boolean allowWildcards) {
			logger.tracef("matchesRedirects: redirect URL to check: %s, allow wildcards: %b, Configured valid redirect URLs: %s", redirect, allowWildcards, validRedirects);
			for (String validRedirect : validRedirects) {
			if (validRedirect.endsWith("*")) {
			if (validRedirect.endsWith("*") && !validRedirect.contains("?") && allowWildcards) {
			// strip off the query component - we don't check them when wildcards are effective
			String r = redirect.contains("?") ? redirect.substring(0, redirect.indexOf("?")) : redirect;
			// strip off *
			int length = validRedirect.length() - 1;
			validRedirect = validRedirect.substring(0, length);
			if (redirect.startsWith(validRedirect)) return true;
			if (r.startsWith(validRedirect)) return validRedirect;
			// strip off trailing '/'
			if (length - 1 > 0 && validRedirect.charAt(length - 1) == '/') length--;
			validRedirect = validRedirect.substring(0, length);
			if (validRedirect.equals(redirect)) return true;
			} else if (validRedirect.equals(redirect)) return true;
			if (validRedirect.equals(r)) return validRedirect;
			} else if (validRedirect.equals(redirect)) return validRedirect;
			}
			return false;
			return null;
			}

			private static String getSingleValidRedirectUri(Collection<String> validRedirects) {
			if (validRedirects.size() != 1) return null;
			String validRedirect = validRedirects.iterator().next();
			return validateRedirectUriWildcard(validRedirect);
			}

			public static String validateRedirectUriWildcard(String redirectUri) {
			if (redirectUri == null)
			return null;

			int idx = redirectUri.indexOf("/*");
			if (idx > -1) {
			redirectUri = redirectUri.substring(0, idx);
			}
			return redirectUri;
			}

			private static String getFirstValidRedirectUri(Collection<String> validRedirects) {
			final String redirectUri = validRedirects.stream().findFirst().orElse(null);
			return (redirectUri != null) ? validateRedirectUriWildcard(redirectUri) : null;
			}

			public static String getFirstValidRedirectUri(KeycloakSession session, String rootUrl, Set<String> validRedirects) {
			return getFirstValidRedirectUri(resolveValidRedirects(session, rootUrl, validRedirects));
			}
			}