Compare commits

...
19 Commits
Author SHA1 Message Date
Renovate Bot a3d23c3718 chore(deps): update ghcr.io/renovatebot/renovate docker tag to v44.241.0 2026-11-16 05:05:23 +00:00
Erwan Leboucher 055c430e77 refactor(sync): Build device list updates separately from joined rooms 2026-11-15 20:24:36 +00:00
Erwan Leboucher df5e03f3b4 fix(sync): Apply the room and account data filters in legacy sync 2026-11-15 20:24:36 +00:00
Jade Ellis 6e7ebe66c9 docs: Fix changelog 2026-11-14 23:09:44 +00:00
Jade Ellis 24e962a656 chore: Release 2026-11-14 21:14:00 +00:00
Jade EllisandHenry-Hiles c5cd82a6a3 fix: SEC45
Co-authored-by: Henry-Hiles <henry@henryhiles.com>
2026-11-14 20:12:45 +00:00
theS1LV3R add66bd0b7 chore: Update resolvematrix to 1.4.2 2026-11-14 18:43:41 +00:00
theS1LV3R 700c11d758 docs: Disable even more llm stuff
fuck off LLM bullshit

ew x3
2026-11-14 14:36:46 +01:00
theS1LV3R 559f76908e docs: Disable webMcp
ew x2
2026-11-14 14:28:16 +01:00
theS1LV3R 7ade8c4899 docs: Disable LLM buttons in documentation
ew
2026-11-14 14:22:11 +01:00
timedout 20943c6210 docs: Explain everything that was mentioned in 1884 2026-11-14 13:03:16 +00:00
timedout 4811ad831d feat: Call out experiments and staleness in the config reference 2026-11-14 13:03:16 +00:00
Henry-Hiles bfb611d9e4 fix(config): Include experiments in the generated example config 2026-11-14 13:03:16 +00:00
timedout d4c6decdd6 feat: Theoretically add experiments to the config reference
For some reason it doesn't *actually* embed. I'm not too sure how the config generator works, so maybe im just missing something.
2026-11-14 13:03:16 +00:00
timedout 82e42696aa chore: Fix display for experiments 2026-11-14 13:03:16 +00:00
timedout f6c9b53e17 chore: Update reference config file 2026-11-14 13:03:16 +00:00
timedout 39035d735e refactor: Configuration-gate experiments 2026-11-14 13:03:16 +00:00
Niklas Wojtkowiak b34dfe343a docs(changelog): Add fragment for createRoom bad JSON fix 2026-11-14 00:22:45 -09:00
Niklas Wojtkowiak 26ec038418 fix(client): Return 400, not 500, for non-canonical createRoom 2026-11-14 00:20:01 -09:00
29 changed files with 729 additions and 203 deletions

No files matched your search

