realaravinth/debian-mirror-gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
debian-mirror-gitlab/doc/user/group/saml_sso/index.md
Pirate Praveen 81ade28521 New upstream version 13.8.5+ds1
2021-03-08 18:12:59 +05:30

28 KiB
Raw Blame History

type stage group info
reference, howto Manage Access To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

SAML SSO for GitLab.com groups (SILVER ONLY)

Introduced in GitLab 11.0.

This page describes SAML for Groups. For instance-wide SAML on self-managed GitLab instances, see SAML OmniAuth Provider.

SAML on GitLab.com allows users to sign in through their SAML identity provider. If the user is not already a member, the sign-in process automatically adds the user to the appropriate group.

If you follow our guidance to automate user provisioning using SCIM or group-managed accounts, you do not need to create such accounts manually.

User synchronization of SAML SSO groups is supported through SCIM. SCIM supports adding and removing users from the GitLab group. For example, if you remove a user from the SCIM app, SCIM removes that same user from the GitLab group.

SAML SSO is not supported at the subgroup level.

Configuring your Identity Provider

  1. Navigate to the group and click Settings > SAML SSO.
  2. Configure your SAML server using the Assertion consumer service URL, Identifier, and GitLab single sign-on URL. Alternatively GitLab provides metadata XML configuration. See specific identity provider documentation for more details.
  3. Configure the SAML response to include a NameID that uniquely identifies each user.
  4. Configure required assertions if using Group Managed Accounts.
  5. Once the identity provider is set up, move on to configuring GitLab.

Issuer and callback for configuring SAML identity provider with GitLab.com

NameID

GitLab.com uses the SAML NameID to identify users. The NameID element:

  • Is a required field in the SAML response.
  • Must be unique to each user.
  • Must be a persistent value that will never change, such as a randomly generated unique user ID.
  • Is case sensitive. The NameID must match exactly on subsequent login attempts, so should not rely on user input that could change between upper and lower case.
  • Should not be an email address or username. We strongly recommend against these as it's hard to guarantee it doesn't ever change, for example, when a person's name changes. Email addresses are also case-insensitive, which can result in users being unable to sign in.

The relevant field name and recommended value for supported providers are in the provider specific notes. appropriate corresponding field.

WARNING: Once users have signed into GitLab using the SSO SAML setup, changing the NameID breaks the configuration and potentially locks users out of the GitLab group.

NameID Format

We recommend setting the NameID format to Persistent unless using a field (such as email) that requires a different format.

Metadata configuration

GitLab provides metadata XML that can be used to configure your Identity Provider.

  1. Navigate to the group and click Settings > SAML SSO.
  2. Copy the provided GitLab metadata URL.
  3. Follow your Identity Provider's documentation and paste the metadata URL when it's requested.

Configuring GitLab

After you set up your identity provider to work with GitLab, you must configure GitLab to use it for authentication:

  1. Navigate to the group's Settings > SAML SSO.
  2. Find the SSO URL from your Identity Provider and enter it the Identity provider single sign-on URL field.
  3. Find and enter the fingerprint for the SAML token signing certificate in the Certificate field.
  4. Select the access level to be applied to newly added users in the Default membership role field. The default access level is 'Guest'.
  5. Click the Enable SAML authentication for this group toggle switch.
  6. Click the Save changes button.

Group SAML Settings for GitLab.com

NOTE: Please note that the certificate fingerprint algorithm must be in SHA1. When configuring the identity provider, use a secure signature algorithm.

SSO enforcement

  • Introduced in GitLab 11.8.
  • Improved in GitLab 11.11 with ongoing enforcement in the GitLab UI.
  • Improved in GitLab 13.8, with an updated timeout experience.
  • Improved in GitLab 13.8 with allowing group owners to not go through SSO.

With this option enabled, users must go through your group's GitLab single sign-on URL. They may also be added via SCIM, if configured. Users can't be added manually, and may only access project/group resources via the UI by signing in through the SSO URL.

However, users are not prompted to sign in through SSO on each visit. GitLab checks whether a user has authenticated through SSO. If it's been more than 7 days since the last sign-in, GitLab prompts the user to sign in again through SSO. You can see more information about how long a session is valid in our user profile documentation.

We intend to add a similar SSO requirement for Git and API activity.

When SSO enforcement is enabled for a group, users can't share a project in the group outside the top-level group, even if the project is forked.

Providers

NOTE: GitLab is unable to provide full support for integrating identify providers that are not listed here.

