calebc-c/SOAR
GitHub: calebc-c/SOAR
为Cortex XSOAR平台提供开箱即用的安全编排与自动化内容包,包含Playbook、集成和脚本,并内置CI/CD流水线支持自动化验证与部署。
Stars: 0 | Forks: 0
# SOAR
用于 **Cortex XSOAR** 的安全编排、自动化与响应(SOAR)内容。
## 结构
内容以 XSOAR 内容包的形式组织,位于 `Packs/` 下:
```
Packs/
└── /
├── pack_metadata.json # Pack info, version, author
├── Playbooks/ # Playbook YAML files
├── Integrations/ # Integration code + YAML
├── Scripts/ # Automation scripts
├── IncidentTypes/ # Incident type definitions
├── IncidentFields/ # Custom incident fields
├── Layouts/ # Incident layouts
├── TestPlaybooks/ # Test playbooks
└── ReleaseNotes/ # Changelog per version
```
## 流水线
CI/CD 流水线会在 Pull Request 和推送到 `main` 分支时自动运行:
| Job | Trigger | Description |
|-----|---------|-------------|
| Lint | PR + push | yamllint + demisto-sdk lint |
| Validate | PR + push | demisto-sdk validate + pack metadata checks |
| Coverage Report | PR only | Playbook & integration summary posted as PR comment |
| Deploy | Push to main | `demisto-sdk upload` to XSOAR instance |
## 设置
### 部署所需的 GitHub Secrets
| Secret | Description |
|--------|-------------|
| `XSOAR_URL` | XSOAR 实例的基础 URL(例如 `https://xsoar.yourdomain.com`) |
| `XSOAR_API_KEY` | XSOAR API 密钥(Settings → API Keys) |
### 添加新 pack
1. 使用上述结构创建 `Packs//`
2. 填写 `pack_metadata.json`
3. 添加 playbooks/integrations/scripts
4. 提交一个 PR — 流水线将自动验证并报告
5. 合并到 `main` 以部署到 XSOAR
## 工具
- [demisto-sdk](https://github.com/demisto/demisto-sdk) — 官方 XSOAR CLI,用于 validate、lint、upload
标签:Cortex XSOAR, Demisto, demisto-sdk, DevSecOps, Incident Response, Playbook, Python, SOAR, YAML, 上游代理, 安全剧本, 安全库, 安全编排与自动化响应, 安全运营, 安全集成, 扫描框架, 无后门, 逆向工具