dreistromland/typo3-hcaptcha

TYPO3 Extension to add hCaptcha to EXT:form - The privacy friendly captcha alternative.

2.2.0 2024-05-28 10:01 UTC

Requires

• php: ^7.2 | ^8.0 | ^8.1 | ^8.2 | ^8.3
• ext-json: *
• typo3/cms-core: ^10.4@dev || ^11.5@dev || ^12.4@dev || ^13.0@dev
• typo3/cms-extbase: ^10.4@dev || ^11.5@dev || ^12.4@dev || ^13.0@dev
• typo3/cms-fluid: ^10.4@dev || ^11.5@dev || ^12.4@dev || ^13.0@dev
• typo3/cms-form: ^10.4@dev || ^11.5@dev || ^12.4@dev || ^13.0@dev

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16 | ^3.13
• overtrue/phplint: ^2.0 | ^5.3 | ^9.1
• phpspec/prophecy-phpunit: ^2.0
• phpstan/extension-installer: ^1.0
• phpunit/phpunit: ^9.4 || ^10.5
• roave/security-advisories: dev-latest
• saschaegerer/phpstan-typo3: ^1.8
• typo3/cms-fluid-styled-content: ^10.4@dev || ^11.5@dev || ^12.1@dev || ^13.0@dev
• typo3/coding-standards: ^0.3 | ^0.5
• typo3/testing-framework: ^7.x-dev || ^8
• vimeo/psalm: ^3.0 | ^4.0 | ^5.0
• zbateson/mail-mime-parser: ^2.0

Suggests

• vlucas/phpdotenv: ^2.4

GPL-2.0-or-later

• waldhacker
• dreistrom.land AG

README

Provides hCaptcha integration for TYPO3 EXT:form.

hCaptcha is a free to use alternative to Google reCaptcha with a bigger focus on privacy. It supports initiatives like PrivacyPass.

For more information, see the hCaptcha website.

Additionally, hCaptcha provides earnings for solved captchas - that can be donated to the Wikimedia foundation automatically (which is the case for the default settings of this extension).

Quick Setup

hCaptcha is configured with a default key to make the setup as easy as possible. It is recommended to create a custom account for your site with hCaptcha and add your own keys.

• Install the extension and activate it
• Include the static template in TypoScript
• Add a hCaptcha element to a form

TypoScript Constants

Set the following constants if you are using your own account:

plugin.tx_hcaptcha {
  settings {
    publicKey = <your-public-key>
    privateKey = <your-private-key>
  }
}

Environment variables

As an alternative to the TypoScript configuration, you can also use environment variables:

• HCAPTCHA_PUBLIC_KEY
• HCAPTCHA_PRIVATE_KEY

Content Security Policy

If you are using CSP, make sure to adjust them accordingly:

• script-src should include https://hcaptcha.com, https://*.hcaptcha.com
• frame-src should include https://hcaptcha.com, https://*.hcaptcha.com
• style-src should include https://hcaptcha.com, https://*

Privacy

Make sure to inform your users of your usage of hCaptcha and what that means - especially if you are using the invisible Enterprise version.

For more info see: https://docs.hcaptcha.com/faq

Help & Support

• Issues: https://github.com/dreistromland/typo3-ext-hcaptcha
• Slack: #typo3-cms

Visit our website or read Susi's blog entry about hCaptcha at susi.dev.

Migration from waldhacker/hcaptcha 2.x to dreistromland/typo3-hcaptcha 2.x

dreistrom.land AG has taken over the maintenance of the extension. In this context, the package namespace was changed from waldhacker/hcaptcha to dreistromland/typo3-hcaptcha. To migrate your project to the new namespace, do something like this:

composer rem waldhacker/hcaptcha && composer req dreistromland/typo3-hcaptcha:^2.0