mitmario.dev

Fehler im Betrieb

PHP Sandbox 4 Min Lesezeit 4 BeispieleLektion 5 von 6

Eine Fehlermeldung mitten in einer Seite verrät jedem Besucher, in welchem Ordner die Anwendung liegt und wie ihre Dateien heißen. Je nach Einstellung stehen sogar Teile eines Datenbankpassworts darin. Die Frage, wer eine Meldung zu sehen bekommt, ist deshalb die erste Sicherheitsentscheidung dieses Kurses. PHP regelt das mit zwei Schaltern.

Zwei Schalter

display_errors bestimmt, ob eine Meldung in die Ausgabe geschrieben wird, also mitten in das, was dein Programm sonst produziert. log_errors bestimmt, ob sie in ein Protokoll (englisch log) geht, in dem du später nachsehen kannst.

Auf deinem eigenen Rechner willst du beides an. Auf einem Server im Netz gehört display_errors aus und log_errors an. So steht es auch in der Vorlage php.ini-production, die PHP mitbringt. Auf der Kommandozeile dieses Kurses ist es genauso eingestellt, und deshalb hast du Meldungen bisher immer im Terminal auf dem Fehlerkanal gefunden und nie in der Ausgabe.

Der Server in dieser Lektion ist dagegen ein Entwicklungsserver und hat die Anzeige an. In seiner Startzeile im Terminal steht -d display_errors=1, und damit landen Meldungen auf der Seite. Im ersten Beispiel siehst du das, im zweiten ist es wieder abgeschaltet.

Wie das aussieht, wenn jemand es vergisst

Die Fehlermeldung steht mitten in der Seite
<?php

declare(strict_types=1);

// So steht ein Server eingestellt, auf dem jemand vergessen hat,
// die Anzeige auszuschalten. Der Server dieses Kurses hat sie
// ohnehin an; die Zeile hier wirkt auch bei php index.php.
ini_set("display_errors", "1");

$warenkorb = ["Kabel" => 2, "Maus" => 1];

echo "<style>body{font-family:sans-serif;max-width:34em;margin:2rem auto}</style>\n";
echo "<h1>Dein Warenkorb</h1>\n";
echo "<p>Kabel: ", $warenkorb["Kabel"], " Stück</p>\n";
echo "<p>Monitor: ", $warenkorb["Monitor"], " Stück</p>\n";
echo "<p>Vielen Dank für deine Bestellung.</p>\n";

Die ersten beiden Beispiele laufen als Server, als einzige in diesem Abschnitt. Dass eine Fehlermeldung auf einer öffentlichen Seite nichts zu suchen hat, glaubt man nämlich erst so richtig, wenn man die Seite sieht.

In diesem Beispiel ist display_errors ausdrücklich eingeschaltet. So sieht ein Server aus, der ohne php.ini läuft oder mit der Vorlage php.ini-development, denn beide zeigen Meldungen an. Der Fehler selbst ist harmlos, ein Schlüssel, den es nicht gibt. Nur steht die Meldung jetzt im Absatz. Zwischen Monitor: und Stück klebt ein Satz mit dem vollen Pfad der Datei und einer Zeilennummer, fett und mit Warning davor.

Im Reiter Browser siehst du die Seite so, wie ein Besucher sie sähe. php index.php aus der Befehlsleiste zeigt im Terminal dieselbe Ausgabe als reinen Text, mit der Meldung mitten darin, nur ohne die <b>-Tags, die der Server drumherum legt. Auf dem Fehlerkanal steht sie außerdem, also zweimal.

Dieselbe Seite, ruhig
<?php

declare(strict_types=1);

// So gehoert es auf einen Server im Netz: Anzeige aus, das
// Protokoll bleibt an. Dieselbe Seite, derselbe Fehler.
ini_set("display_errors", "0");

$warenkorb = ["Kabel" => 2, "Maus" => 1];

echo "<style>body{font-family:sans-serif;max-width:34em;margin:2rem auto}</style>\n";
echo "<h1>Dein Warenkorb</h1>\n";
echo "<p>Kabel: ", $warenkorb["Kabel"], " Stück</p>\n";
echo "<p>Monitor: ", $warenkorb["Monitor"], " Stück</p>\n";
echo "<p>Vielen Dank für deine Bestellung.</p>\n";

Dasselbe Programm, nur steht der Schalter jetzt auf 0. Der Fehler ist immer noch da, aber die Seite ist sauber. Im Absatz fehlt nur eine Zahl, und das lässt sich in Ruhe beheben. Weg ist die Meldung damit nicht, sie geht ins Protokoll. Im Terminal ist die Ausgabe von php index.php sauber, und auf dem Fehlerkanal steht die Warnung trotzdem.

