Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.semgrep.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
General

​
Semgrep Community Edition (CE)

Semgrep CE is a free, community-supported code scanning tool. It’s perfect for individuals, security auditors, and penetration testers who need fast, one-off scans. You can use it at work, on private and proprietary code, no problem!Semgrep CE includes:Semgrep offers three paid products, designed for Application Security teams to use in production:
  • Semgrep Code, a static application security testing (SAST) tool that can perform taint, cross-file, and cross-function analysis.
  • Semgrep Supply Chain, which performs dependency scanning.
  • Semgrep Secrets, which can detect and validate leaked secrets in code.

​
Semgrep Rules

All Semgrep maintained rules are licensed under the Semgrep Rules License v. 1.0. The source for these rules is available at the semgrep/semgrep-rules repository.These rules can only be used for internal business purposes. These rules cannot be resold without permission from Semgrep, Inc. (“Semgrep”). Since Semgrep offers a paid, hosted application, it’s important to have this restriction so other companies cannot resell Semgrep’s rules as a competing service.
Yes! Semgrep is safe to run on your private code. The Semgrep Rules License v. 1.0 restrictions only come into effect if you are selling a product using rules provided in the Semgrep Registry. If that’s the case, contact partnerships@semgrep.com to learn more.
The Semgrep Registry can import rules from sources other than the semgrep/semgrep-rules repository, such as Trail of Bits. These rules have their own licenses.
If you are a security consultant and you want to use Semgrep CE as part of your assessments, that’s great and you don’t have to pay. Feel free to refer your clients to our Semgrep product suite.If your service delivers code scanning, meaning a service that includes static application security testing (SAST), software composition analysis (SCA), or secrets scanning, and you want to charge for scanning that includes rules in the semgrep-rules repository, you must purchase a license.If you want to use Semgrep Code, including its proprietary cross-file (interfile) analysis, Semgrep Supply Chain (SCA), or Semgrep Secrets rules as part of your consulting services, you need a license. Please contact us at partnerships@semgrep.com.
Because Semgrep CE is licensed under the GNU Lesser General Public License v2.1, you can ship your own code analysis software using Semgrep CE without an explicit license from Semgrep, Inc.
All users can contact Semgrep support. Regardless if you are a free tier or paid tier user, reach our support through the Semgrep Community Slack. Paying Semgrep Team tier customers receive 8*5 email and Slack support with committed SLAs. See Support for more details.
Embed a special version of Semgrep Playground with an iframe. The source is https://semgrep.dev/embed/editor?snippet=<snippet-id> where the snippet-id is either the short identifier generated when you share a Playground link (this usually looks like DzKv) or the named identifier from a saved rule (this usually looks like username:rule-name).
<iframe
  title="Semgrep example no prints"
  src="https://semgrep.dev/embed/editor?snippet=KPzL"
  width="100%"
  height="432"
  loading="lazy"
  frameborder="0"
></iframe>
Semgrep is semantic grep for code: it understands the structure of code and builds a syntax tree to search for matches. Where grep "2" only matches the exact string 2, Semgrep matches other equivalent forms, such as x = 1; y = x + 1 when searching for 2. Semgrep’s pattern syntax provides specific mechanisms to fine-tune matches, such as the ellipsis operator and metavariables.See the following rule for a more complex example illustrating Semgrep features:
  • It uses typed metavariables so it can specify the type http.Request.
  • In the sink, the rule tracks imports down to function usage.
  • In the sanitizer, it removes type aware Booleans and a string convert function.
  • It leverages regex only to reduce how many patterns to write for finding dangerous functions.

​
Comparisons

Semgrep provides a simple syntax for writing rules: if you can write code, you can write a Semgrep rule—no program analysis Ph. D. required!To the Semgrep team’s knowledge, the only other tool with the explicit goal of allowing custom rules is GitHub’s proprietary tool, CodeQL. CodeQL has a domain-specific language that is extremely powerful but is designed for those with significant program analysis expertise, whereas Semgrep is designed for the security engineer or developer who wants to automate code review. Our goal is to make writing a Semgrep rule as easy as copying the code you want to find and providing it to Semgrep. Then the Semgrep Engine creates the rule and provides a high-quality, Rule-defined fix that runs in CI, your text editor, or your IDE.Semgrep AppSec Platform provides a Team tier that is free for up to 10 contributors on private repositories. It offers a hosted CI integration with a quick setup so you can start running Semgrep right away.Semgrep’s diff-awareness lets you scan new code and doesn’t force you to fix all the existing issues when you first start. For users running inside organizations with many repositories, the hosted offering also offers a policy and notification system that makes it easy to tune Semgrep so that it only reports issues or suggests fixes that get applied.Our goal is a 99% fix rate for what Semgrep reports.

