lib.rs 85.7%

246 of 287 lines run, 38 of 83 functions · run #320 on main · run missed

//! Reference HTTP server for the Oxygen wire protocol (spec §15.1, §16).
//!
//! Serves every repository directory under a root at `/{repo}/oxy/v1/...`,
//! over TLS when a certificate and key are given, else plain HTTP for use
//! behind a TLS-terminating proxy or on a loopback interface (spec §15.1).
//!
//! Authentication: when bearer tokens are configured, `push` requires one;
//! reads are open. With no tokens configured everything is open (development).
//!
//! Hosts embed the protocol by implementing [`Backend`] (name resolution
//! and authorization) and routing to [`Server::handle`]; `router` is the
//! standalone server built on [`DirBackend`].

use axum::body::Bytes;
use axum::extract::{Path, State};
use axum::http::{header, HeaderMap, Method, StatusCode};
use axum::response::{IntoResponse, Response};
use axum::routing::any;
use axum::Router;
use oxy_core::protocol::{wire, CONTENT_TYPE};
use oxy_core::repo::Repo;
use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::{Arc, Mutex};

#[derive(Clone, Debug)]
pub struct ServerConfig {
    /// Directory containing one repository per subdirectory.
    pub root: PathBuf,
    /// Bearer tokens allowed to push; empty means no authentication.
    pub tokens: Vec<String>,
    /// Serve HTTPS with this certificate chain and private key (PEM files).
    pub tls: Option<TlsFiles>,
}

#[derive(Clone, Debug)]
pub struct TlsFiles {
    pub cert: PathBuf,
    pub key: PathBuf,
}

/// Which kind of access a request needs (spec §15.1: reads may be open;
/// a push must be authenticated when any credential is configured).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Access {
    Read,
    Push,
}

/// What a host provides to the protocol server: how a repository name maps
/// to a repository on disk and who may do what. `oxy serve` uses
/// [`DirBackend`]; a hub supplies its own with accounts and roles.
pub trait Backend: Send + Sync + 'static {
    /// Open the repository called `name`, or fail with the status to
    /// answer. An unknown name is `404`; a name the caller may not see
    /// SHOULD also be `404`, so private repositories are not enumerable.
    fn open(&self, name: &str) -> Result<Repo, Failure>;

    /// Decide whether this request may perform `access` on `name`.
    fn authorize(&self, name: &str, access: Access, headers: &HeaderMap) -> Result<(), Failure>;

    /// Called after a push was processed, with its per-reference results
    /// (accepted or refused), the states each accepted reference moved
    /// between, and the changes stored, for logs and cache invalidation.
    fn after_push(&self, _name: &str, _report: &oxy_core::repo::PushReport, _headers: &HeaderMap) {}

    /// Add the host's transparency log to a refs answer (spec §14.8): its
    /// checkpoint, and each attestation's entry and inclusion proof. A host
    /// without a log leaves it as it is.
    fn add_log(&self, _name: &str, _refs: &mut oxy_core::protocol::RefsResponse) {}

    /// The bookmark of `name` that pushes may never delete (its default),
    /// when the host keeps one apart from the repository's own config.
    fn default_bookmark(&self, _name: &str) -> Option<String> {
        None
    }
}

/// A protocol server over any [`Backend`], serialising the pushes to each
/// repository. Hosts route requests to [`Server::handle`].
pub struct Server {
    backend: Box<dyn Backend>,
    locks: Mutex<HashMap<String, Arc<Mutex<()>>>>,
}

/// An error response: a status and a plain-text body.
#[derive(Debug)]
pub struct Failure(pub StatusCode, pub String);

impl IntoResponse for Failure {
    fn into_response(self) -> Response {
        (self.0, self.1).into_response()
    }
}

impl From<oxy_core::repo::RepoError> for Failure {
    fn from(e: oxy_core::repo::RepoError) -> Failure {
        use oxy_core::repo::RepoError;
        // The server's own storage failing is not the client's fault.
        let status = match &e {
            RepoError::Io(_) | RepoError::Store(_) => StatusCode::INTERNAL_SERVER_ERROR,
            _ => StatusCode::BAD_REQUEST,
        };
        Failure(status, e.to_string())
    }
}

/// The wire protocol's endpoints (spec §16.1), named as in the URL.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Endpoint {
    Capabilities,
    Refs,
    Negotiate,
    Fetch,
    Objects,
    Checkpoint,
    Shallow,
    Push,
}

impl Endpoint {
    pub fn parse(name: &str) -> Option<Endpoint> {
        Some(match name {
            "capabilities" => Endpoint::Capabilities,
            "refs" => Endpoint::Refs,
            "negotiate" => Endpoint::Negotiate,
            "fetch" => Endpoint::Fetch,
            "objects" => Endpoint::Objects,
            "checkpoint" => Endpoint::Checkpoint,
            "shallow" => Endpoint::Shallow,
            "push" => Endpoint::Push,
            _ => return None,
        })
    }

    pub fn name(self) -> &'static str {
        match self {
            Endpoint::Capabilities => "capabilities",
            Endpoint::Refs => "refs",
            Endpoint::Negotiate => "negotiate",
            Endpoint::Fetch => "fetch",
            Endpoint::Objects => "objects",
            Endpoint::Checkpoint => "checkpoint",
            Endpoint::Shallow => "shallow",
            Endpoint::Push => "push",
        }
    }

    /// The HTTP method the endpoint answers to.
    pub fn method(self) -> Method {
        match self {
            Endpoint::Capabilities | Endpoint::Refs => Method::GET,
            _ => Method::POST,
        }
    }

    fn access(self) -> Access {
        match self {
            Endpoint::Push => Access::Push,
            _ => Access::Read,
        }
    }
}

fn ok(body: Vec<u8>) -> Response {
    ([(header::CONTENT_TYPE, CONTENT_TYPE)], body).into_response()
}

pub fn valid_repo_name(name: &str) -> bool {
    !name.is_empty()
        && !name.starts_with('.')
        && name
            .chars()
            .all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'))
}

impl Server {
    pub fn new(backend: impl Backend) -> Arc<Server> {
        Arc::new(Server {
            backend: Box::new(backend),
            locks: Mutex::new(HashMap::new()),
        })
    }

    pub fn backend(&self) -> &dyn Backend {
        self.backend.as_ref()
    }

    fn lock_for(&self, name: &str) -> Arc<Mutex<()>> {
        self.locks
            .lock()
            .unwrap()
            .entry(name.to_string())
            .or_default()
            .clone()
    }