Was eine Meldung verrät

In einer Fehlermeldung steckt erstaunlich viel über dein System. Außer Ordnern und Dateinamen verrät sie, welche Funktion welche andere aufruft, und bei einem Datenbankfehler nennt sie Tabellen- und Spaltennamen.

Ohne php.ini und mit der Vorlage für die Entwicklung schreibt PHP im Stacktrace zu jedem Aufruf sogar die Argumente dazu, Texte bis zu 15 Zeichen lang (zend.exception_string_param_max_len). Aus verbinde("db.example", "shop", "db-passwort-im-klartext") wird dann verbinde('db.example', 'shop', 'db-passwort-im-...'). Ein Passwort mit höchstens 15 Zeichen stünde also ganz da. Die php.ini-production lässt die Argumente weg (zend.exception_ignore_args = On), und seit PHP 8.2 kann eine Funktion einen Parameter mit #[\SensitiveParameter] aus jedem Stacktrace heraushalten.

Für dich ist das die Information, die du zum Reparieren brauchst. Für jemanden, der eine Lücke sucht, ist es der Bauplan. Wie sich damit arbeiten lässt, steht in Abschnitt 15.

Ein kurzer Satz und das Protokoll

error_log schreibt für dich, nicht für den Besucher
<?php

declare(strict_types=1);

function zahleAus(int $cent): void
{
    if ($cent <= 0) {
        error_log("zahleAus: unzulässiger Betrag " . $cent);
        echo "Die Auszahlung hat nicht geklappt.\n";
        return;
    }

    echo "Ausgezahlt: ", number_format($cent / 100, 2, ",", "."), " Euro\n";
}

zahleAus(2500);
zahleAus(-40);
echo "Fertig.\n";

Ab hier bekommt im ganzen Kurs der Besucher einen kurzen Satz und das Protokoll die Einzelheiten. error_log() ist die einfachste Form davon. Der Text geht nie in die Ausgabe, sondern dorthin, wohin die Einstellung error_log in der php.ini zeigt. Ist sie leer, schreibt PHP ins Protokoll des Webservers. Auf der Kommandozeile dieses Kurses landet der Text auf dem Fehlerkanal im Terminal, und dort lassen sich die beiden Kanäle auch trennen. php index.php 2>/dev/null zeigt nur, was der Besucher bekommt, php index.php 2>&1 >/dev/null nur das Protokoll.

Der Besucher liest Die Auszahlung hat nicht geklappt., und du liest zahleAus: unzulässiger Betrag -40.

Ein Protokolleintrag braucht mehr, als die Ausnahme selbst hergibt. Division by zero allein hilft beim Suchen nicht weiter. Interessant ist, wo es passiert ist und mit welchem Wert, und der Name der Funktion und dieser Wert sind das Mindeste.

Ein Netz für ungefangene Ausnahmen

Ein Netz unter allem, was du vergessen hast
<?php

declare(strict_types=1);

set_exception_handler(function (Throwable $fehler): void {
    error_log("Unbehandelt: " . get_class($fehler) . ": " . $fehler->getMessage());
    echo "Es ist ein Fehler aufgetreten. Bitte später erneut versuchen.\n";
});

echo "Der Auftrag wird bearbeitet.\n";

throw new RuntimeException("Verbindung zur Datenbank verloren");

echo "Diese Zeile wird nie ausgegeben.\n";

set_exception_handler() meldet einen Handler an (englisch exception handler). Das ist eine Funktion, die PHP aufruft, wenn eine Ausnahme nirgends gefangen wurde. Er ist das Netz unter allem, was du vergessen hast. Statt Abbruch mit Exit-Code 255 und einem Stacktrace kommt deine eigene Meldung, und der Exit-Code ist 0, wie php index.php; echo $? zeigt.

Weiter läuft das Programm danach trotzdem nicht, denn die Zeile hinter dem throw wird nie ausgeführt. Der Handler ist das Letzte, was passiert, und er ersetzt keine richtige Fehlerbehandlung. Er fängt nur, was du übersehen hast. In Abschnitt 16 bekommt die eigene Anwendung so ein Netz.

In der Aufgabe bekommt der Nutzer genau einen kurzen Satz, und die Einzelheiten landen in einer Datei.

Zum Mitnehmen

display_errors entscheidet, ob eine Meldung in der Ausgabe landet, log_errors, ob sie ins Protokoll geht. Auf einem Server im Netz gehört die Anzeige aus, die Einzelheiten schreibt error_log() ins Protokoll, und für alles Übersehene gibt es set_exception_handler().

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 4 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.