Commit graph

1458 commits

Author SHA1 Message Date
Hubert Chathi 2b71234f3c clarify first run of iterative auth checks 2020-03-19 14:39:54 -04:00
Travis Ralston 79b2e5263d
Update specification/proposals_intro.rst
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2020-03-07 14:05:05 -07:00
Runster e6c7eac023
Correct name of Phil Zimmermann 2020-03-06 18:11:28 +01:00
Travis Ralston da795e5824
Apply suggestions from code review
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2020-03-05 17:24:29 -07:00
Travis Ralston 6d475ebd57
Remove whitespace
Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2020-02-17 12:56:28 -07:00
Travis Ralston c7942d1cec Spec moderation policy rooms (MSC2313)
MSC: https://github.com/matrix-org/matrix-doc/pull/2313
2020-02-12 21:58:57 -07:00
Travis Ralston 3ee9a7d654 Attempt to convert MSC2324 to reality
We've been using this in practice for a while now, so we should document it more officially. 

MSC: https://github.com/matrix-org/matrix-doc/pull/2324
2020-02-12 21:03:11 -07:00
Nicolas Werner 6911171e83 Fix key export format example
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
2020-02-06 09:52:03 +01:00
Aaron Raimist 82a626a98a Fix link to v4 event ID format in identity service spec
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2020-01-02 02:30:29 -06:00
Travis Ralston 912b3cbc95 Move auth events selection to a more appropriate section of the spec
This was pretty buried, and feels like a common question.
2019-12-30 16:29:56 -07:00
Carolin Beer 3aba6e3eeb
Change state_type to event_type
I couldn't find any other reference to a state_type within the entire specification. I assume this is supposed to be the event_type? This aligns with the description of changes resulting from a state update.
2019-12-15 14:37:10 +01:00
Travis Ralston ccc7bcabbc id -> ID while we're here 2019-12-07 15:32:43 -07:00
Isaiah Inuwa ad383351c2 Rename nonce to txn_id. Reorganize for clarity.
Signed-Off-By: Isaiah Inuwa <isaiah.inuwa@gmail.com>
2019-11-29 10:25:38 -06:00
Alexey Murz Korepov daa610659b
Typo: later user » later use 2019-11-10 16:45:01 +03:00
Travis Ralston 11a7d799a3
Merge pull request #2349 from matrix-org/identity_service/release-r0.3.0
Identity Service r0.3.0 release
2019-11-07 08:52:41 -07:00
Travis Ralston 7351c0cd1e Add missing versions to identity spec 2019-11-06 12:47:09 -07:00
Travis Ralston 50647e646e Add r0.6.0 to the list of spec versions. 2019-11-06 12:44:41 -07:00
Travis Ralston 3e035c9172 Make room version 5 the default room version.
As per [MSC2334](https://github.com/matrix-org/matrix-doc/pull/2334)
2019-11-05 16:14:04 -07:00
Travis Ralston 284b15495b Clarify what format the country is on phone number inputs
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
2019-11-04 15:25:49 -07:00
Travis Ralston f5f12a29e0 Spec MSC2290: 3PID binding split 2019-10-23 19:24:11 -06:00
Travis Ralston 48b8a95df6 Deprecate id_server and make it optional
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
2019-10-03 09:41:45 -06:00
Travis Ralston eebcaaef02 Point to the new v2 identity endpoint 2019-09-24 13:30:24 -06:00
Travis Ralston 6cfd761204 Spec the v2 lookup API
Spec for [MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134)
2019-09-09 19:58:06 -06:00
Travis Ralston a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms
Spec IS terms of service
2019-09-06 10:29:47 -06:00
Travis Ralston f7e00b19e9
Merge pull request #2255 from matrix-org/travis/spec/is-auth
Spec the v2 IS auth APIs
2019-09-06 10:29:08 -06:00
Travis Ralston 54fb5eb5cf
Merge pull request #2281 from matrix-org/travis/spec/identity-server-storage
Spec m.identity_server account data
2019-09-06 10:28:09 -06:00
Charlie Varley 4d835c1753
Update index.rst 2019-09-05 10:31:44 +01:00
Travis Ralston 958cffd330 Spec m.identity_server account data
As per [MSC2230](https://github.com/matrix-org/matrix-doc/pull/2230)
2019-09-04 16:17:41 -06:00
Travis Ralston afd5018494 Spec the terms of service handling for identity servers
Part of MSC2140

Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
2019-09-03 14:04:05 -06:00
Travis Ralston 8f48b4e717 Merge branch 'master' into travis/spec/is-auth 2019-09-03 14:03:34 -06:00
Travis Ralston 2b8c8ad512 MSC1779 is actually merged now 2019-09-03 13:49:25 -06:00
Ben Parsons d346099cf7 deduplicate MSC1779 ref in proposals list 2019-09-03 18:30:05 +01:00
Matthew Hodgson 1f2acbcf29 RST is not MD 2019-08-31 16:45:53 +01:00
Travis Ralston 91f862d9e8 Use the right error code for 401 errors 2019-08-28 20:57:07 -06:00
Travis Ralston 0408373cf9 Litter the client-server API with id_access_token 2019-08-28 15:47:08 -06:00
Travis Ralston 4d0ea64121 Define authentication, ripping off the client-server API description 2019-08-28 15:46:58 -06:00
Travis Ralston b0acaeddfa Reference the v2 API where possible 2019-08-28 14:18:11 -06:00
Damir Jelić a96a2f3fce Fix the action of a room key request cancellation.
The spec states that the action of a room key request cancellation
should be "cancel_request" but every known implementation uses
"request_cancellation" instead.

This patch fixes the spec to reflect the implementations.
2019-08-26 12:21:23 +02:00
Andrew Morgan 92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes (#2234)
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181).

Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
2019-08-15 18:10:38 +01:00
Travis Ralston a171d5f6fd Check for a state_key on the tombstone push rule
This is an oversight from the proposal.
2019-08-08 09:29:52 -06:00
Luca Becker f4d6b6c261
Fixed broken indentations 2019-07-23 17:58:40 +02:00
Luca Becker c7a23557d4
Last cosmetic changes
switched back to the use of `.. NOTE::`
2019-07-23 17:57:22 +02:00
Luca Becker d43111cdd2
Incorporated @turt2live suggestions.
Used **Note** to describe notes around the authorisation rules. Otherwise restored the original state for the consequences from the auth rules.
Moved the clarification regarding default power levels up above the auth rules. Removed third sentence. And followed @turt2live's example, but opted for "for users in that room" because the default user power level is applied to all users.
2019-07-23 11:25:34 +02:00
Luca Becker 094005dca1
Incorporated @turt2live suggestions.
Added missing added and removed to the rule, because these keys are not required for m.room.power_levels. Also moved the note down to the Note section.
2019-07-18 08:55:58 +02:00
Luca Becker 8aece4f644
Incorporated @richvdh suggestions 2019-07-17 23:26:10 +02:00
Luca Becker 15994c61a5
Clarification regarding authorisation rules
The rules for m.room.power_levels power were somewhat unclear regarding the behaviour towards the always present keys, such as kick and ban. Additionally, it is now also clarified that in the users and events dictionary also added and removed keys are taken into consideration.
2019-07-16 17:33:13 +02:00
Travis Ralston 7b0f5ea77b
Merge pull request #2159 from jimmycuadra/reference-hash-purpose
Clarify the purpose of reference hashes.
2019-07-09 16:27:44 -06:00
Jimmy Cuadra a3d2d14dae Rephrase explanation of the purpose of reference hashes and link to the
room version spec.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-07-09 15:26:03 -07:00
Andrew Morgan 52643a92c6
Less confusing wording on Application Service's Legacy Routes (#2160)
https://matrix.org/docs/spec/application_service/r0.1.1#legacy-routes

The "becomes" wording made it a little bit confusing for which was the new route and which was the old.
2019-07-09 17:54:45 +01:00
Jimmy Cuadra 5df86dabe0 Clarify the purpose of reference hashes.
The server-server specification describes a "reference hash" of an event
and how to calculate it, but is otherwise not mentioned anywhere else in
the document. This change adds a sentence to explain that they are used
for event identifiers in later room versions, which are described in
other documents.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-07-09 01:14:29 -07:00
J. Ryan Stinnett 4c65660b96 Clarify .m.rule.room_one_to_one push rule
This clarifies the `.m.rule.room_one_to_one` push rule by adding a condition on
event type. Some parts of the spec already had this info, while others were
missing it. Synapse has had this behaviour since the push rule appeared.

Fixes https://github.com/matrix-org/matrix-doc/issues/2150
2019-07-03 10:59:38 +01:00
Andrew Morgan 4997abc4b7 as as -> as 2019-06-25 16:47:10 +01:00
Travis Ralston 6f460ad70a minus spec
according to the apache .htaccess we use
2019-06-14 22:26:29 -06:00
Travis Ralston 33ca891e71 Fix link to Olm signing specification
See https://github.com/matrix-org/matrix.org/issues/478
2019-06-14 22:22:43 -06:00
Matthew Hodgson aadf1cc733
Merge pull request #2131 from jimmycuadra/e2ee-easier-typo
Fix typo in key verification framework section.
2019-06-14 21:56:29 +01:00
Jimmy Cuadra 2dd0da7d50 Fix typo in key verification framework section.
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-06-14 13:48:07 -07:00
Travis Ralston 50dee76fa7
Merge pull request #2122 from matrix-org/travis/fix-changelog
Fix changelog generation
2019-06-13 19:19:32 -06:00
Travis Ralston 18eca90022 Exclude DEL from historical user IDs
The range is inclusive, so don't include 7F
2019-06-12 13:48:50 -06:00
Travis Ralston e60d2defbd Fix changelog generation
Only include the target version, not all versions. Additionally, make sure the appservice spec isn't hardcoded as "unstable".
2019-06-12 13:47:09 -06:00
Travis Ralston 19a3d574b7 Fix HKDF rationale 2019-06-11 11:31:24 -06:00
Travis Ralston ba5479e46f Reference Canonical JSON 2019-06-11 11:30:04 -06:00
Travis Ralston 98c9d93b20
Merge pull request #2113 from matrix-org/client_server/release-r0.5.0
Client-Server r0.5.0
2019-06-11 10:54:06 -06:00
Travis Ralston 497c6875ac
Merge pull request #2112 from matrix-org/server_server/release-r0.1.2
Federation r0.1.2
2019-06-11 10:53:56 -06:00
Travis Ralston 67d12165e8
Merge pull request #2111 from matrix-org/identity_service/release-r0.2.0
Identity r0.2.0
2019-06-11 10:53:44 -06:00
Travis Ralston 1ca60bf5d7 Client-Server r0.5.0 2019-06-11 10:40:48 -06:00
Travis Ralston 8e6ccf0a0e Federation r0.1.2 2019-06-11 10:38:12 -06:00
Travis Ralston 34ad81e81b Identity r0.2.0 2019-06-11 10:30:56 -06:00
Travis Ralston 4f915f2760 Appservice r0.1.1 2019-06-11 10:15:51 -06:00
Travis Ralston f44483a8cf
Merge pull request #2099 from matrix-org/travis/1.0/1.0-notice
Declare Matrix 1.0 in the index
2019-06-11 09:56:55 -06:00
Travis Ralston 2d18f81807
Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible
Reorganize event structure in c2s spec and clarify event capabilities
2019-06-11 09:55:17 -06:00
Travis Ralston c9345ba6a3 Never forget the past 2019-06-11 09:53:36 -06:00
Travis Ralston 19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
Spec lazy-loading room members
2019-06-11 09:39:32 -06:00
Travis Ralston fbdb56a29f
Merge pull request #2101 from matrix-org/anoa/hs_3pid_tokens
Add submit_url field to requestToken responses, clarify HS's can send tokens themselves
2019-06-11 09:25:53 -06:00
Travis Ralston 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
2019-06-11 08:51:25 -06:00
Travis Ralston b32f0e768f clarify that UIA can now be done by the HS 2019-06-11 08:47:40 -06:00
Travis Ralston 370ae8b9fe
Merge pull request #2068 from matrix-org/travis/1.0/mxc
Refactor documentation for content/media repository
2019-06-11 08:32:06 -06:00
Travis Ralston ad3aa5edf0
Merge pull request #2104 from matrix-org/travis/1.0/event-ids
Clarify that the common identifier format can be broken
2019-06-11 07:51:34 -06:00
Travis Ralston b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
Specify some of the common concepts for Matrix in the index
2019-06-11 07:51:06 -06:00
Travis Ralston c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs
Clarify how notification counts are calculated in /sync
2019-06-11 07:50:33 -06:00
Travis Ralston ad2eefdde9 Shuffle and clarify identifier grammar
Specifically, make it clearer that event IDs are the weird exception in this section.
2019-06-10 14:23:04 -06:00
Travis Ralston 32761fc108
Merge pull request #2098 from matrix-org/travis/1.0/modules-update
Clarify what a "module" is and update feature profiles for clients
2019-06-10 14:05:15 -06:00
Travis Ralston 37e2d81d58 Hardcode the state event fields table into the spec
See comment for why.
2019-06-10 14:04:27 -06:00
Travis Ralston 51698a5dd5 Clarify that people must own the namespace to use it 2019-06-10 14:04:14 -06:00
Travis Ralston 19c827e581 Remove trailing slashes section 2019-06-10 13:49:05 -06:00
Travis Ralston 49831fb74f Clarifications about namespaces 2019-06-10 13:48:55 -06:00
Travis Ralston 1886a2346a Move explanation of notifications to notifications module 2019-06-10 13:38:43 -06:00
Travis Ralston cf19f52576 Enforce 7 day validity requirement everywhere
also misc formatting fixes
2019-06-10 13:21:24 -06:00
Matthew Hodgson 0506d09cf7 incorporate LL review from matthew 2019-06-10 19:38:44 +01:00
Travis Ralston 7fe7d365e2
Merge pull request #2089 from matrix-org/travis/1.0/cors
Clarify when and where CORS headers should be returned
2019-06-10 07:21:52 -06:00
Travis Ralston 29340c6eb8 Clarify that the common identifier format can be broken
We already reference in the Event IDs section that the format depends on the room version, so we just need to link there.

Fixes https://github.com/matrix-org/matrix-doc/issues/2103
2019-06-09 22:50:23 -06:00
Matthew Hodgson 950415c72a
Merge branch 'master' into matthew/msc1779 2019-06-07 19:19:19 +01:00
Travis Ralston a38af2009f
Apply suggestions from code review
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-06-07 10:37:57 -06:00
Travis Ralston 4b6e2cc956
Merge pull request #2072 from matrix-org/travis/1.0/msc1717-msc1267-sas-verification
Spec SAS verification and the common key verification framework
2019-06-07 10:34:08 -06:00
Travis Ralston 46747e897e ing 2019-06-07 10:32:06 -06:00
Travis Ralston 00588efd3f
Merge pull request #2086 from matrix-org/travis/1.0/fed-content-type
Clarify that the default s2s transport is JSON over HTTP
2019-06-07 10:12:59 -06:00
Travis Ralston ac27728c0a
Merge pull request #2082 from matrix-org/travis/1.0/v4-default
Make v4 the "default" room version
2019-06-07 10:11:49 -06:00
Travis Ralston e4339fd687 More clarity 2019-06-07 09:01:14 -06:00
Travis Ralston 6a4a6db1bd
Merge pull request #2081 from matrix-org/travis/1.0/pdu-signatures
Clarify which servers are supposed to sign events
2019-06-07 08:56:14 -06:00
Travis Ralston 4c82553df4
Merge pull request #2047 from matrix-org/travis/1.0/test-vectors
Fix test vectors with invalid JSON and signature
2019-06-07 08:54:35 -06:00
Travis Ralston 360ac0b900
Update specification/server_server_api.rst
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-06-07 08:54:21 -06:00