semgrep-rules

Welcome! This repository contains Semgrep's Community Edition rules.

In addition to the rules in this repository, the Semgrep Registry offers proprietary Pro rules that offer additional language coverage, and unlock crossfile and deep dataflow analysis.

• Find rules: search for Community Edition and Pro rules through the Semgrep registry search.
• Use rules: Scan your code with these rules through Semgrep AppSec Platform
• Contribute to rules: see Contributing to Semgrep rules for more information.

Using the Semgrep rules repository

To start writing and using Semgrep rules, see Learn Semgrep syntax and Writing rules. Then, run existing and custom Semgrep rules locally with the Semgrep command line interface (Semgrep CLI) or continuously with Semgrep in CI while using Semgrep AppSec Platform.

Writing Semgrep rules

See Writing rules for information including:

• Pattern syntax, describing what Semgrep patterns can do in detail, and example use cases of the ellipsis operator, metavariables.
• Rule syntax, describing Semgrep YAML rule files, which can have multiple patterns, detailed output messages, and autofixes. The syntax allows the composition of individual patterns with boolean operators.

You can also learn how to write rules using the interactive, example-based Semgrep rule tutorial.

Contributing

We welcome Semgrep rule contributions directly to this repository! When submitting your contribution, you grant Semgrep, Inc. a license to use, modify, and distribute your contribution under the Semgrep Rules License v. 1.0. This ensures your rule can be shared with other Semgrep Registry users.

To contribute, please review our Contributing to Semgrep rules guidelines.

You can also reach out to us at [email protected], and we will help import your rules for others to use!

Additional information

Help

Join Slack for the fastest answers to your questions! Or contact the team at [email protected].

GitHub action to run tests

If you fork this repository or create your own, you can add a GitHub Action to your workflow that will automatically test your rules using the latest version of Semgrep. See our semgrep-rules-test example.

Rulesets

Rulesets are groups of rules organized by purpose, language, or framework sourced from the Semgrep Registry. If you want to modify existing rulesets or create your own, please contact us at [email protected].