http-client-branch: non-us-ascii chars in URI path or query segments http-client-branch
authorchegar
Tue, 24 Apr 2018 19:45:20 +0100
branchhttp-client-branch
changeset 56480 97bff67fed21
parent 56478 90df053536e0
child 56481 247ed0848e48
http-client-branch: non-us-ascii chars in URI path or query segments
src/java.net.http/share/classes/jdk/internal/net/http/Http1Request.java
src/java.net.http/share/classes/jdk/internal/net/http/Stream.java
src/java.net.http/share/classes/jdk/internal/net/http/common/Utils.java
test/jdk/java/net/httpclient/EscapedOctetsInURI.java
test/jdk/java/net/httpclient/NonAsciiCharsInURI.java
--- a/src/java.net.http/share/classes/jdk/internal/net/http/Http1Request.java	Tue Apr 24 10:20:22 2018 +0100
+++ b/src/java.net.http/share/classes/jdk/internal/net/http/Http1Request.java	Tue Apr 24 19:45:20 2018 +0100
@@ -200,9 +200,9 @@
             query = "";
         }
         if (query.equals("")) {
-            return path;
+            return Utils.encode(path);
         } else {
-            return path + "?" + query;
+            return Utils.encode(path + "?" + query);
         }
     }
 
--- a/src/java.net.http/share/classes/jdk/internal/net/http/Stream.java	Tue Apr 24 10:20:22 2018 +0100
+++ b/src/java.net.http/share/classes/jdk/internal/net/http/Stream.java	Tue Apr 24 19:45:20 2018 +0100
@@ -614,7 +614,7 @@
         if (query != null) {
             path += "?" + query;
         }
-        hdrs.setHeader(":path", path);
+        hdrs.setHeader(":path", Utils.encode(path));
     }
 
     HttpHeadersImpl getRequestPseudoHeaders() {
--- a/src/java.net.http/share/classes/jdk/internal/net/http/common/Utils.java	Tue Apr 24 10:20:22 2018 +0100
+++ b/src/java.net.http/share/classes/jdk/internal/net/http/common/Utils.java	Tue Apr 24 19:45:20 2018 +0100
@@ -44,10 +44,14 @@
 import java.net.URLPermission;
 import java.net.http.HttpHeaders;
 import java.nio.ByteBuffer;
+import java.nio.CharBuffer;
+import java.nio.charset.CharacterCodingException;
 import java.nio.charset.Charset;
+import java.nio.charset.CodingErrorAction;
 import java.nio.charset.StandardCharsets;
 import java.security.AccessController;
 import java.security.PrivilegedAction;
+import java.text.Normalizer;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
@@ -939,4 +943,55 @@
             return 1 << (32 - Integer.numberOfLeadingZeros(n - 1));
         }
     }
+
+    // -- toAsciiString-like support to encode path and query URI segments
+
+    private static final char[] hexDigits = {
+            '0', '1', '2', '3', '4', '5', '6', '7',
+            '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
+    };
+
+    private static void appendEscape(StringBuilder sb, byte b) {
+        sb.append('%');
+        sb.append(hexDigits[(b >> 4) & 0x0f]);
+        sb.append(hexDigits[(b >> 0) & 0x0f]);
+    }
+
+    // Encodes all characters >= \u0080 into escaped, normalized UTF-8 octets,
+    // assuming that s is otherwise legal
+    //
+    public static String encode(String s) {
+        int n = s.length();
+        if (n == 0)
+            return s;
+
+        // First check whether we actually need to encode
+        for (int i = 0;;) {
+            if (s.charAt(i) >= '\u0080')
+                break;
+            if (++i >= n)
+                return s;
+        }
+
+        String ns = Normalizer.normalize(s, Normalizer.Form.NFC);
+        ByteBuffer bb = null;
+        try {
+            bb = StandardCharsets.UTF_8.newEncoder()
+                    .onMalformedInput(CodingErrorAction.REPORT)
+                    .onUnmappableCharacter(CodingErrorAction.REPORT)
+                    .encode(CharBuffer.wrap(ns));
+        } catch (CharacterCodingException x) {
+            assert false : x;
+        }
+
+        StringBuilder sb = new StringBuilder();
+        while (bb.hasRemaining()) {
+            int b = bb.get() & 0xff;
+            if (b >= 0x80)
+                appendEscape(sb, (byte)b);
+            else
+                sb.append((char)b);
+        }
+        return sb.toString();
+    }
 }
