forked from MirrorHub/synapse
Added section on rate limiting.
This commit is contained in:
parent
b175179e47
commit
9f94b11d4c
1 changed files with 15 additions and 3 deletions
|
@ -1402,11 +1402,24 @@ SRV Records
|
||||||
|
|
||||||
Security
|
Security
|
||||||
========
|
========
|
||||||
- rate limiting
|
|
||||||
|
|
||||||
.. NOTE::
|
.. NOTE::
|
||||||
This section is a work in progress.
|
This section is a work in progress.
|
||||||
|
|
||||||
|
Rate limiting
|
||||||
|
-------------
|
||||||
|
Home servers SHOULD implement rate limiting to reduce the risk of being overloaded. If a
|
||||||
|
request is refused due to rate limiting, it should return a standard error response of
|
||||||
|
the form::
|
||||||
|
|
||||||
|
{
|
||||||
|
"errcode": "M_LIMIT_EXCEEDED",
|
||||||
|
"error": "string",
|
||||||
|
"retry_after_ms": integer (optional)
|
||||||
|
}
|
||||||
|
|
||||||
|
The ``retry_after_ms`` key SHOULD be included to tell the client how long they have to wait
|
||||||
|
in milliseconds before they can try again.
|
||||||
|
|
||||||
.. TODO
|
.. TODO
|
||||||
- crypto (s-s auth)
|
- crypto (s-s auth)
|
||||||
- E2E
|
- E2E
|
||||||
|
@ -1499,4 +1512,3 @@ User ID:
|
||||||
.. _/join/<room_alias_or_id>: /-rooms/join
|
.. _/join/<room_alias_or_id>: /-rooms/join
|
||||||
|
|
||||||
.. _`Event Stream`: /-events/get_event_stream
|
.. _`Event Stream`: /-events/get_event_stream
|
||||||
.. _`Initial Sync`: /-events/initial_sync
|
|
||||||
|
|
Loading…
Reference in a new issue