http.rs 88.2%

150 of 170 lines run, 30 of 64 functions · run #18 on main · run missed

//! Tuner over HTTP (spec §15.1, §8.5, §21.1): `POST /mcp` on the Unix
//! socket and the loopback port, every request signed and checked before
//! anything else; the peer's uid read from the socket; `Origin` checked
//! against DNS rebinding.

use crate::protocol::{self, Headers, Reply};
use crate::tools::Ctx;
use axum::body::Bytes;
use axum::extract::connect_info::{ConnectInfo, Connected};
use axum::extract::State;
use axum::http::{HeaderMap, StatusCode};
use axum::response::sse::{Event as SseEvent, KeepAlive, Sse};
use axum::response::{IntoResponse, Response};
use axum::routing::post;
use axum::Router;
use futures::stream::{self, StreamExt};
use serde_json::{json, Value as Json};
use spectra_core::authn::Caller;
use spectra_core::daemon::{Daemon, Peer, WireEvent};
use spectra_core::principals::Principal;
use spectra_core::proof::Proof;
use std::convert::Infallible;
use std::sync::Arc;
use std::time::Duration;

/// Who is on the other end of a connection: a Unix peer, or TCP.
#[derive(Clone, Copy, Debug)]
pub struct PeerInfo(pub Option<Peer>);

impl Connected<axum::serve::IncomingStream<'_, tokio::net::UnixListener>> for PeerInfo {
    fn connect_info(stream: axum::serve::IncomingStream<'_, tokio::net::UnixListener>) -> Self {
        let cred = stream.io().peer_cred().ok();
        PeerInfo(cred.map(|c| Peer { uid: c.uid(), pid: c.pid() }))
    }
}

impl Connected<axum::serve::IncomingStream<'_, tokio::net::TcpListener>> for PeerInfo {
    fn connect_info(_: axum::serve::IncomingStream<'_, tokio::net::TcpListener>) -> Self {
        PeerInfo(None)
    }
}

impl Connected<axum::serve::IncomingStream<'_, crate::tls::TlsListener>> for PeerInfo {
    fn connect_info(_: axum::serve::IncomingStream<'_, crate::tls::TlsListener>) -> Self {
        PeerInfo(None)
    }
}

/// The app state: the daemon, and the origins a browser may send from.
#[derive(Clone)]
pub struct AppState {
    pub daemon: Arc<Daemon>,
    pub origins: Arc<Vec<String>>,
    /// The owner's browser sessions (Radar's sign-in link).
    pub sessions: Arc<crate::session::Sessions>,
}

/// Tuner's routes; the binary adds the API and Radar beside them.
pub fn router(state: AppState) -> Router {
    Router::new()
        .route("/mcp", post(mcp).get(not_allowed).delete(not_allowed))
        .route("/api/v1/ledger/events", post(owner_events))
        .route("/api/v1/instance", axum::routing::get(instance))
        .with_state(state)
}

/// `GET /api/v1/instance`, unauthenticated (spec §8.6): who this Spectra
/// is, whose it is, and the instance key's word for its TLS certificate, so
/// a client can decide whether to trust it before it signs anything.
async fn instance(State(state): State<AppState>) -> Response {
    let (instance, owner) = {
        let p = state.daemon.principals.read().await;
        (p.instance().cloned(), p.owner().map(|o| o.hash().to_hex()))
    };
    let Some(instance) = instance else {
        return (StatusCode::SERVICE_UNAVAILABLE, axum::Json(json!({ "title": "this Spectra has no instance key" }))).into_response();
    };
    let tls = match crate::instance::latest_tls(&state.daemon.ledger).await {
        Ok(Some(e)) => json!({ "payload": e.json(), "proof": e.auth.proof.as_ref().map(hex::encode) }),
        _ => Json::Null,
    };
    axum::Json(json!({
        "name": instance.name,
        "instance": spectra_core::principals::identity_payload(&instance),
        "owner": owner,
        "tls": tls,
    }))
    .into_response()
}

async fn not_allowed() -> StatusCode {
    StatusCode::METHOD_NOT_ALLOWED
}

