Enable with Adobe Commerce Cloud (Magento)

The following information explains how to configure Bot Defense Standard with Adobe Commerce Cloud (Magento).

Prerequisites

• You must have an active F5 Distributed Cloud account. If you do not have an account, see Get Started with Distributed Cloud Console.
• You must have Bot Defense Standard enabled in the F5 Distributed Cloud Console. For information, see Enable Distributed Cloud Bot Defense Standard.
• You must have Adobe Commerce Cloud (Magento) configured.
• You must have sufficient privileges in Adobe Commerce Cloud to configure Bot Defense.

Add Adobe Commerce Cloud to Bot Defense

The following task explains how to add Adobe Commerce Cloud as a protected application in Bot Defense.

1. Log on to the Distributed Cloud Console. From the Dashboard page, select Bot Defense.
2. Verify that you are in the correct namespace. For information, see Namespaces.
3. Select Manage > Applications and then select Add Application.
4. Add a Name and Description for the protected application.
5. Select the Application Region where the origin server for the new protected application resides: US, EU or Asia.
6. From the Connector Type drop-down menu, select Adobe Commerce.
7. Select Add Protected Application.

Next steps

Copy information from your protected application in the Distributed Cloud Console that you need to configure the F5_DistributedCloudConnector extension in Adobe Commerce Cloud. For information, see Copy required information from your protected application.

Copy required information from your protected application

The following task explains how to copy information from your new protected application that you need to configure the F5_DistributedCloudConnector extension.

1. In the Distributed Cloud Console, from the Bot Defense page, select Manage > Applications.
2. From the Actions column, select the Action menu (…) next to the protected application you just added for Adobe Commerce Cloud.
3. From the drop-down menu, select the following options and save the copied information in a location you can access later:
   • Copy App ID
   • Copy Tenant ID
   • Copy API Key
   • Copy API Hostname
   • Copy Telemetry Header Prefix

Next steps

Download the F5_DistributedCloudConnector extension from the Magento Marketplace and install it. For information, see: Install the F5_DistributedCloudConnector extension.

Install the F5_DistributedCloudConnector extension

1. To download the F5_DistributedCloudConnector extension from the Magento Marketplace, go to https://marketplace.magento.com/f5-distributed-cloud-connector.html. Or, from the Magento Marketplace, search for "F5 Distributed Cloud Services."
2. Run composer require f5/distributed_cloud_connector:VERSION (for example, f5/distributed_cloud_connector:1.0.2). You can find the extension version in the composer.json file.
3. Run php bin/magento set:up.
4. Run php bin/magento s:d:c.
5. Run php bin/magento setup:static-content:deploy. If Magento is in developer mode, add an -f argument. Developer mode is not officially supported in the extension.

Next steps

Use the information you just copied to configure the F5_DistributedCloudConnector extension. See: Configure the F5_DistributedCloudConnector extension.

Configure the F5_DistributedCloudConnector extension

To configure the F5_DistributedCloudConnector extension, in Adobe Commerce Cloud, go to Admin Panel > Stores > Configuration > F5® DISTRIBUTED CLOUD SERVICES.

To enable the Bot Defense module, configure the following sections:

• General
• JS Insertion
• Login Protection
• Protected Endpoints
• Web Scraping
• Allow List

General

Note: To configure some of the options in this section, you need information that you copied from your protected application. If you have not yet copied that information, see Copy required information from your protected application.

Configure the following options:

• Enable Service: Enable/disable the module.
• Mode: Select one of the following options:
  • Enterprise: The dedicated mode of usage where the “Application ID” and “Tenant ID” fields are not required. If you purchased Bot Defense Advanced, select Enterprise.
  • Standard: The multi-tenant mode of operation. If you purchased the Standard of Bot Defense, select Standard.

Choose the mode based on the F5 Distributed Cloud plan that you have.

• API Hostname: Enter the API Hostname value that you copied from the protected application you added in the Distributed Cloud Console.
• Backend API path: The path to the Bot Defense script on the website backend. F5 recommends that you enter api/v1/decision for this value.
• API Key: The key used for authentication of the API calls to the F5 system. Enter the API Key value that you copied from the protected application you added in the Distributed Cloud Console.
• Telemetry Header Prefix: Enter the Telemetry Header Prefix value that you copied from the protected application you added in the Distributed Cloud Console.
• Application ID: Enter the App ID value that you copied from the protected application you added in the Distributed Cloud Console. Note that this field is only available when you select Standard mode.
• Tenant ID: Enter the Tenant ID value that you copied from the protected application you added in the Distributed Cloud Console. Note that this field is only available when you select Standard mode.
• Timeout API response: The time (in milliseconds) that the module waits for a response from the F5 server. After that, the request is processed by the Adobe Commerce backend. The default is 700.
• Source for Client IP address: Decide how Bot Defense gathers your client IP address:
  • Connecting IP: From your connection information.
  • X-forwarded-For: From the X-forwarded-For header.
  • Custom: From a custom header name that you define.
    • Custom Ip address source: The custom header name for getting your IP address. In the configured header, the first character of each word must be upper case.
• Enable Debug: Enable this to record requests and responses to/from the F5 service in the log file on the website server.

JS insertion

Configure the following options to determine how Bot Defense inserts JavaScript tags in your application.

