> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/security-testing-orchestration/3.0/use-sto/sto-scanner-configuration/semgrep/semgrep-scanner-reference.md).

# Semgrep step configuration

You can scan your code repositories using [Semgrep](https://www.semgrep.com) and ingest the results into STO.

For a quick introduction, go to the [SAST code scans using Semgrep](/security-testing-orchestration/use-sto/sto-scanner-configuration/semgrep/sast-scan-semgrep.md) tutorial.

### Important notes for running Semgrep scans in STO <a href="#important-notes-for-running-semgrep-scans-in-sto" id="important-notes-for-running-semgrep-scans-in-sto"></a>

* This integration uses the [Semgrep Engine](https://github.com/semgrep/semgrep), which is open-source and licensed under [LGPL 2.1](https://tldrlegal.com/license/gnu-lesser-general-public-license-v2.1-\(lgpl-2.1\)).

  To run scans using a licensed version of [Semgrep Code](https://semgrep.dev/products/semgrep-code), add your Semgrep token in the [Access token](#access-token) field.
* STO Semgrep steps include the following rulesets by default:

  * [auto](https://semgrep.dev/p/auto)
  * [bandit](https://semgrep.dev/p/bandit)
  * [brakeman](https://semgrep.dev/p/brakeman)
  * [eslint](https://semgrep.dev/p/eslint)
  * [findsecbugs](https://semgrep.dev/p/findsecbugs)
  * [flawfinder](https://semgrep.dev/p/flawfinder)
  * [gosec](https://semgrep.dev/p/gosec)
  * [phps-security-audit](https://semgrep.dev/p/phpcs-security-audit)
  * [security-code-scan](https://semgrep.dev/p/security-code-scan)

  Some rulesets include Pro rules that are available only with a paid version of Semgrep. For more information, go to the [Semgrep Registry](https://semgrep.dev/explore).
* If you want to add trusted certificates to your scan images at runtime, you need to run the scan step with root access.

  You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your proxies using custom certificates. For more information, go to [Configure your pipeline to use STO images from private registry](/security-testing-orchestration/3.0/troubleshooting-and-resources/sto-use-cases/set-up-sto-pipelines/configure-pipeline-to-use-sto-images-from-private-registry.md).
* The following topics contain useful information for setting up scanner integrations in STO:
  * [What's supported in STO](/security-testing-orchestration/3.0/new-to-sto/sto-whats-supported/sto-deployments.md)
  * [Security Testing Orchestration FAQs](/security-testing-orchestration/3.0/troubleshooting-and-resources/faqs.md)
  * [Optimize STO pipelines](/security-testing-orchestration/3.0/troubleshooting-and-resources/sto-use-cases/set-up-sto-pipelines/optimize-sto-pipelines.md)

### Set-up workflows <a href="#set-up-workflows" id="set-up-workflows"></a>

<details>

<summary>Orchestration scans</summary>

To scan a code repository, you need [Harness Code Repository](https://app.gitbook.com/s/oTP6ysjQCQlt5GlFHRfs/README) or a [Harness connector](/harness-ai/use-harness-platform/connectors/code-repositories/ref-source-repo-provider.md) to your Git service.

**Add the Semgrep scanner**

Do the following:

1. Add a **Build** or **Security** stage to your pipeline.
2. Configure the stage to point to the [codebase](/continuous-integration/use-harness-ci/use-harness-ci/codebase-configuration/create-and-configure-a-codebase.md) you want to scan.
3. Add a Semgrep step to the stage.

**Set up the Semgrep scanner**

**Required settings**

1. Scan mode = [Orchestration](#scan-mode)
2. Target and Variant Detection = [Auto](#detect-target-and-variant)

**Optional settings**

* [Fail on Severity](#fail-on-severity) — Stop the pipeline if the scan detects any issues at a specified severity or higher
* [Log Level](#log-level) — Useful for debugging

**Scan the repository**

Save your pipeline and then select **Run**.

The pipeline scans your code repository and then shows the results in [Vulnerabilities tab](/security-testing-orchestration/3.0/use-sto/sto-security-issues/view-scan-results.md).

</details>

<details>

<summary>Ingestion scans</summary>

**Add a shared path for your scan results**

1. Add a **Build** or **Security** stage to your pipeline.
2. In the stage **Overview**, add a shared path such as `/shared/scan_results`.

**Copy scan results to the shared path**

There are two primary workflows to do this:

* Add a Run step that runs a Semgrep scan from the command line and then copies the results to the shared path.
* Copy results from a Semgrep scan that ran outside the pipeline.

For more information and examples, go to [Ingestion scans](/security-testing-orchestration/3.0/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md).

**Set up the Semgrep scanner**

Add a Semgrep step to the stage and set it up as follows.

**Required settings**

1. [Scan mode](#scan-mode) = Ingestion
2. [Target name](#name) — Usually the repo name
3. [Target variant](#name) — Usually the scanned branch. You can also use a [runtime input](/harness-ai/use-harness-platform/variables-and-expressions/runtime-input-usage.md) and specify the branch at runtime.
4. [Ingestion file](#ingestion-file) — For example, `/shared/scan_results/semgrep-scan.json`

**Optional settings**

* [Fail on Severity](#fail-on-severity) — Stop the pipeline if the scan detects any issues at a specified severity or higher
* [Log Level](#log-level) — Useful for debugging

**Scan the repository**

Save your pipeline and then select **Run**.

The pipeline scans your code repository and then shows the results in [Vulnerabilities tab](/security-testing-orchestration/3.0/use-sto/sto-security-issues/view-scan-results.md).

</details>

### Semgrep step configuration <a href="#semgrep-step-configuration" id="semgrep-step-configuration"></a>

The recommended workflow is to add a Semgrep step to a Security Tests or CI Build stage and then configure it as described below.

#### Scan <a href="#scan" id="scan"></a>

**Scan Mode**

**Scan Configuration**

You can use this setting to select the set of Semgrep rulesets to include in your scan:

* **Default** Include the following rulesets:
  * [bandit](https://semgrep.dev/p/bandit)
  * [brakeman](https://semgrep.dev/p/brakeman)
  * [eslint](https://semgrep.dev/p/eslint)
  * [findsecbugs](https://semgrep.dev/p/findsecbugs)
  * [flawfinder](https://semgrep.dev/p/flawfinder)
  * [gosec](https://semgrep.dev/p/gosec)
  * [phps-security-audit](https://semgrep.dev/p/phpcs-security-audit)
  * [security-code-scan](https://semgrep.dev/p/security-code-scan)
* **No default CLI flags** Run the `semgrep` scanner with no additional CLI flags. This setting is useful if you want to specify a custom set of rulesets in **Additional CLI flags**.
* **p/default** Run the scan with the [default ruleset](https://semgrep.dev/p/default) configured for the Semgrep scanner.
* **Auto only** Run the scan with the [recommended rulesets specific to your project](https://semgrep.dev/p/auto).
* **Auto and Ported security tools** Include the following rulesets:
  * [auto](https://semgrep.dev/p/auto)
  * [brakeman](https://semgrep.dev/p/brakeman)
  * [eslint](https://semgrep.dev/p/eslint)
  * [findsecbugs](https://semgrep.dev/p/findsecbugs)
  * [flawfinder](https://semgrep.dev/p/flawfinder)
  * [gitleaks](https://semgrep.dev/p/gitleaks)
  * [gosec](https://semgrep.dev/p/gosec)
  * [phps-security-audit](https://semgrep.dev/p/phpcs-security-audit)
  * [security-code-scan](https://semgrep.dev/p/security-code-scan)
* **Auto and Ported security tools except p/gitleaks**

#### Target <a href="#target" id="target"></a>

**Type**

**Target and variant detection**

**Name**

**Variant**

**Workspace**

#### Ingestion File <a href="#ingestion-file" id="ingestion-file"></a>

#### Access Token <a href="#access-token" id="access-token"></a>

#### Log Level <a href="#log-level" id="log-level"></a>

#### Additional CLI flags <a href="#additional-cli-flags" id="additional-cli-flags"></a>

Use this field to run the [`semgrep`](https://semgrep.dev/docs/cli-reference/) scanner with flags such as:

`--severity=ERROR --use-git-ignore`

With these flags, `semgrep` considers only ERROR severity rules and ignores files included in `.gitignore`.

#### Fail on Severity <a href="#fail-on-severity" id="fail-on-severity"></a>

#### Settings <a href="#settings" id="settings"></a>

#### Additional Configuration <a href="#additional-configuration" id="additional-configuration"></a>

#### Advanced settings <a href="#advanced-settings" id="advanced-settings"></a>

### Configure Semgrep as a Built-in Scanner <a href="#configure-semgrep-as-a-built-in-scanner" id="configure-semgrep-as-a-built-in-scanner"></a>

The Semgrep scanner is available as a [built-in scanner](/security-testing-orchestration/3.0/use-sto/set-up-sto-scans/built-in-scanners.md) in STO. Configuring it as a built-in scanner enables the step to automatically perform scans using the free version without requiring any licenses. Follow these steps to set it up:

1. Search for **SAST** in the step palette or navigate to the **Built-in Scanners** section and select the **SAST** step.
2. Expand the **Additional CLI Flags** section if you want to configure optional CLI flags.
3. Click **Add Scanner** to save the configuration.

The scanner will automatically use the free version, detect scan targets, and can be further configured by clicking on the step whenever needed.

### Proxy settings <a href="#proxy-settings" id="proxy-settings"></a>

### YAML pipeline example <a href="#yaml-pipeline-example" id="yaml-pipeline-example"></a>

The following pipeline example illustrates an orchestration workflow. It consists of a Semgrep step that scans a code repository and then ingests, normalizes, and deduplicates the results.

```yaml
pipeline:
  name: semgrep-orch-test
  identifier: semgreporchtest
  projectIdentifier: default
  orgIdentifier: default
  tags: {}
  properties:
    ci:
      codebase:
        connectorRef: YOUR_GIT_CONNECTOR_ID
        repoName: YOUR_GIT_REPO_NAME
        build: <+input>
  stages:
    - stage:
        name: semgrep-orch
        identifier: semgreporch
        description: ""
        type: SecurityTests
        spec:
          cloneCodebase: true
          platform:
            os: Linux
            arch: Amd64
          runtime:
            type: Cloud
            spec: {}
          execution:
            steps:
              - step:
                  type: Semgrep
                  name: Semgrep_1
                  identifier: Semgrep_1
                  spec:
                    mode: orchestration
                    config: default
                    target:
                      type: repository
                      detection: auto
                    advanced:
                      log:
                        level: info
```