Compare commits

..
Author SHA1 Message Date
Renovate Bot 6ff2442839 chore(deps): update rust-non-major 2026-11-19 05:03:11 +00:00
Silversys 06c63e8de3 chore: Update resolvematrix to 1.5.0 2026-11-18 23:26:46 +01:00
timedout 8ffa3e5367 fix: Wrap parsed & raw values
Rather than passing them around separately everywhere, just unify them into a single struct that is primarily fetched via a raw.
Also stores raw data directly into the database so that signatures can be verified later rather than only at receive time.
2026-11-18 15:10:51 +00:00
hexchen cec1f85f88 fix: verify_server_keys_response fails on non-standard json fields
Previously `verify_server_keys_response` would work with re-serialized 
ServerSigningKeys, which drops any extra, non-standard fields from the
origin server response. The signature is made over the whole response
though, meaning that any response including extra fields will not pass
signature verification.
2026-11-18 15:10:51 +00:00
Jade Ellis ad50b9a3b3 fix(complement): Enable using container builds as a base 2026-11-18 12:37:40 +00:00
13 changed files with 258 additions and 126 deletions

No files matched your search

Generated
+36 -28
View File
@@ -497,7 +497,7 @@ dependencies = [
"regex",
"rustc-hash",
"shlex",
"syn 3.0.10",
"syn 2.0.119",
]
[[package]]
@@ -604,9 +604,9 @@ checksum = "8f1fe948ff07f4bd06c30984e69f5b4899c516a3ef74f34df92a2df2ab535495"
[[package]]
name = "bytes"
version = "1.12.1"
version = "1.12.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04"
checksum = "776dfebd015e2d8732c684a2c71003674ccb49457b539b9e82151ba38e96dd7c"
[[package]]
name = "bytesize"
@@ -624,6 +624,12 @@ dependencies = [
"pkg-config",
]
[[package]]
name = "cache_control"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1bf2a5fb3207c12b5d208ebc145f967fea5cac41a021c37417ccc31ba40f39ee"
[[package]]
name = "camino"
version = "1.2.6"
@@ -758,9 +764,9 @@ dependencies = [
[[package]]
name = "clap"
version = "4.6.7"
version = "4.6.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "aa8876b300ab35ba921adea3dfd70157a46249b33f95c9084ae5709785478946"
checksum = "ac230478587d0269d8d6998b82ae69ea51509d55df66d9e92edd1f986904cd4a"
dependencies = [
"clap_builder",
"clap_derive",
@@ -778,9 +784,9 @@ dependencies = [
[[package]]
name = "clap_derive"
version = "4.6.7"
version = "4.6.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f9c751b79415d4e559e3d1fcf128e09e720eb673a06d26cf6f392d37d75b66e0"
checksum = "895c9d8d2ac2dd8b8a29f3724a14e72aaaa6debcf8c38c82f97305c6a172767a"
dependencies = [
"heck",
"proc-macro2",
@@ -1519,9 +1525,9 @@ dependencies = [
[[package]]
name = "ctor"
version = "1.0.13"
version = "1.0.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "914a755b7c2d4af2bdcff7ce1739e2db9a1b81a9b07123d8015786ae03c0980d"
checksum = "ea691ed9f36489d087419b8b2ba3ef27d89621380b4178c73e2445a379e4e0f4"
dependencies = [
"link-section",
"linktime-proc-macro",
@@ -1778,10 +1784,11 @@ dependencies = [
[[package]]
name = "dtor"
version = "1.0.6"
version = "1.0.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cd3f6c362b2bbd7063090886afd78978f5dbf1f11da7efcc40f81d32c943fac1"
checksum = "915e80ae7aca23bef767ded8e4a763d0c912c2faaa8bfec1e66d505ebaceb254"
dependencies = [
"link-section",
"linktime-proc-macro",
]
@@ -2311,9 +2318,9 @@ dependencies = [
[[package]]
name = "granit-parser"
version = "2.1.0"
version = "2.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "05f05586d4d4df3d47123207826c40b252728b438a1a07bad3c01ee6bea401df"
checksum = "9bd04d0d9c7079b416b458d2317aea4aa964c81938cb7c20f559758c4f422dc8"
dependencies = [
"arraydeque",
"smallvec",
@@ -3262,9 +3269,9 @@ dependencies = [
[[package]]
name = "link-section"
version = "0.19.3"
version = "0.19.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "39c29a617ce3df32c08497bdc1ab6e2376e0b17948ac166a2fbe5977c5954cd9"
checksum = "4d9aae57673c1a235149777a74d152f3210ebd3e3b13346d2cdb6809e566bd3c"
[[package]]
name = "linked-hash-map"
@@ -4781,9 +4788,9 @@ dependencies = [
[[package]]
name = "regex"
version = "1.13.1"
version = "1.13.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d"
checksum = "9807af0e638c12e753aa1b4e601791bf2a8f71274023c8bbeec12fc149950857"
dependencies = [
"aho-corasick",
"memchr",
@@ -4793,9 +4800,9 @@ dependencies = [
[[package]]
name = "regex-automata"
version = "0.4.18"
version = "0.4.19"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2"
checksum = "41d60ef07df457506a0a1a2073112eb4aae5733dbd2813c3da77d1b0fd441158"
dependencies = [
"aho-corasick",
"memchr",
@@ -4804,9 +4811,9 @@ dependencies = [
[[package]]
name = "regex-syntax"
version = "0.8.11"
version = "0.8.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4"
checksum = "d902046e6a28a1e4c3cab97258a0ce11e994903f01c2d97a9447a0b3df85f4f6"
[[package]]
name = "reqwest"
@@ -4898,10 +4905,11 @@ checksum = "1e061d1b48cb8d38042de4ae0a7a6401009d6143dc80d2e2d6f31f0bdd6470c7"
[[package]]
name = "resolvematrix"
version = "1.4.2"
version = "1.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d6e659fe17ed82acfac43641d00d1bbfd0a9d53ec4d2f901b01f792f0e2c9e3c"
checksum = "39a1efc3c55274528f8b1a916eb0edf5c40a8364b4899fbc1283a57c8d0024db"
dependencies = [
"cache_control",
"hickory-resolver",
"num-traits",
"parking_lot",
@@ -5621,12 +5629,12 @@ dependencies = [
[[package]]
name = "serde-saphyr"
version = "2.1.1"
version = "2.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d43fb82d550b07e6f929a58d7d0935182602f48ddead875f5ee313c41c8f07fe"
checksum = "969cde0349344dbbf58b5f9badbfb8f806db13969364eb8007c057ef687007d9"
dependencies = [
"annotate-snippets",
"base64 0.23.1",
"base64 0.22.1",
"encoding_rs_io",
"granit-parser",
"nohash-hasher",
@@ -5964,9 +5972,9 @@ dependencies = [
[[package]]
name = "smallvec"
version = "1.16.5"
version = "1.16.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "149309498a5f7334b12ddae0cad8aba81ce785fe91755068867e017cf98fee46"
checksum = "3244542535d5de959d90ec55d1b5ff0fd2bb7b1310223907d5f11932847f7b59"
dependencies = [
"serde",
]
+1 -1
View File
@@ -603,7 +603,7 @@ features = ["std"]
version = "0.3.0"
[workspace.dependencies.resolvematrix]
version = "1.4.2"
version = "1.5.0"
features = ["unstable-msc4188"]
[workspace.dependencies.serde_urlencoded]
+17 -3
View File
@@ -52,8 +52,10 @@ else
fi
# The base docker image to use for complement tests
# You can build the default with `docker build -t continuwuity:complement -f ./docker/complement.Dockerfile .`
# after running `cargo build -p conduwuit --features openreg`. Only the debug binary is used.
# On Linux, you can build the default with `docker build -t continuwuity:complement -f ./docker/complement.Dockerfile .`
# after running `cargo build -p conduwuit --features openreg`.
# On non-Linux platforms (or to use a container build), build `docker/Dockerfile` with debuginfo and openreg `--build-arg RUST_PROFILE=dev --build-arg CARGO_FEATURES=default,openreg`
# and then run `docker build -t continuwuity:complement --target container -f ./docker/complement.Dockerfile .`.
COMPLEMENT_BASE_IMAGE="${COMPLEMENT_BASE_IMAGE:-continuwuity:complement}"
# Complement tests that are skipped due to flakiness/reliability issues or we don't implement such features and won't for a long time
@@ -83,6 +85,13 @@ for command in docker go jq; do
fi
done
if [ -z "${DOCKER_HOST:-}" ]; then
DOCKER_HOST="$(docker context inspect --format '{{.Endpoints.docker.Host}}' 2>/dev/null || true)"
if [ -n "$DOCKER_HOST" ]; then
export DOCKER_HOST
fi
fi
if [ -n "$IMAGE_ARCHIVE" ]; then
if [ ! -f "$IMAGE_ARCHIVE" ]; then
echo "Docker image archive not found: $IMAGE_ARCHIVE"
@@ -99,7 +108,12 @@ fi
if ! docker image inspect "$COMPLEMENT_BASE_IMAGE" > /dev/null 2>&1; then
echo "Complement base image not found: $COMPLEMENT_BASE_IMAGE"
echo "Build it with: cargo build -p conduwuit --features openreg && docker build -t $COMPLEMENT_BASE_IMAGE -f docker/complement.Dockerfile ."
if [ "$(uname -s)" != "Linux" ]; then
echo "Build it with: docker buildx build --load -t continuwuity:latest-openreg --build-arg RUST_PROFILE=dev --build-arg CARGO_FEATURES=default,openreg -f docker/Dockerfile . && docker build -t $COMPLEMENT_BASE_IMAGE --target container -f docker/complement.Dockerfile ."
else
echo "Build it with: cargo build -p conduwuit --features openreg && docker build -t $COMPLEMENT_BASE_IMAGE -f docker/complement.Dockerfile ."
echo "Or from a container build: docker buildx build --load -t continuwuity:latest-openreg --build-arg RUST_PROFILE=dev --build-arg CARGO_FEATURES=default,openreg -f docker/Dockerfile . && docker build -t $COMPLEMENT_BASE_IMAGE --target container -f docker/complement.Dockerfile ."
fi
exit 1
fi
+1
View File
@@ -0,0 +1 @@
Fix remote server key signature verification when extra fields exist. Contributed by @hexchen
+21 -3
View File
@@ -1,11 +1,29 @@
FROM ubuntu:latest
ARG CONTINUWUITY_IMAGE=continuwuity:latest-openreg
ARG BINARY_SOURCE=host
FROM ${CONTINUWUITY_IMAGE} AS container-binary
FROM scratch AS host-binary
ARG BINARY_PATH=target/debug/conduwuit
COPY ${BINARY_PATH} /sbin/conduwuit
FROM ubuntu:latest AS base
EXPOSE 8008
EXPOSE 8448
RUN apt-get update && apt-get install -y ca-certificates liburing2 && rm -rf /var/lib/apt/lists/*
RUN mkdir -p /etc/continuwuity /var/lib/continuwuity /usr/local/bin/
COPY complement/complement-entrypoint.sh /usr/local/bin/complement-entrypoint.sh
COPY complement/complement.config.toml /etc/continuwuity/config.toml
COPY target/debug/conduwuit /usr/local/bin/conduwuit
RUN chmod +x /usr/local/bin/conduwuit /usr/local/bin/complement-entrypoint.sh
RUN chmod +x /usr/local/bin/complement-entrypoint.sh
#HEALTHCHECK --interval=30s --timeout=5s CMD curl --fail http://localhost:8008/_continuwuity/server_version || exit 1
ENTRYPOINT ["/usr/local/bin/complement-entrypoint.sh"]
FROM base AS container
COPY --from=container-binary /sbin/conduwuit /usr/local/bin/conduwuit
RUN chmod +x /usr/local/bin/conduwuit
FROM base AS host
COPY --from=host-binary /sbin/conduwuit /usr/local/bin/conduwuit
RUN chmod +x /usr/local/bin/conduwuit
FROM ${BINARY_SOURCE}
+14
View File
@@ -20,6 +20,20 @@ docker build -t continuwuity:complement -f docker/complement.Dockerfile .
The `openreg` feature is required: without it the server refuses the open
registrations Complement uses to create test users, and almost every test fails.
On non-Linux (or to build inside a container instead of on the host), build the Continuwuity image with the `openreg` feature and `RUST_PROFILE=dev` first (open
registration is only enabled when `debug_assertions` are active), then build
the Complement image using the `container` target:
```bash
docker buildx build --load -t continuwuity:latest-openreg --build-arg RUST_PROFILE=dev --build-arg CARGO_FEATURES=default,openreg -f docker/Dockerfile .
docker build -t continuwuity:complement --target container -f docker/complement.Dockerfile .
./bin/complement
```
Pass `--build-arg CONTINUWUITY_IMAGE=your-image:tag` when building
`docker/complement.Dockerfile` if your Continuwuity container image uses a
different tag.
The run can take up to an hour. The runner writes the full Go test stream to
`tests/test_results/complement/test_logs.jsonl` and a sorted pass/fail/skip
summary to `tests/test_results/complement/test_results.jsonl`. It exits nonzero
+13 -13
View File
@@ -431,9 +431,9 @@
}
},
"node_modules/@rspress/core": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/@rspress/core/-/core-2.1.3.tgz",
"integrity": "sha512-qKa5c7zHO8cmhxkReURd3dN/ZRfHYnEztdIQ9hMuolaNzhSYo2A36XErUvLvbMf2EUM2AxfPYRQv+4Crfeq6pw==",
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/@rspress/core/-/core-2.1.2.tgz",
"integrity": "sha512-3ghPRkZFwbuO3tr2Rb5cxi6QfSFWOcxoZ5p4pv21lbN5DxAzMduITFlfgBMTArIQbehXrfXw3OUXe1l422b0RA==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -441,7 +441,7 @@
"@mdx-js/react": "^3.1.1",
"@rsbuild/core": "^2.2.14",
"@rsbuild/plugin-react": "~2.1.1",
"@rspress/shared": "2.1.3",
"@rspress/shared": "2.1.2",
"@shikijs/rehype": "^4.2.0",
"@shikijs/transformers": "^4.2.0",
"@types/mdast": "^4.0.4",
@@ -485,9 +485,9 @@
}
},
"node_modules/@rspress/plugin-client-redirects": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/@rspress/plugin-client-redirects/-/plugin-client-redirects-2.1.3.tgz",
"integrity": "sha512-iEqJ8qEFuUxGKRVaS/WMyFi8FiJlogdcEHbGK/UjY8+8Hg8r8aSv4YihmNh3Ev/uIW21hrC8aXMEgVo0H51Q+g==",
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/@rspress/plugin-client-redirects/-/plugin-client-redirects-2.1.2.tgz",
"integrity": "sha512-kNCC7fffXA277TzTDfKpP+QuCI1X218lJ5JH/2iqYR8PHnLw0Y6ZIwoFmJlE0eKaBdniYyBRGn9zgvT93mCWdg==",
"dev": true,
"license": "MIT",
"engines": {
@@ -498,9 +498,9 @@
}
},
"node_modules/@rspress/plugin-sitemap": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/@rspress/plugin-sitemap/-/plugin-sitemap-2.1.3.tgz",
"integrity": "sha512-Fqo7/4PfQK1ecHUFoUDMrR/E+Hcu+kIohxSs8QabflMy3dqk+M3ZqzJDOHpVYB+HLLGwKiqkPLT4BK+W93clkw==",
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/@rspress/plugin-sitemap/-/plugin-sitemap-2.1.2.tgz",
"integrity": "sha512-qF9NDLLJORa7MM8QY/etgMlrXM8hlArNaK5ntiFimqtKRoF1YTJQSKPsAfMq2PvYrpQJyEqsSg6wJ+r+lyjNlw==",
"dev": true,
"license": "MIT",
"engines": {
@@ -511,9 +511,9 @@
}
},
"node_modules/@rspress/shared": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/@rspress/shared/-/shared-2.1.3.tgz",
"integrity": "sha512-VwJ7kgsTWVqHzSXQVHIUCsdMparmq9b/IDmTa3a6jMPl1zmm5Qg9M0eP4j8JXWoIS9n19XtCkQcZmMTFOPRy3A==",
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/@rspress/shared/-/shared-2.1.2.tgz",
"integrity": "sha512-W34tT1fdP3PrdbXpZNKqOGZMOw+RYL70Z9vnkbT1HTTbtX4uMIDE+SU7ByihG0S0LYBsT3kPxA2cXj696253Uw==",
"dev": true,
"license": "MIT",
"dependencies": {
+2 -2
View File
@@ -142,11 +142,11 @@ impl crate::Context<'_> {
.await?;
self.write_str("| ------ | ---------- | --------------------------- |\n")
.await?;
for (key_id, key) in &response.verify_keys {
for (key_id, key) in &response.parsed.verify_keys {
self.write_str(&format!("| {key_id} | {} | |\n", key.key))
.await?;
}
for (key_id, old_key) in &response.old_verify_keys {
for (key_id, old_key) in &response.parsed.old_verify_keys {
self.write_str(&format!(
"| {key_id} | {} | {:0<13} |\n",
old_key.key,
+3 -3
View File
@@ -34,7 +34,7 @@ pub(crate) async fn get_server_keys_route(
// We need to verify that this response is still trusted based on
// the current configuration. It's possible we got this response
// from a notary who we no longer trust.
if resp.valid_until_ts > in_one_week() {
if resp.parsed.valid_until_ts > in_one_week() {
continue;
}
let trusted = services.config.trusted_servers.iter().any(|notary| {
@@ -47,8 +47,8 @@ pub(crate) async fn get_server_keys_route(
if !trusted {
continue;
}
for (old_key_id, old_key) in resp.old_verify_keys {
if old_key.expired_ts > resp.valid_until_ts {
for (old_key_id, old_key) in resp.parsed.old_verify_keys {
if old_key.expired_ts > resp.parsed.valid_until_ts {
// This key expired in the future which is probably illegal
continue;
}
+9 -9
View File
@@ -241,9 +241,9 @@ impl super::Service {
continue;
}
};
trace!(?origin_response, "Got signing key response from origin");
trace!(?origin_response.raw, "Got signing key response from origin");
self.add_signing_keys(&origin_response);
Self::track_result(&mut result, &mut still_missing, &origin_response);
Self::track_result(&mut result, &mut still_missing, &origin_response.parsed);
if still_missing.is_empty() {
break;
}
@@ -262,9 +262,9 @@ impl super::Service {
"Got signing keys response from a notary"
);
for server_keys in notary_response {
trace!(?server_keys, "Adding response from notary");
trace!(?server_keys.raw, "Adding response from notary");
self.add_signing_keys(&server_keys);
Self::track_result(&mut result, &mut still_missing, &server_keys);
Self::track_result(&mut result, &mut still_missing, &server_keys.parsed);
if still_missing.is_empty() {
break;
}
@@ -285,9 +285,9 @@ impl super::Service {
continue;
};
for server_keys in res {
trace!(?server_keys, "Adding response from notary");
trace!(?server_keys.raw, "Adding response from notary");
self.add_signing_keys(&server_keys);
Self::track_result(&mut result, &mut still_missing, &server_keys);
Self::track_result(&mut result, &mut still_missing, &server_keys.parsed);
}
if still_missing.is_empty() {
break;
@@ -300,9 +300,9 @@ impl super::Service {
debug_warn!(err=?res.err(), "Got error response from origin");
continue;
};
trace!(response=?res, "Got signing key response from origin");
trace!(response=?res.raw, "Got signing key response from origin");
self.add_signing_keys(&res);
Self::track_result(&mut result, &mut still_missing, &res);
Self::track_result(&mut result, &mut still_missing, &res.parsed);
if still_missing.is_empty() {
break;
}
@@ -400,7 +400,7 @@ impl super::Service {
.inspect_err(|e| info!("Could not acquire signing key from origin server: {e:?}"))
.ok()?;
verify_key_from_response(key_id, &response, min_valid_ts)
verify_key_from_response(key_id, &response.parsed, min_valid_ts)
.inspect(|_| self.add_signing_keys(&response))
}
}
+13 -7
View File
@@ -19,8 +19,10 @@ use ruma::{
ServerSigningKeyId,
api::federation::discovery::{ServerSigningKeys, VerifyKey},
room_version_rules::RoomVersionRules,
serde::Raw,
signatures::{Ed25519KeyPair, PublicKeyMap, PublicKeySet},
};
use verify::IncomingServerKeys;
use crate::{Dep, globals, sending, server_keys::util::required_keys};
@@ -83,19 +85,22 @@ impl Service {
}
/// Adds a signing key response to the database.
fn add_signing_keys(&self, new_keys: &ServerSigningKeys) {
fn add_signing_keys(&self, new_keys: &IncomingServerKeys) {
// TODO(nex): this results in massive amounts of data duplication.
// Perhaps a sliding approach would be better? where we just update the
// last known response if the only thing that changed was the
// valid_until_ts. This would require a more complex data structure
// though. For now, just storing the duplicated data is fine.
for key in new_keys
.parsed
.verify_keys
.keys()
.chain(new_keys.old_verify_keys.keys())
.chain(new_keys.parsed.old_verify_keys.keys())
{
let db_key = (new_keys.server_name.as_str(), key.as_str());
self.db.servernamekeyid_response.put(db_key, Json(new_keys));
let db_key = (new_keys.parsed.server_name.as_str(), key.as_str());
self.db
.servernamekeyid_response
.put(db_key, Json(&new_keys.raw));
}
}
@@ -170,7 +175,7 @@ impl Service {
let mut keys = self
.signing_keys_for(origin)
.ready_fold(BTreeMap::new(), |mut base, keys| {
base.extend(keys.verify_keys);
base.extend(keys.parsed.verify_keys);
base
})
.await;
@@ -186,11 +191,12 @@ impl Service {
pub fn signing_keys_for<'a>(
&'a self,
origin: &'a ServerName,
) -> impl Stream<Item = ServerSigningKeys> + Send + 'a {
) -> impl Stream<Item = IncomingServerKeys> + Send + 'a {
self.db
.servernamekeyid_response
.stream_prefix(&(origin, Interfix))
.ignore_err()
.map(|(_, v): (Ignore, ServerSigningKeys)| v)
.map(|(_, v): (Ignore, Raw<ServerSigningKeys>)| v.try_into().map_err(Into::into))
.ignore_err()
}
}
+36 -28
View File
@@ -4,7 +4,6 @@ use conduwuit::{Err, Result, trace, utils::millis_since_unix_epoch, warn};
use ruma::{
MilliSecondsSinceUnixEpoch, OwnedServerName, OwnedServerSigningKeyId, ServerName, UInt,
api::federation::discovery::{
ServerSigningKeys,
get_remote_server_keys_batch::{
self,
v2::{QueryCriteria, Response as NotaryResponse},
@@ -15,6 +14,8 @@ use ruma::{
uint,
};
use crate::server_keys::verify::IncomingServerKeys;
pub(crate) type ServerKeysQuery = BTreeMap<OwnedServerName, ServerKeysQuerySet>;
pub(crate) type ServerKeysQuerySet = BTreeMap<OwnedServerSigningKeyId, QueryCriteria>;
@@ -27,32 +28,33 @@ impl super::Service {
&self,
target: OwnedServerName,
min_valid_ts: MilliSecondsSinceUnixEpoch,
) -> Result<ServerSigningKeys> {
) -> Result<IncomingServerKeys> {
use get_server_keys::v2::Request;
let server_signing_key = self
let raw_server_key = self
.services
.sending
.send_unauthenticated_request(&target, Request::new())
.await
.map(|response| response.server_key)
.and_then(|key| key.deserialize().map_err(Into::into))?;
.map(|response| response.server_key)?;
if server_signing_key.server_name != target {
let server_signing_key: IncomingServerKeys = raw_server_key.try_into()?;
if server_signing_key.parsed.server_name != target {
return Err!(BadServerResponse(debug_warn!(
requested = ?target,
response = ?server_signing_key.server_name,
response = ?server_signing_key.parsed.server_name,
"Origin server responded with bogus server_name"
)));
}
if server_signing_key.valid_until_ts < min_valid_ts
|| server_signing_key.valid_until_ts > in_one_week()
if server_signing_key.parsed.valid_until_ts < min_valid_ts
|| server_signing_key.parsed.valid_until_ts > in_one_week()
{
return Err!(BadServerResponse(debug_warn!(
?target,
?min_valid_ts,
?server_signing_key.valid_until_ts,
?server_signing_key.parsed.valid_until_ts,
"Origin server responded with server keys that are not in-date"
)));
}
@@ -83,7 +85,7 @@ impl super::Service {
&self,
notary: &ServerName,
batch: ServerKeysQuery,
) -> Result<Vec<ServerSigningKeys>> {
) -> Result<Vec<IncomingServerKeys>> {
use get_remote_server_keys_batch::v2::Request;
let is_empty = batch.is_empty() || batch.values().all(BTreeMap::is_empty);
@@ -116,12 +118,12 @@ impl super::Service {
}
/// Parses a notary response, returning a vec of server signing key
/// responses. Drops any chunks that cannot be deserialized.
fn parse_notary_response(raw: &NotaryResponse) -> Vec<ServerSigningKeys> {
/// responses, each paired with its raw JSON (which is what the signatures
/// were made over). Drops any chunks that cannot be deserialized.
fn parse_notary_response(raw: &NotaryResponse) -> Vec<IncomingServerKeys> {
raw.server_keys
.iter()
.map(ruma::serde::Raw::deserialize)
.filter_map(Result::ok)
.filter_map(|chunk| chunk.try_into().ok())
.collect()
}
@@ -129,12 +131,15 @@ impl super::Service {
/// if the response should be dropped, true if it should be kept.
fn validate_notary_chunk(
batch: &ServerKeysQuery,
keys: &ServerSigningKeys,
incoming: &IncomingServerKeys,
notary_name: &ServerName,
notary_keys: &[Base64],
) -> bool {
let Some(expected_keys) = batch.get(&keys.server_name) else {
trace!("Dropping signing keys chunk for unrequested server: {}", keys.server_name);
let Some(expected_keys) = batch.get(&incoming.parsed.server_name) else {
trace!(
"Dropping signing keys chunk for unrequested server: {}",
incoming.parsed.server_name
);
return false;
};
let min_valid_ts = expected_keys
@@ -148,13 +153,15 @@ impl super::Service {
// If this notary response is older than any of the min_valid_ts we
// requested, then we should drop it.
if keys.valid_until_ts < min_valid_ts || keys.valid_until_ts > in_one_week() {
if incoming.parsed.valid_until_ts < min_valid_ts
|| incoming.parsed.valid_until_ts > in_one_week()
{
trace!(
?min_valid_ts,
?keys.valid_until_ts,
?incoming.parsed.valid_until_ts,
"Dropping signing keys chunk for server {} because it is older than the minimum \
valid timestamp we requested",
keys.server_name
incoming.parsed.server_name
);
return false;
}
@@ -162,38 +169,39 @@ impl super::Service {
// Does this chunk even contain any keys we asked for?
// Note that this enforces min_valid_ts per-key, instead of using the
// lowest denominator.
let all_key_ids = keys
let all_key_ids = incoming
.parsed
.verify_keys
.keys()
.chain(keys.old_verify_keys.keys())
.chain(incoming.parsed.old_verify_keys.keys())
.map(ToOwned::to_owned)
.collect::<Vec<_>>();
let interesting = expected_keys.iter().any(|(k, q)| {
all_key_ids.contains(k)
&& q.minimum_valid_until_ts
.is_none_or(|m| m <= keys.valid_until_ts)
.is_none_or(|m| m <= incoming.parsed.valid_until_ts)
});
if !interesting {
trace!(
"Dropping signing keys chunk for server {} because it does not contain any keys \
we requested",
keys.server_name
incoming.parsed.server_name
);
return false;
}
Self::verify_server_keys_response(keys, Some((notary_name, notary_keys)))
Self::verify_server_keys_response(incoming, Some((notary_name, notary_keys)))
.inspect_err(|e| {
trace!(
?e,
?keys,
?incoming.raw,
?notary_name,
?notary_keys,
"Dropping illegal server signing keys response chunk"
);
warn!(
%notary_name,
server_name=%keys.server_name,
server_name=%incoming.parsed.server_name,
"Dropping illegal server signing keys response chunk: {e:?}"
);
})
+92 -29
View File
@@ -5,11 +5,36 @@ use ruma::{
CanonicalJsonObject, CanonicalJsonValue, OwnedEventId, ServerName, SigningKeyAlgorithm,
api::federation::discovery::ServerSigningKeys,
room_version_rules::RoomVersionRules,
serde::{Base64, base64::Standard},
serde::{Base64, Raw, base64::Standard},
signatures::Verified,
};
use serde_json::value::RawValue as RawJsonValue;
pub struct IncomingServerKeys {
pub raw: Raw<ServerSigningKeys>,
pub parsed: ServerSigningKeys,
}
impl TryFrom<Raw<ServerSigningKeys>> for IncomingServerKeys {
type Error = serde_json::Error;
fn try_from(value: Raw<ServerSigningKeys>) -> std::result::Result<Self, Self::Error> {
value
.deserialize()
.map(|parsed| Self { raw: value, parsed })
}
}
impl TryFrom<&Raw<ServerSigningKeys>> for IncomingServerKeys {
type Error = serde_json::Error;
fn try_from(value: &Raw<ServerSigningKeys>) -> std::result::Result<Self, Self::Error> {
value
.deserialize()
.map(|parsed| Self { raw: value.to_owned(), parsed })
}
}
impl super::Service {
/// Validates the incoming event only using locally known verification keys.
/// Inserts the calculated event ID into the event_id field upon success.
@@ -58,34 +83,38 @@ impl super::Service {
/// `notary` must either be empty or have ONE entry. Extraneous notaries
/// will be ignored.
pub fn verify_server_keys_response(
server_keys: &ServerSigningKeys,
incoming: &IncomingServerKeys,
notary: Option<(&ServerName, &[Base64])>,
) -> Result<()> {
if let Some((notary_name, notary_keys)) = notary {
if !notary_keys.is_empty() {
Self::verify_notary_signature(server_keys, notary_name, notary_keys)?;
Self::verify_notary_signature(incoming, notary_name, notary_keys)?;
}
}
// NOTE: old_verify_keys aren't considered here because old keys can't
// be used to sign key responses.
let mut set = ruma::signatures::PublicKeySet::new();
server_keys.verify_keys.iter().for_each(|(key_id, key)| {
set.insert(key_id.to_string(), key.key.clone());
});
incoming
.parsed
.verify_keys
.iter()
.for_each(|(key_id, key)| {
set.insert(key_id.to_string(), key.key.clone());
});
let mut pubkey_map = ruma::signatures::PublicKeyMap::new();
pubkey_map.insert(server_keys.server_name.to_string(), set);
pubkey_map.insert(incoming.parsed.server_name.to_string(), set);
let mut canonical = to_canonical_object(server_keys)?;
Self::strip_extraneous_signatures(&mut canonical, &server_keys.server_name, &[]);
let mut canonical = to_canonical_object(&incoming.raw)?;
Self::strip_extraneous_signatures(&mut canonical, &incoming.parsed.server_name, &[]);
ruma::signatures::verify_json(&pubkey_map, &canonical).map_err(Into::into)
}
/// Verifies that the notary has at least one valid signature present with
/// the provided signing keys.
fn verify_notary_signature(
server_keys: &ServerSigningKeys,
incoming: &IncomingServerKeys,
notary_name: &ServerName,
notary_keys: &[Base64],
) -> Result<()> {
@@ -94,19 +123,16 @@ impl super::Service {
// certificate has been compromised, which would otherwise allow
// them to produce attacker-controlled signing keys with valid
// self-signatures.
let Some(notary_signatures) = server_keys.signatures.get(notary_name) else {
let Some(notary_signatures) = incoming.parsed.signatures.get(notary_name) else {
return Err!(Request(Forbidden(
"Missing notary server signature from {notary_name}"
)));
};
let mut canonical_object = to_canonical_object(notary_signatures)?;
Self::strip_extraneous_signatures(&mut canonical_object, &server_keys.server_name, &[
notary_name,
]);
// The notary signed the response as the origin served it, so verify
// over the raw JSON, not a re-serialised `ServerSigningKeys`.
let for_verify = ruma::signatures::to_canonical_json_string_for_signing(
&to_canonical_object(server_keys).expect("server keys object must be canonical json"),
)
.expect("canonical JSON must be stringable");
&to_canonical_object(&incoming.raw)?,
)?;
let raw_notary_keys = notary_keys.iter().map(Base64::as_bytes).collect::<Vec<_>>();
let raw_notary_signatures = notary_signatures
@@ -126,7 +152,7 @@ impl super::Service {
trace!(
"Valid signature from {notary_name} present on signing keys response \
for {}",
server_keys.server_name
incoming.parsed.server_name
);
return Ok(());
}
@@ -181,9 +207,9 @@ mod tests {
}
}
}
)).map(Raw::from_json).unwrap();
)).map(Raw::from_json).unwrap().try_into().unwrap();
Service::verify_server_keys_response(&response_data.deserialize().unwrap(), None)
Service::verify_server_keys_response(&response_data, None)
.expect("Self-signature of real key response is valid");
}
@@ -208,9 +234,9 @@ mod tests {
}
}
}
)).map(Raw::from_json).unwrap();
)).map(Raw::from_json).unwrap().try_into().unwrap();
Service::verify_server_keys_response(&response_data.deserialize().unwrap(), None)
Service::verify_server_keys_response(&response_data, None)
.expect("Self-signature of real key response is valid");
}
@@ -235,11 +261,11 @@ mod tests {
}
}
}
)).map(Raw::from_json).unwrap();
)).map(Raw::from_json).unwrap().try_into().unwrap();
let starstruck_pubkey =
Base64::<Standard>::parse("Z4oHuEjdUbtC5W/z/gzc5B8raxNk+8gGwbNwgxHqW8Y").unwrap();
Service::verify_server_keys_response(
&response_data.deserialize().unwrap(),
&response_data,
Some((server_name!("starstruck.systems"), &[starstruck_pubkey])),
)
.expect("Server keys from notary are valid");
@@ -265,8 +291,8 @@ mod tests {
}
}
}
)).map(Raw::from_json).unwrap();
Service::verify_server_keys_response(&response_data.deserialize().unwrap(), None)
)).map(Raw::from_json).unwrap().try_into().unwrap();
Service::verify_server_keys_response(&response_data, None)
.expect_err("Tampered response should fail self-signature check");
}
@@ -303,8 +329,45 @@ mod tests {
}
}
}
)).map(Raw::from_json).unwrap();
Service::verify_server_keys_response(&response_data.deserialize().unwrap(), None)
)).map(Raw::from_json).unwrap().try_into().unwrap();
Service::verify_server_keys_response(&response_data, None)
.expect_err("Intercepted notary response should fail strict validation");
}
#[test]
fn verify_response_with_extra_fields() {
let response_data = serde_json::from_value(serde_json::json!(
{
"old_verify_keys": {},
"server_name": "origin.example",
"signatures": {
"notary.example": {
"ed25519:a_RBdc": "ozlc2T5TlUa9XAsmeam+ESr20573vqFJvYHonj3nG8x+m6v7K5TSlEKTAlTRrJYiC6T/aWB+yxMae6FYR6nqCA"
},
"origin.example": {
"ed25519:a_jUhC": "+8xKspAfqI8SfrioOVliQ/jCPRDZEuag6JfkN5dXx9gsCX2rSnbvVTJlTJXFiDYUSyIJZg8ilq1QaPsT85ltBA"
}
},
"tls_fingerprints": [],
"valid_until_ts": 1900000000000_i64,
"verify_keys": {
"ed25519:a_jUhC": {
"key": "idcPtcSpRB5Chnlv1azhL3rMlcTawgQhoGNZWKaNFGI"
}
}
}
)).map(Raw::from_json).unwrap().try_into().unwrap();
let notary_pubkey =
Base64::<Standard>::parse("0ocHGigwa/ap6gSZzzspDQhhOkVkloaf9apolOvwqo8").unwrap();
Service::verify_server_keys_response(&response_data, None)
.expect("Self-signature must verify over the raw response");
Service::verify_server_keys_response(
&response_data,
Some((server_name!("notary.example"), &[notary_pubkey])),
)
.expect("Notary signature must verify over the raw response");
}
}