root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Rename OAuth2 resource server properties 

Closes gh-14165
This commit is contained in:
Madhura Bhave 2018-08-23 16:51:27 -07:00
parent 26353a8f35
commit fc4340c5d4
11 changed files with 27 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/OAuth2ResourceServerProperties.java
View File

@ -23,7 +23,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* @author Madhura Bhave * @author Madhura Bhave
* @since 2.1.0 * @since 2.1.0
*/ */
@ConfigurationProperties(prefix = "spring.security.oauth2.resource") @ConfigurationProperties(prefix = "spring.security.oauth2.resourceserver")
public class OAuth2ResourceServerProperties { public class OAuth2ResourceServerProperties {
private final Jwt jwt = new Jwt(); private final Jwt jwt = new Jwt();
@ -34,27 +34,17 @@ public class OAuth2ResourceServerProperties {
public static class Jwt { public static class Jwt {
private final Jwk jwk = new Jwk();
public Jwk getJwk() {
return this.jwk;
}
}
public static class Jwk {
/** /**
* JSON Web Key URI to use to verify the JWT token. * JSON Web Key URI to use to verify the JWT token.
*/ */
private String setUri; private String jwkSetUri;
public String getSetUri() { public String getJwkSetUri() {
return this.setUri; return this.jwkSetUri;
} }
public void setSetUri(String setUri) { public void setJwkSetUri(String jwkSetUri) {
this.setUri = setUri; this.jwkSetUri = jwkSetUri;
} }
} }

5
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/reactive/ReactiveOAuth2ResourceServerJwkConfiguration.java
View File

@ -39,11 +39,10 @@ class ReactiveOAuth2ResourceServerJwkConfiguration {
} }
@Bean @Bean
@ConditionalOnProperty(name = "spring.security.oauth2.resource.jwt.jwk.set-uri") @ConditionalOnProperty(name = "spring.security.oauth2.resourceserver.jwt.jwk-set-uri")
@ConditionalOnMissingBean @ConditionalOnMissingBean
public ReactiveJwtDecoder jwtDecoder() { public ReactiveJwtDecoder jwtDecoder() {
return new NimbusReactiveJwtDecoder( return new NimbusReactiveJwtDecoder(this.properties.getJwt().getJwkSetUri());
this.properties.getJwt().getJwk().getSetUri());
} }
} }

5
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/servlet/OAuth2ResourceServerJwkConfiguration.java
View File

@ -38,11 +38,10 @@ class OAuth2ResourceServerJwkConfiguration {
} }
@Bean @Bean
@ConditionalOnProperty(name = "spring.security.oauth2.resource.jwt.jwk.set-uri") @ConditionalOnProperty(name = "spring.security.oauth2.resourceserver.jwt.jwk-set-uri")
@ConditionalOnMissingBean @ConditionalOnMissingBean
public JwtDecoder jwtDecoder() { public JwtDecoder jwtDecoder() {
return new NimbusJwtDecoderJwkSupport( return new NimbusJwtDecoderJwkSupport(this.properties.getJwt().getJwkSetUri());
this.properties.getJwt().getJwk().getSetUri());
} }
} }

8
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/oauth2/resource/reactive/ReactiveOAuth2ResourceServerAutoConfigurationTests.java
View File

