EN
Spring Boot 2 - enable encoded slash support in path segments (/ encoding as %2F, e.g. /path/to%2Fendpoint)
4 points
In this short article, we would like to show how in Spring Boot 2 enable encoded slashes support in path segments.
By default, it is not permitted to use %2F in path segments what was described here and here.
From Tomcat documentation:
| Property | Description |
org.apache.tomcat.util.buf. UDecoder.ALLOW_ENCODED_SLASH | If this is true %2F and %5C will be permitted as path delimiters. If not specified, the default value of false will be used. |
Hint: to use
%5Cin URL it is necessary to enable some additional configuration - check this article.
It is necessary to set:
xxxxxxxxxx1
org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=trueIn the below, we use used System.setProperty() to set the above flag:
xxxxxxxxxx1
package example;2
3
import org.springframework.boot.SpringApplication;4
import org.springframework.boot.autoconfigure.SpringBootApplication;5
import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;6
import org.springframework.boot.builder.SpringApplicationBuilder;7
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;8
9
10
public class SpringBootWebApplication extends SpringBootServletInitializer {11
12
13
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {14
return application.sources(SpringBootWebApplication.class);15
}16
17
public static void main(String[] args) throws Exception {18
19
// allows to use %2F in path segments20
//21
System.setProperty("org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH", "true");22
23
SpringApplication.run(SpringBootWebApplication.class, args);24
}25
}It is necessary to add path match configuration:
xxxxxxxxxx1
package example.config;2
3
import org.springframework.context.annotation.Configuration;4
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;5
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;6
import org.springframework.web.util.UrlPathHelper;7
8
9
public class SpringApplicationConfig implements WebMvcConfigurer {10
11
12
public void configurePathMatch(PathMatchConfigurer configurer) {13
14
UrlPathHelper helper = new UrlPathHelper();15
helper.setUrlDecode(false);16
17
configurer.setUrlPathHelper(helper);18
}19
}