headroom/crates/headroom-proxy/tests/integration_headers.rs
chopratejas 2e874c5e3e fix: A5 — strip x-headroom-* from upstream-bound headers (P5-49)
Eliminate P5-49: every Python forwarder and the Rust transparent proxy
now drop internal `x-headroom-*` request headers (`x-headroom-bypass`,
`x-headroom-mode`, `x-headroom-user-id`, `x-headroom-stack`,
`x-headroom-base-url`) before the upstream call. Stops fingerprinting
of the proxy by subscription-revocation enforcers and prevents leakage
of internal user-id / stack / base-url internals to whichever vendor
terminates the request.

Python:
- `_strip_internal_headers(headers)` in `headroom/proxy/helpers.py`
  returns a NEW dict with `x-headroom-*` keys removed (case-insensitive
  prefix match, no regex). Pure function. Operator opt-in
  `HEADROOM_STRIP_INTERNAL_HEADERS=disabled` keeps internal headers in
  the upstream-bound dict for diagnostic shadow tracing — explicit, not
  a fallback.
- Strip applied at every handler entry capture in `anthropic.py`,
  `openai.py`, `batch.py`, `gemini.py` (chat completions, responses,
  WebSocket handshake, Copilot passthrough, batch passthroughs, Gemini
  generate / stream / countTokens / cloudcode-assist, Anthropic
  passthrough + batch results). Inbound reads of x-headroom (bypass
  gating, memory user-id) migrated to `request.headers.get(...)` so
  they continue working off the original dict.
- `log_outbound_headers` emits `event=outbound_headers forwarder=...
  stripped_count=N request_id=...` per call. Never logs header values.

Rust (crates/headroom-proxy):
- `strip_internal_headers(&mut HeaderMap)` and `is_internal_header`
  helpers in `src/headers.rs`. `build_forward_request_headers` accepts
  a `strip_internal: bool` so the same path serves HTTP and WebSocket.
- `Config::strip_internal_headers: StripInternalHeaders` driven by CLI
  flag `--strip-internal-headers` and env var
  `HEADROOM_PROXY_STRIP_INTERNAL_HEADERS` (default `enabled`).
- `proxy.rs` and `websocket.rs` call `build_forward_request_headers`
  with the resolved policy; structured `tracing::info!` /
  `tracing::warn!` line per request describes the strip decision.

Tests: 24 Python (`tests/test_header_isolation.py`) + 4 Rust
integration (`crates/headroom-proxy/tests/integration_headers.rs`) +
4 Rust unit tests in `headers.rs`. Covers every named header
(`bypass`, `mode`, `user-id`, `stack`, `base-url`), case-insensitive
prefix matching, legitimate-headers passthrough, the `disabled`
operator-opt-in mode, and that the inbound bypass-gating read path
is unaffected by the strip.

Acceptance: targeted `pytest -x` suite green (87 tests across
test_header_isolation, test_proxy_byte_faithful_forwarding,
test_proxy_anthropic_cache_stability, test_proxy_system_prompt_immutable,
test_proxy_openai_cache_stability, test_proxy_pipeline_lifecycle).
`cargo test -p headroom-proxy` green (23 tests across all integrations
plus 7 lib unit tests). `cargo clippy -p headroom-proxy -- -D warnings`
clean. `cargo fmt --all -- --check` clean. `cargo test --workspace`
green (~900 tests total).

Per realignment build constraints: configurable (env + CLI), no
hardcodes, no regex (pure `.lower().starts_with()` match), no silent
fallbacks (`disabled` is loud operator opt-in), structured logs
(`event=outbound_headers`).

Remaining `x-headroom-` references in `headroom/proxy/handlers/` are
inbound-read sites only: `request.headers.get("x-headroom-bypass")` /
`x-headroom-mode` for behavior gating, `request.headers.get
("x-headroom-user-id")` for memory user-id resolution, and `ws_headers
.get(...)` on the WebSocket inbound path. Response-side `X-Headroom-*`
injection (e.g. `x-headroom-tokens-saved`) is unrelated to upstream
forwarding and untouched.
2026-05-02 09:35:27 -07:00

