Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- Whonix
- Technical Writer:
- 0brand
- Nome del progetto:
- Documentazione sull'installazione e la configurazione della nuova distribuzione Linux Debian protetta incentrata sulla sicurezza.
- Durata del progetto:
- Durata standard (3 mesi)
Descrizione del progetto
Hardened Debian è una nuova distribuzione Linux incentrata sulla sicurezza in fase di sviluppo attivo da parte degli sviluppatori di Whonix. Questo progetto documenta l'installazione e la configurazione di Hardened Debian in Windows/VirtualBox da zero, con l'obiettivo di fornire agli utenti Linux alle prime armi le competenze necessarie per essere autonomi quando utilizzano una distribuzione Linux.
Obiettivi del progetto
Creare la documentazione di base
La fase iniziale di questo progetto si concentrerà sulla documentazione di base per Hardened Debian. Sarà composta da una panoramica completa del progetto, tutorial per installare e configurare Hardened Debian e consigli e suggerimenti post-installazione.
Creare aree di apprendimento per i nuovi utenti Linux
Insegnare ai nuovi utenti Linux non significa scrivere alcune pagine di manuale e chiamarla area didattica. Molti principianti non sono abituati a interagire con i prompt dei comandi e a risolvere i propri problemi. Queste pagine si concentreranno sulle competenze CLI, sulla risoluzione pratica dei problemi e sulle best practice per la risoluzione dei problemi.
Separare chiaramente la documentazione di Hardened Debian da quella di Whonix (sistema operativo per l'anonimato):
Sebbene Whonix.org ospiterà sia Whonix sia Hardened Debian, ogni sistema operativo ha casi d'uso molto diversi che potrebbero portare a gravi conseguenze se un utente li confonde. Ad esempio, Whonix è noto per l'anonimato, ma un nuovo utente che non conosce Whonix potrebbe configurare Hardened Debian e presumere di navigare sul web in modo anonimo. Per evitare questo tipo di errori, la documentazione di Hardened Debian sarà limitata a un'area separata di Whonix.org utilizzando un nuovo stile di formattazione simile a un libro, distinto dallo stile di formattazione della documentazione del sistema operativo Whonix. Verranno inclusi anche avvisi in aree chiave come la pagina di download di Hardened Debian per impedire agli utenti di commettere questi errori.
Documentazione di facile utilizzo
L'installazione e la configurazione di una distribuzione Linux possono essere difficili anche per gli utenti esperti. Sebbene un'interfaccia utente intuitiva e facile da usare possa migliorare l'esperienza utente, è altrettanto importante scrivere una documentazione chiara e facile da seguire, ovvero di facile utilizzo. Poiché la base di utenti di Hardened Debian spazia dai principianti agli utenti Linux esperti, è necessario assicurarsi che la documentazione non sia scritta esclusivamente in base alle competenze tecniche e alla comprensione del Technical Writer. Hardened Debian verrà invece documentato dal punto di vista di un principiante Linux che potrebbe avere difficoltà a eseguire attività che gli utenti esperti trovano semplici e facili da completare.
Incoraggiare il coinvolgimento/i contributi della community
Hardened Debian è un progetto impegnativo che può essere completato nella sua interezza solo se la community rimane coinvolta per tutta la durata del progetto. I membri della community rimarranno coinvolti solo se i loro feedback verranno accolti con entusiasmo e le loro buone idee verranno utilizzate per migliorare la documentazione. Durante GSoD rimarrò attivo sul forum di Whonix, incoraggiando sia i feedback della community sia i contributi per migliorare la documentazione.
Rinominare il sistema operativo Hardened Debian
Sebbene questo sistema operativo sia basato su Hardened Debian, è necessario trovare un nuovo nome per evitare violazioni di marchi. Per raggiungere questo obiettivo, la community di Whonix sarà invitata a inviare nomi accattivanti tra cui gli sviluppatori di Whonix potranno scegliere. Sebbene sia ancora in fase di brainstorming, le mie due scelte principali sono "Sentient Linux" e "Sentinel Linux".
Cronologia del progetto
La cronologia di questo progetto sarà suddivisa in 7 mini-traguardi che possono essere utilizzati per valutare i progressi e consentire di apportare modifiche per garantire che ogni sezione venga completata in tempo. Se dovessero sorgere difficoltà in qualsiasi momento durante Season of Docs, avviserò immediatamente il mio mentor in modo che possa essere formulato un piano d'azione per risolvere il problema.
2 settembre ( inizio del progetto Season of Docs)
La home page fornirà una panoramica di Hardened Debian, con i punti chiave del sistema operativo.
La documentazione iniziale consisterà nell'installazione di Hardened Debian in Windows/VirtualBox. Ciò limiterà l'ambito iniziale di questo capitolo. Tuttavia, i membri della community saranno invitati a testare Hardened Debian negli host Linux e nell'hypervisor KVM e a documentare i risultati.
Tabella con i dettagli del sistema operativo host supportato
Tabella con i dettagli dei requisiti hardware.
- Requisiti minimi
- Consigliato
- Per prestazioni ottimali
I contenuti saranno costituiti da una panoramica che illustra gli obiettivi di sviluppo e gli utilizzi di Hardened Debian, seguita da una tabella che descrive i singoli componenti.
Obiettivi di Hardened Debian.
- Distribuzione Linux incentrata sulla sicurezza
- Senza costi e open source
- Configurabile dall'utente
- Protetto per impostazione predefinita
Tabella dei componenti che costituiscono Hardened Debian.
- Hypervisor VirtualBox
- Windows
- Sistema operativo basato su Hardened Debian
- Terminologia (host, macchina virtuale, sistema operativo guest e così via)
Hardened Debian è configurato con molte funzionalità di sicurezza avanzate per impostazione predefinita. In questo modo, gli utenti non devono destreggiarsi con configurazioni spesso complicate. Tutti i miglioramenti della sicurezza saranno descritti in una tabella con una breve spiegazione dei vantaggi.
- Haveged installato per impostazione predefinita per una migliore entropia.
- Viene utilizzata la sincronizzazione dell'ora di rete distribuita sicura (sdwdate) anziché NTP.
- Disattiva le anteprime in Dolphin, Nautilus.
- Disattiva i timestamp TCP e l'helper di monitoraggio delle connessioni di Netfilter.
- open-link-confirmation.
- Apparmor abilitato per impostazione predefinita con i profili.
- Browser con sicurezza avanzata (Tor Browser senza Tor)
Kernel Linux migliorato
Ambiente desktop: KDE (disponibile solo in CLI).
Altro …
Traguardo del 15 settembre (completamento dei requisiti di sistema, delle funzionalità e dei vantaggi, dei progetti e degli obiettivi)
La pagina delle domande frequenti verrà utilizzata per rispondere alle domande che vengono poste di frequente dai membri della community. I contenuti verranno aggiunti in base alle esigenze per tutta la durata del progetto.
Il download e l'installazione di Hardened Debian saranno i seguenti.
- Tabella di download che contiene l'immagine di Hardened Debian, la firma OpenGPG, l'hash sha512 e la chiave di firma GPG degli sviluppatori.
- Verifica della chiave di firma degli sviluppatori e dell'immagine di sistema del sistema operativo (tutorial).
- Download e verifica dell'hypervisor VirtualBox (tutorial).
- Importazione di Hardened Debian in VirtualBox (tutorial)
- Avvio di Hardened Debian
Traguardo del 29 settembre (completamento del download e della verifica delle immagini Debian, installazione di Debian)
Gli utenti potrebbero non conoscere i passaggi necessari per personalizzare l'ambiente desktop e allocare le risorse di sistema. I suggerimenti per la "configurazione rapida" verranno documentati per ciascuno dei seguenti.
- Modifica del layout della tastiera
- Allocazione di risorse di sistema aggiuntive (RAM)
- Modifica della risoluzione dello schermo
- Scorciatoie sul desktop
- Gestore dello stile delle finestre
I bug e i problemi riscontrati durante i test del sistema operativo e dei tutorial verranno documentati chiaramente insieme a soluzioni alternative e/o correzioni. Questa pagina includerà anche i problemi comuni quando si eseguono sistemi operativi negli hypervisor.
- Problemi di RAM insufficiente
- Configurazione errata del BIOS (Intel VT-d, AMD-V)
- Problemi di connettività
Traguardo del 6 ottobre (completamento dei primi passaggi, bug di Hardened Debian)
I nuovi utenti potrebbero non conoscere i terminali/CLI Linux. Se le informazioni di cui hanno bisogno non sono facili da trovare o accessibili, finiranno per aprire una richiesta di assistenza senza nemmeno provare a trovare una soluzione. Questa sezione documenterà i comandi di uso comune e la sintassi pratica dei comandi. Ogni man fornirà una breve descrizione del comando, come utilizzarlo e esempi pratici. Gli utenti impiegano un po' di tempo per ricordare i comandi che devono utilizzare per le diverse attività. Con la ripetizione, gli utenti ricorderanno la sintassi dei comandi nel tempo.
- Terminale/CLI
- sudo
- Editor di testo
- Struttura delle directory
- Navigazione nel file system
- Autorizzazioni file
- Pagine di manuale
- Creazione di file/directory
- Varie (ls, cat, less)
Traguardo del 22 ottobre (completamento dell'area di apprendimento, pagine di manuale)
Gli utenti Linux esperti hanno buone capacità di risoluzione dei problemi che acquisiscono nel tempo. Quando si verifica un problema, iniziano automaticamente a cercare una soluzione e continuano a cercare finché non trovano una risposta o tutte le risorse possibili non sono state esaurite. Quando un nuovo utente Linux riscontra un problema, apre automaticamente una richiesta di assistenza. È fondamentale che le best practice vengano rafforzate fin dall'inizio.
Modello di risoluzione dei problemi : è più probabile che gli utenti riescano a risolvere i problemi se seguono le istruzioni passo passo. Si concentrerà su come raccogliere informazioni pertinenti e su come utilizzare tali informazioni per trovare una soluzione al problema. Sarà simile.
Monitoraggio dei file di log: posizione dei log di sistema (per cosa viene utilizzato ciascuno) e comandi necessari per restringere l'output della CLI. (journalctl, dmesg e così via)
systemd: stato, avvio e arresto dei servizi.
Risoluzione dei problemi comuni: problemi di connessione, pacchetti software danneggiati e così via.
Linee guida per la segnalazione di bug e/o problemi.
Traguardo del 5 novembre (completamento dell'area di apprendimento, risoluzione dei problemi)
Il resto di Summer of Docs si concentrerà sul refactoring della documentazione di Whonix per Hardened Debian e sul controllo qualità.
Refactoring della documentazione di Whonix per l'utilizzo con Hardened Debian
- Installazione sicura del software.
- Aggiornamenti del sistema operativo