You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "github-advanced-security[bot] (via GitHub)" <gi...@apache.org> on 2026/06/09 20:15:18 UTC
Re: [PR] feat: Propagate Request Headers (druid)
github-advanced-security[bot] commented on code in PR #19572:
URL: https://github.com/apache/druid/pull/19572#discussion_r3383572243
##########
server/src/main/java/org/apache/druid/client/DirectDruidClient.java:
##########
@@ -471,18 +490,18 @@
// we can increment the count earlier so that we can route the request to a different server
openConnections.getAndIncrement();
try {
- future = httpClient.go(
- new Request(
- HttpMethod.POST,
- new URL(url)
- ).setContent(objectMapper.writeValueAsBytes(Queries.withTimeout(query, timeLeft)))
- .setHeader(
- HttpHeaders.Names.CONTENT_TYPE,
- isSmile ? SmileMediaTypes.APPLICATION_JACKSON_SMILE : MediaType.APPLICATION_JSON
- ),
- responseHandler,
- Duration.millis(timeLeft)
- );
+ final Request outbound = new Request(HttpMethod.POST, new URL(url))
Review Comment:
## CodeQL / Deprecated method or constructor invocation
Invoking [URL.URL](1) should be avoided because it has been deprecated.
[Show more details](https://github.com/apache/druid/security/code-scanning/11299)
##########
processing/src/main/java/org/apache/druid/audit/RequestHeaderContextConfig.java:
##########
@@ -0,0 +1,133 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.apache.druid.audit;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableSet;
+import org.apache.druid.error.DruidException;
+import org.apache.druid.query.BaseQuery;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.function.BiConsumer;
+
+/**
+ * Configures which inbound HTTP headers are captured and where they're stored in the
+ * {@link org.apache.druid.query.Query} context. The map is keyed by header name (case as
+ * sent on the wire) and the value is the reserved context key.
+ *
+ * <p>Defaults: {@code X-Druid-Trace-Id → traceId} so trace propagation works out of the
+ * box. Operators can extend by setting:
+ * <pre>
+ * druid.audit.requestHeaders.headerToContextKey={"X-Druid-Trace-Id": "traceId",
+ * "X-Custom-Foo": "foo"}
+ * </pre>
+ *
+ * <p>The values in this map are reserved context keys: user-supplied values for these keys
+ * are stripped from the query context before the filter-captured value is merged
+ * (anti-spoof). Setting overlapping keys to existing query-context keys is therefore
+ * discouraged — pick context-key names that don't collide with standard Druid context.
+ */
+public class RequestHeaderContextConfig
+{
+ private static final Map<String, String> DEFAULT_HEADER_TO_CONTEXT_KEY = ImmutableMap.of(
+ AuditManager.X_DRUID_TRACE_ID, "traceId"
+ );
+
+ /**
+ * Context keys that are server-managed by Druid and must not be configurable as targets
+ * for header propagation. Mapping a header to one of these would let a client overwrite
+ * the server-assigned value (e.g. the random per-request {@code queryId}), breaking
+ * query identification, cancellation, and metric correlation.
+ */
+ private static final Set<String> RESERVED_DRUID_CONTEXT_KEYS = ImmutableSet.of(
+ BaseQuery.QUERY_ID,
+ BaseQuery.SUB_QUERY_ID,
+ BaseQuery.SQL_QUERY_ID
+ );
+
+ private final Map<String, String> headerToContextKey;
+
+ public RequestHeaderContextConfig()
+ {
+ this(DEFAULT_HEADER_TO_CONTEXT_KEY);
+ }
+
+ /**
+ * @param headerToContextKey explicit mapping; null means "use defaults" (the typical case
+ * when {@code JsonConfigProvider} deserializes from an empty config block);
+ * {@link java.util.Collections#emptyMap()} explicitly disables propagation.
+ */
+ @JsonCreator
+ public RequestHeaderContextConfig(
+ @JsonProperty("headerToContextKey") Map<String, String> headerToContextKey
+ )
+ {
+ final Map<String, String> raw = headerToContextKey == null
+ ? DEFAULT_HEADER_TO_CONTEXT_KEY
+ : headerToContextKey;
+ for (String contextKey : raw.values()) {
+ if (RESERVED_DRUID_CONTEXT_KEYS.contains(contextKey)) {
+ throw DruidException.forPersona(DruidException.Persona.OPERATOR)
+ .ofCategory(DruidException.Category.INVALID_INPUT)
+ .build(
+ "druid.audit.requestHeaders.headerToContextKey maps a header to "
+ + "reserved Druid context key[%s]; this would let a client overwrite "
+ + "the server-assigned value. Reserved keys are %s.",
+ contextKey, RESERVED_DRUID_CONTEXT_KEYS
+ );
+ }
+ }
+ this.headerToContextKey = ImmutableMap.copyOf(raw);
+ }
+
+ /**
+ * Returns the configured map of {@code header → context-key}. Immutable. Empty means
+ * no header propagation is performed (the feature is effectively disabled).
+ */
+ @JsonProperty
+ public Map<String, String> getHeaderToContextKey()
Review Comment:
## CodeQL / Exposing internal representation
getHeaderToContextKey exposes the internal representation stored in field headerToContextKey. The value may be modified [after this call to getHeaderToContextKey](1).
[Show more details](https://github.com/apache/druid/security/code-scanning/11300)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org