    /// Answer one protocol request for repository `name`. `method` is
    /// checked against the endpoint; the body is the raw CBOR request.
    pub async fn handle(
        self: &Arc<Self>,
        name: String,
        endpoint: Endpoint,
        method: &Method,
        headers: &HeaderMap,
        body: Bytes,
    ) -> Response {
        if *method != endpoint.method() {
            return Failure(
                StatusCode::METHOD_NOT_ALLOWED,
                format!("{} is {}", endpoint.name(), endpoint.method()),
            )
            .into_response();
        }
        if let Err(f) = self.backend.authorize(&name, endpoint.access(), headers) {
            return f.into_response();
        }
        let claimed = headers
            .get(oxy_core::protocol::REPO_ID_HEADER)
            .and_then(|v| v.to_str().ok())
            .and_then(hex_id);
        let server = Arc::clone(self);
        let request_headers = headers.clone();
        let repo = name.clone();
        let result = tokio::task::spawn_blocking(move || {
            server.respond(&repo, endpoint, body, claimed, &request_headers)
        })
        .await;
        let failure = match result {
            Ok(Ok(r)) => return r,
            Ok(Err(f)) => f,
            Err(e) => Failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()),
        };
        // Name the operation and repository, in the log and for the client.
        let f = Failure(
            failure.0,
            format!("{} of {name}: {}", endpoint.name(), failure.1),
        );
        eprintln!("oxy-server: {}: {}", f.0.as_u16(), f.1);
        f.into_response()
    }

    fn respond(
        &self,
        name: &str,
        endpoint: Endpoint,
        body: Bytes,
        claimed: Option<[u8; 16]>,
        headers: &HeaderMap,
    ) -> Result<Response, Failure> {
        let r = self.backend.open(name)?;
        Ok(match endpoint {
            Endpoint::Capabilities => ok(wire::encode_capabilities(r.id()?)),
            Endpoint::Refs => {
                let mut refs = r.remote_refs()?;
                if let Some(d) = self.backend.default_bookmark(name) {
                    refs.default_bookmark = Some(d);
                }
                self.backend.add_log(name, &mut refs);
                ok(wire::encode_refs(r.id()?, &refs))
            }
            Endpoint::Negotiate => {
                let (have, want) = wire::decode_negotiate(&body)?;
                ok(wire::encode_hashes(&r.negotiate(&have, &want)?))
            }
            Endpoint::Fetch => {
                let (changes, max_blob) = wire::decode_fetch(&body)?;
                ok(wire::encode_bundle(
                    &r.bundle_for_filtered(&changes, max_blob)?,
                ))
            }
            Endpoint::Objects => {
                let refs = wire::decode_hashes(&body)?;
                let bundle = oxy_core::protocol::Bundle {
                    objects: r.objects_for(&refs)?,
                    ..Default::default()
                };
                ok(wire::encode_bundle(&bundle))
            }
            Endpoint::Checkpoint => {
                let heads = wire::decode_hashes(&body)?;
                let lock = self.lock_for(name);
                let _guard = lock.lock().unwrap();
                ok(wire::encode_bundle(&r.checkpoint_bundle_for(&heads)?))
            }
            Endpoint::Shallow => {
                let (heads, depth) = wire::decode_shallow(&body)?;
                ok(wire::encode_hashes(&r.shallow_changes(&heads, depth)?))
            }
            Endpoint::Push => {
                let (bundle, updates, policy, tags) = wire::decode_push(&body)?;
                let lock = self.lock_for(name);
                let _guard = lock.lock().unwrap();
                if r.is_unbound() {
                    // The first push binds the repository to the pusher's id (spec §16.1).
                    match claimed {
                        Some(id) => r.bind_id(id)?,
                        None => {
                            return Err(Failure(
                                StatusCode::BAD_REQUEST,
                                format!(
                                    "this repository is unbound; push with a client that sends {}",
                                    oxy_core::protocol::REPO_ID_HEADER
                                ),
                            ))
                        }
                    }
                }
                let protected = self.backend.default_bookmark(name);
                let (refused, updates): (Vec<_>, Vec<_>) = updates.into_iter().partition(|u| {
                    u.new_state.is_zero() && protected.as_deref() == Some(u.name.as_str())
                });
                let mut report = r.receive_push_report(bundle, updates, policy, tags)?;
                // The request named references, all refused here: it was no
                // push of objects alone, whatever the repository saw.
                if !refused.is_empty() {
                    report
                        .results
                        .retain(|r| r.name != oxy_core::repo::OBJECTS_RESULT);
                }
                for u in refused {
                    report.results.push(oxy_core::protocol::RefResult {
                        name: u.name.clone(),
                        ok: false,
                        reason: format!(
                            "{:?} is this repository's default bookmark and cannot be deleted",
                            u.name
                        ),
                    });
                }
                for r in report.results.iter().filter(|r| !r.ok) {
                    eprintln!(
                        "oxy-server: push to {name}: {} refused: {}",
                        r.name, r.reason
                    );
                }
                self.backend.after_push(name, &report, headers);
                ok(wire::encode_push_response(&report.results))
            }
        })
    }
}

/// The backend of `oxy serve`: one repository per subdirectory of a root,
/// open reads, and pushes gated by a list of bearer tokens.
pub struct DirBackend {
    pub root: PathBuf,
    pub tokens: Vec<String>,
}

impl Backend for DirBackend {
    fn open(&self, name: &str) -> Result<Repo, Failure> {
        if !valid_repo_name(name) {
            return Err(Failure(StatusCode::NOT_FOUND, "no such repository".into()));
        }
        let dir = self.root.join(name);
        if !dir.join(".oxy").is_dir() {
            return Err(Failure(StatusCode::NOT_FOUND, "no such repository".into()));
        }
        Repo::open(&dir).map_err(|e| Failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()))
    }

    fn default_bookmark(&self, name: &str) -> Option<String> {
        self.open(name).ok().map(|r| r.config.bookmark.clone())
    }

    fn authorize(&self, _name: &str, access: Access, headers: &HeaderMap) -> Result<(), Failure> {
        if access == Access::Read || self.tokens.is_empty() {
            return Ok(());
        }
        match bearer_token(headers) {
            Some(t) if self.tokens.iter().any(|x| x == t) => Ok(()),
            _ => Err(Failure(
                StatusCode::UNAUTHORIZED,
                "a valid bearer token is required to push".into(),
            )),
        }
    }
}

fn hex_id(h: &str) -> Option<[u8; 16]> {
    let h = h.trim();
    if h.len() != 32 {
        return None;
    }
    let mut out = [0u8; 16];
    for (i, byte) in out.iter_mut().enumerate() {
        *byte = u8::from_str_radix(&h[2 * i..2 * i + 2], 16).ok()?;
    }
    Some(out)
}

