F5 BIG-IP APM SAML Integration with AuthPoint

Deployment Overview

This document describes how to set up multi-factor authentication (MFA) for F5 BIG-IP Access Policy Manager (APM) with AuthPoint as an identity provider. BIG-IP APM must already be configured and deployed before you set up MFA with AuthPoint.

F5 BIG-IP APM can be configured to support MFA in several modes. For this integration, we set up SAML authentication with AuthPoint.

This integration was tested with BIGIP-17.1.1.3-0.0.5.

Contents

• F5 BIG-IP APM SAML Integration with AuthPoint
• • Deployment Overview
  • Contents
  • • BIG-IP APM Authentication Data Flow with AuthPoint
  • Before You Begin
  • Configure BIG-IP APM
  • • Download AuthPoint Metadata
    • Configure AuthPoint as an Identity Provider
    • Configure BIG-IP APM as a Service Provider
    • Configure a Lease Pool
    • Configure Network Access
    • Configure a Connectivity Profile
    • (Optional) Configure Webtop
    • (Optional) Configure Webtop Links
    • Configure an Access Profile
    • Edit the Access Profile
    • Configure Virtual Server
  • Configure AuthPoint
  • • Export F5 BIG-IP APM metadata
    • Add a SAML Resource in AuthPoint
    • Add a Group in AuthPoint
    • Add an Authentication Policy to AuthPoint
    • Add Users to AuthPoint
  • Test the Integration

BIG-IP APM 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 BIG-IP APM.

Before You Begin

Before you begin these procedures, make sure that:

• You have installed BIG-IP APM and finished the initialization setup (Setup Utility)
• A token is assigned to a user in AuthPoint
• You have an AuthPoint identity provider (IdP) certificate An AuthPoint IdP certificate is required for SAML authentication. (go to Certificate Management)

Configure BIG-IP APM

In the F5 BIG-IP Setup Utility, in the Resource Provisioning step, you must change Access Policy (APM) to Nominal. The default is Local Traffic (LTM).

Download AuthPoint Metadata

To start, you must download the metadata file The metadata provides your resource with information necessary to identify AuthPoint as a trusted identity provider. from the Certificate Management page in the AuthPoint management UI. After you have that, you can configure BIG-IP APM.

1. Log in to WatchGuard Cloud.
2. From the navigation menu, select Configure > AuthPoint. If you have a Service Provider account, you must select an account from Account Manager.
3. Select Resources.
4. Click Certificate.



5. 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. If you do not have a certificate, or if all of your certificates have expired, click Add Certificate and use the newly created certificate.

   The AuthPoint metadata provides your resource, in this case BIG-IP APM, with information necessary to identify AuthPoint as a trusted identity provider.

Configure AuthPoint as an Identity Provider

The BIG-IP APM system is a SAML service provider. It sends authentication requests to AuthPoint and receives assertions from the AuthPoint (the identity provider).

AuthPoint must be set as an identity provider. This requires the metadata file that you downloaded in the Download AuthPoint Metadata section.

1. Select Access > Federation > SAML Service Provider > External IdP Connectors.
2. Select Create > From Metadata.
3. Click Browse to select the AuthPoint metadata file you downloaded in the Download AuthPoint Metadata section.
4. Type a name for the identity provider (AuthPoint). In our example, we type AuthPoint_SAML.



5. Click OK.

Configure BIG-IP APM as a Service Provider

