Skip to content

Commit c60ae45

Browse files
jgrandjajgrandja
committed
Rename ProviderSettings
Closes gh-864
1 parent 4066c3e commit c60ae45

File tree

48 files changed

+367
-367
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+367
-367
lines changed

‎docs/src/docs/asciidoc/configuration-model.adoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity h
9191
.registeredClientRepository(registeredClientRepository) <1>
9292
.authorizationService(authorizationService) <2>
9393
.authorizationConsentService(authorizationConsentService) <3>
94-
.providerSettings(providerSettings) <4>
94+
.authorizationServerSettings(authorizationServerSettings) <4>
9595
.tokenGenerator(tokenGenerator) <5>
9696
.clientAuthentication(clientAuthentication -> { }) <6>
9797
.authorizationEndpoint(authorizationEndpoint -> { }) <7>
@@ -109,7 +109,7 @@ public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity h
109109
<1> `registeredClientRepository()`: The xref:core-model-components.adoc#registered-client-repository[`RegisteredClientRepository`] (*REQUIRED*) for managing new and existing clients.
110110
<2> `authorizationService()`: The xref:core-model-components.adoc#oauth2-authorization-service[`OAuth2AuthorizationService`] for managing new and existing authorizations.
111111
<3> `authorizationConsentService()`: The xref:core-model-components.adoc#oauth2-authorization-consent-service[`OAuth2AuthorizationConsentService`] for managing new and existing authorization consents.
112-
<4> `providerSettings()`: The <<configuring-provider-settings, `ProviderSettings`>> (*REQUIRED*) for customizing configuration settings for the OAuth2 authorization server.
112+
<4> `authorizationServerSettings()`: The <<configuring-authorization-server-settings, `AuthorizationServerSettings`>> (*REQUIRED*) for customizing configuration settings for the OAuth2 authorization server.
113113
<5> `tokenGenerator()`: The xref:core-model-components.adoc#oauth2-token-generator[`OAuth2TokenGenerator`] for generating tokens supported by the OAuth2 authorization server.
114114
<6> `clientAuthentication()`: The configurer for <<configuring-client-authentication, OAuth2 Client Authentication>>.
115115
<7> `authorizationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[OAuth2 Authorization endpoint].
@@ -119,16 +119,16 @@ public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity h
119119
<11> `userInfoEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oidc-user-info-endpoint[OpenID Connect 1.0 UserInfo endpoint].
120120
<12> `clientRegistrationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oidc-client-registration-endpoint[OpenID Connect 1.0 Client Registration endpoint].
121121

122-
[[configuring-provider-settings]]
123-
== Configuring Provider Settings
122+
[[configuring-authorization-server-settings]]
123+
== Configuring Authorization Server Settings
124124

125-
`ProviderSettings` contains the configuration settings for the OAuth2 authorization server (provider).
125+
`AuthorizationServerSettings` contains the configuration settings for the OAuth2 authorization server.
126126
It specifies the `URI` for the protocol endpoints as well as the https://datatracker.ietf.org/doc/html/rfc8414#section-2[issuer identifier].
127127
The default `URI` for the protocol endpoints are as follows:
128128

129129
[source,java]
130130
----
131-
public final class ProviderSettings extends AbstractSettings {
131+
public final class AuthorizationServerSettings extends AbstractSettings {
132132
133133
...
134134
@@ -149,18 +149,18 @@ public final class ProviderSettings extends AbstractSettings {
149149
----
150150

151151
[NOTE]
152-
`ProviderSettings` is a *REQUIRED* component.
152+
`AuthorizationServerSettings` is a *REQUIRED* component.
153153

154154
[TIP]
155-
<<default-configuration, `@Import(OAuth2AuthorizationServerConfiguration.class)`>> automatically registers a `ProviderSettings` `@Bean`, if not already provided.
155+
<<default-configuration, `@Import(OAuth2AuthorizationServerConfiguration.class)`>> automatically registers an `AuthorizationServerSettings` `@Bean`, if not already provided.
156156

157-
The following example shows how to customize the configuration settings and register a `ProviderSettings` `@Bean`:
157+
The following example shows how to customize the configuration settings and register an `AuthorizationServerSettings` `@Bean`:
158158

159159
[source,java]
160160
----
161161
@Bean
162-
public ProviderSettings providerSettings() {
163-
return ProviderSettings.builder()
162+
public AuthorizationServerSettings authorizationServerSettings() {
163+
return AuthorizationServerSettings.builder()
164164
.issuer("https://example.com")
165165
.authorizationEndpoint("/oauth2/v1/authorize")
166166
.tokenEndpoint("/oauth2/v1/token")
@@ -174,10 +174,10 @@ public ProviderSettings providerSettings() {
174174
----
175175

176176
The `ProviderContext` is a context object that holds information about the provider.
177-
It provides access to the `ProviderSettings` and the "`current`" issuer identifier.
177+
It provides access to the `AuthorizationServerSettings` and the "`current`" issuer identifier.
178178

179179
[NOTE]
180-
If the issuer identifier is not configured in `ProviderSettings.builder().issuer(String)`, it is resolved from the current request.
180+
If the issuer identifier is not configured in `AuthorizationServerSettings.builder().issuer(String)`, it is resolved from the current request.
181181

182182
[NOTE]
183183
The `ProviderContext` is accessible through the `ProviderContextHolder`, which associates it with the current request thread by using a `ThreadLocal`.

‎docs/src/docs/asciidoc/core-model-components.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ public interface OAuth2TokenContext extends Context {
335335
----
336336
<1> `getRegisteredClient()`: The <<registered-client, RegisteredClient>> associated with the authorization grant.
337337
<2> `getPrincipal()`: The `Authentication` instance of the resource owner (or client).
338-
<3> `getProviderContext()`: The xref:configuration-model.adoc#configuring-provider-settings[`ProviderContext`] object that holds information related to the provider.
338+
<3> `getProviderContext()`: The xref:configuration-model.adoc#configuring-authorization-server-settings[`ProviderContext`] object that holds information related to the provider.
339339
<4> `getAuthorization()`: The <<oauth2-authorization, OAuth2Authorization>> associated with the authorization grant.
340340
<5> `getAuthorizedScopes()`: The scope(s) authorized for the client.
341341
<6> `getTokenType()`: The `OAuth2TokenType` to generate. The supported values are `code`, `access_token`, `refresh_token`, and `id_token`.

‎docs/src/docs/asciidoc/examples/src/main/java/sample/gettingStarted/SecurityConfig.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@
4242
import org.springframework.security.oauth2.server.authorization.client.RegisteredClient;
4343
import org.springframework.security.oauth2.server.authorization.client.RegisteredClientRepository;
4444
import org.springframework.security.oauth2.server.authorization.config.annotation.web.configuration.OAuth2AuthorizationServerConfiguration;
45+
import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;
4546
import org.springframework.security.oauth2.server.authorization.settings.ClientSettings;
46-
import org.springframework.security.oauth2.server.authorization.settings.ProviderSettings;
4747
import org.springframework.security.provisioning.InMemoryUserDetailsManager;
4848
import org.springframework.security.web.SecurityFilterChain;
4949
import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
@@ -150,8 +150,8 @@ private static KeyPair generateRsaKey() { // <6>
150150
}
151151

152152
@Bean // <7>
153-
public ProviderSettings providerSettings() {
154-
return ProviderSettings.builder().build();
153+
public AuthorizationServerSettings authorizationServerSettings() {
154+
return AuthorizationServerSettings.builder().build();
155155
}
156156

157157
}

‎docs/src/docs/asciidoc/examples/src/main/java/sample/userinfo/EnableUserInfoSecurityConfig.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
import org.springframework.security.oauth2.server.authorization.client.RegisteredClient;
4545
import org.springframework.security.oauth2.server.authorization.client.RegisteredClientRepository;
4646
import org.springframework.security.oauth2.server.authorization.config.annotation.web.configuration.OAuth2AuthorizationServerConfiguration;
47+
import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;
4748
import org.springframework.security.oauth2.server.authorization.settings.ClientSettings;
48-
import org.springframework.security.oauth2.server.authorization.settings.ProviderSettings;
4949
import org.springframework.security.provisioning.InMemoryUserDetailsManager;
5050
import org.springframework.security.web.SecurityFilterChain;
5151
import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
@@ -158,8 +158,8 @@ private static KeyPair generateRsaKey() {
158158
}
159159

160160
@Bean
161-
public ProviderSettings providerSettings() {
162-
return ProviderSettings.builder().build();
161+
public AuthorizationServerSettings authorizationServerSettings() {
162+
return AuthorizationServerSettings.builder().build();
163163
}
164164
// @fold:off
165165

‎docs/src/docs/asciidoc/examples/src/main/java/sample/userinfo/jwt/JwtUserInfoMapperSecurityConfig.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
import org.springframework.security.oauth2.server.authorization.config.annotation.web.configurers.OAuth2AuthorizationServerConfigurer;
5050
import org.springframework.security.oauth2.server.authorization.oidc.authentication.OidcUserInfoAuthenticationContext;
5151
import org.springframework.security.oauth2.server.authorization.oidc.authentication.OidcUserInfoAuthenticationToken;
52+
import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;
5253
import org.springframework.security.oauth2.server.authorization.settings.ClientSettings;
53-
import org.springframework.security.oauth2.server.authorization.settings.ProviderSettings;
5454
import org.springframework.security.oauth2.server.resource.authentication.JwtAuthenticationToken;
5555
import org.springframework.security.provisioning.InMemoryUserDetailsManager;
5656
import org.springframework.security.web.SecurityFilterChain;
@@ -182,8 +182,8 @@ private static KeyPair generateRsaKey() {
182182
}
183183

184184
@Bean
185-
public ProviderSettings providerSettings() {
186-
return ProviderSettings.builder().build();
185+
public AuthorizationServerSettings authorizationServerSettings() {
186+
return AuthorizationServerSettings.builder().build();
187187
}
188188
// @fold:off
189189

‎docs/src/docs/asciidoc/getting-started.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ This is a minimal configuration for getting started quickly. To understand what
5555
<4> An instance of xref:core-model-components.adoc#registered-client-repository[`RegisteredClientRepository`] for managing clients.
5656
<5> An instance of `com.nimbusds.jose.jwk.source.JWKSource` for signing access tokens.
5757
<6> An instance of `java.security.KeyPair` with keys generated on startup used to create the `JWKSource` above.
58-
<7> An instance of xref:configuration-model#configuring-provider-settings[`ProviderSettings`] to configure Spring Authorization Server.
58+
<7> An instance of xref:configuration-model#configuring-authorization-server-settings[`AuthorizationServerSettings`] to configure Spring Authorization Server.

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
import org.springframework.security.oauth2.server.authorization.client.RegisteredClientRepository;
5454
import org.springframework.security.oauth2.server.authorization.context.ProviderContext;
5555
import org.springframework.security.oauth2.server.authorization.context.ProviderContextHolder;
56-
import org.springframework.security.oauth2.server.authorization.settings.ProviderSettings;
56+
import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;
5757
import org.springframework.util.Assert;
5858
import org.springframework.util.CollectionUtils;
5959
import org.springframework.util.StringUtils;
@@ -248,12 +248,12 @@ private static List<String> getProviderAudience() {
248248
return Collections.emptyList();
249249
}
250250

251-
ProviderSettings providerSettings = providerContext.getProviderSettings();
251+
AuthorizationServerSettings authorizationServerSettings = providerContext.getAuthorizationServerSettings();
252252
List<String> providerAudience = new ArrayList<>();
253253
providerAudience.add(providerContext.getIssuer());
254-
providerAudience.add(asUrl(providerContext.getIssuer(), providerSettings.getTokenEndpoint()));
255-
providerAudience.add(asUrl(providerContext.getIssuer(), providerSettings.getTokenIntrospectionEndpoint()));
256-
providerAudience.add(asUrl(providerContext.getIssuer(), providerSettings.getTokenRevocationEndpoint()));
254+
providerAudience.add(asUrl(providerContext.getIssuer(), authorizationServerSettings.getTokenEndpoint()));
255+
providerAudience.add(asUrl(providerContext.getIssuer(), authorizationServerSettings.getTokenIntrospectionEndpoint()));
256+
providerAudience.add(asUrl(providerContext.getIssuer(), authorizationServerSettings.getTokenRevocationEndpoint()));
257257
return providerAudience;
258258
}
259259

‎oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/config/annotation/web/configuration/OAuth2AuthorizationServerConfiguration.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
import org.springframework.security.oauth2.jwt.JwtDecoder;
3535
import org.springframework.security.oauth2.jwt.NimbusJwtDecoder;
3636
import org.springframework.security.oauth2.server.authorization.config.annotation.web.configurers.OAuth2AuthorizationServerConfigurer;
37-
import org.springframework.security.oauth2.server.authorization.settings.ProviderSettings;
37+
import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;
3838
import org.springframework.security.web.SecurityFilterChain;
3939
import org.springframework.security.web.util.matcher.RequestMatcher;
4040

@@ -90,7 +90,7 @@ public static JwtDecoder jwtDecoder(JWKSource<SecurityContext> jwkSource) {
9090
@Bean
9191
RegisterMissingBeanPostProcessor registerMissingBeanPostProcessor() {
9292
RegisterMissingBeanPostProcessor postProcessor = new RegisterMissingBeanPostProcessor();
93-
postProcessor.addBeanDefinition(ProviderSettings.class, () -> ProviderSettings.builder().build());
93+
postProcessor.addBeanDefinition(AuthorizationServerSettings.class, () -> AuthorizationServerSettings.builder().build());
9494
return postProcessor;
9595
}
9696

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationCodeRequestAuthenticationException;
3131
import org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationCodeRequestAuthenticationProvider;
3232
import org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationCodeRequestAuthenticationToken;
33-
import org.springframework.security.oauth2.server.authorization.settings.ProviderSettings;
33+
import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;
3434
import org.springframework.security.oauth2.server.authorization.web.OAuth2AuthorizationEndpointFilter;
3535
import org.springframework.security.web.authentication.AuthenticationConverter;
3636
import org.springframework.security.web.authentication.AuthenticationFailureHandler;
@@ -132,7 +132,7 @@ public OAuth2AuthorizationEndpointConfigurer errorResponseHandler(Authentication
132132
*
133133
* <ul>
134134
* <li>It must be an HTTP POST</li>
135-
* <li>It must be submitted to {@link ProviderSettings#getAuthorizationEndpoint()} ()}</li>
135+
* <li>It must be submitted to {@link AuthorizationServerSettings#getAuthorizationEndpoint()} ()}</li>
136136
* <li>It must include the received {@code client_id} as an HTTP parameter</li>
137137
* <li>It must include the received {@code state} as an HTTP parameter</li>
138138
* <li>It must include the list of {@code scope}s the {@code Resource Owner}
@@ -149,13 +149,13 @@ public OAuth2AuthorizationEndpointConfigurer consentPage(String consentPage) {
149149

150150
@Override
151151
void init(HttpSecurity httpSecurity) {
152-
ProviderSettings providerSettings = OAuth2ConfigurerUtils.getProviderSettings(httpSecurity);
152+
AuthorizationServerSettings authorizationServerSettings = OAuth2ConfigurerUtils.getAuthorizationServerSettings(httpSecurity);
153153
this.requestMatcher = new OrRequestMatcher(
154154
new AntPathRequestMatcher(
155-
providerSettings.getAuthorizationEndpoint(),
155+
authorizationServerSettings.getAuthorizationEndpoint(),
156156
HttpMethod.GET.name()),
157157
new AntPathRequestMatcher(
158-
providerSettings.getAuthorizationEndpoint(),
158+
authorizationServerSettings.getAuthorizationEndpoint(),
159159
HttpMethod.POST.name()));
160160

161161
List<AuthenticationProvider> authenticationProviders =
@@ -169,12 +169,12 @@ void init(HttpSecurity httpSecurity) {
169169
@Override
170170
void configure(HttpSecurity httpSecurity) {
171171
AuthenticationManager authenticationManager = httpSecurity.getSharedObject(AuthenticationManager.class);
172-
ProviderSettings providerSettings = OAuth2ConfigurerUtils.getProviderSettings(httpSecurity);
172+
AuthorizationServerSettings authorizationServerSettings = OAuth2ConfigurerUtils.getAuthorizationServerSettings(httpSecurity);
173173

174174
OAuth2AuthorizationEndpointFilter authorizationEndpointFilter =
175175
new OAuth2AuthorizationEndpointFilter(
176176
authenticationManager,
177-
providerSettings.getAuthorizationEndpoint());
177+
authorizationServerSettings.getAuthorizationEndpoint());
178178
if (this.authorizationRequestConverter != null) {
179179
authorizationEndpointFilter.setAuthenticationConverter(this.authorizationRequestConverter);
180180
}

0 commit comments

Comments
 (0)