client.rs 70.4%

107 of 152 lines run, 86 of 190 functions · run #20 on main · run missed

//! A client for the daemon over its Unix socket (spec §8.5), signing every
//! request with the caller's key: the shims and the CLI use it, and so do
//! the tests.

use anyhow::{Context, Result};
use http_body_util::{BodyExt, Full};
use hyper::body::Bytes;
use spectra_core::keys::KeyPair;
use spectra_core::proof::Proof;
use std::path::{Path, PathBuf};

/// A response, its body read whole.
#[derive(Debug)]
pub struct Response {
    pub status: u16,
    pub headers: Vec<(String, String)>,
    pub body: Vec<u8>,
}

impl Response {
    pub fn json(&self) -> Result<serde_json::Value> {
        serde_json::from_slice(&self.body).with_context(|| format!("not JSON: {}", String::from_utf8_lossy(&self.body)))
    }
    pub fn header(&self, name: &str) -> Option<&str> {
        self.headers.iter().find(|(k, _)| k.eq_ignore_ascii_case(name)).map(|(_, v)| v.as_str())
    }
}

/// Where the daemon is: its Unix socket, or a server over TLS with a
/// pinned certificate (spec §8.6).
#[derive(Clone)]
pub enum Endpoint {
    Unix(PathBuf),
    Tls { addr: String, config: std::sync::Arc<rustls::ClientConfig> },
}

impl Endpoint {
    /// `https://HOST:PORT` accepting exactly the certificate pinned by `pin`.
    pub fn tls(url: &str, pin: [u8; 32]) -> Result<Endpoint> {
        Ok(Endpoint::Tls { addr: host_port(url)?, config: crate::tls::Pinned::new(Some(pin)).client_config()? })
    }

    pub fn describe(&self) -> String {
        match self {
            Endpoint::Unix(p) => p.display().to_string(),
            Endpoint::Tls { addr, .. } => format!("https://{addr}"),
        }
    }
}

/// `host:port` of an `https://` URL.
pub fn host_port(url: &str) -> Result<String> {
    let rest = url.strip_prefix("https://").with_context(|| format!("{url} is not an https:// URL"))?;
    let hp = rest.split('/').next().unwrap_or("");
    if hp.is_empty() {
        anyhow::bail!("{url} names no host");
    }
    // The port defaults to Spectra's.
    let has_port = if hp.starts_with('[') { hp.contains("]:") } else { hp.contains(':') };
    Ok(if has_port { hp.to_string() } else { format!("{hp}:7350") })
}

trait Io: tokio::io::AsyncRead + tokio::io::AsyncWrite + Unpin + Send {}
impl<T: tokio::io::AsyncRead + tokio::io::AsyncWrite + Unpin + Send> Io for T {}

pub struct Client {
    endpoint: Endpoint,
    signer: Option<KeyPair>,
}

impl Client {
    pub fn new(socket: &Path, signer: Option<KeyPair>) -> Client {
        Client { endpoint: Endpoint::Unix(socket.to_path_buf()), signer }
    }

    pub fn at(endpoint: Endpoint, signer: Option<KeyPair>) -> Client {
        Client { endpoint, signer }
    }

    pub fn endpoint(&self) -> &Endpoint {
        &self.endpoint
    }

    async fn io(&self) -> Result<Box<dyn Io>> {
        Ok(match &self.endpoint {
            Endpoint::Unix(socket) => Box::new(
                tokio::net::UnixStream::connect(socket)
                    .await
                    .with_context(|| format!("connecting to {} (is `spectra serve` running?)", socket.display()))?,
            ),
            Endpoint::Tls { addr, config } => Box::new(crate::tls::connect(addr, config.clone()).await?),
        })
    }

    /// Whether the daemon answers at the endpoint.
    pub async fn reachable(&self) -> bool {
        self.io().await.is_ok()
    }

    /// Whether a daemon answers on the socket.
    pub async fn alive(socket: &Path) -> bool {
        tokio::net::UnixStream::connect(socket).await.is_ok()
    }

    /// Send `method path` with `body` and extra headers, signed.
    pub async fn send(&self, method: &str, path: &str, headers: &[(&str, String)], body: Vec<u8>) -> Result<Response> {
        let stream = self.io().await?;
        let (mut sender, conn) = hyper::client::conn::http1::handshake(hyper_util::rt::TokioIo::new(stream)).await?;
        tokio::spawn(async move {
            let _ = conn.await;
        });
        // One request a connection: the server closes it after answering, so
        // nothing lingers to hold up its shutdown.
        let mut req = hyper::Request::builder().method(method).uri(path).header("host", "spectra").header("connection", "close");
        // JSON unless the caller says otherwise (a form, say).
        if !headers.iter().any(|(k, _)| k.eq_ignore_ascii_case("content-type")) {
            req = req.header("content-type", "application/json");
        }
        for (k, v) in headers {
            req = req.header(*k, v);
        }
        if let Some(pair) = &self.signer {
            for (k, v) in sign_headers(pair, &format!("{method} {path}"), &body) {
                req = req.header(k, v);
            }
        }
        let resp = sender.send_request(req.body(Full::new(Bytes::from(body)))?).await?;
        let status = resp.status().as_u16();
        let headers = resp.headers().iter().map(|(k, v)| (k.to_string(), v.to_str().unwrap_or("").to_string())).collect();
        let body = resp.into_body().collect().await?.to_bytes().to_vec();
        Ok(Response { status, headers, body })
    }

