mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-14 11:57:44 +00:00
428 lines
36 KiB
HTML
428 lines
36 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Password auth provider callbacks - Synapse</title>
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/table-of-contents.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/indent-section-headers.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "../";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="../welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="../setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="../postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="../reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="../setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="../turn-howto.html">Configuring a Turn Server</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/turn/coturn.html">coturn TURN server</a></li><li class="chapter-item expanded "><a href="../setup/turn/eturnal.html">eturnal TURN server</a></li></ol></li><li class="chapter-item expanded "><a href="../delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="../upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="../federate.html">Federation</a></li><li class="chapter-item expanded "><a href="../usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="../usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="../usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="../structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="../templates.html">Templates</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="../sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="../password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="../jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="../CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="../application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="../server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="../consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="../user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="../message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="../modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">Synapse</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/matrix-org/synapse/edit/develop/docs/modules/password_auth_provider_callbacks.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<!-- Page table of contents -->
|
||
|
|
<div class="sidetoc">
|
||
|
|
<nav class="pagetoc"></nav>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 id="password-auth-provider-callbacks"><a class="header" href="#password-auth-provider-callbacks">Password auth provider callbacks</a></h1>
|
||
|
|
<p>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 <code>register_password_auth_provider_callbacks</code> method.</p>
|
||
|
|
<h2 id="callbacks"><a class="header" href="#callbacks">Callbacks</a></h2>
|
||
|
|
<h3 id="auth_checkers"><a class="header" href="#auth_checkers"><code>auth_checkers</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.46.0</em></p>
|
||
|
|
<pre><code class="language-python">auth_checkers: Dict[Tuple[str, Tuple[str, ...]], Callable]
|
||
|
|
</code></pre>
|
||
|
|
<p>A dict mapping from tuples of a login type identifier (such as <code>m.login.password</code>) and a
|
||
|
|
tuple of field names (such as <code>("password", "secret_thing")</code>) to authentication checking
|
||
|
|
callbacks, which should be of the following form:</p>
|
||
|
|
<pre><code class="language-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]]]
|
||
|
|
]
|
||
|
|
]
|
||
|
|
</code></pre>
|
||
|
|
<p>The login type and field names should be provided by the user in the
|
||
|
|
request to the <code>/login</code> API. <a href="https://matrix.org/docs/spec/client_server/latest#authentication-types">The Matrix specification</a>
|
||
|
|
defines some types, however user defined ones are also allowed.</p>
|
||
|
|
<p>The callback is passed the <code>user</code> field provided by the client (which might not be in
|
||
|
|
<code>@username:server</code> form), the login type, and a dictionary of login secrets passed by
|
||
|
|
the client.</p>
|
||
|
|
<p>If the authentication is successful, the module must return the user's Matrix ID (e.g.
|
||
|
|
<code>@alice:example.com</code>) and optionally a callback to be called with the response to the
|
||
|
|
<code>/login</code> request. If the module doesn't wish to return a callback, it must return <code>None</code>
|
||
|
|
instead.</p>
|
||
|
|
<p>If the authentication is unsuccessful, the module must return <code>None</code>.</p>
|
||
|
|
<p>Note that the user is not automatically registered, the <code>register_user(..)</code> method of
|
||
|
|
the <a href="writing_a_module.html">module API</a> can be used to lazily create users.</p>
|
||
|
|
<p>If multiple modules register an auth checker for the same login type but with different
|
||
|
|
fields, Synapse will refuse to start.</p>
|
||
|
|
<p>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 <code>None</code>, then the
|
||
|
|
authentication fails.</p>
|
||
|
|
<h3 id="check_3pid_auth"><a class="header" href="#check_3pid_auth"><code>check_3pid_auth</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.46.0</em></p>
|
||
|
|
<pre><code class="language-python">async def check_3pid_auth(
|
||
|
|
medium: str,
|
||
|
|
address: str,
|
||
|
|
password: str,
|
||
|
|
) -> Optional[
|
||
|
|
Tuple[
|
||
|
|
str,
|
||
|
|
Optional[Callable[["synapse.module_api.LoginResponse"], Awaitable[None]]]
|
||
|
|
]
|
||
|
|
]
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when a user attempts to register or log in with a third party identifier,
|
||
|
|
such as email. It is passed the medium (eg. <code>email</code>), an address (eg. <code>jdoe@example.com</code>)
|
||
|
|
and the user's password.</p>
|
||
|
|
<p>If the authentication is successful, the module must return the user's Matrix ID (e.g.
|
||
|
|
<code>@alice:example.com</code>) and optionally a callback to be called with the response to the <code>/login</code> request.
|
||
|
|
If the module doesn't wish to return a callback, it must return None instead.</p>
|
||
|
|
<p>If the authentication is unsuccessful, the module must return <code>None</code>.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>None</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>None</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback. If every callback returns <code>None</code>,
|
||
|
|
the authentication is denied.</p>
|
||
|
|
<h3 id="on_logged_out"><a class="header" href="#on_logged_out"><code>on_logged_out</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.46.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_logged_out(
|
||
|
|
user_id: str,
|
||
|
|
device_id: Optional[str],
|
||
|
|
access_token: str
|
||
|
|
) -> None
|
||
|
|
</code></pre>
|
||
|
|
<p>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.</p>
|
||
|
|
<p>Deleting the related pushers is done after calling <code>on_logged_out</code>, so you can rely on them
|
||
|
|
to still be present.</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h3 id="get_username_for_registration"><a class="header" href="#get_username_for_registration"><code>get_username_for_registration</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.52.0</em></p>
|
||
|
|
<pre><code class="language-python">async def get_username_for_registration(
|
||
|
|
uia_results: Dict[str, Any],
|
||
|
|
params: Dict[str, Any],
|
||
|
|
) -> Optional[str]
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when registering a new user. The module can return a username to set for the user
|
||
|
|
being registered by returning it as a string, or <code>None</code> if it doesn't wish to force a
|
||
|
|
username for this user. If a username is returned, it will be used as the local part of a
|
||
|
|
user's full Matrix ID (e.g. it's <code>alice</code> in <code>@alice:example.com</code>).</p>
|
||
|
|
<p>This callback is called once <a href="https://spec.matrix.org/latest/client-server-api/#user-interactive-authentication-api">User-Interactive Authentication</a>
|
||
|
|
has been completed by the user. It is not called when registering a user via SSO. It is
|
||
|
|
passed two dictionaries, which include the information that the user has provided during
|
||
|
|
the registration process.</p>
|
||
|
|
<p>The first dictionary contains the results of the <a href="https://spec.matrix.org/latest/client-server-api/#user-interactive-authentication-api">User-Interactive Authentication</a>
|
||
|
|
flow followed by the user. Its keys are the identifiers of every step involved in the flow,
|
||
|
|
associated with either a boolean value indicating whether the step was correctly completed,
|
||
|
|
or additional information (e.g. email address, phone number...). A list of most existing
|
||
|
|
identifiers can be found in the <a href="https://spec.matrix.org/v1.1/client-server-api/#authentication-types">Matrix specification</a>.
|
||
|
|
Here's an example featuring all currently supported keys:</p>
|
||
|
|
<pre><code class="language-python">{
|
||
|
|
"m.login.dummy": True, # Dummy authentication
|
||
|
|
"m.login.terms": True, # User has accepted the terms of service for the homeserver
|
||
|
|
"m.login.recaptcha": True, # User has completed the recaptcha challenge
|
||
|
|
"m.login.email.identity": { # User has provided and verified an email address
|
||
|
|
"medium": "email",
|
||
|
|
"address": "alice@example.com",
|
||
|
|
"validated_at": 1642701357084,
|
||
|
|
},
|
||
|
|
"m.login.msisdn": { # User has provided and verified a phone number
|
||
|
|
"medium": "msisdn",
|
||
|
|
"address": "33123456789",
|
||
|
|
"validated_at": 1642701357084,
|
||
|
|
},
|
||
|
|
"m.login.registration_token": "sometoken", # User has registered through a registration token
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p>The second dictionary contains the parameters provided by the user's client in the request
|
||
|
|
to <code>/_matrix/client/v3/register</code>. See the <a href="https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3register">Matrix specification</a>
|
||
|
|
for a complete list of these parameters.</p>
|
||
|
|
<p>If the module cannot, or does not wish to, generate a username for this user, it must
|
||
|
|
return <code>None</code>.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>None</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>None</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback. If every callback returns <code>None</code>,
|
||
|
|
the username provided by the user is used, if any (otherwise one is automatically
|
||
|
|
generated).</p>
|
||
|
|
<h3 id="get_displayname_for_registration"><a class="header" href="#get_displayname_for_registration"><code>get_displayname_for_registration</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.54.0</em></p>
|
||
|
|
<pre><code class="language-python">async def get_displayname_for_registration(
|
||
|
|
uia_results: Dict[str, Any],
|
||
|
|
params: Dict[str, Any],
|
||
|
|
) -> Optional[str]
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when registering a new user. The module can return a display name to set for the
|
||
|
|
user being registered by returning it as a string, or <code>None</code> if it doesn't wish to force a
|
||
|
|
display name for this user.</p>
|
||
|
|
<p>This callback is called once <a href="https://spec.matrix.org/latest/client-server-api/#user-interactive-authentication-api">User-Interactive Authentication</a>
|
||
|
|
has been completed by the user. It is not called when registering a user via SSO. It is
|
||
|
|
passed two dictionaries, which include the information that the user has provided during
|
||
|
|
the registration process. These dictionaries are identical to the ones passed to
|
||
|
|
<a href="#get_username_for_registration"><code>get_username_for_registration</code></a>, so refer to the
|
||
|
|
documentation of this callback for more information about them.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>None</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>None</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback. If every callback returns <code>None</code>,
|
||
|
|
the username will be used (e.g. <code>alice</code> if the user being registered is <code>@alice:example.com</code>).</p>
|
||
|
|
<h2 id="is_3pid_allowed"><a class="header" href="#is_3pid_allowed"><code>is_3pid_allowed</code></a></h2>
|
||
|
|
<p><em>First introduced in Synapse v1.53.0</em></p>
|
||
|
|
<pre><code class="language-python">async def is_3pid_allowed(self, medium: str, address: str, registration: bool) -> bool
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when attempting to bind a third-party identifier (i.e. an email address or a phone
|
||
|
|
number). The module is given the medium of the third-party identifier (which is <code>email</code> if
|
||
|
|
the identifier is an email address, or <code>msisdn</code> if the identifier is a phone number) and
|
||
|
|
its address, as well as a boolean indicating whether the attempt to bind is happening as
|
||
|
|
part of registering a new user. The module must return a boolean indicating whether the
|
||
|
|
identifier can be allowed to be bound to an account on the local homeserver.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback.</p>
|
||
|
|
<h2 id="example"><a class="header" href="#example">Example</a></h2>
|
||
|
|
<p>The example module below implements authentication checkers for two different login types: </p>
|
||
|
|
<ul>
|
||
|
|
<li><code>my.login.type</code>
|
||
|
|
<ul>
|
||
|
|
<li>Expects a <code>my_field</code> field to be sent to <code>/login</code></li>
|
||
|
|
<li>Is checked by the method: <code>self.check_my_login</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><code>m.login.password</code> (defined in <a href="https://matrix.org/docs/spec/client_server/latest#password-based">the spec</a>)
|
||
|
|
<ul>
|
||
|
|
<li>Expects a <code>password</code> field to be sent to <code>/login</code></li>
|
||
|
|
<li>Is checked by the method: <code>self.check_pass</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<pre><code class="language-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), None)
|
||
|
|
|
||
|
|
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), None)
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../modules/account_validity_callbacks.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="../modules/background_update_controller_callbacks.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../modules/account_validity_callbacks.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="../modules/background_update_controller_callbacks.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
<script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|