Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Whonix
- Technischer Redakteur:
- 0brand
- Projektname:
- Installation und Einrichtung der neuen, sicherheitsorientierten, gehärteten Debian-Linux-Distribution dokumentieren.
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Hardened Debian ist eine neue, sicherheitsorientierte Linux-Distribution, die von den Whonix-Entwicklern aktiv entwickelt wird. In diesem Projekt wird die Installation und Einrichtung von Hardened Debian in Windows/VirtualBox von Grund auf dokumentiert. Der Schwerpunkt liegt darauf, Linux-Einsteiger mit den Fähigkeiten auszustatten, die sie benötigen, um bei der Verwendung einer Linux-Distribution eigenständig zu arbeiten.
Projektziele
Kerndokumentation erstellen
In der Anfangsphase dieses Projekts liegt der Schwerpunkt auf der Kerndokumentation für Hardened Debian. Dieser Teil umfasst eine umfassende Projektübersicht, Anleitungen zur Installation und Einrichtung von gehärtetem Debian sowie Ratschläge und Tipps nach der Installation.
Lernbereiche für neue Linux-Nutzer erstellen
Das Unterrichten neuer Linux-Nutzer besteht nicht darin, ein paar Manpages zu schreiben und sie als Bildungsbereich zu bezeichnen. Viele Anfänger sind nicht daran gewöhnt, mit Eingabeaufforderungen zu interagieren und ihre eigenen Probleme zu beheben. Diese Seiten konzentrieren sich auf Cli-Fähigkeiten, praktische Problemlösung und Best Practices zur Fehlerbehebung.
Dokumentation zur klaren Trennung von gehärtetem Debian und Whonix (Anonymity OS):
Auf Whonix.org werden sowohl Whonix als auch Hardened Debian angeboten. Jedes Betriebssystem hat jedoch sehr unterschiedliche Anwendungsfälle, was zu ernsthaften Konsequenzen führen kann, wenn ein Nutzer das eine mit dem anderen verwechselt. Whonix ist beispielsweise für seine Anonymität bekannt, aber ein neuer Nutzer, der mit Whonix nicht vertraut ist, könnte das gehärtete Debian einrichten und davon ausgehen, dass er anonym im Web surft. Um diese Art von Fehlern zu vermeiden, wird die Dokumentation zu gehärtetem Debian auf einen separaten Bereich von Whonix.org beschränkt. Dabei wird ein neuer, buchähnlicher Formatierungsstil verwendet, der sich von der Formatierung der Whonix-Betriebssystemdokumentation unterscheidet. Warnungen werden auch in wichtigen Bereichen wie der Downloadseite für die gehärtete Debian-Version platziert, um Nutzer vor diesen Fehlern zu bewahren.
Nutzerfreundliche Dokumentation
Die Installation und Einrichtung einer Linux-Distribution kann selbst für erfahrene Nutzer eine Herausforderung sein. Eine nutzerfreundliche und intuitive Benutzeroberfläche kann die Nutzererfahrung verbessern. Genauso wichtig ist es jedoch, eine klare und verständliche Dokumentation zu erstellen. Da die Nutzerbasis von Hardened Debian von Anfängern bis hin zu fortgeschrittenen Linux-Nutzern reicht, muss darauf geachtet werden, dass die Dokumentation nicht nur auf dem technischen Fachwissen und dem Verständnis des technischen Redakteurs basiert. Stattdessen wird Hardened Debian aus der Perspektive eines Linux-Einsteigers dokumentiert, der möglicherweise Schwierigkeiten hat, Aufgaben auszuführen, die erfahrene Nutzer als einfach und leicht zu erledigen empfinden.
Community-Engagement/-Beiträge fördern
Hardened Debian ist ein anspruchsvolles Projekt, das nur dann vollständig abgeschlossen werden kann, wenn die Community während der gesamten Projektdauer aktiv bleibt. Communitymitglieder bleiben nur dann engagiert, wenn ihr Feedback mit Begeisterung aufgenommen wird und ihre guten Ideen zur Verbesserung der Dokumentation verwendet werden. Während der GSoD werde ich weiterhin aktiv im Whonix-Forum sein und sowohl Feedback als auch Beiträge der Community zur Verbesserung der Dokumentation ermutigen.
Gehärtetes Debian-Betriebssystem umbenennen
Dieses Betriebssystem basiert zwar auf Hardened Debian, aber es muss ein neuer Name gefunden werden, um Markenrechtsverletzungen zu vermeiden. Um dieses Ziel zu erreichen, wird die Whonix-Community aufgefordert, eingängige Namen einzureichen, aus denen die Whonix-Entwickler auswählen können. Obwohl ich mich noch im Brainstorming-Modus befinde, sind meine beiden Top-Apps „Sentient Linux“ und „Sentinel Linux“.
Zeitplan des Projekts
Der Zeitplan für dieses Projekt wird in sieben Mini-Meilensteine unterteilt, mit denen der Fortschritt gemessen und Anpassungen vorgenommen werden können, damit jeder Abschnitt rechtzeitig fertiggestellt wird. Sollten während der Season of Docs Probleme auftreten, werde ich meinen Mentor sofort benachrichtigen, damit ein Maßnahmenplan zur Lösung des Problems aufgestellt werden kann.
2. September ( Start des Season of Docs-Projekts)
Die Startseite bietet einen Überblick über Hardened Debian mit Details zu den wichtigsten Punkten des Betriebssystems.
Die erste Dokumentation besteht aus der Installation von gehärtetem Debian in Windows/VirtualBox. Dadurch wird der anfängliche Umfang des Kapitels eingeschränkt. Community-Mitglieder sollten jedoch ermutigt werden, gehärtetes Debian in Linux-Hosts sowie KVM-Hypervisoren zu testen und ihre Ergebnisse zu dokumentieren.
Tabelle mit unterstützten Hostbetriebssystemen
Tabelle mit Hardwareanforderungen
- Mindestanforderungen
- Empfohlen
- Für optimale Leistung
Der Inhalt besteht aus einer Übersicht über die Entwicklungsziele und Verwendungen von Hardened Debian, gefolgt von einer Tabelle mit den einzelnen Komponenten.
Gehärtete Debian-Ziele
- Sicherheitsorientierte Linux-Distribution
- Kostenlos und Open Source
- Vom Nutzer konfigurierbar
- Standardmäßig gehärtet
Tabelle der Komponenten, aus denen Hardened Debian besteht.
- VirtualBox-Hypervisor
- Windows
- Gehärtetes Debian-basiertes Betriebssystem
- Terminologie (Host, virtuelle Maschine, Gastbetriebssystem usw.)
Gehärtetes Debian ist standardmäßig mit vielen erweiterten Sicherheitsfunktionen konfiguriert. So müssen Nutzer nicht mit oft komplizierten Konfigurationen herumspielen. Alle Sicherheitsverbesserungen werden in einer Tabelle mit einer kurzen Erläuterung der Vorteile aufgeführt.
- Haveged ist standardmäßig installiert, um die Entropie zu verbessern.
- Anstelle von NTP wird Secure Distributed Network Time Synchronization (sdwdate) verwendet.
- Deaktiviert Vorschauen in Dolphin und Nautilus.
- Deaktiviert TCP-Zeitstempel und den Verbindungs-Tracking-Helfer von Netfilter.
- open-link-confirmation.
- Apparmor ist standardmäßig mit Profilen aktiviert.
- Sicherheitsgehärteter Browser (Tor Browser ohne Tor)
Verbesserter Linux-Kernel
Desktopumgebung: KDE (nur in der Befehlszeile verfügbar)
Weitere ...
Meilenstein 15. September (vollständige Systemanforderungen, Funktionen und Vorteile, Designs und Ziele)
Auf der Seite mit häufig gestellten Fragen werden Fragen beantwortet, die von Communitymitgliedern häufig gestellt werden. Inhalte werden nach Bedarf während der Projektdauer hinzugefügt.
Der Download und die Installation von Hardened Debian umfassen die folgenden Schritte:
- Downloadtabelle mit dem gehärteten Debian-Image, der OpenGPG-Signatur, dem SHA512-Hash und dem GPG-Signaturschlüssel des Entwicklers.
- Entwicklersignaturschlüssel und Betriebssystem-Image prüfen (Anleitung)
- Herunterladen und Überprüfen des VirtualBox-Hypervisors (Anleitung)
- Härtetes Debian in VirtualBox importieren (Anleitung)
- Gehärtetes Debian starten
Meilenstein 29. September (Debian-Images vollständig herunterladen und prüfen, Debian installieren)
Nutzer sind möglicherweise nicht mit den Schritten zur Anpassung der Desktopumgebung und zur Zuweisung von Systemressourcen vertraut. Für die folgenden Punkte werden Tipps zur „Schnellkonfiguration“ dokumentiert.
- Tastaturlayout ändern
- Zusätzliche Systemressourcen (RAM) zuweisen
- Bildschirmauflösung ändern
- Desktopverknüpfungen
- Fensterstil-Manager
Fehler und Probleme, die beim Testen des Betriebssystems und der Anleitungen gefunden werden, werden zusammen mit Lösungen und/oder Fehlerkorrekturen klar dokumentiert. Auf dieser Seite werden auch Probleme aufgeführt, die beim Ausführen von Betriebssystemen in Hypervisoren häufig auftreten.
- Probleme aufgrund von wenig RAM
- Fehlerhafte BIOS-Konfiguration (Intel VT-d, AMD-V)
- Verbindungsprobleme
Meilenstein 6. Oktober (Erste Schritte abgeschlossen, gehärtete Debian-Fehler)
Neue Nutzer sind möglicherweise nicht mit Linux-Terminals/-CLIs vertraut. Wenn die benötigten Informationen nicht leicht zu finden oder nicht leicht zugänglich sind, wird eine Supportanfrage gestellt, ohne nach einer Lösung suchen zu müssen. In diesem Abschnitt werden häufig verwendete Befehle und die praktische Befehlssyntax dokumentiert. Jedes man-Objekt enthält eine kurze Beschreibung des Befehls und seine Verwendung sowie praktische Beispiele. Es dauert eine Weile, bis sich Nutzer die Befehle für verschiedene Aufgaben merken. Durch Wiederholungen können sich Nutzer die Befehlssyntax mit der Zeit einprägen.
- Terminal/CLI
- sudo
- Texteditoren
- Verzeichnisstruktur
- Dateisystemnavigation
- Dateiberechtigungen
- Man pages
- Dateien/Verzeichnisse erstellen
- Sonstiges (ls, cat, less)
Meilenstein 22. Oktober (Vollständiger Lernbereich, Manpages)
Kompetente/erfahrene Linux-Nutzer haben gute Problemlösungskompetenzen, die sie im Laufe der Zeit erwerben. Wenn ein Problem auftritt, suchen sie automatisch nach einer Lösung und suchen weiter, bis sie eine Antwort finden oder alle möglichen Ressourcen erschöpft sind. Wenn ein neuer Linux-Nutzer auf ein Problem stößt, wird automatisch ein Supportanfrage erstellt. Es ist wichtig, dass gute Praktiken von Anfang an gestärkt werden.
Problemlösungsvorlage : Nutzer sind eher erfolgreich bei der Fehlerbehebung, wenn sie Schritt-für-Schritt-Anweisungen befolgen. Dabei geht es darum, wie Sie relevante Informationen zusammentragen und wie Sie diese Informationen nutzen, um eine Lösung für ihr Problem zu finden. Das sieht ähnlich aus.
Monitoring-Protokolldateien: Speicherort der Systemprotokolle (wofür sie verwendet werden) und der Befehle, die zum Eingrenzen der Cli-Ausgabe erforderlich sind. (journalctl, dmesg usw.)
systemd: Status, Starten und Beenden von Diensten
Behebung von häufigen Problemen: Verbindungsprobleme, beschädigte Softwarepakete usw.
Richtlinien für das Melden von Programmfehlern und/oder Problemen.
Meilenstein 05. November (Lernbereich abschließen, Problemlösung)
Der Rest des Sommers der Dokumentation wird sich auf die Refaktorisierung der Whonix-Dokumentation für Hardened Debian und die Qualitätskontrolle konzentrieren.
Whonix-Dokumente für die Verwendung mit gehärtetem Debian neu strukturieren
- Software sicher installieren
- Betriebssystemupdates