Skip to content

Commit

Permalink
v1.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Maikuolan committed Jul 22, 2021
1 parent 68be5e2 commit 4ff61ef
Show file tree
Hide file tree
Showing 16 changed files with 175 additions and 91 deletions.
10 changes: 10 additions & 0 deletions Changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,22 @@ Versioning guidelines for SemVer can be found at: https://semver.org/

=== Changes made since last versioned release ===

None.

=== Version/Release 1.0.3 ===
PATCH RELEASE.

- [2021.07.15; Bug-fix; Maikuolan]: Resolved "error code: 1020" issue.
Refer github.com/phpMussel/SigTool/issues/6

- [2021.07.21; Maikuolan]: SigTool now displays current RAM usage throughout
its entire process.

- [2021.07.22; Maikuolan]: Update requirements and installation instructions.

Caleb M (Maikuolan),
July 22, 2021.

=== Version/Release 1.0.2 ===
MAINTENANCE RELEASE.

Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
[![Join the chat at https://gitter.im/phpMussel2/Lobby](https://badges.gitter.im/phpMussel2/Lobby.svg)](https://gitter.im/phpMussel2/Lobby)
[![PHP >= 7.0.3](https://img.shields.io/badge/PHP-%3E%3D%207.0.3-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](http://makeapullrequest.com)

Expand All @@ -14,13 +13,18 @@ Generates signatures for **[phpMussel](https://github.com/phpMussel/phpMussel)**
Before installing, please check the requirements. If these aren't met, SigTool won't operate correctly.

#### Requirements:
- PHP >= `7.0.3` with zlib + Phar support.
- >= 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).
- __For SigTool <=1.0.2:__ PHP >=7.0.3 with phar support (PHP >=7.2.0 recommended).
- __For SigTool 1.0.3:__ PHP >=7.0.3 (PHP >=7.2.0 recommended).
- __For SigTool v2:__ PHP >=7.2.0.
- __All versions:__ *At least* >=681 MBs of available RAM (but, at least >=1 GB is strongly recommended).
- __All versions:__ Approximately ~300 MBs of available disk space (this number may vary between iterations of the signatures database).
- __All versions:__ Ability to operate PHP in CLI-mode (e.g., command prompt, terminal, shell, bash, etc).

To install SigTool, just download `SigTool.php` and `YAML.php`. :-)
The recommended way to install SigTool is through Composer.

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.
`composer require phpmussel/sigtool`

Alternatively, you can clone the repository, or download the ZIP, directly from GitHub.

---

Expand Down Expand Up @@ -57,4 +61,4 @@ More information can be found in the documentation herein.
---


Last Updated: 7 March 2020 (2020.03.07).
Last Updated: 22 July 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
Vor der Installation, bitte überprüfen Sie, was erforderlich ist. Wenn was erforderlich ist nicht erfüllt ist, SigTool wird nicht richtig funktionieren.

#### Erforderlich:
- PHP >= `7.0.3` mit zlib + phar unterstützung.
- >= 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.).
- __Für SigTool <=1.0.2:__ PHP >=7.0.3 mit phar unterstützung (PHP >=7.2.0 empfohlen).
- __Für SigTool 1.0.3:__ PHP >=7.0.3 (PHP >=7.2.0 empfohlen).
- __Für SigTool v2:__ PHP >=7.2.0.
- __Alle Versionen:__ *Mindestens* >=681 MB verfügbarer RAM (aber mindestens >=1 GB wird dringend empfohlen).
- __Alle Versionen:__ Ungefähr ~300 MB verfügbarer Festplattenspeicher (diese Anzahl kann zwischen den Iterationen der Signaturdatenbank variieren).
- __Alle Versionen:__ Fähigkeit um PHP im CLI-Modus zu betreiben (z.B., Eingabeaufforderung, Terminal, Shell, Bash u.s.w.).

Um SigTool zu installieren, laden Sie einfach `SigTool.php` und `YAML.php` herunter. :-)
Die empfohlene Methode zur Installation von SigTool ist über Composer.

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.
`composer require phpmussel/sigtool`

Alternativ, können Sie das Repository klonen, oder die ZIP-Datei herunterladen, direkt von GitHub.

---

Expand Down Expand Up @@ -98,4 +103,4 @@ clamav_swf_regex.db | Es handelt sich um SWF-Dateien; Funktioniert mit Rohdaten;
---


Zuletzt aktualisiert: 7 März 2020 (2020.03.07).
Zuletzt aktualisiert: 22. Juli 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
Before installing, please check the requirements. If these aren't met, SigTool won't operate correctly.

#### Requirements:
- PHP >= `7.0.3` with zlib + Phar support.
- >= 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).
- __For SigTool <=1.0.2:__ PHP >=7.0.3 with phar support (PHP >=7.2.0 recommended).
- __For SigTool 1.0.3:__ PHP >=7.0.3 (PHP >=7.2.0 recommended).
- __For SigTool v2:__ PHP >=7.2.0.
- __All versions:__ *At least* >=681 MBs of available RAM (but, at least >=1 GB is strongly recommended).
- __All versions:__ Approximately ~300 MBs of available disk space (this number may vary between iterations of the signatures database).
- __All versions:__ Ability to operate PHP in CLI-mode (e.g., command prompt, terminal, shell, bash, etc).

