Skip to content

HTTPCLIENT-2401: Do not attempt RFC 2817 TLS upgrade on proxied routes #739

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.

Sign up for GitHub

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

Closed
arturobernalg wants to merge 1 commit into from
Closed

HTTPCLIENT-2401: Do not attempt RFC 2817 TLS upgrade on proxied routes #739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestUpgrade.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

import java.io.IOException;

import org.apache.hc.client5.http.RouteInfo;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.core5.annotation.Contract;
import org.apache.hc.core5.annotation.ThreadingBehavior;
Expand All @@ -39,6 +40,7 @@
import org.apache.hc.core5.http.HttpRequestInterceptor;
import org.apache.hc.core5.http.Method;
import org.apache.hc.core5.http.ProtocolVersion;
import org.apache.hc.core5.http.URIScheme;
import org.apache.hc.core5.http.protocol.HttpContext;
import org.apache.hc.core5.util.Args;
import org.slf4j.Logger;
Expand All @@ -65,7 +67,12 @@ public void process(

final HttpClientContext clientContext = HttpClientContext.cast(context);
final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault();
if (requestConfig.isProtocolUpgradeEnabled()) {
final RouteInfo route = clientContext.getHttpRoute();
final String scheme = request.getScheme();
if (scheme != null && !URIScheme.HTTP.same(scheme)) {
return;
}
if (requestConfig.isProtocolUpgradeEnabled() && (route == null || route.getProxyHost() == null)) {
final ProtocolVersion version = request.getVersion() != null ? request.getVersion() : clientContext.getProtocolVersion();
if (!request.containsHeader(HttpHeaders.UPGRADE) &&
!request.containsHeader(HttpHeaders.CONNECTION) &&
Expand Down
63 changes: 63 additions & 0 deletions httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestUpgrade.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,13 @@
import javax.net.ssl.SSLSession;

import org.apache.hc.client5.http.HeadersMatcher;
import org.apache.hc.client5.http.HttpRoute;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.core5.http.HttpHeaders;
import org.apache.hc.core5.http.HttpHost;
import org.apache.hc.core5.http.HttpRequest;
import org.apache.hc.core5.http.HttpVersion;
import org.apache.hc.core5.http.message.BasicClassicHttpRequest;
import org.apache.hc.core5.http.message.BasicHeader;
import org.apache.hc.core5.http.message.BasicHttpRequest;
import org.hamcrest.MatcherAssert;
Expand Down Expand Up @@ -136,4 +139,64 @@ void testDoUpgradeNonSafeMethodsOrTrace() throws Exception {
Assertions.assertFalse(trace.containsHeader(HttpHeaders.UPGRADE));
}

@Test
void doesNotAddUpgradeHeadersWhenProxyPresent() throws Exception {
final RequestUpgrade interceptor = new RequestUpgrade();

final HttpHost target = new HttpHost("http", "example.com", 80);
final HttpHost proxy = new HttpHost("http", "proxy.local", 8080);

final HttpClientContext ctx = HttpClientContext.create();
final HttpRoute route = new HttpRoute(target, null, proxy, false);
ctx.setRoute(route);
ctx.setRequestConfig(RequestConfig.custom()
.setProtocolUpgradeEnabled(true)
.build());

final BasicClassicHttpRequest request = new BasicClassicHttpRequest("GET", "/");
request.setScheme("http");

interceptor.process(request, null, ctx);

Assertions.assertNull(request.getFirstHeader(HttpHeaders.UPGRADE), "Upgrade header must be absent over proxy");
Assertions.assertNull(request.getFirstHeader(HttpHeaders.CONNECTION), "Connection: upgrade must be absent over proxy");
}

@Test
void doesNotAddUpgradeHeadersWhenSchemeIsHttps() throws Exception {
final RequestUpgrade interceptor = new RequestUpgrade();

final HttpClientContext ctx = HttpClientContext.create();
ctx.setRequestConfig(RequestConfig.custom()
.setProtocolUpgradeEnabled(true)
.build());

final BasicClassicHttpRequest request = new BasicClassicHttpRequest("GET", "/");
request.setVersion(HttpVersion.HTTP_1_1);
request.setScheme("https");

interceptor.process(request, null, ctx);

Assertions.assertNull(request.getFirstHeader(HttpHeaders.UPGRADE));
Assertions.assertNull(request.getFirstHeader(HttpHeaders.CONNECTION));
}

@Test
void addsUpgradeHeadersWhenSchemeIsHttp() throws Exception {
final RequestUpgrade interceptor = new RequestUpgrade();

final HttpClientContext ctx = HttpClientContext.create();
ctx.setRequestConfig(RequestConfig.custom()
.setProtocolUpgradeEnabled(true)
.build());

final BasicClassicHttpRequest request = new BasicClassicHttpRequest("GET", "/");
request.setVersion(HttpVersion.HTTP_1_1);
request.setScheme("http");

interceptor.process(request, null, ctx);

Assertions.assertNotNull(request.getFirstHeader(HttpHeaders.UPGRADE));
Assertions.assertNotNull(request.getFirstHeader(HttpHeaders.CONNECTION));
}
}