mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-14 11:57:44 +00:00
655 lines
No EOL
39 KiB
HTML
655 lines
No EOL
39 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>OpenID Connect - 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 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 "><a href="MSC1711_certificates_FAQ.html">Upgrading from pre-Synapse 1.0</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/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="usage/configuration/user_authentication/index.html">User Authentication</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="openid.html" class="active">OpenID Connect</a></li><li class="chapter-item expanded "><div>SAML</div></li><li class="chapter-item expanded "><div>CAS</div></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></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="url_previews.html">URL Previews</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.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Third Party Rules</div></li><li class="chapter-item expanded "><a href="spam_checker.html">Spam Checker</a></li><li class="chapter-item expanded "><a href="presence_router_module.html">Presence Router</a></li><li class="chapter-item expanded "><div>Media Storage Providers</div></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="admin_api/delete_group.html">Delete Group</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/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/purge_room.html">Purge Rooms</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="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/shutdown_room.html">Shutdown Room</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></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 class="chapter-item expanded "><a href="usage/administration/request_log.html">Request log format</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/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></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 "><div>Synapse Architecture</div></li><li><ol class="section"><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></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></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/openid.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="configuring-synapse-to-authenticate-against-an-openid-connect-provider"><a class="header" href="#configuring-synapse-to-authenticate-against-an-openid-connect-provider">Configuring Synapse to authenticate against an OpenID Connect provider</a></h1>
|
|
<p>Synapse can be configured to use an OpenID Connect Provider (OP) for
|
|
authentication, instead of its own local password database.</p>
|
|
<p>Any OP should work with Synapse, as long as it supports the authorization code
|
|
flow. There are a few options for that:</p>
|
|
<ul>
|
|
<li>
|
|
<p>start a local OP. Synapse has been tested with <a href="https://www.ory.sh/docs/hydra/">Hydra</a> and
|
|
<a href="https://github.com/dexidp/dex">Dex</a>. Note that for an OP to work, it should be served under a
|
|
secure (HTTPS) origin. A certificate signed with a self-signed, locally
|
|
trusted CA should work. In that case, start Synapse with a <code>SSL_CERT_FILE</code>
|
|
environment variable set to the path of the CA.</p>
|
|
</li>
|
|
<li>
|
|
<p>set up a SaaS OP, like <a href="https://developers.google.com/identity/protocols/oauth2/openid-connect">Google</a>, <a href="https://auth0.com/">Auth0</a> or
|
|
<a href="https://www.okta.com/">Okta</a>. Synapse has been tested with Auth0 and Google.</p>
|
|
</li>
|
|
</ul>
|
|
<p>It may also be possible to use other OAuth2 providers which provide the
|
|
<a href="https://tools.ietf.org/html/rfc6749#section-4.1">authorization code grant type</a>,
|
|
such as <a href="https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps">Github</a>.</p>
|
|
<h2 id="preparing-synapse"><a class="header" href="#preparing-synapse">Preparing Synapse</a></h2>
|
|
<p>The OpenID integration in Synapse uses the
|
|
<a href="https://pypi.org/project/Authlib/"><code>authlib</code></a> library, which must be installed
|
|
as follows:</p>
|
|
<ul>
|
|
<li>
|
|
<p>The relevant libraries are included in the Docker images and Debian packages
|
|
provided by <code>matrix.org</code> so no further action is needed.</p>
|
|
</li>
|
|
<li>
|
|
<p>If you installed Synapse into a virtualenv, run <code>/path/to/env/bin/pip install matrix-synapse[oidc]</code> to install the necessary dependencies.</p>
|
|
</li>
|
|
<li>
|
|
<p>For other installation mechanisms, see the documentation provided by the
|
|
maintainer.</p>
|
|
</li>
|
|
</ul>
|
|
<p>To enable the OpenID integration, you should then add a section to the <code>oidc_providers</code>
|
|
setting in your configuration file (or uncomment one of the existing examples).
|
|
See <a href="./sample_config.yaml">sample_config.yaml</a> for some sample settings, as well as
|
|
the text below for example configurations for specific providers.</p>
|
|
<h2 id="sample-configs"><a class="header" href="#sample-configs">Sample configs</a></h2>
|
|
<p>Here are a few configs for providers that should work with Synapse.</p>
|
|
<h3 id="microsoft-azure-active-directory"><a class="header" href="#microsoft-azure-active-directory">Microsoft Azure Active Directory</a></h3>
|
|
<p>Azure AD can act as an OpenID Connect Provider. Register a new application under
|
|
<em>App registrations</em> in the Azure AD management console. The RedirectURI for your
|
|
application should point to your matrix server:
|
|
<code>[synapse public baseurl]/_synapse/client/oidc/callback</code></p>
|
|
<p>Go to <em>Certificates & secrets</em> and register a new client secret. Make note of your
|
|
Directory (tenant) ID as it will be used in the Azure links.
|
|
Edit your Synapse config file and change the <code>oidc_config</code> section:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: microsoft
|
|
idp_name: Microsoft
|
|
issuer: "https://login.microsoftonline.com/<tenant id>/v2.0"
|
|
client_id: "<client id>"
|
|
client_secret: "<client secret>"
|
|
scopes: ["openid", "profile"]
|
|
authorization_endpoint: "https://login.microsoftonline.com/<tenant id>/oauth2/v2.0/authorize"
|
|
token_endpoint: "https://login.microsoftonline.com/<tenant id>/oauth2/v2.0/token"
|
|
userinfo_endpoint: "https://graph.microsoft.com/oidc/userinfo"
|
|
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.preferred_username.split('@')[0] }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<h3 id="a-hrefhttpsgithubcomdexidpdexdexa"><a class="header" href="#a-hrefhttpsgithubcomdexidpdexdexa"><a href="https://github.com/dexidp/dex">Dex</a></a></h3>
|
|
<p><a href="https://github.com/dexidp/dex">Dex</a> is a simple, open-source, certified OpenID Connect Provider.
|
|
Although it is designed to help building a full-blown provider with an
|
|
external database, it can be configured with static passwords in a config file.</p>
|
|
<p>Follow the <a href="https://dexidp.io/docs/getting-started/">Getting Started guide</a>
|
|
to install Dex.</p>
|
|
<p>Edit <code>examples/config-dev.yaml</code> config file from the Dex repo to add a client:</p>
|
|
<pre><code class="language-yaml">staticClients:
|
|
- id: synapse
|
|
secret: secret
|
|
redirectURIs:
|
|
- '[synapse public baseurl]/_synapse/client/oidc/callback'
|
|
name: 'Synapse'
|
|
</code></pre>
|
|
<p>Run with <code>dex serve examples/config-dev.yaml</code>.</p>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: dex
|
|
idp_name: "My Dex server"
|
|
skip_verification: true # This is needed as Dex is served on an insecure endpoint
|
|
issuer: "http://127.0.0.1:5556/dex"
|
|
client_id: "synapse"
|
|
client_secret: "secret"
|
|
scopes: ["openid", "profile"]
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.name }}"
|
|
display_name_template: "{{ user.name|capitalize }}"
|
|
</code></pre>
|
|
<h3 id="a-hrefhttpswwwkeycloakorgdocslatestserver_adminsso-protocolskeycloaka"><a class="header" href="#a-hrefhttpswwwkeycloakorgdocslatestserver_adminsso-protocolskeycloaka"><a href="https://www.keycloak.org/docs/latest/server_admin/#sso-protocols">Keycloak</a></a></h3>
|
|
<p><a href="https://www.keycloak.org/docs/latest/server_admin/#sso-protocols">Keycloak</a> is an opensource IdP maintained by Red Hat.</p>
|
|
<p>Follow the <a href="https://www.keycloak.org/getting-started">Getting Started Guide</a> to install Keycloak and set up a realm.</p>
|
|
<ol>
|
|
<li>
|
|
<p>Click <code>Clients</code> in the sidebar and click <code>Create</code></p>
|
|
</li>
|
|
<li>
|
|
<p>Fill in the fields as below:</p>
|
|
</li>
|
|
</ol>
|
|
<table><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody>
|
|
<tr><td>Client ID</td><td><code>synapse</code></td></tr>
|
|
<tr><td>Client Protocol</td><td><code>openid-connect</code></td></tr>
|
|
</tbody></table>
|
|
<ol start="3">
|
|
<li>Click <code>Save</code></li>
|
|
<li>Fill in the fields as below:</li>
|
|
</ol>
|
|
<table><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody>
|
|
<tr><td>Client ID</td><td><code>synapse</code></td></tr>
|
|
<tr><td>Enabled</td><td><code>On</code></td></tr>
|
|
<tr><td>Client Protocol</td><td><code>openid-connect</code></td></tr>
|
|
<tr><td>Access Type</td><td><code>confidential</code></td></tr>
|
|
<tr><td>Valid Redirect URIs</td><td><code>[synapse public baseurl]/_synapse/client/oidc/callback</code></td></tr>
|
|
</tbody></table>
|
|
<ol start="5">
|
|
<li>Click <code>Save</code></li>
|
|
<li>On the Credentials tab, update the fields:</li>
|
|
</ol>
|
|
<table><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody>
|
|
<tr><td>Client Authenticator</td><td><code>Client ID and Secret</code></td></tr>
|
|
</tbody></table>
|
|
<ol start="7">
|
|
<li>Click <code>Regenerate Secret</code></li>
|
|
<li>Copy Secret</li>
|
|
</ol>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: keycloak
|
|
idp_name: "My KeyCloak server"
|
|
issuer: "https://127.0.0.1:8443/auth/realms/{realm_name}"
|
|
client_id: "synapse"
|
|
client_secret: "copy secret generated from above"
|
|
scopes: ["openid", "profile"]
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.preferred_username }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<h3 id="a-hrefhttpsauth0comauth0a"><a class="header" href="#a-hrefhttpsauth0comauth0a"><a href="https://auth0.com/">Auth0</a></a></h3>
|
|
<ol>
|
|
<li>
|
|
<p>Create a regular web application for Synapse</p>
|
|
</li>
|
|
<li>
|
|
<p>Set the Allowed Callback URLs to <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></p>
|
|
</li>
|
|
<li>
|
|
<p>Add a rule to add the <code>preferred_username</code> claim.</p>
|
|
<details>
|
|
<summary>Code sample</summary>
|
|
<pre><code class="language-js">function addPersistenceAttribute(user, context, callback) {
|
|
user.user_metadata = user.user_metadata || {};
|
|
user.user_metadata.preferred_username = user.user_metadata.preferred_username || user.user_id;
|
|
context.idToken.preferred_username = user.user_metadata.preferred_username;
|
|
|
|
auth0.users.updateUserMetadata(user.user_id, user.user_metadata)
|
|
.then(function(){
|
|
callback(null, user, context);
|
|
})
|
|
.catch(function(err){
|
|
callback(err);
|
|
});
|
|
}
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
</details>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: auth0
|
|
idp_name: Auth0
|
|
issuer: "https://your-tier.eu.auth0.com/" # TO BE FILLED
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
scopes: ["openid", "profile"]
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.preferred_username }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<h3 id="github"><a class="header" href="#github">GitHub</a></h3>
|
|
<p>GitHub is a bit special as it is not an OpenID Connect compliant provider, but
|
|
just a regular OAuth2 provider.</p>
|
|
<p>The <a href="https://developer.github.com/v3/users/#get-the-authenticated-user"><code>/user</code> API endpoint</a>
|
|
can be used to retrieve information on the authenticated user. As the Synapse
|
|
login mechanism needs an attribute to uniquely identify users, and that endpoint
|
|
does not return a <code>sub</code> property, an alternative <code>subject_claim</code> has to be set.</p>
|
|
<ol>
|
|
<li>Create a new OAuth application: https://github.com/settings/applications/new.</li>
|
|
<li>Set the callback URL to <code>[synapse public baseurl]/_synapse/client/oidc/callback</code>.</li>
|
|
</ol>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: github
|
|
idp_name: Github
|
|
idp_brand: "github" # optional: styling hint for clients
|
|
discover: false
|
|
issuer: "https://github.com/"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
authorization_endpoint: "https://github.com/login/oauth/authorize"
|
|
token_endpoint: "https://github.com/login/oauth/access_token"
|
|
userinfo_endpoint: "https://api.github.com/user"
|
|
scopes: ["read:user"]
|
|
user_mapping_provider:
|
|
config:
|
|
subject_claim: "id"
|
|
localpart_template: "{{ user.login }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<h3 id="a-hrefhttpsdevelopersgooglecomidentityprotocolsoauth2openid-connectgooglea"><a class="header" href="#a-hrefhttpsdevelopersgooglecomidentityprotocolsoauth2openid-connectgooglea"><a href="https://developers.google.com/identity/protocols/oauth2/openid-connect">Google</a></a></h3>
|
|
<ol>
|
|
<li>Set up a project in the Google API Console (see
|
|
https://developers.google.com/identity/protocols/oauth2/openid-connect#appsetup).</li>
|
|
<li>add an "OAuth Client ID" for a Web Application under "Credentials".</li>
|
|
<li>Copy the Client ID and Client Secret, and add the following to your synapse config:
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: google
|
|
idp_name: Google
|
|
idp_brand: "google" # optional: styling hint for clients
|
|
issuer: "https://accounts.google.com/"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
scopes: ["openid", "profile"]
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.given_name|lower }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
</li>
|
|
<li>Back in the Google console, add this Authorized redirect URI: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code>.</li>
|
|
</ol>
|
|
<h3 id="twitch"><a class="header" href="#twitch">Twitch</a></h3>
|
|
<ol>
|
|
<li>Setup a developer account on <a href="https://dev.twitch.tv/">Twitch</a></li>
|
|
<li>Obtain the OAuth 2.0 credentials by <a href="https://dev.twitch.tv/console/apps/">creating an app</a></li>
|
|
<li>Add this OAuth Redirect URL: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
|
</ol>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: twitch
|
|
idp_name: Twitch
|
|
issuer: "https://id.twitch.tv/oauth2/"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
client_auth_method: "client_secret_post"
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.preferred_username }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<h3 id="gitlab"><a class="header" href="#gitlab">GitLab</a></h3>
|
|
<ol>
|
|
<li>Create a <a href="https://gitlab.com/profile/applications">new application</a>.</li>
|
|
<li>Add the <code>read_user</code> and <code>openid</code> scopes.</li>
|
|
<li>Add this Callback URL: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
|
</ol>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: gitlab
|
|
idp_name: Gitlab
|
|
idp_brand: "gitlab" # optional: styling hint for clients
|
|
issuer: "https://gitlab.com/"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
client_auth_method: "client_secret_post"
|
|
scopes: ["openid", "read_user"]
|
|
user_profile_method: "userinfo_endpoint"
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: '{{ user.nickname }}'
|
|
display_name_template: '{{ user.name }}'
|
|
</code></pre>
|
|
<h3 id="facebook"><a class="header" href="#facebook">Facebook</a></h3>
|
|
<p>Like Github, Facebook provide a custom OAuth2 API rather than an OIDC-compliant
|
|
one so requires a little more configuration.</p>
|
|
<ol start="0">
|
|
<li>You will need a Facebook developer account. You can register for one
|
|
<a href="https://developers.facebook.com/async/registration/">here</a>.</li>
|
|
<li>On the <a href="https://developers.facebook.com/apps/">apps</a> page of the developer
|
|
console, "Create App", and choose "Build Connected Experiences".</li>
|
|
<li>Once the app is created, add "Facebook Login" and choose "Web". You don't
|
|
need to go through the whole form here.</li>
|
|
<li>In the left-hand menu, open "Products"/"Facebook Login"/"Settings".
|
|
<ul>
|
|
<li>Add <code>[synapse public baseurl]/_synapse/client/oidc/callback</code> as an OAuth Redirect
|
|
URL.</li>
|
|
</ul>
|
|
</li>
|
|
<li>In the left-hand menu, open "Settings/Basic". Here you can copy the "App ID"
|
|
and "App Secret" for use below.</li>
|
|
</ol>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml"> - idp_id: facebook
|
|
idp_name: Facebook
|
|
idp_brand: "facebook" # optional: styling hint for clients
|
|
discover: false
|
|
issuer: "https://facebook.com"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
scopes: ["openid", "email"]
|
|
authorization_endpoint: https://facebook.com/dialog/oauth
|
|
token_endpoint: https://graph.facebook.com/v9.0/oauth/access_token
|
|
user_profile_method: "userinfo_endpoint"
|
|
userinfo_endpoint: "https://graph.facebook.com/v9.0/me?fields=id,name,email,picture"
|
|
user_mapping_provider:
|
|
config:
|
|
subject_claim: "id"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<p>Relevant documents:</p>
|
|
<ul>
|
|
<li>https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow</li>
|
|
<li>Using Facebook's Graph API: https://developers.facebook.com/docs/graph-api/using-graph-api/</li>
|
|
<li>Reference to the User endpoint: https://developers.facebook.com/docs/graph-api/reference/user</li>
|
|
</ul>
|
|
<h3 id="gitea"><a class="header" href="#gitea">Gitea</a></h3>
|
|
<p>Gitea is, like Github, not an OpenID provider, but just an OAuth2 provider.</p>
|
|
<p>The <a href="https://try.gitea.io/api/swagger#/user/userGetCurrent"><code>/user</code> API endpoint</a>
|
|
can be used to retrieve information on the authenticated user. As the Synapse
|
|
login mechanism needs an attribute to uniquely identify users, and that endpoint
|
|
does not return a <code>sub</code> property, an alternative <code>subject_claim</code> has to be set.</p>
|
|
<ol>
|
|
<li>Create a new application.</li>
|
|
<li>Add this Callback URL: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
|
</ol>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: gitea
|
|
idp_name: Gitea
|
|
discover: false
|
|
issuer: "https://your-gitea.com/"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_secret: "your-client-secret" # TO BE FILLED
|
|
client_auth_method: client_secret_post
|
|
scopes: [] # Gitea doesn't support Scopes
|
|
authorization_endpoint: "https://your-gitea.com/login/oauth/authorize"
|
|
token_endpoint: "https://your-gitea.com/login/oauth/access_token"
|
|
userinfo_endpoint: "https://your-gitea.com/api/v1/user"
|
|
user_mapping_provider:
|
|
config:
|
|
subject_claim: "id"
|
|
localpart_template: "{{ user.login }}"
|
|
display_name_template: "{{ user.full_name }}"
|
|
</code></pre>
|
|
<h3 id="xwiki"><a class="header" href="#xwiki">XWiki</a></h3>
|
|
<p>Install <a href="https://extensions.xwiki.org/xwiki/bin/view/Extension/OpenID%20Connect/OpenID%20Connect%20Provider/">OpenID Connect Provider</a> extension in your <a href="https://www.xwiki.org">XWiki</a> instance.</p>
|
|
<p>Synapse config:</p>
|
|
<pre><code class="language-yaml">oidc_providers:
|
|
- idp_id: xwiki
|
|
idp_name: "XWiki"
|
|
issuer: "https://myxwikihost/xwiki/oidc/"
|
|
client_id: "your-client-id" # TO BE FILLED
|
|
client_auth_method: none
|
|
scopes: ["openid", "profile"]
|
|
user_profile_method: "userinfo_endpoint"
|
|
user_mapping_provider:
|
|
config:
|
|
localpart_template: "{{ user.preferred_username }}"
|
|
display_name_template: "{{ user.name }}"
|
|
</code></pre>
|
|
<h3 id="apple"><a class="header" href="#apple">Apple</a></h3>
|
|
<p>Configuring "Sign in with Apple" (SiWA) requires an Apple Developer account.</p>
|
|
<p>You will need to create a new "Services ID" for SiWA, and create and download a
|
|
private key with "SiWA" enabled.</p>
|
|
<p>As well as the private key file, you will need:</p>
|
|
<ul>
|
|
<li>Client ID: the "identifier" you gave the "Services ID"</li>
|
|
<li>Team ID: a 10-character ID associated with your developer account.</li>
|
|
<li>Key ID: the 10-character identifier for the key.</li>
|
|
</ul>
|
|
<p>https://help.apple.com/developer-account/?lang=en#/dev77c875b7e has more
|
|
documentation on setting up SiWA.</p>
|
|
<p>The synapse config will look like this:</p>
|
|
<pre><code class="language-yaml"> - idp_id: apple
|
|
idp_name: Apple
|
|
issuer: "https://appleid.apple.com"
|
|
client_id: "your-client-id" # Set to the "identifier" for your "ServicesID"
|
|
client_auth_method: "client_secret_post"
|
|
client_secret_jwt_key:
|
|
key_file: "/path/to/AuthKey_KEYIDCODE.p8" # point to your key file
|
|
jwt_header:
|
|
alg: ES256
|
|
kid: "KEYIDCODE" # Set to the 10-char Key ID
|
|
jwt_payload:
|
|
iss: TEAMIDCODE # Set to the 10-char Team ID
|
|
scopes: ["name", "email", "openid"]
|
|
authorization_endpoint: https://appleid.apple.com/auth/authorize?response_mode=form_post
|
|
user_mapping_provider:
|
|
config:
|
|
email_template: "{{ user.email }}"
|
|
</code></pre>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
|
|
<a rel="prev" href="usage/configuration/user_authentication/index.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="sso_mapping_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/index.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="sso_mapping_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> |