File: HttpClientSNITest.java

package info (click to toggle)
openjdk-24 24.0.2%2B12-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 831,900 kB
  • sloc: java: 5,677,020; cpp: 1,323,154; xml: 1,320,524; ansic: 486,889; asm: 405,131; objc: 21,025; sh: 15,221; javascript: 11,049; python: 8,222; makefile: 2,504; perl: 357; awk: 351; sed: 172; pascal: 103; exp: 54; jsp: 24; csh: 3
file content (210 lines) | stat: -rw-r--r-- 10,451 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
 * Copyright (c) 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.
 *
 * 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.
 */

import java.io.IOException;
import java.io.OutputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.List;

import javax.net.ssl.SNIHostName;
import javax.net.ssl.SNIMatcher;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLParameters;

import com.sun.net.httpserver.HttpsConfigurator;
import com.sun.net.httpserver.HttpsParameters;
import com.sun.net.httpserver.HttpsServer;
import jdk.httpclient.test.lib.common.HttpServerAdapters.HttpTestExchange;
import jdk.httpclient.test.lib.common.HttpServerAdapters.HttpTestHandler;
import jdk.httpclient.test.lib.common.HttpServerAdapters.HttpTestServer;
import jdk.httpclient.test.lib.common.ServerNameMatcher;
import jdk.test.lib.net.SimpleSSLContext;
import jdk.test.lib.net.URIBuilder;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

/*
 * @test
 * @bug 8346705
 * @summary verify the behaviour of java.net.http.HttpClient
 *          when sending a Server Name Indication in the TLS
 *          connections that it establishes for the requests
 * @library /test/lib /test/jdk/java/net/httpclient/lib
 * @build jdk.httpclient.test.lib.common.HttpServerAdapters
 *        jdk.test.lib.net.SimpleSSLContext
 *        jdk.test.lib.net.URIBuilder
 * @run junit HttpClientSNITest
 */
public class HttpClientSNITest {
    private static final String RESP_BODY_TEXT = "hello world";

    private static final class Handler implements HttpTestHandler {

        @Override
        public void handle(final HttpTestExchange exch) throws IOException {
            System.out.println("handling request " + exch.getRequestURI());
            final byte[] respBody = RESP_BODY_TEXT.getBytes(US_ASCII);
            exch.sendResponseHeaders(200, respBody.length);
            try (final OutputStream os = exch.getResponseBody()) {
                os.write(respBody);
            }
        }
    }

    /*
     * Creates and configures a HTTPS server with a SNIMatcher that
     * expects a specific SNI name to be sent by the connection client.
     * The test uses a HttpClient to issue a couple of requests with the URI having
     * a IP address literal as the host. For one of the request, the HttpClient
     * is configured with specific ServerName(s) through HttpClient.sslParameters()
     * and for the other request, it isn't.
     * The test then verifies that for such requests with a IP address literal as the host,
     * the HttpClient sends across the ServerName(s) if any has been configured on the client.
     */
    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    void testRequestToIPLiteralHost(final boolean sniConfiguredOnClient) throws Exception {
        final SSLContext sslContext = new SimpleSSLContext().get();
        assertNotNull(sslContext, "could not create a SSLContext");
        final String expectedSNI = "non-dns-resolvable.foo.bar.localhost";
        final ServerNameMatcher matcher = new ServerNameMatcher(expectedSNI);
        final HttpTestServer server = createServer(matcher, sslContext);
        try {
            final HttpClient.Builder builder = HttpClient.newBuilder().sslContext(sslContext);
            if (sniConfiguredOnClient) {
                final SSLParameters clientConfiguredSSLParams = new SSLParameters();
                clientConfiguredSSLParams.setServerNames(List.of(new SNIHostName(expectedSNI)));
                builder.sslParameters(clientConfiguredSSLParams);
            }
            try (final HttpClient client = builder.build()) {
                final String ipLiteral = InetAddress.getLoopbackAddress().getHostAddress();
                final URI reqURI = URIBuilder.newBuilder()
                        .host(ipLiteral)
                        .port(server.getAddress().getPort())
                        .scheme("https")
                        .path("/")
                        .build();
                final HttpRequest req = HttpRequest.newBuilder(reqURI).build();
                System.out.println("issuing request " + reqURI);
                final HttpResponse<String> resp = client.send(req, BodyHandlers.ofString(US_ASCII));
                assertEquals(200, resp.statusCode(), "unexpected response status code");
                assertEquals(RESP_BODY_TEXT, resp.body(), "unexpected response body");
                if (sniConfiguredOnClient) {
                    assertTrue(matcher.wasInvoked(), "SNIMatcher wasn't invoked on the server");
                } else {
                    assertFalse(matcher.wasInvoked(), "SNIMatcher was unexpectedly invoked" +
                            " on the server");
                }
            }
        } finally {
            System.out.println("stopping server " + server.getAddress());
            server.stop();
        }
    }

