-
Notifications
You must be signed in to change notification settings - Fork 435
MSC2209: Alter auth rules to check notifications in m.room.power_levels #2209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
77 changes: 77 additions & 0 deletions
77
proposals/2209-auth-rules-other-keys-in-m.room.power.levels.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Update auth rules to check notifications key in m.room.power_levels | ||
|
|
||
| ## Introduction | ||
|
|
||
| The key `notifications` was added to the `m.room.power_levels` event after the | ||
| finalisation of the auth rules specified in room version 1. This leads to the | ||
| fact, that this dictionary is not subject to the same validation as other | ||
| dictionaries in the event, such as `users` or `events`. This especially means | ||
| that Alice is able to alter any entry within the dictionary including ones, | ||
| that are above her own power level, which is inconsistent with the behaviour | ||
| for the other two dictionaries. | ||
|
|
||
| [m.room.power_levels](https://matrix.org/docs/spec/client_server/r0.5.0#m-room-power-levels) | ||
| [room version 1](https://matrix.org/docs/spec/rooms/v1) | ||
|
|
||
| ## Proposal | ||
|
|
||
| The auth rules regarding `m.room.power_levels` have been established in room | ||
| version 1. The general idea here was that creators of a new `m.room.power_levels` | ||
| event are only able to make changes to something that is equal to or lower than | ||
| their own power level. | ||
| So, assuming a room with Alice (50), Bob(100), `m.room.power_levels` at 50, | ||
| `m.room.name` at 75 and `m.room.topic` at 25 would mean the following: | ||
|
|
||
| * Alice CAN alter `m.room.topic` to any power level up to her own, in this case 50 | ||
| * Alice is NOT able to alter `m.room.name` since the current value is higher than | ||
| her own (75 > 50) | ||
| * Alice is NOT able to alter the power level of Bob, since his current value is | ||
| higher than her own (100 > 50) | ||
| * Alice is free to set the level for anything that has not been defined such as | ||
| `org.alice.message` up to a maximum of 50 | ||
|
|
||
| Later on the key `notifications` was added to the `m.room.power_levels` event. | ||
| It contains a mapping of notification keys to a power level, that is required | ||
| for a user to trigger the specific notification. The most famous notification | ||
| type is the `@room` notification. | ||
|
|
||
| Going back to the original example because this key was added later on, the auth | ||
| rules make no mention of it, which enables the following behaviour. *It is assumed | ||
| that `@room` is at 75* | ||
|
|
||
| * Alice can add any key to the dictionary and set the value to any value she wants, | ||
| including ones higher than her own. | ||
| * Alice can alter the value for `@room` to any value she wants, including ones that | ||
| are higher than her own, even though her own value is lower. | ||
|
|
||
| The proposed solution is to alter the auth rules and add the `notifications` dictionary | ||
| to the same rules that handle `events` and `users`. | ||
|
|
||
| So the rule [10.d](https://matrix.org/docs/spec/rooms/v1.html) of the auth rules in | ||
| room version 1 would be updated in a new room version to: | ||
|
|
||
|
|
||
| For each entry being added, changed or removed in events, users __and notifications__ | ||
| keys: | ||
|
turt2live marked this conversation as resolved.
Outdated
|
||
|
|
||
|
|
||
| ## Tradeoffs | ||
|
|
||
| The proposed solution would be a breaking change with current room versions and | ||
| the alternative would be to leave the `notifications` key without any checks. | ||
|
|
||
| ## Security considerations | ||
|
|
||
| This is likely to improve security because it prevents malicious users that were | ||
| only given the right to emit `m.room.power_levels` so that they could alter a very | ||
| specific key, such as `invite`, from altering the rules established for triggering | ||
| notifications. | ||
|
|
||
| ## Conclusion | ||
|
|
||
| The current spec conform behaviour regarding `notifications` is inconsistent with | ||
| behaviour shown by the other dictionaries and room administrators are very likely | ||
| expecting the `notifications` to work the same as them. The required change is minimal | ||
| is and also in line with the general spirit of the auth rules regarding the | ||
| `m.room.power_levels` event. A new room version is, however, required. This can be | ||
| done with other pending changes. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.