To install SigTool, just download `SigTool.php` and `YAML.php`. :-)
The recommended way to install SigTool is through Composer.

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.
`composer require phpmussel/sigtool`

Alternatively, you can clone the repository, or download the ZIP, directly from GitHub.

---

Expand Down Expand Up @@ -98,4 +103,4 @@ clamav_swf_regex.db | Targets SWF files; Works with raw data; Signatures can con
---


Last Updated: 7 March 2020 (2020.03.07).
Last Updated: 22 July 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
Antes de la instalación, compruebe los requisitos. Si no se cumplen, SigTool no funcionará correctamente.

#### Requisitos:
- PHP >= `7.0.3` con soporte zlib + Phar.
- >= 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).
- __Para SigTool <=1.0.2:__ PHP >=7.0.3 con soporte phar (se recomienda PHP >=7.2.0).
- __Para SigTool 1.0.3:__ PHP >=7.0.3 (se recomienda PHP >=7.2.0).
- __Para SigTool v2:__ PHP >=7.2.0.
- __Todas las versiones:__ *Al menos* >=681 681 MB de RAM disponible (pero se recomienda encarecidamente al menos >=1 GB).
- __Todas las versiones:__ Aproximadamente ~300 MB de espacio disponible en disco (este número puede variar entre iteraciones de la base de datos de firmas).
- __Todas las versiones:__ Capacidad para operar PHP en modo CLI (por ejemplo, símbolo del sistema, terminal, shell, bash, etc).

Para instalar SigTool, simplemente descargue `SigTool.php` y `YAML.php`. :-)
La forma recomendada de instalar SigTool es a través de Composer.

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.
`composer require phpmussel/sigtool`

Alternativamente, puede clonar el repositorio o descargar el ZIP directamente desde GitHub.

---

Expand Down Expand Up @@ -98,4 +103,4 @@ clamav_swf_regex.db | Destinado a archivos SWF; Funciona con datos sin procesar;
---


Última Actualización: 7 de Marzo de 2020 (2020.03.07).
Última Actualización: 22 de Julio de 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
Avant l'installation, vérifiez les conditions requises. Si ceux-ci ne sont pas satisfaits, SigTool ne fonctionnera pas correctement.

#### Les conditions requises :
- PHP >= `7.0.3` avec support de zlib + Phar.
- >= 1Go d'espace disque libre (si vous travaillez directement à partir du disque) ou RAM disponible (si vous utilisez un disque RAM ; recommandé).
- Capacité d'opérer PHP en mode CLI (invite de commande, le terminal, shell, etc).
- __Pour SigTool <=1.0.2:__ PHP >=7.0.3 avec support de phar (PHP >=7.2.0 recommandé).
- __Pour SigTool 1.0.3:__ PHP >=7.0.3 (PHP >=7.2.0 recommandé).
- __Pour SigTool v2:__ PHP >=7.2.0.
- __Toutes les versions:__ *Au moins* >=681 Mo de RAM disponible (mais, au moins >=1 Go est fortement recommandé).
- __Toutes les versions:__ Environ ~300 Mo d'espace disque disponible (ce nombre peut varier entre les itérations de la base de données de signatures).
- __Toutes les versions:__ Capacité à utiliser PHP en mode CLI (par exemple, invite de commande, terminal, shell, bash, etc).

Pour installer SigTool, téléchargez simplement `SigTool.php` et `YAML.php`. :-)
La méthode recommandé pour installer SigTool est via Composer.

