mirror of
https://github.com/element-hq/synapse.git
synced 2026-03-30 19:25:46 +00:00
971 lines
59 KiB
HTML
971 lines
59 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>OpenID Connect - Synapse</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<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-de23e50b.svg">
|
||
<link rel="shortcut icon" href="favicon-8114d1fc.png">
|
||
<link rel="stylesheet" href="css/variables-8adf115d.css">
|
||
<link rel="stylesheet" href="css/general-2459343d.css">
|
||
<link rel="stylesheet" href="css/chrome-ae938929.css">
|
||
<link rel="stylesheet" href="css/print-9e4910d8.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="fonts/fonts-9644e21d.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" id="mdbook-highlight-css" href="highlight-493f70e1.css">
|
||
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="tomorrow-night-4c0ae647.css">
|
||
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="ayu-highlight-3fdfc3ac.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
<link rel="stylesheet" href="docs/website_files/indent-section-headers-3390f960.css">
|
||
<link rel="stylesheet" href="docs/website_files/version-picker-ddc5216e.css">
|
||
|
||
|
||
<!-- Provide site root and default themes to javascript -->
|
||
<script>
|
||
const path_to_root = "";
|
||
const default_light_theme = "light";
|
||
const default_dark_theme = "navy";
|
||
window.path_to_searchindex_js = "searchindex-b358e032.js";
|
||
</script>
|
||
<!-- Start loading toc.js asap -->
|
||
<script src="toc-4dc10a98.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="mdbook-help-container">
|
||
<div id="mdbook-help-popup">
|
||
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
<div>
|
||
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
<p>Press <kbd>?</kbd> to show this help</p>
|
||
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="mdbook-body-container">
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script>
|
||
try {
|
||
let theme = localStorage.getItem('mdbook-theme');
|
||
let 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>
|
||
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
let theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
const html = document.documentElement;
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add("js");
|
||
</script>
|
||
|
||
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script>
|
||
let sidebar = null;
|
||
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
} else {
|
||
sidebar = 'hidden';
|
||
sidebar_toggle.checked = false;
|
||
}
|
||
if (sidebar === 'visible') {
|
||
sidebar_toggle.checked = true;
|
||
} else {
|
||
html.classList.remove('sidebar-visible');
|
||
}
|
||
</script>
|
||
|
||
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
|
||
<!-- populated by js -->
|
||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
<noscript>
|
||
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
||
</noscript>
|
||
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
|
||
<div class="sidebar-resize-indicator"></div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div id="mdbook-page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
<div id="mdbook-menu-bar-hover-placeholder"></div>
|
||
<div id="mdbook-menu-bar" class="menu-bar sticky">
|
||
<div class="left-buttons">
|
||
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
|
||
</label>
|
||
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
|
||
</button>
|
||
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
|
||
</button>
|
||
</div>
|
||
|
||
<!-- BEGIN CUSTOM SYNAPSE MODIFICATIONS -->
|
||
<div class="version-picker">
|
||
<div class="dropdown">
|
||
<div class="select">
|
||
<span></span>
|
||
<i class="fa fa-chevron-down"></i>
|
||
</div>
|
||
<input type="hidden" name="version">
|
||
<ul class="dropdown-menu">
|
||
<!-- Versions will be added dynamically in version-picker.js -->
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<!-- END CUSTOM SYNAPSE MODIFICATIONS -->
|
||
|
||
<h1 class="menu-title">Synapse</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/element-hq/synapse/edit/develop/docs/openid.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
|
||
<span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="mdbook-search-wrapper" class="hidden">
|
||
<form id="mdbook-searchbar-outer" class="searchbar-outer">
|
||
<div class="search-wrapper">
|
||
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
|
||
<div class="spinner-wrapper">
|
||
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
|
||
<ul id="mdbook-searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script>
|
||
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="mdbook-content" class="content">
|
||
<main>
|
||
<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.
|
||
See the <a href="usage/configuration/config_documentation.html#oidc_providers">configuration manual</a> for some sample settings, as well as
|
||
the text below for example configurations for specific providers.</p>
|
||
<p>For setups using <a href="delegate.html"><code>.well-known</code> delegation</a>, make sure
|
||
<a href="usage/configuration/config_documentation.html#public_baseurl"><code>public_baseurl</code></a> is set
|
||
appropriately. If unset, Synapse defaults to <code>https://<server_name>/</code> which is used in
|
||
the OIDC callback URL.</p>
|
||
<h2 id="oidc-back-channel-logout"><a class="header" href="#oidc-back-channel-logout">OIDC Back-Channel Logout</a></h2>
|
||
<p>Synapse supports receiving <a href="https://openid.net/specs/openid-connect-backchannel-1_0.html">OpenID Connect Back-Channel Logout</a> notifications.</p>
|
||
<p>This lets the OpenID Connect Provider notify Synapse when a user logs out, so that Synapse can end that user session.
|
||
This feature can be enabled by setting the <code>backchannel_logout_enabled</code> property to <code>true</code> in the provider configuration, and setting the following URL as destination for Back-Channel Logout notifications in your OpenID Connect Provider: <code>[synapse public baseurl]/_synapse/client/oidc/backchannel_logout</code></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="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><a href="https://help.apple.com/developer-account/?lang=en#/dev77c875b7e">Apple’s developer documentation</a>
|
||
has more information 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>
|
||
<h3 id="auth0"><a class="header" href="#auth0">Auth0</a></h3>
|
||
<p><a href="https://auth0.com/">Auth0</a> is a hosted SaaS IdP solution.</p>
|
||
<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 with any name to add the <code>preferred_username</code> claim.
|
||
(See https://auth0.com/docs/customize/rules/create-rules for more information on how to create rules.)</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>
|
||
</details></li>
|
||
</ol>
|
||
|
||
<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="authentik"><a class="header" href="#authentik">Authentik</a></h3>
|
||
<p><a href="https://goauthentik.io/">Authentik</a> is an open-source IdP solution.</p>
|
||
<ol>
|
||
<li>Create a provider in Authentik, with type OAuth2/OpenID.</li>
|
||
<li>The parameters are:</li>
|
||
</ol>
|
||
<ul>
|
||
<li>Client Type: Confidential</li>
|
||
<li>JWT Algorithm: RS256</li>
|
||
<li>Scopes: OpenID, Email and Profile</li>
|
||
<li>RSA Key: Select any available key</li>
|
||
<li>Redirect URIs: <code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
||
</ul>
|
||
<ol start="3">
|
||
<li>Create an application for synapse in Authentik and link it to the provider.</li>
|
||
<li>Note the slug of your application, Client ID and Client Secret.</li>
|
||
</ol>
|
||
<p>Note: RSA keys must be used for signing for Authentik, ECC keys do not work.
|
||
Note: The provider must have a signing key set and must not use an encryption key.</p>
|
||
<p>Synapse config:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: authentik
|
||
idp_name: authentik
|
||
discover: true
|
||
issuer: "https://your.authentik.example.org/application/o/your-app-slug/" # TO BE FILLED: domain and slug
|
||
client_id: "your client id" # TO BE FILLED
|
||
client_secret: "your client secret" # TO BE FILLED
|
||
scopes:
|
||
- "openid"
|
||
- "profile"
|
||
- "email"
|
||
user_mapping_provider:
|
||
config:
|
||
localpart_template: "{{ user.preferred_username }}"
|
||
display_name_template: "{{ user.preferred_username|capitalize }}" # TO BE FILLED: If your users have names in Authentik and you want those in Synapse, this should be replaced with user.name|capitalize.
|
||
[...]
|
||
jwt_config:
|
||
enabled: true
|
||
secret: "your client secret" # TO BE FILLED (same as `client_secret` above)
|
||
algorithm: "RS256"
|
||
# (...other fields)
|
||
</code></pre>
|
||
<h3 id="dex"><a class="header" href="#dex">Dex</a></h3>
|
||
<p><a href="https://github.com/dexidp/dex">Dex</a> is a simple, open-source 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="django-oauth-toolkit"><a class="header" href="#django-oauth-toolkit">Django OAuth Toolkit</a></h3>
|
||
<p><a href="https://github.com/jazzband/django-oauth-toolkit">django-oauth-toolkit</a> is a
|
||
Django application providing out of the box all the endpoints, data and logic
|
||
needed to add OAuth2 capabilities to your Django projects. It supports
|
||
<a href="https://django-oauth-toolkit.readthedocs.io/en/latest/oidc.html">OpenID Connect too</a>.</p>
|
||
<p>Configuration on Django’s side:</p>
|
||
<ol>
|
||
<li>Add an application: <code>https://example.com/admin/oauth2_provider/application/add/</code> and choose parameters like this:</li>
|
||
</ol>
|
||
<ul>
|
||
<li><code>Redirect uris</code>: <code>https://synapse.example.com/_synapse/client/oidc/callback</code></li>
|
||
<li><code>Client type</code>: <code>Confidential</code></li>
|
||
<li><code>Authorization grant type</code>: <code>Authorization code</code></li>
|
||
<li><code>Algorithm</code>: <code>HMAC with SHA-2 256</code></li>
|
||
</ul>
|
||
<ol start="2">
|
||
<li>
|
||
<p>You can <a href="https://django-oauth-toolkit.readthedocs.io/en/latest/oidc.html#customizing-the-oidc-responses">customize the claims</a> Django gives to synapse (optional):</p>
|
||
<details>
|
||
<summary>Code sample</summary>
|
||
<pre><code class="language-python">class CustomOAuth2Validator(OAuth2Validator):
|
||
|
||
def get_additional_claims(self, request):
|
||
return {
|
||
"sub": request.user.email,
|
||
"email": request.user.email,
|
||
"first_name": request.user.first_name,
|
||
"last_name": request.user.last_name,
|
||
}
|
||
</code></pre>
|
||
</details>
|
||
</li>
|
||
</ol>
|
||
<p>Your synapse config is then:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: django_example
|
||
idp_name: "Django Example"
|
||
issuer: "https://example.com/o/"
|
||
client_id: "your-client-id" # CHANGE ME
|
||
client_secret: "your-client-secret" # CHANGE ME
|
||
scopes: ["openid"]
|
||
user_profile_method: "userinfo_endpoint" # needed because oauth-toolkit does not include user information in the authorization response
|
||
user_mapping_provider:
|
||
config:
|
||
localpart_template: "{{ user.email.split('@')[0] }}"
|
||
display_name_template: "{{ user.first_name }} {{ user.last_name }}"
|
||
email_template: "{{ user.email }}"
|
||
</code></pre>
|
||
<h3 id="facebook"><a class="header" href="#facebook">Facebook</a></h3>
|
||
<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://www.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"
|
||
jwks_uri: "https://www.facebook.com/.well-known/oauth/openid/jwks/"
|
||
user_mapping_provider:
|
||
config:
|
||
display_name_template: "{{ user.name }}"
|
||
email_template: "{{ user.email }}"
|
||
</code></pre>
|
||
<p>Relevant documents:</p>
|
||
<ul>
|
||
<li><a href="https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow">Manually Build a Login Flow</a></li>
|
||
<li><a href="https://developers.facebook.com/docs/graph-api/using-graph-api/">Using Facebook’s Graph API</a></li>
|
||
<li><a href="https://developers.facebook.com/docs/graph-api/reference/user">Reference to the User endpoint</a></li>
|
||
</ul>
|
||
<p>Facebook do have an <a href="https://www.facebook.com/.well-known/openid-configuration">OIDC discovery endpoint</a>,
|
||
but it has a <code>response_types_supported</code> which excludes “code” (which we rely on, and
|
||
is even mentioned in their <a href="https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow#login">documentation</a>),
|
||
so we have to disable discovery and configure the URIs manually.</p>
|
||
<h3 id="forgejo"><a class="header" href="#forgejo">Forgejo</a></h3>
|
||
<p>Forgejo is a fork of Gitea that can act as an OAuth2 provider.</p>
|
||
<p>The implementation of OAuth2 is improved compared to Gitea, as it provides a correctly defined <code>subject_claim</code> and <code>scopes</code>.</p>
|
||
<p>Synapse config:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: forgejo
|
||
idp_name: Forgejo
|
||
discover: false
|
||
issuer: "https://your-forgejo.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", "profile", "email", "groups"]
|
||
authorization_endpoint: "https://your-forgejo.com/login/oauth/authorize"
|
||
token_endpoint: "https://your-forgejo.com/login/oauth/access_token"
|
||
userinfo_endpoint: "https://your-forgejo.com/api/v1/user"
|
||
user_mapping_provider:
|
||
config:
|
||
subject_claim: "sub"
|
||
picture_claim: "picture"
|
||
localpart_template: "{{ user.preferred_username }}"
|
||
display_name_template: "{{ user.name }}"
|
||
email_template: "{{ user.email }}"
|
||
</code></pre>
|
||
<h3 id="github"><a class="header" href="#github">GitHub</a></h3>
|
||
<p><a href="https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps">GitHub</a> 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: <a href="https://github.com/settings/applications/new">https://github.com/settings/applications/new</a>.</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="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="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="google"><a class="header" href="#google">Google</a></h3>
|
||
<p><a href="https://developers.google.com/identity/protocols/oauth2/openid-connect">Google</a> is an OpenID certified authentication and authorisation provider.</p>
|
||
<ol>
|
||
<li>Set up a project in the Google API Console (see
|
||
<a href="https://developers.google.com/identity/protocols/oauth2/openid-connect#appsetup">documentation</a>).</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", "email"] # email is optional, read below
|
||
user_mapping_provider:
|
||
config:
|
||
localpart_template: "{{ user.given_name|lower }}"
|
||
display_name_template: "{{ user.name }}"
|
||
email_template: "{{ user.email }}" # needs "email" in scopes above
|
||
</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="keycloak"><a class="header" href="#keycloak">Keycloak</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>Keycloak supports OIDC Back-Channel Logout, which sends logout notification to Synapse, so that Synapse users get logged out when they log out from Keycloak.
|
||
This can be optionally enabled by setting <code>backchannel_logout_enabled</code> to <code>true</code> in the Synapse configuration, and by setting the “Backchannel Logout URL” in Keycloak.</p>
|
||
<p>Follow the <a href="https://www.keycloak.org/guides">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>
|
||
<div class="table-wrapper">
|
||
<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>
|
||
</div>
|
||
<ol start="3">
|
||
<li>Click <code>Save</code></li>
|
||
<li>Fill in the fields as below:</li>
|
||
</ol>
|
||
<div class="table-wrapper">
|
||
<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>
|
||
<tr><td>Backchannel Logout URL (optional)</td><td> <code>[synapse public baseurl]/_synapse/client/oidc/backchannel_logout</code></td></tr>
|
||
<tr><td>Backchannel Logout Session Required (optional)</td><td> <code>On</code></td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<ol start="5">
|
||
<li>Click <code>Save</code></li>
|
||
<li>On the Credentials tab, update the fields:</li>
|
||
</ol>
|
||
<div class="table-wrapper">
|
||
<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>
|
||
</div>
|
||
<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/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 }}"
|
||
backchannel_logout_enabled: true # Optional
|
||
</code></pre>
|
||
<h3 id="lemonldap"><a class="header" href="#lemonldap">LemonLDAP</a></h3>
|
||
<p><a href="https://lemonldap-ng.org/">LemonLDAP::NG</a> is an open-source IdP solution.</p>
|
||
<ol>
|
||
<li>Create an OpenID Connect Relying Parties in LemonLDAP::NG</li>
|
||
<li>The parameters are:</li>
|
||
</ol>
|
||
<ul>
|
||
<li>Client ID under the basic menu of the new Relying Parties (<code>Options > Basic > Client ID</code>)</li>
|
||
<li>Client secret (<code>Options > Basic > Client secret</code>)</li>
|
||
<li>JWT Algorithm: RS256 within the security menu of the new Relying Parties
|
||
(<code>Options > Security > ID Token signature algorithm</code> and <code>Options > Security > Access Token signature algorithm</code>)</li>
|
||
<li>Scopes: OpenID, Email and Profile</li>
|
||
<li>Force claims into <code>id_token</code>
|
||
(<code>Options > Advanced > Force claims to be returned in ID Token</code>)</li>
|
||
<li>Allowed redirection addresses for login (<code>Options > Basic > Allowed redirection addresses for login</code> ) :
|
||
<code>[synapse public baseurl]/_synapse/client/oidc/callback</code></li>
|
||
</ul>
|
||
<p>Synapse config:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: lemonldap
|
||
idp_name: lemonldap
|
||
discover: true
|
||
issuer: "https://auth.example.org/" # TO BE FILLED: replace with your domain
|
||
client_id: "your client id" # TO BE FILLED
|
||
client_secret: "your client secret" # TO BE FILLED
|
||
scopes:
|
||
- "openid"
|
||
- "profile"
|
||
- "email"
|
||
user_mapping_provider:
|
||
config:
|
||
localpart_template: "{{ user.preferred_username }}}"
|
||
# TO BE FILLED: If your users have names in LemonLDAP::NG and you want those in Synapse, this should be replaced with user.name|capitalize or any valid filter.
|
||
display_name_template: "{{ user.preferred_username|capitalize }}"
|
||
</code></pre>
|
||
<h3 id="mastodon"><a class="header" href="#mastodon">Mastodon</a></h3>
|
||
<p><a href="https://docs.joinmastodon.org/">Mastodon</a> instances provide an <a href="https://docs.joinmastodon.org/spec/oauth/">OAuth API</a>, allowing those instances to be used as a single sign-on provider for Synapse.</p>
|
||
<p>The first step is to register Synapse as an application with your Mastodon instance, using the <a href="https://docs.joinmastodon.org/methods/apps/#create">Create an application API</a> (see also <a href="https://docs.joinmastodon.org/client/token/">here</a>). There are several ways to do this, but in the example below we are using CURL.</p>
|
||
<p>This example assumes that:</p>
|
||
<ul>
|
||
<li>the Mastodon instance website URL is <code>https://your.mastodon.instance.url</code>, and</li>
|
||
<li>Synapse will be registered as an app named <code>my_synapse_app</code>.</li>
|
||
</ul>
|
||
<p>Send the following request, substituting the value of <code>synapse_public_baseurl</code> from your Synapse installation.</p>
|
||
<pre><code class="language-sh">curl -d "client_name=my_synapse_app&redirect_uris=https://[synapse_public_baseurl]/_synapse/client/oidc/callback" -X POST https://your.mastodon.instance.url/api/v1/apps
|
||
</code></pre>
|
||
<p>You should receive a response similar to the following. Make sure to save it.</p>
|
||
<pre><code class="language-json">{"client_id":"someclientid_123","client_secret":"someclientsecret_123","id":"12345","name":"my_synapse_app","redirect_uri":"https://[synapse_public_baseurl]/_synapse/client/oidc/callback","website":null,"vapid_key":"somerandomvapidkey_123"}
|
||
</code></pre>
|
||
<p>As the Synapse login mechanism needs an attribute to uniquely identify users, and Mastodon’s endpoint does not return a <code>sub</code> property, an alternative <code>subject_template</code> has to be set. Your Synapse configuration should include the following:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: my_mastodon
|
||
idp_name: "Mastodon Instance Example"
|
||
discover: false
|
||
issuer: "https://your.mastodon.instance.url/@admin"
|
||
client_id: "someclientid_123"
|
||
client_secret: "someclientsecret_123"
|
||
authorization_endpoint: "https://your.mastodon.instance.url/oauth/authorize"
|
||
token_endpoint: "https://your.mastodon.instance.url/oauth/token"
|
||
userinfo_endpoint: "https://your.mastodon.instance.url/api/v1/accounts/verify_credentials"
|
||
scopes: ["read"]
|
||
user_mapping_provider:
|
||
config:
|
||
subject_template: "{{ user.id }}"
|
||
localpart_template: "{{ user.username }}"
|
||
display_name_template: "{{ user.display_name }}"
|
||
</code></pre>
|
||
<p>Note that the fields <code>client_id</code> and <code>client_secret</code> are taken from the CURL response above.</p>
|
||
<h3 id="pocket-id"><a class="header" href="#pocket-id">Pocket ID</a></h3>
|
||
<p><a href="https://pocket-id.org/">Pocket ID</a> is a simple OIDC provider that allows users to authenticate with their passkeys.</p>
|
||
<ol>
|
||
<li>Go to <code>OIDC Clients</code></li>
|
||
<li>Click on <code>Add OIDC Client</code></li>
|
||
<li>Add a name, for example <code>Synapse</code></li>
|
||
<li>Add <code>"https://auth.example.org/_synapse/client/oidc/callback</code> to <code>Callback URLs</code> # Replace <code>auth.example.org</code> with your domain</li>
|
||
<li>Click on <code>Save</code></li>
|
||
<li>Note down your <code>Client ID</code> and <code>Client secret</code>, these will be used later</li>
|
||
</ol>
|
||
<p>Synapse config:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: pocket_id
|
||
idp_name: Pocket ID
|
||
issuer: "https://auth.example.org/" # Replace with your domain
|
||
client_id: "your-client-id" # Replace with the "Client ID" you noted down before
|
||
client_secret: "your-client-secret" # Replace with the "Client secret" you noted down before
|
||
scopes: ["openid", "profile"]
|
||
user_mapping_provider:
|
||
config:
|
||
localpart_template: "{{ user.preferred_username }}"
|
||
display_name_template: "{{ user.name }}"
|
||
</code></pre>
|
||
<h3 id="shibboleth-with-oidc-plugin"><a class="header" href="#shibboleth-with-oidc-plugin">Shibboleth with OIDC Plugin</a></h3>
|
||
<p><a href="https://www.shibboleth.net/">Shibboleth</a> is an open Standard IdP solution widely used by Universities.</p>
|
||
<ol>
|
||
<li>Shibboleth needs the <a href="https://shibboleth.atlassian.net/wiki/spaces/IDPPLUGINS/pages/1376878976/OIDC+OP">OIDC Plugin</a> installed and working correctly.</li>
|
||
<li>Create a new config on the IdP Side, ensure that the <code>client_id</code> and <code>client_secret</code>
|
||
are randomly generated data.</li>
|
||
</ol>
|
||
<pre><code class="language-json">{
|
||
"client_id": "SOME-CLIENT-ID",
|
||
"client_secret": "SOME-SUPER-SECRET-SECRET",
|
||
"response_types": ["code"],
|
||
"grant_types": ["authorization_code"],
|
||
"scope": "openid profile email",
|
||
"redirect_uris": ["https://[synapse public baseurl]/_synapse/client/oidc/callback"]
|
||
}
|
||
</code></pre>
|
||
<p>Synapse config:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
# Shibboleth IDP
|
||
#
|
||
- idp_id: shibboleth
|
||
idp_name: "Shibboleth Login"
|
||
discover: true
|
||
issuer: "https://YOUR-IDP-URL.TLD"
|
||
client_id: "YOUR_CLIENT_ID"
|
||
client_secret: "YOUR-CLIENT-SECRECT-FROM-YOUR-IDP"
|
||
scopes: ["openid", "profile", "email"]
|
||
allow_existing_users: true
|
||
user_profile_method: "userinfo_endpoint"
|
||
user_mapping_provider:
|
||
config:
|
||
subject_claim: "sub"
|
||
localpart_template: "{{ user.sub.split('@')[0] }}"
|
||
display_name_template: "{{ user.name }}"
|
||
email_template: "{{ user.email }}"
|
||
</code></pre>
|
||
<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="twitter"><a class="header" href="#twitter">Twitter</a></h3>
|
||
<p><em>Using Twitter as an identity provider requires using Synapse 1.75.0 or later.</em></p>
|
||
<ol>
|
||
<li>Setup a developer account on <a href="https://developer.twitter.com/en/portal/dashboard">Twitter</a></li>
|
||
<li>Create a project & app.</li>
|
||
<li>Enable user authentication and under “Type of App” choose “Web App, Automated App or Bot”.</li>
|
||
<li>Under “App info” set the callback URL to <code>[synapse public baseurl]/_synapse/client/oidc/callback</code>.</li>
|
||
<li>Obtain the OAuth 2.0 credentials under the “Keys and tokens” tab, copy the “OAuth 2.0 Client ID and Client Secret”</li>
|
||
</ol>
|
||
<p>Synapse config:</p>
|
||
<pre><code class="language-yaml">oidc_providers:
|
||
- idp_id: twitter
|
||
idp_name: Twitter
|
||
idp_brand: "twitter" # optional: styling hint for clients
|
||
discover: false # Twitter is not OpenID compliant.
|
||
issuer: "https://twitter.com/"
|
||
client_id: "your-client-id" # TO BE FILLED
|
||
client_secret: "your-client-secret" # TO BE FILLED
|
||
pkce_method: "always"
|
||
# offline.access providers refresh tokens, tweet.read and users.read needed for userinfo request.
|
||
scopes: ["offline.access", "tweet.read", "users.read"]
|
||
authorization_endpoint: https://twitter.com/i/oauth2/authorize
|
||
token_endpoint: https://api.twitter.com/2/oauth2/token
|
||
userinfo_endpoint: https://api.twitter.com/2/users/me?user.fields=profile_image_url
|
||
user_mapping_provider:
|
||
config:
|
||
subject_template: "{{ user.data.id }}"
|
||
localpart_template: "{{ user.data.username }}"
|
||
display_name_template: "{{ user.data.name }}"
|
||
picture_template: "{{ user.data.profile_image_url }}"
|
||
</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>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="usage/configuration/user_authentication/single_sign_on/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="usage/configuration/user_authentication/single_sign_on/saml.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</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/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="usage/configuration/user_authentication/single_sign_on/saml.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
|
||
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
|
||
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
|
||
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
|
||
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
|
||
|
||
|
||
|
||
<script>
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="elasticlunr-ef4e11c1.min.js"></script>
|
||
<script src="mark-09e88c2c.min.js"></script>
|
||
<script src="searcher-c2a407aa.js"></script>
|
||
|
||
<script src="clipboard-1626706a.min.js"></script>
|
||
<script src="highlight-abc7f01d.js"></script>
|
||
<script src="book-a0b12cfe.js"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
<script src="docs/website_files/version-picker-a1e40922.js"></script>
|
||
<script src="docs/website_files/version-d2c738f4.js"></script>
|
||
|
||
|
||
|
||
</div>
|
||
</body>
|
||
</html>
|