diff --git a/.claude/settings.json b/.claude/settings.json index 02b602d4f..b7b0afdc5 100644 --- a/.claude/settings.json +++ b/.claude/settings.json @@ -25,7 +25,7 @@ "Bash(git status:*)", "mcp__plugin_chrome-devtools-mcp_chrome-devtools__new_page", "mcp__plugin_chrome-devtools-mcp_chrome-devtools__performance_stop_trace", - "mcp__plugin_chrome-devtools-mcp_chrome-devtools__evaluate_script", + "mcp__plugin_chrome-devtools-mcp_chrome-devtools__evaluate_script" ] }, "enabledPlugins": { diff --git a/Cargo.lock b/Cargo.lock index 942d5f64b..55289366e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -750,7 +750,7 @@ dependencies = [ [[package]] name = "edgezero-adapter-fastly" version = "0.1.0" -source = "git+https://github.com/stackpop/edgezero?rev=170b74b#170b74bd2c9933b7d561f7ccdb67c53b239e9527" +source = "git+https://github.com/stackpop/edgezero?rev=38198f9839b70aef03ab971ae5876982773fc2a1#38198f9839b70aef03ab971ae5876982773fc2a1" dependencies = [ "anyhow", "async-stream", @@ -771,7 +771,7 @@ dependencies = [ [[package]] name = "edgezero-core" version = "0.1.0" -source = "git+https://github.com/stackpop/edgezero?rev=170b74b#170b74bd2c9933b7d561f7ccdb67c53b239e9527" +source = "git+https://github.com/stackpop/edgezero?rev=38198f9839b70aef03ab971ae5876982773fc2a1#38198f9839b70aef03ab971ae5876982773fc2a1" dependencies = [ "anyhow", "async-compression", @@ -799,7 +799,7 @@ dependencies = [ [[package]] name = "edgezero-macros" version = "0.1.0" -source = "git+https://github.com/stackpop/edgezero?rev=170b74b#170b74bd2c9933b7d561f7ccdb67c53b239e9527" +source = "git+https://github.com/stackpop/edgezero?rev=38198f9839b70aef03ab971ae5876982773fc2a1#38198f9839b70aef03ab971ae5876982773fc2a1" dependencies = [ "log", "proc-macro2", diff --git a/Cargo.toml b/Cargo.toml index 9f2f4c673..3569066cd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -56,10 +56,10 @@ config = "0.15.19" cookie = "0.18.1" derive_more = { version = "2.0", features = ["display", "error"] } ed25519-dalek = { version = "2.2", features = ["rand_core"] } -edgezero-adapter-axum = { git = "https://github.com/stackpop/edgezero", rev = "170b74b", default-features = false } -edgezero-adapter-cloudflare = { git = "https://github.com/stackpop/edgezero", rev = "170b74b", default-features = false } -edgezero-adapter-fastly = { git = "https://github.com/stackpop/edgezero", rev = "170b74b", default-features = false } -edgezero-core = { git = "https://github.com/stackpop/edgezero", rev = "170b74b", default-features = false } +edgezero-adapter-axum = { git = "https://github.com/stackpop/edgezero", rev = "38198f9839b70aef03ab971ae5876982773fc2a1", default-features = false } +edgezero-adapter-cloudflare = { git = "https://github.com/stackpop/edgezero", rev = "38198f9839b70aef03ab971ae5876982773fc2a1", default-features = false } +edgezero-adapter-fastly = { git = "https://github.com/stackpop/edgezero", rev = "38198f9839b70aef03ab971ae5876982773fc2a1", default-features = false } +edgezero-core = { git = "https://github.com/stackpop/edgezero", rev = "38198f9839b70aef03ab971ae5876982773fc2a1", default-features = false } error-stack = "0.6" fastly = "0.11.12" fern = "0.7.1" @@ -83,7 +83,8 @@ sha2 = "0.10.9" subtle = "2.6" temp-env = "0.3.6" tokio = { version = "1.49", features = ["sync", "macros", "io-util", "rt", "time"] } -toml = "1.0" +tokio-test = "0.4" +toml = "1.1" trusted-server-core = { path = "crates/trusted-server-core" } url = "2.5.8" urlencoding = "2.1" diff --git a/crates/trusted-server-adapter-fastly/src/app.rs b/crates/trusted-server-adapter-fastly/src/app.rs new file mode 100644 index 000000000..6123d6546 --- /dev/null +++ b/crates/trusted-server-adapter-fastly/src/app.rs @@ -0,0 +1,535 @@ +//! Full `EdgeZero` application wiring for Trusted Server. +//! +//! Registers all routes from the legacy [`crate::route_request`] into a +//! [`RouterService`], attaches [`FinalizeResponseMiddleware`] (outermost) and +//! [`AuthMiddleware`] (inner), and builds the [`AppState`] once per Wasm +//! instance. +//! +//! # Route inventory +//! +//! | Method | Path pattern | Handler | +//! |--------|-------------|---------| +//! | GET | `/.well-known/trusted-server.json` | [`handle_trusted_server_discovery`] | +//! | POST | `/verify-signature` | [`handle_verify_signature`] | +//! | POST | `/admin/keys/rotate` | [`handle_rotate_key`] | +//! | POST | `/admin/keys/deactivate` | [`handle_deactivate_key`] | +//! | POST | `/auction` | [`handle_auction`] | +//! | GET | `/first-party/proxy` | [`handle_first_party_proxy`] | +//! | GET | `/first-party/click` | [`handle_first_party_click`] | +//! | GET | `/first-party/sign` | [`handle_first_party_proxy_sign`] | +//! | POST | `/first-party/sign` | [`handle_first_party_proxy_sign`] | +//! | POST | `/first-party/proxy-rebuild` | [`handle_first_party_proxy_rebuild`] | +//! | GET | `/` and `/{*rest}` | tsjs (if `/static/tsjs=` prefix), integration proxy, or publisher fallback | +//! | POST, HEAD, OPTIONS, PUT, PATCH, DELETE | `/` and `/{*rest}` | integration proxy or publisher fallback | +//! +//! # Startup error handling +//! +//! When [`build_state`] fails, [`startup_error_router`] returns a minimal router +//! that responds to all routes with the startup error. This router does **not** +//! attach middleware — startup errors are returned without geo or TS headers. + +use core::future::Future; +use std::sync::Arc; + +use edgezero_adapter_fastly::FastlyRequestContext; +use edgezero_core::app::Hooks; +use edgezero_core::context::RequestContext; +use edgezero_core::error::EdgeError; +use edgezero_core::http::{header, HeaderValue, Method, Request, Response}; +use edgezero_core::router::RouterService; +use error_stack::Report; +use trusted_server_core::auction::endpoints::handle_auction; +use trusted_server_core::auction::{build_orchestrator, AuctionOrchestrator}; +use trusted_server_core::error::{IntoHttpResponse as _, TrustedServerError}; +use trusted_server_core::integrations::IntegrationRegistry; +use trusted_server_core::platform::{ClientInfo, PlatformKvStore, RuntimeServices}; +use trusted_server_core::proxy::{ + handle_first_party_click, handle_first_party_proxy, handle_first_party_proxy_rebuild, + handle_first_party_proxy_sign, +}; +use trusted_server_core::publisher::{handle_publisher_request, handle_tsjs_dynamic}; +use trusted_server_core::request_signing::{ + handle_deactivate_key, handle_rotate_key, handle_trusted_server_discovery, + handle_verify_signature, +}; +use trusted_server_core::settings::Settings; +use trusted_server_core::settings_data::get_settings; + +use crate::middleware::{AuthMiddleware, FinalizeResponseMiddleware}; +use crate::platform::{ + FastlyPlatformBackend, FastlyPlatformConfigStore, FastlyPlatformGeo, FastlyPlatformHttpClient, + FastlyPlatformSecretStore, UnavailableKvStore, +}; + +// --------------------------------------------------------------------------- +// AppState +// --------------------------------------------------------------------------- + +/// Application state built once per Wasm instance and shared for its lifetime. +/// +/// In Fastly Compute each request spawns a new Wasm instance, so this struct is +/// effectively per-request. It holds pre-parsed settings and all service handles. +pub(crate) struct AppState { + pub(crate) settings: Arc, + pub(crate) orchestrator: Arc, + pub(crate) registry: Arc, + pub(crate) kv_store: Arc, +} + +/// Build the application state, loading settings and constructing all per-application components. +/// +/// # Errors +/// +/// Returns an error when settings, the auction orchestrator, or the integration +/// registry fail to initialise. +pub(crate) fn build_state() -> Result, Report> { + let settings = get_settings()?; + + let orchestrator = build_orchestrator(&settings)?; + + let registry = IntegrationRegistry::new(&settings)?; + + let kv_store = Arc::new(UnavailableKvStore) as Arc; + + Ok(Arc::new(AppState { + settings: Arc::new(settings), + orchestrator: Arc::new(orchestrator), + registry: Arc::new(registry), + kv_store, + })) +} + +// --------------------------------------------------------------------------- +// Per-request RuntimeServices +// --------------------------------------------------------------------------- + +/// Construct per-request [`RuntimeServices`] from the `EdgeZero` request context. +/// +/// Extracts the client IP address from the [`FastlyRequestContext`] extension +/// inserted by `edgezero_adapter_fastly::dispatch`. TLS metadata is not +/// available through the `EdgeZero` context so those fields are left empty. +fn build_per_request_services(state: &AppState, ctx: &RequestContext) -> RuntimeServices { + let client_ip = FastlyRequestContext::get(ctx.request()).and_then(|c| c.client_ip); + + RuntimeServices::builder() + .config_store(Arc::new(FastlyPlatformConfigStore)) + .secret_store(Arc::new(FastlyPlatformSecretStore)) + .kv_store(Arc::clone(&state.kv_store)) + .backend(Arc::new(FastlyPlatformBackend)) + .http_client(Arc::new(FastlyPlatformHttpClient)) + .geo(Arc::new(FastlyPlatformGeo)) + .client_info(ClientInfo { + client_ip, + tls_protocol: None, + tls_cipher: None, + }) + .build() +} + +fn publisher_fallback_methods() -> [Method; 7] { + [ + Method::GET, + Method::POST, + Method::HEAD, + Method::OPTIONS, + Method::PUT, + Method::PATCH, + Method::DELETE, + ] +} + +fn uses_dynamic_tsjs_fallback(method: &Method, path: &str) -> bool { + *method == Method::GET && path.starts_with("/static/tsjs=") +} + +async fn execute_handler( + state: Arc, + ctx: RequestContext, + handler: F, +) -> Result +where + F: FnOnce(Arc, RuntimeServices, Request) -> Fut, + Fut: Future>>, +{ + let services = build_per_request_services(&state, &ctx); + let req = ctx.into_request(); + + Ok(handler(state, services, req) + .await + .unwrap_or_else(|e| http_error(&e))) +} + +async fn dispatch_fallback( + state: &AppState, + services: &RuntimeServices, + req: Request, +) -> Result> { + let path = req.uri().path().to_string(); + let method = req.method().clone(); + + if uses_dynamic_tsjs_fallback(&method, &path) { + return handle_tsjs_dynamic(&req, &state.registry); + } + + if state.registry.has_route(&method, &path) { + return state + .registry + .handle_proxy(&method, &path, &state.settings, services, req) + .await + .unwrap_or_else(|| { + Err(Report::new(TrustedServerError::BadRequest { + message: format!("Unknown integration route: {path}"), + })) + }); + } + + handle_publisher_request(&state.settings, &state.registry, services, req) + .await + .and_then(|pub_response| { + crate::resolve_publisher_response(pub_response, &state.settings, &state.registry) + }) +} + +// --------------------------------------------------------------------------- +// Error helper +// --------------------------------------------------------------------------- + +/// Convert a [`Report`] into an HTTP [`Response`], +/// mirroring [`crate::http_error_response`] exactly. +/// +/// The near-identical function in `main.rs` is intentional: the legacy path +/// uses fastly HTTP types while this path uses `edgezero_core` types. The +/// duplication will be removed when `legacy_main` is deleted in PR 15. +pub(crate) fn http_error(report: &Report) -> Response { + let root_error = report.current_context(); + log::error!("Error occurred: {:?}", report); + + let body = edgezero_core::body::Body::from(format!("{}\n", root_error.user_message())); + let mut response = Response::new(body); + *response.status_mut() = root_error.status_code(); + response.headers_mut().insert( + header::CONTENT_TYPE, + HeaderValue::from_static("text/plain; charset=utf-8"), + ); + response +} + +// --------------------------------------------------------------------------- +// Startup error fallback +// --------------------------------------------------------------------------- + +/// Returns a [`RouterService`] that responds to every registered route with the startup error. +/// +/// Called when [`build_state`] fails so that request handling degrades to a +/// structured HTTP error response rather than an unrecoverable panic. +fn startup_error_router(e: &Report) -> RouterService { + let message = Arc::new(format!("{}\n", e.current_context().user_message())); + let status = e.current_context().status_code(); + + let make = move |msg: Arc| { + move |_ctx: RequestContext| { + let body = edgezero_core::body::Body::from((*msg).clone()); + let mut resp = Response::new(body); + *resp.status_mut() = status; + resp.headers_mut().insert( + header::CONTENT_TYPE, + HeaderValue::from_static("text/plain; charset=utf-8"), + ); + async move { Ok::(resp) } + } + }; + + let mut router = RouterService::builder(); + for method in publisher_fallback_methods() { + router = router.route("/", method.clone(), make(Arc::clone(&message))); + router = router.route("/{*rest}", method, make(Arc::clone(&message))); + } + router.build() +} + +// --------------------------------------------------------------------------- +// TrustedServerApp +// --------------------------------------------------------------------------- + +/// `EdgeZero` [`Hooks`] implementation for the Trusted Server application. +pub struct TrustedServerApp; + +impl Hooks for TrustedServerApp { + fn name() -> &'static str { + "TrustedServer" + } + + fn routes() -> RouterService { + let state = match build_state() { + Ok(s) => s, + Err(ref e) => { + log::error!("failed to build application state: {:?}", e); + return startup_error_router(e); + } + }; + + // Each named route only selects its core handler; the request/context + // scaffolding and Report -> HTTP mapping live in execute_handler(). + let s = Arc::clone(&state); + let discovery_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_trusted_server_discovery(&state.settings, &services, req) + }) + }; + + let s = Arc::clone(&state); + let verify_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_verify_signature(&state.settings, &services, req) + }) + }; + + let s = Arc::clone(&state); + let rotate_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_rotate_key(&state.settings, &services, req) + }) + }; + + let s = Arc::clone(&state); + let deactivate_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_deactivate_key(&state.settings, &services, req) + }) + }; + + let s = Arc::clone(&state); + let auction_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_auction(&state.settings, &state.orchestrator, &services, req).await + }) + }; + + let s = Arc::clone(&state); + let fp_proxy_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_first_party_proxy(&state.settings, &services, req).await + }) + }; + + let s = Arc::clone(&state); + let fp_click_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_first_party_click(&state.settings, &services, req).await + }) + }; + + let s = Arc::clone(&state); + let fp_sign_get_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_first_party_proxy_sign(&state.settings, &services, req).await + }) + }; + + let s = Arc::clone(&state); + let fp_sign_post_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_first_party_proxy_sign(&state.settings, &services, req).await + }) + }; + + let s = Arc::clone(&state); + let fp_rebuild_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + handle_first_party_proxy_rebuild(&state.settings, &services, req).await + }) + }; + + let s = Arc::clone(&state); + let fallback_handler = move |ctx: RequestContext| { + let s = Arc::clone(&s); + execute_handler(s, ctx, |state, services, req| async move { + dispatch_fallback(&state, &services, req).await + }) + }; + + let mut router = RouterService::builder() + .middleware(FinalizeResponseMiddleware::new( + Arc::clone(&state.settings), + Arc::new(FastlyPlatformGeo), + )) + .middleware(AuthMiddleware::new(Arc::clone(&state.settings))) + .get("/.well-known/trusted-server.json", discovery_handler) + .post("/verify-signature", verify_handler) + .post("/admin/keys/rotate", rotate_handler) + .post("/admin/keys/deactivate", deactivate_handler) + .post("/auction", auction_handler) + .get("/first-party/proxy", fp_proxy_handler) + .get("/first-party/click", fp_click_handler) + .get("/first-party/sign", fp_sign_get_handler) + .post("/first-party/sign", fp_sign_post_handler) + .post("/first-party/proxy-rebuild", fp_rebuild_handler); + + // matchit's `/{*rest}` does not match the bare root `/` — register + // explicit root routes so `/` reaches the publisher fallback too. + for method in publisher_fallback_methods() { + router = router.route("/", method.clone(), fallback_handler.clone()); + router = router.route("/{*rest}", method, fallback_handler.clone()); + } + + router.build() + } +} + +#[cfg(test)] +mod tests { + use super::{startup_error_router, TrustedServerApp}; + + use edgezero_core::app::Hooks as _; + use edgezero_core::body::Body; + use edgezero_core::http::{header, request_builder, Method, StatusCode}; + use error_stack::Report; + use futures::executor::block_on; + use trusted_server_core::constants::HEADER_X_GEO_INFO_AVAILABLE; + use trusted_server_core::error::TrustedServerError; + + fn empty_request(method: Method, uri: &str) -> edgezero_core::http::Request { + request_builder() + .method(method) + .uri(uri) + .body(Body::empty()) + .expect("should build request") + } + + #[test] + fn startup_error_router_handles_head_and_options() { + let report = Report::new(TrustedServerError::BadRequest { + message: "startup failed".to_string(), + }); + let router = startup_error_router(&report); + + let head_response = block_on(router.oneshot(empty_request(Method::HEAD, "/"))); + let options_response = block_on(router.oneshot(empty_request(Method::OPTIONS, "/any"))); + + assert_eq!( + head_response.status(), + StatusCode::BAD_REQUEST, + "HEAD should use the degraded startup-error response" + ); + assert_eq!( + options_response.status(), + StatusCode::BAD_REQUEST, + "OPTIONS should use the degraded startup-error response" + ); + assert_eq!( + head_response + .headers() + .get(header::CONTENT_TYPE) + .and_then(|value| value.to_str().ok()), + Some("text/plain; charset=utf-8"), + "startup errors should stay plain-text for HEAD requests" + ); + assert_eq!( + options_response + .headers() + .get(header::CONTENT_TYPE) + .and_then(|value| value.to_str().ok()), + Some("text/plain; charset=utf-8"), + "startup errors should stay plain-text for OPTIONS requests" + ); + } + + #[test] + fn dynamic_tsjs_fallback_is_get_only() { + assert!( + super::uses_dynamic_tsjs_fallback(&Method::GET, "/static/tsjs=tsjs-unified.js"), + "GET should use the dynamic tsjs shortcut" + ); + assert!( + !super::uses_dynamic_tsjs_fallback(&Method::HEAD, "/static/tsjs=tsjs-unified.js"), + "HEAD should fall through to the publisher/integration fallback" + ); + assert!( + !super::uses_dynamic_tsjs_fallback(&Method::OPTIONS, "/static/tsjs=tsjs-unified.js"), + "OPTIONS should fall through to the publisher/integration fallback" + ); + } + + // --------------------------------------------------------------------------- + // Full EdgeZero dispatch-path tests + // --------------------------------------------------------------------------- + + #[test] + fn dispatch_auth_rejected_401_carries_finalize_headers() { + // Verifies FinalizeResponseMiddleware is outermost: an auth-rejected 401 + // must still carry standard TS headers before reaching the client. + // + // The embedded trusted-server.toml protects `^/admin` with basic-auth. + // Sending the request without an Authorization header causes AuthMiddleware + // to short-circuit with a 401, which then bubbles through + // FinalizeResponseMiddleware for header injection. + // + // This is safe to run without Viceroy: enforce_basic_auth is pure Rust + // (reads settings + request headers only) and FastlyPlatformGeo.lookup(None) + // short-circuits without calling any Fastly ABI. + let router = TrustedServerApp::routes(); + let req = request_builder() + .method(Method::POST) + .uri("/admin/keys/rotate") + .body(Body::empty()) + .expect("should build test request"); + + let response = block_on(router.oneshot(req)); + + assert_eq!( + response.status(), + StatusCode::UNAUTHORIZED, + "request without credentials should be rejected" + ); + assert_eq!( + response + .headers() + .get(HEADER_X_GEO_INFO_AVAILABLE) + .and_then(|v| v.to_str().ok()), + Some("false"), + "FinalizeResponseMiddleware must run even for auth-rejected responses" + ); + } + + #[test] + fn dispatch_unregistered_method_returns_405_at_router_level() { + // Documents the known router-level behavior for unregistered HTTP methods: + // the RouterService returns 405 before the middleware chain runs, so + // FinalizeResponseMiddleware does not inject TS headers at this layer. + // + // The full-system guarantee (TS headers on ALL responses) is maintained + // by the entry-point finalize wrap in main.rs, which is idempotent for + // requests that did run through the middleware chain. + let router = TrustedServerApp::routes(); + let req = request_builder() + .method(Method::from_bytes(b"TRACE").expect("should parse TRACE")) + .uri("/") + .body(Body::empty()) + .expect("should build TRACE request"); + + let response = block_on(router.oneshot(req)); + + assert_eq!( + response.status(), + StatusCode::METHOD_NOT_ALLOWED, + "unregistered method should return 405 from the router layer" + ); + assert!( + response + .headers() + .get(HEADER_X_GEO_INFO_AVAILABLE) + .is_none(), + "router-level 405 bypasses FinalizeResponseMiddleware; main.rs entry-point covers this" + ); + } +} diff --git a/crates/trusted-server-adapter-fastly/src/main.rs b/crates/trusted-server-adapter-fastly/src/main.rs index fe42c2d44..2876667cf 100644 --- a/crates/trusted-server-adapter-fastly/src/main.rs +++ b/crates/trusted-server-adapter-fastly/src/main.rs @@ -1,22 +1,19 @@ use edgezero_core::body::Body as EdgeBody; use edgezero_core::http::{ - header, HeaderName, HeaderValue, Method, Request as HttpRequest, Response as HttpResponse, + header, HeaderValue, Method, Request as HttpRequest, Response as HttpResponse, }; use error_stack::Report; use fastly::http::Method as FastlyMethod; -use fastly::{Request as FastlyRequest, Response as FastlyResponse}; +use fastly::{Error, Request as FastlyRequest, Response as FastlyResponse}; use trusted_server_core::auction::endpoints::handle_auction; -use trusted_server_core::auction::{build_orchestrator, AuctionOrchestrator}; +use trusted_server_core::auction::AuctionOrchestrator; use trusted_server_core::auth::enforce_basic_auth; use trusted_server_core::compat; -use trusted_server_core::constants::{ - ENV_FASTLY_IS_STAGING, ENV_FASTLY_SERVICE_VERSION, HEADER_X_GEO_INFO_AVAILABLE, - HEADER_X_TS_ENV, HEADER_X_TS_VERSION, -}; use trusted_server_core::error::{IntoHttpResponse, TrustedServerError}; use trusted_server_core::geo::GeoInfo; use trusted_server_core::integrations::IntegrationRegistry; +use trusted_server_core::platform::PlatformGeo as _; use trusted_server_core::platform::RuntimeServices; use trusted_server_core::proxy::{ handle_first_party_click, handle_first_party_proxy, handle_first_party_proxy_rebuild, @@ -32,77 +29,131 @@ use trusted_server_core::request_signing::{ use trusted_server_core::settings::Settings; use trusted_server_core::settings_data::get_settings; +mod app; mod error; mod logging; mod management_api; +mod middleware; mod platform; #[cfg(test)] mod route_tests; +use crate::app::{build_state, TrustedServerApp}; use crate::error::to_error_response; -use crate::logging::init_logger; -use crate::platform::{build_runtime_services, open_kv_store, UnavailableKvStore}; +use crate::middleware::apply_finalize_headers; +use crate::platform::{build_runtime_services, open_kv_store, FastlyPlatformGeo}; +use edgezero_core::app::Hooks as _; -/// Entry point for the Fastly Compute program. +/// Returns `true` if the raw config-store value represents an enabled flag. /// -/// Uses an undecorated `main()` with `FastlyRequest::from_client()` instead of -/// `#[fastly::main]` so we can call `send_to_client()` explicitly when needed. -fn main() { - init_logger(); +/// Accepted values (after whitespace trimming): `"true"` and `"1"`. +/// All other values, including the empty string, are treated as disabled. +fn parse_edgezero_flag(value: &str) -> bool { + let v = value.trim(); + v.eq_ignore_ascii_case("true") || v == "1" +} - let mut req = FastlyRequest::from_client(); +/// Reads the `edgezero_enabled` key from the `"trusted_server_config"` Fastly +/// [`ConfigStore`]. +/// +/// Returns `Err` on any store open or key-read failure, so callers should use +/// `.unwrap_or(false)` to ensure the legacy path is the safe default. +/// +/// # Errors +/// +/// - [`fastly::Error`] if the config store cannot be opened or the key cannot be read. +fn is_edgezero_enabled() -> Result { + let store = fastly::ConfigStore::try_open("trusted_server_config") + .map_err(|e| fastly::Error::msg(format!("failed to open config store: {e}")))?; + let value = store + .try_get("edgezero_enabled") + .map_err(|e| fastly::Error::msg(format!("failed to read edgezero_enabled: {e}")))? + .unwrap_or_default(); + Ok(parse_edgezero_flag(&value)) +} - // Keep the health probe independent from settings loading and routing so - // readiness checks still get a cheap liveness response during startup. +#[fastly::main] +fn main(mut req: FastlyRequest) -> Result { + // Health probe bypasses routing, settings, and app construction — cheap liveness signal. if req.get_method() == FastlyMethod::GET && req.get_path() == "/health" { - FastlyResponse::from_status(200) - .with_body_text_plain("ok") - .send_to_client(); - return; + return Ok(FastlyResponse::from_status(200).with_body_text_plain("ok")); } - let settings = match get_settings() { - Ok(s) => s, - Err(e) => { - log::error!("Failed to load settings: {:?}", e); - to_error_response(&e).send_to_client(); - return; - } - }; - log::debug!("Settings {settings:?}"); - - // Build the auction orchestrator once at startup - let orchestrator = match build_orchestrator(&settings) { - Ok(o) => o, - Err(e) => { - log::error!("Failed to build auction orchestrator: {:?}", e); - to_error_response(&e).send_to_client(); - return; + logging::init_logger(); + + // Safe default: if the flag cannot be read (store unavailable, key missing), + // fall back to the legacy path to avoid accidentally routing through an + // untested EdgeZero path. + if is_edgezero_enabled().unwrap_or_else(|e| { + log::warn!("failed to read edgezero_enabled flag, falling back to legacy path: {e}"); + false + }) { + log::debug!("routing request through EdgeZero path"); + let app = TrustedServerApp::build_app(); + // Strip client-spoofable forwarded headers before handing off to the + // EdgeZero dispatcher, mirroring the sanitization done in legacy_main. + compat::sanitize_fastly_forwarded_headers(&mut req); + // Capture client IP before the request is consumed by dispatch. + let client_ip = req.get_client_ip_addr(); + // `run_app_with_config` and `run_app_with_logging` call `init_logger` + // internally — a second `set_logger` call panics because our custom + // fern logger is already initialised above. `dispatch_with_config` + // skips logger initialisation and injects the config store directly. + let mut response = compat::from_fastly_response( + edgezero_adapter_fastly::dispatch_with_config(&app, req, "trusted_server_config")?, + ); + // Apply finalize headers at the entry point so that router-level 405/404 + // responses for unregistered HTTP methods (e.g. TRACE, WebDAV verbs) + // carry TS/geo headers, matching the legacy path's all-methods guarantee. + // For requests that ran through FinalizeResponseMiddleware, this is + // idempotent — header::insert overwrites with the same values. + if let Ok(settings) = get_settings() { + let geo_info = FastlyPlatformGeo.lookup(client_ip).unwrap_or_else(|e| { + log::warn!("entry-point geo lookup failed: {e}"); + None + }); + apply_finalize_headers(&settings, geo_info.as_ref(), &mut response); } - }; + Ok(compat::to_fastly_response(response)) + } else { + log::debug!("routing request through legacy path"); + legacy_main(req) + } +} - let integration_registry = match IntegrationRegistry::new(&settings) { - Ok(r) => r, +/// Handles a request using the original Fastly-native entry point. +/// +/// Preserves identical semantics to the pre-PR14 `main()`. Called when +/// the `edgezero_enabled` config flag is absent or `false`. +/// +/// The thin fastly↔http conversion layer (via `compat::from_fastly_request` / +/// `compat::to_fastly_response`) lives here in the adapter crate. `compat.rs` +/// will be deleted in PR 15 once this legacy path is retired. +/// +/// # Errors +/// +/// Propagates [`fastly::Error`] from the Fastly SDK. +// TODO: delete after Phase 5 EdgeZero cutover — see issue #495 +fn legacy_main(mut req: FastlyRequest) -> Result { + let state = match build_state() { + Ok(state) => state, Err(e) => { - log::error!("Failed to create integration registry: {:?}", e); - to_error_response(&e).send_to_client(); - return; + log::error!("Failed to build application state: {:?}", e); + return Ok(to_error_response(&e)); } }; - - let kv_store = std::sync::Arc::new(UnavailableKvStore) - as std::sync::Arc; + log::debug!("Settings {:?}", state.settings); // Strip client-spoofable forwarded headers at the edge before building // any request-derived context or converting to the core HTTP types. compat::sanitize_fastly_forwarded_headers(&mut req); - let runtime_services = build_runtime_services(&req, kv_store); + let runtime_services = build_runtime_services(&req, std::sync::Arc::clone(&state.kv_store)); let http_req = compat::from_fastly_request(req); let mut response = futures::executor::block_on(route_request( - &settings, - &orchestrator, - &integration_registry, + &state.settings, + &state.orchestrator, + &state.registry, &runtime_services, http_req, )) @@ -120,9 +171,9 @@ fn main() { }) }; - finalize_response(&settings, geo_info.as_ref(), &mut response); + finalize_response(&state.settings, geo_info.as_ref(), &mut response); - compat::to_fastly_response(response).send_to_client(); + Ok(compat::to_fastly_response(response)) } async fn route_request( @@ -209,20 +260,23 @@ async fn route_request( ); match runtime_services_for_consent_route(settings, runtime_services) { - Ok(publisher_services) => { - handle_publisher_request(settings, integration_registry, &publisher_services, req) - .await - .and_then(|pub_response| { - resolve_publisher_response(pub_response, settings, integration_registry) - }) - } + Ok(publisher_services) => handle_publisher_request( + settings, + integration_registry, + &publisher_services, + req, + ) + .await + .and_then(|pub_response| { + resolve_publisher_response(pub_response, settings, integration_registry) + }), Err(e) => Err(e), } } } } -fn resolve_publisher_response( +pub(crate) fn resolve_publisher_response( publisher_response: PublisherResponse, settings: &Settings, integration_registry: &IntegrationRegistry, @@ -236,9 +290,10 @@ fn resolve_publisher_response( } => { let mut output = Vec::new(); stream_publisher_body(body, &mut output, ¶ms, settings, integration_registry)?; - response - .headers_mut() - .insert(header::CONTENT_LENGTH, HeaderValue::from(output.len() as u64)); + response.headers_mut().insert( + header::CONTENT_LENGTH, + HeaderValue::from(output.len() as u64), + ); *response.body_mut() = EdgeBody::from(output); Ok(response) } @@ -276,35 +331,7 @@ fn runtime_services_for_consent_route( /// version/staging, then operator-configured `settings.response_headers`. /// This means operators can intentionally override any managed header. fn finalize_response(settings: &Settings, geo_info: Option<&GeoInfo>, response: &mut HttpResponse) { - if let Some(geo) = geo_info { - geo.set_response_headers(response); - } else { - response.headers_mut().insert( - HEADER_X_GEO_INFO_AVAILABLE, - HeaderValue::from_static("false"), - ); - } - - if let Ok(v) = ::std::env::var(ENV_FASTLY_SERVICE_VERSION) { - if let Ok(value) = HeaderValue::from_str(&v) { - response.headers_mut().insert(HEADER_X_TS_VERSION, value); - } else { - log::warn!("Skipping invalid FASTLY_SERVICE_VERSION response header value"); - } - } - if ::std::env::var(ENV_FASTLY_IS_STAGING).as_deref() == Ok("1") { - response - .headers_mut() - .insert(HEADER_X_TS_ENV, HeaderValue::from_static("staging")); - } - - for (key, value) in &settings.response_headers { - let header_name = HeaderName::from_bytes(key.as_bytes()) - .expect("settings.response_headers validated at load time"); - let header_value = - HeaderValue::from_str(value).expect("settings.response_headers validated at load time"); - response.headers_mut().insert(header_name, header_value); - } + apply_finalize_headers(settings, geo_info, response); } fn http_error_response(report: &Report) -> HttpResponse { @@ -320,3 +347,35 @@ fn http_error_response(report: &Report) -> HttpResponse { ); response } + +#[cfg(test)] +mod tests { + use super::parse_edgezero_flag; + + #[test] + fn parses_true_flag_values() { + assert!(parse_edgezero_flag("true"), "should parse 'true'"); + assert!(parse_edgezero_flag("1"), "should parse '1'"); + assert!(parse_edgezero_flag(" true "), "should trim whitespace"); + assert!( + parse_edgezero_flag(" 1 "), + "should trim whitespace around '1'" + ); + assert!(parse_edgezero_flag("TRUE"), "should parse uppercase 'TRUE'"); + assert!( + parse_edgezero_flag("True"), + "should parse mixed-case 'True'" + ); + } + + #[test] + fn rejects_non_true_flag_values() { + assert!(!parse_edgezero_flag("false"), "should not parse 'false'"); + assert!(!parse_edgezero_flag(""), "should not parse empty string"); + assert!( + !parse_edgezero_flag(" "), + "should not parse whitespace-only" + ); + assert!(!parse_edgezero_flag("yes"), "should not parse 'yes'"); + } +} diff --git a/crates/trusted-server-adapter-fastly/src/middleware.rs b/crates/trusted-server-adapter-fastly/src/middleware.rs new file mode 100644 index 000000000..1e7d0ba52 --- /dev/null +++ b/crates/trusted-server-adapter-fastly/src/middleware.rs @@ -0,0 +1,386 @@ +//! Middleware implementations for the dual-path entry point. +//! +//! Provides two middleware types that mirror the finalization and auth logic +//! from the legacy [`crate::finalize_response`] and [`crate::route_request`]: +//! +//! - [`FinalizeResponseMiddleware`] — geo lookup and standard TS header injection +//! - [`AuthMiddleware`] — basic-auth enforcement via [`enforce_basic_auth`] +//! +//! Registration order in [`crate::app`]: `FinalizeResponseMiddleware` outermost, +//! then `AuthMiddleware`. This ensures auth-rejected responses also receive the +//! standard TS headers before being returned to the client. + +use std::sync::Arc; + +use async_trait::async_trait; +use edgezero_adapter_fastly::FastlyRequestContext; +use edgezero_core::context::RequestContext; +use edgezero_core::error::EdgeError; +use edgezero_core::http::{HeaderName, HeaderValue, Response, StatusCode}; +use edgezero_core::middleware::{Middleware, Next}; +use edgezero_core::response::IntoResponse; +use trusted_server_core::auth::enforce_basic_auth; +use trusted_server_core::constants::{ + ENV_FASTLY_IS_STAGING, ENV_FASTLY_SERVICE_VERSION, HEADER_X_GEO_INFO_AVAILABLE, + HEADER_X_TS_ENV, HEADER_X_TS_VERSION, +}; +use trusted_server_core::geo::GeoInfo; +use trusted_server_core::platform::PlatformGeo; +use trusted_server_core::settings::Settings; + +// --------------------------------------------------------------------------- +// FinalizeResponseMiddleware +// --------------------------------------------------------------------------- + +/// Outermost middleware: performs geo lookup and injects all standard TS response headers. +/// +/// Registered first in the middleware chain so that it wraps all inner middleware +/// (including [`AuthMiddleware`]) and the handler. This guarantees every registered-route +/// response — including auth-rejected ones — carries a consistent set of headers. +/// +/// Router-level 405/404 responses for unregistered HTTP methods (e.g. TRACE) bypass the +/// middleware chain. Those are covered by a second call to [`apply_finalize_headers`] at +/// the `main.rs` entry point, which is idempotent for normal requests. +/// +/// # Header precedence +/// +/// Headers are written in this order (last write wins): +/// 1. Geo headers (or `X-Geo-Info-Available: false` when geo is unavailable) +/// 2. `X-TS-Version` from `FASTLY_SERVICE_VERSION` env var +/// 3. `X-TS-ENV: staging` when `FASTLY_IS_STAGING == "1"` +/// 4. Operator-configured `settings.response_headers` (can override any managed header) +pub struct FinalizeResponseMiddleware { + settings: Arc, + geo: Arc, +} + +impl FinalizeResponseMiddleware { + /// Creates a new [`FinalizeResponseMiddleware`] with the given settings and geo lookup service. + pub fn new(settings: Arc, geo: Arc) -> Self { + Self { settings, geo } + } +} + +#[async_trait(?Send)] +impl Middleware for FinalizeResponseMiddleware { + async fn handle(&self, ctx: RequestContext, next: Next<'_>) -> Result { + let client_ip = FastlyRequestContext::get(ctx.request()).and_then(|c| c.client_ip); + + let mut response = match next.run(ctx).await { + Ok(r) => r, + Err(e) => { + log::error!("request handler failed: {e:?}"); + e.into_response() + } + }; + + // Skip geo lookup for authentication rejections — the lookup is unnecessary for 401s. + let geo_info = if response.status() != StatusCode::UNAUTHORIZED { + self.geo.lookup(client_ip).unwrap_or_else(|e| { + log::warn!("geo lookup failed: {e}"); + None + }) + } else { + None + }; + + apply_finalize_headers(&self.settings, geo_info.as_ref(), &mut response); + + Ok(response) + } +} + +// --------------------------------------------------------------------------- +// AuthMiddleware +// --------------------------------------------------------------------------- + +/// Inner middleware: enforces basic-auth before the handler runs. +/// +/// - `Ok(Some(response))` from [`enforce_basic_auth`] → auth failed; return the +/// challenge response (bubbles through [`FinalizeResponseMiddleware`] for header injection). +/// - `Ok(None)` → no auth required or credentials accepted; continue the chain. +/// - `Err(report)` → internal error; log and convert to a 500 HTTP response. +/// +/// # Errors +/// +/// When [`enforce_basic_auth`] returns an error report, converts it to a 500 HTTP +/// response so that [`FinalizeResponseMiddleware`] can still inject standard TS +/// headers before the response reaches the client. +pub struct AuthMiddleware { + settings: Arc, +} + +impl AuthMiddleware { + /// Creates a new [`AuthMiddleware`] with the given settings. + pub fn new(settings: Arc) -> Self { + Self { settings } + } +} + +#[async_trait(?Send)] +impl Middleware for AuthMiddleware { + async fn handle(&self, ctx: RequestContext, next: Next<'_>) -> Result { + match enforce_basic_auth(&self.settings, ctx.request()) { + Ok(Some(response)) => return Ok(response), + Ok(None) => {} + Err(report) => { + log::error!("auth check failed: {:?}", report); + return Ok(crate::app::http_error(&report)); + } + } + + next.run(ctx).await + } +} + +// --------------------------------------------------------------------------- +// apply_finalize_headers — extracted for unit testing +// --------------------------------------------------------------------------- + +/// Applies all standard Trusted Server response headers to the given response. +/// +/// Mirrors [`crate::finalize_response`] exactly, operating on [`Response`] from +/// `edgezero_core::http` instead of `HttpResponse`. +/// +/// Header write order (last write wins): +/// 1. Geo headers (`x-geo-*`) — or `X-Geo-Info-Available: false` when absent +/// 2. `X-TS-Version` from `FASTLY_SERVICE_VERSION` env var +/// 3. `X-TS-ENV: staging` when `FASTLY_IS_STAGING == "1"` +/// 4. `settings.response_headers` — operator-configured overrides applied last +pub(crate) fn apply_finalize_headers( + settings: &Settings, + geo_info: Option<&GeoInfo>, + response: &mut Response, +) { + if let Some(geo) = geo_info { + geo.set_response_headers(response); + } else { + response.headers_mut().insert( + HEADER_X_GEO_INFO_AVAILABLE, + HeaderValue::from_static("false"), + ); + } + + if let Ok(v) = std::env::var(ENV_FASTLY_SERVICE_VERSION) { + if let Ok(value) = HeaderValue::from_str(&v) { + response.headers_mut().insert(HEADER_X_TS_VERSION, value); + } else { + log::warn!("Skipping invalid FASTLY_SERVICE_VERSION response header value"); + } + } + + if std::env::var(ENV_FASTLY_IS_STAGING).as_deref() == Ok("1") { + response + .headers_mut() + .insert(HEADER_X_TS_ENV, HeaderValue::from_static("staging")); + } + + for (key, value) in &settings.response_headers { + let header_name = HeaderName::from_bytes(key.as_bytes()) + .expect("settings.response_headers validated at load time"); + let header_value = + HeaderValue::from_str(value).expect("settings.response_headers validated at load time"); + response.headers_mut().insert(header_name, header_value); + } +} + +// --------------------------------------------------------------------------- +// Tests +// --------------------------------------------------------------------------- + +#[cfg(test)] +mod tests { + use super::*; + + use std::collections::HashMap; + use std::net::IpAddr; + use std::sync::Arc; + + use edgezero_core::body::Body; + use edgezero_core::context::RequestContext; + use edgezero_core::error::EdgeError; + use edgezero_core::http::{request_builder, response_builder, Method, StatusCode}; + use edgezero_core::middleware::Next; + use edgezero_core::params::PathParams; + use error_stack::Report; + use futures::executor::block_on; + use trusted_server_core::platform::{PlatformError, PlatformGeo}; + + fn empty_response() -> Response { + response_builder() + .body(Body::empty()) + .expect("should build empty test response") + } + + fn empty_ctx() -> RequestContext { + let req = request_builder() + .method(Method::GET) + .uri("/test") + .body(Body::empty()) + .expect("should build test request"); + RequestContext::new(req, PathParams::new(HashMap::new())) + } + + struct FixedGeo(Option); + + impl PlatformGeo for FixedGeo { + fn lookup(&self, _: Option) -> Result, Report> { + Ok(self.0.clone()) + } + } + + fn settings_with_response_headers(headers: Vec<(&str, &str)>) -> Settings { + let mut s = + trusted_server_core::settings_data::get_settings().expect("should load test settings"); + s.response_headers = headers + .into_iter() + .map(|(k, v)| (k.to_string(), v.to_string())) + .collect(); + s + } + + #[test] + fn operator_response_headers_override_earlier_headers() { + let settings = + settings_with_response_headers(vec![("X-Geo-Info-Available", "operator-override")]); + let mut response = empty_response(); + + // No geo_info → would set "false"; operator header should win instead. + apply_finalize_headers(&settings, None, &mut response); + + assert_eq!( + response + .headers() + .get("x-geo-info-available") + .and_then(|v| v.to_str().ok()), + Some("operator-override"), + "should override the managed geo header with the operator-configured value" + ); + } + + #[test] + fn sets_geo_unavailable_header_when_no_geo_info() { + let settings = settings_with_response_headers(vec![]); + let mut response = empty_response(); + + apply_finalize_headers(&settings, None, &mut response); + + assert_eq!( + response + .headers() + .get("x-geo-info-available") + .and_then(|v| v.to_str().ok()), + Some("false"), + "should set X-Geo-Info-Available: false when no geo info is available" + ); + } + + // --------------------------------------------------------------------------- + // FinalizeResponseMiddleware::handle tests + // --------------------------------------------------------------------------- + + #[test] + fn finalize_handle_injects_geo_unavailable_on_ok_response() { + let settings = settings_with_response_headers(vec![]); + let middleware = + FinalizeResponseMiddleware::new(Arc::new(settings), Arc::new(FixedGeo(None))); + let handler = + Arc::new( + |_ctx: RequestContext| async move { Ok::(empty_response()) }, + ); + + let response = block_on(middleware.handle(empty_ctx(), Next::new(&[], &*handler))) + .expect("should succeed"); + + assert_eq!( + response + .headers() + .get("x-geo-info-available") + .and_then(|v| v.to_str().ok()), + Some("false"), + "should set X-Geo-Info-Available: false when geo returns None" + ); + } + + #[test] + fn finalize_handle_absorbs_handler_error_and_injects_headers() { + let settings = settings_with_response_headers(vec![]); + let middleware = + FinalizeResponseMiddleware::new(Arc::new(settings), Arc::new(FixedGeo(None))); + let handler = Arc::new(|_ctx: RequestContext| async move { + Err::(EdgeError::service_unavailable("test error")) + }); + + let response = block_on(middleware.handle(empty_ctx(), Next::new(&[], &*handler))) + .expect("should absorb handler error into a response"); + + assert!( + response.status().is_server_error(), + "should produce a server-error status for absorbed handler error" + ); + assert!( + response.headers().get("x-geo-info-available").is_some(), + "absorbed error response should still carry geo header" + ); + } + + #[test] + #[allow(clippy::panic)] + fn finalize_handle_skips_geo_lookup_for_401() { + struct PanicGeo; + impl PlatformGeo for PanicGeo { + fn lookup(&self, _: Option) -> Result, Report> { + panic!("should not call geo for 401 responses") + } + } + + let settings = settings_with_response_headers(vec![]); + let middleware = FinalizeResponseMiddleware::new(Arc::new(settings), Arc::new(PanicGeo)); + let handler = Arc::new(|_ctx: RequestContext| async move { + let mut resp = empty_response(); + *resp.status_mut() = StatusCode::UNAUTHORIZED; + Ok::(resp) + }); + + let response = block_on(middleware.handle(empty_ctx(), Next::new(&[], &*handler))) + .expect("should succeed without calling geo"); + + assert_eq!( + response.status(), + StatusCode::UNAUTHORIZED, + "should preserve 401 status" + ); + assert_eq!( + response + .headers() + .get("x-geo-info-available") + .and_then(|v| v.to_str().ok()), + Some("false"), + "should set geo-unavailable header without calling geo for 401" + ); + } + + // --------------------------------------------------------------------------- + // AuthMiddleware::handle tests + // --------------------------------------------------------------------------- + + #[test] + fn auth_handle_passes_through_when_auth_not_configured() { + let settings = + trusted_server_core::settings_data::get_settings().expect("should load test settings"); + let middleware = AuthMiddleware::new(Arc::new(settings)); + let handler = + Arc::new( + |_ctx: RequestContext| async move { Ok::(empty_response()) }, + ); + + let response = block_on(middleware.handle(empty_ctx(), Next::new(&[], &*handler))) + .expect("should pass through when auth is not configured"); + + assert_eq!( + response.status(), + StatusCode::OK, + "should reach the handler when auth is not required" + ); + } +} diff --git a/crates/trusted-server-adapter-fastly/src/route_tests.rs b/crates/trusted-server-adapter-fastly/src/route_tests.rs index 001f70f70..aa1843a25 100644 --- a/crates/trusted-server-adapter-fastly/src/route_tests.rs +++ b/crates/trusted-server-adapter-fastly/src/route_tests.rs @@ -7,6 +7,7 @@ use fastly::http::StatusCode; use fastly::Request; use trusted_server_core::auction::build_orchestrator; use trusted_server_core::compat; +use trusted_server_core::error::IntoHttpResponse; use trusted_server_core::integrations::IntegrationRegistry; use trusted_server_core::platform::{ ClientInfo, GeoInfo, PlatformBackend, PlatformBackendSpec, PlatformConfigStore, PlatformError, @@ -14,7 +15,6 @@ use trusted_server_core::platform::{ PlatformResponse, PlatformSecretStore, PlatformSelectResult, RuntimeServices, StoreId, StoreName, }; -use trusted_server_core::error::IntoHttpResponse; use trusted_server_core::request_signing::JWKS_CONFIG_STORE_NAME; use trusted_server_core::settings::Settings; diff --git a/crates/trusted-server-core/src/edge_cookie.rs b/crates/trusted-server-core/src/edge_cookie.rs index 2d796338b..c1b451652 100644 --- a/crates/trusted-server-core/src/edge_cookie.rs +++ b/crates/trusted-server-core/src/edge_cookie.rs @@ -109,7 +109,11 @@ pub fn generate_ec_id( /// /// - [`TrustedServerError::InvalidHeaderValue`] if cookie parsing fails pub fn get_ec_id(req: &Request) -> Result, Report> { - if let Some(ec_id) = req.headers().get(HEADER_X_TS_EC).and_then(|h| h.to_str().ok()) { + if let Some(ec_id) = req + .headers() + .get(HEADER_X_TS_EC) + .and_then(|h| h.to_str().ok()) + { if ec_id_has_only_allowed_chars(ec_id) { log::trace!("Using existing EC ID from header: {}", ec_id); return Ok(Some(ec_id.to_string())); @@ -207,7 +211,9 @@ mod tests { for (key, value) in headers { builder = builder.header(key, *value); } - builder.body(EdgeBody::empty()).expect("should build test request") + builder + .body(EdgeBody::empty()) + .expect("should build test request") } fn is_ec_id_format(value: &str) -> bool { @@ -352,10 +358,7 @@ mod tests { fn test_get_ec_id_rejects_invalid_header_and_falls_back_to_cookie() { let req = create_test_request(&[ (HEADER_X_TS_EC, "evil;injected"), - ( - header::COOKIE, - &format!("{}=valid_cookie_id", COOKIE_TS_EC), - ), + (header::COOKIE, &format!("{}=valid_cookie_id", COOKIE_TS_EC)), ]); let ec_id = get_ec_id(&req).expect("should handle invalid header gracefully"); diff --git a/crates/trusted-server-core/src/integrations/prebid.rs b/crates/trusted-server-core/src/integrations/prebid.rs index ca33befb7..3a9a96d04 100644 --- a/crates/trusted-server-core/src/integrations/prebid.rs +++ b/crates/trusted-server-core/src/integrations/prebid.rs @@ -1057,21 +1057,23 @@ impl AuctionProvider for PrebidAuctionProvider { let request_info = RequestInfo::from_request(context.request, context.client_info); // Create signer and compute signature if request signing is enabled - let signer_with_signature = if let Some(request_signing_config) = - &context.settings.request_signing - { - if request_signing_config.enabled { - let signer = RequestSigner::from_services(context.services)?; - let params = - SigningParams::new(request.id.clone(), request_info.host.clone(), request_info.scheme.clone()); - let signature = signer.sign_request(¶ms)?; - Some((signer, signature, params)) + let signer_with_signature = + if let Some(request_signing_config) = &context.settings.request_signing { + if request_signing_config.enabled { + let signer = RequestSigner::from_services(context.services)?; + let params = SigningParams::new( + request.id.clone(), + request_info.host.clone(), + request_info.scheme.clone(), + ); + let signature = signer.sign_request(¶ms)?; + Some((signer, signature, params)) + } else { + None + } } else { None - } - } else { - None - }; + }; // Convert to OpenRTB with all enrichments let openrtb = self.to_openrtb( diff --git a/crates/trusted-server-core/src/integrations/registry.rs b/crates/trusted-server-core/src/integrations/registry.rs index 2f98d12aa..c02f89857 100644 --- a/crates/trusted-server-core/src/integrations/registry.rs +++ b/crates/trusted-server-core/src/integrations/registry.rs @@ -673,7 +673,8 @@ impl IntegrationRegistry { if let Ok(ref ec_id) = ec_id_result { match HeaderValue::from_str(ec_id) { Ok(header_value) => { - req.headers_mut().insert(HEADER_X_TS_EC.clone(), header_value); + req.headers_mut() + .insert(HEADER_X_TS_EC.clone(), header_value); } Err(error) => { log::warn!("Failed to build x-ts-ec request header value: {}", error); diff --git a/crates/trusted-server-core/src/proxy.rs b/crates/trusted-server-core/src/proxy.rs index d72d353fc..1d5f42ab8 100644 --- a/crates/trusted-server-core/src/proxy.rs +++ b/crates/trusted-server-core/src/proxy.rs @@ -41,7 +41,6 @@ const PROXY_FORWARD_HEADERS: [header::HeaderName; 5] = [ HEADER_X_FORWARDED_FOR, ]; - #[derive(Deserialize)] struct ProxySignReq { url: String, @@ -72,9 +71,22 @@ pub struct ProxyRequestConfig<'a> { pub stream_passthrough: bool, /// Domains allowed for the initial request and any redirects. /// - /// When empty every host is permitted (open mode). Integration proxies - /// should leave this empty; first-party handlers should pass - /// `&settings.proxy.allowed_domains` to enforce the publisher allowlist. + /// **Open mode** (`&[]`): every host is permitted. Integration proxies pass `&[]` + /// because their target URLs originate from operator-controlled configuration + /// (e.g. `trusted-server.toml` integration settings) and are therefore trusted at + /// operator setup time rather than at request time. + /// + /// **Restricted mode** (non-empty slice): only hosts matching a listed pattern are + /// permitted. First-party proxy handlers pass `&settings.proxy.allowed_domains` + /// because they follow redirect chains that may originate from untrusted + /// creative-supplied URLs. + /// + /// **Behavior change from pre-PR-14**: `proxy_with_redirects` previously always + /// enforced `&settings.proxy.allowed_domains` regardless of the caller. After PR 14, + /// only [`handle_first_party_proxy`] and its siblings enforce the operator allowlist; + /// integration proxies use open mode. This is intentional: applying the operator + /// domain allowlist to integration redirects would require every operator to enumerate + /// every integration CDN in their config, which is impractical. pub allowed_domains: &'a [String], } @@ -417,10 +429,11 @@ struct ProxyRequestHeaders<'a> { additional_headers: &'a [(header::HeaderName, HeaderValue)], copy_request_headers: bool, services: &'a RuntimeServices, - /// Domains permitted for the initial request and any redirects. - /// - /// Empty slice means open mode (all hosts allowed). Populated by first-party - /// handlers; integration proxies leave it empty. +} + +struct ProxyRedirectPolicy<'a> { + follow_redirects: bool, + stream_passthrough: bool, allowed_domains: &'a [String], } @@ -465,15 +478,17 @@ pub async fn proxy_request( settings, &req, target_url_parsed, - follow_redirects, body.as_deref(), ProxyRequestHeaders { additional_headers: &headers, copy_request_headers, services, + }, + ProxyRedirectPolicy { + follow_redirects, + stream_passthrough, allowed_domains, }, - stream_passthrough, ) .await } @@ -552,10 +567,9 @@ async fn proxy_with_redirects( settings: &Settings, req: &Request, target_url_parsed: url::Url, - follow_redirects: bool, body: Option<&[u8]>, request_headers: ProxyRequestHeaders<'_>, - stream_passthrough: bool, + redirect_policy: ProxyRedirectPolicy<'_>, ) -> Result, Report> { const MAX_REDIRECTS: usize = 4; @@ -583,7 +597,7 @@ async fn proxy_with_redirects( })); } - if !redirect_is_permitted(request_headers.allowed_domains, host) { + if !redirect_is_permitted(redirect_policy.allowed_domains, host) { log::warn!( "request to `{}` blocked: host not in proxy allowed_domains", host @@ -655,8 +669,14 @@ async fn proxy_with_redirects( let beresp = platform_resp.response; - if !follow_redirects { - return finalize_response(settings, req, ¤t_url, beresp, stream_passthrough); + if !redirect_policy.follow_redirects { + return finalize_response( + settings, + req, + ¤t_url, + beresp, + redirect_policy.stream_passthrough, + ); } let status = beresp.status(); @@ -670,7 +690,13 @@ async fn proxy_with_redirects( ); if !is_redirect { - return finalize_response(settings, req, ¤t_url, beresp, stream_passthrough); + return finalize_response( + settings, + req, + ¤t_url, + beresp, + redirect_policy.stream_passthrough, + ); } let Some(location) = beresp @@ -679,7 +705,13 @@ async fn proxy_with_redirects( .and_then(|h| h.to_str().ok()) .filter(|value| !value.is_empty()) else { - return finalize_response(settings, req, ¤t_url, beresp, stream_passthrough); + return finalize_response( + settings, + req, + ¤t_url, + beresp, + redirect_policy.stream_passthrough, + ); }; if redirect_attempt == MAX_REDIRECTS { @@ -700,7 +732,13 @@ async fn proxy_with_redirects( let next_scheme = next_url.scheme().to_ascii_lowercase(); if next_scheme != "http" && next_scheme != "https" { - return finalize_response(settings, req, ¤t_url, beresp, stream_passthrough); + return finalize_response( + settings, + req, + ¤t_url, + beresp, + redirect_policy.stream_passthrough, + ); } let next_host = match next_url.host_str() { @@ -711,7 +749,7 @@ async fn proxy_with_redirects( })); } }; - if !redirect_is_permitted(request_headers.allowed_domains, next_host) { + if !redirect_is_permitted(redirect_policy.allowed_domains, next_host) { log::warn!( "redirect to `{}` blocked: host not in proxy allowed_domains", next_host @@ -1292,7 +1330,8 @@ fn reconstruct_and_validate_signed_target( #[cfg(test)] mod tests { - use std::sync::Arc; + use std::collections::VecDeque; + use std::sync::{Arc, Mutex}; use super::{ handle_first_party_click, handle_first_party_proxy, handle_first_party_proxy_rebuild, @@ -1374,6 +1413,79 @@ mod tests { .expect("response body should be valid UTF-8") } + struct QueuedHttpResponse { + status: u16, + headers: Vec<(header::HeaderName, HeaderValue)>, + body: Vec, + } + + #[derive(Default)] + struct HeaderAwareStubHttpClient { + responses: Mutex>, + } + + impl HeaderAwareStubHttpClient { + fn new() -> Self { + Self::default() + } + + fn push_response( + &self, + status: u16, + headers: Vec<(header::HeaderName, HeaderValue)>, + body: Vec, + ) { + self.responses + .lock() + .expect("should lock queued responses") + .push_back(QueuedHttpResponse { + status, + headers, + body, + }); + } + } + + #[async_trait::async_trait(?Send)] + impl PlatformHttpClient for HeaderAwareStubHttpClient { + async fn send( + &self, + _request: PlatformHttpRequest, + ) -> Result> { + let queued = self + .responses + .lock() + .expect("should lock queued responses") + .pop_front() + .ok_or_else(|| Report::new(PlatformError::HttpClient))?; + + let mut builder = edgezero_core::http::response_builder().status(queued.status); + for (name, value) in queued.headers { + builder = builder.header(name, value); + } + + let response = builder + .body(EdgeBody::from(queued.body)) + .expect("should build stub HTTP response"); + + Ok(PlatformResponse::new(response)) + } + + async fn send_async( + &self, + _request: PlatformHttpRequest, + ) -> Result> { + Err(Report::new(PlatformError::Unsupported)) + } + + async fn select( + &self, + _pending_requests: Vec, + ) -> Result> { + Err(Report::new(PlatformError::Unsupported)) + } + } + fn build_http_response(status: StatusCode, body: EdgeBody) -> Response { let mut response = Response::new(body); *response.status_mut() = status; @@ -2139,6 +2251,83 @@ mod tests { ); } + #[tokio::test] + async fn proxy_request_allows_open_mode_when_settings_allowlist_is_non_empty() { + let mut settings = create_test_settings(); + settings.proxy.allowed_domains = vec!["allowed.example".to_string()]; + + let stub = Arc::new(HeaderAwareStubHttpClient::new()); + stub.push_response(200, Vec::new(), b"ok".to_vec()); + let services = build_services_with_http_client( + Arc::clone(&stub) as Arc + ); + let req = build_http_request(Method::GET, "https://edge.example/"); + + let response = proxy_request( + &settings, + req, + ProxyRequestConfig { + target_url: "https://blocked.example/resource.js", + follow_redirects: false, + forward_ec_id: false, + body: None, + headers: Vec::new(), + copy_request_headers: false, + stream_passthrough: false, + allowed_domains: &[], + }, + &services, + ) + .await + .expect("open mode should ignore settings.proxy.allowed_domains"); + + assert_eq!(response.status(), StatusCode::OK); + assert_eq!(response_body_string(response), "ok"); + } + + #[tokio::test] + async fn proxy_request_uses_config_allowlist_for_redirect_hops() { + let mut settings = create_test_settings(); + settings.proxy.allowed_domains = vec!["origin.example".to_string()]; + + let stub = Arc::new(HeaderAwareStubHttpClient::new()); + stub.push_response( + 302, + vec![( + header::LOCATION, + HeaderValue::from_static("https://redirected.example/final.js"), + )], + Vec::new(), + ); + stub.push_response(200, Vec::new(), b"redirected".to_vec()); + + let services = build_services_with_http_client( + Arc::clone(&stub) as Arc + ); + let req = build_http_request(Method::GET, "https://edge.example/"); + + let response = proxy_request( + &settings, + req, + ProxyRequestConfig { + target_url: "https://origin.example/start.js", + follow_redirects: true, + forward_ec_id: false, + body: None, + headers: Vec::new(), + copy_request_headers: false, + stream_passthrough: false, + allowed_domains: &[], + }, + &services, + ) + .await + .expect("open mode should allow redirect hops outside settings allowlist"); + + assert_eq!(response.status(), StatusCode::OK); + assert_eq!(response_body_string(response), "redirected"); + } + #[tokio::test] async fn proxy_request_forwards_curated_headers_when_copy_request_headers_is_true() { use crate::platform::test_support::StubHttpClient; @@ -2154,8 +2343,12 @@ mod tests { .uri("https://example.com/") .body(EdgeBody::empty()) .expect("should build test request"); - req.headers_mut().insert(header::USER_AGENT, HeaderValue::from_static("test-agent/1.0")); - req.headers_mut().insert(header::ACCEPT, HeaderValue::from_static("text/html")); + req.headers_mut().insert( + header::USER_AGENT, + HeaderValue::from_static("test-agent/1.0"), + ); + req.headers_mut() + .insert(header::ACCEPT, HeaderValue::from_static("text/html")); req.headers_mut() .insert(header::ACCEPT_LANGUAGE, HeaderValue::from_static("en-US")); @@ -2254,12 +2447,14 @@ mod tests { fn rebuild_response_with_body_preserves_multiple_set_cookie_headers() { let mut beresp = Response::new(EdgeBody::empty()); *beresp.status_mut() = StatusCode::OK; - beresp - .headers_mut() - .append(header::SET_COOKIE, HeaderValue::from_static("a=1; Path=/; Secure")); - beresp - .headers_mut() - .append(header::SET_COOKIE, HeaderValue::from_static("b=2; Path=/; Secure")); + beresp.headers_mut().append( + header::SET_COOKIE, + HeaderValue::from_static("a=1; Path=/; Secure"), + ); + beresp.headers_mut().append( + header::SET_COOKIE, + HeaderValue::from_static("b=2; Path=/; Secure"), + ); let rebuilt = rebuild_response_with_body( beresp, @@ -2505,12 +2700,9 @@ mod tests { // --- initial target allowlist enforcement (integration-level) --- // - // NOTE: A test for Nth-hop redirect blocking (i.e. exercising the - // `redirect_is_permitted` check that fires *after* receiving a 302 - // response) requires a Viceroy backend fixture that returns a redirect. - // That infrastructure is not available here. The unit tests above for - // `redirect_is_permitted` and `ip_literal_blocked_by_domain_allowlist` - // cover the blocking logic used at every hop. + // The unit tests above cover the host-matching logic itself. The tests + // below verify that proxy_request threads config.allowed_domains through + // the initial target check and redirect hops. #[tokio::test] async fn proxy_initial_target_blocked_by_allowlist() { diff --git a/crates/trusted-server-core/src/publisher.rs b/crates/trusted-server-core/src/publisher.rs index ca2caaf36..4582a3344 100644 --- a/crates/trusted-server-core/src/publisher.rs +++ b/crates/trusted-server-core/src/publisher.rs @@ -692,7 +692,10 @@ pub async fn handle_publisher_request( let mut output = Vec::new(); process_response_streaming(body, &mut output, ¶ms)?; - response.headers_mut().insert(header::CONTENT_LENGTH, HeaderValue::from(output.len() as u64)); + response.headers_mut().insert( + header::CONTENT_LENGTH, + HeaderValue::from(output.len() as u64), + ); *response.body_mut() = EdgeBody::from(output); Ok(PublisherResponse::Buffered(response)) @@ -1557,8 +1560,14 @@ mod tests { }; let mut output = Vec::new(); - stream_publisher_body(EdgeBody::empty(), &mut output, ¶ms, &settings, ®istry) - .expect("should succeed on empty body"); + stream_publisher_body( + EdgeBody::empty(), + &mut output, + ¶ms, + &settings, + ®istry, + ) + .expect("should succeed on empty body"); assert!( output.is_empty(), @@ -1764,7 +1773,6 @@ mod tests { assert!( !processed.contains("origin.example.com"), "origin host must not leak. Got: {processed}" - ); } } diff --git a/fastly.toml b/fastly.toml index 9d6c0f269..2c5989e1d 100644 --- a/fastly.toml +++ b/fastly.toml @@ -40,6 +40,13 @@ build = """ env = "FASTLY_KEY" [local_server.config_stores] + [local_server.config_stores.trusted_server_config] + format = "inline-toml" + [local_server.config_stores.trusted_server_config.contents] + # "true" / "1" enable the EdgeZero path. Missing, unreadable, or + # any other value falls back to the legacy entry point. + edgezero_enabled = "true" + [local_server.config_stores.jwks_store] format = "inline-toml" [local_server.config_stores.jwks_store.contents]