/// The token of an `Authorization: Bearer` header, if any.
pub fn bearer_token(headers: &HeaderMap) -> Option<&str> {
    headers
        .get(header::AUTHORIZATION)
        .and_then(|v| v.to_str().ok())
        .and_then(|v| v.strip_prefix("Bearer "))
        .map(str::trim)
}

async fn dispatch(
    State(server): State<Arc<Server>>,
    Path((repo, endpoint)): Path<(String, String)>,
    method: Method,
    headers: HeaderMap,
    body: Bytes,
) -> Response {
    match Endpoint::parse(&endpoint) {
        Some(e) => server.handle(repo, e, &method, &headers, body).await,
        None => Failure(StatusCode::NOT_FOUND, "no such endpoint".into()).into_response(),
    }
}

/// The router of `oxy serve`: `/{repo}/oxy/v1/{endpoint}` over a [`DirBackend`].
pub fn router(cfg: ServerConfig) -> Router {
    let server = Server::new(DirBackend {
        root: cfg.root,
        tokens: cfg.tokens,
    });
    Router::new()
        .route("/{repo}/oxy/v1/{endpoint}", any(dispatch))
        .with_state(server)
}

/// Serve on an already-bound listener until the process ends; HTTPS when
/// `cfg.tls` is set.
pub async fn serve(listener: std::net::TcpListener, cfg: ServerConfig) -> std::io::Result<()> {
    listener.set_nonblocking(true)?;
    match cfg.tls.clone() {
        Some(tls) => {
            let _ = rustls::crypto::ring::default_provider().install_default();
            let rustls_cfg =
                axum_server::tls_rustls::RustlsConfig::from_pem_file(&tls.cert, &tls.key)
                    .await
                    .map_err(|e| std::io::Error::other(format!("loading TLS files: {e}")))?;
            axum_server::from_tcp_rustls(listener, rustls_cfg)?
                .serve(router(cfg).into_make_service())
                .await
        }
        None => {
            let listener = tokio::net::TcpListener::from_std(listener)?;
            axum::serve(listener, router(cfg)).await
        }
    }
}

/// Build a runtime and serve; for the CLI and for tests on a background thread.
pub fn run_blocking(listener: std::net::TcpListener, cfg: ServerConfig) -> std::io::Result<()> {
    let rt = tokio::runtime::Builder::new_multi_thread()
        .enable_all()
        .build()?;
    rt.block_on(serve(listener, cfg))
}

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