    /// A JSON-RPC request to `/mcp` with the protocol headers of `version`.
    pub async fn mcp(&self, version: &str, request: &serde_json::Value) -> Result<Response> {
        let method = request.get("method").and_then(|m| m.as_str()).unwrap_or("").to_string();
        let mut headers = vec![
            ("accept", "application/json, text/event-stream".to_string()),
            ("mcp-protocol-version", version.to_string()),
            ("mcp-method", method.clone()),
        ];
        if let Some(name) = request.pointer("/params/name").or_else(|| request.pointer("/params/uri")).and_then(|n| n.as_str()) {
            headers.push(("mcp-name", name.to_string()));
        }
        self.send("POST", "/mcp", &headers, serde_json::to_vec(request)?).await
    }
}

impl Client {
    /// Send a signed GET and hand each line of the streamed body to `line`
    /// as it arrives (an SSE stream, say); stop when it returns false.
    pub async fn stream(&self, path: &str, mut line: impl FnMut(&str) -> bool) -> Result<u16> {
        let stream = self.io().await?;
        let (mut sender, conn) = hyper::client::conn::http1::handshake(hyper_util::rt::TokioIo::new(stream)).await?;
        tokio::spawn(async move {
            let _ = conn.await;
        });
        let mut req = hyper::Request::builder().method("GET").uri(path).header("host", "spectra").header("connection", "close");
        if let Some(pair) = &self.signer {
            for (k, v) in sign_headers(pair, &format!("GET {path}"), b"") {
                req = req.header(k, v);
            }
        }
        let resp = sender.send_request(req.body(Full::new(Bytes::new()))?).await?;
        let status = resp.status().as_u16();
        let mut body = resp.into_body();
        let mut buf = String::new();
        while let Some(frame) = body.frame().await {
            if let Ok(data) = frame?.into_data() {
                buf.push_str(&String::from_utf8_lossy(&data));
                while let Some(i) = buf.find('\n') {
                    let l: String = buf.drain(..=i).collect();
                    if !line(l.trim_end()) {
                        return Ok(status);
                    }
                }
            }
        }
        Ok(status)
    }
}

/// The signature headers of spec §8.5 for `method_path` and `body`.
pub fn sign_headers(pair: &KeyPair, method_path: &str, body: &[u8]) -> Vec<(&'static str, String)> {
    let p = Proof::sign(pair, method_path, body);
    vec![
        ("spectra-key", p.sig.key.to_hex()),
        ("spectra-time", p.time_ms.to_string()),
        ("spectra-nonce", hex::encode(p.nonce)),
        ("spectra-signature", hex::encode(oxy_core::cbor::encode(&p.sig.to_value()))),
    ]
}

/// The JSON-RPC result inside a response, whether it came as JSON or as
/// the last `data:` of an SSE stream.
pub fn rpc_result(r: &Response) -> Result<serde_json::Value> {
    let is_sse = r.header("content-type").is_some_and(|c| c.starts_with("text/event-stream"));
    if !is_sse {
        return r.json();
    }
    let text = String::from_utf8_lossy(&r.body);
    let last = text
        .lines()
        .rev()
        .filter_map(|l| l.strip_prefix("data:"))
        .map(str::trim)
        .find(|l| !l.is_empty())
        .context("an SSE response with no data")?;
    Ok(serde_json::from_str(last)?)
}

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

