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