privateerproj/privateer
GitHub: privateerproj/privateer
Privateer 是一个插件化的安全与合规性验证框架,帮助基础设施工程师自动化地对软件资产进行批量合规检查。
Stars: 23 | Forks: 9
# pvtr
**pvtr** 是一个验证框架,旨在简化基础设施测试和合规性验证。pvtr 专为基础设施工程师打造,可帮助加速任何软件资产的安全和合规性验证。
## 主要特性
- **社区驱动的插件**:插件由社区协作制作和维护,或在您的组织内部私下进行
- **全面的资源验证**:在一次执行中验证各种资源,无论您需要排队多少个资源或验证
- **一致的机器可读输出**:标准化的输出简化了自动化和集成
- **插件生成**:只需轻点按钮,即可从 [Gemara](https://gemara.openssf.org) Layer 2 schema 目录生成插件脚手架
## 快速开始
**如需详细的生态系统文档,请访问 [privateerproj.com](https://privateerproj.com)**
### 步骤 2:选择您的安装方式
#### 选项 1:通过 Homebrew 安装
```
brew install privateerproj/tap/pvtr
```
#### 选项 2:通过脚本安装
```
/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/privateerproj/privateer/main/install.sh)"
```
#### 选项 3:从 Releases 下载
从 [GitHub Releases](https://github.com/privateerproj/privateer/releases) 下载最新版本。
#### 选项 4:从源码构建
```
git clone https://github.com/privateerproj/privateer.git
cd privateer
go mod tidy
make build
```
### 步骤 3:选择您的插件
我们目前没有维护权威的社区插件列表,但一个不错的起点是 OpenSSF 的 [插件](https://github.com/revanite-io/pvtr-github-repo),它用于根据《开源项目安全基线》扫描 GitHub 仓库。
### 步骤 4:安装并验证您的插件
目前插件安装由用户自行决定。插件二进制文件的默认位置是 `$HOME/.privateer/bin`。如果您将插件安装在其他位置,可以在运行时通过 `--binaries-path` 指定不同的路径。
要查看已安装的插件,请运行 `pvtr list -a`。
### 本地开发前置条件
- **Go 1.25.1 或更高版本** - 构建 pvtr 和运行测试所需
- **Make** - 用于使用 Makefile 构建目标
### 测试
运行所有测试:
```
make test
```
运行测试并生成覆盖率报告:
```
make testcov
```
### 可用的 Make 目标
- `make binary` - 构建二进制文件
- `make test` - 运行测试和 vet 检查
- `make testcov` - 运行测试并生成覆盖率报告
- `make tidy` - 清理 go.mod 依赖项
- `make release` - 为所有平台构建发布版二进制文件
- `make build` - `tidy test binary` 的别名
### 项目结构
```
privateer/
├── cmd/ # CLI commands (run, list, generate-plugin, etc.)
├── test/ # Test data and fixtures
├── build/ # Build scripts and CI configurations
├── main.go # Application entry point
└── go.mod # Go module dependencies
```
## 安全性
有关漏洞报告,请参阅我们的[安全策略](https://github.com/privateerproj/privateer?tab=security-ov-file)。如有安全问题,请搜索我们已关闭的 issue,如果您的问题尚未得到解答,请打开一个新 issue。
## 相关链接
- **[Privateer SDK](https://github.com/privateerproj/privateer-sdk)** - 用于开发 pvtr 插件的 SDK
- **[Privateer 文档](https://privateerproj.com)** - 完整的文档站点
- **[示例插件](https://github.com/privateerproj/raid-wireframe)** - 参考实现
标签:EVTX分析, Go, Ruby工具, 基础设施测试, 安全合规, 插件框架, 文档结构分析, 日志审计, 网络代理