Skip to content

Commit d6977ea

Browse files
rossdrewwilkinsona
rossdrew
authored and
wilkinsona
committed
Remove hyphenation of opaquetoken in OAuth2 property names
See spring-projectsgh-17290
1 parent 8edf88a commit d6977ea

File tree

6 files changed

+41
-41
lines changed

6 files changed

+41
-41
lines changed

Diff for: ‎spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/OAuth2ResourceServerProperties.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ public Jwt getJwt() {
4343
return this.jwt;
4444
}
4545

46-
private final OpaqueToken opaqueToken = new OpaqueToken();
46+
private final Opaquetoken opaqueToken = new Opaquetoken();
4747

48-
public OpaqueToken getOpaqueToken() {
48+
public Opaquetoken getOpaquetoken() {
4949
return this.opaqueToken;
5050
}
5151

5252
@PostConstruct
5353
public void validate() {
54-
if (this.getOpaqueToken().getIntrospectionUri() != null) {
54+
if (this.getOpaquetoken().getIntrospectionUri() != null) {
5555
if (this.getJwt().getJwkSetUri() != null) {
5656
handleError("jwt.jwk-set-uri");
5757
}
@@ -66,7 +66,7 @@ public void validate() {
6666

6767
private void handleError(String property) {
6868
throw new IllegalStateException(
69-
"Only one of " + property + " and opaque-token.introspection-uri should be configured.");
69+
"Only one of " + property + " and opaquetoken.introspection-uri should be configured.");
7070
}
7171

7272
public static class Jwt {
@@ -137,7 +137,7 @@ public String readPublicKey() throws IOException {
137137

138138
}
139139

140-
public static class OpaqueToken {
140+
public static class Opaquetoken {
141141

142142
/**
143143
* Client id used to authenticate with the token introspection endpoint.

Diff for: ‎spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/reactive/ReactiveOAuth2ResourceServerOpaqueTokenConfiguration.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ class ReactiveOAuth2ResourceServerOpaqueTokenConfiguration {
4141
static class OpaqueTokenIntrospectionClientConfiguration {
4242

4343
@Bean
44-
@ConditionalOnProperty(name = "spring.security.oauth2.resourceserver.opaque-token.introspection-uri")
44+
@ConditionalOnProperty(name = "spring.security.oauth2.resourceserver.opaquetoken.introspection-uri")
4545
public NimbusReactiveOAuth2TokenIntrospectionClient oAuth2TokenIntrospectionClient(
4646
OAuth2ResourceServerProperties properties) {
47-
OAuth2ResourceServerProperties.OpaqueToken opaqueToken = properties.getOpaqueToken();
47+
OAuth2ResourceServerProperties.Opaquetoken opaqueToken = properties.getOpaquetoken();
4848
return new NimbusReactiveOAuth2TokenIntrospectionClient(opaqueToken.getIntrospectionUri(),
4949
opaqueToken.getClientId(), opaqueToken.getClientSecret());
5050
}

Diff for: ‎spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/servlet/OAuth2ResourceServerOpaqueTokenConfiguration.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ class OAuth2ResourceServerOpaqueTokenConfiguration {
4141
static class OpaqueTokenIntrospectionClientConfiguration {
4242

4343
@Bean
44-
@ConditionalOnProperty(name = "spring.security.oauth2.resourceserver.opaque-token.introspection-uri")
44+
@ConditionalOnProperty(name = "spring.security.oauth2.resourceserver.opaquetoken.introspection-uri")
4545
public NimbusOAuth2TokenIntrospectionClient oAuth2TokenIntrospectionClient(
4646
OAuth2ResourceServerProperties properties) {
47-
OAuth2ResourceServerProperties.OpaqueToken opaqueToken = properties.getOpaqueToken();
47+
OAuth2ResourceServerProperties.Opaquetoken opaqueToken = properties.getOpaquetoken();
4848
return new NimbusOAuth2TokenIntrospectionClient(opaqueToken.getIntrospectionUri(),
4949
opaqueToken.getClientId(), opaqueToken.getClientSecret());
5050
}

Diff for: ‎spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/oauth2/resource/reactive/ReactiveOAuth2ResourceServerAutoConfigurationTests.java

+16-16
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,9 @@ void autoConfigurationWhenSecurityWebFilterChainConfigPresentShouldNotAddOne() {
212212
void autoConfigurationWhenIntrospectionUriAvailableShouldConfigureIntrospectionClient() {
213213
this.contextRunner
214214
.withPropertyValues(
215-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
216-
"spring.security.oauth2.resourceserver.opaque-token.client-id=my-client-id",
217-
"spring.security.oauth2.resourceserver.opaque-token.client-secret=my-client-secret")
215+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
216+
"spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id",
217+
"spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret")
218218
.run((context) -> {
219219
assertThat(context).hasSingleBean(ReactiveOAuth2TokenIntrospectionClient.class);
220220
assertFilterConfiguredWithOpaqueTokenAuthenticationManager(context);
@@ -225,7 +225,7 @@ void autoConfigurationWhenIntrospectionUriAvailableShouldConfigureIntrospectionC
225225
void oAuth2TokenIntrospectionClientIsConditionalOnMissingBean() {
226226
this.contextRunner
227227
.withPropertyValues(
228-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com")
228+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com")
229229
.withUserConfiguration(OAuth2TokenIntrospectionClientConfig.class)
230230
.run((this::assertFilterConfiguredWithOpaqueTokenAuthenticationManager));
231231
}
@@ -234,9 +234,9 @@ void oAuth2TokenIntrospectionClientIsConditionalOnMissingBean() {
234234
void autoConfigurationForOpaqueTokenWhenSecurityWebFilterChainConfigPresentShouldNotAddOne() {
235235
this.contextRunner
236236
.withPropertyValues(
237-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
238-
"spring.security.oauth2.resourceserver.opaque-token.client-id=my-client-id",
239-
"spring.security.oauth2.resourceserver.opaque-token.client-secret=my-client-secret")
237+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
238+
"spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id",
239+
"spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret")
240240
.withUserConfiguration(SecurityWebFilterChainConfig.class).run((context) -> {
241241
assertThat(context).hasSingleBean(SecurityWebFilterChain.class);
242242
assertThat(context).hasBean("testSpringSecurityFilterChain");
@@ -247,40 +247,40 @@ void autoConfigurationForOpaqueTokenWhenSecurityWebFilterChainConfigPresentShoul
247247
void autoConfigurationWhenIntrospectionUriAvailableShouldBeConditionalOnClass() {
248248
this.contextRunner.withClassLoader(new FilteredClassLoader(OAuth2IntrospectionAuthenticationToken.class))
249249
.withPropertyValues(
250-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
251-
"spring.security.oauth2.resourceserver.opaque-token.client-id=my-client-id",
252-
"spring.security.oauth2.resourceserver.opaque-token.client-secret=my-client-secret")
250+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
251+
"spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id",
252+
"spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret")
253253
.run((context) -> assertThat(context).doesNotHaveBean(OAuth2TokenIntrospectionClient.class));
254254
}
255255

256256
@Test
257257
void autoConfigurationWhenBothJwkSetUriAndTokenIntrospectionUriSetShouldFail() {
258258
this.contextRunner
259259
.withPropertyValues(
260-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
260+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
261261
"spring.security.oauth2.resourceserver.jwt.jwk-set-uri=https://jwk-set-uri.com")
262262
.run((context) -> assertThat(context).hasFailed().getFailure().hasMessageContaining(
263-
"Only one of jwt.jwk-set-uri and opaque-token.introspection-uri should be configured."));
263+
"Only one of jwt.jwk-set-uri and opaquetoken.introspection-uri should be configured."));
264264
}
265265

266266
@Test
267267
void autoConfigurationWhenBothJwtIssuerUriAndTokenIntrospectionUriSetShouldFail() {
268268
this.contextRunner
269269
.withPropertyValues(
270-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
270+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
271271
"spring.security.oauth2.resourceserver.jwt.issuer-uri=https://jwk-oidc-issuer-location.com")
272272
.run((context) -> assertThat(context).hasFailed().getFailure().hasMessageContaining(
273-
"Only one of jwt.issuer-uri and opaque-token.introspection-uri should be configured."));
273+
"Only one of jwt.issuer-uri and opaquetoken.introspection-uri should be configured."));
274274
}
275275

276276
@Test
277277
void autoConfigurationWhenBothJwtKeyLocationAndTokenIntrospectionUriSetShouldFail() {
278278
this.contextRunner
279279
.withPropertyValues(
280-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
280+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
281281
"spring.security.oauth2.resourceserver.jwt.public-key-location=classpath:public-key-location")
282282
.run((context) -> assertThat(context).hasFailed().getFailure().hasMessageContaining(
283-
"Only one of jwt.public-key-location and opaque-token.introspection-uri should be configured."));
283+
"Only one of jwt.public-key-location and opaquetoken.introspection-uri should be configured."));
284284
}
285285

286286
private void assertFilterConfiguredWithJwtAuthenticationManager(AssertableReactiveWebApplicationContext context) {

Diff for: ‎spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/oauth2/resource/servlet/OAuth2ResourceServerAutoConfigurationTests.java

+13-13
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,9 @@ void autoConfigurationShouldBeConditionalOnJwtDecoderClass() {
227227
void autoConfigurationWhenIntrospectionUriAvailableShouldConfigureIntrospectionClient() {
228228
this.contextRunner
229229
.withPropertyValues(
230-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
231-
"spring.security.oauth2.resourceserver.opaque-token.client-id=my-client-id",
232-
"spring.security.oauth2.resourceserver.opaque-token.client-secret=my-client-secret")
230+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
231+
"spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id",
232+
"spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret")
233233
.run((context) -> {
234234
assertThat(context).hasSingleBean(OAuth2TokenIntrospectionClient.class);
235235
assertThat(getBearerTokenFilter(context)).isNotNull();
@@ -240,7 +240,7 @@ void autoConfigurationWhenIntrospectionUriAvailableShouldConfigureIntrospectionC
240240
void oAuth2TokenIntrospectionClientIsConditionalOnMissingBean() {
241241
this.contextRunner
242242
.withPropertyValues(
243-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com")
243+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com")
244244
.withUserConfiguration(OAuth2TokenIntrospectionClientConfig.class)
245245
.run((context) -> assertThat(getBearerTokenFilter(context)).isNotNull());
246246
}
@@ -249,40 +249,40 @@ void oAuth2TokenIntrospectionClientIsConditionalOnMissingBean() {
249249
void autoConfigurationWhenIntrospectionUriAvailableShouldBeConditionalOnClass() {
250250
this.contextRunner.withClassLoader(new FilteredClassLoader(OAuth2IntrospectionAuthenticationToken.class))
251251
.withPropertyValues(
252-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
253-
"spring.security.oauth2.resourceserver.opaque-token.client-id=my-client-id",
254-
"spring.security.oauth2.resourceserver.opaque-token.client-secret=my-client-secret")
252+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
253+
"spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id",
254+
"spring.security.oauth2.resourceserver.opaquetoken.client-secret=my-client-secret")
255255
.run((context) -> assertThat(context).doesNotHaveBean(OAuth2TokenIntrospectionClient.class));
256256
}
257257

258258
@Test
259259
void autoConfigurationWhenBothJwkSetUriAndTokenIntrospectionUriSetShouldFail() {
260260
this.contextRunner
261261
.withPropertyValues(
262-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
262+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
263263
"spring.security.oauth2.resourceserver.jwt.jwk-set-uri=https://jwk-set-uri.com")
264264
.run((context) -> assertThat(context).hasFailed().getFailure().hasMessageContaining(
265-
"Only one of jwt.jwk-set-uri and opaque-token.introspection-uri should be configured."));
265+
"Only one of jwt.jwk-set-uri and opaquetoken.introspection-uri should be configured."));
266266
}
267267

268268
@Test
269269
void autoConfigurationWhenBothJwtIssuerUriAndTokenIntrospectionUriSetShouldFail() {
270270
this.contextRunner
271271
.withPropertyValues(
272-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
272+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
273273
"spring.security.oauth2.resourceserver.jwt.issuer-uri=https://jwk-oidc-issuer-location.com")
274274
.run((context) -> assertThat(context).hasFailed().getFailure().hasMessageContaining(
275-
"Only one of jwt.issuer-uri and opaque-token.introspection-uri should be configured."));
275+
"Only one of jwt.issuer-uri and opaquetoken.introspection-uri should be configured."));
276276
}
277277

278278
@Test
279279
void autoConfigurationWhenBothJwtKeyLocationAndTokenIntrospectionUriSetShouldFail() {
280280
this.contextRunner
281281
.withPropertyValues(
282-
"spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://check-token.com",
282+
"spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://check-token.com",
283283
"spring.security.oauth2.resourceserver.jwt.public-key-location=classpath:public-key-location")
284284
.run((context) -> assertThat(context).hasFailed().getFailure().hasMessageContaining(
285-
"Only one of jwt.public-key-location and opaque-token.introspection-uri should be configured."));
285+
"Only one of jwt.public-key-location and opaquetoken.introspection-uri should be configured."));
286286
}
287287

288288
private Filter getBearerTokenFilter(AssertableWebApplicationContext context) {

Diff for: ‎spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -3820,9 +3820,9 @@ to validate tokens via introspection:
38203820

38213821
[source,properties,indent=0]
38223822
----
3823-
spring.security.oauth2.resourceserver.opaque-token.introspection-uri=https://example.com/check-token
3824-
spring.security.oauth2.resourceserver.opaque-token.client-id=my-client-id
3825-
spring.security.oauth2.resourceserver.opaque-token.client-secret-my-client-secret
3823+
spring.security.oauth2.resourceserver.opaquetoken.introspection-uri=https://example.com/check-token
3824+
spring.security.oauth2.resourceserver.opaquetoken.client-id=my-client-id
3825+
spring.security.oauth2.resourceserver.opaquetoken.client-secret-my-client-secret
38263826
----
38273827

38283828
Again, the same properties are applicable for both servlet and reactive applications.

0 commit comments

Comments
 (0)