semgrep-rules

欢迎！此仓库包含 Semgrep 的 社区版规则。

除了此仓库中的规则，Semgrep Registry 还提供专有的 Pro 规则，提供额外的语言覆盖，并解锁跨文件和深度数据流分析。

• 查找规则：通过 Semgrep Registry 搜索 搜索社区版和 Pro 规则。
• 使用规则：通过 Semgrep AppSec Platform 使用这些规则扫描你的代码。
• 贡献规则：参见 为 Semgrep 规则做贡献 了解更多信息。

使用 Semgrep 规则仓库

要开始编写和使用 Semgrep 规则，请参阅 学习 Semgrep 语法 和 编写规则。然后，使用 Semgrep 命令行界面（Semgrep CLI） 在本地运行现有和自定义的 Semgrep 规则，或在使用 Semgrep AppSec Platform 时在 CI 中持续运行 Semgrep。

编写 Semgrep 规则

参见 编写规则 了解以下信息：

• 模式语法，详细描述 Semgrep 模式可以做什么，以及省略号运算符、元变量的示例用例。
• 规则语法，描述 Semgrep YAML 规则文件，这些文件可以有多个模式、详细的输出消息和自动修复。该语法允许使用布尔运算符组合单个模式。

你还可以通过基于示例的交互式 Semgrep 规则教程学习如何编写规则。

贡献

我们欢迎直接向此仓库贡献 Semgrep 规则！提交贡献时，您授予 Semgrep, Inc. 根据 Semgrep 规则许可证 v. 1.0 使用、修改和分发您的贡献的许可。这确保您的规则可以与其他 Semgrep Registry 用户共享。

要贡献，请查阅我们的 为 Semgrep 规则做贡献 指南。

你也可以通过 [email protected] 联系我们，我们会帮助导入您的规则供其他人使用！

附加信息

帮助

加入 Slack 以获得最快的问题解答！或通过 [email protected] 联系团队。

用于运行测试的 GitHub Action

如果你 fork 此仓库或创建自己的仓库，可以将一个 GitHub Action 添加到你的工作流程中，它将使用最新版本的 Semgrep 自动测试你的规则。参见我们的 semgrep-rules-test 示例。

规则集

规则集是按用途、语言或框架组织的规则组，来源于 Semgrep Registry。如果你想修改现有规则集或创建自己的规则集，请通过 [email protected] 联系我们。