/// The proof the signature headers carry, for `method_path` and `body`.
pub fn proof_from(headers: &HeaderMap, method_path: &str, body: &[u8]) -> Option<Proof> {
    let get = |k: &str| headers.get(k).and_then(|v| v.to_str().ok());
    let key = get("spectra-key")?;
    let time_ms = get("spectra-time")?.parse().ok()?;
    let nonce: [u8; 16] = hex::decode(get("spectra-nonce")?).ok()?.try_into().ok()?;
    let sig_bytes = hex::decode(get("spectra-signature")?).ok()?;
    let sig = oxy_core::cbor::decode(&sig_bytes).ok().and_then(|v| oxy_core::identity::Signature::from_value(&v).ok())?;
    if sig.key.to_hex() != key {
        return None;
    }
    Some(Proof { sig, method: method_path.into(), body_hash: *spectra_core::event::hash_body_plain(body), time_ms, nonce })
}

/// Refuse a browser request from a page that is not ours (spec §21.1).
pub fn origin_ok(headers: &HeaderMap, allowed: &[String]) -> bool {
    match headers.get("origin").and_then(|v| v.to_str().ok()) {
        None => true,
        Some(o) => allowed.iter().any(|a| a == o),
    }
}

/// Authenticate a request, or the response that refuses it.
pub async fn authenticate(
    state: &AppState,
    peer: PeerInfo,
    headers: &HeaderMap,
    method_path: &str,
    body: &[u8],
) -> Result<Caller, Response> {
    if !origin_ok(headers, &state.origins) {
        return Err((
            StatusCode::FORBIDDEN,
            axum::Json(protocol::error(&Json::Null, protocol::INVALID_REQUEST, "this origin may not call Spectra")),
        )
            .into_response());
    }
    let proof = proof_from(headers, method_path, body);
    state.daemon.authenticate(proof.as_ref(), method_path, body, peer.0).await.map_err(|why| {
        tracing::info!(%why, "refused a request");
        // The reason concerns the caller's own key, so the caller is told it:
        // an agent whose delegation expired must be able to say so.
        (
            StatusCode::UNAUTHORIZED,
            axum::Json(protocol::error(&Json::Null, protocol::UNAUTHENTICATED, &format!("not authenticated: {why}"))),
        )
            .into_response()
    })
}

async fn mcp(State(state): State<AppState>, ConnectInfo(peer): ConnectInfo<PeerInfo>, headers: HeaderMap, body: Bytes) -> Response {
    let caller = match authenticate(&state, peer, &headers, "POST /mcp", &body).await {
        Ok(c) => c,
        Err(r) => return r,
    };
    let req: Json = match serde_json::from_slice(&body) {
        Ok(v) => v,
        Err(e) => {
            return (StatusCode::BAD_REQUEST, axum::Json(protocol::error(&Json::Null, protocol::PARSE_ERROR, &format!("not JSON: {e}"))))
                .into_response()
        }
    };
    let new_session = req.pointer("/params/arguments/new_session").and_then(Json::as_bool).unwrap_or(false)
        && req.pointer("/params/name").and_then(Json::as_str) == Some("brief");
    let session = state.daemon.touch(&caller.principal, new_session).await;
    let h = Headers {
        version: headers.get("mcp-protocol-version").and_then(|v| v.to_str().ok()),
        method: headers.get("mcp-method").and_then(|v| v.to_str().ok()),
        name: headers.get("mcp-name").and_then(|v| v.to_str().ok()),
    };
    let version = h.version.unwrap_or("2025-03-26").to_string();
    let ctx = Ctx { daemon: state.daemon.clone(), caller, session };
    let meta = meta(&ctx).await;
    match protocol::handle(&ctx, &h, req, meta.clone()).await {
        Reply::Json(status, v) => (StatusCode::from_u16(status).unwrap_or(StatusCode::OK), axum::Json(v)).into_response(),
        Reply::Accepted => StatusCode::ACCEPTED.into_response(),
        Reply::Stream(id, tool, args) => {
            let fut = async move {
                let out = crate::tools::invoke(&ctx, tool, args).await;
                let meta = crate::http::meta(&ctx).await;
                let msg = protocol::stream_result(&id, &version, &out, meta);
                Ok::<_, Infallible>(SseEvent::default().event("message").data(msg.to_string()))
            };
            sse(stream::once(fut).boxed())
        }
        Reply::Listen(id, sub) => {
            let ack = json!({ "jsonrpc": "2.0", "method": "notifications/subscriptions/acknowledged", "params": { "_meta": { "io.modelcontextprotocol/subscriptionId": sub } } });
            let _ = id;
            let first = stream::once(async move { Ok::<_, Infallible>(SseEvent::default().event("message").data(ack.to_string())) });
            // Spectra's tool list never changes while it runs: the stream
            // stays open, quiet but for keep-alives, until the client closes it.
            sse(first.chain(stream::pending()).boxed())
        }
    }
}

