Сохранение учетных данных для сборщика
Учетные данные — это имя входа только для чтения, которое сборщик использует для подключения к системе: имя входа SQL, учетная запись Windows, ключ SSH или субъект-служба Azure. Вы сохраняете учетные данные один раз в сущности, и их может использовать любой ресурс этой сущности и сущностей ниже. В этом руководстве показано, как добавить учетные данные, какой вид выбрать, какие параметры подключения есть у каждого вида и как ресурс находит используемые им учетные данные.
Перед началом работы
- Вам нужна роль Entity admin (администратор сущности) в сущности, которой будут принадлежать учетные данные.
- Имя входа существует в отслеживаемой системе и имеет разрешения только на чтение. Для SQL Server см. статью Предварительные требования для групп доступности; для всех платформ см. статью Разрешения.
- Сохраняйте учетные данные в дереве сущностей на самом высоком уровне, где они действительны. Имя входа SQL, которое используется на всех серверах ООО «Лукоморье», должно храниться в ООО «Лукоморье», а не в каждой среде.
Выбор вида
| Вид | Пользователь | Секрет | Для чего использовать |
|---|---|---|---|
SQL login (sql_login) | Имя входа SQL | Пароль | Экземпляры SQL Server и группы доступности; обнаруженные в них базы данных и связанные серверы используют учетные данные экземпляра. Также журнал выполнения Reporting Services |
Windows account (windows) | Учетная запись (DOMAIN\user) | Пароль | Узлы Windows через WinRM; серверы отчетов и веб-адреса с проверкой подлинности Windows (NTLM) |
HTTP user and password (http_basic) | Пользователь | Пароль | Веб-адреса и серверы отчетов с обычной проверкой подлинности (Basic); проверки Wazuh |
Bearer token (token) | — | Токен | Веб-адреса с проверкой подлинности по токену Bearer |
SSH key (ssh_key) | Пользователь | Закрытый ключ | Узлы Linux |
SSH password (ssh_password) | Пользователь | Пароль | Узлы Linux |
Azure service principal (azure_sp) | Идентификатор клиента (client id) | Секрет клиента | Проверки состояния Azure и проверки удостоверений Entra ID для клиента (tenant), к которому не может подключиться управляемое удостоверение сервера |
Встроенная проверка подлинности Windows для SQL Server не поддерживается: сборщик работает в контейнере Linux без билета Kerberos. Используйте имя входа SQL; для этого экземпляр должен принимать проверку подлинности SQL Server (смешанный режим).
Добавление учетных данных
- Откройте Settings › Credentials и выберите сущность в средстве выбора сущностей, например ООО «Лукоморье».
- Выберите Add credential.
- Введите понятное вам значение в поле Name, например
sql-monitoring, и выберите Kind. Изменить вид позже нельзя. - Проверьте поле Entity: учетные данные могут использовать ресурсы этой сущности и сущностей ниже.
- Введите пользователя и секрет. Названия полей зависят от вида, например SQL login и Password или Client id и Client secret.
- В разделе Connection options задайте параметры, нужные для этого вида. См. следующий раздел.
- Выберите Create.
Учетные данные появятся в списке с секретом, отмеченным как stored, количеством использующих их ресурсов и временем последнего использования.
Параметры подключения
| Вид | Параметр | Значения | Действие |
|---|---|---|---|
| SQL login | encrypt | yes (по умолчанию), no, strict | Шифрует подключение. strict использует TDS 8 и требует SQL Server 2022 или более поздней версии |
| SQL login | trust_server_certificate | true (по умолчанию), false | Большинство экземпляров используют самозаверяющие сертификаты. Задайте false, когда у экземпляра будет сертификат, которому доверяет сборщик |
| SQL login | host_name_in_certificate | Имя узла | Имя для проверки, если оно отличается от имени узла, например при подключении через прослушиватель или псевдоним |
| SQL login | application_intent | ReadOnly (по умолчанию), ReadWrite | ReadWrite меняет только маршрутизацию, чтобы проверки на уровне баз данных охватывали базы данных доступности первичной реплики, которая отклоняет подключения с намерением только для чтения. У имени входа по-прежнему нет разрешений на запись |
| Windows account | auth | kerberos (по умолчанию), negotiate, ntlm | Способ проверки подлинности WinRM. В образе сборщика нет конфигурации Kerberos, поэтому выберите negotiate или ntlm |
| SSH key, SSH password | known_hosts | Строки OpenSSH known_hosts, по одной на строку | Закрепляет ключи узлов, которые принимает сборщик |
| Azure service principal | tenant_id | Идентификатор клиента (tenant ID) Entra | Клиент, в котором зарегистрировано приложение |
Некоторые параметры задаются только через API, в атрибутах attributes учетных данных:
| Вид | Параметр | Действие |
|---|---|---|
| Azure service principal | subscriptions | Ограничивает проверки состояния Azure этими подписками. Без этого параметра действует AZURE_SUBSCRIPTION_IDS, а в его отсутствие — все подписки, которые может читать удостоверение |
| HTTP user and password | verify_tls | false разрешает недоверенный сертификат на индексаторе и диспетчере Wazuh. По умолчанию true |
Имена параметров никогда не содержат секретов: API отклоняет параметр, имя которого содержит pass, secret, token, private или pwd. Указывайте секреты в поле секрета.
Как защищен секрет
- Секрет доступен только для записи. Он шифруется ключом данных установки (
EXCUBIUS_DATA_KEY) и больше никогда не отображается ни на одном экране и ни через API, который сообщает только, сохранен ли секрет. - Чтобы изменить секрет, отредактируйте учетные данные и введите новый. Оставьте поле пустым, чтобы сохранить имеющийся секрет, или выберите Remove the stored secret, чтобы удалить его.
- Сборщик получает секрет по внутренней сети, хранит его только в памяти и никогда не записывает в журналы.
- Храните
EXCUBIUS_DATA_KEYвместе с резервной копией файла.env. Без этого ключа сохраненные секреты нельзя расшифровать, и проверки завершаются ошибкой видаconfig, пока вы не введете секреты заново.
Какие учетные данные использует ресурс
Ресурс ищет учетные данные в следующем порядке и берет первые, вид которых подходит для проверки:
- Собственные учетные данные проверки, если они заданы.
- Учетные данные ресурса.
- Учетные данные ближайшего родительского ресурса. Группа доступности или база данных, обнаруженная в экземпляре, использует имя входа SQL этого экземпляра.
Например, проверка журнала выполнения сервера отчетов — это проверка T-SQL. Если у ресурса сервера отчетов есть учетная запись Windows для его портала, проверка использует имя входа SQL вышестоящего экземпляра или имя входа SQL, заданное вами для этой отдельной проверки.
Чтобы задать учетные данные для одной проверки, используйте API: PATCH /api/v1/resources/{id}/checks/{check_id} с credential_id. Чтобы связать ресурс или проверку с учетными данными, нужна роль Entity admin в сущности, которой принадлежат эти учетные данные.
Изменение и удаление учетных данных
- Edit изменяет имя, пользователя, секрет и параметры. Вид не меняется.
- Delete работает, только если учетные данные ничем не используются. Сначала измените ресурсы и проверки, которые их используют.
- При удалении сущности удаляются и принадлежащие ей учетные данные.
Для каждого набора учетных данных в списке указано, сколько ресурсов и проверок их используют и когда их в последний раз использовала успешная проверка.
Связанное содержимое
- Как работает сборщик
- Добавление ресурса, где Test connection подтверждает, что учетные данные работают
- Ошибки сборщика
- Разрешения