Configure Bot Defense on an HTTP load balancer

Important: Bot Defense self-service policy management is an early access feature.

You can enable Bot Defense on one or more HTTP load balancers in either Web App & API Protection or Multi-Cloud App Connect.

Complete the following tasks on each HTTP load balancer where you want to enable Bot Defense:

1. Enable Bot Defense on one or more HTTP load balancers.
2. Configure how you want Bot Defense to inject JavaScript tags in the HTML pages in your application. To detect automation, Bot Defense adds JavaScript, which runs in users' browsers. The JavaScript collects data that distinguishes between human visitors and automation.
3. If you are protecting mobile endpoints, enable the F5 Distributed Cloud Mobile SDK. The F5 Mobile SDK collects telemetry that is then inspected by Bot Defense to determine if requests initiated from legitimate mobile devices.

When you enable Bot Defense on an HTTP load balancer in Web App & API Protection, you can view the Bot Defense dashboard from the load balancer. For information, see Bot Defense dashboard.

Before you begin:

• You must purchase Bot Defense. You must have an active F5 Distributed Cloud account. If you don't have an account, see Get Started with Distributed Cloud Console.
• Configure your Bot Endpoint Policies and Bot Allowlist Policies.
• Configure your Bot Defense infrastructure or work with your F5 Operations team to help them configure your infrastructure. If you plan to configure protection for both mobile and web endpoints, you must have separate infrastructures for each type.
• You must have an HTTP load balancer created in Web App & API Protection or Multi-Cloud App Connect. For information about how to create an HTTP load balancer, see Step 2 of the Web App Security & Performance Quick Start.
• If you have CORS policy enabled on your application, make sure you enable the CORS policy on the load balancer. When the CORS policy is configured, specific headers are automatically added to requests that use CORS, for example, <header-a>, <header-ao> and so on. Bot Defense requires these headers to process CORS requests. For information about the CORS policy, see the HTTP Load Balancer configuration documentation.

Enable Bot Defense on an HTTP load balancer

The following steps explain how to enable Bot Defense on an HTTP load balancer that you configured in the F5 Distributed Cloud Console. You can enable Bot Defense on multiple load balancers.

1. From the Distributed Cloud Console home page, select Web App & API Protection or Multi-Cloud App Connect.
2. From the navigation menu, confirm that you selected the correct namespace.
3. Select Manage > Load Balancers > HTTP Load Balancers.
4. From the Actions column, select the Action (...) menu next to the load balancer where you want to configure Bot Defense and then select Manage Configuration.
5. Select Edit Configuration and then select Bot Management.
6. In the Bot Management section, from the Bot Defense drop-down menu, select Enable Bot Defense Advanced.
7. Configure one or both of the following:

   • Select the Bot Defense infrastructure that you want to use to process your web-based traffic.

   • Select the Bot Defense infrastructure that you want to use to process your mobile traffic.

   Note: Bot Defense automatically performs health checks on the highly-available Bot Defense infrastructure. If the health check is unsuccessful, your traffic automatically bypasses Bot Defense and continues to the next hop configured on the load balancer.

Next steps

Configure how Bot Defense injects JavaScript tags in your HTML pages. See Configure web JavaScript settings.

Configure web JavaScript settings

To protect web-based endpoints, you must configure how Bot Defense injects JavaScript tags in the HTML pages that make calls to protected endpoints. To detect automation, Bot Defense adds JavaScript, which runs in users' browsers and collects data that distinguishes between human visitors and automation.

Note: If necessary, you can disable JavaScript tag insertion at any time. For information, see Disable JavaScript insertion.

To configure how you want Bot Defense to inject JavaScript tags, from the Web Client JavaScript Settings drop-down menu, select one of the following options:

Custom JavaScript Insertion Rules

Select Custom JavaScript Insertion Rules to configure matches for HTML pages in which Bot Defense inserts JavaScript tags, and then configure matches for a subset of those pages that you want to exclude.

Figure: Configure Custom JavaScript Insertion Rules

1. To configure matches for pages in which you want to insert Bot Defense JavaScript tags, in the JavaScript Insertions section, select Configure.

2. Select Add and then enter the following information for each page in which you want Bot Defense to insert JavaScript tags:

   • Name: A name to identify the included page. The name must follow DNS-1035 format.
   • Description: A human-readable description of the included page.
   • Domain Matcher: Specify domains you want to include. Enter an Exact Value, a Suffix Value, or a Regex Value. If you select, Any Domain, then Bot Defense injects JavaScript tags in HTML pages from all domains.
   • Path: Specify protected paths, such as /login. Enter a Prefix, Exact path, or Regex value.

3. In the JavaScript Location drop-down menu, specify where in your HTML pages you want Bot Defense to inject JavaScript tags:

   • After <head>
   • After </title>
   • Before <script>

   F5 recommends that you select After <head> so that the JavaScript is executed early in the page loading process. This helps to avoid conflicts with other scripts and allows time for the Bot Defense JavaScript to be executed while the rest of page renders.

   If you select After </title>, be sure your application pages have the <title> tag.

4. Select Apply. Then select Apply again.

5. To configure matches for a subset of pages in which you don't want to insert JavaScript tags, in the Exclude Pages section, select Configure.

6. Select Add and then enter the following information for each page in which you don't want Bot Defense to insert JavaScript tags:

   • Name: A name to identify the excluded page. The name must follow DNS-1035 format.
   • Description: A human-readable description of the excluded page.
   • Domain Matcher: Specify domains you want to exclude. Enter an Exact Value, a Suffix Value, or a Regex Value. If you select, Any Domain, then Bot Defense doesn't inject JavaScript tags in HTML pages from any domain.
   • Path: Specify excluded paths, such as /about. Enter a Prefix, Exact path, or Regex value.

