Remember user consent and make consent page configurable

Author: Kehrlann

oauth2-authorization-server/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/server/authorization/OAuth2AuthorizationServerConfigurer.java

@@ -35,9 +35,11 @@
 import org.springframework.security.oauth2.jwt.JwtEncoder;
 import org.springframework.security.oauth2.jwt.NimbusJwsEncoder;
 import org.springframework.security.oauth2.server.authorization.InMemoryOAuth2AuthorizationService;
+import org.springframework.security.oauth2.server.authorization.InMemoryOAuth2AuthorizationConsentService;
 import org.springframework.security.oauth2.server.authorization.JwtEncodingContext;
 import org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationService;
 import org.springframework.security.oauth2.server.authorization.OAuth2TokenCustomizer;
+import org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationConsentService;
 import org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationCodeAuthenticationProvider;
 import org.springframework.security.oauth2.server.authorization.authentication.OAuth2ClientAuthenticationProvider;
 import org.springframework.security.oauth2.server.authorization.authentication.OAuth2ClientCredentialsAuthenticationProvider;
@@ -96,6 +98,7 @@ public final class OAuth2AuthorizationServerConfigurer<B extends HttpSecurityBui
 			this.tokenRevocationEndpointMatcher.matches(request) ||
 			this.jwkSetEndpointMatcher.matches(request) ||
 			this.oidcProviderConfigurationEndpointMatcher.matches(request);
