infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-01-28 20:18:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
jdk/src/java.net.http/share/classes/module-info.java
Volkan Yazici cbbb0a8630 8367976: Validate and clamp jdk.httpclient.bufsize 
Reviewed-by: dfuchs
2025-10-22 11:20:43 +00:00

293 lines
16 KiB
Java
Raw Blame History

/*
* Copyright (c) 2015, 2025, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* Defines the HTTP Client and WebSocket APIs.
* <p>
* <b id="httpclientprops">System properties used by the java.net.http API</b>
* <p>
* The following is a list of system networking properties used by the java.net.http
* client implementation in the JDK. Any properties below that take a numeric value
* assume the default value if given a string that does not parse as a number.
* Unless otherwise specified below, all values can be set in the {@code conf/net.properties}
* file. In all cases, values can be specified as system properties on the command line,
* in which case, any value in {@code conf/net.properties} is overridden. No guarantee is
* provided that property values can be set programatically with {@code System.setProperty()}.
* Other implementations of this API may choose not to support these properties.
* <ul>
* <li><p><b>{@systemProperty jdk.httpclient.allowRestrictedHeaders}</b> (default: see below)<br>
* A comma-separated list of normally restricted HTTP header names that users may set in HTTP
* requests or by user code in HttpRequest instances. By default, the following request
* headers are not allowed to be set by user code: connection, content-length, expect, host,
* and upgrade. You can override this behavior with this property. The names are case-insensitive
* and whitespace is ignored. Note that this property is intended for testing and not for
* real-world deployments. Protocol errors or other undefined behavior are likely to occur
* when using this property. There may be other headers that are restricted from being set
* depending on the context. These restrictions cannot be overridden by this property.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.bufsize}</b> (default: 16384 bytes or 16 kB)<br>
* The capacity of internal ephemeral buffers allocated to pass data to and from the
* client, in bytes. Valid values are in the range [1, 2^14 (16384)].
* If an invalid value is provided, the default value is used.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.connectionPoolSize}</b> (default: 0)<br>
* The maximum number of connections to keep in the HTTP/1.1 keep alive cache. A value of 0
* means that the cache is unbounded.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.connectionWindowSize}</b> (default: 2^26)<br>
* The HTTP/2 client connection window size in bytes. Valid values are in the range
* [2^16-1, 2^31-1]. If an invalid value is provided, the default value is used.
* The implementation guarantees that the actual value will be no smaller than the stream
* window size, which can be configured through the {@code jdk.httpclient.windowsize}
* system property.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.disableRetryConnect}</b> (default: false)<br>
* Whether automatic retry of connection failures is disabled. If false, then retries are
* attempted (subject to the retry limit).
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.enableAllMethodRetry}</b> (default: false)<br>
* Whether it is permitted to automatically retry non-idempotent HTTP requests.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.enablepush}</b> (default: 1)<br>
* Whether HTTP/2 push promise is enabled. A value of 1 enables push promise; a value of 0
* disables it.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.hpack.maxheadertablesize}</b> (default: 16384 or
* 16 kB)<br> The HTTP/2 client maximum HPACK header table size in bytes.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.qpack.decoderMaxTableCapacity}</b> (default: 0)
* <br> The HTTP/3 client maximum QPACK decoder dynamic header table size in bytes.
* <br> Setting this value to a positive number will allow HTTP/3 servers to add entries
* to the QPack decoder's dynamic table. When set to 0, servers are not permitted to add
* entries to the client's QPack encoder's dynamic table.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.qpack.encoderTableCapacityLimit}</b> (default: 4096,
* or 4 kB)
* <br> The HTTP/3 client maximum QPACK encoder dynamic header table size in bytes.
* <br> Setting this value to a positive number allows the HTTP/3 client's QPack encoder to
* add entries to the server's QPack decoder's dynamic table, if the server permits it.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.HttpClient.log}</b> (default: none)<br>
* Enables high-level logging of various events through the {@linkplain java.lang.System.Logger
* Platform Logging API}. The value contains a comma-separated list of any of the
* following items:
* <ul>
* <li>errors</li>
* <li>requests</li>
* <li>headers</li>
* <li>content</li>
* <li>frames</li>
* <li>ssl</li>
* <li>trace</li>
* <li>channel</li>
* <li>http3</li>
* <li>quic</li>
* </ul><br>
* You can append the frames item with a colon-separated list of any of the following items:
* <ul>
* <li>control</li>
* <li>data</li>
* <li>window</li>
* <li>all</li>
* </ul><br>
* You can append the quic item with a colon-separated list of any of the following items;
* packets are logged in an abridged form that only shows frames offset and length,
* but not content:
* <ul>
* <li>ack: packets containing ack frames will be logged</li>
* <li>cc: information on congestion control will be logged</li>
* <li>control: packets containing quic controls (such as frames affecting
* flow control, or frames opening or closing streams)
* will be logged</li>
* <li>crypto: packets containing crypto frames will be logged</li>
* <li>data: packets containing stream frames will be logged</li>
* <li>dbb: information on direct byte buffer usage will be logged</li>
* <li>ping: packets containing ping frames will be logged</li>
* <li>processed: information on flow control (processed bytes) will be logged</li>
* <li>retransmit: information on packet loss and recovery will be logged</li>
* <li>timer: information on send task scheduling will be logged</li>
* <li>all</li>
* </ul><br>
* Specifying an item adds it to the HTTP client's log. For example, if you specify the
* following value, then the Platform Logging API logs all possible HTTP Client events:<br>
* "errors,requests,headers,frames:control:data:window,ssl,trace,channel"<br>
* Note that you can replace control:data:window with all. The name of the logger is
* "jdk.httpclient.HttpClient", and all logging is at level INFO.
* To debug issues with the quic protocol a good starting point is to specify
* {@code quic:control:retransmit}.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.keepalive.timeout}</b> (default: 30)<br>
* The number of seconds to keep idle HTTP connections alive in the keep alive cache.
* By default this property applies to HTTP/1.1, HTTP/2 and HTTP/3.
* The value for HTTP/2 and HTTP/3 can be overridden with the
* {@code jdk.httpclient.keepalive.timeout.h2} and {@code jdk.httpclient.keepalive.timeout.h3}
* properties respectively. The value specified for HTTP/2 acts as default value for HTTP/3.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.keepalive.timeout.h2}</b> (default: see
* below)<br>The number of seconds to keep idle HTTP/2 connections alive. If not set, then the
* {@code jdk.httpclient.keepalive.timeout} setting is used.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.keepalive.timeout.h3}</b> (default: see
* below)<br>The number of seconds to keep idle HTTP/3 connections alive. If not set, then the
* {@code jdk.httpclient.keepalive.timeout.h2} setting is used.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.maxframesize}</b> (default: 16384 or 16kB)<br>
* The HTTP/2 client maximum frame size in bytes. The server is not permitted to send a frame
* larger than this.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.maxLiteralWithIndexing}</b> (default: 512)<br>
* The maximum number of header field lines (header name and value pairs) that a
* client is willing to add to the HPack or QPACK Decoder dynamic table during the decoding
* of an entire header field section.
* This is purely an implementation limit.
* If a peer sends a field section or a set of QPACK instructions with encoding that
* exceeds this limit a {@link java.net.ProtocolException ProtocolException} will be raised.
* A value of zero or a negative value means no limit.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.maxNonFinalResponses}</b> (default: 8)<br>
* The maximum number of interim (non-final) responses that a client is prepared
* to accept on a request-response stream before the final response is received.
* Interim responses are responses with a status in the range [100, 199] inclusive.
* This is purely an implementation limit.
* If a peer sends a number of interim response that exceeds this limit before
* sending the final response, a {@link java.net.ProtocolException ProtocolException}
* will be raised.
* A value of zero or a negative value means no limit.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.maxstreams}</b> (default: 100)<br>
* The maximum number of HTTP/2 or HTTP/3 push streams that the client will permit servers to open
* simultaneously.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.receiveBufferSize}</b> (default: operating system
* default)<br>The HTTP client {@linkplain java.nio.channels.SocketChannel socket}
* {@linkplain java.net.StandardSocketOptions#SO_RCVBUF receive buffer size} in bytes.
* Values less than or equal to zero are ignored.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.redirects.retrylimit}</b> (default: 5)<br>
* The maximum number of attempts to send a HTTP request when redirected or any failure occurs
* for any reason.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.websocket.writeBufferSize}</b> (default: 16384
* or 16kB)<br>The buffer size used by the web socket implementation for socket writes.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.windowsize}</b> (default: 16777216 or 16 MB)<br>
* The HTTP/2 client stream window size in bytes. Valid values are in the range [2^14, 2^31-1].
* If an invalid value is provided, the default value is used.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.auth.retrylimit}</b> (default: 3)<br>
* The number of attempts the Basic authentication filter will attempt to retry a failed
* authentication. The number of authentication attempts is always one greater than the
* retry limit, as the initial request does not count toward the retries.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.sendBufferSize}</b> (default: operating system
* default)<br>The HTTP client {@linkplain java.nio.channels.SocketChannel socket}
* {@linkplain java.net.StandardSocketOptions#SO_SNDBUF send buffer size} in bytes.
* Values less than or equal to zero are ignored.
* </li>
* <li><p><b>{@systemProperty jdk.internal.httpclient.disableHostnameVerification}</b> (default:
* false)<br>If true (or set to an empty string), hostname verification in SSL certificates
* is disabled. This is a system property only and not available in {@code conf/net.properties}.
* It is provided for testing purposes only.
* </li>
* <li><p><b>{@systemProperty jdk.http.auth.proxying.disabledSchemes}</b> (default: see
* conf/net.properties)<br>A comma separated list of HTTP authentication scheme names,
* that are disallowed for use by the HTTP client implementation, for HTTP proxying.
* </li>
* <li><p><b>{@systemProperty jdk.http.auth.tunneling.disabledSchemes}</b> (default: see
* conf/net.properties)<br>A comma separated list of HTTP authentication scheme names, that
* are disallowed for use by the HTTP client implementation, for HTTP CONNECT tunneling.
* </li>
* <li><p><b>{@systemProperty jdk.http.maxHeaderSize}</b> (default: 393216 or 384kB)
* <br>The maximum header field section size that the client is prepared to accept.
* This is computed as the sum of the size of the uncompressed header name, plus
* the size of the uncompressed header value, plus an overhead of 32 bytes for
* each field section line. If a peer sends a field section that exceeds this
* size a {@link java.net.ProtocolException ProtocolException} will be raised.
* This applies to all versions of the protocol. A value of zero or a negative
* value means no limit.
* </li>
* </ul>
* <p>
* The following system properties can be used to configure some aspects of the
* <a href="https://www.rfc-editor.org/info/rfc9000">QUIC Protocol</a>
* implementation used for HTTP/3:
* <ul>
* <li><p><b>{@systemProperty jdk.httpclient.quic.receiveBufferSize}</b> (default: operating system
* default)<br>The QUIC {@linkplain java.nio.channels.DatagramChannel UDP client socket}
* {@linkplain java.net.StandardSocketOptions#SO_RCVBUF receive buffer size} in bytes.
* Values less than or equal to zero are ignored.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.quic.sendBufferSize}</b> (default: operating system
* default)<br>The QUIC {@linkplain java.nio.channels.DatagramChannel UDP client socket}
* {@linkplain java.net.StandardSocketOptions#SO_SNDBUF send buffer size} in bytes.
* Values less than or equal to zero are ignored.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.quic.defaultMTU}</b> (default: 1200 bytes)<br>
* The default Maximum Transmission Unit (MTU) size that will be used on quic connections.
* The default implementation of the HTTP/3 client does not implement Path MTU Detection,
* but will attempt to send 1-RTT packets up to the size defined by this property.
* Specifying a higher value may give better upload performance when the client and
* servers are located on the same machine, but is likely to result in irrecoverable
* packet loss if used over the network. Allowed values are in the range [1200, 65527].
* If an out-of-range value is specified, the minimum default value will be used.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.quic.maxBytesInFlight}</b> (default:
* 16777216 bytes or 16MB)<br>
* This is the maximum number of unacknowledged bytes that the quic congestion
* controller allows to be in flight. When this amount is reached, no new
* data is sent until some of the packets in flight are acknowledged.
* <br>
* Allowed values are in the range [2^14, 2^24] (or [16kB, 16MB]).
* If an out-of-range value is specified, it will be clamped to the closest
* value in range.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.quic.maxInitialData}</b> (default: 15728640
* bytes, or 15MB)<br>
* The initial flow control limit for quic connections in bytes. Valid values are in
* the range [0, 2^60]. The initial limit is also used to initialize the receive window
* size. If less than 16kB, the window size will be set to 16kB.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.quic.maxStreamInitialData}</b> (default: 6291456
* bytes, or 6MB)<br>
* The initial flow control limit for quic streams in bytes. Valid values are in
* the range [0, 2^60]. The initial limit is also used to initialize the receive window
* size. If less than 16kB, the window size will be set to 16kB.
* </li>
* <li><p><b>{@systemProperty jdk.httpclient.quic.maxInitialTimeout}</b> (default: 30
* seconds)<br>
* This is the maximum time, in seconds, during which the client will wait for a
* response from the server, and continue retransmitting the first Quic INITIAL packet,
* before raising a {@link java.net.ConnectException}. The first INITIAL packet received
* from the target server will disarm this timeout.
* </li>
*
* </ul>
* @moduleGraph
* @since 11
*/
module java.net.http {
exports java.net.http;
}
Reference in New Issue View Git Blame Copy Permalink