1		//! A client for the daemon over its Unix socket (spec §8.5), signing every
2		//! request with the caller's key: the shims and the CLI use it, and so do
3		//! the tests.
4
5		use anyhow::{Context, Result};
6		use http_body_util::{BodyExt, Full};
7		use hyper::body::Bytes;
8		use spectra_core::keys::KeyPair;
9		use spectra_core::proof::Proof;
10		use std::path::{Path, PathBuf};
11
12		/// A response, its body read whole.
13		#[derive(Debug)]
14		pub struct Response {
15		pub status: u16,
16		pub headers: Vec<(String, String)>,
17		pub body: Vec<u8>,
18		}
19
20		impl Response {
21	53×	pub fn json(&self) -> Result<serde_json::Value> {
22	53×	serde_json::from_slice(&self.body).with_context(\|\| format!("not JSON: {}", String::from_utf8_lossy(&self.body)))
23	53×	}
24	34×	pub fn header(&self, name: &str) -> Option<&str> {
25	43×	self.headers.iter().find(\|(k, _)\| k.eq_ignore_ascii_case(name)).map(\|(_, v)\| v.as_str())
26	34×	}
27		}
28
29		/// Where the daemon is: its Unix socket, or a server over TLS with a
30		/// pinned certificate (spec §8.6).
31		#[derive(Clone)]
32		pub enum Endpoint {
33		Unix(PathBuf),
34		Tls { addr: String, config: std::sync::Arc<rustls::ClientConfig> },
35		}
36
37		impl Endpoint {
38		/// `https://HOST:PORT` accepting exactly the certificate pinned by `pin`.
39	8×	pub fn tls(url: &str, pin: [u8; 32]) -> Result<Endpoint> {
40	8×	Ok(Endpoint::Tls { addr: host_port(url)?, config: crate::tls::Pinned::new(Some(pin)).client_config()? })
41	8×	}
42
43	0×	pub fn describe(&self) -> String {
44	0×	match self {
45	0×	Endpoint::Unix(p) => p.display().to_string(),
46	0×	Endpoint::Tls { addr, .. } => format!("https://{addr}"),
47		}
48	0×	}
49		}
50
51		/// `host:port` of an `https://` URL.
52	18×	pub fn host_port(url: &str) -> Result<String> {
53	18×	let rest = url.strip_prefix("https://").with_context(\|\| format!("{url} is not an https:// URL"))?;
54	18×	let hp = rest.split('/').next().unwrap_or("");
55	18×	if hp.is_empty() {
56	0×	anyhow::bail!("{url} names no host");
57	18×	}
58		// The port defaults to Spectra's.
59	18×	let has_port = if hp.starts_with('[') { hp.contains("]:") } else { hp.contains(':') };
60	18×	Ok(if has_port { hp.to_string() } else { format!("{hp}:7350") })
61	18×	}
62
63		trait Io: tokio::io::AsyncRead + tokio::io::AsyncWrite + Unpin + Send {}
64		impl<T: tokio::io::AsyncRead + tokio::io::AsyncWrite + Unpin + Send> Io for T {}
65
66		pub struct Client {
67		endpoint: Endpoint,
68		signer: Option<KeyPair>,
69		}
70
71		impl Client {
72	25×	pub fn new(socket: &Path, signer: Option<KeyPair>) -> Client {
73	25×	Client { endpoint: Endpoint::Unix(socket.to_path_buf()), signer }
74	25×	}
75
76	16×	pub fn at(endpoint: Endpoint, signer: Option<KeyPair>) -> Client {
77	16×	Client { endpoint, signer }
78	16×	}
79
80	0×	pub fn endpoint(&self) -> &Endpoint {
81	0×	&self.endpoint
82	0×	}
83
84	110×	async fn io(&self) -> Result<Box<dyn Io>> {
85	110×	Ok(match &self.endpoint {
86	88×	Endpoint::Unix(socket) => Box::new(
87	88×	tokio::net::UnixStream::connect(socket)
88	88×	.await
89	88×	.with_context(\|\| format!("connecting to {} (is `spectra serve` running?)", socket.display()))?,
90		),
91	22×	Endpoint::Tls { addr, config } => Box::new(crate::tls::connect(addr, config.clone()).await?),
92		})
93	110×	}
94
95		/// Whether the daemon answers at the endpoint.
96	0×	pub async fn reachable(&self) -> bool {
97	0×	self.io().await.is_ok()
98	0×	}
99
100		/// Whether a daemon answers on the socket.
101	48×	pub async fn alive(socket: &Path) -> bool {
102	48×	tokio::net::UnixStream::connect(socket).await.is_ok()
103	48×	}
104
105		/// Send `method path` with `body` and extra headers, signed.
106	110×	pub async fn send(&self, method: &str, path: &str, headers: &[(&str, String)], body: Vec<u8>) -> Result<Response> {
107	110×	let stream = self.io().await?;
108	108×	let (mut sender, conn) = hyper::client::conn::http1::handshake(hyper_util::rt::TokioIo::new(stream)).await?;
109	108×	tokio::spawn(async move {
110	108×	let _ = conn.await;
111	108×	});
112		// One request a connection: the server closes it after answering, so
113		// nothing lingers to hold up its shutdown.
114	108×	let mut req = hyper::Request::builder().method(method).uri(path).header("host", "spectra").header("connection", "close");
115		// JSON unless the caller says otherwise (a form, say).
116	162×	if !headers.iter().any(\|(k, _)\| k.eq_ignore_ascii_case("content-type")) {
117	104×	req = req.header("content-type", "application/json");
118	104×	}
119	163×	for (k, v) in headers {
120	163×	req = req.header(*k, v);
121	163×	}
122	108×	if let Some(pair) = &self.signer {
123	288×	for (k, v) in sign_headers(pair, &format!("{method} {path}"), &body) {
124	288×	req = req.header(k, v);
125	288×	}
126	36×	}
127	108×	let resp = sender.send_request(req.body(Full::new(Bytes::from(body)))?).await?;
128	108×	let status = resp.status().as_u16();
129	522×	let headers = resp.headers().iter().map(\|(k, v)\| (k.to_string(), v.to_str().unwrap_or("").to_string())).collect();
130	108×	let body = resp.into_body().collect().await?.to_bytes().to_vec();
131	108×	Ok(Response { status, headers, body })
132	110×	}
133
134		/// A JSON-RPC request to `/mcp` with the protocol headers of `version`.
135	38×	pub async fn mcp(&self, version: &str, request: &serde_json::Value) -> Result<Response> {
136	38×	let method = request.get("method").and_then(\|m\| m.as_str()).unwrap_or("").to_string();
137	38×	let mut headers = vec![
138	38×	("accept", "application/json, text/event-stream".to_string()),
139	38×	("mcp-protocol-version", version.to_string()),
140	38×	("mcp-method", method.clone()),
141		];
142	38×	if let Some(name) = request.pointer("/params/name").or_else(\|\| request.pointer("/params/uri")).and_then(\|n\| n.as_str()) {
143	27×	headers.push(("mcp-name", name.to_string()));
144	27×	}
145	38×	self.send("POST", "/mcp", &headers, serde_json::to_vec(request)?).await
146	38×	}
147		}
148
149		impl Client {
150		/// Send a signed GET and hand each line of the streamed body to `line`
151		/// as it arrives (an SSE stream, say); stop when it returns false.
152	0×	pub async fn stream(&self, path: &str, mut line: impl FnMut(&str) -> bool) -> Result<u16> {
153	0×	let stream = self.io().await?;
154	0×	let (mut sender, conn) = hyper::client::conn::http1::handshake(hyper_util::rt::TokioIo::new(stream)).await?;
155	0×	tokio::spawn(async move {
156	0×	let _ = conn.await;
157	0×	});
158	0×	let mut req = hyper::Request::builder().method("GET").uri(path).header("host", "spectra").header("connection", "close");
159	0×	if let Some(pair) = &self.signer {
160	0×	for (k, v) in sign_headers(pair, &format!("GET {path}"), b"") {
161	0×	req = req.header(k, v);
162	0×	}
163	0×	}
164	0×	let resp = sender.send_request(req.body(Full::new(Bytes::new()))?).await?;
165	0×	let status = resp.status().as_u16();
166	0×	let mut body = resp.into_body();
167	0×	let mut buf = String::new();
168	0×	while let Some(frame) = body.frame().await {
169	0×	if let Ok(data) = frame?.into_data() {
170	0×	buf.push_str(&String::from_utf8_lossy(&data));
171	0×	while let Some(i) = buf.find('\n') {
172	0×	let l: String = buf.drain(..=i).collect();
173	0×	if !line(l.trim_end()) {
174	0×	return Ok(status);
175	0×	}
176		}
177	0×	}
178		}
179	0×	Ok(status)
180	0×	}
181		}
182
183		/// The signature headers of spec §8.5 for `method_path` and `body`.
184	72×	pub fn sign_headers(pair: &KeyPair, method_path: &str, body: &[u8]) -> Vec<(&'static str, String)> {
185	72×	let p = Proof::sign(pair, method_path, body);
186	72×	vec![
187	72×	("spectra-key", p.sig.key.to_hex()),
188	72×	("spectra-time", p.time_ms.to_string()),
189	72×	("spectra-nonce", hex::encode(p.nonce)),
190	72×	("spectra-signature", hex::encode(oxy_core::cbor::encode(&p.sig.to_value()))),
191		]
192	72×	}
193
194		/// The JSON-RPC result inside a response, whether it came as JSON or as
195		/// the last `data:` of an SSE stream.
196	24×	pub fn rpc_result(r: &Response) -> Result<serde_json::Value> {
197	24×	let is_sse = r.header("content-type").is_some_and(\|c\| c.starts_with("text/event-stream"));
198	24×	if !is_sse {
199	19×	return r.json();
200	5×	}
201	5×	let text = String::from_utf8_lossy(&r.body);
202	5×	let last = text
203	5×	.lines()
204	5×	.rev()
205	10×	.filter_map(\|l\| l.strip_prefix("data:"))
206	5×	.map(str::trim)
207	5×	.find(\|l\| !l.is_empty())
208	5×	.context("an SSE response with no data")?;
209	5×	Ok(serde_json::from_str(last)?)
210	24×	}

Coverage / crates/spectra-mcp/src/client.rs 70.4%

Keyboard