242 lines
8.4 KiB
Rust

//! Header passthrough + hop-by-hop filtering + X-Forwarded-* injection +
//! internal `x-headroom-*` strip (PR-A5, fixes P5-49).
mod common;
use common::{start_proxy, start_proxy_with};
use headroom_proxy::config::StripInternalHeaders;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};
#[tokio::test]
async fn custom_headers_pass_through_both_ways() {
let upstream = MockServer::start().await;
Mock::given(method("GET"))
.and(path("/h"))
.respond_with(move |req: &wiremock::Request| {
assert_eq!(req.headers.get("authorization").unwrap(), "Bearer foo");
assert_eq!(req.headers.get("x-custom").unwrap(), "bar");
// Hop-by-hop must be stripped from the upstream-side request.
assert!(req.headers.get("transfer-encoding").is_none());
// X-Forwarded-* should be injected.
let xff = req
.headers
.get("x-forwarded-for")
.unwrap()
.to_str()
.unwrap();
assert!(xff.contains("127.0.0.1"));
assert!(req.headers.get("x-forwarded-proto").is_some());
assert!(req.headers.get("x-forwarded-host").is_some());
ResponseTemplate::new(200)
.insert_header("x-server-side", "ack")
.insert_header("x-multi", "v1")
.append_header("x-multi", "v2")
// Hop-by-hop on response side must be stripped by the proxy.
.insert_header("connection", "close")
.set_body_string("done")
})
.mount(&upstream)
.await;
let proxy = start_proxy(&upstream.uri()).await;
let resp = reqwest::Client::new()
.get(format!("{}/h", proxy.url()))
.header("authorization", "Bearer foo")
.header("x-custom", "bar")
.send()
.await
.unwrap();
assert_eq!(resp.status(), 200);
assert_eq!(resp.headers().get("x-server-side").unwrap(), "ack");
assert!(
resp.headers().get("connection").is_none(),
"hop-by-hop must be stripped"
);
let multi: Vec<_> = resp
.headers()
.get_all("x-multi")
.iter()
.map(|v| v.to_str().unwrap().to_string())
.collect();
assert_eq!(multi, vec!["v1".to_string(), "v2".to_string()]);
proxy.shutdown().await;
}
#[tokio::test]
async fn x_headroom_request_headers_stripped() {
let upstream = MockServer::start().await;
Mock::given(method("POST"))
.and(path("/v1/messages"))
.respond_with(move |req: &wiremock::Request| {
// PR-A5: internal x-headroom-* must NOT reach upstream.
assert!(
req.headers.get("x-headroom-bypass").is_none(),
"x-headroom-bypass leaked upstream"
);
assert!(
req.headers.get("x-headroom-mode").is_none(),
"x-headroom-mode leaked upstream"
);
assert!(
req.headers.get("x-headroom-user-id").is_none(),
"x-headroom-user-id leaked upstream"
);
// Legitimate headers must still arrive.
assert_eq!(req.headers.get("authorization").unwrap(), "Bearer sk-x");
assert_eq!(req.headers.get("anthropic-version").unwrap(), "2023-06-01");
ResponseTemplate::new(200).set_body_string("{}")
})
.mount(&upstream)
.await;
let proxy = start_proxy(&upstream.uri()).await;
let resp = reqwest::Client::new()
.post(format!("{}/v1/messages", proxy.url()))
.header("authorization", "Bearer sk-x")
.header("anthropic-version", "2023-06-01")
.header("x-headroom-bypass", "true")
.header("x-headroom-mode", "passthrough")
.header("x-headroom-user-id", "alice")
.body("{}")
.send()
.await
.unwrap();
assert_eq!(resp.status(), 200);
proxy.shutdown().await;
}
#[tokio::test]
async fn x_headroom_case_insensitive_stripped() {
let upstream = MockServer::start().await;
Mock::given(method("POST"))
.and(path("/v1/messages"))
.respond_with(move |req: &wiremock::Request| {
// Mixed-case variants — all should be stripped.
for hdr in [
"x-headroom-foo",
"x-headroom-bar",
"x-headroom-baz",
"X-Headroom-Foo",
"X-HEADROOM-BAR",
] {
assert!(
req.headers.get(hdr).is_none(),
"internal header {hdr} leaked upstream"
);
}
ResponseTemplate::new(200).set_body_string("{}")
})
.mount(&upstream)
.await;
let proxy = start_proxy(&upstream.uri()).await;
let resp = reqwest::Client::new()
.post(format!("{}/v1/messages", proxy.url()))
.header("X-Headroom-Foo", "1")
.header("x-Headroom-Bar", "2")
.header("X-HEADROOM-BAZ", "3")
.body("{}")
.send()
.await
.unwrap();
assert_eq!(resp.status(), 200);
proxy.shutdown().await;
}
#[tokio::test]
async fn legitimate_headers_passthrough_with_strip_enabled() {
let upstream = MockServer::start().await;
Mock::given(method("POST"))
.and(path("/echo"))
.respond_with(move |req: &wiremock::Request| {
// Non-internal x-* headers must NOT be stripped.
assert_eq!(req.headers.get("x-api-key").unwrap(), "k1");
assert_eq!(req.headers.get("x-trace-id").unwrap(), "trace-1");
assert_eq!(req.headers.get("authorization").unwrap(), "Bearer x");
assert_eq!(req.headers.get("anthropic-version").unwrap(), "2023-06-01");
// Strip happened — internal flag absent.
assert!(req.headers.get("x-headroom-bypass").is_none());
ResponseTemplate::new(200)
})
.mount(&upstream)
.await;
let proxy = start_proxy(&upstream.uri()).await;
let resp = reqwest::Client::new()
.post(format!("{}/echo", proxy.url()))
.header("x-api-key", "k1")
.header("x-trace-id", "trace-1")
.header("authorization", "Bearer x")
.header("anthropic-version", "2023-06-01")
.header("x-headroom-bypass", "true")
.body("{}")
.send()
.await
.unwrap();
assert_eq!(resp.status(), 200);
proxy.shutdown().await;
}
#[tokio::test]
async fn disabled_mode_passes_internal_headers_through() {
let upstream = MockServer::start().await;
Mock::given(method("POST"))
.and(path("/v1/messages"))
.respond_with(move |req: &wiremock::Request| {
// Operator opt-in: internal header IS forwarded.
assert_eq!(req.headers.get("x-headroom-bypass").unwrap(), "true");
assert_eq!(req.headers.get("x-headroom-mode").unwrap(), "passthrough");
ResponseTemplate::new(200).set_body_string("{}")
})
.mount(&upstream)
.await;
let proxy = start_proxy_with(&upstream.uri(), |cfg| {
cfg.strip_internal_headers = StripInternalHeaders::Disabled;
})
.await;
let resp = reqwest::Client::new()
.post(format!("{}/v1/messages", proxy.url()))
.header("x-headroom-bypass", "true")
.header("x-headroom-mode", "passthrough")
.body("{}")
.send()
.await
.unwrap();
assert_eq!(resp.status(), 200);
proxy.shutdown().await;
}
#[tokio::test]
async fn xff_appends_existing_value() {
let upstream = MockServer::start().await;
Mock::given(method("GET"))
.and(path("/xff"))
.respond_with(move |req: &wiremock::Request| {
let xff = req
.headers
.get("x-forwarded-for")
.unwrap()
.to_str()
.unwrap();
// existing 1.2.3.4 must be preserved + appended.
assert!(
xff.starts_with("1.2.3.4"),
"expected appended xff, got: {xff}"
);
assert!(xff.contains("127.0.0.1"));
ResponseTemplate::new(200)
})
.mount(&upstream)
.await;
let proxy = start_proxy(&upstream.uri()).await;
let resp = reqwest::Client::new()
.get(format!("{}/xff", proxy.url()))
.header("x-forwarded-for", "1.2.3.4")
.send()
.await
.unwrap();
assert_eq!(resp.status(), 200);
proxy.shutdown().await;
}