Description

HCL AppScan Enterprise delivers scalable application security testing and risk management capabilities, to help enterprises manage risk and compliance. HCL AppScan enables security, DevOps teams to collaborate, establish policies, and perform testing throughout the application development lifecycle.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
HCL Accelerate version 2.0 or later
Created by
HCL Software
Website
Version Name Action

1.0.22

ucv-ext-appscan:1.0.22.tar

1.0.23

ucv-ext-appscan:1.0.23.tar

1.0.30

ucv-ext-appscan:1.0.30.tar

1.0.31

ucv-ext-appscan:1.0.31.tar

ucv-ext-appscan:1.0.22.tar

1.0.22


ucv-ext-appscan:1.0.23.tar

1.0.23


ucv-ext-appscan:1.0.30.tar

1.0.30


ucv-ext-appscan:1.0.31.tar

1.0.31


Summary

The AppScan Enterprise plugin provides integration with an HCL AppScan Enterprise server. This plugin retrieves the security vulnerability report of the application and displays it as Insights metrics.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
1.0.23 Minor enhancements
1.0.22 Minor enhancements

Usage

To use the AppScan Enterprise plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file. After the integration is complete, to invoke the plugin send an HTTP Post request to the plugin endpoint

Integration type

The AppScan Enterprise plugin supports endpoint integration which are listed in the following table.

Endpoints
Name Path Method
AppScan Callback appscan/callback Put

Invoking the plugin

To import data from the HCL AppScan Enterprise server, send an HTTP POST request to your endpoint such as the following sample.


https:///pluginEndpoint//appscan/callback

The payload for the POST is shown below.

{"application":"", "buildUrl": ""}.

Name Description
application he application name from the scan ran in Appscan Enterprise. It is a mandatory field to render the scan results in HCL Accelerate.
buildUrl The build URL from Jenkins or any other CI/CD tool. It is an optional field which links the Appscan Enterprise scan results with VSM.

Integration

There are two methods to integrate the plugin:

  • Using the user interface
  • Using a JSON file

The tables in the Configuration properties topic describe the properties used to define the integration.

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plugin, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plugin properties can be defined.

  1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plugin configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. View the new integration on the Integrations page.

Minimum permission to integrate with HCL AppScan Enterprise (ASE)

The HCL AppScan Enterprise (ASE) Account used to generate the token must have access to the project which is being integrated with HCL Accelerate.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

  • The General Configuration Properties table describes configuration properties used by all plugin integrations.
  • The AppScan Enterprise Configuration Properties table describes the configuration properties that define the connection and communications with the HCL AppScan Enterprise server. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

General Configuration properties
Name Description Required Property Name
NA The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
Integration Name An assigned name to the value stream. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
NA List of plugin configuration properties used to connect and communicate with the HCL AppScan Enterprise server. Enclose the properties within braces. Yes properties
The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plugin. The value for the HCL AppScan Enterprise plugin is ucv-ext-appscan Yes type
The user name to use to authenticate with the HCL AppScan Enterprise server.
HCL AppScan Enterprise Configuration Properties
Name Type Description Required Property Name
Password Secure The password to authenticate with the HCL AppScan Enterprise server. Yes password
HCL Accelerate User Access Key Secure The user access key to authenticate with the HCL Accelerate server. Yes ucvAccessKey
User Name String Yes username
URL String The URL of the HCL AppScan Enterprise server. Include the port number. Yes url