1. Request confidentiality in the deployment descriptor
The first way is based on the Servlet specification. You need to specify which URLs should be protected in the web.xml deployment descriptor. It's the same approach as the one used for specifying which URLs require authentication/authorization. Just instead of requesting an assigned role, you request a transport-guarantee.
Sample content of the WEB-INF/web.xml
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<security-constraint>
<web-resource-collection>
<web-resource-name>All confidential</web-resource-name>
<url-pattern>/*</url-pattern>
</web-resource-collection>
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>
</web-app>
As we used the /* URL pattern, all the URLs will request switching from http to https.
2. Request the redirect from Undertow handler in your application
The second approach is similar to the first one. It also depends on the configuration file within the application. Instead of using a Java EE specification, it employs Undertow features. Undertow web server is one of the core components in the WildFly. This approach is lacking detailed description in the WildFly/EAP documentation, but the great starting point is Undertow documentation itself - section Predicates Attributes and Handlers.
What we want to do is to define a handler (a rule) which will all incoming requests having scheme==http redirect to the same URL but with the https scheme used.
So let's simply define the configuration file with the rule WEB-INF/undertow-handlers.conf:
equals(%{SCHEME},"http") -> redirect(https://%v:8443%U%q)
The left equals(...) part is a predicate and the right redirect(...) part is a handler. String templates starting with the percent sign % are called exchange attributes. They may have a long or a short form:
%{LOCAL_SERVER_NAME} %v Local server name
%{REQUEST_URL} %U Requested URL path
%{QUERY_STRING} %q Query string (prepended with a '?' if it exists,
otherwise an empty string)
%{SCHEME} Request scheme
Some attributes (e.g. %{SCHEME}) are missing in the documentation, you can find them in the code or in the JavaDoc.
As you can see, there is a small disadvantage of this solution. We have to know the https port mapping upfront.
3. Request redirect in the Undertow subsystem
Sometime you may want to have HTTPs used for all the applications. In such cases use the way of configuring the Undertow subsystem within the WildFly configuration. The method is the same as in point 2, just the place where the predicates and handlers (rules) is defined is a different one. The Undertow subsystem in WildFly provides a model for the build-in predicates and handlers. You may use the following JBoss CLI commands:
/subsystem=undertow/configuration=filter/rewrite=http-to-https:add( \
redirect=true, \
target="https://%{LOCAL_SERVER_NAME}:${jboss.https.port:8443}%{REQUEST_URL}%{QUERY_STRING}")
/subsystem=undertow/server=default-server/host=default-host/filter-ref=http-to-https:add( \
predicate="equals(%{SCHEME},http)")
So we specified the new rewrite handler with redirect=true. Then we mapped this handler in a new filter-ref resource using it just for requests matching the given predicate.
And that's it. This time we simply resolved the "whats-the-port" issue by using the default https port expression in Wildfly - ${jboss.https.port:8443}.
Bonus - Nginx proxy
Sometime you may want to use another web server. Then you can proxy requests to the WildFly and solve HTTPs redirects completely out of WildFly. Sample config in the Nginx:
server {
listen 80 default_server;
listen [::]:80 default_server;
server_name _;
return 301 https://$host$request_uri;
}
server {
listen 443 ssl;
server_name my-server.my-company.com;
server_tokens off;
location / {
proxy_pass http://127.0.0.1:8080/;
...
}
...
}
Komentáře