async-matrix 0.1.2 → 1.0.0

data/data/matrix-spec/api/client-server/voip.yaml

@@ -0,0 +1,93 @@
+# Copyright 2016 OpenMarket Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+openapi: 3.1.0
+info:
+  title: Matrix Client-Server Voice over IP API
+  version: 1.0.0
+paths:
+  /voip/turnServer:
+    get:
+      summary: Obtain TURN server credentials.
+      description: |-
+        This API provides credentials for the client to use when initiating
+        calls.
+      operationId: getTurnServer
+      security:
+        - accessTokenQuery: []
+        - accessTokenBearer: []
+      responses:
+        "200":
+          description: The TURN server credentials.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  username:
+                    type: string
+                    description: The username to use.
+                  password:
+                    type: string
+                    description: The password to use.
+                  uris:
+                    type: array
+                    items:
+                      type: string
+                    description: A list of TURN URIs
+                  ttl:
+                    type: integer
+                    description: The time-to-live in seconds
+                required:
+                  - username
+                  - password
+                  - uris
+                  - ttl
+              examples:
+                response:
+                  value: {
+                    "username": "1443779631:@user:example.com",
+                    "password": "JlKfBy1QwLrO20385QyAtEyIv0=",
+                    "uris": [
+                      "turn:turn.example.com:3478?transport=udp",
+                      "turn:10.20.30.40:3478?transport=tcp",
+                      "turns:10.20.30.40:443?transport=tcp"
+                    ],
+                    "ttl": 86400
+                  }
+        "429":
+          description: This request was rate-limited.
+          content:
+            application/json:
+              schema:
+                $ref: definitions/errors/rate_limited.yaml
+      tags:
+        - VOIP
+servers:
+  - url: "{protocol}://{hostname}{basePath}"
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+      hostname:
+        default: localhost:8008
+      basePath:
+        default: /_matrix/client/v3
+components:
+  securitySchemes:
+    accessTokenQuery:
+      $ref: definitions/security.yaml#/accessTokenQuery
+    accessTokenBearer:
+      $ref: definitions/security.yaml#/accessTokenBearer

data/data/matrix-spec/api/client-server/wellknown.yaml

