semgrep

command
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 26, 2024 License: MIT Imports: 11 Imported by: 0

README

Semgrep Plugin

The main function of the plugin is to present a top-level interface for a Semgrep scanner.

This page is a short plugin description.
You may find additional information in a scanio-analyse article.

Installing Dependencies

If you build the Scanio code using Docker or pull a pre-built container, you do not need to separately install the Semgrep dependencies. However, if you build the Scanio code to a binary, you will need to install Semgrep before using the application. You can refer to the Semgrep documentation for more information.

Commands

  • Analysing using semgrep with an input file argument.
    scanio analyse --scanner semgrep --input-file /Users/root/.scanio/output.file --format sarif -j 2
  • Analysing using semgrep with a specific path .
    scanio analyse --scanner semgrep --format sarif -j 1 /tmp/my_project
  • Analysing using semgrep with an input file and custom rules.
    scanio analyse --scanner semgrep --config /Users/root/scan-io-semgrep-rules --input-file /Users/root/.scanio/output.file --format sarif -j 2
  • Analysing using semgrep with an input file and additional arguments.
    scanio analyse --scanner semgrep --input-file /Users/root/.scanio/output.file --format sarif -- --verbose --severity INFO

Results of the Command

If you use an input file argument the command will save results into a home directory: ~/.scanio/results/+<VCSURL>+<Namespace>+<repo_name>/<scanner_name>.<report_format>.

If you use a specific path argument the command will save results into the same directory:

  • scanio analyse --scanner <scanner_name> --format <report_format> /tmp/my_project
  • Result path - /tmp/my_project/<scanner_name>.<report_format>r>

Possible Errors

Semgrep does not support Linux ARM64

You may face with this error if you are using Mac with an M chip.

You juset need to build a docker container with a platform flag. docker build --platform linux/amd64 -t scanio . And use a docker command with the same flas:

docker run --rm \                              
            -v "/~/develop/:/data" \
            --platform linux/amd64 \
            scanio analyse --scanner semgrep --input-file /data/testSEC.file --format sarif -j 1

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL