HINWEIS: Das Friendly Captcha Plugin ist eine Eigenentwicklung der N12h GmbH. Bitte wenden Sie sich bei Fragen oder Unterstützung an den Herausgeber.
Angaben zum Herausgeber: N12h GmbH Website: https://n12h.digital E-Mail: kontakt@n12h.digital Support: support@n12h.digital Quellcode: GitHub-Repository
Inhaltsverzeichnis
- Was ist Friendly Captcha?
- Voraussetzungen
- Installation
- Globale Konfiguration
- Verwendung im Designer
- Prüfung beim Absenden
- Fehlercodes
Was ist Friendly Captcha?
Das Plugin Friendly Captcha schützt Formulare vor Spam und automatisierten Absendungen durch Programme (sogenannte Bots). Dafür stellt es ein neues Formular-Element für den Designer bereit.
Nutzerinnen und Nutzer müssen keine Bilderrätsel lösen, also keine Ampeln, Zebrastreifen oder verzerrten Buchstaben. Stattdessen löst der Browser im Hintergrund eine kryptografische Rechenaufgabe, während das Formular ausgefüllt wird. Wenn jemand auf Absenden klickt, ist die Prüfung in der Regel bereits abgeschlossen.
Laut Hersteller bietet das Plugin folgende Eigenschaften:
- Es setzt keine Cookies und verfolgt Nutzer nicht seitenübergreifend.
- Es kommt ohne visuelle oder akustische Rätsel aus und eignet sich damit für barrierefreie Angebote.
- Es unterstützt die Friendly-Captcha-Versionen V1 und V2.
- Zwischen einem globalen Endpunkt und einem Endpunkt mit europäischen Rechenzentren (EU) kann gewählt werden.
- Alle Styles und Skripte werden direkt im Element mitgeliefert. Es sind keine zusätzlichen Dateien vom Server nötig.
Voraussetzungen
- formcycle ab Version 8.5.0 (getestet bis Version 8.5.5)
- Ein Friendly-Captcha-Konto mit einem Sitekey (Website-Schlüssel) und einem Secret Key (geheimer API-Schlüssel)
- Der formcycle-Server muss eine Verbindung zum Friendly-Captcha-Dienst aufbauen dürfen. Bei einer Firewall oder einem Proxy-Server muss diese Verbindung freigegeben sein.
Installation
Die Installation des Plugins kann unter Mandant > Plugins oder unter System > Systemplugins erfolgen.
Globale Konfiguration
Damit bei jedem Formular nicht erneut die Schlüssel eintragen müssen, können Standardwerte für das ganze Plugin festgelegt werden. Öffne dazu Verwaltung > Mandant > Plugins > Friendly Captcha > Einstellungen.
Folgende Einstellungen stehen zur Verfügung:
| Eigenschaft | Standardwert | Beschreibung |
|---|---|---|
| de.xima.fc.plugin.captcha.sitekey | (leer) | Ihr Friendly-Captcha-Website-Schlüssel (Sitekey), auch App-ID genannt. Er sieht zum Beispiel so aus: FCMGRJ22A8UCA94E. |
| de.xima.fc.plugin.captcha.secretKey | (leer) | Ihr geheimer API-Schlüssel (Secret Key). Der Server benötigt ihn, um die Lösung zu prüfen. Er wird im Eingabefeld maskiert angezeigt. |
| de.xima.fc.plugin.captcha.endpoint | GLOBAL | Legt fest, welchen Friendly-Captcha-Server das Plugin nutzt. Es kann zwischen GLOBAL und EU (europäische Rechenzentren) gewählt werden. |
| de.xima.fc.plugin.captcha.version | V2 | Version der Friendly-Captcha-Schnittstelle: V2 (empfohlen) oder V1. |
Wichtig beim Endpunkt EU: Wenn der Endpunkt EU verwendet wird, muss der Sitekey im Friendly-Captcha-Dashboard für die EU-Region freigeschaltet sein. Andernfalls meldet der Dienst den Fehler 403 (eu_endpoint_not_enabled). Der Endpunkt in diesem Fall sollte auf GLOBAL umgestellt werden.
Verwendung im Designer
Element einfügen
- Das gewünschte Formular im formcycle-Designer öffnen.
- In der Elementpalette auf der linken Seite unter den Widgets das Element Friendly Captcha suchen.
- Das Element per Drag & Drop an die gewünschte Stelle im Formular ziehen. Die Platzierung erfolgt vor der Schaltfläche zum Absenden.
In der Vorschau zeigt das Element direkt seinen Status an, zum Beispiel den Hinweis DSGVO-Aktiv, die genutzte Version und die Quelle der Schlüssel.
Eigenschaften des Elements
Im rechten Bereich des Designers kann das Element angepasst werden. Die Eigenschaften friendlyCaptchaSitekey, friendlyCaptchaSecretKey, friendlyCaptchaEndpoint und friendlyCaptchaVersion überschreiben für dieses Formular die globale Konfiguration. Wird ein Feld leer gelassen, gilt der globale Standardwert.
| Eigenschaft | Standardwert | Funktion |
|---|---|---|
| friendlyCaptchaSitekey | (leer) | Überschreibt den globalen Sitekey. |
| friendlyCaptchaSecretKey | (leer) | Überschreibt den globalen Secret Key. So kann für einzelne Projekte ein eigenes Friendly-Captcha-Konto nutzen. |
| friendlyCaptchaEndpoint | (leer) | Legt für dieses Formular fest, ob der Endpunkt GLOBAL oder EU genutzt wird. |
| friendlyCaptchaVersion | (leer) | Wählt V2 oder V1. Bleibt das Feld leer, erkennt das Plugin die Version automatisch anhand des Sitekeys. |
| friendlyCaptchaTheme | auto | Farbschema des Elements: auto (folgt der Systemeinstellung der Nutzerin oder des Nutzers), light (hell) oder dark (dunkel). |
| friendlyCaptchaLang | de | Sprache des Elements, zum Beispiel de, en, fr oder it. |
| friendlyCaptchaStartMode | auto | Legt fest, wann die Prüfung startet: auto (sobald jemand mit dem Formular arbeitet), focus (sobald das Element ausgewählt wird) oder none (erst nach einem Klick). |
| friendlyCaptchaCustomError | (leer) | Eigene Fehlermeldung, die bei einer fehlgeschlagenen Prüfung angezeigt wird. |
[INTERN: Screenshot des rechten Eigenschaften-Panels einfügen, falls vorhanden]
Prüfung beim Absenden
Die Prüfung läuft in vier Schritten ab:
- Der Browser der Nutzerin oder des Nutzers löst die krzptografische Aufgabe im Hintergrund und erhält dafür einen Lösungs-Token.
- Das Token wird als Wert im Formular (IXValuableItem) abgelegt.
- Beim Klick auf Absenden schickt der formcycle-Server das Token über eine verschlüsselte Verbindung an Friendly Captcha und lässt es dort prüfen.
- Nur wenn das Token gültig ist, wird das Formular weiterverarbeitet, zum Beispiel per E-Mail, in der Datenbank oder im Workflow.
Für besondere Fälle gilt:
- Entwurf zwischenspeichern: Beim Zwischenspeichern ohne Validierung wird nicht geprüft (isShouldValidate()==false). Das Zwischenspeichern wird also nicht blockiert.
- Bedingte Sichtbarkeit: Ist das Element in einem Teilschritt ausgeblendet (zum Beispiel über hiddenif), behindert es das Absenden nicht.
- Skripte: Neben dem Primärfeld wird auch das Alias-Feld frcCaptchaResponse synchronisiert.
Fehlercodes
Wenn die Prüfung fehlschlägt, schreibt das Plugin einen Fehlercode in die Protokolldateien (Server-Logs) von formcycle. Mit dem Code kann die Ursache schnell eingegrenzt werden.
| Code | Bezeichnung | Ursache und Behebung |
|---|---|---|
| FCAP-001 | Fehlende Konfiguration | Weder global noch am Element ist ein Secret Key hinterlegt. Der API-Schlüssel ist einzutragen. |
| FCAP-002 | Pflichtangabe fehlt | Das Formular wurde abgesendet, bevor das Captcha gelöst war. |
| FCAP-003 | Ungültige Lösung | Der Friendly-Captcha-Server hat das Token als ungültig abgewiesen. |
| FCAP-004 | Token abgelaufen oder bereits verwendet | Das Token ist nicht mehr gültig oder wurde schon einmal benutzt. Die Prüfung ist erneut durchzuführen. |
| FCAP-005 | Netzwerk-Timeout | Die Verbindung zum Friendly-Captcha-Server ist fehlgeschlagen.Die Einstellungen von Firewall und Proxy-Server sind zu prüfen. |
| FCAP-006 | HTTP-Fehler von der Schnittstelle | Der Friendly-Captcha-Dienst meldet einen Fehler. Bei 403 eu_endpoint_not_enabled ist der Endpunkt auf GLOBAL umzustellen. |
| FCAP-007 | Antwort nicht lesbar | Die Antwort des Friendly-Captcha-Dienstes konnte nicht verarbeitet werden (kein gültiges JSON-Format). |
War dieser Artikel hilfreich?
Das ist großartig!
Vielen Dank für das Feedback
Leider konnten wir nicht helfen
Vielen Dank für das Feedback
Feedback gesendet
Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren