Home
Scanning
This section explains how to scan your source code and manage assessments in HCL® AppScan® Source.
Scanning workspaces, projects, and files
You can scan an Eclipse workspace, project, or file. This includes scanning Java™ (including Android), JavaServer Pages (JSP), and IBM® MobileFirst Platform projects.
Scanning integrations
HCL® AppScan® Source allows for integrations with containerization technology, and for scan automation using containers.
Creating containers using a Docker image

Welcome
Welcome to the documentation for HCL® AppScan® Source.
What's New
Explore these new features that have been added to AppScan® Source - and note any features and capabilities that have been deprecated in this release.
Installing
Learn how to install, upgrade, and activate HCL® AppScan® Source.
Configuring
Learn how to configure applications, folders, and projects, and set attributes and properties in HCL® AppScan® Source.
Administering
Learn how to administer user accounts and permissions, audit user activity, and manage integrations in HCL® AppScan® Source.
Scanning
This section explains how to scan your source code and manage assessments in HCL® AppScan® Source.
- Scanning workspaces, projects, and files
  You can scan an Eclipse workspace, project, or file. This includes scanning Java™ (including Android), JavaServer Pages (JSP), and IBM® MobileFirst Platform projects.
  - Scan considerations
    This topic describes restrictions and considerations that may affect your scans.
  - Scan configurations
    Scan configurations are used when launching scans and can often lead to better scan results. AppScan® Source includes built-in scan configurations, which can be accessed in server mode or local mode. In addition, custom scan configurations can be created in AppScan Source for Analysis and shared to the AppScan Enterprise Server - and accessed from AppScan Source for Development in server mode.
  - Scanning integrations
    HCL® AppScan® Source allows for integrations with containerization technology, and for scan automation using containers.
    - Creating containers using a Docker image
    - Configuring scan automation with Jenkins and containers
      The HCL® AppScan® Source command line interface (CLI) container, available from HCL Harbor and HCL Software License Management Portal, can be used to automate static analysis scans with Jenkins, and without installing a full instance of AppScan Source.
    - Configuring scan automation with Azure and containers
      The HCL® AppScan® Source command line interface (CLI) container, available from HCL Harbor and HCL Software License Management Portal, can be used to automate static analysis scans with Azure, and without installing a full instance of AppScan Source.
    - Configuring scan automation with GitHub Action and containers
      The HCL® AppScan® Source command line interface (CLI) container, available from HCL Harbor and HCL Software License Management Portal, can be used to automate static analysis scans with GitHub, and without installing a full instance of AppScan Source.
    - Configuring scan automation with GitLab CI/CD and containers
      The HCL® AppScan® Source command line interface (CLI) container, available from HCL Harbor and HCL Software License Management Portal), can be used to automate static analysis scans with GitLab, and without installing a full instance of AppScan Source.
  - Scanning secrets
    Enable the secrets scanner for all applications, projects, and folders globally from the scan.ozsettings file.
  - Excluding a file from a scan
  - Excluding a folder from a scan
  - Cancelling or stopping a scan
    Although you can cancel a scan in progress, canceling a scan causes a loss of all data for that scan. Alternatively, you can stop a scan to halt it and produce an assessment with results that are found so far.
  - AppScan® Source for Analysis and AppScan® Source for Development (Eclipse plug-in) component prerequisite on Linux™
    On Linux™, Eclipse requires the installation of a third-party component in order to render browser-based content. Without this component, AppScan® Source for Analysis and the AppScan Source for Development Eclipse plug-in may exhibit symptoms such as a hang after login or a fail during product use.
- Managing My Assessments
  The My Assessments view contains a list of assessments (the currently-opened assessment, along with any assessments that you have saved). In this view, you can open, delete, save, rename, or compare assessments. When a scan completes or you open a saved assessment, the assessment appears in the My Assessments view. My Assessments displays a table of open or saved assessments, and identifies a published or modified assessment. Removing an assessment from this view (without saving or publishing it) permanently deletes that assessment.
