Вивисекция пакетов. Пример

[teplofizik]

Вивисекция пакетов

Описание протокола заключено в двух файлах, которые мы создадим с нуля:
protocol_name.wsgd - здесь указывается, какие порты нам нужны, название вивисектора, имя второго файла со структурой и т.д;
protocol_name.fdesc - здесь уже разбирается протокол, производится выбор типа пакетов и вывод в wireshark.

Первым делом надо бы создать фильтр и название нашего протокола, который будем разбирать. Создадим пустой файл nyaproto.wsgd и поместим его в ту же папку, куда зашвырнули плагин.
Там его и будем редактировать. Напишем описание согласно документации:

# Комментарии начинаются с решётки

# Название протокола
PROTONAME                              Nya Protocol
PROTOSHORTNAME                         NYA
PROTOABBREV                            nya

# фильтр wireshark, по которому отбираем нужные нам пакеты
# Пропускает по совпадению с правилом, таких записей может быть много
# Вариантов море: http://wsgd.free.fr/wsgd_format_PARENT_SUBFIELD_more_info.txt
PARENT_SUBFIELD                        udp.port
PARENT_SUBFIELD_VALUES                 12345

PARENT_SUBFIELD                        udp.port
PARENT_SUBFIELD_VALUES                 12346

# Дальше описываем, в каких структурах во втором файле что находится

# Обработка заголовка, просмотр его тип, расчёт размера и так далее, что пожелается
# Любой пакет должен начинаться с заголовка, чтоб можно определить, что же в нём содержится
# Структура, указанная здесь, должна содержать в себе поля, указанные в MSG_ID_FIELD_NAME 
# и любом MSG_SUMMARY_SUBSIDIARY_FIELD_NAMES.
MSG_HEADER_TYPE                        T_packet_header_type

# Поле, по которому отличаем тип сообщений (см. структуру)
# Должен быть частью структуры, указанной в MSG_HEADER_TYPE.
MSG_ID_FIELD_NAME                      command

# Выбиратор типа сообщения на основании какого-то поля
MSG_MAIN_TYPE                          T_packet_switch(command)

# Далее идёт описание структур и их обработка
PROTO_TYPE_DEFINITIONS

# Загрузим их из второго файла
include                                nyaproto.fdesc ;

Как-то так, есть ещё ряд украшательств, но фиг с ними.
Теперь напишем минимально допустимое описание протокола. Что же минимально необходимо?
1. Описание кодов, по которым определяется тип сообщения;
2. Структура-определятор значения этого поля в пакете;
3. Описание полей для их показа для всех необходимых нам сообщений;
4. Выбиратор типа сообщения в зависимости от значения этого поля для его показа.

Не надо удивляться, что код здесь пишется не только в функциях, но и в структурах.
Итак, nyaproto.fdesc:

# Описание протокола NYA Protocol

# Перечислим типы команд/ответов и их коды
# enum8 говорит, что это перечисляемое поле занимает один байт в пакете
enum8 T_nya_command
{
	# Запрос кота
	KISKIS                  0x00 # Кис-кис
	JRATIDI                 0x01 # Жрать иди

	# Разные пакеты ответов в зависимости от текущего состояния запрашиваемого
	NYA                     0x10 # Ня, нейтральный ответ
	MURMUR                  0x11 # Мур-мур, положительный ответ

	PSHH                    0xFF # Error
}

# Структура, которая будет получать содержимое поля, содержащего код пакета
# Помним, мы её в MSG_HEADER_TYPE обозвали как T_packet_header_type
# Это описание структуры наложится на данные UDP-пакета и поля примут какие-то осмысленные значения
# Структура чисто внутрення и нужна для разбора пакета
struct T_packet_header_type
{
	uint8         start_code; # Стартовый код, он нам не интересен, хотя можно и проверить
	T_nya_command command;    # Код команды
	uint16        length;     # Длина пакета, не включая заголовок
	
	# Дальше все паеты разные, так что фиг с ними, всё важное уже вытащили
	
	# Здесь можно объявлять всякие разные переменные, которые потом везде использовать
	# Например, запомним длину пакета, включая заголовок (1 + 1 + 2 байта)
	var uint16    size = length + 4;
}

# Теперь опишем все пакеты так, как они будут показаны в wireshark

# Заголовок
struct T_nya_header
{
	uint8         start_code; # Стартовый код
	T_nya_command command;
	uint16        length;
}

# Сообщение "Кис-кис" с запросом состояния
struct T_nya_KISKIS_request
{
	T_nya_header header; # Пакет начинается с заголовка

	uint8         request_type; # Зачем нам нужен кот: играть, мацать, скормить и т.д.
}

# Сообщение "Жрать иди" с указанием типа корма и его количества
struct T_nya_JRATIDI_request
{
	T_nya_header header;

	uint8         food_type; # что кушать

	uint8         count;     # количество, шт
}

# Ответ кота "Мур"
struct T_nya_MURMUR_response
{
	T_nya_header header;

	uint32        murmurlevel; # Уровень замурчательности кота
}

# Ответ кота "мяу"
struct T_nya_NYA_response
{
	T_nya_header header;

	uint8         action;      # чем занят кот
}

# Ответ кота "пшшшшш"
struct T_nya_PSHH_response
{
	T_nya_header header;

	uint8         errno;       # что коту не понравилось в ваших действиях
}

# Выбиратор типа сообщения
# Передаётся один аргумент типа T_nya_command (см. MSG_MAIN_TYPE)
# Не забываем ставить пробелы вокруг двоеточий, а то атата
switch T_packet_switch T_nya_command
{
case T_nya_command::KISKIS  : T_nya_KISKIS_request "" ;
case T_nya_command::JRATIDI : T_nya_JRATIDI_request "" ;

case T_nya_command::NYA     : T_nya_NYA_response "" ;
case T_nya_command::MURMUR  : T_nya_MURMUR_response "" ;
case T_nya_command::PSHH    : T_nya_PSHH_response "" ;
}

Если эти файлы поместить к плагину под бочок, то после запуска (если не выскочит никаких ошибок интерпретации) в Internals->Supported protocols появится и наш Nya protocol.
Дальше подробнее посмотрим, что и как надо ему писать, чтобы он всё понял, как украсить вывод и проверить в деле.

Для копипасты:
nyaproto.wsgd
nyaproto.fdesc

1. Введение;
2. Пример;
3. Типы данных и выбиратор.
...