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