Skip to content

Commit 70142f3

Browse files
jgrandjajgrandja
committed
Rename ClientSettings.requireUserConsent() to requireAuthorizationConsent()
Closes spring-projectsgh-363
1 parent c42f80c commit 70142f3

File tree

9 files changed

+29
-29
lines changed

9 files changed

+29
-29
lines changed

‎oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/authentication/OAuth2AuthorizationCodeRequestAuthenticationProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ private static OAuth2Authorization.Builder authorizationBuilder(RegisteredClient
341341
private static boolean requireAuthorizationConsent(RegisteredClient registeredClient,
342342
OAuth2AuthorizationRequest authorizationRequest, OAuth2AuthorizationConsent authorizationConsent) {
343343

344-
if (!registeredClient.getClientSettings().requireUserConsent()) {
344+
if (!registeredClient.getClientSettings().requireAuthorizationConsent()) {
345345
return false;
346346
}
347347
// 'openid' scope does not require consent

‎oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/config/ClientSettings.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020 the original author or authors.
2+
* Copyright 2020-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@
2828
public class ClientSettings extends Settings {
2929
private static final String CLIENT_SETTING_BASE = "setting.client.";
3030
public static final String REQUIRE_PROOF_KEY = CLIENT_SETTING_BASE.concat("require-proof-key");
31-
public static final String REQUIRE_USER_CONSENT = CLIENT_SETTING_BASE.concat("require-user-consent");
31+
public static final String REQUIRE_AUTHORIZATION_CONSENT = CLIENT_SETTING_BASE.concat("require-authorization-consent");
3232

3333
/**
3434
* Constructs a {@code ClientSettings}.
@@ -69,31 +69,31 @@ public ClientSettings requireProofKey(boolean requireProofKey) {
6969
}
7070

7171
/**
72-
* Returns {@code true} if the user's consent is required when the client requests access.
72+
* Returns {@code true} if authorization consent is required when the client requests access.
7373
* The default is {@code false}.
7474
*
75-
* @return {@code true} if the user's consent is required when the client requests access, {@code false} otherwise
75+
* @return {@code true} if authorization consent is required when the client requests access, {@code false} otherwise
7676
*/
77-
public boolean requireUserConsent() {
78-
return setting(REQUIRE_USER_CONSENT);
77+
public boolean requireAuthorizationConsent() {
78+
return setting(REQUIRE_AUTHORIZATION_CONSENT);
7979
}
8080

8181
/**
82-
* Set to {@code true} if the user's consent is required when the client requests access.
82+
* Set to {@code true} if authorization consent is required when the client requests access.
8383
* This applies to all interactive flows (e.g. {@code authorization_code} and {@code device_code}).
8484
*
85-
* @param requireUserConsent {@code true} if the user's consent is required when the client requests access, {@code false} otherwise
85+
* @param requireAuthorizationConsent {@code true} if authorization consent is required when the client requests access, {@code false} otherwise
8686
* @return the {@link ClientSettings}
8787
*/
88-
public ClientSettings requireUserConsent(boolean requireUserConsent) {
89-
setting(REQUIRE_USER_CONSENT, requireUserConsent);
88+
public ClientSettings requireAuthorizationConsent(boolean requireAuthorizationConsent) {
89+
setting(REQUIRE_AUTHORIZATION_CONSENT, requireAuthorizationConsent);
9090
return this;
9191
}
9292

9393
protected static Map<String, Object> defaultSettings() {
9494
Map<String, Object> settings = new HashMap<>();
9595
settings.put(REQUIRE_PROOF_KEY, false);
96-
settings.put(REQUIRE_USER_CONSENT, false);
96+
settings.put(REQUIRE_AUTHORIZATION_CONSENT, false);
9797
return settings;
9898
}
9999
}

‎oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/oidc/authentication/OidcClientRegistrationAuthenticationProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ private static RegisteredClient create(OidcClientRegistration clientRegistration
172172
.clientSettings(clientSettings ->
173173
clientSettings
174174
.requireProofKey(true)
175-
.requireUserConsent(true))
175+
.requireAuthorizationConsent(true))
176176
.tokenSettings(tokenSettings ->
177177
tokenSettings
178178
.idTokenSignatureAlgorithm(SignatureAlgorithm.RS256));

‎oauth2-authorization-server/src/test/java/org/springframework/security/config/annotation/web/configurers/oauth2/server/authorization/OAuth2AuthorizationCodeGrantTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ public void requestWhenRequiresConsentThenDisplaysConsentPage() throws Exception
389389
scopes.add("message.read");
390390
scopes.add("message.write");
391391
})
392-
.clientSettings(settings -> settings.requireUserConsent(true))
392+
.clientSettings(settings -> settings.requireAuthorizationConsent(true))
393393
.build();
394394
this.registeredClientRepository.save(registeredClient);
395395

@@ -416,7 +416,7 @@ public void requestWhenConsentRequestThenReturnAccessTokenResponse() throws Exce
416416
scopes.add("message.read");
417417
scopes.add("message.write");
418418
})
419-
.clientSettings(settings -> settings.requireUserConsent(true))
419+
.clientSettings(settings -> settings.requireAuthorizationConsent(true))
420420
.build();
421421
this.registeredClientRepository.save(registeredClient);
422422

@@ -464,7 +464,7 @@ public void requestWhenCustomConsentPageConfiguredThenRedirect() throws Exceptio
464464
scopes.add("message.read");
465465
scopes.add("message.write");
466466
})
467-
.clientSettings(settings -> settings.requireUserConsent(true))
467+
.clientSettings(settings -> settings.requireAuthorizationConsent(true))
468468
.build();
469469
this.registeredClientRepository.save(registeredClient);
470470

