EN
Spring Boot - forward user protocol information via apache2 proxy
4 points
In this article, we would like to show how to configure Apache2 server with Spring Boot Application to forward information about used protocol in current user request (HTTP or HTTPS information forwarding).
Quick solution:
xxxxxxxxxx1
// In the Apache2 VirtualHost:2
3
<VirtualHost *:80>4
...5
RequestHeader set X-Forwarded-Proto http6
...7
8
<VirtualHost *:443>9
...10
RequestHeader set X-Forwarded-Proto https11
...12
13
14
// In the Spring Boot Configuration:15
16
17
public FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter() {18
FilterRegistrationBean<ForwardedHeaderFilter> registration = new FilterRegistrationBean<>(new ForwardedHeaderFilter());19
20
registration.setOrder(Ordered.HIGHEST_PRECEDENCE);21
registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC, DispatcherType.ERROR);22
23
return registration;24
}25
26
27
// In the Spring Boot Controller:28
29
(value = "/example", produces = MediaType.TEXT_PLAIN_VALUE)30
31
public String example(HttpServletRequest request) {32
33
String protocol = request.getScheme(); // will return http or https34
35
// ...36
}
Simple steps:
- be sure that, apache2 forwards protocol information with
X-Forwarded-Protoheader, - create configuration bean in Spring Boot Application.
Note: above configuration was tested under Debina 10, Apache 2.4 and Spring Boot 2.4.
If X-Forwarded-Proto is not supported in apache2 server but we can add it manually. We can do it by setting http in HTTP VirtuaServer and https in HTTPS VirtuaServer.
Check the below files to know what is necessary configure it.
Hint: do not forget to restart server or reload configurations after changes.
/etc/apache2/sites-enabled/my-domain.com.conf file example:
xxxxxxxxxx1
<VirtualHost *:80>2
3
# HTTP mode:4
5
ServerName my-domain.com6
ProxyPreserveHost On7
ProxyPass / http://127.0.0.1:8080/8
ProxyPassReverse / http://127.0.0.1:8080/9
10
RequestHeader set X-Forwarded-Proto http11
12
</VirtualHost>13
14
<VirtualHost *:443>15
16
# HTTP mode:17
18
ServerName my-domain.com19
ProxyPreserveHost On20
ProxyPass / http://127.0.0.1:8080/21
ProxyPassReverse / http://127.0.0.1:8080/22
23
# HTTPS mode:24
25
Protocols h2 http/1.126
27
SSLEngine on28
SSLProtocol all -SSLv3 -TLSv1 -TLSv1.129
SSLCertificateKeyFile "/path/to/private_key.pem"30
SSLCertificateFile "/path/to/certificate.pem"31
32
RequestHeader set X-Forwarded-Proto https33
34
</VirtualHost>
ExampleController.java file example:
xxxxxxxxxx1
package com.example;2
3
import org.springframework.http.MediaType;4
import org.springframework.stereotype.Controller;5
import org.springframework.web.bind.annotation.RequestMapping;6
import org.springframework.web.bind.annotation.RequestMethod;7
import org.springframework.web.bind.annotation.ResponseBody;8
9
import javax.servlet.http.HttpServletRequest;10
11
12
public class ExampleController13
{14
(15
value = "/example",16
method = RequestMethod.GET,17
produces = MediaType.TEXT_PLAIN_VALUE18
)19
20
public String example(HttpServletRequest request) {21
22
String protocol = request.getScheme(); // returns forwarded protocol if set in header23
24
return "used protocol: " + protocol;25
}26
}
SpringConfig.java file example:
xxxxxxxxxx1
package com.example;2
3
import org.springframework.boot.web.servlet.FilterRegistrationBean;4
import org.springframework.context.annotation.Bean;5
import org.springframework.context.annotation.Configuration;6
import org.springframework.core.Ordered;7
import org.springframework.web.filter.ForwardedHeaderFilter;8
9
import javax.servlet.DispatcherType;10
11
12
public class SpringConfig {13
14
15
public FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter() {16
FilterRegistrationBean<ForwardedHeaderFilter> registration = new FilterRegistrationBean<>(new ForwardedHeaderFilter());17
18
registration.setOrder(Ordered.HIGHEST_PRECEDENCE);19
registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC, DispatcherType.ERROR);20
21
return registration;22
}23
}
