mitmario.dev

Eingaben prüfen

Node.js Sandbox 4 Min Lesezeit 3 BeispieleLektion 5 von 8

Solange nur du selbst die Anlegeroute aufrufst, darf sie alles nehmen, was ankommt. Sobald andere die API benutzen, kommt Unsinn an, und zwar meistens ohne böse Absicht. Ein Formular hat einen Tippfehler im Feldnamen, ein Skript schickt eine Zahl als Text.

Alles, was von außen kommt, ist erst einmal falsch, bis eine Prüfung es durchgelassen hat. Auf diesem Satz baut der Rest des Kurses auf, von den Formularen in Abschnitt 13 bis zur Sicherheit in Abschnitt 15.

Was ohne Prüfung im Bestand landet

Was ohne Prüfung im Bestand landet
import express from "express";

const app = express();
app.use(express.json());

app.get("/", (req, res) =>
  res.type("text/plain").send(
    `curl -si -X POST -H "Content-Type: application/json" -d '{"text":"","prioritaet":"hoch"}' http://localhost:3000/notizen\n`
  )
);

const notizen = [];

// Keine Pruefung. Was ankommt, wird gespeichert.
app.post("/notizen", (req, res) => {
  const notiz = { id: notizen.length + 1, text: req.body.text, prioritaet: req.body.prioritaet };
  notizen.push(notiz);
  res.status(201).location(`/notizen/${notiz.id}`).json(notiz);
});

app.listen(3000);

Auf der Seite im Reiter Browser steht ein Befehl, der absichtlich Unsinn schickt. Einen leeren Text und eine Priorität, die ein Wort ist. Der Server nimmt beides an und gibt es zurück, als wäre nichts.

Die Antwort trägt trotzdem den Status 201. Der Server meldet also, dass alles in Ordnung ist. Den Schaden merkt man erst später und an einer ganz anderen Stelle, etwa wenn jemand nach Priorität sortiert oder den Text in eine Seite schreibt.

Vier Fragen an jede Eingabe

Im Beispiel wird eine Notiz mit Text und Priorität geprüft. Für ein Buch mit Titel und Jahr sind es dieselben vier Fragen.

Vier Fragen an jede Eingabe
const MAX_TEXT = 500;

function pruefe(notiz) {
  const fehler = [];

  // Ist es da, und hat es den richtigen Typ?
  if (typeof notiz.text !== "string") {
    fehler.push({ feld: "text", meldung: "fehlt oder ist kein Text" });
  } else if (notiz.text.trim() === "") {
    fehler.push({ feld: "text", meldung: "darf nicht leer sein" });
  } else if (notiz.text.length > MAX_TEXT) {
    // Ist es nicht zu lang?
    fehler.push({ feld: "text", meldung: `höchstens ${MAX_TEXT} Zeichen` });
  }

  if (!Number.isInteger(notiz.prioritaet)) {
    fehler.push({ feld: "prioritaet", meldung: "fehlt oder ist keine ganze Zahl" });
  } else if (notiz.prioritaet < 1 || notiz.prioritaet > 3) {
    // Ist es plausibel?
    fehler.push({ feld: "prioritaet", meldung: "liegt nicht zwischen 1 und 3" });
  }

  return fehler;
}

const proben = [
  { text: "Milch kaufen", prioritaet: 2 },
  {},
  { text: "Steuer abgeben", prioritaet: "hoch" },
  { text: "   ", prioritaet: 7 },
  { text: "x".repeat(5000), prioritaet: 1 },
];

for (const probe of proben) {
  const gezeigt =
    typeof probe.text === "string" && probe.text.length > 40
      ? `{ text: ${probe.text.length} Zeichen, prioritaet: ${probe.prioritaet} }`
      : JSON.stringify(probe);
  console.log(gezeigt);
  console.log(`  ${JSON.stringify(pruefe(probe))}`);
}
  • Ist es da? Ein fehlendes Feld ist in JavaScript undefined, und damit rechnet es sich erstaunlich weit, bevor es knallt.
  • Stimmt der Typ? "hoch" ist ein gültiger JSON-Wert und keine Priorität, "zweitausend" kein Jahr. Number.isInteger fängt Text, null, Kommazahlen und NaN in einem einzigen Aufruf ab.
  • Ist der Wert plausibel? Eine Priorität 7 ist eine Zahl und trotzdem Unsinn, wenn es nur drei Stufen gibt. Ein Jahr 900 ist es für ein Buch. Diese Prüfung kommt aus dem Fachgebiet und nicht aus der Technik, denn kein Paket weiß, wie viele Stufen eine Priorität hat.
  • Ist er nicht zu lang? Das klingt nach Kosmetik und ist Sicherheit. Ein Titel mit zwei Megabyte ist ein Versuch, den Speicher oder die Datenbank vollzuschreiben. Deshalb bekommt das Feld eine Obergrenze, im Beispiel 500 Zeichen.

Alle Verstöße auf einmal, nicht einer nach dem anderen