- Submitting AppScan® Source assessments to the Cloud for analysis
  If you have a subscription to HCL AppScan on Cloud at HCL Cloud Marketplace, you can submit AppScan® Source assessments for analysis there. Assessments from AppScan Source Versions 9.0 or higher are supported - and the number of scans that you can submit depends on your AppScan on Cloud subscription.
- Publishing assessments
  AppScan® Source offers two publishing options. You can publish assessments to the AppScan Source Database, for the purpose of storing and sharing assessments. Or, if your AppScan Enterprise Server has been installed with the Enterprise Console option, you can publish assessments to it. The AppScan Enterprise Console offers a variety of tools for working with your assessments - such as reporting features, issue management, trend analysis, and dashboards.
- Opening and saving assessments
  AppScan® Source scans source code for vulnerabilities and produces findings. Findings are the vulnerabilities identified during a scan, and the result of a scan is an assessment. You can open a saved assessment from AppScan Source for Development or AppScan Source for Analysis. After you scan, you can save the assessment to a file. Then you can open the assessment again at any time. Assessments are saved as filename.ozasmt.
- Removing assessments from My Assessments
  When assessments are removed from the My Assessments view, they are not removed from your local file system. If an assessment is removed from the view, it can be added back with the Open Assessment action.
- Defining variables
  When saving assessments or bundles, or publishing assessments, AppScan® Source for Analysis may suggest that you create a variable to replace absolute paths (without variables, AppScan Source for Analysis writes absolute paths to the assessment file to reference items such as source files). When you configure variables for absolute paths, you facilitate the sharing of assessments on multiple computers. It is recommended that you use variables when sharing assessments.
Triage and analysis
Grouping similar findings allows security analysts or IT auditors to segment and triage source code problems. This section explains how to triage AppScan® Source assessments and analyze results.
Reporting
Security analysts and risk managers can access reports of select findings or a series of audit reports that measure compliance with software security best practices and regulatory requirements. This section explains how to create reports of aggregate finding data.
Extending product function
Learn how to extend the product to meet specific development requirements.
Reference
Review reference information for HCL® AppScan® Source, including using utilities, plug-ins, and APIs.
Troubleshooting and support
Self-help information, resources, and tools to help you troubleshoot issues while using HCL® AppScan® Source.

Creating containers using a Docker image

When creating containers using a Docker image, you must specify the image, license information, and make scan artifacts available to the image:

Command
docker run ... hcl/appscan/source/cli:10.1.0
License information
--env <name=value
--env-file env.list
Scan artifacts
--volume /data/wa:/data/wa

Using the AppScan® Source CLI Docker image, create containers by executing this command:

> docker run hcl/appscan/source/cli:10.1.0

Docker supports the following optional flags. See the Docker documentation for a detailed discussion of these and additional flags.


Flag	Description
`--rm`	Automatically remove the container when it exits
`--detach`, `--d`	Run container in background and print container ID
`--interactive`, `-i`	Keep STDIN open even if not attached
`--ttv`, `-t`	Allocate pseudo-TTY

Examples:

docker run –i --rm \
	    --env AS_LICENSE_INSTANCE=xxxx \
	    --volume /data/wa:/data/wa \
	    hcl/appscan/source/cli:10.1.0

docker run --env-file env.list --volume /data/wa:/data/wa hcl/appscan/source/cli:10.1.0

Usage notes:

The CLI client does not support generating .paf/.ppf files, nor does the CLI running in a container
By default, a container opens AppScan® Source CLI shell, in which only supported AppScan® Source CLI commands can be executed.
Scanning .NET projects is not supported as the container is made available only on Linux.

Note: As of version 10.3.0, AppScan® Source supports containerization using Podman. As Podman supports all major Docker commands, replace docker with podman in the examples in this topic to create containers and scan in the Podman environment.