• JS Path: Enter an absolute path or a relative path to the JavaScript tags:

  • Absolute example: https://<FQDN+JS_location>, such as https://www.foo.com/abc.js.

    If you enter an absolute path, verify that the JavaScript requests are routed to Bot Defense.

  • Relative example: </JS_location>, such as /abc.js.

• Insert JS option: Specify where in the page to add the JavaScript tags:

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

  F5 recommends that you select After <head> so that the Bot Defense JavaScript is executed early. This allows time to fetch and execute the Bot Defense JavaScript while the rest of page is rendered.

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

• JavaScript load mode: Select the load mode of the JavaScript on the page:

  • Async with caching
  • Async with no caching
  • Sync with caching
  • Async with caching and defer XHR

• Insert JS to specific web pages: Displays the Specific pages list, which lists the pages in which Bot Defense should insert JavaScript tags.

  • If you select Yes, the Specific pages list displays.
    • Enter only the path to the page, such as /about-us.
    • Enter each page on a new line.
    • You can use wildcards used for page path definitions, such as *, and so on.
    • To insert JavaScript tags on all pages, enter only an asterisk (*).

  If this field is empty, Bot Defense does not insert JavaScript tags in any pages.

  • If you select No, the Specific page list field is hidden and JavaScript tags are inserted in all available pages that are not defined in the Excluded pages list field.

• Exclude JS from specific web pages: Displays the Excluded pages list, which lists all the pages in which Bot Defense must not insert JavaScript tags.

  • If you select Yes, the Excluded pages list displays.
    • Enter the path to the page, such as /about-us.
    • Enter each page on a new line.
    • You can use wildcards for page path definitions, such as *, and so on.
  • If you select No, the Excluded pages list field is hidden and JavaScript tags are inserted according to the configuration in Insert JS to specific web pages.

Login protection

Configure the following options to protect your login pages.

• Protection type: Select one of the following protection types:
  • Disable: Disables login protection.
  • Collect txn: Customer verification is performed after sending the login request to the origin destination.
  • Ignore txn: Customer verification is performed right after selecting the Login button on the storefront, but before the Login request is performed to the origin destination.
• Login Url: Defines the login action URL that should be protected by Bot Defense. By default, this is set to /customer/account/loginpost*, which is used by the Adobe Commerce Cloud platform. You only need to update this field if you use a non-default login URL on your website.
• Mitigation: Choose one of the following actions when Bot Defense detects automated traffic:
  • Continue: The bot is allowed to visit the destination page but is flagged by the header defined in the Mitigation Continue header field.
  • Block: The bot is blocked from reaching the destination page. It is routed to a blank page with the content defined in the Blocked Response Body field and the response code defined in the Blocked Response Code field.
  • Redirect: The bot is redirected to the path defined in the Mitigation Redirect path field.

Protected endpoints

Configure the following options in the Protected Endpoints section to define pages and sources on the website that you want to protect with Bot Defense.

• URL endpoint: Enter the path to the page or action that should be protected by Bot Defense. Use wildcards to define complex URLs.
• Method: Enter the type of HTTP methods that Bot Defense protects on this endpoint:
  • GET XHR: Use when the protected application makes an XHTTPRequest to get the content of the page.
  • POST: The most commonly attacked method. F5 recommends that you protect all POST requests. Bot Defense analyzes POST requests to determine if they are part of a bot attack such as credential stuffing or form submission abuse.
  • PUT: Use to protect PUT requests and prevent data uploads or modifications from bots.
• Mitigation: Select the mitigation action you want to take for this endpoint if Bot Defense detects automation:
  • Continue: The bot is allowed to visit the destination page but is flagged by the header defined in the Flag Header name field.
  • Block: The bot is blocked from reaching the destination page. It is routed to a blank page with the content defined in the Block Response Body field and the response code defined in the Block Response Code field.
  • Redirect: The bot is redirected to the path defined in Redirect location.

Web scraping

Configure web scraping protection for documents and pages on a web site that is accessible by GET requests without visiting the main page, for example, from a link on social media, from an email or from a saved bookmark. This direct access to resources prevents Bot Defense from inserting the protection JavaScript tags. When you configure an endpoint for web scraping, Bot Defense displays an interstitial page that is transparent to the user but that allows it to collect telemetry data about the requests.

• URL endpoint: Enter the path to the page or action you want to protect. Use wildcards to define complex URLs.
• Mitigation: Select the mitigation action you want to take for this endpoint if Bot Defense detects automation:
  • Continue: The bot is allowed to visit the destination page but is flagged by the header defined in the Flag Header name field.
  • Block: The bot is blocked from reaching the destination page. It is routed to a blank page with the content defined in the Block Response Body field and the response code defined in the Block Response Code field.
  • Redirect: The bot is redirected to the path defined in Redirect location.

Allow list

Configure the Allow List to let requests get to the origin destination without being verified by Bot Defense. Create your Allow List using either IP addresses or request headers.

• Allowed IP Addresses: Requests sent from IP addresses defined in the Allowed IP addresses field are delivered to the endpoint without being verified by Bot Defense. You must enter each IP address on a new line.
• Allow Header: Requests that contain the [header]:[value] pair are delivered to the endpoint without being verified by Bot Defense. You must enter each [header]:[value] pair on a new line. Bot Defense supports wildcards for both header name and header value.

Next steps

Make sure you have configured Bot Defense correctly. For information, see Test your Bot Defense configuration.

---