Skip to content

Commit 18d744e

Browse files
committed
Documentation update.
1 parent 8bcaaf2 commit 18d744e

File tree

2 files changed

+107
-3
lines changed

2 files changed

+107
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
[![Join the chat at https://gitter.im/phpMussel2/Lobby](https://badges.gitter.im/phpMussel2/Lobby.svg)](https://gitter.im/phpMussel2/Lobby)
2-
[![PHP >= 7.0.0](https://img.shields.io/badge/PHP-%3E%3D%207.0.0-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
2+
[![PHP >= 7.0.3](https://img.shields.io/badge/PHP-%3E%3D%207.0.0-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
33
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
44
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](http://makeapullrequest.com)
55

66
## SigTool.
7-
Generates signatures for [phpMussel](https://github.com/phpMussel/phpMussel) using main.cvd and daily.cvd from [ClamAV](https://www.clamav.net/).
7+
Generates signatures for **[phpMussel](https://github.com/phpMussel/phpMussel)** using `main.cvd` and `daily.cvd` from **[ClamAV](https://www.clamav.net/)**.
88

99
---
1010

11+
1112
### How to install:
1213

1314
Before installing, please check the requirements. If these aren't met, SigTool won't operate correctly.
@@ -23,6 +24,7 @@ SigTool can operate normally from a disk or storage medium in the same manner as
2324

2425
---
2526

27+
2628
### How to use:
2729

2830
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:
@@ -35,6 +37,7 @@ More information can be found in the documentation herein.
3537

3638
---
3739

40+
3841
### Documentation:
3942
- **[English](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.en.md)**
4043
- **[Deutsch](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.de.md)**
@@ -44,10 +47,12 @@ More information can be found in the documentation herein.
4447
- **[Italiano](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.it.md)**
4548
- **[Nederlandse](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.nl.md)**
4649
- **[Português](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.pt.md)**
50+
- **[Русский](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ru.md)**
4751
- **[Tiếng Việt](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.vi.md)**
4852
- **[中文(简体)](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.zh.md)**
4953
- **[中文(傳統)](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.zh-tw.md)**
5054

5155
---
5256

53-
*Last modified: 23 December 2018 (2018.12.23).*
57+
58+
Last Updated: 23 December 2018 (2018.12.23).

_docs/readme.ru.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
### Как установить:
2+
3+
Перед установкой, пожалуйста, проверьте требования. Если они не выполнены, SigTool не будет работать правильно.
4+
5+
#### Требования:
6+
- PHP >= `7.0.3` с поддержкой zlib + Phar.
7+
- >= 1ГБ свободного места на диске (если работает прямо с диска) или доступной ОЗУ (при использовании виртуальный оперативный диск; рекомендуемые).
8+
- Возможность работы PHP в CLI-режиме (командная строка, терминал, оболочка, и т.д.).
9+
10+
SigTool существует как самостоятельный PHP-файл и не имеет внешних зависимостей (кроме требований, перечисленных выше), и единственное, что вам нужно сделать, чтобы «установить» его: Загрузить файл `sigtool.php`.
11+
12+
SigTool может нормально работать с диска или носителя информации так же, как и любой другой скрипт PHP. Однако из-за большого количества операций чтения/записи он выполняет, настоятельно рекомендуется использовать его с ОЗУ, поскольку это немного увеличит его скорость и уменьшит избыточные операции чтения/записи на диске. Конечный результат не должен превышать ~64МБ, но приблизительно ~1ГБ свободного дискового пространства или доступной ОЗУ требуется во время нормальной работы из-за временных рабочих файлов и во избежание ошибок чтения/записи.
13+
14+
---
15+
16+
17+
### Как пользоваться:
18+
19+
Обратите внимание, что SigTool НЕ является веб-приложением! SigTool является CLI-приложение, предназначенное для использования с терминалом, оболочкой, и т.д. Его можно вызвать, вызвав двоичный файл PHP с файлом `sigtool.php` в качестве первого аргумента:
20+
21+
`$ php sigtool.php`
22+
23+
Справочная информация будет отображаться при вызове SigTool с указанием возможных флагов (второй аргумент), которые можно использовать при работе с SigTool.
24+
25+
Возможных флагов:
26+
- Без аргументов: Показать эту справочную информацию.
27+
- `x`: Извлечь файлы сигнатуры из `daily.cvd` и `main.cvd`.
28+
- `p`: Обрабатывать файлы сигнатур для использования с phpMussel.
29+
- `m`: Скачайте `main.cvd` перед обработкой.
30+
- `d`: Скачайте `daily.cvd` перед обработкой.
31+
- `u`: Обновление SigTool (загрузите `sigtool.php` заново и умирает; проверки не выполняются).
32+
33+
В результате получаются различные файлы сигнатур phpMussel, созданные непосредственно из базы данных сигнатур ClamAV, в двух формах:
34+
- Файлы сигнатуры, которые можно вставить непосредственно в каталог `/vault/signatures/`.
35+
- GZ-сжатые копии файлов сигнатур, которые можно использовать для обновления репозитория `phpMussel/Signatures`.
36+
37+
Файлы создаются непосредственно в том же каталоге, что и `sigtool.php`. Исходные файлы и все временные рабочие файлы будут удалены в процессе работы (поэтому, если вы хотите сохранить копии `daily.cvd` и `main.cvd`, вы должны сделать копии перед обработкой файлов сигнатуры).
38+
39+
Если при обработке файл YAML `signatures.dat` включен в тот же каталог, информация о версии и контрольные суммы будут обновлены соответственно (поэтому, при использовании SigTool для обновления репозитория `phpMussel/Signatures`, это должно быть включено).
40+
41+
*Примечание: Если вы являетесь пользователем phpMussel, помните, что файлы сигнатурей должны быть АКТИВНЫМИ, чтобы они работали правильно! Если вы используете SigTool для создания новых файлов сигнатур, вы можете «активировать» их, перечислив в директиве «Active» конфигурации phpMussel. Если вы используете страницу обновлений фронтенда для установки и обновления файлов сигнатур, вы можете «активировать» их непосредственно со страницы обновлений фронтенда. Однако использовать оба метода не обязательно. Кроме того, для оптимальной производительности, рекомендуется использовать только те файлы сигнатур, которые необходимы для вашей установки (например, если какой-то конкретный тип файла занесен в черный список, вам вероятно не понадобятся файлы сигнатуры, соответствующие этому типу; анализ файлов, которые все равно будут заблокированы, является излишней работой и может значительно замедлить процесс сканирования).*
42+
43+
Видео демонстрация использования SigTool доступна на YouTube: __[youtu.be/f2LfjY1HzRI](https://youtu.be/f2LfjY1HzRI)__
44+
45+
---
46+
47+
48+
### Список сгенерированных SigTool файлов сигнатурей:
49+
Файл сигнатуры | Описание
50+
---|---
51+
clamav.hdb | Предназначен для всех типов файлов; Работает с файловыми хешами.
52+
clamav.htdb | Предназначен для HTML файлов; Работает с нормализованными HTML-данными.
53+
clamav_regex.htdb | Предназначен для HTML файлов; Работает с нормализованными HTML-данными; Сигнатуры могут содержать регулярные выражения.
54+
clamav.mdb | Предназначен для PE файлов; Работает с секционными метаданными PE.
55+
clamav.ndb | Предназначен для всех типов файлов; Работает с нормализованными ANSI-данными.
56+
clamav_regex.ndb | Предназначен для всех типов файлов; Работает с нормализованными ANSI-данными; Сигнатуры могут содержать регулярные выражения.
57+
clamav.db | Предназначен для всех типов файлов; Работает с необработанными данными.
58+
clamav_regex.db | Предназначен для всех типов файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
59+
clamav_elf.db | Предназначен для ELF файлов; Работает с необработанными данными.
60+
clamav_elf_regex.db | Предназначен для ELF файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
61+
clamav_email.db | Предназначен для EML файлов; Работает с необработанными данными.
62+
clamav_email_regex.db | Предназначен для EML файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
63+
clamav_exe.db | Предназначен для PE файлов; Работает с необработанными данными.
64+
clamav_exe_regex.db | Предназначен для PE файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
65+
clamav_graphics.db | Предназначен для файлов изображений; Работает с необработанными данными.
66+
clamav_graphics_regex.db | Предназначен для файлов изображений; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
67+
clamav_java.db | Предназначен для Java файлов; Работает с необработанными данными.
68+
clamav_java_regex.db | Предназначен для Java файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
69+
clamav_macho.db | Предназначен для Mach-O файлов; Работает с необработанными данными.
70+
clamav_macho_regex.db | Предназначен для Mach-O файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
71+
clamav_ole.db | Предназначен для объектов OLE; Работает с необработанными данными.
72+
clamav_ole_regex.db | Предназначен для объектов OLE; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
73+
clamav_pdf.db | Предназначен для PDF файлов; Работает с необработанными данными.
74+
clamav_pdf_regex.db | Предназначен для PDF файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
75+
clamav_swf.db | Предназначен для SWF файлов; Работает с необработанными данными.
76+
clamav_swf_regex.db | Предназначен для SWF файлов; Работает с необработанными данными; Сигнатуры могут содержать регулярные выражения.
77+
78+
---
79+
80+
81+
### Примечание относительно расширения файла сигнатуры:
82+
*Эта информация будет расширена в будущем.*
83+
84+
- __cedb__: Сложные расширенные файлы сигнатуры (это домашний формат, созданный для phpMussel и не имеющий отношения к базе данных сигнатур ClamAV; SigTool не создает никаких файлов сигнатуры с использованием этого расширения; они написаны вручную для репозитория `phpMussel/Signatures`; `clamav.cedb` содержит адаптации некоторых устаревших сигнатур из предыдущих версий базы данных сигнатур ClamAV, которые, как считается, все еще сохраняют свою полезность для phpMussel). Файлы сигнатур, которые работают с различными правилами на основе расширенных метаданных, сгенерированных phpMussel, используют это расширение.
85+
- __db__: Стандартные файлы сигнатуры (они извлекаются из файлов сигнатур `.ndb`, содержащихся в `daily.cvd` и `main.cvd`). Файлы сигнатуры, которые работают напрямую с содержимым файлов, используют это расширение.
86+
- __fdb__: Сигнатуры для имена файлов (база данных сигнатур ClamAV ранее поддерживала сигнатуры имя файлов, но больше не поддерживает; SigTool не создает никаких файлов сигнатуры с использованием этого расширения; поддерживается благодаря постоянной полезности для phpMussel). Файлы сигнатуры, которые работают с именами файлов, используют это расширение.
87+
- __hdb__: Сигнатуры для хэши файлов (они извлекаются из файлов сигнатур `.hdb`, содержащихся в `daily.cvd` и `main.cvd`). Файлы сигнатуры, которые работают с файловыми хешами, используют это расширение.
88+
- __htdb__: Сигнатуры для файлов HTML (они извлекаются из файлов сигнатур `.ndb`, содержащихся в `daily.cvd` и `main.cvd`). Файлы сигнатуры, которые работают с нормализованным HTML-контентом, используют это расширение.
89+
- __mdb__: Файлы сигнатуры для секций PE (они извлекаются из файлов сигнатур `.mdb`, содержащихся в `daily.cvd` и `main.cvd`). Файлы сигнатуры, которые работают с секционными метаданными PE, используют это расширение.
90+
- __medb__: Файлы сигнатур расширенные PE (это домашний формат, созданный для phpMussel и не имеющий отношения к базе данных сигнатур ClamAV; SigTool не создает никаких файлов сигнатуры с использованием этого расширения; они написаны вручную для репозитория `phpMussel/Signatures`). Файлы сигнатуры, которые работают с метаданными PE (кроме метаданных секций PE), используют это расширение.
91+
- __ndb__: Нормализованные файлы сигнатуры (они извлекаются из файлов сигнатур `.ndb`, содержащихся в `daily.cvd` и `main.cvd`). Файлы сигнатуры, которые работают с нормализованным ANSI-контентом, используют это расширение.
92+
- __udb__: Файлы сигнатуры URL (это домашний формат, созданный для phpMussel и не имеющий отношения к базе данных сигнатур ClamAV; *В настоящее время* SigTool не создает никаких файлов сигнатуры с использованием этого расширения, хотя это может измениться в будущем; В настоящее время, они написаны вручную для репозитория `phpMussel/Signatures`). Файлы сигнатуры, которые работают с URL, используют это расширение.
93+
- __ldb__: Файлы логической сигнатуры (однажды, для будущей версии SigTool, они будут извлечены из файлов сигнатур `.ldb`, содержащихся в `daily.cvd` и `main.cvd`, но это еще не поддерживается SigTool или phpMussel). Файлы сигнатуры, которые работают с различными логическими правилами, используют это расширение.
94+
95+
96+
---
97+
98+
99+
Последнее обновление: 24 Декабрь 2018 (2018.12.24).

0 commit comments

Comments
 (0)