Usage

To use the HCL AppScan on Cloud 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.

Integration type

The HCL AppScan on Cloud plugin supports endpoint integration which is listed in the following table.

The following picture shows the endpoint after the integration is defined in Accelerate:

Notes

The following two features are available from version 2.0.1 and above of the plugin:

1. the plugin imports historical scan data from ASoC
   1. To sync / import the historical scan data in to Accelerate, update the ‘ASoC applications’ field in the plugin configuration with the Application names in ASoC. The plugin will pull all the scan data till date.
2. the plugin supports ASoC webhooks.
   • The plugin endpoint can be defined as a webhook in ASoC. When the webhook is invoked by ASoC after every scan execution, the plugin will run and import the scan data to Accelerate.
   • If the ASoC scan is invoked using REST API, pass the ‘build url’ as ‘Comment’ as shown in the below example. This will enable the plugin to import the ‘build url’ and associate the scan result to that specific ‘build’ / ‘build url’ in Accelerate. If the scan is invoked from ASoC UI, this feature is not available, but it is soon expected to be available in UI as well.

curl –location –request POST ‘https://cloud.appscan.com/api/v2/Scans/MobileAnalyzer’ \
–header ‘Content-Type: application/x-www-form-urlencoded’ \
–header ‘Authorization: Bearer bearer-token-goes-here‘ \
–data-urlencode ‘ApplicationFileId=file-id-goes-here‘ \
–data-urlencode ‘ScanName=scan-name-goes-here‘ \
–data-urlencode ‘AppId=ASoC-AppId-goes-here‘ \
–data-urlencode ‘Execute=true’ \
–data-urlencode ‘Comment=https://build-url-goes-here‘

• • In order to use the webhook, a software named AppScan presence must be installed on the machine where Accelerate is running. Refer this link from ASoC for more details: https://help.hcltechsw.com/appscan/ASoC/asp_scanning.html
  • The following is an example of creating a webhook in ASoC.

curl –location –request POST ‘https://cloud.appscan.com/api/V2/Webhooks’ \
–header ‘Content-Type: application/x-www-form-urlencoded’ \
–header ‘Authorization: Bearer bearer-token-value-goes-here‘ \
–data-urlencode ‘PresenceId=presence-id-goes-here‘ \
–data-urlencode ‘Uri=plugin-endpoint-goes-here?ScanExecutionId={SubjectId}’ \
–data-urlencode ‘Event=ScaneExecutionCompleted’ \
–data-urlencode ‘Global=true’

The following example shows invoking the plugin end point using a ‘non webhook’ method, i.e, CURL, Postman or as part of the CI/ CD pipeline.

Send an HTTP GET (POST if using versions lower than 2.0.1) request to your endpoint such as the following sample.

https:///pluginEndpoint//asocScan

The payload for the POST is shown below.

{"scanId":"", "buildUrl": ""}.

The following picture shows the ASoC scan results in the Insights section of Accelerate.

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 pages.

Minimum permission to integrate with HCL AppScan on Cloud (ASoC)

The HCL AppScan on Cloud (ASoC) 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 HCL AppScan on Cloud Configuration Properties table describes the configuration properties that define the connection and communications with the HCL Accelerate 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.

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.

"integrations": [
  {
    "type": "asocPlugin",
    "tenant_id": "",
    "name": "",
    "properties":{
      "ucvAccessKey": "",
      "keyId" : "",
      "keySecret":"",
      "asocUrl":"",
      "applications":""
    }
 }
]