Lightweight static analysis for many languages. Find bug variants with patterns that look like source code.
Project description
Lightweight static analysis for many languages.
Find bugs and enforce code standards.
Semgrep is a fast, open-source, static analysis tool for finding bugs and enforcing code standards at editor, commit, and CI time. Get started →.
Semgrep analyzes code locally on your computer or in your build environment: code is never uploaded.
Its rules look like the code you already write; no abstract syntax trees, regex wrestling, or painful DSLs. Here's a quick rule for finding Python print() statements, run it online in Semgrep's Playground by clicking the image:
The Semgrep ecosystem includes:
- Semgrep - the open-source command line tool at the heart of everything (this project)
- Semgrep CI - a specialized Docker image for running Semgrep in CI environments
- Semgrep Playground - an online interactive rule builder for writing and sharing rules
- Semgrep Registry - 1,000+ community-driven rules covering security, correctness, and performance bugs
- Semgrep App - deploy, manage, and monitor Semgrep at scale with free and paid tiers.
Join 100,000 other developers and security engineers already using Semgrep at companies like Chef, Dropbox, Figma, HashiCorp, Snowflake, and Trail of Bits. Also check out tools powered by Semgrep!
Semgrep is developed and commercially supported by r2c, a software security company.
Language support
General availability
C# · Go · Java · JavaScript · JSX · JSON · Python · Ruby · Scala · TypeScript · TSX
Beta & experimental
See supported languages for the complete list.
Getting started
To install Semgrep use Homebrew or pip, or run without installation via Docker:
# For macOS
$ brew install semgrep
# For Ubuntu/WSL/Linux/macOS
$ python3 -m pip install semgrep
# To try Semgrep without installation run via Docker
$ docker run --rm -v "${PWD}:/src" returntocorp/semgrep
Once installed, Semgrep can run with single rules or entire rulesets. Visit Docs > Running rules to learn more or try the following:
# Check for Python == where the left and right hand sides are the same (often a bug)
$ semgrep -e '$X == $X' --lang=py path/to/src
# Fetch rules automatically by setting the `--config auto` flag.
# This 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.
$ semgrep --config auto
Visit the full documentation to learn more.
Rule examples
Visit Docs > Rule examples for use cases and ideas.
| Use case | Semgrep rule |
|---|---|
| Ban dangerous APIs | Prevent use of exec |
| Search routes and authentication | Extract Spring routes |
| Enforce the use secure defaults | Securely set Flask cookies |
| Tainted data flowing into sinks | ExpressJS dataflow into sandbox.run |
| Enforce project best-practices | Use assertEqual for == checks, Always check subprocess calls |
| Codify project-specific knowledge | Verify transactions before making them |
| Audit security hotspots | Finding XSS in Apache Airflow, Hardcoded credentials |
| Audit configuration files | Find S3 ARN uses |
| Migrate from deprecated APIs | DES is deprecated, Deprecated Flask APIs, Deprecated Bokeh APIs |
| Apply automatic fixes | Use listenAndServeTLS |
Extensions
Visit Docs > Extensions to learn about Semgrep in your editor or pre-commit. When integrated into CI and configured to scan pull requests, Semgrep will only report issues introduced by that pull request; this lets you start using Semgrep without fixing or ignoring pre-existing issues!
Documentation
Browse the full Semgrep documentation on the website. If you’re new to Semgrep, check out Docs > Getting started or the interactive tutorial.
Metrics
Using remote configuration from the Registry (like --config=p/ci) reports pseudonymous rule metrics to semgrep.dev.
Using configs from local files (like --config=xyz.yml) does not enable metrics.
To disable Registry rule metrics, use --metrics=off.
PRIVACY.md describes the principles that guide data-collection decisions and the breakdown of the data that are and are not collected when the metrics are enabled.
More
- Frequently asked questions (FAQs)
- Contributing
- Build instructions for developers
- Ask questions in the r2c Community Slack
- CLI reference and exit codes
- r2c YouTube channel with Semgrep presentation videos
- License (LGPL-2.1)
Upgrading
To upgrade, run the command below associated with how you installed Semgrep:
# Using Homebrew
$ brew upgrade semgrep
# Using pip
$ python3 -m pip install --upgrade semgrep
# Using Docker
$ docker pull returntocorp/semgrep:latest
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file semgrep-0.97.0.tar.gz.
File metadata
- Download URL: semgrep-0.97.0.tar.gz
- Upload date:
- Size: 164.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d94b1d31d655dc76004bc903062d989df3ba4278601218b801d5803f96d63f88 |
|
| MD5 | 1c34c12a341fee214cba67633f5171ed |
|
| BLAKE2b-256 | a27ca0d9282883d5a3f47888feebce640ec5034571716623f210579650235523 |
File details
Details for the file semgrep-0.97.0-cp37.cp38.cp39.py37.py38.py39-none-macosx_11_0_arm64.whl.
File metadata
- Download URL: semgrep-0.97.0-cp37.cp38.cp39.py37.py38.py39-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 23.3 MB
- Tags: CPython 3.7, CPython 3.8, CPython 3.9, Python 3.7, Python 3.8, Python 3.9, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de51a13a753537ac2ddd5ae95276fc4f21f7ff0ae8563be3282cf4968be62728 |
|
| MD5 | 54066b518e403d45e904816bd8636597 |
|
| BLAKE2b-256 | a972b5e9e04963cc3e0c97d0c8da4c4bc5ec66d3bfc8ef5a8d6391d9b43ad9bd |
File details
Details for the file semgrep-0.97.0-cp37.cp38.cp39.py37.py38.py39-none-macosx_10_14_x86_64.whl.
File metadata
- Download URL: semgrep-0.97.0-cp37.cp38.cp39.py37.py38.py39-none-macosx_10_14_x86_64.whl
- Upload date:
- Size: 20.4 MB
- Tags: CPython 3.7, CPython 3.8, CPython 3.9, Python 3.7, Python 3.8, Python 3.9, macOS 10.14+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b9827571bdd6217d1af0d986d1939ef7b831bb3824c60d277bf21c1303356789 |
|
| MD5 | ce555bdfe104159e3b3f42d29653d5b8 |
|
| BLAKE2b-256 | 6fcf05aff1b90b15839724e6874f7337ba8c2211db6cb86a9c5fda95d9f79300 |
File details
Details for the file semgrep-0.97.0-cp37.cp38.cp39.py37.py38.py39-none-any.whl.
File metadata
- Download URL: semgrep-0.97.0-cp37.cp38.cp39.py37.py38.py39-none-any.whl
- Upload date:
- Size: 23.5 MB
- Tags: CPython 3.7, CPython 3.8, CPython 3.9, Python 3.7, Python 3.8, Python 3.9
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b4d817c286ff5b1fd002a115cda1dbba534c272ef9970b44fc5b1d26000fb21b |
|
| MD5 | 230cb892797c0646b14a8b528d5bb8e1 |
|
| BLAKE2b-256 | 44390c711f3966d7d6b5c8a0b7e2f3979015d8c42d2dfb689add4d41478ee46b |
