Skip to content

Commit

Permalink
Documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
Maikuolan committed Sep 16, 2017
1 parent 59777a1 commit 4a567dc
Show file tree
Hide file tree
Showing 4 changed files with 212 additions and 3 deletions.
13 changes: 11 additions & 2 deletions Changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,20 @@ Versioning guidelines for SemVer can be found at: http://www.semver.org/

- [2017.08.29-09.05; Documentation; Maikuolan]: Completed translation for the
SigTool README documentation into Spanish, French, Indonesian, Italian,
Dutch, Portuguese. This totals 7 different language versions of the README
documentation now available.
Dutch, and Portuguese. This totals 7 different language versions of the
README documentation now available.

- [2017.09.05; Sub-minor code change; Maikuolan]: Improved progress display.

- [2017.09.10; Documentation; Maikuolan]: Completed translation for the
SigTool README documentation into Vietnamese. This totals 8 different
language versions of the README documentation now available.

- [2017.09.16; Documentation; Maikuolan]: Completed translation for the
SigTool README documentation into Chinese (simplified and traditional). This
totals 10 different language versions of the README documentation now
available.

=== Version/Release 0.1.0 ===
FIRST TAGGED RELEASE.

Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ More information can be found in the documentation herein.
- **[Nederlandse](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.nl.md)**
- **[Português](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.pt.md)**
- **[Tiếng Việt](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.vi.md)**
- **[中文(简体)](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.zh.md)**
- **[中文(傳統)](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.zh-tw.md)**

---


*Last modified: 10 September 2017 (2017.09.10).*
*Last modified: 16 September 2017 (2017.09.16).*
99 changes: 99 additions & 0 deletions _docs/readme.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
### 如何安裝:

安裝前請檢查要求。​如果這些不符合,SigTool將無法正常運行。

#### 要求:
- PHP >= `7.0.3` 用zlib + Phar支持。
- >= 1GB可用磁盤空間(如果直接從磁盤工作)或可用RAM(如果使用RAM驅動器;推薦的)。
- 能夠在CLI模式下操作PHP(命令提示符,終端,shell,等等)。

SigTool作為一個獨立的PHP文件存在,沒有任何外部依賴關係(除上述要求外),所以,您唯一需要做的『安裝』它是下載`sigtool.php`

SigTool可以像任何其他PHP腳本從磁盤或存儲介質一樣運行。​但是,由於執行了大量的讀/寫操作,強烈建議您從RAM驅動器進行操作,因為這會稍微增加速度並減少多餘的磁盤讀/寫操作。​最終輸出不應超過約64MB,但在正常操作期間需要約1GB的可用磁盤空間或可用RAM由於臨時工作文件和為了避免讀/寫錯誤。

---


### 如何使用:

請注意,SigTool不是基於PHP的網絡應用程序(或『web-app』)!​SigTool是基於PHP的CLI應用程序(或『CLI-app』)旨在與終端,shell,等等一起使用。​可以通過使用`sigtool.php`文件作為第一個參數調用PHP二進制來調用它:

`$ php sigtool.php`

當調用SigTool時,將顯示幫助信息,列出了在運行SigTool時可以使用的參數。

可以使用的參數:
- 沒有參數:顯示此幫助信息。
- `x`:從`daily.cvd`和`main.cvd'中提取簽名文件。
- `p`:處理用於phpMussel的簽名文件。
- `m`:在處理之前下載`main.cvd`
- `d`:在處理之前下載`daily.cvd`
- `u`:更新SigTool(重新`sigtool.php`下載然後die;沒有檢查執行).

產生的產出是各種phpMussel簽名文件直接從ClamAV簽名數據庫生成,有兩種形式:
- 可以直接插入在`/vault/signatures/`目錄的簽名文件。
- GZ壓縮的簽名文件副本,可用於更新`phpMussel/Signatures`存儲庫。

輸出直接生成到與`sigtool.php`相同的目錄中。​源文件和所有臨時工作文件將在操作過程中被刪除(所以,如果您想保留『daily.cvd』和『main.cvd』的副本,您應該在處理簽名文件之前進行複制)。

如果`signatures.dat` YAML文件在處理時包含在同一目錄中,版本信息和校驗和將相應更新(所以,當使用SigTool於更新`phpMussel/Signatures`存儲庫,這應該包括在內)。

*注意:如果您是phpMussel用戶,請記住,簽名文件必須是『活性』以便正常工作!​如果您使用SigTool於生成新的簽名文件,您可以通過在phpMussel配置『Active』指令中列出它們來『啟用』它們。​如果您正在使用前端更新頁面來安裝和更新簽名文件,您可以從前端更新頁面直接『啟用』他們。​但是,使用這兩種方法是不必要的。​此外,為了最佳的phpMussel性能,建議您僅使用安裝所需的簽名文件(例如,如果某些特定類型的文件被列入黑名單,您可能不需要與該類型的文件相對應的簽名文件;​分析將被阻止的文件是多餘的工作,可以顯著減慢掃描過程)。*

使用SigTool的視頻演示在YouTube上可用: __[youtu.be/f2LfjY1HzRI](https://youtu.be/f2LfjY1HzRI)__

---


### 由SigTool生成的簽名文件列表:
簽名文件 | 說明
---|---
clamav.hdb | 用於所有文件類型;它使用文件哈希。
clamav.htdb | 用於HTML文件;它使用HTML規範化數據。
clamav_regex.htdb | 用於HTML文件;它使用HTML規範化數據;簽名可以包含正則表達式。
clamav.mdb | 用於PE文件;它使用PE部分元數據。
clamav.ndb | 用於所有文件類型;它使用ANSI規範化數據。
clamav_regex.ndb | 用於所有文件類型;它使用ANSI規範化數據;簽名可以包含正則表達式。
clamav.db | 用於所有文件類型;它使用原始數據。
clamav_regex.db | 用於所有文件類型;它使用原始數據;簽名可以包含正則表達式。
clamav_elf.db | 用於ELF文件;它使用原始數據。
clamav_elf_regex.db | 用於ELF文件;它使用原始數據;簽名可以包含正則表達式。
clamav_email.db | 用於EML文件;它使用原始數據。
clamav_email_regex.db | 用於EML文件;它使用原始數據;簽名可以包含正則表達式。
clamav_exe.db | 用於PE文件;它使用原始數據。
clamav_exe_regex.db | 用於PE文件;它使用原始數據;簽名可以包含正則表達式。
clamav_graphics.db | 用於圖像文件;它使用原始數據。
clamav_graphics_regex.db | 用於圖像文件;它使用原始數據;簽名可以包含正則表達式。
clamav_java.db | 用於Java文件;它使用原始數據。
clamav_java_regex.db | 用於Java文件;它使用原始數據;簽名可以包含正則表達式。
clamav_macho.db | 用於Mach-O文件;它使用原始數據。
clamav_macho_regex.db | 用於Mach-O文件;它使用原始數據;簽名可以包含正則表達式。
clamav_ole.db | 用於OLE對象;它使用原始數據。
clamav_ole_regex.db | 用於OLE對象;它使用原始數據;簽名可以包含正則表達式。
clamav_pdf.db | 用於PDF文件;它使用原始數據。
clamav_pdf_regex.db | 用於PDF文件;它使用原始數據;簽名可以包含正則表達式。
clamav_swf.db | 用於SWF文件;它使用原始數據。
clamav_swf_regex.db | 用於SWF文件;它使用原始數據;簽名可以包含正則表達式。

---


### 關於簽名文件擴展名:
*這些信息將在未來擴大。*

- __cedb__: 複雜擴展簽名文件(這是為phpMussel創建的格式,並且與ClamAV簽名數據庫無關;​SigTool不使用此擴展名生成任何簽名文件;​這些是為`phpMussel/Signatures`存儲庫手動編寫的;​`clamav.cedb`包含了以前版本的ClamAV签名数据库中某些已弃用/过时修改的签名,​被认为对phpMussel具有持续的用处)。​基于由phpMussel生成的扩展元数据的各种规则的签名文件使用此扩展。
- __db__: 標準簽名文件(這些是從`daily.cvd``main.cvd`包含的`.ndb`簽名文件中提取的)。​這些簽名文件直接與文件內容一起工作。
- __fdb__: 文件名簽名文件(ClamAV签名数据库以前支持的文件名签名,但不再是;​SigTool不會使用此擴展名生成任何簽名文件;​因為它被認為對phpMussel是有用)。​這些簽名文件使用文件名。
- __hdb__: 哈希簽名文件(這些是從`daily.cvd``main.cvd`包含的`.hdb`簽名文件中提取的)。​這些簽名文件使用哈希。
- __htdb__: HTML簽名文件(這些是從`daily.cvd``main.cvd`包含的`.ndb`簽名文件中提取的)。​這些簽名文件使用HTML標準化內容。
- __mdb__: PE部分簽名文件(這些是從`daily.cvd``main.cvd`包含的`.mdb`簽名文件中提取的)。​這些簽名文件使用PE部分元數據。
- __medb__: PE擴展簽名文件(這是為phpMussel創建的格式,並且與ClamAV簽名數據庫無關;​SigTool不會使用此擴展名生成任何簽名文件;​這些是為`phpMussel/Signatures`存儲庫手動編寫的)。​這些簽名文件使用PE元數據(除了PE部分元數據)。
- __ndb__: 標準化簽名文件(這些是從`daily.cvd``main.cvd`包含的`.ndb`簽名文件中提取的)。​這些簽名文件使用ANSI標準化內容。
- __udb__: URL簽名文件(這是為phpMussel創建的格式,並且與ClamAV簽名數據庫無關;​SigTool目前不使用此擴展名生成任何簽名文件,但這可能會在將來發生變化;目前,這些是為`phpMussel/Signatures`存儲庫手動編寫的)。​這些簽名文件使用URL。
- __ldb__: 邏輯簽名文件(最終,為未來的SigTool版本,這些將從`.ldb`簽名文件中提取的,但SigTool或phpMussel尚不支持)。​這些簽名文件使用各種邏輯規則。


---


*最後更新:2017年9月16日。*
99 changes: 99 additions & 0 deletions _docs/readme.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
### 如何安装:

安装前请检查要求。​如果这些不符合,SigTool将无法正常运行。

#### 要求:
- PHP >= `7.0.3` 用zlib + Phar支持。
- >= 1GB可用磁盘空间(如果直接从磁盘工作)或可用RAM(如果使用RAM驱动器;推荐的)。
- 能够在CLI模式下操作PHP(命令提示符,终端,shell,等等)。

SigTool作为一个独立的PHP文件存在,没有任何外部依赖关系(除上述要求外),所以,您唯一需要做的“安装”它是下载`sigtool.php`

SigTool可以像任何其他PHP脚本从磁盘或存储介质一样运行。​但是,由于执行了大量的读/写操作,强烈建议您从RAM驱动器进行操作,因为这会稍微增加速度并减少多余的磁盘读/写操作。​最终输出不应超过约64MB,但在正常操作期间需要约1GB的可用磁盘空间或可用RAM由于临时工作文件和为了避免读/写错误。

---


### 如何使用:

请注意,SigTool不是基于PHP的网络应用程序(或“web-app”)!​SigTool是基于PHP的CLI应用程序(或“CLI-app”)旨在与终端,shell,等等一起使用。​可以通过使用`sigtool.php`文件作为第一个参数调用PHP二进制来调用它:

`$ php sigtool.php`

当调用SigTool时,将显示帮助信息,列出了在运行SigTool时可以使用的参数。

可以使用的参数:
- 没有参数:显示此帮助信息。
- `x`:从`daily.cvd`和`main.cvd'中提取签名文件。
- `p`:处理用于phpMussel的签名文件。
- `m`:在处理之前下载`main.cvd`
- `d`:在处理之前下载`daily.cvd`
- `u`:更新SigTool(重新`sigtool.php`下载然后die;没有检查执行).

产生的产出是各种phpMussel签名文件直接从ClamAV签名数据库生成,有两种形式:
- 可以直接插入在`/vault/signatures/`目录的签名文件。
- GZ压缩的签名文件副本,可用于更新`phpMussel/Signatures`存储库。

输出直接生成到与`sigtool.php`相同的目录中。​源文件和所有临时工作文件将在操作过程中被删除(所以,如果您想保留“daily.cvd”和“main.cvd”的副本,您应该在处理签名文件之前进行复制)。

如果`signatures.dat` YAML文件在处理时包含在同一目录中,版本信息和校验和将相应更新(所以,当使用SigTool于更新`phpMussel/Signatures`存储库,这应该包括在内)。

*注意:如果您是phpMussel用户,请记住,签名文件必须是“活性”以便正常工作!​如果您使用SigTool于生成新的签名文件,您可以通过在phpMussel配置“Active”指令中列出它们来“启用”它们。​如果您正在使用前端更新页面来安装和更新签名文件,您可以从前端更新页面直接“启用”他们。​但是,使用这两种方法是不必要的。​此外,为了最佳的phpMussel性能,建议您仅使用安装所需的签名文件(例如,如果某些特定类型的文件被列入黑名单,您可能不需要与该类型的文件相对应的签名文件;​分析将被阻止的文件是多余的工作,可以显着减慢扫描过程)。*

