This document describes how to set up multi-factor authentication (MFA) for GitLab with AuthPoint as an identity provider. GitLab must already be configured and deployed before you set up MFA with AuthPoint.
GitLab Authentication Data Flow with AuthPoint
AuthPoint communicates with various cloud-based services and service providers with the SAML protocol. This diagram shows the data flow of an MFA transaction for GitLab.
Before You Begin
Before you begin these procedures, make sure that:
- End-users can log in to GitLab
- A token is assigned to a user in AuthPoint
- You have an AuthPoint identity provider (IdP) certificateAn AuthPoint IdP certificate is required for SAML authentication. (see Certificate Management)
To start, you must download the metadata fileThe metadata provides your resource with information necessary to identify AuthPoint as a trusted identity provider. from the Certificate Management page in the AuthPoint management UI. Once you have that, you can configure GitLab.
- Log in to WatchGuard Cloud.
- From the navigation menu, select Configure > AuthPoint. If you have a Service Provider account, you must first pivot to your Subscriber view.
- Select Resources.
- Click Certificate.
- Next to AuthPoint certificate you will associate with your resource, click and select Download Metadata.
We recommend that you choose the certificate with the latest expiration date.
The AuthPoint metadata provides your resource, in this case GitLab, with information necessary to identify AuthPoint as a trusted identity provider.
- Next the same certificate, click and select Copy Fingerprint.
The Copy Fingerprint window appears.
- From the Algorithm drop down list, select SHA-1
- Click Copy next to the formatted or unformatted fingerprint. We recommend you leave this window open.
- Open a new tab in your web browser and log in to GitLab as an administrator.
- Select Groups > Your groups.
- Select Settings> SAML SSO.
- Copy the Assertion consumer service URL and the Identifier.
- Select the Enable SAML authentication for this group slider.
- Open the AuthPoint metadata file you downloaded and find the SingleSignOnService Location value.
- In the Identity provider single sign on URL text box, type or paste the SingleSignOnService Location value from the AuthPoint metadata file.
- In the Certificate fingerprint text box, type or paste the AuthPoint fingerprint you copied earlier.
Click Save changes.
You must successfully test SAML single sign-on to save your changes. We recommend that you complete the steps in the next section to configure AuthPoint before you save your changes.
Before AuthPoint can receive authentication requests from GitLab, you must add a SAML resource for GitLab in AuthPoint. You must also assign the GitLab SAML resource to the user group that must authenticate to log in to GitLab.
Add a GitLab Resource in AuthPoint
From the AuthPoint management UI:
- From the navigation menu, select Resources.
- From the Choose a Resource Type drop-down list, select SAML. Click Add Resource.
- On the SAML page, in the Name text box, type a name for this resource.
- From the Application Type drop-down list, select Gitlab.
- In the Service Provider Entity ID text box, type or paste the Assertion consumer service URL value copied from the SAML Single Sign On Settings page in GitLab.
- In the Assertion Consumer Service text box, type or paste the Assertion consumer service URL value copied from the SAML Single Sign On Settings page in GitLab.
- From the User ID drop-down list, select Email.
- From the Signature Method drop-down list, select SHA-256.
- From the AuthPoint Certificate drop-down list, select the certificate to associate with your resource.
We recommend that you choose the certificate with the latest expiration date. For more information, see Certificate Management.
- Click Save.
Add an Access Policy to AuthPoint
You must have at least one user group in AuthPoint for authentication with GitLab, and you must assign an access policy for the GitLab resource to that group. If you already have a group, you do not have to add another group.
In the AuthPoint management UI:
- From the navigation menu, select Groups.
- To add a new group, click Add Group. If you already have a group that you want to use, select the group to edit it.
- In the Name text box, type a descriptive name for the group.
- (Optional) In the Description text box, type a description of the group.
- In the Access Policy section, click Add Policy.
- In the Add Policy dialog box, from the Resource drop-down list, select the resource you want to add an access policy for.
- (Optional) To require that users type their password before they authenticate for this resource, select the Require Password Authentication slider.
- Select the authentication options that users in this group can choose from when they authenticate.
For SAML resources, if you select more than one authentication option, users must choose one of the available options when they authenticate. For example, if you select OTP and Push, users can choose to type their OTP or approve a push to authenticate. You cannot require that they do both.
- Click Add.
- (Optional) Add one or more safe locations to your group. For more information about safe locations and detailed instructions to add them, see About Safe Locations.
- Click Save.
Before you assign users to a group, you must add them to AuthPoint. You can manually add user accounts or import user accounts from your LDAP database. For more information on how to add user accounts, see Add User Accounts.
The email address or user name of your AuthPoint user account must match the user name or email address you use to log in to GitLab.
Test the Integration
To test AuthPoint MFA with GitLab, you can authenticate with a token on your mobile device. You can choose any method (push, QR code, or one-time password).
In this example, we show the push authentication method (users receive a push notification in the mobile app that they must approve to authenticate).
- In a web browser, navigate to the GitLab single sign on URL (shown on the SAML Single Sign On Settings page in GitLab).
- Click Sign in with Single Sign-On
- Type your email address or AuthPoint user name. Click Sign In.
- If required, in the Password text box, type your password.
- For the authentication method, select Push.
- Click Send.
- Approve the authentication request that is sent to your mobile device.
You are logged in to GitLab successfully.