v1.0.0

Author: Maikuolan

Changelog.txt

@@ -9,6 +9,30 @@ Versioning guidelines for SemVer can be found at: https://semver.org/
 
 (none)
 
+=== Version/Release 1.0.0 ===
+MAJOR RELEASE (BACKWARDS COMPATIBLE).
+
+- [2020.03.01; Maikuolan]: Renamed "sigtool.php" to "SigTool.php" to align the
+  name of the file more closely to the name of the class. Added a separate YAML
+  class to handle all YAML functionality; SigTool will now extend that YAML
+  class, instead of trying to define any YAML functionality itself (strictly
+  speaking, this violates the idea of SigTool existing purely as a singular
+  file, free of any dependencies; but, having now two files instead of one, in
+  my opinion, isn't really a big deal, and its more maintainable now anyway, so
+  I think, a good way to proceed moving forward; this violation is also the
+  reason why I've opted to mark this release as a major release, as opposed to
+  minor or patch). Added some code to guard against regular expression-based
+  signatures that contain quantifiers that might exceed PCRE's limits, which
+  could result in compilation failure.
+
+- [2020.03.07; Bug-fix; Maikuolan]: A reconstructed "signatures.dat", after
+  processing new signature files, should be prefixed by "---"; not by
+  "0: false". The code wasn't properly accommodating this; Fixed.
+  Refer github.com/phpMussel/SigTool/issues/5
+
+Caleb M (Maikuolan),
+March 7, 2020.
+
 === Version/Release 0.2.3 ===
 PATCH RELEASE.
 

README.md

@@ -18,7 +18,7 @@ Before installing, please check the requirements. If these aren't met, SigTool w
 - >= 1GB free disk space (if working directly from disk) or available RAM (if using a RAM drive; recommended).
 - Ability to operate PHP in CLI-mode (command prompt, terminal, shell, etc).
 
-SigTool exists as a stand-alone PHP file and doesn't have any external dependencies (other than the requirements listed above), and so, the only thing you need to do to "install" it, is download `sigtool.php`.
+To install SigTool, just download `SigTool.php` and `YAML.php`. :-)
 
 SigTool can operate normally from a disk or storage medium in the same manner as any other PHP script. However, due to the large number of read/write operations it performs, it is highly recommended to operate it from a RAM drive, as this will slightly increase its speed and decrease excess disk read/write operations. Final output should not exceed approximately ~64MBs, but approximately ~1GB of free disk space or available RAM is required during normal operation due to temporary working files and in order to avoid read/write errors.
 
@@ -27,9 +27,9 @@ SigTool can operate normally from a disk or storage medium in the same manner as
 
 ### How to use:
 
-Note that SigTool is NOT a web-based PHP application (or web-app)! SigTool is a CLI-based PHP application (or CLI-app) intended to be used with terminal, shell, etc. It can be invoked by calling the PHP binary with the `sigtool.php` file as its first argument:
+Note that SigTool is NOT a web-based PHP application (or web-app)! SigTool is a CLI-based PHP application (or CLI-app) intended to be used with terminal, shell, etc. It can be invoked by calling the PHP binary with the `SigTool.php` file as its first argument:
 
-`$ php sigtool.php`
+`$ php SigTool.php`
 
 Help information will be displayed when SigTool is invoked, listing the possible flags (second argument) that can be used when operating SigTool.
 
@@ -57,4 +57,4 @@ More information can be found in the documentation herein.
 ---
 
 
-Last Updated: 24 December 2018 (2018.12.24).
+Last Updated: 7 March 2020 (2020.03.07).

_docs/readme.de.md

@@ -7,7 +7,7 @@ Vor der Installation, bitte überprüfen Sie, was erforderlich ist. Wenn was erf
 - >= 1GB freier Festplattenspeicher (wenn direkt von der Festplatte arbeiten) oder verfügbarer RAM (wenn Sie ein RAM-Laufwerk verwenden; empfohlen).
 - Möglichkeit für PHP im CLI-Modus zu betreiben (Eingabeaufforderung, Terminal, Shell, u.s.w.).
 
