Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-06-08 13:12:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update authorize-http-requests.adoc

Browse Source 
Fix patterns in the Security Matchers documentation

Signed-off-by: Bragolgirith <6455473+Bragolgirith@users.noreply.github.com>
This commit is contained in:
Bragolgirith 2025-03-10 15:40:25 +01:00 committed by Josh Cummings
parent 65e83f8e7a
commit 72554f7f36
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/modules/ROOT/pages/servlet/authorization/authorize-http-requests.adoc
View File

@ -1035,8 +1035,8 @@ public class SecurityConfig {
http http
.securityMatcher("/api/**") <1> .securityMatcher("/api/**") <1>
.authorizeHttpRequests(authorize -> authorize .authorizeHttpRequests(authorize -> authorize
.requestMatchers("/user/**").hasRole("USER") <2> .requestMatchers("/api/user/**").hasRole("USER") <2>
.requestMatchers("/admin/**").hasRole("ADMIN") <3> .requestMatchers("/api/admin/**").hasRole("ADMIN") <3>
.anyRequest().authenticated() <4> .anyRequest().authenticated() <4>
) )
.formLogin(withDefaults()); .formLogin(withDefaults());
@ -1058,8 +1058,8 @@ open class SecurityConfig {
http { http {
securityMatcher("/api/**") <1> securityMatcher("/api/**") <1>
authorizeHttpRequests { authorizeHttpRequests {
authorize("/user/**", hasRole("USER")) <2> authorize("/api/user/**", hasRole("USER")) <2>
authorize("/admin/**", hasRole("ADMIN")) <3> authorize("/api/admin/**", hasRole("ADMIN")) <3>
authorize(anyRequest, authenticated) <4> authorize(anyRequest, authenticated) <4>
} }
} }
@ -1071,8 +1071,8 @@ open class SecurityConfig {
====== ======
<1> Configure `HttpSecurity` to only be applied to URLs that start with `/api/` <1> Configure `HttpSecurity` to only be applied to URLs that start with `/api/`
<2> Allow access to URLs that start with `/user/` to users with the `USER` role <2> Allow access to URLs that start with `/api/user/` to users with the `USER` role
<3> Allow access to URLs that start with `/admin/` to users with the `ADMIN` role <3> Allow access to URLs that start with `/api/admin/` to users with the `ADMIN` role
<4> Any other request that doesn't match the rules above, will require authentication <4> Any other request that doesn't match the rules above, will require authentication
The `securityMatcher(s)` and `requestMatcher(s)` methods will decide which `RequestMatcher` implementation fits best for your application: If {spring-framework-reference-url}web.html#spring-web[Spring MVC] is in the classpath, then {security-api-url}org/springframework/security/web/servlet/util/matcher/MvcRequestMatcher.html[`MvcRequestMatcher`] will be used, otherwise, {security-api-url}org/springframework/security/web/servlet/util/matcher/AntPathRequestMatcher.html[`AntPathRequestMatcher`] will be used. The `securityMatcher(s)` and `requestMatcher(s)` methods will decide which `RequestMatcher` implementation fits best for your application: If {spring-framework-reference-url}web.html#spring-web[Spring MVC] is in the classpath, then {security-api-url}org/springframework/security/web/servlet/util/matcher/MvcRequestMatcher.html[`MvcRequestMatcher`] will be used, otherwise, {security-api-url}org/springframework/security/web/servlet/util/matcher/AntPathRequestMatcher.html[`AntPathRequestMatcher`] will be used.
@ -1098,8 +1098,8 @@ public class SecurityConfig {
http http
.securityMatcher(antMatcher("/api/**")) <2> .securityMatcher(antMatcher("/api/**")) <2>
.authorizeHttpRequests(authorize -> authorize .authorizeHttpRequests(authorize -> authorize
.requestMatchers(antMatcher("/user/**")).hasRole("USER") <3> .requestMatchers(antMatcher("/api/user/**")).hasRole("USER") <3>
.requestMatchers(regexMatcher("/admin/.*")).hasRole("ADMIN") <4> .requestMatchers(regexMatcher("/api/admin/.*")).hasRole("ADMIN") <4>
.requestMatchers(new MyCustomRequestMatcher()).hasRole("SUPERVISOR") <5> .requestMatchers(new MyCustomRequestMatcher()).hasRole("SUPERVISOR") <5>
.anyRequest().authenticated() .anyRequest().authenticated()
) )
@ -1133,8 +1133,8 @@ open class SecurityConfig {
http { http {
securityMatcher(antMatcher("/api/**")) <2> securityMatcher(antMatcher("/api/**")) <2>
authorizeHttpRequests { authorizeHttpRequests {
authorize(antMatcher("/user/**"), hasRole("USER")) <3> authorize(antMatcher("/api/user/**"), hasRole("USER")) <3>
authorize(regexMatcher("/admin/**"), hasRole("ADMIN")) <4> authorize(regexMatcher("/api/admin/**"), hasRole("ADMIN")) <4>
authorize(MyCustomRequestMatcher(), hasRole("SUPERVISOR")) <5> authorize(MyCustomRequestMatcher(), hasRole("SUPERVISOR")) <5>
authorize(anyRequest, authenticated) authorize(anyRequest, authenticated)
} }
@ -1148,8 +1148,8 @@ open class SecurityConfig {
<1> Import the static factory methods from `AntPathRequestMatcher` and `RegexRequestMatcher` to create `RequestMatcher` instances. <1> Import the static factory methods from `AntPathRequestMatcher` and `RegexRequestMatcher` to create `RequestMatcher` instances.
<2> Configure `HttpSecurity` to only be applied to URLs that start with `/api/`, using `AntPathRequestMatcher` <2> Configure `HttpSecurity` to only be applied to URLs that start with `/api/`, using `AntPathRequestMatcher`
<3> Allow access to URLs that start with `/user/` to users with the `USER` role, using `AntPathRequestMatcher` <3> Allow access to URLs that start with `/api/user/` to users with the `USER` role, using `AntPathRequestMatcher`
<4> Allow access to URLs that start with `/admin/` to users with the `ADMIN` role, using `RegexRequestMatcher` <4> Allow access to URLs that start with `/api/admin/` to users with the `ADMIN` role, using `RegexRequestMatcher`
<5> Allow access to URLs that match the `MyCustomRequestMatcher` to users with the `SUPERVISOR` role, using a custom `RequestMatcher` <5> Allow access to URLs that match the `MyCustomRequestMatcher` to users with the `SUPERVISOR` role, using a custom `RequestMatcher`
== Further Reading == Further Reading