Connect your AEM Forms environment with Turnstile connect-your-forms-environment-with-turnstile-service

This feature is under the early adopter program. If you’re interested in joining our early access program for this feature, send an email from your official address to aem-forms-ea@adobe.com to request access

CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) is a program commonly used in online transactions to distinguish between humans and automated programs or bots. It poses a challenge and evaluates user response to determine if it’s a human or a bot interacting with the site. It prevents the user to proceed if the test fails and helps make online transactions secure by keeping bots from posting spam or malicious purposes.

AEM Forms 6.5 supports the following CAPTCHA solutions:

Integrate AEM Forms environment with Turnstile Captcha

Cloudflare’s Turnstile Captcha is a security measure that aims to protect forms and sites from automated bots, malicious attacks, spams and unwanted automated traffic. It presents a checkbox on form submission to verify that they are human, before allowing them to submit the form.

Prerequisites to integrate AEM Forms environment with Turnstile Captcha prerequisite

To configure Turnstile for AEM Forms, you need to obtain the Turnstile sitekey and secret key from the Turnstile website.

Configure Turnstile steps-to-configure-hcaptcha

To integrate AEM Forms with the Turnstile service, perform the following steps:

  1. Create a Configuration Container on your AEM Forms environment. A Configuration Container holds Cloud Configurations used to connect AEM Forms to external services. To create a Configuration Container:

    1. Open your AEM Forms environment.

    2. Go to Tools > General > Configuration Browser.

    3. In the Configuration Browser, you select an existing folder or create a new folder:

      • To create a new folder and enable the Cloud Configurations:

        1. In the Configuration Browser, click Create.
        2. In the Create Configuration dialog, specify a name, title, and check Cloud Configurations.
        3. Click Create.
      • To enable Cloud Configuration for an existing folder:

        1. In the Configuration Browser, select the folder and click Properties.
        2. In the Configuration Properties dialog, enable Cloud Configurations.
        3. Click Save & Close to save the configuration.
  2. Configure your Cloud Services:

    1. On your AEM author instance, go to tools-1 > Cloud Services and Click Turnstile.
      Turnstile in Cloud Services

    2. Select a Configuration Container, created or updated, as described in the previous section. Click Create.
      Configuration Turnstile

    3. Specify Widget Type as managed, non-interactive or invisible.

    4. Provide other details such as Title, Name.

    5. Specify Site Key, and Secret Key for Turnstile service obtained in prerequisite.

    6. Click Create.

      Configure the Cloud Service to connect your AEM Forms environment with Turnstile

    note note
    NOTE
    Users need not to modify Client-side JavaScript validation URL and Server-side validation URL as they are already prefilled for Turnstile validation.

    Once the Turnstile Captcha service is configured, it is available for use in your Adaptive Form.

Use Turnstile in an Adaptive Form using-turnstile-aem-6.5

  1. Open your AEM Forms environment.

  2. Go to Forms > Forms and Documents.

  3. Select an Adaptive Form, and Click Properties. In Configuration Container, select your Cloud Configuration for Turnstile®.

  4. Click Save & Close.

    If you do not have such a Configuration Container, see section Connect your AEM Forms environment with Turnstile to learn how to create a Configuration Container.

    Select Configuration Container

  5. Select an Adaptive Form, and Click Edit to open your adaptive form in the editor.

  6. From the component browser, drag-drop or add the Adaptive Form Turnstile component onto the Adaptive Form.

  7. Select the Adaptive Form Turnstile component and Click properties Properties icon icon. It opens the properties dialog. Specify the following properties:

    Cloudfare Turnstile v1

    • Title: Specify the title for your Captcha component. you can identify a form component easily with its unique title both in the form and in the rule editor.

    • Configuration Settings: Select a Cloud Configuration configured for Turnstile.

    • Validation Message: Provide a validation message for validating Captcha on form submission or on a user action.

    • Captcha Service: Select the CAPTCHA Service for your form submission, here you select Turnstile®.

    • Configuration Settings: Select your Cloud Configuration configured for Turnstile®.

      note note
      NOTE
      You can have multiple Cloud Configurations in your environment for a similar purpose. So, choose the service carefully. If no service is listed, see Connect your AEM Forms environment with Turnstile to learn how to create a Cloud Service that connects your AEM Forms environment with Turnstile service.

      * **Error Message:** Provide the error message to display to the user when the Captcha submission fails.

    • Captcha Size: You can select the display size of the hCaptcha® challenge dialog. Use the Compact option to display a small sized and the Normal to display a relatively large-size hCaptcha® challenge dialog.

  8. Select Done.

Now, only legitimate forms, in which the form filler successfully clears the challenge posed by the Turnstile service are allowed for the form submission.

Turnstile Challenge

Frequently Asked Questions

  • Q: Can I use more than one Captcha component in an Adaptive Form?
  • Ans: Using more than one Captcha component in an Adaptive Form is not supported. Also, it is not recommended to use a Captcha component in a fragment or a panel marked for lazy loading.

See also see-also

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2