240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
202 lines
11 KiB
Plaintext
202 lines
11 KiB
Plaintext
---
|
||
title: "Configure SAML with Microsoft ADFS for Windows Server 2012"
|
||
---
|
||
import Inc0_sso_saml_before_you_begin from './sso-saml-before-you-begin.mdx';
|
||
import Inc1_sso_saml_ldapsync from './sso-saml-ldapsync.mdx';
|
||
import Inc2_sso_saml_faq from './sso-saml-faq.mdx';
|
||
|
||
<PlanAvailability slug="all-commercial" />
|
||
|
||
The following process provides steps to configure SAML 2.0 with Microsoft ADFS for Mattermost.
|
||
|
||
<Inc0_sso_saml_before_you_begin />
|
||
|
||
The following are basic requirements to use ADFS for Mattermost:
|
||
- An Active Directory instance where all users have a specified email and username attributes. For Mattermost servers running 3.3 and earlier, users must also have their first name and last name attributes specified.
|
||
- A Microsoft Server running. The screenshots used in this guide are from Microsoft Server 2012R2, but similar steps should work for other versions.
|
||
- An SSL certificate to sign your ADFS login page.
|
||
- ADFS installed on your Microsoft Server. You can find a detailed guide for deploying and configuring ADFS in [this Microsoft article](https://learn.microsoft.com/en-us/previous-versions/dynamicscrm-2016/deployment-administrators-guide/gg188612(v=crm.8)?redirectedfrom=MSDN).
|
||
|
||
On your ADFS installation, note down the value of the **SAML 2.0/W-Federation URL** in ADFS Endpoints section, also known as the **SAML SSO URL Endpoint** in this guide. If you chose the defaults for the installation, this will be `/adfs/ls/`.
|
||
|
||
## Add a relying party trust
|
||
|
||
1. In the ADFS management sidebar, go to **AD FS \> Trust Relationships \> Relying Party Trusts**, then select **Add Relying Party Trust**. A configuration wizard opens for adding a new relying party trust.
|
||
|
||
> 
|
||
|
||
2. On the **Welcome** screen, select **Start**.
|
||
|
||
> 
|
||
|
||
3. On the **Select Data Source** screen, select **Enter data about the relying party manually**.
|
||
|
||
> 
|
||
|
||
4. On the **Specify Display Name** screen, enter a **Display Name** to recognize the trust, such as `Mattermost`, then add any notes you want to make.
|
||
|
||
> 
|
||
|
||
5. On the **Choose Profile** screen, select **AD FS profile**.
|
||
|
||
> 
|
||
|
||
6. On the **Configure Certificate** screen, leave the certificate settings at their default values.
|
||
|
||
> 
|
||
|
||
However, if you would like to set up encryption for your SAML connection, select **Browse**, then upload your Service Provider Public Certificate.
|
||
|
||
> 
|
||
|
||
7. On the **Configure URL** screen, select **Enable Support for the SAML 2.0 WebSSO protocol**, then enter the **SAML 2.0 SSO service URL**, similar to `https://<your-mattermost-url>/login/sso/saml` where `<your-mattermost-url>` should typically match the [Mattermost Site URL](/administration-guide/configure/environment-configuration-settings#site-url).
|
||
|
||
> 
|
||
|
||
8. On the **Configure Identifiers** screen, enter the **Relying party trust identifier** (also known as the **Identity Provider Issuer URL**) of the form `https://<your-idp-url>/adfs/services/trust`, then click **Add**.
|
||
|
||
> 
|
||
|
||
9. On the **Configure Multi-factor Authentication Now** screen, you may enable multi-factor authentication. This is beyond the scope of this documentation.
|
||
|
||
> 
|
||
|
||
10. On the **Choose Issuance Authorization Rules** screen, select **Permit all users to access this relying party**.
|
||
|
||
|
||
|
||
11. On the **Ready to Add Trust** screen, review your settings.
|
||
|
||
|
||
|
||
12. On the **Finish** screen, select **Open the Edit Claim Rules dialog for this relying party trust when the wizard closes**, then select **Close**. You exit the configuration wizard, and a **Claim Rules** editor opens.
|
||
|
||
|
||
|
||
## Create claim rules
|
||
|
||
1. In the **Issuance Transform Rules** section of the **Claim Rules** editor, select **Add Rule…** to open an **Add Transform Claim Rule Wizard**.
|
||
|
||
> 
|
||
|
||
2. On the **Choose Rule Type** screen, select **Send LDAP Attributes as Claims** from the drop-down menu, then select **Next**.
|
||
|
||
> 
|
||
|
||
3. In the **Configure Claim Rule** screen, enter a **Claim Rule Name** of your choice, select **Active Directory** as the **Attribute Store**, then complete the following:
|
||
|
||
> - From the **LDAP Attribute column**, select `E-Mail-Addresses`. From the **Outgoing Claim Type**, type `Email`.
|
||
> - From the **LDAP Attribute column**, select `E-Mail-Addresses`. From the **Outgoing Claim Type**, type `Name ID`.
|
||
> - From the **LDAP Attribute column**, select `Given-Name`. From the **Outgoing Claim Type**, type `FirstName`.
|
||
> - From the **LDAP Attribute column**, select `Surname`. From the **Outgoing Claim Type**, type `LastName`.
|
||
> - From the **LDAP Attribute column**, select `SAM-Account-Name`. From the **Outgoing Claim Type**, type `Username`.
|
||
|
||
The `FirstName` and `LastName` attributes are optional.
|
||
|
||
Select **Finish** to add the rule.
|
||
|
||
Note that the entries in the **Outgoing Claim Type** column can be chosen to be something else. They can contain dashes but no spaces. They will be used to map the corresponding fields in Mattermost later.
|
||
|
||
> 
|
||
|
||
4. Create another new rule by selecting **Add Rule**.
|
||
|
||
5. On the **Choose Rule Type** screen, select **Transform an Incoming Claim** from the drop-down menu, then select **Next**.
|
||
|
||
> 
|
||
|
||
6. On the **Configure Claim Rule** screen, enter a **Claim Rule Name** of your choice, then:
|
||
|
||
> - Select **Name ID** for the **Incoming claim type**.
|
||
> - Select **Unspecified** for the **Incoming name ID format**.
|
||
> - Select **E-Mail Address** for the **Outgoing claim type**.
|
||
|
||
Select **Pass through all claim values**, then select **Finish**.
|
||
|
||
> 
|
||
|
||
7. Select **Finish** to create the claim rule, then select **OK** to finish creating rules.
|
||
8. Open Windows PowerShell as an administrator, then run the following command:
|
||
|
||
> `Set-ADFSRelyingPartyTrust -TargetName <display-name> -SamlResponseSignature "MessageAndAssertion"`
|
||
|
||
where `<display-name>` is the name you specified in step 4 when adding a relying party trust. In this example, `<display-name>` would be `mattermost`.
|
||
|
||
This action adds the signature to SAML messages, making verification successful.
|
||
|
||
## Export identity provider certificate
|
||
|
||
Next, export the identity provider certificate, which will be later uploaded to Mattermost to finish SAML configuration.
|
||
|
||
1. In the ADFS management sidebar, go to **AD FS \> Service \> Certificates**, then double click on the certificate under **Token-signing**. Alternatively, you can right-click on the field, then select **View Certificate**.
|
||
|
||
> 
|
||
|
||
2. On the **Certificate** screen, go to the **Details** tab, then select **Copy to File**, followed by **OK**. This opens a **Certificate Export Wizard**.
|
||
|
||
> 
|
||
|
||
3. On the **Certificate Export Wizard** screen, select **Next**, then, select the option **Base-64 encoded X.509 (.CER)**, and select **Next** again.
|
||
|
||
> 
|
||
|
||
4. On the **Certificate Export Wizard** screen, select **Browse** to specify the location where you want the Identity Provider Certificate to be exported, then specify the file name.
|
||
|
||
> 
|
||
|
||
5. Select **Save**. In the **Certificate Export Wizard** screen, verify the file path is correct, then select **Next**.
|
||
|
||
6. In the **Completing the Certificate Export Wizard**, select **Finish**, then select **OK** to confirm the export was successful.
|
||
|
||
> 
|
||
|
||
## Configure SAML Sign-On for Mattermost
|
||
|
||
Create a metadata URL by appending "FederationMetadata/2007-06/FederationMetadata.xml" to the root URL of the ADFS server, for example: `https://<adfs.domain.com>/federationmetadata/2007-06/FederationMetadata.xml>`.
|
||
|
||
Next, start the Mattermost server and log in to Mattermost as a system admin. Go to **System Console \> Authentication \> SAML**, paste the metadata URL in the **Identity Provider Metadata URL** field, then select **Get SAML Metadata from IdP**.
|
||
|
||
This populates the **SAML SSO URL** and the **Identity Provider Issuer URL** fields automatically. The Identity Provider Public Certificate is also downloaded from the server and set locally.
|
||
|
||
Alternatively you can enter the following fields manually:
|
||
- **SAML SSO URL**: **SAML 2.0/W-Federation URL** ADFS Endpoint you copied earlier.
|
||
|
||
- **Identity Provider Issuer URL**: `Relying party trust identifier` from ADFS you specified earlier.
|
||
|
||
- **Identity Provider Public Certificate**: `X.509 Public Certificate` you downloaded earlier.
|
||
|
||
|
||
|
||
2. Configure Mattermost to verify the signature. The **Service Provider Login URL** is the SAML 2.0 SSO service URL you specified in ADFS earlier.
|
||
|
||
> 
|
||
|
||
3. Enable encryption by uploading the Service Provider Private Key and Service Provider Public Certificate you generated earlier.
|
||
|
||
> 
|
||
|
||
4. Configure Mattermost to sign SAML requests using the Service Provider Private Key.
|
||
|
||
5. Set attributes for the SAML Assertions, which will be used to update user information in Mattermost. Attributes for email and username are required and should match the values you entered in ADFS earlier. See [documentation on SAML configuration settings](/administration-guide/configure/authentication-configuration-settings#saml-20) for more detail.
|
||
|
||
For Mattermost servers running 3.3 and earlier, the `FirstName` and `LastName` attributes are also required fields.
|
||
|
||
> 
|
||
|
||
6. (Optional) Customize the login button text.
|
||
|
||
> 
|
||
|
||
7. Select **Save**.
|
||
8. (Optional) If you configured a `FirstName` and `LastName` Attribute, go to **System Console \> Site Configuration \> Users and Teams**, then set **Teammate Name Display** to **Show first and last name**. This is recommended for a better user experience.
|
||
|
||
If you’d like to confirm SAML SSO is successfully enabled, switch your system admin account from email to SAML-based authentication from your profile picture via **Profile \> Security \> Sign-in Method \> Switch to SAML SSO**, then log in with your SAML credentials to complete the switch.
|
||
|
||
We recommend that you post an announcement about how the migration will work for your users.
|
||
|
||
You may also configure SAML for ADFS by editing the `config.json` file to enable SAML based on [SAML configuration settings](/administration-guide/configure/authentication-configuration-settings#saml-20). You must restart the Mattermost server for the changes to take effect.
|
||
|
||
<Inc1_sso_saml_ldapsync />
|
||
|
||
<Inc2_sso_saml_faq />
|