diff --git a/README.md b/README.md index a57557e..8e8d661 100755 --- a/README.md +++ b/README.md @@ -198,6 +198,9 @@ Markdown-отчет собирает главный вывод, риски по extensions и future-направления без создания новых API или фиктивных collectors. +Модульная схема комплекса с GitHub/Gitea-viewable Mermaid-графами: +[docs/MODULE_ARCHITECTURE_GRAPH_RU.md](docs/MODULE_ARCHITECTURE_GRAPH_RU.md). + ## Если дашборд пустой Обычно это значит одно из трех: выбран слишком узкий период времени, рабочий компьютер давно не присылал события или временно не обновилась витрина в Grafana. Начните с периода `Last 24 hours`, затем переходите к техническим разделам ниже. @@ -359,6 +362,7 @@ collectors. - [Сторонние компоненты](THIRD_PARTY_COMPONENTS.md) - [Сторонние лицензии](THIRD_PARTY_LICENSES_RU.md) - [Архитектура](docs/ARCHITECTURE_RU.md) +- [Модульная схема комплекса](docs/MODULE_ARCHITECTURE_GRAPH_RU.md) - [Установка](docs/INSTALL_RU.md) - [Руководство администратора](docs/ADMIN_GUIDE_RU.md) - [Руководство оператора](docs/OPERATOR_GUIDE_RU.md) diff --git a/docs/MODULE_ARCHITECTURE_GRAPH_RU.md b/docs/MODULE_ARCHITECTURE_GRAPH_RU.md new file mode 100644 index 0000000..cea422e --- /dev/null +++ b/docs/MODULE_ARCHITECTURE_GRAPH_RU.md @@ -0,0 +1,270 @@ +# AWatch-rus / DetMir: модульная схема комплекса + +Статус: операторская архитектурная карта для просмотра прямо в GitHub/Gitea. + +Документ описывает, как связаны основные модули AWatch-rus / DetMir, где +проходят данные и где администратор видит результат. Диаграммы выполнены в +Mermaid: GitHub и Gitea отображают их непосредственно на странице Markdown. + +## 1. Границы и честные утверждения + +- AWatch-rus / DetMir не заявляется как сертифицированная СЗИ, DLP, SIEM, EDR + или XDR. +- GitHub Actions и GitHub issues используются как публичная инженерная + видимость и mirror validation, а не как evidence российского release-контура. +- Основной российский контур поставки и контроля: private Gitea плюс + планируемый российский build-runner. +- Текущий production-профиль DetMir держит тяжелый DLP runtime отключенным для + снижения нагрузки на Proxmox, InfluxDB, Grafana, ClickHouse и AW server. + DLP-модуль не удален и может быть подключен отдельно после решения оператора. +- Hayabusa/Sigma и Velociraptor используются как слой findings/forensics. Они не + входят в горячий путь расчета рабочего времени и не должны запускать + блокировку рабочих станций без явного approval. + +## 2. Карта модулей верхнего уровня + +```mermaid +flowchart LR + subgraph endpoints["Рабочие места и RDP"] + RDP["RDP host
192.168.100.19
logical host SHARKON2025"] + WinCollectors["Windows collectors
window, AFK, browser, worktime"] + File1C["File1C upload task
каждые 15 минут"] + OptionalDlpEndpoint["Optional DLP endpoint sync
обычно disabled"] + end + + subgraph awserver["AW server 10.10.10.13"] + AwServer["ActivityWatch server
порт 5600"] + AwBuckets["AW buckets
SQLite datastore"] + WorktimeApi["aw-worktime-api
порт 5610"] + InfluxExporter["worktime Influx exporter"] + Healthd["aw-rus-healthd
readiness and checks"] + end + + subgraph analytics["Analytics and dashboards"] + Influx["InfluxDB
10.10.10.10:8086"] + Grafana["Grafana
10.10.10.11:3000"] + ClickHouse["ClickHouse
10.10.10.2:8123"] + Portal["DetMir portal and gateway
10.10.10.2:8720
/portal"] + end + + subgraph security["Security findings and containment"] + Hayabusa["Hayabusa / Sigma
EVTX and rule findings"] + Velociraptor["Velociraptor
offline collector or explicit server mode"] + Inbox["Security Finding Inbox
ClickHouse-backed"] + Executor["Containment executor
plan / apply / verify / rollback"] + end + + subgraph governance["Governance and delivery"] + GitHub["GitHub public mirror
PR checks and ruleset"] + Gitea["Russian Gitea
primary private contour"] + BuildRunner["Russian build-runner
planned registry evidence"] + end + + RDP --> WinCollectors + WinCollectors --> AwServer + AwServer --> AwBuckets + AwBuckets --> WorktimeApi + WorktimeApi --> Portal + WorktimeApi --> InfluxExporter + InfluxExporter --> Influx + Influx --> Grafana + Grafana --> Portal + File1C --> ClickHouse + ClickHouse --> Portal + ClickHouse --> Grafana + Healthd --> Portal + + Hayabusa --> Inbox + Velociraptor --> Inbox + OptionalDlpEndpoint -. optional .-> Inbox + Inbox --> Portal + Portal --> Executor + Executor --> Inbox + + GitHub --> Gitea + Gitea --> BuildRunner +``` + +## 3. Основные модули + +| Модуль | Где работает | Что делает | Куда пишет/отдает | +|---|---|---|---| +| Windows collectors | RDP/Windows hosts | Собирают окна, AFK, браузерные домены, рабочие сессии | ActivityWatch API | +| ActivityWatch server | `10.10.10.13:5600` | Принимает события и хранит buckets | SQLite datastore, HTTP API | +| Worktime API | `10.10.10.13:5610` | Строит отчеты рабочего времени и management-срез | Portal, Influx exporter | +| Influx exporter | AW server | Перекладывает рабочие метрики во временные ряды | InfluxDB | +| InfluxDB | `10.10.10.10:8086` | Хранит time-series для Grafana | Grafana | +| Grafana | `10.10.10.11:3000` | Показывает dashboards по активности, дисциплине и состоянию | Администратор, portal links | +| DetMir portal | `10.10.10.2:8720/portal` | Единая витрина: статус, workforce, security inbox, ссылки | Browser UI/API | +| ClickHouse File1C | `10.10.10.2:8123` | Хранит 1C/file telemetry и security findings | Portal, Grafana, manager API | +| Security Finding Inbox | ClickHouse + Rust CLI/API | Нормализует подозрительные станции и workflow | Portal, executor, audit | +| Hayabusa/Sigma | AW server / security host | Разбирает Windows EVTX и Sigma-compatible findings | Inbox | +| Velociraptor | Optional mode | Собирает endpoint forensics/artifacts | Inbox/importers | +| DLP runtime | Optional mode | Тяжелый evidence/DLP слой, в production сейчас disabled | Inbox/AW/ClickHouse when enabled | +| Containment executor | Отдельный процесс | Выполняет только approved plan/apply/verify/rollback | Workflow events в ClickHouse | +| readiness/healthd | AW server and gateway | Проверяет живость сервисов, freshness, деградации | Portal/status/logs | + +## 4. Горячий путь рабочего времени + +Этот путь должен оставаться быстрым и независимым от тяжелых security-модулей. +DLP, Velociraptor и Hayabusa не должны тормозить расчет рабочих отчетов. + +```mermaid +flowchart LR + Session["RDP user session"] --> Collectors["Collectors
window / AFK / browser / worktime"] + Collectors --> AwHttp["ActivityWatch HTTP API"] + AwHttp --> Buckets["AW buckets
host suffix SHARKON2025"] + Buckets --> Worktime["aw-worktime-api"] + Worktime --> Cache["stale-safe report cache"] + Worktime --> PortalWorkforce["Portal
workforce view"] + Worktime --> Exporter["Influx exporter"] + Exporter --> Influx["InfluxDB"] + Influx --> Grafana["Grafana dashboards"] + Grafana --> Admin["Администратор
проверяет графики"] +``` + +Ключевой принцип: физическое имя или IP RDP-сервера может измениться, но +логический host id для buckets и витрин остается стабильным, пока оператор +явно не проводит миграцию идентификаторов. + +## 5. Отбор и категоризация ресурсов + +Браузерные события идут в общий поток ActivityWatch, затем интерпретируются +политикой рабочих/нерабочих ресурсов. Категории должны храниться как +управляемая конфигурация, а не как зашитые в код одиночные домены. + +```mermaid +flowchart TD + BrowserEvent["Browser event
URL/domain/title"] --> Normalizer["Domain normalizer"] + Normalizer --> CategoryRules["Category rules
work / non-work / neutral / unknown"] + CategoryRules --> WorktimeApi["Worktime API scoring"] + WorktimeApi --> Portal["Portal recommendations"] + WorktimeApi --> Grafana["Grafana panels"] + CategoryRules --> AdminConfig["Admin-owned config
review and update"] +``` + +Администратор должен видеть не только итоговые минуты, но и объяснение: +какой домен, какая категория, сколько времени, почему это считается рабочим +или нерабочим. + +## 6. ClickHouse / File1C / управленческая аналитика + +```mermaid +flowchart LR + FileSource["RDP/Windows File1C telemetry"] --> UploadTask["Windows scheduled task
File1C Upload"] + UploadTask --> Landing["ClickHouse landing directory"] + Landing --> Ingest["aw-1c-ingest-rust
systemd timer"] + Ingest --> CHRaw["ClickHouse raw tables"] + CHRaw --> CHViews["Materialized views
manager and workforce slices"] + CHViews --> Portal1C["Portal / 1C manager brief"] + CHViews --> Grafana1C["Grafana 1C dashboards"] + Ingest --> Health["ClickHouse health timers"] + Health --> PortalStatus["Portal status"] +``` + +Этот контур нужен для управленческой аналитики и файловых/1C-срезов. Он не +заменяет ActivityWatch hot path и не должен блокировать портал при временной +деградации ClickHouse. + +## 7. Security Finding Inbox и управляемое containment + +```mermaid +flowchart LR + HayabusaFindings["Hayabusa/Sigma findings"] --> Adapter["Finding adapters"] + VelociraptorFindings["Velociraptor exports"] --> Adapter + ManualFinding["Manual operator finding"] --> Adapter + OptionalDlp["Optional DLP evidence
disabled by default"] -.-> Adapter + Adapter --> Inbox["Security Finding Inbox
ClickHouse"] + Inbox --> Suspicious["Portal page
Подозрительные станции"] + Suspicious --> Decide["decide"] + Decide --> Plan["plan"] + Plan --> Approve["approve
human gate"] + Approve --> Apply["executor apply"] + Apply --> Verify["verify"] + Verify --> Closed["workflow event
closed or escalated"] + Verify --> Rollback["rollback
when verification fails"] + Rollback --> Inbox + Closed --> Inbox +``` + +```mermaid +stateDiagram-v2 + [*] --> FindingReceived + FindingReceived --> Planned: decide and plan + Planned --> ApprovalRequired: action is risky + ApprovalRequired --> Applied: approved + ApprovalRequired --> Rejected: rejected + Applied --> Verified: verify passed + Applied --> RollbackRequired: verify failed + RollbackRequired --> RolledBack: rollback completed + Verified --> Closed + Rejected --> Closed + RolledBack --> Escalated +``` + +Запрет: findings не должны автоматически блокировать рабочую станцию. Исполнение +возможно только после явного approval и через отдельный executor, который +пишет результат обратно в workflow-аудит. + +## 8. Операционный контроль и recovery + +```mermaid +flowchart TD + DailyCheck["daily / weekly contour checks"] --> Healthd["aw-rus-healthd"] + Healthd --> AwCheck["AW server and bucket freshness"] + Healthd --> WorktimeCheck["Worktime API health"] + Healthd --> ClickHouseCheck["ClickHouse health"] + Healthd --> GrafanaCheck["Grafana dashboard smoke"] + AwCheck --> Status["Portal status"] + WorktimeCheck --> Status + ClickHouseCheck --> Status + GrafanaCheck --> Status + Status --> Operator["Operator decision
restart, repair, or escalate"] + Operator --> Runbooks["Docs and runbooks"] +``` + +Важное разделение: routine checks не должны автоматически включать тяжелый DLP +runtime и не должны менять сетевые маршруты. Любое изменение маршрутизации, +firewall или containment выполняется как отдельное управляемое действие. + +## 9. Governance, GitHub и Gitea + +```mermaid +flowchart LR + DevBranch["Feature/docs branch"] --> PR["GitHub PR
public mirror validation"] + PR --> Checks["Required checks
rust, docs, security, smoke"] + Checks --> Review["CODEOWNERS review"] + Review --> Main["main branch"] + Main --> Gitea["Russian Gitea mirror
primary private contour"] + Gitea --> Runner["Russian build-runner
planned release evidence"] + PR -. not registry evidence .-> Note["Public transparency only"] +``` + +GitHub полезен для публичной проверяемости: PR, issues, checks, branch ruleset. +Но для российского реестрового release evidence нужен отдельный российский +контур сборки и хранения артефактов. + +## 10. Где смотреть руками + +| Что проверить | Где смотреть | +|---|---| +| Единый портал DetMir | `/portal` на gateway | +| Рабочая активность и рекомендации | Portal workforce pages, Worktime API | +| Графики по сотрудникам и приложениям | Grafana dashboards `detmir-aw-main`, `detmir-rdp-user-activity` и связанные panels | +| Состояние AW buckets | ActivityWatch API и readiness/status в portal | +| 1C/File analytics | Portal 1C manager views, ClickHouse dashboards | +| Подозрительные станции | Portal security view / Security Finding Inbox | +| Hayabusa/Velociraptor findings | Inbox import status, security dashboards, runbooks | +| Runtime checks | `aw-rus-healthd`, contour check scripts, portal status | +| Код и evidence процесса | GitHub PR/issues, private Gitea mirror | + +## 11. Связанные документы + +- [docs/ARCHITECTURE_RU.md](ARCHITECTURE_RU.md) +- [docs/UNIFIED_OPERATING_MODEL_RU.md](UNIFIED_OPERATING_MODEL_RU.md) +- [docs/WORKFORCE_OPERATIONS_MODEL_RU.md](WORKFORCE_OPERATIONS_MODEL_RU.md) +- [docs/GRAFANA_DASHBOARDS_RU.md](GRAFANA_DASHBOARDS_RU.md) +- [docs/SECURITY_FINDING_INBOX_RU.md](SECURITY_FINDING_INBOX_RU.md) +- [docs/LOW_COST_SIGMA_HAYABUSA_VELOCIRAPTOR_ADDON_RU.md](LOW_COST_SIGMA_HAYABUSA_VELOCIRAPTOR_ADDON_RU.md) +- [docs/DLP_OPTIONAL_RUNTIME_RU.md](DLP_OPTIONAL_RUNTIME_RU.md) +- [docs/PRODUCTION_READINESS_RU.md](PRODUCTION_READINESS_RU.md)