Skip to content

Add X-Elastic-Product header on all http responses #73434

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

Merged
merged 7 commits into from
Jun 1, 2021
Merged

Add X-Elastic-Product header on all http responses #73434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
69e6a52
Add product response header to all responses
jbaiera May 26, 2021
d1a7b67
share header value privately across package
jbaiera May 26, 2021
0d396ee
Make the product header lowercase.
jbaiera May 27, 2021
359a1f5
Do not expose the product header if request is unauthenticated.
jbaiera May 27, 2021
280000e
Merge branch 'master' into add-product-response-header
elasticmachine Jun 1, 2021
cbafa3a
Fix checkstyle
jbaiera Jun 1, 2021
9f9c246
Merge branch 'master' into add-product-response-header
elasticmachine Jun 1, 2021
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
4 changes: 4 additions & 0 deletions server/src/main/java/org/elasticsearch/rest/RestController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ public class RestController implements HttpServerTransport.Dispatcher {

private static final Logger logger = LogManager.getLogger(RestController.class);
private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestController.class);
static final String ELASTIC_PRODUCT_HTTP_HEADER = "X-elastic-product";
static final String ELASTIC_PRODUCT_HTTP_HEADER_VALUE = "Elasticsearch";
private static final String ELASTIC_PRODUCT_ORIGIN_HTTP_HEADER = "X-elastic-product-origin";

private static final BytesReference FAVICON_RESPONSE;
Expand Down Expand Up @@ -210,6 +212,7 @@ public void registerHandler(final RestHandler handler) {

@Override
public void dispatchRequest(RestRequest request, RestChannel channel, ThreadContext threadContext) {
threadContext.addResponseHeader(ELASTIC_PRODUCT_HTTP_HEADER, ELASTIC_PRODUCT_HTTP_HEADER_VALUE);
try {
tryAllHandlers(request, channel, threadContext);
} catch (Exception e) {
Expand All @@ -225,6 +228,7 @@ public void dispatchRequest(RestRequest request, RestChannel channel, ThreadCont

@Override
public void dispatchBadRequest(final RestChannel channel, final ThreadContext threadContext, final Throwable cause) {
threadContext.addResponseHeader(ELASTIC_PRODUCT_HTTP_HEADER, ELASTIC_PRODUCT_HTTP_HEADER_VALUE);
try {
final Exception e;
if (cause == null) {
Expand Down
5 changes: 5 additions & 0 deletions server/src/test/java/org/elasticsearch/rest/RestControllerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.junit.Before;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
Expand Down Expand Up @@ -142,6 +143,10 @@ public MethodHandlers next() {
assertEquals("true", threadContext.getHeader("header.1"));
assertEquals("true", threadContext.getHeader("header.2"));
assertNull(threadContext.getHeader("header.3"));
List<String> expectedProductResponseHeader = new ArrayList<>();
expectedProductResponseHeader.add(RestController.ELASTIC_PRODUCT_HTTP_HEADER_VALUE);
assertEquals(expectedProductResponseHeader, threadContext.getResponseHeaders()
.getOrDefault(RestController.ELASTIC_PRODUCT_HTTP_HEADER, null));
}

public void testRequestWithDisallowedMultiValuedHeader() {
Expand Down
5 changes: 4 additions & 1 deletion ...ugin/security/src/main/java/org/elasticsearch/xpack/security/rest/SecurityRestFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,10 @@ private void handleException(String actionType, RestRequest request, RestChannel
@Override
public Map<String, List<String>> filterHeaders(Map<String, List<String>> headers) {
if (headers.containsKey("Warning")) {
return Maps.copyMapWithRemovedEntry(headers, "Warning");
headers = Maps.copyMapWithRemovedEntry(headers, "Warning");
}
if (headers.containsKey("X-elastic-product")) {
headers = Maps.copyMapWithRemovedEntry(headers, "X-elastic-product");
}
return headers;
}
Expand Down