An federation whitelist query endpoint extension #16848

erikjohnston · 2024-01-24T13:02:28Z

This is to allow clients to query the configured federation whitelist. Disabled by default.

CLAassistant · 2024-04-16T23:49:22Z

All committers have signed the CLA.

anoadragon453

The logic looks correct! Just a few wording changes and a q about the config option placement.

I'll admit that introducing a new section for extensions still doesn't quite sit right with me.

anoadragon453 · 2024-05-07T10:41:10Z

synapse/config/extensions.py

+    section = "extensions"
+
+    def read_config(self, config: JsonDict, **kwargs: Any) -> None:
+        self.federation_whitelist_endpoint: bool = config.get(


Previously @erikjohnston noted that the "extension" config section was created as this option didn't fit in anywhere else.

But would it not fit under "federation"?

synapse/synapse/config/federation.py

Line 28 in 23740ea

class FederationConfig(Config):

It could be beneficial to follow the approach mentioned here: #17147 (comment)

ie. to move this to an in-tree-module and have the config follow the normal module config rules.

The approach mentioned in that PR was deemed undesirable for now.

But would it not fit under "federation"?

On this, @erikjohnston wrote on Matrix:

Yeah, maybe. I suppose the federation section is relatively small. I'm just thinking of what this will look like if we have e.g. 10 optional features like this, and whether we'd want them grouped together in one place in the docs or not
and whether its clearer in the code or not
I suppose we can cross that bridge when we come to it

I don't see this as an optional feature, more a config option like any other. And they won't end up all under federation of course, but spread across the config. I don't think they'll build up in any noticeable way as a group.

I agree. I'll move it under the federation section.

tests/rest/synapse/client/test_federation_whitelist.py

docs/usage/configuration/config_documentation.md

tests/rest/synapse/client/test_federation_whitelist.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

anoadragon453

This comment on the previous review is still a concern of mine, but everything else lgtm.

devonh · 2024-05-09T18:29:26Z

If you're happy with everything the way it is now, I'll merge it in 😄

anoadragon453

LGTM otherwise!

docs/usage/configuration/config_documentation.md

anoadragon453

There's a couple references to extension features left which should now be removed. Otherwise this LGTM!

synapse/rest/synapse/client/federation_whitelist.py

changelog.d/16848.feature

This commit fixes the request path in the `federation_whitelist_endpoint_enabled` config option. The path was changed towards the tail end of development in #16848.

No significant changes since 1.108.0rc1. - Add a feature that allows clients to query the configured federation whitelist. Disabled by default. ([\#16848](element-hq/synapse#16848), [\#17199](element-hq/synapse#17199)) - Add the ability to allow numeric user IDs with a specific prefix when in the CAS flow. Contributed by Aurélien Grimpard. ([\#17098](element-hq/synapse#17098)) - Fix bug where push rules would be empty in `/sync` for some accounts. Introduced in v1.93.0. ([\#17142](element-hq/synapse#17142)) - Add support for optional whitespace around the Federation API's `Authorization` header's parameter commas. ([\#17145](element-hq/synapse#17145)) - Fix bug where disabling room publication prevented public rooms being created on workers. ([\#17177](element-hq/synapse#17177), [\#17184](element-hq/synapse#17184)) - Document [`/v1/make_knock`](https://spec.matrix.org/v1.10/server-server-api/#get_matrixfederationv1make_knockroomiduserid) and [`/v1/send_knock/`](https://spec.matrix.org/v1.10/server-server-api/#put_matrixfederationv1send_knockroomideventid) federation endpoints as worker-compatible. ([\#17058](element-hq/synapse#17058)) - Update User Admin API with note about prefixing OIDC external_id providers. ([\#17139](element-hq/synapse#17139)) - Clarify the state of the created room when using the `autocreate_auto_join_room_preset` config option. ([\#17150](element-hq/synapse#17150)) - Update the Admin FAQ with the current libjemalloc version for latest Debian stable. Additionally update the name of the "push_rules" stream in the Workers documentation. ([\#17171](element-hq/synapse#17171)) - Add note to reflect that [MSC3886](matrix-org/matrix-spec-proposals#3886) is closed but will remain supported for some time. ([\#17151](element-hq/synapse#17151)) - Update dependency PyO3 to 0.21. ([\#17162](element-hq/synapse#17162)) - Fixes linter errors found in PR #17147. ([\#17166](element-hq/synapse#17166)) - Bump black from 24.2.0 to 24.4.2. ([\#17170](element-hq/synapse#17170)) - Cache literal sync filter validation for performance. ([\#17186](element-hq/synapse#17186)) - Improve performance by fixing a reactor pause. ([\#17192](element-hq/synapse#17192)) - Route `/make_knock` and `/send_knock` federation APIs to the federation reader worker in Complement test runs. ([\#17195](element-hq/synapse#17195)) - Prepare sync handler to be able to return different sync responses (`SyncVersion`). ([\#17200](element-hq/synapse#17200)) - Organize the sync cache key parameter outside of the sync config (separate concerns). ([\#17201](element-hq/synapse#17201)) - Refactor `SyncResultBuilder` assembly to its own function. ([\#17202](element-hq/synapse#17202)) - Rename to be obvious: `joined_rooms` -> `joined_room_ids`. ([\#17203](element-hq/synapse#17203), [\#17208](element-hq/synapse#17208)) - Add a short pause when rate-limiting a request. ([\#17210](element-hq/synapse#17210)) * Bump cryptography from 42.0.5 to 42.0.7. ([\#17180](element-hq/synapse#17180)) * Bump gitpython from 3.1.41 to 3.1.43. ([\#17181](element-hq/synapse#17181)) * Bump immutabledict from 4.1.0 to 4.2.0. ([\#17179](element-hq/synapse#17179)) * Bump sentry-sdk from 1.40.3 to 2.1.1. ([\#17178](element-hq/synapse#17178)) * Bump serde from 1.0.200 to 1.0.201. ([\#17183](element-hq/synapse#17183)) * Bump serde_json from 1.0.116 to 1.0.117. ([\#17182](element-hq/synapse#17182))

@clokep

# Synapse 1.109.0 (2024-06-18) - Add the ability to auto-accept invites on the behalf of users. See the [`auto_accept_invites`](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#auto-accept-invites) config option for details. ([\#17147](element-hq/synapse#17147)) - Add experimental [MSC3575](matrix-org/matrix-spec-proposals#3575) Sliding Sync `/sync/e2ee` endpoint for to-device messages and device encryption info. ([\#17167](element-hq/synapse#17167)) - Support [MSC3916](matrix-org/matrix-spec-proposals#3916) by adding unstable media endpoints to `/_matrix/client`. ([\#17213](element-hq/synapse#17213)) - Add logging to tasks managed by the task scheduler, showing CPU and database usage. ([\#17219](element-hq/synapse#17219)) # Synapse 1.108.0 (2024-05-28) - Add a feature that allows clients to query the configured federation whitelist. Disabled by default. ([\#16848](element-hq/synapse#16848), [\#17199](element-hq/synapse#17199)) - Add the ability to allow numeric user IDs with a specific prefix when in the CAS flow. Contributed by Aurélien Grimpard. ([\#17098](element-hq/synapse#17098)) Synapse 1.107.0 (2024-05-14) - Add preliminary support for [MSC3823: Account Suspension](matrix-org/matrix-spec-proposals#3823). ([\#17051](element-hq/synapse#17051)) - Declare support for [Matrix v1.10](https://matrix.org/blog/2024/03/22/matrix-v1.10-release/). Contributed by @clokep. ([\#17082](element-hq/synapse#17082)) - Add support for [MSC4115: membership metadata on events](matrix-org/matrix-spec-proposals#4115). ([\#17104](element-hq/synapse#17104), [\#17137](element-hq/synapse#17137)) # Synapse 1.106.0 (2024-04-30) - Send an email if the address is already bound to an user account. ([\#16819](element-hq/synapse#16819)) - Implement the rendezvous mechanism described by [MSC4108](matrix-org/matrix-spec-proposals#4108). ([\#17056](element-hq/synapse#17056)) - Support delegating the rendezvous mechanism described [MSC4108](matrix-org/matrix-spec-proposals#4108) to an external implementation. ([\#17086](element-hq/synapse#17086))

github-actions bot deployed to PR Documentation Preview January 24, 2024 13:03 Active

github-actions bot deployed to PR Documentation Preview January 24, 2024 13:09 Active

erikjohnston force-pushed the erikj/federation_whitelist branch from 176a38e to 298c530 Compare January 24, 2024 13:20

github-actions bot deployed to PR Documentation Preview January 24, 2024 13:22 Active

erikjohnston force-pushed the erikj/federation_whitelist branch from 298c530 to 7d37a8a Compare January 24, 2024 13:28

github-actions bot deployed to PR Documentation Preview January 24, 2024 13:29 Active

erikjohnston added 3 commits January 24, 2024 14:55

An federation whitelist query endpoint extension

1d03cfa

Newsfile

8653451

Add tests

d4c1270

erikjohnston force-pushed the erikj/federation_whitelist branch from 7d37a8a to d4c1270 Compare January 24, 2024 14:55

github-actions bot deployed to PR Documentation Preview January 24, 2024 14:56 Active

Merge branch 'develop' into erikj/federation_whitelist

b79f8e4

github-actions bot deployed to PR Documentation Preview April 16, 2024 23:50 Active

devonh marked this pull request as ready for review April 17, 2024 01:11

devonh requested a review from a team as a code owner April 17, 2024 01:11

Merge branch 'develop' into erikj/federation_whitelist

264746c

github-actions bot deployed to PR Documentation Preview April 25, 2024 17:51 Active

anoadragon453 requested changes May 7, 2024

View reviewed changes

devonh and others added 6 commits May 7, 2024 15:33

Update docs/usage/configuration/config_documentation.md

da1b7b9

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Update docs/usage/configuration/config_documentation.md

2ec7a55

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Update docs/usage/configuration/config_documentation.md

d9aa8a9

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Update tests/rest/synapse/client/test_federation_whitelist.py

1829e4a

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Add fed whitelist test that filters duplicates

a70d14f

Update fed whitelist docstring for clarity

77bd7b2

github-actions bot deployed to PR Documentation Preview May 7, 2024 15:36 Active

anoadragon453 requested changes May 9, 2024

View reviewed changes

Move config option under federation

75a3ec2

github-actions bot deployed to PR Documentation Preview May 9, 2024 18:28 Active

devonh requested a review from anoadragon453 May 9, 2024 18:28

anoadragon453 requested changes May 10, 2024

View reviewed changes

docs/usage/configuration/config_documentation.md Show resolved Hide resolved

Version federation whitelist endpoint

320fb3e

devonh requested a review from anoadragon453 May 10, 2024 14:36

github-actions bot deployed to PR Documentation Preview May 10, 2024 14:37 Active

anoadragon453 approved these changes May 13, 2024

View reviewed changes

synapse/rest/synapse/client/federation_whitelist.py Outdated Show resolved Hide resolved

changelog.d/16848.feature Outdated Show resolved Hide resolved

devonh added 2 commits May 13, 2024 13:13

Remove reference to extension feature

e3794ad

Merge branch 'develop' into erikj/federation_whitelist

a75e5b3

github-actions bot deployed to PR Documentation Preview May 13, 2024 19:14 Active

devonh merged commit 038b9ec into develop May 13, 2024
40 checks passed

devonh deleted the erikj/federation_whitelist branch May 13, 2024 19:38

anoadragon453 added a commit that referenced this pull request May 15, 2024

For request path for option in documentation

f7b24ce

This commit fixes the request path in the `federation_whitelist_endpoint_enabled` config option. The path was changed towards the tail end of development in #16848.

anoadragon453 mentioned this pull request May 15, 2024

Fix request path for federation_whitelist_endpoint_enabled option in documentation #17199

Merged

anoadragon453 added a commit that referenced this pull request May 15, 2024

Re-use changelog from #16848

0a1c7c0

anoadragon453 added a commit that referenced this pull request May 15, 2024

Re-use changelog from #16848

38d9082

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

An federation whitelist query endpoint extension #16848

An federation whitelist query endpoint extension #16848

erikjohnston commented Jan 24, 2024

CLAassistant commented Apr 16, 2024 •

edited

Loading

anoadragon453 left a comment

anoadragon453 May 7, 2024

devonh May 7, 2024

devonh May 8, 2024

anoadragon453 May 9, 2024

devonh May 9, 2024

anoadragon453 left a comment

devonh commented May 9, 2024

anoadragon453 left a comment

anoadragon453 left a comment

An federation whitelist query endpoint extension #16848

An federation whitelist query endpoint extension #16848

Conversation

erikjohnston commented Jan 24, 2024

CLAassistant commented Apr 16, 2024 • edited Loading

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 May 7, 2024

Choose a reason for hiding this comment

devonh May 7, 2024

Choose a reason for hiding this comment

devonh May 8, 2024

Choose a reason for hiding this comment

anoadragon453 May 9, 2024

Choose a reason for hiding this comment

devonh May 9, 2024

Choose a reason for hiding this comment

anoadragon453 left a comment

Choose a reason for hiding this comment

devonh commented May 9, 2024

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 left a comment

Choose a reason for hiding this comment

CLAassistant commented Apr 16, 2024 •

edited

Loading