@@ -0,0 +1,60 @@
+# Copyright 2018 New Vector Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+openapi: 3.1.0
+info:
+  title: Matrix Client-Server Server Discovery API
+  version: 1.0.0
+paths:
+  /matrix/client:
+    get:
+      summary: Gets Matrix server discovery information about the domain.
+      description: |-
+        Gets discovery information about the domain. The file may include
+        additional keys, which MUST follow the Java package naming convention,
+        e.g. `com.example.myapp.property`. This ensures property names are
+        suitably namespaced for each application and reduces the risk of
+        clashes.
+
+        {{% boxes/note %}}
+        This endpoint should be accessed with the hostname of the homeserver's
+        [server name](/appendices/#server-name) by making a
+        GET request to `https://hostname/.well-known/matrix/client`.
+        {{% /boxes/note %}}
+
+        Note that this endpoint is not necessarily handled by the homeserver,
+        but by another webserver, to be used for discovering the homeserver URL.
+      operationId: getWellknown
+      responses:
+        "200":
+          description: Server discovery information.
+          content:
+            application/json:
+              schema:
+                $ref: definitions/wellknown/full.yaml
+        "404":
+          description: No server discovery information available.
+      tags:
+        - Server administration
+servers:
+  - url: "{protocol}://{hostname}{basePath}"
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+      hostname:
+        default: localhost:8008
+      basePath:
+        default: /.well-known

data/data/matrix-spec/api/client-server/whoami.yaml

@@ -0,0 +1,121 @@
+# Copyright 2017 Travis Ralston
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+openapi: 3.1.0
+info:
+  title: Matrix Client-Server Account Identification API
+  version: 1.0.0
+paths:
+  /account/whoami:
+    get:
+      summary: Gets information about the owner of an access token.
+      description: |-
+        Gets information about the owner of a given access token.
+
+        Note that, as with the rest of the Client-Server API,
+        Application Services may masquerade as users within their
+        namespace by giving a `user_id` query parameter. In this
+        situation, the server should verify that the given `user_id`
+        is registered by the appservice, and return it in the response
+        body.
+      operationId: getTokenOwner
+      security:
+        - accessTokenQuery: []
+        - accessTokenBearer: []
+      responses:
+        "200":
+          description: The token belongs to a known user.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - user_id
+                properties:
+                  user_id:
+                    type: string
+                    format: mx-user-id
+                    pattern: "^@"
+                    description: The user ID that owns the access token.
+                  device_id:
+                    x-addedInMatrixVersion: "1.1"
+                    type: string
+                    description: |-
+                      Device ID associated with the access token. If no device
+                      is associated with the access token (such as in the case
+                      of application services) then this field can be omitted.
+                      Otherwise this is required.
+                  is_guest:
+                    x-addedInMatrixVersion: "1.2"
+                    type: boolean
+                    description: |-
+                      When `true`, the user is a [Guest User](/client-server-api/#guest-access).
+                      When not present or `false`, the user is presumed to be a 
+                      non-guest user.
+              examples:
+                response:
+                  value: {
+                    "user_id": "@joe:example.org",
+                    "device_id": "ABC1234"
+                  }
+        "401":
+          description: The token is not recognised
+          content:
+            application/json:
+              schema:
+                $ref: definitions/errors/error.yaml
+              examples:
+                response:
+                  value: {
+                    "errcode": "M_UNKNOWN_TOKEN",
+                    "error": "Unrecognised access token."
+                  }
+        "403":
+          description: The appservice cannot masquerade as the user or has not registered
+            them.
+          content:
+            application/json:
+              schema:
+                $ref: definitions/errors/error.yaml
+              examples:
+                response:
+                  value: {
+                    "errcode": "M_FORBIDDEN",
+                    "error": "Application service has not registered this user."
+                  }
+        "429":
+          description: This request was rate-limited.
+          content:
+            application/json:
+              schema:
+                $ref: definitions/errors/rate_limited.yaml
+      tags:
+        - Session management
+servers:
+  - url: "{protocol}://{hostname}{basePath}"
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+      hostname:
+        default: localhost:8008
+      basePath:
+        default: /_matrix/client/v3
+components:
+  securitySchemes:
+    accessTokenQuery:
+      $ref: definitions/security.yaml#/accessTokenQuery
+    accessTokenBearer:
+      $ref: definitions/security.yaml#/accessTokenBearer

data/data/matrix-spec/event-schemas/examples/core/event.json

@@ -0,0 +1,6 @@
+{
+    "content": {
+        "key": "value"
+    },
+    "type": "org.example.custom.event"
+}

data/data/matrix-spec/event-schemas/examples/core/room_edu.json

@@ -0,0 +1,3 @@
+{
+    "$ref": "event.json"
+}

data/data/matrix-spec/event-schemas/examples/core/room_event.json

@@ -0,0 +1,11 @@
+{
+    "$ref": "event.json",
+    "event_id": "$143273582443PhrSn:example.org",
+    "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
+    "sender": "@example:example.org",
+    "origin_server_ts": 1432735824653,
+    "unsigned": {
+      "age": 1234,
+      "membership": "join"
+    }
+}

data/data/matrix-spec/event-schemas/examples/core/state_event.json

@@ -0,0 +1,4 @@
+{
+    "$ref": "room_event.json",
+    "state_key": "ArbitraryString"
+}

data/data/matrix-spec/event-schemas/examples/invite_room_state.json

@@ -0,0 +1,18 @@
+[
+    {
+        "type": "m.room.name",
+        "sender": "@bob:example.org",
+        "state_key": "",
+        "content": {
+            "name": "Example Room"
+        }
+    },
+    {
+        "type": "m.room.join_rules",
+        "sender": "@bob:example.org",
+        "state_key": "",
+        "content": {
+            "join_rule": "invite"
+        }
+    }
+]

data/data/matrix-spec/event-schemas/examples/knock_room_state.json

@@ -0,0 +1,18 @@
+[
+    {
+        "type": "m.room.name",
+        "sender": "@bob:example.org",
+        "state_key": "",
+        "content": {
+            "name": "Example Room"
+        }
+    },
+    {
+        "type": "m.room.join_rules",
+        "sender": "@bob:example.org",
+        "state_key": "",
+        "content": {
+            "join_rule": "knock"
+        }
+    }
+]

data/data/matrix-spec/event-schemas/examples/m.accepted_terms.yaml

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.accepted_terms",
+  "content": {
+    "accepted": [
+      "https://example.org/somewhere/terms-1.2-en.html",
+      "https://example.org/somewhere/privacy-1.2-en.html"
+    ]
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.answer.yaml

@@ -0,0 +1,21 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.answer",
+  "content": {
+    "version" : "1",
+    "party_id": "67890",
+    "call_id": "12345",
+    "answer": {
+      "type" : "answer",
+      "sdp" : "v=0\r\no=- 6584580628695956864 2 IN IP4 127.0.0.1[...]"
+    },
+    "sdp_stream_metadata": {
+        "271828182845": {
+            "purpose": "m.screenshare"
+        },
+        "314159265358": {
+            "purpose": "m.usermedia"
+        }
+    }
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.candidates.yaml

@@ -0,0 +1,16 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.candidates",
+  "content": {
+    "version" : "1",
+    "party_id": "67890",
+    "call_id": "12345",
+    "candidates": [
+      {
+        "sdpMid": "audio",
+        "sdpMLineIndex": 0,
+        "candidate": "candidate:863018703 1 udp 2122260223 10.9.64.156 43670 typ host generation 0"
+      }
+    ]
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.hangup.yaml

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.hangup",
+  "content": {
+    "version" : "1",
+    "party_id": "67890",
+    "call_id": "12345",
+    "reason": "user_hangup"
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.invite.yaml

@@ -0,0 +1,22 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.invite",
+  "content": {
+    "version" : "1",
+    "party_id": "67890",
+    "call_id": "12345",
+    "lifetime": 60000,
+    "offer": {
+      "type" : "offer",
+      "sdp" : "v=0\r\no=- 6584580628695956864 2 IN IP4 127.0.0.1[...]"
+    },
+    "sdp_stream_metadata": {
+        "271828182845": {
+            "purpose": "m.screenshare"
+        },
+        "314159265358": {
+            "purpose": "m.usermedia"
+        }
+    }
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.negotiate.yaml

@@ -0,0 +1,22 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.negotiate",
+  "content": {
+    "version" : "1",
+    "party_id": "67890",
+    "call_id": "12345",
+    "lifetime": 10000,
+    "description": {
+      "type" : "offer",
+      "sdp" : "v=0\r\no=- 6584580628695956864 2 IN IP4 127.0.0.1[...]"
+    },
+    "sdp_stream_metadata": {
+        "271828182845": {
+            "purpose": "m.screenshare"
+        },
+        "314159265358": {
+            "purpose": "m.usermedia"
+        }
+    }
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.reject.yaml

@@ -0,0 +1,9 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.reject",
+  "content": {
+    "version" : "1",
+    "party_id": "67890",
+    "call_id": "12345"
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.sdp_stream_metadata_changed.yaml

@@ -0,0 +1,16 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.sdp_stream_metadata_changed",
+  "content": {
+    "version": "1",
+    "call_id": "1414213562373095",
+    "party_id": "1732050807568877",
+    "sdp_stream_metadata": {
+        "2311546231": {
+            "purpose": "m.usermedia",
+            "audio_muted:": true,
+            "video_muted": true
+        }
+    }
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.call.select_answer.yaml

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.call.select_answer",
+  "content": {
+    "version" : "1",
+    "call_id": "12345",
+    "party_id": "67890",
+    "selected_party_id": "111213"
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.direct.yaml

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.direct",
+  "content": {
+    "@bob:example.com": [
+      "!abcdefgh:example.com",
+      "!hgfedcba:example.com"
+    ]
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.dummy.yaml

@@ -0,0 +1,4 @@
+{
+  "content": {},
+  "type": "m.dummy"
+}

data/data/matrix-spec/event-schemas/examples/m.forwarded_room_key.yaml

@@ -0,0 +1,14 @@
+{
+  "content": {
+    "algorithm": "m.megolm.v1.aes-sha2",
+    "room_id": "!Cuyf34gef24t:localhost",
+    "session_id": "X3lUlvLELLYxeTx4yOVu6UDpasGEVO0Jbu+QFnm0cKQ",
+    "session_key": "AgAAAADxKHa9uFxcXzwYoNueL5Xqi69IkD4sni8Llf...",
+    "sender_key": "RF3s+E7RkTQTGF2d8Deol0FkQvgII2aJDf3/Jp5mxVU",
+    "sender_claimed_ed25519_key": "aj40p+aw64yPIdsxoog8jhPu9i7l7NcFRecuOQblE3Y",
+    "forwarding_curve25519_key_chain": [
+      "hPQNcabIABgGnx3/ACv/jmMmiQHoeFfuLB17tzWp6Hw"
+    ]
+  },
+  "type": "m.forwarded_room_key"
+}

data/data/matrix-spec/event-schemas/examples/m.fully_read.yaml

@@ -0,0 +1,7 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.fully_read",
+  "content": {
+    "event_id": "$someplace:example.org"
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.identity_server.yaml

@@ -0,0 +1,7 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.identity_server",
+  "content": {
+    "base_url": "https://example.org"
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.ignored_user_list.yaml

@@ -0,0 +1,9 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.ignored_user_list",
+  "content": {
+    "ignored_users": {
+      "@someone:example.org": {}
+    }
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.invite_permission_config.yaml

@@ -0,0 +1,7 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.invite_permission_config",
+  "content": {
+    "default_action": "block"
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.accept.yaml

@@ -0,0 +1,12 @@
+{
+    "type": "m.key.verification.accept",
+    "content": {
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "method": "m.sas.v1",
+        "key_agreement_protocol": "curve25519",
+        "hash": "sha256",
+        "message_authentication_code": "hkdf-hmac-sha256.v2",
+        "short_authentication_string": ["decimal", "emoji"],
+        "commitment": "fQpGIW1Snz+pwLZu6sTy2aHy/DYWWTspTJRPyNp0PKkymfIsNffysMl6ObMMFdIJhk6g6pwlIqZ54rxo8SLmAg"
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.cancel.yaml

@@ -0,0 +1,8 @@
+{
+    "type": "m.key.verification.cancel",
+    "content": {
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "code": "m.user",
+        "reason": "User rejected the key verification request"
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.done.yaml

@@ -0,0 +1,6 @@
+{
+    "type": "m.key.verification.done",
+    "content": {
+        "transaction_id": "S0meUniqueAndOpaqueString"
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.key.yaml

@@ -0,0 +1,7 @@
+{
+    "type": "m.key.verification.key",
+    "content": {
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "key": "fQpGIW1Snz+pwLZu6sTy2aHy/DYWWTspTJRPyNp0PKkymfIsNffysMl6ObMMFdIJhk6g6pwlIqZ54rxo8SLmAg"
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.mac.yaml

@@ -0,0 +1,10 @@
+{
+    "type": "m.key.verification.mac",
+    "content": {
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "keys": "2Wptgo4CwmLo/Y8B8qinxApKaCkBG2fjTWB7AbP5Uy+aIbygsSdLOFzvdDjww8zUVKCmI02eP9xtyJxc/cLiBA",
+        "mac": {
+            "ed25519:ABCDEF": "fQpGIW1Snz+pwLZu6sTy2aHy/DYWWTspTJRPyNp0PKkymfIsNffysMl6ObMMFdIJhk6g6pwlIqZ54rxo8SLmAg"
+        }
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.ready.yaml

@@ -0,0 +1,10 @@
+{
+    "type": "m.key.verification.ready",
+    "content": {
+        "from_device": "BobDevice1",
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "methods": [
+            "m.sas.v1"
+        ]
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.request.yaml

@@ -0,0 +1,11 @@
+{
+    "type": "m.key.verification.request",
+    "content": {
+        "from_device": "AliceDevice2",
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "methods": [
+            "m.sas.v1"
+        ],
+        "timestamp": 1559598944869
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.start$m.sas.v1.yaml

@@ -0,0 +1,12 @@
+{
+    "type": "m.key.verification.start",
+    "content": {
+        "from_device": "BobDevice1",
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "method": "m.sas.v1",
+        "key_agreement_protocols": ["curve25519"],
+        "hashes": ["sha256"],
+        "message_authentication_codes": ["hkdf-hmac-sha256.v2", "hkdf-hmac-sha256"],
+        "short_authentication_string": ["decimal", "emoji"]
+    }
+}

data/data/matrix-spec/event-schemas/examples/m.key.verification.start.yaml

@@ -0,0 +1,8 @@
+{
+    "type": "m.key.verification.start",
+    "content": {
+        "from_device": "BobDevice1",
+        "transaction_id": "S0meUniqueAndOpaqueString",
+        "method": "m.sas.v1"
+    }
+}