This document describes how to set up multi-factor authentication (MFA) for GitHub® with AuthPoint as an identity provider. GitHub must already be configured and deployed before you set up MFA with AuthPoint.
GitHub can be configured to support MFA in several modes. For this integration, we set up SAML with AuthPoint.
This integration was tested with the on-premise Enterprise version of GitHub. The steps should be the same for the online version of GitHub.
GitHub 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 a GitHub.
Before You Begin
Before you begin these procedures, make sure that:
- End-users can log in to GitHub
- A token is assigned to a user in AuthPoint (necessary to test the integration)
- You have an AuthPoint identity provider (IdP) certificate (see Certificate Management)
To start, you must download the metadata file and the certificate file from the Resources page in the AuthPoint management UI. Once you have those, you can configure GitHub.
- 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 and Download Certificate. We recommend that you choose the certificate with the latest expiration date.
The AuthPoint metadata provides your resource, in this GitHub, with information necessary to identify AuthPoint as a trusted identity provider.
- Navigate to https://<host name>:8443/setup/settings and log in to GitHub Enterprise.
- From the navigation menu, select Authentication.
- Select the SAML.
- Open the AuthPoint metadata file you downloaded and find the SingleSignOnService Location and entityID values.
- In GitHub, in the Single sign-on URL text box, paste the SingleSignOnService Location value from the AuthPoint metadata file.
- In the Issuer text box, paste the entityID value from the AuthPoint metadata file.
- Click Browse and upload the AuthPoint certificate you downloaded.
- Click Save Settings.
Before AuthPoint can receive authentication requests from GitHub, you must specify the GitHub client as a SAML resource in AuthPoint. You must also assign an access policy for the GitHub resource to the AuthPoint user group that will authenticate through GitHub.
Add a SAML 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.
- From the Application Type drop-down list, select GitHub.
- In the Service Provider Entity ID text box, type https://<hostname>.
- In the Assertion Consumer Service text box, type https://<hostname>/saml/consume.
- 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 GitHub, and you must assign an access policy for the GitHub 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.
Before you assign users to a group, you must add the users to AuthPoint. You can manually add user accounts or import user accounts from an external user database. For more information on how to add user accounts, see Add User Accounts.
Test the Integration
To test the integration of AuthPoint and GitHub, you can authenticate with a mobile token on your mobile device. You can choose any method (one-time password, QR code, or push).
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, go to the GitHub URL (https://<hostname>).
The AuthPoint single sign-on page appears.
- Type your email address or AuthPoint user name. Click Next.
- 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 GitHub.