https://github.com/jonathanxdr/m183

https://github.com/jonathanxdr/m183

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jonathanxdr/m183
• Owner: JonathanXDR
• License: mit
• Created: 2024-02-22T14:38:29.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-11T13:29:04.000Z (7 months ago)
• Last Synced: 2024-04-16T08:50:21.932Z (7 months ago)
• Language: PHP
• Size: 5.63 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LB2 Applikation

Diese Applikation ist bewusst unsicher programmiert und dient dazu, uns Lernenden die Augen für potenzielle Sicherheitslücken in Softwareanwendungen zu öffnen. Wir lernen, wie wir diese Lücken erkennen und beheben können. Dieses Projekt ist Teil der LB2 im [Modul 183](https://gitlab.com/ch-tbz-it/Stud/m183/m183).

## Applikation zum Laufen bringen

Um die Applikation zusammen mit Elasticsearch effizient zu nutzen, gehen wir wie folgt vor:

1. **Vorbereitung der Umgebung**:

   - Wir kopieren die Datei [.env.example](./.env.example) und benennen sie in `.env` um.

   - Falls notwendig, passen wir die Einstellungen in der `.env` Datei an unsere Bedürfnisse an.

2. **Dienste starten**:

   - Die Dienste werden mit `docker compose up -d` gestartet.

     - Falls die Applikation aus irgend einem Grund nicht laufen sollte, kann es daran liegen, dass die Images nochmal neu gebaut werden müssen. In diesem fall kann `docker compose up -d --build` ausgeführt werden, um das zu tun.

   - Anschliessend ist die Applikation unter [http://localhost:80](http://localhost:80) erreichbar.

     ![Application](./img/application.png)

   - Die Elastic Services sind unter [http://localhost:5601](http://localhost:5601) zu finden. Für den Login nutzen wir `elastic` als Benutzernamen und Passwort.

     ![Elastic Login](./img/elastic-login.png)

3. **Bei Zugriffsproblemen auf das Dashboard**:

   - Zeigt das Elastic Dashboard länger die Meldung `Kibana server is not ready yet.`, könnte dies auf ein Problem mit dem Passwort des `kibana_system` Benutzers hinweisen.

   - Bei Zugriffsproblemen können wir mit folgendem Befehl ein neues Passwort setzen:

     ```

     docker exec -it m183_lb2-elasticsearch-1 bin/elasticsearch-reset-password -u  -i 

     ```

   - Wichtig ist, dass der entsprechende Container, `m183_lb2-elasticsearch-1`, dabei läuft.

   - Nach dem Zurücksetzen des Passworts müssen wir auch die Passwortvariablen in der `.env` Datei aktualisieren.

4. **Nutzung von Elastic Search**:

   - Nach dem Login erhalten wir Zugriff auf das gesamte Elastic Dashboard und seine Services.

     ![Elastic Overview](./img/elastic-overview.png)

   - Wir beginnen mit dem `Search` Service, um Logs als Dokumente einzusehen.

     ![Elastic Search](./img/elastic-search.png)

   - Unter dem `Analytics` Service im Dashboard-Tab können wir dann eigene Dashboards für unsere Logs erstellen. Wichtig zu wissen ist, dass diese Dashboards nur auf dem persistenten Volume gespeichert werden. Daher muss jeder Benutzer seine Dashboards neu anlegen. Dieses Problem kann leider nicht ohne Weiteres umgangen werden.

     ![Elastic Dashboards](./img/elastic-dashboards.png)

5. **Interaktion erforderlich für Logs**:

   - Wichtig: Logs in Elastic werden erst sichtbar, wenn mit der Applikation interagiert wurde. Das heisst, wir müssen bestimmte Aktionen in der Applikation ausführen, damit Logs generiert und in Elastic sichtbar werden.