LiSCrypt 1.0.10

LiSCrypt ist ein Programm zur symmetrischen Verschlüsselung von Einzeldateien unter Verwendung von AES-GCM-256 bzw. einer Kombination von ChaCha20 und HMAC für sehr große Dateien.

Es wurde ursprünglich von der Qualitäts- und UnterstützungsAgentur - Landesinstitut für Schule in Nordrhein-Westfalen entwickelt.

Prozedere

Die folgenden Ausführungen sollen Ihnen helfen, eine lokale Kopie von LiSCrypt auf Ihrem Rechner zu starten, die Sie für eigene Weiterentlickungen oder zu Testzwecken verwenden wollen. Falls Sie LiSCrypt in Ihrer Umgebung als ausführbares Programm ausrollen möchten, berücksichtigen Sie bitte die Hinweise unter "Ausrollen".

Voraussetzungen

Voraussetzungen für die Verwendung von LiSCrypt

• Python 3.9.x
• Windows, macOS oder Linux

Benötigte Bibliotheken

LiSCrypt 1.0.10 wurde u.a. mit den im Folgenden angegebenen Versionen getestet. Möglicherweise funktionieren insb. neuere Versionen ebenfalls.

• base91, Version 1.0.1 - Base91-Kodiere/-Dekodierer
• pyca/cryptography, Version 36.0.1 - Kryptografie-Backend
• psutil, Version 5.9.0 - Bibliothek für die Ermittlung von Systeminformationen
• PyQt 5, Version 5.15.6 - Python-Schnittstelle zum GUI-Framework Qt 5
• Unter Windows: pywin32, Version 303 - Bibliothek für Zugriff auf die Windows API
• PyYAML, Version 6.0 - Bibliothek für Im- und Export von YAML-Dateien

Nähere Informationen zu den benötigten Fremdquellen finden sich in der Dokumentation.

Installation und erster Start

1. Herunterladen und Installieren von Python 3.9.x.

   Entsprechend des persönlichen Bedarfs können Schritte 2, 3 und 4 entweder systemweit oder alternativ unter Verwendung von virtualenv durchgeführt werden.

2. Update von pip:

   python3 -m pip install --upgrade pip
   

3. Installieren der benötigten Abhängigkeiten (in den Versionen, mit denen LiSCrypt 1.0.10 getestet wurde):

   pip3 install base91==1.0.1 cryptography==36.0.1 psutil==5.9.0 PyQt5==5.15.6 PyYAML==6.0 pywin32==303  
   

   Hinweis: Das Paket pywin32 existiert nur unter Windows und muss z.B. unter macOS oder Linux ausgelassen werden.

4. Herunterladen / Auspacken des LiSCrypt-Quelltextes, z.B. von https://github.com/MaWe2019/LiSCrypt_public/releases

5. Starten des Programms:

   python3 -m Steuerung.LiSCrypt
   

   oder Import in eine beliebige Python-IDE. Entwickelt wurde LiSCrypt mit der Community-Variante von PyCharm.

6. Test aller Programmfunktionen (Verschlüsseln, Entschlüsseln, Vernichten) mit Dummy-Dateien.

Ausrollen

Zum Ausrollen von LiSCrypt in ausführbarer Form kann PyInstaller verwendet werden. Dabei ist insbesondere auf hidden imports und die Einbeziehung der Visual C++ Runtime-Biblitoheken zu achten.

LiSCrypt Shell-Erweiterung (Windows)

Unter Windows existiert seit Version 1.0.0 von LiSCrypt eine Shell-Erweiterung. Damit können die wesentlichen Programmfunktionen auch per Rechtsklick auf Dateien/Ordner ausgeführt werden. Die Shell-Erweiterung wurde mit Visual Studio 2019 in C++ unter Verwendung von ATL erstellt. Der Quelltext ist ebenfalls unter https://github.com/MaWe2019/LiSCrypt_public/releases verfübar.

Beiträge zur Weiterentwicklung

Sie möchten uns bei der Weiterentwicklung von LiSCrypt unterstützen? Wenden Sie sich an Martin Weise bei QUA-LiS NRW

Quelltext-Formatierung

• Weitestgehende Verwendung von camelCase (entgegen der PEP8-Spezifikation)
• Einrückungen mit Tabs (entgegen der PEP8-Spezifikation)
• Modul- und Klassennamen beginnen mit einem Großbuchstaben
• Konstanten und globale Variablen werden komplett in Großbuchstaben geschrieben
• Methodennamen beginnen mit einem Kleinbuchstaben und beschreiben sematisch eine Tätigkeit
• Modulnamen beginnen mit 'LiS'
• Klassennamen beginnen mit 'Q', Klassennamen für GUI-Komponenten beginnen mit 'Ui_'
• Verwendung von Präfixen zur Unterscheidung von Attributen/Bezugsobjekten ('s'), Parametern ('p') und lokalen Variablen ('l')
• Attribute/Bezugsobjekte, Parameter und lokale Varaiblen enden mit einer Typangabe (z.B. lNachrichtString)
• Bezeichner und Kommentare in deutscher Sprache (ohne Umlaute)
• Ansätze des MVC-Prinzips

Versionierung und Updates

Die Versionierung von LiSCrypt folgt dem SemVer-Schema. Der Quelltext zu den verschiedenen Versionen wird in Form von zip-Archiven in diesem Repository zur Verfügung gestellt.

Copyright

• QUA-LiS NRW, Projektleitung: Martin Weise

Lizenz

LiSCrypt ist lizenziert unter der GNU General Public License Version 3 (GNU GPL v3). Den Lizenztext finden Sie in der Datei COPYING.

Sicherheitsaudits

Für die Version 0.9.5 von LiSCrypt wurden zwei externe Sicherheitsprüfungen durchgeführt, bei denen auch das Verschlüsselungsverfahren in den Blick genommen wurde.

Mitwirkende

• Dr. Albert Kapune, Tests
• Arbeitsbereich 5 von QUA-LiS NRW, Verbesserungsvorschläge

ToDo

• Verhalten bei parallelem Doppelklick auf mehrere verschlüsselte Dokumente
• Egränzung/Ausschwärfung der Quelltext-Dokumentation