VMware Cloud Director Integration with AuthPoint

Deployment Overview

This document describes how to set up multi-factor authentication (MFA) for VMware Cloud Director with AuthPoint as an identity provider. VMware Cloud Director must already be configured and deployed before you set up MFA with AuthPoint.

VMware Cloud Director can be configured to support MFA in several modes. For this integration, we set up SAML with AuthPoint.

Integration Summary

The hardware and software used in this guide include:

  • VMware Cloud Director 10.1.1.4916
  • WatchGuard Cloud

VMware Cloud Director 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 Cloud Director.

Diagram that shows the data flow of an MFA transaction for a SAML resource with the push authentication method.

Before You Begin

Before you begin these procedures, make sure that:

Configure VMware Cloud Director

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 VMware Cloud Director.

  1. Log in to WatchGuard Cloud.
  2. From the navigation menu, select Configure > AuthPoint. If you have a Service Provider account, you must first pivot to your Subscriber view.
  3. Select Resources.
  4. Click Certificate.

  1. Next to the 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, VMware Cloud Director, with information necessary to identify AuthPoint as a trusted identity provider.

  1. Log in to the VMware Cloud Director as an administrator.
  2. From the top navigation bar, select Administration.
  3. In the left panel, under Identity Providers, click SAML and click Edit.
  4. Select the Service Provider tab and enter the Entity ID.

Screen shot of the Edit SAML Configuration

  1. Select the Identity Provider tab.
  2. Enable Use SAML Identity Provider.
  3. Click and upload the metadata file you downloaded from AuthPoint.

Screen shot of the Edit SAML Configuration

  1. Click Save.

Screen shot of the SAML Configuration

  1. Click the Service Provider Metadata URL.
    The VMware Cloud Director metadata downloads.
  2. In the left navigation menu, under Provider Access Control, click Users.

Screen shot of the import users

  1. Click Import Users.
  2. From the Source drop-down list, select SAML.
  3. In the Enter the user names text box, type the user name. This user must exist in AuthPoint.
  4. From the Assign Role drop-down list, select the role.

Screen shot of the Import Users

  1. Click Save.
  2. In the left navigation menu, under Provider Access Control, click Groups.

Screen shot of the Groups

  1. Click Import Groups.
  2. From the Source drop-down list, select SAML.
  3. In the Enter the group names text box, type the group name. This group must exist in AuthPoint.
  4. From the Assign Role drop-down list, select the role.

Screen shot of the import group

  1. Click Save.

Configure AuthPoint

Before AuthPoint can receive authentication requests from VMware Cloud Director, you must add a SAML resource in AuthPoint. You must also assign an access policy for the VMware Cloud Director resource to the user group(s) that must authenticate to log in.

Add a SAML Resource in AuthPoint

From the AuthPoint management UI:

  1. From the navigation menu, select Resources.
  2. From the Choose a Resource Type drop-down list, select SAML. Click Add Resource.

  1. Type a name for this resource.
  2. From the Application Type drop-down list, select VMware Cloud Director.
  3. Open the SAML service provider metadata file you downloaded in the previous section , find the entityID, AssertionConsumerService Location and SingleLogoutService Location values.
  4. In the Service Provider Entity ID text box, type the entityID value from the SAML service provider metadata file.
  5. In the Assertion Consumer Service text box, type the AssertionConsumerService Location value from the SAML service provider metadata file. Format is https://VMware Cloud Director FQDN or ipaddress/login/org/system/saml/SSO/alias/vcd.
  6. From the User ID sent on redirection to service provider drop-down list, select User Name.
  7. In the Logout URL text box, type the SingleLogoutService Location value from the SAML service provider metadata file. Format is https://VMware Cloud Director FQDN or ipaddress/login/org/system/saml/SingleLogout/alias/vcd.
  8. From the Signature Method drop-down list, select SHA-256.
  9. 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.

Screen shot of the AuthPoint SAML config

  1. Click Save.

Add an Access Policy to AuthPoint

You must have at least one user group in AuthPoint for authentication with VMware Cloud Director, and you must assign an access policy for the VMware Cloud Director resource to that group. If you already have a group, you do not have to add another group.

In the AuthPoint management UI:

  1. From the navigation menu, select Groups.
  2. 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.

  1. In the Name text box, type a descriptive name for the group.
  2. (Optional) In the Description text box, type a description of the group.

  1. In the Access Policy section, click Add Policy.

  1. In the Add Policy dialog box, from the Resource drop-down list, select the resource you want to add an access policy for.
  2. (Optional) To require that users type their password before they authenticate for this resource, enable the Require Password Authentication toggle.
  3. 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.

  1. Click Add.

  1. (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.
  2. 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.

Test the Integration

To test the integration of AuthPoint and the configuration of VMware Cloud Director, 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).

  1. Open the VMware Cloud Director login interface.
  2. Type your AuthPoint user name. Click Next.
  3. If required, in the Password text box, type your password.
  4. Click Send Push.
  5. Approve the authentication request that is sent to your mobile device.
    You are logged in to VMware Cloud Director.