+1 -1
View File
@@ -43,7 +43,7 @@ jobs:
name: Renovate
runs-on: ubuntu-latest
container:
image: ghcr.io/renovatebot/renovate:44.227.4@sha256:e09d40686f73d43b2c1e4667cb47d3c1d24a6ac730b74ce7aced9c84f68594f1
image: ghcr.io/renovatebot/renovate:44.241.0@sha256:22d22b4ca7d768b5b469309d34379783bf91cd94a58faecf1cd0f4528a65d21c
options: --tmpfs /tmp:exec
steps:
- name: Checkout
+81
View File
@@ -1,3 +1,84 @@
# Continuwuity v26.11.0-alpha.2 (2026-11-14)
## Features
- Added opt-in OpenTelemetry metrics, exported over OTLP or scraped by Prometheus from `/_continuwuity/metrics`, and a Grafana dashboard. Contributed by @eleboucher. (prometheus-metrics)
- Add support for using custom DNS servers instead of using /etc/resolv.conf. Contributed by @s1lv3r. ([#2056](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2056))
- Continuwuity now supports configuring additional trusted audience values for deployments using OIDC with an IDP that sends them. Contributed by @ginger ([#2226](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2226))
- "!admin users list" now hides deactivated users by default, but can display them with the optional "--show-deactivated" flag. "--hide-suspended" and "--hide-locked" have been added as well, which stop suspended and locked users from being displayed respectively. Contributed by @Clubs. ([#2292](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2292))
- Added support for [MSC4494: Membership-based invite blocking](https://github.com/matrix-org/matrix-spec-proposals/pull/4494) ([#2297](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2297))
- Appservices now receive typing indicators and read receipts. Contributed by @Jade ([#2327](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2327))
- Added support for servers returning 410 gone to indicate they are no longer serving a Matrix server ([MSC4188](https://github.com/matrix-org/matrix-spec-proposals/pull/4188)). Contributed by @nex and @silversys ([#2355](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2355))
- Changed the policy on unstable features, disabling most by default and making them configurable in a tidy little `experiments` configuration. See also: #1884. ([#2517](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2517))
- Added support for [MSC4363](https://github.com/matrix-org/matrix-spec-proposals/pull/4363) (OAuth step-up authentication). Contributed by @ginger.
- Added support for [MSC2815](https://github.com/matrix-org/matrix-spec-proposals/pull/2815), allowing room moderators to fetch the original content of redacted events, behind the `allow_moderators_to_view_redacted_content` config option. Contributed by @eleboucher.
- Added support for [MSC4484](https://github.com/matrix-org/matrix-spec-proposals/pull/4484). Clients which use the built-in Matrix server administration APIs will need to ask for the appropriate scope when signing in with OAuth. Contributed by @ginger.
- Check content-type header on federation responses, ignoring any that don't match (spec compliance)
- Implemented unstable support for [MSC4560] (Stripped state requests over federation). Contributed by @ginger.
[MSC4560]: https://github.com/matrix-org/matrix-spec-proposals/pull/4560
- Profile banners are now treated as images when imported from OIDC claims, like avatars already were.
- Remove support for legacy, unauthenticated media, including the `allow_legacy_media` and `freeze_legacy_media` options.
- The first-run version of the web UI now includes a link to the registration page. Contributed by @ginger
## Bugfixes
- Fixed `/get_missing_events` rejecting requests with more `earliest_events` than the `limit`. Contributed by @eleboucher. (get-missing-events-earliest-limit)
- Invitees are now added as room creators when creating a v12+ trusted private chat. Contributed by @ginger. ([#2162](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2162))
- Fixed push gateway URLs containing the configured notification path outside of their suffix. Contributed by @eleboucher. ([#2261](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2261))
- "!admin users change-email" now verifies a user exists before attempting to change their email. Contributed by @Clubs. ([#2298](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2298))
- Fixed URL preview image MIME types and rejected failed downloads. Contributed by @eleboucher. ([#2308](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2308))
- Correctly set RocksDB column options, including enabling block caches. Contributed by @Jade ([#2345](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2345))
- Fix some possible deadlocks/freezes and reduce lock contention (improving performance). Contributed by @Jade ([#2351](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2351))
- Once again fixed how room extremities are handled, fixing a problem that made continuwuity gradually make rooms needlessly complex, which also caused more frequent state resets. ([#2356](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2356))
- The OAuth identity reset page is no longer linked from the account management UI to reduce confusion. Contributed by @ginger. ([#2383](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2383))
- Fixed a worker panic when knocking on a room over federation. Contributed by @eleboucher. ([#2387](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2387))
- Perform more validation on events received during atomic gapfill from remote servers, fixing a panic if bad data was persisted by another server and later lazily fetched by us. ([#2400](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2400))
- Redirect URIs in OAuth clients' metadata are now properly validated to be on a subdomain of the OAuth issuer URL domain. Contributed by @ginger. ([#2421](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2421))
- Fix v12 rooms created by the same user in the same millisecond ending up as the same room. Contributed by @eleboucher. ([#2424](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2424))
- Client-server API endpoints are now properly ratelimited for unauthenticated requests. Contributed by @ginger. ([#2444](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2444))
- Setting a profile key longer than 255 bytes now returns 400 `M_KEY_TOO_LARGE` as required by the spec, instead of 413 `M_TOO_LARGE`. ([#2451](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2451))
- Setting `m.fully_read` via the account data endpoints now returns 405 `M_BAD_JSON` as required by the spec, instead of 400. ([#2451](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2451))
- Appservices masquerading as a device that does not exist now receive 400 `M_UNKNOWN_DEVICE` as required by the spec, instead of 403 `M_FORBIDDEN`. ([#2451](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2451))
- Setting profile data that would make the profile exceed 64 KiB now returns 400 `M_PROFILE_TOO_LARGE` as required by the spec, instead of a 500 error. ([#2451](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2451))
- The `m.forget_forced_upon_leave` capability now reflects the `forget_forced_upon_leave` config option instead of always being advertised as enabled. ([#2452](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2452))
- Fixed push notifications for membership events setting `user_is_target` based on the sender rather than the user being notified. ([#2454](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2454))
- Ensure HTTP clients actually follow the `dns_servers` config option. Contributed by @silversys ([#2460](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2460))
- Reworked event relations to follow the spec more closely. Pagination of `/relations` now returns the correct pages and `next_batch` tokens, recursive relations are returned in the right order without duplicates, and bundled `m.reference` aggregations now include every reference. Contributed by @Henry-Hiles (QuadRadical). ([#2465](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2465))
- Read receipts are now more spec compliant, will work better in threads and are less likely to end up causing loops with other software. Contributed by @Jade ([#2481](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2481))
- Fix the DNS resolver failing to start without `/etc/resolv.conf` when `dns_servers` is configured. Contributed by @eleboucher. ([#2495](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2495))
- Fixed OIDC logins failing after the identity provider rotates its signing keys. Contributed by @eleboucher. ([#2497](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2497))
- Creating a room with valid but non-canonical JSON now returns `400 M_BAD_JSON` instead of panicking the worker and returning `500 M_UNKNOWN`.
- Fix account data updates sent at the same time leaving old copies behind, which every initial sync then returned. Existing copies are removed on startup. Contributed by @eleboucher.
- Fix gap filling skipping outlier events that are missing their previous events. Contributed by @eleboucher.
- Fix incoming federation events losing state changes when predecessors share the same state-before snapshot. Contributed by @eleboucher.
- Fix new devices sometimes never reaching other users' device lists. Contributed by @eleboucher.
- Fix state resolution applying events out of order, which could undo room joins. Contributed by @eleboucher.
- Fix to-device messages, including room keys, sometimes being lost before delivery. Contributed by @eleboucher.
- For deployments using OIDC with `profile_key_import_mode` set to `on_login`, users' avatars will no longer be clobbered if they didn't change their avatar since their last login.
- Joining a local room the user is not allowed to join now returns `403 M_FORBIDDEN` instead of `500 M_UNKNOWN` when there are no other servers to try.
- Room summary visibility checks are no longer incorrectly applied for remote rooms. Contributed by @ginger.
- The userinfo endpoint is now accessible even if federation is disabled, allowing LiveKit to be used on servers with federation disabled without using the server name whitelist.
- `!admin token issue` can no longer issue registration tokens when `allow_registration` is false. Contributed by @Clubs.
## Improved Documentation
- Add the Authentication section to document available auth methods for Continuwuity. The "delegated authentication" guide has also been migrated to here. Contributed by @stratself. ([#2234](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2234))
- Add a guide for push notifications, detailing how it works, push gateway specifics, troubleshooting common issues, and pointing to external guides for UnifiedPush backends. Contributed by @stratself ([#2244](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2244))
- The deploying page now includes vital general information about installing Continuwuity: release tracks, update steps, and post-installation recommendations. Contributed by @stratself ([#2252](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2252))
- Add some missing instructions on configuring Continuwuity on the RPM page. Users are encouraged to use the [generic deploying docs](https://continuwuity.org/deploying/generic) for the bulk of guidance anyhow. Contributed by @stratself ([#2275](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2275))
- Better, more succinct [introduction page](https://continuwuity.org/introduction.html). Contributed by @stratself ([#2279](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2279))
- Add a section on [troubleshooting Docker issues](https://continuwuity.org/troubleshooting#docker-issues). Contributed by @stratself. ([#2324](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2324))
- Instructions for Authelia added to the [OIDC guide](https://continuwuity.org/authentication/oidc.html). Contributed by @fhoekstra ([#2341](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2341))
- Docker compose examples now use bind mounts by default, instead of Docker volumes, as they are easier to work with esp. for backup/restore. Contributed by @stratself. ([#2353](https://forgejo.ellis.link/continuwuation/continuwuity/pulls/2353))
- The documentation now refers to the Continuwuity Docker service as `continuwuity` instead of `homeserver`.
## Misc
- Updated internal Sentry integration setup to the new pattern required by the SDK. #2423
- Upgraded rocksdb from 11.1.1 to 11.12.0 and jemalloc to 5.4.0.
# Continuwuity v26.11.0-alpha.1 (2026-11-10)
## Features
Generated
+15 -14
View File
@@ -865,7 +865,7 @@ dependencies = [
[[package]]
name = "conduwuit"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"clap",
"conduwuit_build_metadata",
@@ -897,7 +897,7 @@ dependencies = [
[[package]]
name = "conduwuit_admin"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"clap",
"conduwuit_api",
@@ -921,7 +921,7 @@ dependencies = [
[[package]]
name = "conduwuit_api"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"axum",
"base64 0.23.1",
@@ -949,11 +949,12 @@ dependencies = [
"sha1 0.11.0",
"tokio",
"tracing",
"wildmatch",
]
[[package]]
name = "conduwuit_build_metadata"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"built",
"cargo_metadata",
@@ -961,7 +962,7 @@ dependencies = [
[[package]]
name = "conduwuit_core"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"argon2",
"arrayvec",
@@ -1031,7 +1032,7 @@ dependencies = [
[[package]]
name = "conduwuit_database"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"async-channel",
"conduwuit_core",
@@ -1051,7 +1052,7 @@ dependencies = [
[[package]]
name = "conduwuit_macros"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"itertools 0.15.0",
"proc-macro2",
@@ -1061,7 +1062,7 @@ dependencies = [
[[package]]
name = "conduwuit_router"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"axum",
"axum-server",
@@ -1094,7 +1095,7 @@ dependencies = [
[[package]]
name = "conduwuit_service"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"askama",
"assign",
@@ -1150,7 +1151,7 @@ dependencies = [
[[package]]
name = "conduwuit_web"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"askama",
"async-trait",
@@ -4897,9 +4898,9 @@ checksum = "1e061d1b48cb8d38042de4ae0a7a6401009d6143dc80d2e2d6f31f0bdd6470c7"
[[package]]
name = "resolvematrix"
version = "1.4.1"
version = "1.4.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "565260441c783e26272b2d879525e80e97552e851fffa723cb0cfe0a3c46df92"
checksum = "d6e659fe17ed82acfac43641d00d1bbfd0a9d53ec4d2f901b01f792f0e2c9e3c"
dependencies = [
"hickory-resolver",
"num-traits",
@@ -5167,7 +5168,7 @@ dependencies = [
[[package]]
name = "ruminuwuity"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"assign",
"http",
@@ -7351,7 +7352,7 @@ dependencies = [
[[package]]
name = "xtask"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
dependencies = [
"askama",
"cargo_metadata",
+5 -2
View File
@@ -12,7 +12,7 @@ license = "Apache-2.0"
# See also `rust-toolchain.toml`
readme = "README.md"
repository = "https://forgejo.ellis.link/continuwuation/continuwuity"
version = "26.11.0-alpha.1"
version = "26.11.0-alpha.2"
[workspace.metadata.crane]
name = "conduwuit"
@@ -272,6 +272,9 @@ version = "0.5.2"
[workspace.dependencies.libloading]
version = "0.9.0"
[workspace.dependencies.wildmatch]
version = "2.7.0"
# Validating urls in config, was already a transitive dependency
[workspace.dependencies.url]
version = "2.5.8"
@@ -600,7 +603,7 @@ features = ["std"]
version = "0.3.0"
[workspace.dependencies.resolvematrix]
version = "1.4.1"
version = "1.4.2"
features = ["unstable-msc4188"]
[workspace.dependencies.serde_urlencoded]
@@ -0,0 +1 @@
Creating a room with valid but non-canonical JSON now returns `400 M_BAD_JSON` instead of panicking the worker and returning `500 M_UNKNOWN`.
+1
View File
@@ -0,0 +1 @@
Legacy `/sync` now honours the `room.rooms`, `room.not_rooms`, `account_data.types` and `account_data.not_types` filter fields instead of returning every room and all account data. Contributed by @eleboucher.
+1
View File
@@ -0,0 +1 @@
Changed the policy on unstable features, disabling most by default and making them configurable in a tidy little `experiments` configuration. See also: #1884.
+103 -26
View File
@@ -1657,32 +1657,6 @@
# env: CONTINUWUITY_ALLOW_INCOMING_TYPING
#allow_incoming_typing = true
# Allow the use of unstable persistent "sticky events" ([MSC4354])
#
# MSC4354: https://c10y.cc/MSC4354
#
# env: CONTINUWUITY_ALLOW_STICKY_EVENTS
#allow_sticky_events = false
# Allow room moderators to view redacted event content ([MSC2815]).
#
# Redacted content is readable by users at or above the room's `redact`
# power level, and by server admins, until it expires.
#
# MSC2815: https://github.com/matrix-org/matrix-spec-proposals/pull/2815
#
# env: CONTINUWUITY_ALLOW_MODERATORS_TO_VIEW_REDACTED_CONTENT
#allow_moderators_to_view_redacted_content = false
# How long to retain the content of redacted events, in seconds. Expired
# content is deleted by a periodic purge and is no longer served.
#
# Only has an effect when allow_moderators_to_view_redacted_content is
# enabled.
#
# env: CONTINUWUITY_UNREDACTED_CONTENT_MAX_AGE_SECS
#unredacted_content_max_age_secs = 7776000 (90 days)
# Maximum time federation user can indicate typing.
#
# env: CONTINUWUITY_TYPING_FEDERATION_TIMEOUT_S
@@ -2683,3 +2657,106 @@
#
# env: CONTINUWUITY_OAUTH__OIDC__PROFILE_KEY_IMPORT_MODE
#profile_key_import_mode = "on_registration"
[global.experiments]
# Continuwuity's experimental features are frequently updated.
# If you got this configuration via a package manager, chances are it's outdated.
# Check out the configuration reference online to see a fresh version:
# https://continuwuity.org/reference/config.html#:~:text=global.experiments
#
# Please keep in mind that experiments are used to enable unstable features.
# You probably don't need to enable any of these unless you know what they are,
# and consequently know why you should enable them.
# MSC4155: Invite filtering
#
# Provides advanced invite filtering rules for users, allowing complex
# configurations that can allow, ignore, and reject invites from users and
# servers broadly.
#
# Requires a supporting client to set up on an account.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/4155
#
# env: CONTINUWUITY_EXPERIMENTS__MSC4155
#msc4155 = false
# MSC4174: Web push
#
# Adds server-side support for web push, allowing web clients to receive
# push notifications directly without the need for an intermediary push
# gateway like Sygnal.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/4174
#
# env: CONTINUWUITY_EXPERIMENTS__MSC4174
#msc4174 = false
# MSC4484: Server Administration OAuth Scope
#
# Adds a new OAuth2 scope that explicitly grants a token temporary
# homeserver administrator privileges, granting temporary token access
# to administrator endpoints like locking & suspension.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/4484
#
# env: CONTINUWUITY_EXPERIMENTS__MSC4484
#msc4484 = false
# MSC4494: Membership-based invite blocking
#
# Adds a new invite blocking action that will reject all invites coming
# from users who do not share a room with the invitee that is not `public`
# (the join rule).
#
# This is not related to MSC4155, this proposal instead builds on the
# "invite blocking" proposal that landed in the specification in v1.17,
# which simply allows enabling or disabling invites altogether.
#
# MSC4494 is a good middle-ground between the allowlisting possible with
# MSC4155, and the general desire to block invites from users you may not
# know.
#
# Requires a supporting client to enable on an account.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/4494
#
# env: CONTINUWUITY_EXPERIMENTS__MSC4494
#msc4494 = false
# MSC4560: Stripped state requests over federation
#
# Implements a more efficient way for servers to acquire and serve
# "stripped state" to clients, which is typically only used for displaying
# rooms. The display of space hierarchies and room summaries is
# significantly faster when this proposal is enabled and used.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/4560
#
# env: CONTINUWUITY_EXPERIMENTS__MSC4560
#msc4560 = false
#[global.experiments.msc2815]
# MSC2815: Proposal to allow room moderators to view redacted event content
#
# Allows the server to retain unredacted copies of events that have been
# redacted for a limited period of time, which allows room moderators and
# server administrators to reveal redacted contents. Useful for moderation
# and investigating reports.
#
# Requires a supporting client to use.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/2815
# Whether to enable MSC2815.
#
# env: CONTINUWUITY_EXPERIMENTS__MSC2815__ENABLED
#enabled = false
# How long, in seconds, to retain the original content of redacted
# events before it is permanently erased. Defaults to 90 days.
#
# env: CONTINUWUITY_EXPERIMENTS__MSC2815__UNREDACTED_CONTENT_MAX_AGE_SECS
#unredacted_content_max_age_secs = 7776000
+105
View File
@@ -0,0 +1,105 @@
# Unstable features policy
Like several other homeservers in the Matrix ecosystem, Continuwuity adopts a "disable by default"
approach to experimental features. This ensures every deployment gets the same baseline stability,
allowing users to opt in to potentially unstable features.
Historically, Continuwuity used maintainer discretion to decide whether an unstable feature should
be enabled by default. However, as the project has grown, and the pace of spec development has
increased, keeping up with unstable proposals becomes less and less feasible by the day, and this
causes the implementation of unstable proposals to gradually drift. This can lead to implementations
becoming so stale they're incompatible, with no bandwidth to get them fixed up.
Continuwuity is already selective about which unstable features it implements: the maintainer team
typically only accept implementations of proposals that seem like they are a net positive for a
large portion of the Matrix ecosystem, rather than aiming to "implement everything". As such, the
unstable feature list should typically be small and manageable.
**All** unstable proposals require an experiment before their implementation can be accepted.
Likewise, all experiments should default to being disabled, requiring explicit configuration to
enable.
**Draft proposals** will not be merged until their proposal is undrafted. Likewise, the pull request
that implements the draft proposal should itself be marked "WIP", to avoid being merged or
prioritised for review. Review is still possible for WIP PRs, so feel free to request a round of
feedback.
## Adding an unstable feature
First, navigate to `src/core/config/experiments.rs`. There, you have two options for adding an
experiment to the `Experiments` struct:
1. Use `SimpleExperiment` if the experiment only requires enabling with no further configuration.
2. Define a new struct that implements the `ToggledExperiment` trait.
All experiments must be optional and default to off (i.e. `is_enabled()` returns `false`).
`SimpleExperiment` is actually a wrapper around `Option<bool>`, and the omission of the
configuration OR setting it to `false` disables the experiment. `ToggledExperiment` impls should
copy similar behaviour.
Then, add a public field to the `Experiments` struct that is named the MSC's ID in lowercase.
Add a docstring to it, starting with the proposal title (including ID), then a brief paragraph or
so explaining what the proposal does in simple terms, and then finally end the docstring with a link
to the proposal.
### Advertising support for unstable features
If the proposal requires advertising an unstable feature flag, that flag must be added to
`unstable_features` in `src/core/matrix/versions.rs`. For example:
```diff
pub fn unstable_features(experiments: &Experiments) -> BTreeMap<String, bool> {
BTreeMap::from_iter([
// Always enabled feature (https://github.com/matrix-org/matrix-spec-proposals/pull/0000)
// Expected for spec v1.20
("org.matrix.msc0000".to_owned(), true),
+ // MSC9999: My Cool Feature (https://github.com/matrix-org/matrix-spec-proposals/pull/9999)
+ ("example.matrix.msc9999".to_owned(), experiments.msc9999.is_enabled())
])
}
```
This will allow the `/_matrix/client/versions` endpoint to dynamically advertise whether the unstable
feature is enabled on the current server.
## Removing unstable features
If a proposal is abandoned, becomes obsolete, or is accepted into the specification, the unstable
configuration should be removed (and possibly migrated) as soon as possible.
After removing a field from `experiments`, the key should be added to the `DEPRECATED_KEYS` slice in
`src/core/config/mod.rs` (really far down). This will ensure that a warning is printed on startup
when a configuration is using a now-removed config key. For example:
```diff
pub struct Experiments {
- pub msc9999: SimpleExperiment,
}
```
```diff
const DEPRECATED_KEYS: &[&str] = [
"foo",
+ "experiments.msc9999",
];
```
## Always-on experiments
Some experiments can be forcefully enabled (i.e. always-on), or enabled by default. This should only
be the case in exceptional circumstances, and must be adequately well documented. Some examples of
situations that may warrant an experiment being always-enabled:
* A proposal was implemented AFTER it was merged, but BEFORE it had a merged spec PR.
These proposals are typically as stable as they'll get, as major changes post-factum of an MSC
merge requires another MSC, so only minor changes can be made in the spec PR phase.
* The daily experience of users would be at a great detriment without the experiment being enabled.
* A proposal is so simple that making it opt-in would be pointless. This is *incredibly* rare.
The latter two require explicit maintainer approval, so discuss those with the maintainer team
first. You can exercise your own judgement for the first.
Always-on or enabled-by-default experiments must explain in detail why they're exempt from the
standard experiments policy via comments in surrounding areas, like
`src/core/config/experiments.rs` and `src/core/matrix/versions.rs`. Ideally, these features are not
unstable for too long, so explaining a timescale for how long before the feature is stabilised is
also helpful.
+3
View File
@@ -11,6 +11,7 @@ export default defineConfig({
light: '/assets/logo.svg',
dark: '/assets/logo.svg',
},
llms: false,
// Use `.no-zoom` class to disable image zooms
mediumZoom: {
selector: '.rspress-doc :not(.no-zoom *) > img',
@@ -40,7 +41,9 @@ export default defineConfig({
},
},
},
webMcp: false,
themeConfig: {
llmsUI: false,
socialLinks: [
{
icon: {
+1
View File
@@ -87,6 +87,7 @@ serde.workspace = true
sha1.workspace = true
tokio.workspace = true
tracing.workspace = true
wildmatch.workspace = true
[lints]
workspace = true
+8 -2
View File
@@ -121,7 +121,10 @@ pub(crate) async fn create_room_route(
// ID exactly matches this, and abort if it doesn't. Otherwise, we use it
// as the room ID itself.
let expect_room_id = {
let body_ref = body.json_body.as_ref().unwrap();
let body_ref = body
.json_body
.as_ref()
.ok_or_else(|| err!(Request(BadJson("Invalid JSON body"))))?;
if let Some(CanonicalJsonValue::String(room_id)) = body_ref
.get("fi.mau.room_id")
.or_else(|| body_ref.get("room_id"))
@@ -302,7 +305,10 @@ pub(crate) async fn create_room_route(
// Allow requesters to override the `origin_server_ts` to customize room ids
// from v12 onwards
let custom_origin_server_ts = {
let body_ref = body.json_body.as_ref().unwrap();
let body_ref = body
.json_body
.as_ref()
.ok_or_else(|| err!(Request(BadJson("Invalid JSON body"))))?;
body_ref
.get("origin_server_ts")
.or_else(|| body_ref.get("fi.mau.origin_server_ts"))
+7 -2
View File
@@ -1,5 +1,7 @@
use axum::extract::{Query, State};
use conduwuit::{Err, Error, Event, PduEvent, Result, debug_warn, err};
use conduwuit::{
Err, Error, Event, PduEvent, Result, config::experiments::ToggledExperiment, debug_warn, err,
};
use futures::TryFutureExt;
use http::StatusCode;
use ruma::{
@@ -68,7 +70,7 @@ pub(crate) async fn get_room_event_route(
return Err!(Request(Forbidden("You don't have permission to view this event.")));
}
if services.config.allow_moderators_to_view_redacted_content
if services.config.experiments.msc2815.is_enabled()
&& params.include_unredacted_content.unwrap_or(false)
&& event.is_redacted()
{
@@ -126,6 +128,9 @@ async fn unredact(services: &crate::State, sender_user: &UserId, event: &mut Pdu
// CustomErrorKind has private fields; only serde can build one.
let keep_ms = services
.config
.experiments
.msc2815
.expect("msc2815 config is disabled but unredact() attempted to access it anyway")
.unredacted_content_max_age_secs
.saturating_mul(1000);
+1 -6
View File
@@ -95,12 +95,7 @@ pub(crate) async fn send_message_event_route(
PartialPdu {
event_type: body.event_type.clone().into(),
content,
sticky: services
.config
.allow_sticky_events
.then_some(body.sticky_duration_ms)
.flatten()
.map(sticky::object),
sticky: body.sticky_duration_ms.map(sticky::object),
unsigned: Some(unsigned),
timestamp: if body.identity.is_appservice()
|| services.admin.user_is_admin(sender_user).await
+75 -56
View File
@@ -64,7 +64,7 @@ pub(super) async fn load_joined_room(
services: &Services,
sync_context: SyncContext<'_>,
ref room_id: OwnedRoomId,
) -> Result<(JoinedRoom, DeviceListUpdates)> {
) -> Result<JoinedRoom> {
/*
Building a sync response involves many steps which all depend on each other.
To parallelize the process as much as possible, each step is divided into its own function,
@@ -80,7 +80,6 @@ pub(super) async fn load_joined_room(
sticky,
summary,
notification_counts,
device_list_updates,
},
) = try_join3(
build_account_data(services, sync_context, room_id),
@@ -117,7 +116,7 @@ pub(super) async fn load_joined_room(
unread_thread_notifications: BTreeMap::new(),
});
Ok((joined_room, device_list_updates))
Ok(joined_room)
}
/// Collect changes to the syncing user's account data events.
@@ -263,7 +262,6 @@ struct StateAndTimeline {
sticky: Sticky,
summary: Option<RoomSummary>,
notification_counts: Option<UnreadNotificationsCount>,
device_list_updates: DeviceListUpdates,
}
async fn build_sticky_events(
@@ -273,10 +271,6 @@ async fn build_sticky_events(
timeline: &TimelinePdus,
joined_since_last_sync: bool,
) -> Sticky {
if !services.config.allow_sticky_events {
return Sticky::new();
}
let SyncContext {
syncing_user,
last_sync_end_count,
@@ -381,24 +375,14 @@ async fn build_state_and_timeline(
debug_warn!("timeline for newly joined room is empty");
}
let (summary, device_list_updates) = try_join(
build_room_summary(
services,
sync_context,
room_id,
shortstatehashes,
&timeline,
&state_events,
joined_since_last_sync,
),
build_device_list_updates(
services,
sync_context,
room_id,
shortstatehashes,
&state_events,
joined_since_last_sync,
),
let summary = build_room_summary(
services,
sync_context,
room_id,
shortstatehashes,
&timeline,
&state_events,
joined_since_last_sync,
)
.await?;
@@ -434,7 +418,6 @@ async fn build_state_and_timeline(
sticky,
summary,
notification_counts,
device_list_updates,
})
}
@@ -858,35 +841,34 @@ async fn build_heroes(
.await
}
/// Collect updates to users' device lists for E2EE.
#[tracing::instrument(level = "debug", skip_all)]
async fn build_device_list_updates(
/// Collect updates to users' device lists for E2EE in a joined room.
#[tracing::instrument(level = "debug", skip_all, fields(%room_id))]
pub(super) async fn load_device_list_updates(
services: &Services,
SyncContext {
sync_context: SyncContext<'_>,
room_id: &RoomId,
) -> Result<DeviceListUpdates> {
let SyncContext {
syncing_user,
last_sync_end_count,
current_count,
..
}: SyncContext<'_>,
room_id: &RoomId,
ShortStateHashes { current_shortstatehash, .. }: ShortStateHashes,
state_events: &Vec<PduEvent>,
joined_since_last_sync: bool,
) -> Result<DeviceListUpdates> {
let is_encrypted_room = services
.rooms
.state_accessor
.state_get(current_shortstatehash, &StateEventType::RoomEncryption, "")
.is_ok();
} = sync_context;
let mut device_list_updates = DeviceListUpdates::new();
// initial syncs don't include device updates, and rooms which aren't
// encrypted don't affect them, so return early in either of those cases
if last_sync_end_count.is_none() || !(is_encrypted_room.await) {
return Ok(DeviceListUpdates::new());
if last_sync_end_count.is_none()
|| !services
.rooms
.state_accessor
.is_encrypted_room(room_id)
.await
{
return Ok(device_list_updates);
}
let mut device_list_updates = DeviceListUpdates::new();
// add users with changed keys to the `changed` list
services
.users
@@ -897,19 +879,56 @@ async fn build_device_list_updates(
})
.await;
// add users who now share encrypted rooms to `changed` and
// users who no longer share encrypted rooms to `left`
for state_event in state_events {
if state_event.kind == RoomMember {
let Some(content): Option<RoomMemberEventContent> = state_event.get_content().ok()
let shortstatehashes = fetch_shortstatehashes(services, sync_context, room_id).await?;
let ShortStateHashes {
current_shortstatehash,
last_sync_end_shortstatehash,
} = shortstatehashes;
if check_joined_since_last_sync(services, shortstatehashes, sync_context).await? {
// the syncing user now shares an encrypted room with every member
services
.rooms
.state_cache
.room_members(room_id)
.ready_for_each(|user_id| {
device_list_updates.changed.insert(user_id);
})
.await;
} else if let Some(last_sync_end_shortstatehash) = last_sync_end_shortstatehash
&& last_sync_end_shortstatehash != current_shortstatehash
{
// add users who now share encrypted rooms to `changed` and
// users who no longer share encrypted rooms to `left`
let state_added = services
.rooms
.state_accessor
.state_added((last_sync_end_shortstatehash, current_shortstatehash))
.await?;
for (shortstatekey, _) in state_added {
let Ok((StateEventType::RoomMember, state_key)) = services
.rooms
.short
.get_statekey_from_short(shortstatekey)
.await
else {
continue;
};
let Some(user_id): Option<OwnedUserId> = state_event
.state_key
.as_ref()
.and_then(|key| key.parse().ok())
let Ok(user_id) = OwnedUserId::try_from(state_key.as_str()) else {
continue;
};
let Ok(content): Result<RoomMemberEventContent> = services
.rooms
.state_accessor
.state_get_content(
current_shortstatehash,
&StateEventType::RoomMember,
user_id.as_str(),
)
.await
else {
continue;
};
@@ -925,7 +944,7 @@ async fn build_device_list_updates(
| Leave if !shares_encrypted_room => {
device_list_updates.left.insert(user_id);
},
| Join if joined_since_last_sync || shares_encrypted_room => {
| Join if shares_encrypted_room => {
device_list_updates.changed.insert(user_id);
},
| _ => (),
+102 -14
View File
@@ -21,7 +21,7 @@ use futures::{FutureExt, StreamExt, TryFutureExt, future::OptionFuture};
use ruma::{
DeviceId, OwnedUserId, RoomId, UserId,
api::client::{
filter::FilterDefinition,
filter::{self, FilterDefinition, RoomFilter},
sync::sync_events::{
self, DeviceLists,
v3::{
@@ -39,13 +39,17 @@ use service::{
account_data::AnyRawAccountDataEvent,
rooms::lazy_loading::{self, MemberSet, Options as _},
};
use wildmatch::WildMatch;
use super::{load_timeline, share_encrypted_room};
use crate::{
Ruma,
client::{
is_ignored_invite,
sync::v3::{joined::load_joined_room, left::load_left_room},
sync::v3::{
joined::{load_device_list_updates, load_joined_room},
left::load_left_room,
},
},
client_ip::ClientIp,
};
@@ -271,34 +275,47 @@ pub(crate) async fn build_sync_events(
.rooms
.state_cache
.rooms_joined(syncing_user)
.ready_filter(|room_id| room_selected(&filter.room, room_id))
.broad_filter_map(|room_id| async {
let joined_room = load_joined_room(services, context, room_id.clone()).await;
match joined_room {
| Ok((room, updates)) => Some((room_id, room, updates)),
| Ok(room) => Some((room_id, room)),
| Err(err) => {
error!(?err, %room_id, "error loading joined room");
None
},
}
})
.ready_fold(
(BTreeMap::new(), DeviceListUpdates::new()),
|(mut joined_rooms, mut all_updates), (room_id, joined_room, updates)| {
all_updates.merge(updates);
.ready_fold(BTreeMap::new(), |mut joined_rooms, (room_id, joined_room)| {
if !joined_room.is_empty() {
joined_rooms.insert(room_id, joined_room);
}
if !joined_room.is_empty() {
joined_rooms.insert(room_id, joined_room);
}
joined_rooms
});
(joined_rooms, all_updates)
},
);
// a filtered out room still contributes its device list updates
let device_list_updates = services
.rooms
.state_cache
.rooms_joined(syncing_user)
.broad_filter_map(|room_id| async move {
load_device_list_updates(services, context, &room_id)
.await
.inspect_err(|err| error!(?err, %room_id, "error loading device list updates"))
.ok()
})
.ready_fold(DeviceListUpdates::new(), |mut all_updates, updates| {
all_updates.merge(updates);
all_updates
});
let left_rooms = services
.rooms
.state_cache
.rooms_left(syncing_user)
.ready_filter(|(room_id, _)| room_selected(&filter.room, room_id))
.broad_filter_map(|(room_id, leave_pdu)| async {
let left_room = load_left_room(services, context, room_id.clone(), leave_pdu).await;
@@ -317,6 +334,7 @@ pub(crate) async fn build_sync_events(
.rooms
.state_cache
.rooms_invited(syncing_user)
.ready_filter(|(room_id, _)| room_selected(&filter.room, room_id))
.wide_filter_map(async |(room_id, invite_state)| {
if is_ignored_invite(services, syncing_user, &room_id).await {
None
@@ -347,6 +365,7 @@ pub(crate) async fn build_sync_events(
.rooms
.state_cache
.rooms_knocked(syncing_user)
.ready_filter(|(room_id, _)| room_selected(&filter.room, room_id))
.fold_default(|mut knocked_rooms: BTreeMap<_, _>, (room_id, knock_state)| async move {
let knock_count = services
.rooms
@@ -376,6 +395,13 @@ pub(crate) async fn build_sync_events(
.account_data
.changes_since(None, syncing_user, last_sync_end_count, Some(current_count))
.ready_filter_map(|e| extract_variant!(e, AnyRawAccountDataEvent::Global))
.ready_filter(|event| {
event
.get_field::<String>("type")
.ok()
.flatten()
.is_some_and(|event_type| type_selected(&filter.account_data, &event_type))
})
.collect();
let to_device_events = services
@@ -404,7 +430,8 @@ pub(crate) async fn build_sync_events(
.list_unused_fallback_key_types(syncing_user, syncing_device);
let (
(joined_rooms, mut device_list_updates),
joined_rooms,
mut device_list_updates,
left_rooms,
invited_rooms,
knocked_rooms,
@@ -417,6 +444,7 @@ pub(crate) async fn build_sync_events(
) = async {
futures::join!(
joined_rooms,
device_list_updates,
left_rooms,
invited_rooms,
knocked_rooms,
@@ -465,6 +493,24 @@ pub(crate) async fn build_sync_events(
Ok(response)
}
fn room_selected(filter: &RoomFilter, room_id: &RoomId) -> bool {
!filter.not_rooms.iter().any(|not_room| not_room == room_id)
&& filter
.rooms
.as_ref()
.is_none_or(|rooms| rooms.iter().any(|room| room == room_id))
}
fn type_selected(filter: &filter::Filter, event_type: &str) -> bool {
let matches = |pattern: &String| WildMatch::new(pattern).matches(event_type);
!filter.not_types.iter().any(matches)
&& filter
.types
.as_ref()
.is_none_or(|types| types.iter().any(matches))
}
#[tracing::instrument(name = "presence", level = "debug", skip_all)]
async fn process_presence_updates(
services: &Services,
@@ -528,3 +574,45 @@ async fn prepare_lazily_loaded_members(
lazily_loaded_members
}
#[cfg(test)]
mod tests {
use ruma::{owned_room_id, room_id};
use super::*;
#[test]
fn rooms_filter_selects_rooms() {
let room_id = room_id!("!a:example.com");
let mut filter = RoomFilter::default();
assert!(room_selected(&filter, room_id));
filter.rooms = Some(Vec::new());
assert!(!room_selected(&filter, room_id));
filter.rooms = Some(vec![room_id.to_owned()]);
assert!(room_selected(&filter, room_id));
filter.not_rooms = vec![owned_room_id!("!a:example.com")];
assert!(!room_selected(&filter, room_id));
}
#[test]
fn types_filter_selects_account_data() {
let mut filter = filter::Filter::default();
assert!(type_selected(&filter, "m.direct"));
filter.types = Some(Vec::new());
assert!(!type_selected(&filter, "m.direct"));
filter.types = Some(vec!["m.direct".to_owned()]);
assert!(type_selected(&filter, "m.direct"));
filter.types = Some(vec!["m.*".to_owned()]);
assert!(type_selected(&filter, "m.direct"));
assert!(!type_selected(&filter, "im.ponies.user_emotes"));
filter.not_types = vec!["m.direct".to_owned()];
assert!(!type_selected(&filter, "m.direct"));
}
}
+1 -1
View File
@@ -1123,7 +1123,7 @@ async fn collect_sticky_events(
let mut delivered = StickyDelivered::new();
let sticky_events = &body.extensions.sticky_events;
if !services.config.allow_sticky_events || !sticky_events.enabled.unwrap_or(false) {
if !sticky_events.enabled.unwrap_or(false) {
return (response, delivered);
}
+1 -11
View File
@@ -27,17 +27,7 @@ pub(crate) async fn get_supported_versions_route(
State(services): State<crate::State>,
_body: Ruma<get_supported_versions::Request>,
) -> Result<get_supported_versions::Response> {
let mut unstable_features = unstable_features();
if services.config.allow_sticky_events {
// sticky events (https://github.com/matrix-org/matrix-spec-proposals/pull/4354)
unstable_features.insert("org.matrix.msc4354".to_owned(), true);
}
if services.config.allow_moderators_to_view_redacted_content {
// moderators can view redacted content (https://github.com/matrix-org/matrix-spec-proposals/pull/2815)
unstable_features.insert("fi.mau.msc2815".to_owned(), true);
}
let unstable_features = unstable_features(&services.config.experiments);
Ok(assign!(get_supported_versions::Response::new(versions()), {
unstable_features
+156
View File
@@ -0,0 +1,156 @@
use conduwuit_macros::config_example_generator;
use serde::Deserialize;
/// Configuration for experimental features.
#[derive(Debug, Deserialize, Default, Clone)]
#[config_example_generator(
filename = "conduwuit-example.toml",
section = "global.experiments",
subheader = r##"# Continuwuity's experimental features are frequently updated.
# If you got this configuration via a package manager, chances are it's outdated.
# Check out the configuration reference online to see a fresh version:
# https://continuwuity.org/reference/config.html#:~:text=global.experiments
#
# Please keep in mind that experiments are used to enable unstable features.
# You probably don't need to enable any of these unless you know what they are,
# and consequently know why you should enable them."##
)]
pub struct Experiments {
/// MSC2815: Proposal to allow room moderators to view redacted event
/// content
///
/// See [`MSC2815`] for details.
///
/// display: nested
#[serde(default)]
pub msc2815: Option<MSC2815>,
/// MSC4155: Invite filtering
///
/// Provides advanced invite filtering rules for users, allowing complex
/// configurations that can allow, ignore, and reject invites from users and
/// servers broadly.
///
/// Requires a supporting client to set up on an account.
///
/// https://github.com/matrix-org/matrix-spec-proposals/pull/4155
///
/// default: false
#[serde(default)]
pub msc4155: SimpleExperiment,
/// MSC4174: Web push
///
/// Adds server-side support for web push, allowing web clients to receive
/// push notifications directly without the need for an intermediary push
/// gateway like Sygnal.
///
/// https://github.com/matrix-org/matrix-spec-proposals/pull/4174
///
/// default: false
#[serde(default)]
pub msc4174: SimpleExperiment,
/// MSC4484: Server Administration OAuth Scope
///
/// Adds a new OAuth2 scope that explicitly grants a token temporary
/// homeserver administrator privileges, granting temporary token access
/// to administrator endpoints like locking & suspension.
///
/// https://github.com/matrix-org/matrix-spec-proposals/pull/4484
///
/// default: false
#[serde(default)]
pub msc4484: SimpleExperiment,
/// MSC4494: Membership-based invite blocking
///
/// Adds a new invite blocking action that will reject all invites coming
/// from users who do not share a room with the invitee that is not `public`
/// (the join rule).
///
/// This is not related to MSC4155, this proposal instead builds on the
/// "invite blocking" proposal that landed in the specification in v1.17,
/// which simply allows enabling or disabling invites altogether.
///
/// MSC4494 is a good middle-ground between the allowlisting possible with
/// MSC4155, and the general desire to block invites from users you may not
/// know.
///
/// Requires a supporting client to enable on an account.
///
/// https://github.com/matrix-org/matrix-spec-proposals/pull/4494
///
/// default: false
#[serde(default)]
pub msc4494: SimpleExperiment,
/// MSC4560: Stripped state requests over federation
///
/// Implements a more efficient way for servers to acquire and serve
/// "stripped state" to clients, which is typically only used for displaying
/// rooms. The display of space hierarchies and room summaries is
/// significantly faster when this proposal is enabled and used.
///
/// https://github.com/matrix-org/matrix-spec-proposals/pull/4560
///
/// default: false
#[serde(default)]
pub msc4560: SimpleExperiment,
}
/// Represents a "simple" experiment, which is either disabled or enabled.
///
/// More complex experiments that require configuration should define their own
/// type and implement `ToggledExperiment` instead.
#[derive(Debug, Deserialize, Default, Clone, Copy)]
pub struct SimpleExperiment(Option<bool>);
pub trait ToggledExperiment {
/// Returns true if this experiment is explicitly enabled.
#[must_use]
fn is_enabled(&self) -> bool;
}
impl ToggledExperiment for SimpleExperiment {
#[inline]
fn is_enabled(&self) -> bool { self.0.is_some_and(crate::is_true!()) }
}
/// Configuration for [MSC2815]: Proposal to allow room moderators to view
/// redacted event content
///
/// MSC2815: https://github.com/matrix-org/matrix-spec-proposals/pull/2815
#[derive(Debug, Deserialize, Default, Clone, Copy)]
#[config_example_generator(
filename = "conduwuit-example.toml",
section = "global.experiments.msc2815",
optional = "true",
subheader = r#"# MSC2815: Proposal to allow room moderators to view redacted event content
#
# Allows the server to retain unredacted copies of events that have been
# redacted for a limited period of time, which allows room moderators and
# server administrators to reveal redacted contents. Useful for moderation
# and investigating reports.
#
# Requires a supporting client to use.
#
# https://github.com/matrix-org/matrix-spec-proposals/pull/2815"#
)]
pub struct MSC2815 {
/// Whether to enable MSC2815.
///
/// default: false
#[serde(default)]
pub enabled: bool,
/// How long, in seconds, to retain the original content of redacted
/// events before it is permanently erased. Defaults to 90 days.
///
/// default: 7776000
#[serde(default = "default_unredacted_content_max_age_secs")]
pub unredacted_content_max_age_secs: u64,
}
#[inline]
fn default_unredacted_content_max_age_secs() -> u64 { 7_776_000 }
impl ToggledExperiment for Option<MSC2815> {
#[inline]
fn is_enabled(&self) -> bool { self.is_some_and(|config| config.enabled) }
}
+16 -31
View File
@@ -18,6 +18,7 @@ use either::{
Either,
Either::{Left, Right},
};
pub use experiments::Experiments;
use figment::providers::{Env, Format, Toml};
pub use figment::{Figment, value::Value as FigmentValue};
use governor::{DefaultKeyedRateLimiter, Quota, RateLimiter};
@@ -1768,35 +1769,6 @@ pub struct Config {
#[serde(default = "true_fn")]
pub allow_incoming_typing: bool,
/// Allow the use of unstable persistent "sticky events" ([MSC4354])
///
/// MSC4354: https://c10y.cc/MSC4354
///
/// default: false
#[serde(default)]
pub allow_sticky_events: bool,
/// Allow room moderators to view redacted event content ([MSC2815]).
///
/// Redacted content is readable by users at or above the room's `redact`
/// power level, and by server admins, until it expires.
///
/// MSC2815: https://github.com/matrix-org/matrix-spec-proposals/pull/2815
///
/// default: false
#[serde(default)]
pub allow_moderators_to_view_redacted_content: bool,
/// How long to retain the content of redacted events, in seconds. Expired
/// content is deleted by a periodic purge and is no longer served.
///
/// Only has an effect when allow_moderators_to_view_redacted_content is
/// enabled.
///
/// default: 7776000 (90 days)
#[serde(default = "default_unredacted_content_max_age_secs")]
pub unredacted_content_max_age_secs: u64,
/// Maximum time federation user can indicate typing.
///
/// default: 30
@@ -2474,6 +2446,12 @@ pub struct Config {
#[serde(default)]
pub matrix_rtc: MatrixRtcConfig,
/// Configuration for unstable features.
///
/// display: nested
#[serde(default)]
pub experiments: Experiments,
#[serde(flatten)]
#[allow(clippy::zero_sized_map_values)]
// this is a catchall, the map shouldn't be zero at runtime
@@ -3007,6 +2985,9 @@ const DEPRECATED_KEYS: &[&str] = &[
"well_known_support_email",
"well_known_support_mxid",
"well_known.rtc_focus_server_urls",
"allow_sticky_events",
"allow_moderators_to_view_redacted_content",
"unredacted_content_max_age_secs",
];
impl Config {
@@ -3239,8 +3220,6 @@ fn default_remote_join_pdu_queue_capacity() -> usize { 50 }
fn default_transaction_id_cache_max_age_secs() -> u64 { 60 * 60 * 2 }
fn default_unredacted_content_max_age_secs() -> u64 { 60 * 60 * 24 * 90 }
fn default_transaction_id_cache_max_entries() -> usize { 8192 }
fn default_tracing_flame_filter() -> String {
@@ -3443,3 +3422,9 @@ fn default_profile_key_map() -> HashMap<String, String> {
fn default_unauthenticated_request_ratelimit<K: Hash + Eq + Clone>() -> PerMinuteRatelimiter<K> {
PerMinuteRatelimiter::new(Quota::per_minute(30.try_into().unwrap()))
}
// NOTE: This must be declared *after* every config struct in this file. The
// example config generator writes sections in macro expansion order, and the
// `global` section truncates the file, so declaring this module any earlier
// causes its sections to be wiped from the generated example config.
pub mod experiments;
+12 -16
View File
@@ -1,5 +1,7 @@
use std::collections::BTreeMap;
use crate::config::{Experiments, experiments::ToggledExperiment};
#[must_use]
pub fn versions() -> Vec<String> {
vec![
@@ -25,32 +27,26 @@ pub fn versions() -> Vec<String> {
"v1.16".to_owned(),
"v1.17".to_owned(),
"v1.18".to_owned(),
"v1.19".to_owned(),
]
}
#[must_use]
pub fn unstable_features() -> BTreeMap<String, bool> {
pub fn unstable_features(experiments: &Experiments) -> BTreeMap<String, bool> {
BTreeMap::from_iter([
// MatrixRTC (https://github.com/matrix-org/matrix-spec-proposals/pull/4143)
// Expected for spec v1.20
("org.matrix.msc4143".to_owned(), true),
// query mutual rooms (https://github.com/matrix-org/matrix-spec-proposals/pull/2666)
// Expected for spec v1.19
("uk.half-shot.msc2666.query_mutual_rooms".to_owned(), true),
("uk.half-shot.msc2666.query_mutual_rooms.stable".to_owned(), true),
// Simplified Sliding sync (https://github.com/matrix-org/matrix-spec-proposals/pull/4186)
// Expected for spec v1.19
// Expected for spec v1.20
("org.matrix.simplified_msc3575".to_owned(), true),
// invite filtering (https://github.com/matrix-org/matrix-spec-proposals/pull/4155)
("org.matrix.msc4155".to_owned(), true),
("org.matrix.msc4155".to_owned(), experiments.msc4155.is_enabled()),
// profile change propagation (https://github.com/matrix-org/matrix-spec-proposals/pull/4466)
("computer.gingershaped.msc4466".to_owned(), true),
// web push (https://github.com/matrix-org/matrix-spec-proposals/pull/4174)
("org.matrix.msc4174".to_owned(), true),
// Membership-based invite blocking (https://github.com/matrix-org/matrix-spec-proposals/pull/4494)
("uk.timedout.msc4494".to_owned(), true),
// server administration OAuth scope (https://github.com/matrix-org/matrix-spec-proposals/pull/4484)
("org.continuwuity.msc4484.unstable".to_owned(), true),
// stripped state over federation (https://github.com/matrix-org/matrix-spec-proposals/pull/4560)
("org.continuwuity.msc4560".to_owned(), true),
("org.matrix.msc4174".to_owned(), experiments.msc4174.is_enabled()),
("uk.timedout.msc4494".to_owned(), experiments.msc4494.is_enabled()),
("org.continuwuity.msc4484.unstable".to_owned(), experiments.msc4484.is_enabled()),
("org.continuwuity.msc4560".to_owned(), experiments.msc4560.is_enabled()),
("fi.mau.msc2815".to_owned(), experiments.msc2815.is_enabled()),
])
}
+1 -1
View File
@@ -25,7 +25,7 @@ http.workspace = true
ruma.workspace = true
serde = { workspace = true }
serde_json = { workspace = true }
wildmatch = "2.7.0"
wildmatch.workspace = true
[dev-dependencies]
+4 -2
View File
@@ -42,6 +42,8 @@ pub mod transactions;
pub mod uiaa;
pub mod users;
use std::collections::BTreeMap;
pub(crate) use service::{Args, Dep, Service};
pub use crate::services::Services;
@@ -51,8 +53,8 @@ conduwuit::mod_dtor! {}
use std::sync::LazyLock;
use conduwuit::matrix::versions::{unstable_features, versions};
use conduwuit::matrix::versions::versions;
use ruma::api::SupportedVersions;
pub static SUPPORTED_VERSIONS: LazyLock<SupportedVersions> =
LazyLock::new(|| SupportedVersions::from_parts(&versions(), &unstable_features()));
LazyLock::new(|| SupportedVersions::from_parts(&versions(), &BTreeMap::new()));
@@ -33,6 +33,16 @@ impl super::Service {
return Err!(Request(Forbidden("Redacting m.room.create is not safe, forbidding.")));
}
// Defense in depth, shouldn't be reachable
if redacting_event
.as_ref()
.is_ok_and(|pdu| pdu.room_id() != Some(room_id))
{
return Err!(Request(Forbidden(
"Cannot redact an event that belongs to a different room."
)));
}
if redacting_event
.as_ref()
.is_ok_and(|pdu| *pdu.kind() == TimelineEventType::RoomServerAcl)
+1 -3
View File
@@ -591,9 +591,7 @@ impl super::Service {
room_id: &RoomId,
) -> Option<OwnedServerName> {
let server = target_user_id.server_name();
if !self.services.config.allow_sticky_events
|| self.services.globals.server_is_ours(server)
{
if self.services.globals.server_is_ours(server) {
return None;
}
+1 -7
View File
@@ -48,13 +48,7 @@ impl super::Service {
PartialPdu {
event_type: event_type.to_string().into(),
content,
sticky: self
.services
.config
.allow_sticky_events
.then_some(sticky_duration_ms)
.flatten()
.map(sticky::object),
sticky: sticky_duration_ms.map(sticky::object),
state_key: Some(state_key.into()),
timestamp,
..Default::default()
+6 -1
View File
@@ -287,7 +287,12 @@ impl Service {
}
fn unredacted_content_cutoff(&self) -> u64 {
let max_age = self.services.config.unredacted_content_max_age_secs;
let max_age = self
.services
.config
.experiments
.msc2815
.map_or_default(|c| c.unredacted_content_max_age_secs);
utils::millis_since_unix_epoch().saturating_sub(max_age.saturating_mul(1000))
}
+9 -6
View File
@@ -1,5 +1,6 @@
use conduwuit::config::experiments::ToggledExperiment;
use conduwuit_core::{
Result, err,
Err, Result, err,
matrix::event::Event,
utils::{self},
warn,
@@ -32,6 +33,12 @@ impl super::Service {
err!(Database(error!(?pdu_id, %event_id, ?e, "PDU ID points to invalid PDU.")))
})?;
if pdu.room_id() != reason.room_id() {
return Err!(Request(Forbidden(
"Cannot redact an event that belongs to a different room."
)));
}
let thread_root = match pdu.get_content::<ExtractRelatesTo>() {
| Ok(ExtractRelatesTo { relates_to: Relation::Thread(thread) }) =>
Some(thread.event_id),
@@ -52,11 +59,7 @@ impl super::Service {
.get_room_version(&pdu.room_id_or_hash())
.await?;
if self
.services
.config
.allow_moderators_to_view_redacted_content
{
if self.services.config.experiments.msc2815.is_enabled() {
let mut pdu_json = self.get_pdu_json_from_id(&pdu_id).await?;
pdu_json.remove("event_id");
if content_hash(&pdu_json)
+1 -1
View File
@@ -327,7 +327,7 @@ impl Service {
/// still-sticky events. Only netburst delivers this queue, so with it
/// disabled there is nothing to keep the event for.
async fn survives_netburst_trim(&self, event: &SendingEvent) -> bool {
if !self.server.config.allow_sticky_events || !self.server.config.startup_netburst {
if !self.server.config.startup_netburst {
return false;
}