2021-10-13 11:21:52 +00:00
|
|
|
# Password auth provider callbacks
|
|
|
|
|
|
|
|
Password auth providers offer a way for server administrators to integrate
|
|
|
|
their Synapse installation with an external authentication system. The callbacks can be
|
|
|
|
registered by using the Module API's `register_password_auth_provider_callbacks` method.
|
|
|
|
|
|
|
|
## Callbacks
|
|
|
|
|
|
|
|
### `auth_checkers`
|
|
|
|
|
2021-10-20 11:04:27 +00:00
|
|
|
_First introduced in Synapse v1.46.0_
|
|
|
|
|
2021-10-13 11:21:52 +00:00
|
|
|
```
|
|
|
|
auth_checkers: Dict[Tuple[str,Tuple], Callable]
|
|
|
|
```
|
|
|
|
|
|
|
|
A dict mapping from tuples of a login type identifier (such as `m.login.password`) and a
|
|
|
|
tuple of field names (such as `("password", "secret_thing")`) to authentication checking
|
|
|
|
callbacks, which should be of the following form:
|
|
|
|
|
|
|
|
```python
|
|
|
|
async def check_auth(
|
|
|
|
user: str,
|
|
|
|
login_type: str,
|
|
|
|
login_dict: "synapse.module_api.JsonDict",
|
|
|
|
) -> Optional[
|
|
|
|
Tuple[
|
|
|
|
str,
|
|
|
|
Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]]
|
|
|
|
]
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
|
|
|
The login type and field names should be provided by the user in the
|
|
|
|
request to the `/login` API. [The Matrix specification](https://matrix.org/docs/spec/client_server/latest#authentication-types)
|
|
|
|
defines some types, however user defined ones are also allowed.
|
|
|
|
|
|
|
|
The callback is passed the `user` field provided by the client (which might not be in
|
|
|
|
`@username:server` form), the login type, and a dictionary of login secrets passed by
|
|
|
|
the client.
|
|
|
|
|
|
|
|
If the authentication is successful, the module must return the user's Matrix ID (e.g.
|
|
|
|
`@alice:example.com`) and optionally a callback to be called with the response to the
|
|
|
|
`/login` request. If the module doesn't wish to return a callback, it must return `None`
|
|
|
|
instead.
|
|
|
|
|
|
|
|
If the authentication is unsuccessful, the module must return `None`.
|
|
|
|
|
2021-10-18 16:26:52 +00:00
|
|
|
If multiple modules register an auth checker for the same login type but with different
|
|
|
|
fields, Synapse will refuse to start.
|
|
|
|
|
|
|
|
If multiple modules register an auth checker for the same login type with the same fields,
|
|
|
|
then the callbacks will be executed in order, until one returns a Matrix User ID (and
|
|
|
|
optionally a callback). In that case, the return value of that callback will be accepted
|
|
|
|
and subsequent callbacks will not be fired. If every callback returns `None`, then the
|
|
|
|
authentication fails.
|
|
|
|
|
2021-10-13 11:21:52 +00:00
|
|
|
### `check_3pid_auth`
|
|
|
|
|
2021-10-20 11:04:27 +00:00
|
|
|
_First introduced in Synapse v1.46.0_
|
|
|
|
|
2021-10-13 11:21:52 +00:00
|
|
|
```python
|
|
|
|
async def check_3pid_auth(
|
|
|
|
medium: str,
|
|
|
|
address: str,
|
|
|
|
password: str,
|
|
|
|
) -> Optional[
|
|
|
|
Tuple[
|
|
|
|
str,
|
|
|
|
Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]]
|
|
|
|
]
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
|
|
|
Called when a user attempts to register or log in with a third party identifier,
|
|
|
|
such as email. It is passed the medium (eg. `email`), an address (eg. `jdoe@example.com`)
|
|
|
|
and the user's password.
|
|
|
|
|
|
|
|
If the authentication is successful, the module must return the user's Matrix ID (e.g.
|
|
|
|
`@alice:example.com`) and optionally a callback to be called with the response to the `/login` request.
|
|
|
|
If the module doesn't wish to return a callback, it must return None instead.
|
|
|
|
|
2021-10-18 16:26:52 +00:00
|
|
|
If the authentication is unsuccessful, the module must return `None`.
|
|
|
|
|
|
|
|
If multiple modules implement this callback, they will be considered in order. If a
|
|
|
|
callback returns `None`, Synapse falls through to the next one. The value of the first
|
|
|
|
callback that does not return `None` will be used. If this happens, Synapse will not call
|
|
|
|
any of the subsequent implementations of this callback. If every callback return `None`,
|
|
|
|
the authentication is denied.
|
2021-10-13 11:21:52 +00:00
|
|
|
|
|
|
|
### `on_logged_out`
|
|
|
|
|
2021-10-20 11:04:27 +00:00
|
|
|
_First introduced in Synapse v1.46.0_
|
|
|
|
|
2021-10-13 11:21:52 +00:00
|
|
|
```python
|
|
|
|
async def on_logged_out(
|
|
|
|
user_id: str,
|
|
|
|
device_id: Optional[str],
|
|
|
|
access_token: str
|
|
|
|
) -> None
|
|
|
|
```
|
|
|
|
Called during a logout request for a user. It is passed the qualified user ID, the ID of the
|
|
|
|
deactivated device (if any: access tokens are occasionally created without an associated
|
|
|
|
device ID), and the (now deactivated) access token.
|
|
|
|
|
2021-10-18 16:26:52 +00:00
|
|
|
If multiple modules implement this callback, Synapse runs them all in order.
|
|
|
|
|
2021-10-13 11:21:52 +00:00
|
|
|
## Example
|
|
|
|
|
|
|
|
The example module below implements authentication checkers for two different login types:
|
|
|
|
- `my.login.type`
|
|
|
|
- Expects a `my_field` field to be sent to `/login`
|
|
|
|
- Is checked by the method: `self.check_my_login`
|
|
|
|
- `m.login.password` (defined in [the spec](https://matrix.org/docs/spec/client_server/latest#password-based))
|
|
|
|
- Expects a `password` field to be sent to `/login`
|
|
|
|
- Is checked by the method: `self.check_pass`
|
|
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
from typing import Awaitable, Callable, Optional, Tuple
|
|
|
|
|
|
|
|
import synapse
|
|
|
|
from synapse import module_api
|
|
|
|
|
|
|
|
|
|
|
|
class MyAuthProvider:
|
|
|
|
def __init__(self, config: dict, api: module_api):
|
|
|
|
|
|
|
|
self.api = api
|
|
|
|
|
|
|
|
self.credentials = {
|
|
|
|
"bob": "building",
|
|
|
|
"@scoop:matrix.org": "digging",
|
|
|
|
}
|
|
|
|
|
|
|
|
api.register_password_auth_provider_callbacks(
|
|
|
|
auth_checkers={
|
|
|
|
("my.login_type", ("my_field",)): self.check_my_login,
|
|
|
|
("m.login.password", ("password",)): self.check_pass,
|
|
|
|
},
|
|
|
|
)
|
|
|
|
|
|
|
|
async def check_my_login(
|
|
|
|
self,
|
|
|
|
username: str,
|
|
|
|
login_type: str,
|
|
|
|
login_dict: "synapse.module_api.JsonDict",
|
|
|
|
) -> Optional[
|
|
|
|
Tuple[
|
|
|
|
str,
|
|
|
|
Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]],
|
|
|
|
]
|
|
|
|
]:
|
|
|
|
if login_type != "my.login_type":
|
|
|
|
return None
|
|
|
|
|
|
|
|
if self.credentials.get(username) == login_dict.get("my_field"):
|
|
|
|
return self.api.get_qualified_user_id(username)
|
|
|
|
|
|
|
|
async def check_pass(
|
|
|
|
self,
|
|
|
|
username: str,
|
|
|
|
login_type: str,
|
|
|
|
login_dict: "synapse.module_api.JsonDict",
|
|
|
|
) -> Optional[
|
|
|
|
Tuple[
|
|
|
|
str,
|
|
|
|
Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]],
|
|
|
|
]
|
|
|
|
]:
|
|
|
|
if login_type != "m.login.password":
|
|
|
|
return None
|
|
|
|
|
|
|
|
if self.credentials.get(username) == login_dict.get("password"):
|
|
|
|
return self.api.get_qualified_user_id(username)
|
|
|
|
```
|