OXYGENHUB
# ba0a55bb5b3c oxygenhub / crates / hub / src / lib.rs
17.2 KiB · Rust · last changed Create and withdraw tags on the website (closes #295, closes #301) 11 days ago source blame history raw
1
//! OxygenHub: a forge for Oxygen repositories (`docs/spec.md`).
2
//!
3
//! One process, or several sharing a database: an axum router serving
4
//! pages, the JSON API and the wire protocol (the web role); the background
5
//! tasks (the worker role, singletons under a leader lock: docs/roles.md);
6
//! SQLite or PostgreSQL for hub state; repositories as bare Oxygen stores.
7
8
pub mod api;
9
pub mod apt;
10
pub mod assistants;
11
pub mod auth;
12
pub mod autoland;
13
pub mod backups;
14
pub mod bus;
15
pub mod config;
16
pub mod coverage;
17
pub mod db;
18
pub mod diffusion;
19
pub mod drops;
20
pub mod events;
21
pub mod flow;
22
pub mod headers;
23
pub mod history_scan;
24
pub mod hooks;
25
pub mod images;
26
pub mod insights;
27
pub mod junit;
28
pub mod keyless;
29
pub mod keys;
30
pub mod leader;
31
pub mod levels;
32
pub mod live;
33
pub mod mail;
34
pub mod maintenance;
35
pub mod metrics;
36
pub mod mirror;
37
pub mod net;
38
pub mod notify;
39
pub mod oidc;
40
pub mod protocol;
41
pub mod provenance;
42
pub mod push_protection;
43
pub mod queue;
44
pub mod render;
45
pub mod reports;
46
pub mod repos;
47
pub mod secrets;
48
pub mod setup;
49
pub mod shutdown;
50
pub mod signin;
51
pub mod social;
52
pub mod storage;
53
pub mod swarm;
54
pub mod tags;
55
pub mod terraform;
56
pub mod throttle;
57
pub mod tlog;
58
pub mod variables;
59
pub mod web;
60
pub mod wiki;
61
62
use crate::config::Config;
63
use crate::repos::Repos;
64
use std::sync::Arc;
65
66
/// Everything a request handler can reach.
67
pub struct App {
68
    pub config: Config,
69
    pub db: db::Pool,
70
    pub repos: Arc<Repos>,
71
    /// Wikis, one Oxygen repository per repository (hub spec §6.11).
72
    pub wikis: Arc<Repos>,
73
    pub server: Arc<oxy_server::Server>,
74
    pub hub_key: keys::HubKey,
75
    pub cookie_key: auth::CookieKey,
76
    /// Seals AI assistants' tokens at rest (hub spec §13.4).
77
    pub assistant_key: assistants::SecretKey,
78
    /// Seals Flow secrets at rest (hub spec §13.2, #107).
79
    pub secret_key: assistants::SecretKey,
80
    /// The OIDC issuer for jobs (hub spec §13.5), made on first use.
81
    pub oidc: tokio::sync::OnceCell<oidc::Issuer>,
82
    /// Which assistants are answering which proposals, and recent calls
83
    /// per repository (hub spec §13.4).
84
    pub assistant_gate: std::sync::Mutex<assistants::Gate>,
85
    /// Failed sign-ins and the like, per account and address (oxygenhub#221).
86
    pub throttle: std::sync::Mutex<throttle::Throttle>,
87
    /// Events for live pages and workers, here and in the other processes
88
    /// sharing the database (docs/roles.md, #273).
89
    pub bus: bus::Bus,
90
    /// Who is resolving which conflict together (hub spec §6.10).
91
    pub rooms: Arc<live::Rooms>,
92
    /// Outgoing mail: hub.toml's `[email]`, overridden by what the admin
93
    /// page saved (#101).
94
    pub mail: std::sync::RwLock<config::Email>,
95
    /// The image swarm's tracker (oxygenhub#144).
96
    pub swarm: swarm::Tracker,
97
    pub started: std::time::Instant,
98
    /// The transparency log (#238).
99
    pub tlog: Arc<tlog::Log>,
100
    /// What this process does: web, worker or both (docs/roles.md, #272).
101
    pub roles: config::Roles,
102
    /// The background tasks started here and the leader locks held (#272).
103
    pub leader: leader::Leader,
104
}
105
106
impl App {
107
    /// The rootfs images this hub keeps for runners (oxygenflow#39).
108
    pub fn images(&self) -> images::Store {
109
        images::Store::new(&self.config.data)
110
    }
111
112
    /// The OIDC issuer, its key loaded or made the first time it is asked for.
113
    pub async fn oidc(&self) -> anyhow::Result<&oidc::Issuer> {
114
        let keys = self.config.keys_dir();
115
        self.oidc.get_or_try_init(|| async move { tokio::task::spawn_blocking(move || oidc::Issuer::load_or_create(&keys)).await? }).await
116
    }
117
}
118
119
pub type Shared = Arc<App>;
120
121
/// Open the data directory and build the application state. `init` must
122
/// have run once; `serve` and the tests call this.
123
pub async fn build(config: Config) -> anyhow::Result<Shared> {
124
    let roles = config.roles()?;
125
    std::fs::create_dir_all(config.repos_dir())?;
126
    let db = db::open(&config).await?;
127
    let repos = Arc::new(Repos::new(config.repos_dir()));
128
    let wikis = Arc::new(Repos::new(config.data.join("wikis")));
129
    let hub_key = keys::ensure_identity(&config.keys_dir(), &config.site.name, config.base_url())?;
130
    let cookie_key = auth::CookieKey::load_or_create(&config.keys_dir())?;
131
    let assistant_key = assistants::SecretKey::load_or_create(&config.keys_dir())?;
132
    let secret_key = assistants::SecretKey::load_or_create_named(&config.keys_dir(), "secrets.key")?;
133
    let backend = protocol::HubBackend::new(
134
        repos.clone(),
135
        wikis.clone(),
136
        db.clone(),
137
        config.auth.push_tokens.clone(),
138
        tokio::runtime::Handle::current(),
139
    )
140
    .with_acceptor(hub_key.identity.clone(), keys::load_secret(&config.keys_dir())?.1)
141
    .with_scan_budget(push_protection::Budget {
142
        bytes: config.limits.scan_limit.0,
143
        file: config.limits.scan_file_limit.0,
144
        time: std::time::Duration::from_millis(config.limits.scan_time_ms),
145
    });
146
    let slot = backend.app_slot();
147
    let server = oxy_server::Server::new(backend);
148
    let mail = mail::load(&db, &config.email).await;
149
    // The web role appends to the log; a worker alone only reads it (#272).
150
    let (tlog_dir, origin) = (config.data.join("tlog"), tlog::origin_of(config.base_url()));
151
    let tlog = Arc::new(if roles.web { tlog::Log::open(&tlog_dir, &origin)? } else { tlog::Log::open_reader(&tlog_dir, &origin)? });
152
    tlog.configure(&config.tlog)?;
153
    let app = Arc::new(App {
154
        mail: std::sync::RwLock::new(mail),
155
        config,
156
        db,
157
        repos,
158
        wikis,
159
        server,
160
        hub_key,
161
        cookie_key,
162
        assistant_key,
163
        secret_key,
164
        oidc: tokio::sync::OnceCell::new(),
165
        assistant_gate: std::sync::Mutex::new(assistants::Gate::default()),
166
        throttle: std::sync::Mutex::new(throttle::Throttle::default()),
167
        bus: bus::Bus::default(),
168
        rooms: Arc::new(live::Rooms::default()),
169
        swarm: Default::default(),
170
        started: std::time::Instant::now(),
171
        tlog,
172
        roles,
173
        leader: leader::Leader::default(),
174
    });
175
    *slot.lock().unwrap() = Some(Arc::downgrade(&app));
176
    bus::start(&app).await?;
177
    storage::load(&app).await?;
178
    coverage::load(&app).await?;
179
    junit::load(&app).await?;
180
    reports::load(&app).await?;
181
    start_background(&app);
182
    setup::ensure(&app).await?;
183
    Ok(app)
184
}
185
186
/// Start this process's background tasks (docs/roles.md, #272). The
187
/// worker role's are singletons across every process sharing the database,
188
/// each run under its leader lock; the transparency log's checkpointer goes
189
/// with the web role, which appends to the log, and is a singleton too.
190
fn start_background(app: &Shared) {
191
    if app.roles.web {
192
        // The checkpointer signs the log this process appends to (#238).
193
        leader::run(app, "tlog.checkpointer", tlog::checkpointer);
194
    }
195
    if !app.roles.worker {
196
        return;
197
    }
198
    leader::run(app, "hooks.worker", hooks::worker);
199
    leader::run(app, "flow.reaper", flow::reaper);
200
    leader::run(app, "flow.scheduler", flow::scheduler);
201
    leader::run(app, "flow.placement", flow::placement);
202
    leader::run(app, "maintenance.nightly", maintenance::nightly);
203
    leader::run(app, "backups.scheduler", backups::scheduler);
204
    // The reverse pin index for repositories pushed before it existed (#148):
205
    // once, by whichever worker leads it first (idempotent if run again).
206
    leader::run(app, "diffusion.backfill", |app| async move { diffusion::backfill(&app).await });
207
    // Mend the pin index and the bumps it drives (oxygenhub#210).
208
    leader::run(app, "diffusion.reconciler", diffusion::reconciler);
209
    // Each repository's history scanned for secrets (#277), a budget at a
210
    // time, at low priority.
211
    leader::run(app, "secrets.history_scan", history_scan::worker);
212
    // The durable work queue (#276): every worker takes its due items.
213
    app.leader.note("queue.worker");
214
    tokio::spawn(queue::worker(app.clone()));
215
    // What each image is for, read or learned once (oxygenhub#173): safe
216
    // in every worker, so it takes no lock.
217
    app.leader.note("images.learn_archs");
218
    tokio::spawn({
219
        let app = app.clone();
220
        async move {
221
            match images::learn_archs(&app).await {
222
                Ok(n) if n > 0 => tracing::info!(images = n, "read the architecture of kept images"),
223
                Ok(_) => {}
224
                Err(e) => tracing::warn!(error = %e, "learning image architectures"),
225
            }
226
        }
227
    });
228
}
229
230
/// The router this process serves: everything for the web role; for a
231
/// worker alone, `/health` and `/metrics`, so it can be watched.
232
pub fn router(app: Shared) -> axum::Router {
233
    if !app.roles.web {
234
        return worker_router(app);
235
    }
236
    full_router(app)
237
}
238
239
/// What a worker-only process answers: its health and its metrics.
240
fn worker_router(app: Shared) -> axum::Router {
241
    use axum::routing::get;
242
    let hsts = headers::hsts(app.config.base_url(), app.config.server.hsts_max_age);
243
    axum::Router::new()
244
        .route("/health", get(web::home::health))
245
        .route("/metrics", get(metrics::metrics))
246
        .with_state(app)
247
        .layer(axum::middleware::from_fn_with_state(hsts, headers::security_headers))
248
}
249
250
/// The full router: pages, API, protocol and static assets.
251
fn full_router(app: Shared) -> axum::Router {
252
    let https = app_https(&app);
253
    let hsts = headers::hsts(app.config.base_url(), app.config.server.hsts_max_age);
254
    web::router(app.clone())
255
        .layer(axum::middleware::from_fn_with_state(app, agent_requests))
256
        .layer(axum::middleware::from_fn(private_pages))
257
        .layer(axum::middleware::from_fn(slow_requests))
258
        .layer(axum::middleware::from_fn_with_state(https, https_only))
259
        .layer(axum::middleware::from_fn_with_state(hsts, headers::security_headers))
260
}
261
262
/// The site's https address, when it has one: what [`https_only`] redirects to.
263
fn app_https(app: &Shared) -> Option<String> {
264
    let base = app.config.base_url();
265
    base.starts_with("https://").then(|| base.trim_end_matches('/').to_string())
266
}
267
268
/// The scheme a proxy in front of the hub says the visitor used
269
/// (`X-Forwarded-Proto`, else Cloudflare's `CF-Visitor`); `None` for a
270
/// request made to the hub directly (runners and tools on its host).
271
fn forwarded_scheme(headers: &axum::http::HeaderMap) -> Option<String> {
272
    if let Some(p) = headers.get("x-forwarded-proto").and_then(|v| v.to_str().ok()) {
273
        return p.split(',').next().map(|s| s.trim().to_ascii_lowercase());
274
    }
275
    let visitor = headers.get("cf-visitor").and_then(|v| v.to_str().ok())?;
276
    serde_json::from_str::<serde_json::Value>(visitor).ok()?["scheme"].as_str().map(str::to_ascii_lowercase)
277
}
278
279
/// HTTPS only (oxygenhub#218): on a site whose address is https, a request
280
/// a proxy reports as plain http is sent to the https address (GET and
281
/// HEAD) or refused (anything else, so a form or a password is never taken
282
/// over http). Requests made to the hub directly carry no such report and
283
/// are untouched.
284
async fn https_only(
285
    axum::extract::State(https): axum::extract::State<Option<String>>,
286
    req: axum::extract::Request,
287
    next: axum::middleware::Next,
288
) -> axum::response::Response {
289
    use axum::response::IntoResponse;
290
    let Some(base) = https else { return next.run(req).await };
291
    if forwarded_scheme(req.headers()).as_deref() != Some("http") {
292
        return next.run(req).await;
293
    }
294
    let to = format!("{base}{}", req.uri().path_and_query().map(|p| p.as_str()).unwrap_or("/"));
295
    if matches!(*req.method(), axum::http::Method::GET | axum::http::Method::HEAD) {
296
        return axum::response::Redirect::permanent(&to).into_response();
297
    }
298
    (axum::http::StatusCode::BAD_REQUEST, format!("This site takes requests over HTTPS only: send it to {to}\n")).into_response()
299
}
300
301
/// A request made with a token its owner marked as an agent's runs with
302
/// that token's name in [`notify::AGENT`], so what the agent does is told
303
/// to its owner (oxygenhub#183).
304
async fn agent_requests(
305
    axum::extract::State(app): axum::extract::State<Shared>,
306
    req: axum::extract::Request,
307
    next: axum::middleware::Next,
308
) -> axum::response::Response {
309
    let token = req
310
        .headers()
311
        .get(axum::http::header::AUTHORIZATION)
312
        .and_then(|v| v.to_str().ok())
313
        .and_then(|v| v.strip_prefix("Bearer "))
314
        .map(|t| auth::token_hash(t.trim()));
315
    let agent = match token {
316
        Some(hash) => db::accounts::token_by_hash(&app.db, &hash).await.ok().flatten().filter(|t| t.agent).map(|t| t.name),
317
        None => None,
318
    };
319
    notify::AGENT.scope(agent, next.run(req)).await
320
}
321
322
/// Requests slower than this are logged, with their path (#145).
323
const SLOW: std::time::Duration = std::time::Duration::from_secs(2);
324
325
/// Log a slow request's method, path and time, so a slow page can be
326
/// found afterwards. Never the query, which may hold a token.
327
async fn slow_requests(req: axum::extract::Request, next: axum::middleware::Next) -> axum::response::Response {
328
    let (method, path) = (req.method().clone(), req.uri().path().to_string());
329
    let start = std::time::Instant::now();
330
    let res = next.run(req).await;
331
    let took = start.elapsed();
332
    metrics::observe(method.as_str(), &path, res.status().as_u16(), took.as_secs_f64());
333
    if took >= SLOW {
334
        tracing::warn!("slow request: {method} {path} took {:.1} s ({})", took.as_secs_f64(), res.status().as_u16());
335
    }
336
    res
337
}
338
339
/// A page for a signed-in viewer is theirs alone: it may list private
340
/// repositories, and the dashboard's sky carries their activity (#157). An
341
/// HTML response to a request with a session cookie, which has not said
342
/// how to cache itself, says `private, no-store`, so no shared cache (a
343
/// proxy or a CDN in front of the hub) ever serves it to anyone else.
344
async fn private_pages(req: axum::extract::Request, next: axum::middleware::Next) -> axum::response::Response {
345
    use axum::http::header;
346
    let signed_in = req
347
        .headers()
348
        .get_all(header::COOKIE)
349
        .iter()
350
        .filter_map(|v| v.to_str().ok())
351
        .any(|c| c.split(';').any(|kv| kv.trim_start().starts_with("oxyhub=")));
352
    let mut res = next.run(req).await;
353
    let html = res.headers().get(header::CONTENT_TYPE).and_then(|v| v.to_str().ok()).is_some_and(|t| t.starts_with("text/html"));
354
    if signed_in && html && !res.headers().contains_key(header::CACHE_CONTROL) {
355
        res.headers_mut().insert(header::CACHE_CONTROL, header::HeaderValue::from_static("private, no-store"));
356
    }
357
    res
358
}
359
360
/// Serve on the configured addresses until the process is told to stop.
361
pub async fn serve(app: Shared) -> anyhow::Result<()> {
362
    let router = router(app.clone());
363
    let http = app.config.bind_addr()?;
364
    let https = app.config.tls_bind_addr()?;
365
    if http.is_none() && https.is_none() && app.roles.web {
366
        anyhow::bail!("nothing to bind: set server.bind or server.tls_bind");
367
    }
368
    tracing::info!("roles: {}", app.roles.names().join(", "));
369
    // Installed first: from here a SIGTERM drains rather than kills.
370
    let signal = shutdown::on_signal()?;
371
    let mut tasks = tokio::task::JoinSet::new();
372
    if let Some(addr) = http {
373
        let listener = match shutdown::systemd_listener() {
374
            Some(l) => {
375
                tracing::info!("http on the socket systemd holds ({})", l.local_addr().map(|a| a.to_string()).unwrap_or_default());
376
                tokio::net::TcpListener::from_std(l)?
377
            }
378
            None => {
379
                tracing::info!("http on {addr}");
380
                tokio::net::TcpListener::bind(addr).await?
381
            }
382
        };
383
        let r = router.clone();
384
        tasks.spawn(async move {
385
            axum::serve(listener, r.into_make_service_with_connect_info::<std::net::SocketAddr>())
386
                .with_graceful_shutdown(shutdown::stopping())
387
                .await
388
                .map_err(anyhow::Error::from)
389
        });
390
    }
391
    if let Some(addr) = https {
392
        let _ = rustls::crypto::ring::default_provider().install_default();
393
        let tls = axum_server::tls_rustls::RustlsConfig::from_pem_file(app.config.tls_cert(), app.config.tls_key())
394
            .await
395
            .map_err(|e| anyhow::anyhow!("loading TLS files: {e}"))?;
396
        tracing::info!("https on {addr}");
397
        let r = router.clone();
398
        let handle = axum_server::Handle::new();
399
        let draining = handle.clone();
400
        tokio::spawn(async move {
401
            shutdown::stopping().await;
402
            draining.graceful_shutdown(Some(shutdown::DRAIN));
403
        });
404
        tasks.spawn(async move {
405
            axum_server::bind_rustls(addr, tls)
406
                .handle(handle)
407
                .serve(r.into_make_service_with_connect_info::<std::net::SocketAddr>())
408
                .await
409
                .map_err(anyhow::Error::from)
410
        });
411
    }
412
    tokio::select! {
413
        // A worker with no address to serve on runs until it is stopped.
414
        r = tasks.join_next(), if !tasks.is_empty() => { r.transpose()?.transpose()?; Ok(()) }
415
        _ = signal => {
416
            // The servers stop taking connections and finish what they
417
            // have; whatever is still running after DRAIN is cut off.
418
            let drained = tokio::time::timeout(shutdown::DRAIN, async { while tasks.join_next().await.is_some() {} }).await;
419
            if drained.is_err() {
420
                tracing::warn!("requests still running after {} s: stopping anyway", shutdown::DRAIN.as_secs());
421
            }
422
            tracing::info!("stopped");
423
            Ok(())
424
        }
425
    }
426
}