vmware/vss-remediation-worker

Secure State 修复任务

目录

• 概述
• 快速入门指南
• 任务执行
• 日志记录
• 支持的修复任务
• 贡献指南
• 仓库管理员资源
• VMware 资源

概述

这些任务是开源的修复任务，需与https://hub.docker.com/r/vmware/vss-remediation-worker%E9%85%8D%E5%90%88%E4%BD%BF%E7%94%A8%E3%80%82%E8%A6%81%E4%BD%BF%E7%94%A8%E6%AD%A4%E4%BB%A3%E7%A0%81%EF%BC%8C%E5%BF%85%E9%A1%BB%E9%83%A8%E7%BD%B2%E8%AF%A5%E5%B7%A5%E4%BD%9C%E5%99%A8%E5%B9%B6%E6%AD%A3%E7%A1%AE%E9%85%8D%E7%BD%AESecure State worker组。

快速入门指南

向此仓库贡献可用任务需遵循以下约定：

• 目录结构
• 文件名

每个任务必须完全包含在独立目录中，目录名称即为任务名称。例如，名为s3-remove-public-access的目录将生成名为s3-remove-public-access的任务。

执行Python任务时，文件必须与目录同名并带有.py扩展名。例如，s3-remove-public-access任务必须在该目录中包含s3-remove-public-access.py文件。

requirements.txt和constraints.txt文件为可选但推荐使用。这确保工作器能以可重复的方式安装依赖，避免Secure State应用因新依赖安装而导致任务失效。

任务执行

当工作器运行时，会在任务目录下安装（可选的）requirements.txt和constraints.txt中指定的所有依赖。任务执行时，Python运行时仅限于该相对路径下的依赖。这确保所有执行的代码均为Secure State工作器已知，并可通过校验和验证。工作器还会将整个文件夹移动到单独的工作目录，以防止本地导入。

工作器执行任务的方式类似于：

bash
python ./s3-remove-public-access/s3-remove-public-access.py {... 发现有效载荷JSON ...}

发现有效载荷格式如下：

json
{
  "notificationInfo": {
    "CloudAccountID" : <string>,
    "RuleID": <string>,
    "RuleName": <string>,
    "RuleDisplayName": <string>,
    "Level": <string>,
    "Service": <string>,
    "FindingInfo": {
      "FindingId": <string>,
      "ObjectId": <string>,
      "ObjectChain": <string>,
      "CloudTags": {
        "<key1>": "<value1>",
        "<key2>": "<value2>",
      },
      "RiskScore": <integer>,
      "Region": <string>,
      "Service": <string>
    }
  },
  "autoRemediate": <boolean>
}

日志记录

所有stdout和stderr日志会发送到Secure State Web应用，用于在用户界面中显示。日志记录时需注意，不要记录敏感数据。

支持的修复任务

下表列出所有支持的任务及其链接：

贡献指南

Secure State团队欢迎社区贡献。如果您希望贡献代码且尚未签署贡献者许可协议(CLA)，我们的机器人会在您提交Pull Request时更新相关问题。有关CLA流程的任何问题，请参考我们的https://cla.vmware.com/faq%E3%80%82

本仓库的所有贡献必须按照该页面所述进行签署。您的签名证明您编写了补丁或有权将其作为开源补丁传递。

有关详细信息，请参阅CONTRIBUTING.md。

仓库管理员资源

委员会成员

委员会成员是来自社区的志愿者和VMware员工，不对因运行本仓库示例而可能发生的任何问题负责。

成员：

• Paul Allen (VMware)

VMware 资源

• VMware Secure State
• https://code.vmware.com/home
• https://communities.vmware.com/community/vmtn/developer

反馈

如发现错误，请提交https://github.com/vmware-samples/secure-state-remediation-jobs/issues%E3%80%82