diff options
Diffstat (limited to 'doc/integration/saml.md')
| -rw-r--r-- | doc/integration/saml.md | 739 |
1 files changed, 407 insertions, 332 deletions
diff --git a/doc/integration/saml.md b/doc/integration/saml.md index fd01e9e0e56..84879b7c4c7 100644 --- a/doc/integration/saml.md +++ b/doc/integration/saml.md @@ -5,41 +5,29 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# SAML OmniAuth Provider **(FREE SELF)** +# SAML SSO for self-managed GitLab instances **(FREE SELF)** -This page describes instance-wide SAML for self-managed GitLab instances. For -SAML on GitLab.com, see [SAML SSO for GitLab.com groups](../user/group/saml_sso/index.md). +This page describes how to set up instance-wide SAML single sign on (SSO) for +self-managed GitLab instances. -You should also reference the [OmniAuth documentation](omniauth.md) for general -settings that apply to all OmniAuth providers. +You can configure GitLab to act as a SAML service provider (SP). This allows +GitLab to consume assertions from a SAML identity provider (IdP), such as +Okta, to authenticate users. -## Glossary of common terms - -| Term | Description | -|--------------------------------|-------------| -| Identity provider (IdP) | The service which manages your user identities, such as Okta or OneLogin. | -| Service provider (SP) | GitLab can be configured as a SAML 2.0 SP. | -| Assertion | A piece of information about a user's identity, such as their name or role. Also known as claims or attributes. | -| Single Sign-On (SSO) | Name of authentication scheme. | -| Assertion consumer service URL | The callback on GitLab where users are redirected after successfully authenticating with the identity provider. | -| Issuer | How GitLab identifies itself to the identity provider. Also known as a "Relying party trust identifier". | -| Certificate fingerprint | Used to confirm that communications over SAML are secure by checking that the server is signing communications with the correct certificate. Also known as a certificate thumbprint. | +To set up SAML on GitLab.com, see [SAML SSO for GitLab.com groups](../user/group/saml_sso/index.md). -## General Setup +For more information on: -GitLab can be configured to act as a SAML 2.0 Service Provider (SP). This allows -GitLab to consume assertions from a SAML 2.0 Identity Provider (IdP), such as -Okta to authenticate users. +- OmniAuth provider settings, see the [OmniAuth documentation](omniauth.md). +- Commonly-used terms, see the [glossary of common terms](#glossary-of-common-terms). -First configure SAML 2.0 support in GitLab, then register the GitLab application -in your SAML IdP: +## Configure SAML support in GitLab -1. Make sure GitLab is configured with HTTPS. - See [Using HTTPS](../install/installation.md#using-https) for instructions. +1. Make sure GitLab is [configured with HTTPS](../install/installation.md#using-https). 1. On your GitLab server, open the configuration file. - For Omnibus package: + For Omnibus installations: ```shell sudo editor /etc/gitlab/gitlab.rb @@ -53,11 +41,12 @@ in your SAML IdP: sudo -u git -H editor config/gitlab.yml ``` -1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings. +1. Edit the initial [configuration settings](omniauth.md#configure-initial-settings). + 1. To allow your users to use SAML to sign up without having to manually create - an account first, add the following values to your configuration: + an account first, add the following values to your configuration. - For Omnibus package: + For Omnibus installations: ```ruby gitlab_rails['omniauth_allow_single_sign_on'] = ['saml'] @@ -73,10 +62,10 @@ in your SAML IdP: block_auto_created_users: false ``` -1. You can also automatically link SAML users with existing GitLab users if their - email addresses match by adding the following setting: +1. Optional. You can automatically link SAML users with existing GitLab users if their + email addresses match by adding the following setting. - For Omnibus package: + For Omnibus installations: ```ruby gitlab_rails['omniauth_auto_link_saml_user'] = true @@ -88,12 +77,21 @@ in your SAML IdP: auto_link_saml_user: true ``` -1. Ensure that the SAML [`NameID`](../user/group/saml_sso/index.md#nameid) and email address are fixed for each user, -as described in the section on [Security](#security). Otherwise, your users are able to sign in as other authorized users. + Alternatively, a user can manually link their SAML identity to an existing GitLab + account by [enabling OmniAuth for an existing user](omniauth.md#enable-omniauth-for-an-existing-user). -1. Add the provider configuration: +1. Configure the following attributes so your SAML users cannot change them: - For Omnibus package: + - [`NameID`](../user/group/saml_sso/index.md#nameid). + - `Email` when used with `omniauth_auto_link_saml_user`. + + If users can change these attributes, they can sign in as other authorized users. + See your SAML IdP documentation for information on how to make these attributes + unchangeable. + +1. Add the provider configuration. + + For Omnibus installations: ```ruby gitlab_rails['omniauth_providers'] = [ @@ -129,63 +127,118 @@ as described in the section on [Security](#security). Otherwise, your users are } ``` -1. Change the value for `assertion_consumer_service_url` to match the HTTPS endpoint - of GitLab (append `users/auth/saml/callback` to the HTTPS URL of your GitLab - installation to generate the correct value). +1. Match the value for `assertion_consumer_service_url` to the HTTPS endpoint + of GitLab. To generate the correct value, append `users/auth/saml/callback` to the + HTTPS URL of your GitLab installation. -1. Change the values of `idp_cert_fingerprint`, `idp_sso_target_url`, - `name_identifier_format` to match your IdP. If a fingerprint is used it must - be a SHA1 fingerprint; check - [the OmniAuth SAML documentation](https://github.com/omniauth/omniauth-saml) - for more details on these options. - See the [notes on configuring your identity provider](#notes-on-configuring-your-identity-provider) for more information. +1. Change the following values to match your IdP: + - `idp_cert_fingerprint`. + - `idp_sso_target_url`. + - `name_identifier_format`. + If you use a `idp_cert_fingerprint`, it must be a SHA1 fingerprint. For more + information on these values, see the + [OmniAuth SAML documentation](https://github.com/omniauth/omniauth-saml). + For more information on other configuration settings, see + [configuring SAML on your IdP](#configure-saml-on-your-idp). 1. Change the value of `issuer` to a unique name, which identifies the application to the IdP. -1. For the changes to take effect: - - If you installed via Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - If you installed from source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). +1. For the changes to take effect, if you installed: + - Using Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). + - From source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). -1. Register the GitLab SP in your SAML 2.0 IdP, using the application name specified - in `issuer`. +### Register GitLab in your SAML IdP -To ease configuration, most IdP accept a metadata URL for the application to provide -configuration information to the IdP. To build the metadata URL for GitLab, append -`users/auth/saml/metadata` to the HTTPS URL of your GitLab installation, for instance: +1. Register the GitLab SP in your SAML IdP, using the application name specified in `issuer`. -```plaintext -https://gitlab.example.com/users/auth/saml/metadata -``` +1. To provide configuration information to the IdP, build a metadata URL for the + application. To build the metadata URL for GitLab, append `users/auth/saml/metadata` + to the HTTPS URL of your GitLab installation. For example: -At a minimum the IdP *must* provide a claim containing the user's email address using `email` or `mail`. -See [the assertions list](#assertions) for other available claims. + ```plaintext + https://gitlab.example.com/users/auth/saml/metadata + ``` + + At a minimum the IdP **must** provide a claim containing the user's email address + using `email` or `mail`. For more information on other available claims, see + [configuring assertions](#configure-assertions). + +1. On the sign in page there should now be a SAML icon below the regular sign in form. + Select the icon to begin the authentication process. If authentication is successful, + you are returned to GitLab and signed in. + +### Configure SAML on your IdP -On the sign in page there should now be a SAML button below the regular sign in form. -Select the icon to begin the authentication process. If everything goes well the user -is returned to GitLab and signed in. +To configure a SAML application on your IdP, you need at least the following information: -### Use multiple SAML identity providers +- Assertion consumer service URL. +- Issuer. +- [`NameID`](../user/group/saml_sso/index.md#nameid). +- [Email address claim](#configure-assertions). + +For an example configuration, see [set up identity providers](#set-up-identity-providers). + +Your IdP may need additional configuration. For more information, see +[additional configuration for SAML apps on your IdP](#additional-configuration-for-saml-apps-on-your-idp). + +### Configure GitLab to use multiple SAML IdPs > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14361) in GitLab 14.6. -You can configure GitLab to use multiple SAML identity providers if: +You can configure GitLab to use multiple SAML IdPs if: -- Each provider has a unique name set that matches a name set in `args`. At least one provider **must** have the name `saml` to mitigate a - [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/366450) in GitLab 14.6 and newer. -- The providers' names are: - - Used in OmniAuth configuration for properties based on the provider name. For example, `allowBypassTwoFactor`, `allowSingleSignOn`, and - `syncProfileFromProvider`. - - Used for association to each existing user as an additional identity. +- Each provider has a unique name set that matches a name set in `args`. At least + one provider must have the name `saml` to mitigate a + [known issue](https://gitlab.com/gitlab-org/gitlab/-/issues/366450) in GitLab + 14.6 and newer. +- The providers' names are used: + - In OmniAuth configuration for properties based on the provider name. For example, + `allowBypassTwoFactor`, `allowSingleSignOn`, and `syncProfileFromProvider`. + - For association to each existing user as an additional identity. - The `assertion_consumer_service_url` matches the provider name. -- The `strategy_class` is explicitly set because it cannot be inferred from provider name. +- The `strategy_class` is explicitly set because it cannot be inferred from provider + name. -Example multiple providers configuration for Omnibus GitLab: +Example provider's configuration for installations from source: + +```yaml +omniauth: + providers: + - { + name: 'saml', # This must match the following name configuration parameter + args: { + name: 'saml', # This is mandatory and must match the provider name + strategy_class: 'OmniAuth::Strategies::SAML', + assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml_1/callback', # URL must match the name of the provider + ... # Put here all the required arguments similar to a single provider + }, + label: 'Provider 1' # Differentiate the two buttons and providers in the UI + } + - { + name: 'saml1', # This must match the following name configuration parameter + args: { + name: 'saml1', # This is mandatory and must match the provider name + strategy_class: 'OmniAuth::Strategies::SAML', + assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml_2/callback', # URL must match the name of the provider + ... # Put here all the required arguments similar to a single provider + }, + label: 'Provider 2' # Differentiate the two buttons and providers in the UI + } +``` + +Example provider's configuration for Omnibus GitLab installations: + +To allow your users to use SAML to sign up without having to manually create an account from either of the providers, add the following values to your configuration. + +```ruby +gitlab_rails['omniauth_allow_single_sign_on'] = ['saml', 'saml1'] +``` ```ruby gitlab_rails['omniauth_providers'] = [ { - name: 'saml', + name: 'saml', # This must match the following name configuration parameter args: { name: 'saml', # This is mandatory and must match the provider name strategy_class: 'OmniAuth::Strategies::SAML', @@ -195,7 +248,7 @@ gitlab_rails['omniauth_providers'] = [ label: 'Provider 1' # Differentiate the two buttons and providers in the UI }, { - name: 'saml1', + name: 'saml1', # This must match the following name configuration parameter args: { name: 'saml1', # This is mandatory and must match the provider name strategy_class: 'OmniAuth::Strategies::SAML', @@ -207,87 +260,126 @@ gitlab_rails['omniauth_providers'] = [ ] ``` -Example providers configuration for installations from source: +To allow your users to use SAML to sign up without having to manually create an +account from either of the providers, add the following values to your configuration. -```yaml -omniauth: - providers: - - { - name: 'saml', - args: { - name: 'saml', # This is mandatory and must match the provider name - strategy_class: 'OmniAuth::Strategies::SAML', - assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml_1/callback', # URL must match the name of the provider - ... # Put here all the required arguments similar to a single provider - }, - label: 'Provider 1' # Differentiate the two buttons and providers in the UI - } - - { - name: 'saml1', - args: { - name: 'saml1', # This is mandatory and must match the provider name - strategy_class: 'OmniAuth::Strategies::SAML', - assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml_2/callback', # URL must match the name of the provider - ... # Put here all the required arguments similar to a single provider - }, - label: 'Provider 2' # Differentiate the two buttons and providers in the UI - } +```ruby +gitlab_rails['omniauth_allow_single_sign_on'] = ['saml', 'saml1'] ``` -### Notes on configuring your identity provider +## Set up identity providers -When configuring a SAML app on the IdP, you need at least: +GitLab support of SAML means you can sign in to GitLab through a wide range +of IdPs. -- Assertion consumer service URL -- Issuer -- [`NameID`](../user/group/saml_sso/index.md#nameid) -- [Email address claim](#assertions) +GitLab provides the following content on setting up the Okta and Google Workspace +IdPs for guidance only. If you have any questions on configuring either of these +IdPs, contact your provider's support. -Your identity provider may require additional configuration, such as the following: +### Set up Okta -| Field | Value | Notes | -|-------|-------|-------| -| SAML profile | Web browser SSO profile | GitLab uses SAML to sign users in through their browser. No requests are made directly to the identity provider. | -| SAML request binding | HTTP Redirect | GitLab (the service provider) redirects users to your identity provider with a base64 encoded `SAMLRequest` HTTP parameter. | -| SAML response binding | HTTP POST | Specifies how the SAML token is sent by your identity provider. Includes the `SAMLResponse`, which a user's browser submits back to GitLab. | -| Sign SAML response | Required | Prevents tampering. | -| X.509 certificate in response | Required | Signs the response and checks against the provided fingerprint. | -| Fingerprint algorithm | SHA-1 | GitLab uses a SHA-1 hash of the certificate to sign the SAML Response. | -| Signature algorithm | SHA-1/SHA-256/SHA-384/SHA-512 | Determines how a response is signed. Also known as the digest method, this can be specified in the SAML response. | -| Encrypt SAML assertion | Optional | Uses TLS between your identity provider, the user's browser, and GitLab. | -| Sign SAML assertion | Optional | Validates the integrity of a SAML assertion. When active, signs the whole response. | -| Check SAML request signature | Optional | Checks the signature on the SAML response. | -| Default RelayState | Optional | Specifies the URL users should end up on after successfully signing in through SAML at your identity provider. | -| NameID format | Persistent | See [NameID format details](../user/group/saml_sso/index.md#nameid-format). | -| Additional URLs | Optional | May include the issuer (or identifier) or the assertion consumer service URL in other fields on some providers. | +1. In the Okta administrator section choose **Applications**. +1. On the app screen, select **Create App Integration** and then select + **SAML 2.0** on the next screen. +1. Optional. Choose and add a logo from [GitLab Press](https://about.gitlab.com/press/). + You must crop and resize the logo. +1. Complete the SAML general configuration. Enter: + - `"Single sign-on URL"`: Use the assertion consumer service URL. + - `"Audience URI"`: Use the issuer. + - [`NameID`](../user/group/saml_sso/index.md#nameid). + - [Assertions](#configure-assertions). +1. In the feedback section, enter that you're a customer and creating an + app for internal use. +1. At the top of your new app's profile, select **SAML 2.0 configuration instructions**. +1. Note the **Identity Provider Single Sign-On URL**. Use this URL for the + `idp_sso_target_url` on your GitLab configuration file. +1. Before you sign out of Okta, make sure you add your user and groups if any. + +### Set up Google Workspace + +Prerequisites: -For example configurations, see the [notes on specific providers](#providers). +- Make sure you have access to a +[Google Workspace Super Admin account](https://support.google.com/a/answer/2405986#super_admin). -### Assertions +1. Use the following information, and follow the instructions in +[Set up your own custom SAML application in Google Workspace](https://support.google.com/a/answer/6087519?hl=en). -| Field | Supported keys | -|-----------------|----------------| -| Email (required)| `email`, `mail` | -| Full Name | `name` | + | | Typical value | Description | + |------------------|--------------------------------------------------|----------------------------------------------------------| + | Name of SAML App | GitLab | Other names OK. | + | ACS URL | `https://<GITLAB_DOMAIN>/users/auth/saml/callback` | Assertion Consumer Service URL. | + | GITLAB_DOMAIN | `gitlab.example.com` | Your GitLab instance domain. | + | Entity ID | `https://gitlab.example.com` | A value unique to your SAML application. Set it to the `issuer` in your GitLab configuration. | + | Name ID format | EMAIL | Required value. Also known as `name_identifier_format`. | + | Name ID | Primary email address | Your email address. Make sure someone receives content sent to that address. | + | First name | `first_name` | First name. Required value to communicate with GitLab. | + | Last name | `last_name` | Last name. Required value to communicate with GitLab. | + +1. Set up the following SAML attribute mappings: + + | Google Directory attributes | App attributes | + |-----------------------------------|----------------| + | Basic information > Email | `email` | + | Basic Information > First name | `first_name` | + | Basic Information > Last name | `last_name` | + + You might use some of this information when you + [configure SAML support in GitLab](#configure-saml-support-in-gitlab). + +When configuring the Google Workspace SAML application, record the following information: + +| | Value | Description | +|-------------|--------------|-----------------------------------------------------------------------------------| +| SSO URL | Depends | Google Identity Provider details. Set to the GitLab `idp_sso_target_url` setting. | +| Certificate | Downloadable | Run `openssl x509 -in <your_certificate.crt> -noout -fingerprint` to generate the SHA1 fingerprint that can be used in the `idp_cert_fingerprint` setting. | + +Google Workspace Administrator also provides the IdP metadata, Entity ID, and SHA-256 +fingerprint. However, GitLab does not need this information to connect to the +Google Workspace SAML application. + +### Set up other IdPs + +Some IdPs have documentation on how to use them as the IdP in SAML configurations. +For example: + +- [Active Directory Federation Services (ADFS)](https://learn.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust) +- [Auth0](https://auth0.com/docs/authenticate/protocols/saml/saml-sso-integrations/configure-auth0-saml-identity-provider) + +If you have any questions on configuring your IdP in a SAML configuration, contact +your provider's support. + +### Configure assertions + +| Field | Supported default keys | +|-----------------|------------------------| +| Email (required)| `email`, `mail` | +| Full Name | `name` | | First Name | `first_name`, `firstname`, `firstName` | -| Last Name | `last_name`, `lastname`, `lastName` | +| Last Name | `last_name`, `lastname`, `lastName` | + +See [`attribute_statements`](#map-saml-response-attribute-names) for: -See [`attribute_statements`](#attribute_statements) for examples on how custom -assertions are configured. This section also describes how to configure custom -username attributes. +- Custom assertion configuration examples. +- How to configure custom username attributes. -Please refer to [the OmniAuth SAML gem](https://github.com/omniauth/omniauth-saml/blob/master/lib/omniauth/strategies/saml.rb) -for a full list of supported assertions. +For a full list of supported assertions, see the [OmniAuth SAML gem](https://github.com/omniauth/omniauth-saml/blob/master/lib/omniauth/strategies/saml.rb) -## SAML Groups +## Configure users based on SAML group membership -You can require users to be members of a certain group, or assign users [external](../user/permissions.md#external-users), administrator or [auditor](../user/permissions.md#auditor-users) roles based on group membership. -These groups are checked on each SAML login and user attributes updated as necessary. -This feature **does not** allow you to -automatically add users to GitLab [Groups](../user/group/index.md). +You can: -Support for these groups depends on your [subscription](https://about.gitlab.com/pricing/) -and whether you've installed [GitLab Enterprise Edition (EE)](https://about.gitlab.com/install/). +- Require users to be members of a certain group. +- Assign users [external](../user/admin_area/external_users.md), administrator or [auditor](../administration/auditor_users.md) roles based on group membership. + +GitLab checks these groups on each SAML sign in and updates user attributes as necessary. +This feature **does not** allow you to automatically add users to GitLab +[Groups](../user/group/index.md). + +Support for these groups depends on: + +- Your [subscription](https://about.gitlab.com/pricing/). +- Whether you've installed [GitLab Enterprise Edition (EE)](https://about.gitlab.com/install/). | Group | Tier | GitLab Enterprise Edition (EE) Only? | |------------------------------|--------------------|--------------------------------------| @@ -296,11 +388,11 @@ and whether you've installed [GitLab Enterprise Edition (EE)](https://about.gitl | [Admin](#administrator-groups) | **(FREE SELF)** | Yes | | [Auditor](#auditor-groups) | **(PREMIUM SELF)** | Yes | -### Requirements +### Prerequisites -First tell GitLab where to look for group information. For this, you -must make sure that your IdP server sends a specific `AttributeStatement` along -with the regular SAML response. Here is an example: +You must tell GitLab where to look for group information. To do this, make sure +that your IdP server sends a specific `AttributeStatement` along with the regular +SAML response. For example: ```xml <saml:AttributeStatement> @@ -313,22 +405,25 @@ with the regular SAML response. Here is an example: </saml:AttributeStatement> ``` -The name of the attribute can be anything you like, but it must contain the groups -to which a user belongs. To tell GitLab where to find these groups, you need -to add a `groups_attribute:` element to your SAML settings. +The name of the attribute must contain the groups that a user belongs to. +To tell GitLab where to find these groups, add a `groups_attribute:` +element to your SAML settings. ### Required groups -Your IdP passes Group information to the SP (GitLab) in the SAML Response. -To use this response, configure GitLab to identify: +Your IdP passes group information to GitLab in the SAML response. To use this +response, configure GitLab to identify: + +- Where to look for the groups in the SAML response, using the `groups_attribute` setting. +- Information about a group or user, using a group setting. -- Where to look for the groups in the SAML response via the `groups_attribute` setting -- Which group membership is requisite to sign in via the `required_groups` setting +Use the `required_groups` setting to configure GitLab to identify which group +membership is required to sign in. -When `required_groups` is empty or not set, anyone with proper authentication -is able to use the service. +If you do not set `required_groups` or leave the setting empty, anyone with proper +authentication can use the service. -Example: +Example configuration: ```yaml { name: 'saml', @@ -346,9 +441,17 @@ Example: ### External groups -SAML login supports the automatic identification of a user as an -[external user](../user/permissions.md#external-users). This is based on the user's group -membership in the SAML identity provider. +Your IdP passes group information to GitLab in the SAML response. To use this +response, configure GitLab to identify: + +- Where to look for the groups in the SAML response, using the `groups_attribute` setting. +- Information about a group or user, using a group setting. + +SAML can automatically identify a user as an +[external user](../user/admin_area/external_users.md), based on the `external_groups` +setting. + +Example configuration: ```yaml { name: 'saml', @@ -366,11 +469,16 @@ membership in the SAML identity provider. ### Administrator groups -The requirements are the same as the previous settings: +Your IdP passes group information to GitLab in the SAML response. To use this +response, configure GitLab to identify: + +- Where to look for the groups in the SAML response, using the `groups_attribute` setting. +- Information about a group or user, using a group setting. -- The IdP must pass Group information to GitLab. -- GitLab must know where to look for the groups in the SAML response, as well as - which groups grant the user administrator access. +Use the `admin_groups` setting to configure GitLab to identify which groups grant +the user administrator access. + +Example configuration: ```yaml { name: 'saml', @@ -390,11 +498,16 @@ The requirements are the same as the previous settings: > Introduced in GitLab 11.4. -The requirements are the same as the previous settings: +Your IdP passes group information to GitLab in the SAML response. To use this +response, configure GitLab to identify: + +- Where to look for the groups in the SAML response, using the `groups_attribute` setting. +- Information about a group or user, using a group setting. + +Use the `auditor_groups` setting to configure GitLab to identify which groups include +users with [auditor access](../administration/auditor_users.md). -- The IdP must pass Group information to GitLab. -- GitLab should know where to look for the groups in the SAML response, as well as which - groups include users with the [Auditor role](../user/permissions.md#auditor-users). +Example configuration: ```yaml { name: 'saml', @@ -410,17 +523,17 @@ The requirements are the same as the previous settings: } } ``` -## Group Sync +## Automatically manage SAML Group Sync For information on automatically managing GitLab group membership, see [SAML Group Sync](../user/group/saml_sso/group_sync.md). -## Bypass two factor authentication +## Bypass two-factor authentication -If you want some SAML authentication methods to count as 2FA on a per session -basis, you can register them in the `upstream_two_factor_authn_contexts` list. +To configure a SAML authentication method to count as two-factor authentication +(2FA) on a per session basis, register that method in the `upstream_two_factor_authn_contexts` +list. -In addition to the changes in GitLab, make sure that your IdP is returning the -`AuthnContext`. For example: +1. Make sure that your IdP is returning the `AuthnContext`. For example: ```xml <saml:AuthnStatement> @@ -430,7 +543,11 @@ In addition to the changes in GitLab, make sure that your IdP is returning the </saml:AuthnStatement> ``` -**For Omnibus installations:** +1. Edit your installation configuration to register the SAML authentication method + in the `upstream_two_factor_authn_contexts` list. How you edit your configuration + will differ depending on your installation type. + +### Omnibus GitLab installations 1. Edit `/etc/gitlab/gitlab.rb`: @@ -456,11 +573,10 @@ In addition to the changes in GitLab, make sure that your IdP is returning the ] ``` -1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. - ---- +1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) + GitLab for the changes to take effect. -**For installations from source:** +### Installations from source 1. Edit `config/gitlab.yml`: @@ -486,17 +602,62 @@ In addition to the changes in GitLab, make sure that your IdP is returning the } ``` -1. Save the file and [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect +1. Save the file and [restart GitLab](../administration/restart_gitlab.md#installations-from-source) + for the changes to take effect. + +## Validate response signatures -## Customization +IdPs must sign SAML responses to ensure that the assertions are not tampered with. -### `auto_sign_in_with_provider` +This prevents user impersonation and privilege escalation when specific group +membership is required. + +You configure the response signature validation using `idp_cert_fingerprint`. +An example configuration: + +```yaml +args: { + assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback', + idp_cert_fingerprint: '43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8', + idp_sso_target_url: 'https://login.example.com/idp', + issuer: 'https://gitlab.example.com', + name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent', +} +``` -You can add this setting to your GitLab configuration to automatically redirect you -to your SAML server for authentication. This removes the requirement to select a button -before actually signing in. +If your IdP does not support configuring this using `idp_cert_fingerprint`, you +can instead configure GitLab directly using `idp_cert`. An example configuration: -For Omnibus package: +```yaml +args: { + assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback', + idp_cert: '-----BEGIN CERTIFICATE----- + <redacted> + -----END CERTIFICATE-----', + idp_sso_target_url: 'https://login.example.com/idp', + issuer: 'https://gitlab.example.com', + name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent', +} +``` + +If you have configured the response signature validation incorrectly, you might see +error messages such as: + +- A key validation error. +- Digest mismatch. +- Fingerprint mismatch. + +For more information on solving these errors, see the [troubleshooting SAML guide](../user/group/saml_sso/troubleshooting.md). + +## Customize SAML settings + +### Redirect users to SAML server for authentication + +You can add the `auto_sign_in_with_provider` setting to your GitLab configuration +to automatically redirect you to your SAML server for authentication. This removes +the requirement to select an element before actually signing in. + +For Omnibus GitLab installations: ```ruby gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'saml' @@ -509,31 +670,28 @@ omniauth: auto_sign_in_with_provider: saml ``` -Keep in mind that every sign in attempt redirects to the SAML server; -you cannot sign in using local credentials. Ensure at least one of the -SAML users has administrator access. +Every sign in attempt redirects to the SAML server, so you cannot sign in using +local credentials. Make sure at least one of the SAML users has administrator access. -You may also bypass the auto sign-in feature by browsing to +You can also bypass the auto sign-in feature by `https://gitlab.example.com/users/sign_in?auto_sign_in=false`. -### `attribute_statements` **(FREE SELF)** - -NOTE: -This setting should be used only to map attributes that are part of the OmniAuth -`info` hash schema. +### Map SAML response attribute names **(FREE SELF)** -`attribute_statements` is used to map Attribute Names in a SAMLResponse to entries +You can use `attribute_statements` to map attribute names in a SAML response to entries in the OmniAuth [`info` hash](https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema#schema-10-and-later). -For example, if your SAMLResponse contains an Attribute called `EmailAddress`, +NOTE: +Only use this setting to map attributes that are part of the OmniAuth `info` hash schema. + +For example, if your `SAMLResponse` contains an Attribute called `EmailAddress`, specify `{ email: ['EmailAddress'] }` to map the Attribute to the corresponding key in the `info` hash. URI-named Attributes are also supported, for example, `{ email: ['http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress'] }`. -This setting allows you tell GitLab where to look for certain attributes required -to create an account. Like mentioned above, if your IdP sends the user's email -address as `EmailAddress` instead of `email`, let GitLab know by setting it on -your configuration: +Use this setting to tell GitLab where to look for certain attributes required +to create an account. If your IdP sends the user's email address as `EmailAddress` +instead of `email`, let GitLab know by setting it on your configuration: ```yaml args: { @@ -566,7 +724,7 @@ args: { This also sets the `username` attribute in your SAML Response to the username in GitLab. -### `allowed_clock_drift` +### Allow for clock drift The clock of the Identity Provider may drift slightly ahead of your system clocks. To allow for a small amount of clock drift, you can use `allowed_clock_drift` in @@ -585,9 +743,11 @@ args: { } ``` -### `uid_attribute` +### Designate a unique attribute for the `uid` -By default, the `uid` is set as the `name_id` in the SAML response. If you'd like to designate a unique attribute for the `uid`, you can set the `uid_attribute`. In the example below, the value of `uid` attribute in the SAML response is set as the `uid_attribute`. +By default, the `uid` is set as the `name_id` in the SAML response. To designate +a unique attribute for the `uid`, you can set the `uid_attribute`. In the following +example, the value of `uid` attribute in the SAML response is set as the `uid_attribute`. ```yaml args: { @@ -600,59 +760,19 @@ args: { } ``` -Make sure you read the [Security](#security) section before changing this value. - -## Response signature validation (required) - -We require Identity Providers to sign SAML responses to ensure that the assertions are -not tampered with. - -This prevents user impersonation and prevents privilege escalation when specific group -membership is required. Typically this: +Before setting the `uid` to a unique attribute, make sure that you have configured +the following attributes so your SAML users cannot change them: -- Is configured using `idp_cert_fingerprint`. -- Includes the full certificate in the response, although if your Identity Provider - doesn't support this, you can directly configure GitLab using the `idp_cert` option. +- [`NameID`](../user/group/saml_sso/index.md#nameid). +- `Email` when used with `omniauth_auto_link_saml_user`. -Example configuration with `idp_cert_fingerprint`: - -```yaml -args: { - assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback', - idp_cert_fingerprint: '43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8', - idp_sso_target_url: 'https://login.example.com/idp', - issuer: 'https://gitlab.example.com', - name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent', -} -``` +If users can change these attributes, they can sign in as other authorized users. +See your SAML IdP documentation for information on how to make these attributes +unchangeable. -Example configuration with `idp_cert`: +## Assertion encryption (optional) -```yaml -args: { - assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback', - idp_cert: '-----BEGIN CERTIFICATE----- - <redacted> - -----END CERTIFICATE-----', - idp_sso_target_url: 'https://login.example.com/idp', - issuer: 'https://gitlab.example.com', - name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent', -} -``` - -If the response signature validation is configured incorrectly, you can see error messages -such as: - -- A key validation error. -- Digest mismatch. -- Fingerprint mismatch. - -Refer to the [troubleshooting section](#troubleshooting) for more information on -debugging these errors. - -## Assertion Encryption (optional) - -GitLab requires the use of TLS encryption with SAML, but in some cases there can be a +GitLab requires the use of TLS encryption with SAML 2.0, but in some cases there can be a need for additional encryption of the assertions. This may be the case, for example, if you terminate TLS encryption early at a load @@ -679,7 +799,7 @@ Your Identity Provider encrypts the assertion with the public certificate of Git NOTE: This integration uses the `certificate` and `private_key` settings for both assertion encryption and request signing. -## Request signing (optional) +## Sign SAML authentication requests (optional) Another optional configuration is to sign SAML authentication requests. GitLab SAML Requests use the SAML redirect binding, so this isn't necessary (unlike the @@ -713,27 +833,21 @@ args: { GitLab signs the request with the provided private key. GitLab includes the configured public x500 certificate in the metadata for your Identity Provider to validate the signature of the received request with. For more information on this option, see the [Ruby SAML gem documentation](https://github.com/onelogin/ruby-saml/tree/v1.7.0). The Ruby SAML gem is used by the [OmniAuth SAML gem](https://github.com/omniauth/omniauth-saml) to implement the client side of the SAML authentication. -## Security - -Avoid user control of the following attributes: +## Password generation for users created through SAML -- [`NameID`](../user/group/saml_sso/index.md#nameid) -- `Email` when used with `omniauth_auto_link_saml_user` - -These attributes define the SAML user. If users can change these attributes, they can impersonate others. - -Refer to the documentation for your SAML Identity Provider for information on how to fix these attributes. +The [Generated passwords for users created through integrated authentication](../security/passwords_for_integrated_authentication_methods.md) guide provides an overview of how GitLab generates and sets passwords for users created via SAML. -## Passwords for users created via SAML +Users authenticated with SSO or SAML must not use a password for Git operations over HTTPS. These users can do one of the following instead: -The [Generated passwords for users created through integrated authentication](../security/passwords_for_integrated_authentication_methods.md) guide provides an overview of how GitLab generates and sets passwords for users created via SAML. +- Set up a [personal access token](../user/profile/personal_access_tokens.md). +- Use the [Git Credential Manager](../user/profile/account/two_factor_authentication.md#git-credential-manager) which securely authenticates using OAuth. ## Link SAML identity for an existing user A user can manually link their SAML identity to an existing GitLab account by following the steps in [Enable OmniAuth for an existing user](omniauth.md#enable-omniauth-for-an-existing-user). -## Configuring Group SAML on a self-managed GitLab instance **(PREMIUM SELF)** +## Group SAML on a self-managed GitLab instance **(PREMIUM SELF)** For information on the GitLab.com implementation, please see the [SAML SSO for GitLab.com groups page](../user/group/saml_sso). @@ -741,10 +855,10 @@ Group SAML SSO helps if you have to allow access via multiple SAML identity prov To proceed with configuring Group SAML SSO instead, enable the `group_saml` OmniAuth provider. This can be done from: -- `gitlab.rb` for [Omnibus GitLab installations](#omnibus-installations). -- `gitlab/config/gitlab.yml` for [source installations](#source-installations). +- `gitlab.rb` for Omnibus GitLab installations. +- `gitlab/config/gitlab.yml` for source installations. -### Limitations +### Self-managed instance group SAML limitations Group SAML on a self-managed instance is limited when compared to the recommended [instance-wide SAML](../user/group/saml_sso/index.md). The recommended solution allows you to take advantage of: @@ -755,7 +869,7 @@ Group SAML on a self-managed instance is limited when compared to the recommende - [Administrator groups](#administrator-groups). - [Auditor groups](#auditor-groups). -### Omnibus installations +For Omnibus installations: 1. Make sure GitLab is [configured with HTTPS](../install/installation.md#using-https). @@ -766,7 +880,7 @@ Group SAML on a self-managed instance is limited when compared to the recommende gitlab_rails['omniauth_providers'] = [{ name: 'group_saml' }] ``` -### Source installations +For installations from source: 1. Make sure GitLab is [configured with HTTPS](../install/installation.md#using-https). @@ -779,78 +893,39 @@ Group SAML on a self-managed instance is limited when compared to the recommende - { name: 'group_saml' } ``` -## Providers - -GitLab support of SAML means that you can sign in to GitLab with a wide range of identity providers. -Your identity provider may have additional documentation. Some identity providers include -documentation on how to use SAML to sign in to GitLab. - -Examples: - -- [ADFS (Active Directory Federation Services)](https://learn.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust) -- [Auth0](https://auth0.com/docs/authenticate/protocols/saml/saml-sso-integrations/configure-auth0-saml-identity-provider) - -GitLab provides the following setup notes for guidance only. -If you have any questions on configuring the SAML app, please contact your provider's support. - -### Okta setup notes - -1. In the Okta administrator section choose **Applications**. -1. When the app screen comes up you see another button to **Create App Integration** and - choose SAML 2.0 on the next screen. -1. Optionally, you can add a logo - (you can choose it from <https://about.gitlab.com/press/>). You must - crop and resize it. -1. Next, fill in the SAML general configuration with - the assertion consumer service URL as "Single sign-on URL" and - the issuer as "Audience URI" along with the [NameID](../user/group/saml_sso/index.md#nameid) and [assertions](#assertions). -1. The last part of the configuration is the feedback section where you can - just say you're a customer and creating an app for internal use. -1. When you have your app you can see a few tabs on the top of the app's - profile. Select the SAML 2.0 configuration instructions button. -1. On the screen that comes up take note of the - **Identity Provider Single Sign-On URL** which you can use for the - `idp_sso_target_url` on your GitLab configuration file. -1. **Before you leave Okta, make sure you add your user and groups if any.** - -### Google workspace setup notes - -The following guidance is based on this Google Workspace article, on how to [Set up your own custom SAML application](https://support.google.com/a/answer/6087519?hl=en): - -Make sure you have access to a Google Workspace [Super Admin](https://support.google.com/a/answer/2405986#super_admin) account. - Use the information below and follow the instructions in the linked Google Workspace article. - -| | Typical value | Description | -|------------------|--------------------------------------------------|----------------------------------------------------------| -| Name of SAML App | GitLab | Other names OK. | -| ACS URL | `https://<GITLAB_DOMAIN>/users/auth/saml/callback` | ACS is short for Assertion Consumer Service. | -| GITLAB_DOMAIN | `gitlab.example.com` | Set to the domain of your GitLab instance. | -| Entity ID | `https://gitlab.example.com` | A value unique to your SAML app, set it to the `issuer` in your GitLab configuration. | -| Name ID format | EMAIL | Required value. Also known as `name_identifier_format` | -| Name ID | Primary email address | Make sure someone receives content sent to that address | -| First name | `first_name` | Required value to communicate with GitLab. | -| Last name | `last_name` | Required value to communicate with GitLab. | +## Additional configuration for SAML apps on your IdP -You also must setup the following SAML attribute mappings: +When configuring a SAML app on the IdP, your identity provider may require additional configuration, such as the following: -| Google Directory attributes | App attributes | -|-----------------------------------|----------------| -| Basic information > Email | `email` | -| Basic Information > First name | `first_name` | -| Basic Information > Last name | `last_name` | - -You may also use some of this information when you [configure GitLab](#general-setup). +| Field | Value | Notes | +|-------|-------|-------| +| SAML profile | Web browser SSO profile | GitLab uses SAML to sign users in through their browser. No requests are made directly to the identity provider. | +| SAML request binding | HTTP Redirect | GitLab (the service provider) redirects users to your identity provider with a base64 encoded `SAMLRequest` HTTP parameter. | +| SAML response binding | HTTP POST | Specifies how the SAML token is sent by your identity provider. Includes the `SAMLResponse`, which a user's browser submits back to GitLab. | +| Sign SAML response | Required | Prevents tampering. | +| X.509 certificate in response | Required | Signs the response and checks against the provided fingerprint. | +| Fingerprint algorithm | SHA-1 | GitLab uses a SHA-1 hash of the certificate to sign the SAML Response. | +| Signature algorithm | SHA-1/SHA-256/SHA-384/SHA-512 | Determines how a response is signed. Also known as the digest method, this can be specified in the SAML response. | +| Encrypt SAML assertion | Optional | Uses TLS between your identity provider, the user's browser, and GitLab. | +| Sign SAML assertion | Optional | Validates the integrity of a SAML assertion. When active, signs the whole response. | +| Check SAML request signature | Optional | Checks the signature on the SAML response. | +| Default RelayState | Optional | Specifies the URL users should end up on after successfully signing in through SAML at your identity provider. | +| NameID format | Persistent | See [NameID format details](../user/group/saml_sso/index.md#nameid-format). | +| Additional URLs | Optional | May include the issuer (or identifier) or the assertion consumer service URL in other fields on some providers. | -When configuring the Google Workspace SAML app, be sure to record the following information: +For example configurations, see the [notes on specific providers](#set-up-identity-providers). -| | Value | Description | -|-------------|--------------|-----------------------------------------------------------------------------------| -| SSO URL | Depends | Google Identity Provider details. Set to the GitLab `idp_sso_target_url` setting. | -| Certificate | Downloadable | Run `openssl x509 -in <your_certificate.crt> -noout -fingerprint` to generate the SHA1 fingerprint that can be used in the `idp_cert_fingerprint` setting. | +## Glossary of common terms -While the Google Workspace Administrator provides IdP metadata, Entity ID, and SHA-256 -fingerprint, they are not required. GitLab does not need that information to -connect to the Google Workspace SAML app. +| Term | Description | +|--------------------------------|-------------| +| Identity provider (IdP) | The service which manages your user identities, such as Okta or OneLogin. | +| Service provider (SP) | GitLab can be configured as a SAML 2.0 SP. | +| Assertion | A piece of information about a user's identity, such as their name or role. Also known as claims or attributes. | +| Single Sign-On (SSO) | Name of authentication scheme. | +| Assertion consumer service URL | The callback on GitLab where users are redirected after successfully authenticating with the identity provider. | +| Issuer | How GitLab identifies itself to the identity provider. Also known as a "Relying party trust identifier". | +| Certificate fingerprint | Used to confirm that communications over SAML are secure by checking that the server is signing communications with the correct certificate. Also known as a certificate thumbprint. | ## Troubleshooting |