--- a/test/jdk/java/net/httpclient/EscapedOctetsInURI.java	Tue Apr 24 10:20:22 2018 +0100
+++ b/test/jdk/java/net/httpclient/EscapedOctetsInURI.java	Tue Apr 24 19:45:20 2018 +0100
@@ -116,6 +116,8 @@
 
     @Test(dataProvider = "variants")
     void test(String uriString, boolean sameClient) throws Exception {
+        System.out.println("\n--- Starting ");
+
         // The single-argument factory requires any illegal characters in its
         // argument to be quoted and preserves any escaped octets and other
         // characters that are present.
@@ -146,6 +148,7 @@
 
     @Test(dataProvider = "variants")
     void testAsync(String uriString, boolean sameClient) {
+        System.out.println("\n--- Starting ");
         URI uri = URI.create(uriString);
 
         HttpClient client = null;
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/java/net/httpclient/NonAsciiCharsInURI.java	Tue Apr 24 19:45:20 2018 +0100
@@ -0,0 +1,252 @@
+/*
+ * Copyright (c) 2018, 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
+ * @summary Verify that non-US-ASCII chars are replaced with a sequence of
+ *          escaped octets that represent that char in the UTF-8 character set.
+ * @bug 8201238
+ * @modules java.base/sun.net.www.http
+ *          java.net.http/jdk.internal.net.http.common
+ *          java.net.http/jdk.internal.net.http.frame
+ *          java.net.http/jdk.internal.net.http.hpack
+ *          java.logging
+ *          jdk.httpserver
+ * @library /lib/testlibrary http2/server
+ * @build Http2TestServer
+ * @build jdk.testlibrary.SimpleSSLContext
+ * @compile -encoding utf-8 NonAsciiCharsInURI.java
+ * @run testng/othervm
+ *       -Djdk.httpclient.HttpClient.log=reqeusts,headers
+ *       NonAsciiCharsInURI
+ */
+
+import com.sun.net.httpserver.HttpServer;
+import com.sun.net.httpserver.HttpsConfigurator;
+import com.sun.net.httpserver.HttpsServer;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+import java.net.URI;
+import javax.net.ssl.SSLContext;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.net.http.HttpResponse.BodyHandlers;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import jdk.testlibrary.SimpleSSLContext;
+import org.testng.annotations.AfterTest;
+import org.testng.annotations.BeforeTest;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+import static java.lang.System.err;
+import static java.lang.System.out;
+import static java.nio.charset.StandardCharsets.US_ASCII;
+import static java.net.http.HttpClient.Builder.NO_PROXY;
+import static org.testng.Assert.assertEquals;
+
+public class NonAsciiCharsInURI implements HttpServerAdapters {
+
+    SSLContext sslContext;
+    HttpTestServer httpTestServer;         // HTTP/1.1    [ 4 servers ]
+    HttpTestServer httpsTestServer;        // HTTPS/1.1
+    HttpTestServer http2TestServer;        // HTTP/2 ( h2c )
+    HttpTestServer https2TestServer;       // HTTP/2 ( h2  )
+    String httpURI;
+    String httpsURI;
+    String http2URI;
+    String https2URI;
+
+    // € = '\u20AC' => 0xE20x820xAC
+    static final String[][] pathsAndQueryStrings = new String[][] {
+               // partial-path
+            {  "/001/plain"                                                            },
+            {  "/002/plain?plainQuery"                                                 },
+            {  "/003/withEuroSymbol/€"                                                 },
+            {  "/004/withEuroSymbol/€?euroSymbol=€"                                    },
+            {  "/005/wiki/エリザベス1世_(イングランド女王)"                                },
+            {  "/006/x?url=https://ja.wikipedia.org/wiki/エリザベス1世_(イングランド女王)" },
+    };
+
+    @DataProvider(name = "variants")
+    public Object[][] variants() {
+        List<Object[]> list = new ArrayList<>();
+
+        for (boolean sameClient : new boolean[] { false, true }) {
+            Arrays.asList(pathsAndQueryStrings).stream()
+                    .map(e -> new Object[] {httpURI + e[0], sameClient})
+                    .forEach(list::add);
+            Arrays.asList(pathsAndQueryStrings).stream()
+                    .map(e -> new Object[] {httpsURI + e[0], sameClient})
+                    .forEach(list::add);
+            Arrays.asList(pathsAndQueryStrings).stream()
+                    .map(e -> new Object[] {http2URI + e[0], sameClient})
+                    .forEach(list::add);
+            Arrays.asList(pathsAndQueryStrings).stream()
+                    .map(e -> new Object[] {https2URI + e[0], sameClient})
+                    .forEach(list::add);
+        }
+        return list.stream().toArray(Object[][]::new);
+    }
+
+    static final int ITERATION_COUNT = 3; // checks upgrade and re-use
+
+    @Test(dataProvider = "variants")
+    void test(String uriString, boolean sameClient) throws Exception {
+        out.println("\n--- Starting ");
+        // The single-argument factory requires any illegal characters in its
+        // argument to be quoted and preserves any escaped octets and other
+        // characters that are present.
+        URI uri = URI.create(uriString);
+
+        HttpClient client = null;
+        for (int i=0; i< ITERATION_COUNT; i++) {
+            if (!sameClient || client == null)
+                client = HttpClient.newBuilder()
+                        .proxy(NO_PROXY)
+                        .sslContext(sslContext)
+                        .build();
+
+            HttpRequest request = HttpRequest.newBuilder(uri).build();
+            HttpResponse<String> resp = client.send(request, BodyHandlers.ofString());
+
+            out.println("Got response: " + resp);
+            out.println("Got body: " + resp.body());
+            assertEquals(resp.statusCode(), 200,
+                    "Expected 200, got:" + resp.statusCode());
+
+            // the response body should contain the toASCIIString
+            // representation of the URI
+            String expectedURIString = uri.toASCIIString();
+            if (!expectedURIString.contains(resp.body())) {
+                err.println("Test failed: " + resp);
+                throw new AssertionError(expectedURIString +
+                                         " does not contain '" + resp.body() + "'");
+            } else {
+                out.println("Found expected " + resp.body() + " in " + expectedURIString);
+            }
+        }
+    }
+
+    @Test(dataProvider = "variants")
+    void testAsync(String uriString, boolean sameClient) {
+        out.println("\n--- Starting ");
+        URI uri = URI.create(uriString);
+
+        HttpClient client = null;
+        for (int i=0; i< ITERATION_COUNT; i++) {
+            if (!sameClient || client == null)
+                client = HttpClient.newBuilder()
+                        .proxy(NO_PROXY)
+                        .sslContext(sslContext)
+                        .build();
+
+            HttpRequest request = HttpRequest.newBuilder(uri).build();
+
+            client.sendAsync(request, BodyHandlers.ofString())
+                    .thenApply(response -> {
+                        out.println("Got response: " + response);
+                        out.println("Got body: " + response.body());
+                        assertEquals(response.statusCode(), 200);
+                        return response.body(); })
+                    .thenAccept(body -> {
+                        // the response body should contain the toASCIIString
+                        // representation of the URI
+                        String expectedURIString = uri.toASCIIString();
+                        if (!expectedURIString.contains(body)) {
+                            err.println("Test failed: " + body);
+                            throw new AssertionError(expectedURIString +
+                                    " does not contain '" + body + "'");
+                        } else {
+                            out.println("Found expected " + body + " in "
+                                        + expectedURIString);
+                        } })
+                    .join();
+        }
+    }
+
+    static String serverAuthority(HttpTestServer server) {
+        return InetAddress.getLoopbackAddress().getHostName() + ":"
+                + server.getAddress().getPort();
+    }
+
+    @BeforeTest
+    public void setup() throws Exception {
+        sslContext = new SimpleSSLContext().get();
+        if (sslContext == null)
+            throw new AssertionError("Unexpected null sslContext");
+
+        HttpTestHandler handler = new HttpUriStringHandler();
+        InetSocketAddress sa = new InetSocketAddress(InetAddress.getLoopbackAddress(), 0);
+        httpTestServer = HttpTestServer.of(HttpServer.create(sa, 0));
+        httpTestServer.addHandler(handler, "/http1");
+        httpURI = "http://" + serverAuthority(httpTestServer) + "/http1";
+
+        HttpsServer httpsServer = HttpsServer.create(sa, 0);
+        httpsServer.setHttpsConfigurator(new HttpsConfigurator(sslContext));
+        httpsTestServer = HttpTestServer.of(httpsServer);
+        httpsTestServer.addHandler(handler, "/https1");
+        httpsURI = "https://" + serverAuthority(httpsTestServer) + "/https1";
+
+        http2TestServer = HttpTestServer.of(new Http2TestServer("localhost", false, 0));
+        http2TestServer.addHandler(handler, "/http2");
+        http2URI = "http://" + http2TestServer.serverAuthority() + "/http2";
+
+        https2TestServer = HttpTestServer.of(new Http2TestServer("localhost", true, 0));
+        https2TestServer.addHandler(handler, "/https2");
+        https2URI = "https://" + https2TestServer.serverAuthority() + "/https2";
+
+        httpTestServer.start();
+        httpsTestServer.start();
+        http2TestServer.start();
+        https2TestServer.start();
+    }
+
+    @AfterTest
+    public void teardown() throws Exception {
+        httpTestServer.stop();
+        httpsTestServer.stop();
+        http2TestServer.stop();
+        https2TestServer.stop();
+    }
+
+    /** A handler that returns, as its body, the exact received request URI. */
+    static class HttpUriStringHandler implements HttpTestHandler {
+        @Override
+        public void handle(HttpTestExchange t) throws IOException {
+            String uri = t.getRequestURI().toString();
+            out.println("Http1UriStringHandler received, uri: " + uri);
+            try (InputStream is = t.getRequestBody();
+                 OutputStream os = t.getResponseBody()) {
+                is.readAllBytes();
+                byte[] bytes = uri.getBytes(US_ASCII);
+                t.sendResponseHeaders(200, bytes.length);
+                os.write(bytes);
+            }
+        }
+    }
+}