Browse Source

Polish ref-doc

Issue gh-1205
pull/1212/head
Steve Riesenberg 3 years ago
parent
commit
244cc87ed8
No known key found for this signature in database
GPG Key ID: 5F311AB48A55D521
  1. 5
      docs/src/docs/asciidoc/examples/src/main/java/sample/userinfo/EnableUserInfoSecurityConfig.java
  2. 7
      docs/src/docs/asciidoc/examples/src/main/java/sample/userinfo/jwt/JwtUserInfoMapperSecurityConfig.java
  3. 5
      docs/src/docs/asciidoc/examples/src/test/java/sample/jpa/JpaTests.java
  4. 2
      docs/src/docs/asciidoc/guides/how-to-userinfo.adoc
  5. 4
      docs/src/docs/asciidoc/protocol-endpoints.adoc

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

@ -33,7 +33,7 @@ import org.springframework.core.annotation.Order;
import org.springframework.http.MediaType; import org.springframework.http.MediaType;
import org.springframework.security.config.Customizer; import org.springframework.security.config.Customizer;
import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configurers.oauth2.server.resource.OAuth2ResourceServerConfigurer; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.core.userdetails.User; import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.core.userdetails.UserDetailsService;
@ -54,6 +54,7 @@ import org.springframework.security.web.authentication.LoginUrlAuthenticationEnt
import org.springframework.security.web.util.matcher.MediaTypeRequestMatcher; import org.springframework.security.web.util.matcher.MediaTypeRequestMatcher;
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@EnableWebSecurity
public class EnableUserInfoSecurityConfig { public class EnableUserInfoSecurityConfig {
@Bean // <1> @Bean // <1>
@ -64,7 +65,7 @@ public class EnableUserInfoSecurityConfig {
.oidc(Customizer.withDefaults()); // Enable OpenID Connect 1.0 .oidc(Customizer.withDefaults()); // Enable OpenID Connect 1.0
// @formatter:off // @formatter:off
http http
.oauth2ResourceServer(OAuth2ResourceServerConfigurer::jwt) // <2> .oauth2ResourceServer((oauth2) -> oauth2.jwt(Customizer.withDefaults())) // <2>
.exceptionHandling((exceptions) -> exceptions .exceptionHandling((exceptions) -> exceptions
.defaultAuthenticationEntryPointFor( .defaultAuthenticationEntryPointFor(
new LoginUrlAuthenticationEntryPoint("/login"), new LoginUrlAuthenticationEntryPoint("/login"),

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

@ -34,7 +34,7 @@ import org.springframework.core.annotation.Order;
import org.springframework.http.MediaType; import org.springframework.http.MediaType;
import org.springframework.security.config.Customizer; import org.springframework.security.config.Customizer;
import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configurers.oauth2.server.resource.OAuth2ResourceServerConfigurer; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.core.userdetails.User; import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.core.userdetails.UserDetailsService;
@ -60,6 +60,7 @@ import org.springframework.security.web.util.matcher.MediaTypeRequestMatcher;
import org.springframework.security.web.util.matcher.RequestMatcher; import org.springframework.security.web.util.matcher.RequestMatcher;
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@EnableWebSecurity
public class JwtUserInfoMapperSecurityConfig { public class JwtUserInfoMapperSecurityConfig {
@Bean // <1> @Bean // <1>
@ -90,7 +91,9 @@ public class JwtUserInfoMapperSecurityConfig {
.anyRequest().authenticated() .anyRequest().authenticated()
) )
.csrf(csrf -> csrf.ignoringRequestMatchers(endpointsMatcher)) .csrf(csrf -> csrf.ignoringRequestMatchers(endpointsMatcher))
.oauth2ResourceServer(OAuth2ResourceServerConfigurer::jwt) // <4> .oauth2ResourceServer(resourceServer -> resourceServer
.jwt(Customizer.withDefaults()) // <4>
)
.exceptionHandling((exceptions) -> exceptions .exceptionHandling((exceptions) -> exceptions
.defaultAuthenticationEntryPointFor( .defaultAuthenticationEntryPointFor(
new LoginUrlAuthenticationEntryPoint("/login"), new LoginUrlAuthenticationEntryPoint("/login"),

5
docs/src/docs/asciidoc/examples/src/test/java/sample/jpa/JpaTests.java

@ -43,7 +43,6 @@ import org.springframework.http.MediaType;
import org.springframework.security.config.Customizer; import org.springframework.security.config.Customizer;
import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configurers.oauth2.server.resource.OAuth2ResourceServerConfigurer;
import org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames; import org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames;
import org.springframework.security.oauth2.core.oidc.endpoint.OidcParameterNames; import org.springframework.security.oauth2.core.oidc.endpoint.OidcParameterNames;
import org.springframework.security.oauth2.jwt.JwtDecoder; import org.springframework.security.oauth2.jwt.JwtDecoder;
@ -209,7 +208,9 @@ public class JpaTests {
new MediaTypeRequestMatcher(MediaType.TEXT_HTML) new MediaTypeRequestMatcher(MediaType.TEXT_HTML)
) )
) )
.oauth2ResourceServer(OAuth2ResourceServerConfigurer::jwt); .oauth2ResourceServer((resourceServer) -> resourceServer
.jwt(Customizer.withDefaults())
);
// @formatter:on // @formatter:on
return http.build(); return http.build();
} }

2
docs/src/docs/asciidoc/guides/how-to-userinfo.adoc

@ -22,7 +22,7 @@ The following listing shows how to enable the {spring-security-reference-base-ur
[[sample.userinfo]] [[sample.userinfo]]
include::code:EnableUserInfoSecurityConfig[] include::code:EnableUserInfoSecurityConfig[]
TIP: Click on the "Expanded folded text" icon in the code sample above to display the full example. TIP: Click on the "Expand folded text" icon in the code sample above to display the full example.
This configuration provides the following: This configuration provides the following:

4
docs/src/docs/asciidoc/protocol-endpoints.adoc

@ -557,7 +557,7 @@ public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity h
... ...
http.oauth2ResourceServer(OAuth2ResourceServerConfigurer::jwt); http.oauth2ResourceServer(resourceServer -> resourceServer.jwt(Customizer.withDefaults()));
return http.build(); return http.build();
} }
@ -650,7 +650,7 @@ public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity h
... ...
http.oauth2ResourceServer(OAuth2ResourceServerConfigurer::jwt); http.oauth2ResourceServer(resourceServer -> resourceServer.jwt(Customizer.withDefaults()));
return http.build(); return http.build();
} }

Loading…
Cancel
Save