From b6207948038fe9912334dee5cb5ee1cf97fb56e8 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 10 Nov 2021 15:43:17 +0000 Subject: [PATCH 1/4] Add Single Sign-On docs page stub --- .../user_authentication/single_sign_on/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/usage/configuration/user_authentication/single_sign_on/README.md diff --git a/docs/usage/configuration/user_authentication/single_sign_on/README.md b/docs/usage/configuration/user_authentication/single_sign_on/README.md new file mode 100644 index 000000000000..b94aad92cf28 --- /dev/null +++ b/docs/usage/configuration/user_authentication/single_sign_on/README.md @@ -0,0 +1,5 @@ +# Single Sign-On + +Synapse supports single sign-on through the SAML, Open ID Connect or CAS protocols. +LDAP and other login methods are supported through first and third-party password +auth provider modules. \ No newline at end of file From 6d992b66a52ce00146f55c723eae48eee27ade2f Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 10 Nov 2021 15:49:40 +0000 Subject: [PATCH 2/4] Add SAML and CAS page stubs --- docs/SUMMARY.md | 2 +- .../user_authentication/single_sign_on/cas.md | 8 ++++++++ .../user_authentication/single_sign_on/saml.md | 8 ++++++++ 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/usage/configuration/user_authentication/single_sign_on/cas.md create mode 100644 docs/usage/configuration/user_authentication/single_sign_on/saml.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 04320ab07b14..07de98d05e7c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -23,7 +23,7 @@ - [Structured Logging](structured_logging.md) - [Templates](templates.md) - [User Authentication](usage/configuration/user_authentication/README.md) - - [Single-Sign On]() + - [Single-Sign On](usage/configuration/user_authentication/single_sign_on.md) - [OpenID Connect](openid.md) - [SAML]() - [CAS]() diff --git a/docs/usage/configuration/user_authentication/single_sign_on/cas.md b/docs/usage/configuration/user_authentication/single_sign_on/cas.md new file mode 100644 index 000000000000..3bac1b29f051 --- /dev/null +++ b/docs/usage/configuration/user_authentication/single_sign_on/cas.md @@ -0,0 +1,8 @@ +# CAS + +Synapse supports authenticating users via the [Central Authentication +Service protocol](https://en.wikipedia.org/wiki/Central_Authentication_Service) +(CAS) natively. + +Please see the `cas_config` and `sso` sections of the [Synapse configuration +file](../../../configuration/homeserver_sample_config.md) for more details. \ No newline at end of file diff --git a/docs/usage/configuration/user_authentication/single_sign_on/saml.md b/docs/usage/configuration/user_authentication/single_sign_on/saml.md new file mode 100644 index 000000000000..2b6f052cc1d7 --- /dev/null +++ b/docs/usage/configuration/user_authentication/single_sign_on/saml.md @@ -0,0 +1,8 @@ +# SAML + +Synapse supports authenticating users via the [Security Assertion +Markup Language](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language) +(SAML) protocol natively. + +Please see the `saml2_config` and `sso` sections of the [Synapse configuration +file](../../../configuration/homeserver_sample_config.md) for more details. \ No newline at end of file From db9f41d4072e0e504d983b5a7b6aca5df24ff531 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 10 Nov 2021 15:50:10 +0000 Subject: [PATCH 3/4] Update SUMMARY.md to point to the new pages --- docs/SUMMARY.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 07de98d05e7c..cdedf8bccc28 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -23,10 +23,10 @@ - [Structured Logging](structured_logging.md) - [Templates](templates.md) - [User Authentication](usage/configuration/user_authentication/README.md) - - [Single-Sign On](usage/configuration/user_authentication/single_sign_on.md) + - [Single-Sign On](usage/configuration/user_authentication/single_sign_on/README.md) - [OpenID Connect](openid.md) - - [SAML]() - - [CAS]() + - [SAML](usage/configuration/user_authentication/single_sign_on/saml.md) + - [CAS](usage/configuration/user_authentication/single_sign_on/cas.md) - [SSO Mapping Providers](sso_mapping_providers.md) - [Password Auth Providers](password_auth_providers.md) - [JSON Web Tokens](jwt.md) From 03f0cbe02fafa1d3f9ffd13f56c35efc8bb7ac1f Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 10 Nov 2021 15:53:55 +0000 Subject: [PATCH 4/4] changelog --- changelog.d/11298.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/11298.doc diff --git a/changelog.d/11298.doc b/changelog.d/11298.doc new file mode 100644 index 000000000000..64ca1c84ed98 --- /dev/null +++ b/changelog.d/11298.doc @@ -0,0 +1 @@ +Add Single Sign-On, SAML and CAS pages to the documentation.