Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix breaking change due to Jetty / Servlet API URI compliance enforcement #683

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Fix breaking change due to Jetty / Servlet API URI compliance enforcement #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions alpine-executable-war/src/main/java/alpine/embedded/EmbeddedJettyServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
package alpine.embedded;

import org.eclipse.jetty.ee10.servlet.ErrorPageErrorHandler;
import org.eclipse.jetty.ee10.servlet.ServletHandler;
import org.eclipse.jetty.ee10.webapp.WebAppContext;
import org.eclipse.jetty.http.UriCompliance;
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.HttpConfiguration;
import org.eclipse.jetty.server.HttpConnectionFactory;
Expand Down Expand Up @@ -73,6 +75,20 @@ public static void main(final String[] args) throws Exception {
final HttpConfiguration httpConfig = new HttpConfiguration();
httpConfig.addCustomizer( new org.eclipse.jetty.server.ForwardedRequestCustomizer() ); // Add support for X-Forwarded headers

// Enable legacy (mimicking Jetty 9) URI compliance.
// This is required to allow URL encoding in path segments, e.g. "/foo/bar%2Fbaz".
// https://github.com/jetty/jetty.project/issues/12162
// https://github.com/jetty/jetty.project/issues/11448
// https://jetty.org/docs/jetty/12/programming-guide/server/compliance.html#uri
//
// NB: The setting on its own is not sufficient. Decoding of ambiguous URIs
// must additionally be enabled in the servlet handler. This can only be done
// after the server is started, further down below.
//
// TODO: Remove this for the next major version bump. Since we're going against Servlet API
// here, the only viable long-term solution is to adapt REST APIs to follow Servlet API 6 spec.
httpConfig.setUriCompliance(UriCompliance.LEGACY);

final HttpConnectionFactory connectionFactory = new HttpConnectionFactory( httpConfig );
final ServerConnector connector = new ServerConnector(server, connectionFactory);
connector.setHost(host);
Expand Down Expand Up @@ -113,6 +129,10 @@ public static void main(final String[] args) throws Exception {
server.addBean(new ErrorHandler());
try {
server.start();
for (final ServletHandler handler : server.getContainedBeans(ServletHandler.class)) {
LOGGER.debug("Enabling decoding of ambiguous URIs for servlet handler: {}", handler.getClass().getName());
handler.setDecodeAmbiguousURIs(true);
}
addJettyShutdownHook(server);
server.join();
} catch (Exception e) {
Expand Down