[Releases][release] | [Pull Requests][pr] | [Issues][issues]
[![GitHub release][img-version-badge]][repo] [![Build Status][img-actions-badge]][actions-ci] [![Pull Requests][img-pr-badge]][pr] [![Slack][img-slack-badge]][slack] [![License][img-license-badge]][license]
Strelka Web UI 是一个基于浏览器和 API 的文件提交前端，用于 Strelka Enterprise File Scanner。它允许用户将文件提交到 Strelka 集群，并轻松查看历史响应结果。Strelka Web UI 支持 LDAP 身份验证和 API 访问，提供了一种安全且灵活的方式来与 Strelka 扫描器交互。本文档详细介绍了如何设置和使用 Strelka Web UI，以及其功能和相关项目。
文件提交 UI 提供以下功能：
默认情况下，Strelka UI 配置为使用一个最小的“快速入门”部署，允许用户测试系统。此部署将指向本地 Strelka 实例并启动本地数据库。用户可以使用任意用户名/密码访问此系统。有关指向远程 Strelka 实例、数据库或使用 LDAP 进行身份验证的更多信息，请参阅附加设置部分：
Start or ensure Strelka cluster is ready and accessible.
See https://github.com/target/strelka for more information.
# Terminal 1
# From the ./strelka-ui directory
$ docker-compose -f docker-compose.yml up
1) Open A Browser
2) Navigate to 0.0.0.0:8080
3) Login with:
- Username: strelka
- Password: strelka
本节详细介绍了如何指向远程 Strelka 实例、用于存储的远程数据库以及用于身份验证的 LDAP 服务器，以实现更安全的使用。要启用这些功能，您可以使用环境变量来覆盖默认值。
后端配置通过环境变量提供，可以在 ./app/config/config.py 中静态设置。
在本地运行时，配置的优先级为：系统环境变量 -> .env -> ./app/config/config.py。
在 Docker 中运行时，配置的优先级为：Docker 环境变量 -> 系统环境变量 -> ./app/config/config.py。
请参考 ./app/example.env 进行环境变量设置。
以下详细说明了 ./app/config/config.py 中的配置项。
| 字段名称 | 值 | 是否必需 |
|---|---|---|
| STRELKA_HOST | Strelka 主机名（例如 0.0.0.0） | 是 |
| STRELKA_PORT | Strelka 端口号（例如 57314） | 是 |
| STRELKA_CERT | Strelka 证书路径（如需要）（例如 /path/to/cert.pem） | 否 |
| CA_CERT_PATH | LDAP 的 CA 证书路径（如需要）（例如 /path/to/ca_certs） | 否 |
| VIRUSTOTAL_API_KEY | VirusTotal 哈希查询的 API 密钥 | 是 |
| VIRUSTOTAL_API_LIMIT | 限制 VirusTotal 扫描的文件数量（默认：30） | 是 |
| LDAP_URL | LDAP 服务器 URL（例如 ldaps://ldap.example.com:636） | 否 |
| LDAP_SEARCH_BASE | LDAP 查询的搜索基础（例如 DC=example,DC=com） | 否 |
| LDAP_USERNAME_ORGANIZATION | LDAP 查询的用户名组织（例如 org//） | 否 |
| LDAP_ATTRIBUTE_ACCOUNT_NAME_FIELD | 账户名称的 LDAP 属性（例如 sAMAccountName） | 否 |
| LDAP_ATTRIBUTE_FIRST_NAME_FIELD | 名字的 LDAP 属性（例如 givenName） | 否 |
| LDAP_ATTRIBUTE_LAST_NAME_FIELD | 姓氏的 LDAP 属性（例如 sn） | 否 |
| LDAP_ATTRIBUTE_MEMBER_OF_FIELD | 成员所属的 LDAP 属性（例如 memberOf） | 否 |
| LDAP_ATTRIBUTE_MEMBER_REQUIREMENT_FIELD | 成员要求的 LDAP 属性（例如 AD Attribute） | 否 |
| STATIC_ASSET_FOLDER | UI 的构建文件夹（例如 build） | 是 |
| MIGRATION_DIRECTORY | SQLAlchemy 迁移目录（例如 ./migrations） | 是 |
| DATABASE_USERNAME | 数据库用户名（例如 admin） | 是 |
| DATABASE_PASSWORD | 数据库密码（例如 password123） | 是 |
| DATABASE_HOST | 数据库主机名（例如 db.example.com） | 是 |
| DATABASE_PORT | 数据库端口号（例如 5432） | 是 |
| DATABASE_DBNAME | 数据库名称（例如 mydb） | 是 |
| API_KEY_EXPIRATION | API 密钥过期时间（以天为单位）（例如 30） | 是 |
您还可以在 UI 提交表中设置一个引用，允许用户根据 request.id 快速跳转到外部站点。通过修改 ./ui/src/config.js 并按照下表中的 SEARCH_URL 示例，您可以为用户提供指向外部站点（例如 SIEM / 日志记录器）的链接。确保您的链接中包含字符串 <REPLACE>，UI 将用相关文件的请求 ID 替换该字符串。
./ui/src/config.js 中支持的修改字段：
| 字段名称 | 值 | 示例 |
|---|---|---|
| SEARCH_URL | 外部应用程序的搜索 URL | 例如：https://search.com/?q=request.id= |
| SEARCH_NAME | 外部应用程序的搜索名称 | 例如：Splunk |
| DEFAULT_EXCLUDED_SUBMITTERS | 默认从提交表视图中排除的用户。用于默认隐藏自动化。 | 例如：SearchBot |
如果您的网络环境需要自定义 CA 捆绑包（例如，企业 TLS 检查代理），您可以在构建时和运行时提供它，而无需将任何证书文件提交到仓库。
构建时 — 在运行 docker compose build 之前，通过 CUSTOM_CA_CERT 传递 CA 捆绑包的路径。证书使用 BuildKit secret 临时挂载，并且永远不会写入任何镜像层：
CUSTOM_CA_CERT=/path/to/your/ca-bundle.crt docker compose build
# or, combined with up:
CUSTOM_CA_CERT=/path/to/your/ca-bundle.crt docker compose up --build
在不需要自定义 CA 的开放网络上，完全省略该变量 — 构建会优雅降级：
docker compose up --build
运行时 — 项目根目录下的 certs 目录会挂载到运行容器内的 /certs。将您的 CA 捆绑包放在那里，并在 ./app/strelka_ui/.env 中或作为 Docker 环境变量设置 REQUESTS_CA_BUNDLE（以及可选的 SSL_CERT_FILE）：
# ./app/strelka_ui/.env
REQUESTS_CA_BUNDLE=/certs/ca-bundle.crt
SSL_CERT_FILE=/certs/ca-bundle.crt
Strelka UI 还提供 API 路由，供用户脚本访问。请参考以下路由了解详情：
有关如何使用 Python requests 对 Strelka UI API 进行身份验证、收集扫描统计信息以及提交文件的示例，请参见 ./misc/examples/api_examples.py
数据库使用 https://www.sqlalchemy.org/ 作为 ORM。Flask-Migrate 用于通过 Alembic 提供数据库迁移。提供了一个辅助脚本文件 manage.py，以协助常见的数据库任务。
如果您正在创建新数据库或修改当前数据库，您必须执行以下步骤 — 不过在启动集群时，这些命令将为您执行：
从模型更改生成新的迁移：
使用当前数据库配置更新数据库
后端应用程序主要由以下技术组成：
前端 UI 是一个使用 React 创建的 React JS 应用程序，由 Flask 提供服务。UI 使用 Antd 库和 Antd ProComponents，路由由 React Router 处理。