SigTool peut fonctionner normalement à partir d'un disque ou d'un support de stockage de la même manière que tout autre script PHP. Cependant, en raison du grand nombre d'opérations de lecture/écriture qu'il effectue, il est fortement recommandé de l'utiliser à partir d'un disque RAM, pour la raison qu'il augmentera légèrement sa vitesse et diminuera les opérations excédentaires de lecture/écriture du disque. La sortie finale ne doit pas dépasser environ ~64Mo, mais environ ~1Go d'espace disque libre ou RAM disponible est requis pendant le fonctionnement normal en raison de fichiers de travail temporaires et afin d'éviter les erreurs de lecture/écriture.
`composer require phpmussel/sigtool`

Alternativement, vous pouvez cloner le référentiel ou télécharger le ZIP directement depuis GitHub.

---

Expand Down Expand Up @@ -98,4 +103,4 @@ clamav_swf_regex.db | Cible les fichiers SWF ; Fonctionne avec des données bru
---


Dernière mise à jour : 7 Mars 2020 (2020.03.07).
Dernière mise à jour : 22 Juillet 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.id.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
Sebelum menginstal, mohon periksa persyaratannya. Jika ini tidak terpenuhi, SigTool tidak akan beroperasi dengan benar.

#### Persyaratan:
- PHP >= `7.0.3` dengan dukungan zlib + Phar.
- >= 1GB ruang disk kosong (jika bekerja langsung dari disk) atau RAM yang tersedia (jika menggunakan drive RAM; direkomendasikan).
- Kemampuan mengoperasikan PHP dalam modus CLI (command prompt, terminal, shell, dll).
- __Untuk SigTool <=1.0.2:__ PHP >=7.0.3 dengan dukungan phar (PHP >=7.2.0 direkomendasikan).
- __Untuk SigTool 1.0.3:__ PHP >=7.0.3 (PHP >=7.2.0 direkomendasikan).
- __Untuk SigTool v2:__ PHP >=7.2.0.
- __Semua versi:__ *Setidaknya* >=681 MB RAM yang tersedia (tapi, minimal >=1 GB sangat direkomendasikan).
- __Semua versi:__ Sekitar ~300 MB ruang disk yang tersedia (jumlah ini dapat bervariasi antara iterasi database tanda tangan).
- __Semua versi:__ Kemampuan untuk mengoperasikan PHP dalam modus CLI (misalnya, command prompt, terminal, shell, bash, dll).

Untuk menginstal SigTool, cukup download `SigTool.php` dan `YAML.php`. :-)
The recommended way to install SigTool is through Composer.

SigTool dapat beroperasi secara normal dari media disk atau media penyimpanan dengan cara yang sama seperti skrip PHP lainnya. Namun, karena banyaknya operasi baca/tulis yang dilakukan, sangat direkomendasikan untuk mengoperasikannya dari drive RAM, karena ini akan sedikit meningkatkan kecepatan dan mengurangi kelebihan operasi disk baca/tulis. Output akhir tidak boleh melebihi kira-kira ~64MBs, tapi kira-kira ~1GB ruang disk kosong atau RAM yang tersedia diperlukan selama operasi normal karena file kerja sementara dan untuk menghindari kesalahan baca/tulis.
`composer require phpmussel/sigtool`

Sebaliknya, Anda dapat mengkloning repositori, atau mengunduh ZIP, langsung dari GitHub.

---

Expand Down Expand Up @@ -98,4 +103,4 @@ clamav_swf_regex.db | Menargetkan file SWF; Bekerja dengan data mentah; Tanda ta
---


Terakhir Diperbarui: 7 Maret 2020 (2020.03.07).
Terakhir Diperbarui: 22 Juli 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.it.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
Prima di installare, controllare i requisiti. Se questi non sono soddisfatti, SigTool non funzionerà correttamente.

