mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-05-02 07:04:09 +02:00
Compare commits
1 commit
0174d153dd
...
4a2ffbb9c1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4a2ffbb9c1 |
|
|
@ -1 +0,0 @@
|
||||||
Add the `m.oauth` authentication type for User-Interactive Authentication as per [MSC4312](https://github.com/matrix-org/matrix-spec-proposals/pull/4312).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Clarify that servers may choose not to use `M_USER_DEACTIVATED` at login time, for example for privacy reasons when they can't authenticate deactivated users.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Minor grammatical fix in the Secrets module description.
|
|
||||||
|
|
@ -907,7 +907,6 @@ This specification defines the following auth types:
|
||||||
- `m.login.dummy`
|
- `m.login.dummy`
|
||||||
- `m.login.registration_token`
|
- `m.login.registration_token`
|
||||||
- {{% added-in v="1.11" %}} `m.login.terms`
|
- {{% added-in v="1.11" %}} `m.login.terms`
|
||||||
- {{% added-in v="1.17" %}} `m.oauth`
|
|
||||||
|
|
||||||
###### Password-based
|
###### Password-based
|
||||||
|
|
||||||
|
|
@ -1246,40 +1245,6 @@ user during registration, if applicable.
|
||||||
|
|
||||||
{{% definition path="api/client-server/definitions/m.login.terms_params" %}}
|
{{% definition path="api/client-server/definitions/m.login.terms_params" %}}
|
||||||
|
|
||||||
###### OAuth authentication
|
|
||||||
|
|
||||||
{{% added-in v="1.17" %}}
|
|
||||||
|
|
||||||
| Type | Description |
|
|
||||||
|-------------------------------|-------------------------------------------------------------------|
|
|
||||||
| `m.oauth` | Authentication is supported by authorising via the homeserver's OAuth account management web UI. |
|
|
||||||
|
|
||||||
{{% boxes/note %}}
|
|
||||||
The `m.oauth` authentication type is currently only valid on the
|
|
||||||
[`/keys/device_signing/upload`](/client-server-api/#post_matrixclientv3keysdevice_signingupload) endpoint.
|
|
||||||
{{% /boxes/note %}}
|
|
||||||
|
|
||||||
This authentication type provides homeservers the ability to guard access to
|
|
||||||
sensitive actions when the client has authenticated via the
|
|
||||||
[OAuth 2.0 API](/client-server-api/#oauth-20-api), which is otherwise not
|
|
||||||
compatible with User-Interactive Authentication (UIA). To do so, the server
|
|
||||||
returns a 401 response on the respective request, where the response body
|
|
||||||
includes `m.oauth` in the `flows` list, and the `m.oauth` property in the
|
|
||||||
`params` object has the structure [shown below](#definition-moauth-params).
|
|
||||||
|
|
||||||
The client is expected to open the contained URL to let the user confirm the
|
|
||||||
action in the homeserver's account management web UI. Once the user has done
|
|
||||||
so, the client submits an `auth` dict with just the `session`, as follows,
|
|
||||||
to complete the stage:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"session": "<session ID>"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
{{% definition path="api/client-server/definitions/m.oauth_params" %}}
|
|
||||||
|
|
||||||
##### Fallback
|
##### Fallback
|
||||||
|
|
||||||
Clients cannot be expected to be able to know how to process every
|
Clients cannot be expected to be able to know how to process every
|
||||||
|
|
@ -1626,11 +1591,6 @@ because they don't have access to the user's credentials anymore.
|
||||||
The [User-Interactive Authentication API](#user-interactive-authentication-api)
|
The [User-Interactive Authentication API](#user-interactive-authentication-api)
|
||||||
is not compatible with the OAuth 2.0 API, so the endpoints that depend on it for
|
is not compatible with the OAuth 2.0 API, so the endpoints that depend on it for
|
||||||
authentication can't be used when an access token is obtained with this API.
|
authentication can't be used when an access token is obtained with this API.
|
||||||
|
|
||||||
The only exception to this is the
|
|
||||||
[`/keys/device_signing/upload`](/client-server-api/#post_matrixclientv3keysdevice_signingupload)
|
|
||||||
endpoint which uses the [`m.oauth`](/client-server-api/#oauth-authentication)
|
|
||||||
authentication type.
|
|
||||||
{{% /boxes/warning %}}
|
{{% /boxes/warning %}}
|
||||||
|
|
||||||
**Sample flow**
|
**Sample flow**
|
||||||
|
|
|
||||||
|
|
@ -59,7 +59,7 @@ clients will try to use the default key to decrypt secrets.
|
||||||
|
|
||||||
Clients that want to present a simplified interface to users by not supporting
|
Clients that want to present a simplified interface to users by not supporting
|
||||||
multiple keys should use the default key if one is specified. If no default
|
multiple keys should use the default key if one is specified. If no default
|
||||||
key is specified, the client may behave as if no key is present at
|
key is specified, the client may behave as if there is no key is present at
|
||||||
all. When such a client creates a key, it should mark that key as being the
|
all. When such a client creates a key, it should mark that key as being the
|
||||||
default key.
|
default key.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -40,12 +40,10 @@ paths:
|
||||||
makes this endpoint idempotent in the case where the response is lost over the network,
|
makes this endpoint idempotent in the case where the response is lost over the network,
|
||||||
which would otherwise cause a UIA challenge upon retry.
|
which would otherwise cause a UIA challenge upon retry.
|
||||||
|
|
||||||
{{% boxes/note %}}
|
{{% boxes/warning %}}
|
||||||
When this endpoint requires User-Interactive Authentication,
|
When this endpoint requires User-Interactive Authentication, it cannot be used when the access token was obtained
|
||||||
it uses the [`m.oauth`](/client-server-api/#oauth-authentication)
|
|
||||||
authentication type if the access token was obtained
|
|
||||||
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
{{% /boxes/note %}}
|
{{% /boxes/warning %}}
|
||||||
operationId: uploadCrossSigningKeys
|
operationId: uploadCrossSigningKeys
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
# Copyright 2025 The Matrix.org Foundation C.I.C.
|
|
||||||
#
|
|
||||||
# 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.
|
|
||||||
|
|
||||||
type: object
|
|
||||||
title: m.oauth params
|
|
||||||
description: Schema for `m.oauth` entry in the `params` object in a User-Interactive Authentication response.
|
|
||||||
required: ['url']
|
|
||||||
properties:
|
|
||||||
url:
|
|
||||||
type: string
|
|
||||||
format: uri
|
|
||||||
description: |
|
|
||||||
A URL pointing to the homeserver's OAuth account management web UI
|
|
||||||
where the user can approve the action. MUST be a valid URI with scheme
|
|
||||||
`http://` or `https://`, the latter being RECOMMENDED.
|
|
||||||
pattern: "^https?://"
|
|
||||||
example: {
|
|
||||||
"url": "https://example.org/account/reset-cross-signing"
|
|
||||||
}
|
|
||||||
|
|
@ -262,8 +262,6 @@ paths:
|
||||||
or the requested device ID is the same as a cross-signing key
|
or the requested device ID is the same as a cross-signing key
|
||||||
ID.
|
ID.
|
||||||
* `M_USER_DEACTIVATED`: The user has been deactivated.
|
* `M_USER_DEACTIVATED`: The user has been deactivated.
|
||||||
Servers MAY instead use `M_FORBIDDEN` when they can no longer authenticate
|
|
||||||
the deactivated user (e.g. their password has been wiped).
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue