diff --git a/README.md b/README.md index 766500f..a175d3f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# JTL-Shop-ALTCHA-Spamschutz +# JTL-Shop ALTCHA Spamschutz -Selbst gehosteter, quelloffener Spamschutz (ALTCHA Proof-of-Work) fuer Registrierung und Newsletter-Anmeldung in JTL-Shop 5. Dokumentation im Wiki: jtl-shop:altcha-spamschutz \ No newline at end of file +Selbst gehostetes, quelloffenes Spamschutz-Plugin (ALTCHA Proof-of-Work, MIT-Lizenz) fuer JTL-Shop 5 -- schuetzt Registrierung und Newsletter-Anmeldung, ohne Daten an Dritte weiterzugeben (kein Google, kein externer Dienst). + +## Enthaelt + +- `fp_altcha_spamschutz/` -- komplettes, installierbares JTL-Shop-5-Plugin (Plugin-ID `fp_altcha_spamschutz`) + - `Bootstrap.php` -- Hook-Registrierung (EventDispatcher) + - `info.xml` -- Plugin-Manifest / Einstellungen + - `src/Service/AltchaService.php` -- Challenge-Erzeugung & Verifikation (ALTCHA V1) + - `src/Handler/TemplateHandler.php` -- Widget-Einbindung ins Formular-HTML + - `src/Handler/ValidationHandler.php` -- Pruefung bei Registrierung & Newsletter-Anmeldung + - `assets/fp-altcha.js` -- client-seitiger Proof-of-Work-Loeser + +Die per Chat gelieferte, installierbare Plugin-ZIP enthaelt zusaetzlich die unveraendert vendorierte ALTCHA-PHP-Bibliothek ([altcha-org/altcha-lib-php](https://github.com/altcha-org/altcha-lib-php), MIT-Lizenz) unter `src/Vendor/AltchaOrg/Altcha/V1/`. Um Drittanbieter-Code hier nicht zu duplizieren, ist sie in diesem Repo nicht enthalten. + +## Hintergrund + +Redmine-Ticket #1633 (EOS Verlag): LilFOOT SpamProtector konnte das dort beobachtete Muster ("Test"/"Test User" in Vorname/Nachname/Ort/Strasse, aber echte Fremd-E-Mail-Adressen) strukturell nicht erkennen, weil dessen Wortlisten-Pruefung nur auf Kommentar-/Nachrichtenfelder wirkt, die das Registrierungsformular gar nicht besitzt. Dieses Plugin ergaenzt (ersetzt nicht) das laufende Rate-Limit und LilFOOT SpamProtector. + +## Dokumentation + +Ausfuehrliche Installations-, Test- und Hintergrundinfos im Wiki: [jtl-shop:altcha-spamschutz:start](https://guide.falk.plus/doku.php?id=jtl-shop:altcha-spamschutz:start) + +## Feedback + +Fragen, Bugs oder Verbesserungsvorschlaege bitte als [Issue in diesem Repo](https://vw.falk.plus/JensFalk/JTL-Shop-ALTCHA-Spamschutz/issues) melden.