GДокументация GuardПользовательские и технические руководства

Документация Guard

Документация TechCatalyst Guard

Руководства для пользователей, администраторов, инженеров эксплуатации и разработчиков. Здесь описаны рабочие станции, агенты, политики безопасности, события, интеграции и эксплуатация Guard.

Начните здесь

Популярные руководства

Начало работыАдминистратор15 минут

Быстрый старт администратора

Первый рабочий сценарий: войти, проверить состояние системы, подключить агента, выпустить политику и увидеть событие.

  1. Войдите в админку под ролью administrator.
  2. Откройте главный экран и проверьте, что система доступна.
  3. Перейдите в «Станции» и зарегистрируйте агента.
  4. Откройте «Политики», создайте правило и опубликуйте его.
  5. Вернитесь в «События» и проверьте, что агент прислал контрольный сигнал или тестовое событие.
СобытияСпециалист безопасности10 минут

Разбор события безопасности

Как понять причину события, уровень риска, затронутую станцию и следующее действие.

  1. Откройте «События».
  2. Выберите событие с высоким риском или блокировкой.
  3. Проверьте станцию, агента, поверхность, причину и время.
  4. Убедитесь, что в данных нет исходного секрета или полного текста запроса.
  5. Если срабатывание неверное, отметьте его в разделе качества детекторов.
ПолитикиАдминистратор12 минут

Публикация политики

Создание, проверка и публикация правил, которые получают агенты на рабочих станциях.

  1. Откройте «Политики».
  2. Создайте черновик или импортируйте готовый JSON.
  3. Проверьте режим применения и список правил.
  4. Опубликуйте политику.
  5. Проверьте, что агент получил тот же policy_id при синхронизации.
AI-угрозыСпециалист безопасности8 минут

Проверка MITRE ATLAS и OWASP

Где увидеть, что внешние источники проверяются, и как читать статус «без изменений».

  1. Откройте «AI-угрозы».
  2. Нажмите «Проверить».
  3. Посмотрите статус MITRE ATLAS, OWASP GenAI/LLM Top 10 и OpenTelemetry.
  4. Если написано «без изменений», источник доступен, но его хэш совпал с прошлым снимком.
  5. Откройте покрытие рисков и проверьте, какие меры уже включены.
ИнтеграцииИнженер эксплуатации20 минут

Проверка входа через Keycloak

Как проверить вход, выход, сессию и права для основных ролей.

  1. Проверьте realm, client и redirect URL.
  2. Войдите под administrator и убедитесь, что доступны действия управления.
  3. Войдите под security_officer и проверьте действия безопасности.
  4. Войдите под viewer и убедитесь, что изменение данных недоступно.
  5. Проверьте выход и повторный вход.
ЭксплуатацияИнженер эксплуатации10 минут

Проверка после обновления

Короткий список проверок, без которых нельзя считать обновление рабочим.

  1. Проверьте публичную страницу.
  2. Проверьте readiness API, а не только HTML.
  3. Откройте интерфейс в браузере и убедитесь, что нет экрана ошибки.
  4. Проверьте вход.
  5. Проверьте регистрацию агента, контрольный сигнал, получение политики и отправку события.

Все материалы

Разделы документации

Начало работы

Базовые материалы для первого входа и понимания продукта.

Что такое TechCatalyst Guard

Краткое описание платформы и состава продукта.

обзорпродукт

Первый вход

Как войти в админку и проверить, что пользователь видит правильные разделы.

входроль

Роли и права

Что может делать administrator, security_officer, viewer и developer.

ролидоступ

Где что находится

Карта главных разделов админки.

навигация

Пользователям

Как работать с платформой каждый день.

Главный экран

Какие показатели смотреть сразу после входа.

главный экранобзор

Станции и агенты

Как понять, какие рабочие станции подключены.

агентыстанции

События безопасности

Как читать событие и принимать решение.

событиярасследование

AI-угрозы

Как смотреть покрытие MITRE ATLAS, OWASP GenAI/LLM Top 10 и OpenTelemetry.

mitreowaspopentelemetry

Guard

Агенты, политики и события безопасности на рабочих станциях.

Состав Guard

Компоненты Guard и их зона ответственности.

guardагентполитики

Установка агента

Минимальная проверка после установки агента Guard.

агентустановка

Политики Guard

Как проверить, что агент применяет нужную политику.

политикиpolicy_id

События Guard

Поля события, которые нужны для расследования.

событиярасследование

Администрирование

Настройки, политики, пользователи и права.

Пользователи

Создание пользователей, роли и отключение доступа.

пользователиrbac

Политики безопасности

Создание, проверка, публикация и откат политики.

политики

Качество детекторов

Как разбирать ложные срабатывания и пропуски.

качестводетекторы

Источники знаний

Как обновляются MITRE ATLAS, OWASP GenAI/LLM Top 10 и OpenTelemetry.

источникиAI-безопасность

Эксплуатация

Установка, обновления, диагностика и восстановление.

Установка on-prem

Состав установки, зависимости и первый запуск.

установкаon-prem

Проверка после обновления

Что проверить после каждого релиза.

обновлениепроверка

Резервные копии

Как проверять резервную копию и восстановление.

резервная копиявосстановление

Ошибка 500

Как быстро найти причину ошибки сервера.

500диагностика

Интеграции

Подключение корпоративных сервисов.

Keycloak и OIDC

Realm, client, redirect URL, группы и роли.

keycloakoidc

Loki

Доставка событий, метки, очередь и принудительная отправка.

lokiлоги

OpenTelemetry

Какие атрибуты использует платформа.

opentelemetryтелеметрия

MITRE ATLAS и OWASP

Как проверяются источники по AI-безопасности.

mitre atlasowasp llm

API

Справочник для разработчиков и интеграторов.

API управления

Основные маршруты и правила доступа.

apiдоступ

Жизненный цикл агента

Регистрация агента, контрольный сигнал, получение политики и отправка события.

агентapi

Событие безопасности

Минимальная схема события и правила очистки данных.

событиясхема

Снимок политики

Как агент получает опубликованную политику.

политикаснимок

Безопасность

Как платформа защищает данные и как это проверяется.

Модель безопасности

Границы доверия, роли, доступ к данным и аудит.

безопасностьаудит

События без секретов

Какие данные нельзя хранить в событиях.

секретыданные

Разделение организаций

Как не допустить доступа к чужим данным.

организацииизоляция

Обновления и подписи

Как проверять целостность обновлений.

обновленияподписи

Коротко

Частые вопросы

Где находится документация?

На этой странице: сверху поиск, слева меню, в центре руководства и статьи. Документы для скачивания находятся внизу.

К какой версии относится документация?

Документация относится к текущей опубликованной версии продукта. Изменение поведения продукта фиксируется в соответствующей статье.

Что значит «без изменений» у MITRE или OWASP?

Источник доступен, но его сохраненный хэш совпал с прошлой проверкой. Это нормальное состояние, если сам источник не публиковал новую версию.

Почему проверки после деплоя не ограничиваются HTTP 200?

HTML-страница может открываться, когда API, вход или база данных не работают. Поэтому проверяются вход, readiness API, агент, политика и отправка события.

Скачать

Документы для скачивания

Описание функциональных характеристик программного обеспечения

Назначение, пользовательские и административные функции, архитектурные модули и сценарии применения.

Документация по установке программного обеспечения

Развертывание, настройка окружения, зависимости, база данных и первый запуск.

Документация по эксплуатации программного обеспечения

Работа с ролями, типовые сценарии, ограничения, сопровождение и диагностика.

Документ
Описание
Файлы
Описание функциональных характеристик программного обеспечения
Назначение, пользовательские и административные функции, архитектурные модули и сценарии применения.
Документация по установке программного обеспечения
Развертывание, настройка окружения, зависимости, база данных и первый запуск.
Документация по эксплуатации программного обеспечения
Работа с ролями, типовые сценарии, ограничения, сопровождение и диагностика.
Продукт и правовой статус
Общее описание программного продукта, классификация, модель предоставления и сведения об исключительном праве.
Техническая архитектура
Пользовательская часть, серверная часть, база данных, API, маршрутизация, мониторинг и журнал событий.
Хранение и сборка
Где хранятся исходники и сборочные артефакты, как выполняется производственная сборка.
Жизненный цикл и поддержка
Эксплуатация, мониторинг, устранение неисправностей, обновления и требования к поддержке.
Тарифная политика
Модель неисключительной лицензии, тарифицируемые позиции и принципы определения стоимости.
Принадлежность сайта
Справка о доменах и сайтах, которые используются правообладателем для размещения документации.
Отчет о проведении работ
Состав выполненных работ, модулей платформы и итоговых материалов разработки.