1		//! Reference HTTP server for the Oxygen wire protocol (spec §15.1, §16).
2		//!
3		//! Serves every repository directory under a root at `/{repo}/oxy/v1/...`,
4		//! over TLS when a certificate and key are given, else plain HTTP for use
5		//! behind a TLS-terminating proxy or on a loopback interface (spec §15.1).
6		//!
7		//! Authentication: when bearer tokens are configured, `push` requires one;
8		//! reads are open. With no tokens configured everything is open (development).
9		//!
10		//! Hosts embed the protocol by implementing [`Backend`] (name resolution
11		//! and authorization) and routing to [`Server::handle`]; `router` is the
12		//! standalone server built on [`DirBackend`].
13
14		use axum::body::Bytes;
15		use axum::extract::{Path, State};
16		use axum::http::{header, HeaderMap, Method, StatusCode};
17		use axum::response::{IntoResponse, Response};
18		use axum::routing::any;
19		use axum::Router;
20		use oxy_core::protocol::{wire, CONTENT_TYPE};
21		use oxy_core::repo::Repo;
22		use std::collections::HashMap;
23		use std::path::PathBuf;
24		use std::sync::{Arc, Mutex};
25
26		#[derive(Clone, Debug)]
27		pub struct ServerConfig {
28		/// Directory containing one repository per subdirectory.
29		pub root: PathBuf,
30		/// Bearer tokens allowed to push; empty means no authentication.
31		pub tokens: Vec<String>,
32		/// Serve HTTPS with this certificate chain and private key (PEM files).
33		pub tls: Option<TlsFiles>,
34		}
35
36		#[derive(Clone, Debug)]
37		pub struct TlsFiles {
38		pub cert: PathBuf,
39		pub key: PathBuf,
40		}
41
42		/// Which kind of access a request needs (spec §15.1: reads may be open;
43		/// a push must be authenticated when any credential is configured).
44		#[derive(Clone, Copy, Debug, PartialEq, Eq)]
45		pub enum Access {
46		Read,
47		Push,
48		}
49
50		/// What a host provides to the protocol server: how a repository name maps
51		/// to a repository on disk and who may do what. `oxy serve` uses
52		/// [`DirBackend`]; a hub supplies its own with accounts and roles.
53		pub trait Backend: Send + Sync + 'static {
54		/// Open the repository called `name`, or fail with the status to
55		/// answer. An unknown name is `404`; a name the caller may not see
56		/// SHOULD also be `404`, so private repositories are not enumerable.
57		fn open(&self, name: &str) -> Result<Repo, Failure>;
58
59		/// Decide whether this request may perform `access` on `name`.
60		fn authorize(&self, name: &str, access: Access, headers: &HeaderMap) -> Result<(), Failure>;
61
62		/// Called after a push was processed, with its per-reference results
63		/// (accepted or refused), the states each accepted reference moved
64		/// between, and the changes stored, for logs and cache invalidation.
65	35×	fn after_push(&self, _name: &str, _report: &oxy_core::repo::PushReport, _headers: &HeaderMap) {}
66
67		/// Add the host's transparency log to a refs answer (spec §14.8): its
68		/// checkpoint, and each attestation's entry and inclusion proof. A host
69		/// without a log leaves it as it is.
70	119×	fn add_log(&self, _name: &str, _refs: &mut oxy_core::protocol::RefsResponse) {}
71
72		/// The bookmark of `name` that pushes may never delete (its default),
73		/// when the host keeps one apart from the repository's own config.
74	5×	fn default_bookmark(&self, _name: &str) -> Option<String> {
75	5×	None
76	5×	}
77		}
78
79		/// A protocol server over any [`Backend`], serialising the pushes to each
80		/// repository. Hosts route requests to [`Server::handle`].
81		pub struct Server {
82		backend: Box<dyn Backend>,
83		locks: Mutex<HashMap<String, Arc<Mutex<()>>>>,
84		}
85
86		/// An error response: a status and a plain-text body.
87		#[derive(Debug)]
88		pub struct Failure(pub StatusCode, pub String);
89
90		impl IntoResponse for Failure {
91	8×	fn into_response(self) -> Response {
92	8×	(self.0, self.1).into_response()
93	8×	}
94		}
95
96		impl From<oxy_core::repo::RepoError> for Failure {
97	0×	fn from(e: oxy_core::repo::RepoError) -> Failure {
98		use oxy_core::repo::RepoError;
99		// The server's own storage failing is not the client's fault.
100	0×	let status = match &e {
101	0×	RepoError::Io(_) \| RepoError::Store(_) => StatusCode::INTERNAL_SERVER_ERROR,
102	0×	_ => StatusCode::BAD_REQUEST,
103		};
104	0×	Failure(status, e.to_string())
105	0×	}
106		}
107
108		/// The wire protocol's endpoints (spec §16.1), named as in the URL.
109		#[derive(Clone, Copy, Debug, PartialEq, Eq)]
110		pub enum Endpoint {
111		Capabilities,
112		Refs,
113		Negotiate,
114		Fetch,
115		Objects,
116		Checkpoint,
117		Shallow,
118		Push,
119		}
120
121		impl Endpoint {
122	380×	pub fn parse(name: &str) -> Option<Endpoint> {
123	380×	Some(match name {
124	380×	"capabilities" => Endpoint::Capabilities,
125	255×	"refs" => Endpoint::Refs,
126	136×	"negotiate" => Endpoint::Negotiate,
127	89×	"fetch" => Endpoint::Fetch,
128	42×	"objects" => Endpoint::Objects,
129	41×	"checkpoint" => Endpoint::Checkpoint,
130	41×	"shallow" => Endpoint::Shallow,
131	41×	"push" => Endpoint::Push,
132	0×	_ => return None,
133		})
134	380×	}
135
136	2×	pub fn name(self) -> &'static str {
137	2×	match self {
138	2×	Endpoint::Capabilities => "capabilities",
139	0×	Endpoint::Refs => "refs",
140	0×	Endpoint::Negotiate => "negotiate",
141	0×	Endpoint::Fetch => "fetch",
142	0×	Endpoint::Objects => "objects",
143	0×	Endpoint::Checkpoint => "checkpoint",
144	0×	Endpoint::Shallow => "shallow",
145	0×	Endpoint::Push => "push",
146		}
147	2×	}
148
149		/// The HTTP method the endpoint answers to.
150	380×	pub fn method(self) -> Method {
151	380×	match self {
152	244×	Endpoint::Capabilities \| Endpoint::Refs => Method::GET,
153	136×	_ => Method::POST,
154		}
155	380×	}
156
157	380×	fn access(self) -> Access {
158	380×	match self {
159	41×	Endpoint::Push => Access::Push,
160	339×	_ => Access::Read,
161		}
162	380×	}
163		}
164
165	372×	fn ok(body: Vec<u8>) -> Response {
166	372×	([(header::CONTENT_TYPE, CONTENT_TYPE)], body).into_response()
167	372×	}
168
169	513×	pub fn valid_repo_name(name: &str) -> bool {
170	513×	!name.is_empty()
171	513×	&& !name.starts_with('.')
172	512×	&& name
173	512×	.chars()
174	2829×	.all(\|c\| c.is_ascii_alphanumeric() \|\| matches!(c, '.' \| '_' \| '-'))
175	513×	}
176
177		impl Server {
178	12×	pub fn new(backend: impl Backend) -> Arc<Server> {
179	12×	Arc::new(Server {
180	12×	backend: Box::new(backend),
181	12×	locks: Mutex::new(HashMap::new()),
182	12×	})
183	12×	}
184
185	0×	pub fn backend(&self) -> &dyn Backend {
186	0×	self.backend.as_ref()
187	0×	}
188
189	36×	fn lock_for(&self, name: &str) -> Arc<Mutex<()>> {
190	36×	self.locks
191	36×	.lock()
192	36×	.unwrap()
193	36×	.entry(name.to_string())
194	36×	.or_default()
195	36×	.clone()
196	36×	}
197
198		/// Answer one protocol request for repository `name`. `method` is
199		/// checked against the endpoint; the body is the raw CBOR request.
200	380×	pub async fn handle(
201	380×	self: &Arc<Self>,
202	380×	name: String,
203	380×	endpoint: Endpoint,
204	380×	method: &Method,
205	380×	headers: &HeaderMap,
206	380×	body: Bytes,
207	380×	) -> Response {
208	380×	if *method != endpoint.method() {
209	0×	return Failure(
210	0×	StatusCode::METHOD_NOT_ALLOWED,
211	0×	format!("{} is {}", endpoint.name(), endpoint.method()),
212	0×	)
213	0×	.into_response();
214	380×	}
215	380×	if let Err(f) = self.backend.authorize(&name, endpoint.access(), headers) {
216	6×	return f.into_response();
217	374×	}
218	374×	let claimed = headers
219	374×	.get(oxy_core::protocol::REPO_ID_HEADER)
220	374×	.and_then(\|v\| v.to_str().ok())
221	374×	.and_then(hex_id);
222	374×	let server = Arc::clone(self);
223	374×	let request_headers = headers.clone();
224	374×	let repo = name.clone();
225	374×	let result = tokio::task::spawn_blocking(move \|\| {
226	374×	server.respond(&repo, endpoint, body, claimed, &request_headers)
227	374×	})
228	374×	.await;
229	374×	let failure = match result {
230	372×	Ok(Ok(r)) => return r,
231	2×	Ok(Err(f)) => f,
232	0×	Err(e) => Failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()),
233		};
234		// Name the operation and repository, in the log and for the client.
235	2×	let f = Failure(
236	2×	failure.0,
237	2×	format!("{} of {name}: {}", endpoint.name(), failure.1),
238	2×	);
239	2×	eprintln!("oxy-server: {}: {}", f.0.as_u16(), f.1);
240	2×	f.into_response()
241	380×	}
242
243	374×	fn respond(
244	374×	&self,
245	374×	name: &str,
246	374×	endpoint: Endpoint,
247	374×	body: Bytes,
248	374×	claimed: Option<[u8; 16]>,
249	374×	headers: &HeaderMap,
250	374×	) -> Result<Response, Failure> {
251	374×	let r = self.backend.open(name)?;
252	372×	Ok(match endpoint {
253	122×	Endpoint::Capabilities => ok(wire::encode_capabilities(r.id()?)),
254		Endpoint::Refs => {
255	119×	let mut refs = r.remote_refs()?;
256	119×	if let Some(d) = self.backend.default_bookmark(name) {
257	115×	refs.default_bookmark = Some(d);
258	115×	}
259	119×	self.backend.add_log(name, &mut refs);
260	119×	ok(wire::encode_refs(r.id()?, &refs))
261		}
262		Endpoint::Negotiate => {
263	47×	let (have, want) = wire::decode_negotiate(&body)?;
264	47×	ok(wire::encode_hashes(&r.negotiate(&have, &want)?))
265		}
266		Endpoint::Fetch => {
267	47×	let (changes, max_blob) = wire::decode_fetch(&body)?;
268	47×	ok(wire::encode_bundle(
269	47×	&r.bundle_for_filtered(&changes, max_blob)?,
270		))
271		}
272		Endpoint::Objects => {
273	1×	let refs = wire::decode_hashes(&body)?;
274	1×	let bundle = oxy_core::protocol::Bundle {
275	1×	objects: r.objects_for(&refs)?,
276	1×	..Default::default()
277		};
278	1×	ok(wire::encode_bundle(&bundle))
279		}
280		Endpoint::Checkpoint => {
281	0×	let heads = wire::decode_hashes(&body)?;
282	0×	let lock = self.lock_for(name);
283	0×	let _guard = lock.lock().unwrap();
284	0×	ok(wire::encode_bundle(&r.checkpoint_bundle_for(&heads)?))
285		}
286		Endpoint::Shallow => {
287	0×	let (heads, depth) = wire::decode_shallow(&body)?;
288	0×	ok(wire::encode_hashes(&r.shallow_changes(&heads, depth)?))
289		}
290		Endpoint::Push => {
291	36×	let (bundle, updates, policy, tags) = wire::decode_push(&body)?;
292	36×	let lock = self.lock_for(name);
293	36×	let _guard = lock.lock().unwrap();
294	36×	if r.is_unbound() {
295		// The first push binds the repository to the pusher's id (spec §16.1).
296	2×	match claimed {
297	2×	Some(id) => r.bind_id(id)?,
298		None => {
299	0×	return Err(Failure(
300	0×	StatusCode::BAD_REQUEST,
301	0×	format!(
302	0×	"this repository is unbound; push with a client that sends {}",
303	0×	oxy_core::protocol::REPO_ID_HEADER
304	0×	),
305	0×	))
306		}
307		}
308	34×	}
309	36×	let protected = self.backend.default_bookmark(name);
310	36×	let (refused, updates): (Vec<_>, Vec<_>) = updates.into_iter().partition(\|u\| {
311	36×	u.new_state.is_zero() && protected.as_deref() == Some(u.name.as_str())
312	36×	});
313	36×	let mut report = r.receive_push_report(bundle, updates, policy, tags)?;
314		// The request named references, all refused here: it was no
315		// push of objects alone, whatever the repository saw.
316	36×	if !refused.is_empty() {
317	1×	report
318	1×	.results
319	1×	.retain(\|r\| r.name != oxy_core::repo::OBJECTS_RESULT);
320	35×	}
321	36×	for u in refused {
322	1×	report.results.push(oxy_core::protocol::RefResult {
323	1×	name: u.name.clone(),
324	1×	ok: false,
325	1×	reason: format!(
326	1×	"{:?} is this repository's default bookmark and cannot be deleted",
327	1×	u.name
328	1×	),
329	1×	});
330	1×	}
331	37×	for r in report.results.iter().filter(\|r\| !r.ok) {
332	16×	eprintln!(
333	16×	"oxy-server: push to {name}: {} refused: {}",
334	16×	r.name, r.reason
335	16×	);
336	16×	}
337	36×	self.backend.after_push(name, &report, headers);
338	36×	ok(wire::encode_push_response(&report.results))
339		}
340		})
341	374×	}
342		}
343
344		/// The backend of `oxy serve`: one repository per subdirectory of a root,
345		/// open reads, and pushes gated by a list of bearer tokens.
346		pub struct DirBackend {
347		pub root: PathBuf,
348		pub tokens: Vec<String>,
349		}
350
351		impl Backend for DirBackend {
352	513×	fn open(&self, name: &str) -> Result<Repo, Failure> {
353	513×	if !valid_repo_name(name) {
354	1×	return Err(Failure(StatusCode::NOT_FOUND, "no such repository".into()));
355	512×	}
356	512×	let dir = self.root.join(name);
357	512×	if !dir.join(".oxy").is_dir() {
358	1×	return Err(Failure(StatusCode::NOT_FOUND, "no such repository".into()));
359	511×	}
360	511×	Repo::open(&dir).map_err(\|e\| Failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()))
361	513×	}
362
363	150×	fn default_bookmark(&self, name: &str) -> Option<String> {
364	150×	self.open(name).ok().map(\|r\| r.config.bookmark.clone())
365	150×	}
366
367	367×	fn authorize(&self, _name: &str, access: Access, headers: &HeaderMap) -> Result<(), Failure> {
368	367×	if access == Access::Read \|\| self.tokens.is_empty() {
369	361×	return Ok(());
370	6×	}
371	6×	match bearer_token(headers) {
372	5×	Some(t) if self.tokens.iter().any(\|x\| x == t) => Ok(()),
373	4×	_ => Err(Failure(
374	4×	StatusCode::UNAUTHORIZED,
375	4×	"a valid bearer token is required to push".into(),
376	4×	)),
377		}
378	367×	}
379		}
380
381	351×	fn hex_id(h: &str) -> Option<[u8; 16]> {
382	351×	let h = h.trim();
383	351×	if h.len() != 32 {
384	0×	return None;
385	351×	}
386	351×	let mut out = [0u8; 16];
387	5616×	for (i, byte) in out.iter_mut().enumerate() {
388	5616×	byte = u8::from_str_radix(&h[2 i..2 * i + 2], 16).ok()?;
389		}
390	351×	Some(out)
391	351×	}
392
393		/// The token of an `Authorization: Bearer` header, if any.
394	19×	pub fn bearer_token(headers: &HeaderMap) -> Option<&str> {
395	19×	headers
396	19×	.get(header::AUTHORIZATION)
397	19×	.and_then(\|v\| v.to_str().ok())
398	19×	.and_then(\|v\| v.strip_prefix("Bearer "))
399	19×	.map(str::trim)
400	19×	}
401
402	367×	async fn dispatch(
403	367×	State(server): State<Arc<Server>>,
404	367×	Path((repo, endpoint)): Path<(String, String)>,
405	367×	method: Method,
406	367×	headers: HeaderMap,
407	367×	body: Bytes,
408	367×	) -> Response {
409	367×	match Endpoint::parse(&endpoint) {
410	367×	Some(e) => server.handle(repo, e, &method, &headers, body).await,
411	0×	None => Failure(StatusCode::NOT_FOUND, "no such endpoint".into()).into_response(),
412		}
413	367×	}
414
415		/// The router of `oxy serve`: `/{repo}/oxy/v1/{endpoint}` over a [`DirBackend`].
416	11×	pub fn router(cfg: ServerConfig) -> Router {
417	11×	let server = Server::new(DirBackend {
418	11×	root: cfg.root,
419	11×	tokens: cfg.tokens,
420	11×	});
421	11×	Router::new()
422	11×	.route("/{repo}/oxy/v1/{endpoint}", any(dispatch))
423	11×	.with_state(server)
424	11×	}
425
426		/// Serve on an already-bound listener until the process ends; HTTPS when
427		/// `cfg.tls` is set.
428	11×	pub async fn serve(listener: std::net::TcpListener, cfg: ServerConfig) -> std::io::Result<()> {
429	11×	listener.set_nonblocking(true)?;
430	11×	match cfg.tls.clone() {
431	1×	Some(tls) => {
432	1×	let _ = rustls::crypto::ring::default_provider().install_default();
433	1×	let rustls_cfg =
434	1×	axum_server::tls_rustls::RustlsConfig::from_pem_file(&tls.cert, &tls.key)
435	1×	.await
436	1×	.map_err(\|e\| std::io::Error::other(format!("loading TLS files: {e}")))?;
437	1×	axum_server::from_tcp_rustls(listener, rustls_cfg)?
438	1×	.serve(router(cfg).into_make_service())
439	1×	.await
440		}
441		None => {
442	10×	let listener = tokio::net::TcpListener::from_std(listener)?;
443	10×	axum::serve(listener, router(cfg)).await
444		}
445		}
446	0×	}
447
448		/// Build a runtime and serve; for the CLI and for tests on a background thread.
449	11×	pub fn run_blocking(listener: std::net::TcpListener, cfg: ServerConfig) -> std::io::Result<()> {
450	11×	let rt = tokio::runtime::Builder::new_multi_thread()
451	11×	.enable_all()
452	11×	.build()?;
453	11×	rt.block_on(serve(listener, cfg))
454	11×	}

Coverage / crates/oxy-server/src/lib.rs 85.7%

Keyboard