Skip to content
Jenkins plugin for executing AppScan Source
Branch: master
Clone or download
Pull request Compare This branch is 11 commits ahead, 3 commits behind kevinfealey:master.
Latest commit 3a925c5 Aug 12, 2016

Readme.md

#AppScan Source Scanner Plugin for Jenkins

##Project Description Configuring IBM Security AppScan Source scans in Jenkins can be time-consuming and error-prone when custom batch or shell scripts are used. This Jenkins plugin greatly simplifies the running of AppScan Source from Jenkins by providing centralized global settings and straight-forward input fields for scan configuration.

Additional information about the plugin can be found here: https://wiki.jenkins-ci.org/display/JENKINS/IBM+AppScan+Source+Scanner+Plugin

##This plugin requires (Prerequisites):

  1. AppScan Source installed on the Jenkins Server
  2. AppScan Source application/project (PAF, PPF, etc.) artifacts on the Jenkins server
  3. Source code and dependencies referenced in the AppScan Source artifacts on the Jenkins server
  4. AppScan Source login token

###Generating a Login Token To generate an AppScan Source login token, execute the AppScan Source CLI, then log in with the following parameters: AppScan Enterprise Server Hostname, AppScan Source username, AppScan Source password -persist [-acceptssl]

ex.

AppScanSrcCli.exe

login localhost myHostname\administrator appScanSourcePassword! -persist -acceptssl

This will generate a file named ouncecli.token in the .ounce folder within home directory of the user who executes the command.

For additional information, please see IBM's documentation: http://www-01.ibm.com/support/knowledgecenter/SSS9LM_9.0.1/com.ibm.rational.appscansrc.utilities.doc/topics/command_line_interface_commands_login.html

##Plugin Use: ###Install plugin ####Automatically The plugin is available to install from within the Jenkins Update Center, which is accessible through the Manage Jenkins menu of your Jenkins installation. If the plugin is not listed as an available plugin, please update your Jenkins installation.

####Manually

  1. From the Jenkins main page, select Manage Jenkins
  2. Select Manage Plugins
  3. Click "Advanced"
  4. Under Upload Plugin, choose the HPI file to upload (located in this project's "release" directory), then click "Upload"
  5. Restart Jenkins

###Configure Plugin

  1. From the Jenkins main page, select Manage Jenkins
  2. Select Configure System
  3. Under the AppScan Source header, click "AppScan Source Installations"
    1. Provide the name of an installation (this is just for your reference later, in case you have more than one installation. This is to enable scanning on slaves where AppScan Source may be installed in a different location)
    2. Provide the installation directory for AppScan Source. The default location is: C:\Program Files (x86)\IBM\AppScanSource
  4. Under the AppScan Source Configuration header, complete the fields:
    1. AppScan Enterprise Hostname/Domain name is the server that AppScan Source logs into
    2. Login Token File Path represents the location of the login token file generated above. This is the path on the Jenkins server.
  5. Click the "Save" button at the bottom of the page

###Configure Job

  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:
  5. 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.
  6. Disable scan should be unchecked if you wish the scan to run
  7. 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.
  8. 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.
  9. Application file should point to a PAF or SLN file to scan.
  10. Click Save at the bottom
  11. Run the job.

##Compatibility This version of the plugin was tested with Jenkins 1.651.1 and IBM Security AppScan Source 9.0.3.

##Roadmap The next step in the roadmap is to support automated publishing of scan results to AppScan Enterprise.

Release Notes

v1.0.0:

  • Initial release

v1.0.3:

  • Fixed bugs to add better support for a multi-Jenkins node environment

v1.0.5:

  • Added custom scan configuration options,
  • Added some help text for input fields
You can’t perform that action at this time.