| branch | using semgrep docker image | test status |
|---|---|---|
develop |
returntocorp/semgrep:develop |
 |
Welcome! This repository is the “standard library” for Semgrep rules, but there are many more written by r2c and other contributors available in the Semgrep Registry. If there a specific rule you are looking for, you can also search the Semgrep registry here.
We recommend starting with semgrep --config auto. The --config auto flag will fetch rules relevant to your project from Semgrep Registry. The name of your project will be sent to Semgrep Registry as an identifier to make selecting relevant rules fast next time; source code will not be uploaded.
Alternatively, you can start with a pre-selected subset of rules that has already been carefully tuned for precision. These subsets of rules, which we call rulesets, may include rules not present in this repository. However, they are available for free on the Semgrep Registry. These rules have been written by open-source contributors and r2c.
If you are determined to drink from the firehose, you can also pull directly from the registry by specifying r/<foldername.subfolder.etc>. So to run all the Python Flask rules from the python/flask directory in this repo, just run:
semgrep --config=r/python.flask
Semgrep releases new versions very frequently and the rules in this repo are always updated to take advantage of new features or fix breaking changes on new releases. For that reason, we suggest that you avoid stale copies of registry rules.
We welcome Semgrep rule contributions directly to this repository! Since this repo is maintained by r2c, there are some extra benefits-for example, if there are bug reports for your rule, we’ll take responsibility to help fix it. If you are submitting to the semgrep-rules repo (rather than your own, separate repository as mentioned above) we’ll ask you to make r2c a joint owner of your contributions. While you still own copyright rights to your rule, joint ownership allows r2c to license these contributions to other Semgrep Registry users pursuant to the LGPL 2.1 under the Commons Clause. Check out the Contributing Guidelines to get started.
You can also contact us at [email protected] to make Semgrep rule contributions. We will import your rules for everyone to use!
Rulesets -- combined sets of rules from the Semgrep registry -- are organized in a private repository. If you want to modify existing sets or create your own, please contact us at [email protected].
If you have more questions, please see the FAQ section in the Semgrep docs.
Join Slack for the fastest answers to your questions! Or contact the team at [email protected].
The namespacing format for contributing rules is <language>.<framework>.<category>.$MORE. If a framework isn't applicable, use lang instead.
category is one of:
- security
- correctness
- best-practice
- maintainability
- performance
If a security rule is discouraging the use of a bad pattern (such as formatted SQL strings), we recommend appending audit to your namespace. This distinguishes it from a security rule that is specifically aiming to detect a vulnerability.
If you fork this repo or create your own, you can add a special semgrep-rules-test Github Action to your workflow that will automatically test your rules by running make test using the latest version of semgrep.
See ours here
The benchmark job runs every weekend. It uploads a few artifacts, which can be downloaded. If you download the test logs, there are two relevant pieces of information in there: the benchmark table, which roughly shows the performance of every rule that completes in under 60 seconds, and any failed tests are rules that did not complete within 60 seconds.
To run benchmark tests locally, do the following from the root of semgrep-rules:
pipenv shell
pipenv install --dev
export PYTHONPATH=.
pytest --timeout=60 --rule-directory=[path_to_rule_directory] --git-repo=[git_URL] tests/performance/test_public_repos.py
If you omit --git-repo from the pytest command, it will run the provided benchmark repo.