Gosec

Gosec is a security scanner for Go programming language code.

Auditor Job Name: Gosec Scanner Auditor image: registry.gitlab.com/whitespots-public/security-images/gosec:2.20.0 AppSec Portal Importer Name: Gosec Scanner

It is designed to identify potential vulnerabilities in the Go codebase, including common issues such as SQL injections, buffer overflows, and cross-site scripting (XSS) vulnerabilities.

Gosec scans Go code by analyzing the abstract syntax tree (AST) of the program. It performs data flow analysis to identify potential security issues and reports them to the user.

One interesting feature of Gosec is its ability to scan for issues in code that has not yet been compiled. This means that developers can catch security issues before they even get a chance to be introduced into the codebase. Gosec is also highly customizable, with options for output formats, severity levels, and more.

Curl example

curl -X POST localhost/api/v1/scan/import/ -H "Authorization: Token a75bb26171cf391671e67b128bfc8ae1c779ff7b" -H "Content-Type: multipart/form-data" -F "file=@./gosec.json" -F "product_name=Product1" -F "product_type=Application" -F "scanner_name=Gosec Scanner" -F "branch=dev" -F "repository=[e-mail]:whitespots-public/appsec-portal.git"

In this command, the following parameters are used:

1. -X POST: specifies the HTTP method to be used (in this case, POST)

2. -H "Authorization: Token <authorization_token>": specifies the authorization token obtained from AppSec Portal.

3. -H "Content-Type: multipart/form-data": specifies the content type of the request.

4. -F "file=@<report_file_path>": specifies the path to the report file generated by the scanner.

5. -F "product_name=<product_name>": specifies the name of the product being scanned.

6. -F "product_type=<product_type>": specifies the type of the product being scanned.

7. -F "scanner_name=<scanner_name>": specifies the name of the scanner used to generate the report (Gosec Scanner)

8. -F "branch=<branch_name>": (optional) specifies the name of the branch in the source code repository (if applicable) This parameter is particularly useful when you want to associate the scan results with a specific branch in your repository. If not provided, the scan will be associated with the default branch

Asset information, if an auditor is used

9. -F "repository=<repository SSH URL>": If your product is code in a repository enter the address of your repository in a specific format, for example: [e-mail]:whitespots-public/appsec-portal.git

10. -F "docker_image=<registry address>": If your product is image enter the address of the registry where your product is located, for example: registry.gitlab.com/whitespots-public/appsec-portal/back/auto_validator:latest

11. -F "domain=<domain>": If your product is web enter the domain name of your product, for example: whitespots.io

12. -F "host=<host>": If your product is web enter the IP address of your product, for example: 0.0.0.0

Report example:

{
  "rules": [
    {
      "id": "rule1",
      "name": "just_some_rule_name",
      "description": "just_some_description",
      "engineId": "test",
      "cleanCodeAttribute": "FORMATTED",
      "impacts": [
        {
          "softwareQuality": "MAINTAINABILITY",
          "severity": "HIGH"
        },
        {
          "softwareQuality": "SECURITY",
          "severity": "LOW"
        }
      ]
    },
    {
      "id": "rule2",
      "name": "just_some_other_rule_name",
      "description": "just_some_description",
      "engineId": "test2",
      "cleanCodeAttribute": "IDENTIFIABLE",
      "impacts": [
        {
          "softwareQuality": "RELIABILITY",
          "severity": "LOW"
        }
      ]
    }
  ],
  "issues": [
    {
      "ruleId": "rule1",
      "effortMinutes": 40,
      "primaryLocation": {
        "message": "fix the issue here",
        "filePath": "file1.js",
        "textRange": {
          "startLine": 1,
          "startColumn": 2,
          "endLine": 3,
          "endColumn": 4
        }
      }
    },
    {
      "ruleId": "rule1",
      "primaryLocation": {
        "message": "fix the bug here",
        "filePath": "file2.js",
        "textRange": {
          "startLine": 3
        }
      }
    },
    {
      "ruleId": "rule1",
      "primaryLocation": {
        "message": "fix the bug here",
        "filePath": "file3.js"
      }
    },
    {
      "ruleId": "rule1",
      "primaryLocation": {
        "message": "fix the bug here",
        "filePath": "file3.js"
      },
      "secondaryLocations": [
        {
          "message": "fix the bug here",
          "filePath": "file1.js",
          "textRange": {
            "startLine": 1
          }
        },
        {
          "filePath": "file2.js",
          "textRange": {
            "startLine": 2
          }
        }
      ]
    },
    {
      "ruleId": "rule2",
      "effortMinutes": 40,
      "primaryLocation": {
        "message": "fix the bug here",
        "filePath": "file3.js"
      },
      "secondaryLocations": [
        {
          "message": "fix the bug here",
          "filePath": "file1.js",
          "textRange": {
            "startLine": 1
          }
        },
        {
          "filePath": "file2.js",
          "textRange": {
            "startLine": 2
          }
        }
      ]
    }
  ]
}