@ -58,7 +58,7 @@ public class ReactiveOAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void autoConfigurationShouldConfigureResourceServer() { public void autoConfigurationShouldConfigureResourceServer() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.run((context) -> { .run((context) -> {
assertThat(context.getBean(ReactiveJwtDecoder.class)) assertThat(context.getBean(ReactiveJwtDecoder.class))
.isInstanceOf(NimbusReactiveJwtDecoder.class); .isInstanceOf(NimbusReactiveJwtDecoder.class);
@ -75,7 +75,7 @@ public class ReactiveOAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void jwtDecoderBeanIsConditionalOnMissingBean() { public void jwtDecoderBeanIsConditionalOnMissingBean() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.withUserConfiguration(JwtDecoderConfig.class) .withUserConfiguration(JwtDecoderConfig.class)
.run((this::assertFilterConfiguredWithJwtAuthenticationManager)); .run((this::assertFilterConfiguredWithJwtAuthenticationManager));
} }
@ -83,7 +83,7 @@ public class ReactiveOAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void autoConfigurationShouldBeConditionalOnBearerTokenAuthenticationTokenClass() { public void autoConfigurationShouldBeConditionalOnBearerTokenAuthenticationTokenClass() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.withUserConfiguration(JwtDecoderConfig.class) .withUserConfiguration(JwtDecoderConfig.class)
.withClassLoader( .withClassLoader(
new FilteredClassLoader(BearerTokenAuthenticationToken.class)) new FilteredClassLoader(BearerTokenAuthenticationToken.class))
@ -94,7 +94,7 @@ public class ReactiveOAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void autoConfigurationWhenSecurityWebFilterChainConfigPresentShouldNotAddOne() { public void autoConfigurationWhenSecurityWebFilterChainConfigPresentShouldNotAddOne() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.withUserConfiguration(SecurityWebFilterChainConfig.class) .withUserConfiguration(SecurityWebFilterChainConfig.class)
.run((context) -> { .run((context) -> {
assertThat(context).hasSingleBean(SecurityWebFilterChain.class); assertThat(context).hasSingleBean(SecurityWebFilterChain.class);

6
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/oauth2/resource/servlet/OAuth2ResourceServerAutoConfigurationTests.java
View File

@ -55,7 +55,7 @@ public class OAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void autoConfigurationShouldConfigureResourceServer() { public void autoConfigurationShouldConfigureResourceServer() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.run((context) -> { .run((context) -> {
assertThat(context.getBean(JwtDecoder.class)) assertThat(context.getBean(JwtDecoder.class))
.isInstanceOf(NimbusJwtDecoderJwkSupport.class); .isInstanceOf(NimbusJwtDecoderJwkSupport.class);
@ -72,7 +72,7 @@ public class OAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void jwtDecoderBeanIsConditionalOnMissingBean() { public void jwtDecoderBeanIsConditionalOnMissingBean() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.withUserConfiguration(JwtDecoderConfig.class) .withUserConfiguration(JwtDecoderConfig.class)
.run((context) -> assertThat(getBearerTokenFilter(context)).isNotNull()); .run((context) -> assertThat(getBearerTokenFilter(context)).isNotNull());
} }
@ -80,7 +80,7 @@ public class OAuth2ResourceServerAutoConfigurationTests {
@Test @Test
public void autoConfigurationShouldBeConditionalOnJwtAuthenticationTokenClass() { public void autoConfigurationShouldBeConditionalOnJwtAuthenticationTokenClass() {
this.contextRunner.withPropertyValues( this.contextRunner.withPropertyValues(
"spring.security.oauth2.resource.jwt.jwk.set-uri=http://jwk-set-uri.com") "spring.security.oauth2.resourceserver.jwt.jwk-set-uri=http://jwk-set-uri.com")
.withUserConfiguration(JwtDecoderConfig.class) .withUserConfiguration(JwtDecoderConfig.class)
.withClassLoader(new FilteredClassLoader(JwtAuthenticationToken.class)) .withClassLoader(new FilteredClassLoader(JwtAuthenticationToken.class))
.run((context) -> assertThat(getBearerTokenFilter(context)).isNull()); .run((context) -> assertThat(getBearerTokenFilter(context)).isNull());

2
spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
View File

@ -538,7 +538,7 @@ content into your application. Rather, pick only the properties that you need.
spring.security.oauth2.client.registration.*= # OAuth client registrations. spring.security.oauth2.client.registration.*= # OAuth client registrations.
# SECURITY OAUTH2 RESOURCE SERVER ({sc-spring-boot-autoconfigure}/security/oauth2/resource/OAuth2ResourceServerProperties.{sc-ext}[OAuth2ResourceServerProperties]) # SECURITY OAUTH2 RESOURCE SERVER ({sc-spring-boot-autoconfigure}/security/oauth2/resource/OAuth2ResourceServerProperties.{sc-ext}[OAuth2ResourceServerProperties])
spring.security.oauth2.resource.jwt.jwk.set-uri= # JSON Web Key URI to use to verify the JWT token. spring.security.oauth2.resourceserver.jwt.jwk-set-uri= # JSON Web Key URI to use to verify the JWT token.
# ---------------------------------------- # ----------------------------------------
# DATA PROPERTIES # DATA PROPERTIES

2
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View File

@ -3324,7 +3324,7 @@ following example:
[source,properties,indent=0] [source,properties,indent=0]
---- ----
spring.security.oauth2.resource.jwt.jwk.set-uri=https://example.com/oauth2/default/v1/keys spring.security.oauth2.resourceserver.jwt.jwk-set-uri=https://example.com/oauth2/default/v1/keys
---- ----
The same properties are applicable for both servlet and reactive applications. The same properties are applicable for both servlet and reactive applications.

5
spring-boot-samples/spring-boot-sample-oauth2-resource-server/src/main/resources/application.yml
View File

@ -3,6 +3,5 @@ spring:
oauth2: oauth2:
resource: resource:
jwt: jwt:
jwk: # To run the application, replace this with a valid JWK Set URI
# To run the application, replace this with a valid JWK Set URI jwk-set-uri: https://example.com/oauth2/default/v1/keys
set-uri: https://example.com/oauth2/default/v1/keys

4
spring-boot-samples/spring-boot-sample-oauth2-resource-server/src/test/java/sample/oauth2/resource/SampleOauth2ResourceServerApplicationTests.java
View File

@ -57,13 +57,13 @@ public class SampleOauth2ResourceServerApplicationTests {
server.start(); server.start();
String url = server.url("/.well-known/jwks.json").toString(); String url = server.url("/.well-known/jwks.json").toString();
server.enqueue(mockResponse()); server.enqueue(mockResponse());
System.setProperty("spring.security.oauth2.resource.jwt.jwk.set-uri", url); System.setProperty("spring.security.oauth2.resourceserver.jwt.jwk-set-uri", url);
} }
@AfterClass @AfterClass
public static void shutdown() throws IOException { public static void shutdown() throws IOException {
server.shutdown(); server.shutdown();
System.clearProperty("spring.security.oauth2.resource.jwt.jwk.set-uri"); System.clearProperty("spring.security.oauth2.resourceserver.jwt.jwk-set-uri");
} }
@Test @Test

5
spring-boot-samples/spring-boot-sample-reactive-oauth2-resource-server/src/main/resources/application.yml
View File

@ -1,8 +1,7 @@
spring: spring:
security: security:
oauth2: oauth2:
resource: resourceserver:
jwt: jwt:
jwk:
# To run the application, replace this with a valid JWK Set URI # To run the application, replace this with a valid JWK Set URI
set-uri: https://example.com/oauth2/default/v1/keys jwk-set-uri: https://example.com/oauth2/default/v1/keys

4
spring-boot-samples/spring-boot-sample-reactive-oauth2-resource-server/src/test/java/sample/oauth2/resource/SampleReactiveOAuth2ResourceServerApplicationTests.java
View File

@ -50,13 +50,13 @@ public class SampleReactiveOAuth2ResourceServerApplicationTests {
server.start(); server.start();
String url = server.url("/.well-known/jwks.json").toString(); String url = server.url("/.well-known/jwks.json").toString();
server.enqueue(mockResponse()); server.enqueue(mockResponse());
System.setProperty("spring.security.oauth2.resource.jwt.jwk.set-uri", url); System.setProperty("spring.security.oauth2.resourceserver.jwt.jwk-set-uri", url);
} }
@AfterClass @AfterClass
public static void shutdown() throws Exception { public static void shutdown() throws Exception {
server.shutdown(); server.shutdown();
System.clearProperty("spring.security.oauth2.resource.jwt.jwk.set-uri"); System.clearProperty("spring.security.oauth2.resourceserver.jwt.jwk-set-uri");
} }
@Test @Test