Provider Documentation
Azure Configuring single sign-on to applications
Okta Setting up a SAML application in Okta
OneLogin Use the OneLogin SAML Test Connector

When configuring your identify provider, please consider the notes below for specific providers to help avoid common issues and as a guide for terminology used.

Azure setup notes

For a demo of the Azure SAML setup including SCIM, see SCIM Provisioning on Azure Using SAML SSO for Groups Demo. Please note that the video is outdated in regards to objectID mapping and the SCIM documentation should be followed.

GitLab Setting Azure Field
Identifier Identifier (Entity ID)
Assertion consumer service URL Reply URL (Assertion Consumer Service URL)
GitLab single sign-on URL Sign on URL
Identity provider single sign-on URL Login URL
Certificate fingerprint Thumbprint

We recommend:

  • Unique User Identifier (Name identifier) set to user.objectID.
  • nameid-format set to persistent.

Okta setup notes

For a demo of the Okta SAML setup including SCIM, see Demo: Okta Group SAML & SCIM setup.

GitLab Setting Okta Field
Identifier Audience URI
Assertion consumer service URL Single sign-on URL
GitLab single sign-on URL Login page URL (under Application Login Page settings)
Identity provider single sign-on URL Identity Provider Single Sign-On URL

Under Okta's Single sign-on URL field, check the option Use this for Recipient URL and Destination URL.

For NameID, the following settings are recommended; for SCIM, the following settings are required:

  • Application username (NameID) set to Custom user.getInternalProperty("id").
  • Name ID Format set to Persistent.

OneLogin setup notes

The GitLab app listed in the OneLogin app catalog is for self-managed GitLab instances. For GitLab.com, use a generic SAML Test Connector such as the SAML Test Connector (Advanced).

GitLab Setting OneLogin Field
Identifier Audience
Assertion consumer service URL Recipient
Assertion consumer service URL ACS (Consumer) URL
Assertion consumer service URL (escaped version) ACS (Consumer) URL Validator
GitLab single sign-on URL Login URL
Identity provider single sign-on URL SAML 2.0 Endpoint

Recommended NameID value: OneLogin ID.

Additional providers and setup options

The SAML standard means that a wide range of identity providers will work with GitLab. Unfortunately we have not verified connections with all SAML providers. For more information, see our discussion on providers.

Your identity provider may have relevant documentation. It may be generic SAML documentation, or specifically targeted for GitLab. Examples:

Your Identity Provider may require additional configuration, such as the following:

Field Value Notes
SAML Profile Web browser SSO profile GitLab uses SAML to sign users in via their browser. We don't make requests direct 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 Your Identity Provider responds to users with an HTTP form including the SAMLResponse, which a user's browser submits back to GitLab.
Sign SAML Response Yes We require this to prevent tampering.
X.509 Certificate in response Yes This is used to sign the response and checked against the provided fingerprint.
Fingerprint Algorithm SHA-1 We need a SHA-1 hash of the certificate used to sign the SAML Response.
Signature Algorithm SHA-1/SHA-256/SHA-384/SHA-512 Also known as the Digest Method, this can be specified in the SAML response. It determines how a response is signed.
Encrypt SAML Assertion No TLS is used between your Identity Provider, the user's browser, and GitLab.
Sign SAML Assertion Optional We don't require Assertions to be signed. We validate their integrity by requiring the whole response to be signed.
Check SAML Request Signature No GitLab does not sign SAML requests, but does check the signature on the SAML response.
Default RelayState Optional The URL users should end up on after signing in via a button on your Identity Provider.
NameID Format Persistent See details above.
Additional URLs You may need to use the Identifier or Assertion consumer service URL in other fields on some providers.
Single Sign Out URL Not supported

If the information you need isn't listed above you may wish to check our troubleshooting docs below.

User access and management

Improved in GitLab 13.7.

Once Group SSO is configured and enabled, users can access the GitLab.com group through the identity provider's dashboard. If SCIM is configured, please see the user access and linking setup section on the SCIM page.

When a user tries to sign in with Group SSO, GitLab attempts to find or create a user based on the following:

  • Find an existing user with a matching SAML identity. This would mean the user either had their account created by SCIM or they have previously signed in with the group's SAML IdP.
  • If there is no conflicting user with the same email address, create a new account automatically.
  • If there is a conflicting user with the same email address, redirect the user to the sign-in page to:
    • Create a new account with another email address.
    • Sign-in to their existing account to link the SAML identity.

Linking SAML to your existing GitLab.com account