-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).
+Um SigTool zu installieren, laden Sie einfach `SigTool.php` und `YAML.php` herunter. :-)
 
 SigTool kann auf normale Weise von einem Datenträger oder Speichermedium auf die gleiche Weise wie jedes andere PHP-Skript arbeiten. Aufgrund jedoch der 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.
 
@@ -16,9 +16,9 @@ SigTool kann auf normale Weise von einem Datenträger oder Speichermedium auf di
 
 ### Benutzung:
 
-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:
+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:
 
-`$ php sigtool.php`
+`$ php SigTool.php`
 
 Hilfeinformationen werden angezeigt, wenn SigTool aufgerufen wird, der möglichen Flaggen auflistet (das zweite Argument), die beim Betrieb von SigTool verwendet werden können.
 
@@ -28,13 +28,13 @@ Möglichen Flaggen:
 - `p`: Verarbeitet Signaturdateien zur Verwendung mit phpMussel.
 - `m`: Holt `main.cvd` vor der Verarbeitung.
 - `d`: Holt `daily.cvd` vor der Verarbeitung.
-- `u`: Aktualisiert SigTool (lädt `sigtool.php` erneut herunter und die; es werden keine Prüfungen durchgeführt).
+- `u`: Aktualisiert SigTool (lädt `SigTool.php` erneut herunter und die; es werden keine Prüfungen durchgeführt).
 
 Die Ausgabe ist verschiedenen phpMussel-Signaturdateien, direkt aus der ClamAV-Signaturdatenbank in zwei Formen generiert:
 - Signaturdateien, die direkt in das `/vault/signatures/`-Verzeichnis eingefügt werden können.
 - GZ-komprimierte Kopien der Signaturdateien, mit denen das `phpMussel/Signatures`-Repository aktualisiert werden kann.
 
-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).
+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).
 
 Wenn Sie mit SigTool neue Signaturdateien erstellen, kann es sein dass der Antiviren-Scanner Ihres Computers versucht, die neu erstellten Signaturdateien zu löschen oder in die Quarantäne zu stellen. Dies ist darauf zurückzuführen, dass die Signaturdateien manchmal Daten enthalten, die den Daten sehr ähnlich sind, nach denen Ihr Antivirus beim Scannen sucht. Die von SigTool erzeugten Signaturdateien enthalten jedoch keinen ausführbaren Code und sind völlig harmlos. Wenn dieses Problem auftritt, können Sie versuchen, Ihren Antiviren-Scanner vorübergehend zu deaktivieren, oder Ihren Antiviren-Scanner so konfigurieren, dass das Verzeichnis, in dem Sie neue Signaturdateien erstellen, in die Whitelist aufgenommen wird.
 
@@ -98,4 +98,4 @@ clamav_swf_regex.db | Es handelt sich um SWF-Dateien; Funktioniert mit Rohdaten;
 ---
 
 
-Zuletzt aktualisiert: 26 Dezember 2018 (2018.12.26).
+Zuletzt aktualisiert: 7 März 2020 (2020.03.07).

_docs/readme.en.md

@@ -7,7 +7,7 @@ Before installing, please check the requirements. If these aren't met, SigTool w
 - >= 1GB free disk space (if working directly from disk) or available RAM (if using a RAM drive; recommended).
 - Ability to operate PHP in CLI-mode (command prompt, terminal, shell, etc).
 
-SigTool exists as a stand-alone PHP file and doesn't have any external dependencies (other than the requirements listed above), and so, the only thing you need to do to "install" it, is download `sigtool.php`.
+To install SigTool, just download `SigTool.php` and `YAML.php`. :-)
 
 SigTool can operate normally from a disk or storage medium in the same manner as any other PHP script. However, due to the large number of read/write operations it performs, it is highly recommended to operate it from a RAM drive, as this will slightly increase its speed and decrease excess disk read/write operations. Final output should not exceed approximately ~64MBs, but approximately ~1GB of free disk space or available RAM is required during normal operation due to temporary working files and in order to avoid read/write errors.
 
