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.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.
- The Ounce/Make build utility
  Ounce/Make is a tool that automates the importing of configuration information into AppScan® Source from build environments that use makefile. Ounce/Make eliminates the need to import configuration information from makefiles manually; this the recommended method of configuring these projects.
  - Requirements
    To create AppScan® Source project files successfully, you must run Ounce/Make in a suitable environment. The following list itemizes the requirements for Ounce/Make to run successfully. If you do not meet all of these requirements, Ounce/Make fails.
  - What Ounce/Make supports
    Ounce/Make supports multiple computer platforms, compilers, and make versions.
  - Operation
    Ounce/Make operates with your Make to extract the necessary configuration information from your makefiles and create appropriate AppScan® Source project files (ppf). To accomplish this, Ounce/Make requires that you provide certain information about the build environment, such as the make version used.
  - Ounce/Make command syntax and make options
    Ounce/Make supports multiple options that can change the way it behaves when it runs.
  - Ounce/Make properties file
    The Ounce/Make Properties file (ouncemake_properties.xml) is an XML file that contains details about your build environment. When Ounce/Make runs, it finds the properties file based on the search path or the -p option. The properties file must specify the compiler used in your build environment, the linker, and make elements.
  - Examples
    This section describes three ways to use Ounce/Make.
    - Example 1: Ounce/Make without options
      This example illustrates using Ounce/Make non-recursively. In non-recursive mode, Ounce/Make only looks at the makefile in the directory from which it is invoked. If the original makefile contains calls to other makefiles, Ounce/Make ignores them.
    - Example 2: Ounce/Make with recursive option
      With the -r option, Ounce/Make operates recursively (follows calls to other makefiles contained inside a makefile). Since multiple-project file mode is the default mode, when used with the -r option, Ounce/Make creates an AppScan® Source project file for every makefile encountered that compiles source code.
    - Example 3: Ounce/Make with single-project and recursive option
      Example 3 illustrates using Ounce/Make recursively in single-project mode. Ounce/Make generates a single AppScan® Source project file for a combination of the source code compiled by all of the makefiles encountered.
- AppScan® Source command line interface (CLI)
  The CLI is an interface to core AppScan® Source functionality.
- The Ounce/Ant build tool
  This section describes how to use Ounce/Ant, an AppScan® Source build utility that integrates AppScan Source and Apache Ant. Integrating Ounce/Ant with your Ant environment helps you automate builds and code assessments.
- AppScan® Source Data Access API
  The Data Access API provides access to AppScan® Source-generated assessment results, including findings and finding details. It also provides access to assessment metrics such as analysis date and time, lines of code, V-density, and number of findings.
- Glossary
  Learn common product terminology.
Troubleshooting and support
There are a number of self-help information resources and tools to help you troubleshoot problems.

Examples

This section describes three ways to use Ounce/Make.

Example 1: Ounce/Make without options illustrates Ounce/Make without options, creating one AppScan® Source project file based only on the makefile in the directory in which you invoke Ounce/Make.

Example 2: Ounce/Make with recursive option uses Ounce/Make with the -r (recursive) option, telling Ounce/Make to operate recursively and follow all calls to other makefiles.

In Example 3: Ounce/Make with single-project and recursive option, Ounce/Make uses both the -r (recursive) and -s (single-project) options, to create a single AppScan® Source project file based on recursive processing of all makefiles that Ounce/Make encounters.

Directory structure and files

All three examples use the same directory structure and files:

Before running ouncemake

This diagram shows a root directory (/usr/source) that contains a makefile and source files. The /usr/source directory contains two subdirectories, /usr/source/database and /usr/source/server. The /usr/source/database directory contains a makefile and SQL files. The /usr/source/server directory contains a makefile and source files.

This example makes the following assumptions about the three makefiles:

The makefile in /usr/source builds the source files in /usr/source and calls the makefiles in /usr/source/database and /usr/source/server.
The makefile in /usr/source/database imports the SQL files into a database.
The makefile in /usr/source/server builds the source files in /usr/source/server.