Merge pull request #1824 from fl4via/backport-features_2.4.x_2

fl4via · web-flow · commit 20044ab7265f · 2025-10-22T10:50:03.000-03:00
[UNDERTOW-2483 / 2473..2476 / 2495 / 2462 / 2481 / 2485 ] Port changes in UndertowOptions to 2.4.x
diff --git a/core/src/main/java/io/undertow/Undertow.java b/core/src/main/java/io/undertow/Undertow.java
@@ -177,7 +177,7 @@ public synchronized void start() {
                     listenerInfo.add(new ListenerInfo("ajp", server.getLocalAddress(), openListener, null, server));
                 } else {
                     OptionMap undertowOptions = OptionMap.builder().set(UndertowOptions.BUFFER_PIPELINED_DATA, true).addAll(serverOptions).getMap();
-                    boolean http2 = serverOptions.get(UndertowOptions.ENABLE_HTTP2, false);
+                    boolean http2 = serverOptions.get(UndertowOptions.ENABLE_HTTP2, UndertowOptions.DEFAULT_ENABLE_HTTP2);
                     if (listener.type == ListenerType.HTTP) {
                         HttpOpenListener openListener = new HttpOpenListener(buffers, undertowOptions);
                         HttpHandler handler = rootHandler;
diff --git a/core/src/main/java/io/undertow/UndertowOptions.java b/core/src/main/java/io/undertow/UndertowOptions.java
@@ -112,13 +112,18 @@ public class UndertowOptions {
      */
     public static final Option<Integer> MAX_COOKIES = Option.simple(UndertowOptions.class, "MAX_COOKIES", Integer.class);
 
+    /**
+     * Default value of {@link #ALLOW_ENCODED_SLASH} option.
+     */
+    public static final Boolean DEFAULT_ALLOW_ENCODED_SLASH = Boolean.FALSE;
+
     /**
      * If a request comes in with encoded / characters (i.e. %2F), will these be decoded.
      * <p>
      * This can cause security problems if a front end proxy does not perform the same decoding, and as a result
      * this is disabled by default.
      * <p>
-     * Defaults to false
+     * Defaults to {@link #DEFAULT_ALLOW_ENCODED_SLASH}
      * <p>
      * See <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2007-0450">CVE-2007-0450</a>
      * @deprecated - this option was interpreted improperly.
@@ -232,17 +237,30 @@ public class UndertowOptions {
     @Deprecated
     public static final Option<Boolean> ENABLE_SPDY = Option.simple(UndertowOptions.class, "ENABLE_SPDY", Boolean.class);
 
+    /**
+     * Default value of {@link #ENABLE_HTTP2} option.
+     */
+    public static final boolean DEFAULT_ENABLE_HTTP2 = false;
+
     /**
      * If we should attempt to use HTTP2 for HTTPS connections.
+     * <p>
+     * Defaults to {@link #DEFAULT_ENABLE_HTTP2}
      */
     public static final Option<Boolean> ENABLE_HTTP2 = Option.simple(UndertowOptions.class, "ENABLE_HTTP2", Boolean.class);
 
+    /**
+     * Default value of {@link #ENABLE_STATISTICS} option.
+     */
+    public static final boolean DEFAULT_ENABLE_STATISTICS = false;
+
     /**
      * If connector level statistics should be enabled. This has a slight performance impact, but allows statistics such
      * as bytes sent/recevied to be monitored.
      *
      * If this is passed to the client then client statistics will be enabled.
-     *
+     * <p>
+     * Defaults to {@link #DEFAULT_ENABLE_STATISTICS}
      */
     public static final Option<Boolean> ENABLE_STATISTICS = Option.simple(UndertowOptions.class, "ENABLE_STATISTICS", Boolean.class);
 
@@ -251,9 +269,13 @@ public class UndertowOptions {
      * If connector level statistics should be enabled. This has a slight performance impact, but allows statistics such
      * as bytes sent/recevied to be monitored.
      */
-    @Deprecated
+    @Deprecated(forRemoval = true)
     public static final Option<Boolean> ENABLE_CONNECTOR_STATISTICS = ENABLE_STATISTICS;
 
+    /**
+     * Default value of {@link #ALLOW_UNKNOWN_PROTOCOLS} option.
+     */
+    public static final Boolean DEFAULT_ALLOW_UNKNOWN_PROTOCOLS = false;
 
     /**
      * If unknown protocols should be allowed. The known protocols are:
@@ -264,8 +286,8 @@ public class UndertowOptions {
      * HTTP/2.0
      *
      * If this is false then requests that specify any other protocol will be rejected with a 400
-     *
-     * Defaults to false
+     * <p>
+     * Defaults to {@link #DEFAULT_ALLOW_UNKNOWN_PROTOCOLS}
      */
     public static final Option<Boolean> ALLOW_UNKNOWN_PROTOCOLS = Option.simple(UndertowOptions.class, "ALLOW_UNKNOWN_PROTOCOLS", Boolean.class);
 
@@ -292,6 +314,10 @@ public class UndertowOptions {
      *  <br>UNIT: Bytes.
      */
     public static final Option<Integer> HTTP2_SETTINGS_INITIAL_WINDOW_SIZE = Option.simple(UndertowOptions.class, "HTTP2_SETTINGS_INITIAL_WINDOW_SIZE", Integer.class);
+    /**
+     * Default value of {@link #HTTP2_SETTINGS_INITIAL_WINDOW_SIZE}. <br>UNIT: Bytes.
+     */
+    public static final int DEFAULT_HTTP2_SETTINGS_INITIAL_WINDOW_SIZE = 65535;
     /**
      * Max frame size for HTTP2.
      *  <br>UNIT: Bytes.
@@ -303,7 +329,7 @@ public class UndertowOptions {
      *
      * @see #MAX_HEADER_SIZE
      */
-    @Deprecated
+    @Deprecated(forRemoval = true)
     public static final Option<Integer> HTTP2_SETTINGS_MAX_HEADER_LIST_SIZE = Option.simple(UndertowOptions.class, "HTTP2_SETTINGS_MAX_HEADER_LIST_SIZE", Integer.class);
 
     /**
@@ -332,7 +358,14 @@ public class UndertowOptions {
     public static final Option<Integer> MAX_CONCURRENT_REQUESTS_PER_CONNECTION = Option.simple(UndertowOptions.class, "MAX_CONCURRENT_REQUESTS_PER_CONNECTION", Integer.class);
 
     /**
-     * The maximum number of buffers that will be used before reads are paused in framed protocols. Defaults to 10
+     * Default value of {@link #MAX_QUEUED_READ_BUFFERS} option.
+     */
+    public static final int DEFAULT_MAX_QUEUED_READ_BUFFERS = 16;
+
+    /**
+     * The maximum number of buffers that will be used before reads are paused in framed protocols.
+     * <p>
+     * Defaults to {@link #DEFAULT_MAX_QUEUED_READ_BUFFERS}
      */
     public static final Option<Integer> MAX_QUEUED_READ_BUFFERS = Option.simple(UndertowOptions.class, "MAX_QUEUED_READ_BUFFERS", Integer.class);
 
@@ -417,6 +450,9 @@ public class UndertowOptions {
      *
      * If not specified, the default value is null.
      */
+
+    public static final Option<Integer> DEFAULT_QUEUED_FRAMES_LOW_WATER_MARK = null;
+
     public static final Option<String> AJP_ALLOWED_REQUEST_ATTRIBUTES_PATTERN = Option.simple(UndertowOptions.class, "AJP_ALLOWED_REQUEST_ATTRIBUTES_PATTERN", String.class);
 
     /**
diff --git a/core/src/main/java/io/undertow/client/ajp/AjpClientProvider.java b/core/src/main/java/io/undertow/client/ajp/AjpClientProvider.java
@@ -113,7 +113,7 @@ private void handleConnected(StreamConnection connection, ClientCallback<ClientC
 
         final ClientStatisticsImpl clientStatistics;
         //first we set up statistics, if required
-        if (options.get(UndertowOptions.ENABLE_STATISTICS, false)) {
+        if (options.get(UndertowOptions.ENABLE_STATISTICS, UndertowOptions.DEFAULT_ENABLE_STATISTICS)) {
             clientStatistics = new ClientStatisticsImpl();
             connection.getSinkChannel().setConduit(new BytesSentStreamSinkConduit(connection.getSinkChannel().getConduit(), new ByteActivityCallback() {
                 @Override
diff --git a/core/src/main/java/io/undertow/client/http/HttpClientConnection.java b/core/src/main/java/io/undertow/client/http/HttpClientConnection.java
@@ -150,7 +150,7 @@ public void handleEvent(StreamSourceConduit channel) {
     HttpClientConnection(final StreamConnection connection, final OptionMap options, final ByteBufferPool bufferPool) {
 
         //first we set up statistics, if required
-        if(options.get(UndertowOptions.ENABLE_STATISTICS, false)) {
+        if(options.get(UndertowOptions.ENABLE_STATISTICS, UndertowOptions.DEFAULT_ENABLE_STATISTICS)) {
             clientStatistics = new ClientStatisticsImpl();
             connection.getSinkChannel().setConduit(new BytesSentStreamSinkConduit(connection.getSinkChannel().getConduit(), new ByteActivityCallback() {
                 @Override
@@ -358,7 +358,7 @@ public void sendRequest(final ClientRequest request, final ClientCallback<Client
         }
         final HttpClientExchange httpClientExchange = new HttpClientExchange(clientCallback, request, this);
         boolean ssl = this.connection instanceof SslConnection;
-        if(!ssl && !http2Tried && options.get(UndertowOptions.ENABLE_HTTP2, false) && !request.getRequestHeaders().contains(Headers.UPGRADE)) {
+        if(!ssl && !http2Tried && options.get(UndertowOptions.ENABLE_HTTP2, UndertowOptions.DEFAULT_ENABLE_HTTP2) && !request.getRequestHeaders().contains(Headers.UPGRADE)) {
             //this is the first request, as we want to try a HTTP2 upgrade
             request.getRequestHeaders().put(new HttpString("HTTP2-Settings"), Http2ClearClientProvider.createSettingsFrame(options, bufferPool));
             request.getRequestHeaders().put(Headers.UPGRADE, Http2Channel.CLEARTEXT_UPGRADE_STRING);
diff --git a/core/src/main/java/io/undertow/client/http/HttpClientProvider.java b/core/src/main/java/io/undertow/client/http/HttpClientProvider.java
@@ -162,7 +162,7 @@ public void handleEvent(SslConnection connection) {
 
     private void handleConnected(final StreamConnection connection, final ClientCallback<ClientConnection> listener, final ByteBufferPool bufferPool, final OptionMap options, URI uri) {
 
-        boolean h2 = options.get(UndertowOptions.ENABLE_HTTP2, false);
+        boolean h2 = options.get(UndertowOptions.ENABLE_HTTP2, UndertowOptions.DEFAULT_ENABLE_HTTP2);
         if(connection instanceof SslConnection && (h2)) {
             List<ALPNClientSelector.ALPNProtocol> protocolList = new ArrayList<>();
             if(h2) {
diff --git a/core/src/main/java/io/undertow/client/http2/Http2ClearClientProvider.java b/core/src/main/java/io/undertow/client/http2/Http2ClearClientProvider.java
@@ -207,7 +207,7 @@ public void handleEvent(StreamConnection channel) {
 
             final ClientStatisticsImpl clientStatistics;
             //first we set up statistics, if required
-            if (options.get(UndertowOptions.ENABLE_STATISTICS, false)) {
+            if (options.get(UndertowOptions.ENABLE_STATISTICS, UndertowOptions.DEFAULT_ENABLE_STATISTICS)) {
                 clientStatistics = new ClientStatisticsImpl();
                 channel.getSinkChannel().setConduit(new BytesSentStreamSinkConduit(channel.getSinkChannel().getConduit(), new ByteActivityCallback() {
                     @Override
diff --git a/core/src/main/java/io/undertow/client/http2/Http2ClientProvider.java b/core/src/main/java/io/undertow/client/http2/Http2ClientProvider.java
@@ -155,7 +155,7 @@ private static Http2ClientConnection createHttp2Channel(StreamConnection connect
 
         final ClientStatisticsImpl clientStatistics;
         //first we set up statistics, if required
-        if (options.get(UndertowOptions.ENABLE_STATISTICS, false)) {
+        if (options.get(UndertowOptions.ENABLE_STATISTICS, UndertowOptions.DEFAULT_ENABLE_STATISTICS)) {
             clientStatistics = new ClientStatisticsImpl();
             connection.getSinkChannel().setConduit(new BytesSentStreamSinkConduit(connection.getSinkChannel().getConduit(), new ByteActivityCallback() {
                 @Override
diff --git a/core/src/main/java/io/undertow/client/http2/Http2PriorKnowledgeClientProvider.java b/core/src/main/java/io/undertow/client/http2/Http2PriorKnowledgeClientProvider.java
@@ -113,7 +113,7 @@ private void handleConnected(final StreamConnection connection, final ClientCall
 
             final ClientStatisticsImpl clientStatistics;
             //first we set up statistics, if required
-            if (options.get(UndertowOptions.ENABLE_STATISTICS, false)) {
+            if (options.get(UndertowOptions.ENABLE_STATISTICS, UndertowOptions.DEFAULT_ENABLE_STATISTICS)) {
                 clientStatistics = new ClientStatisticsImpl();
                 connection.getSinkChannel().setConduit(new BytesSentStreamSinkConduit(connection.getSinkChannel().getConduit(), new ByteActivityCallback() {
                     @Override
diff --git a/core/src/main/java/io/undertow/protocols/http2/Http2Channel.java b/core/src/main/java/io/undertow/protocols/http2/Http2Channel.java
@@ -145,8 +145,6 @@ public class Http2Channel extends AbstractFramedChannel<Http2Channel, AbstractHt
 
     static final int CONTINUATION_FLAG_END_HEADERS = 0x4;
 
-    public static final int DEFAULT_INITIAL_WINDOW_SIZE = 65535;
-
     static final byte[] PREFACE_BYTES = {
             0x50, 0x52, 0x49, 0x20, 0x2a, 0x20, 0x48, 0x54,
             0x54, 0x50, 0x2f, 0x32, 0x2e, 0x30, 0x0d, 0x0a,
@@ -230,7 +228,7 @@ public class Http2Channel extends AbstractFramedChannel<Http2Channel, AbstractHt
     /**
      * The initial window size for newly created channels, guarded by {@link #flowControlLock}
      */
-    private volatile int initialSendWindowSize = DEFAULT_INITIAL_WINDOW_SIZE;
+    private volatile int initialSendWindowSize = UndertowOptions.DEFAULT_HTTP2_SETTINGS_INITIAL_WINDOW_SIZE;
     /**
      * How much data we can send to the remote endpoint, at the connection level, guarded by {@link #flowControlLock}
      */
@@ -257,7 +255,7 @@ public Http2Channel(StreamConnection connectedStreamChannel, String protocol, By
         streamIdCounter = clientSide ? (fromUpgrade ? 3 : 1) : 2;
 
         pushEnabled = settings.get(UndertowOptions.HTTP2_SETTINGS_ENABLE_PUSH, true);
-        this.initialReceiveWindowSize = settings.get(UndertowOptions.HTTP2_SETTINGS_INITIAL_WINDOW_SIZE, DEFAULT_INITIAL_WINDOW_SIZE);
+        this.initialReceiveWindowSize = settings.get(UndertowOptions.HTTP2_SETTINGS_INITIAL_WINDOW_SIZE, UndertowOptions.DEFAULT_HTTP2_SETTINGS_INITIAL_WINDOW_SIZE);
         this.receiveWindowSize = initialReceiveWindowSize;
         this.receiveMaxConcurrentStreams = settings.get(UndertowOptions.HTTP2_SETTINGS_MAX_CONCURRENT_STREAMS, UndertowOptions.DEFAULT_HTTP2_SETTINGS_MAX_CONCURRENT_STREAMS);
 
diff --git a/core/src/main/java/io/undertow/server/protocol/framed/AbstractFramedChannel.java b/core/src/main/java/io/undertow/server/protocol/framed/AbstractFramedChannel.java
@@ -205,7 +205,7 @@ public void handleEvent(AbstractFramedChannel channel) {
      */
     protected AbstractFramedChannel(final StreamConnection connectedStreamChannel, ByteBufferPool bufferPool, FramePriority<C, R, S> framePriority, final PooledByteBuffer readData, OptionMap settings) {
         this.framePriority = framePriority;
-        this.maxQueuedBuffers = settings.get(UndertowOptions.MAX_QUEUED_READ_BUFFERS, 16);
+        this.maxQueuedBuffers = settings.get(UndertowOptions.MAX_QUEUED_READ_BUFFERS, UndertowOptions.DEFAULT_MAX_QUEUED_READ_BUFFERS);
         this.settings = settings;
         if (readData != null) {
             if(readData.getBuffer().hasRemaining()) {
diff --git a/core/src/main/java/io/undertow/server/protocol/http/HttpReadListener.java b/core/src/main/java/io/undertow/server/protocol/http/HttpReadListener.java
@@ -99,7 +99,7 @@ final class HttpReadListener implements ChannelListener<ConduitStreamSourceChann
         this.maxEntitySize = connection.getUndertowOptions().get(UndertowOptions.MAX_ENTITY_SIZE, UndertowOptions.DEFAULT_MAX_ENTITY_SIZE);
         this.recordRequestStartTime = connection.getUndertowOptions().get(UndertowOptions.RECORD_REQUEST_START_TIME, false);
         this.requireHostHeader = connection.getUndertowOptions().get(UndertowOptions.REQUIRE_HOST_HTTP11, true);
-        this.allowUnknownProtocols = connection.getUndertowOptions().get(UndertowOptions.ALLOW_UNKNOWN_PROTOCOLS, false);
+        this.allowUnknownProtocols = connection.getUndertowOptions().get(UndertowOptions.ALLOW_UNKNOWN_PROTOCOLS, UndertowOptions.DEFAULT_ALLOW_UNKNOWN_PROTOCOLS);
         int requestParseTimeout = connection.getUndertowOptions().get(UndertowOptions.REQUEST_PARSE_TIMEOUT, -1);
         int requestIdleTimeout = connection.getUndertowOptions().get(UndertowOptions.NO_REQUEST_TIMEOUT, -1);
         if(requestIdleTimeout < 0 && requestParseTimeout < 0) {
@@ -272,7 +272,7 @@ public void handleEventWithNoRunningRequest(final ConduitStreamSourceChannel cha
     }
 
     private boolean handleHttp2PriorKnowledge(PooledByteBuffer pooled, HttpServerExchange httpServerExchange) throws IOException {
-        if(httpServerExchange.getRequestMethod().equals(PRI) && connection.getUndertowOptions().get(UndertowOptions.ENABLE_HTTP2, false)) {
+        if(httpServerExchange.getRequestMethod().equals(PRI) && connection.getUndertowOptions().get(UndertowOptions.ENABLE_HTTP2, UndertowOptions.DEFAULT_ENABLE_HTTP2)) {
             handleHttp2PriorKnowledge(connection.getChannel(), connection, pooled);
             return false;
         } else {
diff --git a/core/src/main/java/io/undertow/server/protocol/http2/Http2OpenListener.java b/core/src/main/java/io/undertow/server/protocol/http2/Http2OpenListener.java
@@ -109,7 +109,7 @@ public Http2OpenListener(final ByteBufferPool pool, final OptionMap undertowOpti
         this.bufferSize = buf.getBuffer().remaining();
         buf.close();
         connectorStatistics = new ConnectorStatisticsImpl();
-        statisticsEnabled = undertowOptions.get(UndertowOptions.ENABLE_STATISTICS, false);
+        statisticsEnabled = undertowOptions.get(UndertowOptions.ENABLE_STATISTICS, UndertowOptions.DEFAULT_ENABLE_STATISTICS);
         this.protocol = protocol;
     }
 
diff --git a/core/src/main/java/io/undertow/util/URLUtils.java b/core/src/main/java/io/undertow/util/URLUtils.java
@@ -354,7 +354,7 @@ public static boolean isAbsoluteUrl(String location) {
     }
 
     public static boolean getSlashDecodingFlag(final OptionMap options) {
-        final boolean allowEncodedSlash = options.get(UndertowOptions.ALLOW_ENCODED_SLASH, false);
+        final boolean allowEncodedSlash = options.get(UndertowOptions.ALLOW_ENCODED_SLASH, UndertowOptions.DEFAULT_ALLOW_ENCODED_SLASH);
         final Boolean decodeSlash = options.get(UndertowOptions.DECODE_SLASH);
         return getSlashDecodingFlag(allowEncodedSlash, decodeSlash);
     }
diff --git a/core/src/test/java/io/undertow/server/protocol/http2/HTTP2OnListenerTestCase.java b/core/src/test/java/io/undertow/server/protocol/http2/HTTP2OnListenerTestCase.java
@@ -24,6 +24,7 @@
 
 import org.jboss.logging.Logger;
 import org.junit.Assert;
+import org.junit.Assume;
 import org.junit.Test;
 import org.xnio.IoUtils;
 import org.xnio.OptionMap;
@@ -62,6 +63,8 @@ public class HTTP2OnListenerTestCase {
 
     @Test
     public void testExpectedHTTP2() throws Exception {
+        // FIXME UNDERTOW-2635
+        Assume.assumeFalse(System.getProperty("os.name").equals("Mac OS X"));
         doTest(true);
     }
 
