Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a different config setting for inbound and outbound HTTP1 header #7362

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions nima/tests/integration/webclient/webclient/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@
<artifactId>helidon-nima-webserver</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.helidon.nima.testing.junit5</groupId>
<artifactId>helidon-nima-testing-junit5-http2</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.helidon.nima.testing.junit5</groupId>
<artifactId>helidon-nima-testing-junit5-webserver</artifactId>
Expand All @@ -51,6 +56,11 @@
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-params</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest-all</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
that is why this tests is in this module, but in the wrong package
*/
@ServerTest
class ClientRequestImplTest {
class Http1ClientTest {
private static final Http.Header REQ_CHUNKED_HEADER = Http.Headers.createCached(
Http.HeaderNames.create("X-Req-Chunked"), "true");
private static final Http.Header REQ_EXPECT_100_HEADER_NAME = Http.Headers.createCached(
Expand All @@ -77,20 +77,20 @@ class ClientRequestImplTest {
private final String baseURI;
private final WebClient injectedHttp1client;

ClientRequestImplTest(WebServer webServer, WebClient client) {
Http1ClientTest(WebServer webServer, WebClient client) {
baseURI = "http://localhost:" + webServer.port();
injectedHttp1client = client;
}

@SetUpRoute
static void routing(HttpRules rules) {
rules.put("/test", ClientRequestImplTest::responseHandler);
rules.put("/redirectKeepMethod", ClientRequestImplTest::redirectKeepMethod);
rules.put("/redirect", ClientRequestImplTest::redirect);
rules.get("/afterRedirect", ClientRequestImplTest::afterRedirectGet);
rules.put("/afterRedirect", ClientRequestImplTest::afterRedirectPut);
rules.put("/chunkresponse", ClientRequestImplTest::chunkResponseHandler);
rules.put("/delayedEndpoint", ClientRequestImplTest::delayedHandler);
rules.put("/test", Http1ClientTest::responseHandler);
rules.put("/redirectKeepMethod", Http1ClientTest::redirectKeepMethod);
rules.put("/redirect", Http1ClientTest::redirect);
rules.get("/afterRedirect", Http1ClientTest::afterRedirectGet);
rules.put("/afterRedirect", Http1ClientTest::afterRedirectPut);
rules.put("/chunkresponse", Http1ClientTest::chunkResponseHandler);
rules.put("/delayedEndpoint", Http1ClientTest::delayedHandler);
}

@Test
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
/*
* Copyright (c) 2023 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package io.helidon.nima.webclient.http1;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UncheckedIOException;
import java.net.SocketTimeoutException;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Stream;
import java.util.concurrent.TimeUnit;

import io.helidon.common.GenericType;
import io.helidon.common.http.Headers;
import io.helidon.common.http.Http;
import io.helidon.common.http.Http.HeaderName;
import io.helidon.common.http.ServerRequestHeaders;
import io.helidon.nima.http.media.EntityReader;
import io.helidon.nima.http.media.EntityWriter;
import io.helidon.nima.http.media.MediaContext;
import io.helidon.nima.http.media.MediaContextConfig;
import io.helidon.nima.testing.junit5.webserver.ServerTest;
import io.helidon.nima.testing.junit5.webserver.SetUpRoute;
import io.helidon.nima.webclient.api.ClientConnection;
import io.helidon.nima.webclient.api.ClientResponseTyped;
import io.helidon.nima.webclient.api.HttpClientRequest;
import io.helidon.nima.webclient.api.HttpClientResponse;
import io.helidon.nima.webclient.api.Proxy;
import io.helidon.nima.webclient.api.WebClient;
import io.helidon.nima.webserver.WebServer;
import io.helidon.nima.webserver.WebServerConfig;
import io.helidon.nima.webserver.http.HttpRules;
import io.helidon.nima.webserver.http.ServerRequest;
import io.helidon.nima.webserver.http.ServerResponse;
import io.helidon.nima.webserver.http1.Http1Config;
import io.helidon.nima.webserver.http1.Http1ConnectionSelector;
import io.helidon.nima.webserver.spi.ServerConnectionSelector;

import io.helidon.nima.testing.junit5.webserver.SetUpServer;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.params.provider.Arguments.arguments;

import static io.helidon.common.testing.http.junit5.HttpHeaderMatcher.hasHeader;
import static io.helidon.common.testing.http.junit5.HttpHeaderMatcher.noHeader;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.instanceOf;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.IsNot.not;
import static org.junit.jupiter.api.Assertions.assertThrows;

/**
* Test for validating client side outbound/inbound headers (request/response headers)
*/
@ServerTest
class ValidateHeadersTest {
public static final String VALID_HEADER_NAME = "Valid-Header-Name";
public static final String VALID_HEADER_VALUE = "Valid-Header-Value";
private final String baseURI;

ValidateHeadersTest(WebServer webServer) {
baseURI = "http://localhost:" + webServer.port();
}

@SetUpServer
static void server(WebServerConfig.Builder server) {
ServerConnectionSelector http1 = Http1ConnectionSelector.builder()
.config(Http1Config.builder()
.validateRequestHeaders(false)
.validateResponseHeaders(false)
.build())
.build();

server.addConnectionSelector(http1);
}

@SetUpRoute
static void routing(HttpRules rules) {
rules.put("/test", ValidateHeadersTest::headerValidationHandler);
}

@ParameterizedTest
@MethodSource("customHeaders")
void testRequestHeaders(String headerName, String headerValue, boolean expectsValid) {
Http1Client client = Http1Client.create(clientConfig -> clientConfig.baseUri(baseURI)
.protocolConfig(it -> {
it.validateRequestHeaders(true);
it.validateResponseHeaders(false);
})
);
Http1ClientRequest request = client.put(baseURI + "/test");
request.header(Http.Headers.create(Http.HeaderNames.create(headerName), headerValue));
if (expectsValid) {
HttpClientResponse response = request.request();
assertThat(response.status(), is(Http.Status.OK_200));
} else {
assertThrows(IllegalArgumentException.class, () -> request.request());
}
}

@ParameterizedTest
@MethodSource("customHeaders")
void testResponsetHeaders(String headerName, String headerValue, boolean expectsValid) {
Http1Client client = Http1Client.create(clientConfig -> clientConfig.baseUri(baseURI)
.protocolConfig(it -> {
it.validateRequestHeaders(false);
it.validateResponseHeaders(true);
})
);
Http1ClientRequest request = client.put(baseURI + "/test");
request.header(Http.Headers.create(Http.HeaderNames.create(headerName), headerValue));
if (expectsValid) {
HttpClientResponse response = request.request();
assertThat(response.status(), is(Http.Status.OK_200));
String responseHeaderValue = response.headers().get(Http.HeaderNames.create(headerName)).values();
assertThat(responseHeaderValue, is(headerValue.trim()));
} else {
assertThrows(IllegalArgumentException.class, () -> request.request());
}
}

@ParameterizedTest
@MethodSource("customHeaders")
void testOutputStreamResponsetHeaders(String headerName, String headerValue, boolean expectsValid) {
Http1Client client = Http1Client.create(clientConfig -> clientConfig.baseUri(baseURI)
.protocolConfig(it -> {
it.validateRequestHeaders(false);
it.validateResponseHeaders(true);
})
.sendExpectContinue(false)
);
Http1ClientRequest request = client.put(baseURI + "/test");
request.header(Http.Headers.create(Http.HeaderNames.create(headerName), headerValue));
if (expectsValid) {
HttpClientResponse response = request.outputStream(it -> {
it.write("Foo Bar".getBytes(StandardCharsets.UTF_8));
it.close();
});
assertThat(response.status(), is(Http.Status.OK_200));
String responseHeaderValue = response.headers().get(Http.HeaderNames.create(headerName)).values();
assertThat(responseHeaderValue, is(headerValue.trim()));
} else {
assertThrows(
IllegalArgumentException.class, () -> request.outputStream(it -> {
it.write("Foo Bar".getBytes(StandardCharsets.UTF_8));
it.close();
})
);
}
}

@ParameterizedTest
@MethodSource("customHeaders")
void testDisableHeaderValidation(String headerName, String headerValue, boolean expectsValid) {
Http1Client client = Http1Client.create(clientConfig -> clientConfig.baseUri(baseURI)
.protocolConfig(it -> {
it.validateRequestHeaders(false);
it.validateResponseHeaders(false);
})
);
Http1ClientRequest request = client.put(baseURI + "/test");
request.header(Http.Headers.create(Http.HeaderNames.create(headerName), headerValue));
HttpClientResponse response = request.request();
assertThat(response.status(), is(Http.Status.OK_200));
String responseHeaderValue = response.headers().get(Http.HeaderNames.create(headerName)).values();
assertThat(responseHeaderValue, is(headerValue.trim()));
}

private static void headerValidationHandler(ServerRequest request, ServerResponse response) {
ServerRequestHeaders headers = request.headers();
request.headers().toMap().forEach((k, v) -> {
if (k.contains("Header")) {
response.headers().add(Http.Headers.create(Http.HeaderNames.create(k), v));
}
});
response.send("any");
}

private static Stream<Arguments> customHeaders() {
return Stream.of(
// Invalid header names
arguments("Header\u001aName", VALID_HEADER_VALUE, false),
arguments("Header\u000EName", VALID_HEADER_VALUE, false),
arguments("<Header?Name>", VALID_HEADER_VALUE, false),
arguments("{Header=Name}", VALID_HEADER_VALUE, false),
arguments("\"HeaderName\"", VALID_HEADER_VALUE, false),
arguments("[\\HeaderName]", VALID_HEADER_VALUE, false),
arguments("@Header,Name;", VALID_HEADER_VALUE, false),
// Valid header names
arguments("!#$Custom~%&\'*Header+^`|", VALID_HEADER_VALUE, true),
arguments("Custom_0-9_a-z_A-Z_Header", VALID_HEADER_VALUE, true),
// Valid header values
arguments(VALID_HEADER_NAME, "Header Value", true),
arguments(VALID_HEADER_NAME, "HeaderValue1\u0009, Header=Value2", true),
arguments(VALID_HEADER_NAME, "Header\tValue", true),
// Invalid header values
arguments(VALID_HEADER_NAME, "HeaderV\u001calue1", false),
arguments(VALID_HEADER_NAME, "HeaderValue1, Header\u007fValue", false),
arguments(VALID_HEADER_NAME, "HeaderValue1\u001f, HeaderValue2", false)
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ static void server(WebServerConfig.Builder server) {
ServerConnectionSelector http1 = Http1ConnectionSelector.builder()
.config(http1Config -> http1Config
// Headers validation is disabled
.validateHeaders(false))
.validateRequestHeaders(false))
.build();

server.addConnectionSelector(http1)
Expand Down