deploy: 472c2c72f6af21504291691e89ac8296bbbef7ea

author: MadLittleMods <MadLittleMods@users.noreply.github.com> 2023-06-27 15:30:28 +0000
committer: MadLittleMods <MadLittleMods@users.noreply.github.com> 2023-06-27 15:30:28 +0000
commit: 0c31d36a941738b77f181f6de37ae168ba7bb5f6 (patch)
tree: f5752111d907972ef2e671b37555d8fb72453958 /v1.87/sso_mapping_providers.html
parent: deploy: 25c55a9d2267b09da3e18090ee538782d6771a27 (diff)
download: synapse-0c31d36a941738b77f181f6de37ae168ba7bb5f6.tar.xz
1 files changed, 446 insertions, 0 deletions
diff --git a/v1.87/sso_mapping_providers.html b/v1.87/sso_mapping_providers.html
new file mode 100644
index 0000000000..1a6eb0a0fe
--- /dev/null
+++ b/v1.87/sso_mapping_providers.html
@@ -0,0 +1,446 @@
+<!DOCTYPE HTML>
+<html lang="en" class="sidebar-visible no-js light">
+    <head>
+        <!-- Book generated using mdBook -->
+        <meta charset="UTF-8">
+        <title>SSO Mapping Providers - 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" class="active">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 "><a href="modules/spam_checker_callbacks.html">Spam checker callbacks</a></li><li class="chapter-item expanded "><a href="modules/third_party_rules_callbacks.html">Third-party rules callbacks</a></li><li class="chapter-item expanded "><a href="modules/presence_router_callbacks.html">Presence router callbacks</a></li><li class="chapter-item expanded "><a href="modules/account_validity_callbacks.html">Account validity callbacks</a></li><li class="chapter-item expanded "><a href="modules/password_auth_provider_callbacks.html">Password auth provider callbacks</a></li><li class="chapter-item expanded "><a href="modules/background_update_controller_callbacks.html">Background update controller callbacks</a></li><li class="chapter-item expanded "><a href="modules/account_data_callbacks.html">Account data callbacks</a></li><li class="chapter-item expanded "><a href="modules/porting_legacy_module.html">Porting a legacy module to the new interface</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="workers.html">Workers</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="synctl_workers.html">Using synctl with Workers</a></li><li class="chapter-item expanded "><a href="systemd-with-workers/index.html">Systemd</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="usage/administration/index.html">Administration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/administration/admin_api/index.html">Admin API</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="admin_api/account_validity.html">Account Validity</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/background_updates.html">Background Updates</a></li><li class="chapter-item expanded "><a href="admin_api/event_reports.html">Event Reports</a></li><li class="chapter-item expanded "><a href="admin_api/experimental_features.html">Experimental Features</a></li><li class="chapter-item expanded "><a href="admin_api/media_admin_api.html">Media</a></li><li class="chapter-item expanded "><a href="admin_api/purge_history_api.html">Purge History</a></li><li class="chapter-item expanded "><a href="admin_api/register_api.html">Register Users</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/registration_tokens.html">Registration Tokens</a></li><li class="chapter-item expanded "><a href="admin_api/room_membership.html">Manipulate Room Membership</a></li><li class="chapter-item expanded "><a href="admin_api/rooms.html">Rooms</a></li><li class="chapter-item expanded "><a href="admin_api/server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="admin_api/statistics.html">Statistics</a></li><li class="chapter-item expanded "><a href="admin_api/user_admin_api.html">Users</a></li><li class="chapter-item expanded "><a href="admin_api/version_api.html">Server Version</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/federation.html">Federation</a></li></ol></li><li class="chapter-item expanded "><a href="manhole.html">Manhole</a></li><li class="chapter-item expanded "><a href="metrics-howto.html">Monitoring</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/administration/monitoring/reporting_homeserver_usage_statistics.html">Reporting Homeserver Usage Statistics</a></li></ol></li><li class="chapter-item expanded "><a href="usage/administration/monthly_active_users.html">Monthly Active Users</a></li><li class="chapter-item expanded "><a href="usage/administration/understanding_synapse_through_grafana_graphs.html">Understanding Synapse Through Grafana Graphs</a></li><li class="chapter-item expanded "><a href="usage/administration/useful_sql_for_admins.html">Useful SQL for Admins</a></li><li class="chapter-item expanded "><a href="usage/administration/database_maintenance_tools.html">Database Maintenance Tools</a></li><li class="chapter-item expanded "><a href="usage/administration/state_groups.html">State Groups</a></li><li class="chapter-item expanded "><a href="usage/administration/request_log.html">Request log format</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_faq.html">Admin FAQ</a></li><li class="chapter-item expanded "><div>Scripts</div></li></ol></li><li class="chapter-item expanded "><li class="part-title">Development</li><li class="chapter-item expanded "><a href="development/contributing_guide.html">Contributing Guide</a></li><li class="chapter-item expanded "><a href="code_style.html">Code Style</a></li><li class="chapter-item expanded "><a href="development/reviews.html">Reviewing Code</a></li><li class="chapter-item expanded "><a href="development/releases.html">Release Cycle</a></li><li class="chapter-item expanded "><a href="development/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/demo.html">Demo scripts</a></li></ol></li><li class="chapter-item expanded "><a href="opentracing.html">OpenTracing</a></li><li class="chapter-item expanded "><a href="development/database_schema.html">Database Schemas</a></li><li class="chapter-item expanded "><a href="development/experimental_features.html">Experimental features</a></li><li class="chapter-item expanded "><a href="development/dependencies.html">Dependency management</a></li><li class="chapter-item expanded "><div>Synapse Architecture</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/synapse_architecture/cancellation.html">Cancellation</a></li><li class="chapter-item expanded "><a href="log_contexts.html">Log Contexts</a></li><li class="chapter-item expanded "><a href="replication.html">Replication</a></li><li class="chapter-item expanded "><a href="tcp_replication.html">TCP Replication</a></li><li class="chapter-item expanded "><a href="development/synapse_architecture/faster_joins.html">Faster remote joins</a></li></ol></li><li class="chapter-item expanded "><a href="development/internal_documentation/index.html">Internal Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single Sign-On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="development/cas.html">CAS</a></li></ol></li><li class="chapter-item expanded "><a href="development/room-dag-concepts.html">Room DAG concepts</a></li><li class="chapter-item expanded "><div>State Resolution</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="auth_chain_difference_algorithm.html">The Auth Chain Difference Algorithm</a></li></ol></li><li class="chapter-item expanded "><a href="media_repository.html">Media Repository</a></li><li class="chapter-item expanded "><a href="room_and_user_statistics.html">Room and User Statistics</a></li></ol></li><li class="chapter-item expanded "><div>Scripts</div></li><li class="chapter-item expanded affix "><li class="part-title">Other</li><li class="chapter-item expanded "><a href="deprecation_policy.html">Dependency Deprecation Policy</a></li><li class="chapter-item expanded "><a href="other/running_synapse_on_single_board_computers.html">Running Synapse on a Single-Board Computer</a></li></ol>
+            </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/sso_mapping_providers.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="sso-mapping-providers"><a class="header" href="#sso-mapping-providers">SSO Mapping Providers</a></h1>
+<p>A mapping provider is a Python class (loaded via a Python module) that
+works out how to map attributes of a SSO response to Matrix-specific
+user attributes. Details such as user ID localpart, displayname, and even avatar
+URLs are all things that can be mapped from talking to a SSO service.</p>
+<p>As an example, a SSO service may return the email address
+&quot;john.smith@example.com&quot; for a user, whereas Synapse will need to figure out how
+to turn that into a displayname when creating a Matrix user for this individual.
+It may choose <code>John Smith</code>, or <code>Smith, John [Example.com]</code> or any number of
+variations. As each Synapse configuration may want something different, this is
+where SAML mapping providers come into play.</p>
+<p>SSO mapping providers are currently supported for OpenID and SAML SSO
+configurations. Please see the details below for how to implement your own.</p>
+<p>It is up to the mapping provider whether the user should be assigned a predefined
+Matrix ID based on the SSO attributes, or if the user should be allowed to
+choose their own username.</p>
+<p>In the first case - where users are automatically allocated a Matrix ID - it is
+the responsibility of the mapping provider to normalise the SSO attributes and
+map them to a valid Matrix ID. The <a href="https://spec.matrix.org/latest/appendices/#user-identifiers">specification for Matrix
+IDs</a> has some
+information about what is considered valid.</p>
+<p>If the mapping provider does not assign a Matrix ID, then Synapse will
+automatically serve an HTML page allowing the user to pick their own username.</p>
+<p>External mapping providers are provided to Synapse in the form of an external
+Python module. You can retrieve this module from <a href="https://pypi.org">PyPI</a> or elsewhere,
+but it must be importable via Synapse (e.g. it must be in the same virtualenv
+as Synapse). The Synapse config is then modified to point to the mapping provider
+(and optionally provide additional configuration for it).</p>
+<h2 id="openid-mapping-providers"><a class="header" href="#openid-mapping-providers">OpenID Mapping Providers</a></h2>
+<p>The OpenID mapping provider can be customized by editing the
+<a href="usage/configuration/config_documentation.html#oidc_providers"><code>oidc_providers.user_mapping_provider.module</code></a>
+config option.</p>
+<p><code>oidc_providers.user_mapping_provider.config</code> allows you to provide custom
+configuration options to the module. Check with the module's documentation for
+what options it provides (if any). The options listed by default are for the
+user mapping provider built in to Synapse. If using a custom module, you should
+comment these options out and use those specified by the module instead.</p>
+<h3 id="building-a-custom-openid-mapping-provider"><a class="header" href="#building-a-custom-openid-mapping-provider">Building a Custom OpenID Mapping Provider</a></h3>
+<p>A custom mapping provider must specify the following methods:</p>
+<ul>
+<li><code>def __init__(self, parsed_config)</code>
+<ul>
+<li>Arguments:
+<ul>
+<li><code>parsed_config</code> - A configuration object that is the return value of the
+<code>parse_config</code> method. You should set any configuration options needed by
+the module here.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li><code>def parse_config(config)</code>
+<ul>
+<li>This method should have the <code>@staticmethod</code> decoration.</li>
+<li>Arguments:
+<ul>
+<li><code>config</code> - A <code>dict</code> representing the parsed content of the
+<code>oidc_providers.user_mapping_provider.config</code> homeserver config option.
+Runs on homeserver startup. Providers should extract and validate
+any option values they need here.</li>
+</ul>
+</li>
+<li>Whatever is returned will be passed back to the user mapping provider module's
+<code>__init__</code> method during construction.</li>
+</ul>
+</li>
+<li><code>def get_remote_user_id(self, userinfo)</code>
+<ul>
+<li>Arguments:
+<ul>
+<li><code>userinfo</code> - A <code>authlib.oidc.core.claims.UserInfo</code> object to extract user
+information from.</li>
+</ul>
+</li>
+<li>This method must return a string, which is the unique, immutable identifier
+for the user. Commonly the <code>sub</code> claim of the response.</li>
+</ul>
+</li>
+<li><code>async def map_user_attributes(self, userinfo, token, failures)</code>
+<ul>
+<li>This method must be async.</li>
+<li>Arguments:
+<ul>
+<li><code>userinfo</code> - An <a href="https://docs.authlib.org/en/latest/specs/oidc.html#authlib.oidc.core.UserInfo"><code>authlib.oidc.core.claims.UserInfo</code></a>
+object to extract user information from.</li>
+<li><code>token</code> - A dictionary which includes information necessary to make
+further requests to the OpenID provider.</li>
+<li><code>failures</code> - An <code>int</code> that represents the amount of times the returned
+mxid localpart mapping has failed.  This should be used
+to create a deduplicated mxid localpart which should be
+returned instead. For example, if this method returns
+<code>john.doe</code> as the value of <code>localpart</code> in the returned
+dict, and that is already taken on the homeserver, this
+method will be called again with the same parameters but
+with failures=1. The method should then return a different
+<code>localpart</code> value, such as <code>john.doe1</code>.</li>
+</ul>
+</li>
+<li>Returns a dictionary with two keys:
+<ul>
+<li><code>localpart</code>: A string, used to generate the Matrix ID. If this is
+<code>None</code>, the user is prompted to pick their own username. This is only used
+during a user's first login. Once a localpart has been associated with a
+remote user ID (see <code>get_remote_user_id</code>) it cannot be updated.</li>
+<li><code>confirm_localpart</code>: A boolean. If set to <code>True</code>, when a <code>localpart</code>
+string is returned from this method, Synapse will prompt the user to
+either accept this localpart or pick their own username. Otherwise this
+option has no effect. If omitted, defaults to <code>False</code>.</li>
+<li><code>display_name</code>: An optional string, the display name for the user.</li>
+<li><code>emails</code>: A list of strings, the email address(es) to associate with
+this user. If omitted, defaults to an empty list.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li><code>async def get_extra_attributes(self, userinfo, token)</code>
+<ul>
+<li>
+<p>This method must be async.</p>
+</li>
+<li>
+<p>Arguments:</p>
+<ul>
+<li><code>userinfo</code> - A <code>authlib.oidc.core.claims.UserInfo</code> object to extract user
+information from.</li>
+<li><code>token</code> - A dictionary which includes information necessary to make
+further requests to the OpenID provider.</li>
+</ul>
+</li>
+<li>
+<p>Returns a dictionary that is suitable to be serialized to JSON. This
+will be returned as part of the response during a successful login.</p>
+<p>Note that care should be taken to not overwrite any of the parameters
+usually returned as part of the <a href="https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3login">login response</a>.</p>
+</li>
+</ul>
+</li>
+</ul>
+<h3 id="default-openid-mapping-provider"><a class="header" href="#default-openid-mapping-provider">Default OpenID Mapping Provider</a></h3>
+<p>Synapse has a built-in OpenID mapping provider if a custom provider isn't
+specified in the config. It is located at
+<a href="https://github.com/matrix-org/synapse/blob/develop/synapse/handlers/oidc.py"><code>synapse.handlers.oidc.JinjaOidcMappingProvider</code></a>.</p>
+<h2 id="saml-mapping-providers"><a class="header" href="#saml-mapping-providers">SAML Mapping Providers</a></h2>
+<p>The SAML mapping provider can be customized by editing the
+<a href="usage/configuration/config_documentation.html#saml2_config"><code>saml2_config.user_mapping_provider.module</code></a>
+config option.</p>
+<p><code>saml2_config.user_mapping_provider.config</code> allows you to provide custom
+configuration options to the module. Check with the module's documentation for
+what options it provides (if any). The options listed by default are for the
+user mapping provider built in to Synapse. If using a custom module, you should
+comment these options out and use those specified by the module instead.</p>
+<h3 id="building-a-custom-saml-mapping-provider"><a class="header" href="#building-a-custom-saml-mapping-provider">Building a Custom SAML Mapping Provider</a></h3>
+<p>A custom mapping provider must specify the following methods:</p>
+<ul>
+<li><code>def __init__(self, parsed_config, module_api)</code>
+<ul>
+<li>Arguments:
+<ul>
+<li><code>parsed_config</code> - A configuration object that is the return value of the
+<code>parse_config</code> method. You should set any configuration options needed by
+the module here.</li>
+<li><code>module_api</code> - a <code>synapse.module_api.ModuleApi</code> object which provides the
+stable API available for extension modules.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li><code>def parse_config(config)</code>
+<ul>
+<li><strong>This method should have the <code>@staticmethod</code> decoration.</strong></li>
+<li>Arguments:
+<ul>
+<li><code>config</code> - A <code>dict</code> representing the parsed content of the
+<code>saml_config.user_mapping_provider.config</code> homeserver config option.
+Runs on homeserver startup. Providers should extract and validate
+any option values they need here.</li>
+</ul>
+</li>
+<li>Whatever is returned will be passed back to the user mapping provider module's
+<code>__init__</code> method during construction.</li>
+</ul>
+</li>
+<li><code>def get_saml_attributes(config)</code>
+<ul>
+<li><strong>This method should have the <code>@staticmethod</code> decoration.</strong></li>
+<li>Arguments:
+<ul>
+<li><code>config</code> - A object resulting from a call to <code>parse_config</code>.</li>
+</ul>
+</li>
+<li>Returns a tuple of two sets. The first set equates to the SAML auth
+response attributes that are required for the module to function, whereas
+the second set consists of those attributes which can be used if available,
+but are not necessary.</li>
+</ul>
+</li>
+<li><code>def get_remote_user_id(self, saml_response, client_redirect_url)</code>
+<ul>
+<li>Arguments:
+<ul>
+<li><code>saml_response</code> - A <code>saml2.response.AuthnResponse</code> object to extract user
+information from.</li>
+<li><code>client_redirect_url</code> - A string, the URL that the client will be
+redirected to.</li>
+</ul>
+</li>
+<li>This method must return a string, which is the unique, immutable identifier
+for the user. Commonly the <code>uid</code> claim of the response.</li>
+</ul>
+</li>
+<li><code>def saml_response_to_user_attributes(self, saml_response, failures, client_redirect_url)</code>
+<ul>
+<li>
+<p>Arguments:</p>
+<ul>
+<li><code>saml_response</code> - A <code>saml2.response.AuthnResponse</code> object to extract user
+information from.</li>
+<li><code>failures</code> - An <code>int</code> that represents the amount of times the returned
+mxid localpart mapping has failed.  This should be used
+to create a deduplicated mxid localpart which should be
+returned instead. For example, if this method returns
+<code>john.doe</code> as the value of <code>mxid_localpart</code> in the returned
+dict, and that is already taken on the homeserver, this
+method will be called again with the same parameters but
+with failures=1. The method should then return a different
+<code>mxid_localpart</code> value, such as <code>john.doe1</code>.</li>
+<li><code>client_redirect_url</code> - A string, the URL that the client will be
+redirected to.</li>
+</ul>
+</li>
+<li>
+<p>This method must return a dictionary, which will then be used by Synapse
+to build a new user. The following keys are allowed:</p>
+<ul>
+<li><code>mxid_localpart</code> - A string, the mxid localpart of the new user. If this is
+<code>None</code>, the user is prompted to pick their own username. This is only used
+during a user's first login. Once a localpart has been associated with a
+remote user ID (see <code>get_remote_user_id</code>) it cannot be updated.</li>
+<li><code>displayname</code> - The displayname of the new user. If not provided, will default to
+the value of <code>mxid_localpart</code>.</li>
+<li><code>emails</code> - A list of emails for the new user. If not provided, will
+default to an empty list.</li>
+</ul>
+<p>Alternatively it can raise a <code>synapse.api.errors.RedirectException</code> to
+redirect the user to another page. This is useful to prompt the user for
+additional information, e.g. if you want them to provide their own username.
+It is the responsibility of the mapping provider to either redirect back
+to <code>client_redirect_url</code> (including any additional information) or to
+complete registration using methods from the <code>ModuleApi</code>.</p>
+</li>
+</ul>
+</li>
+</ul>
+<h3 id="default-saml-mapping-provider"><a class="header" href="#default-saml-mapping-provider">Default SAML Mapping Provider</a></h3>
+<p>Synapse has a built-in SAML mapping provider if a custom provider isn't
+specified in the config. It is located at
+<a href="https://github.com/matrix-org/synapse/blob/develop/synapse/handlers/saml.py"><code>synapse.handlers.saml.DefaultSamlMappingProvider</code></a>.</p>
+
+                    </main>
+
+                    <nav class="nav-wrapper" aria-label="Page navigation">
+                        <!-- Mobile navigation buttons -->
+                            <a rel="prev" href="usage/configuration/user_authentication/single_sign_on/cas.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="password_auth_providers.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="usage/configuration/user_authentication/single_sign_on/cas.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="password_auth_providers.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>
\ No newline at end of file
author	MadLittleMods <MadLittleMods@users.noreply.github.com>	2023-06-27 15:30:28 +0000
committer	MadLittleMods <MadLittleMods@users.noreply.github.com>	2023-06-27 15:30:28 +0000
commit	0c31d36a941738b77f181f6de37ae168ba7bb5f6 (patch)
tree	f5752111d907972ef2e671b37555d8fb72453958 /v1.87/sso_mapping_providers.html
parent	deploy: 25c55a9d2267b09da3e18090ee538782d6771a27 (diff)
download	synapse-0c31d36a941738b77f181f6de37ae168ba7bb5f6.tar.xz