This document describes how to set up multi-factor authentication (MFA) for VMware Unified Access Gateway (UAG) with AuthPoint as an identity provider. VMware Unified Access Gateway must already be configured and deployed before you set up MFA with AuthPoint.
VMware Unified Access Gateway can be configured to support MFA in several modes. For this integration, we set up SAML with AuthPoint.
VMware Unified Access Gateway is a part of VMware Horizon 7. For SAML authentication to function, VMware Unified Access Gateway needs the services of VMware Horizon 7. In this document, VMware Horizon 7 employs VMware Connection Server for VMware UAG SAML authentication. SAML configuration is done both in VMware UAG and the VMware Connection Server.
The hardware and software used in this guide include:
- VMware Horizon 7
- VMware Unified Access Gateway 3.9.0
- VMware View Connection Server 7.12.0
- VMware vCenter Servers 7.0.0
- VMware Horizon Agent 7.12.0
- VMware Horizon Client 5.4.3
- AD DS, AD CS, and DNS on Windows Server 2016
- WatchGuard Cloud
VMware Unified Access Gateway SAML 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 VMware Unified Access Gateway.
Before You Begin
Before you begin these procedures, make sure that:
- Unified Access Gateway is connected to Horizon Connection Server
- Horizon Connection Server is connected to vCenter Server
- vCenter Server manages a Virtual Machine that has Horizon Agent installed
- Horizon Connection Server has published one or more apps that exist on the Virtual Machine with Horizon Agent installed
- You can use Horizon Client to log in to Connection Server and invoke published app(s) with a user that exists in the Active Directory domain
- A token is assigned to a user in AuthPoint
- You have an AuthPoint identity provider (IdP) certificate (see Certificate Management)
Configure Unified Access Gateway
To start, you must download the metadata file and the certificate file from the Certificate Management page in the AuthPoint management UI. After you have those, you can configure Unified Access Gateway.
From the WatchGuard Cloud web UI:
- 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 , 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 case, Unified Access Gateway, with information necessary to identify AuthPoint as a trusted identity provider.
- Log in to the Unified Access Gateway admin interface as an administrator.
- Under Configure Manually, click Select.
- Under Advanced Settings, click next to Upload Identity Provider Metadata.
- In the Entity ID text box, type the entityID value from the AuthPoint metadata file. This value should be https://sp.authpoint.cloud.watchguard.com/<your WatchGuard Cloud account ID>.
- Next to IDP Metadata, click Select and upload the metadata file you downloaded from AuthPoint.
- Click Save.
- In the General Settings section, enable the Edge Service Settings toggle.
- Next to Horizon Settings, click .
- Click More.
- From the Auth Methods drop-down list, select SAML.
- From the Identity Provider drop-down list, select the IDP you created.
- Click Download SAML service provider metadata. You use the information in this metadata file to configure a SAML resource in AuthPoint.
- In the External Host Name text box, type the host name that Horizon Client connects to.
- Click Download.
Configure Connection Server
- Log in to the View Connection Server admin interface as an administrator. View Connection Server is also called VMware Horizon 7.
- From the navigation menu, select Settings > Servers > Connection Servers.
- Select the existing connection server.
- Click Edit.
- Select the Authentication tab.
- From the Delegation of authentication to VMware Horizon (SAML 2.0 Authenticator): drop-down list, select Allowed.
- Click Manage SAML Authenticators.
- Click Add.
- For Type, select Static.
- In the Label text box, type a name. In our example, we name the SAML authenticator AuthPoint.
- In the SAML Metadata text box, copy AuthPoint metadata into it.
- Select the Enabled for Connection Server checkbox.
- Click OK.
- Click OK.
- Click OK.
Before AuthPoint can receive authentication requests from Unified Access Gateway, you must add a SAML resource in AuthPoint. You must also create an authentication policy for the Unified Access Gateway resource to determine which users can authenticate and log in to Unified Access Gateway 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.
- Type a name for this resource.
- From the Application Type drop-down list, select Unified Access Gateway.
- Open the SAML service provider metadata file you downloaded in the previous section and find the entityID and AssertionConsumerService Location values.
- In the Service Provider Entity ID text box, type the entityID value from the SAML service provider metadata file.
- In the Assertion Consumer Service text box, type the AssertionConsumerService Location value from the SAML service provider metadata file.
- From the User ID sent on redirection to service provider drop-down list, select User Name.
- 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 downloaded the metadata 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 Unified Access Gateway 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 the integration of AuthPoint and the configuration of Unified Access Gateway, 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).
Your AuthPoint user name must matche the AD DS user that you use to log in to Connection Server.
- Open VMware Horizon Client.
- Connect to Unified Access Gateway external FQDN. In our example, the FQDN is uag1.ecouag.com.
VMware Horizon Client opens a browser.
- Type your 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 VMware Connection Server, then you can invoke the published app