Update info about processing

Author: Mishechkin Max

Plugins/PostProcessing/config.json

@@ -6,28 +6,43 @@
 Для использования пользовательского плагина пост-обработки данных необходимо выполнить следующие действия:
 1. написать плагин;
 2. добавить плагин в конфиг-файл для запуска `Crusher` (опционально);
-3. запустить `Crusher`: с конфиг-файлом или с опцией `--post-processing`.
+3. запустить `Crusher`: с конфиг-файлом или с опцией `--processing`.
 
-### 1. Написание плагина
+### 1. Написание плагина processing модуля
 Плагин представляет из себя `.py` файл со следующими необходимыми компонентами:
 * функция инициализации `initialization()`;
-* класс пост-обработки.
+* класс обработки данных в дальнейщем processing.
 
 #### Функция `initialization()`
-Функция `initialization()` возвращает класс пост-обработки, реализованный в плагине.
+Функция `initialization()` возвращает класс , реализованный в плагине.
 
 Пример функции `initialization()`:
 
 ```python
 def initialization():
-    return PostProcess
+    return Processing
 ```
 
-#### Класс пост-обработки
+#### Класс модуля processing
 Имя класса должно соответствовать тому, что возвращает функция `initialization`.
 
-##### Метод пост-обработки
-В классе необходимо релизовать метод `post_processing`, который принимает в качестве аргумента массив байт (`bytearray`) - буфер, который передаёт ядро `Crusher` для мутаций, и возвращает также массив байт.
+##### Метод пред-обработки модуля processing
+
+В классе можно релизовать метод `pre_processing`, который принимает в качестве аргумента массив байт (`bytearray`) - 
+буфер с начальными входными данными, который передаёт ядро `Crusher` для мутаций, и возвращает также массив байт.
+
+Данный метод должен обязательно содержать следующий код (для правильной его инициализации в `Crusher`):
+```python
+def pre_processing(self, data=None):
+    if data is None:
+        return 42
+```
+
+Предполагается, что в остальной части тела метода проводятся манипуляции над `data` и возвращается новый массив байт.
+Однако, использование `data` не является обязательным.
+
+##### Метод пост-обработки модуля processing
+В классе можно релизовать метод `post_processing`, который принимает в качестве аргумента массив байт (`bytearray`) - буфер, который передаёт ядро `Crusher` для мутаций, и возвращает также массив байт.
 
 Данный метод должен обязательно содержать следующий код (для правильной его инициализации в `Crusher`):
 ```python
@@ -39,14 +54,16 @@ def post_processing(self, data=None):
 Предполагается, что в остальной части тела метода проводятся манипуляции над `data` и возвращается новый массив байт.
 Однако, использование `data` не является обязательным.
 
-### 2. Добавление пост-обработчика в конфиг-файл для `Crusher`
+### 2. Добавление модуля processing в конфиг-файл для `Crusher`
 Конфиг-файл для `Crusher` (наряду с аргументами командной строки) позволяет более тонко настраивать его работу. Используется формат `JSON`.
 
-Для использования нового скрипта пост-обработки при фаззинге нужно добавить полный путь к нему в поле `"post-processing"` в конфиг-файле.
+Для использования нового модуля processing при фаззинге нужно добавить полный путь к нему в поле `"processing"` в конфиг-файле.
 
 Важно помнить, что в директориях `queue` внутри директории с результатами работы фаззера будут храниться данные до пост-обработки.
-Т.е. для воспроизведения, например, запусков с некоторыми тесткейсами из `queue`, над данными из соответствующих директорий нужно произвести преобразования из метода `post_processing` и только после этого подать на вход приложению.
-Дело в том, что после пост-обработки размер файла может заметно вырасти, например, после добавления множества заголовков. Чтобы избежать нерационального использования дискового пространства, файлы в `queue` записываются без пост-обработки.
+Т.е. для воспроизведения, например, запусков с некоторыми тесткейсами из `queue`, над данными из соответствующих директорий 
+нужно произвести преобразования из метода `post_processing` и только после этого подать на вход приложению.
+Дело в том, что после пост-обработки размер файла может заметно вырасти, например, после добавления множества заголовков. 
+Чтобы избежать нерационального использования дискового пространства, файлы в `queue` записываются без пост-обработки.
 
 При этом в директориях `crashes` и `hangs` записаны файлы уже после пост-обработки, на которых можно воспроизвести креши/зависания приложения без дополнительных преобразований.
 Крешей и зависаний обычно на порядки меньше (если они вообще есть), чем путей, поэтому они занимают меньше места на диске.
@@ -55,23 +72,23 @@ def post_processing(self, data=None):
 Пример конфиг-файла:
 ```json
 {
-	"post-processing": "/path/to/post-proc.py"
+	"processing": "/path/to/processing.py"
 }
 ```
 
 ### 3. Запуск `Crusher`
-Пример запуска `Crusher` с пользовательским скриптом пост-обработки, где [config.json](config.json) - конфиг-файл:
+Пример запуска `Crusher` с пользовательским скриптом модуля processing, где [config.json](config.json) - конфиг-файл:
 ```shell script
 /path/to/crusher/bin_x86-64/fuzz_manager --start 4 -i in -o out --config-file config.json -- ./test @@
 ```
 
-Также можно запустить `Crusher` со скриптом пост-обработки и без конфиг-файла.
-Для этого в командной строке нужно использовать опцию `--post-processing`, передавая ей в качестве аргумента путь до скрипта пост-обработки:
+Аналогично можно запустить `Crusher` со скриптом модуля processing и без конфиг-файла.
+Для этого в командной строке нужно использовать опцию `processing`, передавая ей в качестве аргумента путь до скрипта пост-обработки:
 
 ```shell script
-/path/to/crusher/bin_x86-64/fuzz_manager --start 4 -i in -o out --post-processing post-proc.py -- ./test @@
+/path/to/crusher/bin_x86-64/fuzz_manager --start 4 -i in -o out --processing processing processing.py -- ./test @@
 ```
 
-Пример скрипта пост-обработки - [post-proc.py](post-proc.py).
+Пример скрипта модуля processing - [processing.py](processing.py).
 
 Пример конфиг-файла - файл [config.json](config.json).

Plugins/PostProcessing/post-proc.py

@@ -0,0 +1,3 @@
+{
+	"processing": "/path/to/post-proc.py"
+}

Plugins/PostProcessing/README.md Plugins/Processing/README.mdPlugins/PostProcessing/README.md renamed to Plugins/Processing/README.md

@@ -0,0 +1,25 @@
+"""
+Simple post-processing script for just add header
+"""
+
+class Processing:
+    def __init__(self):
+        self.open_processing = bytearray("[processing]")
+        self.close_processing = bytearray("[/processing]")
+
+    def pre_processing(self, data=None):
+        if data is None:
+            return 42
+        data.replace(self.open_processing, "")
+        data.replace(self.close_processing, "")
+        return data
+
+    def post_processing(self, data=None):
+        if data is None:
+            return 42
+        data_end = self.open_processing + bytearray(data) + self.close_processing
+        return data_end
+
+
+def initialization():
+    return Processing