Checkmarx/ast-github-action

AST-GITHUB-ACTIONS

探索文档 »

报告 Bug · 请求功能

目录

1. 概述
2. 主要功能
3. 前置条件
4. 入门指南
5. 用法
6. 贡献
7. 许可证
8. 联系方式

# 概述 **Checkmarx One** **GitHub Action** 使您能够直接从 GitHub workflow 触发 Checkmarx One 扫描。它封装了 [Checkmarx One CLI Tool](https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html)，该工具会从您的源代码仓库创建一个 zip 压缩包，并将其上传到 Checkmarx One 进行扫描。该 Github Action 提供了与 GitHub 的轻松集成，同时利用 CLI 工具的完整功能和灵活性实现扫描自定义。 可以自定义 GitHub Action，以便在您 repo 的特定分支上发生特定操作（例如 push 或 pull request）时触发扫描。您还可以向 workflow 添加扫描前和扫描后的步骤。例如，您可以添加一个步骤来筛选 commits，以验证所做的更改是否需要运行新的扫描。 插件代码可以在[这里](https://github.com/CheckmarxDev/ast-github-action)找到。 ## 主要功能 - 自动从 GitHub workflow 触发扫描，运行所有 Checkmarx One 扫描器：CxSAST、CxSCA、IaC Security、Container Security、API Security、Secret Detection 和 Repository Health (OSSF Scorecard)。 - 支持使用 CLI 参数自定义扫描配置，使您能够： - 自定义过滤器以指定扫描哪些文件夹和文件 - 应用预设查询配置 - 使用 [SCA Resolver](https://checkmarx.com/resource/documents/en/34965-19196-checkmarx-sca-resolver.html) 自定义 SCA 扫描 - 设置阈值以中断构建 - 在 GitHub 构建日志中显示扫描结果摘要 - 在违反策略时中断构建 - 支持生成集成到 GitHub Security alerts 中的报告 - 用有关新发现的漏洞以及代码更改修复的漏洞的信息来装饰 pull requests ## 前置条件 - 您项目的源代码托管在 GitHub repo（公开或私有）上 - 您拥有 Checkmarx One 账户，并且拥有该账户的 OAuth **Client ID** 和 **Client Secret**。要创建 OAuth client，请参阅 [Creating an OAuth Client for Checkmarx One Integrations](https://checkmarx.com/resource/documents/en/34965-118315-authentication-for-checkmarx-one-cli.html#UUID-a4e31a96-1f36-6293-e95a-97b4b9189060_UUID-4123a2ff-32d0-2287-8dd2-3c36947f675e)。 ## 入门指南 1. 验证所有前置条件均已具备。 2. 为 Checkmarx One 身份验证配置 GitHub secrets，如[此处](https://checkmarx.com/resource/documents/en/34965-68703-checkmarx-one-github-actions-initial-setup.html)所述。 3. 使用 Checkmarx One workflow 配置 GitHub Action，如[此处](https://checkmarx.com/resource/documents/en/34965-68704-configuring-a-github-action-with-a-checkmarx-one-workflow.html)所述。 ## 反馈 我们很乐意听取您的反馈！如果您遇到 bug 或有功能请求，请通过在 [GitHub Issues](https://github.com/Checkmarx/ast-github-action/issues) 中提交 issue 告知我们。 ## 用法 要了解如何使用我们的工具，请参阅[文档](https://checkmarx.com/resource/documents/en/34965-68702-checkmarx-one-github-actions.html) ## 贡献 我们感谢对该 Github Action 的反馈和贡献！在开始之前，请查看以下内容： - [Checkmarx 贡献指南](docs/contributing.md) - [Checkmarx 行为准则](docs/code_of_conduct.md) ## 许可证 根据 [Apache 2.0](LICENSE) 分发。有关更多信息，请参阅 `LICENSE`。 ## 联系方式 Checkmarx - AST Integrations Team 项目链接：[https://github.com/Checkmarx/ast-github-action](https://github.com/Checkmarx/ast-github-action) 在[这里](https://github.com/Checkmarx/ci-cd-integrations#checkmarx-ast-integrations)查找我们团队的更多集成 © 2022 Checkmarx Ltd. All Rights Reserved.

标签：Checkmarx, Checkmarx One, CI/CD 安全, CLI 封装, DevSecOps, GitHub Actions, GitHub 工作流, IaC 安全, LLM应用, SAST, 上游代理, 安全合规, 数据投毒防御, 文档安全, 盲注攻击, 结构化查询, 网络代理, 自动化安全, 自动笔记, 软件供应链安全, 远程方法调用, 错误基检测, 静态代码分析