7. Select Apply. Then select Apply again.

Insert JavaScript in All Pages with Exceptions

Select Insert JavaScript in All Pages with Exceptions to inject JavaScript tags in all of your HTML pages except for the ones you explicitly exclude.

1. In the JavaScript Location drop-down menu, specify where in your HTML pages you want Bot Defense to inject JavaScript tags:

   • After <head>
   • After </title>
   • Before <script>

   F5 recommends that you select After <head> so that the JavaScript is executed early in the page loading process. This helps to avoid conflicts with other scripts and allows time for the Bot Defense JavaScript to be executed while the rest of the page renders.

   If you select After </title>, be sure your application pages have the <title> tag.

2. In the Exclude Pages section, select Configure and then select Add.

3. Enter the following information for each page in which you don't want to insert the Bot Defense JavaScript.

   • Name: A name to identify the excluded page. The name must follow DNS-1035 format.
   • Description: A human-readable description of the endpoint.
   • Domain Matcher: Specify domains you want to exclude. Enter an Exact Value, a Suffix Value, or a Regex Value. If you select, Any Domain, then Bot Defense doesn't inject JavaScript tags in HTML pages from any domain.
   • Path: Specify protected paths here. Enter a Prefix, Exact path, or Regex value.

4. Select Apply.

   

   Figure: Insert JavaScript Tag in All Pages with Exceptions

Insert JavaScript in All Pages

Select Insert JavaScript in All Pages to inject JavaScript tags in all of your HTML pages.

1. From the Web Client JavaScript Settings drop-down menu, select Insert JavaScript in All Pages.

2. In the JavaScript Location drop-down menu, specify where in your HTML pages you want Bot Defense to inject JavaScript tags:

   • After <head>
   • After </title>
   • Before <script>

   F5 recommends that you select After <head> so that the JavaScript is executed early in the page loading process. This helps to avoid conflicts with other scripts and allows time for the Bot Defense JavaScript to be executed while the rest of page renders.

   If you select After </title>, be sure your application pages have the <title> tag.

   Note: If necessary, you can disable JavaScript tag insertion at any time. For information, see Disable JavaScript insertion.

Next steps

If you plan to protect mobile endpoints, enable the F5 Distributed Cloud Mobile SDK. See Enable the F5 Mobile SDK. Otherwise select Save HTTP Load Balancer and see Next steps.

Enable the F5 Mobile SDK

To protect mobile endpoints, enable Distributed Cloud Mobile SDK settings. Then configure the header values that Bot Defense uses to distinguish mobile requests from web requests. The Mobile SDK collects telemetry and adds headers to requests, which Bot Defense inspects to determine if the requests originated from legitimate mobile devices.

Important: For information about protecting mobile endpoints, see Protect mobile endpoints.

1. From the Mobile SDK Settings drop-down menu, select Mobile SDK Configuration.
2. In the Mobile Request Identifier Headers section, select Add.
3. In the Header Matcher section, enter the Header Name to identify the header you want Bot Defense to use to distinguish mobile requests from web requests.
4. From the Match Options drop-down menu, select one of the following options:
   • Match Values: Enter the Exact Values and Regex Values for the header that Bot Defense can use to identify mobile requests.
   • Present: Bot Defense checks that the header name you entered is present.
   • Not Present: Bot Defense checks that the header name you entered isn't present.
5. Optionally select Transformers to apply to the match values you entered.
6. Select Apply, and then select Save HTTP Load Balancer.

Next steps

After you enable Bot Defense on your HTTP load balancers, go to the Distributed Cloud Console to complete the following tasks:

• Add the hostnames of the HTTP load balancers where you enabled Bot Defense to either the Upstream Routing section or Manual Routing section of your Bot Network Policy. For example, enter lb.example.com. If you enabled Bot Defense on multiple load balancers, add an entry for each hostname.
• Review your Bot Endpoint Policies and Bot Allowlist Policies to confirm your settings are correct.
• Test Bot Defense to ensure that Bot Defense is properly configured, that it injects JavaScript tags in your HTML pages correctly, or that you correctly integrated the F5 Mobile SDK with your mobile application.

Optional tasks

Use trusted client rule settings to allowlist requests

When you configure Bot Defense on an HTTP load balancer, you can optionally use Trusted Client Rules in Distributed Cloud to selectively allowlist requests that meet the criteria in the rule. These allowlisted requests aren't evaluated by Bot Defense.

For information, see the knowledgebase article, K000146814: How do I skip Bot Defense and/or WAF for a trusted client?.

Disable JavaScript insertion

The following steps explain how to optionally disable JavaScript tag insertion in environments where you have enabled Bot Defense through an HTTP load balancer.

Important: For maximum effectiveness, Bot Defense requires you to enable JavaScript insertion. F5 recommends that you don't disable JavaScript insertion.

To disable JavaScript tag insertion in Bot Defense on an HTTP load balancer:

1. From the Distributed Cloud Console home page, select Web App & API Protection.
2. From the navigation menu, confirm that you selected the correct namespace.
3. Select Manage > Load Balancers > HTTP Load Balancers.
4. From the Actions column, select the Action (…) menu next to the load balancer on which you want to disable JavaScript tag insertion and then select Manage Configuration.
5. Select Edit Configuration and then select Bot Management.
6. From the Web JavaScript Settings drop-down menu, select Disable JavaScript Insertion.
7. To save your changes, select Save HTTP Load Balancer.

---