+	private String consentPage = null;
 
 	/**
 	 * Sets the repository of registered clients.
@@ -133,6 +136,43 @@ public OAuth2AuthorizationServerConfigurer<B> providerSettings(ProviderSettings
 		return this;
 	}
 
+	/**
+	 * Specify the URL to redirect {@code Resource Owners} to if consent is required during
+	 * the {@code authorization_code} flow. A default consent page will be generated when
+	 * this attribute is not specified.
+	 *
+	 * If a URL is specified, users are required to process the specified URL to generate
+	 * a consent page. The query string will contain the following parameters:
+	 *
+	 * <ul>
+	 * <li>{@code client_id} the client identifier</li>
+	 * <li>{@code scope} the space separated list of scopes present in the authorization request</li>
+	 * <li>{@code state} a CSRF protection token</li>
+	 * </ul>
+	 *
+	 * In general, the consent page should create a form that submits
+	 * a request with the following requirements:
+	 *
+	 * <ul>
+	 * <li>It must be an HTTP POST</li>
+	 * <li>It must be submitted to {@link ProviderSettings#authorizationEndpoint()}</li>
+	 * <li>It must include the received {@code client_id} as an HTTP parameter</li>
+	 * <li>It must include the received {@code state} as an HTTP parameter</li>
+	 * <li>It must include the list of {@code scope}s the {@code Resource Owners}
+	 * consents to as an HTTP parameter</li>
+	 * <li>It must include the {@code consent_action} parameter, with value either
+	 * {@code approve} or {@code cancel} as an HTTP parameter</li>
+	 * </ul>
+	 *
+	 *
+	 * @param consentPage the consent page to redirect to if consent is required (e.g. "/consent")
+	 * @return the {@link OAuth2AuthorizationServerConfigurer} for further configuration
+	 */
+	public OAuth2AuthorizationServerConfigurer<B> consentPage(String consentPage) {
+		this.consentPage = consentPage;
+		return this;
+	}
+
 	/**
 	 * Returns a {@link RequestMatcher} for the authorization server endpoints.
 	 *
@@ -237,7 +277,12 @@ public void configure(B builder) {
 				new OAuth2AuthorizationEndpointFilter(
 						getRegisteredClientRepository(builder),
 						getAuthorizationService(builder),
-						providerSettings.authorizationEndpoint());
+						getAuthorizationConsentService(builder),
+						providerSettings.authorizationEndpoint()
+				);
+		if (this.consentPage != null) {
+			authorizationEndpointFilter.setCustomUserConsentUri(this.consentPage);
+		}
 		builder.addFilterBefore(postProcess(authorizationEndpointFilter), AbstractPreAuthenticatedProcessingFilter.class);
 
 		OAuth2TokenEndpointFilter tokenEndpointFilter =
@@ -310,6 +355,18 @@ private static <B extends HttpSecurityBuilder<B>> OAuth2AuthorizationService get
 		return authorizationService;
 	}
 
+	private static <B extends HttpSecurityBuilder<B>> OAuth2AuthorizationConsentService getAuthorizationConsentService(B builder) {
+		OAuth2AuthorizationConsentService authorizationConsentService = builder.getSharedObject(OAuth2AuthorizationConsentService.class);
+		if (authorizationConsentService == null) {
+			authorizationConsentService = getOptionalBean(builder, OAuth2AuthorizationConsentService.class);
+			if (authorizationConsentService == null) {
+				authorizationConsentService = new InMemoryOAuth2AuthorizationConsentService();
+			}
+			builder.setSharedObject(OAuth2AuthorizationConsentService.class, authorizationConsentService);
+		}
+		return authorizationConsentService;
+	}
+
 	private static <B extends HttpSecurityBuilder<B>> JwtEncoder getJwtEncoder(B builder) {
 		JwtEncoder jwtEncoder = builder.getSharedObject(JwtEncoder.class);
 		if (jwtEncoder == null) {

oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/InMemoryOAuth2AuthorizationConsentService.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2020-2021 the original author or authors.
+ *
+ * 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
+ *
+ *      https://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.springframework.security.oauth2.server.authorization;
+
+import org.springframework.lang.NonNull;
+import org.springframework.lang.Nullable;
+import org.springframework.security.oauth2.core.Version;
+import org.springframework.security.oauth2.server.authorization.client.RegisteredClient;
+import org.springframework.util.Assert;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * An {@link OAuth2AuthorizationConsentService} that stores {@link OAuth2AuthorizationConsent}'s in-memory.
+ *
+ * <p>
+ * <b>NOTE:</b> This implementation should ONLY be used during development/testing.
+ *
+ * @author Daniel Garnier-Moiroux
+ * @since 0.1.1
+ * @see OAuth2AuthorizationConsent
+ */
+public class InMemoryOAuth2AuthorizationConsentService implements OAuth2AuthorizationConsentService {
+	private final Map<Key, OAuth2AuthorizationConsent> consents = new ConcurrentHashMap<>();
+
+	@Override
+	public void save(@NonNull OAuth2AuthorizationConsent consent) {
+		Key key = Key.from(consent);
+		this.consents.put(key, consent);
+	}
+
+	@Override
+	public void remove(@NonNull OAuth2AuthorizationConsent consent) {
+		Key key = Key.from(consent);
+		this.consents.remove(key, consent);
+	}
+
+	@Override
+	@Nullable
+	public OAuth2AuthorizationConsent findById(String registeredClientId, String principalName) {
+		Assert.hasText(registeredClientId, "registeredClientId cannot be empty");
+		Assert.hasText(principalName, "principalName cannot be empty");
+		Key key = new Key(registeredClientId, principalName);
+		return this.consents.get(key);
+	}
+
+	/**
+	 * Identifier for {@link OAuth2AuthorizationConsent}.
+	 *
+	 * @author Daniel Garnier-Moiroux
+	 * @see OAuth2AuthorizationConsent
+	 * @since 0.1.1
+	 */
+	private final static class Key implements Serializable {
+		private static final long serialVersionUID = Version.SERIAL_VERSION_UID;
+
+		private final String registeredClientId;
+		private final String principalName;
+
+		/**
+		 * Constructs a {@code Key} using the provided parameters.
+		 *
+		 * @param registeredClientId the identifier for the {@link RegisteredClient registeredClient}
+		 * @param principalName the name of the {@code Principal}, Resource Owner or Client
+		 */
+		private Key(@NonNull String registeredClientId, @NonNull String principalName) {
+			this.registeredClientId = registeredClientId;
+			this.principalName = principalName;
+		}
+
+		/**
+		 * Constructs a {@code Key} with the values from the provided {@link OAuth2AuthorizationConsent}.
+		 *
+		 * @param consent the {@link OAuth2AuthorizationConsent}
+		 */
+		private static Key from(OAuth2AuthorizationConsent consent) {
+			Assert.notNull(consent, "consent cannot be null");
+			return new Key(consent.getRegisteredClientId(), consent.getPrincipalName());
+		}
+
+		@Override
+		public boolean equals(Object o) {
+			if (this == o) return true;
+			if (o == null || getClass() != o.getClass()) return false;
+			Key key = (Key) o;
+			return this.registeredClientId.equals(key.registeredClientId) && this.principalName.equals(key.principalName);
+		}
+
+		@Override
+		public int hashCode() {
+			return Objects.hash(this.registeredClientId, this.principalName);
+		}
+	}
+}