Rename the identifiers that carried the upstream name
Everything clients, users and operators meet now carries the fork's name, with no aliases (SPEC.md §2.4, changed here from "protocol identifiers stay"): - JMAP: upstream's registry capability is urn:inbuxa:jmap:registry, beside the fork's own urn:inbuxa:jmap. - WebDAV lock and sync tokens are urn:inbuxa:dav*; clients resync once. - Sieve: vnd.inbuxa.while and vnd.inbuxa.expressions. sieve-rs spells these into its compiler, so it's vendored (vendor/sieve-rs, 0.7.3) and patched in; a unit test fails if Cargo.lock ever moves past the vendored copy. The trusted runtime now names itself too, rather than answering sieve-rs's default. - The web interface's OAuth client is inbuxa-webui. On every start the old stalwart-webui client is removed and any application naming it is moved over. - The spam filter's blobs are INBUXA_SPAM_*; every start moves any left under the old keys, so a trained model survives. - SQL stores and log files default to inbuxa, in the code and in the schema served to the admin (checksum regenerated). - Settings are INBUXA_* only. A STALWART_* variable that's set where its INBUXA_* one isn't stops the server at startup, naming it. - The version-upgrade messages link docs.inbuxa.org's migration page, and the OpenAPI description, smtp crate metadata and web-push test fixtures lose the name. Kept on purpose, allowlisted with reasons: the OAuth key-derivation contexts (renaming them would end every session and invalidate every sealed client id) and the hashed application prefix. Also fixes a latent start-up failure: ensure_client updated an existing first-party client with a revision of 0, which the registry's assertion never matches, so adding a redirect URI or changing the webmail secret failed start-up. And the principal session test now expects legacyProtocols (C-1, added 2026-09-21), which it had missed. Tested: the server builds without warnings; common's 106 unit tests, including the vendoring check; a new integration test for the two start-up migrations; and the webdav, jmap, imap and SMTP Sieve suites.
This commit is contained in:
@@ -143,7 +143,9 @@ impl Scripting {
|
||||
.with_cpu_limit(trusted.max_cpu_cycles as usize)
|
||||
.with_max_nested_includes(trusted.max_nested_includes as usize)
|
||||
.with_max_received_headers(trusted.max_received_headers as usize)
|
||||
.with_default_duplicate_expiry(trusted.duplicate_expiry.into_inner().as_secs());
|
||||
.with_default_duplicate_expiry(trusted.duplicate_expiry.into_inner().as_secs())
|
||||
// inbuxa: without it, `environment "name"` answers sieve-rs's default
|
||||
.with_env_variable("name", types::brand_server!());
|
||||
trusted_runtime.set_local_hostname(local_hostname.clone());
|
||||
untrusted_runtime.set_local_hostname(local_hostname);
|
||||
|
||||
@@ -279,3 +281,23 @@ impl Clone for Scripting {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use sieve::compiler::grammar::Capability;
|
||||
|
||||
// inbuxa: sieve-rs is vendored (vendor/sieve-rs) to carry the fork's
|
||||
// name in its Sieve extensions. If Cargo.lock moves sieve-rs past the
|
||||
// vendored version, Cargo drops the patch with only a warning and
|
||||
// upstream's spelling comes back; this fails instead.
|
||||
#[test]
|
||||
fn sieve_extensions_carry_the_fork_name() {
|
||||
for (capability, name) in [
|
||||
(Capability::While, "vnd.inbuxa.while"),
|
||||
(Capability::Expressions, "vnd.inbuxa.expressions"),
|
||||
] {
|
||||
assert_eq!(capability.to_string(), name);
|
||||
assert_eq!(Capability::parse(name), capability);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -514,12 +514,12 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn index_is_rewritten_with_the_prefix_and_client_id() {
|
||||
let meta = oauth_client_id_meta("stalwart-webui");
|
||||
let meta = oauth_client_id_meta("inbuxa-webui");
|
||||
let html = String::from_utf8(rewrite_index(INDEX, "admin", Some(&meta))).unwrap();
|
||||
|
||||
assert!(html.contains("<base href=\"/admin/\" />"), "{html}");
|
||||
assert!(
|
||||
html.contains("<meta name=\"oauth-client-id\" content=\"stalwart-webui\" />"),
|
||||
html.contains("<meta name=\"oauth-client-id\" content=\"inbuxa-webui\" />"),
|
||||
"{html}"
|
||||
);
|
||||
assert!(html.contains("<title>Portal</title>"), "{html}");
|
||||
@@ -541,7 +541,7 @@ mod tests {
|
||||
#[test]
|
||||
fn index_without_a_placeholder_is_left_alone() {
|
||||
let bundle = "<head>\n <base href=\"/\" />\n</head>";
|
||||
let meta = oauth_client_id_meta("stalwart-webui");
|
||||
let meta = oauth_client_id_meta("inbuxa-webui");
|
||||
let html = String::from_utf8(rewrite_index(bundle, "admin", Some(&meta))).unwrap();
|
||||
|
||||
assert_eq!(html, "<head>\n <base href=\"/admin/\" />\n</head>");
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
//! that ship with it are registered for it, on every start:
|
||||
//!
|
||||
//! - the web interface the server serves itself (`Application`, `/admin` and
|
||||
//! `/account`), as its OAuth client id, `stalwart-webui` unless the
|
||||
//! `/account`), as its OAuth client id, `inbuxa-webui` unless the
|
||||
//! application names another;
|
||||
//! - INBUXA Admin hosted elsewhere, as `inbuxa-admin`, when `INBUXA_ADMIN_URL`
|
||||
//! is set;
|
||||
@@ -29,7 +29,7 @@ use directory::core::secret::{hash_secret, verify_secret_hash};
|
||||
use registry::{
|
||||
schema::{
|
||||
enums::{PasswordHashAlgorithm, ServiceProtocol},
|
||||
prelude::{ObjectType, Property, UTCDateTime},
|
||||
prelude::{Object, ObjectInner, ObjectType, Property, UTCDateTime},
|
||||
structs::{Application, OAuthClient, SystemSettings},
|
||||
},
|
||||
types::map::Map,
|
||||
@@ -40,9 +40,12 @@ use store::registry::{
|
||||
};
|
||||
|
||||
/// The client id the upstream web interface uses when its application names none.
|
||||
pub const WEB_INTERFACE_CLIENT_ID: &str = "stalwart-webui";
|
||||
pub const WEB_INTERFACE_CLIENT_ID: &str = "inbuxa-webui";
|
||||
pub const ADMIN_CLIENT_ID: &str = "inbuxa-admin";
|
||||
pub const WEBMAIL_CLIENT_ID: &str = "ihasmail-inbuxa";
|
||||
/// The web interface's client id before the fork renamed it (SPEC §2.4).
|
||||
/// Only ever read to retire it.
|
||||
const LEGACY_WEB_INTERFACE_CLIENT_ID: &str = "stalwart-webui";
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct FirstPartyClient {
|
||||
@@ -187,6 +190,7 @@ fn env(name: &str) -> Option<String> {
|
||||
}
|
||||
|
||||
pub(crate) async fn ensure_first_party_clients(bp: &mut Bootstrap) -> trc::Result<()> {
|
||||
retire_legacy_web_interface_client(bp).await?;
|
||||
let system = bp.setting_infallible::<SystemSettings>().await;
|
||||
let base_url = base_url(bp, &system);
|
||||
let applications = bp
|
||||
@@ -213,6 +217,56 @@ pub(crate) async fn ensure_first_party_clients(bp: &mut Bootstrap) -> trc::Resul
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// An install from before the rename, upstream's or this fork's, has the web
|
||||
/// interface registered as `stalwart-webui`, and may
|
||||
/// have an application naming it. The application is moved to the current id
|
||||
/// and the old client removed, so the old id stops working rather than
|
||||
/// living on as an alias; anyone signed in to the web interface signs in
|
||||
/// again. Runs on every start and does nothing once both are gone.
|
||||
async fn retire_legacy_web_interface_client(bp: &mut Bootstrap) -> trc::Result<()> {
|
||||
for app in bp.list_infallible::<Application>().await {
|
||||
if app.object.oauth_client_id.as_deref() != Some(LEGACY_WEB_INTERFACE_CLIENT_ID) {
|
||||
continue;
|
||||
}
|
||||
let mut updated = app.object.clone();
|
||||
updated.oauth_client_id = Some(WEB_INTERFACE_CLIENT_ID.to_string());
|
||||
// The old object carries its revision: the write asserts on it.
|
||||
let current = Object::with_revision(ObjectInner::from(app.object), app.revision);
|
||||
let result = bp
|
||||
.registry
|
||||
.write(RegistryWrite::update(app.id.id(), &updated.into(), ¤t))
|
||||
.await?;
|
||||
if !matches!(result, RegistryWriteResult::Success(_)) {
|
||||
return Err(trc::StoreEvent::UnexpectedError
|
||||
.into_err()
|
||||
.details("Failed to move an application to the renamed web interface client.")
|
||||
.reason(result.to_string())
|
||||
.caused_by(trc::location!()));
|
||||
}
|
||||
}
|
||||
|
||||
if let Some(object_id) = bp
|
||||
.registry
|
||||
.primary_key(
|
||||
ObjectType::OAuthClient.into(),
|
||||
Property::ClientId,
|
||||
LEGACY_WEB_INTERFACE_CLIENT_ID.as_bytes().to_vec(),
|
||||
)
|
||||
.await?
|
||||
{
|
||||
let result = bp.registry.write(RegistryWrite::delete(object_id)).await?;
|
||||
if !matches!(result, RegistryWriteResult::Success(_)) {
|
||||
return Err(trc::StoreEvent::UnexpectedError
|
||||
.into_err()
|
||||
.details("Failed to remove the web interface's pre-rename OAuth client.")
|
||||
.reason(result.to_string())
|
||||
.caused_by(trc::location!()));
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn ensure_client(bp: &mut Bootstrap, client: FirstPartyClient) -> trc::Result<()> {
|
||||
let existing = match bp
|
||||
.registry
|
||||
@@ -223,15 +277,18 @@ async fn ensure_client(bp: &mut Bootstrap, client: FirstPartyClient) -> trc::Res
|
||||
)
|
||||
.await?
|
||||
{
|
||||
// inbuxa: read as an Object, keeping the revision the update below
|
||||
// asserts on (a bare OAuthClient converts back with revision 0, which
|
||||
// never matches, so any update failed start-up).
|
||||
Some(object_id) => bp
|
||||
.registry
|
||||
.object::<OAuthClient>(object_id.id())
|
||||
.get(object_id)
|
||||
.await?
|
||||
.map(|object| (object_id.id(), object)),
|
||||
.map(|object| (object_id.id(), object.revision, OAuthClient::from(object))),
|
||||
None => None,
|
||||
};
|
||||
|
||||
let result = if let Some((id, current)) = existing {
|
||||
let result = if let Some((id, revision, current)) = existing {
|
||||
let mut updated = current.clone();
|
||||
for uri in &client.redirect_uris {
|
||||
if !updated.redirect_uris.contains(uri) {
|
||||
@@ -255,8 +312,9 @@ async fn ensure_client(bp: &mut Bootstrap, client: FirstPartyClient) -> trc::Res
|
||||
if updated == current {
|
||||
return Ok(());
|
||||
}
|
||||
let current = Object::with_revision(ObjectInner::from(current), revision);
|
||||
bp.registry
|
||||
.write(RegistryWrite::update(id, &updated.into(), ¤t.into()))
|
||||
.write(RegistryWrite::update(id, &updated.into(), ¤t))
|
||||
.await?
|
||||
} else {
|
||||
let secret = match &client.secret {
|
||||
|
||||
@@ -23,8 +23,8 @@ pub mod defaults;
|
||||
pub mod first_party;
|
||||
pub mod restore;
|
||||
|
||||
pub const SPAM_TRAINER_KEY: &[u8] = "STALWART_SPAM_TRAIN_DATA.lz4".as_bytes();
|
||||
pub const SPAM_CLASSIFIER_KEY: &[u8] = "STALWART_SPAM_CLASSIFIER_MODEL.lz4".as_bytes();
|
||||
pub const SPAM_TRAINER_KEY: &[u8] = "INBUXA_SPAM_TRAIN_DATA.lz4".as_bytes();
|
||||
pub const SPAM_CLASSIFIER_KEY: &[u8] = "INBUXA_SPAM_CLASSIFIER_MODEL.lz4".as_bytes();
|
||||
|
||||
pub async fn fetch_resource(
|
||||
url: &str,
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
* SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <[email protected]>
|
||||
*
|
||||
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-SEL
|
||||
*
|
||||
* Modified by Coffey Labs in 2026 for INBUXA.
|
||||
*/
|
||||
|
||||
use base64::{Engine, engine::general_purpose::URL_SAFE_NO_PAD};
|
||||
@@ -313,16 +315,16 @@ B4yDfR2rGOd2H6Kv3fQNHPj9Nu5Tks8QYMLzrX8ONCNoFnNUQl9S0r0QS6phVqD0
|
||||
#[test]
|
||||
fn contact_is_normalized_to_a_uri() {
|
||||
for (input, expected) in [
|
||||
("hello@stalw.art", Some("mailto:hello@stalw.art")),
|
||||
(" hello@stalw.art ", Some("mailto:hello@stalw.art")),
|
||||
("mailto:hello@stalw.art", Some("mailto:hello@stalw.art")),
|
||||
("MAILTO:hello@stalw.art", Some("MAILTO:hello@stalw.art")),
|
||||
("hello@example.org", Some("mailto:hello@example.org")),
|
||||
(" hello@example.org ", Some("mailto:hello@example.org")),
|
||||
("mailto:hello@example.org", Some("mailto:hello@example.org")),
|
||||
("MAILTO:hello@example.org", Some("MAILTO:hello@example.org")),
|
||||
(
|
||||
"https://stalw.art/contact",
|
||||
Some("https://stalw.art/contact"),
|
||||
"https://example.org/contact",
|
||||
Some("https://example.org/contact"),
|
||||
),
|
||||
("stalw.art", None),
|
||||
("http://stalw.art", None),
|
||||
("example.org", None),
|
||||
("http://example.org", None),
|
||||
("tel:+123456789", None),
|
||||
("", None),
|
||||
] {
|
||||
|
||||
Reference in New Issue
Block a user