Allstar 是安装在组织或存储库上的 GitHub 应用程序,用于设置和实施安全策略。其目标是能够持续监控和检测任何可能有风险或不遵循安全最佳实践的 GitHub 设置或存储库文件内容。如果 Allstar 发现存储库不合规,它将采取措施,例如创建问题或恢复安全设置。
具体策略高度可配置,以尽量满足不同项目社区和组织的需求。此外,制定和贡献新政策也很容易。Allstar 是在 OpenSSF 组织下开发的,作为保护关键项目工作组的一部分。
快速开始
在您的组织和存储库上安装 Allstar GitHub 应用程序。安装 Allstar 时,您可以查看请求的权限。Allstar 要求对大多数设置和文件内容进行读取访问,以检测安全合规性。它请求对问题的写访问权限以创建问题,并检查以允许block
操作。
启用配置
Allstar 可以在应用程序级别的单个存储库上启用,可以选择单独启用或禁用每个安全策略。对于组织级别的配置,创建一个以.allstar
命名的存储库。然后在该存储库中创建一个名为 allstar.yaml 的文件。
Allstar 可以设置为选择加入或选择退出策略。在选择加入中,仅启用那些明确列出的存储库。在选择退出中,所有存储库都已启用,并且需要明确添加存储库以选择退出。Allstar 默认设置为选择加入,因此安装后不会立即在任何存储库上启用。要继续使用默认的选择加入策略,请列出要在您的组织中启用的 Allstar 的存储库,如下所示:
optConfig:
optInRepos:
- repo-one
- repo-two
要切换到选择退出策略(推荐),请将该选项设置为 true:
optConfig:
optOutStrategy: true
如果您要在除少数存储库之外的所有存储库上启用 Allstar,您可以使用选择退出并列出要禁用的存储库:
optConfig:
optOutStrategy: true
optOutRepos:
- repo-one
- repo-two