Secrets - Geheimnisse sicher hinterlegen

Dieses Beispiel zeigt, wie man Geheimnisse in einer Java Applikation sicher hinterlegen kann.

Voraussetzung

  • Du weisst, was mit Geheimnissen gemeint ist.
  • Du weisst was Umgebungsvariablen sind.
  • Du weisst was Maven ist und kannst Maven-Projekte aufsetzen.
  • Du weisst wie man bei Maven ein Paket hinzufügt.
it-ninja tip

Wir stellen dir bei den Übungen jeweils komplette Projekte zur Verfügung. Du musst grundsätzlich nur dort was anpassen, wo die folgende Kommentarzeile steht:

1

// IT-Ninja: Füge hier Deinen Code ein:

Alles andere kannst du für den Moment ignorieren. Wir erklären dir die einzelnen Zeilen Schritt für Schritt in den Modulen.

Vorbereitungsarbeiten

it-ninja info
Neu bei it-ninja?
Die Anleitung enthält einige Befehle und Fachbegriffe, die dir möglicherweise noch nichts sagen. Mach dir deswegen keine Sorgen – in den kommenden Modulen erklären wir dir alles Schritt für Schritt. Schon bald wirst auch du ein it-ninja sein.

Um die folgenden Aufgaben erfolgreich umzusetzen, führe diese Schritte aus:

  1. Beim ersten Mal:

    1. IntelliJ IDEA installieren → !*IntelliJ IDEA einrichten
    2. Git-Repository einrichten → !*Persönliches Git-Repository

  2. Öffne eine !*CMD-Shell und wechsle ins Verzeichnis deines Git-Repositories:

  1. Stelle sicher, dass alle Dateien im Git-Repository committed sind. Mit git status erhältst du eine Übersicht:
1

git status

Falls du bei diesem Befehl einen roten Text siehst, musst du zuerst die aktuellen Dateien sichern:

1
2

git add .
git commit -m "[gescheiter Kommentar]"

  1. Erstelle oder wechsle in den Template Branch:

    Beim ersten Mal musst du einen Template Branch erstellen:

1

git checkout -b "templates"

Falls er bereits existiert, kannst du einfach switchen:

1

git switch "templates"

  1. Lade den Source-Code zu den Übungen herunter und entpacke ihn im Root-Verzeichnis deines lokalen Repositories:
    [[itninja_localrepo|C:\Users\u123456\repos.local\it-ninjas-lab]]

    Den Source-Code findest du hier: Download | Online anschauen

  2. Committe den originalen Source-Code, damit er sicher im Repository gespeichert ist:

1
2
3

git add .
git commit -m "Add it-ninja_99_Tools_java_05_secrets_01_SimpleExample"
git push
  1. Erstelle einen neuen Branch, um deine Lösung zu implementieren:
1

git checkout -b "labs/it-ninja_99_Tools_java_05_secrets_01_SimpleExample"
it-ninja info

Hier kannst du auch einen kürzeren Namen wählen. Verwende labs am Anfang des Branch-Namens für Branches, die deinen eigenen Code enthalten.

Stelle dir einen Branch vorerst als Ordner vor. Jeder Ordner enthält eine Version oder einen Stand von deinem Quellcode. Du kannst dann mit git zwischen diesen Ordern hin und her wechseln, sie vergleichen aber später auch zusammenführen.

it-ninja tip
Pro-Tipp:
Du kannst jederzeit einen weiteren Branch erstellen – z. B. wenn du etwas ausprobieren möchtest. Alternativ kannst du auch in der Git-History einen alten Stand wiederherstellen, was aber weniger flexibel ist.
  1. Starte IntelliJ und öffne mit File → Open das Verzeichnis mit dem Source-Code.
it-ninja warning
Du musst mit IntelliJ den Ordner suchen, welches einen Ordner src oder die Datei pom.xml enthält. Ansonsten wird IntelliJ Mühe haben, dir das Programm zu kompilieren.

Wenn du alles korrekt gemacht hast, findest du das Projekt hier:

  1. Falls du zum ersten Mal mit IntelliJ arbeitest, findest du !*hier eine Anleitung, wie man ein Programm startet.
it-ninja tip
Um das Programm zu starten musst du jeweils die Datei Main.java öffenen. Dann sollte in IntelliJ oben rechts ein grünes Dreieck vorhanden sein, welches das Programm startet.

Nun bist du bereit, die untenstehenden Aufgaben zu lösen.

it-ninja warning

Wenn du alle Änderungen gemacht hast und mit der Übung fertig bist, oder einen ‘Zwischenstand’ festhalten willst, führe die folgenden Befehle aus um das Repository auf dem Server zu speichern (von wo du es geklont hast):

Wenn du deine Änderungen auf dem Git-Server sichern willst, musst du das mit einem push machen.

Beim ersten mal musst du git noch mitteilen, wie der Branch auf dem Git-Server heissen soll:

1

git push --set-upstream origin labs/it-ninja_99_Tools_java_05_secrets_01_SimpleExample

Bei weiteren pushes wird es dann einfacher:

1

git push
it-ninja tip

Die meisten Übungen sind professionell strukturiert – so wie in echten Softwareprojekten. Zu gutem Code gehören auch Tests, die sicherstellen, dass dein Code wie erwartet funktioniert. Sofern nicht anders erwähnt, kannst du mit folgendem Befehl im Root-Verzeichnis des Projekts (dort, wo sich auch die pom.xml befindet) überprüfen, ob du die Aufgabe korrekt gelöst hast:

1

mvn test

Viel Erfolg!

Übung

Das Beispiel zeigt, wie ein Projekt korrekt aufgesetzt wird, damit es sicher in einem Git-Repository gesichert werden kann.

Schaue dir die Datei .env.template an und folge den Anweisungen dort. Ersetze dabei das_geheimnis mit mein_geheimnis.

Passe das Maven-Konfigurationsfile (pom.xml) an:

1
2
3
4
5

<dependency>
  <groupId>io.github.cdimascio</groupId>
  <artifactId>dotenv-java</artifactId>
  <version>3.0.0</version>
</dependency>

Wenn Du alles korrekt erledigt hast, sollte der Unittest erfolgreich durchlaufen:

1

mvn test
it-ninja tip
Wenn du den Unittest anschaust, wirst du feststellen, dass auch dort nirgends das Geheimnis im Klartext steht. Um zu testen, ob du das Geheimnis korrekt konfiguriert hast vergleichen wir es mit einem Hash. Der Hash kann nicht zurück in einen Klartext verwandelt werden, aber mit der Funktion match kann man feststellen, ob ein Wert den gleich Hash erzeugt und so verifizieren, ob der Wert korrekt ist.
Last modified August 14, 2025: Adapt Labs to Java 21; adapt preparation steps (8c9c1820d)