‎oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/authentication/OAuth2AuthorizationCodeRequestAuthenticationProviderTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ public void authenticateWhenPrincipalNotAuthenticatedThenReturnAuthorizationCode
365365
@Test
366366
public void authenticateWhenRequireAuthorizationConsentThenReturnAuthorizationConsent() {
367367
RegisteredClient registeredClient = TestRegisteredClients.registeredClient()
368-
.clientSettings(clientSettings -> clientSettings.requireUserConsent(true))
368+
.clientSettings(clientSettings -> clientSettings.requireAuthorizationConsent(true))
369369
.build();
370370
when(this.registeredClientRepository.findByClientId(eq(registeredClient.getClientId())))
371371
.thenReturn(registeredClient);
@@ -412,7 +412,7 @@ public void authenticateWhenRequireAuthorizationConsentThenReturnAuthorizationCo
412412
@Test
413413
public void authenticateWhenRequireAuthorizationConsentAndOnlyOpenidScopeRequestedThenAuthorizationConsentNotRequired() {
414414
RegisteredClient registeredClient = TestRegisteredClients.registeredClient()
415-
.clientSettings(clientSettings -> clientSettings.requireUserConsent(true))
415+
.clientSettings(clientSettings -> clientSettings.requireAuthorizationConsent(true))
416416
.scopes(scopes -> {
417417
scopes.clear();
418418
scopes.add(OidcScopes.OPENID);
@@ -434,7 +434,7 @@ public void authenticateWhenRequireAuthorizationConsentAndOnlyOpenidScopeRequest
434434
@Test
435435
public void authenticateWhenRequireAuthorizationConsentAndAllPreviouslyApprovedThenAuthorizationConsentNotRequired() {
436436
RegisteredClient registeredClient = TestRegisteredClients.registeredClient()
437-
.clientSettings(clientSettings -> clientSettings.requireUserConsent(true))
437+
.clientSettings(clientSettings -> clientSettings.requireAuthorizationConsent(true))
438438
.build();
439439
when(this.registeredClientRepository.findByClientId(eq(registeredClient.getClientId())))
440440
.thenReturn(registeredClient);

‎oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/config/ClientSettingsTests.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020 the original author or authors.
2+
* Copyright 2020-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ public void constructorWhenDefaultThenDefaultsAreSet() {
3232
ClientSettings clientSettings = new ClientSettings();
3333
assertThat(clientSettings.settings()).hasSize(2);
3434
assertThat(clientSettings.requireProofKey()).isFalse();
35-
assertThat(clientSettings.requireUserConsent()).isFalse();
35+
assertThat(clientSettings.requireAuthorizationConsent()).isFalse();
3636
}
3737

3838
@Test
@@ -49,9 +49,9 @@ public void requireProofKeyWhenTrueThenSet() {
4949
}
5050

5151
@Test
52-
public void requireUserConsentWhenTrueThenSet() {
53-
ClientSettings clientSettings = new ClientSettings().requireUserConsent(true);
54-
assertThat(clientSettings.requireUserConsent()).isTrue();
52+
public void requireAuthorizationConsentWhenTrueThenSet() {
53+
ClientSettings clientSettings = new ClientSettings().requireAuthorizationConsent(true);
54+
assertThat(clientSettings.requireAuthorizationConsent()).isTrue();
5555
}
5656

5757
@Test
@@ -60,10 +60,10 @@ public void settingWhenCalledThenReturnClientSettings() {
6060
.<ClientSettings>setting("name1", "value1")
6161
.requireProofKey(true)
6262
.<ClientSettings>settings(settings -> settings.put("name2", "value2"))
63-
.requireUserConsent(true);
63+
.requireAuthorizationConsent(true);
6464
assertThat(clientSettings.settings()).hasSize(4);
6565
assertThat(clientSettings.requireProofKey()).isTrue();
66-
assertThat(clientSettings.requireUserConsent()).isTrue();
66+
assertThat(clientSettings.requireAuthorizationConsent()).isTrue();
6767
assertThat(clientSettings.<String>setting("name1")).isEqualTo("value1");
6868
assertThat(clientSettings.<String>setting("name2")).isEqualTo("value2");
6969
}

‎oauth2-authorization-server/src/test/java/org/springframework/security/oauth2/server/authorization/oidc/authentication/OidcClientRegistrationAuthenticationProviderTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ public void authenticateWhenValidAccessTokenThenReturnClientRegistration() {
265265
.containsExactlyInAnyOrder(AuthorizationGrantType.AUTHORIZATION_CODE, AuthorizationGrantType.CLIENT_CREDENTIALS);
266266
assertThat(registeredClientResult.getScopes()).containsExactlyInAnyOrder("scope1", "scope2");
267267
assertThat(registeredClientResult.getClientSettings().requireProofKey()).isTrue();
268-
assertThat(registeredClientResult.getClientSettings().requireUserConsent()).isTrue();
268+
assertThat(registeredClientResult.getClientSettings().requireAuthorizationConsent()).isTrue();
269269
assertThat(registeredClientResult.getTokenSettings().idTokenSignatureAlgorithm()).isEqualTo(SignatureAlgorithm.RS256);
270270

271271
OidcClientRegistration clientRegistrationResult = authenticationResult.getClientRegistration();

‎samples/boot/oauth2-integration/authorizationserver-custom-consent-page/src/main/java/sample/config/AuthorizationServerConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public RegisteredClientRepository registeredClientRepository() {
8686
.scope(OidcScopes.OPENID)
8787
.scope("message.read")
8888
.scope("message.write")
89-
.clientSettings(clientSettings -> clientSettings.requireUserConsent(true))
89+
.clientSettings(clientSettings -> clientSettings.requireAuthorizationConsent(true))
9090
.build();
9191
return new InMemoryRegisteredClientRepository(registeredClient);
9292
}

‎samples/boot/oauth2-integration/authorizationserver/src/main/java/sample/config/AuthorizationServerConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public RegisteredClientRepository registeredClientRepository(JdbcTemplate jdbcTe
7777
.scope(OidcScopes.OPENID)
7878
.scope("message.read")
7979
.scope("message.write")
80-
.clientSettings(clientSettings -> clientSettings.requireUserConsent(true))
80+
.clientSettings(clientSettings -> clientSettings.requireAuthorizationConsent(true))
8181
.build();
8282

8383
// Save registered client in db as if in-memory

0 commit comments

Comments
 (0)