inbuxa/inbuxa-server
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 3 Wiki Activity
Files
7109e67f0760dc31b7c4cef2c9b98ac3fd337ef8
inbuxa-server/tests/src/jmap/principal/get.rs
T
jcoffey-dev cc6f1eb298
ci / fork-checks (pull_request) Successful in 16s
Details
ci / build (pull_request) Successful in 7m53s
Details
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.
2026-09-22 19:33:02 -07:00

483 lines
16 KiB
Rust
Raw Blame History

/*
* 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 jmap_proto::{object::principal::PrincipalProperty, request::method::MethodObject};
use serde_json::json;
use crate::utils::{jmap::JmapUtils, server::TestServer};
pub async fn test(test: &TestServer) {
println!("Running Principal get/query tests...");
let john = test.account("[email protected]");
let jane = test.account("[email protected]");
let bill = test.account("[email protected]");
let sales = test.account("[email protected]");
let john_id = john.id_string();
let jane_id = jane.id_string();
let bill_id = bill.id_string();
let sales_id = sales.id_string();
// Validate session object capabilities
let response = john.jmap_session_object().await.into_inner();
let application_server_key =
response["capabilities"]["urn:ietf:params:jmap:webpush-vapid"]["applicationServerKey"]
.clone();
response.assert_is_equal(json!({
"capabilities": {
"urn:ietf:params:jmap:core": {
"maxSizeUpload": 50000000,
"maxConcurrentUpload": 4,
"maxSizeRequest": 10000000,
"maxConcurrentRequests": 4,
"maxCallsInRequest": 16,
"maxObjectsInGet": 100000,
"maxObjectsInSet": 100000,
"collationAlgorithms": [
"i;ascii-numeric",
"i;ascii-casemap",
"i;unicode-casemap"
]
},
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:calendars": {},
"urn:ietf:params:jmap:calendars:parse": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:contacts:parse": {},
"urn:ietf:params:jmap:emailpush": {},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {},
"urn:ietf:params:jmap:principals:availability": {},
"urn:ietf:params:jmap:submission": {},
"urn:ietf:params:jmap:vacationresponse": {},
"urn:ietf:params:jmap:sieve": {
"implementation": concat!(types::brand!(), " ", types::brand_version_full!())
},
"urn:ietf:params:jmap:blob": {},
"urn:ietf:params:jmap:quota": {},
"urn:ietf:params:jmap:webpush-vapid": {
"applicationServerKey": application_server_key
},
"urn:ietf:params:jmap:websocket": {
"url": "wss://127.0.0.1:8899/jmap/ws",
"supportsPush": true
},
// inbuxa: the fork's own capability (contract C-1, multi-tenancy MT-22)
"urn:inbuxa:jmap": {},
// inbuxa: Fastmail's Masked Email API (masked email)
"https://www.fastmail.com/dev/maskedemail": {}
},
"accounts": {
john_id: {
"name": "[email protected]",
"isPersonal": true,
"isReadOnly": false,
"accountCapabilities": {
"urn:ietf:params:jmap:mail": {
"maxMailboxesPerEmail": null,
"maxMailboxDepth": 10,
"maxSizeMailboxName": 255,
"maxSizeAttachmentsPerEmail": 50000000,
"emailQuerySortOptions": [
"receivedAt",
"size",
"from",
"to",
"subject",
"sentAt",
"hasKeyword",
"allInThreadHaveKeyword",
"someInThreadHaveKeyword"
],
"mayCreateTopLevelMailbox": true
},
"urn:ietf:params:jmap:submission": {
"maxDelayedSend": 2592000,
"submissionExtensions": {
"FUTURERELEASE": [],
"SIZE": [],
"DSN": [],
"DELIVERYBY": [],
"MT-PRIORITY": [
"MIXER"
],
"REQUIRETLS": []
}
},
"urn:ietf:params:jmap:vacationresponse": {},
"urn:ietf:params:jmap:contacts": {
"maxAddressBooksPerCard": null,
"mayCreateAddressBook": true
},
"urn:ietf:params:jmap:contacts:parse": {},
"urn:ietf:params:jmap:emailpush": {},
"urn:ietf:params:jmap:calendars": {
"maxCalendarsPerEvent": null,
"minDateTime": "0001-01-01T00:00:00Z",
"maxDateTime": "9999-12-31T23:59:59Z",
"maxExpandedQueryDuration": "P52W1D",
"maxParticipantsPerEvent": 20,
"mayCreateCalendar": true
},
"urn:ietf:params:jmap:calendars:parse": {},
"urn:ietf:params:jmap:websocket": {},
"urn:ietf:params:jmap:sieve": {
"maxSizeScriptName": 512,
"maxSizeScript": 102400,
"maxNumberScripts": 100,
"maxNumberRedirects": 1,
"sieveExtensions": [
"body",
"comparator-elbonia",
"comparator-i;ascii-casemap",
"comparator-i;ascii-numeric",
"comparator-i;octet",
"convert",
"copy",
"date",
"duplicate",
"editheader",
"enclose",
"encoded-character",
"enotify",
"envelope",
"envelope-deliverby",
"envelope-dsn",
"environment",
"ereject",
"extlists",
"extracttext",
"fcc",
"fileinto",
"foreverypart",
"ihave",
"imap4flags",
"imapsieve",
"include",
"index",
"mailbox",
"mailboxid",
"mboxmetadata",
"mime",
"redirect-deliverby",
"redirect-dsn",
"regex",
"reject",
"relational",
"replace",
"servermetadata",
"spamtest",
"spamtestplus",
"special-use",
"subaddress",
"vacation",
"vacation-seconds",
"variables",
"virustest"
],
"notificationMethods": [
"mailto"
],
"externalLists": null
},
"urn:ietf:params:jmap:blob": {
"maxSizeBlobSet": 7499488,
"maxDataSources": 16,
"supportedTypeNames": [
"Email",
"Thread",
"SieveScript"
],
"supportedDigestAlgorithms": [
"sha",
"sha-256",
"sha-512"
]
},
"urn:ietf:params:jmap:quota": {},
"urn:ietf:params:jmap:principals": {
"currentUserPrincipalId": john_id
},
"urn:ietf:params:jmap:principals:availability": {
"maxAvailabilityDuration": "P52W1D",
},
"urn:ietf:params:jmap:filenode": {
"maxFileNodeDepth": null,
"maxSizeFileNodeName": 255,
"forbiddenNameChars": "/<>:\"\\|?*",
"forbiddenNodeNames": [
".",
"..",
"CON",
"PRN",
"AUX",
"NUL",
"COM0",
"COM1",
"COM2",
"COM3",
"COM4",
"COM5",
"COM6",
"COM7",
"COM8",
"COM9",
"LPT0",
"LPT1",
"LPT2",
"LPT3",
"LPT4",
"LPT5",
"LPT6",
"LPT7",
"LPT8",
"LPT9"
],
"fileNodeQuerySortOptions": [
"name",
"size",
"nodeType"
],
"mayCreateTopLevelFileNode": true,
"caseInsensitiveNames": false,
"webTrashUrl": null,
"webUrlTemplate": null,
"webWriteUrlTemplate": null
},
"urn:ietf:params:jmap:mail:share": {},
"urn:inbuxa:jmap:registry": {},
// inbuxa: MT-22, the logo that applies to the account, and
// LP-19, whether the legacy protocols are open to it
"urn:inbuxa:jmap": { "logo": null, "legacyProtocols": "enabled" },
"https://www.fastmail.com/dev/maskedemail": {}
}
}
},
"primaryAccounts": {
"urn:ietf:params:jmap:mail": john_id,
"urn:ietf:params:jmap:submission": john_id,
"urn:ietf:params:jmap:vacationresponse": john_id,
"urn:ietf:params:jmap:contacts": john_id,
"urn:ietf:params:jmap:contacts:parse": john_id,
"urn:ietf:params:jmap:emailpush": john_id,
"urn:ietf:params:jmap:calendars": john_id,
"urn:ietf:params:jmap:calendars:parse": john_id,
"urn:ietf:params:jmap:websocket": john_id,
"urn:ietf:params:jmap:sieve": john_id,
"urn:ietf:params:jmap:blob": john_id,
"urn:ietf:params:jmap:quota": john_id,
"urn:ietf:params:jmap:principals": john_id,
"urn:ietf:params:jmap:principals:availability": john_id,
"urn:ietf:params:jmap:filenode": john_id,
"urn:ietf:params:jmap:mail:share": john_id,
"urn:inbuxa:jmap:registry": john_id,
"https://www.fastmail.com/dev/maskedemail": john_id
},
"username": "[email protected]",
"apiUrl": "https://127.0.0.1:8899/jmap/",
"downloadUrl":
"https://127.0.0.1:8899/jmap/download/{accountId}/{blobId}/{name}?accept={type}",
"uploadUrl":
"https://127.0.0.1:8899/jmap/upload/{accountId}/",
"eventSourceUrl":
"https://127.0.0.1:8899/jmap/eventsource/?types={types}&closeafter={closeafter}&ping={ping}",
"state": response.text_field("state")
}));
// Obtain principal ids for Jane, Bill and the sales group
let response = john
.jmap_query(
MethodObject::Principal,
[("email", "[email protected]")],
["name"],
Vec::<(&str, &str)>::new(),
)
.await;
assert_eq!(response.ids().collect::<Vec<_>>(), [john_id]);
let response = john
.jmap_query(
MethodObject::Principal,
[("name", "[email protected]")],
["name"],
Vec::<(&str, &str)>::new(),
)
.await;
assert_eq!(response.ids().collect::<Vec<_>>(), [bill_id]);
let response = john
.jmap_query(
MethodObject::Principal,
[("accountIds", [jane_id])],
["name"],
Vec::<(&str, &str)>::new(),
)
.await;
assert_eq!(response.ids().collect::<Vec<_>>(), [jane_id]);
let response = john
.jmap_query(
MethodObject::Principal,
[("text", "sales group")],
["name"],
Vec::<(&str, &str)>::new(),
)
.await;
assert_eq!(response.ids().collect::<Vec<_>>(), [sales_id]);
// Validate principal contents
let response = john
.jmap_get(
MethodObject::Principal,
[
PrincipalProperty::Id,
PrincipalProperty::Type,
PrincipalProperty::Email,
PrincipalProperty::Description,
PrincipalProperty::Name,
PrincipalProperty::Timezone,
PrincipalProperty::Capabilities,
PrincipalProperty::Accounts,
],
[john_id, jane_id, bill_id, sales_id],
)
.await;
let list = response.list();
assert_eq!(list.len(), 4);
list[0].assert_is_equal(json!({
"id": john_id,
"type": "individual",
"email": "[email protected]",
"description": "John Doe",
"name": "[email protected]",
"timezone": null,
"capabilities": {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {}
},
"accounts": {
john_id: {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {
"accountId": john_id,
"mayGetAvailability": true,
"mayShareWith": true,
"calendarAddress": "mailto:[email protected]"
},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {},
"urn:ietf:params:jmap:principals:owner": {
"accountIdForPrincipal": john_id,
"principalId": john_id
}
}
}
}));
list[1].assert_is_equal(json!({
"id": jane_id,
"type": "individual",
"email": "[email protected]",
"description": "Jane Smith",
"name": "[email protected]",
"timezone": null,
"capabilities": {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {}
},
"accounts": {
jane_id: {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {
"accountId": jane_id,
"mayGetAvailability": true,
"mayShareWith": true,
"calendarAddress": "mailto:[email protected]"
},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {},
"urn:ietf:params:jmap:principals:owner": {
"accountIdForPrincipal": jane_id,
"principalId": jane_id
}
}
}
}));
list[2].assert_is_equal(json!({
"id": bill_id,
"type": "individual",
"email": "[email protected]",
"description": "Bill Foobar",
"name": "[email protected]",
"timezone": null,
"capabilities": {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {}
},
"accounts": {
bill_id: {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {
"accountId": bill_id,
"mayGetAvailability": true,
"mayShareWith": true,
"calendarAddress": "mailto:[email protected]"
},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {},
"urn:ietf:params:jmap:principals:owner": {
"accountIdForPrincipal": bill_id,
"principalId": bill_id
}
}
}
}));
list[3].assert_is_equal(json!({
"id": sales_id,
"type": "group",
"email": "[email protected]",
"description": "Sales Group",
"name": "[email protected]",
"timezone": null,
"capabilities": {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {}
},
"accounts": {
sales_id: {
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:contacts": {},
"urn:ietf:params:jmap:calendars": {
"accountId": sales_id,
"mayGetAvailability": true,
"mayShareWith": true,
"calendarAddress": "mailto:[email protected]"
},
"urn:ietf:params:jmap:filenode": {},
"urn:ietf:params:jmap:principals": {},
"urn:ietf:params:jmap:principals:owner": {
"accountIdForPrincipal": sales_id,
"principalId": sales_id
}
}
}
}));
}
Reference in New Issue View Git Blame Copy Permalink