Skip to content

Conversation

cwarnermm
Copy link
Member

Updates SAML encryption documentation to clarify AES-256-GCM support introduced in v10.9 and backported to v10.6.5.

Changes

  • Added version information and backwards compatibility messaging in encryption-options.rst
  • Updated main SAML SSO documentation to reference new encryption support
  • Updated technical documentation with version information

Resolves #8349

Generated with Claude Code

- Add clarification that AES-256-GCM encryption support was introduced in v10.9 and backported to v10.6.5
- Include backwards compatibility messaging that existing SAML integrations continue working without changes
- Note that only customers wanting to use AES-256-GCM keys need to update their configuration
- Update main SAML SSO documentation to reference new encryption support
- Update technical documentation to include version information

Resolves #8349

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
@cwarnermm cwarnermm added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor labels Aug 28, 2025
Copy link

Newest code from mattermost has been published to preview environment for Git SHA b58f2c5

Copy link
Contributor

@hanzei hanzei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thansk Carrie!

@@ -58,6 +58,9 @@ Mattermost supports the following encryption methods for SAML:

* aes128-gcm
* aes192-gcm
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This cipher was introduced the in same PR as aes256-gc

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any follow on action you recommend here, @hanzei?

@@ -58,6 +58,9 @@ Mattermost supports the following encryption methods for SAML:

* aes128-gcm
* aes192-gcm
* aes256-gcm
* aes256-gcm (supported in v10.9+ and backported to v10.6.5+)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0/5 do we need to mention the backport?

Copy link
Member Author

@cwarnermm cwarnermm Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. It's over-communication. Removed.


.. note::
**AES-256-GCM encryption** support was introduced in Mattermost v10.9 and backported to v10.6.5. Existing SAML integrations will continue to work without any changes. Only customers who want to use AES-256-GCM keys for SAML encryption need to update their keys and configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2/5 that this is overcommunication. Only customers who check our full changelogs will notice that this is a new supported cipher. My concern is that we introduce confusion here,

Copy link
Member Author

@cwarnermm cwarnermm Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Removed.

Copy link

Newest code from mattermost has been published to preview environment for Git SHA d1d4277

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 7bc1ad2

@cwarnermm cwarnermm requested a review from hanzei August 28, 2025 14:53
Copy link

Newest code from mattermost has been published to preview environment for Git SHA f5543f4

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 832c789

@@ -60,4 +60,4 @@ Mattermost supports the following encryption methods for SAML:
* aes192-gcm
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update. As @hanzei mentioned, AES-192-GCM was introduced in the same PR as AES-256-GCM. Given that, would it make sense to expand the note to cover the full AES-GCM family for example:

"AES-GCM algorithms (aes128-gcm, aes192-gcm, aes256-gcm) were introduced in v10.9."

Comment on lines 60 to 61
* aes192-gcm
* aes256-gcm
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* aes192-gcm
* aes256-gcm
* aes192-gcm (supported in v10.9+)
* aes256-gcm (supported in v10.9+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarifications for AES-256-GCM encryption in SAML
3 participants