undefect. CWE-407 — 63 sites patched across 27 ecosystems
Authors: russell@unturf.com · brackishbert@gmail.com · foxhop.net · TimeHexOn.com Patches, unit tests, benchmarks, whitepaper, and outreach briefs. Public domain — no copyright claimed. Use freely.
This commit is contained in:
commit
0a580b313d
70422 changed files with 17213626 additions and 0 deletions
467
test/jdk/java/net/httpclient/HttpClientClose.java
Normal file
467
test/jdk/java/net/httpclient/HttpClientClose.java
Normal file
|
|
@ -0,0 +1,467 @@
|
|||
/*
|
||||
* Copyright (c) 2023, 2026, 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.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/*
|
||||
* @test
|
||||
* @bug 8267140
|
||||
* @summary Test for HttpClient::close. Any running operation should
|
||||
* succeed and the client should eventually exit.
|
||||
* This test tests close, awaitTermination, and
|
||||
* isTerminated.
|
||||
* @library /test/lib /test/jdk/java/net/httpclient/lib
|
||||
* @build jdk.httpclient.test.lib.http2.Http2TestServer jdk.test.lib.net.SimpleSSLContext
|
||||
* ReferenceTracker
|
||||
* @run junit/othervm
|
||||
* -Djdk.internal.httpclient.debug=true
|
||||
* -Djdk.httpclient.HttpClient.log=trace,headers,requests
|
||||
* HttpClientClose
|
||||
*/
|
||||
// -Djdk.internal.httpclient.debug=true
|
||||
|
||||
import java.io.Closeable;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.io.OutputStream;
|
||||
import java.io.UncheckedIOException;
|
||||
import java.net.URI;
|
||||
import java.net.http.HttpClient;
|
||||
import java.net.http.HttpClient.Redirect;
|
||||
import java.net.http.HttpClient.Version;
|
||||
import java.net.http.HttpRequest;
|
||||
import java.net.http.HttpOption.Http3DiscoveryMode;
|
||||
import java.net.http.HttpResponse;
|
||||
import java.net.http.HttpResponse.BodyHandlers;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Random;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
import java.util.concurrent.Flow.Publisher;
|
||||
import java.util.concurrent.Flow.Subscriber;
|
||||
import java.util.concurrent.Flow.Subscription;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.concurrent.atomic.AtomicLong;
|
||||
|
||||
import jdk.httpclient.test.lib.common.HttpServerAdapters;
|
||||
import javax.net.ssl.SSLContext;
|
||||
|
||||
import jdk.test.lib.RandomFactory;
|
||||
import jdk.test.lib.net.SimpleSSLContext;
|
||||
|
||||
import static java.lang.System.out;
|
||||
import static java.net.http.HttpClient.Builder.NO_PROXY;
|
||||
import static java.net.http.HttpClient.Version.HTTP_1_1;
|
||||
import static java.net.http.HttpClient.Version.HTTP_2;
|
||||
import static java.net.http.HttpClient.Version.HTTP_3;
|
||||
import static java.net.http.HttpOption.Http3DiscoveryMode.ALT_SVC;
|
||||
import static java.net.http.HttpOption.Http3DiscoveryMode.HTTP_3_URI_ONLY;
|
||||
import static java.net.http.HttpOption.H3_DISCOVERY;
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
|
||||
import org.junit.jupiter.api.AfterAll;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
import org.junit.jupiter.api.BeforeAll;
|
||||
import org.junit.jupiter.params.ParameterizedTest;
|
||||
import org.junit.jupiter.params.provider.MethodSource;
|
||||
|
||||
public class HttpClientClose implements HttpServerAdapters {
|
||||
|
||||
static {
|
||||
HttpServerAdapters.enableServerLogging();
|
||||
}
|
||||
static final Random RANDOM = RandomFactory.getRandom();
|
||||
|
||||
private static ExecutorService readerService;
|
||||
private static final SSLContext sslContext = SimpleSSLContext.findSSLContext();
|
||||
private static HttpTestServer httpTestServer; // HTTP/1.1 [ 4 servers ]
|
||||
private static HttpTestServer httpsTestServer; // HTTPS/1.1
|
||||
private static HttpTestServer http2TestServer; // HTTP/2 ( h2c )
|
||||
private static HttpTestServer https2TestServer; // HTTP/2 ( h2 )
|
||||
private static HttpTestServer h2h3TestServer; // HTTP/3 ( h2 + h3 )
|
||||
private static HttpTestServer h3TestServer; // HTTP/3 ( h3 )
|
||||
private static String httpURI;
|
||||
private static String httpsURI;
|
||||
private static String http2URI;
|
||||
private static String https2URI;
|
||||
private static String h2h3URI;
|
||||
private static String h2h3Head;
|
||||
private static String h3URI;
|
||||
|
||||
static final String MESSAGE = "HttpClientClose message body";
|
||||
static final int ITERATIONS = 3;
|
||||
|
||||
public static Object[][] positive() {
|
||||
return new Object[][] {
|
||||
{ h2h3URI, HTTP_3, h2h3TestServer.h3DiscoveryConfig()},
|
||||
{ h3URI, HTTP_3, h3TestServer.h3DiscoveryConfig()},
|
||||
{ httpURI, HTTP_1_1, ALT_SVC}, // do not attempt HTTP/3
|
||||
{ httpsURI, HTTP_1_1, ALT_SVC}, // do not attempt HTTP/3
|
||||
{ http2URI, HTTP_2, ALT_SVC}, // do not attempt HTTP/3
|
||||
{ https2URI, HTTP_2, ALT_SVC}, // do not attempt HTTP/3
|
||||
};
|
||||
}
|
||||
|
||||
static final AtomicLong requestCounter = new AtomicLong();
|
||||
private static final ReferenceTracker TRACKER = ReferenceTracker.INSTANCE;
|
||||
|
||||
static String readBody(InputStream body) {
|
||||
try (InputStream in = body) {
|
||||
return new String(in.readAllBytes(), StandardCharsets.UTF_8);
|
||||
} catch (IOException io) {
|
||||
throw new UncheckedIOException(io);
|
||||
}
|
||||
}
|
||||
|
||||
private record CancellingSubscriber<U>(ExchangeResult<?> result)
|
||||
implements Subscriber<U> {
|
||||
@Override
|
||||
public void onSubscribe(Subscription subscription) {
|
||||
out.printf("%s: cancelling subscription", result.step());
|
||||
subscription.cancel();
|
||||
}
|
||||
@Override
|
||||
public void onNext(U item) {}
|
||||
@Override
|
||||
public void onError(Throwable throwable) {}
|
||||
@Override
|
||||
public void onComplete() {}
|
||||
}
|
||||
|
||||
private static <U> void ensureClosed(ExchangeResult<U> result) {
|
||||
var response = result.response;
|
||||
if (response == null) return;
|
||||
var body = response.body();
|
||||
try {
|
||||
if (body instanceof Closeable cl) {
|
||||
cl.close();
|
||||
} else if (body instanceof Publisher<?> pub) {
|
||||
pub.subscribe(new CancellingSubscriber<Object>(result));
|
||||
}
|
||||
} catch (IOException io) {
|
||||
out.printf("%s: Failed to close body: %s", result.step(), io);
|
||||
io.printStackTrace(out);
|
||||
}
|
||||
}
|
||||
|
||||
record ExchangeResult<T>(int step,
|
||||
Version version,
|
||||
Http3DiscoveryMode config,
|
||||
HttpResponse<T> response,
|
||||
boolean firstVersionMayNotMatch) {
|
||||
|
||||
static <U> ExchangeResult<U> afterHead(int step, Version version, Http3DiscoveryMode config) {
|
||||
return new ExchangeResult<>(step, version, config, null, false);
|
||||
}
|
||||
|
||||
static <U> ExchangeResult<U> ofSequential(int step, Version version, Http3DiscoveryMode config) {
|
||||
return new ExchangeResult<>(step, version, config, null, true);
|
||||
}
|
||||
|
||||
ExchangeResult<T> withResponse(HttpResponse<T> response) {
|
||||
return new ExchangeResult<>(step(), version(), config(), response, firstVersionMayNotMatch());
|
||||
}
|
||||
|
||||
// Ensures that the input stream gets closed in case of assertion
|
||||
ExchangeResult<T> assertResponseState() {
|
||||
out.println(step + ": Got response: " + response);
|
||||
try {
|
||||
out.printf("%s: expect status 200 and version %s (%s) for %s%n", step, version, config,
|
||||
response.request().uri());
|
||||
assertEquals(200, response.statusCode());
|
||||
if (step == 0 && version == HTTP_3 && firstVersionMayNotMatch) {
|
||||
out.printf("%s: version not checked%n", step);
|
||||
} else {
|
||||
assertEquals(version, response.version());
|
||||
out.printf("%s: got expected version %s%n", step, response.version());
|
||||
}
|
||||
} catch (AssertionError error) {
|
||||
out.printf("%s: Closing body due to assertion - %s", step, error);
|
||||
ensureClosed(this);
|
||||
throw error;
|
||||
}
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
static String readBody(int i, HttpResponse<InputStream> resp) {
|
||||
try (var in = resp.body()) {
|
||||
out.println(i + ": reading body for " + resp.request().uri());
|
||||
var body = new String(in.readAllBytes(), StandardCharsets.UTF_8);
|
||||
out.println(i + ": got body " + body);
|
||||
return body;
|
||||
} catch (IOException io) {
|
||||
out.println(i + ": failed to read body");
|
||||
throw new UncheckedIOException(io);
|
||||
}
|
||||
}
|
||||
|
||||
void headRequest(HttpClient client) throws Exception {
|
||||
HttpRequest request = HttpRequest.newBuilder(URI.create(h2h3Head))
|
||||
.version(HTTP_2)
|
||||
.HEAD()
|
||||
.build();
|
||||
var resp = client.send(request, BodyHandlers.discarding());
|
||||
assertEquals(200, resp.statusCode());
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@MethodSource("positive")
|
||||
void testConcurrent(String uriString, Version version, Http3DiscoveryMode config) throws Exception {
|
||||
out.printf("%n---- starting concurrent (%s, %s, %s) ----%n%n", uriString, version, config);
|
||||
Throwable failed = null;
|
||||
HttpClient toCheck = null;
|
||||
List<CompletableFuture<String>> bodies = new ArrayList<>();
|
||||
try (HttpClient client = toCheck = newClientBuilderForH3()
|
||||
.proxy(NO_PROXY)
|
||||
.followRedirects(Redirect.ALWAYS)
|
||||
.version(version == HTTP_1_1 ? HTTP_2 : version)
|
||||
.sslContext(sslContext)
|
||||
.build()) {
|
||||
TRACKER.track(client);
|
||||
|
||||
if (version == HTTP_3 && config != HTTP_3_URI_ONLY) {
|
||||
headRequest(client);
|
||||
}
|
||||
|
||||
for (int i = 0; i < ITERATIONS; i++) {
|
||||
URI uri = URI.create(uriString + "/concurrent/iteration-" + i);
|
||||
HttpRequest request = HttpRequest.newBuilder(uri)
|
||||
.header("X-uuid", "uuid-" + requestCounter.incrementAndGet())
|
||||
.setOption(H3_DISCOVERY, config)
|
||||
.build();
|
||||
out.printf("Iteration %d request: %s%n", i, request.uri());
|
||||
CompletableFuture<HttpResponse<InputStream>> responseCF;
|
||||
CompletableFuture<String> bodyCF;
|
||||
final int si = i;
|
||||
ExchangeResult<InputStream> result = ExchangeResult.afterHead(i, version, config);
|
||||
responseCF = client.sendAsync(request, BodyHandlers.ofInputStream())
|
||||
.thenApply(result::withResponse)
|
||||
.thenApplyAsync(ExchangeResult::assertResponseState, readerService)
|
||||
.thenApply(ExchangeResult::response);
|
||||
bodyCF = responseCF
|
||||
.thenApplyAsync((resp) -> readBody(si, resp), readerService)
|
||||
.thenApply((s) -> {
|
||||
assertEquals(MESSAGE, s);
|
||||
return s;
|
||||
});
|
||||
long sleep = RANDOM.nextLong(5);
|
||||
if (sleep > 0) {
|
||||
out.printf("%d: sleeping %d ms%n", i, sleep);
|
||||
Thread.sleep(sleep);
|
||||
}
|
||||
var cf = bodyCF;
|
||||
bodies.add(cf);
|
||||
}
|
||||
}
|
||||
assertTrue(toCheck.isTerminated());
|
||||
|
||||
// Ensure all CF are eventually completed
|
||||
out.printf("waiting for requests to complete%n");
|
||||
CompletableFuture.allOf(bodies.toArray(new CompletableFuture<?>[0])).get();
|
||||
out.printf("all requests completed%n");
|
||||
out.printf("%n---- end concurrent (%s, %s, %s): %s ----%n",
|
||||
uriString, version, config,
|
||||
failed == null ? "done" : failed.toString());
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@MethodSource("positive")
|
||||
void testSequential(String uriString, Version version, Http3DiscoveryMode config) throws Exception {
|
||||
out.printf("%n---- starting sequential (%s, %s, %s) ----%n%n", uriString, version, config);
|
||||
Throwable failed = null;
|
||||
HttpClient toCheck = null;
|
||||
try (HttpClient client = toCheck = newClientBuilderForH3()
|
||||
.proxy(NO_PROXY)
|
||||
.followRedirects(Redirect.ALWAYS)
|
||||
.version(version == HTTP_1_1 ? HTTP_2 : version)
|
||||
.sslContext(sslContext)
|
||||
.build()) {
|
||||
TRACKER.track(client);
|
||||
|
||||
for (int i = 0; i < ITERATIONS; i++) {
|
||||
URI uri = URI.create(uriString + "/sequential/iteration-" + i);
|
||||
HttpRequest request = HttpRequest.newBuilder(uri)
|
||||
.header("X-uuid", "uuid-" + requestCounter.incrementAndGet())
|
||||
.setOption(H3_DISCOVERY, config)
|
||||
.build();
|
||||
out.printf("Iteration %d request: %s%n", i, request.uri());
|
||||
final int si = i;
|
||||
ExchangeResult<InputStream> result = ExchangeResult.ofSequential(si, version, config);
|
||||
CompletableFuture<HttpResponse<InputStream>> responseCF;
|
||||
CompletableFuture<String> bodyCF;
|
||||
responseCF = client.sendAsync(request, BodyHandlers.ofInputStream())
|
||||
.thenApply(result::withResponse)
|
||||
.thenApplyAsync(ExchangeResult::assertResponseState, readerService)
|
||||
.thenApply(ExchangeResult::response);
|
||||
bodyCF = responseCF.thenApplyAsync(HttpResponse::body, readerService)
|
||||
.thenApply(HttpClientClose::readBody)
|
||||
.thenApply((s) -> {
|
||||
assertEquals(MESSAGE, s);
|
||||
return s;
|
||||
})
|
||||
.thenApply((s) -> {
|
||||
out.println(si + ": Got body: " + s);
|
||||
return s;
|
||||
});
|
||||
long sleep = RANDOM.nextLong(5);
|
||||
if (sleep > 0) {
|
||||
out.printf("%d: sleeping %d ms%n", i, sleep);
|
||||
Thread.sleep(sleep);
|
||||
}
|
||||
bodyCF.get();
|
||||
}
|
||||
}
|
||||
assertTrue(toCheck.isTerminated());
|
||||
}
|
||||
|
||||
// -- Infrastructure
|
||||
|
||||
@BeforeAll
|
||||
public static void setup() throws Exception {
|
||||
out.println("\n**** Setup ****\n");
|
||||
readerService = Executors.newCachedThreadPool();
|
||||
|
||||
httpTestServer = HttpTestServer.create(HTTP_1_1);
|
||||
httpTestServer.addHandler(new ServerRequestHandler(), "/http1/exec/");
|
||||
httpURI = "http://" + httpTestServer.serverAuthority() + "/http1/exec/retry";
|
||||
httpsTestServer = HttpTestServer.create(HTTP_1_1, sslContext);
|
||||
httpsTestServer.addHandler(new ServerRequestHandler(),"/https1/exec/");
|
||||
httpsURI = "https://" + httpsTestServer.serverAuthority() + "/https1/exec/retry";
|
||||
|
||||
http2TestServer = HttpTestServer.create(HTTP_2);
|
||||
http2TestServer.addHandler(new ServerRequestHandler(), "/http2/exec/");
|
||||
http2URI = "http://" + http2TestServer.serverAuthority() + "/http2/exec/retry";
|
||||
https2TestServer = HttpTestServer.create(HTTP_2, sslContext);
|
||||
https2TestServer.addHandler(new ServerRequestHandler(), "/https2/exec/");
|
||||
https2URI = "https://" + https2TestServer.serverAuthority() + "/https2/exec/retry";
|
||||
|
||||
h2h3TestServer = HttpTestServer.create(HTTP_3, sslContext);
|
||||
h2h3TestServer.addHandler(new ServerRequestHandler(), "/h2h3/exec/");
|
||||
h2h3URI = "https://" + h2h3TestServer.serverAuthority() + "/h2h3/exec/retry";
|
||||
h2h3TestServer.addHandler(new HttpHeadOrGetHandler(), "/h2h3/head/");
|
||||
h2h3Head = "https://" + h2h3TestServer.serverAuthority() + "/h2h3/head/";
|
||||
h3TestServer = HttpTestServer.create(HTTP_3_URI_ONLY, sslContext);
|
||||
h3TestServer.addHandler(new ServerRequestHandler(), "/h3-only/exec/");
|
||||
h3URI = "https://" + h3TestServer.serverAuthority() + "/h3-only/exec/retry";
|
||||
|
||||
httpTestServer.start();
|
||||
httpsTestServer.start();
|
||||
http2TestServer.start();
|
||||
https2TestServer.start();
|
||||
h2h3TestServer.start();
|
||||
h3TestServer.start();
|
||||
}
|
||||
|
||||
@AfterAll
|
||||
public static void teardown() throws Exception {
|
||||
Thread.sleep(100);
|
||||
AssertionError fail = TRACKER.checkShutdown(5000);
|
||||
try {
|
||||
shutdown(readerService);
|
||||
httpTestServer.stop();
|
||||
httpsTestServer.stop();
|
||||
http2TestServer.stop();
|
||||
https2TestServer.stop();
|
||||
h2h3TestServer.stop();
|
||||
h3TestServer.stop();
|
||||
} finally {
|
||||
if (fail != null) throw fail;
|
||||
}
|
||||
}
|
||||
|
||||
static void shutdown(ExecutorService executorService) {
|
||||
try {
|
||||
executorService.shutdown();
|
||||
executorService.awaitTermination(2000, TimeUnit.MILLISECONDS);
|
||||
} catch (InterruptedException ie) {
|
||||
executorService.shutdownNow();
|
||||
}
|
||||
}
|
||||
|
||||
static class ServerRequestHandler implements HttpTestHandler {
|
||||
ConcurrentHashMap<String,String> closedRequests = new ConcurrentHashMap<>();
|
||||
|
||||
@java.lang.Override
|
||||
public void handle(HttpTestExchange t) throws IOException {
|
||||
out.println("ServerRequestHandler for: " + t.getRequestURI());
|
||||
|
||||
List<String> uuids = t.getRequestHeaders().get("X-uuid");
|
||||
if (uuids == null || uuids.size() != 1) {
|
||||
readAllRequestData(t);
|
||||
try (OutputStream os = t.getResponseBody()) {
|
||||
String msg = "Incorrect uuid header values:[" + uuids + "]";
|
||||
(new RuntimeException(msg)).printStackTrace();
|
||||
t.sendResponseHeaders(500, -1);
|
||||
os.write(msg.getBytes(UTF_8));
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
String uuid = uuids.get(0);
|
||||
// retrying
|
||||
if (closedRequests.putIfAbsent(uuid, t.getRequestURI().toString()) == null) {
|
||||
if (t.getExchangeVersion() == HTTP_1_1) {
|
||||
// Throwing an exception here only causes a retry
|
||||
// with HTTP_1_1 - where it forces the server to close
|
||||
// the connection.
|
||||
// For HTTP/2 then throwing an IOE would cause the server
|
||||
// to close the stream, and throwing anything else would
|
||||
// cause it to close the connection, but neither would
|
||||
// cause the client to retry.
|
||||
// So we simply do not try to retry with HTTP/2.
|
||||
out.println("Server will close connection, client will retry: "
|
||||
+ t.getRequestURI().toString());
|
||||
throw new IOException("Closing on first request");
|
||||
}
|
||||
}
|
||||
|
||||
// not retrying
|
||||
readAllRequestData(t);
|
||||
try (OutputStream os = t.getResponseBody()) {
|
||||
byte[] bytes = MESSAGE.getBytes(UTF_8);
|
||||
t.sendResponseHeaders(200, bytes.length);
|
||||
for (int i=0; i<bytes.length; i++) {
|
||||
os.write(bytes, i, 1);
|
||||
os.flush();
|
||||
try {
|
||||
Thread.sleep(RANDOM.nextInt(5));
|
||||
} catch (InterruptedException x) { }
|
||||
}
|
||||
}
|
||||
|
||||
closedRequests.remove(uuid);
|
||||
}
|
||||
}
|
||||
|
||||
static void readAllRequestData(HttpTestExchange t) throws IOException {
|
||||
try (InputStream is = t.getRequestBody()) {
|
||||
is.readAllBytes();
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue