Child pages
  • IBM Security AppScan Source Scanner Plugin

Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

Plugin Information

View IBM Security AppScan Source Scanner on the plugin site for more information.

 Project Description

This plugin is supported by Aspect Security.

The purpose of this plugin is to allow Jenkins to perform static code analysis (SCA/SAST) with IBM AppScan Source for Analysis with minimal configuration. AppScan Source for Analysis is a security tool provided by IBM that will scan application source code for vulnerabilities. Configuring AppScan Source to perform automated scanning with custom batch jobs or shell scripts can be a time-consuming and error-prone process. This Jenkins plugin greatly simplifies the process of automating AppScan Source by providing global settings and simple scan configuration within Jenkins.For more information on IBM AppScan Source, please visit the official IBM site http://www-03.ibm.com/software/products/en/appscan-source

Prerequisites

This plugin requires the following:

  • A valid license for AppScan Source for Analysis and AppScan Source for Automation
    Note: The automation license is required to unlock the command-line interface (cli) functionality
  • AppScan Source for Analysis must be installed on the same server as Jenkins
  • The AppScan Source project or application files for the application(s) you are scanning (.PAF, .PPF, etc)
  • Application source code and dependencies must already be referenced in the AppScan Source project or application files

Plugin Setup

Before using this plugin, a login token must be generated via the AppScanSrcCLI application. To generate a login token:

  1. Open a command prompt
  2. Navigate to the bin folder in your AppScan Source install folder
    1. Ex: cd c:\program files(x86)\IBM\AppScan Source\bin
  3. Execute the AppScan Source CLI login command
    1. AppScanSrcCli.exe login http://hostname:9443/ase username password -persist -acceptssl
    2. Be sure to replace hostname, username, and password with valid values for your installation
  4. This will create a file called ouncecli.token under c:\users{username}\.ounce\. Verify that this file exists and make note of the location

For additional reading on the login command, please see IBM's documentation: http://www-01.ibm.com/support/knowledgecenter/SSS9LM_9.0.3/com.ibm.rational.appscansrc.utilities.doc/topics/command_line_interface_commands_login.html

Plugin Configuration

  1. From the Jenkins homepage, click Manage Jenkins and then Configure System
  2. Scroll down the page and locate the section titled AppScan Source
     
  3. Click Add AppScan Source
  4. Fill out the AppScan Source form
    \
    1. AppScan Source Name: A name for this instance of AppScan Source. This is just to help manage environments that may have multiple installations
    2. AppScan Source Installation Directory: The path to the installation directory. Note: the default value is C:\Program Files (x86)\IBM\AppScanSource
  5. Scroll to the bottom and locate the section titled AppScan Source Configuration and fill out the form
    \
    1. AppScan Enterprise Hostname/Domain Name: The host name of your AppScan Enterprise server
    2. Login Token File Path: This is the path to the login token generated above. Default path is C:\Users{user}\.ounce\ouncecli.token
  6. Click Save

Using the plugin

  1. Create a new job or access an existing job
  2. Select "Configure"
  3. Select "Add build step" and select "Run AppScan Source"
  4. Complete the fields that appear:
    1. AppScan Source installation will show the name you provided for the installation on the global configuration screen. If you have not added an installation, please go the the Jenkins Configure System link under Manage Jenkins. If you only have one installation configured, the installation should be selected for you. If you plan to execute AppScan Source on multiple Jenkins nodes, you may need to configure multiple installation paths.
    2. Disable scan should be unchecked if you wish the scan to run
    3. Accept SSL Errors should be checked if you have not created a trusted certificate for your AppScan Source installation. In an Enterprise environment, this should not be checked, since you should be using a trusted certificate.
    4. Scan Workspace Directory is where scan artifacts, like WAFL and staging files will be placed. Scan results (.ozasmt file) will also be placed in this directory.
    5. Application file should point to a PAF or SLN file to scan.
  5. Click Save at the bottom
  6. Run the job.

Compatibility

This version of the plugin was tested with Jenkins 1.651.1 and IBM Security AppScan Source 9.0.3. Plugin should work with any version of AppScan Source 9.0.0 or newer.

Roadmap

Support automated publishing of scan results to AppScan Enterprise.
Execute application scans with IBM Security AppScan Source

For additional information about this plugin, please see the project's README on GitHub