OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

More rst formatting.

pull/10/head
Kegan Dougal 2014-09-09 15:13:50 -07:00
parent f23e5b17b6
commit 2bd4346075
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/human-id-rules.rst
View File

@ -42,8 +42,8 @@ Checks
- Language sets from CLDR dataset. - Language sets from CLDR dataset.
- Treated in segments (localpart, domain) - Treated in segments (localpart, domain)
- Additional restrictions for ease of processing IDs. - Additional restrictions for ease of processing IDs.
- Room alias localparts MUST NOT have ``#`` or ``:``. - Room alias localparts MUST NOT have ``#`` or ``:``.
- User ID localparts MUST NOT have ``@`` or ``:``. - User ID localparts MUST NOT have ``@`` or ``:``.
Rejecting Rejecting
--------- ---------
@ -54,12 +54,13 @@ Rejecting
- Any home server whose domain does not pass this check, MUST use their punycode - Any home server whose domain does not pass this check, MUST use their punycode
domain name instead of the IDN, to prevent other home servers rejecting you. domain name instead of the IDN, to prevent other home servers rejecting you.
- Error code is ``M_FAILED_HUMAN_ID_CHECK``. (generic enough for both failing - Error code is ``M_FAILED_HUMAN_ID_CHECK``. (generic enough for both failing
due to homograph attacks, and failing due to including ``:``s, etc) due to homograph attacks, and failing due to including ``:`` s, etc)
- Error message MAY go into further information about which characters were - Error message MAY go into further information about which characters were
rejected and why. rejected and why.
- Error message SHOULD contain a ``failed_keys`` key which contains an array - Error message SHOULD contain a ``failed_keys`` key which contains an array
of strings which represent the keys which failed the check e.g: of strings which represent the keys which failed the check e.g::
- ``failed_keys: [ user_id, room_alias ]``
failed_keys: [ user_id, room_alias ]
Other considerations Other considerations
-------------------- --------------------