Problem: ein Geheimnis in einer Datei neben der Anwendung
Eine Datei mit Umgebungsvariablen wirkt harmlos, sammelt in der Praxis aber das Passwort der Datenbank, den Schlüssel der Anwendung und den Zugang zum Dateispeicher. Sie wird von jeder Kopie des Verzeichnisses mitgenommen, und beim Wechsel des Servers wird sie per E-Mail oder Messenger übertragen. Ein einziger Fehler genügt, und das Passwort steht für immer im Repository, denn der Git-Verlauf vergisst nichts.
Deshalb geht unsere Praxis davon aus, dass auch die Beispieldatei nur Namen von Variablen enthält, ohne jeden Wert, und in der Pipeline eine Sperre diesen Zustand automatisch überwacht. Die Beispieldatei dient als Vorlage und muss daher ebenso sicher sein wie der Rest des Repositorys.
Grundsatz: Repository ohne Dateien mit Variablen
Die Regel ist einfach: Das Code-Repository enthält keine Dateien mit Umgebungsvariablen. Die Werte werden in CI/CD, in der Umgebung des Containers auf den Servern und in den Standardwerten des lokalen Stapels für Entwickler gehalten. So existiert auf dem Server des Werks keine Datei, die jemand versehentlich kopieren oder in einer Meldung zitieren könnte.
Für den Administrator folgt daraus eine Sache: Die Konfiguration wird dort gesetzt, wo der Container gestartet wird, und nicht im Verzeichnis mit dem Code.
Namensvertrag statt Datei mit Werten
Die Liste der benötigten Umgebungsvariablen liegt im Repository als Vertrag, der nur die Namen ohne Werte enthält. Ein automatischer Test in jeder Pipeline prüft, dass kein benannter Eintrag fehlt und dass in der Datei kein Gleichheitszeichen steht. Der Mechanismus ist einfach: Wer eine neue Variable hinzufügt, muss ihren Namen in den Vertrag eintragen, und wer versucht, einen Wert einzutragen, stoppt die Pipeline.
Der Administrator des Werks erhält dadurch eine vollständige Liste dessen, was zu setzen ist, und kann sie mit dem vergleichen, was in der Umgebung tatsächlich läuft.
Betriebsmodus immer ausdrücklich festgelegt
Auf den Servern liefert die Umgebung des Containers die gesamte Konfiguration. Die Variable, die den Betriebsmodus der Anwendung bestimmt, ist immer gesetzt, und fehlt sie, bricht der Start ab, statt stillschweigend den Entwicklungsmodus mit Debugger zu aktivieren. Das schützt vor einem klassischen Fehler: eine Produktion, die im Entwicklungsmodus läuft und Fehlermeldungen für jeden sichtbar macht.
Halten Sie in der Beschreibung der Installation fest, welche Variablen den Modus festlegen und wer sie ändert.
Verständliche Meldung bei einer fehlenden Variablen
Eine fehlende Konfigurationsvariable endet mit einer Meldung, die den Namen der fehlenden Einstellung nennt, und nicht mit einer Meldung über eine fehlende Datei. Das ist für die Diagnose praktisch: Nennt die Meldung die fehlende Einstellung, verliert der Administrator keine Zeit mit der Suche nach der Ursache im Netzwerk oder in anderen Komponenten.
Geheimnisscan in der Pipeline
Ein Geheimnisscan in der Pipeline blockiert, dass ein Passwort oder ein Schlüssel in das Repository gelangt. Er ist die zweite Sicherung neben dem Verzicht auf Dateien: Selbst wenn jemand ein Passwort in den Code oder in die Dokumentation schreibt, hält die Pipeline es an. Für das Werk ergibt sich ein doppelter Nutzen: ein geringeres Risiko von Datenlecks und ein Nachweis für die Lieferantenprüfung, dass der Hersteller einen solchen Mechanismus einsetzt.
Wenn Sie das eigene Integrationsrepository prüfen möchten, lesen Sie den Leitfaden zum Geheimnisscan beim Softwarelieferanten.
Checkliste
Videomaterial
Häufig gestellte Fragen
Wo liegen die Passwörter dann?
In CI/CD, in der Umgebung des Containers auf den Servern und in den Standardwerten des lokalen Stapels für Entwickler. Das Repository enthält sie nicht.
Was passiert, wenn eine Variable fehlt?
Die Anwendung bricht den Start ab und nennt den Namen der fehlenden Einstellung, statt im Entwicklungsmodus zu starten.
Ist eine Datei mit den Namen der Variablen ein Datenleck?
Nein. Der Vertrag enthält nur Namen ohne Werte, und ein Test sorgt dafür, dass kein Gleichheitszeichen hineingelangt.
Ersetzt der Geheimnisscan die Prüfung des Codes?
Nein, er blockiert aber automatisch eine Fehlerklasse, bevor ein Geheimnis in das Repository gelangt.
Quellen
Fragen Sie nach unserem Konfigurationsvertrag
Wir zeigen dem Administrator des Werks, wie der Vertrag der Variablen aufgebaut ist und welcher Test seine Vollständigkeit überwacht.
Sprechen wir