    /*
     * Creates and configures a HTTPS server with a SNIMatcher that
     * expects a specific SNI name to be sent by the connection client.
     * The test uses a HttpClient to issue a couple of requests with the URI having
     * a hostname (i.e. not a IP address literal) as the host. For one of the request,
     * the HttpClient is configured with specific ServerName(s) through
     * HttpClient.sslParameters() and for the other request, it isn't.
     * The test then verifies that for such requests with a hostname
     * (i.e. not a IP address literal) in the request URI,
     * the HttpClient never sends ServerName(s) that may have been configured on the
     * client and instead it sends the hostname (from the request URI) as the ServerName
     * for each of the request.
     */
    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    void testRequestResolvedHostName(final boolean sniConfiguredOnClient) throws Exception {
        final SSLContext sslContext = new SimpleSSLContext().get();
        assertNotNull(sslContext, "could not create a SSLContext");
        final String resolvedHostName = InetAddress.getLoopbackAddress().getHostName();
        final String expectedSNI = resolvedHostName;
        final ServerNameMatcher matcher = new ServerNameMatcher(expectedSNI);
        final HttpTestServer server = createServer(matcher, sslContext);
        try {
            final HttpClient.Builder builder = HttpClient.newBuilder().sslContext(sslContext);
            if (sniConfiguredOnClient) {
                final SSLParameters clientConfiguredSSLParams = new SSLParameters();
                clientConfiguredSSLParams.setServerNames(List.of(new SNIHostName("does-not-matter")));
                builder.sslParameters(clientConfiguredSSLParams);
            }
            try (final HttpClient client = builder.build()) {
                final URI reqURI = URIBuilder.newBuilder()
                        .host(resolvedHostName)
                        .port(server.getAddress().getPort())
                        .scheme("https")
                        .path("/")
                        .build();
                final HttpRequest req = HttpRequest.newBuilder(reqURI).build();
                System.out.println("issuing request " + reqURI);
                final HttpResponse<String> resp = client.send(req, BodyHandlers.ofString(US_ASCII));
                assertEquals(200, resp.statusCode(), "unexpected response status code");
                assertEquals(RESP_BODY_TEXT, resp.body(), "unexpected response body");
                assertTrue(matcher.wasInvoked(), "SNIMatcher wasn't invoked on the server");
            }
        } finally {
            System.out.println("stopping server " + server.getAddress());
            server.stop();
        }
    }

    /*
     * Creates a HttpsServer configured to use the given SNIMatcher
     */
    private static HttpTestServer createServer(final SNIMatcher matcher,
                                               final SSLContext sslContext) throws Exception {
        final InetSocketAddress addr = new InetSocketAddress(InetAddress.getLoopbackAddress(), 0);
        final int backlog = 0;
        final HttpsServer httpsServer = HttpsServer.create(addr, backlog);
        final HttpsConfigurator configurator = new HttpsConfigurator(sslContext) {
            @Override
            public void configure(final HttpsParameters params) {
                final SSLParameters sslParameters = sslContext.getDefaultSSLParameters();
                // add the SNIMatcher
                sslParameters.setSNIMatchers(List.of(matcher));
                params.setSSLParameters(sslParameters);
                System.out.println("configured HttpsServer with SNIMatcher: " + matcher);
            }
        };
        httpsServer.setHttpsConfigurator(configurator);
        final HttpTestServer server = HttpTestServer.of(httpsServer);
        server.addHandler(new Handler(), "/");
        server.start();
        System.out.println("server started at " + server.getAddress());
        return server;
    }
}