This document describes how to set up multi-factor authentication (MFA) for UDS Enterprise with AuthPoint as an identity provider. UDS Enterprise must already be configured and deployed before you set up MFA with AuthPoint.
UDS Enterprise can be configured to support MFA in several modes. For this integration, we set up SAML with AuthPoint.
This integration was tested with UDS Enterprise v3.0.
UDS Enterprise 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 UDS Enterprise.
Before You Begin
Before you begin these procedures, make sure that:
- You have a UDS system administrator account to access the UDS web administration
- You have a Service Provider and related base services that already deployed on UDS Server
- You have an OS Manager that runs configured service
- In UDS, you have a Transport and a Service Pool
- A token is assigned to a user in AuthPoint
- You have an AuthPoint identity provider (IdP) certificate (see Certificate Management)
A Service Pool consists of different parts: Base Services, OS Manager, Transports and Authenticators. You must create a Service Pool to enable the deployement of desktop services or virtual applications. To learn how to create a Service Pool, Service Provider, OS Manager, and Transport, see the UDS Enterprise documentation.
Configure UDS Enterprise
To start, you must copy the metadata URL from the Certificate Management page in the AuthPoint management UI. After you have that, you can configure UDS Enterprise.
- 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 Copy Metadata URL. We recommend that you choose the certificate with the latest expiration date.
The AuthPoint metadata provides your resource, in this case UDS Enterprise, with information necessary to identify AuthPoint as a trusted identity provider.
- Log in to UDS Enterprise web administration as a UDS system administrator.
- From the user menu, select Dashboard.
- Select Authenticators.
- From the New drop-down list, select SAML Authenticator.
The New Authenticator window opens.
- From the Main tab, in the Name text box, type SAML.
- In the Priority text box, type a number to specify the priority. A smaller number indicates a higher priority.
- In the Label text box, type saml.
- Select the Certificate tab.
- In the Private key text box, enter a private RSA key that is used for signatures and encryptions. To generate a private key using openssl, you can use this command: openssl genrsa -out private-key.pem 2048.
- In the Certificate text box, enter a self-signed certificate that is generated from the private key. To generate a self-signed certificate using openssl, you can use this command: openssl req -new -x509 -key private-key.pem -out cert.pem -days 360.
- Select the Metadata tab.
- In the IDP Metadata text box, type or paste the metadata URL that you copied from AuthPoint in the previous step.
- Select the Attributes tab.
- In the User name attrs text box, type username.
- In the Group name attrs text box, type groups.
- In the Real name attrs text box, type name.
- Select the Display tab.
- Enable the Visible toggle.
- Click test.
- Click Save.
- Select the SAML Authenticator you created, then click the Detail icon. You can also double-click the SAML Authenticator.
- Select the Groups tab.
- From the New drop-down list, select Group.
- In the Group text box, type a group name. The name of this group must match the name of the AuthPoint group your users belong to.
- From the State drop-down list, select Enabled.
- In the Service Pools drop-down list, select the service pools that you created.
- Click OK.
- Edit the SAML Authenticator you created. From the Metadata tab, copy the auto-generated URL from the Entity ID text box. You need this value when you configure AuthPoint.
- Open a new tab and go to the Entity ID URL that you just copied. Download the metadata .XML file.
- Open the downloaded metadata file and copy the AssertionConsumerService and SingleLogoutService values. You need this information when you configure AuthPoint.
Before AuthPoint can receive authentication requests from UDS Enterprise, you must add a SAML resource in AuthPoint. You must also create an authentication policy for the UDS Enterprise resource to determine which users can authenticate and log in to UDS Enterprise and which authentication methods they can use (Push, QR code, and OTP).
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.
- On the SAML page, type a name for this resource.
- From the Application Type drop-down list, select UDS Enterprise.
- In the Service Provider Entity ID text box, type the Entity ID value that you copied from UDS Enterprise in the previous section.
- In the Assertion Consumer Service text box, type the AssertionConsumerService Location value you copied from the UDS metadata file that you downloaded in the previous section.
- From the User ID sent on redirection to service provider drop-down list, select Email or User Name.
- In the Logout URL text box, type the SingleLogoutService Location value you copied from the UDS metadata file that you downloaded in the previous section
- 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. This must be the same certificate that you copied the metadata URL for in the previous section.
- Click Save.
Add a Group in AuthPoint
You must have at least one user group in AuthPoint to configure MFA. If you already have a group, you do not have to add another group.
To add a group to AuthPoint:
- From the navigation menu, select Groups.
- Click Add Group.
The New Group page appears.
- In the Name text box, type a descriptive name for the group.
- (Optional) In the Description text box, type a description of the group.
- Click Save.
Your group is listed on the Groups page.
Add an Authentication Policy to AuthPoint
Authentication policies specify which resources users can authenticate to and which authentication methods they can use (Push, QR code, and OTP).
You must have at least one authentication policy in AuthPoint that includes the UDS Enterprise resource. If you already have authentication policies, you do not have to create a new authentication policy. You can add this resource to your existing authentication policies.
Users that do not have an authentication policy for a specific resource cannot authenticate to log in to that resource.
To configure an authentication policy:
- From the navigation menu, select Authentication Policies.
- Click Add Policy.
- Type a name for this policy.
- From the Select the authentication options drop-down list, select Authentication options and select which authentication options users can choose 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.
- Select which groups this policy applies to. You can select more than one group. To configure this policy to apply to all groups, select All Groups.
- Select the resource that you created in the previous section. If you want this policy to apply to additional resources, select each resource this policy applies to. To configure this policy to apply to all resources, select All Resources.
(Optional) If you have configured policy objects such as a Network Location, select which policy objects apply to this policy. When you add a policy object to a policy, the policy only applies to user authentications that match the conditions of the policy objects. For example, if you add a Network Location to a policy, the policy only applies to user authentications that come from that Network Location. Users who only have a policy that includes a Network Location do not get access to the resource when they authenticate outside of that Network Location (because they do not have a policy that applies, not because authentication is denied).
If you configure policy objects, we recommend that you create a second policy for the same groups and resources without the policy objects. The policy with the policy objects should have a higher priority.
- Click Save.
Your policy is created and added to the end of the policy list.
When you create a new policy, we recommend that you review the order of your policies. AuthPoint always adds new policies to the end of the policy list.
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.
Test the Integration
To test AuthPoint MFA with UDS Enterprise, you can authenticate with a mobile token on your mobile device. For SAML resources, 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, go to the IP address or UDS Server name (broker).
- From the Authenticator drop-down list, select SAML.
- 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 Send Push.
- Approve the authentication request that is sent to your mobile device.
You are logged in to UDS.