​
Speedy and offline: Semgrep runs offline on every keystroke

If you are shipping code daily a code analysis tool that takes a week to run is not helpful. We think modern static analysis tools should run on every keystroke in the editor, without needing network access. Semgrep runs at approximately 20K-100K loc/sec per rule but our goal is to be even faster.

​
Semantic: Semgrep is smart

Semgrep automatically handles the nuance of “there’s more than one way to do it”: you write your query and all equivalent variations of that code are automatically matched.As Semgrep evolves, queries similar to foo("password") become smarter. In the original version of Semgrep, this query would only match the code foo("password"). But a few months after release Semgrep would match const x = "password"; foo(x).Today Semgrep can do even more with intraprocedural dataflow analysis, and we’re working on adding more of these semantic features with every release.

​
Integrated: Semgrep understands Git

It’s easy to write a new Semgrep rule and have it only apply going forward. You can ignore findings of course, but we have built-in support for this with Semgrep AppSec Platform and various repository integrations.

​
Portable: If you write a Semgrep rule, it runs anywhere

Many other tools require a buildable environment or can only be run in a VM. Semgrep runs “on the metal” and has minimal dependencies around a statically linked core; our parsers are declaratively generated C libraries (we contribute to and use tree-sitter).See the Semgrep philosophy for further reading.
Similar to a linter, Semgrep can be run in your developer’s IDE. Semgrep has three IDE extensions:Linters use static analysis but typically have a narrower scope for analysis (most rules typically operate on a single line). Some linters also cover stylistic decisions (for example use of tabs versus spaces), but Semgrep doesn’t care about whitespace or formatting.Semgrep’s registry includes rulesets inspired by the rules of many popular linters and checkers, including ESLint, RuboCop, Bandit, and FindSecBugs. But Semgrep also allows you to enable multiple rulesets at the same time without adding linter-specific artifacts or installation to your code repository.Some popular linter tools may use tools like Semgrep as an internal engine, and we encourage this! For instance, the popular scanner NodeJSScan was re-written to use Semgrep as the core.Lastly, while many linters are extensible, you need to learn specific abstract syntax tree (AST) based patterns for writing custom rules. Semgrep works across languages and you learn its syntax once; you don’t have to mess with MemberExpressions, node visitors, and all that. Before Semgrep, many of us on the maintainer team were writing AST-based rules as well: one of us wrote an article comparing writing linter rules to Semgrep expressions.
See how Semgrep compares to:

​
Privacy and Security

Semgrep, Inc uses Amazon Web Services (US region) for storing customer data.
All customer data is located in AWS (US region). Amazon RDS encrypted database instances use industry-standard AES-256 encryption and TLS 1.2 or higher is used for all data-in-transit.
When Semgrep runs entirely in CI, your source code stays in the environment. Only run metadata is sent to Semgrep’s service (see the next question).Some Semgrep features, such as Semgrep Managed Scans and Semgrep Multimodal, require code access. See Security for more information on how Managed Scans use your code and Multimodal’s Data privacy and legal considerations to understand how your code is stored and retained.
Semgrep sends data to Semgrep AppSec Platform in accordance with the metrics policy.These types of data include scan data and findings data.
  • Scan data includes project name, CI environment, and scan meta-data.
  • Findings data are used to provide human-readable content for notifications and integrations, as well as tracking results as new, fixed, or duplicate.
For more information and a detailed description of each data field, refer to the relevant section in metrics.md.
Semgrep makes network requests in accordance with the data storage previously mentioned.Semgrep makes the following network requests:
  • When running without --disable-version-check, Semgrep makes a network request to check for updates.
  • When providing a URL to --output, Semgrep performs an HTTP POST of the results to the specified URL.
  • When providing a registry ID like p/ci to --config, Semgrep requests the configuration from the Registry and may send metrics in accordance with the metrics policy.

​
Configuration

Semgrep AppSec Platform provides centralized policy management. See the Policies documentation for more details.
A policy is a simple collection of rules and a definition of what to do with rule results: fail the Semgrep CI run and/or send non-blocking notifications to third-party services like Slack. Please see the Policies documentation for more details.

​
Monitoring

Semgrep Team users can create custom dashboards and visualizations. Semgrep also supports posting results through webhooks to any JSON endpoint, so you can easily integrate it with your favorite visualization tool.

​
Privacy

Semgrep, Inc. retains findings data as long as an account remains active. Semgrep securely destroy data within 90 days of contract termination for Enterprise customers.Additionally, account owners may request data destruction at any time by contacting Support.
Not finding what you need in this doc? Ask questions in our Community Slack group, or see Support for other ways to get help.