Skip to content

Latest commit

 

History

History
110 lines (93 loc) · 5.49 KB

README.md

File metadata and controls

110 lines (93 loc) · 5.49 KB
Raw

Veracode SAST IDE Plugin for Jetbrains IDEs (Community Plugin)

Introduction

This is a very simple community plugin that I developed for comlimenting Veracode's official IDE integration with Jetbrains IDE products. It enables you to download the SAST result from Veracode Platform into your Jetbrains IDE and conveniently work within your day-to-day tool chain!

Release Note

Version 1.2.2

Support all Jetbrains IDE's from version 183.*

Version 1.2.1

Support Rider build 2021.2.2

Version 1.2

Change the API authentication to use API credential file.

Version 1.0

The very initial release which consists the core functionality of this plugin:

  • Download policy / sandbox scan result
  • Work with the flaw directly
  • Automated scan upload and result download (BETA Feature! More Info here)

"Supported" Jetbrains IDEs and Versions

Unlike official supported IDE plugins by Veracode, this is a self-initiated project - I am unable to test it against all Jetbrains IDE products. But, the information below is gathered from customers who are using it!

The plugin is known working with the following IDEs:

  • IntelliJ
  • Rider
  • Pycharm
  • PhpStorm
  • AppCode
  • Android Studio
  • (maybe more... let me know if you discover any ;) )

The plugin is known working with the version up to #IC-211.*

Installation

  1. Download the latest version of the plugin from distributions folder
  2. Follow this instruction to get it installed.

Configuration

  1. Generate your API credentials
  2. Setup Veracode credential file
  3. All set.

Usage

  • Download scan result (policy scan / sandbox scan) manually Manual download scan result 1 Manual download scan result 2
  • Shows only flaws affecting compliance policy Flaws affecting compliance
  • Act on the flaw directly via various option, such as commeting, mitigation Act on flaw

Known Issue

  • You may very likely encounter this issue - when select a flaw from the tree, the flaw description is not shown. This is a known problem which occurred after a certain version of IDE base platform. I am still trying hard to get this resolved. Workaround: Click on "Comments / Mitigations" tab then toggle back to "Description" again.

Roadmap

  1. To add flaw actions "Reported to Library Maintainer" and "Accept the Risk"
  2. Pipeline Scan (Potentially)

Feedback / Request

File it to "Issues"!

Automated Scan Upload and Download (BETA Feature)

This feature aims to enable developer for kicking off scanning and downloading result in a single click!

Below is the steps to use this feature.

  1. Copy the [veracode.config] file and place it at the root of your project (Please note that you will have to maintain the naming convention as such). You will see that the "Scan Application" and "Download Result" menu items are enabled.
  2. Open the veracode.config, locate a config block (a config block looks like the following). 
    {
 "config_name": "Policy Scan Config",
 "branch_pattern": "master",
 "static_config": {
   "scan_type": "policy",
   "sandbox_name": "",
   "scan_naming": "timestamp",
   "upload_include_patterns": [
     ".*.php",
     ".*.module",
     ".*.inc",
     ".*.html",
     ".*.htm",
     ".*.profile",
     ".*.install",
     ".*.engine",
     ".*.theme",
     ".*.php4",
     ".*.php5",
     ".*.php7",
     ".*.phtml"
   ],
   "upload_exclude_patterns": [
   ]
 },
 "portfolio": {
   "app_name": "Test PHP"
 }
},
  3. A config block is used to instruct the plugin to intiiate a scanning to a specific location (app profile + policy / sandbox), with what to upload. You can add / remove the config block as necessary. The following parameters are needed to be updated depends on your application:
    • app_name: the application profile name
    • config_name: A name that you prefer for that config block
    • branch_pattern: the git branch pattern. This is a regex.
    • scan_type: policy / sandbox
    • sandbox_name: the sandbox name (sandbox must exist first), if scan_type = sandbox
    • upload_include_patterns: the file pattern to include for upload
    • upload_exclude_patterns: the file pattern to exclude for upload Do not modify the scan_naming in this beta version.