Abschnitt 15 · Lektion 4
Secrets und Umgebung
Ein API-Schlüssel steht in der konfig.js, die Datei landet im Repository, und ab da kann jeder,
der es klont, bei diesem Dienst als du auftreten. Ein Secret ist alles, womit sich jemand
anderes als du ausgeben kann. Dazu gehören auch das Datenbankpasswort, der Schlüssel, mit dem du
Sitzungen signierst, und der, mit dem du eingehende Webhooks prüfst. Das sind Anfragen, mit denen
ein fremder Dienst deinem Server etwas meldet. Wer eins davon hat, ist für den Dienst auf der
anderen Seite du.
Wohin sie gehören
In den Code gehören sie nicht, denn Code wird kopiert. In jeden Klon des Repositorys, in jedes
Backup, auf den Rechner jedes Kollegen, in jeden Lauf einer Pipeline und in jedes Protokoll, das die
Datei einmal ausgibt. Ihr Platz ist die Umgebung, gelesen über process.env aus Lektion 4.2.
// Vier Variablen, und nur zwei davon sind wirklich gesetzt.
process.env.DB_PASSWORT = "aus-der-umgebung";
process.env.DEBUG = "false";
process.env.API_SCHLUESSEL = "";
for (const name of ["DB_PASSWORT", "DEBUG", "API_SCHLUESSEL", "SIGNATUR_SECRET"]) {
const wert = process.env[name];
console.log(
`${name.padEnd(20)} typeof ${(typeof wert).padEnd(10)} ` +
`wahr: ${String(Boolean(wert)).padEnd(6)} ${JSON.stringify(wert)}`
);
}
console.log("");
console.log('Der Text "false" ist wahr, und "" ist falsch. Deshalb prüft');
console.log("man auf Anwesenheit und wertet danach aus, nie in einem Schritt."); Bis auf die erste Zeile steckt in jeder eine Stolperstelle. Jeder Wert ist ein Text, auch wenn eine
Zahl oder ein Wahrheitswert gemeint war, und der Text "false" in DEBUG ist wahr. Eine Variable,
die auf den leeren Text gesetzt ist, gibt es zwar. Brauchbar ist sie trotzdem nicht. Eine, die es
gar nicht gibt, liefert undefined statt eines Fehlers.
Die letzten beiden Zeilen fängt eine einzige Prüfung, denn !process.env.NAME ist bei einer
leeren wie bei einer fehlenden Variable wahr.
.env, .gitignore und .env.example
Im Alltag arbeiten drei Dateien zusammen:
.envliegt auf deinem Rechner und enthält die echten Werte. Sie gehört niemandem außer dir und kommt nie in die Versionskontrolle..gitignorehält sie dort heraus. Ein Eintrag.envreicht, und er muss da sein, bevor du das erste Mal committest..env.exampleenthält dieselben Namen ohne Werte und wird eingecheckt. Darin steht, was das Projekt zum Starten braucht, und sonst müsste jeder Neue im Team danach fragen.
Auf dem Server gibt es dann meist gar keine .env mehr. Die Werte kommen aus der Konfiguration des
Anbieters, aus einem Secret Manager oder aus der Pipeline. Ein Secret Manager ist ein Dienst, der
nur Secrets verwahrt. Am Code ändert das nichts, process.env liest an allen drei Orten auf
dieselbe Weise.
Sofort abbrechen statt später raten
Fehlt eine Pflichtvariable, kann das Programm trotzdem starten und Stunden später mit einem
TypeError über eine Eigenschaft von undefined scheitern, an einer Stelle, die mit der Ursache
nichts zu tun hat. Oder es sagt beim Start, was fehlt.
// Zwei der drei Pflichtvariablen, hier im Code gesetzt, damit das Beispiel
// ohne .env läuft. Auf einem echten Rechner kämen sie aus der Umgebung.
process.env.DB_PASSWORT = "aus-der-umgebung";
process.env.API_SCHLUESSEL = "sk_test_0815";
const PFLICHT = ["DB_PASSWORT", "API_SCHLUESSEL", "SIGNATUR_SECRET"];
const fehlend = PFLICHT.filter((name) => !process.env[name]);
if (fehlend.length > 0) {
console.error(`Start abgebrochen. Diese Umgebungsvariablen fehlen: ${fehlend.join(", ")}`);
console.error("Trag sie in deine .env ein, die Namen stehen in .env.example.");
process.exit(1);
}
console.log("Alle Pflichtvariablen sind da, der Server kann starten."); Die Meldung geht auf stderr und nennt alle fehlenden Variablen auf einmal. Du erfährst also nicht
beim ersten Start die eine und beim nächsten die andere. Sie sagt auch, wo die Namen stehen.
node startpruefung.js; echo $? schreibt dahinter den Exit-Code 1, und daran erkennt ein
Startsystem, dass der Start gescheitert ist. Mit SIGNATUR_SECRET=x davor kommt der Satz, dass der
Server starten kann, und eine 0.
Wenn doch eins im Repository landet
// So sähe die Git-Historie dieser einen Datei aus. Drei Fassungen, und
// in der letzten steht das Secret nicht mehr.
const historie = [
{ commit: "a1b2c3d", text: 'const apiSchluessel = "sk_live_4711";' },
{ commit: "e4f5a6b", text: 'const apiSchluessel = "sk_live_4711"; // TODO: raus hier' },
{ commit: "c7d8e9f", text: "const apiSchluessel = process.env.API_SCHLUESSEL;" },
];
const gesucht = "sk_live_4711";
for (const { commit, text } of historie) {
console.log(`${commit} ${text.includes(gesucht) ? "enthält das Secret" : "sauber"}`);
}
const treffer = historie.filter((f) => f.text.includes(gesucht)).map((f) => f.commit);
console.log("");
console.log(`Aktueller Stand: sauber`);
console.log(`Abrufbar in: ${treffer.join(", ")}`);
console.log("Wer das Repository klont, bekommt die ganze Liste mit."); Im Beispiel stehen drei Fassungen derselben Datei. In der aktuellen steht der Schlüssel nicht mehr, in den beiden davor schon, und beide sind weiterhin abrufbar. „Ich habe es im nächsten Commit rausgenommen“ ändert daran nichts. Selbst die Historie umzuschreiben bringt wenig, wenn das Repository schon irgendwo geklont oder gespiegelt wurde.
Öffentliche Repositories werden außerdem nicht nur von Menschen gelesen. Es gibt Werkzeuge, die neue Commits rund um die Uhr nach Mustern durchsuchen, die wie API-Schlüssel aussehen.
Der erste Schritt ist, das Secret zu wechseln, und mit Git hat er nichts zu tun. Ein neuer Schlüssel wird erzeugt, der alte ungültig gemacht und die Anwendung umgestellt. Erst danach lohnt es sich, die Historie zu bereinigen und nachzusehen, ob mit dem alten Schlüssel etwas passiert ist.
Die Aufgabe holt die Secrets einer konfig.js in die Umgebung und lässt das Laden abbrechen, wenn
eins fehlt.
Zum Mitnehmen
Secrets kommen aus der Umgebung, und das Programm bricht beim Start ab, wenn eins fehlt oder leer ist. Ist eins doch öffentlich geworden, wird es zuerst gewechselt, aufgeräumt wird danach.
Jetzt du
Basis Konto, kostenlosZu 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.