Home
Developing
Learn how to develop by using the product.
Scanning source code and managing assessments
This section explains how to scan your source code and manage assessments.
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.
Example: Defining variables
To share assessment data, you must define the appropriate variables. The example in this topic illustrates the need for a variable.

Welcome
Welcome to the documentation for HCL® AppScan® Source.
Introduction to HCL® AppScan® Source
HCL® AppScan® Source delivers maximum value to every user in your organization who plays a role in software security. Whether a security analyst, quality assurance professional, developer, or executive, the AppScan Source products deliver the functionality, flexibility, and power you need - right to your desktop.
What's New in AppScan® Source
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 the product.
Configuring
Learn how to configure the product.
Administering
Learn how to administer the product.
Developing
Learn how to develop by using the product.
- Scanning source code and managing assessments
  This section explains how to scan your source code and manage assessments.
  - Scanning
    You can scan an Eclipse or Rational® Application Developer for WebSphere® Software (RAD) workspace, project, or file. This includes scanning Java™ (including Android), JavaServer Pages (JSP), and IBM® MobileFirst Platform projects.
  - 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.
    - Defining variables when publishing and saving
      When you attempt to save or publish an assessment, AppScan® Source for Analysis detects any absolute paths in the assessment. If corresponding variables have not been created for the absolute paths, you will be prompted to create them.
    - Example: Defining variables
      To share assessment data, you must define the appropriate variables. The example in this topic illustrates the need for a variable.
- 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.
- AppScan® Source trace
  With AppScan® Source trace, you can verify input validation and encoding that meets your software security policies. You can look at the findings that produce input/output traces and mark methods as validation and encoding routines, sources or sinks, callbacks, or taint propagators.
- Findings reports and audit reports
  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.
- Creating custom reports
  In the Report Editor, you create report templates used to generate custom reports.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.
Troubleshooting and support
There are a number of self-help information resources and tools to help you troubleshoot problems.

Example: Defining variables

To share assessment data, you must define the appropriate variables. The example in this topic illustrates the need for a variable.

User Joe scans on computer A, where all source code exists under the directory C:\dev\my_code. Joe wants to save his scan results to a file and share it with Bill. Bill uses computer B and has the same code that Joe scanned under directory C:\code\bills_code. Without variables, the assessment file will reference all of the source files with absolute paths starting with C:\dev\my_code. If Bill opens this assessment file on computer B, AppScan® Source for Analysis cannot locate the source files since they exist under C:\code\bills_code on computer B.

Solution

Both Joe and Bill should create a variable that points to the root of the source code. Joe creates a variable in AppScan® Source for Analysis named SRC_ROOT, and gives it a value of C:\dev\my_code. This variable is local to Joe's AppScan® Source for Analysis installation. Joe then tells Bill the variable name (SRC_ROOT) and the location that it points to. Bill then creates a variable named SRC_ROOT with a value of C:\code\bills_code, in his AppScan® Source for Analysis. When Joe saves his scan, the variable SRC_ROOT replaces the path C:\dev\my_code. When Bill opens the assessment file that he received from Joe, C:\code\bills_code substitutes for the SRC_ROOT variable.