Skip to content

Commit ed79007

Browse files
committed
Be more explicit about authentication
1 parent 57213f0 commit ed79007

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

proposals/3266-room-summary.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,6 @@ already. This API just makes this more convenient.
8787
`allowed_room_ids` is already part of the federation `hierarchy` API and
8888
necessary for distinguishing possible join modes for `knock_restricted` rooms.
8989

90-
This API should be accessible to guest users (as it is already accessible
91-
without authentication). If the room is not allowed to be previewed,
92-
403/`M_FORBIDDEN` should be returned.
93-
9490

9591
#### Rationale and description of response fields
9692

@@ -112,7 +108,20 @@ without authentication). If the room is not allowed to be previewed,
112108

113109
It should be possible to call this API without authentication, but servers may
114110
rate limit how often they fetch information over federation more heavily, if the
115-
user is unauthenticated.
111+
user is unauthenticated. Being able to call this API unauthenticated is
112+
beneficial to avoid third parties registering guest users for one-shot API
113+
calls. Restricting this API to guests only would provide no security benefit.
114+
115+
This API should be accessible to guest users (as it is already accessible
116+
without authentication).
117+
118+
If the room is not allowed to be previewed, 403/`M_FORBIDDEN` should be
119+
returned. If the room can't be found, `M_NOT_FOUND` should be returned. A
120+
server might return additional error codes based on if a room was blocked, the
121+
`roomIdOrAlias` is malformed or other implementation specific error cases. The
122+
server should NOT return `M_UNAUTHORIZED` or otherwise divulge existance of a
123+
room, that requires authentication to preview, if the request is
124+
unauthenticated or authenticated by a user without access to the room.
116125

117126
(1) The field `membership` will not be present when called unauthenticated, but
118127
is required when called authenticated. It should be `leave` if the server

0 commit comments

Comments
 (0)