Home
Reference
Review reference information for HCL® AppScan® Source, including using utilities, plug-ins, and APIs.
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.
Examples
This section describes three ways to use Ounce/Make.
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.

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.
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.
- 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
Self-help information, resources, and tools to help you troubleshoot issues while using HCL® AppScan® Source.

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.

See Directory structure and files for a graphical explanation of the directory structure and files that are assumed by this example.

Command

ouncemake -r

The -r (recursive) option instructs Ounce/Make to follow makefile calls to other makefiles. For a more detailed description of the recursive option, refer to the table in Ounce/Make command syntax and make options.

The following diagram shows the contents of the directories after Ounce/Make runs:

Directory structure after Ounce/Make has run

In this example, Ounce/Make creates an AppScan® Source project file in /usr/source and /usr/source/server. Since the makefile in /usr/source called the makefiles in /usr/source/database and /usr/source/server, Ounce/Make checked to see if those makefiles compiled source code.

In the case of the makefile in /usr/source/database, Ounce/Make determined that this makefile does not compile source code; therefore, it did not create an AppScan® Source project file. However, Ounce/Make determined that the makefile in /usr/source/server compiled the source files in that directory, and thus generated an AppScan® Source project file for the source files in /usr/source/server.