Files
dip-ids/docs/user-guide.md
T
2026-04-12 22:26:26 +04:00

109 lines
5.0 KiB
Markdown

# Руководство пользователя
## Интерфейс веб-панели
Панель управления доступна по адресу `http://localhost:3000` после запуска фронтенда.
### Боковое меню
| Пункт | Страница | Описание |
|-------|----------|----------|
| Обзор | `/` | Дашборд с метриками и графиками |
| Алерты | `/alerts` | Журнал всех обнаруженных угроз |
| Захват | `/capture` | Управление захватом трафика |
| Статистика | `/stats` | Детальные графики и сводные таблицы |
В нижней части меню — индикатор состояния захвата (зелёный пульс = активен).
---
## Страница «Обзор» (Dashboard)
Главная страница отображает:
**Карточки метрик** — количество алертов по уровню критичности:
- Критический (красный)
- Высокий (оранжевый)
- Средний (жёлтый)
- Низкий (зелёный)
**График «Алерты за 24 часа»** — временная шкала событий с часовой детализацией.
**Диаграмма «Типы атак»** — donut-чарт с распределением по типам угроз.
**Топ источников** — 5 наиболее активных IP-адресов с прогресс-барами.
**Последние инциденты** — 8 последних алертов с описанием. Данные обновляются автоматически каждые 10 секунд.
---
## Страница «Алерты»
### Фильтрация
- **Тип атаки** — Port Scan, Brute Force, DoS/DDoS, ARP Spoof, DNS Anomaly
- **Критичность** — критический, высокий, средний, низкий
- **IP источника** — фильтр по точному совпадению
Нажмите **Найти** для применения фильтров, **Сбросить** — для очистки.
### Таблица алертов
Колонки: Время · Критичность · Тип · Источник · Назначение · Описание
- **Страница** — 25 записей, навигация внизу таблицы
- **Удалить алерт** — кнопка с иконкой корзины в строке
- **Очистить всё** — удаляет все алерты из БД (необратимо)
---
## Страница «Захват»
### Live захват
1. Выберите сетевой интерфейс из выпадающего списка (кнопка ↺ обновляет список)
2. Нажмите **Начать захват**
3. Бэкенд должен быть запущен с правами root (`sudo ./nids`)
4. Для остановки — кнопка **Остановить захват** (в заголовке или на странице)
### Анализ PCAP файла
1. Перейдите на вкладку **PCAP файл**
2. Перетащите `.pcap` или `.pcapng` файл в зону загрузки (или нажмите «Выбрать файл»)
3. Нажмите **Анализировать**
4. После завершения алерты появятся в журнале
### История сессий
Таблица последних 20 сессий захвата: источник, режим, статус, количество пакетов, объём трафика.
---
## Страница «Статистика»
### Период наблюдения
Кнопки: **6ч · 24ч · 2д · 7д** — переключают временной диапазон для всех графиков.
### Графики
- **Динамика алертов** — столбчатая диаграмма по часам
- **По типам атак** — donut с легендой
- **По критичности** — donut с легендой
- **Топ-10 источников** — горизонтальная столбчатая диаграмма
### Сводная таблица
Итоговые числа по критичности и типам атак, общее количество.
---
## Генерация PDF-отчёта
Кнопка **PDF отчёт** доступна в заголовке на любой странице.
Отчёт содержит:
1. Заголовок с датой формирования
2. Метаданные последней сессии
3. Сводку по критичности
4. Таблицу типов угроз
5. Топ-10 источников атак
6. Журнал инцидентов (до 200 записей)
Файл сохраняется как `nids-report-YYYY-MM-DD_HH-MM.pdf`.