Shield-Cyber/ShieldCyber-REST-API

[](https://github.com/Shield-Cyber/ShieldCyber-REST-API/actions/workflows/codeql.yml) # Shield Scanner 本仓库维护和更新连接到 Shield 平台的 Shield Cyber 网络扫描器。此扫描器应用于内部网络漏洞扫描，或用于其部署位置的不同网络的发现扫描。在继续安装扫描器之前，请确保您拥有以下必要的值，以便正确链接扫描器： - **Subscription ID** - 扫描器需要链接回的订阅 ID。 - **Location Name** - 扫描器部署的位置名称。用户应创建此值，并确保每个订阅的唯一性。 - **API Key** - 位于 [**My Account**](https://platform.shieldcyber.io/account) 页面 **Subscriptions** 标签下的 API Key。使用 Subscriptions 表格中的 `Copy` 按钮访问 API Key。 要安装扫描器，请遵循下方针对特定平台的说明。您也可以参考 Shield Platform 文档站点，网址如下：[Shield Platform Documentation](https://docs.shieldcyber.io)。 ## 安装说明 ### 基于 Linux 的操作系统（推荐） 要在基于 Linux 的操作系统上安装，可以下载并执行单个脚本来安装和启动 Shield service。安装 Shield service 后，即可安装扫描器，此时需要设置密码。 #### 下载 Install.sh 脚本 `sudo wget https://raw.githubusercontent.com/Shield-Cyber/ShieldCyber-REST-API/main/install.sh` #### 更新文件权限 `sudo chmod +x install.sh` #### 安装并部署 Shield Service `sudo ./install.sh -s 'SUBSCRIPTION-ID' -l 'LOCATION' -k 'API-KEY'` #### 安装并配置 Shield Scanner `sudo shield -I -P 'CREATE-SCANNER-PASSWORD'` ### Windows 操作系统及 MacOS 在 Windows 系统上安装 Shield scanner 存在限制。具体而言，要运行扫描器，Windows 主机需要安装 Docker Desktop，且只能在 Windows 工作站上运行。此外，安装过程的自动化程度不如 Linux 版本的部署。 #### 依赖项 要在 Mac 或 Windows 10/11 操作系统上成功安装 Shield scanner，需要安装并配置好 WSL（仅限 Windows）和 Docker Desktop。安装 Docker Desktop 后，在尝试安装 Shield Scanner 之前，请确保 Docker 引擎已启动。 - [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) - [Docker Desktop](https://www.docker.com/products/docker-desktop/) #### 安装并配置 Shield Scanner 1. 下载并解压本仓库：[Shield Scanner](https://github.com/Shield-Cyber/ShieldCyber-REST-API/archive/refs/heads/main.zip) 2. 解压文件夹内容 3. 导航至 *ShieldCyber-REST-API-main* 文件夹 4. 在文本编辑器中打开 *example.env* 文件并修改 `yourpasswordhere` 值，然后保存 5. 将 *example.env* 文件重命名为 *.env* 6. 以管理员身份打开命令提示符，并导航至 *ShieldCyber-REST-API-main* 文件夹 7. 使用以下命令安装并启动 Shield scanner：`docker compose up -d` **注意**：您需要按照 [Shield Documentation](https://docs.shieldcyber.io/docs/deployment/network-scans.html) 中的说明安装 Shield Cyber Agent.Shield service，并使用 Shield Service MSI 完成 Agent.Shield service 的安装。 ## 在平台中链接 Shield Scanner 要使用扫描器，需要在 Shield 平台中对其进行链接。要完成此步骤，请导航至 **Settings** -> **Scan Config** -> **Shield** [页面](https://platform.shieldcyber.io/settings)，点击 **New Configuration**，然后输入以下值，并保存创建的配置： - **Location** - 选择为正在链接的扫描器创建的位置。必须安装并运行 Shield service，Location 值才会显示。 - **Access Key** - 输入扫描器的用户名。**Admin** 是所有 Shield scanner 安装的默认用户名。 - **Secret Key**：输入之前创建的扫描器密码。 - **API URL**：输入扫描器 API 的 URL。默认情况下，API 在端口 8000 上运行，因此如果扫描器运行在 service 运行的同一设备上，则 API 值应为 `https://localhost:8000/` ### 注意事项 - 用户名为 **admin** - 服务启动可能需要几分钟，因为扫描器在创建和启动扫描之前需要更新数据库。 - Windows 和 MacOS 环境需要在 Docker 引擎启动 _之前_ 让用户登录系统，因此不建议在无人值守或服务器设置中进行此安装。

标签：Cutter, REST API, SaaS 集成, Shield Cyber, 云存储安全, 代理服务器, 企业安全, 内部网络扫描, 加密, 密码管理, 插件系统, 数据泄露防护, 漏洞扫描器, 网络安全, 网络扫描, 网络探测, 网络资产管理, 脆弱性管理, 自动化安装, 请求拦截, 远程管理, 隐私保护