From 9b2df53c88c9de2c2dcae9e4d63df2b0dd849244 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Tue, 1 Jun 2021 10:42:04 +0100 Subject: [PATCH 1/2] Announce deprecation of experimental `msc2858_enabled` option. --- CHANGES.md | 10 ++++++++++ UPGRADE.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index 7e6f478d425e..b1b5d3f6b596 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,13 @@ +Unreleased +========== + +This release deprecates the `experimental.msc2858_enabled` config option, and +will be removed in the first release in August. Note that the OIDC provider +`idp_brand` config values have changed from e.g. `org.matrix.gitlab` to `gitlab`. See the +[upgrade notes](https://github.com/matrix-org/synapse/blob/release-v1.35/UPGRADE.rst#upgrading-to-v1350) +for details. + + Synapse 1.35.0rc3 (2021-05-28) ============================== diff --git a/UPGRADE.rst b/UPGRADE.rst index 9f61aad4120d..beaa2cd5b3db 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -85,6 +85,46 @@ for example: wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb + +Upgrading to v1.35.0 +==================== + +Deprecation of ``experimental.msc2858_enabled`` config option +------------------------------------------------------------- + +The ``msc2858_enabled`` option enabled support for MSC2858 with unstable +prefixes. The MSC has since been accepted into the Matrix spec, and Synapse +supports the MSC with stable prefixes as of v1.30.0. As such, the use of +``msc2858_enabled`` is deprecated, and it will be removed entirely in the first +Synapse release in August. + +If using an OIDC provider, any ``idp_brand`` config should be updated as +follows: + +* ``org.matrix.gitlab`` to ``gitlab`` +* ``org.matrix.github`` to ``github`` +* ``org.matrix.apple`` to ``apple`` +* ``org.matrix.google`` to ``google`` +* ``org.matrix.facebook`` to ``facebook`` +* ``org.matrix.twitter`` to ``twitter`` + +To maintain backwards compatibility servers can specify ``idp_unstable_brand`` +with the old value, which will be used to populate the brand names returned in +the ``org.matrix.msc2858.identity_providers`` login flow. + + +Clients that currently rely on the experimental MSC2858 support, should: + +1. Migrate from checking ``org.matrix.msc2858.identity_providers`` to + ``identity_providers`` in the flows returned by ``/login``. Note that the + ``brand`` values have changed format (as above). + +2. Replace HTTP calls to + ``/_matrix/client/unstable/org.matrix.msc2858/login/sso/redirect/..`` with + ``/_matrix/client/r0/login/sso/redirect/..``. + + + Upgrading to v1.34.0 ==================== From c8be5fd408cc0a278e108d469eff87ff029dc354 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Tue, 1 Jun 2021 12:58:35 +0100 Subject: [PATCH 2/2] Newsfile --- CHANGES.md | 10 ---------- UPGRADE.rst | 40 --------------------------------------- changelog.d/10101.removal | 1 + 3 files changed, 1 insertion(+), 50 deletions(-) create mode 100644 changelog.d/10101.removal diff --git a/CHANGES.md b/CHANGES.md index b1b5d3f6b596..7e6f478d425e 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,13 +1,3 @@ -Unreleased -========== - -This release deprecates the `experimental.msc2858_enabled` config option, and -will be removed in the first release in August. Note that the OIDC provider -`idp_brand` config values have changed from e.g. `org.matrix.gitlab` to `gitlab`. See the -[upgrade notes](https://github.com/matrix-org/synapse/blob/release-v1.35/UPGRADE.rst#upgrading-to-v1350) -for details. - - Synapse 1.35.0rc3 (2021-05-28) ============================== diff --git a/UPGRADE.rst b/UPGRADE.rst index beaa2cd5b3db..9f61aad4120d 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -85,46 +85,6 @@ for example: wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb - -Upgrading to v1.35.0 -==================== - -Deprecation of ``experimental.msc2858_enabled`` config option -------------------------------------------------------------- - -The ``msc2858_enabled`` option enabled support for MSC2858 with unstable -prefixes. The MSC has since been accepted into the Matrix spec, and Synapse -supports the MSC with stable prefixes as of v1.30.0. As such, the use of -``msc2858_enabled`` is deprecated, and it will be removed entirely in the first -Synapse release in August. - -If using an OIDC provider, any ``idp_brand`` config should be updated as -follows: - -* ``org.matrix.gitlab`` to ``gitlab`` -* ``org.matrix.github`` to ``github`` -* ``org.matrix.apple`` to ``apple`` -* ``org.matrix.google`` to ``google`` -* ``org.matrix.facebook`` to ``facebook`` -* ``org.matrix.twitter`` to ``twitter`` - -To maintain backwards compatibility servers can specify ``idp_unstable_brand`` -with the old value, which will be used to populate the brand names returned in -the ``org.matrix.msc2858.identity_providers`` login flow. - - -Clients that currently rely on the experimental MSC2858 support, should: - -1. Migrate from checking ``org.matrix.msc2858.identity_providers`` to - ``identity_providers`` in the flows returned by ``/login``. Note that the - ``brand`` values have changed format (as above). - -2. Replace HTTP calls to - ``/_matrix/client/unstable/org.matrix.msc2858/login/sso/redirect/..`` with - ``/_matrix/client/r0/login/sso/redirect/..``. - - - Upgrading to v1.34.0 ==================== diff --git a/changelog.d/10101.removal b/changelog.d/10101.removal new file mode 100644 index 000000000000..f2020e9ddf38 --- /dev/null +++ b/changelog.d/10101.removal @@ -0,0 +1 @@ +The core Synapse development team plan to drop support for the [unstable API of MSC2858](https://github.com/matrix-org/matrix-doc/blob/master/proposals/2858-Multiple-SSO-Identity-Providers.md#unstable-prefix), including the undocumented `experimental.msc2858_enabled` config option, in August 2021. Client authors should ensure that their clients are updated to use the stable API (which has been supported since Synapse 1.30) well before that time, to give their users time to upgrade.