@@ -16,9 +16,9 @@ SigTool can operate normally from a disk or storage medium in the same manner as
 
 ### How to use:
 
-Note that SigTool is NOT a PHP-based web application (or web-app)! SigTool is a PHP-based CLI application (or CLI-app) intended to be used with terminal, shell, etc. It can be invoked by calling the PHP binary with the `sigtool.php` file as its first argument:
+Note that SigTool is NOT a PHP-based web application (or web-app)! SigTool is a PHP-based CLI application (or CLI-app) intended to be used with terminal, shell, etc. It can be invoked by calling the PHP binary with the `SigTool.php` file as its first argument:
 
-`$ php sigtool.php`
+`$ php SigTool.php`
 
 Help information will be displayed when SigTool is invoked, listing the possible flags (second argument) that can be used when operating SigTool.
 
@@ -28,13 +28,13 @@ Possible flags:
 - `p`: Process signature files for use with phpMussel.
 - `m`: Download `main.cvd` before processing.
 - `d`: Download `daily.cvd` before processing.
-- `u`: Update SigTool (redownloads `sigtool.php` and dies; no checks performed).
+- `u`: Update SigTool (redownloads `SigTool.php` and dies; no checks performed).
 
 Output produced is various phpMussel signature files generated directly from the ClamAV signatures database, in two forms:
 - Signature files that can be inserted directly into the `/vault/signatures/` directory.
 - GZ-compressed copies of the signature files that can be used to update the `phpMussel/Signatures` repository.
 
-Output is produced directly into the same directory as `sigtool.php`. Source files and all temporary working files will be deleted during the course of operation (so, if you want to keep copies of `daily.cvd` and `main.cvd`, you should make copies before processing the signature files).
+Output is produced directly into the same directory as `SigTool.php`. Source files and all temporary working files will be deleted during the course of operation (so, if you want to keep copies of `daily.cvd` and `main.cvd`, you should make copies before processing the signature files).
 
 When using SigTool to generate new signature files, it's possible that your computer's anti-virus scanner may attempt to delete or quarantine the newly generated signature files. This happens because sometimes, the signature files may contain data very similar to the data that your anti-virus looks for when scanning. However, the signature files generated by SigTool don't contain any executable code, and are completely benign. If you encounter this problem, you can try to temporarily disable your anti-virus scanner, or configure your anti-virus scanner to whitelist the directory where you're generating new signature files.
 
@@ -98,4 +98,4 @@ clamav_swf_regex.db | Targets SWF files; Works with raw data; Signatures can con
 ---
 
 
-Last Updated: 26 December 2018 (2018.12.26).
+Last Updated: 7 March 2020 (2020.03.07).

_docs/readme.es.md

@@ -7,7 +7,7 @@ Antes de la instalación, compruebe los requisitos. Si no se cumplen, SigTool no
 - >= 1GB de espacio libre en disco (si trabaja directamente desde el disco) o RAM disponible (si utiliza una unidad RAM; recomendado).
 - Capacidad para operar PHP en modo CLI (comando, terminal, shell, etc).
 
-SigTool existe como un archivo PHP autónomo y no tiene dependencias externas (distintos de los requisitos enumerados anteriormente), y así, lo único que tienes que hacer para "instalarlo", es descargar `sigtool.php`.
+Para instalar SigTool, simplemente descargue `SigTool.php` y `YAML.php`. :-)
 
 SigTool puede funcionar normalmente desde un disco o medio de almacenamiento de la misma manera que cualquier otro script PHP. Aunque, debido al gran número de operaciones de lectura/escritura que realiza, es altamente recomendable operarlo desde una unidad RAM, ya que esto aumentará ligeramente su velocidad y disminuirá el exceso de operaciones de lectura/escritura de disco. La salida final no debe exceder aproximadamente ~64MBs, pero aproximadamente ~1GB de espacio libre en disco o RAM disponible se requiere durante el funcionamiento normal debido a los archivos temporales de trabajo ya fin de evitar errores de lectura/escritura.
 