1. Log in to the BIG-IP APM web UI from the management port (https://management port IP address).
2. Select Access > Federation > SAML Service Provider > Local SP Services.
3. Click Create.
4. Type a name for the service provider (BIG-IP APM). In our example, we type BIGIP-SAML.
5. In the Entity ID text box, type the external access URL of the BIG-IP APM.



6. Leave the default value for all other settings.
7. Click OK.
8. Select the service provider you created for BIG-IP APM.
9. Click Bind/Unbind IdP Connectors.





10. Click Add New Row.



11. From the SAML IdP Connectors drop-down list, select the IdP connector you created for AuthPoint.
12. Click Update.



13. Click OK.

Configure a Lease Pool

You configure a lease pool to associate a group of IPv4 or IPv6 addresses with a network access resource. When a lease pool is assigned to a network access resource, network access clients are automatically assigned unallocated IP addresses from the pool during the network access session.

To create an IPv4 lease pool to provide internal network addresses for network access tunnel users:

1. From the Main navigation pane, select Access > Connectivity/VPN > Network Access (VPN) > IPV4 Lease Pools.
2. Click Create.
3. Type a name for the lease pool.
4. For Type, select IP Address Range.
5. Type the Start IP Address and End IP Address.
6. Click Add.



7. Click Finished.

Configure Network Access

The BIG-IP APM Network Access feature provides users with the functionality of a traditional IPSec VPN client. With Network Access, employees, partners, and customers can securely access corporate resources from any location using a standard web browser or the BIG-IP Edge Client.

1. From the Main navigation pane, select Access > Connectivity/VPN > Network Access (VPN) > Network Access Lists.
2. Click Create.
3. Type a name for the Network Access.
4. Select the Auto launch check box.



5. Leave the default value for all other settings.
6. Click Finished.
7. Select the Network Settings tab.
8. From the IPV4 Lease Pool drop-down list, select the lease pool that you created.



9. Leave the default value for all other settings.
10. Click Update.

Configure a Connectivity Profile

A connectivity profile is the profile that is selected in a virtual server definition to define connectivity and client settings for a network access session.

1. From the Main navigation pane, select Access > Connectivity/VPN > Connectivity > Profiles.
2. Click Add.
3. Type a name for the Connectivity Profile.
4. From the Parent Profile drop-down list, select /Common/connectivity.



5. Leave the default value for all other settings.
6. Click OK.

(Optional) Configure Webtop

A Webtop is a remote implementation of a desktop environment that provides the functionality of a local machine. You connect to a Webtop with a web browser.

You can define three types of webtops in BIG-IP APM:

• A network access only Webtop
• A portal access Webtop
• A full Webtop

To configure a Full Webtop:

1. From the Main navigation pane, select Access > Webtops > Webtop Lists.
2. Click Create.
3. Type a name for the webtop.
4. From the Type drop-down list, select Full.



5. Leave the default value for all other settings.
6. Click Finished.

(Optional) Configure Webtop Links

Webtop links are the links to the resources that you add to the Webtop. After the user authenticates, they see links to the resources on their Webtop.

1. From the Main navigation pane, select Access > Webtop > Webtop Links.
2. Click Create.
3. Type a name for the webtop link.
4. From the Link Type drop-down list, select Application URI.
5. In the Application URI text box, type a URI link. In our example, we type https://watchguard.com/.



6. Leave the default value for all other settings.
7. Click Finished

Configure an Access Profile

The access profile is where you define the criteria for granting or denying access to the various servers, applications, and other resources on the network.

1. Select Access > Profiles/Policies > Access Profiles (Per-Session Policies).
2. Click Create.
3. Type a name for the Access Profile.
4. From the Profile Type drop-down list, select SSL-VPN.



5. In the Language Settings, add English to Accepted Languages.



6. Leave the default value for all other settings.
7. Click Finished.

Edit the Access Profile

You can use an Access Policy to define a sequence of checks to enforce the required level of security on a user’s system before that user is granted access to servers, applications, and other resources on the network.

An access policy can also include authentication verifications to authenticate a user before access to network resources is granted.

1. In the row of the Access Profile that you added, click Edit.



2. Click +.

The first page for a user will be the redirected page for SAML authentication. To add the SAML authentication redirection:

1. Under the Authentication tab, select SAML Auth.



2. Click Add Item.
3. From the AAA Server drop-down list, select the service provider that you created in the previous section.



4. Click Save.



5. Click Deny next to Successful.
6. Select Allow.



7. Click Save.

When a user successfully authenticates, they see a webtop with customized resources and a Network Access.

To add a webtop and a Network Access:

1. Click the + next to Successful.
2. Select the Assignment tab.
3. Select Advanced Resource Assign.



4. Click Add Item.



5. Click Add new entry.
6. Under Expression, click Add/Delete.



7. Select the Network Access tab.
8. Select the Network Access that you created.



9. Select the Webtop Links tab.
10. Select the Webtop Link that you created.



11. Select the Webtop tab.
12. Select the Webtop that you created.



13. Click Update.
14. Click Save.



15. To apply the configuration, click Apply Access Policy in the upper left corner.
16. Click Close.

Configure Virtual Server

With BIG-IP APM, virtual servers are configured with specific settings for network access connections or web application access. The IP address assigned to a host virtual server is the one that is usually exposed to the Internet.

You can configure a remote access connection to one or more internal web applications. With web applications, you create an Access Policy and local traffic virtual server so that end users can access internal web applications through a single external virtual server.

1. From the Main navigation pane, select Local Traffic > Virtual Servers > Virtual Server List.
2. Click Create.
3. In the General Properties section, type a name for the Virtual Server.
4. From the Type drop-down list, select Standard.
5. For Source Address, select Host and type 0.0.0.0/0 in the text box.
6. For Destination Address/Mask, select Host and type the virtual server host IP address in the text box.
7. For Service Port, select Port.
8. From the drop-down list, select HTTPS.



9. In the Configuration section, from the HTTP Profile (Client) drop-down list, select http.
10. From the HTTP Profile (Server) drop-down list, select Use Client Profiles.
11. In the SSL Profile (Client) select the clientssl profile to use with this virtual server.
12. In the SSL Profile (Server) select the serverssl profile to use with this virtual server.



13. In the Access Policy section, from the Access Profile drop-down list, select the Access Profile that was previously created.
14. From the Connectivity Profile drop-down list, select the Connectivity Profile that was previously created.



15. Leave the default value for all other settings.
16. Click Finished.

Configure AuthPoint

Before AuthPoint can receive authentication requests from F5 BIG-IP APM, you must add a SAML resource In AuthPoint, resources are the applications and services that your users connect to. in AuthPoint. You must also create an authentication policy Authentication policies specify which resources users can authenticate to and which authentication methods they can use (Push, QR code, and OTP). for the F5 BIG-IP APM resource to determine which users can authenticate and log in to F5 BIG-IP APM and which authentication methods they can use (Push, QR code, and OTP).

Export F5 BIG-IP APM metadata

1. From the Main navigation pane, select Access > Federation > SAML Service Provider > Local SP Services.
2. Select the check box next to your service provider.
3. From the bottom of the page, click Export Metadata.





4. From the Sign Metadata drop-down list, select No.
5. Click Download.

Add a SAML Resource in AuthPoint

From the AuthPoint management UI:

1. From the navigation menu, select Resources. Click Add Resource.
   The Add Resource page opens.

2. From the Type drop-down list, select SAML.
   Additional fields appear.

3. In the Name text box, type a name for this resource.
4. From the Application Type drop-down list, select F5 Big-IP APM.
5. Open the BIG-IP APM metadata file you downloaded and find the entityID and AssertionConsumerService Location values.
6. In the Service Provider Entity ID text box, type or paste the entityID value from the BIG-IP APM metadata file.
7. In the Assertion Consumer Service text box, type or paste the AssertionConsumerService Location value from the BIG-IP APM metadata file.
8. From the User ID sent on redirection to service provider drop-down list, select User Name. The user ID is the attribute for an AuthPoint user that is compared to the user name in your application.
9. From the Signature Method drop-down list, select SHA-256.
10. From the AuthPoint Certificate drop-down list, select the AuthPoint certificate to associate with your resource. This must be the same certificate that you used to download the metadata file in the Download AuthPoint Metadata section.

11. 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 WatchGuard Cloud-hosted group to the WatchGuard Cloud Directory:

1. Go to Configure > Directories and Domain Services.
2. Click the WatchGuard Cloud Directory domain name. If you have not yet added the WatchGuard Cloud Directory, click Add Authentication Domain and select the WatchGuard Cloud Directory.
   The New Group page appears.

3. In the Groups tab, click Add Group.
4. In the Group Name text box, type a descriptive name for the group.
5. (Optional) In the Description text box, type a description of the group.

6. Click Save.
   Your group is added to the WatchGuard Cloud Directory and to AuthPoint.

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 F5 BIG-IP APM 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:

1. From the navigation menu, select Authentication Policies.
2. Click Add Policy.

3. Type a name for this policy.
4. 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.

5. 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.
6. 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.

7. (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 are the same as 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.

8. 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 WatchGuard Cloud-hosted 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 AuthPoint MFA with BIG-IP APM, 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).

The user name that you use must be associated with both your AuthPoint and BIG-IP APM user accounts.

To test the AuthPoint MFA:

1. Open a web browser and go to https://virtual server IP address.



2. Type your AuthPoint user name, then click Next.
3. If required, in the Password text box, type your password.
4. For the authentication method, select Send Push.
5. Approve the authentication request that is sent to your mobile device.
6. Click Network Access.



7. (Optional) If you haven't installed the Network Access client yet, you need to download and install the Network Access client first.



8. Click Open F5 Network VPN.