Skip to content
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

Add knocking to the spec #3154

Merged
merged 6 commits into from
Apr 30, 2021
Merged

Conversation

turt2live
Copy link
Member

Spec for #2998
Spec for #2403

This deliberately does not help towards fixing #3153 in order to remain consistent with prior room versions, and to keep the diff smaller on this change. A future change will address room version legibility.

Spec for #2998
Spec for #2403

This deliberately does not help towards fixing #3153 in order to remain consistent with prior room versions, and to keep the diff smaller on this change. A future change will address room version legibility.
@turt2live turt2live requested a review from a team April 29, 2021 01:56
----------------------------------------------+ +----------------------+
/ban
```
![membership-flow-diagram](/diagrams/membership.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No love for Scalable Vector Graphics?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one day maybe, but for now I'm not confident in our CSP or our SVG abilities to properly maintain this.

content/client-server-api/_index.md Outdated Show resolved Hide resolved
description: |-
The servers to attempt to knock on the room through. One of the servers
must be participating in the room.
x-example: ["matrix.org", "elsewhere.ca"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. We seem to have lost examples for path/query params in the new spec. https://github.com/matrix-org/matrix-doc/issues/3158

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, will fix this out of band

data/api/server-server/knocks.yaml Outdated Show resolved Hide resolved
@turt2live turt2live requested a review from uhoreg April 30, 2021 04:20
Comment on lines +32 to +50
If type is `m.room.member`:

...

* If `membership` is `ban`:

...

* If `membership` is `knock`:

i. If the `join_rule` is anything other than `knock`, reject.

ii. If `sender` does not match `state_key`, reject.

iii. If the `sender`'s current membership is not `ban`, `invite`, or `join`, allow.

iv. Otherwise, reject.

...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is being rendered as a code block in the preview because it's indented. I don't think that's what you wanted.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was intended

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context is v6 was the first to introduce a diff-style view of auth rules, but in the transition to the new spec platform we lost diff styling. One day I'd just like to fix it properly, so this is fine for now.

@turt2live turt2live merged commit 315f36c into master Apr 30, 2021
@turt2live turt2live deleted the travis/spec/knock-knock-whos-there branch April 30, 2021 15:21
richvdh pushed a commit that referenced this pull request Aug 23, 2021
richvdh pushed a commit that referenced this pull request Aug 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants