为采集器存储凭据
凭据是采集器用来访问系统的只读登录信息:SQL 登录名、Windows 账户、SSH 密钥或 Azure 服务主体。你只需在实体上存储一次,该实体及其下的每个资源都可以使用它。本指南说明如何添加凭据、选择哪种类型、每种类型的连接选项,以及资源如何找到它所使用的凭据。
开始之前
- 你需要在将拥有该凭据的实体上拥有 Entity admin(实体管理员)角色。
- 登录名已在被监视的系统上创建,并且只有只读权限。对于 SQL Server,请参阅可用性组的先决条件;对于所有平台,请参阅权限。
- 将凭据存储在实体树中尽可能高的、仍然有效的层级。在 高密物流 的每台服务器上使用的 SQL 登录名应放在 高密物流 上,而不是放在每个环境上。
选择类型
| 类型 | 用户 | 机密 | 适用于 |
|---|---|---|---|
SQL login (sql_login) | SQL 登录名 | 密码 | SQL Server 实例和可用性组;它们发现的数据库和链接服务器使用实例的凭据。也用于 Reporting Services 执行日志 |
Windows account (windows) | 账户(DOMAIN\user) | 密码 | 通过 WinRM 访问的 Windows 主机;使用 Windows 身份验证(NTLM)的报表服务器和 Web 终结点 |
HTTP user and password (http_basic) | 用户 | 密码 | 使用基本身份验证的 Web 终结点和报表服务器;Wazuh 检查 |
Bearer token (token) | — | 令牌 | 使用持有者身份验证的 Web 终结点 |
SSH key (ssh_key) | 用户 | 私钥 | Linux 主机 |
SSH password (ssh_password) | 用户 | 密码 | Linux 主机 |
Azure service principal (azure_sp) | 客户端 ID | 客户端密码 | 针对服务器的托管标识无法访问的租户,执行 Azure 态势检查和 Entra ID 身份检查 |
不支持对 SQL Server 使用 Windows 集成身份验证:采集器运行在没有 Kerberos 票证的 Linux 容器中。请使用 SQL 登录名,这要求实例接受 SQL Server 身份验证(混合模式)。
添加凭据
- 打开 Settings › Credentials,并在实体选取器中选择实体,例如 高密物流。
- 选择 Add credential。
- 输入你能识别的 Name,例如
sql-monitoring,并选择 Kind。类型之后无法更改。 - 检查 Entity:该实体及其下的资源可以使用此凭据。
- 输入用户和机密。标签随类型而变,例如 SQL login 和 Password,或者 Client id 和 Client secret。
- 在 Connection options 下,设置该类型所需的内容。请参阅下一节。
- 选择 Create。
凭据会出现在列表中,机密标记为 stored,并显示有多少资源使用它以及上次使用的时间。
连接选项
| 类型 | 选项 | 值 | 效果 |
|---|---|---|---|
| SQL 登录名 | encrypt | yes(默认)、no、strict | 加密连接。strict 使用 TDS 8,并要求 SQL Server 2022 或更高版本 |
| SQL 登录名 | trust_server_certificate | true(默认)、false | 大多数实例使用自签名证书。一旦实例拥有采集器信任的证书,请设置为 false |
| SQL 登录名 | host_name_in_certificate | 主机名 | 当证书中的名称与主机不同时要验证的名称,例如通过侦听器或别名连接时 |
| SQL 登录名 | application_intent | ReadOnly(默认)、ReadWrite | ReadWrite 只更改路由,使每个数据库的检查包含拒绝只读意向连接的主要副本上的可用性数据库。该登录名仍然没有写入权限 |
| Windows 账户 | auth | kerberos(默认)、negotiate、ntlm | WinRM 的身份验证方式。采集器映像没有 Kerberos 配置,因此请选择 negotiate 或 ntlm |
| SSH 密钥、SSH 密码 | known_hosts | OpenSSH known_hosts 行,每行一条 | 固定采集器接受的主机密钥 |
| Azure 服务主体 | tenant_id | Entra 租户 ID | 应用注册所属的租户 |
有些选项只能通过 API 在凭据的 attributes 中设置:
| 类型 | 选项 | 效果 |
|---|---|---|
| Azure 服务主体 | subscriptions | 将 Azure 态势检查限制在这些订阅内。如果没有设置,则适用 AZURE_SUBSCRIPTION_IDS,否则适用身份可以读取的所有订阅 |
| HTTP 用户和密码 | verify_tls | false 表示接受 Wazuh 索引器和管理器上不受信任的证书。默认为 true |
选项名称绝不会保存机密:如果选项名称包含 pass、secret、token、private 或 pwd,API 会拒绝它。请把机密放在机密字段中。
机密如何受到保护
- 机密是只写的。它使用安装的数据密钥(
EXCUBIUS_DATA_KEY)加密,之后在任何界面和 API 中都不会再显示,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 仅在没有任何内容使用该凭据时才可用。请先更改使用它的资源和检查。
- 删除实体时,也会删除它拥有的凭据。
列表会显示每个凭据有多少资源和检查在使用它,以及成功的检查上次使用它的时间。