RecordedFuture-ProfessionalServices/ps-banshee
GitHub: RecordedFuture-ProfessionalServices/ps-banshee
PS Banshee 是一款命令行工具,为安全专业人员提供对 Recorded Future 威胁情报平台的快速访问与自动化操作能力。
Stars: 5 | Forks: 0
# PS Banshee
**PS Banshee** 是一款命令行界面 (CLI) 工具,旨在提供对 Record Future Intelligence 的快速高效访问。PS Banshee 专为安全专业人士打造,可帮助简化调查流程并自动化常见的 security operations 任务。
## 核心功能
- 电子邮件 (EML) enrichment
- IOC 查询与搜索
- Packet capture (pcap) enrichment
- Recorded Future Alert 搜索、查询、更新与导出
- Recorded Future Detection Rules (YARA, Snort, Sigma) 搜索与下载
- Recorded Future Entity 搜索与查询
- Recorded Future List 与 Watch List 管理
- Recorded Future Playbook Alert 搜索、查询、更新与导出
- Recorded Future Risk List 下载与创建
## 安装说明
PS Banshee 已在 [PyPI](https://pypi.org/project/ps-banshee/) 上发布,可以使用 `pip` 或 `pipx` 进行安装。
### 推荐:pipx(隔离环境)
运行以下命令进行全局安装:
```
pipx install ps-banshee
```
### 替代方案:pip(当前环境)
运行以下命令在当前环境中安装:
```
pip install ps-banshee
```
### 依赖项
`pipx` 会自动解析所有 Python 依赖项。
如果您想使用 `pcap` 命令,还需要:
- tshark 3.0.0 或更高版本
### 命令自动补全
安装 PS Banshee 后,您可以启用命令自动补全:
```
banshee --install-completion
```
重启您的 shell 以完成安装。现在您可以使用 TAB 键来自动补全命令了。
## 使用说明
运行以下命令查看可用命令列表:
```
banshee -h
```
### 授权
PS Banshee 会从 `RF_TOKEN` 环境变量(推荐)读取您的 Recorded Future API key,或者从每个命令的 `-k` / `--api-key` flag 中读取。
#### 选项 1:设置 `RF_TOKEN`(推荐)
**macOS / Linux**
仅对当前 shell 生效:
```
export RF_TOKEN=
```
永久生效于未来的 shell(zsh —— 如果使用 bash,请相应修改为 `~/.bashrc`)。运行此命令后请打开一个新的 shell(或者运行 `source ~/.zshrc` 以在当前 shell 中生效):
```
echo 'export RF_TOKEN=' >> ~/.zshrc
```
**Windows (PowerShell)**
仅对当前会话生效:
```
$env:RF_TOKEN = ''
```
永久生效于未来的会话(运行此命令后请打开一个新的 PowerShell):
```
setx RF_TOKEN
```
**Windows (命令提示符)**
仅对当前会话生效:
```
set RF_TOKEN=
```
永久生效于未来的会话(运行此命令后请打开一个新的命令提示符):
```
setx RF_TOKEN
```
#### 选项 2:在每个命令中通过 `-k` 传递
```
banshee -k
```
此方法适用于任何平台,但较为繁琐,且 key 可能会被记录在 shell 历史记录中。
### 代理
如果您在 proxy 环境下,请设置 `HTTP_PROXY` 和 `HTTPS_PROXY` 环境变量。
使用 `-s` flag 可禁用 SSL 验证:
```
banshee -s ca rules
```
### 命令帮助
所有命令均支持 `--help` (`-h`) 选项:
```
banshee -h
banshee ca --help
banshee ioc lookup --help
banshee list bulk-add -h
```
## 支持
请提交 [支持请求](https://support.recordedfuture.com/hc/en-us/requests/new) 获取帮助,或者联系 [support@recordedfuture.com](mailto:support@recordedfuture.com)。
**PS Banshee 由 Recorded Future Professional Services Cyber Security Engineers 开发和维护 🚀**
标签:API集成, Blue Team, Python, 可观测性, 威胁情报, 安全运营, 开发者工具, 扫描框架, 文档结构分析, 无后门, 网络调试, 自动化, 逆向工具