HINWEIS: Das Friendly Captcha Plugin ist eine Eigenentwicklung der N12h GmbH. Bitte wenden Sie sich bei Fragen oder Unterstützung an den Herausgeber. Für die Nutzung ist ein kostenpflichtiger Friendly Captcha Account erforderlich.
Angaben zum Herausgeber: N12h GmbH Website: https://n12h.digital E-Mail: kontakt@n12h.digital Support: support@n12h.digital Quellcode: GitHub-Repository
Inhaltsverzeichnis
- Voraussetzungen
- Installation
- Globale Konfiguration
- Verwendung im Designer
- Prüfung beim Absenden
- Fehlercodes
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 mit den Versionen 8.5.4 und 8.5.5)
- Ein kostenpflichtiges 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.
Alle Friendly-Captcha-Optionen (Schlüssel, Endpunkt, Version, Farbschema, Sprache, Startmodus und Fehlermeldung) werden zentral in diesen Plugin-Einstellungen gepflegt. Am Element im Designer sind sie nicht einstellbar.
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. |
| de.xima.fc.plugin.captcha.theme | auto | Farbschema des Elements: auto (folgt der Einstellung des Browsers oder Systems), light (hell) oder dark (dunkel). |
| de.xima.fc.plugin.captcha.lang | auto | Sprache des Elements. Bei auto wird die Sprache des Formulars verwendet. Alternativ kann ein Sprachcode wie de, en oder fr angegeben werden. |
| de.xima.fc.plugin.captcha.startMode | auto | Legt fest, wann die Prüfung startet: auto (sofort), focus (sobald im Formular gearbeitet wird) oder none (erst nach einem Klick). [PRÜFEN: Beschreibung von "auto" beim Hersteller klären. In Version 1.0.0 stand "bei Interaktion".] |
| de.xima.fc.plugin.captcha.errorMessage | (leer) | Eigene Fehlermeldung bei einer fehlgeschlagenen Prüfung. Bei einem leeren Wert wird die Standardmeldung angezeigt. |
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 sind für das Element folgende Einstellungen vorhanden. Eigene Eingabefelder für die Friendly-Captcha-Optionen werden dort nicht angezeigt. Diese werden zentral in den Plugin-Einstellungen gepflegt.
| Bereich | Einstellung | Hinweis |
|---|---|---|
| Grundeigenschaften | Name, Alias, Breite | Wie bei jedem anderen formcycle-Element. |
| Label / Hilfe | Beschriftung, Hilfetext | Die Standardbeschriftung lautet "Spamschutz". |
| Bedingungen | Prüfe serverseitig | Ab Version 1.0.1 standardmäßig aktiv. Die Option sollte immer aktiviert bleiben. Nur so wird das Token beim Absenden vom formcycle-Server bei Friendly Captcha geprüft. |
| Bedingungen | Versteckt wenn | Ausgeblendete Captchas blockieren das Absenden nicht. |
| Platzierung | Wiederholbare Container | Das Captcha sollte außerhalb wiederholbarer Container platziert werden. Liegt es in einem Container, ist nur das erste Exemplar aktiv und wird geprüft. Ohne Wiederholung wird das Formular abgelehnt (siehe FCAP-008). |
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:
- Prüfe serverseitig: Ist die Option am Element aktiv (Standard ab Version 1.0.1), wird das Zwischenspeichern ohne Validierung nicht blockiert (isShouldValidate()==false). Ist die Option bei älteren Formularen deaktiviert, wird das Token trotzdem bei jedem Absenden geprüft.
- 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). |
| FCAP-008 | Kein Captcha geprüft | Alle Captchas liegen in wiederholbaren Containern ohne Wiederholung. Das Captcha ist außerhalb eines wiederholbaren Containers zu platzieren |
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