To link SAML to your existing GitLab.com account:

  1. Sign in to your GitLab.com account.
  2. Locate and visit the GitLab single sign-on URL for the group you're signing in to. A group owner can find this on the group's Settings > SAML SSO page. If the sign-in URL is configured, users can connect to the GitLab app from the Identity Provider.
  3. Click Authorize.
  4. Enter your credentials on the Identity Provider if prompted.
  5. You are then redirected back to GitLab.com and should now have access to the group. In the future, you can use SAML to sign in to GitLab.com.

On subsequent visits, you should be able to go sign in to GitLab.com with SAML or by visiting links directly. If the enforce SSO option is turned on, you are then redirected to sign in through the identity provider.

Signing in to GitLab.com with SAML

  1. Sign in to your identity provider.
  2. From the list of apps, click on the "GitLab.com" app (The name is set by the administrator of the identity provider).
  3. You are then signed in to GitLab.com and redirected to the group.

Configure user settings from SAML response

Introduced in GitLab 13.7.

GitLab allows setting certain user attributes based on values from the SAML response. This affects users created on first sign-in via Group SAML. Existing users' attributes are not affected regardless of the values sent in the SAML response.

Supported user attributes

  • can_create_group - 'true' or 'false' to indicate whether the user can create new groups. Default is true.
  • projects_limit - The total number of personal projects a user can create. A value of 0 means the user cannot create new projects in their personal namespace. Default is 10000.

Example SAML response

You can find SAML responses in the developer tools or console of your browser, in base64-encoded format. Use the base64 decoding tool of your choice to convert the information to XML. An example SAML response is shown here.

   <saml2:AttributeStatement>
      <saml2:Attribute Name="email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">
         <saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.email</saml2:AttributeValue>
      </saml2:Attribute>
      <saml2:Attribute Name="first_name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
         <saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.firstName</saml2:AttributeValue>
      </saml2:Attribute>
      <saml2:Attribute Name="last_name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
         <saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">user.lastName</saml2:AttributeValue>
      </saml2:Attribute>
      <saml2:Attribute Name="can_create_group" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
         <saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">true</saml2:AttributeValue>
      </saml2:Attribute>
      <saml2:Attribute Name="projects_limit" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified">
         <saml2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">10</saml2:AttributeValue>
      </saml2:Attribute>
   </saml2:AttributeStatement>

Role

Starting from GitLab 13.3, group owners can set a 'Default membership role' other than 'Guest'. To do so, configure the SAML SSO for the group. That role becomes the starting access level of all users added to the group.

Existing members with appropriate privileges can promote or demote users, as needed.

If a user is already a member of the group, linking the SAML identity does not change their role.

Blocking access

To rescind access to the group, perform the following steps, in order:

  1. Remove the user from the user datastore on the identity provider or the list of users on the specific app.
  2. Remove the user from the GitLab.com group.

Unlinking accounts

Users can unlink SAML for a group from their profile page. This can be helpful if:

  • You no longer want a group to be able to sign you in to GitLab.com.
  • Your SAML NameID has changed and so GitLab can no longer find your user.

WARNING: Unlinking an account removes all roles assigned to that user within the group. If a user relinks their account, roles need to be reassigned.

For example, to unlink the MyOrg account, the following Disconnect button is available under Profile > Accounts:

Unlink Group SAML

Group Sync

For a demo of Group Sync using Azure, see Demo: SAML Group Sync.

When the SAML response includes a user and their group memberships from the SAML identity provider, GitLab uses that information to automatically manage that user's GitLab group memberships.

Ensure your SAML identity provider sends an attribute statement named Groups or groups like the following:

<saml:AttributeStatement>
  <saml:Attribute Name="Groups">
    <saml:AttributeValue xsi:type="xs:string">Developers</saml:AttributeValue>
    <saml:AttributeValue xsi:type="xs:string">Product Managers</saml:AttributeValue>
  </saml:Attribute>
</saml:AttributeStatement>

When SAML SSO is enabled for the top-level group, Maintainer and Owner level users see a new menu item in group Settings -> SAML Group Links. Each group (parent or subgroup) can specify one or more group links to map a SAML identity provider group name to a GitLab access level.

SAML Group Links navigation

To link the SAML Freelancers group in the attribute statement example above:

  1. Enter Freelancers in the SAML Group Name field.
  2. Choose the desired Access Level.
  3. Save the group link.
  4. Repeat to add additional group links if desired.

SAML Group Links

If a user is a member of multiple SAML groups mapped to the same GitLab group, the user gets the highest access level from the groups. For example, if one group is linked as Guest and another Maintainer, a user in both groups gets Maintainer access.

Glossary

Term Description
Identity Provider The service which manages your user identities such as ADFS, Okta, Onelogin, or Ping Identity.
Service Provider SAML considers GitLab to be a service provider.
Assertion A piece of information about a user's identity, such as their name or role. Also know as claims or attributes.
SSO Single Sign On.
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.

Passwords for users created via SAML SSO for Groups

The Generated passwords for users created through integrated authentication guide provides an overview of how GitLab generates and sets passwords for users created via SAML SSO for Groups.

Troubleshooting

This section contains possible solutions for problems you might encounter.

SAML debugging tools

SAML responses are base64 encoded, so we recommend the following browser plugins to decode them on the fly:

Specific attention should be paid to:

  • The NameID, which we use to identify which user is signing in. If the user has previously signed in, this must match the value we have stored.
  • The presence of a X509Certificate, which we require to verify the response signature.
  • The SubjectConfirmation and Conditions, which can cause errors if misconfigured.

Verifying configuration

For convenience, we've included some example resources used by our Support Team. While they may help you verify the SAML app configuration, they are not guaranteed to reflect the current state of third-party products.

Verifying NameID

In troubleshooting the Group SAML setup, any authenticated user can use the API to verify the NameID GitLab already has linked to the user by visiting https://gitlab.com/api/v4/user and checking the extern_uid under identities.

Similarly, group members of a role with the appropriate permissions can make use of the members API to view group SAML identity information for members of the group.

This can then be compared to the NameID being sent by the Identity Provider by decoding the message with a SAML debugging tool. We require that these match in order to identify users.

Users receive a 404

If a user is trying to sign in for the first time and the GitLab single sign-on URL has not been configured, they may see a 404. As outlined in the user access section, a group Owner will need to provide the URL to users.

Message: "SAML authentication failed: Extern uid has already been taken"

This error suggests you are signed in as a GitLab user but have already linked your SAML identity to a different GitLab user. Sign out and then try to sign in again using the SSO SAML link, which should log you into GitLab with the linked user account.

If you do not wish to use that GitLab user with the SAML login, you can unlink the GitLab account from the group's SAML.

Message: "SAML authentication failed: User has already been taken"

The user that you're signed in with already has SAML linked to a different identity. Here are possible causes and solutions:

Cause Solution
You've tried to link multiple SAML identities to the same user, for a given Identity Provider. Change the identity that you sign in with. To do so, unlink the previous SAML identity from this GitLab account before attempting to sign in again.

Message: "SAML authentication failed: Email has already been taken"

Cause Solution
When a user account with the email address already exists in GitLab, but the user does not have the SAML identity tied to their account. The user will need to link their account.

Message: "SAML authentication failed: Extern uid has already been taken, User has already been taken"

Getting both of these errors at the same time suggests the NameID capitalization provided by the Identity Provider didn't exactly match the previous value for that user.

This can be prevented by configuring the NameID to return a consistent value. Fixing this for an individual user involves unlinking SAML in the GitLab account, although this will cause group membership and to-dos to be lost.

Message: "Request to link SAML account must be authorized"

Ensure that the user who is trying to link their GitLab account has been added as a user within the identity provider's SAML app.

Stuck in a login "loop"

Ensure that the GitLab single sign-on URL has been configured as "Login URL" (or similarly named field) in the identity provider's SAML app.

Alternatively, when users need to link SAML to their existing GitLab.com account, provide the GitLab single sign-on URL and instruct users not to use the SAML app on first sign in.

The NameID has changed

Cause Solution
As mentioned in the NameID section, if the NameID changes for any user, the user can be locked out. This is a common problem when an email address is used as the identifier. Follow the steps outlined in the "SAML authentication failed: User has already been taken" section.

I need to change my SAML app

Users will need to unlink the current SAML identity and link their identity to the new SAML app.

I need additional information to configure my identity provider

Many SAML terms can vary between providers. It is possible that the information you are looking for is listed under another name.

For more information, start with your Identity Provider's documentation. Look for their options and examples to see how they configure SAML. This can provide hints on what you'll need to configure GitLab to work with these providers.

It can also help to look at our more detailed docs for self-managed GitLab. SAML configuration for GitLab.com is mostly the same as for self-managed instances. However, self-managed GitLab instances use a configuration file that supports more options as described in the external OmniAuth SAML documentation. Internally that uses the ruby-saml library, so we sometimes check there to verify low level details of less commonly used options.

It can also help to compare the XML response from your provider with our example XML used for internal testing.