lib.rs 86.6%

259 of 299 lines run, 44 of 90 functions · run #363 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`].

pub mod witness;

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) {}

    /// Vet a push by what it adds before anything of it is stored or any
    /// reference moves (spec §16.1): `bundle` is the push as decoded, its
    /// changes with their lines, `updates` the references it would move.
    /// A host refuses the whole push by returning a [`Failure`], whose
    /// text reaches the client as the push's error, as it is, several
    /// lines included; it should answer neither 401, 403 nor 404, which a
    /// client takes for a credential it should change. Called for every
    /// part of a push sent in parts (each part's changes are its own),
    /// outside the repository's push lock, so a slow vet holds up no
    /// other push. The default accepts everything at no cost.
    fn vet_push(
        &self,
        _name: &str,
        _repo: &Repo,
        _bundle: &oxy_core::protocol::Bundle,
        _updates: &[oxy_core::protocol::RefUpdate],
        _headers: &HeaderMap,
    ) -> Result<(), Failure> {
        Ok(())
    }

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

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

Keyboard