Beim leeren Objekt {} kommen im Beispiel beide Meldungen zurück und nicht nur die erste.

Erfährst du bei jedem Absenden genau einen Fehler, korrigierst du ihn, schickst erneut und erfährst den nächsten. Bei vier Feldern sind das vier Runden. Eine Prüfung, die sammelt statt abzubrechen, kostet eine Zeile mehr und dem Aufrufer drei Runden weniger.

Dazu gehört, dass jede Meldung sagt, welches Feld betroffen ist und was daran falsch ist. Ein blankes „ungültige Eingabe“ zwingt zum Raten.

Wo die Prüfung hingehört

Die Prüfung an der Tür
import express from "express";

const app = express();
app.use(express.json());

app.get("/", (req, res) =>
  res.type("text/plain").send(
    `curl -si -X POST -H "Content-Type: application/json" -d '{"text":"","prioritaet":"hoch"}' http://localhost:3000/notizen\n` +
      `curl -si -X POST -H "Content-Type: application/json" -d '{"text":"Milch kaufen","prioritaet":2}' http://localhost:3000/notizen\n`
  )
);

const notizen = [];
let naechsteId = 1;

function pruefe(rumpf) {
  const fehler = [];

  if (typeof rumpf.text !== "string" || rumpf.text.trim() === "") {
    fehler.push({ feld: "text", meldung: "fehlt oder ist leer" });
  }

  if (!Number.isInteger(rumpf.prioritaet)) {
    fehler.push({ feld: "prioritaet", meldung: "fehlt oder ist keine ganze Zahl" });
  }

  return fehler;
}

app.post("/notizen", (req, res) => {
  // Ganz oben in der Route, vor allem anderen. Nichts Ungeprueftes
  // geht weiter.
  const fehler = pruefe(req.body);

  if (fehler.length > 0) {
    return res.status(400).json({ fehler });
  }

  const notiz = { id: naechsteId++, text: req.body.text, prioritaet: req.body.prioritaet };
  notizen.push(notiz);
  res.status(201).location(`/notizen/${notiz.id}`).json(notiz);
});

app.listen(3000);

Auf der Seite stehen zwei Befehle, einer mit Unsinn und einer mit gültigen Angaben.

Die Prüfung steht ganz vorn, da, wo die Daten hereinkommen. Also oben in der Route oder in einer eigenen Middleware davor. Verstreut bringt sie nichts. Angenommen, eine Route prüft, ob ein Feld da ist, und irgendwo tiefer sieht noch einmal jemand nach. Dann weiß am Ende niemand mehr, worauf er sich verlassen darf. Steht sie vorn, arbeitet alles hinter dieser Zeile mit gültigen Daten, und der Code dahinter wird kürzer statt länger.

Der dritte Befehl der Befehlsleiste schickt gültige Angaben, aber ohne die Kopfzeile Content-Type: application/json. Dann liest express.json() den Rumpf nicht, und req.body ist undefined. pruefe scheitert schon an rumpf.text. Express antwortet mit 500 und schickt eine HTML-Seite mit dem Stacktrace, ganz oben TypeError: Cannot read properties of undefined (reading 'text'). Im Terminal steht dort &#39; statt der Apostrophe. Übersetzt heißt die Meldung, dass die Eigenschaft text von etwas gelesen werden sollte, das undefined ist. Mit pruefe(req.body ?? {}) wird daraus ein 400 mit beiden Feldern.

Für gültiges JSON mit unsinnigem Inhalt kennt HTTP auch den Statuscode 422 Unprocessable Content, und manche APIs nehmen ihn. Erlaubt ist beides (RFC 9110). Ich nehme in diesem Kurs 400 für alles, was der Aufrufer falsch geschickt hat.

Bei Anmeldedaten wird man absichtlich wortkarg. „Passwort zu kurz“ ist hilfreich. „Diese Adresse kennen wir nicht“ verrät dagegen einem Fremden, wer bei dir ein Konto hat. Mehr dazu in Lektion 14.3.

Ein Schema statt Handarbeit

In einem größeren Projekt nimmt man für die Prüfung ein Paket, etwa Zod. Die erwartete Form steht dort einmal als Schema, und das Paket prüft, meldet und liefert nebenbei die Typen dazu.

Hier läuft die Prüfung von Hand, damit du siehst, was so ein Schema eigentlich tut. Wer sie einmal selbst geschrieben hat, erkennt in einem Zod-Schema dieselben vier Fragen in kürzerer Schreibweise.

Die Anlegeroute des Bücherservers bekommt in der Aufgabe ihre Prüfung, vier Regeln für Titel und Jahr.

Zum Mitnehmen

Jeder Wert von außen wird geprüft, bevor er gespeichert wird, und zwar darauf, ob er da ist, ob Typ und Wert stimmen und ob er nicht zu lang ist. Die Prüfung steht vorn in der Route, sammelt alle Verstöße und antwortet mit 400, je Feld mit dem, was daran falsch ist.

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 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.