跳转至

文档索引

获取完整文档索引,请访问:https://docs.osmedeus.org/llms.txt 在进一步探索前,请使用此文件发现所有可用页面。

Web UI

Osmedeus 的服务器与 Web 界面

本文档介绍 Osmedeus 的 Web UI,它是运行工作流、模块及其他实用工具的主要入口。

Osmedeus 服务器也充当事件接收器,处理来自其他运行的事件并管理定时扫描。详情请参阅事件驱动

通过运行以下命令启动 Web UI:

osmedeus serve

然后在浏览器中打开 https://localhost:8002

如何登录 Web UI

web-ui-login

您的默认密码位于 $HOME/osmedeus-base/osm-settings.yaml

您可以通过运行以下命令查看默认凭据(这些凭据是自动生成的):

osmedeus config view server.username
osmedeus config view server.password

许多 API 端点被有意设计为在您的机器上执行代码,因此请确保您的 Web UI 和 API 端点使用强凭据进行保护。详情请参阅安全警告

您还可以通过运行以下命令更改默认密码并设置 API 密钥认证:

osmedeus config set server.username "osmedeus"
osmedeus config set server.password "$(openssl rand -hex 12)"
# api key auth requires a jwt secret signing key
osmedeus config set server.jwt.secret_signing_key "$(openssl rand -hex 32)"
osmedeus config set server.enabled_auth_api true
osmedeus config set server.auth_api_key "$(openssl rand -hex 24)"

## API Key Authentication Settings
# server:
#   enabled_auth_api: true
#   auth_api_key: "your-secure-api-key"

所有 Web UI 页面

Web UI 包含以下页面,允许您查看和管理资产、工作空间、漏洞及其他实用工具。

1. 资产与工作空间

这是 Web UI 的主页面,您可以在此查看和管理资产、工作空间、漏洞以及工作流生成的工件。

web-ui-workspace

web-ui-assets

web-ui-vuln

web-ui-assets

web-ui-vuln

您还可以选择增强 UI,以更清晰、语法高亮的布局显示工件——非常适合查看 Markdown 或 HTML 报告。

web-ui-artifact-list

web-ui-artifact-details

2. 开始新扫描(简单运行与定时扫描)

您可以在此通过选择工作流和目标资产,并设置所有额外参数和调度选项来开始新扫描。

web-ui-new

开始新扫描后,您可以在扫描列表中查看进度和结果。

web-ui-list-scan

3. 设置与安装注册表

您可以在此配置设置并安装 Osmedeus 的注册表。

web-ui-install-registry

web-ui-settings

4. 实用工具函数与调度

您可以在此安排工作流在特定时间或间隔运行,还可以使用 LLM 聊天获取工作流方面的帮助。

web-ui-schedule

web-ui-llm-chat

web-ui-utility-functions

工作流可视化与编辑器

通过 xyflow 对工作流进行美观的可视化展示,并在 Web UI 中提供编辑器。

web-ui-workflow1

web-ui-workflow2

web-ui-workflow3

web-ui-workflow4

web-ui-workflow4

与 Web UI 通信

登录后,您可以使用 Web UI 运行工作流、查看结果以及管理您的 Osmedeus 安装。

bash Request theme={null} curl --request POST --url https://localhost:8002/osm/api/runs --header 'Authorization: Bearer $TOKEN' --header 'Content-Type: application/json' --data '{"flow": "general", "target": "example.com", "distributed": true}'