@@ -16,9 +16,9 @@ SigTool puede funcionar normalmente desde un disco o medio de almacenamiento de
 
 ### Cómo utilizar:
 
-Tenga en cuenta que SigTool NO es una aplicación web basada en PHP (o web-app)! SigTool es una aplicación CLI basada en PHP (o CLI-app) destinado a ser utilizado con terminal, shell, etc. Se puede invocar llamando al binario PHP con el archivo `sigtool.php` como su primer argumento:
+Tenga en cuenta que SigTool NO es una aplicación web basada en PHP (o web-app)! SigTool es una aplicación CLI basada en PHP (o CLI-app) destinado a ser utilizado con terminal, shell, etc. Se puede invocar llamando al binario PHP con el archivo `SigTool.php` como su primer argumento:
 
-`$ php sigtool.php`
+`$ php SigTool.php`
 
 La información de ayuda se mostrará cuando se invoque SigTool, enumerando las posibles banderas (segundo argumento) que se pueden utilizar cuando se utiliza SigTool.
 
@@ -28,13 +28,13 @@ Las posibles banderas:
 - `p`: Procese archivos de firmas para uso con phpMussel.
 - `m`: Descargue `main.cvd` antes de procesar.
 - `d`: Descargue `daily.cvd` antes de procesar.
-- `u`: Actualizar SigTool (descarga `sigtool.php` de nuevo y die; no se realizan cualquier comprobaciones).
+- `u`: Actualizar SigTool (descarga `SigTool.php` de nuevo y die; no se realizan cualquier comprobaciones).
 
 La salida producida es varios archivos de firmas para phpMussel generados directamente de la base de datos de firmas para ClamAV, de dos formas:
 - Archivos de firmas que se pueden insertar directamente en el directorio `/vault/signatures/`.
 - Copias de los archivos de firmas comprimidos con GZ que se pueden utilizar para actualizar el repositorio `phpMussel/Signatures`.
 
-La salida se produce directamente en el mismo directorio que `sigtool.php`. Los archivos fuente y todos los archivos de trabajo temporales se borrarán durante el curso de la operación (por lo tanto, si desea guardar copias de `daily.cvd` y `main.cvd`, debe hacer copias antes de procesar los archivos de firmas).
+La salida se produce directamente en el mismo directorio que `SigTool.php`. Los archivos fuente y todos los archivos de trabajo temporales se borrarán durante el curso de la operación (por lo tanto, si desea guardar copias de `daily.cvd` y `main.cvd`, debe hacer copias antes de procesar los archivos de firmas).
 
 Cuando lo usar SigTool para generar nuevos archivos de firmas, es posible que el analizador antivirus de su computadora intentará eliminar o poner en cuarentena los archivos de firmas generados. Esto puede ocurrir porque, a veces, los archivos de firmas pueden contener datos muy similares a los datos que su antivirus busca al escanear. Sin embargo, los archivos de firmas generados por SigTool no contienen ningún código ejecutable y son completamente benignos. Si encuentra este problema, puede intentar desactivar temporalmente su analizador antivirus, o configurar su antivirus para incluir en la lista blanca el directorio donde está generando los archivos de firmas nuevos.
 
@@ -98,4 +98,4 @@ clamav_swf_regex.db | Destinado a archivos SWF; Funciona con datos sin procesar;
 ---
 
 
-Última Actualización: 26 Diciembre de 2018 (2018.12.26).
+Última Actualización: 7 de Marzo de 2020 (2020.03.07).