lib.rs 83.2%

288 of 346 lines run, 56 of 113 functions · run #390 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) {}

    /// Tailor a refs answer to the client asking, by its request headers
    /// (its `User-Agent` and the features it declares in `Oxy-Features`),
    /// after [`Backend::add_log`]. The default leaves out the tags a client
    /// that does not declare `certified-tags` would refuse
    /// ([`Repo::refs_for_client`], oxygen#131); a host that overrides it
    /// should apply that too ([`tailor_refs`]).
    fn adjust_refs(
        &self,
        _name: &str,
        repo: &Repo,
        refs: &mut oxy_core::protocol::RefsResponse,
        headers: &HeaderMap,
    ) {
        tailor_refs(repo, refs, headers);
    }

    /// Whether tag `tag` of `name` may be withdrawn (oxygenhub#301): called
    /// for each withdrawal a push carries, before the repository sees it.
    /// A host refuses one it depends on (a forge's release names the tag)
    /// with the reason, which is that withdrawal's result. The default
    /// allows every one; the policy is checked after, as for any push.
    fn vet_tag_withdrawal(&self, _name: &str, _tag: &str) -> Result<(), String> {
        Ok(())
    }

    /// 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,
    CheckpointIndex,
    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,
            "checkpoint-index" => Endpoint::CheckpointIndex,
            "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::CheckpointIndex => "checkpoint-index",
            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);
                self.backend.adjust_refs(name, &r, &mut refs, headers);
                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();
                let bundle = r.checkpoint_bundle_for(&heads)?;
                let _t = oxy_core::timing::phase("serve: encode the checkpoint");
                ok(wire::encode_bundle(&bundle))
            }
            Endpoint::CheckpointIndex => {
                let heads = wire::decode_hashes(&body)?;
                let lock = self.lock_for(name);
                let _guard = lock.lock().unwrap();
                ok(wire::encode_bundle(&r.checkpoint_index_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 kept_tags = Vec::new();
                let mut withdrawals_refused = Vec::new();
                for t in tags {
                    match t
                        .is_withdrawal()
                        .then(|| self.backend.vet_tag_withdrawal(name, &t.name))
                    {
                        Some(Err(reason)) => withdrawals_refused.push((t.name, reason)),
                        _ => kept_tags.push(t),
                    }
                }
                let mut report = r.receive_push_report(bundle, updates, policy, kept_tags)?;
                // The request named references, all refused here: it was no
                // push of objects alone, whatever the repository saw.
                if !refused.is_empty() || !withdrawals_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 (tag, reason) in withdrawals_refused {
                    report.results.push(oxy_core::protocol::RefResult {
                        name: format!("tags/{tag}"),
                        ok: false,
                        reason,
                    });
                }
                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 features a request declares in its `Oxy-Features` header, as the
/// header's text; `None` when it sent none (a client of the 0.5.0 era).
pub fn client_features(headers: &HeaderMap) -> Option<&str> {
    headers
        .get(oxy_core::protocol::FEATURES_HEADER)
        .and_then(|v| v.to_str().ok())
}

/// Tailor `refs` of `repo` to the client whose request carried `headers`:
/// the shared rule of [`Repo::refs_for_client`], which every host applies.
pub fn tailor_refs(repo: &Repo, refs: &mut oxy_core::protocol::RefsResponse, headers: &HeaderMap) {
    repo.refs_for_client(refs, client_features(headers));
}

/// 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 largest request `oxy serve` takes: a push part is about
/// `push.batch-bytes` (64 MiB), but one change can weigh more; OxygenHub's
/// default `push_body_limit` is the same.
pub const BODY_LIMIT: usize = if usize::BITS > 32 {
    4 << 30
} else {
    usize::MAX
};

/// 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,
    });
    // Without a limit of its own a request takes axum's 2 MB, and a larger
    // push was cut off with no word in the log ("Broken pipe" at the client).
    Router::new()
        .route("/{repo}/oxy/v1/{endpoint}", any(dispatch))
        .layer(axum::extract::DefaultBodyLimit::max(BODY_LIMIT))
        .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	36×	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	36×	fn vet_push(
80	36×	&self,
81	36×	_name: &str,
82	36×	_repo: &Repo,
83	36×	_bundle: &oxy_core::protocol::Bundle,
84	36×	_updates: &[oxy_core::protocol::RefUpdate],
85	36×	_headers: &HeaderMap,
86	36×	) -> Result<(), Failure> {
87	36×	Ok(())
88	36×	}
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	142×	fn add_log(&self, _name: &str, _refs: &mut oxy_core::protocol::RefsResponse) {}
94
95		/// Tailor a refs answer to the client asking, by its request headers
96		/// (its `User-Agent` and the features it declares in `Oxy-Features`),
97		/// after [`Backend::add_log`]. The default leaves out the tags a client
98		/// that does not declare `certified-tags` would refuse
99		/// ([`Repo::refs_for_client`], oxygen#131); a host that overrides it
100		/// should apply that too ([`tailor_refs`]).
101	142×	fn adjust_refs(
102	142×	&self,
103	142×	_name: &str,
104	142×	repo: &Repo,
105	142×	refs: &mut oxy_core::protocol::RefsResponse,
106	142×	headers: &HeaderMap,
107	142×	) {
108	142×	tailor_refs(repo, refs, headers);
109	142×	}
110
111		/// Whether tag `tag` of `name` may be withdrawn (oxygenhub#301): called
112		/// for each withdrawal a push carries, before the repository sees it.
113		/// A host refuses one it depends on (a forge's release names the tag)
114		/// with the reason, which is that withdrawal's result. The default
115		/// allows every one; the policy is checked after, as for any push.
116	0×	fn vet_tag_withdrawal(&self, _name: &str, _tag: &str) -> Result<(), String> {
117	0×	Ok(())
118	0×	}
119
120		/// The bookmark of `name` that pushes may never delete (its default),
121		/// when the host keeps one apart from the repository's own config.
122	28×	fn default_bookmark(&self, _name: &str) -> Option<String> {
123	28×	None
124	28×	}
125		}
126
127		/// A protocol server over any [`Backend`], serialising the pushes to each
128		/// repository. Hosts route requests to [`Server::handle`].
129		pub struct Server {
130		backend: Box<dyn Backend>,
131		locks: Mutex<HashMap<String, Arc<Mutex<()>>>>,
132		}
133
134		/// An error response: a status and a plain-text body.
135		#[derive(Debug)]
136		pub struct Failure(pub StatusCode, pub String);
137
138		impl IntoResponse for Failure {
139	9×	fn into_response(self) -> Response {
140	9×	(self.0, self.1).into_response()
141	9×	}
142		}
143
144		impl From<oxy_core::repo::RepoError> for Failure {
145	0×	fn from(e: oxy_core::repo::RepoError) -> Failure {
146		use oxy_core::repo::RepoError;
147		// The server's own storage failing is not the client's fault.
148	0×	let status = match &e {
149	0×	RepoError::Io(_) \| RepoError::Store(_) => StatusCode::INTERNAL_SERVER_ERROR,
150	0×	_ => StatusCode::BAD_REQUEST,
151		};
152	0×	Failure(status, e.to_string())
153	0×	}
154		}
155
156		/// The wire protocol's endpoints (spec §16.1), named as in the URL.
157		#[derive(Clone, Copy, Debug, PartialEq, Eq)]
158		pub enum Endpoint {
159		Capabilities,
160		Refs,
161		Negotiate,
162		Fetch,
163		Objects,
164		Checkpoint,
165		CheckpointIndex,
166		Shallow,
167		Push,
168		}
169
170		impl Endpoint {
171	438×	pub fn parse(name: &str) -> Option<Endpoint> {
172	438×	Some(match name {
173	438×	"capabilities" => Endpoint::Capabilities,
174	294×	"refs" => Endpoint::Refs,
175	152×	"negotiate" => Endpoint::Negotiate,
176	98×	"fetch" => Endpoint::Fetch,
177	44×	"objects" => Endpoint::Objects,
178	43×	"checkpoint" => Endpoint::Checkpoint,
179	43×	"checkpoint-index" => Endpoint::CheckpointIndex,
180	43×	"shallow" => Endpoint::Shallow,
181	43×	"push" => Endpoint::Push,
182	0×	_ => return None,
183		})
184	438×	}
185
186	3×	pub fn name(self) -> &'static str {
187	3×	match self {
188	2×	Endpoint::Capabilities => "capabilities",
189	0×	Endpoint::Refs => "refs",
190	0×	Endpoint::Negotiate => "negotiate",
191	0×	Endpoint::Fetch => "fetch",
192	0×	Endpoint::Objects => "objects",
193	0×	Endpoint::Checkpoint => "checkpoint",
194	0×	Endpoint::CheckpointIndex => "checkpoint-index",
195	0×	Endpoint::Shallow => "shallow",
196	1×	Endpoint::Push => "push",
197		}
198	3×	}
199
200		/// The HTTP method the endpoint answers to.
201	438×	pub fn method(self) -> Method {
202	438×	match self {
203	286×	Endpoint::Capabilities \| Endpoint::Refs => Method::GET,
204	152×	_ => Method::POST,
205		}
206	438×	}
207
208	438×	fn access(self) -> Access {
209	438×	match self {
210	43×	Endpoint::Push => Access::Push,
211	395×	_ => Access::Read,
212		}
213	438×	}
214		}
215
216	429×	fn ok(body: Vec<u8>) -> Response {
217	429×	([(header::CONTENT_TYPE, CONTENT_TYPE)], body).into_response()
218	429×	}
219
220	526×	pub fn valid_repo_name(name: &str) -> bool {
221	526×	!name.is_empty()
222	526×	&& !name.starts_with('.')
223	525×	&& name
224	525×	.chars()
225	2889×	.all(\|c\| c.is_ascii_alphanumeric() \|\| matches!(c, '.' \| '_' \| '-'))
226	526×	}
227
228		impl Server {
229	16×	pub fn new(backend: impl Backend) -> Arc<Server> {
230	16×	Arc::new(Server {
231	16×	backend: Box::new(backend),
232	16×	locks: Mutex::new(HashMap::new()),
233	16×	})
234	16×	}
235
236	0×	pub fn backend(&self) -> &dyn Backend {
237	0×	self.backend.as_ref()
238	0×	}
239
240	37×	fn lock_for(&self, name: &str) -> Arc<Mutex<()>> {
241	37×	self.locks
242	37×	.lock()
243	37×	.unwrap()
244	37×	.entry(name.to_string())
245	37×	.or_default()
246	37×	.clone()
247	37×	}
248
249		/// Answer one protocol request for repository `name`. `method` is
250		/// checked against the endpoint; the body is the raw CBOR request.
251	438×	pub async fn handle(
252	438×	self: &Arc<Self>,
253	438×	name: String,
254	438×	endpoint: Endpoint,
255	438×	method: &Method,
256	438×	headers: &HeaderMap,
257	438×	body: Bytes,
258	438×	) -> Response {
259	438×	if *method != endpoint.method() {
260	0×	return Failure(
261	0×	StatusCode::METHOD_NOT_ALLOWED,
262	0×	format!("{} is {}", endpoint.name(), endpoint.method()),
263	0×	)
264	0×	.into_response();
265	438×	}
266	438×	if let Err(f) = self.backend.authorize(&name, endpoint.access(), headers) {
267	6×	return f.into_response();
268	432×	}
269	432×	let claimed = headers
270	432×	.get(oxy_core::protocol::REPO_ID_HEADER)
271	432×	.and_then(\|v\| v.to_str().ok())
272	432×	.and_then(hex_id);
273	432×	let server = Arc::clone(self);
274	432×	let request_headers = headers.clone();
275	432×	let repo = name.clone();
276	432×	let result = tokio::task::spawn_blocking(move \|\| {
277	432×	server.respond(&repo, endpoint, body, claimed, &request_headers)
278	432×	})
279	432×	.await;
280	432×	let failure = match result {
281	429×	Ok(Ok(r)) => return r,
282	3×	Ok(Err(f)) => f,
283	0×	Err(e) => Failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()),
284		};
285		// Name the operation and repository, in the log and for the client.
286	3×	let f = Failure(
287	3×	failure.0,
288	3×	format!("{} of {name}: {}", endpoint.name(), failure.1),
289	3×	);
290	3×	eprintln!("oxy-server: {}: {}", f.0.as_u16(), f.1);
291	3×	f.into_response()
292	438×	}
293
294	432×	fn respond(
295	432×	&self,
296	432×	name: &str,
297	432×	endpoint: Endpoint,
298	432×	body: Bytes,
299	432×	claimed: Option<[u8; 16]>,
300	432×	headers: &HeaderMap,
301	432×	) -> Result<Response, Failure> {
302	432×	let r = self.backend.open(name)?;
303	430×	Ok(match endpoint {
304	141×	Endpoint::Capabilities => ok(wire::encode_capabilities(r.id()?)),
305		Endpoint::Refs => {
306	142×	let mut refs = r.remote_refs()?;
307	142×	if let Some(d) = self.backend.default_bookmark(name) {
308	120×	refs.default_bookmark = Some(d);
309	120×	}
310	142×	self.backend.add_log(name, &mut refs);
311	142×	self.backend.adjust_refs(name, &r, &mut refs, headers);
312	142×	ok(wire::encode_refs(r.id()?, &refs))
313		}
314		Endpoint::Negotiate => {
315	54×	let (have, want) = wire::decode_negotiate(&body)?;
316	54×	ok(wire::encode_hashes(&r.negotiate(&have, &want)?))
317		}
318		Endpoint::Fetch => {
319	54×	let (changes, max_blob) = wire::decode_fetch(&body)?;
320	54×	ok(wire::encode_bundle(
321	54×	&r.bundle_for_filtered(&changes, max_blob)?,
322		))
323		}
324		Endpoint::Objects => {
325	1×	let refs = wire::decode_hashes(&body)?;
326	1×	let bundle = oxy_core::protocol::Bundle {
327	1×	objects: r.objects_for(&refs)?,
328	1×	..Default::default()
329		};
330	1×	ok(wire::encode_bundle(&bundle))
331		}
332		Endpoint::Checkpoint => {
333	0×	let heads = wire::decode_hashes(&body)?;
334	0×	let lock = self.lock_for(name);
335	0×	let _guard = lock.lock().unwrap();
336	0×	let bundle = r.checkpoint_bundle_for(&heads)?;
337	0×	let _t = oxy_core::timing::phase("serve: encode the checkpoint");
338	0×	ok(wire::encode_bundle(&bundle))
339		}
340		Endpoint::CheckpointIndex => {
341	0×	let heads = wire::decode_hashes(&body)?;
342	0×	let lock = self.lock_for(name);
343	0×	let _guard = lock.lock().unwrap();
344	0×	ok(wire::encode_bundle(&r.checkpoint_index_for(&heads)?))
345		}
346		Endpoint::Shallow => {
347	0×	let (heads, depth) = wire::decode_shallow(&body)?;
348	0×	ok(wire::encode_hashes(&r.shallow_changes(&heads, depth)?))
349		}
350		Endpoint::Push => {
351	38×	let (bundle, updates, policy, tags) = wire::decode_push(&body)?;
352		// The host vets what the push adds before anything is stored
353		// or bound: a refused push leaves the repository as it was.
354	38×	self.backend
355	38×	.vet_push(name, &r, &bundle, &updates, headers)?;
356	37×	let lock = self.lock_for(name);
357	37×	let _guard = lock.lock().unwrap();
358	37×	if r.is_unbound() {
359		// The first push binds the repository to the pusher's id (spec §16.1).
360	3×	match claimed {
361	3×	Some(id) => r.bind_id(id)?,
362		None => {
363	0×	return Err(Failure(
364	0×	StatusCode::BAD_REQUEST,
365	0×	format!(
366	0×	"this repository is unbound; push with a client that sends {}",
367	0×	oxy_core::protocol::REPO_ID_HEADER
368	0×	),
369	0×	))
370		}
371		}
372	34×	}
373	37×	let protected = self.backend.default_bookmark(name);
374	37×	let (refused, updates): (Vec<_>, Vec<_>) = updates.into_iter().partition(\|u\| {
375	37×	u.new_state.is_zero() && protected.as_deref() == Some(u.name.as_str())
376	37×	});
377	37×	let mut kept_tags = Vec::new();
378	37×	let mut withdrawals_refused = Vec::new();
379	37×	for t in tags {
380	3×	match t
381	3×	.is_withdrawal()
382	3×	.then(\|\| self.backend.vet_tag_withdrawal(name, &t.name))
383		{
384	0×	Some(Err(reason)) => withdrawals_refused.push((t.name, reason)),
385	3×	_ => kept_tags.push(t),
386		}
387		}
388	37×	let mut report = r.receive_push_report(bundle, updates, policy, kept_tags)?;
389		// The request named references, all refused here: it was no
390		// push of objects alone, whatever the repository saw.
391	37×	if !refused.is_empty() \|\| !withdrawals_refused.is_empty() {
392	1×	report
393	1×	.results
394	1×	.retain(\|r\| r.name != oxy_core::repo::OBJECTS_RESULT);
395	36×	}
396	37×	for u in refused {
397	1×	report.results.push(oxy_core::protocol::RefResult {
398	1×	name: u.name.clone(),
399	1×	ok: false,
400	1×	reason: format!(
401	1×	"{:?} is this repository's default bookmark and cannot be deleted",
402	1×	u.name
403	1×	),
404	1×	});
405	1×	}
406	37×	for (tag, reason) in withdrawals_refused {
407	0×	report.results.push(oxy_core::protocol::RefResult {
408	0×	name: format!("tags/{tag}"),
409	0×	ok: false,
410	0×	reason,
411	0×	});
412	0×	}
413	43×	for r in report.results.iter().filter(\|r\| !r.ok) {
414	11×	eprintln!(
415	11×	"oxy-server: push to {name}: {} refused: {}",
416	11×	r.name, r.reason
417	11×	);
418	11×	}
419	37×	self.backend.after_push(name, &report, headers);
420	37×	ok(wire::encode_push_response(&report.results))
421		}
422		})
423	432×	}
424		}
425
426		/// The backend of `oxy serve`: one repository per subdirectory of a root,
427		/// open reads, and pushes gated by a list of bearer tokens.
428		pub struct DirBackend {
429		pub root: PathBuf,
430		pub tokens: Vec<String>,
431		}
432
433		impl Backend for DirBackend {
434	526×	fn open(&self, name: &str) -> Result<Repo, Failure> {
435	526×	if !valid_repo_name(name) {
436	1×	return Err(Failure(StatusCode::NOT_FOUND, "no such repository".into()));
437	525×	}
438	525×	let dir = self.root.join(name);
439	525×	if !dir.join(".oxy").is_dir() {
440	1×	return Err(Failure(StatusCode::NOT_FOUND, "no such repository".into()));
441	524×	}
442	524×	Repo::open(&dir).map_err(\|e\| Failure(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()))
443	526×	}
444
445	151×	fn default_bookmark(&self, name: &str) -> Option<String> {
446	151×	self.open(name).ok().map(\|r\| r.config.bookmark.clone())
447	151×	}
448
449	379×	fn authorize(&self, _name: &str, access: Access, headers: &HeaderMap) -> Result<(), Failure> {
450	379×	if access == Access::Read \|\| self.tokens.is_empty() {
451	373×	return Ok(());
452	6×	}
453	6×	match bearer_token(headers) {
454	5×	Some(t) if self.tokens.iter().any(\|x\| x == t) => Ok(()),
455	4×	_ => Err(Failure(
456	4×	StatusCode::UNAUTHORIZED,
457	4×	"a valid bearer token is required to push".into(),
458	4×	)),
459		}
460	379×	}
461		}
462
463	399×	fn hex_id(h: &str) -> Option<[u8; 16]> {
464	399×	let h = h.trim();
465	399×	if h.len() != 32 {
466	0×	return None;
467	399×	}
468	399×	let mut out = [0u8; 16];
469	6384×	for (i, byte) in out.iter_mut().enumerate() {
470	6384×	byte = u8::from_str_radix(&h[2 i..2 * i + 2], 16).ok()?;
471		}
472	399×	Some(out)
473	399×	}
474
475		/// The features a request declares in its `Oxy-Features` header, as the
476		/// header's text; `None` when it sent none (a client of the 0.5.0 era).
477	142×	pub fn client_features(headers: &HeaderMap) -> Option<&str> {
478	142×	headers
479	142×	.get(oxy_core::protocol::FEATURES_HEADER)
480	142×	.and_then(\|v\| v.to_str().ok())
481	142×	}
482
483		/// Tailor `refs` of `repo` to the client whose request carried `headers`:
484		/// the shared rule of [`Repo::refs_for_client`], which every host applies.
485	142×	pub fn tailor_refs(repo: &Repo, refs: &mut oxy_core::protocol::RefsResponse, headers: &HeaderMap) {
486	142×	repo.refs_for_client(refs, client_features(headers));
487	142×	}
488
489		/// The token of an `Authorization: Bearer` header, if any.
490	19×	pub fn bearer_token(headers: &HeaderMap) -> Option<&str> {
491	19×	headers
492	19×	.get(header::AUTHORIZATION)
493	19×	.and_then(\|v\| v.to_str().ok())
494	19×	.and_then(\|v\| v.strip_prefix("Bearer "))
495	19×	.map(str::trim)
496	19×	}
497
498	373×	async fn dispatch(
499	373×	State(server): State<Arc<Server>>,
500	373×	Path((repo, endpoint)): Path<(String, String)>,
501	373×	method: Method,
502	373×	headers: HeaderMap,
503	373×	body: Bytes,
504	373×	) -> Response {
505	373×	match Endpoint::parse(&endpoint) {
506	373×	Some(e) => server.handle(repo, e, &method, &headers, body).await,
507	0×	None => Failure(StatusCode::NOT_FOUND, "no such endpoint".into()).into_response(),
508		}
509	373×	}
510
511		/// The largest request `oxy serve` takes: a push part is about
512		/// `push.batch-bytes` (64 MiB), but one change can weigh more; OxygenHub's
513		/// default `push_body_limit` is the same.
514		pub const BODY_LIMIT: usize = if usize::BITS > 32 {
515		4 << 30
516		} else {
517		usize::MAX
518		};
519
520		/// The router of `oxy serve`: `/{repo}/oxy/v1/{endpoint}` over a [`DirBackend`].
521	13×	pub fn router(cfg: ServerConfig) -> Router {
522	13×	let server = Server::new(DirBackend {
523	13×	root: cfg.root,
524	13×	tokens: cfg.tokens,
525	13×	});
526		// Without a limit of its own a request takes axum's 2 MB, and a larger
527		// push was cut off with no word in the log ("Broken pipe" at the client).
528	13×	Router::new()
529	13×	.route("/{repo}/oxy/v1/{endpoint}", any(dispatch))
530	13×	.layer(axum::extract::DefaultBodyLimit::max(BODY_LIMIT))
531	13×	.with_state(server)
532	13×	}
533
534		/// Serve on an already-bound listener until the process ends; HTTPS when
535		/// `cfg.tls` is set.
536	13×	pub async fn serve(listener: std::net::TcpListener, cfg: ServerConfig) -> std::io::Result<()> {
537	13×	listener.set_nonblocking(true)?;
538	13×	match cfg.tls.clone() {
539	1×	Some(tls) => {
540	1×	let _ = rustls::crypto::ring::default_provider().install_default();
541	1×	let rustls_cfg =
542	1×	axum_server::tls_rustls::RustlsConfig::from_pem_file(&tls.cert, &tls.key)
543	1×	.await
544	1×	.map_err(\|e\| std::io::Error::other(format!("loading TLS files: {e}")))?;
545	1×	axum_server::from_tcp_rustls(listener, rustls_cfg)?
546	1×	.serve(router(cfg).into_make_service())
547	1×	.await
548		}
549		None => {
550	12×	let listener = tokio::net::TcpListener::from_std(listener)?;
551	12×	axum::serve(listener, router(cfg)).await
552		}
553		}
554	0×	}
555
556		/// Build a runtime and serve; for the CLI and for tests on a background thread.
557	13×	pub fn run_blocking(listener: std::net::TcpListener, cfg: ServerConfig) -> std::io::Result<()> {
558	13×	let rt = tokio::runtime::Builder::new_multi_thread()
559	13×	.enable_all()
560	13×	.build()?;
561	13×	rt.block_on(serve(listener, cfg))
562	13×	}

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

Keyboard