fn sse(s: futures::stream::BoxStream<'static, Result<SseEvent, Infallible>>) -> Response {
    let mut r = Sse::new(s).keep_alive(KeepAlive::new().interval(Duration::from_secs(15)).text("")).into_response();
    r.headers_mut().insert("x-accel-buffering", "no".parse().unwrap());
    r
}

/// `_meta` on every result (spec §15.2): the rules version, the session and
/// the unread count.
pub async fn meta(ctx: &Ctx) -> Json {
    let mut m = serde_json::Map::new();
    if let Ok(r) = spectra_core::rules::compile(&ctx.daemon.data) {
        m.insert("spectra/rules_version".into(), json!(r.version));
    }
    if let Some(s) = &ctx.session {
        m.insert("spectra/session".into(), json!(s));
    }
    if let Ok(n) = spectra_core::conversation::unread(&ctx.daemon.ledger, &ctx.caller.principal.actor()).await {
        m.insert("spectra/inbox_unread".into(), json!(n));
    }
    Json::Object(m)
}

/// `POST /api/v1/ledger/events`: the owner's CLI hands over events it
/// signed over their payload, so `agent add` and `project add` work while
/// the daemon holds the ledger (spec §8.5, "One writer").
async fn owner_events(
    State(state): State<AppState>,
    ConnectInfo(peer): ConnectInfo<PeerInfo>,
    headers: HeaderMap,
    body: Bytes,
) -> Response {
    let caller = match authenticate(&state, peer, &headers, "POST /api/v1/ledger/events", &body).await {
        Ok(c) => c,
        Err(r) => return r,
    };
    if !matches!(caller.principal, Principal::Owner { .. }) {
        return (StatusCode::FORBIDDEN, axum::Json(json!({ "title": "only the owner hands events to the daemon" }))).into_response();
    }
    let events: Vec<WireEvent> = match serde_json::from_slice(&body) {
        Ok(v) => v,
        Err(e) => return (StatusCode::BAD_REQUEST, axum::Json(json!({ "title": format!("not a list of events: {e}") }))).into_response(),
    };
    match state.daemon.accept_owner_events(events).await {
        Ok(seqs) => axum::Json(json!({ "appended": seqs })).into_response(),
        Err(e) => (StatusCode::UNPROCESSABLE_ENTITY, axum::Json(json!({ "title": e.to_string() }))).into_response(),
    }
}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

