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