使用SigTool的视频演示在YouTube上可用: __[youtu.be/f2LfjY1HzRI](https://youtu.be/f2LfjY1HzRI)__

---


### 由SigTool生成的签名文件列表:
签名文件 | 说明
---|---
clamav.hdb | 用于所有文件类型;它使用文件哈希。
clamav.htdb | 用于HTML文件;它使用HTML规范化数据。
clamav_regex.htdb | 用于HTML文件;它使用HTML规范化数据;签名可以包含正则表达式。
clamav.mdb | 用于PE文件;它使用PE部分元数据。
clamav.ndb | 用于所有文件类型;它使用ANSI规范化数据。
clamav_regex.ndb | 用于所有文件类型;它使用ANSI规范化数据;签名可以包含正则表达式。
clamav.db | 用于所有文件类型;它使用原始数据。
clamav_regex.db | 用于所有文件类型;它使用原始数据;签名可以包含正则表达式。
clamav_elf.db | 用于ELF文件;它使用原始数据。
clamav_elf_regex.db | 用于ELF文件;它使用原始数据;签名可以包含正则表达式。
clamav_email.db | 用于EML文件;它使用原始数据。
clamav_email_regex.db | 用于EML文件;它使用原始数据;签名可以包含正则表达式。
clamav_exe.db | 用于PE文件;它使用原始数据。
clamav_exe_regex.db | 用于PE文件;它使用原始数据;签名可以包含正则表达式。
clamav_graphics.db | 用于图像文件;它使用原始数据。
clamav_graphics_regex.db | 用于图像文件;它使用原始数据;签名可以包含正则表达式。
clamav_java.db | 用于Java文件;它使用原始数据。
clamav_java_regex.db | 用于Java文件;它使用原始数据;签名可以包含正则表达式。
clamav_macho.db | 用于Mach-O文件;它使用原始数据。
clamav_macho_regex.db | 用于Mach-O文件;它使用原始数据;签名可以包含正则表达式。
clamav_ole.db | 用于OLE对象;它使用原始数据。
clamav_ole_regex.db | 用于OLE对象;它使用原始数据;签名可以包含正则表达式。
clamav_pdf.db | 用于PDF文件;它使用原始数据。
clamav_pdf_regex.db | 用于PDF文件;它使用原始数据;签名可以包含正则表达式。
clamav_swf.db | 用于SWF文件;它使用原始数据。
clamav_swf_regex.db | 用于SWF文件;它使用原始数据;签名可以包含正则表达式。

---


### 关于签名文件扩展名:
*这些信息将在未来扩大。*

- __cedb__: 复杂扩展签名文件(这是为phpMussel创建的格式,并且与ClamAV签名数据库无关;​SigTool不使用此扩展名生成任何签名文件;​这些是为`phpMussel/Signatures`存储库手动编写的;​`clamav.cedb`包含了以前版本的ClamAV签名数据库中某些已弃用/过时修改的签名,​被认为对phpMussel具有持续的用处)。​基于由phpMussel生成的扩展元数据的各种规则的签名文件使用此扩展。
- __db__: 标准签名文件(这些是从`daily.cvd``main.cvd`包含的`.ndb`签名文件中提取的)。​这些签名文件直接与文件内容一起工作。
- __fdb__: 文件名签名文件(ClamAV签名数据库以前支持的文件名签名,但不再是;​SigTool不会使用此扩展名生成任何签名文件;​因为它被认为对phpMussel是有用)。​这些签名文件使用文件名。
- __hdb__: 哈希签名文件(这些是从`daily.cvd``main.cvd`包含的`.hdb`签名文件中提取的)。​这些签名文件使用哈希。
- __htdb__: HTML签名文件(这些是从`daily.cvd``main.cvd`包含的`.ndb`签名文件中提取的)。​这些签名文件使用HTML标准化内容。
- __mdb__: PE部分签名文件(这些是从`daily.cvd``main.cvd`包含的`.mdb`签名文件中提取的)。​这些签名文件使用PE部分元数据。
- __medb__: PE扩展签名文件(这是为phpMussel创建的格式,并且与ClamAV签名数据库无关;​SigTool不会使用此扩展名生成任何签名文件;​这些是为`phpMussel/Signatures`存储库手动编写的)。​这些签名文件使用PE元数据(除了PE部分元数据)。
- __ndb__: 标准化签名文件(这些是从`daily.cvd``main.cvd`包含的`.ndb`签名文件中提取的)。​这些签名文件使用ANSI标准化内容。
- __udb__: URL签名文件(这是为phpMussel创建的格式,并且与ClamAV签名数据库无关;​SigTool目前不使用此扩展名生成任何签名文件,但这可能会在将来发生变化;目前,这些是为`phpMussel/Signatures`存储库手动编写的)。​这些签名文件使用URL。
- __ldb__: 逻辑签名文件(最终,为未来的SigTool版本,这些将从`.ldb`签名文件中提取的,但SigTool或phpMussel尚不支持)。​这些签名文件使用各种逻辑规则。


---


*最后更新:2017年9月16日。*

0 comments on commit 4a567dc

Please sign in to comment.