net.luminis.quic.run.InteropRunner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kwik Show documentation
Show all versions of kwik Show documentation
A QUIC implementation in Java
/*
* Copyright © 2019, 2020, 2021, 2022, 2023 Peter Doornbosch
*
* This file is part of Kwik, an implementation of the QUIC protocol in Java.
*
* Kwik is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your option)
* any later version.
*
* Kwik 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 Lesser General Public License for
* more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see ");
System.exit(1);
}
outputDir = new File(args[0]);
if (! outputDir.isDirectory()) {
outputDir.mkdir();
}
String testCase = args[1];
if (! TESTCASES.contains(testCase)) {
System.out.println("Invalid argument; test case '" + testCase + "' not known.");
System.out.println("Available test cases: " + TESTCASES);
}
int i = -1;
try {
List downloadUrls = new ArrayList<>();
for (i = 2; i < args.length; i++) {
downloadUrls.add(new URL(args[i]));
}
QuicClientConnectionImpl.Builder builder = QuicClientConnectionImpl.newBuilder();
builder.version(QuicConnection.QuicVersion.V1);
builder.applicationProtocol("hq-interop");
builder.noServerCertificateCheck();
builder.uri(downloadUrls.get(0).toURI());
builder.logger(logger);
builder.initialRtt(100);
builder.connectTimeout(Duration.ofSeconds(5));
String keylogfileEnvVar = System.getenv("SSLKEYLOGFILE");
if (keylogfileEnvVar != null && ! keylogfileEnvVar.isBlank()) {
System.out.println("Writing keys to " + keylogfileEnvVar);
builder.secrets(Paths.get(keylogfileEnvVar));
}
if (testCase.equals(TC_TRANSFER)) {
testTransfer(downloadUrls, builder);
}
else if (testCase.equals(TC_RESUMPTION)) {
testResumption(downloadUrls, builder);
}
else if (testCase.equals(TC_MULTI)) {
testMultiConnect(downloadUrls, builder);
}
else if (testCase.equals(TC_0RTT)) {
testZeroRtt(downloadUrls, builder);
}
else if (testCase.equals(TC_KEYUPDATE)) {
testKeyUpdate(downloadUrls, builder);
}
} catch (MalformedURLException | URISyntaxException e) {
System.out.println("Invalid argument: cannot parse URL '" + args[i] + "'");
} catch (IOException e) {
System.out.println("I/O Error: " + e);
}
}
private static void testTransfer(List downloadUrls, QuicClientConnectionImpl.Builder builder) throws IOException, URISyntaxException {
URL url1 = downloadUrls.get(0);
// logger.logPackets(true);
QuicClientConnection connection = builder.build();
connection.connect();
ForkJoinPool myPool = new ForkJoinPool(Integer.min(100, downloadUrls.size()));
try {
myPool.submit(() ->
downloadUrls.parallelStream()
.forEach(url -> http09Request(connection, url, outputDir)))
.get(5, TimeUnit.MINUTES);
logger.info("Downloaded " + downloadUrls);
} catch (InterruptedException e) {
logger.error("download tasks interrupted", e);
} catch (ExecutionException e) {
logger.error("download tasks failed", e);
} catch (TimeoutException e) {
logger.error("download tasks timed out...", e);
}
connection.close();
}
private static void testResumption(List downloadUrls, QuicClientConnectionImpl.Builder builder) throws IOException, URISyntaxException {
if (downloadUrls.size() != 2) {
throw new IllegalArgumentException("expected 2 download URLs");
}
URL url1 = downloadUrls.get(0);
URL url2 = downloadUrls.get(1);
QuicClientConnection connection = builder.build();
connection.connect();
http09Request(connection, url1, outputDir);
logger.info("Downloaded " + url1);
List newSessionTickets = connection.getNewSessionTickets();
connection.close();
if (newSessionTickets.isEmpty()) {
logger.info("Server did not provide any new session tickets.");
System.exit(1);
}
builder = QuicClientConnectionImpl.newBuilder();
builder.version(QuicConnection.QuicVersion.V1);
builder.applicationProtocol("hq-interop");
builder.uri(url2.toURI());
builder.noServerCertificateCheck(); // Not necessary if server accepts PSK, but when not, test would fail for wrong reason.
builder.logger(logger);
builder.sessionTicket(newSessionTickets.get(0));
QuicClientConnection connection2 = builder.build();
connection2.connect();
http09Request(connection2, url2, outputDir);
logger.info("Downloaded " + url2);
connection2.close();
}
private static void testMultiConnect(List downloadUrls, QuicClientConnectionImpl.Builder builder) throws URISyntaxException {
logger.useRelativeTime(true);
logger.logRecovery(true);
logger.logCongestionControl(true);
logger.logPackets(true);
for (URL download : downloadUrls) {
try {
logger.info("Start downloading " + download.getFile() + " at " + timeNow());
QuicClientConnection connection = builder.build();
connection.connect();
http09Request(connection, download, outputDir);
logger.info("Downloaded " + download + " finished at " + timeNow());
connection.close();
}
catch (IOException ioError) {
logger.error(timeNow() + " Error in client: " + ioError);
}
}
}
private static void testZeroRtt(List downloadUrls, QuicClientConnectionImpl.Builder builder) throws IOException {
logger.logPackets(true);
logger.logRecovery(true);
logger.info("Starting first download at " + timeNow());
builder.connectTimeout(Duration.ofSeconds(15));
QuicClientConnection connection = builder.build();
connection.connect();
http09Request(connection, downloadUrls.get(0), outputDir);
logger.info("Downloaded " + downloadUrls.get(0) + " finished at " + timeNow());
List newSessionTickets = connection.getNewSessionTickets();
if (newSessionTickets.isEmpty()) {
logger.error("Error: did not get any new session tickets; aborting test.");
return;
}
else {
logger.info("Got " + newSessionTickets.size() + " new session tickets");
}
connection.close();
logger.info("Connection closed; starting second connection with 0-rtt");
builder.sessionTicket(newSessionTickets.get(0));
builder.connectTimeout(Duration.ofSeconds(15));
QuicClientConnection connection2 = builder.build();
List earlyDataRequests = new ArrayList<>();
for (int i = 1; i < downloadUrls.size(); i++) {
String httpRequest = "GET " + downloadUrls.get(i).getPath() + "\r\n";
earlyDataRequests.add(new QuicClientConnection.StreamEarlyData(httpRequest.getBytes(), true));
}
String alpn = "hq-interop";
List earlyDataStreams = connection2.connect(earlyDataRequests);
for (int i = 0; i < earlyDataRequests.size(); i++) {
if (earlyDataStreams.get(i) == null) {
logger.info("Attempting to create new stream after connect, because it failed on 0-rtt");
}
else {
logger.info("Processing response for stream " + earlyDataStreams.get(i));
}
http09RequestWithZeroRttStream(connection, downloadUrls.get(i+1).getPath(), earlyDataStreams.get(i), outputDir.getAbsolutePath());
}
logger.info("Download finished at " + timeNow());
connection.close();
}
private static void testKeyUpdate(List downloadUrls, QuicClientConnectionImpl.Builder builder) throws IOException {
logger.logPackets(true);
logger.info("Starting download at " + timeNow());
QuicClientConnection connection = builder.build();
connection.connect();
String requestPath = downloadUrls.get(0).getPath();
String outputFile = outputDir.getAbsolutePath();
QuicStream httpStream = connection.createStream(true);
httpStream.getOutputStream().write(("GET " + requestPath + "\r\n").getBytes());
httpStream.getOutputStream().close();
String fileName = requestPath;
FileOutputStream out = new FileOutputStream(new File(outputFile, fileName));
// Read the first 100KB of bytes (approx.)
transfer(httpStream.getInputStream(), out, 100 * 1024);
// Initiate the key update; test specification requires the update to take place before 1MB is downloaded.
logger.info("Initiating key update");
((QuicClientConnectionImpl) connection).updateKeys();
// And download the rest.
httpStream.getInputStream().transferTo(out);
logger.info("Downloaded " + downloadUrls.get(0) + " finished at " + timeNow());
}
private static void http09Request(QuicClientConnection connection, URL url, File outputDir) {
try {
HttpClient httpClient = new Http09Client(connection, false);
HttpRequest request = HttpRequest.newBuilder().uri(url.toURI()).build();
String fileName = new File(url.getFile()).getName();
httpClient.send(request, HttpResponse.BodyHandlers.ofFile(Paths.get(outputDir.getAbsolutePath(), fileName)));
}
catch (IOException | URISyntaxException | InterruptedException e) {
throw new RuntimeException(e);
}
}
private static void http09RequestWithZeroRttStream(QuicConnection quicConnection, String requestPath, QuicStream httpStream, String outputFile) throws IOException {
FileOutputStream out;
if (new File(outputFile).isDirectory()) {
String fileName = requestPath;
if (fileName.equals("/")) {
fileName = "index";
}
out = new FileOutputStream(new File(outputFile, fileName));
}
else {
out = new FileOutputStream(outputFile);
}
httpStream.getInputStream().transferTo(out);
}
private static void transfer(InputStream in, FileOutputStream out, int bytes) throws IOException {
byte[] buffer = new byte[1200];
int transferred = 0;
int read;
while (transferred < bytes && (read = in.read(buffer, 0, 1200)) >= 0) {
out.write(buffer, 0, read);
transferred += read;
}
}
static String timeNow() {
LocalTime localTimeNow = LocalTime.from(Instant.now().atZone(ZoneId.systemDefault()));
DateTimeFormatter timeFormatter = DateTimeFormatter.ofPattern("mm:ss.SSS");
return timeFormatter.format(localTimeNow);
}
}