Device Fingerprint Challenge for Edge Policies

Describes the use and management of the device fingerprint challenge for an edge policy.

The device fingerprint challenge generates hashed signatures of both virtual and real browsers to identify and block malicious bots.

You can perform the following device fingerprint challenge management tasks:

Enabling and Editing the Device Fingerprint Challenge for an Edge Policy

Describes how to enable and edit the device fingerprint challenge for an edge policy.

Using the Console
  1. Open the navigation menu and click Identity & Security. Under Web Application Firewall, click Policies.

    Alternatively, open the Web Application Firewall page and click Policies under Resources.

    The WAF Policies page appears.

  2. Select the Compartment from the list.

    All the WAF policies in that compartment are listed in tabular form.

  3. (Optional) Apply one or more of the following Filters to limit the edge policies displayed:
    • State

    • Name

    • Policy Type: Select Edge Policy.

  4. Click the name of the edge policy for which you want to edit and enable the device fingerprint challenge. 

    The Details page of the edge policy you selected appears.

  5. Click Bot Management under WAF Policy.

    The Bot Management list appears.

  6. Select the Device Fingerprint Challenge tab.
  7. Click Edit Device Fingerprint Challenge.

    The Device Fingerprint Challenge dialog box appears.

  8. Check the Enable Device Fingerprint Challenge box.
  9. Complete the following:
    • Device Fingerprint Challenge Action section: Choose one of the following options:

      • Detect Only: Select this option if you want to be alerted for every matched request.

      • Block: Select this option to block requests by returning a response code, error page, or CAPTCHA.

        Complete the following:

        • Block Action: Select one of the following actions that is taken when a matching request is blocked.

          • Set Response Code:

            Complete the following:

            • Block response code: Select a status code to return in response to blocked requests.

          • Show Error Page:

            Complete the following:

            • Block response code: Select a status code to return in response to blocked requests.

            • Block error page message:: Enter the message that defines the error or error code.

            • Block error page description: Enter more details about the error, including the cause and further instructions.

            • Block Error Page Code: Enter the error code that is displayed with the error.

          • Show CAPTCHA:

            Complete the following:

            • CAPTCHA Title: Enter the text for the CAPTCHA page title.

            • CAPTCHA Header: Enter the text that appears before the CAPTCHA image (for example, "I am not a robot").

            • CAPTCHA Footer Text: Enter the text that will be shown after the CAPTCHA input box and before the submit button.

            • CAPTCHA submit button: Enter the text for the Submit button (for example, "Yes, I am human.").

            • Preview CAPTCHA: Click to view the CAPTCHA as users would see it. Click Edit CAPTCHA to return.

  10. Complete the following:
    1. Complete the following information:

      • Action threshold (number of requests): Specify the number of failed requests before the action occurs. Because of the asynchronous request from the browser during page loading, it is recommended to set a threshold of 10 for web applications with basic Ajax usage, and 100 for apps with heavy Ajax usage.

      • Threshold expiry period (seconds): The number of seconds before the threshold expires.

      • Action expire time (seconds): Enter the number of seconds between challenges to the same IP address. Because of client IP address changes, it is recommended that the expiry time is set to 120 seconds for apps with mobile users and 3,600 seconds for apps with desktop users only.

      • Max address count (IP addresses): The maximum number of IP addresses that are added to the list before the specified action is taken.

      • Max address count expiration (seconds): The number of seconds an IP address is kept in the list before it is removed.

    2. Click Save Changes.

Publish your changes for them to take effect. See Publishing Changes.

Using the CLI

Use the oci waas device-fingerprint-challenge update command and required parameters to enable and edit the device fingerprint challenge for an edge policy:

oci waas device-fingerprint-challenge update --is-enabled true --action DETECT --waas-policy-id waas_policy_id [OPTIONS]

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

Using the API
Use the UpdateDeviceFingerprintChallenge method to enable and edit the device fingerprint challenge.

Getting the Device Fingerprint Challenge's Details for an Edge Policy

Describes how to get the details of the device fingerprint challenge for an edge policy.

Using the Console
  1. Open the navigation menu and click Identity & Security. Under Web Application Firewall, click Policies.

    Alternatively, open the Web Application Firewall page and click Policies under Resources.

    The WAF Policies page appears.

  2. Select the Compartment from the list.

    All the WAF policies in that compartment are listed in tabular form.

  3. (Optional) Apply one or more of the following Filters to limit the edge policies displayed:
    • State

    • Name

    • Policy Type: Select Edge Policy.

  4. Click the name of the edge policy for which you want to edit and enable the device fingerprint challenge. 

    The Details page of the edge policy you selected appears.

  5. Click Bot Management under WAF Policy.

    The Bot Management list appears.

  6. Select the Device Fingerprint Challenge tab.

    The tab indicates whether the device fingerprint challenge is enabled or not.

  7. Click Edit Device Fingerprint Challenge.

    The Edit Device Fingerprint Challenge dialog box appears.

  8. View the settings of the device fingerprint challenge.
Using the CLI

Use the oci waas device-fingerprint-challenge get command and required parameters to get the details of the device fingerprint challenge for an edge policy:

oci waas device-fingerprint-challenge get --waas-policy-id waas_policy_id [OPTIONS]

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

Using the API
Use the GetDeviceFingerprintChallenge method to get the details of the device fingerprint challenge.