diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAddCookies.java b/httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAddCookies.java index cd6cdac1cd..ad16409e45 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAddCookies.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAddCookies.java @@ -108,23 +108,30 @@ public void process(final HttpRequest request, final EntityDetails entity, final Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); + final HttpClientContext clientContext = HttpClientContext.cast(context); + final String exchangeId = clientContext.getExchangeId(); + + // Discard the CookieSpec and CookieOrigin of a previous exchange executed with + // this context so the response interceptor never processes Set-Cookie headers + // against the origin of another request + clientContext.setCookieSpec(null); + clientContext.setCookieOrigin(null); + final String method = request.getMethod(); if (Method.CONNECT.isSame(method) || Method.TRACE.isSame(method)) { return; } - // Check if a Cookie header is already present + // Check if a Cookie header is already present. The header was not generated + // by this interceptor, so leave the CookieSpec and CookieOrigin unset and let + // the response interceptor skip Set-Cookie processing for this exchange if (request.containsHeader(HttpHeaders.COOKIE)) { if (LOG.isDebugEnabled()) { - LOG.debug("Skipping cookie addition, Cookie header already present in the request"); + LOG.debug("{} Skipping cookie addition, Cookie header already present in the request", exchangeId); } - // Skip adding cookies if the Cookie header is already present return; } - final HttpClientContext clientContext = HttpClientContext.cast(context); - final String exchangeId = clientContext.getExchangeId(); - // Obtain cookie store final CookieStore cookieStore = clientContext.getCookieStore(); if (cookieStore == null) { diff --git a/httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestAddCookies.java b/httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestAddCookies.java index f59631082c..4320de6da0 100644 --- a/httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestAddCookies.java +++ b/httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestAddCookies.java @@ -488,6 +488,59 @@ void testSkipAddingCookiesWhenCookieHeaderPresent() throws Exception { Assertions.assertEquals(1, headers.length); Assertions.assertEquals("existingCookie=existingValue", headers[0].getValue()); } + + @Test + void testCookieOriginResetWhenCookieHeaderPresent() throws Exception { + final HttpClientContext context = HttpClientContext.create(); + context.setCookieStore(this.cookieStore); + context.setCookieSpecRegistry(this.cookieSpecRegistry); + + final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; + + // First exchange on this context: cookies are matched for localhost.local + final HttpRequest request1 = new BasicHttpRequest("GET", this.target, "/"); + context.setRoute(new HttpRoute(this.target, null, false)); + interceptor.process(request1, null, context); + Assertions.assertEquals("localhost.local", context.getCookieOrigin().getHost()); + + // Second exchange on the same context to a different host with an explicit Cookie header + final HttpHost otherHost = new HttpHost("other.local", 80); + final HttpRequest request2 = new BasicHttpRequest("GET", otherHost, "/stuff/"); + request2.addHeader("Cookie", "existingCookie=existingValue"); + context.setRoute(new HttpRoute(otherHost, null, false)); + interceptor.process(request2, null, context); + + final Header[] headers = request2.getHeaders("Cookie"); + Assertions.assertEquals(1, headers.length); + Assertions.assertEquals("existingCookie=existingValue", headers[0].getValue()); + + // The Cookie header was set by the caller: no CookieSpec / CookieOrigin, and nothing + // left over from the previous exchange for the response interceptor to act on + Assertions.assertNull(context.getCookieOrigin()); + Assertions.assertNull(context.getCookieSpec()); + } + + @Test + void testCookieOriginResetForTraceRequest() throws Exception { + final HttpClientContext context = HttpClientContext.create(); + context.setCookieStore(this.cookieStore); + context.setCookieSpecRegistry(this.cookieSpecRegistry); + + final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; + + final HttpRequest request1 = new BasicHttpRequest("GET", this.target, "/"); + context.setRoute(new HttpRoute(this.target, null, false)); + interceptor.process(request1, null, context); + Assertions.assertNotNull(context.getCookieOrigin()); + + final HttpHost otherHost = new HttpHost("other.local", 80); + final HttpRequest request2 = new BasicHttpRequest("TRACE", otherHost, "/"); + context.setRoute(new HttpRoute(otherHost, null, false)); + interceptor.process(request2, null, context); + + Assertions.assertNull(context.getCookieOrigin()); + Assertions.assertNull(context.getCookieSpec()); + } @Test void testAddCookiesWithRequestPathContainingQuery() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/stuff?foo=bar");