#### Requisiti:
- PHP >= `7.0.3` con supporto zlib + Phar.
- >= 1GB di spazio libero su disco (se lavora direttamente dal disco) o RAM disponibile (se si utilizza un'unità RAM; consigliato).
- Capacità di utilizzare PHP in modalità CLI (prompt dei comandi, terminal, shell, ecc).
- __Per SigTool <=1.0.2:__ PHP >=7.0.3 con supporto di phar (PHP >=7.2.0 consigliato).
- __Per SigTool 1.0.3:__ PHP >=7.0.3 (PHP >=7.2.0 consigliato).
- __Per SigTool v2:__ PHP >=7.2.0.
- __Tutte le versioni:__ *Almeno* >=681 MB di RAM disponibile (ma almeno >=1 GB è fortemente consigliato).
- __Tutte le versioni:__ Circa ~300 MB di spazio disponibile su disco (questo numero può variare tra le iterazioni del database delle firme).
- __Tutte le versioni:__ Capacità di utilizzare PHP in modalità CLI (ad es., prompt dei comandi, terminale, shell, bash, ecc).

Per installare SigTool, basta scaricare `SigTool.php` e `YAML.php`. :-)
Il modo consigliato per installare SigTool è tramite Composer.

SigTool può funzionare normalmente da un disco o da un supporto di memorizzazione nello stesso modo di qualsiasi altro script PHP. Tuttavia, a causa del numero elevato di operazioni di lettura/scrittura che esegue, è altamente consigliato per azionarlo da un'unità RAM, poichè ciò aumenterà leggermente la sua velocità e diminuirà le operazioni di lettura/scrittura di disco eccessivo. L'output finale non dovrebbe superare approssimativamente ~64MB, ma approssimativamente ~1GB di spazio libero su disco o RAM disponibile è necessario durante il normale funzionamento a causa di file temporanei di lavoro e per evitare errori di lettura/scrittura.
`composer require phpmussel/sigtool`

In alternativa, puoi clonare il repository, o scaricare lo ZIP, direttamente da GitHub.

---

Expand Down Expand Up @@ -97,4 +102,4 @@ clamav_swf_regex.db | Destinato ai file SWF; Funziona con dati non processati; L
---


Ultimo Aggiornamento: 7 Marzo 2020 (2020.03.07).
Ultimo Aggiornamento: 22 Luglio 2021 (2021.07.22).
17 changes: 11 additions & 6 deletions _docs/readme.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
インストールする前に、要件を確認してください。​要件が満たされていない場合、SigToolは正しく動作しません。

#### 要件:
- PHP >= `7.0.3` + pharとzlibのサポート。
- >= 1GBの空きディスク容量(ディスクから直接作業する場合)か利用可能なRAM(RAMドライブを使用している場合。推奨です)。
- CLIモードでPHPを操作する能力(コマンド・プロンプト、端末、シェル、など)。
- __SigTool <=1.0.2 の場合:__ pharをサポートする PHP >=7.0.3 (PHP >=7.2.0 をお勧めします).
- __SigTool 1.0.3 の場合:__ PHP >=7.0.3 (PHP >=7.2.0 をお勧めします).
- __SigTool v2 の場合:__ PHP >=7.2.0.
- __すべてのバージョン:__ *少なくとも* >=681 MBの使用可能なRAM(ただし、少なくとも >=1 GBを強くお勧めします)。
- __すべてのバージョン:__ 使用可能なディスク容量は約 300 MBです(この数は、シグネチャ・データベースの反復ごとに異なる場合があります)。
- __すべてのバージョン:__ PHPを、CLIモードで操作する機能(例えば、コマンド・プロンプト、ターミナル、シェル、bash、など)。

SigToolをインストールするには、`SigTool.php``YAML.php`をダウンロードするだけです。 :-)
SigToolをインストールするための推奨される方法は、Composerを使用することです。

SigToolは、他のPHPスクリプトと同じ方法でディスクまたは記憶媒体から操作できます。​読み取り/書き込み操作が多いため、RAMドライブから操作することをお勧めします。​これにより、速度がわずかに向上し、過剰なディスク読み取り/書き込み操作が減少します。​出力は約〜64MBを超えてはなりませんが、一時的な作業ファイルのため、および読み取り/書き込みエラーを回避するために、通常の動作中に約〜1GBの空きディスク容量または使用可能なRAMが必要です。
`composer require phpmussel/sigtool`

お望みならば、リポジトリのクローンを作成するか、GitHubから直接ZIPをダウンロードすることもできます。

---

Expand Down Expand Up @@ -98,4 +103,4 @@ clamav_swf_regex.db | SWFファイルを操作します。​生データ
---


最終アップデート:2020年3月7日
最終アップデート:2021年7月22日
Loading

0 comments on commit 4ff61ef

Please sign in to comment.