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