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

Rename servletPath to basePath

Browse Source 
Closes gh-16765
This commit is contained in:
Josh Cummings 2025-03-21 12:00:43 -06:00
parent c53bf2befe
commit 86599afd43
No known key found for this signature in database
GPG Key ID: 869B37A20E876129
3 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
config/src/test/java/org/springframework/security/config/annotation/web/configurers/AuthorizeHttpRequestsConfigurerTests.java
View File

@ -1364,7 +1364,7 @@ public class AuthorizeHttpRequestsConfigurerTests {
@Bean @Bean
SecurityFilterChain security(HttpSecurity http) throws Exception { SecurityFilterChain security(HttpSecurity http) throws Exception {
PathPatternRequestMatcher.Builder mvc = PathPatternRequestMatcher.withDefaults().servletPath("/mvc"); PathPatternRequestMatcher.Builder mvc = PathPatternRequestMatcher.withDefaults().basePath("/mvc");
// @formatter:off // @formatter:off
http http
.authorizeHttpRequests((authorize) -> authorize .authorizeHttpRequests((authorize) -> authorize

43
web/src/main/java/org/springframework/security/web/servlet/util/matcher/PathPatternRequestMatcher.java
View File

@ -166,15 +166,18 @@ public final class PathPatternRequestMatcher implements RequestMatcher {
* a {@link PathPatternRequestMatcher}. * a {@link PathPatternRequestMatcher}.
* *
* <p> * <p>
* For example, if Spring MVC is deployed to `/mvc` and another servlet to `/other`, * To match a request URI like {@code /app/servlet/my/resource/**} where {@code /app}
* then you can use this builder to do: * is the context path, you can do
* </p> * {@code PathPatternRequestMatcher.withDefaults().matcher("/servlet/my/resource/**")}
* *
* <code> * <p>
* If you have many paths that have a common path prefix, you can use
* {@link #basePath} to reduce repetition like so: <code>
* PathPatternRequestMatcher.Builder mvc = withDefaults().basePath("/mvc");
* http * http
* .authorizeHttpRequests((authorize) -> authorize * .authorizeHttpRequests((authorize) -> authorize
* .requestMatchers(servletPath("/mvc").matcher("/user/**")).hasAuthority("user") * .requestMatchers(mvc.matcher("/user/**")).hasAuthority("user")
* .requestMatchers(servletPath("/other").matcher("/admin/**")).hasAuthority("admin") * .requestMatchers(mvc.matcher("/admin/**")).hasAuthority("admin")
* ) * )
* ... * ...
* </code> * </code>
@ -183,7 +186,7 @@ public final class PathPatternRequestMatcher implements RequestMatcher {
private final PathPatternParser parser; private final PathPatternParser parser;
private final String servletPath; private final String basePath;
Builder() { Builder() {
this(PathPatternParser.defaultInstance); this(PathPatternParser.defaultInstance);
@ -193,22 +196,26 @@ public final class PathPatternRequestMatcher implements RequestMatcher {
this(parser, ""); this(parser, "");
} }
Builder(PathPatternParser parser, String servletPath) { Builder(PathPatternParser parser, String basePath) {
this.parser = parser; this.parser = parser;
this.servletPath = servletPath; this.basePath = basePath;
} }
/** /**
* Match requests starting with this {@code servletPath}. * Match requests starting with this {@code basePath}.
* @param servletPath the servlet path prefix *
* <p>
* Prefixes should be of the form {@code /my/prefix}, starting with a slash, not
* ending in a slash, and not containing and wildcards
* @param basePath the path prefix
* @return the {@link Builder} for more configuration * @return the {@link Builder} for more configuration
*/ */
public Builder servletPath(String servletPath) { public Builder basePath(String basePath) {
Assert.notNull(servletPath, "servletPath cannot be null"); Assert.notNull(basePath, "basePath cannot be null");
Assert.isTrue(servletPath.startsWith("/"), "servletPath must start with '/'"); Assert.isTrue(basePath.startsWith("/"), "basePath must start with '/'");
Assert.isTrue(!servletPath.endsWith("/"), "servletPath must not end with a slash"); Assert.isTrue(!basePath.endsWith("/"), "basePath must not end with a slash");
Assert.isTrue(!servletPath.contains("*"), "servletPath must not contain a star"); Assert.isTrue(!basePath.contains("*"), "basePath must not contain a star");
return new Builder(this.parser, servletPath); return new Builder(this.parser, basePath);
} }
/** /**
@ -279,7 +286,7 @@ public final class PathPatternRequestMatcher implements RequestMatcher {
public PathPatternRequestMatcher matcher(@Nullable HttpMethod method, String path) { public PathPatternRequestMatcher matcher(@Nullable HttpMethod method, String path) {
Assert.notNull(path, "pattern cannot be null"); Assert.notNull(path, "pattern cannot be null");
Assert.isTrue(path.startsWith("/"), "pattern must start with a /"); Assert.isTrue(path.startsWith("/"), "pattern must start with a /");
PathPattern pathPattern = this.parser.parse(this.servletPath + path); PathPattern pathPattern = this.parser.parse(this.basePath + path);
PathPatternRequestMatcher requestMatcher = new PathPatternRequestMatcher(pathPattern); PathPatternRequestMatcher requestMatcher = new PathPatternRequestMatcher(pathPattern);
if (method != null) { if (method != null) {
requestMatcher.setMethod(new HttpMethodRequestMatcher(method)); requestMatcher.setMethod(new HttpMethodRequestMatcher(method));

15
web/src/test/java/org/springframework/security/web/servlet/util/matcher/PathPatternRequestMatcherTests.java
View File

@ -87,8 +87,7 @@ public class PathPatternRequestMatcherTests {
@Test @Test
void matcherWhenServletPathThenMatchesOnlyServletPath() { void matcherWhenServletPathThenMatchesOnlyServletPath() {
PathPatternRequestMatcher.Builder servlet = PathPatternRequestMatcher.withDefaults() PathPatternRequestMatcher.Builder servlet = PathPatternRequestMatcher.withDefaults().basePath("/servlet/path");
.servletPath("/servlet/path");
RequestMatcher matcher = servlet.matcher(HttpMethod.GET, "/endpoint"); RequestMatcher matcher = servlet.matcher(HttpMethod.GET, "/endpoint");
ServletContext servletContext = servletContext("/servlet/path"); ServletContext servletContext = servletContext("/servlet/path");
MockHttpServletRequest mock = get("/servlet/path/endpoint").servletPath("/servlet/path") MockHttpServletRequest mock = get("/servlet/path/endpoint").servletPath("/servlet/path")
@ -114,8 +113,7 @@ public class PathPatternRequestMatcherTests {
@Test @Test
void matcherWhenMultiServletPathThenMatches() { void matcherWhenMultiServletPathThenMatches() {
PathPatternRequestMatcher.Builder servlet = PathPatternRequestMatcher.withDefaults() PathPatternRequestMatcher.Builder servlet = PathPatternRequestMatcher.withDefaults().basePath("/servlet/path");
.servletPath("/servlet/path");
RequestMatcher matcher = servlet.matcher(HttpMethod.GET, "/endpoint"); RequestMatcher matcher = servlet.matcher(HttpMethod.GET, "/endpoint");
MockHttpServletRequest mock = get("/servlet/path/endpoint").servletPath("/servlet/path").buildRequest(null); MockHttpServletRequest mock = get("/servlet/path/endpoint").servletPath("/servlet/path").buildRequest(null);
assertThat(matcher.matches(mock)).isTrue(); assertThat(matcher.matches(mock)).isTrue();
@ -123,8 +121,7 @@ public class PathPatternRequestMatcherTests {
@Test @Test
void matcherWhenMultiContextPathThenMatches() { void matcherWhenMultiContextPathThenMatches() {
PathPatternRequestMatcher.Builder servlet = PathPatternRequestMatcher.withDefaults() PathPatternRequestMatcher.Builder servlet = PathPatternRequestMatcher.withDefaults().basePath("/servlet/path");
.servletPath("/servlet/path");
RequestMatcher matcher = servlet.matcher(HttpMethod.GET, "/endpoint"); RequestMatcher matcher = servlet.matcher(HttpMethod.GET, "/endpoint");
assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> matcher.matches( assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> matcher.matches(
get("/servlet/path/endpoint").servletPath("/servlet/path").contextPath("/app").buildRequest(null))); get("/servlet/path/endpoint").servletPath("/servlet/path").contextPath("/app").buildRequest(null)));
@ -133,11 +130,11 @@ public class PathPatternRequestMatcherTests {
@Test @Test
void servletPathWhenEndsWithSlashOrStarThenIllegalArgument() { void servletPathWhenEndsWithSlashOrStarThenIllegalArgument() {
assertThatExceptionOfType(IllegalArgumentException.class) assertThatExceptionOfType(IllegalArgumentException.class)
.isThrownBy(() -> PathPatternRequestMatcher.withDefaults().servletPath("/path/**")); .isThrownBy(() -> PathPatternRequestMatcher.withDefaults().basePath("/path/**"));
assertThatExceptionOfType(IllegalArgumentException.class) assertThatExceptionOfType(IllegalArgumentException.class)
.isThrownBy(() -> PathPatternRequestMatcher.withDefaults().servletPath("/path/*")); .isThrownBy(() -> PathPatternRequestMatcher.withDefaults().basePath("/path/*"));
assertThatExceptionOfType(IllegalArgumentException.class) assertThatExceptionOfType(IllegalArgumentException.class)
.isThrownBy(() -> PathPatternRequestMatcher.withDefaults().servletPath("/path/")); .isThrownBy(() -> PathPatternRequestMatcher.withDefaults().basePath("/path/"));
} }
MockHttpServletRequest request(String uri) { MockHttpServletRequest request(String uri) {