- Semgrep Cloud Platform
- Team & Enterprise Tier
Writing rules using Semgrep Editor
Semgrep Editor is an advanced tool for rule writing. Write rules on a YAML editor, verify their performance through tests, and add them to your organization’s Policies page to enforce code standards and increase code security.
To quickly learn Semgrep patterns and syntax, explore the Editor’s library of rules from the public Rule Registry. Rules from the Registry can detect OWASP vulnerabilities, best practice violations, and security issues for a wide variety of languages and frameworks. Semgrep Editor enables you to adapt these rules for your own organization’s use by forking them.
The Editor is free to use on all tiers, but saving a rule for private use is a Team/Enterprise tier feature.
Accessing Semgrep Editor
- Sign in to your Semgrep Cloud Platform account.
- Click Rules > Editor.
- Do any of the following steps:
- To create a new rule, click on the (+) plus sign or Create new rule button.
- To open any rule you’ve recently edited, select it from the Recent list.
- To view a sample rule, select it from the Examples list. The rule renders within the Editor.
- To start a tutorial or read the docs, select it from the Learn list. This navigates you away from the Editor.
The editor is composed of three panes and a top menu.
- View and open various rules through the library. It contains two top-level folders:
- Your organization’s rules
- Publicly-available Semgrep Registry rules from the
- Rule editor
- Enter your rule’s YAML schema in this pane.
- Sample code window
- Enter your rule’s test code in this pane and click the Run button to verify that the rule runs as intended. A matches panel appears after Semgrep is run to display matches and tests.
- Top menu
- Save, share, and add your rule to the Policies page through this menu.
To resize the panes, position your mouse over the borders and click-drag to the desired width. The library pane can be completely hidden to give more space for the editing panes.
Semgrep Registry rules are initially grouped by directory. Most of these directories correspond to languages. The Library can also be grouped by rulesets, which are rules arranged by category, such as security, best practices, and frameworks.
To group by ruleset, right click on the empty space on the official registry entry and select Group by ruleset.
Creating a rule
To create a rule, click Create rule on the splash page or the (+) sign next to the Library label. The Editor provides the minimum fields to create a rule:
Refer to Rule syntax for all possible fields and values to create a rule.
Semgrep can automatically scan for findings using the Semgrep OSS Engine, on any change in the Rule or Sample Code panes.
Click the Turbo mode toggle to try it out.
In this mode, the Run button is hidden because Semgrep scans upon detecting any change to the text. Turbo mode works in both Simple mode and Advanced mode. Turbo mode cannot be enabled for Semgrep Pro Engine.
Jumpstart rule writing using existing rules
Another method of creating rules is by forking/copying from existing rules found in Semgrep Registry. For example, Semgrep’s Java
crypto ruleset prohibits the use of weak hashing algorithms
MD5. An organization may want to further limit the use of other hash functions as part of their standards or security compliance. The next steps illustrate forking through copying an existing
use-of-sha1 rule and changing the rule to forbid MD2 hashes.
- Enter related terms into the search bar to find potential rules. In our example, this is use-of-sha.
- Registry rules cannot be edited directly. They can be forked by right-clicking on their entry in the Library and selecting Fork rule.
- The rule is copied to your organization’s rules.
- Enter edits to finalize your rule. In this example, the patterns are changed to find matches for MD2 and the severity is increased from
- Enter updates to test cases.
- Click Run to validate your rule.
- Click Save to save your rule. The following rule displays the end result.
Debugging syntax issues
The editor will not save, share, or run if the YAML syntax is unparseable. The editor supports error handling, for the following cases:
ruleskey at start
- Invalid language keys
- Incorrect severity fields
- Missing required schema fields
If no schema or spelling errors are detected, check for indentation or newline issues. You can also get rule-writing help through the Semgrep Community Slack.
Evaluating a rule’s performance
Evaluating a rule through testing ensures that it meets your standards for precision and speed, thus reducing false positives. Semgrep uses certain annotations in comments to enable users to test which blocks of code are intended to match with a rule, and which blocks of code should not match.
In the following example, run the rule and click on the three-dot menu to view the result of the tests.
To test a rule:
- Create at least one true positive: a code sample intended to match the rule.
- Above this potential match, create a comment, followed by a space (
ruleid:RULE_IDwhich specifies the rule that should match. In the preceding example, this is
- Create at least one true negative: a code sample intended not to match the rule.
- Above this non-match, create a comment followed by a space ( ), followed by
ok:RULE_ID. For example,
- Optional: add more code samples with their corresponding annotations.
- Click Run. Semgrep will detect the annotations and validate the rule based on your tests.
For additional annotations designed to test false positives and false negatives, refer to Testing rules.
Renaming and saving a rule
- To rename a rule, enter the new name in the YAML editor’s
- To save a rule, enter Ctrl+S (⌘+S on Mac) or click the Save button.
Sharing a rule and setting a rule’s visibility
Upon saving, a rule’s visibility is unlisted by default. This rule can be shared with anyone through an identifier, even to non-Semgrep Cloud Platform users.
A rule can be saved as a private rule, which is visible only to members within an organization. You can still share a private rule, but only members of the organization can see it. Private rules are a Team/Enterprise tier feature.
- To set a rule’s visibility to private, click Share > Private > Confirm.
- To share a private or unlisted rule, click Share and copy the URL link.
Deleting a rule
To remove a private rule, follow these steps:
- In the Semgrep Editor, find a private rule to delete under the Library tab. Private rules are usually stored in the folder with the same name as your Semgrep Cloud Platform organization.
- Click the rule you want to delete, and then click the three vertical dots.
- Click Delete.
Deleting a rule is permanent. If the rule was previously added to the Policies page, it is removed upon deletion.
Setting code standards with the Policies page
Adding a rule to the Policies page applies the rule across all projects scanned by Semgrep Cloud Platform.
To add a rule to the Policies page:
- Click Add to Policy.
- Select which rule mode (Monitor, Comment, or Block) to set the rule to, depending on the rule’s relevance.
The rule appears in your Policy page with the mode it is set to.
Contributing to the open-source Semgrep Registry
For general contributing guidelines, see Contributing rules.
To have your rule accepted faster, include the following:
- Include test cases for both a true positive and a true negative. See Tests for more details.
- Include a descriptive rule message. See Rule messages for more information.
- Include metadata fields. See Semgrep registry rule requirements for more information.
To create a PR from the Semgrep Editor:
- Click Share.
- (Optional) Click Publish to Registry.
- Fill in the required and optional fields.
- Click Continue, and then click Create PR.