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) certificate (see Certificate Management)
To start, you must download the metadata file from the Certificate Management page in the AuthPoint management UI. After 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 select an account from Account Manager.
- 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 AuthPoint certificate to associate with your resource. This must be the same certificate that you downloaded the metadata for in the previous section.
- 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, enable the Require Password Authentication toggle.
- Select the authentication options that users in this group can select from when they authenticate.
For SAML resources, if you select more than one authentication option, users must select 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.
Add Users to AuthPoint
Before you assign users to a group, you must add the users to AuthPoint. There are two ways to add AuthPoint user accounts:
- Sync users from an external user database
- Add local AuthPoint users
Each user must be a member of a group. You must add at least one group before you can add users to AuthPoint.
To import users from Active Directory, Azure Active Directory, or an LDAP database, you must add an external identity in the AuthPoint management UI. External identities connect to user databases to get user account information and validate passwords.
- To sync users from Active Directory or an LDAP database, you must add an LDAP external identity
- To sync users from Azure Active Directory, you must add an Azure AD external identity
When you sync users from an external user database, you can sync any number of users and they are all added to AuthPoint at one time. Users synced from an external user database use the password defined for their user account as their AuthPoint password.
You can create local AuthPoint users on the Users page in the AuthPoint management UI. Because you can create only one user at a time, you most commonly do this when you want to create test users or to add only a small number of users.
Unlike users synced from an external user database, local AuthPoint users define and manage their own AuthPoint password. When you add a local user account, the user receives an email that prompts them to set their password.
To learn how to add local AuthPoint user accounts, see Add Local AuthPoint Users.
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.