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.
YOUR DEPLOYMENT JOURNEY
- You have gained the necessary resource access and permissions required for deployment.
- You have created a Semgrep account and organization.
- You have connected your source code manager.
- Optionally, you have set up SSO.
- You have successfully added a Semgrep job to your CI workflow with diff-aware scanning.
Conditions for PR comment creation
PR comments appear for the following types of scans under these conditions:| Type of scan | Product name | Trigger condition | How to set up |
|---|---|---|---|
| Static application security testing (SAST) | Semgrep Code | A comment appears when a finding is generated by a rule in Comment or Block mode. This means you can fully customize what comments your developers receive. | Complete the steps in the following sections: 1. Confirm your Semgrep account’s connection and access to your source code manager. 2. Configure comments for Semgrep Code. |
| Software composition analysis (SCA) | Semgrep Supply Chain (SSC) | A comment appears based on the conditions you explicitly set in a Supply Chain policy or when Semgrep detects a license violation. | To receive Supply Chain comments, complete the steps in Confirm account connection and access and set up a policy. To receive license violation comments, enable dependency search. |
| Secrets | Semgrep Secrets | A comment appears when a finding is generated by a rule in Comment or Block mode. A comment also appears for invalid findings and validation errors if these conditions are set to Comment or Block mode. | Complete the steps in the following sections: 1. Confirm your Semgrep account’s connection and access to your source code manager. 2. Configure comments for Semgrep Secrets. |
A description of the vulnerability, including the types of attack it is vulnerable to. Fix
Indicates what versions to upgrade to, if any, that resolves or eliminates the vulnerability. Reference
A link to additional information about the vulnerability from its source, such as the GitHub Advisory Database and the National Vulnerability Database (NVD), if available.
Enable PR comments in Bitbucket
Prerequisites
- You must have a Bitbucket Data Center HTTP access token. Ensure that the HTTP access token that you create has been granted Project write permissions. You’ll provide this token to your CI provider during the setup process.
- Semgrep has been tested with Bitbucket Data Center v8.19. If you are using a different version of BBDC and there are issues, please reach out to support.
Confirm your Semgrep account’s connection
Confirm that you have the correct connection and access:Triage through PR comments
Developers can triage Semgrep findings without leaving Bitbucket by responding to the PR comments authored by Semgrep. Semgrep requires Bitbucket Data Center source code manager (SCM) connections to use an HTTP access token withPROJECT_ADMIN permissions, so your connection may already use an appropriate token.
If you do not, to update your connection between Semgrep and Bitbucket Data Center:
Create an HTTP access token. When setting the token’s Project permissions, ensure that you select Project admin.
Return to Semgrep and sign in.
In the Update access token dialog that appears, provide the new token you created. Click Update to save and proceed.
Configure comments for Semgrep Code
In addition to setting up the connection between Semgrep and Bitbucket, you must assign rules to Comment or Block mode. This customization enables you to:- Manage the amount of PR comments your developers receive.
- Ensure that only rules that meet your criteria, such as high severity or high confidence rules, produce comments visible to developers, reducing noise.
Set rules to Comment or Block mode
The following instructions let you customize what findings or security issues your developers see as comments in their PRs:In your Semgrep AppSec Platform account, click Rules > Policies to enter the Policies page. Under Modes , you can quickly see if you have existing rules in either Comment or Block mode.
Configure comments for Semgrep Secrets
In addition to setting up the connection between Semgrep and Bitbucket, you must assign rules to Comment or Block mode. This customization enables you to:- Manage the amount of PR comments your developers receive.
- Ensure that only rules that meet your criteria, such as high severity or high confidence rules, and result in findings involving valid secrets produce comments visible to developers, reducing noise.
Set rules to Comment or Block mode
The following instructions let you customize what findings or security issues your developers see as comments in their PRs:Under Modes , you can see if you have existing rules in either Comment or Block mode. You can also use the filters to find rules you want to set to Comment or Block.
Validation state policies
Validation state policies allow you to define how Semgrep handles the following issues:- Invalid findings: the secret has been revoked, was never functional, or used for a custom or private endpoint that Semgrep can’t communicate with. For example, a Semgrep rule that tests GitHub credentials may return an invalid finding if Semgrep can’t communicate with an on-premise deployment.
- Validation errors: Semgrep was unable to reach the secrets provider to test the validity of the credential, or Semgrep received an unexpected response from the API
Configure comments for Semgrep Supply Chain
To configure comments for Supply Chain, you must define a Supply Chain policy. This policy lets you set the specific conditions, such as transitivity and reachability, that trigger a comment. These conditions are unique to Supply Chain findings. See the Policies documentation for more information.Optional features
Customize PR comments
You can customize the comments Semgrep leaves on your PR. Custom comments allow you to direct your teams to the resources they need to handle the vulnerabilities Semgrep identifies in their code.
Sign in to Semgrep AppSec Platform.
Provide a custom comment for each Semgrep product whose findings you want to generate a PR comment. Semgrep supports Markdown and plaintext links in your message.
Enable Rule-defined fix in Bitbucket Data Center repositories
Autofix is a Semgrep feature in which rules contain suggested fixes to resolve findings. To enable Rule-defined fix for all projects in your Semgrep AppSec Platform organization, follow these steps:Next steps
You’ve finished setting up a core deployment of Semgrep 🎉.- Explore recommended tasks after deployment in Beyond core deployment.