ezformtoken und CSRF-Schutz
Teil 8, Referenz 20. Cross-Site Request Forgery (CSRF) bedeutet, dass eine andere Website den Browser eines
angemeldeten Benutzers dazu bringt, einen POST an Ihre Website zu senden. Die mit dem Kernel ausgelieferte Erweiterung
ezformtoken verhindert das mit einem geheimen Token je Sitzung. Meist funktioniert das, ohne dass Ihre Erweiterung
etwas tun muss; diese Seite sagt, wann nicht, und was dann zu tun ist.
Wie es funktioniert
Die Erweiterung registriert drei Listener (in ihrer settings/site.ini.append.php):
| Ereignis | Methode | Tut |
|---|---|---|
response/output | ezxFormToken::output() | fügt jedem <form> einer HTML-Seite ein verstecktes Feld ezxform_token hinzu und dem <head> die Meta-Tags csrf-param und csrf-token (mit der ID ezxform_token_js) |
request/input | ezxFormToken::input() | lehnt einen POST ohne das richtige Token ab |
session/regenerate | ezxFormToken::reset() | ein neues Token mit einer neuen Sitzung |
Geschützt sind nur angemeldete Benutzer mit einer Sitzung (bei anonymen Besuchern gibt es nichts zu stehlen), und geprüft werden nur POST-Requests.
Wo das Token gesucht wird
Bei einem POST nimmt input() das Token in dieser Reihenfolge aus:
- dem POST-Feld (
ezxform_tokenoder dem konfigurierten Feldnamen); - dem HTTP-Header
X-CSRF-Token, für Ajax-Requests, die JSON oder XML senden.
Ein fehlendes oder falsches Token beendet den Request mit einer Ablehnung 403 (mit einem JSON-Body für Ajax- und JSON-Requests).
Was Ihre Erweiterung tut
| Situation | Vorgehen |
|---|---|
Ein <form method="post"> in einem Template | nichts: Der Ausgabefilter fügt das Feld hinzu |
| Ein Formular, das JavaScript aufbaut | ein verstecktes Feld ezxform_token mit dem Wert des Meta-Tags csrf-token hinzufügen |
| Ein Ajax-POST mit Formulardaten | ezxform_token mitsenden; Exp.io.call() und $.ez() von ezjscore erledigen das für Sie |
| Ein Ajax-POST mit einem JSON-Body | den Header X-CSRF-Token mit dem Token senden |
| Eine View, die bei GET Daten ändert | auf POST umstellen: GET wird nie geprüft |
| Eine JSON-Seite, die Ihre View ausliefert | das Token wird nur HTML-Seiten hinzugefügt; lesen Sie es aus der Seite, die den Aufruf macht |
In PHP gibt ezxFormToken::getToken() das Token der aktuellen Sitzung zurück, für Templates, die Sie außerhalb der
normalen Ausgabe rendern (zum Beispiel einen per Ajax geladenen Dialog):
$tpl = eZTemplate::factory();
$tpl->setVariable( 'ezxform_token', ezxFormToken::getToken() );Das Token in JavaScript lesen
var meta = document.querySelector( 'meta[name="csrf-token"]' );
var token = meta ? meta.getAttribute( 'content' ) : '';
fetch( '/myext/save', {
method: 'POST',
headers: { 'Content-Type': 'application/json', 'X-CSRF-Token': token },
body: JSON.stringify( { name: 'Ada' } ),
credentials: 'same-origin'
} );Schalten Sie ihn nie ab
ezxFormToken::setIsEnabled( false ) gibt es für Sonderfälle innerhalb des Kernels. Eine Erweiterung, die den Schutz
abschaltet, damit ihr eigenes Formular funktioniert, öffnet jeden POST der Website für Fälschungen. Reparieren Sie
stattdessen das Formular.
Verwandte Seiten
- Zurück: Referenz der ezjscore-Serverfunktionen
- Weiter: E-Mails mit eZMail versenden
- Sicherheit in Erweiterungen
- Cross-Site Request Forgery bei OWASP
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.