Skip to content

Commit 8bcaaf2

Browse files
committed
Documentation update.
1 parent d16873e commit 8bcaaf2

File tree

3 files changed

+104
-1
lines changed

3 files changed

+104
-1
lines changed

Changelog.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Versioning guidelines for SemVer can be found at: http://www.semver.org/
1212
slightly reduce complaints sometimes made by certain code quality checkers
1313
and such). It's also less messy now to use an integer value of zero as a key.
1414

15+
- [2018.12.23; Documentation; Maikuolan]: Completed translating the SigTool
16+
README to German. This totals 11 translations now available.
17+
1518
=== Version/Release 0.2.2 ===
1619
PATCH RELEASE.
1720

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ More information can be found in the documentation herein.
3737

3838
### Documentation:
3939
- **[English](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.en.md)**
40+
- **[Deutsch](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.de.md)**
4041
- **[Español](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.es.md)**
4142
- **[Français](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.fr.md)**
4243
- **[Bahasa Indonesia](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.id.md)**
@@ -49,4 +50,4 @@ More information can be found in the documentation herein.
4950

5051
---
5152

52-
*Last modified: 3 September 2018 (2018.09.03).*
53+
*Last modified: 23 December 2018 (2018.12.23).*

_docs/readme.de.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
### Installation:
2+
3+
Vor der Installation, bitte überprüfen Sie, was erforderlich ist. Wenn was erforderlich ist nicht erfüllt ist, SigTool wird nicht richtig funktionieren.
4+
5+
#### Erforderlich:
6+
- PHP >= `7.0.3` mit zlib + phar unterstützung.
7+
- >= 1GB freier Festplattenspeicher (wenn direkt von der Festplatte arbeiten) oder verfügbarer RAM (wenn Sie ein RAM-Laufwerk verwenden; empfohlen).
8+
- Möglichkeit für PHP im CLI-Modus zu betreiben (commandEingabeaufforderung, Terminal, Shell, u.s.w.).
9+
10+
SigTool existiert als eigenständige PHP-Datei und hat keine externen Abhängigkeiten (abgesehen von den oben aufgeführten), und so, um es zu "installieren", müssen Sie `sigtool.php` herunterladen (nichts anderes wird benötigt).
11+
12+
SigTool kann auf normale Weise von einem Datenträger oder Speichermedium auf die gleiche Weise wie jedes andere PHP-Skript arbeiten. Aufgrund jedoch die großen Anzahl der ausgeführten Lese/Schreibvorgänge, es wird dringend empfohlen, es von einem RAM-Laufwerk aus zu betreiben, weil dies seine Geschwindigkeit etwas erhöhen und überschüssige Lese/Schreibvorgänge reduzieren. Die endgültige Ausgabe sollte ungefähr ~64MB nicht überschreiten, aber im normalen Betrieb sind ungefähr ~1GB freier Festplattenspeicher oder verfügbarer RAM erforderlich aufgrund temporärer Arbeitsdateien und um Lese/Schreibfehler zu vermeiden.
13+
14+
---
15+
16+
17+
### Benutzung:
18+
19+
Beachten Sie dass SigTool ist KEINE PHP-basierte Web-App! SigTool ist eine PHP-basierte CLI-App, bestimmt zur Verwendung mit Terminal, Shell, u.s.w. Es kann aufgerufen werden, indem die PHP-Binärdatei mit der Datei `sigtool.php` als erstes Argument aufgerufen:
20+
21+
`$ php sigtool.php`
22+
23+
Hilfeinformationen werden angezeigt, wenn SigTool aufgerufen wird, der möglichen Flaggen auflistet (das zweite Argument), die beim Betrieb von SigTool verwendet werden können.
24+
25+
Möglichen Flaggen:
26+
- Keine Argumente: Zeigt diese Hilfeinformationen.
27+
- `x`: Extrahiert Signaturdateien aus "daily.cvd" und "main.cvd".
28+
- `p`: Verarbeitet Signaturdateien zur Verwendung mit phpMussel.
29+
- `m`: Holt `main.cvd` vor der Verarbeitung.
30+
- `d`: Holt `daily.cvd` vor der Verarbeitung.
31+
- `u`: Aktualisiert SigTool (lädt `sigtool.php` erneut herunter und die; es werden keine Prüfungen durchgeführt).
32+
33+
Die Ausgabe ist verschiedenen phpMussel-Signaturdateien, direkt aus der ClamAV-Signaturdatenbank in zwei Formen generiert:
34+
- Signaturdateien, die direkt in das `/vault/signatures/`-Verzeichnis eingefügt werden können.
35+
- GZ-komprimierte Kopien der Signaturdateien, mit denen das `phpMussel/Signatures`-Repository aktualisiert werden kann.
36+
37+
Die Ausgabe wird direkt in demselben Verzeichnis wie `sigtool.php` erzeugt. Quelldateien und alle temporären Arbeitsdateien werden im laufenden Betrieb gelöscht (so, wenn Sie Kopien von `daily.cvd` und `main.cvd` behalten möchten, Sie sollten Kopien erstellen, bevor Sie die Signaturdateien verarbeiten).
38+
39+
Wenn sich die `signatures.dat` YAML-Datei bei der Verarbeitung in demselben Verzeichnis befindet, Versionsinformationen und Prüfsummen werden entsprechend aktualisiert (so, wenn Sie SigTool verwenden um das `phpMussel/Signatures`-Repository zu aktualisieren, dies sollte enthalten sein).
40+
41+
*Beachten: Wenn Sie phpMussel-Benutzer sind, bitte bedenke, dass Signaturdateien AKTIV sein müssen, damit sie korrekt funktionieren! Wenn Sie SigTool verwenden um neue Signaturdateien zu erstellen, Sie können sie "aktivieren", indem Sie sie in der "Active"-Direktive der phpMussel-Konfiguration auflisten. Wenn Sie die Front-End-Aktualisierungsseite verwenden, um Signaturdateien zu installieren und zu aktualisieren, Sie können sie direkt von der Front-End-Aktualisierungsseite aus aktivieren. Beide Methoden verwenden sind jedoch nicht erforderlich. Auch, für optimale Leistung, es wird empfohlen nur verwenden Sie die Signaturdateien, die Sie für Ihre Installation benötigen (z.B., wenn ein bestimmter Dateityp auf der schwarzen Liste steht, Sie werden wahrscheinlich keine Signaturdateien benötigen, die diesem Dateityp entsprechen; das Analysieren von Dateien, die trotzdem blockiert werden, ist überflüssige Arbeit und kann den Scanvorgang erheblich verlangsamen).*
42+
43+
Eine Videodemo zur Verwendung von SigTool ist auf YouTube verfügbar: __[youtu.be/f2LfjY1HzRI](https://youtu.be/f2LfjY1HzRI)__
44+
45+
---
46+
47+
48+
### Liste der von SigTool erzeugten Signaturdateien:
49+
Signaturdatei | Beschreibung
50+
---|---
51+
clamav.hdb | Es handelt sich an alle Arten von Dateien; Funktioniert mit Datei-Prüfsummen.
52+
clamav.htdb | Es handelt sich um HTML-Dateien; Funktioniert mit HTML-normalisierten Daten.
53+
clamav_regex.htdb | Es handelt sich um HTML-Dateien; Funktioniert mit HTML-normalisierten Daten; Signaturen können Reguläre Ausdrücke enthalten.
54+
clamav.mdb | Es handelt sich um PE-Dateien; Funktioniert mit PE-Sektional-Metadaten.
55+
clamav.ndb | Es richtet sich an alle Arten von Dateien; Funktioniert mit ANSI-normalisierten Daten.
56+
clamav_regex.ndb | Es richtet sich an alle Arten von Dateien; Funktioniert mit ANSI-normalisierten Daten; Signaturen können Reguläre Ausdrücke enthalten.
57+
clamav.db | Es richtet sich an alle Arten von Dateien; Funktioniert mit Rohdaten.
58+
clamav_regex.db | Es richtet sich an alle Arten von Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
59+
clamav_elf.db | Es handelt sich um ELF-Dateien; Funktioniert mit Rohdaten.
60+
clamav_elf_regex.db | Es handelt sich um ELF-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
61+
clamav_email.db | Es handelt sich um EML-Dateien; Funktioniert mit Rohdaten.
62+
clamav_email_regex.db | Es handelt sich um EML-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
63+
clamav_exe.db | Es handelt sich um PE-Dateien; Funktioniert mit Rohdaten.
64+
clamav_exe_regex.db | Es handelt sich um PE-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
65+
clamav_graphics.db | Es handelt sich um Bilddateien; Funktioniert mit Rohdaten.
66+
clamav_graphics_regex.db | Es handelt sich um Bilddateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
67+
clamav_java.db | Es handelt sich um Java-Dateien; Funktioniert mit Rohdaten.
68+
clamav_java_regex.db | Es handelt sich um Java-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
69+
clamav_macho.db | Es handelt sich um Mach-O-Dateien; Funktioniert mit Rohdaten.
70+
clamav_macho_regex.db | Es handelt sich um Mach-O-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
71+
clamav_ole.db | Es handelt sich um OLE-Objekte; Funktioniert mit Rohdaten.
72+
clamav_ole_regex.db | Es handelt sich um OLE-Objekte; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
73+
clamav_pdf.db | Es handelt sich um PDF-Dateien; Funktioniert mit Rohdaten.
74+
clamav_pdf_regex.db | Es handelt sich um PDF-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
75+
clamav_swf.db | Es handelt sich um SWF-Dateien; Funktioniert mit Rohdaten.
76+
clamav_swf_regex.db | Es handelt sich um SWF-Dateien; Funktioniert mit Rohdaten; Signaturen können Reguläre Ausdrücke enthalten.
77+
78+
---
79+
80+
81+
### Hinweis zu Signaturdateierweiterungen:
82+
*Diese Informationen werden in Zukunft erweitert.*
83+
84+
- __cedb__: Komplexe erweiterte Signaturdateien (dies ist ein für phpMussel erstelltes Format, und hat keinen Bezug zur ClamAV-Signaturdatenbank; SigTool generiert keine Signaturdateien mit dieser Erweiterung; diese werden manuell für das `phpMussel/Signatures`-Repository geschrieben; `clamav.cedb` enthält Anpassungen einiger obsolet/veralteter Signaturen aus früheren Versionen der ClamAV-Signaturen-Datenbank, die weiterhin als nützlich für phpMussel gelten). Signaturdateien, die mit verschiedenen Regeln arbeiten, die auf erweiterten Metadaten basieren, die von phpMussel generiert werden, verwenden diese Erweiterung.
85+
- __db__: Standard-Signaturdateien (diese werden aus den in `daily.cvd` und `main.cvd` enthaltenen `.ndb`-Signaturdateien extrahiert). Signaturdateien, die direkt mit dem Dateiinhalt arbeiten, verwenden diese Erweiterung.
86+
- __fdb__: Dateiname-Signaturdateien (Die Datenbank der ClamAV-Signaturen früher unterstützte Dateinamensignaturen, aber nicht länger; SigTool generiert keine Signaturdateien mit dieser Erweiterung; beibehalten wegen der fortgesetzten Nützlichkeit für phpMussel). Signaturdateien, die mit Dateinamen arbeiten, verwenden diese Erweiterung.
87+
- __hdb__: Prüfsummen-Signaturdateien (diese werden aus den in `daily.cvd` und `main.cvd` enthaltenen `.hdb`-Signaturdateien extrahiert). Signaturdateien, die mit Dateiprüfsummen arbeiten, verwenden diese Erweiterung.
88+
- __htdb__: HTML-Signaturdateien (diese werden aus den in `daily.cvd` und `main.cvd` enthaltenen `.ndb`-Signaturdateien extrahiert). Signaturdateien, die mit HTML-normalisierten Dateiinhalten arbeiten, verwenden diese Erweiterung.
89+
- __mdb__: PE-Sektional-Signaturdateien (diese werden aus den in `daily.cvd` und `main.cvd` enthaltenen `.mdb`-Signaturdateien extrahiert). Signaturdateien, die mit PE-Sektional-Metadaten arbeiten, verwenden diese Erweiterung.
90+
- __medb__: PE-Erweiterte-Signaturdateien (dies ist ein für phpMussel erstelltes Format, und hat keinen Bezug zur ClamAV-Signaturdatenbank; SigTool generiert keine Signaturdateien mit dieser Erweiterung; diese werden manuell für das `phpMussel/Signatures`-Repository geschrieben). Signaturdateien, die mit PE-Metadaten (außer PE-Sektional-Metadaten) arbeiten, verwenden diese Erweiterung.
91+
- __ndb__: Normalisierte Signaturdateien (diese werden aus den in `daily.cvd` und `main.cvd` enthaltenen `.ndb`-Signaturdateien extrahiert). Signaturdateien, die mit ANSI-normalisierten Dateiinhalten arbeiten, verwenden diese Erweiterung.
92+
- __udb__: URL-Signaturdateien (dies ist ein für phpMussel erstelltes Format, und hat keinen Bezug zur ClamAV-Signaturdatenbank; SigTool generiert *derzeit* keine Signaturdateien mit dieser Erweiterung, dies kann sich jedoch in Zukunft ändern; derzeit werden diese manuell für das `phpMussel/Signatures`-Repository geschrieben). Signaturdateien, die mit URLs arbeiten, verwenden diese Erweiterung.
93+
- __ldb__: Logische Signaturdateien (diese werden *eventuell*, für eine zukünftige SigTool-Version, aus den in `daily.cvd` und `main.cvd` enthaltenen `.ldb`-Signaturdateien extrahiert, aber noch nicht von SigTool oder phpMussel unterstützt). Signaturdateien, die mit verschiedenen logischen Regeln arbeiten, verwenden diese Erweiterung.
94+
95+
96+
---
97+
98+
99+
Zuletzt aktualisiert: 23 Dezember 2018 (2018.12.23).

0 commit comments

Comments
 (0)