1		//! Tuner over HTTP (spec §15.1, §8.5, §21.1): `POST /mcp` on the Unix
2		//! socket and the loopback port, every request signed and checked before
3		//! anything else; the peer's uid read from the socket; `Origin` checked
4		//! against DNS rebinding.
5
6		use crate::protocol::{self, Headers, Reply};
7		use crate::tools::Ctx;
8		use axum::body::Bytes;
9		use axum::extract::connect_info::{ConnectInfo, Connected};
10		use axum::extract::State;
11		use axum::http::{HeaderMap, StatusCode};
12		use axum::response::sse::{Event as SseEvent, KeepAlive, Sse};
13		use axum::response::{IntoResponse, Response};
14		use axum::routing::post;
15		use axum::Router;
16		use futures::stream::{self, StreamExt};
17		use serde_json::{json, Value as Json};
18		use spectra_core::authn::Caller;
19		use spectra_core::daemon::{Daemon, Peer, WireEvent};
20		use spectra_core::principals::Principal;
21		use spectra_core::proof::Proof;
22		use std::convert::Infallible;
23		use std::sync::Arc;
24		use std::time::Duration;
25
26		/// Who is on the other end of a connection: a Unix peer, or TCP.
27		#[derive(Clone, Copy, Debug)]
28		pub struct PeerInfo(pub Option<Peer>);
29
30		impl Connected<axum::serve::IncomingStream<'_, tokio::net::UnixListener>> for PeerInfo {
31	111×	fn connect_info(stream: axum::serve::IncomingStream<'_, tokio::net::UnixListener>) -> Self {
32	111×	let cred = stream.io().peer_cred().ok();
33	111×	PeerInfo(cred.map(\|c\| Peer { uid: c.uid(), pid: c.pid() }))
34	111×	}
35		}
36
37		impl Connected<axum::serve::IncomingStream<'_, tokio::net::TcpListener>> for PeerInfo {
38	0×	fn connect_info(_: axum::serve::IncomingStream<'_, tokio::net::TcpListener>) -> Self {
39	0×	PeerInfo(None)
40	0×	}
41		}
42
43		impl Connected<axum::serve::IncomingStream<'_, crate::tls::TlsListener>> for PeerInfo {
44	5×	fn connect_info(_: axum::serve::IncomingStream<'_, crate::tls::TlsListener>) -> Self {
45	5×	PeerInfo(None)
46	5×	}
47		}
48
49		/// The app state: the daemon, and the origins a browser may send from.
50		#[derive(Clone)]
51		pub struct AppState {
52		pub daemon: Arc<Daemon>,
53		pub origins: Arc<Vec<String>>,
54		/// The owner's browser sessions (Radar's sign-in link).
55		pub sessions: Arc<crate::session::Sessions>,
56		}
57
58		/// Tuner's routes; the binary adds the API and Radar beside them.
59	13×	pub fn router(state: AppState) -> Router {
60	13×	Router::new()
61	13×	.route("/mcp", post(mcp).get(not_allowed).delete(not_allowed))
62	13×	.route("/api/v1/ledger/events", post(owner_events))
63	13×	.route("/api/v1/instance", axum::routing::get(instance))
64	13×	.with_state(state)
65	13×	}
66
67		/// `GET /api/v1/instance`, unauthenticated (spec §8.6): who this Spectra
68		/// is, whose it is, and the instance key's word for its TLS certificate, so
69		/// a client can decide whether to trust it before it signs anything.
70	3×	async fn instance(State(state): State<AppState>) -> Response {
71	3×	let (instance, owner) = {
72	3×	let p = state.daemon.principals.read().await;
73	3×	(p.instance().cloned(), p.owner().map(\|o\| o.hash().to_hex()))
74		};
75	3×	let Some(instance) = instance else {
76	0×	return (StatusCode::SERVICE_UNAVAILABLE, axum::Json(json!({ "title": "this Spectra has no instance key" }))).into_response();
77		};
78	3×	let tls = match crate::instance::latest_tls(&state.daemon.ledger).await {
79	3×	Ok(Some(e)) => json!({ "payload": e.json(), "proof": e.auth.proof.as_ref().map(hex::encode) }),
80	0×	_ => Json::Null,
81		};
82	3×	axum::Json(json!({
83	3×	"name": instance.name,
84	3×	"instance": spectra_core::principals::identity_payload(&instance),
85	3×	"owner": owner,
86	3×	"tls": tls,
87	3×	}))
88	3×	.into_response()
89	3×	}
90
91	1×	async fn not_allowed() -> StatusCode {
92	1×	StatusCode::METHOD_NOT_ALLOWED
93	1×	}
94
95		/// The proof the signature headers carry, for `method_path` and `body`.
96	77×	pub fn proof_from(headers: &HeaderMap, method_path: &str, body: &[u8]) -> Option<Proof> {
97	302×	let get = \|k: &str\| headers.get(k).and_then(\|v\| v.to_str().ok());
98	77×	let key = get("spectra-key")?;
99	75×	let time_ms = get("spectra-time")?.parse().ok()?;
100	75×	let nonce: [u8; 16] = hex::decode(get("spectra-nonce")?).ok()?.try_into().ok()?;
101	75×	let sig_bytes = hex::decode(get("spectra-signature")?).ok()?;
102	75×	let sig = oxy_core::cbor::decode(&sig_bytes).ok().and_then(\|v\| oxy_core::identity::Signature::from_value(&v).ok())?;
103	75×	if sig.key.to_hex() != key {
104	0×	return None;
105	75×	}
106	75×	Some(Proof { sig, method: method_path.into(), body_hash: *spectra_core::event::hash_body_plain(body), time_ms, nonce })
107	77×	}
108
109		/// Refuse a browser request from a page that is not ours (spec §21.1).
110	82×	pub fn origin_ok(headers: &HeaderMap, allowed: &[String]) -> bool {
111	82×	match headers.get("origin").and_then(\|v\| v.to_str().ok()) {
112	80×	None => true,
113	6×	Some(o) => allowed.iter().any(\|a\| a == o),
114		}
115	82×	}
116
117		/// Authenticate a request, or the response that refuses it.
118	78×	pub async fn authenticate(
119	78×	state: &AppState,
120	78×	peer: PeerInfo,
121	78×	headers: &HeaderMap,
122	78×	method_path: &str,
123	78×	body: &[u8],
124	78×	) -> Result<Caller, Response> {
125	78×	if !origin_ok(headers, &state.origins) {
126	1×	return Err((
127	1×	StatusCode::FORBIDDEN,
128	1×	axum::Json(protocol::error(&Json::Null, protocol::INVALID_REQUEST, "this origin may not call Spectra")),
129	1×	)
130	1×	.into_response());
131	77×	}
132	77×	let proof = proof_from(headers, method_path, body);
133	77×	state.daemon.authenticate(proof.as_ref(), method_path, body, peer.0).await.map_err(\|why\| {
134	5×	tracing::info!(%why, "refused a request");
135		// The reason concerns the caller's own key, so the caller is told it:
136		// an agent whose delegation expired must be able to say so.
137	5×	(
138	5×	StatusCode::UNAUTHORIZED,
139	5×	axum::Json(protocol::error(&Json::Null, protocol::UNAUTHENTICATED, &format!("not authenticated: {why}"))),
140	5×	)
141	5×	.into_response()
142	5×	})
143	78×	}
144
145	47×	async fn mcp(State(state): State<AppState>, ConnectInfo(peer): ConnectInfo<PeerInfo>, headers: HeaderMap, body: Bytes) -> Response {
146	47×	let caller = match authenticate(&state, peer, &headers, "POST /mcp", &body).await {
147	42×	Ok(c) => c,
148	5×	Err(r) => return r,
149		};
150	42×	let req: Json = match serde_json::from_slice(&body) {
151	42×	Ok(v) => v,
152	0×	Err(e) => {
153	0×	return (StatusCode::BAD_REQUEST, axum::Json(protocol::error(&Json::Null, protocol::PARSE_ERROR, &format!("not JSON: {e}"))))
154	0×	.into_response()
155		}
156		};
157	42×	let new_session = req.pointer("/params/arguments/new_session").and_then(Json::as_bool).unwrap_or(false)
158	0×	&& req.pointer("/params/name").and_then(Json::as_str) == Some("brief");
159	42×	let session = state.daemon.touch(&caller.principal, new_session).await;
160	42×	let h = Headers {
161	42×	version: headers.get("mcp-protocol-version").and_then(\|v\| v.to_str().ok()),
162	42×	method: headers.get("mcp-method").and_then(\|v\| v.to_str().ok()),
163	42×	name: headers.get("mcp-name").and_then(\|v\| v.to_str().ok()),
164		};
165	42×	let version = h.version.unwrap_or("2025-03-26").to_string();
166	42×	let ctx = Ctx { daemon: state.daemon.clone(), caller, session };
167	42×	let meta = meta(&ctx).await;
168	42×	match protocol::handle(&ctx, &h, req, meta.clone()).await {
169	34×	Reply::Json(status, v) => (StatusCode::from_u16(status).unwrap_or(StatusCode::OK), axum::Json(v)).into_response(),
170	2×	Reply::Accepted => StatusCode::ACCEPTED.into_response(),
171	6×	Reply::Stream(id, tool, args) => {
172	6×	let fut = async move {
173	6×	let out = crate::tools::invoke(&ctx, tool, args).await;
174	6×	let meta = crate::http::meta(&ctx).await;
175	6×	let msg = protocol::stream_result(&id, &version, &out, meta);
176	6×	Ok::<_, Infallible>(SseEvent::default().event("message").data(msg.to_string()))
177	6×	};
178	6×	sse(stream::once(fut).boxed())
179		}
180	0×	Reply::Listen(id, sub) => {
181	0×	let ack = json!({ "jsonrpc": "2.0", "method": "notifications/subscriptions/acknowledged", "params": { "_meta": { "io.modelcontextprotocol/subscriptionId": sub } } });
182	0×	let _ = id;
183	0×	let first = stream::once(async move { Ok::<_, Infallible>(SseEvent::default().event("message").data(ack.to_string())) });
184		// Spectra's tool list never changes while it runs: the stream
185		// stays open, quiet but for keep-alives, until the client closes it.
186	0×	sse(first.chain(stream::pending()).boxed())
187		}
188		}
189	47×	}
190
191	6×	fn sse(s: futures::stream::BoxStream<'static, Result<SseEvent, Infallible>>) -> Response {
192	6×	let mut r = Sse::new(s).keep_alive(KeepAlive::new().interval(Duration::from_secs(15)).text("")).into_response();
193	6×	r.headers_mut().insert("x-accel-buffering", "no".parse().unwrap());
194	6×	r
195	6×	}
196
197		/// `_meta` on every result (spec §15.2): the rules version, the session and
198		/// the unread count.
199	71×	pub async fn meta(ctx: &Ctx) -> Json {
200	71×	let mut m = serde_json::Map::new();
201	71×	if let Ok(r) = spectra_core::rules::compile(&ctx.daemon.data) {
202	71×	m.insert("spectra/rules_version".into(), json!(r.version));
203	71×	}
204	71×	if let Some(s) = &ctx.session {
205	71×	m.insert("spectra/session".into(), json!(s));
206	71×	}
207	71×	if let Ok(n) = spectra_core::conversation::unread(&ctx.daemon.ledger, &ctx.caller.principal.actor()).await {
208	71×	m.insert("spectra/inbox_unread".into(), json!(n));
209	71×	}
210	71×	Json::Object(m)
211	71×	}
212
213		/// `POST /api/v1/ledger/events`: the owner's CLI hands over events it
214		/// signed over their payload, so `agent add` and `project add` work while
215		/// the daemon holds the ledger (spec §8.5, "One writer").
216	2×	async fn owner_events(
217	2×	State(state): State<AppState>,
218	2×	ConnectInfo(peer): ConnectInfo<PeerInfo>,
219	2×	headers: HeaderMap,
220	2×	body: Bytes,
221	2×	) -> Response {
222	2×	let caller = match authenticate(&state, peer, &headers, "POST /api/v1/ledger/events", &body).await {
223	2×	Ok(c) => c,
224	0×	Err(r) => return r,
225		};
226	2×	if !matches!(caller.principal, Principal::Owner { .. }) {
227	0×	return (StatusCode::FORBIDDEN, axum::Json(json!({ "title": "only the owner hands events to the daemon" }))).into_response();
228	2×	}
229	2×	let events: Vec<WireEvent> = match serde_json::from_slice(&body) {
230	2×	Ok(v) => v,
231	0×	Err(e) => return (StatusCode::BAD_REQUEST, axum::Json(json!({ "title": format!("not a list of events: {e}") }))).into_response(),
232		};
233	2×	match state.daemon.accept_owner_events(events).await {
234	2×	Ok(seqs) => axum::Json(json!({ "appended": seqs })).into_response(),
235	0×	Err(e) => (StatusCode::UNPROCESSABLE_ENTITY, axum::Json(json!({ "title": e.to_string() }))).into_response(),
236		}
237	2×	}

Coverage / crates/spectra-mcp/src/http.rs 88.2%

Keyboard